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 for="'.$name.'_'.$field.'_'.'">' .
 237                 $label . '</label>:', 'right', $color[4]) .
 238             html_tag( 'td', $td_str, 'left', $color[4])
 239             )
 240         . "\n";
 241 }
 242
 243 /**
 244  * Output form to add and modify address data
 245  */
 246 function address_form($name, $submittext, $values = array()) {
 247     global $color, $squirrelmail_language;
 248
 249     if ($squirrelmail_language == 'ja_JP') {
 250         echo html_tag( 'table',
 251                 addressbook_inp_field(_("Nickname"),     'nickname', $name, 15, $values,
 252                     ' <small>' . _("Must be unique") . '</small>') .
 253                 addressbook_inp_field(_("E-mail address"),  'email', $name, 45, $values, '') .
 254                 addressbook_inp_field(_("Last name"),    'lastname', $name, 45, $values, '') .
 255                 addressbook_inp_field(_("First name"),  'firstname', $name, 45, $values, '') .
 256                 addressbook_inp_field(_("Additional info"), 'label', $name, 45, $values, '') .
 257                 list_writable_backends($name) .
 258                 html_tag( 'tr',
 259                     html_tag( 'td',
 260                         addSubmit($submittext, $name.'[SUBMIT]'),
 261                         'center', $color[4], 'colspan="2"')
 262                     )
 263                 , 'center', '', 'border="0" cellpadding="1" width="90%"') ."\n";
 264     } else {
 265         echo html_tag( 'table',
 266                 addressbook_inp_field(_("Nickname"),     'nickname', $name, 15, $values,
 267                     ' <small>' . _("Must be unique") . '</small>') .
 268                 addressbook_inp_field(_("E-mail address"),  'email', $name, 45, $values, '') .
 269                 addressbook_inp_field(_("First name"),  'firstname', $name, 45, $values, '') .
 270                 addressbook_inp_field(_("Last name"),    'lastname', $name, 45, $values, '') .
 271                 addressbook_inp_field(_("Additional info"), 'label', $name, 45, $values, '') .
 272                 list_writable_backends($name) .
 273                 html_tag( 'tr',
 274                     html_tag( 'td',
 275                         addSubmit($submittext, $name.'[SUBMIT]') ,
 276                         'center', $color[4], 'colspan="2"')
 277                     )
 278                 , 'center', '', 'border="0" cellpadding="1" width="90%"') ."\n";
 279     }
 280 }
 281
 282 /**
 283  * Provides list of writeable backends.
 284  * Works only when address is added ($name='addaddr')
 285  * @param string $name name of form
 286  * @return string html formated backend field (select or hidden)
 287  */
 288 function list_writable_backends($name) {
 289     global $color, $abook;
 290     if ( $name != 'addaddr' ) { return; }
 291     $writeable_abook = 1;
 292     if ( $abook->numbackends > 1 ) {
 293         $backends = $abook->get_backend_list();
 294         $writeable_abooks=array();
 295         while (list($undef,$v) = each($backends)) {
 296             if ($v->writeable) {
 297                 // add each backend to array
 298                 $writeable_abooks[$v->bnum]=$v->sname;
 299                 // save backend number
 300                 $writeable_abook=$v->bnum;
 301             }
 302         }
 303         if (count($writeable_abooks)>1) {
 304             // we have more than one writeable backend
 305             $ret=addSelect('backend',$writeable_abooks,null,true);
 306             return html_tag( 'tr',
 307                              html_tag( 'td', _("Add to:"),'right', $color[4] ) .
 308                              html_tag( 'td', $ret, 'left', $color[4] )) . "\n";
 309         }
 310     }
 311     // Only one backend exists or is writeable.
 312     return html_tag( 'tr',
 313                      html_tag( 'td',
 314                                addHidden('backend', $writeable_abook),
 315                                'center', $color[4], 'colspan="2"')) . "\n";
 316 }
 317
 318 /**
 319  * Sort array by the key "name"
 320  */
 321 function alistcmp($a,$b) {
 322     $abook_sort_order=get_abook_sort();
 323
 324     switch ($abook_sort_order) {
 325     case 0:
 326     case 1:
 327       $abook_sort='nickname';
 328       break;
 329     case 4:
 330     case 5:
 331       $abook_sort='email';
 332       break;
 333     case 6:
 334     case 7:
 335       $abook_sort='label';
 336       break;
 337     case 2:
 338     case 3:
 339     case 8:
 340     default:
 341       $abook_sort='name';
 342     }
 343
 344     if ($a['backend'] > $b['backend']) {
 345         return 1;
 346     } else {
 347         if ($a['backend'] < $b['backend']) {
 348             return -1;
 349         }
 350     }
 351
 352     if( (($abook_sort_order+2) % 2) == 1) {
 353       return (strtolower($a[$abook_sort]) < strtolower($b[$abook_sort])) ? 1 : -1;
 354     } else {
 355       return (strtolower($a[$abook_sort]) > strtolower($b[$abook_sort])) ? 1 : -1;
 356     }
 357 }
 358
 359 /**
 360  * Address book sorting options
 361  *
 362  * returns address book sorting order
 363  * @return integer book sorting options order
 364  */
 365 function get_abook_sort() {
 366     global $data_dir, $username;
 367
 368     /* get sorting order */
 369     if(sqgetGlobalVar('abook_sort_order', $temp, SQ_GET)) {
 370       $abook_sort_order = (int) $temp;
 371
 372       if ($abook_sort_order < 0 or $abook_sort_order > 8)
 373         $abook_sort_order=8;
 374
 375       setPref($data_dir, $username, 'abook_sort_order', $abook_sort_order);
 376     } else {
 377       /* get previous sorting options. default to unsorted */
 378       $abook_sort_order = getPref($data_dir, $username, 'abook_sort_order', 8);
 379     }
 380
 381     return $abook_sort_order;
 382 }
 383
 384 /**
 385  * This function shows the address book sort button.
 386  *
 387  * @param integer $abook_sort_order current sort value
 388  * @param string $alt_tag alt tag value (string visible to text only browsers)
 389  * @param integer $Down sort value when list is sorted ascending
 390  * @param integer $Up sort value when list is sorted descending
 391  * @return string html code with sorting images and urls
 392  */
 393 function show_abook_sort_button($abook_sort_order, $alt_tag, $Down, $Up ) {
 394     global $form_url, $icon_theme_path;
 395
 396      /* Figure out which image we want to use. */
 397     if ($abook_sort_order != $Up && $abook_sort_order != $Down) {
 398         $img = 'sort_none.png';
 399         $text_icon = '&#9723;'; // U+25FB WHITE MEDIUM SQUARE
 400         $which = $Up;
 401     } elseif ($abook_sort_order == $Up) {
 402         $img = 'up_pointer.png';
 403         $text_icon = '&#8679;'; // U+21E7 UPWARDS WHITE ARROW
 404         $which = $Down;
 405     } else {
 406         $img = 'down_pointer.png';
 407         $text_icon = '&#8681;'; // U+21E9 DOWNWARDS WHITE ARROW
 408         $which = 8;
 409     }
 410
 411     /* Now that we have everything figured out, show the actual button. */
 412     return '&nbsp;<a href="' . $form_url .'?abook_sort_order=' . $which .
 413            '" style="text-decoration:none" title="'.$alt_tag.'">' .
 414            getIcon($icon_theme_path, $img, $text_icon, $alt_tag) .
 415            '</a>';
 416 }
 417
 418
 419 /**
 420  * This is the main address book class that connect all the
 421  * backends and provide services to the functions above.
 422  * @package squirrelmail
 423  * @subpackage addressbook
 424  */
 425 class AddressBook {
 426     /**
 427      * Enabled address book backends
 428      * @var array
 429      */
 430     var $backends    = array();
 431     /**
 432      * Number of enabled backends
 433      * @var integer
 434      */
 435     var $numbackends = 0;
 436     /**
 437      * Error messages
 438      * @var string
 439      */
 440     var $error       = '';
 441     /**
 442      * id of backend with personal address book
 443      * @var integer
 444      */
 445     var $localbackend = 0;
 446     /**
 447      * Name of backend with personal address book
 448      * @var string
 449      */
 450     var $localbackendname = '';
 451     /**
 452      * Controls use of 'extra' field
 453      *
 454      * Extra field can be used to add link to form, which allows
 455      * to modify all fields supported by backend. This is the only field
 456      * that is not sanitized with htmlspecialchars. Backends MUST make
 457      * sure that field data is sanitized and displayed correctly inside
 458      * table cell. Use of html formating in other address book fields is
 459      * not allowed. Backends that don't return 'extra' row in address book
 460      * data should not modify this object property.
 461      * @var boolean
 462      * @since 1.5.1
 463      */
 464     var $add_extra_field = false;
 465
 466     /**
 467      * Constructor function.
 468      */
 469     function AddressBook() {
 470         $this->localbackendname = _("Personal address book");
 471     }
 472
 473     /**
 474      * Return an array of backends of a given type,
 475      * or all backends if no type is specified.
 476      * @param string $type backend type
 477      * @return array list of backends
 478      */
 479     function get_backend_list($type = '') {
 480         $ret = array();
 481         for ($i = 1 ; $i <= $this->numbackends ; $i++) {
 482             if (empty($type) || $type == $this->backends[$i]->btype) {
 483                 $ret[] = &$this->backends[$i];
 484             }
 485         }
 486         return $ret;
 487     }
 488
 489
 490     /* ========================== Public ======================== */
 491
 492     /**
 493      * Add a new backend.
 494      *
 495      * @param string $backend backend name (without the abook_ prefix)
 496      * @param mixed optional variable that is passed to the backend constructor.
 497      * See each of the backend classes for valid parameters
 498      * @return integer number of backends
 499      */
 500     function add_backend($backend, $param = '') {
 501         static $backend_classes;
 502         if (!isset($backend_classes)) {
 503             $backend_classes = array();
 504         }
 505         if (!isset($backend_classes[$backend])) {
 506             /**
 507               * Support backend provided by plugins. Plugin function must
 508               * return an associative array with as key the backend name ($backend)
 509               * and as value the file including the path containing the backend class.
 510               * i.e.: $aBackend = array('backend_template' => SM_PATH . 'plugins/abook_backend_template/functions.php')
 511               *
 512               * NB: Because the backend files are included from within this function they DO NOT have access to
 513               * vars in the global scope. This function is the global scope for the included backend !!!
 514               */
 515             $aBackend = do_hook('abook_add_class');
 516             if (isset($aBackend) && is_array($aBackend) && isset($aBackend[$backend])) {
 517                 require_once($aBackend[$backend]);
 518             } else {
 519                 require_once(SM_PATH . 'functions/abook_'.$backend.'.php');
 520             }
 521             $backend_classes[$backend] = true;
 522         }
 523         $backend_name = 'abook_' . $backend;
 524         $newback = new $backend_name($param);
 525         //eval('$newback = new ' . $backend_name . '($param);');
 526         if(!empty($newback->error)) {
 527             $this->error = $newback->error;
 528             return false;
 529         }
 530
 531         $this->numbackends++;
 532
 533         $newback->bnum = $this->numbackends;
 534         $this->backends[$this->numbackends] = $newback;
 535
 536         /* Store ID of first local backend added */
 537         if ($this->localbackend == 0 && $newback->btype == 'local') {
 538             $this->localbackend = $this->numbackends;
 539             $this->localbackendname = $newback->sname;
 540         }
 541
 542         return $this->numbackends;
 543     }
 544
 545
 546     /**
 547      * create string with name and email address
 548      *
 549      * This function takes a $row array as returned by the addressbook
 550      * search and returns an e-mail address with the full name or
 551      * nickname optionally prepended.
 552      * @param array $row address book entry
 553      * @return string email address with real name prepended
 554      */
 555     function full_address($row) {
 556         global $addrsrch_fullname, $data_dir, $username;
 557         $prefix = getPref($data_dir, $username, 'addrsrch_fullname');
 558         if (($prefix != "" || (isset($addrsrch_fullname) &&
 559             $prefix == $addrsrch_fullname)) && $prefix != 'noprefix') {
 560             $name = ($prefix == 'nickname' ? $row['nickname'] : $row['name']);
 561             return $name . ' <' . trim($row['email']) . '>';
 562         } else {
 563             return trim($row['email']);
 564         }
 565     }
 566
 567     /**
 568      * Search for entries in address books
 569      *
 570      * Return a list of addresses matching expression in
 571      * all backends of a given type.
 572      * @param string $expression search expression
 573      * @param integer $bnum backend number. default to search in all backends
 574      * @return array search results
 575      */
 576     function search($expression, $bnum = -1) {
 577         $ret = array();
 578         $this->error = '';
 579
 580         /* Search all backends */
 581         if ($bnum == -1) {
 582             $sel = $this->get_backend_list('');
 583             $failed = 0;
 584             for ($i = 0 ; $i < sizeof($sel) ; $i++) {
 585                 $backend = &$sel[$i];
 586                 $backend->error = '';
 587                 $res = $backend->search($expression);
 588                 if (is_array($res)) {
 589                     $ret = array_merge($ret, $res);
 590                 } else {
 591                     $this->error .= "\n" . $backend->error;
 592                     $failed++;
 593                 }
 594             }
 595
 596             /* Only fail if all backends failed */
 597             if( $failed >= sizeof( $sel ) ) {
 598                 $ret = FALSE;
 599             }
 600
 601         } elseif (! isset($this->backends[$bnum])) {
 602             /* make sure that backend exists */
 603             $this->error = _("Unknown address book backend");
 604             $ret = false;
 605         } else {
 606
 607             /* Search only one backend */
 608
 609             $ret = $this->backends[$bnum]->search($expression);
 610             if (!is_array($ret)) {
 611                 $this->error .= "\n" . $this->backends[$bnum]->error;
 612                 $ret = FALSE;
 613             }
 614         }
 615
 616         return( $ret );
 617     }
 618
 619
 620     /**
 621      * Sorted search
 622      * @param string $expression search expression
 623      * @param integer $bnum backend number. default to search in all backends
 624      * @return array search results
 625      */
 626     function s_search($expression, $bnum = -1) {
 627
 628         $ret = $this->search($expression, $bnum);
 629         if ( is_array( $ret ) ) {
 630             usort($ret, 'addressbook_cmp');
 631         }
 632         return $ret;
 633     }
 634
 635
 636     /**
 637      * Lookup an address by alias.
 638      * Only possible in local backends.
 639      * @param string $alias
 640      * @param integer backend number
 641      * @return array lookup results. False, if not found.
 642      */
 643     function lookup($alias, $bnum = -1) {
 644
 645         $ret = array();
 646
 647         if ($bnum > -1) {
 648             if (!isset($this->backends[$bnum])) {
 649                 $this->error = _("Unknown address book backend");
 650                 return false;
 651             }
 652             $res = $this->backends[$bnum]->lookup($alias);
 653             if (is_array($res)) {
 654                return $res;
 655             } else {
 656                $this->error = $this->backends[$bnum]->error;
 657                return false;
 658             }
 659         }
 660
 661         $sel = $this->get_backend_list('local');
 662         for ($i = 0 ; $i < sizeof($sel) ; $i++) {
 663             $backend = &$sel[$i];
 664             $backend->error = '';
 665             $res = $backend->lookup($alias);
 666             if (is_array($res)) {
 667                if(!empty($res))
 668               return $res;
 669             } else {
 670                $this->error = $backend->error;
 671                return false;
 672             }
 673         }
 674
 675         return $ret;
 676     }
 677
 678
 679     /**
 680      * Return all addresses
 681      * @param integer $bnum backend number
 682      * @return array search results
 683      */
 684     function list_addr($bnum = -1) {
 685         $ret = array();
 686
 687         if ($bnum == -1) {
 688             $sel = $this->get_backend_list('');
 689         } elseif (! isset($this->backends[$bnum])) {
 690             /* make sure that backend exists */
 691             $this->error = _("Unknown address book backend");
 692             $ret = false;
 693         } else {
 694             $sel = array(0 => &$this->backends[$bnum]);
 695         }
 696
 697         for ($i = 0 ; $i < sizeof($sel) ; $i++) {
 698             $backend = &$sel[$i];
 699             $backend->error = '';
 700             $res = $backend->list_addr();
 701             if (is_array($res)) {
 702                $ret = array_merge($ret, $res);
 703             } else {
 704                $this->error = $backend->error;
 705                return false;
 706             }
 707         }
 708
 709         return $ret;
 710     }
 711
 712     /**
 713      * Create a new address
 714      * @param array $userdata added address record
 715      * @param integer $bnum backend number
 716      * @return integer the backend number that the/ address was added
 717      * to, or false if it failed.
 718      */
 719     function add($userdata, $bnum) {
 720
 721         /* Validate data */
 722         if (!is_array($userdata)) {
 723             $this->error = _("Invalid input data");
 724             return false;
 725         }
 726         if (empty($userdata['firstname']) && empty($userdata['lastname'])) {
 727             $this->error = _("Name is missing");
 728             return false;
 729         }
 730         if (empty($userdata['email'])) {
 731             $this->error = _("E-mail address is missing");
 732             return false;
 733         }
 734         if (empty($userdata['nickname'])) {
 735             $userdata['nickname'] = $userdata['email'];
 736         }
 737
 738         /* Blocks use of space, :, |, #, " and ! in nickname */
 739         if (eregi('[ \\:\\|\\#\\"\\!]', $userdata['nickname'])) {
 740             $this->error = _("Nickname contains illegal characters");
 741             return false;
 742         }
 743
 744         /* make sure that backend exists */
 745         if (! isset($this->backends[$bnum])) {
 746             $this->error = _("Unknown address book backend");
 747             return false;
 748         }
 749
 750         /* Check that specified backend accept new entries */
 751         if (!$this->backends[$bnum]->writeable) {
 752             $this->error = _("Address book is read-only");
 753             return false;
 754         }
 755
 756         /* Add address to backend */
 757         $res = $this->backends[$bnum]->add($userdata);
 758         if ($res) {
 759             return $bnum;
 760         } else {
 761             $this->error = $this->backends[$bnum]->error;
 762             return false;
 763         }
 764
 765         return false;  // Not reached
 766     } /* end of add() */
 767
 768
 769     /**
 770      * Remove the entries from address book
 771      * @param mixed $alias entries that have to be removed. Can be string with nickname or array with list of nicknames
 772      * @param integer $bnum backend number
 773      * @return bool true if removed successfully. false if there s an error. $this->error contains error message
 774      */
 775     function remove($alias, $bnum) {
 776
 777         /* Check input */
 778         if (empty($alias)) {
 779             return true;
 780         }
 781
 782         /* Convert string to single element array */
 783         if (!is_array($alias)) {
 784             $alias = array(0 => $alias);
 785         }
 786
 787         /* make sure that backend exists */
 788         if (! isset($this->backends[$bnum])) {
 789             $this->error = _("Unknown address book backend");
 790             return false;
 791         }
 792
 793         /* Check that specified backend is writable */
 794         if (!$this->backends[$bnum]->writeable) {
 795             $this->error = _("Address book is read-only");
 796             return false;
 797         }
 798
 799         /* Remove user from backend */
 800         $res = $this->backends[$bnum]->remove($alias);
 801         if ($res) {
 802             return $bnum;
 803         } else {
 804             $this->error = $this->backends[$bnum]->error;
 805             return false;
 806         }
 807
 808         return FALSE;  /* Not reached */
 809     } /* end of remove() */
 810
 811
 812     /**
 813      * Modify entry in address book
 814      * @param string $alias nickname
 815      * @param array $userdata newdata
 816      * @param integer $bnum backend number
 817      */
 818     function modify($alias, $userdata, $bnum) {
 819
 820         /* Check input */
 821         if (empty($alias) || !is_string($alias)) {
 822             return true;
 823         }
 824
 825         /* Validate data */
 826         if(!is_array($userdata)) {
 827             $this->error = _("Invalid input data");
 828             return false;
 829         }
 830         if (empty($userdata['firstname']) && empty($userdata['lastname'])) {
 831             $this->error = _("Name is missing");
 832             return false;
 833         }
 834         if (empty($userdata['email'])) {
 835             $this->error = _("E-mail address is missing");
 836             return false;
 837         }
 838
 839         if (eregi('[\\: \\|\\#"\\!]', $userdata['nickname'])) {
 840             $this->error = _("Nickname contains illegal characters");
 841             return false;
 842         }
 843
 844         if (empty($userdata['nickname'])) {
 845             $userdata['nickname'] = $userdata['email'];
 846         }
 847
 848         /* make sure that backend exists */
 849         if (! isset($this->backends[$bnum])) {
 850             $this->error = _("Unknown address book backend");
 851             return false;
 852         }
 853
 854         /* Check that specified backend is writable */
 855         if (!$this->backends[$bnum]->writeable) {
 856             $this->error = _("Address book is read-only");;
 857             return false;
 858         }
 859
 860         /* Modify user in backend */
 861         $res = $this->backends[$bnum]->modify($alias, $userdata);
 862         if ($res) {
 863             return $bnum;
 864         } else {
 865             $this->error = $this->backends[$bnum]->error;
 866             return false;
 867         }
 868
 869         return FALSE;  /* Not reached */
 870     } /* end of modify() */
 871
 872
 873 } /* End of class Addressbook */
 874
 875 /**
 876  * Generic backend that all other backends extend
 877  * @package squirrelmail
 878  * @subpackage addressbook
 879  */
 880 class addressbook_backend {
 881
 882     /* Variables that all backends must provide. */
 883     /**
 884      * Backend type
 885      *
 886      * Can be 'local' or 'remote'
 887      * @var string backend type
 888      */
 889     var $btype      = 'dummy';
 890     /**
 891      * Internal backend name
 892      * @var string
 893      */
 894     var $bname      = 'dummy';
 895     /**
 896      * Displayed backend name
 897      * @var string
 898      */
 899     var $sname      = 'Dummy backend';
 900
 901     /*
 902      * Variables common for all backends, but that
 903      * should not be changed by the backends.
 904      */
 905     /**
 906      * Backend number
 907      * @var integer
 908      */
 909     var $bnum       = -1;
 910     /**
 911      * Error messages
 912      * @var string
 913      */
 914     var $error      = '';
 915     /**
 916      * Writeable flag
 917      * @var bool
 918      */
 919     var $writeable  = false;
 920
 921     /**
 922      * Set error message
 923      * @param string $string error message
 924      * @return bool
 925      */
 926     function set_error($string) {
 927         $this->error = '[' . $this->sname . '] ' . $string;
 928         return false;
 929     }
 930
 931
 932     /* ========================== Public ======================== */
 933
 934     /**
 935      * Search for entries in backend
 936      *
 937      * Working backend should support use of wildcards. * symbol
 938      * should match one or more symbols. ? symbol should match any
 939      * single symbol.
 940      * @param string $expression
 941      * @return bool
 942      */
 943     function search($expression) {
 944         $this->set_error('search is not implemented');
 945         return false;
 946     }
 947
 948     /**
 949      * Find entry in backend by alias
 950      * @param string $alias name used for id
 951      * @return bool
 952      */
 953     function lookup($alias) {
 954         $this->set_error('lookup is not implemented');
 955         return false;
 956     }
 957
 958     /**
 959      * List all entries in backend
 960      *
 961      * Working backend should provide this function or at least
 962      * dummy function that returns empty array.
 963      * @return bool
 964      */
 965     function list_addr() {
 966         $this->set_error('list_addr is not implemented');
 967         return false;
 968     }
 969
 970     /**
 971      * Add entry to backend
 972      * @param array userdata
 973      * @return bool
 974      */
 975     function add($userdata) {
 976         $this->set_error('add is not implemented');
 977         return false;
 978     }
 979
 980     /**
 981      * Remove entry from backend
 982      * @param string $alias name used for id
 983      * @return bool
 984      */
 985     function remove($alias) {
 986         $this->set_error('delete is not implemented');
 987         return false;
 988     }
 989
 990     /**
 991      * Modify entry in backend
 992      * @param string $alias name used for id
 993      * @param array $newuserdata new data
 994      * @return bool
 995      */
 996     function modify($alias, $newuserdata) {
 997         $this->set_error('modify is not implemented');
 998         return false;
 999     }
1000
1001     /**
1002      * Creates full name from given name and surname
1003      *
1004      * Handles name order differences
1005      * @param string $firstname given name
1006      * @param string $lastname surname
1007      * @return string full name
1008      * @since 1.5.2
1009      */
1010     function fullname($firstname,$lastname) {
1011         global $squirrelmail_language;
1012         if ($squirrelmail_language=='ja_JP') {
1013             return trim($lastname . ' ' . $firstname);
1014         } else {
1015             return trim($firstname . ' ' . $lastname);
1016         }
1017     }
1018 }