286960b4099c1ca4cfaacad3f492effe0adb3c2d
[moodle.git] / backup / util / dbops / restore_dbops.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-dbops
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  * Base abstract class for all the helper classes providing DB operations
27  *
28  * TODO: Finish phpdocs
29  */
30 abstract class restore_dbops {
32     /**
33      * Return all the inforef.xml files to be loaded into the temp_ids table
34      * We do that by loading the controller from DB, then iterating over all the
35      * included tasks and calculating all the inforef files for them
36      */
37     public static function get_needed_inforef_files($restoreid) {
38         $rc = restore_controller_dbops::load_controller($restoreid);
39         $tasks = $rc->get_plan()->get_tasks();
40         $files = array();
41         foreach ($tasks as $task) {
42             // Calculate if the task is being included
43             $included = false;
44             // blocks, based in blocks setting and parent activity/course
45             if ($task instanceof restore_block_task) {
46                 if (!$task->get_setting_value('blocks')) { // Blocks not included, continue
47                     continue;
48                 }
49                 $parent = basename(dirname(dirname($task->get_taskbasepath())));
50                 if ($parent == 'course') { // Parent is course, always included if present
51                     $included = true;
53                 } else { // Look for activity_included setting
54                     $included = $task->get_setting_value($parent . '_included');
55                 }
57             // ativities, based on included setting
58             } else if ($task instanceof restore_activity_task) {
59                 $included = $task->get_setting_value('included');
61             // sections, based on included setting
62             } else if ($task instanceof restore_section_task) {
63                 $included = $task->get_setting_value('included');
65             // course always included if present
66             } else if ($task instanceof restore_course_task) {
67                 $included = true;
68             }
70             // If included and file exists, add it to results
71             if ($included) {
72                 $inforefpath = $task->get_taskbasepath() . '/inforef.xml';
73                 if (file_exists($inforefpath)) {
74                     $files[] = $inforefpath;
75                 }
76             }
77         }
78         return $files;
79     }
81     /**
82      * Load one inforef.xml file to backup_ids table for future reference
83      */
84     public static function load_inforef_to_tempids($restoreid, $inforeffile) {
86         if (!file_exists($inforeffile)) { // Shouldn't happen ever, but...
87             throw new backup_helper_exception('missing_inforef_xml_file', $inforeffile);
88         }
89         // Let's parse, custom processor will do its work, sending info to DB
90         $xmlparser = new progressive_parser();
91         $xmlparser->set_file($inforeffile);
92         $xmlprocessor = new restore_inforef_parser_processor($restoreid);
93         $xmlparser->set_processor($xmlprocessor);
94         $xmlparser->process();
95     }
97     /**
98      * Load the needed role.xml file to backup_ids table for future reference
99      */
100     public static function load_roles_to_tempids($restoreid, $rolesfile) {
102         if (!file_exists($rolesfile)) { // Shouldn't happen ever, but...
103             throw new backup_helper_exception('missing_roles_xml_file', $rolesfile);
104         }
105         // Let's parse, custom processor will do its work, sending info to DB
106         $xmlparser = new progressive_parser();
107         $xmlparser->set_file($rolesfile);
108         $xmlprocessor = new restore_roles_parser_processor($restoreid);
109         $xmlparser->set_processor($xmlprocessor);
110         $xmlparser->process();
111     }
113     /**
114      * Precheck the loaded roles, return empty array if everything is ok, and
115      * array with 'errors', 'warnings' elements (suitable to be used by restore_prechecks)
116      * with any problem found. At the same time, store all the mapping into backup_ids_temp
117      * and also put the information into $rolemappings (controller->info), so it can be reworked later by
118      * post-precheck stages while at the same time accept modified info in the same object coming from UI
119      */
120     public static function precheck_included_roles($restoreid, $courseid, $userid, $samesite, $rolemappings) {
121         global $DB;
123         $problems = array(); // To store warnings/errors
125         // Get loaded roles from backup_ids
126         $rs = $DB->get_recordset('backup_ids_temp', array('backupid' => $restoreid, 'itemname' => 'role'), '', 'itemid');
127         foreach ($rs as $recrole) {
128             // If the rolemappings->modified flag is set, that means that we are coming from
129             // manually modified mappings (by UI), so accept those mappings an put them to backup_ids
130             if ($rolemappings->modified) {
131                 $target = $rolemappings->mappings[$recrole->itemid]->targetroleid;
132                 self::set_backup_ids_record($restoreid, 'role', $recrole->itemid, $target);
134             // Else, we haven't any info coming from UI, let's calculate the mappings, matching
135             // in multiple ways and checking permissions. Note mapping to 0 means "skip"
136             } else {
137                 $role = (object)self::get_backup_ids_record($restoreid, 'role', $recrole->itemid)->info;
138                 $match = self::get_best_assignable_role($role, $courseid, $userid, $samesite);
139                 // Send match to backup_ids
140                 self::set_backup_ids_record($restoreid, 'role', $recrole->itemid, $match);
141                 // Build the rolemappings element for controller
142                 unset($role->id);
143                 unset($role->nameincourse);
144                 unset($role->nameincourse);
145                 $role->targetroleid = $match;
146                 $rolemappings->mappings[$recrole->itemid] = $role;
147                 // Prepare warning if no match found
148                 if (!$match) {
149                     $problems['warnings'][] = get_string('cannotfindassignablerole', 'backup', $role->name);
150                 }
151             }
152         }
153         $rs->close();
154         return $problems;
155     }
157     /**
158      * Given one role, as loaded from XML, perform the best possible matching against the assignable
159      * roles, using different fallback alternatives (shortname, archetype, editingteacher => teacher, defaultcourseroleid)
160      * returning the id of the best matching role or 0 if no match is found
161      */
162     protected static function get_best_assignable_role($role, $courseid, $userid, $samesite) {
163         global $CFG, $DB;
165         // Gather various information about roles
166         $coursectx = get_context_instance(CONTEXT_COURSE, $courseid);
167         $allroles = $DB->get_records('role');
168         $assignablerolesshortname = get_assignable_roles($coursectx, ROLENAME_SHORT, false, $userid);
170         // Note: under 1.9 we had one function restore_samerole() that performed one complete
171         // matching of roles (all caps) and if match was found the mapping was availabe bypassing
172         // any assignable_roles() security. IMO that was wrong and we must not allow such
173         // mappings anymore. So we have left that matching strategy out in 2.0
175         // Empty assignable roles, mean no match possible
176         if (empty($assignablerolesshortname)) {
177             return 0;
178         }
180         // Match by shortname
181         if ($match = array_search($role->shortname, $assignablerolesshortname)) {
182             return $match;
183         }
185         // Match by archetype
186         list($in_sql, $in_params) = $DB->get_in_or_equal(array_keys($assignablerolesshortname));
187         $params = array_merge(array($role->archetype), $in_params);
188         if ($rec = $DB->get_record_select('role', "archetype = ? AND id $in_sql", $params, 'id', IGNORE_MULTIPLE)) {
189             return $rec->id;
190         }
192         // Match editingteacher to teacher (happens a lot, from 1.9)
193         if ($role->shortname == 'editingteacher' && in_array('teacher', $assignablerolesshortname)) {
194             return array_search('teacher', $assignablerolesshortname);
195         }
197         // No match, return 0
198         return 0;
199     }
202     /**
203      * Process the loaded roles, looking for their best mapping or skipping
204      * Any error will cause exception. Note this is one wrapper over
205      * precheck_included_roles, that contains all the logic, but returns
206      * errors/warnings instead and is executed as part of the restore prechecks
207      */
208      public static function process_included_roles($restoreid, $courseid, $userid, $samesite, $rolemappings) {
209         global $DB;
211         // Just let precheck_included_roles() to do all the hard work
212         $problems = self::precheck_included_roles($restoreid, $courseid, $userid, $samesite, $rolemappings);
214         // With problems of type error, throw exception, shouldn't happen if prechecks executed
215         if (array_key_exists('errors', $problems)) {
216             throw new restore_dbops_exception('restore_problems_processing_roles', null, implode(', ', $problems['errors']));
217         }
218     }
220     /**
221      * Load the needed users.xml file to backup_ids table for future reference
222      */
223     public static function load_users_to_tempids($restoreid, $usersfile) {
225         if (!file_exists($usersfile)) { // Shouldn't happen ever, but...
226             throw new backup_helper_exception('missing_users_xml_file', $usersfile);
227         }
228         // Let's parse, custom processor will do its work, sending info to DB
229         $xmlparser = new progressive_parser();
230         $xmlparser->set_file($usersfile);
231         $xmlprocessor = new restore_users_parser_processor($restoreid);
232         $xmlparser->set_processor($xmlprocessor);
233         $xmlparser->process();
234     }
236     /**
237      * Given one component/filearea/context and
238      * optionally one source itemname to match itemids
239      * put the corresponding files in the pool
240      */
241     public static function send_files_to_pool($basepath, $restoreid, $component, $filearea, $oldcontextid, $dfltuserid, $itemname = null) {
242         global $DB;
244         // Get new context, must exist or this will fail
245         if (!$newcontextid = self::get_backup_ids_record($restoreid, 'context', $oldcontextid)->newitemid) {
246             throw new restore_dbops_exception('unknown_context_mapping', $oldcontextid);
247         }
249         // Important: remember how files have been loaded to backup_ids_temp
250         //   - info: contains the whole original object (times, names...)
251         //   (all them being original ids as loaded from xml)
253         // itemname = null, we are going to match only by context, no need to use itemid (all them are 0)
254         if ($itemname == null) {
255             $sql = 'SELECT contextid, component, filearea, itemid, itemid AS newitemid, info
256                       FROM {backup_files_temp}
257                      WHERE backupid = ?
258                        AND contextid = ?
259                        AND component = ?
260                        AND filearea  = ?';
261             $params = array($restoreid, $oldcontextid, $component, $filearea);
263         // itemname not null, going to join with backup_ids to perform the old-new mapping of itemids
264         } else {
265             $sql = 'SELECT f.contextid, f.component, f.filearea, f.itemid, i.newitemid, f.info
266                       FROM {backup_files_temp} f
267                       JOIN {backup_ids_temp} i ON i.backupid = f.backupid
268                                               AND i.parentitemid = f.contextid
269                                               AND i.itemid = f.itemid
270                      WHERE f.backupid = ?
271                        AND f.contextid = ?
272                        AND f.component = ?
273                        AND f.filearea = ?
274                        AND i.itemname = ?';
275             $params = array($restoreid, $oldcontextid, $component, $filearea, $itemname);
276         }
278         $fs = get_file_storage();         // Get moodle file storage
279         $basepath = $basepath . '/files/';// Get backup file pool base
280         $rs = $DB->get_recordset_sql($sql, $params);
281         foreach ($rs as $rec) {
282             $file = (object)unserialize(base64_decode($rec->info));
283             // ignore root dirs (they are created automatically)
284             if ($file->filepath == '/' && $file->filename == '.') {
285                 continue;
286             }
287             // set the best possible user
288             $mappeduser = self::get_backup_ids_record($restoreid, 'user', $file->userid);
289             $file->userid = !empty($mappeduser) ? $mappeduser->newitemid : $dfltuserid;
290             // dir found (and not root one), let's create if
291             if ($file->filename == '.') {
292                 $fs->create_directory($newcontextid, $component, $filearea, $rec->newitemid, $file->filepath, $file->userid);
293                 continue;
294             }
295             // arrived here, file found
296             // Find file in backup pool
297             $backuppath = $basepath . backup_file_manager::get_content_file_location($file->contenthash);
298             if (!file_exists($backuppath)) {
299                 throw new restore_dbops_exception('file_not_found_in_pool', $file);
300             }
301             if (!$fs->file_exists($newcontextid, $component, $filearea, $rec->newitemid, $file->filepath, $file->filename)) {
302                 $file_record = array(
303                     'contextid'   => $newcontextid,
304                     'component'   => $component,
305                     'filearea'    => $filearea,
306                     'itemid'      => $rec->newitemid,
307                     'filepath'    => $file->filepath,
308                     'filename'    => $file->filename,
309                     'timecreated' => $file->timecreated,
310                     'timemodified'=> $file->timemodified,
311                     'userid'      => $file->userid,
312                     'author'      => $file->author,
313                     'license'     => $file->license,
314                     'sortorder'   => $file->sortorder);
315                 $fs->create_file_from_pathname($file_record, $backuppath);
316             }
317         }
318         $rs->close();
319     }
321     /**
322      * Given one restoreid, create in DB all the users present
323      * in backup_ids having newitemid = 0, as far as
324      * precheck_included_users() have left them there
325      * ready to be created. Also, annotate their newids
326      * once created for later reference
327      */
328     public static function create_included_users($basepath, $restoreid, $userfiles) {
329         global $CFG, $DB;
331         $authcache = array(); // Cache to get some bits from authentication plugins
332         $languages = get_string_manager()->get_list_of_translations(); // Get languages for quick search later
333         $themes    = get_list_of_themes(); // Get themes for quick search later
335         // Iterate over all the included users with newitemid = 0, have to create them
336         $rs = $DB->get_recordset('backup_ids_temp', array('backupid' => $restoreid, 'itemname' => 'user', 'newitemid' => 0), '', 'itemid, parentitemid');
337         foreach ($rs as $recuser) {
338             $user = (object)self::get_backup_ids_record($restoreid, 'user', $recuser->itemid)->info;
340             // if user lang doesn't exist here, use site default
341             if (!array_key_exists($user->lang, $languages)) {
342                 $user->lang = $CFG->lang;
343             }
345             // if user theme isn't available on target site or they are disabled, reset theme
346             if (!empty($user->theme)) {
347                 if (empty($CFG->allowuserthemes) || !in_array($user->theme, $themes)) {
348                     $user->theme = '';
349                 }
350             }
352             // if user to be created has mnet auth and its mnethostid is $CFG->mnet_localhost_id
353             // that's 100% impossible as own server cannot be accesed over mnet. Change auth to email/manual
354             if ($user->auth == 'mnet' && $user->mnethostid == $CFG->mnet_localhost_id) {
355                 // Respect registerauth
356                 if ($CFG->registerauth == 'email') {
357                     $user->auth = 'email';
358                 } else {
359                     $user->auth = 'manual';
360                 }
361             }
362             unset($user->mnethosturl); // Not needed anymore
364             // Disable pictures based on global setting
365             if (!empty($CFG->disableuserimages)) {
366                 $user->picture = 0;
367             }
369             // We need to analyse the AUTH field to recode it:
370             //   - if the auth isn't enabled in target site, $CFG->registerauth will decide
371             //   - finally, if the auth resulting isn't enabled, default to 'manual'
372             if (!is_enabled_auth($user->auth)) {
373                 if ($CFG->registerauth == 'email') {
374                     $user->auth = 'email';
375                 } else {
376                     $user->auth = 'manual';
377                 }
378             }
379             if (!is_enabled_auth($user->auth)) { // Final auth check verify, default to manual if not enabled
380                 $user->auth = 'manual';
381             }
383             // Now that we know the auth method, for users to be created without pass
384             // if password handling is internal and reset password is available
385             // we set the password to "restored" (plain text), so the login process
386             // will know how to handle that situation in order to allow the user to
387             // recover the password. MDL-20846
388             if (empty($user->password)) { // Only if restore comes without password
389                 if (!array_key_exists($user->auth, $authcache)) { // Not in cache
390                     $userauth = new stdClass();
391                     $authplugin = get_auth_plugin($user->auth);
392                     $userauth->preventpassindb = $authplugin->prevent_local_passwords();
393                     $userauth->isinternal      = $authplugin->is_internal();
394                     $userauth->canresetpwd     = $authplugin->can_reset_password();
395                     $authcache[$user->auth] = $userauth;
396                 } else {
397                     $userauth = $authcache[$user->auth]; // Get from cache
398                 }
400                 // Most external plugins do not store passwords locally
401                 if (!empty($userauth->preventpassindb)) {
402                     $user->password = 'not cached';
404                 // If Moodle is responsible for storing/validating pwd and reset functionality is available, mark
405                 } else if ($userauth->isinternal and $userauth->canresetpwd) {
406                     $user->password = 'restored';
407                 }
408             }
410             // Creating new user, we must reset the policyagreed always
411             $user->policyagreed = 0;
413             // Set time created if empty
414             if (empty($user->timecreated)) {
415                 $user->timecreated = time();
416             }
418             // Done, let's create the user and annotate its id
419             $newuserid = $DB->insert_record('user', $user);
420             self::set_backup_ids_record($restoreid, 'user', $recuser->itemid, $newuserid);
421             // Let's create the user context and annotate it (we need it for sure at least for files)
422             $newuserctxid = get_context_instance(CONTEXT_USER, $newuserid)->id;
423             self::set_backup_ids_record($restoreid, 'context', $recuser->parentitemid, $newuserctxid);
425             // Process custom fields
426             if (isset($user->custom_fields)) { // if present in backup
427                 foreach($user->custom_fields['custom_field'] as $udata) {
428                     $udata = (object)$udata;
429                     // If the profile field has data and the profile shortname-datatype is defined in server
430                     if ($udata->field_data) {
431                         if ($field = $DB->get_record('user_info_field', array('shortname'=>$udata->field_name, 'datatype'=>$udata->field_type))) {
432                         /// Insert the user_custom_profile_field
433                             $rec = new object();
434                             $rec->userid  = $newuserid;
435                             $rec->fieldid = $field->id;
436                             $rec->data    = $udata->field_data;
437                             $DB->insert_record('user_info_data', $rec);
438                         }
439                     }
440                 }
441             }
443             // Process tags
444             if (!empty($CFG->usetags) && isset($user->tags)) { // if enabled in server and present in backup
445                 $tags = array();
446                 foreach($user->tags['tag'] as $usertag) {
447                     $usertag = (object)$usertag;
448                     $tags[] = $usertag->rawname;
449                 }
450                 tag_set('user', $newuserid, $tags);
451             }
453             // Process preferences
454             if (isset($user->preferences)) { // if present in backup
455                 foreach($user->preferences['preference'] as $preference) {
456                     $preference = (object)$preference;
457                     // Prepare the record and insert it
458                     $preference->userid = $newuserid;
459                     $status = $DB->insert_record('user_preferences', $preference);
460                 }
461             }
463             // Create user files in pool (profile, icon, private) by context
464             restore_dbops::send_files_to_pool($basepath, $restoreid, 'user', 'icon', $recuser->parentitemid);
465             restore_dbops::send_files_to_pool($basepath, $restoreid, 'user', 'profile', $recuser->parentitemid);
466             if ($userfiles) { // private files only if enabled in settings
467                 restore_dbops::send_files_to_pool($basepath, $restoreid, 'user', 'private', $recuser->parentitemid);
468             }
470         }
471         $rs->close();
472     }
474     /**
475     * Given one user object (from backup file), perform all the neccesary
476     * checks is order to decide how that user will be handled on restore.
477     *
478     * Note the function requires $user->mnethostid to be already calculated
479     * so it's caller responsibility to set it
480     *
481     * This function is used both by @restore_precheck_users() and
482     * @restore_create_users() to get consistent results in both places
483     *
484     * It returns:
485     *   - one user object (from DB), if match has been found and user will be remapped
486     *   - boolean true if the user needs to be created
487     *   - boolean false if some conflict happened and the user cannot be handled
488     *
489     * Each test is responsible for returning its results and interrupt
490     * execution. At the end, boolean true (user needs to be created) will be
491     * returned if no test has interrupted that.
492     *
493     * Here it's the logic applied, keep it updated:
494     *
495     *  If restoring users from same site backup:
496     *      1A - Normal check: If match by id and username and mnethost  => ok, return target user
497     *      1B - Handle users deleted in DB and "alive" in backup file:
498     *           If match by id and mnethost and user is deleted in DB and
499     *           (match by username LIKE 'backup_email.%' or by non empty email = md5(username)) => ok, return target user
500     *      1C - Handle users deleted in backup file and "alive" in DB:
501     *           If match by id and mnethost and user is deleted in backup file
502     *           and match by email = email_without_time(backup_email) => ok, return target user
503     *      1D - Conflict: If match by username and mnethost and doesn't match by id => conflict, return false
504     *      1E - None of the above, return true => User needs to be created
505     *
506     *  if restoring from another site backup (cannot match by id here, replace it by email/firstaccess combination):
507     *      2A - Normal check: If match by username and mnethost and (email or non-zero firstaccess) => ok, return target user
508     *      2B - Handle users deleted in DB and "alive" in backup file:
509     *           2B1 - If match by mnethost and user is deleted in DB and not empty email = md5(username) and
510     *                 (username LIKE 'backup_email.%' or non-zero firstaccess) => ok, return target user
511     *           2B2 - If match by mnethost and user is deleted in DB and
512     *                 username LIKE 'backup_email.%' and non-zero firstaccess) => ok, return target user
513     *                 (to cover situations were md5(username) wasn't implemented on delete we requiere both)
514     *      2C - Handle users deleted in backup file and "alive" in DB:
515     *           If match mnethost and user is deleted in backup file
516     *           and by email = email_without_time(backup_email) and non-zero firstaccess=> ok, return target user
517     *      2D - Conflict: If match by username and mnethost and not by (email or non-zero firstaccess) => conflict, return false
518     *      2E - None of the above, return true => User needs to be created
519     *
520     * Note: for DB deleted users email is stored in username field, hence we
521     *       are looking there for emails. See delete_user()
522     * Note: for DB deleted users md5(username) is stored *sometimes* in the email field,
523     *       hence we are looking there for usernames if not empty. See delete_user()
524     */
525     protected static function precheck_user($user, $samesite) {
526         global $CFG, $DB;
528         // Handle checks from same site backups
529         if ($samesite && empty($CFG->forcedifferentsitecheckingusersonrestore)) {
531             // 1A - If match by id and username and mnethost => ok, return target user
532             if ($rec = $DB->get_record('user', array('id'=>$user->id, 'username'=>$user->username, 'mnethostid'=>$user->mnethostid))) {
533                 return $rec; // Matching user found, return it
534             }
536             // 1B - Handle users deleted in DB and "alive" in backup file
537             // Note: for DB deleted users email is stored in username field, hence we
538             //       are looking there for emails. See delete_user()
539             // Note: for DB deleted users md5(username) is stored *sometimes* in the email field,
540             //       hence we are looking there for usernames if not empty. See delete_user()
541             // If match by id and mnethost and user is deleted in DB and
542             // match by username LIKE 'backup_email.%' or by non empty email = md5(username) => ok, return target user
543             if ($rec = $DB->get_record_sql("SELECT *
544                                               FROM {user} u
545                                              WHERE id = ?
546                                                AND mnethostid = ?
547                                                AND deleted = 1
548                                                AND (
549                                                        username LIKE ?
550                                                     OR (
551                                                            ".$DB->sql_isnotempty('user', 'email', false, false)."
552                                                        AND email = ?
553                                                        )
554                                                    )",
555                                            array($user->id, $user->mnethostid, $user->email.'.%', md5($user->username)))) {
556                 return $rec; // Matching user, deleted in DB found, return it
557             }
559             // 1C - Handle users deleted in backup file and "alive" in DB
560             // If match by id and mnethost and user is deleted in backup file
561             // and match by email = email_without_time(backup_email) => ok, return target user
562             if ($user->deleted) {
563                 // Note: for DB deleted users email is stored in username field, hence we
564                 //       are looking there for emails. See delete_user()
565                 // Trim time() from email
566                 $trimemail = preg_replace('/(.*?)\.[0-9]+.?$/', '\\1', $user->username);
567                 if ($rec = $DB->get_record_sql("SELECT *
568                                                   FROM {user} u
569                                                  WHERE id = ?
570                                                    AND mnethostid = ?
571                                                    AND email = ?",
572                                                array($user->id, $user->mnethostid, $trimemail))) {
573                     return $rec; // Matching user, deleted in backup file found, return it
574                 }
575             }
577             // 1D - If match by username and mnethost and doesn't match by id => conflict, return false
578             if ($rec = $DB->get_record('user', array('username'=>$user->username, 'mnethostid'=>$user->mnethostid))) {
579                 if ($user->id != $rec->id) {
580                     return false; // Conflict, username already exists and belongs to another id
581                 }
582             }
584         // Handle checks from different site backups
585         } else {
587             // 2A - If match by username and mnethost and
588             //     (email or non-zero firstaccess) => ok, return target user
589             if ($rec = $DB->get_record_sql("SELECT *
590                                               FROM {user} u
591                                              WHERE username = ?
592                                                AND mnethostid = ?
593                                                AND (
594                                                        email = ?
595                                                     OR (
596                                                            firstaccess != 0
597                                                        AND firstaccess = ?
598                                                        )
599                                                    )",
600                                            array($user->username, $user->mnethostid, $user->email, $user->firstaccess))) {
601                 return $rec; // Matching user found, return it
602             }
604             // 2B - Handle users deleted in DB and "alive" in backup file
605             // Note: for DB deleted users email is stored in username field, hence we
606             //       are looking there for emails. See delete_user()
607             // Note: for DB deleted users md5(username) is stored *sometimes* in the email field,
608             //       hence we are looking there for usernames if not empty. See delete_user()
609             // 2B1 - If match by mnethost and user is deleted in DB and not empty email = md5(username) and
610             //       (by username LIKE 'backup_email.%' or non-zero firstaccess) => ok, return target user
611             if ($rec = $DB->get_record_sql("SELECT *
612                                               FROM {user} u
613                                              WHERE mnethostid = ?
614                                                AND deleted = 1
615                                                AND ".$DB->sql_isnotempty('user', 'email', false, false)."
616                                                AND email = ?
617                                                AND (
618                                                        username LIKE ?
619                                                     OR (
620                                                            firstaccess != 0
621                                                        AND firstaccess = ?
622                                                        )
623                                                    )",
624                                            array($user->mnethostid, md5($user->username), $user->email.'.%', $user->firstaccess))) {
625                 return $rec; // Matching user found, return it
626             }
628             // 2B2 - If match by mnethost and user is deleted in DB and
629             //       username LIKE 'backup_email.%' and non-zero firstaccess) => ok, return target user
630             //       (this covers situations where md5(username) wasn't being stored so we require both
631             //        the email & non-zero firstaccess to match)
632             if ($rec = $DB->get_record_sql("SELECT *
633                                               FROM {user} u
634                                              WHERE mnethostid = ?
635                                                AND deleted = 1
636                                                AND username LIKE ?
637                                                AND firstaccess != 0
638                                                AND firstaccess = ?",
639                                            array($user->mnethostid, $user->email.'.%', $user->firstaccess))) {
640                 return $rec; // Matching user found, return it
641             }
643             // 2C - Handle users deleted in backup file and "alive" in DB
644             // If match mnethost and user is deleted in backup file
645             // and match by email = email_without_time(backup_email) and non-zero firstaccess=> ok, return target user
646             if ($user->deleted) {
647                 // Note: for DB deleted users email is stored in username field, hence we
648                 //       are looking there for emails. See delete_user()
649                 // Trim time() from email
650                 $trimemail = preg_replace('/(.*?)\.[0-9]+.?$/', '\\1', $user->username);
651                 if ($rec = $DB->get_record_sql("SELECT *
652                                                   FROM {user} u
653                                                  WHERE mnethostid = ?
654                                                    AND email = ?
655                                                    AND firstaccess != 0
656                                                    AND firstaccess = ?",
657                                                array($user->mnethostid, $trimemail, $user->firstaccess))) {
658                     return $rec; // Matching user, deleted in backup file found, return it
659                 }
660             }
662             // 2D - If match by username and mnethost and not by (email or non-zero firstaccess) => conflict, return false
663             if ($rec = $DB->get_record_sql("SELECT *
664                                               FROM {user} u
665                                              WHERE username = ?
666                                                AND mnethostid = ?
667                                            AND NOT (
668                                                        email = ?
669                                                     OR (
670                                                            firstaccess != 0
671                                                        AND firstaccess = ?
672                                                        )
673                                                    )",
674                                            array($user->username, $user->mnethostid, $user->email, $user->firstaccess))) {
675                 return false; // Conflict, username/mnethostid already exist and belong to another user (by email/firstaccess)
676             }
677         }
679         // Arrived here, return true as the user will need to be created and no
680         // conflicts have been found in the logic above. This covers:
681         // 1E - else => user needs to be created, return true
682         // 2E - else => user needs to be created, return true
683         return true;
684     }
686     /**
687      * Check all the included users, deciding the action to perform
688      * for each one (mapping / creation) and returning one array
689      * of problems in case something is wrong (lack of permissions,
690      * conficts)
691      */
692     public static function precheck_included_users($restoreid, $courseid, $userid, $samesite) {
693         global $CFG, $DB;
695         // To return any problem found
696         $problems = array();
698         // We are going to map mnethostid, so load all the available ones
699         $mnethosts = $DB->get_records('mnet_host', array(), 'wwwroot', 'wwwroot, id');
701         // Calculate the context we are going to use for capability checking
702         $context = get_context_instance(CONTEXT_COURSE, $courseid);
704         // Calculate if we have perms to create users, by checking:
705         // to 'moodle/restore:createuser' and 'moodle/restore:userinfo'
706         // and also observe $CFG->disableusercreationonrestore
707         $cancreateuser = false;
708         if (has_capability('moodle/restore:createuser', $context, $userid) and
709             has_capability('moodle/restore:userinfo', $context, $userid) and
710             empty($CFG->disableusercreationonrestore)) { // Can create users
712             $cancreateuser = true;
713         }
715         // Iterate over all the included users
716         $rs = $DB->get_recordset('backup_ids_temp', array('backupid' => $restoreid, 'itemname' => 'user'), '', 'itemid');
717         foreach ($rs as $recuser) {
718             $user = (object)self::get_backup_ids_record($restoreid, 'user', $recuser->itemid)->info;
720             // Find the correct mnethostid for user before performing any further check
721             if (empty($user->mnethosturl) || $user->mnethosturl === $CFG->wwwroot) {
722                 $user->mnethostid = $CFG->mnet_localhost_id;
723             } else {
724                 // fast url-to-id lookups
725                 if (isset($mnethosts[$user->mnethosturl])) {
726                     $user->mnethostid = $mnethosts[$user->mnethosturl]->id;
727                 } else {
728                     $user->mnethostid = $CFG->mnet_localhost_id;
729                 }
730             }
732             // Now, precheck that user and, based on returned results, annotate action/problem
733             $usercheck = self::precheck_user($user, $samesite);
735             if (is_object($usercheck)) { // No problem, we have found one user in DB to be mapped to
736                 // Annotate it, for later process. Set newitemid to mapping user->id
737                 self::set_backup_ids_record($restoreid, 'user', $recuser->itemid, $usercheck->id);
739             } else if ($usercheck === false) { // Found conflict, report it as problem
740                  $problems[] = get_string('restoreuserconflict', '', $user->username);
742             } else if ($usercheck === true) { // User needs to be created, check if we are able
743                 if ($cancreateuser) { // Can create user, set newitemid to 0 so will be created later
744                     self::set_backup_ids_record($restoreid, 'user', $recuser->itemid, 0, null, (array)$user);
746                 } else { // Cannot create user, report it as problem
747                     $problems[] = get_string('restorecannotcreateuser', '', $user->username);
748                 }
750             } else { // Shouldn't arrive here ever, something is for sure wrong. Exception
751                 throw new restore_dbops_exception('restore_error_processing_user', $user->username);
752             }
753         }
754         $rs->close();
755         return $problems;
756     }
758     /**
759      * Process the needed users in order to create / map them
760      *
761      * Just wrap over precheck_included_users(), returning
762      * exception if any problem is found or performing the
763      * required user creations if needed
764      */
765     public static function process_included_users($restoreid, $courseid, $userid, $samesite) {
766         global $DB;
768         // Just let precheck_included_users() to do all the hard work
769         $problems = self::precheck_included_users($restoreid, $courseid, $userid, $samesite);
771         // With problems, throw exception, shouldn't happen if prechecks were originally
772         // executed, so be radical here.
773         if (!empty($problems)) {
774             throw new restore_dbops_exception('restore_problems_processing_users', null, implode(', ', $problems));
775         }
776     }
778     public static function set_backup_files_record($restoreid, $filerec) {
779         global $DB;
781         $filerec->info     = base64_encode(serialize($filerec)); // Serialize the whole rec in info
782         $filerec->backupid = $restoreid;
783         $DB->insert_record('backup_files_temp', $filerec);
784     }
787     public static function set_backup_ids_record($restoreid, $itemname, $itemid, $newitemid = 0, $parentitemid = null, $info = null) {
788         global $DB;
790         // Build the basic (mandatory) record info
791         $record = array(
792             'backupid' => $restoreid,
793             'itemname' => $itemname,
794             'itemid'   => $itemid
795         );
796         // Build conditionally the extra record info
797         $extrarecord = array();
798         if ($newitemid != 0) {
799             $extrarecord['newitemid'] = $newitemid;
800         }
801         if ($parentitemid != null) {
802             $extrarecord['parentitemid'] = $parentitemid;
803         }
804         if ($info != null) {
805             $extrarecord['info'] = base64_encode(serialize($info));
806         }
808         // TODO: Analyze if some static (and limited) cache by the 3 params could save us a bunch of get_record() calls
809         // Note: Sure it will! And also will improve getter
810         if (!$dbrec = $DB->get_record('backup_ids_temp', $record)) { // Need to insert the complete record
811             $DB->insert_record('backup_ids_temp', array_merge($record, $extrarecord));
813         } else { // Need to update the extra record info if there is something to
814             if (!empty($extrarecord)) {
815                 $extrarecord['id'] = $dbrec->id;
816                 $DB->update_record('backup_ids_temp', $extrarecord);
817             }
818         }
819     }
821     public static function get_backup_ids_record($restoreid, $itemname, $itemid) {
822         global $DB;
824         // Build the basic (mandatory) record info to look for
825         $record = array(
826             'backupid' => $restoreid,
827             'itemname' => $itemname,
828             'itemid'   => $itemid
829         );
830         // TODO: Analyze if some static (and limited) cache by the 3 params could save us a bunch of get_record() calls
831         if ($dbrec = $DB->get_record('backup_ids_temp', $record)) {
832             if ($dbrec->info != null) {
833                 $dbrec->info = unserialize(base64_decode($dbrec->info));
834             }
835         }
836         return $dbrec;
837     }
839     /**
840      * Given on courseid, fullname and shortname, calculate the correct fullname/shortname to avoid dupes
841      */
842     public static function calculate_course_names($courseid, $fullname, $shortname) {
843         global $CFG, $DB;
845         $currentfullname = '';
846         $currentshortname = '';
847         $counter = 0;
848         // Iteratere while the name exists
849         do {
850             if ($counter) {
851                 $suffixfull  = ' ' . get_string('copyasnoun') . ' ' . $counter;
852                 $suffixshort = '_' . $counter;
853             } else {
854                 $suffixfull  = '';
855                 $suffixshort = '';
856             }
857             $currentfullname = $fullname.$suffixfull;
858             $currentshortname = substr($shortname, 0, 100 - strlen($suffixshort)).$suffixshort; // < 100cc
859             $coursefull  = $DB->get_record_select('course', 'fullname = ? AND id != ?', array($currentfullname, $courseid));
860             $courseshort = $DB->get_record_select('course', 'shortname = ? AND id != ?', array($currentshortname, $courseid));
861             $counter++;
862         } while ($coursefull || $courseshort);
864         // Return results
865         return array($currentfullname, $currentshortname);
866     }
868     /**
869      * For the target course context, put as many custom role names as possible
870      */
871     public static function set_course_role_names($restoreid, $courseid) {
872         global $DB;
874         // Get the course context
875         $coursectx = get_context_instance(CONTEXT_COURSE, $courseid);
876         // Get all the mapped roles we have
877         $rs = $DB->get_recordset('backup_ids_temp', array('backupid' => $restoreid, 'itemname' => 'role'), '', 'itemid');
878         foreach ($rs as $recrole) {
879             // Get the complete temp_ids record
880             $role = (object)self::get_backup_ids_record($restoreid, 'role', $recrole->itemid);
881             // If it's one mapped role and we have one name for it
882             if (!empty($role->newitemid) && !empty($role->info['nameincourse'])) {
883                 // If role name doesn't exist, add it
884                 $rolename = new stdclass();
885                 $rolename->roleid = $role->newitemid;
886                 $rolename->contextid = $coursectx->id;
887                 if (!$DB->record_exists('role_names', (array)$rolename)) {
888                     $rolename->name = $role->info['nameincourse'];
889                     $DB->insert_record('role_names', $rolename);
890                 }
891             }
892         }
893         $rs->close();
894     }
896     /**
897      * Creates a skeleton record within the database using the passed parameters
898      * and returns the new course id.
899      *
900      * @global moodle_database $DB
901      * @param string $fullname
902      * @param string $shortname
903      * @param int $categoryid
904      * @return int The new course id
905      */
906     public static function create_new_course($fullname, $shortname, $categoryid) {
907         global $DB;
908         $category = $DB->get_record('course_categories', array('id'=>$categoryid), '*', MUST_EXIST);
910         $course = new stdClass;
911         $course->fullname = $fullname;
912         $course->shortname = $shortname;
913         $course->category = $category->id;
914         $course->sortorder = 0;
915         $course->timecreated  = time();
916         $course->timemodified = $course->timecreated;
917         $course->visible = $category->visible;
919         return $DB->insert_record('course', $course);   
920     }
922     /**
923      * Deletes all of the content associated with the given course (courseid)
924      * @param int $courseid
925      * @return bool True for success
926      */
927     public static function delete_course_content($courseid) {
928         return remove_course_contents($courseid, false);
929     }
932 /*
933  * Exception class used by all the @dbops stuff
934  */
935 class restore_dbops_exception extends backup_exception {
937     public function __construct($errorcode, $a=NULL, $debuginfo=null) {
938         parent::__construct($errorcode, 'error', '', $a, null, $debuginfo);
939     }