/theme/image.php
PHP | 243 lines | 164 code | 37 blank | 42 comment | 33 complexity | fa3c775ad74ed58176bd6883dd6cdea0 MD5 | raw file
Possible License(s): LGPL-2.1, AGPL-3.0, MPL-2.0-no-copyleft-exception, GPL-3.0, Apache-2.0, BSD-3-Clause
- <?php
- // This file is part of Moodle - http://moodle.org/
- //
- // Moodle is free software: you can redistribute it and/or modify
- // it under the terms of the GNU General Public License as published by
- // the Free Software Foundation, either version 3 of the License, or
- // (at your option) any later version.
- //
- // Moodle is distributed in the hope that it will be useful,
- // but WITHOUT ANY WARRANTY; without even the implied warranty of
- // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- // GNU General Public License for more details.
- //
- // You should have received a copy of the GNU General Public License
- // along with Moodle. If not, see <http://www.gnu.org/licenses/>.
- /**
- * This file is responsible for serving the one theme and plugin images.
- *
- * @package moodlecore
- * @copyright 2009 Petr Skoda (skodak) {@link http://skodak.org}
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
- // disable moodle specific debug messages and any errors in output,
- // comment out when debugging or better look into error log!
- define('NO_DEBUG_DISPLAY', true);
- // we need just the values from config.php and minlib.php
- define('ABORT_AFTER_CONFIG', true);
- require('../config.php'); // this stops immediately at the beginning of lib/setup.php
- if ($slashargument = min_get_slash_argument()) {
- $slashargument = ltrim($slashargument, '/');
- if (substr_count($slashargument, '/') < 3) {
- image_not_found();
- }
- // image must be last because it may contain "/"
- list($themename, $component, $rev, $image) = explode('/', $slashargument, 4);
- $themename = min_clean_param($themename, 'SAFEDIR');
- $component = min_clean_param($component, 'SAFEDIR');
- $rev = min_clean_param($rev, 'INT');
- $image = min_clean_param($image, 'SAFEPATH');
- } else {
- $themename = min_optional_param('theme', 'standard', 'SAFEDIR');
- $component = min_optional_param('component', 'core', 'SAFEDIR');
- $rev = min_optional_param('rev', -1, 'INT');
- $image = min_optional_param('image', '', 'SAFEPATH');
- }
- if (empty($component) or $component === 'moodle' or $component === 'core') {
- $component = 'moodle';
- }
- if (empty($image)) {
- image_not_found();
- }
- if (file_exists("$CFG->dirroot/theme/$themename/config.php")) {
- // exists
- } else if (!empty($CFG->themedir) and file_exists("$CFG->themedir/$themename/config.php")) {
- // exists
- } else {
- image_not_found();
- }
- $candidatelocation = "$CFG->cachedir/theme/$themename/pix/$component";
- $etag = sha1("$themename/$component/$rev/$image");
- if ($rev > -1) {
- if (file_exists("$candidatelocation/$image.error")) {
- // this is a major speedup if there are multiple missing images,
- // the only problem is that random requests may pollute our cache.
- image_not_found();
- }
- $cacheimage = false;
- if (file_exists("$candidatelocation/$image.gif")) {
- $cacheimage = "$candidatelocation/$image.gif";
- $ext = 'gif';
- } else if (file_exists("$candidatelocation/$image.png")) {
- $cacheimage = "$candidatelocation/$image.png";
- $ext = 'png';
- } else if (file_exists("$candidatelocation/$image.jpg")) {
- $cacheimage = "$candidatelocation/$image.jpg";
- $ext = 'jpg';
- } else if (file_exists("$candidatelocation/$image.jpeg")) {
- $cacheimage = "$candidatelocation/$image.jpeg";
- $ext = 'jpeg';
- } else if (file_exists("$candidatelocation/$image.ico")) {
- $cacheimage = "$candidatelocation/$image.ico";
- $ext = 'ico';
- }
- if ($cacheimage) {
- if (!empty($_SERVER['HTTP_IF_NONE_MATCH']) || !empty($_SERVER['HTTP_IF_MODIFIED_SINCE'])) {
- // we do not actually need to verify the etag value because our files
- // never change in cache because we increment the rev parameter
- $lifetime = 60*60*24*60; // 60 days only - the revision may get incremented quite often
- $mimetype = get_contenttype_from_ext($ext);
- header('HTTP/1.1 304 Not Modified');
- header('Expires: '. gmdate('D, d M Y H:i:s', time() + $lifetime) .' GMT');
- header('Cache-Control: public, max-age='.$lifetime);
- header('Content-Type: '.$mimetype);
- header('Etag: '.$etag);
- die;
- }
- send_cached_image($cacheimage, $etag);
- }
- }
- //=================================================================================
- // ok, now we need to start normal moodle script, we need to load all libs and $DB
- define('ABORT_AFTER_CONFIG_CANCEL', true);
- define('NO_MOODLE_COOKIES', true); // Session not used here
- define('NO_UPGRADE_CHECK', true); // Ignore upgrade check
- require("$CFG->dirroot/lib/setup.php");
- $theme = theme_config::load($themename);
- $imagefile = $theme->resolve_image_location($image, $component);
- $rev = theme_get_revision();
- $etag = sha1("$themename/$component/$rev/$image");
- if (empty($imagefile) or !is_readable($imagefile)) {
- if ($rev > -1) {
- if (!file_exists($candidatelocation)) {
- @mkdir($candidatelocation, $CFG->directorypermissions, true);
- }
- // make note we can not find this file
- $cacheimage = "$candidatelocation/$image.error";
- $fp = fopen($cacheimage, 'w');
- fclose($fp);
- }
- image_not_found();
- }
- if ($rev > -1) {
- $pathinfo = pathinfo($imagefile);
- $cacheimage = "$candidatelocation/$image.".$pathinfo['extension'];
- clearstatcache();
- if (!file_exists(dirname($cacheimage))) {
- @mkdir(dirname($cacheimage), $CFG->directorypermissions, true);
- }
- // Prevent serving of incomplete file from concurrent request,
- // the rename() should be more atomic than copy().
- ignore_user_abort(true);
- if (@copy($imagefile, $cacheimage.'.tmp')) {
- rename($cacheimage.'.tmp', $cacheimage);
- @chmod($cacheimage, $CFG->filepermissions);
- @unlink($cacheimage.'.tmp'); // just in case anything fails
- }
- ignore_user_abort(false);
- if (connection_aborted()) {
- die;
- }
- // make sure nothing failed
- clearstatcache();
- if (file_exists($cacheimage)) {
- send_cached_image($cacheimage, $etag);
- }
- }
- send_uncached_image($imagefile);
- //=================================================================================
- //=== utility functions ==
- // we are not using filelib because we need to fine tune all header
- // parameters to get the best performance.
- function send_cached_image($imagepath, $etag) {
- global $CFG;
- require("$CFG->dirroot/lib/xsendfilelib.php");
- $lifetime = 60*60*24*60; // 60 days only - the revision may get incremented quite often
- $pathinfo = pathinfo($imagepath);
- $imagename = $pathinfo['filename'].'.'.$pathinfo['extension'];
- $mimetype = get_contenttype_from_ext($pathinfo['extension']);
- header('Etag: '.$etag);
- header('Content-Disposition: inline; filename="'.$imagename.'"');
- header('Last-Modified: '. gmdate('D, d M Y H:i:s', filemtime($imagepath)) .' GMT');
- header('Expires: '. gmdate('D, d M Y H:i:s', time() + $lifetime) .' GMT');
- header('Pragma: ');
- header('Cache-Control: public, max-age='.$lifetime);
- header('Accept-Ranges: none');
- header('Content-Type: '.$mimetype);
- header('Content-Length: '.filesize($imagepath));
- if (xsendfile($imagepath)) {
- die;
- }
- // no need to gzip already compressed images ;-)
- readfile($imagepath);
- die;
- }
- function send_uncached_image($imagepath) {
- $pathinfo = pathinfo($imagepath);
- $imagename = $pathinfo['filename'].'.'.$pathinfo['extension'];
- $mimetype = get_contenttype_from_ext($pathinfo['extension']);
- header('Content-Disposition: inline; filename="'.$imagename.'"');
- header('Last-Modified: '. gmdate('D, d M Y H:i:s', time()) .' GMT');
- header('Expires: '. gmdate('D, d M Y H:i:s', time() + 15) .' GMT');
- header('Pragma: ');
- header('Accept-Ranges: none');
- header('Content-Type: '.$mimetype);
- header('Content-Length: '.filesize($imagepath));
- readfile($imagepath);
- die;
- }
- function image_not_found() {
- header('HTTP/1.0 404 not found');
- die('Image was not found, sorry.');
- }
- function get_contenttype_from_ext($ext) {
- switch ($ext) {
- case 'gif':
- return 'image/gif';
- case 'png':
- return 'image/png';
- case 'jpg':
- case 'jpeg':
- return 'image/jpeg';
- case 'ico':
- return 'image/vnd.microsoft.icon';
- }
- return 'document/unknown';
- }