Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.10.x will end 8 November 2021 (12 months).
  • Bug fixes for security issues in 3.10.x will end 9 May 2022 (18 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.

Differences Between: [Versions 310 and 311] [Versions 310 and 400] [Versions 310 and 401] [Versions 310 and 402] [Versions 310 and 403]

   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  /**
  27   * Simple task to delete old backup records.
  28   */
  29  class backup_cleanup_task extends scheduled_task {
  30  
  31      /**
  32       * Get a descriptive name for this task (shown to admins).
  33       *
  34       * @return string
  35       */
  36      public function get_name() {
  37          return get_string('taskbackupcleanup', 'admin');
  38      }
  39  
  40      /**
  41       * Do the job.
  42       * Throw exceptions on errors (the job will be retried).
  43       */
  44      public function execute() {
  45          global $DB;
  46  
  47          $loglifetime = get_config('backup', 'loglifetime');
  48  
  49          if (empty($loglifetime)) {
  50              throw new coding_exception('The \'loglifetime\' config is not set. Can\'t proceed and delete old backup records.');
  51          }
  52  
  53          // First, get the list of all backupids older than loglifetime.
  54          $timecreated = time() - ($loglifetime * DAYSECS);
  55          $records = $DB->get_records_select('backup_controllers', 'timecreated < ?', array($timecreated), 'id', 'id, backupid');
  56  
  57          foreach ($records as $record) {
  58              // Check if there is no incomplete adhoc task relying on the given backupid.
  59              $params = array('%' . $record->backupid . '%');
  60              $select = $DB->sql_like('customdata', '?', false);
  61              $count = $DB->count_records_select('task_adhoc',  $select, $params);
  62              if ($count === 0) {
  63                  // Looks like there is no adhoc task, so we can delete logs and controllers for this backupid.
  64                  $DB->delete_records('backup_logs', array('backupid' => $record->backupid));
  65                  $DB->delete_records('backup_controllers', array('backupid' => $record->backupid));
  66              }
  67          }
  68      }
  69  
  70  }