id,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 resource_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 RESOURCE record structure
$resource->course = $restore->course_id;
$resource->name = backup_todb($info['MOD']['#']['NAME']['0']['#']);
$resource->type = $info['MOD']['#']['TYPE']['0']['#'];
$resource->reference = backup_todb($info['MOD']['#']['REFERENCE']['0']['#']);
$resource->summary = backup_todb($info['MOD']['#']['SUMMARY']['0']['#']);
$resource->alltext = backup_todb($info['MOD']['#']['ALLTEXT']['0']['#']);
$resource->popup = backup_todb($info['MOD']['#']['POPUP']['0']['#']);
$resource->options = backup_todb($info['MOD']['#']['OPTIONS']['0']['#']);
$resource->timemodified = $info['MOD']['#']['TIMEMODIFIED']['0']['#'];
//To mantain compatibility, in 1.4 the type and alltext meaning has changed and
//two new fields have arrived (popup and options). We have to modify somethigs
//if the popup field isn't present in the backup file to be upwards compatible.
if (! isset($info['MOD']['#']['POPUP']['0']['#'])) { //It's a pre-14 backup file
//Move alltext to popup in 3 and 5 resource types
if ($resource->type == 3 || $resource->type == 5) {
$resource->popup = $resource->alltext;
$resource->alltext = '';
}
//Move reference to alltext for references
if ($resource->type == 1) {
$resource->popup = '';
$resource->alltext = $resource->reference;
$resource->reference = '';
}
//Reencode the type field to its new values and fill the options field as needed
//Array 1-9 of new types
$types = array ('','html','file','file','text','file',
'html','file','text','directory');
//Array 1-9 of corresponding options
$options = array ('','','frame','','0','',
'','','3','');
//Make the conversion
$oldtype = $resource->type;
$resource->type = $types[$oldtype];
$resource->options = $options[$oldtype];
}
if ($resource->type == 'reference') { // Obsolete type of resource
$resource->type == 'html';
$resource->alltext = $resource->reference;
$resource->reference = '';
}
//The structure is equal to the db, so insert the resource
$newid = insert_record ("resource",$resource);
//Do some output
if (!defined('RESTORE_SILENTLY')) {
echo "
".get_string("modulename","resource")." \"".format_string(stripslashes($resource->name),true)."\"";
}
backup_flush(300);
if ($newid) {
//We have the newid, update backup_ids
backup_putid($restore->backup_unique_code,$mod->modtype,
$mod->id, $newid);
// restore any associated files...
if ($resource->type == 'file' || $resource->type == 'directory' || $resource->type == 'ims') {
resource_restore_files($mod->id,$newid,$resource,$restore);
}
} else {
$status = false;
}
} else {
$status = false;
}
return $status;
}
//Return a content decoded to support interactivities linking. Every module
//should have its own. They are called automatically from
//resource_decode_content_links_caller() function in each module
//in the restore process
function resource_decode_content_links ($content,$restore) {
global $CFG;
$result = $content;
//Link to the list of resources
$searchstring='/\$@(RESOURCEINDEX)\*([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='/\$@(RESOURCEINDEX)\*('.$old_id.')@\$/';
//If it is a link to this course, update the link to its new location
if (!empty($rec->new_id)) {
//Now replace it
$result= preg_replace($searchstring,$CFG->wwwroot.'/mod/resource/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/resource/index.php?id='.$old_id,$result);
}
}
}
//Link to resource view by moduleid
$searchstring='/\$@(RESOURCEVIEWBYID)\*([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='/\$@(RESOURCEVIEWBYID)\*('.$old_id.')@\$/';
//If it is a link to this course, update the link to its new location
if (!empty($rec->new_id)) {
//Now replace it
$result= preg_replace($searchstring,$CFG->wwwroot.'/mod/resource/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/resource/view.php?id='.$old_id,$result);
}
}
}
//Link to resource view by resourceid
$searchstring='/\$@(RESOURCEVIEWBYR)\*([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 (forum id)
$rec = backup_getid($restore->backup_unique_code,"resource",$old_id);
//Personalize the searchstring
$searchstring='/\$@(RESOURCEVIEWBYR)\*('.$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/resource/view.php?r='.$rec->new_id,$result);
} else {
//It's a foreign link so leave it as original
$result= preg_replace($searchstring,$restore->original_wwwroot.'/mod/resource/view.php?r='.$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 resource_decode_content_links_caller($restore) {
global $CFG;
$status = true;
if ($resources = get_records_sql ("SELECT r.id, r.alltext, r.summary, r.reference
FROM {$CFG->prefix}resource r
WHERE r.course = $restore->course_id")) {
$i = 0; //Counter to send some output to the browser to avoid timeouts
foreach ($resources as $resource) {
//Increment counter
$i++;
$content1 = $resource->alltext;
$content2 = $resource->summary;
$content3 = $resource->reference;
$result1 = restore_decode_content_links_worker($content1,$restore);
$result2 = restore_decode_content_links_worker($content2,$restore);
$result3 = restore_decode_content_links_worker($content3,$restore);
if ($result1 != $content1 || $result2 != $content2 || $result3 != $content3) {
//Update record
$resource->alltext = addslashes($result1);
$resource->summary = addslashes($result2);
$resource->reference = addslashes($result3);
$status = update_record("resource",$resource);
if (debugging()) {
if (!defined('RESTORE_SILENTLY')) {
echo '
'.s($content1).'
changed to
'.s($result1).'
';
echo '
'.s($content2).'
changed to
'.s($result2).'
';
echo '
'.s($content3).'
changed to
'.s($result3).'
';
}
}
}
//Do some output
if (($i+1) % 5 == 0) {
if (!defined('RESTORE_SILENTLY')) {
echo ".";
if (($i+1) % 100 == 0) {
echo "
";
}
}
backup_flush(300);
}
}
}
return $status;
}
//This function converts texts in FORMAT_WIKI to FORMAT_MARKDOWN for
//some texts in the module
function resource_restore_wiki2markdown ($restore) {
global $CFG;
$status = true;
//Convert resource->alltext
if ($records = get_records_sql ("SELECT r.id, r.alltext, r.options
FROM {$CFG->prefix}resource r,
{$CFG->prefix}backup_ids b
WHERE r.course = $restore->course_id AND
options = ".FORMAT_WIKI. " AND
b.backup_code = $restore->backup_unique_code AND
b.table_name = 'resource' AND
b.new_id = r.id")) {
foreach ($records as $record) {
//Rebuild wiki links
$record->alltext = restore_decode_wiki_content($record->alltext, $restore);
//Convert to Markdown
$wtm = new WikiToMarkdown();
$record->alltext = $wtm->convert($record->alltext, $restore->course_id);
$record->options = FORMAT_MARKDOWN;
$status = update_record('resource', addslashes_object($record));
//Do some output
$i++;
if (($i+1) % 1 == 0) {
if (!defined('RESTORE_SILENTLY')) {
echo ".";
if (($i+1) % 20 == 0) {
echo "
";
}
}
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 resource_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;
default:
if (!defined('RESTORE_SILENTLY')) {
echo "action (".$log->module."-".$log->action.") unknown. Not restored
"; //Debug
}
break;
}
if ($status) {
$status = $log;
}
return $status;
}
function resource_restore_files($oldid,$newid,$resource,$restore) {
global $CFG;
$status = true;
$status = check_dir_exists($CFG->dataroot."/".$restore->course_id,true);
// we need to do anything referenced by $resource->reference and anything in moddata/resource/instance
// do referenced files/dirs first.
$temp_path = $CFG->dataroot."/temp/backup/".$restore->backup_unique_code.'/course_files/'.$resource->reference;
if (file_exists($temp_path)) { // ok, it was backed up, restore it.
$new_path = $CFG->dataroot.'/'.$restore->course_id.'/'.$resource->reference;
// if this is somewhere deeply nested we need to do all the structure stuff first.....
$bits = explode('/',$resource->reference);
$newbit = '';
for ($i = 0; $i< count($bits)-1; $i++) {
$newbit .= $bits[$i].'/';
$status = $status && check_dir_exists($CFG->dataroot.'/'.$restore->course_id.'/'.$newbit,true);
}
$status = $status && backup_copy_file($temp_path,$new_path);
}
// and now for moddata.
$temp_path = $CFG->dataroot."/temp/backup/".$restore->backup_unique_code.
"/moddata/resource/".$oldid;
if (file_exists($temp_path)) { // there's something to back up, restore it.
$new_path = $CFG->dataroot."/".$restore->course_id."/".$CFG->moddata;
$status = $status && check_dir_exists($new_path,true);
$new_path .= '/resource';
$status = $status && check_dir_exists($new_path,true);
$new_path .= '/'.$newid;
$status = $status && backup_copy_file($temp_path,$new_path);
}
return $status;
}
?>