1. added non anonymous ldap binding patch. (thanks to Ilyak Kasnacheev <ilyak at...
[squirrelmail.git] / functions / addressbook.php
index 271155daeb72a850c621b83781c08126639533e1..57152cbffd2bc838a5150fcf88756f34c346d122 100644 (file)
@@ -3,15 +3,16 @@
 /**
  * addressbook.php
  *
- * Copyright (c) 1999-2001 The Squirrelmail Development Team
+ * Copyright (c) 1999-2003 The SquirrelMail Project Team
  * Licensed under the GNU GPL. For full terms see the file COPYING.
  *
  * Functions and classes for the addressbook system.
  *
  * $Id$
+ * @package squirrelmail
  */
 
-/*
+/**
    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"
    The global addressbook is unmodifiable by anyone.  You must actually
    use a shell script or whatnot to modify the contents.
 
-  global $data_dir;
+  global $data_dir, $address_book_global_filename;
   $address_book_global_filename = "$data_dir/global.abook";
 
-  Include backends here.
 */
 
-require_once('../functions/abook_local_file.php');
-require_once('../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');
-}
+global $addrbook_dsn, $addrbook_global_dsn;
 
-/* Only load database backend if database is configured */
-if(isset($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;
+    global $addrbook_dsn, $addrbook_table;
+    global $addrbook_global_dsn, $addrbook_global_table, $addrbook_global_writeable, $addrbook_global_listing;
 
     /* Create a new addressbook object */
     $abook = new AddressBook;
@@ -63,9 +51,12 @@ function addressbook_init($showerr = true, $onlylocal = false) {
     */
     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' => 'address'));
+                            'table' => $addrbook_table));
         if (!$r && $showerr) {
             echo _("Error initializing addressbook database.");
             exit;
@@ -91,6 +82,21 @@ function addressbook_init($showerr = true, $onlylocal = false) {
         }
     }
 
+    /* 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));
+    }
+
     if ($onlylocal) {
         return $abook;
     }
@@ -133,10 +139,10 @@ function addressbook_cmp($a,$b) {
 }
 
 
-/*
+/**
  * This is the main address book class that connect all the
  * backends and provide services to the functions above.
- *
+ * @package squirrelmail
  */
 
 class AddressBook {
@@ -198,6 +204,26 @@ class AddressBook {
     }
 
 
+    /*
+     * 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, $data_dir, $username;
+
+        if (($prefix = getPref($data_dir, $username, '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']);
+        }
+    }
+
     /*
         Return a list of addresses matching expression in
         all backends of a given type.
@@ -314,7 +340,6 @@ class AddressBook {
         return $ret;
     }
 
-
     /*
      * Create a new address from $userdata, in backend $bnum.
      * Return the backend number that the/ address was added
@@ -379,7 +404,7 @@ class AddressBook {
             $alias = array(0 => $alias);
         }
         
-        /* Check that specified backend is writable */
+        /* Check that specified backend is writeable */
         if (!$this->backends[$bnum]->writeable) {
             $this->error = _("Addressbook is read-only");
             return false;
@@ -432,7 +457,7 @@ class AddressBook {
             $userdata['nickname'] = $userdata['email'];
         }
         
-        /* Check that specified backend is writable */
+        /* Check that specified backend is writeable */
         if (!$this->backends[$bnum]->writeable) {
             $this->error = _("Addressbook is read-only");;
             return false;
@@ -453,8 +478,9 @@ class AddressBook {
     
 } /* End of class Addressbook */
 
-/*
+/**
  * Generic backend that all other backends extend
+ * @package squirrelmail
  */
 class addressbook_backend {
 
@@ -511,4 +537,37 @@ class addressbook_backend {
 
 }
 
-?>
\ No newline at end of file
+/* Sort array by the key "name" */
+function alistcmp($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;
+}
+
+
+/*
+  PHP 5 requires that the class be made first, which seems rather
+  logical, and should have been the way it was generated the first time.
+*/
+
+require_once(SM_PATH . 'functions/abook_local_file.php');
+require_once(SM_PATH . 'functions/abook_ldap_server.php');
+
+/* Use this if you wanna have a global address book */
+if (isset($address_book_global_filename)) {
+    include_once(SM_PATH . 'functions/abook_global_file.php');
+}
+
+/* Only load database backend if database is configured */
+if((isset($addrbook_dsn) && !empty($addrbook_dsn)) || 
+ (isset($addrbook_global_dsn) && !empty($addrbook_global_dsn)) ) {
+  include_once(SM_PATH . 'functions/abook_database.php');
+}
+
+
+?>