4 * functions/addressbook.php - Functions and classes for the addressbook system
6 * Functions require SM_PATH and support of forms.php functions
8 * @copyright © 1999-2005 The SquirrelMail Project Team
9 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
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 );
74 /* Global file based addressbook */
75 if (isset($abook_global_file) &&
76 isset($abook_global_file_writeable) &&
77 isset($abook_global_file_listing) &&
78 trim($abook_global_file)!=''){
80 // Detect place of address book
81 if (! preg_match("/[\/\\\]/",$abook_global_file)) {
82 /* no path chars, address book stored in data directory
83 * make sure that there is a slash between data directory
84 * and address book file name
86 $abook_global_filename=$data_dir
87 . ((substr($data_dir, -1) != '/') ?
'/' : '')
89 } elseif (preg_match("/^\/|\w:/",$abook_global_file)) {
90 // full path is set in options (starts with slash or x:)
91 $abook_global_filename=$abook_global_file;
93 $abook_global_filename=SM_PATH
. $abook_global_file;
96 $r = $abook->add_backend('local_file',array('filename'=>$abook_global_filename,
97 'name' => _("Global address book"),
98 'detect_writeable' => false,
99 'writeable'=> $abook_global_file_writeable,
100 'listing' => $abook_global_file_listing));
102 /* global abook init error is not fatal. add error message and continue */
103 if (!$r && $showerr) {
104 if ($abook_init_error!='') $abook_init_error.="<br />\n";
105 $abook_init_error.=_("Error initializing global addressbook.") . "<br />\n" . $abook->error
;
109 /* Load global addressbook from SQL if configured */
110 if (isset($addrbook_global_dsn) && !empty($addrbook_global_dsn)) {
111 /* Database configured */
112 if (!isset($addrbook_global_table) ||
empty($addrbook_global_table)) {
113 $addrbook_global_table = 'global_abook';
115 $r = $abook->add_backend('database',
116 Array('dsn' => $addrbook_global_dsn,
118 'name' => _("Global address book"),
119 'writeable' => $addrbook_global_writeable,
120 'listing' => $addrbook_global_listing,
121 'table' => $addrbook_global_table));
122 /* global abook init error is not fatal. add error message and continue */
123 if (!$r && $showerr) {
124 if ($abook_init_error!='') $abook_init_error.="<br />\n";
125 $abook_init_error.=_("Error initializing global addressbook.") . "<br />\n" . $abook->error
;
130 * hook allows to include different address book backends.
131 * plugins should extract $abook and $r from arguments
132 * and use same add_backend commands as above functions.
133 * @since 1.5.1 and 1.4.5
135 $hookReturn = do_hook('abook_init', $abook, $r);
136 $abook = $hookReturn[1];
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)) {
145 $r = $abook->add_backend('ldap_server', $param);
146 if (!$r && $showerr) {
147 if ($abook_init_error!='') $abook_init_error.="<br />\n";
148 $abook_init_error.=sprintf(_("Error initializing LDAP server %s:") .
149 "<br />\n", $param['host']);
150 $abook_init_error.= $abook->error
;
154 } // end of ldap server init
155 } // end of remote abook backend init
158 * display address book init errors.
160 if ($abook_init_error!='' && $showerr) {
161 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
419 Cleaning errors from html with htmlspecialchars:
420 Errors from the backend are cleaned up in this class because we not always
421 have control over it when error output is generated in the backend.
422 If this appears to be wrong place then clean it up at the source (the backend)
426 * Enabled address book backends
429 var $backends = array();
431 * Number of enabled backends
434 var $numbackends = 0;
441 * id of backend with personal address book
444 var $localbackend = 0;
446 * Name of backend with personal address book
449 var $localbackendname = '';
451 * Controls use of 'extra' field
453 * Extra field can be used to add link to form, which allows
454 * to modify all fields supported by backend. This is the only field
455 * that is not sanitized with htmlspecialchars. Backends MUST make
456 * sure that field data is sanitized and displayed correctly inside
457 * table cell. Use of html formating in other address book fields is
458 * not allowed. Backends that don't return 'extra' row in address book
459 * data should not modify this object property.
463 var $add_extra_field = false;
466 * Constructor function.
468 function AddressBook() {
469 $this->localbackendname
= _("Personal address book");
473 * Return an array of backends of a given type,
474 * or all backends if no type is specified.
475 * @param string $type backend type
476 * @return array list of backends
478 function get_backend_list($type = '') {
480 for ($i = 1 ; $i <= $this->numbackends
; $i++
) {
481 if (empty($type) ||
$type == $this->backends
[$i]->btype
) {
482 $ret[] = &$this->backends
[$i];
489 /* ========================== Public ======================== */
494 * @param string $backend backend name (without the abook_ prefix)
495 * @param mixed optional variable that is passed to the backend constructor.
496 * See each of the backend classes for valid parameters
497 * @return integer number of backends
499 function add_backend($backend, $param = '') {
500 $backend_name = 'abook_' . $backend;
501 eval('$newback = new ' . $backend_name . '($param);');
502 if(!empty($newback->error
)) {
503 $this->error
= $newback->error
;
507 $this->numbackends++
;
509 $newback->bnum
= $this->numbackends
;
510 $this->backends
[$this->numbackends
] = $newback;
512 /* Store ID of first local backend added */
513 if ($this->localbackend
== 0 && $newback->btype
== 'local') {
514 $this->localbackend
= $this->numbackends
;
515 $this->localbackendname
= $newback->sname
;
518 return $this->numbackends
;
523 * create string with name and email address
525 * This function takes a $row array as returned by the addressbook
526 * search and returns an e-mail address with the full name or
527 * nickname optionally prepended.
528 * @param array $row address book entry
529 * @return string email address with real name prepended
531 function full_address($row) {
532 global $addrsrch_fullname, $data_dir, $username;
533 $prefix = getPref($data_dir, $username, 'addrsrch_fullname');
534 if (($prefix != "" ||
(isset($addrsrch_fullname) &&
535 $prefix == $addrsrch_fullname)) && $prefix != 'noprefix') {
536 $name = ($prefix == 'nickname' ?
$row['nickname'] : $row['name']);
537 return $name . ' <' . trim($row['email']) . '>';
539 return trim($row['email']);
544 * Search for entries in address books
546 * Return a list of addresses matching expression in
547 * all backends of a given type.
548 * @param string $expression search expression
549 * @param integer $bnum backend number. default to search in all backends
550 * @return array search results
552 function search($expression, $bnum = -1) {
556 /* Search all backends */
558 $sel = $this->get_backend_list('');
560 for ($i = 0 ; $i < sizeof($sel) ; $i++
) {
561 $backend = &$sel[$i];
562 $backend->error
= '';
563 $res = $backend->search($expression);
564 if (is_array($res)) {
565 $ret = array_merge($ret, $res);
567 $this->error
.= "<br />\n" . htmlspecialchars($backend->error
);
572 /* Only fail if all backends failed */
573 if( $failed >= sizeof( $sel ) ) {
579 /* Search only one backend */
581 $ret = $this->backends
[$bnum]->search($expression);
582 if (!is_array($ret)) {
583 $this->error
.= "<br />\n" . htmlspecialchars($this->backends
[$bnum]->error
);
594 * @param string $expression search expression
595 * @param integer $bnum backend number. default to search in all backends
596 * @return array search results
598 function s_search($expression, $bnum = -1) {
600 $ret = $this->search($expression, $bnum);
601 if ( is_array( $ret ) ) {
602 usort($ret, 'addressbook_cmp');
609 * Lookup an address by alias.
610 * Only possible in local backends.
611 * @param string $alias
612 * @param integer backend number
613 * @return array lookup results. False, if not found.
615 function lookup($alias, $bnum = -1) {
620 $res = $this->backends
[$bnum]->lookup($alias);
621 if (is_array($res)) {
624 $this->error
= htmlspecialchars($this->backends
[$bnum]->error
);
629 $sel = $this->get_backend_list('local');
630 for ($i = 0 ; $i < sizeof($sel) ; $i++
) {
631 $backend = &$sel[$i];
632 $backend->error
= '';
633 $res = $backend->lookup($alias);
634 if (is_array($res)) {
638 $this->error
= htmlspecialchars($backend->error
);
648 * Return all addresses
649 * @param integer $bnum backend number
650 * @return array search results
652 function list_addr($bnum = -1) {
656 $sel = $this->get_backend_list('');
658 $sel = array(0 => &$this->backends
[$bnum]);
661 for ($i = 0 ; $i < sizeof($sel) ; $i++
) {
662 $backend = &$sel[$i];
663 $backend->error
= '';
664 $res = $backend->list_addr();
665 if (is_array($res)) {
666 $ret = array_merge($ret, $res);
668 $this->error
= htmlspecialchars($backend->error
);
677 * Create a new address
678 * @param array $userdata added address record
679 * @param integer $bnum backend number
680 * @return integer the backend number that the/ address was added
681 * to, or false if it failed.
683 function add($userdata, $bnum) {
686 if (!is_array($userdata)) {
687 $this->error
= _("Invalid input data");
690 if (empty($userdata['firstname']) && empty($userdata['lastname'])) {
691 $this->error
= _("Name is missing");
694 if (empty($userdata['email'])) {
695 $this->error
= _("E-mail address is missing");
698 if (empty($userdata['nickname'])) {
699 $userdata['nickname'] = $userdata['email'];
702 if (eregi('[ \\:\\|\\#\\"\\!]', $userdata['nickname'])) {
703 $this->error
= _("Nickname contains illegal characters");
707 /* Check that specified backend accept new entries */
708 if (!$this->backends
[$bnum]->writeable
) {
709 $this->error
= _("Addressbook is read-only");
713 /* Add address to backend */
714 $res = $this->backends
[$bnum]->add($userdata);
718 $this->error
= htmlspecialchars($this->backends
[$bnum]->error
);
722 return false; // Not reached
727 * Remove the entries from address book
728 * @param mixed $alias entries that have to be removed. Can be string with nickname or array with list of nicknames
729 * @param integer $bnum backend number
730 * @return bool true if removed successfully. false if there s an error. $this->error contains error message
732 function remove($alias, $bnum) {
739 /* Convert string to single element array */
740 if (!is_array($alias)) {
741 $alias = array(0 => $alias);
744 /* Check that specified backend is writable */
745 if (!$this->backends
[$bnum]->writeable
) {
746 $this->error
= _("Addressbook is read-only");
750 /* Remove user from backend */
751 $res = $this->backends
[$bnum]->remove($alias);
755 $this->error
= htmlspecialchars($this->backends
[$bnum]->error
);
759 return FALSE; /* Not reached */
760 } /* end of remove() */
764 * Modify entry in address book
765 * @param string $alias nickname
766 * @param array $userdata newdata
767 * @param integer $bnum backend number
769 function modify($alias, $userdata, $bnum) {
772 if (empty($alias) ||
!is_string($alias)) {
777 if(!is_array($userdata)) {
778 $this->error
= _("Invalid input data");
781 if (empty($userdata['firstname']) && empty($userdata['lastname'])) {
782 $this->error
= _("Name is missing");
785 if (empty($userdata['email'])) {
786 $this->error
= _("E-mail address is missing");
790 if (eregi('[\\: \\|\\#"\\!]', $userdata['nickname'])) {
791 $this->error
= _("Nickname contains illegal characters");
795 if (empty($userdata['nickname'])) {
796 $userdata['nickname'] = $userdata['email'];
799 /* Check that specified backend is writable */
800 if (!$this->backends
[$bnum]->writeable
) {
801 $this->error
= _("Addressbook is read-only");;
805 /* Modify user in backend */
806 $res = $this->backends
[$bnum]->modify($alias, $userdata);
810 $this->error
= htmlspecialchars($this->backends
[$bnum]->error
);
814 return FALSE; /* Not reached */
815 } /* end of modify() */
818 } /* End of class Addressbook */
821 * Generic backend that all other backends extend
822 * @package squirrelmail
823 * @subpackage addressbook
825 class addressbook_backend
{
827 /* Variables that all backends must provide. */
831 * Can be 'local' or 'remote'
832 * @var string backend type
834 var $btype = 'dummy';
836 * Internal backend name
839 var $bname = 'dummy';
841 * Displayed backend name
844 var $sname = 'Dummy backend';
847 * Variables common for all backends, but that
848 * should not be changed by the backends.
864 var $writeable = false;
868 * @param string $string error message
871 function set_error($string) {
872 $this->error
= '[' . $this->sname
. '] ' . $string;
877 /* ========================== Public ======================== */
880 * Search for entries in backend
882 * Working backend should support use of wildcards. * symbol
883 * should match one or more symbols. ? symbol should match any
885 * @param string $expression
888 function search($expression) {
889 $this->set_error('search not implemented');
894 * Find entry in backend by alias
895 * @param string $alias name used for id
898 function lookup($alias) {
899 $this->set_error('lookup not implemented');
904 * List all entries in backend
906 * Working backend should provide this function or at least
907 * dummy function that returns empty array.
910 function list_addr() {
911 $this->set_error('list_addr not implemented');
916 * Add entry to backend
917 * @param array userdata
920 function add($userdata) {
921 $this->set_error('add not implemented');
926 * Remove entry from backend
927 * @param string $alias name used for id
930 function remove($alias) {
931 $this->set_error('delete not implemented');
936 * Modify entry in backend
937 * @param string $alias name used for id
938 * @param array $newuserdata new data
941 function modify($alias, $newuserdata) {
942 $this->set_error('modify not implemented');
948 PHP 5 requires that the class be made first, which seems rather
949 logical, and should have been the way it was generated the first time.
952 require_once(SM_PATH
. 'functions/abook_local_file.php');
953 require_once(SM_PATH
. 'functions/abook_ldap_server.php');
955 /* Only load database backend if database is configured */
956 if((isset($addrbook_dsn) && !empty($addrbook_dsn)) ||
957 (isset($addrbook_global_dsn) && !empty($addrbook_global_dsn))) {
958 include_once(SM_PATH
. 'functions/abook_database.php');
962 * hook allows adding different address book classes.
963 * class must follow address book class coding standards.
965 * see addressbook_backend class and functions/abook_*.php files.
966 * @since 1.5.1 and 1.4.5
968 do_hook('abook_add_class');