Replacing tabs with spaces, trimming white space at EOL and newline at EOF
[squirrelmail.git] / src / addressbook.php
index 64baea9626746a916230b6c4a8a646a945ab05e8..09a5a41bb85587744bdd393633066fea870b9441 100644 (file)
@@ -3,93 +3,80 @@
 /**
  * addressbook.php
  *
- * Copyright (c) 1999-2002 The SquirrelMail Project Team
+ * Copyright (c) 1999-2004 The SquirrelMail Project Team
  * Licensed under the GNU GPL. For full terms see the file COPYING.
  *
  * Manage personal address book.
  *
- * $Id$
+ * @version $Id$
+ * @package squirrelmail
+ * @subpackage addressbook
  */
 
-require_once('../src/validate.php');
-require_once('../functions/array.php');
-require_once('../functions/display_messages.php');
-require_once('../functions/addressbook.php');
-
-/* Sort array by the key "name" */
-function alistcmp($a,$b) {
-    if($a['backend'] > $b['backend']) {
-        return 1;
-    } else {
-        if($a['backend'] < $b['backend']) {
-            return -1;
-        }
-    }
-    return (strtolower($a['name']) > strtolower($b['name'])) ? 1 : -1;
-}
-
-/* Make an input field */
-function adressbook_inp_field($label, $field, $name, $size, $values, $add) {
-    global $color;
-    echo '<TR><TD BGCOLOR="' . $color[4] . '" ALIGN=RIGHT>' .
-         $label . ':</TD>' .
-         '<TD BGCOLOR="' . $color[4] . '" ALIGN=left>' .
-         '<INPUT NAME="' . $name . '[' . $field . ']" SIZE="' . $size . '" VALUE="';
-    if (isset($values[$field])) {
-        echo htmlspecialchars($values[$field]);
-    }
-    echo '">' . $add . '</TD></TR>' . "\n";
-}
-
-/* Output form to add and modify address data */
-function address_form($name, $submittext, $values = array()) {
-    global $color;
-
-    echo '<TABLE BORDER=0 CELLPADDING=1 COLS=2 WIDTH="90%" ALIGN=center>' ."\n";
-
-    adressbook_inp_field(_("Nickname"),     'nickname', $name, 15, $values,
-        '<SMALL>' . _("Must be unique") . '</SMALL>');
-    adressbook_inp_field(_("E-mail address"),  'email', $name, 45, $values, '');
-    adressbook_inp_field(_("First name"),  'firstname', $name, 45, $values, '');
-    adressbook_inp_field(_("Last name"),    'lastname', $name, 45, $values, '');
-    adressbook_inp_field(_("Additional info"), 'label', $name, 45, $values, '');
-
-    echo '<TR><TD COLSPAN=2 BGCOLOR="' . $color[4] . '" ALIGN=center>' . "\n" .
-         '<INPUT TYPE=submit NAME="' . $name . '[SUBMIT]" VALUE="' .
-         $submittext . '"></TD></TR>' .
-         "\n</TABLE>\n";
-}
-
-
-/* Open addressbook, with error messages on but without LDAP (the *
- * second "true"). Don't need LDAP here anyway                    */
-$abook = addressbook_init(true, true);
+/**
+ * Path for SquirrelMail required files.
+ * @ignore
+ */
+define('SM_PATH','../');
+
+/** SquirrelMail required files. */
+require_once(SM_PATH . 'include/validate.php');
+require_once(SM_PATH . 'functions/display_messages.php');
+require_once(SM_PATH . 'functions/addressbook.php');
+require_once(SM_PATH . 'functions/forms.php');
+
+/** lets get the global vars we may need */
+sqgetGlobalVar('key',       $key,           SQ_COOKIE);
+
+sqgetGlobalVar('username',  $username,      SQ_SESSION);
+sqgetGlobalVar('onetimepad',$onetimepad,    SQ_SESSION);
+sqgetGlobalVar('base_uri',  $base_uri,      SQ_SESSION);
+sqgetGlobalVar('delimiter', $delimiter,     SQ_SESSION);
+
+/* From the address form */
+sqgetGlobalVar('addaddr',   $addaddr,   SQ_POST);
+sqgetGlobalVar('editaddr',  $editaddr,  SQ_POST);
+sqgetGlobalVar('deladdr',   $deladdr,   SQ_POST);
+sqgetGlobalVar('sel',       $sel,       SQ_POST);
+sqgetGlobalVar('oldnick',   $oldnick,   SQ_POST);
+sqgetGlobalVar('backend',   $backend,   SQ_POST);
+sqgetGlobalVar('doedit',    $doedit,    SQ_POST);
+
+/* Get sorting order */
+$abook_sort_order = get_abook_sort();
+
+/* Open addressbook with error messages on.
+ remote backends (LDAP) are enabled because they can be used. (list_addr function)
+*/
+$abook = addressbook_init(true, false);
 if($abook->localbackend == 0) {
     plain_error_message(
-        _("No personal address book is defined. Contact administrator."),
-        $color);
+            _("No personal address book is defined. Contact administrator."),
+            $color);
     exit();
 }
 
 displayPageHeader($color, 'None');
 
