git.roojs.org Git - Pman.Core/blob - UpdateDatabase/MysqlLinks.php

   1 <?php
   2 /**
   3  * our standard code relies on links.ini files for the relationships in mysql.
   4  *
   5  * as we use 'loose' relationships - eg. we allow '0' as a missing link mysql FORIEGN KEYS do not really work.
   6  *
   7  * There are a couple of ideas behind this code.
   8  *
   9  * a) put the relationships in the table comments FK(col=table:col,col=table:col)
  10  *  -- we can not put it in the column comments as there is no clean way to update column comments.
  11  *  -- This can be used by external programs to extract the Relationships.
  12  *
  13  * b) generate triggers? to protect against updates to the database..
  14  *
  15  *  -- stored procedures are named
  16  *     {tablename}_before_{insert|delete|update}
  17  *
  18  *
  19  *   initial code will auto generate triggers
  20  *   -- how to add User defined modifications to triggers?
  21  *   -- we can CALL a stored procedure..?
  22  *   -- {tablename}_trigger_{optional_string}_before_delete_{column_name}(NEW.column)
  23  *   -- {tablename}_trigger_{optional_string}_before_update_{column_name}(OLD.column, NEW.column}
  24  *   -- {tablename}_trigger_{optional_string}_before_insert_{column_name}(OLD.column}
  25  *
  26  *
  27  *
  28  */
  29
  30 class Pman_Core_UpdateDatabase_MysqlLinks {
  31
  32     var $dburl;
  33     var $schema;
  34     var $links;
  35
  36     function __construct()
  37     {
  38
  39         $this->loadIniFiles();
  40         $this->updateTableComments();
  41         $ff = HTML_FlexyFramework::get();
  42         if (!empty($ff->Pman['enable_trigger_tests'])) {
  43
  44             // note we may want to override some of these... - to do special triggers..
  45             // as you can only have one trigger per table for each action.
  46
  47             $this->createDeleteTriggers();
  48             $this->createInsertTriggers();
  49             $this->createUpdateTriggers();
  50         }
  51
  52
  53     }
  54
  55     function loadIniFiles()
  56     {
  57         // will create the combined ini cache file for the running user.
  58
  59         $ff = HTML_FlexyFramework::get();
  60         $ff->generateDataobjectsCache(true);
  61         $this->dburl = parse_url($ff->database);
  62
  63         $dbini = 'ini_'. basename($this->dburl['path']);
  64
  65
  66         $iniCache = $ff->DB_DataObject[$dbini];
  67
  68         $this->schema = parse_ini_file($iniCache, true);
  69         $this->links = parse_ini_file(preg_replace('/\.ini$/', '.links.ini', $iniCache), true);
  70
  71
  72
  73     }
  74     function updateTableComments()
  75     {
  76         foreach($this->links as $tbl =>$map) {
  77             $this->updateTableComment($tbl, $map);
  78
  79         }
  80
  81
  82     }
  83
  84     function updateTableComment($tbl, $map)
  85     {
  86
  87
  88         if (!isset($this->schema[$tbl])) {
  89             echo "Skip $tbl = table does not exist in schema\n";
  90             return;
  91         }
  92
  93
  94         $q = DB_DAtaObject::factory('core_enum');
  95         $q->query("SELECT
  96                      TABLE_COMMENT
  97                     FROM
  98                         information_schema.TABLES
  99                     WHERE
 100                         TABLE_SCHEMA = '{$q->escape($q->database())}'
 101                         AND
 102                         TABLE_NAME = '{$q->escape($tbl)}'
 103         ");
 104         $q->fetch();
 105         $tc = $q->TABLE_COMMENT;
 106         //echo "$tbl: $tc\n\n";
 107         if (!empty($q->TABLE_COMMENT)) {
 108             //var_dump($tc);
 109             $tc = trim(preg_replace('/FK\([^)]+\)/', '' , $q->TABLE_COMMENT));
 110             //var_dump($tc);exit;
 111             // strip out the old FC(....)
 112
 113         }
 114         $fks = array();
 115         foreach($map as $k=>$v) {
 116             $fks[] = "$k=$v";
 117         }
 118         $fkstr = $tc . ' FK(' . implode("\n", $fks) .')';
 119         if ($q->TABLE_COMMENT == $fkstr) {
 120             return;
 121         }
 122
 123         $q = DB_DAtaObject::factory('core_enum');
 124         $q->query("ALTER TABLE $tbl COMMENT = '{$q->escape($fkstr)}'");
 125
 126
 127
 128     }
 129
 130     function createDeleteTriggers()
 131     {
 132
 133         // this should only be enabled if the project settings are configured..
 134
 135
 136
 137         // delete triggers on targets -
 138         // if you delete a company, and a person points to it, then it should fire an error...
 139
 140
 141
 142
 143         // create a list of source/targets from $this->links
 144
 145
 146         $revmap = array();
 147         foreach($this->links as $tbl => $map) {
 148             if (!isset($this->schema[$tbl])) {
 149                 continue;
 150             }
 151             foreach($map as $k =>$v) {
 152                 list ($tname, $tcol) = explode(':', $v);
 153
 154
 155                 if (!isset($revmap[$tname])) {
 156                     $revmap[$tname] = array();
 157                 }
 158                 $revmap[$tname]["$tbl:$k"] = "$tname:$tcol";
 159             }
 160         }
 161
 162
 163
 164
 165         foreach($revmap as $target_table => $sources) {
 166
 167
 168             // throw example.. UPDATE `Error: invalid_id_test` SET x=1;
 169
 170             if (!isset($this->schema[$target_table])) {
 171                 echo "Skip $target_table  = table does not exist in schema\n";
 172                 continue;
 173             }
 174
 175
 176
 177             $q = DB_DataObject::factory('core_enum');
 178             $q->query("
 179                 DROP TRIGGER IF EXISTS `{$target_table}_before_delete` ;
 180             ");
 181
 182             $trigger = "
 183
 184             CREATE TRIGGER `{$target_table}_before_delete`
 185                 BEFORE DELETE ON `{$target_table}`
 186             FOR EACH ROW
 187             BEGIN
 188                DECLARE mid INT(11);
 189
 190
 191             ";
 192             foreach($sources as $source=>$target) {
 193                 list($source_table , $source_col) = explode(':', $source);
 194                 list($target_table , $target_col) = explode(':', $target);
 195                 $err = substr("Failed Delete {$target_table} refs {$source_table}:{$source_col}", 0, 64);
 196                 $trigger .="
 197                     SET mid = 0;
 198                     SELECT count(*) into mid FROM {$source_table} WHERE {$source_col} = OLD.{$target_col} LIMIT 1;
 199                     IF mid > 0 THEN
 200                        UPDATE `$err` SET x = 1;
 201                     END IF;
 202                 ";
 203             }
 204
 205             $ar = $this->listTriggerFunctions($tbl, 'delete');
 206             foreach($ar as $fn=>$col) {
 207                 $trigger .= "
 208                     CALL $fn( OLD.{$col});
 209                 ";
 210             }
 211
 212             $trigger .= "
 213             END
 214
 215             ";
 216
 217             //DB_DAtaObject::debugLevel(1);
 218             $q = DB_DataObject::factory('core_enum');
 219             $q->query($trigger);
 220              echo "CREATED TRIGGER {$target_table}_before_delete\n";
 221         }
 222
 223
 224         // inserting - row should not point to a reference that does not exist...
 225
 226
 227
 228
 229     }
 230     function createInsertTriggers()
 231     {
 232         foreach($this->links as $tbl => $map) {
 233             if (!isset($this->schema[$tbl])) {
 234                 continue;
 235             }
 236
 237             $q = DB_DataObject::factory('core_enum');
 238             $q->query("
 239                 DROP TRIGGER IF EXISTS `{$tbl}_before_insert` ;
 240             ");
 241
 242             $trigger = "
 243
 244             CREATE TRIGGER `{$tbl}_before_insert`
 245                 BEFORE INSERT ON `{$tbl}`
 246             FOR EACH ROW
 247             BEGIN
 248                DECLARE mid INT(11);
 249
 250
 251             ";
 252             foreach($map as $source_col=>$target) {
 253                 // check that source_col exists in schema.
 254                 if (!isset($this->schema[$tbl][$source_col])) {
 255                     continue;
 256                 }
 257
 258
 259                 $source_tbl = $tbl;
 260                 list($target_table , $target_col) = explode(':', $target);
 261                 $err = substr("Fail: INSERT referenced {$tbl}:{$source_col}", 0, 64);
 262                 $trigger .="
 263                     SET mid = 0;
 264                     if NEW.{$source_col} > 0 THEN
 265                         SELECT {$target_col} into mid FROM {$target_table} WHERE {$target_col} = NEW.{$source_col} LIMIT 1;
 266                         IF mid < 1 THEN
 267                             UPDATE `$err` SET x = 1;
 268                         END IF;
 269
 270                     END IF;
 271                 ";
 272
 273
 274
 275             }
 276             $ar = $this->listTriggerFunctions($tbl, 'insert');
 277             foreach($ar as $fn=>$col) {
 278                 $trigger .= "
 279                     CALL $fn( NEW.{$col});
 280                 ";
 281             }
 282
 283             $trigger .= "
 284             END
 285
 286             ";
 287             //echo $trigger; exit;
 288             //DB_DAtaObject::debugLevel(1);
 289             $q = DB_DataObject::factory('core_enum');
 290             $q->query($trigger);
 291             echo "CREATED TRIGGER {$tbl}_before_insert\n";
 292
 293
 294
 295
 296
 297
 298
 299         }
 300
 301
 302
 303     }
 304      function createUpdateTriggers()
 305     {
 306         foreach($this->links as $tbl => $map) {
 307             if (!isset($this->schema[$tbl])) {
 308                 continue;
 309             }
 310
 311             $q = DB_DataObject::factory('core_enum');
 312             $q->query("
 313                 DROP TRIGGER IF EXISTS `{$tbl}_before_update` ;
 314             ");
 315
 316             $trigger = "
 317
 318             CREATE TRIGGER `{$tbl}_before_update`
 319                 BEFORE UPDATE ON `{$tbl}`
 320             FOR EACH ROW
 321             BEGIN
 322                DECLARE mid INT(11);
 323
 324
 325             ";
 326             foreach($map as $source_col=>$target) {
 327                 // check that source_col exists in schema.
 328                 if (!isset($this->schema[$tbl][$source_col])) {
 329                     continue;
 330                 }
 331
 332
 333                 $source_tbl = $tbl;
 334                 list($target_table , $target_col) = explode(':', $target);
 335                 $err = substr("Fail: UPDATE referenced {$tbl}:$source_col", 0, 64);
 336                 $trigger .="
 337                     SET mid = 0;
 338                     if NEW.{$source_col} > 0 THEN
 339                         SELECT {$target_col} into mid FROM {$target_table} WHERE {$target_col} = NEW.{$source_col} LIMIT 1;
 340                         IF mid < 1 THEN
 341                             UPDATE `$err` SET x = 1;
 342                         END IF;
 343
 344                     END IF;
 345                 ";
 346             }
 347             $ar = $this->listTriggerFunctions($tbl, 'update');
 348             foreach($ar as $fn=>$col) {
 349                 $trigger .= "
 350                     CALL $fn(OLD.{$col}, NEW.{$col});
 351                 ";
 352             }
 353
 354             $trigger .= "
 355             END
 356
 357             ";
 358             //echo $trigger; exit;
 359             //DB_DAtaObject::debugLevel(1);
 360             $q = DB_DataObject::factory('core_enum');
 361             $q->query($trigger);
 362             echo "CREATED TRIGGER {$tbl}_before_update\n";
 363
 364
 365
 366
 367
 368
 369
 370         }
 371
 372
 373
 374     }
 375     /**
 376      * check the information schema for any methods that match the trigger criteria.
 377      *   -- {tablename}_trigger_{optional_string}_before_delete_{column_name}(NEW.column)
 378      *   -- {tablename}_trigger_{optional_string}_before_update_{column_name}(OLD.column, NEW.column}
 379      *   -- {tablename}_trigger_{optional_string}_before_insert_{column_name}(OLD.column}
 380      *
 381      *
 382      */
 383     // type = update/insert/delete
 384
 385     function listTriggerFunctions($table, $type)
 386     {
 387         static $cache = array();
 388         if (!isset($cache[$table])) {
 389             $cache[$table] = array();
 390             $q = DB_DAtaObject::factory('core_enum');
 391             $q->query("SELECT
 392                             SPECIFIC_NAME
 393                         FROM
 394                             information_schema.ROUTINES
 395                         WHERE
 396                             ROUTINE_SCHEMA = '{$q->escape($q->database())}'
 397                             AND
 398                             ROUTINE_NAME LIKE '" . $q->escape("{$table}_trigger_")  . "%'
 399                             AND
 400                             ROUTINE_TYPE = 'PROCEDURE'
 401
 402             ");
 403             while ($q->fetch()) {
 404                 $cache[$table][] = $q->SPECIFIC_NAME;
 405             }
 406
 407         }
 408         // now see which of the procedures match the specification..
 409         $ret = array();
 410         foreach($cache[$table] as $cname) {
 411             $bits = explode("_before_{$type}_", $cname);
 412             if (count($bits) < 2) {
 413                 continue;
 414             }
 415             $ret[$cname] = $bits[1];
 416         }
 417         return $ret;
 418     }
 419
 420
 421 }
 422