-
- /**
- * Analyzes entries in index file. This will count all found (and valid)
- * entries, mark invalid as damaged and count gaps ("fragmentation"). If
- * only gaps are found, the file is considered as "virgin" (no entries).
- *
- * @return void
- */
- public function analyzeFile () {
- //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] CALLED!', __METHOD__, __LINE__));
-
- // Make sure the file is initialized
- assert($this->isFileInitialized());
-
- // Init counters and gaps array
- $this->initCountersGapsArray();
-
- // Output message (as this may take some time)
- self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] Analyzing file structure ... (this may take some time)', __METHOD__, __LINE__));
-
- // First rewind to the begining
- $this->rewind();
-
- // Then try to load all entries
- while ($this->valid()) {
- // Go to next entry
- $this->next();
-
- // Get current entry
- $current = $this->getCurrentBlock();
-
- // Debug message
- /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] current()=%s', __METHOD__, __LINE__, strlen($current)));
- } // END - while
-
- //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] EXIT!', __METHOD__, __LINE__));
- }
-
- /**
- * Advances to next "block" of bytes
- *
- * @return void
- * @todo This method will load large but empty files in a whole
- */
- public function next () {
- // Is there nothing to read?
- if (!$this->valid()) {
- // Nothing to read
- return;
- } // END - if
-
- // Make sure the block instance is set
- assert($this->getBlockInstance() instanceof CalculatableBlock);
-
- // First calculate minimum block length
- $length = $this->getBlockInstance()->calculateMinimumBlockLength();
-
- // Short be more than zero!
- assert($length > 0);
-
- // Wait until a entry/block separator has been found
- $data = $this->getBackBuffer();
- while ((!$this->isEndOfFileReached()) && (!self::isBlockSeparatorFound($data))) {
- // Then read the block
- $data .= $this->read($length);
- //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('data()=' . strlen($data));
- } // END - if
-
- // EOF reached?
- if ($this->isEndOfFileReached()) {
- // Set whole data as current block
- //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('Calling setCurrentBlock(' . strlen($data) . ') ...');
- $this->setCurrentBlock($data);
-
- // Then abort here silently
- //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('EOF reached.');
- return;
- } // END - if
-
- /*
- * Init back-buffer which is the data that has been found beyond the
- * separator.
- */
- $this->initBackBuffer();
-
- // Separate data
- $dataArray = explode(self::getBlockSeparator(), $data);
-
- // This array must contain two elements
- //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('dataArray=' . print_r($dataArray, TRUE));
- assert(count($dataArray) == 2);
-
- // Left part is the actual block, right one the back-buffer data
- $this->setCurrentBlock($dataArray[0]);
- $this->setBackBuffer($dataArray[1]);
- }
-
- /**
- * Checks wether the current entry is valid (not at the end of the file).
- * This method will return TRUE if an emptied (nulled) entry has been found.
- *
- * @return $isValid Whether the next entry is valid
- */
- public function valid () {
- // Make sure the block instance is set
- assert($this->getBlockInstance() instanceof CalculatableBlock);
-
- // First calculate minimum block length
- $length = $this->getBlockInstance()->calculateMinimumBlockLength();
-
- // Short be more than zero!
- assert($length > 0);
-
- // Get current seek position
- $seekPosition = $this->key();
-
- // Then try to read it
- $data = $this->read($length);
-
- // If some bytes could be read, all is fine
- $isValid = ((is_string($data)) && (strlen($data) > 0));
-
- // Get header size
- $headerSize = $this->getBlockInstance()->getHeaderSize();
-
- // Is the seek position at or beyond the header?
- if ($seekPosition >= $headerSize) {
- // Seek back to old position
- $this->seek($seekPosition);
- } else {
- // Seek directly behind the header
- $this->seek($headerSize);
- }
-
- // Return result
- return $isValid;
- }
-
- /**
- * Gets current seek position ("key").
- *
- * @return $key Current key in iteration
- */
- public function key () {
- // Call pointer instance
- return $this->getPointerInstance()->determineSeekPosition();
- }