django-moderation 0.2

Introduction
============

django-moderation is reusable application for Django framework, that allows to
moderate any model objects.

Possible use cases:

- User creates his profile, profile is not visible on site.
It will be visible on site when moderator approves it.
- User change his profile, old profile data is visible on site.
New data will be visible on site when moderator approves it.

Features:

- configurable admin integration(data changed in admin can be visible on
site when moderator approves it)
- moderation queue in admin
- html differences of changes between versions of objects
- configurable email notifications
- custom model form that allows to edit changed data of object
- auto approve/reject for selected user groups or user types
- 100% PEP8 correct code
- test coverage > 80%

Known issues
============

- foreign-key and m2m relations in models are not currently supported

Road map
========

For road map and issues list look at:

http://github.com/dominno/django-moderation/issues


Contributors
============

Special thanks to all persons that contributed to this project.

- jonwd7 http://github.com/jonwd7 - Thank you for all ideas, bug fixes, patches.

Thank you very much.


Screenshots
===========

.. image:: http://dominno.pl/site_media/uploads/moderation.png
.. image:: http://dominno.pl/site_media/uploads/moderation_2.png


Requirements
============

python >= 2.4

django >= 1.1


Installation
============

Use easy_install::

$> easy_install django-moderation

Or download source code from http://github.com/dominno/django-moderation and run
installation script::

$> python setup.py install



Configuration
=============

1. Add to your INSTALLED_APPS in your settings.py:

``moderation``
2. Run command ``manage.py syncdb``
3. Register Models with moderation::

from django.db import models
from moderation import moderation


class YourModel(models.Model):
pass

moderation.register(YourModel)

4. Register admin class with your Model::

from django.contrib import admin
from moderation.admin import ModerationAdmin


class YourModelAdmin(ModerationAdmin):
"""Admin settings go here."""

admin.site.register(YourModel, YourModelAdmin)

If you want to disable integration of moderation in admin,
add admin_integration_enabled = False to your admin class::

class YourModelAdmin(ModerationAdmin):
admin_integration_enabled = False

admin.site.register(YourModel, YourModelAdmin)

If admin_integration_enabled is enabled then when saving object in admin, data
will not be saved in model instance but it will be stored in moderation queue.
Also data in change form will not data from original model instance but data from
ModeratedObject instance.

How django-moderation works
===========================

When you change existing object or create new one, it will not be publicly
available until moderator approves it. It will be stored in ModeratedObject model.::

your_model = YourModel(description='test')
your_model.save()

YourModel.objects.get(pk=your_model.pk)
Traceback (most recent call last):
DoesNotExist: YourModel matching query does not exist.

When you will approve object, then it will be publicly available.::

your_model.moderated_object.approve(moderated_by=user,
reason='Reason for approve')

YourModel.objects.get(pk=1)
<YourModel: YourModel object>

You can access changed object by calling changed_object on moderated_object:

your_model.moderated_object.changed_object
<YourModel: YourModel object>

This is deserialized version of object that was changed.

Now when you will change an object, old version of it will be available publicly,
new version will be saved in moderated_object::

your_model.description = 'New description'
your_model.save()

your_model = YourModel.objects.get(pk=1)
your_model.__dict__
{'id': 1, 'description': 'test'}

your_model.moderated_object.changed_object.__dict__
{'id': 1, 'description': 'New description'}

your_model.moderated_object.approve(moderated_by=user,
reason='Reason for approve')

your_model = YourModel.objects.get(pk=1)
your_model.__dict__
{'id': 1, 'description': 'New description'}


Moderation registration options
===============================

``moderation.register`` takes following parameters:

``model_class``
Model class that will be registered with moderation

``moderator_class``
Class that subclasses GenericModerator class. It Encapsulates moderation
options for a given model. Example::

class UserProfileModerator(GenericModerator):
notify_user = False
auto_approve_for_superusers = True

moderation.register(UserProfile, UserProfileModerator)


GenericModerator options
------------------------


``manager_names``
List of manager names on which moderation manager will be enabled. Default:
['objects']

``moderation_manager_class``
Default manager class that will enabled on model class managers passed in

``manager_names``. This class takes care of filtering out any objects that are
not approved yet. Default: ModerationObjectsManager

``auto_approve_for_superusers``
Auto approve objects changed by superusers. Default: True

``auto_approve_for_staff``
Auto approve objects changed by user that are staff. Default: True

``auto_approve_for_groups``
List of user group names that will be auto approved. Default: None

``auto_reject_for_anonymous``
Auto reject objects changed by users that are anonymous. Default: True

``auto_reject_for_groups``
List of user group names that will be auto rejected. Default: None

``bypass_moderation_after_approval``
When set to True, affected objects will be released from the model
moderator's control upon initial approval. This is useful for models in which
you want to avoid unnecessary repetition of potentially expensive
auto-approve/reject logic upon each object edit. This cannot be used for models
in which you would like to approve (auto or manually) each object edit, because
changes are not tracked and the moderation logic is not run. If the object needs
to be entered back into moderation you can set its status to "Pending" by
unapproving it. Default: False

``notify_moderator``
Defines if notification e-mails will be send to moderator. By default when
user change object that is under moderation, e-mail notification is send to
moderator. It will inform him that object was changed and need to be moderated.
Default: True

``notify_user``
Defines if notification e-mails will be send to user. When moderator
approves or reject object changes then e-mail notification is send to user that
changed this object. It will inform user if his changes were accepted or
rejected and inform him why it was rejected or approved. Default: True

