[Python-kolab-commits] r3 - in trunk/python-kolab: . kolab kolab/ldap
scm-commit@wald.intevation.org
scm-commit at wald.intevation.org
Thu Feb 22 14:11:06 CET 2007
Author: wrobel
Date: 2007-02-22 14:11:05 +0100 (Thu, 22 Feb 2007)
New Revision: 3
Added:
trunk/python-kolab/AUTHORS
trunk/python-kolab/COPYING
trunk/python-kolab/HACKING
trunk/python-kolab/INSTALL
trunk/python-kolab/MANIFEST.in
trunk/python-kolab/NEWS
trunk/python-kolab/README
trunk/python-kolab/TODO
trunk/python-kolab/kolab/.svn.ignore
trunk/python-kolab/kolab/__init__.py
trunk/python-kolab/kolab/ldap/.svn.ignore
trunk/python-kolab/kolab/ldap/__init__.py
trunk/python-kolab/kolab/ldap/kldap.py
trunk/python-kolab/kolab/version.py
trunk/python-kolab/setup.py
Modified:
trunk/python-kolab/kolab/
trunk/python-kolab/kolab/ldap/
Log:
A first draft of ldap functions. This still needs rearrangement.
Added: trunk/python-kolab/AUTHORS
===================================================================
--- trunk/python-kolab/AUTHORS 2007-02-22 12:32:31 UTC (rev 2)
+++ trunk/python-kolab/AUTHORS 2007-02-22 13:11:05 UTC (rev 3)
@@ -0,0 +1,4 @@
+Authors of python-kolab.
+
+Gunnar Wrobel <p at rdus.de>
+ LDAP functions
Added: trunk/python-kolab/COPYING
===================================================================
--- trunk/python-kolab/COPYING 2007-02-22 12:32:31 UTC (rev 2)
+++ trunk/python-kolab/COPYING 2007-02-22 13:11:05 UTC (rev 3)
@@ -0,0 +1,340 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+ 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The licenses for most software are designed to take away your
+freedom to share and change it. By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users. This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it. (Some other Free Software Foundation software is covered by
+the GNU Library General Public License instead.) You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+ To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have. You must make sure that they, too, receive or can get the
+source code. And you must show them these terms so they know their
+rights.
+
+ We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+ Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software. If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+ Finally, any free program is threatened constantly by software
+patents. We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary. To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ GNU GENERAL PUBLIC LICENSE
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License. The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language. (Hereinafter, translation is included without limitation in
+the term "modification".) Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope. The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+ 1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+ 2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+ a) You must cause the modified files to carry prominent notices
+ stating that you changed the files and the date of any change.
+
+ b) You must cause any work that you distribute or publish, that in
+ whole or in part contains or is derived from the Program or any
+ part thereof, to be licensed as a whole at no charge to all third
+ parties under the terms of this License.
+
+ c) If the modified program normally reads commands interactively
+ when run, you must cause it, when started running for such
+ interactive use in the most ordinary way, to print or display an
+ announcement including an appropriate copyright notice and a
+ notice that there is no warranty (or else, saying that you provide
+ a warranty) and that users may redistribute the program under
+ these conditions, and telling the user how to view a copy of this
+ License. (Exception: if the Program itself is interactive but
+ does not normally print such an announcement, your work based on
+ the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole. If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works. But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+ 3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+ a) Accompany it with the complete corresponding machine-readable
+ source code, which must be distributed under the terms of Sections
+ 1 and 2 above on a medium customarily used for software interchange; or,
+
+ b) Accompany it with a written offer, valid for at least three
+ years, to give any third party, for a charge no more than your
+ cost of physically performing source distribution, a complete
+ machine-readable copy of the corresponding source code, to be
+ distributed under the terms of Sections 1 and 2 above on a medium
+ customarily used for software interchange; or,
+
+ c) Accompany it with the information you received as to the offer
+ to distribute corresponding source code. (This alternative is
+ allowed only for noncommercial distribution and only if you
+ received the program in object code or executable form with such
+ an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it. For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable. However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+ 4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License. Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+ 5. You are not required to accept this License, since you have not
+signed it. However, nothing else grants you permission to modify or
+distribute the Program or its derivative works. These actions are
+prohibited by law if you do not accept this License. Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+ 6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions. You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+ 7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all. For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices. Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+ 8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded. In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+ 9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation. If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+ 10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission. For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this. Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+ NO WARRANTY
+
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 2 of the License, or
+ (at your option) any later version.
+
+ 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 General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program; if not, write to the Free Software
+ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+ Gnomovision version 69, Copyright (C) year name of author
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary. Here is a sample; alter the names:
+
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+ <signature of Ty Coon>, 1 April 1989
+ Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs. If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library. If this is what you want to do, use the GNU Library General
+Public License instead of this License.
Added: trunk/python-kolab/HACKING
===================================================================
--- trunk/python-kolab/HACKING 2007-02-22 12:32:31 UTC (rev 2)
+++ trunk/python-kolab/HACKING 2007-02-22 13:11:05 UTC (rev 3)
@@ -0,0 +1 @@
+Development guidelines still missing.
Added: trunk/python-kolab/INSTALL
===================================================================
--- trunk/python-kolab/INSTALL 2007-02-22 12:32:31 UTC (rev 2)
+++ trunk/python-kolab/INSTALL 2007-02-22 13:11:05 UTC (rev 3)
@@ -0,0 +1,3 @@
+Run
+
+./setup.py install
Added: trunk/python-kolab/MANIFEST.in
===================================================================
--- trunk/python-kolab/MANIFEST.in 2007-02-22 12:32:31 UTC (rev 2)
+++ trunk/python-kolab/MANIFEST.in 2007-02-22 13:11:05 UTC (rev 3)
@@ -0,0 +1,5 @@
+include AUTHORS
+include COPYING
+include ChangeLog
+include NEWS
+include README
Added: trunk/python-kolab/NEWS
===================================================================
--- trunk/python-kolab/NEWS 2007-02-22 12:32:31 UTC (rev 2)
+++ trunk/python-kolab/NEWS 2007-02-22 13:11:05 UTC (rev 3)
@@ -0,0 +1,6 @@
+New in 0.1:
+
+* ldap module
+
+ - Some basic functionality has been provided to handle the Kolab
+ specific LDAP structure
Added: trunk/python-kolab/README
===================================================================
--- trunk/python-kolab/README 2007-02-22 12:32:31 UTC (rev 2)
+++ trunk/python-kolab/README 2007-02-22 13:11:05 UTC (rev 3)
@@ -0,0 +1 @@
+python-kolab provides some Kolab specific functions written in Python.
Added: trunk/python-kolab/TODO
===================================================================
--- trunk/python-kolab/TODO 2007-02-22 12:32:31 UTC (rev 2)
+++ trunk/python-kolab/TODO 2007-02-22 13:11:05 UTC (rev 3)
@@ -0,0 +1,9 @@
+* IMAP functions
+
+ - ...
+ -
+
+* XML handling
+
+ - ...
+ -
Property changes on: trunk/python-kolab/kolab
___________________________________________________________________
Name: svn:ignore
+ *.pyc
Added: trunk/python-kolab/kolab/.svn.ignore
===================================================================
--- trunk/python-kolab/kolab/.svn.ignore 2007-02-22 12:32:31 UTC (rev 2)
+++ trunk/python-kolab/kolab/.svn.ignore 2007-02-22 13:11:05 UTC (rev 3)
@@ -0,0 +1 @@
+*.pyc
Added: trunk/python-kolab/kolab/__init__.py
===================================================================
--- trunk/python-kolab/kolab/__init__.py 2007-02-22 12:32:31 UTC (rev 2)
+++ trunk/python-kolab/kolab/__init__.py 2007-02-22 13:11:05 UTC (rev 3)
@@ -0,0 +1,4 @@
+################################################################################
+# PYTHON-KOLAB - PACKAGE MARKER
+################################################################################
+
Property changes on: trunk/python-kolab/kolab/ldap
___________________________________________________________________
Name: svn:ignore
+ *.pyc
Added: trunk/python-kolab/kolab/ldap/.svn.ignore
===================================================================
--- trunk/python-kolab/kolab/ldap/.svn.ignore 2007-02-22 12:32:31 UTC (rev 2)
+++ trunk/python-kolab/kolab/ldap/.svn.ignore 2007-02-22 13:11:05 UTC (rev 3)
@@ -0,0 +1 @@
+*.pyc
Added: trunk/python-kolab/kolab/ldap/__init__.py
===================================================================
--- trunk/python-kolab/kolab/ldap/__init__.py 2007-02-22 12:32:31 UTC (rev 2)
+++ trunk/python-kolab/kolab/ldap/__init__.py 2007-02-22 13:11:05 UTC (rev 3)
@@ -0,0 +1,4 @@
+################################################################################
+# PYTHON-KOLAB - PACKAGE MARKER
+################################################################################
+
Added: trunk/python-kolab/kolab/ldap/kldap.py
===================================================================
--- trunk/python-kolab/kolab/ldap/kldap.py 2007-02-22 12:32:31 UTC (rev 2)
+++ trunk/python-kolab/kolab/ldap/kldap.py 2007-02-22 13:11:05 UTC (rev 3)
@@ -0,0 +1,529 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+#################################################################################
+# PYTHON-KOLAB LDAP HANDLER
+#################################################################################
+# File: kldap.py
+#
+# A class for LDAP management.
+#
+# Copyright:
+# (c) 2005 - 2007 Pardus
+# Distributed under the terms of the GNU General Public License v2
+#
+# Author(s):
+# Gunnar Wrobel <p at rdus.de>
+#
+# $Id$
+'''A class that provides access to values stored in a LDAP database.'''
+
+__version__ = "$Id$"
+
+#================================================================================
+#
+# Dependencies
+#
+#--------------------------------------------------------------------------------
+
+import ldap
+import ldap.modlist
+import types, re
+
+#================================================================================
+#
+# Helper functions
+#
+#--------------------------------------------------------------------------------
+
+def escape(ldapstr, rep_map):
+ '''
+ Replace all characters according to the given map.
+ '''
+ for in_c, outc in rep_map:
+ ldapstr = ldapstr.replace(in_c, outc)
+ return ldapstr
+
+def escape_for_filter(filter_str):
+ '''
+ From RFC-2254:
+
+ If a value should contain any of the following characters
+
+ Character ASCII value
+ ---------------------------
+ * 0x2a
+ ( 0x28
+ ) 0x29
+ \ 0x5c
+ NUL 0x00
+
+ the character must be encoded as the backslash "\" character (ASCII
+ 0x5c) followed by the two hexadecimal digits representing the ASCII
+ value of the encoded character. The case of the two hexadecimal
+ digits is not significant.
+
+ Simple test (the four slashes are necessary for the sake of the DocTest):
+
+ >>> escape_for_filter("\\\\*()\\0()*\\\\")
+ '\\\\5c\\\\2a\\\\28\\\\29\\\\00\\\\28\\\\29\\\\2a\\\\5c'
+ '''
+ rep_map = (( '\\', '\\5c'),
+ ( '*', '\\2a'),
+ ( '(', '\\28'),
+ ( ')', '\\29'),
+ ( '\0', '\\00'))
+ return escape(filter_str, rep_map);
+
+def escape_for_dn(dn_str):
+ '''
+ DN component escaping as described in RFC-2253
+
+ Simple test (the four slashes are necessary for the sake of the DocTest):
+
+ >>> escape_for_dn("\\\\,+<><<>;;+")
+ '\\\\\\\\\\\\,\\\\+\\\\<\\\\>\\\\<\\\\<\\\\>\\\\;\\\\;\\\\+'
+ '''
+ rep_map = (( '\\', '\\\\'),
+ ( ',', '\\,'),
+ ( '+', '\\+'),
+ ( '<', '\\<'),
+ ( '>', '\\>'),
+ ( ';', '\\;'))
+ dn_str = escape(dn_str, rep_map)
+ if dn_str[0] == '#':
+ dn_str = '\\' + dn_str
+ head = re.compile('^ *').search(dn_str)
+ tail = re.compile(' *$').search(dn_str)
+ if head:
+ begin = head.span()[1]
+ else:
+ begin = 0
+ if tail:
+ end = tail.span()[0]
+ else:
+ end = len(str)
+ return '\\ ' * begin + dn_str[begin:end] + '\\ ' * (len(dn_str) - end)
+
+
+def objectclass_filter(classes, concat = '|'):
+ ''' Generate a object class filter string.
+
+ >>> objectclass_filter(['a','b'])
+ '(|(objectclass=a)(objectclass=b))'
+
+ >>> objectclass_filter(['a','b'], ':')
+ '(:(objectclass=a)(objectclass=b))'
+
+ >>> objectclass_filter(['a','b', 'c'])
+ '(|(|(objectclass=a)(objectclass=b))(objectclass=c))'
+
+ >>> objectclass_filter('a', ':')
+ '(objectclass=a)'
+ '''
+ if isinstance(classes, types.StringTypes):
+ return '(objectclass=' + classes + ')'
+ else:
+ def class_expand(cls):
+ ''' Expand array to a filter string.'''
+ if len(cls) == 1:
+ return objectclass_filter(cls[0])
+ if len(cls) == 2:
+ return '(' + concat + objectclass_filter(cls[0]) \
+ + objectclass_filter(cls[1]) + ')'
+ else:
+ return '(' + concat + class_expand(cls[:-1]) \
+ + objectclass_filter(cls[-1]) + ')'
+
+ return class_expand(classes)
+
+
+#================================================================================
+#
+# LdapStorage
+#
+#--------------------------------------------------------------------------------
+
+class LdapStorage(object):
+ '''
+ This class can be used to handle objects stored in an LDAP database.
+ '''
+ implements(IStorage)
+
+ info = 'LDAP'
+
+ def __init__(self, uri, base_dn, users = {'default': ('', '')}):
+ self.ldap_uri = uri
+ self.base_dn = base_dn
+ self.users = users
+
+ if not 'default' in self.users.keys():
+ self.users['default'] = ('', '')
+
+ self.connected = False
+ self.ldap = None
+
+ self.set_auth()
+
+ def connect(self, user = 'default'):
+ ''' This initializes the storage handler. This is not handled within
+ the __init__ call since the storage handlers are most
+ certainly also services. And the service setup should be
+ seperate from the storage setup. '''
+ self.set_auth(user)
+ self.require_connect()
+
+ def set_auth(self, user = 'default'):
+ ''' Set the authentication to a desired level. The lower the level the
+ less rights are provided. The maximum level acceptable can be
+ decided by the class actually implementing this interface. '''
+ self.require_disconnect()
+ self.current_user = user
+ self.ldapbinddn = self.users[user][0]
+ self.ldappass = self.users[user][1]
+
+ def fetch(self, oid, object_classes = ['*']):
+ '''
+ Fetch an object from storage.
+
+ >>> class DummyLdap:
+ ... def search_s(self, dn, scope, ofilter):
+ ... if dn != 'cn=test,dc=example,dc=com':
+ ... raise ldap.NO_SUCH_OBJECT('Not found')
+ ... return [('cn=test,dc=example,dc=com',
+ ... {'cn': ['test'], 'test': ['another test'],
+ ... 'objectClass': ['top', 'inetOrgPerson',
+ ... 'kolabInetOrgPerson',
+ ... 'hordePerson']})]
+ >>> class DummyLdapStorage(LdapStorage):
+ ... def require_connect(self):
+ ... self.connected = True
+ ... self.ldap = DummyLdap()
+ ... def require_disconnect(self):
+ ... self.connected = False
+ >>> a = DummyLdapStorage("ldap://127.0.0.1", "dc=example,dc=com")
+ >>> a.fetch('cn=test', ['*'])
+ {'test': ['another test'], 'objectClass': ['top', 'inetOrgPerson', 'kolabInetOrgPerson', 'hordePerson'], 'dn': ['cn=test'], 'cn': ['test']}
+ >>> a.fetch('cn=test2', ['*'])
+ '''
+
+ OUT.debug('Updating storage object', 6)
+
+ ldap_result = []
+
+ # Has a dn been given
+ if oid:
+
+ OUT.debug('Fetching object values', 7)
+
+ # Try to fetch the result
+ ldap_result = self.ldap_fetch(oid,
+ object_classes)
+
+ OUT.debug('Got object values', 7)
+
+ if (ldap_result and ldap_result[1] and
+ oid == ldap_result[0][0:len(oid)]):
+ # Need that for the mapping to object attributes
+ ldap_result[1]['dn'] = [ldap_result[0][0:len(oid)]]
+
+ return ldap_result[1]
+ else:
+ return {}
+
+ def store(self, data, oid, input_data, object_classes):
+ ''' This storage method will write the output values to ldap. The
+ configuration context provided by the corresponding storage
+ object needs to provide a valid ldap connection.
+
+ >>> class DummyLdap:
+ ... def search_s(self, dn, scope, ofilter):
+ ... if dn != 'cn=test,dc=example,dc=com':
+ ... raise ldap.NO_SUCH_OBJECT('Not found')
+ ... return [('cn=test,dc=example,dc=com',
+ ... {'cn': ['test'], 'test': ['another test'],
+ ... 'objectClass': ['top', 'inetOrgPerson',
+ ... 'kolabInetOrgPerson',
+ ... 'hordePerson']})]
+ ... def add_s(self, dn, modlist):
+ ... pass
+ ... def rename_s(self, olddn, newdn, a, b):
+ ... pass
+ ... def modify_s(self, dn, modlist):
+ ... pass
+ >>> class FailLdap(DummyLdap):
+ ... def add_s(self, dn, modlist):
+ ... raise ldap.SERVER_DOWN('Not found')
+ ... def rename_s(self, olddn, newdn, a, b):
+ ... raise ldap.SERVER_DOWN('Not found')
+ ... def modify_s(self, dn, modlist):
+ ... raise ldap.SERVER_DOWN('Not found')
+ >>> class DummyLdapStorage(LdapStorage):
+ ... def require_connect(self):
+ ... self.connected = True
+ ... self.ldap = DummyLdap()
+ ... def require_disconnect(self):
+ ... self.connected = False
+ >>> class FailLdapStorage(DummyLdapStorage):
+ ... def require_connect(self):
+ ... self.connected = True
+ ... self.ldap = FailLdap()
+
+ >>> a = DummyLdapStorage("ldap://127.0.0.1", "dc=example,dc=com")
+
+ Test adding a new object:
+
+ >>> input = {}
+ >>> output = {'test': ['another test'], 'objectClass': ['top', 'inetOrgPerson', 'kolabInetOrgPerson', 'hordePerson'], 'dn': ['cn=test2'], 'cn': ['test2']}
+
+ >>> a.store(output, 'cn=test2', input, ['*'])
+ True
+
+ Test adding an object that existed in LDAP (but is missing now):
+
+ >>> input = {'test': ['another test'], 'objectClass': ['top', 'inetOrgPerson', 'kolabInetOrgPerson', 'hordePerson'], 'dn': ['cn=test2'], 'cn': ['test2']}
+ >>> output = {'test': ['another test'], 'objectClass': ['top', 'inetOrgPerson', 'kolabInetOrgPerson', 'hordePerson'], 'dn': ['cn=test2'], 'cn': ['test2']}
+
+ >>> a.store(output, 'cn=test2', input, ['*'])
+ True
+
+ Test for failure:
+
+ >>> b = FailLdapStorage("ldap://127.0.0.1", "dc=example,dc=com")
+ >>> b.store(output, 'cn=test2', input, ['*'])
+ Traceback (most recent call last):
+ ...
+ StorageException: Failed to create object "cn=test2".
+ Error was: Not found
+
+ Renaming an object:
+
+ >>> output = {'test': ['another test'], 'objectClass': ['top', 'inetOrgPerson', 'kolabInetOrgPerson', 'hordePerson'], 'dn': ['cn=test2'], 'cn': ['test2']}
+ >>> input = {'test': ['another test'], 'objectClass': ['top', 'inetOrgPerson', 'kolabInetOrgPerson', 'hordePerson'], 'dn': ['cn=test'], 'cn': ['test']}
+
+ >>> a.store(output, 'cn=test2', input, ['*'])
+ True
+
+ Test for failure:
+
+ >>> input = {'test': ['another test'], 'objectClass': ['top', 'inetOrgPerson', 'kolabInetOrgPerson', 'hordePerson'], 'dn': ['cn=test'], 'cn': ['test']}
+ >>> b = FailLdapStorage("ldap://127.0.0.1", "dc=example,dc=com")
+ >>> b.store(output, 'cn=test2', input, ['*'])
+ Traceback (most recent call last):
+ ...
+ StorageException: Failed to rename object "cn=test2".
+ Error was: Not found
+
+ Object update:
+
+ >>> output = {'test': ['another test2'], 'objectClass': ['top', 'inetOrgPerson', 'kolabInetOrgPerson', 'hordePerson'], 'dn': ['cn=test'], 'cn': ['test']}
+ >>> input = {'test': ['another test'], 'objectClass': ['top', 'inetOrgPerson', 'kolabInetOrgPerson', 'hordePerson'], 'dn': ['cn=test'], 'cn': ['test']}
+
+ >>> a.store(output, 'cn=test', input, ['*'])
+ True
+
+ Test for failure:
+
+ >>> input = {'test': ['another test'], 'objectClass': ['top', 'inetOrgPerson', 'kolabInetOrgPerson', 'hordePerson'], 'dn': ['cn=test'], 'cn': ['test']}
+ >>> b = FailLdapStorage("ldap://127.0.0.1", "dc=example,dc=com")
+ >>> b.store(output, 'cn=test', input, ['*'])
+ Traceback (most recent call last):
+ ...
+ StorageException: Failed to update object "cn=test".
+ Error was: Not found
+ '''
+
+ OUT.debug('Creating/updating object in LDAP', 6)
+
+ dist_name = ''
+
+ # The dn entry may not be part of the dict in case we update
+ # an object
+ if 'dn' in input_data.keys():
+
+ dist_name = input_data['dn'][0]
+
+ del input_data['dn']
+
+ # Hm, we apparently got the object from ldap
+ # but it does not exist anymore. This means
+ # we add a new object
+ if not self.ldap_fetch(dist_name, object_classes):
+ dist_name = ''
+
+ # The object did not originate from LDAP and does not
+ # yet exist in LDAP
+ if not dist_name and not self.ldap_fetch(oid, object_classes):
+
+ OUT.debug('Creating new object in LDAP', 7)
+
+ try:
+ self.ldap_store(oid, data)
+ except Exception, error:
+ raise StorageException('Failed to create object "' + oid
+ + '".\nError was: ' + str(error))
+
+ return True
+
+ # Object comes from LDAP or already exists
+ else:
+
+ OUT.debug('Object modification', 7)
+
+ if dist_name != oid:
+
+ OUT.debug('Object needs renaming', 7)
+
+ try:
+ self.ldap_rename(dist_name, oid)
+ except Exception, e:
+ raise StorageException('Failed to rename object "' + oid
+ + '".\nError was: ' + str(e))
+
+ OUT.debug('Object update', 7)
+
+ try:
+ self.ldap_update(oid, input_data, data)
+ except Exception, e:
+ raise StorageException('Failed to update object "' + oid
+ + '".\nError was: ' + str(e))
+
+ OUT.debug('Object update successful', 7)
+
+ return True
+
+ def delete(self, oid, object_classes):
+ ''' Delete the object from LDAP.'''
+
+ OUT.debug('Deleting object', 7)
+
+ if not self.ldap_fetch(oid, object_classes):
+ raise StorageException('Cannot delete object "' + oid + '". Did '
+ 'not find it in storage.')
+
+ ## Delete the storage object from ldap
+ try:
+ self.ldap_delete(oid)
+ except Exception, error:
+ StorageException('Failed to delete object "' + oid
+ + '".\nError was: ' + str(error))
+
+ return True
+
+ def ldap_fetch(self, dist_name, classes = ['*']):
+ '''
+ Tries to fetch the object for the given dn.
+ '''
+ ofilter = objectclass_filter(classes, '&')
+
+ dist_name = self.complete_dn(dist_name)
+
+ result = []
+
+ self.reconnect()
+ try:
+
+ OUT.debug('Searching for object', 7)
+
+ result = self.ldap.search_s(dist_name, ldap.SCOPE_BASE, ofilter)
+ except ldap.NO_SUCH_OBJECT, error:
+ pass
+ except ldap.SERVER_DOWN, error:
+ raise StorageException('Server down (Filter: "' + ofilter +
+ '", Bound as: "' + self.ldapbinddn +
+ '", Error: ' + str(error) + ').')
+
+ if len(result) == 1:
+ ## Returns the first object found
+ return result[0]
+ else:
+ return None
+
+ def ldap_store(self, dist_name, store_values):
+ ''' Stores the values as a new object in LDAP. '''
+
+ OUT.debug('Creating new object in LDAP', 6)
+
+ dist_name = self.complete_dn(dist_name)
+
+ OUT.debug('Generating modlist', 7)
+
+ modlist = ldap.modlist.addModlist(store_values)
+
+ self.reconnect()
+
+ OUT.debug('Adding object', 7)
+
+ self.ldap.add_s(dist_name, modlist)
+
+ def ldap_update(self, dist_name, oldvalues, newvalues):
+ ''' Update an object in LDAP. '''
+
+ dist_name = self.complete_dn(dist_name)
+
+ modlist = ldap.modlist.modifyModlist(oldvalues, newvalues)
+
+ self.reconnect()
+ self.ldap.modify_s(dist_name, modlist)
+
+ def ldap_rename(self, olddn, newdn):
+ ''' Rename an object in LDAP. '''
+
+ olddn = self.complete_dn(olddn)
+ newdn = self.complete_dn(newdn)
+
+ newdn = ldap.explode_dn(newdn)
+ if len(newdn) < 2:
+ raise StorageException('Did not expect a single rdn as new dn!')
+
+ self.reconnect()
+ self.ldap.rename_s(olddn, newdn[0], ','.join(newdn[1:]), 1)
+
+ def ldap_delete(self, dist_name):
+ ''' Delete an object from LDAP. '''
+
+ dist_name = self.complete_dn(dist_name)
+
+ self.reconnect()
+ self.ldap.delete_s(dist_name)
+
+ def require_connect(self):
+ ''' Connect to the LDAP server. '''
+
+ if self.connected:
+ return
+ self.ldap = ldap.initialize(self.ldap_uri)
+ self.ldap.protocol_version = ldap.VERSION3
+ self.ldap.simple_bind_s(self.ldapbinddn, self.ldappass)
+ self.connected = True
+
+ def require_disconnect(self):
+ ''' Disconnect from LDAP server. '''
+
+ if not self.connected:
+ return
+ self.ldap.unbind()
+ self.connected = False
+
+ def reconnect(self):
+ ''' Reconnect to the LDAP server. '''
+
+ self.require_disconnect()
+ self.require_connect()
+
+ def complete_dn(self, dist_name):
+ ''' Complete an object name with the base DN.. '''
+
+ if dist_name:
+ return dist_name + ',' + self.base_dn
+ else:
+ return self.base_dn
+
+#================================================================================
+#
+# Testing
+#
+#--------------------------------------------------------------------------------
+
+if __name__ == '__main__':
+ import doctest, sys
+ doctest.testmod(sys.modules[__name__])
Added: trunk/python-kolab/kolab/version.py
===================================================================
--- trunk/python-kolab/kolab/version.py 2007-02-22 12:32:31 UTC (rev 2)
+++ trunk/python-kolab/kolab/version.py 2007-02-22 13:11:05 UTC (rev 3)
@@ -0,0 +1,37 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+#################################################################################
+# PYTHON-KOLAB VERSION
+#################################################################################
+# File: version.py
+#
+# Provides a version number for this library
+#
+# Copyright:
+# (c) 2007 p at rdus <http://www.pardus.de>
+# Distributed under the terms of the GNU General Public License v2
+#
+# Author(s):
+# Gunnar Wrobel <p at rdus.de>
+#
+# $Id$
+'''Global version number.'''
+
+__version__ = "$Id$"
+
+#================================================================================
+#
+# Constants
+#
+#--------------------------------------------------------------------------------
+
+VERSION = '0.1'
+
+#================================================================================
+#
+# Testing
+#
+#--------------------------------------------------------------------------------
+
+if __name__ == '__main__':
+ print "python-kolab v" + VERSION
Added: trunk/python-kolab/setup.py
===================================================================
--- trunk/python-kolab/setup.py 2007-02-22 12:32:31 UTC (rev 2)
+++ trunk/python-kolab/setup.py 2007-02-22 13:11:05 UTC (rev 3)
@@ -0,0 +1,50 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+#################################################################################
+# PYTHON-KOLAB SETUP
+#################################################################################
+# File: setup.py
+#
+# Distutils setup script for python-kolab.
+#
+# Copyright:
+# (c) 2007 p at rdus <http://www.pardus.de>
+# Distributed under the terms of the GNU General Public License v2
+#
+# Author(s):
+# Gunnar Wrobel <p at rdus.de>
+#
+# $Id$
+'''Setup script for python-kolab.'''
+
+__version__ = "$Id$"
+
+#================================================================================
+#
+# Dependencies
+#
+#--------------------------------------------------------------------------------
+
+import sys
+
+from distutils.core import setup
+
+sys.path.insert(0, './')
+from kolab.version import VERSION
+
+#================================================================================
+#
+# setup handler
+#
+#--------------------------------------------------------------------------------
+
+setup(name = 'python-kolab',
+ version = VERSION,
+ description = 'Python tools for a Kolab server',
+ author = 'Gunnar Wrobel',
+ author_email = 'p at rdus.de',
+ url = 'http://wald.intevation.org/projects/python-kolab/',
+ packages = ['kolab', 'kolab.kldap'],
+ scripts = [],
+ license = 'GPL',
+ )
Property changes on: trunk/python-kolab/setup.py
___________________________________________________________________
Name: svn:executable
+ *
More information about the Python-kolab-commits
mailing list