*
* @author Roland Haeder <webmaster@ship-simu.org>
* @version 0.0.0
- * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 Core Developer Team
+ * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
* @license GNU GPL 3.0 or any newer version
* @link http://www.ship-simu.org
*
*/
const STACK_MAGIC = 'STACKv0.1';
+ /**
+ * Name of array index for gap position
+ */
+ const ARRAY_INDEX_GAP_POSITION = 'gap';
+
+ /**
+ * Name of array index for hash
+ */
+ const ARRAY_INDEX_HASH = 'hash';
+
+ /**
+ * Name of array index for length of raw data
+ */
+ const ARRAY_INDEX_DATA_LENGTH = 'length';
+
/**
* Protected constructor
*
protected function __construct ($className) {
// Call parent constructor
parent::__construct($className);
-
- // Calculate header size
- $this->setHeaderSize(
- strlen(self::STACK_MAGIC) +
- strlen(self::SEPARATOR_HEADER_DATA) +
- self::LENGTH_COUNT +
- strlen(self::SEPARATOR_HEADER_DATA) +
- self::LENGTH_POSITION +
- strlen(self::SEPARATOR_HEADER_ENTRIES)
- );
-
- // Init counters and gaps array
- $this->initCountersGapsArray();
}
/**
* Reads the file header
*
* @return void
+ * @todo To hard assertions here, better rewrite them to exceptions
*/
- protected function readFileHeader () {
+ public function readFileHeader () {
//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] CALLED!', __METHOD__, __LINE__));
// First rewind to beginning as the header sits at the beginning ...
$this->getIteratorInstance()->rewind();
// Then read it (see constructor for calculation)
- $data = $this->getIteratorInstance()->read($this->getHeaderSize());
- //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] Read %d bytes (%d wanted).', __METHOD__, __LINE__, strlen($data), $this->getHeaderSize()));
+ $data = $this->getIteratorInstance()->read($this->getIteratorInstance()->getHeaderSize());
+ //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] Read %d bytes (%d wanted).', __METHOD__, __LINE__, strlen($data), $this->getIteratorInstance()->getHeaderSize()));
// Have all requested bytes been read?
- assert(strlen($data) == $this->getHeaderSize());
+ assert(strlen($data) == $this->getIteratorInstance()->getHeaderSize());
//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] Passed assert().', __METHOD__, __LINE__));
// Last character must be the separator
//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] data(-1)=%s', __METHOD__, __LINE__, dechex(ord(substr($data, -1, 1)))));
- assert(substr($data, -1, 1) == chr(self::SEPARATOR_HEADER_ENTRIES));
+ assert(substr($data, -1, 1) == chr(BaseBinaryFile::SEPARATOR_HEADER_ENTRIES));
//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] Passed assert().', __METHOD__, __LINE__));
// Okay, then remove it
$data = substr($data, 0, -1);
// And update seek position
- $this->updateSeekPosition();
+ $this->getIteratorInstance()->updateSeekPosition();
/*
* Now split it:
* 1 => total entries
* 2 => current seek position
*/
- $header = explode(chr(self::SEPARATOR_HEADER_DATA), $data);
+ $header = explode(chr(BaseBinaryFile::SEPARATOR_HEADER_DATA), $data);
// Set header here
- $this->setHeader($header);
+ $this->getIteratorInstance()->setHeader($header);
// Check if the array has only 3 elements
//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] header(%d)=%s', __METHOD__, __LINE__, count($header), print_r($header, TRUE)));
//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] Passed assert().', __METHOD__, __LINE__));
// Check length of count and seek position
- assert(strlen($header[1]) == self::LENGTH_COUNT);
+ assert(strlen($header[1]) == BaseBinaryFile::LENGTH_COUNT);
//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] Passed assert().', __METHOD__, __LINE__));
- assert(strlen($header[2]) == self::LENGTH_POSITION);
+ assert(strlen($header[2]) == BaseBinaryFile::LENGTH_POSITION);
//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] Passed assert().', __METHOD__, __LINE__));
// Decode count and seek position
*
* @return void
*/
- protected function flushFileHeader () {
+ public function flushFileHeader () {
//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] CALLED!', __METHOD__, __LINE__));
// Put all informations together
self::STACK_MAGIC,
// Separator magic<->count
- chr(self::SEPARATOR_HEADER_DATA),
+ chr(BaseBinaryFile::SEPARATOR_HEADER_DATA),
// Total entries (will be zero) and pad it to 20 chars
- str_pad($this->dec2hex($this->getCounter()), self::LENGTH_COUNT, '0', STR_PAD_LEFT),
+ str_pad($this->dec2hex($this->getIteratorInstance()->getCounter()), BaseBinaryFile::LENGTH_COUNT, '0', STR_PAD_LEFT),
// Separator count<->seek position
- chr(self::SEPARATOR_HEADER_DATA),
+ chr(BaseBinaryFile::SEPARATOR_HEADER_DATA),
// Position (will be zero)
- str_pad($this->dec2hex($this->getSeekPosition(), 2), self::LENGTH_POSITION, '0', STR_PAD_LEFT),
+ str_pad($this->dec2hex($this->getIteratorInstance()->getSeekPosition(), 2), BaseBinaryFile::LENGTH_POSITION, '0', STR_PAD_LEFT),
// Separator position<->entries
- chr(self::SEPARATOR_HEADER_ENTRIES)
+ chr(BaseBinaryFile::SEPARATOR_HEADER_ENTRIES)
);
// Write it to disk (header is always at seek position 0)
- $this->writeData(0, $header, FALSE);
-
- //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] EXIT!', __METHOD__, __LINE__));
- }
-
- /**
- * Analyzes entries in stack 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
- */
- private 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->getIteratorInstance()->rewind();
-
- // Then try to load all entries
- while ($this->getIteratorInstance()->valid()) {
- // Go to next entry
- $this->getIteratorInstance()->next();
-
- // Get current entry
- $current = $this->getIteratorInstance()->current();
-
- // Simply output it
- self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] current=%s', __METHOD__, __LINE__, print_r($current, TRUE)));
- } // END - while
+ $this->getIteratorInstance()->writeData(0, $header, FALSE);
//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] EXIT!', __METHOD__, __LINE__));
}
*/
protected function initFileStack ($fileName, $type) {
// Get a stack file instance
- $fileInstance = ObjectFactory::createObjectByConfiguredName('stack_file_class', array($fileName));
+ $fileInstance = ObjectFactory::createObjectByConfiguredName('stack_file_class', array($fileName, $this));
// Get iterator instance
- $iteratorInstance = ObjectFactory::createObjectByConfiguredName('file_io_iterator_class', array($fileInstance, $this));
+ $iteratorInstance = ObjectFactory::createObjectByConfiguredName('file_iterator_class', array($fileInstance));
// Is the instance implementing the right interface?
assert($iteratorInstance instanceof SeekableWritableFileIterator);
// Set iterator here
$this->setIteratorInstance($iteratorInstance);
+ // Calculate header size
+ $this->getIteratorInstance()->setHeaderSize(
+ strlen(self::STACK_MAGIC) +
+ strlen(chr(BaseBinaryFile::SEPARATOR_HEADER_DATA)) +
+ BaseBinaryFile::LENGTH_COUNT +
+ strlen(chr(BaseBinaryFile::SEPARATOR_HEADER_DATA)) +
+ BaseBinaryFile::LENGTH_POSITION +
+ strlen(chr(BaseBinaryFile::SEPARATOR_HEADER_ENTRIES))
+ );
+
+ // Init counters and gaps array
+ $this->getIteratorInstance()->initCountersGapsArray();
+
// Is the file's header initialized?
- if (!$this->isFileHeaderInitialized()) {
+ if (!$this->getIteratorInstance()->isFileHeaderInitialized()) {
// No, then create it (which may pre-allocate the stack)
- $this->createFileHeader();
+ $this->getIteratorInstance()->createFileHeader();
// And pre-allocate a bit
- $this->preAllocateFile('file_stack');
+ $this->getIteratorInstance()->preAllocateFile('file_stack');
} // END - if
// Load the file header
$this->readFileHeader();
// Count all entries in file
- $this->analyzeFile();
+ $this->getIteratorInstance()->analyzeFile();
/*
* Get stack index instance. This can be used for faster
throw new FullStackerException(array($this, $stackerName, $value), self::EXCEPTION_STACKER_IS_FULL);
} // END - if
- // Now add the value to the stack
- $this->partialStub('stackerName=' . $stackerName . ',value[]=' . gettype($value));
+ // Debug message
+ //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . '] stackerName=' . $stackerName . ',value[' . gettype($value) . ']=' . print_r($value, TRUE));
+
+ // No objects/resources are allowed as their serialization takes to long
+ assert(!is_object($value));
+ assert(!is_resource($value));
+
+ /*
+ * Now add the value to the file stack which returns gap position, a
+ * hash and length of the raw data.
+ */
+ $data = $this->getIteratorInstance()->writeValueToFile($stackerName, $value);
+
+ // Add the hash and gap position to the index
+ $this->getIndexInstance()->addHashToIndex($stackerName, $data);
}
/**
} // END - if
// Now get the last value
- $this->partialStub('stackerName=' . $stackerName);
+ /* NOISY-DEBUG: */ $this->partialStub('[' . __METHOD__ . ':' . __LINE__ . '] stackerName=' . $stackerName);
$value = NULL;
// Return it
} // END - if
// Now get the first value
- $this->partialStub('stackerName=' . $stackerName);
+ /* NOISY-DEBUG: */ $this->partialStub('[' . __METHOD__ . ':' . __LINE__ . '] stackerName=' . $stackerName);
$value = NULL;
// Return it
} // END - if
// Now, remove the last entry, we don't care about the return value here, see elseif() block above
- $this->partialStub('stackerName=' . $stackerName);
+ /* NOISY-DEBUG: */ $this->partialStub('[' . __METHOD__ . ':' . __LINE__ . '] stackerName=' . $stackerName);
return NULL;
}
} // END - if
// Now, remove the last entry, we don't care about the return value here, see elseif() block above
- $this->partialStub('stackerName=' . $stackerName);
+ /* NOISY-DEBUG: */ $this->partialStub('[' . __METHOD__ . ':' . __LINE__ . '] stackerName=' . $stackerName);
return NULL;
}
throw new UnsupportedOperationException(array($this, __FUNCTION__, $this->getIteratorInstance()->getPointerInstance()), self::EXCEPTION_UNSPPORTED_OPERATION);
}
+ /**
+ * Determines whether the EOF has been reached
+ *
+ * @return $isEndOfFileReached Whether the EOF has been reached
+ * @throws UnsupportedOperationException This method is not (and maybe never will be) supported
+ */
+ public function isEndOfFileReached () {
+ throw new UnsupportedOperationException(array($this, __FUNCTION__, $this->getIteratorInstance()->getPointerInstance()), self::EXCEPTION_UNSPPORTED_OPERATION);
+ }
+
+ /**
+ * Getter for file name
+ *
+ * @return $fileName The current file name
+ * @throws UnsupportedOperationException This method is not (and maybe never will be) supported
+ */
+ public function getFileName () {
+ throw new UnsupportedOperationException(array($this, __FUNCTION__, $this->getIteratorInstance()->getPointerInstance()), self::EXCEPTION_UNSPPORTED_OPERATION);
+ }
+
/**
* Getter for size of given stack (array count)
*
*/
public function getStackCount ($stackerName) {
// Now, simply return the found count value, this must be up-to-date then!
- return $this->getCounter();
+ return $this->getIteratorInstance()->getCounter();
}
/**
*
* @return $length Minimum length for one entry/block
*/
- public function caluclateMinimumBlockLength () {
+ public function calculateMinimumBlockLength () {
// Calulcate it
- $length = self::getHashLength() + strlen(chr(self::SEPARATOR_HASH_NAME)) + self::LENGTH_NAME + 1 + strlen(self::getBlockSeparator());
+ $length =
+ // Length of entry group
+ BaseBinaryFile::LENGTH_GROUP + strlen(chr(BaseBinaryFile::SEPARATOR_GROUP_HASH)) +
+ // Hash + value
+ self::getHashLength() + strlen(chr(BaseBinaryFile::SEPARATOR_HASH_VALUE)) + 1 +
+ // Final separator
+ strlen(chr(BaseBinaryFile::SEPARATOR_ENTRIES));
// Return it
return $length;
}
+
+ /**
+ * Initializes counter for valid entries, arrays for damaged entries and
+ * an array for gap seek positions. If you call this method on your own,
+ * please re-analyze the file structure. So you are better to call
+ * analyzeFile() instead of this method.
+ *
+ * @return void
+ * @throws UnsupportedOperationException This method is not (and maybe never will be) supported
+ */
+ public function initCountersGapsArray () {
+ throw new UnsupportedOperationException(array($this, __FUNCTION__, $this->getIteratorInstance()->getPointerInstance()), self::EXCEPTION_UNSPPORTED_OPERATION);
+ }
+
+ /**
+ * Getter for header size
+ *
+ * @return $totalEntries Size of file header
+ * @throws UnsupportedOperationException This method is not (and maybe never will be) supported
+ */
+ public final function getHeaderSize () {
+ throw new UnsupportedOperationException(array($this, __FUNCTION__, $this->getIteratorInstance()->getPointerInstance()), self::EXCEPTION_UNSPPORTED_OPERATION);
+ }
+
+ /**
+ * Setter for header size
+ *
+ * @param $headerSize Size of file header
+ * @return void
+ * @throws UnsupportedOperationException This method is not (and maybe never will be) supported
+ */
+ public final function setHeaderSize ($headerSize) {
+ throw new UnsupportedOperationException(array($this, __FUNCTION__, $this->getIteratorInstance()->getPointerInstance()), self::EXCEPTION_UNSPPORTED_OPERATION);
+ }
+
+ /**
+ * Getter for header array
+ *
+ * @return $totalEntries Size of file header
+ * @throws UnsupportedOperationException This method is not (and maybe never will be) supported
+ */
+ public final function getHeader () {
+ throw new UnsupportedOperationException(array($this, __FUNCTION__, $this->getIteratorInstance()->getPointerInstance()), self::EXCEPTION_UNSPPORTED_OPERATION);
+ }
+
+ /**
+ * Setter for header
+ *
+ * @param $header Array for a file header
+ * @return void
+ * @throws UnsupportedOperationException This method is not (and maybe never will be) supported
+ */
+ public final function setHeader (array $header) {
+ throw new UnsupportedOperationException(array($this, __FUNCTION__, $this->getIteratorInstance()->getPointerInstance()), self::EXCEPTION_UNSPPORTED_OPERATION);
+ }
+
+ /**
+ * Updates seekPosition attribute from file to avoid to much access on file.
+ *
+ * @return void
+ * @throws UnsupportedOperationException This method is not (and maybe never will be) supported
+ */
+ public function updateSeekPosition () {
+ throw new UnsupportedOperationException(array($this, __FUNCTION__, $this->getIteratorInstance()->getPointerInstance()), self::EXCEPTION_UNSPPORTED_OPERATION);
+ }
+
+ /**
+ * Getter for total entries
+ *
+ * @return $totalEntries Total entries in this file
+ * @throws UnsupportedOperationException This method is not (and maybe never will be) supported
+ */
+ public final function getCounter () {
+ throw new UnsupportedOperationException(array($this, __FUNCTION__, $this->getIteratorInstance()->getPointerInstance()), self::EXCEPTION_UNSPPORTED_OPERATION);
+ }
+
+ /**
+ * Writes data at given position
+ *
+ * @param $seekPosition Seek position
+ * @param $data Data to be written
+ * @param $flushHeader Whether to flush the header (default: flush)
+ * @return void
+ * @throws UnsupportedOperationException This method is not (and maybe never will be) supported
+ */
+ public function writeData ($seekPosition, $data, $flushHeader = TRUE) {
+ /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] seekPosition=%s,data[]=%s,flushHeader=%d', __METHOD__, __LINE__, $seekPosition, gettype($data), intval($flushHeader)));
+ throw new UnsupportedOperationException(array($this, __FUNCTION__, $this->getIteratorInstance()->getPointerInstance()), self::EXCEPTION_UNSPPORTED_OPERATION);
+ }
+
+ /**
+ * Writes given value to the file and returns a hash and gap position for it
+ *
+ * @param $groupId Group identifier
+ * @param $value Value to be added to the stack
+ * @return $data Hash and gap position
+ * @throws UnsupportedOperationException This method is not (and maybe never will be) supported
+ */
+ public function writeValueToFile ($groupId, $value) {
+ /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] groupId=%s,value[%s]=%s', __METHOD__, __LINE__, $groupId, gettype($value), print_r($value, TRUE)));
+ throw new UnsupportedOperationException(array($this, __FUNCTION__, $this->getIteratorInstance()->getPointerInstance()), self::EXCEPTION_UNSPPORTED_OPERATION);
+ }
+
+ /**
+ * Searches for next suitable gap the given length of data can fit in
+ * including padding bytes.
+ *
+ * @param $length Length of raw data
+ * @return $seekPosition Found next gap's seek position
+ * @throws UnsupportedOperationException This method is not (and maybe never will be) supported
+ */
+ public function searchNextGap ($length) {
+ /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] length=%s', __METHOD__, __LINE__, $length));
+ throw new UnsupportedOperationException(array($this, __FUNCTION__, $this->getIteratorInstance()->getPointerInstance()), self::EXCEPTION_UNSPPORTED_OPERATION);
+ }
+
+ /**
+ * "Getter" for file size
+ *
+ * @return $fileSize Size of currently loaded file
+ */
+ public function getFileSize () {
+ // Call iterator's method
+ return $this->getIteratorInstance()->getFileSize();
+ }
+
+ /**
+ * Writes given raw data to the file and returns a gap position and length
+ *
+ * @param $groupId Group identifier
+ * @param $hash Hash from encoded value
+ * @param $encoded Encoded value to be written to the file
+ * @return $data Gap position and length of the raw data
+ */
+ public function writeDataToFreeGap ($groupId, $hash, $encoded) {
+ // Debug message
+ /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] groupId=%s,hash=%s,encoded()=%d - CALLED!', __METHOD__, __LINE__, $groupId, $hash, strlen($encoded)));
+
+ // Raw data been written to the file
+ $rawData = sprintf('%s%s%s%s%s',
+ $groupId,
+ BaseBinaryFile::SEPARATOR_GROUP_HASH,
+ hex2bin($hash),
+ BaseBinaryFile::SEPARATOR_HASH_VALUE,
+ $encoded
+ );
+
+ // Debug message
+ /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] groupId=%s,hash=%s,rawData()=%d', __METHOD__, __LINE__, $groupId, $hash, strlen($rawData)));
+
+ // Search for next free gap
+ $gapPosition = $this->getIteratorInstance()->searchNextGap(strlen($rawData));
+
+ // Gap position cannot be smaller than header length + 1
+ assert($gapPosition > $this->getIteratorInstance()->getHeaderSize());
+
+ // Debug message
+ /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] groupId=%s,hash=%s,gapPosition=%s', __METHOD__, __LINE__, $groupId, $hash, $gapPosition));
+
+ // Then write the data at that gap
+ $this->getIteratorInstance()->writeData($gapPosition, $rawData);
+
+ // Debug message
+ /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] groupId=%s,hash=%s,rawData()=%d - EXIT!', __METHOD__, __LINE__, $groupId, $hash, strlen($rawData)));
+
+ // Return gap position, hash and length of raw data
+ return array(
+ self::ARRAY_INDEX_GAP_POSITION => $gapPosition,
+ self::ARRAY_INDEX_HASH => $hash,
+ self::ARRAY_INDEX_DATA_LENGTH => strlen($rawData)
+ );
+ }
}
// [EOF]
projects / core.git / blobdiff