6b612ba85bffd4fd516c7c151a67598afe5b5fd9
[moodle.git] / lib / portfoliolib.php
1 <?php
2 /**
3  * Moodle - Modular Object-Oriented Dynamic Learning Environment
4  *          http://moodle.org
5  * Copyright (C) 1999 onwards Martin Dougiamas  http://dougiamas.com
6  *
7  * This program is free software: you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation, either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
19  *
20  * @package    moodle
21  * @subpackage portfolio
22  * @author     Penny Leach <penny@catalyst.net.nz>
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL
24  * @copyright  (C) 1999 onwards Martin Dougiamas  http://dougiamas.com
25  *
26  * This file contains all global functions to do with manipulating portfolios
27  * everything else that is logically namespaced by class is in its own file
28  * in lib/portfolio/ directory.
29  */
31 // require all the sublibraries first.
32 require_once($CFG->libdir . '/portfolio/constants.php');   // all the constants for time, export format etc.
33 require_once($CFG->libdir . '/portfolio/exceptions.php');  // exception classes used by portfolio code
34 require_once($CFG->libdir . '/portfolio/formats.php');     // the export format hierarchy
35 require_once($CFG->libdir . '/portfolio/forms.php');       // the form classes that subclass moodleform
36 require_once($CFG->libdir . '/portfolio/exporter.php');    // the exporter class
37 require_once($CFG->libdir . '/portfolio/plugin.php');      // the base classes for plugins
38 require_once($CFG->libdir . '/portfolio/caller.php');      // the base classes for calling code
40 /**
41 * use this to add a portfolio button or icon or form to a page
42 *
43 * These class methods do not check permissions. the caller must check permissions first.
44 * Later, during the export process, the caller class is instantiated and the check_permissions method is called
45 *
46 * This class can be used like this:
47 * $button = new portfolio_add_button();
48 * $button->set_callback_options('name_of_caller_class', array('id' => 6), '/your/mod/lib.php');
49 * $button->render(PORTFOLIO_ADD_FULL_FORM, get_string('addeverythingtoportfolio', 'yourmodule'));
50 *
51 * or like this:
52 * $button = new portfolio_add_button(array('callbackclass' => 'name_of_caller_class', 'callbackargs' => array('id' => 6), 'callbackfile' => '/your/mod/lib.php'));
53 * $somehtml .= $button->to_html(PORTFOLIO_ADD_TEXT_LINK);
54 *
55 * See http://docs.moodle.org/en/Development:Adding_a_Portfolio_Button_to_a_page for more information
56 */
57 class portfolio_add_button {
59     private $alreadyexporting;
60     private $callbackclass;
61     private $callbackargs;
62     private $callbackfile;
63     private $formats;
64     private $instances;
66     /**
67     * constructor. either pass the options here or set them using the helper methods.
68     * generally the code will be clearer if you use the helper methods.
69     *
70     * @param array $options keyed array of options:
71     *                       key 'callbackclass': name of the caller class (eg forum_portfolio_caller')
72     *                       key 'callbackargs': the array of callback arguments your caller class wants passed to it in the constructor
73     *                       key 'callbackfile': the file containing the class definition of your caller class.
74     *                       See set_callback_options for more information on these three.
75     *                       key 'formats': an array of PORTFOLIO_FORMATS this caller will support
76     *                       See set_formats for more information on this.
77     */
78     public function __construct($options=null) {
79         global $SESSION, $CFG;
80         if (isset($SESSION->portfolioexport)) {
81             $this->alreadyexporting = true;
82             return;
83         }
84         $this->instances = portfolio_instances();
85         if (empty($options)) {
86             return true;
87         }
88         foreach ((array)$options as $key => $value) {
89             if (!in_array($key, $constructoroptions)) {
90                 throw new portfolio_button_exception('invalidbuttonproperty', 'portfolio', $key);
91             }
92             $this->{$key} = $value;
93         }
94     }
96     /*
97     * @param string $class   name of the class containing the callback functions
98     *                        activity modules should ALWAYS use their name_portfolio_caller
99     *                        other locations must use something unique
100     * @param mixed $argarray this can be an array or hash of arguments to pass
101     *                        back to the callback functions (passed by reference)
102     *                        these MUST be primatives to be added as hidden form fields.
103     *                        and the values get cleaned to PARAM_ALPHAEXT or PARAM_NUMBER or PARAM_PATH
104     * @param string $file    this can be autodetected if it's in the same file as your caller,
105     *                        but often, the caller is a script.php and the class in a lib.php
106     *                        so you can pass it here if necessary.
107     *                        this path should be relative (ie, not include) dirroot, eg '/mod/forum/lib.php'
108     */
109     public function set_callback_options($class, array $argarray, $file=null) {
110         if ($this->alreadyexporting) {
111             return;
112         }
113         global $CFG;
114         if (empty($file)) {
115             $backtrace = debug_backtrace();
116             if (!array_key_exists(0, $backtrace) || !array_key_exists('file', $backtrace[0]) || !is_readable($backtrace[0]['file'])) {
117                 throw new portfolio_button_exception('nocallbackfile', 'portfolio');
118             }
120             $file = substr($backtrace[0]['file'], strlen($CFG->dirroot));
121         } else if (!is_readable($CFG->dirroot . $file)) {
122             throw new portfolio_button_exception('nocallbackfile', 'portfolio', $file);
123         }
124         $this->callbackfile = $file;
125         require_once($CFG->dirroot . $file);
126         if (!class_exists($class)) {
127             throw new portfolio_button_exception('nocallbackclass', 'portfolio', $class);
128         }
130         // this will throw exceptions
131         // but should not actually do anything other than verify callbackargs
132         $test = new $class($argarray);
133         unset($test);
135         $this->callbackclass = $class;
136         $this->callbackargs = $argarray;
137     }
139     /*
140     * sets the available export formats for this content
141     * this function will also poll the static function in the caller class
142     * and make sure we're not overriding a format that has nothing to do with mimetypes
143     * eg if you pass IMAGE here but the caller can export LEAP it will keep LEAP as well.
144     * see portfolio_most_specific_formats for more information
145     *
146     * @param array $formats if the calling code knows better than the static method on the calling class (supported_formats)
147     *                       eg, if it's going to be a single file, or if you know it's HTML, you can pass it here instead
148     *                       this is almost always the case so you should always use this.
149     *                       {@see portfolio_format_from_file} for how to get the appropriate formats to pass here for uploaded files.
150     */
151     public function set_formats($formats=null) {
152         if ($this->alreadyexporting) {
153             return;
154         }
155         if (is_string($formats)) {
156             $formats = array($formats);
157         }
158         if (empty($formats)) {
159             $formats = array();
160         }
161         if (empty($this->callbackclass)) {
162             throw new portfolio_button_exception('noclassbeforeformats', 'portfolio');
163         }
164         $callerformats = call_user_func(array($this->callbackclass, 'supported_formats'));
165         $this->formats = portfolio_most_specific_formats($formats, $callerformats);
166     }
168     /*
169     * echo the form/button/icon/text link to the page
170     *
171     * @param int $format format to display the button or form or icon or link.
172     *                    See constants PORTFOLIO_ADD_XXX for more info.
173     *                    optional, defaults to PORTFOLI_ADD_FULL_FORM
174     * @param str $addstr string to use for the button or icon alt text or link text.
175     *                    this is whole string, not key.  optional, defaults to 'Add to portfolio';
176     */
177     public function render($format=null, $addstr=null) {
178         echo $this->to_html($format, $addstr);
179     }
181     /*
182     * returns the form/button/icon/text link as html
183     *
184     * @param int $format format to display the button or form or icon or link.
185     *                    See constants PORTFOLIO_ADD_XXX for more info.
186     *                    optional, defaults to PORTFOLI_ADD_FULL_FORM
187     * @param str $addstr string to use for the button or icon alt text or link text.
188     *                    this is whole string, not key.  optional, defaults to 'Add to portfolio';
189     */
190     public function to_html($format=null, $addstr=null) {
191         if ($this->alreadyexporting) {
192             return $this->already_exporting($format);
193         }
194         global $CFG, $COURSE;
195         if (!$this->is_renderable()) {
196             return;
197         }
198         if (empty($this->callbackclass) || empty($this->callbackfile)) {
199             throw new portfolio_button_exception('mustsetcallbackoptions', 'portfolio');
200         }
201         if (empty($this->formats)) {
202             // use the caller defaults
203             $this->set_formats();
204         }
205         $formoutput = '<form method="post" action="' . $CFG->wwwroot . '/portfolio/add.php" id="portfolio-add-button">' . "\n";
206         $linkoutput = '<a href="' . $CFG->wwwroot . '/portfolio/add.php?';
207         foreach ($this->callbackargs as $key => $value) {
208             if (!empty($value) && !is_string($value) && !is_numeric($value)) {
209                 $a->key = $key;
210                 $a->value = print_r($value, true);
211                 debugging(get_string('nonprimative', 'portfolio', $a));
212                 return;
213             }
214             $linkoutput .= 'ca_' . $key . '=' . $value . '&amp;';
215             $formoutput .= "\n" . '<input type="hidden" name="ca_' . $key . '" value="' . $value . '" />';
216         }
217         $formoutput .= "\n" . '<input type="hidden" name="callbackfile" value="' . $this->callbackfile . '" />';
218         $formoutput .= "\n" . '<input type="hidden" name="callbackclass" value="' . $this->callbackclass . '" />';
219         $formoutput .= "\n" . '<input type="hidden" name="course" value="' . (!empty($COURSE) ? $COURSE->id : 0) . '" />';
220         $linkoutput .= 'callbackfile=' . $this->callbackfile . '&amp;callbackclass='
221             . $this->callbackclass . '&amp;course=' . (!empty($COURSE) ? $COURSE->id : 0);
222         $selectoutput = '';
223         if (count($this->instances) == 1) {
224             $instance = array_shift($this->instances);
225             $formats = portfolio_supported_formats_intersect($this->formats, $instance->supported_formats());
226             if (count($formats) == 0) {
227                 // bail. no common formats.
228                 debugging(get_string('nocommonformats', 'portfolio', $this->callbackclass));
229                 return;
230             }
231             if ($error = portfolio_instance_sanity_check($instance)) {
232                 // bail, plugin is misconfigured
233                 debugging(get_string('instancemisconfigured', 'portfolio', get_string($error[$instance->get('id')], 'portfolio_' . $instance->get('plugin'))));
234                 return;
235             }
236             $formoutput .= "\n" . '<input type="hidden" name="instance" value="' . $instance->get('id') . '" />';
237             $linkoutput .= '&amp;instance=' . $instance->get('id');
238         }
239         else {
240             $selectoutput = portfolio_instance_select($this->instances, $this->formats, $this->callbackclass, 'instance', true);
241         }
243         if (empty($addstr)) {
244             $addstr = get_string('addtoportfolio', 'portfolio');
245         }
246         if (empty($format)) {
247             $format = PORTFOLIO_ADD_FULL_FORM;
248         }
249         switch ($format) {
250             case PORTFOLIO_ADD_FULL_FORM:
251                 $formoutput .= $selectoutput;
252                 $formoutput .= "\n" . '<input type="submit" value="' . $addstr .'" />';
253                 $formoutput .= "\n" . '</form>';
254             break;
255             case PORTFOLIO_ADD_ICON_FORM:
256                 $formoutput .= $selectoutput;
257                 $formoutput .= "\n" . '<input type="image" src="' . $CFG->pixpath . '/t/portfolio.gif" alt=' . $addstr .'" />';
258                 $formoutput .= "\n" . '</form>';
259             break;
260             case PORTFOLIO_ADD_ICON_LINK:
261                 $linkoutput .= '"><img src="' . $CFG->pixpath . '/t/portfolio.gif" alt=' . $addstr .'" /></a>';
262             break;
263             case PORTFOLIO_ADD_TEXT_LINK:
264                 $linkoutput .= '">' . $addstr .'</a>';
265             break;
266             default:
267                 debugging(get_string('invalidaddformat', 'portfolio', $format));
268         }
269         $output = (in_array($format, array(PORTFOLIO_ADD_FULL_FORM, PORTFOLIO_ADD_ICON_FORM)) ? $formoutput : $linkoutput);
270         return $output;
271     }
273     /**
274     * does some internal checks
275     * these are not errors, just situations
276     * where it's not appropriate to add the button
277     */
278     private function is_renderable() {
279         global $CFG;
280         if (empty($CFG->enableportfolios)) {
281             return false;
282         }
283         if (defined('PORTFOLIO_INTERNAL')) {
284             // something somewhere has detected a risk of this being called during inside the preparation
285             // eg forum_print_attachments
286             return false;
287         }
288         if (empty($this->instances) || count($this->instances) == 0) {
289             return false;
290         }
291         return true;
292     }
294     /**
295      * Getter for $format property
296      * @return array
297      */
298     public function get_formats() {
299         return $this->formats;
300     }
302     /**
303      * Getter for $callbackargs property
304      * @return array
305      */
306     public function get_callbackargs() {
307         return $this->callbackargs;
308     }
310     /**
311      * Getter for $callbackfile property
312      * @return array
313      */
314     public function get_callbackfile() {
315         return $this->callbackfile;
316     }
318     /**
319      * Getter for $callbackclass property
320      * @return array
321      */
322     public function get_callbackclass() {
323         return $this->callbackclass;
324     }
326     private function already_exporting($format) {
327         global $CFG;
328         $url  = $CFG->wwwroot . '/portfolio/already.php';
329         $icon = $CFG->pixpath . '/t/portfoliono.gif';
330         $alt  = get_string('alreadyalt', 'portfolio');
331         $text = get_string('alreadytext', 'portfolio');
332         if (empty($format)) {
333             $format = PORTFOLIO_ADD_FULL_FORM;
334         }
335         switch ($format) {
336             case PORTFOLIO_ADD_FULL_FORM:
337                 return '<form action="' . $url . '">' . "\n"
338                     . '<input type="submit" value="' . $text . '" />' . "\n"
339                     . ' </form>';
340             case PORTFOLIO_ADD_ICON_FORM:
341             case PORTFOLIO_ADD_ICON_LINK:
342                 return '<a href="' . $url . '"><img src="' . $icon . '" alt="' . $alt . '" /></a>';
343             case PORTFOLIO_ADD_TEXT_LINK:
344                 return '<a href="' . $url . '">' . $text . '</a>';
345             default:
346                 debugging(get_string('invalidaddformat', 'portfolio', $format));
347         }
348     }
351 /**
352 * returns a drop menu with a list of available instances.
354 * @param array    $instances     array of portfolio plugin instance objects - the instances to put in the menu
355 * @param array    $callerformats array of PORTFOLIO_FORMAT_XXX constants - the formats the caller supports (this is used to filter plugins)
356 * @param array    $callbackclass the callback class name - used for debugging only for when there are no common formats
357 * @param string   $selectname    the name of the select element. Optional, defaults to instance.
358 * @param boolean  $return        whether to print or return the output. Optional, defaults to print.
359 * @param booealn  $returnarray   if returning, whether to return the HTML or the array of options. Optional, defaults to HTML.
361 * @return string the html, from <select> to </select> inclusive.
362 */
363 function portfolio_instance_select($instances, $callerformats, $callbackclass, $selectname='instance', $return=false, $returnarray=false) {
364     global $CFG;
366     if (empty($CFG->enableportfolios)) {
367         return;
368     }
370     $insane = portfolio_instance_sanity_check();
371     $count = 0;
372     $selectoutput = "\n" . '<select name="' . $selectname . '">' . "\n";
373     foreach ($instances as $instance) {
374         $formats = portfolio_supported_formats_intersect($callerformats, $instance->supported_formats());
375         if (count($formats) == 0) {
376             // bail. no common formats.
377             continue;
378         }
379         if (array_key_exists($instance->get('id'), $insane)) {
380             // bail, plugin is misconfigured
381             debugging(get_string('instancemisconfigured', 'portfolio', get_string($insane[$instance->get('id')], 'portfolio_' . $instance->get('plugin'))));
382             continue;
383         }
384         $count++;
385         $selectoutput .= "\n" . '<option value="' . $instance->get('id') . '">' . $instance->get('name') . '</option>' . "\n";
386         $options[$instance->get('id')] = $instance->get('name');
387     }
388     if (empty($count)) {
389         // bail. no common formats.
390         debugging(get_string('nocommonformats', 'portfolio', $callbackclass));
391         return;
392     }
393     $selectoutput .= "\n" . "</select>\n";
394     if (!empty($returnarray)) {
395         return $options;
396     }
397     if (!empty($return)) {
398         return $selectoutput;
399     }
400     echo $selectoutput;
403 /**
404 * return all portfolio instances
406 * @todo check capabilities here - see MDL-15768
408 * @param boolean visibleonly Don't include hidden instances. Defaults to true and will be overridden to true if the next parameter is true
409 * @param boolean useronly    Check the visibility preferences and permissions of the logged in user. Defaults to true.
411 * @return array of portfolio instances (full objects, not just database records)
412 */
413 function portfolio_instances($visibleonly=true, $useronly=true) {
415     global $DB, $USER;
417     $values = array();
418     $sql = 'SELECT * FROM {portfolio_instance}';
420     if ($visibleonly || $useronly) {
421         $values[] = 1;
422         $sql .= ' WHERE visible = ?';
423     }
424     if ($useronly) {
425         $sql .= ' AND id NOT IN (
426                 SELECT instance FROM {portfolio_instance_user}
427                 WHERE userid = ? AND name = ? AND value = ?
428             )';
429         $values = array_merge($values, array($USER->id, 'visible', 0));
430     }
431     $sql .= ' ORDER BY name';
433     $instances = array();
434     foreach ($DB->get_records_sql($sql, $values) as $instance) {
435         $instances[$instance->id] = portfolio_instance($instance->id, $instance);
436     }
437     return $instances;
440 /**
441 * Supported formats currently in use.
443 * Canonical place for a list of all formats
444 * that portfolio plugins and callers
445 * can use for exporting content
447 * @return keyed array of all the available export formats (constant => classname)
448 */
449 function portfolio_supported_formats() {
450     return array(
451         PORTFOLIO_FORMAT_FILE  => 'portfolio_format_file',
452         PORTFOLIO_FORMAT_IMAGE => 'portfolio_format_image',
453         PORTFOLIO_FORMAT_HTML  => 'portfolio_format_html',
454         PORTFOLIO_FORMAT_TEXT  => 'portfolio_format_text',
455         PORTFOLIO_FORMAT_VIDEO => 'portfolio_format_video',
456         /*PORTFOLIO_FORMAT_MBKP, */ // later
457         /*PORTFOLIO_FORMAT_PIOP, */ // also later
458     );
461 /**
462 * Deduce export format from file mimetype
464 * This function returns the revelant portfolio export format
465 * which is used to determine which portfolio plugins can be used
466 * for exporting this content
467 * according to the mime type of the given file
468 * this only works when exporting exactly <b>one</b> file
470 * @param stored_file $file file to check mime type for
472 * @return string the format constant (see PORTFOLIO_FORMAT_XXX constants)
473 */
474 function portfolio_format_from_file(stored_file $file) {
475     static $alreadymatched;
476     if (empty($alreadymatched)) {
477         $alreadymatched = array();
478     }
479     if (!($file instanceof stored_file)) {
480         throw new portfolio_exception('invalidfileargument', 'portfolio');
481     }
482     $mimetype = $file->get_mimetype();
483     if (array_key_exists($mimetype, $alreadymatched)) {
484         return $alreadymatched[$mimetype];
485     }
486     $allformats = portfolio_supported_formats();
487     foreach ($allformats as $format => $classname) {
488         $supportedmimetypes = call_user_func(array($classname, 'mimetypes'));
489         if (!is_array($supportedmimetypes)) {
490             debugging("one of the portfolio format classes, $classname, said it supported something funny for mimetypes, should have been array...");
491             debugging(print_r($supportedmimetypes, true));
492             continue;
493         }
494         if (in_array($mimetype, $supportedmimetypes)) {
495             $alreadymatched[$mimetype] = $format;
496             return $format;
497         }
498     }
499     return PORTFOLIO_FORMAT_FILE; // base case for files...
502 /**
503 * Intersection of plugin formats and caller formats
505 * Walks both the caller formats and portfolio plugin formats
506 * and looks for matches (walking the hierarchy as well)
507 * and returns the intersection
509 * @param array $callerformats formats the caller supports
510 * @param array $pluginformats formats the portfolio plugin supports
511 */
512 function portfolio_supported_formats_intersect($callerformats, $pluginformats) {
513     $allformats = portfolio_supported_formats();
514     $intersection = array();
515     foreach ($callerformats as $cf) {
516         if (!array_key_exists($cf, $allformats)) {
517             debugging(get_string('invalidformat', 'portfolio', $cf));
518             continue;
519         }
520         $cfobj = new $allformats[$cf]();
521         foreach ($pluginformats as $p => $pf) {
522             if (!array_key_exists($pf, $allformats)) {
523                 debugging(get_string('invalidformat', 'portfolio', $pf));
524                 unset($pluginformats[$p]); // to avoid the same warning over and over
525                 continue;
526             }
527             if ($cfobj instanceof $allformats[$pf]) {
528                 $intersection[] = $cf;
529             }
530         }
531     }
532     return $intersection;
535 /**
536 * return the combination of the two arrays of formats with duplicates in terms of specificity removed
537 * use case: a module is exporting a single file, so the general formats would be FILE and MBKP
538 *           while the specific formats would be the specific subclass of FILE based on mime (say IMAGE)
539 *           and this function would return IMAGE and MBKP
541 * @param array $specificformats array of more specific formats (eg based on mime detection)
542 * @param array $generalformats  array of more general formats (usually more supported)
544 * @return array merged formats with dups removed
545 */
546 function portfolio_most_specific_formats($specificformats, $generalformats) {
547     $allformats = portfolio_supported_formats();
548     foreach ($specificformats as $f) {
549         // look for something less specific and remove it, ie outside of the inheritance tree of the current formats.
550         if (!array_key_exists($f, $allformats)) {
551             throw new portfolio_button_exception('invalidformat', 'portfolio', $f);
552         }
553         $fobj = new $allformats[$f];
554         foreach ($generalformats as $key => $cf) {
555             $cfclass = $allformats[$cf];
556             if ($fobj instanceof $cfclass) {
557                 unset($generalformats[$cf]);
558             }
559         }
560     }
561     return array_merge(array_values($specificformats), array_values($generalformats));
564 /**
565 * helper function to return an instance of a plugin (with config loaded)
567 * @param int   $instance id of instance
568 * @param array $record   database row that corresponds to this instance
569 *                        this is passed to avoid unnecessary lookups
570 *                        Optional, and the record will be retrieved if null.
572 * @return subclass of portfolio_plugin_base
573 */
574 function portfolio_instance($instanceid, $record=null) {
575     global $DB, $CFG;
577     if ($record) {
578         $instance  = $record;
579     } else {
580         if (!$instance = $DB->get_record('portfolio_instance', array('id' => $instanceid))) {
581             throw new portfolio_exception('invalidinstance', 'portfolio');
582         }
583     }
584     require_once($CFG->dirroot . '/portfolio/type/'. $instance->plugin . '/lib.php');
585     $classname = 'portfolio_plugin_' . $instance->plugin;
586     return new $classname($instanceid, $instance);
589 /**
590 * Helper function to call a static function on a portfolio plugin class
592 * This will figure out the classname and require the right file and call the function.
593 * you can send a variable number of arguments to this function after the first two
594 * and they will be passed on to the function you wish to call.
596 * @param string $plugin   name of plugin
597 * @param string $function function to call
598 */
599 function portfolio_static_function($plugin, $function) {
600     global $CFG;
602     $pname = null;
603     if (is_object($plugin) || is_array($plugin)) {
604         $plugin = (object)$plugin;
605         $pname = $plugin->name;
606     } else {
607         $pname = $plugin;
608     }
610     $args = func_get_args();
611     if (count($args) <= 2) {
612         $args = array();
613     }
614     else {
615         array_shift($args);
616         array_shift($args);
617     }
619     require_once($CFG->dirroot . '/portfolio/type/' . $plugin .  '/lib.php');
620     return call_user_func_array(array('portfolio_plugin_' . $plugin, $function), $args);
623 /**
624 * helper function to check all the plugins for sanity and set any insane ones to invisible.
626 * @param array $plugins to check (if null, defaults to all)
627 *               one string will work too for a single plugin.
629 * @return array array of insane instances (keys= id, values = reasons (keys for plugin lang)
630 */
631 function portfolio_plugin_sanity_check($plugins=null) {
632     global $DB;
633     if (is_string($plugins)) {
634        $plugins = array($plugins);
635     } else if (empty($plugins)) {
636         $plugins = get_list_of_plugins('portfolio/type');
637     }
639     $insane = array();
640     foreach ($plugins as $plugin) {
641         if ($result = portfolio_static_function($plugin, 'plugin_sanity_check')) {
642             $insane[$plugin] = $result;
643         }
644     }
645     if (empty($insane)) {
646         return array();
647     }
648     list($where, $params) = $DB->get_in_or_equal(array_keys($insane));
649     $where = ' plugin ' . $where;
650     $DB->set_field_select('portfolio_instance', 'visible', 0, $where, $params);
651     return $insane;
654 /**
655 * helper function to check all the instances for sanity and set any insane ones to invisible.
657 * @param array $instances to check (if null, defaults to all)
658 *              one instance or id will work too
660 * @return array array of insane instances (keys= id, values = reasons (keys for plugin lang)
661 */
662 function portfolio_instance_sanity_check($instances=null) {
663     global $DB;
664     if (empty($instances)) {
665         $instances = portfolio_instances(false);
666     } else if (!is_array($instances)) {
667         $instances = array($instances);
668     }
670     $insane = array();
671     foreach ($instances as $instance) {
672         if (is_object($instance) && !($instance instanceof portfolio_plugin_base)) {
673             $instance = portfolio_instance($instance->id, $instance);
674         } else if (is_numeric($instance)) {
675             $instance = portfolio_instance($instance);
676         }
677         if (!($instance instanceof portfolio_plugin_base)) {
678             debugging('something weird passed to portfolio_instance_sanity_check, not subclass or id');
679             continue;
680         }
681         if ($result = $instance->instance_sanity_check()) {
682             $insane[$instance->get('id')] = $result;
683         }
684     }
685     if (empty($insane)) {
686         return array();
687     }
688     list ($where, $params) = $DB->get_in_or_equal(array_keys($insane));
689     $where = ' id ' . $where;
690     $DB->set_field_select('portfolio_instance', 'visible', 0, $where, $params);
691     return $insane;
694 /**
695 * helper function to display a table of plugins (or instances) and reasons for disabling
697 * @param array $insane array of insane plugins (key = plugin (or instance id), value = reason)
698 * @param array $instances if reporting instances rather than whole plugins, pass the array (key = id, value = object) here
700 */
701 function portfolio_report_insane($insane, $instances=false, $return=false) {
702     if (empty($insane)) {
703         return;
704     }
706     static $pluginstr;
707     if (empty($pluginstr)) {
708         $pluginstr = get_string('plugin', 'portfolio');
709     }
710     if ($instances) {
711         $headerstr = get_string('someinstancesdisabled', 'portfolio');
712     } else {
713         $headerstr = get_string('somepluginsdisabled', 'portfolio');
714     }
716     $output = notify($headerstr, 'notifyproblem', 'center', true);
717     $table = new StdClass;
718     $table->head = array($pluginstr, '');
719     $table->data = array();
720     foreach ($insane as $plugin => $reason) {
721         if ($instances) {
722             $instance = $instances[$plugin];
723             $plugin   = $instance->get('plugin');
724             $name     = $instance->get('name');
725         } else {
726             $name = $plugin;
727         }
728         $table->data[] = array($name, get_string($reason, 'portfolio_' . $plugin));
729     }
730     $output .= print_table($table, true);
731     $output .= '<br /><br /><br />';
733     if ($return) {
734         return $output;
735     }
736     echo $output;
739 /**
740 * fake the url to portfolio/add.php from data from somewhere else
741 * you should use portfolio_add_button instead 99% of the time
743 * @param int    $instanceid   instanceid (optional, will force a new screen if not specified)
744 * @param string $classname    callback classname
745 * @param string $classfile    file containing the callback class definition
746 * @param array  $callbackargs arguments to pass to the callback class
747 */
748 function portfolio_fake_add_url($instanceid, $classname, $classfile, $callbackargs) {
749     global $CFG;
750     $url = $CFG->wwwroot . '/portfolio/add.php?instance=' . $instanceid . '&amp;callbackclass=' . $classname . '&amp;callbackfile=' . $classfile;
752     if (is_object($callbackargs)) {
753         $callbackargs = (array)$callbackargs;
754     }
755     if (!is_array($callbackargs) || empty($callbackargs)) {
756         return $url;
757     }
758     foreach ($callbackargs as $key => $value) {
759         $url .= '&amp;ca_' . $key . '=' . urlencode($value);
760     }
761     return $url;
766 /**
767 * event handler for the portfolio_send event
768 */
769 function portfolio_handle_event($eventdata) {
770     global $CFG;
771     $exporter = portfolio_exporter::rewaken_object($eventdata);
772     $exporter->process_stage_package();
773     $exporter->process_stage_send();
774     $exporter->save();
775     $exporter->process_stage_cleanup();
776     return true;
779 /**
780 * main portfolio cronjob
781 * currently just cleans up expired transfer records.
783 * @todo add hooks in the plugins - either per instance or per plugin
784 */
785 function portfolio_cron() {
786     global $DB;
788     if ($expired = $DB->get_records_select('portfolio_tempdata', 'expirytime < ?', array(time()), '', 'id')) {
789         foreach ($expired as $d) {
790             $e = portfolio_exporter::rewaken_object($d);
791             $e->process_stage_cleanup(true);
792         }
793     }
796 /**
797 * helper function to rethrow a caught portfolio_exception as an export exception
799 * used because when a portfolio_export exception is thrown the export is cancelled
801 * @param portfolio_exporter $exporter  current exporter object
802 * @param exception          $exception exception to rethrow
804 * @return void
805 * @throws portfolio_export_exceptiog
806 */
807 function portfolio_export_rethrow_exception($exporter, $exception) {
808     throw new portfolio_export_exception($exporter, $exception->errorcode, $exception->module, $exception->link, $exception->a);
811 /**
812 * try and determine expected_time for purely file based exports
813 * or exports that might include large file attachments.
815 * @param mixed $totest - either an array of stored_file objects or a single stored_file object
817 * @return constant PORTFOLIO_TIME_XXX
818 */
819 function portfolio_expected_time_file($totest) {
820     global $CFG;
821     if ($totest instanceof stored_file) {
822         $totest = array($totest);
823     }
824     $size = 0;
825     foreach ($totest as $file) {
826         if (!($file instanceof stored_file)) {
827             debugging('something weird passed to portfolio_expected_time_file - not stored_file object');
828             debugging(print_r($file, true));
829             continue;
830         }
831         $size += $file->get_filesize();
832     }
834     $fileinfo = portfolio_filesize_info();
836     $moderate = $high = 0; // avoid warnings
838     foreach (array('moderate', 'high') as $setting) {
839         $settingname = 'portfolio_' . $setting . '_filesize_threshold';
840         if (empty($CFG->{$settingname}) || !array_key_exists($CFG->{$settingname}, $fileinfo['options'])) {
841             debugging("weird or unset admin value for $settingname, using default instead");
842             $$setting = $fileinfo[$setting];
843         } else {
844             $$setting = $CFG->{$settingname};
845         }
846     }
848     if ($size < $moderate) {
849         return PORTFOLIO_TIME_LOW;
850     } else if ($size < $high) {
851         return PORTFOLIO_TIME_MODERATE;
852     }
853     return PORTFOLIO_TIME_HIGH;
857 /**
858 * the default filesizes and threshold information for file based transfers
859 * this shouldn't need to be used outside the admin pages and the portfolio code
860 */
861 function portfolio_filesize_info() {
862     $filesizes = array();
863     $sizelist = array(10240, 51200, 102400, 512000, 1048576, 2097152, 5242880, 10485760, 20971520, 52428800);
864     foreach ($sizelist as $size) {
865         $filesizes[$size] = display_size($size);
866     }
867     return array(
868         'options' => $filesizes,
869         'moderate' => 1048576,
870         'high'     => 5242880,
871     );
874 /**
875 * try and determine expected_time for purely database based exports
876 * or exports that might include large parts of a database
878 * @param integer $recordcount - number of records trying to export
880 * @return constant PORTFOLIO_TIME_XXX
881 */
882 function portfolio_expected_time_db($recordcount) {
883     global $CFG;
885     if (empty($CFG->portfolio_moderate_dbsize_threshold)) {
886         set_config('portfolio_moderate_dbsize_threshold', 10);
887     }
888     if (empty($CFG->portfolio_high_dbsize_threshold)) {
889         set_config('portfolio_high_dbsize_threshold', 50);
890     }
891     if ($recordcount < $CFG->portfolio_moderate_dbsize_threshold) {
892         return PORTFOLIO_TIME_LOW;
893     } else if ($recordcount < $CFG->portfolio_high_dbsize_threshold) {
894         return PORTFOLIO_TIME_MODERATE;
895     }
896     return PORTFOLIO_TIME_HIGH;
899 ?>