* 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_POSITION = 20;
+ /**
+ * Length of name
+ */
+ const LENGTH_NAME = 10;
+
/**
* The real class name
*/
private $pointerInstance = NULL;
/**
- * An instance of an index
+ * An instance of an Indexable class
*/
private $indexInstance = NULL;
+ /**
+ * An instance of a CalculatableBlock class
+ */
+ private $blockInstance = NULL;
+
/**
* Thousands separator
*/
$this->debugBackTrace(sprintf('Tried to set a missing field. name=%s, value[%s]=%s',
$name,
gettype($value),
- $value
+ print_r($value, TRUE)
));
}
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
*
* @return $totalEntries Size of file header
*/
- protected final function getHeaderSize () {
+ public final function getHeaderSize () {
// Get it
return $this->headerSize;
}
$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
*
//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] EXIT!', __METHOD__, __LINE__));
}
- /**
- * Reads the file header
- *
- * @return void
- */
- protected 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->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->getHeaderSize());
- //* 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__));
- }
-
/**
* Checks 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;
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->getIteratorInstance()->size();
+ $fileSize = $this->size();
//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] fileSize=%s', __METHOD__, __LINE__, $fileSize));
/*
*/
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__));
}
/**
- * Flushes the file header
+ * Seeks to beginning of file, updates seek position in this object and
+ * flushes the header.
*
* @return void
*/
- protected function flushFileHeader () {
+ protected function rewineUpdateSeekPosition () {
//* 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),
+ // Seek to beginning of file
+ $this->getIteratorInstance()->rewind();
- // Total entries (will be zero) and pad it to 20 chars
- str_pad($this->dec2hex($this->getCounter()), self::LENGTH_COUNT, '0', STR_PAD_LEFT),
+ // And update seek position ...
+ $this->updateSeekPosition();
- // Separator count<->seek position
- chr(self::SEPARATOR_HEADER_DATA),
+ // ... to write it back into the file
+ $this->flushFileHeader();
- // Position (will be zero)
- str_pad($this->dec2hex($this->getSeekPosition(), 2), self::LENGTH_POSITION, '0', STR_PAD_LEFT),
+ //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] EXIT!!', __METHOD__, __LINE__));
+ }
- // Separator position<->entries
- chr(self::SEPARATOR_HEADER_ENTRIES)
- );
+ /**
+ * Seeks to old position
+ *
+ * @return void
+ */
+ protected function seekToOldPosition () {
+ //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] CALLED!', __METHOD__, __LINE__));
- // Write it to disk (header is always at seek position 0)
- $this->writeData(0, $header);
+ // Seek to currently ("old") saved position
+ $this->getIteratorInstance()->seek($this->getSeekPosition());
- //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] EXIT!', __METHOD__, __LINE__));
+ //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] EXIT!!', __METHOD__, __LINE__));
}
/**
*
* @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) {
+ 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
// Update seek position
$this->updateSeekPosition();
- // Flush header
- $this->flushHeader();
+ // Flush the header?
+ if ($flushHeader === TRUE) {
+ // Flush header
+ $this->flushFileHeader();
+
+ // Seek to old position
+ $this->seekToOldPosition();
+ } // END - if
- // Seek to old position
- $this->seekToOldPosition();
//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] EXIT!', __METHOD__, __LINE__));
}
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
// Message to user
self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] Pre-allocating 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;
+ // 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
// 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]
projects / core.git / blobdiff