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/>.
  16
  17
  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  */
  26
  27 define('AJAX_SCRIPT', true);
  28
  29 require_once(dirname(dirname(__FILE__)).'/config.php');
  30 require_once(dirname(dirname(__FILE__)).'/lib/filelib.php');
  31 require_once(dirname(__FILE__).'/lib.php');
  32
  33 $err = new stdClass();
  34
  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 $saveas_path   = optional_param('savepath', '/', PARAM_PATH);   // save as file path
  50 $search_text   = optional_param('s', '', PARAM_CLEANHTML);
  51 $linkexternal  = optional_param('linkexternal', '', PARAM_ALPHA);
  52 $usefilereference  = optional_param('usefilereference', false, PARAM_BOOL);
  53
  54 list($context, $course, $cm) = get_context_info_array($contextid);
  55 require_login($course, false, $cm);
  56 $PAGE->set_context($context);
  57
  58 echo $OUTPUT->header(); // send headers
  59 @header('Content-type: text/html; charset=utf-8');
  60
  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 }
  66
  67 if (!confirm_sesskey()) {
  68     $err->error = get_string('invalidsesskey', 'error');
  69     die(json_encode($err));
  70 }
  71
  72 // Get repository instance information
  73 $sql = 'SELECT i.name, i.typeid, r.type FROM {repository} r, {repository_instances} i WHERE i.id=? AND i.typeid=r.id';
  74
  75 if (!$repository = $DB->get_record_sql($sql, array($repo_id))) {
  76     $err->error = get_string('invalidrepositoryid', 'repository');
  77     die(json_encode($err));
  78 } else {
  79     $type = $repository->type;
  80 }
  81
  82 // Check permissions
  83 repository::check_capability($contextid, $repository);
  84
  85 $moodle_maxbytes = get_user_max_upload_file_size($context);
  86 // to prevent maxbytes greater than moodle maxbytes setting
  87 if ($maxbytes == 0 || $maxbytes>=$moodle_maxbytes) {
  88     $maxbytes = $moodle_maxbytes;
  89 }
  90
  91 // Wait as long as it takes for this script to finish
  92 set_time_limit(0);
  93
  94 // Early actions which need to be done before repository instances initialised
  95 switch ($action) {
  96     // global search
  97     case 'gsearch':
  98         $params = array();
  99         $params['context'] = array(get_context_instance_by_id($contextid), get_system_context());
 100         $params['currentcontext'] = get_context_instance_by_id($contextid);
 101         $repos = repository::get_instances($params);
 102         $list = array();
 103         foreach($repos as $repo){
 104             if ($repo->global_search()) {
 105                 $ret = $repo->search($search_text);
 106                 array_walk($ret['list'], 'repository_attach_id', $repo->id);  // See function below
 107                 $tmp = array_merge($list, $ret['list']);
 108                 $list = $tmp;
 109             }
 110         }
 111         $listing = array('list'=>$list);
 112         $listing['gsearch'] = true;
 113         die(json_encode($listing));
 114         break;
 115
 116     // remove the cache files & logout
 117     case 'ccache':
 118         $cache = new curl_cache;
 119         $cache->refresh();
 120         $action = 'list';
 121         break;
 122 }
 123
 124 if (file_exists($CFG->dirroot.'/repository/'.$type.'/lib.php')) {
 125     require_once($CFG->dirroot.'/repository/'.$type.'/lib.php');
 126     $classname = 'repository_' . $type;
 127     $repooptions = array(
 128         'ajax' => true,
 129         'name' => $repository->name,
 130         'type' => $type,
 131         'mimetypes' => $accepted_types
 132     );
 133     $repo = new $classname($repo_id, $contextid, $repooptions);
 134 } else {
 135     $err->error = get_string('invalidplugin', 'repository', $type);
 136     die(json_encode($err));
 137 }
 138
 139 // These actions all occur on the currently active repository instance
 140 switch ($action) {
 141     case 'sign':
 142     case 'signin':
 143     case 'list':
 144         if ($repo->check_login()) {
 145             $listing = repository::prepare_listing($repo->get_listing($req_path, $page));
 146             $listing['repo_id'] = $repo_id;
 147             echo json_encode($listing);
 148             break;
 149         } else {
 150             $action = 'login';
 151         }
 152     case 'login':
 153         $listing = $repo->print_login();
 154         $listing['repo_id'] = $repo_id;
 155         echo json_encode($listing);
 156         break;
 157     case 'logout':
 158         $logout = $repo->logout();
 159         $logout['repo_id'] = $repo_id;
 160         echo json_encode($logout);
 161         break;
 162     case 'searchform':
 163         $search_form['repo_id'] = $repo_id;
 164         $search_form['form'] = $repo->print_search();
 165         $search_form['allowcaching'] = true;
 166         echo json_encode($search_form);
 167         break;
 168     case 'search':
 169         $search_result = repository::prepare_listing($repo->search($search_text, (int)$page));
 170         $search_result['repo_id'] = $repo_id;
 171         $search_result['issearchresult'] = true;
 172         echo json_encode($search_result);
 173         break;
 174     case 'download':
 175         // validate mimetype
 176         $mimetypes = array();
 177         if ((is_array($accepted_types) and in_array('*', $accepted_types)) or $accepted_types == '*') {
 178             $mimetypes = '*';
 179         } else {
 180             foreach ($accepted_types as $type) {
 181                 $mimetypes[] = mimeinfo('type', $type);
 182             }
 183             if (!in_array(mimeinfo('type', $saveas_filename), $mimetypes)) {
 184                 throw new moodle_exception('invalidfiletype', 'repository', '', get_mimetype_description(array('filename' => $saveas_filename)));
 185             }
 186         }
 187
 188         // We have two special repository type need to deal with
 189         // local and recent plugins don't added new files to moodle, just add new records to database
 190         // so we don't check user quota and maxbytes here
 191         $allowexternallink = (int)get_config(null, 'repositoryallowexternallinks');
 192         if (!empty($allowexternallink)) {
 193             $allowexternallink = true;
 194         } else {
 195             $allowexternallink = false;
 196         }
 197         // allow external links in url element all the time
 198         $allowexternallink = ($allowexternallink || ($env == 'url'));
 199
 200         // Use link of the files
 201         if ($allowexternallink and $linkexternal === 'yes' and ($repo->supported_returntypes() & FILE_EXTERNAL)) {
 202             // use external link
 203             $link = $repo->get_link($source);
 204             $info = array();
 205             $info['file'] = $saveas_filename;
 206             $info['type'] = 'link';
 207             $info['url'] = $link;
 208             echo json_encode($info);
 209             die;
 210         } else {
 211             $fs = get_file_storage();
 212
 213             // Prepare file record.
 214             $record = new stdClass();
 215             $record->filepath = $saveas_path;
 216             $record->filename = $saveas_filename;
 217             $record->component = 'user';
 218             $record->filearea = 'draft';
 219             $record->itemid = $itemid;
 220             $record->license = $license;
 221             $record->author = $author;
 222
 223             if ($record->filepath !== '/') {
 224                 $record->filepath = trim($record->filepath, '/');
 225                 $record->filepath = '/'.$record->filepath.'/';
 226             }
 227             $usercontext = get_context_instance(CONTEXT_USER, $USER->id);
 228             $now = time();
 229             $record->contextid = $usercontext->id;
 230             $record->timecreated = $now;
 231             $record->timemodified = $now;
 232             $record->userid = $USER->id;
 233
 234             // If file is already a reference, set $source = file source, $repo = file repository
 235             if ($repo->has_moodle_files()) {
 236                 $file = repository::get_moodle_file($source);
 237                 if ($file && $file->is_external_file()) {
 238                     $source = $file->get_reference();
 239                     $repo_id = $file->get_repository_id();
 240                     $repo = repository::get_repository_by_id($repo_id, $contextid, $repooptions);
 241                 }
 242             }
 243
 244             if ($usefilereference) {
 245                 $reference = $repo->get_file_reference($source);
 246                 // get reference life time from repo
 247                 $record->referencelifetime = $repo->get_reference_file_lifetime($reference);
 248                 // Check if file exists.
 249                 if (repository::draftfile_exists($itemid, $saveas_path, $saveas_filename)) {
 250                     // File name being used, rename it.
 251                     $unused_filename = repository::get_unused_filename($itemid, $saveas_path, $saveas_filename);
 252                     $record->filename = $unused_filename;
 253                     // Create a file copy using unused filename.
 254                     $storedfile = $fs->create_file_from_reference($record, $repo_id, $reference);
 255
 256                     $event = array();
 257                     $event['event'] = 'fileexists';
 258                     $event['newfile'] = new stdClass;
 259                     $event['newfile']->filepath = $saveas_path;
 260                     $event['newfile']->filename = $unused_filename;
 261                     $event['newfile']->url = moodle_url::make_draftfile_url($itemid, $saveas_path, $unused_filename)->out();
 262
 263                     $event['existingfile'] = new stdClass;
 264                     $event['existingfile']->filepath = $saveas_path;
 265                     $event['existingfile']->filename = $saveas_filename;
 266                     $event['existingfile']->url      = moodle_url::make_draftfile_url($itemid, $saveas_path, $saveas_filename)->out();;
 267                 } else {
 268
 269                     // {@link repository::build_source_field()}
 270                     $sourcefield = $repo->get_file_source_info($source);
 271                     $record->source = $repo::build_source_field($sourcefield);
 272
 273                     $storedfile = $fs->create_file_from_reference($record, $repo_id, $reference);
 274                     $event = array(
 275                         'url'=>moodle_url::make_draftfile_url($storedfile->get_itemid(), $storedfile->get_filepath(), $storedfile->get_filename())->out(),
 276                         'id'=>$storedfile->get_itemid(),
 277                         'file'=>$storedfile->get_filename(),
 278                         'icon' => $OUTPUT->pix_url(file_file_icon($storedfile, 32))->out(),
 279                     );
 280                 }
 281                 // Repository plugin callback
 282                 // You can cache reository file in this callback
 283                 // or complete other tasks.
 284                 $repo->cache_file_by_reference($reference, $storedfile);
 285                 echo json_encode($event);
 286                 die;
 287             } else if ($repo->has_moodle_files()) {
 288                 // Some repository plugins (local, user, coursefiles, recent) are hosting moodle
 289                 // internal files, we cannot use get_file method, so we use copy_to_area method
 290
 291                 // If the moodle file is an alias we copy this alias, otherwise we copy the file
 292                 // {@link repository::copy_to_area()}.
 293                 $fileinfo = $repo->copy_to_area($source, $record, $maxbytes);
 294
 295                 echo json_encode($fileinfo);
 296                 die;
 297             } else {
 298                 // Download file to moodle.
 299                 $downloadedfile = $repo->get_file($source, $saveas_filename);
 300                 if ($downloadedfile['path'] === false) {
 301                     $err->error = get_string('cannotdownload', 'repository');
 302                     die(json_encode($err));
 303                 }
 304
 305                 // Check if exceed maxbytes.
 306                 if (($maxbytes!==-1) && (filesize($downloadedfile['path']) > $maxbytes)) {
 307                     throw new file_exception('maxbytes');
 308                 }
 309
 310                 // {@link repository::build_source_field()}
 311                 $sourcefield = $repo->get_file_source_info($source);
 312                 $record->source = $repo::build_source_field($sourcefield);
 313
 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;
 327
 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);
 335
 336         $info = repository::overwrite_existing_draftfile($itemid, $filepath, $filename, $newfilepath, $newfilename);
 337         echo json_encode($info);
 338         break;
 339
 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));
 345
 346         break;
 347 }