Search moodle.org's
Developer Documentation
Developer Documentation
- Bug fixes for general core bugs in 3.11.x will end 14 Nov 2022 (12 months plus 6 months extension).
- Bug fixes for security issues in 3.11.x will end 13 Nov 2023 (18 months plus 12 months extension).
- PHP version: minimum PHP 7.3.0 Note: minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is supported too.
/backup/util/dbops/ -> restore_dbops.class.php (source)
Differences Between: [Versions 310 and 311] [Versions 311 and 400] [Versions 311 and 401] [Versions 311 and 402] [Versions 311 and 403] [Versions 39 and 311]
1 <?php 2 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/>. 17 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 */ 24 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; 63 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; 84 85 } else { // Look for activity_included setting 86 $included = $task->get_setting_value($parent . '_included'); 87 } 88 89 // ativities, based on included setting 90 } else if ($task instanceof restore_activity_task) { 91 $included = $task->get_setting_value('included'); 92 93 // sections, based on included setting 94 } else if ($task instanceof restore_section_task) { 95 $included = $task->get_setting_value('included'); 96 97 // course always included if present 98 } else if ($task instanceof restore_course_task) { 99 $included = true; 100 } 101 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. 108 109 return $includedtasks; 110 } 111 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) { 121 122 if (!file_exists($inforeffile)) { // Shouldn't happen ever, but... 123 throw new backup_helper_exception('missing_inforef_xml_file', $inforeffile); 124 } 125 126 // Set up progress tracking (indeterminate). 127 if (!$progress) { 128 $progress = new \core\progress\none(); 129 } 130 $progress->start_progress('Loading inforef.xml file'); 131 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(); 139 140 // Finish progress 141 $progress->end_progress(); 142 } 143 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) { 148 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 } 159 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; 169 170 $problems = array(); // To store warnings/errors 171 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); 180 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 } 202 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; 214 215 $key = "$itemid $itemname $restoreid"; 216 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 } 222 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 } 233 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 } 250 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; 263 264 $key = "$itemid $itemname $restoreid"; 265 266 $record = array( 267 'backupid' => $restoreid, 268 'itemname' => $itemname, 269 'itemid' => $itemid, 270 ); 271 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 } 299 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 } 331 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 } 356 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; 364 365 // Gather various information about roles 366 $coursectx = context_course::instance($courseid); 367 $assignablerolesshortname = get_assignable_roles($coursectx, ROLENAME_SHORT, false, $userid); 368 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 373 374 // Empty assignable roles, mean no match possible 375 if (empty($assignablerolesshortname)) { 376 return 0; 377 } 378 379 // Match by shortname 380 if ($match = array_search($role->shortname, $assignablerolesshortname)) { 381 return $match; 382 } 383 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 } 390 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 } 395 396 // No match, return 0 397 return 0; 398 } 399 400 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; 409 410 // Just let precheck_included_roles() to do all the hard work 411 $problems = self::precheck_included_roles($restoreid, $courseid, $userid, $samesite, $rolemappings); 412 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 } 418 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) { 428 429 if (!file_exists($usersfile)) { // Shouldn't happen ever, but... 430 throw new backup_helper_exception('missing_users_xml_file', $usersfile); 431 } 432 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'); 438 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(); 446 447 // Finish progress. 448 $progress->end_progress(); 449 } 450 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) { 455 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 } 466 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) { 512 513 $problems = array(); 514 515 // TODO: Check all qs, looking their qtypes are restorable 516 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); 522 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 } 534 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; 571 572 // To return any errors and warnings found 573 $errors = array(); 574 $warnings = array(); 575 576 // Specify which fallbacks must be performed 577 $fallbacks = array( 578 CONTEXT_SYSTEM => CONTEXT_COURSE, 579 CONTEXT_COURSECAT => CONTEXT_COURSE); 580 581 $rc = restore_controller_dbops::load_controller($restoreid); 582 $restoreinfo = $rc->get_info(); 583 $rc->destroy(); // Always need to destroy. 584 $backuprelease = $restoreinfo->backup_release; // The major version: 2.9, 3.0, 3.10... 585 preg_match('/(\d{8})/', $restoreinfo->moodle_release, $matches); 586 $backupbuild = (int)$matches[1]; 587 $after35 = false; 588 if (version_compare($backuprelease, '3.5', '>=') && $backupbuild > 20180205) { 589 $after35 = true; 590 } 591 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. 610 611 // Get all the contexts (question banks) in restore for the given contextlevel 612 $contexts = self::restore_get_question_banks($restoreid, $contextlevel); 613 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, $contextlevel); 623 624 // cache permissions if $targetcontext is found 625 if ($targetcontext = self::restore_find_best_target_context($categories, $courseid, $contextlevel)) { 626 $canmanagecategory = has_capability('moodle/question:managecategory', $targetcontext, $userid); 627 $canadd = has_capability('moodle/question:add', $targetcontext, $userid); 628 } 629 // 1) Iterate over each qcat in the context, matching by stamp for the found target context 630 foreach ($categories as $category) { 631 if ($category->parent == 0) { 632 $topcats++; 633 } 634 635 $matchcat = false; 636 if ($targetcontext) { 637 $matchcat = $DB->get_record('question_categories', array( 638 'contextid' => $targetcontext->id, 639 'stamp' => $category->stamp)); 640 } 641 // 2a) No match, check if user can create qcat and q 642 if (!$matchcat) { 643 // 3a) User can, mark the qcat and all dependent qs to be created in that target context 644 if ($canmanagecategory && $canadd) { 645 // Set parentitemid to targetcontext, BUT for CONTEXT_MODULE categories, where 646 // we keep the source contextid unmodified (for easier matching later when the 647 // activities are created) 648 $parentitemid = $targetcontext->id; 649 if ($contextlevel == CONTEXT_MODULE) { 650 $parentitemid = null; // null means "not modify" a.k.a. leave original contextid 651 } 652 self::set_backup_ids_record($restoreid, 'question_category', $category->id, 0, $parentitemid); 653 // Nothing else to mark, newitemid = 0 means create 654 655 // 3b) User cannot, check if we are in some contextlevel with fallback 656 } else { 657 // 4a) There is fallback, move ALL the qcats to fallback, warn. End qcat loop 658 if (array_key_exists($contextlevel, $fallbacks)) { 659 foreach ($categories as $movedcat) { 660 $movedcat->contextlevel = $fallbacks[$contextlevel]; 661 self::set_backup_ids_record($restoreid, 'question_category', $movedcat->id, 0, $contextid, $movedcat); 662 // Warn about the performed fallback 663 $warnings[] = get_string('qcategory2coursefallback', 'backup', $movedcat); 664 } 665 666 // 4b) No fallback, error. End qcat loop. 667 } else { 668 $errors[] = get_string('qcategorycannotberestored', 'backup', $category); 669 } 670 break; // out from qcat loop (both 4a and 4b), we have decided about ALL categories in context (bank) 671 } 672 673 // 2b) Match, mark qcat to be mapped and iterate over each q, matching by stamp and version 674 } else { 675 self::set_backup_ids_record($restoreid, 'question_category', $category->id, $matchcat->id, $targetcontext->id); 676 $questions = self::restore_get_questions($restoreid, $category->id); 677 678 // Collect all the questions for this category into memory so we only talk to the DB once. 679 $questioncache = $DB->get_records_sql_menu("SELECT ".$DB->sql_concat('stamp', "' '", 'version').", id 680 FROM {question} 681 WHERE category = ?", array($matchcat->id)); 682 683 foreach ($questions as $question) { 684 if (isset($questioncache[$question->stamp." ".$question->version])) { 685 $matchqid = $questioncache[$question->stamp." ".$question->version]; 686 } else { 687 $matchqid = false; 688 } 689 // 5a) No match, check if user can add q 690 if (!$matchqid) { 691 // 6a) User can, mark the q to be created 692 if ($canadd) { 693 // Nothing to mark, newitemid means create 694 695 // 6b) User cannot, check if we are in some contextlevel with fallback 696 } else { 697 // 7a) There is fallback, move ALL the qcats to fallback, warn. End qcat loo 698 if (array_key_exists($contextlevel, $fallbacks)) { 699 foreach ($categories as $movedcat) { 700 $movedcat->contextlevel = $fallbacks[$contextlevel]; 701 self::set_backup_ids_record($restoreid, 'question_category', $movedcat->id, 0, $contextid, $movedcat); 702 // Warn about the performed fallback 703 $warnings[] = get_string('question2coursefallback', 'backup', $movedcat); 704 } 705 706 // 7b) No fallback, error. End qcat loop 707 } else { 708 $errors[] = get_string('questioncannotberestored', 'backup', $question); 709 } 710 break 2; // out from qcat loop (both 7a and 7b), we have decided about ALL categories in context (bank) 711 } 712 713 // 5b) Random questions must always be newly created. 714 } else if ($question->qtype == 'random') { 715 // Nothing to mark, newitemid means create 716 717 // 5c) Match, mark q to be mapped. 718 } else { 719 self::set_backup_ids_record($restoreid, 'question', $question->id, $matchqid); 720 } 721 } 722 } 723 } 724 725 // 8) Check if backup is made on Moodle >= 3.5 and there are more than one top-level category in the context. 726 if ($after35 && $topcats > 1) { 727 $errors[] = get_string('restoremultipletopcats', 'question', $contextid); 728 } 729 730 } 731 732 return array($errors, $warnings); 733 } 734 735 /** 736 * Return one array of contextid => contextlevel pairs 737 * of question banks to be checked for one given restore operation 738 * ordered from CONTEXT_SYSTEM downto CONTEXT_MODULE 739 * If contextlevel is specified, then only banks corresponding to 740 * that level are returned 741 */ 742 public static function restore_get_question_banks($restoreid, $contextlevel = null) { 743 global $DB; 744 745 $results = array(); 746 $qcats = $DB->get_recordset_sql("SELECT itemid, parentitemid AS contextid, info 747 FROM {backup_ids_temp} 748 WHERE backupid = ? 749 AND itemname = 'question_category'", array($restoreid)); 750 foreach ($qcats as $qcat) { 751 // If this qcat context haven't been acummulated yet, do that 752 if (!isset($results[$qcat->contextid])) { 753 $info = backup_controller_dbops::decode_backup_temp_info($qcat->info); 754 // Filter by contextlevel if necessary 755 if (is_null($contextlevel) || $contextlevel == $info->contextlevel) { 756 $results[$qcat->contextid] = $info->contextlevel; 757 } 758 } 759 } 760 $qcats->close(); 761 // Sort by value (contextlevel from CONTEXT_SYSTEM downto CONTEXT_MODULE) 762 asort($results); 763 return $results; 764 } 765 766 /** 767 * Return one array of question_category records for 768 * a given restore operation and one restore context (question bank) 769 * 770 * @param string $restoreid Unique identifier of the restore operation being performed. 771 * @param int $contextid Context id we want question categories to be returned. 772 * @param int $contextlevel Context level we want to restrict the returned categories. 773 * @return array Question categories for the given context id and level. 774 */ 775 public static function restore_get_question_categories($restoreid, $contextid, $contextlevel) { 776 global $DB; 777 778 $results = array(); 779 $qcats = $DB->get_recordset_sql("SELECT itemid, info 780 FROM {backup_ids_temp} 781 WHERE backupid = ? 782 AND itemname = 'question_category' 783 AND parentitemid = ?", array($restoreid, $contextid)); 784 foreach ($qcats as $qcat) { 785 $result = backup_controller_dbops::decode_backup_temp_info($qcat->info); 786 // Filter out found categories that belong to another context level. 787 // (this can happen when a higher level category becomes remapped to 788 // a context id that, by coincidence, matches a context id of another 789 // category at lower level). See MDL-72950 for more info. 790 if ($result->contextlevel == $contextlevel) { 791 $results[$qcat->itemid] = $result; 792 } 793 } 794 $qcats->close(); 795 796 return $results; 797 } 798 799 /** 800 * Calculates the best context found to restore one collection of qcats, 801 * al them belonging to the same context (question bank), returning the 802 * target context found (object) or false 803 */ 804 public static function restore_find_best_target_context($categories, $courseid, $contextlevel) { 805 global $DB; 806 807 $targetcontext = false; 808 809 // Depending of $contextlevel, we perform different actions 810 switch ($contextlevel) { 811 // For system is easy, the best context is the system context 812 case CONTEXT_SYSTEM: 813 $targetcontext = context_system::instance(); 814 break; 815 816 // For coursecat, we are going to look for stamps in all the 817 // course categories between CONTEXT_SYSTEM and CONTEXT_COURSE 818 // (i.e. in all the course categories in the path) 819 // 820 // And only will return one "best" target context if all the 821 // matches belong to ONE and ONLY ONE context. If multiple 822 // matches are found, that means that there is some annoying 823 // qbank "fragmentation" in the categories, so we'll fallback 824 // to create the qbank at course level 825 case CONTEXT_COURSECAT: 826 // Build the array of stamps we are going to match 827 $stamps = array(); 828 foreach ($categories as $category) { 829 $stamps[] = $category->stamp; 830 } 831 $contexts = array(); 832 // Build the array of contexts we are going to look 833 $systemctx = context_system::instance(); 834 $coursectx = context_course::instance($courseid); 835 $parentctxs = $coursectx->get_parent_context_ids(); 836 foreach ($parentctxs as $parentctx) { 837 // Exclude system context 838 if ($parentctx == $systemctx->id) { 839 continue; 840 } 841 $contexts[] = $parentctx; 842 } 843 if (!empty($stamps) && !empty($contexts)) { 844 // Prepare the query 845 list($stamp_sql, $stamp_params) = $DB->get_in_or_equal($stamps); 846 list($context_sql, $context_params) = $DB->get_in_or_equal($contexts); 847 $sql = "SELECT DISTINCT contextid 848 FROM {question_categories} 849 WHERE stamp $stamp_sql 850 AND contextid $context_sql"; 851 $params = array_merge($stamp_params, $context_params); 852 $matchingcontexts = $DB->get_records_sql($sql, $params); 853 // Only if ONE and ONLY ONE context is found, use it as valid target 854 if (count($matchingcontexts) == 1) { 855 $targetcontext = context::instance_by_id(reset($matchingcontexts)->contextid); 856 } 857 } 858 break; 859 860 // For course is easy, the best context is the course context 861 case CONTEXT_COURSE: 862 $targetcontext = context_course::instance($courseid); 863 break; 864 865 // For module is easy, there is not best context, as far as the 866 // activity hasn't been created yet. So we return context course 867 // for them, so permission checks and friends will work. Note this 868 // case is handled by {@link prechek_precheck_qbanks_by_level} 869 // in an special way 870 case CONTEXT_MODULE: 871 $targetcontext = context_course::instance($courseid); 872 break; 873 } 874 return $targetcontext; 875 } 876 877 /** 878 * Return one array of question records for 879 * a given restore operation and one question category 880 */ 881 public static function restore_get_questions($restoreid, $qcatid) { 882 global $DB; 883 884 $results = array(); 885 $qs = $DB->get_recordset_sql("SELECT itemid, info 886 FROM {backup_ids_temp} 887 WHERE backupid = ? 888 AND itemname = 'question' 889 AND parentitemid = ?", array($restoreid, $qcatid)); 890 foreach ($qs as $q) { 891 $results[$q->itemid] = backup_controller_dbops::decode_backup_temp_info($q->info); 892 } 893 $qs->close(); 894 return $results; 895 } 896 897 /** 898 * Given one component/filearea/context and 899 * optionally one source itemname to match itemids 900 * put the corresponding files in the pool 901 * 902 * If you specify a progress reporter, it will get called once per file with 903 * indeterminate progress. 904 * 905 * @param string $basepath the full path to the root of unzipped backup file 906 * @param string $restoreid the restore job's identification 907 * @param string $component 908 * @param string $filearea 909 * @param int $oldcontextid 910 * @param int $dfltuserid default $file->user if the old one can't be mapped 911 * @param string|null $itemname 912 * @param int|null $olditemid 913 * @param int|null $forcenewcontextid explicit value for the new contextid (skip mapping) 914 * @param bool $skipparentitemidctxmatch 915 * @param \core\progress\base $progress Optional progress reporter 916 * @return array of result object 917 */ 918 public static function send_files_to_pool($basepath, $restoreid, $component, $filearea, 919 $oldcontextid, $dfltuserid, $itemname = null, $olditemid = null, 920 $forcenewcontextid = null, $skipparentitemidctxmatch = false, 921 \core\progress\base $progress = null) { 922 global $DB, $CFG; 923 924 $backupinfo = backup_general_helper::get_backup_information(basename($basepath)); 925 $includesfiles = $backupinfo->include_files; 926 927 $results = array(); 928 929 if ($forcenewcontextid) { 930 // Some components can have "forced" new contexts (example: questions can end belonging to non-standard context mappings, 931 // with questions originally at system/coursecat context in source being restored to course context in target). So we need 932 // to be able to force the new contextid 933 $newcontextid = $forcenewcontextid; 934 } else { 935 // Get new context, must exist or this will fail 936 $newcontextrecord = self::get_backup_ids_record($restoreid, 'context', $oldcontextid); 937 if (!$newcontextrecord || !$newcontextrecord->newitemid) { 938 throw new restore_dbops_exception('unknown_context_mapping', $oldcontextid); 939 } 940 $newcontextid = $newcontextrecord->newitemid; 941 } 942 943 // Sometimes it's possible to have not the oldcontextids stored into backup_ids_temp->parentitemid 944 // columns (because we have used them to store other information). This happens usually with 945 // all the question related backup_ids_temp records. In that case, it's safe to ignore that 946 // matching as far as we are always restoring for well known oldcontexts and olditemids 947 $parentitemctxmatchsql = ' AND i.parentitemid = f.contextid '; 948 if ($skipparentitemidctxmatch) { 949 $parentitemctxmatchsql = ''; 950 } 951 952 // Important: remember how files have been loaded to backup_files_temp 953 // - info: contains the whole original object (times, names...) 954 // (all them being original ids as loaded from xml) 955 956 // itemname = null, we are going to match only by context, no need to use itemid (all them are 0) 957 if ($itemname == null) { 958 $sql = "SELECT id AS bftid, contextid, component, filearea, itemid, itemid AS newitemid, info 959 FROM {backup_files_temp} 960 WHERE backupid = ? 961 AND contextid = ? 962 AND component = ? 963 AND filearea = ?"; 964 $params = array($restoreid, $oldcontextid, $component, $filearea); 965 966 // itemname not null, going to join with backup_ids to perform the old-new mapping of itemids 967 } else { 968 $sql = "SELECT f.id AS bftid, f.contextid, f.component, f.filearea, f.itemid, i.newitemid, f.info 969 FROM {backup_files_temp} f 970 JOIN {backup_ids_temp} i ON i.backupid = f.backupid 971 $parentitemctxmatchsql 972 AND i.itemid = f.itemid 973 WHERE f.backupid = ? 974 AND f.contextid = ? 975 AND f.component = ? 976 AND f.filearea = ? 977 AND i.itemname = ?"; 978 $params = array($restoreid, $oldcontextid, $component, $filearea, $itemname); 979 if ($olditemid !== null) { // Just process ONE olditemid intead of the whole itemname 980 $sql .= ' AND i.itemid = ?'; 981 $params[] = $olditemid; 982 } 983 } 984 985 $fs = get_file_storage(); // Get moodle file storage 986 $basepath = $basepath . '/files/';// Get backup file pool base 987 // Report progress before query. 988 if ($progress) { 989 $progress->progress(); 990 } 991 $rs = $DB->get_recordset_sql($sql, $params); 992 foreach ($rs as $rec) { 993 // Report progress each time around loop. 994 if ($progress) { 995 $progress->progress(); 996 } 997 998 $file = (object)backup_controller_dbops::decode_backup_temp_info($rec->info); 999 1000 // ignore root dirs (they are created automatically) 1001 if ($file->filepath == '/' && $file->filename == '.') { 1002 continue; 1003 } 1004 1005 // set the best possible user 1006 $mappeduser = self::get_backup_ids_record($restoreid, 'user', $file->userid); 1007 $mappeduserid = !empty($mappeduser) ? $mappeduser->newitemid : $dfltuserid; 1008 1009 // dir found (and not root one), let's create it 1010 if ($file->filename == '.') { 1011 $fs->create_directory($newcontextid, $component, $filearea, $rec->newitemid, $file->filepath, $mappeduserid); 1012 continue; 1013 } 1014 1015 // The file record to restore. 1016 $file_record = array( 1017 'contextid' => $newcontextid, 1018 'component' => $component, 1019 'filearea' => $filearea, 1020 'itemid' => $rec->newitemid, 1021 'filepath' => $file->filepath, 1022 'filename' => $file->filename, 1023 'timecreated' => $file->timecreated, 1024 'timemodified'=> $file->timemodified, 1025 'userid' => $mappeduserid, 1026 'source' => $file->source, 1027 'author' => $file->author, 1028 'license' => $file->license, 1029 'sortorder' => $file->sortorder 1030 ); 1031 1032 if (empty($file->repositoryid)) { 1033 // If contenthash is empty then gracefully skip adding file. 1034 if (empty($file->contenthash)) { 1035 $result = new stdClass(); 1036 $result->code = 'file_missing_in_backup'; 1037 $result->message = sprintf('missing file (%s) contenthash in backup for component %s', $file->filename, $component); 1038 $result->level = backup::LOG_WARNING; 1039 $results[] = $result; 1040 continue; 1041 } 1042 // this is a regular file, it must be present in the backup pool 1043 $backuppath = $basepath . backup_file_manager::get_backup_content_file_location($file->contenthash); 1044 1045 // Some file types do not include the files as they should already be 1046 // present. We still need to create entries into the files table. 1047 if ($includesfiles) { 1048 // The file is not found in the backup. 1049 if (!file_exists($backuppath)) { 1050 $results[] = self::get_missing_file_result($file); 1051 continue; 1052 } 1053 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)) { 1056 1057 // If no license found, use default. 1058 if ($file->license == null){ 1059 $file->license = $CFG->sitedefaultlicense; 1060 } 1061 1062 $fs->create_file_from_pathname($file_record, $backuppath); 1063 } 1064 } else { 1065 // This backup does not include the files - they should be available in moodle filestorage already. 1066 1067 // Create the file in the filepool if it does not exist yet. 1068 if (!$fs->file_exists($newcontextid, $component, $filearea, $rec->newitemid, $file->filepath, $file->filename)) { 1069 1070 // Even if a file has been deleted since the backup was made, the file metadata may remain in the 1071 // files table, and the file will not yet have been moved to the trashdir. e.g. a draft file version. 1072 // Try to recover from file table first. 1073 if ($foundfiles = $DB->get_records('files', array('contenthash' => $file->contenthash), '', '*', 0, 1)) { 1074 // Only grab one of the foundfiles - the file content should be the same for all entries. 1075 $foundfile = reset($foundfiles); 1076 $fs->create_file_from_storedfile($file_record, $foundfile->id); 1077 } else { 1078 $filesystem = $fs->get_file_system(); 1079 $restorefile = $file; 1080 $restorefile->contextid = $newcontextid; 1081 $restorefile->itemid = $rec->newitemid; 1082 $storedfile = new stored_file($fs, $restorefile); 1083 1084 // Ok, let's try recover this file. 1085 // 1. We check if the file can be fetched locally without attempting to fetch 1086 // from the trash. 1087 // 2. We check if we can get the remote filepath for the specified stored file. 1088 // 3. We check if the file can be fetched from the trash. 1089 // 4. All failed, say we couldn't find it. 1090 if ($filesystem->is_file_readable_locally_by_storedfile($storedfile)) { 1091 $localpath = $filesystem->get_local_path_from_storedfile($storedfile); 1092 $fs->create_file_from_pathname($file, $localpath); 1093 } else if ($filesystem->is_file_readable_remotely_by_storedfile($storedfile)) { 1094 $remotepath = $filesystem->get_remote_path_from_storedfile($storedfile); 1095 $fs->create_file_from_pathname($file, $remotepath); 1096 } else if ($filesystem->is_file_readable_locally_by_storedfile($storedfile, true)) { 1097 $localpath = $filesystem->get_local_path_from_storedfile($storedfile, true); 1098 $fs->create_file_from_pathname($file, $localpath); 1099 } else { 1100 // A matching file was not found. 1101 $results[] = self::get_missing_file_result($file); 1102 continue; 1103 } 1104 } 1105 } 1106 } 1107 1108 // store the the new contextid and the new itemid in case we need to remap 1109 // references to this file later 1110 $DB->update_record('backup_files_temp', array( 1111 'id' => $rec->bftid, 1112 'newcontextid' => $newcontextid, 1113 'newitemid' => $rec->newitemid), true); 1114 1115 } else { 1116 // this is an alias - we can't create it yet so we stash it in a temp 1117 // table and will let the final task to deal with it 1118 if (!$fs->file_exists($newcontextid, $component, $filearea, $rec->newitemid, $file->filepath, $file->filename)) { 1119 $info = new stdClass(); 1120 // oldfile holds the raw information stored in MBZ (including reference-related info) 1121 $info->oldfile = $file; 1122 // newfile holds the info for the new file_record with the context, user and itemid mapped 1123 $info->newfile = (object) $file_record; 1124 1125 restore_dbops::set_backup_ids_record($restoreid, 'file_aliases_queue', $file->id, 0, null, $info); 1126 } 1127 } 1128 } 1129 $rs->close(); 1130 return $results; 1131 } 1132 1133 /** 1134 * Returns suitable entry to include in log when there is a missing file. 1135 * 1136 * @param stdClass $file File definition 1137 * @return stdClass Log entry 1138 */ 1139 protected static function get_missing_file_result($file) { 1140 $result = new stdClass(); 1141 $result->code = 'file_missing_in_backup'; 1142 $result->message = 'Missing file in backup: ' . $file->filepath . $file->filename . 1143 ' (old context ' . $file->contextid . ', component ' . $file->component . 1144 ', filearea ' . $file->filearea . ', old itemid ' . $file->itemid . ')'; 1145 $result->level = backup::LOG_WARNING; 1146 return $result; 1147 } 1148 1149 /** 1150 * Given one restoreid, create in DB all the users present 1151 * in backup_ids having newitemid = 0, as far as 1152 * precheck_included_users() have left them there 1153 * ready to be created. Also, annotate their newids 1154 * once created for later reference. 1155 * 1156 * This function will start and end a new progress section in the progress 1157 * object. 1158 * 1159 * @param string $basepath Base path of unzipped backup 1160 * @param string $restoreid Restore ID 1161 * @param int $userid Default userid for files 1162 * @param \core\progress\base $progress Object used for progress tracking 1163 */ 1164 public static function create_included_users($basepath, $restoreid, $userid, 1165 \core\progress\base $progress) { 1166 global $CFG, $DB; 1167 require_once($CFG->dirroot.'/user/profile/lib.php'); 1168 $progress->start_progress('Creating included users'); 1169 1170 $authcache = array(); // Cache to get some bits from authentication plugins 1171 $languages = get_string_manager()->get_list_of_translations(); // Get languages for quick search later 1172 $themes = get_list_of_themes(); // Get themes for quick search later 1173 1174 // Iterate over all the included users with newitemid = 0, have to create them 1175 $rs = $DB->get_recordset('backup_ids_temp', array('backupid' => $restoreid, 'itemname' => 'user', 'newitemid' => 0), '', 'itemid, parentitemid, info'); 1176 foreach ($rs as $recuser) { 1177 $progress->progress(); 1178 $user = (object)backup_controller_dbops::decode_backup_temp_info($recuser->info); 1179 1180 // if user lang doesn't exist here, use site default 1181 if (!array_key_exists($user->lang, $languages)) { 1182 $user->lang = get_newuser_language(); 1183 } 1184 1185 // if user theme isn't available on target site or they are disabled, reset theme 1186 if (!empty($user->theme)) { 1187 if (empty($CFG->allowuserthemes) || !in_array($user->theme, $themes)) { 1188 $user->theme = ''; 1189 } 1190 } 1191 1192 // if user to be created has mnet auth and its mnethostid is $CFG->mnet_localhost_id 1193 // that's 100% impossible as own server cannot be accesed over mnet. Change auth to email/manual 1194 if ($user->auth == 'mnet' && $user->mnethostid == $CFG->mnet_localhost_id) { 1195 // Respect registerauth 1196 if ($CFG->registerauth == 'email') { 1197 $user->auth = 'email'; 1198 } else { 1199 $user->auth = 'manual'; 1200 } 1201 } 1202 unset($user->mnethosturl); // Not needed anymore 1203 1204 // Disable pictures based on global setting 1205 if (!empty($CFG->disableuserimages)) { 1206 $user->picture = 0; 1207 } 1208 1209 // We need to analyse the AUTH field to recode it: 1210 // - if the auth isn't enabled in target site, $CFG->registerauth will decide 1211 // - finally, if the auth resulting isn't enabled, default to 'manual' 1212 if (!is_enabled_auth($user->auth)) { 1213 if ($CFG->registerauth == 'email') { 1214 $user->auth = 'email'; 1215 } else { 1216 $user->auth = 'manual'; 1217 } 1218 } 1219 if (!is_enabled_auth($user->auth)) { // Final auth check verify, default to manual if not enabled 1220 $user->auth = 'manual'; 1221 } 1222 1223 // Now that we know the auth method, for users to be created without pass 1224 // if password handling is internal and reset password is available 1225 // we set the password to "restored" (plain text), so the login process 1226 // will know how to handle that situation in order to allow the user to 1227 // recover the password. MDL-20846 1228 if (empty($user->password)) { // Only if restore comes without password 1229 if (!array_key_exists($user->auth, $authcache)) { // Not in cache 1230 $userauth = new stdClass(); 1231 $authplugin = get_auth_plugin($user->auth); 1232 $userauth->preventpassindb = $authplugin->prevent_local_passwords(); 1233 $userauth->isinternal = $authplugin->is_internal(); 1234 $userauth->canresetpwd = $authplugin->can_reset_password(); 1235 $authcache[$user->auth] = $userauth; 1236 } else { 1237 $userauth = $authcache[$user->auth]; // Get from cache 1238 } 1239 1240 // Most external plugins do not store passwords locally 1241 if (!empty($userauth->preventpassindb)) { 1242 $user->password = AUTH_PASSWORD_NOT_CACHED; 1243 1244 // If Moodle is responsible for storing/validating pwd and reset functionality is available, mark 1245 } else if ($userauth->isinternal and $userauth->canresetpwd) { 1246 $user->password = 'restored'; 1247 } 1248 } 1249 1250 // Creating new user, we must reset the policyagreed always 1251 $user->policyagreed = 0; 1252 1253 // Set time created if empty 1254 if (empty($user->timecreated)) { 1255 $user->timecreated = time(); 1256 } 1257 1258 // Done, let's create the user and annotate its id 1259 $newuserid = $DB->insert_record('user', $user); 1260 self::set_backup_ids_record($restoreid, 'user', $recuser->itemid, $newuserid); 1261 // Let's create the user context and annotate it (we need it for sure at least for files) 1262 // but for deleted users that don't have a context anymore (MDL-30192). We are done for them 1263 // and nothing else (custom fields, prefs, tags, files...) will be created. 1264 if (empty($user->deleted)) { 1265 $newuserctxid = $user->deleted ? 0 : context_user::instance($newuserid)->id; 1266 self::set_backup_ids_record($restoreid, 'context', $recuser->parentitemid, $newuserctxid); 1267 1268 // Process custom fields 1269 if (isset($user->custom_fields)) { // if present in backup 1270 foreach($user->custom_fields['custom_field'] as $udata) { 1271 $udata = (object)$udata; 1272 // If the profile field has data and the profile shortname-datatype is defined in server 1273 if ($udata->field_data) { 1274 $field = profile_get_custom_field_data_by_shortname($udata->field_name); 1275 if ($field && $field->datatype === $udata->field_type) { 1276 // Insert the user_custom_profile_field. 1277 $rec = new stdClass(); 1278 $rec->userid = $newuserid; 1279 $rec->fieldid = $field->id; 1280 $rec->data = $udata->field_data; 1281 $DB->insert_record('user_info_data', $rec); 1282 } 1283 } 1284 } 1285 } 1286 1287 // Process tags 1288 if (core_tag_tag::is_enabled('core', 'user') && isset($user->tags)) { // If enabled in server and present in backup. 1289 $tags = array(); 1290 foreach($user->tags['tag'] as $usertag) { 1291 $usertag = (object)$usertag; 1292 $tags[] = $usertag->rawname; 1293 } 1294 core_tag_tag::set_item_tags('core', 'user', $newuserid, 1295 context_user::instance($newuserid), $tags); 1296 } 1297 1298 // Process preferences 1299 if (isset($user->preferences)) { // if present in backup 1300 foreach($user->preferences['preference'] as $preference) { 1301 $preference = (object)$preference; 1302 // Prepare the record and insert it 1303 $preference->userid = $newuserid; 1304 $status = $DB->insert_record('user_preferences', $preference); 1305 } 1306 } 1307 // Special handling for htmleditor which was converted to a preference. 1308 if (isset($user->htmleditor)) { 1309 if ($user->htmleditor == 0) { 1310 $preference = new stdClass(); 1311 $preference->userid = $newuserid; 1312 $preference->name = 'htmleditor'; 1313 $preference->value = 'textarea'; 1314 $status = $DB->insert_record('user_preferences', $preference); 1315 } 1316 } 1317 1318 // Create user files in pool (profile, icon, private) by context 1319 restore_dbops::send_files_to_pool($basepath, $restoreid, 'user', 'icon', 1320 $recuser->parentitemid, $userid, null, null, null, false, $progress); 1321 restore_dbops::send_files_to_pool($basepath, $restoreid, 'user', 'profile', 1322 $recuser->parentitemid, $userid, null, null, null, false, $progress); 1323 } 1324 } 1325 $rs->close(); 1326 $progress->end_progress(); 1327 } 1328 1329 /** 1330 * Given one user object (from backup file), perform all the neccesary 1331 * checks is order to decide how that user will be handled on restore. 1332 * 1333 * Note the function requires $user->mnethostid to be already calculated 1334 * so it's caller responsibility to set it 1335 * 1336 * This function is used both by @restore_precheck_users() and 1337 * @restore_create_users() to get consistent results in both places 1338 * 1339 * It returns: 1340 * - one user object (from DB), if match has been found and user will be remapped 1341 * - boolean true if the user needs to be created 1342 * - boolean false if some conflict happened and the user cannot be handled 1343 * 1344 * Each test is responsible for returning its results and interrupt 1345 * execution. At the end, boolean true (user needs to be created) will be 1346 * returned if no test has interrupted that. 1347 * 1348 * Here it's the logic applied, keep it updated: 1349 * 1350 * If restoring users from same site backup: 1351 * 1A - Normal check: If match by id and username and mnethost => ok, return target user 1352 * 1B - If restoring an 'anonymous' user (created via the 'Anonymize user information' option) try to find a 1353 * match by username only => ok, return target user MDL-31484 1354 * 1C - Handle users deleted in DB and "alive" in backup file: 1355 * If match by id and mnethost and user is deleted in DB and 1356 * (match by username LIKE 'backup_email.%' or by non empty email = md5(username)) => ok, return target user 1357 * 1D - Handle users deleted in backup file and "alive" in DB: 1358 * If match by id and mnethost and user is deleted in backup file 1359 * and match by email = email_without_time(backup_email) => ok, return target user 1360 * 1E - Conflict: If match by username and mnethost and doesn't match by id => conflict, return false 1361 * 1F - None of the above, return true => User needs to be created 1362 * 1363 * if restoring from another site backup (cannot match by id here, replace it by email/firstaccess combination): 1364 * 2A - Normal check: 1365 * 2A1 - If match by username and mnethost and (email or non-zero firstaccess) => ok, return target user 1366 * 2A2 - Exceptional handling (MDL-21912): Match "admin" username. Then, if import_general_duplicate_admin_allowed is 1367 * enabled, attempt to map the admin user to the user 'admin_[oldsiteid]' if it exists. If not, 1368 * the user 'admin_[oldsiteid]' will be created in precheck_included users 1369 * 2B - Handle users deleted in DB and "alive" in backup file: 1370 * 2B1 - If match by mnethost and user is deleted in DB and not empty email = md5(username) and 1371 * (username LIKE 'backup_email.%' or non-zero firstaccess) => ok, return target user 1372 * 2B2 - If match by mnethost and user is deleted in DB and 1373 * username LIKE 'backup_email.%' and non-zero firstaccess) => ok, return target user 1374 * (to cover situations were md5(username) wasn't implemented on delete we requiere both) 1375 * 2C - Handle users deleted in backup file and "alive" in DB: 1376 * If match mnethost and user is deleted in backup file 1377 * and by email = email_without_time(backup_email) and non-zero firstaccess=> ok, return target user 1378 * 2D - Conflict: If match by username and mnethost and not by (email or non-zero firstaccess) => conflict, return false 1379 * 2E - None of the above, return true => User needs to be created 1380 * 1381 * Note: for DB deleted users email is stored in username field, hence we 1382 * are looking there for emails. See delete_user() 1383 * Note: for DB deleted users md5(username) is stored *sometimes* in the email field, 1384 * hence we are looking there for usernames if not empty. See delete_user() 1385 */ 1386 protected static function precheck_user($user, $samesite, $siteid = null) { 1387 global $CFG, $DB; 1388 1389 // Handle checks from same site backups 1390 if ($samesite && empty($CFG->forcedifferentsitecheckingusersonrestore)) { 1391 1392 // 1A - If match by id and username and mnethost => ok, return target user 1393 if ($rec = $DB->get_record('user', array('id'=>$user->id, 'username'=>$user->username, 'mnethostid'=>$user->mnethostid))) { 1394 return $rec; // Matching user found, return it 1395 } 1396 1397 // 1B - If restoring an 'anonymous' user (created via the 'Anonymize user information' option) try to find a 1398 // match by username only => ok, return target user MDL-31484 1399 // This avoids username / id mis-match problems when restoring subsequent anonymized backups. 1400 if (backup_anonymizer_helper::is_anonymous_user($user)) { 1401 if ($rec = $DB->get_record('user', array('username' => $user->username))) { 1402 return $rec; // Matching anonymous user found - return it 1403 } 1404 } 1405 1406 // 1C - Handle users deleted in DB and "alive" in backup file 1407 // Note: for DB deleted users email is stored in username field, hence we 1408 // are looking there for emails. See delete_user() 1409 // Note: for DB deleted users md5(username) is stored *sometimes* in the email field, 1410 // hence we are looking there for usernames if not empty. See delete_user() 1411 // If match by id and mnethost and user is deleted in DB and 1412 // match by username LIKE 'substring(backup_email).%' where the substr length matches the retained data in the 1413 // username field (100 - (timestamp + 1) characters), or by non empty email = md5(username) => ok, return target user. 1414 $usernamelookup = core_text::substr($user->email, 0, 89) . '.%'; 1415 if ($rec = $DB->get_record_sql("SELECT * 1416 FROM {user} u 1417 WHERE id = ? 1418 AND mnethostid = ? 1419 AND deleted = 1 1420 AND ( 1421 UPPER(username) LIKE UPPER(?) 1422 OR ( 1423 ".$DB->sql_isnotempty('user', 'email', false, false)." 1424 AND email = ? 1425 ) 1426 )", 1427 array($user->id, $user->mnethostid, $usernamelookup, md5($user->username)))) { 1428 return $rec; // Matching user, deleted in DB found, return it 1429 } 1430 1431 // 1D - Handle users deleted in backup file and "alive" in DB 1432 // If match by id and mnethost and user is deleted in backup file 1433 // and match by substring(email) = email_without_time(backup_email) where the substr length matches the retained data 1434 // in the username field (100 - (timestamp + 1) characters) => ok, return target user. 1435 if ($user->deleted) { 1436 // Note: for DB deleted users email is stored in username field, hence we 1437 // are looking there for emails. See delete_user() 1438 // Trim time() from email 1439 $trimemail = preg_replace('/(.*?)\.[0-9]+.?$/', '\\1', $user->username); 1440 if ($rec = $DB->get_record_sql("SELECT * 1441 FROM {user} u 1442 WHERE id = ? 1443 AND mnethostid = ? 1444 AND " . $DB->sql_substr('UPPER(email)', 1, 89) . " = UPPER(?)", 1445 array($user->id, $user->mnethostid, $trimemail))) { 1446 return $rec; // Matching user, deleted in backup file found, return it 1447 } 1448 } 1449 1450 // 1E - If match by username and mnethost and doesn't match by id => conflict, return false 1451 if ($rec = $DB->get_record('user', array('username'=>$user->username, 'mnethostid'=>$user->mnethostid))) { 1452 if ($user->id != $rec->id) { 1453 return false; // Conflict, username already exists and belongs to another id 1454 } 1455 } 1456 1457 // Handle checks from different site backups 1458 } else { 1459 1460 // 2A1 - If match by username and mnethost and 1461 // (email or non-zero firstaccess) => ok, return target user 1462 if ($rec = $DB->get_record_sql("SELECT * 1463 FROM {user} u 1464 WHERE username = ? 1465 AND mnethostid = ? 1466 AND ( 1467 UPPER(email) = UPPER(?) 1468 OR ( 1469 firstaccess != 0 1470 AND firstaccess = ? 1471 ) 1472 )", 1473 array($user->username, $user->mnethostid, $user->email, $user->firstaccess))) { 1474 return $rec; // Matching user found, return it 1475 } 1476 1477 // 2A2 - If we're allowing conflicting admins, attempt to map user to admin_[oldsiteid]. 1478 if (get_config('backup', 'import_general_duplicate_admin_allowed') && $user->username === 'admin' && $siteid 1479 && $user->mnethostid == $CFG->mnet_localhost_id) { 1480 if ($rec = $DB->get_record('user', array('username' => 'admin_' . $siteid))) { 1481 return $rec; 1482 } 1483 } 1484 1485 // 2B - Handle users deleted in DB and "alive" in backup file 1486 // Note: for DB deleted users email is stored in username field, hence we 1487 // are looking there for emails. See delete_user() 1488 // Note: for DB deleted users md5(username) is stored *sometimes* in the email field, 1489 // hence we are looking there for usernames if not empty. See delete_user() 1490 // 2B1 - If match by mnethost and user is deleted in DB and not empty email = md5(username) and 1491 // (by username LIKE 'substring(backup_email).%' or non-zero firstaccess) => ok, return target user. 1492 $usernamelookup = core_text::substr($user->email, 0, 89) . '.%'; 1493 if ($rec = $DB->get_record_sql("SELECT * 1494 FROM {user} u 1495 WHERE mnethostid = ? 1496 AND deleted = 1 1497 AND ".$DB->sql_isnotempty('user', 'email', false, false)." 1498 AND email = ? 1499 AND ( 1500 UPPER(username) LIKE UPPER(?) 1501 OR ( 1502 firstaccess != 0 1503 AND firstaccess = ? 1504 ) 1505 )", 1506 array($user->mnethostid, md5($user->username), $usernamelookup, $user->firstaccess))) { 1507 return $rec; // Matching user found, return it 1508 } 1509 1510 // 2B2 - If match by mnethost and user is deleted in DB and 1511 // username LIKE 'substring(backup_email).%' and non-zero firstaccess) => ok, return target user 1512 // (this covers situations where md5(username) wasn't being stored so we require both 1513 // the email & non-zero firstaccess to match) 1514 $usernamelookup = core_text::substr($user->email, 0, 89) . '.%'; 1515 if ($rec = $DB->get_record_sql("SELECT * 1516 FROM {user} u 1517 WHERE mnethostid = ? 1518 AND deleted = 1 1519 AND UPPER(username) LIKE UPPER(?) 1520 AND firstaccess != 0 1521 AND firstaccess = ?", 1522 array($user->mnethostid, $usernamelookup, $user->firstaccess))) { 1523 return $rec; // Matching user found, return it 1524 } 1525 1526 // 2C - Handle users deleted in backup file and "alive" in DB 1527 // If match mnethost and user is deleted in backup file 1528 // and match by substring(email) = email_without_time(backup_email) and non-zero firstaccess=> ok, return target user. 1529 if ($user->deleted) { 1530 // Note: for DB deleted users email is stored in username field, hence we 1531 // are looking there for emails. See delete_user() 1532 // Trim time() from email 1533 $trimemail = preg_replace('/(.*?)\.[0-9]+.?$/', '\\1', $user->username); 1534 if ($rec = $DB->get_record_sql("SELECT * 1535 FROM {user} u 1536 WHERE mnethostid = ? 1537 AND " . $DB->sql_substr('UPPER(email)', 1, 89) . " = UPPER(?) 1538 AND firstaccess != 0 1539 AND firstaccess = ?", 1540 array($user->mnethostid, $trimemail, $user->firstaccess))) { 1541 return $rec; // Matching user, deleted in backup file found, return it 1542 } 1543 } 1544 1545 // 2D - If match by username and mnethost and not by (email or non-zero firstaccess) => conflict, return false 1546 if ($rec = $DB->get_record_sql("SELECT * 1547 FROM {user} u 1548 WHERE username = ? 1549 AND mnethostid = ? 1550 AND NOT ( 1551 UPPER(email) = UPPER(?) 1552 OR ( 1553 firstaccess != 0 1554 AND firstaccess = ? 1555 ) 1556 )", 1557 array($user->username, $user->mnethostid, $user->email, $user->firstaccess))) { 1558 return false; // Conflict, username/mnethostid already exist and belong to another user (by email/firstaccess) 1559 } 1560 } 1561 1562 // Arrived here, return true as the user will need to be created and no 1563 // conflicts have been found in the logic above. This covers: 1564 // 1E - else => user needs to be created, return true 1565 // 2E - else => user needs to be created, return true 1566 return true; 1567 } 1568 1569 /** 1570 * Check all the included users, deciding the action to perform 1571 * for each one (mapping / creation) and returning one array 1572 * of problems in case something is wrong (lack of permissions, 1573 * conficts) 1574 * 1575 * @param string $restoreid Restore id 1576 * @param int $courseid Course id 1577 * @param int $userid User id 1578 * @param bool $samesite True if restore is to same site 1579 * @param \core\progress\base $progress Progress reporter 1580 */ 1581 public static function precheck_included_users($restoreid, $courseid, $userid, $samesite, 1582 \core\progress\base $progress) { 1583 global $CFG, $DB; 1584 1585 // To return any problem found 1586 $problems = array(); 1587 1588 // We are going to map mnethostid, so load all the available ones 1589 $mnethosts = $DB->get_records('mnet_host', array(), 'wwwroot', 'wwwroot, id'); 1590 1591 // Calculate the context we are going to use for capability checking 1592 $context = context_course::instance($courseid); 1593 1594 // TODO: Some day we must kill this dependency and change the process 1595 // to pass info around without loading a controller copy. 1596 // When conflicting users are detected we may need original site info. 1597 $rc = restore_controller_dbops::load_controller($restoreid); 1598 $restoreinfo = $rc->get_info(); 1599 $rc->destroy(); // Always need to destroy. 1600 1601 // Calculate if we have perms to create users, by checking: 1602 // to 'moodle/restore:createuser' and 'moodle/restore:userinfo' 1603 // and also observe $CFG->disableusercreationonrestore 1604 $cancreateuser = false; 1605 if (has_capability('moodle/restore:createuser', $context, $userid) and 1606 has_capability('moodle/restore:userinfo', $context, $userid) and 1607 empty($CFG->disableusercreationonrestore)) { // Can create users 1608 1609 $cancreateuser = true; 1610 } 1611 1612 // Prepare for reporting progress. 1613 $conditions = array('backupid' => $restoreid, 'itemname' => 'user'); 1614 $max = $DB->count_records('backup_ids_temp', $conditions); 1615 $done = 0; 1616 $progress->start_progress('Checking users', $max); 1617 1618 // Iterate over all the included users 1619 $rs = $DB->get_recordset('backup_ids_temp', $conditions, '', 'itemid, info'); 1620 foreach ($rs as $recuser) { 1621 $user = (object)backup_controller_dbops::decode_backup_temp_info($recuser->info); 1622 1623 // Find the correct mnethostid for user before performing any further check 1624 if (empty($user->mnethosturl) || $user->mnethosturl === $CFG->wwwroot) { 1625 $user->mnethostid = $CFG->mnet_localhost_id; 1626 } else { 1627 // fast url-to-id lookups 1628 if (isset($mnethosts[$user->mnethosturl])) { 1629 $user->mnethostid = $mnethosts[$user->mnethosturl]->id; 1630 } else { 1631 $user->mnethostid = $CFG->mnet_localhost_id; 1632 } 1633 } 1634 1635 // Now, precheck that user and, based on returned results, annotate action/problem 1636 $usercheck = self::precheck_user($user, $samesite, $restoreinfo->original_site_identifier_hash); 1637 1638 if (is_object($usercheck)) { // No problem, we have found one user in DB to be mapped to 1639 // Annotate it, for later process. Set newitemid to mapping user->id 1640 self::set_backup_ids_record($restoreid, 'user', $recuser->itemid, $usercheck->id); 1641 1642 } else if ($usercheck === false) { // Found conflict, report it as problem 1643 if (!get_config('backup', 'import_general_duplicate_admin_allowed')) { 1644 $problems[] = get_string('restoreuserconflict', '', $user->username); 1645 } else if ($user->username == 'admin') { 1646 if (!$cancreateuser) { 1647 $problems[] = get_string('restorecannotcreateuser', '', $user->username); 1648 } 1649 if ($user->mnethostid != $CFG->mnet_localhost_id) { 1650 $problems[] = get_string('restoremnethostidmismatch', '', $user->username); 1651 } 1652 if (!$problems) { 1653 // Duplicate admin allowed, append original site idenfitier to username. 1654 $user->username .= '_' . $restoreinfo->original_site_identifier_hash; 1655 self::set_backup_ids_record($restoreid, 'user', $recuser->itemid, 0, null, (array)$user); 1656 } 1657 } 1658 1659 } else if ($usercheck === true) { // User needs to be created, check if we are able 1660 if ($cancreateuser) { // Can create user, set newitemid to 0 so will be created later 1661 self::set_backup_ids_record($restoreid, 'user', $recuser->itemid, 0, null, (array)$user); 1662 1663 } else { // Cannot create user, report it as problem 1664 $problems[] = get_string('restorecannotcreateuser', '', $user->username); 1665 } 1666 1667 } else { // Shouldn't arrive here ever, something is for sure wrong. Exception 1668 throw new restore_dbops_exception('restore_error_processing_user', $user->username); 1669 } 1670 $done++; 1671 $progress->progress($done); 1672 } 1673 $rs->close(); 1674 $progress->end_progress(); 1675 return $problems; 1676 } 1677 1678 /** 1679 * Process the needed users in order to decide 1680 * which action to perform with them (create/map) 1681 * 1682 * Just wrap over precheck_included_users(), returning 1683 * exception if any problem is found 1684 * 1685 * @param string $restoreid Restore id 1686 * @param int $courseid Course id 1687 * @param int $userid User id 1688 * @param bool $samesite True if restore is to same site 1689 * @param \core\progress\base $progress Optional progress tracker 1690 */ 1691 public static function process_included_users($restoreid, $courseid, $userid, $samesite, 1692 \core\progress\base $progress = null) { 1693 global $DB; 1694 1695 // Just let precheck_included_users() to do all the hard work 1696 $problems = self::precheck_included_users($restoreid, $courseid, $userid, $samesite, $progress); 1697 1698 // With problems, throw exception, shouldn't happen if prechecks were originally 1699 // executed, so be radical here. 1700 if (!empty($problems)) { 1701 throw new restore_dbops_exception('restore_problems_processing_users', null, implode(', ', $problems)); 1702 } 1703 } 1704 1705 /** 1706 * Process the needed question categories and questions 1707 * to check all them, deciding about the action to perform 1708 * (create/map) and target. 1709 * 1710 * Just wrap over precheck_categories_and_questions(), returning 1711 * exception if any problem is found 1712 */ 1713 public static function process_categories_and_questions($restoreid, $courseid, $userid, $samesite) { 1714 global $DB; 1715 1716 // Just let precheck_included_users() to do all the hard work 1717 $problems = self::precheck_categories_and_questions($restoreid, $courseid, $userid, $samesite); 1718 1719 // With problems of type error, throw exception, shouldn't happen if prechecks were originally 1720 // executed, so be radical here. 1721 if (array_key_exists('errors', $problems)) { 1722 throw new restore_dbops_exception('restore_problems_processing_questions', null, implode(', ', $problems['errors'])); 1723 } 1724 } 1725 1726 public static function set_backup_files_record($restoreid, $filerec) { 1727 global $DB; 1728 1729 // Store external files info in `info` field 1730 $filerec->info = backup_controller_dbops::encode_backup_temp_info($filerec); // Encode the whole record into info. 1731 $filerec->backupid = $restoreid; 1732 $DB->insert_record('backup_files_temp', $filerec); 1733 } 1734 1735 public static function set_backup_ids_record($restoreid, $itemname, $itemid, $newitemid = 0, $parentitemid = null, $info = null) { 1736 // Build conditionally the extra record info 1737 $extrarecord = array(); 1738 if ($newitemid != 0) { 1739 $extrarecord['newitemid'] = $newitemid; 1740 } 1741 if ($parentitemid != null) { 1742 $extrarecord['parentitemid'] = $parentitemid; 1743 } 1744 if ($info != null) { 1745 $extrarecord['info'] = backup_controller_dbops::encode_backup_temp_info($info); 1746 } 1747 1748 self::set_backup_ids_cached($restoreid, $itemname, $itemid, $extrarecord); 1749 } 1750 1751 public static function get_backup_ids_record($restoreid, $itemname, $itemid) { 1752 $dbrec = self::get_backup_ids_cached($restoreid, $itemname, $itemid); 1753 1754 // We must test if info is a string, as the cache stores info in object form. 1755 if ($dbrec && isset($dbrec->info) && is_string($dbrec->info)) { 1756 $dbrec->info = backup_controller_dbops::decode_backup_temp_info($dbrec->info); 1757 } 1758 1759 return $dbrec; 1760 } 1761 1762 /** 1763 * Given on courseid, fullname and shortname, calculate the correct fullname/shortname to avoid dupes 1764 */ 1765 public static function calculate_course_names($courseid, $fullname, $shortname) { 1766 global $CFG, $DB; 1767 1768 $currentfullname = ''; 1769 $currentshortname = ''; 1770 $counter = 0; 1771 // Iteratere while the name exists 1772 do { 1773 if ($counter) { 1774 $suffixfull = ' ' . get_string('copyasnoun') . ' ' . $counter; 1775 $suffixshort = '_' . $counter; 1776 } else { 1777 $suffixfull = ''; 1778 $suffixshort = ''; 1779 } 1780 $currentfullname = $fullname.$suffixfull; 1781 $currentshortname = substr($shortname, 0, 100 - strlen($suffixshort)).$suffixshort; // < 100cc 1782 $coursefull = $DB->get_record_select('course', 'fullname = ? AND id != ?', 1783 array($currentfullname, $courseid), '*', IGNORE_MULTIPLE); 1784 $courseshort = $DB->get_record_select('course', 'shortname = ? AND id != ?', array($currentshortname, $courseid)); 1785 $counter++; 1786 } while ($coursefull || $courseshort); 1787 1788 // Return results 1789 return array($currentfullname, $currentshortname); 1790 } 1791 1792 /** 1793 * For the target course context, put as many custom role names as possible 1794 */ 1795 public static function set_course_role_names($restoreid, $courseid) { 1796 global $DB; 1797 1798 // Get the course context 1799 $coursectx = context_course::instance($courseid); 1800 // Get all the mapped roles we have 1801 $rs = $DB->get_recordset('backup_ids_temp', array('backupid' => $restoreid, 'itemname' => 'role'), '', 'itemid, info, newitemid'); 1802 foreach ($rs as $recrole) { 1803 $info = backup_controller_dbops::decode_backup_temp_info($recrole->info); 1804 // If it's one mapped role and we have one name for it 1805 if (!empty($recrole->newitemid) && !empty($info['nameincourse'])) { 1806 // If role name doesn't exist, add it 1807 $rolename = new stdclass(); 1808 $rolename->roleid = $recrole->newitemid; 1809 $rolename->contextid = $coursectx->id; 1810 if (!$DB->record_exists('role_names', (array)$rolename)) { 1811 $rolename->name = $info['nameincourse']; 1812 $DB->insert_record('role_names', $rolename); 1813 } 1814 } 1815 } 1816 $rs->close(); 1817 } 1818 1819 /** 1820 * Creates a skeleton record within the database using the passed parameters 1821 * and returns the new course id. 1822 * 1823 * @global moodle_database $DB 1824 * @param string $fullname 1825 * @param string $shortname 1826 * @param int $categoryid 1827 * @return int The new course id 1828 */ 1829 public static function create_new_course($fullname, $shortname, $categoryid) { 1830 global $DB; 1831 $category = $DB->get_record('course_categories', array('id'=>$categoryid), '*', MUST_EXIST); 1832 1833 $course = new stdClass; 1834 $course->fullname = $fullname; 1835 $course->shortname = $shortname; 1836 $course->category = $category->id; 1837 $course->sortorder = 0; 1838 $course->timecreated = time(); 1839 $course->timemodified = $course->timecreated; 1840 // forcing skeleton courses to be hidden instead of going by $category->visible , until MDL-27790 is resolved. 1841 $course->visible = 0; 1842 1843 $courseid = $DB->insert_record('course', $course); 1844 1845 $category->coursecount++; 1846 $DB->update_record('course_categories', $category); 1847 1848 return $courseid; 1849 } 1850 1851 /** 1852 * Deletes all of the content associated with the given course (courseid) 1853 * @param int $courseid 1854 * @param array $options 1855 * @return bool True for success 1856 */ 1857 public static function delete_course_content($courseid, array $options = null) { 1858 return remove_course_contents($courseid, false, $options); 1859 } 1860 } 1861 1862 /* 1863 * Exception class used by all the @dbops stuff 1864 */ 1865 class restore_dbops_exception extends backup_exception { 1866 1867 public function __construct($errorcode, $a=NULL, $debuginfo=null) { 1868 parent::__construct($errorcode, 'error', '', $a, null, $debuginfo); 1869 } 1870 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
