diff options
| -rw-r--r-- | src/mailman/app/membership.py | 10 | ||||
| -rw-r--r-- | src/mailman/app/subscriptions.py | 17 | ||||
| -rw-r--r-- | src/mailman/app/tests/test_membership.py | 14 | ||||
| -rw-r--r-- | src/mailman/interfaces/subscriptions.py | 4 | ||||
| -rw-r--r-- | src/mailman/rest/docs/membership.rst | 23 | ||||
| -rw-r--r-- | src/mailman/rest/members.py | 3 |
6 files changed, 50 insertions, 21 deletions
diff --git a/src/mailman/app/membership.py b/src/mailman/app/membership.py index e7c2f40e3..ee4aa1769 100644 --- a/src/mailman/app/membership.py +++ b/src/mailman/app/membership.py @@ -43,7 +43,8 @@ from mailman.utilities.passwords import encrypt_password -def add_member(mlist, email, realname, password, delivery_mode, language): +def add_member(mlist, email, realname, password, delivery_mode, language, + role=MemberRole.member): """Add a member right now. The member's subscription must be approved by whatever policy the list @@ -70,9 +71,6 @@ def add_member(mlist, email, realname, password, delivery_mode, language): """ # Let's be extra cautious. getUtility(IEmailValidator).validate(email) - if mlist.members.get_member(email) is not None: - raise AlreadySubscribedError( - mlist.fqdn_listname, email, MemberRole.member) # Check to see if the email address is banned. if getUtility(IBanManager).is_banned(email, mlist.fqdn_listname): raise MembershipIsBannedError(mlist, email) @@ -99,7 +97,7 @@ def add_member(mlist, email, realname, password, delivery_mode, language): # scheme is recorded in the hashed password string. user.password = encrypt_password(password) user.preferences.preferred_language = language - member = mlist.subscribe(address, MemberRole.member) + member = mlist.subscribe(address, role) member.preferences.delivery_mode = delivery_mode else: # The user exists and is linked to the address. @@ -110,7 +108,7 @@ def add_member(mlist, email, realname, password, delivery_mode, language): raise AssertionError( 'User should have had linked address: {0}'.format(address)) # Create the member and set the appropriate preferences. - member = mlist.subscribe(address, MemberRole.member) + member = mlist.subscribe(address, role) member.preferences.preferred_language = language member.preferences.delivery_mode = delivery_mode return member diff --git a/src/mailman/app/subscriptions.py b/src/mailman/app/subscriptions.py index f11494e75..6f9399520 100644 --- a/src/mailman/app/subscriptions.py +++ b/src/mailman/app/subscriptions.py @@ -37,7 +37,7 @@ from mailman.core.constants import system_preferences from mailman.interfaces.address import InvalidEmailAddressError from mailman.interfaces.listmanager import ( IListManager, ListDeletedEvent, NoSuchListError) -from mailman.interfaces.member import DeliveryMode +from mailman.interfaces.member import DeliveryMode, MemberRole from mailman.interfaces.subscriptions import ( ISubscriptionService, MissingUserError) from mailman.interfaces.usermanager import IUserManager @@ -138,16 +138,12 @@ class SubscriptionService: for member in self.get_members(): yield member - def join(self, fqdn_listname, subscriber, - real_name= None, delivery_mode=None): + def join(self, fqdn_listname, subscriber, real_name= None, + delivery_mode=DeliveryMode.regular, role=MemberRole.member): """See `ISubscriptionService`.""" mlist = getUtility(IListManager).get(fqdn_listname) if mlist is None: raise NoSuchListError(fqdn_listname) - # Convert from string to enum. - mode = (DeliveryMode.regular - if delivery_mode is None - else delivery_mode) # Is the subscriber a user or email address? if '@' in subscriber: # It's an email address, so we'll want a real name. @@ -163,14 +159,15 @@ class SubscriptionService: # it can't be retrieved. Note that none of these are used unless # the address is completely new to us. password = make_user_friendly_password() - return add_member(mlist, subscriber, real_name, password, mode, - system_preferences.preferred_language) + return add_member(mlist, subscriber, real_name, password, + delivery_mode, + system_preferences.preferred_language, role) else: # We have to assume it's a user id. user = getUtility(IUserManager).get_user_by_id(subscriber) if user is None: raise MissingUserError(subscriber) - return mlist.subscribe(user) + return mlist.subscribe(user, role) def leave(self, fqdn_listname, address): """See `ISubscriptionService`.""" diff --git a/src/mailman/app/tests/test_membership.py b/src/mailman/app/tests/test_membership.py index 2b69c7f39..df2f73134 100644 --- a/src/mailman/app/tests/test_membership.py +++ b/src/mailman/app/tests/test_membership.py @@ -34,7 +34,8 @@ from mailman.app.membership import add_member from mailman.config import config from mailman.core.constants import system_preferences from mailman.interfaces.bans import IBanManager -from mailman.interfaces.member import DeliveryMode, MembershipIsBannedError +from mailman.interfaces.member import (DeliveryMode, MembershipIsBannedError, + MemberRole) from mailman.interfaces.usermanager import IUserManager from mailman.testing.helpers import reset_the_world from mailman.testing.layers import ConfigLayer @@ -58,6 +59,7 @@ class AddMemberTest(unittest.TestCase): system_preferences.preferred_language) self.assertEqual(member.address.email, 'aperson@example.com') self.assertEqual(member.mailing_list, 'test@example.com') + self.assertEqual(member.role, MemberRole.member) def test_add_member_existing_user(self): # Test subscribing a user to a mailing list when the email address has @@ -124,6 +126,16 @@ class AddMemberTest(unittest.TestCase): system_preferences.preferred_language) self.assertEqual(member.address.email, 'anne@example.com') + def test_add_member_moderator(self): + # Test adding a moderator to a mailing list + member = add_member(self._mlist, 'aperson@example.com', + 'Anne Person', '123', DeliveryMode.regular, + system_preferences.preferred_language, + MemberRole.moderator) + self.assertEqual(member.address.email, 'aperson@example.com') + self.assertEqual(member.mailing_list, 'test@example.com') + self.assertEqual(member.role, MemberRole.moderator) + class AddMemberPasswordTest(unittest.TestCase): diff --git a/src/mailman/interfaces/subscriptions.py b/src/mailman/interfaces/subscriptions.py index aa2e318f0..a10b7dab8 100644 --- a/src/mailman/interfaces/subscriptions.py +++ b/src/mailman/interfaces/subscriptions.py @@ -28,6 +28,7 @@ __all__ = [ from zope.interface import Interface from mailman.interfaces.errors import MailmanError +from mailman.interfaces.member import DeliveryMode, MemberRole @@ -91,7 +92,8 @@ class ISubscriptionService(Interface): def __iter__(): """See `get_members()`.""" - def join(fqdn_listname, subscriber, real_name=None, delivery_mode=None): + def join(fqdn_listname, subscriber, real_name=None, + delivery_mode=DeliveryMode.regular, role=MemberRole.member): """Subscribe to a mailing list. A user for the address is created if it is not yet known to Mailman, diff --git a/src/mailman/rest/docs/membership.rst b/src/mailman/rest/docs/membership.rst index bed4f425d..974ba6517 100644 --- a/src/mailman/rest/docs/membership.rst +++ b/src/mailman/rest/docs/membership.rst @@ -197,8 +197,27 @@ an owner of the `ant` mailing list and Dave becomes a moderator of the `bee` mailing list. :: - >>> subscribe(ant, 'Dave', MemberRole.moderator) - >>> subscribe(bee, 'Cris', MemberRole.owner) + >>> dump_json('http://localhost:9001/3.0/members', { + ... 'fqdn_listname': 'ant@example.com', + ... 'subscriber': 'dperson@example.com', + ... 'role': 'moderator', + ... }) + content-length: 0 + date: ... + location: http://localhost:9001/3.0/members/6 + server: ... + status: 201 + + >>> dump_json('http://localhost:9001/3.0/members', { + ... 'fqdn_listname': 'bee@example.com', + ... 'subscriber': 'cperson@example.com', + ... 'role': 'owner', + ... }) + content-length: 0 + date: ... + location: http://localhost:9001/3.0/members/7 + server: ... + status: 201 >>> dump_json('http://localhost:9001/3.0/members') entry 0: diff --git a/src/mailman/rest/members.py b/src/mailman/rest/members.py index 047c375bb..dd1e01d56 100644 --- a/src/mailman/rest/members.py +++ b/src/mailman/rest/members.py @@ -151,7 +151,8 @@ class AllMembers(_MemberBase): subscriber=unicode, real_name=unicode, delivery_mode=enum_validator(DeliveryMode), - _optional=('delivery_mode', 'real_name')) + role=enum_validator(MemberRole), + _optional=('delivery_mode', 'real_name', 'role')) member = service.join(**validator(request)) except AlreadySubscribedError: return http.conflict([], b'Member already subscribed') |