blob: 0232adfe4949c0479003895c0eb715565f10b966 [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
Derek Allard2067d1a2008-11-13 22:59:24 +000040if ( ! function_exists('force_download'))
41{
Timothy Warren01b129a2012-04-27 11:36:50 -040042 /**
43 * Force Download
44 *
45 * Generates headers that force a download to happen
46 *
47 * @param string filename
48 * @param mixed the data to be downloaded
Alex Bilbief512b732012-06-16 11:15:19 +010049 * @param bool whether to try and send the actual file MIME type
Timothy Warren01b129a2012-04-27 11:36:50 -040050 * @return void
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 {
Alex Bilbie773ccc32012-06-02 11:11:08 +010054 if ($filename === '' OR $data === '')
Derek Allard2067d1a2008-11-13 22:59:24 +000055 {
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
Andrey Andreev6ef498b2012-06-05 22:01:58 +030076 $mimes =& get_mimes();
Andrey Andreevb38c5dd2012-02-29 14:07:45 +020077
78 // Only change the default MIME if we can find one
79 if (isset($mimes[$extension]))
80 {
81 $mime = is_array($mimes[$extension]) ? $mimes[$extension][0] : $mimes[$extension];
82 }
Derek Allard2067d1a2008-11-13 22:59:24 +000083 }
Barry Mienydd671972010-10-04 16:33:58 +020084
Andrey Andreevfce2ed62012-03-11 22:04:48 +020085 /* It was reported that browsers on Android 2.1 (and possibly older as well)
86 * need to have the filename extension upper-cased in order to be able to
87 * download it.
88 *
89 * Reference: http://digiblog.de/2011/04/19/android-and-the-download-file-headers/
90 */
Andrey Andreev3d933b62012-03-11 22:08:57 +020091 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 +020092 {
93 $x[count($x) - 1] = strtoupper($extension);
94 $filename = implode('.', $x);
95 }
Andrey Andreevae31eb52012-05-17 14:54:15 +030096
Sam Libbd9dd32012-04-23 23:13:46 +080097 // Clean output buffer
Michiel Vugteveen28ff2922012-08-14 10:55:46 +020098 if (ob_get_level() !== 0)
99 {
100 ob_clean();
101 }
Andrey Andreevfce2ed62012-03-11 22:04:48 +0200102
Derek Allard2067d1a2008-11-13 22:59:24 +0000103 // Generate the server headers
dododedodonl4da94782012-03-10 13:56:17 +0100104 header('Content-Type: '.$mime);
Eric Roberts0e4d2b62012-01-23 18:19:20 -0600105 header('Content-Disposition: attachment; filename="'.$filename.'"');
106 header('Expires: 0');
Andrey Andreevb38c5dd2012-02-29 14:07:45 +0200107 header('Content-Transfer-Encoding: binary');
108 header('Content-Length: '.strlen($data));
Eric Roberts0e4d2b62012-01-23 18:19:20 -0600109
Andrey Andreevb38c5dd2012-02-29 14:07:45 +0200110 // Internet Explorer-specific headers
111 if (isset($_SERVER['HTTP_USER_AGENT']) && strpos($_SERVER['HTTP_USER_AGENT'], 'MSIE') !== FALSE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000112 {
Derek Allard2067d1a2008-11-13 22:59:24 +0000113 header('Cache-Control: must-revalidate, post-check=0, pre-check=0');
Derek Allard2067d1a2008-11-13 22:59:24 +0000114 header('Pragma: public');
Derek Allard2067d1a2008-11-13 22:59:24 +0000115 }
Andrey Andreevb38c5dd2012-02-29 14:07:45 +0200116 else
117 {
118 header('Pragma: no-cache');
119 }
Barry Mienydd671972010-10-04 16:33:58 +0200120
Derek Allard2067d1a2008-11-13 22:59:24 +0000121 exit($data);
122 }
123}
124
Derek Allard2067d1a2008-11-13 22:59:24 +0000125/* End of file download_helper.php */
Andrey Andreev627e1722012-03-26 20:53:47 +0300126/* Location: ./system/helpers/download_helper.php */