auth/email/auth.php

   1 <?php
   2
   3 /**
   4  * @author Martin Dougiamas
   5  * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
   6  * @package moodle multiauth
   7  *
   8  * Authentication Plugin: Email Authentication
   9  *
  10  * Standard authentication function.
  11  *
  12  * 2006-08-28  File created.
  13  */
  14
  15 if (!defined('MOODLE_INTERNAL')) {
  16     die('Direct access to this script is forbidden.');    ///  It must be included from a Moodle page
  17 }
  18
  19 require_once($CFG->libdir.'/authlib.php');
  20
  21 /**
  22  * Email authentication plugin.
  23  */
  24 class auth_plugin_email extends auth_plugin_base {
  25
  26     /**
  27      * Constructor.
  28      */
  29     function auth_plugin_email() {
  30         $this->authtype = 'email';
  31         $this->config = get_config('auth/email');
  32     }
  33
  34     /**
  35      * Returns true if the username and password work and false if they are
  36      * wrong or don't exist.
  37      *
  38      * @param string $username The username
  39      * @param string $password The password
  40      * @return bool Authentication success or failure.
  41      */
  42     function user_login ($username, $password) {
  43         global $CFG;
  44         if ($user = get_record('user', 'username', $username, 'mnethostid', $CFG->mnet_localhost_id)) {
  45             return validate_internal_user_password($user, $password);
  46         }
  47         return false;
  48     }
  49
  50     /**
  51      * Updates the user's password.
  52      *
  53      * called when the user password is updated.
  54      *
  55      * @param  object  $user        User table object  (with system magic quotes)
  56      * @param  string  $newpassword Plaintext password (with system magic quotes)
  57      * @return boolean result
  58      *
  59      */
  60     function user_update_password($user, $newpassword) {
  61         $user = get_complete_user_data('id', $user->id);
  62         return update_internal_user_password($user, $newpassword);
  63     }
  64
  65     function can_signup() {
  66         return true;
  67     }
  68
  69     /**
  70      * Sign up a new user ready for confirmation.
  71      * Password is passed in plaintext.
  72      *
  73      * @param object $user new user object (with system magic quotes)
  74      * @param boolean $notify print notice with link and terminate
  75      */
  76     function user_signup($user, $notify=true) {
  77         global $CFG;
  78         require_once($CFG->dirroot.'/user/profile/lib.php');
  79
  80         $user->password = hash_internal_user_password($user->password);
  81
  82         if (! ($user->id = insert_record('user', $user)) ) {
  83             print_error('auth_emailnoinsert','auth');
  84         }
  85
  86         /// Save any custom profile field information
  87         profile_save_data($user);
  88
  89         $user = get_record('user', 'id', $user->id);
  90         events_trigger('user_created', $user);
  91
  92         if (! send_confirmation_email($user)) {
  93             print_error('auth_emailnoemail','auth');
  94         }
  95
  96         if ($notify) {
  97             global $CFG;
  98             $emailconfirm = get_string('emailconfirm');
  99             $navlinks = array();
 100             $navlinks[] = array('name' => $emailconfirm, 'link' => null, 'type' => 'misc');
 101             $navigation = build_navigation($navlinks);
 102
 103             print_header($emailconfirm, $emailconfirm, $navigation);
 104             notice(get_string('emailconfirmsent', '', $user->email), "$CFG->wwwroot/index.php");
 105         } else {
 106             return true;
 107         }
 108     }
 109
 110     /**
 111      * Returns true if plugin allows confirming of new users.
 112      *
 113      * @return bool
 114      */
 115     function can_confirm() {
 116         return true;
 117     }
 118
 119     /**
 120      * Confirm the new user as registered.
 121      *
 122      * @param string $username (with system magic quotes)
 123      * @param string $confirmsecret (with system magic quotes)
 124      */
 125     function user_confirm($username, $confirmsecret) {
 126         $user = get_complete_user_data('username', $username);
 127
 128         if (!empty($user)) {
 129             if ($user->confirmed) {
 130                 return AUTH_CONFIRM_ALREADY;
 131
 132             } else if ($user->auth != 'email') {
 133                 return AUTH_CONFIRM_ERROR;
 134
 135             } else if ($user->secret == stripslashes($confirmsecret)) {   // They have provided the secret key to get in
 136                 if (!set_field("user", "confirmed", 1, "id", $user->id)) {
 137                     return AUTH_CONFIRM_FAIL;
 138                 }
 139                 if (!set_field("user", "firstaccess", time(), "id", $user->id)) {
 140                     return AUTH_CONFIRM_FAIL;
 141                 }
 142                 return AUTH_CONFIRM_OK;
 143             }
 144         } else {
 145             return AUTH_CONFIRM_ERROR;
 146         }
 147     }
 148
 149     /**
 150      * Returns true if this authentication plugin is 'internal'.
 151      *
 152      * @return bool
 153      */
 154     function is_internal() {
 155         return true;
 156     }
 157
 158     /**
 159      * Returns true if this authentication plugin can change the user's
 160      * password.
 161      *
 162      * @return bool
 163      */
 164     function can_change_password() {
 165         return true;
 166     }
 167
 168     /**
 169      * Returns the URL for changing the user's pw, or empty if the default can
 170      * be used.
 171      *
 172      * @return mixed
 173      */
 174     function change_password_url() {
 175         return ''; // use dafult internal method
 176     }
 177
 178     /**
 179      * Returns true if plugin allows resetting of internal password.
 180      *
 181      * @return bool
 182      */
 183     function can_reset_password() {
 184         return true;
 185     }
 186
 187     /**
 188      * Prints a form for configuring this authentication plugin.
 189      *
 190      * This function is called from admin/auth.php, and outputs a full page with
 191      * a form for configuring this plugin.
 192      *
 193      * @param array $page An object containing all the data for this page.
 194      */
 195     function config_form($config, $err, $user_fields) {
 196         include "config.html";
 197     }
 198
 199     /**
 200      * Processes and stores configuration data for this authentication plugin.
 201      */
 202     function process_config($config) {
 203         // set to defaults if undefined
 204         if (!isset($config->recaptcha)) {
 205             $config->recaptcha = false;
 206         }
 207
 208         // save settings
 209         set_config('recaptcha', $config->recaptcha, 'auth/email');
 210         return true;
 211     }
 212
 213     /**
 214      * Returns whether or not the captcha element is enabled, and the admin settings fulfil its requirements.
 215      * @abstract Implement in child classes
 216      * @return bool
 217      */
 218     function is_captcha_enabled() {
 219         return false;
 220     }
 221
 222 }
 223
 224 ?>