Merge branch 'w21_MDL-32564_m23_timezonecontext' of git://github.com/skodak/moodle
[moodle.git] / backup / util / helper / backup_general_helper.class.php
CommitLineData
69dd0c8c
EL
1<?php
2
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/>.
17
18/**
19 * @package moodlecore
20 * @subpackage backup-helper
21 * @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
22 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 */
24
25/**
26 * Non instantiable helper class providing general helper methods for backup/restore
27 *
28 * This class contains various general helper static methods available for backup/restore
29 *
30 * TODO: Finish phpdocs
31 */
32abstract class backup_general_helper extends backup_helper {
33
34 /**
35 * Calculate one checksum for any array/object. Works recursively
36 */
37 public static function array_checksum_recursive($arr) {
38
39 $checksum = ''; // Init checksum
40
41 // Check we are going to process one array always, objects must be cast before
42 if (!is_array($arr)) {
43 throw new backup_helper_exception('array_expected');
44 }
45 foreach ($arr as $key => $value) {
46 if ($value instanceof checksumable) {
47 $checksum = md5($checksum . '-' . $key . '-' . $value->calculate_checksum());
48 } else if (is_object($value)) {
49 $checksum = md5($checksum . '-' . $key . '-' . self::array_checksum_recursive((array)$value));
50 } else if (is_array($value)) {
51 $checksum = md5($checksum . '-' . $key . '-' . self::array_checksum_recursive($value));
52 } else {
53 $checksum = md5($checksum . '-' . $key . '-' . $value);
54 }
55 }
56 return $checksum;
57 }
f60f4666 58
90338ad1
EL
59 /**
60 * Load all the blocks information needed for a given path within moodle2 backup
61 *
62 * This function, given one full path (course, activities/xxxx) will look for all the
63 * blocks existing in the backup file, returning one array used to build the
64 * proper restore plan by the @restore_plan_builder
65 */
66 public static function get_blocks_from_path($path) {
67 global $DB;
68
69 $blocks = array(); // To return results
70
71 static $availableblocks = array(); // Get and cache available blocks
72 if (empty($availableblocks)) {
73 $availableblocks = array_keys(get_plugin_list('block'));
74 }
75
76 $path = $path . '/blocks'; // Always look under blocks subdir
77
78 if (!is_dir($path)) {
79 return array();
80 }
81
82 $dir = opendir($path);
83 while (false !== ($file = readdir($dir))) {
84 if ($file == '.' || $file == '..') { // Skip dots
85 continue;
86 }
87 if (is_dir($path .'/' . $file)) { // Dir found, check it's a valid block
88 if (!file_exists($path .'/' . $file . '/block.xml')) { // Skip if xml file not found
89 continue;
90 }
91 // Extract block name
92 $blockname = preg_replace('/(.*)_\d+/', '\\1', $file);
93 // Check block exists and is installed
94 if (in_array($blockname, $availableblocks) && $DB->record_exists('block', array('name' => $blockname))) {
95 $blocks[$path .'/' . $file] = $blockname;
96 }
97 }
98 }
99 closedir($dir);
100
101 return $blocks;
102 }
103
dc5a2f8a
EL
104 /**
105 * Load and format all the needed information from moodle_backup.xml
106 *
107 * This function loads and process all the moodle_backup.xml
108 * information, composing a big information structure that will
109 * be the used by the plan builder in order to generate the
110 * appropiate tasks / steps / settings
111 */
112 public static function get_backup_information($tempdir) {
113 global $CFG;
114
115 $info = new stdclass(); // Final information goes here
116
7aa06e6d 117 $moodlefile = $CFG->tempdir . '/backup/' . $tempdir . '/moodle_backup.xml';
dc5a2f8a 118 if (!file_exists($moodlefile)) { // Shouldn't happen ever, but...
482aac65 119 throw new backup_helper_exception('missing_moodle_backup_xml_file', $moodlefile);
dc5a2f8a
EL
120 }
121 // Load the entire file to in-memory array
122 $xmlparser = new progressive_parser();
123 $xmlparser->set_file($moodlefile);
124 $xmlprocessor = new restore_moodlexml_parser_processor();
125 $xmlparser->set_processor($xmlprocessor);
126 $xmlparser->process();
127 $infoarr = $xmlprocessor->get_all_chunks();
128 if (count($infoarr) !== 1) { // Shouldn't happen ever, but...
129 throw new backup_helper_exception('problem_parsing_moodle_backup_xml_file');
130 }
131 $infoarr = $infoarr[0]['tags']; // for commodity
132
133 // Let's build info
134 $info->moodle_version = $infoarr['moodle_version'];
135 $info->moodle_release = $infoarr['moodle_release'];
136 $info->backup_version = $infoarr['backup_version'];
137 $info->backup_release = $infoarr['backup_release'];
138 $info->backup_date = $infoarr['backup_date'];
c3ea499d 139 $info->mnet_remoteusers = $infoarr['mnet_remoteusers'];
dc5a2f8a 140 $info->original_wwwroot = $infoarr['original_wwwroot'];
482aac65 141 $info->original_site_identifier_hash = $infoarr['original_site_identifier_hash'];
dc5a2f8a 142 $info->original_course_id = $infoarr['original_course_id'];
560811a9
EL
143 $info->original_course_fullname = $infoarr['original_course_fullname'];
144 $info->original_course_shortname= $infoarr['original_course_shortname'];
145 $info->original_course_startdate= $infoarr['original_course_startdate'];
2df0f295 146 $info->original_course_contextid= $infoarr['original_course_contextid'];
3a1cccc6 147 $info->original_system_contextid= $infoarr['original_system_contextid'];
67233725 148 $info->include_file_references_to_external_content = $infoarr['include_file_references_to_external_content'];
dc5a2f8a
EL
149 $info->type = $infoarr['details']['detail'][0]['type'];
150 $info->format = $infoarr['details']['detail'][0]['format'];
151 $info->mode = $infoarr['details']['detail'][0]['mode'];
8d4e41f4
EL
152 // Build the role mappings custom object
153 $rolemappings = new stdclass();
154 $rolemappings->modified = false;
155 $rolemappings->mappings = array();
156 $info->role_mappings = $rolemappings;
438606fc
EL
157 // Some initially empty containers
158 $info->sections = array();
159 $info->activities = array();
dc5a2f8a
EL
160
161 // Now the contents
162 $contentsarr = $infoarr['contents'];
163 if (isset($contentsarr['course']) && isset($contentsarr['course'][0])) {
164 $info->course = new stdclass();
165 $info->course = (object)$contentsarr['course'][0];
166 $info->course->settings = array();
167 }
168 if (isset($contentsarr['sections']) && isset($contentsarr['sections']['section'])) {
169 $sectionarr = $contentsarr['sections']['section'];
dc5a2f8a
EL
170 foreach ($sectionarr as $section) {
171 $section = (object)$section;
172 $section->settings = array();
173 $sections[basename($section->directory)] = $section;
174 }
175 $info->sections = $sections;
176 }
177 if (isset($contentsarr['activities']) && isset($contentsarr['activities']['activity'])) {
178 $activityarr = $contentsarr['activities']['activity'];
dc5a2f8a
EL
179 foreach ($activityarr as $activity) {
180 $activity = (object)$activity;
181 $activity->settings = array();
182 $activities[basename($activity->directory)] = $activity;
183 }
184 $info->activities = $activities;
185 }
186 $info->root_settings = array(); // For root settings
187
188 // Now the settings, putting each one under its owner
189 $settingsarr = $infoarr['settings']['setting'];
190 foreach($settingsarr as $setting) {
191 switch ($setting['level']) {
192 case 'root':
193 $info->root_settings[$setting['name']] = $setting['value'];
194 break;
195 case 'course':
196 $info->course->settings[$setting['name']] = $setting['value'];
197 break;
198 case 'section':
199 $info->sections[$setting['section']]->settings[$setting['name']] = $setting['value'];
200 break;
201 case 'activity':
202 $info->activities[$setting['activity']]->settings[$setting['name']] = $setting['value'];
203 break;
204 default: // Shouldn't happen
205 throw new backup_helper_exception('wrong_setting_level_moodle_backup_xml_file', $setting['level']);
206 }
207 }
208
209 return $info;
210 }
211
482aac65
EL
212 /**
213 * Given the information fetched from moodle_backup.xml file
214 * decide if we are restoring in the same site the backup was
215 * generated or no. Behavior of various parts of restore are
216 * dependent of this.
217 *
99a82518
DM
218 * Backups created natively in 2.0 and later declare the hashed
219 * site identifier. Backups created by conversion from a 1.9
220 * backup do not declare such identifier, so there is a fallback
221 * to wwwroot comparison. See MDL-16614.
482aac65
EL
222 */
223 public static function backup_is_samesite($info) {
224 global $CFG;
225 $hashedsiteid = md5(get_site_identifier());
226 if (isset($info->original_site_identifier_hash) && !empty($info->original_site_identifier_hash)) {
227 return $info->original_site_identifier_hash == $hashedsiteid;
228 } else {
229 return $info->original_wwwroot == $CFG->wwwroot;
230 }
231 }
232
f60f4666 233 /**
0164592b 234 * Detects the format of the given unpacked backup directory
f60f4666 235 *
0164592b
DM
236 * @param string $tempdir the name of the backup directory
237 * @return string one of backup::FORMAT_xxx constants
f60f4666
EL
238 */
239 public static function detect_backup_format($tempdir) {
240 global $CFG;
1e2c7351 241 require_once($CFG->dirroot . '/backup/util/helper/convert_helper.class.php');
90338ad1 242
0164592b
DM
243 if (convert_helper::detect_moodle2_format($tempdir)) {
244 return backup::FORMAT_MOODLE;
90338ad1 245 }
f60f4666 246
0164592b 247 // see if a converter can identify the format
383f6f63 248 $converters = convert_helper::available_converters();
0164592b
DM
249 foreach ($converters as $name) {
250 $classname = "{$name}_converter";
251 if (!class_exists($classname)) {
252 throw new coding_exception("available_converters() is supposed to load
253 converter classes but class $classname not found");
f60f4666 254 }
f60f4666 255
0164592b
DM
256 $detected = call_user_func($classname .'::detect_format', $tempdir);
257 if (!empty($detected)) {
258 return $detected;
f60f4666
EL
259 }
260 }
261
f60f4666
EL
262 return backup::FORMAT_UNKNOWN;
263 }
69dd0c8c 264}