first commit

mod/feedback/backup/moodle1/lib.php

@@ -0,0 +1,158 @@
+<?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_feedback
+ * @copyright  2011 Rossiani Wijaya <rwijaya@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Feedback module conversion handler
+ */
+class moodle1_mod_feedback_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/FEEDBACK 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(
+                'feedback', '/MOODLE_BACKUP/COURSE/MODULES/MOD/FEEDBACK',
+                array(
+                    'renamefields' => array(
+                        'summary' => 'intro',
+                        'pageaftersub' => 'page_after_submit',
+                    ),
+                    'newfields' => array(
+                        'autonumbering' => 1,
+                        'site_after_submit' => '',
+                        'introformat' => 0,
+                        'page_after_submitformat' => 0,
+                        'completionsubmit' => 0,
+                    ),
+                )
+            ),
+            new convert_path(
+                'feedback_item', '/MOODLE_BACKUP/COURSE/MODULES/MOD/FEEDBACK/ITEMS/ITEM',
+                array (
+                    'newfields' => array(
+                        'label' => '',
+                        'options' => '',
+                        'dependitem' => 0,
+                        'dependvalue' => '',
+                    ),
+                )
+            ),
+        );
+    }
+
+    /**
+     * This is executed every time we have one /MOODLE_BACKUP/COURSE/MODULES/MOD/FEEDBACK
+     * data available
+     */
+    public function process_feedback($data) {
+        global $CFG;
+
+        // 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_feedback');
+
+        // 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);
+
+        // Convert the introformat if necessary.
+        if ($CFG->texteditors !== 'textarea') {
+            $data['intro'] = text_to_html($data['intro'], false, false, true);
+            $data['introformat'] = FORMAT_HTML;
+        }
+
+        // start writing feedback.xml
+        $this->open_xml_writer("activities/feedback_{$this->moduleid}/feedback.xml");
+        $this->xmlwriter->begin_tag('activity', array('id' => $instanceid, 'moduleid' => $this->moduleid,
+            'modulename' => 'feedback', 'contextid' => $contextid));
+        $this->xmlwriter->begin_tag('feedback', array('id' => $instanceid));
+
+        foreach ($data as $field => $value) {
+            if ($field <> 'id') {
+                $this->xmlwriter->full_tag($field, $value);
+            }
+        }
+
+        $this->xmlwriter->begin_tag('items');
+
+        return $data;
+    }
+
+    /**
+     * This is executed every time we have one /MOODLE_BACKUP/COURSE/MODULES/MOD/FEEDBACK/ITEMS/ITEM
+     * data available
+     */
+    public function process_feedback_item($data) {
+        $this->write_xml('item', $data, array('/item/id'));
+    }
+
+    /**
+     * This is executed when we reach the closing </MOD> tag of our 'feedback' path
+     */
+    public function on_feedback_end() {
+        // finish writing feedback.xml
+        $this->xmlwriter->end_tag('items');
+        $this->xmlwriter->end_tag('feedback');
+        $this->xmlwriter->end_tag('activity');
+        $this->close_xml_writer();
+
+        // write inforef.xml
+        $this->open_xml_writer("activities/feedback_{$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/feedback/backup/moodle2/backup_feedback_activity_task.class.php

@@ -0,0 +1,80 @@
+<?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_feedback_activity_task class
+ *
+ * @package     mod_feedback
+ * @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/feedback/backup/moodle2/backup_feedback_stepslib.php');
+require_once($CFG->dirroot . '/mod/feedback/backup/moodle2/backup_feedback_settingslib.php');
+
+/**
+ * Provides the steps to perform one complete backup of the Feedback instance
+ */
+class backup_feedback_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 feedback.xml file
+     */
+    protected function define_my_steps() {
+        // feedback only has one structure step
+        $this->add_step(new backup_feedback_activity_structure_step('feedback structure', 'feedback.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 feedbacks
+        $search="/(".$base."\/mod\/feedback\/index.php\?id\=)([0-9]+)/";
+        $content= preg_replace($search, '$@FEEDBACKINDEX*$2@$', $content);
+
+        // Link to feedback view by moduleid
+        $search="/(".$base."\/mod\/feedback\/view.php\?id\=)([0-9]+)/";
+        $content= preg_replace($search, '$@FEEDBACKVIEWBYID*$2@$', $content);
+
+        // Link to feedback analyis by moduleid
+        $search="/(".$base."\/mod\/feedback\/analysis.php\?id\=)([0-9]+)/";
+        $content= preg_replace($search, '$@FEEDBACKANALYSISBYID*$2@$', $content);
+
+        // Link to feedback entries by moduleid
+        $search="/(".$base."\/mod\/feedback\/show_entries.php\?id\=)([0-9]+)/";
+        $content= preg_replace($search, '$@FEEDBACKSHOWENTRIESBYID*$2@$', $content);
+
+        return $content;
+    }
+}

mod/feedback/backup/moodle2/backup_feedback_settingslib.php

@@ -0,0 +1,26 @@
+<?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_feedback
+ * @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/feedback/backup/moodle2/backup_feedback_stepslib.php

@@ -0,0 +1,130 @@
+<?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_feedback
+ * @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_feedback_activity_task
+ */
+
+/**
+ * Define the complete feedback structure for backup, with file and id annotations
+ */
+class backup_feedback_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
+        $feedback = new backup_nested_element('feedback', array('id'), array(
+                                                'name',
+                                                'intro',
+                                                'introformat',
+                                                'anonymous',
+                                                'email_notification',
+                                                'multiple_submit',
+                                                'autonumbering',
+                                                'site_after_submit',
+                                                'page_after_submit',
+                                                'page_after_submitformat',
+                                                'publish_stats',
+                                                'timeopen',
+                                                'timeclose',
+                                                'timemodified',
+                                                'completionsubmit'));
+
+        $completeds = new backup_nested_element('completeds');
+
+        $completed = new backup_nested_element('completed', array('id'), array(
+                                                'userid',
+                                                'timemodified',
+                                                'random_response',
+                                                'anonymous_response',
+                                                'courseid'));
+
+        $items = new backup_nested_element('items');
+
+        $item = new backup_nested_element('item', array('id'), array(
+                                                'template',
+                                                'name',
+                                                'label',
+                                                'presentation',
+                                                'typ',
+                                                'hasvalue',
+                                                'position',
+                                                'required',
+                                                'dependitem',
+                                                'dependvalue',
+                                                'options'));
+
+        $values = new backup_nested_element('values');
+
+        $value = new backup_nested_element('value', array('id'), array(
+                                                'item',
+                                                'template',
+                                                'completed',
+                                                'value',
+                                                'course_id'));
+
+        // Build the tree
+        $feedback->add_child($items);
+        $items->add_child($item);
+
+        $feedback->add_child($completeds);
+        $completeds->add_child($completed);
+
+        $completed->add_child($values);
+        $values->add_child($value);
+
+        // Define sources
+        $feedback->set_source_table('feedback', array('id' => backup::VAR_ACTIVITYID));
+
+        $item->set_source_table('feedback_item', array('feedback' => backup::VAR_PARENTID));
+
+        // All these source definitions only happen if we are including user info
+        if ($userinfo) {
+            $completed->set_source_sql('
+                SELECT *
+                  FROM {feedback_completed}
+                 WHERE feedback = ?',
+                array(backup::VAR_PARENTID));
+
+            $value->set_source_table('feedback_value', array('completed' => backup::VAR_PARENTID));
+        }
+
+        // Define id annotations
+
+        $completed->annotate_ids('user', 'userid');
+
+        // Define file annotations
+
+        $feedback->annotate_files('mod_feedback', 'intro', null); // This file area hasn't itemid
+        $feedback->annotate_files('mod_feedback', 'page_after_submit', null); // This file area hasn't itemid
+
+        $item->annotate_files('mod_feedback', 'item', 'id');
+
+        // Return the root element (feedback), wrapped into standard activity structure
+        return $this->prepare_activity_structure($feedback);
+    }
+
+}

mod/feedback/backup/moodle2/restore_feedback_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_feedback
+ * @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/feedback/backup/moodle2/restore_feedback_stepslib.php'); // Because it exists (must)
+
+/**
+ * feedback restore task that provides all the settings and steps to perform one
+ * complete restore of the activity
+ */
+class restore_feedback_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() {
+        // feedback only has one structure step
+        $this->add_step(new restore_feedback_activity_structure_step('feedback_structure', 'feedback.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('feedback', array('intro', 'site_after_submit', 'page_after_submit'), 'feedback');
+        $contents[] = new restore_decode_content('feedback_item', array('presentation'), 'feedback_item');
+        $contents[] = new restore_decode_content('feedback_value', array('value'), 'feedback_value');
+
+        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('FEEDBACKINDEX', '/mod/feedback/index.php?id=$1', 'course');
+        $rules[] = new restore_decode_rule('FEEDBACKVIEWBYID', '/mod/feedback/view.php?id=$1', 'course_module');
+        $rules[] = new restore_decode_rule('FEEDBACKANALYSISBYID', '/mod/feedback/analysis.php?id=$1', 'course_module');
+        $rules[] = new restore_decode_rule('FEEDBACKSHOWENTRIESBYID', '/mod/feedback/show_entries.php?id=$1', 'course_module');
+
+        return $rules;
+
+    }
+
+    /**
+     * Define the restore log rules that will be applied
+     * by the {@link restore_logs_processor} when restoring
+     * feedback 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('feedback', 'add', 'view.php?id={course_module}', '{feedback}');
+        $rules[] = new restore_log_rule('feedback', 'update', 'view.php?id={course_module}', '{feedback}');
+        $rules[] = new restore_log_rule('feedback', 'view', 'view.php?id={course_module}', '{feedback}');
+        $rules[] = new restore_log_rule('feedback', 'submit', 'view.php?id={course_module}', '{feedback}');
+        $rules[] = new restore_log_rule('feedback', 'startcomplete', 'view.php?id={course_module}', '{feedback}');
+
+        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('feedback', 'view all', 'index.php?id={course}', null);
+
+        return $rules;
+    }
+}

mod/feedback/backup/moodle2/restore_feedback_stepslib.php

@@ -0,0 +1,133 @@
+<?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_feedback
+ * @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_feedback_activity_task
+ */
+
+/**
+ * Structure step to restore one feedback activity
+ */
+class restore_feedback_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('feedback', '/activity/feedback');
+        $paths[] = new restore_path_element('feedback_item', '/activity/feedback/items/item');
+        if ($userinfo) {
+            $paths[] = new restore_path_element('feedback_completed', '/activity/feedback/completeds/completed');
+            $paths[] = new restore_path_element('feedback_value', '/activity/feedback/completeds/completed/values/value');
+        }
+
+        // Return the paths wrapped into standard activity structure
+        return $this->prepare_activity_structure($paths);
+    }
+
+    protected function process_feedback($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 feedback record
+        $newitemid = $DB->insert_record('feedback', $data);
+        // immediately after inserting "activity" record, call this
+        $this->apply_activity_instance($newitemid);
+    }
+
+    protected function process_feedback_item($data) {
+        global $DB;
+
+        $data = (object)$data;
+        $oldid = $data->id;
+        $data->feedback = $this->get_new_parentid('feedback');
+        $data->typ = clean_param($data->typ, PARAM_ALPHA);
+
+        $newitemid = $DB->insert_record('feedback_item', $data);
+        $this->set_mapping('feedback_item', $oldid, $newitemid, true); // Can have files
+    }
+
+    protected function process_feedback_completed($data) {
+        global $DB;
+
+        $data = (object)$data;
+        $oldid = $data->id;
+        $data->feedback = $this->get_new_parentid('feedback');
+        $data->userid = $this->get_mappingid('user', $data->userid);
+        if ($this->task->is_samesite() && !empty($data->courseid)) {
+            $data->courseid = $data->courseid;
+        } else if ($this->get_courseid() == SITEID) {
+            $data->courseid = SITEID;
+        } else {
+            $data->courseid = 0;
+        }
+
+        $newitemid = $DB->insert_record('feedback_completed', $data);
+        $this->set_mapping('feedback_completed', $oldid, $newitemid);
+    }
+
+    protected function process_feedback_value($data) {
+        global $DB;
+
+        $data = (object)$data;
+        $oldid = $data->id;
+        $data->completed = $this->get_new_parentid('feedback_completed');
+        $data->item = $this->get_mappingid('feedback_item', $data->item);
+        if ($this->task->is_samesite() && !empty($data->course_id)) {
+            $data->course_id = $data->course_id;
+        } else if ($this->get_courseid() == SITEID) {
+            $data->course_id = SITEID;
+        } else {
+            $data->course_id = 0;
+        }
+
+        $newitemid = $DB->insert_record('feedback_value', $data);
+        $this->set_mapping('feedback_value', $oldid, $newitemid);
+    }
+
+    protected function after_execute() {
+        global $DB;
+        // Add feedback related files, no need to match by itemname (just internally handled context)
+        $this->add_related_files('mod_feedback', 'intro', null);
+        $this->add_related_files('mod_feedback', 'page_after_submit', null);
+        $this->add_related_files('mod_feedback', 'item', 'feedback_item');
+
+        // Once all items are restored we can set their dependency.
+        if ($records = $DB->get_records('feedback_item', array('feedback' => $this->task->get_activityid()))) {
+            foreach ($records as $record) {
+                // Get new id for dependitem if present. This will also reset dependitem if not found.
+                $record->dependitem = $this->get_mappingid('feedback_item', $record->dependitem);
+                $DB->update_record('feedback_item', $record);
+            }
+        }
+    }
+}