/repository/recent/lib.php
PHP | 216 lines | 125 code | 14 blank | 77 comment | 7 complexity | f147f71fd505807d705852adeb3b64c6 MD5 | raw file
- <?php
- // This file is part of Moodle - http://moodle.org/
- //
- // Moodle is free software: you can redistribute it and/or modify
- // it under the terms of the GNU General Public License as published by
- // the Free Software Foundation, either version 3 of the License, or
- // (at your option) any later version.
- //
- // Moodle is distributed in the hope that it will be useful,
- // but WITHOUT ANY WARRANTY; without even the implied warranty of
- // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- // GNU General Public License for more details.
- //
- // You should have received a copy of the GNU General Public License
- // along with Moodle. If not, see <http://www.gnu.org/licenses/>.
- /**
- * This plugin is used to access recent used files
- *
- * @since 2.0
- * @package repository_recent
- * @copyright 2010 Dongsheng Cai {@link http://dongsheng.org}
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
- require_once($CFG->dirroot . '/repository/lib.php');
- /**
- * repository_recent class is used to browse recent used files
- *
- * @since 2.0
- * @package repository_recent
- * @copyright 2010 Dongsheng Cai {@link http://dongsheng.org}
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
- define('DEFAULT_RECENT_FILES_NUM', 50);
- class repository_recent extends repository {
- /**
- * Initialize recent plugin
- * @param int $repositoryid
- * @param int $context
- * @param array $options
- */
- public function __construct($repositoryid, $context = SYSCONTEXTID, $options = array()) {
- parent::__construct($repositoryid, $context, $options);
- $number = get_config('recent', 'recentfilesnumber');
- $number = (int)$number;
- if (empty($number)) {
- $this->number = DEFAULT_RECENT_FILES_NUM;
- } else {
- $this->number = $number;
- }
- }
- /**
- * recent plugin doesn't require login, so list all files
- * @return mixed
- */
- public function print_login() {
- return $this->get_listing();
- }
- private function get_recent_files($limitfrom = 0, $limit = DEFAULT_RECENT_FILES_NUM) {
- // XXX: get current itemid
- global $USER, $DB, $itemid;
- // This SQL will ignore draft files if not owned by current user.
- // Ignore all file references.
- $sql = 'SELECT files1.*
- FROM {files} files1
- LEFT JOIN {files_reference} r
- ON files1.referencefileid = r.id
- JOIN (
- SELECT contenthash, filename, MAX(id) AS id
- FROM {files}
- WHERE userid = :userid
- AND filename != :filename
- AND ((filearea = :filearea1 AND itemid = :itemid) OR filearea != :filearea2)
- GROUP BY contenthash, filename
- ) files2 ON files1.id = files2.id
- WHERE r.repositoryid is NULL
- ORDER BY files1.timemodified DESC';
- $params = array(
- 'userid' => $USER->id,
- 'filename' => '.',
- 'filearea1' => 'draft',
- 'itemid' => $itemid,
- 'filearea2' => 'draft');
- $rs = $DB->get_recordset_sql($sql, $params, $limitfrom, $limit);
- $result = array();
- foreach ($rs as $file_record) {
- $info = array();
- $info['contextid'] = $file_record->contextid;
- $info['itemid'] = $file_record->itemid;
- $info['filearea'] = $file_record->filearea;
- $info['component'] = $file_record->component;
- $info['filepath'] = $file_record->filepath;
- $info['filename'] = $file_record->filename;
- $result[$file_record->pathnamehash] = $info;
- }
- $rs->close();
- return $result;
- }
- /**
- * Get file listing
- *
- * @param string $encodedpath
- * @param string $path not used by this plugin
- * @return mixed
- */
- public function get_listing($encodedpath = '', $page = '') {
- global $OUTPUT;
- $ret = array();
- $ret['dynload'] = true;
- $ret['nosearch'] = true;
- $ret['nologin'] = true;
- $list = array();
- $files = $this->get_recent_files(0, $this->number);
- try {
- foreach ($files as $file) {
- // Check that file exists and accessible, retrieve size/date info
- $browser = get_file_browser();
- $context = context::instance_by_id($file['contextid']);
- $fileinfo = $browser->get_file_info($context, $file['component'],
- $file['filearea'], $file['itemid'], $file['filepath'], $file['filename']);
- if ($fileinfo) {
- $params = base64_encode(serialize($file));
- $node = array(
- 'title' => $fileinfo->get_visible_name(),
- 'size' => $fileinfo->get_filesize(),
- 'datemodified' => $fileinfo->get_timemodified(),
- 'datecreated' => $fileinfo->get_timecreated(),
- 'author' => $fileinfo->get_author(),
- 'license' => $fileinfo->get_license(),
- 'source'=> $params,
- 'icon' => $OUTPUT->pix_url(file_file_icon($fileinfo, 24))->out(false),
- 'thumbnail' => $OUTPUT->pix_url(file_file_icon($fileinfo, 90))->out(false),
- );
- if ($imageinfo = $fileinfo->get_imageinfo()) {
- $fileurl = new moodle_url($fileinfo->get_url());
- $node['realthumbnail'] = $fileurl->out(false, array('preview' => 'thumb', 'oid' => $fileinfo->get_timemodified()));
- $node['realicon'] = $fileurl->out(false, array('preview' => 'tinyicon', 'oid' => $fileinfo->get_timemodified()));
- $node['image_width'] = $imageinfo['width'];
- $node['image_height'] = $imageinfo['height'];
- }
- $list[] = $node;
- }
- }
- } catch (Exception $e) {
- throw new repository_exception('emptyfilelist', 'repository_recent');
- }
- $ret['list'] = array_filter($list, array($this, 'filter'));
- return $ret;
- }
- public static function get_type_option_names() {
- return array('recentfilesnumber', 'pluginname');
- }
- public static function type_config_form($mform, $classname = 'repository') {
- parent::type_config_form($mform, $classname);
- $number = get_config('repository_recent', 'recentfilesnumber');
- if (empty($number)) {
- $number = DEFAULT_RECENT_FILES_NUM;
- }
- $mform->addElement('text', 'recentfilesnumber', get_string('recentfilesnumber', 'repository_recent'));
- $mform->setType('recentfilesnumber', PARAM_INT);
- $mform->setDefault('recentfilesnumber', $number);
- }
- /**
- * This plugin doesn't support to link to external links
- *
- * @return int
- */
- public function supported_returntypes() {
- return FILE_INTERNAL;
- }
- /**
- * Repository method to make sure that user can access particular file.
- *
- * This is checked when user tries to pick the file from repository to deal with
- * potential parameter substitutions is request
- *
- * @todo MDL-33805 remove this function when recent files are managed correctly
- *
- * @param string $source
- * @return bool whether the file is accessible by current user
- */
- public function file_is_accessible($source) {
- global $USER;
- $file = self::get_moodle_file($source);
- return (!empty($file) && $file->get_userid() == $USER->id);
- }
- /**
- * Does this repository used to browse moodle files?
- *
- * @return boolean
- */
- public function has_moodle_files() {
- return true;
- }
- /**
- * Is this repository accessing private data?
- *
- * @return bool
- */
- public function contains_private_data() {
- return false;
- }
- }