From: mjollnir_ <mjollnir_>
Date: Thu, 19 Oct 2006 23:30:28 +0000 (+0000)
Subject: error reporting for xmldb (credit: Nigel McNie <nigel@catalyst.net.nz>)
X-Git-Url: http://git.mjollnir.org/gw?a=commitdiff_plain;h=722c3bfeded346b20af59ee4878922f1822a45de;p=moodle.git

error reporting for xmldb (credit: Nigel McNie <nigel@catalyst.net.nz>)
---

diff --git a/lib/ddllib.php b/lib/ddllib.php
index 70f4e097b7..9f76b37fc4 100644
--- a/lib/ddllib.php
+++ b/lib/ddllib.php
@@ -1155,4 +1155,8 @@ function change_db_encoding() {
     }
 }
 
+function xmldb_dbg($message) {
+    error_log($message);
+}
+
 ?>
diff --git a/lib/xmldb/classes/XMLDBField.class.php b/lib/xmldb/classes/XMLDBField.class.php
index 798973f1b5..9c19d76d35 100644
--- a/lib/xmldb/classes/XMLDBField.class.php
+++ b/lib/xmldb/classes/XMLDBField.class.php
@@ -252,6 +252,7 @@ class XMLDBField extends XMLDBObject {
             $this->name = trim($xmlarr['@']['NAME']);
         } else {
             $this->errormsg = 'Missing NAME attribute';
+            xmldb_dbg($this->errormsg);
             $result = false;
         }
 
@@ -262,10 +263,12 @@ class XMLDBField extends XMLDBObject {
                 $this->type = $type;
             } else {
                 $this->errormsg = 'Invalid TYPE attribute';
+                xmldb_dbg($this->errormsg);
                 $result = false;
             }
         } else {
             $this->errormsg = 'Missing TYPE attribute';
+            xmldb_dbg($this->errormsg);
             $result = false;
         }
 
@@ -277,9 +280,11 @@ class XMLDBField extends XMLDBObject {
                 $this->type == XMLDB_TYPE_CHAR) {
                 if (!(is_numeric($length)&&(intval($length)==floatval($length)))) {
                     $this->errormsg = 'Incorrect LENGTH attribute for int, number or char fields';
+                    xmldb_dbg($this->errormsg);
                     $result = false;
                 } else if (!$length) {
                     $this->errormsg = 'Zero LENGTH attribute';
+                    xmldb_dbg($this->errormsg);
                     $result = false;
                 }
             }
@@ -293,6 +298,7 @@ class XMLDBField extends XMLDBObject {
                     $length != 'medium' &&
                     $length != 'small') {
                     $this->errormsg = 'Incorrect LENGTH attribute for text and binary fields (only big, medium and small allowed)';
+                    xmldb_dbg($this->errormsg);
                     $result = false;
                 }
             }
@@ -308,6 +314,7 @@ class XMLDBField extends XMLDBObject {
                 $this->unsigned = false;
             } else {
                 $this->errormsg = 'Incorrect UNSIGNED attribute (true/false allowed)';
+                xmldb_dbg($this->errormsg);
                 $result = false;
             }
         }
@@ -320,6 +327,7 @@ class XMLDBField extends XMLDBObject {
                 $this->notnull = false;
             } else {
                 $this->errormsg = 'Incorrect NOTNULL attribute (true/false allowed)';
+                xmldb_dbg($this->errormsg);
                 $result = false;
             }
         }
@@ -332,6 +340,7 @@ class XMLDBField extends XMLDBObject {
                 $this->sequence = false;
             } else {
                 $this->errormsg = 'Incorrect SEQUENCE attribute (true/false allowed)';
+                xmldb_dbg($this->errormsg);
                 $result = false;
             }
         }
@@ -348,6 +357,7 @@ class XMLDBField extends XMLDBObject {
                 $this->enum = false;
             } else {
                 $this->errormsg = 'Incorrect ENUM attribute (true/false allowed)';
+                xmldb_dbg($this->errormsg);
                 $result = false;
             }
         }
