-<?php {
-
- /**
- ** abook_database.php
- **
- ** Backend for personal addressbook stored in a database,
- ** accessed using the DB-casses 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$
- **/
-
- 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"];
+<?php
+
+/**
+ * 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.
+ *
+ * @version $Id$
+ * @package squirrelmail
+ * @subpackage addressbook
+ */
+
+/** Needs the DB functions */
+if (!include_once('DB.php')) {
+ // same error also in db_prefs.php
+ require_once(SM_PATH . 'functions/display_messages.php');
+ $error = _("Could not include PEAR database functions required for the database backend.") . "<br />\n";
+ $error .= sprintf(_("Is PEAR installed, and is the include path set correctly to find %s?"),
+ '<tt>DB.php</tt>') . "<br />\n";
+ $error .= _("Please contact your system administrator and report this error.");
+ error_box($error, $color);
+ exit;
+}
+
+/**
+ * Undocumented class - stores the addressbook in a sql database
+ * @package squirrelmail
+ */
+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'];
+ }
+
+ if (isset($param['listing'])) {
+ $this->listing = $param['listing'];
+ }