Replacing tabs with spaces, trimming white space at EOL and newline at EOF
[squirrelmail.git] / src / addressbook.php
index d3d45fba2ae798f2571a5dea2fe1033dcfcd9488..09a5a41bb85587744bdd393633066fea870b9441 100644 (file)
@@ -3,26 +3,29 @@
 /**
  * addressbook.php
  *
- * Copyright (c) 1999-2003 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
  */
 
-/* Path for SquirrelMail required files. */
+/**
+ * Path for SquirrelMail required files.
+ * @ignore
+ */
 define('SM_PATH','../');
 
-/* SquirrelMail required files. */
+/** SquirrelMail required files. */
 require_once(SM_PATH . 'include/validate.php');
-require_once(SM_PATH . 'functions/global.php');
 require_once(SM_PATH . 'functions/display_messages.php');
 require_once(SM_PATH . 'functions/addressbook.php');
-require_once(SM_PATH . 'functions/strings.php');
-require_once(SM_PATH . 'functions/html.php');
+require_once(SM_PATH . 'functions/forms.php');
 
-/* lets get the global vars we may need */
+/** lets get the global vars we may need */
 sqgetGlobalVar('key',       $key,           SQ_COOKIE);
 
 sqgetGlobalVar('username',  $username,      SQ_SESSION);
@@ -37,68 +40,19 @@ 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); 
-
-/* Make an input field */
-function adressbook_inp_field($label, $field, $name, $size, $values, $add) {
-    global $color;
-    $td_str = '<INPUT NAME="' . $name . '[' . $field . ']" SIZE="' . $size . '" VALUE="';
-    if (isset($values[$field])) {
-        $td_str .= htmlspecialchars( strip_tags( $values[$field] ) );
-    }
-    $td_str .= '">' . $add . '';
-    return html_tag( 'tr' ,
-        html_tag( 'td', $label . ':', 'right', $color[4]) .
-        html_tag( 'td', $td_str, 'left', $color[4])
-        )
-    . "\n";
-}
+sqgetGlobalVar('doedit',    $doedit,    SQ_POST);
 
-/* Output form to add and modify address data */
-function address_form($name, $submittext, $values = array()) {
-    global $color, $squirrelmail_language;
-    
-    if ($squirrelmail_language == 'ja_JP')
-        {
-    echo html_tag( 'table',
-                       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(_("Last name"),    'lastname', $name, 45, $values, '') .
-                       adressbook_inp_field(_("First name"),  'firstname', $name, 45, $values, '') .
-                       adressbook_inp_field(_("Additional info"), 'label', $name, 45, $values, '') .
-                       html_tag( 'tr',
-                           html_tag( 'td',
-                                       '<INPUT TYPE=submit NAME="' . $name . '[SUBMIT]" VALUE="' .
-                                       $submittext . '">',
-                                   'center', $color[4], 'colspan="2"')
-                       )
-    , 'center', '', 'border="0" cellpadding="1" width="90%"') ."\n";
-        } else {
-    echo html_tag( 'table',
-                       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, '') .
-                       html_tag( 'tr',
-                           html_tag( 'td',
-                                       '<INPUT TYPE=submit NAME="' . $name . '[SUBMIT]" VALUE="' .
-                                       $submittext . '">',
-                                   'center', $color[4], 'colspan="2"')
-                       )
-    , 'center', '', 'border="0" cellpadding="1" width="90%"') ."\n";
-}
-}
+/* Get sorting order */
+$abook_sort_order = get_abook_sort();
 
