X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;ds=sidebyside;f=inc%2Fclasses%2Fmain%2Fclass_BaseFrameworkSystem.php;h=214f2a9f68be77cbdb664148c6109567daa9f68e;hb=f40bcdcb63cb7aa74f5d75c50a5316810944b8eb;hp=abb48a9327f5a8cc2faebbfb368e93ccceed2c6c;hpb=564914ca84745209c1628027e923666dac9c8b2d;p=core.git

diff --git a/inc/classes/main/class_BaseFrameworkSystem.php b/inc/classes/main/class_BaseFrameworkSystem.php
index abb48a93..214f2a9f 100644
--- a/inc/classes/main/class_BaseFrameworkSystem.php
+++ b/inc/classes/main/class_BaseFrameworkSystem.php
@@ -23,6 +23,41 @@
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
 class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
+	/**
+	 * Separator for header data
+	 */
+	const SEPARATOR_HEADER_DATA = 0x01;
+
+	/**
+	 * Separator header->entries
+	 */
+	const SEPARATOR_HEADER_ENTRIES = 0x02;
+
+	/**
+	 * Separator hash->name
+	 */
+	const SEPARATOR_HASH_NAME = 0x03;
+
+	/**
+	 * Separator entry->entry
+	 */
+	const SEPARATOR_ENTRIES = 0x04;
+
+	/**
+	 * Length of count
+	 */
+	const LENGTH_COUNT = 20;
+
+	/**
+	 * Length of position
+	 */
+	const LENGTH_POSITION = 20;
+
+	/**
+	 * Length of name
+	 */
+	const LENGTH_NAME = 10;
+
 	/**
 	 * The real class name
 	 */
@@ -144,12 +179,12 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
 	private $sourceInstance = NULL;
 
 	/**
-	 * An instance of a InputStreamable class
+	 * An instance of a InputStream class
 	 */
 	private $inputStreamInstance = NULL;
 
 	/**
-	 * An instance of a OutputStreamable class
+	 * An instance of a OutputStream class
 	 */
 	private $outputStreamInstance = NULL;
 
@@ -173,6 +208,21 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
 	 */
 	private $wrapperInstance = NULL;
 
+	/**
+	 * An instance of a file I/O pointer class (not handler)
+	 */
+	private $pointerInstance = NULL;
+
+	/**
+	 * An instance of an Indexable class
+	 */
+	private $indexInstance = NULL;
+
+	/**
+	 * An instance of a CalculatableBlock class
+	 */
+	private $blockInstance = NULL;
+
 	/**
 	 * Thousands separator
 	 */
@@ -198,6 +248,41 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
 	 */
 	private $genericArray = array();
 
+	/**
+	 * Length of output from hash()
+	 */
+	private static $hashLength = NULL;
+
+	/**
+	 * 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();
+
 	/***********************
 	 * Exception codes.... *
 	 ***********************/
@@ -249,6 +334,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
 	const EXCEPTION_ARRAY_ELEMENTS_MISSING       = 0x02c;
 	const EXCEPTION_TEMPLATE_ENGINE_UNSUPPORTED  = 0x02d;
 	const EXCEPTION_UNSPPORTED_OPERATION         = 0x02e;
+	const EXCEPTION_FACTORY_REQUIRE_PARAMETER    = 0x02f;
 	const EXCEPTION_MISSING_ELEMENT              = 0x030;
 	const EXCEPTION_HEADERS_ALREADY_SENT         = 0x031;
 	const EXCEPTION_DEFAULT_CONTROLLER_GONE      = 0x032;
@@ -259,7 +345,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
 	const EXCEPTION_ASSERTION_FAILED             = 0x037;
 	const EXCEPTION_FILE_CANNOT_BE_READ          = 0x038;
 	const EXCEPTION_DATABASE_UPDATED_NOT_ALLOWED = 0x039;
