mnet MDL-21276 get rid of all the $MNET* globals
[moodle.git] / portfolio / mahara / lib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * This file contains the class definition for the mahara portfolio plugin
20  *
21  * @since 2.0
22  * @package moodlecore
23  * @subpackage portfolio
24  * @copyright 2009 Penny Leach
25  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26  */
29 define('PORTFOLIO_MAHARA_ERR_NETWORKING_OFF', 'err_networkingoff');
30 define('PORTFOLIO_MAHARA_ERR_NOHOSTS', 'err_nomnethosts');
31 define('PORTFOLIO_MAHARA_ERR_INVALIDHOST', 'err_invalidhost');
32 define('PORTFOLIO_MAHARA_ERR_NOMNETAUTH', 'err_nomnetauth');
34 require_once($CFG->libdir . '/portfoliolib.php');
35 require_once($CFG->libdir . '/portfolio/plugin.php');
36 require_once($CFG->libdir . '/portfolio/exporter.php');
37 require_once($CFG->dirroot . '/mnet/lib.php');
39 define('PORTFOLIO_MAHARA_QUEUE', PORTFOLIO_TIME_HIGH);
40 define('PORTFOLIO_MAHARA_IMMEDIATE', PORTFOLIO_TIME_MODERATE);
42 class portfolio_plugin_mahara extends portfolio_plugin_pull_base {
44     private $hosts; // used in the admin config form
45     private $mnethost; // privately set during export from the admin config value (mnethostid)
46     private $hostrecord; // the host record that corresponds to the peer
47     private $token; // during-transfer token
48     private $sendtype; // whatever mahara has said it can handle (immediate or queued)
49     private $filesmanifest; // manifest of files to send to mahara (set during prepare_package and sent later)
50     private $totalsize; // total size of all included files added together
51     private $continueurl; // if we've been sent back a specific url to continue to (eg folder id)
53     protected function init() {
54         $this->mnet = get_mnet_environment();
55     }
57     public function __wakeup() {
58         $this->mnet = get_mnet_environment();
59     }
61     public static function get_name() {
62         return get_string('pluginname', 'portfolio_mahara');
63     }
65     public static function get_allowed_config() {
66         return array('mnethostid');
67     }
69     public static function supported_formats() {
70         return array(PORTFOLIO_FORMAT_FILE);
71         // TODO remove above line once leap over mnet is tested
72         return array(PORTFOLIO_FORMAT_FILE, PORTFOLIO_FORMAT_LEAP2A);
73     }
75     public function expected_time($callertime) {
76         if ($this->sendtype == PORTFOLIO_MAHARA_QUEUE) {
77             return PORTFOLIO_TIME_FORCEQUEUE;
78         }
79         return $callertime;
80     }
82     public static function has_admin_config() {
83         return true;
84     }
86     public function admin_config_form(&$mform) {
87         $strrequired = get_string('required');
88         $hosts = self::get_mnet_hosts(); // this is called by sanity check but it's ok because it's cached
89         foreach ($hosts as $host) {
90             $hosts[$host->id] = $host->name;
91         }
92         $mform->addElement('select', 'mnethostid', get_string('mnethost', 'portfolio_mahara'), $hosts);
93         $mform->addRule('mnethostid', $strrequired, 'required', null, 'client');
94     }
96     public function instance_sanity_check() {
97         // make sure the host record exists since we don't have referential integrity
98         if (!is_enabled_auth('mnet')) {
99             return PORTFOLIO_MAHARA_ERR_NOMNETAUTH;
100         }
101         try {
102             $this->ensure_mnethost();
103         }
104         catch (portfolio_exception $e) {
105             return PORTFOLIO_MAHARA_ERR_INVALIDHOST;
106         }
107         // make sure we have the right services
108         $hosts = $this->get_mnet_hosts();
109         if (!array_key_exists($this->get_config('mnethostid'), $hosts)) {
110             return PORTFOLIO_MAHARA_ERR_INVALIDHOST;
111         }
112         return 0;
113     }
115     public static function plugin_sanity_check() {
116         global $CFG, $DB;
117         $errorcode = 0;
118         if (!isset($CFG->mnet_dispatcher_mode) || $CFG->mnet_dispatcher_mode != 'strict') {
119             $errorcode =  PORTFOLIO_MAHARA_ERR_NETWORKING_OFF;
120         }
121         if (!is_enabled_auth('mnet')) {
122             $errorcode = PORTFOLIO_MAHARA_ERR_NOMNETAUTH;
123         }
124         if (!self::get_mnet_hosts()) {
125             $errorcode =  PORTFOLIO_MAHARA_ERR_NOHOSTS;
126         }
127         return $errorcode;
128     }
130     private static function get_mnet_hosts() {
131         global $DB, $CFG;
132         static $hosts;
133         if (isset($this) && is_object($this) && isset($this->hosts)) {
134             return $this->hosts;
135         } else if (!isset($this) && isset($hosts)) {
136             return $hosts;
137         }
138         $hosts = $DB->get_records_sql('  SELECT
139                                     h.id,
140                                     h.wwwroot,
141                                     h.ip_address,
142                                     h.name,
143                                     h.public_key,
144                                     h.public_key_expires,
145                                     h.transport,
146                                     h.portno,
147                                     h.last_connect_time,
148                                     h.last_log_id,
149                                     h.applicationid,
150                                     a.name as app_name,
151                                     a.display_name as app_display_name,
152                                     a.xmlrpc_server_url
153                                 FROM {mnet_host} h
154                                     JOIN {mnet_application} a ON h.applicationid=a.id
155                                     JOIN {mnet_host2service} hs1 ON hs1.hostid = h.id
156                                     JOIN {mnet_service} s1 ON hs1.serviceid = s1.id
157                                     JOIN {mnet_host2service} hs2 ON hs2.hostid = h.id
158                                     JOIN {mnet_service} s2 ON hs2.serviceid = s2.id
159                                     JOIN {mnet_host2service} hs3 ON hs3.hostid = h.id
160                                     JOIN {mnet_service} s3 ON hs3.serviceid = s3.id
161                                 WHERE
162                                     h.id <> ? AND
163                                     h.deleted = 0 AND
164                                     a.name = ? AND
165                                     s1.name = ? AND hs1.publish = ? AND
166                                     s2.name = ? AND hs2.subscribe = ? AND
167                                     s3.name = ? AND hs3.subscribe = ? AND
168                                     s3.name = ? AND hs3.publish = ?',
169                         array($CFG->mnet_localhost_id, 'mahara', 'sso_idp', 1, 'sso_sp', 1, 'pf', 1, 'pf', 1));
170         if (empty($hosts)) { $hosts = array(); }
171         if (isset($this) && is_object($this)) {
172             $this->hosts = $hosts;
173         }
174         return $hosts;
175     }
177     public function prepare_package() {
178         $files = $this->exporter->get_tempfiles();
179         $this->totalsize = 0;
180         foreach ($files as $f) {
181             $this->filesmanifest[$f->get_contenthash()] = array(
182                 'filename' => $f->get_filename(),
183                 'sha1'     => $f->get_contenthash(),
184                 'size'     => $f->get_filesize(),
185             );
186             $this->totalsize += $f->get_filesize();
187         }
189         $this->set('file', $this->exporter->zip_tempfiles());  // this will throw a file_exception which the exporter catches separately.
190     }
192     public function send_package() {
193         global $CFG;
194         // send the 'content_ready' request to mahara
195         require_once($CFG->dirroot . '/mnet/xmlrpc/client.php');
196         $client = new mnet_xmlrpc_client();
197         $client->set_method('portfolio/mahara/lib.php/send_content_ready');
198         $client->add_param($this->token);
199         $client->add_param($this->get('user')->username);
200         $client->add_param($this->resolve_format());
201         $client->add_param(array(
202             'filesmanifest' => $this->filesmanifest,
203             'zipfilesha1'   => $this->get('file')->get_contenthash(),
204             'zipfilesize'   => $this->get('file')->get_filesize(),
205             'totalsize'     => $this->totalsize,
206         ));
207         $client->add_param($this->get_export_config('wait'));
208         $this->ensure_mnethost();
209         if (!$client->send($this->mnethost)) {
210             foreach ($client->error as $errormessage) {
211                 list($code, $message) = array_map('trim',explode(':', $errormessage, 2));
212                 $message .= "ERROR $code:<br/>$errormessage<br/>";
213             }
214             throw new portfolio_export_exception($this->get('exporter'), 'failedtoping', 'portfolio_mahara', '', $message);
215         }
216         // we should get back...  an ok and a status
217         // either we've been waiting a while and mahara has fetched the file or has queued it.
218         $response = (object)$client->response;
219         if (!$response->status) {
220             throw new portfolio_export_exception($this->get('exporter'), 'failedtoping', 'portfolio_mahara');
221         }
222         if ($response->type =='queued') {
223             $this->exporter->set_forcequeue();
224         }
225         if (isset($response->querystring)) {
226             $this->continueurl = $response->querystring;
227         }
228         // if we're not queuing the logging might have already happened
229         $this->exporter->update_log_url($this->get_static_continue_url());
230     }
232     public function get_static_continue_url() {
233         $remoteurl = '/artefact/file/';// @todo penny this might change later when we change formats.
234         if (isset($this->continueurl)) {
235             $remoteurl .= $this->continueurl;
236         }
237         return $remoteurl;
238     }
240     public function resolve_static_continue_url($remoteurl) {
241         static $sessions = array();
242         // if this is called mutliple times for the same host, stuff breaks
243         // so we have to keep track and just replace the wantsurl bit
244         // in case things go to different plugins or whatever
245         if (array_key_exists($this->get_config('mnethostid'), $sessions)) {
246             return preg_replace('/wantsurl=[^&]*&/', 'wantsurl=' . urlencode($remoteurl) . '&', $sessions[$this->get_config('mnethostid')]);
247         }
248         $this->ensure_mnethost();
249         $mnetauth = get_auth_plugin('mnet');
250         if (!$url = $mnetauth->start_jump_session($this->get_config('mnethostid'), $remoteurl)) {
251             return false;
252         }
253         $sessions[$this->get_config('mnethostid')] = $url;
254         return $url;
255     }
257     public function get_interactive_continue_url() {
258         return $this->resolve_static_continue_url($this->get_static_continue_url());
259     }
261     public function steal_control($stage) {
262         if ($stage != PORTFOLIO_STAGE_CONFIG) {
263             return false;
264         }
265         global $CFG;
266         return $CFG->wwwroot . '/portfolio/mahara/preconfig.php?id=' . $this->exporter->get('id');
267     }
269     public function verify_file_request_params($params) {
270         return false;
271         // the data comes from an xmlrpc request,
272         // not a request to file.php
273     }
275     /**
276     * sends the 'content_intent' ping to mahara
277     * if all goes well, this will set the 'token' and 'sendtype' member variables.
278     */
279     public function send_intent() {
280         global $CFG, $DB;
281         require_once($CFG->dirroot . '/mnet/xmlrpc/client.php');
282         $client = new mnet_xmlrpc_client();
283         $client->set_method('portfolio/mahara/lib.php/send_content_intent');
284         $client->add_param($this->get('user')->username);
285         $this->ensure_mnethost();
286         if (!$client->send($this->mnethost)) {
287             foreach ($client->error as $errormessage) {
288                 list($code, $message) = array_map('trim',explode(':', $errormessage, 2));
289                 $message .= "ERROR $code:<br/>$errormessage<br/>";
290             }
291             throw new portfolio_export_exception($this->get('exporter'), 'failedtoping', 'portfolio_mahara', '', $message);
292         }
293         // we should get back... the send type and a shared token
294         $response = (object)$client->response;
295         if (empty($response->sendtype) || empty($response->token)) {
296             throw new portfolio_export_exception($this->get('exporter'), 'senddisallowed', 'portfolio_mahara');
297         }
298         switch ($response->sendtype) {
299             case 'immediate':
300                 $this->sendtype = PORTFOLIO_MAHARA_IMMEDIATE;
301                 break;
302             case 'queue':
303                 $this->sendtype = PORTFOLIO_MAHARA_QUEUE;
304                 break;
305             case 'none':
306             default:
307                 throw new portfolio_export_exception($this->get('exporter'), 'senddisallowed', 'portfolio_mahara');
308         }
309         $this->token = $response->token;
310         $this->get('exporter')->save();
311         // put the entry in the mahara queue table now too
312         $q = new stdClass;
313         $q->token = $this->token;
314         $q->transferid = $this->get('exporter')->get('id');
315         $DB->insert_record('portfolio_mahara_queue', $q);
316     }
318     private function ensure_mnethost() {
319         if (!empty($this->hostrecord) && !empty($this->mnethost)) {
320             return;
321         }
322         global $DB;
323         if (!$this->hostrecord = $DB->get_record('mnet_host', array('id' => $this->get_config('mnethostid')))) {
324             throw new portfolio_plugin_exception(PORTFOLIO_MAHARA_ERR_INVALIDHOST, 'portfolio_mahara');
325         }
326         $this->mnethost = new mnet_peer();
327         $this->mnethost->set_wwwroot($this->hostrecord->wwwroot);
328     }
330     /**
331     * xmlrpc (mnet) function to get the file.
332     * reads in the file and returns it base_64 encoded
333     * so that it can be enrypted by mnet.
334     *
335     * @param string $token the token recieved previously during send_content_intent
336     */
337     public static function fetch_file($token) {
338         global $DB;
339         $remoteclient = get_mnet_remote_client();
340         try {
341             if (!$transferid = $DB->get_field('portfolio_mahara_queue', 'transferid', array('token' => $token))) {
342                 throw new mnet_server_exception(8009, get_string('mnet_notoken', 'portfolio_mahara'));
343             }
344             $exporter = portfolio_exporter::rewaken_object($transferid);
345         } catch (portfolio_exception $e) {
346             throw new mnet_server_exception(8010, get_string('mnet_noid', 'portfolio_mahara'));
347         }
348         if ($exporter->get('instance')->get_config('mnethostid') != $remoteclient->id) {
349             throw new mnet_server_exception(8011, get_string('mnet_wronghost', 'portfolio_mahara'));
350         }
351         global $CFG;
352         try {
353             $i = $exporter->get('instance');
354             $f = $i->get('file');
355             if (empty($f) || !($f instanceof stored_file)) {
356                 throw new mnet_server_exception(8012, get_string('mnet_nofile', 'portfolio_mahara'));
357             }
358             try {
359                 $c = $f->get_content();
360             } catch (file_exception $e) {
361                 throw new mnet_server_exception(8013, get_string('mnet_nofilecontents', 'portfolio_mahara', $e->getMessage()));
362             }
363             $contents = base64_encode($c);
364         } catch (Exception $e) {
365             throw new mnet_server_exception(8013, get_string('mnet_nofile', 'portfolio_mahara'));
366         }
367         $exporter->log_transfer();
368         $exporter->process_stage_cleanup(true);
369         return $contents;
370     }
372     public function cleanup() {
373         global $DB;
374         $DB->delete_records('portfolio_mahara_queue', array('transferid' => $this->get('exporter')->get('id'), 'token' => $this->token));
375     }
378     /**
379      * internal helper function, that converts between the format constant,
380      * which might be too specific (eg 'image') and the class in our *supported* list
381      * which might be higher up the format hierarchy tree (eg 'file')
382      */
383     private function resolve_format() {
384         global $CFG;
385         $thisformat = $this->get_export_config('format');
386         $allformats = portfolio_supported_formats();
387         require_once($CFG->libdir . '/portfolio/formats.php');
388         $thisobj = new $allformats[$thisformat];
389         foreach ($this->supported_formats() as $f) {
390             $class = $allformats[$f];
391             if ($thisobj instanceof $class) {
392                 return $f;
393             }
394         }
395     }