first commit

mod/survey/backup/moodle2/backup_survey_activity_task.class.php

@@ -0,0 +1,70 @@
+<?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 backup_survey_activity_task class
+ *
+ * @package     mod_survey
+ * @category    backup
+ * @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/survey/backup/moodle2/backup_survey_stepslib.php');
+
+/**
+ * Provides all the settings and steps to perform one complete backup of the activity
+ */
+class backup_survey_activity_task extends backup_activity_task {
+
+    /**
+     * No specific settings for this activity
+     */
+    protected function define_my_settings() {
+    }
+
+    /**
+     * Defines a backup step to store the instance data in the survey.xml file
+     */
+    protected function define_my_steps() {
+        $this->add_step(new backup_survey_activity_structure_step('survey_structure', 'survey.xml'));
+    }
+
+    /**
+     * Encodes URLs to the index.php and view.php scripts
+     *
+     * @param string $content some HTML text that eventually contains URLs to the activity instance scripts
+     * @return string the content with the URLs encoded
+     */
+    public static function encode_content_links($content) {
+        global $CFG;
+
+        $base = preg_quote($CFG->wwwroot,"/");
+
+        // Link to the list of surveys
+        $search="/(".$base."\/mod\/survey\/index.php\?id\=)([0-9]+)/";
+        $content= preg_replace($search, '$@SURVEYINDEX*$2@$', $content);
+
+        // Link to survey view by moduleid
+        $search="/(".$base."\/mod\/survey\/view.php\?id\=)([0-9]+)/";
+        $content= preg_replace($search, '$@SURVEYVIEWBYID*$2@$', $content);
+
+        return $content;
+    }
+}

mod/survey/backup/moodle2/backup_survey_stepslib.php

@@ -0,0 +1,79 @@
+<?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    mod_survey
+ * @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 backup steps that will be used by the backup_survey_activity_task
+ */
+
+/**
+ * Define the complete survey structure for backup, with file and id annotations
+ */
+class backup_survey_activity_structure_step extends backup_activity_structure_step {
+
+    protected function define_structure() {
+
+        // To know if we are including userinfo
+        $userinfo = $this->get_setting_value('userinfo');
+
+        // Define each element separated
+        $survey = new backup_nested_element('survey', array('id'), array(
+            'name', 'intro', 'introformat', 'template',
+            'questions', 'days', 'timecreated', 'timemodified', 'completionsubmit'));
+
+        $answers = new backup_nested_element('answers');
+
+        $answer = new backup_nested_element('answer', array('id'), array(
+            'userid', 'question', 'time', 'answer1',
+            'answer2'));
+
+        $analysis = new backup_nested_element('analysis');
+
+        $analys = new backup_nested_element('analys', array('id'), array(
+            'userid', 'notes'));
+
+        // Build the tree
+        $survey->add_child($answers);
+        $answers->add_child($answer);
+
+        $survey->add_child($analysis);
+        $analysis->add_child($analys);
+
+        // Define sources
+        $survey->set_source_table('survey', array('id' => backup::VAR_ACTIVITYID));
+
+        $answer->set_source_table('survey_answers', array('survey' => backup::VAR_PARENTID));
+
+        $analys->set_source_table('survey_analysis', array('survey' => backup::VAR_PARENTID));
+
+        // Define id annotations
+        $answer->annotate_ids('user', 'userid');
+        $analys->annotate_ids('user', 'userid');
+
+        // Define file annotations
+        $survey->annotate_files('mod_survey', 'intro', null); // This file area hasn't itemid
+
+        // Return the root element (survey), wrapped into standard activity structure
+        return $this->prepare_activity_structure($survey);
+    }
+}

mod/survey/backup/moodle2/restore_survey_activity_task.class.php

