[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   * A scheduled task for global search.
  19   *
  20   * @package    core
  21   * @copyright  2015 David Monllao {@link http://www.davidmonllao.com}
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  namespace core\task;
  25  
  26  /**
  27   * Runs global search indexing.
  28   *
  29   * @package    core
  30   * @copyright  2015 David Monllao {@link http://www.davidmonllao.com}
  31   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  32   */
  33  class search_index_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('taskglobalsearchindex', 'admin');
  42      }
  43  
  44      /**
  45       * Do the job.
  46       * Throw exceptions on errors (the job will be retried).
  47       */
  48      public function execute() {
  49          if (!\core_search\manager::is_indexing_enabled()) {
  50              return;
  51          }
  52          $globalsearch = \core_search\manager::instance();
  53  
  54          // Get total indexing time limit.
  55          $timelimit = get_config('core', 'searchindextime');
  56          $start = time();
  57  
  58          // Do normal indexing.
  59          $globalsearch->index(false, $timelimit, new \text_progress_trace());
  60  
  61          // Do requested indexing (if any) for the rest of the time.
  62          if ($timelimit != 0) {
  63              $now = time();
  64              $timelimit -= ($now - $start);
  65              if ($timelimit <= 1) {
  66                  // There is hardly any time left, so don't try to do requests.
  67                  return;
  68              }
  69          }
  70          $globalsearch->process_index_requests($timelimit, new \text_progress_trace());
  71      }
  72  }