X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=inc%2Fclasses%2Fmain%2Fstacker%2Ffile%2Fclass_BaseFileStack.php;fp=inc%2Fclasses%2Fmain%2Fstacker%2Ffile%2Fclass_BaseFileStack.php;h=14972d7316d8580fefe7f1329f94d03686d65bf9;hp=81648d58009de0aa1c109a85a9b75afcbccd7612;hb=bde1a7331a8a5c1e4a304583c0db268026aeb8a8;hpb=ce7d4f1ec37db463e6008655bbc56b811c5a5d86

diff --git a/inc/classes/main/stacker/file/class_BaseFileStack.php b/inc/classes/main/stacker/file/class_BaseFileStack.php
index 81648d58..14972d73 100644
--- a/inc/classes/main/stacker/file/class_BaseFileStack.php
+++ b/inc/classes/main/stacker/file/class_BaseFileStack.php
@@ -27,6 +27,21 @@ class BaseFileStack extends BaseStacker {
 	 */
 	const STACK_MAGIC = 'STACKv0.1';
 
+	/**
+	 * Name of array index for gap position
+	 */
+	const ARRAY_INDEX_GAP_POSITION = 'gap';
+
+	/**
+	 * Name of array index for hash
+	 */
+	const ARRAY_INDEX_HASH = 'hash';
+
+	/**
+	 * Name of array index for length of raw data
+	 */
+	const ARRAY_INDEX_DATA_LENGTH = 'length';
+
 	/**
 	 * Protected constructor
 	 *
@@ -212,8 +227,18 @@ class BaseFileStack extends BaseStacker {
 			throw new FullStackerException(array($this, $stackerName, $value), self::EXCEPTION_STACKER_IS_FULL);
 		} // END - if
 
-		// Now add the value to the stack
-		$this->partialStub('stackerName=' . $stackerName . ',value[]=' . gettype($value));
+		// Debug message
+		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . '] stackerName=' . $stackerName . ',value[' . gettype($value) . ']=' . print_r($value, TRUE));
+
+		// No objects/resources are allowed as their serialization takes to long
+		assert(!is_object($value));
+		assert(!is_resource($value));
+
+		// Now add the value to the file stack (which returns a hash)
+		$data = $this->getIteratorInstance()->writeValueToFile($stackerName, $value);
+
+		// Add the hash and gap position to the index
+		$this->getIndexInstance()->addHashToIndex($stackerName, $data);
 	}
 
 	/**
@@ -231,7 +256,7 @@ class BaseFileStack extends BaseStacker {
 		} // END - if
 
 		// Now get the last value
-		$this->partialStub('stackerName=' . $stackerName);
+		/* NOISY-DEBUG: */ $this->partialStub('[' . __METHOD__ . ':' . __LINE__ . '] stackerName=' . $stackerName);
 		$value = NULL;
 
 		// Return it
@@ -253,7 +278,7 @@ class BaseFileStack extends BaseStacker {
 		} // END - if
 
 		// Now get the first value
-		$this->partialStub('stackerName=' . $stackerName);
+		/* NOISY-DEBUG: */ $this->partialStub('[' . __METHOD__ . ':' . __LINE__ . '] stackerName=' . $stackerName);
 		$value = NULL;
 
 		// Return it
@@ -275,7 +300,7 @@ class BaseFileStack extends BaseStacker {
 		} // END - if
 
 		// Now, remove the last entry, we don't care about the return value here, see elseif() block above
-		$this->partialStub('stackerName=' . $stackerName);
+		/* NOISY-DEBUG: */ $this->partialStub('[' . __METHOD__ . ':' . __LINE__ . '] stackerName=' . $stackerName);
 		return NULL;
 	}
 
@@ -294,7 +319,7 @@ class BaseFileStack extends BaseStacker {
 		} // END - if
 
 		// Now, remove the last entry, we don't care about the return value here, see elseif() block above
-		$this->partialStub('stackerName=' . $stackerName);
+		/* NOISY-DEBUG: */ $this->partialStub('[' . __METHOD__ . ':' . __LINE__ . '] stackerName=' . $stackerName);
 		return NULL;
 	}
 
