file.php 21.8 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
<?php
/**
 * This program is part of Mahara
 *
 *  This program 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 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program 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 this program; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 *
 * @package    mahara
 * @subpackage core
21
 * @author     Martin Dougiamas <martin@moodle.com>
22
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL
23 24
 * @copyright  (C) 2001-3001 Martin Dougiamas http://dougiamas.com
 * @copyright  additional modifications (c) Catalyst IT Ltd http://catalyst.net.nz
25 26 27 28 29
 *
 */

defined('INTERNAL') || die();

30
define('BYTESERVING_BOUNDARY', 'm1i2k3e40516'); //unique string constant
31

32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
/**
 * Serves a file from dataroot.
 *
 * This function checks that the file is inside dataroot, but does not perform
 * any other checks. Authors using this function should make sure that their
 * scripts perform appropriate authentication.
 *
 * As an example: If the file is an artefact, you could ask for an artefact and
 * view ID, and check that the artefact is in the view and that the user can
 * view the view.
 *
 * @param string $path     The file to send. Must include the dataroot path.
 * @param string $filename The name of the file as the browser should use to
 *                         serve it.
 * @param array  $options  Any options to use when serving the file. Currently
 *                         there are none.
 */
function serve_file($path, $filename, $options=array()) {
    $dataroot = get_config('dataroot');
    $path = realpath($path);
    $options = array_merge(array(
        'lifetime' => 86400
    ), $options);

    if (substr($path, 0, strlen($dataroot)) != $dataroot) {
        throw new AccessDeniedException();
    }
59

60 61 62
    if (!file_exists($path)) {
        throw new NotFoundException();
    }
63

64
    session_write_close(); // unlock session during fileserving
65

66
    $mimetype     = get_mime_type($path);
67
    if (!$mimetype || (!is_image_mime_type($mimetype) && (isset($_SERVER['HTTP_USER_AGENT']) && false !== strpos($_SERVER['HTTP_USER_AGENT'], 'MSIE')))) {
68 69 70 71
        $mimetype = 'application/forcedownload';
    }
    $lastmodified = filemtime($path);
    $filesize     = filesize($path);
72 73 74 75 76

    if (ini_get('zlib.output_compression')) {
        ini_set('zlib.output_compression', 'Off');
    }

77 78
    // Try to disable automatic sid rewrite in cookieless mode
    @ini_set('session.use_trans_sid', 'false');
79 80 81

    header('Last-Modified: '. gmdate('D, d M Y H:i:s', $lastmodified) .' GMT');

82 83 84 85 86 87 88
    // @todo possibly need addslashes on the filename, but I'm unsure on exactly
    // how the browsers will handle it.
    if ($mimetype == 'application/forcedownload') {
        header('Content-Disposition: attachment; filename="' . $filename . '"');
    }
    else {
        header('Content-Disposition: inline; filename="' . $filename . '"');
89 90
    }

91 92 93 94
    if ($options['lifetime'] > 0) {
        header('Cache-Control: max-age=' . $options['lifetime']);
        header('Expires: '. gmdate('D, d M Y H:i:s', time() + $options['lifetime']) .' GMT');
        header('Pragma: ');
95

96
        if ($mimetype != 'text/plain' && $mimetype != 'text/html') {
97 98 99
            @header('Accept-Ranges: bytes');

            if (!empty($_SERVER['HTTP_RANGE']) && strpos($_SERVER['HTTP_RANGE'],'bytes=') !== FALSE) {
100
                // Byteserving stuff - for Acrobat Reader and download accelerators
101 102 103 104
                // see: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35
                // inspired by: http://www.coneural.org/florian/papers/04_byteserving.php
                $ranges = false;
                if (preg_match_all('/(\d*)-(\d*)/', $_SERVER['HTTP_RANGE'], $ranges, PREG_SET_ORDER)) {
105
                    foreach ($ranges as $key => $value) {
106
                        if ($ranges[$key][1] == '') {
107
                            // Suffix case
108 109
                            $ranges[$key][1] = $filesize - $ranges[$key][2];
                            $ranges[$key][2] = $filesize - 1;
110 111 112
                        }
                        else if ($ranges[$key][2] == '' || $ranges[$key][2] > $filesize - 1) {
                            // Fix range length
113 114 115
                            $ranges[$key][2] = $filesize - 1;
                        }
                        if ($ranges[$key][2] != '' && $ranges[$key][2] < $ranges[$key][1]) {
116
                            // Invalid byte-range ==> ignore header
117 118 119
                            $ranges = false;
                            break;
                        }
120 121 122

                        // Prepare multipart header
                        $ranges[$key][0] =  "\r\n--" . BYTESERVING_BOUNDARY . "\r\nContent-Type: $mimetype\r\n";
123 124 125 126 127 128 129 130 131 132
                        $ranges[$key][0] .= "Content-Range: bytes {$ranges[$key][1]}-{$ranges[$key][2]}/$filesize\r\n\r\n";
                    }
                } else {
                    $ranges = false;
                }
                if ($ranges) {
                    byteserving_send_file($path, $mimetype, $ranges);
                }
            }
        }
133 134 135
        else {
            // Do not byteserve (disabled, strings, text and html files).
            header('Accept-Ranges: none');
136
        }
137 138 139 140 141 142 143 144 145 146 147 148 149
    }
    else { // Do not cache files in proxies and browsers
        if (strpos(get_config('wwwroot'), 'https://') === 0) { //https sites - watch out for IE! KB812935 and KB316431
            header('Cache-Control: max-age=10');
            header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
            header('Pragma: ');
        }
        else { //normal http - prevent caching at all cost
            header('Cache-Control: private, must-revalidate, pre-check=0, post-check=0, max-age=0');
            header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
            header('Pragma: no-cache');
        }
        header('Accept-Ranges: none'); // Do not allow byteserving when caching disabled
150 151
    }

152 153 154
    if ($mimetype == 'text/plain') {
        // Add encoding
        header('Content-Type: Text/plain; charset=utf-8');
155
    }
156 157
    else {
        header('Content-Type: ' . $mimetype);
158
    }
159 160 161 162
    header('Content-Length: ' . $filesize);
    while (@ob_end_flush()); //flush the buffers - save memory and disable sid rewrite
    readfile_chunked($path);
    exit;
163 164 165 166 167 168
}

