/**
* 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.
*
- * $Id$
+ * @copyright © 1999-2005 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. */
+/**
+ * Path for SquirrelMail required files.
+ * @ignore
+ */
define('SM_PATH','../');
/** 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');
require_once(SM_PATH . 'functions/addressbook.php');
-require_once(SM_PATH . 'functions/strings.php');
-require_once(SM_PATH . 'functions/html.php');
+require_once(SM_PATH . 'functions/forms.php');
/** lets get the global vars we may need */
sqgetGlobalVar('key', $key, SQ_COOKIE);
sqgetGlobalVar('sel', $sel, SQ_POST);
sqgetGlobalVar('oldnick', $oldnick, SQ_POST);
sqgetGlobalVar('backend', $backend, SQ_POST);
-sqgetGlobalVar('doedit', $doedit, SQ_POST);
+sqgetGlobalVar('doedit', $doedit, SQ_POST);
-/**
- * Make an input field
- * @param string $label
- * @param string $field
- * @param string $name
- * @param string $size
- * @param array $values
- * @param string $add
- */
-function adressbook_inp_field($label, $field, $name, $size, $values, $add) {
- global $color;
- $td_str = '<INPUT NAME="' . $name . '[' . $field . ']" SIZE="' . $size . '" VALUE="';
- if (isset($values[$field])) {
- $td_str .= htmlspecialchars( strip_tags( $values[$field] ) );
- }
- $td_str .= '">' . $add . '';
- return html_tag( 'tr' ,
- html_tag( 'td', $label . ':', 'right', $color[4]) .
- html_tag( 'td', $td_str, 'left', $color[4])
- )
- . "\n";
-}
+/* Get sorting order */
+$abook_sort_order = get_abook_sort();
-/**
- * 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',
- 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(_("Last name"), 'lastname', $name, 45, $values, '') .
- adressbook_inp_field(_("First name"), 'firstname', $name, 45, $values, '') .
- adressbook_inp_field(_("Additional info"), 'label', $name, 45, $values, '') .
- list_writable_backends($name) .
- html_tag( 'tr',
- html_tag( 'td',
- '<INPUT TYPE=submit NAME="' . $name . '[SUBMIT]" VALUE="' .
- $submittext . '">',
- 'center', $color[4], 'colspan="2"')
- )
- , 'center', '', 'border="0" cellpadding="1" width="90%"') ."\n";
- } else {
- echo html_tag( 'table',
- 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, '') .
- list_writable_backends($name) .
- html_tag( 'tr',
- html_tag( 'td',
- '<INPUT TYPE=submit NAME="' . $name . '[SUBMIT]" VALUE="' .
- $submittext . '">',
- 'center', $color[4], 'colspan="2"')
- )
- , 'center', '', 'border="0" cellpadding="1" width="90%"') ."\n";
-}
-}
+/* Create page header before addressbook_init in order to display error messages correctly. */
+displayPageHeader($color, 'None');
-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',
- '<input type=hidden name=backend value=1>',
- 'center', $color[4], 'colspan="2"')) . "\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);
-/* 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;
$defselected = array();
$form_url = 'addressbook.php';
-
/* Handle user's actions */
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) {
* Update/modify address *
***********************************************/
if (!empty($editaddr)) {
-
/* Stage one: Copy data into form */
if (isset($sel) && sizeof($sel) > 0) {
if(sizeof($sel) > 1) {
$abortform = true;
list($ebackend, $enick) = explode(':', $sel[0]);
$olddata = $abook->lookup($enick, $ebackend);
+ // FIXME: Test if $olddata really contains anything and return an error message if it doesn't
/* 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 '<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>';
+ 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 '<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 */
+ 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();
}
}
/* 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%"' );
+ html_tag( 'tr',
+ html_tag( 'td',
+ "\n". '<br /><strong><font color="' . $color[2] .
+ '">' . _("ERROR") . ': ' . $formerror . '</font></strong>' ."\n",
+ 'center' )
+ ),
+ 'center', '', 'width="100%"' );
}
/* List addresses */
if (count($alist) > 0) {
- echo '<FORM ACTION="' . $form_url . '" METHOD="POST">' . "\n";
+ echo addForm($form_url, 'post');
+ if ($abook->add_extra_field) {
+ $abook_fields = 6;
+ } else {
+ $abook_fields = 5;
+ }
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', ' <br>', 'center', '', 'colspan="5"' )
- ) ,
- 'center' );
+ html_tag( 'tr',
+ html_tag( 'td',
+ addSubmit(_("Edit selected"), 'editaddr').
+ addSubmit(_("Delete selected"), 'deladdr'),
+ 'center', '', "colspan=\"$abook_fields\"" )
+ ) .
+ html_tag( 'tr',
+ html_tag( 'td', ' <br />', 'center', '', "colspan=\"$abook_fields\"" )
+ ),
+ '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%"' ) .
+ ($abook->add_extra_field ? html_tag( 'th', ' ','left', '', 'width="1%"'): '') .
+ "\n",
+ '', $color[9] ) . "\n";
}
-
- echo html_tag( 'table',
- html_tag( 'tr',
- html_tag( 'td', "\n" . '<strong>' . $row['source'] . '</strong>' . "\n", 'center', $color[0] )
- ) ,
- 'center', '', 'width="95%"' ) ."\n"
- . html_tag( 'table', '', 'center', '', 'border="0" cellpadding="1" cellspacing="0" width="90%"' ) .
- html_tag( 'tr', "\n" .
- html_tag( 'th', ' ', '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";
-
+
+ // Separate different backends with <hr />
+ if($prevbackend > 0) {
+ echo html_tag( 'tr',
+ html_tag( 'td', "<hr />", 'center', '' ,"colspan=\"$abook_fields\"" )
+ );
+ }
+
+ // Print backend name
+ echo html_tag( 'tr',
+ html_tag( 'td', "\n" . '<strong>' . $row['source'] . '</strong>' . "\n", 'center', $color[0] ,"colspan=\"$abook_fields\"" )
+ );
+
$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';
+ $selected = in_array($row['backend'] . ':' . $row['nickname'], $defselected);
+
+ /* Print one row, with alternating color */
+ if ($line % 2) {
+ $tr_bgcolor = $color[12];
} else {
- $selected = '';
+ $tr_bgcolor = $color[4];
}
-
- /* 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>' .
- '<INPUT TYPE=checkbox ' . $selected . ' NAME="sel[]" VALUE="' .
- $row['backend'] . ':' . $row['nickname'] . '"></SMALL>' ,
- 'center', '', 'valign="top" width="1%"' ) .
- html_tag( 'td', ' ' . $row['nickname'] . ' ', 'left', '', 'valign="top" width="1%" nowrap' ) .
- html_tag( 'td', ' ' . $row['lastname'] . ' ' . $row['firstname'] . ' ', 'left', '', 'valign="top" width="1%" nowrap' ) .
- html_tag( 'td', '', 'left', '', 'valign="top" width="1%" nowrap' ) . ' ';
- } 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', ' ' . $row['nickname'] . ' ', 'left', '', 'valign="top" width="1%" nowrap' ) .
- html_tag( 'td', ' ' . $row['name'] . ' ', 'left', '', 'valign="top" width="1%" nowrap' ) .
- html_tag( 'td', '', 'left', '', 'valign="top" width="1%" nowrap' ) . ' ';
- }
+ 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',
+ ' ' . htmlspecialchars($row['nickname']) . ' ',
+ 'left', '', 'valign="top" width="1%" style="white-space: nowrap;"' );
+
+ // different full name display formating for Japanese translation
+ if ($squirrelmail_language == 'ja_JP') {
+ /*
+ * translation uses euc-jp character set internally.
+ * htmlspecialchars() should not break any characters.
+ */
+ echo html_tag( 'td',
+ ' ' . htmlspecialchars($row['lastname']) . ' ' . htmlspecialchars($row['firstname']) . ' ',
+ 'left', '', 'valign="top" width="1%" style="white-space: nowrap;"' );
+ } else {
+ echo html_tag( 'td',
+ ' ' . htmlspecialchars($row['name']) . ' ',
+ 'left', '', 'valign="top" width="1%" style="white-space: nowrap;"' );
+ }
+
+ // email address column
+ echo 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";
+ htmlspecialchars($row['email'])).
+ ' </td>'."\n";
+
+ // info column
+ echo html_tag( 'td', ' ' . htmlspecialchars($row['label']) . ' ', 'left', '', 'valign="top" width="1%"' );
+
+ // add extra column if third party backend needs it
+ if ($abook->add_extra_field) {
+ echo html_tag( 'td',
+ ' ' . (isset($row['extra']) ? $row['extra'] : '') . ' ',
+ 'left', '', 'valign="top" width="1%"' );
+ }
+ echo "</tr>\n";
$line++;
}
-
- /* End of list. Close table. */
+ echo "</table>" .
+ "\n<!-- end of address book table -->\n";
+
+ /* End of list. Add edit/delete select buttons */
if ($headerprinted) {
- echo html_tag( 'tr',
+ 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"' )
- );
+ addSubmit(_("Edit selected"), 'editaddr') .
+ addSubmit(_("Delete selected"), 'deladdr'),
+ 'center', '', "colspan=\"$abook_fields\"" )
+ ),
+ 'center' );
}
- echo '</table></FORM>';
+ echo "</form>\n";
}
} /* end of addresslist */
/* 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 '</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 */
+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