@@ -356,6 +366,7 @@ class XMLDBField extends XMLDBObject {
             $enumvalues = strtolower(trim($xmlarr['@']['ENUMVALUES']));
             if (!$this->enum) {
                 $this->errormsg = 'Wrong ENUMVALUES attribute (not ENUM)';
+                xmldb_dbg($this->errormsg);
                 $result = false;
                 $this->enumvalues = $enumvalues;
             } else {
@@ -374,16 +385,19 @@ class XMLDBField extends XMLDBObject {
                         if (substr($enumelement, 0, 1) != "'" ||
                             substr($enumelement, -1, 1) != "'") {
                             $this->errormsg = 'Incorrect ENUMVALUES attribute (some value is not properly quoted)';
+                            xmldb_dbg($this->errormsg);
                             $result = false;
                         }
                     }
                 } else {
                     $this->errormsg = 'Incorrect ENUMVALUES attribute (comma separated of quoted values)';
+                    xmldb_dbg($this->errormsg);
                     $result = false;
                 }
             }
         } else if ($this->enum) {
             $this->errormsg = 'Incorrect ENUMVALUES attribute (field is not declared as ENUM)';
+            xmldb_dbg($this->errormsg);
             $result = false;
         }
     /// Finally, set the value
@@ -399,13 +413,16 @@ class XMLDBField extends XMLDBObject {
                 $this->type == XMLDB_TYPE_FLOAT) {
                 if (!(is_numeric($decimals)&&(intval($decimals)==floatval($decimals)))) {
                     $this->errormsg = 'Incorrect DECIMALS attribute for number field';
+                    xmldb_dbg($this->errormsg);
                     $result = false;
                 } else if ($this->length <= $decimals){
                     $this->errormsg = 'Incorrect DECIMALS attribute (bigget than length)';
+                    xmldb_dbg($this->errormsg);
                     $result = false;
                 }
             } else {
                 $this->errormsg = 'Incorrect DECIMALS attribute for non-number field';
+                xmldb_dbg($this->errormsg);
                 $result = false;
             }
         } else {
diff --git a/lib/xmldb/classes/XMLDBIndex.class.php b/lib/xmldb/classes/XMLDBIndex.class.php
index e8315176fe..680830c937 100644
--- a/lib/xmldb/classes/XMLDBIndex.class.php
+++ b/lib/xmldb/classes/XMLDBIndex.class.php
@@ -96,6 +96,7 @@ class XMLDBIndex extends XMLDBObject {
             $this->name = trim($xmlarr['@']['NAME']);
         } else {
             $this->errormsg = 'Missing NAME attribute';
+            xmldb_dbg($this->errormsg);
             $result = false;
         }
 
@@ -107,10 +108,12 @@ class XMLDBIndex extends XMLDBObject {
                 $this->unique = false;
             } else {
                 $this->errormsg = 'Incorrect UNIQUE attribute (true/false allowed)';
+                xmldb_dbg($this->errormsg);
                 $result = false;
             }
         } else {
                 $this->errormsg = 'Undefined UNIQUE attribute';
+                xmldb_dbg($this->errormsg);
                 $result = false;
         }
 
@@ -124,14 +127,17 @@ class XMLDBIndex extends XMLDBObject {
                     }
                 } else {
                     $this->errormsg = 'Incorrect FIELDS attribute (comma separated of fields)';
+                    xmldb_dbg($this->errormsg);
                     $result = false;
                 }
             } else {
                 $this->errormsg = 'Empty FIELDS attribute';
+                xmldb_dbg($this->errormsg);
                 $result = false;
             }
         } else {
             $this->errormsg = 'Missing FIELDS attribute';
+            xmldb_dbg($this->errormsg);
             $result = false;
         }
     /// Finally, set the array of fields
diff --git a/lib/xmldb/classes/XMLDBKey.class.php b/lib/xmldb/classes/XMLDBKey.class.php
index 61555431ad..be6d8b6b0a 100644
--- a/lib/xmldb/classes/XMLDBKey.class.php
+++ b/lib/xmldb/classes/XMLDBKey.class.php
@@ -133,6 +133,7 @@ class XMLDBKey extends XMLDBObject {
             $this->name = trim($xmlarr['@']['NAME']);
         } else {
             $this->errormsg = 'Missing NAME attribute';
+            xmldb_dbg($this->errormsg);
             $result = false;
         }
 
@@ -143,10 +144,12 @@ class XMLDBKey extends XMLDBObject {
                 $this->type = $type;
             } else {
                 $this->errormsg = 'Invalid TYPE attribute';
+                xmldb_dbg($this->errormsg);
                 $result = false;
             }
         } else {
             $this->errormsg = 'Missing TYPE attribute';
+            xmldb_dbg($this->errormsg);
             $result = false;
         }
 