/**
 * Improves memory consumptions and works around buggy readfile() in PHP 5.0.4 (2MB readfile limit).
 */
function readfile_chunked($filename, $retbytes=true) {
169
    $chunksize = 1 * (1024 * 1024); // 1MB chunks - must be less than 2MB!
170
    $buffer = '';
171
    $cnt =0;
172 173 174 175 176
    $handle = fopen($filename, 'rb');
    if ($handle === false) {
        return false;
    }

177 178
    @set_time_limit(60 * 60); //reset time limit to 60 min - should be enough for 1 MB chunk

179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197
    while (!feof($handle)) {
        $buffer = fread($handle, $chunksize);
        echo $buffer;
        flush();
        if ($retbytes) {
            $cnt += strlen($buffer);
        }
    }
    $status = fclose($handle);
    if ($retbytes && $status) {
        return $cnt; // return num. bytes delivered like readfile() does.
    }
    return $status;
}

/**
 * Send requested byterange of file.
 */
function byteserving_send_file($filename, $mimetype, $ranges) {
198
    $chunksize = 1 * (1024 * 1024); // 1MB chunks - must be less than 2MB!
199 200 201 202 203 204
    $handle = fopen($filename, 'rb');
    if ($handle === false) {
        die;
    }
    if (count($ranges) == 1) { //only one range requested
        $length = $ranges[0][2] - $ranges[0][1] + 1;
205 206 207 208
        header('HTTP/1.1 206 Partial content');
        header('Content-Length: ' . $length);
        header('Content-Range: bytes ' . $ranges[0][1] . '-' . $ranges[0][2] . '/' . filesize($filename));
        header('Content-Type: ' . $mimetype);
209
        while (@ob_end_flush()); //flush the buffers - save memory and disable sid rewrite
210
        @set_time_limit(60*60); //reset time limit to 60 min - should be enough for 1 MB chunk
211 212 213 214 215 216 217 218 219
        $buffer = '';
        fseek($handle, $ranges[0][1]);
        while (!feof($handle) && $length > 0) {
            $buffer = fread($handle, ($chunksize < $length ? $chunksize : $length));
            echo $buffer;
            flush();
            $length -= strlen($buffer);
        }
        fclose($handle);
220 221 222
        exit;
    }
    else { // multiple ranges requested - not tested much
223 224 225 226
        $totallength = 0;
        foreach($ranges as $range) {
            $totallength += strlen($range[0]) + $range[2] - $range[1] + 1;
        }
227 228 229 230
        $totallength += strlen("\r\n--" . BYTESERVING_BOUNDARY . "--\r\n");
        header('HTTP/1.1 206 Partial content');
        header('Content-Length: ' . $totallength);
        header('Content-Type: multipart/byteranges; boundary=' . BYTESERVING_BOUNDARY);
231 232 233 234 235 236 237
        //TODO: check if "multipart/x-byteranges" is more compatible with current readers/browsers/servers
        while (@ob_end_flush()); //flush the buffers - save memory and disable sid rewrite
        foreach($ranges as $range) {
            $length = $range[2] - $range[1] + 1;
            echo $range[0];
            $buffer = '';
            fseek($handle, $range[1]);
238
            @set_time_limit(60 * 60); //reset time limit to 60 min - should be enough for 1 MB chunk
239 240 241 242 243 244 245
            while (!feof($handle) && $length > 0) {
                $buffer = fread($handle, ($chunksize < $length ? $chunksize : $length));
                echo $buffer;
                flush();
                $length -= strlen($buffer);
            }
        }
246
        echo "\r\n--" . BYTESERVING_BOUNDARY . "--\r\n";
247
        fclose($handle);
248
        exit;
249 250 251
    }
}

