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.

Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401] [Versions 400 and 401] [Versions 401 and 402] [Versions 401 and 403]

   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  
  36  /// Initialize variables.
  37  $hostid = optional_param('hostid', 0, PARAM_INT);
  38  $updra = optional_param('updateregisterall', 0, PARAM_INT);
  39  
  40  // first process the register all hosts setting if required
  41  if (!empty($updra)) {
  42      set_config('mnet_register_allhosts', optional_param('registerallhosts', 0, PARAM_INT));
  43      redirect(new moodle_url('/admin/mnet/peers.php'), get_string('changessaved'));
  44  }
  45  
  46  $adminsection = 'mnetpeers';
  47  if ($hostid && $DB->get_field('mnet_host', 'deleted', array('id' => $hostid)) != 1) {
  48      $adminsection = 'mnetpeer' . $hostid;
  49  }
  50  
  51  $PAGE->set_url('/admin/mnet/peers.php');
  52  admin_externalpage_setup($adminsection);
  53  
  54  if (!extension_loaded('openssl')) {
  55      throw new \moodle_exception('requiresopenssl', 'mnet');
  56  }
  57  
  58  if (!function_exists('curl_init') ) {
  59      throw new \moodle_exception('nocurl', 'mnet');
  60  }
  61  
  62  if (!isset($CFG->mnet_dispatcher_mode)) {
  63      set_config('mnet_dispatcher_mode', 'off');
  64  }
  65  
  66  $mnet_peer = new mnet_peer();
  67  $simpleform = new mnet_simple_host_form(); // the one that goes on the bottom of the main page
  68  $reviewform = null; // set up later in different code branches, so mnet_peer can be passed to the constructor
  69  
  70  // if the first form has been submitted, bootstrap the peer and load up the review form
  71  if ($formdata = $simpleform->get_data()) {
  72      // ensure we remove trailing slashes
  73      $formdata->wwwroot = trim($formdata->wwwroot);
  74      $formdata->wwwroot = rtrim($formdata->wwwroot, '/');
  75  
  76      // ensure the wwwroot starts with a http or https prefix
  77      if (strtolower(substr($formdata->wwwroot, 0, 4)) != 'http') {
  78          $formdata->wwwroot = 'http://'.$formdata->wwwroot;
  79      }
  80  
  81      $mnet_peer->set_applicationid($formdata->applicationid);
  82      $application = $DB->get_field('mnet_application', 'name', array('id'=>$formdata->applicationid));
  83      $mnet_peer->bootstrap($formdata->wwwroot, null, $application);
  84      // bootstrap the second form straight with the data from the first form
  85      $reviewform = new mnet_review_host_form(null, array('peer' => $mnet_peer)); // the second step (also the edit host form)
  86      $formdata->oldpublickey = $mnet_peer->public_key; // set this so we can confirm on form post without having to recreate the mnet_peer object
  87      $reviewform->set_data($mnet_peer);
  88      echo $OUTPUT->header();
  89      echo $OUTPUT->box_start();
  90      $reviewform->display();
  91      echo $OUTPUT->box_end();
  92      echo $OUTPUT->footer();
  93      exit;
  94  } else if ($simpleform->is_submitted()) { // validation failed
  95      $noreviewform = true;
  96  }
  97  
  98  // editing a host - load up the review form
  99  if (!empty($hostid)) {
 100      // TODO print a nice little heading
 101      $mnet_peer->set_id($hostid);
 102      echo $OUTPUT->header();
 103      $currenttab = 'mnetdetails';
 104      require_once($CFG->dirroot . '/' . $CFG->admin . '/mnet/tabs.php');
 105  
 106      if ($hostid != $CFG->mnet_all_hosts_id) {
 107          $mnet_peer->currentkey = mnet_get_public_key($mnet_peer->wwwroot, $mnet_peer->application);
 108          if ($mnet_peer->currentkey == $mnet_peer->public_key) {
 109              unset($mnet_peer->currentkey);
 110          } else {
 111              error_log($mnet_peer->currentkey);
 112              error_log($mnet_peer->public_key);
 113              error_log(md5($mnet_peer->currentkey));
 114              error_log(md5($mnet_peer->public_key));
 115          }
 116          $credentials = $mnet_peer->check_credentials($mnet_peer->public_key);
 117          $reviewform = new mnet_review_host_form(null, array('peer' => $mnet_peer)); // the second step (also the edit host form)
 118          $mnet_peer->oldpublickey = $mnet_peer->public_key; // set this so we can confirm on form post without having to recreate the mnet_peer object
 119          $reviewform->set_data((object)$mnet_peer);
 120          echo $OUTPUT->box_start();
 121          $reviewform->display();
 122          echo $OUTPUT->box_end();
 123      } else {
 124          // no options for allhosts host - just let the tabs display and print a notification
 125          echo $OUTPUT->notification(get_string('allhosts_no_options', 'mnet'));
 126      }
 127      echo $OUTPUT->footer();
 128      exit;
 129  }
 130  
 131  // either we're in the second step of setting up a new host
 132  // or editing an existing host
 133  // try our best to set up the mnet_peer object to pass to the form definition
 134  // unless validation on simpleform failed, in which case fall through.
 135  if (empty($noreviewform) && $id = optional_param('id', 0, PARAM_INT)) {
 136      // we're editing an existing one, so set up the tabs
 137      $currenttab = 'mnetdetails';
 138      $mnet_peer->set_id($id);
 139      require_once($CFG->dirroot . '/' . $CFG->admin . '/mnet/tabs.php');
 140  } else if (empty($noreviewform) && ($wwwroot = optional_param('wwwroot', '', PARAM_URL)) && ($applicationid = optional_param('applicationid', 0, PARAM_INT))) {
 141      $application = $DB->get_field('mnet_application', 'name', array('id'=>$applicationid));
 142      $mnet_peer->bootstrap($wwwroot, null, $application);
 143  }
 144  $reviewform = new mnet_review_host_form(null, array('peer' => $mnet_peer));
 145  if ($formdata = $reviewform->get_data()) {
 146  
 147      $mnet_peer->set_applicationid($formdata->applicationid);
 148      $application = $DB->get_field('mnet_application', 'name', array('id'=>$formdata->applicationid));
 149      $mnet_peer->bootstrap($formdata->wwwroot, null, $application);
 150  
 151      if (!empty($formdata->name) && $formdata->name != $mnet_peer->name) {
 152          $mnet_peer->set_name($formdata->name);
 153      }
 154  
 155      if (empty($formdata->theme)) {
 156          $mnet_peer->force_theme = 0;
 157          $mnet_peer->theme = null;
 158      } else {
 159          $mnet_peer->force_theme = 1;
 160          $mnet_peer->theme = $formdata->theme;
 161      }
 162  
 163      $mnet_peer->deleted             = $formdata->deleted;
 164      $mnet_peer->public_key          = $formdata->public_key;
 165      $credentials                    = $mnet_peer->check_credentials($mnet_peer->public_key);
 166      $mnet_peer->public_key_expires  = $credentials['validTo_time_t'];
 167      $mnet_peer->sslverification     = $formdata->sslverification;
 168  
 169      if ($mnet_peer->commit()) {
 170          redirect(new moodle_url('/admin/mnet/peers.php', array('hostid' => $mnet_peer->id)), get_string('changessaved'));
 171      } else {
 172          throw new \moodle_exception('invalidaction', 'error', 'index.php');
 173      }
 174  } else if ($reviewform->is_submitted()) { // submitted, but errors
 175      echo $OUTPUT->header();
 176      echo $OUTPUT->box_start();
 177      $reviewform->display();
 178      echo $OUTPUT->box_end();
 179      echo $OUTPUT->footer();
 180      exit;
 181  }
 182  
 183  
 184  // normal flow - just display all hosts with links
 185  echo $OUTPUT->header();
 186  $hosts = mnet_get_hosts(true);
 187  
 188  // print the table to display the register all hosts setting
 189  $table = new html_table();
 190  $table->head = array(get_string('registerallhosts', 'mnet'));
 191  
 192  $registerrow = '';
 193  $registerstr = '';
 194  $registerurl = new moodle_url('/admin/mnet/peers.php', array('updateregisterall' => 1));
 195  if (!empty($CFG->mnet_register_allhosts)) {
 196      $registerrow = get_string('registerhostson', 'mnet');
 197      $registerurl->param('registerallhosts', 0);
 198      $registerstr = get_string('turnitoff', 'mnet');
 199  } else {
 200      $registerrow = get_string('registerhostsoff', 'mnet');
 201      $registerurl->param('registerallhosts', 1);
 202      $registerstr = get_string('turniton', 'mnet');
 203  }
 204  $registerrow .= $OUTPUT->single_button($registerurl, $registerstr);
 205  
 206  // simple table with two rows of a single cell
 207  $table->data = array(
 208      array(
 209          get_string('registerallhostsexplain', 'mnet'),
 210      ),
 211      array(
 212          $registerrow
 213      ),
 214  );
 215  echo html_writer::table($table);
 216  
 217  // print the list of all hosts, with little action links and buttons
 218  $table = new html_table();
 219  $table->head = array(
 220      get_string('site'),
 221      get_string('system', 'mnet'),
 222      get_string('last_connect_time', 'mnet'),
 223      '',
 224  );
 225  $table->wrap = array('nowrap', 'nowrap', 'nowrap', 'nowrap');
 226  $baseurl = new moodle_url('/admin/mnet/peers.php');
 227  $deleted = array();
 228  foreach($hosts as $host) {
 229      $hosturl = new moodle_url($baseurl, array('hostid' => $host->id));
 230      if (trim($host->name) === '') {
 231          // should not happen but...
 232          $host->name = '???';
 233      }
 234      // process all hosts first since it's the easiest
 235      if ($host->id == $CFG->mnet_all_hosts_id) {
 236          $table->data[] = array(html_writer::link($hosturl, get_string('allhosts', 'core_mnet')), '*', '', '');
 237          continue;
 238      }
 239  
 240      // populate the list of deleted hosts
 241      if ($host->deleted) {
 242          $deleted[] = html_writer::link($hosturl, $host->name);
 243          continue;
 244      }
 245  
 246      if ($host->last_connect_time == 0) {
 247          $last_connect = get_string('never');
 248      } else {
 249          $last_connect = userdate($host->last_connect_time, get_string('strftimedatetime', 'core_langconfig'));
 250      }
 251      $table->data[] = array(
 252          html_writer::link($hosturl, $host->name),
 253          html_writer::link($host->wwwroot, $host->wwwroot),
 254          $last_connect,
 255          $OUTPUT->single_button(new moodle_url('/admin/mnet/delete.php', array('hostid' => $host->id)), get_string('delete'))
 256      );
 257  }
 258  echo html_writer::table($table);
 259  
 260  if ($deleted) {
 261      echo $OUTPUT->box(get_string('deletedhosts', 'core_mnet', join(', ', $deleted)), 'deletedhosts');
 262  }
 263  
 264  // finally, print the initial form to add a new host
 265  echo $OUTPUT->box_start();
 266  echo $OUTPUT->heading(get_string('addnewhost', 'mnet'), 3);
 267  $simpleform->display();
 268  echo $OUTPUT->box_end();
 269  
 270  // done
 271  echo $OUTPUT->footer();
 272  exit;
 273