django-moderation 0.3.5

GenericModerator options

visible_until_rejected

By default moderation stores objects pending moderation in the changed_object field in the object’s corresponding ModeratedObject instance. If visible_until_rejected is set to True, objects pending moderation will be stored in their original model as usual and the most recently approved version of the object will be stored in changed_object. Default: False

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

visibility_column

If you want a performance boost, define visibility field on your model and add option visibility_column = 'your_field' on moderator class. Field must by a BooleanField. The manager that decides which model objects should be excluded when it were rejected, will first use this option to properly display (or hide) objects that are registered with moderation. Use this option if you can define visibility column in your model and want to boost performance. By default when accessing model objects that are under moderation, one extra query is executed per object in query set to determine if object should be excluded from query set. This method benefit those who do not want to add any fields to their Models. Default: None.

fields_exclude

Fields to exclude from object change list. Default: []

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)

0.1 alpha (2010-03-11)

• 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 (2010-05-19)

• 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.

0.3.2 (2012-02-15)

• Added visibility_column option in to GenericModerator class. Boost performance of database queries when excluding objects that should not be available publicly. Field must by a BooleanField. The manager that decides which model objects should be excluded when it were rejected, will first use this option to properly display (or hide) objects that are registered with moderation. Use this option if you can define visibility column in your model and want to boost performance. By default when accessing model objects that are under moderation, one extra query is executed per object in query set to determine if object should be excluded from query set. This method benefit those who do not want to add any fields to their Models. Default: None. Closes #19

• Added support for ImageField model fields on moderate object page.

• Made moderation work with south and grappelli

• Added possibility of excluding fields from moderation change list. Closes #23

• Moved ModerationManager class to moderation.register module, moved GenericModerator class to moderation.moderator module.

• Added auto_discover function that discover all modules that contain moderator.py module and auto registers all models it contain with moderartion.

• Efficiency improvement: get all info needed to filter a queryset in two SQL requests, rather than one for each object in the queryset.

• Added south migrations

• Added suport for foreignkey changes

• Add support for multi-table inheritance

• Add visible_until_rejected functionality

• Added specific initials in BaseModeratedObjectForm

• Added posibility to specify list of moderated fields

• Fixed SMTPRecipientsRefused when user has no email, when sending messages by moderation. Closes #48

• Added sorting of content types list on admin moderation queue

0.3.3 (2013-10-14)

• Tests refactor

• Added Travis CI

• Added CONTRIBUTING GUIDE

0.3.4 (2013-10-18)

• Dropped support for django 1.2.X