diff --git a/src/postorius/forms.py b/src/postorius/forms.py index e093870..e8f8810 100644 --- a/src/postorius/forms.py +++ b/src/postorius/forms.py @@ -20,9 +20,11 @@ from django.core.validators import validate_email from django.utils.translation import gettext as _ from fieldset_forms import FieldsetForm +from django.forms.models import modelformset_factory class DomainNew(FieldsetForm): + """ Form field to add a new domain """ @@ -60,6 +62,7 @@ return web_host class Meta: + """ Class to handle the automatic insertion of fieldsets and divs. @@ -74,6 +77,7 @@ class NewOwnerForm(forms.Form): + """Add a list owner.""" owner_email = forms.EmailField( label=_('Email Address'), @@ -83,6 +87,7 @@ class NewModeratorForm(forms.Form): + """Add a list moderator.""" moderator_email = forms.EmailField( label=_('Email Address'), @@ -92,6 +97,7 @@ class ListNew(FieldsetForm): + """ Form fields to add a new list. Languages are hard coded which should be replaced by a REST lookup of available languages. @@ -130,13 +136,12 @@ error_messages={'required': _("Choose an existing Domain."), 'invalid': "ERROR-todo_forms.py"}) if len(domain_choices) < 2: - self.fields["mail_host"].help_text=_( + self.fields["mail_host"].help_text = _( "Site admin has not created any domains") - #if len(choices) < 2: + # if len(choices) < 2: # help_text=_("No domains available: " + # "The site admin must create new domains " + # "before you will be able to create a list") - def clean_listname(self): try: @@ -146,6 +151,7 @@ return self.cleaned_data['listname'] class Meta: + """ Class to handle the automatic insertion of fieldsets and divs. @@ -162,6 +168,7 @@ class ListSubscribe(FieldsetForm): + """Form fields to join an existing list. """ email = forms.EmailField( @@ -174,6 +181,7 @@ class ListUnsubscribe(FieldsetForm): + """Form fields to leave an existing list. """ email = forms.EmailField( @@ -185,17 +193,18 @@ class ListSettings(FieldsetForm): + """Form fields dealing with the list settings. """ choices = ((True, _('Yes')), (False, _('No'))) - #list_name = forms.CharField( + # list_name = forms.CharField( # label=_('List Name'), # required=False) host_name = forms.CharField( label=_('Domain host name'), required=False) # informational, not configurable - #fqdn_listname = forms.CharField( + # fqdn_listname = forms.CharField( # label=_('Fqdn listname'), # required=False) include_rfc2369_headers = forms.TypedChoiceField( @@ -204,15 +213,16 @@ widget=forms.RadioSelect, required=False, label= _('Include RFC2369 headers'), - help_text=_('Yes is highly recommended. RFC 2369 defines a set of List-* headers that are normally added to every message sent to the list membership. These greatly aid end-users who are using standards compliant mail readers. They should normally always be enabled.However, not all mail readers are standards compliant yet, and if you have a large number of members who are using non-compliant mail readers, they may be annoyed at these headers. You should first try to educate your members as to why these headers exist, and how to hide them in their mail clients. As a last resort you can disable these headers, but this is not recommended (and in fact, your ability to disable these headers may eventually go away).')) + help_text=_('Yes is highly recommended. RFC 2369 defines a set of List-* headers that are normally added to every message sent to the list membership. These greatly aid end-users who are using standards compliant mail readers. They should normally always be enabled.However, not all mail readers are standards compliant yet, and if you have a large number of members who are using non-compliant mail readers, they may be annoyed at these headers. You should first try to educate your members as to why these headers exist, and how to hide them in their mail clients. As a last resort you can disable these headers, but this is not recommended (and in fact, your ability to disable these headers may eventually go away).')) allow_list_posts = forms.TypedChoiceField( choices=choices, widget=forms.RadioSelect, label=_("Include the list post header"), - help_text=_("This can be set to no for announce lists that do not wish to include the List-Post header because posting to the list is discouraged."), + help_text=_( + "This can be set to no for announce lists that do not wish to include the List-Post header because posting to the list is discouraged."), ) archive_policy_choices = ( - ("public", _("Public Archives")), + ("public", _("Public Archives")), ("private", _("Private Archives")), ("never", _("Do not archive this list")), ) @@ -230,12 +240,12 @@ choices=autorespond_choices, widget=forms.RadioSelect, label=_('Autorespond to list owner'), - help_text=('Should Mailman send an auto-response to emails sent to the -owner address?')) + help_text=('Should Mailman send an auto-response to emails sent to the -owner address?')) autoresponse_owner_text = forms.CharField( label=_('Autoresponse owner text'), widget=forms.Textarea(), required=False, - help_text=('Auto-response text to send to -owner emails.')) + help_text=('Auto-response text to send to -owner emails.')) autorespond_postings = forms.ChoiceField( choices=autorespond_choices, widget=forms.RadioSelect, @@ -260,7 +270,7 @@ label=_('Autoresponse grace period'), help_text=('Number of days between auto-responses to either the mailing list or -request/-owner address from the same poster. Set to zero (or negative) for no grace period (i.e. auto-respond to every message).')) # This doesn't make sense as a configurable, so we're leaving it out - #bounces_address = forms.EmailField( + # bounces_address = forms.EmailField( # label=_('Bounces Address'), # required=False) advertised = forms.TypedChoiceField( @@ -275,21 +285,21 @@ widget=forms.RadioSelect, required=False, label=_('Filter content'), - help_text=('Should Mailman filter the content of list traffic according to the settings below?')) + help_text=('Should Mailman filter the content of list traffic according to the settings below?')) collapse_alternatives = forms.TypedChoiceField( coerce=lambda x: x == 'True', choices=((True, _('Yes')), (False, _('No'))), widget=forms.RadioSelect, required=False, label=_('Collapse alternatives'), - help_text=('Should Mailman collapse multipart/alternative to its first part content?')) + help_text=('Should Mailman collapse multipart/alternative to its first part content?')) convert_html_to_plaintext = forms.TypedChoiceField( coerce=lambda x: x == 'True', choices=((True, _('Yes')), (False, _('No'))), widget=forms.RadioSelect, required=False, label=_('Convert html to plaintext'), - help_text=('Should Mailman convert text/html parts to plain text? This conversion happens after MIME attachments have been stripped.')) + help_text=('Should Mailman convert text/html parts to plain text? This conversion happens after MIME attachments have been stripped.')) action_choices = ( ("hold", _("Hold for moderator")), ("reject", _("Reject (with notification)")), @@ -303,7 +313,7 @@ 'required': _("Please choose a default member action.")}, required=True, choices=action_choices, - help_text=('Default action to take when a member posts to the list.Hold -- This holds the message for approval by the list moderators. Reject -- this automatically rejects the message by sending a bounce notice to the post\'s author. The text of the bounce notice can be configured by you. Discard -- this simply discards the message, with no notice sent to the post\'s author. Accept --accepts any postings to the list by default. Defer -- Defers any postings to the list by default. ')) + help_text=('Default action to take when a member posts to the list.Hold -- This holds the message for approval by the list moderators. Reject -- this automatically rejects the message by sending a bounce notice to the post\'s author. The text of the bounce notice can be configured by you. Discard -- this simply discards the message, with no notice sent to the post\'s author. Accept --accepts any postings to the list by default. Defer -- Defers any postings to the list by default. ')) default_nonmember_action = forms.ChoiceField( widget=forms.RadioSelect(), label=_('Default action to take when a non-member posts to the' @@ -312,27 +322,29 @@ 'required': _("Please choose a default non-member action.")}, required=True, choices=action_choices, - help_text=('When a post from a non-member is received, the message\'s sender is matched against the list of explicitly accepted, held, rejected (bounced), and discarded addresses. If no match is found, then this action is taken.')) + help_text=('When a post from a non-member is received, the message\'s sender is matched against the list of explicitly accepted, held, rejected (bounced), and discarded addresses. If no match is found, then this action is taken.')) description = forms.CharField( label=_('Description'), - help_text=('This description is used when the mailing list is listed with other mailing lists, or in headers, and so forth. It should be as succinct as you can get it, while still identifying what the list is.'), + help_text=( + 'This description is used when the mailing list is listed with other mailing lists, or in headers, and so forth. It should be as succinct as you can get it, while still identifying what the list is.'), widget=forms.Textarea()) digest_size_threshold = forms.DecimalField( label=_('Digest size threshold'), help_text=('How big in Kb should a digest be before it gets sent out?') ) # Informational - #digest_last_sent_at = forms.IntegerField( + # digest_last_sent_at = forms.IntegerField( # label=_('Digest last sent at'), # error_messages={ # 'invalid': _('Please provide an integer.')}, # required=False) - first_strip_reply_to = forms.TypedChoiceField( + first_strip_reply_to = forms.TypedChoiceField( coerce=lambda x: x == 'False', choices=((True, _('Yes')), (False, _('No'))), widget=forms.RadioSelect, required=False, - help_text=_('Should any existing Reply-To: header found in the original message be stripped? If so, this will be done regardless of whether an explict Reply-To: header is added by Mailman or not.') + help_text=_( + 'Should any existing Reply-To: header found in the original message be stripped? If so, this will be done regardless of whether an explict Reply-To: header is added by Mailman or not.') ) generic_nonmember_action = forms.IntegerField( label=_('Generic nonmember action'), @@ -347,22 +359,23 @@ required=True, help_text="The \"host_name\" is the preferred name for email to mailman-related addresses on this host, and generally should be the mail host's exchanger address, if any. This setting can be useful for selecting among alternative names of a host that has multiple addresses.") # informational, not editable - #next_digest_number = forms.IntegerField( + # next_digest_number = forms.IntegerField( # label=_('Next digest number'), # error_messages={ # 'invalid': _('Please provide an integer.'), # }, # required=False, #) - #no_reply_address = forms.EmailField( + # no_reply_address = forms.EmailField( # label=_('No reply address'), # required=False, #) posting_pipeline = forms.CharField( label=_('Pipeline'), - help_text=('Type of pipeline you want to use for this mailing list') + help_text=( + 'Type of pipeline you want to use for this mailing list') ) - #post_id = forms.IntegerField( + # post_id = forms.IntegerField( # label=_('Post ID'), # error_messages={ # 'invalid': _('Please provide an integer.'), @@ -371,7 +384,7 @@ #) display_name = forms.CharField( label=_('Display name'), - help_text= ('Display name is the name shown in the web interface.') + help_text=('Display name is the name shown in the web interface.') ) subject_prefix = forms.CharField( label=_('Subject prefix'), @@ -386,14 +399,15 @@ ("no_munging", _("No Munging")), ("point_to_list", _("Reply goes to list")), ("explicit_header", _("Explicit Reply-to header set"))), - help_text=('Where are replies to list messages directed? No Munging is strongly recommended for most mailing lists. \nThis option controls what Mailman does to the Reply-To: header in messages flowing through this mailing list. When set to No Munging, no Reply-To: header is added by Mailman, although if one is present in the original message, it is not stripped. Setting this value to either Reply to List or Explicit Reply causes Mailman to insert a specific Reply-To: header in all messages, overriding the header in the original message if necessary (Explicit Reply inserts the value of reply_to_address).There are many reasons not to introduce or override the Reply-To: header. One is that some posters depend on their own Reply-To: settings to convey their valid return address. Another is that modifying Reply-To: makes it much more difficult to send private replies. See `Reply-To\' Munging Considered Harmful for a general discussion of this issue. See Reply-To Munging Considered Useful for a dissenting opinion.Some mailing lists have restricted posting privileges, with a parallel list devoted to discussions. Examples are `patches\' or `checkin\' lists, where software changes are posted by a revision control system, but discussion about the changes occurs on a developers mailing list. To support these types of mailing lists, select Explicit Reply and set the Reply-To: address option to point to the parallel list. ')) - reply_to_address = forms.CharField( - label= _('Explicit reply-to address'), + help_text=('Where are replies to list messages directed? No Munging is strongly recommended for most mailing lists. \nThis option controls what Mailman does to the Reply-To: header in messages flowing through this mailing list. When set to No Munging, no Reply-To: header is added by Mailman, although if one is present in the original message, it is not stripped. Setting this value to either Reply to List or Explicit Reply causes Mailman to insert a specific Reply-To: header in all messages, overriding the header in the original message if necessary (Explicit Reply inserts the value of reply_to_address).There are many reasons not to introduce or override the Reply-To: header. One is that some posters depend on their own Reply-To: settings to convey their valid return address. Another is that modifying Reply-To: makes it much more difficult to send private replies. See `Reply-To\' Munging Considered Harmful for a general discussion of this issue. See Reply-To Munging Considered Useful for a dissenting opinion.Some mailing lists have restricted posting privileges, with a parallel list devoted to discussions. Examples are `patches\' or `checkin\' lists, where software changes are posted by a revision control system, but discussion about the changes occurs on a developers mailing list. To support these types of mailing lists, select Explicit Reply and set the Reply-To: address option to point to the parallel list. ')) + reply_to_address = forms.CharField( + label=_('Explicit reply-to address'), required=False, - help_text=_('This option allows admins to set an explicit Reply-to address. It is only used if the reply-to is set to use an explicitly set header'), + help_text=_( + 'This option allows admins to set an explicit Reply-to address. It is only used if the reply-to is set to use an explicitly set header'), ) # informational, not editable - #request_address = forms.EmailField( + # request_address = forms.EmailField( # label=_('Request address'), # required=False) send_welcome_message = forms.TypedChoiceField( @@ -404,8 +418,9 @@ label=_('Send welcome message'), help_text=('Send welcome message to newly subscribed members?Turn this off only if you plan on subscribing people manually and don\'t want them to know that you did so. This option is most useful for transparently migrating lists from some other mailing list manager to Mailman.')) welcome_message_uri = forms.CharField( - label = _('URI for the welcome message'), - help_text = _('If a welcome message is to be sent to subscribers, you can specify a URI that gives the text of this message.'), + label=_('URI for the welcome message'), + help_text=_( + 'If a welcome message is to be sent to subscribers, you can specify a URI that gives the text of this message.'), ) # tko - look this up # scheme = forms.CharField( @@ -415,7 +430,7 @@ widget=forms.Textarea(), label=_("Acceptable aliases"), required=False, - help_text=('Alias names which qualify as explicit to or cc destination names for this list.Alternate addresses that are acceptable when `require_explicit_destination\' is enabled. This option takes a list of regular expressions, one per line, which is matched against every recipient address in the message. The matching is performed with Python\'s re.match() function, meaning they are anchored to the start of the string.')) + help_text=('Alias names which qualify as explicit to or cc destination names for this list.Alternate addresses that are acceptable when `require_explicit_destination\' is enabled. This option takes a list of regular expressions, one per line, which is matched against every recipient address in the message. The matching is performed with Python\'s re.match() function, meaning they are anchored to the start of the string.')) admin_immed_notify = forms.BooleanField( widget=forms.RadioSelect(choices=choices), required=False, @@ -430,37 +445,36 @@ widget=forms.RadioSelect(choices=choices), required=False, label=_('Administrivia'), - help_text=('Administrivia tests will check postings to see whether it\'s really meant as an administrative request (like subscribe, unsubscribe, etc), and will add it to the the administrative requests queue, notifying the administrator of the new request, in the process.')) + help_text=('Administrivia tests will check postings to see whether it\'s really meant as an administrative request (like subscribe, unsubscribe, etc), and will add it to the the administrative requests queue, notifying the administrator of the new request, in the process.')) anonymous_list = forms.TypedChoiceField( coerce=lambda x: x == 'True', choices=((True, _('Yes')), (False, _('No'))), widget=forms.RadioSelect, required=False, label=_('Anonymous list'), - help_text=('Hide the sender of a message, replacing it with the list address (Removes From, Sender and Reply-To fields)')) + help_text=('Hide the sender of a message, replacing it with the list address (Removes From, Sender and Reply-To fields)')) # Informational field, not needed. - #created_at = forms.IntegerField( + # created_at = forms.IntegerField( # label=_('Created at'), # widget=forms.HiddenInput(), # required=False) - #join_address = forms.EmailField( + # join_address = forms.EmailField( # label=_('Join address'), # required=False) - #last_post_at = forms.IntegerField( + # last_post_at = forms.IntegerField( # label=_('Last post at'), # required=False) - #leave_address = forms.EmailField( + # leave_address = forms.EmailField( # label=_('Leave address'), # required=False) - #owner_address = forms.EmailField( + # owner_address = forms.EmailField( # label=_('Owner Address'), # required=False) - #posting_address = forms.EmailField( + # posting_address = forms.EmailField( # label=_('Posting Address'), # required=False) - - #Descriptions used in the Settings Overview Page + # Descriptions used in the Settings Overview Page section_descriptions = { "List Identity": _("Basic identity settings for the list"), "Automatic Responses": _("All options for Autoreply"), @@ -476,7 +490,7 @@ def __init__(self, visible_section, visible_option, *args, **kwargs): super(ListSettings, self).__init__(*args, **kwargs) # if settings: - # raise Exception(settings) # debug + # raise Exception(settings) # debug if visible_option: options = [] for option in self.layout: @@ -513,6 +527,7 @@ del self.fields[key] class Meta: + """Class to handle the automatic insertion of fieldsets and divs. To use it: add a list for each wished fieldset. The first item in @@ -522,31 +537,32 @@ # just a really temporary layout to see that it works. -- Anna layout = [ ["List Identity", "display_name", "mail_host", "description", - "advertised", "subject_prefix"], + "advertised", "subject_prefix"], ["Automatic Responses", "autorespond_owner", "autoresponse_owner_text", "autorespond_postings", "autoresponse_postings_text", "autorespond_requests", "autoresponse_request_text", "autoresponse_grace_period", - "send_welcome_message", + "send_welcome_message", "welcome_message_uri", "admin_immed_notify", "admin_notify_mchanges"], ["Alter Messages", "filter_content", "collapse_alternatives", "convert_html_to_plaintext", "anonymous_list", - "include_rfc2369_headers", + "include_rfc2369_headers", "allow_list_posts", "reply_goes_to_list", - "reply_to_address", - "first_strip_reply_to", - "posting_pipeline"], + "reply_to_address", + "first_strip_reply_to", + "posting_pipeline"], ["Digest", "digest_size_threshold"], ["Message Acceptance", "acceptable_aliases", "administrivia", "default_nonmember_action", "default_member_action"], ["Archives", "archive_policy"], - ] + ] class Login(FieldsetForm): + """Form fields to let the user log in. """ user = forms.EmailField( @@ -562,6 +578,7 @@ required=True) class Meta: + """ Class to define the name of the fieldsets and what should be included in each. @@ -570,6 +587,7 @@ class ListMassSubscription(FieldsetForm): + """Form fields to masssubscribe users to a list. """ emails = forms.CharField( @@ -580,6 +598,7 @@ verify_with_email = forms.BooleanField(required=False) class Meta: + """ Class to define the name of the fieldsets and what should be included in each. @@ -587,56 +606,65 @@ layout = [["Mass subscription", "emails"]] -class MembershipSettings(FieldsetForm): - """Form handling the membership settings. +class UserPreferences(FieldsetForm): + + """ + Form handling the user's global, address and subscription based preferences. """ choices = ((True, _('Yes')), (False, _('No'))) - acknowledge_posts = forms.BooleanField( - widget=forms.RadioSelect(choices=choices), + + delivery_mode_choices = (("regular", _('Regular')), + ("plaintext_digests", _('Plain Text Digests')), + ("mime_digests", _('Mime Digests')), + ("summary_digests", _('Summary Digests'))) + delivery_status_choices = ( + ("enabled", _('Enabled')), ("by_user", _('Disabled'))) + delivery_status = forms.ChoiceField( + widget=forms.RadioSelect, + choices=delivery_status_choices, required=False, - label=_('Acknowledge posts')) - hide_address = forms.BooleanField( - widget=forms.RadioSelect(choices=choices), + label=_('Delivery status'), + help_text=_('Set this option to Enabled to receive messages posted to this mailing list. Set it to Disabled if you want to stay subscribed, but don\'t want mail delivered to you for a while (e.g. you\'re going on vacation). If you disable mail delivery, don\'t forget to re-enable it when you come back; it will not be automatically re-enabled.')) + delivery_mode = forms.ChoiceField( + widget=forms.Select(), + choices=delivery_mode_choices, required=False, - label=_('Hide address')) - receive_list_copy = forms.BooleanField( - widget=forms.RadioSelect(choices=choices), - required=False, - label=_('Receive list copy')) + label=_('Delivery mode'), + help_text=_('If you select summary digests , you\'ll get posts bundled together (usually one per day but possibly more on busy lists), instead of singly when they\'re sent. Your mail reader may or may not support MIME digests. In general MIME digests are preferred, but if you have a problem reading them, select plain text digests.')) receive_own_postings = forms.BooleanField( widget=forms.RadioSelect(choices=choices), required=False, - label=_('Receive own postings')) - delivery_mode = forms.ChoiceField( - widget=forms.Select(), - error_messages={ - 'required': _("Please choose a mode.")}, + label=_('Receive own postings'), + help_text=_('Ordinarily, you will get a copy of every message you post to the list. If you don\'t want to receive this copy, set this option to No')) + acknowledge_posts = forms.BooleanField( + widget=forms.RadioSelect(choices=choices), required=False, - choices=( - ("", _("Please choose")), - ("delivery_mode", "some mode...")), - label=_('Delivery mode')) - delivery_status = forms.ChoiceField( - widget=forms.Select(), - error_messages={ - 'required': _("Please choose a status.")}, + label=_('Acknowledge posts'), + help_text=_('Receive acknowledgement mail when you send mail to the list?')) + hide_address = forms.BooleanField( + widget=forms.RadioSelect(choices=choices), required=False, - choices=( - ("", _("Please choose")), - ("delivery_status", "some status...")), - label=_('Delivery status')) + label=_('Hide address'), + help_text=_('When someone views the list membership, your email address is normally shown (in an obscured fashion to thwart spam harvesters). If you do not want your email address to show up on this membership roster at all, select Yes for this option.')) + receive_list_copy = forms.BooleanField( + widget=forms.RadioSelect(choices=choices), + required=False, + label=_('Receive list copy'), + help_text=_('When you are listed explicitly in the To: or Cc: headers of a list message, you can opt to not receive another copy from the mailing list. Select Yes to avoid receiving copies from the mailing list; select No to receive copies. ')) class Meta: + """ Class to define the name of the fieldsets and what should be included in each. """ - layout = [["Membership Settings", "acknowledge_posts", "hide_address", + layout = [["User Preferences", "acknowledge_posts", "hide_address", "receive_list_copy", "receive_own_postings", "delivery_mode", "delivery_status"]] class UserNew(FieldsetForm): + """ Form field to add a new user """ @@ -662,7 +690,7 @@ widget=forms.PasswordInput(render_value=False)) def clean(self): - cleaned_data = self.cleaned_data + cleaned_data = self.cleaned_data password = cleaned_data.get("password") password_repeat = cleaned_data.get("password_repeat") if password != password_repeat: @@ -672,8 +700,10 @@ class UserSettings(FieldsetForm): + """Form handling the user settings. """ + def __init__(self, address_choices, *args, **kwargs): """ Initialize the user settings with a field 'address' where @@ -724,6 +754,7 @@ 'invalid': _('Please enter a valid password.')}) class Meta: + """ Class to define the name of the fieldsets and what should be included in each. diff --git a/src/postorius/templates/postorius/user_address_preferences.html b/src/postorius/templates/postorius/user_address_preferences.html new file mode 100644 index 0000000..e8092df --- /dev/null +++ b/src/postorius/templates/postorius/user_address_preferences.html @@ -0,0 +1,128 @@ +{% extends postorius_base_template %} +{% load url from future %} +{% load i18n %} +{% block main %} +{% include 'postorius/menu/user_nav.html' %} + +
+

Per-Email-Address Based Preferences Overview

+

Table to view the preferences(for testing only)

+ + + + + + + + + + + + + + {%for a in addresses%} + + + + + + + + + + {%endfor%} + +
{% trans 'Email Address' %}{% trans 'Delivery Status' %}{% trans 'Delivery Mode' %}{% trans 'Receive Own Postings' %}{% trans 'Acknowledge Posts' %}{% trans 'Hide Address' %}{% trans 'Receive List Copy' %}
{{ a }}{{ a.preferences.delivery_status }}{{ a.preferences.delivery_mode }}{{ a.preferences.receive_own_postings }}{{ a.preferences.acknowledge_posts }}{{ a.preferences.hide_address }}{{ a.preferences.receive_list_copy }}
+
+

Address Based Preferences Form

+ +
+ {% csrf_token %} + {{formset.management_form}} + {{formset.non_form_errors.as_ul}} + + + + + {% for form,address in zipped_data %} + + {% endfor %} + + + + + {% for form,address in zipped_data %} + + {% endfor %} + + + + {% for form,address in zipped_data %} + + {% endfor %} + + + + {% for form,address in zipped_data %} + + {% endfor %} + + + + {% for form,address in zipped_data %} + + {% endfor %} + + + + {% for form,address in zipped_data %} + + {% endfor %} + + + + {% for form,address in zipped_data %} + + {% endfor %} + +
Preferences {{address}}
+

Mail Delivery:

+

[More info{{ helperform.delivery_status.help_text }} + ] +

+ 		{{form.delivery_status }}
+

Select a Mode of Delivery:

+

[More info{{ helperform.delivery_mode.help_text }} + ] +

+ 		{{form.delivery_mode }}
+

Receive your own posts to the list?

+

[More info{{ helperform.receive_own_postings.help_text }} + ] +

+ 		{{form.receive_own_postings }}
+

Receive acknowledgement mails?

+

[More info{{ helperform.acknowledge_posts.help_text }} + ] +

+ 		{{form.acknowledge_posts }}
+

Conceal yourself from the subscriber list?

+

[More info{{ helperform.hide_address.help_text }} + ] +

+ 		{{form.hide_address }}
+

Avoid duplicate copies of messages?

+

[More info{{ helperform.receive_list_copy.help_text }} + ] +

+ 		{{form.receive_list_copy }}
+
+
+{% endblock main %} + + diff --git a/src/postorius/templates/postorius/user_mailmansettings.html b/src/postorius/templates/postorius/user_mailmansettings.html index 273292b..22a791b 100644 --- a/src/postorius/templates/postorius/user_mailmansettings.html +++ b/src/postorius/templates/postorius/user_mailmansettings.html @@ -1,101 +1,115 @@ {% extends postorius_base_template %} {% load url from future %} {% load i18n %} - {% block main %} - {% include 'postorius/menu/user_nav.html' %} - {% if nolists %} -
-

{% trans "No Preferences Available" %}

-
-

{% trans 'You are not yet subscribed to any lists, so have no Mailman preferences.' %}

- {% else %} - -
-

{% trans "Subscription Settings" %} - {{ user }}

-
- -

Mailman display name: {{ mm_user.display_name}}

-

Django email: {{ user.email }}

-

Mailman primary email: {{ mm_user.email }}

-

Valid email addresses for this account:

- - -

WARNING: This page is currently a mockup and -anything below this line may not work

- -

Preferences:

-

preferences: {{ mm_user.preferences }} -

user: {{ mm_user }} -

tko -

memberships: {{ membership_lists }} - {% for pref in mm_user.preferences %} -

  • {{ pref }}
    • - {% endfor %} - -

    Sample output: not real

    - - -

    Prefs form

    -
    {% csrf_token %} - {{ settingsform.as_p }} - -
    - -

    List Preferences Overview

    -

    Sample output: not real

    - -
    {% csrf_token %} - - - - - - - - - - - - - - - - - - {% for preference in mm_user.preferences %} - {% endfor %} - - - - - - - - - - - -
    {% trans "Setting" %}{% trans "Description" %}{% trans "Set all" %}list1@example.comkumquat@example.comstarfruit@example.com
    {% trans "Mail delivery" %} ({{ preference }})Set this option to Enabled to receive -messages posted - to this mailing list. Set it to Disabled if you want - to stay subscribed, but don't want mail delivered to you for a - while (e.g. you're going on vacation). If you disable mail - delivery, don't forget to re-enable it when you come back; it - will not be automatically re-enabled."
    {% trans "Per-Email subscriptions" %}
    anna@example.com
    -
    - {% endif %} +{% include 'postorius/menu/user_nav.html' %} + +
    +

    Global Preferences Overview

    +

    Table to view the preferences(for testing only)

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    {% trans 'Preference' %} {% trans 'Value' %}
    {% trans 'Delivery Status' %}{{ mm_user.preferences.delivery_status }}
    {% trans 'Delivery Mode' %}{{ mm_user.preferences.delivery_mode }}
    {% trans 'Receive Own Postings' %}{{ mm_user.preferences.receive_own_postings }}
    {% trans 'Acknowledge Posts' %}{{ mm_user.preferences.acknowledge_posts }}
    {% trans 'Hide Address' %}{{ mm_user.preferences.hide_address }}
    {% trans 'Receive List Copy' %}{{ mm_user.preferences.receive_list_copy }}
    +
    +

    Global Preferences Form

    + +
    + {% csrf_token %} + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Preferences Global
    +

    Mail Delivery:

    +

    + [More info{{ settingsform.delivery_status.help_text }} + ]

    +     		{{settingsform.delivery_status }}
    +

    Select a Mode of Delivery:

    +

    + [More info{{ settingsform.delivery_mode.help_text }} + ]

    +     		{{settingsform.delivery_mode }}
    +

    Receive your own posts to the list?

    +

    + [More info{{ settingsform.receive_own_postings.help_text }} + ]

    +     		{{settingsform.receive_own_postings }}
    +

    Receive acknowledgement mails?

    +

    + [More info{{ settingsform.acknowledge_posts.help_text }} + ]

    +     		{{settingsform.acknowledge_posts }}
    +

    Conceal yourself from the subscriber list?

    +

    + [More info{{ settingsform.hide_address.help_text }} + ]

    +     		{{settingsform.hide_address }}
    +

    Avoid duplicate copies of messages?

    +

    [More info{{ settingsform.receive_list_copy.help_text }} + ]

    +     		{{settingsform.receive_list_copy }}
    +
    +
    {% endblock main %} -~ diff --git a/src/postorius/templates/postorius/user_subscription_preferences.html b/src/postorius/templates/postorius/user_subscription_preferences.html new file mode 100644 index 0000000..541ac0f --- /dev/null +++ b/src/postorius/templates/postorius/user_subscription_preferences.html @@ -0,0 +1,84 @@ +{% extends postorius_base_template %} +{% load url from future %} +{% load i18n %} +{% block main %} +{% include 'postorius/menu/user_nav.html' %} +{% if nolists %} +
    +

    { % trans "No Preferences Available" % }

    +
    +

    { % trans 'You are not yet subscribed to any lists, so you have no Mailman preferences.' % }

    +{% else %} + +
    +

    Per-Subscription Based Preferences Overview

    +

    Table to view the preferences(for testing only)

    + + + + + + + + + + + + + {%for s in subscriptions%} + + + + + + + + + + {%endfor%} + +
    {% trans 'Subscription' %}{% trans 'Acknowledge Posts' %}{% trans 'Hide Address' %}{% trans 'Receive List Copy' %}{% trans 'Receive Own Postings' %}{% trans 'Delivery Mode' %}{% trans 'Delivery Status' %}
    {{ s }}{{ s.preferences.acknowledge_posts }}{{ s.preferences.hide_address }}{{ s.preferences.receive_list_copy }}{{ s.preferences.receive_own_postings }}{{ s.preferences.delivery_mode }}{{ s.preferences.delivery_status }}
    +
    +

    Subscription Based Preferences Form

    +
    + +
    + {% csrf_token %} + {{formset.management_form}} + {{formset.non_form_errors.as_ul}} + + {% for form,subscription in zipped_data %} + {% if forloop.first %} + + + + {% for field in form.visible_fields %} + + {% endfor %} + + + {% endif %} + {% endfor %} + + {% for form,subscription in zipped_data %} + + + + + + + + + {% endfor %} +
    Subscription {{field.label}}

    [More info{{ field.help_text }} + ]

    {{subscription.list_id}} {{form.delivery_status}} {{form.delivery_mode}} {{form.receive_own_postings}} {{form.acknowledge_posts}} {{form.hide_address}} {{form.receive_list_copy}}
    +
    +
    + +{% endif %} +{% endblock main %} diff --git a/src/postorius/templates/postorius/user_subscriptions.html b/src/postorius/templates/postorius/user_subscriptions.html index 5a52e74..6b4d8aa 100644 --- a/src/postorius/templates/postorius/user_subscriptions.html +++ b/src/postorius/templates/postorius/user_subscriptions.html @@ -20,10 +20,10 @@ {% for subscription in memberships %} - {{ subscription.fqdn_listname }} + {{ subscription.mlist }} {{ subscription.address }} {{ subscription.role }} - {{ subscription.delivery_mode }} + {{ subscription.preferences.delivery_mode }} {% endfor %} diff --git a/src/postorius/urls.py b/src/postorius/urls.py index 6ddeb61..8c147d9 100644 --- a/src/postorius/urls.py +++ b/src/postorius/urls.py @@ -25,38 +25,45 @@ per_list_urlpatterns = patterns('postorius.views', - url(r'^members/(?P\d+)/$', - ListMembersView.as_view(), name='list_members_paged'), - url(r'^members/$', - ListMembersView.as_view(), name='list_members'), - url(r'^metrics$', - ListMetricsView.as_view(), name='list_metrics'), - url(r'^$', - ListSummaryView.as_view(), name='list_summary'), - url(r'^subscribe$', - ListSubsribeView.as_view(), name='list_subscribe'), - url(r'^unsubscribe/(?P[^/]+)$', - ListUnsubscribeView.as_view(), name='list_unsubscribe'), - url(r'^subscriptions$', - 'list_subscriptions', name='list_subscriptions'), - url(r'^mass_subscribe/$', - ListMassSubsribeView.as_view(), name='mass_subscribe'), - url(r'^delete$', - 'list_delete', name='list_delete'), - url(r'^held_messages/(?P[^/]+)/' - 'accept$', 'accept_held_message', name='accept_held_message'), - url(r'^held_messages/(?P[^/]+)/' - 'discard$', 'discard_held_message', name='discard_held_message'), - url(r'^held_messages/(?P[^/]+)/' - 'defer$', 'defer_held_message', name='defer_held_message'), - url(r'^held_messages/(?P[^/]+)/' - 'reject$', 'reject_held_message', name='reject_held_message'), - url(r'^held_messages$', - 'list_held_messages', name='list_held_messages'), - url(r'^settings/(?P[^/]+)?' - '(?:/(?P.*))?$', 'list_settings', - name='list_settings'), -) + url(r'^members/(?P\d+)/$', + ListMembersView.as_view( + ), name='list_members_paged'), + url(r'^members/$', + ListMembersView.as_view( + ), name='list_members'), + url(r'^metrics$', + ListMetricsView.as_view( + ), name='list_metrics'), + url(r'^$', + ListSummaryView.as_view( + ), name='list_summary'), + url(r'^subscribe$', + ListSubsribeView.as_view( + ), name='list_subscribe'), + url(r'^unsubscribe/(?P[^/]+)$', + ListUnsubscribeView.as_view( + ), name='list_unsubscribe'), + url(r'^subscriptions$', + 'list_subscriptions', name='list_subscriptions'), + url(r'^mass_subscribe/$', + ListMassSubsribeView.as_view( + ), name='mass_subscribe'), + url(r'^delete$', + 'list_delete', name='list_delete'), + url(r'^held_messages/(?P[^/]+)/' + 'accept$', 'accept_held_message', name='accept_held_message'), + url(r'^held_messages/(?P[^/]+)/' + 'discard$', 'discard_held_message', name='discard_held_message'), + url(r'^held_messages/(?P[^/]+)/' + 'defer$', 'defer_held_message', name='defer_held_message'), + url(r'^held_messages/(?P[^/]+)/' + 'reject$', 'reject_held_message', name='reject_held_message'), + url(r'^held_messages$', + 'list_held_messages', name='list_held_messages'), + url(r'^settings/(?P[^/]+)?' + '(?:/(?P.*))?$', 'list_settings', + name='list_settings'), + ) urlpatterns = patterns( 'postorius.views', @@ -68,6 +75,11 @@ url(r'^tasks/$', 'user_tasks', name='user_tasks'), url(r'^accounts/subscriptions/$', UserSubscriptionsView.as_view(), name='user_subscriptions'), + url(r'^accounts/per-address-preferences/$', + UserAddressPreferencesView.as_view(), name='user_address_preferences'), + url(r'^accounts/per-subscription-preferences/$', + UserSubscriptionPreferencesView.as_view( + ), name='user_subscription_preferences'), url(r'^accounts/mailmansettings/$', UserMailmanSettingsView.as_view(), name='user_mailmansettings'), @@ -80,8 +92,9 @@ # /lists/ url(r'^lists/$', 'list_index', name='list_index'), url(r'^lists/new/$', 'list_new', name='list_new'), - url(r'^more_info/(?P[^/]+)/(?P[^/]+)$', 'more_info_tab', name='more_info_tab'), - url(r'^lists/(?P[^/]+)/', include(per_list_urlpatterns)), + url(r'^more_info/(?P[^/]+)/(?P[^/]+)$', + 'more_info_tab', name='more_info_tab'), + url(r'^lists/(?P[^/]+)/', include(per_list_urlpatterns)), # /users/ url(r'^users/(?P\d+)/$', 'user_index', name='user_index_paged'), url(r'^users/$', 'user_index', name='user_index'), diff --git a/src/postorius/views/generic.py b/src/postorius/views/generic.py index 382b8b9..d85e6a9 100644 --- a/src/postorius/views/generic.py +++ b/src/postorius/views/generic.py @@ -29,15 +29,16 @@ class MailmanClientMixin(object): + """Adds a mailmanclient.Client instance.""" - + def client(self): if getattr(self, '_client', None) is None: self._client = utils.get_client() return self._client - class MailingListView(TemplateView, MailmanClientMixin): + """A generic view for everything based on a mailman.client list object. @@ -80,6 +81,7 @@ class MailmanUserView(TemplateView, MailmanClientMixin): + """A generic view for everything based on a mailman.client user object. @@ -101,7 +103,7 @@ user_obj.display_name = '' user_obj.first_address = self._get_first_address(user_obj) return user_obj - + def _get_list(self, list_id): if getattr(self, 'lists', None) is None: self.lists = {} @@ -112,19 +114,14 @@ def _get_memberships(self): memberships = [] if (self.mm_user): - for a in self.mm_user.addresses: - members = self.client()._connection.call('members/find', - {'subscriber': a}) - try: - for m in members[1]['entries']: - mlist = self._get_list(m['list_id']) - memberships.append( - dict(fqdn_listname=mlist.fqdn_listname, - role=m['role'], - delivery_mode=m['delivery_mode'], - address=a)) - except KeyError: - pass + for m in self.mm_user.subscriptions: + mlist = m.list_id + memberships.append( + dict( + mlist=mlist, + role=m.role, + preferences=m.preferences, + address=m.address)) return memberships def dispatch(self, request, *args, **kwargs): @@ -139,7 +136,7 @@ self.mm_user = self._get_user(user_id) except MailmanApiError: return utils.render_api_error(request) - + # set the template if 'template' in kwargs: self.template = kwargs['template'] diff --git a/src/postorius/views/list.py b/src/postorius/views/list.py index 4fe135f..3aba770 100644 --- a/src/postorius/views/list.py +++ b/src/postorius/views/list.py @@ -36,6 +36,7 @@ class ListMembersView(MailingListView): + """Display all members of a given list. """ @@ -94,6 +95,7 @@ class ListMetricsView(MailingListView): + """Shows common list metrics. """ @@ -105,6 +107,7 @@ class ListSummaryView(MailingListView): + """Shows common list metrics. """ @@ -118,6 +121,7 @@ class ListSubsribeView(MailingListView): + """Subscribe a mailing list.""" @method_decorator(login_required) @@ -141,6 +145,7 @@ class ListUnsubscribeView(MailingListView): + """Unsubscribe from a mailing list.""" @method_decorator(login_required) @@ -159,6 +164,7 @@ class ListMassSubsribeView(MailingListView): + """Mass subscription.""" @method_decorator(list_owner_required) @@ -193,6 +199,7 @@ messages.error(request, e) return redirect('mass_subscribe', self.mailing_list.fqdn_listname) + def _get_choosable_domains(request): try: domains = Domain.objects.all() @@ -204,6 +211,7 @@ domain.mail_host)) return choosable_domains + @login_required @user_passes_test(lambda u: u.is_superuser) def list_new(request, template='postorius/lists/new.html'): @@ -221,10 +229,10 @@ choosable_domains = _get_choosable_domains(request) form = ListNew(choosable_domains, request.POST) if form.is_valid(): - #grab domain + # grab domain domain = Domain.objects.get_or_404( mail_host=form.cleaned_data['mail_host']) - #creating the list + # creating the list try: mailing_list = domain.create_list( form.cleaned_data['listname']) @@ -237,7 +245,7 @@ messages.success(request, _("List created")) return redirect("list_summary", fqdn_listname=mailing_list.fqdn_listname) - #TODO catch correct Error class: + # TODO catch correct Error class: except HTTPError, e: return render_to_response( 'postorius/errors/generic.html', @@ -496,7 +504,7 @@ the_list = List.objects.get_or_404(fqdn_listname=fqdn_listname) except MailmanApiError: return utils.render_api_error(request) - #collect all Form sections for the links: + # collect all Form sections for the links: temp = ListSettings('', '') for section in temp.layout: try: @@ -516,12 +524,13 @@ list_settings.save() message = _("The list settings have been updated.") else: - message = _("Validation Error - The list settings have not been updated.") + message = _( + "Validation Error - The list settings have not been updated.") else: - #Provide a form with existing values - #create form and process layout into form.layout + # Provide a form with existing values + # create form and process layout into form.layout form = ListSettings(visible_section, visible_option, data=None) - #create a Dict of all settings which are used in the form + # create a Dict of all settings which are used in the form used_settings = {} for section in form.layout: for option in section[1:]: diff --git a/src/postorius/views/settings.py b/src/postorius/views/settings.py index 305a739..ded9730 100644 --- a/src/postorius/views/settings.py +++ b/src/postorius/views/settings.py @@ -90,6 +90,7 @@ {'form': form, 'message': message}, context_instance=RequestContext(request)) + def domain_delete(request, domain): """Deletes a domain but asks for confirmation first. """ diff --git a/src/postorius/views/user.py b/src/postorius/views/user.py index a5acb5c..05267fd 100644 --- a/src/postorius/views/user.py +++ b/src/postorius/views/user.py @@ -24,6 +24,7 @@ from django.conf import settings +from django.forms.formsets import formset_factory from django.contrib import messages from django.contrib.auth import logout, authenticate, login from django.contrib.auth.decorators import (login_required, @@ -49,34 +50,153 @@ class UserMailmanSettingsView(MailmanUserView): - """The logged-in user's Mailman Preferences.""" + + """The logged-in user's global Mailman Preferences.""" @method_decorator(login_required) def post(self, request): - raise NotImplementedError + try: + mm_user = MailmanUser.objects.get(address=request.user.email) + global_preferences_form = UserPreferences(request.POST) + if global_preferences_form.is_valid(): + preferences = mm_user.preferences + for key in global_preferences_form.fields.keys(): + preferences[ + key] = global_preferences_form.cleaned_data[key] + preferences.save() + messages.success( + request, 'Your preferences have been updated.') + else: + messages.error(request, 'Something went wrong.') + except MailmanApiError: + return utils.render_api_error(request) + except HTTPError, e: + messages.error(request, e.msg) + return redirect("user_mailmansettings") @method_decorator(login_required) def get(self, request): try: mm_user = MailmanUser.objects.get(address=request.user.email) + settingsform = UserPreferences(initial=mm_user.preferences) except MailmanApiError: return utils.render_api_error(request) - except Mailman404Error: - # If the user cannot be found (because there are no - # memberships yet for the logged-in # user), return a - # settings page with a short message only. - return render_to_response( - 'postorius/user_mailmansettings.html', - {'nolists': 'true'}, - context_instance=RequestContext(request)) - settingsform = MembershipSettings() return render_to_response('postorius/user_mailmansettings.html', {'mm_user': mm_user, 'settingsform': settingsform}, context_instance=RequestContext(request)) +class UserAddressPreferencesView(MailmanUserView): + + """The logged-in user's address-based Mailman Preferences.""" + + @method_decorator(login_required) + def post(self, request): + try: + mm_user = MailmanUser.objects.get(address=request.user.email) + formset_class = formset_factory(UserPreferences) + formset = formset_class(request.POST) + zipped_data = zip(formset.forms, mm_user.addresses) + if formset.is_valid(): + for form, address in zipped_data: + preferences = address.preferences + for key in form.fields.keys(): + preferences[ + key] = form.cleaned_data[key] + preferences.save() + messages.success( + request, 'Your preferences have been updated.') + else: + messages.error(request, 'Something went wrong.') + except MailmanApiError: + return utils.render_api_error(request) + except HTTPError, e: + messages.error(request, e.msg) + return redirect("user_address_preferences") + + @method_decorator(login_required) + def get(self, request): + try: + helperform=UserPreferences() + mm_user = MailmanUser.objects.get(address=request.user.email) + addresses = mm_user.addresses + i = 0 + for address in addresses: + i = i + 1 + AFormset = formset_factory(UserPreferences, extra=i) + formset = AFormset() + zipped_data = zip(formset.forms, addresses) + for form, address in zipped_data: + form.initial = address.preferences + except MailmanApiError: + return utils.render_api_error(request) + return render_to_response('postorius/user_address_preferences.html', + {'mm_user': mm_user, + 'addresses': addresses, + 'helperform':helperform, + 'formset': formset, + 'zipped_data': zipped_data}, + context_instance=RequestContext(request)) + + +class UserSubscriptionPreferencesView(MailmanUserView): + + """The logged-in user's subscription-based Mailman Preferences.""" + + @method_decorator(login_required) + def post(self, request): + try: + mm_user = MailmanUser.objects.get(address=request.user.email) + formset_class = formset_factory(UserPreferences) + formset = formset_class(request.POST) + zipped_data = zip(formset.forms, mm_user.subscriptions) + if formset.is_valid(): + for form, subscription in zipped_data: + preferences = subscription.preferences + for key in form.fields.keys(): + preferences[key] = form.cleaned_data[key] + preferences.save() + messages.success( + request, 'Your preferences have been updated.') + else: + messages.error(request, 'Something went wrong.') + except MailmanApiError: + return utils.render_api_error(request) + except HTTPError, e: + messages.error(request, e.msg) + return redirect("user_subscription_preferences") + + @method_decorator(login_required) + def get(self, request): + try: + mm_user = MailmanUser.objects.get(address=request.user.email) + subscriptions = mm_user.subscriptions + i = len(subscriptions) + Mformset = formset_factory(UserPreferences, extra=i) + formset = Mformset() + zipped_data = zip(formset.forms, subscriptions) + for form, subscription in zipped_data: + form.initial = subscription.preferences + except MailmanApiError: + return utils.render_api_error(request) + except Mailman404Error: + return render_to_response( + 'postorius/user_subscription_preferences.html', + {'nolists': 'true'}, + context_instance=RequestContext(request)) + + return render_to_response( + 'postorius/user_subscription_preferences.html', + {'mm_user': mm_user, + 'subscriptions': subscriptions, + 'zipped_data': zipped_data, + 'formset': formset}, + context_instance=RequestContext(request)) + + class UserSummaryView(MailmanUserView): + """Shows a summary of a user. """ @@ -92,6 +212,7 @@ class UserSubscriptionsView(MailmanUserView): + """Shows the subscriptions of a user. """ @@ -172,9 +293,9 @@ def user_profile(request, user_email=None): if not request.user.is_authenticated(): return redirect('user_login') - #try: + # try: # the_user = User.objects.get(email=user_email) - #except MailmanApiError: + # except MailmanApiError: # return utils.render_api_error(request) return render_to_response('postorius/user_profile.html', # {'mm_user': the_user}, @@ -186,21 +307,23 @@ return render_to_response('postorius/user_tasks.html', context_instance=RequestContext(request)) + @login_required def more_info_tab(request, formid=None, helpid=None, template='postorius/more_info_display.html'): """Displays more_info in new tab. """ - + if(formid == 'list_settings'): - form = ListSettings(visible_section='List Identity', visible_option='None', data=request.POST) - + form = ListSettings( + visible_section='List Identity', visible_option='None', data=request.POST) + for field in form: if field.name == helpid: help_text = field.help_text - + return render_to_response(template, - {'help_text':help_text, - 'helpid':helpid}, + {'help_text': help_text, + 'helpid': helpid}, context_instance=RequestContext(request))