2 // This file is part of Moodle - http://moodle.org/
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.
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.
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/>.
18 * This plugin is used to access local files
21 * @package repository_local
22 * @copyright 2010 Dongsheng Cai {@link http://dongsheng.org}
23 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25 require_once($CFG->dirroot
. '/repository/lib.php');
28 * repository_local class is used to browse moodle files
31 * @package repository_local
32 * @copyright 2012 Marina Glancy
33 * @copyright 2009 Dongsheng Cai {@link http://dongsheng.org}
34 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
36 class repository_local
extends repository
{
40 * @param string $encodedpath
41 * @param string $page no paging is used in repository_local
44 public function get_listing($encodedpath = '', $page = '') {
45 global $CFG, $USER, $OUTPUT;
47 $ret['dynload'] = true;
48 $ret['nosearch'] = false;
49 $ret['nologin'] = true;
50 $ret['list'] = array();
58 if (!empty($encodedpath)) {
59 $params = json_decode(base64_decode($encodedpath), true);
60 if (is_array($params) && isset($params['contextid'])) {
61 $component = is_null($params['component']) ?
NULL : clean_param($params['component'], PARAM_COMPONENT
);
62 $filearea = is_null($params['filearea']) ?
NULL : clean_param($params['filearea'], PARAM_AREA
);
63 $itemid = is_null($params['itemid']) ?
NULL : clean_param($params['itemid'], PARAM_INT
);
64 $filepath = is_null($params['filepath']) ?
NULL : clean_param($params['filepath'], PARAM_PATH
);
65 $filename = is_null($params['filename']) ?
NULL : clean_param($params['filename'], PARAM_FILE
);
66 $context = context
::instance_by_id(clean_param($params['contextid'], PARAM_INT
));
69 if (empty($context) && !empty($this->context
)) {
70 $context = $this->context
->get_course_context(false);
72 if (empty($context)) {
73 $context = context_system
::instance();
76 // prepare list of allowed extensions: $extensions is either string '*'
77 // or array of lowercase extensions, i.e. array('.gif','.jpg')
78 $extensions = optional_param_array('accepted_types', '', PARAM_RAW
);
79 if (empty($extensions) ||
$extensions === '*' ||
(is_array($extensions) && in_array('*', $extensions))) {
82 if (!is_array($extensions)) {
83 $extensions = array($extensions);
85 $extensions = array_map('core_text::strtolower', $extensions);
89 $browser = get_file_browser();
90 if (!($fileinfo = $browser->get_file_info($context, $component, $filearea, $itemid, $filepath, $filename))) {
91 // if file doesn't exist, build path nodes root of current context
92 $fileinfo = $browser->get_file_info($context, null, null, null, null, null);
94 $ret['list'] = $this->get_non_empty_children($fileinfo, $extensions);
96 // build path navigation
98 for ($level = $fileinfo; $level; $level = $level->get_parent()) {
99 array_unshift($path, $level);
101 array_unshift($path, null);
102 $ret['path'] = array();
103 for ($i=1; $i<count($path); $i++
) {
104 if ($path[$i] == $fileinfo ||
!$this->can_skip($path[$i], $extensions, $path[$i-1])) {
105 $ret['path'][] = $this->get_node_path($path[$i]);
112 * Tells how the file can be picked from this repository
116 public function supported_returntypes() {
117 return FILE_INTERNAL | FILE_REFERENCE
;
121 * Does this repository used to browse moodle files?
125 public function has_moodle_files() {
130 * Returns all children elements that have one of the specified extensions
132 * This function may skip subfolders and recursively add their children
133 * {@link repository_local::can_skip()}
135 * @param file_info|null $fileinfo
136 * @param string|string[] $extensions for example '*' or ['.gif', '.jpg']
137 * @return array array of file_info elements
139 private function get_non_empty_children(?file_info
$fileinfo, $extensions): array {
140 if ($fileinfo === null) {
143 $nonemptychildren = $fileinfo->get_non_empty_children($extensions);
145 foreach ($nonemptychildren as $child) {
146 if ($this->can_skip($child, $extensions, $fileinfo)) {
147 $list = array_merge($list, $this->get_non_empty_children($child, $extensions));
149 $list[] = $this->get_node($child);
156 * Whether this folder may be skipped in folder hierarchy
158 * 1. Skip the name of a single filearea in a module
159 * 2. Skip course categories for non-admins who do not have navshowmycoursecategories setting
161 * @param file_info $fileinfo
162 * @param string|array $extensions, for example '*' or array('.gif','.jpg')
163 * @param file_info|int $parent specify parent here if we know it to avoid creating extra objects
166 private function can_skip(file_info
$fileinfo, $extensions, $parent = -1) {
168 if (!$fileinfo->is_directory()) {
172 if ($fileinfo instanceof file_info_context_course ||
173 $fileinfo instanceof file_info_context_user ||
174 $fileinfo instanceof file_info_area_course_legacy ||
175 $fileinfo instanceof file_info_context_module ||
176 $fileinfo instanceof file_info_context_system
) {
177 // These instances can never be filearea inside an activity, they will never be skipped.
179 } else if ($fileinfo instanceof file_info_context_coursecat
) {
180 // This is a course category. For non-admins we do not display categories
181 return empty($CFG->navshowmycoursecategories
) &&
182 !has_capability('moodle/course:update', context_system
::instance());
184 $params = $fileinfo->get_params();
185 if (strlen($params['filearea']) &&
186 ($params['filepath'] === '/' ||
empty($params['filepath'])) &&
187 ($params['filename'] === '.' ||
empty($params['filename'])) &&
188 context
::instance_by_id($params['contextid'])->contextlevel
== CONTEXT_MODULE
) {
189 if ($parent === -1) {
190 $parent = $fileinfo->get_parent();
192 // This is a filearea inside an activity, it can be skipped if it has no non-empty siblings
193 if ($parent && ($parent instanceof file_info_context_module
)) {
194 if ($parent->count_non_empty_children($extensions, 2) <= 1) {
204 * Converts file_info object to element of repository return list
206 * @param file_info $fileinfo
209 private function get_node(file_info
$fileinfo) {
211 $encodedpath = base64_encode(json_encode($fileinfo->get_params()));
213 'title' => $fileinfo->get_visible_name(),
214 'datemodified' => $fileinfo->get_timemodified(),
215 'datecreated' => $fileinfo->get_timecreated()
217 if ($fileinfo->is_directory()) {
218 $node['path'] = $encodedpath;
219 $node['thumbnail'] = $OUTPUT->image_url(file_folder_icon())->out(false);
220 $node['children'] = array();
222 $node['size'] = $fileinfo->get_filesize();
223 $node['author'] = $fileinfo->get_author();
224 $node['license'] = $fileinfo->get_license();
225 $node['isref'] = $fileinfo->is_external_file();
226 if ($fileinfo->get_status() == 666) {
227 $node['originalmissing'] = true;
229 $node['source'] = $encodedpath;
230 $node['thumbnail'] = $OUTPUT->image_url(file_file_icon($fileinfo))->out(false);
231 $node['icon'] = $OUTPUT->image_url(file_file_icon($fileinfo))->out(false);
232 if ($imageinfo = $fileinfo->get_imageinfo()) {
233 // what a beautiful picture, isn't it
234 $fileurl = new moodle_url($fileinfo->get_url());
235 $node['realthumbnail'] = $fileurl->out(false, array('preview' => 'thumb', 'oid' => $fileinfo->get_timemodified()));
236 $node['realicon'] = $fileurl->out(false, array('preview' => 'tinyicon', 'oid' => $fileinfo->get_timemodified()));
237 $node['image_width'] = $imageinfo['width'];
238 $node['image_height'] = $imageinfo['height'];
245 * Converts file_info object to element of repository return path
247 * @param file_info $fileinfo
250 private function get_node_path(file_info
$fileinfo) {
251 $encodedpath = base64_encode(json_encode($fileinfo->get_params()));
253 'path' => $encodedpath,
254 'name' => $fileinfo->get_visible_name()
259 * Search through all the files.
261 * This method will do a raw search through the database, then will try
262 * to match with files that a user can access. A maximum of 50 files will be
263 * returned at a time, excluding possible duplicates found along the way.
265 * Queries are done in chunk of 100 files to prevent too many records to be fetched
266 * at once. When too many files are not included, or a maximum of 10 queries are
267 * performed we consider that this was the last page.
269 * @param String $q The query string.
270 * @param integer $page The page number.
271 * @return array of results.
273 public function search($q, $page = 1) {
274 global $DB, $SESSION;
276 // Because the repository API is weird, the first page is 0, but it should be 1.
281 if (!isset($SESSION->repository_local_search
)) {
282 $SESSION->repository_local_search
= array();
285 $fs = get_file_storage();
286 $fb = get_file_browser();
291 $SESSION->repository_local_search
['query'] = $q;
292 $SESSION->repository_local_search
['from'] = 0;
295 // Yes, the repository does not send the query again...
296 $q = $SESSION->repository_local_search
['query'];
297 $from = (int) $SESSION->repository_local_search
['from'];
300 $count = $fs->search_server_files('%' . $DB->sql_like_escape($q) . '%', null, null, true);
301 $remaining = $count - $from;
306 while (count($results) < $max && $maxloops > 0 && $remaining > 0) {
308 $files = $fs->search_server_files('%' . $DB->sql_like_escape($q) . '%', $from, $limit);
316 $file = array_shift($files);
318 // This should not happen.
319 throw new coding_exception('Unexpected end of files list.');
322 $key = $file->get_contenthash() . ':' . $file->get_filename();
323 if (isset($results[$key])) {
324 // We found the file with same content and same name, let's skip it.
328 $ctx = context
::instance_by_id($file->get_contextid());
329 $fileinfo = $fb->get_file_info($ctx, $file->get_component(), $file->get_filearea(), $file->get_itemid(),
330 $file->get_filepath(), $file->get_filename());
332 $results[$key] = $this->get_node($fileinfo);
337 // Save the position for the paging to work.
338 if ($maxloops > 0 && $remaining > 0) {
339 $SESSION->repository_local_search
['from'] +
= $loops;
342 $SESSION->repository_local_search
['from'] = 0;
347 'list' => array_values($results),
357 * Is this repository accessing private data?
361 public function contains_private_data() {