Add template for address book listings along with required files
[squirrelmail.git] / src / addressbook.php
index 8fafa44a656a093b1d65dbbdc593e4313235f1fc..8b5c68b39a9debfe13d58e7b7f00c8e1d447e154 100644 (file)
@@ -3,44 +3,37 @@
 /**
  * addressbook.php
  *
- * Copyright (c) 1999-2005 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/display_messages.php');
+/* address book functions */
 require_once(SM_PATH . 'functions/addressbook.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();
@@ -52,13 +45,31 @@ displayPageHeader($color, 'None');
  remote backends (LDAP) are enabled because they can be used. (list_addr function)
 */
 $abook = addressbook_init(true, false);
+
+// 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);
+    plain_error_message(_("No personal address book is defined. Contact administrator."));
     exit();
 }
 
+$current_backend = $abook->localbackend;
+if (sqgetGlobalVar('new_bnum',$new_backend,SQ_POST) && array_key_exists($new_backend,$abook->backends)) {
+    $current_backend = (int) $new_backend;
+}
+
+$abook_selection = ' ';
+$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');
+    }
+}
 
 $defdata   = array();
 $formerror = '';
@@ -68,6 +79,7 @@ $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') {
 
     /**************************************************
@@ -146,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) {
@@ -155,50 +166,54 @@ 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 */
-                        abook_create_form($form_url,'editaddr',_("Update address"),_("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 */
-                            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 {
+                    $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 */
@@ -218,165 +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";
-
-    /* List addresses */
-    if (count($alist) > 0) {
-        echo addForm($form_url, 'post');
-        while(list($undef,$row) = each($alist)) {
-
-            /* New table header for each backend */
-            if($prevbackend != $row['backend']) {
-                if($prevbackend < 0) {
-                    echo html_tag( 'table',
-                            html_tag( 'tr',
-                                html_tag( 'td',
-                                    addSubmit(_("Edit selected"), 'editaddr').
-                                    addSubmit(_("Delete selected"), 'deladdr'),
-                                    'center', '', 'colspan="5"' )
-                                ) .
-                            html_tag( 'tr',
-                                html_tag( 'td', '&nbsp;<br />', 'center', '', 'colspan="5"' )
-                                ),
-                            'center' );
-                    echo "\n<!-- start of address book table -->\n" .
-                        html_tag( 'table', '', 'center', '', 'border="0" cellpadding="1" cellspacing="0" width="90%"' ) .
-                        html_tag( 'tr', "\n" .
-                                html_tag( 'th', '&nbsp;', 'left', '', 'width="1%"' ) . "\n" .
-                                html_tag( 'th', _("Nickname") .
-                                    show_abook_sort_button($abook_sort_order, _("sort by nickname"), 0, 1),
-                                    'left', '', 'width="1%"' ) . "\n" .
-                                html_tag( 'th', _("Name") .
-                                    show_abook_sort_button($abook_sort_order, _("sort by name"), 2, 3),
-                                    'left', '', 'width="1%"' ) . "\n" .
-                                html_tag( 'th', _("E-mail") .
-                                    show_abook_sort_button($abook_sort_order, _("sort by email"), 4, 5),
-                                    'left', '', 'width="1%"' ) . "\n" .
-                                html_tag( 'th', _("Info") .
-                                    show_abook_sort_button($abook_sort_order, _("sort by info"), 6, 7),
-                                    'left', '', 'width="1%"' ) . "\n",
-                                '', $color[9] ) . "\n";
-                }
-
-                // 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 */
-            $selected = in_array($row['backend'] . ':' . $row['nickname'], $defselected);
-
-            /* Print one row, with alternating color */
-            if ($line % 2) {
-                $tr_bgcolor = $color[12];
-            } else {
-                $tr_bgcolor = $color[4];
-            }
-            if ($squirrelmail_language == 'ja_JP') {
-                echo html_tag( 'tr', '', '', $tr_bgcolor);
-                if ($abook->backends[$row['backend']]->writeable) {
-                    echo html_tag( 'td',
-                            '<small>' .
-                            addCheckBox('sel[]', $selected, $row['backend'].':'.$row['nickname']).
-                            '</small>' ,
-                            'center', '', 'valign="top" width="1%"' );
-                } else {
-                    echo html_tag( 'td',
-                            '&nbsp;' ,
-                            'center', '', 'valign="top" width="1%"' );
-                }
-                echo html_tag( 'td', '&nbsp;' . $row['nickname'] . '&nbsp;', 'left', '', 'valign="top" width="1%" style="white-space: nowrap;"' ) .
-                    html_tag( 'td', '&nbsp;' . $row['lastname'] . ' ' . $row['firstname'] . '&nbsp;', 'left', '', 'valign="top" width="1%" style="white-space: nowrap;"' ) .
-                    html_tag( 'td', '', 'left', '', 'valign="top" width="1%" style="white-space: nowrap;"' ) . '&nbsp;';
-            } else {
-                echo html_tag( 'tr', '', '', $tr_bgcolor);
-                if ($abook->backends[$row['backend']]->writeable) {
-                    echo html_tag( 'td',
-                            '<small>' .
-                            addCheckBox('sel[]', $selected, $row['backend'] . ':' . $row['nickname']).
-                            '</small>' ,
-                            'center', '', 'valign="top" width="1%"' );
-                } else {
-                    echo html_tag( 'td',
-                            '&nbsp;' ,
-                            'center', '', 'valign="top" width="1%"' );
-                }
-                echo html_tag( 'td', '&nbsp;' . $row['nickname'] . '&nbsp;', 'left', '', 'valign="top" width="1%" style="white-space: nowrap;"' ) .
-                    html_tag( 'td', '&nbsp;' . $row['name'] . '&nbsp;', 'left', '', 'valign="top" width="1%" style="white-space: nowrap;"' ) .
-                    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".
-                html_tag( 'td', '&nbsp;' . htmlspecialchars($row['label']) . '&nbsp;', 'left', '', 'valign="top" width="1%"' ) .
-                "</tr>\n";
-            $line++;
-        }
-        echo "</table>" .
-            "\n<!-- end of address book table -->\n";
-
-        /* End of list. Add edit/delete select buttons */
-        if ($headerprinted) {
-            echo html_tag( 'table',
-                    html_tag( 'tr',
-                        html_tag( 'td',
-                            addSubmit(_("Edit selected"), 'editaddr') .
-                            addSubmit(_("Delete selected"), 'deladdr'),
-                            'center', '', 'colspan="5"' )
-                        ),
-                    'center' );
-        }
-        echo "</form>\n";
+    $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;
     }
-} /* end of addresslist */
+  
+    $addresses[$backend->bnum] = $a;
+}
 
 
+if ($showaddrlist) {
+    echo addForm($form_url, 'post');
+    
+    $oTemplate->assign('addresses', $addresses);
+    $oTemplate->assign('current_backend', $current_backend);
+    $oTemplate->assign('backends', $list_backends);
+        
+    $oTemplate->display('addressbook_list.tpl');
+    
+    echo "</form>\n";
+}
+
 /* Display the "new address" 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 */
+/* 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