first commit

mod/choice/backup/moodle1/lib.php

@@ -0,0 +1,151 @@
+<?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/>.
+
+/**
+ * Provides support for the conversion of moodle1 backup to the moodle2 format
+ *
+ * @package    mod_choice
+ * @copyright  2011 David Mudrak <david@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Choice conversion handler
+ */
+class moodle1_mod_choice_handler extends moodle1_mod_handler {
+
+    /** @var moodle1_file_manager */
+    protected $fileman = null;
+
+    /** @var int cmid */
+    protected $moduleid = null;
+
+    /**
+     * Declare the paths in moodle.xml we are able to convert
+     *
+     * The method returns list of {@link convert_path} instances.
+     * For each path returned, the corresponding conversion method must be
+     * defined.
+     *
+     * Note that the path /MOODLE_BACKUP/COURSE/MODULES/MOD/CHOICE does not
+     * actually exist in the file. The last element with the module name was
+     * appended by the moodle1_converter class.
+     *
+     * @return array of {@link convert_path} instances
+     */
+    public function get_paths() {
+        return array(
+            new convert_path(
+                'choice', '/MOODLE_BACKUP/COURSE/MODULES/MOD/CHOICE',
+                array(
+                    'renamefields' => array(
+                        'text' => 'intro',
+                        'format' => 'introformat',
+                    ),
+                    'newfields' => array(
+                        'completionsubmit' => 0,
+                    ),
+                    'dropfields' => array(
+                        'modtype'
+                    ),
+                )
+            ),
+            new convert_path('choice_options', '/MOODLE_BACKUP/COURSE/MODULES/MOD/CHOICE/OPTIONS'),
+            new convert_path('choice_option', '/MOODLE_BACKUP/COURSE/MODULES/MOD/CHOICE/OPTIONS/OPTION'),
+        );
+    }
+
+    /**
+     * This is executed every time we have one /MOODLE_BACKUP/COURSE/MODULES/MOD/CHOICE
+     * data available
+     */
+    public function process_choice($data) {
+
+        // get the course module id and context id
+        $instanceid     = $data['id'];
+        $cminfo         = $this->get_cminfo($instanceid);
+        $this->moduleid = $cminfo['id'];
+        $contextid      = $this->converter->get_contextid(CONTEXT_MODULE, $this->moduleid);
+
+        // get a fresh new file manager for this instance
+        $this->fileman = $this->converter->get_file_manager($contextid, 'mod_choice');
+
+        // convert course files embedded into the intro
+        $this->fileman->filearea = 'intro';
+        $this->fileman->itemid   = 0;
+        $data['intro'] = moodle1_converter::migrate_referenced_files($data['intro'], $this->fileman);
+
+        // start writing choice.xml
+        $this->open_xml_writer("activities/choice_{$this->moduleid}/choice.xml");
+        $this->xmlwriter->begin_tag('activity', array('id' => $instanceid, 'moduleid' => $this->moduleid,
+            'modulename' => 'choice', 'contextid' => $contextid));
+        $this->xmlwriter->begin_tag('choice', array('id' => $instanceid));
+
+        foreach ($data as $field => $value) {
+            if ($field <> 'id') {
+                $this->xmlwriter->full_tag($field, $value);
+            }
+        }
+
+        return $data;
+    }
+
+    /**
+     * This is executed when the parser reaches the <OPTIONS> opening element
+     */
+    public function on_choice_options_start() {
+        $this->xmlwriter->begin_tag('options');
+    }
+
+    /**
+     * This is executed every time we have one /MOODLE_BACKUP/COURSE/MODULES/MOD/CHOICE/OPTIONS/OPTION
+     * data available
+     */
+    public function process_choice_option($data) {
+        $this->write_xml('option', $data, array('/option/id'));
+    }
+
+    /**
+     * This is executed when the parser reaches the closing </OPTIONS> element
+     */
+    public function on_choice_options_end() {
+        $this->xmlwriter->end_tag('options');
+    }
+
+    /**
+     * This is executed when we reach the closing </MOD> tag of our 'choice' path
+     */
+    public function on_choice_end() {
+        // finalize choice.xml
+        $this->xmlwriter->end_tag('choice');
+        $this->xmlwriter->end_tag('activity');
+        $this->close_xml_writer();
+
+        // write inforef.xml
+        $this->open_xml_writer("activities/choice_{$this->moduleid}/inforef.xml");
+        $this->xmlwriter->begin_tag('inforef');
+        $this->xmlwriter->begin_tag('fileref');
+        foreach ($this->fileman->get_fileids() as $fileid) {
+            $this->write_xml('file', array('id' => $fileid));
+        }
+        $this->xmlwriter->end_tag('fileref');
+        $this->xmlwriter->end_tag('inforef');
+        $this->close_xml_writer();
+    }
+}

