X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=src%2Faddressbook.php;h=3a7977f9c4a75819e963145c4f1a1b5751fee258;hp=a02cc4e68282ec8551b1e9f9f70ba9bd72650344;hb=1a7dcf9de0835f84d8ee8d020df7de1a776cc3df;hpb=fc93f97cf33e677789c3affcd0e45d5e95e3b3bd diff --git a/src/addressbook.php b/src/addressbook.php index a02cc4e6..3a7977f9 100644 --- a/src/addressbook.php +++ b/src/addressbook.php @@ -3,145 +3,90 @@ /** * 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-2009 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. */ -define('SM_PATH','../'); +/** This is the addressbook page */ +define('PAGE_NAME', 'addressbook'); + +/** + * Include the SquirrelMail initialization file. + */ +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); - -/** - * 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"; +sqgetGlobalVar('addaddr', $addaddr, SQ_POST); +sqgetGlobalVar('editaddr', $editaddr, SQ_POST); +sqgetGlobalVar('deladdr', $deladdr, SQ_POST); +sqgetGlobalVar('compose_to', $compose_to, SQ_POST); +sqgetGlobalVar('sel', $sel, SQ_POST); +sqgetGlobalVar('oldnick', $oldnick, SQ_POST); +sqgetGlobalVar('backend', $backend, SQ_POST); +sqgetGlobalVar('doedit', $doedit, SQ_POST); +$page_size = $abook_show_num; +if (!sqGetGlobalVar('page_number', $page_number, SQ_FORM)) + if (!sqGetGlobalVar('current_page_number', $page_number, SQ_FORM)) + $page_number = 1; +if (!sqGetGlobalVar('show_all', $show_all, SQ_FORM)) + $show_all = 0; + +/* Get sorting order */ +$abook_sort_order = get_abook_sort(); + +// Create page header before addressbook_init in order to +// display error messages correctly, unless we might be +// redirecting the browser to the compose page. +// +if ((empty($compose_to)) || sizeof($sel) < 1) + displayPageHeader($color); + +/* 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 really 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.")); + exit(); } -/** - * 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, - ' ' . _("Must be unique") . '') . - 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', - '', - '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, - ' ' . _("Must be unique") . '') . - 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', - '', - 'center', $color[4], 'colspan="2"') - ) - , 'center', '', 'border="0" cellpadding="1" width="90%"') ."\n"; -} +$current_backend = $abook->localbackend; +if (sqgetGlobalVar('new_bnum', $new_backend, SQ_FORM) + && array_key_exists($new_backend, $abook->backends)) { + $current_backend = (int) $new_backend; } -function list_writable_backends($name) { - global $color, $abook; - if ( $name != 'addaddr' ) { return; } - if ( $abook->numbackends > 1 ) { - $ret = ""; - 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); -if($abook->localbackend == 0) { - plain_error_message( - _("No personal address book is defined. Contact administrator."), - $color); - exit(); } -displayPageHeader($color, 'None'); - $defdata = array(); $formerror = ''; $abortform = false; @@ -149,7 +94,6 @@ $showaddrlist = true; $defselected = array(); $form_url = 'addressbook.php'; - /* Handle user's actions */ if(sqgetGlobalVar('REQUEST_METHOD', $req_method, SQ_SERVER) && $req_method == 'POST') { @@ -157,14 +101,11 @@ if(sqgetGlobalVar('REQUEST_METHOD', $req_method, SQ_SERVER) && $req_method == 'P * 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) { @@ -185,14 +126,14 @@ if(sqgetGlobalVar('REQUEST_METHOD', $req_method, SQ_SERVER) && $req_method == 'P $orig_sel = $sel; sort($sel); - /* The selected addresses are identidied by "backend:nickname". * + /* The selected addresses are identified 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++) { - list($sbackend, $snick) = explode(':', $sel[$i]); + list($sbackend, $snick) = explode('_', $sel[$i], 2); /* When we get to a new backend, process addresses in * * previous one. */ @@ -226,13 +167,56 @@ if(sqgetGlobalVar('REQUEST_METHOD', $req_method, SQ_SERVER) && $req_method == 'P $defselected = $orig_sel; } + /************************************************ + * Compose to selected address(es) * + ************************************************/ + } else if ((!empty($compose_to)) && sizeof($sel) > 0) { + $orig_sel = $sel; + sort($sel); + + // The selected addresses are identified by "backend_nickname" + $lookup_failed = false; + $send_to = ''; + + for ($i = 0 ; (($i < sizeof($sel)) && !$lookup_failed) ; $i++) { + list($sbackend, $snick) = explode('_', $sel[$i], 2); + + $data = $abook->lookup($snick, $sbackend); + + if (!$data) { + $formerror = $abook->error; + $lookup_failed = true; + break; + } else { + $addr = $abook->full_address($data); + if (!empty($addr)) + $send_to .= $addr . ', '; + } + } + + + if ($lookup_failed || empty($send_to)) { + $showaddrlist = true; + $defselected = $sel; + + // we skipped the page header above for this functionality, so add it here + displayPageHeader($color); + } + + + // send off to compose screen + else { + $send_to = trim($send_to, ', '); + header('Location: ' . $base_uri . 'src/compose.php?send_to=' . rawurlencode($send_to)); + exit; + } + } else { /*********************************************** * Update/modify address * ***********************************************/ if (!empty($editaddr)) { - /* Stage one: Copy data into form */ if (isset($sel) && sizeof($sel) > 0) { if(sizeof($sel) > 1) { @@ -241,77 +225,65 @@ if(sqgetGlobalVar('REQUEST_METHOD', $req_method, SQ_SERVER) && $req_method == 'P $defselected = $sel; } else { $abortform = true; - list($ebackend, $enick) = explode(':', $sel[0]); + list($ebackend, $enick) = explode('_', current($sel), 2); $olddata = $abook->lookup($enick, $ebackend); - - /* Display the "new address" form */ - echo '
' . - "\n" . - html_tag( 'table', - html_tag( 'tr', - html_tag( 'td', - "\n". '' . _("Update address") . '' ."\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'). - '
'; + // 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'). + ''; + } } - } 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". '' . _("ERROR") . ': ' . $abook->error . '' ."\n", - 'center' ) - ), - 'center', '', 'width="100%"' ); - - /* Display the "new address" form again */ - echo '
' . "\n" . - html_tag( 'table', - html_tag( 'tr', - html_tag( 'td', - "\n". '' . _("Update address") . '' ."\n", - 'center', $color[0] ) - ), - 'center', '', 'width="100%"' ); - address_form("editaddr", _("Update address"), $newdata); - echo - addHidden('oldnick', $oldnick). - addHidden('backend', $backend). - addHidden('doedit', '1'). - "\n" . '
'; - $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" . ''; $abortform = true; } - } - } /* !empty($editaddr) - Update/modify address */ - } /* (!empty($deladdr)) && sizeof($sel) > 0 - Delete address(es) */ - } /* !empty($addaddr['nickname']) - Add new address */ + } 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) + or (!empty($compose_to)) && sizeof($sel) > 0 - Compose to address(es) */ + } /* !empty($addaddr['nickname']) - Add new address */ // Some times we end output before forms are printed if($abortform) { - echo "\n"; - exit(); +//FIXME: use footer.tpl; remove HTML from core + echo "\n"; + exit(); } } @@ -323,148 +295,146 @@ if(sqgetGlobalVar('REQUEST_METHOD', $req_method, SQ_SERVER) && $req_method == 'P /* Display error messages */ if (!empty($formerror)) { - echo html_tag( 'table', - html_tag( 'tr', - html_tag( 'td', - "\n". '
' . _("ERROR") . ': ' . $formerror . '' ."\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(); + + // don't do address lookup if we are not viewing that backend + // + if ($backend->bnum == $current_backend) { + $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))); + } + } else { + $addresses[$backend->bnum] = $a; } +} - usort($alist,'alistcmp'); - $prevbackend = -1; - $headerprinted = false; - echo html_tag( 'p', '' . _("Add address") . '', 'center' ) . "\n"; +$current_page_args = array( + 'abook_sort_order' => $abook_sort_order, + 'new_bnum' => $current_backend, + 'page_number' => $page_number, + ); + + +// note that plugins can add to $current_page_args as well as +// filter the address list +// +$temp = array(&$addresses, &$current_backend, &$page_number, &$current_page_args); +do_hook('abook_list_filter', $temp); + + +// NOTE to address book backend authors and plugin authors: if a backend does +// pagination (which might be more efficient), it needs to place a key +// in every address listing it returns called "paginated", whose value +// should evaluate to boolean TRUE. However, if a plugin will also be +// used on the hook above to filter the addresses (perhaps by group), then +// the backend should be made compatible with the filtering plugin and +// should do the actual filtering too. Otherwise, the backend will paginate +// before filtering has taken place, the output of which is clearly wrong. +// It is proposed that filtering be based on a GET/POST variable called +// "abook_groups_X" where X is the current backend number. The value of +// this varaible would be an array of possible filter names, which the +// plugin and the backend would both know about. The plugin would only +// filter based on that value if the backend didn't already do it. The +// backend can insert a "grouped" key into all address listings, whose +// value evaluates to boolean TRUE, telling the plugin not to do any +// filtering itself. For an example of this implementation, see the +// Address Book Grouping and Pagination plugin. + + +// if no pagination was done by a plugin or the abook +// backend (which is indicated by the presence of a +// "paginated" key within all of the address entries +// in the list of addresses for the backend currently +// being viewed), then we provide default pagination +// +$total_addresses = 0; +if (!$show_all + && is_array($addresses[$current_backend]['Addresses']) + && empty($addresses[$current_backend]['Addresses'][0]['paginated'])) { + + // at this point, we assume the current list is + // the *full* list + // + $total_addresses = sizeof($addresses[$current_backend]['Addresses']); + + // iterate through all the entries, building list of addresses + // to keep based on current page + // + $new_address_list = array(); + $total_pages = ceil($total_addresses / $page_size); + if ($page_number > $total_pages) $page_number = $total_pages; + $page_count = 1; + $page_item_count = 0; + foreach ($addresses[$current_backend]['Addresses'] as $addr) { + $page_item_count++; + if ($page_item_count > $page_size) { + $page_count++; + $page_item_count = 1; + } + if ($page_count == $page_number) + $new_address_list[] = $addr; + } + $addresses[$current_backend]['Addresses'] = $new_address_list; - /* List addresses */ - if (count($alist) > 0) { - echo '
' . "\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', - '\n" . - '\n", - 'center', '', 'colspan="5"' ) - ) . - html_tag( 'tr', - html_tag( 'td', ' 
', 'center', '', 'colspan="5"' ) - ) , - 'center' ); - } - - echo html_tag( 'table', - html_tag( 'tr', - html_tag( 'td', "\n" . '' . $row['source'] . '' . "\n", 'center', $color[0] ) - ) , - 'center', '', 'width="95%"' ) ."\n" . - "\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"; - - $line = 0; - $headerprinted = true; - } /* End of header */ +} - $prevbackend = $row['backend']; - - /* Check if this user is selected */ - $selected = in_array($row['backend'] . ':' . $row['nickname'], $defselected); + +if ($showaddrlist) { - /* 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', - '' . - addCheckBox('sel[]', $selected, $row['backend'].':'.$row['nickname']). - '' , - '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', - '' . - '' , - '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' ) . ' '; - } - $email = $abook->full_address($row); - echo makeComposeLink('src/compose.php?send_to='.rawurlencode($email), - htmlspecialchars($row['email']) ) . - ' '."\n". - html_tag( 'td', ' ' . htmlspecialchars($row['label']) . ' ', 'left', '', 'valign="top" width="1%"' ) . - "\n"; - $line++; - echo "\n". - "\n"; - } + $oTemplate->assign('show_all', $show_all); + $oTemplate->assign('page_number', $page_number); + $oTemplate->assign('page_size', $page_size); + $oTemplate->assign('total_addresses', $total_addresses); + $oTemplate->assign('abook_compact_paginator', $abook_compact_paginator); + $oTemplate->assign('abook_page_selector', $abook_page_selector); + $oTemplate->assign('current_page_args', $current_page_args); + $oTemplate->assign('abook_page_selector_max', $abook_page_selector_max); + $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->assign('compose_new_win', $compose_new_win); + $oTemplate->assign('compose_height', $compose_height); + $oTemplate->assign('compose_width', $compose_width); + $oTemplate->assign('form_action', $form_url); + + $oTemplate->display('addressbook_list.tpl'); - /* End of list. Add edit/delete select buttons */ - if ($headerprinted) { - echo html_tag( 'table', - html_tag( 'tr', - html_tag( 'td', - '\n" . - '\n", - 'center', '', 'colspan="5"' ) - ), - 'center' ); - } - echo "
\n"; - } -} /* end of addresslist */ - +} /* Display the "new address" form */ -echo '' . "\n" . - '
' . "\n" . - html_tag( 'table', - html_tag( 'tr', - html_tag( 'td', "\n". '' . _("Add to address book") . '' . "\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 '' . "\n"; +echo abook_create_form($form_url, 'addaddr', + _("Add to address book"), + _("Add address"), + $current_backend, + $defdata); echo "
\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); - \ No newline at end of file +$oTemplate->display('footer.tpl');