Richard Mansfield's avatar
Richard Mansfield committed
252

253
/**
254 255
 * Given a file path, retrieves the mime type of the file using the
 * unix 'file' program.
256 257 258 259
 *
 * This is only implemented for non-windows based operating systems. Mahara
 * does not support windows at this time.
 *
260 261 262
 * Sometimes file will be unable to detect the mimetype, in which case
 * it will return the empty string.
 *
263
 * @param string $file The file to check
264
 * @return string      The mime type of the file, or false if file is not available.
265
 */
Richard Mansfield's avatar
Richard Mansfield committed
266 267
function get_mime_type($file) {
    switch (strtolower(PHP_OS)) {
268 269 270 271 272
    case 'win' :
        throw new SystemException('retrieving filetype not supported in windows');
    default : 
        $filepath = get_config('pathtofile');
        if (!empty($filepath)) {
273
            list($output,) = preg_split('/[\s;]/', exec($filepath . ' -ib ' . escapeshellarg($file)));
274
            return $output;
275
        }
276 277
        return false;
    }
Richard Mansfield's avatar
Richard Mansfield committed
278 279
}

280

281 282 283 284
/**
 * Given a mimetype (perhaps returned by {@link get_mime_type}, returns whether
 * Mahara thinks it is a valid image file.
 *
285 286
 * Not all image types are valid for Mahara. Mahara supports JPEG, PNG, GIF
 * and BMP.
287 288 289 290
 *
 * @param string $type The mimetype to check
 * @return boolean     Whether the type is a valid image type for Mahara
 */
