MDL-67883 core: Make core ready for MoodleNet.
[moodle.git] / 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/>.
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  */
25 defined('MOODLE_INTERNAL') || die();
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;
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;
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');
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);
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     }
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     }
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     }
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     }
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     }
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";
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;
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     }
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     }
168     if (!isset($hiddenfields['moodlenetprofile']) && $user->moodlenetprofile) {
169         $node = new core_user\output\myprofile\node('contact', 'moodlenetprofile', get_string('moodlenetprofile', 'user'), null,
170                 null, $user->moodlenetprofile);
171         $tree->add_node($node);
172     }
174     if (!isset($hiddenfields['country']) && $user->country) {
175         $node = new core_user\output\myprofile\node('contact', 'country', get_string('country'), null, null,
176                 get_string($user->country, 'countries'));
177         $tree->add_node($node);
178     }
180     if (!isset($hiddenfields['city']) && $user->city) {
181         $node = new core_user\output\myprofile\node('contact', 'city', get_string('city'), null, null, $user->city);
182         $tree->add_node($node);
183     }
185     if (isset($identityfields['address']) && $user->address) {
186         $node = new core_user\output\myprofile\node('contact', 'address', get_string('address'), null, null, $user->address);
187         $tree->add_node($node);
188     }
190     if (isset($identityfields['phone1']) && $user->phone1) {
191         $node = new core_user\output\myprofile\node('contact', 'phone1', get_string('phone1'), null, null, $user->phone1);
192         $tree->add_node($node);
193     }
195     if (isset($identityfields['phone2']) && $user->phone2) {
196         $node = new core_user\output\myprofile\node('contact', 'phone2', get_string('phone2'), null, null, $user->phone2);
197         $tree->add_node($node);
198     }
200     if (isset($identityfields['institution']) && $user->institution) {
201         $node = new core_user\output\myprofile\node('contact', 'institution', get_string('institution'), null, null,
202                 $user->institution);
203         $tree->add_node($node);
204     }
206     if (isset($identityfields['department']) && $user->department) {
207         $node = new core_user\output\myprofile\node('contact', 'department', get_string('department'), null, null,
208             $user->department);
209         $tree->add_node($node);
210     }
212     if (isset($identityfields['idnumber']) && $user->idnumber) {
213         $node = new core_user\output\myprofile\node('contact', 'idnumber', get_string('idnumber'), null, null,
214             $user->idnumber);
215         $tree->add_node($node);
216     }
218     if ($user->url && !isset($hiddenfields['webpage'])) {
219         $url = $user->url;
220         if (strpos($user->url, '://') === false) {
221             $url = 'http://'. $url;
222         }
223         $webpageurl = new moodle_url($url);
224         $node = new core_user\output\myprofile\node('contact', 'webpage', get_string('webpage'), null, null,
225             html_writer::link($url, $webpageurl));
226         $tree->add_node($node);
227     }
229     // Printing tagged interests. We want this only for full profile.
230     if (empty($course) && ($interests = core_tag_tag::get_item_tags('core', 'user', $user->id))) {
231         $node = new core_user\output\myprofile\node('contact', 'interests', get_string('interests'), null, null,
232                 $OUTPUT->tag_list($interests, ''));
233         $tree->add_node($node);
234     }
236     if ($iscurrentuser || !isset($hiddenfields['mycourses'])) {
237         $showallcourses = optional_param('showallcourses', 0, PARAM_INT);
238         if ($mycourses = enrol_get_all_users_courses($user->id, true, null)) {
239             $shown = 0;
240             $courselisting = html_writer::start_tag('ul');
241             foreach ($mycourses as $mycourse) {
242                 if ($mycourse->category) {
243                     context_helper::preload_from_record($mycourse);
244                     $ccontext = context_course::instance($mycourse->id);
245                     if (!isset($course) || $mycourse->id != $course->id) {
246                         $linkattributes = null;
247                         if ($mycourse->visible == 0) {
248                             if (!has_capability('moodle/course:viewhiddencourses', $ccontext)) {
249                                 continue;
250                             }
251                             $linkattributes['class'] = 'dimmed';
252                         }
253                         $params = array('id' => $user->id, 'course' => $mycourse->id);
254                         if ($showallcourses) {
255                             $params['showallcourses'] = 1;
256                         }
257                         $url = new moodle_url('/user/view.php', $params);
258                         $courselisting .= html_writer::tag('li', html_writer::link($url, $ccontext->get_context_name(false),
259                                 $linkattributes));
260                     } else {
261                         $courselisting .= html_writer::tag('li', $ccontext->get_context_name(false));
262                     }
263                 }
264                 $shown++;
265                 if (!$showallcourses && $shown == $CFG->navcourselimit) {
266                     $url = null;
267                     if (isset($course)) {
268                         $url = new moodle_url('/user/view.php',
269                                 array('id' => $user->id, 'course' => $course->id, 'showallcourses' => 1));
270                     } else {
271                         $url = new moodle_url('/user/profile.php', array('id' => $user->id, 'showallcourses' => 1));
272                     }
273                     $courselisting .= html_writer::tag('li', html_writer::link($url, get_string('viewmore'),
274                             array('title' => get_string('viewmore'))), array('class' => 'viewmore'));
275                     break;
276                 }
277             }
278             $courselisting .= html_writer::end_tag('ul');
279             if (!empty($mycourses)) {
280                 // Add this node only if there are courses to display.
281                 $node = new core_user\output\myprofile\node('coursedetails', 'courseprofiles',
282                     get_string('courseprofiles'), null, null, rtrim($courselisting, ', '));
283                 $tree->add_node($node);
284             }
285         }
286     }
288     if (!empty($course)) {
290         // Show roles in this course.
291         if ($rolestring = get_user_roles_in_course($user->id, $course->id)) {
292             $node = new core_user\output\myprofile\node('coursedetails', 'roles', get_string('roles'), null, null, $rolestring);
293             $tree->add_node($node);
294         }
296         // Show groups this user is in.
297         if (!isset($hiddenfields['groups']) && !empty($course)) {
298             $accessallgroups = has_capability('moodle/site:accessallgroups', $courseorsystemcontext);
299             if ($usergroups = groups_get_all_groups($course->id, $user->id)) {
300                 $groupstr = '';
301                 foreach ($usergroups as $group) {
302                     if ($course->groupmode == SEPARATEGROUPS and !$accessallgroups and $user->id != $USER->id) {
303                         if (!groups_is_member($group->id, $user->id)) {
304                             continue;
305                         }
306                     }
308                     if ($course->groupmode != NOGROUPS) {
309                         $groupstr .= ' <a href="'.$CFG->wwwroot.'/user/index.php?id='.$course->id.'&amp;group='.$group->id.'">'
310                                      .format_string($group->name).'</a>,';
311                     } else {
312                         // The user/index.php shows groups only when course in group mode.
313                         $groupstr .= ' '.format_string($group->name);
314                     }
315                 }
316                 if ($groupstr !== '') {
317                     $node = new core_user\output\myprofile\node('coursedetails', 'groups',
318                             get_string('group'), null, null, rtrim($groupstr, ', '));
319                     $tree->add_node($node);
320                 }
321             }
322         }
324         if (!isset($hiddenfields['suspended'])) {
325             if ($user->suspended) {
326                 $node = new core_user\output\myprofile\node('coursedetails', 'suspended',
327                         null, null, null, get_string('suspended', 'auth'));
328                 $tree->add_node($node);
329             }
330         }
331     }
333     if ($user->icq && !isset($hiddenfields['icqnumber'])) {
334         $imurl = new moodle_url('http://web.icq.com/wwp', array('uin' => $user->icq) );
335         $iconurl = new moodle_url('http://web.icq.com/whitepages/online', array('icq' => $user->icq, 'img' => '5'));
336         $statusicon = html_writer::tag('img', '',
337                 array('src' => $iconurl, 'class' => 'icon icon-post', 'alt' => get_string('status')));
338         $node = new core_user\output\myprofile\node('contact', 'icqnumber', get_string('icqnumber'), null, null,
339             html_writer::link($imurl, s($user->icq) . $statusicon));
340         $tree->add_node($node);
341     }
343     if ($user->skype && !isset($hiddenfields['skypeid'])) {
344         $imurl = 'skype:'.urlencode($user->skype).'?call';
345         $iconurl = new moodle_url('http://mystatus.skype.com/smallicon/'.urlencode($user->skype));
346         if (is_https()) {
347             // Bad luck, skype devs are lazy to set up SSL on their servers - see MDL-37233.
348             $statusicon = '';
349         } else {
350             $statusicon = html_writer::empty_tag('img',
351                 array('src' => $iconurl, 'class' => 'icon icon-post', 'alt' => get_string('status')));
352         }
354         $node = new core_user\output\myprofile\node('contact', 'skypeid', get_string('skypeid'), null, null,
355             html_writer::link($imurl, s($user->skype) . $statusicon));
356         $tree->add_node($node);
357     }
358     if ($user->yahoo && !isset($hiddenfields['yahooid'])) {
359         $imurl = new moodle_url('http://edit.yahoo.com/config/send_webmesg', array('.target' => $user->yahoo, '.src' => 'pg'));
360         $iconurl = new moodle_url('http://opi.yahoo.com/online', array('u' => $user->yahoo, 'm' => 'g', 't' => '0'));
361         $statusicon = html_writer::tag('img', '',
362             array('src' => $iconurl, 'class' => 'iconsmall icon-post', 'alt' => get_string('status')));
364         $node = new core_user\output\myprofile\node('contact', 'yahooid', get_string('yahooid'), null, null,
365             html_writer::link($imurl, s($user->yahoo) . $statusicon));
366         $tree->add_node($node);
367     }
368     if ($user->aim && !isset($hiddenfields['aimid'])) {
369         $imurl = 'aim:goim?screenname='.urlencode($user->aim);
370         $node = new core_user\output\myprofile\node('contact', 'aimid', get_string('aimid'), null, null,
371             html_writer::link($imurl, s($user->aim)));
372         $tree->add_node($node);
373     }
374     if ($user->msn && !isset($hiddenfields['msnid'])) {
375         $node = new core_user\output\myprofile\node('contact', 'msnid', get_string('msnid'), null, null,
376             s($user->msn));
377         $tree->add_node($node);
378     }
380     $categories = profile_get_user_fields_with_data_by_category($user->id);
381     foreach ($categories as $categoryid => $fields) {
382         foreach ($fields as $formfield) {
383             if ($formfield->is_visible() and !$formfield->is_empty()) {
384                 $node = new core_user\output\myprofile\node('contact', 'custom_field_' . $formfield->field->shortname,
385                     format_string($formfield->field->name), null, null, $formfield->display_data());
386                 $tree->add_node($node);
387             }
388         }
389     }
391     // First access. (Why only for sites ?)
392     if (!isset($hiddenfields['firstaccess']) && empty($course)) {
393         if ($user->firstaccess) {
394             $datestring = userdate($user->firstaccess)."&nbsp; (".format_time(time() - $user->firstaccess).")";
395         } else {
396             $datestring = get_string("never");
397         }
398         $node = new core_user\output\myprofile\node('loginactivity', 'firstaccess', get_string('firstsiteaccess'), null, null,
399             $datestring);
400         $tree->add_node($node);
401     }
403     // Last access.
404     if (!isset($hiddenfields['lastaccess'])) {
405         if (empty($course)) {
406             $string = get_string('lastsiteaccess');
407             if ($user->lastaccess) {
408                 $datestring = userdate($user->lastaccess) . "&nbsp; (" . format_time(time() - $user->lastaccess) . ")";
409             } else {
410                 $datestring = get_string("never");
411             }
412         } else {
413             $string = get_string('lastcourseaccess');
414             if ($lastaccess = $DB->get_record('user_lastaccess', array('userid' => $user->id, 'courseid' => $course->id))) {
415                 $datestring = userdate($lastaccess->timeaccess)."&nbsp; (".format_time(time() - $lastaccess->timeaccess).")";
416             } else {
417                 $datestring = get_string("never");
418             }
419         }
421         $node = new core_user\output\myprofile\node('loginactivity', 'lastaccess', $string, null, null,
422             $datestring);
423         $tree->add_node($node);
424     }
426     // Last ip.
427     if (has_capability('moodle/user:viewlastip', $usercontext) && !isset($hiddenfields['lastip'])) {
428         if ($user->lastip) {
429             $iplookupurl = new moodle_url('/iplookup/index.php', array('ip' => $user->lastip, 'user' => $user->id));
430             $ipstring = html_writer::link($iplookupurl, $user->lastip);
431         } else {
432             $ipstring = get_string("none");
433         }
434         $node = new core_user\output\myprofile\node('loginactivity', 'lastip', get_string('lastip'), null, null,
435             $ipstring);
436         $tree->add_node($node);
437     }