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\Index\Stack\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 data's 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      InvalidArgumentException        If a parameter is not valid
  76          * @throws      UnexpectedValueException        If an invalid gap position is being returned
  77          */
  78         public function addHashedDataToIndex (string $groupId, array $data) {
  79                 // Validate parameter
  80                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('FILE-STACK-INDEX: groupId=%s,data()=%d - CALLED!', $groupId, count($data)));
  81                 if (empty($groupId)) {
  82                         // Throw IAE
  83                         throw new InvalidArgumentException('Parameter "groupId" is empty');
  84                 } elseif (count($data) == 0) {
  85                         // Throw it again
  86                         throw new InvalidArgumentException('Parameter "data" is an empty array');
  87                 } elseif (!isset($data[StackableFile::ARRAY_NAME_HASH])) {
  88                         // Important array element missing
  89                         throw new InvalidArgumentException(sprintf('data[%s] not found', $data[StackableFile::ARRAY_NAME_HASH]));
  90                 } elseif (!isset($data[StackableFile::ARRAY_NAME_GAP_POSITION])) {
  91                         // Important array element missing
  92                         throw new InvalidArgumentException(sprintf('data[%s] not found', $data[StackableFile::ARRAY_NAME_GAP_POSITION]));
  93                 } elseif (!isset($data[StackableFile::ARRAY_NAME_DATA_LENGTH])) {
  94                         // Important array element missing
  95                         throw new InvalidArgumentException(sprintf('data[%s] not found', $data[StackableFile::ARRAY_NAME_DATA_LENGTH]));
  96                 }
  97
  98                 // Raw data been written to the file
  99                 $rawData = sprintf('%s%s%s%s%s%s%s',
 100                         $groupId,
 101                         Indexable::SEPARATOR_GROUP_HASH,
 102                         hex2bin($data[StackableFile::ARRAY_NAME_HASH]),
 103                         Indexable::SEPARATOR_HASH_GAP_POSITION,
 104                         $data[StackableFile::ARRAY_NAME_GAP_POSITION],
 105                         Indexable::SEPARATOR_GAP_LENGTH,
 106                         $data[StackableFile::ARRAY_NAME_DATA_LENGTH]
 107                 );
 108
 109                 // Search for next free gap
 110                 /* 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)));
 111                 $gapPosition = $this->getIteratorInstance()->searchNextGap(strlen($rawData));
 112
 113                 // Gap position cannot be smaller or equal than header length
 114                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('FILE-STACK-INDEX: groupId=%s,hash=%s,gapPosition=%s', $groupId, $data[StackableFile::ARRAY_NAME_HASH], $gapPosition));
 115                 if ($gapPosition <= ($this->getIteratorInstance()->getHeaderSize() + 1)) {
 116                         // Not valid gap position returned
 117                         throw new UnexpectedValueException(sprintf('gapPosition[%s]=%d is smaller or equal headerSize+1=%d', gettype($gapPosition), $gapPosition, ($this->getIteratorInstance()->getHeaderSize() + 1)));
 118                 }
 119
 120                 // Then write the data at that gap
 121                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('FILE-STACK-INDEX: Calling this->iteratorInstance->writeData(%d,%s) ...', $gapPosition, $rawData));
 122                 $this->getIteratorInstance()->writeData($gapPosition, $rawData);
 123
 124                 // Trace message
 125                 /* 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)));
 126         }
 127
 128         /**
 129          * Searches for next suitable gap the given length of data can fit in
 130          * including padding bytes.
 131          *
 132          * @param       $length                 Length of raw data
 133          * @return      $seekPosition   Found next gap's seek position
 134          * @throws      InvalidArgumentException        If the parameter is not valid
 135          * @todo        Unfinished work
 136          */
 137         public function searchNextGap (int $length) {
 138                 // Validate parameter
 139                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('FILE-STACK-INDEX: length=%d - CALLED!', $length));
 140                 if ($length <= 0) {
 141                         // Throw IAE
 142                         throw new InvalidArgumentException(sprintf('length=%d is not valid', $length));
 143                 }
 144
 145                 // Partial stub!
 146                 $this->partialStub('length=' . $length);
 147         }
 148
 149         /**
 150          * Writes at given position by seeking to it.
 151          *
 152          * @param       $seekPosition   Seek position in file
 153          * @param       $dataStream             Data to be written
 154          * @return      mixed                   Number of writes bytes or false on error
 155          * @throws      InvalidArgumentException        If a parameter is not valid
 156          */
 157         public function writeAtPosition (int $seekPosition, string $dataStream) {
 158                 // Validate parameter
 159                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('FILE-STACK-INDEX: seekPosition=%d,dataStream(%d)=%s - CALLED!', $seekPosition, strlen($dataStream), $dataStream));
 160                 if ($seekPosition < 0) {
 161                         // Invalid seek position
 162                         throw new InvalidArgumentException(sprintf('seekPosition=%d is not valid.', $seekPosition));
 163                 } elseif (empty($dataStream)) {
 164                         // Empty dataStream
 165                         throw new InvalidArgumentException('Parameter "dataStream" is empty');
 166                 }
 167
 168                 // Call iterated object's method
 169                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('FILE-STACK-INDEX: Calling this->iteratorInstance->writeAtPosition(%d, %s) ...', $seekPosition, $dataStream));
 170                 $status = $this->getIteratorInstance()->writeAtPosition($seekPosition, $dataStream);
 171
 172                 // Return status
 173                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('FILE-STACK-INDEX: status[%s]=%d - EXIT!', gettype($status), $status));
 174                 return $status;
 175         }
 176
 177         /**
 178          * Checks if this index file has been fully and properly loaded.
 179          *
 180          * @return      $isLoaded       Whether this index file has been loaded
 181          */
 182         public function isIndexFileLoaded () {
 183                 // Trace message
 184                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('FILE-STACK-INDEX: CALLED!');
 185                 /* DEBUG-DIE: */ die(sprintf('[%s:%d]: this=%s', __METHOD__, __LINE__, print_r($this, true)));
 186         }
 187
 188 }