1 files changed, 123 insertions, 0 deletions
diff --git a/mailman/app/replybot.py b/mailman/app/replybot.py
new file mode 100644
index 000000000..74a435589
--- /dev/null
+++ b/mailman/app/replybot.py
@@ -0,0 +1,123 @@
+# Copyright (C) 2007-2008 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
+# USA.
+
+"""Application level auto-reply code."""
+
+# XXX This should undergo a rewrite to move this functionality off of the
+# mailing list.  The reply governor should really apply site-wide per
+# recipient (I think).
+
+from __future__ import with_statement
+
+__all__ = [
+    'autorespond_to_sender',
+    'can_acknowledge',
+    ]
+
+import logging
+import datetime
+
+from mailman import Utils
+from mailman import i18n
+from mailman.configuration import config
+
+
+log = logging.getLogger('mailman.vette')
+_ = i18n._
+
+
+
+def autorespond_to_sender(mlist, sender, lang=None):
+    """Return True if Mailman should auto-respond to this sender.
+
+    This is only consulted for messages sent to the -request address, or
+    for posting hold notifications, and serves only as a safety value for
+    mail loops with email 'bots.
+    """
+    if lang is None:
+        lang = mlist.preferred_language
+    if config.MAX_AUTORESPONSES_PER_DAY == 0:
+        # Unlimited.
+        return True
+    today = datetime.date.today()
+    info = mlist.hold_and_cmd_autoresponses.get(sender)
+    if info is None or info[0] <> today:
+        # This is the first time we've seen a -request/post-hold for this
+        # sender today.
+        mlist.hold_and_cmd_autoresponses[sender] = (today, 1)
+        return True
+    date, count = info
+    if count < 0:
+        # They've already hit the limit for today, and we've already notified
+        # them of this fact, so there's nothing more to do.
+        log.info('-request/hold autoresponse discarded for: %s', sender)
+        return False
+    if count >= config.MAX_AUTORESPONSES_PER_DAY:
+        log.info('-request/hold autoresponse limit hit for: %s', sender)
+        mlist.hold_and_cmd_autoresponses[sender] = (today, -1)
+        # Send this notification message instead.
+        text = Utils.maketext(
+            'nomoretoday.txt',
+            {'sender' : sender,
+             'listname': mlist.fqdn_listname,
+             'num' : count,
+             'owneremail': mlist.owner_address,
+             },
+            lang=lang)
+        with i18n.using_language(lang):
+            msg = Message.UserNotification(
+                sender, mlist.owner_address,
+                _('Last autoresponse notification for today'),
+                text, lang=lang)
+        msg.send(mlist)
+        return False
+    mlist.hold_and_cmd_autoresponses[sender] = (today, count + 1)
+    return True
+
+
+
+def can_acknowledge(msg):
+    """A boolean specifying whether this message can be acknowledged.
+
+    There are several reasons why a message should not be acknowledged, mostly
+    related to competing standards or common practices.  These include:
+
+    * The message has a X-No-Ack header with any value
+    * The message has an X-Ack header with a 'no' value
+    * The message has a Precedence header
+    * The message has an Auto-Submitted header and that header does not have a
+      value of 'no'
+    * The message has an empty Return-Path header, e.g. <>
+    * The message has any RFC 2369 headers (i.e. List-* headers)
+
+    :param msg: a Message object.
+    :return: Boolean specifying whether the message can be acknowledged or not
+        (which is different from whether it will be acknowledged).
+    """
+    # I wrote it this way for clarity and consistency with the docstring.
+    for header in msg.keys():
+        if header in ('x-no-ack', 'precedence'):
+            return False
+        if header.lower().startswith('list-'):
+            return False
+    if msg.get('x-ack', '').lower() == 'no':
+        return False
+    if msg.get('auto-submitted', 'no').lower() <> 'no':
+        return False
+    if msg.get('return-path') == '<>':
+        return False
+    return True