user.php 114 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);

Aaron Wells's avatar
Aaron Wells committed
16
/**
Penny Leach's avatar
Penny Leach committed
17 18
 * loads up activity preferences for a given user
 *
Aaron Wells's avatar
Aaron Wells committed
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");
    }
Richard Mansfield's avatar
Richard Mansfield committed
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;
}

Aaron Wells's avatar
Aaron Wells committed
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
 *
Aaron Wells's avatar
Aaron Wells committed
40
 * @param int $userid to load preferences for
Penny Leach's avatar
Penny Leach committed
41
 * @todo caching
Aaron Wells's avatar
Aaron Wells committed
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;
}


Aaron Wells's avatar
Aaron Wells committed
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
Aaron Wells's avatar
Aaron Wells committed
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 77 78 79 80 81 82 83
    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
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101
    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");
        }
    }
}

102

Aaron Wells's avatar
Aaron Wells committed
103
/**
104
 * Change language-specific stuff in the db for a user.  Currently
105 106
 * 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
107
 * sideblock
108 109 110 111 112 113
 *
 * @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) {
114 115 116 117
    if (get_field('artefact_installed', 'active', 'name', 'file')) {
        safe_require('artefact', 'file');
        ArtefactTypeFolder::change_language($userid, $oldlang, $newlang);
    }
Francois Marier's avatar
Francois Marier committed
118 119
    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));
120
    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));
121 122
}

Aaron Wells's avatar
Aaron Wells committed
123
/**
Penny Leach's avatar
Penny Leach committed
124 125
 * sets an activity preference in the database
 * if you want to set it in the session as well
Aaron Wells's avatar
Aaron Wells committed
126
 * use $SESSION->set_activity_preference
Penny Leach's avatar
Penny Leach committed
127 128
 *
 * @param int $userid user id to set preference for
129
 * @param int $activity activity type to set
Penny Leach's avatar
Penny Leach committed
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
 * @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 "
146
                ." $method for $activity for user $userid");
Penny Leach's avatar
Penny Leach committed
147 148 149 150
        }
    }
}

151
/**
Aaron Wells's avatar
Aaron Wells committed
152
 * gets an account preference for the user,
153 154 155 156 157 158 159
 * 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) {
160
    if ($pref = get_record('usr_account_preference', 'usr', $userid, 'field', $field)) {
161 162 163 164 165 166
        return $pref->value;
    }
    $expected = expected_account_preferences();
    return $expected[$field];
}

167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
/**
 * Returns the user preferred limit if there is one
 *
 * @param int    $limit
 * @param string $field   The account preference to check. To allow for having more than one limit
 *                        for different parts of the system.
 * @param mixed  $userid  Can be user object or id. If left blank then current $USER id will be used
 *
 * @return int $limit
 */
function user_preferred_limit($limit, $field = 'viewsperpage', $userid = null) {
    global $USER;

    if ($userid instanceof User) {
        $userid = $userid->id;
    }
    else if ($userid === null) {
        $userid = $USER->get('id');
    }

    $userlimit = get_account_preference($userid, $field);
    if ($limit > 0 && $limit != $userlimit) {
        set_account_preference($userid, $field, $limit);
    }
    else {
        $limit = $userlimit;
    }
    return $limit;
}
196 197 198 199

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

        // Check for an institution language
202 203 204
        $instlang = get_user_institution_language($userid);
        if (!empty($instlang) && $instlang != 'default') {
            return $instlang;
205 206 207
        }

        // Use the site language
208 209 210 211 212 213
        return get_config('lang');
    }
    return $langpref;
}


214 215
/**
 * default account settings
Aaron Wells's avatar
Aaron Wells committed
216
 *
217 218
 * @returns array of fields => values
 */
