]> git.immae.eu Git - github/shaarli/Shaarli.git/commitdiff
Markdown: Add the 'meta-tag' `.nomarkdown` which prevent a shaare from being parsed...
authorArthurHoaro <arthur@hoa.ro>
Mon, 21 Mar 2016 17:46:34 +0000 (18:46 +0100)
committerArthurHoaro <arthur@hoa.ro>
Mon, 21 Mar 2016 17:46:34 +0000 (18:46 +0100)
Also add the tag in tag list in edit_link, so it will appear on autocompletion.

plugins/markdown/markdown.php
tests/plugins/PluginMarkdownTest.php

index 5a702c7b5df8a639c6b41257ae3d152167352cf8..544ed22ecb6c71f0b8b769df580b661d5e3aa5be 100644 (file)
@@ -8,6 +8,12 @@
 
 require_once 'Parsedown.php';
 
+/*
+ * If this tag is used on a shaare, the description won't be processed by Parsedown.
+ * Using a private tag so it won't appear for visitors.
+ */
+define('NO_MD_TAG', '.nomarkdown');
+
 /**
  * Parse linklist descriptions.
  *
@@ -18,6 +24,9 @@ require_once 'Parsedown.php';
 function hook_markdown_render_linklist($data)
 {
     foreach ($data['links'] as &$value) {
+        if (!empty($value['tags']) && noMarkdownTag($value['tags'])) {
+            continue;
+        }
         $value['description'] = process_markdown($value['description']);
     }
 
@@ -36,6 +45,9 @@ function hook_markdown_render_daily($data)
     // Manipulate columns data
     foreach ($data['cols'] as &$value) {
         foreach ($value as &$value2) {
+            if (!empty($value2['tags']) && noMarkdownTag($value2['tags'])) {
+                continue;
+            }
             $value2['formatedDescription'] = process_markdown($value2['formatedDescription']);
         }
     }
@@ -43,6 +55,18 @@ function hook_markdown_render_daily($data)
     return $data;
 }
 
+/**
+ * Check if noMarkdown is set in tags.
+ *
+ * @param string $tags tag list
+ *
+ * @return bool true if markdown should be disabled on this link.
+ */
+function noMarkdownTag($tags)
+{
+    return strpos($tags, NO_MD_TAG) !== false;
+}
+
 /**
  * When link list is displayed, include markdown CSS.
  *
@@ -75,6 +99,12 @@ function hook_markdown_render_editlink($data)
 {
     // Load help HTML into a string
     $data['edit_link_plugin'][] = file_get_contents(PluginManager::$PLUGINS_PATH .'/markdown/help.html');
+
+    // Add no markdown 'meta-tag' in tag list if it was never used, for autocompletion.
+    if (! in_array(NO_MD_TAG, $data['tags'])) {
+        $data['tags'][NO_MD_TAG] = 0;
+    }
+
     return $data;
 }
 
index 8e1a128acc6d2b00218611af2f7257fd0ff437a7..fa7e1d52ddd1dd126ecb15f0cd1e262f7895c68a 100644 (file)
@@ -102,7 +102,8 @@ class PluginMarkdownTest extends PHPUnit_Framework_TestCase
     /**
      * Test sanitize_html().
      */
-    function testSanitizeHtml() {
+    function testSanitizeHtml()
+    {
         $input = '< script src="js.js"/>';
         $input .= '< script attr>alert(\'xss\');</script>';
         $input .= '<style> * { display: none }</style>';
@@ -114,4 +115,38 @@ class PluginMarkdownTest extends PHPUnit_Framework_TestCase
         $input = escape($input);
         $this->assertEquals($input, sanitize_html($input));
     }
+
+    /**
+     * Test the no markdown tag.
+     */
+    function testNoMarkdownTag()
+    {
+        $str = 'All _work_ and `no play` makes Jack a *dull* boy.';
+        $data = array(
+            'links' => array(array(
+                'description' => $str,
+                'tags' => NO_MD_TAG
+            ))
+        );
+
+        $data = hook_markdown_render_linklist($data);
+        $this->assertEquals($str, $data['links'][0]['description']);
+
+        $data = array(
+            // Columns data
+            'cols' => array(
+                // First, second, third.
+                0 => array(
+                    // nth link
+                    0 => array(
+                        'formatedDescription' => $str,
+                        'tags' => NO_MD_TAG
+                    ),
+                ),
+            ),
+        );
+
+        $data = hook_markdown_render_daily($data);
+        $this->assertEquals($str, $data['cols'][0][0]['formatedDescription']);
+    }
 }