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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
|
<?php
/**
* Configuration module for RSS-Bridge.
*
* This class implements a configuration module for RSS-Bridge.
*/
final class Configuration
{
private const VERSION = '2024-02-02';
private static $config = [];
private function __construct()
{
}
public static function checkInstallation(): array
{
$errors = [];
// OpenSSL: https://www.php.net/manual/en/book.openssl.php
if (!extension_loaded('openssl')) {
$errors[] = 'openssl extension not loaded';
}
// libxml: https://www.php.net/manual/en/book.libxml.php
if (!extension_loaded('libxml')) {
$errors[] = 'libxml extension not loaded';
}
// Multibyte String (mbstring): https://www.php.net/manual/en/book.mbstring.php
if (!extension_loaded('mbstring')) {
$errors[] = 'mbstring extension not loaded';
}
// SimpleXML: https://www.php.net/manual/en/book.simplexml.php
if (!extension_loaded('simplexml')) {
$errors[] = 'simplexml extension not loaded';
}
// Client URL Library (curl): https://www.php.net/manual/en/book.curl.php
// Allow RSS-Bridge to run without curl module in CLI mode without root certificates
if (!extension_loaded('curl') && !(php_sapi_name() === 'cli' && empty(ini_get('curl.cainfo')))) {
$errors[] = 'curl extension not loaded';
}
// JavaScript Object Notation (json): https://www.php.net/manual/en/book.json.php
if (!extension_loaded('json')) {
$errors[] = 'json extension not loaded';
}
return $errors;
}
public static function loadConfiguration(array $customConfig = [], array $env = [])
{
if (!file_exists(__DIR__ . '/../config.default.ini.php')) {
throw new \Exception('The default configuration file is missing');
}
$config = parse_ini_file(__DIR__ . '/../config.default.ini.php', true, INI_SCANNER_TYPED);
if (!$config) {
throw new \Exception('Error parsing ini config');
}
foreach ($config as $header => $section) {
foreach ($section as $key => $value) {
self::setConfig($header, $key, $value);
}
}
foreach ($customConfig as $header => $section) {
foreach ($section as $key => $value) {
self::setConfig($header, $key, $value);
}
}
if (file_exists(__DIR__ . '/../DEBUG')) {
// The debug mode has been moved to config. Preserve existing installs which has this DEBUG file.
self::setConfig('system', 'enable_debug_mode', true);
$debug = trim(file_get_contents(__DIR__ . '/../DEBUG'));
if ($debug) {
self::setConfig('system', 'debug_mode_whitelist', explode("\n", str_replace("\r", '', $debug)));
}
}
if (file_exists(__DIR__ . '/../whitelist.txt')) {
$enabledBridges = trim(file_get_contents(__DIR__ . '/../whitelist.txt'));
if ($enabledBridges === '*') {
self::setConfig('system', 'enabled_bridges', ['*']);
} else {
self::setConfig('system', 'enabled_bridges', array_filter(array_map('trim', explode("\n", $enabledBridges))));
}
}
foreach ($env as $envName => $envValue) {
$nameParts = explode('_', $envName);
if ($nameParts[0] === 'RSSBRIDGE') {
if (count($nameParts) < 3) {
// Invalid env name
continue;
}
// The variable is named $header but it's actually the section in config.ini.php
$header = $nameParts[1];
// Recombine the key if it had multiple underscores
$key = implode('_', array_slice($nameParts, 2));
$key = strtolower($key);
// Handle this specifically because it's an array
if ($key === 'enabled_bridges') {
$envValue = explode(',', $envValue);
$envValue = array_map('trim', $envValue);
}
if ($envValue === 'true' || $envValue === 'false') {
$envValue = filter_var($envValue, FILTER_VALIDATE_BOOLEAN);
}
self::setConfig($header, $key, $envValue);
}
}
if (!is_array(self::getConfig('system', 'enabled_bridges'))) {
self::throwConfigError('system', 'enabled_bridges', 'Is not an array');
}
if (
!is_string(self::getConfig('system', 'timezone'))
|| !in_array(self::getConfig('system', 'timezone'), timezone_identifiers_list(DateTimeZone::ALL_WITH_BC))
) {
self::throwConfigError('system', 'timezone');
}
if (!is_bool(self::getConfig('system', 'enable_debug_mode'))) {
self::throwConfigError('system', 'enable_debug_mode', 'Is not a valid Boolean');
}
if (!is_array(self::getConfig('system', 'debug_mode_whitelist') ?: [])) {
self::throwConfigError('system', 'debug_mode_whitelist', 'Is not a valid array');
}
if (!is_string(self::getConfig('proxy', 'url'))) {
self::throwConfigError('proxy', 'url', 'Is not a valid string');
}
if (!is_bool(self::getConfig('proxy', 'by_bridge'))) {
self::throwConfigError('proxy', 'by_bridge', 'Is not a valid Boolean');
}
if (!is_string(self::getConfig('proxy', 'name'))) {
/** Name of the proxy server */
self::throwConfigError('proxy', 'name', 'Is not a valid string');
}
if (!is_string(self::getConfig('cache', 'type'))) {
self::throwConfigError('cache', 'type', 'Is not a valid string');
}
if (!is_bool(self::getConfig('cache', 'custom_timeout'))) {
self::throwConfigError('cache', 'custom_timeout', 'Is not a valid Boolean');
}
if (!is_bool(self::getConfig('authentication', 'enable'))) {
self::throwConfigError('authentication', 'enable', 'Is not a valid Boolean');
}
if (!is_string(self::getConfig('authentication', 'username'))) {
self::throwConfigError('authentication', 'username', 'Is not a valid string');
}
if (!is_string(self::getConfig('authentication', 'password'))) {
self::throwConfigError('authentication', 'password', 'Is not a valid string');
}
if (
!empty(self::getConfig('admin', 'email'))
&& !filter_var(self::getConfig('admin', 'email'), FILTER_VALIDATE_EMAIL)
) {
self::throwConfigError('admin', 'email', 'Is not a valid email address');
}
if (!is_bool(self::getConfig('admin', 'donations'))) {
self::throwConfigError('admin', 'donations', 'Is not a valid Boolean');
}
if (!is_string(self::getConfig('error', 'output'))) {
self::throwConfigError('error', 'output', 'Is not a valid String');
}
if (!in_array(self::getConfig('error', 'output'), ['feed', 'http', 'none'])) {
self::throwConfigError('error', 'output', 'Invalid output');
}
if (
!is_numeric(self::getConfig('error', 'report_limit'))
|| self::getConfig('error', 'report_limit') < 1
) {
self::throwConfigError('admin', 'report_limit', 'Value is invalid');
}
}
public static function getConfig(string $section, string $key, $default = null)
{
if (self::$config === []) {
throw new \Exception('Config has not been loaded');
}
return self::$config[strtolower($section)][strtolower($key)] ?? $default;
}
private static function setConfig(string $section, string $key, $value): void
{
self::$config[strtolower($section)][strtolower($key)] = $value;
}
public static function getVersion()
{
$headFile = __DIR__ . '/../.git/HEAD';
if (@is_readable($headFile)) {
$revisionHashFile = '.git/' . substr(file_get_contents($headFile), 5, -1);
$parts = explode('/', $revisionHashFile);
if (isset($parts[3])) {
$branchName = $parts[3];
if (file_exists($revisionHashFile)) {
return sprintf('%s (git.%s.%s)', self::VERSION, $branchName, substr(file_get_contents($revisionHashFile), 0, 7));
}
}
}
return self::VERSION;
}
private static function throwConfigError($section, $key, $message = '')
{
throw new \Exception("Config [$section] => [$key] is invalid. $message");
}
}
|