Penny Leach's avatar
Penny Leach committed
219 220 221
function expected_account_preferences() {
    return array('friendscontrol' => 'auth',
                 'wysiwyg'        =>  1,
222
                 'licensedefault' => '',
Penny Leach's avatar
Penny Leach committed
223
                 'messages'       => 'allow',
224
                 'lang'           => 'default',
225
                 'addremovecolumns' => 0,
226
                 'maildisabled'   => 0,
227
                 'tagssideblockmaxtags' => get_config('tagssideblockmaxtags'),
228
                 'groupsideblockmaxgroups' => '',
229
                 'groupsideblocksortby' => 'alphabetical',
230
                 'hiderealname'   => 0,
231
                 'multipleblogs' => get_config('defaultmultipleblogs'),
232
                 'showhomeinfo' => 1,
233
                 'showprogressbar' => 1,
234
                 'theme' => '',
235
                 'resizeonuploaduserdefault' => 1,
236
                 'devicedetection' => 1,
237
                 'licensedefault' => '',
238
                 'viewsperpage' => 20,
239
                 'itemsperpage' => 10,
240
                 'orderpagesby' => 'latestmodified',
241
                 'searchinfields' => 'titleanddescriptionandtags'
Penny Leach's avatar
Penny Leach committed
242 243 244
                 );
}

245
function general_account_prefs_form_elements($prefs) {
246 247
    global $USER;
    require_once('license.php');
248 249 250 251 252 253 254 255 256 257 258 259 260
    $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(
261
        'type' => 'switchbox',
262 263 264 265 266
        'defaultvalue' => (get_config('wysiwyg')) ? get_config('wysiwyg') == 'enable' : $prefs->wysiwyg,
        'title' => get_string('wysiwygdescr', 'account'),
        'help' => true,
        'disabled' => get_config('wysiwyg'),
    );
267 268 269 270
    if (get_config('licensemetadata')) {
        $elements['licensedefault'] = license_form_el_basic(null);
        $elements['licensedefault']['title'] = get_string('licensedefault','account');
        if ($USER->get('institutions')) {
271
            $elements['licensedefault']['options'][LICENSE_INSTITUTION_DEFAULT] = get_string('licensedefaultinherit','account');
272 273
        }
        $elements['licensedefault']['description'] = get_string('licensedefaultdescription','account');
274
        if (isset($prefs->licensedefault)) {
275 276 277
            $elements['licensedefault']['defaultvalue'] = $prefs->licensedefault;
        }
    }
278
    $elements['maildisabled'] = array(
279
        'type' => 'switchbox',
280
        'defaultvalue' => $prefs->maildisabled,
281
        'title' => get_string('disableemail', 'account'),
282 283 284 285 286 287 288 289 290 291 292 293 294 295
        '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();
296 297 298 299 300 301 302 303
    // 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')] . ')';
    }
304

Liam Sharpe's avatar
Liam Sharpe committed
305 306 307 308 309 310 311 312 313 314 315 316
    $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
317
        // institution theme. On save it sets user_account_preference to '' to allow the use of higher up theme.
Liam Sharpe's avatar
Liam Sharpe committed
318 319 320 321
        $sitethemes = array_reverse(get_user_accessible_themes());
        $sitethemes = array_reverse($sitethemes);
    }
    // Get all user's institution themes
322
    $lostthemes = array();
Liam Sharpe's avatar
Liam Sharpe committed
323 324 325 326 327 328 329
    $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');
            }
330
            else if (isset($allthemes[$i->theme])) {
Liam Sharpe's avatar
Liam Sharpe committed
331
                $institutionthemes[$i->theme . '/' . $i->institution] = $i->displayname . ' - ' . $allthemes[$i->theme]->displayname;
332
            }
333 334 335
            else {
                $lostthemes[$i->theme] = 1;
            }
336 337
        }
    }
Liam Sharpe's avatar
Liam Sharpe committed
338 339 340
    $themes = array_merge($sitethemes, $institutionthemes);
    natcasesort($themes);
    $currenttheme = $USER->get_themedata();
