MDL-22414 Fixed standard copyright file headers (R0417)
[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
117 $moodlefile = $CFG->dataroot . '/temp/backup/' . $tempdir . '/moodle_backup.xml';
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'];
dc5a2f8a
EL
148 $info->type = $infoarr['details']['detail'][0]['type'];
149 $info->format = $infoarr['details']['detail'][0]['format'];
150 $info->mode = $infoarr['details']['detail'][0]['mode'];
8d4e41f4
EL
151 // Build the role mappings custom object
152 $rolemappings = new stdclass();
153 $rolemappings->modified = false;
154 $rolemappings->mappings = array();
155 $info->role_mappings = $rolemappings;
156
dc5a2f8a
EL
157
158 // Now the contents
159 $contentsarr = $infoarr['contents'];
160 if (isset($contentsarr['course']) && isset($contentsarr['course'][0])) {
161 $info->course = new stdclass();
162 $info->course = (object)$contentsarr['course'][0];
163 $info->course->settings = array();
164 }
165 if (isset($contentsarr['sections']) && isset($contentsarr['sections']['section'])) {
166 $sectionarr = $contentsarr['sections']['section'];
167 $sections = array();
168 foreach ($sectionarr as $section) {
169 $section = (object)$section;
170 $section->settings = array();
171 $sections[basename($section->directory)] = $section;
172 }
173 $info->sections = $sections;
174 }
175 if (isset($contentsarr['activities']) && isset($contentsarr['activities']['activity'])) {
176 $activityarr = $contentsarr['activities']['activity'];
177 $activities = array();
178 foreach ($activityarr as $activity) {
179 $activity = (object)$activity;
180 $activity->settings = array();
181 $activities[basename($activity->directory)] = $activity;
182 }
183 $info->activities = $activities;
184 }
185 $info->root_settings = array(); // For root settings
186
187 // Now the settings, putting each one under its owner
188 $settingsarr = $infoarr['settings']['setting'];
189 foreach($settingsarr as $setting) {
190 switch ($setting['level']) {
191 case 'root':
192 $info->root_settings[$setting['name']] = $setting['value'];
193 break;
194 case 'course':
195 $info->course->settings[$setting['name']] = $setting['value'];
196 break;
197 case 'section':
198 $info->sections[$setting['section']]->settings[$setting['name']] = $setting['value'];
199 break;
200 case 'activity':
201 $info->activities[$setting['activity']]->settings[$setting['name']] = $setting['value'];
202 break;
203 default: // Shouldn't happen
204 throw new backup_helper_exception('wrong_setting_level_moodle_backup_xml_file', $setting['level']);
205 }
206 }
207
208 return $info;
209 }
210
482aac65
EL
211 /**
212 * Given the information fetched from moodle_backup.xml file
213 * decide if we are restoring in the same site the backup was
214 * generated or no. Behavior of various parts of restore are
215 * dependent of this.
216 *
217 * Use site_identifier (hashed) and fallback to wwwroot, thought
218 * any 2.0 backup should have the former. See MDL-16614
219 */
220 public static function backup_is_samesite($info) {
221 global $CFG;
222 $hashedsiteid = md5(get_site_identifier());
223 if (isset($info->original_site_identifier_hash) && !empty($info->original_site_identifier_hash)) {
224 return $info->original_site_identifier_hash == $hashedsiteid;
225 } else {
226 return $info->original_wwwroot == $CFG->wwwroot;
227 }
228 }
229
f60f4666
EL
230 /**
231 * Given one temp/backup/xxx dir, detect its format
232 *
233 * TODO: Move harcoded detection here to delegated classes under backup/format (moodle1, imscc..)
234 * conversion code will be there too.
235 */
236 public static function detect_backup_format($tempdir) {
237 global $CFG;
90338ad1
EL
238 $filepath = $CFG->dataroot . '/temp/backup/' . $tempdir . '/moodle_backup.xml';
239
240 // Does tempdir exist and is dir
241 if (!is_dir(dirname($filepath))) {
242 throw new backup_helper_exception('tmp_backup_directory_not_found', dirname($filepath));
243 }
f60f4666
EL
244
245 // First look for MOODLE (moodle2) format
f60f4666
EL
246 if (file_exists($filepath)) { // Looks promising, lets load some information
247 $handle = fopen ($filepath, "r");
248 $first_chars = fread($handle,200);
249 $status = fclose ($handle);
250 // Check if it has the required strings
251 if (strpos($first_chars,'<?xml version="1.0" encoding="UTF-8"?>') !== false &&
252 strpos($first_chars,'<moodle_backup>') !== false &&
253 strpos($first_chars,'<information>') !== false) {
254 return backup::FORMAT_MOODLE;
255 }
256 }
257
1e8c265c
MN
258 // See if a converter can identify the format as its own
259 $converters = convert_factory::converters($tempdir);
260 foreach ($converters as $name => $converter) {
261 if ($converter->can_convert()) {
262 return $name;
f60f4666
EL
263 }
264 }
265
f60f4666
EL
266 // Arrived here, unknown format
267 return backup::FORMAT_UNKNOWN;
268 }
69dd0c8c 269}