MDL-23726 fixed phpdocs - credit goes to Henning Bostelmann
[moodle.git] / mnet / environment.php
blobe037f8c19eb51ae3ae142e2d520cd352c1230b4c
1 <?php // $Id$
2 /**
3 * Info about the local environment, wrt RPC
5 * This should really be a singleton. A PHP5 Todo I guess.
6 */
8 class mnet_environment {
10 var $id = 0;
11 var $wwwroot = '';
12 var $ip_address = '';
13 var $public_key = '';
14 var $public_key_expires = 0;
15 var $last_connect_time = 0;
16 var $last_log_id = 0;
17 var $keypair = array();
18 var $deleted = 0;
20 function mnet_environment() {
21 return true;
24 function init() {
25 global $CFG;
27 if (empty($CFG->mnet_dispatcher_mode)) {
28 set_config('mnet_dispatcher_mode', 'off');
31 // Bootstrap the object data on first load.
32 if (empty($CFG->mnet_localhost_id) ) {
33 if (!$CFG->mnet_localhost_id = get_config(NULL, 'mnet_localhost_id')) { // Double-check db
34 $this->wwwroot = $CFG->wwwroot;
35 if (empty($_SERVER['SERVER_ADDR'])) {
36 // SERVER_ADDR is only returned by Apache-like webservers
37 $my_hostname = mnet_get_hostname_from_uri($CFG->wwwroot);
38 $my_ip = gethostbyname($my_hostname); // Returns unmodified hostname on failure. DOH!
39 if ($my_ip == $my_hostname) {
40 $this->ip_address = 'UNKNOWN';
41 } else {
42 $this->ip_address = $my_ip;
44 } else {
45 $this->ip_address = $_SERVER['SERVER_ADDR'];
48 if ($existingrecord = get_record('mnet_host', 'ip_address', $this->ip_address)) {
49 $this->id = $existingrecord->id;
50 } else { // make a new one
51 $this->id = insert_record('mnet_host', $this, true);
54 set_config('mnet_localhost_id', $this->id);
55 $this->get_keypair();
57 } else {
58 $hostobject = get_record('mnet_host','id', $CFG->mnet_localhost_id);
59 if(is_object($hostobject)) {
60 $temparr = get_object_vars($hostobject);
61 foreach($temparr as $key => $value) {
62 $this->$key = $value;
64 unset($hostobject, $temparr);
65 } else {
66 return false;
69 // Unless this is an install/upgrade, generate the SSL keys.
70 if(empty($this->public_key)) {
71 $this->get_keypair();
75 // We need to set up a record that represents 'all hosts'. Any rights
76 // granted to this host will be conferred on all hosts.
77 if (empty($CFG->mnet_all_hosts_id) ) {
78 $hostobject = new stdClass();
79 $hostobject->wwwroot = '';
80 $hostobject->ip_address = '';
81 $hostobject->public_key = '';
82 $hostobject->public_key_expires = 0;
83 $hostobject->last_connect_time = 0;
84 $hostobject->last_log_id = 0;
85 $hostobject->deleted = 0;
86 $hostobject->name = 'All Hosts';
88 $hostobject->id = insert_record('mnet_host',$hostobject, true);
89 set_config('mnet_all_hosts_id', $hostobject->id);
90 $CFG->mnet_all_hosts_id = $hostobject->id;
91 unset($hostobject);
95 function get_keypair() {
96 // We don't generate keys on install/upgrade because we want the USER
97 // record to have an email address, city and country already.
98 if (!empty($_SESSION['upgraderunning'])) return true;
99 if (!extension_loaded("openssl")) return true;
100 if (!empty($this->keypair)) return true;
102 $this->keypair = array();
103 $keypair = get_field('config_plugins', 'value', 'plugin', 'mnet', 'name', 'openssl');
105 if (!empty($keypair)) {
106 // Explode/Implode is faster than Unserialize/Serialize
107 list($this->keypair['certificate'], $this->keypair['keypair_PEM']) = explode('@@@@@@@@', $keypair);
110 if ($this->public_key_expires > time()) {
111 $this->keypair['privatekey'] = openssl_pkey_get_private($this->keypair['keypair_PEM']);
112 $this->keypair['publickey'] = openssl_pkey_get_public($this->keypair['certificate']);
113 } else {
114 // Key generation/rotation
116 // 1. Archive the current key (if there is one).
117 $result = get_field('config_plugins', 'value', 'plugin', 'mnet', 'name', 'openssl_history');
118 if(empty($result)) {
119 set_config('openssl_history', serialize(array()), 'mnet');
120 $openssl_history = array();
121 } else {
122 $openssl_history = unserialize($result);
125 if(count($this->keypair)) {
126 $this->keypair['expires'] = $this->public_key_expires;
127 array_unshift($openssl_history, $this->keypair);
130 // 2. How many old keys do we want to keep? Use array_slice to get
131 // rid of any we don't want
132 $openssl_generations = get_field('config_plugins', 'value', 'plugin', 'mnet', 'name', 'openssl_generations');
133 if(empty($openssl_generations)) {
134 set_config('openssl_generations', 3, 'mnet');
135 $openssl_generations = 3;
138 if(count($openssl_history) > $openssl_generations) {
139 $openssl_history = array_slice($openssl_history, 0, $openssl_generations);
142 set_config('openssl_history', serialize($openssl_history), 'mnet');
144 // 3. Generate fresh keys
145 $this->replace_keys();
147 return true;
150 function replace_keys() {
151 global $CFG;
152 $this->keypair = array();
153 $this->keypair = mnet_generate_keypair();
154 $this->public_key = $this->keypair['certificate'];
155 $this->wwwroot = $CFG->wwwroot;
156 $details = openssl_x509_parse($this->public_key);
157 $this->public_key_expires = $details['validTo_time_t'];
158 if (empty($_SERVER['SERVER_ADDR'])) {
159 // SERVER_ADDR is only returned by Apache-like webservers
160 $my_hostname = mnet_get_hostname_from_uri($CFG->wwwroot);
161 $my_ip = gethostbyname($my_hostname); // Returns unmodified hostname on failure. DOH!
162 if ($my_ip == $my_hostname) {
163 $this->ip_address = 'UNKNOWN';
164 } else {
165 $this->ip_address = $my_ip;
167 } else {
168 $this->ip_address = $_SERVER['SERVER_ADDR'];
170 set_config('openssl', implode('@@@@@@@@', $this->keypair), 'mnet');
172 // clone the proper object and then unset anything that isn't required to go into the database
173 // most fields don't matter but things that are arrays, will break things.
174 $dbobject = (object)clone($this);
175 unset($dbobject->keypair);
176 update_record('mnet_host', addslashes_object($dbobject));
177 error_log('New public key has been generated. It expires ' . date('Y/m/d h:i:s', $this->public_key_expires));
180 function get_private_key() {
181 if (empty($this->keypair)) $this->get_keypair();
182 if (isset($this->keypair['privatekey'])) return $this->keypair['privatekey'];
183 $this->keypair['privatekey'] = openssl_pkey_get_private($this->keypair['keypair_PEM']);
184 return $this->keypair['privatekey'];
187 function get_public_key() {
188 if (!isset($this->keypair)) $this->get_keypair();
189 if (isset($this->keypair['publickey'])) return $this->keypair['publickey'];
190 $this->keypair['publickey'] = openssl_pkey_get_public($this->keypair['certificate']);
191 return $this->keypair['publickey'];