Merge lp:~benste/mailmanweb/main_dev into lp:mailmanweb

[benste]

Merge - added Django Messaging Framework - fixes lp920084 - by benste

Dear Terri and Flo,
the long promissed change which got delayed due to my old revisions ...

No CSS for new class mm_message included
+ For some strange reason the message Tag / Type seems not to be stored hence we don't get a special class e.g. for a warningn

[lp:~benste/mailmanweb/main_dev]

35. By benste on 2012-03-14

changed all render error, error and message vars in views.py to new messaging frame

[Florian Fuchs (flo-fuchs)]

Thank you! I had to add the request param to the messages.success call in line 134. Other than that everything's fine. Added to the trunk...

review: Approve

Unmerged revisions

35. By benste on 2012-03-14

changed all render error, error and message vars in views.py to new messaging frame

33. By Terri on 2012-03-14

Made it so that the settings menu doesn't disappear when you change settings.

32. By Terri on 2012-03-14

Assorted fixes to make sure the settings forms will submit correctly. This
should fix the enums and booleans, but does not fix acceptable_aliases (which
needs to submit a set of unicode strings)

31. By Terri on 2012-03-14

Fixes to the settings page, mostly making sure we use the right enums for
things.

30. By Terri on 2012-03-14

Removing settings templates that we've decided not to use

29. By Terri on 2012-03-14

Merged

28. By Terri on 2012-03-14

Regrouping of the list settings pages.

27. By Terri on 2012-03-13

Rearranging settings in a way that hopefully makes sense.

