fixed misspelled error tracing
[moodle.git] / lib / portfoliolib.php
CommitLineData
67a87e7d 1<?php
50fcb1d8 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
67a87e7d 18/**
87fcac8d 19 * This file contains all global functions to do with manipulating portfolios
20 * everything else that is logically namespaced by class is in its own file
21 * in lib/portfolio/ directory.
50fcb1d8 22 *
23 * Major Contributors
24 * - Penny Leach <penny@catalyst.net.nz>
25 *
78bfb562 26 * @package core
50fcb1d8 27 * @subpackage portfolio
28 * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
29 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
87fcac8d 30 */
31
78bfb562
PS
32defined('MOODLE_INTERNAL') || die();
33
24ba58ee
PL
34// require some of the sublibraries first.
35// this is not an exhaustive list, the others are pulled in as they're needed
36// so we don't have to always include everything unnecessarily for performance
37
38// very lightweight list of constants. always needed and no further dependencies
39require_once($CFG->libdir . '/portfolio/constants.php');
40// a couple of exception deinitions. always needed and no further dependencies
87fcac8d 41require_once($CFG->libdir . '/portfolio/exceptions.php'); // exception classes used by portfolio code
24ba58ee
PL
42// The base class for the caller classes. We always need this because we're either drawing a button,
43// in which case the button needs to know the calling class definition, which requires the base class,
44// or we're exporting, in which case we need the caller class anyway.
45require_once($CFG->libdir . '/portfolio/caller.php');
46
47// the other dependencies are included on demand:
48// libdir/portfolio/formats.php - the classes for the export formats
49// libdir/portfolio/forms.php - all portfolio form classes (requires formslib)
50// libdir/portfolio/plugin.php - the base class for the export plugins
51// libdir/portfolio/exporter.php - the exporter class
52
87fcac8d 53
54/**
50fcb1d8 55 * use this to add a portfolio button or icon or form to a page
56 *
57 * These class methods do not check permissions. the caller must check permissions first.
58 * Later, during the export process, the caller class is instantiated and the check_permissions method is called
887160c7 59 * If you are exporting a single file, you should always call set_format_by_file($file)
50fcb1d8 60 *
61 * This class can be used like this:
62 * <code>
63 * $button = new portfolio_add_button();
64 * $button->set_callback_options('name_of_caller_class', array('id' => 6), '/your/mod/lib.php');
65 * $button->render(PORTFOLIO_ADD_FULL_FORM, get_string('addeverythingtoportfolio', 'yourmodule'));
66 * </code>
67 *
68 * or like this:
69 * <code>
70 * $button = new portfolio_add_button(array('callbackclass' => 'name_of_caller_class', 'callbackargs' => array('id' => 6), 'callbackfile' => '/your/mod/lib.php'));
71 * $somehtml .= $button->to_html(PORTFOLIO_ADD_TEXT_LINK);
72 * </code>
73 *
74 * See {@link http://docs.moodle.org/en/Development:Adding_a_Portfolio_Button_to_a_page} for more information
75 *
76 * @package moodlecore
77 * @subpackage portfolio
78 * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
79 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
67a87e7d 80*/
ce09fecc 81class portfolio_add_button {
67a87e7d 82
ce09fecc 83 private $callbackclass;
84 private $callbackargs;
85 private $callbackfile;
86 private $formats;
87 private $instances;
887160c7 88 private $file; // for single-file exports
521a6ab0 89 private $intendedmimetype; // for writing specific types of files
67a87e7d 90
ce09fecc 91 /**
92 * constructor. either pass the options here or set them using the helper methods.
93 * generally the code will be clearer if you use the helper methods.
94 *
95 * @param array $options keyed array of options:
96 * key 'callbackclass': name of the caller class (eg forum_portfolio_caller')
97 * key 'callbackargs': the array of callback arguments your caller class wants passed to it in the constructor
98 * key 'callbackfile': the file containing the class definition of your caller class.
99 * See set_callback_options for more information on these three.
100 * key 'formats': an array of PORTFOLIO_FORMATS this caller will support
887160c7 101 * See set_formats or set_format_by_file for more information on this.
ce09fecc 102 */
103 public function __construct($options=null) {
11ae365c 104 global $SESSION, $CFG;
380a251f 105 $this->instances = portfolio_instances();
ce09fecc 106 if (empty($options)) {
107 return true;
108 }
c95a6095 109 $constructoroptions = array('callbackclass', 'callbackargs', 'callbackfile', 'formats');
ce09fecc 110 foreach ((array)$options as $key => $value) {
111 if (!in_array($key, $constructoroptions)) {
112 throw new portfolio_button_exception('invalidbuttonproperty', 'portfolio', $key);
113 }
114 $this->{$key} = $value;
115 }
a239f01e 116 }
117
ce09fecc 118 /*
119 * @param string $class name of the class containing the callback functions
120 * activity modules should ALWAYS use their name_portfolio_caller
121 * other locations must use something unique
122 * @param mixed $argarray this can be an array or hash of arguments to pass
123 * back to the callback functions (passed by reference)
124 * these MUST be primatives to be added as hidden form fields.
125 * and the values get cleaned to PARAM_ALPHAEXT or PARAM_NUMBER or PARAM_PATH
126 * @param string $file this can be autodetected if it's in the same file as your caller,
127 * but often, the caller is a script.php and the class in a lib.php
128 * so you can pass it here if necessary.
129 * this path should be relative (ie, not include) dirroot, eg '/mod/forum/lib.php'
130 */
131 public function set_callback_options($class, array $argarray, $file=null) {
132 global $CFG;
133 if (empty($file)) {
134 $backtrace = debug_backtrace();
135 if (!array_key_exists(0, $backtrace) || !array_key_exists('file', $backtrace[0]) || !is_readable($backtrace[0]['file'])) {
136 throw new portfolio_button_exception('nocallbackfile', 'portfolio');
137 }
138
139 $file = substr($backtrace[0]['file'], strlen($CFG->dirroot));
140 } else if (!is_readable($CFG->dirroot . $file)) {
9d429f0b 141 throw new portfolio_button_exception('nocallbackfile', 'portfolio', '', $file);
ce09fecc 142 }
143 $this->callbackfile = $file;
24ba58ee 144 require_once($CFG->libdir . '/portfolio/caller.php'); // require the base class first
ce09fecc 145 require_once($CFG->dirroot . $file);
146 if (!class_exists($class)) {
9d429f0b 147 throw new portfolio_button_exception('nocallbackclass', 'portfolio', '', $class);
ce09fecc 148 }
0d06b6fd 149
150 // this will throw exceptions
151 // but should not actually do anything other than verify callbackargs
152 $test = new $class($argarray);
153 unset($test);
154
ce09fecc 155 $this->callbackclass = $class;
156 $this->callbackargs = $argarray;
67a87e7d 157 }
158
ce09fecc 159 /*
9d7432f6 160 * sets the available export formats for this content
161 * this function will also poll the static function in the caller class
162 * and make sure we're not overriding a format that has nothing to do with mimetypes
59dd457e 163 * eg if you pass IMAGE here but the caller can export LEAP2A it will keep LEAP2A as well.
9d7432f6 164 * see portfolio_most_specific_formats for more information
165 *
59dd457e 166 * @param array $formats if the calling code knows better than the static method on the calling class (base_supported_formats)
ce09fecc 167 * eg, if it's going to be a single file, or if you know it's HTML, you can pass it here instead
168 * this is almost always the case so you should always use this.
521a6ab0
PL
169 * {@see portfolio_format_from_mimetype} for how to get the appropriate formats to pass here for uploaded files.
170 * or just call set_format_by_file instead
ce09fecc 171 */
172 public function set_formats($formats=null) {
173 if (is_string($formats)) {
174 $formats = array($formats);
175 }
176 if (empty($formats)) {
9d7432f6 177 $formats = array();
ce09fecc 178 }
9d7432f6 179 if (empty($this->callbackclass)) {
180 throw new portfolio_button_exception('noclassbeforeformats', 'portfolio');
d1581fc5 181 }
59dd457e 182 $callerformats = call_user_func(array($this->callbackclass, 'base_supported_formats'));
9d7432f6 183 $this->formats = portfolio_most_specific_formats($formats, $callerformats);
6fdd8fa7 184 }
185
521a6ab0
PL
186 /**
187 * reset formats to the default
188 * which is usually what base_supported_formats returns
189 */
59dd457e
PL
190 public function reset_formats() {
191 $this->set_formats();
192 }
193
194
887160c7
PL
195 /**
196 * if we already know we have exactly one file,
197 * bypass set_formats and just pass the file
198 * so we can detect the formats by mimetype.
199 *
59dd457e
PL
200 * @param stored_file $file file to set the format from
201 * @param mixed $extraformats any additional formats other than by mimetype
202 * eg leap2a etc
887160c7 203 */
59dd457e 204 public function set_format_by_file(stored_file $file, $extraformats=null) {
887160c7 205 $this->file = $file;
521a6ab0
PL
206 $fileformat = portfolio_format_from_mimetype($file->get_mimetype());
207 if (is_string($extraformats)) {
208 $extraformats = array($extraformats);
209 } else if (!is_array($extraformats)) {
210 $extraformats = array();
211 }
212 $this->set_formats(array_merge(array($fileformat), $extraformats));
213 }
214
215 /**
216 * correllary to set_format_by_file, but this is used when we don't yet have a stored_file
217 * when we're writing out a new type of file (like csv or pdf)
218 *
219 * @param string $extn the file extension we intend to generate
220 * @param mixed $extraformats any additional formats other than by mimetype
221 * eg leap2a etc
222 */
223 public function set_format_by_intended_file($extn, $extraformats=null) {
224 $mimetype = mimeinfo('type', 'something. ' . $extn);
225 $fileformat = portfolio_format_from_mimetype($mimetype);
226 $this->intendedmimetype = $fileformat;
59dd457e 227 if (is_string($extraformats)) {
521a6ab0
PL
228 $extraformats = array($extraformats);
229 } else if (!is_array($extraformats)) {
230 $extraformats = array();
59dd457e 231 }
521a6ab0 232 $this->set_formats(array_merge(array($fileformat), $extraformats));
887160c7
PL
233 }
234
ce09fecc 235 /*
236 * echo the form/button/icon/text link to the page
237 *
238 * @param int $format format to display the button or form or icon or link.
239 * See constants PORTFOLIO_ADD_XXX for more info.
240 * optional, defaults to PORTFOLI_ADD_FULL_FORM
241 * @param str $addstr string to use for the button or icon alt text or link text.
242 * this is whole string, not key. optional, defaults to 'Add to portfolio';
243 */
244 public function render($format=null, $addstr=null) {
380a251f 245 echo $this->to_html($format, $addstr);
84a44985 246 }
247
ce09fecc 248 /*
249 * returns the form/button/icon/text link as html
250 *
251 * @param int $format format to display the button or form or icon or link.
252 * See constants PORTFOLIO_ADD_XXX for more info.
253 * optional, defaults to PORTFOLI_ADD_FULL_FORM
254 * @param str $addstr string to use for the button or icon alt text or link text.
255 * this is whole string, not key. optional, defaults to 'Add to portfolio';
256 */
257 public function to_html($format=null, $addstr=null) {
add93b8f 258 global $CFG, $COURSE, $OUTPUT, $USER;
ce09fecc 259 if (!$this->is_renderable()) {
ed1fcf79 260 return;
261 }
380a251f 262 if (empty($this->callbackclass) || empty($this->callbackfile)) {
263 throw new portfolio_button_exception('mustsetcallbackoptions', 'portfolio');
ce09fecc 264 }
265 if (empty($this->formats)) {
266 // use the caller defaults
267 $this->set_formats();
268 }
521a6ab0 269 $url = new moodle_url('/portfolio/add.php');
ce09fecc 270 foreach ($this->callbackargs as $key => $value) {
271 if (!empty($value) && !is_string($value) && !is_numeric($value)) {
39f4aedf 272 $a = new object();
ce09fecc 273 $a->key = $key;
274 $a->value = print_r($value, true);
275 debugging(get_string('nonprimative', 'portfolio', $a));
276 return;
277 }
521a6ab0
PL
278 $url->param('ca_' . $key, $value);
279 }
280 $url->param('sesskey', sesskey());
281 $url->param('callbackfile', $this->callbackfile);
282 $url->param('callbackclass', $this->callbackclass);
283 $url->param('course', (!empty($COURSE)) ? $COURSE->id : 0);
284 $url->param('callerformats', implode(',', $this->formats));
285 $mimetype = null;
286 if ($this->file instanceof stored_file) {
287 $mimetype = $this->file->get_mimetype();
288 } else if ($this->intendedmimetype) {
289 $mimetype = $this->intendedmimetype;
290 }
ce09fecc 291 $selectoutput = '';
292 if (count($this->instances) == 1) {
6be1dcae 293 $tmp = array_values($this->instances);
294 $instance = $tmp[0];
c95a6095 295
ce09fecc 296 $formats = portfolio_supported_formats_intersect($this->formats, $instance->supported_formats());
297 if (count($formats) == 0) {
298 // bail. no common formats.
3cec7552 299 //debugging(get_string('nocommonformats', 'portfolio', (object)array('location' => $this->callbackclass, 'formats' => implode(',', $this->formats))));
ce09fecc 300 return;
301 }
302 if ($error = portfolio_instance_sanity_check($instance)) {
303 // bail, plugin is misconfigured
3cec7552 304 //debugging(get_string('instancemisconfigured', 'portfolio', get_string($error[$instance->get('id')], 'portfolio_' . $instance->get('plugin'))));
ce09fecc 305 return;
306 }
24ba58ee 307 if (!$instance->allows_multiple_exports() && $already = portfolio_existing_exports($USER->id, $instance->get('plugin'))) {
3cec7552 308 //debugging(get_string('singleinstancenomultiallowed', 'portfolio'));
c95a6095
PL
309 return;
310 }
521a6ab0
PL
311 if ($mimetype&& !$instance->file_mime_check($mimetype)) {
312 // bail, we have a specific file or mimetype and this plugin doesn't support it
3cec7552 313 //debugging(get_string('mimecheckfail', 'portfolio', (object)array('plugin' => $instance->get('plugin'), 'mimetype' => $mimetype)));
887160c7
PL
314 return;
315 }
521a6ab0 316 $url->param('instance', $instance->get('id'));
ce09fecc 317 }
318 else {
521a6ab0 319 if (!$selectoutput = portfolio_instance_select($this->instances, $this->formats, $this->callbackclass, $mimetype, 'instance', true)) {
3ec8d786
PL
320 return;
321 }
ed1fcf79 322 }
521a6ab0
PL
323 // if we just want a url to redirect to, do it now
324 if ($format == PORTFOLIO_ADD_FAKE_URL) {
b9bc2019 325 return $url->out(false);
521a6ab0 326 }
67a87e7d 327
ce09fecc 328 if (empty($addstr)) {
329 $addstr = get_string('addtoportfolio', 'portfolio');
330 }
331 if (empty($format)) {
332 $format = PORTFOLIO_ADD_FULL_FORM;
333 }
521a6ab0
PL
334
335 $formoutput = '<form method="post" action="' . $CFG->wwwroot . '/portfolio/add.php" id="portfolio-add-button">' . "\n";
6ea66ff3 336 $formoutput .= html_writer::input_hidden_params($url);
521a6ab0
PL
337 $linkoutput = '<a href="' . $url->out();
338
ce09fecc 339 switch ($format) {
340 case PORTFOLIO_ADD_FULL_FORM:
341 $formoutput .= $selectoutput;
342 $formoutput .= "\n" . '<input type="submit" value="' . $addstr .'" />';
343 $formoutput .= "\n" . '</form>';
344 break;
345 case PORTFOLIO_ADD_ICON_FORM:
346 $formoutput .= $selectoutput;
b5d0cafc 347 $formoutput .= "\n" . '<input type="image" src="' . $OUTPUT->pix_url('t/portfolio') . '" alt=' . $addstr .'" />';
ce09fecc 348 $formoutput .= "\n" . '</form>';
349 break;
350 case PORTFOLIO_ADD_ICON_LINK:
9c2b2875 351 $linkoutput .= '"><img src="' . $OUTPUT->pix_url('t/portfolio') . '" alt="' . $addstr .'" /></a>';
ce09fecc 352 break;
353 case PORTFOLIO_ADD_TEXT_LINK:
354 $linkoutput .= '">' . $addstr .'</a>';
355 break;
521a6ab0
PL
356 case PORTFOLIO_ADD_FAKE_URL:
357 return urldecode($linkoutput);
ce09fecc 358 default:
359 debugging(get_string('invalidaddformat', 'portfolio', $format));
360 }
361 $output = (in_array($format, array(PORTFOLIO_ADD_FULL_FORM, PORTFOLIO_ADD_ICON_FORM)) ? $formoutput : $linkoutput);
362 return $output;
349242a3 363 }
67a87e7d 364
ce09fecc 365 /**
366 * does some internal checks
367 * these are not errors, just situations
368 * where it's not appropriate to add the button
369 */
370 private function is_renderable() {
371 global $CFG;
372 if (empty($CFG->enableportfolios)) {
373 return false;
67a87e7d 374 }
ce09fecc 375 if (defined('PORTFOLIO_INTERNAL')) {
376 // something somewhere has detected a risk of this being called during inside the preparation
377 // eg forum_print_attachments
378 return false;
67a87e7d 379 }
380a251f 380 if (empty($this->instances) || count($this->instances) == 0) {
ce09fecc 381 return false;
67a87e7d 382 }
ce09fecc 383 return true;
67a87e7d 384 }
ef6f0f60 385
386 /**
387 * Getter for $format property
388 * @return array
389 */
390 public function get_formats() {
391 return $this->formats;
392 }
393
394 /**
395 * Getter for $callbackargs property
396 * @return array
397 */
398 public function get_callbackargs() {
399 return $this->callbackargs;
400 }
401
402 /**
403 * Getter for $callbackfile property
404 * @return array
405 */
406 public function get_callbackfile() {
407 return $this->callbackfile;
408 }
409
410 /**
411 * Getter for $callbackclass property
412 * @return array
413 */
414 public function get_callbackclass() {
415 return $this->callbackclass;
416 }
ce09fecc 417}
67a87e7d 418
67a87e7d 419/**
420* returns a drop menu with a list of available instances.
421*
887160c7
PL
422* @param array $instances array of portfolio plugin instance objects - the instances to put in the menu
423* @param array $callerformats array of PORTFOLIO_FORMAT_XXX constants - the formats the caller supports (this is used to filter plugins)
424* @param array $callbackclass the callback class name - used for debugging only for when there are no common formats
521a6ab0 425* @param mimetype $mimetype if we already know we have exactly one file, or are going to write one, pass it here to do mime filtering.
887160c7
PL
426* @param string $selectname the name of the select element. Optional, defaults to instance.
427* @param boolean $return whether to print or return the output. Optional, defaults to print.
428* @param booealn $returnarray if returning, whether to return the HTML or the array of options. Optional, defaults to HTML.
67a87e7d 429*
430* @return string the html, from <select> to </select> inclusive.
431*/
521a6ab0 432function portfolio_instance_select($instances, $callerformats, $callbackclass, $mimetype=null, $selectname='instance', $return=false, $returnarray=false) {
c95a6095 433 global $CFG, $USER;
9eb0a772 434
90658eef 435 if (empty($CFG->enableportfolios)) {
9eb0a772 436 return;
437 }
438
67a87e7d 439 $insane = portfolio_instance_sanity_check();
b816c08a 440 $pinsane = portfolio_plugin_sanity_check();
441
67a87e7d 442 $count = 0;
9eb0a772 443 $selectoutput = "\n" . '<select name="' . $selectname . '">' . "\n";
24ba58ee 444 $existingexports = portfolio_existing_exports_by_plugin($USER->id);
67a87e7d 445 foreach ($instances as $instance) {
349242a3 446 $formats = portfolio_supported_formats_intersect($callerformats, $instance->supported_formats());
447 if (count($formats) == 0) {
67a87e7d 448 // bail. no common formats.
449 continue;
450 }
451 if (array_key_exists($instance->get('id'), $insane)) {
452 // bail, plugin is misconfigured
3cec7552 453 //debugging(get_string('instanceismisconfigured', 'portfolio', get_string($insane[$instance->get('id')], 'portfolio_' . $instance->get('plugin'))));
b816c08a 454 continue;
455 } else if (array_key_exists($instance->get('plugin'), $pinsane)) {
456 // bail, plugin is misconfigured
3cec7552 457 //debugging(get_string('pluginismisconfigured', 'portfolio', get_string($pinsane[$instance->get('plugin')], 'portfolio_' . $instance->get('plugin'))));
67a87e7d 458 continue;
459 }
c95a6095
PL
460 if (!$instance->allows_multiple_exports() && in_array($instance->get('plugin'), $existingexports)) {
461 // bail, already exporting something with this plugin and it doesn't support multiple exports
462 continue;
463 }
521a6ab0 464 if ($mimetype && !$instance->file_mime_check($mimetype)) {
3cec7552 465 //debugging(get_string('mimecheckfail', 'portfolio', (object)array('plugin' => $instance->get('plugin'), 'mimetype' => $mimetype())));
887160c7
PL
466 // bail, we have a specific file and this plugin doesn't support it
467 continue;
468 }
67a87e7d 469 $count++;
9eb0a772 470 $selectoutput .= "\n" . '<option value="' . $instance->get('id') . '">' . $instance->get('name') . '</option>' . "\n";
471 $options[$instance->get('id')] = $instance->get('name');
67a87e7d 472 }
473 if (empty($count)) {
474 // bail. no common formats.
3cec7552 475 //debugging(get_string('nocommonformats', 'portfolio', (object)array('location' => $callbackclass, 'formats' => implode(',', $callerformats))));
67a87e7d 476 return;
477 }
478 $selectoutput .= "\n" . "</select>\n";
9eb0a772 479 if (!empty($returnarray)) {
480 return $options;
481 }
482 if (!empty($return)) {
483 return $selectoutput;
484 }
485 echo $selectoutput;
67a87e7d 486}
487
488/**
489* return all portfolio instances
490*
87fcac8d 491* @todo check capabilities here - see MDL-15768
492*
493* @param boolean visibleonly Don't include hidden instances. Defaults to true and will be overridden to true if the next parameter is true
494* @param boolean useronly Check the visibility preferences and permissions of the logged in user. Defaults to true.
495*
67a87e7d 496* @return array of portfolio instances (full objects, not just database records)
497*/
498function portfolio_instances($visibleonly=true, $useronly=true) {
499
500 global $DB, $USER;
501
502 $values = array();
503 $sql = 'SELECT * FROM {portfolio_instance}';
504
505 if ($visibleonly || $useronly) {
506 $values[] = 1;
507 $sql .= ' WHERE visible = ?';
508 }
509 if ($useronly) {
510 $sql .= ' AND id NOT IN (
511 SELECT instance FROM {portfolio_instance_user}
b11bbdd1 512 WHERE userid = ? AND name = ? AND ' . $DB->sql_compare_text('value') . ' = ?
67a87e7d 513 )';
514 $values = array_merge($values, array($USER->id, 'visible', 0));
515 }
516 $sql .= ' ORDER BY name';
517
518 $instances = array();
519 foreach ($DB->get_records_sql($sql, $values) as $instance) {
a50ef3d3 520 $instances[$instance->id] = portfolio_instance($instance->id, $instance);
67a87e7d 521 }
67a87e7d 522 return $instances;
523}
524
525/**
87fcac8d 526* Supported formats currently in use.
527*
528* Canonical place for a list of all formats
529* that portfolio plugins and callers
67a87e7d 530* can use for exporting content
531*
87fcac8d 532* @return keyed array of all the available export formats (constant => classname)
67a87e7d 533*/
534function portfolio_supported_formats() {
535 return array(
a9ec9031
DP
536 PORTFOLIO_FORMAT_FILE => 'portfolio_format_file',
537 PORTFOLIO_FORMAT_IMAGE => 'portfolio_format_image',
538 PORTFOLIO_FORMAT_RICHHTML => 'portfolio_format_richhtml',
539 PORTFOLIO_FORMAT_PLAINHTML => 'portfolio_format_plainhtml',
540 PORTFOLIO_FORMAT_TEXT => 'portfolio_format_text',
541 PORTFOLIO_FORMAT_VIDEO => 'portfolio_format_video',
542 PORTFOLIO_FORMAT_PDF => 'portfolio_format_pdf',
543 PORTFOLIO_FORMAT_DOCUMENT => 'portfolio_format_document',
544 PORTFOLIO_FORMAT_SPREADSHEET => 'portfolio_format_spreadsheet',
545 PORTFOLIO_FORMAT_PRESENTATION => 'portfolio_format_presentation',
5071079c 546 /*PORTFOLIO_FORMAT_MBKP, */ // later
59dd457e
PL
547 PORTFOLIO_FORMAT_LEAP2A => 'portfolio_format_leap2a',
548 PORTFOLIO_FORMAT_RICH => 'portfolio_format_rich',
67a87e7d 549 );
550}
551
ea0de12f 552/**
87fcac8d 553* Deduce export format from file mimetype
554*
555* This function returns the revelant portfolio export format
ea0de12f 556* which is used to determine which portfolio plugins can be used
557* for exporting this content
521a6ab0
PL
558* according to the given mime type
559* this only works when exporting exactly <b>one</b> file, or generating a new one
560* (like a pdf or csv export)
ea0de12f 561*
521a6ab0 562* @param string $mimetype (usually $file->get_mimetype())
87fcac8d 563*
ea0de12f 564* @return string the format constant (see PORTFOLIO_FORMAT_XXX constants)
565*/
521a6ab0 566function portfolio_format_from_mimetype($mimetype) {
24ba58ee 567 global $CFG;
ea0de12f 568 static $alreadymatched;
569 if (empty($alreadymatched)) {
570 $alreadymatched = array();
571 }
ea0de12f 572 if (array_key_exists($mimetype, $alreadymatched)) {
573 return $alreadymatched[$mimetype];
574 }
575 $allformats = portfolio_supported_formats();
24ba58ee 576 require_once($CFG->libdir . '/portfolio/formats.php');
ea0de12f 577 foreach ($allformats as $format => $classname) {
578 $supportedmimetypes = call_user_func(array($classname, 'mimetypes'));
579 if (!is_array($supportedmimetypes)) {
580 debugging("one of the portfolio format classes, $classname, said it supported something funny for mimetypes, should have been array...");
581 debugging(print_r($supportedmimetypes, true));
582 continue;
583 }
584 if (in_array($mimetype, $supportedmimetypes)) {
585 $alreadymatched[$mimetype] = $format;
586 return $format;
587 }
588 }
589 return PORTFOLIO_FORMAT_FILE; // base case for files...
590}
591
592/**
87fcac8d 593* Intersection of plugin formats and caller formats
594*
595* Walks both the caller formats and portfolio plugin formats
ea0de12f 596* and looks for matches (walking the hierarchy as well)
597* and returns the intersection
598*
599* @param array $callerformats formats the caller supports
600* @param array $pluginformats formats the portfolio plugin supports
601*/
7812e882 602function portfolio_supported_formats_intersect($callerformats, $pluginformats) {
24ba58ee 603 global $CFG;
7812e882 604 $allformats = portfolio_supported_formats();
605 $intersection = array();
606 foreach ($callerformats as $cf) {
607 if (!array_key_exists($cf, $allformats)) {
59dd457e
PL
608 if (!portfolio_format_is_abstract($cf)) {
609 debugging(get_string('invalidformat', 'portfolio', $cf));
610 }
7812e882 611 continue;
612 }
24ba58ee 613 require_once($CFG->libdir . '/portfolio/formats.php');
34035201 614 $cfobj = new $allformats[$cf]();
7812e882 615 foreach ($pluginformats as $p => $pf) {
616 if (!array_key_exists($pf, $allformats)) {
59dd457e
PL
617 if (!portfolio_format_is_abstract($pf)) {
618 debugging(get_string('invalidformat', 'portfolio', $pf));
619 }
7812e882 620 unset($pluginformats[$p]); // to avoid the same warning over and over
621 continue;
622 }
34035201 623 if ($cfobj instanceof $allformats[$pf]) {
7812e882 624 $intersection[] = $cf;
625 }
626 }
627 }
628 return $intersection;
629}
630
59dd457e
PL
631/**
632 * tiny helper to figure out whether a portfolio format is abstract
633 *
634 * @param string $format the format to test
635 *
636 * @retun bool
637 */
638function portfolio_format_is_abstract($format) {
639 if (class_exists($format)) {
640 $class = $format;
641 } else if (class_exists('portfolio_format_' . $format)) {
642 $class = 'portfolio_format_' . $format;
643 } else {
644 $allformats = portfolio_supported_formats();
645 if (array_key_exists($format, $allformats)) {
646 $class = $allformats[$format];
647 }
648 }
649 if (empty($class)) {
650 return true; // it may as well be, we can't instantiate it :)
651 }
652 $rc = new ReflectionClass($class);
653 return $rc->isAbstract();
654}
655
9d7432f6 656/**
657* return the combination of the two arrays of formats with duplicates in terms of specificity removed
59dd457e 658* and also removes conflicting formats
9d7432f6 659* use case: a module is exporting a single file, so the general formats would be FILE and MBKP
660* while the specific formats would be the specific subclass of FILE based on mime (say IMAGE)
661* and this function would return IMAGE and MBKP
662*
663* @param array $specificformats array of more specific formats (eg based on mime detection)
664* @param array $generalformats array of more general formats (usually more supported)
665*
666* @return array merged formats with dups removed
667*/
668function portfolio_most_specific_formats($specificformats, $generalformats) {
24ba58ee 669 global $CFG;
9d7432f6 670 $allformats = portfolio_supported_formats();
59dd457e
PL
671 if (empty($specificformats)) {
672 return $generalformats;
673 } else if (empty($generalformats)) {
674 return $specificformats;
675 }
a1e1af19
PL
676 $removedformats = array();
677 foreach ($specificformats as $k => $f) {
9d7432f6 678 // look for something less specific and remove it, ie outside of the inheritance tree of the current formats.
679 if (!array_key_exists($f, $allformats)) {
24ba58ee 680 if (!portfolio_format_is_abstract($f)) {
59dd457e
PL
681 throw new portfolio_button_exception('invalidformat', 'portfolio', $f);
682 }
9d7432f6 683 }
a1e1af19
PL
684 if (in_array($f, $removedformats)) {
685 // already been removed from the general list
3cec7552 686 //debugging("skipping $f because it was already removed");
a1e1af19
PL
687 unset($specificformats[$k]);
688 }
24ba58ee 689 require_once($CFG->libdir . '/portfolio/formats.php');
9d7432f6 690 $fobj = new $allformats[$f];
691 foreach ($generalformats as $key => $cf) {
a1e1af19 692 if (in_array($cf, $removedformats)) {
3cec7552 693 //debugging("skipping $cf because it was already removed");
a1e1af19
PL
694 continue;
695 }
9d7432f6 696 $cfclass = $allformats[$cf];
549c1ae6 697 $cfobj = new $allformats[$cf];
59dd457e 698 if ($fobj instanceof $cfclass && $cfclass != get_class($fobj)) {
3cec7552 699 //debugging("unsetting $key $cf because it's not specific enough ($f is better)");
59dd457e 700 unset($generalformats[$key]);
a1e1af19 701 $removedformats[] = $cf;
549c1ae6 702 continue;
59dd457e
PL
703 }
704 // check for conflicts
705 if ($fobj->conflicts($cf)) {
3cec7552 706 //debugging("unsetting $key $cf because it conflicts with $f");
59dd457e 707 unset($generalformats[$key]);
a1e1af19 708 $removedformats[] = $cf;
549c1ae6
PL
709 continue;
710 }
711 if ($cfobj->conflicts($f)) {
3cec7552 712 //debugging("unsetting $key $cf because it reverse-conflicts with $f");
a1e1af19 713 $removedformats[] = $cf;
549c1ae6
PL
714 unset($generalformats[$key]);
715 continue;
9d7432f6 716 }
717 }
59dd457e
PL
718 //debugging('inside loop');
719 //print_object($generalformats);
9d7432f6 720 }
59dd457e
PL
721
722 //debugging('final formats');
723 $finalformats = array_unique(array_merge(array_values($specificformats), array_values($generalformats)));
724 //print_object($finalformats);
725 return $finalformats;
9d7432f6 726}
727
6be1dcae 728/**
729* helper function to return a format object from the constant
730*
731* @param string $name the constant PORTFOLIO_FORMAT_XXX
732*
733* @return portfolio_format object
734*/
735function portfolio_format_object($name) {
24ba58ee
PL
736 global $CFG;
737 require_once($CFG->libdir . '/portfolio/formats.php');
6be1dcae 738 $formats = portfolio_supported_formats();
739 return new $formats[$name];
740}
741
67a87e7d 742/**
743* helper function to return an instance of a plugin (with config loaded)
744*
87fcac8d 745* @param int $instance id of instance
746* @param array $record database row that corresponds to this instance
747* this is passed to avoid unnecessary lookups
748* Optional, and the record will be retrieved if null.
67a87e7d 749*
750* @return subclass of portfolio_plugin_base
751*/
752function portfolio_instance($instanceid, $record=null) {
753 global $DB, $CFG;
754
755 if ($record) {
756 $instance = $record;
757 } else {
758 if (!$instance = $DB->get_record('portfolio_instance', array('id' => $instanceid))) {
34035201 759 throw new portfolio_exception('invalidinstance', 'portfolio');
67a87e7d 760 }
761 }
24ba58ee 762 require_once($CFG->libdir . '/portfolio/plugin.php');
edf1fc35 763 require_once($CFG->dirroot . '/portfolio/'. $instance->plugin . '/lib.php');
67a87e7d 764 $classname = 'portfolio_plugin_' . $instance->plugin;
765 return new $classname($instanceid, $instance);
766}
767
768/**
87fcac8d 769* Helper function to call a static function on a portfolio plugin class
770*
771* This will figure out the classname and require the right file and call the function.
67a87e7d 772* you can send a variable number of arguments to this function after the first two
773* and they will be passed on to the function you wish to call.
774*
87fcac8d 775* @param string $plugin name of plugin
67a87e7d 776* @param string $function function to call
777*/
778function portfolio_static_function($plugin, $function) {
779 global $CFG;
780
781 $pname = null;
782 if (is_object($plugin) || is_array($plugin)) {
783 $plugin = (object)$plugin;
784 $pname = $plugin->name;
785 } else {
786 $pname = $plugin;
787 }
788
789 $args = func_get_args();
790 if (count($args) <= 2) {
791 $args = array();
792 }
793 else {
794 array_shift($args);
795 array_shift($args);
796 }
797
24ba58ee 798 require_once($CFG->libdir . '/portfolio/plugin.php');
edf1fc35 799 require_once($CFG->dirroot . '/portfolio/' . $plugin . '/lib.php');
67a87e7d 800 return call_user_func_array(array('portfolio_plugin_' . $plugin, $function), $args);
801}
802
803/**
804* helper function to check all the plugins for sanity and set any insane ones to invisible.
805*
806* @param array $plugins to check (if null, defaults to all)
807* one string will work too for a single plugin.
808*
809* @return array array of insane instances (keys= id, values = reasons (keys for plugin lang)
810*/
811function portfolio_plugin_sanity_check($plugins=null) {
812 global $DB;
813 if (is_string($plugins)) {
98c8594a 814 $plugins = array($plugins);
67a87e7d 815 } else if (empty($plugins)) {
17da2e6f 816 $plugins = get_plugin_list('portfolio');
98c8594a 817 $plugins = array_keys($plugins);
67a87e7d 818 }
819
820 $insane = array();
98c8594a 821 foreach ($plugins as $plugin) {
67a87e7d 822 if ($result = portfolio_static_function($plugin, 'plugin_sanity_check')) {
823 $insane[$plugin] = $result;
824 }
825 }
826 if (empty($insane)) {
827 return array();
828 }
829 list($where, $params) = $DB->get_in_or_equal(array_keys($insane));
830 $where = ' plugin ' . $where;
831 $DB->set_field_select('portfolio_instance', 'visible', 0, $where, $params);
832 return $insane;
833}
834
835/**
836* helper function to check all the instances for sanity and set any insane ones to invisible.
837*
838* @param array $instances to check (if null, defaults to all)
839* one instance or id will work too
840*
841* @return array array of insane instances (keys= id, values = reasons (keys for plugin lang)
842*/
843function portfolio_instance_sanity_check($instances=null) {
844 global $DB;
845 if (empty($instances)) {
846 $instances = portfolio_instances(false);
847 } else if (!is_array($instances)) {
848 $instances = array($instances);
849 }
850
851 $insane = array();
852 foreach ($instances as $instance) {
853 if (is_object($instance) && !($instance instanceof portfolio_plugin_base)) {
854 $instance = portfolio_instance($instance->id, $instance);
855 } else if (is_numeric($instance)) {
856 $instance = portfolio_instance($instance);
857 }
858 if (!($instance instanceof portfolio_plugin_base)) {
859 debugging('something weird passed to portfolio_instance_sanity_check, not subclass or id');
860 continue;
861 }
862 if ($result = $instance->instance_sanity_check()) {
863 $insane[$instance->get('id')] = $result;
864 }
865 }
866 if (empty($insane)) {
867 return array();
868 }
869 list ($where, $params) = $DB->get_in_or_equal(array_keys($insane));
870 $where = ' id ' . $where;
871 $DB->set_field_select('portfolio_instance', 'visible', 0, $where, $params);
b816c08a 872 portfolio_insane_notify_admins($insane, true);
67a87e7d 873 return $insane;
874}
875
876/**
877* helper function to display a table of plugins (or instances) and reasons for disabling
878*
879* @param array $insane array of insane plugins (key = plugin (or instance id), value = reason)
880* @param array $instances if reporting instances rather than whole plugins, pass the array (key = id, value = object) here
881*
882*/
a50ef3d3 883function portfolio_report_insane($insane, $instances=false, $return=false) {
aa9a6867 884 global $OUTPUT;
67a87e7d 885 if (empty($insane)) {
886 return;
887 }
888
889 static $pluginstr;
890 if (empty($pluginstr)) {
891 $pluginstr = get_string('plugin', 'portfolio');
892 }
893 if ($instances) {
894 $headerstr = get_string('someinstancesdisabled', 'portfolio');
895 } else {
896 $headerstr = get_string('somepluginsdisabled', 'portfolio');
897 }
898
aa9a6867 899 $output = $OUTPUT->notification($headerstr, 'notifyproblem');
642816a6 900 $table = new html_table();
67a87e7d 901 $table->head = array($pluginstr, '');
902 $table->data = array();
903 foreach ($insane as $plugin => $reason) {
904 if ($instances) {
67a87e7d 905 $instance = $instances[$plugin];
906 $plugin = $instance->get('plugin');
907 $name = $instance->get('name');
908 } else {
909 $name = $plugin;
910 }
911 $table->data[] = array($name, get_string($reason, 'portfolio_' . $plugin));
912 }
16be8974 913 $output .= html_writer::table($table);
a50ef3d3 914 $output .= '<br /><br /><br />';
915
916 if ($return) {
917 return $output;
918 }
919 echo $output;
67a87e7d 920}
921
67a87e7d 922
87fcac8d 923/**
924* event handler for the portfolio_send event
925*/
926function portfolio_handle_event($eventdata) {
927 global $CFG;
24ba58ee
PL
928
929 require_once($CFG->libdir . '/portfolio/exporter.php');
87fcac8d 930 $exporter = portfolio_exporter::rewaken_object($eventdata);
931 $exporter->process_stage_package();
932 $exporter->process_stage_send();
933 $exporter->save();
934 $exporter->process_stage_cleanup();
935 return true;
67a87e7d 936}
937
87fcac8d 938/**
939* main portfolio cronjob
940* currently just cleans up expired transfer records.
941*
942* @todo add hooks in the plugins - either per instance or per plugin
943*/
944function portfolio_cron() {
b73d1651
MD
945 global $DB, $CFG;
946
24ba58ee 947 require_once($CFG->libdir . '/portfolio/exporter.php');
87fcac8d 948 if ($expired = $DB->get_records_select('portfolio_tempdata', 'expirytime < ?', array(time()), '', 'id')) {
949 foreach ($expired as $d) {
2512cb35 950 try {
951 $e = portfolio_exporter::rewaken_object($d->id);
952 $e->process_stage_cleanup(true);
953 } catch (Exception $e) {
90b2d8f0 954 mtrace('Exception thrown in portfolio cron while cleaning up ' . $d->id . ': ' . $e->getMessage());
2512cb35 955 }
9eb0a772 956 }
192ce92b 957 }
5071079c 958}
959
67a87e7d 960/**
50fcb1d8 961 * helper function to rethrow a caught portfolio_exception as an export exception
962 *
963 * used because when a portfolio_export exception is thrown the export is cancelled
964 *
965 * throws portfolio_export_exceptiog
966 *
967 * @param portfolio_exporter $exporter current exporter object
968 * @param exception $exception exception to rethrow
969 *
970 * @return void
971 */
87fcac8d 972function portfolio_export_rethrow_exception($exporter, $exception) {
973 throw new portfolio_export_exception($exporter, $exception->errorcode, $exception->module, $exception->link, $exception->a);
974}
67a87e7d 975
bee4bce2 976/**
977* try and determine expected_time for purely file based exports
978* or exports that might include large file attachments.
979*
50fcb1d8 980 * @global object
bee4bce2 981* @param mixed $totest - either an array of stored_file objects or a single stored_file object
bee4bce2 982* @return constant PORTFOLIO_TIME_XXX
983*/
984function portfolio_expected_time_file($totest) {
985 global $CFG;
986 if ($totest instanceof stored_file) {
987 $totest = array($totest);
988 }
989 $size = 0;
990 foreach ($totest as $file) {
991 if (!($file instanceof stored_file)) {
992 debugging('something weird passed to portfolio_expected_time_file - not stored_file object');
993 debugging(print_r($file, true));
994 continue;
995 }
996 $size += $file->get_filesize();
997 }
998
999 $fileinfo = portfolio_filesize_info();
1000
1001 $moderate = $high = 0; // avoid warnings
1002
1003 foreach (array('moderate', 'high') as $setting) {
1004 $settingname = 'portfolio_' . $setting . '_filesize_threshold';
1005 if (empty($CFG->{$settingname}) || !array_key_exists($CFG->{$settingname}, $fileinfo['options'])) {
1006 debugging("weird or unset admin value for $settingname, using default instead");
1007 $$setting = $fileinfo[$setting];
1008 } else {
1009 $$setting = $CFG->{$settingname};
1010 }
1011 }
1012
1013 if ($size < $moderate) {
1014 return PORTFOLIO_TIME_LOW;
1015 } else if ($size < $high) {
1016 return PORTFOLIO_TIME_MODERATE;
1017 }
1018 return PORTFOLIO_TIME_HIGH;
1019}
1020
1021
1022/**
1023* the default filesizes and threshold information for file based transfers
1024* this shouldn't need to be used outside the admin pages and the portfolio code
1025*/
1026function portfolio_filesize_info() {
1027 $filesizes = array();
1028 $sizelist = array(10240, 51200, 102400, 512000, 1048576, 2097152, 5242880, 10485760, 20971520, 52428800);
1029 foreach ($sizelist as $size) {
1030 $filesizes[$size] = display_size($size);
1031 }
1032 return array(
1033 'options' => $filesizes,
1034 'moderate' => 1048576,
1035 'high' => 5242880,
1036 );
1037}
1038
1039/**
1040* try and determine expected_time for purely database based exports
1041* or exports that might include large parts of a database
1042*
50fcb1d8 1043 * @global object
bee4bce2 1044* @param integer $recordcount - number of records trying to export
bee4bce2 1045* @return constant PORTFOLIO_TIME_XXX
1046*/
1047function portfolio_expected_time_db($recordcount) {
1048 global $CFG;
1049
1050 if (empty($CFG->portfolio_moderate_dbsize_threshold)) {
1051 set_config('portfolio_moderate_dbsize_threshold', 10);
1052 }
1053 if (empty($CFG->portfolio_high_dbsize_threshold)) {
1054 set_config('portfolio_high_dbsize_threshold', 50);
1055 }
1056 if ($recordcount < $CFG->portfolio_moderate_dbsize_threshold) {
1057 return PORTFOLIO_TIME_LOW;
1058 } else if ($recordcount < $CFG->portfolio_high_dbsize_threshold) {
1059 return PORTFOLIO_TIME_MODERATE;
1060 }
1061 return PORTFOLIO_TIME_HIGH;
1062}
67a87e7d 1063
50fcb1d8 1064/**
1065 * @global object
1066 */
b816c08a 1067function portfolio_insane_notify_admins($insane, $instances=false) {
1068
1069 global $CFG;
1070
1071 if (defined('ADMIN_EDITING_PORTFOLIO')) {
1072 return true;
1073 }
1074
1075 $admins = get_admins();
1076
1077 if (empty($admins)) {
1078 return;
1079 }
1080 if ($instances) {
1081 $instances = portfolio_instances(false, false);
1082 }
1083
1084 $site = get_site();
1085
1086 $a = new StdClass;
1087 $a->sitename = $site->fullname;
d1aa1e48 1088 $a->fixurl = "$CFG->wwwroot/$CFG->admin/settings.php?section=manageportfolios";
b816c08a 1089 $a->htmllist = portfolio_report_insane($insane, $instances, true);
1090 $a->textlist = '';
1091
1092 foreach ($insane as $k => $reason) {
1093 if ($instances) {
1094 $a->textlist = $instances[$k]->get('name') . ': ' . $reason . "\n";
1095 } else {
1096 $a->textlist = $k . ': ' . $reason . "\n";
1097 }
1098 }
1099
1100 $subject = get_string('insanesubject', 'portfolio');
1101 $plainbody = get_string('insanebody', 'portfolio', $a);
1102 $htmlbody = get_string('insanebodyhtml', 'portfolio', $a);
1103 $smallbody = get_string('insanebodysmall', 'portfolio', $a);
1104
1105 foreach ($admins as $admin) {
1106 $eventdata = new object();
1107 $eventdata->modulename = 'portfolio';
1108 $eventdata->component = 'portfolio';
1109 $eventdata->name = 'notices';
1110 $eventdata->userfrom = $admin;
1111 $eventdata->userto = $admin;
1112 $eventdata->subject = $subject;
1113 $eventdata->fullmessage = $plainbody;
1114 $eventdata->fullmessageformat = FORMAT_PLAIN;
1115 $eventdata->fullmessagehtml = $htmlbody;
1116 $eventdata->smallmessage = $smallbody;
7c7d3afa 1117 message_send($eventdata);
b816c08a 1118 }
1119}
f1d2641d
PL
1120
1121function portfolio_export_pagesetup($PAGE, $caller) {
90636e2b
PL
1122 // set up the context so that build_navigation works nice
1123 $caller->set_context($PAGE);
f1d2641d
PL
1124
1125 list($extranav, $cm) = $caller->get_navigation();
1126
1127 // and now we know the course for sure and maybe the cm, call require_login with it
90636e2b 1128 require_login($PAGE->course, false, $cm);
f1d2641d
PL
1129
1130 foreach ($extranav as $navitem) {
1131 $PAGE->navbar->add($navitem['name']);
1132 }
1133 $PAGE->navbar->add(get_string('exporting', 'portfolio'));
1134}
b12fbe8e
PL
1135
1136function portfolio_export_type_to_id($type, $userid) {
1137 global $DB;
1138 $sql = 'SELECT t.id FROM {portfolio_tempdata} t JOIN {portfolio_instance} i ON t.instance = i.id WHERE t.userid = ? AND i.plugin = ?';
1139 return $DB->get_field_sql($sql, array($userid, $type));
1140}
24ba58ee
PL
1141
1142/**
1143 * return a list of current exports for the given user
1144 * this will not go through and call rewaken_object, because it's heavy
1145 * it's really just used to figure out what exports are currently happening.
1146 * this is useful for plugins that don't support multiple exports per session
1147 *
1148 * @param int $userid the user to check for
1149 * @param string $type (optional) the portfolio plugin to filter by
1150 *
1151 * @return array
1152 */
1153function portfolio_existing_exports($userid, $type=null) {
1154 global $DB;
1155 $sql = 'SELECT t.*,t.instance,i.plugin,i.name FROM {portfolio_tempdata} t JOIN {portfolio_instance} i ON t.instance = i.id WHERE t.userid = ? ';
1156 $values = array($userid);
1157 if ($type) {
1158 $sql .= ' AND i.plugin = ?';
1159 $values[] = $type;
1160 }
1161 return $DB->get_records_sql($sql, $values);
1162}
1163
1164/**
1165 * Return an array of existing exports by type for a given user.
1166 * This is much more lightweight than {@see existing_exports} because it only returns the types, rather than the whole serialised data
1167 * so can be used for checking availability of multiple plugins at the same time.
1168 */
1169function portfolio_existing_exports_by_plugin($userid) {
1170 global $DB;
1171 $sql = 'SELECT t.id,i.plugin FROM {portfolio_tempdata} t JOIN {portfolio_instance} i ON t.instance = i.id WHERE t.userid = ? ';
1172 $values = array($userid);
1173 return $DB->get_records_sql_menu($sql, $values);
1174}
8192522e
PL
1175
1176
1177/**
1178 * callback function from {@link portfolio_rewrite_pluginfile_urls}
1179 * looks through preg_replace matches and replaces content with whatever the active portfolio export format says
1180 */
64f93798 1181function portfolio_rewrite_pluginfile_url_callback($contextid, $component, $filearea, $itemid, $format, $options, $matches) {
8192522e
PL
1182 $matches = $matches[0]; // no internal matching
1183 $dom = new DomDocument();
1184 if (!$dom->loadXML($matches)) {
1185 return $matches;
1186 }
1187 $attributes = array();
1188 foreach ($dom->documentElement->attributes as $attr => $node) {
1189 $attributes[$attr] = $node->value;
1190 }
1191 // now figure out the file
1192 $fs = get_file_storage();
1193 $key = 'href';
1194 if (!array_key_exists('href', $attributes) && array_key_exists('src', $attributes)) {
1195 $key = 'src';
1196 }
1197 if (!array_key_exists($key, $attributes)) {
1198 debugging('Couldn\'t find an attribute to use that contains @@PLUGINFILE@@ in portfolio_rewrite_pluginfile');
1199 return $matches;
1200 }
1201 $filename = substr($attributes[$key], strpos($attributes[$key], '@@PLUGINFILE@@') + strlen('@@PLUGINFILE@@'));
1202 $filepath = '/';
1203 if (strpos($filename, '/') !== 0) {
1204 $bits = explode('/', $filename);
1205 $filename = array_pop($bits);
1206 $filepath = implode('/', $bits);
1207 }
64f93798
PS
1208 if (!$file = $fs->get_file($contextid, $component, $filearea, $itemid, $filepath, $filename)) {
1209 debugging("Couldn\t find a file from the embedded path info context $contextid component $component filearea $filearea itemid $itemid filepath $filepath name $filename");
8192522e
PL
1210 return $matches;
1211 }
1212 if (empty($options)) {
1213 $options = array();
1214 }
1215 $options['attributes'] = $attributes;
1216 return $format->file_output($file, $options);
1217}
1218
1219
1220/**
1221 * go through all the @@PLUGINFILE@@ matches in some text,
1222 * extract the file information and pass it back to the portfolio export format
1223 * to regenerate the html to output
1224 *
1225 * @param string $text the text to search through
1226 * @param int $contextid normal file_area arguments
64f93798 1227 * @param string $component
8192522e
PL
1228 * @param string $filearea normal file_area arguments
1229 * @param int $itemid normal file_area arguments
1230 * @param portfolio_format $format the portfolio export format
1231 * @param array $options extra options to pass through to the file_output function in the format (optional)
1232 *
1233 * @return string
1234 */
64f93798 1235function portfolio_rewrite_pluginfile_urls($text, $contextid, $component, $filearea, $itemid, $format, $options=null) {
8192522e 1236 $pattern = '/(<[^<]*?="@@PLUGINFILE@@\/[^>]*?(?:\/>|>.*?<\/[^>]*?>))/';
64f93798 1237 $callback = partial('portfolio_rewrite_pluginfile_url_callback', $contextid, $component, $filearea, $itemid, $format, $options);
8192522e
PL
1238 return preg_replace_callback($pattern, $callback, $text);
1239}
1240// this function has to go last, because the regexp screws up syntax highlighting in some editors
1241