X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=inc%2Fclasses%2Fmain%2Fstacker%2Ffile%2Fclass_BaseFileStack.php;h=c14743b32f84900e82a496edc02e97711f8e407d;hp=e3aeb4701fb9c3f192b7fa9cec788448e13cfb61;hb=510fd302ecdfcb218f0c093a8dfc628682a8d20b;hpb=56f54f7f6f84c157db9a8c5b35193304e752f235

diff --git a/inc/classes/main/stacker/file/class_BaseFileStack.php b/inc/classes/main/stacker/file/class_BaseFileStack.php
index e3aeb470..c14743b3 100644
--- a/inc/classes/main/stacker/file/class_BaseFileStack.php
+++ b/inc/classes/main/stacker/file/class_BaseFileStack.php
@@ -47,46 +47,6 @@ class BaseFileStack extends BaseStacker {
 	 */
 	const LENGTH_NAME = 10;
 
-	/**
-	 * Length of count
-	 */
-	const LENGTH_COUNT = 20;
-
-	/**
-	 * Length of position
-	 */
-	const LENGTH_POSITION = 20;
-
-	/**
-	 * Counter for total entries
-	 */
-	private $totalEntries = 0;
-
-	/**
-	 * Current seek position
-	 */
-	private $seekPosition = 0;
-
-	/**
-	 * Size of header
-	 */
-	private $headerSize = 0;
-
-	/**
-	 * File header
-	 */
-	private $header = array();
-
-	/**
-	 * Seek positions for gaps ("fragmentation")
-	 */
-	private $gaps = array();
-
-	/**
-	 * Seek positions for damaged entries (e.g. mismatching hash sum, ...)
-	 */
-	private $damagedEntries = array();
-
 	/**
 	 * Protected constructor
 	 *
@@ -98,7 +58,7 @@ class BaseFileStack extends BaseStacker {
 		parent::__construct($className);
 
 		// Calculate header size
-		$this->headerSize = (
+		$this->setHeaderSize(
 			strlen(self::STACK_MAGIC) +
 			strlen(self::SEPARATOR_HEADER_DATA) +
 			self::LENGTH_COUNT +
@@ -111,94 +71,6 @@ class BaseFileStack extends BaseStacker {
 		$this->initCountersGapsArray();
 	}
 
-	/**
-	 * 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
-	 * analyzeStackFile() instead of this method.
-	 *
-	 * @return	void
-	 */
-	private function initCountersGapsArray () {
-		// Init counter and seek position
-		$this->setCounter(0);
-		$this->setSeekPosition(0);
-
-		// Init arrays
-		$this->gaps = array();
-		$this->damagedEntries = array();
-	}
-
-	/**
-	 * Getter for total entries
-	 *
-	 * @return	$totalEntries	Total entries in this stack
-	 */
-	private final function getCounter () {
-		// Get it
-		return $this->totalEntries;
-	}
-
-	/**
-	 * Setter for total entries
-	 *
-	 * @param	$totalEntries	Total entries in this stack
-	 * @return	void
-	 */
-	private final function setCounter ($counter) {
-		// Set it
-		$this->totalEntries = $counter;
-	}
-
-	/**
-	 * Increment counter
-	 *
-	 * @return	void
-	 */
-	private final function incrementCounter () {
-		// Get it
-		$this->totalEntries++;
-	}
-
-	/**
-	 * Getter for seek position
-	 *
-	 * @return	$seekPosition	Current seek position (stored here in object)
-	 */
-	private final function getSeekPosition () {
-		// Get it
-		return $this->seekPosition;
-	}
-
-	/**
-	 * Setter for seek position
-	 *
-	 * @param	$seekPosition	Current seek position (stored here in object)
-	 * @return	void
-	 */
-	private final function setSeekPosition ($seekPosition) {
-		// And set it
-		$this->seekPosition = $seekPosition;
-	}
-
-	/**
-	 * Updates seekPosition attribute from file to avoid to much access on file.
-	 *
-	 * @return	void
-	 */
-	private function updateSeekPosition () {
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] CALLED!', __METHOD__, __LINE__));
-
-		// Get key (= seek position)
-		$seekPosition = $this->getIteratorInstance()->key();
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] Setting seekPosition=%s', __METHOD__, __LINE__, $seekPosition));
-
-		// And set it here
-		$this->setSeekPosition($seekPosition);
-
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] EXIT!', __METHOD__, __LINE__));
-	}
-
 	/**
 	 * Reads the file header
 	 *
@@ -211,11 +83,11 @@ class BaseFileStack extends BaseStacker {
 		$this->getIteratorInstance()->rewind();
 
 		// Then read it (see constructor for calculation)
-		$data = $this->getIteratorInstance()->read($this->headerSize);
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] Read %d bytes (%d wanted).', __METHOD__, __LINE__, strlen($data), $this->headerSize));
+		$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()));
 
 		// Have all requested bytes been read?
-		assert(strlen($data) == $this->headerSize);
+		assert(strlen($data) == $this->getHeaderSize());
 		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] Passed assert().', __METHOD__, __LINE__));
 
 		// Last character must be the separator
@@ -232,9 +104,9 @@ class BaseFileStack extends BaseStacker {
 		/*
 		 * Now split it:
 		 *
-		 * 0 => Magic
-		 * 1 => Total entries
-		 * 2 => Current seek position
+		 * 0 => magic
+		 * 1 => total entries
+		 * 2 => current seek position
 		 */
 		$this->header = explode(chr(self::SEPARATOR_HEADER_DATA), $data);
 
