[Mailman-Developers] Real Name Support
Nicholas Marouf
marouni@earlham.edu
Thu, 28 Dec 2000 09:52:03 -0500
This is a multi-part message in MIME format.
--------------268321D1775935CAA82A6949
Content-Type: text/plain; charset=us-ascii
Content-Transfer-Encoding: 7bit
Hello,
One of the Student workers here, was working on getting real name
support into Mailman, and lets say did not finish the job. I've been
playing with it for a while, and now I am getting that it is umarshable
object. Can somone take a look at it, or point in the right direction to
what might I have done wrong.
Thanks alot
Nick
PS. I am attaching add_members, Address.py, MailList.py, Utils.py
I've marked every location that a change was made with #xxx
[root@odysseus bin]# ./add_members -n t.t test
Utils: Nicholas Marouf<marouf@earlham.edu>
Utils: Nicholas Marouf Utils: Charlie Peck <charliep@cs.earlham.edu>
Utils: Charlie Peck
Traceback (innermost last): File "./add_members", line 221, in ?
main() File "./add_members", line 195, in main nres =
ml.ApprovedAddMembers(nmembers, None, 0, send_welcome_msg) File
"/home/software/mailman/Mailman/MailList.py", line 1140, in
ApprovedAddMembers self.Save() File
"/home/software/mailman/Mailman/MailList.py", line 867, in Save
self.__save(dict) File "/home/software/mailman/Mailman/MailList.py",
line 826, in __save fp.write(marshal.dumps(dict)) ValueError:
unmarshallable object
[root@odysseus bin]#
--
Nicholas Marouf || Earlham College || Student System Administrator.
------------------------------------------------------------------
http://www.ramallaonline.com
http://www.ramallahonline.com/cgibin/Ultimate.cgi?
--------------268321D1775935CAA82A6949
Content-Type: text/plain; charset=us-ascii;
name="Address.py"
Content-Transfer-Encoding: 7bit
Content-Disposition: inline;
filename="Address.py"
# Nothing fancy here, just a class, really not much more than a struct.
# I need to be able to pass both the name and the address for each
# person on the mailing list, though, and this seems like the easiest
# way to make the conversion. - Ben Bartlett 9/20/00
class address:
name = ''
addr = ''
--------------268321D1775935CAA82A6949
Content-Type: text/plain; charset=us-ascii;
name="MailList.py"
Content-Transfer-Encoding: 7bit
Content-Disposition: inline;
filename="MailList.py"
# 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.
"""The class representing a Mailman mailing list.
Mixes in many task-specific classes.
"""
import sys
import os
import marshal
import string
import errno
import re
import shutil
import socket
from types import StringType, IntType, DictType, ListType
import urllib
from urlparse import urlparse
from Mailman import mm_cfg
from Mailman import Utils
from Mailman import Errors
from Mailman import LockFile
#xxx
from Mailman import Address
# base classes
from Mailman.ListAdmin import ListAdmin
from Mailman.Deliverer import Deliverer
from Mailman.MailCommandHandler import MailCommandHandler
from Mailman.HTMLFormatter import HTMLFormatter
from Mailman.Archiver import Archiver
from Mailman.Digester import Digester
from Mailman.SecurityManager import SecurityManager
from Mailman.Bouncer import Bouncer
from Mailman.GatewayManager import GatewayManager
from Mailman.Autoresponder import Autoresponder
from Mailman.Logging.Syslog import syslog
# other useful classes
from Mailman.pythonlib.StringIO import StringIO
from Mailman import Message
from Mailman.Handlers import HandlerAPI
# Note:
# an _ in front of a member variable for the MailList class indicates
# a variable that does not save when we marshal our state.
# Use mixins here just to avoid having any one chunk be too large.
class MailList(MailCommandHandler, HTMLFormatter, Deliverer, ListAdmin,
Archiver, Digester, SecurityManager, Bouncer, GatewayManager,
Autoresponder):
def __init__(self, name=None, lock=1):
# No timeout by default. If you want to timeout, open the list
# unlocked, then lock explicitly.
MailCommandHandler.__init__(self)
self.InitTempVars(name)
if name:
if lock:
# This will load the database.
self.Lock()
else:
self.Load()
def __del__(self):
try:
self.Unlock()
except AttributeError:
# List didn't get far enough to have __lock
pass
def GetMembers(self, new = 0):
"""returns a list of the members. (all lowercase)"""
if new == 0:
return self.members.keys()
else:
return self.members.items()
def GetDigestMembers(self, new = 0):
"""returns a list of digest members. (all lowercase)"""
if new == 0:
return self.digest_members.keys()
else:
return self.digest_members.items()
def GetDeliveryMembers(self):
"""returns a list of the members with username case preserved."""
res = []
for k, v in self.members.items():
if type(v) is StringType:
res.append(v)
else:
res.append(k)
return res
def GetDigestDeliveryMembers(self):
"""returns a list of the members with username case preserved."""
res = []
for k,v in self.digest_members.items():
if type(v) is StringType:
res.append(v)
else:
res.append(k)
return res
#xxx
def __AddMember(self, email, digest):
"""adds the appropriate data to the internal members dict.
If the username has upercase letters in it, then the value
in the members dict is the case preserved address, otherwise,
the value is 0.
"""
if Utils.LCDomain(email.addr) == string.lower(email.addr):
if digest:
self.digest_members[email] = 0
else:
self.members[email] = 0
else:
if digest:
self.digest_members[string.lower(email.addr)] = email
else:
self.members[string.lower(email.addr)] = email
def GetAdminEmail(self):
return '%s-admin@%s' % (self._internal_name, self.host_name)
def GetOwnerEmail(self):
return '%s-owner@%s' % (self._internal_name, self.host_name)
def GetMemberAdminEmail(self, member):
"""Usually the member addr, but modified for umbrella lists.
Umbrella lists have other mailing lists as members, and so admin stuff
like confirmation requests and passwords must not be sent to the
member addresses - the sublists - but rather to the administrators of
the sublists. This routine picks the right address, considering
regular member address to be their own administrative addresses.
"""
if not self.umbrella_list:
return member
else:
acct, host = tuple(string.split(member, '@'))
return "%s%s@%s" % (acct, self.umbrella_member_suffix, host)
def GetUserSubscribedAddress(self, member):
"""Return the member's case preserved address.
"""
member = string.lower(member)
cpuser = self.members.get(member)
if type(cpuser) == IntType:
return member
elif type(cpuser) == StringType:
return cpuser
cpuser = self.digest_members.get(member)
if type(cpuser) == IntType:
return member
elif type(cpuser) == StringType:
return cpuser
return None
def GetUserCanonicalAddress(self, member):
"""Return the member's address lower cased."""
cpuser = self.GetUserSubscribedAddress(member)
if cpuser is not None:
return string.lower(cpuser)
return None
def GetRequestEmail(self):
return '%s-request@%s' % (self._internal_name, self.host_name)
def GetListEmail(self):
return '%s@%s' % (self._internal_name, self.host_name)
def GetScriptURL(self, scriptname, absolute=0):
return Utils.ScriptURL(scriptname, self.web_page_url, absolute) + \
'/' + self.internal_name()
def GetOptionsURL(self, addr, obscure=0, absolute=0):
addr = string.lower(addr)
url = self.GetScriptURL('options', absolute)
if obscure:
addr = Utils.ObscureEmail(addr)
return '%s/%s' % (url, urllib.quote(addr))
def GetUserOption(self, user, option):
"""Return user's setting for option, defaulting to 0 if no settings."""
user = self.GetUserCanonicalAddress(user)
if option == mm_cfg.Digests:
return self.digest_members.has_key(user)
if not self.user_options.has_key(user):
return 0
return not not self.user_options[user] & option
def SetUserOption(self, user, option, value, save_list=1):
user = self.GetUserCanonicalAddress(user)
if not self.user_options.has_key(user):
self.user_options[user] = 0
if value:
self.user_options[user] = self.user_options[user] | option
else:
self.user_options[user] = self.user_options[user] & ~(option)
if not self.user_options[user]:
del self.user_options[user]
if save_list:
self.Save()
# Here are the rules for the three dictionaries self.members,
# self.digest_members, and self.passwords:
#
# The keys of all these dictionaries are the lowercased version of the
# address. This makes finding a user very quick: just lowercase the name
# you're matching against, and do a has_key() or get() on first
# self.members, then if that returns false, self.digest_members
#
# The value of the key in self.members and self.digest_members is either
# the integer 0, meaning the user was subscribed with an all-lowercase
# address, or a string which would be the address with the username part
# case preserved. Note that for Mailman versions before 1.0b11, the value
# could also have been the integer 1. This is a bug that was caused when
# a user switched from regular to/from digest membership. If this
# happened, you're screwed because there's no way to recover the case
# preserved address. :-(
#
# The keys for self.passwords is also lowercase, although for versions of
# Mailman before 1.0b11, this was not always true. 1.0b11 has a hack in
# Load() that forces the keys to lowercase. The value for the keys in
# self.passwords is, of course the password in plain text.
def FindUser(self, email):
"""Return the lowercased version of the subscribed email address.
If email is not subscribed, either as a regular member or digest
member, None is returned. If they are subscribed, the return value is
guaranteed to be lowercased.
"""
# shortcut
lcuser = self.GetUserCanonicalAddress(email)
if lcuser is not None:
return lcuser
matches = Utils.FindMatchingAddresses(email,
self.members,
self.digest_members)
# sadly, matches may or may not be case preserved
if not matches or not len(matches):
return None
return string.lower(matches[0])
def InitTempVars(self, name):
"""Set transient variables of this and inherited classes."""
self.__lock = LockFile.LockFile(
os.path.join(mm_cfg.LOCK_DIR, name or '<site>') + '.lock',
# TBD: is this a good choice of lifetime?
lifetime = mm_cfg.LIST_LOCK_LIFETIME,
withlogging = mm_cfg.LIST_LOCK_DEBUGGING)
self._internal_name = name
self._ready = 0
if name:
self._full_path = os.path.join(mm_cfg.LIST_DATA_DIR, name)
else:
self._full_path = None
ListAdmin.InitTempVars(self)
def InitVars(self, name=None, admin='', crypted_password=''):
"""Assign default values - some will be overriden by stored state."""
# Non-configurable list info
if name:
self._internal_name = name
# Must save this state, even though it isn't configurable
self.volume = 1
self.members = {} # self.digest_members is initted in mm_digest
self.data_version = mm_cfg.DATA_FILE_VERSION
self.last_post_time = 0
self.post_id = 1. # A float so it never has a chance to overflow.
self.user_options = {}
# This stuff is configurable
self.filter_prog = mm_cfg.DEFAULT_FILTER_PROG
self.dont_respond_to_post_requests = 0
self.advertised = mm_cfg.DEFAULT_LIST_ADVERTISED
self.max_num_recipients = mm_cfg.DEFAULT_MAX_NUM_RECIPIENTS
self.max_message_size = mm_cfg.DEFAULT_MAX_MESSAGE_SIZE
self.web_page_url = mm_cfg.DEFAULT_URL
self.owner = [admin]
self.reply_goes_to_list = mm_cfg.DEFAULT_REPLY_GOES_TO_LIST
self.reply_to_address = ''
self.posters = []
self.forbidden_posters = []
self.admin_immed_notify = mm_cfg.DEFAULT_ADMIN_IMMED_NOTIFY
self.admin_notify_mchanges = \
mm_cfg.DEFAULT_ADMIN_NOTIFY_MCHANGES
self.moderated = mm_cfg.DEFAULT_MODERATED
self.require_explicit_destination = \
mm_cfg.DEFAULT_REQUIRE_EXPLICIT_DESTINATION
self.acceptable_aliases = mm_cfg.DEFAULT_ACCEPTABLE_ALIASES
self.umbrella_list = mm_cfg.DEFAULT_UMBRELLA_LIST
self.umbrella_member_suffix = \
mm_cfg.DEFAULT_UMBRELLA_MEMBER_ADMIN_SUFFIX
self.send_reminders = mm_cfg.DEFAULT_SEND_REMINDERS
self.send_welcome_msg = mm_cfg.DEFAULT_SEND_WELCOME_MSG
self.bounce_matching_headers = \
mm_cfg.DEFAULT_BOUNCE_MATCHING_HEADERS
self.anonymous_list = mm_cfg.DEFAULT_ANONYMOUS_LIST
self.real_name = '%s%s' % (string.upper(self._internal_name[0]),
self._internal_name[1:])
self.description = ''
self.info = ''
self.welcome_msg = ''
self.goodbye_msg = ''
self.subscribe_policy = mm_cfg.DEFAULT_SUBSCRIBE_POLICY
self.private_roster = mm_cfg.DEFAULT_PRIVATE_ROSTER
self.obscure_addresses = mm_cfg.DEFAULT_OBSCURE_ADDRESSES
self.member_posting_only = mm_cfg.DEFAULT_MEMBER_POSTING_ONLY
self.host_name = mm_cfg.DEFAULT_HOST_NAME
self.admin_member_chunksize = mm_cfg.DEFAULT_ADMIN_MEMBER_CHUNKSIZE
self.administrivia = mm_cfg.DEFAULT_ADMINISTRIVIA
# Analogs to these are initted in Digester.InitVars
self.nondigestable = mm_cfg.DEFAULT_NONDIGESTABLE
Digester.InitVars(self) # has configurable stuff
SecurityManager.InitVars(self, crypted_password)
Archiver.InitVars(self) # has configurable stuff
ListAdmin.InitVars(self)
Bouncer.InitVars(self)
GatewayManager.InitVars(self)
HTMLFormatter.InitVars(self)
Autoresponder.InitVars(self)
# These need to come near the bottom because they're dependent on
# other settings.
self.subject_prefix = mm_cfg.DEFAULT_SUBJECT_PREFIX % self.__dict__
self.msg_header = mm_cfg.DEFAULT_MSG_HEADER
self.msg_footer = mm_cfg.DEFAULT_MSG_FOOTER
def GetConfigInfo(self):
config_info = {}
config_info['digest'] = Digester.GetConfigInfo(self)
config_info['archive'] = Archiver.GetConfigInfo(self)
config_info['gateway'] = GatewayManager.GetConfigInfo(self)
config_info['autoreply'] = Autoresponder.GetConfigInfo(self)
WIDTH = mm_cfg.TEXTFIELDWIDTH
# XXX: Should this text be migrated into the templates dir?
config_info['general'] = [
"Fundamental list characteristics, including descriptive"
" info and basic behaviors.",
('real_name', mm_cfg.String, WIDTH, 0,
'The public name of this list (make case-changes only).',
"The capitalization of this name can be changed to make it"
" presentable in polite company as a proper noun, or to make an"
" acronym part all upper case, etc. However, the name"
" will be advertised as the email address (e.g., in subscribe"
" confirmation notices), so it should <em>not</em> be otherwise"
" altered. (Email addresses are not case sensitive, but"
" they are sensitive to almost everything else:-)"),
('owner', mm_cfg.EmailList, (3, WIDTH), 0,
"The list admin's email address - having multiple"
" admins/addresses (on separate lines) is ok."),
('description', mm_cfg.String, WIDTH, 0,
'A terse phrase identifying this list.',
"This description is used when the mailing list is listed with"
" other mailing lists, or in headers, and so forth. It should"
" be as succinct as you can get it, while still identifying"
" what the list is."),
('info', mm_cfg.Text, (7, WIDTH), 0,
' An introductory description - a few paragraphs - about the'
' list. It will be included, as html, at the top of the'
' listinfo page. Carriage returns will end a paragraph - see'
' the details for more info.',
"The text will be treated as html <em>except</em> that newlines"
" newlines will be translated to <br> - so you can use"
" links, preformatted text, etc, but don't put in carriage"
" returns except where you mean to separate paragraphs. And"
" review your changes - bad html (like some unterminated HTML"
" constructs) can prevent display of the entire listinfo page."),
('subject_prefix', mm_cfg.String, WIDTH, 0,
'Prefix for subject line of list postings.',
"This text will be prepended to subject lines of messages"
" posted to the list, to distinguish mailing list messages in"
" in mailbox summaries. Brevity is premium here, it's ok"
" to shorten long mailing list names to something more concise,"
" as long as it still identifies the mailing list."),
('welcome_msg', mm_cfg.Text, (4, WIDTH), 0,
'List-specific text prepended to new-subscriber welcome message',
"This value, if any, will be added to the front of the"
" new-subscriber welcome message. The rest of the"
" welcome message already describes the important addresses"
" and URLs for the mailing list, so you don't need to include"
" any of that kind of stuff here. This should just contain"
" mission-specific kinds of things, like etiquette policies"
" or team orientation, or that kind of thing."),
('goodbye_msg', mm_cfg.Text, (4, WIDTH), 0,
'Text sent to people leaving the list. If empty, no special'
' text will be added to the unsubscribe message.'),
('reply_goes_to_list', mm_cfg.Radio,
('Poster', 'This list', 'Explicit address'), 0,
'''Where are replies to list messages directed? <tt>Poster</tt>
is <em>strongly</em> recommended for most mailing lists.''',
# Details for reply_goes_to_list
"""This option controls what Mailman does to the
<tt>Reply-To:</tt> header in messages flowing through this mailing list. When
set to <em>Poster</em>, no <tt>Reply-To:</tt> header is added by Mailman,
although if one is present in the original message, it is not stripped.
Setting this value to either <em>This list</em> or <em>Explicit address</em>
causes Mailman to insert a specific <tt>Reply-To:</tt> header in all messages,
overriding the header in the original message if necessary (<em>Explicit
address</em> inserts the value of <a
href="?VARHELP=general/reply_to_address">reply_to_address</a>).
<p>There are many reasons not to introduce or override the <tt>Reply-To:</tt>
header. One is that some posters depend on their own <tt>Reply-To:</tt>
settings to convey their valid return address. Another is that modifying
<tt>Reply-To:</tt> makes it much more difficult to send private replies. See
<a href="http://www.unicom.com/pw/reply-to-harmful.html">`Reply-To' Munging
Considered Harmful</a> for a general discussion of this issue. See <a
href="http://www.metasystema.org/essays/reply-to-useful.mhtml">Reply-To
Munging Considered Useful</a> for a dissenting opinion.
<p>Some mailing lists have restricted posting privileges, with a parallel list
devoted to discussions. Examples are `patches' or `checkin' lists, where
software changes are posted by a revision control system, but discussion about
the changes occurs on a developers mailing list. To support these types of
mailing lists, select <tt>Explicit address</tt> and set the <tt>Reply-To:</tt>
address below to point to the parallel list."""),
('reply_to_address', mm_cfg.Email, WIDTH, 0,
'''Explicit <tt>Reply-To:</tt> header.''',
# Details for reply_to_address
"""This is the address set in the <tt>Reply-To:</tt> header
when the <a href="?VARHELP=general/reply_goes_to_list">reply_goes_to_list</a>
option is set to <em>Explicit address</em>.
<p>There are many reasons not to introduce or override the <tt>Reply-To:</tt>
header. One is that some posters depend on their own <tt>Reply-To:</tt>
settings to convey their valid return address. Another is that modifying
<tt>Reply-To:</tt> makes it much more difficult to send private replies. See
<a href="http://www.unicom.com/pw/reply-to-harmful.html">`Reply-To' Munging
Considered Harmful</a> for a general discussion of this issue. See <a
href="http://www.metasystema.org/essays/reply-to-useful.mhtml">Reply-To
Munging Considered Useful</a> for a dissenting opinion.
<p>Some mailing lists have restricted posting privileges, with a parallel list
devoted to discussions. Examples are `patches' or `checkin' lists, where
software changes are posted by a revision control system, but discussion about
the changes occurs on a developers mailing list. To support these types of
mailing lists, select <tt>Explicit address</tt> and set the <tt>Reply-To:</tt>
address below to point to the parallel list."""),
('administrivia', mm_cfg.Radio, ('No', 'Yes'), 0,
"(Administrivia filter) Check postings and intercept ones"
" that seem to be administrative requests?",
"Administrivia tests will check postings to see whether"
" it's really meant as an administrative request (like"
" subscribe, unsubscribe, etc), and will add it to the"
" the administrative requests queue, notifying the "
" administrator of the new request, in the process. "),
('umbrella_list', mm_cfg.Radio, ('No', 'Yes'), 0,
'Send password reminders to, eg, "-owner" address instead of'
' directly to user.',
"Set this to yes when this list is intended to cascade only to"
" other mailing lists. When set, meta notices like confirmations"
" and password reminders will be directed to an address derived"
" from the member\'s address - it will have the value of"
' \"umbrella_member_suffix\" appended to the'
" member\'s account name."),
('umbrella_member_suffix', mm_cfg.String, WIDTH, 0,
'Suffix for use when this list is an umbrella for other lists,'
' according to setting of previous "umbrella_list" setting.',
'When \"umbrella_list\" is set to indicate that this list has'
" other mailing lists as members, then administrative notices"
" like confirmations and password reminders need to not be sent"
" to the member list addresses, but rather to the owner of those"
" member lists. In that case, the value of this setting is"
" appended to the member\'s account name for such notices."
" \'-owner\' is the typical choice. This setting has no"
' effect when \"umbrella_list\" is \"No\".'),
('send_reminders', mm_cfg.Radio, ('No', 'Yes'), 0,
'Send monthly password reminders or no? Overrides the previous '
'option.'),
('send_welcome_msg', mm_cfg.Radio, ('No', 'Yes'), 0,
'Send welcome message when people subscribe?',
"Turn this on only if you plan on subscribing people manually "
"and don't want them to know that you did so. This option "
"is most useful for transparently migrating lists from "
"some other mailing list manager to Mailman."),
('admin_immed_notify', mm_cfg.Radio, ('No', 'Yes'), 0,
'Should administrator get immediate notice of new requests, '
'as well as daily notices about collected ones?',
"List admins are sent daily reminders of pending admin approval"
" requests, like subscriptions to a moderated list or postings"
" that are being held for one reason or another. Setting this"
" option causes notices to be sent immediately on the arrival"
" of new requests, as well."),
('admin_notify_mchanges', mm_cfg.Radio, ('No', 'Yes'), 0,
'Should administrator get notices of subscribes/unsubscribes?'),
('dont_respond_to_post_requests', mm_cfg.Radio, ('Yes', 'No'), 0,
'Send mail to poster when their posting is held for approval?',
"Approval notices are sent when mail triggers certain of the"
" limits <em>except</em> routine list moderation and spam"
" filters, for which notices are <em>not</em> sent. This"
" option overrides ever sending the notice."),
('max_message_size', mm_cfg.Number, 7, 0,
'Maximum length in Kb of a message body. Use 0 for no limit.'),
('host_name', mm_cfg.Host, WIDTH, 0,
'Host name this list prefers.',
"The host_name is the preferred name for email to mailman-related"
" addresses on this host, and generally should be the mail"
" host's exchanger address, if any. This setting can be useful"
" for selecting among alternative names of a host that has"
" multiple addresses."),
('web_page_url', mm_cfg.String, WIDTH, 0,
'''Base URL for Mailman web interface. The URL must end in a
single "/". See also the details for an important warning when
changing this value.''',
"""This is the common root for all Mailman URLs referencing this
mailing list. It is also used in the listinfo overview of
mailing lists to identify whether or not this list resides on the
virtual host identified by the overview URL; i.e. if this value
is found (anywhere) in the URL, then this list is considered to
be on that virtual host. If not, then it is excluded from the
listing.
<p><b><font size="+1">Warning:</font></b> setting this value to
an invalid base URL will render the mailing list unusable. You
will also not be able to fix this from the web interface! In
that case, the site administrator will have to fix the mailing
list from the command line."""),
]
if mm_cfg.ALLOW_OPEN_SUBSCRIBE:
sub_cfentry = ('subscribe_policy', mm_cfg.Radio,
('none', 'confirm', 'require approval',
'confirm+approval'), 0,
"What steps are required for subscription?<br>",
"None - no verification steps (<em>Not"
" Recommended </em>)<br>"
"confirm (*) - email confirmation step"
" required <br>"
"require approval - require list administrator"
" approval for subscriptions <br>"
"confirm+approval - both confirm and approve"
"<p> (*) when someone requests a subscription,"
" mailman sends them a notice with a unique"
" subscription request number that they must"
" reply to in order to subscribe.<br> This"
" prevents mischievous (or malicious) people"
" from creating subscriptions for others"
" without their consent."
)
else:
sub_cfentry = ('subscribe_policy', mm_cfg.Radio,
('confirm', 'require approval',
'confirm+approval'), 1,
"What steps are required for subscription?<br>",
"confirm (*) - email confirmation required <br>"
"require approval - require list administrator"
" approval for subscriptions <br>"
"confirm+approval - both confirm and approve"
"<p> (*) when someone requests a subscription,"
" mailman sends them a notice with a unique"
" subscription request number that they must"
" reply to in order to subscribe.<br> This"
" prevents mischievous (or malicious) people"
" from creating subscriptions for others"
" without their consent."
)
config_info['privacy'] = [
"List access policies, including anti-spam measures,"
" covering members and outsiders."
' (See also the <a href="%s/archive">Archival Options'
' section</a> for separate archive-privacy settings.)'
% (self.GetScriptURL('admin')),
"Subscribing",
('advertised', mm_cfg.Radio, ('No', 'Yes'), 0,
'Advertise this list when people ask what lists are on '
'this machine?'),
sub_cfentry,
"Membership exposure",
('private_roster', mm_cfg.Radio,
('Anyone', 'List members', 'List admin only'), 0,
'Who can view subscription list?',
"When set, the list of subscribers is protected by"
" member or admin password authentication."),
('obscure_addresses', mm_cfg.Radio, ('No', 'Yes'), 0,
"Show member addrs so they're not directly recognizable"
' as email addrs?',
"Setting this option causes member email addresses to be"
" transformed when they are presented on list web pages (both"
" in text and as links), so they're not trivially"
" recognizable as email addresses. The intention is to"
" to prevent the addresses from being snarfed up by"
" automated web scanners for use by spammers."),
"General posting filters",
('moderated', mm_cfg.Radio, ('No', 'Yes'), 0,
'Must posts be approved by an administrator?'),
('member_posting_only', mm_cfg.Radio, ('No', 'Yes'), 0,
'Restrict posting privilege to list members?'
' (<i>member_posting_only</i>)',
"Use this option if you want to restrict posting to list members."
" If you want list members to be able to"
" post, plus a handful of other posters, see the <i> posters </i>"
" setting below"),
('posters', mm_cfg.EmailList, (5, WIDTH), 1,
'Addresses of members accepted for posting to this'
' list without implicit approval requirement. (See'
' "Restrict ... to list members"'
' for whether or not this is in addition to allowing posting'
' by list members',
"Adding entries here will have one of two effects,"
" according to whether another option restricts posting to"
" members. <ul>"
" <li> If <i>member_posting_only</i> is 'yes', then entries"
" added here will have posting privilege in addition to"
" list members."
" <li> If <i>member_posting_only</i> is 'no', then <em>only</em>"
" the posters listed here will be able to post without admin"
" approval. </ul>"),
"Spam-specific posting filters",
('require_explicit_destination', mm_cfg.Radio, ('No', 'Yes'), 0,
'Must posts have list named in destination (to, cc) field'
' (or be among the acceptable alias names, specified below)?',
"Many (in fact, most) spams do not explicitly name their myriad"
" destinations in the explicit destination addresses - in fact,"
" often the to field has a totally bogus address for"
" obfuscation. The constraint applies only to the stuff in"
" the address before the '@' sign, but still catches all such"
" spams."
"<p>The cost is that the list will not accept unhindered any"
" postings relayed from other addresses, unless <ol>"
" <li>The relaying address has the same name, or"
" <li>The relaying address name is included on the options that"
" specifies acceptable aliases for the list. </ol>"),
('acceptable_aliases', mm_cfg.Text, (4, WIDTH), 0,
'Alias names (regexps) which qualify as explicit to or cc'
' destination names for this list.',
"Alternate addresses that are acceptable when"
" `require_explicit_destination' is enabled. This option"
" takes a list of regular expressions, one per line, which is"
" matched against every recipient address in the message. The"
" matching is performed with Python's re.match() function,"
" meaning they are anchored to the start of the string."
" <p>For backwards compatibility with Mailman 1.1, if the regexp"
" does not contain an `@', then the pattern is matched against"
" just the local part of the recipient address. If that match"
" fails, or if the pattern does contain an `@', then the pattern"
" is matched against the entire recipient address. "
" <p>Matching against the local part is deprecated; in a future"
" release, the patterm will always be matched against the "
" entire recipient address."),
('max_num_recipients', mm_cfg.Number, 5, 0,
'Ceiling on acceptable number of recipients for a posting.',
"If a posting has this number, or more, of recipients, it is"
" held for admin approval. Use 0 for no ceiling."),
('forbidden_posters', mm_cfg.EmailList, (5, WIDTH), 1,
'Addresses whose postings are always held for approval.',
"Email addresses whose posts should always be held for"
" approval, no matter what other options you have set."
" See also the subsequent option which applies to arbitrary"
" content of arbitrary headers."),
('bounce_matching_headers', mm_cfg.Text, (6, WIDTH), 0,
'Hold posts with header value matching a specified regexp.',
"Use this option to prohibit posts according to specific header"
" values. The target value is a regular-expression for"
" matching against the specified header. The match is done"
" disregarding letter case. Lines beginning with '#' are"
" ignored as comments."
"<p>For example:<pre>to: .*@public.com </pre> says"
" to hold all postings with a <em>to</em> mail header"
" containing '@public.com' anywhere among the addresses."
"<p>Note that leading whitespace is trimmed from the"
" regexp. This can be circumvented in a number of ways, eg"
" by escaping or bracketing it."
"<p> See also the <em>forbidden_posters</em> option for"
" a related mechanism."),
('anonymous_list', mm_cfg.Radio, ('No', 'Yes'), 0,
'Hide the sender of a message, replacing it with the list '
'address (Removes From, Sender and Reply-To fields)'),
]
config_info['nondigest'] = [
"Policies concerning immediately delivered list traffic.",
('nondigestable', mm_cfg.Toggle, ('No', 'Yes'), 1,
'Can subscribers choose to receive mail immediately,'
' rather than in batched digests?'),
('msg_header', mm_cfg.Text, (4, WIDTH), 0,
'Header added to mail sent to regular list members',
"Text prepended to the top of every immediately-delivery"
" message. " + Utils.maketext('headfoot.html', raw=1)),
('msg_footer', mm_cfg.Text, (4, WIDTH), 0,
'Footer added to mail sent to regular list members',
"Text appended to the bottom of every immediately-delivery"
" message. " + Utils.maketext('headfoot.html', raw=1)),
]
config_info['bounce'] = Bouncer.GetConfigInfo(self)
return config_info
def Create(self, name, admin, crypted_password):
if Utils.list_exists(name):
raise Errors.MMListAlreadyExistsError, name
Utils.ValidateEmail(admin)
Utils.MakeDirTree(os.path.join(mm_cfg.LIST_DATA_DIR, name))
self._full_path = os.path.join(mm_cfg.LIST_DATA_DIR, name)
self._internal_name = name
# Don't use Lock() since that tries to load the non-existant config.db
self.__lock.lock()
self.InitVars(name, admin, crypted_password)
self._ready = 1
self.InitTemplates()
self.Save()
# Touch these files so they have the right dir perms no matter what.
# A "just-in-case" thing. This shouldn't have to be here.
ou = os.umask(002)
try:
path = os.path.join(self._full_path, 'next-digest')
fp = open(path, "a+")
fp.close()
fp = open(path+'-topics', "a+")
fp.close()
finally:
os.umask(ou)
def __save(self, dict):
# Marshal this dictionary to file, and rotate the old version to a
# backup file. The dictionary must contain only builtin objects. We
# must guarantee that config.db is always valid so we never rotate
# unless the we've successfully written the temp file.
fname = os.path.join(self._full_path, 'config.db')
fname_tmp = fname + '.tmp.%s.%d' % (socket.gethostname(), os.getpid())
fname_last = fname + '.last'
fp = None
try:
fp = open(fname_tmp, 'w')
# marshal doesn't check for write() errors so this is safer.
fp.write(marshal.dumps(dict))
fp.close()
except IOError, e:
syslog('error',
'Failed config.db write, retaining old state.\n%s' % e)
if fp is not None:
os.unlink(fname_tmp)
raise
# Now do config.db.tmp.xxx -> config.db -> config.db.last rotation
# as safely as possible.
try:
# might not exist yet
os.unlink(fname_last)
except OSError, e:
if e.errno <> errno.ENOENT: raise
try:
# might not exist yet
os.link(fname, fname_last)
except OSError, e:
if e.errno <> errno.ENOENT: raise
os.rename(fname_tmp, fname)
def Save(self):
# Refresh the lock, just to let other processes know we're still
# interested in it. This will raise a NotLockedError if we don't have
# the lock (which is a serious problem!). TBD: do we need to be more
# defensive?
self.__lock.refresh()
# If more than one client is manipulating the database at once, we're
# pretty hosed. That's a good reason to make this a daemon not a
# program.
self.IsListInitialized()
# copy all public attributes to marshalable dictionary
dict = {}
for key, value in self.__dict__.items():
if key[0] <> '_':
dict[key] = value
# Make config.db unreadable by `other', as it contains all the
# list members' passwords (in clear text).
omask = os.umask(007)
try:
self.__save(dict)
finally:
os.umask(omask)
self.SaveRequestsDb()
self.CheckHTMLArchiveDir()
def __load(self, dbfile):
# Attempt to load and unmarshal the specified database file, which
# could be config.db or config.db.last. On success return a 2-tuple
# of (dictionary, None). On error, return a 2-tuple of the form
# (None, errorobj).
try:
fp = open(dbfile)
except IOError, e:
if e.errno <> errno.ENOENT: raise
return None, e
try:
try:
dict = marshal.load(fp)
if type(dict) <> DictType:
return None, 'Unmarshal expected to return a dictionary'
except (EOFError, ValueError, TypeError, MemoryError), e:
return None, e
finally:
fp.close()
return dict, None
def Load(self, check_version=1):
if not Utils.list_exists(self.internal_name()):
raise Errors.MMUnknownListError
# We first try to load config.db, which contains the up-to-date
# version of the database. If that fails, perhaps because it is
# corrupted or missing, then we load config.db.last as a fallback.
dbfile = os.path.join(self._full_path, 'config.db')
lastfile = dbfile + '.last'
dict, e = self.__load(dbfile)
if dict is None:
# Had problems with config.db. Either it's missing or it's
# corrupted. Try config.db.last as a fallback.
syslog('error', '%s db file was corrupt, using fallback: %s'
% (self.internal_name(), lastfile))
dict, e = self.__load(lastfile)
if dict is None:
# config.db.last is busted too. Nothing much we can do now.
syslog('error', '%s fallback was corrupt, giving up'
% self.internal_name())
raise Errors.MMCorruptListDatabaseError, e
# We had to read config.db.last, so copy it back to config.db.
# This allows the logic in Save() to remain unchanged. Ignore
# any OSError resulting from possibly illegal (but unnecessary)
# chmod.
try:
shutil.copy(lastfile, dbfile)
except OSError, e:
if e.errno <> errno.EPERM:
raise
# Copy the unmarshaled dictionary into the attributes of the mailing
# list object.
self.__dict__.update(dict)
self._ready = 1
if check_version:
self.CheckValues()
self.CheckVersion(dict)
def CheckVersion(self, stored_state):
"""Migrate prior version's state to new structure, if changed."""
if (self.data_version >= mm_cfg.DATA_FILE_VERSION and
type(self.data_version) == type(mm_cfg.DATA_FILE_VERSION)):
return
else:
self.InitVars() # Init any new variables,
self.Load(check_version = 0) # then reload the file
if self.Locked():
from versions import Update
Update(self, stored_state)
self.data_version = mm_cfg.DATA_FILE_VERSION
if self.Locked():
self.Save()
def CheckValues(self):
"""Normalize selected values to known formats."""
if '' in urlparse(self.web_page_url)[:2]:
# Either the "scheme" or the "network location" part of the parsed
# URL is empty; substitute faulty value with (hopefully sane)
# default.
self.web_page_url = mm_cfg.DEFAULT_URL
if self.web_page_url and self.web_page_url[-1] <> '/':
self.web_page_url = self.web_page_url + '/'
def IsListInitialized(self):
if not self._ready:
raise Errors.MMListNotReadyError
#xxx
def AddMember(self, name, password, digest=0, remote=None):
self.IsListInitialized()
# normalize the name, it could be of the form
#
# <person@place.com> User Name
# person@place.com (User Name)
# etc
#
email = Address.address()
email.addr = Utils.ParseAddrs(name)
email.name = Utils.ParseNames(name)
# Remove spaces... it's a common thing for people to add...
email.addr = string.join(string.split(email.addr), '')
# lower case only the domain part
email.addr = Utils.LCDomain(email.addr)
# Validate the e-mail address to some degree.
Utils.ValidateEmail(email.addr)
if self.IsMember(email.addr):
raise Errors.MMAlreadyAMember
if email.addr == string.lower(self.GetListEmail()):
# Trying to subscribe the list to itself!
raise Errors.MMBadEmailError
if digest and not self.digestable:
raise Errors.MMCantDigestError
elif not digest and not self.nondigestable:
raise Errors.MMMustDigestError
if self.subscribe_policy == 0:
# no confirmation or approval necessary:
self.ApprovedAddMember(email.addr, password, digest)
elif self.subscribe_policy == 1 or self.subscribe_policy == 3:
# confirmation:
from Pending import Pending
cookie = Pending().new(email.addr, password, digest)
if remote is not None:
by = " " + remote
remote = " from %s" % remote
else:
by = ""
remote = ""
recipient = self.GetMemberAdminEmail(email.addr)
text = Utils.maketext('verify.txt',
{"email" : email.addr,
"listaddr" : self.GetListEmail(),
"listname" : self.real_name,
"cookie" : cookie,
"hostname" : remote,
"requestaddr": self.GetRequestEmail(),
"remote" : remote,
"listadmin" : self.GetAdminEmail(),
})
msg = Message.UserNotification(
recipient, self.GetRequestEmail(),
'%s -- confirmation of subscription -- request %d' %
(self.real_name, cookie),
text)
msg['Reply-To'] = self.GetRequestEmail()
HandlerAPI.DeliverToUser(self, msg)
if recipient != email.addr:
who = "%s (%s)" % (email.addr, string.split(recipient, '@')[0])
else: who = email.addr
syslog('subscribe', '%s: pending %s %s' %
(self.internal_name(), who, by))
raise Errors.MMSubscribeNeedsConfirmation
else:
# subscription approval is required. add this entry to the admin
# requests database.
self.HoldSubscription(email.addr, password, digest)
raise Errors.MMNeedApproval, \
'subscriptions to %s require administrator approval' % \
self.real_name
def ProcessConfirmation(self, cookie):
from Pending import Pending
got = Pending().confirmed(cookie)
if not got:
raise Errors.MMBadConfirmation
else:
(email_addr, password, digest) = got
try:
if self.subscribe_policy == 3: # confirm + approve
self.HoldSubscription(email_addr, password, digest)
raise Errors.MMNeedApproval, \
'subscriptions to %s require administrator approval' % \
self.real_name
self.ApprovedAddMember(email_addr, password, digest)
finally:
self.Save()
def ApprovedAddMember(self, name, password, digest,
ack=None, admin_notif=None):
res = self.ApprovedAddMembers([name], [password],
digest, ack, admin_notif)
# There should be exactly one (key, value) pair in the returned dict,
# extract the possible exception value
res = res.values()[0]
if res is None:
# User was added successfully
return
else:
# Split up the exception list and reraise it here
e, v = res
raise e, v
def ApprovedAddMembers(self, names, passwords, digest,
ack=None, admin_notif=None):
"""Subscribe members in list `names'.
Passwords can be supplied in the passwords list. If an empty
password is encountered, a random one is generated and used.
Returns a dict where the keys are addresses that were tried
subscribed, and the corresponding values are either two-element
tuple containing the first exception type and value that was
raised when trying to add that address, or `None' to indicate
that no exception was raised.
"""
if ack is None:
if self.send_welcome_msg:
ack = 1
else:
ack = 0
if admin_notif is None:
if self.admin_notify_mchanges:
admin_notif = 1
else:
admin_notif = 0
if type(passwords) is not ListType:
# Type error -- ignore whatever value(s) we were given
passwords = [None] * len(names)
lenpws = len(passwords)
lennames = len(names)
if lenpws < lennames:
passwords.extend([None] * (lennames - lenpws))
result = {}
dirty = 0
#xxx
email = Address.address()
for i in range(lennames):
try:
# normalize the name, it could be of the form
#
# <person@place.com> User Name
# person@place.com (User Name)
# etc
#
email = Address.address()
email.addr = Utils.ParseAddrs(names[i])
email.name = Utils.ParseNames(names[i])
Utils.ValidateEmail(email.addr)
email.addr = Utils.LCDomain(email.addr)
except (Errors.MMBadEmailError, Errors.MMHostileAddress):
# We don't really need the traceback object for the exception,
# and as using it in the wrong way prevents garbage collection
# from working smoothly, we strip it away
result[email.addr] = sys.exc_info()[:2]
# WIBNI we could `continue' within `try' constructs...
if result.has_key(email.addr):
continue
if self.IsMember(email.addr):
result[email.addr] = [Errors.MMAlreadyAMember, email.addr]
continue
self.__AddMember(email, digest)
self.SetUserOption(email.addr, mm_cfg.DisableMime,
1 - self.mime_is_default_digest,
save_list=0)
# Make sure we set a "good" password
password = passwords[i]
if not password:
password = Utils.MakeRandomPassword()
self.passwords[string.lower(email.addr)] = password
# An address has been added successfully, make sure the
# list config is saved later on
dirty = 1
result[email.addr] = None
if dirty:
self.Save()
if digest:
kind = " (D)"
else:
kind = ""
for email.addr in result.keys():
if result[email.addr] is None:
syslog('subscribe', '%s: new%s %s' %
(self.internal_name(), kind, email.addr))
if ack:
self.SendSubscribeAck(
email.addr,
self.passwords[string.lower(email.addr)],
digest)
if admin_notif:
adminaddr = self.GetAdminEmail()
subject = ('%s subscription notification' %
self.real_name)
text = Utils.maketext(
"adminsubscribeack.txt",
{"listname" : self.real_name,
"member" : email.addr,
})
msg = Message.UserNotification(
self.owner, mm_cfg.MAILMAN_OWNER, subject, text)
HandlerAPI.DeliverToUser(self, msg)
return result
def DeleteMember(self, name, whence=None, admin_notif=None, userack=1):
self.IsListInitialized()
# FindMatchingAddresses *should* never return more than 1 address.
# However, should log this, just to make sure.
aliases = Utils.FindMatchingAddresses(name, self.members,
self.digest_members)
if not len(aliases):
raise Errors.MMNoSuchUserError
def DoActualRemoval(alias, me=self):
kind = "(unfound)"
try:
del me.passwords[alias]
except KeyError:
pass
if me.user_options.has_key(alias):
del me.user_options[alias]
try:
del me.members[alias]
kind = "regular"
except KeyError:
pass
try:
del me.digest_members[alias]
kind = "digest"
except KeyError:
pass
map(DoActualRemoval, aliases)
if userack and self.goodbye_msg and len(self.goodbye_msg):
self.SendUnsubscribeAck(name)
self.ClearBounceInfo(name)
self.Save()
if admin_notif is None:
if self.admin_notify_mchanges:
admin_notif = 1
else:
admin_notif = 0
if admin_notif:
subject = '%s unsubscribe notification' % self.real_name
text = Utils.maketext(
'adminunsubscribeack.txt',
{'member' : name,
'listname': self.real_name,
})
msg = Message.UserNotification(self.owner,
mm_cfg.MAILMAN_OWNER,
subject, text)
HandlerAPI.DeliverToUser(self, msg)
if whence:
whence = "; %s" % whence
else:
whence = ""
syslog('subscribe', '%s: deleted %s%s' %
(self.internal_name(), name, whence))
def IsMember(self, address):
return len(Utils.FindMatchingAddresses(address, self.members,
self.digest_members))
def HasExplicitDest(self, msg):
"""True if list name or any acceptable_alias is included among the
to or cc addrs."""
# this is the list's full address
listfullname = '%s@%s' % (self.internal_name(), self.host_name)
recips = []
# check all recipient addresses against the list's explicit addresses,
# specifically To: Cc: and Resent-to:
to = []
for header in ('to', 'cc', 'resent-to', 'resent-cc'):
to.extend(msg.getaddrlist(header))
for fullname, addr in to:
# It's possible that if the header doesn't have a valid
# (i.e. RFC822) value, we'll get None for the address. So skip
# it.
if addr is None:
continue
addr = string.lower(addr)
localpart = string.split(addr, '@')[0]
if (# TBD: backwards compatibility: deprecated
localpart == self.internal_name() or
# Exact match against the complete list address. TBD:
# this test should be case-insensitive.
addr == listfullname):
return 1
recips.append((addr, localpart))
#
# helper function used to match a pattern against an address. Do it
def domatch(pattern, addr):
try:
if re.match(pattern, addr):
return 1
except re.error:
# The pattern is a malformed regexp -- try matching safely,
# with all non-alphanumerics backslashed:
if re.match(re.escape(pattern), addr):
return 1
#
# Here's the current algorithm for matching acceptable_aliases:
#
# 1. If the pattern does not have an `@' in it, we first try matching
# it against just the localpart. This was the behavior prior to
# 2.0beta3, and is kept for backwards compatibility.
# (deprecated).
#
# 2. If that match fails, or the pattern does have an `@' in it, we
# try matching against the entire recip address.
for addr, localpart in recips:
for alias in string.split(self.acceptable_aliases, '\n'):
stripped = string.strip(alias)
if not stripped:
# ignore blank or empty lines
continue
if '@' not in stripped and domatch(stripped, localpart):
return 1
if domatch(stripped, addr):
return 1
return 0
def parse_matching_header_opt(self):
"""Return a list of triples [(field name, regex, line), ...]."""
# - Blank lines and lines with '#' as first char are skipped.
# - Leading whitespace in the matchexp is trimmed - you can defeat
# that by, eg, containing it in gratuitous square brackets.
all = []
for line in string.split(self.bounce_matching_headers, '\n'):
stripped = string.strip(line)
if not stripped or (stripped[0] == "#"):
# Skip blank lines and lines *starting* with a '#'.
continue
else:
try:
h, e = re.split(":[ \t]*", stripped, 1)
try:
re.compile(e)
all.append((h, e, stripped))
except re.error, cause:
# The regexp in this line is malformed -- log it
# and ignore it
syslog('config',
'%s - bad regexp %s [%s] '
'in bounce_matching_header line %s'
% (self.real_name, `e`, `cause`, `stripped`))
except ValueError:
# Whoops - some bad data got by:
syslog('config', '%s - bad bounce_matching_header line %s'
% (self.real_name, `stripped`))
return all
def HasMatchingHeader(self, msg):
"""True if named header field (case-insensitive) matches regexp.
Case insensitive.
Returns constraint line which matches or empty string for no
matches."""
pairs = self.parse_matching_header_opt()
for field, matchexp, line in pairs:
fragments = msg.getallmatchingheaders(field)
subjs = []
l = len(field)
for f in fragments:
# Consolidate header lines, stripping header name & whitespace.
if (len(f) > l
and f[l] == ":"
and string.lower(field) == string.lower(f[0:l])):
# Non-continuation line - trim header name:
subjs.append(f[l+2:])
elif not subjs:
# Whoops - non-continuation that matches?
subjs.append(f)
else:
# Continuation line.
subjs[-1] = subjs[-1] + f
for s in subjs:
# This is safe because parse_matching_header_opt only
# returns valid regexps
if re.search(matchexp, s, re.I):
return line
return 0
def Locked(self):
return self.__lock.locked()
def Lock(self, timeout=0):
self.__lock.lock(timeout)
# Must reload our database for consistency. Watch out for lists that
# don't exist.
try:
self.Load()
except Errors.MMUnknownListError:
self.Unlock()
raise
def Unlock(self):
self.__lock.unlock(unconditionally=1)
def __repr__(self):
if self.Locked():
status = " (locked)"
else:
status = ""
return ("<%s.%s %s%s at %s>" %
(self.__module__, self.__class__.__name__,
`self._internal_name`, status, hex(id(self))[2:]))
def internal_name(self):
return self._internal_name
def fullpath(self):
return self._full_path
--------------268321D1775935CAA82A6949
Content-Type: text/plain; charset=us-ascii;
name="Utils.py"
Content-Transfer-Encoding: 7bit
Content-Disposition: inline;
filename="Utils.py"
# 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.
"""Miscellaneous essential routines.
This includes actual message transmission routines, address checking and
message and address munging, a handy-dandy routine to map a function on all
the mailing lists, and whatever else doesn't belong elsewhere.
"""
import sys
import os
import string
import re
from UserDict import UserDict
from types import StringType
# XXX: obsolete, should use re module
import regsub
import random
import urlparse
from Mailman import mm_cfg
from Mailman import Errors
#xxx
from Mailman import Address
##try:
## import md5
##except ImportError:
## md5 = None
from Mailman import Crypt
def list_exists(listname):
"""Return true iff list `listname' exists."""
# It is possible that config.db got removed erroneously, in which case we
# can fall back to config.db.last
dbfile = os.path.join(mm_cfg.LIST_DATA_DIR, listname, 'config.db')
lastfile = dbfile + '.last'
return os.path.exists(dbfile) or os.path.exists(lastfile)
def list_names():
"""Return the names of all lists in default list directory."""
got = []
for fn in os.listdir(mm_cfg.LIST_DATA_DIR):
if list_exists(fn):
got.append(fn)
return got
# a much more naive implementation than say, Emacs's fill-paragraph!
def wrap(text, column=70):
"""Wrap and fill the text to the specified column.
Wrapping is always in effect, although if it is not possible to wrap a
line (because some word is longer than `column' characters) the line is
broken at the next available whitespace boundary. Paragraphs are also
always filled, unless the line begins with whitespace. This is the
algorithm that the Python FAQ wizard uses, and seems like a good
compromise.
"""
wrapped = ''
# first split the text into paragraphs, defined as a blank line
paras = re.split('\n\n', text)
for para in paras:
# fill
lines = []
fillprev = 0
for line in string.split(para, '\n'):
if not line:
lines.append(line)
continue
if line[0] in string.whitespace:
fillthis = 0
else:
fillthis = 1
if fillprev and fillthis:
# if the previous line should be filled, then just append a
# single space, and the rest of the current line
lines[-1] = string.rstrip(lines[-1]) + ' ' + line
else:
# no fill, i.e. retain newline
lines.append(line)
fillprev = fillthis
# wrap each line
for text in lines:
while text:
if len(text) <= column:
line = text
text = ''
else:
bol = column
# find the last whitespace character
while bol > 0 and text[bol] not in string.whitespace:
bol = bol - 1
# now find the last non-whitespace character
eol = bol
while eol > 0 and text[eol] in string.whitespace:
eol = eol - 1
# watch out for text that's longer than the column width
if eol == 0:
# break on whitespace after column
eol = column
while eol < len(text) and \
text[eol] not in string.whitespace:
eol = eol + 1
bol = eol
while bol < len(text) and \
text[bol] in string.whitespace:
bol = bol + 1
bol = bol - 1
line = text[:eol+1] + '\n'
# find the next non-whitespace character
bol = bol + 1
while bol < len(text) and text[bol] in string.whitespace:
bol = bol + 1
text = text[bol:]
wrapped = wrapped + line
wrapped = wrapped + '\n'
# end while text
wrapped = wrapped + '\n'
# end for text in lines
# the last two newlines are bogus
return wrapped[:-2]
def QuotePeriods(text):
return string.join(string.split(text, '\n.\n'), '\n .\n')
# TBD: what other characters should be disallowed?
_badchars = re.compile('[][()<>|;^,]')
def ValidateEmail(str):
"""Verify that the an email address isn't grossly invalid."""
# Pretty minimal, cheesy check. We could do better...
if not str:
raise Errors.MMBadEmailError
if _badchars.search(str) or str[0] == '-':
raise Errors.MMHostileAddress
if string.find(str, '/') <> -1 and \
os.path.isdir(os.path.split(str)[0]):
# then
raise Errors.MMHostileAddress
user, domain_parts = ParseEmail(str)
# this means local, unqualified addresses, are no allowed
if not domain_parts:
raise Errors.MMBadEmailError
if len(domain_parts) < 2:
raise Errors.MMBadEmailError
# User J. Person <person@allusers.com>
_addrcre1 = re.compile('<(.*)>')
# person@allusers.com (User J. Person)
_addrcre2 = re.compile('([^(]*)\s(.*)')
#xxx
# We want to get the names now, not just the addresses
# User J. Person <person@addlusers.com>
_namecre1 = re.compile('([^<]*)')
# person@allusers.com (User J. Person)
_namecre2 = re.compile('\((.*)\)')
def ParseAddrs(addresses):
"""Parse common types of email addresses:
User J. Person <person@allusers.com>
person@allusers.com (User J. Person)
TBD: I wish we could use rfc822.parseaddr() but 1) the interface is not
convenient, and 2) it doesn't work for the second type of address.
Argument is a list of addresses, return value is a list of the parsed
email addresses. The argument can also be a single string, in which case
the return value is a single string. All addresses are string.strip()'d.
"""
single = 0
if type(addresses) == type(''):
single = 1
addrs = [addresses]
else:
addrs = addresses
parsed = []
for a in addrs:
mo = _addrcre1.search(a)
if mo:
parsed.append(mo.group(1))
continue
mo = _addrcre2.search(a)
if mo:
parsed.append(mo.group(1))
continue
parsed.append(a)
if single:
return string.strip(parsed[0])
return map(string.strip, parsed)
# Added by BB, 9/24/00
# Gets the name of the user from the email address
def ParseNames(addresses):
single = 0
if type(addresses) == type(''):
single = 1
addrs = [addresses]
else:
addrs = addresses
parsed = []
for a in addrs:
print "Utils: %s" % (a) #XYZ
mo = _namecre1.search(a)
if mo:
parsed.append(mo.group(1))
print "Utils: %s" % (mo.group(1)) #XYZ
continue
mo = _namecre2.search(a)
if mo:
parsed.append(mo.group(1))
print "Utils: %s" % (mo.group(1)) #XYZ
continue
parsed.append(a)
if single:
return parsed[0]
return parsed
def GetPathPieces(envar='PATH_INFO'):
path = os.environ.get(envar)
if path:
return filter(None, string.split(path, '/'))
return None
def ScriptURL(target, web_page_url=None, absolute=0):
"""target - scriptname only, nothing extra
web_page_url - the list's configvar of the same name
absolute - a flag which if set, generates an absolute url
"""
if web_page_url is None:
web_page_url = mm_cfg.DEFAULT_URL
if web_page_url[-1] <> '/':
web_page_url = web_page_url + '/'
fullpath = os.environ.get('REQUEST_URI')
if fullpath is None:
fullpath = os.environ.get('SCRIPT_NAME', '') + \
os.environ.get('PATH_INFO', '')
baseurl = urlparse.urlparse(web_page_url)[2]
if not absolute and fullpath[:len(baseurl)] == baseurl:
# Use relative addressing
fullpath = fullpath[len(baseurl):]
i = string.find(fullpath, '?')
if i > 0:
count = string.count(fullpath, '/', 0, i)
else:
count = string.count(fullpath, '/')
path = ('../' * count) + target
else:
path = web_page_url + target
return path + mm_cfg.CGIEXT
def MakeDirTree(path, perms=0775, verbose=0):
made_part = '/'
path_parts = filter(None, string.split(path, '/'))
for item in path_parts:
made_part = os.path.join(made_part, item)
if os.path.exists(made_part):
if not os.path.isdir(made_part):
raise "RuntimeError", ("Couldn't make dir tree for %s. (%s"
" already exists)" % (path, made_part))
else:
ou = os.umask(0)
try:
os.mkdir(made_part, perms)
finally:
os.umask(ou)
if verbose:
print 'made directory: ', madepart
# This takes an email address, and returns a tuple containing (user,host)
def ParseEmail(email):
user = None
domain = None
email = string.lower(email)
at_sign = string.find(email, '@')
if at_sign < 1:
return (email, None)
user = email[:at_sign]
rest = email[at_sign+1:]
domain = string.split(rest, '.')
return (user, domain)
def LCDomain(addr):
"returns the address with the domain part lowercased"
atind = string.find(addr, '@')
if atind == -1: # no domain part
return addr
return addr[:atind] + '@' + string.lower(addr[atind + 1:])
# Return 1 if the 2 addresses match. 0 otherwise.
# Might also want to match if there's any common domain name...
# There's password protection anyway.
def AddressesMatch(addr1, addr2):
"True when username matches and host addr of one addr contains other's."
addr1, addr2 = map(LCDomain, [addr1, addr2])
if not mm_cfg.SMART_ADDRESS_MATCH:
return addr1 == addr2
user1, domain1 = ParseEmail(addr1)
user2, domain2 = ParseEmail(addr2)
if user1 != user2:
return 0
if domain1 == domain2:
return 1
elif not domain1 or not domain2:
return 0
for i in range(-1 * min(len(domain1), len(domain2)), 0):
# By going from most specific component of host part we're likely
# to hit a difference sooner.
if domain1[i] != domain2[i]:
return 0
return 1
def GetPossibleMatchingAddrs(name):
"""returns a sorted list of addresses that could possibly match
a given name.
For Example, given scott@pobox.com, return ['scott@pobox.com'],
given scott@blackbox.pobox.com return ['scott@blackbox.pobox.com',
'scott@pobox.com']"""
name = string.lower(name)
user, domain = ParseEmail(name)
res = [name]
if domain:
domain = domain[1:]
while len(domain) >= 2:
res.append("%s@%s" % (user, string.join(domain, ".")))
domain = domain[1:]
return res
def List2Dict(list):
"""List2Dict returns a dict keyed by the entries in the list
passed to it."""
res = {}
for item in list:
res[item] = 1
return res
def FindMatchingAddresses(name, dict, *dicts):
"""Given an email address, and any number of dictionaries keyed by
email addresses, returns the subset of the list that matches the
given address. Should sort based on exactness of match,
just in case."""
dicts = list(dicts)
dicts.insert(0, dict)
if not mm_cfg.SMART_ADDRESS_MATCH:
for d in dicts:
if d.has_key(string.lower(name)):
return [name]
return []
#
# GetPossibleMatchingAddrs return string.lower'd values
#
p_matches = GetPossibleMatchingAddrs(name)
res = []
for pm in p_matches:
for d in dicts:
if d.has_key(pm):
res.append(pm)
return res
_vowels = ('a', 'e', 'i', 'o', 'u')
_consonants = ('b', 'c', 'd', 'f', 'g', 'h', 'k', 'm', 'n',
'p', 'r', 's', 't', 'v', 'w', 'x', 'z')
_syllables = []
for v in _vowels:
for c in _consonants:
_syllables.append(c+v)
_syllables.append(v+c)
def MakeRandomPassword(length=6):
syls = []
while len(syls)*2 < length:
syls.append(random.choice(_syllables))
return string.join(syls, '')[:length]
def GetRandomSeed():
chr1 = int(random.random() * 52)
chr2 = int(random.random() * 52)
def mkletter(c):
if 0 <= c < 26:
c = c + 65
if 26 <= c < 52:
c = c - 26 + 97
return c
return "%c%c" % tuple(map(mkletter, (chr1, chr2)))
def SetSiteAdminPassword(pw):
fp = open_ex(mm_cfg.SITE_PW_FILE, 'w', perms=0640)
fp.write(Crypt.crypt(pw, GetRandomSeed()))
fp.close()
def CheckSiteAdminPassword(pw1):
try:
f = open(mm_cfg.SITE_PW_FILE)
pw2 = f.read()
f.close()
return Crypt.crypt(pw1, pw2[:2]) == pw2
# There probably is no site admin password if there was an exception
except IOError:
return 0
def QuoteHyperChars(str):
arr = regsub.splitx(str, '[<>"&]')
i = 1
while i < len(arr):
if arr[i] == '<':
arr[i] = '<'
elif arr[i] == '>':
arr[i] = '>'
elif arr[i] == '"':
arr[i] = '"'
else: #if arr[i] == '&':
arr[i] = '&'
i = i + 2
return string.join(arr, '')
# Just changing these two functions should be enough to control the way
# that email address obscuring is handled.
def ObscureEmail(addr, for_text=0):
"""Make email address unrecognizable to web spiders, but invertable.
When for_text option is set (not default), make a sentence fragment
instead of a token."""
if for_text:
return string.replace(addr, "@", " at ")
else:
return string.replace(addr, "@", "--at--")
def UnobscureEmail(addr):
"""Invert ObscureEmail() conversion."""
# Contrived to act as an identity operation on already-unobscured
# emails, so routines expecting obscured ones will accept both.
return string.replace(addr, "--at--", "@")
def chunkify(members, chunksize=None):
"""
return a list of lists of members
"""
if chunksize is None:
chunksize = mm_cfg.DEFAULT_ADMIN_MEMBER_CHUNKSIZE
members.sort()
res = []
while 1:
if not members:
break
chunk = members[:chunksize]
res.append(chunk)
members = members[chunksize:]
return res
class SafeDict(UserDict):
"""Dictionary which returns a default value for unknown keys.
This is used in maketext so that editing templates is a bit more robust.
"""
def __init__(self, d=None):
# optional initial dictionary is a Python 1.5.2-ism. Do it this way
# for portability
UserDict.__init__(self)
if d is not None:
self.update(d)
def __getitem__(self, key):
try:
return self.data[key]
except KeyError:
if type(key) == StringType:
return '%('+key+')s'
else:
return '<Missing key: %s>' % `key`
def maketext(templatefile, dict=None, raw=0):
"""Make some text from a template file.
Reads the `templatefile', relative to mm_cfg.TEMPLATE_DIR, does string
substitution by interpolating in the `dict', and if `raw' is false,
wraps/fills the resulting text by calling wrap().
"""
if dict is None:
dict = {}
file = os.path.join(mm_cfg.TEMPLATE_DIR, templatefile)
fp = open(file)
template = fp.read()
fp.close()
text = template % SafeDict(dict)
if raw:
return text
return wrap(text)
# given a Message.Message object, test for administrivia (eg subscribe,
# unsubscribe, etc). the test must be a good guess -- messages that return
# true get sent to the list admin instead of the entire list.
#
def IsAdministrivia(msg):
lines = map(string.lower, string.split(msg.body, "\n"))
# check to see how many lines that actually have text in them there are
admin_data = {"subscribe": (0, 3),
"unsubscribe": (0, 1),
"who": (0,0),
"info": (0,0),
"lists": (0,0),
"set": (3, 3),
"help": (0,0),
"password": (2, 2),
"options": (0,0),
"remove": (0, 0)}
lines_with_text = 0
for line in lines:
if string.strip(line):
lines_with_text = lines_with_text + 1
if lines_with_text > mm_cfg.DEFAULT_MAIL_COMMANDS_MAX_LINES:
return 0
sig_ind = string.find(msg.body, "\n-- ")
if sig_ind != -1:
body = msg.body[:sig_ind]
else:
body = msg.body
if admin_data.has_key(string.lower(string.strip(body))):
return 1
try:
if admin_data.has_key(string.lower(string.strip(msg["subject"]))):
return 1
except KeyError:
pass
for line in lines[:5]:
if not string.strip(line):
continue
words = string.split(line)
if admin_data.has_key(words[0]):
min_args, max_args = admin_data[words[0]]
if min_args <= len(words[1:]) <= max_args:
if (words[0] == 'set'
and (words[2] not in ['on', 'off'])):
continue
return 1
return 0
def mkdir(dir, mode=02775):
"""Wraps os.mkdir() in a umask saving try/finally.
Two differences from os.mkdir():
- umask is forced to 0 during mkdir()
- default mode is 02775
"""
ou = os.umask(0)
try:
os.mkdir(dir, mode)
finally:
os.umask(ou)
def open_ex(filename, mode='r', bufsize=-1, perms=0664):
"""Use os.open() to open a file in a particular mode.
Returns a file-like object instead of a file descriptor.
Also umask is forced to 0 during the open().
`b' flag is currently unsupported."""
modekey = mode
trunc = os.O_TRUNC
if mode == 'r':
trunc = 0
elif mode[-1] == '+':
trunc = 0
modekey = mode[:-1]
else:
trunc = os.O_TRUNC
flags = {'r' : os.O_RDONLY,
'w' : os.O_WRONLY | os.O_CREAT,
'a' : os.O_RDWR | os.O_CREAT | os.O_APPEND,
'rw': os.O_RDWR | os.O_CREAT,
# TBD: should also support `b'
}.get(modekey)
if flags is None:
raise TypeError, 'Unsupported file mode: ' + mode
flags = flags | trunc
ou = os.umask(0)
try:
try:
fd = os.open(filename, flags, perms)
fp = os.fdopen(fd, mode, bufsize)
return fp
# transform any os.errors into IOErrors
except OSError, e:
e.__class__ = IOError
raise IOError, e, sys.exc_info()[2]
finally:
os.umask(ou)
def GetRequestURI(fallback=None):
"""Return the full virtual path this CGI script was invoked with.
Newer web servers seems to supply this info in the REQUEST_URI
environment variable -- which isn't part of the CGI/1.1 spec.
Thus, if REQUEST_URI isn't available, we concatenate SCRIPT_NAME
and PATH_INFO, both of which are part of CGI/1.1.
Optional argument `fallback' (default `None') is returned if both of
the above methods fail.
"""
if os.environ.has_key('REQUEST_URI'):
return os.environ['REQUEST_URI']
elif os.environ.has_key('SCRIPT_NAME') and os.environ.has_key('PATH_INFO'):
return os.environ['SCRIPT_NAME'] + os.environ['PATH_INFO']
else:
return fallback
# Wait on a dictionary of child pids
def reap(kids, func=None):
while kids:
if func:
func()
pid, status = os.waitpid(-1, os.WNOHANG)
if pid <> 0:
try:
del kids[pid]
except KeyError:
# Huh? How can this happen?
pass
# Useful conversion routines
# unhexlify(hexlify(s)) == s
#
# Python 2.0 has these in the binascii module
try:
from binascii import hexlify, unhexlify
except ImportError:
# Not the most efficient of implementations, but good enough for older
# versions of Python.
def hexlify(s):
acc = []
def munge(byte, append=acc.append, a=ord('a'), z=ord('0')):
if byte > 9: append(byte+a-10)
else: append(byte+z)
for c in s:
hi, lo = divmod(ord(c), 16)
munge(hi)
munge(lo)
return string.join(map(chr, acc), '')
def unhexlify(s):
acc = []
append = acc.append
# In Python 2.0, we can use the int() built-in
int16 = string.atoi
for i in range(0, len(s), 2):
append(chr(int16(s[i:i+2], 16)))
return string.join(acc, '')
def write(*args, **kws):
file = sys.stdout
sep = ' '
end = '\n'
if kws.has_key('file'):
file = kws['file']
del kws['file']
if kws.has_key('nl'):
if not kws['nl']:
end = ' '
del kws['nl']
if kws.has_key('sep'):
sep = kws['sep']
del kws['sep']
if kws:
raise TypeError('unexpected keywords')
file.write(string.join(map(str, args), sep) + end)
--------------268321D1775935CAA82A6949
Content-Type: text/plain; charset=us-ascii;
name="add_members"
Content-Transfer-Encoding: 7bit
Content-Disposition: inline;
filename="add_members"
#! /usr/bin/env python
#
# 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.
#
# argv[1] should be the name of the list.
# argv[2] should be the list of non-digested users.
# argv[3] should be the list of digested users.
# Make sure that the list of email addresses doesn't contain any comments,
# like majordomo may throw in. For now, you just have to remove them manually.
"""Add members to a list from the command line.
Usage:
add_members [-n <file>] [-d <file>] [-c <y|n>] [-w <y|n>] [-h] listname
Where:
--non-digest-members-file <file>
-n <file>
A file containing addresses of the members to be added, one
address per line. This list of people become non-digest
members. If <file> is `-', read addresses from stdin.
--digest-members-file <file>
-d <file>
Similar to above, but these people become digest members.
--changes-msg=<y|n>
-c <y|n>
set whether or not to send the list members the `there's going to be
big changes to your list' message. defaults to no.
--welcome-msg=<y|n>
-w <y|n>
set whether or not to send the list members a welcome message,
overriding whatever the list's `send_welcome_msg' setting is.
--help
-h
Print this help message and exit.
listname
The name of the Mailman list you are adding members to. It must
already exist.
You must supply at least one of -n and -d options. At most one of the
files can be `-'.
"""
import sys
import os
import string
import getopt
import paths
from Mailman import MailList
from Mailman import Utils
from Mailman import Message
from Mailman import Errors
from Mailman import mm_cfg
from Mailman.Handlers import HandlerAPI
def usage(status, msg=''):
if msg:
print msg
print __doc__ % globals()
sys.exit(status)
def ReadFile(filename):
lines = []
if filename == "-":
fp = sys.stdin
else:
fp = open(filename)
lines = filter(None, map(string.strip, fp.readlines()))
fp.close()
return lines
def SendExplanation(mlist, users):
adminaddr = mlist.GetAdminEmail()
d = {'listname' : mlist.real_name,
'listhost' : mlist.host_name,
'listaddr' : mlist.GetListEmail(),
'listinfo_url': mlist.GetScriptURL('listinfo', absolute=1),
'requestaddr' : mlist.GetRequestEmail(),
'adminaddr' : adminaddr,
'version' : mm_cfg.VERSION,
}
text = Utils.maketext('convert.txt', d)
subject = 'Big change in %(listname)s@%(listhost)s mailing list' % d
msg = Message.OutgoingMessage(text)
msg['From'] = adminaddr
msg['Subject'] = subject
HandlerAPI.DeliverToUser(mlist, msg, {'recips': users})
def main():
try:
opts, args = getopt.getopt(sys.argv[1:],
'n:d:c:w:h',
['non-digest-members-file=',
'digest-members-file=',
'changes-msg=',
'welcome-msg=',
'help'])
except getopt.error, msg:
usage(1, msg)
if not len(args) == 1:
usage(1)
listname = string.lower(args[0])
nfile = None
dfile = None
send_changes_msg = 0
send_welcome_msg = -1
for opt, arg in opts:
if opt in ('-h', '--help'):
usage(0)
elif opt in ('-d', '--digest-members-file'):
dfile = arg
elif opt in ('-n', '--non-digest-members-file'):
nfile = arg
elif opt in ('-c', '--changes-msg'):
if arg == 'y':
send_changes_msg = 1
elif arg == 'n':
send_changes_msg = 0
else:
usage(1)
elif opt in ('-w', '--welcome-msg'):
if arg == 'y':
send_welcome_msg = 1
elif arg == 'n':
send_welcome_msg = 0
else:
usage(1)
if dfile is None and nfile is None:
usage(1)
if dfile == "-" and nfile == "-":
print "Sorry, can't read both digest *and* normal members from stdin."
sys.exit(1)
try:
ml = MailList.MailList(listname)
except Errors.MMUnknownListError:
usage(1, 'You must first create the list by running: newlist %s' %
listname)
if send_welcome_msg == -1:
send_welcome_msg = ml.send_welcome_msg
try:
dmembers = []
if dfile:
try:
dmembers = ReadFile(dfile)
except IOError:
pass
nmembers = []
if nfile:
try:
nmembers = ReadFile(nfile)
except IOError:
pass
if not dmembers and not nmembers:
usage(1)
if nmembers:
nres = ml.ApprovedAddMembers(nmembers, None, 0, send_welcome_msg)
else: nres = {}
if dmembers:
dres = ml.ApprovedAddMembers(dmembers, None, 1, send_welcome_msg)
else: dres = {}
for result in (nres, dres):
for name in result.keys():
if result[name] is None:
pass
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:
print 'Already subscribed (skipping):', name
elif issubclass(e, Errors.EmailAddressError):
if name == '': name = '( blank line )'
print "Not a valid email address:", name
if send_changes_msg:
SendExplanation(ml, nmembers + dmembers)
finally:
ml.Unlock()
main()
--------------268321D1775935CAA82A6949--