Make sure generated links use & instead of & between GET vars.
[squirrelmail.git] / functions / html.php
index 6666cd640d768839f7f903cbeeb84d55b63de476..217ecfe022aba86e83bd01ef54f822a6fb8d27e6 100644 (file)
 /**
  * html.php
  *
- * Copyright (c) 1999-2002 The SquirrelMail Project Team
- * Licensed under the GNU GPL. For full terms see the file COPYING.
- *
  * The idea is to inlcude here some functions to make easier
  * the right to left implementation by "functionize" some
  * html outputs.
  *
- * $Id$
+ * @copyright © 1999-2006 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
+ * @package squirrelmail
+ * @since 1.3.0
  */
 
-    function html_tag( $tag,                // Tag to output
-                       $val = '',           // Value between tags (if empty only start tag is issued)
+/**
+ * Generates html tags
+ *
+ * @param string $tag Tag to output
+ * @param string $val Value between tags
+ * @param string $align Alignment (left, center, etc)
+ * @param string $bgcolor Back color in hexadecimal
+ * @param string $xtra Extra options
+ * @return string HTML ready for output
+ * @since 1.3.0
+ */
+function html_tag( $tag,                // Tag to output
+                       $val = '',           // Value between tags
                        $align = '',         // Alignment
                        $bgcolor = '',       // Back color
                        $xtra = '' ) {       // Extra options
-                        
-       GLOBAL $languages, $squirrelmail_language;
-       
-       $align = strtolower( $align );
-       $dir   = strtolower( $dir );
-       $tag = strtoupper( $tag );
-       
-       if ( isset( $languages[$squirrelmail_language]['DIR']) ) {
-           $dir = $languages[$squirrelmail_language]['DIR'];
-       } else {
-           $dir = 'ltr';
-       }
-
-       if ( $dir == 'ltr' ) {
-           $rgt = 'right';
-           $lft = 'left';              
-       } else {
-           $rgt = 'left';
-           $lft = 'right';     
-       }
-       
-       if ( $bgcolor <> '' ) {
-           $bgc = " BGCOLOR=\"$bgcolor\""; 
-       }
-
-       switch ( $align ) {
-       case '':
-           $alg = '';
-           break;
-       case 'right':
-           $alg = " ALIGN=\"$rgt\"";
-           break;
-        case 'left':               
-            $alg = " ALIGN=\"$lft\"";
-            break;
-       default:
-           $alg = " ALIGN=\"$align\"";
-           break;
-       }
-       
-       $ret = "<$tag";
-           
-       if ( $dir <> 'ltr' ) {
-           $ret .= " DIR=\"$dir\"";
-       }
-       $ret .= "$bgc$alg";
-           
-       if ( $xtra <> '' ) {
-           $ret .= " $xtra";
-       }
-       $ret .= '>';
-           
-       if ( $val <> '' ) {
-           $ret .= "$val</$tag>";
-       }
-       
-        return( $ret );
+
+    GLOBAL $languages, $squirrelmail_language;
+
+    $align = strtolower( $align );
+    $bgc = '';
+    $tag = strtolower( $tag );
+
+    if ( isset( $languages[$squirrelmail_language]['DIR']) ) {
+        $dir = $languages[$squirrelmail_language]['DIR'];
+    } else {
+        $dir = 'ltr';
+    }
+
+    if ( $dir == 'ltr' ) {
+        $rgt = 'right';
+        $lft = 'left';
+    } else {
+        $rgt = 'left';
+        $lft = 'right';
+    }
+
+    if ( $bgcolor <> '' ) {
+        $bgc = " bgcolor=\"$bgcolor\"";
+    }
+
+    switch ( $align ) {
+    case '':
+        $alg = '';
+        break;
+    case 'right':
+        $alg = " align=\"$rgt\"";
+        break;
+    case 'left':
+        $alg = " align=\"$lft\"";
+        break;
+    default:
+        $alg = " align=\"$align\"";
+        break;
+    }
+
+    $ret = "<$tag";
+
+    if ( $dir <> 'ltr' ) {
+        $ret .= " dir=\"$dir\"";
+    }
+    $ret .= $bgc . $alg;
+
+    if ( $xtra <> '' ) {
+        $ret .= " $xtra";
+    }
+
+    if ( $val <> '' ) {
+        $ret .= ">$val</$tag>\n";
+    } else {
+        $ret .= '>'. "\n";
+    }
+
+    return( $ret );
+}
+
+/**
+ * handy function to set url vars
+ *
+ * especially useful when $url = $PHP_SELF
+ * @param string $url url that must be modified
+ * @param string $var 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 */
+                    );
+    $url = preg_replace('/&amp;/','&',$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";
+            }
+        }
+        break;
     }
 
-?>
\ No newline at end of file
+    if ($k) {
+        if ($val) {
+            $rpl = "$k=$val";
+            if ($link) {
+                $rpl = preg_replace('/&/','&amp;',$rpl);
+            }
+        } else {
+            $rpl = '';
+        }
+        if( substr($v,-1)=='&' ) {
+            $rpl .= '&';
+        }
+        $pat = "/$k=$v/";
+        $url = preg_replace($pat,$rpl,$url);
+    }
+    $url = preg_replace('/&/','&amp;',$url);
+    return $url;
+}