Merge branch 'w35_MDL-35064_m24_delenrol' of git://github.com/skodak/moodle
[moodle.git] / enrol / manual / locallib.php
index 1a3d580..d7b8f0c 100644 (file)
@@ -352,3 +352,101 @@ class enrol_manual_deleteselectedusers_operation extends enrol_bulk_enrolment_op
         return true;
     }
 }
+
+/**
+ * Migrates all enrolments of the given plugin to enrol_manual plugin,
+ * this is used for example during plugin uninstallation.
+ *
+ * NOTE: this function does not trigger role and enrolment related events.
+ *
+ * @param string $enrol  The enrolment method.
+ */
+function enrol_manual_migrate_plugin_enrolments($enrol) {
+    global $DB;
+
+    if ($enrol === 'manual') {
+        // We can not migrate to self.
+        return;
+    }
+
+    $manualplugin = enrol_get_plugin('manual');
+
+    $params = array('enrol'=>$enrol);
+    $sql = "SELECT e.id, e.courseid, e.status, MIN(me.id) AS mid, COUNT(ue.id) AS cu
+              FROM {enrol} e
+              JOIN {user_enrolments} ue ON (ue.enrolid = e.id)
+              JOIN {course} c ON (c.id = e.courseid)
+         LEFT JOIN {enrol} me ON (me.courseid = e.courseid AND me.enrol='manual')
+             WHERE e.enrol = :enrol
+          GROUP BY e.id, e.courseid, e.status
+          ORDER BY e.id";
+    $rs = $DB->get_recordset_sql($sql, $params);
+
+    foreach($rs as $e) {
+        $minstance = false;
+        if (!$e->mid) {
+            // Manual instance does not exist yet, add a new one.
+            $course = $DB->get_record('course', array('id'=>$e->courseid), '*', MUST_EXIST);
+            if ($minstance = $DB->get_record('enrol', array('courseid'=>$course->id, 'enrol'=>'manual'))) {
+                // Already created by previous iteration.
+                $e->mid = $minstance->id;
+            } else if ($e->mid = $manualplugin->add_default_instance($course)) {
+                $minstance = $DB->get_record('enrol', array('id'=>$e->mid));
+                if ($e->status != ENROL_INSTANCE_ENABLED) {
+                    $DB->set_field('enrol', 'status', ENROL_INSTANCE_DISABLED, array('id'=>$e->mid));
+                    $minstance->status = ENROL_INSTANCE_DISABLED;
+                }
+            }
+        } else {
+            $minstance = $DB->get_record('enrol', array('id'=>$e->mid));
+        }
+
+        if (!$minstance) {
+            // This should never happen unless adding of default instance fails unexpectedly.
+            continue;
+        }
+
+        // First delete potential role duplicates.
+        $params = array('id'=>$e->id, 'component'=>'enrol_'.$enrol, 'empty'=>$DB->sql_empty());
+        $sql = "SELECT ra.id
+                  FROM {role_assignments} ra
+                  JOIN {role_assignments} mra ON (mra.contextid = ra.contextid AND mra.userid = ra.userid AND mra.roleid = ra.roleid AND mra.component = :empty AND mra.itemid = 0)
+                 WHERE ra.component = :component AND ra.itemid = :id";
+        $ras = $DB->get_records_sql($sql, $params);
+        $ras = array_keys($ras);
+        $DB->delete_records_list('role_assignments', 'id', $ras);
+        unset($ras);
+
+        // Migrate roles.
+        $sql = "UPDATE {role_assignments}
+                   SET itemid = 0, component = :empty
+                 WHERE itemid = :id AND component = :component";
+        $params = array('empty'=>$DB->sql_empty(), 'id'=>$e->id, 'component'=>'enrol_'.$enrol);
+        $DB->execute($sql, $params);
+
+        // Delete potential enrol duplicates.
+        $params = array('id'=>$e->id, 'mid'=>$e->mid);
+        $sql = "SELECT ue.id
+                  FROM {user_enrolments} ue
+                  JOIN {user_enrolments} mue ON (mue.userid = ue.userid AND mue.enrolid = :mid)
+                 WHERE ue.enrolid = :id";
+        $ues = $DB->get_records_sql($sql, $params);
+        $ues = array_keys($ues);
+        $DB->delete_records_list('user_enrolments', 'id', $ues);
+        unset($ues);
+
+        // Migrate to manual enrol instance.
+        $params = array('id'=>$e->id, 'mid'=>$e->mid);
+        if ($e->status != ENROL_INSTANCE_ENABLED and $minstance->status == ENROL_INSTANCE_ENABLED) {
+            $status = ", status = :disabled";
+            $params['disabled'] = ENROL_USER_SUSPENDED;
+        } else {
+            $status = "";
+        }
+        $sql = "UPDATE {user_enrolments}
+                   SET enrolid = :mid $status
+                 WHERE enrolid = :id";
+        $DB->execute($sql, $params);
+    }
+    $rs->close();
+}