MDL-23474 user password hashing - removed unnecessary user record update, improved...
[moodle.git] / backup / util / plan / restore_plan.class.php
CommitLineData
b5d45a04
EL
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-plan
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 * Implementable class defining the needed stuf for one restore plan
27 *
28 * TODO: Finish phpdocs
29 */
30class restore_plan extends base_plan implements loggable {
31
32 protected $controller; // The restore controller building/executing this plan
33 protected $basepath; // Fullpath to dir where backup is available
482aac65 34 protected $preloaded; // When executing the plan, do we have preloaded (from checks) info
b5d45a04
EL
35
36 /**
37 * Constructor - instantiates one object of this class
38 */
39 public function __construct($controller) {
40 global $CFG;
41
42 if (! $controller instanceof restore_controller) {
43 throw new restore_plan_exception('wrong_restore_controller_specified');
44 }
45 $this->controller = $controller;
c9d8234a 46 $this->basepath = $CFG->dataroot . '/temp/backup/' . $controller->get_tempdir();
482aac65 47 $this->preloaded = false;
b5d45a04
EL
48 parent::__construct('restore_plan');
49 }
50
51 public function build() {
52 restore_plan_builder::build_plan($this->controller); // We are moodle2 always, go straight to builder
53 $this->built = true;
54 }
55
56 public function get_restoreid() {
57 return $this->controller->get_restoreid();
58 }
59
60 public function get_courseid() {
61 return $this->controller->get_courseid();
62 }
63
64 public function get_basepath() {
65 return $this->basepath;
66 }
67
68 public function get_logger() {
69 return $this->controller->get_logger();
70 }
71
c9d8234a
EL
72 public function get_info() {
73 return $this->controller->get_info();
74 }
75
a4e13312
EL
76 public function get_target() {
77 return $this->controller->get_target();
78 }
79
482aac65
EL
80 public function get_userid() {
81 return $this->controller->get_userid();
82 }
83
84 public function is_samesite() {
85 return $this->controller->is_samesite();
86 }
87
88 public function set_preloaded_information() {
89 $this->preloaded = true;
90 }
91
92 public function get_preloaded_information() {
93 return $this->preloaded;
94 }
95
b5d45a04
EL
96 public function log($message, $level, $a = null, $depth = null, $display = false) {
97 backup_helper::log($message, $level, $a, $depth, $display, $this->get_logger());
98 }
99
100 /**
101 * Function responsible for executing the tasks of any plan
102 */
103 public function execute() {
104 if ($this->controller->get_status() != backup::STATUS_AWAITING) {
105 throw new restore_controller_exception('restore_not_executable_awaiting_required', $this->controller->get_status());
106 }
107 $this->controller->set_status(backup::STATUS_EXECUTING);
108 parent::execute();
109 $this->controller->set_status(backup::STATUS_FINISHED_OK);
110 }
111}
112
113/*
114 * Exception class used by all the @restore_plan stuff
115 */
116class restore_plan_exception extends base_plan_exception {
117
118 public function __construct($errorcode, $a=NULL, $debuginfo=null) {
119 parent::__construct($errorcode, $a, $debuginfo);
120 }
121}