* PRIMARY KEY (owner,nickname)
* </pre>
*
- * @copyright © 1999-2006 The SquirrelMail Project Team
+ * @copyright © 1999-2007 The SquirrelMail Project Team
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
* @version $Id$
* @package squirrelmail
* @param array $param address book backend options
*/
function abook_database($param) {
- $this->sname = _("Personal address book");
+ $this->sname = _("Personal Address Book");
/* test if Pear DB class is available and freak out if it is not */
if (! class_exists('DB')) {
// same error also in db_prefs.php
- $error = _("Could not include PEAR database functions required for the database backend.") . "<br />\n";
+ $error = _("Could not include PEAR database functions required for the database backend.") . "\n";
$error .= sprintf(_("Is PEAR installed, and is the include path set correctly to find %s?"),
- '<tt>DB.php</tt>') . "<br />\n";
+ 'DB.php') . "\n";
$error .= _("Please contact your system administrator and report this error.");
return $this->set_error($error);
}
$this->dbh = false;
}
+ /**
+ * Determine internal database field name given one of
+ * the SquirrelMail SM_ABOOK_FIELD_* constants
+ *
+ * @param integer $field The SM_ABOOK_FIELD_* contant to look up
+ *
+ * @return string The desired field name, or the string "ERROR"
+ * if the $field is not understood (the caller
+ * is responsible for handing errors)
+ *
+ */
+ function get_field_name($field) {
+ switch ($field) {
+ case SM_ABOOK_FIELD_NICKNAME:
+ return 'nickname';
+ case SM_ABOOK_FIELD_FIRSTNAME:
+ return 'firstname';
+ case SM_ABOOK_FIELD_LASTNAME:
+ return 'lastname';
+ case SM_ABOOK_FIELD_EMAIL:
+ return 'email';
+ case SM_ABOOK_FIELD_LABEL:
+ return 'label';
+ default:
+ return 'ERROR';
+ }
+ }
+
/* ========================== Public ======================== */
/**
while ($row = $res->fetchRow(DB_FETCHMODE_ASSOC)) {
array_push($ret, array('nickname' => $row['nickname'],
- 'name' => "$row[firstname] $row[lastname]",
+ 'name' => $this->fullname($row['firstname'], $row['lastname']),
'firstname' => $row['firstname'],
'lastname' => $row['lastname'],
'email' => $row['email'],
}
/**
- * Lookup alias
- * @param string $alias alias
- * @return array search results
+ * Lookup an address by the indicated field.
+ *
+ * @param string $value The value to look up
+ * @param integer $field The field to look in, should be one
+ * of the SM_ABOOK_FIELD_* constants
+ * defined in include/constants.php
+ * (OPTIONAL; defaults to nickname field)
+ * NOTE: uniqueness is only guaranteed
+ * when the nickname field is used here;
+ * otherwise, the first matching address
+ * is returned.
+ *
+ * @return array Array with lookup results when the value
+ * was found, an empty array if the value was
+ * not found.
+ *
*/
- function lookup($alias) {
- if (empty($alias)) {
+ function lookup($value, $field=SM_ABOOK_FIELD_NICKNAME) {
+ if (empty($value)) {
return array();
}
- $alias = strtolower($alias);
+ $value = strtolower($value);
if (!$this->open()) {
return false;
}
- $query = sprintf("SELECT * FROM %s WHERE owner='%s' AND LOWER(nickname)='%s'",
- $this->table, $this->owner, $this->dbh->quoteString($alias));
+ $db_field = $this->get_field_name($field);
+ if ($db_field == 'ERROR') {
+ return $this->set_error(sprintf(_("Unknown field name: %s"), $field));
+ }
+
+ $query = sprintf("SELECT * FROM %s WHERE owner = '%s' AND LOWER(%s) = '%s'",
+ $this->table, $this->owner, $db_field,
+ $this->dbh->quoteString($value));
$res = $this->dbh->query($query);
if ($row = $res->fetchRow(DB_FETCHMODE_ASSOC)) {
return array('nickname' => $row['nickname'],
- 'name' => "$row[firstname] $row[lastname]",
+ 'name' => $this->fullname($row['firstname'], $row['lastname']),
'firstname' => $row['firstname'],
'lastname' => $row['lastname'],
'email' => $row['email'],
while ($row = $res->fetchRow(DB_FETCHMODE_ASSOC)) {
array_push($ret, array('nickname' => $row['nickname'],
- 'name' => "$row[firstname] $row[lastname]",
+ 'name' => $this->fullname($row['firstname'], $row['lastname']),
'firstname' => $row['firstname'],
'lastname' => $row['lastname'],
'email' => $row['email'],
*/
function add($userdata) {
if (!$this->writeable) {
- return $this->set_error(_("Addressbook is read-only"));
+ return $this->set_error(_("Address book is read-only"));
}
if (!$this->open()) {
*/
function remove($alias) {
if (!$this->writeable) {
- return $this->set_error(_("Addressbook is read-only"));
+ return $this->set_error(_("Address book is read-only"));
}
if (!$this->open()) {
*/
function modify($alias, $userdata) {
if (!$this->writeable) {
- return $this->set_error(_("Addressbook is read-only"));
+ return $this->set_error(_("Address book is read-only"));
}
if (!$this->open()) {
} /* End of class abook_database */
// vim: et ts=4
-?>