Add Markdown view helper and tidy other view helpers

Author: Jamie Snape

core/views/helpers/Dateago.php

@@ -19,20 +19,19 @@
 =========================================================================*/
 
 /** Date ago view helper. */
-class Zend_View_Helper_Dateago
+class Zend_View_Helper_Dateago extends Zend_View_Helper_Abstract
 {
-    /** Date ago view helper. */
+    /**
+     * Date ago view helper.
+     *
+     * @param int|string $timestamp timestamp
+     * @return string date ago as a formatted string
+     */
     public function dateago($timestamp)
     {
-        Zend_Loader::loadClass('DateComponent', BASE_PATH.'/core/controllers/components');
-        $component = new DateComponent();
+        /** @var DateComponent $dateComponent */
+        $dateComponent = MidasLoader::loadComponent('Date');
 
-        return $component->ago($timestamp);
-    }
-
-    /** Set the view. */
-    public function setView(Zend_View_Interface $view)
-    {
-        $this->view = $view;
+        return htmlspecialchars($dateComponent->ago($timestamp), ENT_QUOTES, 'UTF-8');
     }
 }

core/views/helpers/Duration.php

@@ -19,20 +19,19 @@
 =========================================================================*/
 
 /** Duration view helper. */
-class Zend_View_Helper_Duration
+class Zend_View_Helper_Duration extends Zend_View_Helper_Abstract
 {
-    /** Duration view helper. */
+    /**
+     * Duration view helper.
+     *
+     * @param int|string $timestamp timestamp
+     * @return string duration as a formatted string
+     */
     public function duration($timestamp)
     {
-        Zend_Loader::loadClass('DateComponent', BASE_PATH.'/core/controllers/components');
-        $component = new DateComponent();
+        /** @var DateComponent $dateComponent */
+        $dateComponent = MidasLoader::loadComponent('Date');
 
-        return $component->duration($timestamp);
-    }
-
-    /** Set the view. */
-    public function setView(Zend_View_Interface $view)
-    {
-        $this->view = $view;
+        return htmlspecialchars($dateComponent->duration($timestamp), ENT_QUOTES, 'UTF-8');
     }
 }

core/views/helpers/Linkuser.php

@@ -19,23 +19,22 @@
 =========================================================================*/
 
 /** Link user view helper. */
-class Zend_View_Helper_Linkuser
+class Zend_View_Helper_Linkuser extends Zend_View_Helper_Abstract
 {
-    /** Link user view helper. */
+    /**
+     * Link user view helper.
+     *
+     * @param UserDao $userDao user DAO
+     * @return string full name of the user, linked to their profile if it is public
+     */
     public function linkuser($userDao)
     {
         if ($userDao->getPrivacy() == MIDAS_USER_PUBLIC || isset($this->view->userDao) && $this->view->userDao->isAdmin(
             ) || isset($this->view->userDao) && $userDao->getKey() == $this->view->userDao->getKey()
         ) {
-            return '<a class="userTitle" href="'.$this->view->webroot.'/user/'.$userDao->getKey().'">'.$userDao->getFullName().'</a>';
+            return '<a class="userTitle" href="'.$this->view->webroot.'/user/'.htmlspecialchars($userDao->getKey(), ENT_QUOTES, 'UTF-8').'">'.htmlspecialchars($userDao->getFullName(), ENT_QUOTES, 'UTF-8').'</a>';
         }
 
-        return $userDao->getFullName();
-    }
-
-    /** Set the view. */
-    public function setView(Zend_View_Interface $view)
-    {
-        $this->view = $view;
+        return htmlspecialchars($userDao->getFullName(), ENT_QUOTES, 'UTF-8');
     }
 }

core/views/helpers/Markdown.php

@@ -0,0 +1,34 @@
+<?php
+/*=========================================================================
+ MIDAS Server
+ Copyright (c) Kitware SAS. 26 rue Louis Guérin. 69100 Villeurbanne, FRANCE
+ All rights reserved.
+ More information http://www.kitware.com
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+         http://www.apache.org/licenses/LICENSE-2.0.txt
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+=========================================================================*/
+
+/** Markdown view helper. */
+class Zend_View_Helper_Markdown extends Zend_View_Helper_Abstract
+{
+    /**
+     * Markdown view helper.
+     *
+     * @param string $text Markdown or Markdown Extra text
+     * @return string HTML text
+     */
+    public function markdown($text)
+    {
+        return UtilityComponent::markdown(htmlspecialchars($text, ENT_QUOTES, 'UTF-8'));
+    }
+}

