Viewing file:  functions.py (3.85 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
"""
functions.py - wraps functions of module _ldap
written by Michael Stroeder <michael@stroeder.com>
See http://python-ldap.sourceforge.net for details.
\$Id: functions.py,v 1.18 2004/01/29 23:12:08 stroeder Exp $
Compability:
- Tested with Python 2.0+ but should work with Python 1.5.x
- functions should behave exactly the same like in _ldap
Usage:
Directly imported by ldap/__init__.py. The symbols of _ldap are
overridden.
Thread-lock:
Basically calls into the LDAP lib are serialized by the module-wide
lock _ldapmodule_lock.
"""
__version__ = '0.1.1'
__all__ = [
'open','initialize','init',
'explode_dn','explode_rdn',
'get_option','set_option'
]
import sys,_ldap
from ldap import _ldap_module_lock,LDAPError
from ldap.ldapobject import LDAPObject
if __debug__:
# Tracing is only supported in debugging mode
import traceback
from ldap import _trace_level,_trace_file,_trace_stack_limit
def _ldap_function_call(func,*args,**kwargs):
"""
Wrapper function which locks calls to func with via
module-wide ldap_lock
"""
if __debug__:
if _trace_level>=1:
_trace_file.write('*** %s.%s (%s,%s)\n' % (
'_ldap',repr(func),
repr(args),repr(kwargs)
))
if _trace_level>=3:
traceback.print_stack(limit=_trace_stack_limit,file=_trace_file)
_ldap_module_lock.acquire()
try:
try:
result = func(*args,**kwargs)
finally:
_ldap_module_lock.release()
except LDAPError,e:
if __debug__ and _trace_level>=2:
_trace_file.write('=> LDAPError: %s\n' % (str(e)))
raise
if __debug__ and _trace_level>=2:
if result!=None and result!=(None,None):
_trace_file.write('=> result: %s\n' % (repr(result)))
return result
def initialize(uri,trace_level=0,trace_file=sys.stdout,trace_stack_limit=None):
"""
Return LDAPObject instance by opening LDAP connection to
LDAP host specified by LDAP URL
Parameters:
uri
LDAP URL containing at least connection scheme and hostport,
e.g. ldap://localhost:389
trace_level
If non-zero a trace output of LDAP calls is generated.
trace_file
File object where to write the trace output to.
Default is to use stdout.
"""
return LDAPObject(uri,trace_level,trace_file,trace_stack_limit)
def open(host,port=389,trace_level=0,trace_file=sys.stdout,trace_stack_limit=None):
"""
Return LDAPObject instance by opening LDAP connection to
specified LDAP host
Parameters:
host
LDAP host and port, e.g. localhost
port
integer specifying the port number to use, e.g. 389
trace_level
If non-zero a trace output of LDAP calls is generated.
trace_file
File object where to write the trace output to.
Default is to use stdout.
"""
return initialize('ldap://%s:%d' % (host,port),trace_level,trace_file,trace_stack_limit)
init = open
def explode_dn(dn,notypes=0):
"""
explode_dn(dn [, notypes=0]) -> list
This function takes a DN and breaks it up into its component parts.
The notypes parameter is used to specify that only the component's
attribute values be returned and not the attribute types.
"""
return _ldap_function_call(_ldap.explode_dn,dn,notypes)
def explode_rdn(rdn,notypes=0):
"""
explode_rdn(rdn [, notypes=0]) -> list
This function takes a RDN and breaks it up into its component parts
if it is a multi-valued RDN.
The notypes parameter is used to specify that only the component's
attribute values be returned and not the attribute types.
"""
return _ldap_function_call(_ldap.explode_rdn,rdn,notypes)
def get_option(option):
"""
get_option(name) -> value
Get the value of an LDAP global option.
"""
return _ldap_function_call(_ldap.get_option,option)
def set_option(option,invalue):
"""
set_option(name, value)
Set the value of an LDAP global option.
"""
_ldap_function_call(_ldap.set_option,option,invalue)
|