Richard Mansfield's avatar
Richard Mansfield committed
291
function is_image_mime_type($type) {
292 293 294 295 296 297 298 299 300 301 302
    $supported = array(
        'image/jpeg', 'image/jpg',
        'image/gif',
        'image/png'
    );
    if (extension_loaded('imagick')) {
        $supported = array_merge($supported, array(
            'image/bmp', 'image/x-bmp', 'image/ms-bmp', 'image/x-ms-bmp'
        ));
    }
    return in_array($type, $supported);
Richard Mansfield's avatar
Richard Mansfield committed
303 304
}

305 306 307 308 309 310
/**
 * Given a path under dataroot, an ID and a size, return the path to a file
 * matching all criteria.
 *
 * If the file with the ID exists but not of the correct size, this function
 * will make a copy that is resized to the correct size.
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
 *
 * @param string $path The base path in dataroot where the image is stored. For 
 *                     example, 'artefact/internal/profileicons/' for profile 
 *                     icons
 * @param int $id      The ID of the image to return. Is typically the ID of an 
 *                     artefact
 * @param mixed $size  The size the image should be.
 *
 *                      As a two element hash with 'w' and 'h' keys:
 *                     - If 'w' and 'h' are not empty, the image will be 
 *                       exactly that size
 *                     - If just 'w' is not empty, the image will be that wide, 
 *                       and the height will be set to make the image scale 
 *                       correctly
 *                     - If just 'h' is not empty, the image will be that high, 
 *                       and the width will be set to make the image scale 
 *                       correctly
 *                     - If neither are set or the parameter is not set, the 
 *                       image will not be resized
 *
 *                     As a number, the path returned will have the largest side being 
 *                     the length specified.
 * @return string The path on disk where the appropriate file resides, or false 
 *                if an appropriate file could not be located or generated
335
 */
