X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=src%2Faddressbook.php;h=50b16a9229865842540c6ddc9bc152add5dce65b;hb=0880efc9bde776d6aba642cc0fceaedbd6578fe5;hp=ca42c538363383adc92ecd1fb5b3b4e30266925e;hpb=15e6162eacc97158393bc75aed3afeb7b19c24a6;p=squirrelmail.git diff --git a/src/addressbook.php b/src/addressbook.php index ca42c538..50b16a92 100644 --- a/src/addressbook.php +++ b/src/addressbook.php @@ -3,113 +3,86 @@ /** * addressbook.php * - * Copyright (c) 1999-2002 The SquirrelMail Project Team - * Licensed under the GNU GPL. For full terms see the file COPYING. - * * Manage personal address book. * - * $Id$ + * @copyright © 1999-2006 The SquirrelMail Project Team + * @license http://opensource.org/licenses/gpl-license.php GNU Public License + * @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 '' . - $label . ':' . - '' . - '' . $add . '' . "\n"; -} - -/* Output form to add and modify address data */ -function address_form($name, $submittext, $values = array()) { - global $color; - - echo '' ."\n"; - - adressbook_inp_field(_("Nickname"), 'nickname', $name, 15, $values, - '' . _("Must be unique") . ''); - 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 '' . - "\n
' . "\n" . - '
\n"; -} +/** + * Path for SquirrelMail required files. + * @ignore + */ +define('SM_PATH','../'); + +/** SquirrelMail required files. */ +include_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); @@ -117,31 +90,30 @@ if($REQUEST_METHOD == 'POST') { $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; @@ -150,32 +122,31 @@ if($REQUEST_METHOD == 'POST') { $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)) { - - // Stage one: Copy data into form + /*********************************************** + * Update/modify address * + ***********************************************/ + if (!empty($editaddr)) { + /* 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"); @@ -185,93 +156,82 @@ if($REQUEST_METHOD == 'POST') { $abortform = true; list($ebackend, $enick) = explode(':', $sel[0]); $olddata = $abook->lookup($enick, $ebackend); - - // Display the "new address" form - print "
\n"; - print "\n"; - print "\n"; - print "
\n"; - print _("Update address"); - print "\n
\n"; - address_form("editaddr", _("Update address"), $olddata); - printf("\n", - htmlspecialchars($olddata["nickname"])); - printf("\n", - htmlspecialchars($olddata["backend"])); - print "\n"; - print '
'; + // FIXME: Test if $olddata really contains anything and return an error message if it doesn't + + /* 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 { - - // Stage two: Write new data - if($doedit = 1) { - $newdata = $editaddr; - $r = $abook->modify($oldnick, $newdata, $backend); - - // Handle error messages - if(!$r) { - // Display error - print "\n"; - print "\n"; - print "
\n
"; - print ""._("ERROR").": ". - $abook->error.""; - print "\n
\n"; - - // Display the "new address" form again - printf("
\n", $PHP_SELF); - print "\n"; - print "\n"; - print "
\n"; - print _("Update address"); - print "\n
\n"; - address_form("editaddr", _("Update address"), $newdata); - printf("\n", - htmlspecialchars($oldnick)); - printf("\n", - htmlspecialchars($backend)); - print "\n"; - print '
'; - - $abortform = true; - } - } else { - - // Should not get here... - plain_error_message(_("Unknown error"), $color); + } elseif ($doedit == 1) { + /* Stage two: Write new data */ + $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 */ + 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) { - print "\n"; - exit(); + echo "\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 "\n"; - print "\n"; - print "
\n
"; - print ""._("ERROR").": $formerror"; - print "\n
\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". '
' . _("ERROR") . ': ' . $formerror . '' ."\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); @@ -282,97 +242,157 @@ if($showaddrlist) { $prevbackend = -1; $headerprinted = false; - echo "

" . - _("Add address") . "

\n"; - - // List addresses - printf("
\n", $PHP_SELF); - while(list($undef,$row) = each($alist)) { - - // New table header for each backend - if($prevbackend != $row["backend"]) { - if($prevbackend >= 0) { - print "\n"; - printf("\n", - _("Edit selected")); - printf("\n", - _("Delete selected")); - echo "\n"; - print ''; - print " 
\n"; - } + echo html_tag( 'p', '' . _("Add address") . '', 'center' ) . "\n"; - print "\n"; - print "\n"; - print "
\n"; - print $row["source"]; - print "\n
\n"; - - print ''; - printf('\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'; + /* List addresses */ + if (count($alist) > 0) { + echo addForm($form_url, 'post'); + if ($abook->add_extra_field) { + $abook_fields = 6; } else { - $selected = ''; + $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', + addSubmit(_("Edit selected"), 'editaddr'). + addSubmit(_("Delete selected"), 'deladdr'), + 'center', '', "colspan=\"$abook_fields\"" ) + ) . + html_tag( 'tr', + html_tag( 'td', ' 
', 'center', '', "colspan=\"$abook_fields\"" ) + ), + '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%"' ) . + ($abook->add_extra_field ? html_tag( 'th', ' ','left', '', 'width="1%"'): '') . + "\n", + '', $color[9] ) . "\n"; + } - // Print one row - printf("", - (($line % 2) ? " bgcolor=\"$color[0]\"" : "")); - print '', - $selected, $row["backend"], $row["nickname"]); - printf(''. - '', - "1%", $row["nickname"], - "1%", $row["name"]); - printf(''."\n", - "1%", rawurlencode($row["email"]), $row["email"]); - printf('', - "%", $row["label"]); - print "\n"; - $line++; - } + // Separate different backends with
+ if($prevbackend > 0) { + echo html_tag( 'tr', + html_tag( 'td', "
", 'center', '' ,"colspan=\"$abook_fields\"" ) + ); + } - // End of list. Close table. - if($headerprinted) { - print "
 '. - '%s%s'. - '%s%s'. - "
'; - printf(' %s  %s  %s  %s 
\n"; - printf("\n", - _("Edit selected")); - printf("\n", - _("Delete selected")); - print "
"; + // Print backend name + echo html_tag( 'tr', + html_tag( 'td', "\n" . '' . $row['source'] . '' . "\n", 'center', $color[0] ,"colspan=\"$abook_fields\"" ) + ); + + $line = 0; + $headerprinted = true; + } /* End of header */ + + $prevbackend = $row['backend']; + + /* 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]; + } + 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', + ' ' . 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'])). + ' '."\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 "\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', + addSubmit(_("Edit selected"), 'editaddr') . + addSubmit(_("Delete selected"), 'deladdr'), + 'center', '', "colspan=\"$abook_fields\"" ) + ), + 'center' ); + } + echo "\n"; } -} // end of addresslist +} /* end of addresslist */ -// Display the "new address" form -echo "\n" . - "
\n". - "\n". - "\n". - "
\n"; -printf(_("Add to %s"), $abook->localbackendname); -echo "\n
\n"; -address_form('addaddr', _("Add address"), $defdata); -echo '
'; +/* Display the "new address" form */ +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 +/* Add hook for anything that wants on the bottom */ +echo "\n"; do_hook('addressbook_bottom'); -?> - - +echo "\n\n"; +$oTemplate->display('footer.tpl'); +?> \ No newline at end of file