Merge branch 'MDL-36107b-23' of git://github.com/srynot4sale/moodle into MOODLE_23_STABLE
[moodle.git] / auth / mnet / auth.php
1 <?php
3 /**
4  * @author Martin Dougiamas
5  * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
6  * @package moodle multiauth
7  *
8  * Authentication Plugin: Moodle Network Authentication
9  *
10  * Multiple host authentication support for Moodle Network.
11  *
12  * 2006-11-01  File created.
13  */
15 if (!defined('MOODLE_INTERNAL')) {
16     die('Direct access to this script is forbidden.');    ///  It must be included from a Moodle page
17 }
19 require_once($CFG->libdir.'/authlib.php');
21 /**
22  * Moodle Network authentication plugin.
23  */
24 class auth_plugin_mnet extends auth_plugin_base {
26     /**
27      * Constructor.
28      */
29     function auth_plugin_mnet() {
30         $this->authtype = 'mnet';
31         $this->config = get_config('auth_mnet');
32         $this->mnet = get_mnet_environment();
33     }
35     /**
36      * This function is normally used to determine if the username and password
37      * are correct for local logins. Always returns false, as local users do not
38      * need to login over mnet xmlrpc.
39      *
40      * @param string $username The username
41      * @param string $password The password
42      * @return bool Authentication success or failure.
43      */
44     function user_login($username, $password) {
45         return false; // print_error("mnetlocal");
46     }
48     /**
49      * Return user data for the provided token, compare with user_agent string.
50      *
51      * @param  string $token    The unique ID provided by remotehost.
52      * @param  string $UA       User Agent string.
53      * @return array  $userdata Array of user info for remote host
54      */
55     function user_authorise($token, $useragent) {
56         global $CFG, $SITE, $DB;
57         $remoteclient = get_mnet_remote_client();
58         require_once $CFG->dirroot . '/mnet/xmlrpc/serverlib.php';
60         $mnet_session = $DB->get_record('mnet_session', array('token'=>$token, 'useragent'=>$useragent));
61         if (empty($mnet_session)) {
62             throw new mnet_server_exception(1, 'authfail_nosessionexists');
63         }
65         // check session confirm timeout
66         if ($mnet_session->confirm_timeout < time()) {
67             throw new mnet_server_exception(2, 'authfail_sessiontimedout');
68         }
70         // session okay, try getting the user
71         if (!$user = $DB->get_record('user', array('id'=>$mnet_session->userid))) {
72             throw new mnet_server_exception(3, 'authfail_usermismatch');
73         }
75         $userdata = mnet_strip_user((array)$user, mnet_fields_to_send($remoteclient));
77         // extra special ones
78         $userdata['auth']                    = 'mnet';
79         $userdata['wwwroot']                 = $this->mnet->wwwroot;
80         $userdata['session.gc_maxlifetime']  = ini_get('session.gc_maxlifetime');
82         if (array_key_exists('picture', $userdata) && !empty($user->picture)) {
83             $fs = get_file_storage();
84             $usercontext = get_context_instance(CONTEXT_USER, $user->id, MUST_EXIST);
85             if ($usericonfile = $fs->get_file($usercontext->id, 'user', 'icon', 0, '/', 'f1.png')) {
86                 $userdata['_mnet_userpicture_timemodified'] = $usericonfile->get_timemodified();
87                 $userdata['_mnet_userpicture_mimetype'] = $usericonfile->get_mimetype();
88             } else if ($usericonfile = $fs->get_file($usercontext->id, 'user', 'icon', 0, '/', 'f1.jpg')) {
89                 $userdata['_mnet_userpicture_timemodified'] = $usericonfile->get_timemodified();
90                 $userdata['_mnet_userpicture_mimetype'] = $usericonfile->get_mimetype();
91             }
92         }
94         $userdata['myhosts'] = array();
95         if ($courses = enrol_get_users_courses($user->id, false)) {
96             $userdata['myhosts'][] = array('name'=> $SITE->shortname, 'url' => $CFG->wwwroot, 'count' => count($courses));
97         }
99         $sql = "SELECT h.name AS hostname, h.wwwroot, h.id AS hostid,
100                        COUNT(c.id) AS count
101                   FROM {mnetservice_enrol_courses} c
102                   JOIN {mnetservice_enrol_enrolments} e ON (e.hostid = c.hostid AND e.remotecourseid = c.remoteid)
103                   JOIN {mnet_host} h ON h.id = c.hostid
104                  WHERE e.userid = ? AND c.hostid = ?
105               GROUP BY h.name, h.wwwroot, h.id";
107         if ($courses = $DB->get_records_sql($sql, array($user->id, $remoteclient->id))) {
108             foreach($courses as $course) {
109                 $userdata['myhosts'][] = array('name'=> $course->hostname, 'url' => $CFG->wwwroot.'/auth/mnet/jump.php?hostid='.$course->hostid, 'count' => $course->count);
110             }
111         }
113         return $userdata;
114     }
116     /**
117      * Generate a random string for use as an RPC session token.
118      */
119     function generate_token() {
120         return sha1(str_shuffle('' . mt_rand() . time()));
121     }
123     /**
124      * Starts an RPC jump session and returns the jump redirect URL.
125      *
126      * @param int $mnethostid id of the mnet host to jump to
127      * @param string $wantsurl url to redirect to after the jump (usually on remote system)
128      * @param boolean $wantsurlbackhere defaults to false, means that the remote system should bounce us back here
129      *                                  rather than somewhere inside *its* wwwroot
130      */
131     function start_jump_session($mnethostid, $wantsurl, $wantsurlbackhere=false) {
132         global $CFG, $USER, $DB;
133         require_once $CFG->dirroot . '/mnet/xmlrpc/client.php';
135         if (session_is_loggedinas()) {
136             print_error('notpermittedtojumpas', 'mnet');
137         }
139         // check remote login permissions
140         if (! has_capability('moodle/site:mnetlogintoremote', get_system_context())
141                 or is_mnet_remote_user($USER)
142                 or isguestuser()
143                 or !isloggedin()) {
144             print_error('notpermittedtojump', 'mnet');
145         }
147         // check for SSO publish permission first
148         if ($this->has_service($mnethostid, 'sso_sp') == false) {
149             print_error('hostnotconfiguredforsso', 'mnet');
150         }
152         // set RPC timeout to 30 seconds if not configured
153         if (empty($this->config->rpc_negotiation_timeout)) {
154             $this->config->rpc_negotiation_timeout = 30;
155             set_config('rpc_negotiation_timeout', '30', 'auth_mnet');
156         }
158         // get the host info
159         $mnet_peer = new mnet_peer();
160         $mnet_peer->set_id($mnethostid);
162         // set up the session
163         $mnet_session = $DB->get_record('mnet_session',
164                                    array('userid'=>$USER->id, 'mnethostid'=>$mnethostid,
165                                    'useragent'=>sha1($_SERVER['HTTP_USER_AGENT'])));
166         if ($mnet_session == false) {
167             $mnet_session = new stdClass();
168             $mnet_session->mnethostid = $mnethostid;
169             $mnet_session->userid = $USER->id;
170             $mnet_session->username = $USER->username;
171             $mnet_session->useragent = sha1($_SERVER['HTTP_USER_AGENT']);
172             $mnet_session->token = $this->generate_token();
173             $mnet_session->confirm_timeout = time() + $this->config->rpc_negotiation_timeout;
174             $mnet_session->expires = time() + (integer)ini_get('session.gc_maxlifetime');
175             $mnet_session->session_id = session_id();
176             $mnet_session->id = $DB->insert_record('mnet_session', $mnet_session);
177         } else {
178             $mnet_session->useragent = sha1($_SERVER['HTTP_USER_AGENT']);
179             $mnet_session->token = $this->generate_token();
180             $mnet_session->confirm_timeout = time() + $this->config->rpc_negotiation_timeout;
181             $mnet_session->expires = time() + (integer)ini_get('session.gc_maxlifetime');
182             $mnet_session->session_id = session_id();
183             $DB->update_record('mnet_session', $mnet_session);
184         }
186         // construct the redirection URL
187         //$transport = mnet_get_protocol($mnet_peer->transport);
188         $wantsurl = urlencode($wantsurl);
189         $url = "{$mnet_peer->wwwroot}{$mnet_peer->application->sso_land_url}?token={$mnet_session->token}&idp={$this->mnet->wwwroot}&wantsurl={$wantsurl}";
190         if ($wantsurlbackhere) {
191             $url .= '&remoteurl=1';
192         }
194         return $url;
195     }
197     /**
198      * This function confirms the remote (ID provider) host's mnet session
199      * by communicating the token and UA over the XMLRPC transport layer, and
200      * returns the local user record on success.
201      *
202      *   @param string    $token           The random session token.
203      *   @param mnet_peer $remotepeer   The ID provider mnet_peer object.
204      *   @return array The local user record.
205      */
206     function confirm_mnet_session($token, $remotepeer) {
207         global $CFG, $DB;
208         require_once $CFG->dirroot . '/mnet/xmlrpc/client.php';
209         require_once $CFG->libdir . '/gdlib.php';
211         // verify the remote host is configured locally before attempting RPC call
212         if (! $remotehost = $DB->get_record('mnet_host', array('wwwroot' => $remotepeer->wwwroot, 'deleted' => 0))) {
213             print_error('notpermittedtoland', 'mnet');
214         }
216         // set up the RPC request
217         $mnetrequest = new mnet_xmlrpc_client();
218         $mnetrequest->set_method('auth/mnet/auth.php/user_authorise');
220         // set $token and $useragent parameters
221         $mnetrequest->add_param($token);
222         $mnetrequest->add_param(sha1($_SERVER['HTTP_USER_AGENT']));
224         // Thunderbirds are go! Do RPC call and store response
225         if ($mnetrequest->send($remotepeer) === true) {
226             $remoteuser = (object) $mnetrequest->response;
227         } else {
228             foreach ($mnetrequest->error as $errormessage) {
229                 list($code, $message) = array_map('trim',explode(':', $errormessage, 2));
230                 if($code == 702) {
231                     $site = get_site();
232                     print_error('mnet_session_prohibited', 'mnet', $remotepeer->wwwroot, format_string($site->fullname));
233                     exit;
234                 }
235                 $message .= "ERROR $code:<br/>$errormessage<br/>";
236             }
237             print_error("rpcerror", '', '', $message);
238         }
239         unset($mnetrequest);
241         if (empty($remoteuser) or empty($remoteuser->username)) {
242             print_error('unknownerror', 'mnet');
243             exit;
244         }
246         if (user_not_fully_set_up($remoteuser)) {
247             print_error('notenoughidpinfo', 'mnet');
248             exit;
249         }
251         $remoteuser = mnet_strip_user($remoteuser, mnet_fields_to_import($remotepeer));
253         $remoteuser->auth = 'mnet';
254         $remoteuser->wwwroot = $remotepeer->wwwroot;
256         // the user may roam from Moodle 1.x where lang has _utf8 suffix
257         // also, make sure that the lang is actually installed, otherwise set site default
258         if (isset($remoteuser->lang)) {
259             $remoteuser->lang = clean_param(str_replace('_utf8', '', $remoteuser->lang), PARAM_LANG);
260         }
261         if (empty($remoteuser->lang)) {
262             if (!empty($CFG->lang)) {
263                 $remoteuser->lang = $CFG->lang;
264             } else {
265                 $remoteuser->lang = 'en';
266             }
267         }
268         $firsttime = false;
270         // get the local record for the remote user
271         $localuser = $DB->get_record('user', array('username'=>$remoteuser->username, 'mnethostid'=>$remotehost->id));
273         // add the remote user to the database if necessary, and if allowed
274         // TODO: refactor into a separate function
275         if (empty($localuser) || ! $localuser->id) {
276             /*
277             if (empty($this->config->auto_add_remote_users)) {
278                 print_error('nolocaluser', 'mnet');
279             } See MDL-21327   for why this is commented out
280             */
281             $remoteuser->mnethostid = $remotehost->id;
282             $remoteuser->firstaccess = time(); // First time user in this server, grab it here
283             $remoteuser->confirmed = 1;
285             $remoteuser->id = $DB->insert_record('user', $remoteuser);
286             $firsttime = true;
287             $localuser = $remoteuser;
288         }
290         // check sso access control list for permission first
291         if (!$this->can_login_remotely($localuser->username, $remotehost->id)) {
292             print_error('sso_mnet_login_refused', 'mnet', '', array('user'=>$localuser->username, 'host'=>$remotehost->name));
293         }
295         $fs = get_file_storage();
297         // update the local user record with remote user data
298         foreach ((array) $remoteuser as $key => $val) {
300             if ($key == '_mnet_userpicture_timemodified' and empty($CFG->disableuserimages) and isset($remoteuser->picture)) {
301                 // update the user picture if there is a newer verion at the identity provider
302                 $usercontext = get_context_instance(CONTEXT_USER, $localuser->id, MUST_EXIST);
303                 if ($usericonfile = $fs->get_file($usercontext->id, 'user', 'icon', 0, '/', 'f1.png')) {
304                     $localtimemodified = $usericonfile->get_timemodified();
305                 } else if ($usericonfile = $fs->get_file($usercontext->id, 'user', 'icon', 0, '/', 'f1.jpg')) {
306                     $localtimemodified = $usericonfile->get_timemodified();
307                 } else {
308                     $localtimemodified = 0;
309                 }
311                 if (!empty($val) and $localtimemodified < $val) {
312                     mnet_debug('refetching the user picture from the identity provider host');
313                     $fetchrequest = new mnet_xmlrpc_client();
314                     $fetchrequest->set_method('auth/mnet/auth.php/fetch_user_image');
315                     $fetchrequest->add_param($localuser->username);
316                     if ($fetchrequest->send($remotepeer) === true) {
317                         if (strlen($fetchrequest->response['f1']) > 0) {
318                             $imagefilename = $CFG->tempdir . '/mnet-usericon-' . $localuser->id;
319                             $imagecontents = base64_decode($fetchrequest->response['f1']);
320                             file_put_contents($imagefilename, $imagecontents);
321                             if ($newrev = process_new_icon($usercontext, 'user', 'icon', 0, $imagefilename)) {
322                                 $localuser->picture = $newrev;
323                             }
324                             unlink($imagefilename);
325                         }
326                         // note that since Moodle 2.0 we ignore $fetchrequest->response['f2']
327                         // the mimetype information provided is ignored and the type of the file is detected
328                         // by process_new_icon()
329                     }
330                 }
331             }
333             if($key == 'myhosts') {
334                 $localuser->mnet_foreign_host_array = array();
335                 foreach($val as $rhost) {
336                     $name  = clean_param($rhost['name'], PARAM_ALPHANUM);
337                     $url   = clean_param($rhost['url'], PARAM_URL);
338                     $count = clean_param($rhost['count'], PARAM_INT);
339                     $url_is_local = stristr($url , $CFG->wwwroot);
340                     if (!empty($name) && !empty($count) && empty($url_is_local)) {
341                         $localuser->mnet_foreign_host_array[] = array('name'  => $name,
342                                                                       'url'   => $url,
343                                                                       'count' => $count);
344                     }
345                 }
346             }
348             $localuser->{$key} = $val;
349         }
351         $localuser->mnethostid = $remotepeer->id;
352         if (empty($localuser->firstaccess)) { // Now firstaccess, grab it here
353             $localuser->firstaccess = time();
354         }
356         $DB->update_record('user', $localuser);
358         if (!$firsttime) {
359             // repeat customer! let the IDP know about enrolments
360             // we have for this user.
361             // set up the RPC request
362             $mnetrequest = new mnet_xmlrpc_client();
363             $mnetrequest->set_method('auth/mnet/auth.php/update_enrolments');
365             // pass username and an assoc array of "my courses"
366             // with info so that the IDP can maintain mnetservice_enrol_enrolments
367             $mnetrequest->add_param($remoteuser->username);
368             $fields = 'id, category, sortorder, fullname, shortname, idnumber, summary, startdate, visible';
369             $courses = enrol_get_users_courses($localuser->id, false, $fields, 'visible DESC,sortorder ASC');
370             if (is_array($courses) && !empty($courses)) {
371                 // Second request to do the JOINs that we'd have done
372                 // inside enrol_get_users_courses() if we had been allowed
373                 $sql = "SELECT c.id,
374                                cc.name AS cat_name, cc.description AS cat_description
375                           FROM {course} c
376                           JOIN {course_categories} cc ON c.category = cc.id
377                          WHERE c.id IN (" . join(',',array_keys($courses)) . ')';
378                 $extra = $DB->get_records_sql($sql);
380                 $keys = array_keys($courses);
381                 $defaultrole = reset(get_archetype_roles('student'));
382                 //$defaultrole = get_default_course_role($ccache[$shortname]); //TODO: rewrite this completely, there is no default course role any more!!!
383                 foreach ($keys AS $id) {
384                     if ($courses[$id]->visible == 0) {
385                         unset($courses[$id]);
386                         continue;
387                     }
388                     $courses[$id]->cat_id          = $courses[$id]->category;
389                     $courses[$id]->defaultroleid   = $defaultrole->id;
390                     unset($courses[$id]->category);
391                     unset($courses[$id]->visible);
393                     $courses[$id]->cat_name        = $extra[$id]->cat_name;
394                     $courses[$id]->cat_description = $extra[$id]->cat_description;
395                     $courses[$id]->defaultrolename = $defaultrole->name;
396                     // coerce to array
397                     $courses[$id] = (array)$courses[$id];
398                 }
399             } else {
400                 // if the array is empty, send it anyway
401                 // we may be clearing out stale entries
402                 $courses = array();
403             }
404             $mnetrequest->add_param($courses);
406             // Call 0800-RPC Now! -- we don't care too much if it fails
407             // as it's just informational.
408             if ($mnetrequest->send($remotepeer) === false) {
409                 // error_log(print_r($mnetrequest->error,1));
410             }
411         }
413         return $localuser;
414     }
417     /**
418      * creates (or updates) the mnet session once
419      * {@see confirm_mnet_session} and {@see complete_user_login} have both been called
420      *
421      * @param stdclass  $user the local user (must exist already
422      * @param string    $token the jump/land token
423      * @param mnet_peer $remotepeer the mnet_peer object of this users's idp
424      */
425     public function update_mnet_session($user, $token, $remotepeer) {
426         global $DB;
427         $session_gc_maxlifetime = 1440;
428         if (isset($user->session_gc_maxlifetime)) {
429             $session_gc_maxlifetime = $user->session_gc_maxlifetime;
430         }
431         if (!$mnet_session = $DB->get_record('mnet_session',
432                                    array('userid'=>$user->id, 'mnethostid'=>$remotepeer->id,
433                                    'useragent'=>sha1($_SERVER['HTTP_USER_AGENT'])))) {
434             $mnet_session = new stdClass();
435             $mnet_session->mnethostid = $remotepeer->id;
436             $mnet_session->userid = $user->id;
437             $mnet_session->username = $user->username;
438             $mnet_session->useragent = sha1($_SERVER['HTTP_USER_AGENT']);
439             $mnet_session->token = $token; // Needed to support simultaneous sessions
440                                            // and preserving DB rec uniqueness
441             $mnet_session->confirm_timeout = time();
442             $mnet_session->expires = time() + (integer)$session_gc_maxlifetime;
443             $mnet_session->session_id = session_id();
444             $mnet_session->id = $DB->insert_record('mnet_session', $mnet_session);
445         } else {
446             $mnet_session->expires = time() + (integer)$session_gc_maxlifetime;
447             $DB->update_record('mnet_session', $mnet_session);
448         }
449     }
453     /**
454      * Invoke this function _on_ the IDP to update it with enrolment info local to
455      * the SP right after calling user_authorise()
456      *
457      * Normally called by the SP after calling user_authorise()
458      *
459      * @param string $username The username
460      * @param array $courses  Assoc array of courses following the structure of mnetservice_enrol_courses
461      * @return bool
462      */
463     function update_enrolments($username, $courses) {
464         global $CFG, $DB;
465         $remoteclient = get_mnet_remote_client();
467         if (empty($username) || !is_array($courses)) {
468             return false;
469         }
470         // make sure it is a user we have an in active session
471         // with that host...
472         $mnetsessions = $DB->get_records('mnet_session', array('username' => $username, 'mnethostid' => $remoteclient->id), '', 'id, userid');
473         $userid = null;
474         foreach ($mnetsessions as $mnetsession) {
475             if (is_null($userid)) {
476                 $userid = $mnetsession->userid;
477                 continue;
478             }
479             if ($userid != $mnetsession->userid) {
480                 throw new mnet_server_exception(3, 'authfail_usermismatch');
481             }
482         }
484         if (empty($courses)) { // no courses? clear out quickly
485             $DB->delete_records('mnetservice_enrol_enrolments', array('hostid'=>$remoteclient->id, 'userid'=>$userid));
486             return true;
487         }
489         // IMPORTANT: Ask for remoteid as the first element in the query, so
490         // that the array that comes back is indexed on the same field as the
491         // array that we have received from the remote client
492         $sql = "SELECT c.remoteid, c.id, c.categoryid AS cat_id, c.categoryname AS cat_name, c.sortorder,
493                        c.fullname, c.shortname, c.idnumber, c.summary, c.summaryformat, c.startdate,
494                        e.id AS enrolmentid
495                   FROM {mnetservice_enrol_courses} c
496              LEFT JOIN {mnetservice_enrol_enrolments} e ON (e.hostid = c.hostid AND e.remotecourseid = c.remoteid)
497                  WHERE e.userid = ? AND c.hostid = ?";
499         $currentcourses = $DB->get_records_sql($sql, array($userid, $remoteclient->id));
501         $local_courseid_array = array();
502         foreach($courses as $ix => $course) {
504             $course['remoteid'] = $course['id'];
505             $course['hostid']   =  (int)$remoteclient->id;
506             $userisregd         = false;
508             // if we do not have the the information about the remote course, it is not available
509             // to us for remote enrolment - skip
510             if (array_key_exists($course['remoteid'], $currentcourses)) {
511                 // Pointer to current course:
512                 $currentcourse =& $currentcourses[$course['remoteid']];
513                 // We have a record - is it up-to-date?
514                 $course['id'] = $currentcourse->id;
516                 $saveflag = false;
518                 foreach($course as $key => $value) {
519                     if ($currentcourse->$key != $value) {
520                         $saveflag = true;
521                         $currentcourse->$key = $value;
522                     }
523                 }
525                 if ($saveflag) {
526                     $DB->update_record('mnetervice_enrol_courses', $currentcourse);
527                 }
529                 if (isset($currentcourse->enrolmentid) && is_numeric($currentcourse->enrolmentid)) {
530                     $userisregd = true;
531                 }
532             } else {
533                 unset ($courses[$ix]);
534                 continue;
535             }
537             // By this point, we should always have a $dataObj->id
538             $local_courseid_array[] = $course['id'];
540             // Do we have a record for this assignment?
541             if ($userisregd) {
542                 // Yes - we know about this one already
543                 // We don't want to do updates because the new data is probably
544                 // 'less complete' than the data we have.
545             } else {
546                 // No - create a record
547                 $assignObj = new stdClass();
548                 $assignObj->userid    = $userid;
549                 $assignObj->hostid    = (int)$remoteclient->id;
550                 $assignObj->remotecourseid = $course['remoteid'];
551                 $assignObj->rolename  = $course['defaultrolename'];
552                 $assignObj->id = $DB->insert_record('mnetservice_enrol_enrolments', $assignObj);
553             }
554         }
556         // Clean up courses that the user is no longer enrolled in.
557         if (!empty($local_courseid_array)) {
558             $local_courseid_string = implode(', ', $local_courseid_array);
559             $whereclause = " userid = ? AND hostid = ? AND remotecourseid NOT IN ($local_courseid_string)";
560             $DB->delete_records_select('mnetservice_enrol_enrolments', $whereclause, array($userid, $remoteclient->id));
561         }
562     }
564     function prevent_local_passwords() {
565         return true;
566     }
568     /**
569      * Returns true if this authentication plugin is 'internal'.
570      *
571      * @return bool
572      */
573     function is_internal() {
574         return false;
575     }
577     /**
578      * Returns true if this authentication plugin can change the user's
579      * password.
580      *
581      * @return bool
582      */
583     function can_change_password() {
584         //TODO: it should be able to redirect, right?
585         return false;
586     }
588     /**
589      * Returns the URL for changing the user's pw, or false if the default can
590      * be used.
591      *
592      * @return moodle_url
593      */
594     function change_password_url() {
595         return null;
596     }
598     /**
599      * Prints a form for configuring this authentication plugin.
600      *
601      * This function is called from admin/auth.php, and outputs a full page with
602      * a form for configuring this plugin.
603      *
604      * @param object $config
605      * @param object $err
606      * @param array $user_fields
607      */
608     function config_form($config, $err, $user_fields) {
609         global $CFG, $DB;
611          $query = "
612             SELECT
613                 h.id,
614                 h.name as hostname,
615                 h.wwwroot,
616                 h2idp.publish as idppublish,
617                 h2idp.subscribe as idpsubscribe,
618                 idp.name as idpname,
619                 h2sp.publish as sppublish,
620                 h2sp.subscribe as spsubscribe,
621                 sp.name as spname
622             FROM
623                 {mnet_host} h
624             LEFT JOIN
625                 {mnet_host2service} h2idp
626             ON
627                (h.id = h2idp.hostid AND
628                (h2idp.publish = 1 OR
629                 h2idp.subscribe = 1))
630             INNER JOIN
631                 {mnet_service} idp
632             ON
633                (h2idp.serviceid = idp.id AND
634                 idp.name = 'sso_idp')
635             LEFT JOIN
636                 {mnet_host2service} h2sp
637             ON
638                (h.id = h2sp.hostid AND
639                (h2sp.publish = 1 OR
640                 h2sp.subscribe = 1))
641             INNER JOIN
642                 {mnet_service} sp
643             ON
644                (h2sp.serviceid = sp.id AND
645                 sp.name = 'sso_sp')
646             WHERE
647                ((h2idp.publish = 1 AND h2sp.subscribe = 1) OR
648                (h2sp.publish = 1 AND h2idp.subscribe = 1)) AND
649                 h.id != ?
650             ORDER BY
651                 h.name ASC";
653         $id_providers       = array();
654         $service_providers  = array();
655         if ($resultset = $DB->get_records_sql($query, array($CFG->mnet_localhost_id))) {
656             foreach($resultset as $hostservice) {
657                 if(!empty($hostservice->idppublish) && !empty($hostservice->spsubscribe)) {
658                     $service_providers[]= array('id' => $hostservice->id, 'name' => $hostservice->hostname, 'wwwroot' => $hostservice->wwwroot);
659                 }
660                 if(!empty($hostservice->idpsubscribe) && !empty($hostservice->sppublish)) {
661                     $id_providers[]= array('id' => $hostservice->id, 'name' => $hostservice->hostname, 'wwwroot' => $hostservice->wwwroot);
662                 }
663             }
664         }
666         include "config.html";
667     }
669     /**
670      * Processes and stores configuration data for this authentication plugin.
671      */
672     function process_config($config) {
673         // set to defaults if undefined
674         if (!isset ($config->rpc_negotiation_timeout)) {
675             $config->rpc_negotiation_timeout = '30';
676         }
677         /*
678         if (!isset ($config->auto_add_remote_users)) {
679             $config->auto_add_remote_users = '0';
680         } See MDL-21327   for why this is commented out
681         set_config('auto_add_remote_users',   $config->auto_add_remote_users,   'auth_mnet');
682         */
684         // save settings
685         set_config('rpc_negotiation_timeout', $config->rpc_negotiation_timeout, 'auth_mnet');
687         return true;
688     }
690     /**
691      * Poll the IdP server to let it know that a user it has authenticated is still
692      * online
693      *
694      * @return  void
695      */
696     function keepalive_client() {
697         global $CFG, $DB;
698         $cutoff = time() - 300; // TODO - find out what the remote server's session
699                                 // cutoff is, and preempt that
701         $sql = "
702             select
703                 id,
704                 username,
705                 mnethostid
706             from
707                 {user}
708             where
709                 lastaccess > ? AND
710                 mnethostid != ?
711             order by
712                 mnethostid";
714         $immigrants = $DB->get_records_sql($sql, array($cutoff, $CFG->mnet_localhost_id));
716         if ($immigrants == false) {
717             return true;
718         }
720         $usersArray = array();
721         foreach($immigrants as $immigrant) {
722             $usersArray[$immigrant->mnethostid][] = $immigrant->username;
723         }
725         require_once $CFG->dirroot . '/mnet/xmlrpc/client.php';
726         foreach($usersArray as $mnethostid => $users) {
727             $mnet_peer = new mnet_peer();
728             $mnet_peer->set_id($mnethostid);
730             $mnet_request = new mnet_xmlrpc_client();
731             $mnet_request->set_method('auth/mnet/auth.php/keepalive_server');
733             // set $token and $useragent parameters
734             $mnet_request->add_param($users);
736             if ($mnet_request->send($mnet_peer) === true) {
737                 if (!isset($mnet_request->response['code'])) {
738                     debugging("Server side error has occured on host $mnethostid");
739                     continue;
740                 } elseif ($mnet_request->response['code'] > 0) {
741                     debugging($mnet_request->response['message']);
742                 }
744                 if (!isset($mnet_request->response['last log id'])) {
745                     debugging("Server side error has occured on host $mnethostid\nNo log ID was received.");
746                     continue;
747                 }
748             } else {
749                 debugging("Server side error has occured on host $mnethostid: " .
750                           join("\n", $mnet_request->error));
751                 break;
752             }
753             $mnethostlogssql = "
754             SELECT
755                 mhostlogs.remoteid, mhostlogs.time, mhostlogs.userid, mhostlogs.ip,
756                 mhostlogs.course, mhostlogs.module, mhostlogs.cmid, mhostlogs.action,
757                 mhostlogs.url, mhostlogs.info, mhostlogs.username, c.fullname as coursename,
758                 c.modinfo
759             FROM
760                 (
761                     SELECT
762                         l.id as remoteid, l.time, l.userid, l.ip, l.course, l.module, l.cmid,
763                         l.action, l.url, l.info, u.username
764                     FROM
765                         {user} u
766                         INNER JOIN {log} l on l.userid = u.id
767                     WHERE
768                         u.mnethostid = ?
769                         AND l.id > ?
770                     ORDER BY remoteid ASC
771                     LIMIT 500
772                 ) mhostlogs
773                 INNER JOIN {course} c on c.id = mhostlogs.course
774             ORDER by mhostlogs.remoteid ASC";
776             $mnethostlogs = $DB->get_records_sql($mnethostlogssql, array($mnethostid, $mnet_request->response['last log id']));
778             if ($mnethostlogs == false) {
779                 continue;
780             }
782             $processedlogs = array();
784             foreach($mnethostlogs as $hostlog) {
785                 // Extract the name of the relevant module instance from the
786                 // course modinfo if possible.
787                 if (!empty($hostlog->modinfo) && !empty($hostlog->cmid)) {
788                     $modinfo = unserialize($hostlog->modinfo);
789                     unset($hostlog->modinfo);
790                     $modulearray = array();
791                     foreach($modinfo as $module) {
792                         $modulearray[$module->cm] = $module->name;
793                     }
794                     $hostlog->resource_name = $modulearray[$hostlog->cmid];
795                 } else {
796                     $hostlog->resource_name = '';
797                 }
799                 $processedlogs[] = array (
800                                     'remoteid'      => $hostlog->remoteid,
801                                     'time'          => $hostlog->time,
802                                     'userid'        => $hostlog->userid,
803                                     'ip'            => $hostlog->ip,
804                                     'course'        => $hostlog->course,
805                                     'coursename'    => $hostlog->coursename,
806                                     'module'        => $hostlog->module,
807                                     'cmid'          => $hostlog->cmid,
808                                     'action'        => $hostlog->action,
809                                     'url'           => $hostlog->url,
810                                     'info'          => $hostlog->info,
811                                     'resource_name' => $hostlog->resource_name,
812                                     'username'      => $hostlog->username
813                                  );
814             }
816             unset($hostlog);
818             $mnet_request = new mnet_xmlrpc_client();
819             $mnet_request->set_method('auth/mnet/auth.php/refresh_log');
821             // set $token and $useragent parameters
822             $mnet_request->add_param($processedlogs);
824             if ($mnet_request->send($mnet_peer) === true) {
825                 if ($mnet_request->response['code'] > 0) {
826                     debugging($mnet_request->response['message']);
827                 }
828             } else {
829                 debugging("Server side error has occured on host $mnet_peer->ip: " .join("\n", $mnet_request->error));
830             }
831         }
832     }
834     /**
835      * Receives an array of log entries from an SP and adds them to the mnet_log
836      * table
837      *
838      * @param   array   $array      An array of usernames
839      * @return  string              "All ok" or an error message
840      */
841     function refresh_log($array) {
842         global $CFG, $DB;
843         $remoteclient = get_mnet_remote_client();
845         // We don't want to output anything to the client machine
846         $start = ob_start();
848         $returnString = '';
849         $transaction = $DB->start_delegated_transaction();
850         $useridarray = array();
852         foreach($array as $logEntry) {
853             $logEntryObj = (object)$logEntry;
854             $logEntryObj->hostid = $remoteclient->id;
856             if (isset($useridarray[$logEntryObj->username])) {
857                 $logEntryObj->userid = $useridarray[$logEntryObj->username];
858             } else {
859                 $logEntryObj->userid = $DB->get_field('user', 'id', array('username'=>$logEntryObj->username, 'mnethostid'=>(int)$logEntryObj->hostid));
860                 if ($logEntryObj->userid == false) {
861                     $logEntryObj->userid = 0;
862                 }
863                 $useridarray[$logEntryObj->username] = $logEntryObj->userid;
864             }
866             unset($logEntryObj->username);
868             $logEntryObj = $this->trim_logline($logEntryObj);
869             $insertok = $DB->insert_record('mnet_log', $logEntryObj, false);
871             if ($insertok) {
872                 $remoteclient->last_log_id = $logEntryObj->remoteid;
873             } else {
874                 $returnString .= 'Record with id '.$logEntryObj->remoteid." failed to insert.\n";
875             }
876         }
877         $remoteclient->commit();
878         $transaction->allow_commit();
880         $end = ob_end_clean();
882         if (empty($returnString)) return array('code' => 0, 'message' => 'All ok');
883         return array('code' => 1, 'message' => $returnString);
884     }
886     /**
887      * Receives an array of usernames from a remote machine and prods their
888      * sessions to keep them alive
889      *
890      * @param   array   $array      An array of usernames
891      * @return  string              "All ok" or an error message
892      */
893     function keepalive_server($array) {
894         global $CFG, $DB;
895         $remoteclient = get_mnet_remote_client();
897         // We don't want to output anything to the client machine
898         $start = ob_start();
900         // We'll get session records in batches of 30
901         $superArray = array_chunk($array, 30);
903         $returnString = '';
905         foreach($superArray as $subArray) {
906             $subArray = array_values($subArray);
907             $instring = "('".implode("', '",$subArray)."')";
908             $query = "select id, session_id, username from {mnet_session} where username in $instring";
909             $results = $DB->get_records_sql($query);
911             if ($results == false) {
912                 // We seem to have a username that breaks our query:
913                 // TODO: Handle this error appropriately
914                 $returnString .= "We failed to refresh the session for the following usernames: \n".implode("\n", $subArray)."\n\n";
915             } else {
916                 foreach($results as $emigrant) {
917                     session_touch($emigrant->session_id);
918                 }
919             }
920         }
922         $end = ob_end_clean();
924         if (empty($returnString)) return array('code' => 0, 'message' => 'All ok', 'last log id' => $remoteclient->last_log_id);
925         return array('code' => 1, 'message' => $returnString, 'last log id' => $remoteclient->last_log_id);
926     }
928     /**
929      * Cron function will be called automatically by cron.php every 5 minutes
930      *
931      * @return void
932      */
933     function cron() {
934         global $DB;
936         // run the keepalive client
937         $this->keepalive_client();
939         // admin/cron.php should have run srand for us
940         $random100 = rand(0,100);
941         if ($random100 < 10) {     // Approximately 10% of the time.
942             // nuke olden sessions
943             $longtime = time() - (1 * 3600 * 24);
944             $DB->delete_records_select('mnet_session', "expires < ?", array($longtime));
945         }
946     }
948     /**
949      * Cleanup any remote mnet_sessions, kill the local mnet_session data
950      *
951      * This is called by require_logout in moodlelib
952      *
953      * @return   void
954      */
955     function prelogout_hook() {
956         global $CFG, $USER;
958         if (!is_enabled_auth('mnet')) {
959             return;
960         }
962         // If the user is local to this Moodle:
963         if ($USER->mnethostid == $this->mnet->id) {
964             $this->kill_children($USER->username, sha1($_SERVER['HTTP_USER_AGENT']));
966         // Else the user has hit 'logout' at a Service Provider Moodle:
967         } else {
968             $this->kill_parent($USER->username, sha1($_SERVER['HTTP_USER_AGENT']));
970         }
971     }
973     /**
974      * The SP uses this function to kill the session on the parent IdP
975      *
976      * @param   string  $username       Username for session to kill
977      * @param   string  $useragent      SHA1 hash of user agent to look for
978      * @return  string                  A plaintext report of what has happened
979      */
980     function kill_parent($username, $useragent) {
981         global $CFG, $USER, $DB;
983         require_once $CFG->dirroot.'/mnet/xmlrpc/client.php';
984         $sql = "
985             select
986                 *
987             from
988                 {mnet_session} s
989             where
990                 s.username   = ? AND
991                 s.useragent  = ? AND
992                 s.mnethostid = ?";
994         $mnetsessions = $DB->get_records_sql($sql, array($username, $useragent, $USER->mnethostid));
996         $ignore = $DB->delete_records('mnet_session',
997                                  array('username'=>$username,
998                                  'useragent'=>$useragent,
999                                  'mnethostid'=>$USER->mnethostid));
1001         if (false != $mnetsessions) {
1002             $mnet_peer = new mnet_peer();
1003             $mnet_peer->set_id($USER->mnethostid);
1005             $mnet_request = new mnet_xmlrpc_client();
1006             $mnet_request->set_method('auth/mnet/auth.php/kill_children');
1008             // set $token and $useragent parameters
1009             $mnet_request->add_param($username);
1010             $mnet_request->add_param($useragent);
1011             if ($mnet_request->send($mnet_peer) === false) {
1012                 debugging(join("\n", $mnet_request->error));
1013                 return false;
1014             }
1015         }
1017         return true;
1018     }
1020     /**
1021      * The IdP uses this function to kill child sessions on other hosts
1022      *
1023      * @param   string  $username       Username for session to kill
1024      * @param   string  $useragent      SHA1 hash of user agent to look for
1025      * @return  string                  A plaintext report of what has happened
1026      */
1027     function kill_children($username, $useragent) {
1028         global $CFG, $USER, $DB;
1029         $remoteclient = null;
1030         if (defined('MNET_SERVER')) {
1031             $remoteclient = get_mnet_remote_client();
1032         }
1033         require_once $CFG->dirroot.'/mnet/xmlrpc/client.php';
1035         $userid = $DB->get_field('user', 'id', array('mnethostid'=>$CFG->mnet_localhost_id, 'username'=>$username));
1037         $returnstring = '';
1039         $mnetsessions = $DB->get_records('mnet_session', array('userid' => $userid, 'useragent' => $useragent));
1041         if (false == $mnetsessions) {
1042             $returnstring .= "Could find no remote sessions\n";
1043             $mnetsessions = array();
1044         }
1046         foreach($mnetsessions as $mnetsession) {
1047             // If this script is being executed by a remote peer, that means the user has clicked
1048             // logout on that peer, and the session on that peer can be deleted natively.
1049             // Skip over it.
1050             if (isset($remoteclient->id) && ($mnetsession->mnethostid == $remoteclient->id)) {
1051                 continue;
1052             }
1053             $returnstring .=  "Deleting session\n";
1055             $mnet_peer = new mnet_peer();
1056             $mnet_peer->set_id($mnetsession->mnethostid);
1058             $mnet_request = new mnet_xmlrpc_client();
1059             $mnet_request->set_method('auth/mnet/auth.php/kill_child');
1061             // set $token and $useragent parameters
1062             $mnet_request->add_param($username);
1063             $mnet_request->add_param($useragent);
1064             if ($mnet_request->send($mnet_peer) === false) {
1065                 debugging("Server side error has occured on host $mnetsession->mnethostid: " .
1066                           join("\n", $mnet_request->error));
1067             }
1068         }
1070         $ignore = $DB->delete_records('mnet_session',
1071                                  array('useragent'=>$useragent, 'userid'=>$userid));
1073         if (isset($remoteclient) && isset($remoteclient->id)) {
1074             session_kill_user($userid);
1075         }
1076         return $returnstring;
1077     }
1079     /**
1080      * When the IdP requests that child sessions are terminated,
1081      * this function will be called on each of the child hosts. The machine that
1082      * calls the function (over xmlrpc) provides us with the mnethostid we need.
1083      *
1084      * @param   string  $username       Username for session to kill
1085      * @param   string  $useragent      SHA1 hash of user agent to look for
1086      * @return  bool                    True on success
1087      */
1088     function kill_child($username, $useragent) {
1089         global $CFG, $DB;
1090         $remoteclient = get_mnet_remote_client();
1091         $session = $DB->get_record('mnet_session', array('username'=>$username, 'mnethostid'=>$remoteclient->id, 'useragent'=>$useragent));
1092         $DB->delete_records('mnet_session', array('username'=>$username, 'mnethostid'=>$remoteclient->id, 'useragent'=>$useragent));
1093         if (false != $session) {
1094             session_kill($session->session_id);
1095             return true;
1096         }
1097         return false;
1098     }
1100     /**
1101      * To delete a host, we must delete all current sessions that users from
1102      * that host are currently engaged in.
1103      *
1104      * @param   string  $sessionidarray   An array of session hashes
1105      * @return  bool                      True on success
1106      */
1107     function end_local_sessions(&$sessionArray) {
1108         global $CFG;
1109         if (is_array($sessionArray)) {
1110             while($session = array_pop($sessionArray)) {
1111                 session_kill($session->session_id);
1112             }
1113             return true;
1114         }
1115         return false;
1116     }
1118     /**
1119      * Returns the user's profile image info
1120      *
1121      * If the user exists and has a profile picture, the returned array will contain keys:
1122      *  f1          - the content of the default 100x100px image
1123      *  f1_mimetype - the mimetype of the f1 file
1124      *  f2          - the content of the 35x35px variant of the image
1125      *  f2_mimetype - the mimetype of the f2 file
1126      *
1127      * The mimetype information was added in Moodle 2.0. In Moodle 1.x, images are always jpegs.
1128      *
1129      * @see process_new_icon()
1130      * @uses mnet_remote_client callable via MNet XML-RPC
1131      * @param int $userid The id of the user
1132      * @return false|array false if user not found, empty array if no picture exists, array with data otherwise
1133      */
1134     function fetch_user_image($username) {
1135         global $CFG, $DB;
1137         if ($user = $DB->get_record('user', array('username' => $username, 'mnethostid' => $CFG->mnet_localhost_id))) {
1138             $fs = get_file_storage();
1139             $usercontext = get_context_instance(CONTEXT_USER, $user->id, MUST_EXIST);
1140             $return = array();
1141             if ($f1 = $fs->get_file($usercontext->id, 'user', 'icon', 0, '/', 'f1.png')) {
1142                 $return['f1'] = base64_encode($f1->get_content());
1143                 $return['f1_mimetype'] = $f1->get_mimetype();
1144             } else if ($f1 = $fs->get_file($usercontext->id, 'user', 'icon', 0, '/', 'f1.jpg')) {
1145                 $return['f1'] = base64_encode($f1->get_content());
1146                 $return['f1_mimetype'] = $f1->get_mimetype();
1147             }
1148             if ($f2 = $fs->get_file($usercontext->id, 'user', 'icon', 0, '/', 'f2.png')) {
1149                 $return['f2'] = base64_encode($f2->get_content());
1150                 $return['f2_mimetype'] = $f2->get_mimetype();
1151             } else if ($f2 = $fs->get_file($usercontext->id, 'user', 'icon', 0, '/', 'f2.jpg')) {
1152                 $return['f2'] = base64_encode($f2->get_content());
1153                 $return['f2_mimetype'] = $f2->get_mimetype();
1154             }
1155             return $return;
1156         }
1157         return false;
1158     }
1160     /**
1161      * Returns the theme information and logo url as strings.
1162      *
1163      * @return string     The theme info
1164      */
1165     function fetch_theme_info() {
1166         global $CFG;
1168         $themename = "$CFG->theme";
1169         $logourl   = "$CFG->wwwroot/theme/$CFG->theme/images/logo.jpg";
1171         $return['themename'] = $themename;
1172         $return['logourl'] = $logourl;
1173         return $return;
1174     }
1176     /**
1177      * Determines if an MNET host is providing the nominated service.
1178      *
1179      * @param int    $mnethostid   The id of the remote host
1180      * @param string $servicename  The name of the service
1181      * @return bool                Whether the service is available on the remote host
1182      */
1183     function has_service($mnethostid, $servicename) {
1184         global $CFG, $DB;
1186         $sql = "
1187             SELECT
1188                 svc.id as serviceid,
1189                 svc.name,
1190                 svc.description,
1191                 svc.offer,
1192                 svc.apiversion,
1193                 h2s.id as h2s_id
1194             FROM
1195                 {mnet_host} h,
1196                 {mnet_service} svc,
1197                 {mnet_host2service} h2s
1198             WHERE
1199                 h.deleted = '0' AND
1200                 h.id = h2s.hostid AND
1201                 h2s.hostid = ? AND
1202                 h2s.serviceid = svc.id AND
1203                 svc.name = ? AND
1204                 h2s.subscribe = '1'";
1206         return $DB->get_records_sql($sql, array($mnethostid, $servicename));
1207     }
1209     /**
1210      * Checks the MNET access control table to see if the username/mnethost
1211      * is permitted to login to this moodle.
1212      *
1213      * @param string $username   The username
1214      * @param int    $mnethostid The id of the remote mnethost
1215      * @return bool              Whether the user can login from the remote host
1216      */
1217     function can_login_remotely($username, $mnethostid) {
1218         global $DB;
1220         $accessctrl = 'allow';
1221         $aclrecord = $DB->get_record('mnet_sso_access_control', array('username'=>$username, 'mnet_host_id'=>$mnethostid));
1222         if (!empty($aclrecord)) {
1223             $accessctrl = $aclrecord->accessctrl;
1224         }
1225         return $accessctrl == 'allow';
1226     }
1228     function logoutpage_hook() {
1229         global $USER, $CFG, $redirect, $DB;
1231         if (!empty($USER->mnethostid) and $USER->mnethostid != $CFG->mnet_localhost_id) {
1232             $host = $DB->get_record('mnet_host', array('id'=>$USER->mnethostid));
1233             $redirect = $host->wwwroot.'/';
1234         }
1235     }
1237     /**
1238      * Trims a log line from mnet peer to limit each part to a length which can be stored in our DB
1239      *
1240      * @param object $logline The log information to be trimmed
1241      * @return object The passed logline object trimmed to not exceed storable limits
1242      */
1243     function trim_logline ($logline) {
1244         $limits = array('ip' => 15, 'coursename' => 40, 'module' => 20, 'action' => 40,
1245                         'url' => 255);
1246         foreach ($limits as $property => $limit) {
1247             if (isset($logline->$property)) {
1248                 $logline->$property = substr($logline->$property, 0, $limit);
1249             }
1250         }
1252         return $logline;
1253     }
1255     /**
1256      * Returns a list of potential IdPs that this authentication plugin supports.
1257      * This is used to provide links on the login page.
1258      *
1259      * @param string $wantsurl the relative url fragment the user wants to get to.  You can use this to compose a returnurl, for example
1260      *
1261      * @return array like:
1262      *              array(
1263      *                  array(
1264      *                      'url' => 'http://someurl',
1265      *                      'icon' => new pix_icon(...),
1266      *                      'name' => get_string('somename', 'auth_yourplugin'),
1267      *                 ),
1268      *             )
1269      */
1270     function loginpage_idp_list($wantsurl) {
1271         global $DB, $CFG;
1273         // strip off wwwroot, since the remote site will prefix it's return url with this
1274         $wantsurl = preg_replace('/(' . preg_quote($CFG->wwwroot, '/') . '|' . preg_quote($CFG->httpswwwroot, '/') . ')/', '', $wantsurl);
1276         $sql = "SELECT DISTINCT h.id, h.wwwroot, h.name, a.sso_jump_url, a.name as application
1277                   FROM {mnet_host} h
1278                   JOIN {mnet_host2service} m ON h.id = m.hostid
1279                   JOIN {mnet_service} s ON s.id = m.serviceid
1280                   JOIN {mnet_application} a ON h.applicationid = a.id
1281                  WHERE s.name = ? AND h.deleted = ? AND m.publish = ?";
1282         $params = array('sso_sp', 0, 1);
1284         if (!empty($CFG->mnet_all_hosts_id)) {
1285             $sql .= " AND h.id <> ?";
1286             $params[] = $CFG->mnet_all_hosts_id;
1287         }
1289         if (!$hosts = $DB->get_records_sql($sql, $params)) {
1290             return array();
1291         }
1293         $idps = array();
1294         foreach ($hosts as $host) {
1295             $idps[] = array(
1296                 'url'  => new moodle_url($host->wwwroot . $host->sso_jump_url, array('hostwwwroot' => $CFG->wwwroot, 'wantsurl' => $wantsurl, 'remoteurl' => 1)),
1297                 'icon' => new pix_icon('i/' . $host->application . '_host', $host->name),
1298                 'name' => $host->name,
1299             );
1300         }
1301         return $idps;
1302     }