f1cbc111361f0ded7ec93ad4be8500f0be19c677
[moodle.git] / auth / email / auth.php
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/>.
17 /**
18  * Authentication Plugin: Email Authentication
19  *
20  * @author Martin Dougiamas
21  * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
22  * @package auth_email
23  */
25 defined('MOODLE_INTERNAL') || die();
27 require_once($CFG->libdir.'/authlib.php');
29 /**
30  * Email authentication plugin.
31  */
32 class auth_plugin_email extends auth_plugin_base {
34     /**
35      * Constructor.
36      */
37     public function __construct() {
38         $this->authtype = 'email';
39         $this->config = get_config('auth_email');
40     }
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     }
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
58      * @return bool Authentication success or failure.
59      */
60     function user_login ($username, $password) {
61         global $CFG, $DB;
62         if ($user = $DB->get_record('user', array('username'=>$username, 'mnethostid'=>$CFG->mnet_localhost_id))) {
63             return validate_internal_user_password($user, $password);
64         }
65         return false;
66     }
68     /**
69      * Updates the user's password.
70      *
71      * called when the user password is updated.
72      *
73      * @param  object  $user        User table object  (with system magic quotes)
74      * @param  string  $newpassword Plaintext password (with system magic quotes)
75      * @return boolean result
76      *
77      */
78     function user_update_password($user, $newpassword) {
79         $user = get_complete_user_data('id', $user->id);
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).
83         return update_internal_user_password($user, $newpassword);
84     }
86     function can_signup() {
87         return true;
88     }
90     /**
91      * Sign up a new user ready for confirmation.
92      * Password is passed in plaintext.
93      *
94      * @param object $user new user object
95      * @param boolean $notify print notice with link and terminate
96      */
97     function user_signup($user, $notify=true) {
98         // Standard signup, without custom confirmatinurl.
99         return $this->user_signup_with_confirmation($user, $notify);
100     }
102     /**
103      * Sign up a new user ready for confirmation.
104      *
105      * Password is passed in plaintext.
106      * A custom confirmationurl could be used.
107      *
108      * @param object $user new user object
109      * @param boolean $notify print notice with link and terminate
110      * @param string $confirmationurl user confirmation URL
111      * @return boolean true if everything well ok and $notify is set to true
112      * @throws moodle_exception
113      * @since Moodle 3.2
114      */
115     public function user_signup_with_confirmation($user, $notify=true, $confirmationurl = null) {
116         global $CFG, $DB;
117         require_once($CFG->dirroot.'/user/profile/lib.php');
118         require_once($CFG->dirroot.'/user/lib.php');
120         $plainpassword = $user->password;
121         $user->password = hash_internal_user_password($user->password);
122         if (empty($user->calendartype)) {
123             $user->calendartype = $CFG->calendartype;
124         }
126         $user->id = user_create_user($user, false, false);
128         user_add_password_history($user->id, $plainpassword);
130         // Save any custom profile field information.
131         profile_save_data($user);
133         // Trigger event.
134         \core\event\user_created::create_from_userid($user->id)->trigger();
136         if (! send_confirmation_email($user, $confirmationurl)) {
137             print_error('auth_emailnoemail', 'auth_email');
138         }
140         if ($notify) {
141             global $CFG, $PAGE, $OUTPUT;
142             $emailconfirm = get_string('emailconfirm');
143             $PAGE->navbar->add($emailconfirm);
144             $PAGE->set_title($emailconfirm);
145             $PAGE->set_heading($PAGE->course->fullname);
146             echo $OUTPUT->header();
147             notice(get_string('emailconfirmsent', '', $user->email), "$CFG->wwwroot/index.php");
148         } else {
149             return true;
150         }
151     }
153     /**
154      * Returns true if plugin allows confirming of new users.
155      *
156      * @return bool
157      */
158     function can_confirm() {
159         return true;
160     }
162     /**
163      * Confirm the new user as registered.
164      *
165      * @param string $username
166      * @param string $confirmsecret
167      */
168     function user_confirm($username, $confirmsecret) {
169         global $DB;
170         $user = get_complete_user_data('username', $username);
172         if (!empty($user)) {
173             if ($user->auth != $this->authtype) {
174                 return AUTH_CONFIRM_ERROR;
176             } else if ($user->secret == $confirmsecret && $user->confirmed) {
177                 return AUTH_CONFIRM_ALREADY;
179             } else if ($user->secret == $confirmsecret) {   // They have provided the secret key to get in
180                 $DB->set_field("user", "confirmed", 1, array("id"=>$user->id));
181                 return AUTH_CONFIRM_OK;
182             }
183         } else {
184             return AUTH_CONFIRM_ERROR;
185         }
186     }
188     function prevent_local_passwords() {
189         return false;
190     }
192     /**
193      * Returns true if this authentication plugin is 'internal'.
194      *
195      * @return bool
196      */
197     function is_internal() {
198         return true;
199     }
201     /**
202      * Returns true if this authentication plugin can change the user's
203      * password.
204      *
205      * @return bool
206      */
207     function can_change_password() {
208         return true;
209     }
211     /**
212      * Returns the URL for changing the user's pw, or empty if the default can
213      * be used.
214      *
215      * @return moodle_url
216      */
217     function change_password_url() {
218         return null; // use default internal method
219     }
221     /**
222      * Returns true if plugin allows resetting of internal password.
223      *
224      * @return bool
225      */
226     function can_reset_password() {
227         return true;
228     }
230     /**
231      * Returns true if plugin can be manually set.
232      *
233      * @return bool
234      */
235     function can_be_manually_set() {
236         return true;
237     }
239     /**
240      * Returns whether or not the captcha element is enabled.
241      * @return bool
242      */
243     function is_captcha_enabled() {
244         return get_config("auth_{$this->authtype}", 'recaptcha');
245     }