[Summary view]

   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   * Standard log reader/writer.
  19   *
  20   * @package    logstore_standard
  21   * @copyright  2014 Petr Skoda {@link http://skodak.org}
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace logstore_standard\task;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  class cleanup_task extends \core\task\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('taskcleanup', 'logstore_standard');
  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 = (int)get_config('logstore_standard', 'loglifetime');
  48  
  49          if (empty($loglifetime) || $loglifetime < 0) {
  50              return;
  51          }
  52  
  53          $loglifetime = time() - ($loglifetime * 3600 * 24); // Value in days.
  54          $lifetimep = array($loglifetime);
  55          $start = time();
  56  
  57          while ($min = $DB->get_field_select("logstore_standard_log", "MIN(timecreated)", "timecreated < ?", $lifetimep)) {
  58              // Break this down into chunks to avoid transaction for too long and generally thrashing database.
  59              // Experiments suggest deleting one day takes up to a few seconds; probably a reasonable chunk size usually.
  60              // If the cleanup has just been enabled, it might take e.g a month to clean the years of logs.
  61              $params = array(min($min + 3600 * 24, $loglifetime));
  62              $DB->delete_records_select("logstore_standard_log", "timecreated < ?", $params);
  63              if (time() > $start + 300) {
  64                  // Do not churn on log deletion for too long each run.
  65                  break;
  66              }
  67          }
  68  
  69          mtrace(" Deleted old log records from standard store.");
  70      }
  71  }