Add template for address book listings along with required files
[squirrelmail.git] / src / addressbook.php
index 39211b87295821d385e72a3c4f347dae8e6ab4c4..8b5c68b39a9debfe13d58e7b7f00c8e1d447e154 100644 (file)
 /**
  * addressbook.php
  *
- * Copyright (c) 1999-2004 The SquirrelMail Project Team
- * Licensed under the GNU GPL. For full terms see the file COPYING.
- *
  * Manage personal address book.
  *
+ * @copyright © 1999-2006 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  * @version $Id$
  * @package squirrelmail
+ * @subpackage addressbook
  */
 
 /**
- * Path for SquirrelMail required files.
- * @ignore
+ * Include the SquirrelMail initialization file.
  */
-define('SM_PATH','../');
+include('../include/init.php');
 
 /** 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');
+/* address book functions */
 require_once(SM_PATH . 'functions/addressbook.php');
-require_once(SM_PATH . 'functions/strings.php');
-require_once(SM_PATH . 'functions/html.php');
+/* form functions */
 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); 
+//sqgetGlobalVar('change_abook',  $change_abook,  SQ_POST);
+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();
+
+/* Create page header before addressbook_init in order to  display error messages correctly. */
+displayPageHeader($color, 'None');
 
-/**
- * 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;
-    $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])
-        )
-    . "\n";
-}
+/* Open addressbook with error messages on.
+ remote backends (LDAP) are enabled because they can be used. (list_addr function)
+*/
+$abook = addressbook_init(true, false);
 
