efa8ff262347cab6cf32c41c0cba40d416a1989f
[moodle.git] / mod / chat / backup / moodle1 / lib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Provides support for the conversion of moodle1 backup to the moodle2 format
20  * Based off of a template @ http://docs.moodle.org/dev/Backup_1.9_conversion_for_developers
21  *
22  * @package    mod
23  * @subpackage chat
24  * @copyright  2011 Aparup Banerjee <aparup@moodle.com>
25  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26  */
28 defined('MOODLE_INTERNAL') || die();
30 /**
31  * Chat conversion handler
32  */
33 class moodle1_mod_chat_handler extends moodle1_mod_handler {
35     /** @var moodle1_file_manager */
36     protected $fileman = null;
38     /** @var int cmid */
39     protected $moduleid = null;
41     /**
42      * Declare the paths in moodle.xml we are able to convert
43      *
44      * The method returns list of {@link convert_path} instances.
45      * For each path returned, the corresponding conversion method must be
46      * defined.
47      *
48      * Note that the path /MOODLE_BACKUP/COURSE/MODULES/MOD/CHAT does not
49      * actually exist in the file. The last element with the module name was
50      * appended by the moodle1_converter class.
51      *
52      * @return array of {@link convert_path} instances
53      */
54     public function get_paths() {
55         return array(
56             new convert_path(
57                 'chat', '/MOODLE_BACKUP/COURSE/MODULES/MOD/CHAT',
58                 array(
59                     'newfields' => array(
60                         'introformat' => 0
61                     )
62                 )
63             )
64         );
65     }
67     /**
68      * This is executed every time we have one /MOODLE_BACKUP/COURSE/MODULES/MOD/CHAT
69      * data available
70      */
71     public function process_chat($data) {
72         global $CFG;
74         // get the course module id and context id
75         $instanceid     = $data['id'];
76         $cminfo         = $this->get_cminfo($instanceid);
77         $this->moduleid = $cminfo['id'];
78         $contextid      = $this->converter->get_contextid(CONTEXT_MODULE, $this->moduleid);
80         // replay the upgrade step 2010050101
81         if ($CFG->texteditors !== 'textarea') {
82             $data['intro']       = text_to_html($data['intro'], false, false, true);
83             $data['introformat'] = FORMAT_HTML;
84         }
86         // get a fresh new file manager for this instance
87         $this->fileman = $this->converter->get_file_manager($contextid, 'mod_chat');
89         // convert course files embedded into the intro
90         $this->fileman->filearea = 'intro';
91         $this->fileman->itemid   = 0;
92         $data['intro'] = moodle1_converter::migrate_referenced_files($data['intro'], $this->fileman);
94         // start writing chat.xml
95         $this->open_xml_writer("activities/chat_{$this->moduleid}/chat.xml");
96         $this->xmlwriter->begin_tag('activity', array('id' => $instanceid, 'moduleid' => $this->moduleid,
97             'modulename' => 'chat', 'contextid' => $contextid));
98         $this->xmlwriter->begin_tag('chat', array('id' => $instanceid));
100         foreach ($data as $field => $value) {
101             if ($field <> 'id') {
102                 $this->xmlwriter->full_tag($field, $value);
103             }
104         }
106         $this->xmlwriter->begin_tag('messages');
108         return $data;
109     }
111     /**
112      * This is executed every time we have one /MOODLE_BACKUP/COURSE/MODULES/MOD/CHAT/MESSAGES/MESSAGE
113      * data available
114      */
115     public function process_chat_message($data) {
116         //@todo process user data
117         //$this->write_xml('message', $data, array('/message/id'));
118     }
120     /**
121      * This is executed when we reach the closing </MOD> tag of our 'chat' path
122      */
123     public function on_chat_end() {
124         // close chat.xml
125         $this->xmlwriter->end_tag('messages');
126         $this->xmlwriter->end_tag('chat');
127         $this->xmlwriter->end_tag('activity');
128         $this->close_xml_writer();
130         // write inforef.xml
131         $this->open_xml_writer("activities/chat_{$this->moduleid}/inforef.xml");
132         $this->xmlwriter->begin_tag('inforef');
133         $this->xmlwriter->begin_tag('fileref');
134         foreach ($this->fileman->get_fileids() as $fileid) {
135             $this->write_xml('file', array('id' => $fileid));
136         }
137         $this->xmlwriter->end_tag('fileref');
138         $this->xmlwriter->end_tag('inforef');
139         $this->close_xml_writer();
140     }