inc/main/classes/database/backend/class_CachedLocalFileDatabase.php

   1 <?php
   2 /**
   3  * Database backend class for storing objects in locally created files.
   4  *
   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.
   8  *
   9  * A configurable 'file_io_class' is being used as "storage backend".
  10  *
  11  * @author              Roland Haeder <webmaster@shipsimu.org>
  12  * @version             0.0.0
  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
  16  *
  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.
  21  *
  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.
  26  *
  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/>.
  29  */
  30 class CachedLocalFileDatabase extends BaseDatabaseBackend implements DatabaseBackend {
  31         /**
  32          * The file's extension
  33          */
  34         private $fileExtension = 'serialized';
  35
  36         /**
  37          * The last read file's name
  38          */
  39         private $lastFile = '';
  40
  41         /**
  42          * The last read file's content including header information
  43          */
  44         private $lastContents = array();
  45
  46         /**
  47          * Whether the "connection is already up
  48          */
  49         private $alreadyConnected = FALSE;
  50
  51         /**
  52          * Table information array
  53          */
  54         private $tableInfo = array();
  55
  56         /**
  57          * Element for index
  58          */
  59         private $indexKey = '__idx';
  60
  61         /**
  62          * The protected constructor. Do never instance from outside! You need to
  63          * set a local file path. The class will then validate it.
  64          *
  65          * @return      void
  66          */
  67         protected function __construct () {
  68                 // Call parent constructor
  69                 parent::__construct(__CLASS__);
  70         }
  71
  72         /**
  73          * Create an object of CachedLocalFileDatabase and set the save path from
  74          * configuration for local files.
  75          *
  76          * @return      $databaseInstance       An instance of CachedLocalFileDatabase
  77          */
  78         public static final function createCachedLocalFileDatabase () {
  79                 // Get an instance
  80                 $databaseInstance = new CachedLocalFileDatabase();
  81
  82                 // Get a new compressor channel instance
  83                 $compressorInstance = ObjectFactory::createObjectByConfiguredName('compressor_channel_class');
  84
  85                 // Set the compressor channel
  86                 $databaseInstance->setCompressorChannel($compressorInstance);
  87
  88                 // Get a file IO handler
  89                 $fileIoInstance = ObjectFactory::createObjectByConfiguredName('file_io_class');
  90
  91                 // ... and set it
  92                 $databaseInstance->setFileIoInstance($fileIoInstance);
  93
  94                 // "Connect" to the database
  95                 $databaseInstance->connectToDatabase();
  96
  97                 // Return database instance
  98                 return $databaseInstance;
  99         }
 100
 101         /**
 102          * Setter for the last read file
 103          *
 104          * @param       $fqfn   The FQFN of the last read file
 105          * @return      void
 106          */
 107         private final function setLastFile ($fqfn) {
 108                 // Cast string and set it
 109                 $this->lastFile = (string) $fqfn;
 110         }
 111
 112         /**
 113          * Getter for last read file
 114          *
 115          * @return      $lastFile       The last read file's name with full path
 116          */
 117         public final function getLastFile () {
 118                 return $this->lastFile;
 119         }
 120
 121         /**
 122          * Setter for contents of the last read file
 123          *
 124          * @param               $contents       An array with header and data elements
 125          * @return      void
 126          */
 127         private final function setLastFileContents (array $contents) {
 128                 // Set array
 129                 $this->lastContents = $contents;
 130         }
 131
 132         /**
 133          * Getter for last read file's content as an array
 134          *
 135          * @return      $lastContent    The array with elements 'header' and 'data'.
 136          */
 137         public final function getLastContents () {
 138                 return $this->lastContents;
 139         }
 140
 141         /**
 142          * Getter for file extension
 143          *
 144          * @return      $fileExtension  The array with elements 'header' and 'data'.
 145          */
 146         public final function getFileExtension () {
 147                 return $this->fileExtension;
 148         }
 149
 150         /**
 151          * Getter for index key
 152          *
 153          * @return      $indexKey       Index key
 154          */
 155         public final function getIndexKey () {
 156                 return $this->indexKey;
 157         }
 158
 159         /**
 160          * Reads a local data file  and returns it's contents in an array
 161          *
 162          * @param       $fqfn   The FQFN for the requested file
 163          * @return      $dataArray
 164          */
 165         private function getDataArrayFromFile ($fqfn) {
 166                 // Debug message
 167                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: Reading elements from database file ' . $fqfn . ' ...');
 168
 169                 // Init compressed data
 170                 $compressedData = $this->getFileIoInstance()->loadFileContents($fqfn);
 171                 $compressedData = $compressedData['data'];
 172
 173                 // Close the file and throw the instance away
 174                 unset($fileInstance);
 175
 176                 // Decompress it
 177                 $serializedData = $this->getCompressorChannel()->getCompressor()->decompressStream($compressedData);
 178
 179                 // Unserialize it
 180                 $dataArray = json_decode($serializedData, TRUE);
 181
 182                 // Debug message
 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));
 185
 186                 // Finally return it
 187                 return $dataArray;
 188         }
 189
 190         /**
 191          * Writes data array to local file
 192          *
 193          * @param       $fqfn           The FQFN of the local file
 194          * @param       $dataArray      An array with all the data we shall write
 195          * @return      void
 196          */
 197         private function writeDataArrayToFqfn ($fqfn, array $dataArray) {
 198                 // Debug message
 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));
 201
 202                 // Serialize and compress it
 203                 $compressedData = $this->getCompressorChannel()->getCompressor()->compressStream(json_encode($dataArray));
 204
 205                 // Write data
 206                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: Writing ' . strlen($compressedData) . ' bytes ...');
 207
 208                 // Write this data BASE64 encoded to the file
 209                 $this->getFileIoInstance()->saveStreamToFile($fqfn, $compressedData, $this);
 210
 211                 // Debug message
 212                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: Flushing ' . count($dataArray) . ' elements to database file completed.');
 213         }
 214
 215         /**
 216          * Getter for table information file contents or an empty if info file was not created
 217          *
 218          * @param       $dataSetInstance        An instance of a database set class
 219          * @return      $infoArray                      An array with all table informations
 220          */
 221         private function getContentsFromTableInfoFile (StoreableCriteria $dataSetInstance) {
 222                 // Default content is no data
 223                 $infoArray = array();
 224
 225                 // Create FQFN for getting the table information file
 226                 $fqfn = $this->generateFqfnFromDataSet($dataSetInstance, 'info');
 227
 228                 // Get the file contents
 229                 try {
 230                         $infoArray = $this->getDataArrayFromFile($fqfn);
 231                 } catch (FileNotFoundException $e) {
 232                         // Not found, so ignore it here
 233                 }
 234
 235                 // ... and return it
 236                 return $infoArray;
 237         }
 238
 239         /**
 240          * Generates an FQFN from given dataset instance and string
 241          *
 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
 245          */
 246         private function generateFqfnFromDataSet (Criteria $dataSetInstance, $rowName) {
 247                 // This is the FQFN
 248                 $fqfn = $this->getConfigInstance()->getConfigEntry('local_db_path') . $dataSetInstance->getTableName() . '/' . $rowName . '.' . $this->getFileExtension();
 249
 250                 // Return it
 251                 return $fqfn;
 252         }
 253
 254         /**
 255          * Creates the table info file from given dataset instance
 256          *
 257          * @param       $dataSetInstance        An instance of a database set class
 258          * @return      void
 259          */
 260         private function createTableInfoFile (StoreableCriteria $dataSetInstance) {
 261                 // Create FQFN for creating the table information file
 262                 $fqfn = $this->generateFqfnFromDataSet($dataSetInstance, 'info');
 263
 264                 // Get the data out from dataset in a local array
 265                 $this->tableInfo[$dataSetInstance->getTableName()] = array(
 266                         'primary'      => $dataSetInstance->getPrimaryKey(),
 267                         'created'      => time(),
 268                         'last_updated' => time()
 269                 );
 270
 271                 // Write the data to the file
 272                 $this->writeDataArrayToFqfn($fqfn, $this->tableInfo[$dataSetInstance->getTableName()]);
 273         }
 274
 275         /**
 276          * Updates the table info file from given dataset instance
 277          *
 278          * @param       $dataSetInstance        An instance of a database set class
 279          * @return      void
 280          */
 281         private function updateTableInfoFile (StoreableCriteria $dataSetInstance) {
 282                 // Create FQFN for creating the table information file
 283                 $fqfn = $this->generateFqfnFromDataSet($dataSetInstance, 'info');
 284
 285                 // Get the data out from dataset in a local array
 286                 $this->tableInfo[$tableName]['primary']      = $dataSetInstance->getPrimaryKey();
 287                 $this->tableInfo[$tableName]['last_updated'] = time();
 288
 289                 // Write the data to the file
 290                 $this->writeDataArrayToFqfn($fqfn, $this->tableInfo[$dataSetInstance->getTableName()]);
 291         }
 292
 293         /**
 294          * Updates the primary key information or creates the table info file if not found
 295          *
 296          * @param       $dataSetInstance        An instance of a database set class
 297          * @return      void
 298          */
 299         private function updatePrimaryKey (StoreableCriteria $dataSetInstance) {
 300                 // "Cache" table name
 301                 $tableName = $dataSetInstance->getTableName();
 302
 303                 // Get the information array from lower method
 304                 $infoArray = $this->getContentsFromTableInfoFile($dataSetInstance);
 305
 306                 // Is the primary key there?
 307                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: tableInfo=' . print_r($this->tableInfo, TRUE));
 308                 if (!isset($this->tableInfo[$tableName]['primary'])) {
 309                         // Then create the info file
 310                         $this->createTableInfoFile($dataSetInstance);
 311                 } elseif (($this->getConfigInstance()->getConfigEntry('db_update_primary_forced') == 'Y') && ($dataSetInstance->getPrimaryKey() != $this->tableInfo[$tableName]['primary'])) {
 312                         // Set the array element
 313                         $this->tableInfo[$tableName]['primary'] = $dataSetInstance->getPrimaryKey();
 314
 315                         // Update the entry
 316                         $this->updateTableInfoFile($dataSetInstance);
 317                 }
 318         }
 319
 320         /**
 321          * Makes sure that the database connection is alive
 322          *
 323          * @return      void
 324          * @todo        Do some checks on the database directory and files here
 325          */
 326         public function connectToDatabase () {
 327         }
 328
 329         /**
 330          * Starts a SELECT query on the database by given return type, table name
 331          * and search criteria
 332          *
 333          * @param       $tableName                      Name of the database table
 334          * @param       $searchInstance         Local search criteria class
 335          * @return      $resultData                     Result data of the query
 336          * @throws      UnsupportedCriteriaException    If the criteria is unsupported
 337          * @throws      SqlException                                    If an 'SQL error' occurs
 338          */
 339         public function querySelect ($tableName, LocalSearchCriteria $searchInstance) {
 340                 // Debug message
 341                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: tableName=' . $tableName . ' - CALLED!');
 342
 343                 // The result is null by any errors
 344                 $resultData = NULL;
 345
 346                 // Create full path name
 347                 $pathName = $this->getConfigInstance()->getConfigEntry('local_db_path') . $tableName . '/';
 348
 349                 /*
 350                  * A 'select' query is not that easy on local files, so first try to
 351                  * find the 'table' which is in fact a directory on the server
 352                  */
 353                 try {
 354                         // Get a directory pointer instance
 355                         $directoryInstance = ObjectFactory::createObjectByConfiguredName('directory_class', array($pathName));
 356
 357                         // Initialize the result data, this need to be rewritten e.g. if a local file cannot be read
 358                         $resultData = array(
 359                                 BaseDatabaseBackend::RESULT_INDEX_STATUS => self::RESULT_OKAY,
 360                                 BaseDatabaseBackend::RESULT_INDEX_ROWS   => array()
 361                         );
 362
 363                         // Initialize limit/skip
 364                         $limitFound = 0;
 365                         $skipFound = 0;
 366                         $idx = 1;
 367
 368                         // Read the directory with some exceptions
 369                         while (($dataFile = $directoryInstance->readDirectoryExcept(array('.htaccess', 'info.' . $this->getFileExtension()))) && (($limitFound < $searchInstance->getLimit()) || ($searchInstance->getLimit() == 0))) {
 370                                 // Debug message
 371                                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: dataFile=' . $dataFile . ',this->getFileExtension()=' . $this->getFileExtension());
 372
 373                                 // Does the extension match?
 374                                 if (substr($dataFile, -(strlen($this->getFileExtension()))) !== $this->getFileExtension()) {
 375                                         // Skip this file!
 376                                         continue;
 377                                 } // END - if
 378
 379                                 // Read the file
 380                                 $dataArray = $this->getDataArrayFromFile($pathName . $dataFile);
 381                                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: dataFile=' . $dataFile . ',dataArray='.print_r($dataArray, TRUE));
 382
 383                                 // Is this an array?
 384                                 if (is_array($dataArray)) {
 385                                         // Default is nothing found
 386                                         $isFound = TRUE;
 387
 388                                         // Search in the criteria with FMFW (First Matches, First Wins)
 389                                         foreach ($dataArray as $key => $value) {
 390                                                 // Make sure value is not bool
 391                                                 assert(!is_bool($value));
 392
 393                                                 // Found one entry?
 394                                                 $isFound = (($isFound === TRUE) && ($searchInstance->isCriteriaMatching($key, $value)));
 395                                                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: key=' . $key . ',value=' . $value . ',isFound=' . intval($isFound));
 396                                         } // END - foreach
 397
 398                                         // Is all found?
 399                                         //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: isFound=' . intval($isFound) . ',limitFound=' . $limitFound . ',limit=' . $searchInstance->getLimit());
 400                                         if ($isFound === TRUE) {
 401                                                 // Shall we skip this entry?
 402                                                 if ($searchInstance->getSkip() > 0) {
 403                                                         // We shall skip some entries
 404                                                         if ($skipFound < $searchInstance->getSkip()) {
 405                                                                 // Skip this entry
 406                                                                 $skipFound++;
 407                                                                 break;
 408                                                         } // END - if
 409                                                 } // END - if
 410
 411                                                 // Set id number
 412                                                 $dataArray[$this->getIndexKey()] = $idx;
 413
 414                                                 // Entry found!
 415                                                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: indexKey=' . $this->getIndexKey() . ',idx=' . $idx . ',dataArray=' . print_r($dataArray, TRUE));
 416                                                 array_push($resultData[BaseDatabaseBackend::RESULT_INDEX_ROWS], $dataArray);
 417
 418                                                 // Count found entries up
 419                                                 $limitFound++;
 420                                         } // END - if
 421                                 } else {
 422                                         // Throw an exception here
 423                                         throw new SqlException(array($this, sprintf('File &#39;%s&#39; contains invalid data.', $dataFile), self::DB_CODE_DATA_FILE_CORRUPT), self::EXCEPTION_SQL_QUERY);
 424                                 }
 425
 426                                 // Count entry up
 427                                 $idx++;
 428                         } // END - while
 429
 430                         // Close directory and throw the instance away
 431                         $directoryInstance->closeDirectory();
 432                         unset($directoryInstance);
 433
 434                         // Reset last exception
 435                         $this->resetLastException();
 436                 } catch (PathIsNoDirectoryException $e) {
 437                         // Path not found means "table not found" for real databases...
 438                         $this->setLastException($e);
 439
 440                         // So throw an SqlException here with faked error message
 441                         throw new SqlException (array($this, sprintf('Table &#39;%s&#39; not found', $tableName), self::DB_CODE_TABLE_MISSING), self::EXCEPTION_SQL_QUERY);
 442                 } catch (FrameworkException $e) {
 443                         // Catch all exceptions and store them in last error
 444                         $this->setLastException($e);
 445                 }
 446
 447                 // Return the gathered result
 448                 return $resultData;
 449         }
 450
 451         /**
 452          * "Inserts" a data set instance into a local file database folder
 453          *
 454          * @param       $dataSetInstance        A storeable data set
 455          * @return      void
 456          * @throws      SqlException    If an SQL error occurs
 457          */
 458         public function queryInsertDataSet (StoreableCriteria $dataSetInstance) {
 459                 // Try to save the request away
 460                 try {
 461                         // Create full path name
 462                         $fqfn = $this->generateFqfnFromDataSet($dataSetInstance, md5($dataSetInstance->getUniqueValue()));
 463
 464                         // Write the data away
 465                         $this->writeDataArrayToFqfn($fqfn, $dataSetInstance->getCriteriaArray());
 466
 467                         // Update the primary key
 468                         $this->updatePrimaryKey($dataSetInstance);
 469
 470                         // Reset last exception
 471                         $this->resetLastException();
 472                 } catch (FrameworkException $e) {
 473                         // Catch all exceptions and store them in last error
 474                         $this->setLastException($e);
 475
 476                         // Throw an SQL exception
 477                         throw new SqlException(array($this, sprintf('Cannot write data to table &#39;%s&#39;, is the table created?', $dataSetInstance->getTableName()), self::DB_CODE_TABLE_UNWRITEABLE), self::EXCEPTION_SQL_QUERY);
 478                 }
 479         }
 480
 481         /**
 482          * "Updates" a data set instance with a database layer
 483          *
 484          * @param       $dataSetInstance        A storeable data set
 485          * @return      void
 486          * @throws      SqlException    If an SQL error occurs
 487          */
 488         public function queryUpdateDataSet (StoreableCriteria $dataSetInstance) {
 489                 // Create full path name
 490                 $pathName = $this->getConfigInstance()->getConfigEntry('local_db_path') . $dataSetInstance->getTableName() . '/';
 491
 492                 // Try all the requests
 493                 try {
 494                         // Get a file pointer instance
 495                         $directoryInstance = ObjectFactory::createObjectByConfiguredName('directory_class', array($pathName));
 496
 497                         // Initialize limit/skip
 498                         $limitFound = 0;
 499                         $skipFound = 0;
 500
 501                         // Get the criteria array from the dataset
 502                         $searchArray = $dataSetInstance->getCriteriaArray();
 503
 504                         // Get search criteria
 505                         $searchInstance = $dataSetInstance->getSearchInstance();
 506
 507                         // Read the directory with some exceptions
 508                         while (($dataFile = $directoryInstance->readDirectoryExcept(array('.htaccess', 'info.' . $this->getFileExtension()))) && (($limitFound < $searchInstance->getLimit()) || ($searchInstance->getLimit() == 0))) {
 509                                 // Does the extension match?
 510                                 if (substr($dataFile, -(strlen($this->getFileExtension()))) !== $this->getFileExtension()) {
 511                                         // Debug message
 512                                         //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: dataFile=' . $dataFile . ',getFileExtension()=' . $this->getFileExtension() . ' - SKIPPED!');
 513                                         // Skip this file!
 514                                         continue;
 515                                 } // END - if
 516
 517                                 // Open this file for reading
 518                                 $dataArray = $this->getDataArrayFromFile($pathName . $dataFile);
 519                                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: dataFile=' . $dataFile . ',dataArray='.print_r($dataArray, TRUE));
 520
 521                                 // Is this an array?
 522                                 if (is_array($dataArray)) {
 523                                         // Default is nothing found
 524                                         $isFound = TRUE;
 525
 526                                         // Search in the criteria with FMFW (First Matches, First Wins)
 527                                         foreach ($dataArray as $key => $value) {
 528                                                 // Make sure value is not bool
 529                                                 assert(!is_bool($value));
 530
 531                                                 // Found one entry?
 532                                                 $isFound = (($isFound === TRUE) && ($searchInstance->isCriteriaMatching($key, $value)));
 533                                         } // END - foreach
 534
 535                                         // Is all found?
 536                                         //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: isFound=' . intval($isFound));
 537                                         if ($isFound === TRUE) {
 538                                                 // Shall we skip this entry?
 539                                                 if ($searchInstance->getSkip() > 0) {
 540                                                         // We shall skip some entries
 541                                                         if ($skipFound < $searchInstance->getSkip()) {
 542                                                                 // Skip this entry
 543                                                                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: Found entry, but skipping ...');
 544                                                                 $skipFound++;
 545                                                                 break;
 546                                                         } // END - if
 547                                                 } // END - if
 548
 549                                                 // Entry found, so update it
 550                                                 foreach ($searchArray as $searchKey => $searchValue) {
 551                                                         // Make sure the value is not bool again
 552                                                         assert(!is_bool($searchValue));
 553                                                         assert($searchKey != $this->indexKey);
 554
 555                                                         // Debug message + add/update it
 556                                                         //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: criteriaKey=' . $searchKey . ',criteriaValue=' . $searchValue);
 557                                                         $dataArray[$searchKey] = $searchValue;
 558                                                 } // END - foreach
 559
 560                                                 // Write the data to a local file
 561                                                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: Writing dataArray()=' . count($dataArray) . ' to ' . $dataFile . ' ...');
 562                                                 $this->writeDataArrayToFqfn($pathName . $dataFile, $dataArray);
 563
 564                                                 // Count found entries up
 565                                                 $limitFound++;
 566                                         } // END - if
 567                                 } // END - if
 568                         } // END - while
 569
 570                         // Close the file pointer
 571                         $directoryInstance->closeDirectory();
 572
 573                         // Update the primary key
 574                         $this->updatePrimaryKey($dataSetInstance);
 575
 576                         // Reset last exception
 577                         $this->resetLastException();
 578                 } catch (FrameworkException $e) {
 579                         // Catch all exceptions and store them in last error
 580                         $this->setLastException($e);
 581
 582                         // Throw an SQL exception
 583                         throw new SqlException(array($this, sprintf('Cannot write data to table &#39;%s&#39;, is the table created? Exception: %s, message:%s', $dataSetInstance->getTableName(), $e->__toString(), $e->getMessage()), self::DB_CODE_TABLE_UNWRITEABLE), self::EXCEPTION_SQL_QUERY);
 584                 }
 585         }
 586
 587         /**
 588          * Getter for primary key of specified table or if not found null will be
 589          * returned. This must be database-specific.
 590          *
 591          * @param       $tableName              Name of the table we need the primary key from
 592          * @return      $primaryKey             Primary key column of the given table
 593          */
 594         public function getPrimaryKeyOfTable ($tableName) {
 595                 // Default key is null
 596                 $primaryKey = NULL;
 597
 598                 // Does the table information exist?
 599                 if (isset($this->tableInfo[$tableName])) {
 600                         // Then return the primary key
 601                         $primaryKey = $this->tableInfo[$tableName]['primary'];
 602                 } // END - if
 603
 604                 // Return the column
 605                 return $primaryKey;
 606         }
 607
 608         /**
 609          * Removes non-public data from given array.
 610          *
 611          * @param       $data   An array with possible non-public data that needs to be removed.
 612          * @return      $data   A cleaned up array with only public data.
 613          * @todo        Add more generic non-public data for removal
 614          */
 615         public function removeNonPublicDataFromArray (array $data) {
 616                 // Remove '__idx'
 617                 unset($data[$this->indexKey]);
 618
 619                 // Return it
 620                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: data[' . gettype($data) . ']='.print_r($data, TRUE));
 621                 return $data;
 622         }
 623
 624         /**
 625          * Counts total rows of given table
 626          *
 627          * @param       $tableName      Table name
 628          * @return      $count          Total rows of given table
 629          */
 630         public function countTotalRows($tableName) {
 631                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: tableName=' . $tableName . ' - CALLED!');
 632
 633                 // Create full path name
 634                 $pathName = $this->getConfigInstance()->getConfigEntry('local_db_path') . $tableName . '/';
 635
 636                 // Try all the requests
 637                 try {
 638                         // Get a file pointer instance
 639                         $directoryInstance = ObjectFactory::createObjectByConfiguredName('directory_class', array($pathName));
 640
 641                         // Initialize counter
 642                         $count = 0;
 643
 644                         // Read the directory with some exceptions
 645                         while ($dataFile = $directoryInstance->readDirectoryExcept(array('.htaccess', 'info.' . $this->getFileExtension()))) {
 646                                 // Does the extension match?
 647                                 if (substr($dataFile, -(strlen($this->getFileExtension()))) !== $this->getFileExtension()) {
 648                                         // Debug message
 649                                         //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: dataFile=' . $dataFile . ',getFileExtension()=' . $this->getFileExtension() . ' - SKIPPED!');
 650                                         // Skip this file!
 651                                         continue;
 652                                 } // END - if
 653
 654                                 // Count this row up
 655                                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: dataFile=' . $dataFile . ',getFileExtension()=' . $this->getFileExtension() . ' - COUNTED!');
 656                                 $count++;
 657                         } // END - while
 658                 } catch (FrameworkException $e) {
 659                         // Catch all exceptions and store them in last error
 660                         $this->setLastException($e);
 661
 662                         // Throw an SQL exception
 663                         throw new SqlException(array($this, sprintf('Cannot count on table &#39;%s&#39;, is the table created?', $dataSetInstance->getTableName()), self::DB_CODE_TABLE_NOT_FOUND), self::EXCEPTION_SQL_QUERY);
 664                 }
 665
 666                 // Return count
 667                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE: tableName=' . $tableName . ',count=' . $count . ' - EXIT!');
 668                 return $count;
 669         }
 670 }
 671
 672 // [EOF]
 673 ?>