=== modified file 'dev_setup/settings.py'
--- dev_setup/settings.py	2012-03-13 03:58:06 +0000
+++ dev_setup/settings.py	2012-03-14 19:51:23 +0000
@@ -102,6 +102,7 @@
 
 TEMPLATE_CONTEXT_PROCESSORS = (
     "django.contrib.auth.context_processors.auth",
+    "django.contrib.messages.context_processors.messages",
     "django.core.context_processors.debug",
     "django.core.context_processors.i18n",
     "django.core.context_processors.media",
@@ -138,6 +139,7 @@
 
 INSTALLED_APPS = (
     'django.contrib.auth',
+    'django.contrib.messages',
     'django.contrib.contenttypes',
     'django.contrib.sessions',
     'django.contrib.sites',
 
=== modified file 'src/mailmanweb/templates/mailmanweb/base.html'
--- src/mailmanweb/templates/mailmanweb/base.html	2012-03-14 17:43:32 +0000
+++ src/mailmanweb/templates/mailmanweb/base.html	2012-03-14 19:51:23 +0000
@@ -50,6 +50,13 @@
     </header>
 
     <div class="mm_main mm_canvas">
+        {% if messages %}
+            <ul class="mm_messages">
+            {% for message in messages %}
+                <li{% if message.tags %} class="{{ message.tags }}"{% endif %}>{{ message }}</li>
+            {% endfor %}
+            </ul>
+        {% endif %}
         {% block main %}{% endblock main %}
     </div>
     <div id="mm_footer">
 
=== modified file 'src/mailmanweb/views.py'
--- src/mailmanweb/views.py	2012-03-14 17:45:34 +0000
+++ src/mailmanweb/views.py	2012-03-14 19:51:23 +0000
@@ -23,6 +23,7 @@
 
 
 from django.conf import settings
+from django.contrib import messages
 from django.contrib.auth import logout, authenticate, login
 from django.contrib.auth.decorators import login_required, permission_required
 from django.contrib.auth.forms import AuthenticationForm
@@ -53,15 +54,26 @@
     try:
         existing_domains = Domain.objects.all()
         logger.debug(Domain.objects)
+<<<<<<< TREE
     except MailmanApiError:
         return utils.render_api_error(request)
     return render_to_response('mailmanweb/domain_index.html', {'domains':existing_domains,},
+=======
+    except MailmanApiError, e:
+        messages.error(request,e)
+        return render_to_response('mailmanweb/errors/generic.html',context_instance=RequestContext(request))
+    return render_to_response(template, {'domains':existing_domains,},
+>>>>>>> MERGE-SOURCE
 					          context_instance=RequestContext(request))
 
 @login_required
 @permission_required('server_admin')
+<<<<<<< TREE
 def domain_new(request):
     message = None
+=======
+def domain_new(request, template = 'mailmanweb/domain_new.html'):
+>>>>>>> MERGE-SOURCE
     if request.method == 'POST':
         form = DomainNew(request.POST)
         if form.is_valid():
@@ -70,15 +82,23 @@
                             description=form.cleaned_data['description'])
             try:
                 domain.save()
-            except MailmanApiError:
-                return utils.render_api_error(request)
+            except MailmanApiError, e:
+                messages.error(request,e)
+                return render_to_response('mailmanweb/errors/generic.html',context_instance=RequestContext(request))
             except HTTPError, e:
-                message=e
+                messages.error(request,e)
+            else:
+                messages.success(request,_("New Domain registered"))
             return redirect("domain_index")
     else:
         form = DomainNew()
+<<<<<<< TREE
     return render_to_response('mailmanweb/domain_new.html',
                               {'form': form,'message': message},
+=======
+    return render_to_response(template,
+                              {'form': form},
+>>>>>>> MERGE-SOURCE
                               context_instance=RequestContext(request))
 
 @login_required
@@ -92,14 +112,13 @@
     filled in before the last POST request is returned. The user must
     be logged in to create a new list.
     """
-    error = None
-    message = None
     mailing_list = None
     if request.method == 'POST':
         try:
             domains = Domain.objects.all()
-        except MailmanApiError:
-            return utils.render_api_error(request)
+        except MailmanApiError, e:
+            messages.error(request,e)
+            return render_to_response('mailmanweb/errors/generic.html',context_instance=RequestContext(request))
         choosable_domains = [("",_("Choose a Domain"))]
         for domain in domains:
             choosable_domains.append((domain.mail_host,
@@ -118,29 +137,31 @@
                 #settings["???"] = form.cleaned_data['languages'] #TODO not found in REST:
                 list_settings["advertised"] = form.cleaned_data['advertised']
                 list_settings.save()
+                messages.success(_("List created"))
                 return redirect("list_summary",fqdn_listname=mailing_list.fqdn_listname)
             #TODO catch correct Error class:
             except HTTPError, e:
-                return render_to_response('mailmanweb/errors/generic.html', 
-                                      {'error':e},
-                                      context_instance=RequestContext(request))
+                messages.error(request,e)
+                return render_to_response('mailmanweb/errors/generic.html',context_instance=RequestContext(request))
+            else:
+                messages.success(_("New List created"))
     else:
         try:
             domains = Domain.objects.all()
-        except MailmanApiError:
-            return utils.render_api_error(request)
+        except MailmanApiError, e:
+            messages.error(request,e)
+            return render_to_response('mailmanweb/errors/generic.html',context_instance=RequestContext(request))
         choosable_domains = [("",_("Choose a Domain"))]
         for domain in domains:
             choosable_domains.append((domain.mail_host,domain.mail_host))
         form = ListNew(choosable_domains,initial={'list_owner': request.user.username})
-    return render_to_response(template, {'form': form, error:None},
+    return render_to_response(template, {'form': form},
                               context_instance=RequestContext(request))
 
 def list_index(request, template = 'mailmanweb/lists/index.html'):
     """Show a table of all public mailing lists.
     """
     lists = []
-    error = None
     domain = None
     only_public = True
     if request.user.is_authenticated():
@@ -148,13 +169,13 @@
     try:
         lists = List.objects.all(only_public=only_public)
     except MailmanApiError:
-        return utils.render_api_error(request)
+        messages.error(request,e)
+        return render_to_response('mailmanweb/errors/generic.html',context_instance=RequestContext(request))
     if request.method == 'POST':
         return redirect("list_summary", fqdn_listname=request.POST["list"])
     else:
         return render_to_response(template,
-                                  {'error': error,
-                                   'lists': lists,},
+                                  {'lists': lists,},
                                   context_instance=RequestContext(request))
 
 def list_metrics(request,fqdn_listname=None,option=None,template='mailmanweb/lists/metrics.html'):
@@ -164,7 +185,6 @@
     information about the list such as the date of the last post and the
     time the last digest is sent.
     """
-    error=None
     user_is_subscribed = False
     if request.method == 'POST':
         return redirect("list_summary", fqdn_listname=request.POST["list"])
@@ -177,7 +197,8 @@
             except:
                 pass #init
         except MailmanApiError:
-            return render_api_error(request)
+            messages.error(request,e)
+            return render_to_response('mailmanweb/errors/generic.html',context_instance=RequestContext(request))
     return render_to_response(template,
                               {'list':the_list,
                                'message':  None,
@@ -193,7 +214,8 @@
     try:
         the_list = List.objects.get_or_404(fqdn_listname=fqdn_listname)
     except MailmanApiError:
-        return utils.render_api_error(request)
+        messages.error(request,e)
+        return render_to_response('mailmanweb/errors/generic.html',context_instance=RequestContext(request))
     return render_to_response(template, 
                               {'list': the_list,
                                'subscribe_form': ListSubscribe(),
@@ -206,7 +228,8 @@
     try:
         the_list = List.objects.get_or_404(fqdn_listname=fqdn_listname)
     except MailmanApiError:
-        return utils.render_api_error(request)
+        messages.error(request,e)
+        return render_to_response('mailmanweb/errors/generic.html',context_instance=RequestContext(request))
     if request.method == 'POST':
         form = ListSubscribe(request.POST)
     else:
@@ -224,8 +247,6 @@
     user to fill in which are evaluated in this function.
     """
     #create Values for Template usage   
-    message = None
-    error = None
     form_subscribe = None
     form_unsubscribe = None
     if request.POST.get('fqdn_listname', ''):
@@ -233,9 +254,9 @@
     # connect REST and catch issues getting the list
     try:
         the_list = List.objects.get_or_404(fqdn_listname=fqdn_listname)
-    except AttributeError, e:
+    except MailmanApiError, e:
+        messages.error(request,"REST API not found / Offline")
         return render_to_response('mailmanweb/errors/generic.html', 
-                                  {'error': "REST API not found / Offline"},
                                   context_instance=RequestContext(request))
     #process submitted form    
     if request.method == 'POST':
@@ -254,8 +275,8 @@
                                                'option':option,
                                                'message':_("Subscribed ")+ email },context_instance=RequestContext(request))
                 except HTTPError, e:
-                    return render_to_response('mailmanweb/errors/generic.html', 
-                                      {'error':e}, context_instance=RequestContext(request))
+                    messages.error(request,e)
+                    return render_to_response('mailmanweb/errors/generic.html', context_instance=RequestContext(request))
             else: #invalid subscribe form
                 form_subscribe = form
                 form_unsubscribe = ListUnsubscribe(initial = {'fqdn_listname': fqdn_listname, 'name' : 'unsubscribe'})       
@@ -269,8 +290,8 @@
                     return render_to_response('mailmanweb/lists/summary.html', 
                                               {'list': the_list, 'message':_("Unsubscribed ")+ email },context_instance=RequestContext(request))
                 except ValueError, e:
-                    return render_to_response('mailmanweb/errors/generic.html', 
-                                      {'error':e}, context_instance=RequestContext(request))   
+                    messages.error(request,e)
+                    return render_to_response('mailmanweb/errors/generic.html', context_instance=RequestContext(request))   
             else:#invalid unsubscribe form
                 form_subscribe = ListSubscribe(initial = {'fqdn_listname': fqdn_listname,
                                                                'option':option,
@@ -288,8 +309,6 @@
     the_list = List.objects.get_or_404(fqdn_listname=fqdn_listname)#TODO
     return render_to_response(template, {'form_subscribe': form_subscribe,
                                          'form_unsubscribe': form_unsubscribe,
-                                         'message':message,
-                                         'error':error,
                                          'list': the_list,
                                          }
                                          ,context_instance=RequestContext(request))
@@ -301,7 +320,8 @@
     try:
         the_list = List.objects.get_or_404(fqdn_listname=fqdn_listname)
     except MailmanApiError:
-        return utils.render_api_error(request)
+        messages.error(request,e)
+        return render_to_response('mailmanweb/errors/generic.html',context_instance=RequestContext(request))
     if request.method == 'POST':
         the_list.delete()
         # let the user return to the list index page
@@ -328,7 +348,6 @@
     to show only parts of the settings
     <param> is optional / is used to differ in between section and option might result in using //option
     """
-    message = ""
     logger.debug(visible_section)
     if visible_section == None:
         visible_section = 'List Identity'
@@ -336,14 +355,15 @@
     try:
         the_list = List.objects.get_or_404(fqdn_listname=fqdn_listname)
     except MailmanApiError:
-        return utils.render_api_error(request)
+        messages.error(request,e)
+        return render_to_response('mailmanweb/errors/generic.html',context_instance=RequestContext(request))
     #collect all Form sections for the links:
     temp = ListSettings('','')
     for section in temp.layout:
         try:
             form_sections.append((section[0],temp.section_descriptions[section[0]]))
         except KeyError, e:
-            error=e
+            messages.error(e)
     del temp
     #Save a Form Processed by POST  
     if request.method == 'POST':
@@ -354,9 +374,9 @@
             for key in form.fields.keys():
                 list_settings[key] = form.cleaned_data[key]
                 list_settings.save()    
-            message = _("The list has been updated.")
+            messages.success(_("The list has been updated."))
         else:
-            message = _("Validation Error - The list has not been updated.")
+            messages.success(_("Validation Error - The list has not been updated."))
     
     else:
         #Provide a form with existing values
@@ -372,7 +392,6 @@
         form.truncate()
     return render_to_response(template, {'form': form,
                                          'form_sections': form_sections,
-                                         'message': message,
                                          'list': the_list,
                                          'visible_option':visible_option,
                                          'visible_section':visible_section,
@@ -387,11 +406,11 @@
     This functions is part of the settings for a list and requires the
     user to be logged in to perform the action.
     """
-    message = ""
     try:
         the_list = List.objects.get_or_404(fqdn_listname=fqdn_listname)
     except MailmanApiError:
-        return utils.render_api_error(request)
+        messages.error(request,e)
+        return render_to_response('mailmanweb/errors/generic.html',context_instance=RequestContext(request))
     if request.method == 'POST':
         form = ListMassSubscription(request.POST)
         if form.is_valid():
@@ -405,16 +424,15 @@
                     if len(parts) == 2 and '.' in parts[1]: #TODO - move check to clean method of the form - see example in django docs
                         try:
                             the_list.subscribe(address=email, real_name="")
-                            message = "The mass subscription was successful."
+                            messages.success(_("The mass subscription was successful."))
                         except Exception, e: #TODO find right exception and catch only this one
-                            return render_to_response('mailmanweb/errors/generic.html', 
-                                  {'error': str(e)})
-
+                            messages.error(request,str(e))
+                            return render_to_response('mailmanweb/errors/generic.html', )
                     else:
                         # At least one email address wasn't valid so 
                         # overwrite the success message and ask them to
                         # try again.
-                        message = "Please enter valid email addresses."
+                        messages.error(_("Please enter valid email addresses."))
             except Exception, e:
                 return HttpResponse(e)
     else:
@@ -422,7 +440,6 @@
         # mass subscribe users.
         form = ListMassSubscription()
     return render_to_response(template, {'form': form,
-                                         'message': message,
                                          'list': the_list}
                                          ,context_instance=RequestContext(request))
 
@@ -438,7 +455,6 @@
             change to the correct calls here
     """
     member = request.user.username
-    message = ''
     form = None
     the_list=None
     membership_lists = []
@@ -450,8 +466,14 @@
                 the_list = List.objects.get(fqdn_listname=fqdn_listname)
                 user_object = the_list.get_member(member)
             else:
+<<<<<<< TREE
                 message = ("Using a workaround to replace missing Client functionality → LP:820827")
                 for mlist in List.objects.all(): 
+=======
+                messages.debug("Using a workaround to replace missing Client functionality → LP:820827") #Todo - no translation neededf
+                #### BEGIN workaround
+                for mlist in Lists.objects.all(): 
+>>>>>>> MERGE-SOURCE
                     try: 
                         mlist.get_member(member)
                         membership_lists.append(mlist)
@@ -462,17 +484,16 @@
            # tuples of length 2
            raise Exception("WORK in PROGRRESS needs REST Auth Middleware! - TODO")
            address_choices = [[addr, addr] for addr in user_object.address]
-    except AttributeError, e:
-        return render_to_response('mailmanweb/errors/generic.html', 
-                                  {'error': str(e)+"REST API not found / Offline"},
-                                  context_instance=RequestContext(request))
+    except MailmanApiError, e:
+        messages.error(request,str(e)+"REST API not found / Offline")
+        return render_to_response('mailmanweb/errors/generic.html',context_instance=RequestContext(request))
     except ValueError, e:
+        messages.error(request,e)
         return render_to_response('mailmanweb/errors/generic.html', 
-                                  {'error': e},
                                   context_instance=RequestContext(request))
     except HTTPError,e :
+        messages.error(request,_("List ")+fqdn_listname+_(" does not exist"))
         return render_to_response('mailmanweb/errors/generic.html', 
-                                  {'error': _("List ")+fqdn_listname+_(" does not exist")},
                                   context_instance=RequestContext(request))
     #-----------------------------------------------------------------
     if request.method == 'POST':
@@ -484,7 +505,7 @@
             if form.is_valid():
                 member_object = c.get_member(member, request.GET["list"])
                 member_object.update(request.POST)
-                message = "The membership settings have been updated."
+                messages.success(_("The membership settings have been updated."))
         else:
             # the post request came from the user tab
             # the 'address' field need choices as a tuple of length 2
@@ -498,7 +519,7 @@
                 # not just the address_choices (add mock data to _User 
                 # class and make the call with 'user_object.info')
                 form = UserSettings(address_choices)
-                message = "The user settings have been updated."
+                messages.success(_("The user settings have been updated."))
 
     else:
         if tab == "membership" and fqdn_listname :
@@ -533,7 +554,6 @@
                                          'tab': tab,
                                          'list': the_list,
                                          'membership_lists': membership_lists,
-                                         'message': message,
                                          'member': member}
                                          ,context_instance=RequestContext(request))