weekly release 2.6dev
[moodle.git] / repository / repository_ajax.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * The Web service script that is called from the filepicker front end
20  *
21  * @since 2.0
22  * @package    repository
23  * @copyright  2009 Dongsheng Cai {@link http://dongsheng.org}
24  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
27 define('AJAX_SCRIPT', true);
29 require_once(dirname(dirname(__FILE__)).'/config.php');
30 require_once(dirname(dirname(__FILE__)).'/lib/filelib.php');
31 require_once(dirname(__FILE__).'/lib.php');
33 $err = new stdClass();
35 // Parameters
36 $action    = optional_param('action', '', PARAM_ALPHA);
37 $repo_id   = optional_param('repo_id', 0, PARAM_INT);           // Repository ID
38 $contextid = optional_param('ctx_id', SYSCONTEXTID, PARAM_INT); // Context ID
39 $env       = optional_param('env', 'filepicker', PARAM_ALPHA);  // Opened in editor or moodleform
40 $license   = optional_param('license', $CFG->sitedefaultlicense, PARAM_TEXT);
41 $author    = optional_param('author', '', PARAM_TEXT);          // File author
42 $source    = optional_param('source', '', PARAM_RAW);           // File to download
43 $itemid    = optional_param('itemid', 0, PARAM_INT);            // Itemid
44 $page      = optional_param('page', '', PARAM_RAW);             // Page
45 $maxbytes  = optional_param('maxbytes', 0, PARAM_INT);          // Maxbytes
46 $req_path  = optional_param('p', '', PARAM_RAW);                // Path
47 $accepted_types  = optional_param_array('accepted_types', '*', PARAM_RAW);
48 $saveas_filename = optional_param('title', '', PARAM_FILE);     // save as file name
49 $areamaxbytes  = optional_param('areamaxbytes', FILE_AREA_MAX_BYTES_UNLIMITED, PARAM_INT); // Area max bytes.
50 $saveas_path   = optional_param('savepath', '/', PARAM_PATH);   // save as file path
51 $search_text   = optional_param('s', '', PARAM_CLEANHTML);
52 $linkexternal  = optional_param('linkexternal', '', PARAM_ALPHA);
53 $usefilereference  = optional_param('usefilereference', false, PARAM_BOOL);
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 uploaded file is larger than post_max_size (php.ini) setting, $_POST content will be empty.
62 if (empty($_POST) && !empty($action)) {
63     $err->error = get_string('errorpostmaxsize', 'repository');
64     die(json_encode($err));
65 }
67 if (!confirm_sesskey()) {
68     $err->error = get_string('invalidsesskey', 'error');
69     die(json_encode($err));
70 }
72 // Get repository instance information
73 $repooptions = array(
74     'ajax' => true,
75     'mimetypes' => $accepted_types
76 );
77 $repo = repository::get_repository_by_id($repo_id, $contextid, $repooptions);
79 // Check permissions
80 $repo->check_capability();
82 $coursemaxbytes = 0;
83 if (!empty($course)) {
84     $coursemaxbytes = $course->maxbytes;
85 }
86 // Make sure maxbytes passed is within site filesize limits.
87 $maxbytes = get_user_max_upload_file_size($context, $CFG->maxbytes, $coursemaxbytes, $maxbytes);
89 // Wait as long as it takes for this script to finish
90 set_time_limit(0);
92 // Early actions which need to be done before repository instances initialised
93 switch ($action) {
94     // global search
95     case 'gsearch':
96         $params = array();
97         $params['context'] = array(context::instance_by_id($contextid), context_system::instance());
98         $params['currentcontext'] = context::instance_by_id($contextid);
99         $repos = repository::get_instances($params);
100         $list = array();
101         foreach($repos as $repo){
102             if ($repo->global_search()) {
103                 $ret = $repo->search($search_text);
104                 array_walk($ret['list'], 'repository_attach_id', $repo->id);  // See function below
105                 $tmp = array_merge($list, $ret['list']);
106                 $list = $tmp;
107             }
108         }
109         $listing = array('list'=>$list);
110         $listing['gsearch'] = true;
111         die(json_encode($listing));
112         break;
114     // remove the cache files & logout
115     case 'ccache':
116         $cache = new curl_cache;
117         $cache->refresh();
118         $action = 'list';
119         break;
122 // These actions all occur on the currently active repository instance
123 switch ($action) {
124     case 'sign':
125     case 'signin':
126     case 'list':
127         if ($repo->check_login()) {
128             $listing = repository::prepare_listing($repo->get_listing($req_path, $page));
129             $listing['repo_id'] = $repo_id;
130             echo json_encode($listing);
131             break;
132         } else {
133             $action = 'login';
134         }
135     case 'login':
136         $listing = $repo->print_login();
137         $listing['repo_id'] = $repo_id;
138         echo json_encode($listing);
139         break;
140     case 'logout':
141         $logout = $repo->logout();
142         $logout['repo_id'] = $repo_id;
143         echo json_encode($logout);
144         break;
145     case 'searchform':
146         $search_form['repo_id'] = $repo_id;
147         $search_form['form'] = $repo->print_search();
148         $search_form['allowcaching'] = true;
149         echo json_encode($search_form);
150         break;
151     case 'search':
152         $search_result = repository::prepare_listing($repo->search($search_text, (int)$page));
153         $search_result['repo_id'] = $repo_id;
154         $search_result['issearchresult'] = true;
155         echo json_encode($search_result);
156         break;
157     case 'download':
158         // validate mimetype
159         $mimetypes = array();
160         if ((is_array($accepted_types) and in_array('*', $accepted_types)) or $accepted_types == '*') {
161             $mimetypes = '*';
162         } else {
163             foreach ($accepted_types as $type) {
164                 $mimetypes[] = mimeinfo('type', $type);
165             }
166             if (!in_array(mimeinfo('type', $saveas_filename), $mimetypes)) {
167                 throw new moodle_exception('invalidfiletype', 'repository', '', get_mimetype_description(array('filename' => $saveas_filename)));
168             }
169         }
171         // We have two special repository type need to deal with
172         // local and recent plugins don't added new files to moodle, just add new records to database
173         // so we don't check user quota and maxbytes here
174         $allowexternallink = (int)get_config(null, 'repositoryallowexternallinks');
175         if (!empty($allowexternallink)) {
176             $allowexternallink = true;
177         } else {
178             $allowexternallink = false;
179         }
180         // allow external links in url element all the time
181         $allowexternallink = ($allowexternallink || ($env == 'url'));
183         $reference = $repo->get_file_reference($source);
185         // Use link of the files
186         if ($allowexternallink and $linkexternal === 'yes' and ($repo->supported_returntypes() & FILE_EXTERNAL)) {
187             // use external link
188             $link = $repo->get_link($reference);
189             $info = array();
190             $info['file'] = $saveas_filename;
191             $info['type'] = 'link';
192             $info['url'] = $link;
193             echo json_encode($info);
194             die;
195         } else {
196             $fs = get_file_storage();
198             // Prepare file record.
199             $record = new stdClass();
200             $record->filepath = $saveas_path;
201             $record->filename = $saveas_filename;
202             $record->component = 'user';
203             $record->filearea = 'draft';
204             $record->itemid = $itemid;
205             $record->license = $license;
206             $record->author = $author;
208             if ($record->filepath !== '/') {
209                 $record->filepath = trim($record->filepath, '/');
210                 $record->filepath = '/'.$record->filepath.'/';
211             }
212             $usercontext = context_user::instance($USER->id);
213             $now = time();
214             $record->contextid = $usercontext->id;
215             $record->timecreated = $now;
216             $record->timemodified = $now;
217             $record->userid = $USER->id;
218             $record->sortorder = 0;
220             // Check that user has permission to access this file
221             if (!$repo->file_is_accessible($source)) {
222                 throw new file_exception('storedfilecannotread');
223             }
225             // {@link repository::build_source_field()}
226             $sourcefield = $repo->get_file_source_info($source);
227             $record->source = $repo::build_source_field($sourcefield);
229             // If file is already a reference, set $source = file source, $repo = file repository
230             // note that in this case user may not have permission to access the source file directly
231             // so no file_browser/file_info can be used below
232             if ($repo->has_moodle_files()) {
233                 $file = repository::get_moodle_file($source);
234                 if ($file && $file->is_external_file()) {
235                     $sourcefield = $file->get_source(); // remember the original source
236                     $record->source = $repo::build_source_field($sourcefield);
237                     $record->contenthash = $file->get_contenthash();
238                     $record->filesize = $file->get_filesize();
239                     $reference = $file->get_reference();
240                     $repo_id = $file->get_repository_id();
241                     $repo = repository::get_repository_by_id($repo_id, $contextid, $repooptions);
242                 }
243             }
245             if ($usefilereference) {
246                 if ($repo->has_moodle_files()) {
247                     $sourcefile = repository::get_moodle_file($reference);
248                     $record->contenthash = $sourcefile->get_contenthash();
249                     $record->filesize = $sourcefile->get_filesize();
250                 }
251                 // Check if file exists.
252                 if (repository::draftfile_exists($itemid, $saveas_path, $saveas_filename)) {
253                     // File name being used, rename it.
254                     $unused_filename = repository::get_unused_filename($itemid, $saveas_path, $saveas_filename);
255                     $record->filename = $unused_filename;
256                     // Create a file copy using unused filename.
257                     $storedfile = $fs->create_file_from_reference($record, $repo_id, $reference);
259                     $event = array();
260                     $event['event'] = 'fileexists';
261                     $event['newfile'] = new stdClass;
262                     $event['newfile']->filepath = $saveas_path;
263                     $event['newfile']->filename = $unused_filename;
264                     $event['newfile']->url = moodle_url::make_draftfile_url($itemid, $saveas_path, $unused_filename)->out();
266                     $event['existingfile'] = new stdClass;
267                     $event['existingfile']->filepath = $saveas_path;
268                     $event['existingfile']->filename = $saveas_filename;
269                     $event['existingfile']->url      = moodle_url::make_draftfile_url($itemid, $saveas_path, $saveas_filename)->out();
270                 } else {
272                     $storedfile = $fs->create_file_from_reference($record, $repo_id, $reference);
273                     $event = array(
274                         'url'=>moodle_url::make_draftfile_url($storedfile->get_itemid(), $storedfile->get_filepath(), $storedfile->get_filename())->out(),
275                         'id'=>$storedfile->get_itemid(),
276                         'file'=>$storedfile->get_filename(),
277                         'icon' => $OUTPUT->pix_url(file_file_icon($storedfile, 32))->out(),
278                     );
279                 }
280                 // Repository plugin callback
281                 // You can cache reository file in this callback
282                 // or complete other tasks.
283                 $repo->cache_file_by_reference($reference, $storedfile);
284                 echo json_encode($event);
285                 die;
286             } else if ($repo->has_moodle_files()) {
287                 // Some repository plugins (local, user, coursefiles, recent) are hosting moodle
288                 // internal files, we cannot use get_file method, so we use copy_to_area method
290                 // If the moodle file is an alias we copy this alias, otherwise we copy the file
291                 // {@link repository::copy_to_area()}.
292                 $fileinfo = $repo->copy_to_area($reference, $record, $maxbytes, $areamaxbytes);
294                 echo json_encode($fileinfo);
295                 die;
296             } else {
297                 // Download file to moodle.
298                 $downloadedfile = $repo->get_file($reference, $saveas_filename);
299                 if (empty($downloadedfile['path'])) {
300                     $err->error = get_string('cannotdownload', 'repository');
301                     die(json_encode($err));
302                 }
304                 // Check if exceed maxbytes.
305                 if ($maxbytes != -1 && filesize($downloadedfile['path']) > $maxbytes) {
306                     throw new file_exception('maxbytes');
307                 }
309                 // Check if we exceed the max bytes of the area.
310                 if (file_is_draft_area_limit_reached($itemid, $areamaxbytes, filesize($downloadedfile['path']))) {
311                     throw new file_exception('maxareabytes');
312                 }
314                 $info = repository::move_to_filepool($downloadedfile['path'], $record);
315                 if (empty($info)) {
316                     $info['e'] = get_string('error', 'moodle');
317                 }
318             }
319             echo json_encode($info);
320             die;
321         }
322         break;
323     case 'upload':
324         $result = $repo->upload($saveas_filename, $maxbytes);
325         echo json_encode($result);
326         break;
328     case 'overwrite':
329         // existing file
330         $filepath    = required_param('existingfilepath', PARAM_PATH);
331         $filename    = required_param('existingfilename', PARAM_FILE);
332         // user added file which needs to replace the existing file
333         $newfilepath = required_param('newfilepath', PARAM_PATH);
334         $newfilename = required_param('newfilename', PARAM_FILE);
336         $info = repository::overwrite_existing_draftfile($itemid, $filepath, $filename, $newfilepath, $newfilename);
337         echo json_encode($info);
338         break;
340     case 'deletetmpfile':
341         // delete tmp file
342         $newfilepath = required_param('newfilepath', PARAM_PATH);
343         $newfilename = required_param('newfilename', PARAM_FILE);
344         echo json_encode(repository::delete_tempfile_from_draft($itemid, $newfilepath, $newfilename));
346         break;