[ Index ]

PHP Cross Reference of Unnamed Project

title

Body

[close]

/lib/ -> myprofilelib.php (source)

   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      if (has_capability('moodle/site:viewuseridentity', $courseorusercontext)) {
 131          $identityfields = array_flip(explode(',', $CFG->showuseridentity));
 132      } else {
 133          $identityfields = array();
 134      }
 135  
 136      if (is_mnet_remote_user($user)) {
 137          $sql = "SELECT h.id, h.name, h.wwwroot,
 138                         a.name as application, a.display_name
 139                    FROM {mnet_host} h, {mnet_application} a
 140                   WHERE h.id = ? AND h.applicationid = a.id";
 141  
 142          $remotehost = $DB->get_record_sql($sql, array($user->mnethostid));
 143          $remoteuser = new stdclass();
 144          $remoteuser->remotetype = $remotehost->display_name;
 145          $hostinfo = new stdclass();
 146          $hostinfo->remotename = $remotehost->name;
 147          $hostinfo->remoteurl  = $remotehost->wwwroot;
 148  
 149          $node = new core_user\output\myprofile\node('contact', 'mnet', get_string('remoteuser', 'mnet', $remoteuser), null, null,
 150              get_string('remoteuserinfo', 'mnet', $hostinfo), null, 'remoteuserinfo');
 151          $tree->add_node($node);
 152      }
 153  
 154      if (isset($identityfields['email']) and ($iscurrentuser
 155                                               or $user->maildisplay == 1
 156                                               or has_capability('moodle/course:useremail', $courseorusercontext)
 157                                               or has_capability('moodle/site:viewuseridentity', $courseorusercontext)
 158                                               or ($user->maildisplay == 2 and enrol_sharing_course($user, $USER)))) {
 159          $node = new core_user\output\myprofile\node('contact', 'email', get_string('email'), null, null,
 160              obfuscate_mailto($user->email, ''));
 161          $tree->add_node($node);
 162      }
 163  
 164      if (!isset($hiddenfields['country']) && $user->country) {
 165          $node = new core_user\output\myprofile\node('contact', 'country', get_string('country'), null, null,
 166                  get_string($user->country, 'countries'));
 167          $tree->add_node($node);
 168      }
 169  
 170      if (!isset($hiddenfields['city']) && $user->city) {
 171          $node = new core_user\output\myprofile\node('contact', 'city', get_string('city'), null, null, $user->city);
 172          $tree->add_node($node);
 173      }
 174  
 175      if (isset($identityfields['address']) && $user->address) {
 176          $node = new core_user\output\myprofile\node('contact', 'address', get_string('address'), null, null, $user->address);
 177          $tree->add_node($node);
 178      }
 179  
 180      if (isset($identityfields['phone1']) && $user->phone1) {
 181          $node = new core_user\output\myprofile\node('contact', 'phone1', get_string('phone1'), null, null, $user->phone1);
 182          $tree->add_node($node);
 183      }
 184  
 185      if (isset($identityfields['phone2']) && $user->phone2) {
 186          $node = new core_user\output\myprofile\node('contact', 'phone2', get_string('phone2'), null, null, $user->phone2);
 187          $tree->add_node($node);
 188      }
 189  
 190      if (isset($identityfields['institution']) && $user->institution) {
 191          $node = new core_user\output\myprofile\node('contact', 'institution', get_string('institution'), null, null,
 192                  $user->institution);
 193          $tree->add_node($node);
 194      }
 195  
 196      if (isset($identityfields['department']) && $user->department) {
 197          $node = new core_user\output\myprofile\node('contact', 'department', get_string('department'), null, null,
 198              $user->department);
 199          $tree->add_node($node);
 200      }
 201  
 202      if (isset($identityfields['idnumber']) && $user->idnumber) {
 203          $node = new core_user\output\myprofile\node('contact', 'idnumber', get_string('idnumber'), null, null,
 204              $user->idnumber);
 205          $tree->add_node($node);
 206      }
 207  
 208      if ($user->url && !isset($hiddenfields['webpage'])) {
 209          $url = $user->url;
 210          if (strpos($user->url, '://') === false) {
 211              $url = 'http://'. $url;
 212          }
 213          $webpageurl = new moodle_url($url);
 214          $node = new core_user\output\myprofile\node('contact', 'webpage', get_string('webpage'), null, null,
 215              html_writer::link($url, $webpageurl));
 216          $tree->add_node($node);
 217      }
 218  
 219      // Printing tagged interests. We want this only for full profile.
 220      if (empty($course) && ($interests = core_tag_tag::get_item_tags('core', 'user', $user->id))) {
 221          $node = new core_user\output\myprofile\node('contact', 'interests', get_string('interests'), null, null,
 222                  $OUTPUT->tag_list($interests, ''));
 223          $tree->add_node($node);
 224      }
 225  
 226      if (!isset($hiddenfields['mycourses'])) {
 227          $showallcourses = optional_param('showallcourses', 0, PARAM_INT);
 228          if ($mycourses = enrol_get_all_users_courses($user->id, true, null, 'visible DESC, sortorder ASC')) {
 229              $shown = 0;
 230              $courselisting = html_writer::start_tag('ul');
 231              foreach ($mycourses as $mycourse) {
 232                  if ($mycourse->category) {
 233                      context_helper::preload_from_record($mycourse);
 234                      $ccontext = context_course::instance($mycourse->id);
 235                      if (!isset($course) || $mycourse->id != $course->id) {
 236                          $linkattributes = null;
 237                          if ($mycourse->visible == 0) {
 238                              if (!has_capability('moodle/course:viewhiddencourses', $ccontext)) {
 239                                  continue;
 240                              }
 241                              $linkattributes['class'] = 'dimmed';
 242                          }
 243                          $params = array('id' => $user->id, 'course' => $mycourse->id);
 244                          if ($showallcourses) {
 245                              $params['showallcourses'] = 1;
 246                          }
 247                          $url = new moodle_url('/user/view.php', $params);
 248                          $courselisting .= html_writer::tag('li', html_writer::link($url, $ccontext->get_context_name(false),
 249                                  $linkattributes));
 250                      } else {
 251                          $courselisting .= html_writer::tag('li', $course->fullname);
 252                      }
 253                  }
 254                  $shown++;
 255                  if (!$showallcourses && $shown == $CFG->navcourselimit) {
 256                      $url = null;
 257                      if (isset($course)) {
 258                          $url = new moodle_url('/user/view.php',
 259                                  array('id' => $user->id, 'course' => $course->id, 'showallcourses' => 1));
 260                      } else {
 261                          $url = new moodle_url('/user/profile.php', array('id' => $user->id, 'showallcourses' => 1));
 262                      }
 263                      $courselisting .= html_writer::tag('li', html_writer::link($url, get_string('viewmore'),
 264                              array('title' => get_string('viewmore'))), array('class' => 'viewmore'));
 265                      break;
 266                  }
 267              }
 268              $courselisting .= html_writer::end_tag('ul');
 269              if (!empty($mycourses)) {
 270                  // Add this node only if there are courses to display.
 271                  $node = new core_user\output\myprofile\node('coursedetails', 'courseprofiles',
 272                      get_string('courseprofiles'), null, null, rtrim($courselisting, ', '));
 273                  $tree->add_node($node);
 274              }
 275          }
 276      }
 277  
 278      if (!empty($course)) {
 279  
 280          // Show roles in this course.
 281          if ($rolestring = get_user_roles_in_course($user->id, $course->id)) {
 282              $node = new core_user\output\myprofile\node('coursedetails', 'roles', get_string('roles'), null, null, $rolestring);
 283              $tree->add_node($node);
 284          }
 285  
 286          // Show groups this user is in.
 287          if (!isset($hiddenfields['groups']) && !empty($course)) {
 288              $accessallgroups = has_capability('moodle/site:accessallgroups', $courseorsystemcontext);
 289              if ($usergroups = groups_get_all_groups($course->id, $user->id)) {
 290                  $groupstr = '';
 291                  foreach ($usergroups as $group) {
 292                      if ($course->groupmode == SEPARATEGROUPS and !$accessallgroups and $user->id != $USER->id) {
 293                          if (!groups_is_member($group->id, $user->id)) {
 294                              continue;
 295                          }
 296                      }
 297  
 298                      if ($course->groupmode != NOGROUPS) {
 299                          $groupstr .= ' <a href="'.$CFG->wwwroot.'/user/index.php?id='.$course->id.'&amp;group='.$group->id.'">'
 300                                       .format_string($group->name).'</a>,';
 301                      } else {
 302                          // The user/index.php shows groups only when course in group mode.
 303                          $groupstr .= ' '.format_string($group->name);
 304                      }
 305                  }
 306                  if ($groupstr !== '') {
 307                      $node = new core_user\output\myprofile\node('coursedetails', 'groups',
 308                              get_string('group'), null, null, rtrim($groupstr, ', '));
 309                      $tree->add_node($node);
 310                  }
 311              }
 312          }
 313  
 314          if (!isset($hiddenfields['suspended'])) {
 315              if ($user->suspended) {
 316                  $node = new core_user\output\myprofile\node('coursedetails', 'suspended',
 317                          null, null, null, get_string('suspended', 'auth'));
 318                  $tree->add_node($node);
 319              }
 320          }
 321      }
 322  
 323      if ($user->icq && !isset($hiddenfields['icqnumber'])) {
 324          $imurl = new moodle_url('http://web.icq.com/wwp', array('uin' => $user->icq) );
 325          $iconurl = new moodle_url('http://web.icq.com/whitepages/online', array('icq' => $user->icq, 'img' => '5'));
 326          $statusicon = html_writer::tag('img', '',
 327                  array('src' => $iconurl, 'class' => 'icon icon-post', 'alt' => get_string('status')));
 328          $node = new core_user\output\myprofile\node('contact', 'icqnumber', get_string('icqnumber'), null, null,
 329              html_writer::link($imurl, s($user->icq) . $statusicon));
 330          $tree->add_node($node);
 331      }
 332  
 333      if ($user->skype && !isset($hiddenfields['skypeid'])) {
 334          $imurl = 'skype:'.urlencode($user->skype).'?call';
 335          $iconurl = new moodle_url('http://mystatus.skype.com/smallicon/'.urlencode($user->skype));
 336          if (is_https()) {
 337              // Bad luck, skype devs are lazy to set up SSL on their servers - see MDL-37233.
 338              $statusicon = '';
 339          } else {
 340              $statusicon = html_writer::empty_tag('img',
 341                  array('src' => $iconurl, 'class' => 'icon icon-post', 'alt' => get_string('status')));
 342          }
 343  
 344          $node = new core_user\output\myprofile\node('contact', 'skypeid', get_string('skypeid'), null, null,
 345              html_writer::link($imurl, s($user->skype) . $statusicon));
 346          $tree->add_node($node);
 347      }
 348      if ($user->yahoo && !isset($hiddenfields['yahooid'])) {
 349          $imurl = new moodle_url('http://edit.yahoo.com/config/send_webmesg', array('.target' => $user->yahoo, '.src' => 'pg'));
 350          $iconurl = new moodle_url('http://opi.yahoo.com/online', array('u' => $user->yahoo, 'm' => 'g', 't' => '0'));
 351          $statusicon = html_writer::tag('img', '',
 352              array('src' => $iconurl, 'class' => 'iconsmall icon-post', 'alt' => get_string('status')));
 353  
 354          $node = new core_user\output\myprofile\node('contact', 'yahooid', get_string('yahooid'), null, null,
 355              html_writer::link($imurl, s($user->yahoo) . $statusicon));
 356          $tree->add_node($node);
 357      }
 358      if ($user->aim && !isset($hiddenfields['aimid'])) {
 359          $imurl = 'aim:goim?screenname='.urlencode($user->aim);
 360          $node = new core_user\output\myprofile\node('contact', 'aimid', get_string('aimid'), null, null,
 361              html_writer::link($imurl, s($user->aim)));
 362          $tree->add_node($node);
 363      }
 364      if ($user->msn && !isset($hiddenfields['msnid'])) {
 365          $node = new core_user\output\myprofile\node('contact', 'msnid', get_string('msnid'), null, null,
 366              s($user->msn));
 367          $tree->add_node($node);
 368      }
 369  
 370      if ($categories = $DB->get_records('user_info_category', null, 'sortorder ASC')) {
 371          foreach ($categories as $category) {
 372              if ($fields = $DB->get_records('user_info_field', array('categoryid' => $category->id), 'sortorder ASC')) {
 373                  foreach ($fields as $field) {
 374                      require_once($CFG->dirroot.'/user/profile/field/'.$field->datatype.'/field.class.php');
 375                      $newfield = 'profile_field_'.$field->datatype;
 376                      $formfield = new $newfield($field->id, $user->id);
 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      }
 386  
 387      // First access. (Why only for sites ?)
 388      if (!isset($hiddenfields['firstaccess']) && empty($course)) {
 389          if ($user->firstaccess) {
 390              $datestring = userdate($user->firstaccess)."&nbsp; (".format_time(time() - $user->firstaccess).")";
 391          } else {
 392              $datestring = get_string("never");
 393          }
 394          $node = new core_user\output\myprofile\node('loginactivity', 'firstaccess', get_string('firstsiteaccess'), null, null,
 395              $datestring);
 396          $tree->add_node($node);
 397      }
 398  
 399      // Last access.
 400      if (!isset($hiddenfields['lastaccess'])) {
 401          if (empty($course)) {
 402              $string = get_string('lastsiteaccess');
 403              if ($user->lastaccess) {
 404                  $datestring = userdate($user->lastaccess) . "&nbsp; (" . format_time(time() - $user->lastaccess) . ")";
 405              } else {
 406                  $datestring = get_string("never");
 407              }
 408          } else {
 409              $string = get_string('lastcourseaccess');
 410              if ($lastaccess = $DB->get_record('user_lastaccess', array('userid' => $user->id, 'courseid' => $course->id))) {
 411                  $datestring = userdate($lastaccess->timeaccess)."&nbsp; (".format_time(time() - $lastaccess->timeaccess).")";
 412              } else {
 413                  $datestring = get_string("never");
 414              }
 415          }
 416  
 417          $node = new core_user\output\myprofile\node('loginactivity', 'lastaccess', $string, null, null,
 418              $datestring);
 419          $tree->add_node($node);
 420      }
 421  
 422      // Last ip.
 423      if (has_capability('moodle/user:viewlastip', $usercontext) && !isset($hiddenfields['lastip'])) {
 424          if ($user->lastip) {
 425              $iplookupurl = new moodle_url('/iplookup/index.php', array('ip' => $user->lastip, 'user' => $USER->id));
 426              $ipstring = html_writer::link($iplookupurl, $user->lastip);
 427          } else {
 428              $ipstring = get_string("none");
 429          }
 430          $node = new core_user\output\myprofile\node('loginactivity', 'lastip', get_string('lastip'), null, null,
 431              $ipstring);
 432          $tree->add_node($node);
 433      }
 434  }


Generated: Thu Aug 11 10:00:09 2016 Cross-referenced by PHPXref 0.7.1