@@ -160,14 +163,17 @@ class XMLDBKey extends XMLDBObject {
                     }
                 } else {
                     $this->errormsg = 'Incorrect FIELDS attribute (comma separated of fields)';
+                    xmldb_dbg($this->errormsg);
                     $result = false;
                 }
             } else {
                 $this->errormsg = 'Empty FIELDS attribute';
+                xmldb_dbg($this->errormsg);
                 $result = false;
             }
         } else {
             $this->errormsg = 'Missing FIELDS attribute';
+            xmldb_dbg($this->errormsg);
             $result = false;
         }
     /// Finally, set the array of fields
@@ -180,15 +186,18 @@ class XMLDBKey extends XMLDBObject {
                 $reftable = strtolower(trim($xmlarr['@']['REFTABLE']));
                 if (!$reftable) {
                     $this->errormsg = 'Empty REFTABLE attribute';
+                    xmldb_dbg($this->errormsg);
                     $result = false;
                 }
             } else {
                 $this->errormsg = 'Wrong REFTABLE attribute (only FK can have it)';
+                xmldb_dbg($this->errormsg);
                 $result = false;
             }
         } else if ($this->type == XMLDB_KEY_FOREIGN ||
                    $this->type == XMLDB_KEY_FOREIGN_UNIQUE) {
             $this->errormsg = 'Missing REFTABLE attribute';
+            xmldb_dbg($this->errormsg);
             $result = false;
         }
     /// Finally, set the reftable
@@ -210,19 +219,23 @@ class XMLDBKey extends XMLDBObject {
                         }
                     } else {
                         $this->errormsg = 'Incorrect REFFIELDS attribute (comma separated of fields)';
+                        xmldb_dbg($this->errormsg);
                         $result = false;
                     }
                 } else {
                     $this->errormsg = 'Empty REFFIELDS attribute';
+                    xmldb_dbg($this->errormsg);
                     $result = false;
                 }
             } else {
                 $this->errormsg = 'Wrong REFFIELDS attribute (only FK can have it)';
+                xmldb_dbg($this->errormsg);
                 $result = false;
             }
         } else if ($this->type == XMLDB_KEY_FOREIGN ||
                    $this->type == XMLDB_KEY_FOREIGN_UNIQUE) {
             $this->errormsg = 'Missing REFFIELDS attribute';
+            xmldb_dbg($this->errormsg);
             $result = false;
         }
     /// Finally, set the array of reffields
diff --git a/lib/xmldb/classes/XMLDBStatement.class.php b/lib/xmldb/classes/XMLDBStatement.class.php
index 0fa063ed37..b761b47b34 100644
--- a/lib/xmldb/classes/XMLDBStatement.class.php
+++ b/lib/xmldb/classes/XMLDBStatement.class.php
@@ -103,6 +103,7 @@ class XMLDBStatement extends XMLDBObject {
             $this->table = strtolower(trim($xmlarr['@']['TABLE']));
         } else {
             $this->errormsg = 'Missing TABLE attribute';
+            xmldb_dbg($this->errormsg);
             $result = false;
         }
 
@@ -113,10 +114,12 @@ class XMLDBStatement extends XMLDBObject {
                 $this->type = $type;
             } else {
                 $this->errormsg = 'Invalid TYPE attribute';
+                xmldb_dbg($this->errormsg);
                 $result = false;
             }
         } else {
             $this->errormsg = 'Missing TYPE attribute';
+            xmldb_dbg($this->errormsg);
             $result = false;
         }
 
@@ -131,6 +134,7 @@ class XMLDBStatement extends XMLDBObject {
                         $sentencesarr[] = trim($sentence['@']['TEXT']);
                     } else {
                         $this->errormsg = 'Missing TEXT attribute in sentence';
+                        xmldb_dbg($this->errormsg);
                         $result = false;
                     }
                 }
@@ -151,18 +155,22 @@ class XMLDBStatement extends XMLDBObject {
                 /// Check that we aren't inserting the id field
                     if (in_array('id', $fields)) {
                         $this->errormsg = 'Cannot insert the "id" field. It is an autonumeric column';
+                        xmldb_dbg($this->errormsg);
                         $result = false;
                     }
                     if ($result && count($fields) == 0) {
                         $this->errormsg = 'Missing fields in sentence "' . $sentence . '"';
+                        xmldb_dbg($this->errormsg);
                         $result = false;
                     }
                     if ($result && count($values) == 0) {
                         $this->errormsg = 'Missing values in sentence "' . $sentence . '"';
+                        xmldb_dbg($this->errormsg);
                         $result = false;
                     }
                     if ($result && count($fields) != count($values)) {
                         $this->errormsg = 'Incorrect number of fields (' .implode(', ', $fields) . ') or values (' . implode(', ', $values) . ')';
+                        xmldb_dbg($this->errormsg);
                         $result = false;
                     }
                 }
