X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;ds=sidebyside;f=inc%2Fclasses%2Fmain%2Findex%2Fclass_BaseIndex.php;h=1b0b153317321254242616e9bd4a8c1120525d6f;hb=1bceb461c6e71bc2f97bdf1b7ab544055021a246;hp=d4a2c6b6023d0a5ce4532e573750eb53486f1e26;hpb=6d54ef031eb27d1b9a46ce92f39a3c9b19633eb3;p=core.git

diff --git a/inc/classes/main/index/class_BaseIndex.php b/inc/classes/main/index/class_BaseIndex.php
index d4a2c6b6..1b0b1533 100644
--- a/inc/classes/main/index/class_BaseIndex.php
+++ b/inc/classes/main/index/class_BaseIndex.php
@@ -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
 	 *
@@ -50,9 +40,9 @@ class BaseIndex extends BaseFrameworkSystem {
 		// Calculate header size
 		$this->setHeaderSize(
 			strlen(self::INDEX_MAGIC) +
-			strlen(self::SEPARATOR_HEADER_DATA) +
-			self::LENGTH_COUNT +
-			strlen(self::SEPARATOR_HEADER_ENTRIES)
+			strlen(chr(BaseFile::SEPARATOR_HEADER_DATA)) +
+			BaseFile::LENGTH_COUNT +
+			strlen(chr(BaseFile::SEPARATOR_HEADER_ENTRIES))
 		);
 
 		// Init counters and gaps array
@@ -64,7 +54,7 @@ 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 ...
@@ -80,7 +70,7 @@ class BaseIndex extends BaseFrameworkSystem {
 
 		// 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(BaseFile::SEPARATOR_HEADER_ENTRIES));
 		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] Passed assert().', __METHOD__, __LINE__));
 
 		// Okay, then remove it
@@ -95,7 +85,7 @@ class BaseIndex extends BaseFrameworkSystem {
 		 * 0 => magic
 		 * 1 => total entries
 		 */
-		$header = explode(chr(self::SEPARATOR_HEADER_DATA), $data);
+		$header = explode(chr(BaseFile::SEPARATOR_HEADER_DATA), $data);
 
 		// Set it here
 		$this->setHeader($header);
@@ -110,7 +100,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]) == BaseFile::LENGTH_COUNT);
 		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] Passed assert().', __METHOD__, __LINE__));
 
 		// Decode count
@@ -124,7 +114,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,13 +123,13 @@ class BaseIndex extends BaseFrameworkSystem {
 			self::INDEX_MAGIC,
 
 			// Separator header data
-			chr(self::SEPARATOR_HEADER_DATA),
+			chr(BaseFile::SEPARATOR_HEADER_DATA),
 
 			// Total entries
-			str_pad($this->dec2hex($this->getCounter()), self::LENGTH_COUNT, '0', STR_PAD_LEFT),
+			str_pad($this->dec2hex($this->getCounter()), BaseFile::LENGTH_COUNT, '0', STR_PAD_LEFT),
 
 			// Separator header<->entries
-			chr(self::SEPARATOR_HEADER_ENTRIES)
+			chr(BaseFile::SEPARATOR_HEADER_ENTRIES)
 		);
 
 		// Write it to disk (header is always at seek position 0)
@@ -148,54 +138,6 @@ class BaseIndex extends BaseFrameworkSystem {
 		//* 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).
-	 *
-	 * @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()->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
-
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] EXIT!', __METHOD__, __LINE__));
-	}
-
-	/**
-	 * Calculates minimum length for one entry
-	 *
-	 * @return	$length		Minimum length for one entry
-	 */
-	protected function caluclateMinimumFileEntryLength () {
-		// Calulcate it
-		// @TODO Not finished yet
-		$length = 0;
-
-		// Return it
-		return $length;
-	}
-
 	/**
 	 * Initializes this index
 	 *
@@ -208,10 +150,10 @@ class BaseIndex extends BaseFrameworkSystem {
 		$fileName .= $this->getConfigInstance()->getConfigEntry('index_extension');
 
 		// Get a file i/o pointer instance for index file
-		$fileInstance = ObjectFactory::createObjectByConfiguredName('index_file_class', array($fileName));
+		$fileInstance = ObjectFactory::createObjectByConfiguredName('index_file_class', array($fileName, $this));
 
 		// Get iterator instance
-		$iteratorInstance = ObjectFactory::createObjectByConfiguredName('file_io_iterator_class', array($fileInstance));
+		$iteratorInstance = ObjectFactory::createObjectByConfiguredName('file_iterator_class', array($fileInstance));
 
 		// Is the instance implementing the right interface?
 		assert($iteratorInstance instanceof SeekableWritableFileIterator);
@@ -220,19 +162,63 @@ class BaseIndex extends BaseFrameworkSystem {
 		$this->setIteratorInstance($iteratorInstance);
 
 		// Is the file's header initialized?
-		if (!$this->isFileHeaderInitialized()) {
+		if (!$this->getIteratorInstance()->isFileHeaderInitialized()) {
 			// No, then create it (which may pre-allocate the index)
-			$this->createFileHeader();
+			$this->getIteratorInstance()->createFileHeader();
 
 			// And pre-allocate a bit
-			$this->preAllocateFile('index');
+			$this->getIteratorInstance()->preAllocateFile('index');
 		} // END - if
 
 		// Load the file header
 		$this->readFileHeader();
 
 		// Count all entries in file
-		$this->analyzeFile();
+		$this->getIteratorInstance()->analyzeFile();
+	}
+
+	/**
+	 * Calculates minimum length for one entry/block
+	 *
+	 * @return	$length		Minimum length for one entry/block
+	 */
+	public function calculateMinimumBlockLength () {
+		// Calulcate it
+		$length = BaseFile::LENGTH_TYPE + strlen(chr(BaseFile::SEPARATOR_TYPE_POSITION)) + BaseFile::LENGTH_POSITION + strlen(chr(BaseFile::SEPARATOR_ENTRIES));
+
+		// Return it
+		return $length;
+	}
+
+	/**
+	 * Close a file source and set it's instance to null and the file name
+	 * to empty.
+	 *
+	 * @return	void
+	 * @throws	UnsupportedOperationException	If this method is called
+	 */
+	public function closeFile () {
+		throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
+	}
+
+	/**
+	 * Determines whether the EOF has been reached
+	 *
+	 * @return	$isEndOfFileReached		Whether the EOF has been reached
+	 * @throws	UnsupportedOperationException	If this method is called
+	 */
+	public function isEndOfFileReached () {
+		throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
+	}
+
+	/**
+	 * 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);
 	}
 }