[Summary view] [Print] [Text 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   * User login failed event.
  19   *
  20   * @package    core
  21   * @copyright  2014 Rajesh Taneja <rajesh@moodle.com>
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace core\event;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  /**
  30   * User login failed event class.
  31   *
  32   * @property-read array $other {
  33   *      Extra information about event.
  34   *
  35   *      - string username: name of user.
  36   *      - int reason: failure reason.
  37   * }
  38   *
  39   * @package    core
  40   * @since      Moodle 2.7
  41   * @copyright  2014 Rajesh Taneja <rajesh@moodle.com>
  42   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  43   */
  44  class user_login_failed extends base {
  45      /**
  46       * Init method.
  47       *
  48       * @return void
  49       */
  50      protected function init() {
  51          $this->context = \context_system::instance();
  52          $this->data['crud'] = 'r';
  53          $this->data['edulevel'] = self::LEVEL_OTHER;
  54      }
  55  
  56      /**
  57       * Return localised event name.
  58       *
  59       * @return string
  60       */
  61      public static function get_name() {
  62          return get_string('eventuserloginfailed', 'auth');
  63      }
  64  
  65      /**
  66       * Returns non-localised event description with id's for admin use only.
  67       *
  68       * @return string
  69       */
  70      public function get_description() {
  71          // Note that username could be any random user input.
  72          $username = s($this->other['username']);
  73          return "Login failed for the username '{$username}' for the reason with id '{$this->other['reason']}'.";
  74      }
  75  
  76      /**
  77       * Get URL related to the action.
  78       *
  79       * @return \moodle_url
  80       */
  81      public function get_url() {
  82          if (isset($this->data['userid'])) {
  83              return new \moodle_url('/user/profile.php', array('id' => $this->data['userid']));
  84          } else {
  85              return null;
  86          }
  87      }
  88  
  89      /**
  90       * Return legacy data for add_to_log().
  91       *
  92       * @return array
  93       */
  94      protected function get_legacy_logdata() {
  95          return array(SITEID, 'login', 'error', 'index.php', $this->other['username']);
  96      }
  97  
  98      /**
  99       * Custom validation.
 100       *
 101       * @throws \coding_exception when validation does not pass.
 102       * @return void
 103       */
 104      protected function validate_data() {
 105          parent::validate_data();
 106  
 107          if (!isset($this->other['reason'])) {
 108              throw new \coding_exception('The \'reason\' value must be set in other.');
 109          }
 110  
 111          if (!isset($this->other['username'])) {
 112              throw new \coding_exception('The \'username\' value must be set in other.');
 113          }
 114      }
 115  
 116      public static function get_other_mapping() {
 117          return false;
 118      }
 119  }