forked from moodle/moodle
-
Notifications
You must be signed in to change notification settings - Fork 0
/
backuplib.php
534 lines (481 loc) · 28.2 KB
/
backuplib.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
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
<?php
/**
* Question bank backup code.
*
* @license http://www.gnu.org/copyleft/gpl.html GNU Public License
* @package questionbank
*//** */
//This is the "graphical" structure of the question database:
//To see, put your terminal to 160cc
// The following holds student-independent information about the questions
//
// question_categories
// (CL,pk->id)
// |
// |
// |.......................................
// | .
// | .
// | -------question_datasets------ .
// | | (CL,pk->id,fk->question, | .
// | | fk->dataset_definition) | .
// | | | .
// | | | .
// | | | .
// | | question_dataset_definitions
// | | (CL,pk->id,fk->category)
// question |
// (CL,pk->id,fk->category,files) |
// | question_dataset_items
// | (CL,pk->id,fk->definition)
// |
// |
// |
// --------------------------------------------------------------------------------------------------------------
// | | | | | | |
// | | | | | | |
// | | | | question_calculated | |
// question_truefalse | question_multichoice | (CL,pl->id,fk->question) | |
// (CL,pk->id,fk->question) | (CL,pk->id,fk->question) | . | | question_randomsamatch
// . | . | . | |--(CL,pk->id,fk->question)
// . question_shortanswer . question_numerical . question_multianswer. |
// . (CL,pk->id,fk->question) . (CL,pk->id,fk->question) . (CL,pk->id,fk->question) |
// . . . . . . | question_match
// . . . . . . |--(CL,pk->id,fk->question)
// . . . . . . | .
// . . . . . . | .
// . . . . . . | .
// . . . . . . | question_match_sub
// ........................................................................................ |--(CL,pk->id,fk->question)
// . |
// . |
// . | question_numerical_units
// question_answers |--(CL,pk->id,fk->question)
// (CL,pk->id,fk->question)----------------------------------------------------------
//
//
// The following holds the information about student interaction with the questions
//
// question_sessions
// (UL,pk->id,fk->attempt,question)
// .
// .
// question_states
// (UL,pk->id,fk->attempt,question)
//
// Meaning: pk->primary key field of the table
// fk->foreign key to link with parent
// nt->nested field (recursive data)
// SL->site level info
// CL->course level info
// UL->user level info
// files->table may have files
//
//-----------------------------------------------------------
require_once("$CFG->libdir/questionlib.php");
function backup_question_category_context($bf, $contextid, $course) {
global $DB;
$status = true;
$context = get_context_instance_by_id($contextid);
$status = $status && fwrite($bf,start_tag("CONTEXT",4,true));
switch ($context->contextlevel){
case CONTEXT_MODULE:
$status = $status && fwrite($bf,full_tag("LEVEL",5,false, 'module'));
$status = $status && fwrite($bf,full_tag("INSTANCE",5,false, $context->instanceid));
break;
case CONTEXT_COURSE:
$status = $status && fwrite($bf,full_tag("LEVEL",5,false, 'course'));
break;
case CONTEXT_COURSECAT:
$thiscourse = $DB->get_record('course', array('id'=>$course));
$cat = $thiscourse->category;
$catno = 1;
while($context->instanceid != $cat){
$catno ++;
if ($cat ==0) {
return false;
}
$cat = $DB->get_field('course_categories', 'parent', array('id'=>$cat));
}
$status = $status && fwrite($bf,full_tag("LEVEL",5,false, 'coursecategory'));
$status = $status && fwrite($bf,full_tag("COURSECATEGORYLEVEL",5,false, $catno));
break;
case CONTEXT_SYSTEM:
$status = $status && fwrite($bf,full_tag("LEVEL",5,false, 'system'));
break;
default :
return false;
}
$status = $status && fwrite($bf,end_tag("CONTEXT",4,true));
return $status;
}
function backup_question_categories($bf,$preferences) {
global $CFG, $DB;
$status = true;
//First, we get the used categories from backup_ids
$categories = question_category_ids_by_backup ($preferences->backup_unique_code);
//If we've categories
if ($categories) {
//Write start tag
$status = $status && fwrite($bf,start_tag("QUESTION_CATEGORIES",2,true));
//Iterate over each category
foreach ($categories as $cat) {
//Start category
$status = $status && fwrite ($bf,start_tag("QUESTION_CATEGORY",3,true));
//Get category data from question_categories
$category = $DB->get_record ("question_categories", array("id"=>$cat->old_id));
//Print category contents
$status = $status && fwrite($bf,full_tag("ID",4,false,$category->id));
$status = $status && fwrite($bf,full_tag("NAME",4,false,$category->name));
$status = $status && fwrite($bf,full_tag("INFO",4,false,$category->info));
$status = $status && backup_question_category_context($bf, $category->contextid, $preferences->backup_course);
$status = $status && fwrite($bf,full_tag("STAMP",4,false,$category->stamp));
$status = $status && fwrite($bf,full_tag("PARENT",4,false,$category->parent));
$status = $status && fwrite($bf,full_tag("SORTORDER",4,false,$category->sortorder));
//Now, backup their questions
$status = $status && backup_question($bf,$preferences,$category->id);
//End category
$status = $status && fwrite ($bf,end_tag("QUESTION_CATEGORY",3,true));
}
//Write end tag
$status = $status && fwrite ($bf,end_tag("QUESTION_CATEGORIES",2,true));
}
return $status;
}
//This function backups all the questions in selected category and their
//asociated data
function backup_question($bf,$preferences,$category, $level = 4) {
global $CFG, $QTYPES, $DB;
$status = true;
// We'll fetch the questions sorted by parent so that questions with no parents
// (these are the ones which could be parents themselves) are backed up first. This
// is important for the recoding of the parent field during the restore process
// Only select questions with ids in backup_ids table
$questions = $DB->get_records_sql("SELECT q.* FROM {backup_ids} bk, {question} q
WHERE q.category= ? AND
bk.old_id=q.id AND
bk.backup_code = ?
ORDER BY parent ASC, q.id", array($category, $preferences->backup_unique_code));
//If there are questions
if ($questions) {
//Write start tag
$status = $status && fwrite ($bf,start_tag("QUESTIONS",$level,true));
$counter = 0;
//Iterate over each question
foreach ($questions as $question) {
// Deal with missing question types - they need to be included becuase
// user data or quizzes may refer to them.
if (!array_key_exists($question->qtype, $QTYPES)) {
$question->qtype = 'missingtype';
$question->questiontext = '<p>' . get_string('warningmissingtype', 'quiz') . '</p>' . $question->questiontext;
}
//Start question
$status = $status && fwrite ($bf,start_tag("QUESTION",$level + 1,true));
//Print question contents
fwrite ($bf,full_tag("ID",$level + 2,false,$question->id));
fwrite ($bf,full_tag("PARENT",$level + 2,false,$question->parent));
fwrite ($bf,full_tag("NAME",$level + 2,false,$question->name));
fwrite ($bf,full_tag("QUESTIONTEXT",$level + 2,false,$question->questiontext));
fwrite ($bf,full_tag("QUESTIONTEXTFORMAT",$level + 2,false,$question->questiontextformat));
fwrite ($bf,full_tag("IMAGE",$level + 2,false,$question->image));
fwrite ($bf,full_tag("GENERALFEEDBACK",$level + 2,false,$question->generalfeedback));
fwrite ($bf,full_tag("DEFAULTGRADE",$level + 2,false,$question->defaultgrade));
fwrite ($bf,full_tag("PENALTY",$level + 2,false,$question->penalty));
fwrite ($bf,full_tag("QTYPE",$level + 2,false,$question->qtype));
fwrite ($bf,full_tag("LENGTH",$level + 2,false,$question->length));
fwrite ($bf,full_tag("STAMP",$level + 2,false,$question->stamp));
fwrite ($bf,full_tag("VERSION",$level + 2,false,$question->version));
fwrite ($bf,full_tag("HIDDEN",$level + 2,false,$question->hidden));
fwrite ($bf,full_tag("TIMECREATED",$level + 2,false,$question->timecreated));
fwrite ($bf,full_tag("TIMEMODIFIED",$level + 2,false,$question->timemodified));
fwrite ($bf,full_tag("CREATEDBY",$level + 2,false,$question->createdby));
fwrite ($bf,full_tag("MODIFIEDBY",$level + 2,false,$question->modifiedby));
// Backup question type specific data
$status = $status && $QTYPES[$question->qtype]->backup($bf,$preferences,$question->id, $level + 2);
//End question
$status = $status && fwrite ($bf,end_tag("QUESTION",$level + 1,true));
//Do some output
$counter++;
if ($counter % 10 == 0) {
echo ".";
if ($counter % 200 == 0) {
echo "<br />";
}
backup_flush(300);
}
}
//Write end tag
$status = $status && fwrite ($bf,end_tag("QUESTIONS",$level,true));
}
return $status;
}
//This function backups the answers data in some question types
//(truefalse, shortanswer,multichoice,numerical,calculated)
function question_backup_answers($bf,$preferences,$question, $level = 6) {
global $CFG, $DB;
$status = true;
$answers = $DB->get_records("question_answers", array("question"=>$question), "id");
//If there are answers
if ($answers) {
$status = $status && fwrite ($bf,start_tag("ANSWERS",$level,true));
//Iterate over each answer
foreach ($answers as $answer) {
$status = $status && fwrite ($bf,start_tag("ANSWER",$level + 1,true));
//Print answer contents
fwrite ($bf,full_tag("ID",$level + 2,false,$answer->id));
fwrite ($bf,full_tag("ANSWER_TEXT",$level + 2,false,$answer->answer));
fwrite ($bf,full_tag("FRACTION",$level + 2,false,$answer->fraction));
fwrite ($bf,full_tag("FEEDBACK",$level + 2,false,$answer->feedback));
$status = $status && fwrite ($bf,end_tag("ANSWER",$level + 1,true));
}
$status = $status && fwrite ($bf,end_tag("ANSWERS",$level,true));
}
return $status;
}
//This function backups question_numerical_units from different question types
function question_backup_numerical_units($bf,$preferences,$question,$level=7) {
global $CFG, $DB;
$status = true;
$numerical_units = $DB->get_records("question_numerical_units", array("question"=>$question), "id");
//If there are numericals_units
if ($numerical_units) {
$status = $status && fwrite ($bf,start_tag("NUMERICAL_UNITS",$level,true));
//Iterate over each numerical_unit
foreach ($numerical_units as $numerical_unit) {
$status = $status && fwrite ($bf,start_tag("NUMERICAL_UNIT",$level+1,true));
//Print numerical_unit contents
fwrite ($bf,full_tag("MULTIPLIER",$level+2,false,$numerical_unit->multiplier));
fwrite ($bf,full_tag("UNIT",$level+2,false,$numerical_unit->unit));
//Now backup numerical_units
$status = $status && fwrite ($bf,end_tag("NUMERICAL_UNIT",$level+1,true));
}
$status = $status && fwrite ($bf,end_tag("NUMERICAL_UNITS",$level,true));
}
return $status;
}
//This function backups question_numerical_options from different question types
function question_backup_numerical_options($bf,$preferences,$question,$level=7) {
global $CFG, $DB;
$status = true;
$numerical_options = $DB->get_records("question_numerical_options",array("questionid" => $question),"id");
if ($numerical_options) {
//Iterate over each numerical_option
foreach ($numerical_options as $numerical_option) {
$status = $status && fwrite ($bf,start_tag("NUMERICAL_OPTIONS",$level,true));
//Print numerical_option contents
fwrite ($bf,full_tag("INSTRUCTIONS",$level+1,false,$numerical_option->instructions));
fwrite ($bf,full_tag("SHOWUNITS",$level+1,false,$numerical_option->showunits));
fwrite ($bf,full_tag("UNITSLEFT",$level+1,false,$numerical_option->unitsleft));
fwrite ($bf,full_tag("UNITGRADINGTYPE",$level+1,false,$numerical_option->unitgradingtype));
fwrite ($bf,full_tag("UNITPENALTY",$level+1,false,$numerical_option->unitpenalty));
$status = $status && fwrite ($bf,end_tag("NUMERICAL_OPTIONS",$level,true));
}
}
return $status;
}
//This function backups dataset_definitions (via question_datasets) from different question types
function question_backup_datasets($bf,$preferences,$question,$level=7) {
global $CFG, $DB;
$status = true;
//First, we get the used datasets for this question
$question_datasets = $DB->get_records("question_datasets", array("question"=>$question), "id");
//If there are question_datasets
if ($question_datasets) {
$status = $status &&fwrite ($bf,start_tag("DATASET_DEFINITIONS",$level,true));
//Iterate over each question_dataset
foreach ($question_datasets as $question_dataset) {
$def = NULL;
//Get dataset_definition
if ($def = $DB->get_record("question_dataset_definitions", array("id"=>$question_dataset->datasetdefinition))) {;
$status = $status &&fwrite ($bf,start_tag("DATASET_DEFINITION",$level+1,true));
//Print question_dataset contents
fwrite ($bf,full_tag("CATEGORY",$level+2,false,$def->category));
fwrite ($bf,full_tag("NAME",$level+2,false,$def->name));
fwrite ($bf,full_tag("TYPE",$level+2,false,$def->type));
fwrite ($bf,full_tag("OPTIONS",$level+2,false,$def->options));
fwrite ($bf,full_tag("ITEMCOUNT",$level+2,false,$def->itemcount));
//Now backup dataset_entries
$status = $status && question_backup_dataset_items($bf,$preferences,$def->id,$level+2);
//End dataset definition
$status = $status &&fwrite ($bf,end_tag("DATASET_DEFINITION",$level+1,true));
}
}
$status = $status &&fwrite ($bf,end_tag("DATASET_DEFINITIONS",$level,true));
}
return $status;
}
//This function backups datases_items from dataset_definitions
function question_backup_dataset_items($bf,$preferences,$datasetdefinition,$level=9) {
global $CFG, $DB;
$status = true;
//First, we get the datasets_items for this dataset_definition
$dataset_items = $DB->get_records("question_dataset_items", array("definition"=>$datasetdefinition), "id");
//If there are dataset_items
if ($dataset_items) {
$status = $status &&fwrite ($bf,start_tag("DATASET_ITEMS",$level,true));
//Iterate over each dataset_item
foreach ($dataset_items as $dataset_item) {
$status = $status &&fwrite ($bf,start_tag("DATASET_ITEM",$level+1,true));
//Print question_dataset contents
fwrite ($bf,full_tag("NUMBER",$level+2,false,$dataset_item->itemnumber));
fwrite ($bf,full_tag("VALUE",$level+2,false,$dataset_item->value));
//End dataset definition
$status = $status &&fwrite ($bf,end_tag("DATASET_ITEM",$level+1,true));
}
$status = $status &&fwrite ($bf,end_tag("DATASET_ITEMS",$level,true));
}
return $status;
}
//Backup question_states contents (executed from backup_quiz_attempts)
function backup_question_states ($bf,$preferences,$attempt, $level = 6) {
global $CFG, $DB;
$status = true;
$question_states = $DB->get_records("question_states", array("attempt"=>$attempt),"id");
//If there are states
if ($question_states) {
//Write start tag
$status = $status && fwrite ($bf,start_tag("STATES",$level,true));
//Iterate over each state
foreach ($question_states as $state) {
//Start state
$status = $status && fwrite ($bf,start_tag("STATE",$level + 1,true));
//Print state contents
fwrite ($bf,full_tag("ID",$level + 2,false,$state->id));
fwrite ($bf,full_tag("QUESTION",$level + 2,false,$state->question));
fwrite ($bf,full_tag("SEQ_NUMBER",$level + 2,false,$state->seq_number));
fwrite ($bf,full_tag("ANSWER",$level + 2,false,$state->answer));
fwrite ($bf,full_tag("TIMESTAMP",$level + 2,false,$state->timestamp));
fwrite ($bf,full_tag("EVENT",$level + 2,false,$state->event));
fwrite ($bf,full_tag("GRADE",$level + 2,false,$state->grade));
fwrite ($bf,full_tag("RAW_GRADE",$level + 2,false,$state->raw_grade));
fwrite ($bf,full_tag("PENALTY",$level + 2,false,$state->penalty));
//End state
$status = $status && fwrite ($bf,end_tag("STATE",$level + 1,true));
}
//Write end tag
$status = $status && fwrite ($bf,end_tag("STATES",$level,true));
}
}
//Backup question_sessions contents (executed from backup_quiz_attempts)
function backup_question_sessions ($bf,$preferences,$attempt, $level = 6) {
global $CFG, $DB;
$status = true;
$question_sessions = $DB->get_records("question_sessions", array("attemptid"=>$attempt), "id");
//If there are sessions
if ($question_sessions) {
//Write start tag (the funny name 'newest states' has historical reasons)
$status = $status && fwrite ($bf,start_tag("NEWEST_STATES",$level,true));
//Iterate over each newest_state
foreach ($question_sessions as $newest_state) {
//Start newest_state
$status = $status && fwrite ($bf,start_tag("NEWEST_STATE",$level + 1,true));
//Print newest_state contents
fwrite ($bf,full_tag("ID",$level + 2,false,$newest_state->id));
fwrite ($bf,full_tag("QUESTIONID",$level + 2,false,$newest_state->questionid));
fwrite ($bf,full_tag("NEWEST",$level + 2,false,$newest_state->newest));
fwrite ($bf,full_tag("NEWGRADED",$level + 2,false,$newest_state->newgraded));
fwrite ($bf,full_tag("SUMPENALTY",$level + 2,false,$newest_state->sumpenalty));
fwrite ($bf,full_tag("MANUALCOMMENT",$level + 2,false,$newest_state->manualcomment));
//End newest_state
$status = $status && fwrite ($bf,end_tag("NEWEST_STATE",$level + 1,true));
}
//Write end tag
$status = $status && fwrite ($bf,end_tag("NEWEST_STATES",$level,true));
}
return $status;
}
//Returns an array of categories id
function question_category_ids_by_backup ($backup_unique_code) {
global $CFG, $DB;
return $DB->get_records_sql("SELECT a.old_id, a.backup_code
FROM {backup_ids} a
WHERE a.backup_code = ? AND
a.table_name = 'question_categories'", array($backup_unique_code));
}
function question_ids_by_backup ($backup_unique_code) {
global $CFG, $DB;
return $DB->get_records_sql("SELECT old_id, backup_code
FROM {backup_ids}
WHERE backup_code = ? AND
table_name = 'question'", array($backup_unique_code));
}
//Function for inserting question and category ids into db that are all called from
// quiz_check_backup_mods during execution of backup_check.html
function question_insert_c_and_q_ids_for_course($coursecontext, $backup_unique_code){
global $CFG, $DB;
// First, all categories from this course's context.
$status = $DB->execute("INSERT INTO {backup_ids} (backup_code, table_name, old_id, info)
SELECT '$backup_unique_code', 'question_categories', qc.id, 'course'
FROM {question_categories} qc
WHERE qc.contextid = ?", array($coursecontext->id));
$status = $status && question_insert_q_ids($backup_unique_code, 'course');
return $status;
}
/**
* Insert all question ids for categories whose ids have already been inserted in the backup_ids table
* Insert code to identify categories to later insert all question ids later eg. course, quiz or other module name.
*/
function question_insert_q_ids($backup_unique_code, $info){
global $CFG,$DB;
//put the ids of the questions from all these categories into the db.
$status = $DB->execute("INSERT INTO {backup_ids} (backup_code, table_name, old_id, info)
SELECT ?, 'question', q.id, ?
FROM {question} q, {backup_ids} bk
WHERE q.category = bk.old_id AND bk.table_name = 'question_categories'
AND " . $DB->sql_compare_text('bk.info') . " = ?
AND bk.backup_code = ?",
array($backup_unique_code, $DB->sql_empty(), $info, $backup_unique_code));
return $status;
}
function question_insert_c_and_q_ids_for_module($backup_unique_code, $course, $modulename, $instances){
global $CFG, $DB;
$status = true;
// using 'dummykeyname' in sql because otherwise $DB->get_records_sql_menu returns an error
// if two key names are the same.
$cmcontexts = array();
if(!empty($instances)) {
list($usql, $params) = $DB->get_in_or_equal(array_keys($instances));
$params[] = $modulename;
$params[] = $course;
$cmcontexts = $DB->get_records_sql_menu("SELECT c.id, c.id AS dummykeyname FROM {modules} m,
{course_modules} cm, {context} c
WHERE cm.instance $usql AND m.name = ? AND m.id = cm.module AND cm.id = c.instanceid
AND c.contextlevel = ".CONTEXT_MODULE." AND cm.course = ?", $params);
}
if ($cmcontexts){
list($usql, $params) = $DB->get_in_or_equal(array_keys($cmcontexts));
$status = $status && $DB->execute("INSERT INTO {backup_ids} (backup_code, table_name, old_id, info)
SELECT '$backup_unique_code', 'question_categories', qc.id, '$modulename'
FROM {question_categories} qc
WHERE qc.contextid $usql", $params);
}
$status = $status && question_insert_q_ids($backup_unique_code, $modulename);
return $status;
}
function question_insert_site_file_names($course, $backup_unique_code){
global $QTYPES, $CFG, $DB, $OUTPUT;
$status = true;
$questionids = question_ids_by_backup ($backup_unique_code);
$urls = array();
if ($questionids){
foreach ($questionids as $question_bk){
$question = $DB->get_record('question', array('id'=>$question_bk->old_id));
$QTYPES[$question->qtype]->get_question_options($question);
$urls = array_merge_recursive($urls, $QTYPES[$question->qtype]->find_file_links($question, SITEID));
}
}
ksort($urls);
foreach (array_keys($urls) as $url){
if (file_exists($CFG->dataroot.'/'.SITEID.'/'.$url)){
$inserturl = new object();
$inserturl->backup_code = $backup_unique_code;
$inserturl->file_type = 'site';
$url = clean_param($url, PARAM_PATH);
$inserturl->path = $url;
$status = $status && $DB->insert_record('backup_files', $inserturl);
} else {
echo $OUTPUT->notification(get_string('linkedfiledoesntexist', 'question', $url));
}
}
return $status;
}