-
Notifications
You must be signed in to change notification settings - Fork 7
/
help.php
509 lines (451 loc) · 20 KB
/
help.php
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
<?php
/**
* HELP.PHP für REDAXO-Addons
*
* @author Christoph Böcker <https://github.com/christophboecker>
* @version 2.4
* @copyright Christoph Böcker <https://github.com/christophboecker>
* @license MIT
* @see https://github.com/christophboecker/help.php Repository on Github
* @see https://github.com/christophboecker/help.php/blob/master/manual.md Manual/Documentation
*
* für REDAXO ab V5.10
*
* @var rex_addon $this
*/
/*
2.1: wirft _pjax aus dem Request; klemmt sonst womöglich
2.1: Zweistufige Menüs
2.1: Menüstrukturen (help:) optional in eigener help.yml statt package.yml
*/
if( !class_exists('help_documentation') )
{
class help_documentation {
/** @var array<mixed> */
public $navigation = [];
/** @var string */
public $initialPage = '';
/** @var string */
public $activePage = '';
/** @var string */
public $dir = '';
/** @var integer */
public $dirLen = 0;
/** @var string */
public $filename = '';
/** @var string */
public $filetype = '';
/** @var string */
public $targetfile = '';
/** @var rex_addon|null */
public $context = null;
/** @var array<mixed> */
public $prohibited = [];
// $filename ist der Name der anzuzeigenden Datei im $dir. Sofern es keine anderen Angaben
// gibt, wird die README.md des Addons angezeigt.
// Der Name kann Pfadanteile aufweisen (docs/xyz.md, ../xyz.md)
// $navigation Array mit Angaben zum Aufbau einer Sub-Navigation innerhalb der Seite.
//
// README.md ist die Fallback-Datei, die angezeigt wird wenn keine andere Datei benannt ist.
//
// Alternativ wird der Dateiname aus der Package.yml entnommen. Zum zugehörigen Regelwerk siehe oben.
// Hier sind dann auch die Angaben zur $navigation zu finden.
//
// Oberste Priorität ist die Angabe in der URL (...&doc=...)
/**
* @param rex_addon $addon
* @return void
*/
function __construct( \rex_addon $addon )
{
$this->context = $addon;
$user = rex::getUser();
// Im weiteren Verlauf wird immer wieder das aktuelle Verzeichnis (Root des Addons) benötigt
$this->dir = $addon->getPath();
$this->dirLen = strlen( $this->dir );
$navigation = rex_file::getConfig( $addon->getPath('help.yml'), [] );
if( $navigation ):
array_walk_recursive($navigation, function(&$a,$b){
if( 'translate:'==substr($a,0,10) ) $a = rex_i18n::translate($a);
});
else:
$navigation = $addon->getProperty('help',[]);
endif;
$this->navigation = $navigation[\rex_be_controller::getCurrentPage()] ?? $navigation['default'] ?? [];
// Berechtigungen prüfen und rauswerfen, was nicht berechtigt ist
// Aus der Navigation das Array 'permissions' extrahieren
$permissions = $this->navigation['permissions'] ?? [];
if( $permissions ) {
// aus der Navigation entfernen
unset( $this->navigation['permissions'] );
foreach( $permissions as $k=>$v ) {
foreach( (array) $v as $perm ) {
if( $perm && !$user->hasPerm($perm) ) {
$this->prohibited[] = $k;
}
}
}
}
foreach( $this->navigation as $k1=>$v1 ) {
$permission = $v1['perm'] ?? '';
if( $permission && !$user->hasPerm($permission) ) {
$this->prohibited[] = $v1['path'];
unset( $this->navigation[$k1] );
}
foreach( ($v1['subnav'] ?? []) as $k2=>$v2 ) {
$subPermission = $v2['perm'] ?? $permission;
if( $subPermission && !$user->hasPerm($subPermission) ) {
$this->prohibited[] = $v2['path'];
unset( $this->navigation[$k1][$k2] );
}
}
}
$this->prohibited = array_unique( $this->prohibited );
if( isset($this->navigation['initial']) && $this->navigation['initial'] ){
$this->initialPage = $this->navigation['initial'];
unset( $this->navigation['initial'] );
}
foreach( $this->navigation as $k=>$v ) {
if( isset($v['path']) ):
if( !$this->activePage ) $this->activePage = $v['path'];
if( isset($v['active']) && true===$v['active'] ):
$this->activePage = $v['path'];
break;
endif;
endif;
}
$this->filename = \rex_request( 'doc','string',$this->initialPage ?: $this->activePage ?: 'README.md' );
// Wenn das replace auf einen Fehler läuft, stimt wohl etwas Grundlegendws nicht. Abschalten.
$this->filename = mb_ereg_replace('\\\\|/', DIRECTORY_SEPARATOR, $this->filename, 'msr') ?: '';
$this->filetype = pathinfo( $this->filename,PATHINFO_EXTENSION );
$this->targetfile = $this->getDocumentName( );
}
// Der $file_name kann auch Pfadanteile enthalten. Auch "../"-Elemente sind zulässig.
// Mit bösartigen URLS kann der REDAXO-Instanz eine Abfrage untegeschoben werden, die darüber
// Zugang zu Dateien erlangen, die nicht extern sichtbar sein sollen bzw. dürfen.
//
// Daher werden die Pfade normiert und geprüft (realpath(..))
// Zulässig sind am Ende nur ausgewählte Pfade, die innerhalb des Addon liegen.
// «addon_root»/README.md
// «addon_root»/LICENSE.md
// «addon_root»/CHANGELOG.md
// «addon_root»/CREDITS.md
// «addon_root»/docs/*
//
// Als Nebeneffekt wird geprüft, ob die Datei überhaupt exisitert bzw. ob sie in einer
// Sprachversion existiert (pfad/dateiname.lang.suffix), die statt des Originalnamens genutzt wird.
/** @return boolean|string */
/**
* @return string
*/
function getDocumentName( )
{
// Zerlege den Pfadnamen in path, name, lang und suffix.
// lang ist optional. Ohne suffix => NO_GO
$filepath = $this->dir . $this->filename;
$pattern = '/^(?<path>(.*?\/)*)(?<name>.*?)(?<lang>\.[a-zA-Z]{2})?(?<suffix>\.\w+)$/';
if( !preg_match( $pattern, $filepath, $pathinfo ) ) {
return '';
}
$pathinfo = array_filter( $pathinfo, 'is_string', ARRAY_FILTER_USE_KEY );
// Suche zunächst die Datei mit dem aktuellen Sprachcode
$pathinfo['lang'] = '.' . \rex_i18n::getLanguage();
$real_path = realpath( implode('',$pathinfo) );
if( !$real_path)
{
// Pfad normieren, Suche nach normaler Datei
$pathinfo['lang'] = '';
$real_path = realpath( implode('',$pathinfo) );
}
if( $real_path )
{
$real_dir = substr($real_path,0,$this->dirLen);
if( 0 == strcasecmp($this->dir,$real_dir) )
{
$filename = substr($real_path,$this->dirLen);
$xxx = in_array( $filename,$this->prohibited );
if( ( 0 == strcasecmp(substr($filename,0,5),'docs'.DIRECTORY_SEPARATOR)
|| 0 == strcasecmp($filename,'readme.md')
|| 0 == strcasecmp($filename,'changelog.md')
|| 0 == strcasecmp($filename,'credits.md')
|| 0 == strcasecmp($filename,'license.md') )
&& !in_array( $filename,$this->prohibited ) )
{
return $filename;
}
}
}
return '';
}
/** @return string */
function getFilePath()
{
return $this->targetfile ? $this->dir . $this->targetfile : '';
}
/** @return boolean */
function isAsset( )
{
return 'md' !== $this->filetype;
}
// Nicht-Markdown-Dateien (meist Bilder), werden direkt ausgegeben.
// Danach abbrechen.
// Non-Images als Download-Anhang senden
/** @return void */
function sendAsset( ): void
{
\rex_response::cleanOutputBuffers();
if ( ($path = $this->getFilePath()) && \rex_media::isDocType($this->filetype) ) {
$mime = \rex_file::mimeType( $path );
if( 'image/' === substr($mime,0,6) ) {
\rex_response::sendFile( $path, $mime );
} else {
\rex_response::sendFile( $path, $mime, 'attachment', basename($path) );
}
} else {
header( 'HTTP/1.1 Not Found' );
}
exit();
}
// Entferne ein für die Github-Ansicht eingebautes Menü, das hier der $navigation entspricht
// Das sind alle Zeilen ab Zeile 1, die mit "> - " beginnen sowie die abschließende Leerzeile
/**
* @param string $text
* @return string
*/
function stripGithubNavigation( string $text ): string
{
return preg_replace( '/^(\>\s+\-\s?.*?\\n)*\s*\\n/', '', $text );
}
// Im Text werden alle Links, die nicht Datei-intern (#...) und nicht URIs (z.B. http://...)
// sind, werden so umgebaut, dass sie durch diese Seite geschleust werden.
// Der Link ist die URL der aktuellen Seite mit dem zusätzlichen Parameter '&doc=originallink'
// per EP kann der Link noch einmal umgearbeitet werden.
// Datei die Code-Blöcke auslassen
/**
* @param string $text
* @return string
*/
function replaceLinks( string $text ): string
{
$request = $_REQUEST;
$request['doc'] = dirname($this->targetfile);
# Code-Blöcke identifizieren und herauslösen, damit keine darin enthaltenen Links geändert werden.
$original = [];
$text = preg_replace_callback( '/(```.*?```|`.*?`)/s', function( $matches) use(&$original){
$marker = '<!--' . md5($matches[0]) . '-->';
$original["/$marker/"] = $matches[0];
return $marker;
}, $text );
# Links umbauen; nur Markdown! [label](link) bzw. 
$text = preg_replace_callback (
'/((!?)\[(.*?)\]\()\s*(.*?)\s*(\))/',
function( $matches ) use( $request )
{
$link = $matches[4];
// leere Links ignorieren
// Dokument-interne Referenzen (#) ignorieren
// REDAXO-Interne Aufrufe (?...) ignorieren
// Dokumente mit kompletter URL ignorieren (irgendwas://sonstnochwas)
if( !$link
|| '#' == substr($link,0,1)
|| '?' == substr($link,0,1)
|| preg_match( '/^.*?\:\/\/.*?$/',$link)
|| ('' === ($href = help_documentation::getLink( $request, $link, $docfile ))) )
{
$term = $matches[0];
$href = $link;
}
// alle anderen Varianten umbauen
else
{
// gesperrte Seite => ohne Link
if( in_array($docfile,$this->prohibited) ) {
$term = $matches[3];
} else {
$term = $matches[1] . $href . $matches[5];
}
}
return \rex_extension::registerPoint(new \rex_extension_point(
'HELP_HREF',
$term,
['source'=>$matches[0],'label'=>$matches[3],'link'=>$matches[4],'href'=>$href,'isImageLink'=>($matches[2]>''),'context'=>$this->context]
));
},
$text );
# Code-Blöcke wieder einfügen
if( $original ) {
$text = preg_replace( array_keys($original), $original, $text );
}
return $text;
}
/**
* @param array<mixed> $request Entspricht $_REQUEST
* @param string $link URL, die bearbeitet wird
* @param string $docfile
* @return string Aus dem Link ermittelte neue, BE-bazogene URL
*/
static function getLink( $request, $link, &$docfile=null )
{
$url = '';
if( preg_match('/^(?<link>.*?)(#(?<hook>.*?))?$$/',$link,$linkinfo) ){
if( $linkinfo['link'] ?? '' ) $request['doc'] .= DIRECTORY_SEPARATOR . $linkinfo['link'];
if( isset($request['_pjax']) ) unset($request['_pjax']);
$url = \rex_url::currentBackendPage( $request,false );
if( $linkinfo['hook'] ?? '' ) $url .= '#' . $linkinfo['hook'];
$docfile = $request['doc'];
}
return $url;
}
// Falls angefordert wird ein Tab-Menü mit den Hauptseiten eines Hilfe-Systems gebaut.
// Es wird nicht beim einzelnen Aufruf geprüft, ob es sinnvolle Referenzen im $navigation-Array
// gibt. Das muss der Entwickler sicherstellen.
// Der Link ist die URL der aktuellen Seite mit dem zusätzlichen Paramater 'doc=seitenlink'
/**
* @param array<mixed> $navigation
* @param array<mixed> $request
* @return array<mixed>
*/
function getNavArray( array $navigation, array $request ) : array
{
$tabs = [];
foreach( $navigation as $nav )
{
$href = $nav['href'] ?? '' ?: '';
if( isset($nav['path']) && $nav['path'] ){
$request['doc'] = $nav['path'] ?? '' ?: '';
$href = \rex_url::currentBackendPage( $request,false );
}
if( $href ) {
$active = $this->filename == ($nav['path'] ?? '' ?: '');
$tab = [
'linkClasses' => [],
'itemClasses' => [],
'linkAttr' => [],
'itemAttr' => [],
'href' => $href,
'title' => $nav['title'] ?? '' ?: '',
'icon' => $nav['icon'] ?? false ?: false
];
$active = false;
if( is_array($nav['subnav']??null) ) {
$subnav = $this->getNavArray( $nav['subnav'], $request );
$active = array_reduce( $subnav, function($c,$v){return $c || $v['active'];}, false );
if( $active ) {
$tab['children'] = $subnav;
}
}
$tab['active'] = $active || ($this->filename == ($nav['path'] ?? '' ?: ''));
$tabs[] = $tab;
}
}
return $tabs;
}
/**
* @param array<mixed> $navigation
* @param array<mixed> $request
* @return array<mixed>
*/
function getNavigationStructure( array $navigation, array $request ) : array
{
$tabs = [];
$active = false;
foreach( $navigation as $nav )
{
$href = $nav['href'] ?? '' ?: '';
if( isset($nav['path']) && $nav['path'] ){
$request['doc'] = $nav['path'] ?? '' ?: '';
$href = \rex_url::currentBackendPage( $request,false );
}
if( $href ) {
$tab = [
'linkClasses' => [],
'itemClasses' => [],
'linkAttr' => [],
'itemAttr' => [],
'href' => $href,
'title' => $nav['title'] ?? '' ?: '',
'active' => $this->filename == ($nav['path'] ?? '' ?: ''),
'icon' => $nav['icon'] ?? false ?: false
];
if( is_array($nav['subnav']??null) ) {
$subnav = $this->getNavigationStructure( $nav['subnav'], $request );
if( $subnav ) {
$tab['children'] = $subnav;
$tab['active'] = true;
}
}
$tabs[] = $tab;
$active = $active || $tab['active'];
}
}
return $active ? $tabs : [];
}
function getNavigation( ) : string
{
$tabs = \rex_extension::registerPoint(new \rex_extension_point(
'HELP_NAVIGATION',
$this->getNavArray( $this->navigation, $_REQUEST ),
['profile'=>$this->navigation,'context'=>$this->context]
));
if( $tabs )
{
$fragment = new \rex_fragment();
$fragment->setVar('left', $tabs, false);
return $fragment->parse('core/navigations/content.php');
}
return '';
}
// Die Markdown-Datei wird in Inhaltsverzeichnis und Inhalt aufgedröselt
// beide stehen nebeneinander in zwei Spalten.
function getDocument( string $text ) : string
{
[$toc, $content] = \rex_markdown::factory()->parseWithToc( $text,2,3,false );
$fragment = new \rex_fragment();
$fragment->setVar('content', $content, false);
$fragment->setVar('toc', $toc, false);
return $fragment->parse('core/page/docs.php');
}
// Wenn es im Addon-Asset-Verzeichnis Ressourcen-Dateien gibt, werden sie geladen
// /assests/addons/myaddon/help.min.js bzw. /assests/addons/myaddon/help.min.css
function getJsCss( ): string
{
$HTML = '';
$path = $this->context->getAssetsPath('help.min.js');
if( file_exists($path) ){
$file = $this->context->getAssetsUrl('help.min.js');
$url = \rex_url::backendController(['asset' => $file, 'buster' => filemtime($path)]);
$HTML .= '<script type="text/javascript" src="' . $url .'"></script>';
}
$path = $this->context->getAssetsPath('help.min.css');
if( file_exists($path) ){
$file = $this->context->getAssetsUrl('help.min.css');
$url = \rex_url::backendController(['asset' => $file, 'buster' => filemtime($path)]);
$HTML .= '<link rel="stylesheet" type="text/css" media="all" href="' . $url .'" />';
}
return $HTML;
}
}
}
// Here we go ....
$publish = new help_documentation( $this );
if( $publish->isAsset() ) {
$publish->sendAsset();
}
if( '' === ($path = $publish->getFilePath()) ) {
$key = $this->getName() . '_helpphp_not_found';
if( !\rex_i18n::hasMsg($key) ) {
\rex_i18n::addMsg($key, '#Sorry, die angeforderte Seite existiert nicht oder ist gesperrt!');
}
$text = \rex_i18n::msg($key);
} else {
$text = \rex_file::get( $path );
$text = $publish->stripGithubNavigation( $text );
$text = $publish->replaceLinks( $text );
}
$text = $publish->getDocument( $text );
?>
<?=$publish->getJsCss()?>
<div class="help-documentation">
<?=$publish->getNavigation( )?>
<?=$text?>
</div>