MDL-33184 Filepicker: rephrased drag and drop sentence
[moodle.git] / files / renderer.php
CommitLineData
64f93798
PS
1<?php
2///////////////////////////////////////////////////////////////////////////
3// //
4// This file is part of Moodle - http://moodle.org/ //
5// Moodle - Modular Object-Oriented Dynamic Learning Environment //
6// //
7// Moodle 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 3 of the License, or //
10// (at your option) any later version. //
11// //
12// Moodle 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 Moodle. If not, see <http://www.gnu.org/licenses/>. //
19// //
20///////////////////////////////////////////////////////////////////////////
21
22defined('MOODLE_INTERNAL') || die();
23
24/**
25 * Rendering of files viewer related widgets.
26 * @package core
27 * @subpackage file
28 * @copyright 2010 Dongsheng Cai
29 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
30 * @since Moodle 2.0
31 */
32
33/**
e921afa8 34 * File browser render
64f93798
PS
35 *
36 * @copyright 2010 Dongsheng Cai
37 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
38 * @since Moodle 2.0
39 */
40class core_files_renderer extends plugin_renderer_base {
41
42 public function files_tree_viewer(file_info $file_info, array $options = null) {
43 $tree = new files_tree_viewer($file_info, $options);
44 return $this->render($tree);
45 }
46
47 public function render_files_tree_viewer(files_tree_viewer $tree) {
e0873f13 48 $html = $this->output->heading_with_help(get_string('coursefiles'), 'courselegacyfiles', 'moodle');
0b259d91
DC
49
50 $html .= $this->output->container_start('coursefilesbreadcrumb');
64f93798
PS
51 foreach($tree->path as $path) {
52 $html .= $path;
53 $html .= ' / ';
54 }
0b259d91 55 $html .= $this->output->container_end();
64f93798 56
0b259d91
DC
57 $html .= $this->output->box_start();
58 $table = new html_table();
559276b1
MG
59 $table->head = array(get_string('name'), get_string('lastmodified'), get_string('size', 'repository'), get_string('type', 'repository'));
60 $table->align = array('left', 'left', 'left', 'left');
0b259d91
DC
61 $table->width = '100%';
62 $table->data = array();
63
64 foreach ($tree->tree as $file) {
559276b1
MG
65 $filedate = $filesize = $filetype = '';
66 if ($file['filedate']) {
67 $filedate = userdate($file['filedate'], get_string('strftimedatetimeshort', 'langconfig'));
68 }
69 if (empty($file['isdir'])) {
70 if ($file['filesize']) {
71 $filesize = display_size($file['filesize']);
72 }
73 $fileicon = file_file_icon($file, 24);
74 $filetype = get_mimetype_description($file);
0b259d91 75 } else {
559276b1 76 $fileicon = file_folder_icon(24);
64f93798 77 }
559276b1
MG
78 $table->data[] = array(
79 html_writer::link($file['url'], $this->output->pix_icon($fileicon, get_string('icon')) . ' ' . $file['filename']),
80 $filedate,
81 $filesize,
82 $filetype
83 );
64f93798 84 }
0b259d91
DC
85
86 $html .= html_writer::table($table);
e921afa8 87 $html .= $this->output->single_button(new moodle_url('/files/coursefilesedit.php', array('contextid'=>$tree->context->id)), get_string('coursefilesedit'), 'get');
0b259d91 88 $html .= $this->output->box_end();
64f93798
PS
89 return $html;
90 }
906e7d89
MG
91
92 /**
93 * Prints the file manager and initializes all necessary libraries
94 *
95 * <pre>
96 * $fm = new form_filemanager($options);
97 * $output = get_renderer('core', 'files');
98 * echo $output->render($fm);
99 * </pre>
100 *
101 * @param form_filemanager $fm File manager to render
102 * @return string HTML fragment
103 */
d1d18691 104 public function render_form_filemanager($fm) {
906e7d89 105 static $filemanagertemplateloaded;
d1d18691 106 $html = $this->fm_print_generallayout($fm);
906e7d89
MG
107 $module = array(
108 'name'=>'form_filemanager',
109 'fullpath'=>'/lib/form/filemanager.js',
4325db53
MG
110 'requires' => array('core_filepicker', 'base', 'io-base', 'node', 'json', 'core_dndupload', 'panel', 'resize-plugin', 'dd-plugin'),
111 'strings' => array(
112 array('error', 'moodle'), array('info', 'moodle'), array('confirmdeletefile', 'repository'),
113 array('draftareanofiles', 'repository'), array('entername', 'repository'), array('enternewname', 'repository'),
9a62f779
MG
114 array('invalidjson', 'repository'), array('popupblockeddownload', 'repository'),
115 array('unknownoriginal', 'repository'), array('confirmdeletefolder', 'repository'),
116 array('confirmdeletefilewithhref', 'repository'), array('confirmrenamefolder', 'repository'),
117 array('confirmrenamefile', 'repository')
906e7d89
MG
118 )
119 );
120 if (empty($filemanagertemplateloaded)) {
121 $filemanagertemplateloaded = true;
122 $this->page->requires->js_init_call('M.form_filemanager.set_templates',
e709ddd2 123 array($this->filemanager_js_templates()), true, $module);
906e7d89
MG
124 }
125 $this->page->requires->js_init_call('M.form_filemanager.init', array($fm->options), true, $module);
126
127 // non javascript file manager
128 $html .= '<noscript>';
129 $html .= "<div><object type='text/html' data='".$fm->get_nonjsurl()."' height='160' width='600' style='border:1px solid #000'></object></div>";
130 $html .= '</noscript>';
131
132
133 return $html;
134 }
135
136 /**
137 * Returns html for displaying one file manager
138 *
139 * The main element in HTML must have id="filemanager-{$client_id}" and
140 * class="filemanager fm-loading";
141 * After all necessary code on the page (both html and javascript) is loaded,
142 * the class fm-loading will be removed and added class fm-loaded;
143 * The main element (class=filemanager) will be assigned the following classes:
144 * 'fm-maxfiles' - when filemanager has maximum allowed number of files;
145 * 'fm-nofiles' - when filemanager has no files at all (although there might be folders);
146 * 'fm-noitems' - when current view (folder) has no items - neither files nor folders;
147 * 'fm-updating' - when current view is being updated (usually means that loading icon is to be displayed);
148 * 'fm-nomkdir' - when 'Make folder' action is unavailable (empty($fm->options->subdirs) == true)
149 *
150 * Element with class 'filemanager-container' will be holding evens for dnd upload (dragover, etc.).
151 * It will have class:
152 * 'dndupload-ready' - when a file is being dragged over the browser
153 * 'dndupload-over' - when file is being dragged over this filepicker (additional to 'dndupload-ready')
154 * 'dndupload-uploading' - during the upload process (note that after dnd upload process is
155 * over, the file manager will refresh the files list and therefore will have for a while class
156 * fm-updating. Both waiting processes should look similar so the images don't jump for user)
157 *
158 * If browser supports Drag-and-drop, the body element will have class 'dndsupported',
159 * otherwise - 'dndnotsupported';
160 *
e709ddd2
MG
161 * Element with class 'fp-content' will be populated with files list;
162 * Element with class 'fp-btn-add' will hold onclick event for adding a file (opening filepicker);
163 * Element with class 'fp-btn-mkdir' will hold onclick event for adding new folder;
164 * Element with class 'fp-btn-download' will hold onclick event for download action;
165 *
166 * Element with class 'fp-path-folder' is a template for one folder in path toolbar.
167 * It will hold mouse click event and will be assigned classes first/last/even/odd respectfully.
168 * Parent element will receive class 'empty' when there are no folders to be displayed;
169 * The content of subelement with class 'fp-path-folder-name' will be substituted with folder name;
170 *
171 * Element with class 'fp-viewbar' will have the class 'enabled' or 'disabled' when view mode
172 * can be changed or not;
173 * Inside element with class 'fp-viewbar' there are expected elements with classes
174 * 'fp-vb-icons', 'fp-vb-tree' and 'fp-vb-details'. They will handle onclick events to switch
175 * between the view modes, the last clicked element will have the class 'checked';
906e7d89
MG
176 *
177 * @param form_filemanager $fm
178 * @return string
179 */
d1d18691 180 private function fm_print_generallayout($fm) {
906e7d89
MG
181 global $OUTPUT;
182 $options = $fm->options;
183 $client_id = $options->client_id;
184 $straddfile = get_string('addfile', 'repository');
185 $strmakedir = get_string('makeafolder', 'moodle');
186 $strdownload = get_string('downloadfolder', 'repository');
187 $strloading = get_string('loading', 'repository');
906e7d89
MG
188 $strdroptoupload = get_string('droptoupload', 'moodle');
189 $icon_progress = $OUTPUT->pix_icon('i/loading_small', $strloading).'';
d1d18691 190 $restrictions = $this->fm_print_restrictions($fm);
906e7d89
MG
191 $strdndenabled = get_string('dndenabled_insentence', 'moodle').$OUTPUT->help_icon('dndenabled');
192 $strdndenabledinbox = get_string('dndenabled_inbox', 'moodle');
193 $loading = get_string('loading', 'repository');
194
e709ddd2
MG
195 $html = '
196<div id="filemanager-'.$client_id.'" class="filemanager fm-loading">
420e7bb2 197 <div class="fp-restrictions">
e709ddd2
MG
198 '.$restrictions.'
199 <span class="dndupload-message"> - '.$strdndenabled.' </span>
420e7bb2
BR
200 </div>
201 <div class="fp-navbar">
202 <div class="filemanager-toolbar">
420e7bb2
BR
203 <div class="fp-toolbar">
204 <div class="{!}fp-btn-add"><a href="#"><img src="'.$this->pix_url('a/add_file').'" /> '.$straddfile.'</a></div>
205 <div class="{!}fp-btn-mkdir"><a href="#"><img src="'.$this->pix_url('a/create_folder').'" /> '.$strmakedir.'</a></div>
0f0d10c5 206 <div class="{!}fp-btn-download"><a href="#"><img src="'.$this->pix_url('a/download_all').'" /> '.$strdownload.'</a></div>
420e7bb2 207 </div>
b4562710
BR
208 <div class="{!}fp-viewbar">
209 <a class="{!}fp-vb-icons" href="#"></a>
210 <a class="{!}fp-vb-details" href="#"></a>
211 <a class="{!}fp-vb-tree" href="#"></a>
212 </div>
420e7bb2
BR
213 </div>
214 <div class="fp-pathbar">
0f0d10c5 215 <span class="{!}fp-path-folder"><a class="{!}fp-path-folder-name" href="#"></a></span>
e709ddd2 216 </div>
906e7d89 217 </div>
0f0d10c5 218 <div class="filemanager-loading mdl-align">'.$icon_progress.'</div>
906e7d89 219 <div class="filemanager-container" >
e709ddd2 220 <div class="fm-content-wrapper">
420e7bb2 221 <div class="fp-content"></div>
322945e9 222 <div class="fm-empty-container <!--mdl-align-->">
0f0d10c5 223 <span class="dndupload-message">'.$strdndenabledinbox.'<br/><span class="dndupload-arrow"></span></span>
e709ddd2 224 </div>
0f0d10c5 225 <div class="dndupload-target">'.$strdroptoupload.'<br/><span class="dndupload-arrow"></span></div>
e709ddd2 226 <div class="dndupload-uploadinprogress">'.$icon_progress.'</div>
906e7d89 227 </div>
e709ddd2 228 <div class="filemanager-updating">'.$icon_progress.'</div>
906e7d89 229 </div>
420e7bb2 230</div>';
e709ddd2
MG
231 return preg_replace('/\{\!\}/', '', $html);
232 }
233
234 /**
235 * FileManager JS template for displaying one file in 'icon view' mode.
236 *
23b83009
MG
237 * Except for elements described in fp_js_template_iconfilename, this template may also
238 * contain element with class 'fp-contextmenu'. If context menu is available for this
239 * file, the top element will receive the additional class 'fp-hascontextmenu' and
240 * the element with class 'fp-contextmenu' will hold onclick event for displaying
241 * the context menu.
242 *
e709ddd2
MG
243 * @see fp_js_template_iconfilename()
244 * @return string
245 */
246 private function fm_js_template_iconfilename() {
420e7bb2
BR
247 $rv = '
248<div class="fp-file">
249 <a href="#">
9a62f779 250 <div style="position:relative;">
0f0d10c5
BR
251 <div class="{!}fp-thumbnail"></div>
252 <div class="fp-reficons1"></div>
253 <div class="fp-reficons2"></div>
254 </div>
255 <div class="fp-filename-field">
256 <div class="{!}fp-filename"></div>
9a62f779 257 </div>
0f0d10c5 258 </a>
23b83009
MG
259 <a class="{!}fp-contextmenu" href="#">'.$this->pix_icon('i/menu', '▶').'</a>
260</div>';
261 return preg_replace('/\{\!\}/', '', $rv);
e709ddd2
MG
262 }
263
264 /**
265 * FileManager JS template for displaying file name in 'table view' and 'tree view' modes.
266 *
23b83009
MG
267 * Except for elements described in fp_js_template_listfilename, this template may also
268 * contain element with class 'fp-contextmenu'. If context menu is available for this
269 * file, the top element will receive the additional class 'fp-hascontextmenu' and
270 * the element with class 'fp-contextmenu' will hold onclick event for displaying
271 * the context menu.
272 *
273 * @todo MDL-32736 remove onclick="return false;"
e709ddd2
MG
274 * @see fp_js_template_listfilename()
275 * @return string
276 */
277 private function fm_js_template_listfilename() {
420e7bb2 278 $rv = '
a9352f1f 279<span class="fp-filename-icon">
0f0d10c5 280 <a href="#">
420e7bb2
BR
281 <span class="{!}fp-icon"></span>
282 <span class="{!}fp-filename"></span>
0f0d10c5 283 </a>
420e7bb2
BR
284 <a class="{!}fp-contextmenu" href="#" onclick="return false;">'.$this->pix_icon('i/menu', '▶').'</a>
285</span>';
23b83009 286 return preg_replace('/\{\!\}/', '', $rv);
e709ddd2
MG
287 }
288
694beb54
MG
289 /**
290 * FileManager JS template for displaying 'Make new folder' dialog.
291 *
292 * Must be wrapped in an element, CSS for this element must define width and height of the window;
293 *
294 * Must have one input element with type="text" (for users to enter the new folder name);
295 *
296 * content of element with class 'fp-dlg-curpath' will be replaced with current path where
297 * new folder is about to be created;
298 * elements with classes 'fp-dlg-butcreate' and 'fp-dlg-butcancel' will hold onclick events;
299 *
300 * @return string
301 */
302 private function fm_js_template_mkdir() {
420e7bb2
BR
303 $rv = '
304<div class="fp-mkdir-dlg">
b4562710
BR
305 <p>New folder name:</p>
306 <input type="text"><br/>
307 <a class="{!}fp-dlg-butcreate fp-panel-button" href="#">'.get_string('create').'</a>
308 <a class="{!}fp-dlg-butcancel fp-panel-button" href="#">'.get_string('cancel').'</a>
694beb54
MG
309</div>';
310 return preg_replace('/\{\!\}/', '', $rv);
311 }
312
313 /**
314 * FileManager JS template for error/info message displayed as a separate popup window.
315 *
316 * @see fp_js_template_message()
317 * @return string
318 */
319 private function fm_js_template_message() {
320 return $this->fp_js_template_message();
321 }
322
e709ddd2
MG
323 /**
324 * FileManager JS template for window with file information/actions.
325 *
55089a9d
MG
326 * All content must be enclosed in one element, CSS for this class must define width and
327 * height of the window;
e709ddd2
MG
328 *
329 * Thumbnail image will be added as content to the element with class 'fp-thumbnail';
330 *
331 * Inside the window the elements with the following classnames must be present:
332 * 'fp-saveas', 'fp-author', 'fp-license', 'fp-path'. Inside each of them must be
333 * one input element (or select in case of fp-license and fp-path). They may also have labels.
334 * The elements will be assign with class 'uneditable' and input/select element will become
335 * disabled if they are not applicable for the particular file;
336 *
e0ff0867 337 * There may be present elements with classes 'fp-original', 'fp-datemodified', 'fp-datecreated',
9dbdf31f
MG
338 * 'fp-size', 'fp-dimensions', 'fp-reflist'. They will receive additional class 'fp-unknown' if
339 * information is unavailable. If there is information available, the content of embedded
340 * element with class 'fp-value' will be substituted with the value;
e709ddd2 341 *
9a62f779
MG
342 * The value of Original ('fp-original') is loaded in separate request. When it is applicable
343 * but not yet loaded the 'fp-original' element receives additional class 'fp-loading';
344 *
9dbdf31f
MG
345 * The value of 'Aliases/Shortcuts' ('fp-reflist') is also loaded in separate request. When it
346 * is applicable but not yet loaded the 'fp-original' element receives additional class
347 * 'fp-loading'. The string explaining that XX references exist will replace content of element
348 * 'fp-refcount'. Inside '.fp-reflist .fp-value' each reference will be enclosed in <li>;
349 *
e709ddd2
MG
350 * Elements with classes 'fp-file-update', 'fp-file-download', 'fp-file-delete', 'fp-file-zip',
351 * 'fp-file-unzip', 'fp-file-setmain' and 'fp-file-cancel' will hold corresponding onclick
352 * events (there may be several elements with class 'fp-file-cancel');
353 *
354 * When confirm button is pressed and file is being selected, the top element receives
355 * additional class 'loading'. It is removed when response from server is received.
356 *
357 * When any of the input fields is changed, the top element receives class 'fp-changed';
358 * When current file can be set as main - top element receives class 'fp-cansetmain';
359 * When current file is folder/zip/file - top element receives respectfully class
360 * 'fp-folder'/'fp-zip'/'fp-file';
361 *
362 * @return string
363 */
364 private function fm_js_template_fileselectlayout() {
9a62f779
MG
365 $strloading = get_string('loading', 'repository');
366 $icon_progress = $this->pix_icon('i/loading_small', $strloading).'';
420e7bb2
BR
367 $rv = '
368<div class="filemanager fp-select">
369 <div class="fp-select-loading">
370 <img src="'.$this->pix_url('i/loading').'" />
371 <p>'.get_string('loading', 'repository').'</p>
372 </div>
373 <form>
374 <div><a class="{!}fp-file-download fp-panel-button" href="#">'.get_string('download').'</a>
375 <a class="{!}fp-file-delete fp-panel-button" href="#">'.get_string('delete').'</a>
376 <a class="{!}fp-file-setmain fp-panel-button" href="#">'.get_string('setmainfile', 'repository').'</a>
377 <a class="{!}fp-file-zip fp-panel-button" href="#">'.get_string('zip', 'editor').'</a>
378 <a class="{!}fp-file-unzip fp-panel-button" href="#">'.get_string('unzip').'</a>
379 </div>
380 <div class="fp-hr"></div>
381 <table>
382 <tr class="{!}fp-saveas"><td class="mdl-right"><label>'.get_string('name', 'moodle').'</label>:</td>
383 <td class="mdl-left"><input type="text"/></td></tr>
384 <tr class="{!}fp-author"><td class="mdl-right"><label>'.get_string('author', 'repository').'</label>:</td>
385 <td class="mdl-left"><input type="text" /></td></tr>
386 <tr class="{!}fp-license"><td class="mdl-right"><label>'.get_string('chooselicense', 'repository').'</label>:</td>
387 <td class="mdl-left"><select></select></td></tr>
388 <tr class="{!}fp-path"><td class="mdl-right"><label>'.get_string('path', 'moodle').'</label>:</td>
389 <td class="mdl-left"><select></select></td></tr>
390 <tr class="{!}fp-original"><td class="mdl-right"><label>'.get_string('original', 'repository').'</label>:</td>
391 <td class="mdl-left"><span class="fp-originloading">'.$icon_progress.' '.$strloading.'</span><span class="fp-value"/></td></tr>
9dbdf31f
MG
392 <tr class="{!}fp-reflist"><td class="mdl-right"><label>'.get_string('referenceslist', 'repository').'</label>:</td>
393 <td class="mdl-left"><p class="{!}fp-refcount"/><span class="fp-reflistloading">'.$icon_progress.' '.$strloading.'</span><ul class="fp-value"/></td></tr>
420e7bb2
BR
394 </table>
395 </form>
396 <p class="{!}fp-thumbnail"></p>
397 <form>
398 <p class="fp-select-update">
0f0d10c5
BR
399 <a class="{!}fp-file-update" href="#"><span>'.get_string('update', 'moodle').'</span></a>
400 <a class="{!}fp-file-cancel" href="#"><span>'.get_string('cancel').'</span></a>
420e7bb2
BR
401 </p>
402 </form>
403 <div class="fp-fileinfo">
404 <div class="{!}fp-datemodified">'.get_string('lastmodified', 'moodle').': <span class="fp-value"/></div>
405 <div class="{!}fp-datecreated">'.get_string('datecreated', 'repository').': <span class="fp-value"/></div>
406 <div class="{!}fp-size">'.get_string('size', 'repository').': <span class="fp-value"/></div>
407 <div class="{!}fp-dimensions">'.get_string('dimensions', 'repository').': <span class="fp-value"/></div>
408 </div>
e709ddd2
MG
409</div>';
410 return preg_replace('/\{\!\}/', '', $rv);
411 }
412
9a62f779
MG
413 /**
414 * FileManager JS template for popup confirm dialogue window.
415 *
416 * Must have one top element, CSS for this element must define width and height of the window;
417 *
418 * content of element with class 'fp-dlg-text' will be replaced with dialog text;
419 * elements with classes 'fp-dlg-butconfirm' and 'fp-dlg-butcancel' will
420 * hold onclick events;
421 *
422 * @return string
423 */
424 private function fm_js_template_confirmdialog() {
420e7bb2
BR
425 $rv = '
426<div class="filemanager fp-dlg">
427 <div class="{!}fp-dlg-text"></div>
b4562710
BR
428 <a class="{!}fp-dlg-butconfirm fp-panel-button" href="#">'.get_string('ok').'</a>
429 <a class="{!}fp-dlg-butcancel fp-panel-button" href="#">'.get_string('cancel').'</a>
9a62f779
MG
430</div>';
431 return preg_replace('/\{\!\}/', '', $rv);
432 }
433
e709ddd2
MG
434 /**
435 * Returns all FileManager JavaScript templates as an array.
436 *
437 * @return array
438 */
439 public function filemanager_js_templates() {
440 $class_methods = get_class_methods($this);
441 $templates = array();
442 foreach ($class_methods as $method_name) {
443 if (preg_match('/^fm_js_template_(.*)$/', $method_name, $matches))
444 $templates[$matches[1]] = $this->$method_name();
445 }
446 return $templates;
906e7d89
MG
447 }
448
449 /**
450 * Displays restrictions for the file manager
451 *
452 * @param form_filemanager $fm
453 * @return string
454 */
d1d18691 455 private function fm_print_restrictions($fm) {
906e7d89
MG
456 $maxbytes = display_size($fm->options->maxbytes);
457 if (empty($options->maxfiles) || $options->maxfiles == -1) {
458 $maxsize = get_string('maxfilesize', 'moodle', $maxbytes);
459 //$string['maxfilesize'] = 'Maximum size for new files: {$a}';
460 } else {
461 $strparam = (object)array('size' => $maxbytes, 'attachments' => $options->maxfiles);
462 $maxsize = get_string('maxsizeandattachments', 'moodle', $strparam);
463 //$string['maxsizeandattachments'] = 'Maximum size for new files: {$a->size}, maximum attachments: {$a->attachments}';
464 }
465 // TODO MDL-32020 also should say about 'File types accepted'
466 return '<span>'. $maxsize. '</span>';
467 }
64f93798 468
d1d18691
MG
469 /**
470 * Template for FilePicker with general layout (not QuickUpload).
471 *
472 * Must have one top element containing everything else (recommended <div class="file-picker">),
473 * CSS for this element must define width and height of the filepicker window. Or CSS must
474 * define min-width, max-width, min-height and max-height and in this case the filepicker
475 * window will be resizeable;
476 *
477 * Element with class 'fp-viewbar' will have the class 'enabled' or 'disabled' when view mode
478 * can be changed or not;
479 * Inside element with class 'fp-viewbar' there are expected elements with classes
480 * 'fp-vb-icons', 'fp-vb-tree' and 'fp-vb-details'. They will handle onclick events to switch
481 * between the view modes, the last clicked element will have the class 'checked';
482 *
483 * Element with class 'fp-repo' is a template for displaying one repository. Other repositories
484 * will be attached as siblings (classes first/last/even/odd will be added respectfully).
485 * The currently selected repostory will have class 'active'. Contents of element with class
486 * 'fp-repo-name' will be replaced with repository name, source of image with class
487 * 'fp-repo-icon' will be replaced with repository icon;
488 *
489 * Element with class 'fp-content' is obligatory and will hold the current contents;
490 *
491 * Element with class 'fp-paging' will contain page navigation (will be deprecated soon);
492 *
e709ddd2 493 * Element with class 'fp-path-folder' is a template for one folder in path toolbar.
d1d18691 494 * It will hold mouse click event and will be assigned classes first/last/even/odd respectfully.
d1d18691 495 * Parent element will receive class 'empty' when there are no folders to be displayed;
e709ddd2 496 * The content of subelement with class 'fp-path-folder-name' will be substituted with folder name;
d1d18691
MG
497 *
498 * Element with class 'fp-toolbar' will have class 'empty' if all 'Back', 'Search', 'Refresh',
499 * 'Logout', 'Manage' and 'Help' are unavailable for this repo;
500 *
501 * Inside fp-toolbar there are expected elements with classes fp-tb-back, fp-tb-search,
502 * fp-tb-refresh, fp-tb-logout, fp-tb-manage and fp-tb-help. Each of them will have
503 * class 'enabled' or 'disabled' if particular repository has this functionality.
504 * Element with class 'fp-tb-search' must contain empty form inside, it's contents will
505 * be substituted with the search form returned by repository (in the most cases it
506 * is generated with template core_repository_renderer::repository_default_searchform);
507 * Other elements must have either <a> or <button> element inside, it will hold onclick
508 * event for corresponding action; labels for fp-tb-back and fp-tb-logout may be
509 * replaced with those specified by repository;
510 *
511 * @return string
512 */
513 private function fp_js_template_generallayout() {
514 $rv = '
515<div class="file-picker fp-generallayout">
e88d5641
BR
516 <div class="fp-repo-area">
517 <ul class="fp-list">
b4562710 518 <li class="{!}fp-repo"><a href="#"><img class="{!}fp-repo-icon" width="16" height="16" />&nbsp;<span class="{!}fp-repo-name" /span></a></li>
e88d5641 519 </ul>
d1d18691 520 </div>
e88d5641 521 <div class="fp-repo-items">
0f0d10c5 522 <div class="fp-navbar">
420e7bb2 523 <div>
420e7bb2
BR
524 <div class="{!}fp-toolbar">
525 <div class="{!}fp-tb-back"><a href="#">'.get_string('back', 'repository').'</a></div>
526 <div class="{!}fp-tb-search fp-search"><form/></div>
527 <div class="{!}fp-tb-refresh"><a href="#"><img src="'.$this->pix_url('a/refresh').'" /></a></div>
528 <div class="{!}fp-tb-logout"><img src="'.$this->pix_url('a/logout').'" /><a href="#"></a></div>
529 <div class="{!}fp-tb-manage"><a href="#"><img src="'.$this->pix_url('a/setting').'" /> '.get_string('manageurl', 'repository').'</a></div>
530 <div class="{!}fp-tb-help"><a href="#"><img src="'.$this->pix_url('a/help').'" /> '.get_string('help').'</a></div>
531 </div>
b4562710
BR
532 <div class="{!}fp-viewbar">
533 <a class="{!}fp-vb-icons" href="#"></a>
534 <a class="{!}fp-vb-details" href="#"></a>
535 <a class="{!}fp-vb-tree" href="#"></a>
536 </div>
a9352f1f 537 <div class="fp-clear-right"></div>
e88d5641
BR
538 </div>
539 <div class="fp-pathbar">
0f0d10c5
BR
540 <span class="{!}fp-path-folder"><a class="{!}fp-path-folder-name" href="#"></a></span>
541 </div>
d1d18691 542 </div>
e88d5641 543 <div class="{!}fp-content"></div>
d1d18691 544 </div>
d1d18691
MG
545</div>';
546 return preg_replace('/\{\!\}/', '', $rv);
547 }
548
549 /**
e709ddd2 550 * FilePicker JS template for displaying one file in 'icon view' mode.
d1d18691
MG
551 *
552 * the element with class 'fp-thumbnail' will be resized to the repository thumbnail size
553 * (both width and height, unless min-width and/or min-height is set in CSS) and the content of
554 * an element will be replaced with an appropriate img;
555 *
556 * the width of element with class 'fp-filename' will be set to the repository thumbnail width
557 * (unless min-width is set in css) and the content of an element will be replaced with filename
558 * supplied by repository;
559 *
e709ddd2
MG
560 * top element(s) will have class fp-folder if the element is a folder;
561 *
562 * List of files will have parent <div> element with class 'fp-iconview'
563 *
d1d18691
MG
564 * @return string
565 */
e709ddd2 566 private function fp_js_template_iconfilename() {
420e7bb2
BR
567 $rv = '
568<a class="fp-file" href="#" >
d1d18691 569 <div class="{!}fp-thumbnail"></div>
0f0d10c5
BR
570 <div class="fp-filename-field">
571 <p class="{!}fp-filename"></p>
572 </div>
e88d5641 573</a>';
d1d18691
MG
574 return preg_replace('/\{\!\}/', '', $rv);
575 }
576
577 /**
578 * FilePicker JS template for displaying file name in 'table view' and 'tree view' modes.
579 *
580 * content of the element with class 'fp-icon' will be replaced with an appropriate img;
581 *
582 * content of element with class 'fp-filename' will be replaced with filename supplied by
583 * repository;
584 *
e709ddd2
MG
585 * top element(s) will have class fp-folder if the element is a folder;
586 *
d1d18691
MG
587 * Note that tree view and table view are the YUI widgets and therefore there are no
588 * other templates. The widgets will be wrapped in <div> with class fp-treeview or
589 * fp-tableview (respectfully).
590 *
591 * @return string
592 */
593 private function fp_js_template_listfilename() {
a9352f1f
BR
594 $rv = '
595<span class="fp-filename-icon">
596 <a href="#">
597 <span class="{!}fp-icon"></span>
598 <span class="{!}fp-filename"></span>
599 </a>
600</span>';
d1d18691
MG
601 return preg_replace('/\{\!\}/', '', $rv);
602 }
603
604 /**
605 * FilePicker JS template for displaying link/loading progress for fetching of the next page
606 *
607 * This text is added to .fp-content AFTER .fp-iconview/.fp-treeview/.fp-tableview
608 *
609 * Must have one parent element with class 'fp-nextpage'. It will be assigned additional
610 * class 'loading' during loading of the next page (it is recommended that in this case the link
611 * becomes unavailable). Also must contain one element <a> or <button> that will hold
612 * onclick event for displaying of the next page. The event will be triggered automatically
613 * when user scrolls to this link.
614 *
615 * @return string
616 */
617 private function fp_js_template_nextpage() {
420e7bb2
BR
618 $rv = '
619<div class="{!}fp-nextpage">
620 <div class="fp-nextpage-link"><a href="#">'.get_string('more').'</a></div>
621 <div class="fp-nextpage-loading">
622 <img src="'.$this->pix_url('i/loading').'" />
623 <p>'.get_string('loading', 'repository').'</p>
624 </div>
d1d18691
MG
625</div>';
626 return preg_replace('/\{\!\}/', '', $rv);
627 }
628
629 /**
e709ddd2 630 * FilePicker JS template for window appearing to select a file.
d1d18691 631 *
55089a9d
MG
632 * All content must be enclosed in one element, CSS for this class must define width and
633 * height of the window;
d1d18691
MG
634 *
635 * Thumbnail image will be added as content to the element with class 'fp-thumbnail';
636 *
637 * Inside the window the elements with the following classnames must be present:
55089a9d
MG
638 * 'fp-saveas', 'fp-linktype-2', 'fp-linktype-1', 'fp-linktype-4', 'fp-setauthor',
639 * 'fp-setlicense'. Inside each of them must have one input element (or select in case of
640 * fp-setlicense). They may also have labels.
d1d18691
MG
641 * The elements will be assign with class 'uneditable' and input/select element will become
642 * disabled if they are not applicable for the particular file;
643 *
644 * There may be present elements with classes 'fp-datemodified', 'fp-datecreated', 'fp-size',
e709ddd2
MG
645 * 'fp-license', 'fp-author', 'fp-dimensions'. They will receive additional class 'fp-unknown'
646 * if information is unavailable. If there is information available, the content of embedded
647 * element with class 'fp-value' will be substituted with the value;
d1d18691
MG
648 *
649 * Elements with classes 'fp-select-confirm' and 'fp-select-cancel' will hold corresponding
650 * onclick events;
651 *
652 * When confirm button is pressed and file is being selected, the top element receives
653 * additional class 'loading'. It is removed when response from server is received.
654 *
655 * @return string
656 */
657 private function fp_js_template_selectlayout() {
420e7bb2
BR
658 $rv = '
659<div class="file-picker fp-select">
660 <div class="fp-select-loading">
661 <img src="'.$this->pix_url('i/loading').'" />
662 <p>'.get_string('loading', 'repository').'</p>
663 </div>
664 <form>
665 <div>
666 <a class="{!}fp-select-confirm fp-panel-button" href="#">'.get_string('getfile', 'repository').'</a>
667 <a class="{!}fp-select-cancel fp-panel-button" href="#">'.get_string('cancel').'</a>
668 </div>
669 <div class="fp-hr"></div>
670 <table>
420e7bb2
BR
671 <tr class="{!}fp-linktype-2">
672 <td></td>
0f0d10c5 673 <td class="mdl-left"><input type="radio"/><label>&nbsp;'.get_string('makefileinternal', 'repository').'</label></td></tr>
420e7bb2
BR
674 <tr class="{!}fp-linktype-1">
675 <td></td>
0f0d10c5 676 <td class="mdl-left"><input type="radio"/><label>&nbsp;'.get_string('makefilelink', 'repository').'</label></td></tr>
420e7bb2
BR
677 <tr class="{!}fp-linktype-4">
678 <td></td>
0f0d10c5 679 <td class="mdl-left"><input type="radio"/><label>&nbsp;'.get_string('makefilereference', 'repository').'</label></td></tr>
420e7bb2
BR
680 <tr class="{!}fp-saveas">
681 <td class="mdl-right"><label>'.get_string('saveas', 'repository').'</label>:</td>
682 <td class="mdl-left"><input type="text"/></td></tr>
683 <tr class="{!}fp-setauthor">
684 <td class="mdl-right"><label>'.get_string('author', 'repository').'</label>:</td>
685 <td class="mdl-left"><input type="text" /></td></tr>
686 <tr class="{!}fp-setlicense">
687 <td class="mdl-right"><label>'.get_string('chooselicense', 'repository').'</label>:</td>
688 <td class="mdl-left"><select></select></td></tr>
689 </table>
690 </form>
691 <p class="{!}fp-thumbnail"></p>
692 <div class="fp-fileinfo">
693 <div class="{!}fp-datemodified">'.get_string('lastmodified', 'moodle').': <span class="fp-value"/></div>
694 <div class="{!}fp-datecreated">'.get_string('datecreated', 'repository').': <span class="fp-value"/></div>
695 <div class="{!}fp-size">'.get_string('size', 'repository').': <span class="fp-value"/></div>
696 <div class="{!}fp-license">'.get_string('license', 'moodle').': <span class="fp-value"/></div>
697 <div class="{!}fp-author">'.get_string('author', 'repository').': <span class="fp-value"/></div>
698 <div class="{!}fp-dimensions">'.get_string('dimensions', 'repository').': <span class="fp-value"/></div>
699 </div>
d1d18691
MG
700</div>';
701 return preg_replace('/\{\!\}/', '', $rv);
702 }
703
704 /**
705 * FilePicker JS template for 'Upload file' repository
706 *
707 * Content to display when user chooses 'Upload file' repository (will be nested inside
708 * element with class 'fp-content').
709 *
710 * Must contain form (enctype="multipart/form-data" method="POST")
711 *
712 * The elements with the following classnames must be present:
713 * 'fp-file', 'fp-saveas', 'fp-setauthor', 'fp-setlicense'. Inside each of them must have
714 * one input element (or select in case of fp-setlicense). They may also have labels.
715 *
716 * Element with class 'fp-upload-btn' will hold onclick event for uploading the file;
717 *
718 * Please note that some fields may be hidden using CSS if this is part of quickupload form
719 *
720 * @return string
721 */
722 private function fp_js_template_uploadform() {
420e7bb2
BR
723 $rv = '
724<div class="fp-upload-form mdl-align">
0f0d10c5 725 <div class="fp-content-center">
420e7bb2
BR
726 <form enctype="multipart/form-data" method="POST">
727 <table >
728 <tr class="{!}fp-file">
729 <td class="mdl-right"><label>'.get_string('attachment', 'repository').'</label>:</td>
730 <td class="mdl-left"><input type="file"/></td></tr>
731 <tr class="{!}fp-saveas">
732 <td class="mdl-right"><label>'.get_string('saveas', 'repository').'</label>:</td>
733 <td class="mdl-left"><input type="text"/></td></tr>
734 <tr class="{!}fp-setauthor">
735 <td class="mdl-right"><label>'.get_string('author', 'repository').'</label>:</td>
736 <td class="mdl-left"><input type="text"/></td></tr>
737 <tr class="{!}fp-setlicense">
738 <td class="mdl-right"><label>'.get_string('chooselicense', 'repository').'</label>:</td>
739 <td class="mdl-left"><select/></td></tr>
740 </table>
741 </form>
742 <div><button class="{!}fp-upload-btn">'.get_string('upload', 'repository').'</button></div>
743 </div>
d1d18691
MG
744</div> ';
745 return preg_replace('/\{\!\}/', '', $rv);
746 }
747
748 /**
749 * FilePicker JS template to display during loading process (inside element with class 'fp-content').
750 *
751 * @return string
752 */
753 private function fp_js_template_loading() {
420e7bb2 754 return '
0f0d10c5
BR
755<div class="fp-content-loading">
756 <div class="fp-content-center">
757 <img src="'.$this->pix_url('i/loading').'" />
758 <p>'.get_string('loading', 'repository').'</p>
759 </div>
d1d18691
MG
760</div>';
761 }
762
763 /**
764 * FilePicker JS template for error (inside element with class 'fp-content').
765 *
766 * must have element with class 'fp-error', its content will be replaced with error text
767 * and the error code will be assigned as additional class to this element
768 * used errors: invalidjson, nofilesavailable, norepositoriesavailable
769 *
770 * @return string
771 */
772 private function fp_js_template_error() {
420e7bb2
BR
773 $rv = '
774<div class="fp-content-error" ><div class="{!}fp-error" /></div>';
d1d18691
MG
775 return preg_replace('/\{\!\}/', '', $rv);
776 }
777
778 /**
779 * FilePicker JS template for error/info message displayed as a separate popup window.
780 *
9a62f779 781 * Must be wrapped in one element, CSS for this element must define
d1d18691
MG
782 * width and height of the window. It will be assigned with an additional class 'fp-msg-error'
783 * or 'fp-msg-info' depending on message type;
784 *
785 * content of element with class 'fp-msg-text' will be replaced with error/info text;
786 *
787 * element with class 'fp-msg-butok' will hold onclick event
788 *
789 * @return string
790 */
791 private function fp_js_template_message() {
420e7bb2
BR
792 $rv = '
793<div class="file-picker fp-msg">
794 <p class="{!}fp-msg-text"></p>
b4562710 795 <a class="{!}fp-msg-butok fp-panel-button" href="#">'.get_string('ok').'</a>
420e7bb2 796</div>';
d1d18691
MG
797 return preg_replace('/\{\!\}/', '', $rv);
798 }
799
800 /**
801 * FilePicker JS template for popup dialogue window asking for action when file with the same name already exists.
802 *
9a62f779 803 * Must have one top element, CSS for this element must define width and height of the window;
d1d18691
MG
804 *
805 * content of element with class 'fp-dlg-text' will be replaced with dialog text;
806 * elements with classes 'fp-dlg-butoverwrite', 'fp-dlg-butrename' and 'fp-dlg-butcancel' will
807 * hold onclick events;
808 *
809 * content of element with class 'fp-dlg-butrename' will be substituted with appropriate string
810 * (Note that it may have long text)
811 *
812 * @return string
813 */
814 private function fp_js_template_processexistingfile() {
420e7bb2
BR
815 $rv = '
816<div class="file-picker fp-dlg">
817 <p class="{!}fp-dlg-text"></p>
0f0d10c5
BR
818 <a class="{!}fp-dlg-butoverwrite fp-panel-button" href="#">'.get_string('overwrite', 'repository').'</a>
819 <a class="{!}fp-dlg-butcancel fp-panel-button" href="#">'.get_string('cancel').'</a>
820 <a class="{!}fp-dlg-butrename fp-panel-button" href="#"/>
d1d18691
MG
821</div>';
822 return preg_replace('/\{\!\}/', '', $rv);
823 }
0f0d10c5 824
d1d18691
MG
825 /**
826 * FilePicker JS template for repository login form including templates for each element type
827 *
828 * Must contain one <form> element with templates for different input types inside:
829 * Elements with classes 'fp-login-popup', 'fp-login-textarea', 'fp-login-select' and
830 * 'fp-login-input' are templates for displaying respective login form elements. Inside
831 * there must be exactly one element with type <button>, <textarea>, <select> or <input>
832 * (i.e. fp-login-popup should have <button>, fp-login-textarea should have <textarea>, etc.);
833 * They may also contain the <label> element and it's content will be substituted with
834 * label;
835 *
836 * You can also define elements with classes 'fp-login-checkbox', 'fp-login-text'
837 * but if they are not found, 'fp-login-input' will be used;
838 *
839 * Element with class 'fp-login-radiogroup' will be used for group of radio inputs. Inside
840 * it should hava a template for one radio input (with class 'fp-login-radio');
841 *
842 * Element with class 'fp-login-submit' will hold on click mouse event (form submission). It
843 * will be removed if at least one popup element is present;
844 *
845 * @return string
846 */
847 private function fp_js_template_loginform() {
848 $rv = '
849<div class="fp-login-form">
420e7bb2
BR
850 <div class="fp-content-center">
851 <form>
852 <table >
853 <tr class="{!}fp-login-popup">
854 <td colspan="2">
855 <label>'.get_string('popup', 'repository').'</label>
856 <p class="fp-popup"><button class="{!}fp-login-popup-but">'.get_string('login', 'repository').'</button></p></td></tr>
857 <tr class="{!}fp-login-textarea">
858 <td colspan="2"><p><textarea></textarea></p></td></tr>
859 <tr class="{!}fp-login-select">
860 <td align="right"><label></label></td>
861 <td align="left"><select></select></td></tr>
862 <tr class="{!}fp-login-input">
863 <td class="label"><label /></td>
864 <td class="input"><input/></td></tr>
865 <tr class="{!}fp-login-radiogroup">
866 <td align="right" width="30%" valign="top"><label /></td>
867 <td align="left" valign="top"><p class="{!}fp-login-radio"><input /> <label /></p></td></tr>
868 </table>
869 <p><button class="{!}fp-login-submit">'.get_string('submit', 'repository').'</button></p>
870 </form>
871 </div>
d1d18691
MG
872</div>';
873 return preg_replace('/\{\!\}/', '', $rv);
874 }
875
876 /**
877 * Returns all FilePicker JavaScript templates as an array.
878 *
879 * @return array
880 */
881 public function filepicker_js_templates() {
882 $class_methods = get_class_methods($this);
883 $templates = array();
884 foreach ($class_methods as $method_name) {
885 if (preg_match('/^fp_js_template_(.*)$/', $method_name, $matches))
886 $templates[$matches[1]] = $this->$method_name();
887 }
888 return $templates;
889 }
890
891 /**
892 * Returns HTML for default repository searchform to be passed to Filepicker
893 *
894 * This will be used as contents for search form defined in generallayout template
895 * (form with id {TOOLSEARCHID}).
896 * Default contents is one text input field with name="s"
897 */
898 public function repository_default_searchform() {
e88d5641 899 $str = '<input class="search-entry" name="s" value="Search" />';
d1d18691
MG
900 return $str;
901 }
902}
64f93798
PS
903
904/**
905 * Data structure representing a general moodle file tree viewer
906 *
907 * @copyright 2010 Dongsheng Cai
908 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
909 * @since Moodle 2.0
910 */
911class files_tree_viewer implements renderable {
912 public $tree;
913 public $path;
e921afa8 914 public $context;
64f93798
PS
915
916 /**
917 * Constructor of moodle_file_tree_viewer class
918 * @param file_info $file_info
919 * @param array $options
920 */
921 public function __construct(file_info $file_info, array $options = null) {
922 global $CFG;
923
924 //note: this MUST NOT use get_file_storage() !!!!!!!!!!!!!!!!!!!!!!!!!!!!
64f93798 925 $this->options = (array)$options;
e921afa8
DC
926 $this->context = $options['context'];
927
64f93798
PS
928 $this->tree = array();
929 $children = $file_info->get_children();
0b259d91 930 $current_file_params = $file_info->get_params();
64f93798 931 $parent_info = $file_info->get_parent();
64f93798
PS
932 $level = $parent_info;
933 $this->path = array();
934 while ($level) {
935 $params = $level->get_params();
936 $context = get_context_instance_by_id($params['contextid']);
0b259d91
DC
937 // $this->context is current context
938 if ($context->id != $this->context->id or empty($params['filearea'])) {
64f93798
PS
939 break;
940 }
e921afa8
DC
941 // unset unused parameters
942 unset($params['component']);
943 unset($params['filearea']);
0b259d91 944 unset($params['filename']);
e921afa8 945 unset($params['itemid']);
64f93798 946 $url = new moodle_url('/files/index.php', $params);
e921afa8 947 $this->path[] = html_writer::link($url, $level->get_visible_name());
64f93798
PS
948 $level = $level->get_parent();
949 }
950 $this->path = array_reverse($this->path);
0b259d91
DC
951 if ($current_file_params['filepath'] != '/') {
952 $this->path[] = $file_info->get_visible_name();
953 }
64f93798
PS
954
955 foreach ($children as $child) {
956 $filedate = $child->get_timemodified();
957 $filesize = $child->get_filesize();
958 $mimetype = $child->get_mimetype();
959 $params = $child->get_params();
0b259d91
DC
960 unset($params['component']);
961 unset($params['filearea']);
962 unset($params['filename']);
963 unset($params['itemid']);
64f93798
PS
964 $fileitem = array(
965 'params' => $params,
966 'filename' => $child->get_visible_name(),
559276b1
MG
967 'mimetype' => $child->get_mimetype(),
968 'filedate' => $filedate ? $filedate : '',
969 'filesize' => $filesize ? $filesize : ''
64f93798 970 );
e921afa8 971 $url = new moodle_url('/files/index.php', $params);
64f93798
PS
972 if ($child->is_directory()) {
973 $fileitem['isdir'] = true;
974 $fileitem['url'] = $url->out(false);
64f93798
PS
975 } else {
976 $fileitem['url'] = $child->get_url();
977 }
978 $this->tree[] = $fileitem;
979 }
980 }
981}