diff options
Diffstat (limited to 'webmail/plugins/new_user_identity')
| -rw-r--r-- | webmail/plugins/new_user_identity/new_user_identity.php | 86 | ||||
| -rw-r--r-- | webmail/plugins/new_user_identity/package.xml | 49 | ||||
| -rw-r--r-- | webmail/plugins/new_user_identity/tests/NewUserIdentity.php | 23 |
3 files changed, 158 insertions, 0 deletions
diff --git a/webmail/plugins/new_user_identity/new_user_identity.php b/webmail/plugins/new_user_identity/new_user_identity.php new file mode 100644 index 0000000..200d9ac --- /dev/null +++ b/webmail/plugins/new_user_identity/new_user_identity.php @@ -0,0 +1,86 @@ +<?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'; + */ +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) { + $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; + if (!$args['user_email'] && strpos($user_email, '@')) { + $args['user_email'] = rcube_idn_to_ascii($user_email); + } + } + } + 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/webmail/plugins/new_user_identity/package.xml b/webmail/plugins/new_user_identity/package.xml new file mode 100644 index 0000000..e50cd92 --- /dev/null +++ b/webmail/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>2012-08-13</date> + <version> + <release>1.0.7</release> + <api>1.1</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> diff --git a/webmail/plugins/new_user_identity/tests/NewUserIdentity.php b/webmail/plugins/new_user_identity/tests/NewUserIdentity.php new file mode 100644 index 0000000..c1d3858 --- /dev/null +++ b/webmail/plugins/new_user_identity/tests/NewUserIdentity.php @@ -0,0 +1,23 @@ +<?php + +class NewUserIdentity_Plugin extends PHPUnit_Framework_TestCase +{ + + function setUp() + { + include_once dirname(__FILE__) . '/../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); + } +} + |