summaryrefslogtreecommitdiff
path: root/src/mailman/interfaces
diff options
context:
space:
mode:
Diffstat (limited to 'src/mailman/interfaces')
-rw-r--r--src/mailman/interfaces/chain.py37
-rw-r--r--src/mailman/interfaces/configuration.py41
-rw-r--r--src/mailman/interfaces/database.py7
-rw-r--r--src/mailman/interfaces/runner.py13
4 files changed, 96 insertions, 2 deletions
diff --git a/src/mailman/interfaces/chain.py b/src/mailman/interfaces/chain.py
index 8858f874c..8862026f8 100644
--- a/src/mailman/interfaces/chain.py
+++ b/src/mailman/interfaces/chain.py
@@ -21,11 +21,17 @@ from __future__ import absolute_import, unicode_literals
__metaclass__ = type
__all__ = [
+ 'AcceptEvent',
+ 'AcceptOwnerEvent',
+ 'ChainEvent',
+ 'DiscardEvent',
+ 'HoldEvent',
'IChain',
'IChainIterator',
'IChainLink',
'IMutableChain',
'LinkAction',
+ 'RejectEvent',
]
@@ -34,6 +40,37 @@ from zope.interface import Interface, Attribute
+class ChainEvent:
+ """Base class for chain notification events."""
+
+ def __init__(self, mlist, msg, msgdata, chain):
+ self.mlist = mlist
+ self.msg = msg
+ self.msgdata = msgdata
+ self.chain = chain
+
+
+class AcceptEvent(ChainEvent):
+ """A notification event signaling that a message is being accepted."""
+
+
+class AcceptOwnerEvent(ChainEvent):
+ """An event signaling that a message is accepted to the -owner address."""
+
+
+class DiscardEvent(ChainEvent):
+ """A notification event signaling that a message is being discarded."""
+
+
+class HoldEvent(ChainEvent):
+ """A notification event signaling that a message is being held."""
+
+
+class RejectEvent(ChainEvent):
+ """A notification event signaling that a message is being rejected."""
+
+
+
class LinkAction(Enum):
# Jump to another chain.
jump = 0
diff --git a/src/mailman/interfaces/configuration.py b/src/mailman/interfaces/configuration.py
new file mode 100644
index 000000000..8c4fb52a6
--- /dev/null
+++ b/src/mailman/interfaces/configuration.py
@@ -0,0 +1,41 @@
+# Copyright (C) 2012 by the Free Software Foundation, Inc.
+#
+# This file is part of GNU Mailman.
+#
+# GNU Mailman is free software: you can redistribute it and/or modify it under
+# the terms of the GNU General Public License as published by the Free
+# Software Foundation, either version 3 of the License, or (at your option)
+# any later version.
+#
+# GNU Mailman is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+# more details.
+#
+# You should have received a copy of the GNU General Public License along with
+# GNU Mailman. If not, see <http://www.gnu.org/licenses/>.
+
+"""Configuration system interface."""
+
+from __future__ import absolute_import, print_function, unicode_literals
+
+__metaclass__ = type
+__all__ = [
+ 'ConfigurationUpdatedEvent',
+ 'IConfiguration',
+ ]
+
+
+from zope.interface import Interface
+
+
+
+class IConfiguration(Interface):
+ """Marker interface; used for adaptation in the REST API."""
+
+
+
+class ConfigurationUpdatedEvent:
+ """The system-wide global configuration was updated."""
+ def __init__(self, config):
+ self.config = config
diff --git a/src/mailman/interfaces/database.py b/src/mailman/interfaces/database.py
index 0530f83b9..040bce77c 100644
--- a/src/mailman/interfaces/database.py
+++ b/src/mailman/interfaces/database.py
@@ -17,7 +17,7 @@
"""Interfaces for database interaction."""
-from __future__ import absolute_import, unicode_literals
+from __future__ import absolute_import, print_function, unicode_literals
__metaclass__ = type
__all__ = [
@@ -26,7 +26,7 @@ __all__ = [
]
-from zope.interface import Interface
+from zope.interface import Attribute, Interface
from mailman.interfaces.errors import MailmanError
@@ -63,3 +63,6 @@ class IDatabase(Interface):
def abort():
"""Abort the current transaction."""
+
+ store = Attribute(
+ """The underlying Storm store on which you can do queries.""")
diff --git a/src/mailman/interfaces/runner.py b/src/mailman/interfaces/runner.py
index 4611fa3a7..9a3c9baa4 100644
--- a/src/mailman/interfaces/runner.py
+++ b/src/mailman/interfaces/runner.py
@@ -22,6 +22,7 @@ from __future__ import absolute_import, unicode_literals
__metaclass__ = type
__all__ = [
'IRunner',
+ 'RunnerCrashEvent',
]
@@ -29,6 +30,18 @@ from zope.interface import Interface, Attribute
+class RunnerCrashEvent:
+ """Triggered when a runner encounters an exception in _dispose()."""
+
+ def __init__(self, runner, mlist, msg, metadata, error):
+ self.runner = runner
+ self.mailing_list = mlist
+ self.message = msg
+ self.metadata = metadata
+ self.error = error
+
+
+
class IRunner(Interface):
"""The runner."""