mirror of
https://github.com/the-djmaze/snappymail.git
synced 2025-09-07 13:44:13 +08:00
a53d7383db
Use common LDAP terminology and update comments to reflect how the configuration options work (e.g. that all the LDAP attribute options are multivalued).
109 lines
4.4 KiB
PHP
109 lines
4.4 KiB
PHP
<?php
|
|
|
|
class LdapContactsSuggestionsPlugin extends \RainLoop\Plugins\AbstractPlugin
|
|
{
|
|
const
|
|
NAME = 'Contacts suggestions (LDAP)',
|
|
VERSION = '2.0',
|
|
CATEGORY = 'Security',
|
|
DESCRIPTION = 'Plugin that adds functionality to get contacts from LDAP on compose page.';
|
|
|
|
public function Init() : void
|
|
{
|
|
$this->addHook('main.fabrica', 'MainFabrica');
|
|
}
|
|
|
|
/**
|
|
* @return string
|
|
*/
|
|
public function Supported() : string
|
|
{
|
|
if (!\function_exists('ldap_connect'))
|
|
{
|
|
return 'The LDAP PHP extension must be installed to use this plugin';
|
|
}
|
|
|
|
return '';
|
|
}
|
|
|
|
/**
|
|
* @param string $sName
|
|
* @param mixed $mResult
|
|
*/
|
|
public function MainFabrica($sName, &$mResult)
|
|
{
|
|
switch ($sName)
|
|
{
|
|
case 'suggestions':
|
|
|
|
if (!\is_array($mResult))
|
|
{
|
|
$mResult = array();
|
|
}
|
|
|
|
$sHostName = \trim($this->Config()->Get('plugin', 'hostname', ''));
|
|
$iHostPort = (int) $this->Config()->Get('plugin', 'port', 389);
|
|
$bUseStartTLS = (bool) $this->Config()->Get('plugin', 'use_start_tls', True);
|
|
$sAccessDn = \trim($this->Config()->Get('plugin', 'access_dn', ''));
|
|
$sAccessPassword = \trim($this->Config()->Get('plugin', 'access_password', ''));
|
|
$sUsersDn = \trim($this->Config()->Get('plugin', 'users_dn_format', ''));
|
|
$sObjectClass = \trim($this->Config()->Get('plugin', 'object_class', ''));
|
|
$sUidField = \trim($this->Config()->Get('plugin', 'uid_field', ''));
|
|
$sNameField = \trim($this->Config()->Get('plugin', 'name_field', ''));
|
|
$sEmailField = \trim($this->Config()->Get('plugin', 'mail_field', ''));
|
|
$sAllowedEmails = \trim($this->Config()->Get('plugin', 'allowed_emails', ''));
|
|
|
|
if (0 < \strlen($sUsersDn) && 0 < \strlen($sObjectClass) && 0 < \strlen($sEmailField))
|
|
{
|
|
include_once __DIR__.'/LdapContactsSuggestions.php';
|
|
|
|
$oProvider = new LdapContactsSuggestions();
|
|
$oProvider->SetConfig($sHostName, $iHostPort, $bUseStartTLS, $sAccessDn, $sAccessPassword, $sUsersDn, $sObjectClass, $sUidField, $sNameField, $sEmailField, $sAllowedEmails);
|
|
|
|
$mResult[] = $oProvider;
|
|
}
|
|
|
|
break;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @return array
|
|
*/
|
|
protected function configMapping() : array
|
|
{
|
|
return array(
|
|
\RainLoop\Plugins\Property::NewInstance('hostname')->SetLabel('LDAP hostname')
|
|
->SetDefaultValue('127.0.0.1'),
|
|
\RainLoop\Plugins\Property::NewInstance('port')->SetLabel('LDAP port')
|
|
->SetType(\RainLoop\Enumerations\PluginPropertyType::INT)
|
|
->SetDefaultValue(389),
|
|
\RainLoop\Plugins\Property::NewInstance('use_start_tls')->SetLabel('Use StartTLS')
|
|
->SetType(\RainLoop\Enumerations\PluginPropertyType::BOOL)
|
|
->SetDefaultValue(True),
|
|
\RainLoop\Plugins\Property::NewInstance('access_dn')->SetLabel('Bind DN')
|
|
->SetDescription('DN to bind (login) with. If left blank, anonymous bind will be tried and the password will be ignored')
|
|
->SetDefaultValue(''),
|
|
\RainLoop\Plugins\Property::NewInstance('access_password')->SetLabel('Bind password')
|
|
->SetType(\RainLoop\Enumerations\PluginPropertyType::PASSWORD)
|
|
->SetDefaultValue(''),
|
|
\RainLoop\Plugins\Property::NewInstance('users_dn_format')->SetLabel('Search base DN')
|
|
->SetDescription('DN to use as the search base. Supported tokens: {domain}, {domain:dc}, {email}, {email:user}, {email:domain}, {login}, {imap:login}, {imap:host}, {imap:port}')
|
|
->SetDefaultValue('ou=People,dc=domain,dc=com'),
|
|
\RainLoop\Plugins\Property::NewInstance('object_class')->SetLabel('objectClass value')
|
|
->SetDefaultValue('inetOrgPerson'),
|
|
\RainLoop\Plugins\Property::NewInstance('uid_field')->SetLabel('uid attributes')
|
|
->SetDescription('LDAP attributes for userids, comma separated list in order of preference')
|
|
->SetDefaultValue('uid'),
|
|
\RainLoop\Plugins\Property::NewInstance('name_field')->SetLabel('Name attributes')
|
|
->SetDescription('LDAP attributes for user names, comma separated list in order of preference')
|
|
->SetDefaultValue('givenName'),
|
|
\RainLoop\Plugins\Property::NewInstance('mail_field')->SetLabel('Mail attributes')
|
|
->SetDescription('LDAP attributes for user email addresses, comma separated list in order of preference')
|
|
->SetDefaultValue('mail'),
|
|
\RainLoop\Plugins\Property::NewInstance('allowed_emails')->SetLabel('Allowed emails')
|
|
->SetDescription('Email addresses of users which should be allowed to do LDAP lookups, space as delimiter, wildcard supported. Example: user1@domain1.net user2@domain1.net *@domain2.net')
|
|
->SetDefaultValue('*')
|
|
);
|
|
}
|
|
}
|