98fd2ce0534828f944f25f78a633c42a6ce1cd11
[moodle.git] / backup / util / dbops / restore_dbops.class.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * @package    moodlecore
20  * @subpackage backup-dbops
21  * @copyright  2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 /**
26  * Base abstract class for all the helper classes providing DB operations
27  *
28  * TODO: Finish phpdocs
29  */
30 abstract class restore_dbops {
32     /**
33      * Return all the inforef.xml files to be loaded into the temp_ids table
34      * We do that by loading the controller from DB, then iterating over all the
35      * included tasks and calculating all the inforef files for them
36      */
37     public static function get_needed_inforef_files($restoreid) {
38         $rc = restore_controller_dbops::load_controller($restoreid);
39         $tasks = $rc->get_plan()->get_tasks();
40         $files = array();
41         foreach ($tasks as $task) {
42             // Calculate if the task is being included
43             $included = false;
44             // blocks, based in blocks setting and parent activity/course
45             if ($task instanceof restore_block_task) {
46                 if (!$task->get_setting_value('blocks')) { // Blocks not included, continue
47                     continue;
48                 }
49                 $parent = basename(dirname(dirname($task->get_taskbasepath())));
50                 if ($parent == 'course') { // Parent is course, always included if present
51                     $included = true;
53                 } else { // Look for activity_included setting
54                     $included = $task->get_setting_value($parent . '_included');
55                 }
57             // ativities, based on included setting
58             } else if ($task instanceof restore_activity_task) {
59                 $included = $task->get_setting_value('included');
61             // sections, based on included setting
62             } else if ($task instanceof restore_section_task) {
63                 $included = $task->get_setting_value('included');
65             // course always included if present
66             } else if ($task instanceof restore_course_task) {
67                 $included = true;
68             }
70             // If included and file exists, add it to results
71             if ($included) {
72                 $inforefpath = $task->get_taskbasepath() . '/inforef.xml';
73                 if (file_exists($inforefpath)) {
74                     $files[] = $inforefpath;
75                 }
76             }
77         }
78         return $files;
79     }
81     /**
82      * Load one inforef.xml file to backup_ids table for future reference
83      */
84     public static function load_inforef_to_tempids($restoreid, $inforeffile) {
86         if (!file_exists($inforeffile)) { // Shouldn't happen ever, but...
87             throw new backup_helper_exception('missing_inforef_xml_file', $inforeffile);
88         }
89         // Let's parse, custom processor will do its work, sending info to DB
90         $xmlparser = new progressive_parser();
91         $xmlparser->set_file($inforeffile);
92         $xmlprocessor = new restore_inforef_parser_processor($restoreid);
93         $xmlparser->set_processor($xmlprocessor);
94         $xmlparser->process();
95     }
97     /**
98      * Load the needed role.xml file to backup_ids table for future reference
99      */
100     public static function load_roles_to_tempids($restoreid, $rolesfile) {
102         if (!file_exists($rolesfile)) { // Shouldn't happen ever, but...
103             throw new backup_helper_exception('missing_roles_xml_file', $rolesfile);
104         }
105         // Let's parse, custom processor will do its work, sending info to DB
106         $xmlparser = new progressive_parser();
107         $xmlparser->set_file($rolesfile);
108         $xmlprocessor = new restore_roles_parser_processor($restoreid);
109         $xmlparser->set_processor($xmlprocessor);
110         $xmlparser->process();
111     }
113     /**
114      * Precheck the loaded roles, return empty array if everything is ok, and
115      * array with 'errors', 'warnings' elements (suitable to be used by restore_prechecks)
116      * with any problem found. At the same time, store all the mapping into backup_ids_temp
117      * and also put the information into $rolemappings (controller->info), so it can be reworked later by
118      * post-precheck stages while at the same time accept modified info in the same object coming from UI
119      */
120     public static function precheck_included_roles($restoreid, $courseid, $userid, $samesite, $rolemappings) {
121         global $DB;
123         $problems = array(); // To store warnings/errors
125         // Get loaded roles from backup_ids
126         $rs = $DB->get_recordset('backup_ids_temp', array('backupid' => $restoreid, 'itemname' => 'role'), '', 'itemid');
127         foreach ($rs as $recrole) {
128             // If the rolemappings->modified flag is set, that means that we are coming from
129             // manually modified mappings (by UI), so accept those mappings an put them to backup_ids
130             if ($rolemappings->modified) {
131                 $target = $rolemappings->mappings[$recrole->itemid]->targetroleid;
132                 self::set_backup_ids_record($restoreid, 'role', $recrole->itemid, $target);
134             // Else, we haven't any info coming from UI, let's calculate the mappings, matching
135             // in multiple ways and checking permissions. Note mapping to 0 means "skip"
136             } else {
137                 $role = (object)self::get_backup_ids_record($restoreid, 'role', $recrole->itemid)->info;
138                 $match = self::get_best_assignable_role($role, $courseid, $userid, $samesite);
139                 // Send match to backup_ids
140                 self::set_backup_ids_record($restoreid, 'role', $recrole->itemid, $match);
141                 // Build the rolemappings element for controller
142                 unset($role->id);
143                 unset($role->nameincourse);
144                 unset($role->nameincourse);
145                 $role->targetroleid = $match;
146                 $rolemappings->mappings[$recrole->itemid] = $role;
147                 // Prepare warning if no match found
148                 if (!$match) {
149                     $problems['warnings'][] = get_string('cannotfindassignablerole', 'backup', $role->name);
150                 }
151             }
152         }
153         $rs->close();
154         return $problems;
155     }
157     /**
158      * Given one role, as loaded from XML, perform the best possible matching against the assignable
159      * roles, using different fallback alternatives (shortname, archetype, editingteacher => teacher, defaultcourseroleid)
160      * returning the id of the best matching role or 0 if no match is found
161      */
162     protected static function get_best_assignable_role($role, $courseid, $userid, $samesite) {
163         global $CFG, $DB;
165         // Gather various information about roles
166         $coursectx = get_context_instance(CONTEXT_COURSE, $courseid);
167         $allroles = $DB->get_records('role');
168         $assignablerolesshortname = get_assignable_roles($coursectx, ROLENAME_SHORT, false, $userid);
170         // Note: under 1.9 we had one function restore_samerole() that performed one complete
171         // matching of roles (all caps) and if match was found the mapping was availabe bypassing
172         // any assignable_roles() security. IMO that was wrong and we must not allow such
173         // mappings anymore. So we have left that matching strategy out in 2.0
175         // Empty assignable roles, mean no match possible
176         if (empty($assignablerolesshortname)) {
177             return 0;
178         }
180         // Match by shortname
181         if ($match = array_search($role->shortname, $assignablerolesshortname)) {
182             return $match;
183         }
185         // Match by archetype
186         list($in_sql, $in_params) = $DB->get_in_or_equal(array_keys($assignablerolesshortname));
187         $params = array_merge(array($role->archetype), $in_params);
188         if ($rec = $DB->get_record_select('role', "archetype = ? AND id $in_sql", $params, 'id', IGNORE_MULTIPLE)) {
189             return $rec->id;
190         }
192         // Match editingteacher to teacher (happens a lot, from 1.9)
193         if ($role->shortname == 'editingteacher' && in_array('teacher', $assignablerolesshortname)) {
194             return array_search('teacher', $assignablerolesshortname);
195         }
197         // No match, return 0
198         return 0;
199     }
202     /**
203      * Process the loaded roles, looking for their best mapping or skipping
204      * Any error will cause exception. Note this is one wrapper over
205      * precheck_included_roles, that contains all the logic, but returns
206      * errors/warnings instead and is executed as part of the restore prechecks
207      */
208      public static function process_included_roles($restoreid, $courseid, $userid, $samesite, $rolemappings) {
209         global $DB;
211         // Just let precheck_included_roles() to do all the hard work
212         $problems = self::precheck_included_roles($restoreid, $courseid, $userid, $samesite, $rolemappings);
214         // With problems of type error, throw exception, shouldn't happen if prechecks executed
215         if (array_key_exists('errors', $problems)) {
216             throw new restore_dbops_exception('restore_problems_processing_roles', null, implode(', ', $problems['errors']));
217         }
218     }
220     /**
221      * Load the needed users.xml file to backup_ids table for future reference
222      */
223     public static function load_users_to_tempids($restoreid, $usersfile) {
225         if (!file_exists($usersfile)) { // Shouldn't happen ever, but...
226             throw new backup_helper_exception('missing_users_xml_file', $usersfile);
227         }
228         // Let's parse, custom processor will do its work, sending info to DB
229         $xmlparser = new progressive_parser();
230         $xmlparser->set_file($usersfile);
231         $xmlprocessor = new restore_users_parser_processor($restoreid);
232         $xmlparser->set_processor($xmlprocessor);
233         $xmlparser->process();
234     }
236     /**
237      * Load the needed questions.xml file to backup_ids table for future reference
238      */
239     public static function load_categories_and_questions_to_tempids($restoreid, $questionsfile) {
241         if (!file_exists($questionsfile)) { // Shouldn't happen ever, but...
242             throw new backup_helper_exception('missing_questions_xml_file', $questionsfile);
243         }
244         // Let's parse, custom processor will do its work, sending info to DB
245         $xmlparser = new progressive_parser();
246         $xmlparser->set_file($questionsfile);
247         $xmlprocessor = new restore_questions_parser_processor($restoreid);
248         $xmlparser->set_processor($xmlprocessor);
249         $xmlparser->process();
250     }
252     /**
253      * Check all the included categories and questions, deciding the action to perform
254      * for each one (mapping / creation) and returning one array of problems in case
255      * something is wrong.
256      *
257      * There are some basic rules that the method below will always try to enforce:
258      *
259      * Rule1: Targets will be, always, calculated for *whole* question banks (a.k.a. contexid source),
260      *     so, given 2 question categories belonging to the same bank, their target bank will be
261      *     always the same. If not, we can be incurring into "fragmentation", leading to random/cloze
262      *     problems (qtypes having "child" questions).
263      *
264      * Rule2: The 'moodle/question:managecategory' and 'moodle/question:add' capabilities will be
265      *     checked before creating any category/question respectively and, if the cap is not allowed
266      *     into upper contexts (system, coursecat)) but in lower ones (course), the *whole* question bank
267      *     will be created there.
268      *
269      * Rule3: Coursecat question banks not existing in the target site will be created as course
270      *     (lower ctx) question banks, never as "guessed" coursecat question banks base on depth or so.
271      *
272      * Rule4: System question banks will be created at system context if user has perms to do so. Else they
273      *     will created as course (lower ctx) question banks (similary to rule3). In other words, course ctx
274      *     if always a fallback for system and coursecat question banks.
275      *
276      * Also, there are some notes to clarify the scope of this method:
277      *
278      * Note1: This method won't create any question category nor question at all. It simply will calculate
279      *     which actions (create/map) must be performed for each element and where, validating that all those
280      *     actions are doable by the user executing the restore operation. Any problem found will be
281      *     returned in the problems array, causing the restore process to stop with error.
282      *
283      * Note2: To decide if one question bank (all its question categories and questions) is going to be remapped,
284      *     then all the categories and questions must exist in the same target bank. If able to do so, missing
285      *     qcats and qs will be created (rule2). But if, at the end, something is missing, the whole question bank
286      *     will be recreated at course ctx (rule1), no matter if that duplicates some categories/questions.
287      *
288      * Note3: We'll be using the newitemid column in the temp_ids table to store the action to be performed
289      *     with each question category and question. newitemid = 0 means the qcat/q needs to be created and
290      *     any other value means the qcat/q is mapped. Also, for qcats, parentitemid will contain the target
291      *     context where the categories have to be created (but for module contexts where we'll keep the old
292      *     one until the activity is created)
293      *
294      * Note4: All these "actions" will be "executed" later by {@link restore_create_categories_and_questions}
295      */
296     public static function precheck_categories_and_questions($restoreid, $courseid, $userid, $samesite) {
298         $problems = array();
300         // TODO: Check all qs, looking their qtypes are restorable
302         // Precheck all qcats and qs looking for target contexts / warnings / errors
303         list($syserr, $syswarn) = self::prechek_precheck_qbanks_by_level($restoreid, $courseid, $userid, $samesite, CONTEXT_SYSTEM);
304         list($caterr, $catwarn) = self::prechek_precheck_qbanks_by_level($restoreid, $courseid, $userid, $samesite, CONTEXT_COURSECAT);
305         list($couerr, $couwarn) = self::prechek_precheck_qbanks_by_level($restoreid, $courseid, $userid, $samesite, CONTEXT_COURSE);
306         list($moderr, $modwarn) = self::prechek_precheck_qbanks_by_level($restoreid, $courseid, $userid, $samesite, CONTEXT_MODULE);
308         // Acummulate and handle errors and warnings
309         $errors   = array_merge($syserr, $caterr, $couerr, $moderr);
310         $warnings = array_merge($syswarn, $catwarn, $couwarn, $modwarn);
311         if (!empty($errors)) {
312             $problems['errors'] = $errors;
313         }
314         if (!empty($warnings)) {
315             $problems['warnings'] = $warnings;
316         }
317         return $problems;
318     }
320     /**
321      * This function will process all the question banks present in restore
322      * at some contextlevel (from CONTEXT_SYSTEM to CONTEXT_MODULE), finding
323      * the target contexts where each bank will be restored and returning
324      * warnings/errors as needed.
325      *
326      * Some contextlevels (system, coursecat), will delegate process to
327      * course level if any problem is found (lack of permissions, non-matching
328      * target context...). Other contextlevels (course, module) will
329      * cause return error if some problem is found.
330      *
331      * At the end, if no errors were found, all the categories in backup_temp_ids
332      * will be pointing (parentitemid) to the target context where they must be
333      * created later in the restore process.
334      *
335      * Note: at the time these prechecks are executed, activities haven't been
336      * created yet so, for CONTEXT_MODULE banks, we keep the old contextid
337      * in the parentitemid field. Once the activity (and its context) has been
338      * created, we'll update that context in the required qcats
339      *
340      * Caller {@link precheck_categories_and_questions} will, simply, execute
341      * this function for all the contextlevels, acting as a simple controller
342      * of warnings and errors.
343      *
344      * The function returns 2 arrays, one containing errors and another containing
345      * warnings. Both empty if no errors/warnings are found.
346      */
347     public static function prechek_precheck_qbanks_by_level($restoreid, $courseid, $userid, $samesite, $contextlevel) {
348         global $CFG, $DB;
350         // To return any errors and warnings found
351         $errors   = array();
352         $warnings = array();
354         // Specify which fallbacks must be performed
355         $fallbacks = array(
356             CONTEXT_SYSTEM => CONTEXT_COURSE,
357             CONTEXT_COURSECAT => CONTEXT_COURSE);
359         // For any contextlevel, follow this process logic:
360         //
361         // 0) Iterate over each context (qbank)
362         // 1) Iterate over each qcat in the context, matching by stamp for the found target context
363         //     2a) No match, check if user can create qcat and q
364         //         3a) User can, mark the qcat and all dependent qs to be created in that target context
365         //         3b) User cannot, check if we are in some contextlevel with fallback
366         //             4a) There is fallback, move ALL the qcats to fallback, warn. End qcat loop
367         //             4b) No fallback, error. End qcat loop.
368         //     2b) Match, mark qcat to be mapped and iterate over each q, matching by stamp and version
369         //         5a) No match, check if user can add q
370         //             6a) User can, mark the q to be created
371         //             6b) User cannot, check if we are in some contextlevel with fallback
372         //                 7a) There is fallback, move ALL the qcats to fallback, warn. End qcat loop
373         //                 7b) No fallback, error. End qcat loop
374         //         5b) Match, mark q to be mapped
376         // Get all the contexts (question banks) in restore for the given contextlevel
377         $contexts = self::restore_get_question_banks($restoreid, $contextlevel);
379         // 0) Iterate over each context (qbank)
380         foreach ($contexts as $contextid => $contextlevel) {
381             // Init some perms
382             $canmanagecategory = false;
383             $canadd            = false;
384             // get categories in context (bank)
385             $categories = self::restore_get_question_categories($restoreid, $contextid);
386             // cache permissions if $targetcontext is found
387             if ($targetcontext = self::restore_find_best_target_context($categories, $courseid, $contextlevel)) {
388                 $canmanagecategory = has_capability('moodle/question:managecategory', $targetcontext, $userid);
389                 $canadd            = has_capability('moodle/question:add', $targetcontext, $userid);
390             }
391             // 1) Iterate over each qcat in the context, matching by stamp for the found target context
392             foreach ($categories as $category) {
393                 $matchcat = false;
394                 if ($targetcontext) {
395                     $matchcat = $DB->get_record('question_categories', array(
396                                     'contextid' => $targetcontext->id,
397                                     'stamp' => $category->stamp));
398                 }
399                 // 2a) No match, check if user can create qcat and q
400                 if (!$matchcat) {
401                     // 3a) User can, mark the qcat and all dependent qs to be created in that target context
402                     if ($canmanagecategory && $canadd) {
403                         // Set parentitemid to targetcontext, BUT for CONTEXT_MODULE categories, where
404                         // we keep the source contextid unmodified (for easier matching later when the
405                         // activities are created)
406                         $parentitemid = $targetcontext->id;
407                         if ($contextlevel == CONTEXT_MODULE) {
408                             $parentitemid = null; // null means "not modify" a.k.a. leave original contextid
409                         }
410                         self::set_backup_ids_record($restoreid, 'question_category', $category->id, 0, $parentitemid);
411                         // Nothing else to mark, newitemid = 0 means create
413                     // 3b) User cannot, check if we are in some contextlevel with fallback
414                     } else {
415                         // 4a) There is fallback, move ALL the qcats to fallback, warn. End qcat loop
416                         if (array_key_exists($contextlevel, $fallbacks)) {
417                             foreach ($categories as $movedcat) {
418                                 $movedcat->contextlevel = $fallbacks[$contextlevel];
419                                 self::set_backup_ids_record($restoreid, 'question_category', $movedcat->id, 0, $contextid, $movedcat);
420                                 // Warn about the performed fallback
421                                 $warnings[] = get_string('qcategory2coursefallback', 'backup', $movedcat);
422                             }
424                         // 4b) No fallback, error. End qcat loop.
425                         } else {
426                             $errors[] = get_string('qcategorycannotberestored', 'backup', $category);
427                         }
428                         break; // out from qcat loop (both 4a and 4b), we have decided about ALL categories in context (bank)
429                     }
431                 // 2b) Match, mark qcat to be mapped and iterate over each q, matching by stamp and version
432                 } else {
433                     self::set_backup_ids_record($restoreid, 'question_category', $category->id, $matchcat->id, $targetcontext->id);
434                     $questions = self::restore_get_questions($restoreid, $category->id);
435                     foreach ($questions as $question) {
436                         $matchq = $DB->get_record('question', array(
437                                       'category' => $matchcat->id,
438                                       'stamp' => $question->stamp,
439                                       'version' => $question->version));
440                         // 5a) No match, check if user can add q
441                         if (!$matchq) {
442                             // 6a) User can, mark the q to be created
443                             if ($canadd) {
444                                 // Nothing to mark, newitemid means create
446                              // 6b) User cannot, check if we are in some contextlevel with fallback
447                             } else {
448                                 // 7a) There is fallback, move ALL the qcats to fallback, warn. End qcat loo
449                                 if (array_key_exists($contextlevel, $fallbacks)) {
450                                     foreach ($categories as $movedcat) {
451                                         $movedcat->contextlevel = $fallbacks[$contextlevel];
452                                         self::set_backup_ids_record($restoreid, 'question_category', $movedcat->id, 0, $contextid, $movedcat);
453                                         // Warn about the performed fallback
454                                         $warnings[] = get_string('question2coursefallback', 'backup', $movedcat);
455                                     }
457                                 // 7b) No fallback, error. End qcat loop
458                                 } else {
459                                     $errors[] = get_string('questioncannotberestored', 'backup', $question);
460                                 }
461                                 break 2; // out from qcat loop (both 7a and 7b), we have decided about ALL categories in context (bank)
462                             }
464                         // 5b) Match, mark q to be mapped
465                         } else {
466                             self::set_backup_ids_record($restoreid, 'question', $question->id, $matchq->id);
467                         }
468                     }
469                 }
470             }
471         }
473         return array($errors, $warnings);
474     }
476     /**
477      * Return one array of contextid => contextlevel pairs
478      * of question banks to be checked for one given restore operation
479      * ordered from CONTEXT_SYSTEM downto CONTEXT_MODULE
480      * If contextlevel is specified, then only banks corresponding to
481      * that level are returned
482      */
483     public static function restore_get_question_banks($restoreid, $contextlevel = null) {
484         global $DB;
486         $results = array();
487         $qcats = $DB->get_records_sql("SELECT itemid, parentitemid AS contextid
488                                          FROM {backup_ids_temp}
489                                        WHERE backupid = ?
490                                          AND itemname = 'question_category'", array($restoreid));
491         foreach ($qcats as $qcat) {
492             // If this qcat context haven't been acummulated yet, do that
493             if (!isset($results[$qcat->contextid])) {
494                 $temprec = self::get_backup_ids_record($restoreid, 'question_category', $qcat->itemid);
495                 // Filter by contextlevel if necessary
496                 if (is_null($contextlevel) || $contextlevel == $temprec->info->contextlevel) {
497                     $results[$qcat->contextid] = $temprec->info->contextlevel;
498                 }
499             }
500         }
501         // Sort by value (contextlevel from CONTEXT_SYSTEM downto CONTEXT_MODULE)
502         asort($results);
503         return $results;
504     }
506     /**
507      * Return one array of question_category records for
508      * a given restore operation and one restore context (question bank)
509      */
510     public static function restore_get_question_categories($restoreid, $contextid) {
511         global $DB;
513         $results = array();
514         $qcats = $DB->get_records_sql("SELECT itemid
515                                          FROM {backup_ids_temp}
516                                         WHERE backupid = ?
517                                           AND itemname = 'question_category'
518                                           AND parentitemid = ?", array($restoreid, $contextid));
519         foreach ($qcats as $qcat) {
520             $temprec = self::get_backup_ids_record($restoreid, 'question_category', $qcat->itemid);
521             $results[$qcat->itemid] = $temprec->info;
522         }
523         return $results;
524     }
526     /**
527      * Calculates the best context found to restore one collection of qcats,
528      * al them belonging to the same context (question bank), returning the
529      * target context found (object) or false
530      */
531     public static function restore_find_best_target_context($categories, $courseid, $contextlevel) {
532         global $DB;
534         $targetcontext = false;
536         // Depending of $contextlevel, we perform different actions
537         switch ($contextlevel) {
538              // For system is easy, the best context is the system context
539              case CONTEXT_SYSTEM:
540                  $targetcontext = get_context_instance(CONTEXT_SYSTEM);
541                  break;
543              // For coursecat, we are going to look for stamps in all the
544              // course categories between CONTEXT_SYSTEM and CONTEXT_COURSE
545              // (i.e. in all the course categories in the path)
546              //
547              // And only will return one "best" target context if all the
548              // matches belong to ONE and ONLY ONE context. If multiple
549              // matches are found, that means that there is some annoying
550              // qbank "fragmentation" in the categories, so we'll fallback
551              // to create the qbank at course level
552              case CONTEXT_COURSECAT:
553                  // Build the array of stamps we are going to match
554                  $stamps = array();
555                  foreach ($categories as $category) {
556                      $stamps[] = $category->stamp;
557                  }
558                  $contexts = array();
559                  // Build the array of contexts we are going to look
560                  $systemctx = get_context_instance(CONTEXT_SYSTEM);
561                  $coursectx = get_context_instance(CONTEXT_COURSE, $courseid);
562                  $parentctxs= get_parent_contexts($coursectx);
563                  foreach ($parentctxs as $parentctx) {
564                      // Exclude system context
565                      if ($parentctx == $systemctx->id) {
566                          continue;
567                      }
568                      $contexts[] = $parentctx;
569                  }
570                  if (!empty($stamps) && !empty($contexts)) {
571                      // Prepare the query
572                      list($stamp_sql, $stamp_params) = $DB->get_in_or_equal($stamps);
573                      list($context_sql, $context_params) = $DB->get_in_or_equal($contexts);
574                      $sql = "SELECT contextid
575                                FROM {question_categories}
576                               WHERE stamp $stamp_sql
577                                 AND contextid $context_sql";
578                      $params = array_merge($stamp_params, $context_params);
579                      $matchingcontexts = $DB->get_records_sql($sql, $params);
580                      // Only if ONE and ONLY ONE context is found, use it as valid target
581                      if (count($matchingcontexts) == 1) {
582                          $targetcontext = get_context_instance_by_id(reset($matchingcontexts)->contextid);
583                      }
584                  }
585                  break;
587              // For course is easy, the best context is the course context
588              case CONTEXT_COURSE:
589                  $targetcontext = get_context_instance(CONTEXT_COURSE, $courseid);
590                  break;
592              // For module is easy, there is not best context, as far as the
593              // activity hasn't been created yet. So we return context course
594              // for them, so permission checks and friends will work. Note this
595              // case is handled by {@link prechek_precheck_qbanks_by_level}
596              // in an special way
597              case CONTEXT_MODULE:
598                  $targetcontext = get_context_instance(CONTEXT_COURSE, $courseid);
599                  break;
600         }
601         return $targetcontext;
602     }
604     /**
605      * Return one array of question records for
606      * a given restore operation and one question category
607      */
608     public static function restore_get_questions($restoreid, $qcatid) {
609         global $DB;
611         $results = array();
612         $qs = $DB->get_records_sql("SELECT itemid
613                                       FROM {backup_ids_temp}
614                                      WHERE backupid = ?
615                                        AND itemname = 'question'
616                                        AND parentitemid = ?", array($restoreid, $qcatid));
617         foreach ($qs as $q) {
618             $temprec = self::get_backup_ids_record($restoreid, 'question', $q->itemid);
619             $results[$q->itemid] = $temprec->info;
620         }
621         return $results;
622     }
624     /**
625      * Given one component/filearea/context and
626      * optionally one source itemname to match itemids
627      * put the corresponding files in the pool
628      */
629     public static function send_files_to_pool($basepath, $restoreid, $component, $filearea, $oldcontextid, $dfltuserid, $itemname = null, $olditemid = null, $forcenewcontextid = null, $skipparentitemidctxmatch = false) {
630         global $DB;
632         if ($forcenewcontextid) {
633             // Some components can have "forced" new contexts (example: questions can end belonging to non-standard context mappings,
634             // with questions originally at system/coursecat context in source being restored to course context in target). So we need
635             // to be able to force the new contextid
636             $newcontextid = $forcenewcontextid;
637         } else {
638             // Get new context, must exist or this will fail
639             if (!$newcontextid = self::get_backup_ids_record($restoreid, 'context', $oldcontextid)->newitemid) {
640                 throw new restore_dbops_exception('unknown_context_mapping', $oldcontextid);
641             }
642         }
644         // Sometimes it's possible to have not the oldcontextids stored into backup_ids_temp->parentitemid
645         // columns (because we have used them to store other information). This happens usually with
646         // all the question related backup_ids_temp records. In that case, it's safe to ignore that
647         // matching as far as we are always restoring for well known oldcontexts and olditemids
648         $parentitemctxmatchsql = ' AND i.parentitemid = f.contextid ';
649         if ($skipparentitemidctxmatch) {
650             $parentitemctxmatchsql = '';
651         }
653         // Important: remember how files have been loaded to backup_files_temp
654         //   - info: contains the whole original object (times, names...)
655         //   (all them being original ids as loaded from xml)
657         // itemname = null, we are going to match only by context, no need to use itemid (all them are 0)
658         if ($itemname == null) {
659             $sql = 'SELECT contextid, component, filearea, itemid, itemid AS newitemid, info
660                       FROM {backup_files_temp}
661                      WHERE backupid = ?
662                        AND contextid = ?
663                        AND component = ?
664                        AND filearea  = ?';
665             $params = array($restoreid, $oldcontextid, $component, $filearea);
667         // itemname not null, going to join with backup_ids to perform the old-new mapping of itemids
668         } else {
669             $sql = "SELECT f.contextid, f.component, f.filearea, f.itemid, i.newitemid, f.info
670                       FROM {backup_files_temp} f
671                       JOIN {backup_ids_temp} i ON i.backupid = f.backupid
672                                               $parentitemctxmatchsql
673                                               AND i.itemid = f.itemid
674                      WHERE f.backupid = ?
675                        AND f.contextid = ?
676                        AND f.component = ?
677                        AND f.filearea = ?
678                        AND i.itemname = ?";
679             $params = array($restoreid, $oldcontextid, $component, $filearea, $itemname);
680             if ($olditemid !== null) { // Just process ONE olditemid intead of the whole itemname
681                 $sql .= ' AND i.itemid = ?';
682                 $params[] = $olditemid;
683             }
684         }
686         $fs = get_file_storage();         // Get moodle file storage
687         $basepath = $basepath . '/files/';// Get backup file pool base
688         $rs = $DB->get_recordset_sql($sql, $params);
689         foreach ($rs as $rec) {
690             $file = (object)unserialize(base64_decode($rec->info));
691             // ignore root dirs (they are created automatically)
692             if ($file->filepath == '/' && $file->filename == '.') {
693                 continue;
694             }
695             // set the best possible user
696             $mappeduser = self::get_backup_ids_record($restoreid, 'user', $file->userid);
697             $file->userid = !empty($mappeduser) ? $mappeduser->newitemid : $dfltuserid;
698             // dir found (and not root one), let's create if
699             if ($file->filename == '.') {
700                 $fs->create_directory($newcontextid, $component, $filearea, $rec->newitemid, $file->filepath, $file->userid);
701                 continue;
702             }
703             // arrived here, file found
704             // Find file in backup pool
705             $backuppath = $basepath . backup_file_manager::get_backup_content_file_location($file->contenthash);
706             if (!file_exists($backuppath)) {
707                 throw new restore_dbops_exception('file_not_found_in_pool', $file);
708             }
709             if (!$fs->file_exists($newcontextid, $component, $filearea, $rec->newitemid, $file->filepath, $file->filename)) {
710                 $file_record = array(
711                     'contextid'   => $newcontextid,
712                     'component'   => $component,
713                     'filearea'    => $filearea,
714                     'itemid'      => $rec->newitemid,
715                     'filepath'    => $file->filepath,
716                     'filename'    => $file->filename,
717                     'timecreated' => $file->timecreated,
718                     'timemodified'=> $file->timemodified,
719                     'userid'      => $file->userid,
720                     'author'      => $file->author,
721                     'license'     => $file->license,
722                     'sortorder'   => $file->sortorder);
723                 $fs->create_file_from_pathname($file_record, $backuppath);
724             }
725         }
726         $rs->close();
727     }
729     /**
730      * Given one restoreid, create in DB all the users present
731      * in backup_ids having newitemid = 0, as far as
732      * precheck_included_users() have left them there
733      * ready to be created. Also, annotate their newids
734      * once created for later reference
735      */
736     public static function create_included_users($basepath, $restoreid, $userfiles, $userid) {
737         global $CFG, $DB;
739         $authcache = array(); // Cache to get some bits from authentication plugins
740         $languages = get_string_manager()->get_list_of_translations(); // Get languages for quick search later
741         $themes    = get_list_of_themes(); // Get themes for quick search later
743         // Iterate over all the included users with newitemid = 0, have to create them
744         $rs = $DB->get_recordset('backup_ids_temp', array('backupid' => $restoreid, 'itemname' => 'user', 'newitemid' => 0), '', 'itemid, parentitemid');
745         foreach ($rs as $recuser) {
746             $user = (object)self::get_backup_ids_record($restoreid, 'user', $recuser->itemid)->info;
748             // if user lang doesn't exist here, use site default
749             if (!array_key_exists($user->lang, $languages)) {
750                 $user->lang = $CFG->lang;
751             }
753             // if user theme isn't available on target site or they are disabled, reset theme
754             if (!empty($user->theme)) {
755                 if (empty($CFG->allowuserthemes) || !in_array($user->theme, $themes)) {
756                     $user->theme = '';
757                 }
758             }
760             // if user to be created has mnet auth and its mnethostid is $CFG->mnet_localhost_id
761             // that's 100% impossible as own server cannot be accesed over mnet. Change auth to email/manual
762             if ($user->auth == 'mnet' && $user->mnethostid == $CFG->mnet_localhost_id) {
763                 // Respect registerauth
764                 if ($CFG->registerauth == 'email') {
765                     $user->auth = 'email';
766                 } else {
767                     $user->auth = 'manual';
768                 }
769             }
770             unset($user->mnethosturl); // Not needed anymore
772             // Disable pictures based on global setting
773             if (!empty($CFG->disableuserimages)) {
774                 $user->picture = 0;
775             }
777             // We need to analyse the AUTH field to recode it:
778             //   - if the auth isn't enabled in target site, $CFG->registerauth will decide
779             //   - finally, if the auth resulting isn't enabled, default to 'manual'
780             if (!is_enabled_auth($user->auth)) {
781                 if ($CFG->registerauth == 'email') {
782                     $user->auth = 'email';
783                 } else {
784                     $user->auth = 'manual';
785                 }
786             }
787             if (!is_enabled_auth($user->auth)) { // Final auth check verify, default to manual if not enabled
788                 $user->auth = 'manual';
789             }
791             // Now that we know the auth method, for users to be created without pass
792             // if password handling is internal and reset password is available
793             // we set the password to "restored" (plain text), so the login process
794             // will know how to handle that situation in order to allow the user to
795             // recover the password. MDL-20846
796             if (empty($user->password)) { // Only if restore comes without password
797                 if (!array_key_exists($user->auth, $authcache)) { // Not in cache
798                     $userauth = new stdClass();
799                     $authplugin = get_auth_plugin($user->auth);
800                     $userauth->preventpassindb = $authplugin->prevent_local_passwords();
801                     $userauth->isinternal      = $authplugin->is_internal();
802                     $userauth->canresetpwd     = $authplugin->can_reset_password();
803                     $authcache[$user->auth] = $userauth;
804                 } else {
805                     $userauth = $authcache[$user->auth]; // Get from cache
806                 }
808                 // Most external plugins do not store passwords locally
809                 if (!empty($userauth->preventpassindb)) {
810                     $user->password = 'not cached';
812                 // If Moodle is responsible for storing/validating pwd and reset functionality is available, mark
813                 } else if ($userauth->isinternal and $userauth->canresetpwd) {
814                     $user->password = 'restored';
815                 }
816             }
818             // Creating new user, we must reset the policyagreed always
819             $user->policyagreed = 0;
821             // Set time created if empty
822             if (empty($user->timecreated)) {
823                 $user->timecreated = time();
824             }
826             // Done, let's create the user and annotate its id
827             $newuserid = $DB->insert_record('user', $user);
828             self::set_backup_ids_record($restoreid, 'user', $recuser->itemid, $newuserid);
829             // Let's create the user context and annotate it (we need it for sure at least for files)
830             $newuserctxid = get_context_instance(CONTEXT_USER, $newuserid)->id;
831             self::set_backup_ids_record($restoreid, 'context', $recuser->parentitemid, $newuserctxid);
833             // Process custom fields
834             if (isset($user->custom_fields)) { // if present in backup
835                 foreach($user->custom_fields['custom_field'] as $udata) {
836                     $udata = (object)$udata;
837                     // If the profile field has data and the profile shortname-datatype is defined in server
838                     if ($udata->field_data) {
839                         if ($field = $DB->get_record('user_info_field', array('shortname'=>$udata->field_name, 'datatype'=>$udata->field_type))) {
840                         /// Insert the user_custom_profile_field
841                             $rec = new stdClass();
842                             $rec->userid  = $newuserid;
843                             $rec->fieldid = $field->id;
844                             $rec->data    = $udata->field_data;
845                             $DB->insert_record('user_info_data', $rec);
846                         }
847                     }
848                 }
849             }
851             // Process tags
852             if (!empty($CFG->usetags) && isset($user->tags)) { // if enabled in server and present in backup
853                 $tags = array();
854                 foreach($user->tags['tag'] as $usertag) {
855                     $usertag = (object)$usertag;
856                     $tags[] = $usertag->rawname;
857                 }
858                 tag_set('user', $newuserid, $tags);
859             }
861             // Process preferences
862             if (isset($user->preferences)) { // if present in backup
863                 foreach($user->preferences['preference'] as $preference) {
864                     $preference = (object)$preference;
865                     // Prepare the record and insert it
866                     $preference->userid = $newuserid;
867                     $status = $DB->insert_record('user_preferences', $preference);
868                 }
869             }
871             // Create user files in pool (profile, icon, private) by context
872             restore_dbops::send_files_to_pool($basepath, $restoreid, 'user', 'icon', $recuser->parentitemid, $userid);
873             restore_dbops::send_files_to_pool($basepath, $restoreid, 'user', 'profile', $recuser->parentitemid, $userid);
874             if ($userfiles) { // private files only if enabled in settings
875                 restore_dbops::send_files_to_pool($basepath, $restoreid, 'user', 'private', $recuser->parentitemid, $userid);
876             }
878         }
879         $rs->close();
880     }
882     /**
883     * Given one user object (from backup file), perform all the neccesary
884     * checks is order to decide how that user will be handled on restore.
885     *
886     * Note the function requires $user->mnethostid to be already calculated
887     * so it's caller responsibility to set it
888     *
889     * This function is used both by @restore_precheck_users() and
890     * @restore_create_users() to get consistent results in both places
891     *
892     * It returns:
893     *   - one user object (from DB), if match has been found and user will be remapped
894     *   - boolean true if the user needs to be created
895     *   - boolean false if some conflict happened and the user cannot be handled
896     *
897     * Each test is responsible for returning its results and interrupt
898     * execution. At the end, boolean true (user needs to be created) will be
899     * returned if no test has interrupted that.
900     *
901     * Here it's the logic applied, keep it updated:
902     *
903     *  If restoring users from same site backup:
904     *      1A - Normal check: If match by id and username and mnethost  => ok, return target user
905     *      1B - Handle users deleted in DB and "alive" in backup file:
906     *           If match by id and mnethost and user is deleted in DB and
907     *           (match by username LIKE 'backup_email.%' or by non empty email = md5(username)) => ok, return target user
908     *      1C - Handle users deleted in backup file and "alive" in DB:
909     *           If match by id and mnethost and user is deleted in backup file
910     *           and match by email = email_without_time(backup_email) => ok, return target user
911     *      1D - Conflict: If match by username and mnethost and doesn't match by id => conflict, return false
912     *      1E - None of the above, return true => User needs to be created
913     *
914     *  if restoring from another site backup (cannot match by id here, replace it by email/firstaccess combination):
915     *      2A - Normal check: If match by username and mnethost and (email or non-zero firstaccess) => ok, return target user
916     *      2B - Handle users deleted in DB and "alive" in backup file:
917     *           2B1 - If match by mnethost and user is deleted in DB and not empty email = md5(username) and
918     *                 (username LIKE 'backup_email.%' or non-zero firstaccess) => ok, return target user
919     *           2B2 - If match by mnethost and user is deleted in DB and
920     *                 username LIKE 'backup_email.%' and non-zero firstaccess) => ok, return target user
921     *                 (to cover situations were md5(username) wasn't implemented on delete we requiere both)
922     *      2C - Handle users deleted in backup file and "alive" in DB:
923     *           If match mnethost and user is deleted in backup file
924     *           and by email = email_without_time(backup_email) and non-zero firstaccess=> ok, return target user
925     *      2D - Conflict: If match by username and mnethost and not by (email or non-zero firstaccess) => conflict, return false
926     *      2E - None of the above, return true => User needs to be created
927     *
928     * Note: for DB deleted users email is stored in username field, hence we
929     *       are looking there for emails. See delete_user()
930     * Note: for DB deleted users md5(username) is stored *sometimes* in the email field,
931     *       hence we are looking there for usernames if not empty. See delete_user()
932     */
933     protected static function precheck_user($user, $samesite) {
934         global $CFG, $DB;
936         // Handle checks from same site backups
937         if ($samesite && empty($CFG->forcedifferentsitecheckingusersonrestore)) {
939             // 1A - If match by id and username and mnethost => ok, return target user
940             if ($rec = $DB->get_record('user', array('id'=>$user->id, 'username'=>$user->username, 'mnethostid'=>$user->mnethostid))) {
941                 return $rec; // Matching user found, return it
942             }
944             // 1B - Handle users deleted in DB and "alive" in backup file
945             // Note: for DB deleted users email is stored in username field, hence we
946             //       are looking there for emails. See delete_user()
947             // Note: for DB deleted users md5(username) is stored *sometimes* in the email field,
948             //       hence we are looking there for usernames if not empty. See delete_user()
949             // If match by id and mnethost and user is deleted in DB and
950             // match by username LIKE 'backup_email.%' or by non empty email = md5(username) => ok, return target user
951             if ($rec = $DB->get_record_sql("SELECT *
952                                               FROM {user} u
953                                              WHERE id = ?
954                                                AND mnethostid = ?
955                                                AND deleted = 1
956                                                AND (
957                                                        username LIKE ?
958                                                     OR (
959                                                            ".$DB->sql_isnotempty('user', 'email', false, false)."
960                                                        AND email = ?
961                                                        )
962                                                    )",
963                                            array($user->id, $user->mnethostid, $user->email.'.%', md5($user->username)))) {
964                 return $rec; // Matching user, deleted in DB found, return it
965             }
967             // 1C - Handle users deleted in backup file and "alive" in DB
968             // If match by id and mnethost and user is deleted in backup file
969             // and match by email = email_without_time(backup_email) => ok, return target user
970             if ($user->deleted) {
971                 // Note: for DB deleted users email is stored in username field, hence we
972                 //       are looking there for emails. See delete_user()
973                 // Trim time() from email
974                 $trimemail = preg_replace('/(.*?)\.[0-9]+.?$/', '\\1', $user->username);
975                 if ($rec = $DB->get_record_sql("SELECT *
976                                                   FROM {user} u
977                                                  WHERE id = ?
978                                                    AND mnethostid = ?
979                                                    AND email = ?",
980                                                array($user->id, $user->mnethostid, $trimemail))) {
981                     return $rec; // Matching user, deleted in backup file found, return it
982                 }
983             }
985             // 1D - If match by username and mnethost and doesn't match by id => conflict, return false
986             if ($rec = $DB->get_record('user', array('username'=>$user->username, 'mnethostid'=>$user->mnethostid))) {
987                 if ($user->id != $rec->id) {
988                     return false; // Conflict, username already exists and belongs to another id
989                 }
990             }
992         // Handle checks from different site backups
993         } else {
995             // 2A - If match by username and mnethost and
996             //     (email or non-zero firstaccess) => ok, return target user
997             if ($rec = $DB->get_record_sql("SELECT *
998                                               FROM {user} u
999                                              WHERE username = ?
1000                                                AND mnethostid = ?
1001                                                AND (
1002                                                        email = ?
1003                                                     OR (
1004                                                            firstaccess != 0
1005                                                        AND firstaccess = ?
1006                                                        )
1007                                                    )",
1008                                            array($user->username, $user->mnethostid, $user->email, $user->firstaccess))) {
1009                 return $rec; // Matching user found, return it
1010             }
1012             // 2B - Handle users deleted in DB and "alive" in backup file
1013             // Note: for DB deleted users email is stored in username field, hence we
1014             //       are looking there for emails. See delete_user()
1015             // Note: for DB deleted users md5(username) is stored *sometimes* in the email field,
1016             //       hence we are looking there for usernames if not empty. See delete_user()
1017             // 2B1 - If match by mnethost and user is deleted in DB and not empty email = md5(username) and
1018             //       (by username LIKE 'backup_email.%' or non-zero firstaccess) => ok, return target user
1019             if ($rec = $DB->get_record_sql("SELECT *
1020                                               FROM {user} u
1021                                              WHERE mnethostid = ?
1022                                                AND deleted = 1
1023                                                AND ".$DB->sql_isnotempty('user', 'email', false, false)."
1024                                                AND email = ?
1025                                                AND (
1026                                                        username LIKE ?
1027                                                     OR (
1028                                                            firstaccess != 0
1029                                                        AND firstaccess = ?
1030                                                        )
1031                                                    )",
1032                                            array($user->mnethostid, md5($user->username), $user->email.'.%', $user->firstaccess))) {
1033                 return $rec; // Matching user found, return it
1034             }
1036             // 2B2 - If match by mnethost and user is deleted in DB and
1037             //       username LIKE 'backup_email.%' and non-zero firstaccess) => ok, return target user
1038             //       (this covers situations where md5(username) wasn't being stored so we require both
1039             //        the email & non-zero firstaccess to match)
1040             if ($rec = $DB->get_record_sql("SELECT *
1041                                               FROM {user} u
1042                                              WHERE mnethostid = ?
1043                                                AND deleted = 1
1044                                                AND username LIKE ?
1045                                                AND firstaccess != 0
1046                                                AND firstaccess = ?",
1047                                            array($user->mnethostid, $user->email.'.%', $user->firstaccess))) {
1048                 return $rec; // Matching user found, return it
1049             }
1051             // 2C - Handle users deleted in backup file and "alive" in DB
1052             // If match mnethost and user is deleted in backup file
1053             // and match by email = email_without_time(backup_email) and non-zero firstaccess=> ok, return target user
1054             if ($user->deleted) {
1055                 // Note: for DB deleted users email is stored in username field, hence we
1056                 //       are looking there for emails. See delete_user()
1057                 // Trim time() from email
1058                 $trimemail = preg_replace('/(.*?)\.[0-9]+.?$/', '\\1', $user->username);
1059                 if ($rec = $DB->get_record_sql("SELECT *
1060                                                   FROM {user} u
1061                                                  WHERE mnethostid = ?
1062                                                    AND email = ?
1063                                                    AND firstaccess != 0
1064                                                    AND firstaccess = ?",
1065                                                array($user->mnethostid, $trimemail, $user->firstaccess))) {
1066                     return $rec; // Matching user, deleted in backup file found, return it
1067                 }
1068             }
1070             // 2D - If match by username and mnethost and not by (email or non-zero firstaccess) => conflict, return false
1071             if ($rec = $DB->get_record_sql("SELECT *
1072                                               FROM {user} u
1073                                              WHERE username = ?
1074                                                AND mnethostid = ?
1075                                            AND NOT (
1076                                                        email = ?
1077                                                     OR (
1078                                                            firstaccess != 0
1079                                                        AND firstaccess = ?
1080                                                        )
1081                                                    )",
1082                                            array($user->username, $user->mnethostid, $user->email, $user->firstaccess))) {
1083                 return false; // Conflict, username/mnethostid already exist and belong to another user (by email/firstaccess)
1084             }
1085         }
1087         // Arrived here, return true as the user will need to be created and no
1088         // conflicts have been found in the logic above. This covers:
1089         // 1E - else => user needs to be created, return true
1090         // 2E - else => user needs to be created, return true
1091         return true;
1092     }
1094     /**
1095      * Check all the included users, deciding the action to perform
1096      * for each one (mapping / creation) and returning one array
1097      * of problems in case something is wrong (lack of permissions,
1098      * conficts)
1099      */
1100     public static function precheck_included_users($restoreid, $courseid, $userid, $samesite) {
1101         global $CFG, $DB;
1103         // To return any problem found
1104         $problems = array();
1106         // We are going to map mnethostid, so load all the available ones
1107         $mnethosts = $DB->get_records('mnet_host', array(), 'wwwroot', 'wwwroot, id');
1109         // Calculate the context we are going to use for capability checking
1110         $context = get_context_instance(CONTEXT_COURSE, $courseid);
1112         // Calculate if we have perms to create users, by checking:
1113         // to 'moodle/restore:createuser' and 'moodle/restore:userinfo'
1114         // and also observe $CFG->disableusercreationonrestore
1115         $cancreateuser = false;
1116         if (has_capability('moodle/restore:createuser', $context, $userid) and
1117             has_capability('moodle/restore:userinfo', $context, $userid) and
1118             empty($CFG->disableusercreationonrestore)) { // Can create users
1120             $cancreateuser = true;
1121         }
1123         // Iterate over all the included users
1124         $rs = $DB->get_recordset('backup_ids_temp', array('backupid' => $restoreid, 'itemname' => 'user'), '', 'itemid');
1125         foreach ($rs as $recuser) {
1126             $user = (object)self::get_backup_ids_record($restoreid, 'user', $recuser->itemid)->info;
1128             // Find the correct mnethostid for user before performing any further check
1129             if (empty($user->mnethosturl) || $user->mnethosturl === $CFG->wwwroot) {
1130                 $user->mnethostid = $CFG->mnet_localhost_id;
1131             } else {
1132                 // fast url-to-id lookups
1133                 if (isset($mnethosts[$user->mnethosturl])) {
1134                     $user->mnethostid = $mnethosts[$user->mnethosturl]->id;
1135                 } else {
1136                     $user->mnethostid = $CFG->mnet_localhost_id;
1137                 }
1138             }
1140             // Now, precheck that user and, based on returned results, annotate action/problem
1141             $usercheck = self::precheck_user($user, $samesite);
1143             if (is_object($usercheck)) { // No problem, we have found one user in DB to be mapped to
1144                 // Annotate it, for later process. Set newitemid to mapping user->id
1145                 self::set_backup_ids_record($restoreid, 'user', $recuser->itemid, $usercheck->id);
1147             } else if ($usercheck === false) { // Found conflict, report it as problem
1148                  $problems[] = get_string('restoreuserconflict', '', $user->username);
1150             } else if ($usercheck === true) { // User needs to be created, check if we are able
1151                 if ($cancreateuser) { // Can create user, set newitemid to 0 so will be created later
1152                     self::set_backup_ids_record($restoreid, 'user', $recuser->itemid, 0, null, (array)$user);
1154                 } else { // Cannot create user, report it as problem
1155                     $problems[] = get_string('restorecannotcreateuser', '', $user->username);
1156                 }
1158             } else { // Shouldn't arrive here ever, something is for sure wrong. Exception
1159                 throw new restore_dbops_exception('restore_error_processing_user', $user->username);
1160             }
1161         }
1162         $rs->close();
1163         return $problems;
1164     }
1166     /**
1167      * Process the needed users in order to decide
1168      * which action to perform with them (create/map)
1169      *
1170      * Just wrap over precheck_included_users(), returning
1171      * exception if any problem is found
1172      */
1173     public static function process_included_users($restoreid, $courseid, $userid, $samesite) {
1174         global $DB;
1176         // Just let precheck_included_users() to do all the hard work
1177         $problems = self::precheck_included_users($restoreid, $courseid, $userid, $samesite);
1179         // With problems, throw exception, shouldn't happen if prechecks were originally
1180         // executed, so be radical here.
1181         if (!empty($problems)) {
1182             throw new restore_dbops_exception('restore_problems_processing_users', null, implode(', ', $problems));
1183         }
1184     }
1186     /**
1187      * Process the needed question categories and questions
1188      * to check all them, deciding about the action to perform
1189      * (create/map) and target.
1190      *
1191      * Just wrap over precheck_categories_and_questions(), returning
1192      * exception if any problem is found
1193      */
1194     public static function process_categories_and_questions($restoreid, $courseid, $userid, $samesite) {
1195         global $DB;
1197         // Just let precheck_included_users() to do all the hard work
1198         $problems = self::precheck_categories_and_questions($restoreid, $courseid, $userid, $samesite);
1200         // With problems of type error, throw exception, shouldn't happen if prechecks were originally
1201         // executed, so be radical here.
1202         if (array_key_exists('errors', $problems)) {
1203             throw new restore_dbops_exception('restore_problems_processing_questions', null, implode(', ', $problems));
1204         }
1205     }
1207     public static function set_backup_files_record($restoreid, $filerec) {
1208         global $DB;
1210         $filerec->info     = base64_encode(serialize($filerec)); // Serialize the whole rec in info
1211         $filerec->backupid = $restoreid;
1212         $DB->insert_record('backup_files_temp', $filerec);
1213     }
1216     public static function set_backup_ids_record($restoreid, $itemname, $itemid, $newitemid = 0, $parentitemid = null, $info = null) {
1217         global $DB;
1219         // Build the basic (mandatory) record info
1220         $record = array(
1221             'backupid' => $restoreid,
1222             'itemname' => $itemname,
1223             'itemid'   => $itemid
1224         );
1225         // Build conditionally the extra record info
1226         $extrarecord = array();
1227         if ($newitemid != 0) {
1228             $extrarecord['newitemid'] = $newitemid;
1229         }
1230         if ($parentitemid != null) {
1231             $extrarecord['parentitemid'] = $parentitemid;
1232         }
1233         if ($info != null) {
1234             $extrarecord['info'] = base64_encode(serialize($info));
1235         }
1237         // TODO: Analyze if some static (and limited) cache by the 3 params could save us a bunch of get_record() calls
1238         // Note: Sure it will! And also will improve getter
1239         if (!$dbrec = $DB->get_record('backup_ids_temp', $record)) { // Need to insert the complete record
1240             $DB->insert_record('backup_ids_temp', array_merge($record, $extrarecord));
1242         } else { // Need to update the extra record info if there is something to
1243             if (!empty($extrarecord)) {
1244                 $extrarecord['id'] = $dbrec->id;
1245                 $DB->update_record('backup_ids_temp', $extrarecord);
1246             }
1247         }
1248     }
1250     public static function get_backup_ids_record($restoreid, $itemname, $itemid) {
1251         global $DB;
1253         // Build the basic (mandatory) record info to look for
1254         $record = array(
1255             'backupid' => $restoreid,
1256             'itemname' => $itemname,
1257             'itemid'   => $itemid
1258         );
1259         // TODO: Analyze if some static (and limited) cache by the 3 params could save us a bunch of get_record() calls
1260         if ($dbrec = $DB->get_record('backup_ids_temp', $record)) {
1261             if ($dbrec->info != null) {
1262                 $dbrec->info = unserialize(base64_decode($dbrec->info));
1263             }
1264         }
1265         return $dbrec;
1266     }
1268     /**
1269      * Given on courseid, fullname and shortname, calculate the correct fullname/shortname to avoid dupes
1270      */
1271     public static function calculate_course_names($courseid, $fullname, $shortname) {
1272         global $CFG, $DB;
1274         $currentfullname = '';
1275         $currentshortname = '';
1276         $counter = 0;
1277         // Iteratere while the name exists
1278         do {
1279             if ($counter) {
1280                 $suffixfull  = ' ' . get_string('copyasnoun') . ' ' . $counter;
1281                 $suffixshort = '_' . $counter;
1282             } else {
1283                 $suffixfull  = '';
1284                 $suffixshort = '';
1285             }
1286             $currentfullname = $fullname.$suffixfull;
1287             $currentshortname = substr($shortname, 0, 100 - strlen($suffixshort)).$suffixshort; // < 100cc
1288             $coursefull  = $DB->get_record_select('course', 'fullname = ? AND id != ?', array($currentfullname, $courseid));
1289             $courseshort = $DB->get_record_select('course', 'shortname = ? AND id != ?', array($currentshortname, $courseid));
1290             $counter++;
1291         } while ($coursefull || $courseshort);
1293         // Return results
1294         return array($currentfullname, $currentshortname);
1295     }
1297     /**
1298      * For the target course context, put as many custom role names as possible
1299      */
1300     public static function set_course_role_names($restoreid, $courseid) {
1301         global $DB;
1303         // Get the course context
1304         $coursectx = get_context_instance(CONTEXT_COURSE, $courseid);
1305         // Get all the mapped roles we have
1306         $rs = $DB->get_recordset('backup_ids_temp', array('backupid' => $restoreid, 'itemname' => 'role'), '', 'itemid');
1307         foreach ($rs as $recrole) {
1308             // Get the complete temp_ids record
1309             $role = (object)self::get_backup_ids_record($restoreid, 'role', $recrole->itemid);
1310             // If it's one mapped role and we have one name for it
1311             if (!empty($role->newitemid) && !empty($role->info['nameincourse'])) {
1312                 // If role name doesn't exist, add it
1313                 $rolename = new stdclass();
1314                 $rolename->roleid = $role->newitemid;
1315                 $rolename->contextid = $coursectx->id;
1316                 if (!$DB->record_exists('role_names', (array)$rolename)) {
1317                     $rolename->name = $role->info['nameincourse'];
1318                     $DB->insert_record('role_names', $rolename);
1319                 }
1320             }
1321         }
1322         $rs->close();
1323     }
1325     /**
1326      * Creates a skeleton record within the database using the passed parameters
1327      * and returns the new course id.
1328      *
1329      * @global moodle_database $DB
1330      * @param string $fullname
1331      * @param string $shortname
1332      * @param int $categoryid
1333      * @return int The new course id
1334      */
1335     public static function create_new_course($fullname, $shortname, $categoryid) {
1336         global $DB;
1337         $category = $DB->get_record('course_categories', array('id'=>$categoryid), '*', MUST_EXIST);
1339         $course = new stdClass;
1340         $course->fullname = $fullname;
1341         $course->shortname = $shortname;
1342         $course->category = $category->id;
1343         $course->sortorder = 0;
1344         $course->timecreated  = time();
1345         $course->timemodified = $course->timecreated;
1346         $course->visible = $category->visible;
1348         $courseid = $DB->insert_record('course', $course);
1350         $category->coursecount++;
1351         $DB->update_record('course_categories', $category);
1353         return $courseid;
1354     }
1356     /**
1357      * Deletes all of the content associated with the given course (courseid)
1358      * @param int $courseid
1359      * @return bool True for success
1360      */
1361     public static function delete_course_content($courseid) {
1362         return remove_course_contents($courseid, false);
1363     }
1366 /*
1367  * Exception class used by all the @dbops stuff
1368  */
1369 class restore_dbops_exception extends backup_exception {
1371     public function __construct($errorcode, $a=NULL, $debuginfo=null) {
1372         parent::__construct($errorcode, 'error', '', $a, null, $debuginfo);
1373     }