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