inc/classes/main/iterator/io/class_FileIoIterator.php

   1 <?php
   2 /**
   3  * A file i/o iterator
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Hub 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 FileIoIterator extends BaseIterator implements SeekableWritableFileIterator {
  25         /**
  26          * Back-buffer
  27          */
  28         private $backBuffer = '';
  29
  30         /**
  31          * Currently loaded block (will be returned by current())
  32          */
  33         private $currentBlock = '';
  34
  35         /**
  36          * Protected constructor
  37          *
  38          * @return      void
  39          */
  40         protected function __construct () {
  41                 // Call parent constructor
  42                 parent::__construct(__CLASS__);
  43         }
  44
  45         /**
  46          * Creates an instance of this class
  47          *
  48          * @param       $pointerInstance        An instance of a InputOutputPointer class
  49          * @param       $blockInstance          An instance of a CalculatableBlock class
  50          * @return      $iteratorInstance       An instance of a Iterator class
  51          */
  52         public final static function createFileIoIterator (InputOutputPointer $pointerInstance, CalculatableBlock $blockInstance) {
  53                 // Get new instance
  54                 $iteratorInstance = new FileIoIterator();
  55
  56                 // Set the instance here
  57                 $iteratorInstance->setPointerInstance($pointerInstance);
  58
  59                 // Set the block instance here
  60                 $iteratorInstance->setBlockInstance($blockInstance);
  61
  62                 // Return the prepared instance
  63                 return $iteratorInstance;
  64         }
  65
  66         /**
  67          * Initializes the back-buffer by setting it to an empty string.
  68          *
  69          * @return      void
  70          */
  71         private function initBackBuffer () {
  72                 // Simply call the setter
  73                 $this->setBackBuffer('');
  74         }
  75
  76         /**
  77          * Setter for backBuffer field
  78          *
  79          * @param       $backBuffer             Characters to "store" in back-buffer
  80          * @return      void
  81          */
  82         private function setBackBuffer ($backBuffer) {
  83                 // Cast to string (so no arrays or objects)
  84                 $backBuffer = (string) $backBuffer;
  85
  86                 // ... and set it
  87                 $this->backBuffer = $backBuffer;
  88         }
  89
  90         /**
  91          * Getter for backBuffer field
  92          *
  93          * @return      $backBuffer             Characters "stored" in back-buffer
  94          */
  95         private function getBackBuffer () {
  96                 return $this->backBuffer;
  97         }
  98
  99         /**
 100          * Setter for currentBlock field
 101          *
 102          * @param       $currentBlock           Characters to set a currently loaded block
 103          * @return      void
 104          */
 105         private function setCurrentBlock ($currentBlock) {
 106                 // Cast to string (so no arrays or objects)
 107                 $currentBlock = (string) $currentBlock;
 108
 109                 // ... and set it
 110                 $this->currentBlock = $currentBlock;
 111         }
 112
 113         /**
 114          * Gets currently read data
 115          *
 116          * @return      $current        Currently read data
 117          */
 118         public function current () {
 119                 // Return it
 120                 return $this->currentBlock;
 121         }
 122
 123         /**
 124          * Gets current seek position ("key").
 125          *
 126          * @return      $key    Current key in iteration
 127          */
 128         public function key () {
 129                 // Return it
 130                 return $this->getPointerInstance()->determineSeekPosition();
 131         }
 132
 133         /**
 134          * Advances to next "block" of bytes
 135          *
 136          * @return      void
 137          */
 138         public function next () {
 139                 // Is there nothing to read?
 140                 if (!$this->valid()) {
 141                         // Nothing to read
 142                         return;
 143                 } // END - if
 144
 145                 // First calculate minimum block length
 146                 $length = $this->getBlockInstance()->caluclateMinimumBlockLength();
 147
 148                 // Short be more than zero!
 149                 assert($length > 0);
 150
 151                 // Wait until a entry/block separator has been found
 152                 $data = $this->getBackBuffer();
 153                 while ((!$this->getPointerInstance()->isEndOfFileReached()) && (!$this->getBlockInstance()->isBlockSeparatorFound($data))) {
 154                         // Then read the block
 155                         $data .= $this->read($length);
 156                         //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('data()=' . strlen($data));
 157                 } // END - if
 158
 159                 // EOF reached?
 160                 if ($this->getPointerInstance()->isEndOfFileReached()) {
 161                         // Set whole data as current block
 162                         //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('Calling setCurrentBlock(' . strlen($data) . ') ...');
 163                         $this->setCurrentBlock($data);
 164
 165                         // Then abort here silently
 166                         //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('EOF reached.');
 167                         return;
 168                 } // END - if
 169
 170                 /*
 171                  * Init back-buffer which is the data that has been found beyond the
 172                  * separator.
 173                  */
 174                 $this->initBackBuffer();
 175
 176                 // Separate data
 177                 $dataArray = explode(self::getBlockSeparator(), $data);
 178
 179                 // This array must contain two elements
 180                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('dataArray=' . print_r($dataArray, TRUE));
 181                 assert(count($dataArray) == 2);
 182
 183                 // Left part is the actual block, right one the back-buffer data
 184                 $this->setCurrentBlock($dataArray[0]);
 185                 $this->setBackBuffer($dataArray[1]);
 186         }
 187
 188         /**
 189          * Rewinds to the beginning of the file
 190          *
 191          * @return      $status         Status of this operation
 192          */
 193         public function rewind () {
 194                 // Call pointer instance
 195                 return $this->getPointerInstance()->rewind();
 196         }
 197
 198         /**
 199          * Checks wether the current entry is valid (not at the end of the file).
 200          * This method will return TRUE if an emptied (nulled) entry has been found.
 201          *
 202          * @return      $isValid        Whether the next entry is valid
 203          */
 204         public function valid () {
 205                 // First calculate minimum block length
 206                 $length = $this->getBlockInstance()->caluclateMinimumBlockLength();
 207
 208                 // Short be more than zero!
 209                 assert($length > 0);
 210
 211                 // Get current seek position
 212                 $seekPosition = $this->key();
 213
 214                 // Then try to read it
 215                 $data = $this->read($length);
 216
 217                 // If some bytes could be read, all is fine
 218                 $isValid = ((is_string($data)) && (strlen($data) > 0));
 219
 220                 // Get header size
 221                 $headerSize = $this->getBlockInstance()->getHeaderSize();
 222
 223                 // Is the seek position at or beyond the header?
 224                 if ($seekPosition >= $headerSize) {
 225                         // Seek back to old position
 226                         $this->seek($seekPosition);
 227                 } else {
 228                         // Seek directly behind the header
 229                         $this->seek($headerSize);
 230                 }
 231
 232                 // Return result
 233                 return $isValid;
 234         }
 235
 236         /**
 237          * Seeks to given position
 238          *
 239          * @param       $seekPosition   Seek position in file
 240          * @return      $status                 Status of this operation
 241          */
 242         public function seek ($seekPosition) {
 243                 // Call pointer instance
 244                 return $this->getPointerInstance()->seek($seekPosition);
 245         }
 246
 247         /**
 248          * Writes at given position by seeking to it.
 249          *
 250          * @param       $seekPosition   Seek position in file
 251          * @param       $data                   Data to be written
 252          * @return      void
 253          */
 254         public function writeAtPosition ($seekPosition, $data) {
 255                 // First seek to it
 256                 $this->seek($seekPosition);
 257
 258                 // Then write the data at that position
 259                 $this->getPointerInstance()->writeToFile($data);
 260         }
 261
 262         /**
 263          * Size of file stack
 264          *
 265          * @return      $size   Size (in bytes) of file
 266          */
 267         public function size () {
 268                 // Call the pointer object
 269                 $size = $this->getPointerInstance()->size();
 270
 271                 // Return result
 272                 return $size;
 273         }
 274
 275         /**
 276          * Reads given amount of bytes from file.
 277          *
 278          * @param       $bytes  Amount of bytes to read
 279          * @return      $data   Data read from file
 280          */
 281         public function read ($bytes) {
 282                 // Call pointer instance
 283                 return $this->getPointerInstance()->read($bytes);
 284         }
 285 }
 286
 287 // [EOF]
 288 ?>