summaryrefslogtreecommitdiff
path: root/src/mailman/app/membership.py
diff options
context:
space:
mode:
Diffstat (limited to 'src/mailman/app/membership.py')
-rw-r--r--src/mailman/app/membership.py137
1 files changed, 137 insertions, 0 deletions
diff --git a/src/mailman/app/membership.py b/src/mailman/app/membership.py
new file mode 100644
index 000000000..4b9609469
--- /dev/null
+++ b/src/mailman/app/membership.py
@@ -0,0 +1,137 @@
+# Copyright (C) 2007-2009 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/>.
+
+"""Application support for membership management."""
+
+from __future__ import unicode_literals
+
+__metaclass__ = type
+__all__ = [
+ 'add_member',
+ 'delete_member',
+ ]
+
+
+from email.utils import formataddr
+
+from mailman import Message
+from mailman import Utils
+from mailman import i18n
+from mailman.app.notifications import send_goodbye_message
+from mailman.config import config
+from mailman.core import errors
+from mailman.interfaces.member import AlreadySubscribedError, MemberRole
+
+_ = i18n._
+
+
+
+def add_member(mlist, address, realname, password, delivery_mode, language):
+ """Add a member right now.
+
+ The member's subscription must be approved by whatever policy the list
+ enforces.
+
+ :param mlist: the mailing list to add the member to
+ :type mlist: IMailingList
+ :param address: the address to subscribe
+ :type address: string
+ :param realname: the subscriber's full name
+ :type realname: string
+ :param password: the subscriber's password
+ :type password: string
+ :param delivery_mode: the delivery mode the subscriber has chosen
+ :type delivery_mode: DeliveryMode
+ :param language: the language that the subscriber is going to use
+ :type language: string
+ """
+ # Let's be extra cautious.
+ Utils.ValidateEmail(address)
+ if mlist.members.get_member(address) is not None:
+ raise AlreadySubscribedError(
+ mlist.fqdn_listname, address, MemberRole.member)
+ # Check for banned address here too for admin mass subscribes and
+ # confirmations.
+ pattern = Utils.get_pattern(address, mlist.ban_list)
+ if pattern:
+ raise errors.MembershipIsBanned(pattern)
+ # Do the actual addition. First, see if there's already a user linked
+ # with the given address.
+ user = config.db.user_manager.get_user(address)
+ if user is None:
+ # A user linked to this address does not yet exist. Is the address
+ # itself known but just not linked to a user?
+ address_obj = config.db.user_manager.get_address(address)
+ if address_obj is None:
+ # Nope, we don't even know about this address, so create both the
+ # user and address now.
+ user = config.db.user_manager.create_user(address, realname)
+ # Do it this way so we don't have to flush the previous change.
+ address_obj = list(user.addresses)[0]
+ else:
+ # The address object exists, but it's not linked to a user.
+ # Create the user and link it now.
+ user = config.db.user_manager.create_user()
+ user.real_name = (realname if realname else address_obj.real_name)
+ user.link(address_obj)
+ # Since created the user, then the member, and set preferences on the
+ # appropriate object.
+ user.password = password
+ user.preferences.preferred_language = language
+ member = address_obj.subscribe(mlist, MemberRole.member)
+ member.preferences.delivery_mode = delivery_mode
+ else:
+ # The user exists and is linked to the address.
+ for address_obj in user.addresses:
+ if address_obj.address == address:
+ break
+ else:
+ raise AssertionError(
+ 'User should have had linked address: {0}'.format(address))
+ # Create the member and set the appropriate preferences.
+ member = address_obj.subscribe(mlist, MemberRole.member)
+ member.preferences.preferred_language = language
+ member.preferences.delivery_mode = delivery_mode
+## mlist.setMemberOption(email, config.Moderate,
+## mlist.default_member_moderation)
+
+
+
+def delete_member(mlist, address, admin_notif=None, userack=None):
+ if userack is None:
+ userack = mlist.send_goodbye_msg
+ if admin_notif is None:
+ admin_notif = mlist.admin_notify_mchanges
+ # Delete a member, for which we know the approval has been made
+ member = mlist.members.get_member(address)
+ language = member.preferred_language
+ member.unsubscribe()
+ # And send an acknowledgement to the user...
+ if userack:
+ send_goodbye_message(mlist, address, language)
+ # ...and to the administrator.
+ if admin_notif:
+ user = config.db.user_manager.get_user(address)
+ realname = user.real_name
+ subject = _('$mlist.real_name unsubscription notification')
+ text = Utils.maketext(
+ 'adminunsubscribeack.txt',
+ {'listname': mlist.real_name,
+ 'member' : formataddr((realname, address)),
+ }, mlist=mlist)
+ msg = Message.OwnerNotification(mlist, subject, text)
+ msg.send(mlist)