+ /* Return a sorted search */
+ function s_search($expression, $bnum = -1) {
+
+ $ret = $this->search($expression, $bnum);
+ if ( is_array( $ret ) ) {
+ usort($ret, 'addressbook_cmp');
+ }
+ return $ret;
+ }
+
+
+ /*
+ * Lookup an address by alias. Only possible in
+ * local backends.
+ */
+ function lookup($alias, $bnum = -1) {
+
+ $ret = array();
+
+ if ($bnum > -1) {
+ $res = $this->backends[$bnum]->lookup($alias);
+ if (is_array($res)) {
+ return $res;
+ } else {
+ $this->error = $backend->error;
+ return false;
+ }
+ }
+
+ $sel = $this->get_backend_list('local');
+ for ($i = 0 ; $i < sizeof($sel) ; $i++) {
+ $backend = &$sel[$i];
+ $backend->error = '';
+ $res = $backend->lookup($alias);
+ if (is_array($res)) {
+ if(!empty($res))
+ return $res;
+ } else {
+ $this->error = $backend->error;
+ return false;
+ }
+ }
+
+ return $ret;
+ }
+
+
+ /* Return all addresses */
+ function list_addr($bnum = -1) {
+ $ret = array();
+
+ if ($bnum == -1) {
+ $sel = $this->get_backend_list('local');
+ } else {
+ $sel = array(0 => &$this->backends[$bnum]);
+ }
+
+ for ($i = 0 ; $i < sizeof($sel) ; $i++) {
+ $backend = &$sel[$i];
+ $backend->error = '';
+ $res = $backend->list_addr();
+ if (is_array($res)) {
+ $ret = array_merge($ret, $res);
+ } else {
+ $this->error = $backend->error;
+ return false;
+ }
+ }
+
+ return $ret;
+ }
+
+ /*
+ * Create a new address from $userdata, in backend $bnum.
+ * Return the backend number that the/ address was added
+ * to, or false if it failed.
+ */
+ function add($userdata, $bnum) {
+
+ /* Validate data */
+ if (!is_array($userdata)) {
+ $this->error = _("Invalid input data");
+ return false;
+ }
+ if (empty($userdata['firstname']) && empty($userdata['lastname'])) {
+ $this->error = _("Name is missing");
+ return false;
+ }
+ if (empty($userdata['email'])) {
+ $this->error = _("E-mail address is missing");
+ return false;
+ }
+ if (empty($userdata['nickname'])) {
+ $userdata['nickname'] = $userdata['email'];
+ }
+
+ if (eregi('[ \\:\\|\\#\\"\\!]', $userdata['nickname'])) {
+ $this->error = _("Nickname contains illegal characters");
+ return false;
+ }
+
+ /* Check that specified backend accept new entries */
+ if (!$this->backends[$bnum]->writeable) {
+ $this->error = _("Addressbook is read-only");
+ return false;
+ }
+
+ /* Add address to backend */
+ $res = $this->backends[$bnum]->add($userdata);
+ if ($res) {
+ return $bnum;
+ } else {
+ $this->error = $this->backends[$bnum]->error;
+ return false;
+ }
+
+ return false; // Not reached
+ } /* end of add() */
+
+
+ /*
+ * Remove the user identified by $alias from backend $bnum
+ * If $alias is an array, all users in the array are removed.
+ */
+ function remove($alias, $bnum) {
+
+ /* Check input */
+ if (empty($alias)) {
+ return true;
+ }
+
+ /* Convert string to single element array */
+ if (!is_array($alias)) {
+ $alias = array(0 => $alias);
+ }
+
+ /* Check that specified backend is writeable */
+ if (!$this->backends[$bnum]->writeable) {
+ $this->error = _("Addressbook is read-only");
+ return false;
+ }
+
+ /* Remove user from backend */
+ $res = $this->backends[$bnum]->remove($alias);
+ if ($res) {
+ return $bnum;
+ } else {
+ $this->error = $this->backends[$bnum]->error;
+ return false;
+ }
+
+ return FALSE; /* Not reached */
+ } /* end of remove() */
+
+
+ /*
+ * Remove the user identified by $alias from backend $bnum
+ * If $alias is an array, all users in the array are removed.
+ */
+ function modify($alias, $userdata, $bnum) {
+
+ /* Check input */
+ if (empty($alias) || !is_string($alias)) {
+ return true;
+ }
+
+ /* Validate data */
+ if(!is_array($userdata)) {
+ $this->error = _("Invalid input data");
+ return false;
+ }
+ if (empty($userdata['firstname']) && empty($userdata['lastname'])) {
+ $this->error = _("Name is missing");
+ return false;
+ }
+ if (empty($userdata['email'])) {
+ $this->error = _("E-mail address is missing");
+ return false;
+ }
+
+ if (eregi('[\\: \\|\\#"\\!]', $userdata['nickname'])) {
+ $this->error = _("Nickname contains illegal characters");
+ return false;
+ }
+
+ if (empty($userdata['nickname'])) {
+ $userdata['nickname'] = $userdata['email'];
+ }
+
+ /* Check that specified backend is writeable */
+ if (!$this->backends[$bnum]->writeable) {
+ $this->error = _("Addressbook is read-only");;
+ return false;
+ }
+
+ /* Modify user in backend */
+ $res = $this->backends[$bnum]->modify($alias, $userdata);
+ if ($res) {
+ return $bnum;
+ } else {
+ $this->error = $this->backends[$bnum]->error;
+ return false;
+ }
+
+ return FALSE; /* Not reached */
+ } /* end of modify() */
+
+
+} /* End of class Addressbook */
+
+/**
+ * Generic backend that all other backends extend
+ * @package squirrelmail
+ */
+class addressbook_backend {
+
+ /* Variables that all backends must provide. */
+ var $btype = 'dummy';
+ var $bname = 'dummy';
+ var $sname = 'Dummy backend';
+
+ /*
+ * Variables common for all backends, but that
+ * should not be changed by the backends.
+ */
+ var $bnum = -1;
+ var $error = '';
+ var $writeable = false;
+
+ function set_error($string) {
+ $this->error = '[' . $this->sname . '] ' . $string;
+ return false;
+ }
+
+
+ /* ========================== Public ======================== */
+
+ function search($expression) {
+ $this->set_error('search not implemented');
+ return false;
+ }
+
+ function lookup($alias) {
+ $this->set_error('lookup not implemented');
+ return false;
+ }
+
+ function list_addr() {
+ $this->set_error('list_addr not implemented');
+ return false;
+ }
+
+ function add($userdata) {
+ $this->set_error('add not implemented');
+ return false;
+ }
+
+ function remove($alias) {
+ $this->set_error('delete not implemented');
+ return false;
+ }
+
+ function modify($alias, $newuserdata) {
+ $this->set_error('modify not implemented');
+ return false;
+ }
+
+}
+
+/**
+ * Sort array by the key "name"
+ */
+function alistcmp($a,$b) {
+ $abook_sort=get_abook_sort();
+
+ if ($a['backend'] > $b['backend']) {
+ return 1;
+ } else {
+ if ($a['backend'] < $b['backend']) {
+ return -1;
+ }
+ }
+ return (strtolower($a[$abook_sort]) > strtolower($b[$abook_sort])) ? 1 : -1;
+}
+
+/**
+ * Address book sorting order
+ *
+ * returns name of field that should be used for sorting.
+ * @return string name of address book field
+ */
+function get_abook_sort() {
+ global $data_dir, $username;
+
+ /* get sorting order */
+ if(sqgetGlobalVar('abook_sort', $abook_sort,SQ_GET)) {
+ sqgetGlobalVar('abook_sort', $abook_sort,SQ_GET);
+ setPref($data_dir, $username, 'abook_sort', $abook_sort);
+ } else {
+ $abook_sort = getPref($data_dir, $username, 'abook_sort', 'name');
+ }
+
+ if ($abook_sort != "nickname" && $abook_sort != "email" && $abook_sort != "label")
+ $abook_sort = "name";
+
+ return $abook_sort;
+}
+
+/*
+ PHP 5 requires that the class be made first, which seems rather
+ logical, and should have been the way it was generated the first time.
+*/
+
+require_once(SM_PATH . 'functions/abook_local_file.php');
+require_once(SM_PATH . 'functions/abook_ldap_server.php');
+
+/* Use this if you wanna have a global address book */
+if (isset($address_book_global_filename)) {
+ include_once(SM_PATH . 'functions/abook_global_file.php');
+}
+
+/* Only load database backend if database is configured */
+if((isset($addrbook_dsn) && !empty($addrbook_dsn)) ||
+ (isset($addrbook_global_dsn) && !empty($addrbook_global_dsn)) ) {
+ include_once(SM_PATH . 'functions/abook_database.php');
+}
+
+/*
+ * hook allows adding different address book classes.
+ * class must follow address book class coding standards.
+ *
+ * see addressbook_backend class and functions/abook_*.php files.
+ */
+do_hook('abook_add_class');