summaryrefslogtreecommitdiff
path: root/Mailman/bin/rmlist.py
blob: fcc47b3f042819f7c39270f51ccd7efb062e138a (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
# Copyright (C) 1998-2007 by the Free Software Foundation, Inc.
#
# 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 Street, Fifth Floor, Boston, MA 02110-1301,
# USA.

import os
import sys
import shutil
import optparse

from Mailman import Errors
from Mailman import Utils
from Mailman import Version
from Mailman import database
from Mailman.MailList import MailList
from Mailman.configuration import config
from Mailman.i18n import _
from Mailman.initialize import initialize

__i18n_templates__ = True



def remove_it(listname, filename, msg, quiet=False):
    if os.path.islink(filename):
        if not quiet:
            print _('Removing $msg')
        os.unlink(filename)
    elif os.path.isdir(filename):
        if not quiet:
            print _('Removing $msg')
        shutil.rmtree(filename)
    elif os.path.isfile(filename):
        os.unlink(filename)
    else:
        if not quiet:
            print _('$listname $msg not found as $filename')



def delete_list(listname, mlist=None, archives=True, quiet=False):
    removeables = []
    if mlist:
        # Remove the list from the database
        database.remove_list(mlist)
        # Do the MTA-specific list deletion tasks
        if config.MTA:
            modname = 'Mailman.MTA.' + config.MTA
            __import__(modname)
            sys.modules[modname].remove(mlist)
        # Remove the list directory
        removeables.append((os.path.join('lists', listname), _('list info')))

    # Remove any stale locks associated with the list
    for filename in os.listdir(config.LOCK_DIR):
        fn_listname = filename.split('.')[0]
        if fn_listname == listname:
            removeables.append((os.path.join(config.LOCK_DIR, filename),
                                _('stale lock file')))

    if archives:
        removeables.extend([
            (os.path.join('archives', 'private', listname),
             _('private archives')),
            (os.path.join('archives', 'private', listname + '.mbox'),
             _('private archives')),
            (os.path.join('archives', 'public', listname),
             _('public archives')),
            (os.path.join('archives', 'public', listname + '.mbox'),
             _('public archives')),
            ])

    for dirtmpl, msg in removeables:
        path = os.path.join(config.VAR_DIR, dirtmpl)
        remove_it(listname, path, msg, quiet)



def parseargs():
    parser = optparse.OptionParser(version=Version.MAILMAN_VERSION,
                                   usage=_("""\
%prog [options] listname

Remove the components of a mailing list with impunity - beware!

This removes (almost) all traces of a mailing list.  By default, the lists
archives are not removed, which is very handy for retiring old lists.
"""))
    parser.add_option('-a', '--archives',
                      default=False, action='store_true', help=_("""\
Remove the list's archives too, or if the list has already been deleted,
remove any residual archives."""))
    parser.add_option('-C', '--config',
                      help=_('Alternative configuration file to use'))
    opts, args = parser.parse_args()
    if not args:
        parser.print_help()
        print >> sys.stderr, _('Missing listname')
        sys.exit(1)
    if len(args) > 1:
        parser.print_help()
        print >> sys.stderr, _('Unexpected arguments')
        sys.exit(1)
    return parser, opts, args



def main():
    parser, opts, args = parseargs()
    initialize(opts.config)

    listname = Utils.fqdn_listname(args[0])
    try:
        mlist = MailList(listname, lock=False)
    except Errors.MMUnknownListError:
        if not opts.archives:
            print >> sys.stderr, _(
                'No such list (or list already deleted): $listname')
            sys.exit(1)
        else:
            print _(
                'No such list: ${listname}.  Removing its residual archives.')
            mlist = None

    if not opts.archives:
        print _('Not removing archives.  Reinvoke with -a to remove them.')

    delete_list(listname, mlist, opts.archives)



if __name__ == '__main__':
    main()