backup/backup_scheduled.php

   1 <?php //$Id$
   2     //This file contains all the code needed to execute scheduled backups
   3
   4 //This function is executed via moodle cron
   5 //It prepares all the info and execute backups as necessary
   6 function schedule_backup_cron() {
   7
   8     global $CFG;
   9
  10     $status = true;
  11
  12     $emailpending = false;
  13
  14     //Check for required functions...
  15     if(!function_exists('utf8_encode')) {
  16         mtrace("        ERROR: You need to add XML support to your PHP installation!");
  17         return true;
  18     }
  19
  20     //Get now
  21     $now = time();
  22
  23     //First of all, we have to see if the scheduled is active and detect
  24     //that there isn't another cron running
  25     mtrace("    Checking backup status",'...');
  26     $backup_config = backup_get_config();
  27     if(!isset($backup_config->backup_sche_active) || !$backup_config->backup_sche_active) {
  28         mtrace("INACTIVE");
  29         return true;
  30     } else if (isset($backup_config->backup_sche_running) && $backup_config->backup_sche_running) {
  31         mtrace("RUNNING");
  32         //Now check if it's a really running task or something very old looking
  33         //for info in backup_logs to unlock status as necessary
  34         $timetosee = 1800;   //Half an hour looking for activity
  35         $timeafter = time() - $timetosee;
  36         $numofrec = count_records_select ("backup_log","time > $timeafter");
  37         if (!$numofrec) {
  38             $timetoseemin = $timetosee/60;
  39             mtrace("    No activity in last ".$timetoseemin." minutes. Unlocking status");
  40         } else {
  41             mtrace("    Scheduled backup seems to be running. Execution delayed");
  42             return true;
  43         }
  44     } else {
  45         mtrace("OK");
  46         //Mark backup_sche_running
  47         backup_set_config("backup_sche_running","1");
  48     }
  49
  50     //Now we get the main admin user (we'll use his timezone, mail...)
  51     mtrace("    Getting admin info");
  52     $admin = get_admin();
  53     if (!$admin) {
  54         $status = false;
  55     }
  56
  57     //Delete old_entries from backup tables
  58     if ($status) {
  59         mtrace("    Deleting old data");
  60         $status = backup_delete_old_data();
  61     }
  62
  63     //Now we get a list of courses in the server
  64     if ($status) {
  65         mtrace("    Checking courses");
  66         //First of all, we delete everything from backup tables related to deleted courses
  67         mtrace("        Skipping deleted courses");
  68         $skipped = 0;
  69         if ($bckcourses = get_records('backup_courses')) {
  70             foreach($bckcourses as $bckcourse) {
  71                 //Search if it exists
  72                 if (!$exists = get_record('course', 'id', "$bckcourse->courseid")) {
  73                     //Doesn't exist, so delete from backup tables
  74                     delete_records('backup_courses', 'courseid', "$bckcourse->courseid");
  75                     delete_records('backup_log', 'courseid', "$bckcourse->courseid");
  76                     $skipped++;
  77                 }
  78             }
  79         }
  80         mtrace("            $skipped courses");
  81         //Now process existing courses
  82         $courses = get_records("course");
  83         //For each course, we check (insert, update) the backup_course table
  84         //with needed data
  85         foreach ($courses as $course) {
  86             if ($status) {
  87                 mtrace("        $course->fullname");
  88                 //We check if the course exists in backup_course
  89                 $backup_course = get_record("backup_courses","courseid",$course->id);
  90                 //If it doesn't exist, create
  91                 if (!$backup_course) {
  92                     $temp_backup_course->courseid = $course->id;
  93                     $newid = insert_record("backup_courses",$temp_backup_course);
  94                     //And get it from db
  95                     $backup_course = get_record("backup_courses","id",$newid);
  96                 }
  97                 //If it doesn't exist now, error
  98                 if (!$backup_course) {
  99                     mtrace("            ERROR (in backup_courses detection)");
 100                     $status = false;
 101                     continue;
 102                 }
 103                 // Skip backup of unavailable courses that have remained unmodified in a month
 104                 $skipped = false;
 105                 if (!$course->visible && ($now - $course->timemodified) > 31*24*60*60) {  //Hidden + unmodified last month
 106                     mtrace("            SKIPPING - hidden+unmodified");
 107                     set_field("backup_courses","laststatus","3","courseid",$backup_course->courseid);
 108                     $skipped = true;
 109                 }
 110                 //Now we backup every non skipped course with nextstarttime < now
 111                 if (!$skipped  && $backup_course->nextstarttime > 0 && $backup_course->nextstarttime < $now) {
 112                     //We have to send a email because we have included at least one backup
 113                     $emailpending = true;
 114                     //Only make the backup if laststatus isn't 2-UNFINISHED (uncontrolled error)
 115                     if ($backup_course->laststatus != 2) {
 116                         //Set laststarttime
 117                         $starttime = time();
 118                         set_field("backup_courses","laststarttime",$starttime,"courseid",$backup_course->courseid);
 119                         //Set course status to unfinished, the process will reset it
 120                         set_field("backup_courses","laststatus","2","courseid",$backup_course->courseid);
 121                         //Launch backup
 122                         $course_status = schedule_backup_launch_backup($course,$starttime);
 123                         //Set lastendtime
 124                         set_field("backup_courses","lastendtime",time(),"courseid",$backup_course->courseid);
 125                         //Set laststatus
 126                         if ($course_status) {
 127                             set_field("backup_courses","laststatus","1","courseid",$backup_course->courseid);
 128                         } else {
 129                             set_field("backup_courses","laststatus","0","courseid",$backup_course->courseid);
 130                         }
 131                     }
 132                 }
 133
 134                 //Now, calculate next execution of the course
 135                 $nextstarttime = schedule_backup_next_execution ($backup_course,$backup_config,$now,$admin->timezone);
 136                 //Save it to db
 137                 set_field("backup_courses","nextstarttime",$nextstarttime,"courseid",$backup_course->courseid);
 138                 //Print it to screen as necessary
 139                 $showtime = "undefined";
 140                 if ($nextstarttime > 0) {
 141                     $showtime = userdate($nextstarttime,"",$admin->timezone);
 142                 }
 143                 mtrace("            Next execution: $showtime");
 144             }
 145         }
 146     }
 147
 148     //Delete old logs
 149     if (!empty($CFG->loglifetime)) {
 150         mtrace("    Deleting old logs");
 151         $loglifetime = $now - ($CFG->loglifetime * 86400);
 152         delete_records_select("backup_log", "laststarttime < '$loglifetime'");
 153     }
 154
 155     //Send email to admin if necessary
 156     if ($emailpending) {
 157         mtrace("    Sending email to admin");
 158         $message = "";
 159
 160         //Get info about the status of courses
 161         $count_all = count_records('backup_courses');
 162         $count_ok = count_records('backup_courses','laststatus','1');
 163         $count_error = count_records('backup_courses','laststatus','0');
 164         $count_unfinished = count_records('backup_courses','laststatus','2');
 165         $count_skipped = count_records('backup_courses','laststatus','3');
 166
 167         //Build the message text
 168         //Summary
 169         $message .= get_string('summary')."\n";
 170         $message .= "==================================================\n";
 171         $message .= "  ".get_string('courses').": ".$count_all."\n";
 172         $message .= "  ".get_string('ok').": ".$count_ok."\n";
 173         $message .= "  ".get_string('skipped').": ".$count_skipped."\n";
 174         $message .= "  ".get_string('error').": ".$count_error."\n";
 175         $message .= "  ".get_string('unfinished').": ".$count_unfinished."\n\n";
 176
 177         //Reference
 178         if ($count_error != 0 || $count_unfinished != 0) {
 179             $message .= "  ".get_string('backupfailed')."\n\n";
 180             $dest_url = $CFG->wwwroot.'/backup/log.php';
 181             $message .= "  ".get_string('backuptakealook','',$dest_url)."\n\n";
 182             //Set message priority
 183             $admin->priority = 1;
 184             //Reset unfinished to error
 185             set_field('backup_courses','laststatus','0','laststatus','2');
 186         } else {
 187             $message .= "  ".get_string('backupfinished')."\n";
 188         }
 189
 190         //Build the message subject
 191         $site = get_site();
 192         $prefix = $site->shortname.": ";
 193         if ($count_error != 0 || $count_unfinished != 0) {
 194             $prefix .= "[".strtoupper(get_string('error'))."] ";
 195         }
 196         $subject = $prefix.get_string("scheduledbackupstatus");
 197
 198         //Send the message
 199         email_to_user($admin,$admin,$subject,$message);
 200     }
 201
 202
 203     //Everything is finished stop backup_sche_running
 204     backup_set_config("backup_sche_running","0");
 205
 206     return $status;
 207 }
 208
 209 //This function executes the ENTIRE backup of a course (passed as parameter)
 210 //using all the scheduled backup preferences
 211 function schedule_backup_launch_backup($course,$starttime = 0) {
 212
 213     $preferences = false;
 214     $status = false;
 215
 216     mtrace("            Executing backup");
 217     schedule_backup_log($starttime,$course->id,"Start backup course $course->fullname");
 218     schedule_backup_log($starttime,$course->id,"  Phase 1: Checking and counting:");
 219     $preferences = schedule_backup_course_configure($course,$starttime);
 220
 221     if ($preferences) {
 222         schedule_backup_log($starttime,$course->id,"  Phase 2: Executing and copying:");
 223         $status = schedule_backup_course_execute($preferences,$starttime);
 224     }
 225
 226     if ($status && $preferences) {
 227         //Only if the backup_sche_keep is set
 228         if ($preferences->backup_keep) {
 229             schedule_backup_log($starttime,$course->id,"  Phase 3: Deleting old backup files:");
 230             $status = schedule_backup_course_delete_old_files($preferences,$starttime);
 231         }
 232     }
 233
 234     if ($status && $preferences) {
 235         mtrace("            End backup OK");
 236         schedule_backup_log($starttime,$course->id,"End backup course $course->fullname - OK");
 237     } else {
 238         mtrace("            End backup with ERROR");
 239         schedule_backup_log($starttime,$course->id,"End backup course $course->fullname - ERROR!!");
 240     }
 241
 242     return $status && $preferences;
 243 }
 244
 245 //This function saves to backup_log all the needed process info
 246 //to use it later.  NOTE: If $starttime = 0 no info in saved
 247 function schedule_backup_log($starttime,$courseid,$message) {
 248
 249     if ($starttime) {
 250         $log->courseid = $courseid;
 251         $log->time = time();
 252         $log->laststarttime = $starttime;
 253         $log->info = addslashes($message);
 254
 255         insert_record ("backup_log",$log);
 256     }
 257
 258 }
 259
 260 //This function returns the next future GMT time to execute the course based in the
 261 //configuration of the scheduled backups
 262 function schedule_backup_next_execution ($backup_course,$backup_config,$now,$timezone) {
 263
 264     $result = -1;
 265
 266     //Get today's midnight GMT
 267     $midnight = usergetmidnight($now,$timezone);
 268
 269     //Get today's day of week (0=Sunday...6=Saturday)
 270     $date = usergetdate($now,$timezone);
 271     $dayofweek = $date['wday'];
 272
 273     //Get number of days (from today) to execute backups
 274     $scheduled_days = substr($backup_config->backup_sche_weekdays,$dayofweek).
 275                       $backup_config->backup_sche_weekdays;
 276     $daysfromtoday = strpos($scheduled_days, "1");
 277
 278     //If some day has been found
 279     if ($daysfromtoday !== false) {
 280         //Calculate distance
 281         $dist = ($daysfromtoday * 86400) +                     //Days distance
 282                 ($backup_config->backup_sche_hour*3600) +      //Hours distance
 283                 ($backup_config->backup_sche_minute*60);       //Minutes distance
 284         $result = $midnight + $dist;
 285     }
 286
 287     //If that time is past, call the function recursively to obtain the next valid day
 288     if ($result > 0 && $result < time()) {
 289         $result = schedule_backup_next_execution ($backup_course,$backup_config,$now + 86400,$timezone);
 290     }
 291
 292     return $result;
 293 }
 294
 295
 296
 297 //This function implements all the needed code to prepare a course
 298 //to be in backup (insert temp info into backup temp tables).
 299 function schedule_backup_course_configure($course,$starttime = 0) {
 300
 301     global $CFG;
 302
 303     $status = true;
 304
 305     schedule_backup_log($starttime,$course->id,"    checking parameters");
 306
 307     //Check the required variable
 308     if (empty($course->id)) {
 309         $status = false;
 310     }
 311     //Get scheduled backup preferences
 312     $backup_config =  backup_get_config();
 313
 314     //Checks backup_config pairs exist
 315     if ($status) {
 316         if (!isset($backup_config->backup_sche_modules)) {
 317             $backup_config->backup_sche_modules = 1;
 318         }
 319         if (!isset($backup_config->backup_sche_withuserdata)) {
 320             $backup_config->backup_sche_withuserdata = 1;
 321         }
 322         if (!isset($backup_config->backup_sche_metacourse)) {
 323             $backup_config->backup_sche_metacourse = 1;
 324         }
 325         if (!isset($backup_config->backup_sche_users)) {
 326             $backup_config->backup_sche_users = 1;
 327         }
 328         if (!isset($backup_config->backup_sche_logs)) {
 329             $backup_config->backup_sche_logs = 0;
 330         }
 331         if (!isset($backup_config->backup_sche_userfiles)) {
 332             $backup_config->backup_sche_userfiles = 1;
 333         }
 334         if (!isset($backup_config->backup_sche_coursefiles)) {
 335             $backup_config->backup_sche_coursefiles = 1;
 336         }
 337         if (!isset($backup_config->backup_sche_messages)) {
 338             $backup_config->backup_sche_messages = 0;
 339         }
 340         if (!isset($backup_config->backup_sche_active)) {
 341             $backup_config->backup_sche_active = 0;
 342         }
 343         if (!isset($backup_config->backup_sche_weekdays)) {
 344             $backup_config->backup_sche_weekdays = "0000000";
 345         }
 346         if (!isset($backup_config->backup_sche_hour)) {
 347             $backup_config->backup_sche_hour = 00;
 348         }
 349         if (!isset($backup_config->backup_sche_minute)) {
 350             $backup_config->backup_sche_minute = 00;
 351         }
 352         if (!isset($backup_config->backup_sche_destination)) {
 353             $backup_config->backup_sche_destination = "";
 354         }
 355         if (!isset($backup_config->backup_sche_keep)) {
 356             $backup_config->backup_sche_keep = 1;
 357         }
 358     }
 359
 360     if ($status) {
 361        //Checks for the required files/functions to backup every mod
 362         //And check if there is data about it
 363         $count = 0;
 364         if ($allmods = get_records("modules") ) {
 365             foreach ($allmods as $mod) {
 366                 $modname = $mod->name;
 367                 $modfile = "$CFG->dirroot/mod/$modname/backuplib.php";
 368                 $modbackup = $modname."_backup_mods";
 369                 $modcheckbackup = $modname."_check_backup_mods";
 370                 if (file_exists($modfile)) {
 371                    include_once($modfile);
 372                    if (function_exists($modbackup) and function_exists($modcheckbackup)) {
 373                        $var = "exists_".$modname;
 374                        $$var = true;
 375                        $count++;
 376
 377                        // PENNY NOTES: I have moved from here to the closing brace inside
 378                        // by two sets of ifs()
 379                        // to avoid the backup failing on a non existant backup.
 380                        // If the file/function/whatever doesn't exist, we don't want to set this
 381                        // this module in backup preferences at all.
 382                        //Check data
 383                        //Check module info
 384                        $var = "backup_".$modname;
 385                        if (!isset($$var)) {
 386                            $$var = $backup_config->backup_sche_modules;
 387                        }
 388                        //Now stores all the mods preferences into an array into preferences
 389                        $preferences->mods[$modname]->backup = $$var;
 390
 391                        //Check include user info
 392                        $var = "backup_user_info_".$modname;
 393                        if (!isset($$var)) {
 394                            $$var = $backup_config->backup_sche_withuserdata;
 395                        }
 396                        //Now stores all the mods preferences into an array into preferences
 397                        $preferences->mods[$modname]->userinfo = $$var;
 398                        //And the name of the mod
 399                        $preferences->mods[$modname]->name = $modname;
 400                    }
 401                 }
 402             }
 403         }
 404         // now set instances
 405         if ($coursemods = get_course_mods($course->id)) {
 406             foreach ($coursemods as $mod) {
 407                 if (array_key_exists($mod->modname,$preferences->mods)) { // we are to backup this module
 408                     if (empty($preferences->mods[$mod->modname]->instances)) {
 409                         $preferences->mods[$mod->modname]->instances = array(); // avoid warnings
 410                     }
 411                     $preferences->mods[$mod->modname]->instances[$mod->instance]->backup = $preferences->mods[$mod->modname]->backup;
 412                     $preferences->mods[$mod->modname]->instances[$mod->instance]->userinfo = $preferences->mods[$mod->modname]->userinfo;
 413                     // there isn't really a nice way to do this...
 414                     $preferences->mods[$mod->modname]->instances[$mod->instance]->name = get_field($mod->modname,'name','id',$mod->instance);
 415                 }
 416             }
 417         }
 418     }
 419
 420     //Convert other parameters
 421     if ($status) {
 422         $preferences->backup_metacourse = $backup_config->backup_sche_metacourse;
 423         $preferences->backup_users = $backup_config->backup_sche_users;
 424         $preferences->backup_logs = $backup_config->backup_sche_logs;
 425         $preferences->backup_user_files = $backup_config->backup_sche_userfiles;
 426         $preferences->backup_course_files = $backup_config->backup_sche_coursefiles;
 427         $preferences->backup_messages = $backup_config->backup_sche_messages;
 428         $preferences->backup_course = $course->id;
 429         $preferences->backup_destination = $backup_config->backup_sche_destination;
 430         $preferences->backup_keep = $backup_config->backup_sche_keep;
 431     }
 432
 433     //Calculate the backup string
 434     if ($status) {
 435         schedule_backup_log($starttime,$course->id,"    calculating backup name");
 436
 437         //Calculate the backup word
 438         //Take off some characters in the filename !!
 439         $takeoff = array(" ", ":", "/", "\\", "|");
 440         $backup_word = str_replace($takeoff,"_",moodle_strtolower(get_string("backupfilename")));
 441         //If non-translated, use "backup"
 442         if (substr($backup_word,0,1) == "[") {
 443             $backup_word= "backup";
 444         }
 445
 446         //Calculate the date format string
 447         $backup_date_format = str_replace(" ","_",get_string("backupnameformat"));
 448         //If non-translated, use "%Y%m%d-%H%M"
 449         if (substr($backup_date_format,0,1) == "[") {
 450             $backup_date_format = "%%Y%%m%%d-%%H%%M";
 451         }
 452
 453         //Calculate the shortname
 454         $backup_shortname = clean_filename($course->shortname);
 455         if (empty($backup_shortname) or $backup_shortname == '_' ) {
 456             $backup_shortname = $course->id;
 457         }
 458
 459         //Calculate the final backup filename
 460         //The backup word
 461         $backup_name = $backup_word."-";
 462         //The shortname
 463         $backup_name .= moodle_strtolower($backup_shortname)."-";
 464         //The date format
 465         $backup_name .= userdate(time(),$backup_date_format,99,false);
 466         //The extension
 467         $backup_name .= ".zip";
 468         //And finally, clean everything
 469         $backup_name = clean_filename($backup_name);
 470
 471         //Calculate the string to match the keep preference
 472         $keep_name = $backup_word."-";
 473         //The shortname
 474         $keep_name .= moodle_strtolower($backup_shortname)."-";
 475         //And finally, clean everything
 476         $keep_name = clean_filename($keep_name);
 477
 478         $preferences->backup_name = $backup_name;
 479         $preferences->keep_name = $keep_name;
 480     }
 481
 482     //Calculate the backup unique code to allow simultaneus backups (to define
 483     //the temp-directory name and records in backup temp tables
 484     if ($status) {
 485         $backup_unique_code = time();
 486         $preferences->backup_unique_code = $backup_unique_code;
 487     }
 488
 489     //Calculate necesary info to backup modules
 490     if ($status) {
 491         schedule_backup_log($starttime,$course->id,"    calculating modules data");
 492         if ($allmods = get_records("modules") ) {
 493             foreach ($allmods as $mod) {
 494                 $modname = $mod->name;
 495                 $modbackup = $modname."_backup_mods";
 496                 //If exists the lib & function
 497                 $var = "exists_".$modname;
 498                 if (isset($$var) && $$var) {
 499                     //Add hidden fields
 500                     $var = "backup_".$modname;
 501                     //Only if selected
 502                     if ($$var == 1) {
 503                         $var = "backup_user_info_".$modname;
 504                         //Call the check function to show more info
 505                         $modcheckbackup = $modname."_check_backup_mods";
 506                         schedule_backup_log($starttime,$course->id,"      $modname");
 507                         $modcheckbackup($course->id,$$var,$backup_unique_code);
 508                     }
 509                 }
 510             }
 511         }
 512     }
 513
 514     //Now calculate the users
 515     if ($status) {
 516         schedule_backup_log($starttime,$course->id,"    calculating users");
 517         //Decide about include users with messages, based on SITEID
 518         if ($preferences->backup_messages && $preferences->backup_course == SITEID) {
 519             $include_message_users = true;
 520         } else {
 521             $include_message_users = false;
 522         }
 523         user_check_backup($course->id,$backup_unique_code,$preferences->backup_users,$include_message_users);
 524     }
 525
 526     //Now calculate the logs
 527     if ($status) {
 528         if ($preferences->backup_logs) {
 529             schedule_backup_log($starttime,$course->id,"    calculating logs");
 530             log_check_backup($course->id);
 531         }
 532     }
 533
 534     //Now calculate the userfiles
 535     if ($status) {
 536         if ($preferences->backup_user_files) {
 537             schedule_backup_log($starttime,$course->id,"    calculating user files");
 538             user_files_check_backup($course->id,$preferences->backup_unique_code);
 539         }
 540     }
 541
 542     //Now calculate the coursefiles
 543     if ($status) {
 544        if ($preferences->backup_course_files) {
 545             schedule_backup_log($starttime,$course->id,"    calculating course files");
 546             course_files_check_backup($course->id,$preferences->backup_unique_code);
 547         }
 548     }
 549
 550     //If everything is ok, return calculated preferences
 551     if ($status) {
 552         $status = $preferences;
 553     }
 554
 555     return $status;
 556 }
 557
 558 //This function implements all the needed code to backup a course
 559 //copying it to the desired destination (default if not specified)
 560 function schedule_backup_course_execute($preferences,$starttime = 0) {
 561
 562     global $CFG;
 563
 564     $status = true;
 565
 566     //Another Info to add
 567     $preferences->moodle_version = $CFG->version;
 568     $preferences->moodle_release = $CFG->release;
 569     $preferences->backup_version = $CFG->backup_version;
 570     $preferences->backup_release = $CFG->backup_release;
 571
 572     //Some parts of the backup doesn't know about $preferences, so we
 573     //put a copy of it inside that CFG (always global) to be able to
 574     //use it. Then, when needed I search for preferences inside CFG
 575     //Used to avoid some problems in full_tag() when preferences isn't
 576     //set globally (i.e. in scheduled backups)
 577     $CFG->backup_preferences = $preferences;
 578
 579     //Check for temp and backup and backup_unique_code directory
 580     //Create them as needed
 581     schedule_backup_log($starttime,$preferences->backup_course,"    checking temp structures");
 582     $status = check_and_create_backup_dir($preferences->backup_unique_code);
 583     //Empty backup dir
 584     if ($status) {
 585         schedule_backup_log($starttime,$preferences->backup_course,"    cleaning current dir");
 586         $status = clear_backup_dir($preferences->backup_unique_code);
 587     }
 588
 589     //Create the moodle.xml file
 590     if ($status) {
 591         schedule_backup_log($starttime,$preferences->backup_course,"    creating backup file");
 592         //Obtain the xml file (create and open) and print prolog information
 593         $backup_file = backup_open_xml($preferences->backup_unique_code);
 594         //Prints general info about backup to file
 595         if ($backup_file) {
 596             schedule_backup_log($starttime,$preferences->backup_course,"      general info");
 597             $status = backup_general_info($backup_file,$preferences);
 598         } else {
 599             $status = false;
 600         }
 601
 602         //Prints course start (tag and general info)
 603         if ($status) {
 604             $status = backup_course_start($backup_file,$preferences);
 605         }
 606
 607         //Metacourse information
 608         if ($status && $preferences->backup_metacourse) {
 609             schedule_backup_log($starttime,$preferences->backup_course,"      metacourse info");
 610             $status = backup_course_metacourse($backup_file,$preferences);
 611         }
 612
 613         //Block info
 614         if ($status) {
 615             schedule_backup_log($starttime,$preferences->backup_course,"      blocks info");
 616             $status = backup_course_blocks($backup_file,$preferences);
 617         }
 618
 619         //Section info
 620         if ($status) {
 621             schedule_backup_log($starttime,$preferences->backup_course,"      sections info");
 622             $status = backup_course_sections($backup_file,$preferences);
 623         }
 624
 625         //User info
 626         if ($status) {
 627             schedule_backup_log($starttime,$preferences->backup_course,"      user info");
 628             $status = backup_user_info($backup_file,$preferences);
 629         }
 630
 631         //If we have selected to backup messages and we are
 632         //doing a SITE backup, let's do it
 633         if ($status && $preferences->backup_messages && $preferences->backup_course == SITEID) {
 634             schedule_backup_log($starttime,$preferences->backup_course,"      messages");
 635             if (!$status = backup_messages($backup_file,$preferences)) {
 636                 notify("An error occurred while backing up messages");
 637             }
 638         }
 639
 640         //If we have selected to backup quizzes, backup categories and
 641         //questions structure (step 1). See notes on mod/quiz/backuplib.php
 642         if ($status and $preferences->mods['quiz']->backup) {
 643             schedule_backup_log($starttime,$preferences->backup_course,"      categories & questions");
 644             $status = backup_question_categories($backup_file,$preferences);
 645         }
 646
 647         //Print logs if selected
 648         if ($status) {
 649             if ($preferences->backup_logs) {
 650                 schedule_backup_log($starttime,$preferences->backup_course,"      logs");
 651                 $status = backup_log_info($backup_file,$preferences);
 652             }
 653         }
 654
 655         //Print scales info
 656         if ($status) {
 657             schedule_backup_log($starttime,$preferences->backup_course,"      scales");
 658             $status = backup_scales_info($backup_file,$preferences);
 659         }
 660
 661         //Print groups info
 662         if ($status) {
 663             schedule_backup_log($starttime,$preferences->backup_course,"      groups");
 664             $status = backup_groups_info($backup_file,$preferences);
 665         }
 666
 667         //Print events info
 668         if ($status) {
 669             schedule_backup_log($starttime,$preferences->backup_course,"      events");
 670             $status = backup_events_info($backup_file,$preferences);
 671         }
 672
 673         //Print gradebook info
 674         if ($status) {
 675             schedule_backup_log($starttime,$preferences->backup_course,"      gradebook");
 676             $status = backup_gradebook_info($backup_file,$preferences);
 677         }
 678
 679         //Module info, this unique function makes all the work!!
 680         //db export and module fileis copy
 681         if ($status) {
 682             $mods_to_backup = false;
 683             //Check if we have any mod to backup
 684             foreach ($preferences->mods as $module) {
 685                 if ($module->backup) {
 686                     $mods_to_backup = true;
 687                 }
 688             }
 689             //If we have to backup some module
 690             if ($mods_to_backup) {
 691                 schedule_backup_log($starttime,$preferences->backup_course,"      modules");
 692                 //Start modules tag
 693                 $status = backup_modules_start ($backup_file,$preferences);
 694                 //Iterate over modules and call backup
 695                 foreach ($preferences->mods as $module) {
 696                     if ($module->backup and $status) {
 697                         schedule_backup_log($starttime,$preferences->backup_course,"        $module->name");
 698                         $status = backup_module($backup_file,$preferences,$module->name);
 699                     }
 700                 }
 701                 //Close modules tag
 702                 $status = backup_modules_end ($backup_file,$preferences);
 703             }
 704         }
 705
 706         //Prints course end
 707         if ($status) {
 708             $status = backup_course_end($backup_file,$preferences);
 709         }
 710
 711         //Close the xml file and xml data
 712         if ($backup_file) {
 713             backup_close_xml($backup_file);
 714         }
 715     }
 716
 717     //Now, if selected, copy user files
 718     if ($status) {
 719         if ($preferences->backup_user_files) {
 720             schedule_backup_log($starttime,$preferences->backup_course,"    copying user files");
 721             $status = backup_copy_user_files ($preferences);
 722         }
 723     }
 724
 725     //Now, if selected, copy course files
 726     if ($status) {
 727         if ($preferences->backup_course_files) {
 728             schedule_backup_log($starttime,$preferences->backup_course,"    copying course files");
 729             $status = backup_copy_course_files ($preferences);
 730         }
 731     }
 732
 733     //Now, zip all the backup directory contents
 734     if ($status) {
 735         schedule_backup_log($starttime,$preferences->backup_course,"    zipping files");
 736         $status = backup_zip ($preferences);
 737     }
 738
 739     //Now, copy the zip file to course directory
 740     if ($status) {
 741         schedule_backup_log($starttime,$preferences->backup_course,"    copying backup");
 742         $status = copy_zip_to_course_dir ($preferences);
 743     }
 744
 745     //Now, clean temporary data (db and filesystem)
 746     if ($status) {
 747         schedule_backup_log($starttime,$preferences->backup_course,"    cleaning temp data");
 748         $status = clean_temp_data ($preferences);
 749     }
 750
 751     //Unset CFG->backup_preferences only needed in scheduled backups
 752     unset ($CFG->backup_preferences);
 753
 754     return $status;
 755 }
 756
 757 //This function deletes old backup files when the "keep" limit has been reached
 758 //in the destination directory.
 759 function schedule_backup_course_delete_old_files($preferences,$starttime=0) {
 760
 761     global $CFG;
 762
 763     $status = true;
 764
 765     //Calculate the directory to check
 766     $dirtocheck = "";
 767     //if $preferences->backup_destination isn't empty, then check that directory
 768     if (!empty($preferences->backup_destination)) {
 769         $dirtocheck = $preferences->backup_destination;
 770     //else calculate standard backup directory location
 771     } else {
 772         $dirtocheck = $CFG->dataroot."/".$preferences->backup_course."/backupdata";
 773     }
 774     schedule_backup_log($starttime,$preferences->backup_course,"    checking $dirtocheck");
 775     if ($CFG->debug > 7) {
 776         mtrace("            Keeping backup files in $dirtocheck");
 777     }
 778
 779     //Get all the files in $dirtocheck
 780     $files = get_directory_list($dirtocheck,"",false);
 781     //Get all matching files ($preferences->keep_name) from $files
 782     $matchingfiles = array();
 783     foreach ($files as $file) {
 784         if (substr($file, 0, strlen($preferences->keep_name)) == $preferences->keep_name) {
 785             $modifieddate = filemtime($dirtocheck."/".$file);
 786             $matchingfiles[$modifieddate] = $file;
 787         }
 788     }
 789     //Sort by key (modified date) to get the oldest first (instead of doing that by name
 790     //because it could give us problems in some languages with different format names).
 791     ksort($matchingfiles);
 792
 793     //Count matching files
 794     $countmatching = count($matchingfiles);
 795     schedule_backup_log($starttime,$preferences->backup_course,"        found $countmatching backup files");
 796     mtrace("                found $countmatching backup files");
 797     if ($preferences->backup_keep < $countmatching) {
 798         schedule_backup_log($starttime,$preferences->backup_course,"        keep limit ($preferences->backup_keep) reached. Deleting old files");
 799         mtrace("                keep limit ($preferences->backup_keep) reached. Deleting old files");
 800         $filestodelete = $countmatching - $preferences->backup_keep;
 801         $filesdeleted = 0;
 802         foreach ($matchingfiles as $matchfile) {
 803             if ($filesdeleted < $filestodelete) {
 804                 schedule_backup_log($starttime,$preferences->backup_course,"        $matchfile deleted");
 805                 mtrace("                $matchfile deleted");
 806                 $filetodelete = $dirtocheck."/".$matchfile;
 807                 unlink($filetodelete);
 808                 $filesdeleted++;
 809             }
 810         }
 811     }
 812     return $status;
 813 }
 814
 815 ?>