diff options
Diffstat (limited to 'src/mailman/app')
| -rw-r--r-- | src/mailman/app/bounces.py | 2 | ||||
| -rw-r--r-- | src/mailman/app/docs/lifecycle.rst | 10 | ||||
| -rw-r--r-- | src/mailman/app/membership.py | 19 | ||||
| -rw-r--r-- | src/mailman/app/moderator.py | 22 | ||||
| -rw-r--r-- | src/mailman/app/notifications.py | 31 | ||||
| -rw-r--r-- | src/mailman/app/registrar.py | 10 | ||||
| -rw-r--r-- | src/mailman/app/subscriptions.py | 8 | ||||
| -rw-r--r-- | src/mailman/app/tests/test_notifications.py | 2 |
8 files changed, 53 insertions, 51 deletions
diff --git a/src/mailman/app/bounces.py b/src/mailman/app/bounces.py index 3816369fa..d88621e9b 100644 --- a/src/mailman/app/bounces.py +++ b/src/mailman/app/bounces.py @@ -215,7 +215,7 @@ def send_probe(member, msg): ) # Calculate the Subject header, in the member's preferred language. with _.using(member.preferred_language.code): - subject = _('$mlist.real_name mailing list probe message') + subject = _('$mlist.display_name mailing list probe message') # Craft the probe message. This will be a multipart where the first part # is the probe text and the second part is the message that caused this # probe to be sent. diff --git a/src/mailman/app/docs/lifecycle.rst b/src/mailman/app/docs/lifecycle.rst index d8356db74..c9d3ed10d 100644 --- a/src/mailman/app/docs/lifecycle.rst +++ b/src/mailman/app/docs/lifecycle.rst @@ -119,13 +119,13 @@ the system, they won't be created again. >>> user_b = user_manager.get_user('bperson@example.com') >>> user_c = user_manager.get_user('cperson@example.com') >>> user_d = user_manager.get_user('dperson@example.com') - >>> user_a.real_name = 'Anne Person' - >>> user_b.real_name = 'Bart Person' - >>> user_c.real_name = 'Caty Person' - >>> user_d.real_name = 'Dirk Person' + >>> user_a.display_name = 'Anne Person' + >>> user_b.display_name = 'Bart Person' + >>> user_c.display_name = 'Caty Person' + >>> user_d.display_name = 'Dirk Person' >>> mlist_3 = create_list('test_3@example.com', owners) - >>> dump_list(user.real_name for user in mlist_3.owners.users) + >>> dump_list(user.display_name for user in mlist_3.owners.users) Anne Person Bart Person Caty Person diff --git a/src/mailman/app/membership.py b/src/mailman/app/membership.py index 1d075afcd..e31a1695c 100644 --- a/src/mailman/app/membership.py +++ b/src/mailman/app/membership.py @@ -43,7 +43,7 @@ from mailman.utilities.i18n import make -def add_member(mlist, email, realname, password, delivery_mode, language, +def add_member(mlist, email, display_name, password, delivery_mode, language, role=MemberRole.member): """Add a member right now. @@ -54,8 +54,8 @@ def add_member(mlist, email, realname, password, delivery_mode, language, :type mlist: `IMailingList` :param email: The email address to subscribe. :type email: str - :param realname: The subscriber's full name. - :type realname: str + :param display_name: The subscriber's full name. + :type display_name: str :param password: The subscriber's plain text password. :type password: str :param delivery_mode: The delivery mode the subscriber has chosen. @@ -86,14 +86,15 @@ def add_member(mlist, email, realname, password, delivery_mode, language, if address is None: # Nope, we don't even know about this address, so create both the # user and address now. - user = user_manager.create_user(email, realname) + user = user_manager.create_user(email, display_name) # Do it this way so we don't have to flush the previous change. address = 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 = user_manager.create_user() - user.real_name = (realname if realname else address.real_name) + user.display_name = ( + display_name if display_name else address.display_name) user.link(address) # Encrypt the password using the currently selected scheme. The # scheme is recorded in the hashed password string. @@ -148,12 +149,12 @@ def delete_member(mlist, email, admin_notif=None, userack=None): # ...and to the administrator. if admin_notif: user = getUtility(IUserManager).get_user(email) - realname = user.real_name - subject = _('$mlist.real_name unsubscription notification') + display_name = user.display_name + subject = _('$mlist.display_name unsubscription notification') text = make('adminunsubscribeack.txt', mailing_list=mlist, - listname=mlist.real_name, - member=formataddr((realname, email)), + listname=mlist.display_name, + member=formataddr((display_name, email)), ) msg = OwnerNotification(mlist, subject, text, roster=mlist.administrators) diff --git a/src/mailman/app/moderator.py b/src/mailman/app/moderator.py index 01dc4a232..2e2711809 100644 --- a/src/mailman/app/moderator.py +++ b/src/mailman/app/moderator.py @@ -162,7 +162,7 @@ def handle_message(mlist, id, action, # Get a copy of the original message from the message store. msg = message_store.get_message_by_id(message_id) # It's possible the forwarding address list is a comma separated list - # of realname/address pairs. + # of display_name/address pairs. addresses = [addr[1] for addr in getaddresses(forward)] language = mlist.preferred_language if len(addresses) == 1: @@ -197,10 +197,10 @@ def handle_message(mlist, id, action, -def hold_subscription(mlist, address, realname, password, mode, language): +def hold_subscription(mlist, address, display_name, password, mode, language): data = dict(when=now().isoformat(), address=address, - realname=realname, + display_name=display_name, password=password, delivery_mode=str(mode), language=language) @@ -213,7 +213,7 @@ def hold_subscription(mlist, address, realname, password, mode, language): # Possibly notify the administrator in default list language if mlist.admin_immed_notify: subject = _( - 'New subscription request to list $mlist.real_name from $address') + 'New subscription request to $mlist.display_name from $address') text = make('subauth.txt', mailing_list=mlist, username=address, @@ -249,11 +249,11 @@ def handle_subscription(mlist, id, action, comment=None): enum_value = data['delivery_mode'].split('.')[-1] delivery_mode = DeliveryMode(enum_value) address = data['address'] - realname = data['realname'] + display_name = data['display_name'] language = getUtility(ILanguageManager)[data['language']] password = data['password'] try: - add_member(mlist, address, realname, password, + add_member(mlist, address, display_name, password, delivery_mode, language) except AlreadySubscribedError: # The address got subscribed in some other way after the original @@ -264,9 +264,9 @@ def handle_subscription(mlist, id, action, comment=None): send_welcome_message(mlist, address, language, delivery_mode) if mlist.admin_notify_mchanges: send_admin_subscription_notice( - mlist, address, realname, language) + mlist, address, display_name, language) slog.info('%s: new %s, %s %s', mlist.fqdn_listname, - delivery_mode, formataddr((realname, address)), + delivery_mode, formataddr((display_name, address)), 'via admin approval') else: raise AssertionError('Unexpected action: {0}'.format(action)) @@ -285,7 +285,7 @@ def hold_unsubscription(mlist, address): # Possibly notify the administrator of the hold if mlist.admin_immed_notify: subject = _( - 'New unsubscription request from $mlist.real_name by $address') + 'New unsubscription request from $mlist.display_name by $address') text = make('unsubauth.txt', mailing_list=mlist, address=address, @@ -335,7 +335,7 @@ def _refuse(mlist, request, recip, comment, origmsg=None, lang=None): # As this message is going to the requester, try to set the language to # his/her language choice, if they are a member. Otherwise use the list's # preferred language. - realname = mlist.real_name + display_name = mlist.display_name if lang is None: member = mlist.members.get_member(recip) lang = (mlist.preferred_language @@ -357,7 +357,7 @@ def _refuse(mlist, request, recip, comment, origmsg=None, lang=None): '---------- ' + _('Original Message') + ' ----------', str(origmsg) ]) - subject = _('Request to mailing list "$realname" rejected') + subject = _('Request to mailing list "$display_name" rejected') msg = UserNotification(recip, mlist.bounces_address, subject, text, lang) msg.send(mlist) diff --git a/src/mailman/app/notifications.py b/src/mailman/app/notifications.py index 5604d5f05..bc5b326ac 100644 --- a/src/mailman/app/notifications.py +++ b/src/mailman/app/notifications.py @@ -17,7 +17,7 @@ """Sending notifications.""" -from __future__ import unicode_literals +from __future__ import absolute_import, print_function, unicode_literals __metaclass__ = type __all__ = [ @@ -80,12 +80,12 @@ def send_welcome_message(mlist, address, language, delivery_mode, text=''): # Find the IMember object which is subscribed to the mailing list, because # from there, we can get the member's options url. member = mlist.members.get_member(address) - user_name = member.user.real_name + user_name = member.user.display_name options_url = member.options_url # Get the text from the template. text = expand(welcome, dict( fqdn_listname=mlist.fqdn_listname, - list_name=mlist.real_name, + list_name=mlist.display_name, listinfo_uri=mlist.script_url('listinfo'), list_requests=mlist.request_address, user_name=user_name, @@ -99,7 +99,7 @@ def send_welcome_message(mlist, address, language, delivery_mode, text=''): msg = UserNotification( formataddr((user_name, address)), mlist.request_address, - _('Welcome to the "$mlist.real_name" mailing list${digmode}'), + _('Welcome to the "$mlist.display_name" mailing list${digmode}'), text, language) msg['X-No-Archive'] = 'yes' msg.send(mlist, verp=as_boolean(config.mta.verp_personalized_deliveries)) @@ -125,31 +125,32 @@ def send_goodbye_message(mlist, address, language): goodbye = '' msg = UserNotification( address, mlist.bounces_address, - _('You have been unsubscribed from the $mlist.real_name mailing list'), + _('You have been unsubscribed from the $mlist.display_name ' + 'mailing list'), goodbye, language) msg.send(mlist, verp=as_boolean(config.mta.verp_personalized_deliveries)) -def send_admin_subscription_notice(mlist, address, full_name, language): +def send_admin_subscription_notice(mlist, address, display_name, language): """Send the list administrators a subscription notice. - :param mlist: the mailing list + :param mlist: The mailing list. :type mlist: IMailingList - :param address: the address being subscribed + :param address: The address being subscribed. :type address: string - :param full_name: the name of the subscriber - :type full_name: string - :param language: the language of the address's realname + :param display_name: The name of the subscriber. + :type display_name: string + :param language: The language of the address's display name. :type language: string """ with _.using(mlist.preferred_language.code): - subject = _('$mlist.real_name subscription notification') - full_name = full_name.encode(language.charset, 'replace') + subject = _('$mlist.display_name subscription notification') + display_name = display_name.encode(language.charset, 'replace') text = make('adminsubscribeack.txt', mailing_list=mlist, - listname=mlist.real_name, - member=formataddr((full_name, address)), + listname=mlist.display_name, + member=formataddr((display_name, address)), ) msg = OwnerNotification(mlist, subject, text, roster=mlist.administrators) msg.send(mlist) diff --git a/src/mailman/app/registrar.py b/src/mailman/app/registrar.py index e439b3c54..b95fda1f8 100644 --- a/src/mailman/app/registrar.py +++ b/src/mailman/app/registrar.py @@ -59,7 +59,7 @@ class Registrar: implements(IRegistrar) - def register(self, mlist, email, real_name=None, delivery_mode=None): + def register(self, mlist, email, display_name=None, delivery_mode=None): """See `IUserRegistrar`.""" if delivery_mode is None: delivery_mode = DeliveryMode.regular @@ -70,7 +70,7 @@ class Registrar: pendable = PendableRegistration( type=PendableRegistration.PEND_KEY, email=email, - real_name=real_name, + display_name=display_name, delivery_mode=delivery_mode.name) pendable['list_name'] = mlist.fqdn_listname token = getUtility(IPendings).add(pendable) @@ -104,7 +104,7 @@ class Registrar: return False missing = object() email = pendable.get('email', missing) - real_name = pendable.get('real_name', missing) + display_name = pendable.get('display_name', missing) list_name = pendable.get('list_name', missing) pended_delivery_mode = pendable.get('delivery_mode', 'regular') try: @@ -133,7 +133,7 @@ class Registrar: # and link the two together if address is None: assert user is None, 'How did we get a user but not an address?' - user = user_manager.create_user(email, real_name) + user = user_manager.create_user(email, display_name) # Because the database changes haven't been flushed, we can't use # IUserManager.get_address() to find the IAddress just created # under the hood. Instead, iterate through the IUser's addresses, @@ -145,7 +145,7 @@ class Registrar: raise AssertionError('Could not find expected IAddress') elif user is None: user = user_manager.create_user() - user.real_name = real_name + user.display_name = display_name user.link(address) else: # The IAddress and linked IUser already exist, so all we need to diff --git a/src/mailman/app/subscriptions.py b/src/mailman/app/subscriptions.py index 931d7f4c7..60f8cdebe 100644 --- a/src/mailman/app/subscriptions.py +++ b/src/mailman/app/subscriptions.py @@ -145,7 +145,7 @@ class SubscriptionService: yield member def join(self, fqdn_listname, subscriber, - real_name=None, + display_name=None, delivery_mode=DeliveryMode.regular, role=MemberRole.member): """See `ISubscriptionService`.""" @@ -158,8 +158,8 @@ class SubscriptionService: # it's a valid email address, and let InvalidEmailAddressError # propagate up. getUtility(IEmailValidator).validate(subscriber) - if real_name is None: - real_name, at, domain = subscriber.partition('@') + if display_name is None: + display_name, at, domain = subscriber.partition('@') # Because we want to keep the REST API simple, there is no # password or language given to us. We'll use the system's # default language for the user's default language. We'll set the @@ -167,7 +167,7 @@ class SubscriptionService: # it can't be retrieved. Note that none of these are used unless # the address is completely new to us. password = generate(int(config.passwords.password_length)) - return add_member(mlist, subscriber, real_name, password, + return add_member(mlist, subscriber, display_name, password, delivery_mode, system_preferences.preferred_language, role) else: diff --git a/src/mailman/app/tests/test_notifications.py b/src/mailman/app/tests/test_notifications.py index 42f482582..8cce1be6f 100644 --- a/src/mailman/app/tests/test_notifications.py +++ b/src/mailman/app/tests/test_notifications.py @@ -50,7 +50,7 @@ class TestNotifications(unittest.TestCase): def setUp(self): self._mlist = create_list('test@example.com') self._mlist.welcome_message_uri = 'mailman:///welcome.txt' - self._mlist.real_name = 'Test List' + self._mlist.display_name = 'Test List' self.var_dir = tempfile.mkdtemp() config.push('template config', """\ [paths.testing] |