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/new_user_identity.php89
-rw-r--r--plugins/new_user_identity/package.xml49
2 files changed, 138 insertions, 0 deletions
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..7b67578bf
--- /dev/null
+++ b/plugins/new_user_identity/new_user_identity.php
@@ -0,0 +1,89 @@
+<?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
+ *
+ * Example configuration:
+ *
+ * // The id of the address book to use to automatically set a new
+ * // user's full name in their new identity. (This should be an
+ * // string, which refers to the $rcmail_config['ldap_public'] array.)
+ * $rcmail_config['new_user_identity_addressbook'] = 'People';
+ *
+ * // When automatically setting a new users's full name in their
+ * // new identity, match the user's login name against this field.
+ * $rcmail_config['new_user_identity_match'] = 'uid';
+ *
+ * // Use this field (from fieldmap configuration) to fill alias col of
+ * // the new user record.
+ * $rcmail_config['new_user_identity_alias'] = 'alias';
+ */
+class new_user_identity extends rcube_plugin
+{
+ public $task = 'login';
+
+ private $ldap;
+
+ function init()
+ {
+ $this->add_hook('user_create', array($this, 'lookup_user_name'));
+ }
+
+ function lookup_user_name($args)
+ {
+ $rcmail = rcmail::get_instance();
+
+ if ($this->init_ldap($args['host'])) {
+ $results = $this->ldap->search('*', $args['user'], TRUE);
+ if (count($results->records) == 1) {
+ $args['user_name'] = $results->records[0]['name'];
+ if (!$args['user_email'] && strpos($results->records[0]['email'], '@')) {
+ $args['user_email'] = rcube_idn_to_ascii($results->records[0]['email']);
+ }
+ if (($alias_col = $rcmail->config->get('new_user_identity_alias')) && $results->records[0][$alias_col]) {
+ $args['alias'] = $results->records[0][$alias_col];
+ }
+ }
+ }
+ return $args;
+ }
+
+ private function init_ldap($host)
+ {
+ if ($this->ldap)
+ return $this->ldap->ready;
+
+ $rcmail = rcmail::get_instance();
+
+ $addressbook = $rcmail->config->get('new_user_identity_addressbook');
+ $ldap_config = (array)$rcmail->config->get('ldap_public');
+ $match = $rcmail->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],
+ $rcmail->config->get('ldap_debug'),
+ $rcmail->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/package.xml b/plugins/new_user_identity/package.xml
new file mode 100644
index 000000000..95f1dc0dc
--- /dev/null
+++ b/plugins/new_user_identity/package.xml
@@ -0,0 +1,49 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<package xmlns="http://pear.php.net/dtd/package-2.0" xmlns:tasks="http://pear.php.net/dtd/tasks-1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" packagerversion="1.9.0" version="2.0" xsi:schemaLocation="http://pear.php.net/dtd/tasks-1.0
+ http://pear.php.net/dtd/tasks-1.0.xsd
+ http://pear.php.net/dtd/package-2.0
+ http://pear.php.net/dtd/package-2.0.xsd">
+ <name>new_user_identity</name>
+ <channel>pear.roundcube.net</channel>
+ <summary>Populates a new user's default identity from LDAP on their first visit.</summary>
+ <description>
+ Populates a new user's default identity from LDAP on their first visit.
+ </description>
+ <lead>
+ <name>Aleksander Machniak</name>
+ <user>alec</user>
+ <email>alec@alec.pl</email>
+ <active>yes</active>
+ </lead>
+ <date>2011-11-21</date>
+ <version>
+ <release>1.0.5</release>
+ <api>1.0</api>
+ </version>
+ <stability>
+ <release>stable</release>
+ <api>stable</api>
+ </stability>
+ <license uri="http://www.gnu.org/licenses/gpl-2.0.html">GNU GPLv2</license>
+ <notes>-</notes>
+ <contents>
+ <dir baseinstalldir="/" name="/">
+ <file name="new_user_identity.php" role="php">
+ <tasks:replace from="@name@" to="name" type="package-info"/>
+ <tasks:replace from="@package_version@" to="version" type="package-info"/>
+ </file>
+ </dir>
+ <!-- / -->
+ </contents>
+ <dependencies>
+ <required>
+ <php>
+ <min>5.2.1</min>
+ </php>
+ <pearinstaller>
+ <min>1.7.0</min>
+ </pearinstaller>
+ </required>
+ </dependencies>
+ <phprelease/>
+</package>