341 342 343

    if (!isset($currenttheme->basename) || (isset($currenttheme->altname) && $currenttheme->altname == 'sitedefault')
        || !empty($lostthemes[$currenttheme->basename])) {
Liam Sharpe's avatar
Liam Sharpe committed
344 345 346 347 348
        $defaulttheme = 'sitedefault';
    }
    else {
        $defaulttheme = $currenttheme->basename;
    }
349
    if (isset($currenttheme->institutionname) && empty($lostthemes[$currenttheme->basename])) {
Liam Sharpe's avatar
Liam Sharpe committed
350 351 352 353 354 355 356 357 358 359 360 361 362 363
        $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,
    );
364

365
    $elements['addremovecolumns'] = array(
366
        'type' => 'switchbox',
367 368 369 370 371 372
        '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(
373
        'type' => 'switchbox',
374
        'title'=> get_string('enablemultipleblogs1' ,'account'),
375
        'description' => get_string('enablemultipleblogsdescription1', 'account'),
376 377 378 379 380 381 382 383 384 385 386 387
        '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),
        );
    }
388 389 390
    $elements['groupsideblockmaxgroups'] = array(
        'type'         => 'text',
        'size'         => 4,
391 392
        'title'        => get_string('limitto1', 'blocktype.mygroups'),
        'description'  => get_string('limittodescsideblock1', 'blocktype.mygroups'),
393
        'defaultvalue' => isset($prefs->groupsideblockmaxgroups) ? $prefs->groupsideblockmaxgroups : '',
394 395 396 397 398
        'rules'        => array('regex' => '/^[0-9]*$/', 'minvalue' => 0, 'maxvalue' => 1000),
    );
    $elements['groupsideblocksortby'] = array(
        'type'         => 'select',
        'defaultvalue' => isset($prefs->groupsideblocksortby) ? $prefs->groupsideblocksortby : 'alphabetical',
399
        'title' => get_string('sortgroups', 'blocktype.mygroups'),
400 401 402 403 404 405
        'options' =>  array(
            'latest' => get_string('latest', 'blocktype.mygroups'),
            'earliest' => get_string('earliest', 'blocktype.mygroups'),
            'alphabetical'  => get_string('alphabetical', 'blocktype.mygroups'),
        ),
    );
406 407
    if (get_config('userscanhiderealnames')) {
        $elements['hiderealname'] = array(
408
            'type'         => 'switchbox',
409 410 411 412 413 414 415
            'title'        => get_string('hiderealname', 'account'),
            'description'  => get_string('hiderealnamedescription', 'account'),
            'defaultvalue' => $prefs->hiderealname,
        );
    }
    if (get_config('homepageinfo')) {
        $elements['showhomeinfo'] = array(
416
            'type' => 'switchbox',
417
            'defaultvalue' => $prefs->showhomeinfo,
418 419
            'title' => get_string('showhomeinfo2', 'account'),
            'description' => get_string('showhomeinfodescription1', 'account', hsc(get_config('sitename'))),
420 421 422
            'help' => 'true'
        );
    }
423 424
    if (get_config('showprogressbar')) {
        $elements['showprogressbar'] = array(
425
            'type' => 'switchbox',
426 427 428 429 430
            'defaultvalue' => $prefs->showprogressbar,
            'title' => get_string('showprogressbar', 'account'),
            'description' => get_string('showprogressbardescription', 'account', hsc(get_config('sitename'))),
        );
    }
431 432
    if (get_config_plugin('artefact', 'file', 'resizeonuploadenable')) {
        $elements['resizeonuploaduserdefault'] = array(
433
            'type'         => 'switchbox',
434
            'title'        => get_string('resizeonuploaduserdefault1', 'account'),
435
            'description'  => get_string('resizeonuploaduserdefaultdescription2', 'account'),
436 437 438
            'defaultvalue' => $prefs->resizeonuploaduserdefault,
        );
    }
439