mod/choice/backup/moodle2/backup_choice_activity_task.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 backup_choice_activity_task class
+ *
+ * @package     mod_choice
+ * @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/choice/backup/moodle2/backup_choice_stepslib.php');
+require_once($CFG->dirroot . '/mod/choice/backup/moodle2/backup_choice_settingslib.php');
+
+/**
+ * Provides the steps to perform one complete backup of the Choice instance
+ */
+class backup_choice_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 choice.xml file
+     */
+    protected function define_my_steps() {
+        $this->add_step(new backup_choice_activity_structure_step('choice_structure', 'choice.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 choices
+        $search="/(".$base."\/mod\/choice\/index.php\?id\=)([0-9]+)/";
+        $content= preg_replace($search, '$@CHOICEINDEX*$2@$', $content);
+
+        // Link to choice view by moduleid
+        $search="/(".$base."\/mod\/choice\/view.php\?id\=)([0-9]+)/";
+        $content= preg_replace($search, '$@CHOICEVIEWBYID*$2@$', $content);
+
+        return $content;
+    }
+}

mod/choice/backup/moodle2/backup_choice_settingslib.php

@@ -0,0 +1,27 @@
+<?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_choice
+ * @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
+ */
+
+ // This activity has not particular settings but the inherited from the generic
+ // backup_activity_task so here there isn't any class definition, like the ones
+ // existing in /backup/moodle2/backup_settingslib.php (activities section)

mod/choice/backup/moodle2/backup_choice_stepslib.php

@@ -0,0 +1,82 @@
+<?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_choice
+ * @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_choice_activity_task
+ */
+
+/**
+ * Define the complete choice structure for backup, with file and id annotations
+ */
+class backup_choice_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
+        $choice = new backup_nested_element('choice', array('id'), array(
+            'name', 'intro', 'introformat', 'publish',
+            'showresults', 'display', 'allowupdate', 'allowmultiple', 'showunanswered',
+            'limitanswers', 'timeopen', 'timeclose', 'timemodified',
+            'completionsubmit', 'showpreview', 'includeinactive', 'showavailable'));
+
+        $options = new backup_nested_element('options');
+
+        $option = new backup_nested_element('option', array('id'), array(
+            'text', 'maxanswers', 'timemodified'));
+
+        $answers = new backup_nested_element('answers');
+
+        $answer = new backup_nested_element('answer', array('id'), array(
+            'userid', 'optionid', 'timemodified'));
+
+        // Build the tree
+        $choice->add_child($options);
+        $options->add_child($option);
+
+        $choice->add_child($answers);
+        $answers->add_child($answer);
+
+        // Define sources
+        $choice->set_source_table('choice', array('id' => backup::VAR_ACTIVITYID));
+
+        $option->set_source_table('choice_options', array('choiceid' => backup::VAR_PARENTID), 'id ASC');
+
+        // All the rest of elements only happen if we are including user info
+        if ($userinfo) {
+            $answer->set_source_table('choice_answers', array('choiceid' => '../../id'));
+        }
+
+        // Define id annotations
+        $answer->annotate_ids('user', 'userid');
+
+        // Define file annotations
+        $choice->annotate_files('mod_choice', 'intro', null); // This file area hasn't itemid
+
+        // Return the root element (choice), wrapped into standard activity structure
+        return $this->prepare_activity_structure($choice);
+    }
+}

