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