lib/schemaupdater.php

   1 <?php
   2
   3 /**
   4  * StatusNet, the distributed open-source microblogging tool
   5  *
   6  * Database schema utilities
   7  *
   8  * PHP version 5
   9  *
  10  * LICENCE: This program is free software: you can redistribute it and/or modify
  11  * it under the terms of the GNU Affero General Public License as published by
  12  * the Free Software Foundation, either version 3 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Affero General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Affero General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  *
  23  * @category  Database
  24  * @package   StatusNet
  25  * @author    Evan Prodromou <evan@status.net>
  26  * @copyright 2009 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('GNUSOCIAL')) { exit(1); }
  32
  33 class SchemaUpdater
  34 {
  35     public function __construct($schema)
  36     {
  37         $this->schema = $schema;
  38         $this->checksums = $this->getChecksums();
  39     }
  40
  41     /**
  42      * @param string $tableName
  43      * @param array $tableDef
  44      */
  45     public function register($tableName, array $tableDef)
  46     {
  47         // Check if the table we're registering is related to a Managed_DataObject
  48         if (is_a(ucfirst($tableName), 'Managed_DataObject', true)) {
  49             call_user_func("{$tableName}::beforeSchemaUpdate");
  50         }
  51
  52         $this->tables[$tableName] = $tableDef;
  53     }
  54
  55     /**
  56      * Go ping em!
  57      *
  58      * @fixme handle tables that belong on different database servers...?
  59      */
  60     public function checkSchema()
  61     {
  62         $checksums = $this->checksums;
  63         foreach ($this->tables as $table => $def) {
  64             $checksum = $this->checksum($def);
  65             if (empty($checksums[$table])) {
  66                 common_log(LOG_DEBUG, "No previous schema_version for $table: updating to $checksum");
  67             } else if ($checksums[$table] == $checksum) {
  68                 common_log(LOG_DEBUG, "Last schema_version for $table up to date: $checksum");
  69                 continue;
  70             } else {
  71                 common_log(LOG_DEBUG, "Last schema_version for $table is {$checksums[$table]}: updating to $checksum");
  72             }
  73             //$this->conn->query('BEGIN');
  74             $this->schema->ensureTable($table, $def);
  75             $this->saveChecksum($table, $checksum);
  76             //$this->conn->commit();
  77         }
  78     }
  79
  80     /**
  81      * Calculate a checksum for this table definition array.
  82      *
  83      * @param array $def
  84      * @return string
  85      */
  86     public function checksum(array $def)
  87     {
  88         $flat = serialize($def);
  89         return sha1($flat);
  90     }
  91
  92     /**
  93      * Pull all known table checksums into an array for easy lookup.
  94      *
  95      * @return array: associative array of table names to checksum strings
  96      */
  97     protected function getChecksums()
  98     {
  99         $checksums = array();
 100
 101         try {
 102             $sv = new Schema_version();
 103             $sv->find();
 104             while ($sv->fetch()) {
 105                 $checksums[$sv->table_name] = $sv->checksum;
 106             }
 107
 108             return $checksums;
 109         } catch (Exception $e) {
 110             // no dice!
 111             common_log(LOG_DEBUG, "Possibly schema_version table doesn't exist yet.");
 112         }
 113
 114         return $checksums;
 115     }
 116
 117     /**
 118      * Save or update current available checksums.
 119      *
 120      * @param string $table
 121      * @param string $checksum
 122      */
 123     protected function saveChecksum($table, $checksum)
 124     {
 125         try {
 126             $sv = new Schema_version();
 127             $sv->table_name = $table;
 128             $sv->checksum = $checksum;
 129             $sv->modified = common_sql_now();
 130             if (isset($this->checksums[$table])) {
 131                 $sv->update();
 132             } else {
 133                 $sv->insert();
 134             }
 135         } catch (Exception $e) {
 136             // no dice!
 137             common_log(LOG_DEBUG, "Possibly schema_version table doesn't exist yet.");
 138         }
 139         $this->checksums[$table] = $checksum;
 140     }
 141 }