MDL-53139 admin: case diff issue with email
[moodle.git] / admin / tool / uploaduser / locallib.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  * Bulk user registration functions
19  *
20  * @package    tool
21  * @subpackage uploaduser
22  * @copyright  2004 onwards Martin Dougiamas (http://dougiamas.com)
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 defined('MOODLE_INTERNAL') || die();
28 define('UU_USER_ADDNEW', 0);
29 define('UU_USER_ADDINC', 1);
30 define('UU_USER_ADD_UPDATE', 2);
31 define('UU_USER_UPDATE', 3);
33 define('UU_UPDATE_NOCHANGES', 0);
34 define('UU_UPDATE_FILEOVERRIDE', 1);
35 define('UU_UPDATE_ALLOVERRIDE', 2);
36 define('UU_UPDATE_MISSING', 3);
38 define('UU_BULK_NONE', 0);
39 define('UU_BULK_NEW', 1);
40 define('UU_BULK_UPDATED', 2);
41 define('UU_BULK_ALL', 3);
43 define('UU_PWRESET_NONE', 0);
44 define('UU_PWRESET_WEAK', 1);
45 define('UU_PWRESET_ALL', 2);
47 /**
48  * Tracking of processed users.
49  *
50  * This class prints user information into a html table.
51  *
52  * @package    core
53  * @subpackage admin
54  * @copyright  2007 Petr Skoda  {@link http://skodak.org}
55  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
56  */
57 class uu_progress_tracker {
58     private $_row;
59     public $columns = array('status', 'line', 'id', 'username', 'firstname', 'lastname', 'email', 'password', 'auth', 'enrolments', 'suspended', 'deleted');
61     /**
62      * Print table header.
63      * @return void
64      */
65     public function start() {
66         $ci = 0;
67         echo '<table id="uuresults" class="generaltable boxaligncenter flexible-wrap" summary="'.get_string('uploadusersresult', 'tool_uploaduser').'">';
68         echo '<tr class="heading r0">';
69         echo '<th class="header c'.$ci++.'" scope="col">'.get_string('status').'</th>';
70         echo '<th class="header c'.$ci++.'" scope="col">'.get_string('uucsvline', 'tool_uploaduser').'</th>';
71         echo '<th class="header c'.$ci++.'" scope="col">ID</th>';
72         echo '<th class="header c'.$ci++.'" scope="col">'.get_string('username').'</th>';
73         echo '<th class="header c'.$ci++.'" scope="col">'.get_string('firstname').'</th>';
74         echo '<th class="header c'.$ci++.'" scope="col">'.get_string('lastname').'</th>';
75         echo '<th class="header c'.$ci++.'" scope="col">'.get_string('email').'</th>';
76         echo '<th class="header c'.$ci++.'" scope="col">'.get_string('password').'</th>';
77         echo '<th class="header c'.$ci++.'" scope="col">'.get_string('authentication').'</th>';
78         echo '<th class="header c'.$ci++.'" scope="col">'.get_string('enrolments', 'enrol').'</th>';
79         echo '<th class="header c'.$ci++.'" scope="col">'.get_string('suspended', 'auth').'</th>';
80         echo '<th class="header c'.$ci++.'" scope="col">'.get_string('delete').'</th>';
81         echo '</tr>';
82         $this->_row = null;
83     }
85     /**
86      * Flush previous line and start a new one.
87      * @return void
88      */
89     public function flush() {
90         if (empty($this->_row) or empty($this->_row['line']['normal'])) {
91             // Nothing to print - each line has to have at least number
92             $this->_row = array();
93             foreach ($this->columns as $col) {
94                 $this->_row[$col] = array('normal'=>'', 'info'=>'', 'warning'=>'', 'error'=>'');
95             }
96             return;
97         }
98         $ci = 0;
99         $ri = 1;
100         echo '<tr class="r'.$ri.'">';
101         foreach ($this->_row as $key=>$field) {
102             foreach ($field as $type=>$content) {
103                 if ($field[$type] !== '') {
104                     $field[$type] = '<span class="uu'.$type.'">'.$field[$type].'</span>';
105                 } else {
106                     unset($field[$type]);
107                 }
108             }
109             echo '<td class="cell c'.$ci++.'">';
110             if (!empty($field)) {
111                 echo implode('<br />', $field);
112             } else {
113                 echo '&nbsp;';
114             }
115             echo '</td>';
116         }
117         echo '</tr>';
118         foreach ($this->columns as $col) {
119             $this->_row[$col] = array('normal'=>'', 'info'=>'', 'warning'=>'', 'error'=>'');
120         }
121     }
123     /**
124      * Add tracking info
125      * @param string $col name of column
126      * @param string $msg message
127      * @param string $level 'normal', 'warning' or 'error'
128      * @param bool $merge true means add as new line, false means override all previous text of the same type
129      * @return void
130      */
131     public function track($col, $msg, $level = 'normal', $merge = true) {
132         if (empty($this->_row)) {
133             $this->flush(); //init arrays
134         }
135         if (!in_array($col, $this->columns)) {
136             debugging('Incorrect column:'.$col);
137             return;
138         }
139         if ($merge) {
140             if ($this->_row[$col][$level] != '') {
141                 $this->_row[$col][$level] .='<br />';
142             }
143             $this->_row[$col][$level] .= $msg;
144         } else {
145             $this->_row[$col][$level] = $msg;
146         }
147     }
149     /**
150      * Print the table end
151      * @return void
152      */
153     public function close() {
154         $this->flush();
155         echo '</table>';
156     }
159 /**
160  * Validation callback function - verified the column line of csv file.
161  * Converts standard column names to lowercase.
162  * @param csv_import_reader $cir
163  * @param array $stdfields standard user fields
164  * @param array $profilefields custom profile fields
165  * @param moodle_url $returnurl return url in case of any error
166  * @return array list of fields
167  */
168 function uu_validate_user_upload_columns(csv_import_reader $cir, $stdfields, $profilefields, moodle_url $returnurl) {
169     $columns = $cir->get_columns();
171     if (empty($columns)) {
172         $cir->close();
173         $cir->cleanup();
174         print_error('cannotreadtmpfile', 'error', $returnurl);
175     }
176     if (count($columns) < 2) {
177         $cir->close();
178         $cir->cleanup();
179         print_error('csvfewcolumns', 'error', $returnurl);
180     }
182     // test columns
183     $processed = array();
184     foreach ($columns as $key=>$unused) {
185         $field = $columns[$key];
186         $lcfield = core_text::strtolower($field);
187         if (in_array($field, $stdfields) or in_array($lcfield, $stdfields)) {
188             // standard fields are only lowercase
189             $newfield = $lcfield;
191         } else if (in_array($field, $profilefields)) {
192             // exact profile field name match - these are case sensitive
193             $newfield = $field;
195         } else if (in_array($lcfield, $profilefields)) {
196             // hack: somebody wrote uppercase in csv file, but the system knows only lowercase profile field
197             $newfield = $lcfield;
199         } else if (preg_match('/^(sysrole|cohort|course|group|type|role|enrolperiod|enrolstatus)\d+$/', $lcfield)) {
200             // special fields for enrolments
201             $newfield = $lcfield;
203         } else {
204             $cir->close();
205             $cir->cleanup();
206             print_error('invalidfieldname', 'error', $returnurl, $field);
207         }
208         if (in_array($newfield, $processed)) {
209             $cir->close();
210             $cir->cleanup();
211             print_error('duplicatefieldname', 'error', $returnurl, $newfield);
212         }
213         $processed[$key] = $newfield;
214     }
216     return $processed;
219 /**
220  * Increments username - increments trailing number or adds it if not present.
221  * Varifies that the new username does not exist yet
222  * @param string $username
223  * @return incremented username which does not exist yet
224  */
225 function uu_increment_username($username) {
226     global $DB, $CFG;
228     if (!preg_match_all('/(.*?)([0-9]+)$/', $username, $matches)) {
229         $username = $username.'2';
230     } else {
231         $username = $matches[1][0].($matches[2][0]+1);
232     }
234     if ($DB->record_exists('user', array('username'=>$username, 'mnethostid'=>$CFG->mnet_localhost_id))) {
235         return uu_increment_username($username);
236     } else {
237         return $username;
238     }
241 /**
242  * Check if default field contains templates and apply them.
243  * @param string template - potential tempalte string
244  * @param object user object- we need username, firstname and lastname
245  * @return string field value
246  */
247 function uu_process_template($template, $user) {
248     if (is_array($template)) {
249         // hack for for support of text editors with format
250         $t = $template['text'];
251     } else {
252         $t = $template;
253     }
254     if (strpos($t, '%') === false) {
255         return $template;
256     }
258     $username  = isset($user->username)  ? $user->username  : '';
259     $firstname = isset($user->firstname) ? $user->firstname : '';
260     $lastname  = isset($user->lastname)  ? $user->lastname  : '';
262     $callback = partial('uu_process_template_callback', $username, $firstname, $lastname);
264     $result = preg_replace_callback('/(?<!%)%([+-~])?(\d)*([flu])/', $callback, $t);
266     if (is_null($result)) {
267         return $template; //error during regex processing??
268     }
270     if (is_array($template)) {
271         $template['text'] = $result;
272         return $t;
273     } else {
274         return $result;
275     }
278 /**
279  * Internal callback function.
280  */
281 function uu_process_template_callback($username, $firstname, $lastname, $block) {
282     switch ($block[3]) {
283         case 'u':
284             $repl = $username;
285             break;
286         case 'f':
287             $repl = $firstname;
288             break;
289         case 'l':
290             $repl = $lastname;
291             break;
292         default:
293             return $block[0];
294     }
296     switch ($block[1]) {
297         case '+':
298             $repl = core_text::strtoupper($repl);
299             break;
300         case '-':
301             $repl = core_text::strtolower($repl);
302             break;
303         case '~':
304             $repl = core_text::strtotitle($repl);
305             break;
306     }
308     if (!empty($block[2])) {
309         $repl = core_text::substr($repl, 0 , $block[2]);
310     }
312     return $repl;
315 /**
316  * Returns list of auth plugins that are enabled and known to work.
317  *
318  * If ppl want to use some other auth type they have to include it
319  * in the CSV file next on each line.
320  *
321  * @return array type=>name
322  */
323 function uu_supported_auths() {
324     // Get all the enabled plugins.
325     $plugins = get_enabled_auth_plugins();
326     $choices = array();
327     foreach ($plugins as $plugin) {
328         $objplugin = get_auth_plugin($plugin);
329         // If the plugin can not be manually set skip it.
330         if (!$objplugin->can_be_manually_set()) {
331             continue;
332         }
333         $choices[$plugin] = get_string('pluginname', "auth_{$plugin}");
334     }
336     return $choices;
339 /**
340  * Returns list of roles that are assignable in courses
341  * @return array
342  */
343 function uu_allowed_roles() {
344     // let's cheat a bit, frontpage is guaranteed to exist and has the same list of roles ;-)
345     $roles = get_assignable_roles(context_course::instance(SITEID), ROLENAME_ORIGINALANDSHORT);
346     return array_reverse($roles, true);
349 /**
350  * Returns mapping of all roles using short role name as index.
351  * @return array
352  */
353 function uu_allowed_roles_cache() {
354     $allowedroles = get_assignable_roles(context_course::instance(SITEID), ROLENAME_SHORT);
355     foreach ($allowedroles as $rid=>$rname) {
356         $rolecache[$rid] = new stdClass();
357         $rolecache[$rid]->id   = $rid;
358         $rolecache[$rid]->name = $rname;
359         if (!is_numeric($rname)) { // only non-numeric shortnames are supported!!!
360             $rolecache[$rname] = new stdClass();
361             $rolecache[$rname]->id   = $rid;
362             $rolecache[$rname]->name = $rname;
363         }
364     }
365     return $rolecache;
368 /**
369  * Returns mapping of all system roles using short role name as index.
370  * @return array
371  */
372 function uu_allowed_sysroles_cache() {
373     $allowedroles = get_assignable_roles(context_system::instance(), ROLENAME_SHORT);
374     foreach ($allowedroles as $rid => $rname) {
375         $rolecache[$rid] = new stdClass();
376         $rolecache[$rid]->id   = $rid;
377         $rolecache[$rid]->name = $rname;
378         if (!is_numeric($rname)) { // Only non-numeric shortnames are supported!
379             $rolecache[$rname] = new stdClass();
380             $rolecache[$rname]->id   = $rid;
381             $rolecache[$rname]->name = $rname;
382         }
383     }
384     return $rolecache;
387 /**
388  * Pre process custom profile data, and update it with corrected value
389  *
390  * @param stdClass $data user profile data
391  * @return stdClass pre-processed custom profile data
392  */
393 function uu_pre_process_custom_profile_data($data) {
394     global $CFG, $DB;
395     // find custom profile fields and check if data needs to converted.
396     foreach ($data as $key => $value) {
397         if (preg_match('/^profile_field_/', $key)) {
398             $shortname = str_replace('profile_field_', '', $key);
399             if ($fields = $DB->get_records('user_info_field', array('shortname' => $shortname))) {
400                 foreach ($fields as $field) {
401                     require_once($CFG->dirroot.'/user/profile/field/'.$field->datatype.'/field.class.php');
402                     $newfield = 'profile_field_'.$field->datatype;
403                     $formfield = new $newfield($field->id, $data->id);
404                     if (method_exists($formfield, 'convert_external_data')) {
405                         $data->$key = $formfield->convert_external_data($value);
406                     }
407                 }
408             }
409         }
410     }
411     return $data;
414 /**
415  * Checks if data provided for custom fields is correct
416  * Currently checking for custom profile field or type menu
417  *
418  * @param array $data user profile data
419  * @return bool true if no error else false
420  */
421 function uu_check_custom_profile_data(&$data) {
422     global $CFG, $DB;
423     $noerror = true;
424     $testuserid = null;
426     if (!empty($data['username'])) {
427         if (preg_match('/id=(.*)"/i', $data['username'], $result)) {
428             $testuserid = $result[1];
429         }
430     }
431     // Find custom profile fields and check if data needs to converted.
432     foreach ($data as $key => $value) {
433         if (preg_match('/^profile_field_/', $key)) {
434             $shortname = str_replace('profile_field_', '', $key);
435             if ($fields = $DB->get_records('user_info_field', array('shortname' => $shortname))) {
436                 foreach ($fields as $field) {
437                     require_once($CFG->dirroot.'/user/profile/field/'.$field->datatype.'/field.class.php');
438                     $newfield = 'profile_field_'.$field->datatype;
439                     $formfield = new $newfield($field->id, 0);
440                     if (method_exists($formfield, 'convert_external_data') &&
441                             is_null($formfield->convert_external_data($value))) {
442                         $data['status'][] = get_string('invaliduserfield', 'error', $shortname);
443                         $noerror = false;
444                     }
445                     // Check for duplicate value.
446                     if (method_exists($formfield, 'edit_validate_field') ) {
447                         $testuser = new stdClass();
448                         $testuser->{$key} = $value;
449                         $testuser->id = $testuserid;
450                         $err = $formfield->edit_validate_field($testuser);
451                         if (!empty($err[$key])) {
452                             $data['status'][] = $err[$key].' ('.$key.')';
453                             $noerror = false;
454                         }
455                     }
456                 }
457             }
458         }
459     }
460     return $noerror;