1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332
|
<?php
/**
* abook_database.php
*
* Copyright (c) 1999-2002 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.
*
* $Id: abook_database.php,v 1.13 2001/12/23 07:42:38 thomppj Exp $
*/
require_once('DB.php');
class abook_database extends addressbook_backend {
var $btype = 'local';
var $bname = 'database';
var $dsn = '';
var $table = '';
var $owner = '';
var $dbh = false;
var $writeable = true;
/* ========================== Private ======================= */
/* Constructor */
function abook_database($param) {
$this->sname = _("Personal address book");
if (is_array($param)) {
if (empty($param['dsn']) ||
empty($param['table']) ||
empty($param['owner'])) {
return $this->set_error('Invalid parameters');
}
$this->dsn = $param['dsn'];
$this->table = $param['table'];
$this->owner = $param['owner'];
if (!empty($param['name'])) {
$this->sname = $param['name'];
}
if (isset($param['writeable'])) {
$this->writeable = $param['writeable'];
}
$this->open(true);
}
else {
return $this->set_error('Invalid argument to constructor');
}
}
/* Open the database. New connection if $new is true */
function open($new = false) {
$this->error = '';
/* Return true is file is open and $new is unset */
if ($this->dbh && !$new) {
return true;
}
/* Close old file, if any */
if ($this->dbh) {
$this->close();
}
$dbh = DB::connect($this->dsn, true);
if (DB::isError($dbh) || DB::isWarning($dbh)) {
return $this->set_error(sprintf(_("Database error: %s"),
DB::errorMessage($dbh)));
}
$this->dbh = $dbh;
return true;
}
/* Close the file and forget the filehandle */
function close() {
$this->dbh->disconnect();
$this->dbh = false;
}
/* ========================== Public ======================== */
/* Search the file */
function &search($expr) {
$ret = array();
if(!$this->open()) {
return false;
}
/* To be replaced by advanded search expression parsing */
if (is_array($expr)) {
return;
}
/* Make regexp from glob'ed expression */
$expr = str_replace('?', '_', $expr);
$expr = str_replace('*', '%', $expr);
$expr = $this->dbh->quoteString($expr);
$expr = "%$expr%";
$query = sprintf("SELECT * FROM %s WHERE owner='%s' AND " .
"(firstname LIKE '%s' OR lastname LIKE '%s')",
$this->table, $this->owner, $expr, $expr);
$res = $this->dbh->query($query);
if (DB::isError($res)) {
return $this->set_error(sprintf(_("Database error: %s"),
DB::errorMessage($res)));
}
while ($row = $res->fetchRow(DB_FETCHMODE_ASSOC)) {
array_push($ret, array('nickname' => $row['nickname'],
'name' => "$row[firstname] $row[lastname]",
'firstname' => $row['firstname'],
'lastname' => $row['lastname'],
'email' => $row['email'],
'label' => $row['label'],
'backend' => $this->bnum,
'source' => &$this->sname));
}
return $ret;
}
/* Lookup alias */
function &lookup($alias) {
if (empty($alias)) {
return array();
}
$alias = strtolower($alias);
if (!$this->open()) {
return false;
}
$query = sprintf("SELECT * FROM %s WHERE owner='%s' AND nickname='%s'",
$this->table, $this->owner, $this->dbh->quoteString($alias));
$res = $this->dbh->query($query);
if (DB::isError($res)) {
return $this->set_error(sprintf(_("Database error: %s"),
DB::errorMessage($res)));
}
if ($row = $res->fetchRow(DB_FETCHMODE_ASSOC)) {
return array('nickname' => $row['nickname'],
'name' => "$row[firstname] $row[lastname]",
'firstname' => $row['firstname'],
'lastname' => $row['lastname'],
'email' => $row['email'],
'label' => $row['label'],
'backend' => $this->bnum,
'source' => &$this->sname);
}
return array();
}
/* List all addresses */
function &list_addr() {
$ret = array();
if (!$this->open()) {
return false;
}
$query = sprintf("SELECT * FROM %s WHERE owner='%s'",
$this->table, $this->owner);
$res = $this->dbh->query($query);
if (DB::isError($res)) {
return $this->set_error(sprintf(_("Database error: %s"),
DB::errorMessage($res)));
}
while ($row = $res->fetchRow(DB_FETCHMODE_ASSOC)) {
array_push($ret, array('nickname' => $row['nickname'],
'name' => "$row[firstname] $row[lastname]",
'firstname' => $row['firstname'],
'lastname' => $row['lastname'],
'email' => $row['email'],
'label' => $row['label'],
'backend' => $this->bnum,
'source' => &$this->sname));
}
return $ret;
}
/* Add address */
function add($userdata) {
if (!$this->writeable) {
return $this->set_error(_("Addressbook is read-only"));
}
if (!$this->open()) {
return false;
}
/* See if user exist already */
$ret = $this->lookup($userdata['nickname']);
if (!empty($ret)) {
return $this->set_error(sprintf(_("User '%s' already exist"),
$ret['nickname']));
}
/* Create query */
$query = sprintf("INSERT INTO %s (owner, nickname, firstname, " .
"lastname, email, label) VALUES('%s','%s','%s'," .
"'%s','%s','%s')",
$this->table, $this->owner,
$this->dbh->quoteString($userdata['nickname']),
$this->dbh->quoteString($userdata['firstname']),
$this->dbh->quoteString($userdata['lastname']),
$this->dbh->quoteString($userdata['email']),
$this->dbh->quoteString($userdata['label']) );
/* Do the insert */
$r = $this->dbh->simpleQuery($query);
if ($r == DB_OK) {
return true;
}
/* Fail */
return $this->set_error(sprintf(_("Database error: %s"),
DB::errorMessage($r)));
}
/* Delete address */
function remove($alias) {
if (!$this->writeable) {
return $this->set_error(_("Addressbook is read-only"));
}
if (!$this->open()) {
return false;
}
/* Create query */
$query = sprintf("DELETE FROM %s WHERE owner='%s' AND (",
$this->table, $this->owner);
$sepstr = '';
while (list($undef, $nickname) = each($alias)) {
$query .= sprintf("%s nickname='%s' ", $sepstr,
$this->dbh->quoteString($nickname));
$sepstr = 'OR';
}
$query .= ')';
/* Delete entry */
$r = $this->dbh->simpleQuery($query);
if ($r == DB_OK) {
return true;
}
/* Fail */
return $this->set_error(sprintf(_("Database error: %s"),
DB::errorMessage($r)));
}
/* Modify address */
function modify($alias, $userdata) {
if (!$this->writeable) {
return $this->set_error(_("Addressbook is read-only"));
}
if (!$this->open()) {
return false;
}
/* See if user exist */
$ret = $this->lookup($alias);
if (empty($ret)) {
return $this->set_error(sprintf(_("User '%s' does not exist"),
$alias));
}
/* Create query */
$query = sprintf("UPDATE %s SET nickname='%s', firstname='%s', ".
"lastname='%s', email='%s', label='%s' ".
"WHERE owner='%s' AND nickname='%s'",
$this->table,
$this->dbh->quoteString($userdata['nickname']),
$this->dbh->quoteString($userdata['firstname']),
$this->dbh->quoteString($userdata['lastname']),
$this->dbh->quoteString($userdata['email']),
$this->dbh->quoteString($userdata['label']),
$this->owner,
$this->dbh->quoteString($alias) );
/* Do the insert */
$r = $this->dbh->simpleQuery($query);
if ($r == DB_OK) {
return true;
}
/* Fail */
return $this->set_error(sprintf(_("Database error: %s"),
DB::errorMessage($r)));
}
} /* End of class abook_database */
?>
|