-	const EXCEPTION_FILTER_CHAIN_INTERCEPTED     = 0x040;
+	const EXCEPTION_FILTER_CHAIN_INTERCEPTED     = 0x03a;
 
 	/**
 	 * Hexadecimal->Decimal translation array
@@ -456,7 +542,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
 		$this->debugBackTrace(sprintf('Tried to set a missing field. name=%s, value[%s]=%s',
 			$name,
 			gettype($value),
-			$value
+			print_r($value, TRUE)
 		));
 	}
 
@@ -1084,40 +1170,40 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
 	}
 
 	/**
-	 * Getter for a InputStreamable instance
+	 * Getter for a InputStream instance
 	 *
-	 * @param	$inputStreamInstance	The InputStreamable instance
+	 * @param	$inputStreamInstance	The InputStream instance
 	 */
 	protected final function getInputStreamInstance () {
 		return $this->inputStreamInstance;
 	}
 
 	/**
-	 * Setter for a InputStreamable instance
+	 * Setter for a InputStream instance
 	 *
-	 * @param	$inputStreamInstance	The InputStreamable instance
+	 * @param	$inputStreamInstance	The InputStream instance
 	 * @return	void
 	 */
-	protected final function setInputStreamInstance (InputStreamable $inputStreamInstance) {
+	protected final function setInputStreamInstance (InputStream $inputStreamInstance) {
 		$this->inputStreamInstance = $inputStreamInstance;
 	}
 
 	/**
-	 * Getter for a OutputStreamable instance
+	 * Getter for a OutputStream instance
 	 *
-	 * @param	$outputStreamInstance	The OutputStreamable instance
+	 * @param	$outputStreamInstance	The OutputStream instance
 	 */
 	protected final function getOutputStreamInstance () {
 		return $this->outputStreamInstance;
 	}
 
 	/**
-	 * Setter for a OutputStreamable instance
+	 * Setter for a OutputStream instance
 	 *
-	 * @param	$outputStreamInstance	The OutputStreamable instance
+	 * @param	$outputStreamInstance	The OutputStream instance
 	 * @return	void
 	 */
-	protected final function setOutputStreamInstance (OutputStreamable $outputStreamInstance) {
+	protected final function setOutputStreamInstance (OutputStream $outputStreamInstance) {
 		$this->outputStreamInstance = $outputStreamInstance;
 	}
 
@@ -1217,6 +1303,63 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
 		return $this->iteratorInstance;
 	}
 
+	/**
+	 * Setter for InputOutputPointer instance
+	 *
+	 * @param	$pointerInstance	An instance of an InputOutputPointer class
+	 * @return	void
+	 */
+	protected final function setPointerInstance (InputOutputPointer $pointerInstance) {
+		$this->pointerInstance = $pointerInstance;
+	}
+
+	/**
+	 * Getter for InputOutputPointer instance
+	 *
+	 * @return	$pointerInstance	An instance of an InputOutputPointer class
+	 */
+	public final function getPointerInstance () {
+		return $this->pointerInstance;
+	}
+
+	/**
+	 * Setter for Indexable instance
+	 *
+	 * @param	$indexInstance	An instance of an Indexable class
+	 * @return	void
+	 */
+	protected final function setIndexInstance (Indexable $indexInstance) {
+		$this->indexInstance = $indexInstance;
+	}
+
+	/**
+	 * Getter for Indexable instance
+	 *
+	 * @return	$indexInstance	An instance of an Indexable class
+	 */
+	public final function getIndexInstance () {
+		return $this->indexInstance;
+	}
+
+	/**
+	 * Setter for CalculatableBlock instance
+	 *
+	 * @param	$blockInstance	An instance of an CalculatableBlock class
+	 * @return	void
+	 */
+	protected final function setBlockInstance (CalculatableBlock $blockInstance) {
+		$this->blockInstance = $blockInstance;
+	}
+
+	/**
+	 * Getter for CalculatableBlock instance
+	 *
+	 * @return	$blockInstance	An instance of an CalculatableBlock class
+	 */
+	public final function getBlockInstance () {
+		return $this->blockInstance;
+	}
+
 	/**
 	 * Checks whether an object equals this object. You should overwrite this
 	 * method to implement own equality checks
@@ -2065,19 +2208,37 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
 	}
 
 	/**
-	 * Hashes a given string with a simple but stronger hash function (no salts)
+	 * Hashes a given string with a simple but stronger hash function (no salt)
+	 * and hex-encode it.
 	 *
 	 * @param	$str	The string to be hashed
 	 * @return	$hash	The hash from string $str
 	 */
-	public function hashString ($str) {
+	public static final function hash ($str) {
 		// Hash given string with (better secure) hasher
-		$hash = mhash(MHASH_SHA256, $str);
+		$hash = bin2hex(mhash(MHASH_SHA256, $str));
 
 		// Return it
 		return $hash;
 	}
 
+	/**
+	 * "Getter" for length of hash() output. This will be "cached" to speed up
+	 * things.
+	 *
+	 * @return	$length		Length of hash() output
+	 */
+	public static final function getHashLength () {
+		// Is it cashed?
+		if (is_null(self::$hashLength)) {
+			// No, then hash a string and save its length.
+			self::$hashLength = strlen(self::hash('abc123'));
+		} // END - if
+
+		// Return it
+		return self::$hashLength;
+	}
+
 	/**
 	 * Checks whether the given number is really a number (only chars 0-9).
 	 *
@@ -2713,6 +2874,371 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
 		// Return it
 		return $isValid;
 	}
+
+	/**
+	 * Translates boolean TRUE to 'Y' and FALSE to 'N'
+	 *
+	 * @param	$boolean		Boolean value
+	 * @return	$translated		Translated boolean value
+	 */
+	public static final function translateBooleanToYesNo ($boolean) {
+		// Make sure it is really boolean
+		assert(is_bool($boolean));
+
+		// "Translate" it
+		$translated = ($boolean === TRUE) ? 'Y' : 'N';
+
+		// ... and return it
+		return $translated;
+	}
+
+	/**
+	 * 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
+	 */
+	protected 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 file
+	 */
+	protected final function getCounter () {
+		// Get it
+		return $this->totalEntries;
+	}
+
+	/**
+	 * Setter for total entries
+	 *
+	 * @param	$totalEntries	Total entries in this file
+	 * @return	void
+	 */
+	protected final function setCounter ($counter) {
+		// Set it
+		$this->totalEntries = $counter;
+	}
+
+	/**
+	 * Increment counter
+	 *
+	 * @return	void
+	 */
+	protected final function incrementCounter () {
+		// Get it
+		$this->totalEntries++;
+	}
+
+	/**
+	 * Getter for header size
+	 *
+	 * @return	$totalEntries	Size of file header
+	 */
+	public final function getHeaderSize () {
+		// Get it
+		return $this->headerSize;
+	}
+
+	/**
+	 * Setter for header size
+	 *
+	 * @param	$headerSize		Size of file header
+	 * @return	void
+	 */
+	protected final function setHeaderSize ($headerSize) {
+		// Set it
+		$this->headerSize = $headerSize;
+	}
+
+	/**
+	 * Getter for header array
+	 *
+	 * @return	$totalEntries	Size of file header
+	 */
+	protected final function getHeade () {
+		// Get it
+		return $this->header;
+	}
+
+	/**
+	 * Setter for header
+	 *
+	 * @param	$header		Array for a file header
+	 * @return	void
+	 */
+	protected final function setHeader (array $header) {
+		// Set it
+		$this->header = $header;
+	}
+
+	/**
+	 * Getter for seek position
+	 *
+	 * @return	$seekPosition	Current seek position (stored here in object)
+	 */
+	protected final function getSeekPosition () {
+		// Get it
+		return $this->seekPosition;
+	}
+
+	/**
+	 * Setter for seek position
+	 *
+	 * @param	$seekPosition	Current seek position (stored here in object)
+	 * @return	void
+	 */
+	protected final function setSeekPosition ($seekPosition) {
+		// And set it
+		$this->seekPosition = $seekPosition;
+	}
+
+	/**
+	 * Updates seekPosition attribute from file to avoid to much access on file.
+	 *
+	 * @return	void
+	 */
+	protected 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__));
+	}
+
+	/**
+	 * Checks whether the file header is initialized
+	 *
+	 * @return	$isInitialized	Whether the file header is initialized
+	 */
+	protected function isFileHeaderInitialized () {
+		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] CALLED!', __METHOD__, __LINE__));
+
+		// Is the method there?
+		assert(is_callable(array($this, 'readFileHeader')));
+
+		// 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 assigned file has been initialized
+	 *
+	 * @return	$isInitialized		Whether the file's size is zero
+	 */
+	protected function isFileInitialized () {
+		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] CALLED!', __METHOD__, __LINE__));
+
+		// size() must be callable
+		assert(is_callable(array($this, 'size')));
+
+		// Get it from iterator which holds the pointer instance. If FALSE is returned
+		$fileSize = $this->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 assigned file
+	 *
+	 * @return	void
+	 */
+	protected function createFileHeader () {
+		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] CALLED!', __METHOD__, __LINE__));
+
+		// The method flushFileHeader() must be callable
+		assert(is_callable(array($this, 'flushFileHeader')));
+
+		// The file's header should not be initialized here
+		assert(!$this->isFileHeaderInitialized());
+
+		// Simple flush file header which will create it.
+		$this->flushFileHeader();
+
+		// Rewind seek position (to beginning of file) and update/flush file header
+		$this->rewineUpdateSeekPosition();
+
+		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] EXIT!!', __METHOD__, __LINE__));
+	}
+
+	/**
+	 * Seeks to beginning of file, updates seek position in this object and
+	 * flushes the header.
+	 *
+	 * @return	void
+	 */
+	protected function rewineUpdateSeekPosition () {
+		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] CALLED!', __METHOD__, __LINE__));
+
+		// Seek to beginning of file
+		$this->getIteratorInstance()->rewind();
+
+		// And update seek position ...
+		$this->updateSeekPosition();
+
+		// ... to write it back into the file
+		$this->flushFileHeader();
+
+		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] EXIT!!', __METHOD__, __LINE__));
+	}
+
+	/**
+	 * Seeks to old position
+	 *
+	 * @return	void
+	 */
+	protected function seekToOldPosition () {
+		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] CALLED!', __METHOD__, __LINE__));
+
+		// Seek to currently ("old") saved position
+		$this->getIteratorInstance()->seek($this->getSeekPosition());
+
+		//* 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
+	 * @param	$flushHeader	Whether to flush the header (default: flush)
+	 * @return	void
+	 */
+	protected function writeData ($seekPosition, $data, $flushHeader = TRUE) {
+		//* 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();
+
+		// Flush the header?
+		if ($flushHeader === TRUE) {
+			// Flush header
+			$this->flushFileHeader();
+
+			// Seek to old position
+			$this->seekToOldPosition();
+		} // END - if
+
+		//* 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.
+	 *
+	 * @param	$type	Type of the file
+	 * @return	void
+	 */
+	protected function preAllocateFile ($type) {
+		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] CALLED!', __METHOD__, __LINE__));
+
+		// caluclateMinimumBlockLength() must be callable
+		assert(is_callable(array($this, 'caluclateMinimumBlockLength')));
+
+		// Is it enabled?
+		if ($this->getConfigInstance()->getConfigEntry($type . '_pre_allocate_enabled') != 'Y') {
+			// Not enabled
+			self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] Not pre-allocating file.', __METHOD__, __LINE__));
+
+			// Don't continue here.
+			return;
+		} // END - if
+
+		// Message to user
+		self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] Pre-allocating file ...', __METHOD__, __LINE__));
+
+		// Calculate minimum length for one entry
+		$minLengthEntry = $this->caluclateMinimumBlockLength();
+		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] minLengthEntry=%s', __METHOD__, __LINE__, $minLengthEntry));
+
+		// Calulcate seek position
+		$seekPosition = $minLengthEntry * $this->getConfigInstance()->getConfigEntry($type . '_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));
+
+		// Rewind seek position (to beginning of file) and update/flush file header
+		$this->rewineUpdateSeekPosition();
+
+		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] EXIT!', __METHOD__, __LINE__));
+	}
+
+	/**
+	 * Checks whether the block separator has been found
+	 *
+	 * @param	$str		String to look in
+	 * @return	$isFound	Whether the block separator has been found
+	 */
+	public function isBlockSeparatorFound ($str) {
+		// Determine it
+		$isFound = (strpos($str, self::getBlockSeparator()) !== FALSE);
+
+		// Return result
+		return $isFound;
+	}
+
+	/**
+	 * Getter for block separator character(s)
+	 *
+	 * @return	$blockSeparator		A separator for blocks
+	 */
+	protected static final function getBlockSeparator () {
+		return chr(self::SEPARATOR_ENTRIES);
+	}
 }
 
 // [EOF]