<?php
+
/**
- * addressbook.php
- *
- * Copyright (c) 1999-2004 The SquirrelMail Project Team
- * Licensed under the GNU GPL. For full terms see the file COPYING.
+ * functions/addressbook.php - Functions and classes for the addressbook system
*
- * Functions and classes for the addressbook system.
+ * Functions require SM_PATH and support of forms.php functions
*
+ * @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 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;
- $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;
+ 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
'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($abook_global_file) && isset($abook_global_file_writeable)
- && trim($abook_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
- $abook_global_filename=$data_dir . $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,
- 'writeable'=> $abook_global_file_writeable));
+ '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;
}
}
'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:") .
- "<br />\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 */
'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.
$td_str .= $add ;
return html_tag( 'tr' ,
- html_tag( 'td', $label . ':', 'right', $color[4]) .
+ html_tag( 'td', '<label for="'.$name.'_'.$field.'_'.'">' .
+ $label . '</label>:', 'right', $color[4]) .
html_tag( 'td', $td_str, 'left', $color[4])
)
. "\n";
}
}
+/**
+ * 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 = '<select name="backend">';
$backends = $abook->get_backend_list();
+ $writeable_abooks=array();
while (list($undef,$v) = each($backends)) {
if ($v->writeable) {
- $ret .= '<option value="' . $v->bnum;
- $ret .= '">' . $v->sname . "</option>\n";
+ // add each backend to array
+ $writeable_abooks[$v->bnum]=$v->sname;
+ // save backend number
+ $writeable_abook=$v->bnum;
}
}
- $ret .= "</select>";
- 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";
}
/**
* @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 ' <a href="' . $form_url .'?abook_sort_order=' . $which
- . '"><img src="../images/' . $img
- . '" border="0" width="12" height="10" alt="' . $alt_tag . '" title="'
- . _("Click here to change the sorting of the address list") .'" /></a>';
+ /* Now that we have everything figured out, show the actual button. */
+ 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 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.
* @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;
if (is_array($res)) {
$ret = array_merge($ret, $res);
} else {
- $this->error .= "<br />\n" . $backend->error;
+ $this->error .= "\n" . $backend->error;
$failed++;
}
}
$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 .= "<br />\n" . $this->backends[$bnum]->error;
+ $this->error .= "\n" . $this->backends[$bnum]->error;
$ret = FALSE;
}
}
$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;
}
}
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]);
}
}
/**
- * Create a new address
+ * 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
$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;
}
/**
* 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 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
*/
$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;
}
$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;
}
/**
* 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;
}
* @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;
}
* @return bool
*/
function add($userdata) {
- $this->set_error('add not implemented');
+ $this->set_error('add is not implemented');
return false;
}
* @return bool
*/
function remove($alias) {
- $this->set_error('delete not implemented');
+ $this->set_error('delete is not implemented');
return false;
}
* @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
+ * @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);
+ }
+ }
}
-
-/*
- * 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