From bcedf05d19ba1b2f63bdbfe42ff2c726fc50b6b6 Mon Sep 17 00:00:00 2001
From: Aleksander Machniak <alec@alec.pl>
Date: Tue, 20 Aug 2013 13:23:59 -0400
Subject: [PATCH] s/$rcmail_config/$config/ also for plugins configuration
---
plugins/virtuser_query/virtuser_query.php | 160 +++++++++++++++++++++++++++++++++++++++++++++--------
1 files changed, 136 insertions(+), 24 deletions(-)
diff --git a/plugins/virtuser_query/virtuser_query.php b/plugins/virtuser_query/virtuser_query.php
index 803c270..a0b7482 100644
--- a/plugins/virtuser_query/virtuser_query.php
+++ b/plugins/virtuser_query/virtuser_query.php
@@ -3,30 +3,58 @@
/**
* DB based User-to-Email and Email-to-User lookup
*
- * Add it to the plugins list in config/main.inc.php and set
- * SQL query to resolve user names and e-mail addresses from the database
+ * Add it to the plugins list in config.inc.php and set
+ * SQL queries to resolve usernames, e-mail addresses and hostnames from the database
* %u will be replaced with the current username for login.
- * The query should select the user's e-mail address as first column
- * and optional identity name as second column
- * $rcmail_config['virtuser_query'] = '';
+ * %m will be replaced with the current e-mail address for login.
*
- * @version 1.0
- * @author Aleksander Machniak
+ * Queries should select the user's e-mail address, username or the imap hostname as first column
+ * The email query could optionally select identity data columns in specified order:
+ * name, organization, reply-to, bcc, signature, html_signature
+ *
+ * $config['virtuser_query'] = array('email' => '', 'user' => '', 'host' => '', 'alias' => '');
+ *
+ * The email query can return more than one record to create more identities.
+ * This requires identities_level option to be set to value less than 2.
+ *
+ * By default Roundcube database is used. To use different database (or host)
+ * you can specify DSN string in $config['virtuser_query_dsn'] option.
+ *
+ * @version @package_version@
+ * @author Aleksander Machniak <alec@alec.pl>
+ * @author Steffen Vogel
+ * @author Tim Gerundt
+ * @license GNU GPLv3+
*/
class virtuser_query extends rcube_plugin
{
- private $query;
+ private $config;
private $app;
+ private $db;
function init()
{
- $this->app = rcmail::get_instance();
- $this->query = $this->app->config->get('virtuser_query');
+ $this->app = rcmail::get_instance();
+ $this->config = $this->app->config->get('virtuser_query');
- if ($this->query) {
- $this->add_hook('user2email', array($this, 'user2email'));
-// $this->add_hook('email2user', array($this, 'email2user'));
- }
+ if (!empty($this->config)) {
+ if (is_string($this->config)) {
+ $this->config = array('email' => $this->config);
+ }
+
+ if ($this->config['email']) {
+ $this->add_hook('user2email', array($this, 'user2email'));
+ }
+ if ($this->config['user']) {
+ $this->add_hook('email2user', array($this, 'email2user'));
+ }
+ if ($this->config['host']) {
+ $this->add_hook('authenticate', array($this, 'user2host'));
+ }
+ if ($this->config['alias']) {
+ $this->add_hook('authenticate', array($this, 'alias2user'));
+ }
+ }
}
/**
@@ -34,20 +62,104 @@
*/
function user2email($p)
{
- $dbh = $rcmail->get_dbh();
+ $dbh = $this->get_dbh();
- $sql_result = $dbh->query(preg_replace('/%u/', $dbh->escapeSimple($p['user']), $this->query));
+ $sql_result = $dbh->query(preg_replace('/%u/', $dbh->escape($p['user']), $this->config['email']));
- while ($sql_arr = $dbh->fetch_array($sql_result)) {
- if (strpos($sql_arr[0], '@')) {
- $result[] = ($p['extended'] && count($sql_arr) > 1) ? $sql_arr : $sql_arr[0];
+ while ($sql_arr = $dbh->fetch_array($sql_result)) {
+ if (strpos($sql_arr[0], '@')) {
+ if ($p['extended'] && count($sql_arr) > 1) {
+ $result[] = array(
+ 'email' => rcube_utils::idn_to_ascii($sql_arr[0]),
+ 'name' => $sql_arr[1],
+ 'organization' => $sql_arr[2],
+ 'reply-to' => rcube_utils::idn_to_ascii($sql_arr[3]),
+ 'bcc' => rcube_utils::idn_to_ascii($sql_arr[4]),
+ 'signature' => $sql_arr[5],
+ 'html_signature' => (int)$sql_arr[6],
+ );
+ }
+ else {
+ $result[] = $sql_arr[0];
+ }
- if ($p['first'])
- return $result[0];
- }
- }
+ if ($p['first']) {
+ break;
+ }
+ }
+ }
- return $p;
+ $p['email'] = $result;
+
+ return $p;
+ }
+
+ /**
+ * EMail > User
+ */
+ function email2user($p)
+ {
+ $dbh = $this->get_dbh();
+
+ $sql_result = $dbh->query(preg_replace('/%m/', $dbh->escape($p['email']), $this->config['user']));
+
+ if ($sql_arr = $dbh->fetch_array($sql_result)) {
+ $p['user'] = $sql_arr[0];
+ }
+
+ return $p;
+ }
+
+ /**
+ * User > Host
+ */
+ function user2host($p)
+ {
+ $dbh = $this->get_dbh();
+
+ $sql_result = $dbh->query(preg_replace('/%u/', $dbh->escape($p['user']), $this->config['host']));
+
+ if ($sql_arr = $dbh->fetch_array($sql_result)) {
+ $p['host'] = $sql_arr[0];
+ }
+
+ return $p;
+ }
+
+ /**
+ * Alias > User
+ */
+ function alias2user($p)
+ {
+ $dbh = $this->get_dbh();
+
+ $sql_result = $dbh->query(preg_replace('/%u/', $dbh->escape($p['user']), $this->config['alias']));
+
+ if ($sql_arr = $dbh->fetch_array($sql_result)) {
+ $p['user'] = $sql_arr[0];
+ }
+
+ return $p;
+ }
+
+ /**
+ * Initialize database handler
+ */
+ function get_dbh()
+ {
+ if (!$this->db) {
+ if ($dsn = $this->app->config->get('virtuser_query_dsn')) {
+ // connect to the virtuser database
+ $this->db = rcube_db::factory($dsn);
+ $this->db->set_debug((bool)$this->app->config->get('sql_debug'));
+ $this->db->db_connect('r'); // connect in read mode
+ }
+ else {
+ $this->db = $this->app->get_dbh();
+ }
+ }
+
+ return $this->db;
}
}
--
Gitblit v1.9.1