New LDAPProvider for user_ldap

3 files changed, 199 insertions, 0 deletions

diff --git a/lib/public/LDAP/IDeletionFlagSupport.php b/lib/public/LDAP/IDeletionFlagSupport.php
new file mode 100644
index 00000000000..ca272d7aa79
--- /dev/null
+++ b/lib/public/LDAP/IDeletionFlagSupport.php
@@ -0,0 +1,44 @@
+<?php
+/**
+ * @author Roger Szabo <roger.szabo@web.de>
+ *
+ * @copyright Copyright (c) 2016, ownCloud, Inc.
+ * @license AGPL-3.0
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License, version 3,
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>
+ *
+ */
+
+namespace OCP\LDAP;
+
+/**
+ * Interface IDeletionFlagSupport
+ *
+ * @package OCP\LDAP
+ * @since 9.2.0
+ */
+interface IDeletionFlagSupport {
+	/**
+	 * Flag record for deletion.
+	 * @param string $uid ownCloud user id
+	 * @since 9.2.0
+	 */
+	public function flagRecord($uid);
+	
+	/**
+	 * Unflag record for deletion.
+	 * @param string $uid ownCloud user id
+	 * @since 9.2.0
+	 */
+	public function unflagRecord($uid);
+}
diff --git a/lib/public/LDAP/ILDAPProvider.php b/lib/public/LDAP/ILDAPProvider.php
new file mode 100644
index 00000000000..44f7d88c946
--- /dev/null
+++ b/lib/public/LDAP/ILDAPProvider.php
@@ -0,0 +1,104 @@
+<?php
+/**
+ * @author Roger Szabo <roger.szabo@web.de>
+ *
+ * @copyright Copyright (c) 2016, ownCloud, Inc.
+ * @license AGPL-3.0
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License, version 3,
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>
+ *
+ */
+
+namespace OCP\LDAP;
+
+/**
+ * Interface ILDAPProvider
+ *
+ * @package OCP\LDAP
+ * @since 9.2.0
+ */
+interface ILDAPProvider {
+	/**
+	 * Translate an ownCloud username to LDAP DN.
+	 * @param string $uid ownCloud user id
+	 * @return string
+	 * @since 9.2.0
+	 */
+	public function getUserDN($uid);
+	
+	/**
+	 * Translate a LDAP DN to an ownCloud user name.
+	 * @param string $dn LDAP DN
+	 * @return string with the ownCloud user name
+	 * @throws \Exception if translation was unsuccessful
+	 * @since 9.2.0
+	 */
+	public function getUserName($dn);
+	
+	/**
+	 * Convert a stored DN so it can be used as base parameter for LDAP queries.
+	 * @param string $dn the DN
+	 * @return string
+	 * @since 9.2.0
+	 */
+	public function DNasBaseParameter($dn);
+	
+	/**
+	 * Sanitize a DN received from the LDAP server.
+	 * @param array $dn the DN in question
+	 * @return array the sanitized DN
+	 * @since 9.2.0
+	 */
+	public function sanitizeDN($dn);
+	
+	/**
+	 * Return a new LDAP connection resource for the specified user. 
+	 * @param string $uid ownCloud user id
+	 * @return resource of the LDAP connection
+	 * @since 9.2.0
+	 */
+	public function getLDAPConnection($uid);
+	
+	/**
+	 * Get the LDAP base for users.
+	 * @param string $uid ownCloud user id
+	 * @return string the base for users
+	 * @throws \Exception if user id was not found in LDAP
+	 * @since 9.2.0
+	 */
+	public function getLDAPBaseUsers($uid);
+	
+	/**
+	 * Get the LDAP base for groups.
+	 * @param string $uid ownCloud user id
+	 * @return string the base for groups
+	 * @throws \Exception if user id was not found in LDAP
+	 * @since 9.2.0
+	 */
+	public function getLDAPBaseGroups($uid);
+	
+	/**
+	 * Check whether a LDAP DN exists
+	 * @param string $dn LDAP DN
+	 * @return bool whether the DN exists
+	 * @since 9.2.0
+	 */
+	public function dnExists($dn);
+	
+	/**
+	 * Clear the cache if a cache is used, otherwise do nothing.
+	 * @param string $uid ownCloud user id
+	 * @since 9.2.0
+	 */
+	public function clearCache($uid);
+}
diff --git a/lib/public/LDAP/ILDAPProviderFactory.php b/lib/public/LDAP/ILDAPProviderFactory.php
new file mode 100644
index 00000000000..3e1242e33db
--- /dev/null
+++ b/lib/public/LDAP/ILDAPProviderFactory.php
@@ -0,0 +1,51 @@
+<?php
+/**
+ * @author Roger Szabo <roger.szabo@web.de>
+ *
+ * @copyright Copyright (c) 2016, ownCloud, Inc.
+ * @license AGPL-3.0
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License, version 3,
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>
+ *
+ */
+namespace OCP\LDAP;
+
+use OCP\IServerContainer;
+
+/**
+ * Interface ILDAPProviderFactory
+ *
+ * This class is responsible for instantiating and returning an ILDAPProvider
+ * instance.
+ *
+ * @package OCP\LDAP
+ * @since 9.2.0
+ */
+interface ILDAPProviderFactory {
+
+	/**
+	 * Constructor for the LDAP provider factory
+	 *
+	 * @param IServerContainer $serverContainer server container
+	 * @since 9.2.0
+	 */
+	public function __construct(IServerContainer $serverContainer);
+	
+	/**
+	 * creates and returns an instance of the ILDAPProvider
+	 *
+	 * @return ILDAPProvider
+	 * @since 9.2.0
+	 */
+	public function getLDAPProvider();
+}