@@ -260,82 +132,6 @@ class BaseFileStack extends BaseStacker {
 		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] EXIT!', __METHOD__, __LINE__));
 	}
 
-	/**
-	 * Checks whether the file header is initialized
-	 *
-	 * @return	$isInitialized	Whether the file header is initialized
-	 */
-	private function isFileHeaderInitialized () {
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] CALLED!', __METHOD__, __LINE__));
-		// Default is not initialized
-		$isInitialized = FALSE;
-
-		// Is the file initialized?
-		if ($this->isFileInitialized()) {
-			// Some bytes has been written, so rewind to start of it.
-			$rewindStatus = $this->getIteratorInstance()->rewind();
-			//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] rewindStatus=%s', __METHOD__, __LINE__, $rewindStatus));
-
-			// Is the rewind() call successfull?
-			if ($rewindStatus != 1) {
-				// Something bad happened
-				self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] Could not rewind().', __METHOD__, __LINE__));
-			} // END - if
-
-			// Read file header
-			$this->readFileHeader();
-
-			// The above method does already check the header
-			$isInitialized = TRUE;
-		} // END - if
-
-		// Return result
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] isInitialized=%d - EXIT!', __METHOD__, __LINE__, intval($isInitialized)));
-		return $isInitialized;
-	}
-
-	/**
-	 * Checks whether the file-based stack has been initialized
-	 *
-	 * @return	$isInitialized		Whether the file's size is zero
-	 */
-	private function isFileInitialized () {
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] CALLED!', __METHOD__, __LINE__));
-
-		// Get it from iterator which holds the pointer instance. If FALSE is returned
-		$fileSize = $this->getIteratorInstance()->size();
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] fileSize=%s', __METHOD__, __LINE__, $fileSize));
-
-		/*
-		 * The returned file size should not be FALSE or NULL as this means
-		 * that the pointer class does not work correctly.
-		 */
-		assert(is_int($fileSize));
-
-		// Is more than 0 returned?
-		$isInitialized = ($fileSize > 0);
-
-		// Return result
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] isInitialized=%d - EXIT!', __METHOD__, __LINE__, intval($isInitialized)));
-		return $isInitialized;
-	}
-
-	/**
-	 * Creates the file-stack's header
-	 *
-	 * @return	void
-	 */
-	private function createFileHeader () {
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] CALLED!', __METHOD__, __LINE__));
-		// The file's header should not be initialized here
-		assert(!$this->isFileHeaderInitialized());
-
-		// Simple flush file header which will create it.
-		$this->flushFileHeader();
-
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] EXIT!!', __METHOD__, __LINE__));
-	}
-
 	/**
 	 * Flushes the file header
 	 *
@@ -371,62 +167,6 @@ class BaseFileStack extends BaseStacker {
 		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] EXIT!', __METHOD__, __LINE__));
 	}
 
-	/**
-	 * Writes data at given position
-	 *
-	 * @param	$seekPosition	Seek position
-	 * @param	$data			Data to be written
-	 * @return	void
-	 */
-	private function writeData ($seekPosition, $data) {
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] seekPosition=%s,data()=%s - CALLED!', __METHOD__, __LINE__, $seekPosition, strlen($data)));
-
-		// Write data at given position
-		$this->getIteratorInstance()->writeAtPosition($seekPosition, $data);
-
-		// Update seek position
-		$this->updateSeekPosition();
-
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] EXIT!', __METHOD__, __LINE__));
-	}
-
-	/**
-	 * Pre-allocates file (if enabled) with some space for later faster write access.
-	 *
-	 * @return	void
-	 */
-	private function preAllocateFile () {
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] CALLED!', __METHOD__, __LINE__));
-
-		// Is it enabled?
-		if ($this->getConfigInstance()->getConfigEntry('file_stack_pre_allocate_enabled') != 'Y') {
-			// Not enabled
-			self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] Not pre-allocating stack file.', __METHOD__, __LINE__));
-
-			// Don't continue here.
-			return;
-		} // END - if
-
-		// Message to user
-		self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] Pre-allocating stack file ...', __METHOD__, __LINE__));
-
-		/*
-		 * Calculate minimum length for one entry:
-		 * minimum length = hash length + separator + name + minimum entry size = ?? + 1 + 10 + 1 = ??
-		 */
-		$minLengthEntry = self::getHashLength() + strlen(self::SEPARATOR_HASH_NAME) + self::LENGTH_NAME + 1;
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] minLengthEntry=%s', __METHOD__, __LINE__, $minLengthEntry));
-
-		// Calulcate seek position
-		$seekPosition = $minLengthEntry * $this->getConfigInstance()->getConfigEntry('file_stack_pre_allocate_count');
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] seekPosition=%s', __METHOD__, __LINE__, $seekPosition));
-
-		// Now simply write a NUL there. This will pre-allocate the file.
-		$this->writeData($seekPosition, chr(0));
-
-		//* 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
@@ -434,7 +174,7 @@ class BaseFileStack extends BaseStacker {
 	 *
 	 * @return	void
 	 */
-	private function analyzeStackFile () {
+	private function analyzeFile () {
 		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] CALLED!', __METHOD__, __LINE__));
 
 		// Make sure the file is initialized
@@ -475,14 +215,14 @@ class BaseFileStack extends BaseStacker {
 			$this->createFileHeader();
 
 			// And pre-allocate a bit
-			$this->preAllocateFile();
+			$this->preAllocateFile('file_stack');
 		} // END - if
 
 		// Load the file header
 		$this->readFileHeader();
 
 		// Count all entries in file
-		$this->analyzeStackFile();
+		$this->analyzeFile();
 
 		/*
 		 * Get stack index instance. This can be used for faster