mirrored from git://git.moodle.org/moodle.git
-
Notifications
You must be signed in to change notification settings - Fork 6.6k
/
base_task.class.php
247 lines (216 loc) · 7.68 KB
/
base_task.class.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* @package moodlecore
* @subpackage backup-plan
* @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
/**
* Abstract class defining the basis for one execution (backup/restore) task
*
* TODO: Finish phpdocs
*/
abstract class base_task implements checksumable, executable, loggable {
protected $name; // One simple name for identification purposes
protected $plan; // Plan this is part of
protected $settings; // One array of base_setting elements to define this task
protected $steps; // One array of base_step elements
protected $built; // Flag to know if one task has been built
protected $executed; // Flag to know if one task has been executed
/**
* Constructor - instantiates one object of this class
*/
public function __construct($name, $plan = null) {
if (!is_null($plan) && !($plan instanceof base_plan)) {
throw new base_task_exception('wrong_base_plan_specified');
}
$this->name = $name;
$this->plan = $plan;
$this->settings = array();
$this->steps = array();
$this->built = false;
$this->executed = false;
if (!is_null($plan)) { // Add the task to the plan if specified
$plan->add_task($this);
}
}
public function get_name() {
return $this->name;
}
public function get_steps() {
return $this->steps;
}
public function get_settings() {
return $this->settings;
}
public function get_setting($name) {
// First look in task settings
$result = null;
foreach ($this->settings as $key => $setting) {
if ($setting->get_name() == $name) {
if ($result != null) {
throw new base_task_exception('multiple_settings_by_name_found', $name);
} else {
$result = $setting;
}
}
}
if ($result) {
return $result;
} else {
// Fallback to plan settings
return $this->plan->get_setting($name);
}
}
public function setting_exists($name) {
return $this->plan->setting_exists($name);
}
public function get_setting_value($name) {
return $this->get_setting($name)->get_value();
}
public function get_courseid() {
return $this->plan->get_courseid();
}
public function get_basepath() {
return $this->plan->get_basepath();
}
public function get_taskbasepath() {
return $this->get_basepath();
}
public function get_logger() {
return $this->plan->get_logger();
}
public function log($message, $level, $a = null, $depth = null, $display = false) {
backup_helper::log($message, $level, $a, $depth, $display, $this->get_logger());
}
public function add_step($step) {
if (! $step instanceof base_step) {
throw new base_task_exception('wrong_base_step_specified');
}
// link the step with the task
$step->set_task($this);
$this->steps[] = $step;
}
public function set_plan($plan) {
if (! $plan instanceof base_plan) {
throw new base_task_exception('wrong_base_plan_specified');
}
$this->plan = $plan;
$this->define_settings(); // Settings are defined when plan & task are linked
}
/**
* Function responsible for building the steps of any task
* (must set the $built property to true)
*/
public abstract function build();
/**
* Function responsible for executing the steps of any task
* (setting the $executed property to true)
*/
public function execute() {
if (!$this->built) {
throw new base_task_exception('base_task_not_built', $this->name);
}
if ($this->executed) {
throw new base_task_exception('base_task_already_executed', $this->name);
}
foreach ($this->steps as $step) {
$result = $step->execute();
// If step returns array, it will be forwarded to plan
// (TODO: shouldn't be array but proper result object)
if (is_array($result) and !empty($result)) {
$this->plan->add_result($result);
}
}
// Mark as executed if any step has been executed
if (!empty($this->steps)) {
$this->executed = true;
}
}
/**
* Destroy all circular references. It helps PHP 5.2 a lot!
*/
public function destroy() {
// Before reseting anything, call destroy recursively
foreach ($this->steps as $step) {
$step->destroy();
}
foreach ($this->settings as $setting) {
$setting->destroy();
}
// Everything has been destroyed recursively, now we can reset safely
$this->steps = array();
$this->setting = array();
$this->plan = null;
}
public function is_checksum_correct($checksum) {
return $this->calculate_checksum() === $checksum;
}
public function calculate_checksum() {
// Let's do it using name and settings and steps
return md5($this->name . '-' .
backup_general_helper::array_checksum_recursive($this->settings) .
backup_general_helper::array_checksum_recursive($this->steps));
}
/**
* Add the given info to the current plan's results.
*
* @see base_plan::add_result()
* @param array $result associative array describing a result of a task/step
*/
public function add_result($result) {
if (!is_null($this->plan)) {
$this->plan->add_result($result);
} else {
debugging('Attempting to add a result of a task not binded with a plan', DEBUG_DEVELOPER);
}
}
/**
* Return the current plan's results
*
* @return array|null
*/
public function get_results() {
if (!is_null($this->plan)) {
return $this->plan->get_results();
} else {
debugging('Attempting to get results of a task not binded with a plan', DEBUG_DEVELOPER);
return null;
}
}
// Protected API starts here
/**
* This function is invoked on activity creation in order to add all the settings
* that are associated with one task. The function will, directly, inject the settings
* in the task.
*/
protected abstract function define_settings();
protected function add_setting($setting) {
if (! $setting instanceof base_setting) {
throw new base_setting_exception('wrong_base_setting_specified');
}
$this->settings[] = $setting;
}
}
/*
* Exception class used by all the @base_task stuff
*/
class base_task_exception extends moodle_exception {
public function __construct($errorcode, $a=NULL, $debuginfo=null) {
parent::__construct($errorcode, '', '', $a, $debuginfo);
}
}