Feature/history

djadmin2/core.py

@@ -1,6 +1,7 @@
 # -*- coding: utf-8 -*-:
 """
-WARNING: This file about to undergo major refactoring by @pydanny per Issue #99.
+WARNING: This file about to undergo major refactoring by @pydanny per
+Issue #99.
 """
 from __future__ import division, absolute_import, unicode_literals
 
@@ -22,7 +23,8 @@ class Admin2(object):
     It keeps a registry of all registered Models and collects the urls of their
     related ModelAdmin2 instances.
 
-    It also provides an index view that serves as an entry point to the admin site.
+    It also provides an index view that serves as an entry point to the
+    admin site.
     """
     index_view = views.IndexView
     app_index_view = views.AppIndexView
@@ -46,7 +48,8 @@ def register(self, model, model_admin=None, **kwargs):
         If a model is already registered, this will raise ImproperlyConfigured.
         """
         if model in self.registry:
-            raise ImproperlyConfigured('%s is already registered in django-admin2' % model)
+            raise ImproperlyConfigured(
+                '%s is already registered in django-admin2' % model)
         if not model_admin:
             model_admin = types.ModelAdmin2
         self.registry[model] = model_admin(model, admin=self, **kwargs)
@@ -62,12 +65,14 @@ def deregister(self, model):
         """
         Deregisters the given model. Remove the model from the self.app as well
 
-        If the model is not already registered, this will raise ImproperlyConfigured.
+        If the model is not already registered, this will raise
+        ImproperlyConfigured.
         """
         try:
             del self.registry[model]
         except KeyError:
-            raise ImproperlyConfigured('%s was never registered in django-admin2' % model)
+            raise ImproperlyConfigured(
+                '%s was never registered in django-admin2' % model)
 
         # Remove the model from the apps registry
         # Get the app label
@@ -101,7 +106,8 @@ def get_admin_by_name(self, name):
         for object_admin in self.registry.values():
             if object_admin.name == name:
                 return object_admin
-        raise ValueError(u'No object admin found with name {}'.format(repr(name)))
+        raise ValueError(
+            u'No object admin found with name {}'.format(repr(name)))
 
     def get_index_kwargs(self):
         return {
@@ -122,7 +128,8 @@ def get_api_index_kwargs(self):
         }
 
     def get_urls(self):
