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
|
<?php
/**
* webtrees: online genealogy
* Copyright (C) 2018 webtrees development team
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
namespace Fisharebest\Webtrees;
use Fisharebest\Webtrees\CommonMark\CensusTableExtension;
use Fisharebest\Webtrees\CommonMark\XrefExtension;
use League\CommonMark\Block\Renderer\DocumentRenderer;
use League\CommonMark\Block\Renderer\ParagraphRenderer;
use League\CommonMark\Converter;
use League\CommonMark\DocParser;
use League\CommonMark\Environment;
use League\CommonMark\HtmlRenderer;
use League\CommonMark\Inline\Parser\AutolinkParser;
use League\CommonMark\Inline\Renderer\LinkRenderer;
use League\CommonMark\Inline\Renderer\TextRenderer;
use Throwable;
use Webuni\CommonMark\TableExtension\TableExtension;
/**
* Filter input and escape output.
*/
class Filter
{
// REGEX to match a URL
// Some versions of RFC3987 have an appendix B which gives the following regex
// (([^:/?#]+):)?(//([^/?#]*))?([^?#]*)(\?([^#]*))?(#(.*))?
// This matches far too much while a “precise” regex is several pages long.
// This is a compromise.
const URL_REGEX = '((https?|ftp]):)(//([^\s/?#<>]*))?([^\s?#<>]*)(\?([^\s#<>]*))?(#[^\s?#<>]+)?';
/**
* Format block-level text such as notes or transcripts, etc.
*
* @param string $text
* @param Tree $tree
*
* @return string
*/
public static function formatText(string $text, Tree $tree): string
{
switch ($tree->getPreference('FORMAT_TEXT')) {
case 'markdown':
return '<div class="markdown" dir="auto">' . self::markdown($text, $tree) . '</div>';
default:
return '<div class="markdown" style="white-space: pre-wrap;" dir="auto">' . self::expandUrls($text, $tree) . '</div>';
}
}
/**
* Format a block of text, expanding URLs and XREFs.
*
* @param string $text
* @param Tree $tree
*
* @return string
*/
public static function expandUrls(string $text, Tree $tree): string
{
// If it looks like a URL, turn it into a markdown autolink.
$text = preg_replace('/' . addcslashes(self::URL_REGEX, '/') . '/', '<$0>', $text);
// Create a minimal commonmark processor - just add support for autolinks.
$environment = new Environment();
$environment->mergeConfig([
'renderer' => [
'block_separator' => "\n",
'inner_separator' => "\n",
'soft_break' => "\n",
],
'html_input' => Environment::HTML_INPUT_ESCAPE,
'allow_unsafe_links' => true,
]);
$environment
->addBlockRenderer(\League\CommonMark\Block\Element\Document::class, new DocumentRenderer())
->addBlockRenderer(\League\CommonMark\Block\Element\Paragraph::class, new ParagraphRenderer())
->addInlineRenderer(\League\CommonMark\Inline\Element\Text::class, new TextRenderer())
->addInlineRenderer(\League\CommonMark\Inline\Element\Link::class, new LinkRenderer())
->addInlineParser(new AutolinkParser());
$environment->addExtension(new CensusTableExtension());
$environment->addExtension(new XrefExtension($tree));
$converter = new Converter(new DocParser($environment), new HtmlRenderer($environment));
try {
return $converter->convertToHtml($text);
} catch (Throwable $ex) {
// See issue #1824
return $text;
}
}
/**
* Format a block of text, using "Markdown".
*
* @param string $text
* @param Tree $tree
*
* @return string
*/
public static function markdown(string $text, Tree $tree): string
{
$environment = Environment::createCommonMarkEnvironment();
$environment->mergeConfig(['html_input' => 'escape']);
$environment->addExtension(new TableExtension());
$environment->addExtension(new CensusTableExtension());
$environment->addExtension(new XrefExtension($tree));
$converter = new Converter(new DocParser($environment), new HtmlRenderer($environment));
try {
return $converter->convertToHtml($text);
} catch (Throwable $ex) {
// See issue #1824
return $text;
}
}
}
|
