MDL-52035 enrol_lti: added backup/restore functionality

enrol/lti/backup/moodle2/backup_enrol_lti_plugin.class.php

@@ -0,0 +1,71 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Defines the backup_enrol_lti_plugin class.
+ *
+ * @package   enrol_lti
+ * @copyright 2016 Mark Nelson <[email protected]>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Define all the backup steps.
+ *
+ * @package   enrol_lti
+ * @copyright 2016 Mark Nelson <[email protected]>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class backup_enrol_lti_plugin extends backup_enrol_plugin {
+
+    /**
+     * Defines the other LTI enrolment structures to append.
+     *
+     * @return backup_plugin_element
+     */
+    public function define_enrol_plugin_structure() {
+        // Get the parent we will be adding these elements to.
+        $plugin = $this->get_plugin_element();
+
+        // Define our elements.
+        $tool = new backup_nested_element('tool', array('id'), array(
+            'enrolid', 'contextid', 'institution', 'lang', 'timezone', 'maxenrolled', 'maildisplay', 'city',
+            'country', 'gradesync', 'gradesynccompletion', 'membersync', 'membersyncmode',  'roleinstructor',
+            'rolelearner', 'secret', 'timecreated', 'timemodified'));
+
+        $users = new backup_nested_element('users');
+
+        $user = new backup_nested_element('user', array('id'), array(
+            'userid', 'toolid', 'serviceurl', 'sourceid', 'consumerkey', 'consumersecret', 'membershipurl',
+            'membershipsid'));
+
+        // Build elements hierarchy.
+        $plugin->add_child($tool);
+        $tool->add_child($users);
+        $users->add_child($user);
+
+        // Set sources to populate the data.
+        $tool->set_source_table('enrol_lti_tools',
+            array('enrolid' => backup::VAR_PARENTID));
+
+        // Users are only added only if users included.
+        if ($this->task->get_setting_value('users')) {
+            $user->set_source_table('enrol_lti_users', array('toolid' => backup::VAR_PARENTID));
+        }
+    }
+}

enrol/lti/backup/moodle2/restore_enrol_lti_plugin.class.php

@@ -0,0 +1,115 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Defines the restore_enrol_lti_plugin class.
+ *
+ * @package   enrol_lti
+ * @copyright 2016 Mark Nelson <[email protected]>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Define all the restore steps.
+ *
+ * @package   enrol_lti
+ * @copyright 2016 Mark Nelson <[email protected]>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class restore_enrol_lti_plugin extends restore_enrol_plugin {
+
+    /**
+     * @var array $tools Stores the IDs of the newly created tools.
+     */
+    protected $tools = array();
+
+    /**
+     * Declares the enrol LTI XML paths attached to the enrol element
+     *
+     * @return array of {@link restore_path_element}
+     */
+    protected function define_enrol_plugin_structure() {
+
+        $paths = array();
+        $paths[] = new restore_path_element('enrol_lti_tool', $this->connectionpoint->get_path() . '/tool');
+        $paths[] = new restore_path_element('enrol_lti_users', $this->connectionpoint->get_path() . '/tool/users/user');
+
+        return $paths;
+    }
+
+    /**
+     * Processes LTI tools element data
+     *
+     * @param array|stdClass $data
+     */
+    public function process_enrol_lti_tool($data) {
+        global $DB;
+
+        $data = (object) $data;
+
+        // Store the old id.
+        $oldid = $data->id;
+
+        // Change the values before we insert it.
+        $data->timecreated = time();
+        $data->timemodified = $data->timecreated;
+
+        // Now we can insert the new record.
+        $data->id = $DB->insert_record('enrol_lti_tools', $data);
+
+        // Add the array of tools we need to process later.
+        $this->tools[$data->id] = $data;
+
+        // Set up the mapping.
+        $this->set_mapping('enrol_lti_tool', $oldid, $data->id);
+    }
+
+    /**
+     * Processes LTI users element data
+     *
+     * @param array|stdClass $data The data to insert as a comment
+     */
+    public function process_enrol_lti_users($data) {
+        global $DB;
+
+        $data = (object) $data;
+
+        $data->userid = $this->get_mappingid('user', $data->userid);
+        $data->toolid = $this->get_mappingid('enrol_lti_tool', $data->toolid);
+        $data->timecreated = time();
+
+        $DB->insert_record('enrol_lti_users', $data);
+    }
+
+    /**
+     * This function is executed after all the tasks in the plan have been finished.
+     * This must be done here because the activities have not been restored yet.
+     */
+    public function after_restore_enrol() {
+        global $DB;
+
+        // Need to go through and change the values.
+        foreach ($this->tools as $tool) {
+            $updatetool = new stdClass();
+            $updatetool->id = $tool->id;
+            $updatetool->enrolid = $this->get_mappingid('enrol', $tool->enrolid);
+            $updatetool->contextid = $this->get_mappingid('context', $tool->contextid);
+            $DB->update_record('enrol_lti_tools', $updatetool);
+        }
+    }
+}

enrol/lti/lib.php

@@ -383,6 +383,21 @@ class enrol_lti_plugin extends enrol_plugin {
         }
         return $actions;
     }
+
+    /**
+     * Restore instance and map settings.
+     *
+     * @param restore_enrolments_structure_step $step
+     * @param stdClass $data
+     * @param stdClass $course
+     * @param int $oldid
+     */
+    public function restore_instance(restore_enrolments_structure_step $step, stdClass $data, $course, $oldid) {
+        // We want to call the parent because we do not want to add an enrol_lti_tools row
+        // as that is done as part of the restore process.
+        $instanceid = parent::add_instance($course, (array)$data);
+        $step->set_mapping('enrol', $oldid, $instanceid);
+    }
 }
 
 /**