MDL-15666 - change all the portfolio plugins and callers to use exceptions
[moodle.git] / portfolio / type / mahara / lib.php
CommitLineData
254f2d05 1<?php
2
3define('PORTFOLIO_MAHARA_ERR_NETWORKING_OFF', 'err_networkingoff');
4define('PORTFOLIO_MAHARA_ERR_NOHOSTS', 'err_nomnethosts');
aae8cfdc 5define('PORTFOLIO_MAHARA_ERR_INVALIDHOST', 'err_invalidhost');
7254f56e 6define('PORTFOLIO_MAHARA_ERR_NOMNETAUTH', 'err_nomnetauth');
254f2d05 7
8require_once($CFG->dirroot . '/lib/portfoliolib.php');
9require_once($CFG->dirroot . '/mnet/lib.php');
10
11define('PORTFOLIO_MAHARA_QUEUE', PORTFOLIO_TIME_HIGH);
12define('PORTFOLIO_MAHARA_IMMEDIATE', PORTFOLIO_TIME_MODERATE);
13
14class portfolio_plugin_mahara extends portfolio_plugin_pull_base {
15
16 private $hosts; // used in the admin config form
17 private $mnethost; // privately set during export from the admin config value (mnethostid)
18 private $hostrecord; // the host record that corresponds to the peer
19 private $token; // during-transfer token
20 private $sendtype; // whatever mahara has said it can handle (immediate or queued)
21 private $filesmanifest; // manifest of files to send to mahara (set during prepare_package and sent later)
2f6bd2a9 22 private $totalsize; // total size of all included files added together
254f2d05 23
0f71f48b 24 public static function get_name() {
25 return get_string('pluginname', 'portfolio_mahara');
26 }
27
254f2d05 28 public static function get_allowed_config() {
29 return array('mnethostid');
30 }
31
32 public static function supported_formats() {
33 return array(PORTFOLIO_FORMAT_FILE);
34 }
35
36 public function expected_time($callertime) {
37 if ($this->sendtype == PORTFOLIO_MAHARA_QUEUE) {
38 return PORTFOLIO_TIME_FORCEQUEUE;
39 }
40 return $callertime;
41 }
42
43 public static function has_admin_config() {
44 return true;
45 }
46
47 public function admin_config_form(&$mform) {
254f2d05 48 $strrequired = get_string('required');
49 $hosts = self::get_mnet_hosts(); // this is called by sanity check but it's ok because it's cached
50 foreach ($hosts as $host) {
51 $hosts[$host->id] = $host->name;
52 }
53 $mform->addElement('select', 'mnethostid', get_string('mnethost', 'portfolio_mahara'), $hosts);
54 $mform->addRule('mnethostid', $strrequired, 'required', null, 'client');
55 }
56
aae8cfdc 57 public function instance_sanity_check() {
58 // make sure the host record exists since we don't have referential integrity
b0482154 59 if (!is_enabled_auth('mnet')) {
60 return PORTFOLIO_MAHARA_ERR_NOMNETAUTH;
61 }
aae8cfdc 62 try {
63 $this->ensure_mnethost();
64 }
65 catch (portfolio_exception $e) {
66 return PORTFOLIO_MAHARA_ERR_INVALIDHOST;
67 }
68 // make sure we have the right services
69 $hosts = $this->get_mnet_hosts();
70 if (!array_key_exists($this->get_config('mnethostid'), $hosts)) {
71 return PORTFOLIO_MAHARA_ERR_INVALIDHOST;
72 }
73 return 0;
74 }
254f2d05 75
76 public static function plugin_sanity_check() {
254f2d05 77 global $CFG, $DB;
78 $errorcode = 0;
79 if (!isset($CFG->mnet_dispatcher_mode) || $CFG->mnet_dispatcher_mode != 'strict') {
80 $errorcode = PORTFOLIO_MAHARA_ERR_NETWORKING_OFF;
81 }
7254f56e 82 if (!is_enabled_auth('mnet')) {
83 $errorcode = PORTFOLIO_MAHARA_ERR_NOMNETAUTH;
84 }
254f2d05 85 if (!self::get_mnet_hosts()) {
86 $errorcode = PORTFOLIO_MAHARA_ERR_NOHOSTS;
87 }
254f2d05 88 return $errorcode;
89 }
90
91 private static function get_mnet_hosts() {
92 global $DB, $CFG;
93 static $hosts;
94 if (isset($this) && is_object($this) && isset($this->hosts)) {
95 return $this->hosts;
96 } else if (!isset($this) && isset($hosts)) {
97 return $hosts;
98 }
99 $hosts = $DB->get_records_sql(' SELECT
100 h.id,
101 h.wwwroot,
102 h.ip_address,
103 h.name,
104 h.public_key,
105 h.public_key_expires,
106 h.transport,
107 h.portno,
108 h.last_connect_time,
109 h.last_log_id,
110 h.applicationid,
111 a.name as app_name,
112 a.display_name as app_display_name,
113 a.xmlrpc_server_url
114 FROM {mnet_host} h
115 JOIN {mnet_application} a ON h.applicationid=a.id
116 JOIN {mnet_host2service} hs1 ON hs1.hostid = h.id
117 JOIN {mnet_service} s1 ON hs1.serviceid = s1.id
118 JOIN {mnet_host2service} hs2 ON hs2.hostid = h.id
119 JOIN {mnet_service} s2 ON hs2.serviceid = s2.id
120 JOIN {mnet_host2service} hs3 ON hs3.hostid = h.id
121 JOIN {mnet_service} s3 ON hs3.serviceid = s3.id
122 WHERE
123 h.id <> ? AND
124 h.deleted = 0 AND
125 a.name = ? AND
126 s1.name = ? AND hs1.publish = ? AND
127 s2.name = ? AND hs2.subscribe = ? AND
128 s3.name = ? AND hs3.subscribe = ?',
129 array($CFG->mnet_localhost_id, 'mahara', 'sso_idp', 1, 'sso_sp', 1, 'pf', 1));;
130 if (empty($hosts)) { $hosts = array(); }
131 if (isset($this) && is_object($this)) {
132 $this->hosts = $hosts;
133 }
134 return $hosts;
135 }
136
137 public function prepare_package() {
138 $files = $this->exporter->get_tempfiles();
2f6bd2a9 139 $this->totalsize = 0;
254f2d05 140 foreach ($files as $f) {
141 $this->filesmanifest[$f->get_contenthash()] = array(
142 'filename' => $f->get_filename(),
143 'sha1' => $f->get_contenthash(),
2f6bd2a9 144 'size' => $f->get_filesize(),
254f2d05 145 );
2f6bd2a9 146 $this->totalsize += $f->get_filesize();
254f2d05 147 }
254f2d05 148
37f03ea0 149 $this->set('file', $this->exporter->zip_tempfiles()); // this will throw a file_exception which the exporter catches separately.
254f2d05 150 }
151
aed2937f 152 private function ensure_environment() {
254f2d05 153 global $MNET;
154 if (empty($MNET)) {
155 $MNET = new mnet_environment();
156 $MNET->init();
157 } // no idea why this happens :(
aed2937f 158 }
159
160 public function send_package() {
161 global $CFG;
162 $this->ensure_environment();
254f2d05 163 // send the 'content_ready' request to mahara
164 require_once($CFG->dirroot . '/mnet/xmlrpc/client.php');
165 $client = new mnet_xmlrpc_client();
166 $client->set_method('portfolio/mahara/lib.php/send_content_ready');
167 $client->add_param($this->token);
168 $client->add_param($this->get('user')->username);
169 $client->add_param($this->resolve_format());
1c597211 170 $client->add_param(array(
171 'filesmanifest' => $this->filesmanifest,
2f6bd2a9 172 'zipfilesha1' => $this->get('file')->get_contenthash(),
173 'zipfilesize' => $this->get('file')->get_filesize(),
174 'totalsize' => $this->totalsize,
1c597211 175 ));
254f2d05 176 $client->add_param($this->get_export_config('wait'));
177 $this->ensure_mnethost();
178 if (!$client->send($this->mnethost)) {
179 foreach ($client->error as $errormessage) {
180 list($code, $message) = array_map('trim',explode(':', $errormessage, 2));
181 $message .= "ERROR $code:<br/>$errormessage<br/>";
182 }
183 throw new portfolio_export_exception($this->get('exporter'), 'failedtoping', 'portfolio_mahara', '', $message);
184 }
185 // we should get back... an ok and a status
186 // either we've been waiting a while and mahara has fetched the file or has queued it.
187 $response = (object)$client->response;
188 if (!$response->status) {
189 throw new portfolio_export_exception($this->get('exporter'), 'failedtoping', 'portfolio_mahara');
190 }
37f03ea0 191 if ($response->type =='queued') {
192 $this->exporter->set('forcequeue', true);
193 }
254f2d05 194 }
195
196 public function get_continue_url() {
197 $this->ensure_mnethost();
aed2937f 198 $this->ensure_environment();
199 $mnetauth = get_auth_plugin('mnet');
200 $remoteurl = '/artefact/file/';// @todo penny this might change later when we change formats.
201 if (!$url = $mnetauth->start_jump_session($this->get_config('mnethostid'), $remoteurl)) {
202 return false;
203 }
204 return $url;
254f2d05 205 }
206
207 public function steal_control($stage) {
208 if ($stage != PORTFOLIO_STAGE_CONFIG) {
209 return false;
210 }
211 global $CFG;
212 return $CFG->wwwroot . '/portfolio/type/mahara/preconfig.php?id=' . $this->exporter->get('id');
213 }
214
215 public function verify_file_request_params($params) {
216 return false;
217 // the data comes from an xmlrpc request,
218 // not a request to file.php
219 }
220
221 /**
222 * sends the 'content_intent' ping to mahara
223 * if all goes well, this will set the 'token' and 'sendtype' member variables.
224 */
225 public function send_intent() {
226 global $CFG, $DB;
227 require_once($CFG->dirroot . '/mnet/xmlrpc/client.php');
228 $client = new mnet_xmlrpc_client();
229 $client->set_method('portfolio/mahara/lib.php/send_content_intent');
230 $client->add_param($this->get('user')->username);
231 $this->ensure_mnethost();
232 if (!$client->send($this->mnethost)) {
233 foreach ($client->error as $errormessage) {
234 list($code, $message) = array_map('trim',explode(':', $errormessage, 2));
235 $message .= "ERROR $code:<br/>$errormessage<br/>";
236 }
237 throw new portfolio_export_exception($this->get('exporter'), 'failedtoping', 'portfolio_mahara', '', $message);
238 }
239 // we should get back... the send type and a shared token
240 $response = (object)$client->response;
241 if (empty($response->sendtype) || empty($response->token)) {
242 throw new portfolio_export_exception($this->get('exporter'), 'senddisallowed', 'portfolio_mahara');
243 }
244 switch ($response->sendtype) {
245 case 'immediate':
246 $this->sendtype = PORTFOLIO_MAHARA_IMMEDIATE;
247 break;
248 case 'queue':
249 $this->sendtype = PORTFOLIO_MAHARA_QUEUE;
250 break;
251 case 'none':
252 default:
253 throw new portfolio_export_exception($this->get('exporter'), 'senddisallowed', 'portfolio_mahara');
254 }
255 $this->token = $response->token;
256 $this->get('exporter')->save();
257 // put the entry in the mahara queue table now too
258 $q = new stdClass;
259 $q->token = $this->token;
260 $q->transferid = $this->get('exporter')->get('id');
261 $DB->insert_record('portfolio_mahara_queue', $q);
262 }
263
264 private function ensure_mnethost() {
265 if (!empty($this->hostrecord) && !empty($this->mnethost)) {
266 return;
267 }
268 global $DB;
aae8cfdc 269 if (!$this->hostrecord = $DB->get_record('mnet_host', array('id' => $this->get_config('mnethostid')))) {
270 throw new portfolio_plugin_exception(PORTFOLIO_MAHARA_ERR_INVALIDHOST, 'portfolio_mahara');
271 }
254f2d05 272 $this->mnethost = new mnet_peer();
273 $this->mnethost->set_wwwroot($this->hostrecord->wwwroot);
274 }
275
276 public static function mnet_publishes() {
277 $pf= array();
278 $pf['name'] = 'pf'; // Name & Description go in lang file
279 $pf['apiversion'] = 1;
280 $pf['methods'] = array('send_content_intent', 'send_content_ready', 'fetch_file');
281
282 return array($pf);
283 }
284
285 /**
286 * xmlrpc (mnet) function to get the file.
287 * reads in the file and returns it base_64 encoded
288 * so that it can be enrypted by mnet.
289 *
290 * @param string $token the token recieved previously during send_content_intent
291 */
292 public static function fetch_file($token) {
293 global $DB, $MNET_REMOTE_CLIENT;;
294 try {
aed2937f 295 if (!$transferid = $DB->get_field('portfolio_mahara_queue', 'transferid', array('token' => $token))) {
2f6bd2a9 296 exit(mnet_server_fault(8009, get_string('mnet_notoken', 'portfolio_mahara')));
aed2937f 297 }
254f2d05 298 $exporter = portfolio_exporter::rewaken_object($transferid);
299 } catch (portfolio_exception $e) {
2f6bd2a9 300 exit(mnet_server_fault(8010, get_string('mnet_noid', 'portfolio_mahara')));
254f2d05 301 }
302 if ($exporter->get('instance')->get_config('mnethostid') != $MNET_REMOTE_CLIENT->id) {
2f6bd2a9 303 exit(mnet_server_fault(8011, get_string('mnet_wronghost', 'portfolio_mahara')));
254f2d05 304 }
305 global $CFG;
d5dfe1b3 306 try {
307 $i = $exporter->get('instance');
308 $f = $i->get('file');
432ad8bf 309 if (empty($f) || !($f instanceof stored_file)) {
2f6bd2a9 310 exit(mnet_server_fault(8012, get_string('mnet_nofile', 'portfolio_mahara')));
d5dfe1b3 311 }
432ad8bf 312 try {
313 $c = $f->get_content();
314 } catch (file_exception $e) {
2f6bd2a9 315 exit(mnet_server_fault(8013, get_string('mnet_nofilecontents', 'portfolio_mahara', $e->getMessage())));
432ad8bf 316 }
d5dfe1b3 317 $contents = base64_encode($c);
318 } catch (Exception $e) {
2f6bd2a9 319 exit(mnet_server_fault(8013, get_string('mnet_nofile', 'portfolio_mahara')));
d5dfe1b3 320 }
254f2d05 321 $exporter->process_stage_cleanup(true);
322 return $contents;
323 }
324
325 public function cleanup() {
326 global $DB;
327 $DB->delete_records('portfolio_mahara_queue', array('transferid' => $this->get('exporter')->get('id'), 'token' => $this->token));
328 }
329
330
331 private function resolve_format() {
332 $thisformat = $this->get_export_config('format');
333 $allformats = portfolio_supported_formats();
334 $thisobj = new $allformats[$thisformat];
335 foreach ($this->supported_formats() as $f) {
336 $class = $allformats[$f];
337 if ($thisobj instanceof $class) {
338 return $f;
339 }
340 }
341 }
254f2d05 342}
343
344?>