mirrored from git://git.moodle.org/moodle.git
-
Notifications
You must be signed in to change notification settings - Fork 6.6k
/
backup_plan_dbops.class.php
277 lines (242 loc) · 10.5 KB
/
backup_plan_dbops.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
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
<?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-dbops
* @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 DB support to the @backup_plan class
*
* This class contains various static methods available for all the DB operations
* performed by the @backup_plan (and builder) classes
*
* TODO: Finish phpdocs
*/
abstract class backup_plan_dbops extends backup_dbops {
/**
* Given one course module id, return one array with all the block intances that belong to it
*/
public static function get_blockids_from_moduleid($moduleid) {
global $DB;
// Get the context of the module
$contextid = get_context_instance(CONTEXT_MODULE, $moduleid)->id;
// Get all the block instances which parentcontextid is the module contextid
$blockids = array();
$instances = $DB->get_records('block_instances', array('parentcontextid' => $contextid), '', 'id');
foreach ($instances as $instance) {
$blockids[] = $instance->id;
}
return $blockids;
}
/**
* Given one course id, return one array with all the block intances that belong to it
*/
public static function get_blockids_from_courseid($courseid) {
global $DB;
// Get the context of the course
$contextid = get_context_instance(CONTEXT_COURSE, $courseid)->id;
// Get all the block instances which parentcontextid is the course contextid
$blockids = array();
$instances = $DB->get_records('block_instances', array('parentcontextid' => $contextid), '', 'id');
foreach ($instances as $instance) {
$blockids[] = $instance->id;
}
return $blockids;
}
/**
* Given one section id, return one array with all the course modules that belong to it
*/
public static function get_modules_from_sectionid($sectionid) {
global $DB;
// Get the course and sequence of the section
$secrec = $DB->get_record('course_sections', array('id' => $sectionid), 'course, sequence');
$courseid = $secrec->course;
$sequence = $secrec->sequence;
// Get the section->sequence contents (it roots the activities order)
// Get all course modules belonging to requested section
$modulesarr = array();
$modules = $DB->get_records_sql("
SELECT cm.id, m.name AS modname
FROM {course_modules} cm
JOIN {modules} m ON m.id = cm.module
WHERE cm.course = ?
AND cm.section = ?", array($courseid, $sectionid));
foreach (explode(',', $sequence) as $moduleid) {
if (isset($modules[$moduleid])) {
$module = array('id' => $modules[$moduleid]->id, 'modname' => $modules[$moduleid]->modname);
$modulesarr[] = (object)$module;
unset($modules[$moduleid]);
}
}
if (!empty($modules)) { // This shouldn't happen, but one borked sequence can lead to it. Add the rest
foreach ($modules as $module) {
$module = array('id' => $module->id, 'modname' => $module->modname);
$modulesarr[] = (object)$module;
}
}
return $modulesarr;
}
/**
* Given one course id, return one array with all the course_sections belonging to it
*/
public static function get_sections_from_courseid($courseid) {
global $DB;
// Get all sections belonging to requested course
$sectionsarr = array();
$sections = $DB->get_records('course_sections', array('course' => $courseid));
foreach ($sections as $section) {
$sectionsarr[] = $section->id;
}
return $sectionsarr;
}
/**
* Given one course id, return its format in DB
*/
public static function get_courseformat_from_courseid($courseid) {
global $DB;
return $DB->get_field('course', 'format', array('id' => $courseid));
}
/**
* Given a course id, returns its theme. This can either be the course
* theme or (if not specified in course) the category, site theme.
*
* User, session, and inherited-from-mnet themes cannot have backed-up
* per course data. This is course-related data so it must be in a course
* theme specified as part of the course structure
* @param int $courseid
* @return string Name of course theme
* @see moodle_page#resolve_theme()
*/
public static function get_theme_from_courseid($courseid) {
global $DB, $CFG;
// Course theme first
if (!empty($CFG->allowcoursethemes)) {
$theme = $DB->get_field('course', 'theme', array('id' => $courseid));
if ($theme) {
return $theme;
}
}
// Category themes in reverse order
if (!empty($CFG->allowcategorythemes)) {
$catid = $DB->get_field('course', 'category', array('id' => $courseid));
while($catid) {
$category = $DB->get_record('course_categories', array('id'=>$catid),
'theme,parent', MUST_EXIST);
if ($category->theme) {
return $category->theme;
}
$catid = $category->parent;
}
}
// Finally use site theme
return $CFG->theme;
}
/**
* Return the wwwroot of the $CFG->mnet_localhost_id host
* caching it along the request
*/
public static function get_mnet_localhost_wwwroot() {
global $CFG, $DB;
static $wwwroot = null;
if (is_null($wwwroot)) {
$wwwroot = $DB->get_field('mnet_host', 'wwwroot', array('id' => $CFG->mnet_localhost_id));
}
return $wwwroot;
}
/**
* Returns the default backup filename, based in passed params.
*
* Default format is (see MDL-22145)
* backup word - format - type - name - date - info . mbz
* where name is variable (course shortname, section name/id, activity modulename + cmid)
* and info can be (nu = no user info, an = anonymized). The last param $useidasname,
* defaulting to false, allows to replace the course shortname by the course id (used
* by automated backups, to avoid non-ascii chars in OS filesystem)
*
* @param string $format One of backup::FORMAT_
* @param string $type One of backup::TYPE_
* @param int $courseid/$sectionid/$cmid
* @param bool $users Should be true is users were included in the backup
* @param bool $anonymised Should be true is user information was anonymized.
* @param bool $useidasname true to use id, false to use strings (default)
* @return string The filename to use
*/
public static function get_default_backup_filename($format, $type, $id, $users, $anonymised, $useidasname = false) {
global $DB;
// Calculate backup word
$backupword = str_replace(' ', '_', moodle_strtolower(get_string('backupfilename')));
$backupword = trim(clean_filename($backupword), '_');
$shortname = '';
// Not $useidasname, lets calculate it, else $id will be used
if (!$useidasname) {
// Calculate proper name element (based on type)
switch ($type) {
case backup::TYPE_1COURSE:
$shortname = $DB->get_field('course', 'shortname', array('id' => $id));
$context = get_context_instance(CONTEXT_COURSE, $id);
$shortname = format_string($shortname, true, array('context' => $context));
break;
case backup::TYPE_1SECTION:
if (!$shortname = $DB->get_field('course_sections', 'name', array('id' => $id))) {
$shortname = $DB->get_field('course_sections', 'section', array('id' => $id));
}
break;
case backup::TYPE_1ACTIVITY:
$cm = get_coursemodule_from_id(null, $id);
$shortname = $cm->modname . $id;
break;
}
$shortname = str_replace(' ', '_', $shortname);
$shortname = moodle_strtolower(trim(clean_filename($shortname), '_'));
}
$name = empty($shortname) ? $id : $shortname;
// Calculate date
$backupdateformat = str_replace(' ', '_', get_string('backupnameformat', 'langconfig'));
$date = userdate(time(), $backupdateformat, 99, false);
$date = moodle_strtolower(trim(clean_filename($date), '_'));
// Calculate info
$info = '';
if (!$users) {
$info = '-nu';
} else if ($anonymised) {
$info = '-an';
}
return $backupword . '-' . $format . '-' . $type . '-' .
$name . '-' . $date . $info . '.mbz';
}
/**
* Returns a flag indicating the need to backup gradebook elements like calculated grade items and category visibility
* If all activity related grade items are being backed up we can also backup calculated grade items and categories
*/
public static function require_gradebook_backup($courseid, $backupid) {
global $DB;
$sql = "SELECT count(id)
FROM {grade_items}
WHERE courseid=:courseid
AND itemtype = 'mod'
AND id NOT IN (
SELECT bi.itemid
FROM {backup_ids_temp} bi
WHERE bi.itemname = 'grade_itemfinal'
AND bi.backupid = :backupid)";
$params = array('courseid'=>$courseid, 'backupid'=>$backupid);
$count = $DB->count_records_sql($sql, $params);
//if there are 0 activity grade items not already included in the backup
return $count == 0;
}
}