-
 $defdata   = array();
 $formerror = '';
 $abortform = false;
 $showaddrlist = true;
 $defselected  = array();
-
+$form_url = 'addressbook.php';
 
 /* Handle user's actions */
-if($REQUEST_METHOD == 'POST') {
+if(sqgetGlobalVar('REQUEST_METHOD', $req_method, SQ_SERVER) && $req_method == 'POST') {
 
     /**************************************************
      * Add new address                                *
      **************************************************/
-    if (!empty($addaddr['nickname'])) {
-
-        $r = $abook->add($addaddr, $abook->localbackend);
+    if (isset($addaddr)) {
+        if (isset($backend)) {
+            $r = $abook->add($addaddr, $backend);
+        } else {
+            $r = $abook->add($addaddr, $abook->localbackend);
+        }
 
         /* Handle error messages */
         if (!$r) {
@@ -101,7 +88,6 @@ if($REQUEST_METHOD == 'POST') {
             $showaddrlist = false;
             $defdata = $addaddr;
         }
-
     } else {
 
         /************************************************
@@ -171,20 +157,11 @@ if($REQUEST_METHOD == 'POST') {
                         $olddata = $abook->lookup($enick, $ebackend);
 
                         /* Display the "new address" form */
-                        echo '<FORM ACTION="' . $PHP_SELF . '" METHOD="POST">' .
-                             "\n" .
-                             '<TABLE WIDTH=100% COLS=1 ALIGN=CENTER>' . "\n" .
-                             '<TR><TD BGCOLOR="' . $color[0] .
-                             '" ALIGN=CENTER>' . "\n" . '<STRONG>' .
-                             _("Update address") .
-                             "<STRONG>\n</TD></TR>\n</TABLE>\n";
-                        address_form("editaddr", _("Update address"), $olddata);
-                        echo '<INPUT TYPE=hidden NAME=oldnick VALUE="' . 
-                             htmlspecialchars($olddata["nickname"]) . "\">\n" .
-                             '<INPUT TYPE=hidden NAME=backend VALUE="' .
-                             htmlspecialchars($olddata["backend"]) . "\">\n" .
-                             '<INPUT TYPE=hidden NAME=doedit VALUE=1>' . "\n" .
-                             '</FORM>';
+                        abook_create_form($form_url,'editaddr',_("Update address"),_("Update address"),$olddata);
+                        echo addHidden('oldnick', $olddata['nickname']).
+                            addHidden('backend', $olddata['backend']).
+                            addHidden('doedit', '1').
+                            '</form>';
                     }
                 } else {
 
@@ -196,27 +173,21 @@ if($REQUEST_METHOD == 'POST') {
                         /* Handle error messages */
                         if (!$r) {
                             /* Display error */
-                            echo '<TABLE WIDTH=100% COLS=1 ALIGN=CENTER>' .
-                                 "\n" . '<TR><TD ALIGN=CENTER>' . "\n" .
-                                 '<br><STRONG><FONT COLOR="' . $color[2] .
-                                 '">' . _("ERROR") . ": " . $abook->error .
-                                 '</FONT><STRONG>' . "\n</TD></TR>\n</TABLE>\n";
+                            echo html_tag( 'table',
+                                    html_tag( 'tr',
+                                        html_tag( 'td',
+                                            "\n". '<strong><font color="' . $color[2] .
+                                            '">' . _("ERROR") . ': ' . $abook->error . '</font></strong>' ."\n",
+                                            'center' )
+                                        ),
+                                    'center', '', 'width="100%"' );
 
                             /* Display the "new address" form again */
-                            echo '<FORM ACTION="' . $PHP_SELF .
-                                 '" METHOD="POST">' . "\n" .
-                                 '<TABLE WIDTH=100% COLS=1 ALIGN=CENTER>' .
-                                 "\n" . '<TR><TD BGCOLOR="' . $color[0] .
-                                 '" ALIGN=CENTER>' . "\n" . '<STRONG>' .
-                                 _("Update address") .
-                                 "<STRONG>\n</TD></TR>\n</TABLE>\n";
-                            address_form("editaddr", _("Update address"), $newdata);
-                            echo '<INPUT TYPE=hidden NAME=oldnick VALUE="' .
-                                 htmlspecialchars($oldnick) . "\">\n" .
-                                 '<INPUT TYPE=hidden NAME=backend VALUE="' .
-                                 htmlspecialchars($backend) . "\">\n" .
-                                 '<INPUT TYPE=hidden NAME=doedit VALUE=1>' .
-                                 "\n" . '</FORM>';
+                            abook_create_form($form_url,'editaddr',_("Update address"),_("Update address"),$newdata);
+                            echo addHidden('oldnick', $oldnick).
+                                addHidden('backend', $backend).
+                                addHidden('doedit',  '1').
+                                "\n" . '</form>';
                             $abortform = true;
                         }
                     } else {
@@ -232,8 +203,8 @@ if($REQUEST_METHOD == 'POST') {
 
     // Some times we end output before forms are printed
     if($abortform) {
-       echo "</BODY></HTML>\n";
-       exit();
+        echo "</body></html>\n";
+        exit();
     }
 }
 
@@ -245,10 +216,14 @@ if($REQUEST_METHOD == 'POST') {
 
 /* Display error messages */
 if (!empty($formerror)) {
-    echo '<TABLE WIDTH=100% COLS=1 ALIGN=CENTER>' . "\n" .
-         '<TR><TD ALIGN=CENTER>' . "\n" . '<br><STRONG>' .
-         '<FONT COLOR="' . $color[2]. '">' . _("ERROR") . ': ' . $formerror .
-         '</FONT><STRONG>' . "\n</TD></TR>\n</TABLE>\n";
+    echo html_tag( 'table',
+            html_tag( 'tr',
+                html_tag( 'td',
+                    "\n". '<br /><strong><font color="' . $color[2] .
+                    '">' . _("ERROR") . ': ' . $formerror . '</font></strong>' ."\n",
+                    'center' )
+                ),
+            'center', '', 'width="100%"' );
 }
 
 
@@ -265,92 +240,141 @@ if ($showaddrlist) {
     $prevbackend = -1;
     $headerprinted = false;
 
-    echo '<p align=center><a href="#AddAddress">' .
-         _("Add address") . "</a></p>\n";
+    echo html_tag( 'p', '<a href="#AddAddress">' . _("Add address") . '</a>', 'center' ) . "\n";
 
     /* List addresses */
-    echo '<FORM ACTION="' . $PHP_SELF . '" METHOD="POST">' . "\n";
-    while(list($undef,$row) = each($alist)) {
-
-        /* New table header for each backend */
-        if($prevbackend != $row['backend']) {
-            if($prevbackend >= 0) {
-                echo '<TR><TD COLSPAN=5 ALIGN=center>' . "\n" .
-                     '<INPUT TYPE=submit NAME=editaddr VALUE="' . 
-                     _("Edit selected") . "\">\n" .
-                     '<INPUT TYPE=submit NAME=deladdr VALUE="' .
-                     _("Delete selected") . "\">\n</tr>\n" .
-                     '<TR><TD COLSPAN="5" ALIGN=center>' .
-                     '&nbsp;<BR></TD></TR></TABLE>' . "\n";
-            }
+    if (count($alist) > 0) {
+        echo addForm($form_url, 'post');
+        while(list($undef,$row) = each($alist)) {
+
+            /* New table header for each backend */
+            if($prevbackend != $row['backend']) {
+                if($prevbackend < 0) {
+                    echo html_tag( 'table',
+                            html_tag( 'tr',
+                                html_tag( 'td',
+                                    addSubmit(_("Edit selected"), 'editaddr').
+                                    addSubmit(_("Delete selected"), 'deladdr'),
+                                    'center', '', 'colspan="5"' )
+                                ) .
+                            html_tag( 'tr',
+                                html_tag( 'td', '&nbsp;<br />', 'center', '', 'colspan="5"' )
+                                ),
+                            'center' );
+                    echo "\n<!-- start of address book table -->\n" .
+                        html_tag( 'table', '', 'center', '', 'border="0" cellpadding="1" cellspacing="0" width="90%"' ) .
+                        html_tag( 'tr', "\n" .
+                                html_tag( 'th', '&nbsp;', 'left', '', 'width="1%"' ) . "\n" .
+                                html_tag( 'th', _("Nickname") .
+                                    show_abook_sort_button($abook_sort_order, _("sort by nickname"), 0, 1),
+                                    'left', '', 'width="1%"' ) . "\n" .
+                                html_tag( 'th', _("Name") .
+                                    show_abook_sort_button($abook_sort_order, _("sort by name"), 2, 3),
+                                    'left', '', 'width="1%"' ) . "\n" .
+                                html_tag( 'th', _("E-mail") .
+                                    show_abook_sort_button($abook_sort_order, _("sort by email"), 4, 5),
+                                    'left', '', 'width="1%"' ) . "\n" .
+                                html_tag( 'th', _("Info") .
+                                    show_abook_sort_button($abook_sort_order, _("sort by info"), 6, 7),
+                                    'left', '', 'width="1%"' ) . "\n",
+                                '', $color[9] ) . "\n";
+                }
 
-            echo '<TABLE WIDTH="95%" COLS=1 ALIGN=CENTER>' . "\n" .
-                 '<TR><TD BGCOLOR="' . $color[0] . '" ALIGN=CENTER>' . "\n" .
-                 '<STRONG>' . $row['source'] .
-                 "<STRONG>\n</TD></TR>\n</TABLE>\n" .
-                 '<TABLE COLS="5" BORDER="0" CELLPADDING="1" CELLSPACING="0"' .
-                 ' WIDTH="90%" ALIGN="center">' .
-                 '<TR BGCOLOR="' . $color[9] .
-                 '"><TH ALIGN=left WIDTH="1%">&nbsp;<TH ALIGN=left WIDTH="1%">' .
-                 _("Nickname") . '<TH ALIGN=left WIDTH="1%">' . _("Name") .
-                 '<TH ALIGN=left WIDTH="1%">' . _("E-mail") .
-                 '<TH ALIGN=left WIDTH="%">' . _("Info") . "</TR>\n";
-
-            $line = 0;
-            $headerprinted = true;
-        } /* End of header */
-
-        $prevbackend = $row['backend'];
-
-        /* Check if this user is selected */
-        if(in_array($row['backend'] . ':' . $row['nickname'], $defselected)) {
-            $selected = 'CHECKED';
-        } else {
-            $selected = '';
-        }
+                // Separate different backends with <hr />
+                if($prevbackend > 0) {
+                    echo  html_tag( 'tr',
+                            html_tag( 'td', "<hr />", 'center', '' ,'colspan="5"' )
+                            );
+                }
 
-        /* Print one row */
-        echo '<TR';
-        if ($line % 2) { echo ' bgcolor="' . $color[0]. '"'; }
-        echo '><TD VALIGN=top ALIGN=center WIDTH="1%"><SMALL>' .
-             '<INPUT TYPE=checkbox ' . $selected . ' NAME="sel[]" VALUE="' .
-             $row['backend'] . ':' . $row['nickname'] . '"></SMALL></TD>' .
-             '<TD VALIGN=top NOWRAP WIDTH="1%">&nbsp;' . $row['nickname'] .
-             '&nbsp;</TD>' .
-             '<TD VALIGN=top NOWRAP WIDTH="1%">&nbsp;' . $row['name'] .
-             '&nbsp;</TD>',
-             '<TD VALIGN=top NOWRAP WIDTH="1%">&nbsp;' .
-             '<A HREF="compose.php?send_to=' . rawurlencode($row['email']) .
-             '">' . $row['email'] . '</A>&nbsp;</TD>'."\n",
-             '<TD VALIGN=top WIDTH="1%">&nbsp;' . $row['label'] . '&nbsp;</TD>' .
-             "</TR>\n";
-        $line++;
-    }
+                // Print backend name
+                echo  html_tag( 'tr',
+                        html_tag( 'td', "\n" . '<strong>' . $row['source'] . '</strong>' . "\n", 'center', $color[0] ,'colspan="5"' )
+                        );
+
+                $line = 0;
+                $headerprinted = true;
+            } /* End of header */
+
+            $prevbackend = $row['backend'];
 
-    /* End of list. Close table. */
-    if ($headerprinted) {
-        echo '<TR><TD COLSPAN=5 ALIGN=center>' . "\n" .
-             '<INPUT TYPE=submit NAME=editaddr VALUE="' . _("Edit selected") .
-             "\">\n" .
-             '<INPUT TYPE=submit NAME=deladdr VALUE="' . _("Delete selected") .
-             "\">\n" . '</TR></TABLE></FORM>';
+            /* Check if this user is selected */
+            $selected = in_array($row['backend'] . ':' . $row['nickname'], $defselected);
+
+            /* Print one row, with alternating color */
+            if ($line % 2) {
+                $tr_bgcolor = $color[12];
+            } else {
+                $tr_bgcolor = $color[4];
+            }
+            if ($squirrelmail_language == 'ja_JP') {
+                echo html_tag( 'tr', '', '', $tr_bgcolor);
+                if ($abook->backends[$row['backend']]->writeable) {
+                    echo html_tag( 'td',
+                            '<small>' .
+                            addCheckBox('sel[]', $selected, $row['backend'].':'.$row['nickname']).
+                            '</small>' ,
+                            'center', '', 'valign="top" width="1%"' );
+                } else {
+                    echo html_tag( 'td',
+                            '&nbsp;' ,
+                            'center', '', 'valign="top" width="1%"' );
+                }
+                echo html_tag( 'td', '&nbsp;' . $row['nickname'] . '&nbsp;', 'left', '', 'valign="top" width="1%" nowrap' ) .
+                    html_tag( 'td', '&nbsp;' . $row['lastname'] . ' ' . $row['firstname'] . '&nbsp;', 'left', '', 'valign="top" width="1%" nowrap' ) .
+                    html_tag( 'td', '', 'left', '', 'valign="top" width="1%" nowrap' ) . '&nbsp;';
+            } else {
+                echo html_tag( 'tr', '', '', $tr_bgcolor);
+                if ($abook->backends[$row['backend']]->writeable) {
+                    echo html_tag( 'td',
+                            '<small>' .
+                            addCheckBox('sel[]', $selected, $row['backend'] . ':' . $row['nickname']).
+                            '</small>' ,
+                            'center', '', 'valign="top" width="1%"' );
+                } else {
+                    echo html_tag( 'td',
+                            '&nbsp;' ,
+                            'center', '', 'valign="top" width="1%"' );
+                }
+                echo html_tag( 'td', '&nbsp;' . $row['nickname'] . '&nbsp;', 'left', '', 'valign="top" width="1%" nowrap' ) .
+                    html_tag( 'td', '&nbsp;' . $row['name'] . '&nbsp;', 'left', '', 'valign="top" width="1%" nowrap' ) .
+                    html_tag( 'td', '', 'left', '', 'valign="top" width="1%" nowrap' ) . '&nbsp;';
+            }
+            $email = $abook->full_address($row);
+            echo makeComposeLink('src/compose.php?send_to='.rawurlencode($email),
+                    htmlspecialchars($row['email'])).
+                '&nbsp;</td>'."\n".
+                html_tag( 'td', '&nbsp;' . htmlspecialchars($row['label']) . '&nbsp;', 'left', '', 'valign="top" width="1%"' ) .
+                "</tr>\n";
+            $line++;
+        }
+        echo "</table>" .
+            "\n<!-- end of address book table -->\n";
+
+        /* End of list. Add edit/delete select buttons */
+        if ($headerprinted) {
+            echo html_tag( 'table',
+                    html_tag( 'tr',
+                        html_tag( 'td',
+                            addSubmit(_("Edit selected"), 'editaddr') .
+                            addSubmit(_("Delete selected"), 'deladdr'),
+                            'center', '', 'colspan="5"' )
+                        ),
+                    'center' );
+        }
+        echo "</form>\n";
     }
 } /* end of addresslist */
 
 
 /* Display the "new address" form */
-echo '<a name="AddAddress"></a>' . "\n" .
-     '<FORM ACTION="' . $PHP_SELF . '" NAME=f_add METHOD="POST">' . "\n" .
-     '<TABLE WIDTH=100% COLS=1 ALIGN=CENTER>' . "\n" .
-     '<TR><TD BGCOLOR="' . $color[0] . '" ALIGN=CENTER>' . "\n" . '<STRONG>',
-     sprintf(_("Add to %s"), $abook->localbackendname) .
-     "<STRONG>\n</TD></TR>\n" .
-     "</TABLE>\n";
-address_form('addaddr', _("Add address"), $defdata);
-echo '</FORM>';
+echo '<a name="AddAddress"></a>' . "\n";
+abook_create_form($form_url,'addaddr',_("Add to address book"),_("Add address"),$defdata);
+echo "</form>\n";
 
 /* Add hook for anything that wants on the bottom */
+echo "<!-- start of addressbook_bottom hook-->\n";
 do_hook('addressbook_bottom');
+echo "\n<!-- end of addressbook_bottom hook-->\n";
 ?>
-
-</BODY></HTML>
+</body></html>
\ No newline at end of file