MDL-40440 Backup: Skip files that already exist
[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 {
31     /**
32      * Keep cache of backup records.
33      * @var array
34      * @todo MDL-25290 static should be replaced with MUC code.
35      */
36     private static $backupidscache = array();
37     /**
38      * Keep track of backup ids which are cached.
39      * @var array
40      * @todo MDL-25290 static should be replaced with MUC code.
41      */
42     private static $backupidsexist = array();
43     /**
44      * Count is expensive, so manually keeping track of
45      * backupidscache, to avoid memory issues.
46      * @var int
47      * @todo MDL-25290 static should be replaced with MUC code.
48      */
49     private static $backupidscachesize = 2048;
50     /**
51      * Count is expensive, so manually keeping track of
52      * backupidsexist, to avoid memory issues.
53      * @var int
54      * @todo MDL-25290 static should be replaced with MUC code.
55      */
56     private static $backupidsexistsize = 10240;
57     /**
58      * Slice backupids cache to add more data.
59      * @var int
60      * @todo MDL-25290 static should be replaced with MUC code.
61      */
62     private static $backupidsslice = 512;
64     /**
65      * Return one array containing all the tasks that have been included
66      * in the restore process. Note that these tasks aren't built (they
67      * haven't steps nor ids data available)
68      */
69     public static function get_included_tasks($restoreid) {
70         $rc = restore_controller_dbops::load_controller($restoreid);
71         $tasks = $rc->get_plan()->get_tasks();
72         $includedtasks = array();
73         foreach ($tasks as $key => $task) {
74             // Calculate if the task is being included
75             $included = false;
76             // blocks, based in blocks setting and parent activity/course
77             if ($task instanceof restore_block_task) {
78                 if (!$task->get_setting_value('blocks')) { // Blocks not included, continue
79                     continue;
80                 }
81                 $parent = basename(dirname(dirname($task->get_taskbasepath())));
82                 if ($parent == 'course') { // Parent is course, always included if present
83                     $included = true;
85                 } else { // Look for activity_included setting
86                     $included = $task->get_setting_value($parent . '_included');
87                 }
89             // ativities, based on included setting
90             } else if ($task instanceof restore_activity_task) {
91                 $included = $task->get_setting_value('included');
93             // sections, based on included setting
94             } else if ($task instanceof restore_section_task) {
95                 $included = $task->get_setting_value('included');
97             // course always included if present
98             } else if ($task instanceof restore_course_task) {
99                 $included = true;
100             }
102             // If included, add it
103             if ($included) {
104                 $includedtasks[] = $task;
105             }
106         }
107         return $includedtasks;
108     }
110     /**
111      * Load one inforef.xml file to backup_ids table for future reference
112      */
113     public static function load_inforef_to_tempids($restoreid, $inforeffile) {
115         if (!file_exists($inforeffile)) { // Shouldn't happen ever, but...
116             throw new backup_helper_exception('missing_inforef_xml_file', $inforeffile);
117         }
118         // Let's parse, custom processor will do its work, sending info to DB
119         $xmlparser = new progressive_parser();
120         $xmlparser->set_file($inforeffile);
121         $xmlprocessor = new restore_inforef_parser_processor($restoreid);
122         $xmlparser->set_processor($xmlprocessor);
123         $xmlparser->process();
124     }
126     /**
127      * Load the needed role.xml file to backup_ids table for future reference
128      */
129     public static function load_roles_to_tempids($restoreid, $rolesfile) {
131         if (!file_exists($rolesfile)) { // Shouldn't happen ever, but...
132             throw new backup_helper_exception('missing_roles_xml_file', $rolesfile);
133         }
134         // Let's parse, custom processor will do its work, sending info to DB
135         $xmlparser = new progressive_parser();
136         $xmlparser->set_file($rolesfile);
137         $xmlprocessor = new restore_roles_parser_processor($restoreid);
138         $xmlparser->set_processor($xmlprocessor);
139         $xmlparser->process();
140     }
142     /**
143      * Precheck the loaded roles, return empty array if everything is ok, and
144      * array with 'errors', 'warnings' elements (suitable to be used by restore_prechecks)
145      * with any problem found. At the same time, store all the mapping into backup_ids_temp
146      * and also put the information into $rolemappings (controller->info), so it can be reworked later by
147      * post-precheck stages while at the same time accept modified info in the same object coming from UI
148      */
149     public static function precheck_included_roles($restoreid, $courseid, $userid, $samesite, $rolemappings) {
150         global $DB;
152         $problems = array(); // To store warnings/errors
154         // Get loaded roles from backup_ids
155         $rs = $DB->get_recordset('backup_ids_temp', array('backupid' => $restoreid, 'itemname' => 'role'), '', 'itemid');
156         foreach ($rs as $recrole) {
157             // If the rolemappings->modified flag is set, that means that we are coming from
158             // manually modified mappings (by UI), so accept those mappings an put them to backup_ids
159             if ($rolemappings->modified) {
160                 $target = $rolemappings->mappings[$recrole->itemid]->targetroleid;
161                 self::set_backup_ids_record($restoreid, 'role', $recrole->itemid, $target);
163             // Else, we haven't any info coming from UI, let's calculate the mappings, matching
164             // in multiple ways and checking permissions. Note mapping to 0 means "skip"
165             } else {
166                 $role = (object)self::get_backup_ids_record($restoreid, 'role', $recrole->itemid)->info;
167                 $match = self::get_best_assignable_role($role, $courseid, $userid, $samesite);
168                 // Send match to backup_ids
169                 self::set_backup_ids_record($restoreid, 'role', $recrole->itemid, $match);
170                 // Build the rolemappings element for controller
171                 unset($role->id);
172                 unset($role->nameincourse);
173                 unset($role->nameincourse);
174                 $role->targetroleid = $match;
175                 $rolemappings->mappings[$recrole->itemid] = $role;
176                 // Prepare warning if no match found
177                 if (!$match) {
178                     $problems['warnings'][] = get_string('cannotfindassignablerole', 'backup', $role->name);
179                 }
180             }
181         }
182         $rs->close();
183         return $problems;
184     }
186     /**
187      * Return cached backup id's
188      *
189      * @param int $restoreid id of backup
190      * @param string $itemname name of the item
191      * @param int $itemid id of item
192      * @return array backup id's
193      * @todo MDL-25290 replace static backupids* with MUC code
194      */
195     protected static function get_backup_ids_cached($restoreid, $itemname, $itemid) {
196         global $DB;
198         $key = "$itemid $itemname $restoreid";
200         // If record exists in cache then return.
201         if (isset(self::$backupidsexist[$key]) && isset(self::$backupidscache[$key])) {
202             // Return a copy of cached data, to avoid any alterations in cached data.
203             return clone self::$backupidscache[$key];
204         }
206         // Clean cache, if it's full.
207         if (self::$backupidscachesize <= 0) {
208             // Remove some records, to keep memory in limit.
209             self::$backupidscache = array_slice(self::$backupidscache, self::$backupidsslice, null, true);
210             self::$backupidscachesize = self::$backupidscachesize + self::$backupidsslice;
211         }
212         if (self::$backupidsexistsize <= 0) {
213             self::$backupidsexist = array_slice(self::$backupidsexist, self::$backupidsslice, null, true);
214             self::$backupidsexistsize = self::$backupidsexistsize + self::$backupidsslice;
215         }
217         // Retrive record from database.
218         $record = array(
219             'backupid' => $restoreid,
220             'itemname' => $itemname,
221             'itemid'   => $itemid
222         );
223         if ($dbrec = $DB->get_record('backup_ids_temp', $record)) {
224             self::$backupidsexist[$key] = $dbrec->id;
225             self::$backupidscache[$key] = $dbrec;
226             self::$backupidscachesize--;
227             self::$backupidsexistsize--;
228             return $dbrec;
229         } else {
230             return false;
231         }
232     }
234     /**
235      * Cache backup ids'
236      *
237      * @param int $restoreid id of backup
238      * @param string $itemname name of the item
239      * @param int $itemid id of item
240      * @param array $extrarecord extra record which needs to be updated
241      * @return void
242      * @todo MDL-25290 replace static BACKUP_IDS_* with MUC code
243      */
244     protected static function set_backup_ids_cached($restoreid, $itemname, $itemid, $extrarecord) {
245         global $DB;
247         $key = "$itemid $itemname $restoreid";
249         $record = array(
250             'backupid' => $restoreid,
251             'itemname' => $itemname,
252             'itemid'   => $itemid,
253         );
255         // If record is not cached then add one.
256         if (!isset(self::$backupidsexist[$key])) {
257             // If we have this record in db, then just update this.
258             if ($existingrecord = $DB->get_record('backup_ids_temp', $record)) {
259                 self::$backupidsexist[$key] = $existingrecord->id;
260                 self::$backupidsexistsize--;
261                 self::update_backup_cached_record($record, $extrarecord, $key, $existingrecord);
262             } else {
263                 // Add new record to cache and db.
264                 $recorddefault = array (
265                     'newitemid' => 0,
266                     'parentitemid' => null,
267                     'info' => null);
268                 $record = array_merge($record, $recorddefault, $extrarecord);
269                 $record['id'] = $DB->insert_record('backup_ids_temp', $record);
270                 self::$backupidsexist[$key] = $record['id'];
271                 self::$backupidsexistsize--;
272                 if (self::$backupidscachesize > 0) {
273                     // Cache new records if we haven't got many yet.
274                     self::$backupidscache[$key] = (object) $record;
275                     self::$backupidscachesize--;
276                 }
277             }
278         } else {
279             self::update_backup_cached_record($record, $extrarecord, $key);
280         }
281     }
283     /**
284      * Updates existing backup record
285      *
286      * @param array $record record which needs to be updated
287      * @param array $extrarecord extra record which needs to be updated
288      * @param string $key unique key which is used to identify cached record
289      * @param stdClass $existingrecord (optional) existing record
290      */
291     protected static function update_backup_cached_record($record, $extrarecord, $key, $existingrecord = null) {
292         global $DB;
293         // Update only if extrarecord is not empty.
294         if (!empty($extrarecord)) {
295             $extrarecord['id'] = self::$backupidsexist[$key];
296             $DB->update_record('backup_ids_temp', $extrarecord);
297             // Update existing cache or add new record to cache.
298             if (isset(self::$backupidscache[$key])) {
299                 $record = array_merge((array)self::$backupidscache[$key], $extrarecord);
300                 self::$backupidscache[$key] = (object) $record;
301             } else if (self::$backupidscachesize > 0) {
302                 if ($existingrecord) {
303                     self::$backupidscache[$key] = $existingrecord;
304                 } else {
305                     // Retrive record from database and cache updated records.
306                     self::$backupidscache[$key] = $DB->get_record('backup_ids_temp', $record);
307                 }
308                 $record = array_merge((array)self::$backupidscache[$key], $extrarecord);
309                 self::$backupidscache[$key] = (object) $record;
310                 self::$backupidscachesize--;
311             }
312         }
313     }
315     /**
316      * Reset the ids caches completely
317      *
318      * Any destructive operation (partial delete, truncate, drop or recreate) performed
319      * with the backup_ids table must cause the backup_ids caches to be
320      * invalidated by calling this method. See MDL-33630.
321      *
322      * Note that right now, the only operation of that type is the recreation
323      * (drop & restore) of the table that may happen once the prechecks have ended. All
324      * the rest of operations are always routed via {@link set_backup_ids_record()}, 1 by 1,
325      * keeping the caches on sync.
326      *
327      * @todo MDL-25290 static should be replaced with MUC code.
328      */
329     public static function reset_backup_ids_cached() {
330         // Reset the ids cache.
331         $cachetoadd = count(self::$backupidscache);
332         self::$backupidscache = array();
333         self::$backupidscachesize = self::$backupidscachesize + $cachetoadd;
334         // Reset the exists cache.
335         $existstoadd = count(self::$backupidsexist);
336         self::$backupidsexist = array();
337         self::$backupidsexistsize = self::$backupidsexistsize + $existstoadd;
338     }
340     /**
341      * Given one role, as loaded from XML, perform the best possible matching against the assignable
342      * roles, using different fallback alternatives (shortname, archetype, editingteacher => teacher, defaultcourseroleid)
343      * returning the id of the best matching role or 0 if no match is found
344      */
345     protected static function get_best_assignable_role($role, $courseid, $userid, $samesite) {
346         global $CFG, $DB;
348         // Gather various information about roles
349         $coursectx = context_course::instance($courseid);
350         $assignablerolesshortname = get_assignable_roles($coursectx, ROLENAME_SHORT, false, $userid);
352         // Note: under 1.9 we had one function restore_samerole() that performed one complete
353         // matching of roles (all caps) and if match was found the mapping was availabe bypassing
354         // any assignable_roles() security. IMO that was wrong and we must not allow such
355         // mappings anymore. So we have left that matching strategy out in 2.0
357         // Empty assignable roles, mean no match possible
358         if (empty($assignablerolesshortname)) {
359             return 0;
360         }
362         // Match by shortname
363         if ($match = array_search($role->shortname, $assignablerolesshortname)) {
364             return $match;
365         }
367         // Match by archetype
368         list($in_sql, $in_params) = $DB->get_in_or_equal(array_keys($assignablerolesshortname));
369         $params = array_merge(array($role->archetype), $in_params);
370         if ($rec = $DB->get_record_select('role', "archetype = ? AND id $in_sql", $params, 'id', IGNORE_MULTIPLE)) {
371             return $rec->id;
372         }
374         // Match editingteacher to teacher (happens a lot, from 1.9)
375         if ($role->shortname == 'editingteacher' && in_array('teacher', $assignablerolesshortname)) {
376             return array_search('teacher', $assignablerolesshortname);
377         }
379         // No match, return 0
380         return 0;
381     }
384     /**
385      * Process the loaded roles, looking for their best mapping or skipping
386      * Any error will cause exception. Note this is one wrapper over
387      * precheck_included_roles, that contains all the logic, but returns
388      * errors/warnings instead and is executed as part of the restore prechecks
389      */
390      public static function process_included_roles($restoreid, $courseid, $userid, $samesite, $rolemappings) {
391         global $DB;
393         // Just let precheck_included_roles() to do all the hard work
394         $problems = self::precheck_included_roles($restoreid, $courseid, $userid, $samesite, $rolemappings);
396         // With problems of type error, throw exception, shouldn't happen if prechecks executed
397         if (array_key_exists('errors', $problems)) {
398             throw new restore_dbops_exception('restore_problems_processing_roles', null, implode(', ', $problems['errors']));
399         }
400     }
402     /**
403      * Load the needed users.xml file to backup_ids table for future reference
404      */
405     public static function load_users_to_tempids($restoreid, $usersfile) {
407         if (!file_exists($usersfile)) { // Shouldn't happen ever, but...
408             throw new backup_helper_exception('missing_users_xml_file', $usersfile);
409         }
410         // Let's parse, custom processor will do its work, sending info to DB
411         $xmlparser = new progressive_parser();
412         $xmlparser->set_file($usersfile);
413         $xmlprocessor = new restore_users_parser_processor($restoreid);
414         $xmlparser->set_processor($xmlprocessor);
415         $xmlparser->process();
416     }
418     /**
419      * Load the needed questions.xml file to backup_ids table for future reference
420      */
421     public static function load_categories_and_questions_to_tempids($restoreid, $questionsfile) {
423         if (!file_exists($questionsfile)) { // Shouldn't happen ever, but...
424             throw new backup_helper_exception('missing_questions_xml_file', $questionsfile);
425         }
426         // Let's parse, custom processor will do its work, sending info to DB
427         $xmlparser = new progressive_parser();
428         $xmlparser->set_file($questionsfile);
429         $xmlprocessor = new restore_questions_parser_processor($restoreid);
430         $xmlparser->set_processor($xmlprocessor);
431         $xmlparser->process();
432     }
434     /**
435      * Check all the included categories and questions, deciding the action to perform
436      * for each one (mapping / creation) and returning one array of problems in case
437      * something is wrong.
438      *
439      * There are some basic rules that the method below will always try to enforce:
440      *
441      * Rule1: Targets will be, always, calculated for *whole* question banks (a.k.a. contexid source),
442      *     so, given 2 question categories belonging to the same bank, their target bank will be
443      *     always the same. If not, we can be incurring into "fragmentation", leading to random/cloze
444      *     problems (qtypes having "child" questions).
445      *
446      * Rule2: The 'moodle/question:managecategory' and 'moodle/question:add' capabilities will be
447      *     checked before creating any category/question respectively and, if the cap is not allowed
448      *     into upper contexts (system, coursecat)) but in lower ones (course), the *whole* question bank
449      *     will be created there.
450      *
451      * Rule3: Coursecat question banks not existing in the target site will be created as course
452      *     (lower ctx) question banks, never as "guessed" coursecat question banks base on depth or so.
453      *
454      * Rule4: System question banks will be created at system context if user has perms to do so. Else they
455      *     will created as course (lower ctx) question banks (similary to rule3). In other words, course ctx
456      *     if always a fallback for system and coursecat question banks.
457      *
458      * Also, there are some notes to clarify the scope of this method:
459      *
460      * Note1: This method won't create any question category nor question at all. It simply will calculate
461      *     which actions (create/map) must be performed for each element and where, validating that all those
462      *     actions are doable by the user executing the restore operation. Any problem found will be
463      *     returned in the problems array, causing the restore process to stop with error.
464      *
465      * Note2: To decide if one question bank (all its question categories and questions) is going to be remapped,
466      *     then all the categories and questions must exist in the same target bank. If able to do so, missing
467      *     qcats and qs will be created (rule2). But if, at the end, something is missing, the whole question bank
468      *     will be recreated at course ctx (rule1), no matter if that duplicates some categories/questions.
469      *
470      * Note3: We'll be using the newitemid column in the temp_ids table to store the action to be performed
471      *     with each question category and question. newitemid = 0 means the qcat/q needs to be created and
472      *     any other value means the qcat/q is mapped. Also, for qcats, parentitemid will contain the target
473      *     context where the categories have to be created (but for module contexts where we'll keep the old
474      *     one until the activity is created)
475      *
476      * Note4: All these "actions" will be "executed" later by {@link restore_create_categories_and_questions}
477      */
478     public static function precheck_categories_and_questions($restoreid, $courseid, $userid, $samesite) {
480         $problems = array();
482         // TODO: Check all qs, looking their qtypes are restorable
484         // Precheck all qcats and qs looking for target contexts / warnings / errors
485         list($syserr, $syswarn) = self::prechek_precheck_qbanks_by_level($restoreid, $courseid, $userid, $samesite, CONTEXT_SYSTEM);
486         list($caterr, $catwarn) = self::prechek_precheck_qbanks_by_level($restoreid, $courseid, $userid, $samesite, CONTEXT_COURSECAT);
487         list($couerr, $couwarn) = self::prechek_precheck_qbanks_by_level($restoreid, $courseid, $userid, $samesite, CONTEXT_COURSE);
488         list($moderr, $modwarn) = self::prechek_precheck_qbanks_by_level($restoreid, $courseid, $userid, $samesite, CONTEXT_MODULE);
490         // Acummulate and handle errors and warnings
491         $errors   = array_merge($syserr, $caterr, $couerr, $moderr);
492         $warnings = array_merge($syswarn, $catwarn, $couwarn, $modwarn);
493         if (!empty($errors)) {
494             $problems['errors'] = $errors;
495         }
496         if (!empty($warnings)) {
497             $problems['warnings'] = $warnings;
498         }
499         return $problems;
500     }
502     /**
503      * This function will process all the question banks present in restore
504      * at some contextlevel (from CONTEXT_SYSTEM to CONTEXT_MODULE), finding
505      * the target contexts where each bank will be restored and returning
506      * warnings/errors as needed.
507      *
508      * Some contextlevels (system, coursecat), will delegate process to
509      * course level if any problem is found (lack of permissions, non-matching
510      * target context...). Other contextlevels (course, module) will
511      * cause return error if some problem is found.
512      *
513      * At the end, if no errors were found, all the categories in backup_temp_ids
514      * will be pointing (parentitemid) to the target context where they must be
515      * created later in the restore process.
516      *
517      * Note: at the time these prechecks are executed, activities haven't been
518      * created yet so, for CONTEXT_MODULE banks, we keep the old contextid
519      * in the parentitemid field. Once the activity (and its context) has been
520      * created, we'll update that context in the required qcats
521      *
522      * Caller {@link precheck_categories_and_questions} will, simply, execute
523      * this function for all the contextlevels, acting as a simple controller
524      * of warnings and errors.
525      *
526      * The function returns 2 arrays, one containing errors and another containing
527      * warnings. Both empty if no errors/warnings are found.
528      */
529     public static function prechek_precheck_qbanks_by_level($restoreid, $courseid, $userid, $samesite, $contextlevel) {
530         global $CFG, $DB;
532         // To return any errors and warnings found
533         $errors   = array();
534         $warnings = array();
536         // Specify which fallbacks must be performed
537         $fallbacks = array(
538             CONTEXT_SYSTEM => CONTEXT_COURSE,
539             CONTEXT_COURSECAT => CONTEXT_COURSE);
541         // For any contextlevel, follow this process logic:
542         //
543         // 0) Iterate over each context (qbank)
544         // 1) Iterate over each qcat in the context, matching by stamp for the found target context
545         //     2a) No match, check if user can create qcat and q
546         //         3a) User can, mark the qcat and all dependent qs to be created in that target context
547         //         3b) User cannot, check if we are in some contextlevel with fallback
548         //             4a) There is fallback, move ALL the qcats to fallback, warn. End qcat loop
549         //             4b) No fallback, error. End qcat loop.
550         //     2b) Match, mark qcat to be mapped and iterate over each q, matching by stamp and version
551         //         5a) No match, check if user can add q
552         //             6a) User can, mark the q to be created
553         //             6b) User cannot, check if we are in some contextlevel with fallback
554         //                 7a) There is fallback, move ALL the qcats to fallback, warn. End qcat loop
555         //                 7b) No fallback, error. End qcat loop
556         //         5b) Match, mark q to be mapped
558         // Get all the contexts (question banks) in restore for the given contextlevel
559         $contexts = self::restore_get_question_banks($restoreid, $contextlevel);
561         // 0) Iterate over each context (qbank)
562         foreach ($contexts as $contextid => $contextlevel) {
563             // Init some perms
564             $canmanagecategory = false;
565             $canadd            = false;
566             // get categories in context (bank)
567             $categories = self::restore_get_question_categories($restoreid, $contextid);
568             // cache permissions if $targetcontext is found
569             if ($targetcontext = self::restore_find_best_target_context($categories, $courseid, $contextlevel)) {
570                 $canmanagecategory = has_capability('moodle/question:managecategory', $targetcontext, $userid);
571                 $canadd            = has_capability('moodle/question:add', $targetcontext, $userid);
572             }
573             // 1) Iterate over each qcat in the context, matching by stamp for the found target context
574             foreach ($categories as $category) {
575                 $matchcat = false;
576                 if ($targetcontext) {
577                     $matchcat = $DB->get_record('question_categories', array(
578                                     'contextid' => $targetcontext->id,
579                                     'stamp' => $category->stamp));
580                 }
581                 // 2a) No match, check if user can create qcat and q
582                 if (!$matchcat) {
583                     // 3a) User can, mark the qcat and all dependent qs to be created in that target context
584                     if ($canmanagecategory && $canadd) {
585                         // Set parentitemid to targetcontext, BUT for CONTEXT_MODULE categories, where
586                         // we keep the source contextid unmodified (for easier matching later when the
587                         // activities are created)
588                         $parentitemid = $targetcontext->id;
589                         if ($contextlevel == CONTEXT_MODULE) {
590                             $parentitemid = null; // null means "not modify" a.k.a. leave original contextid
591                         }
592                         self::set_backup_ids_record($restoreid, 'question_category', $category->id, 0, $parentitemid);
593                         // Nothing else to mark, newitemid = 0 means create
595                     // 3b) User cannot, check if we are in some contextlevel with fallback
596                     } else {
597                         // 4a) There is fallback, move ALL the qcats to fallback, warn. End qcat loop
598                         if (array_key_exists($contextlevel, $fallbacks)) {
599                             foreach ($categories as $movedcat) {
600                                 $movedcat->contextlevel = $fallbacks[$contextlevel];
601                                 self::set_backup_ids_record($restoreid, 'question_category', $movedcat->id, 0, $contextid, $movedcat);
602                                 // Warn about the performed fallback
603                                 $warnings[] = get_string('qcategory2coursefallback', 'backup', $movedcat);
604                             }
606                         // 4b) No fallback, error. End qcat loop.
607                         } else {
608                             $errors[] = get_string('qcategorycannotberestored', 'backup', $category);
609                         }
610                         break; // out from qcat loop (both 4a and 4b), we have decided about ALL categories in context (bank)
611                     }
613                 // 2b) Match, mark qcat to be mapped and iterate over each q, matching by stamp and version
614                 } else {
615                     self::set_backup_ids_record($restoreid, 'question_category', $category->id, $matchcat->id, $targetcontext->id);
616                     $questions = self::restore_get_questions($restoreid, $category->id);
617                     foreach ($questions as $question) {
618                         $matchq = $DB->get_record('question', array(
619                                       'category' => $matchcat->id,
620                                       'stamp' => $question->stamp,
621                                       'version' => $question->version));
622                         // 5a) No match, check if user can add q
623                         if (!$matchq) {
624                             // 6a) User can, mark the q to be created
625                             if ($canadd) {
626                                 // Nothing to mark, newitemid means create
628                              // 6b) User cannot, check if we are in some contextlevel with fallback
629                             } else {
630                                 // 7a) There is fallback, move ALL the qcats to fallback, warn. End qcat loo
631                                 if (array_key_exists($contextlevel, $fallbacks)) {
632                                     foreach ($categories as $movedcat) {
633                                         $movedcat->contextlevel = $fallbacks[$contextlevel];
634                                         self::set_backup_ids_record($restoreid, 'question_category', $movedcat->id, 0, $contextid, $movedcat);
635                                         // Warn about the performed fallback
636                                         $warnings[] = get_string('question2coursefallback', 'backup', $movedcat);
637                                     }
639                                 // 7b) No fallback, error. End qcat loop
640                                 } else {
641                                     $errors[] = get_string('questioncannotberestored', 'backup', $question);
642                                 }
643                                 break 2; // out from qcat loop (both 7a and 7b), we have decided about ALL categories in context (bank)
644                             }
646                         // 5b) Match, mark q to be mapped
647                         } else {
648                             self::set_backup_ids_record($restoreid, 'question', $question->id, $matchq->id);
649                         }
650                     }
651                 }
652             }
653         }
655         return array($errors, $warnings);
656     }
658     /**
659      * Return one array of contextid => contextlevel pairs
660      * of question banks to be checked for one given restore operation
661      * ordered from CONTEXT_SYSTEM downto CONTEXT_MODULE
662      * If contextlevel is specified, then only banks corresponding to
663      * that level are returned
664      */
665     public static function restore_get_question_banks($restoreid, $contextlevel = null) {
666         global $DB;
668         $results = array();
669         $qcats = $DB->get_records_sql("SELECT itemid, parentitemid AS contextid
670                                          FROM {backup_ids_temp}
671                                        WHERE backupid = ?
672                                          AND itemname = 'question_category'", array($restoreid));
673         foreach ($qcats as $qcat) {
674             // If this qcat context haven't been acummulated yet, do that
675             if (!isset($results[$qcat->contextid])) {
676                 $temprec = self::get_backup_ids_record($restoreid, 'question_category', $qcat->itemid);
677                 // Filter by contextlevel if necessary
678                 if (is_null($contextlevel) || $contextlevel == $temprec->info->contextlevel) {
679                     $results[$qcat->contextid] = $temprec->info->contextlevel;
680                 }
681             }
682         }
683         // Sort by value (contextlevel from CONTEXT_SYSTEM downto CONTEXT_MODULE)
684         asort($results);
685         return $results;
686     }
688     /**
689      * Return one array of question_category records for
690      * a given restore operation and one restore context (question bank)
691      */
692     public static function restore_get_question_categories($restoreid, $contextid) {
693         global $DB;
695         $results = array();
696         $qcats = $DB->get_records_sql("SELECT itemid
697                                          FROM {backup_ids_temp}
698                                         WHERE backupid = ?
699                                           AND itemname = 'question_category'
700                                           AND parentitemid = ?", array($restoreid, $contextid));
701         foreach ($qcats as $qcat) {
702             $temprec = self::get_backup_ids_record($restoreid, 'question_category', $qcat->itemid);
703             $results[$qcat->itemid] = $temprec->info;
704         }
705         return $results;
706     }
708     /**
709      * Calculates the best context found to restore one collection of qcats,
710      * al them belonging to the same context (question bank), returning the
711      * target context found (object) or false
712      */
713     public static function restore_find_best_target_context($categories, $courseid, $contextlevel) {
714         global $DB;
716         $targetcontext = false;
718         // Depending of $contextlevel, we perform different actions
719         switch ($contextlevel) {
720              // For system is easy, the best context is the system context
721              case CONTEXT_SYSTEM:
722                  $targetcontext = context_system::instance();
723                  break;
725              // For coursecat, we are going to look for stamps in all the
726              // course categories between CONTEXT_SYSTEM and CONTEXT_COURSE
727              // (i.e. in all the course categories in the path)
728              //
729              // And only will return one "best" target context if all the
730              // matches belong to ONE and ONLY ONE context. If multiple
731              // matches are found, that means that there is some annoying
732              // qbank "fragmentation" in the categories, so we'll fallback
733              // to create the qbank at course level
734              case CONTEXT_COURSECAT:
735                  // Build the array of stamps we are going to match
736                  $stamps = array();
737                  foreach ($categories as $category) {
738                      $stamps[] = $category->stamp;
739                  }
740                  $contexts = array();
741                  // Build the array of contexts we are going to look
742                  $systemctx = context_system::instance();
743                  $coursectx = context_course::instance($courseid);
744                  $parentctxs= get_parent_contexts($coursectx);
745                  foreach ($parentctxs as $parentctx) {
746                      // Exclude system context
747                      if ($parentctx == $systemctx->id) {
748                          continue;
749                      }
750                      $contexts[] = $parentctx;
751                  }
752                  if (!empty($stamps) && !empty($contexts)) {
753                      // Prepare the query
754                      list($stamp_sql, $stamp_params) = $DB->get_in_or_equal($stamps);
755                      list($context_sql, $context_params) = $DB->get_in_or_equal($contexts);
756                      $sql = "SELECT contextid
757                                FROM {question_categories}
758                               WHERE stamp $stamp_sql
759                                 AND contextid $context_sql";
760                      $params = array_merge($stamp_params, $context_params);
761                      $matchingcontexts = $DB->get_records_sql($sql, $params);
762                      // Only if ONE and ONLY ONE context is found, use it as valid target
763                      if (count($matchingcontexts) == 1) {
764                          $targetcontext = context::instance_by_id(reset($matchingcontexts)->contextid);
765                      }
766                  }
767                  break;
769              // For course is easy, the best context is the course context
770              case CONTEXT_COURSE:
771                  $targetcontext = context_course::instance($courseid);
772                  break;
774              // For module is easy, there is not best context, as far as the
775              // activity hasn't been created yet. So we return context course
776              // for them, so permission checks and friends will work. Note this
777              // case is handled by {@link prechek_precheck_qbanks_by_level}
778              // in an special way
779              case CONTEXT_MODULE:
780                  $targetcontext = context_course::instance($courseid);
781                  break;
782         }
783         return $targetcontext;
784     }
786     /**
787      * Return one array of question records for
788      * a given restore operation and one question category
789      */
790     public static function restore_get_questions($restoreid, $qcatid) {
791         global $DB;
793         $results = array();
794         $qs = $DB->get_records_sql("SELECT itemid
795                                       FROM {backup_ids_temp}
796                                      WHERE backupid = ?
797                                        AND itemname = 'question'
798                                        AND parentitemid = ?", array($restoreid, $qcatid));
799         foreach ($qs as $q) {
800             $temprec = self::get_backup_ids_record($restoreid, 'question', $q->itemid);
801             $results[$q->itemid] = $temprec->info;
802         }
803         return $results;
804     }
806     /**
807      * Given one component/filearea/context and
808      * optionally one source itemname to match itemids
809      * put the corresponding files in the pool
810      *
811      * @param string $basepath the full path to the root of unzipped backup file
812      * @param string $restoreid the restore job's identification
813      * @param string $component
814      * @param string $filearea
815      * @param int $oldcontextid
816      * @param int $dfltuserid default $file->user if the old one can't be mapped
817      * @param string|null $itemname
818      * @param int|null $olditemid
819      * @param int|null $forcenewcontextid explicit value for the new contextid (skip mapping)
820      * @param bool $skipparentitemidctxmatch
821      * @return array of result object
822      */
823     public static function send_files_to_pool($basepath, $restoreid, $component, $filearea, $oldcontextid, $dfltuserid, $itemname = null, $olditemid = null, $forcenewcontextid = null, $skipparentitemidctxmatch = false) {
824         global $DB, $CFG;
826         $backupinfo = backup_general_helper::get_backup_information(basename($basepath));
827         $includesfiles = $backupinfo->include_files;
829         $results = array();
831         if ($forcenewcontextid) {
832             // Some components can have "forced" new contexts (example: questions can end belonging to non-standard context mappings,
833             // with questions originally at system/coursecat context in source being restored to course context in target). So we need
834             // to be able to force the new contextid
835             $newcontextid = $forcenewcontextid;
836         } else {
837             // Get new context, must exist or this will fail
838             if (!$newcontextid = self::get_backup_ids_record($restoreid, 'context', $oldcontextid)->newitemid) {
839                 throw new restore_dbops_exception('unknown_context_mapping', $oldcontextid);
840             }
841         }
843         // Sometimes it's possible to have not the oldcontextids stored into backup_ids_temp->parentitemid
844         // columns (because we have used them to store other information). This happens usually with
845         // all the question related backup_ids_temp records. In that case, it's safe to ignore that
846         // matching as far as we are always restoring for well known oldcontexts and olditemids
847         $parentitemctxmatchsql = ' AND i.parentitemid = f.contextid ';
848         if ($skipparentitemidctxmatch) {
849             $parentitemctxmatchsql = '';
850         }
852         // Important: remember how files have been loaded to backup_files_temp
853         //   - info: contains the whole original object (times, names...)
854         //   (all them being original ids as loaded from xml)
856         // itemname = null, we are going to match only by context, no need to use itemid (all them are 0)
857         if ($itemname == null) {
858             $sql = "SELECT id AS bftid, contextid, component, filearea, itemid, itemid AS newitemid, info
859                       FROM {backup_files_temp}
860                      WHERE backupid = ?
861                        AND contextid = ?
862                        AND component = ?
863                        AND filearea  = ?";
864             $params = array($restoreid, $oldcontextid, $component, $filearea);
866         // itemname not null, going to join with backup_ids to perform the old-new mapping of itemids
867         } else {
868             $sql = "SELECT f.id AS bftid, f.contextid, f.component, f.filearea, f.itemid, i.newitemid, f.info
869                       FROM {backup_files_temp} f
870                       JOIN {backup_ids_temp} i ON i.backupid = f.backupid
871                                               $parentitemctxmatchsql
872                                               AND i.itemid = f.itemid
873                      WHERE f.backupid = ?
874                        AND f.contextid = ?
875                        AND f.component = ?
876                        AND f.filearea = ?
877                        AND i.itemname = ?";
878             $params = array($restoreid, $oldcontextid, $component, $filearea, $itemname);
879             if ($olditemid !== null) { // Just process ONE olditemid intead of the whole itemname
880                 $sql .= ' AND i.itemid = ?';
881                 $params[] = $olditemid;
882             }
883         }
885         $fs = get_file_storage();         // Get moodle file storage
886         $basepath = $basepath . '/files/';// Get backup file pool base
887         $rs = $DB->get_recordset_sql($sql, $params);
888         foreach ($rs as $rec) {
889             $file = (object)unserialize(base64_decode($rec->info));
891             // ignore root dirs (they are created automatically)
892             if ($file->filepath == '/' && $file->filename == '.') {
893                 continue;
894             }
896             // set the best possible user
897             $mappeduser = self::get_backup_ids_record($restoreid, 'user', $file->userid);
898             $mappeduserid = !empty($mappeduser) ? $mappeduser->newitemid : $dfltuserid;
900             // dir found (and not root one), let's create it
901             if ($file->filename == '.') {
902                 $fs->create_directory($newcontextid, $component, $filearea, $rec->newitemid, $file->filepath, $mappeduserid);
903                 continue;
904             }
906             // The file record to restore.
907             $file_record = array(
908                 'contextid'   => $newcontextid,
909                 'component'   => $component,
910                 'filearea'    => $filearea,
911                 'itemid'      => $rec->newitemid,
912                 'filepath'    => $file->filepath,
913                 'filename'    => $file->filename,
914                 'timecreated' => $file->timecreated,
915                 'timemodified'=> $file->timemodified,
916                 'userid'      => $mappeduserid,
917                 'author'      => $file->author,
918                 'license'     => $file->license,
919                 'sortorder'   => $file->sortorder
920             );
922             if (empty($file->repositoryid)) {
923                 // this is a regular file, it must be present in the backup pool
924                 $backuppath = $basepath . backup_file_manager::get_backup_content_file_location($file->contenthash);
926                 // Some file types do not include the files as they should already be
927                 // present. We still need to create entries into the files table.
928                 if ($includesfiles) {
929                     // The file is not found in the backup.
930                     if (!file_exists($backuppath)) {
931                         $result = new stdClass();
932                         $result->code = 'file_missing_in_backup';
933                         $result->message = sprintf('missing file %s%s in backup', $file->filepath, $file->filename);
934                         $result->level = backup::LOG_WARNING;
935                         $results[] = $result;
936                         continue;
937                     }
939                     // create the file in the filepool if it does not exist yet
940                     if (!$fs->file_exists($newcontextid, $component, $filearea, $rec->newitemid, $file->filepath, $file->filename)) {
942                         // If no license found, use default.
943                         if ($file->license == null){
944                             $file->license = $CFG->sitedefaultlicense;
945                         }
947                         $fs->create_file_from_pathname($file_record, $backuppath);
948                     }
949                 } else {
950                     // This backup does not include the files - they should be available in moodle filestorage already.
952                     // Create the file in the filepool if it does not exist yet.
953                     if (!$fs->file_exists($newcontextid, $component, $filearea, $rec->newitemid, $file->filepath, $file->filename)) {
955                         // Even if a file has been deleted since the backup was made, the file metadata will remain in the
956                         // files table, and the file will not be moved to the trashdir.
957                         // Files are not cleared from the files table by cron until several days after deletion.
958                         if ($foundfiles = $DB->get_records('files', array('contenthash' => $file->contenthash))) {
959                             // Only grab one of the foundfiles - the file content should be the same for all entries.
960                             $foundfile = reset($foundfiles);
961                             $fs->create_file_from_storedfile($file_record, $foundfile->id);
962                         } else {
963                             // A matching existing file record was not found in the database.
964                             $result = new stdClass();
965                             $result->code = 'file_missing_in_backup';
966                             $result->message = sprintf('missing file %s%s in backup', $file->filepath, $file->filename);
967                             $result->level = backup::LOG_WARNING;
968                             $results[] = $result;
969                             continue;
970                         }
971                     }
972                 }
974                 // store the the new contextid and the new itemid in case we need to remap
975                 // references to this file later
976                 $DB->update_record('backup_files_temp', array(
977                     'id' => $rec->bftid,
978                     'newcontextid' => $newcontextid,
979                     'newitemid' => $rec->newitemid), true);
981             } else {
982                 // this is an alias - we can't create it yet so we stash it in a temp
983                 // table and will let the final task to deal with it
984                 if (!$fs->file_exists($newcontextid, $component, $filearea, $rec->newitemid, $file->filepath, $file->filename)) {
985                     $info = new stdClass();
986                     // oldfile holds the raw information stored in MBZ (including reference-related info)
987                     $info->oldfile = $file;
988                     // newfile holds the info for the new file_record with the context, user and itemid mapped
989                     $info->newfile = (object) $file_record;
991                     restore_dbops::set_backup_ids_record($restoreid, 'file_aliases_queue', $file->id, 0, null, $info);
992                 }
993             }
994         }
995         $rs->close();
996         return $results;
997     }
999     /**
1000      * Given one restoreid, create in DB all the users present
1001      * in backup_ids having newitemid = 0, as far as
1002      * precheck_included_users() have left them there
1003      * ready to be created. Also, annotate their newids
1004      * once created for later reference
1005      */
1006     public static function create_included_users($basepath, $restoreid, $userid) {
1007         global $CFG, $DB;
1009         $authcache = array(); // Cache to get some bits from authentication plugins
1010         $languages = get_string_manager()->get_list_of_translations(); // Get languages for quick search later
1011         $themes    = get_list_of_themes(); // Get themes for quick search later
1013         // Iterate over all the included users with newitemid = 0, have to create them
1014         $rs = $DB->get_recordset('backup_ids_temp', array('backupid' => $restoreid, 'itemname' => 'user', 'newitemid' => 0), '', 'itemid, parentitemid');
1015         foreach ($rs as $recuser) {
1016             $user = (object)self::get_backup_ids_record($restoreid, 'user', $recuser->itemid)->info;
1018             // if user lang doesn't exist here, use site default
1019             if (!array_key_exists($user->lang, $languages)) {
1020                 $user->lang = $CFG->lang;
1021             }
1023             // if user theme isn't available on target site or they are disabled, reset theme
1024             if (!empty($user->theme)) {
1025                 if (empty($CFG->allowuserthemes) || !in_array($user->theme, $themes)) {
1026                     $user->theme = '';
1027                 }
1028             }
1030             // if user to be created has mnet auth and its mnethostid is $CFG->mnet_localhost_id
1031             // that's 100% impossible as own server cannot be accesed over mnet. Change auth to email/manual
1032             if ($user->auth == 'mnet' && $user->mnethostid == $CFG->mnet_localhost_id) {
1033                 // Respect registerauth
1034                 if ($CFG->registerauth == 'email') {
1035                     $user->auth = 'email';
1036                 } else {
1037                     $user->auth = 'manual';
1038                 }
1039             }
1040             unset($user->mnethosturl); // Not needed anymore
1042             // Disable pictures based on global setting
1043             if (!empty($CFG->disableuserimages)) {
1044                 $user->picture = 0;
1045             }
1047             // We need to analyse the AUTH field to recode it:
1048             //   - if the auth isn't enabled in target site, $CFG->registerauth will decide
1049             //   - finally, if the auth resulting isn't enabled, default to 'manual'
1050             if (!is_enabled_auth($user->auth)) {
1051                 if ($CFG->registerauth == 'email') {
1052                     $user->auth = 'email';
1053                 } else {
1054                     $user->auth = 'manual';
1055                 }
1056             }
1057             if (!is_enabled_auth($user->auth)) { // Final auth check verify, default to manual if not enabled
1058                 $user->auth = 'manual';
1059             }
1061             // Now that we know the auth method, for users to be created without pass
1062             // if password handling is internal and reset password is available
1063             // we set the password to "restored" (plain text), so the login process
1064             // will know how to handle that situation in order to allow the user to
1065             // recover the password. MDL-20846
1066             if (empty($user->password)) { // Only if restore comes without password
1067                 if (!array_key_exists($user->auth, $authcache)) { // Not in cache
1068                     $userauth = new stdClass();
1069                     $authplugin = get_auth_plugin($user->auth);
1070                     $userauth->preventpassindb = $authplugin->prevent_local_passwords();
1071                     $userauth->isinternal      = $authplugin->is_internal();
1072                     $userauth->canresetpwd     = $authplugin->can_reset_password();
1073                     $authcache[$user->auth] = $userauth;
1074                 } else {
1075                     $userauth = $authcache[$user->auth]; // Get from cache
1076                 }
1078                 // Most external plugins do not store passwords locally
1079                 if (!empty($userauth->preventpassindb)) {
1080                     $user->password = AUTH_PASSWORD_NOT_CACHED;
1082                 // If Moodle is responsible for storing/validating pwd and reset functionality is available, mark
1083                 } else if ($userauth->isinternal and $userauth->canresetpwd) {
1084                     $user->password = 'restored';
1085                 }
1086             }
1088             // Creating new user, we must reset the policyagreed always
1089             $user->policyagreed = 0;
1091             // Set time created if empty
1092             if (empty($user->timecreated)) {
1093                 $user->timecreated = time();
1094             }
1096             // Done, let's create the user and annotate its id
1097             $newuserid = $DB->insert_record('user', $user);
1098             self::set_backup_ids_record($restoreid, 'user', $recuser->itemid, $newuserid);
1099             // Let's create the user context and annotate it (we need it for sure at least for files)
1100             // but for deleted users that don't have a context anymore (MDL-30192). We are done for them
1101             // and nothing else (custom fields, prefs, tags, files...) will be created.
1102             if (empty($user->deleted)) {
1103                 $newuserctxid = $user->deleted ? 0 : context_user::instance($newuserid)->id;
1104                 self::set_backup_ids_record($restoreid, 'context', $recuser->parentitemid, $newuserctxid);
1106                 // Process custom fields
1107                 if (isset($user->custom_fields)) { // if present in backup
1108                     foreach($user->custom_fields['custom_field'] as $udata) {
1109                         $udata = (object)$udata;
1110                         // If the profile field has data and the profile shortname-datatype is defined in server
1111                         if ($udata->field_data) {
1112                             if ($field = $DB->get_record('user_info_field', array('shortname'=>$udata->field_name, 'datatype'=>$udata->field_type))) {
1113                             /// Insert the user_custom_profile_field
1114                                 $rec = new stdClass();
1115                                 $rec->userid  = $newuserid;
1116                                 $rec->fieldid = $field->id;
1117                                 $rec->data    = $udata->field_data;
1118                                 $DB->insert_record('user_info_data', $rec);
1119                             }
1120                         }
1121                     }
1122                 }
1124                 // Process tags
1125                 if (!empty($CFG->usetags) && isset($user->tags)) { // if enabled in server and present in backup
1126                     $tags = array();
1127                     foreach($user->tags['tag'] as $usertag) {
1128                         $usertag = (object)$usertag;
1129                         $tags[] = $usertag->rawname;
1130                     }
1131                     tag_set('user', $newuserid, $tags);
1132                 }
1134                 // Process preferences
1135                 if (isset($user->preferences)) { // if present in backup
1136                     foreach($user->preferences['preference'] as $preference) {
1137                         $preference = (object)$preference;
1138                         // Prepare the record and insert it
1139                         $preference->userid = $newuserid;
1140                         $status = $DB->insert_record('user_preferences', $preference);
1141                     }
1142                 }
1144                 // Create user files in pool (profile, icon, private) by context
1145                 restore_dbops::send_files_to_pool($basepath, $restoreid, 'user', 'icon', $recuser->parentitemid, $userid);
1146                 restore_dbops::send_files_to_pool($basepath, $restoreid, 'user', 'profile', $recuser->parentitemid, $userid);
1147             }
1148         }
1149         $rs->close();
1150     }
1152     /**
1153     * Given one user object (from backup file), perform all the neccesary
1154     * checks is order to decide how that user will be handled on restore.
1155     *
1156     * Note the function requires $user->mnethostid to be already calculated
1157     * so it's caller responsibility to set it
1158     *
1159     * This function is used both by @restore_precheck_users() and
1160     * @restore_create_users() to get consistent results in both places
1161     *
1162     * It returns:
1163     *   - one user object (from DB), if match has been found and user will be remapped
1164     *   - boolean true if the user needs to be created
1165     *   - boolean false if some conflict happened and the user cannot be handled
1166     *
1167     * Each test is responsible for returning its results and interrupt
1168     * execution. At the end, boolean true (user needs to be created) will be
1169     * returned if no test has interrupted that.
1170     *
1171     * Here it's the logic applied, keep it updated:
1172     *
1173     *  If restoring users from same site backup:
1174     *      1A - Normal check: If match by id and username and mnethost  => ok, return target user
1175     *      1B - If restoring an 'anonymous' user (created via the 'Anonymize user information' option) try to find a
1176     *           match by username only => ok, return target user MDL-31484
1177     *      1C - Handle users deleted in DB and "alive" in backup file:
1178     *           If match by id and mnethost and user is deleted in DB and
1179     *           (match by username LIKE 'backup_email.%' or by non empty email = md5(username)) => ok, return target user
1180     *      1D - Handle users deleted in backup file and "alive" in DB:
1181     *           If match by id and mnethost and user is deleted in backup file
1182     *           and match by email = email_without_time(backup_email) => ok, return target user
1183     *      1E - Conflict: If match by username and mnethost and doesn't match by id => conflict, return false
1184     *      1F - None of the above, return true => User needs to be created
1185     *
1186     *  if restoring from another site backup (cannot match by id here, replace it by email/firstaccess combination):
1187     *      2A - Normal check: If match by username and mnethost and (email or non-zero firstaccess) => ok, return target user
1188     *      2B - Handle users deleted in DB and "alive" in backup file:
1189     *           2B1 - If match by mnethost and user is deleted in DB and not empty email = md5(username) and
1190     *                 (username LIKE 'backup_email.%' or non-zero firstaccess) => ok, return target user
1191     *           2B2 - If match by mnethost and user is deleted in DB and
1192     *                 username LIKE 'backup_email.%' and non-zero firstaccess) => ok, return target user
1193     *                 (to cover situations were md5(username) wasn't implemented on delete we requiere both)
1194     *      2C - Handle users deleted in backup file and "alive" in DB:
1195     *           If match mnethost and user is deleted in backup file
1196     *           and by email = email_without_time(backup_email) and non-zero firstaccess=> ok, return target user
1197     *      2D - Conflict: If match by username and mnethost and not by (email or non-zero firstaccess) => conflict, return false
1198     *      2E - None of the above, return true => User needs to be created
1199     *
1200     * Note: for DB deleted users email is stored in username field, hence we
1201     *       are looking there for emails. See delete_user()
1202     * Note: for DB deleted users md5(username) is stored *sometimes* in the email field,
1203     *       hence we are looking there for usernames if not empty. See delete_user()
1204     */
1205     protected static function precheck_user($user, $samesite) {
1206         global $CFG, $DB;
1208         // Handle checks from same site backups
1209         if ($samesite && empty($CFG->forcedifferentsitecheckingusersonrestore)) {
1211             // 1A - If match by id and username and mnethost => ok, return target user
1212             if ($rec = $DB->get_record('user', array('id'=>$user->id, 'username'=>$user->username, 'mnethostid'=>$user->mnethostid))) {
1213                 return $rec; // Matching user found, return it
1214             }
1216             // 1B - If restoring an 'anonymous' user (created via the 'Anonymize user information' option) try to find a
1217             // match by username only => ok, return target user MDL-31484
1218             // This avoids username / id mis-match problems when restoring subsequent anonymized backups.
1219             if (backup_anonymizer_helper::is_anonymous_user($user)) {
1220                 if ($rec = $DB->get_record('user', array('username' => $user->username))) {
1221                     return $rec; // Matching anonymous user found - return it
1222                 }
1223             }
1225             // 1C - Handle users deleted in DB and "alive" in backup file
1226             // Note: for DB deleted users email is stored in username field, hence we
1227             //       are looking there for emails. See delete_user()
1228             // Note: for DB deleted users md5(username) is stored *sometimes* in the email field,
1229             //       hence we are looking there for usernames if not empty. See delete_user()
1230             // If match by id and mnethost and user is deleted in DB and
1231             // match by username LIKE 'backup_email.%' or by non empty email = md5(username) => ok, return target user
1232             if ($rec = $DB->get_record_sql("SELECT *
1233                                               FROM {user} u
1234                                              WHERE id = ?
1235                                                AND mnethostid = ?
1236                                                AND deleted = 1
1237                                                AND (
1238                                                        UPPER(username) LIKE UPPER(?)
1239                                                     OR (
1240                                                            ".$DB->sql_isnotempty('user', 'email', false, false)."
1241                                                        AND email = ?
1242                                                        )
1243                                                    )",
1244                                            array($user->id, $user->mnethostid, $user->email.'.%', md5($user->username)))) {
1245                 return $rec; // Matching user, deleted in DB found, return it
1246             }
1248             // 1D - Handle users deleted in backup file and "alive" in DB
1249             // If match by id and mnethost and user is deleted in backup file
1250             // and match by email = email_without_time(backup_email) => ok, return target user
1251             if ($user->deleted) {
1252                 // Note: for DB deleted users email is stored in username field, hence we
1253                 //       are looking there for emails. See delete_user()
1254                 // Trim time() from email
1255                 $trimemail = preg_replace('/(.*?)\.[0-9]+.?$/', '\\1', $user->username);
1256                 if ($rec = $DB->get_record_sql("SELECT *
1257                                                   FROM {user} u
1258                                                  WHERE id = ?
1259                                                    AND mnethostid = ?
1260                                                    AND UPPER(email) = UPPER(?)",
1261                                                array($user->id, $user->mnethostid, $trimemail))) {
1262                     return $rec; // Matching user, deleted in backup file found, return it
1263                 }
1264             }
1266             // 1E - If match by username and mnethost and doesn't match by id => conflict, return false
1267             if ($rec = $DB->get_record('user', array('username'=>$user->username, 'mnethostid'=>$user->mnethostid))) {
1268                 if ($user->id != $rec->id) {
1269                     return false; // Conflict, username already exists and belongs to another id
1270                 }
1271             }
1273         // Handle checks from different site backups
1274         } else {
1276             // 2A - If match by username and mnethost and
1277             //     (email or non-zero firstaccess) => ok, return target user
1278             if ($rec = $DB->get_record_sql("SELECT *
1279                                               FROM {user} u
1280                                              WHERE username = ?
1281                                                AND mnethostid = ?
1282                                                AND (
1283                                                        UPPER(email) = UPPER(?)
1284                                                     OR (
1285                                                            firstaccess != 0
1286                                                        AND firstaccess = ?
1287                                                        )
1288                                                    )",
1289                                            array($user->username, $user->mnethostid, $user->email, $user->firstaccess))) {
1290                 return $rec; // Matching user found, return it
1291             }
1293             // 2B - Handle users deleted in DB and "alive" in backup file
1294             // Note: for DB deleted users email is stored in username field, hence we
1295             //       are looking there for emails. See delete_user()
1296             // Note: for DB deleted users md5(username) is stored *sometimes* in the email field,
1297             //       hence we are looking there for usernames if not empty. See delete_user()
1298             // 2B1 - If match by mnethost and user is deleted in DB and not empty email = md5(username) and
1299             //       (by username LIKE 'backup_email.%' or non-zero firstaccess) => ok, return target user
1300             if ($rec = $DB->get_record_sql("SELECT *
1301                                               FROM {user} u
1302                                              WHERE mnethostid = ?
1303                                                AND deleted = 1
1304                                                AND ".$DB->sql_isnotempty('user', 'email', false, false)."
1305                                                AND email = ?
1306                                                AND (
1307                                                        UPPER(username) LIKE UPPER(?)
1308                                                     OR (
1309                                                            firstaccess != 0
1310                                                        AND firstaccess = ?
1311                                                        )
1312                                                    )",
1313                                            array($user->mnethostid, md5($user->username), $user->email.'.%', $user->firstaccess))) {
1314                 return $rec; // Matching user found, return it
1315             }
1317             // 2B2 - If match by mnethost and user is deleted in DB and
1318             //       username LIKE 'backup_email.%' and non-zero firstaccess) => ok, return target user
1319             //       (this covers situations where md5(username) wasn't being stored so we require both
1320             //        the email & non-zero firstaccess to match)
1321             if ($rec = $DB->get_record_sql("SELECT *
1322                                               FROM {user} u
1323                                              WHERE mnethostid = ?
1324                                                AND deleted = 1
1325                                                AND UPPER(username) LIKE UPPER(?)
1326                                                AND firstaccess != 0
1327                                                AND firstaccess = ?",
1328                                            array($user->mnethostid, $user->email.'.%', $user->firstaccess))) {
1329                 return $rec; // Matching user found, return it
1330             }
1332             // 2C - Handle users deleted in backup file and "alive" in DB
1333             // If match mnethost and user is deleted in backup file
1334             // and match by email = email_without_time(backup_email) and non-zero firstaccess=> ok, return target user
1335             if ($user->deleted) {
1336                 // Note: for DB deleted users email is stored in username field, hence we
1337                 //       are looking there for emails. See delete_user()
1338                 // Trim time() from email
1339                 $trimemail = preg_replace('/(.*?)\.[0-9]+.?$/', '\\1', $user->username);
1340                 if ($rec = $DB->get_record_sql("SELECT *
1341                                                   FROM {user} u
1342                                                  WHERE mnethostid = ?
1343                                                    AND UPPER(email) = UPPER(?)
1344                                                    AND firstaccess != 0
1345                                                    AND firstaccess = ?",
1346                                                array($user->mnethostid, $trimemail, $user->firstaccess))) {
1347                     return $rec; // Matching user, deleted in backup file found, return it
1348                 }
1349             }
1351             // 2D - If match by username and mnethost and not by (email or non-zero firstaccess) => conflict, return false
1352             if ($rec = $DB->get_record_sql("SELECT *
1353                                               FROM {user} u
1354                                              WHERE username = ?
1355                                                AND mnethostid = ?
1356                                            AND NOT (
1357                                                        UPPER(email) = UPPER(?)
1358                                                     OR (
1359                                                            firstaccess != 0
1360                                                        AND firstaccess = ?
1361                                                        )
1362                                                    )",
1363                                            array($user->username, $user->mnethostid, $user->email, $user->firstaccess))) {
1364                 return false; // Conflict, username/mnethostid already exist and belong to another user (by email/firstaccess)
1365             }
1366         }
1368         // Arrived here, return true as the user will need to be created and no
1369         // conflicts have been found in the logic above. This covers:
1370         // 1E - else => user needs to be created, return true
1371         // 2E - else => user needs to be created, return true
1372         return true;
1373     }
1375     /**
1376      * Check all the included users, deciding the action to perform
1377      * for each one (mapping / creation) and returning one array
1378      * of problems in case something is wrong (lack of permissions,
1379      * conficts)
1380      */
1381     public static function precheck_included_users($restoreid, $courseid, $userid, $samesite) {
1382         global $CFG, $DB;
1384         // To return any problem found
1385         $problems = array();
1387         // We are going to map mnethostid, so load all the available ones
1388         $mnethosts = $DB->get_records('mnet_host', array(), 'wwwroot', 'wwwroot, id');
1390         // Calculate the context we are going to use for capability checking
1391         $context = context_course::instance($courseid);
1393         // Calculate if we have perms to create users, by checking:
1394         // to 'moodle/restore:createuser' and 'moodle/restore:userinfo'
1395         // and also observe $CFG->disableusercreationonrestore
1396         $cancreateuser = false;
1397         if (has_capability('moodle/restore:createuser', $context, $userid) and
1398             has_capability('moodle/restore:userinfo', $context, $userid) and
1399             empty($CFG->disableusercreationonrestore)) { // Can create users
1401             $cancreateuser = true;
1402         }
1404         // Iterate over all the included users
1405         $rs = $DB->get_recordset('backup_ids_temp', array('backupid' => $restoreid, 'itemname' => 'user'), '', 'itemid');
1406         foreach ($rs as $recuser) {
1407             $user = (object)self::get_backup_ids_record($restoreid, 'user', $recuser->itemid)->info;
1409             // Find the correct mnethostid for user before performing any further check
1410             if (empty($user->mnethosturl) || $user->mnethosturl === $CFG->wwwroot) {
1411                 $user->mnethostid = $CFG->mnet_localhost_id;
1412             } else {
1413                 // fast url-to-id lookups
1414                 if (isset($mnethosts[$user->mnethosturl])) {
1415                     $user->mnethostid = $mnethosts[$user->mnethosturl]->id;
1416                 } else {
1417                     $user->mnethostid = $CFG->mnet_localhost_id;
1418                 }
1419             }
1421             // Now, precheck that user and, based on returned results, annotate action/problem
1422             $usercheck = self::precheck_user($user, $samesite);
1424             if (is_object($usercheck)) { // No problem, we have found one user in DB to be mapped to
1425                 // Annotate it, for later process. Set newitemid to mapping user->id
1426                 self::set_backup_ids_record($restoreid, 'user', $recuser->itemid, $usercheck->id);
1428             } else if ($usercheck === false) { // Found conflict, report it as problem
1429                  $problems[] = get_string('restoreuserconflict', '', $user->username);
1431             } else if ($usercheck === true) { // User needs to be created, check if we are able
1432                 if ($cancreateuser) { // Can create user, set newitemid to 0 so will be created later
1433                     self::set_backup_ids_record($restoreid, 'user', $recuser->itemid, 0, null, (array)$user);
1435                 } else { // Cannot create user, report it as problem
1436                     $problems[] = get_string('restorecannotcreateuser', '', $user->username);
1437                 }
1439             } else { // Shouldn't arrive here ever, something is for sure wrong. Exception
1440                 throw new restore_dbops_exception('restore_error_processing_user', $user->username);
1441             }
1442         }
1443         $rs->close();
1444         return $problems;
1445     }
1447     /**
1448      * Process the needed users in order to decide
1449      * which action to perform with them (create/map)
1450      *
1451      * Just wrap over precheck_included_users(), returning
1452      * exception if any problem is found
1453      */
1454     public static function process_included_users($restoreid, $courseid, $userid, $samesite) {
1455         global $DB;
1457         // Just let precheck_included_users() to do all the hard work
1458         $problems = self::precheck_included_users($restoreid, $courseid, $userid, $samesite);
1460         // With problems, throw exception, shouldn't happen if prechecks were originally
1461         // executed, so be radical here.
1462         if (!empty($problems)) {
1463             throw new restore_dbops_exception('restore_problems_processing_users', null, implode(', ', $problems));
1464         }
1465     }
1467     /**
1468      * Process the needed question categories and questions
1469      * to check all them, deciding about the action to perform
1470      * (create/map) and target.
1471      *
1472      * Just wrap over precheck_categories_and_questions(), returning
1473      * exception if any problem is found
1474      */
1475     public static function process_categories_and_questions($restoreid, $courseid, $userid, $samesite) {
1476         global $DB;
1478         // Just let precheck_included_users() to do all the hard work
1479         $problems = self::precheck_categories_and_questions($restoreid, $courseid, $userid, $samesite);
1481         // With problems of type error, throw exception, shouldn't happen if prechecks were originally
1482         // executed, so be radical here.
1483         if (array_key_exists('errors', $problems)) {
1484             throw new restore_dbops_exception('restore_problems_processing_questions', null, implode(', ', $problems['errors']));
1485         }
1486     }
1488     public static function set_backup_files_record($restoreid, $filerec) {
1489         global $DB;
1491         // Store external files info in `info` field
1492         $filerec->info     = base64_encode(serialize($filerec)); // Serialize the whole rec in info
1493         $filerec->backupid = $restoreid;
1494         $DB->insert_record('backup_files_temp', $filerec);
1495     }
1497     public static function set_backup_ids_record($restoreid, $itemname, $itemid, $newitemid = 0, $parentitemid = null, $info = null) {
1498         // Build conditionally the extra record info
1499         $extrarecord = array();
1500         if ($newitemid != 0) {
1501             $extrarecord['newitemid'] = $newitemid;
1502         }
1503         if ($parentitemid != null) {
1504             $extrarecord['parentitemid'] = $parentitemid;
1505         }
1506         if ($info != null) {
1507             $extrarecord['info'] = base64_encode(serialize($info));
1508         }
1510         self::set_backup_ids_cached($restoreid, $itemname, $itemid, $extrarecord);
1511     }
1513     public static function get_backup_ids_record($restoreid, $itemname, $itemid) {
1514         $dbrec = self::get_backup_ids_cached($restoreid, $itemname, $itemid);
1516         if ($dbrec && isset($dbrec->info) && is_string($dbrec->info)) {
1517             $dbrec->info = unserialize(base64_decode($dbrec->info));
1518         }
1520         return $dbrec;
1521     }
1523     /**
1524      * Given on courseid, fullname and shortname, calculate the correct fullname/shortname to avoid dupes
1525      */
1526     public static function calculate_course_names($courseid, $fullname, $shortname) {
1527         global $CFG, $DB;
1529         $currentfullname = '';
1530         $currentshortname = '';
1531         $counter = 0;
1532         // Iteratere while the name exists
1533         do {
1534             if ($counter) {
1535                 $suffixfull  = ' ' . get_string('copyasnoun') . ' ' . $counter;
1536                 $suffixshort = '_' . $counter;
1537             } else {
1538                 $suffixfull  = '';
1539                 $suffixshort = '';
1540             }
1541             $currentfullname = $fullname.$suffixfull;
1542             $currentshortname = substr($shortname, 0, 100 - strlen($suffixshort)).$suffixshort; // < 100cc
1543             $coursefull  = $DB->get_record_select('course', 'fullname = ? AND id != ?',
1544                     array($currentfullname, $courseid), '*', IGNORE_MULTIPLE);
1545             $courseshort = $DB->get_record_select('course', 'shortname = ? AND id != ?', array($currentshortname, $courseid));
1546             $counter++;
1547         } while ($coursefull || $courseshort);
1549         // Return results
1550         return array($currentfullname, $currentshortname);
1551     }
1553     /**
1554      * For the target course context, put as many custom role names as possible
1555      */
1556     public static function set_course_role_names($restoreid, $courseid) {
1557         global $DB;
1559         // Get the course context
1560         $coursectx = context_course::instance($courseid);
1561         // Get all the mapped roles we have
1562         $rs = $DB->get_recordset('backup_ids_temp', array('backupid' => $restoreid, 'itemname' => 'role'), '', 'itemid');
1563         foreach ($rs as $recrole) {
1564             // Get the complete temp_ids record
1565             $role = (object)self::get_backup_ids_record($restoreid, 'role', $recrole->itemid);
1566             // If it's one mapped role and we have one name for it
1567             if (!empty($role->newitemid) && !empty($role->info['nameincourse'])) {
1568                 // If role name doesn't exist, add it
1569                 $rolename = new stdclass();
1570                 $rolename->roleid = $role->newitemid;
1571                 $rolename->contextid = $coursectx->id;
1572                 if (!$DB->record_exists('role_names', (array)$rolename)) {
1573                     $rolename->name = $role->info['nameincourse'];
1574                     $DB->insert_record('role_names', $rolename);
1575                 }
1576             }
1577         }
1578         $rs->close();
1579     }
1581     /**
1582      * Creates a skeleton record within the database using the passed parameters
1583      * and returns the new course id.
1584      *
1585      * @global moodle_database $DB
1586      * @param string $fullname
1587      * @param string $shortname
1588      * @param int $categoryid
1589      * @return int The new course id
1590      */
1591     public static function create_new_course($fullname, $shortname, $categoryid) {
1592         global $DB;
1593         $category = $DB->get_record('course_categories', array('id'=>$categoryid), '*', MUST_EXIST);
1595         $course = new stdClass;
1596         $course->fullname = $fullname;
1597         $course->shortname = $shortname;
1598         $course->category = $category->id;
1599         $course->sortorder = 0;
1600         $course->timecreated  = time();
1601         $course->timemodified = $course->timecreated;
1602         // forcing skeleton courses to be hidden instead of going by $category->visible , until MDL-27790 is resolved.
1603         $course->visible = 0;
1605         $courseid = $DB->insert_record('course', $course);
1607         $category->coursecount++;
1608         $DB->update_record('course_categories', $category);
1610         return $courseid;
1611     }
1613     /**
1614      * Deletes all of the content associated with the given course (courseid)
1615      * @param int $courseid
1616      * @param array $options
1617      * @return bool True for success
1618      */
1619     public static function delete_course_content($courseid, array $options = null) {
1620         return remove_course_contents($courseid, false, $options);
1621     }
1624 /*
1625  * Exception class used by all the @dbops stuff
1626  */
1627 class restore_dbops_exception extends backup_exception {
1629     public function __construct($errorcode, $a=NULL, $debuginfo=null) {
1630         parent::__construct($errorcode, 'error', '', $a, null, $debuginfo);
1631     }