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
|
<?php //$Id: restorelib.php,v 1.24 2006/04/11 16:10:44 stronk7 Exp $
//This php script contains all the stuff to backup/restore
//assignment mods
//This is the "graphical" structure of the assignment mod:
//
// assignment
// (CL,pk->id)
// |
// |
// |
// assignment_submisions
// (UL,pk->id, fk->assignment,files)
//
// Meaning: pk->primary key field of the table
// fk->foreign key to link with parent
// nt->nested field (recursive data)
// CL->course level info
// UL->user level info
// files->table may have files)
//
//-----------------------------------------------------------
//This function executes all the restore procedure about this mod
function assignment_restore_mods($mod,$restore) {
global $CFG;
$status = true;
//Get record from backup_ids
$data = backup_getid($restore->backup_unique_code,$mod->modtype,$mod->id);
if ($data) {
//Now get completed xmlized object
$info = $data->info;
//traverse_xmlize($info); //Debug
//print_object ($GLOBALS['traverse_array']); //Debug
//$GLOBALS['traverse_array']=""; //Debug
//Now, build the ASSIGNMENT record structure
$assignment->course = $restore->course_id;
$assignment->name = backup_todb($info['MOD']['#']['NAME']['0']['#']);
$assignment->description = backup_todb($info['MOD']['#']['DESCRIPTION']['0']['#']);
$assignment->format = backup_todb($info['MOD']['#']['FORMAT']['0']['#']);
$assignment->resubmit = backup_todb($info['MOD']['#']['RESUBMIT']['0']['#']);
$assignment->preventlate = backup_todb($info['MOD']['#']['PREVENTLATE']['0']['#']);
$assignment->emailteachers = backup_todb($info['MOD']['#']['EMAILTEACHERS']['0']['#']);
$assignment->var1 = backup_todb($info['MOD']['#']['VAR1']['0']['#']);
$assignment->var2 = backup_todb($info['MOD']['#']['VAR2']['0']['#']);
$assignment->var3 = backup_todb($info['MOD']['#']['VAR3']['0']['#']);
$assignment->var4 = backup_todb($info['MOD']['#']['VAR4']['0']['#']);
$assignment->var5 = backup_todb($info['MOD']['#']['VAR5']['0']['#']);
$assignment->type = backup_todb($info['MOD']['#']['TYPE']['0']['#']);
$assignment->assignmenttype = backup_todb($info['MOD']['#']['ASSIGNMENTTYPE']['0']['#']);
$assignment->maxbytes = backup_todb($info['MOD']['#']['MAXBYTES']['0']['#']);
$assignment->timedue = backup_todb($info['MOD']['#']['TIMEDUE']['0']['#']);
$assignment->timeavailable = backup_todb($info['MOD']['#']['TIMEAVAILABLE']['0']['#']);
$assignment->grade = backup_todb($info['MOD']['#']['GRADE']['0']['#']);
$assignment->timemodified = backup_todb($info['MOD']['#']['TIMEMODIFIED']['0']['#']);
//We have to recode the grade field if it is <0 (scale)
if ($assignment->grade < 0) {
$scale = backup_getid($restore->backup_unique_code,"scale",abs($assignment->grade));
if ($scale) {
$assignment->grade = -($scale->new_id);
}
}
if (empty($assignment->assignmenttype)) { /// Pre 1.5 assignment
if ($assignment->type == 1) {
$assignment->assignmenttype = 'uploadsingle';
} else {
$assignment->assignmenttype = 'offline';
}
}
//The structure is equal to the db, so insert the assignment
$newid = insert_record ("assignment",$assignment);
//Do some output
if (!defined('RESTORE_SILENTLY')) {
echo "<li>".get_string("modulename","assignment")." \"".format_string(stripslashes($assignment->name),true)."\"</li>";
}
backup_flush(300);
if ($newid) {
//We have the newid, update backup_ids
backup_putid($restore->backup_unique_code,$mod->modtype,
$mod->id, $newid);
//Now check if want to restore user data and do it.
if (restore_userdata_selected($restore,'assignment',$mod->id)) {
//Restore assignmet_submissions
$status = assignment_submissions_restore_mods ($mod->id, $newid,$info,$restore);
}
} else {
$status = false;
}
} else {
$status = false;
}
return $status;
}
//This function restores the assignment_submissions
function assignment_submissions_restore_mods($old_assignment_id, $new_assignment_id,$info,$restore) {
global $CFG;
$status = true;
//Get the submissions array
$submissions = $info['MOD']['#']['SUBMISSIONS']['0']['#']['SUBMISSION'];
//Iterate over submissions
for($i = 0; $i < sizeof($submissions); $i++) {
$sub_info = $submissions[$i];
//traverse_xmlize($sub_info); //Debug
//print_object ($GLOBALS['traverse_array']); //Debug
//$GLOBALS['traverse_array']=""; //Debug
//We'll need this later!!
$oldid = backup_todb($sub_info['#']['ID']['0']['#']);
$olduserid = backup_todb($sub_info['#']['USERID']['0']['#']);
//Now, build the ASSIGNMENT_SUBMISSIONS record structure
$submission->assignment = $new_assignment_id;
$submission->userid = backup_todb($sub_info['#']['USERID']['0']['#']);
$submission->timecreated = backup_todb($sub_info['#']['TIMECREATED']['0']['#']);
$submission->timemodified = backup_todb($sub_info['#']['TIMEMODIFIED']['0']['#']);
$submission->numfiles = backup_todb($sub_info['#']['NUMFILES']['0']['#']);
$submission->data1 = backup_todb($sub_info['#']['DATA1']['0']['#']);
$submission->data2 = backup_todb($sub_info['#']['DATA2']['0']['#']);
$submission->grade = backup_todb($sub_info['#']['GRADE']['0']['#']);
$submission->comment = backup_todb($sub_info['#']['COMMENT']['0']['#']);
$submission->format = backup_todb($sub_info['#']['FORMAT']['0']['#']);
$submission->teacher = backup_todb($sub_info['#']['TEACHER']['0']['#']);
$submission->timemarked = backup_todb($sub_info['#']['TIMEMARKED']['0']['#']);
$submission->mailed = backup_todb($sub_info['#']['MAILED']['0']['#']);
//We have to recode the userid field
$user = backup_getid($restore->backup_unique_code,"user",$submission->userid);
if ($user) {
$submission->userid = $user->new_id;
}
//We have to recode the teacher field
$user = backup_getid($restore->backup_unique_code,"user",$submission->teacher);
if ($user) {
$submission->teacher = $user->new_id;
}
//The structure is equal to the db, so insert the assignment_submission
$newid = insert_record ("assignment_submissions",$submission);
//Do some output
if (($i+1) % 50 == 0) {
if (!defined('RESTORE_SILENTLY')) {
echo ".";
if (($i+1) % 1000 == 0) {
echo "<br />";
}
}
backup_flush(300);
}
if ($newid) {
//We have the newid, update backup_ids
backup_putid($restore->backup_unique_code,"assignment_submission",$oldid,
$newid);
//Now copy moddata associated files
$status = assignment_restore_files ($old_assignment_id, $new_assignment_id,
$olduserid, $submission->userid, $restore);
} else {
$status = false;
}
}
return $status;
}
//This function copies the assignment related info from backup temp dir to course moddata folder,
//creating it if needed and recoding everything (assignment id and user id)
function assignment_restore_files ($oldassid, $newassid, $olduserid, $newuserid, $restore) {
global $CFG;
$status = true;
$todo = false;
$moddata_path = "";
$assignment_path = "";
$temp_path = "";
//First, we check to "course_id" exists and create is as necessary
//in CFG->dataroot
$dest_dir = $CFG->dataroot."/".$restore->course_id;
$status = check_dir_exists($dest_dir,true);
//Now, locate course's moddata directory
$moddata_path = $CFG->dataroot."/".$restore->course_id."/".$CFG->moddata;
//Check it exists and create it
$status = check_dir_exists($moddata_path,true);
//Now, locate assignment directory
if ($status) {
$assignment_path = $moddata_path."/assignment";
//Check it exists and create it
$status = check_dir_exists($assignment_path,true);
}
//Now locate the temp dir we are gong to restore
if ($status) {
$temp_path = $CFG->dataroot."/temp/backup/".$restore->backup_unique_code.
"/moddata/assignment/".$oldassid."/".$olduserid;
//Check it exists
if (is_dir($temp_path)) {
$todo = true;
}
}
//If todo, we create the neccesary dirs in course moddata/assignment
if ($status and $todo) {
//First this assignment id
$this_assignment_path = $assignment_path."/".$newassid;
$status = check_dir_exists($this_assignment_path,true);
//Now this user id
$user_assignment_path = $this_assignment_path."/".$newuserid;
//And now, copy temp_path to user_assignment_path
$status = backup_copy_file($temp_path, $user_assignment_path);
}
return $status;
}
//Return a content decoded to support interactivities linking. Every module
//should have its own. They are called automatically from
//assignment_decode_content_links_caller() function in each module
//in the restore process
function assignment_decode_content_links ($content,$restore) {
global $CFG;
$result = $content;
//Link to the list of assignments
$searchstring='/\$@(ASSIGNMENTINDEX)\*([0-9]+)@\$/';
//We look for it
preg_match_all($searchstring,$content,$foundset);
//If found, then we are going to look for its new id (in backup tables)
if ($foundset[0]) {
//print_object($foundset); //Debug
//Iterate over foundset[2]. They are the old_ids
foreach($foundset[2] as $old_id) {
//We get the needed variables here (course id)
$rec = backup_getid($restore->backup_unique_code,"course",$old_id);
//Personalize the searchstring
$searchstring='/\$@(ASSIGNMENTINDEX)\*('.$old_id.')@\$/';
//If it is a link to this course, update the link to its new location
if($rec->new_id) {
//Now replace it
$result= preg_replace($searchstring,$CFG->wwwroot.'/mod/assignment/index.php?id='.$rec->new_id,$result);
} else {
//It's a foreign link so leave it as original
$result= preg_replace($searchstring,$restore->original_wwwroot.'/mod/assignment/index.php?id='.$old_id,$result);
}
}
}
//Link to assignment view by moduleid
$searchstring='/\$@(ASSIGNMENTVIEWBYID)\*([0-9]+)@\$/';
//We look for it
preg_match_all($searchstring,$result,$foundset);
//If found, then we are going to look for its new id (in backup tables)
if ($foundset[0]) {
//print_object($foundset); //Debug
//Iterate over foundset[2]. They are the old_ids
foreach($foundset[2] as $old_id) {
//We get the needed variables here (course_modules id)
$rec = backup_getid($restore->backup_unique_code,"course_modules",$old_id);
//Personalize the searchstring
$searchstring='/\$@(ASSIGNMENTVIEWBYID)\*('.$old_id.')@\$/';
//If it is a link to this course, update the link to its new location
if($rec->new_id) {
//Now replace it
$result= preg_replace($searchstring,$CFG->wwwroot.'/mod/assignment/view.php?id='.$rec->new_id,$result);
} else {
//It's a foreign link so leave it as original
$result= preg_replace($searchstring,$restore->original_wwwroot.'/mod/assignment/view.php?id='.$old_id,$result);
}
}
}
return $result;
}
//This function makes all the necessary calls to xxxx_decode_content_links()
//function in each module, passing them the desired contents to be decoded
//from backup format to destination site/course in order to mantain inter-activities
//working in the backup/restore process. It's called from restore_decode_content_links()
//function in restore process
function assignment_decode_content_links_caller($restore) {
global $CFG;
$status = true;
if ($assignments = get_records_sql ("SELECT a.id, a.description
FROM {$CFG->prefix}assignment a
WHERE a.course = $restore->course_id")) {
//Iterate over each assignment->description
$i = 0; //Counter to send some output to the browser to avoid timeouts
foreach ($assignments as $assignment) {
//Increment counter
$i++;
$content = $assignment->description;
$result = restore_decode_content_links_worker($content,$restore);
if ($result != $content) {
//Update record
$assignment->description = addslashes($result);
$status = update_record("assignment",$assignment);
if ($CFG->debug>7) {
if (!defined('RESTORE_SILENTLY')) {
echo '<br /><hr />'.s($content).'<br />changed to<br />'.s($result).'<hr /><br />';
}
}
}
//Do some output
if (($i+1) % 5 == 0) {
if (!defined('RESTORE_SILENTLY')) {
echo ".";
if (($i+1) % 100 == 0) {
echo "<br />";
}
}
backup_flush(300);
}
}
}
return $status;
}
//This function converts texts in FORMAT_WIKI to FORMAT_MARKDOWN for
//some texts in the module
function assignment_restore_wiki2markdown ($restore) {
global $CFG;
$status = true;
//Convert assignment->description
if ($records = get_records_sql ("SELECT a.id, a.description, a.format
FROM {$CFG->prefix}assignment a,
{$CFG->prefix}backup_ids b
WHERE a.course = $restore->course_id AND
a.format = ".FORMAT_WIKI. " AND
b.backup_code = $restore->backup_unique_code AND
b.table_name = 'assignment' AND
b.new_id = a.id")) {
foreach ($records as $record) {
//Rebuild wiki links
$record->description = restore_decode_wiki_content($record->description, $restore);
//Convert to Markdown
$wtm = new WikiToMarkdown();
$record->description = $wtm->convert($record->description, $restore->course_id);
$record->format = FORMAT_MARKDOWN;
$status = update_record('assignment', addslashes_object($record));
//Do some output
$i++;
if (($i+1) % 1 == 0) {
if (!defined('RESTORE_SILENTLY')) {
echo ".";
if (($i+1) % 20 == 0) {
echo "<br />";
}
}
backup_flush(300);
}
}
}
return $status;
}
//This function returns a log record with all the necessay transformations
//done. It's used by restore_log_module() to restore modules log.
function assignment_restore_logs($restore,$log) {
$status = false;
//Depending of the action, we recode different things
switch ($log->action) {
case "add":
if ($log->cmid) {
//Get the new_id of the module (to recode the info field)
$mod = backup_getid($restore->backup_unique_code,$log->module,$log->info);
if ($mod) {
$log->url = "view.php?id=".$log->cmid;
$log->info = $mod->new_id;
$status = true;
}
}
break;
case "update":
if ($log->cmid) {
//Get the new_id of the module (to recode the info field)
$mod = backup_getid($restore->backup_unique_code,$log->module,$log->info);
if ($mod) {
$log->url = "view.php?id=".$log->cmid;
$log->info = $mod->new_id;
$status = true;
}
}
break;
case "view":
if ($log->cmid) {
//Get the new_id of the module (to recode the info field)
$mod = backup_getid($restore->backup_unique_code,$log->module,$log->info);
if ($mod) {
$log->url = "view.php?id=".$log->cmid;
$log->info = $mod->new_id;
$status = true;
}
}
break;
case "view all":
$log->url = "index.php?id=".$log->course;
$status = true;
break;
case "upload":
if ($log->cmid) {
//Get the new_id of the module (to recode the info field)
$mod = backup_getid($restore->backup_unique_code,$log->module,$log->info);
if ($mod) {
$log->url = "view.php?a=".$mod->new_id;
$log->info = $mod->new_id;
$status = true;
}
}
break;
case "view submission":
if ($log->cmid) {
//Get the new_id of the module (to recode the info field)
$mod = backup_getid($restore->backup_unique_code,$log->module,$log->info);
if ($mod) {
$log->url = "submissions.php?id=".$mod->new_id;
$log->info = $mod->new_id;
$status = true;
}
}
break;
case "update grades":
if ($log->cmid) {
//Extract the assignment id from the url field
$assid = substr(strrchr($log->url,"="),1);
//Get the new_id of the module (to recode the info field)
$mod = backup_getid($restore->backup_unique_code,$log->module,$assid);
if ($mod) {
$log->url = "submissions.php?id=".$mod->new_id;
$status = true;
}
}
break;
default:
if (!defined('RESTORE_SILENTLY')) {
echo "action (".$log->module."-".$log->action.") unknown. Not restored<br />"; //Debug
}
break;
}
if ($status) {
$status = $log;
}
return $status;
}
?>
|
