lib/myprofilelib.php

   1 <?php
   2 // This file is part of Moodle - http://moodle.org/
   3 //
   4 // Moodle is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU General Public License as published by
   6 // the Free Software Foundation, either version 3 of the License, or
   7 // (at your option) any later version.
   8 //
   9 // Moodle is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU General Public License
  15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 /**
  18  * Defines core nodes for my profile navigation tree.
  19  *
  20  * @package   core
  21  * @copyright 2015 onwards Ankit Agarwal
  22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23  */
  24
  25 defined('MOODLE_INTERNAL') || die();
  26
  27 /**
  28  * Defines core nodes for my profile navigation tree.
  29  *
  30  * @param \core_user\output\myprofile\tree $tree Tree object
  31  * @param stdClass $user user object
  32  * @param bool $iscurrentuser is the user viewing profile, current user ?
  33  * @param stdClass $course course object
  34  *
  35  * @return bool
  36  */
  37 function core_myprofile_navigation(core_user\output\myprofile\tree $tree, $user, $iscurrentuser, $course) {
  38     global $CFG, $USER, $DB, $PAGE, $OUTPUT;
  39
  40     $usercontext = context_user::instance($user->id, MUST_EXIST);
  41     $systemcontext = context_system::instance();
  42     $courseorusercontext = !empty($course) ? context_course::instance($course->id) : $usercontext;
  43     $courseorsystemcontext = !empty($course) ? context_course::instance($course->id) : $systemcontext;
  44     $courseid = !empty($course) ? $course->id : SITEID;
  45
  46     $contactcategory = new core_user\output\myprofile\category('contact', get_string('userdetails'));
  47     // No after property specified intentionally. It is a hack to make administration block appear towards the end. Refer MDL-49928.
  48     $coursedetailscategory = new core_user\output\myprofile\category('coursedetails', get_string('coursedetails'));
  49     $miscategory = new core_user\output\myprofile\category('miscellaneous', get_string('miscellaneous'), 'coursedetails');
  50     $reportcategory = new core_user\output\myprofile\category('reports', get_string('reports'), 'miscellaneous');
  51     $admincategory = new core_user\output\myprofile\category('administration', get_string('administration'), 'reports');
  52     $loginactivitycategory = new core_user\output\myprofile\category('loginactivity', get_string('loginactivity'), 'administration');
  53
  54     // Add categories.
  55     $tree->add_category($contactcategory);
  56     $tree->add_category($coursedetailscategory);
  57     $tree->add_category($miscategory);
  58     $tree->add_category($reportcategory);
  59     $tree->add_category($admincategory);
  60     $tree->add_category($loginactivitycategory);
  61
  62     // Add core nodes.
  63     // Full profile node.
  64     if (!empty($course)) {
  65         if (empty($CFG->forceloginforprofiles) || $iscurrentuser ||
  66             has_capability('moodle/user:viewdetails', $usercontext)
  67             || has_coursecontact_role($user->id)) {
  68             $url = new moodle_url('/user/profile.php', array('id' => $user->id));
  69             $node = new core_user\output\myprofile\node('miscellaneous', 'fullprofile', get_string('fullprofile'), null, $url);
  70             $tree->add_node($node);
  71         }
  72     }
  73
  74     // Edit profile.
  75     if (isloggedin() && !isguestuser($user) && !is_mnet_remote_user($user)) {
  76         if (($iscurrentuser || is_siteadmin($USER) || !is_siteadmin($user)) && has_capability('moodle/user:update',
  77                     $systemcontext)) {
  78             $url = new moodle_url('/user/editadvanced.php', array('id' => $user->id, 'course' => $courseid,
  79                 'returnto' => 'profile'));
  80             $node = new core_user\output\myprofile\node('contact', 'editprofile', get_string('editmyprofile'), null, $url,
  81                 null, null, 'editprofile');
  82             $tree->add_node($node);
  83         } else if ((has_capability('moodle/user:editprofile', $usercontext) && !is_siteadmin($user))
  84                    || ($iscurrentuser && has_capability('moodle/user:editownprofile', $systemcontext))) {
  85             $userauthplugin = false;
  86             if (!empty($user->auth)) {
  87                 $userauthplugin = get_auth_plugin($user->auth);
  88             }
  89             if ($userauthplugin && $userauthplugin->can_edit_profile()) {
  90                 $url = $userauthplugin->edit_profile_url();
  91                 if (empty($url)) {
  92                     if (empty($course)) {
  93                         $url = new moodle_url('/user/edit.php', array('id' => $user->id, 'returnto' => 'profile'));
  94                     } else {
  95                         $url = new moodle_url('/user/edit.php', array('id' => $user->id, 'course' => $course->id,
  96                             'returnto' => 'profile'));
  97                     }
  98                 }
  99                 $node = new core_user\output\myprofile\node('contact', 'editprofile',
 100                         get_string('editmyprofile'), null, $url, null, null, 'editprofile');
 101                 $tree->add_node($node);
 102             }
 103         }
 104     }
 105
 106     // Preference page.
 107     if (!$iscurrentuser && $PAGE->settingsnav->can_view_user_preferences($user->id)) {
 108         $url = new moodle_url('/user/preferences.php', array('userid' => $user->id));
 109         $title = get_string('preferences', 'moodle');
 110         $node = new core_user\output\myprofile\node('administration', 'preferences', $title, null, $url);
 111         $tree->add_node($node);
 112     }
 113
 114     // Login as ...
 115     if (!$user->deleted && !$iscurrentuser &&
 116                 !\core\session\manager::is_loggedinas() && has_capability('moodle/user:loginas',
 117                 $courseorsystemcontext) && !is_siteadmin($user->id)) {
 118         $url = new moodle_url('/course/loginas.php',
 119                 array('id' => $courseid, 'user' => $user->id, 'sesskey' => sesskey()));
 120         $node = new  core_user\output\myprofile\node('administration', 'loginas', get_string('loginas'), null, $url);
 121         $tree->add_node($node);
 122     }
 123
 124     // Contact details.
 125     if (has_capability('moodle/user:viewhiddendetails', $courseorusercontext)) {
 126         $hiddenfields = array();
 127     } else {
 128         $hiddenfields = array_flip(explode(',', $CFG->hiddenuserfields));
 129     }
 130     $canviewuseridentity = has_capability('moodle/site:viewuseridentity', $courseorusercontext);
 131     if ($canviewuseridentity) {
 132         $identityfields = array_flip(explode(',', $CFG->showuseridentity));
 133     } else {
 134         $identityfields = array();
 135     }
 136
 137     if (is_mnet_remote_user($user)) {
 138         $sql = "SELECT h.id, h.name, h.wwwroot,
 139                        a.name as application, a.display_name
 140                   FROM {mnet_host} h, {mnet_application} a
 141                  WHERE h.id = ? AND h.applicationid = a.id";
 142
 143         $remotehost = $DB->get_record_sql($sql, array($user->mnethostid));
 144         $remoteuser = new stdclass();
 145         $remoteuser->remotetype = $remotehost->display_name;
 146         $hostinfo = new stdclass();
 147         $hostinfo->remotename = $remotehost->name;
 148         $hostinfo->remoteurl  = $remotehost->wwwroot;
 149
 150         $node = new core_user\output\myprofile\node('contact', 'mnet', get_string('remoteuser', 'mnet', $remoteuser), null, null,
 151             get_string('remoteuserinfo', 'mnet', $hostinfo), null, 'remoteuserinfo');
 152         $tree->add_node($node);
 153     }
 154
 155     if ($iscurrentuser
 156         or (!isset($hiddenfields['email']) and (
 157             $user->maildisplay == core_user::MAILDISPLAY_EVERYONE
 158             or ($user->maildisplay == core_user::MAILDISPLAY_COURSE_MEMBERS_ONLY and enrol_sharing_course($user, $USER))
 159             or has_capability('moodle/course:useremail', $courseorusercontext) // TODO: Deprecate/remove for MDL-37479.
 160         ))
 161         or (isset($identityfields['email']) and $canviewuseridentity)
 162        ) {
 163         $node = new core_user\output\myprofile\node('contact', 'email', get_string('email'), null, null,
 164             obfuscate_mailto($user->email, ''));
 165         $tree->add_node($node);
 166     }
 167
 168     if (!isset($hiddenfields['country']) && $user->country) {
 169         $node = new core_user\output\myprofile\node('contact', 'country', get_string('country'), null, null,
 170                 get_string($user->country, 'countries'));
 171         $tree->add_node($node);
 172     }
 173
 174     if (!isset($hiddenfields['city']) && $user->city) {
 175         $node = new core_user\output\myprofile\node('contact', 'city', get_string('city'), null, null, $user->city);
 176         $tree->add_node($node);
 177     }
 178
 179     if (isset($identityfields['address']) && $user->address) {
 180         $node = new core_user\output\myprofile\node('contact', 'address', get_string('address'), null, null, $user->address);
 181         $tree->add_node($node);
 182     }
 183
 184     if (isset($identityfields['phone1']) && $user->phone1) {
 185         $node = new core_user\output\myprofile\node('contact', 'phone1', get_string('phone1'), null, null, $user->phone1);
 186         $tree->add_node($node);
 187     }
 188
 189     if (isset($identityfields['phone2']) && $user->phone2) {
 190         $node = new core_user\output\myprofile\node('contact', 'phone2', get_string('phone2'), null, null, $user->phone2);
 191         $tree->add_node($node);
 192     }
 193
 194     if (isset($identityfields['institution']) && $user->institution) {
 195         $node = new core_user\output\myprofile\node('contact', 'institution', get_string('institution'), null, null,
 196                 $user->institution);
 197         $tree->add_node($node);
 198     }
 199
 200     if (isset($identityfields['department']) && $user->department) {
 201         $node = new core_user\output\myprofile\node('contact', 'department', get_string('department'), null, null,
 202             $user->department);
 203         $tree->add_node($node);
 204     }
 205
 206     if (isset($identityfields['idnumber']) && $user->idnumber) {
 207         $node = new core_user\output\myprofile\node('contact', 'idnumber', get_string('idnumber'), null, null,
 208             $user->idnumber);
 209         $tree->add_node($node);
 210     }
 211
 212     if ($user->url && !isset($hiddenfields['webpage'])) {
 213         $url = $user->url;
 214         if (strpos($user->url, '://') === false) {
 215             $url = 'http://'. $url;
 216         }
 217         $webpageurl = new moodle_url($url);
 218         $node = new core_user\output\myprofile\node('contact', 'webpage', get_string('webpage'), null, null,
 219             html_writer::link($url, $webpageurl));
 220         $tree->add_node($node);
 221     }
 222
 223     // Printing tagged interests. We want this only for full profile.
 224     if (empty($course) && ($interests = core_tag_tag::get_item_tags('core', 'user', $user->id))) {
 225         $node = new core_user\output\myprofile\node('contact', 'interests', get_string('interests'), null, null,
 226                 $OUTPUT->tag_list($interests, ''));
 227         $tree->add_node($node);
 228     }
 229
 230     if (!isset($hiddenfields['mycourses'])) {
 231         $showallcourses = optional_param('showallcourses', 0, PARAM_INT);
 232         if ($mycourses = enrol_get_all_users_courses($user->id, true, null)) {
 233             $shown = 0;
 234             $courselisting = html_writer::start_tag('ul');
 235             foreach ($mycourses as $mycourse) {
 236                 if ($mycourse->category) {
 237                     context_helper::preload_from_record($mycourse);
 238                     $ccontext = context_course::instance($mycourse->id);
 239                     if (!isset($course) || $mycourse->id != $course->id) {
 240                         $linkattributes = null;
 241                         if ($mycourse->visible == 0) {
 242                             if (!has_capability('moodle/course:viewhiddencourses', $ccontext)) {
 243                                 continue;
 244                             }
 245                             $linkattributes['class'] = 'dimmed';
 246                         }
 247                         $params = array('id' => $user->id, 'course' => $mycourse->id);
 248                         if ($showallcourses) {
 249                             $params['showallcourses'] = 1;
 250                         }
 251                         $url = new moodle_url('/user/view.php', $params);
 252                         $courselisting .= html_writer::tag('li', html_writer::link($url, $ccontext->get_context_name(false),
 253                                 $linkattributes));
 254                     } else {
 255                         $courselisting .= html_writer::tag('li', $ccontext->get_context_name(false));
 256                     }
 257                 }
 258                 $shown++;
 259                 if (!$showallcourses && $shown == $CFG->navcourselimit) {
 260                     $url = null;
 261                     if (isset($course)) {
 262                         $url = new moodle_url('/user/view.php',
 263                                 array('id' => $user->id, 'course' => $course->id, 'showallcourses' => 1));
 264                     } else {
 265                         $url = new moodle_url('/user/profile.php', array('id' => $user->id, 'showallcourses' => 1));
 266                     }
 267                     $courselisting .= html_writer::tag('li', html_writer::link($url, get_string('viewmore'),
 268                             array('title' => get_string('viewmore'))), array('class' => 'viewmore'));
 269                     break;
 270                 }
 271             }
 272             $courselisting .= html_writer::end_tag('ul');
 273             if (!empty($mycourses)) {
 274                 // Add this node only if there are courses to display.
 275                 $node = new core_user\output\myprofile\node('coursedetails', 'courseprofiles',
 276                     get_string('courseprofiles'), null, null, rtrim($courselisting, ', '));
 277                 $tree->add_node($node);
 278             }
 279         }
 280     }
 281
 282     if (!empty($course)) {
 283
 284         // Show roles in this course.
 285         if ($rolestring = get_user_roles_in_course($user->id, $course->id)) {
 286             $node = new core_user\output\myprofile\node('coursedetails', 'roles', get_string('roles'), null, null, $rolestring);
 287             $tree->add_node($node);
 288         }
 289
 290         // Show groups this user is in.
 291         if (!isset($hiddenfields['groups']) && !empty($course)) {
 292             $accessallgroups = has_capability('moodle/site:accessallgroups', $courseorsystemcontext);
 293             if ($usergroups = groups_get_all_groups($course->id, $user->id)) {
 294                 $groupstr = '';
 295                 foreach ($usergroups as $group) {
 296                     if ($course->groupmode == SEPARATEGROUPS and !$accessallgroups and $user->id != $USER->id) {
 297                         if (!groups_is_member($group->id, $user->id)) {
 298                             continue;
 299                         }
 300                     }
 301
 302                     if ($course->groupmode != NOGROUPS) {
 303                         $groupstr .= ' <a href="'.$CFG->wwwroot.'/user/index.php?id='.$course->id.'&amp;group='.$group->id.'">'
 304                                      .format_string($group->name).'</a>,';
 305                     } else {
 306                         // The user/index.php shows groups only when course in group mode.
 307                         $groupstr .= ' '.format_string($group->name);
 308                     }
 309                 }
 310                 if ($groupstr !== '') {
 311                     $node = new core_user\output\myprofile\node('coursedetails', 'groups',
 312                             get_string('group'), null, null, rtrim($groupstr, ', '));
 313                     $tree->add_node($node);
 314                 }
 315             }
 316         }
 317
 318         if (!isset($hiddenfields['suspended'])) {
 319             if ($user->suspended) {
 320                 $node = new core_user\output\myprofile\node('coursedetails', 'suspended',
 321                         null, null, null, get_string('suspended', 'auth'));
 322                 $tree->add_node($node);
 323             }
 324         }
 325     }
 326
 327     if ($user->icq && !isset($hiddenfields['icqnumber'])) {
 328         $imurl = new moodle_url('http://web.icq.com/wwp', array('uin' => $user->icq) );
 329         $iconurl = new moodle_url('http://web.icq.com/whitepages/online', array('icq' => $user->icq, 'img' => '5'));
 330         $statusicon = html_writer::tag('img', '',
 331                 array('src' => $iconurl, 'class' => 'icon icon-post', 'alt' => get_string('status')));
 332         $node = new core_user\output\myprofile\node('contact', 'icqnumber', get_string('icqnumber'), null, null,
 333             html_writer::link($imurl, s($user->icq) . $statusicon));
 334         $tree->add_node($node);
 335     }
 336
 337     if ($user->skype && !isset($hiddenfields['skypeid'])) {
 338         $imurl = 'skype:'.urlencode($user->skype).'?call';
 339         $iconurl = new moodle_url('http://mystatus.skype.com/smallicon/'.urlencode($user->skype));
 340         if (is_https()) {
 341             // Bad luck, skype devs are lazy to set up SSL on their servers - see MDL-37233.
 342             $statusicon = '';
 343         } else {
 344             $statusicon = html_writer::empty_tag('img',
 345                 array('src' => $iconurl, 'class' => 'icon icon-post', 'alt' => get_string('status')));
 346         }
 347
 348         $node = new core_user\output\myprofile\node('contact', 'skypeid', get_string('skypeid'), null, null,
 349             html_writer::link($imurl, s($user->skype) . $statusicon));
 350         $tree->add_node($node);
 351     }
 352     if ($user->yahoo && !isset($hiddenfields['yahooid'])) {
 353         $imurl = new moodle_url('http://edit.yahoo.com/config/send_webmesg', array('.target' => $user->yahoo, '.src' => 'pg'));
 354         $iconurl = new moodle_url('http://opi.yahoo.com/online', array('u' => $user->yahoo, 'm' => 'g', 't' => '0'));
 355         $statusicon = html_writer::tag('img', '',
 356             array('src' => $iconurl, 'class' => 'iconsmall icon-post', 'alt' => get_string('status')));
 357
 358         $node = new core_user\output\myprofile\node('contact', 'yahooid', get_string('yahooid'), null, null,
 359             html_writer::link($imurl, s($user->yahoo) . $statusicon));
 360         $tree->add_node($node);
 361     }
 362     if ($user->aim && !isset($hiddenfields['aimid'])) {
 363         $imurl = 'aim:goim?screenname='.urlencode($user->aim);
 364         $node = new core_user\output\myprofile\node('contact', 'aimid', get_string('aimid'), null, null,
 365             html_writer::link($imurl, s($user->aim)));
 366         $tree->add_node($node);
 367     }
 368     if ($user->msn && !isset($hiddenfields['msnid'])) {
 369         $node = new core_user\output\myprofile\node('contact', 'msnid', get_string('msnid'), null, null,
 370             s($user->msn));
 371         $tree->add_node($node);
 372     }
 373
 374     $categories = profile_get_user_fields_with_data_by_category($user->id);
 375     foreach ($categories as $categoryid => $fields) {
 376         foreach ($fields as $formfield) {
 377             if ($formfield->is_visible() and !$formfield->is_empty()) {
 378                 $node = new core_user\output\myprofile\node('contact', 'custom_field_' . $formfield->field->shortname,
 379                     format_string($formfield->field->name), null, null, $formfield->display_data());
 380                 $tree->add_node($node);
 381             }
 382         }
 383     }
 384
 385     // First access. (Why only for sites ?)
 386     if (!isset($hiddenfields['firstaccess']) && empty($course)) {
 387         if ($user->firstaccess) {
 388             $datestring = userdate($user->firstaccess)."&nbsp; (".format_time(time() - $user->firstaccess).")";
 389         } else {
 390             $datestring = get_string("never");
 391         }
 392         $node = new core_user\output\myprofile\node('loginactivity', 'firstaccess', get_string('firstsiteaccess'), null, null,
 393             $datestring);
 394         $tree->add_node($node);
 395     }
 396
 397     // Last access.
 398     if (!isset($hiddenfields['lastaccess'])) {
 399         if (empty($course)) {
 400             $string = get_string('lastsiteaccess');
 401             if ($user->lastaccess) {
 402                 $datestring = userdate($user->lastaccess) . "&nbsp; (" . format_time(time() - $user->lastaccess) . ")";
 403             } else {
 404                 $datestring = get_string("never");
 405             }
 406         } else {
 407             $string = get_string('lastcourseaccess');
 408             if ($lastaccess = $DB->get_record('user_lastaccess', array('userid' => $user->id, 'courseid' => $course->id))) {
 409                 $datestring = userdate($lastaccess->timeaccess)."&nbsp; (".format_time(time() - $lastaccess->timeaccess).")";
 410             } else {
 411                 $datestring = get_string("never");
 412             }
 413         }
 414
 415         $node = new core_user\output\myprofile\node('loginactivity', 'lastaccess', $string, null, null,
 416             $datestring);
 417         $tree->add_node($node);
 418     }
 419
 420     // Last ip.
 421     if (has_capability('moodle/user:viewlastip', $usercontext) && !isset($hiddenfields['lastip'])) {
 422         if ($user->lastip) {
 423             $iplookupurl = new moodle_url('/iplookup/index.php', array('ip' => $user->lastip, 'user' => $user->id));
 424             $ipstring = html_writer::link($iplookupurl, $user->lastip);
 425         } else {
 426             $ipstring = get_string("none");
 427         }
 428         $node = new core_user\output\myprofile\node('loginactivity', 'lastip', get_string('lastip'), null, null,
 429             $ipstring);
 430         $tree->add_node($node);
 431     }
 432 }