Issue #265 - user panel control

piplmesh/account/forms.py

@@ -2,6 +2,7 @@
 from django.forms.extras import widgets
 from django.utils.translation import ugettext_lazy as _
 
+from piplmesh import panels
 from piplmesh.account import fields, form_fields, models
 
 class UserUsernameForm(forms.Form):
@@ -164,3 +165,59 @@ def clean_confirmation_token(self):
         if not self.user.email_confirmation_token.check_token(confirmation_token):
             raise forms.ValidationError(_("The confirmation token is invalid or has expired. Please retry."), code='confirmation_token_incorrect')
         return confirmation_token
+
+def panel_form_factory():
+    """
+    Function which generates the form for selecting homepage panels.
+    """
+    def __init__(self, *args, **kwargs):
+        super(forms.Form, self).__init__(*args, **kwargs)
+
+        # Add information about dependencies to display in template
+        for name in self.fields:
+            panel = panels.panels_pool.get_panel(name)
+            self.fields[name].dependencies = panel.get_dependencies()
+
+    def clean(self):
+        cleaned_data = super(forms.Form, self).clean()
+        add = []
+
+        while True:
+            if add:
+                # User has not selected some of the dependencies, so we select them
+                for val in add:
+                    cleaned_data[val] = True
+                    self.data[val] = 'on'
+                add = []
+
+            for name, val in cleaned_data.iteritems():
+                if not val:
+                    continue
+
+                panel = panels.panels_pool.get_panel(name)
+                errors = []
+                for dep in panel.get_dependencies():
+                    if not cleaned_data[dep]:
+                        errors.append(_("Panel '%s' depends on panel '%s', it has been selected." % (name, dep)))
+                        add.append(dep)
+
+                if errors:
+                    self._errors[name] = self.error_class(errors)
+
+            # All requirements satisfied
+            if not add:
+                break
+
+        return cleaned_data
+
+    panel_list = panels.panels_pool.get_all_panels()
+
+    properties = {}
+    for panel in panel_list:
+        properties[panel.get_name()] = forms.BooleanField(required=False, initial=True)
+
+    form = type('PanelForm', (forms.Form,), properties)
+    form.__init__ = __init__
+    form.clean = clean
+
+    return form

piplmesh/account/models.py

@@ -48,6 +48,16 @@ class TwitterAccessToken(mongoengine.EmbeddedDocument):
     key = mongoengine.StringField(max_length=150)
     secret = mongoengine.StringField(max_length=150)
 
