lib/classes/task/send_new_user_passwords_task.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/>.
  16
  17 /**
  18  * Scheduled task class.
  19  *
  20  * @package    core
  21  * @copyright  2013 onwards Martin Dougiamas  http://dougiamas.com
  22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23  */
  24 namespace core\task;
  25
  26 /**
  27  * Simple task to create accounts and send password emails for new users.
  28  */
  29 class send_new_user_passwords_task extends scheduled_task {
  30
  31     /**
  32      * Get a descriptive name for this task (shown to admins).
  33      *
  34      * @return string
  35      */
  36     public function get_name() {
  37         return get_string('tasksendnewuserpasswords', 'admin');
  38     }
  39
  40     /**
  41      * Do the job.
  42      * Throw exceptions on errors (the job will be retried).
  43      */
  44     public function execute() {
  45         global $DB;
  46
  47         // Generate new password emails for users - ppl expect these generated asap.
  48         if ($DB->count_records('user_preferences', array('name' => 'create_password', 'value' => '1'))) {
  49             mtrace('Creating passwords for new users...');
  50             $userfieldsapi = \core_user\fields::for_name();
  51             $usernamefields = $userfieldsapi->get_sql('u', false, '', '', false)->selects;
  52             $newusers = $DB->get_recordset_sql("SELECT u.id as id, u.email, u.auth, u.deleted,
  53                                                      u.suspended, u.emailstop, u.mnethostid, u.mailformat,
  54                                                      $usernamefields, u.username, u.lang,
  55                                                      p.id as prefid
  56                                                 FROM {user} u
  57                                                 JOIN {user_preferences} p ON u.id=p.userid
  58                                                WHERE p.name='create_password' AND p.value='1' AND
  59                                                      u.email !='' AND u.suspended = 0 AND
  60                                                      u.auth != 'nologin' AND u.deleted = 0");
  61
  62             // Note: we can not send emails to suspended accounts.
  63             foreach ($newusers as $newuser) {
  64                 // Use a low cost factor when generating bcrypt hash otherwise
  65                 // hashing would be slow when emailing lots of users. Hashes
  66                 // will be automatically updated to a higher cost factor the first
  67                 // time the user logs in.
  68                 if (setnew_password_and_mail($newuser, true)) {
  69                     unset_user_preference('create_password', $newuser);
  70                     set_user_preference('auth_forcepasswordchange', 1, $newuser);
  71                 } else {
  72                     trigger_error("Could not create and mail new user password!");
  73                 }
  74             }
  75             $newusers->close();
  76         }
  77     }
  78
  79 }