<?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";
+ * If SM_PATH isn't defined, define it. Required to include files.
+ * @ignore
+ */
+if (!defined('SM_PATH')) {
+ define('SM_PATH','../');
+}
-*/
+/* make sure that display_messages.php is loaded */
+include_once(SM_PATH . 'functions/display_messages.php');
global $addrbook_dsn, $addrbook_global_dsn;
/**
- 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
+ * @return object address book object.
+ */
function addressbook_init($showerr = true, $onlylocal = false) {
- global $data_dir, $username, $ldap_server, $address_book_global_filename;
+ global $data_dir, $username, $color, $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;
/* 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 addressbook database.") . "<br />\n" . $abook->error;
}
} else {
/* File */
$r = $abook->add_backend('local_file', Array('filename' => $filename,
'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,
+ '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.="<br />\n";
+ $abook_init_error.=_("Error initializing global addressbook.") . "<br />\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.="<br />\n";
+ $abook_init_error.=_("Error initializing global addressbook.") . "<br />\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.1 and 1.4.5
*/
$hookReturn = do_hook('abook_init', $abook, $r);
$abook = $hookReturn[1];
$r = $hookReturn[2];
- 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:") .
- "<br />\n", $param['host']);
- echo ' ' . $abook->error;
- exit;
+ 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.="<br />\n";
+ $abook_init_error.=sprintf(_("Error initializing LDAP server %s:") .
+ "<br />\n", $param['host']);
+ $abook_init_error.= $abook->error;
+ }
}
}
- }
+ } // end of ldap server init
+ } // end of remote abook backend init
+
+ /**
+ * display address book init errors.
+ */
+ if ($abook_init_error!='' && $showerr) {
+ error_box($abook_init_error,$color);
}
/* 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.
}
}
+/**
+ * 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";
}
/**
*/
class AddressBook {
+ /*
+ Cleaning errors from html with htmlspecialchars:
+ Errors from the backend are cleaned up in this class because we not always
+ have control over it when error output is generated in the backend.
+ If this appears to be wrong place then clean it up at the source (the backend)
+ */
+
+ /**
+ * 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();
}
- /*
- ========================== 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 = '') {
$backend_name = 'abook_' . $backend;
}
- /*
+ /**
+ * 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');
}
}
- /*
- 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 = '';
if (is_array($res)) {
$ret = array_merge($ret, $res);
} else {
- $this->error .= "<br />\n" . $backend->error;
+ $this->error .= "<br />\n" . htmlspecialchars($backend->error);
$failed++;
}
}
$ret = $this->backends[$bnum]->search($expression);
if (!is_array($ret)) {
- $this->error .= "<br />\n" . $this->backends[$bnum]->error;
+ $this->error .= "<br />\n" . htmlspecialchars($this->backends[$bnum]->error);
$ret = FALSE;
}
}
}
- /* 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);
}
- /*
- * 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) {
if (is_array($res)) {
return $res;
} else {
- $this->error = $backend->error;
+ $this->error = htmlspecialchars($this->backends[$bnum]->error);
return false;
}
}
if(!empty($res))
return $res;
} else {
- $this->error = $backend->error;
+ $this->error = htmlspecialchars($backend->error);
return false;
}
}
}
- /* 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('');
} else {
$sel = array(0 => &$this->backends[$bnum]);
}
if (is_array($res)) {
$ret = array_merge($ret, $res);
} else {
- $this->error = $backend->error;
+ $this->error = htmlspecialchars($backend->error);
return false;
}
}
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) {
if ($res) {
return $bnum;
} else {
- $this->error = $this->backends[$bnum]->error;
+ $this->error = htmlspecialchars($this->backends[$bnum]->error);
return false;
}
} /* 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) {
if ($res) {
return $bnum;
} else {
- $this->error = $this->backends[$bnum]->error;
+ $this->error = htmlspecialchars($this->backends[$bnum]->error);
return false;
}
} /* 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) {
if ($res) {
return $bnum;
} else {
- $this->error = $this->backends[$bnum]->error;
+ $this->error = htmlspecialchars($this->backends[$bnum]->error);
return false;
}
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;
/* ========================== 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');
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');
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');
return false;
}
+ /**
+ * Add entry to backend
+ * @param array userdata
+ * @return bool
+ */
function add($userdata) {
$this->set_error('add 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');
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');
return false;
}
-
}
/*
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');
+ (isset($addrbook_global_dsn) && !empty($addrbook_global_dsn))) {
+ include_once(SM_PATH . 'functions/abook_database.php');
}
/*
* 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
+?>