240aeb976d367ff26a8ef76da6ddf6564f8bea8c
[moodle.git] / lib / portfolio / caller.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 the base classes that are extended to create portfolio export functionality.
19  *
20  * For places in moodle that want to
21  * add export functionality to subclass from {@link http://docs.moodle.org/dev/Adding_a_Portfolio_Button_to_a_page}
22  *
23  * @package core_portfolio
24  * @copyright 2008 Penny Leach <penny@catalyst.net.nz>, Martin Dougiamas
25  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26  */
28 defined('MOODLE_INTERNAL') || die();
30 /**
31  * Base class for callers
32  *
33  * {@link See http://docs.moodle.org/dev/Adding_a_Portfolio_Button_to_a_page}
34  * {@see also portfolio_module_caller_base}
35  *
36  * @package core_portfolio
37  * @category portfolio
38  * @copyright 2008 Penny Leach <penny@catalyst.net.nz>
39  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
40  */
41 abstract class portfolio_caller_base {
43     /** @var stdClass course active during the call */
44     protected $course;
46     /** @var array configuration used for export. Use {@see  set_export_config} and {@see get_export_config} to access */
47     protected $exportconfig = array();
49     /** @var stdclass user currently exporting content */
50     protected $user;
52     /** @var stdClass a reference to the exporter object */
53     protected $exporter;
55     /** @var array can be optionally overridden by subclass constructors */
56     protected $supportedformats;
58     /** @var stored_file single file exports configuration*/
59     protected $singlefile;
61     /** @var stored_file|object set this for multi file exports */
62     protected $multifiles;
64     /** @var string set this for generated-file exports */
65     protected $intendedmimetype;
67     /**
68      * Create portfolio_caller object
69      *
70      * @param array $callbackargs argument properties
71      */
72     public function __construct($callbackargs) {
73         $expected = call_user_func(array(get_class($this), 'expected_callbackargs'));
74         foreach ($expected as $key => $required) {
75             if (!array_key_exists($key, $callbackargs)) {
76                 if ($required) {
77                     $a = (object)array('arg' => $key, 'class' => get_class($this));
78                     throw new portfolio_caller_exception('missingcallbackarg', 'portfolio', null, $a);
79                 }
80                 continue;
81             }
82             $this->{$key} = $callbackargs[$key];
83         }
84     }
86     /**
87      * If this caller wants any additional config items,
88      * they should be defined here.
89      *
90      * @param moodleform $mform passed by reference, add elements to it.
91      * @param portfolio_plugin_base $instance subclass of portfolio_plugin_base
92      */
93     public function export_config_form(&$mform, $instance) {}
96     /**
97      * Whether this caller wants any additional
98      * config during export (eg options or metadata)
99      *
100      * @return bool
101      */
102     public function has_export_config() {
103         return false;
104     }
106     /**
107      * Just like the moodle form validation function,
108      * this is passed in the data array from the form
109      * and if a non empty array is returned, form processing will stop.
110      *
111      * @param array $data data from form.
112      */
113     public function export_config_validation($data) {}
115     /**
116      * How long does this reasonably expect to take..
117      * Should we offer the user the option to wait..?
118      * This is deliberately nonstatic so it can take filesize into account
119      * the portfolio plugin can override this.
120      * (so for example even if a huge file is being sent,
121      * the download portfolio plugin doesn't care )
122      */
123     public abstract function expected_time();
125     /**
126      * Helper method to calculate expected time for multi or single file exports
127      *
128      * @return string file time expectation
129      */
130     public function expected_time_file() {
131         if ($this->multifiles) {
132             return portfolio_expected_time_file($this->multifiles);
133         }
134         else if ($this->singlefile) {
135             return portfolio_expected_time_file($this->singlefile);
136         }
137         return PORTFOLIO_TIME_LOW;
138     }
140     /**
141      * Function to build navigation
142      */
143     public abstract function get_navigation();
145     /**
146      * Helper function to get sha1
147      */
148     public abstract function get_sha1();
150     /**
151      * Helper function to calculate the sha1 for multi or single file exports
152      *
153      * @return string sha1 file exports
154      */
155     public function get_sha1_file() {
156         if (empty($this->singlefile) && empty($this->multifiles)) {
157             throw new portfolio_caller_exception('invalidsha1file', 'portfolio', $this->get_return_url());
158         }
159         if ($this->singlefile) {
160             return $this->singlefile->get_contenthash();
161         }
162         $sha1s = array();
163         foreach ($this->multifiles as $file) {
164             $sha1s[] = $file->get_contenthash();
165         }
166         asort($sha1s);
167         return sha1(implode('', $sha1s));
168     }
170     /**
171      * Generic getter for properties belonging to this instance
172      * <b>outside</b> the subclasses
173      * like name, visible etc.
174      *
175      * @param string $field property's name
176      * @return mixed
177      * @throws portfolio_export_exception
178      */
179     public function get($field) {
180         if (property_exists($this, $field)) {
181             return $this->{$field};
182         }
183         $a = (object)array('property' => $field, 'class' => get_class($this));
184         throw new portfolio_export_exception($this->get('exporter'), 'invalidproperty', 'portfolio', $this->get_return_url(), $a);
185     }
187     /**
188      * Generic setter for properties belonging to this instance
189      * <b>outside</b> the subclass
190      * like name, visible, etc.
191      *
192      * @param string $field property's name
193      * @param mixed $value property's value
194      * @return bool
195      * @throws moodle_exception
196      */
197     public final function set($field, &$value) {
198         if (property_exists($this, $field)) {
199             $this->{$field} =& $value;
200             $this->dirty = true;
201             return true;
202         }
203         $a = (object)array('property' => $field, 'class' => get_class($this));
204         throw new portfolio_export_exception($this->get('exporter'), 'invalidproperty', 'portfolio', $this->get_return_url(), $a);
205     }
207     /**
208      * Stores the config generated at export time.
209      * Subclasses can retrieve values using
210      * {@see get_export_config}
211      *
212      * @param array $config formdata
213      */
214     public final function set_export_config($config) {
215         $allowed = array_merge(
216             array('wait', 'hidewait', 'format', 'hideformat'),
217             $this->get_allowed_export_config()
218         );
219         foreach ($config as $key => $value) {
220             if (!in_array($key, $allowed)) {
221                 $a = (object)array('property' => $key, 'class' => get_class($this));
222                 throw new portfolio_export_exception($this->get('exporter'), 'invalidexportproperty', 'portfolio', $this->get_return_url(), $a);
223             }
224             $this->exportconfig[$key] = $value;
225         }
226     }
228     /**
229      * Returns a particular export config value.
230      * Subclasses shouldn't need to override this
231      *
232      * @param string $key the config item to fetch
233      * @return null|mixed of export configuration
234      */
235     public final function get_export_config($key) {
236         $allowed = array_merge(
237             array('wait', 'hidewait', 'format', 'hideformat'),
238             $this->get_allowed_export_config()
239         );
240         if (!in_array($key, $allowed)) {
241             $a = (object)array('property' => $key, 'class' => get_class($this));
242             throw new portfolio_export_exception($this->get('exporter'), 'invalidexportproperty', 'portfolio', $this->get_return_url(), $a);
243         }
244         if (!array_key_exists($key, $this->exportconfig)) {
245             return null;
246         }
247         return $this->exportconfig[$key];
248     }
250     /**
251      * Similar to the other allowed_config functions
252      * if you need export config, you must provide
253      * a list of what the fields are.
254      * Even if you want to store stuff during export
255      * without displaying a form to the user,
256      * you can use this.
257      *
258      * @return array array of allowed keys
259      */
260     public function get_allowed_export_config() {
261         return array();
262     }
264     /**
265      * After the user submits their config,
266      * they're given a confirm screen
267      * summarising what they've chosen.
268      * This function should return a table of nice strings => values
269      * of what they've chosen
270      * to be displayed in a table.
271      *
272      * @return bool
273      */
274     public function get_export_summary() {
275         return false;
276     }
278     /**
279      * Called before the portfolio plugin gets control.
280      * This function should copy all the files it wants to
281      * the temporary directory, using {@see copy_existing_file}
282      * or {@see write_new_file}
283      */
284     public abstract function prepare_package();
286     /**
287      * Helper function to copy files into the temp area
288      * for single or multi file exports.
289      *
290      * @return stored_file|bool
291      */
292     public function prepare_package_file() {
293         if (empty($this->singlefile) && empty($this->multifiles)) {
294             throw new portfolio_caller_exception('invalidpreparepackagefile', 'portfolio', $this->get_return_url());
295         }
296         if ($this->singlefile) {
297             return $this->exporter->copy_existing_file($this->singlefile);
298         }
299         foreach ($this->multifiles as $file) {
300             $this->exporter->copy_existing_file($file);
301         }
302     }
304     /**
305      * Array of formats this caller supports.
306      *
307      * @return array list of formats
308      */
309     public final function supported_formats() {
310         $basic = $this->base_supported_formats();
311         if (empty($this->supportedformats)) {
312             $specific = array();
313         } else if (!is_array($this->supportedformats)) {
314             debugging(get_class($this) . ' has set a non array value of member variable supported formats - working around but should be fixed in code');
315             $specific = array($this->supportedformats);
316         } else {
317             $specific = $this->supportedformats;
318         }
319         return portfolio_most_specific_formats($specific, $basic);
320     }
322     /**
323      * Base supported formats
324      *
325      * @throws coding_exception
326      */
327     public static function base_supported_formats() {
328         throw new coding_exception('base_supported_formats() method needs to be overridden in each subclass of portfolio_caller_base');
329     }
331     /**
332      * This is the "return to where you were" url
333      */
334     public abstract function get_return_url();
336     /**
337      * Callback to do whatever capability checks required
338      * in the caller (called during the export process
339      */
340     public abstract function check_permissions();
342     /**
343      * Clean name to display to the user about this caller location
344      */
345     public static function display_name() {
346         throw new coding_exception('display_name() method needs to be overridden in each subclass of portfolio_caller_base');
347     }
349     /**
350      * Return a string to put at the header summarising this export.
351      * By default, it just display the name (usually just 'assignment' or something unhelpful
352      *
353      * @return string
354      */
355     public function heading_summary() {
356         return get_string('exportingcontentfrom', 'portfolio', $this->display_name());
357     }
359     /**
360      * Load data
361      */
362     public abstract function load_data();
364     /**
365      * Set up the required files for this export.
366      * This supports either passing files directly
367      * or passing area arguments directly through
368      * to the files api using file_storage::get_area_files
369      *
370      * @param mixed $ids one of:
371      *                   - single file id
372      *                   - single stored_file object
373      *                   - array of file ids or stored_file objects
374      *                   - null
375      * @return void
376      */
377     public function set_file_and_format_data($ids=null /* ..pass arguments to area files here. */) {
378         $args = func_get_args();
379         array_shift($args); // shift off $ids
380         if (empty($ids) && count($args) == 0) {
381             return;
382         }
383         $files = array();
384         $fs = get_file_storage();
385         if (!empty($ids)) {
386             if (is_numeric($ids) || $ids instanceof stored_file) {
387                 $ids = array($ids);
388             }
389             foreach ($ids as $id) {
390                 if ($id instanceof stored_file) {
391                     $files[] = $id;
392                 } else {
393                     $files[] = $fs->get_file_by_id($id);
394                 }
395             }
396         } else if (count($args) != 0) {
397             if (count($args) < 4) {
398                 throw new portfolio_caller_exception('invalidfileareaargs', 'portfolio');
399             }
400             $files = array_values(call_user_func_array(array($fs, 'get_area_files'), $args));
401         }
402         switch (count($files)) {
403             case 0: return;
404             case 1: {
405                 $this->singlefile = $files[0];
406                 return;
407             }
408             default: {
409                 $this->multifiles = $files;
410             }
411         }
412     }
414     /**
415      * The button-location always knows best
416      * what the formats are... so it should be trusted.
417      *
418      * @todo MDL-31298 - re-analyze set_formats_from_button comment
419      * @param array $formats array of PORTFOLIO_FORMAT_XX
420      * @return void
421      */
422     public function set_formats_from_button($formats) {
423         $base = $this->base_supported_formats();
424         if (count($base) != count($formats)
425                 || count($base) != count(array_intersect($base, $formats))) {
426                 $this->supportedformats = portfolio_most_specific_formats($formats, $base);
427                 return;
428         }
429         // in the case where the button hasn't actually set anything,
430         // we need to run through again and resolve conflicts
431         // TODO revisit this comment - it looks to me like it's lying
432         $this->supportedformats = portfolio_most_specific_formats($formats, $formats);
433     }
435     /**
436      * Adds a new format to the list of supported formats.
437      * This functions also handles removing conflicting and less specific
438      * formats at the same time.
439      *
440      * @param string $format one of PORTFOLIO_FORMAT_XX
441      * @return void
442      */
443     protected function add_format($format) {
444         if (in_array($format, $this->supportedformats)) {
445             return;
446         }
447         $this->supportedformats = portfolio_most_specific_formats(array($format), $this->supportedformats);
448     }
450     /**
451      * Gets mimetype
452      *
453      * @return string
454      */
455     public function get_mimetype() {
456         if ($this->singlefile instanceof stored_file) {
457             return $this->singlefile->get_mimetype();
458         } else if (!empty($this->intendedmimetype)) {
459             return $this->intendedmimetype;
460         }
461     }
463     /**
464      * Array of arguments the caller expects to be passed through to it.
465      * This must be keyed on the argument name, and the array value is a boolean,
466      * whether it is required, or just optional
467      * eg array(
468      *     id            => true,
469      *     somethingelse => false
470      * )
471      */
472     public static function expected_callbackargs() {
473         throw new coding_exception('expected_callbackargs() method needs to be overridden in each subclass of portfolio_caller_base');
474     }
477     /**
478      * Return the context for this export. used for $PAGE->set_context
479      *
480      * @param moodle_page $PAGE global page object
481      */
482     public abstract function set_context($PAGE);
485 /**
486  * Base class for module callers.
487  * This just implements a few of the abstract functions
488  * from portfolio_caller_base so that caller authors
489  * don't need to.
490  * {@link http://docs.moodle.org/dev/Adding_a_Portfolio_Button_to_a_page}
491  * {@see also portfolio_caller_base}
492  *
493  * @package core_portfolio
494  * @category portfolio
495  * @copyright 2008 Penny Leach <penny@catalyst.net.nz>
496  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
497  */
498 abstract class portfolio_module_caller_base extends portfolio_caller_base {
500     /** @var object coursemodule object. set this in the constructor like $this->cm = get_coursemodule_from_instance('forum', $this->forum->id); */
501     protected $cm;
503     /** @var int cmid */
504     protected $id;
506     /** @var stdclass course object */
507     protected $course;
509     /**
510      * Navigation passed to print_header.
511      * Override this to do something more specific than the module view page
512      *
513      * @return array
514      */
515     public function get_navigation() {
516         $extranav = array('name' => $this->cm->name, 'link' => $this->get_return_url());
517         return array($extranav, $this->cm);
518     }
520     /**
521      * The url to return to after export or on cancel.
522      * Defaults value is set to the module 'view' page.
523      * Override this if it's deeper inside the module.
524      *
525      * @return string
526      */
527     public function get_return_url() {
528         global $CFG;
529         return $CFG->wwwroot . '/mod/' . $this->cm->modname . '/view.php?id=' . $this->cm->id;
530     }
532     /**
533      * Override the parent get function
534      * to make sure when we're asked for a course,
535      * We retrieve the object from the database as needed.
536      *
537      * @param string $key the name of get function
538      * @return stdClass
539      */
540     public function get($key) {
541         if ($key != 'course') {
542             return parent::get($key);
543         }
544         global $DB;
545         if (empty($this->course)) {
546             $this->course = $DB->get_record('course', array('id' => $this->cm->course));
547         }
548         return $this->course;
549     }
551     /**
552      * Return a string to put at the header summarising this export.
553      * by default, this function just display the name and module instance name.
554      * Override this to do something more specific
555      *
556      * @return string
557      */
558     public function heading_summary() {
559         return get_string('exportingcontentfrom', 'portfolio', $this->display_name() . ': ' . $this->cm->name);
560     }
562     /**
563      * Overridden to return the course module context
564      *
565      * @param moodle_page $PAGE global PAGE
566      */
567     public function set_context($PAGE) {
568         $PAGE->set_cm($this->cm);
569     }