965ac93f0889fff9a0e2ce8be08256213725a194
[squirrelmail.git] / functions / addressbook.php
1 <?php
2 /**
3 * functions/addressbook.php - Functions and classes for the addressbook system
4 *
5 * Functions require SM_PATH and support of forms.php functions
6 *
7 * @copyright &copy; 1999-2007 The SquirrelMail Project Team
8 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
9 * @version $Id$
10 * @package squirrelmail
11 * @subpackage addressbook
12 */
13
14 /**
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
21 * tagged as remote.
22 * @return object address book object.
23 */
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;
30
31 /* Create a new addressbook object */
32 $abook = new AddressBook;
33
34 /* Create empty error message */
35 $abook_init_error='';
36
37 /*
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.
41 */
42 if (isset($addrbook_dsn) && !empty($addrbook_dsn)) {
43 /* Database */
44 if (!isset($addrbook_table) || empty($addrbook_table)) {
45 $addrbook_table = 'address';
46 }
47 $r = $abook->add_backend('database', Array('dsn' => $addrbook_dsn,
48 'owner' => $username,
49 'table' => $addrbook_table));
50 if (!$r && $showerr) {
51 $abook_init_error.=_("Error initializing address book database.") . "\n" . $abook->error;
52 }
53 } else {
54 /* File */
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,
58 'create' => true));
59 if(!$r && $showerr) {
60 // no need to use $abook->error, because message explains error.
61 $abook_init_error.=sprintf( _("Error opening file %s"), $filename );
62 }
63 }
64
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)!=''){
70
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
76 */
77 $abook_global_filename=$data_dir
78 . ((substr($data_dir, -1) != '/') ? '/' : '')
79 . $abook_global_file;
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;
83 } else {
84 $abook_global_filename=SM_PATH . $abook_global_file;
85 }
86
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));
93
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;
98 }
99 }
100
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';
106 }
107 $r = $abook->add_backend('database',
108 Array('dsn' => $addrbook_global_dsn,
109 'owner' => 'global',
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;
118 }
119 }
120
121 /*
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.
132 */
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;
138 }
139
140 /* Load configured LDAP servers (if PHP has LDAP support) */
141 if (isset($ldap_server) && is_array($ldap_server)) {
142 reset($ldap_server);
143 while (list($undef,$param) = each($ldap_server)) {
144 if (!is_array($param))
145 continue;
146
147 /* if onlylocal is true, we only add writeable ldap servers */
148 if ($onlylocal && (!isset($param['writeable']) || $param['writeable'] != true))
149 continue;
150
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;
156 }
157 }
158 } // end of ldap server init
159
160 /**
161 * display address book init errors.
162 */
163 if ($abook_init_error!='' && $showerr) {
164 error_box(nl2br(htmlspecialchars($abook_init_error)));
165 }
166
167 /* Return the initialized object */
168 return $abook;
169 }
170
171 /**
172 * Constructs the "new address" form
173 *
174 * NOTE! The form is not closed - the caller
175 * must add the closing form tag itself.
176 *
177 * @since 1.5.1
178 *
179 * @param string $form_url Form action url
180 * @param string $name Form name
181 * @param string $title Form title
182 * @param string $button Form button name
183 * @param int $backend The current backend being displayed
184 * @param array $defdata Values of form fields
185 *
186 * @return string The desired address form display code
187 *
188 */
189 function abook_create_form($form_url, $name, $title, $button,
190 $backend, $defdata=array()) {
191
192 global $oTemplate;
193
194 $output = addForm($form_url, 'post', 'f_add');
195
196 if ($button == _("Update address")) {
197 $edit = true;
198 $backends = NULL;
199 } else {
200 $edit = false;
201 $backends = getWritableBackends();
202 }
203
204 $fields = array (
205 'nickname' => 'NickName',
206 'firstname' => 'FirstName',
207 'lastname' => 'LastName',
208 'email' => 'Email',
209 'label' => 'Info',
210 );
211 $values = array();
212 foreach ($fields as $sqm=>$template) {
213 $values[$template] = isset($defdata[$sqm]) ? $defdata[$sqm] : '';
214 }
215
216 $oTemplate->assign('writable_backends', $backends);
217 $oTemplate->assign('values', $values);
218 $oTemplate->assign('edit', $edit);
219 $oTemplate->assign('current_backend', $backend);
220
221 $output .= $oTemplate->fetch('addrbook_addedit.tpl');
222
223 return $output;
224 }
225
226
227 /**
228 * Had to move this function outside of the Addressbook Class
229 * PHP 4.0.4 Seemed to be having problems with inline functions.
230 * Note: this can return now since we don't support 4.0.4 anymore.
231 */
232 function addressbook_cmp($a,$b) {
233
234 if($a['backend'] > $b['backend']) {
235 return 1;
236 } else if($a['backend'] < $b['backend']) {
237 return -1;
238 }
239
240 return (strtolower($a['name']) > strtolower($b['name'])) ? 1 : -1;
241
242 }
243
244 /**
245 * Retrieve a list of writable backends
246 * @since 1.5.2
247 */
248 function getWritableBackends () {
249 global $abook;
250
251 $write = array();
252 $backends = $abook->get_backend_list();
253 while (list($undef,$v) = each($backends)) {
254 if ($v->writeable) {
255 $write[$v->bnum]=$v->sname;
256 }
257 }
258
259 return $write;
260 }
261
262 /**
263 * Sort array by the key "name"
264 */
265 function alistcmp($a,$b) {
266 $abook_sort_order=get_abook_sort();
267
268 switch ($abook_sort_order) {
269 case 0:
270 case 1:
271 $abook_sort='nickname';
272 break;
273 case 4:
274 case 5:
275 $abook_sort='email';
276 break;
277 case 6:
278 case 7:
279 $abook_sort='label';
280 break;
281 case 2:
282 case 3:
283 case 8:
284 default:
285 $abook_sort='name';
286 }
287
288 if ($a['backend'] > $b['backend']) {
289 return 1;
290 } else {
291 if ($a['backend'] < $b['backend']) {
292 return -1;
293 }
294 }
295
296 if( (($abook_sort_order+2) % 2) == 1) {
297 return (strtolower($a[$abook_sort]) < strtolower($b[$abook_sort])) ? 1 : -1;
298 } else {
299 return (strtolower($a[$abook_sort]) > strtolower($b[$abook_sort])) ? 1 : -1;
300 }
301 }
302
303 /**
304 * Address book sorting options
305 *
306 * returns address book sorting order
307 * @return integer book sorting options order
308 */
309 function get_abook_sort() {
310 global $data_dir, $username;
311
312 /* get sorting order */
313 if(sqgetGlobalVar('abook_sort_order', $temp, SQ_GET)) {
314 $abook_sort_order = (int) $temp;
315
316 if ($abook_sort_order < 0 or $abook_sort_order > 8)
317 $abook_sort_order=8;
318
319 setPref($data_dir, $username, 'abook_sort_order', $abook_sort_order);
320 } else {
321 /* get previous sorting options. default to unsorted */
322 $abook_sort_order = getPref($data_dir, $username, 'abook_sort_order', 8);
323 }
324
325 return $abook_sort_order;
326 }
327
328 /**
329 * This function shows the address book sort button.
330 *
331 * @param integer $abook_sort_order Current sort value
332 * @param string $alt_tag The alt tag value (string
333 * visible to text only browsers)
334 * @param integer $Down Sort value when list is sorted
335 * ascending
336 * @param integer $Up Sort value when list is sorted
337 * descending
338 * @param array $uri_extra Any additional parameters to add
339 * to the button's link, as an
340 * associative array of key/value pairs
341 * (OPTIONAL; default none)
342 *
343 * @return string html code with sorting images and urls
344 *
345 */
346 function show_abook_sort_button($abook_sort_order, $alt_tag,
347 $Down, $Up, $uri_extra=array() ) {
348
349 global $form_url, $icon_theme_path;
350
351 /* Figure out which image we want to use. */
352 if ($abook_sort_order != $Up && $abook_sort_order != $Down) {
353 $img = 'sort_none.png';
354 $text_icon = '&#9723;'; // U+25FB WHITE MEDIUM SQUARE
355 $which = $Up;
356 } elseif ($abook_sort_order == $Up) {
357 $img = 'up_pointer.png';
358 $text_icon = '&#8679;'; // U+21E7 UPWARDS WHITE ARROW
359 $which = $Down;
360 } else {
361 $img = 'down_pointer.png';
362 $text_icon = '&#8681;'; // U+21E9 DOWNWARDS WHITE ARROW
363 $which = 8;
364 }
365
366 $uri = $form_url .'?abook_sort_order=' . $which;
367 foreach ($uri_extra as $key => $value)
368 $uri = set_url_var($uri, $key, $value, FALSE);
369
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),
373 '', '', '', '', '',
374 array('style' => 'text-decoration:none',
375 'title' => $alt_tag),
376 FALSE);
377 }
378
379
380 /**
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
385 */
386 class AddressBook {
387 /**
388 * Enabled address book backends
389 * @var array
390 */
391 var $backends = array();
392 /**
393 * Number of enabled backends
394 * @var integer
395 */
396 var $numbackends = 0;
397 /**
398 * Error messages
399 * @var string
400 */
401 var $error = '';
402 /**
403 * id of backend with personal address book
404 * @var integer
405 */
406 var $localbackend = 0;
407 /**
408 * Name of backend with personal address book
409 * @var string
410 */
411 var $localbackendname = '';
412 /**
413 * Controls use of 'extra' field
414 *
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.
422 * @var boolean
423 * @since 1.5.1
424 */
425 var $add_extra_field = false;
426
427 /**
428 * Constructor function.
429 */
430 function AddressBook() {
431 $this->localbackendname = _("Personal Address Book");
432 }
433
434 /**
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
439 */
440 function get_backend_list($type = '') {
441 $ret = array();
442 for ($i = 1 ; $i <= $this->numbackends ; $i++) {
443 if (empty($type) || $type == $this->backends[$i]->btype) {
444 $ret[] = &$this->backends[$i];
445 }
446 }
447 return $ret;
448 }
449
450
451 /* ========================== Public ======================== */
452
453 /**
454 * Add a new backend.
455 *
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
460 */
461 function add_backend($backend, $param = '') {
462 static $backend_classes;
463 if (!isset($backend_classes)) {
464 $backend_classes = array();
465 }
466 if (!isset($backend_classes[$backend])) {
467 /**
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')
472 *
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 !!!
475 */
476 global $null;
477 $aBackend = do_hook('abook_add_class', $null);
478 if (isset($aBackend) && is_array($aBackend) && isset($aBackend[$backend])) {
479 require_once($aBackend[$backend]);
480 } else {
481 require_once(SM_PATH . 'functions/abook_'.$backend.'.php');
482 }
483 $backend_classes[$backend] = true;
484 }
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;
490 return false;
491 }
492
493 $this->numbackends++;
494
495 $newback->bnum = $this->numbackends;
496 $this->backends[$this->numbackends] = $newback;
497
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;
502 }
503
504 return $this->numbackends;
505 }
506
507
508 /**
509 * create string with name and email address
510 *
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
516 */
517 function full_address($row) {
518 global $data_dir, $username;
519 $addrsrch_fullname = getPref($data_dir, $username, 'addrsrch_fullname');
520 if ($addrsrch_fullname == 'fullname')
521 return $row['name'] . ' <' . trim($row['email']) . '>';
522 else if ($addrsrch_fullname == 'nickname')
523 return $row['nickname'] . ' <' . trim($row['email']) . '>';
524 else // "noprefix"
525 return trim($row['email']);
526 }
527
528 /**
529 * Search for entries in address books
530 *
531 * Return a list of addresses matching expression in
532 * all backends of a given type.
533 * @param string $expression search expression
534 * @param integer $bnum backend number. default to search in all backends
535 * @return array search results
536 */
537 function search($expression, $bnum = -1) {
538 $ret = array();
539 $this->error = '';
540
541 /* Search all backends */
542 if ($bnum == -1) {
543 $sel = $this->get_backend_list('');
544 $failed = 0;
545 for ($i = 0 ; $i < sizeof($sel) ; $i++) {
546 $backend = &$sel[$i];
547 $backend->error = '';
548 $res = $backend->search($expression);
549 if (is_array($res)) {
550 $ret = array_merge($ret, $res);
551 } else {
552 $this->error .= "\n" . $backend->error;
553 $failed++;
554 }
555 }
556
557 /* Only fail if all backends failed */
558 if( $failed >= sizeof( $sel ) ) {
559 $ret = FALSE;
560 }
561
562 } elseif (! isset($this->backends[$bnum])) {
563 /* make sure that backend exists */
564 $this->error = _("Unknown address book backend");
565 $ret = false;
566 } else {
567
568 /* Search only one backend */
569
570 $ret = $this->backends[$bnum]->search($expression);
571 if (!is_array($ret)) {
572 $this->error .= "\n" . $this->backends[$bnum]->error;
573 $ret = FALSE;
574 }
575 }
576
577 return( $ret );
578 }
579
580
581 /**
582 * Sorted search
583 * @param string $expression search expression
584 * @param integer $bnum backend number. default to search in all backends
585 * @return array search results
586 */
587 function s_search($expression, $bnum = -1) {
588
589 $ret = $this->search($expression, $bnum);
590 if ( is_array( $ret ) ) {
591 usort($ret, 'addressbook_cmp');
592 }
593 return $ret;
594 }
595
596
597 /**
598 * Lookup an address by alias.
599 * Only possible in local backends.
600 * @param string $alias
601 * @param integer backend number
602 * @return array lookup results. False, if not found.
603 */
604 function lookup($alias, $bnum = -1) {
605
606 $ret = array();
607
608 if ($bnum > -1) {
609 if (!isset($this->backends[$bnum])) {
610 $this->error = _("Unknown address book backend");
611 return false;
612 }
613 $res = $this->backends[$bnum]->lookup($alias);
614 if (is_array($res)) {
615 return $res;
616 } else {
617 $this->error = $this->backends[$bnum]->error;
618 return false;
619 }
620 }
621
622 $sel = $this->get_backend_list('local');
623 for ($i = 0 ; $i < sizeof($sel) ; $i++) {
624 $backend = &$sel[$i];
625 $backend->error = '';
626 $res = $backend->lookup($alias);
627 if (is_array($res)) {
628 if(!empty($res))
629 return $res;
630 } else {
631 $this->error = $backend->error;
632 return false;
633 }
634 }
635
636 return $ret;
637 }
638
639
640 /**
641 * Return all addresses
642 * @param integer $bnum backend number
643 * @return mixed array with search results or boolean false on error.
644 */
645 function list_addr($bnum = -1) {
646 $ret = array();
647
648 if ($bnum == -1) {
649 $sel = $this->get_backend_list('');
650 } elseif (! isset($this->backends[$bnum])) {
651 /* make sure that backend exists */
652 $this->error = _("Unknown address book backend");
653 $ret = false;
654 } else {
655 $sel = array(0 => &$this->backends[$bnum]);
656 }
657
658 for ($i = 0 ; $i < sizeof($sel) ; $i++) {
659 $backend = &$sel[$i];
660 $backend->error = '';
661 $res = $backend->list_addr();
662 if (is_array($res)) {
663 $ret = array_merge($ret, $res);
664 } else {
665 $this->error = $backend->error;
666 return false;
667 }
668 }
669
670 return $ret;
671 }
672
673 /**
674 * Create a new address
675 * @param array $userdata added address record
676 * @param integer $bnum backend number
677 * @return integer the backend number that the/ address was added
678 * to, or false if it failed.
679 */
680 function add($userdata, $bnum) {
681
682 /* Validate data */
683 if (!is_array($userdata)) {
684 $this->error = _("Invalid input data");
685 return false;
686 }
687 if (empty($userdata['firstname']) && empty($userdata['lastname'])) {
688 $this->error = _("Name is missing");
689 return false;
690 }
691 if (empty($userdata['email'])) {
692 $this->error = _("E-mail address is missing");
693 return false;
694 }
695 if (empty($userdata['nickname'])) {
696 $userdata['nickname'] = $userdata['email'];
697 }
698
699 /* Blocks use of space, :, |, #, " and ! in nickname */
700 if (eregi('[ \\:\\|\\#\\"\\!]', $userdata['nickname'])) {
701 $this->error = _("Nickname contains illegal characters");
702 return false;
703 }
704
705 /* make sure that backend exists */
706 if (! isset($this->backends[$bnum])) {
707 $this->error = _("Unknown address book backend");
708 return false;
709 }
710
711 /* Check that specified backend accept new entries */
712 if (!$this->backends[$bnum]->writeable) {
713 $this->error = _("Address book is read-only");
714 return false;
715 }
716
717 /* Add address to backend */
718 $res = $this->backends[$bnum]->add($userdata);
719 if ($res) {
720 return $bnum;
721 } else {
722 $this->error = $this->backends[$bnum]->error;
723 return false;
724 }
725
726 return false; // Not reached
727 } /* end of add() */
728
729
730 /**
731 * Remove the entries from address book
732 * @param mixed $alias entries that have to be removed. Can be string with nickname or array with list of nicknames
733 * @param integer $bnum backend number
734 * @return bool true if removed successfully. false if there s an error. $this->error contains error message
735 */
736 function remove($alias, $bnum) {
737
738 /* Check input */
739 if (empty($alias)) {
740 return true;
741 }
742
743 /* Convert string to single element array */
744 if (!is_array($alias)) {
745 $alias = array(0 => $alias);
746 }
747
748 /* make sure that backend exists */
749 if (! isset($this->backends[$bnum])) {
750 $this->error = _("Unknown address book backend");
751 return false;
752 }
753
754 /* Check that specified backend is writable */
755 if (!$this->backends[$bnum]->writeable) {
756 $this->error = _("Address book is read-only");
757 return false;
758 }
759
760 /* Remove user from backend */
761 $res = $this->backends[$bnum]->remove($alias);
762 if ($res) {
763 return $bnum;
764 } else {
765 $this->error = $this->backends[$bnum]->error;
766 return false;
767 }
768
769 return FALSE; /* Not reached */
770 } /* end of remove() */
771
772
773 /**
774 * Modify entry in address book
775 * @param string $alias nickname
776 * @param array $userdata newdata
777 * @param integer $bnum backend number
778 */
779 function modify($alias, $userdata, $bnum) {
780
781 /* Check input */
782 if (empty($alias) || !is_string($alias)) {
783 return true;
784 }
785
786 /* Validate data */
787 if(!is_array($userdata)) {
788 $this->error = _("Invalid input data");
789 return false;
790 }
791 if (empty($userdata['firstname']) && empty($userdata['lastname'])) {
792 $this->error = _("Name is missing");
793 return false;
794 }
795 if (empty($userdata['email'])) {
796 $this->error = _("E-mail address is missing");
797 return false;
798 }
799
800 if (eregi('[\\: \\|\\#"\\!]', $userdata['nickname'])) {
801 $this->error = _("Nickname contains illegal characters");
802 return false;
803 }
804
805 if (empty($userdata['nickname'])) {
806 $userdata['nickname'] = $userdata['email'];
807 }
808
809 /* make sure that backend exists */
810 if (! isset($this->backends[$bnum])) {
811 $this->error = _("Unknown address book backend");
812 return false;
813 }
814
815 /* Check that specified backend is writable */
816 if (!$this->backends[$bnum]->writeable) {
817 $this->error = _("Address book is read-only");;
818 return false;
819 }
820
821 /* Modify user in backend */
822 $res = $this->backends[$bnum]->modify($alias, $userdata);
823 if ($res) {
824 return $bnum;
825 } else {
826 $this->error = $this->backends[$bnum]->error;
827 return false;
828 }
829
830 return FALSE; /* Not reached */
831 } /* end of modify() */
832
833
834 } /* End of class Addressbook */
835
836 /**
837 * Generic backend that all other backends extend
838 * @package squirrelmail
839 * @subpackage addressbook
840 */
841 class addressbook_backend {
842
843 /* Variables that all backends must provide. */
844 /**
845 * Backend type
846 *
847 * Can be 'local' or 'remote'
848 * @var string backend type
849 */
850 var $btype = 'dummy';
851 /**
852 * Internal backend name
853 * @var string
854 */
855 var $bname = 'dummy';
856 /**
857 * Displayed backend name
858 * @var string
859 */
860 var $sname = 'Dummy backend';
861
862 /*
863 * Variables common for all backends, but that
864 * should not be changed by the backends.
865 */
866 /**
867 * Backend number
868 * @var integer
869 */
870 var $bnum = -1;
871 /**
872 * Error messages
873 * @var string
874 */
875 var $error = '';
876 /**
877 * Writeable flag
878 * @var bool
879 */
880 var $writeable = false;
881
882 /**
883 * Set error message
884 * @param string $string error message
885 * @return bool
886 */
887 function set_error($string) {
888 $this->error = '[' . $this->sname . '] ' . $string;
889 return false;
890 }
891
892
893 /* ========================== Public ======================== */
894
895 /**
896 * Search for entries in backend
897 *
898 * Working backend should support use of wildcards. * symbol
899 * should match one or more symbols. ? symbol should match any
900 * single symbol.
901 * @param string $expression
902 * @return bool
903 */
904 function search($expression) {
905 $this->set_error('search is not implemented');
906 return false;
907 }
908
909 /**
910 * Find entry in backend by alias
911 * @param string $alias name used for id
912 * @return bool
913 */
914 function lookup($alias) {
915 $this->set_error('lookup is not implemented');
916 return false;
917 }
918
919 /**
920 * List all entries in backend
921 *
922 * Working backend should provide this function or at least
923 * dummy function that returns empty array.
924 * @return bool
925 */
926 function list_addr() {
927 $this->set_error('list_addr is not implemented');
928 return false;
929 }
930
931 /**
932 * Add entry to backend
933 * @param array userdata
934 * @return bool
935 */
936 function add($userdata) {
937 $this->set_error('add is not implemented');
938 return false;
939 }
940
941 /**
942 * Remove entry from backend
943 * @param string $alias name used for id
944 * @return bool
945 */
946 function remove($alias) {
947 $this->set_error('delete is not implemented');
948 return false;
949 }
950
951 /**
952 * Modify entry in backend
953 * @param string $alias name used for id
954 * @param array $newuserdata new data
955 * @return bool
956 */
957 function modify($alias, $newuserdata) {
958 $this->set_error('modify is not implemented');
959 return false;
960 }
961
962 /**
963 * Creates full name from given name and surname
964 *
965 * Handles name order differences. Function always runs in SquirrelMail gettext domain.
966 * Plugins don't have to switch domains before calling this function.
967 * @param string $firstname given name
968 * @param string $lastname surname
969 * @return string full name
970 * @since 1.5.2
971 */
972 function fullname($firstname,$lastname) {
973 /**
974 * i18n: allows to control fullname layout in address book listing
975 * first %s is for first name, second %s is for last name.
976 * Translate it to '%2$s %1$s', if surname must be displayed first in your language.
977 * Please note that variables can be set to empty string and extra formating
978 * (for example '%2$s, %1$s' as in 'Smith, John') might break. Use it only for
979 * setting name and surname order. scripts will remove all prepended and appended
980 * whitespace.
981 */
982 return trim(sprintf(dgettext('squirrelmail',"%s %s"),$firstname,$lastname));
983 }
984 }