diff --git a/src/postorius/forms.py b/src/postorius/forms.py index da68656..56c4bde 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. @@ -588,12 +607,18 @@ class UserPreferences(FieldsetForm): - """Form handling the user's global preferences. + + """ + Form handling the user's global preferences. """ choices = ((True, _('Yes')), (False, _('No'))) - - 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_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'))) acknowledge_posts = forms.BooleanField( widget=forms.RadioSelect(choices=choices), required=False, @@ -611,17 +636,18 @@ required=False, label=_('Receive own postings')) delivery_mode = forms.ChoiceField( - widget = forms.Select(), - choices = delivery_mode_choices, - required = False, - label = _('Delivery mode')) - delivery_status = forms.ChoiceField( - widget = forms.Select(), + widget=forms.Select(), + choices=delivery_mode_choices, required=False, - choices= delivery_status_choices, + label=_('Delivery mode')) + delivery_status = forms.ChoiceField( + widget=forms.Select(), + required=False, + choices=delivery_status_choices, label=_('Delivery status')) class Meta: + """ Class to define the name of the fieldsets and what should be included in each. @@ -630,7 +656,9 @@ "receive_list_copy", "receive_own_postings", "delivery_mode", "delivery_status"]] + class UserNew(FieldsetForm): + """ Form field to add a new user """ @@ -656,7 +684,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: @@ -666,8 +694,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 @@ -718,6 +748,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..0075c77 --- /dev/null +++ b/src/postorius/templates/postorius/user_address_preferences.html @@ -0,0 +1,96 @@ +{% extends postorius_base_template %} +{% load url from future %} +{% load i18n %} + +{% block main %} + {% include 'postorius/menu/user_nav.html' %} +
+ +{% trans 'Email Address' %} | +{% trans 'Acknowledge Posts' %} | +{% trans 'Hide Address' %} | +{% trans 'Receive List Copy' %} | +{% trans 'Receive Own Postings' %} | +{% trans 'Delivery Mode' %} | +{% trans 'Delivery Status' %} | +
---|---|---|---|---|---|---|
{{ a }} | +{{ a.preferences.acknowledge_posts }} | +{{ a.preferences.hide_address }} | +{{ a.preferences.receive_list_copy }} | +{{ a.preferences.receive_own_postings }} | +{{ a.preferences.delivery_mode }} | +{{ a.preferences.delivery_status }} | +
{% trans 'You are not yet subscribed to any lists, so have no Mailman preferences.' %}
- {% else %} -{% trans 'Preference' %} | +{% trans 'Value' %} | +
---|---|
{% trans 'Receive List Copy' %} | {{ mm_user.preferences.receive_list_copy }} |
{ % trans 'You are not yet subscribed to any lists, so you have no Mailman preferences.' % }
+ {% else %} + + +{% 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 }} | +