X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=functions%2Faddressbook.php;h=f62ccde50fdc0f752c2968d05edf02a7d4864ea2;hp=269b199417a630682ea9462f30ee73865816d6a2;hb=b68edc750e3b478f5302681e8fbd289b17447550;hpb=75e19c7fe9b21733b1af5f4c5910835da1eea326
diff --git a/functions/addressbook.php b/functions/addressbook.php
index 269b1994..f62ccde5 100644
--- a/functions/addressbook.php
+++ b/functions/addressbook.php
@@ -6,375 +6,543 @@
* Copyright (c) 1999-2002 The SquirrelMail Project Team
* Licensed under the GNU GPL. For full terms see the file COPYING.
*
- * Manage personal address book.
+ * Functions and classes for the addressbook system.
*
* $Id$
*/
-require_once('../src/validate.php');
-require_once('../functions/array.php');
-require_once('../functions/display_messages.php');
-require_once('../functions/addressbook.php');
-require_once('../functions/strings.php');
-require_once('../functions/html.php');
-
-/* Make an input field */
-function adressbook_inp_field($label, $field, $name, $size, $values, $add) {
- global $color;
- $td_str = '' . $add . '';
- return html_tag( 'tr' ,
- html_tag( 'td', $label . ':', 'right', $color[4]) .
- html_tag( 'td', $td_str, 'left', $color[4])
- )
- . "\n";
+/*
+ This is the path to the global site-wide addressbook.
+ It looks and feels just like a user's .abook file
+ If this is in the data directory, use "$data_dir/global.abook"
+ If not, specify the path as though it was accessed from the
+ src/ directory ("../global.abook" -> in main directory)
+
+ If you don't want a global site-wide addressbook, comment these
+ two lines out. (They are disabled by default.)
+
+ The global addressbook is unmodifiable by anyone. You must actually
+ use a shell script or whatnot to modify the contents.
+
+ global $data_dir;
+ $address_book_global_filename = "$data_dir/global.abook";
+
+ Include backends here.
+*/
+
+require_once(SM_PATH . 'functions/abook_local_file.php');
+require_once(SM_PATH . 'functions/abook_ldap_server.php');
+
+global $addrbook_dsn;
+
+/* Use this if you wanna have a global address book */
+if (isset($address_book_global_filename)) {
+ include_once('../functions/abook_global_file.php');
}
-/* 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";
+/* Only load database backend if database is configured */
+if(isset($addrbook_dsn) && !empty($addrbook_dsn)) {
+ include_once('../functions/abook_database.php');
}
+/*
+ Create and initialize an addressbook object.
+ Returns the created object
+*/
+function addressbook_init($showerr = true, $onlylocal = false) {
+ global $data_dir, $username, $ldap_server, $address_book_global_filename;
+ global $addrbook_dsn, $addrbook_table;
+
+ /* Create a new addressbook object */
+ $abook = new AddressBook;
+
+ /*
+ Always add a local backend. We use *either* file-based *or* a
+ database addressbook. If $addrbook_dsn is set, the database
+ backend is used. If not, addressbooks are stores in files.
+ */
+ if (isset($addrbook_dsn) && !empty($addrbook_dsn)) {
+ /* Database */
+ if (!isset($addrbook_table) || empty($addrbook_table)) {
+ $addrbook_table = 'address';
+ }
+ $r = $abook->add_backend('database', Array('dsn' => $addrbook_dsn,
+ 'owner' => $username,
+ 'table' => $addrbook_table));
+ if (!$r && $showerr) {
+ echo _("Error initializing addressbook database.");
+ exit;
+ }
+ } else {
+ /* File */
+ $filename = getHashedFile($username, $data_dir, "$username.abook");
+ $r = $abook->add_backend('local_file', Array('filename' => $filename,
+ 'create' => true));
+ if(!$r && $showerr) {
+ printf( _("Error opening file %s"), $filename );
+ exit;
+ }
+
+ }
+
+ /* This would be for the global addressbook */
+ if (isset($address_book_global_filename)) {
+ $r = $abook->add_backend('global_file');
+ if (!$r && $showerr) {
+ echo _("Error initializing global addressbook.");
+ exit;
+ }
+ }
-/* 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 ($onlylocal) {
+ return $abook;
+ }
+
+ /* Load configured LDAP servers (if PHP has LDAP support) */
+ if (isset($ldap_server) && is_array($ldap_server) && function_exists('ldap_connect')) {
+ reset($ldap_server);
+ while (list($undef,$param) = each($ldap_server)) {
+ if (is_array($param)) {
+ $r = $abook->add_backend('ldap_server', $param);
+ if (!$r && $showerr) {
+ printf( ' ' . _("Error initializing LDAP server %s:") .
+ "
\n", $param['host']);
+ echo ' ' . $abook->error;
+ exit;
+ }
+ }
+ }
+ }
+
+ /* Return the initialized object */
+ return $abook;
}
-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.
+ */
+function addressbook_cmp($a,$b) {
+
+ if($a['backend'] > $b['backend']) {
+ return 1;
+ } else if($a['backend'] < $b['backend']) {
+ return -1;
+ }
+
+ return (strtolower($a['name']) > strtolower($b['name'])) ? 1 : -1;
+
+}
-$defdata = array();
-$formerror = '';
-$abortform = false;
-$showaddrlist = true;
-$defselected = array();
+/*
+ * This is the main address book class that connect all the
+ * backends and provide services to the functions above.
+ *
+ */
-/* Handle user's actions */
-if($REQUEST_METHOD == 'POST') {
+class AddressBook {
- /**************************************************
- * Add new address *
- **************************************************/
- if (!empty($addaddr['nickname'])) {
+ var $backends = array();
+ var $numbackends = 0;
+ var $error = '';
+ var $localbackend = 0;
+ var $localbackendname = '';
+
+ // Constructor function.
+ function AddressBook() {
+ $localbackendname = _("Personal address book");
+ }
- $r = $abook->add($addaddr, $abook->localbackend);
+ /*
+ * Return an array of backends of a given type,
+ * or all backends if no type is specified.
+ */
+ 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;
+ }
- /* Handle error messages */
- if (!$r) {
- /* Remove backend name from error string */
- $errstr = $abook->error;
- $errstr = ereg_replace('^\[.*\] *', '', $errstr);
- $formerror = $errstr;
- $showaddrlist = false;
- $defdata = $addaddr;
+ /*
+ ========================== Public ========================
+
+ Add a new backend. $backend is the name of a backend
+ (without the abook_ prefix), and $param is an optional
+ mixed variable that is passed to the backend constructor.
+ See each of the backend classes for valid parameters.
+ */
+ function add_backend($backend, $param = '') {
+ $backend_name = 'abook_' . $backend;
+ eval('$newback = new ' . $backend_name . '($param);');
+ if(!empty($newback->error)) {
+ $this->error = $newback->error;
+ return false;
}
- } else {
+ $this->numbackends++;
- /************************************************
- * 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();
- }
+ $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;
+ }
- /* Queue for processing */
- array_push($subsel, $snick);
- $prevback = $sbackend;
- }
+ return $this->numbackends;
+ }
- if (!$delfailed) {
- $r = $abook->remove($subsel, $prevback);
- if (!$r) { /* Handle errors */
- $formerror = $abook->error;
- $delfailed = true;
- }
- }
- if ($delfailed) {
- $showaddrlist = true;
- $defselected = $orig_sel;
- }
+ /*
+ * 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.
+ */
+ function full_address($row) {
+ global $addrsrch_fullname, $datadir, $user;
+
+ if (($prefix = getPref($datadir, $user, 'addrsrch_fullname') or
+ isset($addrsrch_fullname) and $prefix = $addrsrch_fullname)
+ and $prefix !== 'noprefix') {
+ $name = ($prefix === 'nickname') ? $row['nickname']
+ : $row['name'];
+ return $name . ' <' . trim($row['email']) . '>';
} else {
+ return trim($row['email']);
+ }
+ }
- /***********************************************
- * 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 '';
- }
+ /*
+ Return a list of addresses matching expression in
+ all backends of a given type.
+ */
+ 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 {
-
- /* 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". '
' . _("ERROR") . ': ' . $abook->error . '' ."\n",
- 'center' )
- ),
- 'center', '', 'width="100%" cols="1"' );
-
- /* Display the "new address" form again */
- echo '';
- $abortform = true;
- }
- } else {
-
- /* Should not get here... */
- plain_error_message(_("Unknown error"), $color);
- $abortform = true;
- }
+ $this->error .= "
\n" . $backend->error;
+ $failed++;
}
- } /* !empty($editaddr) - Update/modify address */
- } /* (!empty($deladdr)) && sizeof($sel) > 0 - Delete address(es) */
- } /* !empty($addaddr['nickname']) - Add new address */
-
- // Some times we end output before forms are printed
- if($abortform) {
- echo "