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-2010 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,
58 'line_length' => $abook_file_line_length,
61 // no need to use $abook->error, because message explains error.
62 $abook_init_error.=sprintf( _("Error opening file %s"), $filename );
66 /* Global file based addressbook */
67 if (isset($abook_global_file) &&
68 isset($abook_global_file_writeable) &&
69 isset($abook_global_file_listing) &&
70 trim($abook_global_file)!=''){
72 // Detect place of address book
73 if (! preg_match("/[\/\\\]/",$abook_global_file)) {
74 /* no path chars, address book stored in data directory
75 * make sure that there is a slash between data directory
76 * and address book file name
78 $abook_global_filename=$data_dir
79 . ((substr($data_dir, -1) != '/') ?
'/' : '')
81 } elseif (preg_match("/^\/|\w:/",$abook_global_file)) {
82 // full path is set in options (starts with slash or x:)
83 $abook_global_filename=$abook_global_file;
85 $abook_global_filename=SM_PATH
. $abook_global_file;
88 $r = $abook->add_backend('local_file',array('filename'=>$abook_global_filename,
89 'name' => _("Global Address Book"),
90 'detect_writeable' => false,
91 'line_length' => $abook_file_line_length,
92 'writeable'=> $abook_global_file_writeable,
93 'listing' => $abook_global_file_listing));
95 /* global abook init error is not fatal. add error message and continue */
96 if (!$r && $showerr) {
97 if ($abook_init_error!='') $abook_init_error.="\n";
98 $abook_init_error.=_("Error initializing global address book.") . "\n" . $abook->error
;
102 /* Load global addressbook from SQL if configured */
103 if (isset($addrbook_global_dsn) && !empty($addrbook_global_dsn)) {
104 /* Database configured */
105 if (!isset($addrbook_global_table) ||
empty($addrbook_global_table)) {
106 $addrbook_global_table = 'global_abook';
108 $r = $abook->add_backend('database',
109 Array('dsn' => $addrbook_global_dsn,
111 'name' => _("Global Address Book"),
112 'writeable' => $addrbook_global_writeable,
113 'listing' => $addrbook_global_listing,
114 'table' => $addrbook_global_table));
115 /* global abook init error is not fatal. add error message and continue */
116 if (!$r && $showerr) {
117 if ($abook_init_error!='') $abook_init_error.="\n";
118 $abook_init_error.=_("Error initializing global address book.") . "\n" . $abook->error
;
123 * hook allows to include different address book backends.
124 * plugins should extract $abook and $r from arguments
125 * and use same add_backend commands as above functions.
126 * Since 1.5.2 hook sends third ($onlylocal) argument to address book
127 * plugins in order to allow detection of local address book init.
128 * @since 1.5.1 and 1.4.5
129 * Since 1.5.2, the plugin arguments are passed inside an array
130 * and by reference, so plugins hooking in here need to accept arguments
131 * in an array and change those values as needed instead of returning
132 * the changed values.
134 $temp = array(&$abook, &$r, &$onlylocal);
135 do_hook('abook_init', $temp);
136 if (!$r && $showerr) {
137 if ($abook_init_error!='') $abook_init_error.="\n";
138 $abook_init_error.=_("Error initializing other address books.") . "\n" . $abook->error
;
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))
148 /* if onlylocal is true, we only add writeable ldap servers */
149 if ($onlylocal && (!isset($param['writeable']) ||
$param['writeable'] != true))
152 $r = $abook->add_backend('ldap_server', $param);
153 if (!$r && $showerr) {
154 if ($abook_init_error!='') $abook_init_error.="\n";
155 $abook_init_error.=sprintf(_("Error initializing LDAP server %s:"), $param['host'])."\n";
156 $abook_init_error.= $abook->error
;
159 } // end of ldap server init
162 * display address book init errors.
164 if ($abook_init_error!='' && $showerr) {
165 error_box(nl2br(htmlspecialchars($abook_init_error)));
168 /* Return the initialized object */
173 * Constructs the "new address" form
175 * NOTE! The form is not closed - the caller
176 * must add the closing form tag itself.
180 * @param string $form_url Form action url
181 * @param string $name Form name
182 * @param string $title Form title
183 * @param string $button Form button name
184 * @param int $backend The current backend being displayed
185 * @param array $defdata Values of form fields
187 * @return string The desired address form display code
190 function abook_create_form($form_url, $name, $title, $button,
191 $backend, $defdata=array()) {
195 $output = addForm($form_url, 'post', 'f_add', '', '', array(), TRUE);
197 if ($button == _("Update address")) {
202 $backends = getWritableBackends();
206 'nickname' => 'NickName',
207 'firstname' => 'FirstName',
208 'lastname' => 'LastName',
213 foreach ($fields as $sqm=>$template) {
214 $values[$template] = isset($defdata[$sqm]) ?
$defdata[$sqm] : '';
217 $oTemplate->assign('writable_backends', $backends);
218 $oTemplate->assign('values', $values);
219 $oTemplate->assign('edit', $edit);
220 $oTemplate->assign('current_backend', $backend);
222 $output .= $oTemplate->fetch('addrbook_addedit.tpl');
229 * Had to move this function outside of the Addressbook Class
230 * PHP 4.0.4 Seemed to be having problems with inline functions.
231 * Note: this can return now since we don't support 4.0.4 anymore.
233 function addressbook_cmp($a,$b) {
235 if($a['backend'] > $b['backend']) {
237 } else if($a['backend'] < $b['backend']) {
241 return (strtolower($a['name']) > strtolower($b['name'])) ?
1 : -1;
246 * Retrieve a list of writable backends
249 function getWritableBackends () {
253 $backends = $abook->get_backend_list();
254 while (list($undef,$v) = each($backends)) {
256 $write[$v->bnum
]=$v->sname
;
264 * Sort array by the key "name"
266 function alistcmp($a,$b) {
267 $abook_sort_order=get_abook_sort();
269 switch ($abook_sort_order) {
272 $abook_sort='nickname';
289 if ($a['backend'] > $b['backend']) {
292 if ($a['backend'] < $b['backend']) {
297 if( (($abook_sort_order+
2) %
2) == 1) {
298 return (strtolower($a[$abook_sort]) < strtolower($b[$abook_sort])) ?
1 : -1;
300 return (strtolower($a[$abook_sort]) > strtolower($b[$abook_sort])) ?
1 : -1;
305 * Address book sorting options
307 * returns address book sorting order
308 * @return integer book sorting options order
310 function get_abook_sort() {
311 global $data_dir, $username;
313 /* get sorting order */
314 if(sqgetGlobalVar('abook_sort_order', $temp, SQ_GET
)) {
315 $abook_sort_order = (int) $temp;
317 if ($abook_sort_order < 0 or $abook_sort_order > 8)
320 setPref($data_dir, $username, 'abook_sort_order', $abook_sort_order);
322 /* get previous sorting options. default to unsorted */
323 $abook_sort_order = getPref($data_dir, $username, 'abook_sort_order', 8);
326 return $abook_sort_order;
330 * This function shows the address book sort button.
332 * @param integer $abook_sort_order Current sort value
333 * @param string $alt_tag The alt tag value (string
334 * visible to text only browsers)
335 * @param integer $Down Sort value when list is sorted
337 * @param integer $Up Sort value when list is sorted
339 * @param array $uri_extra Any additional parameters to add
340 * to the button's link, as an
341 * associative array of key/value pairs
342 * (OPTIONAL; default none)
344 * @return string html code with sorting images and urls
347 function show_abook_sort_button($abook_sort_order, $alt_tag,
348 $Down, $Up, $uri_extra=array() ) {
350 global $form_url, $icon_theme_path;
352 /* Figure out which image we want to use. */
353 if ($abook_sort_order != $Up && $abook_sort_order != $Down) {
354 $img = 'sort_none.png';
355 $text_icon = '◻'; // U+25FB WHITE MEDIUM SQUARE
357 } elseif ($abook_sort_order == $Up) {
358 $img = 'up_pointer.png';
359 $text_icon = '⇧'; // U+21E7 UPWARDS WHITE ARROW
362 $img = 'down_pointer.png';
363 $text_icon = '⇩'; // U+21E9 DOWNWARDS WHITE ARROW
367 $uri_extra['abook_sort_order'] = $which;
368 $uri = set_uri_vars($form_url, $uri_extra, FALSE);
370 /* Now that we have everything figured out, show the actual button. */
371 return create_hyperlink($uri,
372 getIcon($icon_theme_path, $img, $text_icon, $alt_tag),
374 array('style' => 'text-decoration:none',
375 'title' => $alt_tag),
381 * This is the main address book class that connect all the
382 * backends and provide services to the functions above.
383 * @package squirrelmail
384 * @subpackage addressbook
388 * Enabled address book backends
391 var $backends = array();
393 * Number of enabled backends
396 var $numbackends = 0;
403 * id of backend with personal address book
406 var $localbackend = 0;
408 * Name of backend with personal address book
411 var $localbackendname = '';
413 * Controls use of 'extra' field
415 * Extra field can be used to add link to form, which allows
416 * to modify all fields supported by backend. This is the only field
417 * that is not sanitized with htmlspecialchars. Backends MUST make
418 * sure that field data is sanitized and displayed correctly inside
419 * table cell. Use of html formating in other address book fields is
420 * not allowed. Backends that don't return 'extra' row in address book
421 * data should not modify this object property.
425 var $add_extra_field = false;
428 * Constructor function.
430 function AddressBook() {
431 $this->localbackendname
= _("Personal Address Book");
435 * Return an array of backends of a given type,
436 * or all backends if no type is specified.
437 * @param string $type backend type
438 * @return array list of backends
440 function get_backend_list($type = '') {
442 for ($i = 1 ; $i <= $this->numbackends
; $i++
) {
443 if (empty($type) ||
$type == $this->backends
[$i]->btype
) {
444 $ret[] = &$this->backends
[$i];
451 /* ========================== Public ======================== */
456 * @param string $backend backend name (without the abook_ prefix)
457 * @param mixed optional variable that is passed to the backend constructor.
458 * See each of the backend classes for valid parameters
459 * @return integer number of backends
461 function add_backend($backend, $param = '') {
462 static $backend_classes;
463 if (!isset($backend_classes)) {
464 $backend_classes = array();
466 if (!isset($backend_classes[$backend])) {
468 * Support backend provided by plugins. Plugin function must
469 * return an associative array with as key the backend name ($backend)
470 * and as value the file including the path containing the backend class.
471 * i.e.: $aBackend = array('backend_template' => SM_PATH . 'plugins/abook_backend_template/functions.php')
473 * NB: Because the backend files are included from within this function they DO NOT have access to
474 * vars in the global scope. This function is the global scope for the included backend !!!
477 $aBackend = do_hook('abook_add_class', $null);
478 if (isset($aBackend) && is_array($aBackend) && isset($aBackend[$backend])) {
479 require_once($aBackend[$backend]);
481 require_once(SM_PATH
. 'functions/abook_'.$backend.'.php');
483 $backend_classes[$backend] = true;
485 $backend_name = 'abook_' . $backend;
486 $newback = new $backend_name($param);
487 //eval('$newback = new ' . $backend_name . '($param);');
488 if(!empty($newback->error
)) {
489 $this->error
= $newback->error
;
493 $this->numbackends++
;
495 $newback->bnum
= $this->numbackends
;
496 $this->backends
[$this->numbackends
] = $newback;
498 /* Store ID of first local backend added */
499 if ($this->localbackend
== 0 && $newback->btype
== 'local') {
500 $this->localbackend
= $this->numbackends
;
501 $this->localbackendname
= $newback->sname
;
504 return $this->numbackends
;
509 * create string with name and email address
511 * This function takes a $row array as returned by the addressbook
512 * search and returns an e-mail address with the full name or
513 * nickname optionally prepended.
514 * @param array $row address book entry
515 * @return string email address with real name prepended
517 function full_address($row) {
518 global $data_dir, $username;
519 $addrsrch_fullname = getPref($data_dir, $username, 'addrsrch_fullname');
521 // allow multiple addresses in one row (poor person's grouping - bah)
522 // (separate with commas)
525 $addresses = explode(',', $row['email']);
526 foreach ($addresses as $address) {
528 if (!empty($return)) $return .= ', ';
530 if ($addrsrch_fullname == 'fullname')
531 $return .= '"' . $row['name'] . '" <' . trim($address) . '>';
532 else if ($addrsrch_fullname == 'nickname')
533 $return .= '"' . $row['nickname'] . '" <' . trim($address) . '>';
535 $return .= trim($address);
543 * Search for entries in address books
545 * Return a list of addresses matching expression in
546 * all backends of a given type.
547 * @param string $expression search expression
548 * @param integer $bnum backend number. default to search in all backends
549 * @return array search results
551 function search($expression, $bnum = -1) {
555 /* Search all backends */
557 $sel = $this->get_backend_list('');
559 for ($i = 0 ; $i < sizeof($sel) ; $i++
) {
560 $backend = &$sel[$i];
561 $backend->error
= '';
562 $res = $backend->search($expression);
563 if (is_array($res)) {
564 $ret = array_merge($ret, $res);
566 $this->error
.= "\n" . $backend->error
;
571 /* Only fail if all backends failed */
572 if( $failed >= sizeof( $sel ) ) {
576 } elseif (! isset($this->backends
[$bnum])) {
577 /* make sure that backend exists */
578 $this->error
= _("Unknown address book backend");
582 /* Search only one backend */
584 $ret = $this->backends
[$bnum]->search($expression);
585 if (!is_array($ret)) {
586 $this->error
.= "\n" . $this->backends
[$bnum]->error
;
597 * @param string $expression search expression
598 * @param integer $bnum backend number. default to search in all backends
599 * @return array search results
601 function s_search($expression, $bnum = -1) {
603 $ret = $this->search($expression, $bnum);
604 if ( is_array( $ret ) ) {
605 usort($ret, 'addressbook_cmp');
612 * Lookup an address by the indicated field.
614 * Only possible in local backends.
616 * @param string $value The value to look up
617 * @param integer $bnum The number of the backend to
618 * look within (OPTIONAL; defaults
619 * to look in all local backends)
620 * @param integer $field The field to look in, should be one
621 * of the SM_ABOOK_FIELD_* constants
622 * defined in include/constants.php
623 * (OPTIONAL; defaults to nickname field)
624 * NOTE: uniqueness is only guaranteed
625 * when the nickname field is used here;
626 * otherwise, the first matching address
629 * @return mixed Array with lookup results when the value
630 * was found, an empty array if the value was
631 * not found, or false if an error occured.
634 function lookup($value, $bnum = -1, $field = SM_ABOOK_FIELD_NICKNAME
) {
639 if (!isset($this->backends
[$bnum])) {
640 $this->error
= _("Unknown address book backend");
643 $res = $this->backends
[$bnum]->lookup($value, $field);
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($value, $field);
658 // return an address if one is found
659 // (empty array means lookup concluded
660 // but no result found - in this case,
661 // proceed to next backend)
663 if (is_array($res)) {
664 if (!empty($res)) return $res;
666 $this->error
= $backend->error
;
676 * Return all addresses
677 * @param integer $bnum backend number
678 * @return mixed array with search results or boolean false on error.
680 function list_addr($bnum = -1) {
684 $sel = $this->get_backend_list('');
685 } elseif (! isset($this->backends
[$bnum])) {
686 /* make sure that backend exists */
687 $this->error
= _("Unknown address book backend");
690 $sel = array(0 => &$this->backends
[$bnum]);
693 for ($i = 0 ; $i < sizeof($sel) ; $i++
) {
694 $backend = &$sel[$i];
695 $backend->error
= '';
696 $res = $backend->list_addr();
697 if (is_array($res)) {
698 $ret = array_merge($ret, $res);
700 $this->error
= $backend->error
;
709 * Create a new address
710 * @param array $userdata added address record
711 * @param integer $bnum backend number
712 * @return integer the backend number that the/ address was added
713 * to, or false if it failed.
715 function add($userdata, $bnum) {
718 if (!is_array($userdata)) {
719 $this->error
= _("Invalid input data");
722 if (empty($userdata['firstname']) && empty($userdata['lastname'])) {
723 $this->error
= _("Name is missing");
726 if (empty($userdata['email'])) {
727 $this->error
= _("E-mail address is missing");
730 if (empty($userdata['nickname'])) {
731 $userdata['nickname'] = $userdata['email'];
734 /* Blocks use of space, :, |, #, " and ! in nickname */
735 if (preg_match('/[ :|#"!]/', $userdata['nickname'])) {
736 $this->error
= _("Nickname contains illegal characters");
740 /* make sure that backend exists */
741 if (! isset($this->backends
[$bnum])) {
742 $this->error
= _("Unknown address book backend");
746 /* Check that specified backend accept new entries */
747 if (!$this->backends
[$bnum]->writeable
) {
748 $this->error
= _("Address book is read-only");
752 /* Add address to backend */
753 $res = $this->backends
[$bnum]->add($userdata);
757 $this->error
= $this->backends
[$bnum]->error
;
761 return false; // Not reached
766 * Remove the entries from address book
767 * @param mixed $alias entries that have to be removed. Can be string with nickname or array with list of nicknames
768 * @param integer $bnum backend number
769 * @return bool true if removed successfully. false if there s an error. $this->error contains error message
771 function remove($alias, $bnum) {
778 /* Convert string to single element array */
779 if (!is_array($alias)) {
780 $alias = array(0 => $alias);
783 /* make sure that backend exists */
784 if (! isset($this->backends
[$bnum])) {
785 $this->error
= _("Unknown address book backend");
789 /* Check that specified backend is writable */
790 if (!$this->backends
[$bnum]->writeable
) {
791 $this->error
= _("Address book is read-only");
795 /* Remove user from backend */
796 $res = $this->backends
[$bnum]->remove($alias);
800 $this->error
= $this->backends
[$bnum]->error
;
804 return FALSE; /* Not reached */
805 } /* end of remove() */
809 * Modify entry in address book
810 * @param string $alias nickname
811 * @param array $userdata newdata
812 * @param integer $bnum backend number
814 function modify($alias, $userdata, $bnum) {
817 if (empty($alias) ||
!is_string($alias)) {
822 if(!is_array($userdata)) {
823 $this->error
= _("Invalid input data");
826 if (empty($userdata['firstname']) && empty($userdata['lastname'])) {
827 $this->error
= _("Name is missing");
830 if (empty($userdata['email'])) {
831 $this->error
= _("E-mail address is missing");
835 if (preg_match('/[: |#"!]/', $userdata['nickname'])) {
836 $this->error
= _("Nickname contains illegal characters");
840 if (empty($userdata['nickname'])) {
841 $userdata['nickname'] = $userdata['email'];
844 /* make sure that backend exists */
845 if (! isset($this->backends
[$bnum])) {
846 $this->error
= _("Unknown address book backend");
850 /* Check that specified backend is writable */
851 if (!$this->backends
[$bnum]->writeable
) {
852 $this->error
= _("Address book is read-only");;
856 /* Modify user in backend */
857 $res = $this->backends
[$bnum]->modify($alias, $userdata);
861 $this->error
= $this->backends
[$bnum]->error
;
865 return FALSE; /* Not reached */
866 } /* end of modify() */
869 } /* End of class Addressbook */
872 * Generic backend that all other backends extend
873 * @package squirrelmail
874 * @subpackage addressbook
876 class addressbook_backend
{
878 /* Variables that all backends must provide. */
882 * Can be 'local' or 'remote'
883 * @var string backend type
885 var $btype = 'dummy';
887 * Internal backend name
890 var $bname = 'dummy';
892 * Displayed backend name
895 var $sname = 'Dummy backend';
898 * Variables common for all backends, but that
899 * should not be changed by the backends.
915 var $writeable = false;
919 * @param string $string error message
922 function set_error($string) {
923 $this->error
= '[' . $this->sname
. '] ' . $string;
928 /* ========================== Public ======================== */
931 * Search for entries in backend
933 * Working backend should support use of wildcards. * symbol
934 * should match one or more symbols. ? symbol should match any
936 * @param string $expression
939 function search($expression) {
940 $this->set_error('search is not implemented');
945 * Find entry in backend by the indicated field
947 * @param string $value The value to look up
948 * @param integer $field The field to look in, should be one
949 * of the SM_ABOOK_FIELD_* constants
950 * defined in include/constants.php
951 * NOTE: uniqueness is only guaranteed
952 * when the nickname field is used here;
953 * otherwise, the first matching address
956 * @return mixed Array with lookup results when the value
957 * was found, an empty array if the value was
958 * not found, or false if an error occured.
961 function lookup($value, $field) {
962 $this->set_error('lookup is not implemented');
967 * List all entries in backend
969 * Working backend should provide this function or at least
970 * dummy function that returns empty array.
973 function list_addr() {
974 $this->set_error('list_addr is not implemented');
979 * Add entry to backend
980 * @param array userdata
983 function add($userdata) {
984 $this->set_error('add is not implemented');
989 * Remove entry from backend
990 * @param string $alias name used for id
993 function remove($alias) {
994 $this->set_error('delete is not implemented');
999 * Modify entry in backend
1000 * @param string $alias name used for id
1001 * @param array $newuserdata new data
1004 function modify($alias, $newuserdata) {
1005 $this->set_error('modify is not implemented');
1010 * Creates full name from given name and surname
1012 * Handles name order differences. Function always runs in SquirrelMail gettext domain.
1013 * Plugins don't have to switch domains before calling this function.
1014 * @param string $firstname given name
1015 * @param string $lastname surname
1016 * @return string full name
1019 function fullname($firstname,$lastname) {
1020 // i18n: allows to control fullname layout in address book listing
1021 // first %s is for first name, second %s is for last name.
1022 // Translate it to '%2$s %1$s', if surname must be displayed first in your language.
1023 // Please note that variables can be set to empty string and extra formating
1024 // (for example '%2$s, %1$s' as in 'Smith, John') might break. Use it only for
1025 // setting name and surname order. scripts will remove all prepended and appended
1027 return trim(sprintf(dgettext('squirrelmail',"%s %s"),$firstname,$lastname));