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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
|
<?php
class Config {
private const _ENVVAR_PREFIX = "EPUBE_";
const T_BOOL = 1;
const T_STRING = 2;
const T_INT = 3;
// override defaults, defined below in _DEFAULTS[], via environment: DB_TYPE becomes EPUBE_DB_TYPE, etc
const DB_TYPE = "DB_TYPE";
const DB_HOST = "DB_HOST";
const DB_USER = "DB_USER";
const DB_NAME = "DB_NAME";
const DB_PASS = "DB_PASS";
const DB_PORT = "DB_PORT";
const SCRATCH_DB = "SCRATCH_DB";
const CALIBRE_DB = "CALIBRE_DB";
const BOOKS_DIR = "BOOKS_DIR";
const DICT_SERVER = "DICT_SERVER";
const SESSION_LIFETIME = "SESSION_LIFETIME";
const SESSION_NAME = "SESSION_NAME";
const OIDC_NAME = "OIDC_NAME";
const OIDC_URL = "OIDC_URL";
const OIDC_CLIENT_ID = "OIDC_CLIENT_ID";
const OIDC_CLIENT_SECRET = "OIDC_CLIENT_SECRET";
private const _DEFAULTS = [
Config::DB_TYPE => [ "sqlite", Config::T_STRING ],
Config::DB_HOST => [ "db", Config::T_STRING ],
Config::DB_USER => [ "", Config::T_STRING ],
Config::DB_NAME => [ "", Config::T_STRING ],
Config::DB_PASS => [ "", Config::T_STRING ],
Config::DB_PORT => [ "5432", Config::T_STRING ],
Config::SCRATCH_DB => [ "db/scratch.db", Config::T_STRING ],
Config::CALIBRE_DB => [ "", Config::T_STRING ],
Config::BOOKS_DIR => [ "", Config::T_STRING ],
Config::DICT_SERVER => [ "", Config::T_STRING ],
Config::SESSION_LIFETIME => [ 86400*30, Config::T_INT ],
Config::SESSION_NAME => [ "epube_sid", Config::T_STRING ],
Config::OIDC_NAME => [ "OIDC", Config::T_STRING ],
Config::OIDC_URL => [ "", Config::T_STRING ],
Config::OIDC_CLIENT_ID => [ "", Config::T_STRING ],
Config::OIDC_CLIENT_SECRET => [ "", Config::T_STRING ],
];
private static ?Config $instance = null;
/** @var array<string, array<bool|int|string>> */
private array $params = [];
private Db_Migrations $migrations;
public static function get_instance() : Config {
if (self::$instance == null)
self::$instance = new self();
return self::$instance;
}
private function __clone() {
//
}
/** load data from environment variables */
function reload(): void {
$ref = new ReflectionClass(get_class($this));
foreach ($ref->getConstants() as $const => $cvalue) {
if (isset(self::_DEFAULTS[$const])) {
$override = getenv(self::_ENVVAR_PREFIX . $const);
list ($defval, $deftype) = self::_DEFAULTS[$const];
$this->params[$cvalue] = [ self::cast_to($override !== false ? $override : $defval, $deftype), $deftype ];
}
}
}
/** this is primarily needed for tests, normally global config is not changed at runtime */
static function set(string $key, mixed $value): bool {
if (!getenv('IS_INTEGRATION_TESTING') && !getenv('IS_TESTING')) {
user_error("This method is only available for tests.", E_USER_WARNING);
return false;
} if (array_key_exists($key, self::_DEFAULTS)) {
list ($defval, $deftype) = self::_DEFAULTS[$key];
self::get_instance()->params[$key] = [self::cast_to($value, $deftype), $deftype];
return true;
} else {
user_error("Requested to set unknown global config variable: {$key}", E_USER_WARNING);
return false;
}
}
function __construct() {
$this->reload();
}
static function get_migrations() : Db_Migrations {
return self::get_instance()->_get_migrations();
}
private function _get_migrations() : Db_Migrations {
if (empty($this->migrations)) {
$this->migrations = new Db_Migrations();
$this->migrations->initialize(dirname(__DIR__) . "/sql", "epube_migrations", true);
}
return $this->migrations;
}
static function is_migration_needed() : bool {
return self::get_migrations()->is_migration_needed();
}
static function get_schema_version() : int {
return self::get_migrations()->get_version();
}
/** @return int|bool|string */
static function cast_to(string $value, int $type_hint) : mixed {
switch ($type_hint) {
case self::T_BOOL:
return sql_bool_to_bool($value);
case self::T_INT:
return (int) $value;
default:
return $value;
}
}
/** @return int|bool|string */
private function _get(string $param) : mixed {
list ($value, $type_hint) = $this->params[$param];
return $this->cast_to($value, $type_hint);
}
private function _add(string $param, string $default, int $type_hint) : void {
$override = getenv($this::_ENVVAR_PREFIX . $param);
$this->params[$param] = [ self::cast_to(!empty($override) ? $override : $default, $type_hint), $type_hint ];
}
static function add(string $param, string $default, int $type_hint = Config::T_STRING) : void {
$instance = self::get_instance();
$instance->_add($param, $default, $type_hint);
}
/** @return int|bool|string */
static function get(string $param) {
$instance = self::get_instance();
return $instance->_get($param);
}
static function is_server_https() : bool {
return (!empty($_SERVER['HTTPS']) && ($_SERVER['HTTPS'] != 'off')) ||
(!empty($_SERVER['HTTP_X_FORWARDED_PROTO']) && $_SERVER['HTTP_X_FORWARDED_PROTO'] == 'https');
}
/** generates reference self_url_path (no trailing slash) */
static function get_self_url() : string {
$proto = self::is_server_https() ? 'https' : 'http';
$self_url_path = $proto . '://' . $_SERVER["HTTP_HOST"] . $_SERVER["REQUEST_URI"];
$self_url_path = preg_replace("/\w+\.php(\?.*$)?$/", "", $self_url_path);
if (substr($self_url_path, -1) === "/") {
return substr($self_url_path, 0, -1);
} else {
return $self_url_path;
}
}
/** also initializes Db and ORM */
static function sanity_check() : void {
/*
we don't actually need the DB object right now but some checks below might use ORM which won't be initialized
because it is set up in the Db constructor, which is why it's a good idea to invoke it as early as possible
it is a bit of a hack, maybe ORM should be initialized somewhere else (functions.php?)
*/
$pdo = Db::pdo();
$errors = [];
if (function_exists('posix_getuid') && posix_getuid() == 0) {
array_push($errors, "Please don't run this script as root.");
}
if (version_compare(PHP_VERSION, '7.1.0', '<')) {
array_push($errors, "PHP version 7.1.0 or newer required. You're using " . PHP_VERSION . ".");
}
if (php_sapi_name() != "cli") {
if (self::get_schema_version() < 0) {
array_push($errors, "Base database schema is missing. Either load it manually or perform a migration (<code>update.php --update-schema</code>)");
}
}
if (count($errors) > 0 && php_sapi_name() != "cli") { ?>
<!DOCTYPE html>
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link href="lib/bootstrap/v3/css/bootstrap.min.css" rel="stylesheet" media="screen">
<link href="lib/bootstrap/v3/css/bootstrap-theme.min.css" rel="stylesheet" media="screen">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<script src="dist/app-libs.min.js"></script>
<title>Startup failed</title>
<link type="text/css" rel="stylesheet" media="screen" href="dist/app.min.css" />
<link rel="shortcut icon" type="image/png" href="img/favicon.png" />
<link rel="manifest" href="manifest.json">
<meta name="mobile-web-app-capable" content="yes">
<script type="text/javascript">
$(document).ready(function() {
/* global EpubeApp */
if (typeof EpubeApp != "undefined") {
EpubeApp.setPage("PAGE_LOGIN");
}
});
</script>
</head>
<body class="epube-sanity-failed">
<div class="container">
<h1>Startup failed</h1>
<p>Please fix errors indicated by the following messages:</p>
<?php foreach ($errors as $error) { echo self::format_error($error); } ?>
</div>
</body>
</html>
<?php
die;
} else if (count($errors) > 0) {
echo "Please fix errors indicated by the following messages:\n\n";
foreach ($errors as $error) {
echo " * " . strip_tags($error)."\n";
}
exit(1);
}
}
private static function format_error(string $msg) : string {
return "<div class=\"alert alert-danger\">$msg</div>";
}
}
|