AD lookup of Name and Email

jpastin

All of our end-users are in our MSAD domain. What we would like to do is some way of populating the Full NAme and E-mail address fields on staff created tickets based on AD. Ideally we would like to use functionality similar to the lookup that currently exists for MySQL. For example, I start typing 'Tom' in the Full Name field (or a username field that I can add following instructions from another thread) and it displays all of the Toms in AD. The hope is that this cuts down on typo's in email addresses, and speeds ticket creation time.

jpastin

I think i solved this myself...

Two files to deal with:

/include/staff/newticket.inc.php

<script type="text/javascript">

// Change to AD lookup

// J. Pastin 9-3-09

// var options = {

// script:"ajax.php?api=tickets&f=searchbyemail&limit=10&",

// varname:"input",

// json: true,

// shownoresults,

// maxresults,

// callback: function (obj) { document.getElementById('email').value = obj.id; document.getElementById('name').value = obj.info; return false;}

// };

// var autosug = new bsn.AutoSuggest('email', options);

//

var name_options = {

script: "userfind.php?maxEntries=10&",

varname: "name",

json: true,

delay: 100,

cache,

callback (obj) {document.getElementById('email').value=obj.info;}

};

var email_options = {

script: "userfind.php?maxEntries=10&",

varname:"mail",

json,

cache,

callback (obj) {document.getElementById('name').value=obj.info;}

};

var email_as=new bsn.AutoSuggest('email', email_options);

var name_as=new bsn.AutoSuggest('name', name_options);

// End Changes

Create /scp/userfind.php, you will need to customize some variables here.

<?php

//Replace this with your AD Domain Controller

$ds=ldap_connect('ldap://mydc.mydomain.com') or die("Couldn't connect to AD!");

//Replace this with a username that has read permissions on your AD

$connect_u = "ad\myUser";

//Replace this with the password of the user

$conect_p="myPass";

//Replace this with the DN of the base OU you want to search

$search_user_dn = "OU=users,DC=my,DC=company,DC=com";

$inforequired = array("displayName","mail");

