3 * our standard code relies on links.ini files for the relationships in mysql.
5 * as we use 'loose' relationships - eg. we allow '0' as a missing link mysql FORIEGN KEYS do not really work.
7 * There are a couple of ideas behind this code.
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.
13 * b) generate triggers? to protect against updates to the database..
15 * -- stored procedures are named
16 * {tablename}_before_{insert|delete|update}
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}
27 * ------- Importing with triggers disabled.
29 * SET @DISABLE_TRIGGER=1; (or anything you like except NULL)
31 * SET @DISABLE_TRIGGER=NULL;
33 * ------ Call a method disabling a particular set of triggers
34 * SET @DISABLE_TRIGGER_the_table_name=1; (or anything you like except NULL)
36 * SET @DISABLE_TRIGGER_the_table_name=NULL;*
39 class Pman_Core_UpdateDatabase_MysqlLinks {
45 function __construct()
48 $this->loadIniFiles();
49 $this->updateTableComments();
51 $ff = HTML_FlexyFramework::get();
52 if (empty($ff->Pman['enable_trigger_tests'])) {
55 if (!empty($ff->page->opts['disable-create-triggers'])) {
59 // note we may want to override some of these... - to do special triggers..
60 // as you can only have one trigger per table for each action.
62 $this->createDeleteTriggers();
63 $this->createInsertTriggers();
64 $this->createUpdateTriggers();
70 function loadIniFiles()
72 // will create the combined ini cache file for the running user.
74 $ff = HTML_FlexyFramework::get();
75 $ff->generateDataobjectsCache(true);
76 $this->dburl = parse_url($ff->database);
78 $dbini = 'ini_'. basename($this->dburl['path']);
81 $iniCache = isset( $ff->PDO_DataObject) ? $ff->PDO_DataObject['schema_location'] : $ff->DB_DataObject[$dbini];
83 if (strpos($iniCache, PATH_SEPARATOR) !== false) {
84 echo "SKIP links code - cached ini file has not been created\n";
87 $this->schema = parse_ini_file($iniCache, true);
88 $this->links = parse_ini_file(preg_replace('/\.ini$/', '.links.ini', $iniCache), true);
90 $lcfg = &$this->links;
91 $cfg = empty($ff->DB_DataObject) ? array() : $ff->DB_DataObject;
93 if (!empty($cfg['table_alias'])) {
94 $ta = $cfg['table_alias'];
95 foreach($lcfg as $k=>$v) {
99 if (!isset($lcfg[$kk])) {
100 $lcfg[$kk] = array();
103 foreach($v as $l => $t_c) {
104 $bits = explode(':',$t_c);
105 $tt = isset($ta[$bits[0]]) ? $ta[$bits[0]] : $bits[0];
106 if ($tt == $bits[0] && $kk == $k) {
110 $lcfg[$kk][$l] = $tt .':'. $bits[1];
120 function updateTableComments()
122 foreach($this->links as $tbl =>$map) {
123 $this->updateTableComment($tbl, $map);
130 function updateTableComment($tbl, $map)
134 if (!isset($this->schema[$tbl])) {
135 echo "Skip $tbl = table does not exist in schema\n";
140 $q = DB_DAtaObject::factory('core_enum');
144 information_schema.TABLES
146 TABLE_SCHEMA = DATABASE()
148 TABLE_NAME = '{$q->escape($tbl)}'
151 $tc = $q->TABLE_COMMENT;
152 //echo "$tbl: $tc\n\n";
153 if (!empty($q->TABLE_COMMENT)) {
155 $tc = trim(preg_replace('/FK\([^)]+\)/', '' , $q->TABLE_COMMENT));
156 //var_dump($tc);exit;
157 // strip out the old FC(....)
161 foreach($map as $k=>$v) {
164 $fkstr = $tc . ' FK(' . implode("\n", $fks) .')';
165 if ($q->TABLE_COMMENT == $fkstr) {
169 $q = DB_DAtaObject::factory('core_enum');
170 $q->query("ALTER TABLE `$tbl` COMMENT = '{$q->escape($fkstr)}'");
176 function createDeleteTriggers()
179 // this should only be enabled if the project settings are configured..
183 // delete triggers on targets -
184 // if you delete a company, and a person points to it, then it should fire an error...
189 // create a list of source/targets from $this->links
193 foreach($this->links as $tbl => $map) {
194 if (!isset($this->schema[$tbl])) {
197 foreach($map as $k =>$v) {
198 list ($tname, $tcol) = explode(':', $v);
201 if (!isset($revmap[$tname])) {
202 $revmap[$tname] = array();
204 $revmap[$tname]["$tbl:$k"] = "$tname:$tcol";
211 foreach($revmap as $target_table => $sources) {
214 // throw example.. UPDATE `Error: invalid_id_test` SET x=1;
216 if (!isset($this->schema[$target_table])) {
217 echo "Skip $target_table = table does not exist in schema\n";
223 $q = DB_DataObject::factory('core_enum');
225 DROP TRIGGER IF EXISTS `{$target_table}_before_delete` ;
230 CREATE TRIGGER `{$target_table}_before_delete`
231 BEFORE DELETE ON `{$target_table}`
235 IF (@DISABLE_TRIGGER IS NULL AND @DISABLE_TRIGGER_{$target_table} IS NULL ) THEN
238 foreach($sources as $source=>$target) {
239 list($source_table , $source_col) = explode(':', $source);
240 list($target_table , $target_col) = explode(':', $target);
241 $err = substr("Failed Delete {$target_table} refs {$source_table}:{$source_col}", 0, 64);
244 IF OLD.{$target_col} > 0 THEN
245 SELECT count(*) into mid FROM {$source_table} WHERE {$source_col} = OLD.{$target_col} LIMIT 1;
247 UPDATE `$err` SET x = 1;
253 $ar = $this->listTriggerFunctions($tbl, 'delete');
254 foreach($ar as $fn=>$col) {
256 CALL $fn( OLD.{$col});
266 //DB_DAtaObject::debugLevel(1);
267 $q = DB_DataObject::factory('core_enum');
269 echo "CREATED TRIGGER {$target_table}_before_delete\n";
273 // inserting - row should not point to a reference that does not exist...
279 function createInsertTriggers()
281 foreach($this->links as $tbl => $map) {
282 if (!isset($this->schema[$tbl])) {
286 $q = DB_DataObject::factory('core_enum');
288 DROP TRIGGER IF EXISTS `{$tbl}_before_insert` ;
293 CREATE TRIGGER `{$tbl}_before_insert`
294 BEFORE INSERT ON `{$tbl}`
298 IF (@DISABLE_TRIGGER IS NULL AND @DISABLE_TRIGGER_{$tbl} IS NULL ) THEN
303 foreach($map as $source_col=>$target) {
304 // check that source_col exists in schema.
305 if (!isset($this->schema[$tbl][$source_col])) {
306 $errs[] = "SOURCE MISSING: $source_col => $target";
312 list($target_table , $target_col) = explode(':', $target);
314 if (!isset($this->schema[$target_table])) {
315 // skip... target table does not exist
316 $errs[] = "TARGET MISSING: $source_col => $target";
321 $err = substr("Fail: INSERT referenced {$tbl}:{$source_col}", 0, 64);
324 if NEW.{$source_col} > 0 THEN
325 SELECT {$target_col} into mid FROM {$target_table} WHERE {$target_col} = NEW.{$source_col} LIMIT 1;
327 UPDATE `$err` SET x = 1;
337 $ar = $this->listTriggerFunctions($tbl, 'insert');
338 foreach($ar as $fn=>$col) {
340 CALL $fn( NEW.{$col});
352 echo "SKIP TRIGGER {$tbl}_before_insert (missing " . implode(", ", $errs) . ")\n";
355 //echo $trigger; exit;
356 //DB_DAtaObject::debugLevel(1);
357 $q = DB_DataObject::factory('core_enum');
359 echo "CREATED TRIGGER {$tbl}_before_insert\n";
372 function createUpdateTriggers()
374 foreach($this->links as $tbl => $map) {
375 if (!isset($this->schema[$tbl])) {
379 $q = DB_DataObject::factory('core_enum');
381 DROP TRIGGER IF EXISTS `{$tbl}_before_update` ;
386 CREATE TRIGGER `{$tbl}_before_update`
387 BEFORE UPDATE ON `{$tbl}`
391 IF (@DISABLE_TRIGGER IS NULL AND @DISABLE_TRIGGER_{$tbl} IS NULL ) THEN
396 foreach($map as $source_col=>$target) {
397 // check that source_col exists in schema.
398 if (!isset($this->schema[$tbl][$source_col])) {
399 $errs[] = "SOURCE MISSING: $source_col => $target";
405 list($target_table , $target_col) = explode(':', $target);
407 if (!isset($this->schema[$target_table])) {
408 // skip... target table does not exist
409 $errs[] = "TARGET MISSING: $source_col => $target";
413 $err = substr("Fail: UPDATE referenced {$tbl}:$source_col", 0, 64);
416 if NEW.{$source_col} > 0 THEN
417 SELECT {$target_col} into mid FROM {$target_table} WHERE {$target_col} = NEW.{$source_col} LIMIT 1;
419 UPDATE `$err` SET x = 1;
426 $ar = $this->listTriggerFunctions($tbl, 'update');
427 foreach($ar as $fn=>$col) {
429 CALL $fn(OLD.{$col}, NEW.{$col});
440 echo "SKIP TRIGGER {$tbl}_before_update (missing " . implode(", ", $errs) . ")\n";
444 //echo $trigger; exit;
445 //DB_DAtaObject::debugLevel(1);
446 $q = DB_DataObject::factory('core_enum');
448 echo "CREATED TRIGGER {$tbl}_before_update\n";
457 * check the information schema for any methods that match the trigger criteria.
458 * -- {tablename}_trigger_{optional_string}_before_delete_{column_name}(NEW.column)
459 * -- {tablename}_trigger_{optional_string}_before_update_{column_name}(OLD.column, NEW.column}
460 * -- {tablename}_trigger_{optional_string}_before_insert_{column_name}(OLD.column}
464 // type = update/insert/delete
466 function listTriggerFunctions($table, $type)
468 static $cache = array();
469 if (!isset($cache[$table])) {
470 $cache[$table] = array();
471 $q = DB_DAtaObject::factory('core_enum');
475 information_schema.ROUTINES
477 ROUTINE_SCHEMA = '{$q->escape($q->database())}'
479 ROUTINE_NAME LIKE '" . $q->escape("{$table}_trigger_") . "%'
481 ROUTINE_TYPE = 'PROCEDURE'
484 while ($q->fetch()) {
485 $cache[$table][] = $q->SPECIFIC_NAME;
489 // now see which of the procedures match the specification..
491 foreach($cache[$table] as $cname) {
492 $bits = explode("_before_{$type}_", $cname);
493 if (count($bits) < 2) {
496 $ret[$cname] = $bits[1];