MDL-25973 add missing charset
[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    core
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 $err = new stdClass();
37 /// Parameters
38 $action    = optional_param('action', '', PARAM_ALPHA);
39 $repo_id   = optional_param('repo_id', 0, PARAM_INT);           // Repository 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 @header('Content-type: text/plain; charset=utf-8');
57 // if uploaded file is larger than post_max_size (php.ini) setting, $_POST content will lost
58 if (empty($_POST) && !empty($action)) {
59     $err->error = get_string('errorpostmaxsize', 'repository');
60     die(json_encode($err));
61 }
63 list($context, $course, $cm) = get_context_info_array($contextid);
64 require_login($course, false, $cm);
65 $PAGE->set_context($context);
67 echo $OUTPUT->header(); // send headers
69 if (!confirm_sesskey()) {
70     $err->error = get_string('invalidsesskey');
71     die(json_encode($err));
72 }
74 /// Get repository instance information
75 $sql = 'SELECT i.name, i.typeid, r.type FROM {repository} r, {repository_instances} i WHERE i.id=? AND i.typeid=r.id';
77 if (!$repository = $DB->get_record_sql($sql, array($repo_id))) {
78     $err->error = get_string('invalidrepositoryid', 'repository');
79     die(json_encode($err));
80 } else {
81     $type = $repository->type;
82 }
84 /// Check permissions
85 repository::check_capability($contextid, $repository);
87 $moodle_maxbytes = get_max_upload_file_size();
88 // to prevent maxbytes greater than moodle maxbytes setting
89 if ($maxbytes == 0 || $maxbytes>=$moodle_maxbytes) {
90     $maxbytes = $moodle_maxbytes;
91 }
93 /// Wait as long as it takes for this script to finish
94 set_time_limit(0);
96 // Early actions which need to be done before repository instances initialised
97 switch ($action) {
98     // global search
99     case 'gsearch':
100         $params = array();
101         $params['context'] = array(get_context_instance_by_id($contextid), get_system_context());
102         $params['currentcontext'] = get_context_instance_by_id($contextid);
103         $repos = repository::get_instances($params);
104         $list = array();
105         foreach($repos as $repo){
106             if ($repo->global_search()) {
107                 $ret = $repo->search($search_text);
108                 array_walk($ret['list'], 'repository_attach_id', $repo->id);  // See function below
109                 $tmp = array_merge($list, $ret['list']);
110                 $list = $tmp;
111             }
112         }
113         $listing = array('list'=>$list);
114         $listing['gsearch'] = true;
115         die(json_encode($listing));
116         break;
118     // remove the cache files & logout
119     case 'ccache':
120         $cache = new curl_cache;
121         $cache->refresh();
122         $action = 'list';
123         break;
126 if (file_exists($CFG->dirroot.'/repository/'.$type.'/lib.php')) {
127     require_once($CFG->dirroot.'/repository/'.$type.'/lib.php');
128     $classname = 'repository_' . $type;
129     $repo = new $classname($repo_id, $contextid, array('ajax'=>true, 'name'=>$repository->name, 'type'=>$type));
130 } else {
131     $err->error = get_string('invalidplugin', 'repository', $type);
132     die(json_encode($err));
135 /// These actions all occur on the currently active repository instance
136 switch ($action) {
137     case 'sign':
138     case 'signin':
139     case 'list':
140         if ($repo->check_login()) {
141             $listing = $repo->get_listing($req_path, $page);
142             $listing['repo_id'] = $repo_id;
143             echo json_encode($listing);
144             break;
145         } else {
146             $action = 'login';
147         }
148     case 'login':
149         $listing = $repo->print_login();
150         $listing['repo_id'] = $repo_id;
151         echo json_encode($listing);
152         break;
153     case 'logout':
154         $logout = $repo->logout();
155         $logout['repo_id'] = $repo_id;
156         echo json_encode($logout);
157         break;
158     case 'searchform':
159         $search_form['form'] = $repo->print_search();
160         echo json_encode($search_form);
161         break;
162     case 'search':
163         $search_result = $repo->search($search_text, (int)$page);
164         $search_result['repo_id'] = $repo_id;
165         $search_result['issearchresult'] = true;
166         echo json_encode($search_result);
167         break;
168     case 'download':
169         // validate mimetype
170         $mimetypes = array();
171         if ((is_array($accepted_types) and in_array('*', $accepted_types)) or $accepted_types == '*') {
172             $mimetypes = '*';
173         } else {
174             foreach ($accepted_types as $type) {
175                 $mimetypes[] = mimeinfo('type', $type);
176             }
177             if (!in_array(mimeinfo('type', $saveas_filename), $mimetypes)) {
178                 throw new moodle_exception('invalidfiletype', 'repository', '', get_string(mimeinfo('type', $saveas_filename), 'mimetypes'));
179             }
180         }
182         // We have two special repository type need to deal with
183         // local and recent plugins don't added new files to moodle, just add new records to database
184         // so we don't check user quota and maxbytes here
185         $allowexternallink = (int)get_config(null, 'repositoryallowexternallinks');
186         if (!empty($allowexternallink)) {
187             $allowexternallink = true;
188         } else {
189             $allowexternallink = false;
190         }
191         // allow external links in url element all the time
192         $allowexternallink = ($allowexternallink || ($env == 'url'));
194         // Use link of the files
195         if ($allowexternallink and $linkexternal === 'yes' and ($repo->supported_returntypes() & FILE_EXTERNAL)) {
196             // use external link
197             $link = $repo->get_link($source);
198             $info = array();
199             $info['filename'] = $saveas_filename;
200             $info['type'] = 'link';
201             $info['url'] = $link;
202             echo json_encode($info);
203             die;
204         } else {
205             if (in_array($repo->options['type'], array('local', 'recent', 'user', 'coursefiles'))) { //TODO: this hardcoding is a really ugly hack (skodak)
206                 $fileinfo = $repo->copy_to_area($source, $itemid, $saveas_path, $saveas_filename);
207                 $info = array();
208                 $info['file'] = $fileinfo['title'];
209                 $info['id'] = $itemid;
210                 $info['url'] = $CFG->httpswwwroot.'/draftfile.php/'.$fileinfo['contextid'].'/user/draft/'.$itemid.'/'.$fileinfo['title'];
211                 $filesize = $fileinfo['filesize'];
212                 if (($maxbytes!==-1) && ($filesize>$maxbytes)) {
213                     throw new file_exception('maxbytes');
214                 }
215                 echo json_encode($info);
216                 die;
217             }
218             // Download file to moodle
219             $file = $repo->get_file($source, $saveas_filename);
220             if ($file['path'] === false) {
221                 $err->error = get_string('cannotdownload', 'repository');
222                 die(json_encode($err));
223             }
225             // check if exceed maxbytes
226             if (($maxbytes!==-1) && (filesize($file['path']) > $maxbytes)) {
227                 throw new file_exception('maxbytes');
228             }
230             $record = new stdClass();
231             $record->filepath = $saveas_path;
232             $record->filename = $saveas_filename;
233             $record->component = 'user';
234             $record->filearea = 'draft';
235             $record->itemid   = $itemid;
237             if (!empty($file['license'])) {
238                 $record->license  = $file['license'];
239             } else {
240                 $record->license  = $license;
241             }
242             if (!empty($file['author'])) {
243                 $record->author   = $file['author'];
244             } else {
245                 $record->author   = $author;
246             }
247             $record->source = !empty($file['url']) ? $file['url'] : '';
249             $info = repository::move_to_filepool($file['path'], $record);
250             if (empty($info)) {
251                 $info['e'] = get_string('error', 'moodle');
252             }
253             echo json_encode($info);
254             die;
255         }
256         break;
257     case 'upload':
258         // handle exception here instead moodle default exception handler
259         // see MDL-23407
260         try {
261             // TODO: add file scanning MDL-19380 into each plugin
262             $result = $repo->upload($saveas_filename, $maxbytes);
263             echo json_encode($result);
264         } catch (Exception $e) {
265             $err->error = $e->getMessage();
266             echo json_encode($err);
267             die;
268         }
269         break;
272 /**
273  * Small function to walk an array to attach repository ID
274  * @param array $value
275  * @param string $key
276  * @param int $id
277  */
278 function repository_attach_id(&$value, $key, $id){
279     $value['repo_id'] = $id;