if (!ldap_bind( $ds, $connect_u, $conect_p) ) {

$error_msg = "Could not bind AD connection<br>";

}else
{        if (!empty($_REQUEST)) {
                $curMail=$_REQUEST;
                $curMail = strtolower($curMail);
                $curMail.='*';
                $filter="(&(mail=$curMail)(objectCategory=person))";
        }
        elseif (!empty($_REQUEST)) {
                $curName=$_REQUEST;
                $curName = strtolower($curName);
                $curName.='*';
                $filter="(&(displayName=$curName)(objectCategory=person))";
        }
        $user_result = ldap_search($ds,$search_user_dn,$filter,$inforequired);
        $user_info = ldap_get_entries($ds,$user_result);
        header("Content-Type: application/json");
                echo"{\"results\": [";
                $arr=Array();
                if (count($user_info) > $_REQUEST)
                {
                        $max=$_REQUEST;
                }
                else
                {
                        $max=count($user_info);
                }
                for ( $i=1; $i<$max; $i+=1)
                {
                        if (!empty($_REQUEST)) {
                                $arr= "{\"id\": \"".$i."\", \"value\": \"".$user_info."\", \"info\": \"".$user_info."\"}";
                        }
                        elseif (!empty($_REQUEST)) {
                                $arr= "{\"id\": \"".$i."\", \"value\": \"".$user_info."\", \"info\": \"".$user_info}";
}

?>

jpastin

If you want to add it to the client new ticket page, it is pretty straightforward as well. This assumes you added it to the SCP new ticket page.

Three changes need to be made in /includes/client/open.inc.php:

First, the "Name" filed needs an ID:

<?if ($thisclient && ($name=$thisclient->getName())) {

?>

<input type="hidden" name="name" value="<?=$name?>"><?=$name?>

<?}else {?>

Change to auto populate name and email address from AD

J. Pastin 9-8-09

<input type="text" name="name" size="25" value="<?=$info?>">

<input type="text" id="name" name="name" size="25" value="<?=$info?>">

End Changes

<?}?>

 <font class="error">* <?=$errors?></font>

Then the "Email" field needs to be given an ID:

<?if ($thisclient && ($email=$thisclient->getEmail())) {

?>

<input type="hidden" name="email" size="25" value="<?=$email?>"><?=$email?>

<?}else {?>

Change to auto populate name and email address from AD

J. Pastin 9-8-09

<input type="text" name="email" size="25" value="<?=$info?>">

<input type="text" id="email" name="email" size="25" value="<?=$info?>">

End Changes

<?}?>

Then the javascript needs to be added.

Change to AD lookup

J. Pastin 9-8-09

<script type="text/javascript">

var name_options = {

script: "/scp/userfind.php?maxEntries=10&",

varname: "name",

json: true,

delay: 100,

cache,

callback (obj) {document.getElementById('email').value=obj.info;}

};

var email_options = {

script: "/scp/userfind.php?maxEntries=10&",

varname:"mail",

json,

cache,

callback (obj) {document.getElementById('name').value=obj.info;}

};

var email_as=new bsn.AutoSuggest('email', email_options);

var name_as=new bsn.AutoSuggest('name', name_options);

</script>

End Changes

The other change to make is in /include/client/header.inc.php. The javascript link and the css link need to be added:

<head>

<meta http-equiv="content-type" content="text/html; charset=UTF-8">

<title><?=Format:($title)?></title>

<link rel="stylesheet" href="./styles/main.css" media="screen">

<link rel="stylesheet" href="./styles/colors.css" media="screen">

Change to add auto lookup of name and email

J. Pastin 9-8-09

<script type="text/javascript" src="/scp/js/bsn.AutoSuggest_2.1.3.js" charset="utf-8"></script>

<link rel="stylesheet" href="/scp/css/autosuggest_inquisitor.css" type="text/css" media="screen" charset="utf-8" />

End Changes

</head>

DaSilva

I tried to implement this but I have the problem that one OU has spaces in its name and it seems to be a problem with this.

Do you know how I can solve it?

It looks like this:

$search_user_dn = "OU=.Three Words OU,OU=City,OU=Users,OU=IT,DC=domain,DC=com,DC=au";

Is it also possible to get those information from all the OUs below the last one? So for example instead of the "IT" OU I want to get the information from all OUs below the "Users" OU.

Thanks in advance.

jpastin

As a best practice, I never use spaces in my OU names in AD. That said, it should work right with the spaces. One thing that I noticed is that you had a '.' in your example:

$search_user_dn = "OU=.Three Words OU,OU=City,OU=Users,OU=IT,DC=domain,DC=com,DC=au";

That might cause a problem.

As far as your second question, you are specifying a base search location. for example if your structure looks like this:

ad.mydomain.com

+ Users

+ City1

+ City2

+ Dept1

+ Dept2

If you wanted all users in Dept1 and Dept2, you would use a DN like this:

$search_user_dn = "OU=City2,OU=Users,DC=ad,DC=mydomain,DC=com"

A good utility to help find the correct DN for you is JXplorer. It is an LDAP browser that can give raw table data. http://www.jxplorer.org(http://www.jxplorer.org) Just navigate to the OU you want, flip to the 'Table Editor' tab and select the value of 'distinguishedName'

***Be careful with JXplorer, you can screw up your AD if you start changing stuff***

DaSilva

Thanks, it worked :)

jpastin

Great! Glad to hear it!

ema

not work :(

I tryed the first one (ticket for staff), but doesn't work.

I setup osticket 1.6rc5 with wampserver under windows7 x64.

I also added php_ldap extension under wamp server's control panel, but doesn't work.

I doesn't received any error message...

Have you any suggestion?

Thank you in advance. :)

ema

jpastin

Haven't played with Win 7 or WAMP yet. Not exactly sure, but here are a couple of things to check.

1) Did you restart the services after enabling php_ldap?

2) Did you replace the necessary variables in scp/userfind.php with the info for your environment?

3) If you are getting the message "Couldn't connect to AD", it means that for some reason php_ldap can't communicate with the LDAP service. This could be a number of things:

A) Incorrect hostname in the connect string

B) LDAP is not listening on the standard port 389

C) Some networking/firewall issue

D) php_ldap is not working properly

