required file already included by template class => it raised a fatal error.
[squirrelmail.git] / src / addressbook.php
index f32b85ab03e40e91e1cca5c6055fa8c9185b0ff2..dfb02d8f6af59de70d255b436475d816b16459f7 100644 (file)
@@ -3,82 +3,94 @@
 /**
  * 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');
-include_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');
+include_once(SM_PATH . 'templates/util_addressbook.php');
 
-    echo '<TABLE BORDER=0 CELLPADDING=1 COLS=2 WIDTH="90%" ALIGN=center>' ."\n";
+/* form functions */
+require_once(SM_PATH . 'functions/forms.php');
 
-    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, '');
+/** lets get the global vars we may need */
 
-    echo '<TR><TD COLSPAN=2 BGCOLOR="' . $color[4] . '" ALIGN=center>' . "\n" .
-         '<INPUT TYPE=submit NAME="' . $name . '[SUBMIT]" VALUE="' .
-         $submittext . '"></TD></TR>' .
-         "\n</TABLE>\n";
-}
+/* 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);
 
+/* 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);
+/* 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);
+
+// 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();
 }
 
-displayPageHeader($color, 'None');
+$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 = '&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');
+    }
+}
 
 $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 +102,6 @@ if($REQUEST_METHOD == 'POST') {
             $showaddrlist = false;
             $defdata = $addaddr;
         }
-
     } else {
 
         /************************************************
@@ -100,14 +111,14 @@ if($REQUEST_METHOD == 'POST') {
             $orig_sel = $sel;
             sort($sel);
 
-            /* The selected addresses are identidied by "backend:nickname". *
+            /* The selected addresses are identidied by "nickname_backend". *
              * Sort the list and process one backend at the time            */
             $prevback  = -1;
             $subsel    = array();
             $delfailed = false;
 
             for ($i = 0 ; (($i < sizeof($sel)) && !$delfailed) ; $i++) {
-                list($sbackend, $snick) = explode(':', $sel[$i]);
+                list($snick, $sbackend) = explode('_', $sel[$i]);
 
                 /* When we get to a new backend, process addresses in *
                  * previous one.                                      */
@@ -147,7 +158,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) {
@@ -156,73 +166,55 @@ if($REQUEST_METHOD == 'POST') {
                         $defselected = $sel;
                     } else {
                         $abortform = true;
-                        list($ebackend, $enick) = explode(':', $sel[0]);
+                        list($enick, $ebackend) = explode('_', current($sel));
                         $olddata = $abook->lookup($enick, $ebackend);
-
-                        /* 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>';
+                        // 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 '<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 */
+                        plain_error_message( nl2br(htmlspecialchars($abook->error)));
+
+                        /* 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,115 +226,57 @@ 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";
+    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);
+
+    /* check return (array with data or boolean false) */
+    if (is_array($alist)) {
+        usort($alist,'alistcmp');
+
+        $a['Addresses'] = formatAddressList($alist);
+  
+        $addresses[$backend->bnum] = $a;
+    } else {
+        // list_addr() returns boolean
+        plain_error_message(nl2br(htmlspecialchars($abook->error)));
     }
+}
 
-    usort($alist,'alistcmp');
-    $prevbackend = -1;
-    $headerprinted = false;
-
-    echo '<p align=center><a href="#AddAddress">' .
-         _("Add address") . "</a></p>\n";
 
-    /* List addresses */
-    if (count($alist) > 0) {
-        echo '<FORM ACTION="' . $PHP_SELF . '" METHOD="POST">' . "\n";
-        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 '<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";
-    
-                $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';
-            } else {
-                $selected = '';
-            }
+if ($showaddrlist) {
+    echo addForm($form_url, 'post');
     
-            /* 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;' .
-                 '<A HREF="compose.php?send_to=' . rawurlencode($row['email']) .
-                 '">' . $row['email'] . '</A>&nbsp;</TD>'."\n",
-                 '<TD VALIGN=top WIDTH="1%">&nbsp;' . $row['label'] . '&nbsp;</TD>' .
-                 "</TR>\n";
-            $line++;
-        }
+    $oTemplate->assign('addresses', $addresses);
+    $oTemplate->assign('current_backend', $current_backend);
+    $oTemplate->assign('backends', $list_backends);
+    $oTemplate->assign('abook_has_extra_field', $abook->add_extra_field);
+        
+    $oTemplate->display('addressbook_list.tpl');
     
-        /* End of list. Close table. */
-        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 '</FORM>';
-    }
-} /* end of addresslist */
-
+//FIXME: Remove HTML from here!
+    echo "</form>\n";
+}
 
 /* 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 */
-do_hook('addressbook_bottom');
-?>
+//FIXME: Remove HTML from here!
+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 */
+do_hook('addressbook_bottom', $null);
 
-</BODY></HTML>
+$oTemplate->display('footer.tpl');
+?>