X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;ds=sidebyside;f=functions%2Faddressbook.php;h=22cc1c01e2f16af4a5247c8e334bc42e381032ab;hb=62f7daa5b0686061e12aeeee9866c195488c0d44;hp=9b98f61bf386d2f1ee6a3e0a3763326eaddf4a84;hpb=bd9c880b180d3db597909c87c7cbf3fadef40be2;p=squirrelmail.git diff --git a/functions/addressbook.php b/functions/addressbook.php index 9b98f61b..22cc1c01 100644 --- a/functions/addressbook.php +++ b/functions/addressbook.php @@ -3,15 +3,17 @@ /** * addressbook.php * - * Copyright (c) 1999-2002 The SquirrelMail Project Team + * Copyright (c) 1999-2004 The SquirrelMail Project Team * Licensed under the GNU GPL. For full terms see the file COPYING. * * Functions and classes for the addressbook system. * - * $Id$ + * @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" @@ -24,34 +26,21 @@ The global addressbook is unmodifiable by anyone. You must actually use a shell script or whatnot to modify the contents. - global $data_dir; + global $data_dir, $address_book_global_filename; $address_book_global_filename = "$data_dir/global.abook"; - Include backends here. */ -require_once(SM_PATH . 'functions/abook_local_file.php'); -require_once(SM_PATH . 'functions/abook_ldap_server.php'); - -global $addrbook_dsn; +global $addrbook_dsn, $addrbook_global_dsn; -/* 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)) { - include_once(SM_PATH . 'functions/abook_database.php'); -} - -/* +/** Create and initialize an addressbook object. Returns the created object */ function addressbook_init($showerr = true, $onlylocal = false) { global $data_dir, $username, $ldap_server, $address_book_global_filename; global $addrbook_dsn, $addrbook_table; + global $addrbook_global_dsn, $addrbook_global_table, $addrbook_global_writeable, $addrbook_global_listing; /* Create a new addressbook object */ $abook = new AddressBook; @@ -94,6 +83,30 @@ function addressbook_init($showerr = true, $onlylocal = false) { } } + /* Load global addressbook from SQL if configured */ + if (isset($addrbook_global_dsn) && !empty($addrbook_global_dsn)) { + /* Database configured */ + if (!isset($addrbook_global_table) || empty($addrbook_global_table)) { + $addrbook_global_table = 'global_abook'; + } + $r = $abook->add_backend('database', + Array('dsn' => $addrbook_global_dsn, + 'owner' => 'global', + 'name' => _("Global address book"), + 'writeable' => $addrbook_global_writeable, + 'listing' => $addrbook_global_listing, + 'table' => $addrbook_global_table)); + } + + /* + * 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. + */ + $hookReturn = do_hook('abook_init', $abook, $r); + $abook = $hookReturn[1]; + $r = $hookReturn[2]; + if ($onlylocal) { return $abook; } @@ -106,7 +119,7 @@ function addressbook_init($showerr = true, $onlylocal = false) { $r = $abook->add_backend('ldap_server', $param); if (!$r && $showerr) { printf( ' ' . _("Error initializing LDAP server %s:") . - "
\n", $param['host']); + "
\n", $param['host']); echo ' ' . $abook->error; exit; } @@ -122,7 +135,8 @@ function addressbook_init($showerr = true, $onlylocal = false) { /* * 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. + */ function addressbook_cmp($a,$b) { if($a['backend'] > $b['backend']) { @@ -130,16 +144,16 @@ function addressbook_cmp($a,$b) { } else if($a['backend'] < $b['backend']) { return -1; } - + return (strtolower($a['name']) > strtolower($b['name'])) ? 1 : -1; } -/* +/** * This is the main address book class that connect all the * backends and provide services to the functions above. - * + * @package squirrelmail */ class AddressBook { @@ -149,7 +163,7 @@ class AddressBook { var $error = ''; var $localbackend = 0; var $localbackendname = ''; - + // Constructor function. function AddressBook() { $localbackendname = _("Personal address book"); @@ -190,7 +204,7 @@ class AddressBook { $newback->bnum = $this->numbackends; $this->backends[$this->numbackends] = $newback; - + /* Store ID of first local backend added */ if ($this->localbackend == 0 && $newback->btype == 'local') { $this->localbackend = $this->numbackends; @@ -202,19 +216,17 @@ class AddressBook { /* - * This function takes a $row array as returned by the addressbook + * 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. */ function full_address($row) { - global $addrsrch_fullname, $datadir, $user; - - if (($prefix = getPref($datadir, $user, 'addrsrch_fullname') or - isset($addrsrch_fullname) and $prefix = $addrsrch_fullname) - and $prefix !== 'noprefix') { - $name = ($prefix === 'nickname') ? $row['nickname'] - : $row['name']; + global $addrsrch_fullname, $data_dir, $username; + $prefix = getPref($data_dir, $username, 'addrsrch_fullname'); + if (($prefix != "" || (isset($addrsrch_fullname) && + $prefix == $addrsrch_fullname)) && $prefix != 'noprefix') { + $name = ($prefix == 'nickname' ? $row['nickname'] : $row['name']); return $name . ' <' . trim($row['email']) . '>'; } else { return trim($row['email']); @@ -240,7 +252,7 @@ class AddressBook { if (is_array($res)) { $ret = array_merge($ret, $res); } else { - $this->error .= "
\n" . $backend->error; + $this->error .= "
\n" . $backend->error; $failed++; } } @@ -256,7 +268,7 @@ class AddressBook { $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; } } @@ -267,11 +279,11 @@ class AddressBook { /* Return a sorted search */ function s_search($expression, $bnum = -1) { - + $ret = $this->search($expression, $bnum); if ( is_array( $ret ) ) { usort($ret, 'addressbook_cmp'); - } + } return $ret; } @@ -281,9 +293,9 @@ class AddressBook { * local backends. */ function lookup($alias, $bnum = -1) { - + $ret = array(); - + if ($bnum > -1) { $res = $this->backends[$bnum]->lookup($alias); if (is_array($res)) { @@ -293,7 +305,7 @@ class AddressBook { return false; } } - + $sel = $this->get_backend_list('local'); for ($i = 0 ; $i < sizeof($sel) ; $i++) { $backend = &$sel[$i]; @@ -307,7 +319,7 @@ class AddressBook { return false; } } - + return $ret; } @@ -315,13 +327,13 @@ class AddressBook { /* Return all addresses */ function list_addr($bnum = -1) { $ret = array(); - + if ($bnum == -1) { $sel = $this->get_backend_list('local'); } else { $sel = array(0 => &$this->backends[$bnum]); } - + for ($i = 0 ; $i < sizeof($sel) ; $i++) { $backend = &$sel[$i]; $backend->error = ''; @@ -333,7 +345,7 @@ class AddressBook { return false; } } - + return $ret; } @@ -343,7 +355,7 @@ class AddressBook { * to, or false if it failed. */ function add($userdata, $bnum) { - + /* Validate data */ if (!is_array($userdata)) { $this->error = _("Invalid input data"); @@ -360,18 +372,18 @@ class AddressBook { if (empty($userdata['nickname'])) { $userdata['nickname'] = $userdata['email']; } - + if (eregi('[ \\:\\|\\#\\"\\!]', $userdata['nickname'])) { $this->error = _("Nickname contains illegal characters"); return false; } - + /* Check that specified backend accept new entries */ if (!$this->backends[$bnum]->writeable) { $this->error = _("Addressbook is read-only"); return false; } - + /* Add address to backend */ $res = $this->backends[$bnum]->add($userdata); if ($res) { @@ -380,7 +392,7 @@ class AddressBook { $this->error = $this->backends[$bnum]->error; return false; } - + return false; // Not reached } /* end of add() */ @@ -390,23 +402,23 @@ class AddressBook { * If $alias is an array, all users in the array are removed. */ function remove($alias, $bnum) { - + /* Check input */ if (empty($alias)) { return true; } - + /* Convert string to single element array */ if (!is_array($alias)) { $alias = array(0 => $alias); } - + /* Check that specified backend is writable */ if (!$this->backends[$bnum]->writeable) { $this->error = _("Addressbook is read-only"); return false; } - + /* Remove user from backend */ $res = $this->backends[$bnum]->remove($alias); if ($res) { @@ -415,7 +427,7 @@ class AddressBook { $this->error = $this->backends[$bnum]->error; return false; } - + return FALSE; /* Not reached */ } /* end of remove() */ @@ -425,12 +437,12 @@ class AddressBook { * If $alias is an array, all users in the array are removed. */ function modify($alias, $userdata, $bnum) { - + /* Check input */ if (empty($alias) || !is_string($alias)) { return true; } - + /* Validate data */ if(!is_array($userdata)) { $this->error = _("Invalid input data"); @@ -444,22 +456,22 @@ class AddressBook { $this->error = _("E-mail address is missing"); return false; } - + if (eregi('[\\: \\|\\#"\\!]', $userdata['nickname'])) { $this->error = _("Nickname contains illegal characters"); return false; } - + if (empty($userdata['nickname'])) { $userdata['nickname'] = $userdata['email']; } - + /* Check that specified backend is writable */ if (!$this->backends[$bnum]->writeable) { $this->error = _("Addressbook is read-only");; return false; } - + /* Modify user in backend */ $res = $this->backends[$bnum]->modify($alias, $userdata); if ($res) { @@ -468,15 +480,16 @@ class AddressBook { $this->error = $this->backends[$bnum]->error; return false; } - + return FALSE; /* Not reached */ } /* end of modify() */ - - + + } /* End of class Addressbook */ -/* +/** * Generic backend that all other backends extend + * @package squirrelmail */ class addressbook_backend { @@ -484,7 +497,7 @@ class addressbook_backend { var $btype = 'dummy'; var $bname = 'dummy'; var $sname = 'Dummy backend'; - + /* * Variables common for all backends, but that * should not be changed by the backends. @@ -492,40 +505,40 @@ class addressbook_backend { var $bnum = -1; var $error = ''; var $writeable = false; - + function set_error($string) { $this->error = '[' . $this->sname . '] ' . $string; return false; } - - + + /* ========================== Public ======================== */ - + function search($expression) { $this->set_error('search not implemented'); return false; } - + function lookup($alias) { $this->set_error('lookup not implemented'); return false; } - + function list_addr() { $this->set_error('list_addr not implemented'); return false; } - + function add($userdata) { $this->set_error('add not implemented'); return false; } - + function remove($alias) { $this->set_error('delete not implemented'); return false; } - + function modify($alias, $newuserdata) { $this->set_error('modify not implemented'); return false; @@ -533,8 +546,32 @@ class addressbook_backend { } -/* Sort array by the key "name" */ +/** + * Sort array by the key "name" + */ function alistcmp($a,$b) { + $abook_sort_order=get_abook_sort(); + + switch ($abook_sort_order) { + case 0: + case 1: + $abook_sort='nickname'; + break; + case 4: + case 5: + $abook_sort='email'; + break; + case 6: + case 7: + $abook_sort='label'; + break; + case 2: + case 3: + case 8: + default: + $abook_sort='name'; + } + if ($a['backend'] > $b['backend']) { return 1; } else { @@ -542,7 +579,95 @@ function alistcmp($a,$b) { return -1; } } - return (strtolower($a['name']) > strtolower($b['name'])) ? 1 : -1; + + if( (($abook_sort_order+2) % 2) == 1) { + return (strtolower($a[$abook_sort]) < strtolower($b[$abook_sort])) ? 1 : -1; + } else { + return (strtolower($a[$abook_sort]) > strtolower($b[$abook_sort])) ? 1 : -1; + } } -?> +/** + * Address book sorting options + * + * returns address book sorting order + * @return integer book sorting options order + */ +function get_abook_sort() { + global $data_dir, $username; + + /* get sorting order */ + if(sqgetGlobalVar('abook_sort_order', $temp, SQ_GET)) { + $abook_sort_order = (int) $temp; + + if ($abook_sort_order < 0 or $abook_sort_order > 8) + $abook_sort_order=8; + + setPref($data_dir, $username, 'abook_sort_order', $abook_sort_order); + } else { + /* get previous sorting options. default to unsorted */ + $abook_sort_order = getPref($data_dir, $username, 'abook_sort_order', 8); + } + + return $abook_sort_order; +} + +/** + * This function shows the address book sort button. + * + * @param integer $abook_sort_order current sort value + * @param string $alt_tag alt tag value (string visible to text only browsers) + * @param integer $Down sort value when list is sorted ascending + * @param integer $Up sort value when list is sorted descending + * @return string html code with sorting images and urls + */ +function show_abook_sort_button($abook_sort_order, $alt_tag, $Down, $Up ) { + global $form_url; + + /* Figure out which image we want to use. */ + if ($abook_sort_order != $Up && $abook_sort_order != $Down) { + $img = 'sort_none.png'; + $which = $Up; + } elseif ($abook_sort_order == $Up) { + $img = 'up_pointer.png'; + $which = $Down; + } else { + $img = 'down_pointer.png'; + $which = 8; + } + + /* Now that we have everything figured out, show the actual button. */ + return ' ' . $alt_tag . ''; +} + +/* + 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