Merge branch 'MDL-67786-master' of git://github.com/aanabit/moodle
[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[] = clone($task); // A clone is enough. In fact we only need the basepath.
105             }
106         }
107         $rc->destroy(); // Always need to destroy.
109         return $includedtasks;
110     }
112     /**
113      * Load one inforef.xml file to backup_ids table for future reference
114      *
115      * @param string $restoreid Restore id
116      * @param string $inforeffile File path
117      * @param \core\progress\base $progress Progress tracker
118      */
119     public static function load_inforef_to_tempids($restoreid, $inforeffile,
120             \core\progress\base $progress = null) {
122         if (!file_exists($inforeffile)) { // Shouldn't happen ever, but...
123             throw new backup_helper_exception('missing_inforef_xml_file', $inforeffile);
124         }
126         // Set up progress tracking (indeterminate).
127         if (!$progress) {
128             $progress = new \core\progress\none();
129         }
130         $progress->start_progress('Loading inforef.xml file');
132         // Let's parse, custom processor will do its work, sending info to DB
133         $xmlparser = new progressive_parser();
134         $xmlparser->set_file($inforeffile);
135         $xmlprocessor = new restore_inforef_parser_processor($restoreid);
136         $xmlparser->set_processor($xmlprocessor);
137         $xmlparser->set_progress($progress);
138         $xmlparser->process();
140         // Finish progress
141         $progress->end_progress();
142     }
144     /**
145      * Load the needed role.xml file to backup_ids table for future reference
146      */
147     public static function load_roles_to_tempids($restoreid, $rolesfile) {
149         if (!file_exists($rolesfile)) { // Shouldn't happen ever, but...
150             throw new backup_helper_exception('missing_roles_xml_file', $rolesfile);
151         }
152         // Let's parse, custom processor will do its work, sending info to DB
153         $xmlparser = new progressive_parser();
154         $xmlparser->set_file($rolesfile);
155         $xmlprocessor = new restore_roles_parser_processor($restoreid);
156         $xmlparser->set_processor($xmlprocessor);
157         $xmlparser->process();
158     }
160     /**
161      * Precheck the loaded roles, return empty array if everything is ok, and
162      * array with 'errors', 'warnings' elements (suitable to be used by restore_prechecks)
163      * with any problem found. At the same time, store all the mapping into backup_ids_temp
164      * and also put the information into $rolemappings (controller->info), so it can be reworked later by
165      * post-precheck stages while at the same time accept modified info in the same object coming from UI
166      */
167     public static function precheck_included_roles($restoreid, $courseid, $userid, $samesite, $rolemappings) {
168         global $DB;
170         $problems = array(); // To store warnings/errors
172         // Get loaded roles from backup_ids
173         $rs = $DB->get_recordset('backup_ids_temp', array('backupid' => $restoreid, 'itemname' => 'role'), '', 'itemid, info');
174         foreach ($rs as $recrole) {
175             // If the rolemappings->modified flag is set, that means that we are coming from
176             // manually modified mappings (by UI), so accept those mappings an put them to backup_ids
177             if ($rolemappings->modified) {
178                 $target = $rolemappings->mappings[$recrole->itemid]->targetroleid;
179                 self::set_backup_ids_record($restoreid, 'role', $recrole->itemid, $target);
181             // Else, we haven't any info coming from UI, let's calculate the mappings, matching
182             // in multiple ways and checking permissions. Note mapping to 0 means "skip"
183             } else {
184                 $role = (object)backup_controller_dbops::decode_backup_temp_info($recrole->info);
185                 $match = self::get_best_assignable_role($role, $courseid, $userid, $samesite);
186                 // Send match to backup_ids
187                 self::set_backup_ids_record($restoreid, 'role', $recrole->itemid, $match);
188                 // Build the rolemappings element for controller
189                 unset($role->id);
190                 unset($role->nameincourse);
191                 $role->targetroleid = $match;
192                 $rolemappings->mappings[$recrole->itemid] = $role;
193                 // Prepare warning if no match found
194                 if (!$match) {
195                     $problems['warnings'][] = get_string('cannotfindassignablerole', 'backup', $role->name);
196                 }
197             }
198         }
199         $rs->close();
200         return $problems;
201     }
203     /**
204      * Return cached backup id's
205      *
206      * @param int $restoreid id of backup
207      * @param string $itemname name of the item
208      * @param int $itemid id of item
209      * @return array backup id's
210      * @todo MDL-25290 replace static backupids* with MUC code
211      */
212     protected static function get_backup_ids_cached($restoreid, $itemname, $itemid) {
213         global $DB;
215         $key = "$itemid $itemname $restoreid";
217         // If record exists in cache then return.
218         if (isset(self::$backupidsexist[$key]) && isset(self::$backupidscache[$key])) {
219             // Return a copy of cached data, to avoid any alterations in cached data.
220             return clone self::$backupidscache[$key];
221         }
223         // Clean cache, if it's full.
224         if (self::$backupidscachesize <= 0) {
225             // Remove some records, to keep memory in limit.
226             self::$backupidscache = array_slice(self::$backupidscache, self::$backupidsslice, null, true);
227             self::$backupidscachesize = self::$backupidscachesize + self::$backupidsslice;
228         }
229         if (self::$backupidsexistsize <= 0) {
230             self::$backupidsexist = array_slice(self::$backupidsexist, self::$backupidsslice, null, true);
231             self::$backupidsexistsize = self::$backupidsexistsize + self::$backupidsslice;
232         }
234         // Retrive record from database.
235         $record = array(
236             'backupid' => $restoreid,
237             'itemname' => $itemname,
238             'itemid'   => $itemid
239         );
240         if ($dbrec = $DB->get_record('backup_ids_temp', $record)) {
241             self::$backupidsexist[$key] = $dbrec->id;
242             self::$backupidscache[$key] = $dbrec;
243             self::$backupidscachesize--;
244             self::$backupidsexistsize--;
245             return $dbrec;
246         } else {
247             return false;
248         }
249     }
251     /**
252      * Cache backup ids'
253      *
254      * @param int $restoreid id of backup
255      * @param string $itemname name of the item
256      * @param int $itemid id of item
257      * @param array $extrarecord extra record which needs to be updated
258      * @return void
259      * @todo MDL-25290 replace static BACKUP_IDS_* with MUC code
260      */
261     protected static function set_backup_ids_cached($restoreid, $itemname, $itemid, $extrarecord) {
262         global $DB;
264         $key = "$itemid $itemname $restoreid";
266         $record = array(
267             'backupid' => $restoreid,
268             'itemname' => $itemname,
269             'itemid'   => $itemid,
270         );
272         // If record is not cached then add one.
273         if (!isset(self::$backupidsexist[$key])) {
274             // If we have this record in db, then just update this.
275             if ($existingrecord = $DB->get_record('backup_ids_temp', $record)) {
276                 self::$backupidsexist[$key] = $existingrecord->id;
277                 self::$backupidsexistsize--;
278                 self::update_backup_cached_record($record, $extrarecord, $key, $existingrecord);
279             } else {
280                 // Add new record to cache and db.
281                 $recorddefault = array (
282                     'newitemid' => 0,
283                     'parentitemid' => null,
284                     'info' => null);
285                 $record = array_merge($record, $recorddefault, $extrarecord);
286                 $record['id'] = $DB->insert_record('backup_ids_temp', $record);
287                 self::$backupidsexist[$key] = $record['id'];
288                 self::$backupidsexistsize--;
289                 if (self::$backupidscachesize > 0) {
290                     // Cache new records if we haven't got many yet.
291                     self::$backupidscache[$key] = (object) $record;
292                     self::$backupidscachesize--;
293                 }
294             }
295         } else {
296             self::update_backup_cached_record($record, $extrarecord, $key);
297         }
298     }
300     /**
301      * Updates existing backup record
302      *
303      * @param array $record record which needs to be updated
304      * @param array $extrarecord extra record which needs to be updated
305      * @param string $key unique key which is used to identify cached record
306      * @param stdClass $existingrecord (optional) existing record
307      */
308     protected static function update_backup_cached_record($record, $extrarecord, $key, $existingrecord = null) {
309         global $DB;
310         // Update only if extrarecord is not empty.
311         if (!empty($extrarecord)) {
312             $extrarecord['id'] = self::$backupidsexist[$key];
313             $DB->update_record('backup_ids_temp', $extrarecord);
314             // Update existing cache or add new record to cache.
315             if (isset(self::$backupidscache[$key])) {
316                 $record = array_merge((array)self::$backupidscache[$key], $extrarecord);
317                 self::$backupidscache[$key] = (object) $record;
318             } else if (self::$backupidscachesize > 0) {
319                 if ($existingrecord) {
320                     self::$backupidscache[$key] = $existingrecord;
321                 } else {
322                     // Retrive record from database and cache updated records.
323                     self::$backupidscache[$key] = $DB->get_record('backup_ids_temp', $record);
324                 }
325                 $record = array_merge((array)self::$backupidscache[$key], $extrarecord);
326                 self::$backupidscache[$key] = (object) $record;
327                 self::$backupidscachesize--;
328             }
329         }
330     }
332     /**
333      * Reset the ids caches completely
334      *
335      * Any destructive operation (partial delete, truncate, drop or recreate) performed
336      * with the backup_ids table must cause the backup_ids caches to be
337      * invalidated by calling this method. See MDL-33630.
338      *
339      * Note that right now, the only operation of that type is the recreation
340      * (drop & restore) of the table that may happen once the prechecks have ended. All
341      * the rest of operations are always routed via {@link set_backup_ids_record()}, 1 by 1,
342      * keeping the caches on sync.
343      *
344      * @todo MDL-25290 static should be replaced with MUC code.
345      */
346     public static function reset_backup_ids_cached() {
347         // Reset the ids cache.
348         $cachetoadd = count(self::$backupidscache);
349         self::$backupidscache = array();
350         self::$backupidscachesize = self::$backupidscachesize + $cachetoadd;
351         // Reset the exists cache.
352         $existstoadd = count(self::$backupidsexist);
353         self::$backupidsexist = array();
354         self::$backupidsexistsize = self::$backupidsexistsize + $existstoadd;
355     }
357     /**
358      * Given one role, as loaded from XML, perform the best possible matching against the assignable
359      * roles, using different fallback alternatives (shortname, archetype, editingteacher => teacher, defaultcourseroleid)
360      * returning the id of the best matching role or 0 if no match is found
361      */
362     protected static function get_best_assignable_role($role, $courseid, $userid, $samesite) {
363         global $CFG, $DB;
365         // Gather various information about roles
366         $coursectx = context_course::instance($courseid);
367         $assignablerolesshortname = get_assignable_roles($coursectx, ROLENAME_SHORT, false, $userid);
369         // Note: under 1.9 we had one function restore_samerole() that performed one complete
370         // matching of roles (all caps) and if match was found the mapping was availabe bypassing
371         // any assignable_roles() security. IMO that was wrong and we must not allow such
372         // mappings anymore. So we have left that matching strategy out in 2.0
374         // Empty assignable roles, mean no match possible
375         if (empty($assignablerolesshortname)) {
376             return 0;
377         }
379         // Match by shortname
380         if ($match = array_search($role->shortname, $assignablerolesshortname)) {
381             return $match;
382         }
384         // Match by archetype
385         list($in_sql, $in_params) = $DB->get_in_or_equal(array_keys($assignablerolesshortname));
386         $params = array_merge(array($role->archetype), $in_params);
387         if ($rec = $DB->get_record_select('role', "archetype = ? AND id $in_sql", $params, 'id', IGNORE_MULTIPLE)) {
388             return $rec->id;
389         }
391         // Match editingteacher to teacher (happens a lot, from 1.9)
392         if ($role->shortname == 'editingteacher' && in_array('teacher', $assignablerolesshortname)) {
393             return array_search('teacher', $assignablerolesshortname);
394         }
396         // No match, return 0
397         return 0;
398     }
401     /**
402      * Process the loaded roles, looking for their best mapping or skipping
403      * Any error will cause exception. Note this is one wrapper over
404      * precheck_included_roles, that contains all the logic, but returns
405      * errors/warnings instead and is executed as part of the restore prechecks
406      */
407      public static function process_included_roles($restoreid, $courseid, $userid, $samesite, $rolemappings) {
408         global $DB;
410         // Just let precheck_included_roles() to do all the hard work
411         $problems = self::precheck_included_roles($restoreid, $courseid, $userid, $samesite, $rolemappings);
413         // With problems of type error, throw exception, shouldn't happen if prechecks executed
414         if (array_key_exists('errors', $problems)) {
415             throw new restore_dbops_exception('restore_problems_processing_roles', null, implode(', ', $problems['errors']));
416         }
417     }
419     /**
420      * Load the needed users.xml file to backup_ids table for future reference
421      *
422      * @param string $restoreid Restore id
423      * @param string $usersfile File path
424      * @param \core\progress\base $progress Progress tracker
425      */
426     public static function load_users_to_tempids($restoreid, $usersfile,
427             \core\progress\base $progress = null) {
429         if (!file_exists($usersfile)) { // Shouldn't happen ever, but...
430             throw new backup_helper_exception('missing_users_xml_file', $usersfile);
431         }
433         // Set up progress tracking (indeterminate).
434         if (!$progress) {
435             $progress = new \core\progress\none();
436         }
437         $progress->start_progress('Loading users into temporary table');
439         // Let's parse, custom processor will do its work, sending info to DB
440         $xmlparser = new progressive_parser();
441         $xmlparser->set_file($usersfile);
442         $xmlprocessor = new restore_users_parser_processor($restoreid);
443         $xmlparser->set_processor($xmlprocessor);
444         $xmlparser->set_progress($progress);
445         $xmlparser->process();
447         // Finish progress.
448         $progress->end_progress();
449     }
451     /**
452      * Load the needed questions.xml file to backup_ids table for future reference
453      */
454     public static function load_categories_and_questions_to_tempids($restoreid, $questionsfile) {
456         if (!file_exists($questionsfile)) { // Shouldn't happen ever, but...
457             throw new backup_helper_exception('missing_questions_xml_file', $questionsfile);
458         }
459         // Let's parse, custom processor will do its work, sending info to DB
460         $xmlparser = new progressive_parser();
461         $xmlparser->set_file($questionsfile);
462         $xmlprocessor = new restore_questions_parser_processor($restoreid);
463         $xmlparser->set_processor($xmlprocessor);
464         $xmlparser->process();
465     }
467     /**
468      * Check all the included categories and questions, deciding the action to perform
469      * for each one (mapping / creation) and returning one array of problems in case
470      * something is wrong.
471      *
472      * There are some basic rules that the method below will always try to enforce:
473      *
474      * Rule1: Targets will be, always, calculated for *whole* question banks (a.k.a. contexid source),
475      *     so, given 2 question categories belonging to the same bank, their target bank will be
476      *     always the same. If not, we can be incurring into "fragmentation", leading to random/cloze
477      *     problems (qtypes having "child" questions).
478      *
479      * Rule2: The 'moodle/question:managecategory' and 'moodle/question:add' capabilities will be
480      *     checked before creating any category/question respectively and, if the cap is not allowed
481      *     into upper contexts (system, coursecat)) but in lower ones (course), the *whole* question bank
482      *     will be created there.
483      *
484      * Rule3: Coursecat question banks not existing in the target site will be created as course
485      *     (lower ctx) question banks, never as "guessed" coursecat question banks base on depth or so.
486      *
487      * Rule4: System question banks will be created at system context if user has perms to do so. Else they
488      *     will created as course (lower ctx) question banks (similary to rule3). In other words, course ctx
489      *     if always a fallback for system and coursecat question banks.
490      *
491      * Also, there are some notes to clarify the scope of this method:
492      *
493      * Note1: This method won't create any question category nor question at all. It simply will calculate
494      *     which actions (create/map) must be performed for each element and where, validating that all those
495      *     actions are doable by the user executing the restore operation. Any problem found will be
496      *     returned in the problems array, causing the restore process to stop with error.
497      *
498      * Note2: To decide if one question bank (all its question categories and questions) is going to be remapped,
499      *     then all the categories and questions must exist in the same target bank. If able to do so, missing
500      *     qcats and qs will be created (rule2). But if, at the end, something is missing, the whole question bank
501      *     will be recreated at course ctx (rule1), no matter if that duplicates some categories/questions.
502      *
503      * Note3: We'll be using the newitemid column in the temp_ids table to store the action to be performed
504      *     with each question category and question. newitemid = 0 means the qcat/q needs to be created and
505      *     any other value means the qcat/q is mapped. Also, for qcats, parentitemid will contain the target
506      *     context where the categories have to be created (but for module contexts where we'll keep the old
507      *     one until the activity is created)
508      *
509      * Note4: All these "actions" will be "executed" later by {@link restore_create_categories_and_questions}
510      */
511     public static function precheck_categories_and_questions($restoreid, $courseid, $userid, $samesite) {
513         $problems = array();
515         // TODO: Check all qs, looking their qtypes are restorable
517         // Precheck all qcats and qs looking for target contexts / warnings / errors
518         list($syserr, $syswarn) = self::prechek_precheck_qbanks_by_level($restoreid, $courseid, $userid, $samesite, CONTEXT_SYSTEM);
519         list($caterr, $catwarn) = self::prechek_precheck_qbanks_by_level($restoreid, $courseid, $userid, $samesite, CONTEXT_COURSECAT);
520         list($couerr, $couwarn) = self::prechek_precheck_qbanks_by_level($restoreid, $courseid, $userid, $samesite, CONTEXT_COURSE);
521         list($moderr, $modwarn) = self::prechek_precheck_qbanks_by_level($restoreid, $courseid, $userid, $samesite, CONTEXT_MODULE);
523         // Acummulate and handle errors and warnings
524         $errors   = array_merge($syserr, $caterr, $couerr, $moderr);
525         $warnings = array_merge($syswarn, $catwarn, $couwarn, $modwarn);
526         if (!empty($errors)) {
527             $problems['errors'] = $errors;
528         }
529         if (!empty($warnings)) {
530             $problems['warnings'] = $warnings;
531         }
532         return $problems;
533     }
535     /**
536      * This function will process all the question banks present in restore
537      * at some contextlevel (from CONTEXT_SYSTEM to CONTEXT_MODULE), finding
538      * the target contexts where each bank will be restored and returning
539      * warnings/errors as needed.
540      *
541      * Some contextlevels (system, coursecat), will delegate process to
542      * course level if any problem is found (lack of permissions, non-matching
543      * target context...). Other contextlevels (course, module) will
544      * cause return error if some problem is found.
545      *
546      * At the end, if no errors were found, all the categories in backup_temp_ids
547      * will be pointing (parentitemid) to the target context where they must be
548      * created later in the restore process.
549      *
550      * Note: at the time these prechecks are executed, activities haven't been
551      * created yet so, for CONTEXT_MODULE banks, we keep the old contextid
552      * in the parentitemid field. Once the activity (and its context) has been
553      * created, we'll update that context in the required qcats
554      *
555      * Caller {@link precheck_categories_and_questions} will, simply, execute
556      * this function for all the contextlevels, acting as a simple controller
557      * of warnings and errors.
558      *
559      * The function returns 2 arrays, one containing errors and another containing
560      * warnings. Both empty if no errors/warnings are found.
561      *
562      * @param int $restoreid The restore ID
563      * @param int $courseid The ID of the course
564      * @param int $userid The id of the user doing the restore
565      * @param bool $samesite True if restore is to same site
566      * @param int $contextlevel (CONTEXT_SYSTEM, etc.)
567      * @return array A separate list of all error and warnings detected
568      */
569     public static function prechek_precheck_qbanks_by_level($restoreid, $courseid, $userid, $samesite, $contextlevel) {
570         global $DB;
572         // To return any errors and warnings found
573         $errors   = array();
574         $warnings = array();
576         // Specify which fallbacks must be performed
577         $fallbacks = array(
578             CONTEXT_SYSTEM => CONTEXT_COURSE,
579             CONTEXT_COURSECAT => CONTEXT_COURSE);
581         $rc = restore_controller_dbops::load_controller($restoreid);
582         $restoreinfo = $rc->get_info();
583         $rc->destroy(); // Always need to destroy.
584         $backuprelease = floatval($restoreinfo->backup_release);
585         preg_match('/(\d{8})/', $restoreinfo->moodle_release, $matches);
586         $backupbuild = (int)$matches[1];
587         $after35 = false;
588         if ($backuprelease >= 3.5 && $backupbuild > 20180205) {
589             $after35 = true;
590         }
592         // For any contextlevel, follow this process logic:
593         //
594         // 0) Iterate over each context (qbank)
595         // 1) Iterate over each qcat in the context, matching by stamp for the found target context
596         //     2a) No match, check if user can create qcat and q
597         //         3a) User can, mark the qcat and all dependent qs to be created in that target context
598         //         3b) User cannot, check if we are in some contextlevel with fallback
599         //             4a) There is fallback, move ALL the qcats to fallback, warn. End qcat loop
600         //             4b) No fallback, error. End qcat loop.
601         //     2b) Match, mark qcat to be mapped and iterate over each q, matching by stamp and version
602         //         5a) No match, check if user can add q
603         //             6a) User can, mark the q to be created
604         //             6b) User cannot, check if we are in some contextlevel with fallback
605         //                 7a) There is fallback, move ALL the qcats to fallback, warn. End qcat loop
606         //                 7b) No fallback, error. End qcat loop
607         //         5b) Random question, must always create new.
608         //         5c) Match, mark q to be mapped
609         // 8) Check if backup is from Moodle >= 3.5 and error if more than one top-level category in the context.
611         // Get all the contexts (question banks) in restore for the given contextlevel
612         $contexts = self::restore_get_question_banks($restoreid, $contextlevel);
614         // 0) Iterate over each context (qbank)
615         foreach ($contexts as $contextid => $contextlevel) {
616             // Init some perms
617             $canmanagecategory = false;
618             $canadd            = false;
619             // Top-level category counter.
620             $topcats = 0;
621             // get categories in context (bank)
622             $categories = self::restore_get_question_categories($restoreid, $contextid);
623             // cache permissions if $targetcontext is found
624             if ($targetcontext = self::restore_find_best_target_context($categories, $courseid, $contextlevel)) {
625                 $canmanagecategory = has_capability('moodle/question:managecategory', $targetcontext, $userid);
626                 $canadd            = has_capability('moodle/question:add', $targetcontext, $userid);
627             }
628             // 1) Iterate over each qcat in the context, matching by stamp for the found target context
629             foreach ($categories as $category) {
630                 if ($category->parent == 0) {
631                     $topcats++;
632                 }
634                 $matchcat = false;
635                 if ($targetcontext) {
636                     $matchcat = $DB->get_record('question_categories', array(
637                                     'contextid' => $targetcontext->id,
638                                     'stamp' => $category->stamp));
639                 }
640                 // 2a) No match, check if user can create qcat and q
641                 if (!$matchcat) {
642                     // 3a) User can, mark the qcat and all dependent qs to be created in that target context
643                     if ($canmanagecategory && $canadd) {
644                         // Set parentitemid to targetcontext, BUT for CONTEXT_MODULE categories, where
645                         // we keep the source contextid unmodified (for easier matching later when the
646                         // activities are created)
647                         $parentitemid = $targetcontext->id;
648                         if ($contextlevel == CONTEXT_MODULE) {
649                             $parentitemid = null; // null means "not modify" a.k.a. leave original contextid
650                         }
651                         self::set_backup_ids_record($restoreid, 'question_category', $category->id, 0, $parentitemid);
652                         // Nothing else to mark, newitemid = 0 means create
654                     // 3b) User cannot, check if we are in some contextlevel with fallback
655                     } else {
656                         // 4a) There is fallback, move ALL the qcats to fallback, warn. End qcat loop
657                         if (array_key_exists($contextlevel, $fallbacks)) {
658                             foreach ($categories as $movedcat) {
659                                 $movedcat->contextlevel = $fallbacks[$contextlevel];
660                                 self::set_backup_ids_record($restoreid, 'question_category', $movedcat->id, 0, $contextid, $movedcat);
661                                 // Warn about the performed fallback
662                                 $warnings[] = get_string('qcategory2coursefallback', 'backup', $movedcat);
663                             }
665                         // 4b) No fallback, error. End qcat loop.
666                         } else {
667                             $errors[] = get_string('qcategorycannotberestored', 'backup', $category);
668                         }
669                         break; // out from qcat loop (both 4a and 4b), we have decided about ALL categories in context (bank)
670                     }
672                 // 2b) Match, mark qcat to be mapped and iterate over each q, matching by stamp and version
673                 } else {
674                     self::set_backup_ids_record($restoreid, 'question_category', $category->id, $matchcat->id, $targetcontext->id);
675                     $questions = self::restore_get_questions($restoreid, $category->id);
677                     // Collect all the questions for this category into memory so we only talk to the DB once.
678                     $questioncache = $DB->get_records_sql_menu("SELECT ".$DB->sql_concat('stamp', "' '", 'version').", id
679                                                                   FROM {question}
680                                                                  WHERE category = ?", array($matchcat->id));
682                     foreach ($questions as $question) {
683                         if (isset($questioncache[$question->stamp." ".$question->version])) {
684                             $matchqid = $questioncache[$question->stamp." ".$question->version];
685                         } else {
686                             $matchqid = false;
687                         }
688                         // 5a) No match, check if user can add q
689                         if (!$matchqid) {
690                             // 6a) User can, mark the q to be created
691                             if ($canadd) {
692                                 // Nothing to mark, newitemid means create
694                              // 6b) User cannot, check if we are in some contextlevel with fallback
695                             } else {
696                                 // 7a) There is fallback, move ALL the qcats to fallback, warn. End qcat loo
697                                 if (array_key_exists($contextlevel, $fallbacks)) {
698                                     foreach ($categories as $movedcat) {
699                                         $movedcat->contextlevel = $fallbacks[$contextlevel];
700                                         self::set_backup_ids_record($restoreid, 'question_category', $movedcat->id, 0, $contextid, $movedcat);
701                                         // Warn about the performed fallback
702                                         $warnings[] = get_string('question2coursefallback', 'backup', $movedcat);
703                                     }
705                                 // 7b) No fallback, error. End qcat loop
706                                 } else {
707                                     $errors[] = get_string('questioncannotberestored', 'backup', $question);
708                                 }
709                                 break 2; // out from qcat loop (both 7a and 7b), we have decided about ALL categories in context (bank)
710                             }
712                         // 5b) Random questions must always be newly created.
713                         } else if ($question->qtype == 'random') {
714                             // Nothing to mark, newitemid means create
716                         // 5c) Match, mark q to be mapped.
717                         } else {
718                             self::set_backup_ids_record($restoreid, 'question', $question->id, $matchqid);
719                         }
720                     }
721                 }
722             }
724             // 8) Check if backup is made on Moodle >= 3.5 and there are more than one top-level category in the context.
725             if ($after35 && $topcats > 1) {
726                 $errors[] = get_string('restoremultipletopcats', 'question', $contextid);
727             }
729         }
731         return array($errors, $warnings);
732     }
734     /**
735      * Return one array of contextid => contextlevel pairs
736      * of question banks to be checked for one given restore operation
737      * ordered from CONTEXT_SYSTEM downto CONTEXT_MODULE
738      * If contextlevel is specified, then only banks corresponding to
739      * that level are returned
740      */
741     public static function restore_get_question_banks($restoreid, $contextlevel = null) {
742         global $DB;
744         $results = array();
745         $qcats = $DB->get_recordset_sql("SELECT itemid, parentitemid AS contextid, info
746                                          FROM {backup_ids_temp}
747                                        WHERE backupid = ?
748                                          AND itemname = 'question_category'", array($restoreid));
749         foreach ($qcats as $qcat) {
750             // If this qcat context haven't been acummulated yet, do that
751             if (!isset($results[$qcat->contextid])) {
752                 $info = backup_controller_dbops::decode_backup_temp_info($qcat->info);
753                 // Filter by contextlevel if necessary
754                 if (is_null($contextlevel) || $contextlevel == $info->contextlevel) {
755                     $results[$qcat->contextid] = $info->contextlevel;
756                 }
757             }
758         }
759         $qcats->close();
760         // Sort by value (contextlevel from CONTEXT_SYSTEM downto CONTEXT_MODULE)
761         asort($results);
762         return $results;
763     }
765     /**
766      * Return one array of question_category records for
767      * a given restore operation and one restore context (question bank)
768      */
769     public static function restore_get_question_categories($restoreid, $contextid) {
770         global $DB;
772         $results = array();
773         $qcats = $DB->get_recordset_sql("SELECT itemid, info
774                                          FROM {backup_ids_temp}
775                                         WHERE backupid = ?
776                                           AND itemname = 'question_category'
777                                           AND parentitemid = ?", array($restoreid, $contextid));
778         foreach ($qcats as $qcat) {
779             $results[$qcat->itemid] = backup_controller_dbops::decode_backup_temp_info($qcat->info);
780         }
781         $qcats->close();
783         return $results;
784     }
786     /**
787      * Calculates the best context found to restore one collection of qcats,
788      * al them belonging to the same context (question bank), returning the
789      * target context found (object) or false
790      */
791     public static function restore_find_best_target_context($categories, $courseid, $contextlevel) {
792         global $DB;
794         $targetcontext = false;
796         // Depending of $contextlevel, we perform different actions
797         switch ($contextlevel) {
798              // For system is easy, the best context is the system context
799              case CONTEXT_SYSTEM:
800                  $targetcontext = context_system::instance();
801                  break;
803              // For coursecat, we are going to look for stamps in all the
804              // course categories between CONTEXT_SYSTEM and CONTEXT_COURSE
805              // (i.e. in all the course categories in the path)
806              //
807              // And only will return one "best" target context if all the
808              // matches belong to ONE and ONLY ONE context. If multiple
809              // matches are found, that means that there is some annoying
810              // qbank "fragmentation" in the categories, so we'll fallback
811              // to create the qbank at course level
812              case CONTEXT_COURSECAT:
813                  // Build the array of stamps we are going to match
814                  $stamps = array();
815                  foreach ($categories as $category) {
816                      $stamps[] = $category->stamp;
817                  }
818                  $contexts = array();
819                  // Build the array of contexts we are going to look
820                  $systemctx = context_system::instance();
821                  $coursectx = context_course::instance($courseid);
822                  $parentctxs = $coursectx->get_parent_context_ids();
823                  foreach ($parentctxs as $parentctx) {
824                      // Exclude system context
825                      if ($parentctx == $systemctx->id) {
826                          continue;
827                      }
828                      $contexts[] = $parentctx;
829                  }
830                  if (!empty($stamps) && !empty($contexts)) {
831                      // Prepare the query
832                      list($stamp_sql, $stamp_params) = $DB->get_in_or_equal($stamps);
833                      list($context_sql, $context_params) = $DB->get_in_or_equal($contexts);
834                      $sql = "SELECT DISTINCT contextid
835                                FROM {question_categories}
836                               WHERE stamp $stamp_sql
837                                 AND contextid $context_sql";
838                      $params = array_merge($stamp_params, $context_params);
839                      $matchingcontexts = $DB->get_records_sql($sql, $params);
840                      // Only if ONE and ONLY ONE context is found, use it as valid target
841                      if (count($matchingcontexts) == 1) {
842                          $targetcontext = context::instance_by_id(reset($matchingcontexts)->contextid);
843                      }
844                  }
845                  break;
847              // For course is easy, the best context is the course context
848              case CONTEXT_COURSE:
849                  $targetcontext = context_course::instance($courseid);
850                  break;
852              // For module is easy, there is not best context, as far as the
853              // activity hasn't been created yet. So we return context course
854              // for them, so permission checks and friends will work. Note this
855              // case is handled by {@link prechek_precheck_qbanks_by_level}
856              // in an special way
857              case CONTEXT_MODULE:
858                  $targetcontext = context_course::instance($courseid);
859                  break;
860         }
861         return $targetcontext;
862     }
864     /**
865      * Return one array of question records for
866      * a given restore operation and one question category
867      */
868     public static function restore_get_questions($restoreid, $qcatid) {
869         global $DB;
871         $results = array();
872         $qs = $DB->get_recordset_sql("SELECT itemid, info
873                                       FROM {backup_ids_temp}
874                                      WHERE backupid = ?
875                                        AND itemname = 'question'
876                                        AND parentitemid = ?", array($restoreid, $qcatid));
877         foreach ($qs as $q) {
878             $results[$q->itemid] = backup_controller_dbops::decode_backup_temp_info($q->info);
879         }
880         $qs->close();
881         return $results;
882     }
884     /**
885      * Given one component/filearea/context and
886      * optionally one source itemname to match itemids
887      * put the corresponding files in the pool
888      *
889      * If you specify a progress reporter, it will get called once per file with
890      * indeterminate progress.
891      *
892      * @param string $basepath the full path to the root of unzipped backup file
893      * @param string $restoreid the restore job's identification
894      * @param string $component
895      * @param string $filearea
896      * @param int $oldcontextid
897      * @param int $dfltuserid default $file->user if the old one can't be mapped
898      * @param string|null $itemname
899      * @param int|null $olditemid
900      * @param int|null $forcenewcontextid explicit value for the new contextid (skip mapping)
901      * @param bool $skipparentitemidctxmatch
902      * @param \core\progress\base $progress Optional progress reporter
903      * @return array of result object
904      */
905     public static function send_files_to_pool($basepath, $restoreid, $component, $filearea,
906             $oldcontextid, $dfltuserid, $itemname = null, $olditemid = null,
907             $forcenewcontextid = null, $skipparentitemidctxmatch = false,
908             \core\progress\base $progress = null) {
909         global $DB, $CFG;
911         $backupinfo = backup_general_helper::get_backup_information(basename($basepath));
912         $includesfiles = $backupinfo->include_files;
914         $results = array();
916         if ($forcenewcontextid) {
917             // Some components can have "forced" new contexts (example: questions can end belonging to non-standard context mappings,
918             // with questions originally at system/coursecat context in source being restored to course context in target). So we need
919             // to be able to force the new contextid
920             $newcontextid = $forcenewcontextid;
921         } else {
922             // Get new context, must exist or this will fail
923             $newcontextrecord = self::get_backup_ids_record($restoreid, 'context', $oldcontextid);
924             if (!$newcontextrecord || !$newcontextrecord->newitemid) {
925                 throw new restore_dbops_exception('unknown_context_mapping', $oldcontextid);
926             }
927             $newcontextid = $newcontextrecord->newitemid;
928         }
930         // Sometimes it's possible to have not the oldcontextids stored into backup_ids_temp->parentitemid
931         // columns (because we have used them to store other information). This happens usually with
932         // all the question related backup_ids_temp records. In that case, it's safe to ignore that
933         // matching as far as we are always restoring for well known oldcontexts and olditemids
934         $parentitemctxmatchsql = ' AND i.parentitemid = f.contextid ';
935         if ($skipparentitemidctxmatch) {
936             $parentitemctxmatchsql = '';
937         }
939         // Important: remember how files have been loaded to backup_files_temp
940         //   - info: contains the whole original object (times, names...)
941         //   (all them being original ids as loaded from xml)
943         // itemname = null, we are going to match only by context, no need to use itemid (all them are 0)
944         if ($itemname == null) {
945             $sql = "SELECT id AS bftid, contextid, component, filearea, itemid, itemid AS newitemid, info
946                       FROM {backup_files_temp}
947                      WHERE backupid = ?
948                        AND contextid = ?
949                        AND component = ?
950                        AND filearea  = ?";
951             $params = array($restoreid, $oldcontextid, $component, $filearea);
953         // itemname not null, going to join with backup_ids to perform the old-new mapping of itemids
954         } else {
955             $sql = "SELECT f.id AS bftid, f.contextid, f.component, f.filearea, f.itemid, i.newitemid, f.info
956                       FROM {backup_files_temp} f
957                       JOIN {backup_ids_temp} i ON i.backupid = f.backupid
958                                               $parentitemctxmatchsql
959                                               AND i.itemid = f.itemid
960                      WHERE f.backupid = ?
961                        AND f.contextid = ?
962                        AND f.component = ?
963                        AND f.filearea = ?
964                        AND i.itemname = ?";
965             $params = array($restoreid, $oldcontextid, $component, $filearea, $itemname);
966             if ($olditemid !== null) { // Just process ONE olditemid intead of the whole itemname
967                 $sql .= ' AND i.itemid = ?';
968                 $params[] = $olditemid;
969             }
970         }
972         $fs = get_file_storage();         // Get moodle file storage
973         $basepath = $basepath . '/files/';// Get backup file pool base
974         // Report progress before query.
975         if ($progress) {
976             $progress->progress();
977         }
978         $rs = $DB->get_recordset_sql($sql, $params);
979         foreach ($rs as $rec) {
980             // Report progress each time around loop.
981             if ($progress) {
982                 $progress->progress();
983             }
985             $file = (object)backup_controller_dbops::decode_backup_temp_info($rec->info);
987             // ignore root dirs (they are created automatically)
988             if ($file->filepath == '/' && $file->filename == '.') {
989                 continue;
990             }
992             // set the best possible user
993             $mappeduser = self::get_backup_ids_record($restoreid, 'user', $file->userid);
994             $mappeduserid = !empty($mappeduser) ? $mappeduser->newitemid : $dfltuserid;
996             // dir found (and not root one), let's create it
997             if ($file->filename == '.') {
998                 $fs->create_directory($newcontextid, $component, $filearea, $rec->newitemid, $file->filepath, $mappeduserid);
999                 continue;
1000             }
1002             // The file record to restore.
1003             $file_record = array(
1004                 'contextid'   => $newcontextid,
1005                 'component'   => $component,
1006                 'filearea'    => $filearea,
1007                 'itemid'      => $rec->newitemid,
1008                 'filepath'    => $file->filepath,
1009                 'filename'    => $file->filename,
1010                 'timecreated' => $file->timecreated,
1011                 'timemodified'=> $file->timemodified,
1012                 'userid'      => $mappeduserid,
1013                 'source'      => $file->source,
1014                 'author'      => $file->author,
1015                 'license'     => $file->license,
1016                 'sortorder'   => $file->sortorder
1017             );
1019             if (empty($file->repositoryid)) {
1020                 // If contenthash is empty then gracefully skip adding file.
1021                 if (empty($file->contenthash)) {
1022                     $result = new stdClass();
1023                     $result->code = 'file_missing_in_backup';
1024                     $result->message = sprintf('missing file (%s) contenthash in backup for component %s', $file->filename, $component);
1025                     $result->level = backup::LOG_WARNING;
1026                     $results[] = $result;
1027                     continue;
1028                 }
1029                 // this is a regular file, it must be present in the backup pool
1030                 $backuppath = $basepath . backup_file_manager::get_backup_content_file_location($file->contenthash);
1032                 // Some file types do not include the files as they should already be
1033                 // present. We still need to create entries into the files table.
1034                 if ($includesfiles) {
1035                     // The file is not found in the backup.
1036                     if (!file_exists($backuppath)) {
1037                         $results[] = self::get_missing_file_result($file);
1038                         continue;
1039                     }
1041                     // create the file in the filepool if it does not exist yet
1042                     if (!$fs->file_exists($newcontextid, $component, $filearea, $rec->newitemid, $file->filepath, $file->filename)) {
1044                         // If no license found, use default.
1045                         if ($file->license == null){
1046                             $file->license = $CFG->sitedefaultlicense;
1047                         }
1049                         $fs->create_file_from_pathname($file_record, $backuppath);
1050                     }
1051                 } else {
1052                     // This backup does not include the files - they should be available in moodle filestorage already.
1054                     // Create the file in the filepool if it does not exist yet.
1055                     if (!$fs->file_exists($newcontextid, $component, $filearea, $rec->newitemid, $file->filepath, $file->filename)) {
1057                         // Even if a file has been deleted since the backup was made, the file metadata may remain in the
1058                         // files table, and the file will not yet have been moved to the trashdir. e.g. a draft file version.
1059                         // Try to recover from file table first.
1060                         if ($foundfiles = $DB->get_records('files', array('contenthash' => $file->contenthash), '', '*', 0, 1)) {
1061                             // Only grab one of the foundfiles - the file content should be the same for all entries.
1062                             $foundfile = reset($foundfiles);
1063                             $fs->create_file_from_storedfile($file_record, $foundfile->id);
1064                         } else {
1065                             $filesystem = $fs->get_file_system();
1066                             $restorefile = $file;
1067                             $restorefile->contextid = $newcontextid;
1068                             $restorefile->itemid = $rec->newitemid;
1069                             $storedfile = new stored_file($fs, $restorefile);
1071                             // Ok, let's try recover this file.
1072                             // 1. We check if the file can be fetched locally without attempting to fetch
1073                             //    from the trash.
1074                             // 2. We check if we can get the remote filepath for the specified stored file.
1075                             // 3. We check if the file can be fetched from the trash.
1076                             // 4. All failed, say we couldn't find it.
1077                             if ($filesystem->is_file_readable_locally_by_storedfile($storedfile)) {
1078                                 $localpath = $filesystem->get_local_path_from_storedfile($storedfile);
1079                                 $fs->create_file_from_pathname($file, $localpath);
1080                             } else if ($filesystem->is_file_readable_remotely_by_storedfile($storedfile)) {
1081                                 $url = $filesystem->get_remote_path_from_storedfile($storedfile);
1082                                 $fs->create_file_from_url($file, $url);
1083                             } else if ($filesystem->is_file_readable_locally_by_storedfile($storedfile, true)) {
1084                                 $localpath = $filesystem->get_local_path_from_storedfile($storedfile, true);
1085                                 $fs->create_file_from_pathname($file, $localpath);
1086                             } else {
1087                                 // A matching file was not found.
1088                                 $results[] = self::get_missing_file_result($file);
1089                                 continue;
1090                             }
1091                         }
1092                     }
1093                 }
1095                 // store the the new contextid and the new itemid in case we need to remap
1096                 // references to this file later
1097                 $DB->update_record('backup_files_temp', array(
1098                     'id' => $rec->bftid,
1099                     'newcontextid' => $newcontextid,
1100                     'newitemid' => $rec->newitemid), true);
1102             } else {
1103                 // this is an alias - we can't create it yet so we stash it in a temp
1104                 // table and will let the final task to deal with it
1105                 if (!$fs->file_exists($newcontextid, $component, $filearea, $rec->newitemid, $file->filepath, $file->filename)) {
1106                     $info = new stdClass();
1107                     // oldfile holds the raw information stored in MBZ (including reference-related info)
1108                     $info->oldfile = $file;
1109                     // newfile holds the info for the new file_record with the context, user and itemid mapped
1110                     $info->newfile = (object) $file_record;
1112                     restore_dbops::set_backup_ids_record($restoreid, 'file_aliases_queue', $file->id, 0, null, $info);
1113                 }
1114             }
1115         }
1116         $rs->close();
1117         return $results;
1118     }
1120     /**
1121      * Returns suitable entry to include in log when there is a missing file.
1122      *
1123      * @param stdClass $file File definition
1124      * @return stdClass Log entry
1125      */
1126     protected static function get_missing_file_result($file) {
1127         $result = new stdClass();
1128         $result->code = 'file_missing_in_backup';
1129         $result->message = 'Missing file in backup: ' . $file->filepath  . $file->filename .
1130                 ' (old context ' . $file->contextid . ', component ' . $file->component .
1131                 ', filearea ' . $file->filearea . ', old itemid ' . $file->itemid . ')';
1132         $result->level = backup::LOG_WARNING;
1133         return $result;
1134     }
1136     /**
1137      * Given one restoreid, create in DB all the users present
1138      * in backup_ids having newitemid = 0, as far as
1139      * precheck_included_users() have left them there
1140      * ready to be created. Also, annotate their newids
1141      * once created for later reference.
1142      *
1143      * This function will start and end a new progress section in the progress
1144      * object.
1145      *
1146      * @param string $basepath Base path of unzipped backup
1147      * @param string $restoreid Restore ID
1148      * @param int $userid Default userid for files
1149      * @param \core\progress\base $progress Object used for progress tracking
1150      */
1151     public static function create_included_users($basepath, $restoreid, $userid,
1152             \core\progress\base $progress) {
1153         global $CFG, $DB;
1154         $progress->start_progress('Creating included users');
1156         $authcache = array(); // Cache to get some bits from authentication plugins
1157         $languages = get_string_manager()->get_list_of_translations(); // Get languages for quick search later
1158         $themes    = get_list_of_themes(); // Get themes for quick search later
1160         // Iterate over all the included users with newitemid = 0, have to create them
1161         $rs = $DB->get_recordset('backup_ids_temp', array('backupid' => $restoreid, 'itemname' => 'user', 'newitemid' => 0), '', 'itemid, parentitemid, info');
1162         foreach ($rs as $recuser) {
1163             $progress->progress();
1164             $user = (object)backup_controller_dbops::decode_backup_temp_info($recuser->info);
1166             // if user lang doesn't exist here, use site default
1167             if (!array_key_exists($user->lang, $languages)) {
1168                 $user->lang = $CFG->lang;
1169             }
1171             // if user theme isn't available on target site or they are disabled, reset theme
1172             if (!empty($user->theme)) {
1173                 if (empty($CFG->allowuserthemes) || !in_array($user->theme, $themes)) {
1174                     $user->theme = '';
1175                 }
1176             }
1178             // if user to be created has mnet auth and its mnethostid is $CFG->mnet_localhost_id
1179             // that's 100% impossible as own server cannot be accesed over mnet. Change auth to email/manual
1180             if ($user->auth == 'mnet' && $user->mnethostid == $CFG->mnet_localhost_id) {
1181                 // Respect registerauth
1182                 if ($CFG->registerauth == 'email') {
1183                     $user->auth = 'email';
1184                 } else {
1185                     $user->auth = 'manual';
1186                 }
1187             }
1188             unset($user->mnethosturl); // Not needed anymore
1190             // Disable pictures based on global setting
1191             if (!empty($CFG->disableuserimages)) {
1192                 $user->picture = 0;
1193             }
1195             // We need to analyse the AUTH field to recode it:
1196             //   - if the auth isn't enabled in target site, $CFG->registerauth will decide
1197             //   - finally, if the auth resulting isn't enabled, default to 'manual'
1198             if (!is_enabled_auth($user->auth)) {
1199                 if ($CFG->registerauth == 'email') {
1200                     $user->auth = 'email';
1201                 } else {
1202                     $user->auth = 'manual';
1203                 }
1204             }
1205             if (!is_enabled_auth($user->auth)) { // Final auth check verify, default to manual if not enabled
1206                 $user->auth = 'manual';
1207             }
1209             // Now that we know the auth method, for users to be created without pass
1210             // if password handling is internal and reset password is available
1211             // we set the password to "restored" (plain text), so the login process
1212             // will know how to handle that situation in order to allow the user to
1213             // recover the password. MDL-20846
1214             if (empty($user->password)) { // Only if restore comes without password
1215                 if (!array_key_exists($user->auth, $authcache)) { // Not in cache
1216                     $userauth = new stdClass();
1217                     $authplugin = get_auth_plugin($user->auth);
1218                     $userauth->preventpassindb = $authplugin->prevent_local_passwords();
1219                     $userauth->isinternal      = $authplugin->is_internal();
1220                     $userauth->canresetpwd     = $authplugin->can_reset_password();
1221                     $authcache[$user->auth] = $userauth;
1222                 } else {
1223                     $userauth = $authcache[$user->auth]; // Get from cache
1224                 }
1226                 // Most external plugins do not store passwords locally
1227                 if (!empty($userauth->preventpassindb)) {
1228                     $user->password = AUTH_PASSWORD_NOT_CACHED;
1230                 // If Moodle is responsible for storing/validating pwd and reset functionality is available, mark
1231                 } else if ($userauth->isinternal and $userauth->canresetpwd) {
1232                     $user->password = 'restored';
1233                 }
1234             }
1236             // Creating new user, we must reset the policyagreed always
1237             $user->policyagreed = 0;
1239             // Set time created if empty
1240             if (empty($user->timecreated)) {
1241                 $user->timecreated = time();
1242             }
1244             // Done, let's create the user and annotate its id
1245             $newuserid = $DB->insert_record('user', $user);
1246             self::set_backup_ids_record($restoreid, 'user', $recuser->itemid, $newuserid);
1247             // Let's create the user context and annotate it (we need it for sure at least for files)
1248             // but for deleted users that don't have a context anymore (MDL-30192). We are done for them
1249             // and nothing else (custom fields, prefs, tags, files...) will be created.
1250             if (empty($user->deleted)) {
1251                 $newuserctxid = $user->deleted ? 0 : context_user::instance($newuserid)->id;
1252                 self::set_backup_ids_record($restoreid, 'context', $recuser->parentitemid, $newuserctxid);
1254                 // Process custom fields
1255                 if (isset($user->custom_fields)) { // if present in backup
1256                     foreach($user->custom_fields['custom_field'] as $udata) {
1257                         $udata = (object)$udata;
1258                         // If the profile field has data and the profile shortname-datatype is defined in server
1259                         if ($udata->field_data) {
1260                             if ($field = $DB->get_record('user_info_field', array('shortname'=>$udata->field_name, 'datatype'=>$udata->field_type))) {
1261                             /// Insert the user_custom_profile_field
1262                                 $rec = new stdClass();
1263                                 $rec->userid  = $newuserid;
1264                                 $rec->fieldid = $field->id;
1265                                 $rec->data    = $udata->field_data;
1266                                 $DB->insert_record('user_info_data', $rec);
1267                             }
1268                         }
1269                     }
1270                 }
1272                 // Process tags
1273                 if (core_tag_tag::is_enabled('core', 'user') && isset($user->tags)) { // If enabled in server and present in backup.
1274                     $tags = array();
1275                     foreach($user->tags['tag'] as $usertag) {
1276                         $usertag = (object)$usertag;
1277                         $tags[] = $usertag->rawname;
1278                     }
1279                     core_tag_tag::set_item_tags('core', 'user', $newuserid,
1280                             context_user::instance($newuserid), $tags);
1281                 }
1283                 // Process preferences
1284                 if (isset($user->preferences)) { // if present in backup
1285                     foreach($user->preferences['preference'] as $preference) {
1286                         $preference = (object)$preference;
1287                         // Prepare the record and insert it
1288                         $preference->userid = $newuserid;
1289                         $status = $DB->insert_record('user_preferences', $preference);
1290                     }
1291                 }
1292                 // Special handling for htmleditor which was converted to a preference.
1293                 if (isset($user->htmleditor)) {
1294                     if ($user->htmleditor == 0) {
1295                         $preference = new stdClass();
1296                         $preference->userid = $newuserid;
1297                         $preference->name = 'htmleditor';
1298                         $preference->value = 'textarea';
1299                         $status = $DB->insert_record('user_preferences', $preference);
1300                     }
1301                 }
1303                 // Create user files in pool (profile, icon, private) by context
1304                 restore_dbops::send_files_to_pool($basepath, $restoreid, 'user', 'icon',
1305                         $recuser->parentitemid, $userid, null, null, null, false, $progress);
1306                 restore_dbops::send_files_to_pool($basepath, $restoreid, 'user', 'profile',
1307                         $recuser->parentitemid, $userid, null, null, null, false, $progress);
1308             }
1309         }
1310         $rs->close();
1311         $progress->end_progress();
1312     }
1314     /**
1315     * Given one user object (from backup file), perform all the neccesary
1316     * checks is order to decide how that user will be handled on restore.
1317     *
1318     * Note the function requires $user->mnethostid to be already calculated
1319     * so it's caller responsibility to set it
1320     *
1321     * This function is used both by @restore_precheck_users() and
1322     * @restore_create_users() to get consistent results in both places
1323     *
1324     * It returns:
1325     *   - one user object (from DB), if match has been found and user will be remapped
1326     *   - boolean true if the user needs to be created
1327     *   - boolean false if some conflict happened and the user cannot be handled
1328     *
1329     * Each test is responsible for returning its results and interrupt
1330     * execution. At the end, boolean true (user needs to be created) will be
1331     * returned if no test has interrupted that.
1332     *
1333     * Here it's the logic applied, keep it updated:
1334     *
1335     *  If restoring users from same site backup:
1336     *      1A - Normal check: If match by id and username and mnethost  => ok, return target user
1337     *      1B - If restoring an 'anonymous' user (created via the 'Anonymize user information' option) try to find a
1338     *           match by username only => ok, return target user MDL-31484
1339     *      1C - Handle users deleted in DB and "alive" in backup file:
1340     *           If match by id and mnethost and user is deleted in DB and
1341     *           (match by username LIKE 'backup_email.%' or by non empty email = md5(username)) => ok, return target user
1342     *      1D - Handle users deleted in backup file and "alive" in DB:
1343     *           If match by id and mnethost and user is deleted in backup file
1344     *           and match by email = email_without_time(backup_email) => ok, return target user
1345     *      1E - Conflict: If match by username and mnethost and doesn't match by id => conflict, return false
1346     *      1F - None of the above, return true => User needs to be created
1347     *
1348     *  if restoring from another site backup (cannot match by id here, replace it by email/firstaccess combination):
1349     *      2A - Normal check:
1350     *           2A1 - If match by username and mnethost and (email or non-zero firstaccess) => ok, return target user
1351     *           2A2 - Exceptional handling (MDL-21912): Match "admin" username. Then, if import_general_duplicate_admin_allowed is
1352     *                 enabled, attempt to map the admin user to the user 'admin_[oldsiteid]' if it exists. If not,
1353     *                 the user 'admin_[oldsiteid]' will be created in precheck_included users
1354     *      2B - Handle users deleted in DB and "alive" in backup file:
1355     *           2B1 - If match by mnethost and user is deleted in DB and not empty email = md5(username) and
1356     *                 (username LIKE 'backup_email.%' or non-zero firstaccess) => ok, return target user
1357     *           2B2 - If match by mnethost and user is deleted in DB and
1358     *                 username LIKE 'backup_email.%' and non-zero firstaccess) => ok, return target user
1359     *                 (to cover situations were md5(username) wasn't implemented on delete we requiere both)
1360     *      2C - Handle users deleted in backup file and "alive" in DB:
1361     *           If match mnethost and user is deleted in backup file
1362     *           and by email = email_without_time(backup_email) and non-zero firstaccess=> ok, return target user
1363     *      2D - Conflict: If match by username and mnethost and not by (email or non-zero firstaccess) => conflict, return false
1364     *      2E - None of the above, return true => User needs to be created
1365     *
1366     * Note: for DB deleted users email is stored in username field, hence we
1367     *       are looking there for emails. See delete_user()
1368     * Note: for DB deleted users md5(username) is stored *sometimes* in the email field,
1369     *       hence we are looking there for usernames if not empty. See delete_user()
1370     */
1371     protected static function precheck_user($user, $samesite, $siteid = null) {
1372         global $CFG, $DB;
1374         // Handle checks from same site backups
1375         if ($samesite && empty($CFG->forcedifferentsitecheckingusersonrestore)) {
1377             // 1A - If match by id and username and mnethost => ok, return target user
1378             if ($rec = $DB->get_record('user', array('id'=>$user->id, 'username'=>$user->username, 'mnethostid'=>$user->mnethostid))) {
1379                 return $rec; // Matching user found, return it
1380             }
1382             // 1B - If restoring an 'anonymous' user (created via the 'Anonymize user information' option) try to find a
1383             // match by username only => ok, return target user MDL-31484
1384             // This avoids username / id mis-match problems when restoring subsequent anonymized backups.
1385             if (backup_anonymizer_helper::is_anonymous_user($user)) {
1386                 if ($rec = $DB->get_record('user', array('username' => $user->username))) {
1387                     return $rec; // Matching anonymous user found - return it
1388                 }
1389             }
1391             // 1C - Handle users deleted in DB and "alive" in backup file
1392             // Note: for DB deleted users email is stored in username field, hence we
1393             //       are looking there for emails. See delete_user()
1394             // Note: for DB deleted users md5(username) is stored *sometimes* in the email field,
1395             //       hence we are looking there for usernames if not empty. See delete_user()
1396             // If match by id and mnethost and user is deleted in DB and
1397             // match by username LIKE 'substring(backup_email).%' where the substr length matches the retained data in the
1398             // username field (100 - (timestamp + 1) characters), or by non empty email = md5(username) => ok, return target user.
1399             $usernamelookup = core_text::substr($user->email, 0, 89) . '.%';
1400             if ($rec = $DB->get_record_sql("SELECT *
1401                                               FROM {user} u
1402                                              WHERE id = ?
1403                                                AND mnethostid = ?
1404                                                AND deleted = 1
1405                                                AND (
1406                                                        UPPER(username) LIKE UPPER(?)
1407                                                     OR (
1408                                                            ".$DB->sql_isnotempty('user', 'email', false, false)."
1409                                                        AND email = ?
1410                                                        )
1411                                                    )",
1412                                            array($user->id, $user->mnethostid, $usernamelookup, md5($user->username)))) {
1413                 return $rec; // Matching user, deleted in DB found, return it
1414             }
1416             // 1D - Handle users deleted in backup file and "alive" in DB
1417             // If match by id and mnethost and user is deleted in backup file
1418             // and match by substring(email) = email_without_time(backup_email) where the substr length matches the retained data
1419             // in the username field (100 - (timestamp + 1) characters) => ok, return target user.
1420             if ($user->deleted) {
1421                 // Note: for DB deleted users email is stored in username field, hence we
1422                 //       are looking there for emails. See delete_user()
1423                 // Trim time() from email
1424                 $trimemail = preg_replace('/(.*?)\.[0-9]+.?$/', '\\1', $user->username);
1425                 if ($rec = $DB->get_record_sql("SELECT *
1426                                                   FROM {user} u
1427                                                  WHERE id = ?
1428                                                    AND mnethostid = ?
1429                                                    AND " . $DB->sql_substr('UPPER(email)', 1, 89) . " = UPPER(?)",
1430                                                array($user->id, $user->mnethostid, $trimemail))) {
1431                     return $rec; // Matching user, deleted in backup file found, return it
1432                 }
1433             }
1435             // 1E - If match by username and mnethost and doesn't match by id => conflict, return false
1436             if ($rec = $DB->get_record('user', array('username'=>$user->username, 'mnethostid'=>$user->mnethostid))) {
1437                 if ($user->id != $rec->id) {
1438                     return false; // Conflict, username already exists and belongs to another id
1439                 }
1440             }
1442         // Handle checks from different site backups
1443         } else {
1445             // 2A1 - If match by username and mnethost and
1446             //     (email or non-zero firstaccess) => ok, return target user
1447             if ($rec = $DB->get_record_sql("SELECT *
1448                                               FROM {user} u
1449                                              WHERE username = ?
1450                                                AND mnethostid = ?
1451                                                AND (
1452                                                        UPPER(email) = UPPER(?)
1453                                                     OR (
1454                                                            firstaccess != 0
1455                                                        AND firstaccess = ?
1456                                                        )
1457                                                    )",
1458                                            array($user->username, $user->mnethostid, $user->email, $user->firstaccess))) {
1459                 return $rec; // Matching user found, return it
1460             }
1462             // 2A2 - If we're allowing conflicting admins, attempt to map user to admin_[oldsiteid].
1463             if (get_config('backup', 'import_general_duplicate_admin_allowed') && $user->username === 'admin' && $siteid
1464                     && $user->mnethostid == $CFG->mnet_localhost_id) {
1465                 if ($rec = $DB->get_record('user', array('username' => 'admin_' . $siteid))) {
1466                     return $rec;
1467                 }
1468             }
1470             // 2B - Handle users deleted in DB and "alive" in backup file
1471             // Note: for DB deleted users email is stored in username field, hence we
1472             //       are looking there for emails. See delete_user()
1473             // Note: for DB deleted users md5(username) is stored *sometimes* in the email field,
1474             //       hence we are looking there for usernames if not empty. See delete_user()
1475             // 2B1 - If match by mnethost and user is deleted in DB and not empty email = md5(username) and
1476             //       (by username LIKE 'substring(backup_email).%' or non-zero firstaccess) => ok, return target user.
1477             $usernamelookup = core_text::substr($user->email, 0, 89) . '.%';
1478             if ($rec = $DB->get_record_sql("SELECT *
1479                                               FROM {user} u
1480                                              WHERE mnethostid = ?
1481                                                AND deleted = 1
1482                                                AND ".$DB->sql_isnotempty('user', 'email', false, false)."
1483                                                AND email = ?
1484                                                AND (
1485                                                        UPPER(username) LIKE UPPER(?)
1486                                                     OR (
1487                                                            firstaccess != 0
1488                                                        AND firstaccess = ?
1489                                                        )
1490                                                    )",
1491                                            array($user->mnethostid, md5($user->username), $usernamelookup, $user->firstaccess))) {
1492                 return $rec; // Matching user found, return it
1493             }
1495             // 2B2 - If match by mnethost and user is deleted in DB and
1496             //       username LIKE 'substring(backup_email).%' and non-zero firstaccess) => ok, return target user
1497             //       (this covers situations where md5(username) wasn't being stored so we require both
1498             //        the email & non-zero firstaccess to match)
1499             $usernamelookup = core_text::substr($user->email, 0, 89) . '.%';
1500             if ($rec = $DB->get_record_sql("SELECT *
1501                                               FROM {user} u
1502                                              WHERE mnethostid = ?
1503                                                AND deleted = 1
1504                                                AND UPPER(username) LIKE UPPER(?)
1505                                                AND firstaccess != 0
1506                                                AND firstaccess = ?",
1507                                            array($user->mnethostid, $usernamelookup, $user->firstaccess))) {
1508                 return $rec; // Matching user found, return it
1509             }
1511             // 2C - Handle users deleted in backup file and "alive" in DB
1512             // If match mnethost and user is deleted in backup file
1513             // and match by substring(email) = email_without_time(backup_email) and non-zero firstaccess=> ok, return target user.
1514             if ($user->deleted) {
1515                 // Note: for DB deleted users email is stored in username field, hence we
1516                 //       are looking there for emails. See delete_user()
1517                 // Trim time() from email
1518                 $trimemail = preg_replace('/(.*?)\.[0-9]+.?$/', '\\1', $user->username);
1519                 if ($rec = $DB->get_record_sql("SELECT *
1520                                                   FROM {user} u
1521                                                  WHERE mnethostid = ?
1522                                                    AND " . $DB->sql_substr('UPPER(email)', 1, 89) . " = UPPER(?)
1523                                                    AND firstaccess != 0
1524                                                    AND firstaccess = ?",
1525                                                array($user->mnethostid, $trimemail, $user->firstaccess))) {
1526                     return $rec; // Matching user, deleted in backup file found, return it
1527                 }
1528             }
1530             // 2D - If match by username and mnethost and not by (email or non-zero firstaccess) => conflict, return false
1531             if ($rec = $DB->get_record_sql("SELECT *
1532                                               FROM {user} u
1533                                              WHERE username = ?
1534                                                AND mnethostid = ?
1535                                            AND NOT (
1536                                                        UPPER(email) = UPPER(?)
1537                                                     OR (
1538                                                            firstaccess != 0
1539                                                        AND firstaccess = ?
1540                                                        )
1541                                                    )",
1542                                            array($user->username, $user->mnethostid, $user->email, $user->firstaccess))) {
1543                 return false; // Conflict, username/mnethostid already exist and belong to another user (by email/firstaccess)
1544             }
1545         }
1547         // Arrived here, return true as the user will need to be created and no
1548         // conflicts have been found in the logic above. This covers:
1549         // 1E - else => user needs to be created, return true
1550         // 2E - else => user needs to be created, return true
1551         return true;
1552     }
1554     /**
1555      * Check all the included users, deciding the action to perform
1556      * for each one (mapping / creation) and returning one array
1557      * of problems in case something is wrong (lack of permissions,
1558      * conficts)
1559      *
1560      * @param string $restoreid Restore id
1561      * @param int $courseid Course id
1562      * @param int $userid User id
1563      * @param bool $samesite True if restore is to same site
1564      * @param \core\progress\base $progress Progress reporter
1565      */
1566     public static function precheck_included_users($restoreid, $courseid, $userid, $samesite,
1567             \core\progress\base $progress) {
1568         global $CFG, $DB;
1570         // To return any problem found
1571         $problems = array();
1573         // We are going to map mnethostid, so load all the available ones
1574         $mnethosts = $DB->get_records('mnet_host', array(), 'wwwroot', 'wwwroot, id');
1576         // Calculate the context we are going to use for capability checking
1577         $context = context_course::instance($courseid);
1579         // TODO: Some day we must kill this dependency and change the process
1580         // to pass info around without loading a controller copy.
1581         // When conflicting users are detected we may need original site info.
1582         $rc = restore_controller_dbops::load_controller($restoreid);
1583         $restoreinfo = $rc->get_info();
1584         $rc->destroy(); // Always need to destroy.
1586         // Calculate if we have perms to create users, by checking:
1587         // to 'moodle/restore:createuser' and 'moodle/restore:userinfo'
1588         // and also observe $CFG->disableusercreationonrestore
1589         $cancreateuser = false;
1590         if (has_capability('moodle/restore:createuser', $context, $userid) and
1591             has_capability('moodle/restore:userinfo', $context, $userid) and
1592             empty($CFG->disableusercreationonrestore)) { // Can create users
1594             $cancreateuser = true;
1595         }
1597         // Prepare for reporting progress.
1598         $conditions = array('backupid' => $restoreid, 'itemname' => 'user');
1599         $max = $DB->count_records('backup_ids_temp', $conditions);
1600         $done = 0;
1601         $progress->start_progress('Checking users', $max);
1603         // Iterate over all the included users
1604         $rs = $DB->get_recordset('backup_ids_temp', $conditions, '', 'itemid, info');
1605         foreach ($rs as $recuser) {
1606             $user = (object)backup_controller_dbops::decode_backup_temp_info($recuser->info);
1608             // Find the correct mnethostid for user before performing any further check
1609             if (empty($user->mnethosturl) || $user->mnethosturl === $CFG->wwwroot) {
1610                 $user->mnethostid = $CFG->mnet_localhost_id;
1611             } else {
1612                 // fast url-to-id lookups
1613                 if (isset($mnethosts[$user->mnethosturl])) {
1614                     $user->mnethostid = $mnethosts[$user->mnethosturl]->id;
1615                 } else {
1616                     $user->mnethostid = $CFG->mnet_localhost_id;
1617                 }
1618             }
1620             // Now, precheck that user and, based on returned results, annotate action/problem
1621             $usercheck = self::precheck_user($user, $samesite, $restoreinfo->original_site_identifier_hash);
1623             if (is_object($usercheck)) { // No problem, we have found one user in DB to be mapped to
1624                 // Annotate it, for later process. Set newitemid to mapping user->id
1625                 self::set_backup_ids_record($restoreid, 'user', $recuser->itemid, $usercheck->id);
1627             } else if ($usercheck === false) { // Found conflict, report it as problem
1628                 if (!get_config('backup', 'import_general_duplicate_admin_allowed')) {
1629                     $problems[] = get_string('restoreuserconflict', '', $user->username);
1630                 } else if ($user->username == 'admin') {
1631                     if (!$cancreateuser) {
1632                         $problems[] = get_string('restorecannotcreateuser', '', $user->username);
1633                     }
1634                     if ($user->mnethostid != $CFG->mnet_localhost_id) {
1635                         $problems[] = get_string('restoremnethostidmismatch', '', $user->username);
1636                     }
1637                     if (!$problems) {
1638                         // Duplicate admin allowed, append original site idenfitier to username.
1639                         $user->username .= '_' . $restoreinfo->original_site_identifier_hash;
1640                         self::set_backup_ids_record($restoreid, 'user', $recuser->itemid, 0, null, (array)$user);
1641                     }
1642                 }
1644             } else if ($usercheck === true) { // User needs to be created, check if we are able
1645                 if ($cancreateuser) { // Can create user, set newitemid to 0 so will be created later
1646                     self::set_backup_ids_record($restoreid, 'user', $recuser->itemid, 0, null, (array)$user);
1648                 } else { // Cannot create user, report it as problem
1649                     $problems[] = get_string('restorecannotcreateuser', '', $user->username);
1650                 }
1652             } else { // Shouldn't arrive here ever, something is for sure wrong. Exception
1653                 throw new restore_dbops_exception('restore_error_processing_user', $user->username);
1654             }
1655             $done++;
1656             $progress->progress($done);
1657         }
1658         $rs->close();
1659         $progress->end_progress();
1660         return $problems;
1661     }
1663     /**
1664      * Process the needed users in order to decide
1665      * which action to perform with them (create/map)
1666      *
1667      * Just wrap over precheck_included_users(), returning
1668      * exception if any problem is found
1669      *
1670      * @param string $restoreid Restore id
1671      * @param int $courseid Course id
1672      * @param int $userid User id
1673      * @param bool $samesite True if restore is to same site
1674      * @param \core\progress\base $progress Optional progress tracker
1675      */
1676     public static function process_included_users($restoreid, $courseid, $userid, $samesite,
1677             \core\progress\base $progress = null) {
1678         global $DB;
1680         // Just let precheck_included_users() to do all the hard work
1681         $problems = self::precheck_included_users($restoreid, $courseid, $userid, $samesite, $progress);
1683         // With problems, throw exception, shouldn't happen if prechecks were originally
1684         // executed, so be radical here.
1685         if (!empty($problems)) {
1686             throw new restore_dbops_exception('restore_problems_processing_users', null, implode(', ', $problems));
1687         }
1688     }
1690     /**
1691      * Process the needed question categories and questions
1692      * to check all them, deciding about the action to perform
1693      * (create/map) and target.
1694      *
1695      * Just wrap over precheck_categories_and_questions(), returning
1696      * exception if any problem is found
1697      */
1698     public static function process_categories_and_questions($restoreid, $courseid, $userid, $samesite) {
1699         global $DB;
1701         // Just let precheck_included_users() to do all the hard work
1702         $problems = self::precheck_categories_and_questions($restoreid, $courseid, $userid, $samesite);
1704         // With problems of type error, throw exception, shouldn't happen if prechecks were originally
1705         // executed, so be radical here.
1706         if (array_key_exists('errors', $problems)) {
1707             throw new restore_dbops_exception('restore_problems_processing_questions', null, implode(', ', $problems['errors']));
1708         }
1709     }
1711     public static function set_backup_files_record($restoreid, $filerec) {
1712         global $DB;
1714         // Store external files info in `info` field
1715         $filerec->info     = backup_controller_dbops::encode_backup_temp_info($filerec); // Encode the whole record into info.
1716         $filerec->backupid = $restoreid;
1717         $DB->insert_record('backup_files_temp', $filerec);
1718     }
1720     public static function set_backup_ids_record($restoreid, $itemname, $itemid, $newitemid = 0, $parentitemid = null, $info = null) {
1721         // Build conditionally the extra record info
1722         $extrarecord = array();
1723         if ($newitemid != 0) {
1724             $extrarecord['newitemid'] = $newitemid;
1725         }
1726         if ($parentitemid != null) {
1727             $extrarecord['parentitemid'] = $parentitemid;
1728         }
1729         if ($info != null) {
1730             $extrarecord['info'] = backup_controller_dbops::encode_backup_temp_info($info);
1731         }
1733         self::set_backup_ids_cached($restoreid, $itemname, $itemid, $extrarecord);
1734     }
1736     public static function get_backup_ids_record($restoreid, $itemname, $itemid) {
1737         $dbrec = self::get_backup_ids_cached($restoreid, $itemname, $itemid);
1739         // We must test if info is a string, as the cache stores info in object form.
1740         if ($dbrec && isset($dbrec->info) && is_string($dbrec->info)) {
1741             $dbrec->info = backup_controller_dbops::decode_backup_temp_info($dbrec->info);
1742         }
1744         return $dbrec;
1745     }
1747     /**
1748      * Given on courseid, fullname and shortname, calculate the correct fullname/shortname to avoid dupes
1749      */
1750     public static function calculate_course_names($courseid, $fullname, $shortname) {
1751         global $CFG, $DB;
1753         $currentfullname = '';
1754         $currentshortname = '';
1755         $counter = 0;
1756         // Iteratere while the name exists
1757         do {
1758             if ($counter) {
1759                 $suffixfull  = ' ' . get_string('copyasnoun') . ' ' . $counter;
1760                 $suffixshort = '_' . $counter;
1761             } else {
1762                 $suffixfull  = '';
1763                 $suffixshort = '';
1764             }
1765             $currentfullname = $fullname.$suffixfull;
1766             $currentshortname = substr($shortname, 0, 100 - strlen($suffixshort)).$suffixshort; // < 100cc
1767             $coursefull  = $DB->get_record_select('course', 'fullname = ? AND id != ?',
1768                     array($currentfullname, $courseid), '*', IGNORE_MULTIPLE);
1769             $courseshort = $DB->get_record_select('course', 'shortname = ? AND id != ?', array($currentshortname, $courseid));
1770             $counter++;
1771         } while ($coursefull || $courseshort);
1773         // Return results
1774         return array($currentfullname, $currentshortname);
1775     }
1777     /**
1778      * For the target course context, put as many custom role names as possible
1779      */
1780     public static function set_course_role_names($restoreid, $courseid) {
1781         global $DB;
1783         // Get the course context
1784         $coursectx = context_course::instance($courseid);
1785         // Get all the mapped roles we have
1786         $rs = $DB->get_recordset('backup_ids_temp', array('backupid' => $restoreid, 'itemname' => 'role'), '', 'itemid, info, newitemid');
1787         foreach ($rs as $recrole) {
1788             $info = backup_controller_dbops::decode_backup_temp_info($recrole->info);
1789             // If it's one mapped role and we have one name for it
1790             if (!empty($recrole->newitemid) && !empty($info['nameincourse'])) {
1791                 // If role name doesn't exist, add it
1792                 $rolename = new stdclass();
1793                 $rolename->roleid = $recrole->newitemid;
1794                 $rolename->contextid = $coursectx->id;
1795                 if (!$DB->record_exists('role_names', (array)$rolename)) {
1796                     $rolename->name = $info['nameincourse'];
1797                     $DB->insert_record('role_names', $rolename);
1798                 }
1799             }
1800         }
1801         $rs->close();
1802     }
1804     /**
1805      * Creates a skeleton record within the database using the passed parameters
1806      * and returns the new course id.
1807      *
1808      * @global moodle_database $DB
1809      * @param string $fullname
1810      * @param string $shortname
1811      * @param int $categoryid
1812      * @return int The new course id
1813      */
1814     public static function create_new_course($fullname, $shortname, $categoryid) {
1815         global $DB;
1816         $category = $DB->get_record('course_categories', array('id'=>$categoryid), '*', MUST_EXIST);
1818         $course = new stdClass;
1819         $course->fullname = $fullname;
1820         $course->shortname = $shortname;
1821         $course->category = $category->id;
1822         $course->sortorder = 0;
1823         $course->timecreated  = time();
1824         $course->timemodified = $course->timecreated;
1825         // forcing skeleton courses to be hidden instead of going by $category->visible , until MDL-27790 is resolved.
1826         $course->visible = 0;
1828         $courseid = $DB->insert_record('course', $course);
1830         $category->coursecount++;
1831         $DB->update_record('course_categories', $category);
1833         return $courseid;
1834     }
1836     /**
1837      * Deletes all of the content associated with the given course (courseid)
1838      * @param int $courseid
1839      * @param array $options
1840      * @return bool True for success
1841      */
1842     public static function delete_course_content($courseid, array $options = null) {
1843         return remove_course_contents($courseid, false, $options);
1844     }
1847 /*
1848  * Exception class used by all the @dbops stuff
1849  */
1850 class restore_dbops_exception extends backup_exception {
1852     public function __construct($errorcode, $a=NULL, $debuginfo=null) {
1853         parent::__construct($errorcode, 'error', '', $a, null, $debuginfo);
1854     }