X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=functions%2Faddressbook.php;h=35edb5a514990bb13e8fd66a599178b0f0996119;hb=0db60ced010cea3a14b2b3fc225692e5f2d6a272;hp=269b199417a630682ea9462f30ee73865816d6a2;hpb=75e19c7fe9b21733b1af5f4c5910835da1eea326;p=squirrelmail.git diff --git a/functions/addressbook.php b/functions/addressbook.php index 269b1994..35edb5a5 100644 --- a/functions/addressbook.php +++ b/functions/addressbook.php @@ -1,380 +1,955 @@ add_backend('database', Array('dsn' => $addrbook_dsn, + 'owner' => $username, + 'table' => $addrbook_table)); + if (!$r && $showerr) { + $abook_init_error.=_("Error initializing address book database.") . "\n" . $abook->error; + } + } else { + /* File */ + $filename = getHashedFile($username, $data_dir, "$username.abook"); + $r = $abook->add_backend('local_file', Array('filename' => $filename, + 'line_length' => $abook_file_line_length, + 'create' => true)); + if(!$r && $showerr) { + // no need to use $abook->error, because message explains error. + $abook_init_error.=sprintf( _("Error opening file %s"), $filename ); + } } - $td_str .= '">' . $add . ''; - return html_tag( 'tr' , - html_tag( 'td', $label . ':', 'right', $color[4]) . - html_tag( 'td', $td_str, 'left', $color[4]) - ) - . "\n"; -} -/* Output form to add and modify address data */ -function address_form($name, $submittext, $values = array()) { - global $color; - echo html_tag( 'table', - adressbook_inp_field(_("Nickname"), 'nickname', $name, 15, $values, - '' . _("Must be unique") . '') . - adressbook_inp_field(_("E-mail address"), 'email', $name, 45, $values, '') . - adressbook_inp_field(_("First name"), 'firstname', $name, 45, $values, '') . - adressbook_inp_field(_("Last name"), 'lastname', $name, 45, $values, '') . - adressbook_inp_field(_("Additional info"), 'label', $name, 45, $values, '') . - html_tag( 'tr', - html_tag( 'td', - '', - 'center', $color[4], 'colspan="2"') - ) - , 'center', '', 'border="0" cellpadding="1" cols="2" width="90%"') ."\n"; + /* Global file based addressbook */ + if (isset($abook_global_file) && + isset($abook_global_file_writeable) && + isset($abook_global_file_listing) && + trim($abook_global_file)!=''){ + + // Detect place of address book + if (! preg_match("/[\/\\\]/",$abook_global_file)) { + /* no path chars, address book stored in data directory + * make sure that there is a slash between data directory + * and address book file name + */ + $abook_global_filename=$data_dir + . ((substr($data_dir, -1) != '/') ? '/' : '') + . $abook_global_file; + } elseif (preg_match("/^\/|\w:/",$abook_global_file)) { + // full path is set in options (starts with slash or x:) + $abook_global_filename=$abook_global_file; + } else { + $abook_global_filename=SM_PATH . $abook_global_file; + } + + $r = $abook->add_backend('local_file',array('filename'=>$abook_global_filename, + 'name' => _("Global address book"), + 'detect_writeable' => false, + 'line_length' => $abook_file_line_length, + 'writeable'=> $abook_global_file_writeable, + 'listing' => $abook_global_file_listing)); + + /* global abook init error is not fatal. add error message and continue */ + if (!$r && $showerr) { + if ($abook_init_error!='') $abook_init_error.="\n"; + $abook_init_error.=_("Error initializing global address book.") . "\n" . $abook->error; + } + } + + /* Load global addressbook from SQL if configured */ + if (isset($addrbook_global_dsn) && !empty($addrbook_global_dsn)) { + /* Database configured */ + if (!isset($addrbook_global_table) || empty($addrbook_global_table)) { + $addrbook_global_table = 'global_abook'; + } + $r = $abook->add_backend('database', + Array('dsn' => $addrbook_global_dsn, + 'owner' => 'global', + 'name' => _("Global address book"), + 'writeable' => $addrbook_global_writeable, + 'listing' => $addrbook_global_listing, + 'table' => $addrbook_global_table)); + /* global abook init error is not fatal. add error message and continue */ + if (!$r && $showerr) { + if ($abook_init_error!='') $abook_init_error.="\n"; + $abook_init_error.=_("Error initializing global address book.") . "\n" . $abook->error; + } + } + + /* + * hook allows to include different address book backends. + * plugins should extract $abook and $r from arguments + * and use same add_backend commands as above functions. + * Since 1.5.2 hook sends third ($onlylocal) argument to address book + * plugins in order to allow detection of local address book init. + * @since 1.5.1 and 1.4.5 + * Since 1.5.2, the plugin arguments are passed inside an array + * and by reference, so plugins hooking in here need to accept arguments + * in an array and change those values as needed instead of returning + * the changed values. + */ + do_hook('abook_init', $temp=array(&$abook, &$r, &$onlylocal)); + if (!$r && $showerr) { + if ($abook_init_error!='') $abook_init_error.="\n"; + $abook_init_error.=_("Error initializing other address books.") . "\n" . $abook->error; + } + + /* Load configured LDAP servers (if PHP has LDAP support) */ + if (isset($ldap_server) && is_array($ldap_server)) { + reset($ldap_server); + while (list($undef,$param) = each($ldap_server)) { + if (!is_array($param)) + continue; + + /* if onlylocal is true, we only add writeable ldap servers */ + if ($onlylocal && (!isset($param['writeable']) || $param['writeable'] != true)) + continue; + + $r = $abook->add_backend('ldap_server', $param); + if (!$r && $showerr) { + if ($abook_init_error!='') $abook_init_error.="\n"; + $abook_init_error.=sprintf(_("Error initializing LDAP server %s:"), $param['host'])."\n"; + $abook_init_error.= $abook->error; + } + } + } // end of ldap server init + + /** + * display address book init errors. + */ + if ($abook_init_error!='' && $showerr) { + error_box(nl2br(htmlspecialchars($abook_init_error))); + } + + /* Return the initialized object */ + return $abook; } +/** + * Display the "new address" form + * + * Form is not closed and you must add closing form tag. + * @since 1.5.1 + * @param string $form_url form action url + * @param string $name form name + * @param string $title form title + * @param string $button form button name + * @param array $defdata values of form fields + */ +function abook_create_form($form_url,$name,$title,$button,$defdata=array()) { + global $oTemplate; + + echo addForm($form_url, 'post', 'f_add'); -/* Open addressbook, with error messages on but without LDAP (the * - * second "true"). Don't need LDAP here anyway */ -$abook = addressbook_init(true, true); -if($abook->localbackend == 0) { - plain_error_message( - _("No personal address book is defined. Contact administrator."), - $color); - exit(); + if ($button == _("Update address")) { + $edit = true; + $backends = NULL; + } else { + $edit = false; + $backends = getWritableBackends(); + } + + $fields = array ( + 'nickname' => 'NickName', + 'firstname' => 'FirstName', + 'lastname' => 'LastName', + 'email' => 'Email', + 'label' => 'Info', + ); + $values = array(); + foreach ($fields as $sqm=>$template) { + $values[$template] = isset($defdata[$sqm]) ? $defdata[$sqm] : ''; + } + + $oTemplate->assign('writable_backends', $backends); + $oTemplate->assign('values', $values); + $oTemplate->assign('edit', $edit); + + $oTemplate->display('addrbook_addedit.tpl'); } -displayPageHeader($color, 'None'); +/** + * Had to move this function outside of the Addressbook Class + * PHP 4.0.4 Seemed to be having problems with inline functions. + * Note: this can return now since we don't support 4.0.4 anymore. + */ +function addressbook_cmp($a,$b) { -$defdata = array(); -$formerror = ''; -$abortform = false; -$showaddrlist = true; -$defselected = array(); + if($a['backend'] > $b['backend']) { + return 1; + } else if($a['backend'] < $b['backend']) { + return -1; + } + return (strtolower($a['name']) > strtolower($b['name'])) ? 1 : -1; -/* Handle user's actions */ -if($REQUEST_METHOD == 'POST') { +} - /************************************************** - * Add new address * - **************************************************/ - if (!empty($addaddr['nickname'])) { +/** + * Retrieve a list of writable backends + * @since 1.5.2 + */ +function getWritableBackends () { + global $abook; + + $write = array(); + $backends = $abook->get_backend_list(); + while (list($undef,$v) = each($backends)) { + if ($v->writeable) { + $write[$v->bnum]=$v->sname; + } + } - $r = $abook->add($addaddr, $abook->localbackend); + return $write; +} - /* Handle error messages */ - if (!$r) { - /* Remove backend name from error string */ - $errstr = $abook->error; - $errstr = ereg_replace('^\[.*\] *', '', $errstr); +/** + * Sort array by the key "name" + */ +function alistcmp($a,$b) { + $abook_sort_order=get_abook_sort(); + + switch ($abook_sort_order) { + case 0: + case 1: + $abook_sort='nickname'; + break; + case 4: + case 5: + $abook_sort='email'; + break; + case 6: + case 7: + $abook_sort='label'; + break; + case 2: + case 3: + case 8: + default: + $abook_sort='name'; + } - $formerror = $errstr; - $showaddrlist = false; - $defdata = $addaddr; + if ($a['backend'] > $b['backend']) { + return 1; + } else { + if ($a['backend'] < $b['backend']) { + return -1; } + } + if( (($abook_sort_order+2) % 2) == 1) { + return (strtolower($a[$abook_sort]) < strtolower($b[$abook_sort])) ? 1 : -1; } else { + return (strtolower($a[$abook_sort]) > strtolower($b[$abook_sort])) ? 1 : -1; + } +} - /************************************************ - * Delete address(es) * - ************************************************/ - if ((!empty($deladdr)) && sizeof($sel) > 0) { - $orig_sel = $sel; - sort($sel); - - /* The selected addresses are identidied by "backend:nickname". * - * Sort the list and process one backend at the time */ - $prevback = -1; - $subsel = array(); - $delfailed = false; - - for ($i = 0 ; (($i < sizeof($sel)) && !$delfailed) ; $i++) { - list($sbackend, $snick) = explode(':', $sel[$i]); - - /* When we get to a new backend, process addresses in * - * previous one. */ - if ($prevback != $sbackend && $prevback != -1) { - - $r = $abook->remove($subsel, $prevback); - if (!$r) { - $formerror = $abook->error; - $i = sizeof($sel); - $delfailed = true; - break; - } - $subsel = array(); - } +/** + * Address book sorting options + * + * returns address book sorting order + * @return integer book sorting options order + */ +function get_abook_sort() { + global $data_dir, $username; + + /* get sorting order */ + if(sqgetGlobalVar('abook_sort_order', $temp, SQ_GET)) { + $abook_sort_order = (int) $temp; + + if ($abook_sort_order < 0 or $abook_sort_order > 8) + $abook_sort_order=8; + + setPref($data_dir, $username, 'abook_sort_order', $abook_sort_order); + } else { + /* get previous sorting options. default to unsorted */ + $abook_sort_order = getPref($data_dir, $username, 'abook_sort_order', 8); + } + + return $abook_sort_order; +} + +/** + * This function shows the address book sort button. + * + * @param integer $abook_sort_order current sort value + * @param string $alt_tag alt tag value (string visible to text only browsers) + * @param integer $Down sort value when list is sorted ascending + * @param integer $Up sort value when list is sorted descending + * @return string html code with sorting images and urls + */ +function show_abook_sort_button($abook_sort_order, $alt_tag, $Down, $Up ) { + global $form_url, $icon_theme_path; + + /* Figure out which image we want to use. */ + if ($abook_sort_order != $Up && $abook_sort_order != $Down) { + $img = 'sort_none.png'; + $text_icon = '◻'; // U+25FB WHITE MEDIUM SQUARE + $which = $Up; + } elseif ($abook_sort_order == $Up) { + $img = 'up_pointer.png'; + $text_icon = '⇧'; // U+21E7 UPWARDS WHITE ARROW + $which = $Down; + } else { + $img = 'down_pointer.png'; + $text_icon = '⇩'; // U+21E9 DOWNWARDS WHITE ARROW + $which = 8; + } + + /* Now that we have everything figured out, show the actual button. */ + return ' ' . + getIcon($icon_theme_path, $img, $text_icon, $alt_tag) . + ''; +} + + +/** + * This is the main address book class that connect all the + * backends and provide services to the functions above. + * @package squirrelmail + * @subpackage addressbook + */ +class AddressBook { + /** + * Enabled address book backends + * @var array + */ + var $backends = array(); + /** + * Number of enabled backends + * @var integer + */ + var $numbackends = 0; + /** + * Error messages + * @var string + */ + var $error = ''; + /** + * id of backend with personal address book + * @var integer + */ + var $localbackend = 0; + /** + * Name of backend with personal address book + * @var string + */ + var $localbackendname = ''; + /** + * Controls use of 'extra' field + * + * Extra field can be used to add link to form, which allows + * to modify all fields supported by backend. This is the only field + * that is not sanitized with htmlspecialchars. Backends MUST make + * sure that field data is sanitized and displayed correctly inside + * table cell. Use of html formating in other address book fields is + * not allowed. Backends that don't return 'extra' row in address book + * data should not modify this object property. + * @var boolean + * @since 1.5.1 + */ + var $add_extra_field = false; + + /** + * Constructor function. + */ + function AddressBook() { + $this->localbackendname = _("Personal address book"); + } - /* Queue for processing */ - array_push($subsel, $snick); - $prevback = $sbackend; + /** + * Return an array of backends of a given type, + * or all backends if no type is specified. + * @param string $type backend type + * @return array list of backends + */ + function get_backend_list($type = '') { + $ret = array(); + for ($i = 1 ; $i <= $this->numbackends ; $i++) { + if (empty($type) || $type == $this->backends[$i]->btype) { + $ret[] = &$this->backends[$i]; } + } + return $ret; + } + - if (!$delfailed) { - $r = $abook->remove($subsel, $prevback); - if (!$r) { /* Handle errors */ - $formerror = $abook->error; - $delfailed = true; + /* ========================== Public ======================== */ + + /** + * Add a new backend. + * + * @param string $backend backend name (without the abook_ prefix) + * @param mixed optional variable that is passed to the backend constructor. + * See each of the backend classes for valid parameters + * @return integer number of backends + */ + function add_backend($backend, $param = '') { + static $backend_classes; + if (!isset($backend_classes)) { + $backend_classes = array(); + } + if (!isset($backend_classes[$backend])) { + /** + * Support backend provided by plugins. Plugin function must + * return an associative array with as key the backend name ($backend) + * and as value the file including the path containing the backend class. + * i.e.: $aBackend = array('backend_template' => SM_PATH . 'plugins/abook_backend_template/functions.php') + * + * NB: Because the backend files are included from within this function they DO NOT have access to + * vars in the global scope. This function is the global scope for the included backend !!! + */ + global $null; + $aBackend = do_hook('abook_add_class', $null); + if (isset($aBackend) && is_array($aBackend) && isset($aBackend[$backend])) { + require_once($aBackend[$backend]); + } else { + require_once(SM_PATH . 'functions/abook_'.$backend.'.php'); + } + $backend_classes[$backend] = true; + } + $backend_name = 'abook_' . $backend; + $newback = new $backend_name($param); + //eval('$newback = new ' . $backend_name . '($param);'); + if(!empty($newback->error)) { + $this->error = $newback->error; + return false; + } + + $this->numbackends++; + + $newback->bnum = $this->numbackends; + $this->backends[$this->numbackends] = $newback; + + /* Store ID of first local backend added */ + if ($this->localbackend == 0 && $newback->btype == 'local') { + $this->localbackend = $this->numbackends; + $this->localbackendname = $newback->sname; + } + + return $this->numbackends; + } + + + /** + * create string with name and email address + * + * This function takes a $row array as returned by the addressbook + * search and returns an e-mail address with the full name or + * nickname optionally prepended. + * @param array $row address book entry + * @return string email address with real name prepended + */ + function full_address($row) { + global $addrsrch_fullname, $data_dir, $username; + $prefix = getPref($data_dir, $username, 'addrsrch_fullname'); + if (($prefix != "" || (isset($addrsrch_fullname) && + $prefix == $addrsrch_fullname)) && $prefix != 'noprefix') { + $name = ($prefix == 'nickname' ? $row['nickname'] : $row['name']); + return $name . ' <' . trim($row['email']) . '>'; + } else { + return trim($row['email']); + } + } + + /** + * Search for entries in address books + * + * Return a list of addresses matching expression in + * all backends of a given type. + * @param string $expression search expression + * @param integer $bnum backend number. default to search in all backends + * @return array search results + */ + function search($expression, $bnum = -1) { + $ret = array(); + $this->error = ''; + + /* Search all backends */ + if ($bnum == -1) { + $sel = $this->get_backend_list(''); + $failed = 0; + for ($i = 0 ; $i < sizeof($sel) ; $i++) { + $backend = &$sel[$i]; + $backend->error = ''; + $res = $backend->search($expression); + if (is_array($res)) { + $ret = array_merge($ret, $res); + } else { + $this->error .= "\n" . $backend->error; + $failed++; } } - if ($delfailed) { - $showaddrlist = true; - $defselected = $orig_sel; + /* Only fail if all backends failed */ + if( $failed >= sizeof( $sel ) ) { + $ret = FALSE; } + } elseif (! isset($this->backends[$bnum])) { + /* make sure that backend exists */ + $this->error = _("Unknown address book backend"); + $ret = false; } else { - /*********************************************** - * Update/modify address * - ***********************************************/ - if (!empty($editaddr)) { - - /* Stage one: Copy data into form */ - if (isset($sel) && sizeof($sel) > 0) { - if(sizeof($sel) > 1) { - $formerror = _("You can only edit one address at the time"); - $showaddrlist = true; - $defselected = $sel; - } else { - $abortform = true; - list($ebackend, $enick) = explode(':', $sel[0]); - $olddata = $abook->lookup($enick, $ebackend); - - /* Display the "new address" form */ - echo '
'; - } - } else { + /* Search only one backend */ - /* Stage two: Write new data */ - if ($doedit = 1) { - $newdata = $editaddr; - $r = $abook->modify($oldnick, $newdata, $backend); - - /* Handle error messages */ - if (!$r) { - /* Display error */ - echo html_tag( 'table', - html_tag( 'tr', - html_tag( 'td', - "\n". '