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
 262                 if (!isset($this->schema[$target_table])) {
 263                     // skip... target table does not exist
 264                     continue;
 265                 }
 266
 267
 268                 $err = substr("Fail: INSERT referenced {$tbl}:{$source_col}", 0, 64);
 269                 $trigger .="
 270                     SET mid = 0;
 271                     if NEW.{$source_col} > 0 THEN
 272                         SELECT {$target_col} into mid FROM {$target_table} WHERE {$target_col} = NEW.{$source_col} LIMIT 1;
 273                         IF mid < 1 THEN
 274                             UPDATE `$err` SET x = 1;
 275                         END IF;
 276
 277                     END IF;
 278                 ";
 279
 280
 281
 282             }
 283             $ar = $this->listTriggerFunctions($tbl, 'insert');
 284             foreach($ar as $fn=>$col) {
 285                 $trigger .= "
 286                     CALL $fn( NEW.{$col});
 287                 ";
 288             }
 289
 290             $trigger .= "
 291             END
 292
 293             ";
 294             //echo $trigger; exit;
 295             //DB_DAtaObject::debugLevel(1);
 296             $q = DB_DataObject::factory('core_enum');
 297             $q->query($trigger);
 298             echo "CREATED TRIGGER {$tbl}_before_insert\n";
 299
 300
 301
 302
 303
 304
 305
 306         }
 307
 308
 309
 310     }
 311      function createUpdateTriggers()
 312     {
 313         foreach($this->links as $tbl => $map) {
 314             if (!isset($this->schema[$tbl])) {
 315                 continue;
 316             }
 317
 318             $q = DB_DataObject::factory('core_enum');
 319             $q->query("
 320                 DROP TRIGGER IF EXISTS `{$tbl}_before_update` ;
 321             ");
 322
 323             $trigger = "
 324
 325             CREATE TRIGGER `{$tbl}_before_update`
 326                 BEFORE UPDATE ON `{$tbl}`
 327             FOR EACH ROW
 328             BEGIN
 329                DECLARE mid INT(11);
 330
 331
 332             ";
 333             foreach($map as $source_col=>$target) {
 334                 // check that source_col exists in schema.
 335                 if (!isset($this->schema[$tbl][$source_col])) {
 336                     continue;
 337                 }
 338
 339
 340                 $source_tbl = $tbl;
 341                 list($target_table , $target_col) = explode(':', $target);
 342
 343                 if (!isset($this->schema[$target_table])) {
 344                     // skip... target table does not exist
 345                     continue;
 346                 }
 347
 348                 $err = substr("Fail: UPDATE referenced {$tbl}:$source_col", 0, 64);
 349                 $trigger .="
 350                     SET mid = 0;
 351                     if NEW.{$source_col} > 0 THEN
 352                         SELECT {$target_col} into mid FROM {$target_table} WHERE {$target_col} = NEW.{$source_col} LIMIT 1;
 353                         IF mid < 1 THEN
 354                             UPDATE `$err` SET x = 1;
 355                         END IF;
 356
 357                     END IF;
 358                 ";
 359             }
 360             $ar = $this->listTriggerFunctions($tbl, 'update');
 361             foreach($ar as $fn=>$col) {
 362                 $trigger .= "
 363                     CALL $fn(OLD.{$col}, NEW.{$col});
 364                 ";
 365             }
 366
 367             $trigger .= "
 368             END
 369
 370             ";
 371             //echo $trigger; exit;
 372             //DB_DAtaObject::debugLevel(1);
 373             $q = DB_DataObject::factory('core_enum');
 374             $q->query($trigger);
 375             echo "CREATED TRIGGER {$tbl}_before_update\n";
 376
 377
 378
 379
 380
 381
 382
 383         }
 384
 385
 386
 387     }
 388     /**
 389      * check the information schema for any methods that match the trigger criteria.
 390      *   -- {tablename}_trigger_{optional_string}_before_delete_{column_name}(NEW.column)
 391      *   -- {tablename}_trigger_{optional_string}_before_update_{column_name}(OLD.column, NEW.column}
 392      *   -- {tablename}_trigger_{optional_string}_before_insert_{column_name}(OLD.column}
 393      *
 394      *
 395      */
 396     // type = update/insert/delete
 397
 398     function listTriggerFunctions($table, $type)
 399     {
 400         static $cache = array();
 401         if (!isset($cache[$table])) {
 402             $cache[$table] = array();
 403             $q = DB_DAtaObject::factory('core_enum');
 404             $q->query("SELECT
 405                             SPECIFIC_NAME
 406                         FROM
 407                             information_schema.ROUTINES
 408                         WHERE
 409                             ROUTINE_SCHEMA = '{$q->escape($q->database())}'
 410                             AND
 411                             ROUTINE_NAME LIKE '" . $q->escape("{$table}_trigger_")  . "%'
 412                             AND
 413                             ROUTINE_TYPE = 'PROCEDURE'
 414
 415             ");
 416             while ($q->fetch()) {
 417                 $cache[$table][] = $q->SPECIFIC_NAME;
 418             }
 419
 420         }
 421         // now see which of the procedures match the specification..
 422         $ret = array();
 423         foreach($cache[$table] as $cname) {
 424             $bits = explode("_before_{$type}_", $cname);
 425             if (count($bits) < 2) {
 426                 continue;
 427             }
 428             $ret[$cname] = $bits[1];
 429         }
 430         return $ret;
 431     }
 432
 433
 434 }
 435