2fa26738237257f547066715155a04f9bcb0f2fc
[moodle.git] / lib / form / filepicker.php
1 <?php
3 global $CFG;
5 require_once("HTML/QuickForm/button.php");
6 require_once($CFG->dirroot.'/repository/lib.php');
8 /**
9  * HTML class for a single filepicker element (based on button)
10  *
11  * @author       Moodle.com
12  * @version      1.0
13  * @since        Moodle 2.0
14  * @access       public
15  */
16 class MoodleQuickForm_filepicker extends HTML_QuickForm_input {
17     public $_helpbutton = '';
18     protected $_options    = array('maxbytes'=>0, 'accepted_types'=>'*', 'return_types'=>FILE_INTERNAL);
20     function MoodleQuickForm_filepicker($elementName=null, $elementLabel=null, $attributes=null, $options=null) {
21         global $CFG;
23         $options = (array)$options;
24         foreach ($options as $name=>$value) {
25             if (array_key_exists($name, $this->_options)) {
26                 $this->_options[$name] = $value;
27             }
28         }
29         if (!empty($options['maxbytes'])) {
30             $this->_options['maxbytes'] = get_max_upload_file_size($CFG->maxbytes, $options['maxbytes']);
31         }
32         parent::HTML_QuickForm_input($elementName, $elementLabel, $attributes);
33     }
35     function setHelpButton($helpbuttonargs, $function='helpbutton') {
36         debugging('component setHelpButton() is not used any more, please use $mform->setHelpButton() instead');
37     }
39     function getHelpButton() {
40         return $this->_helpbutton;
41     }
43     function getElementTemplateType() {
44         if ($this->_flagFrozen){
45             return 'nodisplay';
46         } else {
47             return 'default';
48         }
49     }
51     function toHtml() {
52         global $CFG, $COURSE, $USER, $PAGE, $OUTPUT;
53         $id     = $this->_attributes['id'];
54         $elname = $this->_attributes['name'];
56         if ($this->_flagFrozen) {
57             return $this->getFrozenHtml();
58         }
59         if (!$draftitemid = (int)$this->getValue()) {
60             // no existing area info provided - let's use fresh new draft area
61             $draftitemid = file_get_unused_draft_itemid();
62             $this->setValue($draftitemid);
63         }
65         if ($COURSE->id == SITEID) {
66             $context = get_context_instance(CONTEXT_SYSTEM);
67         } else {
68             $context = get_context_instance(CONTEXT_COURSE, $COURSE->id);
69         }
71         $client_id = uniqid();
73         $args = new stdClass();
74         // need these three to filter repositories list
75         $args->accepted_types = $this->_options['accepted_types']?$this->_options['accepted_types']:'*';
76         $args->return_types = FILE_INTERNAL;
77         $args->itemid = $draftitemid;
78         $args->maxbytes = $this->_options['maxbytes'];
79         $args->context = $PAGE->context;
81         $html = $this->_getTabs();
82         $fp = new file_picker($args);
83         $options = $fp->options;
84         $options->context = $PAGE->context;
85         $html .= $OUTPUT->render($fp);
86         $html .= '<input type="hidden" name="'.$elname.'" id="'.$id.'" value="'.$draftitemid.'" />';
88         $module = array('name'=>'form_filepicker', 'fullpath'=>'/lib/form/filepicker.js', 'requires'=>array('core_filepicker'));
89         $PAGE->requires->js_init_call('M.form_filepicker.init', array($fp->options), true, $module);
91         $nonjsfilepicker = new moodle_url('/repository/draftfiles_manager.php', array(
92             'env'=>'filepicker',
93             'action'=>'browse',
94             'itemid'=>$draftitemid,
95             'subdirs'=>0,
96             'maxbytes'=>$options->maxbytes,
97             'maxfiles'=>1,
98             'ctx_id'=>$PAGE->context->id,
99             'course'=>$PAGE->course->id,
100             'sesskey'=>sesskey(),
101             ));
103         // non js file picker
104         $html .= '<noscript>';
105         $html .= "<div><object type='text/html' data='$nonjsfilepicker' height='160' width='600' style='border:1px solid #000'></object></div>";
106         $html .= '</noscript>';
108         return $html;
109     }
111     function exportValue(&$submitValues, $assoc = false) {
112         global $USER;
114         // make sure max one file is present and it is not too big
115         if ($draftitemid = $submitValues[$this->_attributes['name']]) {
116             $fs = get_file_storage();
117             $usercontext = get_context_instance(CONTEXT_USER, $USER->id);
118             if ($files = $fs->get_area_files($usercontext->id, 'user', 'draft', $draftitemid, 'id DESC', false)) {
119                 $file = array_shift($files);
120                 if ($this->_options['maxbytes'] and $file->get_filesize() > $this->_options['maxbytes']) {
121                     // bad luck, somebody tries to sneak in oversized file
122                     $file->delete();
123                 }
124                 foreach ($files as $file) {
125                     // only one file expected
126                     $file->delete();
127                 }
128             }
129         }
131         return array($this->_attributes['name'] => $submitValues[$this->_attributes['name']]);
132     }