]>
Commit | Line | Data |
---|---|---|
1be4afac A |
1 | <?php |
2 | ||
3 | /** | |
4 | * Plugin Markdown. | |
5 | * | |
6 | * Shaare's descriptions are parsed with Markdown. | |
7 | */ | |
8 | ||
dd6794cf A |
9 | use Shaarli\Config\ConfigManager; |
10 | ||
3ce20d9e A |
11 | /* |
12 | * If this tag is used on a shaare, the description won't be processed by Parsedown. | |
3ce20d9e | 13 | */ |
8c4e6018 | 14 | define('NO_MD_TAG', 'nomarkdown'); |
3ce20d9e | 15 | |
1be4afac A |
16 | /** |
17 | * Parse linklist descriptions. | |
18 | * | |
e0376101 A |
19 | * @param array $data linklist data. |
20 | * @param ConfigManager $conf instance. | |
1be4afac A |
21 | * |
22 | * @return mixed linklist data parsed in markdown (and converted to HTML). | |
23 | */ | |
e0376101 | 24 | function hook_markdown_render_linklist($data, $conf) |
1be4afac A |
25 | { |
26 | foreach ($data['links'] as &$value) { | |
3ce20d9e | 27 | if (!empty($value['tags']) && noMarkdownTag($value['tags'])) { |
266e3fe5 | 28 | $value = stripNoMarkdownTag($value); |
3ce20d9e A |
29 | continue; |
30 | } | |
a120fb29 | 31 | $value['description_src'] = $value['description']; |
86ceea05 A |
32 | $value['description'] = process_markdown( |
33 | $value['description'], | |
34 | $conf->get('security.markdown_escape', true), | |
35 | $conf->get('security.allowed_protocols') | |
36 | ); | |
1be4afac | 37 | } |
1be4afac A |
38 | return $data; |
39 | } | |
40 | ||
635d38c2 A |
41 | /** |
42 | * Parse feed linklist descriptions. | |
43 | * | |
44 | * @param array $data linklist data. | |
e0376101 | 45 | * @param ConfigManager $conf instance. |
635d38c2 A |
46 | * |
47 | * @return mixed linklist data parsed in markdown (and converted to HTML). | |
48 | */ | |
e0376101 | 49 | function hook_markdown_render_feed($data, $conf) |
635d38c2 A |
50 | { |
51 | foreach ($data['links'] as &$value) { | |
52 | if (!empty($value['tags']) && noMarkdownTag($value['tags'])) { | |
266e3fe5 | 53 | $value = stripNoMarkdownTag($value); |
635d38c2 A |
54 | continue; |
55 | } | |
dd6794cf | 56 | $value['description'] = reverse_feed_permalink($value['description']); |
86ceea05 A |
57 | $value['description'] = process_markdown( |
58 | $value['description'], | |
59 | $conf->get('security.markdown_escape', true), | |
60 | $conf->get('security.allowed_protocols') | |
61 | ); | |
635d38c2 A |
62 | } |
63 | ||
64 | return $data; | |
65 | } | |
66 | ||
1be4afac A |
67 | /** |
68 | * Parse daily descriptions. | |
69 | * | |
e0376101 A |
70 | * @param array $data daily data. |
71 | * @param ConfigManager $conf instance. | |
1be4afac A |
72 | * |
73 | * @return mixed daily data parsed in markdown (and converted to HTML). | |
74 | */ | |
e0376101 | 75 | function hook_markdown_render_daily($data, $conf) |
1be4afac | 76 | { |
50142efd | 77 | //var_dump($data);die; |
1be4afac | 78 | // Manipulate columns data |
50142efd | 79 | foreach ($data['linksToDisplay'] as &$value) { |
80 | if (!empty($value['tags']) && noMarkdownTag($value['tags'])) { | |
81 | $value = stripNoMarkdownTag($value); | |
82 | continue; | |
1be4afac | 83 | } |
50142efd | 84 | $value['formatedDescription'] = process_markdown( |
85 | $value['formatedDescription'], | |
86 | $conf->get('security.markdown_escape', true), | |
87 | $conf->get('security.allowed_protocols') | |
88 | ); | |
1be4afac A |
89 | } |
90 | ||
91 | return $data; | |
92 | } | |
93 | ||
3ce20d9e A |
94 | /** |
95 | * Check if noMarkdown is set in tags. | |
96 | * | |
97 | * @param string $tags tag list | |
98 | * | |
99 | * @return bool true if markdown should be disabled on this link. | |
100 | */ | |
101 | function noMarkdownTag($tags) | |
102 | { | |
266e3fe5 | 103 | return preg_match('/(^|\s)'. NO_MD_TAG .'(\s|$)/', $tags); |
3ce20d9e A |
104 | } |
105 | ||
8c4e6018 A |
106 | /** |
107 | * Remove the no-markdown meta tag so it won't be displayed. | |
108 | * | |
266e3fe5 | 109 | * @param array $link Link data. |
8c4e6018 | 110 | * |
266e3fe5 | 111 | * @return array Updated link without no markdown tag. |
8c4e6018 | 112 | */ |
266e3fe5 | 113 | function stripNoMarkdownTag($link) |
8c4e6018 | 114 | { |
266e3fe5 A |
115 | if (! empty($link['taglist'])) { |
116 | $offset = array_search(NO_MD_TAG, $link['taglist']); | |
117 | if ($offset !== false) { | |
118 | unset($link['taglist'][$offset]); | |
119 | } | |
120 | } | |
121 | ||
122 | if (!empty($link['tags'])) { | |
123 | str_replace(NO_MD_TAG, '', $link['tags']); | |
124 | } | |
125 | ||
126 | return $link; | |
8c4e6018 A |
127 | } |
128 | ||
1be4afac A |
129 | /** |
130 | * When link list is displayed, include markdown CSS. | |
131 | * | |
132 | * @param array $data includes data. | |
133 | * | |
134 | * @return mixed - includes data with markdown CSS file added. | |
135 | */ | |
136 | function hook_markdown_render_includes($data) | |
137 | { | |
138 | if ($data['_PAGE_'] == Router::$PAGE_LINKLIST | |
139 | || $data['_PAGE_'] == Router::$PAGE_DAILY | |
140 | || $data['_PAGE_'] == Router::$PAGE_EDITLINK | |
141 | ) { | |
50142efd | 142 | |
1be4afac A |
143 | $data['css_files'][] = PluginManager::$PLUGINS_PATH . '/markdown/markdown.css'; |
144 | } | |
145 | ||
146 | return $data; | |
147 | } | |
148 | ||
149 | /** | |
150 | * Hook render_editlink. | |
151 | * Adds an help link to markdown syntax. | |
152 | * | |
153 | * @param array $data data passed to plugin | |
154 | * | |
155 | * @return array altered $data. | |
156 | */ | |
157 | function hook_markdown_render_editlink($data) | |
158 | { | |
159 | // Load help HTML into a string | |
12266213 A |
160 | $txt = file_get_contents(PluginManager::$PLUGINS_PATH .'/markdown/help.html'); |
161 | $translations = [ | |
162 | t('Description will be rendered with'), | |
163 | t('Markdown syntax documentation'), | |
164 | t('Markdown syntax'), | |
165 | ]; | |
166 | $data['edit_link_plugin'][] = vsprintf($txt, $translations); | |
3ce20d9e A |
167 | // Add no markdown 'meta-tag' in tag list if it was never used, for autocompletion. |
168 | if (! in_array(NO_MD_TAG, $data['tags'])) { | |
169 | $data['tags'][NO_MD_TAG] = 0; | |
170 | } | |
171 | ||
1be4afac A |
172 | return $data; |
173 | } | |
174 | ||
175 | ||
176 | /** | |
177 | * Remove HTML links auto generated by Shaarli core system. | |
178 | * Keeps HREF attributes. | |
179 | * | |
180 | * @param string $description input description text. | |
181 | * | |
182 | * @return string $description without HTML links. | |
183 | */ | |
184 | function reverse_text2clickable($description) | |
185 | { | |
9ccca401 A |
186 | $descriptionLines = explode(PHP_EOL, $description); |
187 | $descriptionOut = ''; | |
188 | $codeBlockOn = false; | |
189 | $lineCount = 0; | |
190 | ||
191 | foreach ($descriptionLines as $descriptionLine) { | |
c5941f31 A |
192 | // Detect line of code: starting with 4 spaces, |
193 | // except lists which can start with +/*/- or `2.` after spaces. | |
194 | $codeLineOn = preg_match('/^ +(?=[^\+\*\-])(?=(?!\d\.).)/', $descriptionLine) > 0; | |
9ccca401 A |
195 | // Detect and toggle block of code |
196 | if (!$codeBlockOn) { | |
197 | $codeBlockOn = preg_match('/^```/', $descriptionLine) > 0; | |
198 | } | |
199 | elseif (preg_match('/^```/', $descriptionLine) > 0) { | |
200 | $codeBlockOn = false; | |
201 | } | |
202 | ||
203 | $hashtagTitle = ' title="Hashtag [^"]+"'; | |
204 | // Reverse `inline code` hashtags. | |
205 | $descriptionLine = preg_replace( | |
206 | '!(`[^`\n]*)<a href="[^ ]*"'. $hashtagTitle .'>([^<]+)</a>([^`\n]*`)!m', | |
207 | '$1$2$3', | |
208 | $descriptionLine | |
209 | ); | |
210 | ||
c5941f31 A |
211 | // Reverse all links in code blocks, only non hashtag elsewhere. |
212 | $hashtagFilter = (!$codeBlockOn && !$codeLineOn) ? '(?!'. $hashtagTitle .')': '(?:'. $hashtagTitle .')?'; | |
9ccca401 | 213 | $descriptionLine = preg_replace( |
c5941f31 | 214 | '#<a href="[^ ]*"'. $hashtagFilter .'>([^<]+)</a>#m', |
9ccca401 A |
215 | '$1', |
216 | $descriptionLine | |
217 | ); | |
218 | ||
219 | $descriptionOut .= $descriptionLine; | |
220 | if ($lineCount++ < count($descriptionLines) - 1) { | |
221 | $descriptionOut .= PHP_EOL; | |
222 | } | |
223 | } | |
224 | return $descriptionOut; | |
1be4afac A |
225 | } |
226 | ||
227 | /** | |
228 | * Remove <br> tag to let markdown handle it. | |
229 | * | |
230 | * @param string $description input description text. | |
231 | * | |
232 | * @return string $description without <br> tags. | |
233 | */ | |
234 | function reverse_nl2br($description) | |
235 | { | |
236 | return preg_replace('!<br */?>!im', '', $description); | |
237 | } | |
238 | ||
239 | /** | |
240 | * Remove HTML spaces ' ' auto generated by Shaarli core system. | |
241 | * | |
242 | * @param string $description input description text. | |
243 | * | |
244 | * @return string $description without HTML links. | |
245 | */ | |
246 | function reverse_space2nbsp($description) | |
247 | { | |
248 | return preg_replace('/(^| ) /m', '$1 ', $description); | |
249 | } | |
250 | ||
dd6794cf A |
251 | function reverse_feed_permalink($description) |
252 | { | |
253 | return preg_replace('@— <a href="([^"]+)" title="[^"]+">(\w+)</a>$@im', '— [$2]($1)', $description); | |
254 | } | |
255 | ||
86ceea05 A |
256 | /** |
257 | * Replace not whitelisted protocols with http:// in given description. | |
258 | * | |
259 | * @param string $description input description text. | |
260 | * @param array $allowedProtocols list of allowed protocols. | |
261 | * | |
262 | * @return string $description without malicious link. | |
263 | */ | |
264 | function filter_protocols($description, $allowedProtocols) | |
265 | { | |
266 | return preg_replace_callback( | |
267 | '#]\((.*?)\)#is', | |
268 | function ($match) use ($allowedProtocols) { | |
269 | return ']('. whitelist_protocols($match[1], $allowedProtocols) .')'; | |
270 | }, | |
271 | $description | |
272 | ); | |
273 | } | |
274 | ||
1be4afac | 275 | /** |
2925687e A |
276 | * Remove dangerous HTML tags (tags, iframe, etc.). |
277 | * Doesn't affect <code> content (already escaped by Parsedown). | |
1be4afac A |
278 | * |
279 | * @param string $description input description text. | |
280 | * | |
2925687e | 281 | * @return string given string escaped. |
1be4afac | 282 | */ |
2925687e | 283 | function sanitize_html($description) |
1be4afac | 284 | { |
2925687e A |
285 | $escapeTags = array( |
286 | 'script', | |
287 | 'style', | |
288 | 'link', | |
289 | 'iframe', | |
290 | 'frameset', | |
291 | 'frame', | |
292 | ); | |
293 | foreach ($escapeTags as $tag) { | |
294 | $description = preg_replace_callback( | |
295 | '#<\s*'. $tag .'[^>]*>(.*</\s*'. $tag .'[^>]*>)?#is', | |
296 | function ($match) { return escape($match[0]); }, | |
297 | $description); | |
298 | } | |
299 | $description = preg_replace( | |
b525810c | 300 | '#(<[^>]+\s)on[a-z]*="?[^ "]*"?#is', |
2925687e A |
301 | '$1', |
302 | $description); | |
303 | return $description; | |
1be4afac A |
304 | } |
305 | ||
306 | /** | |
307 | * Render shaare contents through Markdown parser. | |
308 | * 1. Remove HTML generated by Shaarli core. | |
2925687e A |
309 | * 2. Reverse the escape function. |
310 | * 3. Generate markdown descriptions. | |
311 | * 4. Sanitize sensible HTML tags for security. | |
312 | * 5. Wrap description in 'markdown' CSS class. | |
1be4afac A |
313 | * |
314 | * @param string $description input description text. | |
e0376101 | 315 | * @param bool $escape escape HTML entities |
1be4afac A |
316 | * |
317 | * @return string HTML processed $description. | |
318 | */ | |
86ceea05 | 319 | function process_markdown($description, $escape = true, $allowedProtocols = []) |
1be4afac A |
320 | { |
321 | $parsedown = new Parsedown(); | |
322 | ||
323 | $processedDescription = $description; | |
1be4afac A |
324 | $processedDescription = reverse_nl2br($processedDescription); |
325 | $processedDescription = reverse_space2nbsp($processedDescription); | |
9ccca401 | 326 | $processedDescription = reverse_text2clickable($processedDescription); |
86ceea05 | 327 | $processedDescription = filter_protocols($processedDescription, $allowedProtocols); |
2925687e | 328 | $processedDescription = unescape($processedDescription); |
1be4afac | 329 | $processedDescription = $parsedown |
e0376101 | 330 | ->setMarkupEscaped($escape) |
1be4afac A |
331 | ->setBreaksEnabled(true) |
332 | ->text($processedDescription); | |
2925687e | 333 | $processedDescription = sanitize_html($processedDescription); |
841df2dd | 334 | |
335 | if(!empty($processedDescription)){ | |
336 | $processedDescription = '<div class="markdown">'. $processedDescription . '</div>'; | |
337 | } | |
1be4afac A |
338 | |
339 | return $processedDescription; | |
340 | } | |
12266213 A |
341 | |
342 | /** | |
343 | * This function is never called, but contains translation calls for GNU gettext extraction. | |
344 | */ | |
345 | function markdown_dummy_translation() | |
346 | { | |
347 | // meta | |
348 | t('Render shaare description with Markdown syntax.<br><strong>Warning</strong>: | |
349 | If your shaared descriptions contained HTML tags before enabling the markdown plugin, | |
350 | enabling it might break your page. | |
351 | See the <a href="https://github.com/shaarli/Shaarli/tree/master/plugins/markdown#html-rendering">README</a>.'); | |
352 | } |