diff options
Diffstat (limited to 'wiki/lib/plugins/authad/adLDAP/classes/adLDAPContacts.php')
| -rw-r--r-- | wiki/lib/plugins/authad/adLDAP/classes/adLDAPContacts.php | 294 |
1 files changed, 0 insertions, 294 deletions
diff --git a/wiki/lib/plugins/authad/adLDAP/classes/adLDAPContacts.php b/wiki/lib/plugins/authad/adLDAP/classes/adLDAPContacts.php deleted file mode 100644 index 42a0d75..0000000 --- a/wiki/lib/plugins/authad/adLDAP/classes/adLDAPContacts.php +++ /dev/null @@ -1,294 +0,0 @@ -<?php -/** - * PHP LDAP CLASS FOR MANIPULATING ACTIVE DIRECTORY - * Version 4.0.4 - * - * PHP Version 5 with SSL and LDAP support - * - * Written by Scott Barnett, Richard Hyland - * email: scott@wiggumworld.com, adldap@richardhyland.com - * http://adldap.sourceforge.net/ - * - * Copyright (c) 2006-2012 Scott Barnett, Richard Hyland - * - * We'd appreciate any improvements or additions to be submitted back - * to benefit the entire community :) - * - * This library is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; either - * version 2.1 of the License. - * - * This library 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 - * Lesser General Public License for more details. - * - * @category ToolsAndUtilities - * @package adLDAP - * @subpackage Contacts - * @author Scott Barnett, Richard Hyland - * @copyright (c) 2006-2012 Scott Barnett, Richard Hyland - * @license http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html LGPLv2.1 - * @revision $Revision: 97 $ - * @version 4.0.4 - * @link http://adldap.sourceforge.net/ - */ - -require_once(dirname(__FILE__) . '/../adLDAP.php'); -require_once(dirname(__FILE__) . '/../collections/adLDAPContactCollection.php'); - -class adLDAPContacts { - /** - * The current adLDAP connection via dependency injection - * - * @var adLDAP - */ - protected $adldap; - - public function __construct(adLDAP $adldap) { - $this->adldap = $adldap; - } - - //***************************************************************************************************************** - // CONTACT FUNCTIONS - // * Still work to do in this area, and new functions to write - - /** - * Create a contact - * - * @param array $attributes The attributes to set to the contact - * @return bool - */ - public function create($attributes) - { - // Check for compulsory fields - if (!array_key_exists("display_name", $attributes)) { return "Missing compulsory field [display_name]"; } - if (!array_key_exists("email", $attributes)) { return "Missing compulsory field [email]"; } - if (!array_key_exists("container", $attributes)) { return "Missing compulsory field [container]"; } - if (!is_array($attributes["container"])) { return "Container attribute must be an array."; } - - // Translate the schema - $add = $this->adldap->adldap_schema($attributes); - - // Additional stuff only used for adding contacts - $add["cn"][0] = $attributes["display_name"]; - $add["objectclass"][0] = "top"; - $add["objectclass"][1] = "person"; - $add["objectclass"][2] = "organizationalPerson"; - $add["objectclass"][3] = "contact"; - if (!isset($attributes['exchange_hidefromlists'])) { - $add["msExchHideFromAddressLists"][0] = "TRUE"; - } - - // Determine the container - $attributes["container"] = array_reverse($attributes["container"]); - $container= "OU=" . implode(",OU=", $attributes["container"]); - - // Add the entry - $result = @ldap_add($this->adldap->getLdapConnection(), "CN=" . $this->adldap->utilities()->escapeCharacters($add["cn"][0]) . ", " . $container . "," . $this->adldap->getBaseDn(), $add); - if ($result != true) { - return false; - } - - return true; - } - - /** - * Determine the list of groups a contact is a member of - * - * @param string $distinguisedname The full DN of a contact - * @param bool $recursive Recursively check groups - * @return array - */ - public function groups($distinguishedName, $recursive = NULL) - { - if ($distinguishedName === NULL) { return false; } - if ($recursive === NULL) { $recursive = $this->adldap->getRecursiveGroups(); } //use the default option if they haven't set it - if (!$this->adldap->getLdapBind()){ return false; } - - // Search the directory for their information - $info = @$this->info($distinguishedName, array("memberof", "primarygroupid")); - $groups = $this->adldap->utilities()->niceNames($info[0]["memberof"]); //presuming the entry returned is our contact - - if ($recursive === true){ - foreach ($groups as $id => $groupName){ - $extraGroups = $this->adldap->group()->recursiveGroups($groupName); - $groups = array_merge($groups, $extraGroups); - } - } - - return $groups; - } - - /** - * Get contact information. Returned in a raw array format from AD - * - * @param string $distinguisedname The full DN of a contact - * @param array $fields Attributes to be returned - * @return array - */ - public function info($distinguishedName, $fields = NULL) - { - if ($distinguishedName === NULL) { return false; } - if (!$this->adldap->getLdapBind()) { return false; } - - $filter = "distinguishedName=" . $distinguishedName; - if ($fields === NULL) { - $fields = array("distinguishedname", "mail", "memberof", "department", "displayname", "telephonenumber", "primarygroupid", "objectsid"); - } - $sr = ldap_search($this->adldap->getLdapConnection(), $this->adldap->getBaseDn(), $filter, $fields); - $entries = ldap_get_entries($this->adldap->getLdapConnection(), $sr); - - if ($entries[0]['count'] >= 1) { - // AD does not return the primary group in the ldap query, we may need to fudge it - if ($this->adldap->getRealPrimaryGroup() && isset($entries[0]["primarygroupid"][0]) && isset($entries[0]["primarygroupid"][0])){ - //$entries[0]["memberof"][]=$this->group_cn($entries[0]["primarygroupid"][0]); - $entries[0]["memberof"][] = $this->adldap->group()->getPrimaryGroup($entries[0]["primarygroupid"][0], $entries[0]["objectsid"][0]); - } else { - $entries[0]["memberof"][] = "CN=Domain Users,CN=Users," . $this->adldap->getBaseDn(); - } - } - - $entries[0]["memberof"]["count"]++; - return $entries; - } - - /** - * Find information about the contacts. Returned in a raw array format from AD - * - * @param string $distinguishedName The full DN of a contact - * @param array $fields Array of parameters to query - * @return mixed - */ - public function infoCollection($distinguishedName, $fields = NULL) - { - if ($distinguishedName === NULL) { return false; } - if (!$this->adldap->getLdapBind()) { return false; } - - $info = $this->info($distinguishedName, $fields); - - if ($info !== false) { - $collection = new adLDAPContactCollection($info, $this->adldap); - return $collection; - } - return false; - } - - /** - * Determine if a contact is a member of a group - * - * @param string $distinguisedName The full DN of a contact - * @param string $group The group name to query - * @param bool $recursive Recursively check groups - * @return bool - */ - public function inGroup($distinguisedName, $group, $recursive = NULL) - { - if ($distinguisedName === NULL) { return false; } - if ($group === NULL) { return false; } - if (!$this->adldap->getLdapBind()) { return false; } - if ($recursive === NULL) { $recursive = $this->adldap->getRecursiveGroups(); } //use the default option if they haven't set it - - // Get a list of the groups - $groups = $this->groups($distinguisedName, array("memberof"), $recursive); - - // Return true if the specified group is in the group list - if (in_array($group, $groups)){ - return true; - } - - return false; - } - - /** - * Modify a contact - * - * @param string $distinguishedName The contact to query - * @param array $attributes The attributes to modify. Note if you set the enabled attribute you must not specify any other attributes - * @return bool - */ - public function modify($distinguishedName, $attributes) { - if ($distinguishedName === NULL) { return "Missing compulsory field [distinguishedname]"; } - - // Translate the update to the LDAP schema - $mod = $this->adldap->adldap_schema($attributes); - - // Check to see if this is an enabled status update - if (!$mod) { - return false; - } - - // Do the update - $result = ldap_modify($this->adldap->getLdapConnection(), $distinguishedName, $mod); - if ($result == false) { - return false; - } - - return true; - } - - /** - * Delete a contact - * - * @param string $distinguishedName The contact dn to delete (please be careful here!) - * @return array - */ - public function delete($distinguishedName) - { - $result = $this->folder()->delete($distinguishedName); - if ($result != true) { - return false; - } - return true; - } - - /** - * Return a list of all contacts - * - * @param bool $includeDescription Include a description of a contact - * @param string $search The search parameters - * @param bool $sorted Whether to sort the results - * @return array - */ - public function all($includeDescription = false, $search = "*", $sorted = true) { - if (!$this->adldap->getLdapBind()) { return false; } - - // Perform the search and grab all their details - $filter = "(&(objectClass=contact)(cn=" . $search . "))"; - $fields = array("displayname","distinguishedname"); - $sr = ldap_search($this->adldap->getLdapConnection(), $this->adldap->getBaseDn(), $filter, $fields); - $entries = ldap_get_entries($this->adldap->getLdapConnection(), $sr); - - $usersArray = array(); - for ($i=0; $i<$entries["count"]; $i++){ - if ($includeDescription && strlen($entries[$i]["displayname"][0])>0){ - $usersArray[$entries[$i]["distinguishedname"][0]] = $entries[$i]["displayname"][0]; - } elseif ($includeDescription){ - $usersArray[$entries[$i]["distinguishedname"][0]] = $entries[$i]["distinguishedname"][0]; - } else { - array_push($usersArray, $entries[$i]["distinguishedname"][0]); - } - } - if ($sorted) { - asort($usersArray); - } - return $usersArray; - } - - /** - * Mail enable a contact - * Allows email to be sent to them through Exchange - * - * @param string $distinguishedname The contact to mail enable - * @param string $emailaddress The email address to allow emails to be sent through - * @param string $mailnickname The mailnickname for the contact in Exchange. If NULL this will be set to the display name - * @return bool - */ - public function contactMailEnable($distinguishedName, $emailAddress, $mailNickname = NULL){ - return $this->adldap->exchange()->contactMailEnable($distinguishedName, $emailAddress, $mailNickname); - } - - -} -?> |