Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.

Differences Between: [Versions 310 and 401] [Versions 39 and 401]

   1  <?php
   2  // This file is part of Moodle - http://moodle.org/
   3  //
   4  // Moodle is free software: you can redistribute it and/or modify
   5  // it under the terms of the GNU General Public License as published by
   6  // the Free Software Foundation, either version 3 of the License, or
   7  // (at your option) any later version.
   8  //
   9  // Moodle is distributed in the hope that it will be useful,
  10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  // GNU General Public License for more details.
  13  //
  14  // You should have received a copy of the GNU General Public License
  15  // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16  
  17  /**
  18   * A scheduled task.
  19   *
  20   * @package    core
  21   * @copyright  2013 onwards Martin Dougiamas  http://dougiamas.com
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  namespace core\task;
  25  
  26  defined('MOODLE_INTERNAL') || die();
  27  
  28  require_once($CFG->dirroot . '/backup/util/includes/backup_includes.php');
  29  
  30  /**
  31   * Simple task to delete old backup records.
  32   */
  33  class backup_cleanup_task extends scheduled_task {
  34  
  35      /**
  36       * Get a descriptive name for this task (shown to admins).
  37       *
  38       * @return string
  39       */
  40      public function get_name() {
  41          return get_string('taskbackupcleanup', 'admin');
  42      }
  43  
  44      /**
  45       * Do the job.
  46       * Throw exceptions on errors (the job will be retried).
  47       */
  48      public function execute() {
  49          global $DB;
  50  
  51          $sql = 'SELECT * FROM {backup_controllers} WHERE purpose = ? AND status <> ?';
  52          $params = [\backup::MODE_COPY, \backup::STATUS_FINISHED_OK];
  53          $copyrecords = $DB->get_records_sql($sql, $params);
  54          \copy_helper::cleanup_orphaned_copy_controllers($copyrecords);
  55  
  56          $loglifetime = get_config('backup', 'loglifetime');
  57          if (empty($loglifetime)) {
  58              mtrace('The \'loglifetime\' config is not set. Can\'t proceed and delete old backup records.');
  59              return;
  60          }
  61  
  62          // First, get the list of all backupids older than loglifetime.
  63          $timecreated = time() - ($loglifetime * DAYSECS);
  64          $records = $DB->get_records_select('backup_controllers', 'timecreated < ?', array($timecreated), 'id', 'id, backupid');
  65  
  66          foreach ($records as $record) {
  67              // Check if there is no incomplete adhoc task relying on the given backupid.
  68              $params = array('%' . $record->backupid . '%');
  69              $select = $DB->sql_like('customdata', '?', false);
  70              $count = $DB->count_records_select('task_adhoc',  $select, $params);
  71              if ($count === 0) {
  72                  // Looks like there is no adhoc task, so we can delete logs and controllers for this backupid.
  73                  $DB->delete_records('backup_logs', array('backupid' => $record->backupid));
  74                  $DB->delete_records('backup_controllers', array('backupid' => $record->backupid));
  75              }
  76          }
  77  
  78          // Delete files and dirs older than 1 week.
  79          \backup_helper::delete_old_backup_dirs(strtotime('-1 week'));
  80      }
  81  
  82  }