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
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
|
<?php
/**
* Planet configuration class
*/
class PlanetConfig
{
/** @var array<string, mixed> */
protected $conf = [];
private ?string $opmlFile = null;
private ?string $cacheDir = null;
/** @var array<string, mixed> */
public static $defaultConfig = [
'url' => 'http://www.example.com/',
'name' => '',
'locale' => 'en',
'items' => 10,
'refresh' => 3600,
'cache' => 1800,
'categories' => '',
'cachedir' => './cache',
'debug' => false,
'checkcerts' => true,
];
/**
* PlanetConfig constructor.
* @param array<string, mixed> $userConfig
* @param bool $useDefaultConfig
*/
public function __construct($userConfig = [], $useDefaultConfig = true)
{
$default = $useDefaultConfig ? self::$defaultConfig : array();
$this->conf = $this->merge($default, $userConfig);
}
/**
*/
public static function load(string $dir) : PlanetConfig
{
$config = new PlanetConfig;
if (!self::isInstalled()) {
if (!self::isInstalledPre10Version()) {
return $config;
}
if (!self::migratePre10Version()) {
error_log('Failed to migrate configuration.');
return $config;
}
}
$configFile = realpath(config_path('config.yml'));
$conf = Spyc::YAMLLoad($configFile);
// this is a check to upgrade older config file without l10n
if (!isset($conf['locale'])) {
$resetPlanetConfig = new PlanetConfig($conf);
file_put_contents($configFile, $resetPlanetConfig->toYaml());
$conf = Spyc::YAMLLoad($configFile);
return $resetPlanetConfig;
}
$config = new PlanetConfig($conf);
return $config;
}
/**
* Is moonmoon installed?
*
* @return bool
*/
public static function isInstalled() : bool
{
return file_exists(config_path('config.yml')) &&
file_exists(config_path('people.opml'));
}
/**
* Or is it a pre-10 version installed?
* (that is, config is stored in custom/config.yml instead of custom/config/config.yml)
*/
public static function isInstalledPre10Version(): bool
{
return file_exists(custom_path('config.yml')) &&
file_exists(custom_path('people.opml'));
}
/**
* Migrate config files from old to new location.
* Purge cache.
*
* @return bool true if succeeded, false otherwise
*/
public static function migratePre10Version() : bool
{
if (!is_dir(config_path())) {
if (!mkdir(config_path(), 0777, true)) {
return false;
}
}
return self::migrate_file('config.yml') &&
self::migrate_file('people.opml');
}
public static function migrate_file(string $file) : bool
{
$source = custom_path($file);
$dest = config_path($file);
if (!copy($source, $source . '.bak')) {
error_log("Failed to make a backup of ${source}");
return false;
}
if (!rename($source, $dest)) {
error_log("Failed to move ${source} to ${dest}");
return false;
}
return true;
}
/**
* Merge the configuration of the user in the default one.
*
* @param array<string, mixed> $default
* @param array<string, mixed> $user
* @return array<string, mixed>
*/
protected function merge($default = [], $user = [])
{
return array_merge($default, $this->normalizeArrayKeys($user));
}
public function getUrl() : string
{
return $this->conf['url'];
}
public function getName() : string
{
return $this->conf['name'];
}
public function setName(string $name) : void
{
$this->conf['name'] = $name;
}
public function getCacheTimeout() : int
{
return $this->conf['refresh'];
}
public function getCacheDir() : string
{
if (is_null($this->cacheDir)) {
$this->cacheDir = realpath(__DIR__ . '/../../'.$this->conf['cachedir']);
}
return $this->cacheDir;
}
public function getOpmlFile() : string
{
if (is_null($this->opmlFile)) {
$this->opmlFile = realpath(config_path('people.opml'));
}
return $this->opmlFile;
}
public function getOutputTimeout() : int
{
return $this->conf['cache'];
}
public function getMaxDisplay() : int
{
return $this->conf['items'];
}
public function getCategories() : string
{
return $this->conf['categories'];
}
public function toYaml() : string
{
return Spyc::YAMLDump($this->conf, 4);
}
/**
* @return array<string, mixed>
*/
public function toArray()
{
return $this->conf;
}
public function getDebug() : bool
{
return $this->conf['debug'];
}
public function checkCertificates() : bool
{
return $this->conf['checkcerts'];
}
public function getLocale() : string
{
return $this->conf['locale'];
}
/**
* @return array<string, mixed>
*/
public function getDefaultConfig()
{
return self::$defaultConfig;
}
/**
* Normalize the name of a configuration key.
*
* @param string $key
* @return string
*/
protected function normalizeKeyName(string $key) : string
{
return strtolower($key);
}
/**
* Normalize all the keys of the array.
*
* @param array<string, mixed> $array
* @return array<string, mixed>
*/
protected function normalizeArrayKeys($array = [])
{
foreach ($array as $key => $value) {
$normalized = $this->normalizeKeyName($key);
if ($normalized !== $key) {
$array[$this->normalizeKeyName($key)] = $value;
unset($array[$key]);
}
}
return $array;
}
/**
* Generic configuration getter.
*
* @return mixed|null
*/
public function __get(string $key)
{
$key = $this->normalizeKeyName($key);
return array_key_exists($key, $this->conf) ?
$this->conf[$key] :
null;
}
/**
* Generic configuration setter.
*/
public function __set(string $key, mixed $value) : void
{
$key = $this->normalizeKeyName($key);
$this->conf[$key] = $value;
}
}
|