mod/choice/backup/moodle2/restore_choice_activity_task.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/>.
+
+/**
+ * @package    mod_choice
+ * @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/choice/backup/moodle2/restore_choice_stepslib.php'); // Because it exists (must)
+
+/**
+ * choice restore task that provides all the settings and steps to perform one
+ * complete restore of the activity
+ */
+class restore_choice_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_choice_activity_structure_step('choice_structure', 'choice.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('choice', array('intro'), 'choice');
+
+        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('CHOICEVIEWBYID', '/mod/choice/view.php?id=$1', 'course_module');
+        $rules[] = new restore_decode_rule('CHOICEINDEX', '/mod/choice/index.php?id=$1', 'course');
+
+        return $rules;
+
+    }
+
+    /**
+     * Define the restore log rules that will be applied
+     * by the {@link restore_logs_processor} when restoring
+     * choice 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('choice', 'add', 'view.php?id={course_module}', '{choice}');
+        $rules[] = new restore_log_rule('choice', 'update', 'view.php?id={course_module}', '{choice}');
+        $rules[] = new restore_log_rule('choice', 'view', 'view.php?id={course_module}', '{choice}');
+        $rules[] = new restore_log_rule('choice', 'choose', 'view.php?id={course_module}', '{choice}');
+        $rules[] = new restore_log_rule('choice', 'choose again', 'view.php?id={course_module}', '{choice}');
+        $rules[] = new restore_log_rule('choice', 'report', 'report.php?id={course_module}', '{choice}');
+
+        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();
+
+        // Fix old wrong uses (missing extension)
+        $rules[] = new restore_log_rule('choice', 'view all', 'index?id={course}', null,
+                                        null, null, 'index.php?id={course}');
+        $rules[] = new restore_log_rule('choice', 'view all', 'index.php?id={course}', null);
+
+        return $rules;
+    }
+}

mod/choice/backup/moodle2/restore_choice_stepslib.php

@@ -0,0 +1,97 @@
+<?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_choice
+ * @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_choice_activity_task
+ */
+
+/**
+ * Structure step to restore one choice activity
+ */
+class restore_choice_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('choice', '/activity/choice');
+        $paths[] = new restore_path_element('choice_option', '/activity/choice/options/option');
+        if ($userinfo) {
+            $paths[] = new restore_path_element('choice_answer', '/activity/choice/answers/answer');
+        }
+
+        // Return the paths wrapped into standard activity structure
+        return $this->prepare_activity_structure($paths);
+    }
+
+    protected function process_choice($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.
+        $data->timeopen = $this->apply_date_offset($data->timeopen);
+        $data->timeclose = $this->apply_date_offset($data->timeclose);
+
+        // insert the choice record
+        $newitemid = $DB->insert_record('choice', $data);
+        // immediately after inserting "activity" record, call this
+        $this->apply_activity_instance($newitemid);
+    }
+
+    protected function process_choice_option($data) {
+        global $DB;
+
+        $data = (object)$data;
+        $oldid = $data->id;
+
+        $data->choiceid = $this->get_new_parentid('choice');
+
+        $newitemid = $DB->insert_record('choice_options', $data);
+        $this->set_mapping('choice_option', $oldid, $newitemid);
+    }
+
+    protected function process_choice_answer($data) {
+        global $DB;
+
+        $data = (object)$data;
+
+        $data->choiceid = $this->get_new_parentid('choice');
+        $data->optionid = $this->get_mappingid('choice_option', $data->optionid);
+        $data->userid = $this->get_mappingid('user', $data->userid);
+
+        $newitemid = $DB->insert_record('choice_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 choice related files, no need to match by itemname (just internally handled context)
+        $this->add_related_files('mod_choice', 'intro', null);
+    }
+}