3 * functions/addressbook.php - Functions and classes for the addressbook system
5 * Functions require SM_PATH and support of forms.php functions
7 * @copyright © 1999-2007 The SquirrelMail Project Team
8 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
10 * @package squirrelmail
11 * @subpackage addressbook
15 * Create and initialize an addressbook object.
16 * @param boolean $showerr display any address book init errors. html page header
17 * must be created before calling addressbook_init() with $showerr enabled.
18 * @param boolean $onlylocal enable only local address book backends. Should
19 * be used when code does not need access to remote backends. Backends
20 * that provide read only address books with limited listing options can be
22 * @return object address book object.
24 function addressbook_init($showerr = true, $onlylocal = false) {
25 global $data_dir, $username, $ldap_server, $address_book_global_filename;
26 global $addrbook_dsn, $addrbook_table;
27 global $abook_global_file, $abook_global_file_writeable, $abook_global_file_listing;
28 global $addrbook_global_dsn, $addrbook_global_table, $addrbook_global_writeable, $addrbook_global_listing;
29 global $abook_file_line_length;
31 /* Create a new addressbook object */
32 $abook = new AddressBook
;
34 /* Create empty error message */
38 Always add a local backend. We use *either* file-based *or* a
39 database addressbook. If $addrbook_dsn is set, the database
40 backend is used. If not, addressbooks are stores in files.
42 if (isset($addrbook_dsn) && !empty($addrbook_dsn)) {
44 if (!isset($addrbook_table) ||
empty($addrbook_table)) {
45 $addrbook_table = 'address';
47 $r = $abook->add_backend('database', Array('dsn' => $addrbook_dsn,
49 'table' => $addrbook_table));
50 if (!$r && $showerr) {
51 $abook_init_error.=_("Error initializing address book database.") . "\n" . $abook->error
;
55 $filename = getHashedFile($username, $data_dir, "$username.abook");
56 $r = $abook->add_backend('local_file', Array('filename' => $filename,
57 'line_length' => $abook_file_line_length,
60 // no need to use $abook->error, because message explains error.
61 $abook_init_error.=sprintf( _("Error opening file %s"), $filename );
65 /* Global file based addressbook */
66 if (isset($abook_global_file) &&
67 isset($abook_global_file_writeable) &&
68 isset($abook_global_file_listing) &&
69 trim($abook_global_file)!=''){
71 // Detect place of address book
72 if (! preg_match("/[\/\\\]/",$abook_global_file)) {
73 /* no path chars, address book stored in data directory
74 * make sure that there is a slash between data directory
75 * and address book file name
77 $abook_global_filename=$data_dir
78 . ((substr($data_dir, -1) != '/') ?
'/' : '')
80 } elseif (preg_match("/^\/|\w:/",$abook_global_file)) {
81 // full path is set in options (starts with slash or x:)
82 $abook_global_filename=$abook_global_file;
84 $abook_global_filename=SM_PATH
. $abook_global_file;
87 $r = $abook->add_backend('local_file',array('filename'=>$abook_global_filename,
88 'name' => _("Global Address Book"),
89 'detect_writeable' => false,
90 'line_length' => $abook_file_line_length,
91 'writeable'=> $abook_global_file_writeable,
92 'listing' => $abook_global_file_listing));
94 /* global abook init error is not fatal. add error message and continue */
95 if (!$r && $showerr) {
96 if ($abook_init_error!='') $abook_init_error.="\n";
97 $abook_init_error.=_("Error initializing global address book.") . "\n" . $abook->error
;
101 /* Load global addressbook from SQL if configured */
102 if (isset($addrbook_global_dsn) && !empty($addrbook_global_dsn)) {
103 /* Database configured */
104 if (!isset($addrbook_global_table) ||
empty($addrbook_global_table)) {
105 $addrbook_global_table = 'global_abook';
107 $r = $abook->add_backend('database',
108 Array('dsn' => $addrbook_global_dsn,
110 'name' => _("Global Address Book"),
111 'writeable' => $addrbook_global_writeable,
112 'listing' => $addrbook_global_listing,
113 'table' => $addrbook_global_table));
114 /* global abook init error is not fatal. add error message and continue */
115 if (!$r && $showerr) {
116 if ($abook_init_error!='') $abook_init_error.="\n";
117 $abook_init_error.=_("Error initializing global address book.") . "\n" . $abook->error
;
122 * hook allows to include different address book backends.
123 * plugins should extract $abook and $r from arguments
124 * and use same add_backend commands as above functions.
125 * Since 1.5.2 hook sends third ($onlylocal) argument to address book
126 * plugins in order to allow detection of local address book init.
127 * @since 1.5.1 and 1.4.5
128 * Since 1.5.2, the plugin arguments are passed inside an array
129 * and by reference, so plugins hooking in here need to accept arguments
130 * in an array and change those values as needed instead of returning
131 * the changed values.
133 $temp = array(&$abook, &$r, &$onlylocal);
134 do_hook('abook_init', $temp);
135 if (!$r && $showerr) {
136 if ($abook_init_error!='') $abook_init_error.="\n";
137 $abook_init_error.=_("Error initializing other address books.") . "\n" . $abook->error
;
140 /* Load configured LDAP servers (if PHP has LDAP support) */
141 if (isset($ldap_server) && is_array($ldap_server)) {
143 while (list($undef,$param) = each($ldap_server)) {
144 if (!is_array($param))
147 /* if onlylocal is true, we only add writeable ldap servers */
148 if ($onlylocal && (!isset($param['writeable']) ||
$param['writeable'] != true))
151 $r = $abook->add_backend('ldap_server', $param);
152 if (!$r && $showerr) {
153 if ($abook_init_error!='') $abook_init_error.="\n";
154 $abook_init_error.=sprintf(_("Error initializing LDAP server %s:"), $param['host'])."\n";
155 $abook_init_error.= $abook->error
;
158 } // end of ldap server init
161 * display address book init errors.
163 if ($abook_init_error!='' && $showerr) {
164 error_box(nl2br(htmlspecialchars($abook_init_error)));
167 /* Return the initialized object */
172 * Constructs the "new address" form
174 * NOTE! The form is not closed - the caller
175 * must add the closing form tag itself.
179 * @param string $form_url Form action url
180 * @param string $name Form name
181 * @param string $title Form title
182 * @param string $button Form button name
183 * @param int $backend The current backend being displayed
184 * @param array $defdata Values of form fields
186 * @return string The desired address form display code
189 function abook_create_form($form_url, $name, $title, $button,
190 $backend, $defdata=array()) {
194 $output = addForm($form_url, 'post', 'f_add');
196 if ($button == _("Update address")) {
201 $backends = getWritableBackends();
205 'nickname' => 'NickName',
206 'firstname' => 'FirstName',
207 'lastname' => 'LastName',
212 foreach ($fields as $sqm=>$template) {
213 $values[$template] = isset($defdata[$sqm]) ?
$defdata[$sqm] : '';
216 $oTemplate->assign('writable_backends', $backends);
217 $oTemplate->assign('values', $values);
218 $oTemplate->assign('edit', $edit);
219 $oTemplate->assign('current_backend', $backend);
221 $output .= $oTemplate->fetch('addrbook_addedit.tpl');
228 * Had to move this function outside of the Addressbook Class
229 * PHP 4.0.4 Seemed to be having problems with inline functions.
230 * Note: this can return now since we don't support 4.0.4 anymore.
232 function addressbook_cmp($a,$b) {
234 if($a['backend'] > $b['backend']) {
236 } else if($a['backend'] < $b['backend']) {
240 return (strtolower($a['name']) > strtolower($b['name'])) ?
1 : -1;
245 * Retrieve a list of writable backends
248 function getWritableBackends () {
252 $backends = $abook->get_backend_list();
253 while (list($undef,$v) = each($backends)) {
255 $write[$v->bnum
]=$v->sname
;
263 * Sort array by the key "name"
265 function alistcmp($a,$b) {
266 $abook_sort_order=get_abook_sort();
268 switch ($abook_sort_order) {
271 $abook_sort='nickname';
288 if ($a['backend'] > $b['backend']) {
291 if ($a['backend'] < $b['backend']) {
296 if( (($abook_sort_order+
2) %
2) == 1) {
297 return (strtolower($a[$abook_sort]) < strtolower($b[$abook_sort])) ?
1 : -1;
299 return (strtolower($a[$abook_sort]) > strtolower($b[$abook_sort])) ?
1 : -1;
304 * Address book sorting options
306 * returns address book sorting order
307 * @return integer book sorting options order
309 function get_abook_sort() {
310 global $data_dir, $username;
312 /* get sorting order */
313 if(sqgetGlobalVar('abook_sort_order', $temp, SQ_GET
)) {
314 $abook_sort_order = (int) $temp;
316 if ($abook_sort_order < 0 or $abook_sort_order > 8)
319 setPref($data_dir, $username, 'abook_sort_order', $abook_sort_order);
321 /* get previous sorting options. default to unsorted */
322 $abook_sort_order = getPref($data_dir, $username, 'abook_sort_order', 8);
325 return $abook_sort_order;
329 * This function shows the address book sort button.
331 * @param integer $abook_sort_order Current sort value
332 * @param string $alt_tag The alt tag value (string
333 * visible to text only browsers)
334 * @param integer $Down Sort value when list is sorted
336 * @param integer $Up Sort value when list is sorted
338 * @param array $uri_extra Any additional parameters to add
339 * to the button's link, as an
340 * associative array of key/value pairs
341 * (OPTIONAL; default none)
343 * @return string html code with sorting images and urls
346 function show_abook_sort_button($abook_sort_order, $alt_tag,
347 $Down, $Up, $uri_extra=array() ) {
349 global $form_url, $icon_theme_path;
351 /* Figure out which image we want to use. */
352 if ($abook_sort_order != $Up && $abook_sort_order != $Down) {
353 $img = 'sort_none.png';
354 $text_icon = '◻'; // U+25FB WHITE MEDIUM SQUARE
356 } elseif ($abook_sort_order == $Up) {
357 $img = 'up_pointer.png';
358 $text_icon = '⇧'; // U+21E7 UPWARDS WHITE ARROW
361 $img = 'down_pointer.png';
362 $text_icon = '⇩'; // U+21E9 DOWNWARDS WHITE ARROW
366 $uri_extra['abook_sort_order'] = $which;
367 $uri = set_uri_vars($form_url, $uri_extra, FALSE);
369 /* Now that we have everything figured out, show the actual button. */
370 return create_hyperlink($uri,
371 getIcon($icon_theme_path, $img, $text_icon, $alt_tag),
373 array('style' => 'text-decoration:none',
374 'title' => $alt_tag),
380 * This is the main address book class that connect all the
381 * backends and provide services to the functions above.
382 * @package squirrelmail
383 * @subpackage addressbook
387 * Enabled address book backends
390 var $backends = array();
392 * Number of enabled backends
395 var $numbackends = 0;
402 * id of backend with personal address book
405 var $localbackend = 0;
407 * Name of backend with personal address book
410 var $localbackendname = '';
412 * Controls use of 'extra' field
414 * Extra field can be used to add link to form, which allows
415 * to modify all fields supported by backend. This is the only field
416 * that is not sanitized with htmlspecialchars. Backends MUST make
417 * sure that field data is sanitized and displayed correctly inside
418 * table cell. Use of html formating in other address book fields is
419 * not allowed. Backends that don't return 'extra' row in address book
420 * data should not modify this object property.
424 var $add_extra_field = false;
427 * Constructor function.
429 function AddressBook() {
430 $this->localbackendname
= _("Personal Address Book");
434 * Return an array of backends of a given type,
435 * or all backends if no type is specified.
436 * @param string $type backend type
437 * @return array list of backends
439 function get_backend_list($type = '') {
441 for ($i = 1 ; $i <= $this->numbackends
; $i++
) {
442 if (empty($type) ||
$type == $this->backends
[$i]->btype
) {
443 $ret[] = &$this->backends
[$i];
450 /* ========================== Public ======================== */
455 * @param string $backend backend name (without the abook_ prefix)
456 * @param mixed optional variable that is passed to the backend constructor.
457 * See each of the backend classes for valid parameters
458 * @return integer number of backends
460 function add_backend($backend, $param = '') {
461 static $backend_classes;
462 if (!isset($backend_classes)) {
463 $backend_classes = array();
465 if (!isset($backend_classes[$backend])) {
467 * Support backend provided by plugins. Plugin function must
468 * return an associative array with as key the backend name ($backend)
469 * and as value the file including the path containing the backend class.
470 * i.e.: $aBackend = array('backend_template' => SM_PATH . 'plugins/abook_backend_template/functions.php')
472 * NB: Because the backend files are included from within this function they DO NOT have access to
473 * vars in the global scope. This function is the global scope for the included backend !!!
476 $aBackend = do_hook('abook_add_class', $null);
477 if (isset($aBackend) && is_array($aBackend) && isset($aBackend[$backend])) {
478 require_once($aBackend[$backend]);
480 require_once(SM_PATH
. 'functions/abook_'.$backend.'.php');
482 $backend_classes[$backend] = true;
484 $backend_name = 'abook_' . $backend;
485 $newback = new $backend_name($param);
486 //eval('$newback = new ' . $backend_name . '($param);');
487 if(!empty($newback->error
)) {
488 $this->error
= $newback->error
;
492 $this->numbackends++
;
494 $newback->bnum
= $this->numbackends
;
495 $this->backends
[$this->numbackends
] = $newback;
497 /* Store ID of first local backend added */
498 if ($this->localbackend
== 0 && $newback->btype
== 'local') {
499 $this->localbackend
= $this->numbackends
;
500 $this->localbackendname
= $newback->sname
;
503 return $this->numbackends
;
508 * create string with name and email address
510 * This function takes a $row array as returned by the addressbook
511 * search and returns an e-mail address with the full name or
512 * nickname optionally prepended.
513 * @param array $row address book entry
514 * @return string email address with real name prepended
516 function full_address($row) {
517 global $data_dir, $username;
518 $addrsrch_fullname = getPref($data_dir, $username, 'addrsrch_fullname');
519 if ($addrsrch_fullname == 'fullname')
520 return $row['name'] . ' <' . trim($row['email']) . '>';
521 else if ($addrsrch_fullname == 'nickname')
522 return $row['nickname'] . ' <' . trim($row['email']) . '>';
524 return trim($row['email']);
528 * Search for entries in address books
530 * Return a list of addresses matching expression in
531 * all backends of a given type.
532 * @param string $expression search expression
533 * @param integer $bnum backend number. default to search in all backends
534 * @return array search results
536 function search($expression, $bnum = -1) {
540 /* Search all backends */
542 $sel = $this->get_backend_list('');
544 for ($i = 0 ; $i < sizeof($sel) ; $i++
) {
545 $backend = &$sel[$i];
546 $backend->error
= '';
547 $res = $backend->search($expression);
548 if (is_array($res)) {
549 $ret = array_merge($ret, $res);
551 $this->error
.= "\n" . $backend->error
;
556 /* Only fail if all backends failed */
557 if( $failed >= sizeof( $sel ) ) {
561 } elseif (! isset($this->backends
[$bnum])) {
562 /* make sure that backend exists */
563 $this->error
= _("Unknown address book backend");
567 /* Search only one backend */
569 $ret = $this->backends
[$bnum]->search($expression);
570 if (!is_array($ret)) {
571 $this->error
.= "\n" . $this->backends
[$bnum]->error
;
582 * @param string $expression search expression
583 * @param integer $bnum backend number. default to search in all backends
584 * @return array search results
586 function s_search($expression, $bnum = -1) {
588 $ret = $this->search($expression, $bnum);
589 if ( is_array( $ret ) ) {
590 usort($ret, 'addressbook_cmp');
597 * Lookup an address by the indicated field.
599 * Only possible in local backends.
601 * @param string $value The value to look up
602 * @param integer $bnum The number of the backend to
603 * look within (OPTIONAL; defaults
604 * to look in all local backends)
605 * @param integer $field The field to look in, should be one
606 * of the SM_ABOOK_FIELD_* constants
607 * defined in include/constants.php
608 * (OPTIONAL; defaults to nickname field)
609 * NOTE: uniqueness is only guaranteed
610 * when the nickname field is used here;
611 * otherwise, the first matching address
614 * @return mixed Array with lookup results when the value
615 * was found, an empty array if the value was
616 * not found, or false if an error occured.
619 function lookup($value, $bnum = -1, $field = SM_ABOOK_FIELD_NICKNAME
) {
624 if (!isset($this->backends
[$bnum])) {
625 $this->error
= _("Unknown address book backend");
628 $res = $this->backends
[$bnum]->lookup($value, $field);
629 if (is_array($res)) {
632 $this->error
= $this->backends
[$bnum]->error
;
637 $sel = $this->get_backend_list('local');
638 for ($i = 0 ; $i < sizeof($sel) ; $i++
) {
639 $backend = &$sel[$i];
640 $backend->error
= '';
641 $res = $backend->lookup($value, $field);
643 // return an address if one is found
644 // (empty array means lookup concluded
645 // but no result found - in this case,
646 // proceed to next backend)
648 if (is_array($res)) {
649 if (!empty($res)) return $res;
651 $this->error
= $backend->error
;
661 * Return all addresses
662 * @param integer $bnum backend number
663 * @return mixed array with search results or boolean false on error.
665 function list_addr($bnum = -1) {
669 $sel = $this->get_backend_list('');
670 } elseif (! isset($this->backends
[$bnum])) {
671 /* make sure that backend exists */
672 $this->error
= _("Unknown address book backend");
675 $sel = array(0 => &$this->backends
[$bnum]);
678 for ($i = 0 ; $i < sizeof($sel) ; $i++
) {
679 $backend = &$sel[$i];
680 $backend->error
= '';
681 $res = $backend->list_addr();
682 if (is_array($res)) {
683 $ret = array_merge($ret, $res);
685 $this->error
= $backend->error
;
694 * Create a new address
695 * @param array $userdata added address record
696 * @param integer $bnum backend number
697 * @return integer the backend number that the/ address was added
698 * to, or false if it failed.
700 function add($userdata, $bnum) {
703 if (!is_array($userdata)) {
704 $this->error
= _("Invalid input data");
707 if (empty($userdata['firstname']) && empty($userdata['lastname'])) {
708 $this->error
= _("Name is missing");
711 if (empty($userdata['email'])) {
712 $this->error
= _("E-mail address is missing");
715 if (empty($userdata['nickname'])) {
716 $userdata['nickname'] = $userdata['email'];
719 /* Blocks use of space, :, |, #, " and ! in nickname */
720 if (eregi('[ \\:\\|\\#\\"\\!]', $userdata['nickname'])) {
721 $this->error
= _("Nickname contains illegal characters");
725 /* make sure that backend exists */
726 if (! isset($this->backends
[$bnum])) {
727 $this->error
= _("Unknown address book backend");
731 /* Check that specified backend accept new entries */
732 if (!$this->backends
[$bnum]->writeable
) {
733 $this->error
= _("Address book is read-only");
737 /* Add address to backend */
738 $res = $this->backends
[$bnum]->add($userdata);
742 $this->error
= $this->backends
[$bnum]->error
;
746 return false; // Not reached
751 * Remove the entries from address book
752 * @param mixed $alias entries that have to be removed. Can be string with nickname or array with list of nicknames
753 * @param integer $bnum backend number
754 * @return bool true if removed successfully. false if there s an error. $this->error contains error message
756 function remove($alias, $bnum) {
763 /* Convert string to single element array */
764 if (!is_array($alias)) {
765 $alias = array(0 => $alias);
768 /* make sure that backend exists */
769 if (! isset($this->backends
[$bnum])) {
770 $this->error
= _("Unknown address book backend");
774 /* Check that specified backend is writable */
775 if (!$this->backends
[$bnum]->writeable
) {
776 $this->error
= _("Address book is read-only");
780 /* Remove user from backend */
781 $res = $this->backends
[$bnum]->remove($alias);
785 $this->error
= $this->backends
[$bnum]->error
;
789 return FALSE; /* Not reached */
790 } /* end of remove() */
794 * Modify entry in address book
795 * @param string $alias nickname
796 * @param array $userdata newdata
797 * @param integer $bnum backend number
799 function modify($alias, $userdata, $bnum) {
802 if (empty($alias) ||
!is_string($alias)) {
807 if(!is_array($userdata)) {
808 $this->error
= _("Invalid input data");
811 if (empty($userdata['firstname']) && empty($userdata['lastname'])) {
812 $this->error
= _("Name is missing");
815 if (empty($userdata['email'])) {
816 $this->error
= _("E-mail address is missing");
820 if (eregi('[\\: \\|\\#"\\!]', $userdata['nickname'])) {
821 $this->error
= _("Nickname contains illegal characters");
825 if (empty($userdata['nickname'])) {
826 $userdata['nickname'] = $userdata['email'];
829 /* make sure that backend exists */
830 if (! isset($this->backends
[$bnum])) {
831 $this->error
= _("Unknown address book backend");
835 /* Check that specified backend is writable */
836 if (!$this->backends
[$bnum]->writeable
) {
837 $this->error
= _("Address book is read-only");;
841 /* Modify user in backend */
842 $res = $this->backends
[$bnum]->modify($alias, $userdata);
846 $this->error
= $this->backends
[$bnum]->error
;
850 return FALSE; /* Not reached */
851 } /* end of modify() */
854 } /* End of class Addressbook */
857 * Generic backend that all other backends extend
858 * @package squirrelmail
859 * @subpackage addressbook
861 class addressbook_backend
{
863 /* Variables that all backends must provide. */
867 * Can be 'local' or 'remote'
868 * @var string backend type
870 var $btype = 'dummy';
872 * Internal backend name
875 var $bname = 'dummy';
877 * Displayed backend name
880 var $sname = 'Dummy backend';
883 * Variables common for all backends, but that
884 * should not be changed by the backends.
900 var $writeable = false;
904 * @param string $string error message
907 function set_error($string) {
908 $this->error
= '[' . $this->sname
. '] ' . $string;
913 /* ========================== Public ======================== */
916 * Search for entries in backend
918 * Working backend should support use of wildcards. * symbol
919 * should match one or more symbols. ? symbol should match any
921 * @param string $expression
924 function search($expression) {
925 $this->set_error('search is not implemented');
930 * Find entry in backend by the indicated field
932 * @param string $value The value to look up
933 * @param integer $field The field to look in, should be one
934 * of the SM_ABOOK_FIELD_* constants
935 * defined in include/constants.php
936 * NOTE: uniqueness is only guaranteed
937 * when the nickname field is used here;
938 * otherwise, the first matching address
941 * @return mixed Array with lookup results when the value
942 * was found, an empty array if the value was
943 * not found, or false if an error occured.
946 function lookup($value, $field) {
947 $this->set_error('lookup is not implemented');
952 * List all entries in backend
954 * Working backend should provide this function or at least
955 * dummy function that returns empty array.
958 function list_addr() {
959 $this->set_error('list_addr is not implemented');
964 * Add entry to backend
965 * @param array userdata
968 function add($userdata) {
969 $this->set_error('add is not implemented');
974 * Remove entry from backend
975 * @param string $alias name used for id
978 function remove($alias) {
979 $this->set_error('delete is not implemented');
984 * Modify entry in backend
985 * @param string $alias name used for id
986 * @param array $newuserdata new data
989 function modify($alias, $newuserdata) {
990 $this->set_error('modify is not implemented');
995 * Creates full name from given name and surname
997 * Handles name order differences. Function always runs in SquirrelMail gettext domain.
998 * Plugins don't have to switch domains before calling this function.
999 * @param string $firstname given name
1000 * @param string $lastname surname
1001 * @return string full name
1004 function fullname($firstname,$lastname) {
1005 // i18n: allows to control fullname layout in address book listing
1006 // first %s is for first name, second %s is for last name.
1007 // Translate it to '%2$s %1$s', if surname must be displayed first in your language.
1008 // Please note that variables can be set to empty string and extra formating
1009 // (for example '%2$s, %1$s' as in 'Smith, John') might break. Use it only for
1010 // setting name and surname order. scripts will remove all prepended and appended
1012 return trim(sprintf(dgettext('squirrelmail',"%s %s"),$firstname,$lastname));