make a start with adding labels for html form elements. this aids disabled
[squirrelmail.git] / src / addressbook.php
index 2284886cd0031c4ce38d97b7d8f8f39256827db0..f3fb8b1afbdb7bd6366389f70a6e19f008d88883 100644 (file)
@@ -3,82 +3,75 @@
 /**
  * addressbook.php
  *
- * Copyright (c) 1999-2002 The SquirrelMail Project Team
- * Licensed under the GNU GPL. For full terms see the file COPYING.
- *
  * Manage personal address book.
  *
- * $Id$
+ * @copyright © 1999-2006 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @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');
-require_once('../functions/strings.php');
-
-/* 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";
-}
+/**
+ * Include the SquirrelMail initialization file.
+ */
+include('../include/init.php');
 
-/* Output form to add and modify address data */
-function address_form($name, $submittext, $values = array()) {
-    global $color;
+/** SquirrelMail required files. */
+/* address book functions */
+require_once(SM_PATH . 'functions/addressbook.php');
+/* form functions */
+require_once(SM_PATH . 'functions/forms.php');
 
-    echo '<TABLE BORDER=0 CELLPADDING=1 COLS=2 WIDTH="90%" ALIGN=center>' ."\n";
+/** lets get the global vars we may need */
 
-    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, '');
+/* 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);
 
-    echo '<TR><TD COLSPAN=2 BGCOLOR="' . $color[4] . '" ALIGN=center>' . "\n" .
-         '<INPUT TYPE=submit NAME="' . $name . '[SUBMIT]" VALUE="' .
-         $submittext . '"></TD></TR>' .
-         "\n</TABLE>\n";
-}
+/* Get sorting order */
+$abook_sort_order = get_abook_sort();
 
+/* Create page header before addressbook_init in order to  display error messages correctly. */
+displayPageHeader($color, 'None');
+
+/* Open addressbook with error messages on.
+ remote backends (LDAP) are enabled because they can be used. (list_addr function)
+*/
+$abook = addressbook_init(true, false);
 
-/* Open addressbook, with error messages on but without LDAP (the *
- * second "true"). Don't need LDAP here anyway                    */
-$abook = addressbook_init(true, true);
+// FIXME: do we have to stop use of address book, when localbackend is not present.
 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) {
@@ -90,7 +83,6 @@ if($REQUEST_METHOD == 'POST') {
             $showaddrlist = false;
             $defdata = $addaddr;
         }
-
     } else {
 
         /************************************************
@@ -147,7 +139,6 @@ if($REQUEST_METHOD == 'POST') {
              * Update/modify address                       *
              ***********************************************/
             if (!empty($editaddr)) {
-
                 /* Stage one: Copy data into form */
                 if (isset($sel) && sizeof($sel) > 0) {
                     if(sizeof($sel) > 1) {
@@ -158,71 +149,57 @@ if($REQUEST_METHOD == 'POST') {
                         $abortform = true;
                         list($ebackend, $enick) = explode(':', $sel[0]);
                         $olddata = $abook->lookup($enick, $ebackend);
+                        // FIXME: Test if $olddata really contains anything and return an error message if it doesn't
 
                         /* 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 {
-
+                } elseif ($doedit == 1) {
                     /* Stage two: Write new data */
-                    if ($doedit = 1) {
-                        $newdata = $editaddr;
-                        $r = $abook->modify($oldnick, $newdata, $backend);
-
-                        /* 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";
-
-                            /* 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>';
-                            $abortform = true;
-                        }
-                    } else {
+                    $newdata = $editaddr;
+                    $r = $abook->modify($oldnick, $newdata, $backend);
 
-                        /* Should not get here... */
-                        plain_error_message(_("Unknown error"), $color);
+                    /* Handle error messages */
+                    if (!$r) {
+                        /* Display error */
+                        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 */
+                        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 {
+                    /**
+                     * $editaddr is set, but $sel (address selection in address listing)
+                     * and $doedit (address edit form) are not set.
+                     * Assume that user clicked on "Edit address" without selecting any address.
+                     */
+                    $formerror = _("Please select address that you want to edit");
+                    $showaddrlist = true;
+                } /* end of edit stage detection */
             } /* !empty($editaddr)                  - Update/modify address */
         } /* (!empty($deladdr)) && sizeof($sel) > 0 - Delete address(es) */
     } /* !empty($addaddr['nickname'])               - Add new address */
 
     // Some times we end output before forms are printed
     if($abortform) {
-       echo "</BODY></HTML>\n";
-       exit();
+        echo "</body></html>\n";
+        exit();
     }
 }
 
@@ -234,10 +211,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") . ': ' . nl2br(htmlspecialchars($formerror)) . '</font></strong>' ."\n",
+                    'center' )
+                ),
+            'center', '', 'width="100%"' );
 }
 
 