@@ -170,6 +178,7 @@ class XMLDBStatement extends XMLDBObject {
         } else {
         /// Sentences different from INSERT are not valid for now
             $this->errormsg = 'Only INSERT statements are supported';
+            xmldb_dbg($this->errormsg);
             $result = false;
         }
 
diff --git a/lib/xmldb/classes/XMLDBStructure.class.php b/lib/xmldb/classes/XMLDBStructure.class.php
index 3ccbf0d22f..57dc4b46cb 100644
--- a/lib/xmldb/classes/XMLDBStructure.class.php
+++ b/lib/xmldb/classes/XMLDBStructure.class.php
@@ -342,18 +342,21 @@ class XMLDBStructure extends XMLDBObject {
             $this->path = trim($xmlarr['XMLDB']['@']['PATH']);
         } else {
             $this->errormsg = 'Missing PATH attribute';
+            xmldb_dbg($this->errormsg);
             $result = false;
         }
         if (isset($xmlarr['XMLDB']['@']['VERSION'])) {
             $this->version = trim($xmlarr['XMLDB']['@']['VERSION']);
         } else {
             $this->errormsg = 'Missing VERSION attribute';
+            xmldb_dbg($this->errormsg);
             $result = false;
         }
         if (isset($xmlarr['XMLDB']['@']['COMMENT'])) {
             $this->comment = trim($xmlarr['XMLDB']['@']['COMMENT']);
         } else {
             $this->errormsg = 'Missing COMMENT attribute';
+            xmldb_dbg($this->errormsg);
             $result = false;
         }
 
@@ -369,11 +372,13 @@ class XMLDBStructure extends XMLDBObject {
                 $this->tables[] = $table;
                 if (!$table->isLoaded()) {
                     $this->errormsg = 'Problem loading table ' . $name;
+                    xmldb_dbg($this->errormsg);
                     $result = false;
                 }
             }
         } else {
             $this->errormsg = 'Missing TABLES section';
+            xmldb_dbg($this->errormsg);
             $result = false;
         }
 
@@ -382,16 +387,19 @@ class XMLDBStructure extends XMLDBObject {
         /// Check tables names are ok (lowercase, a-z _-)
             if (!$this->checkNameValues($this->tables)) {
                 $this->errormsg = 'Some TABLES name values are incorrect';
+                xmldb_dbg($this->errormsg);
                 $result = false;
             }
         /// Check previous & next are ok (duplicates and existing tables)
             if ($result && !$this->checkPreviousNextValues($this->tables)) {
                 $this->errormsg = 'Some TABLES previous/next values are incorrect';
+                xmldb_dbg($this->errormsg);
                 $result = false;
             }
         /// Order tables
             if ($result && !$this->orderTables($this->tables)) {
                 $this->errormsg = 'Error ordering the tables';
+                xmldb_dbg($this->errormsg);
                 $result = false;
             }
         }
@@ -408,6 +416,7 @@ class XMLDBStructure extends XMLDBObject {
                 $this->statements[] = $statement;
                 if (!$statement->isLoaded()) {
                     $this->errormsg = 'Problem loading statement ' . $name;
+                    xmldb_dbg($this->errormsg);
                     $result = false;
                 }
             }
@@ -418,16 +427,19 @@ class XMLDBStructure extends XMLDBObject {
         /// Check statements names are ok (lowercase, a-z _-)
             if (!$this->checkNameValues($this->statements)) {
                 $this->errormsg = 'Some STATEMENTS name values are incorrect';
+                xmldb_dbg($this->errormsg);
                 $result = false;
             }
         /// Check previous & next are ok (duplicates and existing statements)
             if ($result && !$this->checkPreviousNextValues($this->statements)) {
                 $this->errormsg = 'Some STATEMENTS previous/next values are incorrect';
+                xmldb_dbg($this->errormsg);
                 $result = false;
             }
         /// Order statements
             if ($result && !$this->orderStatements($this->statements)) {
                 $this->errormsg = 'Error ordering the statements';
+                xmldb_dbg($this->errormsg);
                 $result = false;
             }
         }
