Merge pull request django-cms#2066 from yakky/feature/edit_model_frontend

Frontend-editable models

Author: digi604

cms/admin/placeholderadmin.py

@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
 import sys
+from django.contrib.admin.helpers import AdminForm
 from django.utils.decorators import method_decorator
 from django.db import transaction
 from django.utils import simplejson
@@ -34,6 +35,82 @@
 from cms.utils.i18n import get_language_list
 
 
+class FrontendEditableAdmin(object):
+    frontend_editable_fields = []
+
+    def get_urls(self):
+        """
+        Register the url for the single field edit view
+        """
+        from django.conf.urls import patterns, url
+
+        info = "%s_%s" % (self.model._meta.app_label, self.model._meta.module_name)
+        pat = lambda regex, fn: url(regex, self.admin_site.admin_view(fn), name='%s_%s' % (info, fn.__name__))
+
+        url_patterns = patterns(
+            '',
+            pat(r'edit-field/([0-9]+)/([a-z\-]+)/$', self.edit_field),
+        )
+        return url_patterns + super(FrontendEditableAdmin, self).get_urls()
+
+    def _get_object_for_single_field(self, object_id, language):
+        # Quick and dirty way to retrieve objects for django-hvad
+        # Cleaner implementation will extend this method in a child mixin
+        try:
+            return self.model.objects.language(language).get(pk=object_id)
+        except AttributeError:
+            return self.model.objects.get(pk=object_id)
+
+    def edit_field(self, request, object_id, language):
+        obj = self._get_object_for_single_field(object_id, language)
+        opts = obj.__class__._meta
+        saved_successfully = False
+        cancel_clicked = request.POST.get("_cancel", False)
+        raw_fields = request.GET.get("edit_fields")
+        fields = [field for field in raw_fields.split(",") if field in self.frontend_editable_fields]
+        if not fields:
+            return HttpResponseBadRequest(_("Fields %s not editabled in the frontend") % raw_fields)
+        if not request.user.has_perm("%s_change" % self.model._meta.module_name):
+            return HttpResponseForbidden(_("You do not have permission to edit this item"))
+        # Dinamically creates the form class with only `field_name` field
+        # enabled
+        form_class = self.get_form(request, obj, fields=fields)
+        if not cancel_clicked and request.method == 'POST':
+            form = form_class(instance=obj, data=request.POST)
+            if form.is_valid():
+                form.save()
+                saved_successfully = True
+        else:
+            form = form_class(instance=obj)
+        admin_form = AdminForm(form, fieldsets=[(None, {'fields': fields})], prepopulated_fields={},
+                               model_admin=self)
+        media = self.media + admin_form.media
+        context = {
+            'CMS_MEDIA_URL': get_cms_setting('MEDIA_URL'),
+            'title': opts.verbose_name,
+            'plugin': None,
+            'plugin_id': None,
+            'adminform': admin_form,
+            'add': False,
+            'is_popup': True,
+            'media': media,
+            'opts': opts,
+            'change': True,
+            'save_as': False,
+            'has_add_permission': False,
+            'window_close_timeout': 10,
+        }
+        if cancel_clicked:
+            # cancel button was clicked
+            context.update({
+                'cancel': True,
+            })
+            return render_to_response('admin/cms/page/plugin/confirm_form.html', context, RequestContext(request))
+        if not cancel_clicked and request.method == 'POST' and saved_successfully:
+            return render_to_response('admin/cms/page/plugin/confirm_form.html', context, RequestContext(request))
+        return render_to_response('admin/cms/page/plugin/change_form.html', context, RequestContext(request))
+
+
 class PlaceholderAdmin(ModelAdmin):
     def get_urls(self):
         """

cms/templates/cms/toolbar/model_attribute_edit.html

@@ -0,0 +1,18 @@
+{% load i18n l10n sekizai_tags cms_tags %}{% load url from future %}{% spaceless %}
+{% addtoblock "js" %}
+<script type="text/javascript">
+(function($) {
+// CMS.$ will be passed for $
+$(document).ready(function () {
+	new CMS.PlaceholderItem('#cms_placeholder-model-{{ opts.app_label }}-{{ instance.pk|unlocalize }}-{{ attribute_name|slugify }}', {
+		'type': 'generic',
+		'plugin_name': 'Edit {{ opts.verbose_name }}',
+		'urls': {
+			'edit_plugin': '{{ admin_url }}'
+		}
+	});
+});
+})(CMS.$);
+</script>
+{% endaddtoblock %}
+<span id="cms_placeholder-model-{{ opts.app_label }}-{{ instance.pk|unlocalize }}-{{ attribute_name|slugify }}" class="cms_placeholder-generic">{{ item }}</span>{% endspaceless %}

cms/templates/cms/toolbar/model_attribute_noedit.html

@@ -0,0 +1 @@
+{{ item }}

cms/templatetags/placeholder_tags.py

@@ -3,6 +3,10 @@
 from classytags.core import Tag, Options
 from django import template
 from django.template.defaultfilters import safe
+from django.utils.http import urlencode
+from classytags.helpers import InclusionTag
+from django.core.urlresolvers import reverse
+from cms.utils import get_language_from_request
 
 register = template.Library()
 
@@ -23,4 +27,74 @@ def render_tag(self, context, placeholder, width, language=None):
         if not placeholder:
             return ''
         return safe(placeholder.render(context, width, lang=language))
-register.tag(RenderPlaceholder)
+register.tag(RenderPlaceholder)
+
+
+class CMSEditableObject(InclusionTag):
+    template = 'cms/toolbar/model_attribute_noedit.html'
+    edit_template = 'cms/toolbar/model_attribute_edit.html'
+    name = 'show_editable_model'
+    options = Options(
+        Argument('instance'),
+        Argument('attribute'),
+        Argument('edit_fields', default=None, required=False),
+        Argument('language', default=None, required=False),
+        Argument('view_url', default=None, required=False),
+        Argument('view_method', default=None, required=False),
+    )
+
+    def _is_editable(self, request):
+        return (request and hasattr(request, 'toolbar') and
+                request.toolbar.edit_mode)
+
+    def get_template(self, context, **kwargs):
+        if self._is_editable(context.get('request', None)):
+            return self.edit_template
+        return self.template
+
+    def get_context(self, context, instance, attribute, edit_fields, language,
+                    view_url, view_method):
+        if not language:
+            language = get_language_from_request(context['request'])
+        # This allow the requested item to be a method, a property or an
+        # attribute
+        context['attribute_name'] = attribute
+        querystring = {'language': language}
+        if edit_fields:
+            context['edit_fields'] = edit_fields.split(",")
+        context['item'] = getattr(instance, attribute, '')
+        if callable(context['item']):
+            context['item'] = context['item'](context['request'])
+        # If the toolbar is not enabled the following part is just skipped: it
+        # would cause a perfomance hit for no reason
+        if self._is_editable(context.get('request', None)):
+            context['instance'] = instance
+            context['opts'] = instance._meta
+            # view_method has the precedence and we retrieve the corresponding
+            # attribute in the instance class.
+            # If view_method refers to a method it will be called passing the
+            # request; if it's an attribute, it's stored for later use
+            if view_method:
+                method = getattr(instance, view_method)
+                if callable(method):
+                    url_base = method(context['request'])
+                else:
+                    url_base = method
+            else:
+                # The default view_url is the default admin changeform for the
+                # current instance
+                if not edit_fields:
+                    view_url = 'admin:%s_%s_change' % (
+                        instance._meta.app_label, instance._meta.module_name)
+                    url_base = reverse(view_url, args=(instance.pk,))
+                else:
+                    if not view_url:
+                        view_url = 'admin:%s_%s_edit_field' % (
+                            instance._meta.app_label, instance._meta.module_name)
+                    url_base = reverse(view_url, args=(instance.pk, language))
+                    querystring['edit_fields'] = ",".join(context['edit_fields'])
+            context['admin_url'] = "%s?%s" % (url_base, urlencode(querystring))
+        return context
+
+
+register.tag(CMSEditableObject)

cms/test_utils/project/placeholderapp/admin.py

@@ -1,19 +1,20 @@
-from cms.admin.placeholderadmin import PlaceholderAdmin
+from cms.admin.placeholderadmin import PlaceholderAdmin, FrontendEditableAdmin
 from cms.test_utils.project.placeholderapp.models import (Example1, MultilingualExample1, TwoPlaceholderExample)
 from django.contrib import admin
 from hvad.admin import TranslatableAdmin
 
 
-class ExampleAdmin(PlaceholderAdmin):
-    pass
+class ExampleAdmin(FrontendEditableAdmin, PlaceholderAdmin):
+    frontend_editable_fields = ("char_1", "char_2")
 
 
 class TwoPlaceholderExampleAdmin(PlaceholderAdmin):
     pass
 
 
-class MultilingualAdmin(TranslatableAdmin, PlaceholderAdmin):
-    pass
+class MultilingualAdmin(FrontendEditableAdmin, TranslatableAdmin,
+                        PlaceholderAdmin):
+    frontend_editable_fields = ("char_1", "char_2")
 
 
 admin.site.register(Example1, ExampleAdmin)

cms/test_utils/project/placeholderapp/cms_app.py

@@ -0,0 +1,16 @@
+from cms.apphook_pool import apphook_pool
+from cms.app_base import CMSApp
+from django.utils.translation import ugettext_lazy as _
+
+
+class Example1App(CMSApp):
+    name = _("Example1 App")
+    urls = ["cms.test_utils.project.placeholderapp.urls"]
+
+apphook_pool.register(Example1App)
+
+class MultilingualExample1App(CMSApp):
+    name = _("MultilingualExample1 App")
+    urls = ["cms.test_utils.project.placeholderapp.urls_multi"]
+
+apphook_pool.register(MultilingualExample1App)

cms/test_utils/project/placeholderapp/models.py

@@ -1,3 +1,4 @@
+from django.core.urlresolvers import reverse
 from cms.utils.compat.dj import python_2_unicode_compatible
 from django.db import models
 from cms.models.fields import PlaceholderField
@@ -19,6 +20,15 @@ class Example1(models.Model):
     char_4 = models.CharField(u'char_4', max_length=255)
     placeholder = PlaceholderField('placeholder')
 
+    def callable_item(self, request):
+        return self.char_1
+
+    def __str__(self):
+        return self.char_1
+
+    def get_absolute_url(self):
+        return reverse("detail", args=(self.pk,))
+
 
 class TwoPlaceholderExample(models.Model):
     char_1 = models.CharField(u'char_1', max_length=255)
@@ -45,4 +55,7 @@ class MultilingualExample1(TranslatableModel):
     placeholder_1 = PlaceholderField('placeholder_1')
 
     def __str__(self):
-        return self.char_1
+        return self.char_1
+
+    def get_absolute_url(self):
+        return reverse("detail_multi", args=(self.pk,))

cms/test_utils/project/placeholderapp/templates/detail.html

@@ -0,0 +1,8 @@
+{% extends "base.html" %}
+{% load placeholder_tags %}
+
+{% block content %}
+<h1>{% show_editable_model instance "char_1" %}</h1>
+{% show_editable_model instance "char_2" "char_1,char_2" %}
+{% render_placeholder instance.placeholder %}
+{% endblock content %}

cms/test_utils/project/placeholderapp/templates/detail_multi.html

@@ -0,0 +1,8 @@
+{% extends "base.html" %}
+{% load placeholder_tags %}
+
+{% block content %}
+<h1>{% show_editable_model instance "char_1" "char_1" %}</h1>
+{% show_editable_model instance "char_2" "char_1,char_2" %}
+{% render_placeholder instance.placeholder_1 %}
+{% endblock content %}

cms/test_utils/project/placeholderapp/templates/list.html

@@ -0,0 +1,8 @@
+{% extends "base.html" %}
+{% load placeholder_tags %}
+
+{% block content %}
+{% for example in examples %}
+<h2><a href="{{example.get_absolute_url}}">!!{{example}}</a></h2>
+{% endfor %}
+{% endblock content %}

cms/test_utils/project/placeholderapp/urls.py

@@ -0,0 +1,6 @@
+from django.conf.urls import *
+
+urlpatterns = patterns('cms.test_utils.project.placeholderapp.views',
+    url(r'^detail/(?P<id>[0-9]+)/$', 'detail_view', name="detail"),
+    url(r'^$', 'list_view', name="list"),
+)

cms/test_utils/project/placeholderapp/urls_multi.py

@@ -0,0 +1,10 @@
+from django.conf.urls import *
+try:
+    from django.conf.urls.i18n import i18n_patterns
+except ImportError:
+    from i18nurls.i18n import i18n_patterns
+
+urlpatterns = patterns('cms.test_utils.project.placeholderapp.views',
+    url(r'^detail/(?P<id>[0-9]+)/$', 'detail_view_multi', name="detail_multi"),
+    url(r'^$', 'list_view_multi', name="list_multi"),
+)

cms/test_utils/project/placeholderapp/views.py

@@ -1,9 +1,53 @@
+from django.http import HttpResponse
 from django.shortcuts import render_to_response
+from django.template.base import Template
 from django.template.context import RequestContext
-from cms.test_utils.project.placeholderapp.models import Example1
+from cms.test_utils.project.placeholderapp.models import (Example1,
+                                                          MultilingualExample1)
+from cms.utils import get_language_from_request
 
 
 def example_view(request):
     context = RequestContext(request)
     context['examples'] = Example1.objects.all()
     return render_to_response('placeholderapp.html', context)
+
+
+def _base_detail(request, instance, template_name='detail.html', item_name="char_1",
+                template_string='',):
+    context = RequestContext(request)
+    context['instance'] = instance
+    context['item_name'] = item_name
+    if template_string:
+        template = Template(template_string)
+        return HttpResponse(template.render(context))
+    else:
+        return render_to_response(template_name, context)
+
+
+def list_view_multi(request):
+    context = RequestContext(request)
+    context['examples'] = MultilingualExample1.objects.language(
+        get_language_from_request(request)).all()
+    return render_to_response('list.html', context)
+
+
+def detail_view_multi(request, id, template_name='detail_multi.html', item_name="char_1",
+                template_string='',):
+    instance = MultilingualExample1.objects.language(
+        get_language_from_request(request)).get(pk=id)
+    return _base_detail(request, instance, template_name, item_name,
+                        template_string)
+
+
+def list_view(request):
+    context = RequestContext(request)
+    context['examples'] = Example1.objects.all()
+    return render_to_response('list.html', context)
+
+
+def detail_view(request, id, template_name='detail.html', item_name="char_1",
+                template_string='',):
+    instance = Example1.objects.get(pk=id)
+    return _base_detail(request, instance, template_name, item_name,
+                        template_string)