summaryrefslogtreecommitdiffstats
path: root/pykolab/imap/cyrus.py
blob: bd56ab49d07d27fbd375a2b3c77b508adfd265f0 (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
# -*- 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 cyruslib
import time

import pykolab

from pykolab.imap import IMAP

from pykolab.translate import _

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

class Cyrus(object):
    """
        Abstraction class for some common actions to do exclusively in Cyrus.

        For example, the following functions require the commands to be
        executed against the backend server if a murder is being used.

        - Setting quota
        - Renaming the top-level mailbox
        - Setting annotations
    """
    def __init__(self, imap=None):
        self.imap = imap

        if self.imap == None:
            self.imap = IMAP()

    def setquota(self, mailbox, quota):
        """
            Login to the actual backend server.
        """
        log.debug(_("Checking actual backend server for folder %s through annotations") %(mailbox), level=8)
        annotations = self.imap.getannotation(mailbox, "/vendor/cmu/cyrus-imapd/server")
        server = annotations[mailbox]['/vendor/cmu/cyrus-imapd/server']
        log.debug(_("Server for INBOX folder %s is %s") %(mailbox,server), level=8)

        _imap = cyruslib.IMAP4(server, 143)
        admin_login = conf.get('cyrus-imap', 'admin_login')
        admin_password = conf.get('cyrus-imap', 'admin_password')
        _imap.login(admin_login, admin_password)

        log.debug(_("Setting quota for INBOX folder %s to %s") %(mailbox,quota), level=8)
        _imap.setquota(mailbox, quota)

        del _imap

    def rename(self, from_mailbox, to_mailbox, partition=None):
        """
            Login to the actual backend server, then rename.
        """
        log.debug(_("Checking actual backend server for folder %s through annotations") %(from_mailbox), level=8)
        annotations = self.imap.getannotation(from_mailbox, "/vendor/cmu/cyrus-imapd/server")
        server = annotations[from_mailbox]['/vendor/cmu/cyrus-imapd/server']
        log.debug(_("Server for INBOX folder %s is %s") %(from_mailbox,server), level=8)

        _imap = cyruslib.IMAP4(server, 143)
        admin_login = conf.get('cyrus-imap', 'admin_login')
        admin_password = conf.get('cyrus-imap', 'admin_password')
        _imap.login(admin_login, admin_password)

        log.debug(_("Moving INBOX folder %s to %s") %(from_mailbox,from_mailbox), level=8)
        _imap.rename(from_mailbox, from_mailbox, partition)

        del _imap

    def setannotation(self, mailbox, annotation, value):
        """
            Login to the actual backend server, then set annotation.
        """
        log.debug(_("Checking actual backend server for folder %s through annotations") %(mailbox), level=8)
        annotations = self.imap.getannotation(mailbox, "/vendor/cmu/cyrus-imapd/server")
        server = annotations[mailbox]['/vendor/cmu/cyrus-imapd/server']
        log.debug(_("Server for INBOX folder %s is %s") %(mailbox,server), level=8)

        _imap = cyruslib.IMAP4(server, 143)
        admin_login = conf.get('cyrus-imap', 'admin_login')
        admin_password = conf.get('cyrus-imap', 'admin_password')
        _imap.login(admin_login, admin_password)

        log.debug(_("Setting annotation %s on folder %s") %(annotation,mailbox), level=8)
        _imap.setannotation(mailbox, annotation, value)

        del _imap

    def undelete(self, mailbox, to_mailbox=None, recursive=True):
        """
            Login to the actual backend server, then "undelete" the mailbox.

            'mailbox' may be a string representing either of the following two
            options;

            - the fully qualified pathof the deleted folder in its current
              location, such as, for a deleted INBOX folder originally known as
              "user/userid[@domain]";

                "DELETED/user/userid/hex[@domain]"

            - the original folder name, such as;

                "user/userid[@domain]"

            'to_mailbox' may be the target folder to "undelete" the deleted
            folder to. If not specified, the original folder name is used.
        """

        log.debug(_("Checking actual backend server for folder %s through annotations") %(mailbox), level=8)
        annotations = self.imap.getannotation(mailbox, "/vendor/cmu/cyrus-imapd/server")
        server = annotations[mailbox]['/vendor/cmu/cyrus-imapd/server']
        log.debug(_("Server for deleted folder %s is %s") %(mailbox,server), level=8)

        _imap = cyruslib.IMAP4(server, 143)
        admin_login = conf.get('cyrus-imap', 'admin_login')
        admin_password = conf.get('cyrus-imap', 'admin_password')
        _imap.login(admin_login, admin_password)

        # Get the seperator used
        self.seperator = _imap.getsep()

        # Placeholder for folders we have recovered already.
        target_folders = []

        mailbox = self.parse_mailbox(mailbox)

        undelete_folders = self._find_deleted_folder(mailbox)

        if not to_mailbox == None:
            target_mbox = self.parse_mailbox(to_mailbox)
        else:
            target_mbox = mailbox

        for undelete_folder in undelete_folders:
            undelete_mbox = self.parse_mailbox(undelete_folder)

            prefix = undelete_mbox['path_parts'].pop(0)
            mbox = undelete_mbox['path_parts'].pop(0)

            if to_mailbox == None:
                target_folder = self.seperator.join([prefix,mbox])
            else:
                target_folder = self.seperator.join(target_mbox['path_parts'])

            if not to_mailbox == None:
                target_folder = "%s%s%s" %(target_folder,self.seperator,mbox)
            if not len(undelete_mbox['path_parts']) == 0:
                target_folder = "%s%s%s" %(target_folder,self.seperator,self.seperator.join(undelete_mbox['path_parts']))

            if target_folder in target_folders:
                target_folder = "%s%s%s" %(target_folder,self.seperator,undelete_mbox['hex_timestamp'])

            target_folders.append(target_folder)

            if not target_mbox['domain'] == None:
                target_folder = "%s@%s" %(target_folder,target_mbox['domain'])

            log.info(_("Undeleting %s to %s") %(undelete_folder,target_folder))
            _imap.rename(undelete_folder,target_folder)

    def parse_mailbox(self, mailbox):
        """
            Parse a mailbox name to it's parts.

            Takes a fully qualified mailbox or mailbox sub-folder.
        """
        mbox = {
                'domain': None
            }

        # Split off the virtual domain identifier, if any
        if len(mailbox.split('@')) > 1:
            mbox['domain'] = mailbox.split('@')[1]
            mbox['path_parts'] = mailbox.split('@')[0].split(self.seperator)
        else:
            mbox['path_parts'] = mailbox.split(self.seperator)

        # See if the path that has been specified is the current location for
        # the deleted folder, or the original location, we have to find the deleted
        # folder for.
        if not mbox['path_parts'][0] in [ 'user', 'shared' ]:
            deleted_prefix = mbox['path_parts'].pop(0)
            # See if the hexadecimal timestamp is actually hexadecimal.
            # This prevents "DELETED/user/userid/Sent", but not
            # "DELETED/user/userid/FFFFFF" from being specified.
            try:
                epoch = int(mbox['path_parts'][(len(mbox['path_parts'])-1)], 16)
                try:
                    timestamp = time.asctime(time.gmtime(epoch))
                except:
                    return None
            except:
                return None

            # Verify that the input for the deleted folder is actually a
            # deleted folder.
            verify_folder_search = "%(dp)s%(sep)s%(mailbox)s" % {
                    'dp': deleted_prefix,
                    'sep': self.seperator,
                    'mailbox': self.seperator.join(mbox['path_parts'])
                }

            if not mbox['domain'] == None:
                verify_folder_search = "%s@%s" %(verify_folder_search, mbox['domain'])

            folders = self.imap.imap.lm(verify_folder_search)

            # NOTE: Case also covered is valid hexadecimal folders; won't be the
            # actual check as intended, but doesn't give you anyone else's data
            # unless... See the following:
            #
            # TODO: Case not covered is usernames that are hexadecimal.
            #
            # We could probably attempt to convert the int(hex) into a time.gmtime(),
            # but it still would not cover all cases.
            #

            # If no folders where found... well... then there you go.
            if len(folders) < 1:
                return None

            # Pop off the hex timestamp, which turned out to be valid
            mbox['hex_timestamp'] = mbox['path_parts'].pop()

        return mbox

    def _find_deleted_folder(self, mbox):
        """
            Give me the parts that are in an original mailbox name and I'll find
            the deleted folder name.

            TODO: It finds virtdomain folders for non-virtdomain searches.
        """
        deleted_folder_search = "%(deleted_prefix)s%(seperator)s%(mailbox)s%(seperator)s*" % {
                    'deleted_prefix': "DELETED",
                    'mailbox': self.seperator.join(mbox['path_parts']),
                    'seperator': self.seperator,
                }

        if not mbox['domain'] == None:
            deleted_folder_search = "%s@%s" %(deleted_folder_search,mbox['domain'])

        folders = self.imap.lm(deleted_folder_search)

        #print "the deleted folders that i could find are:", folders

        if mbox['domain'] == None:
            #print "removing the folders that are virtdomain folders"
            _folders = []
            for folder in folders:
                if len(folder.split('@')) < 2:
                    _folders.append(folder)

            #print "remaining folders:", _folders
            folders = _folders

        return folders