440 441
    if (get_config('userscandisabledevicedetection')) {
        $elements['devicedetection'] = array(
442
            'type'         => 'switchbox',
443 444 445 446 447 448
            'title'        => get_string('devicedetection', 'account'),
            'description'  => get_string('devicedetectiondescription', 'account'),
            'defaultvalue' => $prefs->devicedetection,
        );
    }

449 450 451
    return $elements;
}

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 495 496 497 498 499 500 501 502 503 504 505 506 507
/**
 * 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;
}

508 509
/**
 * Save a profile field.
510
 * Exception is 'socialprofile' field. It is made up of 2 fields:
511 512 513 514 515
 * socialprofile_profileurl,
 * socialprofile_profiletype
 * @param int $userid
 * @param string $field
 * @param string (or array for socialprofile) $value
516
 * @param int $new - Whether the user is new (avoid unnecessary queries)
517
 */
518
function set_profile_field($userid, $field, $value, $new = FALSE) {
519
    safe_require('artefact', 'internal');
520 521 522 523

    // this is a special case that replaces the primary email address with the
    // specified one
    if ($field == 'email') {
524 525 526 527 528 529 530
        if (!$new) {
            try {
                $email = artefact_instance_from_type('email', $userid);
            }
            catch (ArtefactNotFoundException $e) {
                // We'll create a new artefact then.
            }
531
        }
532 533
        if (!isset($email)) {
            $email = new ArtefactTypeEmail(0, null, TRUE);
534 535 536 537 538
            $email->set('owner', $userid);
        }
        $email->set('title', $value);
        $email->commit();
    }
539
    else if ($field == 'socialprofile') {
540 541 542 543 544 545 546 547
        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';
        }
548
        $classname = generate_artefact_class_name($field);
549
        $profile = new $classname(0, array('owner' => $userid), $new);
550
        $profile->set('title',       $value['socialprofile_profileurl']);
551 552
        $profile->set('description', $desc);
        $profile->set('note',        $type);
553 554
        $profile->commit();
    }
555 556
    else {
        $classname = generate_artefact_class_name($field);
557
        $profile = new $classname(0, array('owner' => $userid), $new);
558 559 560
        $profile->set('title', $value);
        $profile->commit();
    }
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 609 610 611 612 613 614 615 616 617 618 619 620 621
/**
 * 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();
}
622 623 624 625 626
/**
 * 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
627 628 629
 * @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
630 631 632 633
 *
 * @todo, this needs to be better (fix email behaviour)
 */
function get_profile_field($userid, $field) {
634 635 636 637 638 639 640
    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));
    }
641 642 643 644 645 646 647 648
    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();
        }
    }
649 650 651
    else if ($field == 'introduction') {
        $value = get_field('artefact', 'description', 'owner', $userid, 'artefacttype', $field);
    }
652 653 654
    else {
        $value = get_field('artefact', 'title', 'owner', $userid, 'artefacttype', $field);
    }
655 656 657 658

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

660
    return null;
661 662
}

Aaron Wells's avatar
Aaron Wells committed
663
/**
664
 * Always use this function for all emails to users
Aaron Wells's avatar
Aaron Wells committed
665
 *
666 667 668 669 670
 * @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)
671
 * @param array  $customheaders email headers
672
 * @throws EmailException
673
 * @throws EmailDisabledException
Aaron Wells's avatar
Aaron Wells committed
674
 */
675
function email_user($userto, $userfrom, $subject, $messagetext, $messagehtml='', $customheaders=null) {
676 677 678
    global $IDPJUMPURL;
    static $mnetjumps = array();

679
    if (!get_config('sendemail')) {
Aaron Wells's avatar
Aaron Wells committed
680
        // You can entirely disable Mahara from sending any e-mail via the
681 682 683
        // 'sendemail' configuration variable
        return true;
    }
684 685 686 687

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

689
    if (isset($userto->id) && empty($userto->ignoredisabled)) {
690 691 692 693
        $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");
        }
694 695
    }

