/**
* addressbook.php
*
- * Copyright (c) 1999-2002 The SquirrelMail Project Team
+ * Copyright (c) 1999-2005 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
+ * @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;
-}
-
-/* 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";
-}
-
-/* Output form to add and modify address data */
-function address_form($name, $submittext, $values = array()) {
- global $color;
-
- echo '<TABLE BORDER=0 CELLPADDING=1 COLS=2 WIDTH="90%" ALIGN=center>' ."\n";
-
- 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, '');
-
- echo '<TR><TD COLSPAN=2 BGCOLOR="' . $color[4] . '" ALIGN=center>' . "\n" .
- '<INPUT TYPE=submit NAME="' . $name . '[SUBMIT]" VALUE="' .
- $submittext . '"></TD></TR>' .
- "\n</TABLE>\n";
-}
+/**
+ * Path for SquirrelMail required files.
+ * @ignore
+ */
+define('SM_PATH','../');
+
+/** SquirrelMail required files. */
+require_once(SM_PATH . 'include/validate.php');
+require_once(SM_PATH . 'functions/display_messages.php');
+require_once(SM_PATH . 'functions/addressbook.php');
+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);
+
+/* 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);
+ _("No personal address book is defined. Contact administrator."),
+ $color);
exit();
}
-displayPageHeader($color, 'None');
-
$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 "backend:nickname". *
+ * Sort the list and process one backend at the time */
$prevback = -1;
$subsel = array();
$delfailed = false;
- for($i = 0 ; (($i < sizeof($sel)) && !$delfailed) ; $i++) {
+ for ($i = 0 ; (($i < sizeof($sel)) && !$delfailed) ; $i++) {
list($sbackend, $snick) = 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)) {
+ /***********************************************
+ * Update/modify address *
+ ***********************************************/
+ if (!empty($editaddr)) {
- // Stage one: Copy data into form
+ /* 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");
list($ebackend, $enick) = explode(':', $sel[0]);
$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>';
+ /* 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 {
- // Stage two: Write new data
- if($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
- 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>';
-
+ /* 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 {
- // Should not get here...
+ /* Should not get here... */
plain_error_message(_("Unknown error"), $color);
$abortform = true;
}
// 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.
-// ===================================================================
-
-// 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";
+/* =================================================================== *
+ * 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)) {
+ 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%"' );
}
-// Display the address management part
-if($showaddrlist) {
- // Get and sort address list
+/* 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);
$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";
- }
+ 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', ' <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', ' ', '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";
+ }
- 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 = '';
- }
+ // Separate different backends with <hr />
+ if($prevbackend > 0) {
+ echo html_tag( 'tr',
+ html_tag( 'td', "<hr />", 'center', '' ,'colspan="5"' )
+ );
+ }
- // 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++;
- }
+ // 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'];
- // 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>";
+ /* 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',
+ ' ' ,
+ 'center', '', 'valign="top" width="1%"' );
+ }
+ echo html_tag( 'td', ' ' . $row['nickname'] . ' ', 'left', '', 'valign="top" width="1%" style="white-space: nowrap;"' ) .
+ html_tag( 'td', ' ' . $row['lastname'] . ' ' . $row['firstname'] . ' ', 'left', '', 'valign="top" width="1%" style="white-space: nowrap;"' ) .
+ html_tag( 'td', '', 'left', '', 'valign="top" width="1%" style="white-space: nowrap;"' ) . ' ';
+ } 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',
+ ' ' ,
+ 'center', '', 'valign="top" width="1%"' );
+ }
+ echo html_tag( 'td', ' ' . $row['nickname'] . ' ', 'left', '', 'valign="top" width="1%" style="white-space: nowrap;"' ) .
+ html_tag( 'td', ' ' . $row['name'] . ' ', 'left', '', 'valign="top" width="1%" style="white-space: nowrap;"' ) .
+ html_tag( 'td', '', 'left', '', 'valign="top" width="1%" style="white-space: nowrap;"' ) . ' ';
+ }
+ $email = $abook->full_address($row);
+ echo makeComposeLink('src/compose.php?send_to='.rawurlencode($email),
+ htmlspecialchars($row['email'])).
+ ' </td>'."\n".
+ html_tag( 'td', ' ' . htmlspecialchars($row['label']) . ' ', '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";
}
-} // end of addresslist
+} /* 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>';
+/* 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
+/* Add hook for anything that wants on the bottom */
+echo "<!-- start of addressbook_bottom hook-->\n";
do_hook('addressbook_bottom');
+echo "\n<!-- end of addressbook_bottom hook-->\n";
?>
-
-</BODY></HTML>
+</body></html>
\ No newline at end of file