# Copyright (C) 1998,1999,2000 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. """Process and produce the list-administration options forms. """ import os import cgi import string import types from Mailman import Utils from Mailman import MailList from Mailman import Errors from Mailman import MailCommandHandler from Mailman.htmlformat import * from Mailman.Crypt import crypt from Mailman import mm_cfg from Mailman.Cgi import Auth from Mailman.Logging.Syslog import syslog CATEGORIES = [('general', "General Options"), ('members', "Membership Management"), ('privacy', "Privacy Options"), ('nondigest', "Regular-member (non-digest) Options"), ('digest', "Digest-member Options"), ('bounce', "Bounce Options"), ('archive', "Archival Options"), ('gateway', "Mail-News and News-Mail gateways"), ('autoreply', 'Auto-responder'), ] def main(): """Process and produce list options form. CGI input indicates that we're returning from submission of some new settings, which is processed before producing the new version. """ syslog('debug', 'in admin.py') doc = Document() try: path = os.environ['PATH_INFO'] except KeyError: path = '' parts = Utils.GetPathPieces(path) # How many ../'s we need to get back to http://host/mailman if len(parts) == 0: FormatAdminOverview() return # get the list object listname = string.lower(parts[0]) try: mlist = MailList.MailList(listname) except Errors.MMListError, e: FormatAdminOverview('No such list %s' % listname) syslog('error', 'Someone tried to access the admin interface for a ' 'non-existent list: %s\n' % listname) return try: if len(parts) == 1: category = 'general' category_suffix = '' else: category = parts[1] category_suffix = category # If the user is not authenticated, we're done. cgidata = cgi.FieldStorage() try: Auth.authenticate(mlist, cgidata) except Auth.NotLoggedInError, e: Auth.loginpage(mlist, 'admin', e.message) return # Is this a log-out request? if category == 'logout': print mlist.ZapCookie('admin') Auth.loginpage(mlist, 'admin', frontpage=1) return if category not in map(lambda x: x[0], CATEGORIES): category = 'general' # is the request for variable details? varhelp = None if cgidata.has_key('VARHELP'): varhelp = cgidata['VARHELP'].value elif cgidata.has_key('request_login') and \ os.environ.get('QUERY_STRING'): # POST methods, even if their actions have a query string, don't # get put into FieldStorage's keys :-( qs = cgi.parse_qs(os.environ['QUERY_STRING']).get('VARHELP') if qs and type(qs) == types.ListType: varhelp = qs[0] if varhelp: FormatOptionHelp(doc, varhelp, mlist) print doc.Format(bgcolor="#ffffff") return if cgidata.has_key('bounce_matching_headers'): pairs = mlist.parse_matching_header_opt() if not mlist.digestable and len(mlist.GetDigestMembers()): AddErrorMessage(doc, 'Warning: you have digest members,' ' but digests are turned off.' ' Those people will not receive mail.') if not mlist.nondigestable and len(mlist.GetMembers()): AddErrorMessage(doc, 'Warning: you have list members,' ' but non-digestified mail is turned' ' off. They will receive mail until' ' you fix this problem.') if len(cgidata.keys()): ChangeOptions(mlist, category, cgidata, doc) FormatConfiguration(doc, mlist, category, category_suffix, cgidata) print doc.Format(bgcolor="#ffffff") finally: mlist.Save() mlist.Unlock() # Form Production: def FormatAdminOverview(error=None): "Present a general welcome and itemize the (public) lists." doc = Document() legend = "%s mailing lists - Admin Links" % mm_cfg.DEFAULT_HOST_NAME doc.SetTitle(legend) table = Table(border=0, width="100%") table.AddRow([Center(Header(2, legend))]) table.AddCellInfo(max(table.GetCurrentRowIndex(), 0), 0, colspan=2, bgcolor="#99ccff") advertised = [] names = Utils.list_names() names.sort() for n in names: l = MailList.MailList(n, lock=0) if l.advertised: advertised.append(l) if error: greeting = FontAttr(error, color="ff5060", size="+1") else: greeting = "Welcome!" if not advertised: welcome_items = (greeting, "
" " There currently are no publicly-advertised ", Link(mm_cfg.MAILMAN_URL, "mailman"), " mailing lists on %s." % mm_cfg.DEFAULT_HOST_NAME, ) else: welcome_items = ( greeting, "
" " Below is the collection of publicly-advertised ", Link(mm_cfg.MAILMAN_URL, "mailman"), " mailing lists on %s." % mm_cfg.DEFAULT_HOST_NAME, (' Click on a list name to visit the configuration pages' ' for that list.' ) ) welcome_items = (welcome_items + (" To visit the administrators configuration page for" " an unadvertised list, open a URL similar to this" + (" one, but with a '/' and the %slist name appended.
" % ((error and "right ") or "")) + " General list information can be found at ", Link("%slistinfo%s" % ('../' * Utils.GetNestingLevel(), mm_cfg.CGIEXT), "the mailing list overview page"), "." "
(Send questions and comments to ", Link("mailto:%s" % mm_cfg.MAILMAN_OWNER, mm_cfg.MAILMAN_OWNER), ".)
" ) ) table.AddRow([apply(Container, welcome_items)]) table.AddCellInfo(max(table.GetCurrentRowIndex(), 0), 0, colspan=2) if advertised: table.AddRow([' ', ' ']) table.AddRow([Bold("List"), Bold("Description")]) for l in advertised: table.AddRow( [Link(l.GetRelativeScriptURL('admin'), Bold(l.real_name)), l.description or Italic('[no description available]')]) doc.AddItem(table) doc.AddItem('
" % andpassmsg) form.AddItem(FormatOptionsSection(category, mlist, cgi_data)) if category == 'general': form.AddItem(Center(FormatPasswordStuff())) form.AddItem("
") form.AddItem(Center(FormatSubmit())) form.AddItem(mlist.GetMailmanFooter()) def FormatOptionsSection(category, mlist, cgi_data): """Produce the category-specific options table.""" if category == 'members': # Special case for members section. return FormatMembershipOptions(mlist, cgi_data) options = GetConfigOptions(mlist, category) big_table = Table(cellspacing=3, cellpadding=4) # Get and portray the text label for the category. for k, v in CATEGORIES: if k == category: label = v big_table.AddRow([Center(Header(2, label))]) big_table.AddCellInfo(max(big_table.GetCurrentRowIndex(), 0), 0, colspan=2, bgcolor="#99ccff") def ColHeader(big_table = big_table): big_table.AddRow([Center(Bold('Description')), Center(Bold('Value'))]) big_table.AddCellInfo(max(big_table.GetCurrentRowIndex(), 0), 0, width="15%") big_table.AddCellInfo(max(big_table.GetCurrentRowIndex(), 0), 1, width="85%") did_col_header = 0 for item in options: if type(item) == types.StringType: # The very first banner option (string in an options list) is # treated as a general description, while any others are # treated as section headers - centered and italicized... if did_col_header: item = "
" % (varname, category, descr)) doc.AddItem("%s
" % elaboration)
form = Form("%s/%s" % (mlist.GetRelativeScriptURL('admin'), category))
valtab = Table(cellspacing=3, cellpadding=4)
AddOptionsTableItem(valtab, item, category, mlist, detailsp=0)
form.AddItem(valtab)
# XXX I don't think we want to be able to set options from two places,
# since they'll go out of sync.
#form.AddItem(Center(FormatPasswordStuff()))
doc.AddItem(Center(form))
doc.AddItem("(Don't change the option here. "
'Use the ')
doc.AddItem(Link('%s/%s' % (mlist.GetRelativeScriptURL('admin'),
category),
category + ' options page'))
doc.AddItem(' instead.)')
def GetItemCharacteristics(table_entry):
"""Break out the components of an item description from its table entry:
0 option-var name
1 type
2 entry size
3 ?dependancies?
4 Brief description
5 Optional description elaboration"""
if len(table_entry) == 5:
elaboration = None
varname, kind, params, dependancies, descr = table_entry
elif len(table_entry) == 6:
varname, kind, params, dependancies, descr, elaboration = table_entry
else:
raise ValueError, ("Badly formed options entry:\n %s"
% table_entry)
return (varname, kind, params, dependancies, descr, elaboration)
def GetItemGuiValue(mlist, kind, varname, params):
"""Return a representation of an item's settings."""
if kind == mm_cfg.Radio or kind == mm_cfg.Toggle:
#
# if we are sending returning the option for subscribe
# policy and this site doesn't allow open subscribes,
# then we have to alter the value of mlist.subscribe_policy
# as passed to RadioButtonArray in order to compensate
# for the fact that there is one fewer option. correspondingly,
# we alter the value back in the change options function -scott
#
# TBD: this is an ugly ugly hack.
if varname[0] == '_':
checked = 0
else:
checked = getattr(mlist, varname)
if varname == 'subscribe_policy' and not mm_cfg.ALLOW_OPEN_SUBSCRIBE:
checked = checked - 1
return RadioButtonArray(varname, params, checked)
elif (kind == mm_cfg.String or kind == mm_cfg.Email or
kind == mm_cfg.Host or kind == mm_cfg.Number):
return TextBox(varname, getattr(mlist, varname), params)
elif kind == mm_cfg.Text:
if params:
r, c = params
else:
r, c = None, None
val = getattr(mlist, varname)
if not val:
val = ''
return TextArea(varname, val, r, c)
elif kind == mm_cfg.EmailList:
if params:
r, c = params
else:
r, c = None, None
res = string.join(getattr(mlist, varname), '\n')
return TextArea(varname, res, r, c, wrap='off')
elif kind == mm_cfg.FileUpload:
# like a text area, but also with uploading
if params:
r, c = params
else:
r, c = None, None
val = getattr(mlist, varname)
if not val:
val = ''
container = Container()
container.AddItem('Enter the text below, or...
')
container.AddItem(TextArea(varname, val, r, c))
container.AddItem('
...specify a file to upload
')
container.AddItem(FileUpload(varname+'_upload', r, c))
return container
def GetItemGuiDescr(mlist, category, varname, descr, detailsp):
"""Return the item's description, with link to details.
Details are not included if this is a VARHELP page, because that /is/ the
details page!
"""
if not detailsp:
return '
To View other sections, " "click on the appropriate range listed below") chunk_indices = range(len(chunks)) chunk_indices.remove(chunk) buttons = [] for ci in chunk_indices: start, end = chunks[ci][0], chunks[ci][-1] url = mlist.GetScriptURL('admin', relative=1) buttons.append(" from %s to %s " % (url, ci, start, end)) buttons = apply(UnorderedList, tuple(buttons)) footer = footer + buttons.Format() + "
" else: all.sort() footer = "
" for member in all: mtext = '%s' % ( mlist.GetOptionsURL(member, obscure=1, relative=1), mlist.GetUserSubscribedAddress(member)) cells = [mtext + "" % (member), Center(CheckBox(member + "_subscribed", "on", 1).Format())] for opt in ("hide", "nomail", "ack", "notmetoo"): if mlist.GetUserOption(member,MailCommandHandler.option_info[opt]): value = "on" checked = 1 else: value = "off" checked = 0 box = CheckBox("%s_%s" % (member, opt), value, checked) cells.append(Center(box.Format())) if mlist.members.has_key(member): cells.append(Center(CheckBox(member + "_digest", "off", 0).Format())) else: cells.append(Center(CheckBox(member + "_digest", "on", 1).Format())) if mlist.GetUserOption(member,MailCommandHandler.option_info['plain']): value = 'on' checked = 1 else: value = 'off' checked = 0 cells.append(Center(CheckBox('%s_plain' % member, value, checked))) user_table.AddRow(cells) container.AddItem(Center(user_table)) legend = UnorderedList() legend.AddItem('subscr -- Is the member subscribed?') legend.AddItem("hide -- Is the member's address " "concealed on the list of subscribers?") legend.AddItem('nomail -- Is delivery to the member disabled?') legend.AddItem('ack -- ' 'Does the member get acknowledgements of their posts?') legend.AddItem('not metoo -- ' 'Does the member avoid copies of their own posts?') legend.AddItem('digest -- ' 'Does the member get messages in digests? ' '(otherwise, individual messages)') legend.AddItem( 'plain -- ' 'If getting digests, does the member get plain text digests? ' '(otherwise, MIME)') container.AddItem(legend.Format()) container.AddItem(footer) t = Table(width="90%") t.AddRow([Center(Header(4, "Mass Subscribe Members"))]) t.AddCellInfo(t.GetCurrentRowIndex(), t.GetCurrentCellIndex(), bgcolor="#cccccc", colspan=8) if mlist.send_welcome_msg: nochecked = 0 yeschecked = 1 else: nochecked = 1 yeschecked = 0 t.AddRow([("1. Send Welcome message to this batch? " + RadioButton("send_welcome_msg_to_this_batch", 0, nochecked).Format() + " no " + RadioButton("send_welcome_msg_to_this_batch", 1, yeschecked).Format() + " yes ")]) t.AddRow(["2. Enter one address per line:
"]) container.AddItem(Center(t)) container.AddItem(Center(TextArea(name='subscribees', rows=10,cols=60,wrap=None))) return container def FormatPasswordStuff(): change_pw_table = Table(bgcolor="#99cccc", border=0, cellspacing=0, cellpadding=2, valign="top") change_pw_table.AddRow( [Bold(Center('To Change The Administrator Password'))]) change_pw_table.AddCellInfo(0, 0, align="left", colspan=2) old = Table(bgcolor="#99cccc", border=1, cellspacing=0, cellpadding=2, valign="top") old.AddRow(['
real_name attribute not changed! It must differ from the list's name by case only.
""") continue setattr(mlist, property, value) # # mass subscription processing for members category # if cgi_info.has_key('subscribees'): name_text = cgi_info['subscribees'].value name_text = string.replace(name_text, '\r', '') names = filter(None, map(string.strip, string.split(name_text, '\n'))) send_welcome_msg = string.atoi( cgi_info["send_welcome_msg_to_this_batch"].value) digest = 0 if not mlist.digestable: digest = 0 if not mlist.nondigestable: digest = 1 subscribe_errors = [] subscribe_success = [] result = mlist.ApprovedAddMembers(names, None, digest, send_welcome_msg) for name in result.keys(): if result[name] is None: subscribe_success.append(name) else: # `name' was not subscribed, find out why. On failures, # result[name] is set from sys.exc_info()[:2] e, v = result[name] if e is Errors.MMAlreadyAMember: subscribe_errors.append((name, 'Already a member')) elif e is Errors.MMBadEmailError: if name == '': name = '<blank line>' subscribe_errors.append( (name, "Bad/Invalid email address")) elif e is Errors.MMHostileAddress: subscribe_errors.append( (name, "Hostile Address (illegal characters)")) if subscribe_success: document.AddItem(Header(5, "Successfully Subscribed:")) document.AddItem(apply(UnorderedList, tuple((subscribe_success)))) document.AddItem("
") # ApprovedAddMembers will already have saved the list for us. if subscribe_errors: document.AddItem(Header(5, "Error Subscribing:")) items = map(lambda x: "%s -- %s" % (x[0], x[1]), subscribe_errors) document.AddItem(apply(UnorderedList, tuple((items)))) document.AddItem("
") # # do the user options for members category # if cgi_info.has_key('user'): user = cgi_info["user"] if type(user) is type([]): users = [] for ui in range(len(user)): users.append(user[ui].value) else: users = [user.value] unsubscribe_errors = [] for user in users: if not cgi_info.has_key('%s_subscribed' % (user)): try: mlist.DeleteMember(user) except Errors.MMNoSuchUserError: unsubscribe_errors.append((user, 'Not subscribed')) continue if not cgi_info.has_key("%s_digest" % (user)): if mlist.digest_members.has_key(user): del mlist.digest_members[user] if not mlist.members.has_key(user): mlist.members[user] = 0 else: if not mlist.digest_members.has_key(user): mlist.digest_members[user] = 0 if mlist.members.has_key(user): del mlist.members[user] for opt in ("hide", "nomail", "ack", "notmetoo", "plain"): opt_code = MailCommandHandler.option_info[opt] if cgi_info.has_key("%s_%s" % (user, opt)): mlist.SetUserOption(user, opt_code, 1, save_list=0) else: mlist.SetUserOption(user, opt_code, 0, save_list=0) if unsubscribe_errors: document.AddItem(Header(5, "Error Unsubscribing:")) items = map(lambda x: "%s -- %s" % (x[0], x[1]), unsubscribe_errors) document.AddItem(apply(UnorderedList, tuple((items)))) document.AddItem("
") def AddErrorMessage(doc, errmsg, *args): doc.AddItem(Header(3, Italic(FontAttr(errmsg % args, color="#ff66cc")))) _config_info = None def GetConfigOptions(mlist, category): global _config_info if _config_info == None: _config_info = mlist.GetConfigInfo() return _config_info[category]