framework/main/classes/index/file_stack/class_FileStackIndex.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Index\Stack;
   4
   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;
  11
  12 // Import SPL stuff
  13 use \SplFileInfo;
  14
  15 /**
  16  * A FileStack index class
  17  *
  18  * @author              Roland Haeder <webmaster@ship-simu.org>
  19  * @version             0.0.0
  20  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2019 Core Developer Team
  21  * @license             GNU GPL 3.0 or any newer version
  22  * @link                http://www.ship-simu.org
  23  *
  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.
  28  *
  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.
  33  *
  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/>.
  36  */
  37 class FileStackIndex extends BaseIndex implements IndexableStack, Registerable {
  38         /**
  39          * Protected constructor
  40          *
  41          * @return      void
  42          */
  43         protected function __construct () {
  44                 // Call parent constructor
  45                 parent::__construct(__CLASS__);
  46         }
  47
  48         /**
  49          * Creates an instance of this Index class and prepares it for usage
  50          *
  51          * @param       $fileInfoInstance       An instance of a SplFileInfo class
  52          * @return      $indexInstance  An instance of this Index class
  53          */
  54         public final static function createFileStackIndex (SplFileInfo $fileInfoInstance) {
  55                 // Get a new instance
  56                 $indexInstance = new FileStackIndex();
  57
  58                 // Initialize index
  59                 $indexInstance->initIndex($fileInfoInstance);
  60
  61                 // Return the prepared instance
  62                 return $indexInstance;
  63         }
  64
  65         /**
  66          * Adds given hash to an index file
  67          *
  68          * @param       $groupId        Name of stack to add hash for
  69          * @param       $data           Hash and gap position to be added to the index
  70          * @return      void
  71          */
  72         public function addHashToIndex ($groupId, array $data) {
  73                 // Debug message
  74                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('[%s:%d:] groupId=%s,hash=%s,gap=%d,length=%d - CALLED!', __METHOD__, __LINE__, $groupId, $data[BaseFileStack::ARRAY_INDEX_HASH], $data[BaseFileStack::ARRAY_INDEX_GAP_POSITION], $data[BaseFileStack::ARRAY_INDEX_DATA_LENGTH]));
  75
  76                 // Raw data been written to the file
  77                 $rawData = sprintf('%s%s%s%s%s%s%s',
  78                         $groupId,
  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]
  85                 );
  86
  87                 // Debug message
  88                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('[%s:%d:] groupId=%s,hash=%s,rawData()=%d', __METHOD__, __LINE__, $groupId, $data[BaseFileStack::ARRAY_INDEX_HASH], strlen($rawData)));
  89
  90                 // Search for next free gap
  91                 $gapPosition = $this->getIteratorInstance()->searchNextGap(strlen($rawData));
  92
  93                 // Gap position cannot be smaller than header length + 1
  94                 assert($gapPosition > $this->getIteratorInstance()->getHeaderSize());
  95
  96                 // Debug message
  97                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('[%s:%d:] groupId=%s,hash=%s,gapPosition=%s', __METHOD__, __LINE__, $groupId, $data[BaseFileStack::ARRAY_INDEX_HASH], $gapPosition));
  98
  99                 // Then write the data at that gap
 100                 $this->getIteratorInstance()->writeData($gapPosition, $rawData);
 101
 102                 // Debug message
 103                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('[%s:%d:] groupId=%s,hash=%s,rawData()=%d - EXIT!', __METHOD__, __LINE__, $groupId, $data[BaseFileStack::ARRAY_INDEX_HASH], strlen($rawData)));
 104         }
 105
 106         /**
 107          * Searches for next suitable gap the given length of data can fit in
 108          * including padding bytes.
 109          *
 110          * @param       $length                 Length of raw data
 111          * @return      $seekPosition   Found next gap's seek position
 112          */
 113         public function searchNextGap ($length) {
 114                 $this->partialStub('length=' . $length);
 115         }
 116
 117 }