core/views/helpers/Slicename.php

@@ -19,20 +19,17 @@
 =========================================================================*/
 
 /** Slice name view helper. */
-class Zend_View_Helper_Slicename
+class Zend_View_Helper_Slicename extends Zend_View_Helper_Abstract
 {
-    /** Slice name view helper. */
+    /**
+     * Slice name view helper.
+     *
+     * @param string $name name
+     * @param int $nchar number of characters
+     * @return string sliced name
+     */
     public function slicename($name, $nchar)
     {
-        Zend_Loader::loadClass('UtilityComponent', BASE_PATH.'/core/controllers/components');
-        $component = new UtilityComponent();
-
-        return $component->sliceName($name, $nchar);
-    }
-
-    /** Set view */
-    public function setView(Zend_View_Interface $view)
-    {
-        $this->view = $view;
+        return htmlspecialchars(UtilityComponent::sliceName($name, $nchar), ENT_QUOTES, 'UTF-8');
     }
 }

core/views/helpers/T.php

@@ -19,19 +19,18 @@
 =========================================================================*/
 
 /** Translation view helper. */
-class Zend_View_Helper_T
+class Zend_View_Helper_T extends Zend_View_Helper_Abstract
 {
-    /** Translation view helper. */
+    /**
+     * Translation view helper.
+     *
+     * @param string $text text
+     * @return string translated text if available, otherwise the input text
+     */
     public function t($text)
     {
         Zend_Loader::loadClass("InternationalizationComponent", BASE_PATH.'/core/controllers/components');
 
-        return InternationalizationComponent::translate($text);
-    }
-
-    /** Set the view. */
-    public function setView(Zend_View_Interface $view)
-    {
-        $this->view = $view;
+        return htmlspecialchars(InternationalizationComponent::translate($text), ENT_QUOTES, 'UTF-8');
     }
 }

core/views/helpers/Userthumbnail.php

@@ -19,11 +19,19 @@
 =========================================================================*/
 
 /** User thumbnail view helper. */
-class Zend_View_Helper_Userthumbnail
+class Zend_View_Helper_Userthumbnail extends Zend_View_Helper_Abstract
 {
-    /** User thumbnail view helper. */
+    /**
+     * User thumbnail view helper.
+     *
+     * @param string $thumbnail link to thumbnail, if any
+     * @param string $id value of id attribute
+     */
     public function userthumbnail($thumbnail, $id = '')
     {
+        $id = htmlspecialchars($id, ENT_QUOTES, 'UTF-8');
+        $thumbnail = htmlspecialchars($thumbnail, ENT_QUOTES, 'UTF-8');
+
         if (empty($thumbnail)) {
             echo '<img id="'.$id.'" class="thumbnailSmall" src="'.$this->view->coreWebroot.'/public/images/icons/unknownUser.png" alt="" />';
         } elseif (preg_match("@^https?://@", $thumbnail)) {
@@ -32,10 +40,4 @@ public function userthumbnail($thumbnail, $id = '')
             echo '<img id="'.$id.'" class="thumbnailSmall" src="'.$this->view->webroot.'/'.$thumbnail.'" alt="" />';
         }
     }
-
-    /** Set the view. */
-    public function setView(Zend_View_Interface $view)
-    {
-        $this->view = $view;
-    }
 }

core/views/licenses/view.phtml

@@ -18,11 +18,8 @@
  limitations under the License.
 =========================================================================*/
 ?>
-<link type="text/css" rel="stylesheet"
-      href="<?php echo $this->coreWebroot ?>/public/css/common/common.genericPage.css"/>
+<link type="text/css" rel="stylesheet" href="<?php echo $this->coreWebroot ?>/public/css/common/common.genericPage.css" />
 
 <div class="licenseView">
-    <?php
-    echo $this->license->getFulltext();
-    ?>
+    <?php echo $this->markdown($this->license->getFulltext()); ?>
 </div>