portfolio MDL-22264 add leap2a option for the mahara plugin
[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', 'enableleap2a');
67     }
69     public function supported_formats() {
70         if ($this->get_config('enableleap2a')) {
71             return array(PORTFOLIO_FORMAT_FILE, PORTFOLIO_FORMAT_LEAP2A);
72         }
73         return array(PORTFOLIO_FORMAT_FILE);
74     }
76     public function expected_time($callertime) {
77         if ($this->sendtype == PORTFOLIO_MAHARA_QUEUE) {
78             return PORTFOLIO_TIME_FORCEQUEUE;
79         }
80         return $callertime;
81     }
83     public static function has_admin_config() {
84         return true;
85     }
87     public function admin_config_form(&$mform) {
88         $strrequired = get_string('required');
89         $hosts = self::get_mnet_hosts(); // this is called by sanity check but it's ok because it's cached
90         foreach ($hosts as $host) {
91             $hosts[$host->id] = $host->name;
92         }
93         $mform->addElement('select', 'mnethostid', get_string('mnethost', 'portfolio_mahara'), $hosts);
94         $mform->addRule('mnethostid', $strrequired, 'required', null, 'client');
95         $mform->addElement('selectyesno', 'enableleap2a', get_string('enableleap2a', 'portfolio_mahara'));
96     }
98     public function instance_sanity_check() {
99         // make sure the host record exists since we don't have referential integrity
100         if (!is_enabled_auth('mnet')) {
101             return PORTFOLIO_MAHARA_ERR_NOMNETAUTH;
102         }
103         try {
104             $this->ensure_mnethost();
105         }
106         catch (portfolio_exception $e) {
107             return PORTFOLIO_MAHARA_ERR_INVALIDHOST;
108         }
109         // make sure we have the right services
110         $hosts = $this->get_mnet_hosts();
111         if (!array_key_exists($this->get_config('mnethostid'), $hosts)) {
112             return PORTFOLIO_MAHARA_ERR_INVALIDHOST;
113         }
114         return 0;
115     }
117     public static function plugin_sanity_check() {
118         global $CFG, $DB;
119         $errorcode = 0;
120         if (!isset($CFG->mnet_dispatcher_mode) || $CFG->mnet_dispatcher_mode != 'strict') {
121             $errorcode =  PORTFOLIO_MAHARA_ERR_NETWORKING_OFF;
122         }
123         if (!is_enabled_auth('mnet')) {
124             $errorcode = PORTFOLIO_MAHARA_ERR_NOMNETAUTH;
125         }
126         if (!self::get_mnet_hosts()) {
127             $errorcode =  PORTFOLIO_MAHARA_ERR_NOHOSTS;
128         }
129         return $errorcode;
130     }
132     private static function get_mnet_hosts() {
133         global $DB, $CFG;
134         static $hosts;
135         if (isset($this) && is_object($this) && isset($this->hosts)) {
136             return $this->hosts;
137         } else if (!isset($this) && isset($hosts)) {
138             return $hosts;
139         }
140         $hosts = $DB->get_records_sql('  SELECT
141                                     h.id,
142                                     h.wwwroot,
143                                     h.ip_address,
144                                     h.name,
145                                     h.public_key,
146                                     h.public_key_expires,
147                                     h.transport,
148                                     h.portno,
149                                     h.last_connect_time,
150                                     h.last_log_id,
151                                     h.applicationid,
152                                     a.name as app_name,
153                                     a.display_name as app_display_name,
154                                     a.xmlrpc_server_url
155                                 FROM {mnet_host} h
156                                     JOIN {mnet_application} a ON h.applicationid=a.id
157                                     JOIN {mnet_host2service} hs1 ON hs1.hostid = h.id
158                                     JOIN {mnet_service} s1 ON hs1.serviceid = s1.id
159                                     JOIN {mnet_host2service} hs2 ON hs2.hostid = h.id
160                                     JOIN {mnet_service} s2 ON hs2.serviceid = s2.id
161                                     JOIN {mnet_host2service} hs3 ON hs3.hostid = h.id
162                                     JOIN {mnet_service} s3 ON hs3.serviceid = s3.id
163                                 WHERE
164                                     h.id <> ? AND
165                                     h.deleted = 0 AND
166                                     a.name = ? AND
167                                     s1.name = ? AND hs1.publish = ? AND
168                                     s2.name = ? AND hs2.subscribe = ? AND
169                                     s3.name = ? AND hs3.subscribe = ? AND
170                                     s3.name = ? AND hs3.publish = ?',
171                         array($CFG->mnet_localhost_id, 'mahara', 'sso_idp', 1, 'sso_sp', 1, 'pf', 1, 'pf', 1));
172         if (empty($hosts)) { $hosts = array(); }
173         if (isset($this) && is_object($this)) {
174             $this->hosts = $hosts;
175         }
176         return $hosts;
177     }
179     public function prepare_package() {
180         $files = $this->exporter->get_tempfiles();
181         $this->totalsize = 0;
182         foreach ($files as $f) {
183             $this->filesmanifest[$f->get_contenthash()] = array(
184                 'filename' => $f->get_filename(),
185                 'sha1'     => $f->get_contenthash(),
186                 'size'     => $f->get_filesize(),
187             );
188             $this->totalsize += $f->get_filesize();
189         }
191         $this->set('file', $this->exporter->zip_tempfiles());  // this will throw a file_exception which the exporter catches separately.
192     }
194     public function send_package() {
195         global $CFG;
196         // send the 'content_ready' request to mahara
197         require_once($CFG->dirroot . '/mnet/xmlrpc/client.php');
198         $client = new mnet_xmlrpc_client();
199         $client->set_method('portfolio/mahara/lib.php/send_content_ready');
200         $client->add_param($this->token);
201         $client->add_param($this->get('user')->username);
202         $client->add_param($this->resolve_format());
203         $client->add_param(array(
204             'filesmanifest' => $this->filesmanifest,
205             'zipfilesha1'   => $this->get('file')->get_contenthash(),
206             'zipfilesize'   => $this->get('file')->get_filesize(),
207             'totalsize'     => $this->totalsize,
208         ));
209         $client->add_param($this->get_export_config('wait'));
210         $this->ensure_mnethost();
211         if (!$client->send($this->mnethost)) {
212             foreach ($client->error as $errormessage) {
213                 list($code, $message) = array_map('trim',explode(':', $errormessage, 2));
214                 $message .= "ERROR $code:<br/>$errormessage<br/>";
215             }
216             throw new portfolio_export_exception($this->get('exporter'), 'failedtoping', 'portfolio_mahara', '', $message);
217         }
218         // we should get back...  an ok and a status
219         // either we've been waiting a while and mahara has fetched the file or has queued it.
220         $response = (object)$client->response;
221         if (!$response->status) {
222             throw new portfolio_export_exception($this->get('exporter'), 'failedtoping', 'portfolio_mahara');
223         }
224         if ($response->type =='queued') {
225             $this->exporter->set_forcequeue();
226         }
227         if (isset($response->querystring)) {
228             $this->continueurl = $response->querystring;
229         }
230         // if we're not queuing the logging might have already happened
231         $this->exporter->update_log_url($this->get_static_continue_url());
232     }
234     public function get_static_continue_url() {
235         $remoteurl = '';
236         if ($this->resolve_format() == 'file') {
237             $remoteurl = '/artefact/file/'; // we hopefully get the files that were imported highlighted
238         }
239         if (isset($this->continueurl)) {
240             $remoteurl .= $this->continueurl;
241         }
242         return $remoteurl;
243     }
245     public function resolve_static_continue_url($remoteurl) {
246         global $CFG;
247         $this->ensure_mnethost();
248         $u = new moodle_url('/auth/mnet/jump.php', array('hostid' => $this->get_config('mnethostid'), 'wantsurl' => $remoteurl));
249         return $u->out();
250     }
252     public function get_interactive_continue_url() {
253         return $this->resolve_static_continue_url($this->get_static_continue_url());
254     }
256     public function steal_control($stage) {
257         if ($stage != PORTFOLIO_STAGE_CONFIG) {
258             return false;
259         }
260         global $CFG;
261         return $CFG->wwwroot . '/portfolio/mahara/preconfig.php?id=' . $this->exporter->get('id');
262     }
264     public function verify_file_request_params($params) {
265         return false;
266         // the data comes from an xmlrpc request,
267         // not a request to file.php
268     }
270     /**
271     * sends the 'content_intent' ping to mahara
272     * if all goes well, this will set the 'token' and 'sendtype' member variables.
273     */
274     public function send_intent() {
275         global $CFG, $DB;
276         require_once($CFG->dirroot . '/mnet/xmlrpc/client.php');
277         $client = new mnet_xmlrpc_client();
278         $client->set_method('portfolio/mahara/lib.php/send_content_intent');
279         $client->add_param($this->get('user')->username);
280         $this->ensure_mnethost();
281         if (!$client->send($this->mnethost)) {
282             foreach ($client->error as $errormessage) {
283                 list($code, $message) = array_map('trim',explode(':', $errormessage, 2));
284                 $message .= "ERROR $code:<br/>$errormessage<br/>";
285             }
286             throw new portfolio_export_exception($this->get('exporter'), 'failedtoping', 'portfolio_mahara', '', $message);
287         }
288         // we should get back... the send type and a shared token
289         $response = (object)$client->response;
290         if (empty($response->sendtype) || empty($response->token)) {
291             throw new portfolio_export_exception($this->get('exporter'), 'senddisallowed', 'portfolio_mahara');
292         }
293         switch ($response->sendtype) {
294             case 'immediate':
295                 $this->sendtype = PORTFOLIO_MAHARA_IMMEDIATE;
296                 break;
297             case 'queue':
298                 $this->sendtype = PORTFOLIO_MAHARA_QUEUE;
299                 break;
300             case 'none':
301             default:
302                 throw new portfolio_export_exception($this->get('exporter'), 'senddisallowed', 'portfolio_mahara');
303         }
304         $this->token = $response->token;
305         $this->get('exporter')->save();
306         // put the entry in the mahara queue table now too
307         $q = new stdClass;
308         $q->token = $this->token;
309         $q->transferid = $this->get('exporter')->get('id');
310         $DB->insert_record('portfolio_mahara_queue', $q);
311     }
313     private function ensure_mnethost() {
314         if (!empty($this->hostrecord) && !empty($this->mnethost)) {
315             return;
316         }
317         global $DB;
318         if (!$this->hostrecord = $DB->get_record('mnet_host', array('id' => $this->get_config('mnethostid')))) {
319             throw new portfolio_plugin_exception(PORTFOLIO_MAHARA_ERR_INVALIDHOST, 'portfolio_mahara');
320         }
321         $this->mnethost = new mnet_peer();
322         $this->mnethost->set_wwwroot($this->hostrecord->wwwroot);
323     }
325     /**
326     * xmlrpc (mnet) function to get the file.
327     * reads in the file and returns it base_64 encoded
328     * so that it can be enrypted by mnet.
329     *
330     * @param string $token the token recieved previously during send_content_intent
331     */
332     public static function fetch_file($token) {
333         global $DB;
334         $remoteclient = get_mnet_remote_client();
335         try {
336             if (!$transferid = $DB->get_field('portfolio_mahara_queue', 'transferid', array('token' => $token))) {
337                 throw new mnet_server_exception(8009, get_string('mnet_notoken', 'portfolio_mahara'));
338             }
339             $exporter = portfolio_exporter::rewaken_object($transferid);
340         } catch (portfolio_exception $e) {
341             throw new mnet_server_exception(8010, get_string('mnet_noid', 'portfolio_mahara'));
342         }
343         if ($exporter->get('instance')->get_config('mnethostid') != $remoteclient->id) {
344             throw new mnet_server_exception(8011, get_string('mnet_wronghost', 'portfolio_mahara'));
345         }
346         global $CFG;
347         try {
348             $i = $exporter->get('instance');
349             $f = $i->get('file');
350             if (empty($f) || !($f instanceof stored_file)) {
351                 throw new mnet_server_exception(8012, get_string('mnet_nofile', 'portfolio_mahara'));
352             }
353             try {
354                 $c = $f->get_content();
355             } catch (file_exception $e) {
356                 throw new mnet_server_exception(8013, get_string('mnet_nofilecontents', 'portfolio_mahara', $e->getMessage()));
357             }
358             $contents = base64_encode($c);
359         } catch (Exception $e) {
360             throw new mnet_server_exception(8013, get_string('mnet_nofile', 'portfolio_mahara'));
361         }
362         $exporter->log_transfer();
363         $exporter->process_stage_cleanup(true);
364         return $contents;
365     }
367     public function cleanup() {
368         global $DB;
369         $DB->delete_records('portfolio_mahara_queue', array('transferid' => $this->get('exporter')->get('id'), 'token' => $this->token));
370     }
373     /**
374      * internal helper function, that converts between the format constant,
375      * which might be too specific (eg 'image') and the class in our *supported* list
376      * which might be higher up the format hierarchy tree (eg 'file')
377      */
378     private function resolve_format() {
379         global $CFG;
380         $thisformat = $this->get_export_config('format');
381         $allformats = portfolio_supported_formats();
382         require_once($CFG->libdir . '/portfolio/formats.php');
383         $thisobj = new $allformats[$thisformat];
384         foreach ($this->supported_formats() as $f) {
385             $class = $allformats[$f];
386             if ($thisobj instanceof $class) {
387                 return $f;
388             }
389         }
390     }