Subject: or Keywords: header contains a
match against a topic filter, the message is logically placed
into a topic bucket. Each user can then choose to only
receive messages from the mailing list for a particular topic
bucket (or buckets). Any message not categorized in a topic
bucket registered with the user is not delivered to the list.
Note that this feature only works with regular delivery, not digest delivery.
The body of the message can also be optionally scanned for
Subject: and Keywords: headers, as
specified by the topics_bodylines_limit
configuration variable.""")),
('topics_bodylines_limit', mm_cfg.Number, 5, 0,
_('How many body lines should the topic matcher scan?'),
_("""The topic matcher will scan this many lines of the message
body looking for topic keyword matches. Body scanning stops when
either this many lines have been looked at, or a non-header-like
body line is encountered. By setting this value to zero, no body
lines will be scanned (i.e. only the Keywords: and
Subject: headers will be scanned). By setting this
value to a negative number, then all body lines will be scanned
until a non-header-like line is encountered.
""")),
('topics', mm_cfg.Topics, 0, 0,
_('Topic keywords, one per line, to match against each message.'),
_("""Each topic keyword is actually a regular expression, which is
matched against certain parts of a mail message, specifically the
Keywords: and Subject: message headers.
Note that the first few lines of the body of the message can also
contain a Keywords: and Subject:
"header" on which matching is also performed.""")),
]
def handleForm(self, mlist, category, subcat, cgidata, doc):
topics = []
# We start i at 1 and keep going until we no longer find items keyed
# with the marked tags.
i = 1
while 1:
deltag = 'topic_delete_%02d' % i
boxtag = 'topic_box_%02d' % i
reboxtag = 'topic_rebox_%02d' % i
desctag = 'topic_desc_%02d' % i
wheretag = 'topic_where_%02d' % i
addtag = 'topic_add_%02d' % i
newtag = 'topic_new_%02d' % i
i += 1
# Was this a delete? If so, we can just ignore this entry
if cgidata.has_key(deltag):
continue
# Get the data for the current box
name = cgidata.getvalue(boxtag)
pattern = cgidata.getvalue(reboxtag)
desc = cgidata.getvalue(desctag)
if name is None:
# We came to the end of the boxes
break
if cgidata.has_key(newtag) and (not name or not pattern):
# This new entry is incomplete.
doc.addError(_("""Topic specifications require both a name and
a pattern. Incomplete topics will be ignored."""))
continue
# Make sure the pattern was a legal regular expression
try:
re.compile(pattern)
except (re.error, TypeError):
doc.addError(_("""The topic pattern `%(pattern)s' is not a
legal regular expression. It will be discarded."""))
continue
# Was this an add item?
if cgidata.has_key(addtag):
# Where should the new one be added?
where = cgidata.getvalue(wheretag)
if where == 'before':
# Add a new empty topics box before the current one
topics.append(('', '', '', 1))
topics.append((name, pattern, desc, 0))
# Default is to add it after...
else:
topics.append((name, pattern, desc, 0))
topics.append(('', '', '', 1))
# Otherwise, just retain this one in the list
else:
topics.append((name, pattern, desc, 0))
# Add these topics to the mailing list object, and deal with other
# options.
mlist.topics = topics
try:
mlist.topics_enabled = int(cgidata.getvalue(
'topics_enabled',
mlist.topics_enabled))
except ValueError:
# BAW: should really print a warning
pass
try:
mlist.topics_bodylines_limit = int(cgidata.getvalue(
'topics_bodylines_limit',
mlist.topics_bodylines_limit))
except ValueError:
# BAW: should really print a warning
pass