-
-
Notifications
You must be signed in to change notification settings - Fork 829
/
Formatter.php
222 lines (178 loc) · 5.79 KB
/
Formatter.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
<?php
/*
* This file is part of Flarum.
*
* For detailed copyright and license information, please view the
* LICENSE file that was distributed with this source code.
*/
namespace Flarum\Formatter;
use Flarum\User\User;
use Illuminate\Contracts\Cache\Repository;
use Psr\Http\Message\ServerRequestInterface;
use s9e\TextFormatter\Configurator;
use s9e\TextFormatter\Parser;
use s9e\TextFormatter\Renderer;
use s9e\TextFormatter\Unparser;
use s9e\TextFormatter\Utils;
class Formatter
{
protected array $configurationCallbacks = [];
protected array $parsingCallbacks = [];
protected array $unparsingCallbacks = [];
protected array $renderingCallbacks = [];
public function __construct(
protected Repository $cache,
protected string $cacheDir
) {
}
/**
* @internal
*/
public function addConfigurationCallback(callable $callback): void
{
$this->configurationCallbacks[] = $callback;
}
/**
* @internal
*/
public function addParsingCallback(callable $callback): void
{
$this->parsingCallbacks[] = $callback;
}
/**
* @internal
*/
public function addUnparsingCallback(callable $callback): void
{
$this->unparsingCallbacks[] = $callback;
}
/**
* @internal
*/
public function addRenderingCallback(callable $callback): void
{
$this->renderingCallbacks[] = $callback;
}
public function parse(string $text, mixed $context = null, User $user = null): string
{
$parser = $this->getParser($context);
/*
* Can be injected in tag or attribute filters by calling:
* ->addParameterByName('actor') on the filter.
* See the mentions extension's ConfigureMentions.php for an example.
*/
$parser->registeredVars['actor'] = $user;
foreach ($this->parsingCallbacks as $callback) {
$text = $callback($parser, $context, $text, $user);
}
return $parser->parse($text);
}
public function render(string $xml, mixed $context = null, ServerRequestInterface $request = null): string
{
$renderer = $this->getRenderer();
foreach ($this->renderingCallbacks as $callback) {
$xml = $callback($renderer, $context, $xml, $request);
}
$xml = $this->configureDefaultsOnLinks($xml);
return $renderer->render($xml);
}
public function unparse(string $xml, mixed $context = null): string
{
foreach ($this->unparsingCallbacks as $callback) {
$xml = $callback($context, $xml);
}
return Unparser::unparse($xml);
}
/**
* Flush the cache so that the formatter components are regenerated.
*/
public function flush(): void
{
$this->cache->forget('flarum.formatter');
}
protected function getConfigurator(): Configurator
{
$configurator = new Configurator;
$configurator->rootRules->enableAutoLineBreaks();
$configurator->rendering->setEngine('PHP');
$configurator->rendering->getEngine()->cacheDir = $this->cacheDir; // @phpstan-ignore-line
$configurator->enableJavaScript();
$configurator->javascript->exports = ['preview'];
$configurator->javascript->setMinifier('MatthiasMullieMinify')
->keepGoing = true;
$configurator->Escaper; /** @phpstan-ignore-line */
$configurator->Autoemail; /** @phpstan-ignore-line */
$configurator->Autolink; /** @phpstan-ignore-line */
$configurator->tags->onDuplicate('replace');
foreach ($this->configurationCallbacks as $callback) {
$callback($configurator);
}
$this->configureExternalLinks($configurator);
return $configurator;
}
protected function configureExternalLinks(Configurator $configurator): void
{
/**
* @var Configurator\Items\TemplateDocument $dom
*/
$dom = $configurator->tags['URL']->template->asDOM();
foreach ($dom->getElementsByTagName('a') as $a) {
/** @var \s9e\SweetDOM\Element $a */
$a->prependXslCopyOf('@target');
$a->prependXslCopyOf('@rel');
}
$dom->saveChanges();
}
/**
* Get a TextFormatter component ("renderer" or "parser" or "js").
*/
protected function getComponent(string $name): mixed
{
$formatter = $this->cache->rememberForever('flarum.formatter', function () {
return $this->getConfigurator()->finalize();
});
return $formatter[$name];
}
protected function getParser(mixed $context = null): Parser
{
$parser = $this->getComponent('parser');
$parser->registeredVars['context'] = $context;
return $parser;
}
protected function getRenderer(): Renderer
{
spl_autoload_register(function ($class) {
if (file_exists($file = $this->cacheDir.'/'.$class.'.php')) {
include $file;
}
});
return $this->getComponent('renderer');
}
/**
* Get the formatter JavaScript.
*/
public function getJs(): string
{
return $this->getComponent('js');
}
protected function configureDefaultsOnLinks(string $xml): string
{
return Utils::replaceAttributes($xml, 'URL', function ($attributes) {
$attributes['rel'] ??= 'ugc nofollow';
return $attributes;
});
}
/**
* Converts a plain text string (with or without Markdown) to it's HTML equivalent.
*
* @param ?string $content
* @return string
*/
public function convert(?string $content): string
{
if (! $content) {
return '';
}
return $this->getRenderer()->render($this->getParser()->parse($content));
}
}