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