Merge branch 'MDL-37761-m' of git://github.com/andrewnicols/moodle
[moodle.git] / backup / util / dbops / backup_controller_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  * Non instantiable helper class providing DB support to the @backup_controller
27  *
28  * This class contains various static methods available for all the DB operations
29  * performed by the backup_controller class
30  *
31  * TODO: Finish phpdocs
32  */
33 abstract class backup_controller_dbops extends backup_dbops {
35     /**
36      * Send one backup controller to DB
37      *
38      * @param backup_controller $controller controller to send to DB
39      * @param string $checksum hash of the controller to be checked
40      * @param bool $includeobj to decide if the object itself must be updated (true) or no (false)
41      * @param bool $cleanobj to decide if the object itself must be cleaned (true) or no (false)
42      * @return int id of the controller record in the DB
43      * @throws backup_controller_exception|backup_dbops_exception
44      */
45     public static function save_controller($controller, $checksum, $includeobj = true, $cleanobj = false) {
46         global $DB;
47         // Check we are going to save one backup_controller
48         if (! $controller instanceof backup_controller) {
49             throw new backup_controller_exception('backup_controller_expected');
50         }
51         // Check checksum is ok. Only if we are including object info. Sounds silly but it isn't ;-).
52         if ($includeobj and !$controller->is_checksum_correct($checksum)) {
53             throw new backup_dbops_exception('backup_controller_dbops_saving_checksum_mismatch');
54         }
55         // Cannot request to $includeobj and $cleanobj at the same time.
56         if ($includeobj and $cleanobj) {
57             throw new backup_dbops_exception('backup_controller_dbops_saving_cannot_include_and_delete');
58         }
59         // Get all the columns
60         $rec = new stdclass();
61         $rec->backupid     = $controller->get_backupid();
62         $rec->operation    = $controller->get_operation();
63         $rec->type         = $controller->get_type();
64         $rec->itemid       = $controller->get_id();
65         $rec->format       = $controller->get_format();
66         $rec->interactive  = $controller->get_interactive();
67         $rec->purpose      = $controller->get_mode();
68         $rec->userid       = $controller->get_userid();
69         $rec->status       = $controller->get_status();
70         $rec->execution    = $controller->get_execution();
71         $rec->executiontime= $controller->get_executiontime();
72         $rec->checksum     = $checksum;
73         // Serialize information
74         if ($includeobj) {
75             $rec->controller = base64_encode(serialize($controller));
76         } else if ($cleanobj) {
77             $rec->controller = '';
78         }
79         // Send it to DB
80         if ($recexists = $DB->get_record('backup_controllers', array('backupid' => $rec->backupid))) {
81             $rec->id = $recexists->id;
82             $rec->timemodified = time();
83             $DB->update_record('backup_controllers', $rec);
84         } else {
85             $rec->timecreated = time();
86             $rec->timemodified = 0;
87             $rec->id = $DB->insert_record('backup_controllers', $rec);
88         }
89         return $rec->id;
90     }
92     public static function load_controller($backupid) {
93         global $DB;
94         if (! $controllerrec = $DB->get_record('backup_controllers', array('backupid' => $backupid))) {
95             throw new backup_dbops_exception('backup_controller_dbops_nonexisting');
96         }
97         $controller = unserialize(base64_decode($controllerrec->controller));
98         // Check checksum is ok. Sounds silly but it isn't ;-)
99         if (!$controller->is_checksum_correct($controllerrec->checksum)) {
100             throw new backup_dbops_exception('backup_controller_dbops_loading_checksum_mismatch');
101         }
102         return $controller;
103     }
105     public static function create_backup_ids_temp_table($backupid) {
106         global $CFG, $DB;
107         $dbman = $DB->get_manager(); // We are going to use database_manager services
109         $xmldb_table = new xmldb_table('backup_ids_temp');
110         $xmldb_table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
111         // Set default backupid (not needed but this enforce any missing backupid). That's hackery in action!
112         $xmldb_table->add_field('backupid', XMLDB_TYPE_CHAR, 32, null, XMLDB_NOTNULL, null, $backupid);
113         $xmldb_table->add_field('itemname', XMLDB_TYPE_CHAR, 160, null, XMLDB_NOTNULL, null, null);
114         $xmldb_table->add_field('itemid', XMLDB_TYPE_INTEGER, 10, null, XMLDB_NOTNULL, null, null);
115         $xmldb_table->add_field('newitemid', XMLDB_TYPE_INTEGER, 10, null, XMLDB_NOTNULL, null, '0');
116         $xmldb_table->add_field('parentitemid', XMLDB_TYPE_INTEGER, 10, null, null, null, '0');
117         $xmldb_table->add_field('info', XMLDB_TYPE_TEXT, 1333, null, null, null, null);
118         $xmldb_table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
119         $xmldb_table->add_key('backupid_itemname_itemid_uk', XMLDB_KEY_UNIQUE, array('backupid','itemname','itemid'));
120         $xmldb_table->add_index('backupid_parentitemid_ix', null, array('backupid','itemname','parentitemid'));
121         $xmldb_table->add_index('backupid_itemname_newitemid_ix', null, array('backupid','itemname','newitemid'));
123         $dbman->create_temp_table($xmldb_table); // And create it
125     }
127     public static function create_backup_files_temp_table($backupid) {
128         global $CFG, $DB;
129         $dbman = $DB->get_manager(); // We are going to use database_manager services
131         $xmldb_table = new xmldb_table('backup_files_temp');
132         $xmldb_table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
133         // Set default backupid (not needed but this enforce any missing backupid). That's hackery in action!
134         $xmldb_table->add_field('backupid', XMLDB_TYPE_CHAR, 32, null, XMLDB_NOTNULL, null, $backupid);
135         $xmldb_table->add_field('contextid', XMLDB_TYPE_INTEGER, 10, null, XMLDB_NOTNULL, null, null);
136         $xmldb_table->add_field('component', XMLDB_TYPE_CHAR, 100, null, XMLDB_NOTNULL, null, null);
137         $xmldb_table->add_field('filearea', XMLDB_TYPE_CHAR, 50, null, XMLDB_NOTNULL, null, null);
138         $xmldb_table->add_field('itemid', XMLDB_TYPE_INTEGER, 10, null, XMLDB_NOTNULL, null, null);
139         $xmldb_table->add_field('info', XMLDB_TYPE_TEXT, 1333, null, null, null, null);
140         $xmldb_table->add_field('newcontextid', XMLDB_TYPE_INTEGER, 10, null, null, null, '0');
141         $xmldb_table->add_field('newitemid', XMLDB_TYPE_INTEGER, 10, null, null, null, '0');
142         $xmldb_table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
143         $xmldb_table->add_index('backupid_contextid_component_filearea_itemid_ix', null, array('backupid','contextid','component','filearea','itemid'));
145         $dbman->create_temp_table($xmldb_table); // And create it
146     }
148     public static function drop_backup_ids_temp_table($backupid) {
149         global $DB;
150         $dbman = $DB->get_manager(); // We are going to use database_manager services
152         $targettablename = 'backup_ids_temp';
153         $table = new xmldb_table($targettablename);
154         $dbman->drop_table($table); // And drop it
155     }
157     /**
158      * Given one type and id from controller, return the corresponding courseid
159      */
160     public static function get_courseid_from_type_id($type, $id) {
161         global $DB;
162         if ($type == backup::TYPE_1COURSE) {
163             return $id; // id is the course id
165         } else if ($type == backup::TYPE_1SECTION) {
166             if (! $courseid = $DB->get_field('course_sections', 'course', array('id' => $id))) {
167                 throw new backup_dbops_exception('course_not_found_for_section', $id);
168             }
169             return $courseid;
170         } else if ($type == backup::TYPE_1ACTIVITY) {
171             if (! $courseid = $DB->get_field('course_modules', 'course', array('id' => $id))) {
172                 throw new backup_dbops_exception('course_not_found_for_moduleid', $id);
173             }
174             return $courseid;
175         }
176     }
178     /**
179      * Given one activity task, return the activity information and related settings
180      * Used by get_moodle_backup_information()
181      */
182     private static function get_activity_backup_information($task) {
184         $contentinfo = array(
185             'moduleid'   => $task->get_moduleid(),
186             'sectionid'  => $task->get_sectionid(),
187             'modulename' => $task->get_modulename(),
188             'title'      => $task->get_name(),
189             'directory'  => 'activities/' . $task->get_modulename() . '_' . $task->get_moduleid());
191         // Now get activity settings
192         // Calculate prefix to find valid settings
193         $prefix = basename($contentinfo['directory']);
194         $settingsinfo = array();
195         foreach ($task->get_settings() as $setting) {
196             // Discard ones without valid prefix
197             if (strpos($setting->get_name(), $prefix) !== 0) {
198                 continue;
199             }
200             // Validate level is correct (activity)
201             if ($setting->get_level() != backup_setting::ACTIVITY_LEVEL) {
202                 throw new backup_controller_exception('setting_not_activity_level', $setting);
203             }
204             $settinginfo = array(
205                 'level'    => 'activity',
206                 'activity' => $prefix,
207                 'name'     => $setting->get_name(),
208                 'value'    => $setting->get_value());
209             $settingsinfo[$setting->get_name()] = (object)$settinginfo;
210         }
211         return array($contentinfo, $settingsinfo);
212     }
214     /**
215      * Given one section task, return the section information and related settings
216      * Used by get_moodle_backup_information()
217      */
218     private static function get_section_backup_information($task) {
220         $contentinfo = array(
221             'sectionid'  => $task->get_sectionid(),
222             'title'      => $task->get_name(),
223             'directory'  => 'sections/' . 'section_' . $task->get_sectionid());
225         // Now get section settings
226         // Calculate prefix to find valid settings
227         $prefix = basename($contentinfo['directory']);
228         $settingsinfo = array();
229         foreach ($task->get_settings() as $setting) {
230             // Discard ones without valid prefix
231             if (strpos($setting->get_name(), $prefix) !== 0) {
232                 continue;
233             }
234             // Validate level is correct (section)
235             if ($setting->get_level() != backup_setting::SECTION_LEVEL) {
236                 throw new backup_controller_exception('setting_not_section_level', $setting);
237             }
238             $settinginfo = array(
239                 'level'    => 'section',
240                 'section'  => $prefix,
241                 'name'     => $setting->get_name(),
242                 'value'    => $setting->get_value());
243             $settingsinfo[$setting->get_name()] = (object)$settinginfo;
244         }
245         return array($contentinfo, $settingsinfo);
246     }
248     /**
249      * Given one course task, return the course information and related settings
250      * Used by get_moodle_backup_information()
251      */
252     private static function get_course_backup_information($task) {
254         $contentinfo = array(
255             'courseid'   => $task->get_courseid(),
256             'title'      => $task->get_name(),
257             'directory'  => 'course');
259         // Now get course settings
260         // Calculate prefix to find valid settings
261         $prefix = basename($contentinfo['directory']);
262         $settingsinfo = array();
263         foreach ($task->get_settings() as $setting) {
264             // Discard ones without valid prefix
265             if (strpos($setting->get_name(), $prefix) !== 0) {
266                 continue;
267             }
268             // Validate level is correct (course)
269             if ($setting->get_level() != backup_setting::COURSE_LEVEL) {
270                 throw new backup_controller_exception('setting_not_course_level', $setting);
271             }
272             $settinginfo = array(
273                 'level'    => 'course',
274                 'name'     => $setting->get_name(),
275                 'value'    => $setting->get_value());
276             $settingsinfo[$setting->get_name()] = (object)$settinginfo;
277         }
278         return array($contentinfo, $settingsinfo);
279     }
281     /**
282      * Given one root task, return the course information and related settings
283      * Used by get_moodle_backup_information()
284      */
285     private static function get_root_backup_information($task) {
287         // Now get root settings
288         $settingsinfo = array();
289         foreach ($task->get_settings() as $setting) {
290             // Validate level is correct (root)
291             if ($setting->get_level() != backup_setting::ROOT_LEVEL) {
292                 throw new backup_controller_exception('setting_not_root_level', $setting);
293             }
294             $settinginfo = array(
295                 'level'    => 'root',
296                 'name'     => $setting->get_name(),
297                 'value'    => $setting->get_value());
298             $settingsinfo[$setting->get_name()] = (object)$settinginfo;
299         }
300         return array(null, $settingsinfo);
301     }
303     /**
304      * Get details information for main moodle_backup.xml file, extracting it from
305      * the specified controller
306      */
307     public static function get_moodle_backup_information($backupid) {
309         $detailsinfo = array(); // Information details
310         $contentsinfo= array(); // Information about backup contents
311         $settingsinfo= array(); // Information about backup settings
312         $bc = self::load_controller($backupid); // Load controller
314         // Details info
315         $detailsinfo['id'] = $bc->get_id();
316         $detailsinfo['backup_id'] = $bc->get_backupid();
317         $detailsinfo['type'] = $bc->get_type();
318         $detailsinfo['format'] = $bc->get_format();
319         $detailsinfo['interactive'] = $bc->get_interactive();
320         $detailsinfo['mode'] = $bc->get_mode();
321         $detailsinfo['execution'] = $bc->get_execution();
322         $detailsinfo['executiontime'] = $bc->get_executiontime();
323         $detailsinfo['userid'] = $bc->get_userid();
324         $detailsinfo['courseid'] = $bc->get_courseid();
327         // Init content placeholders
328         $contentsinfo['activities'] = array();
329         $contentsinfo['sections']   = array();
330         $contentsinfo['course']     = array();
332         // Contents info (extract information from tasks)
333         foreach ($bc->get_plan()->get_tasks() as $task) {
335             if ($task instanceof backup_activity_task) { // Activity task
337                 if ($task->get_setting_value('included')) { // Only return info about included activities
338                     list($contentinfo, $settings) = self::get_activity_backup_information($task);
339                     $contentsinfo['activities'][] = $contentinfo;
340                     $settingsinfo = array_merge($settingsinfo, $settings);
341                 }
343             } else if ($task instanceof backup_section_task) { // Section task
345                 if ($task->get_setting_value('included')) { // Only return info about included sections
346                     list($contentinfo, $settings) = self::get_section_backup_information($task);
347                     $contentsinfo['sections'][] = $contentinfo;
348                     $settingsinfo = array_merge($settingsinfo, $settings);
349                 }
351             } else if ($task instanceof backup_course_task) { // Course task
353                 list($contentinfo, $settings) = self::get_course_backup_information($task);
354                 $contentsinfo['course'][] = $contentinfo;
355                 $settingsinfo = array_merge($settingsinfo, $settings);
357             } else if ($task instanceof backup_root_task) { // Root task
359                 list($contentinfo, $settings) = self::get_root_backup_information($task);
360                 $settingsinfo = array_merge($settingsinfo, $settings);
361             }
362         }
364         $bc->destroy(); // Always need to destroy controller to handle circular references
366         return array(array((object)$detailsinfo), $contentsinfo, $settingsinfo);
367     }
369     /**
370      * Update CFG->backup_version and CFG->backup_release if change in
371      * version is detected.
372      */
373     public static function apply_version_and_release() {
374         global $CFG;
376         if ($CFG->backup_version < backup::VERSION) {
377             set_config('backup_version', backup::VERSION);
378             set_config('backup_release', backup::RELEASE);
379         }
380     }
382     /**
383      * Given the backupid, detect if the backup includes "mnet" remote users or no
384      */
385     public static function backup_includes_mnet_remote_users($backupid) {
386         global $CFG, $DB;
388         $sql = "SELECT COUNT(*)
389                   FROM {backup_ids_temp} b
390                   JOIN {user} u ON u.id = b.itemid
391                  WHERE b.backupid = ?
392                    AND b.itemname = 'userfinal'
393                    AND u.mnethostid != ?";
394         $count = $DB->count_records_sql($sql, array($backupid, $CFG->mnet_localhost_id));
395         return (int)(bool)$count;
396     }
398     /**
399      * Given the backupid, determine whether this backup should include
400      * files from the moodle file storage system.
401      *
402      * @param string $backupid The ID of the backup.
403      * @return int Indicates whether files should be included in backups.
404      */
405     public static function backup_includes_files($backupid) {
406         // Load controller
407         $bc = self::load_controller($backupid);
408         return $bc->get_include_files();
409     }
411     /**
412      * Given the backupid, detect if the backup contains references to external contents
413      *
414      * @copyright 2012 Dongsheng Cai {@link http://dongsheng.org}
415      * @return int
416      */
417     public static function backup_includes_file_references($backupid) {
418         global $CFG, $DB;
420         $sql = "SELECT count(r.repositoryid)
421                   FROM {files} f
422                   LEFT JOIN {files_reference} r
423                        ON r.id = f.referencefileid
424                   JOIN {backup_ids_temp} bi
425                        ON f.id = bi.itemid
426                  WHERE bi.backupid = ?
427                        AND bi.itemname = 'filefinal'";
428         $count = $DB->count_records_sql($sql, array($backupid));
429         return (int)(bool)$count;
430     }
432     /**
433      * Given the courseid, return some course related information we want to transport
434      *
435      * @param int $course the id of the course this backup belongs to
436      */
437     public static function backup_get_original_course_info($courseid) {
438         global $DB;
439         return $DB->get_record('course', array('id' => $courseid), 'fullname, shortname, startdate');
440     }
442     /**
443      * Sets the default values for the settings in a backup operation
444      *
445      * Based on the mode of the backup it will delegate the process to
446      * other methods like {@link apply_general_config_defaults} ...
447      * to get proper defaults loaded
448      *
449      * @param backup_controller $controller
450      */
451     public static function apply_config_defaults(backup_controller $controller) {
452         // Based on the mode of the backup (general, automated, import, hub...)
453         // decide the action to perform to get defaults loaded
454         $mode = $controller->get_mode();
456         switch ($mode) {
457             case backup::MODE_GENERAL:
458                 // Load the general defaults
459                 self::apply_general_config_defaults($controller);
460                 break;
461             case backup::MODE_AUTOMATED:
462                 // TODO: Move the loading from automatic stuff to here
463                 break;
464             default:
465                 // Nothing to do for other modes (IMPORT/HUB...). Some day we
466                 // can define defaults (admin UI...) for them if we want to
467         }
468     }
470     /**
471      * Sets the controller settings default values from the backup config.
472      *
473      * @param backup_controller $controller
474      */
475     private static function apply_general_config_defaults(backup_controller $controller) {
476         $settings = array(
477             // Config name                      => Setting name
478             'backup_general_users'              => 'users',
479             'backup_general_anonymize'          => 'anonymize',
480             'backup_general_role_assignments'   => 'role_assignments',
481             'backup_general_activities'         => 'activities',
482             'backup_general_blocks'             => 'blocks',
483             'backup_general_filters'            => 'filters',
484             'backup_general_comments'           => 'comments',
485             'backup_general_userscompletion'    => 'userscompletion',
486             'backup_general_logs'               => 'logs',
487             'backup_general_histories'          => 'grade_histories'
488         );
489         $plan = $controller->get_plan();
490         foreach ($settings as $config=>$settingname) {
491             $value = get_config('backup', $config);
492             $locked = (get_config('backup', $config.'_locked') == true);
493             if ($plan->setting_exists($settingname)) {
494                 $setting = $plan->get_setting($settingname);
495                 if ($setting->get_value() != $value || 1==1) {
496                     $setting->set_value($value);
497                     if ($locked) {
498                         $setting->set_status(base_setting::LOCKED_BY_CONFIG);
499                     }
500                 }
501             }
502         }
503     }