LDAP suggestions

Thanks to Djip007

conf/data/configs/application.ini

@@ -138,7 +138,7 @@ sign_me_auto = "DefaultOff"
 enable = On
 
 ; List of enabled plugins
-enabled_list = "ynh-login-mapping"
+enabled_list = "PLUGINSTOENABLE"
 
 [defaults]
 ; Editor mode used by default (Plain, Html, HtmlForced or PlainForced)

manifest.json

@@ -48,6 +48,15 @@
                     "en": "Choose a strong password for the 'admin' user",
                     "fr": "Choisissez un mot de passe fort pour l'administrateur 'admin'"
                 }
+			},
+			{
+               "name": "ldap",
+                "ask": {
+                    "en": "Do you want to add YunoHost users to the recipients suggestions?",
+                    "fr": "Souhaitez-vous ajouter les utilisateurs YunoHost dans les suggestions de destinataires ?"
+                },
+                "choices": ["Yes", "No"],
+                "default": "Yes"
 			}
         ]
     }

scripts/install

@@ -1,5 +1,5 @@
 #!/bin/bash
-
+set -e
 app=rainloop
 
 # Retrieve arguments
@@ -7,17 +7,13 @@ domain=$1
 	path=$2
 	is_public=$3
 	password=$4
+	ldap=$5
 
 # Removal of trailing /
 	if [ $path = "/" ]
 	then
-	#sitename="root"
 		echo "Installation on the root of the domain"
 	else
-	# sitename == path without any "/"
-	#sitename=$(echo $path | cut -d '/' -f 2)
-	# Removal of trailing /
-	# path can be null but not really an issue for the remaining commands
 		path=${path%/}
 	fi
 
@@ -27,22 +23,15 @@ if [[ ! $? -eq 0 ]]; then
 		exit 1
 	fi
 
-# Generate random password
+# Generate random password, use 'rainloop' as database name and user and intialize databse
 	db_pwd=$(dd if=/dev/urandom bs=1 count=200 2> /dev/null | tr -c -d 'A-Za-z0-9' | sed -n 's/\(.\{24\}\).*/\1/p')
-
-# Use 'rainloop' as database name and user
 	db_user=$app
-
-# Initialize database and store mysql password for upgrade
 	sudo yunohost app initdb $db_user -p $db_pwd
-sudo yunohost app setting rainloop mysqlpwd -v $db_pwd
+	sudo yunohost app setting $app mysqlpwd -v $db_pwd
 
-#mysql -u $db_user -p$db_pwd $db_user < ../sources/plugins/automatic_addressbook/SQL/mysql.initial.sql
+# Create the final path and copy sources
-
-# Copy files to the right place
 	final_path=/var/www/$app
 	rainloop_path=${final_path}/app
-#rainloop_path=${final_path}
 
 	sudo rm -rf $final_path
 	sudo mkdir -p $final_path
@@ -51,20 +40,37 @@ sudo mkdir -p $rainloop_path
 	# Use of latest community edition
 	sudo unzip ../sources/rainloop-community.zip -d $rainloop_path/
 	
+	# Install plugins
+	sudo mkdir -p $rainloop_path/data/_data_/_default_/plugins
+	sudo cp -rf ../sources/plugins/ynh-login-mapping $rainloop_path/data/_data_/_default_/plugins/.
+	sudo cp -rf ../sources/plugins/ynh-ldap-addressbooks $rainloop_path/data/_data_/_default_/plugins/.
+
 # Autoconfig
 	sudo mkdir -p $rainloop_path/data/_data_/_default_/configs/
 	application_file=$rainloop_path/data/_data_/_default_/configs/application.ini
+
+	# Set lang
 	if [ $(echo $LANG | cut -c1-2) == "fr" ]
 	then
 		lang=fr
 	else
 		lang=en
 	fi
