]> git.mxchange.org Git - core.git/blob - framework/main/classes/index/file/stack/class_FileStackIndex.php
Continued:
[core.git] / framework / main / classes / index / file / stack / class_FileStackIndex.php
1 <?php
2 // Own namespace
3 namespace Org\Mxchange\CoreFramework\Index\File\Stack;
4
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Generic\FrameworkInterface;
7 use Org\Mxchange\CoreFramework\Index\File\BaseFileIndex;
8 use Org\Mxchange\CoreFramework\Index\File\Stack\IndexableStack;
9 use Org\Mxchange\CoreFramework\Index\Indexable;
10 use Org\Mxchange\CoreFramework\Registry\Registerable;
11 use Org\Mxchange\CoreFramework\Stack\File\StackableFile;
12
13 // Import SPL stuff
14 use \InvalidArgumentException;
15 use \SplFileInfo;
16 use \UnexpectedValueException;
17
18 /**
19  * A FileStack index class
20  *
21  * @author              Roland Haeder <webmaster@ship-simu.org>
22  * @version             0.0.0
23  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2023 Core Developer Team
24  * @license             GNU GPL 3.0 or any newer version
25  * @link                http://www.ship-simu.org
26  *
27  * This program is free software: you can redistribute it and/or modify
28  * it under the terms of the GNU General Public License as published by
29  * the Free Software Foundation, either version 3 of the License, or
30  * (at your option) any later version.
31  *
32  * This program is distributed in the hope that it will be useful,
33  * but WITHOUT ANY WARRANTY; without even the implied warranty of
34  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
35  * GNU General Public License for more details.
36  *
37  * You should have received a copy of the GNU General Public License
38  * along with this program. If not, see <http://www.gnu.org/licenses/>.
39  */
40 class FileStackIndex extends BaseFileIndex implements IndexableStack, Registerable {
41         /**
42          * Protected constructor
43          *
44          * @return      void
45          */
46         private function __construct () {
47                 // Call parent constructor
48                 parent::__construct(__CLASS__);
49         }
50
51         /**
52          * Creates an instance of this Index class and prepares it for usage
53          *
54          * @param       $fileInfoInstance       An instance of a SplFileInfo class
55          * @return      $indexInstance  An instance of this Index class
56          */
57         public final static function createFileStackIndex (SplFileInfo $fileInfoInstance) {
58                 // Get a new instance
59                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('FILE-STACK-INDEX: fileInfoInstance[%s]=%s - CALLED!', get_class($fileInfoInstance), $fileInfoInstance));
60                 $indexInstance = new FileStackIndex();
61
62                 // Initialize index
63                 $indexInstance->initFileIndex($fileInfoInstance);
64
65                 // Return the prepared instance
66                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('FILE-STACK-INDEX: indexInstance=%s - EXIT!', $indexInstance->__toString()));
67                 return $indexInstance;
68         }
69
70         /**
71          * Adds given data's hash to an index file
72          *
73          * @param       $stackName      Name of stack to add hash for
74          * @param       $data           Hash and gap position to be added to the index
75          * @return      void
76          * @throws      InvalidArgumentException        If a parameter is not valid
77          * @throws      UnexpectedValueException        If an invalid gap position is being returned
78          */
79         public function addHashedDataToIndex (string $stackName, array $data) {
80                 // Validate parameter
81                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('FILE-STACK-INDEX: stackName=%s,data()=%d - CALLED!', $stackName, count($data)));
82                 if (empty($stackName)) {
83                         // Throw IAE
84                         throw new InvalidArgumentException('Parameter "stackName" is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT);
85                 } elseif (count($data) == 0) {
86                         // Throw it again
87                         throw new InvalidArgumentException('Parameter "data" is an empty array');
88                 } elseif (!isset($data[StackableFile::ARRAY_NAME_HASH])) {
89                         // Important array element missing
90                         throw new InvalidArgumentException(sprintf('data[%s] not found', StackableFile::ARRAY_NAME_HASH));
91                 } elseif (!isset($data[StackableFile::ARRAY_NAME_GAP_POSITION])) {
92                         // Important array element missing
93                         throw new InvalidArgumentException(sprintf('data[%s] not found', StackableFile::ARRAY_NAME_GAP_POSITION));
94                 } elseif (!isset($data[StackableFile::ARRAY_NAME_DATA_LENGTH])) {
95                         // Important array element missing
96                         throw new InvalidArgumentException(sprintf('data[%s] not found', StackableFile::ARRAY_NAME_DATA_LENGTH));
97                 }
98
99                 // Raw data been written to the file
100                 $rawData = sprintf('%s%s%s%s%s%s%s',
101                         $stackName,
102                         Indexable::SEPARATOR_GROUP_HASH,
103                         $data[StackableFile::ARRAY_NAME_HASH],
104                         Indexable::SEPARATOR_HASH_GAP_POSITION,
105                         $data[StackableFile::ARRAY_NAME_GAP_POSITION],
106                         Indexable::SEPARATOR_GAP_LENGTH,
107                         $data[StackableFile::ARRAY_NAME_DATA_LENGTH]
108                 );
109                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('FILE-STACK-INDEX: stackName=%s,hash{}=0x%s,rawData(%d)=%s', $stackName, bin2hex($data[StackableFile::ARRAY_NAME_HASH]), strlen($rawData), $rawData));
110
111                 // Search for next free gap
112                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('FILE-STACK-INDEX: Invoking this->iteratorInstance->binaryFileInstance->searchNextGap(%d) ...', strlen($rawData)));
113                 $gapPosition = $this->getIteratorInstance()->getBinaryFileInstance()->searchNextGap(strlen($rawData));
114
115                 // Gap position cannot be smaller or equal than header length
116                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('FILE-STACK-INDEX: stackName=%s,hash{}=0x%s,gapPosition=%s', $stackName, bin2hex($data[StackableFile::ARRAY_NAME_HASH]), $gapPosition));
117                 if ($gapPosition <= ($this->getIteratorInstance()->getBinaryFileInstance()->getHeaderSize() + 1)) {
118                         // Not valid gap position returned
119                         throw new UnexpectedValueException(sprintf('gapPosition[%s]=%d is smaller or equal headerSize+1=%d', gettype($gapPosition), $gapPosition, ($this->getIteratorInstance()->getBinaryFileInstance()->getHeaderSize() + 1)));
120                 }
121
122                 // Then write the data at that gap
123                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('FILE-STACK-INDEX: Invoking this->iteratorInstance->binaryFileInstance->writeData(%d,%s) ...', $gapPosition, $rawData));
124                 $this->getIteratorInstance()->getBinaryFileInstance()->writeData($gapPosition, $rawData);
125
126                 // Trace message
127                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('FILE-STACK-INDEX: stackName=%s,hash{}=0x%s,rawData()=%d - EXIT!', $stackName, bin2hex($data[StackableFile::ARRAY_NAME_HASH]), strlen($rawData)));
128         }
129
130 }