user.php 111 KB
Newer Older
Penny Leach's avatar
Penny Leach committed
1 2 3 4 5
<?php
/**
 *
 * @package    mahara
 * @subpackage core
6
 * @author     Catalyst IT Ltd
7 8
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL version 3 or later
 * @copyright  For copyright information on Mahara, please see the README file distributed with this software.
Penny Leach's avatar
Penny Leach committed
9 10 11 12 13
 *
 */

defined('INTERNAL') || die();

14 15
define('MAX_USERNAME_DISPLAY', 30);

16
/**
Penny Leach's avatar
Penny Leach committed
17 18
 * loads up activity preferences for a given user
 *
19
 * @param int $userid to load preferences for
Penny Leach's avatar
Penny Leach committed
20 21 22 23 24 25 26
 * @todo caching
 */
function load_activity_preferences($userid) {
    $prefs = array();
    if (empty($userid)) {
        throw new InvalidArgumentException("couldn't load activity preferences, no user id specified");
    }
27
    if ($prefs = get_records_assoc('usr_activity_preference', 'usr', $userid, '', 'activity,method')) {
Penny Leach's avatar
Penny Leach committed
28
        foreach ($prefs as $p) {
29
            $prefs[$p->activity] = $p->method;
Penny Leach's avatar
Penny Leach committed
30 31 32 33 34
        }
    }
    return $prefs;
}

35
/**
Penny Leach's avatar
Penny Leach committed
36 37 38 39
 * loads up account preferences for a given user
 * if you want them for the current user
 * use $SESSION->accountprefs
 *
40
 * @param int $userid to load preferences for
Penny Leach's avatar
Penny Leach committed
41
 * @todo caching
42
 * @todo defaults?
Penny Leach's avatar
Penny Leach committed
43 44 45 46 47 48 49
 */
function load_account_preferences($userid) {
    $prefs = array();
    $expectedprefs = expected_account_preferences();
    if (empty($userid)) {
        throw new InvalidArgumentException("couldn't load account preferences, no user id specified");
    }
50
    if ($prefs = get_records_array('usr_account_preference', 'usr', $userid)) {
Penny Leach's avatar
Penny Leach committed
51
        foreach ($prefs as $p) {
52
            $prefs[$p->field] = $p->value;
Penny Leach's avatar
Penny Leach committed
53 54 55 56 57 58 59 60 61 62 63
        }
    }
    foreach ($expectedprefs as $field => $default) {
        if (!isset($prefs[$field])) {
            $prefs[$field] = $default;
        }
    }
    return $prefs;
}


64
/**
Penny Leach's avatar
Penny Leach committed
65 66
 * sets a user preference in the database
 * if you want to set it in the session as well
67
 * use SESSION->set_account_preference
Penny Leach's avatar
Penny Leach committed
68 69 70 71 72 73
 *
 * @param int $userid user id to set preference for
 * @param string $field preference field to set
 * @param string $value preference value to set.
 */
function set_account_preference($userid, $field, $value) {
74 75 76
    if ($field == 'mobileuploadtoken'
        && ((!isset($value) || empty($value))
            || (is_array($value) && count($value) == 1 && (!isset($value[0]) || empty($value[0]))))) {
77 78
        $value = '';
    }
79 80 81 82 83 84 85 86 87 88
    if ($field == 'lang') {
        $oldlang = get_field('usr_account_preference', 'value', 'usr', $userid, 'field', 'lang');
        if (empty($oldlang) || $oldlang == 'default') {
            $oldlang = get_config('lang');
        }
        $newlang = (empty($value) || $value == 'default') ? get_config('lang') : $value;
        if ($newlang != $oldlang) {
            change_language($userid, $oldlang, $newlang);
        }
    }
Penny Leach's avatar
Penny Leach committed
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
    if (record_exists('usr_account_preference', 'usr', $userid, 'field', $field)) {
        set_field('usr_account_preference', 'value', $value, 'usr', $userid, 'field', $field);
    }
    else {
        try {
            $pref = new StdClass;
            $pref->usr = $userid;
            $pref->field = $field;
            $pref->value = $value;
            insert_record('usr_account_preference', $pref);
        }
        catch (Exception $e) {
            throw new InvalidArgumentException("Failed to insert account preference "
                ." $value for $field for user $userid");
        }
    }
}

107

108
/**
109
 * Change language-specific stuff in the db for a user.  Currently
110 111
 * changes the name of the 'assessmentfiles' folder in the user's
 * files area and the views and artefacts tagged for the profile
Clare Lenihan's avatar
Clare Lenihan committed
112
 * sideblock
113 114 115 116 117 118
 *
 * @param int $userid user id to set preference for
 * @param string $oldlang old language
 * @param string $newlang new language
 */
function change_language($userid, $oldlang, $newlang) {
119 120 121 122
    if (get_field('artefact_installed', 'active', 'name', 'file')) {
        safe_require('artefact', 'file');
        ArtefactTypeFolder::change_language($userid, $oldlang, $newlang);
    }
123 124
    set_field_select('artefact_tag', 'tag', get_string_from_language($newlang, 'profile'), 'WHERE tag = ? AND artefact IN (SELECT id FROM {artefact} WHERE "owner" = ?)', array(get_string_from_language($oldlang, 'profile'), $userid));
    set_field_select('view_tag', 'tag', get_string_from_language($newlang, 'profile'), 'WHERE tag = ? AND "view" IN (SELECT id FROM {view} WHERE "owner" = ?)', array(get_string_from_language($oldlang, 'profile'), $userid));
125
    set_field_select('collection_tag', 'tag', get_string_from_language($newlang, 'profile'), 'WHERE tag = ? AND "collection" IN (SELECT id FROM {collection} WHERE "owner" = ?)', array(get_string_from_language($oldlang, 'profile'), $userid));
126 127
}

128
/**
Penny Leach's avatar
Penny Leach committed
129 130
 * sets an activity preference in the database
 * if you want to set it in the session as well
131
 * use $SESSION->set_activity_preference
Penny Leach's avatar
Penny Leach committed
132 133
 *
 * @param int $userid user id to set preference for
134
 * @param int $activity activity type to set
Penny Leach's avatar
Penny Leach committed
135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
 * @param string $method notification method to set.
 */
function set_activity_preference($userid, $activity, $method) {
    if (record_exists('usr_activity_preference', 'usr', $userid, 'activity', $activity)) {
        set_field('usr_activity_preference', 'method', $method, 'usr', $userid, 'activity', $activity);
    }
    else {
        try {
            $pref = new StdClass;
            $pref->usr = $userid;
            $pref->activity = $activity;
            $pref->method = $method;
            insert_record('usr_activity_preference', $pref);
        }
        catch (Exception $e) {
            throw new InvalidArgumentException("Failed to insert activity preference "
151
                ." $method for $activity for user $userid");
Penny Leach's avatar
Penny Leach committed
152 153 154 155
        }
    }
}

156
/**
157
 * gets an account preference for the user,
158 159 160 161 162 163 164
 * or the default if not set for that user,
 * as specified in {@link expected_account_preferences}
 *
 * @param int $userid id of user
 * @param string $field preference to get
 */
function get_account_preference($userid, $field) {
165
    if ($pref = get_record('usr_account_preference', 'usr', $userid, 'field', $field)) {
166 167 168 169 170 171
        return $pref->value;
    }
    $expected = expected_account_preferences();
    return $expected[$field];
}

172 173 174 175

