File: LDAPMemberDataTool.py

package info (click to toggle)
zope-cmfldap 2.0-1
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 172 kB
  • ctags: 59
  • sloc: python: 406; makefile: 29; sh: 28
file content (258 lines) | stat: -rw-r--r-- 8,539 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
#####################################################################
#
# LDAPMemberDataTool       LDAP-enabled CMF Memberdata Tool
#
# This software is governed by a license. See
# LICENSE.txt for the terms of this license.
#
#####################################################################
__version__='$Revision: 1.22 $'[11:-2]


from Products.CMFCore.utils import getToolByName
from Products.CMFCore.CMFCorePermissions import View
from Globals import InitializeClass, DTMLFile
from Acquisition import aq_base
from AccessControl import ClassSecurityInfo
from Products.CMFCore.MemberDataTool import MemberDataTool, MemberData

_marker = []


class LDAPMemberDataTool(MemberDataTool):
    """ This tool wraps user objects, making them act as Member objects. """
    security = ClassSecurityInfo()
    meta_type = 'LDAP Member Data Tool'
    title = 'LDAP Member Data Tool'
    manage_showContents = DTMLFile('dtml/memberdataContents', globals())


    def __init__(self, id='portal_memberdata'):
        self.id = id
        MemberDataTool.__init__(self)


    def wrapUser(self, u):
        """
        If possible, returns the Member object that corresponds
        to the given User object.
        """
        id = u.getUserName()
        members = self._members

        if not members.has_key(id):
            # Get a temporary member that might be
            # registered later via registerMemberData().
            temps = self._v_temps

            if temps is not None and temps.has_key(id):
                m = temps[id]
            else:
                base = aq_base(self)
                m    = LDAPMemberData(base, id)

                if temps is None:
                    self._v_temps = { id : m }
                else:
                    temps[id] = m
        else:
            m = members[id]

        wrapper = m.__of__(self).__of__(u)
        # We set the MemberData global options if we found values
        # in the UserData. (for instance the 'email')
        try:
            global mapped_attrs
            mapped_attrs = self.acl_users.getMappedUserAttrs()

            for MappedUserAttr in mapped_attrs:
                try:
                    # get the property value from LDAPUser object, if it is 
                    # empty then the method will raise an exception
                    PropertyValue = u.getProperty(MappedUserAttr[1])
                    # now read the value from the wrapper
                    WrapperPropertyValue = wrapper.getProperty(MappedUserAttr[1])
                    # redefine the wrapper value if it differ
                    if ( PropertyValue is not None and 
                         PropertyValue != '' and 
                         PropertyValue != WrapperPropertyValue ):
                        setattr(wrapper, MappedUserAttr[1], PropertyValue)
                except:
                    # the exception may be thrown if PropertyValue is empty
                    pass
        except:
            pass

        # Return a wrapper with self as containment and
        # the user as context.
        return wrapper


    def getMemberDataContents(self):
        """
        Return the number of members stored in the _members
        BTree and some other useful info
        """
        membertool = getToolByName(self, 'portal_membership')
        members = self._members
        temps = self._v_temps
        user_list = membertool.listMemberIds()
        member_list = members.keys()
        member_count = len(members)
        orphan_count = 0
        member_temp_count = 0
 
        if (len(user_list) == 1):
            # Possible LDAP Error?
            res_str = user_list[0].lower()
            if res_str.find('error') != -1:
                msg = 'No or too many results returned from LDAP'

                return [ { 'member_count' : member_count
                         , 'orphan_count' : msg
                         } ]

        for member in member_list:
            if member not in user_list:
                orphan_count = orphan_count + 1
 
        if temps is not None:
            member_temp_count=len(temps.keys())

        return [ { 'member_count' : member_count
                 , 'orphan_count' : orphan_count 
                 , 'member_temp_count' : member_temp_count
                 } ]
 

    security.declareProtected(View, 'getMemberProps')
    def getMemberProps(self):
        """
            Return a list of tuples with the property and a "friendly"
            name for it for any property that can be set on a user 
            object.
        """
        return self.acl_users.getLDAPSchema()


    security.declareProtected(View, 'getLoginAttribute')
    def getLoginAttribute(self):
        """ Get the attribute name used for login in LDAP """
        return self.acl_users.getProperty('_login_attr')


InitializeClass(LDAPMemberDataTool)


class LDAPMemberData (MemberData):
    """ Member Data wrapper for the LDAP-driven Member Data Tool """

    def __init__(self, tool, id):
        """ class constructor """
        self.id = id
        # Make a temporary reference to the tool.
        # The reference will be removed by notifyModified().
        self._tool = tool


    def setMemberProperties(self, mapping):
        """ Sets the properties of the member.  """
        acl = self.acl_users
        ldap_schemakeys = [x[0] for x in acl.getLDAPSchema()]

        # back conversion of mapped attributes
        mapped_attrs = acl.getMappedUserAttrs()
        for mapped_attr in mapped_attrs:
            if ( not mapping.has_key(mapped_attr[0]) 
                 and mapping.has_key(mapped_attr[1]) ):
                mapping.set( mapped_attr[0]
                           , mapping[mapped_attr[1]]
                           )
        
        change_vals = filter( None
                            , map( lambda x, lsk=ldap_schemakeys: x in lsk
                                 , mapping.keys()
                                 )
                            )

        try:
            if change_vals:
                user_obj = self.getUser()
                dn = user_obj.getUserDN()
                rdn_attr = acl.getProperty('_rdnattr')

                if not mapping.has_key(rdn_attr):
                    mapping.set( rdn_attr
                               , user_obj.getUserName()
                               )

                acl.manage_editUser(dn, kwargs=mapping)
                user_obj._expire()
        except:
            pass

        # To be on the safe side...
        wrapper_keys = self.__dict__.keys()
        for key in ldap_schemakeys:
            if mapping.has_key(key) and key in wrapper_keys:
                setattr(self, key, mapping[key])

        MemberData.setMemberProperties(self, mapping)
        

    def setSecurityProfile(self, password=None, roles=None, domains=None):
        """ Set the user's basic security profile """
        acl = self.acl_users
        u = self.getUser()
        user_dn = u.getUserDN()
        
        if password is not None:
            acl.manage_editUserPassword(user_dn, password)
            u.__ = password

        if roles is not None:
            all_roles = acl.getGroups()
            role_dns = []
            my_new_roles = []
            
            for role_name, role_dn in all_roles:
                if role_name in roles:
                    my_new_roles.append(role_name)
                    role_dns.append(role_dn)
                    
            u.roles = my_new_roles
            acl.manage_editUserRoles(user_dn, role_dns)

        if domains is not None:
            u.domains = domains


    def getPassword(self):
        """
            Retrieve the user's password if there is a valid record in the 
            user folder cache, otherwise create a new one and set it
            on the user object and in LDAP
        """
        user_obj = self.getUser()
        pwd = user_obj._getPassword()

        if pwd == 'undef':      # This user object did not result from a login
            reg_tool = getToolByName(self, 'portal_registration')
            pwd = reg_tool.generatePassword()
            self.setSecurityProfile(password=pwd)
            self.acl_users._expireUser(user_obj)

        return pwd

InitializeClass(LDAPMemberData)


def manage_addLDAPMemberDataTool(self, REQUEST=None):
    """ Add an LDAP-based MemberDataTool """
    tool_obj = LDAPMemberDataTool()
    self._setObject(tool_obj.id, tool_obj)
 
    if REQUEST is not None:
        return self.manage_main(self, REQUEST)