Following things are changed: (in order of class names)

[shipsimu.git] / inc / classes / main / database / databases / class_LocalFileDatabase.php

diff --git a/inc/classes/main/database/databases/class_LocalFileDatabase.php b/inc/classes/main/database/databases/class_LocalFileDatabase.php
index ef5c2ba0c4a4df118bec2e1e780db4ae49b99124..60fb4d32011cb16527f8f225dbb822a57f62d0ac 100644 (file)
--- a/inc/classes/main/database/databases/class_LocalFileDatabase.php
+++ b/inc/classes/main/database/databases/class_LocalFileDatabase.php
@@ -65,6 +65,11 @@ class LocalFileDatabase extends BaseDatabaseFrontend implements DatabaseFrontend
         */
        private $lastException = null;
 
         */
        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.
        /**
         * The protected constructor. Do never instance from outside! You need to
         * set a local file path. The class will then validate it.


@@ -163,6 +168,7 @@ class LocalFileDatabase extends BaseDatabaseFrontend implements DatabaseFrontend
         * @throws      NoArrayCreatedException         If explode() fails to create an array
         * @throws      InvalidArrayCountException      If the array contains less or
         *                                                                      more than two elements
         * @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... ;-)
         */
        public function isUniqueIdUsed ($uniqueID, $inConstructor = false) {
                // Currently not used... ;-)


@@ -210,7 +216,7 @@ class LocalFileDatabase extends BaseDatabaseFrontend implements DatabaseFrontend
 
                // Initialize the search loop
                $isValid = false;
 
                // 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);
                        // Generate FQFN for testing
                        $fqfn = sprintf("%s/%s", $pathName, $dataFile);
                        $this->setLastFile($fqfn);


@@ -349,6 +355,74 @@ class LocalFileDatabase extends BaseDatabaseFrontend implements DatabaseFrontend
                $fileInstance->closeFile();
        }
 
                $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
         *
        /**
         * Makes sure that the database connection is alive
         *


@@ -389,10 +463,17 @@ class LocalFileDatabase extends BaseDatabaseFrontend implements DatabaseFrontend
                        );
 
                        // Initialize limit/skip
                        );
 
                        // Initialize limit/skip

-                       $limitFound = 0; $skipFound = 0;
+                       $limitFound = 0;
+                       $skipFound = 0;

 
                        // Read the directory with some exceptions
 
                        // 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);
 
                                // Read the file
                                $dataArray = $this->getDataArrayFromFile($pathName . $dataFile);
 


@@ -424,7 +505,7 @@ class LocalFileDatabase extends BaseDatabaseFrontend implements DatabaseFrontend
                                        } // END - foreach
                                } else {
                                        // Throw an exception here
                                        } // END - foreach
                                } else {
                                        // Throw an exception here

-                                       throw new SqlException(sprintf("File &#39;%s&#39; contains invalid data.", $dataFile), self::DB_CODE_DATA_FILE_CORRUPT);
+                                       throw new SqlException(array($this, sprintf("File &#39;%s&#39; contains invalid data.", $dataFile), self::DB_CODE_DATA_FILE_CORRUPT), self::EXCEPTION_SQL_QUERY);

                                }
                        } // END - while
 
                                }
                        } // END - while
 


@@ -472,6 +553,9 @@ class LocalFileDatabase extends BaseDatabaseFrontend implements DatabaseFrontend
                        // Write the data away
                        $this->writeDataArrayToFqfn($fqfn, $dataSetInstance->getCriteriaArray());
 
                        // 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) {
                        // Reset last error message and exception
                        $this->resetLastError();
                } catch (FrameworkException $e) {


@@ -501,7 +585,8 @@ class LocalFileDatabase extends BaseDatabaseFrontend implements DatabaseFrontend
                        $directoryInstance = FrameworkDirectoryPointer::createFrameworkDirectoryPointer($pathName);
 
                        // Initialize limit/skip
                        $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();
 
                        // Get the criteria array from the dataset
                        $criteriaArray = $dataSetInstance->getCriteriaArray();


@@ -510,7 +595,13 @@ class LocalFileDatabase extends BaseDatabaseFrontend implements DatabaseFrontend
                        $searchInstance = $dataSetInstance->getSearchInstance();
 
                        // Read the directory with some exceptions
                        $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);
 
                                // Open this file for reading
                                $dataArray = $this->getDataArrayFromFile($pathName . $dataFile);
 


@@ -553,6 +644,9 @@ class LocalFileDatabase extends BaseDatabaseFrontend implements DatabaseFrontend
                        // Close the file pointer
                        $directoryInstance->closeDirectory();
 
                        // Close the file pointer
                        $directoryInstance->closeDirectory();
 

+                       // Update the primary key
+                       $this->updatePrimaryKey($dataSetInstance);
+

                        // Reset last error message and exception
                        $this->resetLastError();
                } catch (FrameworkException $e) {
                        // Reset last error message and exception
                        $this->resetLastError();
                } catch (FrameworkException $e) {


@@ -561,9 +655,30 @@ class LocalFileDatabase extends BaseDatabaseFrontend implements DatabaseFrontend
                        $this->lastError = $e->getMessage();
 
                        // Throw an SQL exception
                        $this->lastError = $e->getMessage();
 
                        // Throw an SQL exception

-                       throw new SqlException (array($this, sprintf("Cannot write data to table &#39;%s&#39;", $tableName), self::DB_CODE_TABLE_UNWRITEABLE), self::EXCEPTION_SQL_QUERY);
+                       throw new SqlException (array($this, sprintf("Cannot write data to table &#39;%s&#39;", $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]
 }
 
 // [EOF]