function get_user_language($userid) {
    $langpref = get_account_preference($userid, 'lang');
    if (empty($langpref) || $langpref == 'default') {
176 177

        // Check for an institution language
178 179 180
        $instlang = get_user_institution_language($userid);
        if (!empty($instlang) && $instlang != 'default') {
            return $instlang;
181 182 183
        }

        // Use the site language
184 185 186 187 188 189
        return get_config('lang');
    }
    return $langpref;
}


190 191
/**
 * default account settings
192
 *
193 194
 * @returns array of fields => values
 */
Penny Leach's avatar
Penny Leach committed
195 196 197
function expected_account_preferences() {
    return array('friendscontrol' => 'auth',
                 'wysiwyg'        =>  1,
198
                 'licensedefault' => '',
Penny Leach's avatar
Penny Leach committed
199
                 'messages'       => 'allow',
200
                 'lang'           => 'default',
201
                 'addremovecolumns' => 0,
202
                 'maildisabled'   => 0,
203
                 'tagssideblockmaxtags' => get_config('tagssideblockmaxtags'),
204
                 'groupsideblockmaxgroups' => '',
205
                 'groupsideblocksortby' => 'alphabetical',
206
                 'hiderealname'   => 0,
207
                 'multipleblogs' => get_config('defaultmultipleblogs'),
208
                 'showhomeinfo' => 1,
209
                 'showprogressbar' => 1,
210
                 'mobileuploadtoken' => '',
211
                 'theme' => '',
212
                 'resizeonuploaduserdefault' => 1,
213
                 'devicedetection' => 1,
214
                 'licensedefault' => '',
215
                 'viewsperpage' => 20,
216
                 'orderpagesby' => 'atoz',
Penny Leach's avatar
Penny Leach committed
217 218 219
                 );
}

220
function general_account_prefs_form_elements($prefs) {
221 222
    global $USER;
    require_once('license.php');
223 224 225 226 227 228 229 230 231 232 233 234 235
    $elements = array();
    $elements['friendscontrol'] = array(
        'type' => 'radio',
        'defaultvalue' => $prefs->friendscontrol,
        'title'  => get_string('friendsdescr', 'account'),
        'options' => array(
            'nobody' => get_string('friendsnobody', 'account'),
            'auth'   => get_string('friendsauth', 'account'),
            'auto'   => get_string('friendsauto', 'account')
        ),
        'help' => true
    );
    $elements['wysiwyg'] = array(
236
        'type' => 'switchbox',
237 238 239 240 241
        'defaultvalue' => (get_config('wysiwyg')) ? get_config('wysiwyg') == 'enable' : $prefs->wysiwyg,
        'title' => get_string('wysiwygdescr', 'account'),
        'help' => true,
        'disabled' => get_config('wysiwyg'),
    );
242 243 244 245
    if (get_config('licensemetadata')) {
        $elements['licensedefault'] = license_form_el_basic(null);
        $elements['licensedefault']['title'] = get_string('licensedefault','account');
        if ($USER->get('institutions')) {
246
            $elements['licensedefault']['options'][LICENSE_INSTITUTION_DEFAULT] = get_string('licensedefaultinherit','account');
247 248
        }
        $elements['licensedefault']['description'] = get_string('licensedefaultdescription','account');
249
        if (isset($prefs->licensedefault)) {
250 251 252
            $elements['licensedefault']['defaultvalue'] = $prefs->licensedefault;
        }
    }
253
    $elements['maildisabled'] = array(
254
        'type' => 'switchbox',
255
        'defaultvalue' => $prefs->maildisabled,
256
        'title' => get_string('disableemail', 'account'),
257 258 259 260 261 262 263 264 265 266 267 268 269 270
        'help' => true,
    );
    $elements['messages'] = array(
        'type' => 'radio',
        'defaultvalue' => $prefs->messages,
        'title' => get_string('messagesdescr', 'account'),
        'options' => array(
            'nobody' => get_string('messagesnobody', 'account'),
            'friends' => get_string('messagesfriends', 'account'),
            'allow' => get_string('messagesallow', 'account'),
        ),
        'help' => true,
    );
    $languages = get_languages();
271 272 273 274 275 276 277 278
    // Determine default language.
    $instlang = get_user_institution_language($USER->id, $instlanginstname);
    if (!empty($instlang) && $instlang != 'default') {
        $sitedefaultlabel = get_string('defaultlangforinstitution', 'admin', get_config_institution($instlanginstname, 'displayname')) . ' (' . $languages[$instlang] . ')';
    }
    else {
        $sitedefaultlabel = get_string('sitedefault', 'admin') . ' (' . $languages[get_config('lang')] . ')';
    }
279

280 281 282 283 284 285 286 287 288 289 290 291
    $elements['lang'] = array(
        'type' => 'select',
        'defaultvalue' => $prefs->lang,
        'title' => get_string('language', 'account'),
        'options' => array_merge(array('default' => $sitedefaultlabel), $languages),
        'help' => true,
        'ignore' => count($languages) < 2,
    );
    $sitethemes = array();
    // Get all available standard site themes
    if (get_config('sitethemeprefs') && !in_admin_section()) {
        // get_user_accessible_themes() returns 'sitedefault' to mean fall back to the site or
292
        // institution theme. On save it sets user_account_preference to '' to allow the use of higher up theme.
293 294 295 296
        $sitethemes = array_reverse(get_user_accessible_themes());
        $sitethemes = array_reverse($sitethemes);
    }
    // Get all user's institution themes
297
    $lostthemes = array();
298 299 300 301 302 303 304
    $institutionthemes = array();
    if ($institutions = $USER->get('institutions')) {
        $allthemes = get_all_theme_objects();
        foreach ($institutions as $i) {
            if (empty($i->theme)) {
                $institutionthemes['sitedefault' . '/' . $i->institution] = $i->displayname . ' - ' . get_string('sitedefault', 'admin');
            }
305
            else if (isset($allthemes[$i->theme])) {
306
                $institutionthemes[$i->theme . '/' . $i->institution] = $i->displayname . ' - ' . $allthemes[$i->theme]->displayname;
307
            }
308 309 310
            else {
                $lostthemes[$i->theme] = 1;
            }
311 312
        }
    }
313 314 315
    $themes = array_merge($sitethemes, $institutionthemes);
    natcasesort($themes);
    $currenttheme = $USER->get_themedata();
316 317 318

    if (!isset($currenttheme->basename) || (isset($currenttheme->altname) && $currenttheme->altname == 'sitedefault')
        || !empty($lostthemes[$currenttheme->basename])) {
319 320 321 322 323
        $defaulttheme = 'sitedefault';
    }
    else {
        $defaulttheme = $currenttheme->basename;
    }
324
    if (isset($currenttheme->institutionname) && empty($lostthemes[$currenttheme->basename])) {
325 326 327 328 329 330 331 332 333 334 335 336 337 338
        $defaulttheme = $defaulttheme . '/' . $currenttheme->institutionname;
    }
    if (!array_key_exists($defaulttheme, $themes)) {
        reset($themes);
        $defaulttheme = key($themes);
    }
    $elements['theme'] = array(
        'type' => 'select',
        'defaultvalue' => $defaulttheme,
        'title' => get_string('theme'),
        'options' => $themes,
        'ignore' => count($themes) < 2,
        'help' => true,
    );
339

340
    $elements['addremovecolumns'] = array(
341
        'type' => 'switchbox',
342 343 344 345 346 347
        'defaultvalue' => $prefs->addremovecolumns,
        'title' => get_string('showviewcolumns', 'account'),
        'help' => 'true'
    );
    // TODO: add a way for plugins (like blog!) to have account preferences
    $elements['multipleblogs'] = array(
348
        'type' => 'switchbox',
349
        'title'=> get_string('enablemultipleblogs1' ,'account'),
350
        'description' => get_string('enablemultipleblogsdescription1', 'account'),
351 352 353 354 355 356 357 358 359 360 361 362
        'defaultvalue' => $prefs->multipleblogs,
    );
    if (get_config('showtagssideblock')) {
        $elements['tagssideblockmaxtags'] = array(
            'type'         => 'text',
            'size'         => 4,
            'title'        => get_string('tagssideblockmaxtags', 'account'),
            'description'  => get_string('tagssideblockmaxtagsdescription', 'account'),
            'defaultvalue' => isset($prefs->tagssideblockmaxtags) ? $prefs->tagssideblockmaxtags : get_config('tagssideblockmaxtags'),
            'rules'        => array('integer' => true, 'minvalue' => 0, 'maxvalue' => 1000),
        );
    }
363 364 365
    $elements['groupsideblockmaxgroups'] = array(
        'type'         => 'text',
        'size'         => 4,
366 367
        'title'        => get_string('limitto1', 'blocktype.mygroups'),
        'description'  => get_string('limittodescsideblock1', 'blocktype.mygroups'),
368
        'defaultvalue' => isset($prefs->groupsideblockmaxgroups) ? $prefs->groupsideblockmaxgroups : '',
369 370 371 372 373
        'rules'        => array('regex' => '/^[0-9]*$/', 'minvalue' => 0, 'maxvalue' => 1000),
    );
    $elements['groupsideblocksortby'] = array(
        'type'         => 'select',
        'defaultvalue' => isset($prefs->groupsideblocksortby) ? $prefs->groupsideblocksortby : 'alphabetical',
374
        'title' => get_string('sortgroups', 'blocktype.mygroups'),
375 376 377 378 379 380
        'options' =>  array(
            'latest' => get_string('latest', 'blocktype.mygroups'),
            'earliest' => get_string('earliest', 'blocktype.mygroups'),
            'alphabetical'  => get_string('alphabetical', 'blocktype.mygroups'),
        ),
    );
381 382
    if (get_config('userscanhiderealnames')) {
        $elements['hiderealname'] = array(
383
            'type'         => 'switchbox',
384 385 386 387 388 389 390
            'title'        => get_string('hiderealname', 'account'),
            'description'  => get_string('hiderealnamedescription', 'account'),
            'defaultvalue' => $prefs->hiderealname,
        );
    }
    if (get_config('homepageinfo')) {
        $elements['showhomeinfo'] = array(
391
            'type' => 'switchbox',
392
            'defaultvalue' => $prefs->showhomeinfo,
393 394
            'title' => get_string('showhomeinfo2', 'account'),
            'description' => get_string('showhomeinfodescription1', 'account', hsc(get_config('sitename'))),
395 396 397
            'help' => 'true'
        );
    }
398 399
    if (get_config('showprogressbar')) {
        $elements['showprogressbar'] = array(
400
            'type' => 'switchbox',
401 402 403 404 405
            'defaultvalue' => $prefs->showprogressbar,
            'title' => get_string('showprogressbar', 'account'),
            'description' => get_string('showprogressbardescription', 'account', hsc(get_config('sitename'))),
        );
    }
406
    if (get_config('allowmobileuploads')) {
407 408 409 410
        $defaultvalue = array();
        $mobileuploadtoken = isset($prefs->mobileuploadtoken) ? $prefs->mobileuploadtoken : get_config('mobileuploadtoken');
        $defaultvalue = explode('|', trim($mobileuploadtoken, '|'));

411
        $elements['mobileuploadtoken'] = array(
412
            'type'         => 'multitext',
413
            'title'        => get_string('mobileuploadtoken', 'account'),
414 415
            'defaultvalue' => $defaultvalue,
            'help'         => 'true'
416 417
        );
    }
418 419
    if (get_config_plugin('artefact', 'file', 'resizeonuploadenable')) {
        $elements['resizeonuploaduserdefault'] = array(
420
            'type'         => 'switchbox',
421
            'title'        => get_string('resizeonuploaduserdefault1', 'account'),
422
            'description'  => get_string('resizeonuploaduserdefaultdescription2', 'account'),
423 424 425
            'defaultvalue' => $prefs->resizeonuploaduserdefault,
        );
    }
426

427 428
    if (get_config('userscandisabledevicedetection')) {
        $elements['devicedetection'] = array(
429
            'type'         => 'switchbox',
430 431 432 433 434 435
            'title'        => get_string('devicedetection', 'account'),
            'description'  => get_string('devicedetectiondescription', 'account'),
            'defaultvalue' => $prefs->devicedetection,
        );
    }

436 437 438
    return $elements;
}

