summaryrefslogtreecommitdiff
path: root/src/mailman/commands/cli_info.py
blob: 4f8faace6de9c24509d63ca99b481f059f54233a (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
# Copyright (C) 2009-2017 by the Free Software Foundation, Inc.
#
# This file is part of GNU Mailman.
#
# GNU Mailman 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.
#
# GNU Mailman 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
# GNU Mailman.  If not, see <http://www.gnu.org/licenses/>.

"""Information about this Mailman instance."""

import sys
import click

from lazr.config import as_boolean
from mailman.config import config
from mailman.core.api import API30, API31
from mailman.core.i18n import _
from mailman.interfaces.command import ICLISubCommand
from mailman.utilities.options import I18nCommand
from mailman.version import MAILMAN_VERSION_FULL
from public import public
from zope.interface import implementer


@click.command(
    cls=I18nCommand,
    help=_('Information about this Mailman instance.'))
@click.option(
    '--output', '-o',
    type=click.File(mode='w', encoding='utf-8', atomic=True),
    help=_("""\
    File to send the output to.  If not given, standard output is used."""))
@click.option(
    '--verbose', '-v',
    is_flag=True, default=False,
    help=_("""\
    A more verbose output including the file system paths that Mailman is
    using."""))
def info(output, verbose):
    """See `ICLISubCommand`."""
    print(MAILMAN_VERSION_FULL, file=output)
    print('Python', sys.version, file=output)
    print('config file:', config.filename, file=output)
    print('db url:', config.db.url, file=output)
    print('devmode:',
          'ENABLED' if as_boolean(config.devmode.enabled) else 'DISABLED',
          file=output)
    api = (API30 if config.webservice.api_version == '3.0' else API31)
    print('REST root url:', api.path_to('/'), file=output)
    print('REST credentials: {}:{}'.format(
        config.webservice.admin_user, config.webservice.admin_pass),
        file=output)
    if verbose:
        print('File system paths:', file=output)
        longest = 0
        paths = {}
        for attribute in dir(config):
            if attribute.endswith('_DIR') or attribute.endswith('_FILE'):
                paths[attribute] = getattr(config, attribute)
            longest = max(longest, len(attribute))
        for attribute in sorted(paths):
            print('    {0:{2}} = {1}'.format(
                attribute, paths[attribute], longest))


@public
@implementer(ICLISubCommand)
class Info:
    name = 'info'
    command = info