Moodle release 3.2beta
[moodle.git] / auth / email / auth.php
CommitLineData
b9ddb2d5 1<?php
a2f10958
PS
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/>.
b9ddb2d5 16
17/**
b9ddb2d5 18 * Authentication Plugin: Email Authentication
19 *
a2f10958
PS
20 * @author Martin Dougiamas
21 * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
22 * @package auth_email
b9ddb2d5 23 */
24
60d7078a 25defined('MOODLE_INTERNAL') || die();
b9ddb2d5 26
6bc1e5d5 27require_once($CFG->libdir.'/authlib.php');
b9ddb2d5 28
29/**
30 * Email authentication plugin.
31 */
6bc1e5d5 32class auth_plugin_email extends auth_plugin_base {
b9ddb2d5 33
34 /**
35 * Constructor.
36 */
4a89e83b 37 public function __construct() {
6bc1e5d5 38 $this->authtype = 'email';
b9ddb2d5 39 $this->config = get_config('auth/email');
40 }
41
4a89e83b
MG
42 /**
43 * Old syntax of class constructor. Deprecated in PHP7.
44 *
45 * @deprecated since Moodle 3.1
46 */
47 public function auth_plugin_email() {
48 debugging('Use of class name as constructor is deprecated', DEBUG_DEVELOPER);
49 self::__construct();
50 }
51
b9ddb2d5 52 /**
53 * Returns true if the username and password work and false if they are
54 * wrong or don't exist.
55 *
56 * @param string $username The username
57 * @param string $password The password
139ebfdb 58 * @return bool Authentication success or failure.
b9ddb2d5 59 */
60 function user_login ($username, $password) {
be544ec3 61 global $CFG, $DB;
62 if ($user = $DB->get_record('user', array('username'=>$username, 'mnethostid'=>$CFG->mnet_localhost_id))) {
b9ddb2d5 63 return validate_internal_user_password($user, $password);
64 }
65 return false;
66 }
67
fb5c7739 68 /**
b9ddb2d5 69 * Updates the user's password.
70 *
71 * called when the user password is updated.
72 *
c57dcb62 73 * @param object $user User table object (with system magic quotes)
74 * @param string $newpassword Plaintext password (with system magic quotes)
b9ddb2d5 75 * @return boolean result
76 *
77 */
da249a30 78 function user_update_password($user, $newpassword) {
79 $user = get_complete_user_data('id', $user->id);
ec2d8ceb
SC
80 // This will also update the stored hash to the latest algorithm
81 // if the existing hash is using an out-of-date algorithm (or the
82 // legacy md5 algorithm).
b9ddb2d5 83 return update_internal_user_password($user, $newpassword);
84 }
85
6bc1e5d5 86 function can_signup() {
87 return true;
88 }
89
430759a5 90 /**
b9ddb2d5 91 * Sign up a new user ready for confirmation.
dd0feda5 92 * Password is passed in plaintext.
93 *
5d910388 94 * @param object $user new user object
dd0feda5 95 * @param boolean $notify print notice with link and terminate
b9ddb2d5 96 */
6b8ad965 97 function user_signup($user, $notify=true) {
5d910388 98 global $CFG, $DB;
831d450e 99 require_once($CFG->dirroot.'/user/profile/lib.php');
bb78e249 100 require_once($CFG->dirroot.'/user/lib.php');
5117d598 101
1d658535 102 $plainpassword = $user->password;
dd0feda5 103 $user->password = hash_internal_user_password($user->password);
8bf0f207
MN
104 if (empty($user->calendartype)) {
105 $user->calendartype = $CFG->calendartype;
106 }
dd0feda5 107
9363073b 108 $user->id = user_create_user($user, false, false);
5117d598 109
1d658535
PS
110 user_add_password_history($user->id, $plainpassword);
111
bb78e249 112 // Save any custom profile field information.
831d450e 113 profile_save_data($user);
114
9363073b
RT
115 // Trigger event.
116 \core\event\user_created::create_from_userid($user->id)->trigger();
117
b9ddb2d5 118 if (! send_confirmation_email($user)) {
2b06294b 119 print_error('auth_emailnoemail','auth_email');
b9ddb2d5 120 }
121
122 if ($notify) {
07ed083e 123 global $CFG, $PAGE, $OUTPUT;
b9ddb2d5 124 $emailconfirm = get_string('emailconfirm');
cfc5b79b 125 $PAGE->navbar->add($emailconfirm);
126 $PAGE->set_title($emailconfirm);
c93fdc7b 127 $PAGE->set_heading($PAGE->course->fullname);
cfc5b79b 128 echo $OUTPUT->header();
b9ddb2d5 129 notice(get_string('emailconfirmsent', '', $user->email), "$CFG->wwwroot/index.php");
dd0feda5 130 } else {
131 return true;
139ebfdb 132 }
b9ddb2d5 133 }
134
6bc1e5d5 135 /**
136 * Returns true if plugin allows confirming of new users.
137 *
138 * @return bool
139 */
140 function can_confirm() {
141 return true;
142 }
143
430759a5 144 /**
b9ddb2d5 145 * Confirm the new user as registered.
dd0feda5 146 *
b9a66360 147 * @param string $username
148 * @param string $confirmsecret
b9ddb2d5 149 */
150 function user_confirm($username, $confirmsecret) {
b9a66360 151 global $DB;
b9ddb2d5 152 $user = get_complete_user_data('username', $username);
153
154 if (!empty($user)) {
4f8b6d56 155 if ($user->auth != $this->authtype) {
dd0feda5 156 return AUTH_CONFIRM_ERROR;
157
4f8b6d56
MG
158 } else if ($user->secret == $confirmsecret && $user->confirmed) {
159 return AUTH_CONFIRM_ALREADY;
160
b9a66360 161 } else if ($user->secret == $confirmsecret) { // They have provided the secret key to get in
f685e830 162 $DB->set_field("user", "confirmed", 1, array("id"=>$user->id));
b9ddb2d5 163 return AUTH_CONFIRM_OK;
164 }
dd0feda5 165 } else {
166 return AUTH_CONFIRM_ERROR;
b9ddb2d5 167 }
168 }
169
edb5da83
PS
170 function prevent_local_passwords() {
171 return false;
172 }
173
b9ddb2d5 174 /**
175 * Returns true if this authentication plugin is 'internal'.
176 *
139ebfdb 177 * @return bool
b9ddb2d5 178 */
179 function is_internal() {
180 return true;
181 }
139ebfdb 182
b9ddb2d5 183 /**
184 * Returns true if this authentication plugin can change the user's
185 * password.
186 *
139ebfdb 187 * @return bool
b9ddb2d5 188 */
189 function can_change_password() {
190 return true;
191 }
139ebfdb 192
b9ddb2d5 193 /**
430759a5 194 * Returns the URL for changing the user's pw, or empty if the default can
b9ddb2d5 195 * be used.
196 *
99f9f85f 197 * @return moodle_url
b9ddb2d5 198 */
199 function change_password_url() {
99f9f85f 200 return null; // use default internal method
430759a5 201 }
202
203 /**
204 * Returns true if plugin allows resetting of internal password.
205 *
206 * @return bool
207 */
208 function can_reset_password() {
209 return true;
b9ddb2d5 210 }
139ebfdb 211
9b29f686
MN
212 /**
213 * Returns true if plugin can be manually set.
214 *
215 * @return bool
216 */
217 function can_be_manually_set() {
218 return true;
219 }
220
b9ddb2d5 221 /**
222 * Prints a form for configuring this authentication plugin.
223 *
224 * This function is called from admin/auth.php, and outputs a full page with
225 * a form for configuring this plugin.
226 *
227 * @param array $page An object containing all the data for this page.
228 */
139ebfdb 229 function config_form($config, $err, $user_fields) {
b9ddb2d5 230 include "config.html";
231 }
232
233 /**
234 * Processes and stores configuration data for this authentication plugin.
235 */
236 function process_config($config) {
5d6308d4 237 // set to defaults if undefined
5117d598
PS
238 if (!isset($config->recaptcha)) {
239 $config->recaptcha = false;
5d6308d4 240 }
5117d598 241
5d6308d4 242 // save settings
243 set_config('recaptcha', $config->recaptcha, 'auth/email');
b9ddb2d5 244 return true;
245 }
5117d598 246
9b5f87d2 247 /**
0f7f3002 248 * Returns whether or not the captcha element is enabled.
9b5f87d2 249 * @return bool
250 */
251 function is_captcha_enabled() {
0f7f3002 252 return get_config("auth/{$this->authtype}", 'recaptcha');
9b5f87d2 253 }
139ebfdb 254
b9ddb2d5 255}
256
5117d598 257