Merge branch 'MDL-62572-master' of git://github.com/damyon/moodle
[moodle.git] / backup / controller / backup_controller.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-controller
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  * Class implementing the controller of any backup process
27  *
28  * This final class is in charge of controlling all the backup architecture, for any
29  * type of backup. Based in type, format, interactivity and target, it stores the
30  * whole execution plan and settings that will be used later by the @backup_worker,
31  * applies all the defaults, performs all the security contraints and is in charge
32  * of handling the ui if necessary. Also logging strategy is defined here.
33  *
34  * Note the class is 100% neutral and usable for *any* backup. It just stores/requests
35  * all the needed information from other backup classes in order to have everything well
36  * structured in order to allow the @backup_worker classes to do their job.
37  *
38  * In other words, a mammoth class, but don't worry, practically everything is delegated/
39  * aggregated!)
40  *
41  * TODO: Finish phpdocs
42  */
43 class backup_controller extends base_controller {
45     protected $backupid; // Unique identificator for this backup
47     protected $type;   // Type of backup (activity, section, course)
48     protected $id;     // Course/section/course_module id to backup
49     protected $courseid; // courseid where the id belongs to
50     protected $format; // Format of backup (moodle, imscc)
51     protected $interactive; // yes/no
52     protected $mode;   // Purpose of the backup (default settings)
53     protected $userid; // user id executing the backup
54     protected $operation; // Type of operation (backup/restore)
56     protected $status; // Current status of the controller (created, planned, configured...)
58     protected $plan;   // Backup execution plan
59     protected $includefiles; // Whether this backup includes files or not.
61     /**
62      * Immediate/delayed execution type.
63      * @var integer
64      */
65     protected $execution;
66     protected $executiontime; // epoch time when we want the backup to be executed (requires cron to run)
68     protected $destination; // Destination chain object (fs_moodle, fs_os, db, email...)
70     protected $checksum; // Cache @checksumable results for lighter @is_checksum_correct() uses
72     /**
73      * Constructor for the backup controller class.
74      *
75      * @param int $type Type of the backup; One of backup::TYPE_1COURSE, TYPE_1SECTION, TYPE_1ACTIVITY
76      * @param int $id The ID of the item to backup; e.g the course id
77      * @param int $format The backup format to use; Most likely backup::FORMAT_MOODLE
78      * @param bool $interactive Whether this backup will require user interaction; backup::INTERACTIVE_YES or INTERACTIVE_NO
79      * @param int $mode One of backup::MODE_GENERAL, MODE_IMPORT, MODE_SAMESITE, MODE_HUB, MODE_AUTOMATED
80      * @param int $userid The id of the user making the backup
81      */
82     public function __construct($type, $id, $format, $interactive, $mode, $userid){
83         $this->type = $type;
84         $this->id   = $id;
85         $this->courseid = backup_controller_dbops::get_courseid_from_type_id($this->type, $this->id);
86         $this->format = $format;
87         $this->interactive = $interactive;
88         $this->mode = $mode;
89         $this->userid = $userid;
91         // Apply some defaults
92         $this->operation = backup::OPERATION_BACKUP;
93         $this->executiontime = 0;
94         $this->checksum = '';
96         // Set execution based on backup mode.
97         if ($mode == backup::MODE_ASYNC) {
98             $this->execution = backup::EXECUTION_DELAYED;
99         } else {
100             $this->execution = backup::EXECUTION_INMEDIATE;
101         }
103         // Apply current backup version and release if necessary
104         backup_controller_dbops::apply_version_and_release();
106         // Check format and type are correct
107         backup_check::check_format_and_type($this->format, $this->type);
109         // Check id is correct
110         backup_check::check_id($this->type, $this->id);
112         // Check user is correct
113         backup_check::check_user($this->userid);
115         // Calculate unique $backupid
116         $this->calculate_backupid();
118         // Default logger chain (based on interactive/execution)
119         $this->logger = backup_factory::get_logger_chain($this->interactive, $this->execution, $this->backupid);
121         // By default there is no progress reporter. Interfaces that wish to
122         // display progress must set it.
123         $this->progress = new \core\progress\none();
125         // Instantiate the output_controller singleton and active it if interactive and immediate.
126         $oc = output_controller::get_instance();
127         if ($this->interactive == backup::INTERACTIVE_YES && $this->execution == backup::EXECUTION_INMEDIATE) {
128             $oc->set_active(true);
129         }
131         $this->log('instantiating backup controller', backup::LOG_INFO, $this->backupid);
133         // Default destination chain (based on type/mode/execution)
134         $this->destination = backup_factory::get_destination_chain($this->type, $this->id, $this->mode, $this->execution);
136         // Set initial status
137         $this->set_status(backup::STATUS_CREATED);
139         // Load plan (based on type/format)
140         $this->load_plan();
142         // Apply all default settings (based on type/format/mode)
143         $this->apply_defaults();
145         // Perform all initial security checks and apply (2nd param) them to settings automatically
146         backup_check::check_security($this, true);
148         // Set status based on interactivity
149         if ($this->interactive == backup::INTERACTIVE_YES) {
150             $this->set_status(backup::STATUS_SETTING_UI);
151         } else {
152             $this->set_status(backup::STATUS_AWAITING);
153         }
154     }
156     /**
157      * Clean structures used by the backup_controller
158      *
159      * This method clean various structures used by the backup_controller,
160      * destroying them in an ordered way, so their memory will be gc properly
161      * by PHP (mainly circular references).
162      *
163      * Note that, while it's not mandatory to execute this method, it's highly
164      * recommended to do so, specially in scripts performing multiple operations
165      * (like the automated backups) or the system will run out of memory after
166      * a few dozens of backups)
167      */
168     public function destroy() {
169         // Only need to destroy circulars under the plan. Delegate to it.
170         $this->plan->destroy();
171         // Loggers may have also chained references, destroy them. Also closing resources when needed.
172         $this->logger->destroy();
173     }
175     public function finish_ui() {
176         if ($this->status != backup::STATUS_SETTING_UI) {
177             throw new backup_controller_exception('cannot_finish_ui_if_not_setting_ui');
178         }
179         $this->set_status(backup::STATUS_AWAITING);
180     }
182     public function process_ui_event() {
184         // Perform security checks throwing exceptions (2nd param) if something is wrong
185         backup_check::check_security($this, false);
186     }
188     public function set_status($status) {
189         // Note: never save_controller() with the object info after STATUS_EXECUTING or the whole controller,
190         // containing all the steps will be sent to DB. 100% (monster) useless.
191         $this->log('setting controller status to', backup::LOG_DEBUG, $status);
192         // TODO: Check it's a correct status.
193         $this->status = $status;
194         // Ensure that, once set to backup::STATUS_AWAITING, controller is stored in DB.
195         // Also save if executing so we can better track progress.
196         if ($status == backup::STATUS_AWAITING || $status == backup::STATUS_EXECUTING) {
197             $this->save_controller();
198             $tbc = self::load_controller($this->backupid);
199             $this->logger = $tbc->logger; // wakeup loggers
200             $tbc->plan->destroy(); // Clean plan controller structures, keeping logger alive.
202         } else if ($status == backup::STATUS_FINISHED_OK) {
203             // If the operation has ended without error (backup::STATUS_FINISHED_OK)
204             // proceed by cleaning the object from database. MDL-29262.
205             $this->save_controller(false, true);
206         } else if ($status == backup::STATUS_FINISHED_ERR) {
207             // If the operation has ended with an error save the controller
208             // preserving the object in the database. We may want it for debugging.
209             $this->save_controller();
210         }
211     }
213     public function set_execution($execution, $executiontime = 0) {
214         $this->log('setting controller execution', backup::LOG_DEBUG);
215         // TODO: Check valid execution mode.
216         // TODO: Check time in future.
217         // TODO: Check time = 0 if immediate.
218         $this->execution = $execution;
219         $this->executiontime = $executiontime;
221         // Default destination chain (based on type/mode/execution)
222         $this->destination = backup_factory::get_destination_chain($this->type, $this->id, $this->mode, $this->execution);
224         // Default logger chain (based on interactive/execution)
225         $this->logger = backup_factory::get_logger_chain($this->interactive, $this->execution, $this->backupid);
226     }
228 // checksumable interface methods
230     public function calculate_checksum() {
231         // Reset current checksum to take it out from calculations!
232         $this->checksum = '';
233         // Init checksum
234         $tempchecksum = md5('backupid-'   . $this->backupid .
235                             'type-'       . $this->type .
236                             'id-'         . $this->id .
237                             'format-'     . $this->format .
238                             'interactive-'. $this->interactive .
239                             'mode-'       . $this->mode .
240                             'userid-'     . $this->userid .
241                             'operation-'  . $this->operation .
242                             'status-'     . $this->status .
243                             'execution-'  . $this->execution .
244                             'plan-'       . backup_general_helper::array_checksum_recursive(array($this->plan)) .
245                             'destination-'. backup_general_helper::array_checksum_recursive(array($this->destination)) .
246                             'logger-'     . backup_general_helper::array_checksum_recursive(array($this->logger)));
247         $this->log('calculating controller checksum', backup::LOG_DEBUG, $tempchecksum);
248         return $tempchecksum;
249     }
251     public function is_checksum_correct($checksum) {
252         return $this->checksum === $checksum;
253     }
255     public function get_backupid() {
256         return $this->backupid;
257     }
259     public function get_type() {
260         return $this->type;
261     }
263     /**
264      * Returns the current value of the include_files setting.
265      * This setting is intended to ensure that files are not included in
266      * generated backups.
267      *
268      * @return int Indicates whether files should be included in backups.
269      */
270     public function get_include_files() {
271         return $this->includefiles;
272     }
274     public function get_operation() {
275         return $this->operation;
276     }
278     public function get_id() {
279         return $this->id;
280     }
282     public function get_courseid() {
283         return $this->courseid;
284     }
286     public function get_format() {
287         return $this->format;
288     }
290     public function get_interactive() {
291         return $this->interactive;
292     }
294     public function get_mode() {
295         return $this->mode;
296     }
298     public function get_userid() {
299         return $this->userid;
300     }
302     public function get_status() {
303         return $this->status;
304     }
306     public function get_execution() {
307         return $this->execution;
308     }
310     public function get_executiontime() {
311         return $this->executiontime;
312     }
314     /**
315      * @return backup_plan
316      */
317     public function get_plan() {
318         return $this->plan;
319     }
321     /**
322      * Executes the backup
323      * @return void Throws and exception of completes
324      */
325     public function execute_plan() {
326         // Basic/initial prevention against time/memory limits
327         core_php_time_limit::raise(1 * 60 * 60); // 1 hour for 1 course initially granted
328         raise_memory_limit(MEMORY_EXTRA);
329         // If this is not a course backup, or single activity backup (e.g. duplicate) inform the plan we are not
330         // including all the activities for sure. This will affect any
331         // task/step executed conditionally to stop including information
332         // for section and activity backup. MDL-28180.
333         if ($this->get_type() !== backup::TYPE_1COURSE && $this->get_type() !== backup::TYPE_1ACTIVITY) {
334             $this->log('notifying plan about excluded activities by type', backup::LOG_DEBUG);
335             $this->plan->set_excluding_activities();
336         }
337         return $this->plan->execute();
338     }
340     public function get_results() {
341         return $this->plan->get_results();
342     }
344     /**
345      * Save controller information
346      *
347      * @param bool $includeobj to decide if the object itself must be updated (true) or no (false)
348      * @param bool $cleanobj to decide if the object itself must be cleaned (true) or no (false)
349      */
350     public function save_controller($includeobj = true, $cleanobj = false) {
351         // Going to save controller to persistent storage, calculate checksum for later checks and save it.
352         // TODO: flag the controller as NA. Any operation on it should be forbidden until loaded back.
353         $this->log('saving controller to db', backup::LOG_DEBUG);
354         if ($includeobj ) {  // Only calculate checksum if we are going to include the object.
355             $this->checksum = $this->calculate_checksum();
356         }
357         backup_controller_dbops::save_controller($this, $this->checksum, $includeobj, $cleanobj);
358     }
360     public static function load_controller($backupid) {
361         // Load controller from persistent storage
362         // TODO: flag the controller as available. Operations on it can continue
363         $controller = backup_controller_dbops::load_controller($backupid);
364         $controller->log('loading controller from db', backup::LOG_DEBUG);
365         return $controller;
366     }
368 // Protected API starts here
370     protected function calculate_backupid() {
371         // Current epoch time + type + id + format + interactive + mode + userid + operation
372         // should be unique enough. Add one random part at the end
373         $this->backupid = md5(time() . '-' . $this->type . '-' . $this->id . '-' . $this->format . '-' .
374                               $this->interactive . '-' . $this->mode . '-' . $this->userid . '-' .
375                               $this->operation . '-' . random_string(20));
376     }
378     protected function load_plan() {
379         $this->log('loading controller plan', backup::LOG_DEBUG);
380         $this->plan = new backup_plan($this);
381         $this->plan->build(); // Build plan for this controller
382         $this->set_status(backup::STATUS_PLANNED);
383     }
385     protected function apply_defaults() {
386         $this->log('applying plan defaults', backup::LOG_DEBUG);
387         backup_controller_dbops::apply_config_defaults($this);
388         $this->set_status(backup::STATUS_CONFIGURED);
389         $this->set_include_files();
390     }
392     /**
393      * Set the initial value for the include_files setting.
394      *
395      * @see backup_controller::get_include_files for further information on the purpose of this setting.
396      * @return int Indicates whether files should be included in backups.
397      */
398     protected function set_include_files() {
399         // We normally include files.
400         $includefiles = true;
402         // In an import, we don't need to include files.
403         if ($this->get_mode() === backup::MODE_IMPORT) {
404             $includefiles = false;
405         }
407         // When a backup is intended for the same site, we don't need to include the files.
408         // Note, this setting is only used for duplication of an entire course.
409         if ($this->get_mode() === backup::MODE_SAMESITE) {
410             $includefiles = false;
411         }
413         $this->includefiles = (int) $includefiles;
414         $this->log("setting file inclusion to {$this->includefiles}", backup::LOG_DEBUG);
415         return $this->includefiles;
416     }
420 /*
421  * Exception class used by all the @backup_controller stuff
422  */
423 class backup_controller_exception extends backup_exception {
425     public function __construct($errorcode, $a=NULL, $debuginfo=null) {
426         parent::__construct($errorcode, $a, $debuginfo);
427     }