MDL-22991, fixed file api calls
[moodle.git] / repository / repository_ajax.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/>.
19 /**
20  * The Web service script that is called from the filepicker front end
21  *
22  * @since 2.0
23  * @package moodlecore
24  * @subpackage repository
25  * @copyright 2009 Dongsheng Cai <dongsheng@moodle.com>
26  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
27  */
29 define('AJAX_SCRIPT', true);
31 require_once(dirname(dirname(__FILE__)).'/config.php');
32 require_once(dirname(dirname(__FILE__)).'/lib/filelib.php');
33 require_once(dirname(__FILE__).'/lib.php');
35 require_login();
37 /// Parameters
38 $action    = optional_param('action', '', PARAM_ALPHA);
39 $repo_id   = optional_param('repo_id', 0, PARAM_INT);           // Pepository ID
40 $contextid = optional_param('ctx_id', SYSCONTEXTID, PARAM_INT); // Context ID
41 $env       = optional_param('env', 'filepicker', PARAM_ALPHA);  // Opened in editor or moodleform
42 $license   = optional_param('license', $CFG->sitedefaultlicense, PARAM_TEXT);
43 $author    = optional_param('author', '', PARAM_TEXT);          // File author
44 $source    = optional_param('source', '', PARAM_RAW);           // File to download
45 $itemid    = optional_param('itemid', 0, PARAM_INT);            // Itemid
46 $page      = optional_param('page', '', PARAM_RAW);             // Page
47 $maxbytes  = optional_param('maxbytes', 0, PARAM_INT);          // Maxbytes
48 $req_path  = optional_param('p', '', PARAM_RAW);                // Path
49 $accepted_types  = optional_param('accepted_types', '*', PARAM_RAW);
50 $saveas_filename = optional_param('title', '', PARAM_FILE);     // save as file name
51 $saveas_path   = optional_param('savepath', '/', PARAM_PATH);   // save as file path
52 $search_text   = optional_param('s', '', PARAM_CLEANHTML);
53 $linkexternal  = optional_param('linkexternal', '', PARAM_ALPHA);
55 /// Headers to make it not cacheable
56 header('Cache-Control: no-cache, must-revalidate');
57 header('Expires: Sat, 26 Jul 1997 05:00:00 GMT');
59 $err = new stdclass;
61 if (!confirm_sesskey()) {
62     $err->error = get_string('invalidsesskey');
63     die(json_encode($err));
64 }
66 /// Check permissions
67 if (! (isloggedin() && repository::check_context($contextid)) ) {
68     $err->error = get_string('nopermissiontoaccess', 'repository');
69     die(json_encode($err));
70 }
72 $moodle_maxbytes = get_max_upload_file_size();
73 // to prevent maxbytes greater than moodle maxbytes setting
74 if ($maxbytes == 0 || $maxbytes>=$moodle_maxbytes) {
75     $maxbytes = $moodle_maxbytes;
76 }
78 /// Wait as long as it takes for this script to finish
79 set_time_limit(0);
81 // Early actions which need to be done before repository instaces initialised
82 switch ($action) {
83     // global search
84     case 'gsearch':
85         $params = array();
86         $params['context'] = array(get_context_instance_by_id($contextid), get_system_context());
87         $params['currentcontext'] = get_context_instance_by_id($contextid);
88         $repos = repository::get_instances($params);
89         $list = array();
90         foreach($repos as $repo){
91             if ($repo->global_search()) {
92                 $ret = $repo->search($search_text);
93                 array_walk($ret['list'], 'repository_attach_id', $repo->id);  // See function below
94                 $tmp = array_merge($list, $ret['list']);
95                 $list = $tmp;
96             }
97         }
98         $listing = array('list'=>$list);
99         $listing['gsearch'] = true;
100         die(json_encode($listing));
101         break;
103     // remove the cache files & logout
104     case 'ccache':
105         $cache = new curl_cache;
106         $cache->refresh();
107         $action = 'list';
108         break;
111 /// Get repository instance information
112 $sql = 'SELECT i.name, i.typeid, r.type FROM {repository} r, {repository_instances} i '.
113        'WHERE i.id=? AND i.typeid=r.id';
115 if (!$repository = $DB->get_record_sql($sql, array($repo_id))) {
116     $err->error = get_string('invalidrepositoryid', 'repository');
117     die(json_encode($err));
118 } else {
119     $type = $repository->type;
122 if (file_exists($CFG->dirroot.'/repository/'.$type.'/lib.php')) {
123     require_once($CFG->dirroot.'/repository/'.$type.'/lib.php');
124     $classname = 'repository_' . $type;
125     $repo = new $classname($repo_id, $contextid, array('ajax'=>true, 'name'=>$repository->name, 'type'=>$type));
126 } else {
127     $err->error = get_string('invalidplugin', 'repository', $type);
128     die(json_encode($err));
131 /// These actions all occur on the currently active repository instance
132 switch ($action) {
133     case 'sign':
134     case 'signin':
135     case 'list':
136         if ($repo->check_login()) {
137             $listing = $repo->get_listing($req_path, $page);
138             $listing['repo_id'] = $repo_id;
139             echo json_encode($listing);
140             break;
141         } else {
142             $action = 'login';
143         }
144     case 'login':
145         $listing = $repo->print_login();
146         $listing['repo_id'] = $repo_id;
147         echo json_encode($listing);
148         break;
149     case 'logout':
150         $logout = $repo->logout();
151         $logout['repo_id'] = $repo_id;
152         echo json_encode($logout);
153         break;
154     case 'searchform':
155         $search_form['form'] = $repo->print_search();
156         echo json_encode($search_form);
157         break;
158     case 'search':
159         $search_result = $repo->search($search_text, (int)$page);
160         $search_result['repo_id'] = $repo_id;
161         $search_result['search_result'] = true;
162         echo json_encode($search_result);
163         break;
164     case 'download':
165         // validate mimetype
166         $mimetypes = array();
167         if (in_array('*', $accepted_types) or $accepted_types == '*') {
168             $mimetypes = '*';
169         } else {
170             foreach ($accepted_types as $type) {
171                 $mimetypes[] = mimeinfo('type', $type);
172             }
173             if (!in_array(mimeinfo('type', $saveas_filename), $mimetypes)) {
174                 throw new moodle_exception('invalidfiletype', 'repository', '', mimeinfo('type', $_FILES[$elname]['name']));
175             }
176         }
178         // We have two special repoisitory type need to deal with
179         // local and recent plugins don't added new files to moodle, just add new records to database
180         // so we don't check user quota and maxbytes here
181         if (in_array($repo->options['type'], array('local', 'recent', 'user'))) {
182             $fileinfo = $repo->copy_to_area($source, 'draft', $itemid, $saveas_path, $saveas_filename);
183             $info = array();
184             $info['file'] = $fileinfo['title'];
185             $info['id'] = $itemid;
186             $info['url'] = $CFG->httpswwwroot.'/draftfile.php/'.$fileinfo['contextid'].'/user/draft/'.$itemid.'/'.$fileinfo['title'];
187             $filesize = $fileinfo['filesize'];
188             if (($maxbytes!==-1) && ($filesize>$maxbytes)) {
189                 throw new file_exception('maxbytes');
190             }
191             echo json_encode($info);
192             die; // ends here!!
193         } else {
194             $allowexternallink = (int)get_config(null, 'repositoryallowexternallinks');
195             if (!empty($allowexternallink)) {
196                 $allowexternallink = true;
197             } else {
198                 $allowexternallink = false;
199             }
200             // allow external links in url element all the time
201             $allowexternallink = ($allowexternallink || ($env == 'url'));
203             // Use link of the files
204             if ($allowexternallink and $linkexternal === 'yes' and ($repo->supported_returntypes() & FILE_EXTERNAL)) {
205                 // use external link
206                 $link = $repo->get_link($source);
207                 $info = array();
208                 $info['filename'] = $saveas_filename;
209                 $info['type'] = 'link';
210                 $info['url'] = $link;
211                 echo json_encode($info);
212                 die;
213             } else {
214                 // Download file to moodle
215                 $file = $repo->get_file($source, $saveas_filename);
216                 if ($file['path'] === false) {
217                     $err->error = get_string('cannotdownload', 'repository');
218                     die(json_encode($err));
219                 }
221                 // check if exceed maxbytes
222                 if (($maxbytes!==-1) && (filesize($file['path']) > $maxbytes)) {
223                     throw new file_exception('maxbytes');
224                 }
226                 // check if exceed user quota
227                 $userquota = file_get_user_used_space();
228                 if (filesize($file['path'])+$userquota>=(int)$CFG->userquota) {
229                     throw new file_exception('userquotalimit');
230                 }
232                 $record = new stdclass;
233                 $record->filepath = $saveas_path;
234                 $record->filename = $saveas_filename;
235                 $record->component = 'user';
236                 $record->filearea = 'draft';
237                 $record->itemid   = $itemid;
239                 if (!empty($file['license'])) {
240                     $record->license  = $file['license'];
241                 } else {
242                     $record->license  = $license;
243                 }
244                 if (!empty($file['author'])) {
245                     $record->author   = $file['author'];
246                 } else {
247                     $record->author   = $author;
248                 }
249                 $record->source = !empty($file['url']) ? $file['url'] : '';
251                 $info = repository::move_to_filepool($file['path'], $record);
252                 if (empty($info)) {
253                     $info['e'] = get_string('error', 'moodle');
254                 }
255                 echo json_encode($info);
256                 die;
257             }
258         }
259         break;
260     case 'upload':
261         $result = $repo->upload();
262         echo json_encode($result);
263         break;
266 /**
267  * Small function to walk an array to attach repository ID
268  * @param array $value
269  * @param string $key
270  * @param int $id
271  */
272 function repository_attach_id(&$value, $key, $id){
273     $value['repo_id'] = $id;