<?php
+
/**
* 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.
*
+ * @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 is the addressbook page */
+define('PAGE_NAME', '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/global.php');
-require_once(SM_PATH . 'functions/display_messages.php');
+/* address book functions */
require_once(SM_PATH . 'functions/addressbook.php');
-require_once(SM_PATH . 'functions/strings.php');
-require_once(SM_PATH . 'functions/html.php');
+include_once(SM_PATH . 'templates/util_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('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();
-/**
- * Make an input field
- * @param string $label
- * @param string $field
- * @param string $name
- * @param string $size
- * @param array $values
- * @param string $add
- */
-function addressbook_inp_field($label, $field, $name, $size, $values, $add) {
- global $color;
- $value = ( isset($values[$field]) ? $values[$field] : '');
-
- $td_str = addInput($name.'['.$field.']', $value, $size)
- . $add ;
-
- return html_tag( 'tr' ,
- html_tag( 'td', $label . ':', 'right', $color[4]) .
- html_tag( 'td', $td_str, 'left', $color[4])
- )
- . "\n";
-}
+/* Create page header before addressbook_init in order to display error messages correctly. */
+displayPageHeader($color);
-/**
- * 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',
- addressbook_inp_field(_("Nickname"), 'nickname', $name, 15, $values,
- ' <SMALL>' . _("Must be unique") . '</SMALL>') .
- addressbook_inp_field(_("E-mail address"), 'email', $name, 45, $values, '') .
- addressbook_inp_field(_("Last name"), 'lastname', $name, 45, $values, '') .
- addressbook_inp_field(_("First name"), 'firstname', $name, 45, $values, '') .
- addressbook_inp_field(_("Additional info"), 'label', $name, 45, $values, '') .
- list_writable_backends($name) .
- html_tag( 'tr',
- html_tag( 'td',
- '<INPUT TYPE=submit NAME="' . htmlentities($name) . '[SUBMIT]" VALUE="' .
- $submittext . '">',
- 'center', $color[4], 'colspan="2"')
- )
- , 'center', '', 'border="0" cellpadding="1" width="90%"') ."\n";
- } else {
- echo html_tag( 'table',
- addressbook_inp_field(_("Nickname"), 'nickname', $name, 15, $values,
- ' <SMALL>' . _("Must be unique") . '</SMALL>') .
- addressbook_inp_field(_("E-mail address"), 'email', $name, 45, $values, '') .
- addressbook_inp_field(_("First name"), 'firstname', $name, 45, $values, '') .
- addressbook_inp_field(_("Last name"), 'lastname', $name, 45, $values, '') .
- addressbook_inp_field(_("Additional info"), 'label', $name, 45, $values, '') .
- list_writable_backends($name) .
- html_tag( 'tr',
- html_tag( 'td',
- '<INPUT TYPE=submit NAME="' . htmlentities($name) . '[SUBMIT]" VALUE="' .
- $submittext . '">',
- 'center', $color[4], 'colspan="2"')
- )
- , 'center', '', 'border="0" cellpadding="1" width="90%"') ."\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);
-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',
- addHidden('backend', '1'),
- 'center', $color[4], 'colspan="2"')) . "\n";
- }
-}
-
-/* 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_FORM)
+ && 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 = '';
$defselected = array();
$form_url = 'addressbook.php';
-
/* Handle user's actions */
if(sqgetGlobalVar('REQUEST_METHOD', $req_method, SQ_SERVER) && $req_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. */
* Update/modify address *
***********************************************/
if (!empty($editaddr)) {
-
/* Stage one: Copy data into form */
if (isset($sel) && sizeof($sel) > 0) {
if(sizeof($sel) > 1) {
$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="' . $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 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 */
+ echo abook_create_form($form_url, 'editaddr',
+ _("Update address"),
+ _("Update address"),
+ $current_backend,
+ $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
- 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 */
+ plain_error_message( nl2br(htmlspecialchars($abook->error)));
+
+ /* Display the "new address" form again */
+ echo abook_create_form($form_url, 'editaddr',
+ _("Update address"),
+ _("Update address"),
+ $current_backend,
+ $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%"' );
+ 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 html_tag( 'p', '<a href="#AddAddress">' . _("Add address") . '</a>', 'center' ) . "\n";
-
- /* List addresses */
- if (count($alist) > 0) {
- echo '<form action="' . $form_url . '" method="post">' . "\n";
- 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' );
- 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";
- }
-
- // 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'];
+if ($showaddrlist) {
+//FIXME: Remove HTML from here!
+ echo addForm($form_url, 'post', 'address_book_form');
- /* Check if this user is selected */
- $selected = in_array($row['backend'] . ':' . $row['nickname'], $defselected);
+ $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');
- /* 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%" 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);
- if ($abook->backends[$row['backend']]->writeable) {
- echo html_tag( 'td',
- '<small>' .
- '<input type=checkbox ' . $selected . ' name="sel[]" value="' .
- $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%" nowrap' ) .
- html_tag( 'td', ' ' . $row['name'] . ' ', 'left', '', 'valign="top" width="1%" nowrap' ) .
- html_tag( 'td', '', 'left', '', 'valign="top" width="1%" 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',
- '<input type="submit" name="editaddr" value="' . _("Edit selected") .
- "\" />\n" .
- '<input type="submit" name="deladdr" value="' . _("Delete selected") .
- "\" />\n",
- 'center', '', 'colspan="5"' )
- ),
- 'center' );
- }
- echo "</form>\n";
- }
-} /* end of addresslist */
-
+//FIXME: Remove HTML from here!
+ echo "</form>\n";
+}
/* 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);
+//FIXME: Remove HTML from here! (echo abook_create_form() is OK, since it is all template based output
+echo '<a name="AddAddress"></a>' . "\n";
+echo abook_create_form($form_url, 'addaddr',
+ _("Add to address book"),
+ _("Add address"),
+ $current_backend,
+ $defdata);
echo "</form>\n";
-/* Add hook for anything that wants on the bottom */
-do_hook('addressbook_bottom');
-?>
+/* Hook for extra address book blocks */
+do_hook('addressbook_bottom', $null);
-</body></html>
+$oTemplate->display('footer.tpl');
projects / squirrelmail.git / blobdiff