3 * Database backend class for storing objects in locally created files.
5 * This class serializes arrays stored in the dataset instance and saves them
6 * to local files. Every file (except 'info') represents a single line. Every
7 * directory within the 'db' (base) directory represents a table.
9 * A configurable 'file_io_class' is being used as "storage backend".
11 * @author Roland Haeder <webmaster@shipsimu.org>
13 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
14 * @license GNU GPL 3.0 or any newer version
15 * @link http://www.shipsimu.org
17 * This program is free software: you can redistribute it and/or modify
18 * it under the terms of the GNU General Public License as published by
19 * the Free Software Foundation, either version 3 of the License, or
20 * (at your option) any later version.
22 * This program is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU General Public License for more details.
27 * You should have received a copy of the GNU General Public License
28 * along with this program. If not, see <http://www.gnu.org/licenses/>.
30 class CachedLocalFileDatabase extends BaseDatabaseBackend implements DatabaseBackend {
32 * The file's extension
34 private $fileExtension = 'serialized';
37 * The last read file's name
39 private $lastFile = '';
42 * The last read file's content including header information
44 private $lastContents = array();
47 * Whether the "connection is already up
49 private $alreadyConnected = FALSE;
52 * Table information array
54 private $tableInfo = array();
59 private $indexKey = '__idx';
62 * The protected constructor. Do never instance from outside! You need to
63 * set a local file path. The class will then validate it.
67 protected function __construct () {
68 // Call parent constructor
69 parent::__construct(__CLASS__);
73 * Create an object of CachedLocalFileDatabase and set the save path from
74 * configuration for local files.
76 * @return $databaseInstance An instance of CachedLocalFileDatabase
78 public static final function createCachedLocalFileDatabase () {
80 $databaseInstance = new CachedLocalFileDatabase();
82 // Get a new compressor channel instance
83 $compressorInstance = ObjectFactory::createObjectByConfiguredName('compressor_channel_class');
85 // Set the compressor channel
86 $databaseInstance->setCompressorChannel($compressorInstance);
88 // Get a file IO handler
89 $fileIoInstance = ObjectFactory::createObjectByConfiguredName('file_io_class');
92 $databaseInstance->setFileIoInstance($fileIoInstance);
94 // "Connect" to the database
95 $databaseInstance->connectToDatabase();
97 // Return database instance
98 return $databaseInstance;
102 * Setter for the last read file
104 * @param $fqfn The FQFN of the last read file
107 private final function setLastFile ($fqfn) {
108 // Cast string and set it
109 $this->lastFile = (string) $fqfn;
113 * Getter for last read file
115 * @return $lastFile The last read file's name with full path
117 public final function getLastFile () {
118 return $this->lastFile;
122 * Setter for contents of the last read file
124 * @param $contents An array with header and data elements
127 private final function setLastFileContents (array $contents) {
129 $this->lastContents = $contents;
133 * Getter for last read file's content as an array
135 * @return $lastContent The array with elements 'header' and 'data'.
137 public final function getLastContents () {
138 return $this->lastContents;
142 * Getter for file extension
144 * @return $fileExtension The array with elements 'header' and 'data'.
146 public final function getFileExtension () {
147 return $this->fileExtension;
151 * Getter for index key
153 * @return $indexKey Index key
155 public final function getIndexKey () {
156 return $this->indexKey;
160 * Reads a local data file and returns it's contents in an array
162 * @param $fqfn The FQFN for the requested file
165 private function getDataArrayFromFile ($fqfn) {
167 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: Reading elements from database file ' . $fqfn . ' ...');
169 // Init compressed data
170 $compressedData = $this->getFileIoInstance()->loadFileContents($fqfn);
171 $compressedData = $compressedData['data'];
173 // Close the file and throw the instance away
174 unset($fileInstance);
177 $serializedData = $this->getCompressorChannel()->getCompressor()->decompressStream($compressedData);
180 $dataArray = json_decode($serializedData, TRUE);
183 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: Read ' . count($dataArray) . ' elements from database file ' . $fqfn . '.');
184 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: dataArray=' . print_r($dataArray, TRUE));
191 * Writes data array to local file
193 * @param $fqfn The FQFN of the local file
194 * @param $dataArray An array with all the data we shall write
197 private function writeDataArrayToFqfn ($fqfn, array $dataArray) {
199 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: Flushing ' . count($dataArray) . ' elements to database file ' . $fqfn . ' ...');
200 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: dataArray=' . print_r($dataArray, TRUE));
202 // Serialize and compress it
203 $compressedData = $this->getCompressorChannel()->getCompressor()->compressStream(json_encode($dataArray));
206 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: Writing ' . strlen($compressedData) . ' bytes ...');
208 // Write this data BASE64 encoded to the file
209 $this->getFileIoInstance()->saveStreamToFile($fqfn, $compressedData, $this);
212 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: Flushing ' . count($dataArray) . ' elements to database file completed.');
216 * Getter for table information file contents or an empty if info file was not created
218 * @param $dataSetInstance An instance of a database set class
219 * @return $infoArray An array with all table informations
221 private function getContentsFromTableInfoFile (StoreableCriteria $dataSetInstance) {
222 // Default content is no data
223 $infoArray = array();
225 // Create FQFN for getting the table information file
226 $fqfn = $this->generateFqfnFromDataSet($dataSetInstance, 'info');
228 // Get the file contents
230 $infoArray = $this->getDataArrayFromFile($fqfn);
231 } catch (FileNotFoundException $e) {
232 // Not found, so ignore it here
240 * Generates an FQFN from given dataset instance and string
242 * @param $dataSetInstance An instance of a database set class
243 * @param $rowName Name of the row
244 * @return $fqfn The FQFN for this row
246 private function generateFqfnFromDataSet (Criteria $dataSetInstance, $rowName) {
248 $fqfn = $this->getConfigInstance()->getConfigEntry('local_db_path') . $dataSetInstance->getTableName() . '/' . $rowName . '.' . $this->getFileExtension();
255 * Creates the table info file from given dataset instance
257 * @param $dataSetInstance An instance of a database set class
260 private function createTableInfoFile (StoreableCriteria $dataSetInstance) {
261 // Create FQFN for creating the table information file
262 $fqfn = $this->generateFqfnFromDataSet($dataSetInstance, 'info');
264 // Get the data out from dataset in a local array
265 $this->tableInfo[$dataSetInstance->getTableName()] = array(
266 'primary' => $dataSetInstance->getPrimaryKey(),
268 'last_updated' => time()
271 // Write the data to the file
272 $this->writeDataArrayToFqfn($fqfn, $this->tableInfo[$dataSetInstance->getTableName()]);
276 * Updates the table info file from given dataset instance
278 * @param $dataSetInstance An instance of a database set class
281 private function updateTableInfoFile (StoreableCriteria $dataSetInstance) {
282 // Get table name from criteria
283 $tableName = $dataSetInstance->getTableName();
285 // Create FQFN for creating the table information file
286 $fqfn = $this->generateFqfnFromDataSet($dataSetInstance, 'info');
288 // Get the data out from dataset in a local array
289 $this->tableInfo[$tableName]['primary'] = $dataSetInstance->getPrimaryKey();
290 $this->tableInfo[$tableName]['last_updated'] = time();
292 // Write the data to the file
293 $this->writeDataArrayToFqfn($fqfn, $this->tableInfo[$tableName]);
297 * Updates the primary key information or creates the table info file if not found
299 * @param $dataSetInstance An instance of a database set class
302 private function updatePrimaryKey (StoreableCriteria $dataSetInstance) {
303 // Get table name from criteria
304 $tableName = $dataSetInstance->getTableName();
306 // Get the information array from lower method
307 $infoArray = $this->getContentsFromTableInfoFile($dataSetInstance);
309 // Is the primary key there?
310 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: tableInfo=' . print_r($this->tableInfo, TRUE));
311 if (!isset($this->tableInfo[$tableName]['primary'])) {
312 // Then create the info file
313 $this->createTableInfoFile($dataSetInstance);
314 } elseif (($this->getConfigInstance()->getConfigEntry('db_update_primary_forced') == 'Y') && ($dataSetInstance->getPrimaryKey() != $this->tableInfo[$tableName]['primary'])) {
315 // Set the array element
316 $this->tableInfo[$tableName]['primary'] = $dataSetInstance->getPrimaryKey();
319 $this->updateTableInfoFile($dataSetInstance);
324 * Makes sure that the database connection is alive
327 * @todo Do some checks on the database directory and files here
329 public function connectToDatabase () {
333 * Starts a SELECT query on the database by given return type, table name
334 * and search criteria
336 * @param $tableName Name of the database table
337 * @param $searchInstance Local search criteria class
338 * @return $resultData Result data of the query
339 * @throws UnsupportedCriteriaException If the criteria is unsupported
340 * @throws SqlException If an 'SQL error' occurs
342 public function querySelect ($tableName, LocalSearchCriteria $searchInstance) {
344 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: tableName=' . $tableName . ' - CALLED!');
346 // The result is null by any errors
349 // Create full path name
350 $pathName = $this->getConfigInstance()->getConfigEntry('local_db_path') . $tableName . '/';
353 * A 'select' query is not that easy on local files, so first try to
354 * find the 'table' which is in fact a directory on the server
357 // Get a directory pointer instance
358 $directoryInstance = ObjectFactory::createObjectByConfiguredName('directory_class', array($pathName));
360 // Initialize the result data, this need to be rewritten e.g. if a local file cannot be read
362 BaseDatabaseBackend::RESULT_INDEX_STATUS => self::RESULT_OKAY,
363 BaseDatabaseBackend::RESULT_INDEX_ROWS => array()
366 // Initialize limit/skip
371 // Read the directory with some exceptions
372 while (($dataFile = $directoryInstance->readDirectoryExcept(array('.htaccess', 'info.' . $this->getFileExtension()))) && (($limitFound < $searchInstance->getLimit()) || ($searchInstance->getLimit() == 0))) {
374 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: dataFile=' . $dataFile . ',this->getFileExtension()=' . $this->getFileExtension());
376 // Does the extension match?
377 if (substr($dataFile, -(strlen($this->getFileExtension()))) !== $this->getFileExtension()) {
383 $dataArray = $this->getDataArrayFromFile($pathName . $dataFile);
384 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: dataFile=' . $dataFile . ',dataArray='.print_r($dataArray, TRUE));
387 if (is_array($dataArray)) {
388 // Default is nothing found
391 // Search in the criteria with FMFW (First Matches, First Wins)
392 foreach ($dataArray as $key => $value) {
393 // Make sure value is not bool
394 assert(!is_bool($value));
397 $isFound = (($isFound === TRUE) && ($searchInstance->isCriteriaMatching($key, $value)));
398 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: key=' . $key . ',value=' . $value . ',isFound=' . intval($isFound));
402 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: isFound=' . intval($isFound) . ',limitFound=' . $limitFound . ',limit=' . $searchInstance->getLimit());
403 if ($isFound === TRUE) {
404 // Shall we skip this entry?
405 if ($searchInstance->getSkip() > 0) {
406 // We shall skip some entries
407 if ($skipFound < $searchInstance->getSkip()) {
415 $dataArray[$this->getIndexKey()] = $idx;
418 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: indexKey=' . $this->getIndexKey() . ',idx=' . $idx . ',dataArray=' . print_r($dataArray, TRUE));
419 array_push($resultData[BaseDatabaseBackend::RESULT_INDEX_ROWS], $dataArray);
421 // Count found entries up
425 // Throw an exception here
426 throw new SqlException(array($this, sprintf('File '%s' contains invalid data.', $dataFile), self::DB_CODE_DATA_FILE_CORRUPT), self::EXCEPTION_SQL_QUERY);
433 // Close directory and throw the instance away
434 $directoryInstance->closeDirectory();
435 unset($directoryInstance);
437 // Reset last exception
438 $this->resetLastException();
439 } catch (PathIsNoDirectoryException $e) {
440 // Path not found means "table not found" for real databases...
441 $this->setLastException($e);
443 // So throw an SqlException here with faked error message
444 throw new SqlException (array($this, sprintf('Table '%s' not found', $tableName), self::DB_CODE_TABLE_MISSING), self::EXCEPTION_SQL_QUERY);
445 } catch (FrameworkException $e) {
446 // Catch all exceptions and store them in last error
447 $this->setLastException($e);
450 // Return the gathered result
455 * "Inserts" a data set instance into a local file database folder
457 * @param $dataSetInstance A storeable data set
459 * @throws SqlException If an SQL error occurs
461 public function queryInsertDataSet (StoreableCriteria $dataSetInstance) {
462 // Try to save the request away
464 // Create full path name
465 $fqfn = $this->generateFqfnFromDataSet($dataSetInstance, md5($dataSetInstance->getUniqueValue()));
467 // Write the data away
468 $this->writeDataArrayToFqfn($fqfn, $dataSetInstance->getCriteriaArray());
470 // Update the primary key
471 $this->updatePrimaryKey($dataSetInstance);
473 // Reset last exception
474 $this->resetLastException();
475 } catch (FrameworkException $e) {
476 // Catch all exceptions and store them in last error
477 $this->setLastException($e);
479 // Throw an SQL exception
480 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);
485 * "Updates" a data set instance with a database layer
487 * @param $dataSetInstance A storeable data set
489 * @throws SqlException If an SQL error occurs
491 public function queryUpdateDataSet (StoreableCriteria $dataSetInstance) {
492 // Create full path name
493 $pathName = $this->getConfigInstance()->getConfigEntry('local_db_path') . $dataSetInstance->getTableName() . '/';
495 // Try all the requests
497 // Get a file pointer instance
498 $directoryInstance = ObjectFactory::createObjectByConfiguredName('directory_class', array($pathName));
500 // Initialize limit/skip
504 // Get the criteria array from the dataset
505 $searchArray = $dataSetInstance->getCriteriaArray();
507 // Get search criteria
508 $searchInstance = $dataSetInstance->getSearchInstance();
510 // Read the directory with some exceptions
511 while (($dataFile = $directoryInstance->readDirectoryExcept(array('.htaccess', 'info.' . $this->getFileExtension()))) && (($limitFound < $searchInstance->getLimit()) || ($searchInstance->getLimit() == 0))) {
512 // Does the extension match?
513 if (substr($dataFile, -(strlen($this->getFileExtension()))) !== $this->getFileExtension()) {
515 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: dataFile=' . $dataFile . ',getFileExtension()=' . $this->getFileExtension() . ' - SKIPPED!');
520 // Open this file for reading
521 $dataArray = $this->getDataArrayFromFile($pathName . $dataFile);
522 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: dataFile=' . $dataFile . ',dataArray='.print_r($dataArray, TRUE));
525 if (is_array($dataArray)) {
526 // Default is nothing found
529 // Search in the criteria with FMFW (First Matches, First Wins)
530 foreach ($dataArray as $key => $value) {
531 // Make sure value is not bool
532 assert(!is_bool($value));
535 $isFound = (($isFound === TRUE) && ($searchInstance->isCriteriaMatching($key, $value)));
539 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: isFound=' . intval($isFound));
540 if ($isFound === TRUE) {
541 // Shall we skip this entry?
542 if ($searchInstance->getSkip() > 0) {
543 // We shall skip some entries
544 if ($skipFound < $searchInstance->getSkip()) {
546 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: Found entry, but skipping ...');
552 // Entry found, so update it
553 foreach ($searchArray as $searchKey => $searchValue) {
554 // Make sure the value is not bool again
555 assert(!is_bool($searchValue));
556 assert($searchKey != $this->indexKey);
558 // Debug message + add/update it
559 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: criteriaKey=' . $searchKey . ',criteriaValue=' . $searchValue);
560 $dataArray[$searchKey] = $searchValue;
563 // Write the data to a local file
564 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: Writing dataArray()=' . count($dataArray) . ' to ' . $dataFile . ' ...');
565 $this->writeDataArrayToFqfn($pathName . $dataFile, $dataArray);
567 // Count found entries up
573 // Close the file pointer
574 $directoryInstance->closeDirectory();
576 // Update the primary key
577 $this->updatePrimaryKey($dataSetInstance);
579 // Reset last exception
580 $this->resetLastException();
581 } catch (FrameworkException $e) {
582 // Catch all exceptions and store them in last error
583 $this->setLastException($e);
585 // Throw an SQL exception
586 throw new SqlException(array($this, sprintf('Cannot write data to table '%s', is the table created? Exception: %s, message:%s', $dataSetInstance->getTableName(), $e->__toString(), $e->getMessage()), self::DB_CODE_TABLE_UNWRITEABLE), self::EXCEPTION_SQL_QUERY);
591 * Getter for primary key of specified table or if not found null will be
592 * returned. This must be database-specific.
594 * @param $tableName Name of the table we need the primary key from
595 * @return $primaryKey Primary key column of the given table
597 public function getPrimaryKeyOfTable ($tableName) {
598 // Default key is null
601 // Does the table information exist?
602 if (isset($this->tableInfo[$tableName])) {
603 // Then return the primary key
604 $primaryKey = $this->tableInfo[$tableName]['primary'];
612 * Removes non-public data from given array.
614 * @param $data An array with possible non-public data that needs to be removed.
615 * @return $data A cleaned up array with only public data.
616 * @todo Add more generic non-public data for removal
618 public function removeNonPublicDataFromArray (array $data) {
620 unset($data[$this->indexKey]);
623 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: data[' . gettype($data) . ']='.print_r($data, TRUE));
628 * Counts total rows of given table
630 * @param $tableName Table name
631 * @return $count Total rows of given table
633 public function countTotalRows($tableName) {
634 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: tableName=' . $tableName . ' - CALLED!');
636 // Create full path name
637 $pathName = $this->getConfigInstance()->getConfigEntry('local_db_path') . $tableName . '/';
639 // Try all the requests
641 // Get a file pointer instance
642 $directoryInstance = ObjectFactory::createObjectByConfiguredName('directory_class', array($pathName));
644 // Initialize counter
647 // Read the directory with some exceptions
648 while ($dataFile = $directoryInstance->readDirectoryExcept(array('.htaccess', 'info.' . $this->getFileExtension()))) {
649 // Does the extension match?
650 if (substr($dataFile, -(strlen($this->getFileExtension()))) !== $this->getFileExtension()) {
652 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: dataFile=' . $dataFile . ',getFileExtension()=' . $this->getFileExtension() . ' - SKIPPED!');
658 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: dataFile=' . $dataFile . ',getFileExtension()=' . $this->getFileExtension() . ' - COUNTED!');
661 } catch (FrameworkException $e) {
662 // Catch all exceptions and store them in last error
663 $this->setLastException($e);
665 // Throw an SQL exception
666 throw new SqlException(array($this, sprintf('Cannot count on table '%s', is the table created?', $dataSetInstance->getTableName()), self::DB_CODE_TABLE_NOT_FOUND), self::EXCEPTION_SQL_QUERY);
670 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: tableName=' . $tableName . ',count=' . $count . ' - EXIT!');