MDL-22991, validate data that was encoded in base64
[moodle.git] / repository / recent / lib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * repository_recent class is used to browse recent used files
20  *
21  * @since 2.0
22  * @package moodlecore
23  * @subpackage repository
24  * @copyright 2010 Dongsheng Cai <dongsheng@moodle.com>
25  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26  */
28 define('DEFAULT_RECENT_FILES_NUM', 50);
29 class repository_recent extends repository {
31     /**
32      * Initialize recent plugin
33      * @param int $repositoryid
34      * @param int $context
35      * @param array $options
36      */
37     public function __construct($repositoryid, $context = SYSCONTEXTID, $options = array()) {
38         parent::__construct($repositoryid, $context, $options);
39         $number = get_config('recent', 'recentfilesnumber');
40         $number = (int)$number;
41         if (empty($number)) {
42             $this->number = DEFAULT_RECENT_FILES_NUM;
43         } else {
44             $this->number = $number;
45         }
46     }
48     /**
49      * recent plugin doesn't require login, so list all files
50      * @return mixed
51      */
52     public function print_login() {
53         return $this->get_listing();
54     }
56     private function get_recent_files($limitfrom = 0, $limit = DEFAULT_RECENT_FILES_NUM) {
57         global $USER, $DB;
58         // TODO: should exclude user_draft area files?
59         $sql = 'SELECT * FROM {files} files1
60                 JOIN (SELECT contenthash, filename, MAX(id) AS id
61                 FROM {files}
62                 WHERE userid = ? AND filename != ? AND filearea != ?
63                 GROUP BY contenthash, filename) files2 ON files1.id = files2.id
64                 ORDER BY files1.timemodified DESC';
65         $params = array('userid'=>$USER->id, 'filename'=>'.', 'filearea'=>'user_draft');
66         $rs = $DB->get_recordset_sql($sql, $params, $limitfrom, $limit);
67         $result = array();
68         foreach ($rs as $file_record) {
69             $info = array();
70             $info['contextid'] = $file_record->contextid;
71             $info['itemid'] = $file_record->itemid;
72             $info['filearea'] = $file_record->filearea;
73             $info['filepath'] = $file_record->filepath;
74             $info['filename'] = $file_record->filename;
75             $result[$file_record->pathnamehash] = $info;
76         }
77         $rs->close();
78         return $result;
79     }
81     /**
82      * Get file listing
83      *
84      * @param string $encodedpath
85      * @param string $path not used by this plugin
86      * @return mixed
87      */
88     public function get_listing($encodedpath = '', $page = '') {
89         global $CFG, $USER, $OUTPUT;
90         $ret = array();
91         $ret['dynload'] = true;
92         $ret['nosearch'] = true;
93         $ret['nologin'] = true;
94         $list = array();
95         $files = $this->get_recent_files(0, $this->number);
97         try {
98             foreach ($files as $file) {
99                 $params = base64_encode(serialize($file));
100                 $icon = 'f/'.str_replace('.gif', '', mimeinfo('icon', $file['filename'])) . '-32';
101                 $node = array(
102                     'title' => $file['filename'],
103                     'shorttitle' => $this->get_short_filename($file['filename'], 12),
104                     'size' => 0,
105                     'date' => '',
106                     'source'=> $params,
107                     'thumbnail' => $OUTPUT->pix_url($icon) . '',
108                 );
109                 $list[] = $node;
110             }
111         } catch (Exception $e) {
112             throw new repository_exception('emptyfilelist', 'repository_recent');
113         }
114         $ret['list'] = array_filter($list, array($this, 'filter'));
115         return $ret;
116     }
119     /**
120      * Set repository name
121      *
122      * @return string repository name
123      */
124     public function get_name(){
125         return get_string('pluginname', 'repository_recent');;
126     }
128     public static function get_type_option_names() {
129         return array('recentfilesnumber');
130     }
132     public function type_config_form($mform) {
133         $number = get_config('repository_recent', 'recentfilesnumber');
134         if (empty($number)) {
135             $number = DEFAULT_RECENT_FILES_NUM;
136         }
137         $mform->addElement('text', 'recentfilesnumber', get_string('recentfilesnumber', 'repository_recent'));
138         $mform->setDefault('recentfilesnumber', $number);
139     }
141     /**
142      * This plugin doesn't support to link to external links
143      *
144      * @return int
145      */
146     public function supported_returntypes() {
147         return FILE_INTERNAL;
148     }
149     /**
150      * Copy a file to file area
151      *
152      * @global object $USER
153      * @global object $DB
154      * @param string $encoded The information of file, it is base64 encoded php seriablized data
155      * @param string $new_filename The intended name of file
156      * @param string $new_itemid itemid
157      * @param string $new_filepath the new path in draft area
158      * @return array The information of file
159      */
160     public function copy_to_area($encoded, $new_filearea='draft', $new_itemid = '', $new_filepath = '/', $new_filename = '') {
161         global $USER, $DB;
163         $user_context = get_context_instance(CONTEXT_USER, $USER->id);
165         $fs = get_file_storage();
167         $params = unserialize(base64_decode($encoded));
169         $contextid  = clean_param($params['contextid'], PARAM_INT);
170         $fileitemid = clean_param($params['itemid'], PARAM_INT);
171         $filename = clean_param($params['filename'], PARAM_FILE);
172         $filepath = clean_param($params['filepath'], PARAM_PATH);;
173         $filearea = clean_param($params['filearea'], PARAM_ALPHAEXT);
175         // XXX:
176         // When user try to pick a file from other filearea, normally file api will use file browse to
177         // operate the files with capability check, but in some areas, users don't have permission to
178         // browse the files (for example, forum_attachment area).
179         //
180         // To get 'recent' plugin working, we need to use lower level file_stoarge class to bypass the
181         // capability check, we will use a better workaround to improve it.
182         if ($stored_file = $fs->get_file($contextid, $filearea, $fileitemid, $filepath, $filename)) {
183             $file_record = array('contextid'=>$user_context->id, 'filearea'=>$new_filearea,
184                 'itemid'=>$new_itemid, 'filepath'=>$new_filepath, 'filename'=>$new_filename);
185             if ($file = $fs->get_file($user_context->id, $new_filearea, $new_itemid, $new_filepath, $new_filename)) {
186                 $file->delete();
187             }
188             $fs->create_file_from_storedfile($file_record, $stored_file);
189         }
191         $info = array();
192         $info['title']  = $new_filename;
193         $info['itemid'] = $new_itemid;
194         $info['filesize']  = $stored_file->get_filesize();
195         $info['contextid'] = $user_context->id;
197         return $info;
198     }