mirrored from git://git.moodle.org/moodle.git
-
Notifications
You must be signed in to change notification settings - Fork 6.6k
/
backup_check.class.php
245 lines (222 loc) · 11.5 KB
/
backup_check.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
<?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-factories
* @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
/**
* Non instantiable helper class providing different backup checks
*
* This class contains various static methods available in order to easily
* perform a bunch of backup architecture tests
*
* TODO: Finish phpdocs
*/
abstract class backup_check {
public static function check_format_and_type($format, $type) {
global $CFG;
$file = $CFG->dirroot . '/backup/' . $format . '/backup_plan_builder.class.php';
if (! file_exists($file)) {
throw new backup_controller_exception('backup_check_unsupported_format', $format);
}
require_once($file);
if (!in_array($type, backup_plan_builder::supported_backup_types())) {
throw new backup_controller_exception('backup_check_unsupported_type', $type);
}
require_once($CFG->dirroot . '/backup/moodle2/backup_plan_builder.class.php');
}
public static function check_id($type, $id) {
global $DB;
switch ($type) {
case backup::TYPE_1ACTIVITY:
// id must exist in course_modules table
if (! $DB->record_exists('course_modules', array('id' => $id))) {
throw new backup_controller_exception('backup_check_module_not_exists', $id);
}
break;
case backup::TYPE_1SECTION:
// id must exist in course_sections table
if (! $DB->record_exists('course_sections', array('id' => $id))) {
throw new backup_controller_exception('backup_check_section_not_exists', $id);
}
break;
case backup::TYPE_1COURSE:
// id must exist in course table
if (! $DB->record_exists('course', array('id' => $id))) {
throw new backup_controller_exception('backup_check_course_not_exists', $id);
}
break;
default:
throw new backup_controller_exception('backup_check_incorrect_type', $type);
}
return true;
}
public static function check_user($userid) {
global $DB;
// userid must exist in user table
if (! $DB->record_exists('user', array('id' => $userid))) {
throw new backup_controller_exception('backup_check_user_not_exists', $userid);
}
return true;
}
public static function check_security($backup_controller, $apply) {
global $DB;
if (! $backup_controller instanceof backup_controller) {
throw new backup_controller_exception('backup_check_security_requires_backup_controller');
}
$backup_controller->log('checking plan security', backup::LOG_INFO);
// Some handy vars
$type = $backup_controller->get_type();
$mode = $backup_controller->get_mode();
$courseid = $backup_controller->get_courseid();
$coursectx= get_context_instance(CONTEXT_COURSE, $courseid);
$userid = $backup_controller->get_userid();
$id = $backup_controller->get_id(); // courseid / sectionid / cmid
// Note: all the checks along the function MUST be performed for $userid, that
// is the user who "requested" the course backup, not current $USER at all!!
// First of all, decide which caps/contexts are we going to check
// for common backups (general, automated...) based exclusively
// in the type (course, section, activity). And store them into
// one capability => context array structure
$typecapstocheck = array();
switch ($type) {
case backup::TYPE_1COURSE :
$DB->get_record('course', array('id' => $id), '*', MUST_EXIST); // course exists
$typecapstocheck['moodle/backup:backupcourse'] = $coursectx;
break;
case backup::TYPE_1SECTION :
$DB->get_record('course_sections', array('course' => $courseid, 'id' => $id), '*', MUST_EXIST); // sec exists
$typecapstocheck['moodle/backup:backupsection'] = $coursectx;
break;
case backup::TYPE_1ACTIVITY :
get_coursemodule_from_id(null, $id, $courseid, false, MUST_EXIST); // cm exists
$modulectx = get_context_instance(CONTEXT_MODULE, $id);
$typecapstocheck['moodle/backup:backupactivity'] = $modulectx;
break;
default :
throw new backup_controller_exception('backup_unknown_backup_type', $type);
}
// Now, if backup mode is hub or import, check userid has permissions for those modes
// other modes will perform common checks only (backupxxxx capabilities in $typecapstocheck)
switch ($mode) {
case backup::MODE_HUB:
if (!has_capability('moodle/backup:backuptargethub', $coursectx, $userid)) {
$a = new stdclass();
$a->userid = $userid;
$a->courseid = $courseid;
$a->capability = 'moodle/backup:backuptargethub';
throw new backup_controller_exception('backup_user_missing_capability', $a);
}
break;
case backup::MODE_IMPORT:
if (!has_capability('moodle/backup:backuptargetimport', $coursectx, $userid)) {
$a = new stdclass();
$a->userid = $userid;
$a->courseid = $courseid;
$a->capability = 'moodle/backup:backuptargetimport';
throw new backup_controller_exception('backup_user_missing_capability', $a);
}
break;
// Common backup (general, automated...), let's check all the $typecapstocheck
// capability => context pairs
default:
foreach ($typecapstocheck as $capability => $context) {
if (!has_capability($capability, $context, $userid)) {
$a = new stdclass();
$a->userid = $userid;
$a->courseid = $courseid;
$a->capability = $capability;
throw new backup_controller_exception('backup_user_missing_capability', $a);
}
}
}
// Now, enforce 'moodle/backup:userinfo' to 'users' setting, applying changes if allowed,
// else throwing exception
$userssetting = $backup_controller->get_plan()->get_setting('users');
$prevvalue = $userssetting->get_value();
$prevstatus = $userssetting->get_status();
$hasusercap = has_capability('moodle/backup:userinfo', $coursectx, $userid);
// If setting is enabled but user lacks permission
if (!$hasusercap) { // If user has not the capability
// Now analyse if we are allowed to apply changes or must stop with exception
if (!$apply && $prevvalue) { // Cannot apply changes and the value is set, throw exception
$a = new stdclass();
$a->setting = 'users';
$a->value = $prevvalue;
$a->capability = 'moodle/backup:userinfo';
throw new backup_controller_exception('backup_setting_value_wrong_for_capability', $a);
} else { // Can apply changes
// If it is already false, we don't want to try and set it again, because if it is
// already locked, and exception will occur. The side benifit is if it is true and locked
// we will get an exception...
if ($prevvalue) {
$userssetting->set_value(false); // Set the value to false
}
$userssetting->set_status(base_setting::LOCKED_BY_PERMISSION);// Set the status to locked by perm
}
}
// Now, enforce 'moodle/backup:anonymise' to 'anonymise' setting, applying changes if allowed,
// else throwing exception
$anonsetting = $backup_controller->get_plan()->get_setting('anonymize');
$prevvalue = $anonsetting->get_value();
$prevstatus = $anonsetting->get_status();
$hasanoncap = has_capability('moodle/backup:anonymise', $coursectx, $userid);
// If setting is enabled but user lacks permission
if (!$hasanoncap) { // If user has not the capability
// Now analyse if we are allowed to apply changes or must stop with exception
if (!$apply && $prevvalue) { // Cannot apply changes and the value is set, throw exception
$a = new stdclass();
$a->setting = 'anonymize';
$a->value = $prevvalue;
$a->capability = 'moodle/backup:anonymise';
throw new backup_controller_exception('backup_setting_value_wrong_for_capability', $a);
} else { // Can apply changes
if ($prevvalue) { // If we try and set it back to false and it has already been locked, error will occur
$anonsetting->set_value(false); // Set the value to false
}
$anonsetting->set_status(base_setting::LOCKED_BY_PERMISSION);// Set the status to locked by perm
}
}
// Now, if mode is HUB or IMPORT, and still we are including users in backup, turn them off
// Defaults processing should have handled this, but we need to be 100% sure
if ($mode == backup::MODE_IMPORT || $mode == backup::MODE_HUB) {
$userssetting = $backup_controller->get_plan()->get_setting('users');
if ($userssetting->get_value()) {
$userssetting->set_value(false); // Set the value to false
$userssetting->set_status(base_setting::LOCKED_BY_PERMISSION);// Set the status to locked by perm
}
}
// Check the user has the ability to configure the backup. If not then we need
// to lock all settings by permission so that no changes can be made. This does
// not apply to the import facility, where the activities must be always enabled
// to be able to pick them
if ($mode != backup::MODE_IMPORT) {
$hasconfigcap = has_capability('moodle/backup:configure', $coursectx, $userid);
if (!$hasconfigcap) {
$settings = $backup_controller->get_plan()->get_settings();
foreach ($settings as $setting) {
if ($setting->get_name() == 'filename') {
continue;
}
$setting->set_status(base_setting::LOCKED_BY_PERMISSION);
}
}
}
return true;
}
}