first commit

mod/chat/backup/moodle1/lib.php

@@ -0,0 +1,138 @@
+<?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
+ * Based off of a template @ http://docs.moodle.org/dev/Backup_1.9_conversion_for_developers
+ *
+ * @package    mod_chat
+ * @copyright  2011 Aparup Banerjee <aparup@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Chat conversion handler
+ */
+class moodle1_mod_chat_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/CHAT 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(
+                'chat', '/MOODLE_BACKUP/COURSE/MODULES/MOD/CHAT',
+                array(
+                    'newfields' => array(
+                        'introformat' => 0
+                    )
+                )
+            )
+        );
+    }
+
+    /**
+     * This is executed every time we have one /MOODLE_BACKUP/COURSE/MODULES/MOD/CHAT
+     * data available
+     */
+    public function process_chat($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);
+
+        // Replay the upgrade step 2010050101.
+        if ($CFG->texteditors !== 'textarea') {
+            $data['intro']       = text_to_html($data['intro'], false, false, true);
+            $data['introformat'] = FORMAT_HTML;
+        }
+
+        // Get a fresh new file manager for this instance.
+        $this->fileman = $this->converter->get_file_manager($contextid, 'mod_chat');
+
+        // 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 chat.xml.
+        $this->open_xml_writer("activities/chat_{$this->moduleid}/chat.xml");
+        $this->xmlwriter->begin_tag('activity', array('id' => $instanceid, 'moduleid' => $this->moduleid,
+            'modulename' => 'chat', 'contextid' => $contextid));
+        $this->xmlwriter->begin_tag('chat', array('id' => $instanceid));
+
+        foreach ($data as $field => $value) {
+            if ($field <> 'id') {
+                $this->xmlwriter->full_tag($field, $value);
+            }
+        }
+
+        $this->xmlwriter->begin_tag('messages');
+
+        return $data;
+    }
+
+    /**
+     * This is executed every time we have one /MOODLE_BACKUP/COURSE/MODULES/MOD/CHAT/MESSAGES/MESSAGE
+     * data available
+     */
+    public function process_chat_message($data) {
+        // MDL-46466 - Should this be empty?
+    }
+
+    /**
+     * This is executed when we reach the closing </MOD> tag of our 'chat' path
+     */
+    public function on_chat_end() {
+        // Close chat.xml.
+        $this->xmlwriter->end_tag('messages');
+        $this->xmlwriter->end_tag('chat');
+        $this->xmlwriter->end_tag('activity');
+        $this->close_xml_writer();
+
+        // Write inforef.xml.
+        $this->open_xml_writer("activities/chat_{$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/chat/backup/moodle2/backup_chat_activity_task.class.php

@@ -0,0 +1,69 @@
+<?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_chat_activity_task class
+ *
+ * @package     mod_chat
+ * @category    backup
+ * @copyright   2010 onwards Dongsheng Cai <dongsheng@moodle.com>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+require_once($CFG->dirroot . '/mod/chat/backup/moodle2/backup_chat_stepslib.php');
+
+/**
+ * Provides the steps to perform one complete backup of the Chat instance
+ */
+class backup_chat_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 chat.xml file
+     */
+    protected function define_my_steps() {
+        $this->add_step(new backup_chat_activity_structure_step('chat_structure', 'chat.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 . '/mod/chat', '#');
+
+        // Link to the list of chats.
+        $pattern = "#(".$base."\/index.php\?id\=)([0-9]+)#";
+        $content = preg_replace($pattern, '$@CHATINDEX*$2@$', $content);
+
+        // Link to chat view by moduleid.
+        $pattern = "#(".$base."\/view.php\?id\=)([0-9]+)#";
+        $content = preg_replace($pattern, '$@CHATVIEWBYID*$2@$', $content);
+
+        return $content;
+    }
+}

mod/chat/backup/moodle2/backup_chat_stepslib.php

@@ -0,0 +1,67 @@
+<?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_chat
+ * @subpackage backup-moodle2
+ * @copyright 2010 onwards Dongsheng Cai <dongsheng@moodle.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_chat_activity_task
+ */
+class backup_chat_activity_structure_step extends backup_activity_structure_step {
+    protected function define_structure() {
+        $userinfo = $this->get_setting_value('userinfo');
+
+        // Define each element separated.
+        $chat = new backup_nested_element('chat', array('id'), array(
+            'name', 'intro', 'introformat', 'keepdays', 'studentlogs',
+            'chattime', 'schedule', 'timemodified'));
+        $messages = new backup_nested_element('messages');
+
+        $message = new backup_nested_element('message', array('id'), array(
+            'userid', 'groupid', 'system', 'message_text', 'timestamp'));
+
+        // It is not cool to have two tags with same name, so we need to rename message field to message_text.
+        $message->set_source_alias('message', 'message_text');
+        // Renamed 'issystem' into 'system', for backward compatibility: 'system' is now a reserved word in MySQL 8.0.3+.
+        $message->set_source_alias('issystem', 'system');
+
+        // Build the tree.
+        $chat->add_child($messages);
+        $messages->add_child($message);
+
+        // Define sources.
+        $chat->set_source_table('chat', array('id' => backup::VAR_ACTIVITYID));
+
+        // User related messages only happen if we are including user info.
+        if ($userinfo) {
+            $message->set_source_table('chat_messages', array('chatid' => backup::VAR_PARENTID));
+        }
+
+        // Define id annotations.
+        $message->annotate_ids('user', 'userid');
+        $message->annotate_ids('group', 'groupid');
+
+        // Annotate the file areas in chat module.
+        $chat->annotate_files('mod_chat', 'intro', null); // The chat_intro area doesn't use itemid.
+
+        // Return the root element (chat), wrapped into standard activity structure.
+        return $this->prepare_activity_structure($chat);
+    }
+}

mod/chat/backup/moodle2/restore_chat_activity_task.class.php

@@ -0,0 +1,111 @@
+<?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_chat
+ * @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/chat/backup/moodle2/restore_chat_stepslib.php');
+
+/**
+ * chat restore task that provides all the settings and steps to perform one
+ * complete restore of the activity
+ */
+class restore_chat_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() {
+        // Chat only has one structure step.
+        $this->add_step(new restore_chat_activity_structure_step('chat_structure', 'chat.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('chat', array('intro'), 'chat');
+        $contents[] = new restore_decode_content('chat_messages', array('message'), 'chat_message');
+
+        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('CHATVIEWBYID', '/mod/chat/view.php?id=$1', 'course_module');
+        $rules[] = new restore_decode_rule('CHATINDEX', '/mod/chat/index.php?id=$1', 'course');
+
+        return $rules;
+
+    }
+
+    /**
+     * Define the restore log rules that will be applied
+     * by the {@link restore_logs_processor} when restoring
+     * chat 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('chat', 'add', 'view.php?id={course_module}', '{chat}');
+        $rules[] = new restore_log_rule('chat', 'update', 'view.php?id={course_module}', '{chat}');
+        $rules[] = new restore_log_rule('chat', 'view', 'view.php?id={course_module}', '{chat}');
+        $rules[] = new restore_log_rule('chat', 'talk', 'view.php?id={course_module}', '{chat}');
+        $rules[] = new restore_log_rule('chat', 'report', 'report.php?id={course_module}', '{chat}');
+
+        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('chat', 'view all', 'index.php?id={course}', null);
+
+        return $rules;
+    }
+}

mod/chat/backup/moodle2/restore_chat_stepslib.php

@@ -0,0 +1,83 @@
+<?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_chat
+ * @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_chat_activity_task
+ */
+
+/**
+ * Structure step to restore one chat activity
+ */
+class restore_chat_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('chat', '/activity/chat');
+        if ($userinfo) {
+            $paths[] = new restore_path_element('chat_message', '/activity/chat/messages/message');
+        }
+
+        // Return the paths wrapped into standard activity structure.
+        return $this->prepare_activity_structure($paths);
+    }
+
+    protected function process_chat($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->chattime = $this->apply_date_offset($data->chattime);
+
+        // Insert the chat record.
+        $newitemid = $DB->insert_record('chat', $data);
+        // Immediately after inserting "activity" record, call this.
+        $this->apply_activity_instance($newitemid);
+    }
+
+    protected function process_chat_message($data) {
+        global $DB;
+
+        $data = (object)$data;
+        $oldid = $data->id;
+        $data->chatid = $this->get_new_parentid('chat');
+        $data->userid = $this->get_mappingid('user', $data->userid);
+        $data->groupid = $this->get_mappingid('group', $data->groupid);
+        $data->message = $data->message_text;
+        $data->issystem = $data->system;
+
+        $newitemid = $DB->insert_record('chat_messages', $data);
+        $this->set_mapping('chat_message', $oldid, $newitemid); // Because of decode.
+    }
+
+    protected function after_execute() {
+        // Add chat related files, no need to match by itemname (just internally handled context).
+        $this->add_related_files('mod_chat', 'intro', null);
+    }
+}