Commit | Line | Data |
---|---|---|
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 | */ | |
32 | abstract 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... | |
119 | throw new backup_helper_exception('missing_moodle_backup_xml_file'); | |
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']; | |
139 | $info->original_wwwroot = $infoarr['original_wwwroot']; | |
140 | $info->original_site_identifier = $infoarr['original_site_identifier']; | |
141 | $info->original_course_id = $infoarr['original_course_id']; | |
142 | $info->type = $infoarr['details']['detail'][0]['type']; | |
143 | $info->format = $infoarr['details']['detail'][0]['format']; | |
144 | $info->mode = $infoarr['details']['detail'][0]['mode']; | |
145 | ||
146 | // Now the contents | |
147 | $contentsarr = $infoarr['contents']; | |
148 | if (isset($contentsarr['course']) && isset($contentsarr['course'][0])) { | |
149 | $info->course = new stdclass(); | |
150 | $info->course = (object)$contentsarr['course'][0]; | |
151 | $info->course->settings = array(); | |
152 | } | |
153 | if (isset($contentsarr['sections']) && isset($contentsarr['sections']['section'])) { | |
154 | $sectionarr = $contentsarr['sections']['section']; | |
155 | $sections = array(); | |
156 | foreach ($sectionarr as $section) { | |
157 | $section = (object)$section; | |
158 | $section->settings = array(); | |
159 | $sections[basename($section->directory)] = $section; | |
160 | } | |
161 | $info->sections = $sections; | |
162 | } | |
163 | if (isset($contentsarr['activities']) && isset($contentsarr['activities']['activity'])) { | |
164 | $activityarr = $contentsarr['activities']['activity']; | |
165 | $activities = array(); | |
166 | foreach ($activityarr as $activity) { | |
167 | $activity = (object)$activity; | |
168 | $activity->settings = array(); | |
169 | $activities[basename($activity->directory)] = $activity; | |
170 | } | |
171 | $info->activities = $activities; | |
172 | } | |
173 | $info->root_settings = array(); // For root settings | |
174 | ||
175 | // Now the settings, putting each one under its owner | |
176 | $settingsarr = $infoarr['settings']['setting']; | |
177 | foreach($settingsarr as $setting) { | |
178 | switch ($setting['level']) { | |
179 | case 'root': | |
180 | $info->root_settings[$setting['name']] = $setting['value']; | |
181 | break; | |
182 | case 'course': | |
183 | $info->course->settings[$setting['name']] = $setting['value']; | |
184 | break; | |
185 | case 'section': | |
186 | $info->sections[$setting['section']]->settings[$setting['name']] = $setting['value']; | |
187 | break; | |
188 | case 'activity': | |
189 | $info->activities[$setting['activity']]->settings[$setting['name']] = $setting['value']; | |
190 | break; | |
191 | default: // Shouldn't happen | |
192 | throw new backup_helper_exception('wrong_setting_level_moodle_backup_xml_file', $setting['level']); | |
193 | } | |
194 | } | |
195 | ||
196 | return $info; | |
197 | } | |
198 | ||
f60f4666 EL |
199 | /** |
200 | * Given one temp/backup/xxx dir, detect its format | |
201 | * | |
202 | * TODO: Move harcoded detection here to delegated classes under backup/format (moodle1, imscc..) | |
203 | * conversion code will be there too. | |
204 | */ | |
205 | public static function detect_backup_format($tempdir) { | |
206 | global $CFG; | |
90338ad1 EL |
207 | $filepath = $CFG->dataroot . '/temp/backup/' . $tempdir . '/moodle_backup.xml'; |
208 | ||
209 | // Does tempdir exist and is dir | |
210 | if (!is_dir(dirname($filepath))) { | |
211 | throw new backup_helper_exception('tmp_backup_directory_not_found', dirname($filepath)); | |
212 | } | |
f60f4666 EL |
213 | |
214 | // First look for MOODLE (moodle2) format | |
f60f4666 EL |
215 | if (file_exists($filepath)) { // Looks promising, lets load some information |
216 | $handle = fopen ($filepath, "r"); | |
217 | $first_chars = fread($handle,200); | |
218 | $status = fclose ($handle); | |
219 | // Check if it has the required strings | |
220 | if (strpos($first_chars,'<?xml version="1.0" encoding="UTF-8"?>') !== false && | |
221 | strpos($first_chars,'<moodle_backup>') !== false && | |
222 | strpos($first_chars,'<information>') !== false) { | |
223 | return backup::FORMAT_MOODLE; | |
224 | } | |
225 | } | |
226 | ||
227 | // Then look for MOODLE1 (moodle1) format | |
228 | $filepath = $CFG->dataroot . '/temp/backup/' . $tempdir . '/moodle.xml'; | |
229 | if (file_exists($filepath)) { // Looks promising, lets load some information | |
230 | $handle = fopen ($filepath, "r"); | |
231 | $first_chars = fread($handle,200); | |
232 | $status = fclose ($handle); | |
233 | // Check if it has the required strings | |
234 | if (strpos($first_chars,'<?xml version="1.0" encoding="UTF-8"?>') !== false && | |
235 | strpos($first_chars,'<MOODLE_BACKUP>') !== false && | |
236 | strpos($first_chars,'<INFO>') !== false) { | |
237 | return backup::FORMAT_MOODLE1; | |
238 | } | |
239 | } | |
240 | ||
241 | // Other formats | |
242 | ||
243 | // Arrived here, unknown format | |
244 | return backup::FORMAT_UNKNOWN; | |
245 | } | |
69dd0c8c | 246 | } |