6 * Shaare's descriptions are parsed with Markdown.
9 require_once 'Parsedown.php';
12 * If this tag is used on a shaare, the description won't be processed by Parsedown.
13 * Using a private tag so it won't appear for visitors.
15 define('NO_MD_TAG', '.nomarkdown');
18 * Parse linklist descriptions.
20 * @param array $data linklist data.
22 * @return mixed linklist data parsed in markdown (and converted to HTML).
24 function hook_markdown_render_linklist($data)
26 foreach ($data['links'] as &$value) {
27 if (!empty($value['tags']) && noMarkdownTag($value['tags'])) {
30 $value['description'] = process_markdown($value['description']);
37 * Parse feed linklist descriptions.
39 * @param array $data linklist data.
41 * @return mixed linklist data parsed in markdown (and converted to HTML).
43 function hook_markdown_render_feed($data)
45 foreach ($data['links'] as &$value) {
46 if (!empty($value['tags']) && noMarkdownTag($value['tags'])) {
49 $value['description'] = process_markdown($value['description']);
56 * Parse daily descriptions.
58 * @param array $data daily data.
60 * @return mixed daily data parsed in markdown (and converted to HTML).
62 function hook_markdown_render_daily($data)
64 // Manipulate columns data
65 foreach ($data['cols'] as &$value) {
66 foreach ($value as &$value2) {
67 if (!empty($value2['tags']) && noMarkdownTag($value2['tags'])) {
70 $value2['formatedDescription'] = process_markdown($value2['formatedDescription']);
78 * Check if noMarkdown is set in tags.
80 * @param string $tags tag list
82 * @return bool true if markdown should be disabled on this link.
84 function noMarkdownTag($tags)
86 return strpos($tags, NO_MD_TAG
) !== false;
90 * When link list is displayed, include markdown CSS.
92 * @param array $data includes data.
94 * @return mixed - includes data with markdown CSS file added.
96 function hook_markdown_render_includes($data)
98 if ($data['_PAGE_'] == Router
::$PAGE_LINKLIST
99 || $data['_PAGE_'] == Router
::$PAGE_DAILY
100 || $data['_PAGE_'] == Router
::$PAGE_EDITLINK
103 $data['css_files'][] = PluginManager
::$PLUGINS_PATH . '/markdown/markdown.css';
110 * Hook render_editlink.
111 * Adds an help link to markdown syntax.
113 * @param array $data data passed to plugin
115 * @return array altered $data.
117 function hook_markdown_render_editlink($data)
119 // Load help HTML into a string
120 $data['edit_link_plugin'][] = file_get_contents(PluginManager
::$PLUGINS_PATH .'/markdown/help.html');
122 // Add no markdown 'meta-tag' in tag list if it was never used, for autocompletion.
123 if (! in_array(NO_MD_TAG
, $data['tags'])) {
124 $data['tags'][NO_MD_TAG
] = 0;
132 * Remove HTML links auto generated by Shaarli core system.
133 * Keeps HREF attributes.
135 * @param string $description input description text.
137 * @return string $description without HTML links.
139 function reverse_text2clickable($description)
141 return preg_replace('!<a +href="([^ ]*)">[^ ]+</a>!m', '$1', $description);
145 * Remove <br> tag to let markdown handle it.
147 * @param string $description input description text.
149 * @return string $description without <br> tags.
151 function reverse_nl2br($description)
153 return preg_replace('!<br */
?>!im
', '', $description);
157 * Remove HTML spaces ' 
;' auto generated by Shaarli core system.
159 * @param string $description input description text.
161 * @return string $description without HTML links.
163 function reverse_space2nbsp($description)
165 return preg_replace('/(^
| ) 
;/m
', '$1 ', $description);
169 * Remove dangerous HTML tags (tags, iframe, etc.).
170 * Doesn't affect
<code
> content (already escaped by Parsedown
).
172 * @param
string $description input description text
.
174 * @return string given
string escaped
.
176 function sanitize_html($description)
186 foreach ($escapeTags as $tag) {
187 $description = preg_replace_callback(
188 '#<\s*'. $tag .'[^>]*>(.*</\s*'. $tag .'[^>]*>)?#is',
189 function ($match) { return escape($match
[0]); },
192 $description = preg_replace(
193 '#(<[^>]+)on[a-z]*="[^"]*"#is',
200 * Render shaare contents through Markdown parser.
201 * 1. Remove HTML generated by Shaarli core.
202 * 2. Reverse the escape function.
203 * 3. Generate markdown descriptions.
204 * 4. Sanitize sensible HTML tags for security.
205 * 5. Wrap description in 'markdown
' CSS class.
207 * @param string $description input description text.
209 * @return string HTML processed $description.
211 function process_markdown($description)
213 $parsedown = new Parsedown();
215 $processedDescription = $description;
216 $processedDescription = reverse_text2clickable($processedDescription);
217 $processedDescription = reverse_nl2br($processedDescription);
218 $processedDescription = reverse_space2nbsp($processedDescription);
219 $processedDescription = unescape($processedDescription);
220 $processedDescription = $parsedown
221 ->setMarkupEscaped(false)
222 ->setBreaksEnabled(true)
223 ->text($processedDescription);
224 $processedDescription = sanitize_html($processedDescription);
226 if(!empty($processedDescription)){
227 $processedDescription = '<div
class="markdown">'. $processedDescription . '</div
>';
230 return $processedDescription;