X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;ds=sidebyside;f=inc%2Fclasses%2Fmain%2Fstacker%2Ffile%2Fclass_BaseFileStack.php;h=14972d7316d8580fefe7f1329f94d03686d65bf9;hb=bde1a7331a8a5c1e4a304583c0db268026aeb8a8;hp=b70d1ded3206135379420145f74067098a769f9e;hpb=09e0d01cf5fc1e7ba5bc0c63751ea967bea9b4c9;p=core.git diff --git a/inc/classes/main/stacker/file/class_BaseFileStack.php b/inc/classes/main/stacker/file/class_BaseFileStack.php index b70d1ded..14972d73 100644 --- a/inc/classes/main/stacker/file/class_BaseFileStack.php +++ b/inc/classes/main/stacker/file/class_BaseFileStack.php @@ -4,7 +4,7 @@ * * @author Roland Haeder * @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 * @@ -27,6 +27,21 @@ class BaseFileStack extends BaseStacker { */ 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 * @@ -36,19 +51,6 @@ class BaseFileStack extends BaseStacker { protected function __construct ($className) { // Call parent constructor parent::__construct($className); - - // Calculate header size - $this->setHeaderSize( - strlen(self::STACK_MAGIC) + - strlen(chr(BaseFile::SEPARATOR_HEADER_DATA)) + - self::LENGTH_COUNT + - strlen(chr(BaseFile::SEPARATOR_HEADER_DATA)) + - self::LENGTH_POSITION + - strlen(chr(BaseFile::SEPARATOR_HEADER_ENTRIES)) - ); - - // Init counters and gaps array - $this->initCountersGapsArray(); } /** @@ -64,23 +66,23 @@ class BaseFileStack extends BaseStacker { $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(BaseFile::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: @@ -89,10 +91,10 @@ class BaseFileStack extends BaseStacker { * 1 => total entries * 2 => current seek position */ - $header = explode(chr(BaseFile::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))); @@ -104,9 +106,9 @@ class BaseFileStack extends BaseStacker { //* 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 @@ -130,23 +132,23 @@ class BaseFileStack extends BaseStacker { self::STACK_MAGIC, // Separator magic<->count - chr(BaseFile::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(BaseFile::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(BaseFile::SEPARATOR_HEADER_ENTRIES) + chr(BaseBinaryFile::SEPARATOR_HEADER_ENTRIES) ); // Write it to disk (header is always at seek position 0) - $this->writeData(0, $header, FALSE); + $this->getIteratorInstance()->writeData(0, $header, FALSE); //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] EXIT!', __METHOD__, __LINE__)); } @@ -172,6 +174,19 @@ class BaseFileStack extends BaseStacker { // 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->getIteratorInstance()->isFileHeaderInitialized()) { // No, then create it (which may pre-allocate the stack) @@ -212,8 +227,18 @@ class BaseFileStack extends BaseStacker { 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 a hash) + $data = $this->getIteratorInstance()->writeValueToFile($stackerName, $value); + + // Add the hash and gap position to the index + $this->getIndexInstance()->addHashToIndex($stackerName, $data); } /** @@ -231,7 +256,7 @@ class BaseFileStack extends BaseStacker { } // END - if // Now get the last value - $this->partialStub('stackerName=' . $stackerName); + /* NOISY-DEBUG: */ $this->partialStub('[' . __METHOD__ . ':' . __LINE__ . '] stackerName=' . $stackerName); $value = NULL; // Return it @@ -253,7 +278,7 @@ class BaseFileStack extends BaseStacker { } // END - if // Now get the first value - $this->partialStub('stackerName=' . $stackerName); + /* NOISY-DEBUG: */ $this->partialStub('[' . __METHOD__ . ':' . __LINE__ . '] stackerName=' . $stackerName); $value = NULL; // Return it @@ -275,7 +300,7 @@ class BaseFileStack extends BaseStacker { } // 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; } @@ -294,7 +319,7 @@ class BaseFileStack extends BaseStacker { } // 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; } @@ -361,17 +386,6 @@ class BaseFileStack extends BaseStacker { throw new UnsupportedOperationException(array($this, __FUNCTION__, $this->getIteratorInstance()->getPointerInstance()), self::EXCEPTION_UNSPPORTED_OPERATION); } - /** - * Close a file source and set it's instance to null and the file name - * to empty. - * - * @return void - * @throws UnsupportedOperationException This method is not (and maybe never will be) supported - */ - public function closeFile () { - throw new UnsupportedOperationException(array($this, __FUNCTION__, $this->getIteratorInstance()->getPointerInstance()), self::EXCEPTION_UNSPPORTED_OPERATION); - } - /** * Determines whether the EOF has been reached * @@ -400,7 +414,7 @@ class BaseFileStack extends BaseStacker { */ 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(); } /** @@ -410,11 +424,189 @@ class BaseFileStack extends BaseStacker { */ public function calculateMinimumBlockLength () { // Calulcate it - $length = self::getHashLength() + strlen(chr(BaseFile::SEPARATOR_HASH_NAME)) + self::LENGTH_NAME + 1 + strlen(chr(BaseFile::SEPARATOR_ENTRIES)); + $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()=%s - 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()=%s', __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()=%s - 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]