3 namespace Org\Mxchange\CoreFramework\Index\Stack;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Index\BaseIndex;
7 use Org\Mxchange\CoreFramework\Index\Indexable;
8 use Org\Mxchange\CoreFramework\Registry\Registerable;
9 use Org\Mxchange\CoreFramework\Stacker\Filesystem\BaseFileStack;
10 use Org\Mxchange\CoreFramework\Stacker\Index\IndexableStack;
16 * A FileStack index class
18 * @author Roland Haeder <webmaster@ship-simu.org>
20 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2020 Core Developer Team
21 * @license GNU GPL 3.0 or any newer version
22 * @link http://www.ship-simu.org
24 * This program is free software: you can redistribute it and/or modify
25 * it under the terms of the GNU General Public License as published by
26 * the Free Software Foundation, either version 3 of the License, or
27 * (at your option) any later version.
29 * This program is distributed in the hope that it will be useful,
30 * but WITHOUT ANY WARRANTY; without even the implied warranty of
31 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
32 * GNU General Public License for more details.
34 * You should have received a copy of the GNU General Public License
35 * along with this program. If not, see <http://www.gnu.org/licenses/>.
37 class FileStackIndex extends BaseIndex implements IndexableStack, Registerable {
39 * Protected constructor
43 protected function __construct () {
44 // Call parent constructor
45 parent::__construct(__CLASS__);
49 * Creates an instance of this Index class and prepares it for usage
51 * @param $fileInfoInstance An instance of a SplFileInfo class
52 * @return $indexInstance An instance of this Index class
54 public final static function createFileStackIndex (SplFileInfo $fileInfoInstance) {
56 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('FILE-STACK-INDEX: fileInfoInstance=%s - CALLED!', $fileInfoInstance));
57 $indexInstance = new FileStackIndex();
60 $indexInstance->initIndex($fileInfoInstance);
62 // Return the prepared instance
63 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('FILE-STACK-INDEX: indexInstance=%s - EXIT!', $indexInstance->__toString()));
64 return $indexInstance;
68 * Adds given hash to an index file
70 * @param $groupId Name of stack to add hash for
71 * @param $data Hash and gap position to be added to the index
74 public function addHashToIndex (string $groupId, array $data) {
75 // Raw data been written to the file
76 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('FILE-STACK-INDEX: groupId=%s,hash=%s,gap=%d,length=%d - CALLED!', $groupId, $data[BaseFileStack::ARRAY_INDEX_HASH], $data[BaseFileStack::ARRAY_INDEX_GAP_POSITION], $data[BaseFileStack::ARRAY_INDEX_DATA_LENGTH]));
77 $rawData = sprintf('%s%s%s%s%s%s%s',
79 self::SEPARATOR_GROUP_HASH,
80 hex2bin($data[BaseFileStack::ARRAY_INDEX_HASH]),
81 self::SEPARATOR_HASH_GAP_POSITION,
82 $data[BaseFileStack::ARRAY_INDEX_GAP_POSITION],
83 self::SEPARATOR_GAP_LENGTH,
84 $data[BaseFileStack::ARRAY_INDEX_DATA_LENGTH]
88 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('FILE-STACK-INDEX: groupId=%s,hash=%s,rawData()=%d', $groupId, $data[BaseFileStack::ARRAY_INDEX_HASH], strlen($rawData)));
90 // Search for next free gap
91 $gapPosition = $this->getIteratorInstance()->searchNextGap(strlen($rawData));
93 // Gap position cannot be smaller than header length + 1
94 assert($gapPosition > $this->getIteratorInstance()->getHeaderSize());
96 // Then write the data at that gap
97 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('FILE-STACK-INDEX: groupId=%s,hash=%s,gapPosition=%s', $groupId, $data[BaseFileStack::ARRAY_INDEX_HASH], $gapPosition));
98 $this->getIteratorInstance()->writeData($gapPosition, $rawData);
101 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('FILE-STACK-INDEX: groupId=%s,hash=%s,rawData()=%d - EXIT!', $groupId, $data[BaseFileStack::ARRAY_INDEX_HASH], strlen($rawData)));
105 * Searches for next suitable gap the given length of data can fit in
106 * including padding bytes.
108 * @param $length Length of raw data
109 * @return $seekPosition Found next gap's seek position
111 public function searchNextGap (int $length) {
112 $this->partialStub('length=' . $length);