336 337
function get_dataroot_image_path($path, $id, $size=null) {
    log_debug("get_dataroot_image_path($path, $id, " . serialize($size) . ')');
338 339
    $dataroot = get_config('dataroot');
    $imagepath = $dataroot . $path;
340 341 342
    if (substr($imagepath, -1) == '/') {
        $imagepath = substr($imagepath , 0, -1);
    }
343 344 345 346 347

    if (!is_dir($imagepath) || !is_readable($imagepath)) {
        return false;
    }

348 349 350
    // Work out the location of the original image
    $originalimage = $imagepath . '/originals/' . ($id % 256) . "/$id";
    log_debug("original image path = $originalimage");
351

352 353 354 355 356 357 358 359 360
    if (!$size) {
        // No size has been asked for. Check for the original and return that
        if (is_readable($originalimage)) {
            log_debug("Found original image and no size asked for");
            return $originalimage;
        }
        // Oops - no original available
        log_debug("Original image NOT found");
        return false;
361
    }
362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379
    else {
        // Check if the image is available in the size requested
        $sizestr = serialize($size);
        $md5     = md5("{$id}.{$sizestr}");

        $resizedimagedir = $imagepath . '/resized/';
        check_dir_exists($resizedimagedir);
        for ($i = 0; $i <= 2; $i++) {
           $resizedimagedir .= substr($md5, $i, 1) . '/';
            check_dir_exists($resizedimagedir);
        }
        $resizedimagefile = "{$resizedimagedir}{$md5}.$id";//.$sizestr";
        log_debug("$sizestr   $md5   $resizedimagefile");

        if (is_readable($resizedimagefile)) {
            log_debug("Found cached version of image $resizedimagefile");
            return $resizedimagefile;
        }
Nigel McNie's avatar
Nigel McNie committed
380

381 382
        // Image is not available in this size. If there is a base image for
        // it, we can make one however.
Nigel McNie's avatar
Nigel McNie committed
383
        if (is_readable($originalimage)) {
384
            log_debug("Couldn't find a resized one, but found an original at $originalimage");
385

386 387
            $originalmimetype = get_mime_type($originalimage);
            switch ($originalmimetype) {
Nigel McNie's avatar
Nigel McNie committed
388
                case 'image/jpeg':
389
                case 'image/jpg':
Nigel McNie's avatar
Nigel McNie committed
390
                    $oldih = imagecreatefromjpeg($originalimage);
Nigel McNie's avatar
Nigel McNie committed
391
                    break;
Nigel McNie's avatar
Nigel McNie committed
392 393
                case 'image/png':
                    $oldih = imagecreatefrompng($originalimage);
Nigel McNie's avatar
Nigel McNie committed
394
                    break;
Nigel McNie's avatar
Nigel McNie committed
395 396
                case 'image/gif':
                    $oldih = imagecreatefromgif($originalimage);
Nigel McNie's avatar
Nigel McNie committed
397
                    break;
398 399 400 401 402
                case 'image/bmp':
                case 'image/x-bmp':
                case 'image/ms-bmp':
                case 'image/x-ms-bmp':
                    if (!extension_loaded('imagick')) {
403
                        log_info('Bitmap image detected for resizing, but imagick extension is not available');
404 405
                        return false;
                    }
406 407 408 409 410 411 412 413 414 415

                    $ih = imagick_readimage($originalimage);
                    if (!$newdimensions = image_get_new_dimensions(imagick_getwidth($ih), imagick_getheight($ih), $size)) {
                        return false;
                    }
                    imagick_resize($ih, $newdimensions['w'], $newdimensions['h'], IMAGICK_FILTER_LANCZOS, 1);
                    if (imagick_writeimage($ih, $resizedimagefile)) {
                        return $resizedimagefile;
                    }
                    return false;
Nigel McNie's avatar
Nigel McNie committed
416 417
                default:
                    return false;
Nigel McNie's avatar
Nigel McNie committed
418 419
            }

Nigel McNie's avatar
Nigel McNie committed
420 421 422
            if (!$oldih) {
                return false;
            }
423

Nigel McNie's avatar
Nigel McNie committed
424 425
            $oldx = imagesx($oldih);
            $oldy = imagesy($oldih);
426

427 428
            if (!$newdimensions = image_get_new_dimensions($oldx, $oldy, $size)) {
                return false;
Nigel McNie's avatar
Nigel McNie committed
429
            }
430
            log_debug("storing at $resizedimagefile");
431

432
            $newih = imagecreatetruecolor($newdimensions['w'], $newdimensions['h']);
433 434 435 436 437 438 439 440 441 442

            if ($originalmimetype == 'image/png' || $originalmimetype == 'image/gif') {
                // Create a new destination image which is completely 
                // transparent and turn off alpha blending for it, so that when 
                // the PNG source file is copied, the alpha channel is retained.
                // Thanks to http://alexle.net/archives/131

                $background = imagecolorallocate($newih, 0, 0, 0);
                imagecolortransparent($newih, $background);
                imagealphablending($newih, false);
443
                imagecopyresampled($newih, $oldih, 0, 0, 0, 0, $newdimensions['w'], $newdimensions['h'], $oldx, $oldy);
444 445 446 447 448 449
                imagesavealpha($newih, true);
            }
            else {
                // imagecopyresized is faster, but results in noticeably worse image quality. 
                // Given the images are resized only once each time they're 
                // made, I suggest you just leave the good quality one in place
450 451
                imagecopyresampled($newih, $oldih, 0, 0, 0, 0, $newdimensions['w'], $newdimensions['h'], $oldx, $oldy);
                //imagecopyresized($newih, $oldih, 0, 0, 0, 0, $newdimensions['w'], $newdimensions['h'], $oldx, $oldy);
452 453
            }

454 455 456 457 458 459 460
            $result = imagepng($newih, $resizedimagefile);
            log_debug("RESULT");
            log_debug($result);
            if ($result) {
                return $resizedimagefile;
            }
        } // end attempting to build a resized image
461 462 463 464 465
    }

    // Image not available in any size
    return false;
}
466

