[Summary view]

Differences Between: [Versions 311 and 402] [Versions 311 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   * 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          $reasonid = $this->other['reason'];
  74          $loginfailed = 'Login failed for user';
  75          switch ($reasonid){
  76              case 1:
  77                  return $loginfailed." '{$username}'. User does not exist (error ID '{$reasonid}').";
  78              case 2:
  79                  return $loginfailed." '{$username}'. User is suspended (error ID '{$reasonid}').";
  80              case 3:
  81                  return $loginfailed." '{$username}'. Most likely the password did not match (error ID '{$reasonid}').";
  82              case 4:
  83                  return $loginfailed." '{$username}'. User is locked out (error ID '{$reasonid}').";
  84              case 5:
  85                  return $loginfailed." '{$username}'. User is not authorised (error ID '{$reasonid}').";
  86              default:
  87                  return $loginfailed." '{$username}', error ID '{$reasonid}'.";
  88  
  89          }
  90      }
  91  
  92      /**
  93       * Get URL related to the action.
  94       *
  95       * @return \moodle_url
  96       */
  97      public function get_url() {
  98          if (isset($this->data['userid'])) {
  99              return new \moodle_url('/user/profile.php', array('id' => $this->data['userid']));
 100          } else {
 101              return null;
 102          }
 103      }
 104  
 105      /**
 106       * Return legacy data for add_to_log().
 107       *
 108       * @return array
 109       */
 110      protected function get_legacy_logdata() {
 111          return array(SITEID, 'login', 'error', 'index.php', $this->other['username']);
 112      }
 113  
 114      /**
 115       * Custom validation.
 116       *
 117       * @throws \coding_exception when validation does not pass.
 118       * @return void
 119       */
 120      protected function validate_data() {
 121          parent::validate_data();
 122  
 123          if (!isset($this->other['reason'])) {
 124              throw new \coding_exception('The \'reason\' value must be set in other.');
 125          }
 126  
 127          if (!isset($this->other['username'])) {
 128              throw new \coding_exception('The \'username\' value must be set in other.');
 129          }
 130      }
 131  
 132      public static function get_other_mapping() {
 133          return false;
 134      }
 135  }