-        urlpatterns = patterns('',
+        urlpatterns = patterns(
+            '',
             url(regex=r'^$',
                 view=self.index_view.as_view(**self.get_index_kwargs()),
                 name='dashboard'
@@ -140,18 +147,21 @@ def get_urls(self):
                 name='logout'
                 ),
             url(regex=r'^(?P<app_label>\w+)/$',
-                view=self.app_index_view.as_view(**self.get_app_index_kwargs()),
+                view=self.app_index_view.as_view(
+                    **self.get_app_index_kwargs()),
                 name='app_index'
                 ),
             url(regex=r'^api/v0/$',
-                view=self.api_index_view.as_view(**self.get_api_index_kwargs()),
+                view=self.api_index_view.as_view(
+                    **self.get_api_index_kwargs()),
                 name='api_index'
                 ),
         )
 
         for model, model_admin in self.registry.iteritems():
             model_options = utils.model_options(model)
-            urlpatterns += patterns('',
+            urlpatterns += patterns(
+                '',
                 url('^{}/{}/'.format(
                     model_options.app_label,
                     model_options.object_name.lower()),

djadmin2/models.py

@@ -2,13 +2,107 @@
 """ Boilerplate for now, will serve a purpose soon! """
 from __future__ import division, absolute_import, unicode_literals
 
+from django.conf import settings
+from django.contrib.contenttypes.models import ContentType
+from django.contrib.admin.util import quote
+from django.db import models
 from django.db.models import signals
+from django.utils.encoding import force_text
+from django.utils.encoding import smart_text
+from django.utils.encoding import python_2_unicode_compatible
+from django.utils.translation import ugettext, ugettext_lazy as _
 
 from . import permissions
 
 
+class LogEntryManager(models.Manager):
+    def log_action(self, user_id, obj, action_flag, change_message=''):
+        content_type_id = ContentType.objects.get_for_model(obj).id
+        e = self.model(None, None, user_id, content_type_id,
+                       smart_text(obj.id), force_text(obj)[:200],
+                       action_flag, change_message)
+        e.save()
+
+
+@python_2_unicode_compatible
+class LogEntry(models.Model):
+    ADDITION = 1
+    CHANGE = 2
+    DELETION = 3
+
+    action_time = models.DateTimeField(_('action time'), auto_now=True)
+    user = models.ForeignKey(settings.AUTH_USER_MODEL,
+                             related_name='log_entries')
+    content_type = models.ForeignKey(ContentType, blank=True, null=True,
+                                     related_name='log_entries')
+    object_id = models.TextField(_('object id'), blank=True, null=True)
+    object_repr = models.CharField(_('object repr'), max_length=200)
+    action_flag = models.PositiveSmallIntegerField(_('action flag'))
+    change_message = models.TextField(_('change message'), blank=True)
+
+    objects = LogEntryManager()
+
+    class Meta:
+        verbose_name = _('log entry')
+        verbose_name_plural = _('log entries')
+        ordering = ('-action_time',)
+
+    def __repr__(self):
+        return smart_text(self.action_time)
+
+    def __str__(self):
+        if self.action_flag == self.ADDITION:
+            return ugettext('Added "%(object)s".') % {
+                'object': self.object_repr}
+        elif self.action_flag == self.CHANGE:
+            return ugettext('Changed "%(object)s" - %(changes)s') % {
+                'object': self.object_repr,
+                'changes': self.change_message,
+            }
+        elif self.action_flag == self.DELETION:
+            return ugettext('Deleted "%(object)s."') % {
+                'object': self.object_repr}
+
+        return ugettext('LogEntry Object')
+
+    def is_addition(self):
+        return self.action_flag == self.ADDITION
+
+    def is_change(self):
+        return self.action_flag == self.CHANGE
+
+    def is_deletion(self):
+        return self.action_flag == self.DELETION
+
+    @property
+    def action_type(self):
+        if self.is_addition():
+            return _('added')
+        if self.is_change():
+            return _('changed')
+        if self.is_deletion():
+            return _('deleted')
+        return ''
+
+    def get_edited_object(self):
+        "Returns the edited object represented by this log entry"
+        return self.content_type.get_object_for_this_type(pk=self.object_id)
+
+    def get_admin_url(self):
+        """
+        Returns the admin URL to edit the object represented by this log entry.
+        This is relative to the Django admin index page.
+        """
+        if self.content_type and self.object_id:
+            return '{0.app_label}/{0.model}/{1}'.format(
+                self.content_type,
+                quote(self.object_id)
+            )
+        return None
+
 # setup signal handlers here, since ``models.py`` will be imported by django
 # for sure if ``djadmin2`` is listed in the ``INSTALLED_APPS``.
 
-signals.post_syncdb.connect(permissions.create_view_permissions,
+signals.post_syncdb.connect(
+    permissions.create_view_permissions,
     dispatch_uid="django-admin2.djadmin2.permissions.create_view_permissions")

djadmin2/templatetags/admin2_tags.py

@@ -7,7 +7,7 @@
 from django import template
 from django.db.models.fields import FieldDoesNotExist
 
-from .. import utils, renderers
+from .. import utils, renderers, models
 
 
 register = template.Library()
@@ -136,3 +136,10 @@ def render(context, model_instance, attribute_name):
         # It must be a method instead.
         field = None
     return renderer(value, field)
+
+
+@register.inclusion_tag('djadmin2theme_default/includes/history.html',
+                        takes_context=True)
+def action_history(context):
+    actions = models.LogEntry.objects.filter(user__pk=context['user'].pk)
+    return {'actions': actions}

djadmin2/themes/djadmin2theme_default/templates/djadmin2theme_default/includes/history.html

@@ -0,0 +1,20 @@
+{% if actions %}
+    <ol class="unstyled">
+        {% for action in actions %}
+        <li>
+            {% if action.is_addition %}
+                <i class="added icon-plus"></i>
+            {% elif action.is_change %}
+                <i class="changed icon-pencil"></i>
+            {% else %}
+                <i class="deleted icon-minus"></i>
+            {% endif %}
+            {{ action }}
+            <span class="muted">{{ action.content_type.model }}</span>
+        </li>
+        {% endfor %}
+    </ol>
+{% else %}
+    <p>None available</p>
+{% endif %}
+

djadmin2/themes/djadmin2theme_default/templates/djadmin2theme_default/index.html

@@ -3,16 +3,16 @@
 
 {% block content %}
 
-<div class="row">
-  <div class="span7">
+<div class="row-fluid">
+  <div class="span8">
     {% for app_label, registry in apps.items %}
       {% include 'djadmin2theme_default/includes/app_model_list.html' %}
     {% endfor %}
   </div>
-  <div class="span5">
+  <div class="span4 well pull-right">
     <h4>{% trans "Recent Actions" %}</h4>
     <h5>{% trans "My Actions" %}</h5>
-    TODO
+    {% action_history %}
   </div>
 </div>
 {% endblock content %}

djadmin2/themes/djadmin2theme_default/templates/djadmin2theme_default/model_history.html

@@ -0,0 +1,59 @@
+{% extends "djadmin2theme_default/base.html" %}
+{% load admin2_tags i18n %}
+
+{% block title %}{% trans "History for" %} {{ object }}{% endblock title %}
+
+{% block page_title %}{% trans "History for" %} {{ object }}{% endblock page_title %}
+
+{% block breadcrumbs %}
+  <li>
+    <a href="{% url "admin2:dashboard" %}">{% trans "Home" %}</a>
+    <span class="divider">/</span>
+  </li>
+  <li>
+    <a href="{% url "admin2:app_index" app_label=app_label %}">{{ app_label|title }}</a>
+    <span class="divider">/</span>
+  </li>
+  <li>
+    <a href="{% url view|admin2_urlname:"index" %}">{{ model_name_pluralized|title }}</a>
+    <span class="divider">/</span>
+  </li>
+  <li>
+    <a href="{% url view|admin2_urlname:"detail" pk=object.pk %}">{{ object }}</a>
+    <span class="divider">/</span>
+  </li>
+  <li class="active">{% trans "History" %}</li>
+{% endblock breadcrumbs %}
+
+{% block content %}
+
+<p>
+{% blocktrans with object=object %}
+    History for {{ object }}
+{% endblocktrans %}
+
+{% if object_list %}
+    <table class="table table-striped table-bordered">
+        <thead>
+            <tr>
+                <th>{% trans "Date/Time" %}</th>
+                <th>{% trans "User" %}</th>
+                <th>{% trans "Action" %}</th>
+                <th>{% trans "Message" %}</th>
+            </tr>
+        </thead>
+        <tbody>
+            {% for log in object_list %}
+            <tr>
+                <td>{{ log.action_time }}</td>
+                <td>{{ log.user }}</td>
+                <td>{{ log.action_type|capfirst }}</td>
+                <td>{{ log.change_message }}</td>
+            </tr>
+            {% endfor %}
+        </tbody>
+    </table>
+{% else %}
+    <p>No history for this object.</p>
+{% endif %}
+{% endblock content %}

djadmin2/themes/djadmin2theme_default/templates/djadmin2theme_default/model_update_form.html

@@ -9,7 +9,9 @@
 {% block page_title %}{% blocktrans with action=action model_name=model_name %}{{ action_name }} {{ model_name }}{% endblocktrans %}{% endblock page_title %}
 
 {% block page_title_link %}
-<a href="#" class="btn btn-info">History</a>
+{% if object.pk %}
+    <a href="{% url view|admin2_urlname:"history" pk=object.pk %}" class="btn btn-info pull-right">History</a>
+{% endif %}
 {% endblock page_title_link %}
 
 {% block breadcrumbs %}
@@ -41,14 +43,14 @@
 {% block content %}
 
     <form method="post">
-       
+
       {% if view.model_admin.save_on_top %}
         {% include "djadmin2theme_default/includes/save_buttons.html" %}
       {% endif %}
 
 <div class="row-fluid"><!-- begin main form row -->
     <div class="span12">
-        
+
       <div class="change_form">
         {% csrf_token %}
         {{ form|crispy }}
@@ -63,11 +65,11 @@ <h4>{{ formset.model|model_verbose_name_plural|capfirst }}</h4>
 
   </div>
 </div><!-- end main form row -->
-      
+
       {% if view.model_admin.save_on_bottom %}
         {% include "djadmin2theme_default/includes/save_buttons.html" %}
       {% endif %}
-      
+
 </form>