@@ -399,7 +424,13 @@ class BaseFileStack extends BaseStacker {
 	 */
 	public function calculateMinimumBlockLength () {
 		// Calulcate it
-		$length = self::getHashLength() + strlen(chr(BaseBinaryFile::SEPARATOR_HASH_NAME)) + BaseBinaryFile::LENGTH_NAME + 1 + strlen(chr(BaseBinaryFile::SEPARATOR_ENTRIES));
+		$length =
+			// Length of entry group
+			BaseBinaryFile::LENGTH_GROUP + strlen(chr(BaseBinaryFile::SEPARATOR_GROUP_HASH)) +
+			// Hash + value
+			self::getHashLength() + strlen(chr(BaseBinaryFile::SEPARATOR_HASH_VALUE)) + 1 +
+			// Final separator
+			strlen(chr(BaseBinaryFile::SEPARATOR_ENTRIES));
 
 		// Return it
 		return $length;
@@ -480,6 +511,46 @@ class BaseFileStack extends BaseStacker {
 		throw new UnsupportedOperationException(array($this, __FUNCTION__, $this->getIteratorInstance()->getPointerInstance()), self::EXCEPTION_UNSPPORTED_OPERATION);
 	}
 
+	/**
+	 * 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
+	 * @throws	UnsupportedOperationException	This method is not (and maybe never will be) supported
+	 */
+	public function writeData ($seekPosition, $data, $flushHeader = TRUE) {
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] seekPosition=%s,data[]=%s,flushHeader=%d', __METHOD__, __LINE__, $seekPosition, gettype($data), intval($flushHeader)));
+		throw new UnsupportedOperationException(array($this, __FUNCTION__, $this->getIteratorInstance()->getPointerInstance()), self::EXCEPTION_UNSPPORTED_OPERATION);
+	}
+
+	/**
+	 * Writes given value to the file and returns a hash and gap position for it
+	 *
+	 * @param	$groupId	Group identifier
+	 * @param	$value		Value to be added to the stack
+	 * @return	$data		Hash and gap position
+	 * @throws	UnsupportedOperationException	This method is not (and maybe never will be) supported
+	 */
+	public function writeValueToFile ($groupId, $value) {
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] groupId=%s,value[%s]=%s', __METHOD__, __LINE__, $groupId, gettype($value), print_r($value, TRUE)));
+		throw new UnsupportedOperationException(array($this, __FUNCTION__, $this->getIteratorInstance()->getPointerInstance()), self::EXCEPTION_UNSPPORTED_OPERATION);
+	}
+
+	/**
+	 * Searches for next suitable gap the given length of data can fit in
+	 * including padding bytes.
+	 *
+	 * @param	$length			Length of raw data
+	 * @return	$seekPosition	Found next gap's seek position
+	 * @throws	UnsupportedOperationException	This method is not (and maybe never will be) supported
+	 */
+	public function searchNextGap ($length) {
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] length=%s', __METHOD__, __LINE__, $length));
+		throw new UnsupportedOperationException(array($this, __FUNCTION__, $this->getIteratorInstance()->getPointerInstance()), self::EXCEPTION_UNSPPORTED_OPERATION);
+	}
+
 	/**
 	 * "Getter" for file size
 	 *
@@ -489,6 +560,53 @@ class BaseFileStack extends BaseStacker {
 		// Call iterator's method
 		return $this->getIteratorInstance()->getFileSize();
 	}
+
+	/**
+	 * Writes given raw data to the file and returns a gap position and length
+	 *
+	 * @param	$groupId	Group identifier
+	 * @param	$hash		Hash from encoded value
+	 * @param	$encoded	Encoded value to be written to the file
+	 * @return	$data		Gap position and length of the raw data
+	 */
+	public function writeDataToFreeGap ($groupId, $hash, $encoded) {
+		// Debug message
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] groupId=%s,hash=%s,encoded()=%s - CALLED!', __METHOD__, __LINE__, $groupId, $hash, strlen($encoded)));
+
+		// Raw data been written to the file
+		$rawData = sprintf('%s%s%s%s%s',
+			$groupId,
+			BaseBinaryFile::SEPARATOR_GROUP_HASH,
+			hex2bin($hash),
+			BaseBinaryFile::SEPARATOR_HASH_VALUE,
+			$encoded
+		);
+
+		// Debug message
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] groupId=%s,hash=%s,rawData()=%s', __METHOD__, __LINE__, $groupId, $hash, strlen($rawData)));
+
+		// Search for next free gap
+		$gapPosition = $this->getIteratorInstance()->searchNextGap(strlen($rawData));
+
+		// Gap position cannot be smaller than header length + 1
+		assert($gapPosition > $this->getIteratorInstance()->getHeaderSize());
+
+		// Debug message
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] groupId=%s,hash=%s,gapPosition=%s', __METHOD__, __LINE__, $groupId, $hash, $gapPosition));
+
+		// Then write the data at that gap
+		$this->getIteratorInstance()->writeData($gapPosition, $rawData);
+
+		// Debug message
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] groupId=%s,hash=%s,rawData()=%s - EXIT!', __METHOD__, __LINE__, $groupId, $hash, strlen($rawData)));
+
+		// Return gap position, hash and length of raw data
+		return array(
+			self::ARRAY_INDEX_GAP_POSITION => $gapPosition,
+			self::ARRAY_INDEX_HASH         => $hash,
+			self::ARRAY_INDEX_DATA_LENGTH  => strlen($rawData)
+		);
+	}
 }
 
 // [EOF]