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\BaseFileStacker;
  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 <<<<<<< HEAD:framework/main/classes/index/file_stack/class_FileStackIndex.php
  21  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  22 =======
  23  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2016 Core Developer Team
  24 >>>>>>> Some updates::inc/main/classes/index/file_stack/class_FileStackIndex.php
  25  * @license             GNU GPL 3.0 or any newer version
  26  * @link                http://www.ship-simu.org
  27  *
  28  * This program is free software: you can redistribute it and/or modify
  29  * it under the terms of the GNU General Public License as published by
  30  * the Free Software Foundation, either version 3 of the License, or
  31  * (at your option) any later version.
  32  *
  33  * This program is distributed in the hope that it will be useful,
  34  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  35  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  36  * GNU General Public License for more details.
  37  *
  38  * You should have received a copy of the GNU General Public License
  39  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  40  */
  41 class FileStackIndex extends BaseIndex implements IndexableStack, Registerable {
  42         /**
  43          * Protected constructor
  44          *
  45          * @return      void
  46          */
  47         protected function __construct () {
  48                 // Call parent constructor
  49                 parent::__construct(__CLASS__);
  50         }
  51
  52         /**
  53          * Creates an instance of this Index class and prepares it for usage
  54          *
  55          * @param       $fileInfoInstance       An instance of a SplFileInfo class
  56          * @return      $indexInstance  An instance of this Index class
  57          */
  58         public final static function createFileStackIndex (SplFileInfo $fileInfoInstance) {
  59                 // Get a new instance
  60                 $indexInstance = new FileStackIndex();
  61
  62                 // Initialize index
  63                 $indexInstance->initIndex($fileInfoInstance);
  64
  65                 // Return the prepared instance
  66                 return $indexInstance;
  67         }
  68
  69         /**
  70          * Adds given hash to an index file
  71          *
  72          * @param       $groupId        Name of stack to add hash for
  73          * @param       $data           Hash and gap position to be added to the index
  74          * @return      void
  75          */
  76         public function addHashToIndex ($groupId, array $data) {
  77                 // Debug message
  78                 /* 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]));
  79
  80                 // Raw data been written to the file
  81                 $rawData = sprintf('%s%s%s%s%s%s%s',
  82                         $groupId,
  83                         self::SEPARATOR_GROUP_HASH,
  84                         hex2bin($data[BaseFileStack::ARRAY_INDEX_HASH]),
  85                         self::SEPARATOR_HASH_GAP_POSITION,
  86                         $data[BaseFileStack::ARRAY_INDEX_GAP_POSITION],
  87                         self::SEPARATOR_GAP_LENGTH,
  88                         $data[BaseFileStack::ARRAY_INDEX_DATA_LENGTH]
  89                 );
  90
  91                 // Debug message
  92                 /* 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)));
  93
  94                 // Search for next free gap
  95                 $gapPosition = $this->getIteratorInstance()->searchNextGap(strlen($rawData));
  96
  97                 // Gap position cannot be smaller than header length + 1
  98                 assert($gapPosition > $this->getIteratorInstance()->getHeaderSize());
  99
 100                 // Debug message
 101                 /* 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));
 102
 103                 // Then write the data at that gap
 104                 $this->getIteratorInstance()->writeData($gapPosition, $rawData);
 105
 106                 // Debug message
 107                 /* 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)));
 108         }
 109
 110         /**
 111          * Searches for next suitable gap the given length of data can fit in
 112          * including padding bytes.
 113          *
 114          * @param       $length                 Length of raw data
 115          * @return      $seekPosition   Found next gap's seek position
 116          */
 117         public function searchNextGap ($length) {
 118                 $this->partialStub('length=' . $length);
 119         }
 120
 121 }