X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=inc%2Fclasses%2Fmain%2Findex%2Fclass_BaseIndex.php;h=6dd651caf43d64d565716dfbfea6ca865223d21a;hp=29d0d52e10246f3824cb1db90afda4dae80c201d;hb=a1a6fe495d2e61dee317af1b45ee6821eb0027e5;hpb=5be92ee0bc0cba46404a391f569367bf2a2b6292 diff --git a/inc/classes/main/index/class_BaseIndex.php b/inc/classes/main/index/class_BaseIndex.php index 29d0d52e..6dd651ca 100644 --- a/inc/classes/main/index/class_BaseIndex.php +++ b/inc/classes/main/index/class_BaseIndex.php @@ -4,7 +4,7 @@ * * @author Roland Haeder * @version 0.0.0 - * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 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,16 +27,6 @@ class BaseIndex extends BaseFrameworkSystem { */ const INDEX_MAGIC = 'INDEXv0.1'; - /** - * Separator for header data - */ - const SEPARATOR_HEADER_DATA = 0x01; - - /** - * Separator header->entries - */ - const SEPARATOR_HEADER_ENTRIES = 0x02; - /** * Protected constructor * @@ -46,17 +36,6 @@ class BaseIndex extends BaseFrameworkSystem { protected function __construct ($className) { // Call parent constructor parent::__construct($className); - - // Calculate header size - $this->setHeaderSize( - strlen(self::INDEX_MAGIC) + - strlen(self::SEPARATOR_HEADER_DATA) + - self::LENGTH_COUNT + - strlen(self::SEPARATOR_HEADER_ENTRIES) - ); - - // Init counters and gaps array - $this->initCountersGapsArray(); } /** @@ -64,30 +43,30 @@ class BaseIndex extends BaseFrameworkSystem { * * @return void */ - 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: @@ -95,10 +74,10 @@ class BaseIndex extends BaseFrameworkSystem { * 0 => magic * 1 => total entries */ - $header = explode(chr(self::SEPARATOR_HEADER_DATA), $data); + $header = explode(chr(BaseBinaryFile::SEPARATOR_HEADER_DATA), $data); // Set it 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))); @@ -110,7 +89,7 @@ class BaseIndex extends BaseFrameworkSystem { //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] Passed assert().', __METHOD__, __LINE__)); // Check length of count - 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__)); // Decode count @@ -124,7 +103,7 @@ class BaseIndex extends BaseFrameworkSystem { * * @return void */ - protected function flushFileHeader () { + public function flushFileHeader () { //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] CALLED!', __METHOD__, __LINE__)); // Put all informations together @@ -133,93 +112,187 @@ class BaseIndex extends BaseFrameworkSystem { self::INDEX_MAGIC, // Separator header data - chr(self::SEPARATOR_HEADER_DATA), + chr(BaseBinaryFile::SEPARATOR_HEADER_DATA), // Total entries - 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 header<->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); + $this->getIteratorInstance()->writeData(0, $header, FALSE); //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] EXIT!', __METHOD__, __LINE__)); } /** - * 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). + * Initializes this index * + * @param $fileName File name of this index * @return void + * @todo Currently the index file is not cached, please implement a memory-handling class and if enough RAM is found, cache the whole index file. */ - private function analyzeFile () { - //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] CALLED!', __METHOD__, __LINE__)); + protected function initIndex ($fileName) { + // Append index file extension + $fileName .= $this->getConfigInstance()->getConfigEntry('index_extension'); - // Make sure the file is initialized - assert($this->isFileInitialized()); + // Get a file i/o pointer instance for index file + $fileInstance = ObjectFactory::createObjectByConfiguredName('index_file_class', array($fileName, $this)); + + // Get iterator instance + $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::INDEX_MAGIC) + + strlen(chr(BaseBinaryFile::SEPARATOR_HEADER_DATA)) + + BaseBinaryFile::LENGTH_COUNT + + strlen(chr(BaseBinaryFile::SEPARATOR_HEADER_ENTRIES)) + ); // Init counters and gaps array - $this->initGapsArray(); + $this->getIteratorInstance()->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__)); + // Is the file's header initialized? + if (!$this->getIteratorInstance()->isFileHeaderInitialized()) { + // No, then create it (which may pre-allocate the index) + $this->getIteratorInstance()->createFileHeader(); - //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] EXIT!', __METHOD__, __LINE__)); + // And pre-allocate a bit + $this->getIteratorInstance()->preAllocateFile('index'); + } // END - if + + // Load the file header + $this->readFileHeader(); + + // Count all entries in file + $this->getIteratorInstance()->analyzeFile(); } /** - * Calculates minimum length for one entry + * Calculates minimum length for one entry/block * - * @return $length Minimum length for one entry + * @return $length Minimum length for one entry/block */ - protected function caluclateMinimumFileEntryLength () { + public function calculateMinimumBlockLength () { // Calulcate it - // @TODO Not finished yet - $length = 0; + $length = BaseBinaryFile::LENGTH_TYPE + strlen(chr(BaseBinaryFile::SEPARATOR_TYPE_POSITION)) + BaseBinaryFile::LENGTH_POSITION + strlen(chr(BaseBinaryFile::SEPARATOR_ENTRIES)); // Return it return $length; } /** - * Initializes this index + * Determines whether the EOF has been reached * - * @param $fileName File name of this index - * @return void + * @return $isEndOfFileReached Whether the EOF has been reached + * @throws UnsupportedOperationException If this method is called */ - protected function initIndex ($fileName) { - // Append index file extension - $fileName .= $this->getConfigInstance()->getConfigEntry('index_extension'); + public function isEndOfFileReached () { + throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION); + } - // Get a file i/o pointer instance for index file - $pointerInstance = ObjectFactory::createObjectByConfiguredName('file_raw_input_output_class', array($fileName)); + /** + * Getter for file name + * + * @return $fileName The current file name + * @throws UnsupportedOperationException If this method is called + */ + public function getFileName () { + throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION); + } - // Get iterator instance - $iteratorInstance = ObjectFactory::createObjectByConfiguredName('file_io_iterator_class', array($pointerInstance)); + /** + * 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); + } - // Is the instance implementing the right interface? - assert($iteratorInstance instanceof SeekableWritableFileIterator); + /** + * 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); + } - // Set iterator here - $this->setIteratorInstance($iteratorInstance); + /** + * 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); + } - // Is the file's header initialized? - if (!$this->isFileHeaderInitialized()) { - // No, then create it (which may pre-allocate the index) - $this->createFileHeader(); + /** + * 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); + } - // And pre-allocate a bit - $this->preAllocateFile('index'); - } // END - if + /** + * 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); + } - // Load the file header - $this->readFileHeader(); + /** + * 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); + } - // Count all entries in file - $this->analyzeFile(); + /** + * 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); + } + + /** + * "Getter" for file size + * + * @return $fileSize Size of currently loaded file + */ + public function getFileSize () { + // Call iterator's method + return $this->getIteratorInstance()->getFileSize(); } }