696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718
    // 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);
    }


719
    require_once('phpmailer/PHPMailerAutoload.php');
720

721
    $mail = new PHPMailer(true);
Aaron Wells's avatar
Aaron Wells committed
722

723 724 725 726 727 728
    $mail->CharSet = 'UTF-8';

    $smtphosts = get_config('smtphosts');
    if ($smtphosts == 'qmail') {
        // use Qmail system
        $mail->IsQmail();
Aaron Wells's avatar
Aaron Wells committed
729
    }
730 731 732 733 734 735 736 737
    else if (empty($smtphosts)) {
        // use PHP mail() = sendmail
        $mail->IsMail();
    }
    else {
        $mail->IsSMTP();
        // use SMTP directly
        $mail->Host = get_config('smtphosts');
738
        $mail->Port = is_numeric(get_config('smtpport')) ? get_config('smtpport') : 25;
739 740
        if (get_config('smtpuser')) {
            // Use SMTP authentication
741 742 743 744
            $mail->SMTPAuth   = true;
            $mail->Username   = get_config('smtpuser');
            $mail->Password   = get_config('smtppass');
            $mail->SMTPSecure = get_config('smtpsecure');
745 746 747 748 749 750 751 752 753
            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;
                }
            }
754 755 756
        }
    }

757 758
    if (get_config('bounces_handle') && !empty($userto->id) && empty($maildisabled)) {
        $mail->Sender = generate_email_processing_address($userto->id, $userto);
759
    }
760
    if (empty($userfrom) || $userfrom->email == get_config('noreplyaddress')) {
761 762 763 764
        if (empty($mail->Sender)) {
            $mail->Sender = get_config('noreplyaddress');
        }
        $mail->From = get_config('noreplyaddress');
765
        $mail->FromName = (isset($userfrom->id)) ? display_name($userfrom, $userto) : get_config('sitename');
766
        $customheaders[] = 'Precedence: Bulk'; // Try to avoid pesky out of office responses
Richard Mansfield's avatar
Richard Mansfield committed
767
        $messagetext .= "\n\n" . get_string('pleasedonotreplytothismessage') . "\n";
768
        if ($messagehtml) {
Richard Mansfield's avatar
Richard Mansfield committed
769
            $messagehtml .= "\n\n<p>" . get_string('pleasedonotreplytothismessage') . "</p>\n";
770
        }
771 772
    }
    else {
773 774 775 776
        if (empty($mail->Sender)) {
            $mail->Sender = $userfrom->email;
        }
        $mail->From = $userfrom->email;
777 778
        $mail->FromName = display_name($userfrom, $userto);
    }
779
    $replytoset = false;
780 781
    if (!empty($customheaders) && is_array($customheaders)) {
        foreach ($customheaders as $customheader) {
782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799
            // 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);
            }
800 801 802
            if (0 === stripos($customheader, 'reply-to')) {
                $replytoset = true;
            }
803 804
        }
    }
805

806
    $mail->Subject = substr(stripslashes($subject), 0, 900);
807

808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826
    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);
827 828
        }
    }
829
    catch (phpmailerException $e) {
830 831 832 833
        // 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);
    }

Aaron Wells's avatar
Aaron Wells committed
834
    $mail->WordWrap = 79;
835

Aaron Wells's avatar
Aaron Wells committed
836
    if ($messagehtml) {
837 838 839
        $mail->IsHTML(true);
        $mail->Encoding = 'quoted-printable';
        $mail->Body    =  $messagehtml;
840
        $mail->AltBody =  $messagetext;
Aaron Wells's avatar
Aaron Wells committed
841
    }
842 843
    else {
        $mail->IsHTML(false);
844
        $mail->Body =  $messagetext;
845 846
    }

847 848 849 850 851 852 853 854
    try {
        $sent = $mail->Send();
    }
    catch (phpmailerException $e) {
        $sent = false;
    }

    if ($sent) {
855 856 857 858 859 860 861
        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));
            }
