mod/resource/restorelib.php

   1 <?php //$Id$
   2     //This php script contains all the stuff to backup/restore
   3     //resource mods
   4
   5     //This is the "graphical" structure of the resource mod:
   6     //
   7     //                     resource
   8     //                 (CL,pk->id,files)
   9     //
  10     // Meaning: pk->primary key field of the table
  11     //          fk->foreign key to link with parent
  12     //          nt->nested field (recursive data)
  13     //          CL->course level info
  14     //          UL->user level info
  15     //          files->table may have files)
  16     //
  17     //-----------------------------------------------------------
  18
  19     //This function executes all the restore procedure about this mod
  20     function resource_restore_mods($mod,$restore) {
  21
  22         global $CFG;
  23
  24         $status = true;
  25
  26         //Get record from backup_ids
  27         $data = backup_getid($restore->backup_unique_code,$mod->modtype,$mod->id);
  28
  29         if ($data) {
  30             //Now get completed xmlized object
  31             $info = $data->info;
  32             //traverse_xmlize($info);                                                                     //Debug
  33             //print_object ($GLOBALS['traverse_array']);                                                  //Debug
  34             //$GLOBALS['traverse_array']="";                                                              //Debug
  35
  36             //Now, build the RESOURCE record structure
  37             $resource->course = $restore->course_id;
  38             $resource->name = backup_todb($info['MOD']['#']['NAME']['0']['#']);
  39             $resource->type = $info['MOD']['#']['TYPE']['0']['#'];
  40             $resource->reference = backup_todb($info['MOD']['#']['REFERENCE']['0']['#']);
  41             $resource->summary = backup_todb($info['MOD']['#']['SUMMARY']['0']['#']);
  42             $resource->alltext = backup_todb($info['MOD']['#']['ALLTEXT']['0']['#']);
  43             $resource->popup = backup_todb($info['MOD']['#']['POPUP']['0']['#']);
  44             $resource->options = backup_todb($info['MOD']['#']['OPTIONS']['0']['#']);
  45             $resource->timemodified = $info['MOD']['#']['TIMEMODIFIED']['0']['#'];
  46
  47             //To mantain compatibility, in 1.4 the type and alltext meaning has changed and
  48             //two new fields have arrived (popup and options). We have to modify somethigs
  49             //if the popup field isn't present in the backup file to be upwards compatible.
  50             if (! isset($info['MOD']['#']['POPUP']['0']['#'])) { //It's a pre-14 backup file
  51                 //Move alltext to popup in 3 and 5 resource types
  52                 if ($resource->type == 3 || $resource->type == 5) {
  53                     $resource->popup = $resource->alltext;
  54                     $resource->alltext = '';
  55                 }
  56                 //Move reference to alltext for references
  57                 if ($resource->type == 1) {
  58                     $resource->popup = '';
  59                     $resource->alltext = $resource->reference;
  60                     $resource->reference = '';
  61                 }
  62                 //Reencode the type field to its new values and fill the options field as needed
  63                 //Array 1-9 of new types
  64                 $types = array ('','html','file','file','text','file',
  65                                    'html','file','text','directory');
  66                 //Array 1-9 of corresponding options
  67                 $options = array ('','','frame','','0','',
  68                                      '','','3','');
  69                 //Make the conversion
  70                 $oldtype = $resource->type;
  71                 $resource->type = $types[$oldtype];
  72                 $resource->options = $options[$oldtype];
  73             }
  74
  75             if ($resource->type == 'reference') {   // Obsolete type of resource
  76                 $resource->type == 'html';
  77                 $resource->alltext = $resource->reference;
  78                 $resource->reference = '';
  79             }
  80
  81             //The structure is equal to the db, so insert the resource
  82             $newid = insert_record ("resource",$resource);
  83
  84             //Do some output
  85             if (!defined('RESTORE_SILENTLY')) {
  86                 echo "<li>".get_string("modulename","resource")." \"".format_string(stripslashes($resource->name),true)."\"</li>";
  87             }
  88             backup_flush(300);
  89
  90             if ($newid) {
  91                 //We have the newid, update backup_ids
  92                 backup_putid($restore->backup_unique_code,$mod->modtype,
  93                              $mod->id, $newid);
  94
  95                 // restore any associated files...
  96                 if ($resource->type == 'file' || $resource->type == 'directory' || $resource->type == 'ims') {
  97                     resource_restore_files($mod->id,$newid,$resource,$restore);
  98                 }
  99
 100             } else {
 101                 $status = false;
 102             }
 103         } else {
 104             $status = false;
 105         }
 106
 107         return $status;
 108     }
 109
 110     //Return a content decoded to support interactivities linking. Every module
 111     //should have its own. They are called automatically from
 112     //resource_decode_content_links_caller() function in each module
 113     //in the restore process
 114     function resource_decode_content_links ($content,$restore) {
 115
 116         global $CFG;
 117
 118         $result = $content;
 119
 120         //Link to the list of resources
 121
 122         $searchstring='/\$@(RESOURCEINDEX)\*([0-9]+)@\$/';
 123         //We look for it
 124         preg_match_all($searchstring,$content,$foundset);
 125         //If found, then we are going to look for its new id (in backup tables)
 126         if ($foundset[0]) {
 127             //print_object($foundset);                                     //Debug
 128             //Iterate over foundset[2]. They are the old_ids
 129             foreach($foundset[2] as $old_id) {
 130                 //We get the needed variables here (course id)
 131                 $rec = backup_getid($restore->backup_unique_code,"course",$old_id);
 132                 //Personalize the searchstring
 133                 $searchstring='/\$@(RESOURCEINDEX)\*('.$old_id.')@\$/';
 134                 //If it is a link to this course, update the link to its new location
 135                 if (!empty($rec->new_id)) {
 136                     //Now replace it
 137                     $result= preg_replace($searchstring,$CFG->wwwroot.'/mod/resource/index.php?id='.$rec->new_id,$result);
 138                 } else {
 139                     //It's a foreign link so leave it as original
 140                     $result= preg_replace($searchstring,$restore->original_wwwroot.'/mod/resource/index.php?id='.$old_id,$result);
 141                 }
 142             }
 143         }
 144
 145         //Link to resource view by moduleid
 146
 147         $searchstring='/\$@(RESOURCEVIEWBYID)\*([0-9]+)@\$/';
 148         //We look for it
 149         preg_match_all($searchstring,$result,$foundset);
 150         //If found, then we are going to look for its new id (in backup tables)
 151         if ($foundset[0]) {
 152             //print_object($foundset);                                     //Debug
 153             //Iterate over foundset[2]. They are the old_ids
 154             foreach($foundset[2] as $old_id) {
 155                 //We get the needed variables here (course_modules id)
 156                 $rec = backup_getid($restore->backup_unique_code,"course_modules",$old_id);
 157                 //Personalize the searchstring
 158                 $searchstring='/\$@(RESOURCEVIEWBYID)\*('.$old_id.')@\$/';
 159                 //If it is a link to this course, update the link to its new location
 160                 if (!empty($rec->new_id)) {
 161                     //Now replace it
 162                     $result= preg_replace($searchstring,$CFG->wwwroot.'/mod/resource/view.php?id='.$rec->new_id,$result);
 163                 } else {
 164                     //It's a foreign link so leave it as original
 165                     $result= preg_replace($searchstring,$restore->original_wwwroot.'/mod/resource/view.php?id='.$old_id,$result);
 166                 }
 167             }
 168         }
 169
 170         //Link to resource view by resourceid
 171
 172         $searchstring='/\$@(RESOURCEVIEWBYR)\*([0-9]+)@\$/';
 173         //We look for it
 174         preg_match_all($searchstring,$result,$foundset);
 175         //If found, then we are going to look for its new id (in backup tables)
 176         if ($foundset[0]) {
 177             //print_object($foundset);                                     //Debug
 178             //Iterate over foundset[2]. They are the old_ids
 179             foreach($foundset[2] as $old_id) {
 180                 //We get the needed variables here (forum id)
 181                 $rec = backup_getid($restore->backup_unique_code,"resource",$old_id);
 182                 //Personalize the searchstring
 183                 $searchstring='/\$@(RESOURCEVIEWBYR)\*('.$old_id.')@\$/';
 184                 //If it is a link to this course, update the link to its new location
 185                 if($rec->new_id) {
 186                     //Now replace it
 187                     $result= preg_replace($searchstring,$CFG->wwwroot.'/mod/resource/view.php?r='.$rec->new_id,$result);
 188                 } else {
 189                     //It's a foreign link so leave it as original
 190                     $result= preg_replace($searchstring,$restore->original_wwwroot.'/mod/resource/view.php?r='.$old_id,$result);
 191                 }
 192             }
 193         }
 194
 195         return $result;
 196     }
 197
 198     //This function makes all the necessary calls to xxxx_decode_content_links()
 199     //function in each module, passing them the desired contents to be decoded
 200     //from backup format to destination site/course in order to mantain inter-activities
 201     //working in the backup/restore process. It's called from restore_decode_content_links()
 202     //function in restore process
 203     function resource_decode_content_links_caller($restore) {
 204         global $CFG;
 205         $status = true;
 206
 207         if ($resources = get_records_sql ("SELECT r.id, r.alltext, r.summary, r.reference
 208                                    FROM {$CFG->prefix}resource r
 209                                    WHERE r.course = $restore->course_id")) {
 210
 211             $i = 0;   //Counter to send some output to the browser to avoid timeouts
 212             foreach ($resources as $resource) {
 213                 //Increment counter
 214                 $i++;
 215                 $content1 = $resource->alltext;
 216                 $content2 = $resource->summary;
 217                 $content3 = $resource->reference;
 218                 $result1 = restore_decode_content_links_worker($content1,$restore);
 219                 $result2 = restore_decode_content_links_worker($content2,$restore);
 220                 $result3 = restore_decode_content_links_worker($content3,$restore);
 221
 222                 if ($result1 != $content1 || $result2 != $content2 ||  $result3 != $content3) {
 223                     //Update record
 224                     $resource->alltext = addslashes($result1);
 225                     $resource->summary = addslashes($result2);
 226                     $resource->reference = addslashes($result3);
 227                     $status = update_record("resource",$resource);
 228                     if (debugging()) {
 229                         if (!defined('RESTORE_SILENTLY')) {
 230                             echo '<br /><hr />'.s($content1).'<br />changed to<br />'.s($result1).'<hr /><br />';
 231                             echo '<br /><hr />'.s($content2).'<br />changed to<br />'.s($result2).'<hr /><br />';
 232                             echo '<br /><hr />'.s($content3).'<br />changed to<br />'.s($result3).'<hr /><br />';
 233                         }
 234                     }
 235                 }
 236                 //Do some output
 237                 if (($i+1) % 5 == 0) {
 238                     if (!defined('RESTORE_SILENTLY')) {
 239                         echo ".";
 240                         if (($i+1) % 100 == 0) {
 241                             echo "<br />";
 242                         }
 243                     }
 244                     backup_flush(300);
 245                 }
 246             }
 247         }
 248         return $status;
 249     }
 250
 251     //This function converts texts in FORMAT_WIKI to FORMAT_MARKDOWN for
 252     //some texts in the module
 253     function resource_restore_wiki2markdown ($restore) {
 254
 255         global $CFG;
 256
 257         $status = true;
 258
 259         //Convert resource->alltext
 260         if ($records = get_records_sql ("SELECT r.id, r.alltext, r.options
 261                                          FROM {$CFG->prefix}resource r,
 262                                               {$CFG->prefix}backup_ids b
 263                                          WHERE r.course = $restore->course_id AND
 264                                                options = ".FORMAT_WIKI. " AND
 265                                                b.backup_code = $restore->backup_unique_code AND
 266                                                b.table_name = 'resource' AND
 267                                                b.new_id = r.id")) {
 268             foreach ($records as $record) {
 269                 //Rebuild wiki links
 270                 $record->alltext = restore_decode_wiki_content($record->alltext, $restore);
 271                 //Convert to Markdown
 272                 $wtm = new WikiToMarkdown();
 273                 $record->alltext = $wtm->convert($record->alltext, $restore->course_id);
 274                 $record->options = FORMAT_MARKDOWN;
 275                 $status = update_record('resource', addslashes_object($record));
 276                 //Do some output
 277                 $i++;
 278                 if (($i+1) % 1 == 0) {
 279                     if (!defined('RESTORE_SILENTLY')) {
 280                         echo ".";
 281                         if (($i+1) % 20 == 0) {
 282                             echo "<br />";
 283                         }
 284                     }
 285                     backup_flush(300);
 286                 }
 287             }
 288
 289         }
 290         return $status;
 291     }
 292
 293
 294     //This function returns a log record with all the necessay transformations
 295     //done. It's used by restore_log_module() to restore modules log.
 296     function resource_restore_logs($restore,$log) {
 297
 298         $status = false;
 299
 300         //Depending of the action, we recode different things
 301         switch ($log->action) {
 302         case "add":
 303             if ($log->cmid) {
 304                 //Get the new_id of the module (to recode the info field)
 305                 $mod = backup_getid($restore->backup_unique_code,$log->module,$log->info);
 306                 if ($mod) {
 307                     $log->url = "view.php?id=".$log->cmid;
 308                     $log->info = $mod->new_id;
 309                     $status = true;
 310                 }
 311             }
 312             break;
 313         case "update":
 314             if ($log->cmid) {
 315                 //Get the new_id of the module (to recode the info field)
 316                 $mod = backup_getid($restore->backup_unique_code,$log->module,$log->info);
 317                 if ($mod) {
 318                     $log->url = "view.php?id=".$log->cmid;
 319                     $log->info = $mod->new_id;
 320                     $status = true;
 321                 }
 322             }
 323             break;
 324         case "view":
 325             if ($log->cmid) {
 326                 //Get the new_id of the module (to recode the info field)
 327                 $mod = backup_getid($restore->backup_unique_code,$log->module,$log->info);
 328                 if ($mod) {
 329                     $log->url = "view.php?id=".$log->cmid;
 330                     $log->info = $mod->new_id;
 331                     $status = true;
 332                 }
 333             }
 334             break;
 335         case "view all":
 336             $log->url = "index.php?id=".$log->course;
 337             $status = true;
 338             break;
 339         default:
 340             if (!defined('RESTORE_SILENTLY')) {
 341                 echo "action (".$log->module."-".$log->action.") unknown. Not restored<br />";                 //Debug
 342             }
 343             break;
 344         }
 345
 346         if ($status) {
 347             $status = $log;
 348         }
 349         return $status;
 350     }
 351
 352     function resource_restore_files($oldid,$newid,$resource,$restore) {
 353         global $CFG;
 354
 355         $status = true;
 356         $status = check_dir_exists($CFG->dataroot."/".$restore->course_id,true);
 357
 358         // we need to do anything referenced by $resource->reference and anything in moddata/resource/instance
 359
 360         // do referenced files/dirs first.
 361         $temp_path = $CFG->dataroot."/temp/backup/".$restore->backup_unique_code.'/course_files/'.$resource->reference;
 362         if (file_exists($temp_path)) { // ok, it was backed up, restore it.
 363             $new_path = $CFG->dataroot.'/'.$restore->course_id.'/'.$resource->reference;
 364
 365             // if this is somewhere deeply nested we need to do all the structure stuff first.....
 366             $bits = explode('/',$resource->reference);
 367             $newbit = '';
 368             for ($i = 0; $i< count($bits)-1; $i++) {
 369                 $newbit .= $bits[$i].'/';
 370                 $status = $status && check_dir_exists($CFG->dataroot.'/'.$restore->course_id.'/'.$newbit,true);
 371             }
 372             $status = $status && backup_copy_file($temp_path,$new_path);
 373         }
 374
 375         // and now for moddata.
 376         $temp_path = $CFG->dataroot."/temp/backup/".$restore->backup_unique_code.
 377             "/moddata/resource/".$oldid;
 378         if (file_exists($temp_path)) { // there's something to back up, restore it.
 379             $new_path = $CFG->dataroot."/".$restore->course_id."/".$CFG->moddata;
 380             $status = $status && check_dir_exists($new_path,true);
 381             $new_path .= '/resource';
 382             $status = $status && check_dir_exists($new_path,true);
 383             $new_path .= '/'.$newid;
 384             $status = $status && backup_copy_file($temp_path,$new_path);
 385         }
 386         return $status;
 387     }
 388
 389 ?>