-/* Open addressbook, with error messages on but without LDAP (the *
- * second "true"). Don't need LDAP here anyway                    */
-$abook = addressbook_init(true, true);
+/* 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();
 }
 
@@ -111,18 +65,18 @@ $showaddrlist = true;
 $defselected  = array();
 $form_url = 'addressbook.php';
 
-
 /* Handle user's actions */
 if(sqgetGlobalVar('REQUEST_METHOD', $req_method, SQ_SERVER) && $req_method == 'POST') {
 
     /**************************************************
      * Add new address                                *
      **************************************************/
-    if (!empty($addaddr['nickname'])) {
-        foreach( $addaddr as $k => $adr ) {
-            $addaddr[$k] = strip_tags( $adr );
+    if (isset($addaddr)) {
+        if (isset($backend)) {
+            $r = $abook->add($addaddr, $backend);
+        } else {
+            $r = $abook->add($addaddr, $abook->localbackend);
         }
-        $r = $abook->add($addaddr, $abook->localbackend);
 
         /* Handle error messages */
         if (!$r) {
@@ -203,22 +157,11 @@ if(sqgetGlobalVar('REQUEST_METHOD', $req_method, SQ_SERVER) && $req_method == 'P
                         $olddata = $abook->lookup($enick, $ebackend);
 
                         /* Display the "new address" form */
-                        echo '<FORM ACTION="' . $form_url . '" METHOD="POST">' .
-                             "\n" .
-                             html_tag( 'table',
-                                html_tag( 'tr',
-                                   html_tag( 'td',
-                                      "\n". '<strong>' . _("Update address") . '</strong>' ."\n",
-                                      'center', $color[0] )
-                                   ),
-                             'center', '', 'width="100%" ' );
-                        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 {
 
@@ -230,32 +173,21 @@ if(sqgetGlobalVar('REQUEST_METHOD', $req_method, SQ_SERVER) && $req_method == 'P
                         /* Handle error messages */
                         if (!$r) {
                             /* Display error */
-                             echo html_tag( 'table',
-                                html_tag( 'tr',
-                                   html_tag( 'td',
-                                      "\n". '<br><strong><font color="' . $color[2] .
-                                      '">' . _("ERROR") . ': ' . $abook->error . '</font></strong>' ."\n",
-                                      'center' )
-                                   ),
-                             'center', '', 'width="100%"' );
+                            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="' . $form_url .
-                                 '" METHOD="POST">' . "\n" .
-                                 html_tag( 'table',
-                                     html_tag( 'tr',
-                                         html_tag( 'td',
-                                                    "\n". '<br><strong>' . _("Update address") . '</strong>' ."\n",
-                                         'center', $color[0] )
-                                     ),
-                                 'center', '', 'width="100%"' ) .
-                            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 {
@@ -271,8 +203,8 @@ if(sqgetGlobalVar('REQUEST_METHOD', $req_method, SQ_SERVER) && $req_method == 'P
 
     // Some times we end output before forms are printed
     if($abortform) {
-       echo "</BODY></HTML>\n";
-       exit();
+        echo "</body></html>\n";
+        exit();
     }
 }
 
@@ -285,13 +217,13 @@ if(sqgetGlobalVar('REQUEST_METHOD', $req_method, SQ_SERVER) && $req_method == 'P
 /* Display error messages */
 if (!empty($formerror)) {
     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%"' );
+            html_tag( 'tr',
+                html_tag( 'td',
+                    "\n". '<br /><strong><font color="' . $color[2] .
+                    '">' . _("ERROR") . ': ' . $formerror . '</font></strong>' ."\n",
+                    'center' )
+                ),
+            'center', '', 'width="100%"' );
 }
 
 
@@ -312,119 +244,137 @@ if ($showaddrlist) {
 
     /* List addresses */
     if (count($alist) > 0) {
-        echo '<FORM ACTION="' . $form_url . '" METHOD="POST">' . "\n";
+        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',
-                                                     '<INPUT TYPE=submit NAME=editaddr VALUE="' . 
-                                                     _("Edit selected") . "\">\n" .
-                                                     '<INPUT TYPE=submit NAME=deladdr VALUE="' .
-                                                     _("Delete selected") . "\">\n",
-                                          'center', '', 'colspan="5"' )
-                                    ) .
-                                    html_tag( 'tr',
-                                          html_tag( 'td', '&nbsp;<br>', 'center', '', 'colspan="5"' )
-                                    ) ,
-                             'center' );
+                            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";
+                }
+
+                // Separate different backends with <hr />
+                if($prevbackend > 0) {
+                    echo  html_tag( 'tr',
+                            html_tag( 'td', "<hr />", 'center', '' ,'colspan="5"' )
+                            );
                 }
-    
-                echo html_tag( 'table',
-                                html_tag( 'tr',
-                                    html_tag( 'td', "\n" . '<strong>' . $row['source'] . '</strong>' . "\n", 'center', $color[0] )
-                                ) ,
-                        'center', '', 'width="95%"' ) ."\n"
-                . html_tag( 'table', '', 'center', '', 'border="0" cellpadding="1" cellspacing="0" width="90%"' ) .
-                      html_tag( 'tr', "\n" .
-                          html_tag( 'th', '&nbsp;', 'left', '', 'width="1%"' ) .
-                          html_tag( 'th', _("Nickname"), 'left', '', 'width="1%"' ) .
-                          html_tag( 'th', _("Name"), 'left', '', 'width="1%"' ) .
-                          html_tag( 'th', _("E-mail"), 'left', '', 'width="1%"' ) .
-                          html_tag( 'th', _("Info"), 'left', '', 'width="1%"' ) ,
-                      '', $color[9] ) . "\n";
-    
+
+                // 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'];
-    
+
             /* 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 */
-            $tr_bgcolor = '';
-            if ($line % 2) { $tr_bgcolor = $color[0]; }
-            if ($squirrelmail_language == 'ja_JP')
-                {
-            echo html_tag( 'tr', '') .
-                html_tag( 'td',
-                          '<SMALL>' .
-                          '<INPUT TYPE=checkbox ' . $selected . ' NAME="sel[]" VALUE="' .
-                          $row['backend'] . ':' . $row['nickname'] . '"></SMALL>' ,
-                          'center', '', 'valign="top" width="1%"' ) .
-                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;';
+            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( 'tr', '') .
-            html_tag( 'td',
-                '<SMALL>' .
-                '<INPUT TYPE=checkbox ' . $selected . ' NAME="sel[]" VALUE="' .
-                $row['backend'] . ':' . $row['nickname'] . '"></SMALL>' ,
-                'center', '', 'valign="top" width="1%"' ) .
-            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;';
+                    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";
+                    htmlspecialchars($row['email'])).
+                '&nbsp;</td>'."\n".
+                html_tag( 'td', '&nbsp;' . htmlspecialchars($row['label']) . '&nbsp;', 'left', '', 'valign="top" width="1%"' ) .
+                "</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 html_tag( 'tr',
+            echo html_tag( 'table',
+                    html_tag( 'tr',
                         html_tag( 'td',
-                                '<INPUT TYPE="submit" NAME="editaddr" VALUE="' . _("Edit selected") .
-                                "\">\n" .
-                                '<INPUT TYPE="submit" NAME="deladdr" VALUE="' . _("Delete selected") .
-                                "\">\n",
-                         'center', '', 'colspan="5"' )
-                    );
+                            addSubmit(_("Edit selected"), 'editaddr') .
+                            addSubmit(_("Delete selected"), 'deladdr'),
+                            'center', '', 'colspan="5"' )
+                        ),
+                    'center' );
         }
-        echo '</table></FORM>';
+        echo "</form>\n";
     }
 } /* end of addresslist */
 
 
 /* Display the "new address" form */
-echo '<a name="AddAddress"></a>' . "\n" .
-    '<FORM ACTION="' . $form_url . '" NAME=f_add METHOD="POST">' . "\n" .
-    html_tag( 'table',  
-        html_tag( 'tr',
-            html_tag( 'td', "\n". '<strong>' . sprintf(_("Add to %s"), $abook->localbackendname) . '</strong>' . "\n",
-                'center', $color[0]
-            )
-        )
-    , 'center', '', 'width="100%"' ) ."\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