summaryrefslogtreecommitdiffstats
path: root/pykolab/cli/cmd_mailbox_cleanup.py
blob: b7010eeca6cd2ecca87b2f96fce776ab8dbd5b6a (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
# -*- coding: utf-8 -*-
# Copyright 2010-2013 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, either version 3 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, see <http://www.gnu.org/licenses/>.
#

import ldap
import sys

import commands

import pykolab

from pykolab import imap_utf7
from pykolab.auth import Auth
from pykolab.imap import IMAP
from pykolab.translate import _

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

def __init__():
    commands.register('mailbox_cleanup', execute, description=description())

def cli_options():
    my_option_group = conf.add_cli_parser_option_group(_("CLI Options"))
    my_option_group.add_option(
            '--dry-run',
            dest    = "dryrun",
            action  = "store_true",
            default = False,
            help    = _("Do not actually delete mailboxes, but report what mailboxes would have been deleted.")
        )

def description():
    return _("Clean up mailboxes that do no longer have an owner.")

def execute(*args, **kw):
    """
        List mailboxes
    """

    auth = Auth()
    domains = auth.list_domains()

    imap = IMAP()
    imap.connect()

    domain_folders = {}

    subjects = []
    # Placeholder for subjects that would have already been deleted
    subjects_deleted = []

    for domain in domains.keys():
        domain_folders[domain] = imap.lm("user/%%@%s" % (domain))

    for domain in domain_folders.keys():
        auth = Auth(domain=domain)
        auth.connect(domain)

        for folder in domain_folders[domain]:
            user = folder.replace('user/','')

            try:
                recipient = auth.find_recipient(user)
            except ldap.NO_SUCH_OBJECT, errmsg:
                if not user in subjects_deleted and conf.dryrun:
                    subjects_deleted.append(user)

                if conf.dryrun:
                    log.info(_("Would have deleted folder 'user/%s' (dryrun)") % (user))
                else:
                    log.info(_("Deleting folder 'user/%s'") % (user))
                continue

            if len(recipient) == 0 or recipient == []:
                if not user in subjects_deleted and conf.dryrun:
                    subjects_deleted.append(user)

                if conf.dryrun:
                    log.info(_("Would have deleted folder 'user/%s' (dryrun)") % (user))
                else:
                    log.info(_("Deleting folder 'user/%s'") % (user))
                    try:
                        imap.dm(folder)
                    except:
                        log.error(_("Error deleting folder 'user/%s'") % (user))
            else:
                log.debug(_("Valid recipient found for 'user/%s'") % (user), level=6)

                if not user in subjects:
                    subjects.append(user)

    imap_domains = []
    folders = imap.lm()
    for folder in folders:
        namespace = folder.split('/')[0]
        mailbox = folder.split('/')[1]

        if len(mailbox.split('@')) > 1:
            domain = mailbox.split('@')[1]
            if not domain in domains.keys() and not domain in imap_domains:
                imap_domains.append(domain)

    for domain in imap_domains:
        for folder in imap.lm('user/%%@%s' % (domain)):

            user = folder.replace('user/', '')

            if not user in subjects_deleted and conf.dryrun:
                subjects_deleted.append(user)

            if conf.dryrun:
                log.info(_("Would have deleted folder '%s' (dryrun)") % (folder))
            else:
                log.info(_("Deleting folder '%s'") % (folder))
                try:
                    imap.dm(folder)
                except:
                    log.error(_("Error deleting folder '%s'") % (folder))

        for folder in imap.lm('shared/%%@%s' % (domain)):
            if conf.dryrun:
                log.info(_("Would have deleted folder '%s' (dryrun)") % (folder))
            else:
                log.info(_("Deleting folder '%s'") % (folder))
                try:
                    imap.dm(folder)
                except:
                    log.error(_("Error deleting folder '%s'") % (folder))

    for folder in [x for x in imap.lm() if not x.startswith('DELETED/')]:
        folder = imap_utf7.decode(folder)
        acls = imap.list_acls(folder)

        for subject in acls.keys():
            if subject == 'anyone':
                log.info(
                        _("Skipping removal of ACL %s for subject %s on folder %s") % (
                                acls[subject],
                                subject,
                                folder
                            )
                    )

                continue

            if not subject in subjects and not subject in subjects_deleted:
                if conf.dryrun:
                    log.info(
                            _("Would have deleted ACL %s for subject %s on folder %s") % (
                                    acls[subject],
                                    subject,
                                    folder
                                )
                        )
                else:
                    log.info(
                            _("Deleting ACL %s for subject %s on folder %s") % (
                                    acls[subject],
                                    subject,
                                    folder
                                )
                        )

                    try:
                        imap.set_acl(folder, aci_subject, '')
                    except:
                        log.error(
                                _("Error removing ACL %s for subject %s from folder %s") % (
                                        acls[subject],
                                        subject,
                                        folder
                                    )
                            )