439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494
/**
 * Get account settings elements from plugins.
 *
 * @param stdClass $prefs
 * @return array
 */
function plugin_account_prefs_form_elements(stdClass $prefs) {
    $elements = array();
    $installed = plugin_all_installed();
    foreach ($installed as $i) {
        if (!safe_require_plugin($i->plugintype, $i->name)) {
            continue;
        }
        $elements = array_merge($elements, call_static_method(generate_class_name($i->plugintype, $i->name),
                'get_accountprefs_elements', $prefs));
    }
    return $elements;
}

/**
 * Validate plugin account form values.
 *
 * @param Pieform $form
 * @param array $values
 */
function plugin_account_prefs_validate(Pieform $form, $values) {
    $elements = array();
    $installed = plugin_all_installed();
    foreach ($installed as $i) {
        if (!safe_require_plugin($i->plugintype, $i->name)) {
            continue;
        }
        call_static_method(generate_class_name($i->plugintype, $i->name), 'accountprefs_validate', $form, $values);
    }
}

/**
 * Submit plugin account form values.
 *
 * @param Pieform $form
 * @param array $values
 * @return bool is page need to be refreshed
 */
function plugin_account_prefs_submit(Pieform $form, $values) {
    $reload = false;
    $elements = array();
    $installed = plugin_all_installed();
    foreach ($installed as $i) {
        if (!safe_require_plugin($i->plugintype, $i->name)) {
            continue;
        }
        $reload = call_static_method(generate_class_name($i->plugintype, $i->name), 'accountprefs_submit', $form, $values) || $reload;
    }
    return $reload;
}

495 496
/**
 * Save a profile field.
497
 * Exception is 'socialprofile' field. It is made up of 2 fields:
498 499 500 501 502
 * socialprofile_profileurl,
 * socialprofile_profiletype
 * @param int $userid
 * @param string $field
 * @param string (or array for socialprofile) $value
503
 * @param int $new - Whether the user is new (avoid unnecessary queries)
504
 */
505
function set_profile_field($userid, $field, $value, $new = FALSE) {
506
    safe_require('artefact', 'internal');
507 508 509 510

    // this is a special case that replaces the primary email address with the
    // specified one
    if ($field == 'email') {
511 512 513 514 515 516 517
        if (!$new) {
            try {
                $email = artefact_instance_from_type('email', $userid);
            }
            catch (ArtefactNotFoundException $e) {
                // We'll create a new artefact then.
            }
518
        }
519 520
        if (!isset($email)) {
            $email = new ArtefactTypeEmail(0, null, TRUE);
521 522 523 524 525
            $email->set('owner', $userid);
        }
        $email->set('title', $value);
        $email->commit();
    }
526
    else if ($field == 'socialprofile') {
527 528 529 530 531 532 533 534
        if (in_array($value['socialprofile_profiletype'], ArtefactTypeSocialprofile::$socialnetworks)) {
            $desc = get_string($value['socialprofile_profiletype'], 'artefact.internal');
            $type = $value['socialprofile_profiletype'];
        }
        else {
            $desc = $value['socialprofile_profiletype'];
            $type = 'website';
        }
535
        $classname = generate_artefact_class_name($field);
536
        $profile = new $classname(0, array('owner' => $userid), $new);
537
        $profile->set('title',       $value['socialprofile_profileurl']);
538 539
        $profile->set('description', $desc);
        $profile->set('note',        $type);
540 541
        $profile->commit();
    }
542 543
    else {
        $classname = generate_artefact_class_name($field);
544
        $profile = new $classname(0, array('owner' => $userid), $new);
545 546 547
        $profile->set('title', $value);
        $profile->commit();
    }
548 549
}

