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\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         $revmap = array();
 146         foreach($this->links as $tbl => $map) {
 147             if (!isset($this->schema[$tbl])) {
 148                 continue;
 149             }
 150             foreach($map as $k =>$v) {
 151                 list ($tname, $tcol) = explode(':', $v);
 152
 153
 154                 if (!isset($revmap[$tname])) {
 155                     $revmap[$tname] = array();
 156                 }
 157                 $revmap[$tname]["$tbl:$k"] = "$tname:$tcol";
 158             }
 159         }
 160
 161
 162         foreach($revmap as $target_table => $sources) {
 163
 164
 165             // throw example.. UPDATE `Error: invalid_id_test` SET x=1;
 166
 167             $q = DB_DataObject::factory('core_enum');
 168             $q->query("
 169                 DROP TRIGGER IF EXISTS `{$target_table}_before_delete` ;
 170             ");
 171
 172             $trigger = "
 173
 174             CREATE TRIGGER `{$target_table}_before_delete`
 175                 BEFORE DELETE ON `{$target_table}`
 176             FOR EACH ROW
 177             BEGIN
 178                DECLARE mid INT(11);
 179
 180
 181             ";
 182             foreach($sources as $source=>$target) {
 183                 list($source_table , $source_col) = explode(':', $source);
 184                 list($target_table , $target_col) = explode(':', $target);
 185                 $err = substr("Failed Delete {$target_table} refs {$source_table}:{$source_col}", 0, 64);
 186                 $trigger .="
 187                     SET mid = 0;
 188                     SELECT count(*) into mid FROM {$source_table} WHERE {$source_col} = OLD.{$target_col};
 189                     IF mid > 0 THEN
 190
 191                        UPDATE `$err` SET x = 1;
 192
 193                     END IF;
 194                 ";
 195             }
 196
 197             $ar = $this->listTriggerFunctions($tbl, 'delete');
 198             foreach($ar as $fn=>$col) {
 199                 $trigger .= "
 200                     CALL $fn( OLD.{$col});
 201                 ";
 202             }
 203
 204             $trigger .= "
 205             END
 206
 207             ";
 208
 209             //DB_DAtaObject::debugLevel(1);
 210             $q = DB_DataObject::factory('core_enum');
 211             $q->query($trigger);
 212
 213         }
 214
 215
 216         // inserting - row should not point to a reference that does not exist...
 217
 218
 219
 220
 221     }
 222     function createInsertTriggers()
 223     {
 224         foreach($this->links as $tbl => $map) {
 225             if (!isset($this->schema[$tbl])) {
 226                 continue;
 227             }
 228
 229             $q = DB_DataObject::factory('core_enum');
 230             $q->query("
 231                 DROP TRIGGER IF EXISTS `{$tbl}_before_insert` ;
 232             ");
 233
 234             $trigger = "
 235
 236             CREATE TRIGGER `{$tbl}_before_insert`
 237                 BEFORE INSERT ON `{$tbl}`
 238             FOR EACH ROW
 239             BEGIN
 240                DECLARE mid INT(11);
 241
 242
 243             ";
 244             foreach($map as $source_col=>$target) {
 245                 // check that source_col exists in schema.
 246                 if (!isset($this->schema[$tbl][$source_col])) {
 247                     continue;
 248                 }
 249
 250
 251                 $source_tbl = $tbl;
 252                 list($target_table , $target_col) = explode(':', $target);
 253                 $err = substr("Fail: INSERT referenced {$tbl}:{$source_col}", 0, 64);
 254                 $trigger .="
 255                     SET mid = 0;
 256                     if NEW.{$source_col} > 0 THEN
 257                         SELECT {$target_col} into mid FROM {$target_table} WHERE {$target_col} = NEW.{$source_col};
 258                         IF mid < 1 THEN
 259                             UPDATE `$err` SET x = 1;
 260                         END IF;
 261
 262                     END IF;
 263                 ";
 264
 265
 266
 267             }
 268             $ar = $this->listTriggerFunctions($tbl, 'insert');
 269             foreach($ar as $fn=>$col) {
 270                 $trigger .= "
 271                     CALL $fn( NEW.{$col});
 272                 ";
 273             }
 274
 275             $trigger .= "
 276             END
 277
 278             ";
 279             //echo $trigger; exit;
 280             //DB_DAtaObject::debugLevel(1);
 281             $q = DB_DataObject::factory('core_enum');
 282             $q->query($trigger);
 283
 284
 285
 286
 287
 288
 289
 290
 291         }
 292
 293
 294
 295     }
 296      function createUpdateTriggers()
 297     {
 298         foreach($this->links as $tbl => $map) {
 299             if (!isset($this->schema[$tbl])) {
 300                 continue;
 301             }
 302
 303             $q = DB_DataObject::factory('core_enum');
 304             $q->query("
 305                 DROP TRIGGER IF EXISTS `{$tbl}_before_update` ;
 306             ");
 307
 308             $trigger = "
 309
 310             CREATE TRIGGER `{$tbl}_before_update`
 311                 BEFORE UPDATE ON `{$tbl}`
 312             FOR EACH ROW
 313             BEGIN
 314                DECLARE mid INT(11);
 315
 316
 317             ";
 318             foreach($map as $source_col=>$target) {
 319                 // check that source_col exists in schema.
 320                 if (!isset($this->schema[$tbl][$source_col])) {
 321                     continue;
 322                 }
 323
 324
 325                 $source_tbl = $tbl;
 326                 list($target_table , $target_col) = explode(':', $target);
 327                 $err = substr("Fail: UPDATE referenced {$tbl}:$source_col", 0, 64);
 328                 $trigger .="
 329                     SET mid = 0;
 330                     if NEW.{$source_col} > 0 THEN
 331                         SELECT {$target_col} into mid FROM {$target_table} WHERE {$target_col} = NEW.{$source_col};
 332                         IF mid < 1 THEN
 333                             UPDATE `$err` SET x = 1;
 334                         END IF;
 335
 336                     END IF;
 337                 ";
 338             }
 339             $ar = $this->listTriggerFunctions($tbl, 'update');
 340             foreach($ar as $fn=>$col) {
 341                 $trigger .= "
 342                     CALL $fn(OLD.{$col}, NEW.{$col});
 343                 ";
 344             }
 345
 346             $trigger .= "
 347             END
 348
 349             ";
 350             //echo $trigger; exit;
 351             //DB_DAtaObject::debugLevel(1);
 352             $q = DB_DataObject::factory('core_enum');
 353             $q->query($trigger);
 354
 355
 356
 357
 358
 359
 360
 361
 362         }
 363
 364
 365
 366     }
 367     /**
 368      * check the information schema for any methods that match the trigger criteria.
 369      *   -- {tablename}_trigger_{optional_string}_before_delete_{column_name}(NEW.column)
 370      *   -- {tablename}_trigger_{optional_string}_before_update_{column_name}(OLD.column, NEW.column}
 371      *   -- {tablename}_trigger_{optional_string}_before_insert_{column_name}(OLD.column}
 372      *
 373      *
 374      */
 375     // type = update/insert/delete
 376
 377     function listTriggerFunctions($table, $type)
 378     {
 379         static $cache = array();
 380         if (!isset($cache[$table])) {
 381             $cache[$table] = array();
 382             $q = DB_DAtaObject::factory('core_enum');
 383             $q->query("SELECT
 384                             SPECIFIC_NAME
 385                         FROM
 386                             information_schema.ROUTINES
 387                         WHERE
 388                             ROUTINE_SCHEMA = '{$q->escape($q->database())}'
 389                             AND
 390                             ROUTINE_NAME LIKE '" . $q->escape("{$table}_trigger_")  . "%'
 391                             AND
 392                             ROUTINE_TYPE = 'CALL'
 393
 394             ");
 395             while ($q->fetch()) {
 396                 $cache[$table] = $q->SPECIFIC_NAME;
 397             }
 398             if ($table == 'core_notify_recur') {
 399                 print_r($cache[$table]);
 400             }
 401         }
 402         // now see which of the procedures match the specification..
 403         $ret = array();
 404         foreach($cache[$table] as $cname) {
 405             $bits = explode("_before_{$type}_", $cname);
 406             if (count($bits) < 2) {
 407                 continue;
 408             }
 409             $ret[$cname] = $bits[1];
 410         }
 411         return $ret;
 412     }
 413
 414
 415 }
 416