diff --git a/lib/xmldb/classes/XMLDBTable.class.php b/lib/xmldb/classes/XMLDBTable.class.php
index 943564f468..c2c353b5a3 100644
--- a/lib/xmldb/classes/XMLDBTable.class.php
+++ b/lib/xmldb/classes/XMLDBTable.class.php
@@ -444,12 +444,14 @@ class XMLDBTable extends XMLDBObject {
             $this->name = trim($xmlarr['@']['NAME']);
         } else {
             $this->errormsg = 'Missing NAME attribute';
+            xmldb_dbg($this->errormsg);
             $result = false;
         }
         if (isset($xmlarr['@']['COMMENT'])) {
             $this->comment = trim($xmlarr['@']['COMMENT']);
         } else {
             $this->errormsg = 'Missing COMMENT attribute';
+            xmldb_dbg($this->errormsg);
             $result = false;
         }
         if (isset($xmlarr['@']['PREVIOUS'])) {
@@ -471,11 +473,13 @@ class XMLDBTable extends XMLDBObject {
                 $this->fields[] = $field;
                 if (!$field->isLoaded()) {
                     $this->errormsg = 'Problem loading field ' . $name;
+                    xmldb_dbg($this->errormsg);
                     $result = false;
                 }
             }
         } else {
             $this->errormsg = 'Missing FIELDS section';
+            xmldb_dbg($this->errormsg);
             $result = false;
         }
 
@@ -484,16 +488,19 @@ class XMLDBTable extends XMLDBObject {
         /// Check field names are ok (lowercase, a-z _-)
             if (!$this->checkNameValues($this->fields)) {
                 $this->errormsg = 'Some FIELDS name values are incorrect';
+                xmldb_dbg($this->errormsg);
                 $result = false;
             }
         /// Check previous & next are ok (duplicates and existing fields)
             if ($result && !$this->checkPreviousNextValues($this->fields)) {
                 $this->errormsg = 'Some FIELDS previous/next values are incorrect';
+                xmldb_dbg($this->errormsg);
                 $result = false;
             }
         /// Order fields
             if ($result && !$this->orderFields($this->fields)) {
                 $this->errormsg = 'Error ordering the fields';
+                xmldb_dbg($this->errormsg);
                 $result = false;
             }
         }
@@ -510,11 +517,13 @@ class XMLDBTable extends XMLDBObject {
                 $this->keys[] = $key;
                 if (!$key->isLoaded()) {
                     $this->errormsg = 'Problem loading key ' . $name;
+                    xmldb_dbg($this->errormsg);
                     $result = false;
                 }
             }
         } else {
             $this->errormsg = 'Missing KEYS section (at least one PK must exist)';
+            xmldb_dbg($this->errormsg);
             $result = false;
         }
 
@@ -523,16 +532,19 @@ class XMLDBTable extends XMLDBObject {
         /// Check keys names are ok (lowercase, a-z _-)
             if (!$this->checkNameValues($this->keys)) {
                 $this->errormsg = 'Some KEYS name values are incorrect';
+                xmldb_dbg($this->errormsg);
                 $result = false;
             }
         /// Check previous & next are ok (duplicates and existing keys)
             if ($result && !$this->checkPreviousNextValues($this->keys)) {
                 $this->errormsg = 'Some KEYS previous/next values are incorrect';
+                xmldb_dbg($this->errormsg);
                 $result = false;
             }
         /// Order keys
             if ($result && !$this->orderKeys($this->keys)) {
                 $this->errormsg = 'Error ordering the keys';
+                xmldb_dbg($this->errormsg);
                 $result = false;
             }
         /// TODO: Only one PK
@@ -552,6 +564,7 @@ class XMLDBTable extends XMLDBObject {
                 $this->indexes[] = $index;
                 if (!$index->isLoaded()) {
                     $this->errormsg = 'Problem loading index ' . $name;
+                    xmldb_dbg($this->errormsg);
                     $result = false;
                 }
             }
@@ -562,16 +575,19 @@ class XMLDBTable extends XMLDBObject {
         /// Check field names are ok (lowercase, a-z _-)
             if (!$this->checkNameValues($this->indexes)) {
                 $this->errormsg = 'Some INDEXES name values are incorrect';
+                xmldb_dbg($this->errormsg);
                 $result = false;
             }
         /// Check previous & next are ok (duplicates and existing INDEXES)
             if ($result && !$this->checkPreviousNextValues($this->indexes)) {
                 $this->errormsg = 'Some INDEXES previous/next values are incorrect';
+                xmldb_dbg($this->errormsg);
                 $result = false;
             }
         /// Order indexes
             if ($result && !$this->orderIndexes($this->indexes)) {
                 $this->errormsg = 'Error ordering the indexes';
+                xmldb_dbg($this->errormsg);
                 $result = false;
             }
         /// TODO: Not indexes with repeated fields