550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608
/**
 * Update the primary email to an user
 * Add new if not exists
 *
 * @param int $userid The user ID
 * @param string $newemail The new valid email address
 */
function set_user_primary_email($userid, $newemail) {
    safe_require('artefact', 'internal');

    $user = new User();
    $user->find_by_id($userid);

    db_begin();
    // Update user's primary email address
    if ($newemail !== $user->email) {
        // Set the current email address to be secondary
        update_record(
            'artefact_internal_profile_email',
            (object)array(
                'principal' => 0,
            ),
            (object)array(
                'owner' => $user->id,
                'email' => $user->email,
            )
        );
        // If the new primary email address is to be verified, remove it
        delete_records(
            'artefact_internal_profile_email',
            'owner', $user->id,
            'email', $newemail,
            'verified', '0'
        );
        // If the new address is one of the user's email addresses, set it as principal
        if (record_exists(
            'artefact_internal_profile_email',
            'owner', $user->id,
            'email', $newemail)) {
            update_record(
                'artefact_internal_profile_email',
                (object)array(
                    'principal' => 1,
                ),
                (object)array(
                    'owner' => $user->id,
                    'email' => $newemail,
                )
            );
        }
        else {
            // Add new user profile email address
            set_profile_field($user->id, 'email', $newemail, TRUE);
        }
        $user->email = $newemail;
        $user->commit();
    }
    db_commit();
}
609 610 611 612 613
/**
 * Return the value of a profile field for a given user
 *
 * @param integer user id to find the profile field for
 * @param field what profile field you want the value for
614 615 616
 * @returns string for non-socialprofile fields - the value of the profile field.
 *          array for socialprofile fields - array of the values of the profile fields ('id-<id>'|'<description>|'<title>').
 *          null if it doesn't exist
617 618 619 620
 *
 * @todo, this needs to be better (fix email behaviour)
 */
