admin/mnet/peers.php

   1 <?php
   2
   3 // This file is part of Moodle - http://moodle.org/
   4 //
   5 // Moodle is free software: you can redistribute it and/or modify
   6 // it under the terms of the GNU General Public License as published by
   7 // the Free Software Foundation, either version 3 of the License, or
   8 // (at your option) any later version.
   9 //
  10 // Moodle is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 // GNU General Public License for more details.
  14 //
  15 // You should have received a copy of the GNU General Public License
  16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  17
  18
  19 /**
  20  * Page to allow the administrator to configure networked hosts, and add new ones
  21  *
  22  * @package    core
  23  * @subpackage mnet
  24  * @copyright  2007 Donal McMullan
  25  * @copyright  2007 Martin Langhoff
  26  * @copyright  2010 Penny Leach
  27  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  28  */
  29
  30 require(__DIR__.'/../../config.php');
  31 require_once($CFG->libdir.'/adminlib.php');
  32 require_once($CFG->dirroot.'/mnet/lib.php');
  33 require_once($CFG->dirroot.'/'.$CFG->admin.'/mnet/peer_forms.php');
  34
  35 require_login();
  36
  37 $context = context_system::instance();
  38 require_capability('moodle/site:config', $context, $USER->id, true, 'nopermissions');
  39
  40 /// Initialize variables.
  41 $hostid = optional_param('hostid', 0, PARAM_INT);
  42 $updra = optional_param('updateregisterall', 0, PARAM_INT);
  43
  44 // first process the register all hosts setting if required
  45 if (!empty($updra)) {
  46     set_config('mnet_register_allhosts', optional_param('registerallhosts', 0, PARAM_INT));
  47     redirect(new moodle_url('/admin/mnet/peers.php'), get_string('changessaved'));
  48 }
  49
  50 $adminsection = 'mnetpeers';
  51 if ($hostid && $DB->get_field('mnet_host', 'deleted', array('id' => $hostid)) != 1) {
  52     $adminsection = 'mnetpeer' . $hostid;
  53 }
  54
  55 $PAGE->set_url('/admin/mnet/peers.php');
  56 admin_externalpage_setup($adminsection);
  57
  58 if (!extension_loaded('openssl')) {
  59     print_error('requiresopenssl', 'mnet');
  60 }
  61
  62 if (!function_exists('curl_init') ) {
  63     print_error('nocurl', 'mnet');
  64 }
  65
  66 if (!function_exists('xmlrpc_encode_request')) {
  67     print_error('xmlrpc-missing', 'mnet');
  68 }
  69
  70 if (!isset($CFG->mnet_dispatcher_mode)) {
  71     set_config('mnet_dispatcher_mode', 'off');
  72 }
  73
  74 $mnet_peer = new mnet_peer();
  75 $simpleform = new mnet_simple_host_form(); // the one that goes on the bottom of the main page
  76 $reviewform = null; // set up later in different code branches, so mnet_peer can be passed to the constructor
  77
  78 // if the first form has been submitted, bootstrap the peer and load up the review form
  79 if ($formdata = $simpleform->get_data()) {
  80     // ensure we remove trailing slashes
  81     $formdata->wwwroot = trim($formdata->wwwroot);
  82     $formdata->wwwroot = rtrim($formdata->wwwroot, '/');
  83
  84     // ensure the wwwroot starts with a http or https prefix
  85     if (strtolower(substr($formdata->wwwroot, 0, 4)) != 'http') {
  86         $formdata->wwwroot = 'http://'.$formdata->wwwroot;
  87     }
  88
  89     $mnet_peer->set_applicationid($formdata->applicationid);
  90     $application = $DB->get_field('mnet_application', 'name', array('id'=>$formdata->applicationid));
  91     $mnet_peer->bootstrap($formdata->wwwroot, null, $application);
  92     // bootstrap the second form straight with the data from the first form
  93     $reviewform = new mnet_review_host_form(null, array('peer' => $mnet_peer)); // the second step (also the edit host form)
  94     $formdata->oldpublickey = $mnet_peer->public_key; // set this so we can confirm on form post without having to recreate the mnet_peer object
  95     $reviewform->set_data($mnet_peer);
  96     echo $OUTPUT->header();
  97     echo $OUTPUT->box_start();
  98     $reviewform->display();
  99     echo $OUTPUT->box_end();
 100     echo $OUTPUT->footer();
 101     exit;
 102 } else if ($simpleform->is_submitted()) { // validation failed
 103     $noreviewform = true;
 104 }
 105
 106 // editing a host - load up the review form
 107 if (!empty($hostid)) {
 108     // TODO print a nice little heading
 109     $mnet_peer->set_id($hostid);
 110     echo $OUTPUT->header();
 111     $currenttab = 'mnetdetails';
 112     require_once($CFG->dirroot . '/' . $CFG->admin . '/mnet/tabs.php');
 113
 114     if ($hostid != $CFG->mnet_all_hosts_id) {
 115         $mnet_peer->currentkey = mnet_get_public_key($mnet_peer->wwwroot, $mnet_peer->application);
 116         if ($mnet_peer->currentkey == $mnet_peer->public_key) {
 117             unset($mnet_peer->currentkey);
 118         } else {
 119             error_log($mnet_peer->currentkey);
 120             error_log($mnet_peer->public_key);
 121             error_log(md5($mnet_peer->currentkey));
 122             error_log(md5($mnet_peer->public_key));
 123         }
 124         $credentials = $mnet_peer->check_credentials($mnet_peer->public_key);
 125         $reviewform = new mnet_review_host_form(null, array('peer' => $mnet_peer)); // the second step (also the edit host form)
 126         $mnet_peer->oldpublickey = $mnet_peer->public_key; // set this so we can confirm on form post without having to recreate the mnet_peer object
 127         $reviewform->set_data((object)$mnet_peer);
 128         echo $OUTPUT->box_start();
 129         $reviewform->display();
 130         echo $OUTPUT->box_end();
 131     } else {
 132         // no options for allhosts host - just let the tabs display and print a notification
 133         echo $OUTPUT->notification(get_string('allhosts_no_options', 'mnet'));
 134     }
 135     echo $OUTPUT->footer();
 136     exit;
 137 }
 138
 139 // either we're in the second step of setting up a new host
 140 // or editing an existing host
 141 // try our best to set up the mnet_peer object to pass to the form definition
 142 // unless validation on simpleform failed, in which case fall through.
 143 if (empty($noreviewform) && $id = optional_param('id', 0, PARAM_INT)) {
 144     // we're editing an existing one, so set up the tabs
 145     $currenttab = 'mnetdetails';
 146     $mnet_peer->set_id($id);
 147     require_once($CFG->dirroot . '/' . $CFG->admin . '/mnet/tabs.php');
 148 } else if (empty($noreviewform) && ($wwwroot = optional_param('wwwroot', '', PARAM_URL)) && ($applicationid = optional_param('applicationid', 0, PARAM_INT))) {
 149     $application = $DB->get_field('mnet_application', 'name', array('id'=>$applicationid));
 150     $mnet_peer->bootstrap($wwwroot, null, $application);
 151 }
 152 $reviewform = new mnet_review_host_form(null, array('peer' => $mnet_peer));
 153 if ($formdata = $reviewform->get_data()) {
 154
 155     $mnet_peer->set_applicationid($formdata->applicationid);
 156     $application = $DB->get_field('mnet_application', 'name', array('id'=>$formdata->applicationid));
 157     $mnet_peer->bootstrap($formdata->wwwroot, null, $application);
 158
 159     if (!empty($formdata->name) && $formdata->name != $mnet_peer->name) {
 160         $mnet_peer->set_name($formdata->name);
 161     }
 162
 163     if (empty($formdata->theme)) {
 164         $mnet_peer->force_theme = 0;
 165         $mnet_peer->theme = null;
 166     } else {
 167         $mnet_peer->force_theme = 1;
 168         $mnet_peer->theme = $formdata->theme;
 169     }
 170
 171     $mnet_peer->deleted             = $formdata->deleted;
 172     $mnet_peer->public_key          = $formdata->public_key;
 173     $credentials                    = $mnet_peer->check_credentials($mnet_peer->public_key);
 174     $mnet_peer->public_key_expires  = $credentials['validTo_time_t'];
 175     $mnet_peer->sslverification     = $formdata->sslverification;
 176
 177     if ($mnet_peer->commit()) {
 178         redirect(new moodle_url('/admin/mnet/peers.php', array('hostid' => $mnet_peer->id)), get_string('changessaved'));
 179     } else {
 180         print_error('invalidaction', 'error', 'index.php');
 181     }
 182 } else if ($reviewform->is_submitted()) { // submitted, but errors
 183     echo $OUTPUT->header();
 184     echo $OUTPUT->box_start();
 185     $reviewform->display();
 186     echo $OUTPUT->box_end();
 187     echo $OUTPUT->footer();
 188     exit;
 189 }
 190
 191
 192 // normal flow - just display all hosts with links
 193 echo $OUTPUT->header();
 194 $hosts = mnet_get_hosts(true);
 195
 196 // print the table to display the register all hosts setting
 197 $table = new html_table();
 198 $table->head = array(get_string('registerallhosts', 'mnet'));
 199
 200 $registerrow = '';
 201 $registerstr = '';
 202 $registerurl = new moodle_url('/admin/mnet/peers.php', array('updateregisterall' => 1));
 203 if (!empty($CFG->mnet_register_allhosts)) {
 204     $registerrow = get_string('registerhostson', 'mnet');
 205     $registerurl->param('registerallhosts', 0);
 206     $registerstr = get_string('turnitoff', 'mnet');
 207 } else {
 208     $registerrow = get_string('registerhostsoff', 'mnet');
 209     $registerurl->param('registerallhosts', 1);
 210     $registerstr = get_string('turniton', 'mnet');
 211 }
 212 $registerrow .= $OUTPUT->single_button($registerurl, $registerstr);
 213
 214 // simple table with two rows of a single cell
 215 $table->data = array(
 216     array(
 217         get_string('registerallhostsexplain', 'mnet'),
 218     ),
 219     array(
 220         $registerrow
 221     ),
 222 );
 223 echo html_writer::table($table);
 224
 225 // print the list of all hosts, with little action links and buttons
 226 $table = new html_table();
 227 $table->head = array(
 228     get_string('site'),
 229     get_string('system', 'mnet'),
 230     get_string('last_connect_time', 'mnet'),
 231     '',
 232 );
 233 $table->wrap = array('nowrap', 'nowrap', 'nowrap', 'nowrap');
 234 $baseurl = new moodle_url('/admin/mnet/peers.php');
 235 $deleted = array();
 236 foreach($hosts as $host) {
 237     $hosturl = new moodle_url($baseurl, array('hostid' => $host->id));
 238     if (trim($host->name) === '') {
 239         // should not happen but...
 240         $host->name = '???';
 241     }
 242     // process all hosts first since it's the easiest
 243     if ($host->id == $CFG->mnet_all_hosts_id) {
 244         $table->data[] = array(html_writer::link($hosturl, get_string('allhosts', 'core_mnet')), '*', '', '');
 245         continue;
 246     }
 247
 248     // populate the list of deleted hosts
 249     if ($host->deleted) {
 250         $deleted[] = html_writer::link($hosturl, $host->name);
 251         continue;
 252     }
 253
 254     if ($host->last_connect_time == 0) {
 255         $last_connect = get_string('never');
 256     } else {
 257         $last_connect = userdate($host->last_connect_time, get_string('strftimedatetime', 'core_langconfig'));
 258     }
 259     $table->data[] = array(
 260         html_writer::link($hosturl, $host->name),
 261         html_writer::link($host->wwwroot, $host->wwwroot),
 262         $last_connect,
 263         $OUTPUT->single_button(new moodle_url('/admin/mnet/delete.php', array('hostid' => $host->id)), get_string('delete'))
 264     );
 265 }
 266 echo html_writer::table($table);
 267
 268 if ($deleted) {
 269     echo $OUTPUT->box(get_string('deletedhosts', 'core_mnet', join(', ', $deleted)), 'deletedhosts');
 270 }
 271
 272 // finally, print the initial form to add a new host
 273 echo $OUTPUT->box_start();
 274 echo $OUTPUT->heading(get_string('addnewhost', 'mnet'), 3);
 275 $simpleform->display();
 276 echo $OUTPUT->box_end();
 277
 278 // done
 279 echo $OUTPUT->footer();
 280 exit;
 281