Continued:

[core.git] / framework / main / classes / index / class_BaseIndex.php

diff --git a/framework/main/classes/index/class_BaseIndex.php b/framework/main/classes/index/class_BaseIndex.php
index 6f0c5a146275b35e016e4f64ce65990f0bfd2602..21a79b7de90db59812b24766444abdef30b7cd63 100644 (file)
--- a/framework/main/classes/index/class_BaseIndex.php
+++ b/framework/main/classes/index/class_BaseIndex.php
@@ -3,7 +3,7 @@
 namespace Org\Mxchange\CoreFramework\Index;
 
 // Import framework stuff
-use Org\Mxchange\CoreFramework\Factory\ObjectFactory;
+use Org\Mxchange\CoreFramework\Factory\Object\ObjectFactory;
 use Org\Mxchange\CoreFramework\Filesystem\File\BaseBinaryFile;
 use Org\Mxchange\CoreFramework\Generic\UnsupportedOperationException;
 use Org\Mxchange\CoreFramework\Iterator\Filesystem\SeekableWritableFileIterator;
@@ -42,24 +42,9 @@ abstract class BaseIndex extends BaseFrameworkSystem {
        use IteratorTrait;
 
        /**
-        * Magic for this index
+        * Minimum block length
         */
-       const INDEX_MAGIC = 'INDEXv0.1';
-
-       /**
-        * Separator group->hash
-        */
-       const SEPARATOR_GROUP_HASH = 0x01;
-
-       /**
-        * Separator hash->gap position
-        */
-       const SEPARATOR_HASH_GAP_POSITION = 0x02;
-
-       /**
-        * Separator gap position->length
-        */
-       const SEPARATOR_GAP_LENGTH = 0x03;
+       private static $minimumBlockLength = 0;
 
        /**
         * Protected constructor
@@ -76,7 +61,7 @@ abstract class BaseIndex extends BaseFrameworkSystem {
         * Reads the file header
         *
         * @return      void
-        * @throws      UnexpectedValueException        If header length is invalid
+        * @throws      UnexpectedValueException        If header length or count of elements is invalid
         */
        public function readFileHeader () {
                // First rewind to beginning as the header sits at the beginning ...
@@ -87,7 +72,7 @@ abstract class BaseIndex extends BaseFrameworkSystem {
                $data = $this->getIteratorInstance()->read($this->getIteratorInstance()->getHeaderSize());
 
                // Have all requested bytes been read?
-               /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('Read %d bytes (%d wanted).', strlen($data), $this->getIteratorInstance()->getHeaderSize()));
+               /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('BASE-INDEX: Read %d bytes (%d wanted).', strlen($data), $this->getIteratorInstance()->getHeaderSize()));
                if (strlen($data) != $this->getIteratorInstance()->getHeaderSize()) {
                        // Invalid header length
                        throw new UnexpectedValueException(sprintf('data(%d)=%s is not expected length %d',
@@ -117,22 +102,26 @@ abstract class BaseIndex extends BaseFrameworkSystem {
                 */
                $header = explode(chr(BaseBinaryFile::SEPARATOR_HEADER_DATA), $data);
 
-               // Set it here
-               $this->getIteratorInstance()->setHeader($header);
-
                // Check if the array has only 3 elements
-               /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('header(%d)=%s', count($header), print_r($header, true)));
-               assert(count($header) == 2);
-
-               // Check magic
-               assert($header[0] == self::INDEX_MAGIC);
-
-               // Check length of count
-               assert(strlen($header[1]) == BaseBinaryFile::LENGTH_COUNT);
+               /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('BASE-INDEX: header()=%d', count($header)));
+               //* PRINTR-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('BASE-INDEX: header(%d)=%s', count($header), print_r($header, true)));
+               if (count($header) != 2) {
+                       // Bad header
+                       throw new UnexpectedValueException(sprintf('header()=%d is not expected value 2', count($header)));
+               } elseif ($header[0] !== Indexable::INDEX_MAGIC) {
+                       // Magic must be in first element
+                       throw new UnexpectedValueException(sprintf('header[0]=%s is not the expected magic (%s)', $header[0], Indexable::INDEX_MAGIC));
+               } elseif (strlen($header[1]) != BaseBinaryFile::LENGTH_COUNT) {
+                       // Length of total entries not matching
+                       throw new UnexpectedValueException(sprintf('header[1](%d)=%s does not have expected length %d', strlen($header[1]), $header[1], BaseBinaryFile::LENGTH_COUNT));
+               }
 
                // Decode count
                $header[1] = hex2bin($header[1]);
 
+               // Set it here
+               $this->getIteratorInstance()->setHeader($header);
+
                // Trace message
                /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-INDEX: EXIT!');
        }
@@ -147,7 +136,7 @@ abstract class BaseIndex extends BaseFrameworkSystem {
                /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-INDEX: CALLED!');
                $header = sprintf('%s%s%s%s',
                        // Magic
-                       self::INDEX_MAGIC,
+                       Indexable::INDEX_MAGIC,
 
                        // Separator header data
                        chr(BaseBinaryFile::SEPARATOR_HEADER_DATA),
@@ -175,7 +164,7 @@ abstract class BaseIndex extends BaseFrameworkSystem {
         */
        protected function initIndex (SplFileInfo $fileInfoInstance) {
                // Get a file i/o pointer instance for index file
-               /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('fileInfoInstance[%s]=%s - CALLED!', get_class($fileInfoInstance), $fileInfoInstance));
+               /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('BASE-INDEX: fileInfoInstance[%s]=%s - CALLED!', get_class($fileInfoInstance), $fileInfoInstance));
                $fileInstance = ObjectFactory::createObjectByConfiguredName('index_file_class', array($fileInfoInstance, $this));
 
                // Get iterator instance
@@ -186,7 +175,7 @@ abstract class BaseIndex extends BaseFrameworkSystem {
 
                // Calculate header size
                $this->getIteratorInstance()->setHeaderSize(
-                       strlen(self::INDEX_MAGIC) +
+                       strlen(Indexable::INDEX_MAGIC) +
                        strlen(chr(BaseBinaryFile::SEPARATOR_HEADER_DATA)) +
                        BaseBinaryFile::LENGTH_COUNT +
                        strlen(chr(BaseBinaryFile::SEPARATOR_HEADER_ENTRIES))
@@ -220,13 +209,21 @@ abstract class BaseIndex extends BaseFrameworkSystem {
         * @return      $length         Minimum length for one entry/block
         */
        public function calculateMinimumBlockLength () {
-               // Calulcate it
+               // Is it "cached"?
                /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-INDEX: CALLED!');
-               $length = BaseBinaryFile::LENGTH_TYPE + strlen(chr(BaseBinaryFile::SEPARATOR_TYPE_POSITION)) + BaseBinaryFile::LENGTH_POSITION + strlen(chr(BaseBinaryFile::SEPARATOR_ENTRIES));
+               if (self::$minimumBlockLength == 0) {
+                       // Calulcate it
+                       self::$minimumBlockLength = (
+                               // Type
+                               BaseBinaryFile::LENGTH_TYPE + strlen(chr(BaseBinaryFile::SEPARATOR_TYPE_POSITION)) +
+                               // Position
+                               BaseBinaryFile::LENGTH_POSITION + strlen(chr(BaseBinaryFile::SEPARATOR_ENTRIES))
+                       );
+               }
 
                // Return it
-               /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('BASE-INDEX: length=%d - EXIT!', $length));
-               return $length;
+               /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('BASE-INDEX: self::minimumBlockLength=%d - EXIT!', self::$minimumBlockLength));
+               return self::$minimumBlockLength;
        }
 
        /**