Fixed improper Markdown escaping for some tooltips

lvic · Apr 29, 2016 · 9fa8f63 · 9fa8f63
1 parent a34f83f
commit 9fa8f63
Show file tree

Hide file tree

Showing 11 changed files with 30 additions and 9 deletions.
diff --git a/ChangeLog b/ChangeLog
@@ -22,6 +22,7 @@ Improvements:
 
 Bug fixes:
 
+* Fixed improper Markdown escaping for some tooltips
 * Closing all tasks by column, also update closed tasks
 * Fixed wrong task link generation within Markdown text
 * Fixed wrong URL on comment toggle link for sorting

diff --git a/app/Helper/TextHelper.php b/app/Helper/TextHelper.php
@@ -38,6 +38,18 @@ public function markdown($text, $isPublicLink = false)
         return $parser->text($text);
     }
 
+    /**
+     * Escape Markdown text that need to be stored in HTML attribute
+     *
+     * @access public
+     * @param  string $text
+     * @return mixed
+     */
+    public function markdownAttribute($text)
+    {
+        return htmlentities($this->markdown($text), ENT_QUOTES, 'UTF-8');
+    }
+
     /**
      * Format a file size
      *

diff --git a/app/Template/app/projects.php b/app/Template/app/projects.php
@@ -31,7 +31,7 @@
 
                 <?= $this->url->link($this->text->e($project['name']), 'board', 'show', array('project_id' => $project['id'])) ?>
                 <?php if (! empty($project['description'])): ?>
-                    <span class="tooltip" title='<?= $this->text->e($this->text->markdown($project['description'])) ?>'>
+                    <span class="tooltip" title="<?= $this->text->markdownAttribute($project['description']) ?>">
                         <i class="fa fa-info-circle"></i>
                     </span>
                 <?php endif ?>

diff --git a/app/Template/board/table_column.php b/app/Template/board/table_column.php
@@ -47,7 +47,7 @@
             </span>
 
             <?php if (! $not_editable && ! empty($column['description'])): ?>
-                <span class="tooltip pull-right" title='<?= $this->text->e($this->text->markdown($column['description'])) ?>'>
+                <span class="tooltip pull-right" title="<?= $this->text->markdownAttribute($column['description']) ?>">
                     &nbsp;<i class="fa fa-info-circle"></i>
                 </span>
             <?php endif ?>

diff --git a/app/Template/board/task_footer.php b/app/Template/board/task_footer.php
@@ -11,7 +11,7 @@
                 array('task_id' => $task['id'], 'project_id' => $task['project_id']),
                 false,
                 'popover' . (! empty($task['category_description']) ? ' tooltip' : ''),
-                ! empty($task['category_description']) ? $this->text->markdown($task['category_description']) : t('Change category')
+                ! empty($task['category_description']) ? $this->text->markdownAttribute($task['category_description']) : t('Change category')
             ) ?>
         <?php endif ?>
     </span>
@@ -76,7 +76,7 @@
             <i class="fa fa-flag flag-milestone"></i>
         </span>
     <?php endif ?>
-    
+
     <?= $this->hook->render('template:board:task:icons', array('task' => $task)) ?>
 
     <?= $this->task->formatPriority($project, $task) ?>

diff --git a/app/Template/column/index.php b/app/Template/column/index.php
@@ -28,7 +28,7 @@ class="columns-table table-stripped"
                 <i class="fa fa-arrows-alt draggable-row-handle" title="<?= t('Change column position') ?>"></i>
                 <?= $this->text->e($column['title']) ?>
                 <?php if (! empty($column['description'])): ?>
-                    <span class="tooltip" title='<?= $this->text->e($this->text->markdown($column['description'])) ?>'>
+                    <span class="tooltip" title="<?= $this->text->markdownAttribute($column['description']) ?>">
                         <i class="fa fa-info-circle"></i>
                     </span>
                 <?php endif ?>

diff --git a/app/Template/header.php b/app/Template/header.php
@@ -8,7 +8,7 @@
                 <?= $this->text->e($title) ?>
             </span>
             <?php if (! empty($description)): ?>
-                <span class="tooltip" title='<?= $this->text->e($this->text->markdown($description)) ?>'>
+                <span class="tooltip" title="<?= $this->text->markdownAttribute($description) ?>">
                     <i class="fa fa-info-circle"></i>
                 </span>
             <?php endif ?>

diff --git a/app/Template/project/index.php b/app/Template/project/index.php
@@ -49,7 +49,7 @@
                     <?php endif ?>
 
                     <?php if (! empty($project['description'])): ?>
-                        <span class="tooltip" title='<?= $this->text->e($this->text->markdown($project['description'])) ?>'>
+                        <span class="tooltip" title="<?= $this->text->markdownAttribute($project['description']) ?>">
                             <i class="fa fa-info-circle"></i>
                         </span>
                     <?php endif ?>

diff --git a/app/Template/project/show.php b/app/Template/project/show.php
@@ -63,7 +63,7 @@
         <td>
             <?= $this->text->e($column['title']) ?>
             <?php if (! empty($column['description'])): ?>
-                <span class="tooltip" title='<?= $this->text->e($this->text->markdown($column['description'])) ?>'>
+                <span class="tooltip" title="<?= $this->text->markdownAttribute($column['description']) ?>">
                     <i class="fa fa-info-circle"></i>
                 </span>
             <?php endif ?>

diff --git a/app/Template/swimlane/table.php b/app/Template/swimlane/table.php
@@ -45,7 +45,7 @@ class="swimlanes-table table-stripped"
                 <?= $this->text->e($swimlane['name']) ?>
 
                 <?php if (! empty($swimlane['description'])): ?>
-                    <span class="tooltip" title='<?= $this->text->e($this->text->markdown($swimlane['description'])) ?>'>
+                    <span class="tooltip" title="<?= $this->text->markdownAttribute($swimlane['description']) ?>">
                         <i class="fa fa-info-circle"></i>
                     </span>
                 <?php endif ?>

diff --git a/tests/units/Helper/TextHelperTest.php b/tests/units/Helper/TextHelperTest.php
@@ -51,6 +51,14 @@ public function testMarkdownUserLink()
         $this->assertEquals('<p>Text @admin @notfound</p>', $h->markdown('Text @admin @notfound', true));
     }
 
+    public function testMarkdownAttribute()
+    {
+        $helper = new TextHelper($this->container);
+        $this->assertEquals('&lt;p&gt;&Ccedil;a marche&lt;/p&gt;', $helper->markdownAttribute('Ça marche'));
+        $this->assertEquals('&lt;p&gt;Test with &amp;quot;double quotes&amp;quot;&lt;/p&gt;', $helper->markdownAttribute('Test with "double quotes"'));
+        $this->assertEquals('&lt;p&gt;Test with &#039;single quotes&#039;&lt;/p&gt;', $helper->markdownAttribute("Test with 'single quotes'"));
+    }
+
     public function testFormatBytes()
     {
         $h = new TextHelper($this->container);