* @subpackage addressbook
*/
-/**
- * If SM_PATH isn't defined, define it. Required to include files.
- * @ignore
- */
-if (!defined('SM_PATH')) {
- define('SM_PATH','../');
-}
-
-/* required includes */
-include_once(SM_PATH . 'functions/display_messages.php');
+/** required includes */
+// FIXME, NO display code in functions files
include_once(SM_PATH . 'templates/util_global.php');
-global $addrbook_dsn, $addrbook_global_dsn;
-
/**
* 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
+ * @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, $color, $ldap_server, $address_book_global_filename;
+ 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;
* 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.="<br />\n";
+ $abook_init_error.=_("Error initializing other address books.") . "<br />\n" . $abook->error;
+ }
if (! $onlylocal) {
/* Load configured LDAP servers (if PHP has LDAP support) */
* display address book init errors.
*/
if ($abook_init_error!='' && $showerr) {
- error_box($abook_init_error,$color);
+ error_box($abook_init_error);
}
/* Return the initialized object */
/* 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 '
<a href="' . $form_url .'?abook_sort_order=' . $which .
- '">' .
- getIcon($icon_theme_path, $img, $alt_tag, _("Click here to change the sorting of the address list")) .
+ return '
<a href="' . $form_url .'?abook_sort_order=' . $which .
+ '" style="text-decoration:none" title="'.$alt_tag.'">' .
+ getIcon($icon_theme_path, $img, $text_icon, $alt_tag) .
'</a>';
}
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
+ *
+ * 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
+ * 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
* @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;
/**
* Search for entries in backend
*
- * Working backend should support use of wildcards. * symbol
+ * Working backend should support use of wildcards. * symbol
* should match one or more symbols. ? symbol should match any
- * single symbol.
+ * single symbol.
* @param string $expression
* @return bool
*/
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');
-}
-
-/*
- * 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
projects / squirrelmail.git / blobdiff