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
|
# Copyright (C) 2009-2013 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/>.
"""Print the mailman configuration."""
from __future__ import absolute_import, print_function, unicode_literals
__metaclass__ = type
__all__ = [
'Mailmanconf'
]
import sys
from zope.interface import implementer
from lazr.config._config import Section
from mailman.config import config
from mailman.core.i18n import _
from mailman.interfaces.command import ICLISubCommand
@implementer(ICLISubCommand)
class Mailmanconf:
"""Print the mailman configuration."""
name = 'mailmanconf'
def add(self, parser, command_parser):
self.parser = parser
"""See `ICLISubCommand`."""
command_parser.add_argument(
'-o', '--output',
action='store', help=_("""\
File to send the output to. If not given, standard output is
used."""))
command_parser.add_argument(
'-s', '--section',
action='store', help=_("Section to use for the lookup (optional)."))
command_parser.add_argument(
'-k', '--key',
action='store', help=_("Key to use for the lookup (optional)."))
def __get_value(self, section, key):
return getattr(getattr(config, section), key)
def __print_full_syntax(self, section, key, value, output):
print('[{0}] {1}: {2}'.format(section, key, value), file=output)
def __show_key_error(self, key):
self.parser.error('No such key: %s' % key)
def __show_section_error(self, section):
self.parser.error('No such section: %s' % section)
def __print_values_for_section(self, section, output):
current_section = getattr(config, section)
for key in current_section:
if hasattr(current_section, key):
self.__print_full_syntax(section, key, self.__get_value(section, key), output)
def __section_exists(self, section):
# not all the attributes in config are actual sections,
# so we have to additionally check a sections type
return hasattr(config, section) and isinstance(getattr(config, section), Section)
def process(self, args):
"""See `ICLISubCommand`."""
if args.output is None:
output = sys.stdout
else:
# We don't need to close output because that will happen
# automatically when the script exits.
output = open(args.output, 'w')
section = args.section
key = args.key
# Case 1: Both section and key are given, we can directly look up the value
if section is not None and key is not None:
if self.__section_exists(section) and hasattr(getattr(config, section), key):
print(self.__get_value(section, key))
# Case 2: Section is given, key is not given
elif section is not None and key is None:
if self.__section_exists(section):
self.__print_values_for_section(section, output)
else:
self.__show_section_error(section)
# Case 3: Section is not given, key is given
elif section is None and key is not None:
for current_section in config.schema._section_schemas:
# We have to ensure that the current section actually exists and
# that it contains the given key
if self.__section_exists(current_section) and hasattr(getattr(config, current_section), key):
self.__print_full_syntax(current_section, key, self.__get_value(current_section, key), output)
# Case 4: Neither section nor key are given,
# just display all the sections and their corresponding key/value pairs.
elif section is None and key is None:
for current_section in config.schema._section_schemas:
# However, we have to make sure that the current sections and key
# which are being looked up actually exist before trying to print them
if self.__section_exists(current_section):
self.__print_values_for_section(current_section, output)
|