+class UserPanels(mongoengine.EmbeddedDocument):
+    panels_collapsed = mongoengine.DictField()
+    panels_order = mongoengine.DictField()
+    panels_disabled = mongoengine.ListField()
+
+    def get_panels(self):
+        return [panel for panel \
+                in panels.panels_pool.get_all_panels() \
+                if panel not in map(panels.panels_pool.get_panel, self.panels_disabled)]
+
 class User(auth.User):
     username = mongoengine.StringField(
         max_length=30,
@@ -83,10 +93,15 @@ class User(auth.User):
 
     email_confirmed = mongoengine.BooleanField(default=False)
     email_confirmation_token = mongoengine.EmbeddedDocumentField(EmailConfirmationToken)
-
-    # TODO: Model for panel settings should be more semantic.
-    panels_collapsed = mongoengine.DictField()
-    panels_order = mongoengine.DictField()
+
+    user_panels = mongoengine.EmbeddedDocumentField(UserPanels)
+
+    def __init__(self, *args, **kwargs):
+        super(User, self).__init__(*args, **kwargs)
+
+        # If the user has not previously saved any panel data, make sure we have an object to query
+        if self.user_panels == None:
+            self.user_panels = UserPanels()
 
     @models.permalink
     def get_absolute_url(self):
@@ -95,10 +110,6 @@ def get_absolute_url(self):
     def get_profile_url(self):
         return self.get_absolute_url()
 
-    def get_panels(self):
-        # TODO: Should return only panels user has enabled (should make sure users can enable panels only in the way that dependencies are satisfied)
-        return panels.panels_pool.get_all_panels()
-
     def is_anonymous(self):
         return not self.is_authenticated()
 

piplmesh/account/templates/form/panels.html

@@ -0,0 +1,39 @@
+{% load i18n %}
+
+<form action="{{ form_action }}" method="post" id="panel_form">
+    {{ form.non_field_errors }}
+    {% csrf_token %}
+    {% with next|default:request_get_next|default:"" as next_url %}
+        <div style="display: none;"><input type="hidden" name="{{ REDIRECT_FIELD_NAME }}" value="{{ next_url }}" /></div>
+    {% endwith %}
+    {% if form.fields %}
+        <ul class="form_fields">
+            {% for field in form %}
+                {% if field.errors %}
+                    <li class="field_error">
+                        {{ field.errors }}
+                    </li>
+                {% endif %}
+                <li class="field">
+                	<div class="text">
+                     <label for="{{ field.id_for_label }}">
+                         {{ field.label }}
+                     </label>
+                     {% if field.field.dependencies %}
+                      <div class="dependencies">
+                      	{% trans "Required panels" %}:
+                      	<ul>
+                          {% for dep in field.field.dependencies %}
+                          	<li>{{ dep }}</li>
+                          {% endfor %}
+                          </ul>
+                      </div>
+                  {% endif %}
+                 </div>
+                 <div class="input">{{ field }}</div>
+                </li>
+            {% endfor %}
+        </ul>
+    {% endif %}
+    <div class="buttons"><input type="submit" value="{{ form_submit }}" /></div>
+</form>

piplmesh/account/templates/user/account.html

@@ -8,6 +8,7 @@
     <div id="menu_list">
         <p><a href="{% url "profile" username=user.username %}">{% trans "Profile" %}</a></p>
         <p id="current_item"><a href="{% url "account" %}">{% trans "Account" %}</a></p>
+        <p><a href="{% url "user_panels" %}">{% trans "Panels" %}</a></p>
     </div>
     <div class="registration">
         {% with form_submit=_("Submit") %}

piplmesh/account/templates/user/panels.html

@@ -0,0 +1,18 @@
+{% extends "plain.html" %}
+
+{% load future i18n %}
+
+{% block title %}{% trans "Account" %}{% endblock %}
+
+{% block content %}
+    <div id="menu_list">
+        <p><a href="{% url "profile" username=user.username %}">{% trans "Profile" %}</a></p>
+        <p><a href="{% url "account" %}">{% trans "Account" %}</a></p>
+        <p id="current_item"><a href="{% url "user_panels" %}">{% trans "Panels" %}</a></p>
+    </div>
+    <div class="panels">
+        {% with form_submit=_("Submit") %}
+            {% include "form/panels.html" %}
+        {% endwith %}
+    </div>
+{% endblock %}

piplmesh/account/views.py

@@ -402,6 +402,34 @@ def dispatch(self, request, *args, **kwargs):
     def get_form(self, form_class):
         return form_class(self.request.user, **self.get_form_kwargs())
 
+class PanelView(generic_views.FormView):
+    template_name = 'user/panels.html'
+    form_class = forms.panel_form_factory()
+    success_url = urlresolvers.reverse_lazy('user_panels')
+
+    def form_valid(self, form):
+        user = self.request.user
+        user.user_panels.panels_disabled = [key for key, val in form.cleaned_data.iteritems() if not val]
+        user.save()
+        messages.success(self.request, _("You have successfully set your panel defaults."))
+        return super(PanelView, self).form_valid(form)
+
+    def get_initial(self):
+        user = self.request.user
+        return dict(zip(user.user_panels.panels_disabled, [False] * len(user.user_panels.panels_disabled)))
+
+    def get_form_kwargs(self):
+        """
+        Returns the keyword arguments for instanciating the form,
+        copying request.POST so we can change users' selection on validation.
+        """
+        kwargs = {'initial': self.get_initial()}
+        if self.request.method in ('POST', 'PUT'):
+            kwargs.update({
+                'data': dict(self.request.POST),
+            })
+        return kwargs
+
 def logout(request):
     """
     After user logouts, redirect her back to the page she came from.

piplmesh/frontend/static/piplmesh/css/style.css

@@ -479,6 +479,29 @@ button.browserid-signin:hover {
     padding-right: 4px;
 }
 
+/* ------------------ PANELS ---------------------------- */
+#panel_form .field {
+    overflow: auto;
+}
+
+#panel_form .field .text {
+    float: left;
+}
+
+#panel_form .field .text .dependencies {
+    color: #006600;
+    font-size: 10px;
+    text-align: right;
+}
+
+#panel_form .field .input {
+    float: left;
+}
+
+#panel_form .field .input input {
+    width: 25px;
+}
+
 /* ------------------ FOOTER ---------------------------- */
 #footer {
     text-align: center;

piplmesh/frontend/templates/home.html

@@ -30,7 +30,7 @@
     </div>
     <div id="panels">
         <div class="panels_column">
-            {% for panel in user.get_panels %}
+            {% for panel in user.user_panels.get_panels %}
                 {% render_panel panel %}
             {% endfor %}
         </div>

piplmesh/frontend/templates/user/user.html

@@ -9,6 +9,7 @@
         {% if user.username == object.username %}
             <p id="current_item">{% trans "Profile" %}</p>
             <p><a href="{% url "account" %}">{% trans "Account" %}</a></p>
+            <p><a href="{% url "user_panels" %}">{% trans "Panels" %}</a></p>
         {% endif %}
     </div>
     <div id="picture" >        

piplmesh/frontend/views.py

@@ -123,27 +123,27 @@ def send_update_on_new_post(sender, post, request, bundle, **kwargs):
 
 def panels_collapse(request):
     if request.method == 'POST':
-        request.user.panels_collapsed[request.POST['name']] = True if request.POST['collapsed'] == 'true' else False
+        request.user.user_panels.panels_collapsed[request.POST['name']] = True if request.POST['collapsed'] == 'true' else False
         request.user.save()
         return http.HttpResponse()
     else:
-        return http.HttpResponse(simplejson.dumps(request.user.panels_collapsed), mimetype='application/json')
+        return http.HttpResponse(simplejson.dumps(request.user.user_panels.panels_collapsed), mimetype='application/json')
 
 def panels_order(request):
     if request.method == 'POST':
         panels = []
 
         for name, column in zip(request.POST.getlist('names'), request.POST.getlist('columns')):
             column = int(column)
-            if column == len(panels):
+            while column >= len(panels):
                 panels.append([])
             panels[column].append(name)
 
-        request.user.panels_order[request.POST['number_of_columns']] = panels
+        request.user.user_panels.panels_order[request.POST['number_of_columns']] = panels
         request.user.save()
 
         return http.HttpResponse()
     else:
         number_of_columns = request.GET['number_of_columns']
-        panels = request.user.panels_order.get(number_of_columns, [])
+        panels = request.user.user_panels.panels_order.get(number_of_columns, [])
         return http.HttpResponse(simplejson.dumps(panels), mimetype='application/json')

piplmesh/panels/base.py

@@ -16,8 +16,8 @@ def __init__(self):
         from . import panels_pool
 
         for dependency in self.get_dependencies():
-            if not panels_pool.panels_pool.has_panel(dependency):
-                raise exceptions.PanelDependencyNotRegistered("Panel '%s' depends on panel '%s', but later is not registered" % (self.get_name(), dependency))
+            if not panels_pool.has_panel(dependency):
+                raise exceptions.PanelDependencyNotRegistered("Panel '%s' depends on panel '%s', but the latter is not registered" % (self.get_name(), dependency))
 
     @classmethod
     def get_name(cls):

piplmesh/panels/dummy_test/panel.py

@@ -0,0 +1,22 @@
+import random
+
+from django.conf import settings
+from django.contrib.webdesign import lorem_ipsum
+from django.utils.translation import ugettext_lazy as _
+
+from piplmesh import panels
+
+class DummyTestPanel(panels.BasePanel):
+    dependencies = ('dummy',)
+
+    def get_context(self, context):
+        context = super(DummyTestPanel, self).get_context(context)
+
+        context.update({
+            'header': _("Dummy test panel"),
+            'content': '\n\n'.join(lorem_ipsum.paragraphs(random.randint(1, 1))),
+        })
+        return context
+
+if settings.DEBUG:
+    panels.panels_pool.register(DummyTestPanel)

piplmesh/panels/dummy_test/templates/panel/dummy/panel.html

@@ -0,0 +1,5 @@
+{% extends "panel/panel.html" %}
+
+{% block content %}
+    {{ content|linebreaks }}
+{% endblock %}

piplmesh/urls.py

@@ -69,6 +69,7 @@
     url(r'^account/confirmation/$', account_views.EmailConfirmationSendToken.as_view(), name='email_confirmation_send_token'),
     url(r'^account/confirmation/token/(?:(?P<confirmation_token>\w+)/)?$', account_views.EmailConfirmationProcessToken.as_view(), name='email_confirmaton_process_token'),
     url(r'^account/setlanguage/$', account_views.set_language, name='set_language'),
+    url(r'^account/panels/$', account_views.PanelView.as_view(), name='user_panels'),
 
     # RESTful API
     url(r'^api/', include(v1_api.urls)),