/**
* abook_database.php
*
- * Copyright (c) 1999-2004 The SquirrelMail Project Team
- * Licensed under the GNU GPL. For full terms see the file COPYING.
- *
- * Backend for personal addressbook stored in a database,
- * accessed using the DB-classes in PEAR.
- *
- * IMPORTANT: The PEAR modules must be in the include path
- * for this class to work.
- *
- * An array with the following elements must be passed to
- * the class constructor (elements marked ? are optional):
- *
- * dsn => database DNS (see PEAR for syntax)
- * table => table to store addresses in (must exist)
- * owner => current user (owner of address data)
- * ? writeable => set writeable flag (true/false)
- *
- * The table used should have the following columns:
- * owner, nickname, firstname, lastname, email, label
- * The pair (owner,nickname) should be unique (primary key).
- *
- * NOTE. This class should not be used directly. Use the
- * "AddressBook" class instead.
- *
+ * @copyright © 1999-2006 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
* @version $Id$
* @package squirrelmail
* @subpackage addressbook
}
/**
- * Undocumented class - stores the addressbook in a sql database
+ * Address book in a database backend
+ *
+ * Backend for personal/shared address book stored in a database,
+ * accessed using the DB-classes in PEAR.
+ *
+ * IMPORTANT: The PEAR modules must be in the include path
+ * for this class to work.
+ *
+ * An array with the following elements must be passed to
+ * the class constructor (elements marked ? are optional):
+ * <pre>
+ * dsn => database DNS (see PEAR for syntax)
+ * table => table to store addresses in (must exist)
+ * owner => current user (owner of address data)
+ * ? name => name of address book
+ * ? writeable => set writeable flag (true/false)
+ * ? listing => enable/disable listing
+ * </pre>
+ * The table used should have the following columns:
+ * owner, nickname, firstname, lastname, email, label
+ * The pair (owner,nickname) should be unique (primary key).
+ *
+ * NOTE. This class should not be used directly. Use the
+ * "AddressBook" class instead.
* @package squirrelmail
+ * @subpackage addressbook
*/
class abook_database extends addressbook_backend {
+ /**
+ * Backend type
+ * @var string
+ */
var $btype = 'local';
+ /**
+ * Backend name
+ * @var string
+ */
var $bname = 'database';
+ /**
+ * Data Source Name (connection description)
+ * @var string
+ */
var $dsn = '';
+ /**
+ * Table that stores addresses
+ * @var string
+ */
var $table = '';
+ /**
+ * Owner name
+ *
+ * Limits list of database entries visible to end user
+ * @var string
+ */
var $owner = '';
+ /**
+ * Database Handle
+ * @var resource
+ */
var $dbh = false;
-
+ /**
+ * Enable/disable writing into address book
+ * @var bool
+ */
var $writeable = true;
+ /**
+ * Enable/disable address book listing
+ * @var bool
+ */
+ var $listing = true;
/* ========================== Private ======================= */
- /* Constructor */
+ /**
+ * Constructor
+ * @param array $param address book backend options
+ */
function abook_database($param) {
$this->sname = _("Personal address book");
}
- /* Open the database. New connection if $new is true */
+ /**
+ * Open the database.
+ * @param bool $new new connection if it is true
+ * @return bool
+ */
function open($new = false) {
$this->error = '';
return true;
}
- /* Close the file and forget the filehandle */
+ /**
+ * Close the file and forget the filehandle
+ */
function close() {
$this->dbh->disconnect();
$this->dbh = false;
/* ========================== Public ======================== */
- /* Search the file */
- function &search($expr) {
+ /**
+ * Search the database
+ * @param string $expr search expression
+ * @return array search results
+ */
+ function search($expr) {
$ret = array();
if(!$this->open()) {
return false;
return;
}
+ // don't allow wide search when listing is disabled.
+ if ($expr=='*' && ! $this->listing)
+ return array();
+
/* Make regexp from glob'ed expression */
$expr = str_replace('?', '_', $expr);
$expr = str_replace('*', '%', $expr);
return $ret;
}
- /* Lookup alias */
- function &lookup($alias) {
+ /**
+ * Lookup alias
+ * @param string $alias alias
+ * @return array search results
+ */
+ function lookup($alias) {
if (empty($alias)) {
return array();
}
return array();
}
- /* List all addresses */
- function &list_addr() {
+ /**
+ * List all addresses
+ * @return array search results
+ */
+ function list_addr() {
$ret = array();
if (!$this->open()) {
return false;
return $ret;
}
- /* Add address */
+ /**
+ * Add address
+ * @param array $userdata added data
+ * @return bool
+ */
function add($userdata) {
if (!$this->writeable) {
return $this->set_error(_("Addressbook is read-only"));
/* See if user exist already */
$ret = $this->lookup($userdata['nickname']);
if (!empty($ret)) {
- return $this->set_error(sprintf(_("User '%s' already exist"),
- $ret['nickname']));
+ return $this->set_error(sprintf(_("User \"%s\" already exists"),$ret['nickname']));
}
/* Create query */
$this->table, $this->owner,
$this->dbh->quoteString($userdata['nickname']),
$this->dbh->quoteString($userdata['firstname']),
- $this->dbh->quoteString($userdata['lastname']),
+ $this->dbh->quoteString((!empty($userdata['lastname'])?$userdata['lastname']:'')),
$this->dbh->quoteString($userdata['email']),
- $this->dbh->quoteString($userdata['label']) );
+ $this->dbh->quoteString((!empty($userdata['label'])?$userdata['label']:'')) );
/* Do the insert */
$r = $this->dbh->simpleQuery($query);
DB::errorMessage($r)));
}
- /* Delete address */
+ /**
+ * Delete address
+ * @param string $alias alias that has to be deleted
+ * @return bool
+ */
function remove($alias) {
if (!$this->writeable) {
return $this->set_error(_("Addressbook is read-only"));
DB::errorMessage($r)));
}
- /* Modify address */
+ /**
+ * Modify address
+ * @param string $alias modified alias
+ * @param array $userdata new data
+ * @return bool
+ */
function modify($alias, $userdata) {
if (!$this->writeable) {
return $this->set_error(_("Addressbook is read-only"));
/* See if user exist */
$ret = $this->lookup($alias);
if (empty($ret)) {
- return $this->set_error(sprintf(_("User '%s' does not exist"),
- $alias));
+ return $this->set_error(sprintf(_("User \"%s\" does not exist"),$alias));
}
/* Create query */
$this->table,
$this->dbh->quoteString($userdata['nickname']),
$this->dbh->quoteString($userdata['firstname']),
- $this->dbh->quoteString($userdata['lastname']),
+ $this->dbh->quoteString((!empty($userdata['lastname'])?$userdata['lastname']:'')),
$this->dbh->quoteString($userdata['email']),
- $this->dbh->quoteString($userdata['label']),
+ $this->dbh->quoteString((!empty($userdata['label'])?$userdata['label']:'')),
$this->owner,
$this->dbh->quoteString($alias) );
} /* End of class abook_database */
// vim: et ts=4
-?>
\ No newline at end of file
+?>
projects / squirrelmail.git / blobdiff