@@ -246,7 +227,7 @@ if ($showaddrlist) {
     /* Get and sort address list */
     $alist = $abook->list_addr();
     if(!is_array($alist)) {
-        plain_error_message($abook->error, $color);
+        plain_error_message(nl2br(htmlspecialchars($abook->error)), $color);
         exit;
     }
 
@@ -254,100 +235,149 @@ 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 */
     if (count($alist) > 0) {
-        echo '<FORM ACTION="' . $PHP_SELF . '" METHOD="POST">' . "\n";
+        echo addForm($form_url, 'post');
+        if ($abook->add_extra_field) {
+            $abook_fields = 6;
+        } else {
+            $abook_fields = 5;
+        }
         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";
+                    echo html_tag( 'table',
+                            html_tag( 'tr',
+                                html_tag( 'td',
+                                    addSubmit(_("Edit selected"), 'editaddr').
+                                    addSubmit(_("Delete selected"), 'deladdr'),
+                                    'center', '', "colspan=\"$abook_fields\"" )
+                                ) .
+                            html_tag( 'tr',
+                                html_tag( 'td', '&nbsp;<br />', 'center', '', "colspan=\"$abook_fields\"" )
+                                ),
+                            '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%"' ) .
+                                  ($abook->add_extra_field ? html_tag( 'th', '&nbsp;','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";
-    
+
+                // Separate different backends with <hr />
+                if($prevbackend > 0) {
+                    echo  html_tag( 'tr',
+                            html_tag( 'td', "<hr />", 'center', '' ,"colspan=\"$abook_fields\"" )
+                            );
+                }
+
+                // Print backend name
+                echo html_tag( 'tr',
+                        html_tag( 'td', "\n" . '<strong>' . $row['source'] . '</strong>' . "\n", 'center', $color[0] ,"colspan=\"$abook_fields\"" )
+                        );
+
                 $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';
+            $selected = in_array($row['backend'] . ':' . $row['nickname'], $defselected);
+
+            /* Print one row, with alternating color */
+            if ($line % 2) {
+                $tr_bgcolor = $color[12];
             } else {
-                $selected = '';
+                $tr_bgcolor = $color[4];
             }
-    
-            /* 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;'; 
-                if ($compose_new_win == '1') {
-                    echo '<a href="javascript:void(0)" onclick=comp_in_new(false,"compose.php?send_to='.rawurlencode($row['email']).'")>';
-                }
-                else {
-                 echo '<A HREF="compose.php?send_to=' . rawurlencode($row['email']).'">';
-                }
-                echo $row['email'] . '</A>&nbsp;</TD>'."\n",
-                 '<TD VALIGN=top WIDTH="1%">&nbsp;' . $row['label'] . '&nbsp;</TD>' .
-                 "</TR>\n";
+            echo html_tag( 'tr', '', '', $tr_bgcolor);
+            if ($abook->backends[$row['backend']]->writeable) {
+                $id = $row['backend'].':'.$row['nickname'];
+                echo html_tag( 'td',
+                               '<small>' .
+                               addCheckBox("sel[$id]", $selected, $id).
+                               '</small>' ,
+                               'center', '', 'valign="top" width="1%"' );
+                $label1 = '<label for="sel_'.$id.'_">'; $label2='</label>';
+            } else {
+                echo html_tag( 'td',
+                               '&nbsp;' ,
+                               'center', '', 'valign="top" width="1%"' );
+                $label1 = $label2 = '';
+            }
+            echo html_tag( 'td',
+                           '&nbsp;' . $label1 . htmlspecialchars($row['nickname']) . $label2 . '&nbsp;',
+                           'left', '', 'valign="top" width="1%" style="white-space: nowrap;"' );
+
+            echo html_tag( 'td',
+                           '&nbsp;' . $label1 . htmlspecialchars($row['name']) . $label2 . '&nbsp;',
+                           'left', '', 'valign="top" width="1%" style="white-space: nowrap;"' );
+
+            // email address column
+            echo html_tag( 'td', '', 'left', '', 'valign="top" width="1%" style="white-space: nowrap;"' ) . '&nbsp;';
+            $email = $abook->full_address($row);
+            echo makeComposeLink('src/compose.php?send_to='.rawurlencode($email),
+                    htmlspecialchars($row['email'])).
+                '&nbsp;</td>'."\n";
+
+            // info column
+            echo html_tag( 'td', '&nbsp;' . htmlspecialchars($row['label']) . '&nbsp;', 'left', '', 'valign="top" width="1%"' );
+
+            // add extra column if third party backend needs it
+            if ($abook->add_extra_field) {
+                echo html_tag( 'td',
+                               '&nbsp;' . (isset($row['extra']) ? $row['extra'] : '') . '&nbsp;',
+                               'left', '', 'valign="top" width="1%"' );
+            }
+            echo "</tr>\n";
             $line++;
         }
-    
-        /* End of list. Close table. */
+        echo "</table>" .
+            "\n<!-- end of address book table -->\n";
+
+        /* End of list. Add edit/delete select buttons */
         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>';
+            echo html_tag( 'table',
+                    html_tag( 'tr',
+                        html_tag( 'td',
+                            addSubmit(_("Edit selected"), 'editaddr') .
+                            addSubmit(_("Delete selected"), 'deladdr'),
+                            'center', '', "colspan=\"$abook_fields\"" )
+                        ),
+                    'center' );
         }
-        echo '</FORM>';
+        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>';
-
-/* Add hook for anything that wants on the bottom */
+echo '<a name="AddAddress"></a>' . "\n";
+abook_create_form($form_url,'addaddr',_("Add to address book"),_("Add address"),$defdata);
+echo "</form>\n";
+
+/* Hook for extra address book blocks */
+echo "<!-- start of addressbook_bottom hook-->\n";
 do_hook('addressbook_bottom');
+echo "\n<!-- end of addressbook_bottom hook-->\n";
+$oTemplate->display('footer.tpl');
 ?>
-
-</BODY></HTML>