6 * Shaare's descriptions are parsed with Markdown.
9 use Shaarli\Config\ConfigManager
;
12 * If this tag is used on a shaare, the description won't be processed by Parsedown.
14 define('NO_MD_TAG', 'nomarkdown');
17 * Parse linklist descriptions.
19 * @param array $data linklist data.
20 * @param ConfigManager $conf instance.
22 * @return mixed linklist data parsed in markdown (and converted to HTML).
24 function hook_markdown_render_linklist($data, $conf)
26 foreach ($data['links'] as &$value) {
27 if (!empty($value['tags']) && noMarkdownTag($value['tags'])) {
28 $value = stripNoMarkdownTag($value);
31 $value['description_src'] = $value['description'];
32 $value['description'] = process_markdown(
33 $value['description'],
34 $conf->get('security.markdown_escape', true),
35 $conf->get('security.allowed_protocols')
42 * Parse feed linklist descriptions.
44 * @param array $data linklist data.
45 * @param ConfigManager $conf instance.
47 * @return mixed linklist data parsed in markdown (and converted to HTML).
49 function hook_markdown_render_feed($data, $conf)
51 foreach ($data['links'] as &$value) {
52 if (!empty($value['tags']) && noMarkdownTag($value['tags'])) {
53 $value = stripNoMarkdownTag($value);
56 $value['description'] = reverse_feed_permalink($value['description']);
57 $value['description'] = process_markdown(
58 $value['description'],
59 $conf->get('security.markdown_escape', true),
60 $conf->get('security.allowed_protocols')
68 * Parse daily descriptions.
70 * @param array $data daily data.
71 * @param ConfigManager $conf instance.
73 * @return mixed daily data parsed in markdown (and converted to HTML).
75 function hook_markdown_render_daily($data, $conf)
77 //var_dump($data);die;
78 // Manipulate columns data
79 foreach ($data['linksToDisplay'] as &$value) {
80 if (!empty($value['tags']) && noMarkdownTag($value['tags'])) {
81 $value = stripNoMarkdownTag($value);
84 $value['formatedDescription'] = process_markdown(
85 $value['formatedDescription'],
86 $conf->get('security.markdown_escape', true),
87 $conf->get('security.allowed_protocols')
95 * Check if noMarkdown is set in tags.
97 * @param string $tags tag list
99 * @return bool true if markdown should be disabled on this link.
101 function noMarkdownTag($tags)
103 return preg_match('/(^|\s)'. NO_MD_TAG
.'(\s|$)/', $tags);
107 * Remove the no-markdown meta tag so it won't be displayed.
109 * @param array $link Link data.
111 * @return array Updated link without no markdown tag.
113 function stripNoMarkdownTag($link)
115 if (! empty($link['taglist'])) {
116 $offset = array_search(NO_MD_TAG
, $link['taglist']);
117 if ($offset !== false) {
118 unset($link['taglist'][$offset]);
122 if (!empty($link['tags'])) {
123 str_replace(NO_MD_TAG
, '', $link['tags']);
130 * When link list is displayed, include markdown CSS.
132 * @param array $data includes data.
134 * @return mixed - includes data with markdown CSS file added.
136 function hook_markdown_render_includes($data)
138 if ($data['_PAGE_'] == Router
::$PAGE_LINKLIST
139 || $data['_PAGE_'] == Router
::$PAGE_DAILY
140 || $data['_PAGE_'] == Router
::$PAGE_EDITLINK
142 $data['css_files'][] = PluginManager
::$PLUGINS_PATH . '/markdown/markdown.css';
149 * Hook render_editlink.
150 * Adds an help link to markdown syntax.
152 * @param array $data data passed to plugin
154 * @return array altered $data.
156 function hook_markdown_render_editlink($data)
158 // Load help HTML into a string
159 $txt = file_get_contents(PluginManager
::$PLUGINS_PATH .'/markdown/help.html');
161 t('Description will be rendered with'),
162 t('Markdown syntax documentation'),
163 t('Markdown syntax'),
165 $data['edit_link_plugin'][] = vsprintf($txt, $translations);
166 // Add no markdown 'meta-tag' in tag list if it was never used, for autocompletion.
167 if (! in_array(NO_MD_TAG
, $data['tags'])) {
168 $data['tags'][NO_MD_TAG
] = 0;
176 * Remove HTML links auto generated by Shaarli core system.
177 * Keeps HREF attributes.
179 * @param string $description input description text.
181 * @return string $description without HTML links.
183 function reverse_text2clickable($description)
185 $descriptionLines = explode(PHP_EOL
, $description);
186 $descriptionOut = '';
187 $codeBlockOn = false;
190 foreach ($descriptionLines as $descriptionLine) {
191 // Detect line of code: starting with 4 spaces,
192 // except lists which can start with +/*/- or `2.` after spaces.
193 $codeLineOn = preg_match('/^ +(?=[^\+\*\-])(?=(?!\d\.).)/', $descriptionLine) > 0;
194 // Detect and toggle block of code
196 $codeBlockOn = preg_match('/^```/', $descriptionLine) > 0;
197 } elseif (preg_match('/^```/', $descriptionLine) > 0) {
198 $codeBlockOn = false;
201 $hashtagTitle = ' title="Hashtag [^"]+"';
202 // Reverse `inline code` hashtags.
203 $descriptionLine = preg_replace(
204 '!(`[^`\n]*)<a href="[^ ]*"'. $hashtagTitle .'>([^<]+)</a>([^`\n]*`)!m',
209 // Reverse all links in code blocks, only non hashtag elsewhere.
210 $hashtagFilter = (!$codeBlockOn && !$codeLineOn) ? '(?!'. $hashtagTitle .')': '(?:'. $hashtagTitle .')?';
211 $descriptionLine = preg_replace(
212 '#<a href="[^ ]*"'. $hashtagFilter .'>([^<]+)</a>#m',
217 // Make hashtag links markdown ready, otherwise the links will be ignored with escape set to true
218 if (!$codeBlockOn && !$codeLineOn) {
219 $descriptionLine = preg_replace(
220 '#<a href="([^ ]*)"'. $hashtagTitle .'>([^<]+)</a>#m',
226 $descriptionOut .= $descriptionLine;
227 if ($lineCount++
< count($descriptionLines) - 1) {
228 $descriptionOut .= PHP_EOL
;
231 return $descriptionOut;
235 * Remove <br> tag to let markdown handle it.
237 * @param string $description input description text.
239 * @return string $description without <br> tags.
241 function reverse_nl2br($description)
243 return preg_replace('!<br */?>!im', '', $description);
247 * Remove HTML spaces ' ' auto generated by Shaarli core system.
249 * @param string $description input description text.
251 * @return string $description without HTML links.
253 function reverse_space2nbsp($description)
255 return preg_replace('/(^| ) /m', '$1 ', $description);
258 function reverse_feed_permalink($description)
260 return preg_replace('@— <a href="([^"]+)" title="[^"]+">(\w+)</a>$@im', '— [$2]($1)', $description);
264 * Replace not whitelisted protocols with http:// in given description.
266 * @param string $description input description text.
267 * @param array $allowedProtocols list of allowed protocols.
269 * @return string $description without malicious link.
271 function filter_protocols($description, $allowedProtocols)
273 return preg_replace_callback(
275 function ($match) use ($allowedProtocols) {
276 return ']('. whitelist_protocols($match[1], $allowedProtocols) .')';
283 * Remove dangerous HTML tags (tags, iframe, etc.).
284 * Doesn't affect <code> content (already escaped by Parsedown).
286 * @param string $description input description text.
288 * @return string given string escaped.
290 function sanitize_html($description)
300 foreach ($escapeTags as $tag) {
301 $description = preg_replace_callback(
302 '#<\s*'. $tag .'[^>]*>(.*</\s*'. $tag .'[^>]*>)?#is',
304 return escape($match[0]);
309 $description = preg_replace(
310 '#(<[^>]+\s)on[a-z]*="?[^ "]*"?#is',
318 * Render shaare contents through Markdown parser.
319 * 1. Remove HTML generated by Shaarli core.
320 * 2. Reverse the escape function.
321 * 3. Generate markdown descriptions.
322 * 4. Sanitize sensible HTML tags for security.
323 * 5. Wrap description in 'markdown
' CSS class.
325 * @param string $description input description text.
326 * @param bool $escape escape HTML entities
328 * @return string HTML processed $description.
330 function process_markdown($description, $escape = true, $allowedProtocols = [])
332 $parsedown = new Parsedown();
334 $processedDescription = $description;
335 $processedDescription = reverse_nl2br($processedDescription);
336 $processedDescription = reverse_space2nbsp($processedDescription);
337 $processedDescription = reverse_text2clickable($processedDescription);
338 $processedDescription = filter_protocols($processedDescription, $allowedProtocols);
339 $processedDescription = unescape($processedDescription);
340 $processedDescription = $parsedown
341 ->setMarkupEscaped($escape)
342 ->setBreaksEnabled(true)
343 ->text($processedDescription);
344 $processedDescription = sanitize_html($processedDescription);
346 if (!empty($processedDescription)) {
347 $processedDescription = '<div
class="markdown">'. $processedDescription . '</div
>';
350 return $processedDescription;
354 * This function is never called, but contains translation calls for GNU gettext extraction.
356 function markdown_dummy_translation()
359 t('Render shaare description with Markdown syntax
.<br
><strong
>Warning
</strong
>:
360 If your shaared descriptions contained HTML tags before enabling the markdown plugin
,
361 enabling it might
break your page
.
362 See the
<a href
="https://github.com/shaarli/Shaarli/tree/master/plugins/markdown#html-rendering">README
</a
>.');