/**
* Database backend class for storing objects in locally created files.
*
- * This class serializes objects and saves them to local files.
+ * This class serializes arrays stored in the dataset instance and saves them
+ * to local files. Every file (except 'info') represents a single line. Every
+ * directory within the 'db' (base) directory represents a table.
+ *
+ * A configurable 'file_io_class' is being used as "storage backend".
*
* @author Roland Haeder <webmaster@ship-simu.org>
* @version 0.0.0
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-class LocalFileDatabase extends BaseDatabaseFrontend implements DatabaseFrontendInterface {
- // Constants for MySQL backward-compatiblity (PLEASE FIX THEM!)
- const DB_CODE_TABLE_MISSING = 0x100;
- const DB_CODE_TABLE_UNWRITEABLE = 0x101;
- const DB_CODE_DATA_FILE_CORRUPT = 0x102;
-
- // Status results
- const RESULT_OKAY = 'ok';
-
+class LocalFileDatabase extends BaseDatabaseBackend implements DatabaseBackendInterface {
/**
* The file's extension
*/
*/
private $alreadyConnected = false;
- /**
- * Last exception
- */
- private $lastException = NULL;
-
/**
* Table information array
*/
// Set the compressor channel
$databaseInstance->setCompressorChannel($compressorInstance);
+ // Get a file IO handler
+ $fileIoInstance = ObjectFactory::createObjectByConfiguredName('file_io_class');
+
+ // ... and set it
+ $databaseInstance->setFileIoInstance($fileIoInstance);
+
// "Connect" to the database
$databaseInstance->connectToDatabase();
return $databaseInstance;
}
- /**
- * Getter for last exception
- *
- * @return $lastException Last thrown exception
- */
- public final function getLastException () {
- return $this->lastException;
- }
-
/**
* Setter for the last read file
*
$this->lastFile = (string) $fqfn;
}
- /**
- * Reset the last exception instance. This should be done after a "query"
- * was completed without any errors.
- *
- * @return void
- */
- private final function resetLastException () {
- $this->lastException = NULL;
- }
-
/**
* Getter for last read file
*
- * @return $lastFile The last read file's name with full path
+ * @return $lastFile The last read file's name with full path
*/
public final function getLastFile () {
return $this->lastFile;
/**
* Setter for contents of the last read file
*
- * @param $contents An array with header and data elements
+ * @param $contents An array with header and data elements
* @return void
*/
private final function setLastFileContents (array $contents) {
* @return $dataArray
*/
private function getDataArrayFromFile ($fqfn) {
- // Get a file pointer
- $fileInstance = FrameworkFileInputPointer::createFrameworkFileInputPointer($fqfn);
+ // Debug message
+ //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: Reading elements from database file ' . $fqfn . ' ...');
- // Get the raw data and BASE64-decode it
- $compressedData = base64_decode($fileInstance->readLinesFromFile());
+ // Init compressed data
+ $compressedData = $this->getFileIoInstance()->loadFileContents($fqfn);
+ $compressedData = $compressedData['data'];
// Close the file and throw the instance away
- $fileInstance->closeFile();
unset($fileInstance);
// Decompress it
// Unserialize it
$dataArray = unserialize($serializedData);
+ // Debug message
+ //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: Read ' . count($dataArray) . ' elements from database file ' . $fqfn . '.');
+
// Finally return it
return $dataArray;
}
* @return void
*/
private function writeDataArrayToFqfn ($fqfn, array $dataArray) {
- // Get a file pointer instance
- $fileInstance = FrameworkFileOutputPointer::createFrameworkFileOutputPointer($fqfn, 'w');
+ // Debug message
+ //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: Flushing ' . count($dataArray) . ' elements to database file ' . $fqfn . ' ...');
// Serialize and compress it
$compressedData = $this->getCompressorChannel()->getCompressor()->compressStream(serialize($dataArray));
+ // Write data
+ //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: Writing ' . strlen($compressedData) . ' bytes ...');
+
// Write this data BASE64 encoded to the file
- $fileInstance->writeToFile(base64_encode($compressedData));
+ $this->getFileIoInstance()->saveFile($fqfn, $compressedData);
- // Close the file pointer
- $fileInstance->closeFile();
+ // Debug message
+ //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: Flushing ' . count($dataArray) . ' elements to database file completed.');
}
/**
// Initialize the result data, this need to be rewritten e.g. if a local file cannot be read
$resultData = array(
- BaseDatabaseFrontend::RESULT_INDEX_STATUS => LocalfileDatabase::RESULT_OKAY,
- BaseDatabaseFrontend::RESULT_INDEX_ROWS => array()
+ BaseDatabaseBackend::RESULT_INDEX_STATUS => self::RESULT_OKAY,
+ BaseDatabaseBackend::RESULT_INDEX_ROWS => array()
);
// Initialize limit/skip
// Read the file
$dataArray = $this->getDataArrayFromFile($pathName . $dataFile);
+ //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: dataFile=' . $dataFile . ',dataArray='.print_r($dataArray,true));
// Is this an array?
if (is_array($dataArray)) {
// Get criteria element
$criteria = $criteriaInstance->getCriteriaElemnent($key);
- // Is the criteria met?
- //* NOISY-DEBUG: */ $this->debugOutput('DATABASE: criteria[' . gettype($criteria) . ']=' . $criteria . ',()=' . strlen($criteria) . ',value=' . $value . ',()=' . strlen($value));
- if ((!is_null($criteria)) && ($criteria == $value)) {
+ // Is the criteria met or none set?
+ //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: criteria[' . gettype($criteria) . ']=' . $criteria . ';()=' . strlen($criteria) . ',criteriaInstance()=' . $criteriaInstance->count() . ',value(' . strlen($value) . ')=' . $value);
+ if (((!is_null($criteria)) && ($criteria == $value)) || ($criteriaInstance->count() == 0)) {
// Shall we skip this entry?
if ($criteriaInstance->getSkip() > 0) {
// We shall skip some entries
$dataArray[$this->getIndexKey()] = $idx;
// Entry found!
- //* NOISY-DEBUG: */ $this->debugOutput('DATABASE: indexKey=' . $this->getIndexKey() . ',idx=' . $idx . ',dataArray=' . print_r($dataArray, true));
- $resultData[BaseDatabaseFrontend::RESULT_INDEX_ROWS][] = $dataArray;
+ //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: indexKey=' . $this->getIndexKey() . ',idx=' . $idx . ',dataArray=' . print_r($dataArray, true));
+ $resultData[BaseDatabaseBackend::RESULT_INDEX_ROWS][] = $dataArray;
// Count found entries up
$limitFound++;
$this->resetLastException();
} catch (PathIsNoDirectoryException $e) {
// Path not found means "table not found" for real databases...
- $this->lastException = $e;
+ $this->setLastException($e);
// So throw an SqlException here with faked error message
throw new SqlException (array($this, sprintf("Table '%s' not found", $tableName), self::DB_CODE_TABLE_MISSING), self::EXCEPTION_SQL_QUERY);
} catch (FrameworkException $e) {
// Catch all exceptions and store them in last error
- $this->lastException = $e;
+ $this->setLastException($e);
}
// Return the gathered result
$this->resetLastException();
} catch (FrameworkException $e) {
// Catch all exceptions and store them in last error
- $this->lastException = $e;
+ $this->setLastException($e);
// Throw an SQL exception
throw new SqlException(array($this, sprintf("Cannot write data to table '%s', is the table created?", $dataSetInstance->getTableName()), self::DB_CODE_TABLE_UNWRITEABLE), self::EXCEPTION_SQL_QUERY);
$searchInstance = $dataSetInstance->getSearchInstance();
// Read the directory with some exceptions
- while (($dataFile = $directoryInstance->readDirectoryExcept(array('.', '..', '.htaccess', '.svn', "info." . $this->getFileExtension()))) && ($limitFound < $searchInstance->getLimit())) {
+ while (($dataFile = $directoryInstance->readDirectoryExcept(array('.', '..', '.htaccess', '.svn', 'info.' . $this->getFileExtension()))) && ($limitFound < $searchInstance->getLimit())) {
// Does the extension match?
if (substr($dataFile, -(strlen($this->getFileExtension()))) !== $this->getFileExtension()) {
+ // Debug message
+ //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: dataFile=' . $dataFile . ',getFileExtension()=' . $this->getFileExtension() . ' - SKIPPED!');
// Skip this file!
continue;
- }
+ } // END - if
// Open this file for reading
$dataArray = $this->getDataArrayFromFile($pathName . $dataFile);
+ //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: dataFile=' . $dataFile . ',dataArray='.print_r($dataArray,true));
// Is this an array?
if (is_array($dataArray)) {
foreach ($dataArray as $key => $value) {
// Get criteria element
$criteria = $searchInstance->getCriteriaElemnent($key);
+ //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: dataFile=' . $dataFile . ',key=' . $key . ',criteria=' . $criteria);
// Is the criteria met?
- if ((!is_null($criteria)) && ($criteria == $value)) {
-
+ if (((!is_null($criteria)) && ($criteria == $value)) || ($searchInstance->count() == 0)) {
// Shall we skip this entry?
if ($searchInstance->getSkip() > 0) {
// We shall skip some entries
// Entry found, so update it
foreach ($criteriaArray as $criteriaKey => $criteriaValue) {
+ //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: criteriaKey=' . $criteriaKey . ',criteriaValue=' . $criteriaValue);
$dataArray[$criteriaKey] = $criteriaValue;
} // END - foreach
$this->resetLastException();
} catch (FrameworkException $e) {
// Catch all exceptions and store them in last error
- $this->lastException = $e;
+ $this->setLastException($e);
// Throw an SQL exception
throw new SqlException(array($this, sprintf("Cannot write data to table '%s', is the table created?", $dataSetInstance->getTableName()), self::DB_CODE_TABLE_UNWRITEABLE), self::EXCEPTION_SQL_QUERY);
projects / core.git / blobdiff