MDL-26312 Workshop: data integrity check to detect eventual course_modules corruption
authorDavid Mudrak <david@moodle.com>
Fri, 11 Feb 2011 14:41:35 +0000 (15:41 +0100)
committerDavid Mudrak <david@moodle.com>
Mon, 14 Feb 2011 09:11:42 +0000 (10:11 +0100)
Because of a bug in Workshop upgrade code, multiple workshop course_modules can
potentially point to a single workshop instance. The chance is pretty low as in most cases,
the upgrade failed. But under certain circumstances, workshop could be upgraded with
this data integrity issue. We want to detect it now and let the admin know.

mod/workshop/db/upgrade.php
mod/workshop/version.php

index 13f02d8..34883cc 100644 (file)
@@ -264,5 +264,47 @@ function xmldb_workshop_upgrade($oldversion) {
         upgrade_mod_savepoint(true, 2010111200, 'workshop');
     }
 
+    /**
+     * Check the course_module integrity - see MDL-26312 for details
+     *
+     * Because of a bug in Workshop upgrade code, multiple workshop course_modules can
+     * potentially point to a single workshop instance. The chance is pretty low as in most cases,
+     * the upgrade failed. But under certain circumstances, workshop could be upgraded with
+     * this data integrity issue. We want to detect it now and let the admin know.
+     */
+    if ($oldversion < 2011021100) {
+        $sql = "SELECT cm.id, cm.course, cm.instance
+                  FROM {course_modules} cm
+                 WHERE cm.module IN (SELECT id
+                                       FROM {modules}
+                                      WHERE name = ?)";
+        $rs = $DB->get_recordset_sql($sql, array('workshop'));
+        $map = array(); // returned stdClasses by instance id
+        foreach ($rs as $cm) {
+            $map[$cm->instance][$cm->id] = $cm;
+        }
+        $rs->close();
+
+        $problems = array();
+        foreach ($map as $instanceid => $cms) {
+            if (count($cms) > 1) {
+                $problems[] = 'workshop instance ' . $instanceid . ' referenced by course_modules ' . implode(', ', array_keys($cms));
+            }
+        }
+        if ($problems) {
+            echo $OUTPUT->notification('¬°Ay, caramba! Data integrity corruption has been detected in your workshop ' . PHP_EOL .
+                'module database tables. This might be caused by a bug in workshop upgrade code. ' . PHP_EOL .
+                'Please report this issue immediately in workshop module support forum at ' . PHP_EOL .
+                'http://moodle.org so that we can help to fix this problem. Please copy and keep ' . PHP_EOL .
+                'following information for future reference:');
+            foreach ($problems as $problem) {
+                echo $OUTPUT->notification($problem);
+                upgrade_log(UPGRADE_LOG_NOTICE, 'mod_workshop', 'course_modules integrity problem', $problem);
+            }
+        }
+
+        upgrade_mod_savepoint(true, 2011021100, 'workshop');
+    }
+
     return true;
 }
index 9cc8d88..11348c1 100644 (file)
@@ -29,6 +29,6 @@
 
 defined('MOODLE_INTERNAL') || die();
 
-$module->version  = 2010111200;
-$module->requires = 2010111002;  // Requires this Moodle version
+$module->version  = 2011021100;
+$module->requires = 2011020900;  // Requires this Moodle version
 //$module->cron     = 60;