X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;ds=sidebyside;f=inc%2Fclasses%2Fmain%2Fstacker%2Ffile%2Fclass_BaseFileStack.php;h=b4a9133006462eb2d47afacc3f2712359ce17a04;hb=420b3c92cc606eb241955ac5c1b350f101b174cb;hp=f0539e10fc0f0130a222cae198b9ca370f48f295;hpb=65a9356fe91fab0489325b7f3a5662b8bbf0b110;p=core.git

diff --git a/inc/classes/main/stacker/file/class_BaseFileStack.php b/inc/classes/main/stacker/file/class_BaseFileStack.php
index f0539e10..b4a91330 100644
--- a/inc/classes/main/stacker/file/class_BaseFileStack.php
+++ b/inc/classes/main/stacker/file/class_BaseFileStack.php
@@ -28,19 +28,54 @@ class BaseFileStack extends BaseStacker {
 	const STACK_MAGIC = 'STACKv0.1';
 
 	/**
-	 * Separator magic->count
+	 * Separator for header data
 	 */
-	const SEPARATOR_MAGIC_COUNT = 0x00;
+	const SEPARATOR_HEADER_DATA = 0x01;
 
 	/**
-	 * Separator position->entries
+	 * Separator header->entries
 	 */
-	const SEPARATOR_SEEK_POS_ENTRIES = 0xff;
+	const SEPARATOR_HEADER_ENTRIES = 0x02;
 
 	/**
 	 * Separator hash->name
 	 */
-	const SEPARATOR_HASH_NAME = 0x05;
+	const SEPARATOR_HASH_NAME = 0x03;
+
+	/**
+	 * Length of name
+	 */
+	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();
 
 	/**
 	 * Protected constructor
@@ -51,6 +86,136 @@ class BaseFileStack extends BaseStacker {
 	protected function __construct ($className) {
 		// Call parent constructor
 		parent::__construct($className);
+
+		// Calculate header size
+		$this->headerSize = (
+			strlen(self::STACK_MAGIC) +
+			strlen(self::SEPARATOR_HEADER_DATA) +
+			self::LENGTH_COUNT +
+			strlen(self::SEPARATOR_HEADER_DATA) +
+			self::LENGTH_POSITION +
+			strlen(self::SEPARATOR_HEADER_ENTRIES)
+		);
+	}
+
+	/**
+	 * Getter for total entries
+	 *
+	 * @return	$totalEntries	Total entries in this stack
+	 */
+	private function getCounter () {
+		// Get it
+		return $this->totalEntries;
+	}
+
+	/**
+	 * Increment counter
+	 *
+	 * @return	void
+	 */
+	private function incrementCounter () {
+		// Get it
+		$this->totalEntries++;
+	}
+
+	/**
+	 * Getter for seek position
+	 *
+	 * @return	$seekPosition	Current seek position (stored here in object)
+	 */
+	private function getSeekPosition () {
+		// Get it
+		return $this->seekPosition;
+	}
+
+	/**
+	 * Setter for seek position
+	 *
+	 * @param	$seekPosition	Current seek position (stored here in object)
+	 * @return	void
+	 */
+	private 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
+	 *
+	 * @return	void
+	 */
+	private 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->headerSize);
+		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] Read %d bytes (%d wanted).', __METHOD__, __LINE__, strlen($data), $this->headerSize));
+
+		// Have all requested bytes been read?
+		assert(strlen($data) == $this->headerSize);
+		//* 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));
+		//* 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();
+
+		/*
+		 * Now split it:
+		 *
+		 * 0 => Magic
+		 * 1 => Total entries
+		 * 2 => Current seek position
+		 */
+		$this->header = explode(chr(self::SEPARATOR_HEADER_DATA), $data);
+
+		// Check if the array has only 3 elements
+		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] header(%d)=%s', __METHOD__, __LINE__, count($this->header), print_r($this->header, TRUE)));
+		assert(count($this->header) == 3);
+		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] Passed assert().', __METHOD__, __LINE__));
+
+		// Check magic
+		assert($this->header[0] == self::STACK_MAGIC);
+		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] Passed assert().', __METHOD__, __LINE__));
+
+		// Check length of count and seek position
+		assert(strlen($this->header[1]) == self::LENGTH_COUNT);
+		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] Passed assert().', __METHOD__, __LINE__));
+		assert(strlen($this->header[2]) == self::LENGTH_POSITION);
+		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] Passed assert().', __METHOD__, __LINE__));
+
+		// Decode count and seek position
+		$this->header[1] = hex2bin($this->header[1]);
+		$this->header[2] = hex2bin($this->header[2]);
+
+		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] EXIT!', __METHOD__, __LINE__));
 	}
 
 	/**
@@ -59,19 +224,31 @@ class BaseFileStack extends BaseStacker {
 	 * @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.
-			$this->getIteratorInstance()->rewind();
+			$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;
 	}
 
@@ -81,11 +258,11 @@ class BaseFileStack extends BaseStacker {
 	 * @return	$isInitialized		Whether the file's size is zero
 	 */
 	private function isFileInitialized () {
-		// Default is not initialized
-		$isInitialized = FALSE;
+		//* 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
@@ -94,15 +271,120 @@ class BaseFileStack extends BaseStacker {
 		assert(is_int($fileSize));
 
 		// Is more than 0 returned?
-		if ($fileSize > 0) {
-			// So is the header written?
-			$isInitialized = $this->getIteratorInstance()->isHeaderInitialized();
-		} // END - if
+		$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
+	 *
+	 * @return	void
+	 */
+	private function flushFileHeader () {
+		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] CALLED!', __METHOD__, __LINE__));
+
+		// Put all informations together
+		$header = sprintf('%s%s%s%s%s%s',
+			// Magic
+			self::STACK_MAGIC,
+
+			// Separator magic<->count
+			chr(self::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),
+
+			// Separator count<->seek position
+			chr(self::SEPARATOR_HEADER_DATA),
+
+			// Position (will be zero)
+			str_pad($this->dec2hex($this->getSeekPosition(), 2), self::LENGTH_POSITION, '0', STR_PAD_LEFT),
+
+			// Separator position<->entries
+			chr(self::SEPARATOR_HEADER_ENTRIES)
+		);
+
+		// Write it to disk (header is always at seek position 0)
+		$this->writeData(0, $header);
+
+		//* 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__));
+	}
+
 	/**
 	 * Initializes this file-based stack.
 	 *
@@ -125,10 +407,13 @@ class BaseFileStack extends BaseStacker {
 		// Is the file's header initialized?
 		if ($this->isFileHeaderInitialized()) {
 			// Then load it
-			$this->loadFileHeader();
+			$this->readFileHeader();
 		} else {
 			// No, then create it (which may pre-allocate the stack)
 			$this->createFileHeader();
+
+			// And pre-allocate a bit
+			$this->preAllocateFile();
 		}
 	}