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 * Display the "new address" form
174 * Form is not closed and you must add closing form tag.
176 * @param string $form_url form action url
177 * @param string $name form name
178 * @param string $title form title
179 * @param string $button form button name
180 * @param array $defdata values of form fields
182 function abook_create_form($form_url,$name,$title,$button,$defdata=array()) {
185 echo addForm($form_url, 'post', 'f_add');
187 if ($button == _("Update address")) {
192 $backends = getWritableBackends();
196 'nickname' => 'NickName',
197 'firstname' => 'FirstName',
198 'lastname' => 'LastName',
203 foreach ($fields as $sqm=>$template) {
204 $values[$template] = isset($defdata[$sqm]) ?
$defdata[$sqm] : '';
207 $oTemplate->assign('writable_backends', $backends);
208 $oTemplate->assign('values', $values);
209 $oTemplate->assign('edit', $edit);
211 $oTemplate->display('addrbook_addedit.tpl');
216 * Had to move this function outside of the Addressbook Class
217 * PHP 4.0.4 Seemed to be having problems with inline functions.
218 * Note: this can return now since we don't support 4.0.4 anymore.
220 function addressbook_cmp($a,$b) {
222 if($a['backend'] > $b['backend']) {
224 } else if($a['backend'] < $b['backend']) {
228 return (strtolower($a['name']) > strtolower($b['name'])) ?
1 : -1;
233 * Retrieve a list of writable backends
236 function getWritableBackends () {
240 $backends = $abook->get_backend_list();
241 while (list($undef,$v) = each($backends)) {
243 $write[$v->bnum
]=$v->sname
;
251 * Sort array by the key "name"
253 function alistcmp($a,$b) {
254 $abook_sort_order=get_abook_sort();
256 switch ($abook_sort_order) {
259 $abook_sort='nickname';
276 if ($a['backend'] > $b['backend']) {
279 if ($a['backend'] < $b['backend']) {
284 if( (($abook_sort_order+
2) %
2) == 1) {
285 return (strtolower($a[$abook_sort]) < strtolower($b[$abook_sort])) ?
1 : -1;
287 return (strtolower($a[$abook_sort]) > strtolower($b[$abook_sort])) ?
1 : -1;
292 * Address book sorting options
294 * returns address book sorting order
295 * @return integer book sorting options order
297 function get_abook_sort() {
298 global $data_dir, $username;
300 /* get sorting order */
301 if(sqgetGlobalVar('abook_sort_order', $temp, SQ_GET
)) {
302 $abook_sort_order = (int) $temp;
304 if ($abook_sort_order < 0 or $abook_sort_order > 8)
307 setPref($data_dir, $username, 'abook_sort_order', $abook_sort_order);
309 /* get previous sorting options. default to unsorted */
310 $abook_sort_order = getPref($data_dir, $username, 'abook_sort_order', 8);
313 return $abook_sort_order;
317 * This function shows the address book sort button.
319 * @param integer $abook_sort_order current sort value
320 * @param string $alt_tag alt tag value (string visible to text only browsers)
321 * @param integer $Down sort value when list is sorted ascending
322 * @param integer $Up sort value when list is sorted descending
323 * @return string html code with sorting images and urls
325 function show_abook_sort_button($abook_sort_order, $alt_tag, $Down, $Up ) {
326 global $form_url, $icon_theme_path;
328 /* Figure out which image we want to use. */
329 if ($abook_sort_order != $Up && $abook_sort_order != $Down) {
330 $img = 'sort_none.png';
331 $text_icon = '◻'; // U+25FB WHITE MEDIUM SQUARE
333 } elseif ($abook_sort_order == $Up) {
334 $img = 'up_pointer.png';
335 $text_icon = '⇧'; // U+21E7 UPWARDS WHITE ARROW
338 $img = 'down_pointer.png';
339 $text_icon = '⇩'; // U+21E9 DOWNWARDS WHITE ARROW
343 /* Now that we have everything figured out, show the actual button. */
344 return ' <a href="' . $form_url .'?abook_sort_order=' . $which .
345 '" style="text-decoration:none" title="'.$alt_tag.'">' .
346 getIcon($icon_theme_path, $img, $text_icon, $alt_tag) .
352 * This is the main address book class that connect all the
353 * backends and provide services to the functions above.
354 * @package squirrelmail
355 * @subpackage addressbook
359 * Enabled address book backends
362 var $backends = array();
364 * Number of enabled backends
367 var $numbackends = 0;
374 * id of backend with personal address book
377 var $localbackend = 0;
379 * Name of backend with personal address book
382 var $localbackendname = '';
384 * Controls use of 'extra' field
386 * Extra field can be used to add link to form, which allows
387 * to modify all fields supported by backend. This is the only field
388 * that is not sanitized with htmlspecialchars. Backends MUST make
389 * sure that field data is sanitized and displayed correctly inside
390 * table cell. Use of html formating in other address book fields is
391 * not allowed. Backends that don't return 'extra' row in address book
392 * data should not modify this object property.
396 var $add_extra_field = false;
399 * Constructor function.
401 function AddressBook() {
402 $this->localbackendname
= _("Personal address book");
406 * Return an array of backends of a given type,
407 * or all backends if no type is specified.
408 * @param string $type backend type
409 * @return array list of backends
411 function get_backend_list($type = '') {
413 for ($i = 1 ; $i <= $this->numbackends
; $i++
) {
414 if (empty($type) ||
$type == $this->backends
[$i]->btype
) {
415 $ret[] = &$this->backends
[$i];
422 /* ========================== Public ======================== */
427 * @param string $backend backend name (without the abook_ prefix)
428 * @param mixed optional variable that is passed to the backend constructor.
429 * See each of the backend classes for valid parameters
430 * @return integer number of backends
432 function add_backend($backend, $param = '') {
433 static $backend_classes;
434 if (!isset($backend_classes)) {
435 $backend_classes = array();
437 if (!isset($backend_classes[$backend])) {
439 * Support backend provided by plugins. Plugin function must
440 * return an associative array with as key the backend name ($backend)
441 * and as value the file including the path containing the backend class.
442 * i.e.: $aBackend = array('backend_template' => SM_PATH . 'plugins/abook_backend_template/functions.php')
444 * NB: Because the backend files are included from within this function they DO NOT have access to
445 * vars in the global scope. This function is the global scope for the included backend !!!
448 $aBackend = do_hook('abook_add_class', $null);
449 if (isset($aBackend) && is_array($aBackend) && isset($aBackend[$backend])) {
450 require_once($aBackend[$backend]);
452 require_once(SM_PATH
. 'functions/abook_'.$backend.'.php');
454 $backend_classes[$backend] = true;
456 $backend_name = 'abook_' . $backend;
457 $newback = new $backend_name($param);
458 //eval('$newback = new ' . $backend_name . '($param);');
459 if(!empty($newback->error
)) {
460 $this->error
= $newback->error
;
464 $this->numbackends++
;
466 $newback->bnum
= $this->numbackends
;
467 $this->backends
[$this->numbackends
] = $newback;
469 /* Store ID of first local backend added */
470 if ($this->localbackend
== 0 && $newback->btype
== 'local') {
471 $this->localbackend
= $this->numbackends
;
472 $this->localbackendname
= $newback->sname
;
475 return $this->numbackends
;
480 * create string with name and email address
482 * This function takes a $row array as returned by the addressbook
483 * search and returns an e-mail address with the full name or
484 * nickname optionally prepended.
485 * @param array $row address book entry
486 * @return string email address with real name prepended
488 function full_address($row) {
489 global $data_dir, $username;
490 $addrsrch_fullname = getPref($data_dir, $username, 'addrsrch_fullname');
491 if ($addrsrch_fullname == 'fullname')
492 return $row['name'] . ' <' . trim($row['email']) . '>';
493 else if ($addrsrch_fullname == 'nickname')
494 return $row['nickname'] . ' <' . trim($row['email']) . '>';
496 return trim($row['email']);
500 * Search for entries in address books
502 * Return a list of addresses matching expression in
503 * all backends of a given type.
504 * @param string $expression search expression
505 * @param integer $bnum backend number. default to search in all backends
506 * @return array search results
508 function search($expression, $bnum = -1) {
512 /* Search all backends */
514 $sel = $this->get_backend_list('');
516 for ($i = 0 ; $i < sizeof($sel) ; $i++
) {
517 $backend = &$sel[$i];
518 $backend->error
= '';
519 $res = $backend->search($expression);
520 if (is_array($res)) {
521 $ret = array_merge($ret, $res);
523 $this->error
.= "\n" . $backend->error
;
528 /* Only fail if all backends failed */
529 if( $failed >= sizeof( $sel ) ) {
533 } elseif (! isset($this->backends
[$bnum])) {
534 /* make sure that backend exists */
535 $this->error
= _("Unknown address book backend");
539 /* Search only one backend */
541 $ret = $this->backends
[$bnum]->search($expression);
542 if (!is_array($ret)) {
543 $this->error
.= "\n" . $this->backends
[$bnum]->error
;
554 * @param string $expression search expression
555 * @param integer $bnum backend number. default to search in all backends
556 * @return array search results
558 function s_search($expression, $bnum = -1) {
560 $ret = $this->search($expression, $bnum);
561 if ( is_array( $ret ) ) {
562 usort($ret, 'addressbook_cmp');
569 * Lookup an address by alias.
570 * Only possible in local backends.
571 * @param string $alias
572 * @param integer backend number
573 * @return array lookup results. False, if not found.
575 function lookup($alias, $bnum = -1) {
580 if (!isset($this->backends
[$bnum])) {
581 $this->error
= _("Unknown address book backend");
584 $res = $this->backends
[$bnum]->lookup($alias);
585 if (is_array($res)) {
588 $this->error
= $this->backends
[$bnum]->error
;
593 $sel = $this->get_backend_list('local');
594 for ($i = 0 ; $i < sizeof($sel) ; $i++
) {
595 $backend = &$sel[$i];
596 $backend->error
= '';
597 $res = $backend->lookup($alias);
598 if (is_array($res)) {
602 $this->error
= $backend->error
;
612 * Return all addresses
613 * @param integer $bnum backend number
614 * @return mixed array with search results or boolean false on error.
616 function list_addr($bnum = -1) {
620 $sel = $this->get_backend_list('');
621 } elseif (! isset($this->backends
[$bnum])) {
622 /* make sure that backend exists */
623 $this->error
= _("Unknown address book backend");
626 $sel = array(0 => &$this->backends
[$bnum]);
629 for ($i = 0 ; $i < sizeof($sel) ; $i++
) {
630 $backend = &$sel[$i];
631 $backend->error
= '';
632 $res = $backend->list_addr();
633 if (is_array($res)) {
634 $ret = array_merge($ret, $res);
636 $this->error
= $backend->error
;
645 * Create a new address
646 * @param array $userdata added address record
647 * @param integer $bnum backend number
648 * @return integer the backend number that the/ address was added
649 * to, or false if it failed.
651 function add($userdata, $bnum) {
654 if (!is_array($userdata)) {
655 $this->error
= _("Invalid input data");
658 if (empty($userdata['firstname']) && empty($userdata['lastname'])) {
659 $this->error
= _("Name is missing");
662 if (empty($userdata['email'])) {
663 $this->error
= _("E-mail address is missing");
666 if (empty($userdata['nickname'])) {
667 $userdata['nickname'] = $userdata['email'];
670 /* Blocks use of space, :, |, #, " and ! in nickname */
671 if (eregi('[ \\:\\|\\#\\"\\!]', $userdata['nickname'])) {
672 $this->error
= _("Nickname contains illegal characters");
676 /* make sure that backend exists */
677 if (! isset($this->backends
[$bnum])) {
678 $this->error
= _("Unknown address book backend");
682 /* Check that specified backend accept new entries */
683 if (!$this->backends
[$bnum]->writeable
) {
684 $this->error
= _("Address book is read-only");
688 /* Add address to backend */
689 $res = $this->backends
[$bnum]->add($userdata);
693 $this->error
= $this->backends
[$bnum]->error
;
697 return false; // Not reached
702 * Remove the entries from address book
703 * @param mixed $alias entries that have to be removed. Can be string with nickname or array with list of nicknames
704 * @param integer $bnum backend number
705 * @return bool true if removed successfully. false if there s an error. $this->error contains error message
707 function remove($alias, $bnum) {
714 /* Convert string to single element array */
715 if (!is_array($alias)) {
716 $alias = array(0 => $alias);
719 /* make sure that backend exists */
720 if (! isset($this->backends
[$bnum])) {
721 $this->error
= _("Unknown address book backend");
725 /* Check that specified backend is writable */
726 if (!$this->backends
[$bnum]->writeable
) {
727 $this->error
= _("Address book is read-only");
731 /* Remove user from backend */
732 $res = $this->backends
[$bnum]->remove($alias);
736 $this->error
= $this->backends
[$bnum]->error
;
740 return FALSE; /* Not reached */
741 } /* end of remove() */
745 * Modify entry in address book
746 * @param string $alias nickname
747 * @param array $userdata newdata
748 * @param integer $bnum backend number
750 function modify($alias, $userdata, $bnum) {
753 if (empty($alias) ||
!is_string($alias)) {
758 if(!is_array($userdata)) {
759 $this->error
= _("Invalid input data");
762 if (empty($userdata['firstname']) && empty($userdata['lastname'])) {
763 $this->error
= _("Name is missing");
766 if (empty($userdata['email'])) {
767 $this->error
= _("E-mail address is missing");
771 if (eregi('[\\: \\|\\#"\\!]', $userdata['nickname'])) {
772 $this->error
= _("Nickname contains illegal characters");
776 if (empty($userdata['nickname'])) {
777 $userdata['nickname'] = $userdata['email'];
780 /* make sure that backend exists */
781 if (! isset($this->backends
[$bnum])) {
782 $this->error
= _("Unknown address book backend");
786 /* Check that specified backend is writable */
787 if (!$this->backends
[$bnum]->writeable
) {
788 $this->error
= _("Address book is read-only");;
792 /* Modify user in backend */
793 $res = $this->backends
[$bnum]->modify($alias, $userdata);
797 $this->error
= $this->backends
[$bnum]->error
;
801 return FALSE; /* Not reached */
802 } /* end of modify() */
805 } /* End of class Addressbook */
808 * Generic backend that all other backends extend
809 * @package squirrelmail
810 * @subpackage addressbook
812 class addressbook_backend
{
814 /* Variables that all backends must provide. */
818 * Can be 'local' or 'remote'
819 * @var string backend type
821 var $btype = 'dummy';
823 * Internal backend name
826 var $bname = 'dummy';
828 * Displayed backend name
831 var $sname = 'Dummy backend';
834 * Variables common for all backends, but that
835 * should not be changed by the backends.
851 var $writeable = false;
855 * @param string $string error message
858 function set_error($string) {
859 $this->error
= '[' . $this->sname
. '] ' . $string;
864 /* ========================== Public ======================== */
867 * Search for entries in backend
869 * Working backend should support use of wildcards. * symbol
870 * should match one or more symbols. ? symbol should match any
872 * @param string $expression
875 function search($expression) {
876 $this->set_error('search is not implemented');
881 * Find entry in backend by alias
882 * @param string $alias name used for id
885 function lookup($alias) {
886 $this->set_error('lookup is not implemented');
891 * List all entries in backend
893 * Working backend should provide this function or at least
894 * dummy function that returns empty array.
897 function list_addr() {
898 $this->set_error('list_addr is not implemented');
903 * Add entry to backend
904 * @param array userdata
907 function add($userdata) {
908 $this->set_error('add is not implemented');
913 * Remove entry from backend
914 * @param string $alias name used for id
917 function remove($alias) {
918 $this->set_error('delete is not implemented');
923 * Modify entry in backend
924 * @param string $alias name used for id
925 * @param array $newuserdata new data
928 function modify($alias, $newuserdata) {
929 $this->set_error('modify is not implemented');
934 * Creates full name from given name and surname
936 * Handles name order differences. Function always runs in SquirrelMail gettext domain.
937 * Plugins don't have to switch domains before calling this function.
938 * @param string $firstname given name
939 * @param string $lastname surname
940 * @return string full name
943 function fullname($firstname,$lastname) {
945 * i18n: allows to control fullname layout in address book listing
946 * first %s is for first name, second %s is for last name.
947 * Translate it to '%2$s %1$s', if surname must be displayed first in your language.
948 * Please note that variables can be set to empty string and extra formating
949 * (for example '%2$s, %1$s' as in 'Smith, John') might break. Use it only for
950 * setting name and surname order. scripts will remove all prepended and appended
953 return trim(sprintf(dgettext('squirrelmail',"%s %s"),$firstname,$lastname));