4 * functions/addressbook.php - Functions and classes for the addressbook system
6 * Copyright (c) 1999-2005 The SquirrelMail Project Team
7 * Licensed under the GNU GPL. For full terms see the file COPYING.
9 * Functions require SM_PATH and support of forms.php functions
12 * @package squirrelmail
13 * @subpackage addressbook
17 * If SM_PATH isn't defined, define it. Required to include files.
20 if (!defined('SM_PATH')) {
21 define('SM_PATH','../');
24 /* make sure that display_messages.php is loaded */
25 include_once(SM_PATH
. 'functions/display_messages.php');
27 global $addrbook_dsn, $addrbook_global_dsn;
30 * Create and initialize an addressbook object.
31 * @param boolean $showerr display any address book init errors. html page header
32 * must be created before calling addressbook_init() with $showerr enabled.
33 * @param boolean $onlylocal enable only local address book backends
34 * @return object address book object.
36 function addressbook_init($showerr = true, $onlylocal = false) {
37 global $data_dir, $username, $color, $ldap_server, $address_book_global_filename;
38 global $addrbook_dsn, $addrbook_table;
39 global $abook_global_file, $abook_global_file_writeable, $abook_global_file_listing;
40 global $addrbook_global_dsn, $addrbook_global_table, $addrbook_global_writeable, $addrbook_global_listing;
42 /* Create a new addressbook object */
43 $abook = new AddressBook
;
45 /* Create empty error message */
49 Always add a local backend. We use *either* file-based *or* a
50 database addressbook. If $addrbook_dsn is set, the database
51 backend is used. If not, addressbooks are stores in files.
53 if (isset($addrbook_dsn) && !empty($addrbook_dsn)) {
55 if (!isset($addrbook_table) ||
empty($addrbook_table)) {
56 $addrbook_table = 'address';
58 $r = $abook->add_backend('database', Array('dsn' => $addrbook_dsn,
60 'table' => $addrbook_table));
61 if (!$r && $showerr) {
62 $abook_init_error.=_("Error initializing addressbook database.") . "<br />\n" . $abook->error
;
66 $filename = getHashedFile($username, $data_dir, "$username.abook");
67 $r = $abook->add_backend('local_file', Array('filename' => $filename,
70 // no need to use $abook->error, because message explains error.
71 $abook_init_error.=sprintf( _("Error opening file %s"), $filename );
75 /* Global file based addressbook */
76 if (isset($abook_global_file) &&
77 isset($abook_global_file_writeable) &&
78 isset($abook_global_file_listing) &&
79 trim($abook_global_file)!=''){
81 // Detect place of address book
82 if (! preg_match("/[\/\\\]/",$abook_global_file)) {
83 /* no path chars, address book stored in data directory
84 * make sure that there is a slash between data directory
85 * and address book file name
87 $abook_global_filename=$data_dir
88 . ((substr($data_dir, -1) != '/') ?
'/' : '')
90 } elseif (preg_match("/^\/|\w:/",$abook_global_file)) {
91 // full path is set in options (starts with slash or x:)
92 $abook_global_filename=$abook_global_file;
94 $abook_global_filename=SM_PATH
. $abook_global_file;
97 $r = $abook->add_backend('local_file',array('filename'=>$abook_global_filename,
98 'name' => _("Global address book"),
99 'detect_writeable' => false,
100 'writeable'=> $abook_global_file_writeable,
101 'listing' => $abook_global_file_listing));
103 /* global abook init error is not fatal. add error message and continue */
104 if (!$r && $showerr) {
105 if ($abook_init_error!='') $abook_init_error.="<br />\n";
106 $abook_init_error.=_("Error initializing global addressbook.") . "<br />\n" . $abook->error
;
110 /* Load global addressbook from SQL if configured */
111 if (isset($addrbook_global_dsn) && !empty($addrbook_global_dsn)) {
112 /* Database configured */
113 if (!isset($addrbook_global_table) ||
empty($addrbook_global_table)) {
114 $addrbook_global_table = 'global_abook';
116 $r = $abook->add_backend('database',
117 Array('dsn' => $addrbook_global_dsn,
119 'name' => _("Global address book"),
120 'writeable' => $addrbook_global_writeable,
121 'listing' => $addrbook_global_listing,
122 'table' => $addrbook_global_table));
123 /* global abook init error is not fatal. add error message and continue */
124 if (!$r && $showerr) {
125 if ($abook_init_error!='') $abook_init_error.="<br />\n";
126 $abook_init_error.=_("Error initializing global addressbook.") . "<br />\n" . $abook->error
;
131 * hook allows to include different address book backends.
132 * plugins should extract $abook and $r from arguments
133 * and use same add_backend commands as above functions.
134 * @since 1.5.1 and 1.4.5
136 $hookReturn = do_hook('abook_init', $abook, $r);
137 $abook = $hookReturn[1];
141 /* Load configured LDAP servers (if PHP has LDAP support) */
142 if (isset($ldap_server) && is_array($ldap_server)) {
144 while (list($undef,$param) = each($ldap_server)) {
145 if (is_array($param)) {
146 $r = $abook->add_backend('ldap_server', $param);
147 if (!$r && $showerr) {
148 if ($abook_init_error!='') $abook_init_error.="<br />\n";
149 $abook_init_error.=sprintf(_("Error initializing LDAP server %s:") .
150 "<br />\n", $param['host']);
151 $abook_init_error.= $abook->error
;
155 } // end of ldap server init
156 } // end of remote abook backend init
159 * display address book init errors.
161 if ($abook_init_error!='' && $showerr) {
162 error_box($abook_init_error,$color);
165 /* Return the initialized object */
170 * Display the "new address" form
172 * Form is not closed and you must add closing form tag.
174 * @param string $form_url form action url
175 * @param string $name form name
176 * @param string $title form title
177 * @param string $button form button name
178 * @param array $defdata values of form fields
180 function abook_create_form($form_url,$name,$title,$button,$defdata=array()) {
182 echo addForm($form_url, 'post', 'f_add').
185 html_tag( 'td', "\n". '<strong>' . $title . '</strong>' . "\n",
189 , 'center', '', 'width="90%"' ) ."\n";
190 address_form($name, $button, $defdata);
195 * Had to move this function outside of the Addressbook Class
196 * PHP 4.0.4 Seemed to be having problems with inline functions.
197 * Note: this can return now since we don't support 4.0.4 anymore.
199 function addressbook_cmp($a,$b) {
201 if($a['backend'] > $b['backend']) {
203 } else if($a['backend'] < $b['backend']) {
207 return (strtolower($a['name']) > strtolower($b['name'])) ?
1 : -1;
212 * Make an input field
213 * @param string $label
214 * @param string $field
215 * @param string $name
216 * @param string $size
217 * @param array $values
220 function addressbook_inp_field($label, $field, $name, $size, $values, $add='') {
222 $value = ( isset($values[$field]) ?
$values[$field] : '');
224 if (is_array($value)) {
225 $td_str = addSelect($name.'['.$field.']', $value);
227 $td_str = addInput($name.'['.$field.']', $value, $size);
231 return html_tag( 'tr' ,
232 html_tag( 'td', $label . ':', 'right', $color[4]) .
233 html_tag( 'td', $td_str, 'left', $color[4])
239 * Output form to add and modify address data
241 function address_form($name, $submittext, $values = array()) {
242 global $color, $squirrelmail_language;
244 if ($squirrelmail_language == 'ja_JP') {
245 echo html_tag( 'table',
246 addressbook_inp_field(_("Nickname"), 'nickname', $name, 15, $values,
247 ' <small>' . _("Must be unique") . '</small>') .
248 addressbook_inp_field(_("E-mail address"), 'email', $name, 45, $values, '') .
249 addressbook_inp_field(_("Last name"), 'lastname', $name, 45, $values, '') .
250 addressbook_inp_field(_("First name"), 'firstname', $name, 45, $values, '') .
251 addressbook_inp_field(_("Additional info"), 'label', $name, 45, $values, '') .
252 list_writable_backends($name) .
255 addSubmit($submittext, $name.'[SUBMIT]'),
256 'center', $color[4], 'colspan="2"')
258 , 'center', '', 'border="0" cellpadding="1" width="90%"') ."\n";
260 echo html_tag( 'table',
261 addressbook_inp_field(_("Nickname"), 'nickname', $name, 15, $values,
262 ' <small>' . _("Must be unique") . '</small>') .
263 addressbook_inp_field(_("E-mail address"), 'email', $name, 45, $values, '') .
264 addressbook_inp_field(_("First name"), 'firstname', $name, 45, $values, '') .
265 addressbook_inp_field(_("Last name"), 'lastname', $name, 45, $values, '') .
266 addressbook_inp_field(_("Additional info"), 'label', $name, 45, $values, '') .
267 list_writable_backends($name) .
270 addSubmit($submittext, $name.'[SUBMIT]') ,
271 'center', $color[4], 'colspan="2"')
273 , 'center', '', 'border="0" cellpadding="1" width="90%"') ."\n";
278 * Provides list of writeable backends.
279 * Works only when address is added ($name='addaddr')
280 * @param string $name name of form
281 * @return string html formated backend field (select or hidden)
283 function list_writable_backends($name) {
284 global $color, $abook;
285 if ( $name != 'addaddr' ) { return; }
286 $writeable_abook = 1;
287 if ( $abook->numbackends
> 1 ) {
288 $backends = $abook->get_backend_list();
289 $writeable_abooks=array();
290 while (list($undef,$v) = each($backends)) {
292 // add each backend to array
293 $writeable_abooks[$v->bnum
]=$v->sname
;
294 // save backend number
295 $writeable_abook=$v->bnum
;
298 if (count($writeable_abooks)>1) {
299 // we have more than one writeable backend
300 $ret=addSelect('backend',$writeable_abooks,null,true);
301 return html_tag( 'tr',
302 html_tag( 'td', _("Add to:"),'right', $color[4] ) .
303 html_tag( 'td', $ret, 'left', $color[4] )) . "\n";
306 // Only one backend exists or is writeable.
307 return html_tag( 'tr',
309 addHidden('backend', $writeable_abook),
310 'center', $color[4], 'colspan="2"')) . "\n";
314 * Sort array by the key "name"
316 function alistcmp($a,$b) {
317 $abook_sort_order=get_abook_sort();
319 switch ($abook_sort_order) {
322 $abook_sort='nickname';
339 if ($a['backend'] > $b['backend']) {
342 if ($a['backend'] < $b['backend']) {
347 if( (($abook_sort_order+
2) %
2) == 1) {
348 return (strtolower($a[$abook_sort]) < strtolower($b[$abook_sort])) ?
1 : -1;
350 return (strtolower($a[$abook_sort]) > strtolower($b[$abook_sort])) ?
1 : -1;
355 * Address book sorting options
357 * returns address book sorting order
358 * @return integer book sorting options order
360 function get_abook_sort() {
361 global $data_dir, $username;
363 /* get sorting order */
364 if(sqgetGlobalVar('abook_sort_order', $temp, SQ_GET
)) {
365 $abook_sort_order = (int) $temp;
367 if ($abook_sort_order < 0 or $abook_sort_order > 8)
370 setPref($data_dir, $username, 'abook_sort_order', $abook_sort_order);
372 /* get previous sorting options. default to unsorted */
373 $abook_sort_order = getPref($data_dir, $username, 'abook_sort_order', 8);
376 return $abook_sort_order;
380 * This function shows the address book sort button.
382 * @param integer $abook_sort_order current sort value
383 * @param string $alt_tag alt tag value (string visible to text only browsers)
384 * @param integer $Down sort value when list is sorted ascending
385 * @param integer $Up sort value when list is sorted descending
386 * @return string html code with sorting images and urls
388 function show_abook_sort_button($abook_sort_order, $alt_tag, $Down, $Up ) {
391 /* Figure out which image we want to use. */
392 if ($abook_sort_order != $Up && $abook_sort_order != $Down) {
393 $img = 'sort_none.png';
395 } elseif ($abook_sort_order == $Up) {
396 $img = 'up_pointer.png';
399 $img = 'down_pointer.png';
403 /* Now that we have everything figured out, show the actual button. */
404 return ' <a href="' . $form_url .'?abook_sort_order=' . $which
405 . '"><img src="../images/' . $img
406 . '" border="0" width="12" height="10" alt="' . $alt_tag . '" title="'
407 . _("Click here to change the sorting of the address list") .'" /></a>';
412 * This is the main address book class that connect all the
413 * backends and provide services to the functions above.
414 * @package squirrelmail
415 * @subpackage addressbook
419 * Enabled address book backends
422 var $backends = array();
424 * Number of enabled backends
427 var $numbackends = 0;
434 * id of backend with personal address book
437 var $localbackend = 0;
439 * Name of backend with personal address book
442 var $localbackendname = '';
445 * Constructor function.
447 function AddressBook() {
448 $this->localbackendname
= _("Personal address book");
452 * Return an array of backends of a given type,
453 * or all backends if no type is specified.
454 * @param string $type backend type
455 * @return array list of backends
457 function get_backend_list($type = '') {
459 for ($i = 1 ; $i <= $this->numbackends
; $i++
) {
460 if (empty($type) ||
$type == $this->backends
[$i]->btype
) {
461 $ret[] = &$this->backends
[$i];
468 /* ========================== Public ======================== */
473 * @param string $backend backend name (without the abook_ prefix)
474 * @param mixed optional variable that is passed to the backend constructor.
475 * See each of the backend classes for valid parameters
476 * @return integer number of backends
478 function add_backend($backend, $param = '') {
479 $backend_name = 'abook_' . $backend;
480 eval('$newback = new ' . $backend_name . '($param);');
481 if(!empty($newback->error
)) {
482 $this->error
= $newback->error
;
486 $this->numbackends++
;
488 $newback->bnum
= $this->numbackends
;
489 $this->backends
[$this->numbackends
] = $newback;
491 /* Store ID of first local backend added */
492 if ($this->localbackend
== 0 && $newback->btype
== 'local') {
493 $this->localbackend
= $this->numbackends
;
494 $this->localbackendname
= $newback->sname
;
497 return $this->numbackends
;
502 * create string with name and email address
504 * This function takes a $row array as returned by the addressbook
505 * search and returns an e-mail address with the full name or
506 * nickname optionally prepended.
507 * @param array $row address book entry
508 * @return string email address with real name prepended
510 function full_address($row) {
511 global $addrsrch_fullname, $data_dir, $username;
512 $prefix = getPref($data_dir, $username, 'addrsrch_fullname');
513 if (($prefix != "" ||
(isset($addrsrch_fullname) &&
514 $prefix == $addrsrch_fullname)) && $prefix != 'noprefix') {
515 $name = ($prefix == 'nickname' ?
$row['nickname'] : $row['name']);
516 return $name . ' <' . trim($row['email']) . '>';
518 return trim($row['email']);
523 * Search for entries in address books
525 * Return a list of addresses matching expression in
526 * all backends of a given type.
527 * @param string $expression search expression
528 * @param integer $bnum backend number. default to search in all backends
529 * @return array search results
531 function search($expression, $bnum = -1) {
535 /* Search all backends */
537 $sel = $this->get_backend_list('');
539 for ($i = 0 ; $i < sizeof($sel) ; $i++
) {
540 $backend = &$sel[$i];
541 $backend->error
= '';
542 $res = $backend->search($expression);
543 if (is_array($res)) {
544 $ret = array_merge($ret, $res);
546 $this->error
.= "<br />\n" . $backend->error
;
551 /* Only fail if all backends failed */
552 if( $failed >= sizeof( $sel ) ) {
558 /* Search only one backend */
560 $ret = $this->backends
[$bnum]->search($expression);
561 if (!is_array($ret)) {
562 $this->error
.= "<br />\n" . $this->backends
[$bnum]->error
;
573 * @param string $expression search expression
574 * @param integer $bnum backend number. default to search in all backends
575 * @return array search results
577 function s_search($expression, $bnum = -1) {
579 $ret = $this->search($expression, $bnum);
580 if ( is_array( $ret ) ) {
581 usort($ret, 'addressbook_cmp');
588 * Lookup an address by alias.
589 * Only possible in local backends.
590 * @param string $alias
591 * @param integer backend number
592 * @return array lookup results. False, if not found.
594 function lookup($alias, $bnum = -1) {
599 $res = $this->backends
[$bnum]->lookup($alias);
600 if (is_array($res)) {
603 $this->error
= $backend->error
;
608 $sel = $this->get_backend_list('local');
609 for ($i = 0 ; $i < sizeof($sel) ; $i++
) {
610 $backend = &$sel[$i];
611 $backend->error
= '';
612 $res = $backend->lookup($alias);
613 if (is_array($res)) {
617 $this->error
= $backend->error
;
627 * Return all addresses
628 * @param integer $bnum backend number
629 * @return array search results
631 function list_addr($bnum = -1) {
635 $sel = $this->get_backend_list('');
637 $sel = array(0 => &$this->backends
[$bnum]);
640 for ($i = 0 ; $i < sizeof($sel) ; $i++
) {
641 $backend = &$sel[$i];
642 $backend->error
= '';
643 $res = $backend->list_addr();
644 if (is_array($res)) {
645 $ret = array_merge($ret, $res);
647 $this->error
= $backend->error
;
656 * Create a new address
657 * @param array $userdata added address record
658 * @param integer $bnum backend number
659 * @return integer the backend number that the/ address was added
660 * to, or false if it failed.
662 function add($userdata, $bnum) {
665 if (!is_array($userdata)) {
666 $this->error
= _("Invalid input data");
669 if (empty($userdata['firstname']) && empty($userdata['lastname'])) {
670 $this->error
= _("Name is missing");
673 if (empty($userdata['email'])) {
674 $this->error
= _("E-mail address is missing");
677 if (empty($userdata['nickname'])) {
678 $userdata['nickname'] = $userdata['email'];
681 if (eregi('[ \\:\\|\\#\\"\\!]', $userdata['nickname'])) {
682 $this->error
= _("Nickname contains illegal characters");
686 /* Check that specified backend accept new entries */
687 if (!$this->backends
[$bnum]->writeable
) {
688 $this->error
= _("Addressbook is read-only");
692 /* Add address to backend */
693 $res = $this->backends
[$bnum]->add($userdata);
697 $this->error
= $this->backends
[$bnum]->error
;
701 return false; // Not reached
706 * Remove the entries from address book
707 * @param mixed $alias entries that have to be removed. Can be string with nickname or array with list of nicknames
708 * @param integer $bnum backend number
709 * @return bool true if removed successfully. false if there s an error. $this->error contains error message
711 function remove($alias, $bnum) {
718 /* Convert string to single element array */
719 if (!is_array($alias)) {
720 $alias = array(0 => $alias);
723 /* Check that specified backend is writable */
724 if (!$this->backends
[$bnum]->writeable
) {
725 $this->error
= _("Addressbook is read-only");
729 /* Remove user from backend */
730 $res = $this->backends
[$bnum]->remove($alias);
734 $this->error
= $this->backends
[$bnum]->error
;
738 return FALSE; /* Not reached */
739 } /* end of remove() */
743 * Modify entry in address book
744 * @param string $alias nickname
745 * @param array $userdata newdata
746 * @param integer $bnum backend number
748 function modify($alias, $userdata, $bnum) {
751 if (empty($alias) ||
!is_string($alias)) {
756 if(!is_array($userdata)) {
757 $this->error
= _("Invalid input data");
760 if (empty($userdata['firstname']) && empty($userdata['lastname'])) {
761 $this->error
= _("Name is missing");
764 if (empty($userdata['email'])) {
765 $this->error
= _("E-mail address is missing");
769 if (eregi('[\\: \\|\\#"\\!]', $userdata['nickname'])) {
770 $this->error
= _("Nickname contains illegal characters");
774 if (empty($userdata['nickname'])) {
775 $userdata['nickname'] = $userdata['email'];
778 /* Check that specified backend is writable */
779 if (!$this->backends
[$bnum]->writeable
) {
780 $this->error
= _("Addressbook is read-only");;
784 /* Modify user in backend */
785 $res = $this->backends
[$bnum]->modify($alias, $userdata);
789 $this->error
= $this->backends
[$bnum]->error
;
793 return FALSE; /* Not reached */
794 } /* end of modify() */
797 } /* End of class Addressbook */
800 * Generic backend that all other backends extend
801 * @package squirrelmail
802 * @subpackage addressbook
804 class addressbook_backend
{
806 /* Variables that all backends must provide. */
810 * Can be 'local' or 'remote'
811 * @var string backend type
813 var $btype = 'dummy';
815 * Internal backend name
818 var $bname = 'dummy';
820 * Displayed backend name
823 var $sname = 'Dummy backend';
826 * Variables common for all backends, but that
827 * should not be changed by the backends.
843 var $writeable = false;
847 * @param string $string error message
850 function set_error($string) {
851 $this->error
= '[' . $this->sname
. '] ' . $string;
856 /* ========================== Public ======================== */
859 * Search for entries in backend
860 * @param string $expression
863 function search($expression) {
864 $this->set_error('search not implemented');
869 * Find entry in backend by alias
870 * @param string $alias name used for id
873 function lookup($alias) {
874 $this->set_error('lookup not implemented');
879 * List all entries in backend
882 function list_addr() {
883 $this->set_error('list_addr not implemented');
888 * Add entry to backend
889 * @param array userdata
892 function add($userdata) {
893 $this->set_error('add not implemented');
898 * Remove entry from backend
899 * @param string $alias name used for id
902 function remove($alias) {
903 $this->set_error('delete not implemented');
908 * Modify entry in backend
909 * @param string $alias name used for id
910 * @param array $newuserdata new data
913 function modify($alias, $newuserdata) {
914 $this->set_error('modify not implemented');
920 PHP 5 requires that the class be made first, which seems rather
921 logical, and should have been the way it was generated the first time.
924 require_once(SM_PATH
. 'functions/abook_local_file.php');
925 require_once(SM_PATH
. 'functions/abook_ldap_server.php');
927 /* Only load database backend if database is configured */
928 if((isset($addrbook_dsn) && !empty($addrbook_dsn)) ||
929 (isset($addrbook_global_dsn) && !empty($addrbook_global_dsn))) {
930 include_once(SM_PATH
. 'functions/abook_database.php');
934 * hook allows adding different address book classes.
935 * class must follow address book class coding standards.
937 * see addressbook_backend class and functions/abook_*.php files.
938 * @since 1.5.1 and 1.4.5
940 do_hook('abook_add_class');