X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=functions%2Faddressbook.php;h=59256d7d8a1994956dc614343bbc946b88a17f56;hb=cffbdf90421ea9ad911b7d01a458ba26c8c0fb11;hp=4ffed913b1fbde92dffa4cabf21be0ee5d0fb5df;hpb=c6b8b46c20800c58b548b0541ef7af067845c0b3;p=squirrelmail.git diff --git a/functions/addressbook.php b/functions/addressbook.php index 4ffed913..59256d7d 100644 --- a/functions/addressbook.php +++ b/functions/addressbook.php @@ -1,49 +1,44 @@ 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; - $address_book_global_filename = "$data_dir/global.abook"; - -*/ - -global $addrbook_dsn, $addrbook_global_dsn; +/** required includes */ +// FIXME, NO display code in functions files +include_once(SM_PATH . 'templates/util_global.php'); /** - Create and initialize an addressbook object. - Returns the created object -*/ + * Create and initialize an addressbook object. + * @param boolean $showerr display any address book init errors. html page header + * must be created before calling addressbook_init() with $showerr enabled. + * @param boolean $onlylocal enable only local address book backends. Should + * be used when code does not need access to remote backends. Backends + * that provide read only address books with limited listing options can be + * tagged as remote. + * @return object address book object. + */ function addressbook_init($showerr = true, $onlylocal = false) { global $data_dir, $username, $ldap_server, $address_book_global_filename; global $addrbook_dsn, $addrbook_table; + global $abook_global_file, $abook_global_file_writeable, $abook_global_file_listing; global $addrbook_global_dsn, $addrbook_global_table, $addrbook_global_writeable, $addrbook_global_listing; + global $abook_file_line_length; /* Create a new addressbook object */ $abook = new AddressBook; + /* Create empty error message */ + $abook_init_error=''; + /* Always add a local backend. We use *either* file-based *or* a database addressbook. If $addrbook_dsn is set, the database @@ -58,27 +53,53 @@ function addressbook_init($showerr = true, $onlylocal = false) { 'owner' => $username, 'table' => $addrbook_table)); if (!$r && $showerr) { - echo _("Error initializing addressbook database."); - exit; + $abook_init_error.=_("Error initializing address book database.") . "\n" . $abook->error; } } else { /* File */ $filename = getHashedFile($username, $data_dir, "$username.abook"); $r = $abook->add_backend('local_file', Array('filename' => $filename, - 'create' => true)); + 'line_length' => $abook_file_line_length, + 'create' => true)); if(!$r && $showerr) { - printf( _("Error opening file %s"), $filename ); - exit; + // no need to use $abook->error, because message explains error. + $abook_init_error.=sprintf( _("Error opening file %s"), $filename ); } - } - /* This would be for the global addressbook */ - if (isset($address_book_global_filename)) { - $r = $abook->add_backend('global_file'); + /* Global file based addressbook */ + if (isset($abook_global_file) && + isset($abook_global_file_writeable) && + isset($abook_global_file_listing) && + trim($abook_global_file)!=''){ + + // Detect place of address book + if (! preg_match("/[\/\\\]/",$abook_global_file)) { + /* no path chars, address book stored in data directory + * make sure that there is a slash between data directory + * and address book file name + */ + $abook_global_filename=$data_dir + . ((substr($data_dir, -1) != '/') ? '/' : '') + . $abook_global_file; + } elseif (preg_match("/^\/|\w:/",$abook_global_file)) { + // full path is set in options (starts with slash or x:) + $abook_global_filename=$abook_global_file; + } else { + $abook_global_filename=SM_PATH . $abook_global_file; + } + + $r = $abook->add_backend('local_file',array('filename'=>$abook_global_filename, + 'name' => _("Global address book"), + 'detect_writeable' => false, + 'line_length' => $abook_file_line_length, + 'writeable'=> $abook_global_file_writeable, + 'listing' => $abook_global_file_listing)); + + /* global abook init error is not fatal. add error message and continue */ if (!$r && $showerr) { - echo _("Error initializing global addressbook."); - exit; + if ($abook_init_error!='') $abook_init_error.="\n"; + $abook_init_error.=_("Error initializing global address book.") . "\n" . $abook->error; } } @@ -95,35 +116,54 @@ function addressbook_init($showerr = true, $onlylocal = false) { 'writeable' => $addrbook_global_writeable, 'listing' => $addrbook_global_listing, 'table' => $addrbook_global_table)); + /* global abook init error is not fatal. add error message and continue */ + if (!$r && $showerr) { + if ($abook_init_error!='') $abook_init_error.="\n"; + $abook_init_error.=_("Error initializing global address book.") . "\n" . $abook->error; + } } /* * hook allows to include different address book backends. * plugins should extract $abook and $r from arguments * and use same add_backend commands as above functions. + * Since 1.5.2 hook sends third ($onlylocal) argument to address book + * plugins in order to allow detection of local address book init. + * @since 1.5.1 and 1.4.5 */ - $hookReturn = do_hook('abook_init', $abook, $r); + $hookReturn = do_hook('abook_init', $abook, $r, $onlylocal); $abook = $hookReturn[1]; $r = $hookReturn[2]; - - if ($onlylocal) { - return $abook; + if (!$r && $showerr) { + if ($abook_init_error!='') $abook_init_error.="\n"; + $abook_init_error.=_("Error initializing other address books.") . "\n" . $abook->error; } /* Load configured LDAP servers (if PHP has LDAP support) */ - if (isset($ldap_server) && is_array($ldap_server) && function_exists('ldap_connect')) { + if (isset($ldap_server) && is_array($ldap_server)) { 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; - } + if (!is_array($param)) + continue; + + /* if onlylocal is true, we only add writeable ldap servers */ + if ($onlylocal && (!isset($param['writeable']) || $param['writeable'] != true)) + continue; + + $r = $abook->add_backend('ldap_server', $param); + if (!$r && $showerr) { + if ($abook_init_error!='') $abook_init_error.="\n"; + $abook_init_error.=sprintf(_("Error initializing LDAP server %s:"), $param['host'])."\n"; + $abook_init_error.= $abook->error; } } + } // end of ldap server init + + /** + * display address book init errors. + */ + if ($abook_init_error!='' && $showerr) { + error_box(nl2br(htmlspecialchars($abook_init_error))); } /* Return the initialized object */ @@ -150,12 +190,12 @@ function abook_create_form($form_url,$name,$title,$button,$defdata=array()) { 'center', $color[0] ) ) - , 'center', '', 'width="100%"' ) ."\n"; + , 'center', '', 'width="90%"' ) ."\n"; address_form($name, $button, $defdata); } -/* +/** * Had to move this function outside of the Addressbook Class * PHP 4.0.4 Seemed to be having problems with inline functions. * Note: this can return now since we don't support 4.0.4 anymore. @@ -193,7 +233,8 @@ function addressbook_inp_field($label, $field, $name, $size, $values, $add='') { $td_str .= $add ; return html_tag( 'tr' , - html_tag( 'td', $label . ':', 'right', $color[4]) . + html_tag( 'td', ':', 'right', $color[4]) . html_tag( 'td', $td_str, 'left', $color[4]) ) . "\n"; @@ -238,28 +279,40 @@ function address_form($name, $submittext, $values = array()) { } } +/** + * Provides list of writeable backends. + * Works only when address is added ($name='addaddr') + * @param string $name name of form + * @return string html formated backend field (select or hidden) + */ function list_writable_backends($name) { global $color, $abook; if ( $name != 'addaddr' ) { return; } + $writeable_abook = 1; 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"; + if (count($writeable_abooks)>1) { + // we have more than one writeable backend + $ret=addSelect('backend',$writeable_abooks,null,true); + return html_tag( 'tr', + html_tag( 'td', _("Add to:"),'right', $color[4] ) . + html_tag( 'td', $ret, 'left', $color[4] )) . "\n"; + } } + // Only one backend exists or is writeable. + return html_tag( 'tr', + html_tag( 'td', + addHidden('backend', $writeable_abook), + 'center', $color[4], 'colspan="2"')) . "\n"; } /** @@ -338,25 +391,28 @@ function get_abook_sort() { * @return string html code with sorting images and urls */ function show_abook_sort_button($abook_sort_order, $alt_tag, $Down, $Up ) { - global $form_url; + global $form_url, $icon_theme_path; /* Figure out which image we want to use. */ if ($abook_sort_order != $Up && $abook_sort_order != $Down) { $img = 'sort_none.png'; + $text_icon = '◻'; // U+25FB WHITE MEDIUM SQUARE $which = $Up; } elseif ($abook_sort_order == $Up) { $img = 'up_pointer.png'; + $text_icon = '⇧'; // U+21E7 UPWARDS WHITE ARROW $which = $Down; } else { $img = 'down_pointer.png'; + $text_icon = '⇩'; // U+21E9 DOWNWARDS WHITE ARROW $which = 8; } - /* Now that we have everything figured out, show the actual button. */ - return ' ' . $alt_tag . ''; + /* Now that we have everything figured out, show the actual button. */ + return ' ' . + getIcon($icon_theme_path, $img, $text_icon, $alt_tag) . + ''; } @@ -367,21 +423,58 @@ function show_abook_sort_button($abook_sort_order, $alt_tag, $Down, $Up ) { * @subpackage addressbook */ class AddressBook { - + /** + * Enabled address book backends + * @var array + */ var $backends = array(); + /** + * Number of enabled backends + * @var integer + */ var $numbackends = 0; + /** + * Error messages + * @var string + */ var $error = ''; + /** + * id of backend with personal address book + * @var integer + */ var $localbackend = 0; + /** + * Name of backend with personal address book + * @var string + */ var $localbackendname = ''; + /** + * Controls use of 'extra' field + * + * Extra field can be used to add link to form, which allows + * to modify all fields supported by backend. This is the only field + * that is not sanitized with htmlspecialchars. Backends MUST make + * sure that field data is sanitized and displayed correctly inside + * table cell. Use of html formating in other address book fields is + * not allowed. Backends that don't return 'extra' row in address book + * data should not modify this object property. + * @var boolean + * @since 1.5.1 + */ + var $add_extra_field = false; - // Constructor function. + /** + * Constructor function. + */ function AddressBook() { $this->localbackendname = _("Personal address book"); } - /* + /** * Return an array of backends of a given type, * or all backends if no type is specified. + * @param string $type backend type + * @return array list of backends */ function get_backend_list($type = '') { $ret = array(); @@ -394,17 +487,42 @@ class AddressBook { } - /* - ========================== Public ======================== + /* ========================== 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. + /** + * Add a new backend. + * + * @param string $backend backend name (without the abook_ prefix) + * @param mixed optional variable that is passed to the backend constructor. + * See each of the backend classes for valid parameters + * @return integer number of backends */ function add_backend($backend, $param = '') { + static $backend_classes; + if (!isset($backend_classes)) { + $backend_classes = array(); + } + if (!isset($backend_classes[$backend])) { + /** + * Support backend provided by plugins. Plugin function must + * return an associative array with as key the backend name ($backend) + * and as value the file including the path containing the backend class. + * i.e.: $aBackend = array('backend_template' => SM_PATH . 'plugins/abook_backend_template/functions.php') + * + * NB: Because the backend files are included from within this function they DO NOT have access to + * vars in the global scope. This function is the global scope for the included backend !!! + */ + $aBackend = do_hook('abook_add_class'); + if (isset($aBackend) && is_array($aBackend) && isset($aBackend[$backend])) { + require_once($aBackend[$backend]); + } else { + require_once(SM_PATH . 'functions/abook_'.$backend.'.php'); + } + $backend_classes[$backend] = true; + } $backend_name = 'abook_' . $backend; - eval('$newback = new ' . $backend_name . '($param);'); + $newback = new $backend_name($param); + //eval('$newback = new ' . $backend_name . '($param);'); if(!empty($newback->error)) { $this->error = $newback->error; return false; @@ -425,12 +543,15 @@ class AddressBook { } - /* + /** + * create string with name and email address + * * This function takes a $row array as returned by the addressbook * search and returns an e-mail address with the full name or * nickname optionally prepended. + * @param array $row address book entry + * @return string email address with real name prepended */ - function full_address($row) { global $addrsrch_fullname, $data_dir, $username; $prefix = getPref($data_dir, $username, 'addrsrch_fullname'); @@ -443,10 +564,15 @@ class AddressBook { } } - /* - Return a list of addresses matching expression in - all backends of a given type. - */ + /** + * Search for entries in address books + * + * Return a list of addresses matching expression in + * all backends of a given type. + * @param string $expression search expression + * @param integer $bnum backend number. default to search in all backends + * @return array search results + */ function search($expression, $bnum = -1) { $ret = array(); $this->error = ''; @@ -462,7 +588,7 @@ class AddressBook { if (is_array($res)) { $ret = array_merge($ret, $res); } else { - $this->error .= "
\n" . $backend->error; + $this->error .= "\n" . $backend->error; $failed++; } } @@ -472,13 +598,17 @@ class AddressBook { $ret = FALSE; } - } else { + } elseif (! isset($this->backends[$bnum])) { + /* make sure that backend exists */ + $this->error = _("Unknown address book backend"); + $ret = false; + } else { /* Search only one backend */ $ret = $this->backends[$bnum]->search($expression); if (!is_array($ret)) { - $this->error .= "
\n" . $this->backends[$bnum]->error; + $this->error .= "\n" . $this->backends[$bnum]->error; $ret = FALSE; } } @@ -487,7 +617,12 @@ class AddressBook { } - /* Return a sorted search */ + /** + * Sorted search + * @param string $expression search expression + * @param integer $bnum backend number. default to search in all backends + * @return array search results + */ function s_search($expression, $bnum = -1) { $ret = $this->search($expression, $bnum); @@ -498,20 +633,27 @@ class AddressBook { } - /* - * Lookup an address by alias. Only possible in - * local backends. + /** + * Lookup an address by alias. + * Only possible in local backends. + * @param string $alias + * @param integer backend number + * @return array lookup results. False, if not found. */ function lookup($alias, $bnum = -1) { $ret = array(); if ($bnum > -1) { + if (!isset($this->backends[$bnum])) { + $this->error = _("Unknown address book backend"); + return false; + } $res = $this->backends[$bnum]->lookup($alias); if (is_array($res)) { return $res; } else { - $this->error = $backend->error; + $this->error = $this->backends[$bnum]->error; return false; } } @@ -534,12 +676,20 @@ class AddressBook { } - /* Return all addresses */ + /** + * Return all addresses + * @param integer $bnum backend number + * @return array search results + */ function list_addr($bnum = -1) { $ret = array(); if ($bnum == -1) { - $sel = $this->get_backend_list('local'); + $sel = $this->get_backend_list(''); + } elseif (! isset($this->backends[$bnum])) { + /* make sure that backend exists */ + $this->error = _("Unknown address book backend"); + $ret = false; } else { $sel = array(0 => &$this->backends[$bnum]); } @@ -559,9 +709,11 @@ class AddressBook { return $ret; } - /* - * Create a new address from $userdata, in backend $bnum. - * Return the backend number that the/ address was added + /** + * Create a new address + * @param array $userdata added address record + * @param integer $bnum backend number + * @return integer the backend number that the/ address was added * to, or false if it failed. */ function add($userdata, $bnum) { @@ -583,14 +735,21 @@ class AddressBook { $userdata['nickname'] = $userdata['email']; } + /* Blocks use of space, :, |, #, " and ! in nickname */ if (eregi('[ \\:\\|\\#\\"\\!]', $userdata['nickname'])) { $this->error = _("Nickname contains illegal characters"); return false; } + /* make sure that backend exists */ + if (! isset($this->backends[$bnum])) { + $this->error = _("Unknown address book backend"); + return false; + } + /* Check that specified backend accept new entries */ if (!$this->backends[$bnum]->writeable) { - $this->error = _("Addressbook is read-only"); + $this->error = _("Address book is read-only"); return false; } @@ -607,9 +766,11 @@ class AddressBook { } /* end of add() */ - /* - * Remove the user identified by $alias from backend $bnum - * If $alias is an array, all users in the array are removed. + /** + * Remove the entries from address book + * @param mixed $alias entries that have to be removed. Can be string with nickname or array with list of nicknames + * @param integer $bnum backend number + * @return bool true if removed successfully. false if there s an error. $this->error contains error message */ function remove($alias, $bnum) { @@ -623,9 +784,15 @@ class AddressBook { $alias = array(0 => $alias); } + /* make sure that backend exists */ + if (! isset($this->backends[$bnum])) { + $this->error = _("Unknown address book backend"); + return false; + } + /* Check that specified backend is writable */ if (!$this->backends[$bnum]->writeable) { - $this->error = _("Addressbook is read-only"); + $this->error = _("Address book is read-only"); return false; } @@ -642,9 +809,11 @@ class AddressBook { } /* end of remove() */ - /* - * Remove the user identified by $alias from backend $bnum - * If $alias is an array, all users in the array are removed. + /** + * Modify entry in address book + * @param string $alias nickname + * @param array $userdata newdata + * @param integer $bnum backend number */ function modify($alias, $userdata, $bnum) { @@ -676,9 +845,15 @@ class AddressBook { $userdata['nickname'] = $userdata['email']; } + /* make sure that backend exists */ + if (! isset($this->backends[$bnum])) { + $this->error = _("Unknown address book backend"); + return false; + } + /* Check that specified backend is writable */ if (!$this->backends[$bnum]->writeable) { - $this->error = _("Addressbook is read-only");; + $this->error = _("Address book is read-only");; return false; } @@ -705,18 +880,49 @@ class AddressBook { class addressbook_backend { /* Variables that all backends must provide. */ + /** + * Backend type + * + * Can be 'local' or 'remote' + * @var string backend type + */ var $btype = 'dummy'; + /** + * Internal backend name + * @var string + */ var $bname = 'dummy'; + /** + * Displayed backend name + * @var string + */ var $sname = 'Dummy backend'; /* * Variables common for all backends, but that * should not be changed by the backends. */ + /** + * Backend number + * @var integer + */ var $bnum = -1; + /** + * Error messages + * @var string + */ var $error = ''; + /** + * Writeable flag + * @var bool + */ var $writeable = false; + /** + * Set error message + * @param string $string error message + * @return bool + */ function set_error($string) { $this->error = '[' . $this->sname . '] ' . $string; return false; @@ -725,63 +931,88 @@ class addressbook_backend { /* ========================== Public ======================== */ + /** + * Search for entries in backend + * + * Working backend should support use of wildcards. * symbol + * should match one or more symbols. ? symbol should match any + * single symbol. + * @param string $expression + * @return bool + */ function search($expression) { - $this->set_error('search not implemented'); + $this->set_error('search is not implemented'); return false; } + /** + * Find entry in backend by alias + * @param string $alias name used for id + * @return bool + */ function lookup($alias) { - $this->set_error('lookup not implemented'); + $this->set_error('lookup is not implemented'); return false; } + /** + * List all entries in backend + * + * Working backend should provide this function or at least + * dummy function that returns empty array. + * @return bool + */ function list_addr() { - $this->set_error('list_addr not implemented'); + $this->set_error('list_addr is not implemented'); return false; } + /** + * Add entry to backend + * @param array userdata + * @return bool + */ function add($userdata) { - $this->set_error('add not implemented'); + $this->set_error('add is not implemented'); return false; } + /** + * Remove entry from backend + * @param string $alias name used for id + * @return bool + */ function remove($alias) { - $this->set_error('delete not implemented'); + $this->set_error('delete is not implemented'); return false; } + /** + * Modify entry in backend + * @param string $alias name used for id + * @param array $newuserdata new data + * @return bool + */ function modify($alias, $newuserdata) { - $this->set_error('modify not implemented'); + $this->set_error('modify is not implemented'); return false; } + /** + * Creates full name from given name and surname + * + * Handles name order differences + * @param string $firstname given name + * @param string $lastname surname + * @return string full name + * @since 1.5.2 + */ + function fullname($firstname,$lastname) { + global $squirrelmail_language; + if ($squirrelmail_language=='ja_JP') { + return trim($lastname . ' ' . $firstname); + } else { + return trim($firstname . ' ' . $lastname); + } + } } - -/* - PHP 5 requires that the class be made first, which seems rather - logical, and should have been the way it was generated the first time. -*/ - -require_once(SM_PATH . 'functions/abook_local_file.php'); -require_once(SM_PATH . 'functions/abook_ldap_server.php'); - -/* Use this if you wanna have a global address book */ -if (isset($address_book_global_filename)) { - include_once(SM_PATH . 'functions/abook_global_file.php'); -} - -/* Only load database backend if database is configured */ -if((isset($addrbook_dsn) && !empty($addrbook_dsn)) || - (isset($addrbook_global_dsn) && !empty($addrbook_global_dsn)) ) { - include_once(SM_PATH . 'functions/abook_database.php'); -} - -/* - * hook allows adding different address book classes. - * class must follow address book class coding standards. - * - * see addressbook_backend class and functions/abook_*.php files. - */ -do_hook('abook_add_class'); - -?> \ No newline at end of file