+	
+	# Set plugins
+	plugins="ynh-login-mapping"
+	if [ "$ldap" = "Yes" ];
+	then
+		plugins="$plugins,ynh-ldap-addressbooks"
+	fi
+	sudo yunohost app setting $app plugins -v $plugins
+	
 	sudo cp ../conf/data/configs/application.ini $application_file
 	sudo sed -i "s@domain.tld@$domain@g"         $application_file
 	sudo sed -i "s@MYSQLUSER@$db_user@g"         $application_file
 	sudo sed -i "s@MYSQLPASSWORD@$db_pwd@g"      $application_file
 	sudo sed -i "s@LANGTOCHANGE@$lang@g"         $application_file
+	sudo sed -i "s@PLUGINSTOENABLE@$plugins@g"   $application_file
 
 # Set admin password
 	sudo php ../conf/config.php --index="$rainloop_path/index.php" --password="$password"
@@ -80,14 +86,9 @@ for alldomain in $alldomains ; do
 	done
 	sudo cp ../conf/data/domains/disabled $rainloop_path/data/_data_/_default_/domains/disabled
 
-# now install ynh plugins:
-sudo mkdir -p $rainloop_path/data/_data_/_default_/plugins
-sudo cp -rf ../sources/plugins/ynh-login-mapping $rainloop_path/data/_data_/_default_/plugins/.
-
-
 # Hooks for domains are not implemented yet, so new domains will not be added automatically
 
-# install SSO and auto version
+# install SSO and auto version - at the moment the index is the SSO and rainloop is installed in /app
 	if [ $final_path == $rainloop_path ]
 	then
 		# use modified version of master index.php that implement sso
@@ -125,7 +126,6 @@ then
 		sudo yunohost app setting $app skipped_uris -v "/"
 	fi
 
-
 # Reload Nginx and regenerate SSOwat conf
 	sudo service php5-fpm reload
 	sudo service nginx reload

scripts/remove

@@ -1,5 +1,5 @@
 #!/bin/bash
-
+set -e
 app=rainloop
 
 db_user=$app

scripts/upgrade

@@ -1,5 +1,5 @@
 #!/bin/bash
-
+set -e
 app=rainloop
 
 # Retrieve arguments
@@ -8,32 +8,31 @@ path=$(sudo yunohost app setting $app path)
 	is_public=$(sudo yunohost app setting $app is_public)
 	dp_pwd=$(sudo yunohost app setting $app mysqlpwd)
 	db_user=$app
+	plugins=$(sudo yunohost app setting $app plugins)
 
 # no update for db now...
-#root_pwd=$(sudo cat /etc/yunohost/mysql)
-#mysql -u root -p$root_pwd -e "DROP DATABASE $db_name ; DROP USER $db_user@localhost ;"
-#sudo yunohost app initdb $db_user -p $db_pwd
 
-# Copy files to the right place
+# Create the final path and copy sources
 	final_path=/var/www/$app
 	rainloop_path=${final_path}/app
-#rainloop_path=${final_path}
 
-# no delete... we keep old install, the new is in a new path
+	# the old version is not deleted... the new version is in a new path
-#sudo rm -rf $final_path
-#sudo mkdir -p $final_path
-#sudo mkdir -p $rainloop_path
 
 	# Use of latest community edition
 	sudo unzip ../sources/rainloop-community.zip -d $rainloop_path/
 	
-# update patch to auto load version.
+	# Install plugins
-sudo cp ../sources/patch/index_auto_version.php $rainloop_path/index.php
-
-# update ynh plugins:
 	sudo mkdir -p $rainloop_path/data/_data_/_default_/plugins
 	sudo cp -rf ../sources/plugins/ynh-login-mapping $rainloop_path/data/_data_/_default_/plugins/.
 
+	# Update patch to auto load version
+	sudo cp ../sources/patch/index_auto_version.php $rainloop_path/index.php
+
+	# Update ynh plugins:
+	sudo mkdir -p $rainloop_path/data/_data_/_default_/plugins
+	sudo cp -rf ../sources/plugins/ynh-login-mapping $rainloop_path/data/_data_/_default_/plugins/.
+	sudo cp -rf ../sources/plugins/ynh-ldap-addressbooks $rainloop_path/data/_data_/_default_/plugins/.
+
 # update SSO and auto version
 	if [ $final_path == $rainloop_path ]
 	then

