summaryrefslogtreecommitdiffstats
path: root/pykolab/imap/__init__.py
blob: a3533f34331c88a46da623bf295d42dff58b92f9 (plain)
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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
# -*- coding: utf-8 -*-
# Copyright 2010-2011 Kolab Systems AG (http://www.kolabsys.com)
#
# Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
#
# 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; version 3 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 Library 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
#


import logging
import re
import time

from urlparse import urlparse

import pykolab
from pykolab.translate import _

log = pykolab.getLogger('pykolab.imap')
conf = pykolab.getConf()

auth = pykolab.auth

class IMAP(object):
    def __init__(self):
        # Pool of named IMAP connections, by hostname
        self._imap = {}

        # Place holder for the current IMAP connection
        self.imap = None

    def connect(self, uri=None):
        backend = conf.get('kolab', 'imap_backend')

        if uri == None:
            uri = conf.get(backend, 'uri')

        result = urlparse(uri)

        # Get the credentials
        admin_login = conf.get(backend, 'admin_login')
        admin_password = conf.get(backend, 'admin_password')

        if not self._imap.has_key(result.hostname):
            if backend == 'cyrus-imap':
                import cyrus
                self._imap[result.hostname] = cyrus.Cyrus(uri)
                # Actually connect
                log.debug(_("Logging on to Cyrus IMAP server %s") %(result.hostname), level=8)
                self._imap[result.hostname].login(admin_login, admin_password)

            elif backend == 'dovecot':
                import dovecot
                self._imap[result.hostname] = dovecot.Dovecot(uri)
                # Actually connect
                log.debug(_("Logging on to Dovecot IMAP server %s") %(result.hostname), level=8)
                self._imap[result.hostname].login(admin_login, admin_password)

            else:
                import imap
                self._imap[result.hostname] = imap.IMAP(uri)
                # Actually connect
                log.debug(_("Logging on to generic IMAP server %s") %(result.hostname), level=8)
                self._imap[result.hostname].login(admin_login, admin_password)
        else:
            log.debug(_("Reusing existing IMAP server connection to %s") %(result.hostname), level=8)

        # Set the newly created technology specific IMAP library as the current
        # IMAP connection to be used.
        self.imap = self._imap[result.hostname]

    def disconnect(self, server=None):
        if server == None:
            # No server specified, but make sure self.imap is None anyways
            self.imap = None
        else:
            if self._imap.has_key(server):
                del self._imap[server]
            else:
                log.warning(_("Called imap.disconnect() on a server that " + \
                    "we had no connection to"))

    def __getattr__(self, name):
        if hasattr(self.imap, name):
            return getattr(self.imap, name)
        else:
            raise AttributeError, _("%r has no attribute %s") %(self,name)

    def has_folder(self, folder):
        folders = self.imap.lm(folder)
        log.debug(_("Looking for folder '%s', we found folders: %r") %(folder,folders), level=8)
        # Greater then one, this folder may have subfolders.
        if len(folders) > 0:
            return True
        else:
            return False

    def move_user_folders(self, users=[]):
        for user in users:
            if type(user) == dict:
                if user.has_key('old_mail'):
                    inbox = "user/%s" %(user['mail'])
                    old_inbox = "user/%s" %(user['old_mail'])

                    if self.has_folder(old_inbox):
                        log.debug(_("Found old INBOX folder %s") %(old_inbox), level=8)

                        if not self.has_folder(inbox):
                            self.imap.rename(old_inbox,inbox)
                        else:
                            log.warning(_("Moving INBOX folder %s won't succeed as target folder %s already exists") %(old_inbox,inbox))
                    else:
                        log.debug(_("Did not find old folder user/%s to rename") %(user['old_mail']), level=8)
            else:
                log.debug(_("Value for user is not a dictionary"), level=8)

    def create_user_folders(self, users, primary_domain, secondary_domains):
        inbox_folders = []

        domain_section = auth.domain_section(primary_domain)

        folders = self.list_user_folders(primary_domain, secondary_domains)

        # See if the folder belongs to any of the users
        _match_attr = conf.get('cyrus-sasl', 'result_attribute')

        #print domain

        if not users:
            users = auth.list_users(primary_domain)

        for user in users:
            if type(user) == dict:
                if user.has_key(_match_attr):
                    inbox_folders.append(user[_match_attr])
            elif type(user) == str:
                inbox_folders.append(user)

        for folder in inbox_folders:
            additional_folders = None
            try:
                if folders.index(folder) > -1:
                    continue
                else:
                    # TODO: Perhaps this block is moot
                    log.info(_("Creating new INBOX for user (%d): %s")
                        %(1,folder))
                    try:
                        self.imap.cm("user/%s" %(folder))
                    except:
                        log.warning(_("Mailbox already exists: user/%s")
                            %(folder))
                        continue
                    if conf.get('kolab', 'imap_backend') == 'cyrus-imap':
                        self.imap._setquota("user/%s" %(folder),0)

            except:
                # TODO: Perhaps this block is moot
                log.info(_("Creating new INBOX for user (%d): %s") %(2,folder))
                try:
                    self.imap.cm("user/%s" %(folder))
                except:
                    log.warning(_("Mailbox already exists: user/%s") %(folder))
                    continue
                self.imap._setquota("user/%s" %(folder),0)

            if conf.has_option(domain_section, "autocreate_folders"):
                _additional_folders = conf.get_raw(domain_section, "autocreate_folders")
                additional_folders = conf.plugins.exec_hook("create_user_folders",
                        kw={
                                'folder': folder,
                                'additional_folders': _additional_folders
                            }
                    )

            if not additional_folders == None:
                self.create_user_additional_folders(folder, additional_folders)

        return inbox_folders

    def create_user_additional_folders(self, folder, additional_folders):
        for additional_folder in additional_folders.keys():
            _add_folder = {}
            if len(folder.split('@')) > 1:
                folder_name = "user%(seperator)s%(username)s%(seperator)s%(additional_folder_name)s@%(domainname)s"
                _add_folder['username'] = folder.split('@')[0]
                _add_folder['domainname'] = folder.split('@')[1]
                _add_folder['additional_folder_name'] = additional_folder
                _add_folder['seperator'] = self.imap.seperator
                folder_name = folder_name % _add_folder
            else:
                folder_name = "user%(seperator)s%(username)s%(seperator)s%(additional_folder_name)s" % {
                        "username": folder,
                        "seperator": self.imap.seperator,
                        "additional_folder_name": additional_folder
                    }

            try:
                self.imap.cm(folder_name)
            except:
                log.warning(_("Mailbox already exists: user/%s") %(folder))

            if additional_folders[additional_folder].has_key("annotations"):
                for annotation in additional_folders[additional_folder]["annotations"].keys():
                    if conf.get('kolab', 'imap_backend') == 'cyrus-imap':
                        self.imap._setannotation(
                                folder_name,
                                "%s" %(annotation),
                                "%s" %(additional_folders[additional_folder]["annotations"][annotation])
                            )

            if additional_folders[additional_folder].has_key("acls"):
                for acl in additional_folders[additional_folder]["acls"].keys():
                    self.imap.sam(
                            folder_name,
                            "%s" %(acl),
                            "%s" %(additional_folders[additional_folder]["acls"][acl])
                        )

    def set_user_folder_quota(self, users=[], primary_domain=None, secondary_domain=[], folders=[]):
        self.connect()

        if conf.has_option(primary_domain, 'quota_attribute'):
            _quota_attr = conf.get(primary_domain, 'quota_attribute')
        else:
            auth_mechanism = conf.get('kolab', 'auth_mechanism')
            _quota_attr = conf.get(auth_mechanism, 'quota_attribute')

        _inbox_folder_attr = conf.get('cyrus-sasl', 'result_attribute')

        default_quota = auth.domain_default_quota(primary_domain)

        if default_quota == "":
            default_quota = 0

        if len(users) == 0:
            users = auth.list_users(primary_domain)

        for user in users:
            quota = None

            if type(user) == dict:
                if user.has_key(_quota_attr):
                    #print "user has key"
                    if type(user[_quota_attr]) == list:
                        quota = user[_quota_attr].pop(0)
                    elif type(user[_quota_attr]) == str:
                        quota = user[_quota_attr]
                else:
                    _quota = auth.get_user_attribute(primary_domain, user, _quota_attr)
                    if _quota == None:
                        quota = 0
                    else:
                        quota = _quota

                if not user.has_key(_inbox_folder_attr):
                    continue
                else:
                    if type(user[_inbox_folder_attr]) == list:
                        folder = "user/%s" % user[_inbox_folder_attr].pop(0)
                    elif type(user[_inbox_folder_attr]) == str:
                        folder = "user/%s" % user[_inbox_folder_attr]
            elif type(user) == str:
                quota = auth.get_user_attribute(user, 'quota')
                folder = "user/%s" %(user)

            try:
                (used,current_quota) = self.imap.lq(folder)
            except:
                # TODO: Go in fact correct the quota.
                log.warning(_("Cannot get current IMAP quota for folder %s") %(folder))
                continue

            new_quota = conf.plugins.exec_hook("set_user_folder_quota", kw={
                        'used': used,
                        'current_quota': current_quota,
                        'new_quota': int(quota),
                        'default_quota': default_quota
                    }
                )

            log.debug(_("Quota for %s currently is %s") %(folder, current_quota), level=7)

            if new_quota == None:
                continue

            if not int(new_quota) == int(quota):
                log.info(_("Adjusting authentication database quota for folder %s to %d") %(folder,int(new_quota)))
                quota = int(new_quota)
                auth.set_user_attribute(primary_domain, user, _quota_attr, new_quota)

            if not int(current_quota) == int(quota):
                #log.info(_("Correcting quota for %s to %s (currently %s)") %(folder, quota, current_quota))
                self.imap._setquota(folder, quota)

    def expunge_user_folders(self, inbox_folders=None):
        """
            Delete folders that have no equivalent user qualifier in the list
            of users passed to this function, ...

            TODO: Explain the domain parameter, and actually get it to work
                  properly. This also relates to threading for multi-domain
                  deployments.

            Parameters:

                users
                        A list of users. Can be a list of user qualifiers, e.g.
                        [ 'user1', 'user2' ] or a list of user attribute
                        dictionaries, e.g. [ { 'user1': { 'attr': 'value' } } ]

                primary_domain, secondary_domains
        """
        self.connect()

        if inbox_folders == None:
            inbox_folders = []

        folders = self.list_user_folders()

        for folder in folders:
            log.debug(_("Checking folder: %s") %(folder), level=1)
            try:
                if inbox_folders.index(folder) > -1:
                    continue
                else:
                    log.info(_("Folder has no corresponding user (1): %s") %(folder))
                    self.imap.dm("user/%s" %(folder))
            except:
                log.info(_("Folder has no corresponding user (2): %s") %(folder))
                try:
                    self.imap.dm("user/%s" %(folder))
                except:
                    pass

    def list_user_folders(self, primary_domain=None, secondary_domains=[]):
        """
            List the INBOX folders in the IMAP backend. Returns a list of unique
            base folder names.
        """
        self.connect()

        _folders = self.imap.lm("user/%")
        # TODO: Replace the .* below with a regex representing acceptable DNS
        # domain names.
        domain_re = ".*\.?%s$"

        acceptable_domain_name_res = []

        if not primary_domain == None:
            for domain in [ primary_domain ] + secondary_domains:
                acceptable_domain_name_res.append(domain_re %(domain))

        folders = []

        for folder in _folders:
            folder_name = None
            if len(folder.split('@')) > 1:
                #acceptable = False
                #for domain_name_re in acceptable_domain_name_res:
                    #prog = re.compile(domain_name_re)
                    #if prog.match(folder.split('@')[1]):
                        #print "Acceptable indeed"
                        #acceptable = True
                    #if not acceptable:
                        #print "%s is not acceptable against %s yet using %s" %(folder.split('@')[1],folder,domain_name_re)

                #if acceptable:
                    #folder_name = "%s@%s" %(folder.split(self.seperator)[1].split('@')[0],folder.split('@')[1])

                folder_name = "%s@%s" %(folder.split(self.imap.seperator)[1].split('@')[0],folder.split('@')[1])
            else:
                folder_name = "%s" %(folder.split(self.imap.seperator)[1])

            if not folder_name == None:
                if not folder_name in folders:
                    folders.append(folder_name)

        #print folders

        return folders

    def synchronize(self, users=[], primary_domain=None, secondary_domains=[]):
        self.connect()
        self.users = users

        self.move_user_folders(users)

        folders = self.create_user_folders(users, primary_domain, secondary_domains)

        self.set_user_folder_quota(users, primary_domain, secondary_domains, folders)

        return folders

    def lm(self, *args, **kw):
        return self.imap.lm(*args, **kw)

    def undelete(self, *args, **kw):
        self.imap.undelete(*args, **kw)