Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
<?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/>.

/**
 * This file contains two forms for adding/editing mnet hosts, used by peers.php
 *
 * @package    core
 * @subpackage mnet
 * @copyright  2010 Penny Leach
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

defined('MOODLE_INTERNAL') || die();

require_once($CFG->libdir . '/formslib.php');

/**
 * The very basic first step add new host form - just wwwroot & application
 * The second form is loaded up with the information from this one.
 */
class mnet_simple_host_form extends moodleform {
    function definition() {
        global $DB;

        $mform = $this->_form;

        $mform->addElement('text', 'wwwroot', get_string('hostname', 'mnet'), array('maxlength' => 255, 'size' => 50));
        $mform->setType('wwwroot', PARAM_URL);
        $mform->addRule('wwwroot', null, 'required', null, 'client');
        $mform->addRule('wwwroot', get_string('maximumchars', '', 255), 'maxlength', 255, 'client');

        $mform->addElement('select', 'applicationid', get_string('applicationtype', 'mnet'),
                           $DB->get_records_menu('mnet_application', array(), 'id,display_name'));
        $mform->addRule('applicationid', null, 'required', null, 'client');

        $this->add_action_buttons(false, get_string('addhost', 'mnet'));
    }

    function validation($data, $files) {
        global $DB;

        $wwwroot = $data['wwwroot'];
        // ensure the wwwroot starts with a http or https prefix
        if (strtolower(substr($wwwroot, 0, 4)) != 'http') {
            $wwwroot = 'http://'.$wwwroot;
        }
        if ($host = $DB->get_record('mnet_host', array('wwwroot' => $wwwroot))) {
< global $CFG; < return array('wwwroot' => get_string('hostexists', 'mnet', < new moodle_url('/admin/mnet/peers.php', array('hostid' => $host->id))));
> $str = get_string('hostexists', 'mnet', (new moodle_url('/admin/mnet/peers.php', ['hostid' => $host->id]))->out()); > return array('wwwroot' => $str);
} return array(); } } /** * The second step of the form - reviewing the host details * This is also the same form that is used for editing an existing host */ class mnet_review_host_form extends moodleform { function definition() { global $OUTPUT; $mform = $this->_form; $mnet_peer = $this->_customdata['peer']; $mform->addElement('hidden', 'last_connect_time'); $mform->setType('last_connect_time', PARAM_INT); $mform->addElement('hidden', 'id'); $mform->setType('id', PARAM_INT); $mform->addElement('hidden', 'applicationid'); $mform->setType('applicationid', PARAM_INT); $mform->addElement('hidden', 'oldpublickey'); $mform->setType('oldpublickey', PARAM_PEM); $mform->addElement('text', 'name', get_string('site'), array('maxlength' => 80, 'size' => 50)); $mform->setType('name', PARAM_NOTAGS); $mform->addRule('name', get_string('maximumchars', '', 80), 'maxlength', 80, 'client'); $mform->addElement('text', 'wwwroot', get_string('hostname', 'mnet'), array('maxlength' => 255, 'size' => 50)); $mform->setType('wwwroot', PARAM_URL); $mform->addRule('wwwroot', get_string('maximumchars', '', 255), 'maxlength', 255, 'client'); $options = array( mnet_peer::SSL_NONE => get_string('none'), mnet_peer::SSL_HOST => get_string('verifyhostonly', 'core_mnet'), mnet_peer::SSL_HOST_AND_PEER => get_string('verifyhostandpeer', 'core_mnet') ); $mform->addElement('select', 'sslverification', get_string('sslverification', 'core_mnet'), $options); $mform->setDefault('sslverification', mnet_peer::SSL_HOST_AND_PEER); $mform->addHelpButton('sslverification', 'sslverification', 'core_mnet'); $themes = array('' => get_string('forceno')); foreach (array_keys(core_component::get_plugin_list('theme')) as $themename) { $themes[$themename] = get_string('pluginname', 'theme_'.$themename); } $mform->addElement('select', 'theme', get_string('forcetheme'), $themes); $mform->addElement('textarea', 'public_key', get_string('publickey', 'mnet'), array('rows' => 17, 'cols' => 100, 'class' => 'smalltext')); $mform->setType('public_key', PARAM_PEM); $mform->addRule('public_key', get_string('required'), 'required'); // finished with form controls, now the static informational stuff if ($mnet_peer && !empty($mnet_peer->bootstrapped)) { $expires = ''; if ($mnet_peer->public_key_expires < time()) { $expires = get_string('expired', 'mnet') . ' '; } $expires .= userdate($mnet_peer->public_key_expires); $mform->addElement('static', 'validuntil', get_string('expires', 'mnet'), $expires); $lastconnect = ''; if ($mnet_peer->last_connect_time == 0) { $lastconnect = get_string('never', 'mnet'); } else { $lastconnect = date('H:i:s d/m/Y',$mnet_peer->last_connect_time); } $mform->addElement('static', 'lastconnect', get_string('last_connect_time', 'mnet'), $lastconnect); $mform->addElement('static', 'ipaddress', get_string('ipaddress', 'mnet'), $mnet_peer->ip_address); if (isset($mnet_peer->currentkey)) { // key being published is not the same as our records $currentkeystr = '<b>' . get_string('keymismatch', 'mnet') . '</b><br /><br /> ' . $OUTPUT->box('<pre>' . $mnet_peer->currentkey . '</pre>'); $mform->addElement('static', 'keymismatch', get_string('currentkey', 'mnet'), $currentkeystr); } $credstr = ''; if ($credentials = $mnet_peer->check_credentials($mnet_peer->public_key)) { foreach($credentials['subject'] as $key => $credential) { if (is_scalar($credential)) { $credstr .= str_pad($key, 16, " ", STR_PAD_LEFT).': '.$credential."\n"; } else { $credstr .= str_pad($key, 16, " ", STR_PAD_LEFT).': '.var_export($credential,1)."\n"; } } } $mform->addElement('static', 'certdetails', get_string('certdetails', 'mnet'), $OUTPUT->box('<pre>' . $credstr . '</pre>', 'generalbox certdetails')); } if ($mnet_peer && !empty($mnet_peer->deleted)) { $radioarray = array(); $radioarray[] = $mform->createElement('static', 'deletedinfo', '', $OUTPUT->container(get_string('deletedhostinfo', 'mnet'), 'alert alert-warning')); $radioarray[] = $mform->createElement('radio', 'deleted', '', get_string('yes'), 1); $radioarray[] = $mform->createElement('radio', 'deleted', '', get_string('no'), 0); $mform->addGroup($radioarray, 'radioar', get_string('deleted'), array(' ', ' '), false); } else { $mform->addElement('hidden', 'deleted'); $mform->setType('deleted', PARAM_BOOL); } // finished with static stuff, print save button $this->add_action_buttons(false); } function validation($data, $files) { $errors = array(); if ($data['oldpublickey'] == $data['public_key']) { return; } $mnet_peer = new mnet_peer(); // idiotic api $mnet_peer->wwwroot = $data['wwwroot']; // just hard-set this rather than bootstrap the object if (empty($data['public_key'])) { $errors['public_key'] = get_string('publickeyrequired', 'mnet'); } else if (!$credentials = $mnet_peer->check_credentials($data['public_key'])) { $errmsg = ''; foreach ($mnet_peer->error as $err) { $errmsg .= $err['code'] . ': ' . $err['text'].'<br />'; } $errors['public_key'] = get_string('invalidpubkey', 'mnet', $errmsg); } unset($mnet_peer); return $errors; } }