862
            $line = "$to <- $mail->From - " . str_shorten_text($mail->Subject, 200);
863 864 865
            @error_log('[' . date("Y-m-d h:i:s") . "] [$client] [$script] $line\n", 3, $logfile);
        }

866 867 868 869
        if (get_config('bounces_handle')) {
            // Update the count of sent mail
            update_send_count($userto);
        }
870

871
        return true;
Aaron Wells's avatar
Aaron Wells committed
872
    }
873 874 875 876
    throw new EmailException("Couldn't send email to $usertoname with subject $subject. "
                        . "Error from phpmailer was: " . $mail->ErrorInfo );
}

877 878 879 880 881 882 883 884 885 886 887 888 889 890
/**
 * 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');
891 892 893
    // 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);
894 895 896
    return $mailprefix . $args . substr(md5($mailprefix . $userto->email . $installation_key), 0, 16) . '@' . $maildomain;
}

897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912
/**
 * 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;
    }

Aaron Wells's avatar
Aaron Wells committed
913 914 915 916
    $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) {
917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953
        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;
}

954 955 956 957 958 959 960 961 962 963 964 965
/**
 * 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;
    }
Francois Marier's avatar
Francois Marier committed
966
    if ($mailinfo = get_record_select('artefact_internal_profile_email', '"owner" = ? AND email = ? AND principal = 1', array($userto->id, $userto->email))) {
967 968 969 970 971
        $mailinfo->mailssent = (!empty($reset)) ? 0 : $mailinfo->mailssent+1;
        update_record('artefact_internal_profile_email', $mailinfo, array('email' => $userto->email, 'owner' => $userto->id));
    }
}

972 973 974 975 976 977 978 979 980 981 982 983
/**
 * 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;
    }
Francois Marier's avatar
Francois Marier committed
984
    if ($mailinfo = get_record_select('artefact_internal_profile_email', '"owner" = ? AND email = ? AND principal = 1', array($userto->id, $userto->email))) {
985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008
        $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;
    }

1009 1010 1011
    $mailprefix = get_config('bounceprefix');
    $prefixlength = strlen($mailprefix);

1012
    list($email->localpart,$email->domain) = explode('@',$address);
1013 1014
    // The prefix is stored in the first characters denoted by $prefixlength
    $email->prefix        = substr($email->localpart, 0, $prefixlength);
1015
    // The type of message received is a one letter code
1016
    $email->type          = substr($email->localpart, $prefixlength, 1);
1017
    // The userid should be available immediately afterwards
1018 1019 1020
    // 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
1021
    list(,$email->userid) = unpack('V',base64_decode(preg_replace('/-/', '/', substr($email->localpart, $prefixlength + 1, 8))));
1022
    // Any additional arguments
1023
    $email->args          = substr($email->localpart, $prefixlength + 9,-16);
1024 1025 1026 1027 1028 1029 1030 1031 1032 1033
    // 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
Francois Marier's avatar
Francois Marier committed
1034
        if ($user = get_record_select('artefact_internal_profile_email', '"owner" = ? AND principal = 1', array($email->userid))) {
1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051
            $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;
}

1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090
/**
 * 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);
}

1091 1092 1093 1094 1095 1096 1097
/**
 * 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
 *
1098
 * @param mixed $user the user that you're trying to format to a string (accepts an integer, object, or array)
1099
 * @param object $userto the user that is looking at the string representation (if left
1100
 * blank, will default to the currently logged in user).
1101
 * @param boolean $nameonly do not append the user's username even if $userto can see it.
1102
 * @param boolean $realname show the user's real name even if preferredname exists
1103
 * @param boolean $username show the user's username even if the viewer is not an admin
1104 1105 1106
 *
 * @returns string name to display
 */
1107
function display_name($user, $userto=null, $nameonly=false, $realname=false, $username=false) {
Pat Kira's avatar
Pat Kira committed
1108

1109
    global $USER;