Updated the HEAD build version to 20100718
[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('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 users.xml file to backup_ids table for future reference
99      */
100     public static function load_users_to_tempids($restoreid, $usersfile) {
102         if (!file_exists($usersfile)) { // Shouldn't happen ever, but...
103             throw new backup_helper_exception('missing_users_xml_file', $inforeffile);
104         }
105         // Let's parse, custom processor will do its work, sending info to DB
106         $xmlparser = new progressive_parser();
107         $xmlparser->set_file($usersfile);
108         $xmlprocessor = new restore_users_parser_processor($restoreid);
109         $xmlparser->set_processor($xmlprocessor);
110         $xmlparser->process();
111     }
113     /**
114      * Given one restoreid, create in DB all the users present
115      * in backup_ids having newitemid = 0, as far as
116      * precheck_included_users() have left them there
117      * ready to be created. Also, annotate their newids
118      * once created for later reference
119      */
120     protected static function create_included_users($restoreid) {
121         global $CFG, $DB;
123         $authcache = array(); // Cache to get some bits from authentication plugins
124         $languages = get_string_manager()->get_list_of_translations(); // Get languages for quick search later
125         $themes    = get_list_of_themes(); // Get themes for quick search later
127         // Iterate over all the included users with newitemid = 0, have to create them
128         $rs = $DB->get_recordset('backup_ids_temp', array('backupid' => $restoreid, 'itemname' => 'user', 'newitemid' => 0), '', 'itemid, parentitemid');
129         foreach ($rs as $recuser) {
130             $user = (object)self::get_backup_ids_record($restoreid, 'user', $recuser->itemid)->info;
132             // if user lang doesn't exist here, use site default
133             if (!array_key_exists($user->lang, $languages)) {
134                 $user->lang = $CFG->lang;
135             }
137             // if user theme isn't available on target site or they are disabled, reset theme
138             if (!empty($user->theme)) {
139                 if (empty($CFG->allowuserthemes) || !in_array($user->theme, $themes)) {
140                     $user->theme = '';
141                 }
142             }
144             // if user to be created has mnet auth and its mnethostid is $CFG->mnet_localhost_id
145             // that's 100% impossible as own server cannot be accesed over mnet. Change auth to email/manual
146             if ($user->auth == 'mnet' && $user->mnethostid == $CFG->mnet_localhost_id) {
147                 // Respect registerauth
148                 if ($CFG->registerauth == 'email') {
149                     $user->auth = 'email';
150                 } else {
151                     $user->auth = 'manual';
152                 }
153             }
154             unset($user->mnethosturl); // Not needed anymore
156             // Disable pictures based on global setting
157             if (!empty($CFG->disableuserimages)) {
158                 $user->picture = 0;
159             }
161             // We need to analyse the AUTH field to recode it:
162             //   - if the auth isn't enabled in target site, $CFG->registerauth will decide
163             //   - finally, if the auth resulting isn't enabled, default to 'manual'
164             if (!is_enabled_auth($user->auth)) {
165                 if ($CFG->registerauth == 'email') {
166                     $user->auth = 'email';
167                 } else {
168                     $user->auth = 'manual';
169                 }
170             }
171             if (!is_enabled_auth($user->auth)) { // Final auth check verify, default to manual if not enabled
172                 $user->auth = 'manual';
173             }
175             // Now that we know the auth method, for users to be created without pass
176             // if password handling is internal and reset password is available
177             // we set the password to "restored" (plain text), so the login process
178             // will know how to handle that situation in order to allow the user to
179             // recover the password. MDL-20846
180             if (empty($user->password)) { // Only if restore comes without password
181                 if (!array_key_exists($user->auth, $authcache)) { // Not in cache
182                     $userauth = new stdClass();
183                     $authplugin = get_auth_plugin($user->auth);
184                     $userauth->preventpassindb = $authplugin->prevent_local_passwords();
185                     $userauth->isinternal      = $authplugin->is_internal();
186                     $userauth->canresetpwd     = $authplugin->can_reset_password();
187                     $authcache[$user->auth] = $userauth;
188                 } else {
189                     $userauth = $authcache[$user->auth]; // Get from cache
190                 }
192                 // Most external plugins do not store passwords locally
193                 if (!empty($userauth->preventpassindb)) {
194                     $user->password = 'not cached';
196                 // If Moodle is responsible for storing/validating pwd and reset functionality is available, mark
197                 } else if ($userauth->isinternal and $userauth->canresetpwd) {
198                     $user->password = 'restored';
199                 }
200             }
202             // Creating new user, we must reset the policyagreed always
203             $user->policyagreed = 0;
205             // Set time created if empty
206             if (empty($user->timecreated)) {
207                 $user->timecreated = time();
208             }
210             // Done, let's create the user and annotate its id
211             $newuserid = $DB->insert_record('user', $user);
212             self::set_backup_ids_record($restoreid, 'user', $recuser->itemid, $newuserid);
213             // Let's create the user context and annotate it (we need it for sure at least for files)
214             $newuserctxid = get_context_instance(CONTEXT_USER, $newuserid)->id;
215             self::set_backup_ids_record($restoreid, 'context', $recuser->parentitemid, $newuserctxid);
217             // Process custom fields
218             if (isset($user->custom_fields)) { // if present in backup
219                 foreach($user->custom_fields['custom_field'] as $udata) {
220                     $udata = (object)$udata;
221                     // If the profile field has data and the profile shortname-datatype is defined in server
222                     if ($udata->field_data) {
223                         if ($field = $DB->get_record('user_info_field', array('shortname'=>$udata->field_name, 'datatype'=>$udata->field_type))) {
224                         /// Insert the user_custom_profile_field
225                             $rec = new object();
226                             $rec->userid  = $newuserid;
227                             $rec->fieldid = $field->id;
228                             $rec->data    = $udata->field_data;
229                             $DB->insert_record('user_info_data', $rec);
230                         }
231                     }
232                 }
233             }
235             // Process tags
236             if (!empty($CFG->usetags) && isset($user->tags)) { // if enabled in server and present in backup
237                 $tags = array();
238                 foreach($user->tags['tag'] as $usertag) {
239                     $usertag = (object)$usertag;
240                     $tags[] = $usertag->rawname;
241                 }
242                 tag_set('user', $newuserid, $tags);
243             }
245             // Process preferences
246             if (isset($user->preferences)) { // if present in backup
247                 foreach($user->preferences as $preference) {
248                     $preference = (object)$preference;
249                     // Prepare the record and insert it
250                     $preference->userid = $newuserid;
251                     $status = $DB->insert_record('user_preferences', $preference);
252                 }
253             }
255         }
256         $rs->close();
257     }
259     /**
260     * Given one user object (from backup file), perform all the neccesary
261     * checks is order to decide how that user will be handled on restore.
262     *
263     * Note the function requires $user->mnethostid to be already calculated
264     * so it's caller responsibility to set it
265     *
266     * This function is used both by @restore_precheck_users() and
267     * @restore_create_users() to get consistent results in both places
268     *
269     * It returns:
270     *   - one user object (from DB), if match has been found and user will be remapped
271     *   - boolean true if the user needs to be created
272     *   - boolean false if some conflict happened and the user cannot be handled
273     *
274     * Each test is responsible for returning its results and interrupt
275     * execution. At the end, boolean true (user needs to be created) will be
276     * returned if no test has interrupted that.
277     *
278     * Here it's the logic applied, keep it updated:
279     *
280     *  If restoring users from same site backup:
281     *      1A - Normal check: If match by id and username and mnethost  => ok, return target user
282     *      1B - Handle users deleted in DB and "alive" in backup file:
283     *           If match by id and mnethost and user is deleted in DB and
284     *           (match by username LIKE 'backup_email.%' or by non empty email = md5(username)) => ok, return target user
285     *      1C - Handle users deleted in backup file and "alive" in DB:
286     *           If match by id and mnethost and user is deleted in backup file
287     *           and match by email = email_without_time(backup_email) => ok, return target user
288     *      1D - Conflict: If match by username and mnethost and doesn't match by id => conflict, return false
289     *      1E - None of the above, return true => User needs to be created
290     *
291     *  if restoring from another site backup (cannot match by id here, replace it by email/firstaccess combination):
292     *      2A - Normal check: If match by username and mnethost and (email or non-zero firstaccess) => ok, return target user
293     *      2B - Handle users deleted in DB and "alive" in backup file:
294     *           2B1 - If match by mnethost and user is deleted in DB and not empty email = md5(username) and
295     *                 (username LIKE 'backup_email.%' or non-zero firstaccess) => ok, return target user
296     *           2B2 - If match by mnethost and user is deleted in DB and
297     *                 username LIKE 'backup_email.%' and non-zero firstaccess) => ok, return target user
298     *                 (to cover situations were md5(username) wasn't implemented on delete we requiere both)
299     *      2C - Handle users deleted in backup file and "alive" in DB:
300     *           If match mnethost and user is deleted in backup file
301     *           and by email = email_without_time(backup_email) and non-zero firstaccess=> ok, return target user
302     *      2D - Conflict: If match by username and mnethost and not by (email or non-zero firstaccess) => conflict, return false
303     *      2E - None of the above, return true => User needs to be created
304     *
305     * Note: for DB deleted users email is stored in username field, hence we
306     *       are looking there for emails. See delete_user()
307     * Note: for DB deleted users md5(username) is stored *sometimes* in the email field,
308     *       hence we are looking there for usernames if not empty. See delete_user()
309     */
310     protected static function precheck_user($user, $samesite) {
311         global $CFG, $DB;
313         // Handle checks from same site backups
314         if ($samesite && empty($CFG->forcedifferentsitecheckingusersonrestore)) {
316             // 1A - If match by id and username and mnethost => ok, return target user
317             if ($rec = $DB->get_record('user', array('id'=>$user->id, 'username'=>$user->username, 'mnethostid'=>$user->mnethostid))) {
318                 return $rec; // Matching user found, return it
319             }
321             // 1B - Handle users deleted in DB and "alive" in backup file
322             // Note: for DB deleted users email is stored in username field, hence we
323             //       are looking there for emails. See delete_user()
324             // Note: for DB deleted users md5(username) is stored *sometimes* in the email field,
325             //       hence we are looking there for usernames if not empty. See delete_user()
326             // If match by id and mnethost and user is deleted in DB and
327             // match by username LIKE 'backup_email.%' or by non empty email = md5(username) => ok, return target user
328             if ($rec = $DB->get_record_sql("SELECT *
329                                               FROM {user} u
330                                              WHERE id = ?
331                                                AND mnethostid = ?
332                                                AND deleted = 1
333                                                AND (
334                                                        username LIKE ?
335                                                     OR (
336                                                            ".$DB->sql_isnotempty('user', 'email', false, false)."
337                                                        AND email = ?
338                                                        )
339                                                    )",
340                                            array($user->id, $user->mnethostid, $user->email.'.%', md5($user->username)))) {
341                 return $rec; // Matching user, deleted in DB found, return it
342             }
344             // 1C - Handle users deleted in backup file and "alive" in DB
345             // If match by id and mnethost and user is deleted in backup file
346             // and match by email = email_without_time(backup_email) => ok, return target user
347             if ($user->deleted) {
348                 // Note: for DB deleted users email is stored in username field, hence we
349                 //       are looking there for emails. See delete_user()
350                 // Trim time() from email
351                 $trimemail = preg_replace('/(.*?)\.[0-9]+.?$/', '\\1', $user->username);
352                 if ($rec = $DB->get_record_sql("SELECT *
353                                                   FROM {user} u
354                                                  WHERE id = ?
355                                                    AND mnethostid = ?
356                                                    AND email = ?",
357                                                array($user->id, $user->mnethostid, $trimemail))) {
358                     return $rec; // Matching user, deleted in backup file found, return it
359                 }
360             }
362             // 1D - If match by username and mnethost and doesn't match by id => conflict, return false
363             if ($rec = $DB->get_record('user', array('username'=>$user->username, 'mnethostid'=>$user->mnethostid))) {
364                 if ($user->id != $rec->id) {
365                     return false; // Conflict, username already exists and belongs to another id
366                 }
367             }
369         // Handle checks from different site backups
370         } else {
372             // 2A - If match by username and mnethost and
373             //     (email or non-zero firstaccess) => ok, return target user
374             if ($rec = $DB->get_record_sql("SELECT *
375                                               FROM {user} u
376                                              WHERE username = ?
377                                                AND mnethostid = ?
378                                                AND (
379                                                        email = ?
380                                                     OR (
381                                                            firstaccess != 0
382                                                        AND firstaccess = ?
383                                                        )
384                                                    )",
385                                            array($user->username, $user->mnethostid, $user->email, $user->firstaccess))) {
386                 return $rec; // Matching user found, return it
387             }
389             // 2B - Handle users deleted in DB and "alive" in backup file
390             // Note: for DB deleted users email is stored in username field, hence we
391             //       are looking there for emails. See delete_user()
392             // Note: for DB deleted users md5(username) is stored *sometimes* in the email field,
393             //       hence we are looking there for usernames if not empty. See delete_user()
394             // 2B1 - If match by mnethost and user is deleted in DB and not empty email = md5(username) and
395             //       (by username LIKE 'backup_email.%' or non-zero firstaccess) => ok, return target user
396             if ($rec = $DB->get_record_sql("SELECT *
397                                               FROM {user} u
398                                              WHERE mnethostid = ?
399                                                AND deleted = 1
400                                                AND ".$DB->sql_isnotempty('user', 'email', false, false)."
401                                                AND email = ?
402                                                AND (
403                                                        username LIKE ?
404                                                     OR (
405                                                            firstaccess != 0
406                                                        AND firstaccess = ?
407                                                        )
408                                                    )",
409                                            array($user->mnethostid, md5($user->username), $user->email.'.%', $user->firstaccess))) {
410                 return $rec; // Matching user found, return it
411             }
413             // 2B2 - If match by mnethost and user is deleted in DB and
414             //       username LIKE 'backup_email.%' and non-zero firstaccess) => ok, return target user
415             //       (this covers situations where md5(username) wasn't being stored so we require both
416             //        the email & non-zero firstaccess to match)
417             if ($rec = $DB->get_record_sql("SELECT *
418                                               FROM {user} u
419                                              WHERE mnethostid = ?
420                                                AND deleted = 1
421                                                AND username LIKE ?
422                                                AND firstaccess != 0
423                                                AND firstaccess = ?",
424                                            array($user->mnethostid, $user->email.'.%', $user->firstaccess))) {
425                 return $rec; // Matching user found, return it
426             }
428             // 2C - Handle users deleted in backup file and "alive" in DB
429             // If match mnethost and user is deleted in backup file
430             // and match by email = email_without_time(backup_email) and non-zero firstaccess=> ok, return target user
431             if ($user->deleted) {
432                 // Note: for DB deleted users email is stored in username field, hence we
433                 //       are looking there for emails. See delete_user()
434                 // Trim time() from email
435                 $trimemail = preg_replace('/(.*?)\.[0-9]+.?$/', '\\1', $user->username);
436                 if ($rec = $DB->get_record_sql("SELECT *
437                                                   FROM {user} u
438                                                  WHERE mnethostid = ?
439                                                    AND email = ?
440                                                    AND firstaccess != 0
441                                                    AND firstaccess = ?",
442                                                array($user->mnethostid, $trimemail, $user->firstaccess))) {
443                     return $rec; // Matching user, deleted in backup file found, return it
444                 }
445             }
447             // 2D - If match by username and mnethost and not by (email or non-zero firstaccess) => conflict, return false
448             if ($rec = $DB->get_record_sql("SELECT *
449                                               FROM {user} u
450                                              WHERE username = ?
451                                                AND mnethostid = ?
452                                            AND NOT (
453                                                        email = ?
454                                                     OR (
455                                                            firstaccess != 0
456                                                        AND firstaccess = ?
457                                                        )
458                                                    )",
459                                            array($user->username, $user->mnethostid, $user->email, $user->firstaccess))) {
460                 return false; // Conflict, username/mnethostid already exist and belong to another user (by email/firstaccess)
461             }
462         }
464         // Arrived here, return true as the user will need to be created and no
465         // conflicts have been found in the logic above. This covers:
466         // 1E - else => user needs to be created, return true
467         // 2E - else => user needs to be created, return true
468         return true;
469     }
471     /**
472      * Check all the included users, deciding the action to perform
473      * for each one (mapping / creation) and returning one array
474      * of problems in case something is wrong (lack of permissions,
475      * conficts)
476      */
477     public static function precheck_included_users($restoreid, $courseid, $userid, $samesite) {
478         global $CFG, $DB;
480         // To return any problem found
481         $problems = array();
483         // We are going to map mnethostid, so load all the available ones
484         $mnethosts = $DB->get_records('mnet_host', array(), 'wwwroot', 'wwwroot, id');
486         // Calculate the context we are going to use for capability checking
487         $context = get_context_instance(CONTEXT_COURSE, $courseid);
489         // Calculate if we have perms to create users, by checking:
490         // to 'moodle/restore:createuser' and 'moodle/restore:userinfo'
491         // and also observe $CFG->disableusercreationonrestore
492         $cancreateuser = false;
493         if (has_capability('moodle/restore:createuser', $context, $userid) and
494             has_capability('moodle/restore:userinfo', $context, $userid) and
495             empty($CFG->disableusercreationonrestore)) { // Can create users
497             $cancreateuser = true;
498         }
500         // Iterate over all the included users
501         $rs = $DB->get_recordset('backup_ids_temp', array('backupid' => $restoreid, 'itemname' => 'user'), '', 'itemid');
502         foreach ($rs as $recuser) {
503             $user = (object)self::get_backup_ids_record($restoreid, 'user', $recuser->itemid)->info;
505             // Find the correct mnethostid for user before performing any further check
506             if (empty($user->mnethosturl) || $user->mnethosturl === $CFG->wwwroot) {
507                 $user->mnethostid = $CFG->mnet_localhost_id;
508             } else {
509                 // fast url-to-id lookups
510                 if (isset($mnethosts[$user->mnethosturl])) {
511                     $user->mnethostid = $mnethosts[$user->mnethosturl]->id;
512                 } else {
513                     $user->mnethostid = $CFG->mnet_localhost_id;
514                 }
515             }
517             // Now, precheck that user and, based on returned results, annotate action/problem
518             $usercheck = self::precheck_user($user, $samesite);
520             if (is_object($usercheck)) { // No problem, we have found one user in DB to be mapped to
521                 // Annotate it, for later process. Set newitemid to mapping user->id
522                 self::set_backup_ids_record($restoreid, 'user', $recuser->itemid, $usercheck->id);
524             } else if ($usercheck === false) { // Found conflict, report it as problem
525                  $problems[] = get_string('restoreuserconflict', '', $user->username);
527             } else if ($usercheck === true) { // User needs to be created, check if we are able
528                 if ($cancreateuser) { // Can create user, set newitemid to 0 so will be created later
529                     self::set_backup_ids_record($restoreid, 'user', $recuser->itemid, 0, null, (array)$user);
531                 } else { // Cannot create user, report it as problem
532                     $problems[] = get_string('restorecannotcreateuser', '', $user->username);
533                 }
535             } else { // Shouldn't arrive here ever, something is for sure wrong. Exception
536                 throw new restore_dbops_exception('restore_error_processing_user', $user->username);
537             }
538         }
539         $rs->close();
540         return $problems;
541     }
543     /**
544      * Process the needed users in order to create / map them
545      *
546      * Just wrap over precheck_included_users(), returning
547      * exception if any problem is found or performing the
548      * required user creations if needed
549      */
550     public static function process_included_users($restoreid, $courseid, $userid, $samesite) {
551         global $DB;
553         // Just let precheck_included_users() to do all the hard work
554         $problems = self::precheck_included_users($restoreid, $courseid, $userid, $samesite);
556         // With problems, throw exception, shouldn't happen if prechecks were originally
557         // executed, so be radical here.
558         if (!empty($problems)) {
559             throw new restore_dbops_exception('restore_problems_processing_users', null, implode(', ', $problems));
560         }
562         // Now, create all the users that we haven't been able to map
563         self::create_included_users($restoreid);
564     }
567     public static function set_backup_ids_record($restoreid, $itemname, $itemid, $newitemid = 0, $parentitemid = null, $info = null) {
568         global $DB;
570         // Build the basic (mandatory) record info
571         $record = array(
572             'backupid' => $restoreid,
573             'itemname' => $itemname,
574             'itemid'   => $itemid
575         );
576         // Build conditionally the extra record info
577         $extrarecord = array();
578         if ($newitemid != 0) {
579             $extrarecord['newitemid'] = $newitemid;
580         }
581         if ($parentitemid != null) {
582             $extrarecord['parentitemid'] = $parentitemid;
583         }
584         if ($info != null) {
585             $extrarecord['info'] = base64_encode(serialize($info));
586         }
588         // TODO: Analyze if some static (and limited) cache by the 3 params could save us a bunch of get_record() calls
589         // Note: Sure it will! And also will improve getter
590         if (!$dbrec = $DB->get_record('backup_ids_temp', $record)) { // Need to insert the complete record
591             $DB->insert_record('backup_ids_temp', array_merge($record, $extrarecord));
593         } else { // Need to update the extra record info if there is something to
594             if (!empty($extrarecord)) {
595                 $extrarecord['id'] = $dbrec->id;
596                 $DB->update_record('backup_ids_temp', $extrarecord);
597             }
598         }
599     }
601     public static function get_backup_ids_record($restoreid, $itemname, $itemid) {
602         global $DB;
604         // Build the basic (mandatory) record info to look for
605         $record = array(
606             'backupid' => $restoreid,
607             'itemname' => $itemname,
608             'itemid'   => $itemid
609         );
610         // TODO: Analyze if some static (and limited) cache by the 3 params could save us a bunch of get_record() calls
611         if ($dbrec = $DB->get_record('backup_ids_temp', $record)) {
612             if ($dbrec->info != null) {
613                 $dbrec->info = unserialize(base64_decode($dbrec->info));
614             }
615         }
616         return $dbrec;
617     }
620 /*
621  * Exception class used by all the @dbops stuff
622  */
623 class restore_dbops_exception extends backup_exception {
625     public function __construct($errorcode, $a=NULL, $debuginfo=null) {
626         parent::__construct($errorcode, 'error', '', $a, null, $debuginfo);
627     }