Fix broken set_url_var function in functions/html.php (#1729814).
[squirrelmail.git] / functions / html.php
index 004565ba711af6153a0ae27b204aa9d18305dfe2..2df57f2e7aa0e9550a2e1639a06e7070ae1e5d48 100644 (file)
  * the right to left implementation by "functionize" some
  * html outputs.
  *
- * @copyright © 1999-2006 The SquirrelMail Project Team
+ * @copyright © 1999-2007 The SquirrelMail Project Team
  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  * @version $Id$
  * @package squirrelmail
  * @since 1.3.0
  */
 
+
+/**
+ * Generates a hyperlink
+ *
+ * @param string $uri      The target link location
+ * @param string $text     The link text 
+ * @param string $target   The location where the link should 
+ *                         be opened (OPTIONAL; default not used)
+ * @param string $onclick  The onClick JavaScript handler (OPTIONAL; 
+ *                         default not used)
+ * @param string $class    The CSS class name (OPTIONAL; default
+ *                         not used)
+ * @param string $id       The ID name (OPTIONAL; default not used)
+ * @param string $name     The anchor name (OPTIONAL; default not used)
+ * @param array  $aAttribs Any extra attributes: this must be an 
+ *                         associative array, where keys will be 
+ *                         added as the attribute name, and values
+ *                         (which are optional - should be null if
+ *                         none should be used) will be placed in
+ *                         double quotes (pending template implementation)
+ *                         as the attribute value (OPTIONAL; default empty).
+ *
+ * @return string The desired hyperlink tag.
+ *
+ * @since 1.5.2
+ *
+ */
+function create_hyperlink($uri, $text, $target='', $onclick='', 
+                          $class='', $id='', $name='', $aAttribs=array()) {
+
+    global $oTemplate;
+
+    $oTemplate->assign('uri', $uri);
+    $oTemplate->assign('text', $text);
+    $oTemplate->assign('target', $target);
+    $oTemplate->assign('onclick', $onclick);
+    $oTemplate->assign('class', $class);
+    $oTemplate->assign('id', $id);
+    $oTemplate->assign('name', $name);
+
+    $oTemplate->assign('aAttribs', $aAttribs);
+
+    return $oTemplate->fetch('hyperlink.tpl');
+
+}
+
+
+/**
+ * Generates an image tag
+ *
+ * @param string $src     The image source path
+ * @param string $alt     Alternate link text (OPTIONAL; default 
+ *                        not used)
+ * @param string $width   The width the image should be shown in 
+ *                        (OPTIONAL; default not used)
+ * @param string $height  The height the image should be shown in 
+ *                        (OPTIONAL; default not used)
+ * @param string $border  The image's border attribute value 
+ *                        (OPTIONAL; default not used)
+ * @param string $class   The CSS class name (OPTIONAL; default
+ *                        not used)
+ * @param string $id      The ID name (OPTIONAL; default not used)
+ * @param string $onclick The onClick JavaScript handler (OPTIONAL;
+ *                        default not used)
+ * @param string $title   The image's title attribute value 
+ *                        (OPTIONAL; default not used)
+ * @param string $align   The image's alignment attribute value 
+ *                        (OPTIONAL; default not used)
+ * @param string $hspace  The image's hspace attribute value 
+ *                        (OPTIONAL; default not used)
+ * @param string $vspace  The image's vspace attribute value 
+ *                        (OPTIONAL; default not used)
+ * @param string $text_alternative A text replacement for the entire
+ *                                 image tag, to be used at the 
+ *                                 discretion of the template set,
+ *                                 if for some reason the image tag
+ *                                 cannot or should not be produced
+ *                                 (OPTIONAL; default not used)
+ * @param array  $aAttribs Any extra attributes: this must be an 
+ *                         associative array, where keys will be 
+ *                         added as the attribute name, and values
+ *                         (which are optional - should be null if
+ *                         none should be used) will be placed in
+ *                         double quotes (pending template implementation)
+ *                         as the attribute value (OPTIONAL; default empty).
+ *
+ * @return string The desired hyperlink tag.
+ *
+ * @since 1.5.2
+ *
+ */
+function create_image($src, $alt='', $width='', $height='', 
+                      $border='', $class='', $id='', $onclick='', 
+                      $title='', $align='', $hspace='', $vspace='',
+                      $text_alternative='', $aAttribs=array()) {
+
+    global $oTemplate;
+
+    $oTemplate->assign('src', $src);
+    $oTemplate->assign('alt', $alt);
+    $oTemplate->assign('width', $width);
+    $oTemplate->assign('height', $height);
+    $oTemplate->assign('border', $border);
+    $oTemplate->assign('class', $class);
+    $oTemplate->assign('id', $id);
+    $oTemplate->assign('onclick', $onclick);
+    $oTemplate->assign('title', $title);
+    $oTemplate->assign('align', $align);
+    $oTemplate->assign('hspace', $hspace);
+    $oTemplate->assign('vspace', $vspace);
+    $oTemplate->assign('text_alternative', $text_alternative);
+
+    $oTemplate->assign('aAttribs', $aAttribs);
+
+    return $oTemplate->fetch('image.tpl');
+
+}
+
+
+/**
+ * Generates a label tag
+ *
+ * @param string $value    The contents that belong inside the label
+ * @param string $for      The ID to which the label applies (OPTIONAL; 
+ *                         default not used)
+ * @param array  $aAttribs Any extra attributes: this must be an
+ *                         associative array, where keys will be
+ *                         added as the attribute name, and values
+ *                         (which are optional - should be null if
+ *                         none should be used) will be placed in
+ *                         double quotes (pending template implementation)
+ *                         as the attribute value (OPTIONAL; default empty).
+ *
+ * @return string The desired label tag.
+ *
+ * @since 1.5.2
+ *
+ */
+function create_label($value, $for='', $aAttribs=array()) {
+
+    global $oTemplate;
+
+    $oTemplate->assign('text', $value);
+    $oTemplate->assign('for', $for);
+
+    $oTemplate->assign('aAttribs', $aAttribs);
+
+    return $oTemplate->fetch('label.tpl');
+
+}
+
+
+/**
+ * Generates a span tag
+ *
+ * @param string $value   The contents that belong inside the span
+ * @param string $class   The CSS class name (OPTIONAL; default
+ *                        not used)
+ * @param string $id      The ID name (OPTIONAL; default not used)
+ * @param array  $aAttribs Any extra attributes: this must be an 
+ *                         associative array, where keys will be 
+ *                         added as the attribute name, and values
+ *                         (which are optional - should be null if
+ *                         none should be used) will be placed in
+ *                         double quotes (pending template implementation)
+ *                         as the attribute value (OPTIONAL; default empty).
+ *
+ * @return string The desired span tag.
+ *
+ * @since 1.5.2
+ *
+ */
+function create_span($value, $class='', $id='', $aAttribs=array()) {
+
+    global $oTemplate;
+
+    $oTemplate->assign('value', $value);
+    $oTemplate->assign('class', $class);
+    $oTemplate->assign('id', $id);
+
+    $oTemplate->assign('aAttribs', $aAttribs);
+
+    return $oTemplate->fetch('span.tpl');
+
+}
+
+
+/**
+ * Generates an opening body tag
+ *
+ * @param string $onload  Body onload JavaScript handler code  
+ *                        (OPTIONAL; default not used)
+ * @param string $class   The CSS class name (OPTIONAL; default
+ *                        not used)
+ * @param array  $aAttribs Any extra attributes: this must be an 
+ *                         associative array, where keys will be 
+ *                         added as the attribute name, and values
+ *                         (which are optional - should be null if
+ *                         none should be used) will be placed in
+ *                         double quotes (pending template implementation)
+ *                         as the attribute value (OPTIONAL; default empty).
+ *
+ * @return string The desired body tag.
+ *
+ * @since 1.5.2
+ *
+ */
+function create_body($onload='', $class='', $aAttribs=array()) {
+
+    global $oTemplate;
+
+    $oTemplate->assign('onload', $onload);
+    $oTemplate->assign('class', $class);
+
+    $oTemplate->assign('aAttribs', $aAttribs);
+
+    return $oTemplate->fetch('body.tpl');
+
+}
+
+
 /**
  * Generates html tags
+//FIXME: This should not be used anywhere in the core, or we should convert this to use templates.  We sould not be assuming HTML output.
  *
  * @param string $tag Tag to output
  * @param string $val Value between tags
@@ -90,70 +312,63 @@ function html_tag( $tag,                // Tag to output
     return( $ret );
 }
 
+
 /**
- * handy function to set url vars
+ * This function is used to add, modify or delete GET variables in a URL. 
+ * It is especially useful when $url = $PHP_SELF
+ *
+ * Set $val to NULL to remove $var from $url.
+ * To ensure compatibility with older versions, use $val='0' to set $var to 0. 
  *
- * especially useful when $url = $PHP_SELF
  * @param string $url url that must be modified
- * @param string $var variable name
+ * @param string $var GET variable name
  * @param string $val variable value
  * @param boolean $link controls sanitizing of ampersand in urls (since 1.3.2)
+ *
  * @return string $url modified url
+ *
  * @since 1.3.0
+ *
  */
-function set_url_var($url, $var, $val=0, $link=true) {
-    $k = '';
-    $pat_a = array (
-                    '/.+(\\&'.$var.')=(.*)\\&/AU',   /* in the middle */
-                    '/.+\\?('.$var.')=(.*\\&).+/AU', /* at front, more follow */
-                    '/.+(\\?'.$var.')=(.*)$/AU',     /* at front and only var */
-                    '/.+(\\&'.$var.')=(.*)$/AU'      /* at the end */
-                    );
+function set_url_var($url, $var, $val=null, $link=true) {
     $url = str_replace('&','&',$url);
 
-    // FIXME: why switch is used instead of if () or one preg_match()
-    switch (true) {
-    case (preg_match($pat_a[0],$url,$regs)):
-        $k = $regs[1];
-        $v = $regs[2];
-        break;
-    case (preg_match($pat_a[1],$url,$regs)):
-        $k = $regs[1];
-        $v = $regs[2];
-        break;
-    case (preg_match($pat_a[2],$url,$regs)):
-        $k = $regs[1];
-        $v = $regs[2];
-        break;
-    case (preg_match($pat_a[3],$url,$regs)):
-        $k = $regs[1];
-        $v = $regs[2];
-        break;
-    default:
-        if ($val) {
-            if (strpos($url,'?')) {
-                $url .= "&$var=$val";
-            } else {
-                $url .= "?$var=$val";
-            }
+    if (strpos($url, '?') === false) {
+        $url .= '?';
+    }   
+
+    list($uri, $params) = explode('?', $url, 2);
+        
+    $newpar = array(); 
+    $params = explode('&', $params);
+   
+    foreach ($params as $p) {
+        if (trim($p)) {
+            $p = explode('=', $p);
+            $newpar[$p[0]] = (isset($p[1]) ? $p[1] : '');
         }
-        break;
     }
 
-    if ($k) {
-        if ($val) {
-            $rpl = "$k=$val";
-        } else {
-            $rpl = '';
-        }
-        if( substr($v,-1)=='&' ) {
-            $rpl .= '&';
-        }
-        $pat = "/$k=$v/";
-        $url = preg_replace($pat,$rpl,$url);
+    if (is_null($val)) {
+        unset($newpar[$var]);
+    } else {
+        $newpar[$var] = $val;
+    }
+
+    if (!count($newpar)) {
+        return $uri;
     }
+   
+    $url = $uri . '?';
+    foreach ($newpar as $name => $value) {
+        $url .= "$name=$value&";
+    }
+     
+    $url = substr($url, 0, -1);
     if ($link) {
         $url = str_replace('&','&',$url);
     }
+    
     return $url;
 }
+