framework/main/classes/file_directories/binary/index/class_IndexFile.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Filesystem\Index;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Filesystem\File\BaseBinaryFile;
   7 use Org\Mxchange\CoreFramework\Filesystem\Index\IndexableFile;
   8 use Org\Mxchange\CoreFramework\Generic\UnsupportedOperationException;
   9 use Org\Mxchange\CoreFramework\Index\Indexable;
  10
  11 // Import SPL stuff
  12 use \SplFileInfo;
  13
  14 /**
  15  * An index file class
  16  *
  17  * @author              Roland Haeder <webmaster@ship-simu.org>
  18  * @version             0.0.0
  19  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2020 Core Developer Team
  20  * @license             GNU GPL 3.0 or any newer version
  21  * @link                http://www.ship-simu.org
  22  *
  23  * This program is free software: you can redistribute it and/or modify
  24  * it under the terms of the GNU General Public License as published by
  25  * the Free Software Foundation, either version 3 of the License, or
  26  * (at your option) any later version.
  27  *
  28  * This program is distributed in the hope that it will be useful,
  29  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  30  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  31  * GNU General Public License for more details.
  32  *
  33  * You should have received a copy of the GNU General Public License
  34  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  35  */
  36 class IndexFile extends BaseBinaryFile implements IndexableFile {
  37         /**
  38          * Protected constructor
  39          *
  40          * @return      void
  41          */
  42         protected function __construct () {
  43                 // Call parent constructor
  44                 parent::__construct(__CLASS__);
  45         }
  46
  47         /**
  48          * Creates an instance of this File class and prepares it for usage
  49          *
  50          * @param       $fileInfoInstance       An instance of a SplFileInfo class
  51          * @param       $indexInstance  An instance of a Indexable class
  52          * @return      $indexFileInstance      An instance of an IndexableFile class
  53          */
  54         public final static function createIndexFile (SplFileInfo $fileInfoInstance, Indexable $indexInstance) {
  55                 // Get a new instance
  56                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('INDEX-FILE: fileInfoInstance[%s]=%s,indexInstance=%s - CALLED!', get_class($fileInfoInstance), $fileInfoInstance, $indexInstance->__toString()));
  57                 $indexFileInstance = new IndexFile();
  58
  59                 // Set file instance here for callbacks
  60                 $indexFileInstance->setIndexInstance($indexInstance);
  61
  62                 // Expand file name with .idx
  63                 $indexInfoInstance = new SplFileInfo(sprintf('%s.idx', $fileInfoInstance->__toString()));
  64
  65                 // Init this abstract file
  66                 $indexFileInstance->initFile($indexInfoInstance);
  67
  68                 // Return the prepared instance
  69                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('INDEX-FILE: indexFileInstance=%s - EXIT!', $indexFileInstance->__toString()));
  70                 return $indexFileInstance;
  71         }
  72
  73         /**
  74          * Writes given value to the file and returns a hash and gap position for it
  75          *
  76          * @param       $stackName      Group identifier
  77          * @param       $value          Value to be added to the stack
  78          * @return      $data           Hash and gap position
  79          * @throws      InvalidArgumentException        If a parameter is not valid
  80          */
  81         public function writeValueToFile (string $stackName, $value) {
  82                 // Validate parameter
  83                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('INDEX-FILE: stackName=%s,value[]=%s - CALLED!', $stackName, gettype($value)));
  84                 if (empty($stackName)) {
  85                         // Throw IAE
  86                         throw new InvalidArgumentException('Parameter "stackName" is empty');
  87                 } elseif (is_object($value) || is_resource($value)) {
  88                         // Not wanted here
  89                         throw new InvalidArgumentException(sprintf('value[]=%s is not stackable in files', gettype($value)));
  90                 }
  91
  92                 // Encode/convert the value into a "binary format"
  93                 $encoded = StringUtils::encodeData($value);
  94
  95                 // Get a strong hash for the "encoded" data
  96                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('INDEX-FILE: encoded=%s', $encoded));
  97                 $hash = self::hash($encoded);
  98
  99                 // Then write it to the next free gap
 100                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('INDEX-FILE: hash=%s', $hash));
 101                 $data = $this->getIndexInstance()->writeDataToFreeGap($stackName, $hash, $encoded);
 102
 103                 // Return info
 104                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('INDEX-FILE: data[]=%s - EXIT!', gettype($data)));
 105                 return $data;
 106         }
 107
 108         /**
 109          * Writes given raw data to the file and returns a gap position and length
 110          *
 111          * @param       $stackName      Group identifier
 112          * @param       $hash           Hash from encoded value
 113          * @param       $encoded        Encoded value to be written to the file
 114          * @return      $data           Gap position and length of the raw data
 115          * @throws      UnsupportedOperationException   If this method is called
 116          */
 117         public function writeDataToFreeGap (string $stackName, string $hash, string $encoded) {
 118                 self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('INDEX-FILE: stackName=' . $stackName . ',hash=' . $hash . ',encoded()=' . strlen($encoded));
 119                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
 120         }
 121
 122 }