Legacy code was probably wrong

[squirrelmail.git] / functions / template / general_util.php

diff --git a/functions/template/general_util.php b/functions/template/general_util.php
index bcae35e9417dc07b7b1b95fd7f63250a7dde5a47..3970c710e6e3cc7f6db62a4d6878a568cdf95b4f 100644 (file)
--- a/functions/template/general_util.php
+++ b/functions/template/general_util.php
@@ -6,7 +6,7 @@
  * This file is intended to contain helper functions for template sets
  * that would like to use them.
  *
- * @copyright © 1999-2006 The SquirrelMail Project Team
+ * @copyright 1999-2017 The SquirrelMail Project Team
  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  * @version $Id$
  * @package squirrelmail
@@ -21,18 +21,14 @@
   * @param boolean $alt       Whether or not this is an alternate 
   *                           stylesheet (optional; default TRUE).
   * @param string  $mtype     The target media display type (optional; default "screen").
-  * @param string  $xhtml_end The XHTML-compliant close tag syntax to 
-  *                           use (optional; default "/")
   *
   * @return string The full text of the stylesheet link.
   *
   */
-function create_css_link($uri, $name='', $alt=TRUE, $mtype='screen', $xhtml_end='/') {
+function create_css_link($uri, $name='', $alt=TRUE, $mtype='screen') {
 // FIXME: Add closing / to link and meta elements only after 
 //        switching to xhtml 1.0 Transitional.
 //        It is not compatible with html 4.01 Transitional
-$xhtml_end='';
-
     if (empty($uri)) {
         return '';
     }
@@ -72,25 +68,27 @@ $xhtml_end='';
         $rel   = 'rel="'.( $alt ? 'alternate ' : '' ).'stylesheet" ';
     }
 
-    return '<link '.$media.$title.$rel.'type="text/css" '.$href." $xhtml_end>\n";
+    return '<link '.$media.$title.$rel.'type="text/css" '.$href." />\n";
 }
 
 
 /**
- * Checks for an image icon and returns a complete HTML img tag or a text
+ * Checks for an image icon and returns a complete image tag or a text
  * string with the text icon based on what is found and user prefs.
  *
  * @param string $icon_theme_path User's chosen icon set
  * @param string $icon_name File name of the desired icon
  * @param string $text_icon Text-based icon to display if desired
- * @param string $alt_text Optional.  Text for alt/title attribute of image
+ * @param string $alt_text Text for alt/title attribute of image
  * @param integer $w Optional.  Width of requested image.
  * @param integer $h Optional.  Height of requested image.
+ *
  * @return string $icon String containing icon that can be echo'ed
+ *
  * @author Steve Brown
  * @since 1.5.2
  */
-function getIcon($icon_theme_path, $icon_name, $text_icon, $alt_text='', $w=NULL, $h=NULL) {
+function getIcon($icon_theme_path, $icon_name, $text_icon, $alt_text, $w=NULL, $h=NULL) {
     $icon = '';
     if (is_null($icon_theme_path)) {
         $icon = $text_icon;
@@ -100,12 +98,8 @@ function getIcon($icon_theme_path, $icon_name, $text_icon, $alt_text='', $w=NULL
         // If we found an icon, build an img tag to display it.  If we didn't
         // find an image, we will revert back to the text icon.
         if (!is_null($icon_path)) {
-            $icon = '<img src="'.$icon_path.'" ' .
-                    'alt="'.$alt_text.'" '.
-                    (!empty($alt_text) ? 'title="'.$alt_text.'" ' : '') .
-                    (!is_null($w) ? 'width="'.$w.'" ' : '') .
-                    (!is_null($h) ? 'height="'.$h.'" ' : '') .
-                    ' />';
+            $icon = create_image($icon_path, $alt_text, $w, $h, '', '', '', 
+                                 '', $alt_text, '', '', '', $text_icon);
         } else {
             $icon = $text_icon;
         }
@@ -121,10 +115,13 @@ function getIcon($icon_theme_path, $icon_name, $text_icon, $alt_text='', $w=NULL
  *
  * @param string $icon_theme_path User's chosen icon set
  * @param string $icon_name File name of the desired icon
+ *
  * @return string $icon String containing path to icon that can be used in
  *                      an IMG tag, or NULL if the image is not found.
+ *
  * @author Steve Brown
  * @since 1.5.2
+ *
  */
 function getIconPath ($icon_theme_path, $icon_name) {
     global $fallback_icon_theme_path;
@@ -133,14 +130,17 @@ function getIconPath ($icon_theme_path, $icon_name) {
         return NULL;
 
     // Desired icon exists in the current theme?
+//FIXME: this assumes a URI path will be valid when used as a filesystem path - this will fail for some systems -- OTOH, if $icon_theme_path is meant as an internal filesystem path to the user's chosen theme directory, then the assumption that is wrong here is that this internal filesystem path is always correct for use as part of a URI.  This really should be mapped to/from an internal path to a URI path -- or can we guarantee that the two are always the same?
     if (is_file($icon_theme_path . $icon_name)) {
         return $icon_theme_path . $icon_name;
 
     // Icon not found, check for the admin-specified fallback
+//FIXME: same problem here as above
     } elseif (!is_null($fallback_icon_theme_path) && is_file($fallback_icon_theme_path . $icon_name)) {
         return $fallback_icon_theme_path . $icon_name;
 
     // Icon not found, return the SQM default icon
+//FIXME: same problem here -- SM_PATH is *NOT* intended for use in URIs
     } elseif (is_file(SM_PATH . 'images/themes/default/'.$icon_name)) {
         return SM_PATH . 'images/themes/default/'.$icon_name;
     }
@@ -175,5 +175,3 @@ function displayErrors () {
 function humanReadableSize ($size) {
     return show_readable_size($size);
 }
-
-