``subject_template_moderator``
Subject template that will be used when sending notifications to moderators.
Default: moderation/notification_subject_moderator.txt

``message_template_moderator``
Message template that will be used when sending notifications to moderator.
Default: moderation/notification_message_moderator.txt

``subject_template_user``
Subject template that will be used when sending notifications to users.
Default: moderation/notification_subject_user.txt

``message_template_user``
Message template that will be used when sending notifications to users.
Default: moderation/notification_message_user.txt


``Notes on auto moderation``
If you want to use auto moderation in your views, then you need to save user
object that has changed the object in ModeratedObject instance. You can use
following helper. Example::


moderation.register(UserProfile)

new_profile = UserProfile()

new_profile.save()

from moderation.helpers import automoderate

automoderate(new_profile, user)


``Custom auto moderation``
If you want to define your custom logic in auto moderation, you can
overwrite methods: ``is_auto_reject`` or ``is_auto_approve`` of GenericModerator
class


Example::


class MyModelModerator(GenericModerator):

def is_auto_reject(self, obj, user):
# Auto reject spam
if akismet_spam_check(obj.body): # Check body of object for spam
# Body of object is spam, moderate
return self.reason('My custom reason: SPAM')
super(MyModelModerator, self).is_auto_reject(obj, user)

moderation.register(MyModel, MyModelModerator)


Default context of notification templates
-----------------------------------------

Default context:

``content_type``
content type object of moderated object

``moderated_object``
ModeratedObject instance

``site``
current Site instance


How to pass extra context to email notification templates
---------------------------------------------------------

Subclass GenericModerator class and overwrite ``inform_moderator`` and
``inform_user``
methods.::

class UserProfileModerator(GenericModerator):

def inform_moderator(self,
content_object,
extra_context=None):
'''Send notification to moderator'''
extra_context={'test':'test'}
super(UserProfileModerator, self).inform_moderator(content_object,
extra_context)

def inform_user(self, content_object, user, extra_context=None)
'''Send notification to user when object is approved or rejected'''
extra_context={'test':'test'}
super(CustomModerationNotification, self).inform_user(content_object,
user,
extra_context)

moderation.register(UserProfile, UserProfileModerator)


ModerationAdmin
===============

If you have defined your own ``save_model`` method in your ModelAdmin then you
must::


# Custom save_model in MyModelAdmin
def save_model(self, request, obj, form, change):
# Your custom stuff
from moderation.helpers import automoderate
automoderate(obj, request.user)


Otherwise what you save in the admin will get moderated and automoderation will
not work.


Signals
=======

``moderation.signals.pre_moderation`` - signal send before object is approved or
rejected

Arguments sent with this signal:

``sender``
The model class.

``instance``
Instance of model class that is moderated

``status``
Moderation status, 0 - rejected, 1 - approved


``moderation.signals.post_moderation`` - signal send after object is approved or
rejected

Arguments sent with this signal:

``sender``
The model class.

``instance``
Instance of model class that is moderated

``status``
Moderation status, 0 - rejected, 1 - approved


Forms
=====

When creating ModelForms for models that are under moderation use
BaseModeratedObjectForm class as ModelForm class. Thanks to that form will
initialized
with data from changed_object.::


from moderation.forms import BaseModeratedObjectForm


class ModeratedObjectForm(BaseModeratedObjectForm):

class Meta:
model = MyModel


Settings
========

``MODERATORS``
List of moderators e-mails to which notifications will be send.


How to run django-moderation tests
==================================

1. Download source from http://github.com/dominno/django-moderation
2. Run: python bootstrap.py
3. Run buildout:

bin/buildout

4. Run tests for Django 1.1 and Django 1.2::

bin/test-1.1
bin/test-1.2



Changelog
=========

0.1 alpha
---------

* Initial release

Added features

- configurable admin integration(data changed in admin can be visible on
site when moderator approves it)
- moderation queue in admin
- html differences of changes between versions of objects
- configurable email notifications
- custom model form that allows to edit changed data of object

0.2
---

- Added GenericModerator class that encapsulates moderation options for a given
model.Changed register method, it will get only two parameters: model class and
settings class.
- Added option to register models with multiple managers.
- Added options to GenericModerator class auto_approve_for_superusers,
auto_approve_for_staff, auto_approve_for_groups, auto_reject_for_anonymous,
auto_reject_for_groups. Added methods for checking auto moderation.
- Added automoderate helper function.
- Changed moderated_object property in ModerationManager class, moderated object
is get only once from database, next is cached in _moderated_object, fixed issue
with not setting user object on changed_by attribute of ModeratedObject model.
- Fixed issue when loading object from fixture for model class that is
registered with moderation. Now moderated objects will not be created when
objects are loaded from fixture.
- Fixed issue with TypeError when generating differences of changes between
model instances that have field with non unicode value ex. DateField.
- Fixed issue with accessing objects that existed before installation of
django-moderation on model class.
- Fixed issue when more then one model is registered with moderation and
multiple model instances have the same pk.
- Fixed issue with multiple model save when automoderate was used. Auto
moderation in save method of ModeratedObject has been moved to separate method.
- Added admin filter that will show only content types registered with
moderation in admin queue.
- Fixed issue when creating model forms for objects that doesn't have moderated
object created.
- Added possibility of passing changed object in to is_auto- methods of
GenericModerator class. This will allow more useful custom auto-moderation. Ex.
auto reject if akismet spam check returns True.
- Added ability to provide custom auto reject/approve reason.
- Added option bypass_moderation_after_approval in to GenericModerator class
that will release object from moderation system after initial approval of object.
- Other bug fixes and code refactoring.