mod/data/restorelib.php

   1 <?php
   2 //This php script contains all the stuff to backup/restore data mod
   3
   4     //This is the "graphical" structure of the data mod:
   5     //
   6     //                     data
   7     //                    (CL,pk->id)
   8     //                        |
   9     //                        |
  10     //                        |
  11     //      ---------------------------------------------------------------------------------
  12     //      |                                                                               |
  13     //data_records (UL,pk->id, fk->data)                                      data_fields (pk->id, fk->data)
  14     //               |                                                                      |
  15     //               |                                                                      |
  16     //     -----------------------------------------------------------------------------    |
  17     //     |                                  |                                        |    |
  18     //data_ratings(fk->recordid, pk->id) data_comments (fk->recordid, pk->id)          |    |
  19     //                                                                  data_content(pk->id, fk->recordid, fk->fieldid)
  20     //
  21     //
  22     //
  23     // Meaning: pk->primary key field of the table
  24     //          fk->foreign key to link with parent
  25     //          nt->nested field (recursive data)
  26     //          CL->course level info
  27     //          UL->user level info
  28     //          files->table may have files)
  29     //
  30     //-----------------------------------------------------------
  31
  32     //Backup data files because we've selected to backup user info
  33     //and files are user info's level
  34
  35 $fieldids = array();    //array in the format of $fieldids[$oldid]=$newid. This is needed because of double dependencies of multiple tables.
  36
  37
  38     //Return a content encoded to support interactivities linking. Every module
  39 function data_restore_mods($mod,$restore) {
  40
  41     global $CFG;
  42
  43     $status = true;
  44
  45     $data = backup_getid($restore->backup_unique_code,$mod->modtype,$mod->id);
  46
  47     if ($data) {
  48         //Now get completed xmlized object
  49         $info = $data->info;
  50         // if necessary, write to restorelog and adjust date/time fields
  51         if ($restore->course_startdateoffset) {
  52             restore_log_date_changes('Database', $restore, $info['MOD']['#'], array('TIMEAVAILABLEFROM', 'TIMEAVAILABLETO','TIMEVIEWFROM', 'TIMEVIEWTO'));
  53         }
  54         //traverse_xmlize($info);                                                                     //Debug
  55         //print_object ($GLOBALS['traverse_array']);                                                  //Debug
  56         //$GLOBALS['traverse_array']="";                                                              //Debug
  57
  58         $database->course = $restore->course_id;
  59
  60         $database->name = backup_todb($info['MOD']['#']['NAME']['0']['#']);
  61         $database->intro = backup_todb($info['MOD']['#']['INTRO']['0']['#']);
  62         // Only relevant for restoring backups from 1.6 in a 1.7 install.
  63         if (isset($info['MOD']['#']['RATINGS']['0']['#'])) {
  64             $database->ratings = backup_todb($info['MOD']['#']['RATINGS']['0']['#']);
  65         }
  66         $database->comments = backup_todb($info['MOD']['#']['COMMENTS']['0']['#']);
  67         $database->timeavailablefrom = backup_todb($info['MOD']['#']['TIMEAVAILABLEFROM']['0']['#']);
  68         $database->timeavailableto = backup_todb($info['MOD']['#']['TIMEAVAILABLETO']['0']['#']);
  69         $database->timeviewfrom = backup_todb($info['MOD']['#']['TIMEVIEWFROM']['0']['#']);
  70         $database->timeviewto = backup_todb($info['MOD']['#']['TIMEVIEWTO']['0']['#']);
  71         // Only relevant for restoring backups from 1.6 in a 1.7 install.
  72         if (isset($info['MOD']['#']['PARTICIPANTS']['0']['#'])) {
  73             $database->participants = backup_todb($info['MOD']['#']['PARTICIPANTS']['0']['#']);
  74         }
  75         $database->requiredentries = backup_todb($info['MOD']['#']['REQUIREDENTRIES']['0']['#']);
  76         $database->requiredentriestoview = backup_todb($info['MOD']['#']['REQUIREDENTRIESTOVIEW']['0']['#']);
  77         $database->maxentries = backup_todb($info['MOD']['#']['MAXENTRIES']['0']['#']);
  78         $database->rssarticles = backup_todb($info['MOD']['#']['RSSARTICLES']['0']['#']);
  79         $database->singletemplate = backup_todb($info['MOD']['#']['SINGLETEMPLATE']['0']['#']);
  80         $database->listtemplate = backup_todb($info['MOD']['#']['LISTTEMPLATE']['0']['#']);
  81         $database->listtemplateheader = backup_todb($info['MOD']['#']['LISTTEMPLATEHEADER']['0']['#']);
  82         $database->listtemplatefooter = backup_todb($info['MOD']['#']['LISTTEMPLATEFOOTER']['0']['#']);
  83         $database->addtemplate = backup_todb($info['MOD']['#']['ADDTEMPLATE']['0']['#']);
  84         $database->rsstemplate = backup_todb($info['MOD']['#']['RSSTEMPLATE']['0']['#']);
  85         $database->rsstitletemplate = backup_todb($info['MOD']['#']['RSSTITLETEMPLATE']['0']['#']);
  86         $database->csstemplate = backup_todb($info['MOD']['#']['CSSTEMPLATE']['0']['#']);
  87         $database->jstemplate = backup_todb($info['MOD']['#']['JSTEMPLATE']['0']['#']);
  88         $database->approval = backup_todb($info['MOD']['#']['APPROVAL']['0']['#']);
  89         $database->scale = backup_todb($info['MOD']['#']['SCALE']['0']['#']);
  90         $database->assessed = backup_todb($info['MOD']['#']['ASSESSED']['0']['#']);
  91         // Only relevant for restoring backups from 1.6 in a 1.7 install.
  92         if (isset($info['MOD']['#']['ASSESSPUBLIC']['0']['#'])) {
  93             $database->assesspublic = backup_todb($info['MOD']['#']['ASSESSPUBLIC']['0']['#']);
  94         }
  95
  96         $newid = insert_record ('data', $database);
  97
  98         //Do some output
  99         if (!defined('RESTORE_SILENTLY')) {
 100             echo "<li>".get_string("modulename","data")." \"".format_string(stripslashes($database->name),true)."\"</li>";
 101         }
 102
 103         if ($newid) {
 104             //We have the newid, update backup_ids
 105             backup_putid($restore->backup_unique_code,$mod->modtype,
 106                              $mod->id, $newid);
 107             //Now check if want to restore user data and do it.
 108             if (function_exists('restore_userdata_selected')) {
 109                 // Moodle 1.6
 110                 $restore_userdata_selected = restore_userdata_selected($restore, 'data', $mod->id);
 111             } else {
 112                 // Moodle 1.5
 113                 $restore_userdata_selected = $restore->mods['data']->userinfo;
 114             }
 115
 116             //Restore data_fields first!!! need to hold an array of [oldid]=>newid due to double dependencies
 117             $status = $status and data_fields_restore_mods ($mod->id, $newid, $info, $restore);
 118
 119             if ($restore_userdata_selected) {
 120                 $status = $status and data_records_restore_mods ($mod->id, $newid, $info, $restore);
 121             }
 122
 123             // If the backup contained $data->participants, $data->assesspublic
 124             // and $data->groupmode, we need to convert the data to use Roles.
 125             // It means the backup was made pre Moodle 1.7. We check the
 126             // backup_version to make sure.
 127             if (isset($database->participants) && isset($database->assesspublic)) {
 128
 129                 if (!$teacherroles = get_roles_with_capability('moodle/legacy:teacher', CAP_ALLOW)) {
 130                       notice('Default teacher role was not found. Roles and permissions '.
 131                              'for your database modules will have to be manually set.');
 132                 }
 133                 if (!$studentroles = get_roles_with_capability('moodle/legacy:student', CAP_ALLOW)) {
 134                       notice('Default student role was not found. Roles and permissions '.
 135                              'for all your database modules will have to be manually set.');
 136                 }
 137                 if (!$guestroles = get_roles_with_capability('moodle/legacy:guest', CAP_ALLOW)) {
 138                       notice('Default guest role was not found. Roles and permissions '.
 139                              'for all your database modules will have to be manually set.');
 140                 }
 141                 require_once($CFG->dirroot.'/mod/data/lib.php');
 142                 data_convert_to_roles($database, $teacherroles, $studentroles,
 143                                       $restore->mods['data']->instances[$mod->id]->restored_as_course_module);
 144             }
 145
 146         } else {
 147             $status = false;
 148         }
 149     } else {
 150         $status = false;
 151     }
 152
 153     return $status;
 154 }
 155
 156 function data_fields_restore_mods ($old_data_id, $new_data_id, $info, $restore) {
 157
 158     global $CFG, $fieldids;
 159
 160
 161     $fields = $info['MOD']['#']['FIELDS']['0']['#']['FIELD'];
 162
 163     for ($i = 0; $i < sizeof($fields); $i++) {
 164
 165         $fie_info = $fields[$i];
 166         $oldid = backup_todb($fie_info['#']['ID']['0']['#']);
 167
 168         $field -> dataid = $new_data_id;
 169         $field -> type = backup_todb($fie_info['#']['TYPE']['0']['#']);
 170         $field -> name = backup_todb($fie_info['#']['NAME']['0']['#']);
 171         $field -> description = backup_todb($fie_info['#']['DESCRIPTION']['0']['#']);
 172         $field -> param1 = backup_todb($fie_info['#']['PARAM1']['0']['#']);
 173         $field -> param2 = backup_todb($fie_info['#']['PARAM2']['0']['#']);
 174         $field -> param3 = backup_todb($fie_info['#']['PARAM3']['0']['#']);
 175         $field -> param4 = backup_todb($fie_info['#']['PARAM4']['0']['#']);
 176         $field -> param5 = backup_todb($fie_info['#']['PARAM5']['0']['#']);
 177         $field -> param6 = backup_todb($fie_info['#']['PARAM6']['0']['#']);
 178         $field -> param7 = backup_todb($fie_info['#']['PARAM7']['0']['#']);
 179         $field -> param8 = backup_todb($fie_info['#']['PARAM8']['0']['#']);
 180         $field -> param9 = backup_todb($fie_info['#']['PARAM9']['0']['#']);
 181         $field -> param10 = backup_todb($fie_info['#']['PARAM10']['0']['#']);
 182
 183         $newid = insert_record ("data_fields",$field);
 184
 185         $fieldids[$oldid] = $newid;    //so we can use them in sub tables that depends on both fieldid and recordid
 186
 187         //Do some output
 188         if (($i+1) % 50 == 0) {
 189             if (!defined('RESTORE_SILENTLY')) {
 190                 echo ".";
 191                 if (($i+1) % 1000 == 0) {
 192                     echo "<br />";
 193                 }
 194             }
 195             backup_flush(300);
 196         }
 197
 198         if ($newid) {
 199             //We have the newid, update backup_ids
 200             $status = backup_putid($restore->backup_unique_code,"data_fields",$oldid, $newid);
 201         } else {
 202             $status = false;
 203         }
 204
 205     }
 206     return $status;
 207
 208 }
 209
 210 function data_records_restore_mods ($old_data_id, $new_data_id, $info, $restore) {
 211
 212     global $CFG, $fieldids;
 213
 214     $status = true;
 215
 216     $records = $info['MOD']['#']['RECORDS']['0']['#']['RECORD'];
 217
 218     for ($i = 0; $i < sizeof($records); $i++) {
 219
 220         $rec_info = $records[$i];
 221         $oldid = backup_todb($rec_info['#']['ID']['0']['#']);
 222
 223         $record = new object();
 224         $record -> dataid = $new_data_id;
 225         $record -> userid = backup_todb($rec_info['#']['USERID']['0']['#']);
 226         $record -> groupid = backup_todb($rec_info['#']['GROUPID']['0']['#']);
 227         $record -> timecreated = backup_todb($rec_info['#']['TIMECREATED']['0']['#']);
 228         $record -> timemodified = backup_todb($rec_info['#']['TIMEMODIFIED']['0']['#']);
 229         $record -> approved = backup_todb($rec_info['#']['APPROVED']['0']['#']);
 230         $user = backup_getid($restore->backup_unique_code,"user",$record->userid);
 231         $group= backup_getid($restore->backup_unique_code,"groups",$record->groupid);
 232
 233         if ($user) {
 234             $record->userid = $user->new_id;
 235         }
 236         if ($group) {
 237             $record->groupid= $group->new_id;
 238         }
 239
 240         $newid = insert_record ("data_records",$record);
 241
 242         //Do some output
 243         if (($i+1) % 50 == 0) {
 244             if (!defined('RESTORE_SILENTLY')) {
 245                 echo ".";
 246                 if (($i+1) % 1000 == 0) {
 247                     echo "<br />";
 248                 }
 249             }
 250             backup_flush(300);
 251         }
 252
 253         if ($newid) {
 254             //We have the newid, update backup_ids
 255             $status = $status and backup_putid($restore->backup_unique_code,"data_records",$oldid, $newid);
 256
 257             $status = $status and data_content_restore_mods ($oldid, $newid, $old_data_id, $new_data_id, $rec_info, $restore);
 258             $status = $status and data_ratings_restore_mods ($oldid, $newid, $info, $rec_info);
 259             $status = $status and data_comments_restore_mods ($oldid, $newid, $info, $rec_info);
 260
 261         } else {
 262             $status = false;
 263         }
 264     }
 265     return $status;
 266 }
 267
 268 function data_content_restore_mods ($old_record_id, $new_record_id, $old_data_id, $new_data_id, $recinfo, $restore) {
 269
 270     global $CFG, $fieldids;
 271
 272     $status = true;
 273
 274     $contents = $recinfo['#']['CONTENTS']['0']['#']['CONTENT'];
 275
 276     for ($i = 0; $i < sizeof($contents); $i++) {
 277
 278         $con_info = $contents[$i];
 279         $oldid = backup_todb($con_info['#']['ID']['0']['#']);
 280         $oldfieldid = backup_todb($con_info['#']['FIELDID']['0']['#']);
 281         $oldrecordid = backup_todb($con_info['#']['RECORDID']['0']['#']);
 282
 283         $content -> recordid = $new_record_id;
 284         $content -> fieldid = $fieldids[$oldfieldid];
 285         $content -> content = backup_todb($con_info['#']['CONTENT']['0']['#']);
 286         $content -> content1 = backup_todb($con_info['#']['CONTENT1']['0']['#']);
 287         $content -> content2 = backup_todb($con_info['#']['CONTENT2']['0']['#']);
 288         $content -> content3 = backup_todb($con_info['#']['CONTENT3']['0']['#']);
 289         $content -> content4 = backup_todb($con_info['#']['CONTENT4']['0']['#']);
 290         $newid = insert_record ("data_content",$content);
 291
 292         //Do some output
 293         if (($i+1) % 50 == 0) {
 294             if (!defined('RESTORE_SILENTLY')) {
 295                 echo ".";
 296                 if (($i+1) % 1000 == 0) {
 297                     echo "<br />";
 298                 }
 299             }
 300             backup_flush(300);
 301         }
 302
 303         if ($newid) {
 304             //We have the newid, update backup_ids
 305
 306             $status = $status and data_restore_files ($old_data_id, $new_data_id, $oldfieldid, $content->fieldid, $oldrecordid, $content->recordid, $recinfo, $restore);
 307             $status = $status and backup_putid($restore->backup_unique_code,"data_content",$oldid, $newid);
 308         } else {
 309             $status = false;
 310         }
 311     }
 312     return $status;
 313 }
 314
 315
 316 function data_restore_files ($old_data_id, $new_data_id, $old_field_id, $new_field_id, $old_record_id, $new_record_id, $recinfo, $restore) {
 317
 318     global $CFG, $db;
 319
 320     $status = true;
 321     $todo = false;
 322     $moddata_path = "";
 323     $data_path = "";
 324     $temp_path = "";
 325
 326     //First, we check to "course_id" exists and create is as necessary
 327     //in CFG->dataroot
 328     $dest_dir = $CFG->dataroot."/".$restore->course_id;
 329     $status = check_dir_exists($dest_dir,true);
 330
 331     //Now, locate course's moddata directory
 332     $moddata_path = $CFG->dataroot."/".$restore->course_id."/".$CFG->moddata;
 333
 334     //Check it exists and create it
 335     $status = check_dir_exists($moddata_path,true);
 336
 337     //Now, locate data directory
 338     if ($status) {
 339         $data_path = $moddata_path."/data";
 340         //Check it exists and create it
 341         $status = check_dir_exists($data_path,true);
 342     }
 343
 344     //Now locate the temp dir we are gong to restore
 345     if ($status) {
 346         $temp_path = $CFG->dataroot."/temp/backup/".$restore->backup_unique_code.
 347                     "/moddata/data/".$old_data_id."/".$old_field_id."/".$old_record_id;
 348         $todo = check_dir_exists($temp_path);
 349     }
 350
 351     //If todo, we create the neccesary dirs in course moddata/data
 352     if ($status and $todo) {
 353         //First this data id
 354         $this_data_path = $data_path."/".$new_data_id;
 355
 356         $status = check_dir_exists($this_data_path,true);
 357         //Now this user id
 358         $this_field_path = $this_data_path."/".$new_field_id;
 359         $status = check_dir_exists($this_field_path,true);
 360         $this_record_path = $this_field_path = $this_field_path."/".$new_record_id;
 361         $status = check_dir_exists($this_record_path,true);
 362         //And now, copy temp_path to user_data_path
 363
 364         $status = @backup_copy_file($temp_path, $this_record_path);
 365     }
 366
 367     return $status;
 368 }
 369
 370 function data_ratings_restore_mods ($oldid, $newid, $info, $rec_info) {
 371
 372     global $CFG;
 373
 374     $status = true;
 375
 376     $ratings= $rec_info['#']['RATINGS']['0']['#']['RATING'];
 377
 378     if (empty($ratings)) { // no ratings to restore
 379         return true;
 380     }
 381     for ($i = 0; $i < sizeof($ratings); $i++) {
 382
 383         $rat_info = $ratings[$i];
 384
 385         $rating -> recordid = $newid;
 386         $rating -> userid = backup_todb($rat_info['#']['USERID']['0']['#']);
 387         $rating -> rating = backup_todb($rat_info['#']['RATING']['0']['#']);
 388
 389         if (! insert_record ("data_ratings",$rating)) {
 390             $status = false;
 391         }
 392     }
 393     return $status;
 394 }
 395
 396 function data_comments_restore_mods ($oldid, $newid, $info, $rec_info) {
 397
 398     global $CFG;
 399
 400     $status = true;
 401
 402     $comments= $rec_info['#']['COMMENTS']['0']['#']['COMMENT'];
 403
 404     if (empty($comments)) { // no comments to restore
 405         return true;
 406     }
 407
 408     for ($i = 0; $i < sizeof($comments); $i++) {
 409
 410         $com_info = $comments[$i];
 411
 412         $comment -> recordid = $newid;
 413         $comment -> userid = backup_todb($com_info['#']['USERID']['0']['#']);
 414         $comment -> content = backup_todb($com_info['#']['CONTENT']['0']['#']);
 415         $comment -> created = backup_todb($com_info['#']['CREATED']['0']['#']);
 416         $comment -> modified = backup_todb($com_info['#']['MODIFIED']['0']['#']);
 417         if (! insert_record ("data_comments",$comment)) {
 418             $status = false;
 419         }
 420
 421     }
 422     return $status;
 423
 424 }
 425 ?>