4) If you are getting the message "Could not bind AD connection", the specified credentials are incorrect.

5) If you are getting neither of these, you may be connecting to AD and just not getting results. This could be for a couple of reasons:

A) The account you are binding with does not have the necessary permissions. The account should have read permissions on the OU you are checking

B) The search DN is wrong, check it with JXplorer as detailed in a previous post in this thread.

Hopefully this will point you in the right direction. Also try creating a generic php script to verify LDAP functionality. Let me know how it turns out.

ema

Also try creating a generic php script to verify LDAP functionality. Let me know how it turns out.

I tryed to create a generic php script and it works :)

I think the problem is that the javascript (newticket.inc.php)... it was not be executed.

If I understand correctly, the javascript (it call the page userinfo.php with the AD lookup code) must be executed when I write something on "name" or "email".

Is this correct?

Thank you for your help :)

Ciao

ema

jpastin

The javascript is the actual AJAX part. It should be a direct drop-in replacement for the existing javascript from the stock mysql lookup. Make sure that you comment out or remove the original javascript. If you can't find it, try posting the relevant sections of your newticket.inc.php, and I'll take a look.

ema

The javascript is the actual AJAX part. It should be a direct drop-in replacement for the existing javascript from the stock mysql lookup. Make sure that you comment out or remove the original javascript. If you can't find it, try posting the relevant sections of your newticket.inc.php, and I'll take a look.

It's a simple "copy & paste" of your code

/include/staff/newticket.inc.php

...

</table>

<script type="text/javascript">

// Change to AD lookup

// J. Pastin 9-3-09

// var options = {

// script:"ajax.php?api=tickets&f=searchbyemail&limit=10&",

// varname:"input",

// json: true,

// shownoresults,

// maxresults,

// callback: function (obj) { document.getElementById('email').value = obj.id; document.getElementById('name').value = obj.info; return false;}

// };

// var autosug = new bsn.AutoSuggest('email', options);

//

var name_options = {

script: "userfind.php?maxEntries=10&",

varname: "name",

json: true,

delay: 100,

cache,

callback (obj) {document.getElementById('email').value=obj.info;}

};

var email_options = {

script: "userfind.php?maxEntries=10&",

varname:"mail",

json,

cache,

callback (obj) {document.getElementById('name').value=obj.info;}

};

var email_as=new bsn.AutoSuggest('email', email_options);

var name_as=new bsn.AutoSuggest('name', name_options);

// End Changes

...and after this I created the /scp/userfind.php

I also have tried to modify /scp/userfind.php with this

<?php

die("test");

?>

to test if userfind.php is loaded, but nothing happened.

Ciao :)

ema

jpastin

do you have the tag at the end?

ema

do you have the tag at the end?

Yes.

I try this

/include/staff/newticket.ini.php

...

<script type="text/javascript">

// Change to AD lookup

// J. Pastin 9-3-09

var options = {

script:"ajax.php?api=tickets&f=searchbyemail&limit=10&",

varname:"input",

json: true,

shownoresults,

maxresults,

callback: function (obj) { document.getElementById('email').value = obj.id; document.getElementById('name').value = obj.info; return false;}

};

var autosug = new bsn.AutoSuggest('email', options);

var name_options = {

script: "userfind.php?maxEntries=10&",

varname: "name",

json: true,

delay: 100,

cache,

callback (obj) {document.getElementById('email').value=obj.info;}

};

// var email_options = {

// script: "userfind.php?maxEntries=10&",

// varname:"mail",

// json,

// cache,

// callback (obj) {document.getElementById('name').value=obj.info;}

// };

// var email_as=new bsn.AutoSuggest('email', email_options);

var name_as=new bsn.AutoSuggest('name', name_options);

// End Changes

</script>

/scp/userfind.php

<?php

die("test");

?>

Email works in the old way, name doesn't work :

Ciao

ema

jpastin

just out of curiosity, check the permissions on userfind.php, and make sure that they are the same as ajax.php. I am thinking that since you created userfind.php the user that apache runs as may not be able to read it, which would explain why you aren't even getting a die response from it.

ema

just out of curiosity, check the permissions on userfind.php, and make sure that they are the same as ajax.php. I am thinking that since you created userfind.php the user that apache runs as may not be able to read it, which would explain why you aren't even getting a die response from it.

