inc/classes/main/stacker/file/class_BaseFileStack.php

   1 <?php
   2 /**
   3  * A general file-based stack class
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 Core Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 class BaseFileStack extends BaseStacker {
  25         /**
  26          * Magic for this stack
  27          */
  28         const STACK_MAGIC = 'STACKv0.1';
  29
  30         /**
  31          * Separator for header data
  32          */
  33         const SEPARATOR_HEADER_DATA = 0x01;
  34
  35         /**
  36          * Separator header->entries
  37          */
  38         const SEPARATOR_HEADER_ENTRIES = 0x02;
  39
  40         /**
  41          * Separator hash->name
  42          */
  43         const SEPARATOR_HASH_NAME = 0x03;
  44
  45         /**
  46          * Length of name
  47          */
  48         const LENGTH_NAME = 10;
  49
  50         /**
  51          * Protected constructor
  52          *
  53          * @param       $className      Name of the class
  54          * @return      void
  55          */
  56         protected function __construct ($className) {
  57                 // Call parent constructor
  58                 parent::__construct($className);
  59
  60                 // Calculate header size
  61                 $this->setHeaderSize(
  62                         strlen(self::STACK_MAGIC) +
  63                         strlen(self::SEPARATOR_HEADER_DATA) +
  64                         self::LENGTH_COUNT +
  65                         strlen(self::SEPARATOR_HEADER_DATA) +
  66                         self::LENGTH_POSITION +
  67                         strlen(self::SEPARATOR_HEADER_ENTRIES)
  68                 );
  69
  70                 // Init counters and gaps array
  71                 $this->initCountersGapsArray();
  72         }
  73
  74         /**
  75          * Reads the file header
  76          *
  77          * @return      void
  78          */
  79         protected function readFileHeader () {
  80                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] CALLED!', __METHOD__, __LINE__));
  81
  82                 // First rewind to beginning as the header sits at the beginning ...
  83                 $this->getIteratorInstance()->rewind();
  84
  85                 // Then read it (see constructor for calculation)
  86                 $data = $this->getIteratorInstance()->read($this->getHeaderSize());
  87                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] Read %d bytes (%d wanted).', __METHOD__, __LINE__, strlen($data), $this->getHeaderSize()));
  88
  89                 // Have all requested bytes been read?
  90                 assert(strlen($data) == $this->getHeaderSize());
  91                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] Passed assert().', __METHOD__, __LINE__));
  92
  93                 // Last character must be the separator
  94                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] data(-1)=%s', __METHOD__, __LINE__, dechex(ord(substr($data, -1, 1)))));
  95                 assert(substr($data, -1, 1) == chr(self::SEPARATOR_HEADER_ENTRIES));
  96                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] Passed assert().', __METHOD__, __LINE__));
  97
  98                 // Okay, then remove it
  99                 $data = substr($data, 0, -1);
 100
 101                 // And update seek position
 102                 $this->updateSeekPosition();
 103
 104                 /*
 105                  * Now split it:
 106                  *
 107                  * 0 => magic
 108                  * 1 => total entries
 109                  * 2 => current seek position
 110                  */
 111                 $header = explode(chr(self::SEPARATOR_HEADER_DATA), $data);
 112
 113                 // Set header here
 114                 $this->setHeader($header);
 115
 116                 // Check if the array has only 3 elements
 117                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] header(%d)=%s', __METHOD__, __LINE__, count($header), print_r($header, TRUE)));
 118                 assert(count($header) == 3);
 119                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] Passed assert().', __METHOD__, __LINE__));
 120
 121                 // Check magic
 122                 assert($header[0] == self::STACK_MAGIC);
 123                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] Passed assert().', __METHOD__, __LINE__));
 124
 125                 // Check length of count and seek position
 126                 assert(strlen($header[1]) == self::LENGTH_COUNT);
 127                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] Passed assert().', __METHOD__, __LINE__));
 128                 assert(strlen($header[2]) == self::LENGTH_POSITION);
 129                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] Passed assert().', __METHOD__, __LINE__));
 130
 131                 // Decode count and seek position
 132                 $header[1] = hex2bin($header[1]);
 133                 $header[2] = hex2bin($header[2]);
 134
 135                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] EXIT!', __METHOD__, __LINE__));
 136         }
 137
 138         /**
 139          * Flushes the file header
 140          *
 141          * @return      void
 142          */
 143         protected function flushFileHeader () {
 144                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] CALLED!', __METHOD__, __LINE__));
 145
 146                 // Put all informations together
 147                 $header = sprintf('%s%s%s%s%s%s',
 148                         // Magic
 149                         self::STACK_MAGIC,
 150
 151                         // Separator magic<->count
 152                         chr(self::SEPARATOR_HEADER_DATA),
 153
 154                         // Total entries (will be zero) and pad it to 20 chars
 155                         str_pad($this->dec2hex($this->getCounter()), self::LENGTH_COUNT, '0', STR_PAD_LEFT),
 156
 157                         // Separator count<->seek position
 158                         chr(self::SEPARATOR_HEADER_DATA),
 159
 160                         // Position (will be zero)
 161                         str_pad($this->dec2hex($this->getSeekPosition(), 2), self::LENGTH_POSITION, '0', STR_PAD_LEFT),
 162
 163                         // Separator position<->entries
 164                         chr(self::SEPARATOR_HEADER_ENTRIES)
 165                 );
 166
 167                 // Write it to disk (header is always at seek position 0)
 168                 $this->writeData(0, $header, FALSE);
 169
 170                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] EXIT!', __METHOD__, __LINE__));
 171         }
 172
 173         /**
 174          * Analyzes entries in stack file. This will count all found (and valid)
 175          * entries, mark invalid as damaged and count gaps ("fragmentation"). If
 176          * only gaps are found, the file is considered as "virgin" (no entries).
 177          *
 178          * @return      void
 179          */
 180         private function analyzeFile () {
 181                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] CALLED!', __METHOD__, __LINE__));
 182
 183                 // Make sure the file is initialized
 184                 assert($this->isFileInitialized());
 185
 186                 // Init counters and gaps array
 187                 $this->initCountersGapsArray();
 188
 189                 // Output message (as this may take some time)
 190                 self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] Analyzing file structure ... (this may take some time)', __METHOD__, __LINE__));
 191
 192                 // First rewind to the begining
 193                 $this->getIteratorInstance()->rewind();
 194
 195                 // Then try to load all entries
 196                 while ($this->getIteratorInstance()->next()) {
 197                         // Get current entry
 198                         $current = $this->getIteratorInstance()->current();
 199
 200                         // Simply output it
 201                         self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] current=%s', __METHOD__, __LINE__, print_r($current, TRUE)));
 202                 } // END - while
 203
 204                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] EXIT!', __METHOD__, __LINE__));
 205         }
 206
 207         /**
 208          * Initializes this file-based stack.
 209          *
 210          * @param       $fileName       File name of this stack
 211          * @param       $type           Type of this stack (e.g. url_source for URL sources)
 212          * @return      void
 213          * @todo        Currently the stack file is not cached, please implement a memory-handling class and if enough RAM is found, cache the whole stack file.
 214          */
 215         protected function initFileStack ($fileName, $type) {
 216                 // Get a stack file instance
 217                 $fileInstance = ObjectFactory::createObjectByConfiguredName('stack_file_class', array($fileName));
 218
 219                 // Get iterator instance
 220                 $iteratorInstance = ObjectFactory::createObjectByConfiguredName('file_io_iterator_class', array($fileInstance));
 221
 222                 // Is the instance implementing the right interface?
 223                 assert($iteratorInstance instanceof SeekableWritableFileIterator);
 224
 225                 // Set iterator here
 226                 $this->setIteratorInstance($iteratorInstance);
 227
 228                 // Is the file's header initialized?
 229                 if (!$this->isFileHeaderInitialized()) {
 230                         // No, then create it (which may pre-allocate the stack)
 231                         $this->createFileHeader();
 232
 233                         // And pre-allocate a bit
 234                         $this->preAllocateFile('file_stack');
 235                 } // END - if
 236
 237                 // Load the file header
 238                 $this->readFileHeader();
 239
 240                 // Count all entries in file
 241                 $this->analyzeFile();
 242
 243                 /*
 244                  * Get stack index instance. This can be used for faster
 245                  * "defragmentation" and startup.
 246                  */
 247                 $indexInstance = FileStackIndexFactory::createFileStackIndexInstance($fileName, $type);
 248
 249                 // And set it here
 250                 $this->setIndexInstance($indexInstance);
 251         }
 252
 253         /**
 254          * Calculates minimum length for one entry
 255          *
 256          * @return      $length         Minimum length for one entry
 257          */
 258         protected function caluclateMinimumFileEntryLength () {
 259                 // Calulcate it
 260                 $length = self::getHashLength() + strlen(self::SEPARATOR_HASH_NAME) + self::LENGTH_NAME + 1;
 261
 262                 // Return it
 263                 return $length;
 264         }
 265
 266         /**
 267          * Adds a value to given stack
 268          *
 269          * @param       $stackerName    Name of the stack
 270          * @param       $value                  Value to add to this stacker
 271          * @return      void
 272          * @throws      FullStackerException    If the stack is full
 273          */
 274         protected function addValue ($stackerName, $value) {
 275                 // Do some tests
 276                 if ($this->isStackFull($stackerName)) {
 277                         // Stacker is full
 278                         throw new FullStackerException(array($this, $stackerName, $value), self::EXCEPTION_STACKER_IS_FULL);
 279                 } // END - if
 280
 281                 // Now add the value to the stack
 282                 $this->partialStub('stackerName=' . $stackerName . ',value[]=' . gettype($value));
 283         }
 284
 285         /**
 286          * Get last value from named stacker
 287          *
 288          * @param       $stackerName    Name of the stack
 289          * @return      $value                  Value of last added value
 290          * @throws      EmptyStackerException   If the stack is empty
 291          */
 292         protected function getLastValue ($stackerName) {
 293                 // Is the stack not yet initialized or full?
 294                 if ($this->isStackEmpty($stackerName)) {
 295                         // Throw an exception
 296                         throw new EmptyStackerException(array($this, $stackerName), self::EXCEPTION_STACKER_IS_EMPTY);
 297                 } // END - if
 298
 299                 // Now get the last value
 300                 $this->partialStub('stackerName=' . $stackerName);
 301                 $value = NULL;
 302
 303                 // Return it
 304                 return $value;
 305         }
 306
 307         /**
 308          * Get first value from named stacker
 309          *
 310          * @param       $stackerName    Name of the stack
 311          * @return      $value                  Value of last added value
 312          * @throws      EmptyStackerException   If the stack is empty
 313          */
 314         protected function getFirstValue ($stackerName) {
 315                 // Is the stack not yet initialized or full?
 316                 if ($this->isStackEmpty($stackerName)) {
 317                         // Throw an exception
 318                         throw new EmptyStackerException(array($this, $stackerName), self::EXCEPTION_STACKER_IS_EMPTY);
 319                 } // END - if
 320
 321                 // Now get the first value
 322                 $this->partialStub('stackerName=' . $stackerName);
 323                 $value = NULL;
 324
 325                 // Return it
 326                 return $value;
 327         }
 328
 329         /**
 330          * "Pops" last entry from stack
 331          *
 332          * @param       $stackerName    Name of the stack
 333          * @return      $value                  Value "poped" from array
 334          * @throws      EmptyStackerException   If the stack is empty
 335          */
 336         protected function popLast ($stackerName) {
 337                 // Is the stack not yet initialized or full?
 338                 if ($this->isStackEmpty($stackerName)) {
 339                         // Throw an exception
 340                         throw new EmptyStackerException(array($this, $stackerName), self::EXCEPTION_STACKER_IS_EMPTY);
 341                 } // END - if
 342
 343                 // Now, remove the last entry, we don't care about the return value here, see elseif() block above
 344                 $this->partialStub('stackerName=' . $stackerName);
 345                 return NULL;
 346         }
 347
 348         /**
 349          * "Pops" first entry from stack
 350          *
 351          * @param       $stackerName    Name of the stack
 352          * @return      $value                  Value "shifted" from array
 353          * @throws      EmptyStackerException   If the named stacker is empty
 354          */
 355         protected function popFirst ($stackerName) {
 356                 // Is the stack not yet initialized or full?
 357                 if ($this->isStackEmpty($stackerName)) {
 358                         // Throw an exception
 359                         throw new EmptyStackerException(array($this, $stackerName), self::EXCEPTION_STACKER_IS_EMPTY);
 360                 } // END - if
 361
 362                 // Now, remove the last entry, we don't care about the return value here, see elseif() block above
 363                 $this->partialStub('stackerName=' . $stackerName);
 364                 return NULL;
 365         }
 366
 367         /**
 368          * Checks whether the given stack is full
 369          *
 370          * @param       $stackerName    Name of the stack
 371          * @return      $isFull                 Whether the stack is full
 372          */
 373         protected function isStackFull ($stackerName) {
 374                 // File-based stacks will only run full if the disk space is low.
 375                 // @TODO Please implement this, returning FALSE
 376                 $isFull = FALSE;
 377
 378                 // Return result
 379                 return $isFull;
 380         }
 381
 382         /**
 383          * Checks whether the given stack is empty
 384          *
 385          * @param       $stackerName            Name of the stack
 386          * @return      $isEmpty                        Whether the stack is empty
 387          * @throws      NoStackerException      If given stack is missing
 388          */
 389         public function isStackEmpty ($stackerName) {
 390                 // So, is the stack empty?
 391                 $isEmpty = (($this->getStackCount($stackerName)) == 0);
 392
 393                 // Return result
 394                 return $isEmpty;
 395         }
 396
 397         /**
 398          * Initializes given stacker
 399          *
 400          * @param       $stackerName    Name of the stack
 401          * @param       $forceReInit    Force re-initialization
 402          * @return      void
 403          * @throws      UnsupportedOperationException   This method is not (and maybe never will be) supported
 404          */
 405         public function initStack ($stackerName, $forceReInit = FALSE) {
 406                 throw new UnsupportedOperationException(array($this, __FUNCTION__, $this->getIteratorInstance()->getPointerInstance()), self::EXCEPTION_UNSPPORTED_OPERATION);
 407         }
 408
 409         /**
 410          * Initializes all stacks
 411          *
 412          * @return      void
 413          * @throws      UnsupportedOperationException   This method is not (and maybe never will be) supported
 414          */
 415         public function initStacks (array $stacks, $forceReInit = FALSE) {
 416                 throw new UnsupportedOperationException(array($this, __FUNCTION__, $this->getIteratorInstance()->getPointerInstance()), self::EXCEPTION_UNSPPORTED_OPERATION);
 417         }
 418
 419         /**
 420          * Checks whether the given stack is initialized (set in array $stackers)
 421          *
 422          * @param       $stackerName    Name of the stack
 423          * @return      $isInitialized  Whether the stack is initialized
 424          * @throws      UnsupportedOperationException   This method is not (and maybe never will be) supported
 425          */
 426         public function isStackInitialized ($stackerName) {
 427                 throw new UnsupportedOperationException(array($this, __FUNCTION__, $this->getIteratorInstance()->getPointerInstance()), self::EXCEPTION_UNSPPORTED_OPERATION);
 428         }
 429
 430         /**
 431          * Getter for size of given stack (array count)
 432          *
 433          * @param       $stackerName    Name of the stack
 434          * @return      $count                  Size of stack (array count)
 435          */
 436         public function getStackCount ($stackerName) {
 437                 // Now, simply return the found count value, this must be up-to-date then!
 438                 return $this->getCounter();
 439         }
 440 }
 441
 442 // [EOF]
 443 ?>