MDL-29766 Add drag and drop upload to filemanager / filepicker elements
[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         $this->_type = 'filepicker';
33         parent::HTML_QuickForm_input($elementName, $elementLabel, $attributes);
34     }
36     function setHelpButton($helpbuttonargs, $function='helpbutton') {
37         debugging('component setHelpButton() is not used any more, please use $mform->setHelpButton() instead');
38     }
40     function getHelpButton() {
41         return $this->_helpbutton;
42     }
44     function getElementTemplateType() {
45         if ($this->_flagFrozen){
46             return 'nodisplay';
47         } else {
48             return 'default';
49         }
50     }
52     function toHtml() {
53         global $CFG, $COURSE, $USER, $PAGE, $OUTPUT;
54         $id     = $this->_attributes['id'];
55         $elname = $this->_attributes['name'];
57         if ($this->_flagFrozen) {
58             return $this->getFrozenHtml();
59         }
60         if (!$draftitemid = (int)$this->getValue()) {
61             // no existing area info provided - let's use fresh new draft area
62             $draftitemid = file_get_unused_draft_itemid();
63             $this->setValue($draftitemid);
64         }
66         if ($COURSE->id == SITEID) {
67             $context = get_context_instance(CONTEXT_SYSTEM);
68         } else {
69             $context = get_context_instance(CONTEXT_COURSE, $COURSE->id);
70         }
72         $client_id = uniqid();
74         $args = new stdClass();
75         // need these three to filter repositories list
76         $args->accepted_types = $this->_options['accepted_types']?$this->_options['accepted_types']:'*';
77         $args->return_types = FILE_INTERNAL;
78         $args->itemid = $draftitemid;
79         $args->maxbytes = $this->_options['maxbytes'];
80         $args->context = $PAGE->context;
81         $args->buttonname = $elname.'choose';
82         $args->elementname = $elname;
84         $html = $this->_getTabs();
85         $fp = new file_picker($args);
86         $options = $fp->options;
87         $options->context = $PAGE->context;
88         $html .= $OUTPUT->render($fp);
89         $html .= '<input type="hidden" name="'.$elname.'" id="'.$id.'" value="'.$draftitemid.'" class="filepickerhidden"/>';
91         $module = array('name'=>'form_filepicker', 'fullpath'=>'/lib/form/filepicker.js', 'requires'=>array('core_filepicker', 'node', 'node-event-simulate', 'core_dndupload'));
92         $PAGE->requires->js_init_call('M.form_filepicker.init', array($fp->options), true, $module);
94         $nonjsfilepicker = new moodle_url('/repository/draftfiles_manager.php', array(
95             'env'=>'filepicker',
96             'action'=>'browse',
97             'itemid'=>$draftitemid,
98             'subdirs'=>0,
99             'maxbytes'=>$options->maxbytes,
100             'maxfiles'=>1,
101             'ctx_id'=>$PAGE->context->id,
102             'course'=>$PAGE->course->id,
103             'sesskey'=>sesskey(),
104             ));
106         // non js file picker
107         $html .= '<noscript>';
108         $html .= "<div><object type='text/html' data='$nonjsfilepicker' height='160' width='600' style='border:1px solid #000'></object></div>";
109         $html .= '</noscript>';
111         return $html;
112     }
114     function exportValue(&$submitValues, $assoc = false) {
115         global $USER;
117         $draftitemid = $this->_findValue($submitValues);
118         if (null === $draftitemid) {
119             $draftitemid = $this->getValue();
120         }
122         // make sure max one file is present and it is not too big
123         if (!is_null($draftitemid)) {
124             $fs = get_file_storage();
125             $usercontext = get_context_instance(CONTEXT_USER, $USER->id);
126             if ($files = $fs->get_area_files($usercontext->id, 'user', 'draft', $draftitemid, 'id DESC', false)) {
127                 $file = array_shift($files);
128                 if ($this->_options['maxbytes'] and $file->get_filesize() > $this->_options['maxbytes']) {
129                     // bad luck, somebody tries to sneak in oversized file
130                     $file->delete();
131                 }
132                 foreach ($files as $file) {
133                     // only one file expected
134                     $file->delete();
135                 }
136             }
137         }
139         return $this->_prepareValue($draftitemid, true);
140     }