MDL-64820 forum: fix up issues from review
[moodle.git] / lib / portfoliolib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * This file contains all global functions to do with manipulating portfolios.
19  *
20  * Everything else that is logically namespaced by class is in its own file
21  * in lib/portfolio/ directory.
22  *
23  * Major Contributors
24  *     - Penny Leach <penny@catalyst.net.nz>
25  *
26  * @package core_portfolio
27  * @category 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
30  */
32 defined('MOODLE_INTERNAL') || die();
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
38 // very lightweight list of constants. always needed and no further dependencies
39 require_once($CFG->libdir . '/portfolio/constants.php');
40 // a couple of exception deinitions. always needed and no further dependencies
41 require_once($CFG->libdir . '/portfolio/exceptions.php');  // exception classes used by portfolio code
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.
45 require_once($CFG->libdir . '/portfolio/caller.php');
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
54 /**
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
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), 'yourcomponent'); eg. mod_forum
64  * $button->render(PORTFOLIO_ADD_FULL_FORM, get_string('addeverythingtoportfolio', 'yourcomponent'));
65  * </code>
66  * or like this:
67  * <code>
68  * $button = new portfolio_add_button(array('callbackclass' => 'name_of_caller_class', 'callbackargs' => array('id' => 6), 'callbackcomponent' => 'yourcomponent')); eg. mod_forum
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 $callbackcomponent;
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 'callbackcomponent': 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', 'callbackcomponent');
125         foreach ((array)$options as $key => $value) {
126             if (!in_array($key, $constructoroptions)) {
127                 throw new portfolio_button_exception('invalidbuttonproperty', 'portfolio', $key);
128             }
129         }
131         $this->set_callback_options($options['callbackclass'], $options['callbackargs'], $options['callbackcomponent']);
132     }
134     /**
135      * Function to set the callback options
136      *
137      * @param string $class Name of the class containing the callback functions
138      *      activity components should ALWAYS use their name_portfolio_caller
139      *      other locations must use something unique
140      * @param array $argarray This can be an array or hash of arguments to pass
141      *      back to the callback functions (passed by reference)
142      *      these MUST be primatives to be added as hidden form fields.
143      *      and the values get cleaned to PARAM_ALPHAEXT or PARAM_FLOAT or PARAM_PATH
144      * @param string $component This is the name of the component in Moodle, eg 'mod_forum'
145      */
146     public function set_callback_options($class, array $argarray, $component) {
147         global $CFG;
149         // Require the base class first before any other files.
150         require_once($CFG->libdir . '/portfolio/caller.php');
152         // Include any potential callback files and check for errors.
153         portfolio_include_callback_file($component, $class);
155         // This will throw exceptions but should not actually do anything other than verify callbackargs.
156         $test = new $class($argarray);
157         unset($test);
159         $this->callbackcomponent = $component;
160         $this->callbackclass = $class;
161         $this->callbackargs = $argarray;
162     }
164     /**
165      * Sets the available export formats for this content.
166      * This function will also poll the static function in the caller class
167      * and make sure we're not overriding a format that has nothing to do with mimetypes.
168      * Eg: if you pass IMAGE here but the caller can export LEAP2A it will keep LEAP2A as well.
169      * @see portfolio_most_specific_formats for more information
170      * @see portfolio_format_from_mimetype
171      *
172      * @param array $formats if the calling code knows better than the static method on the calling class (base_supported_formats).
173      *                       Eg: if it's going to be a single file, or if you know it's HTML, you can pass it here instead.
174      *                       This is almost always the case so it should be use all the times
175      *                       portfolio_format_from_mimetype for how to get the appropriate formats to pass here for uploaded files.
176      *                       or just call set_format_by_file instead
177      */
178     public function set_formats($formats=null) {
179         if (is_string($formats)) {
180             $formats = array($formats);
181         }
182         if (empty($formats)) {
183             $formats = array();
184         }
185         if (empty($this->callbackclass)) {
186             throw new portfolio_button_exception('noclassbeforeformats', 'portfolio');
187         }
188         $callerformats = call_user_func(array($this->callbackclass, 'base_supported_formats'));
189         $this->formats = portfolio_most_specific_formats($formats, $callerformats);
190     }
192     /**
193      * Reset formats to the default,
194      * which is usually what base_supported_formats returns
195      */
196     public function reset_formats() {
197         $this->set_formats();
198     }
201     /**
202      * If we already know we have exactly one file,
203      * bypass set_formats and just pass the file
204      * so we can detect the formats by mimetype.
205      *
206      * @param stored_file $file file to set the format from
207      * @param array $extraformats any additional formats other than by mimetype
208      *                            eg leap2a etc
209      */
210     public function set_format_by_file(stored_file $file, $extraformats=null) {
211         $this->file = $file;
212         $fileformat = portfolio_format_from_mimetype($file->get_mimetype());
213         if (is_string($extraformats)) {
214             $extraformats = array($extraformats);
215         } else if (!is_array($extraformats)) {
216             $extraformats = array();
217         }
218         $this->set_formats(array_merge(array($fileformat), $extraformats));
219     }
221     /**
222      * Correllary this is use to set_format_by_file, but it is also used when there is no stored_file and
223      * when we're writing out a new type of file (like csv or pdf)
224      *
225      * @param string $extn the file extension we intend to generate
226      * @param array  $extraformats any additional formats other than by mimetype
227      *                             eg leap2a etc
228      */
229     public function set_format_by_intended_file($extn, $extraformats=null) {
230         $mimetype = mimeinfo('type', 'something. ' . $extn);
231         $fileformat = portfolio_format_from_mimetype($mimetype);
232         $this->intendedmimetype = $fileformat;
233         if (is_string($extraformats)) {
234             $extraformats = array($extraformats);
235         } else if (!is_array($extraformats)) {
236             $extraformats = array();
237         }
238         $this->set_formats(array_merge(array($fileformat), $extraformats));
239     }
241     /**
242      * Echo the form/button/icon/text link to the page
243      *
244      * @param int $format format to display the button or form or icon or link.
245      *                    See constants PORTFOLIO_ADD_XXX for more info.
246      *                    optional, defaults to PORTFOLIO_ADD_FULL_FORM
247      * @param string $addstr string to use for the button or icon alt text or link text.
248      *                       this is whole string, not key. optional, defaults to 'Export to portfolio';
249      */
250     public function render($format=null, $addstr=null) {
251         echo $this->to_html($format, $addstr);
252     }
254     /**
255      * Returns the form/button/icon/text link as html
256      *
257      * @param int $format format to display the button or form or icon or link.
258      *                    See constants PORTFOLIO_ADD_XXX for more info.
259      *                    Optional, defaults to PORTFOLIO_ADD_FULL_FORM
260      * @param string $addstr string to use for the button or icon alt text or link text.
261      *                       This is whole string, not key.  optional, defaults to 'Add to portfolio';
262      * @return void|string|moodle_url
263      */
264     public function to_html($format=null, $addstr=null) {
265         global $CFG, $COURSE, $OUTPUT, $USER;
266         if (!$this->is_renderable()) {
267             return;
268         }
269         if (empty($this->callbackclass) || empty($this->callbackcomponent)) {
270             throw new portfolio_button_exception('mustsetcallbackoptions', 'portfolio');
271         }
272         if (empty($this->formats)) {
273             // use the caller defaults
274             $this->set_formats();
275         }
276         $url = new moodle_url('/portfolio/add.php');
277         foreach ($this->callbackargs as $key => $value) {
278             if (!empty($value) && !is_string($value) && !is_numeric($value)) {
279                 $a = new stdClass();
280                 $a->key = $key;
281                 $a->value = print_r($value, true);
282                 debugging(get_string('nonprimative', 'portfolio', $a));
283                 return;
284             }
285             $url->param('ca_' . $key, $value);
286         }
287         $url->param('sesskey', sesskey());
288         $url->param('callbackcomponent', $this->callbackcomponent);
289         $url->param('callbackclass', $this->callbackclass);
290         $url->param('course', (!empty($COURSE)) ? $COURSE->id : 0);
291         $url->param('callerformats', implode(',', $this->formats));
292         $mimetype = null;
293         if ($this->file instanceof stored_file) {
294             $mimetype = $this->file->get_mimetype();
295         } else if ($this->intendedmimetype) {
296             $mimetype = $this->intendedmimetype;
297         }
298         $selectoutput = '';
299         if (count($this->instances) == 1) {
300             $tmp = array_values($this->instances);
301             $instance = $tmp[0];
303             $formats = portfolio_supported_formats_intersect($this->formats, $instance->supported_formats());
304             if (count($formats) == 0) {
305                 // bail. no common formats.
306                 //debugging(get_string('nocommonformats', 'portfolio', (object)array('location' => $this->callbackclass, 'formats' => implode(',', $this->formats))));
307                 return;
308             }
309             if ($error = portfolio_instance_sanity_check($instance)) {
310                 // bail, plugin is misconfigured
311                 //debugging(get_string('instancemisconfigured', 'portfolio', get_string($error[$instance->get('id')], 'portfolio_' . $instance->get('plugin'))));
312                 return;
313             }
314             if (!$instance->allows_multiple_exports() && $already = portfolio_existing_exports($USER->id, $instance->get('plugin'))) {
315                 //debugging(get_string('singleinstancenomultiallowed', 'portfolio'));
316                 return;
317             }
318             if ($mimetype&& !$instance->file_mime_check($mimetype)) {
319                 // bail, we have a specific file or mimetype and this plugin doesn't support it
320                 //debugging(get_string('mimecheckfail', 'portfolio', (object)array('plugin' => $instance->get('plugin'), 'mimetype' => $mimetype)));
321                 return;
322             }
323             $url->param('instance', $instance->get('id'));
324         }
325         else {
326             if (!$selectoutput = portfolio_instance_select($this->instances, $this->formats, $this->callbackclass, $mimetype, 'instance', true)) {
327                 return;
328             }
329         }
330         // If we just want a moodle_url to redirect to, do it now.
331         if ($format == PORTFOLIO_ADD_MOODLE_URL) {
332             return $url;
333         }
335         // if we just want a url to redirect to, do it now
336         if ($format == PORTFOLIO_ADD_FAKE_URL) {
337             return $url->out(false);
338         }
340         if (empty($addstr)) {
341             $addstr = get_string('addtoportfolio', 'portfolio');
342         }
343         if (empty($format)) {
344             $format = PORTFOLIO_ADD_FULL_FORM;
345         }
347         $formoutput = '<form method="post" action="' . $CFG->wwwroot . '/portfolio/add.php" id="portfolio-add-button">' . "\n";
348         $formoutput .= html_writer::input_hidden_params($url);
349         $linkoutput = '';
351         switch ($format) {
352             case PORTFOLIO_ADD_FULL_FORM:
353                 $formoutput .= $selectoutput;
354                 $formoutput .= "\n" . '<input type="submit" class="btn btn-secondary" value="' . $addstr .'" />';
355                 $formoutput .= "\n" . '</form>';
356             break;
357             case PORTFOLIO_ADD_ICON_FORM:
358                 $formoutput .= $selectoutput;
359                 $formoutput .= "\n" . '<button class="portfolio-add-icon">' . $OUTPUT->pix_icon('t/portfolioadd', $addstr) . '</button>';
360                 $formoutput .= "\n" . '</form>';
361             break;
362             case PORTFOLIO_ADD_ICON_LINK:
363                 $linkoutput = $OUTPUT->action_icon($url, new pix_icon('t/portfolioadd', $addstr, '',
364                     array('class' => 'portfolio-add-icon smallicon')));
365             break;
366             case PORTFOLIO_ADD_TEXT_LINK:
367                 $linkoutput = html_writer::link($url, $addstr, array('class' => 'portfolio-add-link',
368                     'title' => $addstr));
369             break;
370             default:
371                 debugging(get_string('invalidaddformat', 'portfolio', $format));
372         }
373         $output = (in_array($format, array(PORTFOLIO_ADD_FULL_FORM, PORTFOLIO_ADD_ICON_FORM)) ? $formoutput : $linkoutput);
374         return $output;
375     }
377     /**
378      * Perform some internal checks.
379      * These are not errors, just situations
380      * where it's not appropriate to add the button
381      *
382      * @return bool
383      */
384     private function is_renderable() {
385         global $CFG;
386         if (empty($CFG->enableportfolios)) {
387             return false;
388         }
389         if (defined('PORTFOLIO_INTERNAL')) {
390             // something somewhere has detected a risk of this being called during inside the preparation
391             // eg forum_print_attachments
392             return false;
393         }
394         if (empty($this->instances) || count($this->instances) == 0) {
395             return false;
396         }
397         return true;
398     }
400     /**
401      * Getter for $format property
402      *
403      * @return array
404      */
405     public function get_formats() {
406         return $this->formats;
407     }
409     /**
410      * Getter for $callbackargs property
411      *
412      * @return array
413      */
414     public function get_callbackargs() {
415         return $this->callbackargs;
416     }
418     /**
419      * Getter for $callbackcomponent property
420      *
421      * @return string
422      */
423     public function get_callbackcomponent() {
424         return $this->callbackcomponent;
425     }
427     /**
428      * Getter for $callbackclass property
429      *
430      * @return string
431      */
432     public function get_callbackclass() {
433         return $this->callbackclass;
434     }
437 /**
438  * Returns a drop menu with a list of available instances.
439  *
440  * @param array          $instances      array of portfolio plugin instance objects - the instances to put in the menu
441  * @param array          $callerformats  array of PORTFOLIO_FORMAT_XXX constants - the formats the caller supports (this is used to filter plugins)
442  * @param string         $callbackclass  the callback class name - used for debugging only for when there are no common formats
443  * @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.
444  * @param string         $selectname     the name of the select element. Optional, defaults to instance.
445  * @param bool           $return         whether to print or return the output. Optional, defaults to print.
446  * @param bool           $returnarray    if returning, whether to return the HTML or the array of options. Optional, defaults to HTML.
447  * @return void|array|string the html, from <select> to </select> inclusive.
448  */
449 function portfolio_instance_select($instances, $callerformats, $callbackclass, $mimetype=null, $selectname='instance', $return=false, $returnarray=false) {
450     global $CFG, $USER;
452     if (empty($CFG->enableportfolios)) {
453         return;
454     }
456     $insane = portfolio_instance_sanity_check();
457     $pinsane = portfolio_plugin_sanity_check();
459     $count = 0;
460     $selectoutput = "\n" . '<label class="accesshide" for="instanceid">' . get_string('plugin', 'portfolio') . '</label>';
461     $selectoutput .= "\n" . '<select id="instanceid" name="' . $selectname . '" class="custom-select">' . "\n";
462     $existingexports = portfolio_existing_exports_by_plugin($USER->id);
463     foreach ($instances as $instance) {
464         $formats = portfolio_supported_formats_intersect($callerformats, $instance->supported_formats());
465         if (count($formats) == 0) {
466             // bail. no common formats.
467             continue;
468         }
469         if (array_key_exists($instance->get('id'), $insane)) {
470             // bail, plugin is misconfigured
471             //debugging(get_string('instanceismisconfigured', 'portfolio', get_string($insane[$instance->get('id')], 'portfolio_' . $instance->get('plugin'))));
472             continue;
473         } else if (array_key_exists($instance->get('plugin'), $pinsane)) {
474             // bail, plugin is misconfigured
475             //debugging(get_string('pluginismisconfigured', 'portfolio', get_string($pinsane[$instance->get('plugin')], 'portfolio_' . $instance->get('plugin'))));
476             continue;
477         }
478         if (!$instance->allows_multiple_exports() && in_array($instance->get('plugin'), $existingexports)) {
479             // bail, already exporting something with this plugin and it doesn't support multiple exports
480             continue;
481         }
482         if ($mimetype && !$instance->file_mime_check($mimetype)) {
483             //debugging(get_string('mimecheckfail', 'portfolio', (object)array('plugin' => $instance->get('plugin'), 'mimetype' => $mimetype())));
484             // bail, we have a specific file and this plugin doesn't support it
485             continue;
486         }
487         $count++;
488         $selectoutput .= "\n" . '<option value="' . $instance->get('id') . '">' . $instance->get('name') . '</option>' . "\n";
489         $options[$instance->get('id')] = $instance->get('name');
490     }
491     if (empty($count)) {
492         // bail. no common formats.
493         //debugging(get_string('nocommonformats', 'portfolio', (object)array('location' => $callbackclass, 'formats' => implode(',', $callerformats))));
494         return;
495     }
496     $selectoutput .= "\n" . "</select>\n";
497     if (!empty($returnarray)) {
498         return $options;
499     }
500     if (!empty($return)) {
501         return $selectoutput;
502     }
503     echo $selectoutput;
506 /**
507  * Return all portfolio instances
508  *
509  * @todo MDL-15768 - check capabilities here
510  * @param bool $visibleonly Don't include hidden instances. Defaults to true and will be overridden to true if the next parameter is true
511  * @param bool $useronly    Check the visibility preferences and permissions of the logged in user. Defaults to true.
512  * @return array of portfolio instances (full objects, not just database records)
513  */
514 function portfolio_instances($visibleonly=true, $useronly=true) {
516     global $DB, $USER;
518     $values = array();
519     $sql = 'SELECT * FROM {portfolio_instance}';
521     if ($visibleonly || $useronly) {
522         $values[] = 1;
523         $sql .= ' WHERE visible = ?';
524     }
525     if ($useronly) {
526         $sql .= ' AND id NOT IN (
527                 SELECT instance FROM {portfolio_instance_user}
528                 WHERE userid = ? AND name = ? AND ' . $DB->sql_compare_text('value') . ' = ?
529             )';
530         $values = array_merge($values, array($USER->id, 'visible', 0));
531     }
532     $sql .= ' ORDER BY name';
534     $instances = array();
535     foreach ($DB->get_records_sql($sql, $values) as $instance) {
536         $instances[$instance->id] = portfolio_instance($instance->id, $instance);
537     }
538     return $instances;
541 /**
542  * Return whether there are visible instances in portfolio.
543  *
544  * @return bool true when there are some visible instances.
545  */
546 function portfolio_has_visible_instances() {
547     global $DB;
548     return $DB->record_exists('portfolio_instance', array('visible' => 1));
551 /**
552  * Supported formats currently in use.
553  * Canonical place for a list of all formats
554  * that portfolio plugins and callers
555  * can use for exporting content
556  *
557  * @return array keyed array of all the available export formats (constant => classname)
558  */
559 function portfolio_supported_formats() {
560     return array(
561         PORTFOLIO_FORMAT_FILE         => 'portfolio_format_file',
562         PORTFOLIO_FORMAT_IMAGE        => 'portfolio_format_image',
563         PORTFOLIO_FORMAT_RICHHTML     => 'portfolio_format_richhtml',
564         PORTFOLIO_FORMAT_PLAINHTML    => 'portfolio_format_plainhtml',
565         PORTFOLIO_FORMAT_TEXT         => 'portfolio_format_text',
566         PORTFOLIO_FORMAT_VIDEO        => 'portfolio_format_video',
567         PORTFOLIO_FORMAT_PDF          => 'portfolio_format_pdf',
568         PORTFOLIO_FORMAT_DOCUMENT     => 'portfolio_format_document',
569         PORTFOLIO_FORMAT_SPREADSHEET  => 'portfolio_format_spreadsheet',
570         PORTFOLIO_FORMAT_PRESENTATION => 'portfolio_format_presentation',
571         /*PORTFOLIO_FORMAT_MBKP, */ // later
572         PORTFOLIO_FORMAT_LEAP2A       => 'portfolio_format_leap2a',
573         PORTFOLIO_FORMAT_RICH         => 'portfolio_format_rich',
574     );
577 /**
578  * Deduce export format from file mimetype
579  * This function returns the revelant portfolio export format
580  * which is used to determine which portfolio plugins can be used
581  * for exporting this content
582  * according to the given mime type
583  * this only works when exporting exactly <b>one</b> file, or generating a new one
584  * (like a pdf or csv export)
585  *
586  * @param string $mimetype (usually $file->get_mimetype())
587  * @return string the format constant (see PORTFOLIO_FORMAT_XXX constants)
588  */
589 function portfolio_format_from_mimetype($mimetype) {
590     global $CFG;
591     static $alreadymatched;
592     if (empty($alreadymatched)) {
593         $alreadymatched = array();
594     }
595     if (array_key_exists($mimetype, $alreadymatched)) {
596         return $alreadymatched[$mimetype];
597     }
598     $allformats = portfolio_supported_formats();
599     require_once($CFG->libdir . '/portfolio/formats.php');
600     foreach ($allformats as $format => $classname) {
601         $supportedmimetypes = call_user_func(array($classname, 'mimetypes'));
602         if (!is_array($supportedmimetypes)) {
603             debugging("one of the portfolio format classes, $classname, said it supported something funny for mimetypes, should have been array...");
604             debugging(print_r($supportedmimetypes, true));
605             continue;
606         }
607         if (in_array($mimetype, $supportedmimetypes)) {
608             $alreadymatched[$mimetype] = $format;
609             return $format;
610         }
611     }
612     return PORTFOLIO_FORMAT_FILE; // base case for files...
615 /**
616  * Intersection of plugin formats and caller formats.
617  * Walks both the caller formats and portfolio plugin formats
618  * and looks for matches (walking the hierarchy as well)
619  * and returns the intersection
620  *
621  * @param array $callerformats formats the caller supports
622  * @param array $pluginformats formats the portfolio plugin supports
623  * @return array
624  */
625 function portfolio_supported_formats_intersect($callerformats, $pluginformats) {
626     global $CFG;
627     $allformats = portfolio_supported_formats();
628     $intersection = array();
629     foreach ($callerformats as $cf) {
630         if (!array_key_exists($cf, $allformats)) {
631             if (!portfolio_format_is_abstract($cf)) {
632                 debugging(get_string('invalidformat', 'portfolio', $cf));
633             }
634             continue;
635         }
636         require_once($CFG->libdir . '/portfolio/formats.php');
637         $cfobj = new $allformats[$cf]();
638         foreach ($pluginformats as $p => $pf) {
639             if (!array_key_exists($pf, $allformats)) {
640                 if (!portfolio_format_is_abstract($pf)) {
641                     debugging(get_string('invalidformat', 'portfolio', $pf));
642                 }
643                 unset($pluginformats[$p]); // to avoid the same warning over and over
644                 continue;
645             }
646             if ($cfobj instanceof $allformats[$pf]) {
647                 $intersection[] = $cf;
648             }
649         }
650     }
651     return $intersection;
654 /**
655  * Tiny helper to figure out whether a portfolio format is abstract
656  *
657  * @param string $format the format to test
658  * @return bool
659  */
660 function portfolio_format_is_abstract($format) {
661     if (class_exists($format)) {
662         $class = $format;
663     } else if (class_exists('portfolio_format_' . $format)) {
664         $class = 'portfolio_format_' . $format;
665     } else {
666         $allformats = portfolio_supported_formats();
667         if (array_key_exists($format, $allformats)) {
668             $class = $allformats[$format];
669         }
670     }
671     if (empty($class)) {
672         return true; // it may as well be, we can't instantiate it :)
673     }
674     $rc = new ReflectionClass($class);
675     return $rc->isAbstract();
678 /**
679  * Return the combination of the two arrays of formats with duplicates in terms of specificity removed
680  * and also removes conflicting formats.
681  * Use case: a module is exporting a single file, so the general formats would be FILE and MBKP
682  *           while the specific formats would be the specific subclass of FILE based on mime (say IMAGE)
683  *           and this function would return IMAGE and MBKP
684  *
685  * @param array $specificformats array of more specific formats (eg based on mime detection)
686  * @param array $generalformats  array of more general formats (usually more supported)
687  * @return array merged formats with dups removed
688  */
689 function portfolio_most_specific_formats($specificformats, $generalformats) {
690     global $CFG;
691     $allformats = portfolio_supported_formats();
692     if (empty($specificformats)) {
693         return $generalformats;
694     } else if (empty($generalformats)) {
695         return $specificformats;
696     }
697     $removedformats = array();
698     foreach ($specificformats as $k => $f) {
699         // look for something less specific and remove it, ie outside of the inheritance tree of the current formats.
700         if (!array_key_exists($f, $allformats)) {
701             if (!portfolio_format_is_abstract($f)) {
702                 throw new portfolio_button_exception('invalidformat', 'portfolio', $f);
703             }
704         }
705         if (in_array($f, $removedformats)) {
706             // already been removed from the general list
707             //debugging("skipping $f because it was already removed");
708             unset($specificformats[$k]);
709         }
710         require_once($CFG->libdir . '/portfolio/formats.php');
711         $fobj = new $allformats[$f];
712         foreach ($generalformats as $key => $cf) {
713             if (in_array($cf, $removedformats)) {
714                 //debugging("skipping $cf because it was already removed");
715                 continue;
716             }
717             $cfclass = $allformats[$cf];
718             $cfobj = new $allformats[$cf];
719             if ($fobj instanceof $cfclass && $cfclass != get_class($fobj)) {
720                 //debugging("unsetting $key $cf because it's not specific enough ($f is better)");
721                 unset($generalformats[$key]);
722                 $removedformats[] = $cf;
723                 continue;
724             }
725             // check for conflicts
726             if ($fobj->conflicts($cf)) {
727                 //debugging("unsetting $key $cf because it conflicts with $f");
728                 unset($generalformats[$key]);
729                 $removedformats[] = $cf;
730                 continue;
731             }
732             if ($cfobj->conflicts($f)) {
733                 //debugging("unsetting $key $cf because it reverse-conflicts with $f");
734                 $removedformats[] = $cf;
735                 unset($generalformats[$key]);
736                 continue;
737             }
738         }
739         //debugging('inside loop');
740         //print_object($generalformats);
741     }
743     //debugging('final formats');
744     $finalformats =  array_unique(array_merge(array_values($specificformats), array_values($generalformats)));
745     //print_object($finalformats);
746     return $finalformats;
749 /**
750  * Helper function to return a format object from the constant
751  *
752  * @param string $name the constant PORTFOLIO_FORMAT_XXX
753  * @return portfolio_format
754  */
755 function portfolio_format_object($name) {
756     global $CFG;
757     require_once($CFG->libdir . '/portfolio/formats.php');
758     $formats = portfolio_supported_formats();
759     return new $formats[$name];
762 /**
763  * Helper function to return an instance of a plugin (with config loaded)
764  *
765  * @param int   $instanceid id of instance
766  * @param object $record database row that corresponds to this instance
767  *                       this is passed to avoid unnecessary lookups
768  *                       Optional, and the record will be retrieved if null.
769  * @return object of portfolio_plugin_XXX
770  */
771 function portfolio_instance($instanceid, $record=null) {
772     global $DB, $CFG;
774     if ($record) {
775         $instance  = $record;
776     } else {
777         if (!$instance = $DB->get_record('portfolio_instance', array('id' => $instanceid))) {
778             throw new portfolio_exception('invalidinstance', 'portfolio');
779         }
780     }
781     require_once($CFG->libdir . '/portfolio/plugin.php');
782     require_once($CFG->dirroot . '/portfolio/'. $instance->plugin . '/lib.php');
783     $classname = 'portfolio_plugin_' . $instance->plugin;
784     return new $classname($instanceid, $instance);
787 /**
788  * Helper function to call a static function on a portfolio plugin class.
789  * This will figure out the classname and require the right file and call the function.
790  * You can send a variable number of arguments to this function after the first two
791  * and they will be passed on to the function you wish to call.
792  *
793  * @param string $plugin   name of plugin
794  * @param string $function function to call
795  * @return mixed
796  */
797 function portfolio_static_function($plugin, $function) {
798     global $CFG;
800     $pname = null;
801     if (is_object($plugin) || is_array($plugin)) {
802         $plugin = (object)$plugin;
803         $pname = $plugin->name;
804     } else {
805         $pname = $plugin;
806     }
808     $args = func_get_args();
809     if (count($args) <= 2) {
810         $args = array();
811     }
812     else {
813         array_shift($args);
814         array_shift($args);
815     }
817     require_once($CFG->libdir . '/portfolio/plugin.php');
818     require_once($CFG->dirroot . '/portfolio/' . $plugin .  '/lib.php');
819     return call_user_func_array(array('portfolio_plugin_' . $plugin, $function), $args);
822 /**
823  * Helper function to check all the plugins for sanity and set any insane ones to invisible.
824  *
825  * @param array $plugins array of supported plugin types
826  * @return array array of insane instances (keys= id, values = reasons (keys for plugin lang)
827  */
828 function portfolio_plugin_sanity_check($plugins=null) {
829     global $DB;
830     if (is_string($plugins)) {
831         $plugins = array($plugins);
832     } else if (empty($plugins)) {
833         $plugins = core_component::get_plugin_list('portfolio');
834         $plugins = array_keys($plugins);
835     }
837     $insane = array();
838     foreach ($plugins as $plugin) {
839         if ($result = portfolio_static_function($plugin, 'plugin_sanity_check')) {
840             $insane[$plugin] = $result;
841         }
842     }
843     if (empty($insane)) {
844         return array();
845     }
846     list($where, $params) = $DB->get_in_or_equal(array_keys($insane));
847     $where = ' plugin ' . $where;
848     $DB->set_field_select('portfolio_instance', 'visible', 0, $where, $params);
849     return $insane;
852 /**
853  * Helper function to check all the instances for sanity and set any insane ones to invisible.
854  *
855  * @param array $instances array of plugin instances
856  * @return array array of insane instances (keys= id, values = reasons (keys for plugin lang)
857  */
858 function portfolio_instance_sanity_check($instances=null) {
859     global $DB;
860     if (empty($instances)) {
861         $instances = portfolio_instances(false);
862     } else if (!is_array($instances)) {
863         $instances = array($instances);
864     }
866     $insane = array();
867     foreach ($instances as $instance) {
868         if (is_object($instance) && !($instance instanceof portfolio_plugin_base)) {
869             $instance = portfolio_instance($instance->id, $instance);
870         } else if (is_numeric($instance)) {
871             $instance = portfolio_instance($instance);
872         }
873         if (!($instance instanceof portfolio_plugin_base)) {
874             debugging('something weird passed to portfolio_instance_sanity_check, not subclass or id');
875             continue;
876         }
877         if ($result = $instance->instance_sanity_check()) {
878             $insane[$instance->get('id')] = $result;
879         }
880     }
881     if (empty($insane)) {
882         return array();
883     }
884     list ($where, $params) = $DB->get_in_or_equal(array_keys($insane));
885     $where = ' id ' . $where;
886     $DB->set_field_select('portfolio_instance', 'visible', 0, $where, $params);
887     portfolio_insane_notify_admins($insane, true);
888     return $insane;
891 /**
892  * Helper function to display a table of plugins (or instances) and reasons for disabling
893  *
894  * @param array $insane array of portfolio plugin
895  * @param array $instances if reporting instances rather than whole plugins, pass the array (key = id, value = object) here
896  * @param bool $return option to deliver the report in html format or print it out directly to the page.
897  * @return void|string of portfolio report in html table format
898  */
899 function portfolio_report_insane($insane, $instances=false, $return=false) {
900     global $OUTPUT;
901     if (empty($insane)) {
902         return;
903     }
905     static $pluginstr;
906     if (empty($pluginstr)) {
907         $pluginstr = get_string('plugin', 'portfolio');
908     }
909     if ($instances) {
910         $headerstr = get_string('someinstancesdisabled', 'portfolio');
911     } else {
912         $headerstr = get_string('somepluginsdisabled', 'portfolio');
913     }
915     $output = $OUTPUT->notification($headerstr, 'notifyproblem');
916     $table = new html_table();
917     $table->head = array($pluginstr, '');
918     $table->data = array();
919     foreach ($insane as $plugin => $reason) {
920         if ($instances) {
921             $instance = $instances[$plugin];
922             $plugin   = $instance->get('plugin');
923             $name     = $instance->get('name');
924         } else {
925             $name = $plugin;
926         }
927         $table->data[] = array($name, get_string($reason, 'portfolio_' . $plugin));
928     }
929     $output .= html_writer::table($table);
930     $output .= '<br /><br /><br />';
932     if ($return) {
933         return $output;
934     }
935     echo $output;
938 /**
939  * Main portfolio cronjob.
940  * Currently just cleans up expired transfer records.
941  */
942 function portfolio_cron() {
943     global $DB, $CFG;
945     require_once($CFG->libdir . '/portfolio/exporter.php');
946     if ($expired = $DB->get_records_select('portfolio_tempdata', 'expirytime < ?', array(time()), '', 'id')) {
947         foreach ($expired as $d) {
948             try {
949                 $e = portfolio_exporter::rewaken_object($d->id);
950                 $e->process_stage_cleanup(true);
951             } catch (Exception $e) {
952                 mtrace('Exception thrown in portfolio cron while cleaning up ' . $d->id . ': ' . $e->getMessage());
953             }
954         }
955     }
957     $process = $DB->get_records('portfolio_tempdata', array('queued' => 1), 'id ASC', 'id');
958     foreach ($process as $d) {
959         try {
960             $exporter = portfolio_exporter::rewaken_object($d->id);
961             $exporter->process_stage_package();
962             $exporter->process_stage_send();
963             $exporter->save();
964             $exporter->process_stage_cleanup();
965         } catch (Exception $e) {
966             // This will get probably retried in the next cron until it is discarded by the code above.
967             mtrace('Exception thrown in portfolio cron while processing ' . $d->id . ': ' . $e->getMessage());
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' => context_course::instance(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 \core\message\message();
1118         $eventdata->courseid = SITEID;
1119         $eventdata->modulename = 'portfolio';
1120         $eventdata->component = 'portfolio';
1121         $eventdata->name = 'notices';
1122         $eventdata->userfrom = get_admin();
1123         $eventdata->userto = $admin;
1124         $eventdata->subject = $subject;
1125         $eventdata->fullmessage = $plainbody;
1126         $eventdata->fullmessageformat = FORMAT_PLAIN;
1127         $eventdata->fullmessagehtml = $htmlbody;
1128         $eventdata->smallmessage = $smallbody;
1129         message_send($eventdata);
1130     }
1133 /**
1134  * Setup page export
1135  *
1136  * @param moodle_page $PAGE global variable from page object
1137  * @param portfolio_caller_base $caller plugin type caller
1138  */
1139 function portfolio_export_pagesetup($PAGE, $caller) {
1140     // set up the context so that build_navigation works nice
1141     $caller->set_context($PAGE);
1143     list($extranav, $cm) = $caller->get_navigation();
1145     // and now we know the course for sure and maybe the cm, call require_login with it
1146     require_login($PAGE->course, false, $cm);
1148     foreach ($extranav as $navitem) {
1149         $PAGE->navbar->add($navitem['name']);
1150     }
1151     $PAGE->navbar->add(get_string('exporting', 'portfolio'));
1154 /**
1155  * Get export type id
1156  *
1157  * @param string $type plugin type
1158  * @param int $userid the user to check for
1159  * @return mixed|bool
1160  */
1161 function portfolio_export_type_to_id($type, $userid) {
1162     global $DB;
1163     $sql = 'SELECT t.id FROM {portfolio_tempdata} t JOIN {portfolio_instance} i ON t.instance = i.id WHERE t.userid = ? AND i.plugin = ?';
1164     return $DB->get_field_sql($sql, array($userid, $type));
1167 /**
1168  * Return a list of current exports for the given user.
1169  * This will not go through and call rewaken_object, because it's heavy.
1170  * It's really just used to figure out what exports are currently happening.
1171  * This is useful for plugins that don't support multiple exports per session
1172  *
1173  * @param int $userid the user to check for
1174  * @param string $type (optional) the portfolio plugin to filter by
1175  * @return array
1176  */
1177 function portfolio_existing_exports($userid, $type=null) {
1178     global $DB;
1179     $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 = ? ';
1180     $values = array($userid);
1181     if ($type) {
1182         $sql .= ' AND i.plugin = ?';
1183         $values[] = $type;
1184     }
1185     return $DB->get_records_sql($sql, $values);
1188 /**
1189  * Return an array of existing exports by type for a given user.
1190  * This is much more lightweight than existing_exports because it only returns the types, rather than the whole serialised data
1191  * so can be used for checking availability of multiple plugins at the same time.
1192  * @see existing_exports
1193  *
1194  * @param int $userid the user to check for
1195  * @return array
1196  */
1197 function portfolio_existing_exports_by_plugin($userid) {
1198     global $DB;
1199     $sql = 'SELECT t.id,i.plugin FROM {portfolio_tempdata} t JOIN {portfolio_instance} i ON t.instance = i.id WHERE t.userid = ? ';
1200     $values = array($userid);
1201     return $DB->get_records_sql_menu($sql, $values);
1204 /**
1205  * Return default common options for {@link format_text()} when preparing a content to be exported.
1206  * It is important not to apply filters and not to clean the HTML in format_text()
1207  *
1208  * @return stdClass
1209  */
1210 function portfolio_format_text_options() {
1212     $options                = new stdClass();
1213     $options->para          = false;
1214     $options->newlines      = true;
1215     $options->filter        = false;
1216     $options->noclean       = true;
1217     $options->overflowdiv   = false;
1219     return $options;
1222 /**
1223  * callback function from {@link portfolio_rewrite_pluginfile_urls}
1224  * looks through preg_replace matches and replaces content with whatever the active portfolio export format says
1225  *
1226  * @param int $contextid module context id
1227  * @param string $component module name (eg:mod_assignment)
1228  * @param string $filearea normal file_area arguments
1229  * @param int $itemid component item id
1230  * @param portfolio_format $format exporter format type
1231  * @param array $options extra options to pass through to the file_output function in the format (optional)
1232  * @param array $matches internal matching
1233  * @return object|array|string
1234  */
1235 function portfolio_rewrite_pluginfile_url_callback($contextid, $component, $filearea, $itemid, $format, $options, $matches) {
1236     $matches = $matches[0]; // No internal matching.
1238     // Loads the HTML.
1239     $dom = new DomDocument();
1240     if (!$dom->loadHTML($matches)) {
1241         return $matches;
1242     }
1244     // Navigates to the node.
1245     $xpath = new DOMXPath($dom);
1246     $nodes = $xpath->query('/html/body/child::*');
1247     if (empty($nodes) || count($nodes) > 1) {
1248         // Unexpected sequence, none or too many nodes.
1249         return $matches;
1250     }
1251     $dom = $nodes->item(0);
1253     $attributes = array();
1254     foreach ($dom->attributes as $attr => $node) {
1255         $attributes[$attr] = $node->value;
1256     }
1257     // now figure out the file
1258     $fs = get_file_storage();
1259     $key = 'href';
1260     if (!array_key_exists('href', $attributes) && array_key_exists('src', $attributes)) {
1261         $key = 'src';
1262     }
1263     if (!array_key_exists($key, $attributes)) {
1264         debugging('Couldn\'t find an attribute to use that contains @@PLUGINFILE@@ in portfolio_rewrite_pluginfile');
1265         return $matches;
1266     }
1267     $filename = substr($attributes[$key], strpos($attributes[$key], '@@PLUGINFILE@@') + strlen('@@PLUGINFILE@@'));
1268     $filepath = '/';
1269     if (strpos($filename, '/') !== 0) {
1270         $bits = explode('/', $filename);
1271         $filename = array_pop($bits);
1272         $filepath = implode('/', $bits);
1273     }
1274     if (!$file = $fs->get_file($contextid, $component, $filearea, $itemid, $filepath, urldecode($filename))) {
1275         debugging("Couldn't find a file from the embedded path info context $contextid component $component filearea $filearea itemid $itemid filepath $filepath name $filename");
1276         return $matches;
1277     }
1278     if (empty($options)) {
1279         $options = array();
1280     }
1281     $options['attributes'] = $attributes;
1282     return $format->file_output($file, $options);
1285 /**
1286  * Function to require any potential callback files, throwing exceptions
1287  * if an issue occurs.
1288  *
1289  * @param string $component This is the name of the component in Moodle, eg 'mod_forum'
1290  * @param string $class Name of the class containing the callback functions
1291  *     activity components should ALWAYS use their name_portfolio_caller
1292  *     other locations must use something unique
1293  */
1294 function portfolio_include_callback_file($component, $class = null) {
1295     global $CFG;
1296     require_once($CFG->libdir . '/adminlib.php');
1298     // It's possible that they are passing a file path rather than passing a component.
1299     // We want to try and convert this to a component name, eg. mod_forum.
1300     $pos = strrpos($component, '/');
1301     if ($pos !== false) {
1302         // Get rid of the first slash (if it exists).
1303         $component = ltrim($component, '/');
1304         // Get a list of valid plugin types.
1305         $plugintypes = core_component::get_plugin_types();
1306         // Assume it is not valid for now.
1307         $isvalid = false;
1308         // Go through the plugin types.
1309         foreach ($plugintypes as $type => $path) {
1310             // Getting the path relative to the dirroot.
1311             $path = preg_replace('|^' . preg_quote($CFG->dirroot, '|') . '/|', '', $path);
1312             if (strrpos($component, $path) === 0) {
1313                 // Found the plugin type.
1314                 $isvalid = true;
1315                 $plugintype = $type;
1316                 $pluginpath = $path;
1317             }
1318         }
1319         // Throw exception if not a valid component.
1320         if (!$isvalid) {
1321             throw new coding_exception('Somehow a non-valid plugin path was passed, could be a hackz0r attempt, exiting.');
1322         }
1323         // Remove the file name.
1324         $component = trim(substr($component, 0, $pos), '/');
1325         // Replace the path with the type.
1326         $component = str_replace($pluginpath, $plugintype, $component);
1327         // Ok, replace '/' with '_'.
1328         $component = str_replace('/', '_', $component);
1329         // Place a debug message saying the third parameter should be changed.
1330         debugging('The third parameter sent to the function set_callback_options should be the component name, not a file path, please update this.', DEBUG_DEVELOPER);
1331     }
1333     // Check that it is a valid component.
1334     if (!get_component_version($component)) {
1335         throw new portfolio_button_exception('nocallbackcomponent', 'portfolio', '', $component);
1336     }
1338     // Obtain the component's location.
1339     if (!$componentloc = core_component::get_component_directory($component)) {
1340         throw new portfolio_button_exception('nocallbackcomponent', 'portfolio', '', $component);
1341     }
1343     // Check if the component contains the necessary file for the portfolio plugin.
1344     // These are locallib.php, portfoliolib.php and portfolio_callback.php.
1345     $filefound = false;
1346     if (file_exists($componentloc . '/locallib.php')) {
1347         $filefound = true;
1348         require_once($componentloc . '/locallib.php');
1349     }
1350     if (file_exists($componentloc . '/portfoliolib.php')) {
1351         $filefound = true;
1352         debugging('Please standardise your plugin by renaming your portfolio callback file to locallib.php, or if that file already exists moving the portfolio functionality there.', DEBUG_DEVELOPER);
1353         require_once($componentloc . '/portfoliolib.php');
1354     }
1355     if (file_exists($componentloc . '/portfolio_callback.php')) {
1356         $filefound = true;
1357         debugging('Please standardise your plugin by renaming your portfolio callback file to locallib.php, or if that file already exists moving the portfolio functionality there.', DEBUG_DEVELOPER);
1358         require_once($componentloc . '/portfolio_callback.php');
1359     }
1361     // Ensure that we found a file we can use, if not throw an exception.
1362     if (!$filefound) {
1363         throw new portfolio_button_exception('nocallbackfile', 'portfolio', '', $component);
1364     }
1366     if (!is_null($class)) {
1367         // If class is specified, check it exists and extends portfolio_caller_base.
1368         if (!class_exists($class) || !is_subclass_of($class, 'portfolio_caller_base')) {
1369             throw new portfolio_button_exception('nocallbackclass', 'portfolio', '', $class);
1370         }
1371     }
1374 /**
1375  * Go through all the @@PLUGINFILE@@ matches in some text,
1376  * extract the file information and pass it back to the portfolio export format
1377  * to regenerate the html to output
1378  *
1379  * @param string $text the text to search through
1380  * @param int $contextid normal file_area arguments
1381  * @param string $component module name
1382  * @param string $filearea normal file_area arguments
1383  * @param int $itemid normal file_area arguments
1384  * @param portfolio_format $format the portfolio export format
1385  * @param array $options additional options to be included in the plugin file url (optional)
1386  * @return mixed
1387  */
1388 function portfolio_rewrite_pluginfile_urls($text, $contextid, $component, $filearea, $itemid, $format, $options=null) {
1389     $patterns = array(
1390         '(<(a|A)[^<]*?href="@@PLUGINFILE@@/[^>]*?>.*?</(a|A)>)',
1391         '(<(img|IMG)\s[^<]*?src="@@PLUGINFILE@@/[^>]*?/?>)',
1392     );
1393     $pattern = '~' . implode('|', $patterns) . '~';
1394     $callback = partial('portfolio_rewrite_pluginfile_url_callback', $contextid, $component, $filearea, $itemid, $format, $options);
1395     return preg_replace_callback($pattern, $callback, $text);
1397 // this function has to go last, because the regexp screws up syntax highlighting in some editors