467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520
/**
 * Given the old dimensions of an image and a size object as obtained from 
 * get_imagesize_parameters(), calculates what the new size of the image should 
 * be
 *
 * @param int $oldx   The width of the image to calculate the new size for
 * @param int $oldy   The height of the image to calculate the new size for
 * @param mixed $size The size data
 * @return array      A hash with the new width and height, keyed by 'w' and 'h'
 */
function image_get_new_dimensions($oldx, $oldy, $size) {
    log_debug("STRATEGY:");
    log_debug("Old image is $oldx x $oldy");
    if (is_int($size)) {
        // If just a number (number is width AND height here)
        if ($oldy > $oldx) {
            $newy = $size;
            $newx = ($oldx * $newy) / $oldy;
        }
        else {
            $newx = $size;
            $newy = ($oldy * $newx) / $oldx;
        }
        log_debug("Resizing so the maximum size of the largest side = $size");
        log_debug("New size = $newx x $newy");
    }
    else if (isset($size['w']) && isset($size['h'])) {
        // If size explicitly X by Y
        $newx = $size['w'];
        $newy = $size['h'];
        log_debug("Resizing to EXACTLY $newx x $newy");
    }
    else if (isset($size['w'])) {
        // Else if just width
        $newx = $size['w'];
        $newy = ($oldy * $newx) / $oldx;
        log_debug("Resizing so WIDTH = " . $size['w']);
        log_debug("New dimensions: $newx x $newy");
    }
    else if (isset($size['h'])) {
        // Else if just height
        $newy = $size['h'];
        $newx = ($oldx * $newy) / $oldy;
        log_debug("Resizing so HEIGHT = " . $size['h']);
        log_debug("New dimensions: $newx x $newy");
    }
    else {
        log_debug("Unknown size specification:");
        log_debug($size);
        return false;
    }
    return array('w' => $newx, 'h' => $newy);
}

521 522 523 524 525 526 527 528 529 530 531 532 533 534
/**
 * Deletes an image, including all resized versions of it, from dataroot.
 *
 * This function does not delete anything from anywhere else - it is your
 * responsibility to delete any database records.
 *
 * @param string $path The path in dataroot of the base directory where the
 *                     image resides.
 * @param int $id      The id of the image to delete.
 * @return boolean     Whether the image was deleted successfully.
 */
function delete_image($path, $id) {
    // Check that the image exists.
    $dataroot = get_config('dataroot');
535
    $imagepath = $dataroot . $path . '/originals';
536 537 538 539 540 541 542 543 544 545 546

    if (!is_dir($imagepath) || !is_readable($imagepath)) {
        return false;
    }

    $originalimage = $imagepath . '/' . ($id % 256) . "/$id";
    if (!is_readable($originalimage)) {
        return false;
    }

    unlink($originalimage);
547 548
    return true;
}
549

550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575
/**
 * Delete a file, or a folder and its contents
 *
 * @author      Aidan Lister <aidan@php.net>
 * @version     1.0.3
 * @link        http://aidanlister.com/repos/v/function.rmdirr.php
 * @param       string   $dirname    Directory to delete
 * @return      bool     Returns TRUE on success, FALSE on failure
 */
function rmdirr($dirname)
{
    // Sanity check
    if (!file_exists($dirname)) {
        return false;
    }
 
    // Simple delete for a file
    if (is_file($dirname) || is_link($dirname)) {
        return unlink($dirname);
    }
 
    // Loop through the folder
    $dir = dir($dirname);
    while (false !== $entry = $dir->read()) {
        // Skip pointers
        if ($entry == '.' || $entry == '..') {
576 577
            continue;
        }
578 579 580
 
        // Recurse
        rmdirr($dirname . DIRECTORY_SEPARATOR . $entry);
581
    }
582 583 584 585
 
    // Clean up
    $dir->close();
    return rmdir($dirname);
586 587
}

588
?>