1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
|
# Copyright (C) 2008-2017 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/>.
"""Domains."""
from mailman.database.model import Model
from mailman.database.transaction import dbconnection
from mailman.database.types import SAUnicode
from mailman.interfaces.domain import (
BadDomainSpecificationError, DomainCreatedEvent, DomainCreatingEvent,
DomainDeletedEvent, DomainDeletingEvent, IDomain, IDomainManager)
from mailman.interfaces.user import IUser
from mailman.interfaces.usermanager import IUserManager
from mailman.model.mailinglist import MailingList
from public import public
from sqlalchemy import Column, Integer
from sqlalchemy.orm import relationship
from zope.component import getUtility
from zope.event import notify
from zope.interface import implementer
@public
@implementer(IDomain)
class Domain(Model):
"""Domains."""
__tablename__ = 'domain'
id = Column(Integer, primary_key=True)
mail_host = Column(SAUnicode)
description = Column(SAUnicode)
owners = relationship('User',
secondary='domain_owner',
backref='domains')
def __init__(self, mail_host,
description=None,
owners=None):
"""Create and register a domain.
:param mail_host: The host name for the email interface.
:type mail_host: string
:param description: An optional description of the domain.
:type description: string
:param owners: Optional owners of this domain.
:type owners: sequence of `IUser` or string emails.
"""
self.mail_host = mail_host
self.description = description
if owners is not None:
self.add_owners(owners)
@property
@dbconnection
def mailing_lists(self, store):
"""See `IDomain`."""
yield from store.query(MailingList).filter(
MailingList.mail_host == self.mail_host
).order_by(MailingList._list_id)
def __repr__(self):
"""repr(a_domain)"""
if self.description is None:
return ('<Domain {0.mail_host}>').format(self)
else:
return ('<Domain {0.mail_host}, {0.description}>').format(self)
def add_owner(self, owner):
"""See `IDomain`."""
user_manager = getUtility(IUserManager)
if IUser.providedBy(owner):
user = owner
else:
user = user_manager.get_user(owner)
# BAW 2015-04-06: Make sure this path is tested.
if user is None:
user = user_manager.create_user(owner)
self.owners.append(user)
def add_owners(self, owners):
"""See `IDomain`."""
# BAW 2015-04-06: This should probably be more efficient by inlining
# add_owner().
for owner in owners:
self.add_owner(owner)
def remove_owner(self, owner):
"""See `IDomain`."""
user_manager = getUtility(IUserManager)
self.owners.remove(user_manager.get_user(owner))
@public
@implementer(IDomainManager)
class DomainManager:
"""Domain manager."""
@dbconnection
def add(self, store,
mail_host,
description=None,
owners=None):
"""See `IDomainManager`."""
# Be sure the mail_host is not already registered. This is probably
# a constraint that should (also) be maintained in the database.
if self.get(mail_host) is not None:
raise BadDomainSpecificationError(
'Duplicate email host: {}'.format(mail_host))
notify(DomainCreatingEvent(mail_host))
domain = Domain(mail_host, description, owners)
store.add(domain)
notify(DomainCreatedEvent(domain))
return domain
@dbconnection
def remove(self, store, mail_host):
domain = self[mail_host]
notify(DomainDeletingEvent(domain))
store.delete(domain)
notify(DomainDeletedEvent(mail_host))
return domain
@dbconnection
def get(self, store, mail_host, default=None):
"""See `IDomainManager`."""
domains = store.query(Domain).filter_by(mail_host=mail_host)
if domains.count() < 1:
return default
assert domains.count() == 1, (
'Too many matching domains: %s' % mail_host)
return domains.one()
def __getitem__(self, mail_host):
"""See `IDomainManager`."""
missing = object()
domain = self.get(mail_host, missing)
if domain is missing:
raise KeyError(mail_host)
return domain
@dbconnection
def __len__(self, store):
return store.query(Domain).count()
@dbconnection
def __iter__(self, store):
"""See `IDomainManager`."""
yield from store.query(Domain).order_by(Domain.mail_host).all()
@dbconnection
def __contains__(self, store, mail_host):
"""See `IDomainManager`."""
return store.query(Domain).filter_by(mail_host=mail_host).count() > 0
|