@@ -0,0 +1,114 @@
+<?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    mod_survey
+ * @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/survey/backup/moodle2/restore_survey_stepslib.php'); // Because it exists (must)
+
+/**
+ * survey restore task that provides all the settings and steps to perform one
+ * complete restore of the activity
+ */
+class restore_survey_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() {
+        // survey only has one structure step
+        $this->add_step(new restore_survey_activity_structure_step('survey_structure', 'survey.xml'));
+    }
+
+    /**
+     * Define the contents in the activity that must be
+     * processed by the link decoder
+     */
+    public static function define_decode_contents() {
+        $contents = array();
+
+        $contents[] = new restore_decode_content('survey', array('intro'), 'survey');
+
+        return $contents;
+    }
+
+    /**
+     * Define the decoding rules for links belonging
+     * to the activity to be executed by the link decoder
+     */
+    public static function define_decode_rules() {
+        $rules = array();
+
+        $rules[] = new restore_decode_rule('SURVEYVIEWBYID', '/mod/survey/view.php?id=$1', 'course_module');
+        $rules[] = new restore_decode_rule('SURVEYINDEX', '/mod/survey/index.php?id=$1', 'course');
+
+        return $rules;
+
+    }
+
+    /**
+     * Define the restore log rules that will be applied
+     * by the {@link restore_logs_processor} when restoring
+     * survey logs. It must return one array
+     * of {@link restore_log_rule} objects
+     */
+    public static function define_restore_log_rules() {
+        $rules = array();
+
+        $rules[] = new restore_log_rule('survey', 'add', 'view.php?id={course_module}', '{survey}');
+        $rules[] = new restore_log_rule('survey', 'update', 'view.php?id={course_module}', '{survey}');
+        $rules[] = new restore_log_rule('survey', 'view', 'view.php?id={course_module}', '{survey}');
+        $rules[] = new restore_log_rule('survey', 'download', 'download.php?id={course_module}&type=[type]&group=[group]', '{survey}');
+        $rules[] = new restore_log_rule('survey', 'view report', 'report.php?id={course_module}', '{survey}');
+        $rules[] = new restore_log_rule('survey', 'submit', 'view.php?id={course_module}', '{survey}');
+        $rules[] = new restore_log_rule('survey', 'view graph', 'view.php?id={course_module}', '{survey}');
+        $rules[] = new restore_log_rule('survey', 'view form', 'view.php?id={course_module}', '{survey}');
+
+        return $rules;
+    }
+
+    /**
+     * Define the restore log rules that will be applied
+     * by the {@link restore_logs_processor} when restoring
+     * course logs. It must return one array
+     * of {@link restore_log_rule} objects
+     *
+     * Note this rules are applied when restoring course logs
+     * by the restore final task, but are defined here at
+     * activity level. All them are rules not linked to any module instance (cmid = 0)
+     */
+    public static function define_restore_log_rules_for_course() {
+        $rules = array();
+
+        $rules[] = new restore_log_rule('survey', 'view all', 'index.php?id={course}', null);
+
+        return $rules;
+    }
+}

mod/survey/backup/moodle2/restore_survey_stepslib.php

@@ -0,0 +1,95 @@
+<?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    mod_survey
+ * @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_survey_activity_task
+ */
+
+/**
+ * Structure step to restore one survey activity
+ */
+class restore_survey_activity_structure_step extends restore_activity_structure_step {
+
+    protected function define_structure() {
+
+        $paths = array();
+        $userinfo = $this->get_setting_value('userinfo');
+
+        $paths[] = new restore_path_element('survey', '/activity/survey');
+        if ($userinfo) {
+            $paths[] = new restore_path_element('survey_answer', '/activity/survey/answers/answer');
+            $paths[] = new restore_path_element('survey_analys', '/activity/survey/analysis/analys');
+        }
+
+        // Return the paths wrapped into standard activity structure
+        return $this->prepare_activity_structure($paths);
+    }
+
+    protected function process_survey($data) {
+        global $DB;
+
+        $data = (object)$data;
+        $oldid = $data->id;
+        $data->course = $this->get_courseid();
+
+        // Any changes to the list of dates that needs to be rolled should be same during course restore and course reset.
+        // See MDL-9367.
+
+        // insert the survey record
+        $newitemid = $DB->insert_record('survey', $data);
+        // immediately after inserting "activity" record, call this
+        $this->apply_activity_instance($newitemid);
+    }
+
+    protected function process_survey_analys($data) {
+        global $DB;
+
+        $data = (object)$data;
+        $oldid = $data->id;
+        $data->survey = $this->get_new_parentid('survey');
+        $data->userid = $this->get_mappingid('user', $data->userid);
+
+        $newitemid = $DB->insert_record('survey_analysis', $data);
+        // No need to save this mapping as far as nothing depend on it
+        // (child paths, file areas nor links decoder)
+    }
+
+    protected function process_survey_answer($data) {
+        global $DB;
+
+        $data = (object)$data;
+        $oldid = $data->id;
+        $data->survey = $this->get_new_parentid('survey');
+        $data->userid = $this->get_mappingid('user', $data->userid);
+
+        $newitemid = $DB->insert_record('survey_answers', $data);
+        // No need to save this mapping as far as nothing depend on it
+        // (child paths, file areas nor links decoder)
+    }
+
+    protected function after_execute() {
+        // Add survey related files, no need to match by itemname (just internally handled context)
+        $this->add_related_files('mod_survey', 'intro', null);
+    }
+}