LdapNgPlugin

On this page:

This plugin provides an interface to query an LDAP directory and display the results in a WikiApplication It is a complete rewrite of the Foswiki:Extensions/LdapPlugin by Gerard Hickey to provide greater flexibility and performance based on the Foswiki:Extensions/LdapContrib package.

Syntax Rules

LDAP

%LDAP{(filter=)"filter" ...}%

Query an LDAP directrory.

Parameters:

filter: the LDAP query string
host: host IP or name to connect to
port: port to of the host
version: protocol version; possible values: 2,3
ssl: use ssl to bind to the server; possible values 0,1
base: base dn of the (sub)tree to search in; if base is written in brackets (e.g. 'base="(ou=people)"') then it is prepended to the default base of the LdapContrib
scope: scope of search; possible values: sub, base, one
format: format string used to display a database record
header: header to prepend the output; default: '$dn'
footer: footer to appended to the output
sep: separator between database records; default: '$n'
sort: name of attributes to sort the output
reverse: reverse the result set; possible values: on, off; default: off
limit: maximum number of records to return; default: 0 (unlimited)
skip: number of records in the hit set to skip before displaying them; default: 0
hidenull: wether to hide any output on an empty hit set; possible values: on, off; default: off
clear: comma separated list of attributes to be removed from the output if they are not resolved

Cgi Parameters:

refresh: refresh the cache of blobs (i.e. jpegPhotos); possible values: on, off; default: off; (right now only the jpegPhoto attribute is recognized as a blob)

The header, format and footer format strings may contain the following variables:

$percnt: % sign
$dollar: $ sign
$n: newline
$count: the number of hits
$index: the record number
$<attr-name>: the value of the record attribute <attr-name>

LDAPUSERS

%LDAPUSERS{...}%

List all LDAP userinformation. Information is drawn from cache and not from the LDAP server. Use ?refreshldap=on to update.

Parameters:

format: format string used to display a user record
header: header to prepend the output
footer: footer to appended to the output
sep: separator between database records; default: '$n'
limit: maximum number of records to return; default: 0 (unlimited)
skip: number of records in the hit set to skip before displaying them; default: 0
include: regular expression a user's WikiName must match to be included in the output
exclude: regular expression a user's WikiName must not match
hideunknown: on/off, enable/disable filtering out users that did not log in yet and thus have no hometopic (e.g. created by Foswiki:Extensions/NewUsersPlugin), defaults to 'on'

The format string may contain the following variables:

$percnt: % sign
$dollar: $ sign
$n: newline
$index: the record number
$wikiName: the user's WikiName
$loginName: the user's login name
$displayName: a link pointing to the users hometopic in the Main web, if it exists, and '<nop>$wikiName' otherwise
$emails: the list of all known email addresses

Examples

ERROR: 32: No such object

Plugin Settings

The LdapNgPlugin will use the default configuration of the LdapContrib in your LocalSite.cfg file, that is

$Foswiki::cfg{Ldap}{Host} (overridable per query)
$Foswiki::cfg{Ldap}{Port} (overridable per query)
$Foswiki::cfg{Ldap}{Base} (overridable per query)
$Foswiki::cfg{Ldap}{Version} (overridable per query)
$Foswiki::cfg{Ldap}{SSL} (overridable per query)
$Foswiki::cfg{Ldap}{BindDN}
$Foswiki::cfg{Ldap}{BindPasswd}

Plugin Installation Instructions

You do not need to install anything in the browser to use this extension. The following instructions are for the administrator who installs the extension on the server.

Open configure, and open the "Extensions" section. Use "Find More Extensions" to get a list of available extensions. Select "Install".

If you have any problems, or if the extension isn't available in configure, then you can still install manually from the command-line. See http://foswiki.org/Support/ManuallyInstallingExtensions for more help.

Dependencies

Name	Version	Description
Foswiki::Contrib::LdapContrib	>=3.00	Required
Unicode::MapUTF8	>=1.11	Required. Download from CPAN:Unicode::MapUTF8

Plugin Info

This work was partly funded by Spanlink Communications.

Plugin Author:	Michael Daum
Copyright ©:	2006-2009 Michael Daum http://michaeldaumconsulting.com
License:	GPL (GNU General Public License)
Plugin Version:	v3.00
Change History:
27 Jan 2009:	syncing version number with LdapContrib
08 Jan 2009:	ported to foswiki
12 Jun 2008:	fixed yet another "sep" problem
13 Nov 2007:	fixed $nop
01 Oct 2007:	added LDAPUSERS, lined up to changes in LdapContrib-2.0
04 June 2007:	don't convert from/to utf8 if the site charset is already utf8
18 Dec 2006:	added support for addresses as specified in RFC4517
04 Dec 2006:	map utf8 strings from LDAP to the site's encoding and vice versa
30 Nov 2006:	replaced commonTagsHandler with a properly registered LDAP tag
31 Aug 2006:	added NO_PREFS_IN_TOPIC
19 Jul 2006:	public release
25 April 2006:	Initial (internal) version
Perl Version:	5.8
Plugin Home:	Foswiki:Extensions/LdapNgPlugin
Support:	Foswiki:Support/LdapNgPlugin