Uneditable address book entries no longer have checkboxes next to them on addresses...
[squirrelmail.git] / src / addressbook.php
index 8d4c80ff719b6b03b327b02211ae759deb00a2bc..7c3ae718ad57ec236ee792cdfe91c993f06f1565 100644 (file)
@@ -1,28 +1,32 @@
 <?php
-
 /**
  * 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
  */
 
-/* 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,16 +41,27 @@ 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); 
+sqgetGlobalVar('doedit',    $doedit,    SQ_POST);
 
-/* Make an input field */
-function adressbook_inp_field($label, $field, $name, $size, $values, $add) {
+/* Get sorting order */
+$abook_sort_order = get_abook_sort();
+
+/**
+ * Make an input field
+ * @param string $label
+ * @param string $field
+ * @param string $name
+ * @param string $size
+ * @param array $values
+ * @param string $add
+ */
+function addressbook_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 . '';
+    $value = ( isset($values[$field]) ? $values[$field] : '');
+    
+    $td_str = addInput($name.'['.$field.']', $value, $size)
+        . $add ;
+
     return html_tag( 'tr' ,
         html_tag( 'td', $label . ':', 'right', $color[4]) .
         html_tag( 'td', $td_str, 'left', $color[4])
@@ -54,37 +69,41 @@ function adressbook_inp_field($label, $field, $name, $size, $values, $add) {
     . "\n";
 }
 
-/* Output form to add and modify address data */
+/**
+ * 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,
+                       addressbook_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, '') .
+                       addressbook_inp_field(_("E-mail address"),  'email', $name, 45, $values, '') .
+                       addressbook_inp_field(_("Last name"),    'lastname', $name, 45, $values, '') .
+                       addressbook_inp_field(_("First name"),  'firstname', $name, 45, $values, '') .
+                       addressbook_inp_field(_("Additional info"), 'label', $name, 45, $values, '') .
+                   list_writable_backends($name) .
                        html_tag( 'tr',
                            html_tag( 'td',
-                                       '<INPUT TYPE=submit NAME="' . $name . '[SUBMIT]" VALUE="' .
+                                       '<INPUT TYPE=submit NAME="' . htmlentities($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,
+                       addressbook_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, '') .
+                       addressbook_inp_field(_("E-mail address"),  'email', $name, 45, $values, '') .
+                       addressbook_inp_field(_("First name"),  'firstname', $name, 45, $values, '') .
+                       addressbook_inp_field(_("Last name"),    'lastname', $name, 45, $values, '') .
+                       addressbook_inp_field(_("Additional info"), 'label', $name, 45, $values, '') .
+                   list_writable_backends($name) .
                        html_tag( 'tr',
                            html_tag( 'td',
-                                       '<INPUT TYPE=submit NAME="' . $name . '[SUBMIT]" VALUE="' .
+                                       '<INPUT TYPE=submit NAME="' . htmlentities($name) . '[SUBMIT]" VALUE="' .
                                        $submittext . '">',
                                    'center', $color[4], 'colspan="2"')
                        )
@@ -92,6 +111,30 @@ function address_form($name, $submittext, $values = array()) {
 }
 }
 
+function list_writable_backends($name) {
+  global $color, $abook;
+  if ( $name != 'addaddr' ) { return; }
+  if ( $abook->numbackends > 1 ) {
+    $ret = "<select name=backend>";
+    $backends = $abook->get_backend_list();
+    while (list($undef,$v) = each($backends)) {
+      if ($v->writeable) {
+        $ret .= '<OPTION VALUE=' . $v->bnum;
+        $ret .= '>' . $v->sname . "\n";
+      }
+    }
+    $ret .= "</select>";
+    return html_tag( 'tr',
+                     html_tag( 'td', _("Add to:"),'right', $color[4] ) .
+                     html_tag( 'td', $ret, 'left', $color[4] )) . "\n";
+  } else {
+  return html_tag( 'tr',
+                   html_tag( 'td',
+                             addHidden('backend', '1'),
+                             'center', $color[4], 'colspan="2"')) . "\n";
+  }
+}
+
 /* Open addressbook, with error messages on but without LDAP (the *
  * second "true"). Don't need LDAP here anyway                    */
 $abook = addressbook_init(true, true);
@@ -119,10 +162,11 @@ if(sqgetGlobalVar('REQUEST_METHOD', $req_method, SQ_SERVER) && $req_method == 'P
      * Add new address                                *
      **************************************************/
     if (isset($addaddr)) {
-        foreach( $addaddr as $k => $adr ) {
-            $addaddr[$k] = strip_tags( $adr );
+        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) {
@@ -213,11 +257,9 @@ if(sqgetGlobalVar('REQUEST_METHOD', $req_method, SQ_SERVER) && $req_method == 'P
                                    ),
                              '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" .
+                        echo addHidden('oldnick', $olddata['nickname']).
+                             addHidden('backend', $olddata['backend']).
+                             addHidden('doedit', '1').
                              '</FORM>';
                     }
                 } else {
@@ -250,11 +292,10 @@ if(sqgetGlobalVar('REQUEST_METHOD', $req_method, SQ_SERVER) && $req_method == 'P
                                      ),
                                  '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>' .
+                            echo 
+                              addHidden('oldnick', $oldnick).
+                              addHidden('backend', $backend).
+                              addHidden('doedit',  '1').
                                  "\n" . '</FORM>';
                             $abortform = true;
                         }
@@ -312,7 +353,7 @@ if ($showaddrlist) {
 
     /* List addresses */
     if (count($alist) > 0) {
-        echo '<FORM ACTION="' . $form_url . '" METHOD="POST">' . "\n";
+        echo '<form action="' . $form_url . '" method="post">' . "\n";
         while(list($undef,$row) = each($alist)) {
     
             /* New table header for each backend */
@@ -321,67 +362,93 @@ if ($showaddrlist) {
                     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",
+                                                     '<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' );
-                }
-    
-                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%"' ) .
+                    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%"' ) .
-                          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";
-    
+                          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"' )
+                      );
+                }
+
+                // 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' ) . 
+            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', '') .
-            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' ) .
+            echo html_tag( 'tr', '', '', $tr_bgcolor);
+            if ($abook->backends[$row['backend']]->writeable) {
+                echo html_tag( 'td',
+                '<small>' .
+                '<input type=checkbox ' . $selected . ' name="sel[]" value="' .
+                $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;';
                 }
@@ -393,38 +460,42 @@ if ($showaddrlist) {
             "</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',
-                        html_tag( 'td',
-                                '<INPUT TYPE="submit" NAME="editaddr" VALUE="' . _("Edit selected") .
-                                "\">\n" .
-                                '<INPUT TYPE="submit" NAME="deladdr" VALUE="' . _("Delete selected") .
-                                "\">\n",
-                         'center', '', 'colspan="5"' )
-                    );
+            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"' )
+                                     ),
+                           '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" .
+    '<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",
+            html_tag( 'td', "\n". '<strong>' . _("Add to address book") . '</strong>' . "\n",
                 'center', $color[0]
             )
         )
     , 'center', '', 'width="100%"' ) ."\n";
 address_form('addaddr', _("Add address"), $defdata);
-echo '</FORM>';
+echo "</form>\n";
 
 /* Add hook for anything that wants on the bottom */
 do_hook('addressbook_bottom');
 ?>
 
-</BODY></HTML>
+</body></html>