87d5c7e61f2f957341f19061db163bd92e4ba09a
[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         // Create temp tables
53         restore_controller_dbops::create_restore_temp_tables($controller->get_restoreid());
55         // Check we are restoring one backup >= $min20version (very first ok ever)
56         $min20version = 2010071800;
57         if ($controller->get_info()->backup_version < $min20version) {
58             $message = new stdclass();
59             $message->backup = $controller->get_info()->backup_version;
60             $message->min    = $min20version;
61             $errors[] = get_string('errorminbackup20version', 'backup', $message);
62         }
64         // Compare Moodle's versions
65         if ($CFG->version < $controller->get_info()->moodle_version) {
66             $message = new stdclass();
67             $message->serverversion = $CFG->version;
68             $message->serverrelease = $CFG->release;
69             $message->backupversion = $controller->get_info()->moodle_version;
70             $message->backuprelease = $controller->get_info()->moodle_release;
71             $warnings[] = get_string('noticenewerbackup','',$message);
72         }
74         // Error if restoring over frontpage
75         // TODO: Review the whole restore process in order to transform this into one warning (see 1.9)
76         if ($controller->get_courseid() == SITEID) {
77             $errors[] = get_string('errorrestorefrontpage', 'backup');
78         }
80         // If restoring to different site and restoring users and backup has mnet users warn/error
81         $samesite = $controller->is_samesite();
82         $restoreusers = $controller->get_plan()->get_setting('users')->get_value();
83         $hasmnetusers = (int)$controller->get_info()->mnet_remoteusers;
84         if (!$samesite && $restoreusers && $hasmnetusers) {
85             // User is admin (can create users at sysctx), warn
86             if (has_capability('moodle/user:create', get_context_instance(CONTEXT_SYSTEM), $controller->get_userid())) {
87                 $warnings[] = get_string('mnetrestore_extusers_admin', 'admin');
88             // User not admin
89             } else {
90                 $errors[] = get_string('mnetrestore_extusers_noadmin', 'admin');
91             }
92         }
94         // If restoring users, check we are able to create all them
95         if ($restoreusers) {
96             $file = $controller->get_plan()->get_basepath() . '/users.xml';
97             $restoreid = $controller->get_restoreid();
98             $courseid = $controller->get_courseid();
99             $userid = $controller->get_userid();
100             $inforeffiles = restore_dbops::get_needed_inforef_files($restoreid); // Get all inforef files
101             foreach ($inforeffiles as $inforeffile) {
102                 restore_dbops::load_inforef_to_tempids($restoreid, $inforeffile); // Load each inforef file to temp_ids
103             }
104             restore_dbops::load_users_to_tempids($restoreid, $file); // Load needed users to temp_ids
105             if ($problems = restore_dbops::precheck_included_users($restoreid, $courseid, $userid, $samesite)) {
106                 $errors = array_merge($errors, $problems);
107             }
108         }
110         // TODO: Perform role_mappings, warning about non-mappable ones being ignored (see 1.9)
111         // (restore won't create roles in any case)
113         // Prepare results and return
114         $results = array();
115         if (!empty($errors)) {
116             $results['errors'] = $errors;
117         }
118         if (!empty($warnings)) {
119             $results['warnings'] = $warnings;
120         }
121         // Warnings/errors detected, drop temp tables
122         if (!empty($results)) {
123             restore_controller_dbops::drop_restore_temp_tables($controller->get_restoreid());
124         }
125         return $results;
126     }
129 /*
130  * Exception class used by all the @restore_prechecks_helper stuff
131  */
132 class restore_prechecks_helper_exception extends backup_exception {
134     public function __construct($errorcode, $a=NULL, $debuginfo=null) {
135         parent::__construct($errorcode, $a, $debuginfo);
136     }