mirror of
https://github.com/moodle/moodle.git
synced 2025-01-18 05:58:34 +01:00
cf0b1faded
Remove the responsibility for loging the application of the course start date offset, from activity modules to the backup module. Merged from stable branch
509 lines
22 KiB
PHP
509 lines
22 KiB
PHP
<?php //$Id$
|
|
//This php script contains all the stuff to backup/restore
|
|
//choice mods
|
|
|
|
//This is the "graphical" structure of the choice mod:
|
|
//
|
|
// choice
|
|
// (CL,pk->id)----------|
|
|
// | |
|
|
// | |
|
|
// | |
|
|
// choice_options |
|
|
// (UL,pk->id, fk->choiceid) |
|
|
// | |
|
|
// | |
|
|
// | |
|
|
// choice_answers |
|
|
// (UL,pk->id, fk->choiceid, fk->optionid)
|
|
//
|
|
// 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 choice_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;
|
|
// if necessary, write to restorelog and adjust date/time fields
|
|
if ($restore->course_startdateoffset) {
|
|
restore_log_date_changes('Choice', $restore, $info['MOD']['#'], array('TIMEOPEN', 'TIMECLOSE'));
|
|
}
|
|
//traverse_xmlize($info); //Debug
|
|
//print_object ($GLOBALS['traverse_array']); //Debug
|
|
//$GLOBALS['traverse_array']=""; //Debug
|
|
|
|
//Now, build the CHOICE record structure
|
|
$choice->course = $restore->course_id;
|
|
$choice->name = backup_todb($info['MOD']['#']['NAME']['0']['#']);
|
|
$choice->text = backup_todb($info['MOD']['#']['TEXT']['0']['#']);
|
|
$choice->format = backup_todb($info['MOD']['#']['FORMAT']['0']['#']);
|
|
$choice->publish = backup_todb($info['MOD']['#']['PUBLISH']['0']['#']);
|
|
$choice->showresults = isset($info['MOD']['#']['SHOWRESULTS']['0']['#'])?backup_todb($info['MOD']['#']['SHOWRESULTS']['0']['#']):'';
|
|
$choice->display = backup_todb($info['MOD']['#']['DISPLAY']['0']['#']);
|
|
$choice->allowupdate = backup_todb($info['MOD']['#']['ALLOWUPDATE']['0']['#']);
|
|
$choice->showunanswered = backup_todb($info['MOD']['#']['SHOWUNANSWERED']['0']['#']);
|
|
$choice->limitanswers = backup_todb($info['MOD']['#']['LIMITANSWERS']['0']['#']);
|
|
$choice->timeopen = backup_todb($info['MOD']['#']['TIMEOPEN']['0']['#']);
|
|
$choice->timeclose = backup_todb($info['MOD']['#']['TIMECLOSE']['0']['#']);
|
|
$choice->timemodified = backup_todb($info['MOD']['#']['TIMEMODIFIED']['0']['#']);
|
|
|
|
//To mantain compatibilty, in 1.4 the publish setting meaning has changed. We
|
|
//have to modify some things it if the release field isn't present in the backup file.
|
|
if (! isset($info['MOD']['#']['SHOWRESULTS']['0']['#'])) { //check for previous versions
|
|
if (! isset($info['MOD']['#']['RELEASE']['0']['#'])) { //It's a pre-14 backup filea
|
|
//Set the allowupdate field
|
|
if ($choice->publish == 0) {
|
|
$choice->allowupdate = 1;
|
|
}
|
|
//Set the showresults field as defined by the old publish field
|
|
if ($choice->publish > 0) {
|
|
$choice->showresults = 1;
|
|
}
|
|
//Recode the publish field to its 1.4 meaning
|
|
if ($choice->publish > 0) {
|
|
$choice->publish--;
|
|
}
|
|
} else { //it's post 1.4 pre 1.6
|
|
//convert old release values into new showanswer column.
|
|
$choice->showresults = backup_todb($info['MOD']['#']['RELEASE']['0']['#']);
|
|
}
|
|
}
|
|
//The structure is equal to the db, so insert the choice
|
|
$newid = insert_record ("choice",$choice);
|
|
|
|
if ($newid) {
|
|
//We have the newid, update backup_ids
|
|
backup_putid($restore->backup_unique_code,$mod->modtype,
|
|
$mod->id, $newid);
|
|
|
|
//Check to see how answers (curently choice_options) are stored in the table
|
|
//If answer1 - answer6 exist, this is a pre 1.5 version of choice
|
|
if (isset($info['MOD']['#']['ANSWER1']['0']['#']) ||
|
|
isset($info['MOD']['#']['ANSWER2']['0']['#']) ||
|
|
isset($info['MOD']['#']['ANSWER3']['0']['#']) ||
|
|
isset($info['MOD']['#']['ANSWER4']['0']['#']) ||
|
|
isset($info['MOD']['#']['ANSWER5']['0']['#']) ||
|
|
isset($info['MOD']['#']['ANSWER6']['0']['#']) ) {
|
|
|
|
//This is a pre 1.5 choice backup, special work begins
|
|
$options = array();
|
|
$options[1] = backup_todb($info['MOD']['#']['ANSWER1']['0']['#']);
|
|
$options[2] = backup_todb($info['MOD']['#']['ANSWER2']['0']['#']);
|
|
$options[3] = backup_todb($info['MOD']['#']['ANSWER3']['0']['#']);
|
|
$options[4] = backup_todb($info['MOD']['#']['ANSWER4']['0']['#']);
|
|
$options[5] = backup_todb($info['MOD']['#']['ANSWER5']['0']['#']);
|
|
$options[6] = backup_todb($info['MOD']['#']['ANSWER6']['0']['#']);
|
|
|
|
for($i = 1; $i < 7; $i++) { //insert old answers (in 1.4) as choice_options (1.5) to db.
|
|
if (!empty($options[$i])) { //make sure this option has something in it!
|
|
$option->choiceid = $newid;
|
|
$option->text = $options[$i];
|
|
$option->timemodified = $choice->timemodified;
|
|
$newoptionid = insert_record ("choice_options",$option);
|
|
//Save this choice_option to backup_ids
|
|
backup_putid($restore->backup_unique_code,"choice_options",$i,$newoptionid);
|
|
}
|
|
}
|
|
} else { //Now we are in a "standard" 1.5 choice, so restore choice_options normally
|
|
$status = choice_options_restore_mods($newid,$info,$restore);
|
|
}
|
|
|
|
//now restore the answers for this choice.
|
|
if (restore_userdata_selected($restore,'choice',$mod->id)) {
|
|
//Restore choice_answers
|
|
$status = choice_answers_restore_mods($newid,$info,$restore);
|
|
}
|
|
} else {
|
|
$status = false;
|
|
}
|
|
|
|
//Do some output
|
|
if (!defined('RESTORE_SILENTLY')) {
|
|
echo "<li>".get_string("modulename","choice")." \"".format_string(stripslashes($choice->name),true)."\"</li>";
|
|
}
|
|
backup_flush(300);
|
|
|
|
} else {
|
|
$status = false;
|
|
}
|
|
return $status;
|
|
}
|
|
|
|
function choice_options_restore_mods($choiceid,$info,$restore) {
|
|
|
|
global $CFG;
|
|
|
|
$status = true;
|
|
|
|
$options = $info['MOD']['#']['OPTIONS']['0']['#']['OPTION'];
|
|
|
|
//Iterate over options
|
|
for($i = 0; $i < sizeof($options); $i++) {
|
|
$opt_info = $options[$i];
|
|
//traverse_xmlize($opt_info); //Debug
|
|
//print_object ($GLOBALS['traverse_array']); //Debug
|
|
//$GLOBALS['traverse_array']=""; //Debug
|
|
|
|
//We'll need this later!!
|
|
$oldid = backup_todb($opt_info['#']['ID']['0']['#']);
|
|
$olduserid = isset($opt_info['#']['USERID']['0']['#'])?backup_todb($opt_info['#']['USERID']['0']['#']):'';
|
|
|
|
//Now, build the CHOICE_OPTIONS record structure
|
|
$option->choiceid = $choiceid;
|
|
$option->text = backup_todb($opt_info['#']['TEXT']['0']['#']);
|
|
$option->maxanswers = backup_todb($opt_info['#']['MAXANSWERS']['0']['#']);
|
|
$option->timemodified = backup_todb($opt_info['#']['TIMEMODIFIED']['0']['#']);
|
|
|
|
//The structure is equal to the db, so insert the choice_options
|
|
$newid = insert_record ("choice_options",$option);
|
|
|
|
//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,"choice_options",$oldid,
|
|
$newid);
|
|
} else {
|
|
$status = false;
|
|
}
|
|
}
|
|
|
|
return $status;
|
|
}
|
|
|
|
//This function restores the choice_answers
|
|
function choice_answers_restore_mods($choiceid,$info,$restore) {
|
|
|
|
global $CFG;
|
|
|
|
$status = true;
|
|
|
|
$answers = $info['MOD']['#']['ANSWERS']['0']['#']['ANSWER'];
|
|
|
|
//Iterate over answers
|
|
for($i = 0; $i < sizeof($answers); $i++) {
|
|
$ans_info = $answers[$i];
|
|
//traverse_xmlize($sub_info); //Debug
|
|
//print_object ($GLOBALS['traverse_array']); //Debug
|
|
//$GLOBALS['traverse_array']=""; //Debug
|
|
|
|
//We'll need this later!!
|
|
$oldid = backup_todb($ans_info['#']['ID']['0']['#']);
|
|
$olduserid = backup_todb($ans_info['#']['USERID']['0']['#']);
|
|
|
|
//Now, build the CHOICE_ANSWERS record structure
|
|
$answer->choiceid = $choiceid;
|
|
$answer->userid = backup_todb($ans_info['#']['USERID']['0']['#']);
|
|
$answer->optionid = backup_todb($ans_info['#']['OPTIONID']['0']['#']);
|
|
$answer->timemodified = backup_todb($ans_info['#']['TIMEMODIFIED']['0']['#']);
|
|
|
|
//If the answer contains CHOICE_ANSWER, it's a pre 1.5 backup
|
|
if (!empty($ans_info['#']['CHOICE_ANSWER']['0']['#'])) {
|
|
//optionid was, in pre 1.5 backups, choice_answer
|
|
$answer->optionid = backup_todb($ans_info['#']['CHOICE_ANSWER']['0']['#']);
|
|
}
|
|
|
|
//We have to recode the optionid field
|
|
$option = backup_getid($restore->backup_unique_code,"choice_options",$answer->optionid);
|
|
if ($option) {
|
|
$answer->optionid = $option->new_id;
|
|
}
|
|
|
|
//We have to recode the userid field
|
|
$user = backup_getid($restore->backup_unique_code,"user",$answer->userid);
|
|
if ($user) {
|
|
$answer->userid = $user->new_id;
|
|
}
|
|
|
|
//The structure is equal to the db, so insert the choice_answers
|
|
$newid = insert_record ("choice_answers",$answer);
|
|
|
|
//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,"choice_answers",$oldid,
|
|
$newid);
|
|
} else {
|
|
$status = false;
|
|
}
|
|
}
|
|
|
|
return $status;
|
|
}
|
|
|
|
//Return a content decoded to support interactivities linking. Every module
|
|
//should have its own. They are called automatically from
|
|
//choice_decode_content_links_caller() function in each module
|
|
//in the restore process
|
|
function choice_decode_content_links ($content,$restore) {
|
|
|
|
global $CFG;
|
|
|
|
$result = $content;
|
|
|
|
//Link to the list of choices
|
|
|
|
$searchstring='/\$@(CHOICEINDEX)\*([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='/\$@(CHOICEINDEX)\*('.$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/choice/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/choice/index.php?id='.$old_id,$result);
|
|
}
|
|
}
|
|
}
|
|
|
|
//Link to choice view by moduleid
|
|
|
|
$searchstring='/\$@(CHOICEVIEWBYID)\*([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='/\$@(CHOICEVIEWBYID)\*('.$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/choice/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/choice/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 choice_decode_content_links_caller($restore) {
|
|
global $CFG;
|
|
$status = true;
|
|
|
|
if ($choices = get_records_sql ("SELECT c.id, c.text
|
|
FROM {$CFG->prefix}choice c
|
|
WHERE c.course = $restore->course_id")) {
|
|
//Iterate over each choice->text
|
|
$i = 0; //Counter to send some output to the browser to avoid timeouts
|
|
foreach ($choices as $choice) {
|
|
//Increment counter
|
|
$i++;
|
|
$content = $choice->text;
|
|
$result = restore_decode_content_links_worker($content,$restore);
|
|
if ($result != $content) {
|
|
//Update record
|
|
$choice->text = addslashes($result);
|
|
$status = update_record("choice",$choice);
|
|
if (debugging()) {
|
|
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 choice_restore_wiki2markdown ($restore) {
|
|
|
|
global $CFG;
|
|
|
|
$status = true;
|
|
|
|
//Convert choice->text
|
|
if ($records = get_records_sql ("SELECT c.id, c.text, c.format
|
|
FROM {$CFG->prefix}choice c,
|
|
{$CFG->prefix}backup_ids b
|
|
WHERE c.course = $restore->course_id AND
|
|
c.format = ".FORMAT_WIKI. " AND
|
|
b.backup_code = $restore->backup_unique_code AND
|
|
b.table_name = 'choice' AND
|
|
b.new_id = c.id")) {
|
|
foreach ($records as $record) {
|
|
//Rebuild wiki links
|
|
$record->text = restore_decode_wiki_content($record->text, $restore);
|
|
//Convert to Markdown
|
|
$wtm = new WikiToMarkdown();
|
|
$record->text = $wtm->convert($record->text, $restore->course_id);
|
|
$record->format = FORMAT_MARKDOWN;
|
|
$status = update_record('choice', 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 choice_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 "choose":
|
|
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 "choose again":
|
|
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 "report":
|
|
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 = "report.php?id=".$log->cmid;
|
|
$log->info = $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;
|
|
}
|
|
?>
|