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
|
<?php
/**
* webtrees: online genealogy
* Copyright (C) 2026 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 <https://www.gnu.org/licenses/>.
*/
declare(strict_types=1);
namespace Fisharebest\Webtrees\Factories;
use Fisharebest\Webtrees\CommonMark\CensusTableExtension;
use Fisharebest\Webtrees\CommonMark\XrefExtension;
use Fisharebest\Webtrees\Contracts\MarkdownFactoryInterface;
use Fisharebest\Webtrees\Tree;
use League\CommonMark\Environment\Environment;
use League\CommonMark\Extension\Autolink\AutolinkExtension;
use League\CommonMark\Extension\CommonMark\CommonMarkCoreExtension;
use League\CommonMark\Extension\CommonMark\Node\Inline\Link;
use League\CommonMark\Extension\CommonMark\Renderer\Inline\LinkRenderer;
use League\CommonMark\Extension\Table\TableExtension;
use League\CommonMark\MarkdownConverter;
use League\CommonMark\Node\Block\Document;
use League\CommonMark\Node\Block\Paragraph;
use League\CommonMark\Node\Inline\Newline;
use League\CommonMark\Node\Inline\Text;
use League\CommonMark\Parser\Inline\NewlineParser;
use League\CommonMark\Renderer\Block\DocumentRenderer;
use League\CommonMark\Renderer\Block\ParagraphRenderer;
use League\CommonMark\Renderer\Inline\NewlineRenderer;
use League\CommonMark\Renderer\Inline\TextRenderer;
use League\CommonMark\Util\HtmlFilter;
use function strip_tags;
use function strtr;
/**
* Create a markdown converter.
*/
class MarkdownFactory implements MarkdownFactoryInterface
{
// Commonmark uses the self-closing form of this tag, so we do the same for consistency.
public const string BREAK = '<br />';
protected const array CONFIG_AUTOLINK = [
'allow_unsafe_links' => false,
'html_input' => HtmlFilter::ESCAPE,
'renderer' => [
'soft_break' => self::BREAK,
],
];
protected const array CONFIG_MARKDOWN = [
'allow_unsafe_links' => false,
'html_input' => HtmlFilter::ESCAPE,
'renderer' => [
'soft_break' => self::BREAK,
],
'table' => [
'wrap' => [
'enabled' => true,
'tag' => 'div',
'attributes' => [
'class' => 'table-responsive',
],
],
],
];
/**
* @param string $markdown
* @param Tree|null $tree
*
* @return string
*/
public function autolink(string $markdown, Tree|null $tree = null): string
{
// Create a minimal commonmark processor - just add support for auto-links.
$environment = new Environment(static::CONFIG_AUTOLINK);
$environment->addInlineParser(new NewlineParser());
$environment->addRenderer(Document::class, new DocumentRenderer());
$environment->addRenderer(Paragraph::class, new ParagraphRenderer());
$environment->addRenderer(Text::class, new TextRenderer());
$environment->addRenderer(Link::class, new LinkRenderer());
$environment->addRenderer(Newline::class, new NewlineRenderer());
$environment->addExtension(new AutolinkExtension());
// Optionally create links to other records.
if ($tree instanceof Tree) {
$environment->addExtension(new XrefExtension($tree));
}
$converter = new MarkDownConverter($environment);
$html = $converter->convert($markdown)->getContent();
// We should only have certain tags. Make sure of this.
$html = strip_tags($html, ['a', 'br', 'p']);
// The markdown convert adds newlines, but not in a documented way. Safest to ignore them.
return strtr($html, ["\n" => '']);
}
/**
* @param string $markdown
* @param Tree|null $tree
*
* @return string
*/
public function markdown(string $markdown, Tree|null $tree = null): string
{
$environment = new Environment(static::CONFIG_MARKDOWN);
$environment->addExtension(new CommonMarkCoreExtension());
$environment->addExtension(new TableExtension());
// Convert webtrees 1.x style census tables to commonmark format.
$environment->addExtension(new CensusTableExtension());
// Optionally create links to other records.
if ($tree instanceof Tree) {
$environment->addExtension(new XrefExtension($tree));
}
$converter = new MarkDownConverter($environment);
$html = $converter->convert($markdown)->getContent();
// The markdown convert adds newlines, but not in a documented way. Safest to ignore them.
return strtr($html, ["\n" => '']);
}
}
|
