Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
   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   * A script to serve files from web service client
  20   *
  21   * @package    core_webservice
  22   * @copyright  2011 Dongsheng Cai <dongsheng@moodle.com>
  23   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24   */
  25  
  26  /**
  27   * AJAX_SCRIPT - exception will be converted into JSON
  28   */
  29  define('AJAX_SCRIPT', true);
  30  
  31  /**
  32   * NO_MOODLE_COOKIES - we don't want any cookie
  33   */
  34  define('NO_MOODLE_COOKIES', true);
  35  
  36  
  37  require_once(__DIR__ . '/../config.php');
  38  require_once($CFG->libdir . '/filelib.php');
  39  require_once($CFG->dirroot . '/webservice/lib.php');
  40  
  41  // Allow CORS requests.
  42  header('Access-Control-Allow-Origin: *');
  43  
  44  // Authenticate the user.
  45  $token = required_param('token', PARAM_ALPHANUM);
  46  // Use preview in order to display the preview of the file (e.g. "thumb" for a thumbnail).
  47  $preview = optional_param('preview', null, PARAM_ALPHANUM);
  48  // Offline means download the file from the repository and serve it, even if it was an external link.
  49  // The repository may have to export the file to an offline format.
  50  $offline = optional_param('offline', 0, PARAM_BOOL);
  51  
  52  $webservicelib = new webservice();
  53  $authenticationinfo = $webservicelib->authenticate_user($token);
  54  
  55  // Check the service allows file download.
  56  $enabledfiledownload = (int) ($authenticationinfo['service']->downloadfiles);
  57  if (empty($enabledfiledownload)) {
  58      throw new webservice_access_exception('Web service file downloading must be enabled in external service settings');
  59  }
  60  
  61  // Finally we can serve the file :).
  62  $relativepath = get_file_argument();
  63  file_pluginfile($relativepath, 0, $preview, $offline);