MDL-23752 backup - export/import mode. Fixed various details.
[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
785d6603
SH
32 /**
33 *
34 * @var restore_controller
35 */
b5d45a04
EL
36 protected $controller; // The restore controller building/executing this plan
37 protected $basepath; // Fullpath to dir where backup is available
482aac65 38 protected $preloaded; // When executing the plan, do we have preloaded (from checks) info
03307846 39 protected $decoder; // restore_decode_processor in charge of decoding all the interlinks
58328ce8
EL
40 protected $missingmodules; // to flag if restore has detected some missing module
41 protected $excludingdactivities; // to flag if restore settings are excluding any activity
b5d45a04
EL
42
43 /**
44 * Constructor - instantiates one object of this class
45 */
46 public function __construct($controller) {
47 global $CFG;
48
49 if (! $controller instanceof restore_controller) {
50 throw new restore_plan_exception('wrong_restore_controller_specified');
51 }
52 $this->controller = $controller;
c9d8234a 53 $this->basepath = $CFG->dataroot . '/temp/backup/' . $controller->get_tempdir();
482aac65 54 $this->preloaded = false;
03307846 55 $this->decoder = new restore_decode_processor($this->get_restoreid(), $this->get_info()->original_wwwroot, $CFG->wwwroot);
58328ce8
EL
56 $this->missingmodules = false;
57 $this->excludingdactivities = false;
58
b5d45a04
EL
59 parent::__construct('restore_plan');
60 }
61
62 public function build() {
63 restore_plan_builder::build_plan($this->controller); // We are moodle2 always, go straight to builder
03307846 64 restore_decode_processor::register_link_decoders($this->decoder); // Add decoder contents and rules
b5d45a04
EL
65 $this->built = true;
66 }
67
68 public function get_restoreid() {
69 return $this->controller->get_restoreid();
70 }
71
72 public function get_courseid() {
73 return $this->controller->get_courseid();
74 }
75
dc1e4cce
EL
76 public function get_mode() {
77 return $this->controller->get_mode();
78 }
79
b5d45a04
EL
80 public function get_basepath() {
81 return $this->basepath;
82 }
83
84 public function get_logger() {
85 return $this->controller->get_logger();
86 }
87
c9d8234a
EL
88 public function get_info() {
89 return $this->controller->get_info();
90 }
91
a4e13312
EL
92 public function get_target() {
93 return $this->controller->get_target();
94 }
95
482aac65
EL
96 public function get_userid() {
97 return $this->controller->get_userid();
98 }
99
03307846
EL
100 public function get_decoder() {
101 return $this->decoder;
102 }
103
482aac65
EL
104 public function is_samesite() {
105 return $this->controller->is_samesite();
106 }
107
58328ce8
EL
108 public function is_missing_modules() {
109 return $this->missingmodules;
110 }
111
112 public function is_excluding_activities() {
113 return $this->excludingdactivities;
114 }
115
482aac65
EL
116 public function set_preloaded_information() {
117 $this->preloaded = true;
118 }
119
120 public function get_preloaded_information() {
121 return $this->preloaded;
122 }
123
b1eaf633
EL
124 public function get_tempdir() {
125 return $this->controller->get_tempdir();
126 }
127
58328ce8
EL
128 public function set_missing_modules() {
129 $this->missingmodules = true;
130 }
131
132 public function set_excluding_activities() {
133 $this->excludingdactivities = true;
134 }
135
b5d45a04
EL
136 public function log($message, $level, $a = null, $depth = null, $display = false) {
137 backup_helper::log($message, $level, $a, $depth, $display, $this->get_logger());
138 }
139
140 /**
141 * Function responsible for executing the tasks of any plan
142 */
143 public function execute() {
144 if ($this->controller->get_status() != backup::STATUS_AWAITING) {
145 throw new restore_controller_exception('restore_not_executable_awaiting_required', $this->controller->get_status());
146 }
147 $this->controller->set_status(backup::STATUS_EXECUTING);
148 parent::execute();
149 $this->controller->set_status(backup::STATUS_FINISHED_OK);
150 }
151}
152
153/*
154 * Exception class used by all the @restore_plan stuff
155 */
156class restore_plan_exception extends base_plan_exception {
157
158 public function __construct($errorcode, $a=NULL, $debuginfo=null) {
159 parent::__construct($errorcode, $a, $debuginfo);
160 }
161}