Repository navigation
Expand file tree
/
Copy pathcommon.php
More file actions
1959 lines (1784 loc) · 56.5 KB
/
Copy pathcommon.php
File metadata and controls
1959 lines (1784 loc) · 56.5 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
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
* Common DokuWiki functions
*
* @license GPL 2 (http://www.gnu.org/licenses/gpl.html)
* @author Andreas Gohr <andi@splitbrain.org>
*/
use dokuwiki\PassHash;
use dokuwiki\Draft;
use dokuwiki\PrefCookie;
use dokuwiki\Utf8\Clean;
use dokuwiki\Utf8\PhpString;
use dokuwiki\Utf8\Conversion;
use dokuwiki\Cache\CacheRenderer;
use dokuwiki\ChangeLog\PageChangeLog;
use dokuwiki\File\PageFile;
use dokuwiki\Subscriptions\PageSubscriptionSender;
use dokuwiki\Subscriptions\SubscriberManager;
use dokuwiki\Extension\AuthPlugin;
use dokuwiki\Extension\Event;
use dokuwiki\Ip;
use function PHP81_BC\strftime;
/**
* Wrapper around htmlspecialchars()
*
* @param string $string the string being converted
* @return string converted string
* @author Andreas Gohr <andi@splitbrain.org>
* @see htmlspecialchars()
*
*/
function hsc($string)
{
return htmlspecialchars($string, ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML401, 'UTF-8');
}
/**
* A safer explode for fixed length lists
*
* This works just like explode(), but will always return the wanted number of elements.
* If the $input string does not contain enough elements, the missing elements will be
* filled up with the $default value. If the input string contains more elements, the last
* one will NOT be split up and will still contain $separator
*
* @param string $separator The boundary string
* @param string $string The input string
* @param int $limit The number of expected elements
* @param mixed $default The value to use when filling up missing elements
* @return array
* @see explode
*/
function sexplode($separator, $string, $limit, $default = null)
{
return array_pad(explode($separator, $string, $limit), $limit, $default);
}
/**
* Checks if the given input is blank
*
* This is similar to empty() but will return false for "0".
*
* Please note: when you pass uninitialized variables, they will implicitly be created
* with a NULL value without warning.
*
* To avoid this it's recommended to guard the call with isset like this:
*
* (isset($foo) && !blank($foo))
* (!isset($foo) || blank($foo))
*
* @param $in
* @param bool $trim Consider a string of whitespace to be blank
* @return bool
*/
function blank(&$in, $trim = false)
{
if (is_null($in)) return true;
if (is_array($in)) return $in === [];
if ($in === "\0") return true;
if ($trim && trim($in) === '') return true;
if (strlen($in) > 0) return false;
return empty($in);
}
/**
* strips control characters (<32) from the given string
*
* @param string $string being stripped
* @return string
* @author Andreas Gohr <andi@splitbrain.org>
*
*/
function stripctl($string)
{
return preg_replace('/[\x00-\x1F]+/s', '', $string);
}
/**
* Return a secret token to be used for CSRF attack prevention
*
* @return string
* @link http://en.wikipedia.org/wiki/Cross-site_request_forgery
* @link http://christ1an.blogspot.com/2007/04/preventing-csrf-efficiently.html
*
* @author Andreas Gohr <andi@splitbrain.org>
*/
function getSecurityToken()
{
/** @var Input $INPUT */
global $INPUT;
$user = $INPUT->server->str('REMOTE_USER');
$session = session_id();
// CSRF checks are only for logged in users - do not generate for anonymous
8000
if (trim($user) == '' || trim($session) == '') return '';
return PassHash::hmac('md5', $session . $user, auth_cookiesalt());
}
/**
* Check the secret CSRF token
*
* @param null|string $token security token or null to read it from request variable
* @return bool success if the token matched
*/
function checkSecurityToken($token = null)
{
/** @var Input $INPUT */
global $INPUT;
if (!$INPUT->server->str('REMOTE_USER')) return true; // no logged in user, no need for a check
if (is_null($token)) $token = $INPUT->str('sectok');
if (getSecurityToken() != $token) {
msg('Security Token did not match. Possible CSRF attack.', -1);
return false;
}
return true;
}
/**
* Print a hidden form field with a secret CSRF token
*
* @param bool $print if true print the field, otherwise html of the field is returned
* @return string html of hidden form field
* @author Andreas Gohr <andi@splitbrain.org>
*
*/
function formSecurityToken($print = true)
{
$ret = '<div class="no"><input type="hidden" name="sectok" value="' . getSecurityToken() . '" /></div>' . "\n";
if ($print) echo $ret;
return $ret;
}
/**
* Determine basic information for a request of $id
*
* @param string $id pageid
* @param bool $htmlClient add info about whether is mobile browser
* @return array with info for a request of $id
*
* @author Chris Smith <chris@jalakai.co.uk>
*
* @author Andreas Gohr <andi@splitbrain.org>
*/
function basicinfo($id, $htmlClient = true)
{
global $USERINFO;
/* @var Input $INPUT */
global $INPUT;
// set info about manager/admin status.
$info = [];
$info['isadmin'] = false;
$info['ismanager'] = false;
if ($INPUT->server->has('REMOTE_USER')) {
$info['userinfo'] = $USERINFO;
$info['perm'] = auth_quickaclcheck($id);
$info['client'] = $INPUT->server->str('REMOTE_USER');
if ($info['perm'] == AUTH_ADMIN) {
$info['isadmin'] = true;
$info['ismanager'] = true;
} elseif (auth_ismanager()) {
$info['ismanager'] = true;
}
// if some outside auth were used only REMOTE_USER is set
if (empty($info['userinfo']['name'])) {
$info['userinfo']['name'] = $INPUT->server->str('REMOTE_USER');
}
} else {
$info['perm'] = auth_aclcheck($id, '', null);
$info['client'] = clientIP(true);
}
$info['namespace'] = getNS($id);
// mobile detection
if ($htmlClient) {
$info['ismobile'] = clientismobile();
}
return $info;
}
/**
* Return info about the current document as associative
* array.
*
* @return array with info about current document
* @throws Exception
*
* @author Andreas Gohr <andi@splitbrain.org>
*/
function pageinfo()
{
global $ID;
global $REV;
global $RANGE;
global $lang;
$info = basicinfo($ID);
// include ID & REV not redundant, as some parts of DokuWiki may temporarily change $ID, e.g. p_wiki_xhtml
// FIXME ... perhaps it would be better to ensure the temporary changes weren't necessary
$info['id'] = $ID;
$info['rev'] = $REV;
$subManager = new SubscriberManager();
$info['subscribed'] = $subManager->userSubscription();
$info['locked'] = checklock($ID);
$info['filepath'] = wikiFN($ID);
$info['exists'] = file_exists($info['filepath']);
$info['currentrev'] = @filemtime($info['filepath']);
if ($REV) {
//check if current revision was meant
if ($info['exists'] && ($info['currentrev'] == $REV)) {
$REV = '';
} elseif ($RANGE) {
//section editing does not work with old revisions!
$REV = '';
$RANGE = '';
msg($lang['nosecedit'], 0);
} else {
//really use old revision
$info['filepath'] = wikiFN($ID, $REV);
$info['exists'] = file_exists($info['filepath']);
}
}
$info['rev'] = $REV;
if ($info['exists']) {
$info['writable'] = (is_writable($info['filepath']) && $info['perm'] >= AUTH_EDIT);
} else {
$info['writable'] = ($info['perm'] >= AUTH_CREATE);
}
$info['editable'] = ($info['writable'] && empty($info['locked']));
$info['lastmod'] = @filemtime($info['filepath']);
//load page meta data
$info['meta'] = p_get_metadata($ID);
//who's the editor
$pagelog = new PageChangeLog($ID, 1024);
if ($REV) {
$revinfo = $pagelog->getRevisionInfo($REV);
} elseif (!empty($info['meta']['last_change']) && is_array($info['meta']['last_change'])) {
$revinfo = $info['meta']['last_change'];
} else {
$revinfo = $pagelog->getRevisionInfo($info['lastmod']);
// cache most recent changelog line in metadata if missing and still valid
if ($revinfo !== false) {
$info['meta']['last_change'] = $revinfo;
p_set_metadata($ID, ['last_change' => $revinfo]);
}
}
//and check for an external edit
if ($revinfo !== false && $revinfo['date'] != $info['lastmod']) {
// cached changelog line no longer valid
$revinfo = false;
$info['meta']['last_change'] = $revinfo;
p_set_metadata($ID, ['last_change' => $revinfo]);
}
if ($revinfo !== false) {
$info['ip'] = $revinfo['ip'];
$info['user'] = $revinfo['user'];
$info['sum'] = $revinfo['sum'];
// See also $INFO['meta']['last_change'] which is the most recent log line for page $ID.
// Use $INFO['meta']['last_change']['type']===DOKU_CHANGE_TYPE_MINOR_EDIT in place of $info['minor'].
$info['editor'] = $revinfo['user'] ?: $revinfo['ip'];
} else {
$info['ip'] = null;
$info['user'] = null;
$info['sum'] = null;
$info['editor'] = null;
}
// draft
$draft = new Draft($ID, $info['client']);
if ($draft->isDraftAvailable()) {
$info['draft'] = $draft->getDraftFilename();
}
return $info;
}
/**
* Initialize and/or fill global $JSINFO with some basic info to be given to javascript
*/
function jsinfo()
{
global $JSINFO, $ID, $INFO, $ACT;
if (!is_array($JSINFO)) {
$JSINFO = [];
}
//export minimal info to JS, plugins can add more
$JSINFO['id'] = $ID;
$JSINFO['namespace'] = isset($INFO) ? (string)$INFO['namespace'] : '';
$JSINFO['ACT'] = act_clean($ACT);
$JSINFO['useHeadingNavigation'] = (int)useHeading('navigation');
$JSINFO['useHeadingContent'] = (int)useHeading('content');
}
/**
* Return information about the current media item as an associative array.
*
* @return array with info about current media item
*/
function mediainfo()
{
global $NS;
global $IMG;
$info = basicinfo("$NS:*");
$info['image'] = $IMG;
return $info;
}
/**
* Build an string of URL parameters
*
* @see http_build_query()
* @param array|object $params the data to encode
* @param string $sep series of pairs are separated by this character
* @return string query string
*
*/
function buildURLparams($params, $sep = '&')
{
return http_build_query($params, '', $sep, PHP_QUERY_RFC3986);
}
/**
* Build an string of html tag attributes
*
* Skips keys starting with '_', values get HTML encoded
*
* @param array $params array with (attribute name-attribute value) pairs
* @param bool $skipEmptyStrings skip empty string values?
* @return string
* @author Andreas Gohr
*
*/
function buildAttributes($params, $skipEmptyStrings = false)
{
$url = '';
$white = false;
foreach ($params as $key => $val) {
if ($key[0] == '_') continue;
if ($val === '' && $skipEmptyStrings) continue;
if ($white) $url .= ' ';
$url .= $key . '="';
$url .= hsc($val);
$url .= '"';
$white = true;
}
8000
return $url;
}
/**
* This builds the breadcrumb trail and returns it as array
*
* @return string[] with the data: array(pageid=>name, ... )
* @author Andreas Gohr <andi@splitbrain.org>
*
*/
function breadcrumbs()
{
// we prepare the breadcrumbs early for quick session closing
static $crumbs = null;
if ($crumbs != null) return $crumbs;
global $ID;
global $ACT;
global $conf;
global $INFO;
//first visit?
$crumbs = $_SESSION[DOKU_COOKIE]['bc'] ?? [];
//we only save on show and existing visible readable wiki documents
$file = wikiFN($ID);
if ($ACT != 'show' || $INFO['perm'] < AUTH_READ || isHiddenPage($ID) || !file_exists($file)) {
$_SESSION[DOKU_COOKIE]['bc'] = $crumbs;
return $crumbs;
}
// page names
$name = noNSorNS($ID);
if (useHeading('navigation')) {
// get page title
$title = p_get_first_heading($ID, METADATA_RENDER_USING_SIMPLE_CACHE);
if ($title) {
$name = $title;
}
}
//remove ID from array
if (isset($crumbs[$ID])) {
unset($crumbs[$ID]);
}
//add to array
$crumbs[$ID] = $name;
//reduce size
while (count($crumbs) > $conf['breadcrumbs']) {
array_shift($crumbs);
}
//save to session
$_SESSION[DOKU_COOKIE]['bc'] = $crumbs;
return $crumbs;
}
/**
* Filter for page IDs
*
* This is run on a ID before it is outputted somewhere
* currently used to replace the colon with something else
* on Windows (non-IIS) systems and to have proper URL encoding
*
* See discussions at https://github.com/dokuwiki/dokuwiki/pull/84 and
* https://github.com/dokuwiki/dokuwiki/pull/173 why we use a whitelist of
* unaffected servers instead of blacklisting affected servers here.
*
* Urlencoding is ommitted when the second parameter is false
*
* @param string $id pageid being filtered
* @param bool $ue apply urlencoding?
* @return string
* @author Andreas Gohr <andi@splitbrain.org>
*
*/
function idfilter($id, $ue = true)
{
global $conf;
/* @var Input $INPUT */
global $INPUT;
$id = (string)$id;
if ($conf['useslash'] && $conf['userewrite']) {
$id = strtr($id, ':', '/');
} elseif (
str_starts_with(strtoupper(PHP_OS), 'WIN') &&
$conf['userewrite'] &&
strpos($INPUT->server->str('SERVER_SOFTWARE'), 'Microsoft-IIS') === false
) {
$id = strtr($id, ':', ';');
}
if ($ue) {
$id = rawurlencode($id);
$id = str_replace('%3A', ':', $id); //keep as colon
$id = str_replace('%3B', ';', $id); //keep as semicolon
$id = str_replace('%2F', '/', $id); //keep as slash
}
return $id;
}
/**
* This builds a link to a wikipage
*
* It handles URL rewriting and adds additional parameters
*
* @param string $id page id, defaults to start page
* @param string|array $urlParameters URL parameters, associative array recommended
* @param bool $absolute request an absolute URL instead of relative
* @param string $separator parameter separator
* @return string
* @author Andreas Gohr <andi@splitbrain.org>
*
*/
function wl($id = '', $urlParameters = '', $absolute = false, $separator = '&')
{
global $conf;
if (is_array($urlParameters)) {
if (isset($urlParameters['rev']) && !$urlParameters['rev']) unset($urlParameters['rev']);
if (isset($urlParameters['at']) && $conf['date_at_format']) {
$urlParameters['at'] = date($conf['date_at_format'], $urlParameters['at']);
}
$urlParameters = buildURLparams($urlParameters, $separator);
} else {
$urlParameters = str_replace(',', $separator, $urlParameters);
}
if ($id === '') {
$id = $conf['start'];
}
$id = idfilter($id);
if ($absolute) {
$xlink = DOKU_URL;
} else {
$xlink = DOKU_BASE;
}
if ($conf['userewrite'] == 2) {
$xlink .= DOKU_SCRIPT . '/' . $id;
if ($urlParameters) $xlink .= '?' . $urlParameters;
} elseif ($conf['userewrite']) {
$xlink .= $id;
if ($urlParameters) $xlink .= '?' . $urlParameters;
} elseif ($id !== '') {
$xlink .= DOKU_SCRIPT . '?id=' . $id;
if ($urlParameters) $xlink .= $separator . $urlParameters;
} else {
$xlink .= DOKU_SCRIPT;
if ($urlParameters) $xlink .= '?' . $urlParameters;
}
return $xlink;
}
/**
* This builds a link to an alternate page format
*
* Handles URL rewriting if enabled. Follows the style of wl().
*
* @param string $id page id, defaults to start page
* @param string $format the export renderer to use
* @param string|array $urlParameters URL parameters, associative array recommended
* @param bool $abs request an absolute URL instead of relative
* @param string $sep parameter separator
* @return string
* @author Ben Coburn <btcoburn@silicodon.net>
*/
function exportlink($id = '', $format = 'raw', $urlParameters = '', $abs = false, $sep = '&')
{
global $conf;
if (is_array($urlParameters)) {
$urlParameters = buildURLparams($urlParameters, $sep);
} else {
$urlParameters = str_replace(',', $sep, $urlParameters);
}
$format = rawurlencode($format);
$id = idfilter($id);
if ($abs) {
$xlink = DOKU_URL;
} else {
$xlink = DOKU_BASE;
}
if ($conf['userewrite'] == 2) {
$xlink .= DOKU_SCRIPT . '/' . $id . '?do=export_' . $format;
if ($urlParameters) $xlink .= $sep . $urlParameters;
} elseif ($conf['userewrite'] == 1) {
$xlink .= '_export/' . $format . '/' . $id;
if ($urlParameters) $xlink .= '?' . $urlParameters;
} else {
$xlink .= DOKU_SCRIPT . '?do=export_' . $format . $sep . 'id=' . $id;
if ($urlParameters) $xlink .= $sep . $urlParameters;
}
return $xlink;
}
/**
* Build a link to a media file
*
* Will return a link to the detail page if $direct is false
*
* The $more parameter should always be given as array, the function then
* will strip default parameters to produce even cleaner URLs
*
* @param string $id the media file id or URL
* @param mixed $more string or array with additional parameters
* @param bool $direct link to detail page if false
* @param string $sep URL parameter separator
* @param bool $abs Create an absolute URL
* @return string
*/
function ml($id = '', $more = '', $direct = true, $sep = '&', $abs = false)
{
global $conf;
$isexternalimage = media_isexternal($id);
if (!$isexternalimage) {
$id = cleanID($id);
}
if (is_array($more)) {
// add token for resized images
$w = $more['w'] ?? null;
$h = $more['h'] ?? null;
if ($w || $h || $isexternalimage) {
$more['tok'] = media_get_token($id, $w, $h);
}
// strip defaults for shorter URLs
if (isset($more['cache']) && $more['cache'] == 'cache') unset($more['cache']);
if (empty($more['w'])) unset($more['w']);
if (empty($more['h'])) unset($more['h']);
if (isset($more['id']) && $direct) unset($more['id']);
if (isset($more['rev']) && !$more['rev']) unset($more['rev']);
$more = buildURLparams($more, $sep);
} else {
$matches = [];
if (preg_match_all('/\b(w|h)=(\d*)\b/', $more, $matches, PREG_SET_ORDER) || $isexternalimage) {
$resize = ['w' => 0, 'h' => 0];
foreach ($matches as $match) {
$resize[$match[1]] = $match[2];
}
$more .= $more === '' ? '' : $sep;
$more .= 'tok=' . media_get_token($id, $resize['w'], $resize['h']);
}
$more = str_replace('cache=cache', '', $more); //skip default
$more = str_replace(',,', ',', $more);
$more = str_replace(',', $sep, $more);
}
if ($abs) {
$xlink = DOKU_URL;
} else {
$xlink = DOKU_BASE;
}
// external URLs are always direct without rewriting
if ($isexternalimage) {
$xlink .= 'lib/exe/fetch.php';
$xlink .= '?' . $more;
$xlink .= $sep . 'media=' . rawurlencode($id);
return $xlink;
}
$id = idfilter($id);
// decide on scriptname
if ($direct) {
if ($conf['userewrite'] == 1) {
$script = '_media';
} else {
$script = 'lib/exe/fetch.php';
}
} elseif ($conf['userewrite'] == 1) {
$script = '_detail';
} else {
$script = 'lib/exe/detail.php';
}
// build URL based on rewrite mode
if ($conf['userewrite']) {
$xlink .= $script . '/' . $id;
if ($more) $xlink .= '?' . $more;
} elseif ($more) {
$xlink .= $script . '?' . $more;
$xlink .= $sep . 'media=' . $id;
} else {
$xlink .= $script . '?media=' . $id;
}
return $xlink;
}
/**
* Returns the URL to the DokuWiki base script
*
* Consider using wl() instead, unless you absoutely need the doku.php endpoint
*
* @return string
* @author Andreas Gohr <andi@splitbrain.org>
*
*/
function script()
{
return DOKU_BASE . DOKU_SCRIPT;
}
/**
* Spamcheck against wordlist
*
* Checks the wikitext against a list of blocked expressions
* returns true if the text contains any bad words
*
* Triggers COMMON_WORDBLOCK_BLOCKED
*
* Action Plugins can use this event to inspect the blocked data
* and gain information about the user who was blocked.
*
* Event data:
* data['matches'] - array of matches
* data['userinfo'] - information about the blocked user
* [ip] - ip address
* [user] - username (if logged in)
* [mail] - mail address (if logged in)
* [name] - real name (if logged in)
*
* @param string $text - optional text to check, if not given the globals are used
* @return bool - true if a spam word was found
* @author Andreas Gohr <andi@splitbrain.org>
* @author Michael Klier <chi@chimeric.de>
*
*/
function checkwordblock($text = '')
{
global $TEXT;
global $PRE;
global $SUF;
global $SUM;
global $conf;
global $INFO;
/* @var Input $INPUT */
global $INPUT;
if (!$conf['usewordblock']) return false;
if (!$text) $text = "$PRE $TEXT $SUF $SUM";
// we prepare the text a tiny bit to prevent spammers circumventing URL checks
// phpcs:disable Generic.Files.LineLength.TooLong
$text = preg_replace(
'!(\b)(www\.[\w.:?\-;,]+?\.[\w.:?\-;,]+?[\w/\#~:.?+=&%@\!\-.:?\-;,]+?)([.:?\-;,]*[^\w/\#~:.?+=&%@\!\-.:?\-;,])!i',
'\1http://\2 \2\3',
$text
);
// phpcs:enable
$wordblocks = getWordblocks();
// read file in chunks of 200 - this should work around the
// MAX_PATTERN_SIZE in modern PCRE
$chunksize = 200;
while ($blocks = array_splice($wordblocks, 0, $chunksize)) {
$re = [];
// build regexp from blocks
foreach ($blocks as $block) {
$block = preg_replace('/#.*$/', '', $block);
$block = trim($block);
if (empty($block)) continue;
$re[] = $block;
}
if (count($re) && preg_match('#(' . implode('|', $re) . ')#si', $text, $matches)) {
// prepare event data
$data = [];
$data['matches'] = $matches;
$data['userinfo']['ip'] = $INPUT->server->str('REMOTE_ADDR');
if ($INPUT->server->str('REMOTE_USER')) {
$data['userinfo']['user'] = $INPUT->server->str('REMOTE_USER');
$data['userinfo']['name'] = $INFO['userinfo']['name'];
$data['userinfo']['mail'] = $INFO['userinfo']['mail'];
}
$callback = static fn() => true;
return Event::createAndTrigger('COMMON_WORDBLOCK_BLOCKED', $data, $callback, true);
}
}
return false;
}
/**
* Return the IP of the client.
*
* The IP is sourced from, in order of preference:
*
* - The X-Real-IP header if $conf[realip] is true.
* - The X-Forwarded-For header if all the proxies are trusted by $conf[trustedproxies].
* - The TCP/IP connection remote address.
* - 0.0.0.0 if all else fails.
*
* The 'realip' config value should only be set to true if the X-Real-IP header
* is being added by the web server, otherwise it may be spoofed by the client.
*
* The 'trustedproxies' setting must not allow any IP, otherwise the X-Forwarded-For
* may be spoofed by the client.
*
* @param bool $single If set only a single IP is returned.
*
* @return string Returns an IP address if 'single' is true, or a comma-separated list
* of IP addresses otherwise.
* @author Zebra North <mrzebra@mrzebra.co.uk>
*
*/
function clientIP($single = false)
{
// Return the first IP in single mode, or all the IPs.
return $single ? Ip::clientIp() : implode(',', Ip::clientIps());
}
/**
* Check if the browser is on a mobile device
*
* Adapted from the example code at url below
*
* @link http://www.brainhandles.com/2007/10/15/detecting-mobile-browsers/#code
*
* @deprecated 2018-04-27 you probably want media queries instead anyway
* @return bool if true, client is mobile browser; otherwise false
*/
function clientismobile()
{
/* @var Input $INPUT */
global $INPUT;
if ($INPUT->server->has('HTTP_X_WAP_PROFILE')) return true;
if (preg_match('/wap\.|\.wap/i', $INPUT->server->str('HTTP_ACCEPT'))) return true;
if (!$INPUT->server->has('HTTP_USER_AGENT')) return false;
$uamatches = implode(
'|',
[
'midp', 'j2me', 'avantg', 'docomo', 'novarra', 'palmos', 'palmsource', '240x320', 'opwv',
'chtml', 'pda', 'windows ce', 'mmp\/', 'blackberry', 'mib\/', 'symbian', 'wireless', 'nokia',
'hand', 'mobi', 'phone', 'cdm', 'up\.b', 'audio', 'SIE\-', 'SEC\-', 'samsung', 'HTC', 'mot\-',
'mitsu', 'sagem', 'sony', 'alcatel', 'lg', 'erics', 'vx', 'NEC', 'philips', 'mmm', 'xx',
'panasonic', 'sharp', 'wap', 'sch', 'rover', 'pocket', 'benq', 'java', 'pt', 'pg', 'vox',
'amoi', 'bird', 'compal', 'kg', 'voda', 'sany', 'kdd', 'dbt', 'sendo', 'sgh', 'gradi', 'jb',
'\d\d\di', 'moto'
]
);
if (preg_match("/$uamatches/i", $INPUT->server->str('HTTP_USER_AGENT'))) return true;
return false;
}
/**
* check if a given link is interwiki link
*
* @param string $link the link, e.g. "wiki>page"
* @return bool
*/
function link_isinterwiki($link)
{
if (preg_match('/^[a-zA-Z0-9\.]+>/u', $link)) return true;
return false;
}
/**
* Convert one or more comma separated IPs to hostnames
*
* If $conf['dnslookups'] is disabled it simply returns the input string
*
* @param string $ips comma separated list of IP addresses
* @return string a comma separated list of hostnames
* @author Glen Harris <astfgl@iamnota.org>
*
*/
function gethostsbyaddrs($ips)
{
global $conf;
if (!$conf['dnslookups']) return $ips;
$hosts = [];
$ips = explode(',', $ips);
if (is_array($ips)) {
foreach ($ips as $ip) {
$hosts[] = gethostbyaddr(trim($ip));
}
return implode(',', $hosts);
} else {
return gethostbyaddr(trim($ips));
}
}
/**
* Checks if a given page is currently locked.
*
* removes stale lockfiles
*
* @param string $id page id
* @return bool page is locked?
* @author Andreas Gohr <andi@splitbrain.org>
*
*/
function checklock($id)
{
global $conf;
/* @var Input $INPUT */
global $INPUT;
$lock = wikiLockFN($id);
//no lockfile
if (!file_exists($lock)) return false;
//lockfile expired
if ((time() - filemtime($lock)) > $conf['locktime']) {
@unlink($lock);
return false;
}
//my own lock
[$ip, $session] = sexplode("\n", io_readFile($lock), 2);
if ($ip == $INPUT->server->str('REMOTE_USER') || (session_id() && $session === session_id())) {
return false;
}
return $ip;
}
/**
* Lock a page for editing
*
* @param string $id page id to lock
* @author Andreas Gohr <andi@splitbrain.org>
*
*/
function lock($id)
{
global $conf;
/* @var Input $INPUT */
global $INPUT;
if ($conf['locktime'] == 0) {
return;
}
$lock = wikiLockFN($id);
if ($INPUT->server->str('REMOTE_USER')) {
io_saveFile($lock, $INPUT->server->str('REMOTE_USER'));
} else {
io_saveFile($lock, clientIP() . "\n" . session_id());
}
}
/**
* Unlock a page if it was locked by the user
*
* @param string $id page id to unlock
* @return bool true if a lock was removed
* @author Andreas Gohr <andi@splitbrain.org>
*
*/
function unlock($id)
{
/* @var Input $INPUT */
global $INPUT;
$lock = wikiLockFN($id);
if (file_exists($lock)) {
@[$ip, $session] = explode("\n", io_readFile($lock));
if ($ip == $INPUT->server->str('REMOTE_USER') || $session == session_id()) {
@unlink($lock);
return true;
}
}
return false;
}
/**
* convert line ending to unix format
*
* also makes sure the given text is valid UTF-8
*
* @param string $text
* @return string
* @see formText() for 2crlf conversion
* @author Andreas Gohr <andi@splitbrain.org>
*
*/
function cleanText($text)
{
$text = preg_replace("/(\015\012)|(\015)/", "\012", $text);
// if the text is not valid UTF-8 we simply assume latin1
// this won't break any worse than it breaks with the wrong encoding
// but might actually fix the problem in many cases
if (!Clean::isUtf8($text)) $text = Conversion::fromLatin1($text);
return $text;
}
/**
* Prepares text for print in Webforms by encoding special chars.
* It also converts line endings to Windows format which is
* pseudo standard for webforms.
*
* @param string $text
* @return string
* @see cleanText() for 2unix conversion
* @author Andreas Gohr <andi@splitbrain.org>
*
*/
function formText($text)