X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=functions%2Faddressbook.php;h=9e9d02958e2ee43b86d4a1bc4fed871f2c1c0281;hb=8ce0f071bf3515816b92e306bae8baa0138d9397;hp=ae524b77130abbed232eba4d4cbd0e1c511b5320;hpb=7390e24059ba28045540f784dccc24f05171af4c;p=squirrelmail.git diff --git a/functions/addressbook.php b/functions/addressbook.php index ae524b77..9e9d0295 100644 --- a/functions/addressbook.php +++ b/functions/addressbook.php @@ -1,43 +1,32 @@ $username, 'table' => $addrbook_table)); if (!$r && $showerr) { - $abook_init_error.=_("Error initializing addressbook database.") . "
\n" . $abook->error; + $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) { // no need to use $abook->error, because message explains error. $abook_init_error.=sprintf( _("Error opening file %s"), $filename ); @@ -97,13 +87,14 @@ function addressbook_init($showerr = true, $onlylocal = false) { $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) { - if ($abook_init_error!='') $abook_init_error.="
\n"; - $abook_init_error.=_("Error initializing global addressbook.") . "
\n" . $abook->error; + if ($abook_init_error!='') $abook_init_error.="\n"; + $abook_init_error.=_("Error initializing global address book.") . "\n" . $abook->error; } } @@ -122,8 +113,8 @@ function addressbook_init($showerr = true, $onlylocal = false) { '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 addressbook.") . "
\n" . $abook->error; + if ($abook_init_error!='') $abook_init_error.="\n"; + $abook_init_error.=_("Error initializing global address book.") . "\n" . $abook->error; } } @@ -131,35 +122,43 @@ function addressbook_init($showerr = true, $onlylocal = false) { * 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 (!$r && $showerr) { + if ($abook_init_error!='') $abook_init_error.="\n"; + $abook_init_error.=_("Error initializing other address books.") . "\n" . $abook->error; + } - if (! $onlylocal) { - /* Load configured LDAP servers (if PHP has LDAP support) */ - 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) { - if ($abook_init_error!='') $abook_init_error.="
\n"; - $abook_init_error.=sprintf(_("Error initializing LDAP server %s:") . - "
\n", $param['host']); - $abook_init_error.= $abook->error; - } - } + /* Load configured LDAP servers (if PHP has LDAP support) */ + if (isset($ldap_server) && is_array($ldap_server)) { + reset($ldap_server); + while (list($undef,$param) = each($ldap_server)) { + 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 - } // end of remote abook backend init + } + } // end of ldap server init /** * display address book init errors. */ if ($abook_init_error!='' && $showerr) { - error_box($abook_init_error,$color); + error_box(nl2br(htmlspecialchars($abook_init_error))); } /* Return the initialized object */ @@ -191,7 +190,7 @@ function abook_create_form($form_url,$name,$title,$button,$defdata=array()) { } -/* +/** * 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. @@ -229,7 +228,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"; @@ -386,25 +386,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) . + ''; } @@ -440,6 +443,20 @@ class AddressBook { * @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. @@ -476,8 +493,31 @@ class AddressBook { * @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; @@ -543,7 +583,7 @@ class AddressBook { if (is_array($res)) { $ret = array_merge($ret, $res); } else { - $this->error .= "
\n" . $backend->error; + $this->error .= "\n" . $backend->error; $failed++; } } @@ -553,13 +593,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; } } @@ -596,11 +640,15 @@ class AddressBook { $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; } } @@ -626,13 +674,17 @@ class AddressBook { /** * Return all addresses * @param integer $bnum backend number - * @return array search results + * @return mixed array with search results or boolean false on error. */ function list_addr($bnum = -1) { $ret = array(); if ($bnum == -1) { $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]); } @@ -678,14 +730,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; } @@ -720,9 +779,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; } @@ -775,9 +840,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; } @@ -857,11 +928,15 @@ class addressbook_backend { /** * 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; } @@ -871,16 +946,19 @@ class addressbook_backend { * @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; } @@ -890,7 +968,7 @@ class addressbook_backend { * @return bool */ function add($userdata) { - $this->set_error('add not implemented'); + $this->set_error('add is not implemented'); return false; } @@ -900,7 +978,7 @@ class addressbook_backend { * @return bool */ function remove($alias) { - $this->set_error('delete not implemented'); + $this->set_error('delete is not implemented'); return false; } @@ -911,32 +989,30 @@ class addressbook_backend { * @return bool */ function modify($alias, $newuserdata) { - $this->set_error('modify not implemented'); + $this->set_error('modify is not implemented'); return false; } -} - -/* - 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'); -/* 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'); + /** + * Creates full name from given name and surname + * + * Handles name order differences. Function always runs in SquirrelMail gettext domain. + * Plugins don't have to switch domains before calling this function. + * @param string $firstname given name + * @param string $lastname surname + * @return string full name + * @since 1.5.2 + */ + function fullname($firstname,$lastname) { + /** + * i18n: allows to control fullname layout in address book listing + * first %s is for first name, second %s is for last name. + * Translate it to '%2$s %1$s', if surname must be displayed first in your language. + * Please note that variables can be set to empty string and extra formating + * (for example '%2$s, %1$s' as in 'Smith, John') might break. Use it only for + * setting name and surname order. scripts will remove all prepended and appended + * whitespace. + */ + return trim(sprintf(dgettext('squirrelmail',"%s %s"),$firstname,$lastname)); + } } - -/* - * hook allows adding different address book classes. - * class must follow address book class coding standards. - * - * see addressbook_backend class and functions/abook_*.php files. - * @since 1.5.1 and 1.4.5 - */ -do_hook('abook_add_class'); - -?> \ No newline at end of file