Merge branch 'MDL-46159-wip' of https://github.com/willylee/moodle
[moodle.git] / user / profile.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Public Profile -- a user's public profile page
19  *
20  * - each user can currently have their own page (cloned from system and then customised)
21  * - users can add any blocks they want
22  * - the administrators can define a default site public profile for users who have
23  *   not created their own public profile
24  *
25  * This script implements the user's view of the public profile, and allows editing
26  * of the public profile.
27  *
28  * @package    core_user
29  * @copyright  2010 Remote-Learner.net
30  * @author     Hubert Chathi <hubert@remote-learner.net>
31  * @author     Olav Jordan <olav.jordan@remote-learner.net>
32  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
33  */
35 require_once(dirname(__FILE__) . '/../config.php');
36 require_once($CFG->dirroot . '/my/lib.php');
37 require_once($CFG->dirroot . '/tag/lib.php');
38 require_once($CFG->dirroot . '/user/profile/lib.php');
39 require_once($CFG->libdir.'/filelib.php');
41 $userid         = optional_param('id', 0, PARAM_INT);
42 $edit           = optional_param('edit', null, PARAM_BOOL);    // Turn editing on and off.
43 $reset          = optional_param('reset', null, PARAM_BOOL);
44 $showallcourses = optional_param('showallcourses', 0, PARAM_INT);
46 $PAGE->set_url('/user/profile.php', array('id' => $userid));
48 if (!empty($CFG->forceloginforprofiles)) {
49     require_login();
50     if (isguestuser()) {
51         $SESSION->wantsurl = $PAGE->url->out(false);
52         redirect(get_login_url());
53     }
54 } else if (!empty($CFG->forcelogin)) {
55     require_login();
56 }
58 $userid = $userid ? $userid : $USER->id;       // Owner of the page.
59 if ((!$user = $DB->get_record('user', array('id' => $userid))) || ($user->deleted)) {
60     $PAGE->set_context(context_system::instance());
61     echo $OUTPUT->header();
62     if (!$user) {
63         echo $OUTPUT->notification(get_string('invaliduser', 'error'));
64     } else {
65         echo $OUTPUT->notification(get_string('userdeleted'));
66     }
67     echo $OUTPUT->footer();
68     die;
69 }
71 $currentuser = ($user->id == $USER->id);
72 $context = $usercontext = context_user::instance($userid, MUST_EXIST);
74 if (!$currentuser &&
75     !empty($CFG->forceloginforprofiles) &&
76     !has_capability('moodle/user:viewdetails', $context) &&
77     !has_coursecontact_role($userid)) {
79     // Course managers can be browsed at site level. If not forceloginforprofiles, allow access (bug #4366).
80     $struser = get_string('user');
81     $PAGE->set_context(context_system::instance());
82     $PAGE->set_title("$SITE->shortname: $struser");  // Do not leak the name.
83     $PAGE->set_heading("$SITE->shortname: $struser");
84     $PAGE->set_url('/user/profile.php', array('id' => $userid));
85     $PAGE->navbar->add($struser);
86     echo $OUTPUT->header();
87     echo $OUTPUT->notification(get_string('usernotavailable', 'error'));
88     echo $OUTPUT->footer();
89     exit;
90 }
92 // Get the profile page.  Should always return something unless the database is broken.
93 if (!$currentpage = my_get_page($userid, MY_PAGE_PUBLIC)) {
94     print_error('mymoodlesetup');
95 }
97 if (!$currentpage->userid) {
98     $context = context_system::instance();  // A trick so that we even see non-sticky blocks.
99 }
101 $PAGE->set_context($context);
102 $PAGE->set_pagelayout('mypublic');
103 $PAGE->set_pagetype('user-profile');
105 // Set up block editing capabilities.
106 if (isguestuser()) {     // Guests can never edit their profile.
107     $USER->editing = $edit = 0;  // Just in case.
108     $PAGE->set_blocks_editing_capability('moodle/my:configsyspages');  // unlikely :).
109 } else {
110     if ($currentuser) {
111         $PAGE->set_blocks_editing_capability('moodle/user:manageownblocks');
112     } else {
113         $PAGE->set_blocks_editing_capability('moodle/user:manageblocks');
114     }
117 if (has_capability('moodle/user:viewhiddendetails', $context)) {
118     $hiddenfields = array();
119 } else {
120     $hiddenfields = array_flip(explode(',', $CFG->hiddenuserfields));
123 if (has_capability('moodle/site:viewuseridentity', $context)) {
124     $identityfields = array_flip(explode(',', $CFG->showuseridentity));
125 } else {
126     $identityfields = array();
129 // Start setting up the page.
130 $strpublicprofile = get_string('publicprofile');
132 $PAGE->blocks->add_region('content');
133 $PAGE->set_subpage($currentpage->id);
134 $PAGE->set_title(fullname($user).": $strpublicprofile");
135 $PAGE->set_heading(fullname($user).": $strpublicprofile");
137 if (!$currentuser) {
138     $PAGE->navigation->extend_for_user($user);
139     if ($node = $PAGE->settingsnav->get('userviewingsettings'.$user->id)) {
140         $node->forceopen = true;
141     }
142 } else if ($node = $PAGE->settingsnav->get('usercurrentsettings', navigation_node::TYPE_CONTAINER)) {
143     $node->forceopen = true;
145 if ($node = $PAGE->settingsnav->get('root')) {
146     $node->forceopen = false;
150 // Toggle the editing state and switches.
151 if ($PAGE->user_allowed_editing()) {
152     if ($reset !== null) {
153         if (!is_null($userid)) {
154             if (!$currentpage = my_reset_page($userid, MY_PAGE_PUBLIC, 'user-profile')) {
155                 print_error('reseterror', 'my');
156             }
157             redirect(new moodle_url('/user/profile.php', array('id' => $userid)));
158         }
159     } else if ($edit !== null) {             // Editing state was specified.
160         $USER->editing = $edit;       // Change editing state.
161         if (!$currentpage->userid && $edit) {
162             // If we are viewing a system page as ordinary user, and the user turns
163             // editing on, copy the system pages as new user pages, and get the
164             // new page record.
165             if (!$currentpage = my_copy_page($userid, MY_PAGE_PUBLIC, 'user-profile')) {
166                 print_error('mymoodlesetup');
167             }
168             $PAGE->set_context($usercontext);
169             $PAGE->set_subpage($currentpage->id);
170         }
171     } else {                          // Editing state is in session.
172         if ($currentpage->userid) {   // It's a page we can edit, so load from session.
173             if (!empty($USER->editing)) {
174                 $edit = 1;
175             } else {
176                 $edit = 0;
177             }
178         } else {                      // It's a system page and they are not allowed to edit system pages.
179             $USER->editing = $edit = 0;          // Disable editing completely, just to be safe.
180         }
181     }
183     // Add button for editing page.
184     $params = array('edit' => !$edit, 'id' => $userid);
186     $resetbutton = '';
187     $resetstring = get_string('resetpage', 'my');
188     $reseturl = new moodle_url("$CFG->wwwroot/user/profile.php", array('edit' => 1, 'reset' => 1, 'id' => $userid));
190     if (!$currentpage->userid) {
191         // Viewing a system page -- let the user customise it.
192         $editstring = get_string('updatemymoodleon');
193         $params['edit'] = 1;
194     } else if (empty($edit)) {
195         $editstring = get_string('updatemymoodleon');
196         $resetbutton = $OUTPUT->single_button($reseturl, $resetstring);
197     } else {
198         $editstring = get_string('updatemymoodleoff');
199         $resetbutton = $OUTPUT->single_button($reseturl, $resetstring);
200     }
202     $url = new moodle_url("$CFG->wwwroot/user/profile.php", $params);
203     $button = $OUTPUT->single_button($url, $editstring);
204     $PAGE->set_button($resetbutton . $button);
206 } else {
207     $USER->editing = $edit = 0;
210 // HACK WARNING!  This loads up all this page's blocks in the system context.
211 if ($currentpage->userid == 0) {
212     $CFG->blockmanagerclass = 'my_syspage_block_manager';
215 // Trigger a user profile viewed event.
216 $event = \core\event\user_profile_viewed::create(array(
217     'objectid' => $user->id,
218     'relateduserid' => $user->id,
219     'context' => $usercontext
220 ));
221 $event->add_record_snapshot('user', $user);
222 $event->trigger();
224 // TODO WORK OUT WHERE THE NAV BAR IS!
225 echo $OUTPUT->header();
226 echo '<div class="userprofile">';
229 // Print the standard content of this page, the basic profile info.
230 echo $OUTPUT->heading(fullname($user));
232 if (is_mnet_remote_user($user)) {
233     $sql = "SELECT h.id, h.name, h.wwwroot,
234                    a.name as application, a.display_name
235               FROM {mnet_host} h, {mnet_application} a
236              WHERE h.id = ? AND h.applicationid = a.id";
238     $remotehost = $DB->get_record_sql($sql, array($user->mnethostid));
239     $a = new stdclass();
240     $a->remotetype = $remotehost->display_name;
241     $a->remotename = $remotehost->name;
242     $a->remoteurl  = $remotehost->wwwroot;
244     echo $OUTPUT->box(get_string('remoteuserinfo', 'mnet', $a), 'remoteuserinfo');
247 echo '<div class="userprofilebox clearfix"><div class="profilepicture">';
248 echo $OUTPUT->user_picture($user, array('size' => 100));
249 echo '</div>';
251 echo '<div class="descriptionbox"><div class="description">';
252 // Print the description.
253 if ($user->description && !isset($hiddenfields['description'])) {
254     if (!empty($CFG->profilesforenrolledusersonly) && !$currentuser &&
255         !$DB->record_exists('role_assignments', array('userid' => $user->id))) {
256         echo get_string('profilenotshown', 'moodle');
257     } else {
258         $user->description = file_rewrite_pluginfile_urls($user->description, 'pluginfile.php', $usercontext->id, 'user',
259                                                           'profile', null);
260         $options = array('overflowdiv' => true);
261         echo format_text($user->description, $user->descriptionformat, $options);
262     }
264 echo '</div>';
267 // Print all the little details in a list.
268 echo html_writer::start_tag('dl', array('class' => 'list'));
269 if (!isset($hiddenfields['country']) && $user->country) {
270     echo html_writer::tag('dt', get_string('country'));
271     echo html_writer::tag('dd', get_string($user->country, 'countries'));
274 if (!isset($hiddenfields['city']) && $user->city) {
275     echo html_writer::tag('dt', get_string('city'));
276     echo html_writer::tag('dd', $user->city);
279 if (isset($identityfields['address']) && $user->address) {
280     echo html_writer::tag('dt', get_string('address'));
281     echo html_writer::tag('dd', $user->address);
284 if (isset($identityfields['phone1']) && $user->phone1) {
285     echo html_writer::tag('dt', get_string('phone'));
286     echo html_writer::tag('dd', $user->phone1);
289 if (isset($identityfields['phone2']) && $user->phone2) {
290     echo html_writer::tag('dt', get_string('phone2'));
291     echo html_writer::tag('dd', $user->phone2);
294 if (isset($identityfields['institution']) && $user->institution) {
295     echo html_writer::tag('dt', get_string('institution'));
296     echo html_writer::tag('dd', $user->institution);
299 if (isset($identityfields['department']) && $user->department) {
300     echo html_writer::tag('dt', get_string('department'));
301     echo html_writer::tag('dd', $user->department);
304 if (isset($identityfields['idnumber']) && $user->idnumber) {
305     echo html_writer::tag('dt', get_string('idnumber'));
306     echo html_writer::tag('dd', $user->idnumber);
309 if (isset($identityfields['email']) and ($currentuser
310   or $user->maildisplay == 1
311   or has_capability('moodle/course:useremail', $context)
312   or ($user->maildisplay == 2 and enrol_sharing_course($user, $USER)))) {
313     echo html_writer::tag('dt', get_string('email'));
314     echo html_writer::tag('dd', obfuscate_mailto($user->email, ''));
317 if ($user->url && !isset($hiddenfields['webpage'])) {
318     $url = $user->url;
319     if (strpos($user->url, '://') === false) {
320         $url = 'http://'. $url;
321     }
322     $webpageurl = new moodle_url($url);
323     echo html_writer::tag('dt', get_string('webpage'));
324     echo html_writer::tag('dd', html_writer::link($webpageurl, s($user->url)));
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', '', array('src' => $iconurl, 'class' => 'icon icon-post', 'alt' => get_string('status')));
331     echo html_writer::tag('dt', get_string('icqnumber'));
332     echo html_writer::tag('dd', html_writer::link($imurl, s($user->icq) . $statusicon));
335 if ($user->skype && !isset($hiddenfields['skypeid'])) {
336     $imurl = 'skype:'.urlencode($user->skype).'?call';
337     $iconurl = new moodle_url('http://mystatus.skype.com/smallicon/'.urlencode($user->skype));
338     if (strpos($CFG->httpswwwroot, 'https:') === 0) {
339         // Bad luck, skype devs are lazy to set up SSL on their servers - see MDL-37233.
340         $statusicon = '';
341     } else {
342         $statusicon = html_writer::empty_tag('img',
343             array('src' => $iconurl, 'class' => 'icon icon-post', 'alt' => get_string('status')));
344     }
345     echo html_writer::tag('dt', get_string('skypeid'));
346     echo html_writer::tag('dd', html_writer::link($imurl, s($user->skype) . $statusicon));
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     echo html_writer::tag('dt', get_string('yahooid'));
354     echo html_writer::tag('dd', html_writer::link($imurl, s($user->yahoo) . $statusicon));
356 if ($user->aim && !isset($hiddenfields['aimid'])) {
357     $imurl = 'aim:goim?screenname='.urlencode($user->aim);
358     echo html_writer::tag('dt', get_string('aimid'));
359     echo html_writer::tag('dd', html_writer::link($imurl, s($user->aim)));
361 if ($user->msn && !isset($hiddenfields['msnid'])) {
362     echo html_writer::tag('dt', get_string('msnid'));
363     echo html_writer::tag('dd', s($user->msn));
366 // Print the Custom User Fields.
367 profile_display_fields($user->id);
370 if (!isset($hiddenfields['mycourses'])) {
371     if ($mycourses = enrol_get_all_users_courses($user->id, true, null, 'visible DESC, sortorder ASC')) {
372         $shown = 0;
373         $courselisting = '';
374         foreach ($mycourses as $mycourse) {
375             if ($mycourse->category) {
376                 context_helper::preload_from_record($mycourse);
377                 $ccontext = context_course::instance($mycourse->id);
378                 $class = '';
379                 if ($mycourse->visible == 0) {
380                     if (!has_capability('moodle/course:viewhiddencourses', $ccontext)) {
381                         continue;
382                     }
383                     $class = 'class="dimmed"';
384                 }
385                 $params = array('id' => $user->id, 'course' => $mycourse->id);
386                 if ($showallcourses) {
387                     $params['showallcourses'] = 1;
388                 }
389                 $url = new moodle_url('/user/view.php', $params);
390                 $courselisting .= html_writer::link($url, $ccontext->get_context_name(false), array('class' => $class));
391                 $courselisting .= ', ';
392             }
393             $shown++;
394             if (!$showallcourses && $shown == 20) {
395                 $url = new moodle_url('/user/profile.php', array('id' => $user->id, 'showallcourses' => 1));
396                 $courselisting .= html_writer::link($url, '...', array('title' => get_string('viewmore')));
397                 break;
398             }
399         }
400         echo html_writer::tag('dt', get_string('courseprofiles'));
401         echo html_writer::tag('dd', rtrim($courselisting, ', '));
402     }
404 if (!isset($hiddenfields['firstaccess'])) {
405     if ($user->firstaccess) {
406         $datestring = userdate($user->firstaccess)."&nbsp; (".format_time(time() - $user->firstaccess).")";
407     } else {
408         $datestring = get_string("never");
409     }
410     echo html_writer::tag('dt', get_string('firstaccess'));
411     echo html_writer::tag('dd', $datestring);
413 if (!isset($hiddenfields['lastaccess'])) {
414     if ($user->lastaccess) {
415         $datestring = userdate($user->lastaccess)."&nbsp; (".format_time(time() - $user->lastaccess).")";
416     } else {
417         $datestring = get_string("never");
418     }
419     echo html_writer::tag('dt', get_string('lastaccess'));
420     echo html_writer::tag('dd', $datestring);
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     echo html_writer::tag('dt', get_string('lastip'));
431     echo html_writer::tag('dd', $ipstring);
434 // Printing tagged interests.
435 if (!empty($CFG->usetags)) {
436     if ($interests = tag_get_tags_csv('user', $user->id) ) {
437         echo html_writer::tag('dt', get_string('interests'));
438         echo html_writer::tag('dd', $interests);
439     }
442 if (!isset($hiddenfields['suspended'])) {
443     if ($user->suspended) {
444         echo html_writer::tag('dt', '&nbsp;');
445         echo html_writer::tag('dd', get_string('suspended', 'auth'));
446     }
449 require_once($CFG->libdir . '/badgeslib.php');
450 if (!empty($CFG->enablebadges)) {
451     profile_display_badges($user->id);
454 echo html_writer::end_tag('dl');
455 echo "</div></div>"; // Closing desriptionbox and userprofilebox.
457 echo $OUTPUT->custom_block_region('content');
459 // Print messaging link if allowed.
460 if (isloggedin() && has_capability('moodle/site:sendmessage', $context)
461     && !empty($CFG->messaging) && !isguestuser() && !isguestuser($user) && ($USER->id != $user->id)) {
462     echo '<div class="messagebox">';
463     echo '<a href="'.$CFG->wwwroot.'/message/index.php?id='.$user->id.'">'.get_string('messageselectadd').'</a>';
464     echo '</div>';
467 echo '</div>';  // Userprofile class.
468 echo $OUTPUT->footer();