MDL-23479 backup - assignment revised & old code deleted (but restore…

… logs). Support for subpluggins added

mod/assignment/backup/moodle2/backup_assignment_activity_task.class.php

@@ -56,7 +56,7 @@ static public function encode_content_links($content) {
 
         // Link to the list of assignments
         $search="/(".$base."\/mod\/assignment\/index.php\?id\=)([0-9]+)/";
-        $content= preg_replace($search, '$@ASIGNMENTINDEX*$2@$', $content);
+        $content= preg_replace($search, '$@ASSIGNMENTINDEX*$2@$', $content);
 
         // Link to assignment view by moduleid
         $search="/(".$base."\/mod\/assignment\/view.php\?id\=)([0-9]+)/";

mod/assignment/backup/moodle2/backup_assignment_stepslib.php

@@ -79,6 +79,8 @@ protected function define_structure() {
         // Define file annotations
         $assignment->annotate_files('mod_assignment', 'intro', null); // This file area hasn't itemid
         $submission->annotate_files('mod_assignment', 'submission', 'id');
+        $submission->annotate_files('mod_assignment', 'online_submission', 'id'); // Until MDL-23683 gets decided/implemented
+        $submission->annotate_files('mod_assignment', 'response', 'id');
 
         // Return the root element (assignment), wrapped into standard activity structure
         return $this->prepare_activity_structure($assignment);

mod/assignment/backup/moodle2/restore_assignment_activity_task.class.php

@@ -0,0 +1,75 @@
+<?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/>.
+
+/**
+ * @package moodlecore
+ * @subpackage backup-moodle2
+ * @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+require_once($CFG->dirroot . '/mod/assignment/backup/moodle2/restore_assignment_stepslib.php'); // Because it exists (must)
+
+/**
+ * assignment restore task that provides all the settings and steps to perform one
+ * complete restore of the activity
+ */
+class restore_assignment_activity_task extends restore_activity_task {
+
+    /**
+     * Define (add) particular settings this activity can have
+     */
+    protected function define_my_settings() {
+        // No particular settings for this activity
+    }
+
+    /**
+     * Define (add) particular steps this activity can have
+     */
+    protected function define_my_steps() {
+        // Choice only has one structure step
+        $this->add_step(new restore_assignment_activity_structure_step('assignment_structure', 'assignment.xml'));
+    }
+
+    /**
+     * Define the contents in the activity that must be
+     * processed by the link decoder
+     */
+    static public function define_decode_contents() {
+        $contents = array();
+
+        $contents[] = new restore_decode_content('assignment', array('intro'), 'assignment');
+
+        return $contents;
+    }
+
+    /**
+     * Define the decoding rules for links belonging
+     * to the activity to be executed by the link decoder
+     */
+    static public function define_decode_rules() {
+        $rules = array();
+
+        $rules[] = new restore_decode_rule('ASSIGNMENTVIEWBYID', '/mod/assignment/view.php?id=$1', 'course_module');
+        $rules[] = new restore_decode_rule('ASSIGNMENTINDEX', '/mod/assignment/index.php?id=$1', 'course');
+
+        return $rules;
+
+    }
+}

mod/assignment/backup/moodle2/restore_assignment_stepslib.php

@@ -0,0 +1,103 @@
+<?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/>.
+
+/**
+ * @package moodlecore
+ * @subpackage backup-moodle2
+ * @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+/**
+ * Define all the restore steps that will be used by the restore_assignment_activity_task
+ */
+
+/**
+ * Structure step to restore one assignment activity
+ */
+class restore_assignment_activity_structure_step extends restore_activity_structure_step {
+
+    protected function define_structure() {
+
+        $paths = array();
+        $userinfo = $this->get_setting_value('userinfo');
+
+        $assignment = new restore_path_element('assignment', '/activity/assignment');
+        $paths[] = $assignment;
+
+        // Apply for 'assignment' subplugins optional paths at assignment level
+        $this->add_subplugin_structure('assignment', $assignment);
+
+        if ($userinfo) {
+            $submission = new restore_path_element('assignment_submission', '/activity/assignment/submissions/submission');
+            $paths[] = $submission;
+            // Apply for 'assignment' subplugins optional stuff at submission level
+            $this->add_subplugin_structure('assignment', $submission);
+        }
+
+        // Return the paths wrapped into standard activity structure
+        return $this->prepare_activity_structure($paths);
+    }
+
+    protected function process_assignment($data) {
+        global $DB;
+
+        $data = (object)$data;
+        $oldid = $data->id;
+        $data->course = $this->get_courseid();
+
+        $data->timedue = $this->apply_date_offset($data->timedue);
+        $data->timeavailable = $this->apply_date_offset($data->timeavailable);
+        $data->timemodified = $this->apply_date_offset($data->timemodified);
+
+        if ($data->grade < 0) { // scale found, get mapping
+            $data->grade = -($this->get_mappingid('scale', abs($data->grade)));
+        }
+
+        // insert the assignment record
+        $newitemid = $DB->insert_record('assignment', $data);
+        // inmediately after inserting "activity" record, call this
+        $this->apply_activity_instance($newitemid);
+    }
+
+    protected function process_assignment_submission($data) {
+        global $DB;
+
+        $data = (object)$data;
+        $oldid = $data->id;
+
+        $data->assignment = $this->get_new_parentid('assignment');
+        $data->timecreated = $this->apply_date_offset($data->timecreated);
+        $data->timemodified = $this->apply_date_offset($data->timemodified);
+        $data->timemarked = $this->apply_date_offset($data->timemarked);
+
+        $data->userid = $this->get_mappingid('user', $data->userid);
+        $data->teacher = $this->get_mappingid('user', $data->teacher);
+
+        $newitemid = $DB->insert_record('assignment_submissions', $data);
+        $this->set_mapping('assignment_submission', $oldid, $newitemid, true); // Going to have files
+    }
+
+    protected function after_execute() {
+        // Add assignment related files, no need to match by itemname (just internally handled context)
+        $this->add_related_files('mod_assignment', 'intro', null);
+        // Add assignment submission files, maching by assignment_submission itemname
+        $this->add_related_files('mod_assignment', 'submission', 'assignment_submission');
+        $this->add_related_files('mod_assignment', 'online_submission', 'assignment_submission'); // Until MDL-23683 gets decided/implemented
+        $this->add_related_files('mod_assignment', 'response', 'assignment_submission');
+    }
+}