/**
* addressbook.php
*
- * Copyright (c) 1999-2001 The Squirrelmail Development Team
- * Licensed under the GNU GPL. For full terms see the file COPYING.
- *
* Manage personal address book.
*
- * $Id$
+ * @copyright © 1999-2007 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
+ * @package squirrelmail
+ * @subpackage addressbook
*/
-/*****************************************************************/
-/*** THIS FILE NEEDS TO HAVE ITS FORMATTING FIXED!!! ***/
-/*** PLEASE DO SO AND REMOVE THIS COMMENT SECTION. ***/
-/*** + Base level indent should begin at left margin, as ***/
-/*** the require_once below looks. ***/
-/*** + All identation should consist of four space blocks ***/
-/*** + Tab characters are evil. ***/
-/*** + all comments should use "slash-star ... star-slash" ***/
-/*** style -- no pound characters, no slash-slash style ***/
-/*** + FLOW CONTROL STATEMENTS (if, while, etc) SHOULD ***/
-/*** ALWAYS USE { AND } CHARACTERS!!! ***/
-/*** + Please use ' instead of ", when possible. Note " ***/
-/*** should always be used in _( ) function calls. ***/
-/*** Thank you for your help making the SM code more readable. ***/
-/*****************************************************************/
-
-require_once('../src/validate.php');
-require_once('../functions/array.php');
-require_once('../functions/display_messages.php');
-require_once('../functions/addressbook.php');
-
-/* Sort array by the key "name" */
-function alistcmp($a,$b) {
- if($a['backend'] > $b['backend']) {
- return 1;
- } else {
- if($a['backend'] < $b['backend']) {
- return -1;
- }
- }
- return (strtolower($a['name']) > strtolower($b['name'])) ? 1 : -1;
-}
+/**
+ * Include the SquirrelMail initialization file.
+ */
+include('../include/init.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";
-}
+/** SquirrelMail required files. */
+/* address book functions */
+require_once(SM_PATH . 'functions/addressbook.php');
+include_once(SM_PATH . 'templates/util_addressbook.php');
-/* Output form to add and modify address data */
-function address_form($name, $submittext, $values = array()) {
- global $color;
+/* form functions */
+require_once(SM_PATH . 'functions/forms.php');
- echo '<TABLE BORDER=0 CELLPADDING=1 COLS=2 WIDTH="90%" ALIGN=center>' ."\n";
+/** lets get the global vars we may need */
- 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, '');
+/* 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);
- echo '<TR><TD COLSPAN=2 BGCOLOR="' . $color[4] . '" ALIGN=center>' . "\n" .
- '<INPUT TYPE=submit NAME="' . $name . '[SUBMIT]" VALUE="' .
- $submittext . '"></TD></TR>' .
- "\n</TABLE>\n";
-}
+/* 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');
+/* Open addressbook with error messages on.
+ remote backends (LDAP) are enabled because they can be used. (list_addr function)
+*/
+$abook = addressbook_init(true, false);
-// Open addressbook, with error messages on but without LDAP (the
-// second "true"). Don't need LDAP here anyway
-$abook = addressbook_init(true, true);
+// 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 = ' ';
+$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(sqgetGlobalVar('REQUEST_METHOD', $req_method, SQ_SERVER) && $req_method == 'POST') {
-// Handle user's actions
-if($REQUEST_METHOD == 'POST') {
-
- // ***********************************************
- // Add new address
- // ***********************************************
- if(!empty($addaddr['nickname'])) {
-
- $r = $abook->add($addaddr, $abook->localbackend);
+ /**************************************************
+ * Add new address *
+ **************************************************/
+ if (isset($addaddr)) {
+ if (isset($backend)) {
+ $r = $abook->add($addaddr, $backend);
+ } else {
+ $r = $abook->add($addaddr, $abook->localbackend);
+ }
- // Handle error messages
- if(!$r) {
- // Remove backend name from error string
+ /* Handle error messages */
+ if (!$r) {
+ /* Remove backend name from error string */
$errstr = $abook->error;
$errstr = ereg_replace('^\[.*\] *', '', $errstr);
$showaddrlist = false;
$defdata = $addaddr;
}
-
} else {
- // ***********************************************
- // Delete address(es)
- // ***********************************************
- if((!empty($deladdr)) && sizeof($sel) > 0) {
+ /************************************************
+ * Delete address(es) *
+ ************************************************/
+ if ((!empty($deladdr)) && sizeof($sel) > 0) {
$orig_sel = $sel;
sort($sel);
- // The selected addresses are identidied by "backend:nickname".
- // Sort the list and process one backend at the time
+ /* 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]);
+ for ($i = 0 ; (($i < sizeof($sel)) && !$delfailed) ; $i++) {
+ list($snick, $sbackend) = explode('_', $sel[$i]);
- // When we get to a new backend, process addresses in
- // previous one.
- if($prevback != $sbackend && $prevback != -1) {
+ /* When we get to a new backend, process addresses in *
+ * previous one. */
+ if ($prevback != $sbackend && $prevback != -1) {
$r = $abook->remove($subsel, $prevback);
- if(!$r) {
+ if (!$r) {
$formerror = $abook->error;
$i = sizeof($sel);
$delfailed = true;
$subsel = array();
}
- // Queue for processing
+ /* Queue for processing */
array_push($subsel, $snick);
$prevback = $sbackend;
}
- if(!$delfailed) {
+ if (!$delfailed) {
$r = $abook->remove($subsel, $prevback);
- if(!$r) { // Handle errors
+ if (!$r) { /* Handle errors */
$formerror = $abook->error;
$delfailed = true;
}
}
- if($delfailed) {
+ if ($delfailed) {
$showaddrlist = true;
$defselected = $orig_sel;
}
} else {
- // ***********************************************
- // Update/modify address
- // ***********************************************
- if(!empty($editaddr)) {
-
- // Stage one: Copy data into form
+ /***********************************************
+ * Update/modify address *
+ ***********************************************/
+ if (!empty($editaddr)) {
+ /* Stage one: Copy data into form */
if (isset($sel) && sizeof($sel) > 0) {
if(sizeof($sel) > 1) {
$formerror = _("You can only edit one address at the time");
$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
- print "<FORM ACTION=\"$PHP_SELF\" METHOD=\"POST\">\n";
- print "<TABLE WIDTH=100% COLS=1 ALIGN=CENTER>\n";
- print "<TR><TD BGCOLOR=\"$color[0]\" ALIGN=CENTER>\n<STRONG>";
- print _("Update address");
- print "<STRONG>\n</TD></TR>\n";
- print "</TABLE>\n";
- address_form("editaddr", _("Update address"), $olddata);
- printf("<INPUT TYPE=hidden NAME=oldnick VALUE=\"%s\">\n",
- htmlspecialchars($olddata["nickname"]));
- printf("<INPUT TYPE=hidden NAME=backend VALUE=\"%s\">\n",
- htmlspecialchars($olddata["backend"]));
- print "<INPUT TYPE=hidden NAME=doedit VALUE=1>\n";
- print '</FORM>';
- }
- } else {
-
- // Stage two: Write new data
- if($doedit = 1) {
- $newdata = $editaddr;
- $r = $abook->modify($oldnick, $newdata, $backend);
-
- // Handle error messages
- if(!$r) {
- // Display error
- print "<TABLE WIDTH=100% COLS=1 ALIGN=CENTER>\n";
- print "<TR><TD ALIGN=CENTER>\n<br><STRONG>";
- print "<FONT COLOR=\"$color[2]\">"._("ERROR").": ".
- $abook->error."</FONT>";
- print "<STRONG>\n</TD></TR>\n";
- print "</TABLE>\n";
-
- // Display the "new address" form again
- printf("<FORM ACTION=\"%s\" METHOD=\"POST\">\n", $PHP_SELF);
- print "<TABLE WIDTH=100% COLS=1 ALIGN=CENTER>\n";
- print "<TR><TD BGCOLOR=\"$color[0]\" ALIGN=CENTER>\n<STRONG>";
- print _("Update address");
- print "<STRONG>\n</TD></TR>\n";
- print "</TABLE>\n";
- address_form("editaddr", _("Update address"), $newdata);
- printf("<INPUT TYPE=hidden NAME=oldnick VALUE=\"%s\">\n",
- htmlspecialchars($oldnick));
- printf("<INPUT TYPE=hidden NAME=backend VALUE=\"%s\">\n",
- htmlspecialchars($backend));
- print "<INPUT TYPE=hidden NAME=doedit VALUE=1>\n";
- print '</FORM>';
-
- $abortform = true;
+ // 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 {
-
- // Should not get here...
- plain_error_message(_("Unknown error"), $color);
+ }
+ } elseif ($doedit == 1) {
+ /* Stage two: Write new data */
+ $newdata = $editaddr;
+ $r = $abook->modify($oldnick, $newdata, $backend);
+
+ /* 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) {
- print "</BODY></HTML>\n";
- exit();
+ echo "</body></html>\n";
+ exit();
}
}
-// ===================================================================
-// The following is only executed on a GET request, or on a POST when
-// a user is added, or when "delete" or "modify" was successful.
-// ===================================================================
+/* =================================================================== *
+ * The following is only executed on a GET request, or on a POST when *
+ * a user is added, or when "delete" or "modify" was successful. *
+ * =================================================================== */
-// Display error messages
-if(!empty($formerror)) {
- print "<TABLE WIDTH=100% COLS=1 ALIGN=CENTER>\n";
- print "<TR><TD ALIGN=CENTER>\n<br><STRONG>";
- print "<FONT COLOR=\"$color[2]\">"._("ERROR").": $formerror</FONT>";
- print "<STRONG>\n</TD></TR>\n";
- print "</TABLE>\n";
+/* Display error messages */
+if (!empty($formerror)) {
+ 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;
- }
+/* Display the address management part */
+$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();
- usort($alist,'alistcmp');
- $prevbackend = -1;
- $headerprinted = false;
-
- echo "<p align=center><a href=\"#AddAddress\">" .
- _("Add address") . "</a></p>\n";
-
- // List addresses
- printf("<FORM ACTION=\"%s\" METHOD=\"POST\">\n", $PHP_SELF);
- while(list($undef,$row) = each($alist)) {
-
- // New table header for each backend
- if($prevbackend != $row["backend"]) {
- if($prevbackend >= 0) {
- print "<TR><TD COLSPAN=5 ALIGN=center>\n";
- printf("<INPUT TYPE=submit NAME=editaddr VALUE=\"%s\">\n",
- _("Edit selected"));
- printf("<INPUT TYPE=submit NAME=deladdr VALUE=\"%s\">\n",
- _("Delete selected"));
- echo "</tr>\n";
- print '<TR><TD COLSPAN="5" ALIGN=center>';
- print " <BR></TD></TR></TABLE>\n";
- }
+ $alist = $abook->list_addr($backend->bnum);
- print "<TABLE WIDTH=\"95%\" COLS=1 ALIGN=CENTER>\n";
- print "<TR><TD BGCOLOR=\"$color[0]\" ALIGN=CENTER>\n<STRONG>";
- print $row["source"];
- print "<STRONG>\n</TD></TR>\n";
- print "</TABLE>\n";
-
- print '<TABLE COLS="5" BORDER="0" CELLPADDING="1" CELLSPACING="0" WIDTH="90%" ALIGN="center">';
- printf('<TR BGCOLOR="%s"><TH ALIGN=left WIDTH="%s"> '.
- '<TH ALIGN=left WIDTH="%s">%s<TH ALIGN=left WIDTH="%s">%s'.
- '<TH ALIGN=left WIDTH="%s">%s<TH ALIGN=left WIDTH="%s">%s'.
- "</TR>\n", $color[9], "1%",
- "1%", _("Nickname"),
- "1%", _("Name"),
- "1%", _("E-mail"),
- "%", _("Info"));
- $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 = '';
- }
+ /* check return (array with data or boolean false) */
+ if (is_array($alist)) {
+ usort($alist,'alistcmp');
- // Print one row
- printf("<TR%s>",
- (($line % 2) ? " bgcolor=\"$color[0]\"" : ""));
- print '<TD VALIGN=top ALIGN=center WIDTH="1%"><SMALL>';
- printf('<INPUT TYPE=checkbox %s NAME="sel[]" VALUE="%s:%s"></SMALL></TD>',
- $selected, $row["backend"], $row["nickname"]);
- printf('<TD VALIGN=top NOWRAP WIDTH="%s"> %s </TD>'.
- '<TD VALIGN=top NOWRAP WIDTH="%s"> %s </TD>',
- "1%", $row["nickname"],
- "1%", $row["name"]);
- printf('<TD VALIGN=top NOWRAP WIDTH="%s"> <A HREF="compose.php?send_to=%s">%s</A> </TD>'."\n",
- "1%", rawurlencode($row["email"]), $row["email"]);
- printf('<TD VALIGN=top WIDTH="%s"> %s </TD>',
- "%", $row["label"]);
- print "</TR>\n";
- $line++;
+ $a['Addresses'] = formatAddressList($alist);
+
+ $addresses[$backend->bnum] = $a;
+ } else {
+ // list_addr() returns boolean
+ plain_error_message(nl2br(htmlspecialchars($abook->error)));
}
+}
- // End of list. Close table.
- if($headerprinted) {
- print "<TR><TD COLSPAN=5 ALIGN=center>\n";
- printf("<INPUT TYPE=submit NAME=editaddr VALUE=\"%s\">\n",
- _("Edit selected"));
- printf("<INPUT TYPE=submit NAME=deladdr VALUE=\"%s\">\n",
- _("Delete selected"));
- print "</TR></TABLE></FORM>";
- }
-} // end of addresslist
-
-
-// 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>";
-printf(_("Add to %s"), $abook->localbackendname);
-echo "<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');
-?>
-</BODY></HTML>
+if ($showaddrlist) {
+ echo addForm($form_url, 'post');
+
+ $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');
+
+//FIXME: Remove HTML from here!
+ echo "</form>\n";
+}
+
+/* Display the "new address" form */
+//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);
+
+$oTemplate->display('footer.tpl');
+?>