I use WAMP under Windows7 and the permissions are ok.

I can't understand why it not work, so I decided to rewrite userfind.php from scratch and now it works.. :

<?php

// original version by J. Pastin 9-3-09

//Domain info

$ldap_url = 'dc.my.domain.it';

$ldap_domain = 'my.domain.it';

$ldap_dn = "dc=my,dc=domain,dc=it";

//Account for LDAP connection

$ldapbind_usr = "ldapbind";

$ldapbind_pwd = "xxxxxxxxxx";

if (!empty($_REQUEST)) {

$strfind = $_REQUEST;

$strfind = strtolower($strfind);

$strfind.='*';

$filter = "(&(objectCategory=person)(displayName=$strfind))";

}

if (!empty($_REQUEST)) {

$strfind = $_REQUEST;

$strfind = strtolower($strfind);

$strfind.='*';

$filter = "(&(objectCategory=person)(mail=$strfind))";

}

//Connect

$ds = ldap_connect( $ldap_url );

ldap_set_option($ds, LDAP_OPT_PROTOCOL_VERSION, 3);

ldap_set_option($ds, LDAP_OPT_REFERRALS, 0);

//Login

$login = ldap_bind( $ds, "$ldapbind_usr@$ldap_domain", $ldapbind_pwd );

try

{	$attributes = array("displayname", "mail");
	$result = ldap_search($ds, $ldap_dn, $filter, $attributes);
	$entries = ldap_get_entries($ds, $result);
	header ("Cache-Control: no-cache, must-revalidate");
	header ("Pragma: no-cache");
	header ("Content-Type: application/json");	
	echo "{\"results\": [";
	if (count($entries) > $_REQUEST)
			{
					$max=$_REQUEST;
			}
			else
			{
					$max=count($entries);
			}
	if (count($entries) > 0)
	{
		for ( $i=1; $i<$max; $i+=1)
		{
			if (!empty($_REQUEST)) {
				$arr = "{\"id\": \"".$i."\", \"value\": \"".$entries."\", \"info\": \"".$entries."\"}";
			}
			elseif (!empty($_REQUEST)) {
				$arr = "{\"id\": \"".$i."\", \"value\": \"".$entries."\", \"info\": \"".$entries."\"}";
			}
		}
	}
	else
	{
		$arr}";	
}catch(Exception $e)
{	ldap_unbind($ds);
	return;
}ldap_unbind($ds);
?>

Thank you very much for your help! :)

Ciao

ema

jpastin

Very strange, but glad you got it working!!!

pti_breton

Thanks a lot jpastin,

It works very well for the staff but i have a problem for the client.

Where do we have to put the JS code you mention on your third post ?

I tried to put it in /include/client/open.inc.php but i have this JS error : 'bsn' is undefined on the loading of the page open.php.

Second problem : I'm french and we have accented characters. I tried to change the charset to iso-8859-1 in include/staff/header.inc.php but it didn't help me. I have ? caracters...

Thanks for your help.

jpastin

Two things to check:

1) The javascript section (The third code block in post #3) goes at the bottom of /includes/client/open.inc.php

2) Did you add the link to the autosuggest external js (The fourth code block in post #4)? This goes into /include/client/header.inc.php

My guess is that it either can't find the external autosuggest js file or the permissions might be wrong on it.

Let me know...

pti_breton

The JS Code is at the bottom of include/client/open.inc.php and i added the link to the autosuggest external js.

The error "bsn is undefined" goes to this line :

var email_as=new bsn.AutoSuggest('email', email_options);

I tried to change the links with the point like this in header.inc.php :

<script type="text/javascript" src="./scp/js/bsn.AutoSuggest_2.1.3.js" charset="utf-8"></script>

<link rel="stylesheet" href="./scp/css/autosuggest_inquisitor.css" type="text/css" media="screen" charset="utf-8" />

but when i start to enter a name or email, i have an error : AJAX Error : 404

I restarted all the modifications (for the staff and the client) and i always have the error "bsn is undefined"

I don't think this problem comes from permissions of userfind.php because they are the same as ajax.php