mod/data/backuplib.php

   1 <?php
   2
   3 //This php script contains all the stuff to backup/restore data mod
   4
   5     //This is the "graphical" structure of the data mod:
   6     //
   7     //                     data
   8     //                    (CL,pk->id)
   9     //                        |
  10     //                        |
  11     //                        |
  12     //      ---------------------------------------------------------------------------------
  13     //      |                                                                               |
  14     //data_records (UL,pk->id, fk->data)                                      data_fields (pk->id, fk->data)
  15     //               |                                                                      |
  16     //               |                                                                      |
  17     //     -----------------------------------------------------------------------------    |
  18     //     |                                  |                                        |    |
  19     //data_ratings(fk->recordid, pk->id) data_comments (fk->recordid, pk->id)          |    |
  20     //                                                                  data_content(pk->id, fk->recordid, fk->fieldid)
  21     //
  22     //
  23     //
  24     // Meaning: pk->primary key field of the table
  25     //          fk->foreign key to link with parent
  26     //          nt->nested field (recursive data)
  27     //          CL->course level info
  28     //          UL->user level info
  29     //          files->table may have files)
  30     //
  31     //-----------------------------------------------------------
  32
  33     //Backup data files because we've selected to backup user info
  34     //and files are user info's level
  35
  36
  37     //Return a content encoded to support interactivities linking. Every module
  38
  39 function data_backup_mods($bf,$preferences) {
  40     global $CFG;
  41
  42     $status = true;
  43
  44     // iterate
  45     if ($datas = get_records('data','course',$preferences->backup_course,"id")) {
  46         foreach ($datas as $data) {
  47            if (function_exists('backup_mod_selected')) {
  48                     // Moodle 1.6
  49                     $backup_mod_selected = backup_mod_selected($preferences, 'data', $data->id);
  50             } else {
  51                     // Moodle 1.5
  52                 $backup_mod_selected = true;
  53             }
  54             if ($backup_mod_selected) {
  55                 $status = data_backup_one_mod($bf,$preferences,$data);
  56                 // backup files happens in backup_one_mod now too.
  57             }
  58         }
  59     }
  60     return $status;
  61 }
  62
  63 function data_backup_one_mod($bf,$preferences,$data) {
  64     global $CFG;
  65
  66     if (is_numeric($data)) { // backwards compatibility
  67         $data = get_record('data','id',$data);
  68     }
  69     $instanceid = $data->id;
  70
  71     $status = true;
  72
  73
  74     fwrite ($bf,start_tag("MOD",3,true));
  75     //Print data data
  76     fwrite ($bf,full_tag("ID",4,false,$data->id));
  77     fwrite ($bf,full_tag("MODTYPE",4,false,"data"));
  78     fwrite ($bf,full_tag("NAME",4,false,$data->name));
  79     fwrite ($bf,full_tag("INTRO",4,false,$data->intro));
  80     fwrite ($bf,full_tag("COMMENTS",4,false,$data->comments));
  81     fwrite ($bf,full_tag("TIMEAVAILABLEFROM",4,false,$data->timeavailablefrom));
  82     fwrite ($bf,full_tag("TIMEAVAILABLETO",4,false,$data->timeavailableto));
  83     fwrite ($bf,full_tag("TIMEVIEWFROM",4,false,$data->timeviewfrom));
  84     fwrite ($bf,full_tag("TIMEVIEWTO",4,false,$data->timeviewto));
  85     fwrite ($bf,full_tag("REQUIREDENTRIES",4,false,$data->requiredentries));
  86     fwrite ($bf,full_tag("REQUIREDENTRIESTOVIEW",4,false,$data->requiredentriestoview));
  87     fwrite ($bf,full_tag("MAXENTRIES",4,false,$data->maxentries));
  88     fwrite ($bf,full_tag("RSSARTICLES",4,false,$data->rssarticles));
  89     fwrite ($bf,full_tag("SINGLETEMPLATE",4,false,$data->singletemplate));
  90     fwrite ($bf,full_tag("LISTTEMPLATE",4,false,$data->listtemplate));
  91     fwrite ($bf,full_tag("LISTTEMPLATEHEADER",4,false,$data->listtemplateheader));
  92     fwrite ($bf,full_tag("LISTTEMPLATEFOOTER",4,false,$data->listtemplatefooter));
  93     fwrite ($bf,full_tag("ADDTEMPLATE",4,false,$data->addtemplate));
  94     fwrite ($bf,full_tag("RSSTEMPLATE",4,false,$data->rsstemplate));
  95     fwrite ($bf,full_tag("RSSTITLETEMPLATE",4,false,$data->rsstitletemplate));
  96     fwrite ($bf,full_tag("CSSTEMPLATE",4,false,$data->csstemplate));
  97     fwrite ($bf,full_tag("JSTEMPLATE",4,false,$data->jstemplate));
  98     fwrite ($bf,full_tag("APPROVAL",4,false,$data->approval));
  99     fwrite ($bf,full_tag("SCALE",4,false,$data->scale));
 100     fwrite ($bf,full_tag("ASSESSED",4,false,$data->assessed));
 101
 102     // if we've selected to backup users info, then call any other functions we need
 103     // including backing up individual files
 104
 105     $status = backup_data_fields($bf,$preferences,$data->id);
 106
 107     if (backup_userdata_selected($preferences,'data',$data->id)) {
 108         //$status = backup_someuserdata_for_this_instance();
 109         //$status = backup_somefiles_for_this_instance();
 110         // ... etc
 111
 112         $status = backup_data_records($bf,$preferences,$data->id);
 113         if ($status) {
 114             $status = backup_data_files_instance($bf,$preferences,$data->id);    //recursive copy
 115         }
 116     }
 117     fwrite ($bf,end_tag("MOD",3,true));
 118     return $status;
 119
 120 }
 121
 122
 123 function backup_data_fields($bf,$preferences,$dataid){
 124     global $CFG;
 125     $status = true;
 126
 127     $data_fields = get_records("data_fields","dataid",$dataid);
 128
 129         //If there is submissions
 130         if ($data_fields) {
 131             //Write start tag
 132             $status =fwrite ($bf,start_tag("FIELDS",4,true));
 133             //Iterate over each submission
 134             foreach ($data_fields as $fie_sub) {
 135                 //Start submission
 136                 $status =fwrite ($bf,start_tag("FIELD",5,true));
 137                 //Print submission contents
 138                 fwrite ($bf,full_tag("ID",6,false,$fie_sub->id));
 139                 fwrite ($bf,full_tag("DATAID",6,false,$fie_sub->dataid));
 140                 fwrite ($bf,full_tag("TYPE",6,false,$fie_sub->type));
 141                 fwrite ($bf,full_tag("NAME",6,false,$fie_sub->name));
 142                 fwrite ($bf,full_tag("DESCRIPTION",6,false,$fie_sub->description));
 143                 fwrite ($bf,full_tag("PARAM1",6,false,$fie_sub->param1));
 144                 fwrite ($bf,full_tag("PARAM2",6,false,$fie_sub->param2));
 145                 fwrite ($bf,full_tag("PARAM3",6,false,$fie_sub->param3));
 146                 fwrite ($bf,full_tag("PARAM4",6,false,$fie_sub->param4));
 147                 fwrite ($bf,full_tag("PARAM5",6,false,$fie_sub->param5));
 148                 fwrite ($bf,full_tag("PARAM6",6,false,$fie_sub->param6));
 149                 fwrite ($bf,full_tag("PARAM7",6,false,$fie_sub->param7));
 150                 fwrite ($bf,full_tag("PARAM8",6,false,$fie_sub->param8));
 151                 fwrite ($bf,full_tag("PARAM9",6,false,$fie_sub->param9));
 152                 fwrite ($bf,full_tag("PARAM10",6,false,$fie_sub->param10));
 153
 154                 //End submission
 155                 $status =fwrite ($bf,end_tag("FIELD",5,true));
 156             }
 157             //Write end tag
 158             $status =fwrite ($bf,end_tag("FIELDS",4,true));
 159         }
 160         return $status;
 161 }
 162
 163 function backup_data_content($bf,$preferences,$recordid){
 164     global $CFG;
 165     $status = true;
 166
 167     $data_contents = get_records("data_content","recordid",$recordid);
 168
 169         //If there is submissions
 170         if ($data_contents) {
 171             //Write start tag
 172             $status =fwrite ($bf,start_tag("CONTENTS",6,true));
 173             //Iterate over each submission
 174             foreach ($data_contents as $cnt_sub) {
 175                 //Start submission
 176                 $status =fwrite ($bf,start_tag("CONTENT",7,true));
 177                 //Print submission contents
 178                 fwrite ($bf,full_tag("ID",8,false,$cnt_sub->id));
 179                 fwrite ($bf,full_tag("RECORDID",8,false,$cnt_sub->recordid));
 180                 fwrite ($bf,full_tag("FIELDID",8,false,$cnt_sub->fieldid));
 181                 fwrite ($bf,full_tag("CONTENT",8,false,$cnt_sub->content));
 182                 fwrite ($bf,full_tag("CONTENT1",8,false,$cnt_sub->content1));
 183                 fwrite ($bf,full_tag("CONTENT2",8,false,$cnt_sub->content2));
 184                 fwrite ($bf,full_tag("CONTENT3",8,false,$cnt_sub->content3));
 185                 fwrite ($bf,full_tag("CONTENT4",8,false,$cnt_sub->content4));
 186                 //End submission
 187                 $status =fwrite ($bf,end_tag("CONTENT",7,true));
 188             }
 189             //Write end tag
 190             $status =fwrite ($bf,end_tag("CONTENTS",6,true));
 191         }
 192         return $status;
 193
 194 }
 195 function backup_data_ratings($bf,$preferences,$recordid){
 196     global $CFG;
 197     $status = true;
 198     $data_ratings = get_records("data_ratings","recordid",$recordid);
 199
 200     //If there is submissions
 201     if ($data_ratings) {
 202         //Write start tag
 203         $status =fwrite ($bf,start_tag("RATINGS",6,true));
 204         //Iterate over each submission
 205         foreach ($data_ratings as $rat_sub) {
 206             //Start submission
 207             $status =fwrite ($bf,start_tag("RATING",7,true));
 208             //Print submission contents
 209             fwrite ($bf,full_tag("ID",8,false,$rat_sub->id));
 210             fwrite ($bf,full_tag("RECORDID",8,false,$rat_sub->recordid));
 211             fwrite ($bf,full_tag("USERID",8,false,$rat_sub->userid));
 212             fwrite ($bf,full_tag("RATING",8,false,$rat_sub->rating));
 213             //End submission
 214             $status =fwrite ($bf,end_tag("RATING",7,true));
 215         }
 216             //Write end tag
 217         $status =fwrite ($bf,end_tag("RATINGS",6,true));
 218
 219     }
 220
 221     return $status;
 222 }
 223 function backup_data_comments($bf,$preferences,$recordid){
 224     global $CFG;
 225     $status = true;
 226     $data_comments = get_records("data_comments","recordid",$recordid);
 227
 228     //If there is submissions
 229     if ($data_comments) {
 230         //Write start tag
 231         $status =fwrite ($bf,start_tag("COMMENTS",6,true));
 232             //Iterate over each submission
 233         foreach ($data_comments as $com_sub) {
 234             //Start submission
 235             $status =fwrite ($bf,start_tag("COMMENT",7,true));
 236             //Print submission contents
 237             fwrite ($bf,full_tag("ID",8,false,$com_sub->id));
 238             fwrite ($bf,full_tag("RECORDID",8,false,$com_sub->recordid));
 239             fwrite ($bf,full_tag("USERID",8,false,$com_sub->userid));
 240             fwrite ($bf,full_tag("CONTENT",8,false,$com_sub->content));
 241             fwrite ($bf,full_tag("CREATED",8,false,$com_sub->created));
 242             fwrite ($bf,full_tag("MODIFIED",8,false,$com_sub->modified));
 243             //End submission
 244             $status =fwrite ($bf,end_tag("COMMENT",7,true));
 245         }
 246         //Write end tag
 247         $status =fwrite ($bf,end_tag("COMMENTS",6,true));
 248     }
 249     return $status;
 250 }
 251
 252
 253 function backup_data_files_instance($bf,$preferences,$instanceid) {
 254
 255     global $CFG;
 256     $status = true;
 257
 258         //First we check to moddata exists and create it as necessary
 259         //in temp/backup/$backup_code  dir
 260     $status = check_and_create_moddata_dir($preferences->backup_unique_code);
 261     $status = check_dir_exists($CFG->dataroot."/temp/backup/".$preferences->backup_unique_code."/moddata/data/",true);
 262         //Now copy the data dir
 263     if ($status) {
 264             //Only if it exists !! Thanks to Daniel Miksik.
 265         if (is_dir($CFG->dataroot."/".$preferences->backup_course."/".$CFG->moddata."/data/".$instanceid)) {
 266             $status = backup_copy_file($CFG->dataroot."/".$preferences->backup_course."/".$CFG->moddata."/data/".$instanceid,
 267                                            $CFG->dataroot."/temp/backup/".$preferences->backup_unique_code."/moddata/data/".$instanceid);
 268         }
 269     }
 270     return $status;
 271 }
 272
 273 function backup_data_records($bf,$preferences,$dataid){
 274
 275     global $CFG;
 276     $status = true;
 277
 278     $data_records = get_records("data_records","dataid",$dataid);
 279         //If there is submissions
 280         if ($data_records) {
 281             //Write start tag
 282             $status =fwrite ($bf,start_tag("RECORDS",4,true));
 283             //Iterate over each submission
 284             foreach ($data_records as $rec_sub) {
 285                 //Start submission
 286                 $status =fwrite ($bf,start_tag("RECORD",5,true));
 287                 //Print submission contents
 288                 fwrite ($bf,full_tag("ID",6,false,$rec_sub->id));
 289                 fwrite ($bf,full_tag("USERID",6,false,$rec_sub->userid));
 290                 fwrite ($bf,full_tag("GROUPID",6,false,$rec_sub->groupid));
 291                 fwrite ($bf,full_tag("DATAID",6,false,$rec_sub->dataid));
 292                 fwrite ($bf,full_tag("TIMECREATED",6,false,$rec_sub->timecreated));
 293                 fwrite ($bf,full_tag("TIMEMODIFIED",6,false,$rec_sub->timemodified));
 294                 fwrite ($bf,full_tag("APPROVED",6,false,$rec_sub->approved));
 295                 //End submission
 296
 297                 backup_data_content($bf,$preferences,$rec_sub->id);
 298                 backup_data_ratings($bf,$preferences,$rec_sub->id);
 299                 backup_data_comments($bf,$preferences,$rec_sub->id);
 300
 301                 $status =fwrite ($bf,end_tag("RECORD",5,true));
 302             }
 303             //Write end tag
 304             $status =fwrite ($bf,end_tag("RECORDS",4,true));
 305         }
 306         return $status;
 307
 308 }
 309
 310 function backup_data_files($bf,$preferences) {
 311
 312     global $CFG;
 313
 314     $status = true;
 315
 316         //First we check to moddata exists and create it as necessary
 317         //in temp/backup/$backup_code  dir
 318     $status = check_and_create_moddata_dir($preferences->backup_unique_code);
 319         //Now copy the data dir
 320     if ($status) {
 321             //Only if it exists !! Thanks to Daniel Miksik.
 322         if (is_dir($CFG->dataroot."/".$preferences->backup_course."/".$CFG->moddata."/data")) {
 323             $status = backup_copy_file($CFG->dataroot."/".$preferences->backup_course."/".$CFG->moddata."/data",
 324                                                $CFG->dataroot."/temp/backup/".$preferences->backup_unique_code."/moddata/data");
 325         }
 326     }
 327
 328     return $status;
 329 }
 330
 331 function backup_data_file_instance($bf,$preferences,$instanceid) {
 332
 333     global $CFG;
 334     $status = true;
 335
 336         //First we check to moddata exists and create it as necessary
 337         //in temp/backup/$backup_code  dir
 338     $status = check_and_create_moddata_dir($preferences->backup_unique_code);
 339     $status = check_dir_exists($CFG->dataroot."/temp/backup/".$preferences->backup_unique_code."/moddata/data/",true);
 340         //Now copy the data dir
 341     if ($status) {
 342             //Only if it exists !! Thanks to Daniel Miksik.
 343         if (is_dir($CFG->dataroot."/".$preferences->backup_course."/".$CFG->moddata."/data/".$instanceid)) {
 344             $status = backup_copy_file($CFG->dataroot."/".$preferences->backup_course."/".$CFG->moddata."/data/".$instanceid,
 345                                            $CFG->dataroot."/temp/backup/".$preferences->backup_unique_code."/moddata/data/".$instanceid);
 346         }
 347     }
 348     return $status;
 349 }
 350
 351 function data_check_backup_mods_instances($instance,$backup_unique_code) {
 352     $info[$instance->id.'0'][0] = '<b>'.$instance->name.'</b>';
 353     $info[$instance->id.'0'][1] = '';
 354     if (!empty($instance->userdata)) {
 355         // any other needed stuff
 356     }
 357     return $info;
 358 }
 359
 360 function data_check_backup_mods($course,$user_data=false,$backup_unique_code,$instances=null) {
 361     if (!empty($instances) && is_array($instances) && count($instances)) {
 362         $info = array();
 363         foreach ($instances as $id => $instance) {
 364             $info += data_check_backup_mods_instances($instance,$backup_unique_code);
 365         }
 366         return $info;
 367     }
 368
 369     // otherwise continue as normal
 370     //First the course data
 371     $info[0][0] = get_string("modulenameplural","data");
 372     if ($ids = data_ids ($course)) {
 373         $info[0][1] = count($ids);
 374     } else {
 375         $info[0][1] = 0;
 376     }
 377
 378     //Now, if requested, the user_data
 379     if ($user_data) {
 380         // any other needed stuff
 381     }
 382     return $info;
 383
 384 }
 385
 386 function data_ids($course) {
 387     // stub function, return number of modules
 388     return 1;
 389 }