. // // // /////////////////////////////////////////////////////////////////////////// defined('MOODLE_INTERNAL') || die(); /** * Rendering of files viewer related widgets. * @package core * @subpackage file * @copyright 2010 Dongsheng Cai * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later * @since Moodle 2.0 */ /** * File browser render * * @copyright 2010 Dongsheng Cai * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later * @since Moodle 2.0 */ class core_files_renderer extends plugin_renderer_base { public function files_tree_viewer(file_info $file_info, array $options = null) { $tree = new files_tree_viewer($file_info, $options); return $this->render($tree); } public function render_files_tree_viewer(files_tree_viewer $tree) { $html = $this->output->heading_with_help(get_string('coursefiles'), 'courselegacyfiles', 'moodle'); $html .= $this->output->container_start('coursefilesbreadcrumb'); foreach($tree->path as $path) { $html .= $path; $html .= ' / '; } $html .= $this->output->container_end(); $html .= $this->output->box_start(); $table = new html_table(); $table->head = array(get_string('name'), get_string('lastmodified'), get_string('size', 'repository'), get_string('type', 'repository')); $table->align = array('left', 'left', 'left', 'left'); $table->width = '100%'; $table->data = array(); foreach ($tree->tree as $file) { $filedate = $filesize = $filetype = ''; if ($file['filedate']) { $filedate = userdate($file['filedate'], get_string('strftimedatetimeshort', 'langconfig')); } if (empty($file['isdir'])) { if ($file['filesize']) { $filesize = display_size($file['filesize']); } $fileicon = file_file_icon($file, 24); $filetype = get_mimetype_description($file); } else { $fileicon = file_folder_icon(24); } $table->data[] = array( html_writer::link($file['url'], $this->output->pix_icon($fileicon, get_string('icon')) . ' ' . $file['filename']), $filedate, $filesize, $filetype ); } $html .= html_writer::table($table); $html .= $this->output->single_button(new moodle_url('/files/coursefilesedit.php', array('contextid'=>$tree->context->id)), get_string('coursefilesedit'), 'get'); $html .= $this->output->box_end(); return $html; } /** * Prints the file manager and initializes all necessary libraries * * 
     * $fm = new form_filemanager($options);
     * $output = get_renderer('core', 'files');
     * echo $output->render($fm);
     *
