From 75e19c7fe9b21733b1af5f4c5910835da1eea326 Mon Sep 17 00:00:00 2001 From: philippe_mingo Date: Mon, 24 Jun 2002 09:49:47 +0000 Subject: [PATCH] R2L by Yoav git-svn-id: https://svn.code.sf.net/p/squirrelmail/code/trunk/squirrelmail@2993 7612ce4b-ef26-0410-bec9-ea0150e637f0 --- functions/addressbook.php | 794 ++++++++++++++++---------------------- 1 file changed, 323 insertions(+), 471 deletions(-) diff --git a/functions/addressbook.php b/functions/addressbook.php index 50968174..269b1994 100644 --- a/functions/addressbook.php +++ b/functions/addressbook.php @@ -6,523 +6,375 @@ * Copyright (c) 1999-2002 The SquirrelMail Project Team * Licensed under the GNU GPL. For full terms see the file COPYING. * - * Functions and classes for the addressbook system. + * Manage personal address book. * * $Id$ */ -/* - This is the path to the global site-wide addressbook. - It looks and feels just like a user's .abook file - If this is in the data directory, use "$data_dir/global.abook" - If not, specify the path as though it was accessed from the - src/ directory ("../global.abook" -> in main directory) - - If you don't want a global site-wide addressbook, comment these - two lines out. (They are disabled by default.) - - The global addressbook is unmodifiable by anyone. You must actually - use a shell script or whatnot to modify the contents. - - global $data_dir; - $address_book_global_filename = "$data_dir/global.abook"; - - Include backends here. -*/ - -require_once('../functions/abook_local_file.php'); -require_once('../functions/abook_ldap_server.php'); - -global $addrbook_dsn; - -/* Use this if you wanna have a global address book */ -if (isset($address_book_global_filename)) { - include_once('../functions/abook_global_file.php'); +require_once('../src/validate.php'); +require_once('../functions/array.php'); +require_once('../functions/display_messages.php'); +require_once('../functions/addressbook.php'); +require_once('../functions/strings.php'); +require_once('../functions/html.php'); + +/* Make an input field */ +function adressbook_inp_field($label, $field, $name, $size, $values, $add) { + global $color; + $td_str = '' . $add . ''; + return html_tag( 'tr' , + html_tag( 'td', $label . ':', 'right', $color[4]) . + html_tag( 'td', $td_str, 'left', $color[4]) + ) + . "\n"; } -/* Only load database backend if database is configured */ -if(isset($addrbook_dsn) && !empty($addrbook_dsn)) { - include_once('../functions/abook_database.php'); +/* Output form to add and modify address data */ +function address_form($name, $submittext, $values = array()) { + global $color; + echo html_tag( 'table', + 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, '') . + html_tag( 'tr', + html_tag( 'td', + '', + 'center', $color[4], 'colspan="2"') + ) + , 'center', '', 'border="0" cellpadding="1" cols="2" width="90%"') ."\n"; } -/* - Create and initialize an addressbook object. - Returns the created object -*/ -function addressbook_init($showerr = true, $onlylocal = false) { - global $data_dir, $username, $ldap_server, $address_book_global_filename; - global $addrbook_dsn, $addrbook_table; - - /* Create a new addressbook object */ - $abook = new AddressBook; - - /* - Always add a local backend. We use *either* file-based *or* a - database addressbook. If $addrbook_dsn is set, the database - backend is used. If not, addressbooks are stores in files. - */ - if (isset($addrbook_dsn) && !empty($addrbook_dsn)) { - /* Database */ - if (!isset($addrbook_table) || empty($addrbook_table)) { - $addrbook_table = 'address'; - } - $r = $abook->add_backend('database', Array('dsn' => $addrbook_dsn, - 'owner' => $username, - 'table' => $addrbook_table)); - if (!$r && $showerr) { - echo _("Error initializing addressbook database."); - exit; - } - } else { - /* File */ - $filename = getHashedFile($username, $data_dir, "$username.abook"); - $r = $abook->add_backend('local_file', Array('filename' => $filename, - 'create' => true)); - if(!$r && $showerr) { - printf( _("Error opening file %s"), $filename ); - exit; - } - - } - - /* This would be for the global addressbook */ - if (isset($address_book_global_filename)) { - $r = $abook->add_backend('global_file'); - if (!$r && $showerr) { - echo _("Error initializing global addressbook."); - exit; - } - } - - if ($onlylocal) { - return $abook; - } - - /* Load configured LDAP servers (if PHP has LDAP support) */ - if (isset($ldap_server) && is_array($ldap_server) && function_exists('ldap_connect')) { - reset($ldap_server); - while (list($undef,$param) = each($ldap_server)) { - if (is_array($param)) { - $r = $abook->add_backend('ldap_server', $param); - if (!$r && $showerr) { - printf( ' ' . _("Error initializing LDAP server %s:") . - "
\n", $param['host']); - echo ' ' . $abook->error; - exit; - } - } - } - } - /* Return the initialized object */ - return $abook; +/* 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'); -/* - * Had to move this function outside of the Addressbook Class - * PHP 4.0.4 Seemed to be having problems with inline functions. - */ -function addressbook_cmp($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; +$defdata = array(); +$formerror = ''; +$abortform = false; +$showaddrlist = true; +$defselected = array(); -} +/* Handle user's actions */ +if($REQUEST_METHOD == 'POST') { -/* - * This is the main address book class that connect all the - * backends and provide services to the functions above. - * - */ + /************************************************** + * Add new address * + **************************************************/ + if (!empty($addaddr['nickname'])) { -class AddressBook { + $r = $abook->add($addaddr, $abook->localbackend); - var $backends = array(); - var $numbackends = 0; - var $error = ''; - var $localbackend = 0; - var $localbackendname = ''; - - // Constructor function. - function AddressBook() { - $localbackendname = _("Personal address book"); - } + /* Handle error messages */ + if (!$r) { + /* Remove backend name from error string */ + $errstr = $abook->error; + $errstr = ereg_replace('^\[.*\] *', '', $errstr); - /* - * Return an array of backends of a given type, - * or all backends if no type is specified. - */ - function get_backend_list($type = '') { - $ret = array(); - for ($i = 1 ; $i <= $this->numbackends ; $i++) { - if (empty($type) || $type == $this->backends[$i]->btype) { - $ret[] = &$this->backends[$i]; - } + $formerror = $errstr; + $showaddrlist = false; + $defdata = $addaddr; } - return $ret; - } - - - /* - ========================== Public ======================== - - Add a new backend. $backend is the name of a backend - (without the abook_ prefix), and $param is an optional - mixed variable that is passed to the backend constructor. - See each of the backend classes for valid parameters. - */ - function add_backend($backend, $param = '') { - $backend_name = 'abook_' . $backend; - eval('$newback = new ' . $backend_name . '($param);'); - if(!empty($newback->error)) { - $this->error = $newback->error; - return false; - } - - $this->numbackends++; - - $newback->bnum = $this->numbackends; - $this->backends[$this->numbackends] = $newback; - - /* Store ID of first local backend added */ - if ($this->localbackend == 0 && $newback->btype == 'local') { - $this->localbackend = $this->numbackends; - $this->localbackendname = $newback->sname; - } - - return $this->numbackends; - } + } else { - /* - Return a list of addresses matching expression in - all backends of a given type. - */ - function search($expression, $bnum = -1) { - $ret = array(); - $this->error = ''; - - /* Search all backends */ - if ($bnum == -1) { - $sel = $this->get_backend_list(''); - $failed = 0; - for ($i = 0 ; $i < sizeof($sel) ; $i++) { - $backend = &$sel[$i]; - $backend->error = ''; - $res = $backend->search($expression); - if (is_array($res)) { - $ret = array_merge($ret, $res); - } else { - $this->error .= "
\n" . $backend->error; - $failed++; + /************************************************ + * 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 */ + $prevback = -1; + $subsel = array(); + $delfailed = false; + + 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) { + + $r = $abook->remove($subsel, $prevback); + if (!$r) { + $formerror = $abook->error; + $i = sizeof($sel); + $delfailed = true; + break; + } + $subsel = array(); } - } - /* Only fail if all backends failed */ - if( $failed >= sizeof( $sel ) ) { - $ret = FALSE; + /* Queue for processing */ + array_push($subsel, $snick); + $prevback = $sbackend; } - } else { - - /* Search only one backend */ + if (!$delfailed) { + $r = $abook->remove($subsel, $prevback); + if (!$r) { /* Handle errors */ + $formerror = $abook->error; + $delfailed = true; + } + } - $ret = $this->backends[$bnum]->search($expression); - if (!is_array($ret)) { - $this->error .= "
\n" . $this->backends[$bnum]->error; - $ret = FALSE; + if ($delfailed) { + $showaddrlist = true; + $defselected = $orig_sel; } - } - return( $ret ); - } + } else { + /*********************************************** + * 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"); + $showaddrlist = true; + $defselected = $sel; + } else { + $abortform = true; + list($ebackend, $enick) = explode(':', $sel[0]); + $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%" cols="1"' ) . + address_form("editaddr", _("Update address"), $olddata); + echo '\n" . + '\n" . + '' . "\n" . + '
'; + } + } else { - /* Return a sorted search */ - function s_search($expression, $bnum = -1) { - - $ret = $this->search($expression, $bnum); - if ( is_array( $ret ) ) { - usort($ret, 'addressbook_cmp'); - } - return $ret; + /* 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%" cols="1"' ); + + /* 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%" cols="1"' ) . + address_form("editaddr", _("Update address"), $newdata); + echo '\n" . + '\n" . + '' . + "\n" . '
'; + $abortform = true; + } + } else { + + /* Should not get here... */ + plain_error_message(_("Unknown error"), $color); + $abortform = true; + } + } + } /* !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(); } +} - /* - * Lookup an address by alias. Only possible in - * local backends. - */ - function lookup($alias, $bnum = -1) { - - $ret = array(); - - if ($bnum > -1) { - $res = $this->backends[$bnum]->lookup($alias); - if (is_array($res)) { - return $res; - } else { - $this->error = $backend->error; - return false; - } - } - - $sel = $this->get_backend_list('local'); - for ($i = 0 ; $i < sizeof($sel) ; $i++) { - $backend = &$sel[$i]; - $backend->error = ''; - $res = $backend->lookup($alias); - if (is_array($res)) { - if(!empty($res)) - return $res; - } else { - $this->error = $backend->error; - return false; - } - } - - return $ret; - } +/* =================================================================== * + * 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%" cols="1"' ); +} - /* Return all addresses */ - function list_addr($bnum = -1) { - $ret = array(); - - if ($bnum == -1) { - $sel = $this->get_backend_list('local'); - } else { - $sel = array(0 => &$this->backends[$bnum]); - } - - for ($i = 0 ; $i < sizeof($sel) ; $i++) { - $backend = &$sel[$i]; - $backend->error = ''; - $res = $backend->list_addr(); - if (is_array($res)) { - $ret = array_merge($ret, $res); - } else { - $this->error = $backend->error; - return false; - } - } - - return $ret; +/* 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; } - /* - * Create a new address from $userdata, in backend $bnum. - * Return the backend number that the/ address was added - * to, or false if it failed. - */ - function add($userdata, $bnum) { - - /* Validate data */ - if (!is_array($userdata)) { - $this->error = _("Invalid input data"); - return false; - } - if (empty($userdata['firstname']) && empty($userdata['lastname'])) { - $this->error = _("Name is missing"); - return false; - } - if (empty($userdata['email'])) { - $this->error = _("E-mail address is missing"); - return false; - } - if (empty($userdata['nickname'])) { - $userdata['nickname'] = $userdata['email']; - } - - if (eregi('[ \\:\\|\\#\\"\\!]', $userdata['nickname'])) { - $this->error = _("Nickname contains illegal characters"); - return false; - } - - /* Check that specified backend accept new entries */ - if (!$this->backends[$bnum]->writeable) { - $this->error = _("Addressbook is read-only"); - return false; - } - - /* Add address to backend */ - $res = $this->backends[$bnum]->add($userdata); - if ($res) { - return $bnum; - } else { - $this->error = $this->backends[$bnum]->error; - return false; - } - - return false; // Not reached - } /* end of add() */ - - - /* - * Remove the user identified by $alias from backend $bnum - * If $alias is an array, all users in the array are removed. - */ - function remove($alias, $bnum) { - - /* Check input */ - if (empty($alias)) { - return true; - } - - /* Convert string to single element array */ - if (!is_array($alias)) { - $alias = array(0 => $alias); - } - - /* Check that specified backend is writable */ - if (!$this->backends[$bnum]->writeable) { - $this->error = _("Addressbook is read-only"); - return false; - } - - /* Remove user from backend */ - $res = $this->backends[$bnum]->remove($alias); - if ($res) { - return $bnum; - } else { - $this->error = $this->backends[$bnum]->error; - return false; - } - - return FALSE; /* Not reached */ - } /* end of remove() */ + usort($alist,'alistcmp'); + $prevbackend = -1; + $headerprinted = false; + echo html_tag( 'p', '' . _("Add address") . '', 'center' ) . "\n"; - /* - * Remove the user identified by $alias from backend $bnum - * If $alias is an array, all users in the array are removed. - */ - function modify($alias, $userdata, $bnum) { + /* List addresses */ + if (count($alist) > 0) { + echo '
' . "\n"; + while(list($undef,$row) = each($alist)) { - /* Check input */ - if (empty($alias) || !is_string($alias)) { - return true; - } - - /* Validate data */ - if(!is_array($userdata)) { - $this->error = _("Invalid input data"); - return false; - } - if (empty($userdata['firstname']) && empty($userdata['lastname'])) { - $this->error = _("Name is missing"); - return false; - } - if (empty($userdata['email'])) { - $this->error = _("E-mail address is missing"); - return false; - } - - if (eregi('[\\: \\|\\#"\\!]', $userdata['nickname'])) { - $this->error = _("Nickname contains illegal characters"); - return false; - } - - if (empty($userdata['nickname'])) { - $userdata['nickname'] = $userdata['email']; - } - - /* Check that specified backend is writable */ - if (!$this->backends[$bnum]->writeable) { - $this->error = _("Addressbook is read-only");; - return false; - } - - /* Modify user in backend */ - $res = $this->backends[$bnum]->modify($alias, $userdata); - if ($res) { - return $bnum; - } else { - $this->error = $this->backends[$bnum]->error; - return false; - } - - return FALSE; /* Not reached */ - } /* end of modify() */ - - -} /* End of class Addressbook */ - -/* - * Generic backend that all other backends extend - */ -class addressbook_backend { - - /* Variables that all backends must provide. */ - var $btype = 'dummy'; - var $bname = 'dummy'; - var $sname = 'Dummy backend'; - - /* - * Variables common for all backends, but that - * should not be changed by the backends. - */ - var $bnum = -1; - var $error = ''; - var $writeable = false; - - function set_error($string) { - $this->error = '[' . $this->sname . '] ' . $string; - return false; - } - - - /* ========================== Public ======================== */ + /* 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' ); + } - function search($expression) { - $this->set_error('search not implemented'); - return false; - } + echo html_tag( 'table', + html_tag( 'tr', + html_tag( 'td', "\n" . '' . $row['source'] . '' . "\n", 'center', $color[0] ) + ) , + 'center', '', 'width="95%" cols="1"' ) ."\n" + . html_tag( 'table', '', 'center', '', 'cols="5" 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"; - function lookup($alias) { - $this->set_error('lookup not implemented'); - return false; - } + $line = 0; + $headerprinted = true; + } /* End of header */ - function list_addr() { - $this->set_error('list_addr not implemented'); - return false; - } + $prevbackend = $row['backend']; - function add($userdata) { - $this->set_error('add not implemented'); - return false; - } - - function remove($alias) { - $this->set_error('delete not implemented'); - return false; - } + /* Check if this user is selected */ + if(in_array($row['backend'] . ':' . $row['nickname'], $defselected)) { + $selected = 'CHECKED'; + } else { + $selected = ''; + } - function modify($alias, $newuserdata) { - $this->set_error('modify not implemented'); - return false; - } - -} - -/* 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; + /* Print one row */ + $tr_bgcolor = ''; + if ($line % 2) { $tr_bgcolor = $color[0]; } + echo html_tag( 'tr', '') . + 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' ) . ' '; + if ($compose_new_win == '1') { + echo ''; + } + else { + echo ''; + } + echo $row['email'] . ' '."\n". + html_tag( 'td', ' ' . $row['label'] . ' ', 'left', '', 'valign="top" width="1%"' ) . + "\n"; + $line++; } + + /* End of list. Close table. */ + if ($headerprinted) { + echo html_tag( 'tr', + html_tag( 'td', + '\n" . + '\n", + 'center', '', 'colspan="5"' ) + ); + } + echo '
'; } - return (strtolower($a['name']) > strtolower($b['name'])) ? 1 : -1; -} - +} /* end of addresslist */ + + +/* Display the "new address" form */ +echo '' . "\n" . + '
' . "\n" . + html_tag( 'table', + html_tag( 'tr', + html_tag( 'td', "\n". '' . sprintf(_("Add to %s"), $abook->localbackendname) . '' . "\n", + 'center', $color[0] + ) + ) + , 'center', '', 'width="100%" cols="1"' ) ."\n"; +address_form('addaddr', _("Add address"), $defdata); +echo '
'; + +/* Add hook for anything that wants on the bottom */ +do_hook('addressbook_bottom'); ?> + + \ No newline at end of file -- 2.25.1