Merge branch 'MDL-29256-resource-format' of git://github.com/mudrd8mz/moodle
[moodle.git] / mod / page / 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  *
21  * @package    mod
22  * @subpackage page
23  * @copyright  2011 Andrew Davis <andrew@moodle.com>
24  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
27 defined('MOODLE_INTERNAL') || die();
29 /**
30  * Page conversion handler. This resource handler is called by moodle1_mod_resource_handler
31  */
32 class moodle1_mod_page_handler extends moodle1_resource_successor_handler {
34     /** @var moodle1_file_manager instance */
35     protected $fileman = null;
37     /**
38      * Converts /MOODLE_BACKUP/COURSE/MODULES/MOD/RESOURCE data
39      * Called by moodle1_mod_resource_handler::process_resource()
40      */
41     public function process_legacy_resource(array $data) {
43         // get the course module id and context id
44         $instanceid = $data['id'];
45         $cminfo     = $this->get_cminfo($instanceid, 'resource');
46         $moduleid   = $cminfo['id'];
47         $contextid  = $this->converter->get_contextid(CONTEXT_MODULE, $moduleid);
49         // convert the legacy data onto the new page record
50         $page                       = array();
51         $page['id']                 = $data['id'];
52         $page['name']               = $data['name'];
53         $page['intro']              = $data['intro'];
54         $page['introformat']        = $data['introformat'];
55         $page['content']            = $data['alltext'];
57         if ($data['type'] === 'html') {
58             // legacy Resource of the type Web page
59             $page['contentformat'] = FORMAT_HTML;
61         } else {
62             // legacy Resource of the type Plain text page
63             $page['contentformat'] = (int)$data['reference'];
65             if ($page['contentformat'] < 0 or $page['contentformat'] > 4) {
66                 $page['contentformat'] = FORMAT_MOODLE;
67             }
68         }
70         $page['legacyfiles']        = RESOURCELIB_LEGACYFILES_ACTIVE;
71         $page['legacyfileslast']    = null;
72         $page['revision']           = 1;
73         $page['timemodified']       = $data['timemodified'];
75         // populate display and displayoptions fields
76         $options = array('printheading' => 0, 'printintro' => 0);
77         if ($data['popup']) {
78             $page['display'] = RESOURCELIB_DISPLAY_POPUP;
79             $rawoptions = explode(',', $data['popup']);
80             foreach ($rawoptions as $rawoption) {
81                 list($name, $value) = explode('=', trim($rawoption), 2);
82                 if ($value > 0 and ($name == 'width' or $name == 'height')) {
83                     $options['popup'.$name] = $value;
84                     continue;
85                 }
86             }
87         } else {
88             $page['display'] = RESOURCELIB_DISPLAY_OPEN;
89         }
90         $page['displayoptions'] = serialize($options);
92         // get a fresh new file manager for this instance
93         $this->fileman = $this->converter->get_file_manager($contextid, 'mod_page');
95         // convert course files embedded into the intro
96         $this->fileman->filearea = 'intro';
97         $this->fileman->itemid   = 0;
98         $page['intro'] = moodle1_converter::migrate_referenced_files($page['intro'], $this->fileman);
100         // convert course files embedded into the content
101         $this->fileman->filearea = 'content';
102         $this->fileman->itemid   = 0;
103         $page['content'] = moodle1_converter::migrate_referenced_files($page['content'], $this->fileman);
105         // write page.xml
106         $this->open_xml_writer("activities/page_{$moduleid}/page.xml");
107         $this->xmlwriter->begin_tag('activity', array('id' => $instanceid, 'moduleid' => $moduleid,
108             'modulename' => 'page', 'contextid' => $contextid));
109         $this->write_xml('page', $page, array('/page/id'));
110         $this->xmlwriter->end_tag('activity');
111         $this->close_xml_writer();
113         // write inforef.xml for migrated resource file.
114         $this->open_xml_writer("activities/page_{$moduleid}/inforef.xml");
115         $this->xmlwriter->begin_tag('inforef');
116         $this->xmlwriter->begin_tag('fileref');
117         foreach ($this->fileman->get_fileids() as $fileid) {
118             $this->write_xml('file', array('id' => $fileid));
119         }
120         $this->xmlwriter->end_tag('fileref');
121         $this->xmlwriter->end_tag('inforef');
122         $this->close_xml_writer();
123     }