-/**
- * 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',
-                       addressbook_inp_field(_("Nickname"),     'nickname', $name, 15, $values,
-                           ' <SMALL>' . _("Must be unique") . '</SMALL>') .
-                       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="' . htmlentities($name) . '[SUBMIT]" VALUE="' .
-                                       $submittext . '">',
-                                   'center', $color[4], 'colspan="2"')
-                       )
-    , 'center', '', 'border="0" cellpadding="1" width="90%"') ."\n";
-        } else {
-    echo html_tag( 'table',
-                       addressbook_inp_field(_("Nickname"),     'nickname', $name, 15, $values,
-                           ' <SMALL>' . _("Must be unique") . '</SMALL>') .
-                       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="' . htmlentities($name) . '[SUBMIT]" VALUE="' .
-                                       $submittext . '">',
-                                   'center', $color[4], 'colspan="2"')
-                       )
-    , 'center', '', 'border="0" cellpadding="1" width="90%"') ."\n";
-}
+// 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."));
+    exit();
 }
 
-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";
-  }
+$current_backend = $abook->localbackend;
+if (sqgetGlobalVar('new_bnum',$new_backend,SQ_POST) && array_key_exists($new_backend,$abook->backends)) {
+    $current_backend = (int) $new_backend;
 }
 
-/* Open addressbook, with error messages on but without LDAP (the *
- * second "true"). Don't need LDAP here anyway                    */
-$abook = addressbook_init(true, true);
-if($abook->localbackend == 0) {
-    plain_error_message(
-        _("No personal address book is defined. Contact administrator."),
-        $color);
-    exit();
+$abook_selection = '&nbsp;';
+$list_backends = array();
+if (count($abook->backends) > 1) {
+    foreach($abook->get_backend_list() as $oBackend) {
+        if ($oBackend->listing) {
+            $list_backends[$oBackend->bnum]=$oBackend->sname;
+        }
+    }
+    if (count($list_backends)>1) {
+        $abook_selection = addSelect('new_bnum',$list_backends,$current_backend,true)
+            .addSubmit(_("Change"),'change_abook');
+    }
 }
 
-displayPageHeader($color, 'None');
-
 $defdata   = array();
 $formerror = '';
 $abortform = false;
@@ -152,22 +78,19 @@ $showaddrlist = true;
 $defselected  = array();
 $form_url = 'addressbook.php';
 
-
 /* Handle user's actions */
+//if(sqgetGlobalVar('REQUEST_METHOD', $req_method, SQ_SERVER) && $req_method == 'POST' && !isset($change_abook)) {
 if(sqgetGlobalVar('REQUEST_METHOD', $req_method, SQ_SERVER) && $req_method == 'POST') {
 
     /**************************************************
      * 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);
         }
-       if (isset($backend)) {
-         $r = $abook->add($addaddr, $backend);
-       } else {
-         $r = $abook->add($addaddr, $abook->localbackend);
-       }
 
         /* Handle error messages */
         if (!$r) {
@@ -235,7 +158,6 @@ if(sqgetGlobalVar('REQUEST_METHOD', $req_method, SQ_SERVER) && $req_method == 'P
              * Update/modify address                       *
              ***********************************************/
             if (!empty($editaddr)) {
-
                 /* Stage one: Copy data into form */
                 if (isset($sel) && sizeof($sel) > 0) {
                     if(sizeof($sel) > 1) {
@@ -244,77 +166,62 @@ if(sqgetGlobalVar('REQUEST_METHOD', $req_method, SQ_SERVER) && $req_method == 'P
                         $defselected = $sel;
                     } else {
                         $abortform = true;
-                        list($ebackend, $enick) = explode(':', $sel[0]);
+                        list($ebackend, $enick) = explode(':', current($sel));
                         $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 addHidden('oldnick', $olddata['nickname']).
-                             addHidden('backend', $olddata['backend']).
-                            addHidden('doedit', '1').
-                             '</FORM>';
+                        // Test if $olddata really contains anything and return an error message if it doesn't
+                        if (!$olddata) {
+                            error_box(nl2br(htmlspecialchars($abook->error)));
+                        } else {
+                            /* Display the "new address" 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 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". '<strong>' . _("Update address") . '</strong>' ."\n",
-                                         'center', $color[0] )
-                                     ),
-                                 'center', '', 'width="100%"' );
-                            address_form("editaddr", _("Update address"), $newdata);
-                            echo 
-                               addHidden('oldnick', $oldnick).
-                               addHidden('backend', $backend).
-                               addHidden('doedit',  '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();
     }
 }
 
@@ -326,148 +233,65 @@ 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%"' );
+    plain_error_message(nl2br(htmlspecialchars($formerror)));
 }
 
 
 /* Display the address management part */
-if ($showaddrlist) {
-    /* Get and sort address list */
-    $alist = $abook->list_addr();
-    if(!is_array($alist)) {
-        plain_error_message($abook->error, $color);
-        exit;
-    }
-
+$addresses = array();
+while (list($k, $backend) = each ($abook->backends)) {
+    $a = array();
+    $a['BackendID'] = $backend->bnum;
+    $a['BackendSource'] = $backend->sname;
+    $a['BackendWritable'] = $backend->writeable;
+    $a['Addresses'] = array();
+
+    $alist = $abook->list_addr($backend->bnum);
     usort($alist,'alistcmp');
-    $prevbackend = -1;
-    $headerprinted = false;
-
-    echo html_tag( 'p', '<a href="#AddAddress">' . _("Add address") . '</a>', 'center' ) . "\n";
+    $start = 200;
+    $count = count($alist);
+    if ($start >= $count) $start = 0;
+    $alist = array_slice($alist,$start,15);
+   
+    while(list($undef,$row) = each($alist)) {
+        $contact = array (
+                            'FirstName'     => htmlspecialchars($row['firstname']),
+                            'LastName'      => htmlspecialchars($row['lastname']),
+                            'FullName'      => htmlspecialchars($row['name']),
+                            'NickName'      => htmlspecialchars($row['nickname']),
+                            'Email'         => htmlspecialchars($row['email']),
+                            'FullAddress'   => htmlspecialchars($abook->full_address($row)),
+                            'Info'          => htmlspecialchars($row['label']),
+                            'Extra'         => (isset($row['extra']) ? $row['extra'] : NULL),
+                         );
+        $a['Addresses'][] = $contact;
+    }
+  
+    $addresses[$backend->bnum] = $a;
+}
 
-    /* List addresses */
-    if (count($alist) > 0) {
-        echo '<form action="' . $form_url . '" method="post">' . "\n";
-        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' );
-                }
-    
-                echo html_tag( 'table',
-                                html_tag( 'tr',
-                                    html_tag( 'td', "\n" . '<strong>' . $row['source'] . '</strong>' . "\n", 'center', $color[0] )
-                                ) ,
-                        'center', '', 'width="95%"' ) ."\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";
-    
-                $line = 0;
-                $headerprinted = true;
-            } /* End of header */
 
-            $prevbackend = $row['backend'];
-    
-            /* Check if this user is selected */
-            $selected = in_array($row['backend'] . ':' . $row['nickname'], $defselected);
+if ($showaddrlist) {
+    echo addForm($form_url, 'post');
     
-            /* Print one row */
-            $tr_bgcolor = '';
-            if ($line % 2) { $tr_bgcolor = $color[0]; }
-            if ($squirrelmail_language == 'ja_JP')
-                {
-            echo html_tag( 'tr', '', '', $tr_bgcolor) .
-                html_tag( 'td',
-                          '<small>' .
-                         addCheckBox('sel[]', $selected, $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;';
-                } else {
-            echo html_tag( 'tr', '', '', $tr_bgcolor) .
-            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;';
-                }
-            $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";
-        }
+    $oTemplate->assign('addresses', $addresses);
+    $oTemplate->assign('current_backend', $current_backend);
+    $oTemplate->assign('backends', $list_backends);
+        
+    $oTemplate->display('addressbook_list.tpl');
     
-        /* End of list. Add edit/delete select buttons */
-        if ($headerprinted) {
-            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 "</form>\n";
-    }
-} /* end of addresslist */
-
+    echo "</form>\n";
+}
 
 /* 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>' . _("Add to address book") . '</strong>' . "\n",
-                'center', $color[0]
-            )
-        )
-    , 'center', '', 'width="100%"' ) ."\n";
-address_form('addaddr', _("Add address"), $defdata);
+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 */
+/* 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";
 
-</body></html>
\ No newline at end of file
+$oTemplate->display('footer.tpl');
+?>
\ No newline at end of file