MDL-21432 - backup finished groupings restore + introduced role precheck/execution...
[moodle.git] / backup / util / helper / restore_prechecks_helper.class.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  * @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  */
25 /**
26  * Non instantiable helper class providing support for restore prechecks
27  *
28  * This class contains various prechecks to be performed before executing
29  * the restore plan. Its entry point is execute_prechecks() that will
30  * call various stuff. At the end, it will return one array(), if empty
31  * all the prechecks have passed ok. If not empty, you'll find 1/2 elements
32  * in the array, warnings and errors, each one containing one description
33  * of the problem. Warnings aren't stoppers so the restore execution can
34  * continue after displaying them. In the other side, if errors are returned
35  * then restore execution cannot continue
36  *
37  * TODO: Finish phpdocs
38  */
39 abstract class restore_prechecks_helper {
41     /**
42      * Entry point for all the prechecks to be performed before restore
43      *
44      * Returns empty array or warnings/errors array
45      */
46     public static function execute_prechecks($controller) {
47         global $CFG;
49         $errors = array();
50         $warnings = array();
52         // Some handy vars to be used along the prechecks
53         $samesite = $controller->is_samesite();
54         $restoreusers = $controller->get_plan()->get_setting('users')->get_value();
55         $hasmnetusers = (int)$controller->get_info()->mnet_remoteusers;
56         $restoreid = $controller->get_restoreid();
57         $courseid = $controller->get_courseid();
58         $userid = $controller->get_userid();
59         $inforeffiles = restore_dbops::get_needed_inforef_files($restoreid); // Get all inforef files
61         // Create temp tables
62         restore_controller_dbops::create_restore_temp_tables($controller->get_restoreid());
64         // Check we are restoring one backup >= $min20version (very first ok ever)
65         $min20version = 2010071800;
66         if ($controller->get_info()->backup_version < $min20version) {
67             $message = new stdclass();
68             $message->backup = $controller->get_info()->backup_version;
69             $message->min    = $min20version;
70             $errors[] = get_string('errorminbackup20version', 'backup', $message);
71         }
73         // Compare Moodle's versions
74         if ($CFG->version < $controller->get_info()->moodle_version) {
75             $message = new stdclass();
76             $message->serverversion = $CFG->version;
77             $message->serverrelease = $CFG->release;
78             $message->backupversion = $controller->get_info()->moodle_version;
79             $message->backuprelease = $controller->get_info()->moodle_release;
80             $warnings[] = get_string('noticenewerbackup','',$message);
81         }
83         // Error if restoring over frontpage
84         // TODO: Review the whole restore process in order to transform this into one warning (see 1.9)
85         if ($controller->get_courseid() == SITEID) {
86             $errors[] = get_string('errorrestorefrontpage', 'backup');
87         }
89         // If restoring to different site and restoring users and backup has mnet users warn/error
90         if (!$samesite && $restoreusers && $hasmnetusers) {
91             // User is admin (can create users at sysctx), warn
92             if (has_capability('moodle/user:create', get_context_instance(CONTEXT_SYSTEM), $controller->get_userid())) {
93                 $warnings[] = get_string('mnetrestore_extusers_admin', 'admin');
94             // User not admin
95             } else {
96                 $errors[] = get_string('mnetrestore_extusers_noadmin', 'admin');
97             }
98         }
100         // Load all the inforef files, we are going to need them
101         foreach ($inforeffiles as $inforeffile) {
102             restore_dbops::load_inforef_to_tempids($restoreid, $inforeffile); // Load each inforef file to temp_ids
103         }
105         // If restoring users, check we are able to create all them
106         if ($restoreusers) {
107             $file = $controller->get_plan()->get_basepath() . '/users.xml';
108             restore_dbops::load_users_to_tempids($restoreid, $file); // Load needed users to temp_ids
109             if ($problems = restore_dbops::precheck_included_users($restoreid, $courseid, $userid, $samesite)) {
110                 $errors = array_merge($errors, $problems);
111             }
112         }
114         // TODO: Perform role_mappings, warning about non-mappable ones being ignored (see 1.9)
115         // Note: restore won't create roles at all. Only mapping/skip!
116         $file = $controller->get_plan()->get_basepath() . '/roles.xml';
117         restore_dbops::load_roles_to_tempids($restoreid, $file); // Load needed users to temp_ids
118         if ($problems = restore_dbops::precheck_included_roles($restoreid, $courseid, $userid, $samesite)) {
119             $errors = array_key_exists('errors', $problems) ? array_merge($errors, $problems['errors']) : $errors;
120             $warnings = array_key_exists('warnings', $problems) ? array_merge($warnings, $problems['warnings']) : $warnings;
121         }
123         // Prepare results and return
124         $results = array();
125         if (!empty($errors)) {
126             $results['errors'] = $errors;
127         }
128         if (!empty($warnings)) {
129             $results['warnings'] = $warnings;
130         }
131         // Warnings/errors detected, drop temp tables
132         if (!empty($results)) {
133             restore_controller_dbops::drop_restore_temp_tables($controller->get_restoreid());
134         }
135         return $results;
136     }
139 /*
140  * Exception class used by all the @restore_prechecks_helper stuff
141  */
142 class restore_prechecks_helper_exception extends backup_exception {
144     public function __construct($errorcode, $a=NULL, $debuginfo=null) {
145         parent::__construct($errorcode, $a, $debuginfo);
146     }