Merge branch 'MDL-41891_master' of https://github.com/nadavkav/moodle
[moodle.git] / theme / image.php
CommitLineData
78946b9b 1<?php
78946b9b
PS
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 * This file is responsible for serving the one theme and plugin images.
19 *
574909ef 20 * @package core
78946b9b
PS
21 * @copyright 2009 Petr Skoda (skodak) {@link http://skodak.org}
22 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 */
24
73e504bc 25
c198390a
PS
26// disable moodle specific debug messages and any errors in output,
27// comment out when debugging or better look into error log!
28define('NO_DEBUG_DISPLAY', true);
29
78946b9b
PS
30// we need just the values from config.php and minlib.php
31define('ABORT_AFTER_CONFIG', true);
32require('../config.php'); // this stops immediately at the beginning of lib/setup.php
33
9d473266
PS
34if ($slashargument = min_get_slash_argument()) {
35 $slashargument = ltrim($slashargument, '/');
36 if (substr_count($slashargument, '/') < 3) {
37 image_not_found();
38 }
436dbeec
SH
39 if (strpos($slashargument, '_s/') === 0) {
40 // Can't use SVG
41 $slashargument = substr($slashargument, 3);
42 $usesvg = false;
43 } else {
44 $usesvg = true;
45 }
9d473266
PS
46 // image must be last because it may contain "/"
47 list($themename, $component, $rev, $image) = explode('/', $slashargument, 4);
48 $themename = min_clean_param($themename, 'SAFEDIR');
49 $component = min_clean_param($component, 'SAFEDIR');
50 $rev = min_clean_param($rev, 'INT');
51 $image = min_clean_param($image, 'SAFEPATH');
78946b9b 52
9d473266
PS
53} else {
54 $themename = min_optional_param('theme', 'standard', 'SAFEDIR');
55 $component = min_optional_param('component', 'core', 'SAFEDIR');
56 $rev = min_optional_param('rev', -1, 'INT');
57 $image = min_optional_param('image', '', 'SAFEPATH');
436dbeec 58 $usesvg = (bool)min_optional_param('svg', '1', 'INT');
9d473266
PS
59}
60
61if (empty($component) or $component === 'moodle' or $component === 'core') {
036e925b 62 $component = 'core';
9d473266
PS
63}
64
65if (empty($image)) {
78946b9b
PS
66 image_not_found();
67}
68
73e504bc
PS
69if (file_exists("$CFG->dirroot/theme/$themename/config.php")) {
70 // exists
71} else if (!empty($CFG->themedir) and file_exists("$CFG->themedir/$themename/config.php")) {
72 // exists
73} else {
78946b9b
PS
74 image_not_found();
75}
76
cb8108dd 77$candidatelocation = "$CFG->localcachedir/theme/$rev/$themename/pix/$component";
036e925b 78$etag = sha1("$rev/$themename/$component/$image");
78946b9b 79
036e925b 80if ($rev > 0) {
78946b9b 81 if (file_exists("$candidatelocation/$image.error")) {
036e925b 82 // This is a major speedup if there are multiple missing images,
78946b9b
PS
83 // the only problem is that random requests may pollute our cache.
84 image_not_found();
85 }
86 $cacheimage = false;
436dbeec
SH
87 if ($usesvg && file_exists("$candidatelocation/$image.svg")) {
88 $cacheimage = "$candidatelocation/$image.svg";
89 $ext = 'svg';
78946b9b
PS
90 } else if (file_exists("$candidatelocation/$image.png")) {
91 $cacheimage = "$candidatelocation/$image.png";
ccc0fff9 92 $ext = 'png';
436dbeec
SH
93 } else if (file_exists("$candidatelocation/$image.gif")) {
94 $cacheimage = "$candidatelocation/$image.gif";
95 $ext = 'gif';
78946b9b
PS
96 } else if (file_exists("$candidatelocation/$image.jpg")) {
97 $cacheimage = "$candidatelocation/$image.jpg";
ccc0fff9 98 $ext = 'jpg';
78946b9b
PS
99 } else if (file_exists("$candidatelocation/$image.jpeg")) {
100 $cacheimage = "$candidatelocation/$image.jpeg";
ccc0fff9 101 $ext = 'jpeg';
78946b9b
PS
102 } else if (file_exists("$candidatelocation/$image.ico")) {
103 $cacheimage = "$candidatelocation/$image.ico";
ccc0fff9 104 $ext = 'ico';
78946b9b
PS
105 }
106 if ($cacheimage) {
aa603b14 107 if (!empty($_SERVER['HTTP_IF_NONE_MATCH']) || !empty($_SERVER['HTTP_IF_MODIFIED_SINCE'])) {
78946b9b
PS
108 // we do not actually need to verify the etag value because our files
109 // never change in cache because we increment the rev parameter
71d4c603 110 $lifetime = 60*60*24*60; // 60 days only - the revision may get incremented quite often
ccc0fff9 111 $mimetype = get_contenttype_from_ext($ext);
aa603b14 112 header('HTTP/1.1 304 Not Modified');
ccc0fff9 113 header('Expires: '. gmdate('D, d M Y H:i:s', time() + $lifetime) .' GMT');
c3a3f540 114 header('Cache-Control: public, max-age='.$lifetime.', no-transform');
ccc0fff9 115 header('Content-Type: '.$mimetype);
06eca486 116 header('Etag: "'.$etag.'"');
78946b9b
PS
117 die;
118 }
71d4c603 119 send_cached_image($cacheimage, $etag);
78946b9b
PS
120 }
121}
122
123//=================================================================================
124// ok, now we need to start normal moodle script, we need to load all libs and $DB
125define('ABORT_AFTER_CONFIG_CANCEL', true);
126
127define('NO_MOODLE_COOKIES', true); // Session not used here
128define('NO_UPGRADE_CHECK', true); // Ignore upgrade check
129
130require("$CFG->dirroot/lib/setup.php");
131
132$theme = theme_config::load($themename);
036e925b
PS
133$themerev = theme_get_revision();
134
135if ($themerev <= 0 or $rev != $themerev) {
136 // Do not send caching headers if they do not request current revision,
137 // we do not want to pollute browser caches with outdated images.
138 $imagefile = $theme->resolve_image_location($image, $component, $usesvg);
139 if (empty($imagefile) or !is_readable($imagefile)) {
140 image_not_found();
141 }
142 send_uncached_image($imagefile);
143}
144
cb8108dd 145make_localcache_directory('theme', false);
78946b9b 146
27c1c305
SH
147// We're not using SVG and there is no cached version of this file (in any format).
148// As we're going to be caching a format other than svg, and because svg use is conditional we need to ensure that at the same
149// time we cache a version of the SVG if it exists. If we don't do this other users who ask for SVG would not ever get it as
150// there is a cached image already of another format.
151// Remember this only gets run once before any candidate exists, and only if we want a cached revision.
036e925b 152if (!$usesvg) {
27c1c305
SH
153 $imagefile = $theme->resolve_image_location($image, $component, true);
154 if (!empty($imagefile) && is_readable($imagefile)) {
155 $cacheimage = cache_image($image, $imagefile, $candidatelocation);
156 $pathinfo = pathinfo($imagefile);
036e925b 157 // There is no SVG equivalent, we've just successfully cached an image of another format.
27c1c305
SH
158 if ($pathinfo['extension'] !== 'svg') {
159 // Serve the file as we would in a normal request.
160 if (connection_aborted()) {
161 die;
162 }
036e925b 163 // Make sure nothing failed.
27c1c305
SH
164 clearstatcache();
165 if (file_exists($cacheimage)) {
166 send_cached_image($cacheimage, $etag);
167 }
168 send_uncached_image($imagefile);
169 exit;
170 }
171 }
172}
173
174// Either SVG was requested or we've cached a SVG version and are ready to serve a regular format.
175$imagefile = $theme->resolve_image_location($image, $component, $usesvg);
78946b9b 176if (empty($imagefile) or !is_readable($imagefile)) {
036e925b
PS
177 if (!file_exists($candidatelocation)) {
178 @mkdir($candidatelocation, $CFG->directorypermissions, true);
78946b9b 179 }
036e925b
PS
180 // Make note we can not find this file.
181 $cacheimage = "$candidatelocation/$image.error";
182 $fp = fopen($cacheimage, 'w');
183 fclose($fp);
78946b9b
PS
184 image_not_found();
185}
186
036e925b
PS
187$cacheimage = cache_image($image, $imagefile, $candidatelocation);
188if (connection_aborted()) {
189 die;
190}
191// Make sure nothing failed.
192clearstatcache();
193if (file_exists($cacheimage)) {
194 send_cached_image($cacheimage, $etag);
78946b9b
PS
195}
196
979d3207
PS
197send_uncached_image($imagefile);
198
78946b9b
PS
199
200//=================================================================================
201//=== utility functions ==
202// we are not using filelib because we need to fine tune all header
203// parameters to get the best performance.
204
71d4c603 205function send_cached_image($imagepath, $etag) {
7e9f1b63
PS
206 global $CFG;
207 require("$CFG->dirroot/lib/xsendfilelib.php");
208
71d4c603 209 $lifetime = 60*60*24*60; // 60 days only - the revision may get incremented quite often
78946b9b
PS
210 $pathinfo = pathinfo($imagepath);
211 $imagename = $pathinfo['filename'].'.'.$pathinfo['extension'];
212
ccc0fff9 213 $mimetype = get_contenttype_from_ext($pathinfo['extension']);
78946b9b 214
06eca486 215 header('Etag: "'.$etag.'"');
78946b9b 216 header('Content-Disposition: inline; filename="'.$imagename.'"');
71d4c603 217 header('Last-Modified: '. gmdate('D, d M Y H:i:s', filemtime($imagepath)) .' GMT');
78946b9b
PS
218 header('Expires: '. gmdate('D, d M Y H:i:s', time() + $lifetime) .' GMT');
219 header('Pragma: ');
c3a3f540 220 header('Cache-Control: public, max-age='.$lifetime.', no-transform');
78946b9b
PS
221 header('Accept-Ranges: none');
222 header('Content-Type: '.$mimetype);
223 header('Content-Length: '.filesize($imagepath));
224
7e9f1b63
PS
225 if (xsendfile($imagepath)) {
226 die;
227 }
228
7c986f04
PS
229 // no need to gzip already compressed images ;-)
230
78946b9b
PS
231 readfile($imagepath);
232 die;
233}
234
235function send_uncached_image($imagepath) {
236 $pathinfo = pathinfo($imagepath);
237 $imagename = $pathinfo['filename'].'.'.$pathinfo['extension'];
238
ccc0fff9 239 $mimetype = get_contenttype_from_ext($pathinfo['extension']);
78946b9b
PS
240
241 header('Content-Disposition: inline; filename="'.$imagename.'"');
242 header('Last-Modified: '. gmdate('D, d M Y H:i:s', time()) .' GMT');
13ea159e 243 header('Expires: '. gmdate('D, d M Y H:i:s', time() + 15) .' GMT');
78946b9b
PS
244 header('Pragma: ');
245 header('Accept-Ranges: none');
246 header('Content-Type: '.$mimetype);
247 header('Content-Length: '.filesize($imagepath));
248
78946b9b
PS
249 readfile($imagepath);
250 die;
251}
252
253function image_not_found() {
254 header('HTTP/1.0 404 not found');
255 die('Image was not found, sorry.');
ccc0fff9
TL
256}
257
258function get_contenttype_from_ext($ext) {
259 switch ($ext) {
436dbeec
SH
260 case 'svg':
261 return 'image/svg+xml';
ccc0fff9
TL
262 case 'png':
263 return 'image/png';
436dbeec
SH
264 case 'gif':
265 return 'image/gif';
ccc0fff9
TL
266 case 'jpg':
267 case 'jpeg':
268 return 'image/jpeg';
269 case 'ico':
270 return 'image/vnd.microsoft.icon';
271 }
272 return 'document/unknown';
27c1c305
SH
273}
274
275/**
276 * Caches a given image file.
277 *
278 * @param string $image The name of the image that was requested.
279 * @param string $imagefile The location of the image file we want to cache.
280 * @param string $candidatelocation The location to cache it in.
281 * @return string The path to the cached image.
282 */
283function cache_image($image, $imagefile, $candidatelocation) {
284 global $CFG;
285 $pathinfo = pathinfo($imagefile);
286 $cacheimage = "$candidatelocation/$image.".$pathinfo['extension'];
287
288 clearstatcache();
289 if (!file_exists(dirname($cacheimage))) {
290 @mkdir(dirname($cacheimage), $CFG->directorypermissions, true);
291 }
292
293 // Prevent serving of incomplete file from concurrent request,
294 // the rename() should be more atomic than copy().
295 ignore_user_abort(true);
296 if (@copy($imagefile, $cacheimage.'.tmp')) {
297 rename($cacheimage.'.tmp', $cacheimage);
298 @chmod($cacheimage, $CFG->filepermissions);
299 @unlink($cacheimage.'.tmp'); // just in case anything fails
300 }
301 return $cacheimage;
574909ef 302}