aboutsummaryrefslogtreecommitdiffstats
path: root/bin/list_lists
blob: 3ab71fbf1d914234099890cc60d1cc090b749007 (plain) (blame)
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
#! @PYTHON@
#
# Copyright (C) 1998,1999,2000,2001,2002 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.

"""List all mailing lists.

Usage: %(program)s [options]

Where:

    -a / --advertised
        List only those mailing lists that are publically advertised

    -p / --public-archive
        List only those lists with public archives.

    --virtual-host-overview=domain
    -V domain
        List only those mailing lists that are homed to the given virtual
        domain.  This only works if the VIRTUAL_HOST_OVERVIEW variable is
        set.

    -b / --bare
        Displays only the list name, with no description.

    -h / --help
        Print this text and exit.

"""

import sys
import getopt
import paths

from Mailman import mm_cfg
from Mailman import MailList
from Mailman import Utils
from Mailman import Errors
from Mailman.i18n import _

program = sys.argv[0]

def usage(code, msg=''):
    if code:
        fd = sys.stderr
    else:
        fd = sys.stdout
    print >> fd, _(__doc__)
    if msg:
        print >> fd, msg
    sys.exit(code)



def main():
    try:
        opts, args = getopt.getopt(sys.argv[1:], 'apbV:h',
                                   ['advertised', 'public-archive', 'bare',
                                    'virtual-host-overview=',
                                    'help'])
    except getopt.error, msg:
        usage(1, msg)

    advertised = 0
    public = 0
    vhost = None
    bare = 0
    for opt, arg in opts:
        if opt in ('-h', '--help'):
            usage(0)
        elif opt in ('-a', '--advertised'):
            advertised = 1
        elif opt in ('-p', '--public-archive'):
            public = 1
        elif opt in ('-V', '--virtual-host-overview'):
            vhost = arg
        elif opt in ('-b', '--bare'):
            bare = 1

    names = Utils.list_names()
    names.sort()

    mlists = []
    longest = 0
    for n in names:
        mlist = MailList.MailList(n, lock=0)
        if advertised and not mlist.advertised:
            continue
        if public and mlist.archive_private:
            continue
        if vhost and mm_cfg.VIRTUAL_HOST_OVERVIEW and \
               vhost.find(mlist.web_page_url) == -1 and \
               mlist.web_page_url.find(vhost) == -1:
            continue
        mlists.append(mlist)
        longest = max(len(mlist.real_name), longest)

    if not mlists and not bare:
        print _('No matching mailing lists found')
        return

    if not bare:
        print len(mlists), _('matching mailing lists found:')

    format = '%%%ds - %%.%ds' % (longest, 77 - longest)
    for mlist in mlists:
        if bare:
            print mlist.internal_name()
        else:
            description = mlist.description or _('[no description available]')
            print '   ', format % (mlist.real_name, description)



if __name__ == '__main__':
    main()