blob: 8b87f817960be39a2f58de8bbf5c0c6248061ffc [file] [log] [blame]
Andrey Andreevb38c5dd2012-02-29 14:07:45 +02001<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
Derek Allard2067d1a2008-11-13 22:59:24 +00002/**
3 * CodeIgniter
4 *
Phil Sturgeon07c1ac82012-03-09 17:03:37 +00005 * An open source application development framework for PHP 5.2.4 or newer
Derek Allard2067d1a2008-11-13 22:59:24 +00006 *
Derek Jonesf4a4bd82011-10-20 12:18:42 -05007 * NOTICE OF LICENSE
Andrey Andreevb38c5dd2012-02-29 14:07:45 +02008 *
Derek Jonesf4a4bd82011-10-20 12:18:42 -05009 * Licensed under the Open Software License version 3.0
Andrey Andreevb38c5dd2012-02-29 14:07:45 +020010 *
Derek Jonesf4a4bd82011-10-20 12:18:42 -050011 * This source file is subject to the Open Software License (OSL 3.0) that is
12 * bundled with this package in the files license.txt / license.rst. It is
13 * also available through the world wide web at this URL:
14 * http://opensource.org/licenses/OSL-3.0
15 * If you did not receive a copy of the license and are unable to obtain it
16 * through the world wide web, please send an email to
17 * licensing@ellislab.com so we can send you a copy immediately.
18 *
Derek Allard2067d1a2008-11-13 22:59:24 +000019 * @package CodeIgniter
Derek Jonesf4a4bd82011-10-20 12:18:42 -050020 * @author EllisLab Dev Team
Greg Aker0defe5d2012-01-01 18:46:41 -060021 * @copyright Copyright (c) 2008 - 2012, EllisLab, Inc. (http://ellislab.com/)
Derek Jonesf4a4bd82011-10-20 12:18:42 -050022 * @license http://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
Derek Allard2067d1a2008-11-13 22:59:24 +000023 * @link http://codeigniter.com
24 * @since Version 1.0
25 * @filesource
26 */
27
Derek Allard2067d1a2008-11-13 22:59:24 +000028/**
29 * CodeIgniter Download Helpers
30 *
31 * @package CodeIgniter
32 * @subpackage Helpers
33 * @category Helpers
Derek Jonesf4a4bd82011-10-20 12:18:42 -050034 * @author EllisLab Dev Team
Derek Allard2067d1a2008-11-13 22:59:24 +000035 * @link http://codeigniter.com/user_guide/helpers/download_helper.html
36 */
37
38// ------------------------------------------------------------------------
39
40/**
41 * Force Download
42 *
43 * Generates headers that force a download to happen
44 *
Derek Allard2067d1a2008-11-13 22:59:24 +000045 * @param string filename
46 * @param mixed the data to be downloaded
Andrey Andreevb38c5dd2012-02-29 14:07:45 +020047 * @param bool wether to try and send the actual file MIME type
Derek Allard2067d1a2008-11-13 22:59:24 +000048 * @return void
Barry Mienydd671972010-10-04 16:33:58 +020049 */
Derek Allard2067d1a2008-11-13 22:59:24 +000050if ( ! function_exists('force_download'))
51{
Andrey Andreevb38c5dd2012-02-29 14:07:45 +020052 function force_download($filename = '', $data = '', $set_mime = FALSE)
Derek Allard2067d1a2008-11-13 22:59:24 +000053 {
54 if ($filename == '' OR $data == '')
55 {
56 return FALSE;
57 }
58
Andrey Andreevb38c5dd2012-02-29 14:07:45 +020059 // Set the default MIME type to send
60 $mime = 'application/octet-stream';
61
Andrey Andreevfce2ed62012-03-11 22:04:48 +020062 $x = explode('.', $filename);
63 $extension = end($x);
64
Andrey Andreevb38c5dd2012-02-29 14:07:45 +020065 if ($set_mime === TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +000066 {
Andrey Andreevfce2ed62012-03-11 22:04:48 +020067 if (count($x) === 1 OR $extension === '')
Andrey Andreevb38c5dd2012-02-29 14:07:45 +020068 {
Andrey Andreevfce2ed62012-03-11 22:04:48 +020069 /* If we're going to detect the MIME type,
70 * we'll need a file extension.
71 */
Andrey Andreevb38c5dd2012-02-29 14:07:45 +020072 return FALSE;
73 }
74
Andrey Andreevb38c5dd2012-02-29 14:07:45 +020075 // Load the mime types
76 if (defined('ENVIRONMENT') && is_file(APPPATH.'config/'.ENVIRONMENT.'/mimes.php'))
77 {
78 include(APPPATH.'config/'.ENVIRONMENT.'/mimes.php');
79 }
80 elseif (is_file(APPPATH.'config/mimes.php'))
81 {
82 include(APPPATH.'config/mimes.php');
83 }
84
85 // Only change the default MIME if we can find one
86 if (isset($mimes[$extension]))
87 {
88 $mime = is_array($mimes[$extension]) ? $mimes[$extension][0] : $mimes[$extension];
89 }
Derek Allard2067d1a2008-11-13 22:59:24 +000090 }
Barry Mienydd671972010-10-04 16:33:58 +020091
Andrey Andreevfce2ed62012-03-11 22:04:48 +020092 /* It was reported that browsers on Android 2.1 (and possibly older as well)
93 * need to have the filename extension upper-cased in order to be able to
94 * download it.
95 *
96 * Reference: http://digiblog.de/2011/04/19/android-and-the-download-file-headers/
97 */
Andrey Andreev3d933b62012-03-11 22:08:57 +020098 if (count($x) !== 1 && isset($_SERVER['HTTP_USER_AGENT']) && preg_match('/Android\s(1|2\.[01])/', $_SERVER['HTTP_USER_AGENT']))
Andrey Andreevfce2ed62012-03-11 22:04:48 +020099 {
100 $x[count($x) - 1] = strtoupper($extension);
101 $filename = implode('.', $x);
102 }
Sam Lid52e3b12012-04-23 23:04:35 +0800103
Sam Libbd9dd32012-04-23 23:13:46 +0800104 // Clean output buffer
Sam Lid52e3b12012-04-23 23:04:35 +0800105 ob_clean();
Andrey Andreevfce2ed62012-03-11 22:04:48 +0200106
Derek Allard2067d1a2008-11-13 22:59:24 +0000107 // Generate the server headers
dododedodonl4da94782012-03-10 13:56:17 +0100108 header('Content-Type: '.$mime);
Eric Roberts0e4d2b62012-01-23 18:19:20 -0600109 header('Content-Disposition: attachment; filename="'.$filename.'"');
110 header('Expires: 0');
Andrey Andreevb38c5dd2012-02-29 14:07:45 +0200111 header('Content-Transfer-Encoding: binary');
112 header('Content-Length: '.strlen($data));
Eric Roberts0e4d2b62012-01-23 18:19:20 -0600113
Andrey Andreevb38c5dd2012-02-29 14:07:45 +0200114 // Internet Explorer-specific headers
115 if (isset($_SERVER['HTTP_USER_AGENT']) && strpos($_SERVER['HTTP_USER_AGENT'], 'MSIE') !== FALSE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000116 {
Derek Allard2067d1a2008-11-13 22:59:24 +0000117 header('Cache-Control: must-revalidate, post-check=0, pre-check=0');
Derek Allard2067d1a2008-11-13 22:59:24 +0000118 header('Pragma: public');
Derek Allard2067d1a2008-11-13 22:59:24 +0000119 }
Andrey Andreevb38c5dd2012-02-29 14:07:45 +0200120 else
121 {
122 header('Pragma: no-cache');
123 }
Barry Mienydd671972010-10-04 16:33:58 +0200124
Derek Allard2067d1a2008-11-13 22:59:24 +0000125 exit($data);
126 }
127}
128
Derek Allard2067d1a2008-11-13 22:59:24 +0000129/* End of file download_helper.php */
Andrey Andreev627e1722012-03-26 20:53:47 +0300130/* Location: ./system/helpers/download_helper.php */