<?php
- /**
- ** addressbook.php
- **
- ** Functions and classes for the addressbook system.
- **
- ** $Id$
- **/
-
- $addressbook_php = true;
-
- // Include backends here.
- include('../functions/abook_local_file.php');
- include('../functions/abook_ldap_server.php');
-
- // Un-comment if you're using database backend
- // include('../functions/abook_database.php');
+/**
+ * addressbook.php
+ *
+ * Copyright (c) 1999-2001 The Squirrelmail Development Team
+ * Licensed under the GNU GPL. For full terms see the file COPYING.
+ *
+ * Functions and classes for the addressbook system.
+ *
+ * $Id$
+ */
+
+/*****************************************************************/
+/*** THIS FILE NEEDS TO HAVE ITS FORMATTING FIXED!!! ***/
+/*** PLEASE DO SO AND REMOVE THIS COMMENT SECTION. ***/
+/*** + Base level indent should begin at left margin, as ***/
+/*** the require_once below looks. ***/
+/*** + All identation should consist of four space blocks ***/
+/*** + Tab characters are evil. ***/
+/*** + all comments should use "slash-star ... star-slash" ***/
+/*** style -- no pound characters, no slash-slash style ***/
+/*** + FLOW CONTROL STATEMENTS (if, while, etc) SHOULD ***/
+/*** ALWAYS USE { AND } CHARACTERS!!! ***/
+/*** + Please use ' instead of ", when possible. Note " ***/
+/*** should always be used in _( ) function calls. ***/
+/*** Thank you for your help making the SM code more readable. ***/
+/*****************************************************************/
+
+// 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('../functions/abook_local_file.php');
+require_once('../functions/abook_ldap_server.php');
+
+ // Use this if you wanna have a global address book
+ if (isset($address_book_global_filename))
+ include_once('../functions/abook_global_file.php');
+
+ // Only load database backend if database is configured
+ global $addrbook_dsn;
+ 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;
+ global $data_dir, $username, $ldap_server, $address_book_global_filename;
+ global $addrbook_dsn;
// Create a new addressbook object
$abook = new AddressBook;
- // Always add a local backend
-
- // Use *either* file-based *or* database addressbook. Remove
- // and insert comments to enable the one you want.
-
- // ------ BEGIN Initialize file-based personal addressbook ------
- $filename = sprintf('%s%s.abook', $data_dir, $username);
- $r = $abook->add_backend('local_file', Array('filename' => $filename,
- 'create' => true));
+ // 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
+ $r = $abook->add_backend('database', Array('dsn' => $addrbook_dsn,
+ 'owner' => $username,
+ 'table' => 'address'));
+ if(!$r && $showerr) {
+ printf(_("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;
+ }
+
+ }
- 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) {
+ printf(_("Error initializing global addressbook."));
+ exit;
+ }
}
- // ------ END Initialize file-based personal addressbook ------
-
- // ------ BEGIN Initialize database-based personal addressbook ------
- // $r = $abook->add_backend('database', Array('dsn' => 'mysql://dbuser@host/dbname',
- // 'owner' => $username,
- // 'table' => 'address'));
- // if(!$r && $showerr) {
- // printf(_("Error initializing addressbook: %s"), $filename);
- // exit;
- // }
- // ------ END Initialize database-based personal addressbook ------
if($onlylocal)
return $abook;
$ret = array();
for($i = 1 ; $i <= $this->numbackends ; $i++) {
if(empty($type) || $type == $this->backends[$i]->btype) {
- array_push($ret, &$this->backends[$i]);
+ $ret[] = &$this->backends[$i];
}
}
return $ret;
}
if(eregi('[ \\:\\|\\#\\"\\!]', $userdata['nickname'])) {
- $this->error = _("Nickname contain illegal characters");
+ $this->error = _("Nickname contains illegal characters");
return false;
}
}
if(eregi('[\\: \\|\\#"\\!]', $userdata['nickname'])) {
- $this->error = _("Nickname contain illegal characters");
+ $this->error = _("Nickname contains illegal characters");
return false;
}
projects / squirrelmail.git / blobdiff