*
* @author Roland Haeder <webmaster@ship-simu.org>
* @version 0.0.0
- * @copyright Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @copyright Copyright (c) 2007, 2008 Roland Haeder, this is free software
* @license GNU GPL 3.0 or any newer version
* @link http://www.ship-simu.org
*
class LocalFileDatabase extends BaseDatabaseFrontend implements DatabaseFrontendInterface {
// Constants for MySQL backward-compatiblity (PLEASE FIX THEM!)
- const DB_CODE_TABLE_MISSING = 0x010;
- const DB_CODE_TABLE_UNWRITEABLE = 0x011;
- const DB_CODE_DATA_FILE_CORRUPT = 0x012;
+ const DB_CODE_TABLE_MISSING = 0x100;
+ const DB_CODE_TABLE_UNWRITEABLE = 0x101;
+ const DB_CODE_DATA_FILE_CORRUPT = 0x102;
/**
* Save path for "file database"
*/
private $lastException = null;
+ /**
+ * Table information array
+ */
+ private $tableInfo = array();
+
/**
* The protected constructor. Do never instance from outside! You need to
* set a local file path. The class will then validate it.
// Call parent constructor
parent::__construct(__CLASS__);
- // Set description
- $this->setObjectDescription("Class for local file databases");
-
- // Create unique ID
- $this->generateUniqueId();
-
// Clean up a little
+ $this->removeNumberFormaters();
$this->removeSystemArray();
}
* @throws NoArrayCreatedException If explode() fails to create an array
* @throws InvalidArrayCountException If the array contains less or
* more than two elements
+ * @deprecated
*/
public function isUniqueIdUsed ($uniqueID, $inConstructor = false) {
// Currently not used... ;-)
if ($inConstructor) {
return false;
} else {
- throw new NoArrayCreatedException(array($this, "pathFile"), self::EXCEPTION_ARRAY_EXPECTED);
+ throw new NoArrayCreatedException(array($this, 'pathFile'), self::EXCEPTION_ARRAY_EXPECTED);
}
} elseif (count($pathFile) != 2) {
// Invalid ID returned!
if ($inConstructor) {
return false;
} else {
- throw new InvalidArrayCountException(array($this, "pathFile", count($pathFile), 2), self::EXCEPTION_ARRAY_HAS_INVALID_COUNT);
+ throw new InvalidArrayCountException(array($this, 'pathFile', count($pathFile), 2), self::EXCEPTION_ARRAY_HAS_INVALID_COUNT);
}
}
// Initialize the search loop
$isValid = false;
- while ($dataFile = $dirInstance->readDirectoryExcept(array(".", "..", ".htaccess", ".svn"))) {
+ while ($dataFile = $dirInstance->readDirectoryExcept(array(".", "..", ".htaccess", ".svn", "info." . $this->getFileExtension()))) {
// Generate FQFN for testing
$fqfn = sprintf("%s/%s", $pathName, $dataFile);
$this->setLastFile($fqfn);
$fileInstance->closeFile();
}
+ /**
+ * Getter for table information file contents or an empty if the info file was not created
+ *
+ * @param $dataSetInstance An instance of a database set class
+ * @return $infoArray An array with all table informations
+ */
+ private function getContentsFromTableInfoFile (StoreableCriteria $dataSetInstance) {
+ // Default content is no data
+ $infoArray = array();
+
+ // Create FQFN for getting the table information file
+ $fqfn = $this->getSavePath() . $dataSetInstance->getTableName() . '/info.' . $this->getFileExtension();
+
+ // Get the file contents
+ try {
+ $infoArray = $this->getDataArrayFromFile($fqfn);
+ } catch (FileNotFoundException $e) {
+ // Not found, so ignore it here
+ }
+
+ // ... and return it
+ return $infoArray;
+ }
+
+ /**
+ * Creates the table info file from given dataset instance
+ *
+ * @param $dataSetInstance An instance of a database set class
+ * @return void
+ */
+ private function createTableInfoFile (StoreableCriteria $dataSetInstance) {
+ // Create FQFN for creating the table information file
+ $fqfn = $this->getSavePath() . $dataSetInstance->getTableName() . '/info.' . $this->getFileExtension();
+
+ // Get the data out from dataset in a local array
+ $this->tableInfo[$dataSetInstance->getTableName()] = array(
+ 'primary' => $dataSetInstance->getPrimaryKey(),
+ 'created' => time(),
+ 'last_updated' => time()
+ );
+
+ // Write the data to the file
+ $this->writeDataArrayToFqfn($fqfn, $this->tableInfo[$dataSetInstance->getTableName()]);
+ }
+
+ /**
+ * Updates the primary key information or creates the table info file if not found
+ *
+ * @param $dataSetInstance An instance of a database set class
+ * @return void
+ */
+ private function updatePrimaryKey (StoreableCriteria $dataSetInstance) {
+ // Get the information array from lower method
+ $infoArray = $this->getContentsFromTableInfoFile($dataSetInstance);
+
+ // Is the primary key there?
+ if (!isset($this->tableInfo['primary'])) {
+ // Then create the info file
+ $this->createTableInfoFile($dataSetInstance);
+ } elseif (($this->getConfigInstance()->readConfig('db_update_primary_forced') === "Y") && ($dataSetInstance->getPrimaryKey() != $this->tableInfo['primary'])) {
+ // Set the array element
+ $this->tableInfo[$dataSetInstance->getTableName()]['primary'] = $dataSetInstance->getPrimaryKey();
+
+ // Update the entry
+ $this->updateTableInfoFile($dataSetInstance);
+ }
+ }
+
/**
* Makes sure that the database connection is alive
*
);
// Initialize limit/skip
- $limitFound = 0; $skipFound = 0;
+ $limitFound = 0;
+ $skipFound = 0;
// Read the directory with some exceptions
- while (($dataFile = $directoryInstance->readDirectoryExcept(array(".", "..", ".htaccess", ".svn"))) && ($limitFound < $criteriaInstance->getLimit())) {
+ while (($dataFile = $directoryInstance->readDirectoryExcept(array(".", "..", ".htaccess", ".svn", "info." . $this->getFileExtension()))) && ($limitFound < $criteriaInstance->getLimit())) {
+ // Does the extension match?
+ if (substr($dataFile, -(strlen($this->getFileExtension()))) !== $this->getFileExtension()) {
+ // Skip this file!
+ continue;
+ }
+
// Read the file
$dataArray = $this->getDataArrayFromFile($pathName . $dataFile);
} // END - foreach
} else {
// Throw an exception here
- throw new SqlException(sprintf("File '%s' contains invalid data.", $dataFile), self::DB_CODE_DATA_FILE_CORRUPT);
+ throw new SqlException(array($this, sprintf("File '%s' contains invalid data.", $dataFile), self::DB_CODE_DATA_FILE_CORRUPT), self::EXCEPTION_SQL_QUERY);
}
} // END - while
// Write the data away
$this->writeDataArrayToFqfn($fqfn, $dataSetInstance->getCriteriaArray());
+ // Update the primary key
+ $this->updatePrimaryKey($dataSetInstance);
+
// Reset last error message and exception
$this->resetLastError();
} catch (FrameworkException $e) {
$directoryInstance = FrameworkDirectoryPointer::createFrameworkDirectoryPointer($pathName);
// Initialize limit/skip
- $limitFound = 0; $skipFound = 0;
+ $limitFound = 0;
+ $skipFound = 0;
// Get the criteria array from the dataset
$criteriaArray = $dataSetInstance->getCriteriaArray();
$searchInstance = $dataSetInstance->getSearchInstance();
// Read the directory with some exceptions
- while (($dataFile = $directoryInstance->readDirectoryExcept(array(".", "..", ".htaccess", ".svn"))) && ($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;
+ }
+
// Open this file for reading
$dataArray = $this->getDataArrayFromFile($pathName . $dataFile);
// Close the file pointer
$directoryInstance->closeDirectory();
+ // Update the primary key
+ $this->updatePrimaryKey($dataSetInstance);
+
// Reset last error message and exception
$this->resetLastError();
} catch (FrameworkException $e) {
$this->lastError = $e->getMessage();
// 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'", $dataSetInstance->getTableName()), self::DB_CODE_TABLE_UNWRITEABLE), self::EXCEPTION_SQL_QUERY);
}
}
+
+ /**
+ * Getter for primary key of specified table or if not found null will be
+ * returned. This must be database-specific.
+ *
+ * @param $tableName Name of the table we need the primary key from
+ * @return $primaryKey Primary key column of the given table
+ */
+ public function getPrimaryKeyOfTable ($tableName) {
+ // Default key is null
+ $primaryKey = null;
+
+ // Does the table information exist?
+ if (isset($this->tableInfo[$tableName])) {
+ // Then return the primary key
+ $primaryKey = $this->tableInfo[$tableName]['primary'];
+ } // END - if
+
+ // Return the column
+ return $primaryKey;
+ }
}
// [EOF]