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-2006 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
129 $hookReturn = do_hook('abook_init', $abook, $r, $onlylocal);
130 $abook = $hookReturn[1];
132 if (!$r && $showerr) {
133 if ($abook_init_error!='') $abook_init_error.="\n";
134 $abook_init_error.=_("Error initializing other address books.") . "\n" . $abook->error
;
137 /* Load configured LDAP servers (if PHP has LDAP support) */
138 if (isset($ldap_server) && is_array($ldap_server)) {
140 while (list($undef,$param) = each($ldap_server)) {
141 if (!is_array($param))
144 /* if onlylocal is true, we only add writeable ldap servers */
145 if ($onlylocal && (!isset($param['writeable']) ||
$param['writeable'] != true))
148 $r = $abook->add_backend('ldap_server', $param);
149 if (!$r && $showerr) {
150 if ($abook_init_error!='') $abook_init_error.="\n";
151 $abook_init_error.=sprintf(_("Error initializing LDAP server %s:"), $param['host'])."\n";
152 $abook_init_error.= $abook->error
;
155 } // end of ldap server init
158 * display address book init errors.
160 if ($abook_init_error!='' && $showerr) {
161 error_box(nl2br(htmlspecialchars($abook_init_error)));
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()) {
182 echo addForm($form_url, 'post', 'f_add');
184 if ($button == _("Update address")) {
189 $backends = getWritableBackends();
193 'nickname' => 'NickName',
194 'firstname' => 'FirstName',
195 'lastname' => 'LastName',
200 foreach ($fields as $sqm=>$template) {
201 $values[$template] = isset($defdata[$sqm]) ?
$defdata[$sqm] : '';
204 $oTemplate->assign('writable_backends', $backends);
205 $oTemplate->assign('values', $values);
206 $oTemplate->assign('edit', $edit);
208 $oTemplate->display('addrbook_addedit.tpl');
213 * Had to move this function outside of the Addressbook Class
214 * PHP 4.0.4 Seemed to be having problems with inline functions.
215 * Note: this can return now since we don't support 4.0.4 anymore.
217 function addressbook_cmp($a,$b) {
219 if($a['backend'] > $b['backend']) {
221 } else if($a['backend'] < $b['backend']) {
225 return (strtolower($a['name']) > strtolower($b['name'])) ?
1 : -1;
230 * Retrieve a list of writable backends
232 * @author Steve Brown
235 function getWritableBackends () {
239 $backends = $abook->get_backend_list();
240 while (list($undef,$v) = each($backends)) {
242 $write[$v->bnum
]=$v->sname
;
250 * Provides list of writeable backends. Works only when address is added,
251 * e.g. $name='addaddr'.
253 * NOTE: This function needs to remain during the templating process to maintain
254 * some degree of backwards compatability with plugins.
256 * @param string $name name of form
257 * @return string html formated backend field (select or hidden)
259 function list_writable_backends($name) {
260 global $color, $abook;
261 if ( $name != 'addaddr' ) { return; }
262 $writeable_abook = 1;
263 if ( $abook->numbackends
> 1 ) {
264 $backends = $abook->get_backend_list();
265 $writeable_abooks=array();
266 while (list($undef,$v) = each($backends)) {
268 // add each backend to array
269 $writeable_abooks[$v->bnum
]=$v->sname
;
270 // save backend number
271 $writeable_abook=$v->bnum
;
274 if (count($writeable_abooks)>1) {
275 // we have more than one writeable backend
276 $ret=addSelect('backend',$writeable_abooks,null,true);
277 return html_tag( 'tr',
278 html_tag( 'td', _("Add to:"),'right', $color[4] ) .
279 html_tag( 'td', $ret, 'left', $color[4] )) . "\n";
282 // Only one backend exists or is writeable.
283 return html_tag( 'tr',
285 addHidden('backend', $writeable_abook),
286 'center', $color[4], 'colspan="2"')) . "\n";
290 * Sort array by the key "name"
292 function alistcmp($a,$b) {
293 $abook_sort_order=get_abook_sort();
295 switch ($abook_sort_order) {
298 $abook_sort='nickname';
315 if ($a['backend'] > $b['backend']) {
318 if ($a['backend'] < $b['backend']) {
323 if( (($abook_sort_order+
2) %
2) == 1) {
324 return (strtolower($a[$abook_sort]) < strtolower($b[$abook_sort])) ?
1 : -1;
326 return (strtolower($a[$abook_sort]) > strtolower($b[$abook_sort])) ?
1 : -1;
331 * Address book sorting options
333 * returns address book sorting order
334 * @return integer book sorting options order
336 function get_abook_sort() {
337 global $data_dir, $username;
339 /* get sorting order */
340 if(sqgetGlobalVar('abook_sort_order', $temp, SQ_GET
)) {
341 $abook_sort_order = (int) $temp;
343 if ($abook_sort_order < 0 or $abook_sort_order > 8)
346 setPref($data_dir, $username, 'abook_sort_order', $abook_sort_order);
348 /* get previous sorting options. default to unsorted */
349 $abook_sort_order = getPref($data_dir, $username, 'abook_sort_order', 8);
352 return $abook_sort_order;
356 * This function shows the address book sort button.
358 * @param integer $abook_sort_order current sort value
359 * @param string $alt_tag alt tag value (string visible to text only browsers)
360 * @param integer $Down sort value when list is sorted ascending
361 * @param integer $Up sort value when list is sorted descending
362 * @return string html code with sorting images and urls
364 function show_abook_sort_button($abook_sort_order, $alt_tag, $Down, $Up ) {
365 global $form_url, $icon_theme_path;
367 /* Figure out which image we want to use. */
368 if ($abook_sort_order != $Up && $abook_sort_order != $Down) {
369 $img = 'sort_none.png';
370 $text_icon = '◻'; // U+25FB WHITE MEDIUM SQUARE
372 } elseif ($abook_sort_order == $Up) {
373 $img = 'up_pointer.png';
374 $text_icon = '⇧'; // U+21E7 UPWARDS WHITE ARROW
377 $img = 'down_pointer.png';
378 $text_icon = '⇩'; // U+21E9 DOWNWARDS WHITE ARROW
382 /* Now that we have everything figured out, show the actual button. */
383 return ' <a href="' . $form_url .'?abook_sort_order=' . $which .
384 '" style="text-decoration:none" title="'.$alt_tag.'">' .
385 getIcon($icon_theme_path, $img, $text_icon, $alt_tag) .
391 * This is the main address book class that connect all the
392 * backends and provide services to the functions above.
393 * @package squirrelmail
394 * @subpackage addressbook
398 * Enabled address book backends
401 var $backends = array();
403 * Number of enabled backends
406 var $numbackends = 0;
413 * id of backend with personal address book
416 var $localbackend = 0;
418 * Name of backend with personal address book
421 var $localbackendname = '';
423 * Controls use of 'extra' field
425 * Extra field can be used to add link to form, which allows
426 * to modify all fields supported by backend. This is the only field
427 * that is not sanitized with htmlspecialchars. Backends MUST make
428 * sure that field data is sanitized and displayed correctly inside
429 * table cell. Use of html formating in other address book fields is
430 * not allowed. Backends that don't return 'extra' row in address book
431 * data should not modify this object property.
435 var $add_extra_field = false;
438 * Constructor function.
440 function AddressBook() {
441 $this->localbackendname
= _("Personal address book");
445 * Return an array of backends of a given type,
446 * or all backends if no type is specified.
447 * @param string $type backend type
448 * @return array list of backends
450 function get_backend_list($type = '') {
452 for ($i = 1 ; $i <= $this->numbackends
; $i++
) {
453 if (empty($type) ||
$type == $this->backends
[$i]->btype
) {
454 $ret[] = &$this->backends
[$i];
461 /* ========================== Public ======================== */
466 * @param string $backend backend name (without the abook_ prefix)
467 * @param mixed optional variable that is passed to the backend constructor.
468 * See each of the backend classes for valid parameters
469 * @return integer number of backends
471 function add_backend($backend, $param = '') {
472 static $backend_classes;
473 if (!isset($backend_classes)) {
474 $backend_classes = array();
476 if (!isset($backend_classes[$backend])) {
478 * Support backend provided by plugins. Plugin function must
479 * return an associative array with as key the backend name ($backend)
480 * and as value the file including the path containing the backend class.
481 * i.e.: $aBackend = array('backend_template' => SM_PATH . 'plugins/abook_backend_template/functions.php')
483 * NB: Because the backend files are included from within this function they DO NOT have access to
484 * vars in the global scope. This function is the global scope for the included backend !!!
486 $aBackend = do_hook('abook_add_class');
487 if (isset($aBackend) && is_array($aBackend) && isset($aBackend[$backend])) {
488 require_once($aBackend[$backend]);
490 require_once(SM_PATH
. 'functions/abook_'.$backend.'.php');
492 $backend_classes[$backend] = true;
494 $backend_name = 'abook_' . $backend;
495 $newback = new $backend_name($param);
496 //eval('$newback = new ' . $backend_name . '($param);');
497 if(!empty($newback->error
)) {
498 $this->error
= $newback->error
;
502 $this->numbackends++
;
504 $newback->bnum
= $this->numbackends
;
505 $this->backends
[$this->numbackends
] = $newback;
507 /* Store ID of first local backend added */
508 if ($this->localbackend
== 0 && $newback->btype
== 'local') {
509 $this->localbackend
= $this->numbackends
;
510 $this->localbackendname
= $newback->sname
;
513 return $this->numbackends
;
518 * create string with name and email address
520 * This function takes a $row array as returned by the addressbook
521 * search and returns an e-mail address with the full name or
522 * nickname optionally prepended.
523 * @param array $row address book entry
524 * @return string email address with real name prepended
526 function full_address($row) {
527 global $addrsrch_fullname, $data_dir, $username;
528 $prefix = getPref($data_dir, $username, 'addrsrch_fullname');
529 if (($prefix != "" ||
(isset($addrsrch_fullname) &&
530 $prefix == $addrsrch_fullname)) && $prefix != 'noprefix') {
531 $name = ($prefix == 'nickname' ?
$row['nickname'] : $row['name']);
532 return $name . ' <' . trim($row['email']) . '>';
534 return trim($row['email']);
539 * Search for entries in address books
541 * Return a list of addresses matching expression in
542 * all backends of a given type.
543 * @param string $expression search expression
544 * @param integer $bnum backend number. default to search in all backends
545 * @return array search results
547 function search($expression, $bnum = -1) {
551 /* Search all backends */
553 $sel = $this->get_backend_list('');
555 for ($i = 0 ; $i < sizeof($sel) ; $i++
) {
556 $backend = &$sel[$i];
557 $backend->error
= '';
558 $res = $backend->search($expression);
559 if (is_array($res)) {
560 $ret = array_merge($ret, $res);
562 $this->error
.= "\n" . $backend->error
;
567 /* Only fail if all backends failed */
568 if( $failed >= sizeof( $sel ) ) {
572 } elseif (! isset($this->backends
[$bnum])) {
573 /* make sure that backend exists */
574 $this->error
= _("Unknown address book backend");
578 /* Search only one backend */
580 $ret = $this->backends
[$bnum]->search($expression);
581 if (!is_array($ret)) {
582 $this->error
.= "\n" . $this->backends
[$bnum]->error
;
593 * @param string $expression search expression
594 * @param integer $bnum backend number. default to search in all backends
595 * @return array search results
597 function s_search($expression, $bnum = -1) {
599 $ret = $this->search($expression, $bnum);
600 if ( is_array( $ret ) ) {
601 usort($ret, 'addressbook_cmp');
608 * Lookup an address by alias.
609 * Only possible in local backends.
610 * @param string $alias
611 * @param integer backend number
612 * @return array lookup results. False, if not found.
614 function lookup($alias, $bnum = -1) {
619 if (!isset($this->backends
[$bnum])) {
620 $this->error
= _("Unknown address book backend");
623 $res = $this->backends
[$bnum]->lookup($alias);
624 if (is_array($res)) {
627 $this->error
= $this->backends
[$bnum]->error
;
632 $sel = $this->get_backend_list('local');
633 for ($i = 0 ; $i < sizeof($sel) ; $i++
) {
634 $backend = &$sel[$i];
635 $backend->error
= '';
636 $res = $backend->lookup($alias);
637 if (is_array($res)) {
641 $this->error
= $backend->error
;
651 * Return all addresses
652 * @param integer $bnum backend number
653 * @return mixed array with search results or boolean false on error.
655 function list_addr($bnum = -1) {
659 $sel = $this->get_backend_list('');
660 } elseif (! isset($this->backends
[$bnum])) {
661 /* make sure that backend exists */
662 $this->error
= _("Unknown address book backend");
665 $sel = array(0 => &$this->backends
[$bnum]);
668 for ($i = 0 ; $i < sizeof($sel) ; $i++
) {
669 $backend = &$sel[$i];
670 $backend->error
= '';
671 $res = $backend->list_addr();
672 if (is_array($res)) {
673 $ret = array_merge($ret, $res);
675 $this->error
= $backend->error
;
684 * Create a new address
685 * @param array $userdata added address record
686 * @param integer $bnum backend number
687 * @return integer the backend number that the/ address was added
688 * to, or false if it failed.
690 function add($userdata, $bnum) {
693 if (!is_array($userdata)) {
694 $this->error
= _("Invalid input data");
697 if (empty($userdata['firstname']) && empty($userdata['lastname'])) {
698 $this->error
= _("Name is missing");
701 if (empty($userdata['email'])) {
702 $this->error
= _("E-mail address is missing");
705 if (empty($userdata['nickname'])) {
706 $userdata['nickname'] = $userdata['email'];
709 /* Blocks use of space, :, |, #, " and ! in nickname */
710 if (eregi('[ \\:\\|\\#\\"\\!]', $userdata['nickname'])) {
711 $this->error
= _("Nickname contains illegal characters");
715 /* make sure that backend exists */
716 if (! isset($this->backends
[$bnum])) {
717 $this->error
= _("Unknown address book backend");
721 /* Check that specified backend accept new entries */
722 if (!$this->backends
[$bnum]->writeable
) {
723 $this->error
= _("Address book is read-only");
727 /* Add address to backend */
728 $res = $this->backends
[$bnum]->add($userdata);
732 $this->error
= $this->backends
[$bnum]->error
;
736 return false; // Not reached
741 * Remove the entries from address book
742 * @param mixed $alias entries that have to be removed. Can be string with nickname or array with list of nicknames
743 * @param integer $bnum backend number
744 * @return bool true if removed successfully. false if there s an error. $this->error contains error message
746 function remove($alias, $bnum) {
753 /* Convert string to single element array */
754 if (!is_array($alias)) {
755 $alias = array(0 => $alias);
758 /* make sure that backend exists */
759 if (! isset($this->backends
[$bnum])) {
760 $this->error
= _("Unknown address book backend");
764 /* Check that specified backend is writable */
765 if (!$this->backends
[$bnum]->writeable
) {
766 $this->error
= _("Address book is read-only");
770 /* Remove user from backend */
771 $res = $this->backends
[$bnum]->remove($alias);
775 $this->error
= $this->backends
[$bnum]->error
;
779 return FALSE; /* Not reached */
780 } /* end of remove() */
784 * Modify entry in address book
785 * @param string $alias nickname
786 * @param array $userdata newdata
787 * @param integer $bnum backend number
789 function modify($alias, $userdata, $bnum) {
792 if (empty($alias) ||
!is_string($alias)) {
797 if(!is_array($userdata)) {
798 $this->error
= _("Invalid input data");
801 if (empty($userdata['firstname']) && empty($userdata['lastname'])) {
802 $this->error
= _("Name is missing");
805 if (empty($userdata['email'])) {
806 $this->error
= _("E-mail address is missing");
810 if (eregi('[\\: \\|\\#"\\!]', $userdata['nickname'])) {
811 $this->error
= _("Nickname contains illegal characters");
815 if (empty($userdata['nickname'])) {
816 $userdata['nickname'] = $userdata['email'];
819 /* make sure that backend exists */
820 if (! isset($this->backends
[$bnum])) {
821 $this->error
= _("Unknown address book backend");
825 /* Check that specified backend is writable */
826 if (!$this->backends
[$bnum]->writeable
) {
827 $this->error
= _("Address book is read-only");;
831 /* Modify user in backend */
832 $res = $this->backends
[$bnum]->modify($alias, $userdata);
836 $this->error
= $this->backends
[$bnum]->error
;
840 return FALSE; /* Not reached */
841 } /* end of modify() */
844 } /* End of class Addressbook */
847 * Generic backend that all other backends extend
848 * @package squirrelmail
849 * @subpackage addressbook
851 class addressbook_backend
{
853 /* Variables that all backends must provide. */
857 * Can be 'local' or 'remote'
858 * @var string backend type
860 var $btype = 'dummy';
862 * Internal backend name
865 var $bname = 'dummy';
867 * Displayed backend name
870 var $sname = 'Dummy backend';
873 * Variables common for all backends, but that
874 * should not be changed by the backends.
890 var $writeable = false;
894 * @param string $string error message
897 function set_error($string) {
898 $this->error
= '[' . $this->sname
. '] ' . $string;
903 /* ========================== Public ======================== */
906 * Search for entries in backend
908 * Working backend should support use of wildcards. * symbol
909 * should match one or more symbols. ? symbol should match any
911 * @param string $expression
914 function search($expression) {
915 $this->set_error('search is not implemented');
920 * Find entry in backend by alias
921 * @param string $alias name used for id
924 function lookup($alias) {
925 $this->set_error('lookup is not implemented');
930 * List all entries in backend
932 * Working backend should provide this function or at least
933 * dummy function that returns empty array.
936 function list_addr() {
937 $this->set_error('list_addr is not implemented');
942 * Add entry to backend
943 * @param array userdata
946 function add($userdata) {
947 $this->set_error('add is not implemented');
952 * Remove entry from backend
953 * @param string $alias name used for id
956 function remove($alias) {
957 $this->set_error('delete is not implemented');
962 * Modify entry in backend
963 * @param string $alias name used for id
964 * @param array $newuserdata new data
967 function modify($alias, $newuserdata) {
968 $this->set_error('modify is not implemented');
973 * Creates full name from given name and surname
975 * Handles name order differences. Function always runs in SquirrelMail gettext domain.
976 * Plugins don't have to switch domains before calling this function.
977 * @param string $firstname given name
978 * @param string $lastname surname
979 * @return string full name
982 function fullname($firstname,$lastname) {
984 * i18n: allows to control fullname layout in address book listing
985 * first %s is for first name, second %s is for last name.
986 * Translate it to '%2$s %1$s', if surname must be displayed first in your language.
987 * Please note that variables can be set to empty string and extra formating
988 * (for example '%2$s, %1$s' as in 'Smith, John') might break. Use it only for
989 * setting name and surname order. scripts will remove all prepended and appended
992 return trim(sprintf(dgettext('squirrelmail',"%s %s"),$firstname,$lastname));