* * @param form_filemanager $fm File manager to render * @return string HTML fragment */ public function render_form_filemanager($fm) { $html = $this->fm_print_generallayout($fm); $module = array( 'name'=>'form_filemanager', 'fullpath'=>'/lib/form/filemanager.js', 'requires' => array('moodle-core-notification-dialogue', 'core_filepicker', 'base', 'io-base', 'node', 'json', 'core_dndupload', 'panel', 'resize-plugin', 'dd-plugin'), 'strings' => array( array('error', 'moodle'), array('info', 'moodle'), array('confirmdeletefile', 'repository'), array('draftareanofiles', 'repository'), array('entername', 'repository'), array('enternewname', 'repository'), array('invalidjson', 'repository'), array('popupblockeddownload', 'repository'), array('unknownoriginal', 'repository'), array('confirmdeletefolder', 'repository'), array('confirmdeletefilewithhref', 'repository'), array('confirmrenamefolder', 'repository'), array('confirmrenamefile', 'repository'), array('newfolder', 'repository'), array('edit', 'moodle') ) ); if ($this->page->requires->should_create_one_time_item_now('core_file_managertemplate')) { $this->page->requires->js_init_call('M.form_filemanager.set_templates', array($this->filemanager_js_templates()), true, $module); } $this->page->requires->js_init_call('M.form_filemanager.init', array($fm->options), true, $module); // non javascript file manager $html .= ''; return $html; } /** * Returns html for displaying one file manager * * The main element in HTML must have id="filemanager-{$client_id}" and * class="filemanager fm-loading"; * After all necessary code on the page (both html and javascript) is loaded, * the class fm-loading will be removed and added class fm-loaded; * The main element (class=filemanager) will be assigned the following classes: * 'fm-maxfiles' - when filemanager has maximum allowed number of files; * 'fm-nofiles' - when filemanager has no files at all (although there might be folders); * 'fm-noitems' - when current view (folder) has no items - neither files nor folders; * 'fm-updating' - when current view is being updated (usually means that loading icon is to be displayed); * 'fm-nomkdir' - when 'Make folder' action is unavailable (empty($fm->options->subdirs) == true) * * Element with class 'filemanager-container' will be holding evens for dnd upload (dragover, etc.). * It will have class: * 'dndupload-ready' - when a file is being dragged over the browser * 'dndupload-over' - when file is being dragged over this filepicker (additional to 'dndupload-ready') * 'dndupload-uploading' - during the upload process (note that after dnd upload process is * over, the file manager will refresh the files list and therefore will have for a while class * fm-updating. Both waiting processes should look similar so the images don't jump for user) * * If browser supports Drag-and-drop, the body element will have class 'dndsupported', * otherwise - 'dndnotsupported'; * * Element with class 'fp-content' will be populated with files list; * Element with class 'fp-btn-add' will hold onclick event for adding a file (opening filepicker); * Element with class 'fp-btn-mkdir' will hold onclick event for adding new folder; * Element with class 'fp-btn-download' will hold onclick event for download action; * * Element with class 'fp-path-folder' is a template for one folder in path toolbar. * It will hold mouse click event and will be assigned classes first/last/even/odd respectfully. * Parent element will receive class 'empty' when there are no folders to be displayed; * The content of subelement with class 'fp-path-folder-name' will be substituted with folder name; * * Element with class 'fp-viewbar' will have the class 'enabled' or 'disabled' when view mode * can be changed or not; * Inside element with class 'fp-viewbar' there are expected elements with classes * 'fp-vb-icons', 'fp-vb-tree' and 'fp-vb-details'. They will handle onclick events to switch * between the view modes, the last clicked element will have the class 'checked'; * * @param form_filemanager $fm * @return string */ private function fm_print_generallayout($fm) { global $OUTPUT; $options = $fm->options; $client_id = $options->client_id; $straddfile = get_string('addfile', 'repository'); $strmakedir = get_string('makeafolder', 'moodle'); $strdownload = get_string('downloadfolder', 'repository'); $strloading = get_string('loading', 'repository'); $strdroptoupload = get_string('droptoupload', 'moodle'); $icon_progress = $OUTPUT->pix_icon('i/loading_small', $strloading).''; $restrictions = $this->fm_print_restrictions($fm); $strdndnotsupported = get_string('dndnotsupported_insentence', 'moodle').$OUTPUT->help_icon('dndnotsupported'); $strdndenabledinbox = get_string('dndenabled_inbox', 'moodle'); $loading = get_string('loading', 'repository'); $straddfiletext = get_string('addfiletext', 'repository'); $strcreatefolder = get_string('createfolder', 'repository'); $strdownloadallfiles = get_string('downloadallfiles', 'repository'); $html = '
'.$restrictions.' - '.$strdndnotsupported.'
' . $straddfiletext . '
' . $strcreatefolder . '
' . $strdownloadallfiles . '
'. get_string('displayasicons', 'repository') .' '. get_string('displayasdetails', 'repository') .' '. get_string('displayastree', 'repository') .'
'.$icon_progress.'
'.$strdndenabledinbox.'
'.$strdroptoupload.'
'.$icon_progress.'
'.$icon_progress.'
'; return $html; } /** * FileManager JS template for displaying one file in 'icon view' mode. * * Except for elements described in fp_js_template_iconfilename, this template may also * contain element with class 'fp-contextmenu'. If context menu is available for this * file, the top element will receive the additional class 'fp-hascontextmenu' and * the element with class 'fp-contextmenu' will hold onclick event for displaying * the context menu. * * @see fp_js_template_iconfilename() * @return string */ private function fm_js_template_iconfilename() { $rv = '
'.$this->pix_icon('i/menu', '▶').'
'; return $rv; } /** * FileManager JS template for displaying file name in 'table view' and 'tree view' modes. * * Except for elements described in fp_js_template_listfilename, this template may also * contain element with class 'fp-contextmenu'. If context menu is available for this * file, the top element will receive the additional class 'fp-hascontextmenu' and * the element with class 'fp-contextmenu' will hold onclick event for displaying * the context menu. * * @todo MDL-32736 remove onclick="return false;" * @see fp_js_template_listfilename() * @return string */ private function fm_js_template_listfilename() { $rv = ' '.$this->pix_icon('i/menu', '▶').' '; return $rv; } /** * FileManager JS template for displaying 'Make new folder' dialog. * * Must be wrapped in an element, CSS for this element must define width and height of the window; * * Must have one input element with type="text" (for users to enter the new folder name); * * content of element with class 'fp-dlg-curpath' will be replaced with current path where * new folder is about to be created; * elements with classes 'fp-dlg-butcreate' and 'fp-dlg-butcancel' will hold onclick events; * * @return string */ private function fm_js_template_mkdir() { $rv = ' '; return $rv; } /** * FileManager JS template for error/info message displayed as a separate popup window. * * @see fp_js_template_message() * @return string */ private function fm_js_template_message() { return $this->fp_js_template_message(); } /** * FileManager JS template for window with file information/actions. * * All content must be enclosed in one element, CSS for this class must define width and * height of the window; * * Thumbnail image will be added as content to the element with class 'fp-thumbnail'; * * Inside the window the elements with the following classnames must be present: * 'fp-saveas', 'fp-author', 'fp-license', 'fp-path'. Inside each of them must be * one input element (or select in case of fp-license and fp-path). They may also have labels. * The elements will be assign with class 'uneditable' and input/select element will become * disabled if they are not applicable for the particular file; * * There may be present elements with classes 'fp-original', 'fp-datemodified', 'fp-datecreated', * 'fp-size', 'fp-dimensions', 'fp-reflist'. They will receive additional class 'fp-unknown' if * information is unavailable. If there is information available, the content of embedded * element with class 'fp-value' will be substituted with the value; * * The value of Original ('fp-original') is loaded in separate request. When it is applicable * but not yet loaded the 'fp-original' element receives additional class 'fp-loading'; * * The value of 'Aliases/Shortcuts' ('fp-reflist') is also loaded in separate request. When it * is applicable but not yet loaded the 'fp-original' element receives additional class * 'fp-loading'. The string explaining that XX references exist will replace content of element * 'fp-refcount'. Inside '.fp-reflist .fp-value' each reference will be enclosed in
  • ; * * Elements with classes 'fp-file-update', 'fp-file-download', 'fp-file-delete', 'fp-file-zip', * 'fp-file-unzip', 'fp-file-setmain' and 'fp-file-cancel' will hold corresponding onclick * events (there may be several elements with class 'fp-file-cancel'); * * When confirm button is pressed and file is being selected, the top element receives * additional class 'loading'. It is removed when response from server is received. * * When any of the input fields is changed, the top element receives class 'fp-changed'; * When current file can be set as main - top element receives class 'fp-cansetmain'; * When current file is folder/zip/file - top element receives respectfully class * 'fp-folder'/'fp-zip'/'fp-file'; * * @return string */ private function fm_js_template_fileselectlayout() { global $OUTPUT; $strloading = get_string('loading', 'repository'); $iconprogress = $this->pix_icon('i/loading_small', $strloading).''; $rv = '
    '.$OUTPUT->help_icon('setmainfile', 'repository').'
    '.$iconprogress.' '.$strloading.'

    '.$iconprogress.' '.$strloading.'

      '.get_string('lastmodified', 'repository').'
      '.get_string('datecreated', 'repository').'
      '.get_string('size', 'repository').'
      '.get_string('dimensions', 'repository').'
      '; return $rv; } /** * FileManager JS template for popup confirm dialogue window. * * Must have one top element, CSS for this element must define width and height of the window; * * content of element with class 'fp-dlg-text' will be replaced with dialog text; * elements with classes 'fp-dlg-butconfirm' and 'fp-dlg-butcancel' will * hold onclick events; * * @return string */ private function fm_js_template_confirmdialog() { $rv = '
      '; return $rv; } /** * Returns all FileManager JavaScript templates as an array. * * @return array */ public function filemanager_js_templates() { $class_methods = get_class_methods($this); $templates = array(); foreach ($class_methods as $method_name) { if (preg_match('/^fm_js_template_(.*)$/', $method_name, $matches)) $templates[$matches[1]] = $this->$method_name(); } return $templates; } /** * Displays restrictions for the file manager * * @param form_filemanager $fm * @return string */ private function fm_print_restrictions($fm) { $maxbytes = display_size($fm->options->maxbytes); $strparam = (object) array('size' => $maxbytes, 'attachments' => $fm->options->maxfiles, 'areasize' => display_size($fm->options->areamaxbytes)); $hasmaxfiles = !empty($fm->options->maxfiles) && $fm->options->maxfiles > 0; $hasarealimit = !empty($fm->options->areamaxbytes) && $fm->options->areamaxbytes != -1; if ($hasmaxfiles && $hasarealimit) { $maxsize = get_string('maxsizeandattachmentsandareasize', 'moodle', $strparam); } else if ($hasmaxfiles) { $maxsize = get_string('maxsizeandattachments', 'moodle', $strparam); } else if ($hasarealimit) { $maxsize = get_string('maxsizeandareasize', 'moodle', $strparam); } else { $maxsize = get_string('maxfilesize', 'moodle', $maxbytes); } // TODO MDL-32020 also should say about 'File types accepted' return ''. $maxsize . ''; } /** * Template for FilePicker with general layout (not QuickUpload). * * Must have one top element containing everything else (recommended
      ), * CSS for this element must define width and height of the filepicker window. Or CSS must * define min-width, max-width, min-height and max-height and in this case the filepicker * window will be resizeable; * * Element with class 'fp-viewbar' will have the class 'enabled' or 'disabled' when view mode * can be changed or not; * Inside element with class 'fp-viewbar' there are expected elements with classes * 'fp-vb-icons', 'fp-vb-tree' and 'fp-vb-details'. They will handle onclick events to switch * between the view modes, the last clicked element will have the class 'checked'; * * Element with class 'fp-repo' is a template for displaying one repository. Other repositories * will be attached as siblings (classes first/last/even/odd will be added respectfully). * The currently selected repostory will have class 'active'. Contents of element with class * 'fp-repo-name' will be replaced with repository name, source of image with class * 'fp-repo-icon' will be replaced with repository icon; * * Element with class 'fp-content' is obligatory and will hold the current contents; * * Element with class 'fp-paging' will contain page navigation (will be deprecated soon); * * Element with class 'fp-path-folder' is a template for one folder in path toolbar. * It will hold mouse click event and will be assigned classes first/last/even/odd respectfully. * Parent element will receive class 'empty' when there are no folders to be displayed; * The content of subelement with class 'fp-path-folder-name' will be substituted with folder name; * * Element with class 'fp-toolbar' will have class 'empty' if all 'Back', 'Search', 'Refresh', * 'Logout', 'Manage' and 'Help' are unavailable for this repo; * * Inside fp-toolbar there are expected elements with classes fp-tb-back, fp-tb-search, * fp-tb-refresh, fp-tb-logout, fp-tb-manage and fp-tb-help. Each of them will have * class 'enabled' or 'disabled' if particular repository has this functionality. * Element with class 'fp-tb-search' must contain empty form inside, it's contents will * be substituted with the search form returned by repository (in the most cases it * is generated with template core_repository_renderer::repository_default_searchform); * Other elements must have either or

      '.get_string('lastmodified', 'repository').'
      '.get_string('datecreated', 'repository').'
      '.get_string('size', 'repository').'
      '.get_string('license', 'repository').'
      '.get_string('author', 'repository').'
      '.get_string('dimensions', 'repository').'
      '; return $rv; } /** * FilePicker JS template for 'Upload file' repository * * Content to display when user chooses 'Upload file' repository (will be nested inside * element with class 'fp-content'). * * Must contain form (enctype="multipart/form-data" method="POST") * * The elements with the following classnames must be present: * 'fp-file', 'fp-saveas', 'fp-setauthor', 'fp-setlicense'. Inside each of them must have * one input element (or select in case of fp-setlicense). They may also have labels. * * Element with class 'fp-upload-btn' will hold onclick event for uploading the file; * * Please note that some fields may be hidden using CSS if this is part of quickupload form * * @return string */ private function fp_js_template_uploadform() { $rv = '
      '; return $rv; } /** * FilePicker JS template to display during loading process (inside element with class 'fp-content'). * * @return string */ private function fp_js_template_loading() { return '
      '; } /** * FilePicker JS template for error (inside element with class 'fp-content'). * * must have element with class 'fp-error', its content will be replaced with error text * and the error code will be assigned as additional class to this element * used errors: invalidjson, nofilesavailable, norepositoriesavailable * * @return string */ private function fp_js_template_error() { $rv = '
      '; return $rv; } /** * FilePicker JS template for error/info message displayed as a separate popup window. * * Must be wrapped in one element, CSS for this element must define * width and height of the window. It will be assigned with an additional class 'fp-msg-error' * or 'fp-msg-info' depending on message type; * * content of element with class 'fp-msg-text' will be replaced with error/info text; * * element with class 'fp-msg-butok' will hold onclick event * * @return string */ private function fp_js_template_message() { $rv = '

      '; return $rv; } /** * FilePicker JS template for popup dialogue window asking for action when file with the same name already exists. * * Must have one top element, CSS for this element must define width and height of the window; * * content of element with class 'fp-dlg-text' will be replaced with dialog text; * elements with classes 'fp-dlg-butoverwrite', 'fp-dlg-butrename', * 'fp-dlg-butoverwriteall', 'fp-dlg-butrenameall' and 'fp-dlg-butcancel' will * hold onclick events; * * content of element with class 'fp-dlg-butrename' will be substituted with appropriate string * (Note that it may have long text) * * @return string */ private function fp_js_template_processexistingfile() { $rv = '

      '; return $rv; } /** * FilePicker JS template for popup dialogue window asking for action when file with the same name already exists (multiple-file version). * * Must have one top element, CSS for this element must define width and height of the window; * * content of element with class 'fp-dlg-text' will be replaced with dialog text; * elements with classes 'fp-dlg-butoverwrite', 'fp-dlg-butrename' and 'fp-dlg-butcancel' will * hold onclick events; * * content of element with class 'fp-dlg-butrename' will be substituted with appropriate string * (Note that it may have long text) * * @return string */ private function fp_js_template_processexistingfilemultiple() { $rv = '

      '.get_string('overwrite', 'repository').' '.get_string('cancel').'
      '.get_string('overwriteall', 'repository').' '.get_string('renameall', 'repository').'
      '; return $rv; } /** * FilePicker JS template for repository login form including templates for each element type * * Must contain one
      element with templates for different input types inside: * Elements with classes 'fp-login-popup', 'fp-login-textarea', 'fp-login-select' and * 'fp-login-input' are templates for displaying respective login form elements. Inside * there must be exactly one element with type

      '; return $rv; } /** * Returns all FilePicker JavaScript templates as an array. * * @return array */ public function filepicker_js_templates() { $class_methods = get_class_methods($this); $templates = array(); foreach ($class_methods as $method_name) { if (preg_match('/^fp_js_template_(.*)$/', $method_name, $matches)) $templates[$matches[1]] = $this->$method_name(); } return $templates; } /** * Returns HTML for default repository searchform to be passed to Filepicker * * This will be used as contents for search form defined in generallayout template * (form with id {TOOLSEARCHID}). * Default contents is one text input field with name="s" */ public function repository_default_searchform() { $searchinput = html_writer::label(get_string('searchrepo', 'repository'), 'reposearch', false, array('class' => 'accesshide')); $searchinput .= html_writer::empty_tag('input', array('type' => 'text', 'id' => 'reposearch', 'name' => 's', 'value' => get_string('search', 'repository'))); $str = html_writer::tag('div', $searchinput, array('class' => "fp-def-search")); return $str; } } /** * Data structure representing a general moodle file tree viewer * * @copyright 2010 Dongsheng Cai * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later * @since Moodle 2.0 */ class files_tree_viewer implements renderable { public $tree; public $path; public $context; /** * Constructor of moodle_file_tree_viewer class * @param file_info $file_info * @param array $options */ public function __construct(file_info $file_info, array $options = null) { global $CFG; //note: this MUST NOT use get_file_storage() !!!!!!!!!!!!!!!!!!!!!!!!!!!! $this->options = (array)$options; $this->context = $options['context']; $this->tree = array(); $children = $file_info->get_children(); $current_file_params = $file_info->get_params(); $parent_info = $file_info->get_parent(); $level = $parent_info; $this->path = array(); while ($level) { $params = $level->get_params(); $context = context::instance_by_id($params['contextid']); // $this->context is current context if ($context->id != $this->context->id or empty($params['filearea'])) { break; } // unset unused parameters unset($params['component']); unset($params['filearea']); unset($params['filename']); unset($params['itemid']); $url = new moodle_url('/files/index.php', $params); $this->path[] = html_writer::link($url, $level->get_visible_name()); $level = $level->get_parent(); } $this->path = array_reverse($this->path); if ($current_file_params['filepath'] != '/') { $this->path[] = $file_info->get_visible_name(); } foreach ($children as $child) { $filedate = $child->get_timemodified(); $filesize = $child->get_filesize(); $mimetype = $child->get_mimetype(); $params = $child->get_params(); unset($params['component']); unset($params['filearea']); unset($params['filename']); unset($params['itemid']); $fileitem = array( 'params' => $params, 'filename' => $child->get_visible_name(), 'mimetype' => $child->get_mimetype(), 'filedate' => $filedate ? $filedate : '', 'filesize' => $filesize ? $filesize : '' ); $url = new moodle_url('/files/index.php', $params); if ($child->is_directory()) { $fileitem['isdir'] = true; $fileitem['url'] = $url->out(false); } else { $fileitem['url'] = $child->get_url(); } $this->tree[] = $fileitem; } } }