9b10a3cc649fa9564bcef53ee27bde811523277b
[squirrelmail.git] / functions / addressbook.php
1 <?php
2
3 /**
4 * functions/addressbook.php - Functions and classes for the addressbook system
5 *
6 * Functions require SM_PATH and support of forms.php functions
7 *
8 * @copyright &copy; 1999-2006 The SquirrelMail Project Team
9 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
10 * @version $Id$
11 * @package squirrelmail
12 * @subpackage addressbook
13 */
14
15 /** required includes */
16 // FIXME, NO display code in functions files
17 include_once(SM_PATH . 'templates/util_global.php');
18
19 /**
20 * Create and initialize an addressbook object.
21 * @param boolean $showerr display any address book init errors. html page header
22 * must be created before calling addressbook_init() with $showerr enabled.
23 * @param boolean $onlylocal enable only local address book backends. Should
24 * be used when code does not need access to remote backends. Backends
25 * that provide read only address books with limited listing options can be
26 * tagged as remote.
27 * @return object address book object.
28 */
29 function addressbook_init($showerr = true, $onlylocal = false) {
30 global $data_dir, $username, $ldap_server, $address_book_global_filename;
31 global $addrbook_dsn, $addrbook_table;
32 global $abook_global_file, $abook_global_file_writeable, $abook_global_file_listing;
33 global $addrbook_global_dsn, $addrbook_global_table, $addrbook_global_writeable, $addrbook_global_listing;
34 global $abook_file_line_length;
35
36 /* Create a new addressbook object */
37 $abook = new AddressBook;
38
39 /* Create empty error message */
40 $abook_init_error='';
41
42 /*
43 Always add a local backend. We use *either* file-based *or* a
44 database addressbook. If $addrbook_dsn is set, the database
45 backend is used. If not, addressbooks are stores in files.
46 */
47 if (isset($addrbook_dsn) && !empty($addrbook_dsn)) {
48 /* Database */
49 if (!isset($addrbook_table) || empty($addrbook_table)) {
50 $addrbook_table = 'address';
51 }
52 $r = $abook->add_backend('database', Array('dsn' => $addrbook_dsn,
53 'owner' => $username,
54 'table' => $addrbook_table));
55 if (!$r && $showerr) {
56 $abook_init_error.=_("Error initializing address book database.") . "\n" . $abook->error;
57 }
58 } else {
59 /* File */
60 $filename = getHashedFile($username, $data_dir, "$username.abook");
61 $r = $abook->add_backend('local_file', Array('filename' => $filename,
62 'line_length' => $abook_file_line_length,
63 'create' => true));
64 if(!$r && $showerr) {
65 // no need to use $abook->error, because message explains error.
66 $abook_init_error.=sprintf( _("Error opening file %s"), $filename );
67 }
68 }
69
70 /* Global file based addressbook */
71 if (isset($abook_global_file) &&
72 isset($abook_global_file_writeable) &&
73 isset($abook_global_file_listing) &&
74 trim($abook_global_file)!=''){
75
76 // Detect place of address book
77 if (! preg_match("/[\/\\\]/",$abook_global_file)) {
78 /* no path chars, address book stored in data directory
79 * make sure that there is a slash between data directory
80 * and address book file name
81 */
82 $abook_global_filename=$data_dir
83 . ((substr($data_dir, -1) != '/') ? '/' : '')
84 . $abook_global_file;
85 } elseif (preg_match("/^\/|\w:/",$abook_global_file)) {
86 // full path is set in options (starts with slash or x:)
87 $abook_global_filename=$abook_global_file;
88 } else {
89 $abook_global_filename=SM_PATH . $abook_global_file;
90 }
91
92 $r = $abook->add_backend('local_file',array('filename'=>$abook_global_filename,
93 'name' => _("Global address book"),
94 'detect_writeable' => false,
95 'line_length' => $abook_file_line_length,
96 'writeable'=> $abook_global_file_writeable,
97 'listing' => $abook_global_file_listing));
98
99 /* global abook init error is not fatal. add error message and continue */
100 if (!$r && $showerr) {
101 if ($abook_init_error!='') $abook_init_error.="\n";
102 $abook_init_error.=_("Error initializing global address book.") . "\n" . $abook->error;
103 }
104 }
105
106 /* Load global addressbook from SQL if configured */
107 if (isset($addrbook_global_dsn) && !empty($addrbook_global_dsn)) {
108 /* Database configured */
109 if (!isset($addrbook_global_table) || empty($addrbook_global_table)) {
110 $addrbook_global_table = 'global_abook';
111 }
112 $r = $abook->add_backend('database',
113 Array('dsn' => $addrbook_global_dsn,
114 'owner' => 'global',
115 'name' => _("Global address book"),
116 'writeable' => $addrbook_global_writeable,
117 'listing' => $addrbook_global_listing,
118 'table' => $addrbook_global_table));
119 /* global abook init error is not fatal. add error message and continue */
120 if (!$r && $showerr) {
121 if ($abook_init_error!='') $abook_init_error.="\n";
122 $abook_init_error.=_("Error initializing global address book.") . "\n" . $abook->error;
123 }
124 }
125
126 /*
127 * hook allows to include different address book backends.
128 * plugins should extract $abook and $r from arguments
129 * and use same add_backend commands as above functions.
130 * Since 1.5.2 hook sends third ($onlylocal) argument to address book
131 * plugins in order to allow detection of local address book init.
132 * @since 1.5.1 and 1.4.5
133 */
134 $hookReturn = do_hook('abook_init', $abook, $r, $onlylocal);
135 $abook = $hookReturn[1];
136 $r = $hookReturn[2];
137 if (!$r && $showerr) {
138 if ($abook_init_error!='') $abook_init_error.="\n";
139 $abook_init_error.=_("Error initializing other address books.") . "\n" . $abook->error;
140 }
141
142 /* Load configured LDAP servers (if PHP has LDAP support) */
143 if (isset($ldap_server) && is_array($ldap_server)) {
144 reset($ldap_server);
145 while (list($undef,$param) = each($ldap_server)) {
146 if (!is_array($param))
147 continue;
148
149 /* if onlylocal is true, we only add writeable ldap servers */
150 if ($onlylocal && (!isset($param['writeable']) || $param['writeable'] != true))
151 continue;
152
153 $r = $abook->add_backend('ldap_server', $param);
154 if (!$r && $showerr) {
155 if ($abook_init_error!='') $abook_init_error.="\n";
156 $abook_init_error.=sprintf(_("Error initializing LDAP server %s:"), $param['host'])."\n";
157 $abook_init_error.= $abook->error;
158 }
159 }
160 } // end of ldap server init
161
162 /**
163 * display address book init errors.
164 */
165 if ($abook_init_error!='' && $showerr) {
166 error_box(nl2br(htmlspecialchars($abook_init_error)));
167 }
168
169 /* Return the initialized object */
170 return $abook;
171 }
172
173 /**
174 * Display the "new address" form
175 *
176 * Form is not closed and you must add closing form tag.
177 * @since 1.5.1
178 * @param string $form_url form action url
179 * @param string $name form name
180 * @param string $title form title
181 * @param string $button form button name
182 * @param array $defdata values of form fields
183 */
184 function abook_create_form($form_url,$name,$title,$button,$defdata=array()) {
185 global $color;
186 echo addForm($form_url, 'post', 'f_add').
187 html_tag( 'table',
188 html_tag( 'tr',
189 html_tag( 'td', "\n". '<strong>' . $title . '</strong>' . "\n",
190 'center', $color[0]
191 )
192 )
193 , 'center', '', 'width="90%"' ) ."\n";
194 address_form($name, $button, $defdata);
195 }
196
197
198 /**
199 * Had to move this function outside of the Addressbook Class
200 * PHP 4.0.4 Seemed to be having problems with inline functions.
201 * Note: this can return now since we don't support 4.0.4 anymore.
202 */
203 function addressbook_cmp($a,$b) {
204
205 if($a['backend'] > $b['backend']) {
206 return 1;
207 } else if($a['backend'] < $b['backend']) {
208 return -1;
209 }
210
211 return (strtolower($a['name']) > strtolower($b['name'])) ? 1 : -1;
212
213 }
214
215 /**
216 * Make an input field
217 * @param string $label
218 * @param string $field
219 * @param string $name
220 * @param string $size
221 * @param array $values
222 * @param string $add
223 */
224 function addressbook_inp_field($label, $field, $name, $size, $values, $add='') {
225 global $color;
226 $value = ( isset($values[$field]) ? $values[$field] : '');
227
228 if (is_array($value)) {
229 $td_str = addSelect($name.'['.$field.']', $value);
230 } else {
231 $td_str = addInput($name.'['.$field.']', $value, $size);
232 }
233 $td_str .= $add ;
234
235 return html_tag( 'tr' ,
236 html_tag( 'td', $label . ':', 'right', $color[4]) .
237 html_tag( 'td', $td_str, 'left', $color[4])
238 )
239 . "\n";
240 }
241
242 /**
243 * Output form to add and modify address data
244 */
245 function address_form($name, $submittext, $values = array()) {
246 global $color, $squirrelmail_language;
247
248 if ($squirrelmail_language == 'ja_JP') {
249 echo html_tag( 'table',
250 addressbook_inp_field(_("Nickname"), 'nickname', $name, 15, $values,
251 ' <small>' . _("Must be unique") . '</small>') .
252 addressbook_inp_field(_("E-mail address"), 'email', $name, 45, $values, '') .
253 addressbook_inp_field(_("Last name"), 'lastname', $name, 45, $values, '') .
254 addressbook_inp_field(_("First name"), 'firstname', $name, 45, $values, '') .
255 addressbook_inp_field(_("Additional info"), 'label', $name, 45, $values, '') .
256 list_writable_backends($name) .
257 html_tag( 'tr',
258 html_tag( 'td',
259 addSubmit($submittext, $name.'[SUBMIT]'),
260 'center', $color[4], 'colspan="2"')
261 )
262 , 'center', '', 'border="0" cellpadding="1" width="90%"') ."\n";
263 } else {
264 echo html_tag( 'table',
265 addressbook_inp_field(_("Nickname"), 'nickname', $name, 15, $values,
266 ' <small>' . _("Must be unique") . '</small>') .
267 addressbook_inp_field(_("E-mail address"), 'email', $name, 45, $values, '') .
268 addressbook_inp_field(_("First name"), 'firstname', $name, 45, $values, '') .
269 addressbook_inp_field(_("Last name"), 'lastname', $name, 45, $values, '') .
270 addressbook_inp_field(_("Additional info"), 'label', $name, 45, $values, '') .
271 list_writable_backends($name) .
272 html_tag( 'tr',
273 html_tag( 'td',
274 addSubmit($submittext, $name.'[SUBMIT]') ,
275 'center', $color[4], 'colspan="2"')
276 )
277 , 'center', '', 'border="0" cellpadding="1" width="90%"') ."\n";
278 }
279 }
280
281 /**
282 * Provides list of writeable backends.
283 * Works only when address is added ($name='addaddr')
284 * @param string $name name of form
285 * @return string html formated backend field (select or hidden)
286 */
287 function list_writable_backends($name) {
288 global $color, $abook;
289 if ( $name != 'addaddr' ) { return; }
290 $writeable_abook = 1;
291 if ( $abook->numbackends > 1 ) {
292 $backends = $abook->get_backend_list();
293 $writeable_abooks=array();
294 while (list($undef,$v) = each($backends)) {
295 if ($v->writeable) {
296 // add each backend to array
297 $writeable_abooks[$v->bnum]=$v->sname;
298 // save backend number
299 $writeable_abook=$v->bnum;
300 }
301 }
302 if (count($writeable_abooks)>1) {
303 // we have more than one writeable backend
304 $ret=addSelect('backend',$writeable_abooks,null,true);
305 return html_tag( 'tr',
306 html_tag( 'td', _("Add to:"),'right', $color[4] ) .
307 html_tag( 'td', $ret, 'left', $color[4] )) . "\n";
308 }
309 }
310 // Only one backend exists or is writeable.
311 return html_tag( 'tr',
312 html_tag( 'td',
313 addHidden('backend', $writeable_abook),
314 'center', $color[4], 'colspan="2"')) . "\n";
315 }
316
317 /**
318 * Sort array by the key "name"
319 */
320 function alistcmp($a,$b) {
321 $abook_sort_order=get_abook_sort();
322
323 switch ($abook_sort_order) {
324 case 0:
325 case 1:
326 $abook_sort='nickname';
327 break;
328 case 4:
329 case 5:
330 $abook_sort='email';
331 break;
332 case 6:
333 case 7:
334 $abook_sort='label';
335 break;
336 case 2:
337 case 3:
338 case 8:
339 default:
340 $abook_sort='name';
341 }
342
343 if ($a['backend'] > $b['backend']) {
344 return 1;
345 } else {
346 if ($a['backend'] < $b['backend']) {
347 return -1;
348 }
349 }
350
351 if( (($abook_sort_order+2) % 2) == 1) {
352 return (strtolower($a[$abook_sort]) < strtolower($b[$abook_sort])) ? 1 : -1;
353 } else {
354 return (strtolower($a[$abook_sort]) > strtolower($b[$abook_sort])) ? 1 : -1;
355 }
356 }
357
358 /**
359 * Address book sorting options
360 *
361 * returns address book sorting order
362 * @return integer book sorting options order
363 */
364 function get_abook_sort() {
365 global $data_dir, $username;
366
367 /* get sorting order */
368 if(sqgetGlobalVar('abook_sort_order', $temp, SQ_GET)) {
369 $abook_sort_order = (int) $temp;
370
371 if ($abook_sort_order < 0 or $abook_sort_order > 8)
372 $abook_sort_order=8;
373
374 setPref($data_dir, $username, 'abook_sort_order', $abook_sort_order);
375 } else {
376 /* get previous sorting options. default to unsorted */
377 $abook_sort_order = getPref($data_dir, $username, 'abook_sort_order', 8);
378 }
379
380 return $abook_sort_order;
381 }
382
383 /**
384 * This function shows the address book sort button.
385 *
386 * @param integer $abook_sort_order current sort value
387 * @param string $alt_tag alt tag value (string visible to text only browsers)
388 * @param integer $Down sort value when list is sorted ascending
389 * @param integer $Up sort value when list is sorted descending
390 * @return string html code with sorting images and urls
391 */
392 function show_abook_sort_button($abook_sort_order, $alt_tag, $Down, $Up ) {
393 global $form_url, $icon_theme_path;
394
395 /* Figure out which image we want to use. */
396 if ($abook_sort_order != $Up && $abook_sort_order != $Down) {
397 $img = 'sort_none.png';
398 $text_icon = '&#9723;'; // U+25FB WHITE MEDIUM SQUARE
399 $which = $Up;
400 } elseif ($abook_sort_order == $Up) {
401 $img = 'up_pointer.png';
402 $text_icon = '&#8679;'; // U+21E7 UPWARDS WHITE ARROW
403 $which = $Down;
404 } else {
405 $img = 'down_pointer.png';
406 $text_icon = '&#8681;'; // U+21E9 DOWNWARDS WHITE ARROW
407 $which = 8;
408 }
409
410 /* Now that we have everything figured out, show the actual button. */
411 return '&nbsp;<a href="' . $form_url .'?abook_sort_order=' . $which .
412 '" style="text-decoration:none" title="'.$alt_tag.'">' .
413 getIcon($icon_theme_path, $img, $text_icon, $alt_tag) .
414 '</a>';
415 }
416
417
418 /**
419 * This is the main address book class that connect all the
420 * backends and provide services to the functions above.
421 * @package squirrelmail
422 * @subpackage addressbook
423 */
424 class AddressBook {
425 /**
426 * Enabled address book backends
427 * @var array
428 */
429 var $backends = array();
430 /**
431 * Number of enabled backends
432 * @var integer
433 */
434 var $numbackends = 0;
435 /**
436 * Error messages
437 * @var string
438 */
439 var $error = '';
440 /**
441 * id of backend with personal address book
442 * @var integer
443 */
444 var $localbackend = 0;
445 /**
446 * Name of backend with personal address book
447 * @var string
448 */
449 var $localbackendname = '';
450 /**
451 * Controls use of 'extra' field
452 *
453 * Extra field can be used to add link to form, which allows
454 * to modify all fields supported by backend. This is the only field
455 * that is not sanitized with htmlspecialchars. Backends MUST make
456 * sure that field data is sanitized and displayed correctly inside
457 * table cell. Use of html formating in other address book fields is
458 * not allowed. Backends that don't return 'extra' row in address book
459 * data should not modify this object property.
460 * @var boolean
461 * @since 1.5.1
462 */
463 var $add_extra_field = false;
464
465 /**
466 * Constructor function.
467 */
468 function AddressBook() {
469 $this->localbackendname = _("Personal address book");
470 }
471
472 /**
473 * Return an array of backends of a given type,
474 * or all backends if no type is specified.
475 * @param string $type backend type
476 * @return array list of backends
477 */
478 function get_backend_list($type = '') {
479 $ret = array();
480 for ($i = 1 ; $i <= $this->numbackends ; $i++) {
481 if (empty($type) || $type == $this->backends[$i]->btype) {
482 $ret[] = &$this->backends[$i];
483 }
484 }
485 return $ret;
486 }
487
488
489 /* ========================== Public ======================== */
490
491 /**
492 * Add a new backend.
493 *
494 * @param string $backend backend name (without the abook_ prefix)
495 * @param mixed optional variable that is passed to the backend constructor.
496 * See each of the backend classes for valid parameters
497 * @return integer number of backends
498 */
499 function add_backend($backend, $param = '') {
500 static $backend_classes;
501 if (!isset($backend_classes)) {
502 $backend_classes = array();
503 }
504 if (!isset($backend_classes[$backend])) {
505 /**
506 * Support backend provided by plugins. Plugin function must
507 * return an associative array with as key the backend name ($backend)
508 * and as value the file including the path containing the backend class.
509 * i.e.: $aBackend = array('backend_template' => SM_PATH . 'plugins/abook_backend_template/functions.php')
510 *
511 * NB: Because the backend files are included from within this function they DO NOT have access to
512 * vars in the global scope. This function is the global scope for the included backend !!!
513 */
514 $aBackend = do_hook('abook_add_class');
515 if (isset($aBackend) && is_array($aBackend) && isset($aBackend[$backend])) {
516 require_once($aBackend[$backend]);
517 } else {
518 require_once(SM_PATH . 'functions/abook_'.$backend.'.php');
519 }
520 $backend_classes[$backend] = true;
521 }
522 $backend_name = 'abook_' . $backend;
523 $newback = new $backend_name($param);
524 //eval('$newback = new ' . $backend_name . '($param);');
525 if(!empty($newback->error)) {
526 $this->error = $newback->error;
527 return false;
528 }
529
530 $this->numbackends++;
531
532 $newback->bnum = $this->numbackends;
533 $this->backends[$this->numbackends] = $newback;
534
535 /* Store ID of first local backend added */
536 if ($this->localbackend == 0 && $newback->btype == 'local') {
537 $this->localbackend = $this->numbackends;
538 $this->localbackendname = $newback->sname;
539 }
540
541 return $this->numbackends;
542 }
543
544
545 /**
546 * create string with name and email address
547 *
548 * This function takes a $row array as returned by the addressbook
549 * search and returns an e-mail address with the full name or
550 * nickname optionally prepended.
551 * @param array $row address book entry
552 * @return string email address with real name prepended
553 */
554 function full_address($row) {
555 global $addrsrch_fullname, $data_dir, $username;
556 $prefix = getPref($data_dir, $username, 'addrsrch_fullname');
557 if (($prefix != "" || (isset($addrsrch_fullname) &&
558 $prefix == $addrsrch_fullname)) && $prefix != 'noprefix') {
559 $name = ($prefix == 'nickname' ? $row['nickname'] : $row['name']);
560 return $name . ' <' . trim($row['email']) . '>';
561 } else {
562 return trim($row['email']);
563 }
564 }
565
566 /**
567 * Search for entries in address books
568 *
569 * Return a list of addresses matching expression in
570 * all backends of a given type.
571 * @param string $expression search expression
572 * @param integer $bnum backend number. default to search in all backends
573 * @return array search results
574 */
575 function search($expression, $bnum = -1) {
576 $ret = array();
577 $this->error = '';
578
579 /* Search all backends */
580 if ($bnum == -1) {
581 $sel = $this->get_backend_list('');
582 $failed = 0;
583 for ($i = 0 ; $i < sizeof($sel) ; $i++) {
584 $backend = &$sel[$i];
585 $backend->error = '';
586 $res = $backend->search($expression);
587 if (is_array($res)) {
588 $ret = array_merge($ret, $res);
589 } else {
590 $this->error .= "\n" . $backend->error;
591 $failed++;
592 }
593 }
594
595 /* Only fail if all backends failed */
596 if( $failed >= sizeof( $sel ) ) {
597 $ret = FALSE;
598 }
599
600 } else {
601
602 /* Search only one backend */
603
604 $ret = $this->backends[$bnum]->search($expression);
605 if (!is_array($ret)) {
606 $this->error .= "\n" . $this->backends[$bnum]->error;
607 $ret = FALSE;
608 }
609 }
610
611 return( $ret );
612 }
613
614
615 /**
616 * Sorted search
617 * @param string $expression search expression
618 * @param integer $bnum backend number. default to search in all backends
619 * @return array search results
620 */
621 function s_search($expression, $bnum = -1) {
622
623 $ret = $this->search($expression, $bnum);
624 if ( is_array( $ret ) ) {
625 usort($ret, 'addressbook_cmp');
626 }
627 return $ret;
628 }
629
630
631 /**
632 * Lookup an address by alias.
633 * Only possible in local backends.
634 * @param string $alias
635 * @param integer backend number
636 * @return array lookup results. False, if not found.
637 */
638 function lookup($alias, $bnum = -1) {
639
640 $ret = array();
641
642 if ($bnum > -1) {
643 $res = $this->backends[$bnum]->lookup($alias);
644 if (is_array($res)) {
645 return $res;
646 } else {
647 $this->error = $this->backends[$bnum]->error;
648 return false;
649 }
650 }
651
652 $sel = $this->get_backend_list('local');
653 for ($i = 0 ; $i < sizeof($sel) ; $i++) {
654 $backend = &$sel[$i];
655 $backend->error = '';
656 $res = $backend->lookup($alias);
657 if (is_array($res)) {
658 if(!empty($res))
659 return $res;
660 } else {
661 $this->error = $backend->error;
662 return false;
663 }
664 }
665
666 return $ret;
667 }
668
669
670 /**
671 * Return all addresses
672 * @param integer $bnum backend number
673 * @return array search results
674 */
675 function list_addr($bnum = -1) {
676 $ret = array();
677
678 if ($bnum == -1) {
679 $sel = $this->get_backend_list('');
680 } else {
681 $sel = array(0 => &$this->backends[$bnum]);
682 }
683
684 for ($i = 0 ; $i < sizeof($sel) ; $i++) {
685 $backend = &$sel[$i];
686 $backend->error = '';
687 $res = $backend->list_addr();
688 if (is_array($res)) {
689 $ret = array_merge($ret, $res);
690 } else {
691 $this->error = $backend->error;
692 return false;
693 }
694 }
695
696 return $ret;
697 }
698
699 /**
700 * Create a new address
701 * @param array $userdata added address record
702 * @param integer $bnum backend number
703 * @return integer the backend number that the/ address was added
704 * to, or false if it failed.
705 */
706 function add($userdata, $bnum) {
707
708 /* Validate data */
709 if (!is_array($userdata)) {
710 $this->error = _("Invalid input data");
711 return false;
712 }
713 if (empty($userdata['firstname']) && empty($userdata['lastname'])) {
714 $this->error = _("Name is missing");
715 return false;
716 }
717 if (empty($userdata['email'])) {
718 $this->error = _("E-mail address is missing");
719 return false;
720 }
721 if (empty($userdata['nickname'])) {
722 $userdata['nickname'] = $userdata['email'];
723 }
724
725 /* Blocks use of space, :, |, #, " and ! in nickname */
726 if (eregi('[ \\:\\|\\#\\"\\!]', $userdata['nickname'])) {
727 $this->error = _("Nickname contains illegal characters");
728 return false;
729 }
730
731 /* Check that specified backend accept new entries */
732 if (!$this->backends[$bnum]->writeable) {
733 $this->error = _("Address book is read-only");
734 return false;
735 }
736
737 /* Add address to backend */
738 $res = $this->backends[$bnum]->add($userdata);
739 if ($res) {
740 return $bnum;
741 } else {
742 $this->error = $this->backends[$bnum]->error;
743 return false;
744 }
745
746 return false; // Not reached
747 } /* end of add() */
748
749
750 /**
751 * Remove the entries from address book
752 * @param mixed $alias entries that have to be removed. Can be string with nickname or array with list of nicknames
753 * @param integer $bnum backend number
754 * @return bool true if removed successfully. false if there s an error. $this->error contains error message
755 */
756 function remove($alias, $bnum) {
757
758 /* Check input */
759 if (empty($alias)) {
760 return true;
761 }
762
763 /* Convert string to single element array */
764 if (!is_array($alias)) {
765 $alias = array(0 => $alias);
766 }
767
768 /* Check that specified backend is writable */
769 if (!$this->backends[$bnum]->writeable) {
770 $this->error = _("Address book is read-only");
771 return false;
772 }
773
774 /* Remove user from backend */
775 $res = $this->backends[$bnum]->remove($alias);
776 if ($res) {
777 return $bnum;
778 } else {
779 $this->error = $this->backends[$bnum]->error;
780 return false;
781 }
782
783 return FALSE; /* Not reached */
784 } /* end of remove() */
785
786
787 /**
788 * Modify entry in address book
789 * @param string $alias nickname
790 * @param array $userdata newdata
791 * @param integer $bnum backend number
792 */
793 function modify($alias, $userdata, $bnum) {
794
795 /* Check input */
796 if (empty($alias) || !is_string($alias)) {
797 return true;
798 }
799
800 /* Validate data */
801 if(!is_array($userdata)) {
802 $this->error = _("Invalid input data");
803 return false;
804 }
805 if (empty($userdata['firstname']) && empty($userdata['lastname'])) {
806 $this->error = _("Name is missing");
807 return false;
808 }
809 if (empty($userdata['email'])) {
810 $this->error = _("E-mail address is missing");
811 return false;
812 }
813
814 if (eregi('[\\: \\|\\#"\\!]', $userdata['nickname'])) {
815 $this->error = _("Nickname contains illegal characters");
816 return false;
817 }
818
819 if (empty($userdata['nickname'])) {
820 $userdata['nickname'] = $userdata['email'];
821 }
822
823 /* Check that specified backend is writable */
824 if (!$this->backends[$bnum]->writeable) {
825 $this->error = _("Address book is read-only");;
826 return false;
827 }
828
829 /* Modify user in backend */
830 $res = $this->backends[$bnum]->modify($alias, $userdata);
831 if ($res) {
832 return $bnum;
833 } else {
834 $this->error = $this->backends[$bnum]->error;
835 return false;
836 }
837
838 return FALSE; /* Not reached */
839 } /* end of modify() */
840
841
842 } /* End of class Addressbook */
843
844 /**
845 * Generic backend that all other backends extend
846 * @package squirrelmail
847 * @subpackage addressbook
848 */
849 class addressbook_backend {
850
851 /* Variables that all backends must provide. */
852 /**
853 * Backend type
854 *
855 * Can be 'local' or 'remote'
856 * @var string backend type
857 */
858 var $btype = 'dummy';
859 /**
860 * Internal backend name
861 * @var string
862 */
863 var $bname = 'dummy';
864 /**
865 * Displayed backend name
866 * @var string
867 */
868 var $sname = 'Dummy backend';
869
870 /*
871 * Variables common for all backends, but that
872 * should not be changed by the backends.
873 */
874 /**
875 * Backend number
876 * @var integer
877 */
878 var $bnum = -1;
879 /**
880 * Error messages
881 * @var string
882 */
883 var $error = '';
884 /**
885 * Writeable flag
886 * @var bool
887 */
888 var $writeable = false;
889
890 /**
891 * Set error message
892 * @param string $string error message
893 * @return bool
894 */
895 function set_error($string) {
896 $this->error = '[' . $this->sname . '] ' . $string;
897 return false;
898 }
899
900
901 /* ========================== Public ======================== */
902
903 /**
904 * Search for entries in backend
905 *
906 * Working backend should support use of wildcards. * symbol
907 * should match one or more symbols. ? symbol should match any
908 * single symbol.
909 * @param string $expression
910 * @return bool
911 */
912 function search($expression) {
913 $this->set_error('search is not implemented');
914 return false;
915 }
916
917 /**
918 * Find entry in backend by alias
919 * @param string $alias name used for id
920 * @return bool
921 */
922 function lookup($alias) {
923 $this->set_error('lookup is not implemented');
924 return false;
925 }
926
927 /**
928 * List all entries in backend
929 *
930 * Working backend should provide this function or at least
931 * dummy function that returns empty array.
932 * @return bool
933 */
934 function list_addr() {
935 $this->set_error('list_addr is not implemented');
936 return false;
937 }
938
939 /**
940 * Add entry to backend
941 * @param array userdata
942 * @return bool
943 */
944 function add($userdata) {
945 $this->set_error('add is not implemented');
946 return false;
947 }
948
949 /**
950 * Remove entry from backend
951 * @param string $alias name used for id
952 * @return bool
953 */
954 function remove($alias) {
955 $this->set_error('delete is not implemented');
956 return false;
957 }
958
959 /**
960 * Modify entry in backend
961 * @param string $alias name used for id
962 * @param array $newuserdata new data
963 * @return bool
964 */
965 function modify($alias, $newuserdata) {
966 $this->set_error('modify is not implemented');
967 return false;
968 }
969
970 /**
971 * Creates full name from given name and surname
972 *
973 * Handles name order differences
974 * @param string $firstname given name
975 * @param string $lastname surname
976 * @return string full name
977 * @since 1.5.2
978 */
979 function fullname($firstname,$lastname) {
980 global $squirrelmail_language;
981 if ($squirrelmail_language=='ja_JP') {
982 return trim($lastname . ' ' . $firstname);
983 } else {
984 return trim($firstname . ' ' . $lastname);
985 }
986 }
987 }