function get_profile_field($userid, $field) {
621 622 623 624 625 626 627
    if ($field == 'email') {
        $value = get_field_sql("
            SELECT a.title
            FROM {usr} u
            JOIN {artefact} a ON (a.title = u.email AND a.owner = u.id)
            WHERE a.artefacttype = 'email' AND u.id = ?", array($userid));
    }
628 629 630 631 632 633 634 635
    else if ($field == 'socialprofile') {
        // First check if the block is enabled.
        if (get_record('blocktype_installed', 'active', 1, 'name', 'socialprofile')) {
            // The user can have more than one social profiles. Will need to return an array.
            safe_require('artefact', 'internal');
            $value = ArtefactTypeSocialprofile::get_social_profiles();
        }
    }
636 637 638
    else {
        $value = get_field('artefact', 'title', 'owner', $userid, 'artefacttype', $field);
    }
639 640 641 642

    if ($value) {
        return $value;
    }
643

644
    return null;
645 646
}

647
/**
648
 * Always use this function for all emails to users
649
 *
650 651 652 653 654
 * @param object $userto user object to send email to. must contain firstname,lastname,preferredname,email
 * @param object $userfrom user object to send email from. If null, email will come from mahara
 * @param string $subject email subject
 * @param string $messagetext text version of email
 * @param string $messagehtml html version of email (will send both html and text)
655
 * @param array  $customheaders email headers
656
 * @throws EmailException
657
 * @throws EmailDisabledException
658
 */
659
function email_user($userto, $userfrom, $subject, $messagetext, $messagehtml='', $customheaders=null) {
660 661 662
    global $IDPJUMPURL;
    static $mnetjumps = array();

663
    if (!get_config('sendemail')) {
664
        // You can entirely disable Mahara from sending any e-mail via the
665 666 667
        // 'sendemail' configuration variable
        return true;
    }
668 669 670 671

    if (empty($userto)) {
        throw new InvalidArgumentException("empty user given to email_user");
    }
672

673
    if (isset($userto->id) && empty($userto->ignoredisabled)) {
674 675 676 677
        $maildisabled = property_exists($userto, 'maildisabled') ? $userto->maildisabled : get_account_preference($userto->id, 'maildisabled') == 1;
        if ($maildisabled) {
            throw new EmailDisabledException("email for this user has been disabled");
        }
678 679
    }

680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702
    // If the user is a remote xmlrpc user, trawl through the email text for URLs
    // to our wwwroot and modify the url to direct the user's browser to login at
    // their home site before hitting the link on this site
    if (!empty($userto->mnethostwwwroot) && !empty($userto->mnethostapp)) {
        require_once(get_config('docroot') . 'auth/xmlrpc/lib.php');

        // Form the request url to hit the idp's jump.php
        if (isset($mnetjumps[$userto->mnethostwwwroot])) {
            $IDPJUMPURL = $mnetjumps[$userto->mnethostwwwroot];
        } else {
            $mnetjumps[$userto->mnethostwwwroot] = $IDPJUMPURL = PluginAuthXmlrpc::get_jump_url_prefix($userto->mnethostwwwroot, $userto->mnethostapp);
        }

        $wwwroot = get_config('wwwroot');
        $messagetext = preg_replace_callback('%(' . $wwwroot . '([\w_:\?=#&@/;.~-]*))%',
            'localurl_to_jumpurl',
            $messagetext);
        $messagehtml = preg_replace_callback('%href=["\'`](' . $wwwroot . '([\w_:\?=#&@/;.~-]*))["\'`]%',
            'localurl_to_jumpurl',
            $messagehtml);
    }


703
    require_once('phpmailer/PHPMailerAutoload.php');
704

705
    $mail = new PHPMailer(true);
706

707 708 709 710 711 712
    $mail->CharSet = 'UTF-8';

    $smtphosts = get_config('smtphosts');
    if ($smtphosts == 'qmail') {
        // use Qmail system
        $mail->IsQmail();
713
    }
714 715 716 717 718 719 720 721 722 723
    else if (empty($smtphosts)) {
        // use PHP mail() = sendmail
        $mail->IsMail();
    }
    else {
        $mail->IsSMTP();
        // use SMTP directly
        $mail->Host = get_config('smtphosts');
        if (get_config('smtpuser')) {
            // Use SMTP authentication
724 725 726 727 728
            $mail->SMTPAuth   = true;
            $mail->Username   = get_config('smtpuser');
            $mail->Password   = get_config('smtppass');
            $mail->SMTPSecure = get_config('smtpsecure');
            $mail->Port       = get_config('smtpport');
729 730 731 732 733 734 735 736 737
            if (get_config('smtpsecure') && !get_config('smtpport')) {
                // Encrypted connection with no port. Use default one.
                if (get_config('smtpsecure') == 'ssl') {
                    $mail->Port = 465;
                }
                elseif (get_config('smtpsecure') == 'tls') {
                    $mail->Port = 587;
                }
            }
738 739 740
        }
    }

741 742
    if (get_config('bounces_handle') && !empty($userto->id) && empty($maildisabled)) {
        $mail->Sender = generate_email_processing_address($userto->id, $userto);
743
    }
744
    if (empty($userfrom) || $userfrom->email == get_config('noreplyaddress')) {
745 746 747 748
        if (empty($mail->Sender)) {
            $mail->Sender = get_config('noreplyaddress');
        }
        $mail->From = get_config('noreplyaddress');
749
        $mail->FromName = (isset($userfrom->id)) ? display_name($userfrom, $userto) : get_config('sitename');
750
        $customheaders[] = 'Precedence: Bulk'; // Try to avoid pesky out of office responses
751
        $messagetext .= "\n\n" . get_string('pleasedonotreplytothismessage') . "\n";
752
        if ($messagehtml) {
753
            $messagehtml .= "\n\n<p>" . get_string('pleasedonotreplytothismessage') . "</p>\n";
754
        }
755 756
    }
    else {
757 758 759 760
        if (empty($mail->Sender)) {
            $mail->Sender = $userfrom->email;
        }
        $mail->From = $userfrom->email;
761 762
        $mail->FromName = display_name($userfrom, $userto);
    }
763
    $replytoset = false;
764 765
    if (!empty($customheaders) && is_array($customheaders)) {
        foreach ($customheaders as $customheader) {
766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783
            // To prevent duplicated declaration of the field "Message-ID",
            // don't add it into the $mail->CustomHeader[].
            if (false === stripos($customheader, 'message-id')) {
                // Hack the fields "In-Reply-To" and "References":
                // add touser<userID>
                if ((0 === stripos($customheader, 'in-reply-to')) ||
                    (0 === stripos($customheader, 'references'))) {
                    $customheader = preg_replace('/<forumpost(\d+)/', '<forumpost${1}touser' . $userto->id, $customheader);
                }
                $mail->AddCustomHeader($customheader);
            }
            else {
                list($h, $msgid) = explode(':', $customheader, 2);
                // Hack the "Message-ID": add touser<userID> to make sure
                // the "Message-ID" is unique
                $msgid = preg_replace('/<forumpost(\d+)/', '<forumpost${1}touser' . $userto->id, $msgid);
                $mail->MessageID = trim($msgid);
            }
784 785 786
            if (0 === stripos($customheader, 'reply-to')) {
                $replytoset = true;
            }
787 788
        }
    }
789

790
    $mail->Subject = substr(stripslashes($subject), 0, 900);
791

792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810
    try {
        if ($to = get_config('sendallemailto')) {
            // Admins can configure the system to send all email to a given address
            // instead of whoever would receive it, useful for debugging.
            $usertoname = display_name($userto, $userto, true) . ' (' . get_string('divertingemailto', 'mahara', $to) . ')';
            $mail->addAddress($to);
            $notice = get_string('debugemail', 'mahara', display_name($userto, $userto), $userto->email);
            $messagetext =  $notice . "\n\n" . $messagetext;
            if ($messagehtml) {
                $messagehtml = '<p>' . hsc($notice) . '</p>' . $messagehtml;
            }
        }
        else {
            $usertoname = display_name($userto, $userto);
            $mail->AddAddress($userto->email, $usertoname );
            $to = $userto->email;
        }
        if (!$replytoset) {
            $mail->AddReplyTo($mail->From, $mail->FromName);
811 812
        }
    }
813
    catch (phpmailerException $e) {
814 815 816 817
        // If there's a phpmailer error already, assume it's an invalid address
        throw new InvalidEmailException("Cannot send email to $usertoname with subject $subject. Error from phpmailer was: " . $mail->ErrorInfo);
    }

818
    $mail->WordWrap = 79;
819

820
    if ($messagehtml) {
821 822 823
        $mail->IsHTML(true);
        $mail->Encoding = 'quoted-printable';
        $mail->Body    =  $messagehtml;
824
        $mail->AltBody =  $messagetext;
825
    }
826 827
    else {
        $mail->IsHTML(false);
828
        $mail->Body =  $messagetext;
829 830
    }

831 832 833 834 835 836 837 838
    try {
        $sent = $mail->Send();
    }
    catch (phpmailerException $e) {
        $sent = false;
    }

    if ($sent) {
839 840 841 842 843 844 845
        if ($logfile = get_config('emaillog')) {
            $docroot = get_config('docroot');
            @$client = (string) $_SERVER['REMOTE_ADDR'];
            @$script = (string) $_SERVER['SCRIPT_FILENAME'];
            if (strpos($script, $docroot) === 0) {
                $script = substr($script, strlen($docroot));
            }
846
            $line = "$to <- $mail->From - " . str_shorten_text($mail->Subject, 200);
847 848 849
            @error_log('[' . date("Y-m-d h:i:s") . "] [$client] [$script] $line\n", 3, $logfile);
        }

850 851 852 853
        if (get_config('bounces_handle')) {
            // Update the count of sent mail
            update_send_count($userto);
        }
854

855
        return true;
856
    }
857 858 859 860
    throw new EmailException("Couldn't send email to $usertoname with subject $subject. "
                        . "Error from phpmailer was: " . $mail->ErrorInfo );
}

861 862 863 864 865 866 867 868 869 870 871 872 873 874
/**
 * Generate an email processing address for VERP handling of email
 *
 * @param int $userid the ID of the user sending the mail
 * @param object $userto an object containing the email address
 * @param char $type The type of address to generate
 *
 * The type of address is typically a Bounce. These are processed by the
 * process_email function.
 */
function generate_email_processing_address($userid, $userto, $type='B') {
    $mailprefix = get_config('bounceprefix');
    $maildomain = get_config('bouncedomain');
    $installation_key = get_config('installation_key');
875 876 877
    // Postfix and other smtp servers don't like the use of / in the extension part of an email
    // Replace it with another valid email character that isn't in base64, like '-'
    $args = $type . preg_replace('/\//', '-', base64_encode(pack('V', $userid))) . substr(md5($userto->email), 0, 16);
878 879 880
    return $mailprefix . $args . substr(md5($mailprefix . $userto->email . $installation_key), 0, 16) . '@' . $maildomain;
}

881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896
/**
 * Check whether an email account is over the site-wide bounce threshold.
 * If the user is over threshold, then e-mail is disabled for their
 * account, and they are sent a notification to notify them of the change.
 *
 * @param object $mailinfo The row from artefact_internal_profile_email for
 * the user being processed.
 * @return boolean false if the user is not over threshold, true if they
 * are.
 */
function check_overcount($mailinfo) {
    // if we don't handle bounce e-mails, then we can't be over threshold
    if (!get_config('bounces_handle')) {
        return false;
    }

897 898 899 900
    $minbounces = get_config('bounces_min');
    $bounceratio = get_config('bounces_ratio');
    // If they haven't set a minbounces value, then we can't proceed
    if (!$minbounces) {
901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937
        return false;
    }

    if ($mailinfo->mailssent == 0) {
        return false;
    }

    // If the bouncecount is larger than the allowed amount
    // and the bounce count ratio (bounces/total sent) is larger than the
    // bounceratio, then disable email
    $overlimit = ($mailinfo->mailsbounced >= $minbounces) && ($mailinfo->mailsbounced/$mailinfo->mailssent >= $bounceratio);

    if ($overlimit) {
        if (get_account_preference($mailinfo->owner,'maildisabled') != 1) {
            // Disable the e-mail account
            db_begin();
            set_account_preference($mailinfo->owner, 'maildisabled', 1);

            $lang = get_user_language($mailinfo->owner);

            // Send a notification that e-mail has been disabled
            $message = new StdClass;
            $message->users = array($mailinfo->owner);

            $message->subject = get_string_from_language($lang, 'maildisabled', 'account');
            $message->message = get_string_from_language($lang, 'maildisabledbounce', 'account', get_config('wwwroot') . 'account/');

            require_once('activity.php');
            activity_occurred('maharamessage', $message);

            db_commit();
        }
        return true;
    }
    return false;
}

938 939 940 941 942 943 944 945 946 947 948 949
/**
 * Update the send count for the specified e-mail address
 *
 * @param object $userto object to update count for. Must contain email and
 * user id
 * @param boolean reset Reset the sent mail count to 0 (optional).
 */
function update_send_count($userto, $reset=false) {
    if (!$userto->id) {
        // We need a user id to update the send count.
        return false;
    }
950
    if ($mailinfo = get_record_select('artefact_internal_profile_email', '"owner" = ? AND email = ? AND principal = 1', array($userto->id, $userto->email))) {
951 952 953 954 955
        $mailinfo->mailssent = (!empty($reset)) ? 0 : $mailinfo->mailssent+1;
        update_record('artefact_internal_profile_email', $mailinfo, array('email' => $userto->email, 'owner' => $userto->id));
    }
}

956 957 958 959 960 961 962 963 964 965 966 967
/**
 * Update the bounce count for the specified e-mail address
 *
 * @param object $userto object to update count for. Must contain email and
 * user id
 * @param boolean reset Reset the sent mail count to 0 (optional).
 */
function update_bounce_count($userto, $reset=false) {
    if (!$userto->id) {
        // We need a user id to update the bounce count.
        return false;
    }
968
    if ($mailinfo = get_record_select('artefact_internal_profile_email', '"owner" = ? AND email = ? AND principal = 1', array($userto->id, $userto->email))) {
969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992
        $mailinfo->mailsbounced = (!empty($reset)) ? 0 : $mailinfo->mailsbounced+1;
        update_record('artefact_internal_profile_email', $mailinfo, array('email' => $userto->email, 'owner' => $userto->id));
    }
}

/**
 * Process an incoming email
 *
 * @param string $address the email address to process
 */
function process_email($address) {

    $email = new StdClass;

    if (strlen($address) <= 30) {
        log_debug ('-- Email address not long enough to contain valid data.');
        return $email;
    }

    if (!strstr($address, '@')) {
        log_debug ('-- Email address does not contain @.');
        return $email;
    }

993 994 995
    $mailprefix = get_config('bounceprefix');
    $prefixlength = strlen($mailprefix);

996
    list($email->localpart,$email->domain) = explode('@',$address);
997 998
    // The prefix is stored in the first characters denoted by $prefixlength
    $email->prefix        = substr($email->localpart, 0, $prefixlength);
999
    // The type of message received is a one letter code
1000
    $email->type          = substr($email->localpart, $prefixlength, 1);
1001
    // The userid should be available immediately afterwards
1002 1003 1004
    // Postfix and other smtp servers don't like the use of / in the extension part of an email
    // We may of replaced it with another valid email character which isn't in base64, namely '-'
    // If we didn't, then the preg_replace won't do anything
1005
    list(,$email->userid) = unpack('V',base64_decode(preg_replace('/-/', '/', substr($email->localpart, $prefixlength + 1, 8))));
1006
    // Any additional arguments
1007
    $email->args          = substr($email->localpart, $prefixlength + 9,-16);
1008 1009 1010 1011 1012 1013 1014 1015 1016 1017
    // And a hash of the intended recipient for authentication
    $email->addresshash   = substr($email->localpart,-16);

    if (!$email->userid) {
        log_debug('-- no userid associated with this email address');
        return $email;
    }

    switch ($email->type) {
    case 'B': // E-mail bounces
1018
        if ($user = get_record_select('artefact_internal_profile_email', '"owner" = ? AND principal = 1', array($email->userid))) {
1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035
            $maildomain = get_config('bouncedomain');
            $installation_key = get_config('installation_key');
            // check the half md5 of their email
            $md5check = substr(md5($mailprefix . $user->email . $installation_key), 0, 16);
            $user->id = $user->owner;
            if ($md5check == substr($email->addresshash, -16)) {
                update_bounce_count($user);
                check_overcount($user);
            }
            // else maybe they've already changed their email address
        }
        break;
        // No more cases yet
    }
    return $email;
}

1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074
/**
 * Check an imap mailbox for new mailbounces
 */
function check_imap_for_bounces() {
    $imapserver = get_config('imapserver');
    if (!$imapserver) {
        return;
    }
    if (!extension_loaded('imap')) {
        log_debug('php imap extension not loaded, can\'t continue');
        return;
    }
    $imapport = get_config('imapport');
    $imap = imap_open("{" . $imapserver . ($imapport ? ':' . $imapport : '') . get_config('imapflags') . '}' . get_config('imapmailbox'),
                        get_config('imapuser'), get_config('imappass'));
    $check = imap_check($imap);
    if ($check->Nmsgs == 0) {
        imap_close($imap);
        return;
    }
    $emails = imap_fetch_overview($imap, "1:" . $check->Nmsgs);
    foreach ($emails as $email) {
        if ($email->deleted) {
            continue;
        }
        $address = $email->to;
        log_debug('---------- started  processing email at ' . date('r', time()) . ' ----------');
        log_debug('-- mail from ' . $address . ' -- delivered ' . $email->date);

        $ret = process_email($address);

        log_debug('---------- finished processing email at ' . date('r', time()) . ' ----------');

        imap_delete($imap, $email->msgno);
    }
    imap_expunge($imap);
    imap_close($imap);
}

1075 1076 1077 1078 1079 1080 1081
/**
 * converts a user object to a string representation of the user suitable for
 * the current user (or specified user) to see
 *
 * Both parameters should be objects containing id, preferredname, firstname,
 * lastname, admin
 *
1082
 * @param mixed $user the user that you're trying to format to a string (accepts an integer, object, or array)
1083
 * @param object $userto the user that is looking at the string representation (if left
1084
 * blank, will default to the currently logged in user).
1085
 * @param boolean $nameonly do not append the user's username even if $userto can see it.
1086
 * @param boolean $realname show the user's real name even if preferredname exists
1087
 * @param boolean $username show the user's username even if the viewer is not an admin
1088 1089 1090
 *
 * @returns string name to display
 */
1091
function display_name($user, $userto=null, $nameonly=false, $realname=false, $username=false) {
Pat Kira's avatar
Pat Kira committed
1092

1093
    global $USER;
1094
    static $tutorcache  = array();
Nigel McNie's avatar
Nigel McNie committed
1095

1096 1097 1098 1099
    if ($nameonly) {
        return display_default_name($user);
    }

1100
    $nousernames = get_config('nousernames');
1101 1102
    $userto = get_user_for_display($userto);
    $user   = get_user_for_display($user);
1103

1104
    $addusername = ($username && empty($nousernames)) || !empty($userto->admin) || !empty($userto->staff);
Nigel McNie's avatar
Nigel McNie committed
1105

1106 1107
    // if they don't have a preferred name set, just return here
    if (empty($user->preferredname)) {
1108 1109
        $firstlast = full_name($user);
        if ($addusername) {
1110
            return $firstlast . ' (' . display_username($user) . ')';
1111
        }
1112
        return $firstlast;
1113
    }
1114 1115
    else if ($user->id == $userto->id) {
        // If viewing our own name, show it how we like it
1116
        return $user->preferredname;
1117
    }
1118

1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129
    // Preferred name is set
    $addrealname = $realname || !empty($userto->admin) || !empty($userto->staff);

    if (!$addrealname) {
        // Tutors can always see the user's real name, so we need to check if the
        // viewer is a tutor of the user whose name is being displayed
        if (!isset($tutorcache[$user->id][$userto->id])) {
            $tutorcache[$user->id][$userto->id] = record_exists_sql('
                SELECT s.member
                FROM {group_member} s
                JOIN {group_member} t ON s.group = t.group
1130
                JOIN {group} g ON (g.id = s.group AND g.deleted = 0 AND g.submittableto = 1)
1131 1132 1133 1134 1135 1136 1137
                JOIN {grouptype_roles} gtr
                    ON (g.grouptype = gtr.grouptype AND gtr.role = t.role AND gtr.see_submitted_views = 1)
                WHERE s.member = ? AND t.member = ?',
                array($user->id, $userto->id)
            );
        }
        $addrealname = $tutorcache[$user->id][$userto->id];
1138 1139
    }

1140 1141 1142
    if ($addrealname) {
        $firstlast = full_name($user);
        if ($addusername) {
1143
            return $user->preferredname . ' (' . $firstlast . ' - ' . display_username($user) . ')';
1144 1145
        }
        return $user->preferredname . ' (' . $firstlast . ')';
1146
    }
1147
    if ($addusername) {
1148
        return $user->preferredname . ' (' . display_username($user) . ')';
1149 1150
    }
    return $user->preferredname;
1151 1152
}

1153 1154 1155
/**
 * function to format a users name when there is no user to look at them
 * ie when display_name is not going to work..
1156
 */
1157
function display_default_name($user) {
1158
    $user = get_user_for_display($user);
1159
    return empty($user->preferredname) ? full_name($user) : $user->preferredname;
1160 1161 1162 1163
}



1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178
/**
 * Converts a user object to a full name representation, honouring the language
 * setting.
 *
 * Currently a stub, will need to be improved and completed as demand arises.
 *
 * @param object $user The user object to make a full name out of. If empty,
 *                     the global $USER object is used*/
function full_name($user=null) {
    global $USER;

    if ($user === null) {
        $user = new StdClass;
        $user->firstname = $USER->get('firstname');
        $user->lastname  = $USER->get('lastname');
1179
        $user->deleted   = $USER->get('deleted');
1180 1181
    }

1182
    return isset($user->deleted) && $user->deleted ? get_string('deleteduser') : $user->firstname . ' ' . $user->lastname;
1183
}
1184

1185 1186 1187 1188 1189 1190 1191 1192 1193 1194
/**
 * Takes an array, object or integer identifying a user and returns an object with
 * the properties needed for display_name, display_default_name, or profile_icon_url.
 */
function get_user_for_display($user=null) {
    global $USER;
    static $usercache = array();

    $fields = array(
        'id', 'username', 'preferredname', 'firstname', 'lastname', 'admin', 'staff',
1195
        'profileicon', 'email', 'deleted', 'urlid', 'suspendedctime',
1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209
    );

    if (is_numeric($user) && isset($usercache[$user])) {
        return $usercache[$user];
    }

    if (is_array($user)) {
        $user = (object)$user;
    }
    else if (is_null($user) || (is_numeric($user) && $user == $USER->get('id'))) {
        $user = new StdClass;
        foreach ($fields as $f) {
            $user->$f = $USER->get($f);
        }
1210 1211
        $user->admin = $user->admin || $USER->is_institutional_admin();
        $user->staff = $user->staff || $USER->is_institutional_staff();
1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246
    }
    else if ($user instanceof User) {
        $userObj = $user;
        $user = new StdClass;
        foreach ($fields as $f) {
            $user->$f = $userObj->get($f);
        }
    }
    else if (is_numeric($user)) {
        $user = get_record('usr', 'id', $user);
    }

    if (!is_object($user)) {
        throw new InvalidArgumentException("Invalid user passed to get_user_for_display");
    }

    if (!isset($user->id)) {
        $user->id = null;
    }

    if (is_numeric($user->id)) {
        if (!isset($usercache[$user->id])) {
            return $usercache[$user->id] = $user;
        }
        foreach ($fields as $f) {
            if (!isset($usercache[$user->id]->$f) && isset($user->$f)) {
                $usercache[$user->id]->$f = $user->$f;
            }
        }
        return $usercache[$user->id];
    }

    return $user;
}

1247 1248 1249 1250 1251 1252 1253 1254 1255 1256
/**
 * Creates a string containing a displayable username.
 *
 * If the username is longer than 30 characters (bug #548165), then print
 * the first 30 characters followed by '...'
 *
 * @param object $user The user object to display the username of. If empty,
 *                     the global $USER object is used
 */
function display_username($user=null) {
Pat Kira's avatar
Pat Kira committed
1257 1258


1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272
    global $USER;

    if ($user === null) {
        $user = new StdClass;
        $user->username = $USER->get('username');
    }

    if (strlen($user->username) > MAX_USERNAME_DISPLAY) {
        return substr($user->username, 0, MAX_USERNAME_DISPLAY).'...';
    }
    else {
        return $user->username;
    }
}
1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287

/**
 * helper function to default to currently
 * logged in user if there isn't an id specified
 * @throws InvalidArgumentException if there is no user and no $USER
 */
function optional_userid($userid) {

    if (!empty($userid)) {
        return $userid;
    }

    if (!is_logged_in()) {
        throw new InvalidArgumentException("optional_userid no userid and no logged in user");
    }
1288

1289 1290 1291 1292
    global $USER;
    return $USER->get('id');
}

1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305


/**
 * helper function to default to currently
 * logged in user if there isn't an id specified
 * @throws InvalidArgumentException if there is no user and no $USER
 */
function optional_userobj($user) {

    if (!empty($user) && is_object($user)) {
        return $user;
    }

1306
    if (!empty($user) && is_numeric($user)) {
1307 1308 1309 1310 1311 1312 1313 1314 1315
        if ($user = get_record('usr', 'id', $user)) {
            return $user;
        }
        throw new InvalidArgumentException("optional_userobj given id $id no db match found");
    }

    if (!is_logged_in()) {
        throw new InvalidArgumentException("optional_userobj no userid and no logged in user");
    }
1316

1317 1318 1319 1320 1321 1322 1323
    global $USER;
    return $USER->to_stdclass();
}




1324 1325 1326
/**
 * helper function for testing logins
 */
1327 1328
function is_logged_in() {
    global $USER;
Martyn Smith's avatar
Martyn Smith committed
1329 1330 1331 1332 1333
    if (empty($USER)) {
        return false;
    }

    return $USER->is_logged_in();
1334 1335
}

1336 1337 1338
/**
 * is there a friend relationship between these two users?
 *
1339
 * @param int $userid1
1340 1341 1342 1343
 * @param int $userid2
 */

function is_friend($userid1, $userid2) {
1344
    return record_exists_select('usr_friend', '(usr1 = ? AND usr2 = ?) OR (usr2 = ? AND usr1 = ?)',
1345 1346 1347 1348 1349 1350 1351 1352 1353 1354
                                array($userid1, $userid2, $userid1, $userid2));
}

/**
 * has there been a request between these two users?
 *
 * @param int $userid1
 * @param int $userid2
 */
function get_friend_request($userid1, $userid2) {
1355
    return get_record_select('usr_friend_request', '("owner" = ? AND requester = ?) OR (requester = ? AND "owner" = ?)',
1356
                             array($userid1, $userid2, $userid1, $userid2));
1357 1358

}
1359

1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370
/**
 * Returns an object containing information about a user, including account
 * and activity preferences
 *
 * @param int $userid The ID of the user to retrieve information about
 * @return object     The user object. Note this is not in the same form as
 *                    the $USER object used to denote the current user -
 *                    the object returned by this method is a simple object.
 */
function get_user($userid) {
    if (!$user = get_record('usr', 'id', $userid, null, null, null, null,
1371 1372 1373
        '*, ' . db_format_tsfield('expiry') . ', ' . db_format_tsfield('lastlogin') .
        ', ' . db_format_tsfield('lastlastlogin') . ', ' . db_format_tsfield('lastaccess') .
        ', ' . db_format_tsfield('suspendedctime') . ', ' . db_format_tsfield('ctime'))) {
1374 1375 1376 1377 1378 1379 1380 1381
        throw new InvalidArgumentException('Unknown user ' . $userid);
    }

    $user->activityprefs = load_activity_preferences($userid);
    $user->accountprefs  = load_account_preferences($userid);
    return $user;
}

1382

1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394
/**
 * Suspends a user
 *
 * @param int $suspendeduserid  The ID of the user to suspend
 * @param string $reason        The reason why the user is being suspended
 * @param int $suspendinguserid The ID of the user who is performing the suspension
 */
function suspend_user($suspendeduserid, $reason, $suspendinguserid=null) {
    if ($suspendinguserid === null) {
        global $USER;
        $suspendinguserid = $USER->get('id');
    }
1395

1396 1397 1398 1399 1400 1401
    $suspendrec = new StdClass;
    $suspendrec->id              = $suspendeduserid;
    $suspendrec->suspendedcusr   = $suspendinguserid;
    $suspendrec->suspendedreason = $reason;
    $suspendrec->suspendedctime  = db_format_timestamp(time());
    update_record('usr', $suspendrec, 'id');
1402

1403 1404 1405 1406
    // Try to kick the user from any active login session.
    require_once(get_config('docroot') . 'auth/session.php');
    remove_user_sessions($suspendeduserid);

1407
    $lang = get_user_language($suspendeduserid);
1408 1409
    $message = new StdClass;
    $message->users = array($suspendeduserid);
1410
    $message->subject = get_string_from_language($lang, 'youraccounthasbeensuspended');
1411 1412 1413 1414 1415 1416 1417 1418
    if ($reason == '') {
        $message->message = get_string_from_language($lang, 'youraccounthasbeensuspendedtext2', 'mahara',
            get_config('sitename'), display_name($suspendinguserid, $suspendeduserid));
    }
    else {
        $message->message = get_string_from_language($lang, 'youraccounthasbeensuspendedreasontext', 'mahara',
            get_config('sitename'), display_name($suspendinguserid, $suspendeduserid), $reason);
    }
1419
    require_once('activity.php');
1420 1421
    activity_occurred('maharamessage', $message);

1422 1423
    handle_event('suspenduser', $suspendeduserid);
}
1424

1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437
/**
 * Unsuspends a user
 *
 * @param int $userid The ID of the user to unsuspend
 */
function unsuspend_user($userid) {
    $suspendedrec = new StdClass;
    $suspendedrec->id = $userid;
    $suspendedrec->suspendedcusr = null;
    $suspendedrec->suspendedreason = null;
    $suspendedrec->suspendedctime  = null;
    update_record('usr', $suspendedrec);

1438
    $lang = get_user_language($userid);
1439 1440
    $message = new StdClass;
    $message->users = array($userid);
1441
    $message->subject = get_string_from_language($lang, 'youraccounthasbeenunsuspended');
1442
    $message->message = get_string_from_language($lang, 'youraccounthasbeenunsuspendedtext2', 'mahara', get_config('sitename'));
1443
    require_once('activity.php');
1444 1445 1446 1447 1448 1449 1450 1451
    activity_occurred('maharamessage', $message);

    handle_event('unsuspenduser', $userid);
}

/**
 * Deletes a user
 *
1452 1453
 * This function ensures that a user is deleted according to how Mahara wants a
 * deleted user to be. You can call it multiple times on the same user without
1454 1455
 * harm.
 *
1456 1457 1458
 * @param int $userid The ID of the user to delete
 */
function delete_user($userid) {
1459 1460
    db_begin();

1461
    // We want to append 'deleted.timestamp' to some unique fields in the usr
1462 1463
    // table, so they can be reused by new accounts
    $fieldstomunge = array('username', 'email');
1464
    $datasuffix = '.deleted.' . microtime(true);
1465

1466 1467
    $user = get_record('usr', 'id', $userid, null, null, null, null, implode(', ', $fieldstomunge));

1468 1469 1470
    $deleterec = new StdClass;
    $deleterec->id = $userid;
    $deleterec->deleted = 1;
1471 1472 1473 1474 1475
    foreach ($fieldstomunge as $field) {
        if (!preg_match('/\.deleted\.\d+$/', $user->$field)) {
            $deleterec->$field = $user->$field . $datasuffix;
        }
    }
1476 1477 1478

    // Set authinstance to default internal, otherwise the old authinstance can be blocked from deletion
    // by deleted users.
1479
    $authinst = get_field('auth_instance', 'id', 'institution', 'mahara', 'authname', 'internal');
1480
    if ($authinst) {
1481
        $deleterec->authinstance = $authinst;
1482 1483
    }

1484 1485 1486
    // Free the urlid for another user to use
    $deleterec->urlid = null;

1487 1488
    update_record('usr', $deleterec);

1489
    // Remove user from any groups they're in, invited to or want to be in
1490 1491 1492 1493 1494 1495 1496
    $groupids = get_column('group_member', '"group"', 'member', $userid);
    if ($groupids) {
        require_once(get_config('libroot') . 'group.php');
        foreach ($groupids as $groupid) {
            group_remove_user($groupid, $userid, true);
        }
    }
1497 1498
    delete_records('group_member_request', 'member', $userid);
    delete_records('group_member_invite', 'member', $userid);
1499

1500 1501 1502 1503 1504 1505 1506 1507
    // Remove any friend relationships the user is in
    execute_sql('DELETE FROM {usr_friend}
        WHERE usr1 = ?
        OR usr2 = ?', array($userid, $userid));
    execute_sql('DELETE FROM {usr_friend_request}
        WHERE owner = ?
        OR requester = ?', array($userid, $userid));

1508 1509 1510 1511 1512 1513
    // Delete the user from others' favourites lists
    delete_records('favorite_usr', 'usr', $userid);
    // Delete favourites lists owned by the user
    execute_sql('DELETE FROM {favorite_usr} WHERE favorite IN (SELECT id FROM {favorite} WHERE owner = ?)', array($userid));
    delete_records('favorite', 'owner', $userid);

1514
    delete_records('artefact_access_usr', 'usr', $userid);
1515
    delete_records('auth_remote_user', 'localusr', $userid);
1516 1517 1518 1519 1520 1521 1522 1523
    delete_records('import_queue', 'usr', $userid);
    delete_records('usr_account_preference', 'usr', $userid);
    delete_records('usr_activity_preference', 'usr', $userid);
    delete_records('usr_infectedupload', 'usr', $userid);
    delete_records('usr_institution', 'usr', $userid);
    delete_records('usr_institution_request', 'usr', $userid);
    delete_records('usr_password_request', 'usr', $userid);
    delete_records('usr_watchlist_view', 'usr', $userid);
1524
    delete_records('view_access', 'usr', $userid);
1525
    delete_records('usr_login_data', 'usr', $userid);
1526 1527 1528 1529 1530