X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=inc%2Fclasses%2Fmain%2Fdatabase%2Fdatabases%2Fclass_LocalFileDatabase.php;h=9c9c00bde531870addff78e18f3611f25ea5919f;hp=78375f6612f579962883e85cc4c86a5945f848e7;hb=70cb8ef9a893f8676290c77b0b83d53363b6914c;hpb=b9c18d6c24e3be4393bf41005aa4e428a0ea3218 diff --git a/inc/classes/main/database/databases/class_LocalFileDatabase.php b/inc/classes/main/database/databases/class_LocalFileDatabase.php index 78375f66..9c9c00bd 100644 --- a/inc/classes/main/database/databases/class_LocalFileDatabase.php +++ b/inc/classes/main/database/databases/class_LocalFileDatabase.php @@ -6,7 +6,7 @@ * * @author Roland Haeder * @version 0.0.0 - * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team + * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team * @license GNU GPL 3.0 or any newer version * @link http://www.ship-simu.org * @@ -32,11 +32,6 @@ class LocalFileDatabase extends BaseDatabaseFrontend implements DatabaseFrontend // Status results const RESULT_OKAY = 'ok'; - /** - * Save path for "file database" - */ - private $savePath = ''; - /** * The file's extension */ @@ -53,20 +48,10 @@ class LocalFileDatabase extends BaseDatabaseFrontend implements DatabaseFrontend private $lastContents = array(); /** - * Wether the "connection is already up + * Whether the "connection is already up */ private $alreadyConnected = false; - /** - * Last error message - */ - private $lastError = ''; - - /** - * Last exception - */ - private $lastException = null; - /** * Table information array */ @@ -75,7 +60,7 @@ class LocalFileDatabase extends BaseDatabaseFrontend implements DatabaseFrontend /** * Element for index */ - private $indexKey = "__idx"; + private $indexKey = '__idx'; /** * The protected constructor. Do never instance from outside! You need to @@ -83,78 +68,32 @@ class LocalFileDatabase extends BaseDatabaseFrontend implements DatabaseFrontend * * @return void */ - protected function __construct() { + protected function __construct () { // Call parent constructor parent::__construct(__CLASS__); - - // Clean up a little - $this->removeNumberFormaters(); - $this->removeSystemArray(); } /** - * Create an object of LocalFileDatabase and set the save path for local files. - * This method also validates the given file path. + * Create an object of LocalFileDatabase and set the save path from + * configuration for local files. * - * @param $savePath The local file path string - * @param $ioInstance The input/output handler. This - * should be FileIoHandler - * @return $dbInstance An instance of LocalFileDatabase + * @return $databaseInstance An instance of LocalFileDatabase */ - public final static function createLocalFileDatabase ($savePath, FileIoHandler $ioInstance) { + public static final function createLocalFileDatabase () { // Get an instance - $dbInstance = new LocalFileDatabase(); + $databaseInstance = new LocalFileDatabase(); + + // Get a new compressor channel instance + $compressorInstance = ObjectFactory::createObjectByConfiguredName('compressor_channel_class'); - // Set save path and IO instance - $dbInstance->setSavePath($savePath); - $dbInstance->setFileIoInstance($ioInstance); + // Set the compressor channel + $databaseInstance->setCompressorChannel($compressorInstance); // "Connect" to the database - $dbInstance->connectToDatabase(); + $databaseInstance->connectToDatabase(); // Return database instance - return $dbInstance; - } - - /** - * Setter for save path - * - * @param $savePath The local save path where we shall put our serialized classes - * @return void - */ - public final function setSavePath ($savePath) { - // Secure string - $savePath = (string) $savePath; - - // Set save path - $this->savePath = $savePath; - } - - /** - * Getter for save path - * - * @return $savePath The local save path where we shall put our serialized classes - */ - public final function getSavePath () { - return $this->savePath; - } - - /** - * Getter for last error message - * - * @return $lastError Last error message - */ - public final function getLastError () { - return $this->lastError; - } - - /** - * Getter for last exception - * - * @return $lastException Last thrown exception - */ - public final function getLastException () { - return $this->lastException; + return $databaseInstance; } /** @@ -168,17 +107,6 @@ class LocalFileDatabase extends BaseDatabaseFrontend implements DatabaseFrontend $this->lastFile = (string) $fqfn; } - /** - * Reset the last error and exception instance. This should be done after - * a successfull "query" - * - * @return void - */ - private final function resetLastError () { - $this->lastError = ''; - $this->lastException = null; - } - /** * Getter for last read file * @@ -261,6 +189,9 @@ class LocalFileDatabase extends BaseDatabaseFrontend implements DatabaseFrontend * @return void */ private function writeDataArrayToFqfn ($fqfn, array $dataArray) { + // Debug message + /* NOISY-DEBUG: */ $this->debugOutput('DATABASE: Flushing ' . count($dataArray) . ' elements to database file ' . $fqfn . ' ...'); + // Get a file pointer instance $fileInstance = FrameworkFileOutputPointer::createFrameworkFileOutputPointer($fqfn, 'w'); @@ -272,6 +203,9 @@ class LocalFileDatabase extends BaseDatabaseFrontend implements DatabaseFrontend // Close the file pointer $fileInstance->closeFile(); + + // Debug message + /* NOISY-DEBUG: */ $this->debugOutput('DATABASE: Flushing ' . count($dataArray) . ' elements to database file completed.'); } /** @@ -285,12 +219,12 @@ class LocalFileDatabase extends BaseDatabaseFrontend implements DatabaseFrontend $infoArray = array(); // Create FQFN for getting the table information file - $fqfn = $this->getSavePath() . $dataSetInstance->getTableName() . '/info.' . $this->getFileExtension(); + $fqfn = $this->generateFqfnFromDataSet($dataSetInstance, 'info'); // Get the file contents try { $infoArray = $this->getDataArrayFromFile($fqfn); - } catch (FileNotFoundException $e) { + } catch (FileIoException $e) { // Not found, so ignore it here } @@ -298,6 +232,21 @@ class LocalFileDatabase extends BaseDatabaseFrontend implements DatabaseFrontend return $infoArray; } + /** + * Generates an FQFN from given dataset instance and string + * + * @param $dataSetInstance An instance of a database set class + * @param $rowName Name of the row + * @return $fqfn The FQFN for this row + */ + private function generateFqfnFromDataSet (Criteria $dataSetInstance, $rowName) { + // This is the FQFN + $fqfn = $this->getConfigInstance()->getConfigEntry('local_db_path') . $dataSetInstance->getTableName() . '/' . $rowName . '.' . $this->getFileExtension(); + + // Return it + return $fqfn; + } + /** * Creates the table info file from given dataset instance * @@ -306,7 +255,7 @@ class LocalFileDatabase extends BaseDatabaseFrontend implements DatabaseFrontend */ private function createTableInfoFile (StoreableCriteria $dataSetInstance) { // Create FQFN for creating the table information file - $fqfn = $this->getSavePath() . $dataSetInstance->getTableName() . '/info.' . $this->getFileExtension(); + $fqfn = $this->generateFqfnFromDataSet($dataSetInstance, 'info'); // Get the data out from dataset in a local array $this->tableInfo[$dataSetInstance->getTableName()] = array( @@ -355,19 +304,18 @@ class LocalFileDatabase extends BaseDatabaseFrontend implements DatabaseFrontend * Starts a SELECT query on the database by given return type, table name * and search criteria * - * @param $resultType Result type ('array', 'object' and 'indexed' are valid) * @param $tableName Name of the database table * @param $criteria Local search criteria class * @return $resultData Result data of the query * @throws UnsupportedCriteriaException If the criteria is unsupported * @throws SqlException If an 'SQL error' occurs */ - public function querySelect ($resultType, $tableName, LocalSearchCriteria $criteriaInstance) { + public function querySelect ($tableName, LocalSearchCriteria $criteriaInstance) { // The result is null by any errors - $resultData = null; + $resultData = NULL; // Create full path name - $pathName = $this->getSavePath() . $tableName . '/'; + $pathName = $this->getConfigInstance()->getConfigEntry('local_db_path') . $tableName . '/'; // A 'select' query is not that easy on local files, so first try to // find the 'table' which is in fact a directory on the server @@ -377,8 +325,8 @@ class LocalFileDatabase extends BaseDatabaseFrontend implements DatabaseFrontend // Initialize the result data, this need to be rewritten e.g. if a local file cannot be read $resultData = array( - 'status' => LocalfileDatabase::RESULT_OKAY, - 'rows' => array() + BaseDatabaseFrontend::RESULT_INDEX_STATUS => LocalfileDatabase::RESULT_OKAY, + BaseDatabaseFrontend::RESULT_INDEX_ROWS => array() ); // Initialize limit/skip @@ -387,7 +335,7 @@ class LocalFileDatabase extends BaseDatabaseFrontend implements DatabaseFrontend $idx = 1; // Read the directory with some exceptions - while (($dataFile = $directoryInstance->readDirectoryExcept(array('.', '..', '.htaccess', '.svn', "info." . $this->getFileExtension()))) && ($limitFound < $criteriaInstance->getLimit())) { + while (($dataFile = $directoryInstance->readDirectoryExcept(array('.', '..', '.htaccess', '.svn', 'info.' . $this->getFileExtension()))) && (($limitFound < $criteriaInstance->getLimit()) || ($criteriaInstance->getLimit() == 0))) { // Does the extension match? if (substr($dataFile, -(strlen($this->getFileExtension()))) !== $this->getFileExtension()) { // Skip this file! @@ -405,8 +353,8 @@ class LocalFileDatabase extends BaseDatabaseFrontend implements DatabaseFrontend $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)) { - // Shall we skip this entry? if ($criteriaInstance->getSkip() > 0) { // We shall skip some entries @@ -421,7 +369,8 @@ class LocalFileDatabase extends BaseDatabaseFrontend implements DatabaseFrontend $dataArray[$this->getIndexKey()] = $idx; // Entry found! - $resultData['rows'][] = $dataArray; + //* NOISY-DEBUG: */ $this->debugOutput('DATABASE: indexKey=' . $this->getIndexKey() . ',idx=' . $idx . ',dataArray=' . print_r($dataArray, true)); + $resultData[BaseDatabaseFrontend::RESULT_INDEX_ROWS][] = $dataArray; // Count found entries up $limitFound++; @@ -441,19 +390,17 @@ class LocalFileDatabase extends BaseDatabaseFrontend implements DatabaseFrontend $directoryInstance->closeDirectory(); unset($directoryInstance); - // Reset last error message and exception - $this->resetLastError(); + // Reset last exception + $this->resetLastException(); } catch (PathIsNoDirectoryException $e) { // Path not found means "table not found" for real databases... - $this->lastException = $e; - $this->lastError = $e->getMessage(); + $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->lastError = $e->getMessage(); + $this->setLastException($e); } // Return the gathered result @@ -469,12 +416,7 @@ class LocalFileDatabase extends BaseDatabaseFrontend implements DatabaseFrontend */ public function queryInsertDataSet (StoreableCriteria $dataSetInstance) { // Create full path name - $fqfn = sprintf("%s%s/%s.%s", - $this->getSavePath(), - $dataSetInstance->getTableName(), - md5($dataSetInstance->getUniqueValue()), - $this->getFileExtension() - ); + $fqfn = $this->generateFqfnFromDataSet($dataSetInstance, md5($dataSetInstance->getUniqueValue())); // Try to save the request away try { @@ -484,15 +426,14 @@ class LocalFileDatabase extends BaseDatabaseFrontend implements DatabaseFrontend // Update the primary key $this->updatePrimaryKey($dataSetInstance); - // Reset last error message and exception - $this->resetLastError(); + // Reset last exception + $this->resetLastException(); } catch (FrameworkException $e) { // Catch all exceptions and store them in last error - $this->lastException = $e; - $this->lastError = $e->getMessage(); + $this->setLastException($e); // Throw an SQL exception - throw new SqlException (array($this, sprintf("Cannot write data to table '%s'", $tableName), self::DB_CODE_TABLE_UNWRITEABLE), self::EXCEPTION_SQL_QUERY); + 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); } } @@ -505,7 +446,7 @@ class LocalFileDatabase extends BaseDatabaseFrontend implements DatabaseFrontend */ public function queryUpdateDataSet (StoreableCriteria $dataSetInstance) { // Create full path name - $pathName = $this->getSavePath() . $dataSetInstance->getTableName() . '/'; + $pathName = $this->getConfigInstance()->getConfigEntry('local_db_path') . $dataSetInstance->getTableName() . '/'; // Try all the requests try { @@ -523,12 +464,12 @@ class LocalFileDatabase extends BaseDatabaseFrontend implements DatabaseFrontend $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()) { // Skip this file! continue; - } + } // END - if // Open this file for reading $dataArray = $this->getDataArrayFromFile($pathName . $dataFile); @@ -542,7 +483,6 @@ class LocalFileDatabase extends BaseDatabaseFrontend implements DatabaseFrontend // Is the criteria met? if ((!is_null($criteria)) && ($criteria == $value)) { - // Shall we skip this entry? if ($searchInstance->getSkip() > 0) { // We shall skip some entries @@ -575,15 +515,14 @@ class LocalFileDatabase extends BaseDatabaseFrontend implements DatabaseFrontend // Update the primary key $this->updatePrimaryKey($dataSetInstance); - // Reset last error message and exception - $this->resetLastError(); + // Reset last exception + $this->resetLastException(); } catch (FrameworkException $e) { // Catch all exceptions and store them in last error - $this->lastException = $e; - $this->lastError = $e->getMessage(); + $this->setLastException($e); // Throw an SQL exception - throw new SqlException (array($this, sprintf("Cannot write data to table '%s'", $dataSetInstance->getTableName()), self::DB_CODE_TABLE_UNWRITEABLE), self::EXCEPTION_SQL_QUERY); + 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); } } @@ -596,7 +535,7 @@ class LocalFileDatabase extends BaseDatabaseFrontend implements DatabaseFrontend */ public function getPrimaryKeyOfTable ($tableName) { // Default key is null - $primaryKey = null; + $primaryKey = NULL; // Does the table information exist? if (isset($this->tableInfo[$tableName])) {