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-2006 The SquirrelMail Project Team
9 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
11 * @package squirrelmail
12 * @subpackage addressbook
15 /** required includes */
16 // FIXME, NO display code in functions files
17 include_once(SM_PATH
. 'templates/util_global.php');
20 * Create and initialize an addressbook object.
21 * @param boolean $showerr display any address book init errors. html page header
22 * must be created before calling addressbook_init() with $showerr enabled.
23 * @param boolean $onlylocal enable only local address book backends. Should
24 * be used when code does not need access to remote backends. Backends
25 * that provide read only address books with limited listing options can be
27 * @return object address book object.
29 function addressbook_init($showerr = true, $onlylocal = false) {
30 global $data_dir, $username, $ldap_server, $address_book_global_filename;
31 global $addrbook_dsn, $addrbook_table;
32 global $abook_global_file, $abook_global_file_writeable, $abook_global_file_listing;
33 global $addrbook_global_dsn, $addrbook_global_table, $addrbook_global_writeable, $addrbook_global_listing;
34 global $abook_file_line_length;
36 /* Create a new addressbook object */
37 $abook = new AddressBook
;
39 /* Create empty error message */
43 Always add a local backend. We use *either* file-based *or* a
44 database addressbook. If $addrbook_dsn is set, the database
45 backend is used. If not, addressbooks are stores in files.
47 if (isset($addrbook_dsn) && !empty($addrbook_dsn)) {
49 if (!isset($addrbook_table) ||
empty($addrbook_table)) {
50 $addrbook_table = 'address';
52 $r = $abook->add_backend('database', Array('dsn' => $addrbook_dsn,
54 'table' => $addrbook_table));
55 if (!$r && $showerr) {
56 $abook_init_error.=_("Error initializing address book database.") . "\n" . $abook->error
;
60 $filename = getHashedFile($username, $data_dir, "$username.abook");
61 $r = $abook->add_backend('local_file', Array('filename' => $filename,
62 'line_length' => $abook_file_line_length,
65 // no need to use $abook->error, because message explains error.
66 $abook_init_error.=sprintf( _("Error opening file %s"), $filename );
70 /* Global file based addressbook */
71 if (isset($abook_global_file) &&
72 isset($abook_global_file_writeable) &&
73 isset($abook_global_file_listing) &&
74 trim($abook_global_file)!=''){
76 // Detect place of address book
77 if (! preg_match("/[\/\\\]/",$abook_global_file)) {
78 /* no path chars, address book stored in data directory
79 * make sure that there is a slash between data directory
80 * and address book file name
82 $abook_global_filename=$data_dir
83 . ((substr($data_dir, -1) != '/') ?
'/' : '')
85 } elseif (preg_match("/^\/|\w:/",$abook_global_file)) {
86 // full path is set in options (starts with slash or x:)
87 $abook_global_filename=$abook_global_file;
89 $abook_global_filename=SM_PATH
. $abook_global_file;
92 $r = $abook->add_backend('local_file',array('filename'=>$abook_global_filename,
93 'name' => _("Global address book"),
94 'detect_writeable' => false,
95 'line_length' => $abook_file_line_length,
96 'writeable'=> $abook_global_file_writeable,
97 'listing' => $abook_global_file_listing));
99 /* global abook init error is not fatal. add error message and continue */
100 if (!$r && $showerr) {
101 if ($abook_init_error!='') $abook_init_error.="\n";
102 $abook_init_error.=_("Error initializing global address book.") . "\n" . $abook->error
;
106 /* Load global addressbook from SQL if configured */
107 if (isset($addrbook_global_dsn) && !empty($addrbook_global_dsn)) {
108 /* Database configured */
109 if (!isset($addrbook_global_table) ||
empty($addrbook_global_table)) {
110 $addrbook_global_table = 'global_abook';
112 $r = $abook->add_backend('database',
113 Array('dsn' => $addrbook_global_dsn,
115 'name' => _("Global address book"),
116 'writeable' => $addrbook_global_writeable,
117 'listing' => $addrbook_global_listing,
118 'table' => $addrbook_global_table));
119 /* global abook init error is not fatal. add error message and continue */
120 if (!$r && $showerr) {
121 if ($abook_init_error!='') $abook_init_error.="\n";
122 $abook_init_error.=_("Error initializing global address book.") . "\n" . $abook->error
;
127 * hook allows to include different address book backends.
128 * plugins should extract $abook and $r from arguments
129 * and use same add_backend commands as above functions.
130 * Since 1.5.2 hook sends third ($onlylocal) argument to address book
131 * plugins in order to allow detection of local address book init.
132 * @since 1.5.1 and 1.4.5
134 $hookReturn = do_hook('abook_init', $abook, $r, $onlylocal);
135 $abook = $hookReturn[1];
137 if (!$r && $showerr) {
138 if ($abook_init_error!='') $abook_init_error.="\n";
139 $abook_init_error.=_("Error initializing other address books.") . "\n" . $abook->error
;
142 /* Load configured LDAP servers (if PHP has LDAP support) */
143 if (isset($ldap_server) && is_array($ldap_server)) {
145 while (list($undef,$param) = each($ldap_server)) {
146 if (!is_array($param))
149 /* if onlylocal is true, we only add writeable ldap servers */
150 if ($onlylocal && (!isset($param['writeable']) ||
$param['writeable'] != true))
153 $r = $abook->add_backend('ldap_server', $param);
154 if (!$r && $showerr) {
155 if ($abook_init_error!='') $abook_init_error.="\n";
156 $abook_init_error.=sprintf(_("Error initializing LDAP server %s:"), $param['host'])."\n";
157 $abook_init_error.= $abook->error
;
160 } // end of ldap server init
163 * display address book init errors.
165 if ($abook_init_error!='' && $showerr) {
166 error_box(nl2br(htmlspecialchars($abook_init_error)));
169 /* Return the initialized object */
174 * Display the "new address" form
176 * Form is not closed and you must add closing form tag.
178 * @param string $form_url form action url
179 * @param string $name form name
180 * @param string $title form title
181 * @param string $button form button name
182 * @param array $defdata values of form fields
184 function abook_create_form($form_url,$name,$title,$button,$defdata=array()) {
186 echo addForm($form_url, 'post', 'f_add').
189 html_tag( 'td', "\n". '<strong>' . $title . '</strong>' . "\n",
193 , 'center', '', 'width="90%"' ) ."\n";
194 address_form($name, $button, $defdata);
199 * Had to move this function outside of the Addressbook Class
200 * PHP 4.0.4 Seemed to be having problems with inline functions.
201 * Note: this can return now since we don't support 4.0.4 anymore.
203 function addressbook_cmp($a,$b) {
205 if($a['backend'] > $b['backend']) {
207 } else if($a['backend'] < $b['backend']) {
211 return (strtolower($a['name']) > strtolower($b['name'])) ?
1 : -1;
216 * Make an input field
217 * @param string $label
218 * @param string $field
219 * @param string $name
220 * @param string $size
221 * @param array $values
224 function addressbook_inp_field($label, $field, $name, $size, $values, $add='') {
226 $value = ( isset($values[$field]) ?
$values[$field] : '');
228 if (is_array($value)) {
229 $td_str = addSelect($name.'['.$field.']', $value);
231 $td_str = addInput($name.'['.$field.']', $value, $size);
235 return html_tag( 'tr' ,
236 html_tag( 'td', $label . ':', 'right', $color[4]) .
237 html_tag( 'td', $td_str, 'left', $color[4])
243 * Output form to add and modify address data
245 function address_form($name, $submittext, $values = array()) {
246 global $color, $squirrelmail_language;
248 if ($squirrelmail_language == 'ja_JP') {
249 echo html_tag( 'table',
250 addressbook_inp_field(_("Nickname"), 'nickname', $name, 15, $values,
251 ' <small>' . _("Must be unique") . '</small>') .
252 addressbook_inp_field(_("E-mail address"), 'email', $name, 45, $values, '') .
253 addressbook_inp_field(_("Last name"), 'lastname', $name, 45, $values, '') .
254 addressbook_inp_field(_("First name"), 'firstname', $name, 45, $values, '') .
255 addressbook_inp_field(_("Additional info"), 'label', $name, 45, $values, '') .
256 list_writable_backends($name) .
259 addSubmit($submittext, $name.'[SUBMIT]'),
260 'center', $color[4], 'colspan="2"')
262 , 'center', '', 'border="0" cellpadding="1" width="90%"') ."\n";
264 echo html_tag( 'table',
265 addressbook_inp_field(_("Nickname"), 'nickname', $name, 15, $values,
266 ' <small>' . _("Must be unique") . '</small>') .
267 addressbook_inp_field(_("E-mail address"), 'email', $name, 45, $values, '') .
268 addressbook_inp_field(_("First name"), 'firstname', $name, 45, $values, '') .
269 addressbook_inp_field(_("Last name"), 'lastname', $name, 45, $values, '') .
270 addressbook_inp_field(_("Additional info"), 'label', $name, 45, $values, '') .
271 list_writable_backends($name) .
274 addSubmit($submittext, $name.'[SUBMIT]') ,
275 'center', $color[4], 'colspan="2"')
277 , 'center', '', 'border="0" cellpadding="1" width="90%"') ."\n";
282 * Provides list of writeable backends.
283 * Works only when address is added ($name='addaddr')
284 * @param string $name name of form
285 * @return string html formated backend field (select or hidden)
287 function list_writable_backends($name) {
288 global $color, $abook;
289 if ( $name != 'addaddr' ) { return; }
290 $writeable_abook = 1;
291 if ( $abook->numbackends
> 1 ) {
292 $backends = $abook->get_backend_list();
293 $writeable_abooks=array();
294 while (list($undef,$v) = each($backends)) {
296 // add each backend to array
297 $writeable_abooks[$v->bnum
]=$v->sname
;
298 // save backend number
299 $writeable_abook=$v->bnum
;
302 if (count($writeable_abooks)>1) {
303 // we have more than one writeable backend
304 $ret=addSelect('backend',$writeable_abooks,null,true);
305 return html_tag( 'tr',
306 html_tag( 'td', _("Add to:"),'right', $color[4] ) .
307 html_tag( 'td', $ret, 'left', $color[4] )) . "\n";
310 // Only one backend exists or is writeable.
311 return html_tag( 'tr',
313 addHidden('backend', $writeable_abook),
314 'center', $color[4], 'colspan="2"')) . "\n";
318 * Sort array by the key "name"
320 function alistcmp($a,$b) {
321 $abook_sort_order=get_abook_sort();
323 switch ($abook_sort_order) {
326 $abook_sort='nickname';
343 if ($a['backend'] > $b['backend']) {
346 if ($a['backend'] < $b['backend']) {
351 if( (($abook_sort_order+
2) %
2) == 1) {
352 return (strtolower($a[$abook_sort]) < strtolower($b[$abook_sort])) ?
1 : -1;
354 return (strtolower($a[$abook_sort]) > strtolower($b[$abook_sort])) ?
1 : -1;
359 * Address book sorting options
361 * returns address book sorting order
362 * @return integer book sorting options order
364 function get_abook_sort() {
365 global $data_dir, $username;
367 /* get sorting order */
368 if(sqgetGlobalVar('abook_sort_order', $temp, SQ_GET
)) {
369 $abook_sort_order = (int) $temp;
371 if ($abook_sort_order < 0 or $abook_sort_order > 8)
374 setPref($data_dir, $username, 'abook_sort_order', $abook_sort_order);
376 /* get previous sorting options. default to unsorted */
377 $abook_sort_order = getPref($data_dir, $username, 'abook_sort_order', 8);
380 return $abook_sort_order;
384 * This function shows the address book sort button.
386 * @param integer $abook_sort_order current sort value
387 * @param string $alt_tag alt tag value (string visible to text only browsers)
388 * @param integer $Down sort value when list is sorted ascending
389 * @param integer $Up sort value when list is sorted descending
390 * @return string html code with sorting images and urls
392 function show_abook_sort_button($abook_sort_order, $alt_tag, $Down, $Up ) {
393 global $form_url, $icon_theme_path;
395 /* Figure out which image we want to use. */
396 if ($abook_sort_order != $Up && $abook_sort_order != $Down) {
397 $img = 'sort_none.png';
398 $text_icon = '◻'; // U+25FB WHITE MEDIUM SQUARE
400 } elseif ($abook_sort_order == $Up) {
401 $img = 'up_pointer.png';
402 $text_icon = '⇧'; // U+21E7 UPWARDS WHITE ARROW
405 $img = 'down_pointer.png';
406 $text_icon = '⇩'; // U+21E9 DOWNWARDS WHITE ARROW
410 /* Now that we have everything figured out, show the actual button. */
411 return ' <a href="' . $form_url .'?abook_sort_order=' . $which .
412 '" style="text-decoration:none" title="'.$alt_tag.'">' .
413 getIcon($icon_theme_path, $img, $text_icon, $alt_tag) .
419 * This is the main address book class that connect all the
420 * backends and provide services to the functions above.
421 * @package squirrelmail
422 * @subpackage addressbook
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 static $backend_classes;
501 if (!isset($backend_classes)) {
502 $backend_classes = array();
504 if (!isset($backend_classes[$backend])) {
506 * Support backend provided by plugins. Plugin function must
507 * return an associative array with as key the backend name ($backend)
508 * and as value the file including the path containing the backend class.
509 * i.e.: $aBackend = array('backend_template' => SM_PATH . 'plugins/abook_backend_template/functions.php')
511 * NB: Because the backend files are included from within this function they DO NOT have access to
512 * vars in the global scope. This function is the global scope for the included backend !!!
514 $aBackend = do_hook('abook_add_class');
515 if (isset($aBackend) && is_array($aBackend) && isset($aBackend[$backend])) {
516 require_once($aBackend[$backend]);
518 require_once(SM_PATH
. 'functions/abook_'.$backend.'.php');
520 $backend_classes[$backend] = true;
522 $backend_name = 'abook_' . $backend;
523 $newback = new $backend_name($param);
524 //eval('$newback = new ' . $backend_name . '($param);');
525 if(!empty($newback->error
)) {
526 $this->error
= $newback->error
;
530 $this->numbackends++
;
532 $newback->bnum
= $this->numbackends
;
533 $this->backends
[$this->numbackends
] = $newback;
535 /* Store ID of first local backend added */
536 if ($this->localbackend
== 0 && $newback->btype
== 'local') {
537 $this->localbackend
= $this->numbackends
;
538 $this->localbackendname
= $newback->sname
;
541 return $this->numbackends
;
546 * create string with name and email address
548 * This function takes a $row array as returned by the addressbook
549 * search and returns an e-mail address with the full name or
550 * nickname optionally prepended.
551 * @param array $row address book entry
552 * @return string email address with real name prepended
554 function full_address($row) {
555 global $addrsrch_fullname, $data_dir, $username;
556 $prefix = getPref($data_dir, $username, 'addrsrch_fullname');
557 if (($prefix != "" ||
(isset($addrsrch_fullname) &&
558 $prefix == $addrsrch_fullname)) && $prefix != 'noprefix') {
559 $name = ($prefix == 'nickname' ?
$row['nickname'] : $row['name']);
560 return $name . ' <' . trim($row['email']) . '>';
562 return trim($row['email']);
567 * Search for entries in address books
569 * Return a list of addresses matching expression in
570 * all backends of a given type.
571 * @param string $expression search expression
572 * @param integer $bnum backend number. default to search in all backends
573 * @return array search results
575 function search($expression, $bnum = -1) {
579 /* Search all backends */
581 $sel = $this->get_backend_list('');
583 for ($i = 0 ; $i < sizeof($sel) ; $i++
) {
584 $backend = &$sel[$i];
585 $backend->error
= '';
586 $res = $backend->search($expression);
587 if (is_array($res)) {
588 $ret = array_merge($ret, $res);
590 $this->error
.= "\n" . $backend->error
;
595 /* Only fail if all backends failed */
596 if( $failed >= sizeof( $sel ) ) {
602 /* Search only one backend */
604 $ret = $this->backends
[$bnum]->search($expression);
605 if (!is_array($ret)) {
606 $this->error
.= "\n" . $this->backends
[$bnum]->error
;
617 * @param string $expression search expression
618 * @param integer $bnum backend number. default to search in all backends
619 * @return array search results
621 function s_search($expression, $bnum = -1) {
623 $ret = $this->search($expression, $bnum);
624 if ( is_array( $ret ) ) {
625 usort($ret, 'addressbook_cmp');
632 * Lookup an address by alias.
633 * Only possible in local backends.
634 * @param string $alias
635 * @param integer backend number
636 * @return array lookup results. False, if not found.
638 function lookup($alias, $bnum = -1) {
643 $res = $this->backends
[$bnum]->lookup($alias);
644 if (is_array($res)) {
647 $this->error
= $this->backends
[$bnum]->error
;
652 $sel = $this->get_backend_list('local');
653 for ($i = 0 ; $i < sizeof($sel) ; $i++
) {
654 $backend = &$sel[$i];
655 $backend->error
= '';
656 $res = $backend->lookup($alias);
657 if (is_array($res)) {
661 $this->error
= $backend->error
;
671 * Return all addresses
672 * @param integer $bnum backend number
673 * @return array search results
675 function list_addr($bnum = -1) {
679 $sel = $this->get_backend_list('');
681 $sel = array(0 => &$this->backends
[$bnum]);
684 for ($i = 0 ; $i < sizeof($sel) ; $i++
) {
685 $backend = &$sel[$i];
686 $backend->error
= '';
687 $res = $backend->list_addr();
688 if (is_array($res)) {
689 $ret = array_merge($ret, $res);
691 $this->error
= $backend->error
;
700 * Create a new address
701 * @param array $userdata added address record
702 * @param integer $bnum backend number
703 * @return integer the backend number that the/ address was added
704 * to, or false if it failed.
706 function add($userdata, $bnum) {
709 if (!is_array($userdata)) {
710 $this->error
= _("Invalid input data");
713 if (empty($userdata['firstname']) && empty($userdata['lastname'])) {
714 $this->error
= _("Name is missing");
717 if (empty($userdata['email'])) {
718 $this->error
= _("E-mail address is missing");
721 if (empty($userdata['nickname'])) {
722 $userdata['nickname'] = $userdata['email'];
725 /* Blocks use of space, :, |, #, " and ! in nickname */
726 if (eregi('[ \\:\\|\\#\\"\\!]', $userdata['nickname'])) {
727 $this->error
= _("Nickname contains illegal characters");
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 /* Check that specified backend is writable */
769 if (!$this->backends
[$bnum]->writeable
) {
770 $this->error
= _("Address book is read-only");
774 /* Remove user from backend */
775 $res = $this->backends
[$bnum]->remove($alias);
779 $this->error
= $this->backends
[$bnum]->error
;
783 return FALSE; /* Not reached */
784 } /* end of remove() */
788 * Modify entry in address book
789 * @param string $alias nickname
790 * @param array $userdata newdata
791 * @param integer $bnum backend number
793 function modify($alias, $userdata, $bnum) {
796 if (empty($alias) ||
!is_string($alias)) {
801 if(!is_array($userdata)) {
802 $this->error
= _("Invalid input data");
805 if (empty($userdata['firstname']) && empty($userdata['lastname'])) {
806 $this->error
= _("Name is missing");
809 if (empty($userdata['email'])) {
810 $this->error
= _("E-mail address is missing");
814 if (eregi('[\\: \\|\\#"\\!]', $userdata['nickname'])) {
815 $this->error
= _("Nickname contains illegal characters");
819 if (empty($userdata['nickname'])) {
820 $userdata['nickname'] = $userdata['email'];
823 /* Check that specified backend is writable */
824 if (!$this->backends
[$bnum]->writeable
) {
825 $this->error
= _("Address book is read-only");;
829 /* Modify user in backend */
830 $res = $this->backends
[$bnum]->modify($alias, $userdata);
834 $this->error
= $this->backends
[$bnum]->error
;
838 return FALSE; /* Not reached */
839 } /* end of modify() */
842 } /* End of class Addressbook */
845 * Generic backend that all other backends extend
846 * @package squirrelmail
847 * @subpackage addressbook
849 class addressbook_backend
{
851 /* Variables that all backends must provide. */
855 * Can be 'local' or 'remote'
856 * @var string backend type
858 var $btype = 'dummy';
860 * Internal backend name
863 var $bname = 'dummy';
865 * Displayed backend name
868 var $sname = 'Dummy backend';
871 * Variables common for all backends, but that
872 * should not be changed by the backends.
888 var $writeable = false;
892 * @param string $string error message
895 function set_error($string) {
896 $this->error
= '[' . $this->sname
. '] ' . $string;
901 /* ========================== Public ======================== */
904 * Search for entries in backend
906 * Working backend should support use of wildcards. * symbol
907 * should match one or more symbols. ? symbol should match any
909 * @param string $expression
912 function search($expression) {
913 $this->set_error('search is not implemented');
918 * Find entry in backend by alias
919 * @param string $alias name used for id
922 function lookup($alias) {
923 $this->set_error('lookup is not implemented');
928 * List all entries in backend
930 * Working backend should provide this function or at least
931 * dummy function that returns empty array.
934 function list_addr() {
935 $this->set_error('list_addr is not implemented');
940 * Add entry to backend
941 * @param array userdata
944 function add($userdata) {
945 $this->set_error('add is not implemented');
950 * Remove entry from backend
951 * @param string $alias name used for id
954 function remove($alias) {
955 $this->set_error('delete is not implemented');
960 * Modify entry in backend
961 * @param string $alias name used for id
962 * @param array $newuserdata new data
965 function modify($alias, $newuserdata) {
966 $this->set_error('modify is not implemented');
971 * Creates full name from given name and surname
973 * Handles name order differences
974 * @param string $firstname given name
975 * @param string $lastname surname
976 * @return string full name
979 function fullname($firstname,$lastname) {
980 global $squirrelmail_language;
981 if ($squirrelmail_language=='ja_JP') {
982 return trim($lastname . ' ' . $firstname);
984 return trim($firstname . ' ' . $lastname);