Repository navigation
Expand file tree
/
Copy pathinfoutils.php
More file actions
649 lines (584 loc) · 20.4 KB
/
Copy pathinfoutils.php
File metadata and controls
649 lines (584 loc) · 20.4 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
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
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
<?php
/**
* Information and debugging functions
*
* @license GPL 2 (http://www.gnu.org/licenses/gpl.html)
* @author Andreas Gohr <andi@splitbrain.org>
*/
use dokuwiki\Debug\DebugHelper;
use dokuwiki\Extension\AuthPlugin;
use dokuwiki\Extension\Event;
use dokuwiki\HTTP\DokuHTTPClient;
use dokuwiki\Logger;
use dokuwiki\Utf8\PhpString;
if (!defined('DOKU_MESSAGEURL')) {
if (in_array('ssl', stream_get_transports())) {
define('DOKU_MESSAGEURL', 'https://update.dokuwiki.org/check/');
} else {
define('DOKU_MESSAGEURL', 'http://update.dokuwiki.org/check/');
}
}
/**
* Check for new messages from upstream
*
* @author Andreas Gohr <andi@splitbrain.org>
*/
function checkUpdateMessages()
{
global $conf;
global $INFO;
global $updateVersion;
if (!$conf['updatecheck']) return;
if ($conf['useacl'] && !$INFO['ismanager']) return;
$cf =
8000
getCacheName($updateVersion, '.updmsg');
$lm = @filemtime($cf);
$is_http = !str_starts_with(DOKU_MESSAGEURL, 'https');
// check if new messages needs to be fetched
if ($lm < time() - (60 * 60 * 24) || $lm < @filemtime(DOKU_INC . DOKU_SCRIPT)) {
@touch($cf);
Logger::debug(
sprintf(
'checkUpdateMessages(): downloading messages to %s%s',
$cf,
$is_http ? ' (without SSL)' : ' (with SSL)'
)
);
$http = new DokuHTTPClient();
$http->timeout = 12;
$resp = $http->get(DOKU_MESSAGEURL . $updateVersion);
if (is_string($resp) && ($resp == '' || str_ends_with(trim($resp), '%'))) {
// basic sanity check that this is either an empty string response (ie "no messages")
// or it looks like one of our messages, not WiFi login or other interposed response
io_saveFile($cf, $resp);
} else {
Logger::debug("checkUpdateMessages(): unexpected HTTP response received", $http->error);
}
} else {
Logger::debug("checkUpdateMessages(): messages up to date");
}
$data = io_readFile($cf);
// show messages through the usual message mechanism
$msgs = explode("\n%\n", $data);
foreach ($msgs as $msg) {
if ($msg) msg($msg, 2);
}
}
/**
* Return DokuWiki's version (split up in date and type)
*
* @author Andreas Gohr <andi@splitbrain.org>
*/
function getVersionData()
{
$version = [];
//import version string
if (file_exists(DOKU_INC . 'VERSION')) {
//official release
$version['date'] = trim(io_readFile(DOKU_INC . 'VERSION'));
$version['type'] = 'Release';
} elseif (is_dir(DOKU_INC . '.git')) {
$version['type'] = 'Git';
$version['date'] = 'unknown';
// First try to get date and commit hash by calling Git
if (function_exists('shell_exec')) {
$commitInfo = shell_exec("git log -1 --pretty=format:'%h %cd' --date=short");
if ($commitInfo) {
[$version['sha'], $date] = explode(' ', $commitInfo);
$version['date'] = hsc($date);
return $version;
}
}
// we cannot use git on the shell -- let's do it manually!
if (file_exists(DOKU_INC . '.git/HEAD')) {
$headCommit = trim(file_get_contents(DOKU_INC . '.git/HEAD'));
if (strpos($headCommit, 'ref: ') === 0) {
// it is something like `ref: refs/heads/master`
$headCommit = substr($headCommit, 5);
$pathToHead = DOKU_INC . '.git/' . $headCommit;
if (file_exists($pathToHead)) {
$headCommit = trim(file_get_contents($pathToHead));
} else {
$packedRefs = file_get_contents(DOKU_INC . '.git/packed-refs');
if (!preg_match("~([[:xdigit:]]+) $headCommit~", $packedRefs, $matches)) {
# ref not found in pack file
return $version;
}
$headCommit = $matches[1];
}
}
// At this point $headCommit is a SHA
$version['sha'] = $headCommit;
// Get commit date from Git object
$subDir = substr($headCommit, 0, 2);
$fileName = substr($headCommit, 2);
$gitCommitObject = DOKU_INC . ".git/objects/$subDir/$fileName";
if (file_exists($gitCommitObject) && function_exists('zlib_decode')) {
$commit = zlib_decode(file_get_contents($gitCommitObject));
$committerLine = explode("\n", $commit)[3];
$committerData = explode(' ', $committerLine);
end($committerData);
$ts = prev($committerData);
if ($ts && $date = date('Y-m-d', $ts)) {
$version['date'] = $date;
}
}
}
} else {
global $updateVersion;
$version['date'] = 'update version ' . $updateVersion;
$version['type'] = 'snapshot?';
}
return $version;
}
/**
* Return DokuWiki's version
*
* This returns the version in the form "Type Date (SHA)". Where type is either
* "Release" or "Git" and date is the date of the release or the date of the
* last commit. SHA is the short SHA of the last commit - this is only added on
* git checkouts.
*
* If no version can be determined "snapshot? update version XX" is returned.
* Where XX represents the update version number set in doku.php.
*
* @return string The version string e.g. "Release 2023-04-04a"
* @author Anika Henke <anika@selfthinker.org>
*/
function getVersion()
{
$version = getV
8000
ersionData();
$sha = empty($version['sha']) ? '' : ' (' . $version['sha'] . ')';
return $version['type'] . ' ' . $version['date'] . $sha;
}
/**
* Get some data about the environment this wiki is running in
*
* @return array
*/
function getRuntimeVersions()
{
$data = [];
$data['php'] = 'PHP ' . PHP_VERSION;
$osRelease = getOsRelease();
if (isset($osRelease['PRETTY_NAME'])) {
$data['dist'] = $osRelease['PRETTY_NAME'];
}
$data['os'] = php_uname('s') . ' ' . php_uname('r');
$data['sapi'] = PHP_SAPI;
if (getenv('KUBERNETES_SERVICE_HOST')) {
$data['container'] = 'Kubernetes';
} elseif (@file_exists('/.dockerenv')) {
$data['container'] = 'Docker';
}
return $data;
}
/**
* Get informational data about the linux distribution this wiki is running on
*
* @see https://gist.github.com/natefoo/814c5bf936922dad97ff
* @return array an os-release array, might be empty
*/
function getOsRelease()
{
$reader = fn($file) => @parse_ini_string(preg_replace('/#.*$/m', '', file_get_contents($file)));
$osRelease = [];
if (@file_exists('/etc/os-release')) {
// pretty much any common Linux distribution has this
$osRelease = $reader('/etc/os-release');
} elseif (@file_exists('/etc/synoinfo.conf') && @file_exists('/etc/VERSION')) {
// Synology DSM has its own way
$synoInfo = $reader('/etc/synoinfo.conf');
$synoVersion = $reader('/etc/VERSION');
$osRelease['NAME'] = 'Synology DSM';
$osRelease['ID'] = 'synology';
$osRelease['ID_LIKE'] = 'linux';
$osRelease['VERSION_ID'] = $synoVersion['productversion'];
$osRelease['VERSION'] = $synoVersion['productversion'];
$osRelease['SYNO_MODEL'] = $synoInfo['upnpmodelname'];
$osRelease['PRETTY_NAME'] = implode(' ', [$osRelease['NAME'], $osRelease['VERSION'], $osRelease['SYNO_MODEL']]);
}
return $osRelease;
}
/**
* Run a few sanity checks
*
* @author Andreas Gohr <andi@splitbrain.org>
*/
function check()
{
global $conf;
global $INFO;
/* @var Input $INPUT */
global $INPUT;
if ($INFO['isadmin'] || $INFO['ismanager']) {
msg('DokuWiki version: ' . getVersion(), 1);
if (version_compare(phpversion(), '7.4.0', '<')) {
msg('Your PHP version is too old (' . phpversion() . ' vs. 7.4+ needed)', -1);
} else {
msg('PHP version ' . phpversion(), 1);
}
} elseif (version_compare(phpversion(), '7.4.0', '<')) {
msg('Your PHP version is too old', -1);
}
$mem = php_to_byte(ini_get('memory_limit'));
if ($mem) {
if ($mem === -1) {
msg('PHP memory is unlimited', 1);
} elseif ($mem < 16_777_216) {
msg('PHP is limited to less than 16MB RAM (' . filesize_h($mem) . ').
Increase memory_limit in php.ini', -1);
} elseif ($mem < 20_971_520) {
msg('PHP is limited to less than 20MB RAM (' . filesize_h($mem) . '),
you might encounter problems with bigger pages. Increase memory_limit in php.ini', -1);
} elseif ($mem < 33_554_432) {
msg('PHP is limited to less than 32MB RAM (' . filesize_h($mem) . '),
but that should be enough in most cases. If not, increase memory_limit in php.ini', 0);
} else {
msg('More than 32MB RAM (' . filesize_h($mem) . ') available.', 1);
}
}
if (is_writable($conf['changelog'])) {
msg('Changelog is writable', 1);
} elseif (file_exists($conf['changelog'])) {
msg('Changelog is not writable', -1);
}
if (isset($conf['changelog_old']) && file_exists($conf['changelog_old'])) {
msg('Old changelog exists', 0);
}
if (file_exists($conf['changelog'] . '_failed')) {
msg('Importing old changelog failed', -1);
} elseif (file_exists($conf['changelog'] . '_importing')) {
msg('Importing old changelog now.', 0);
} elseif (file_exists($conf['changelog'] . '_import_ok')) {
msg('Old changelog imported', 1);
if (!plugin_isdisabled('importoldchangelog')) {
msg('Importoldchangelog plugin not disabled after import', -1);
}
}
if (is_writable(DOKU_CONF)) {
msg('conf directory is writable', 1);
} else {
msg('conf directory is not writable', -1);
}
if ($conf['authtype'] == 'plain') {
global $config_cascade;
if (is_writable($config_cascade['plainauth.users']['default'])) {
msg('conf/users.auth.php is writable', 1);
} else {
msg('conf/users.auth.php is not writable', 0);
}
}
if (function_exists('mb_strpos')) {
if (defined('UTF8_NOMBSTRING')) {
msg('mb_string extension is available but will not be used', 0);
} else {
msg('mb_string extension is available and will be used', 1);
if (ini_get('mbstring.func_overload') != 0) {
msg('mb_string function overloading is enabled, this will cause problems and should be disabled', -1);
}
}
} else {
msg('mb_string extension not available - PHP only replacements will be used', 0);
}
if (!UTF8_PREGSUPPORT) {
msg('PHP is missing UTF-8 support in Perl-Compatible Regular Expressions (PCRE)', -1);
}
if (!UTF8_PROPERTYSUPPORT) {
msg('PHP is missing Unicode properties support in Perl-Compatible Regular Expressions (PCRE)', -1);
}
$loc = setlocale(LC_ALL, 0);
if (!$loc) {
msg('No valid locale is set for your PHP setup. You should fix this', -1);
} elseif (stripos($loc, 'utf') === false) {
msg('Your locale <code>' . hsc($loc) . '</code> seems not to be a UTF-8 locale,
you should fix this if you encounter problems.', 0);
} else {
msg('Valid locale ' . hsc($loc) . ' found.', 1);
}
if ($conf['allowdebug']) {
msg('Debugging support is enabled. If you don\'t need it you should set $conf[\'allowdebug\'] = 0', -1);
} else {
msg('Debugging support is disabled', 1);
}
if (!empty($INFO['userinfo']['name'])) {
msg(sprintf(
"You are currently logged in as %s (%s)",
$INPUT->server->str('REMOTE_USER'),
$INFO['userinfo']['name']
), 0);
msg('You are part of the groups ' . implode(', ', $INFO['userinfo']['grps']), 0);
} else {
msg('You are currently not logged in', 0);
}
msg('Your current permission for this page is ' . $INFO['perm'], 0);
if (file_exists($INFO['filepath']) && is_writable($INFO['filepath'])) {
msg('The current page is writable by the webserver', 1);
} elseif (!file_exists($INFO['filepath']) && is_writable(dirname($INFO['filepath']))) {
msg('The current page can be created by the webserver', 1);
} else {
msg('The current page is not writable by the webserver', -1);
}
if ($INFO['writable']) {
msg('The current page is writable by you', 1);
} else {
msg('The current page is not writable by you', -1);
}
// Check for corrupted search index
$lengths = idx_listIndexLengths();
$index_corrupted = false;
foreach ($lengths as $length) {
if (count(idx_getIndex('w', $length)) !== count(idx_getIndex('i', $length))) {
$index_corrupted = true;
break;
}
}
foreach (idx_getIndex('metadata', '') as $index) {
if (count(idx_getIndex($index . '_w', '')) !== count(idx_getIndex($index . '_i', ''))) {
$index_corrupted = true;
break;
}
}
if ($index_corrupted) {
msg(
'The search index is corrupted. It might produce wrong results and most
probably needs to be rebuilt. See
<a href="https://www.dokuwiki.org/faq:searchindex">faq:searchindex</a>
for ways to rebuild the search index.',
-1
);
} elseif (!empty($lengths)) {
msg('The search index seems to be working', 1);
} else {
msg(
'The search index is empty. See
<a href="https://www.dokuwiki.org/faq:searchindex">faq:searchindex</a>
for help on how to fix the search index. If the default indexer
isn\'t used or the wiki is actually empty this is normal.'
);
}
// rough time check
$http = new DokuHTTPClient();
$http->max_redirect = 0;
$http->timeout = 3;
$http->sendRequest('https://www.dokuwiki.org', '', 'HEAD');
$now = time();
if (isset($http->resp_headers['date'])) {
$time = strtotime($http->resp_headers['date']);
$diff = $time - $now;
if (abs($diff) < 4) {
msg("Server time seems to be okay. Diff: {$diff}s", 1);
} else {
msg("Your server's clock seems to be out of sync!
Consider configuring a sync with a NTP server. Diff: {$diff}s");
}
}
}
/**
* Display a message to the user
*
* If HTTP headers were not sent yet the message is added
* to the global message array else it's printed directly
* using html_msgarea()
*
* Triggers INFOUTIL_MSG_SHOW
*
* @param string $message
* @param int $lvl -1 = error, 0 = info, 1 = success, 2 = notify
* @param string $line line number
* @param string $file file number
* @param int $allow who's allowed to see the message, see MSG_* constants
* @see html_msgarea()
*/
function msg($message, $lvl = 0, $line = '', $file = '', $allow = MSG_PUBLIC)
{
global $MSG, $MSG_shown;
static $errors = [
-1 => 'error',
0 => 'info',
1 => 'success',
2 => 'notify',
];
$msgdata = [
'msg' => $message,
'lvl' => $errors[$lvl],
'allow' => $allow,
'line' => $line,
'file' => $file,
];
$evt = new Event('INFOUTIL_MSG_SHOW', $msgdata);
if ($evt->advise_before()) {
/* Show msg normally - event could suppress message show */
if ($msgdata['line'] || $msgdata['file']) {
$basename = PhpString::basename($msgdata['file']);
$msgdata['msg'] .= ' [' . $basename . ':' . $msgdata['line'] . ']';
}
if (!isset($MSG)) $MSG = [];
$MSG[] = $msgdata;
if (isset($MSG_shown) || headers_sent()) {
if (function_exists('html_msgarea')) {
html_msgarea();
} else {
echo "ERROR(" . $msgdata['lvl'] . ") " . $msgdata['msg'] . "\n";
}
unset($GLOBALS['MSG']);
}
}
$evt->advise_after();
unset($evt);
}
/**
* Determine whether the current user is allowed to view the message
* in the $msg data structure
*
* @param array $msg dokuwiki msg structure:
* msg => string, the message;
* lvl => int, level of the message (see msg() function);
* allow => int, flag used to determine who is allowed to see the message, see MSG_* constants
* @return bool
*/
function info_msg_allowed($msg)
{
global $INFO, $auth;
// is the message public? - everyone and anyone can see it
if (empty($msg['allow']) || ($msg['allow'] == MSG_PUBLIC)) return true;
// restricted msg, but no authentication
if (!$auth instanceof AuthPlugin) return false;
switch ($msg['allow']) {
case MSG_USERS_ONLY:
return !empty($INFO['userinfo']);
case MSG_MANAGERS_ONLY:
return $INFO['ismanager'];
case MSG_ADMINS_ONLY:
return $INFO['isadmin'];
default:
trigger_error(
'invalid msg allow restriction. msg="' . $msg['msg'] . '" allow=' . $msg['allow'] . '"',
E_USER_WARNING
);
return $INFO['isadmin'];
}
}
/**
* print debug messages
*
* little function to print the content of a var
*
* @param string $msg
* @param bool $hidden
*
* @author Andreas Gohr <andi@splitbrain.org>
*/
function dbg($msg, $hidden = false)
{
if ($hidden) {
echo "<!--\n";
print_r($msg);
echo "\n-->";
} else {
echo '<pre class="dbg">';
echo hsc(print_r($msg, true));
echo '</pre>';
}
}
/**
8BD0
* Print info to debug log file
*
* @param string $msg
* @param string $header
*
* @author Andreas Gohr <andi@splitbrain.org>
* @deprecated 2020-08-13
*/
function dbglog($msg, $header = '')
{
dbg_deprecated('\\dokuwiki\\Logger');
// was the msg as single line string? use it as header
if ($header === '' && is_string($msg) && strpos($msg, "\n") === false) {
$header = $msg;
$msg = '';
}
Logger::getInstance(Logger::LOG_DEBUG)->log(
$header,
$msg
);
}
/**
* Log accesses to deprecated fucntions to the debug log
*
* @param string $alternative The function or method that should be used instead
* @triggers INFO_DEPRECATION_LOG
*/
function dbg_deprecated($alternative = '')
{
DebugHelper::dbgDeprecatedFunction($alternative, 2);
}
/**
* Print a reversed, prettyprinted backtrace
*
* @author Gary Owen <gary_owen@bigfoot.com>
*/
function dbg_backtrace()
{
// Get backtrace
$backtrace = debug_backtrace();
// Unset call to debug_print_backtrace
array_shift($backtrace);
// Iterate backtrace
$calls = [];
$depth = count($backtrace) - 1;
foreach ($backtrace as $i => $call) {
if (isset($call['file'])) {
$location = $call['file'] . ':' . ($call['line'] ?? '0');
} else {
$location = '[anonymous]';
}
if (isset($call['class'])) {
$function = $call['class'] . $call['type'] . $call['function'];
} else {
$function = $call['function'];
}
$params = [];
if (isset($call['args'])) {
foreach ($call['args'] as $arg) {
if (is_object($arg)) {
$params[] = '[Object ' . get_class($arg) . ']';
} elseif (is_array($arg)) {
$params[] = '[Array]';
} elseif (is_null($arg)) {
$params[] = '[NULL]';
} else {
$params[] = '"' . $arg . '"';
}
}
}
$params = implode(', ', $params);
$calls[$depth - $i] = sprintf(
'%s(%s) called at %s',
$function,
str_replace("\n", '\n', $params),
$location
);
}
ksort($calls);
return implode("\n", $calls);
}
/**
* Remove all data from an array where the key seems to point to sensitive data
*
* This is used to remove passwords, mail addresses and similar data from the
* debug output
*
* @param array $data
*
* @author Andreas Gohr <andi@splitbrain.org>
*/
function debug_guard(&$data)
{
foreach ($data as $key => $value) {
if (preg_match('/(notify|pass|auth|secret|ftp|userinfo|token|buid|mail|proxy)/i', $key)) {
$data[$key] = '***';
continue;
}
if (is_array($value)) debug_guard($data[$key]);
}
}