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         if (! send_confirmation_email($user)) {
  90             print_error('auth_emailnoemail','auth');
  91         }
  92
  93         if ($notify) {
  94             global $CFG;
  95             $emailconfirm = get_string('emailconfirm');
  96             $navlinks = array();
  97             $navlinks[] = array('name' => $emailconfirm, 'link' => null, 'type' => 'misc');
  98             $navigation = build_navigation($navlinks);
  99
 100             print_header($emailconfirm, $emailconfirm, $navigation);
 101             notice(get_string('emailconfirmsent', '', $user->email), "$CFG->wwwroot/index.php");
 102         } else {
 103             return true;
 104         }
 105     }
 106
 107     /**
 108      * Returns true if plugin allows confirming of new users.
 109      *
 110      * @return bool
 111      */
 112     function can_confirm() {
 113         return true;
 114     }
 115
 116     /**
 117      * Confirm the new user as registered.
 118      *
 119      * @param string $username (with system magic quotes)
 120      * @param string $confirmsecret (with system magic quotes)
 121      */
 122     function user_confirm($username, $confirmsecret) {
 123         $user = get_complete_user_data('username', $username);
 124
 125         if (!empty($user)) {
 126             if ($user->confirmed) {
 127                 return AUTH_CONFIRM_ALREADY;
 128
 129             } else if ($user->auth != 'email') {
 130                 return AUTH_CONFIRM_ERROR;
 131
 132             } else if ($user->secret == stripslashes($confirmsecret)) {   // They have provided the secret key to get in
 133                 if (!set_field("user", "confirmed", 1, "id", $user->id)) {
 134                     return AUTH_CONFIRM_FAIL;
 135                 }
 136                 if (!set_field("user", "firstaccess", time(), "id", $user->id)) {
 137                     return AUTH_CONFIRM_FAIL;
 138                 }
 139                 return AUTH_CONFIRM_OK;
 140             }
 141         } else {
 142             return AUTH_CONFIRM_ERROR;
 143         }
 144     }
 145
 146     /**
 147      * Returns true if this authentication plugin is 'internal'.
 148      *
 149      * @return bool
 150      */
 151     function is_internal() {
 152         return true;
 153     }
 154
 155     /**
 156      * Returns true if this authentication plugin can change the user's
 157      * password.
 158      *
 159      * @return bool
 160      */
 161     function can_change_password() {
 162         return true;
 163     }
 164
 165     /**
 166      * Returns the URL for changing the user's pw, or empty if the default can
 167      * be used.
 168      *
 169      * @return mixed
 170      */
 171     function change_password_url() {
 172         return ''; // use dafult internal method
 173     }
 174
 175     /**
 176      * Returns true if plugin allows resetting of internal password.
 177      *
 178      * @return bool
 179      */
 180     function can_reset_password() {
 181         return true;
 182     }
 183
 184     /**
 185      * Prints a form for configuring this authentication plugin.
 186      *
 187      * This function is called from admin/auth.php, and outputs a full page with
 188      * a form for configuring this plugin.
 189      *
 190      * @param array $page An object containing all the data for this page.
 191      */
 192     function config_form($config, $err, $user_fields) {
 193         include "config.html";
 194     }
 195
 196     /**
 197      * Processes and stores configuration data for this authentication plugin.
 198      */
 199     function process_config($config) {
 200         // set to defaults if undefined
 201         if (!isset($config->recaptcha)) {
 202             $config->recaptcha = false;
 203         }
 204
 205         // save settings
 206         set_config('recaptcha', $config->recaptcha, 'auth/email');
 207         return true;
 208     }
 209
 210     /**
 211      * Returns whether or not the captcha element is enabled, and the admin settings fulfil its requirements.
 212      * @abstract Implement in child classes
 213      * @return bool
 214      */
 215     function is_captcha_enabled() {
 216         return false;
 217     }
 218
 219 }
 220
 221 ?>