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