X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=src%2Faddressbook.php;h=dfb02d8f6af59de70d255b436475d816b16459f7;hb=be4ba0bffba237a21d902482a0eadb4ed2158e7c;hp=c0ff11ff9b4dec2f14897fc251c18cbefd5890f0;hpb=134e4174c8919790bcc463587e90ac37cabc2f90;p=squirrelmail.git diff --git a/src/addressbook.php b/src/addressbook.php index c0ff11ff..dfb02d8f 100644 --- a/src/addressbook.php +++ b/src/addressbook.php @@ -3,150 +3,74 @@ /** * 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-2006 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. - * @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, 'None'); -/** - * 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"; -} -} +/* 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 = '"; - 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_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 = ''; @@ -155,7 +79,6 @@ $showaddrlist = true; $defselected = array(); $form_url = 'addressbook.php'; - /* Handle user's actions */ if(sqgetGlobalVar('REQUEST_METHOD', $req_method, SQ_SERVER) && $req_method == 'POST') { @@ -188,14 +111,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 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. */ @@ -235,7 +158,6 @@ if(sqgetGlobalVar('REQUEST_METHOD', $req_method, SQ_SERVER) && $req_method == 'P * Update/modify address * ***********************************************/ if (!empty($editaddr)) { - /* Stage one: Copy data into form */ if (isset($sel) && sizeof($sel) > 0) { if(sizeof($sel) > 1) { @@ -244,77 +166,55 @@ if(sqgetGlobalVar('REQUEST_METHOD', $req_method, SQ_SERVER) && $req_method == 'P $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 '
' . - "\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 */ + abook_create_form($form_url,'editaddr',_("Update address"),_("Update address"),$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 */ + abook_create_form($form_url,'editaddr',_("Update address"),_("Update address"),$newdata); + echo addHidden('oldnick', $oldnick). + addHidden('backend', $backend). + addHidden('doedit', '1'). + "\n" . ''; $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 "\n"; - exit(); + echo "\n"; + exit(); } } @@ -326,176 +226,57 @@ 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(); + + $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', '' . _("Add address") . '', 'center' ) . "\n"; - - /* 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 "\n\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
- if($prevbackend > 0) { - echo html_tag( 'tr', - html_tag( 'td', "
", 'center', '' ,'colspan="5"' ) - ); - } - - // Print backend name - echo html_tag( 'tr', - html_tag( 'td', "\n" . '' . $row['source'] . '' . "\n", 'center', $color[0] ,'colspan="5"' ) - ); - - $line = 0; - $headerprinted = true; - } /* End of header */ - $prevbackend = $row['backend']; +if ($showaddrlist) { + echo addForm($form_url, 'post'); - /* 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', - '' . - addCheckBox('sel[]', $selected, $row['backend'].':'.$row['nickname']). - '' , - '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', - '' . - '' , - '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']) ) . - ' '."\n". - html_tag( 'td', ' ' . htmlspecialchars($row['label']) . ' ', 'left', '', 'valign="top" width="1%"' ) . - "\n"; - $line++; - } - echo "" . - "\n\n"; - - /* 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 */ - +//FIXME: Remove HTML from here! + echo "\n"; +} /* 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 '' . "\n"; +abook_create_form($form_url,'addaddr',_("Add to address book"),_("Add address"),$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); + +$oTemplate->display('footer.tpl'); ?> -