sources/plugins/ynh-ldap-addressbooks/README

@@ -0,0 +1 @@
+Plugin which allows to suggess email from ynh ldap

sources/plugins/ynh-ldap-addressbooks/VERSION

@@ -0,0 +1 @@
+0.1

sources/plugins/ynh-ldap-addressbooks/YnhLdapAddressbooks.php

@@ -0,0 +1,170 @@
+<?php
+class YnhLdapAddressbooks implements \RainLoop\Providers\Suggestions\ISuggestions {
+	
+	/**
+	 *
+	 * @var \MailSo\Log\Logger
+	 */
+	private $oLogger = null;
+	
+	/**
+	 *
+	 * @param \RainLoop\Model\Account $oAccount        	
+	 * @param string $sQuery        	
+	 * @param int $iLimit
+	 *        	= 20
+	 *        	
+	 * @return array
+	 */
+	public function Process($oAccount, $sQuery, $iLimit = 20) {
+		$sQuery = \trim ( $sQuery );
+		
+		if ('' === $sQuery || ! $oAccount) {
+			return array ();
+		}
+		
+		$aResult = $this->ldapSearch ( $oAccount, $sQuery, $iLimit );
+		
+		$aResult = \RainLoop\Utils::RemoveSuggestionDuplicates ( $aResult );
+		if ($iLimit < \count ( $aResult )) {
+			$aResult = \array_slice ( $aResult, 0, $iLimit );
+		}
+		
+		return $aResult;
+	}
+	
+	/**
+	 *
+	 * OK search in ldap.
+	 * match email or displayName...
+	 *
+	 * @param \RainLoop\Model\Account $oAccount        	
+	 * @param string $sQuery        	
+	 *
+	 * @return array
+	 */
+	private function ldapSearch($oAccount, $sQuery, $iLimit) {
+		$sSearchEscaped = $this->escape ( $sQuery );
+		
+		$aResult = array ();
+		$oCon = @\ldap_connect ();
+		if (! $oCon) {
+			$this->oLogger->Write ( 'YnhLdapAddressbooks: Could not connect to LDAP server', \MailSo\Log\Enumerations\Type::ERROR );
+			return $aResult;
+		}
+		
+		@\ldap_set_option ( $oCon, LDAP_OPT_PROTOCOL_VERSION, 3 );
+		
+		if (! ldap_bind ( $oCon )) {
+			// bizard... ca renvoie false.... mais ca marche....
+			// $this->logLdapError ( $oCon, 'ldap_bind' );
+			// $this->Manager()->Actions()->Logger()->Write('YnhLdapAdressbooks: Could not bind to LDAP server', \MailSo\Log\Enumerations\Type::ERROR);
+			// return $aResult;
+		}
+		
+		$this->oLogger->Write ( 'YnhLdapAddressbooks: connected to LDAP', \MailSo\Log\Enumerations\Type::INFO, 'LDAP' );
+		
+		$sSearchDn = 'dc=yunohost,dc=org';
+		
+		// on veut chercher parmis mail et nom utilisateur...
+		$sFilter = '(&(objectClass=inetOrgPerson)';
+		$sFilter .= '(|';
+		$sFilter .= '(mail=*' . $sSearchEscaped . '*)';
+		$sFilter .= '(displayName=*' . $sSearchEscaped . '*)';
+		$sFilter .= '))';
+		
+		$aItems = array (
+				'mail',
+				'displayName' 
+		);
+		
+		$this->oLogger->Write ( 'YnhLdapAddressbooks: ldap_search : ' . $sSearchDn . ' / ' . $sFilter, \MailSo\Log\Enumerations\Type::INFO, 'LDAP' );
+		
+		$oS = @\ldap_search ( $oCon, $sSearchDn, $sFilter, $aItems, 0, $iLimit, $iLimit );
+		if ($oS) {
+			$aEntries = @\ldap_get_entries ( $oCon, $oS );
+			$this->oLogger->Write ( 'YnhLdapAddressbooks: ldap_search => ' . var_export ( $aEntries ), \MailSo\Log\Enumerations\Type::INFO, 'LDAP' );
+			
+			if (is_array ( $aEntries )) {
+				if (isset ( $aEntries ['count'] )) {
+					unset ( $aEntries ['count'] );
+				}
+				
+				foreach ( $aEntries as $aItem ) {
+					$sName = \trim ( $aItem ['displayname'] [0] );
+					if (isset ( $aItem ['mail'] ['count'] )) {
+						unset ( $aItem ['mail'] ['count'] );
+					}
+					foreach ( $aItem ['mail'] as $sEmail ) {
+						$sEmail = \trim ( $sEmail );
+						if (! empty ( $sEmail )) {
+							$aResult [] = array (
+									$sEmail,
+									$sName 
+							);
+						}
+					}
+				}
+			} else {
+				$this->logLdapError ( $oCon, 'ldap_get_entries' );
+			}
+		} else {
+			$this->logLdapError ( $oCon, 'ldap_search' );
+		}
+		
+		return $aResult;
+	}
+	
+	/**
+	 *
+	 * @param string $sStr        	
+	 *
+	 * @return string
+	 */
+	private function escape($sStr) {
+		$aNewChars = array ();
+		$aChars = array (
+				'\\',
+				'*',
+				' (',
+				')',
+				\chr ( 0 ) 
+		);
+		
+		foreach ( $aChars as $iIndex => $sValue ) {
+			$aNewChars [$iIndex] = '\\' . \str_pad ( \dechex ( \ord ( $sValue ) ), 2, '0' );
+		}
+		return \str_replace ( $aChars, $aNewChars, $sStr );
+	}
+	
+	/**
+	 *
+	 * @param mixed $oCon        	
+	 * @param string $sCmd        	
+	 *
+	 * @return string
+	 */
+	private function logLdapError($oCon, $sCmd) {
+		if ($this->oLogger) {
+			$sError = $oCon ? @\ldap_error ( $oCon ) : '';
+			$iErrno = $oCon ? @\ldap_errno ( $oCon ) : 0;
+			
+			$this->oLogger->Write ( $sCmd . ' error: ' . $sError . ' (' . $iErrno . ')', \MailSo\Log\Enumerations\Type::WARNING, 'LDAP' );
+		}
+	}
+	
+	/**
+	 *
+	 * @param \MailSo\Log\Logger $oLogger        	
+	 *
+	 * @return \LdapContactsSuggestions
+	 */
+	/**
+	 *
+	 * @param \MailSo\Log\Logger $oLogger        	
+	 */
+	public function SetLogger($oLogger) {
+		$this->oLogger = $oLogger instanceof \MailSo\Log\Logger ? $oLogger : null;
+	}
+}
+?>

sources/plugins/ynh-ldap-addressbooks/index.php

@@ -0,0 +1,37 @@
+<?php
+class YnhLdapAddressbooksPlugin extends \RainLoop\Plugins\AbstractPlugin {
+	public function Init() {
+		$this->addHook ( 'main.fabrica', 'MainFabrica' );
+	}
+	
+	/**
+	 * test if ldap is supported (but with ynh it nead ;) )
+	 *
+	 * @return string
+	 */
+	public function Supported() {
+		if (! \function_exists ( 'ldap_connect' )) {
+			return 'The LDAP PHP exention must be installed to use this plugin';
+		}
+		return '';
+	}
+	
+	/**
+	 *
+	 * @param string $sName        	
+	 * @param mixed $mResult        	
+	 */
+	public function MainFabrica($sName, &$mResult) {
+		if ($sName === 'suggestions') {
+			include_once __DIR__ . '/YnhLdapAddressbooks.php';
+			
+			if (! \is_array ( $mResult )) {
+				$mResult = array ();
+			}
+			
+			$oProvider = new YnhLdapAddressbooks ();
+			$mResult [] = $oProvider;
+		}
+	}
+}
+?>