summaryrefslogtreecommitdiff
path: root/plugins/new_user_identity
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/new_user_identity')
-rw-r--r--plugins/new_user_identity/composer.json24
-rw-r--r--plugins/new_user_identity/config.inc.php.dist15
-rw-r--r--plugins/new_user_identity/new_user_identity.php133
-rw-r--r--plugins/new_user_identity/tests/NewUserIdentity.php23
4 files changed, 195 insertions, 0 deletions
diff --git a/plugins/new_user_identity/composer.json b/plugins/new_user_identity/composer.json
new file mode 100644
index 000000000..8378ae50c
--- /dev/null
+++ b/plugins/new_user_identity/composer.json
@@ -0,0 +1,24 @@
+{
+ "name": "roundcube/new_user_identity",
+ "type": "roundcube-plugin",
+ "description": "Populates a new user's default identity from LDAP on their first visit.",
+ "license": "GPLv3+",
+ "version": "1.1",
+ "authors": [
+ {
+ "name": "Aleksander Machniak",
+ "email": "alec@alec.pl",
+ "role": "Lead"
+ }
+ ],
+ "repositories": [
+ {
+ "type": "composer",
+ "url": "http://plugins.roundcube.net"
+ }
+ ],
+ "require": {
+ "php": ">=5.3.0",
+ "roundcube/plugin-installer": ">=0.1.3"
+ }
+}
diff --git a/plugins/new_user_identity/config.inc.php.dist b/plugins/new_user_identity/config.inc.php.dist
new file mode 100644
index 000000000..87f28166b
--- /dev/null
+++ b/plugins/new_user_identity/config.inc.php.dist
@@ -0,0 +1,15 @@
+<?php
+
+// The id of the address book to use to automatically set a
+// user's full name in their new identity. (This should be an
+// string, which refers to the $config['ldap_public'] array.)
+$config['new_user_identity_addressbook'] = 'People';
+
+// When automatically setting a user's full name in their
+// new identity, match the user's login name against this field.
+$config['new_user_identity_match'] = 'uid';
+
+// Determine whether to import user's identities on each login.
+// New user identity will be created for each e-mail address
+// present in address book, but not assigned to any identity.
+$config['new_user_identity_onlogin'] = false;
diff --git a/plugins/new_user_identity/new_user_identity.php b/plugins/new_user_identity/new_user_identity.php
new file mode 100644
index 000000000..b9054880e
--- /dev/null
+++ b/plugins/new_user_identity/new_user_identity.php
@@ -0,0 +1,133 @@
+<?php
+/**
+ * New user identity
+ *
+ * Populates a new user's default identity from LDAP on their first visit.
+ *
+ * This plugin requires that a working public_ldap directory be configured.
+ *
+ * @version @package_version@
+ * @author Kris Steinhoff
+ * @license GNU GPLv3+
+ */
+class new_user_identity extends rcube_plugin
+{
+ public $task = 'login';
+
+ private $rc;
+ private $ldap;
+
+ function init()
+ {
+ $this->rc = rcmail::get_instance();
+
+ $this->add_hook('user_create', array($this, 'lookup_user_name'));
+ $this->add_hook('login_after', array($this, 'login_after'));
+ }
+
+ function lookup_user_name($args)
+ {
+ if ($this->init_ldap($args['host'])) {
+ $results = $this->ldap->search('*', $args['user'], true);
+
+ if (count($results->records) == 1) {
+ $user_name = is_array($results->records[0]['name']) ? $results->records[0]['name'][0] : $results->records[0]['name'];
+ $user_email = is_array($results->records[0]['email']) ? $results->records[0]['email'][0] : $results->records[0]['email'];
+
+ $args['user_name'] = $user_name;
+ $args['email_list'] = array();
+
+ if (!$args['user_email'] && strpos($user_email, '@')) {
+ $args['user_email'] = rcube_utils::idn_to_ascii($user_email);
+ }
+
+ foreach (array_keys($results[0]) as $key) {
+ if (!preg_match('/^email($|:)/', $key)) {
+ continue;
+ }
+
+ foreach ((array) $results->records[0][$key] as $alias) {
+ if (strpos($alias, '@')) {
+ $args['email_list'][] = rcube_utils::idn_to_ascii($alias);
+ }
+ }
+ }
+
+ }
+ }
+
+ return $args;
+ }
+
+ function login_after($args)
+ {
+ $this->load_config();
+
+ if ($this->ldap || !$this->rc->config->get('new_user_identity_onlogin')) {
+ return $args;
+ }
+
+ $identities = $this->rc->user->list_emails();
+ $ldap_entry = $this->lookup_user_name(array(
+ 'user' => $this->rc->user->data['username'],
+ 'host' => $this->rc->user->data['mail_host'],
+ ));
+
+ foreach ((array) $ldap_entry['email_list'] as $email) {
+ foreach ($identities as $identity) {
+ if ($identity['email'] == $email) {
+ continue 2;
+ }
+ }
+
+ $plugin = $this->rc->plugins->exec_hook('identity_create', array(
+ 'login' => true,
+ 'record' => array(
+ 'user_id' => $this->rc->user->ID,
+ 'standard' => 0,
+ 'email' => $email,
+ 'name' => $ldap_entry['user_name']
+ ),
+ ));
+
+ if (!$plugin['abort'] && $plugin['record']['email']) {
+ $this->rc->user->insert_identity($plugin['record']);
+ }
+ }
+ return $args;
+ }
+
+ private function init_ldap($host)
+ {
+ if ($this->ldap) {
+ return $this->ldap->ready;
+ }
+
+ $this->load_config();
+
+ $addressbook = $this->rc->config->get('new_user_identity_addressbook');
+ $ldap_config = (array)$this->rc->config->get('ldap_public');
+ $match = $this->rc->config->get('new_user_identity_match');
+
+ if (empty($addressbook) || empty($match) || empty($ldap_config[$addressbook])) {
+ return false;
+ }
+
+ $this->ldap = new new_user_identity_ldap_backend(
+ $ldap_config[$addressbook],
+ $this->rc->config->get('ldap_debug'),
+ $this->rc->config->mail_domain($host),
+ $match);
+
+ return $this->ldap->ready;
+ }
+}
+
+class new_user_identity_ldap_backend extends rcube_ldap
+{
+ function __construct($p, $debug, $mail_domain, $search)
+ {
+ parent::__construct($p, $debug, $mail_domain);
+ $this->prop['search_fields'] = (array)$search;
+ }
+}
diff --git a/plugins/new_user_identity/tests/NewUserIdentity.php b/plugins/new_user_identity/tests/NewUserIdentity.php
new file mode 100644
index 000000000..21197362e
--- /dev/null
+++ b/plugins/new_user_identity/tests/NewUserIdentity.php
@@ -0,0 +1,23 @@
+<?php
+
+class NewUserIdentity_Plugin extends PHPUnit_Framework_TestCase
+{
+
+ function setUp()
+ {
+ include_once __DIR__ . '/../new_user_identity.php';
+ }
+
+ /**
+ * Plugin object construction test
+ */
+ function test_constructor()
+ {
+ $rcube = rcube::get_instance();
+ $plugin = new new_user_identity($rcube->api);
+
+ $this->assertInstanceOf('new_user_identity', $plugin);
+ $this->assertInstanceOf('rcube_plugin', $plugin);
+ }
+}
+