backup/util/helper/backup_general_helper.class.php

   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 defined('MOODLE_INTERNAL') || die();
  26
  27 /**
  28  * Non instantiable helper class providing general helper methods for backup/restore
  29  *
  30  * This class contains various general helper static methods available for backup/restore
  31  *
  32  * TODO: Finish phpdocs
  33  */
  34 abstract class backup_general_helper extends backup_helper {
  35
  36     /**
  37      * Calculate one checksum for any array/object. Works recursively
  38      */
  39     public static function array_checksum_recursive($arr) {
  40
  41         $checksum = ''; // Init checksum
  42
  43         // Check we are going to process one array always, objects must be cast before
  44         if (!is_array($arr)) {
  45             throw new backup_helper_exception('array_expected');
  46         }
  47         foreach ($arr as $key => $value) {
  48             if ($value instanceof checksumable) {
  49                 $checksum = md5($checksum . '-' . $key . '-' . $value->calculate_checksum());
  50             } else if (is_object($value)) {
  51                 $checksum = md5($checksum . '-' . $key . '-' . self::array_checksum_recursive((array)$value));
  52             } else if (is_array($value)) {
  53                 $checksum = md5($checksum . '-' . $key . '-' . self::array_checksum_recursive($value));
  54             } else {
  55                 $checksum = md5($checksum . '-' . $key . '-' . $value);
  56             }
  57         }
  58         return $checksum;
  59     }
  60
  61     /**
  62      * Load all the blocks information needed for a given path within moodle2 backup
  63      *
  64      * This function, given one full path (course, activities/xxxx) will look for all the
  65      * blocks existing in the backup file, returning one array used to build the
  66      * proper restore plan by the @restore_plan_builder
  67      */
  68     public static function get_blocks_from_path($path) {
  69         global $DB;
  70
  71         $blocks = array(); // To return results
  72
  73         static $availableblocks = array(); // Get and cache available blocks
  74         if (empty($availableblocks)) {
  75             $availableblocks = array_keys(core_component::get_plugin_list('block'));
  76         }
  77
  78         $path = $path . '/blocks'; // Always look under blocks subdir
  79
  80         if (!is_dir($path)) {
  81             return array();
  82         }
  83
  84         if (!$dir = opendir($path)) {
  85             return array();
  86         }
  87         while (false !== ($file = readdir($dir))) {
  88             if ($file == '.' || $file == '..') { // Skip dots
  89                 continue;
  90             }
  91             if (is_dir($path .'/' . $file)) { // Dir found, check it's a valid block
  92                 if (!file_exists($path .'/' . $file . '/block.xml')) { // Skip if xml file not found
  93                     continue;
  94                 }
  95                 // Extract block name
  96                 $blockname = preg_replace('/(.*)_\d+/', '\\1', $file);
  97                 // Check block exists and is installed
  98                 if (in_array($blockname, $availableblocks) && $DB->record_exists('block', array('name' => $blockname))) {
  99                     $blocks[$path .'/' . $file] = $blockname;
 100                 }
 101             }
 102         }
 103         closedir($dir);
 104
 105         return $blocks;
 106     }
 107
 108     /**
 109      * Load and format all the needed information from moodle_backup.xml
 110      *
 111      * This function loads and process all the moodle_backup.xml
 112      * information, composing a big information structure that will
 113      * be the used by the plan builder in order to generate the
 114      * appropiate tasks / steps / settings
 115      */
 116     public static function get_backup_information($tempdir) {
 117         global $CFG;
 118
 119         $info = new stdclass(); // Final information goes here
 120
 121         $moodlefile = $CFG->tempdir . '/backup/' . $tempdir . '/moodle_backup.xml';
 122         if (!file_exists($moodlefile)) { // Shouldn't happen ever, but...
 123             throw new backup_helper_exception('missing_moodle_backup_xml_file', $moodlefile);
 124         }
 125         // Load the entire file to in-memory array
 126         $xmlparser = new progressive_parser();
 127         $xmlparser->set_file($moodlefile);
 128         $xmlprocessor = new restore_moodlexml_parser_processor();
 129         $xmlparser->set_processor($xmlprocessor);
 130         $xmlparser->process();
 131         $infoarr = $xmlprocessor->get_all_chunks();
 132         if (count($infoarr) !== 1) { // Shouldn't happen ever, but...
 133             throw new backup_helper_exception('problem_parsing_moodle_backup_xml_file');
 134         }
 135         $infoarr = $infoarr[0]['tags']; // for commodity
 136
 137         // Let's build info
 138         $info->moodle_version = $infoarr['moodle_version'];
 139         $info->moodle_release = $infoarr['moodle_release'];
 140         $info->backup_version = $infoarr['backup_version'];
 141         $info->backup_release = $infoarr['backup_release'];
 142         $info->backup_date    = $infoarr['backup_date'];
 143         $info->mnet_remoteusers         = $infoarr['mnet_remoteusers'];
 144         $info->original_wwwroot         = $infoarr['original_wwwroot'];
 145         $info->original_site_identifier_hash = $infoarr['original_site_identifier_hash'];
 146         $info->original_course_id       = $infoarr['original_course_id'];
 147         $info->original_course_fullname = $infoarr['original_course_fullname'];
 148         $info->original_course_shortname= $infoarr['original_course_shortname'];
 149         $info->original_course_startdate= $infoarr['original_course_startdate'];
 150         $info->original_course_contextid= $infoarr['original_course_contextid'];
 151         $info->original_system_contextid= $infoarr['original_system_contextid'];
 152         // Moodle backup file don't have this option before 2.3
 153         if (!empty($infoarr['include_file_references_to_external_content'])) {
 154             $info->include_file_references_to_external_content = 1;
 155         } else {
 156             $info->include_file_references_to_external_content = 0;
 157         }
 158         // Introduced in Moodle 2.9.
 159         $info->original_course_format = '';
 160         if (!empty($infoarr['original_course_format'])) {
 161             $info->original_course_format = $infoarr['original_course_format'];
 162         }
 163         // include_files is a new setting in 2.6.
 164         if (isset($infoarr['include_files'])) {
 165             $info->include_files = $infoarr['include_files'];
 166         } else {
 167             $info->include_files = 1;
 168         }
 169         $info->type   =  $infoarr['details']['detail'][0]['type'];
 170         $info->format =  $infoarr['details']['detail'][0]['format'];
 171         $info->mode   =  $infoarr['details']['detail'][0]['mode'];
 172         // Build the role mappings custom object
 173         $rolemappings = new stdclass();
 174         $rolemappings->modified = false;
 175         $rolemappings->mappings = array();
 176         $info->role_mappings = $rolemappings;
 177         // Some initially empty containers
 178         $info->sections = array();
 179         $info->activities = array();
 180
 181         // Now the contents
 182         $contentsarr = $infoarr['contents'];
 183         if (isset($contentsarr['course']) && isset($contentsarr['course'][0])) {
 184             $info->course = new stdclass();
 185             $info->course = (object)$contentsarr['course'][0];
 186             $info->course->settings = array();
 187         }
 188         if (isset($contentsarr['sections']) && isset($contentsarr['sections']['section'])) {
 189             $sectionarr = $contentsarr['sections']['section'];
 190             foreach ($sectionarr as $section) {
 191                 $section = (object)$section;
 192                 $section->settings = array();
 193                 $sections[basename($section->directory)] = $section;
 194             }
 195             $info->sections = $sections;
 196         }
 197         if (isset($contentsarr['activities']) && isset($contentsarr['activities']['activity'])) {
 198             $activityarr = $contentsarr['activities']['activity'];
 199             foreach ($activityarr as $activity) {
 200                 $activity = (object)$activity;
 201                 $activity->settings = array();
 202                 $activities[basename($activity->directory)] = $activity;
 203             }
 204             $info->activities = $activities;
 205         }
 206         $info->root_settings = array(); // For root settings
 207
 208         // Now the settings, putting each one under its owner
 209         $settingsarr = $infoarr['settings']['setting'];
 210         foreach($settingsarr as $setting) {
 211             switch ($setting['level']) {
 212                 case 'root':
 213                     $info->root_settings[$setting['name']] = $setting['value'];
 214                     break;
 215                 case 'course':
 216                     $info->course->settings[$setting['name']] = $setting['value'];
 217                     break;
 218                 case 'section':
 219                     $info->sections[$setting['section']]->settings[$setting['name']] = $setting['value'];
 220                     break;
 221                 case 'activity':
 222                     $info->activities[$setting['activity']]->settings[$setting['name']] = $setting['value'];
 223                     break;
 224                 default: // Shouldn't happen
 225                     throw new backup_helper_exception('wrong_setting_level_moodle_backup_xml_file', $setting['level']);
 226             }
 227         }
 228
 229         return $info;
 230     }
 231
 232     /**
 233      * Load and format all the needed information from a backup file.
 234      *
 235      * This will only extract the moodle_backup.xml file from an MBZ
 236      * file and then call {@link self::get_backup_information()}.
 237      *
 238      * This can be a long-running (multi-minute) operation for large backups.
 239      * Pass a $progress value to receive progress updates.
 240      *
 241      * @param string $filepath absolute path to the MBZ file.
 242      * @param file_progress $progress Progress updates
 243      * @return stdClass containing information.
 244      * @since Moodle 2.4
 245      */
 246     public static function get_backup_information_from_mbz($filepath, file_progress $progress = null) {
 247         global $CFG;
 248         if (!is_readable($filepath)) {
 249             throw new backup_helper_exception('missing_moodle_backup_file', $filepath);
 250         }
 251
 252         // Extract moodle_backup.xml.
 253         $tmpname = 'info_from_mbz_' . time() . '_' . random_string(4);
 254         $tmpdir = $CFG->tempdir . '/backup/' . $tmpname;
 255         $fp = get_file_packer('application/vnd.moodle.backup');
 256
 257         $extracted = $fp->extract_to_pathname($filepath, $tmpdir, array('moodle_backup.xml'), $progress);
 258         $moodlefile =  $tmpdir . '/' . 'moodle_backup.xml';
 259         if (!$extracted || !is_readable($moodlefile)) {
 260             throw new backup_helper_exception('missing_moodle_backup_xml_file', $moodlefile);
 261         }
 262
 263         // Read the information and delete the temporary directory.
 264         $info = self::get_backup_information($tmpname);
 265         remove_dir($tmpdir);
 266         return $info;
 267     }
 268
 269     /**
 270      * Given the information fetched from moodle_backup.xml file
 271      * decide if we are restoring in the same site the backup was
 272      * generated or no. Behavior of various parts of restore are
 273      * dependent of this.
 274      *
 275      * Backups created natively in 2.0 and later declare the hashed
 276      * site identifier. Backups created by conversion from a 1.9
 277      * backup do not declare such identifier, so there is a fallback
 278      * to wwwroot comparison. See MDL-16614.
 279      */
 280     public static function backup_is_samesite($info) {
 281         global $CFG;
 282         $hashedsiteid = md5(get_site_identifier());
 283         if (isset($info->original_site_identifier_hash) && !empty($info->original_site_identifier_hash)) {
 284             return $info->original_site_identifier_hash == $hashedsiteid;
 285         } else {
 286             return $info->original_wwwroot == $CFG->wwwroot;
 287         }
 288     }
 289
 290     /**
 291      * Detects the format of the given unpacked backup directory
 292      *
 293      * @param string $tempdir the name of the backup directory
 294      * @return string one of backup::FORMAT_xxx constants
 295      */
 296     public static function detect_backup_format($tempdir) {
 297         global $CFG;
 298         require_once($CFG->dirroot . '/backup/util/helper/convert_helper.class.php');
 299
 300         if (convert_helper::detect_moodle2_format($tempdir)) {
 301             return backup::FORMAT_MOODLE;
 302         }
 303
 304         // see if a converter can identify the format
 305         $converters = convert_helper::available_converters();
 306         foreach ($converters as $name) {
 307             $classname = "{$name}_converter";
 308             if (!class_exists($classname)) {
 309                 throw new coding_exception("available_converters() is supposed to load
 310                     converter classes but class $classname not found");
 311             }
 312
 313             $detected = call_user_func($classname .'::detect_format', $tempdir);
 314             if (!empty($detected)) {
 315                 return $detected;
 316             }
 317         }
 318
 319         return backup::FORMAT_UNKNOWN;
 320     }
 321 }