block_mnet_hosts.php

<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/**
 * MNet hosts block.
 *
 * @package    block_mnet_hosts
 * @copyright  1999 onwards Martin Dougiamas (http://dougiamas.com)
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

class block_mnet_hosts extends block_list {
    function init() {
        $this->title = get_string('pluginname','block_mnet_hosts') ;
    }

    function has_config() {
        return false;
    }

    function applicable_formats() {
        if (has_capability('moodle/site:mnetlogintoremote', context_system::instance(), NULL, false)) {
            return array('all' => true, 'mod' => false, 'tag' => false);
        } else {
            return array('site' => true);
        }
    }

    function get_content() {
        global $CFG, $USER, $DB, $OUTPUT;

        // shortcut -  only for logged in users!
        if (!isloggedin() || isguestuser()) {
            return false;
        }

        if (\core\session\manager::is_loggedinas()) {
            $this->content = new stdClass();
            $this->content->footer = html_writer::tag('span',
                get_string('notpermittedtojumpas', 'mnet'));
            return $this->content;
        }

        // according to start_jump_session,
        // remote users can't on-jump
        // so don't show this block to them
        if (is_mnet_remote_user($USER)) {
            if (debugging() and !empty($CFG->debugdisplay)) {
                $this->content = new stdClass();
                $this->content->footer = html_writer::tag('span',
                    get_string('error_localusersonly', 'block_mnet_hosts'),
                    array('class' => 'error'));
                return $this->content;
            } else {
                return '';
            }
        }

        if (!is_enabled_auth('mnet')) {
            if (debugging() and !empty($CFG->debugdisplay)) {
                $this->content = new stdClass();
                $this->content->footer = html_writer::tag('span',
                    get_string('error_authmnetneeded', 'block_mnet_hosts'),
                    array('class' => 'error'));
                return $this->content;
            } else {
                return '';
            }
        }

        if (!has_capability('moodle/site:mnetlogintoremote', context_system::instance(), NULL, false)) {
            if (debugging() and !empty($CFG->debugdisplay)) {
                $this->content = new stdClass();
                $this->content->footer = html_writer::tag('span',
                    get_string('error_roamcapabilityneeded', 'block_mnet_hosts'),
                    array('class' => 'error'));
                return $this->content;
            } else {
                return '';
            }
        }

        if ($this->content !== NULL) {
            return $this->content;
        }

        // TODO: Test this query - it's appropriate? It works?
        // get the hosts and whether we are doing SSO with them
        $sql = "
             SELECT DISTINCT
                 h.id,
                 h.name,
                 h.wwwroot,
                 a.name as application,
                 a.display_name
             FROM
                 {mnet_host} h,
                 {mnet_application} a,
                 {mnet_host2service} h2s_IDP,
                 {mnet_service} s_IDP,
                 {mnet_host2service} h2s_SP,
                 {mnet_service} s_SP
             WHERE
                 h.id <> ? AND
                 h.id <> ? AND
                 h.id = h2s_IDP.hostid AND
                 h.deleted = 0 AND
                 h.applicationid = a.id AND
                 h2s_IDP.serviceid = s_IDP.id AND
                 s_IDP.name = 'sso_idp' AND
                 h2s_IDP.publish = '1' AND
                 h.id = h2s_SP.hostid AND
                 h2s_SP.serviceid = s_SP.id AND
                 s_SP.name = 'sso_idp' AND
                 h2s_SP.publish = '1'
             ORDER BY
                 a.display_name,
                 h.name";

        $hosts = $DB->get_records_sql($sql, array($CFG->mnet_localhost_id, $CFG->mnet_all_hosts_id));

        $this->content = new stdClass();
        $this->content->items = array();
        $this->content->icons = array();
        $this->content->footer = '';

        if ($hosts) {
            foreach ($hosts as $host) {
                if ($host->id == $USER->mnethostid) {
                    $url = new \moodle_url($host->wwwroot);
                } else {
                    $url = new \moodle_url('/auth/mnet/jump.php', array('hostid' => $host->id));
                }
                $this->content->items[] = html_writer::tag('a',
                    $OUTPUT->pix_icon("i/{$host->application}_host", get_string('server', 'block_mnet_hosts')) . s($host->name),
                    array('href' => $url->out(), 'title' => s($host->name))
                );
            }
        }

        return $this->content;
    }

    /**
     * This block shouldn't be added to a page if the mnet authentication method is disabled.
     *
     * @param moodle_page $page
     * @return bool
     */
    public function can_block_be_added(moodle_page $page): bool {
        return is_enabled_auth('mnet');
    }
}