3 * functions/addressbook.php - Functions and classes for the addressbook system
5 * Copyright (c) 1999-2005 The SquirrelMail Project Team
6 * Licensed under the GNU GPL. For full terms see the file COPYING.
8 * Functions require SM_PATH and support of forms.php functions
11 * @package squirrelmail
12 * @subpackage addressbook
16 * If SM_PATH isn't defined, define it. Required to include files.
19 if (!defined('SM_PATH')) {
20 define('SM_PATH','../');
23 /* make sure that display_messages.php is loaded */
24 include_once(SM_PATH
. 'functions/display_messages.php');
26 global $addrbook_dsn, $addrbook_global_dsn;
29 * Create and initialize an addressbook object.
30 * @param boolean $showerr display any address book init errors. html page header
31 * must be created before calling addressbook_init() with $showerr enabled.
32 * @param boolean $onlylocal enable only local address book backends
33 * @return object address book object.
35 function addressbook_init($showerr = true, $onlylocal = false) {
36 global $data_dir, $username, $color, $ldap_server, $address_book_global_filename;
37 global $addrbook_dsn, $addrbook_table;
38 global $abook_global_file, $abook_global_file_writeable, $abook_global_file_listing;
39 global $addrbook_global_dsn, $addrbook_global_table, $addrbook_global_writeable, $addrbook_global_listing;
41 /* Create a new addressbook object */
42 $abook = new AddressBook
;
44 /* Create empty error message */
48 Always add a local backend. We use *either* file-based *or* a
49 database addressbook. If $addrbook_dsn is set, the database
50 backend is used. If not, addressbooks are stores in files.
52 if (isset($addrbook_dsn) && !empty($addrbook_dsn)) {
54 if (!isset($addrbook_table) ||
empty($addrbook_table)) {
55 $addrbook_table = 'address';
57 $r = $abook->add_backend('database', Array('dsn' => $addrbook_dsn,
59 'table' => $addrbook_table));
60 if (!$r && $showerr) {
61 $abook_init_error.=_("Error initializing addressbook database.") . "<br />\n" . $abook->error
;
65 $filename = getHashedFile($username, $data_dir, "$username.abook");
66 $r = $abook->add_backend('local_file', Array('filename' => $filename,
69 // no need to use $abook->error, because message explains error.
70 $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.
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);
164 /* Return the initialized object */
169 * Display the "new address" form
171 * Form is not closed and you must add closing form tag.
173 * @param string $form_url form action url
174 * @param string $name form name
175 * @param string $title form title
176 * @param string $button form button name
177 * @param array $defdata values of form fields
179 function abook_create_form($form_url,$name,$title,$button,$defdata=array()) {
181 echo addForm($form_url, 'post', 'f_add').
184 html_tag( 'td', "\n". '<strong>' . $title . '</strong>' . "\n",
188 , 'center', '', 'width="90%"' ) ."\n";
189 address_form($name, $button, $defdata);
194 * Had to move this function outside of the Addressbook Class
195 * PHP 4.0.4 Seemed to be having problems with inline functions.
196 * Note: this can return now since we don't support 4.0.4 anymore.
198 function addressbook_cmp($a,$b) {
200 if($a['backend'] > $b['backend']) {
202 } else if($a['backend'] < $b['backend']) {
206 return (strtolower($a['name']) > strtolower($b['name'])) ?
1 : -1;
211 * Make an input field
212 * @param string $label
213 * @param string $field
214 * @param string $name
215 * @param string $size
216 * @param array $values
219 function addressbook_inp_field($label, $field, $name, $size, $values, $add='') {
221 $value = ( isset($values[$field]) ?
$values[$field] : '');
223 if (is_array($value)) {
224 $td_str = addSelect($name.'['.$field.']', $value);
226 $td_str = addInput($name.'['.$field.']', $value, $size);
230 return html_tag( 'tr' ,
231 html_tag( 'td', $label . ':', 'right', $color[4]) .
232 html_tag( 'td', $td_str, 'left', $color[4])
238 * Output form to add and modify address data
240 function address_form($name, $submittext, $values = array()) {
241 global $color, $squirrelmail_language;
243 if ($squirrelmail_language == 'ja_JP') {
244 echo html_tag( 'table',
245 addressbook_inp_field(_("Nickname"), 'nickname', $name, 15, $values,
246 ' <small>' . _("Must be unique") . '</small>') .
247 addressbook_inp_field(_("E-mail address"), 'email', $name, 45, $values, '') .
248 addressbook_inp_field(_("Last name"), 'lastname', $name, 45, $values, '') .
249 addressbook_inp_field(_("First name"), 'firstname', $name, 45, $values, '') .
250 addressbook_inp_field(_("Additional info"), 'label', $name, 45, $values, '') .
251 list_writable_backends($name) .
254 addSubmit($submittext, $name.'[SUBMIT]'),
255 'center', $color[4], 'colspan="2"')
257 , 'center', '', 'border="0" cellpadding="1" width="90%"') ."\n";
259 echo html_tag( 'table',
260 addressbook_inp_field(_("Nickname"), 'nickname', $name, 15, $values,
261 ' <small>' . _("Must be unique") . '</small>') .
262 addressbook_inp_field(_("E-mail address"), 'email', $name, 45, $values, '') .
263 addressbook_inp_field(_("First name"), 'firstname', $name, 45, $values, '') .
264 addressbook_inp_field(_("Last name"), 'lastname', $name, 45, $values, '') .
265 addressbook_inp_field(_("Additional info"), 'label', $name, 45, $values, '') .
266 list_writable_backends($name) .
269 addSubmit($submittext, $name.'[SUBMIT]') ,
270 'center', $color[4], 'colspan="2"')
272 , 'center', '', 'border="0" cellpadding="1" width="90%"') ."\n";
277 * Provides list of writeable backends.
278 * Works only when address is added ($name='addaddr')
279 * @param string $name name of form
280 * @return string html formated backend field (select or hidden)
282 function list_writable_backends($name) {
283 global $color, $abook;
284 if ( $name != 'addaddr' ) { return; }
285 $writeable_abook = 1;
286 if ( $abook->numbackends
> 1 ) {
287 $backends = $abook->get_backend_list();
288 $writeable_abooks=array();
289 while (list($undef,$v) = each($backends)) {
291 // add each backend to array
292 $writeable_abooks[$v->bnum
]=$v->sname
;
293 // save backend number
294 $writeable_abook=$v->bnum
;
297 if (count($writeable_abooks)>1) {
298 // we have more than one writeable backend
299 $ret=addSelect('backend',$writeable_abooks,null,true);
300 return html_tag( 'tr',
301 html_tag( 'td', _("Add to:"),'right', $color[4] ) .
302 html_tag( 'td', $ret, 'left', $color[4] )) . "\n";
305 // Only one backend exists or is writeable.
306 return html_tag( 'tr',
308 addHidden('backend', $writeable_abook),
309 'center', $color[4], 'colspan="2"')) . "\n";
313 * Sort array by the key "name"
315 function alistcmp($a,$b) {
316 $abook_sort_order=get_abook_sort();
318 switch ($abook_sort_order) {
321 $abook_sort='nickname';
338 if ($a['backend'] > $b['backend']) {
341 if ($a['backend'] < $b['backend']) {
346 if( (($abook_sort_order+
2) %
2) == 1) {
347 return (strtolower($a[$abook_sort]) < strtolower($b[$abook_sort])) ?
1 : -1;
349 return (strtolower($a[$abook_sort]) > strtolower($b[$abook_sort])) ?
1 : -1;
354 * Address book sorting options
356 * returns address book sorting order
357 * @return integer book sorting options order
359 function get_abook_sort() {
360 global $data_dir, $username;
362 /* get sorting order */
363 if(sqgetGlobalVar('abook_sort_order', $temp, SQ_GET
)) {
364 $abook_sort_order = (int) $temp;
366 if ($abook_sort_order < 0 or $abook_sort_order > 8)
369 setPref($data_dir, $username, 'abook_sort_order', $abook_sort_order);
371 /* get previous sorting options. default to unsorted */
372 $abook_sort_order = getPref($data_dir, $username, 'abook_sort_order', 8);
375 return $abook_sort_order;
379 * This function shows the address book sort button.
381 * @param integer $abook_sort_order current sort value
382 * @param string $alt_tag alt tag value (string visible to text only browsers)
383 * @param integer $Down sort value when list is sorted ascending
384 * @param integer $Up sort value when list is sorted descending
385 * @return string html code with sorting images and urls
387 function show_abook_sort_button($abook_sort_order, $alt_tag, $Down, $Up ) {
390 /* Figure out which image we want to use. */
391 if ($abook_sort_order != $Up && $abook_sort_order != $Down) {
392 $img = 'sort_none.png';
394 } elseif ($abook_sort_order == $Up) {
395 $img = 'up_pointer.png';
398 $img = 'down_pointer.png';
402 /* Now that we have everything figured out, show the actual button. */
403 return ' <a href="' . $form_url .'?abook_sort_order=' . $which
404 . '"><img src="../images/' . $img
405 . '" border="0" width="12" height="10" alt="' . $alt_tag . '" title="'
406 . _("Click here to change the sorting of the address list") .'" /></a>';
411 * This is the main address book class that connect all the
412 * backends and provide services to the functions above.
413 * @package squirrelmail
414 * @subpackage addressbook
418 * Enabled address book backends
421 var $backends = array();
423 * Number of enabled backends
426 var $numbackends = 0;
433 * id of backend with personal address book
436 var $localbackend = 0;
438 * Name of backend with personal address book
441 var $localbackendname = '';
444 * Constructor function.
446 function AddressBook() {
447 $this->localbackendname
= _("Personal address book");
451 * Return an array of backends of a given type,
452 * or all backends if no type is specified.
453 * @param string $type backend type
454 * @return array list of backends
456 function get_backend_list($type = '') {
458 for ($i = 1 ; $i <= $this->numbackends
; $i++
) {
459 if (empty($type) ||
$type == $this->backends
[$i]->btype
) {
460 $ret[] = &$this->backends
[$i];
467 /* ========================== Public ======================== */
472 * @param string $backend backend name (without the abook_ prefix)
473 * @param mixed optional variable that is passed to the backend constructor.
474 * See each of the backend classes for valid parameters
475 * @return integer number of backends
477 function add_backend($backend, $param = '') {
478 $backend_name = 'abook_' . $backend;
479 eval('$newback = new ' . $backend_name . '($param);');
480 if(!empty($newback->error
)) {
481 $this->error
= $newback->error
;
485 $this->numbackends++
;
487 $newback->bnum
= $this->numbackends
;
488 $this->backends
[$this->numbackends
] = $newback;
490 /* Store ID of first local backend added */
491 if ($this->localbackend
== 0 && $newback->btype
== 'local') {
492 $this->localbackend
= $this->numbackends
;
493 $this->localbackendname
= $newback->sname
;
496 return $this->numbackends
;
501 * create string with name and email address
503 * This function takes a $row array as returned by the addressbook
504 * search and returns an e-mail address with the full name or
505 * nickname optionally prepended.
506 * @param array $row address book entry
507 * @return string email address with real name prepended
509 function full_address($row) {
510 global $addrsrch_fullname, $data_dir, $username;
511 $prefix = getPref($data_dir, $username, 'addrsrch_fullname');
512 if (($prefix != "" ||
(isset($addrsrch_fullname) &&
513 $prefix == $addrsrch_fullname)) && $prefix != 'noprefix') {
514 $name = ($prefix == 'nickname' ?
$row['nickname'] : $row['name']);
515 return $name . ' <' . trim($row['email']) . '>';
517 return trim($row['email']);
522 * Search for entries in address books
524 * Return a list of addresses matching expression in
525 * all backends of a given type.
526 * @param string $expression search expression
527 * @param integer $bnum backend number. default to search in all backends
528 * @return array search results
530 function search($expression, $bnum = -1) {
534 /* Search all backends */
536 $sel = $this->get_backend_list('');
538 for ($i = 0 ; $i < sizeof($sel) ; $i++
) {
539 $backend = &$sel[$i];
540 $backend->error
= '';
541 $res = $backend->search($expression);
542 if (is_array($res)) {
543 $ret = array_merge($ret, $res);
545 $this->error
.= "<br />\n" . $backend->error
;
550 /* Only fail if all backends failed */
551 if( $failed >= sizeof( $sel ) ) {
557 /* Search only one backend */
559 $ret = $this->backends
[$bnum]->search($expression);
560 if (!is_array($ret)) {
561 $this->error
.= "<br />\n" . $this->backends
[$bnum]->error
;
572 * @param string $expression search expression
573 * @param integer $bnum backend number. default to search in all backends
574 * @return array search results
576 function s_search($expression, $bnum = -1) {
578 $ret = $this->search($expression, $bnum);
579 if ( is_array( $ret ) ) {
580 usort($ret, 'addressbook_cmp');
587 * Lookup an address by alias.
588 * Only possible in local backends.
589 * @param string $alias
590 * @param integer backend number
591 * @return array lookup results. False, if not found.
593 function lookup($alias, $bnum = -1) {
598 $res = $this->backends
[$bnum]->lookup($alias);
599 if (is_array($res)) {
602 $this->error
= $backend->error
;
607 $sel = $this->get_backend_list('local');
608 for ($i = 0 ; $i < sizeof($sel) ; $i++
) {
609 $backend = &$sel[$i];
610 $backend->error
= '';
611 $res = $backend->lookup($alias);
612 if (is_array($res)) {
616 $this->error
= $backend->error
;
626 * Return all addresses
627 * @param integer $bnum backend number
628 * @return array search results
630 function list_addr($bnum = -1) {
634 $sel = $this->get_backend_list('');
636 $sel = array(0 => &$this->backends
[$bnum]);
639 for ($i = 0 ; $i < sizeof($sel) ; $i++
) {
640 $backend = &$sel[$i];
641 $backend->error
= '';
642 $res = $backend->list_addr();
643 if (is_array($res)) {
644 $ret = array_merge($ret, $res);
646 $this->error
= $backend->error
;
655 * Create a new address
656 * @param array $userdata added address record
657 * @param integer $bnum backend number
658 * @return integer the backend number that the/ address was added
659 * to, or false if it failed.
661 function add($userdata, $bnum) {
664 if (!is_array($userdata)) {
665 $this->error
= _("Invalid input data");
668 if (empty($userdata['firstname']) && empty($userdata['lastname'])) {
669 $this->error
= _("Name is missing");
672 if (empty($userdata['email'])) {
673 $this->error
= _("E-mail address is missing");
676 if (empty($userdata['nickname'])) {
677 $userdata['nickname'] = $userdata['email'];
680 if (eregi('[ \\:\\|\\#\\"\\!]', $userdata['nickname'])) {
681 $this->error
= _("Nickname contains illegal characters");
685 /* Check that specified backend accept new entries */
686 if (!$this->backends
[$bnum]->writeable
) {
687 $this->error
= _("Addressbook is read-only");
691 /* Add address to backend */
692 $res = $this->backends
[$bnum]->add($userdata);
696 $this->error
= $this->backends
[$bnum]->error
;
700 return false; // Not reached
705 * Remove the entries from address book
706 * @param mixed $alias entries that have to be removed. Can be string with nickname or array with list of nicknames
707 * @param integer $bnum backend number
708 * @return bool true if removed successfully. false if there s an error. $this->error contains error message
710 function remove($alias, $bnum) {
717 /* Convert string to single element array */
718 if (!is_array($alias)) {
719 $alias = array(0 => $alias);
722 /* Check that specified backend is writable */
723 if (!$this->backends
[$bnum]->writeable
) {
724 $this->error
= _("Addressbook is read-only");
728 /* Remove user from backend */
729 $res = $this->backends
[$bnum]->remove($alias);
733 $this->error
= $this->backends
[$bnum]->error
;
737 return FALSE; /* Not reached */
738 } /* end of remove() */
742 * Modify entry in address book
743 * @param string $alias nickname
744 * @param array $userdata newdata
745 * @param integer $bnum backend number
747 function modify($alias, $userdata, $bnum) {
750 if (empty($alias) ||
!is_string($alias)) {
755 if(!is_array($userdata)) {
756 $this->error
= _("Invalid input data");
759 if (empty($userdata['firstname']) && empty($userdata['lastname'])) {
760 $this->error
= _("Name is missing");
763 if (empty($userdata['email'])) {
764 $this->error
= _("E-mail address is missing");
768 if (eregi('[\\: \\|\\#"\\!]', $userdata['nickname'])) {
769 $this->error
= _("Nickname contains illegal characters");
773 if (empty($userdata['nickname'])) {
774 $userdata['nickname'] = $userdata['email'];
777 /* Check that specified backend is writable */
778 if (!$this->backends
[$bnum]->writeable
) {
779 $this->error
= _("Addressbook is read-only");;
783 /* Modify user in backend */
784 $res = $this->backends
[$bnum]->modify($alias, $userdata);
788 $this->error
= $this->backends
[$bnum]->error
;
792 return FALSE; /* Not reached */
793 } /* end of modify() */
796 } /* End of class Addressbook */
799 * Generic backend that all other backends extend
800 * @package squirrelmail
801 * @subpackage addressbook
803 class addressbook_backend
{
805 /* Variables that all backends must provide. */
809 * Can be 'local' or 'remote'
810 * @var string backend type
812 var $btype = 'dummy';
814 * Internal backend name
817 var $bname = 'dummy';
819 * Displayed backend name
822 var $sname = 'Dummy backend';
825 * Variables common for all backends, but that
826 * should not be changed by the backends.
842 var $writeable = false;
846 * @param string $string error message
849 function set_error($string) {
850 $this->error
= '[' . $this->sname
. '] ' . $string;
855 /* ========================== Public ======================== */
858 * Search for entries in backend
859 * @param string $expression
862 function search($expression) {
863 $this->set_error('search not implemented');
868 * Find entry in backend by alias
869 * @param string $alias name used for id
872 function lookup($alias) {
873 $this->set_error('lookup not implemented');
878 * List all entries in backend
881 function list_addr() {
882 $this->set_error('list_addr not implemented');
887 * Add entry to backend
888 * @param array userdata
891 function add($userdata) {
892 $this->set_error('add not implemented');
897 * Remove entry from backend
898 * @param string $alias name used for id
901 function remove($alias) {
902 $this->set_error('delete not implemented');
907 * Modify entry in backend
908 * @param string $alias name used for id
909 * @param array $newuserdata new data
912 function modify($alias, $newuserdata) {
913 $this->set_error('modify not implemented');
919 PHP 5 requires that the class be made first, which seems rather
920 logical, and should have been the way it was generated the first time.
923 require_once(SM_PATH
. 'functions/abook_local_file.php');
924 require_once(SM_PATH
. 'functions/abook_ldap_server.php');
926 /* Only load database backend if database is configured */
927 if((isset($addrbook_dsn) && !empty($addrbook_dsn)) ||
928 (isset($addrbook_global_dsn) && !empty($addrbook_global_dsn)) ) {
929 include_once(SM_PATH
. 'functions/abook_database.php');
933 * hook allows adding different address book classes.
934 * class must follow address book class coding standards.
936 * see addressbook_backend class and functions/abook_*.php files.
939 do_hook('abook_add_class');