forked from phpbb/phpbb
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcontroller.php
More file actions
188 lines (161 loc) · 3.83 KB
/
controller.php
File metadata and controls
188 lines (161 loc) · 3.83 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
<?php
/**
*
* This file is part of the phpBB Forum Software package.
*
* @copyright (c) phpBB Limited <https://www.phpbb.com>
* @license GNU General Public License, version 2 (GPL-2.0)
*
* For full copyright and license information, please see
* the docs/CREDITS.txt file.
*
*/
namespace phpbb\storage\controller;
use phpbb\cache\service;
use phpbb\db\driver\driver_interface;
use phpbb\exception\http_exception;
use phpbb\storage\exception\exception;
use phpbb\storage\storage;
use Symfony\Component\HttpFoundation\Request as symfony_request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpFoundation\StreamedResponse;
/**
* Generic controller for storage
*/
class controller
{
/** @var service */
protected $cache;
/** @var driver_interface */
protected $db;
/** @var storage */
protected $storage;
/** @var symfony_request */
protected $symfony_request;
/**
* Constructor
*
* @param service $cache
* @param driver_interface $db
* @param storage $storage
* @param symfony_request $symfony_request
*/
public function __construct(service $cache, driver_interface $db, storage $storage, symfony_request $symfony_request)
{
$this->cache = $cache;
$this->db = $db;
$this->storage = $storage;
$this->symfony_request = $symfony_request;
}
/**
* Handler
*
* @param string $file File path
*
* @return Response a Symfony response object
*
* @throws http_exception when can't access $file
* @throws exception when there is an error reading the file
*/
public function handle(string $file): Response
{
$response = new StreamedResponse();
if (!static::is_allowed($file))
{
throw new http_exception(403, 'Forbidden');
}
if (!static::file_exists($file))
{
throw new http_exception(404, 'Not Found');
}
static::prepare($response, $file);
if (headers_sent())
{
throw new http_exception(500, 'Headers already sent');
}
return $response;
}
/**
* If the user is allowed to download the file
*
* @param string $file File path
*
* @return bool
*/
protected function is_allowed(string $file): bool
{
return true;
}
/**
* Check if file exists
*
* @param string $file File path
*
* @return bool
*/
protected function file_exists(string $file): bool
{
return $this->storage->exists($file);
}
/**
* Prepare response
*
* @param StreamedResponse $response
* @param string $file File path
*
* @return void
* @throws exception when there is an error reading the file
*/
protected function prepare(StreamedResponse $response, string $file): void
{
$file_info = $this->storage->file_info($file);
// Add Content-Type header
if (!$response->headers->has('Content-Type'))
{
try
{
$content_type = $file_info->get('mimetype');
}
catch (exception $e)
{
$content_type = 'application/octet-stream';
}
$response->headers->set('Content-Type', $content_type);
}
// Add Content-Length header if we have the file size
if (!$response->headers->has('Content-Length'))
{
try
{
$response->headers->set('Content-Length', $file_info->get('size'));
}
catch (exception $e)
{
// Just don't send this header
}
}
@set_time_limit(0);
$fp = $this->storage->read_stream($file);
// Close db connection
$this->file_gc();
$output = fopen('php://output', 'w+b');
$response->setCallback(function () use ($fp, $output) {
stream_copy_to_stream($fp, $output);
fclose($fp);
fclose($output);
flush();
// Terminate script to avoid the execution of terminate events
// This avoid possible errors with db connection closed
exit;
});
$response->isNotModified($this->symfony_request);
}
/**
* Garbage Collection
*/
protected function file_gc(): void
{
$this->cache->unload(); // Equivalent to $this->cache->get_driver()->unload();
$this->db->sql_close();
}
}