def test_serialize_of_object(self):
"""Test if object is propertly serialized to json"""
json_field = SerializedObjectField()
self.assertEqual(json_field._serialize(self.profile),
'[{"pk": 1, "model": "test_app.userprofile", "fields": '\
'{"url": "http://www.google.com", "user": 1, '\
'"description": "Profile description"}}]',
)
def test_deserialize(self):
value = '[{"pk": 1, "model": "test_app1.userprofile", "fields": '\
'{"url": "http://www.google.com", "user": 1, '\
'"description": "Profile description"}}]'
json_field = SerializedObjectField()
object = json_field._deserialize(value)
self.assertEqual(repr(object),
'<UserProfile: moderator - http://www.google.com>')
self.assertTrue(isinstance(object, UserProfile))
def test_deserialize(self):
value = '[{"pk": 1, "model": "test_app1.userprofile", "fields": '\
'{"url": "http://www.google.com", "user": 1, '\
'"description": "Profile description"}}]'
json_field = SerializedObjectField()
object = json_field._deserialize(value)
self.assertEqual(repr(object),
'<UserProfile: moderator - http://www.google.com>')
self.assertTrue(isinstance(object, UserProfile))
def test_serialize_of_object(self):
"""Test if object is properly serialized to json"""
json_field = SerializedObjectField()
self.assertEqual(
json_field._serialize(self.profile),
'[{"pk": 1, "model": "test_app1.userprofile", "fields": '\
'{"url": "http://www.google.com", "user": 1, '\
'"description": "Old description"}}]',
)
def test_deserialize_proxy_model(self):
"Correctly restore a proxy model."
value = '[{"pk": 2, "model": "tests.proxyprofile", "fields": '\
'{"url": "http://example.com", "user": 2, '\
'"description": "I\'m a proxy."}}]'
json_field = SerializedObjectField()
profile = json_field._deserialize(value)
self.assertTrue(isinstance(profile, ProxyProfile))
self.assertEqual(profile.url, "http://example.com")
self.assertEqual(profile.description, "I\'m a proxy.")
self.assertEqual(profile.user_id, 2)
def test_deserialize_proxy_model(self):
"Correctly restore a proxy model."
value = '[{"pk": 2, "model": "tests.proxyprofile", "fields": '\
'{"url": "http://example.com", "user": 2, '\
'"description": "I\'m a proxy."}}]'
json_field = SerializedObjectField()
profile = json_field._deserialize(value)
self.assertTrue(isinstance(profile, ProxyProfile))
self.assertEqual(profile.url, "http://example.com")
self.assertEqual(profile.description, "I\'m a proxy.")
self.assertEqual(profile.user_id, 2)
def test_deserialize_with_inheritance(self):
value = '[{"pk": 2, "model": "test_app1.superuserprofile",'\
' "fields": {"super_power": "invisibility"}}, '\
'{"pk": 2, "model": "test_app1.userprofile", "fields":'\
' {"url": "http://www.test.com", "user": 2,'\
' "description": "Profile for new super user"}}]'
json_field = SerializedObjectField()
object = json_field._deserialize(value)
self.assertTrue(isinstance(object, SuperUserProfile))
self.assertEqual(repr(object),
'<SuperUserProfile: user1 - http://www.test.com - invisibility>')
def test_serialize_proxy_model(self):
"Handle proxy models in the serialization."
profile = ProxyProfile(description="I'm a proxy.",
url="http://example.com",
user=User.objects.get(username='******'))
profile.save()
json_field = SerializedObjectField()
self.assertEqual(
json_field._serialize(profile),
'[{"pk": 2, "model": "test_app1.proxyprofile", "fields": '\
'{"url": "http://example.com", "user": 2, '\
'"description": "I\'m a proxy."}}]',)
def test_serialize_of_object(self):
"""Test if object is properly serialized to json"""
json_field = SerializedObjectField()
serialized_str = json_field._serialize(self.profile)
self.assertIn('"pk": 1', serialized_str)
self.assertIn('"model": "tests.userprofile"', serialized_str)
self.assertIn('"fields": {', serialized_str)
self.assertIn('"url": "http://www.google.com"', serialized_str)
self.assertIn('"user": 1', serialized_str)
self.assertIn('"description": "Old description"', serialized_str)
def test_serialize_proxy_model(self):
"Handle proxy models in the serialization."
profile = ProxyProfile(description="I'm a proxy.",
url="http://example.com",
user=User.objects.get(username='******'))
profile.save()
json_field = SerializedObjectField()
self.assertEqual(
json_field._serialize(profile),
'[{"pk": 2, "model": "tests.proxyprofile", "fields": '
'{"url": "http://example.com", "user": 2, '
'"description": "I\'m a proxy."}}]',)
def test_serialize_of_object(self):
"""Test if object is properly serialized to json"""
json_field = SerializedObjectField()
serialized_str = json_field._serialize(self.profile)
self.assertIn('"pk": 1', serialized_str)
self.assertIn('"model": "tests.userprofile"', serialized_str)
self.assertIn('"fields": {', serialized_str)
self.assertIn('"url": "http://www.google.com"', serialized_str)
self.assertIn('"user": 1', serialized_str)
self.assertIn('"description": "Old description"', serialized_str)
def test_deserialize_with_inheritance(self):
value = '[{"pk": 2, "model": "test_app1.superuserprofile",'\
' "fields": {"super_power": "invisibility"}}, '\
'{"pk": 2, "model": "test_app1.userprofile", "fields":'\
' {"url": "http://www.test.com", "user": 2,'\
' "description": "Profile for new super user"}}]'
json_field = SerializedObjectField()
object = json_field._deserialize(value)
self.assertTrue(isinstance(object, SuperUserProfile))
self.assertEqual(
repr(object),
'<SuperUserProfile: user1 - http://www.test.com - invisibility>')
def test_serialize_of_many_objects(self):
"""Test if object is propertly serialized to json"""
profile = UserProfile(description='Profile for new user',
url='http://www.test.com',
user=User.objects.get(username='******'))
profile.save()
json_field = SerializedObjectField()
self.assertEqual(json_field._serialize(UserProfile.objects.all()),
'[{"pk": 1, "model": "test_app.userprofile", '\
'"fields": {"url": "http://www.google.com",'\
' "user": 1, "description": "Profile description"}},'\
' {"pk": 2, "model": "test_app.userprofile", "fields":'\
' {"url": "http://www.test.com", "user": 2, '\
'"description": "Profile for new user"}}]')
def test_serialize_proxy_model(self):
"Handle proxy models in the serialization."
profile = ProxyProfile(description="I'm a proxy.",
url="http://example.com",
user=User.objects.get(username='******'))
profile.save()
json_field = SerializedObjectField()
serialized_str = json_field._serialize(profile)
self.assertIn('"pk": 2', serialized_str)
self.assertIn('"model": "tests.proxyprofile"', serialized_str)
self.assertIn('"url": "http://example.com"', serialized_str)
self.assertIn('"user": 2', serialized_str)
self.assertIn('"description": "I\'m a proxy."', serialized_str)
self.assertIn('"fields": {', serialized_str)
def test_serialize_proxy_model(self):
"Handle proxy models in the serialization."
profile = ProxyProfile(description="I'm a proxy.",
url="http://example.com",
user=User.objects.get(username='******'))
profile.save()
json_field = SerializedObjectField()
serialized_str = json_field._serialize(profile)
self.assertIn('"pk": 2', serialized_str)
self.assertIn('"model": "tests.proxyprofile"', serialized_str)
self.assertIn('"url": "http://example.com"', serialized_str)
self.assertIn('"user": 2', serialized_str)
self.assertIn('"description": "I\'m a proxy."', serialized_str)
self.assertIn('"fields": {', serialized_str)
def test_serialize_with_inheritance(self):
"""Test if object is properly serialized to json"""
profile = SuperUserProfile(description='Profile for new super user',
url='http://www.test.com',
user=User.objects.get(username='******'),
super_power='invisibility')
profile.save()
json_field = SerializedObjectField()
self.assertEqual(json_field._serialize(profile),
'[{"pk": 2, "model": "test_app1.superuserprofile",'\
' "fields": {"super_power": "invisibility"}}, '\
'{"pk": 2, "model": "test_app1.userprofile", "fields":'\
' {"url": "http://www.test.com", "user": 2,'\
' "description": "Profile for new super user"}}]')
def test_serialize_with_inheritance(self):
"""Test if object is properly serialized to json"""
profile = SuperUserProfile(description='Profile for new super user',
url='http://www.test.com',
user=User.objects.get(username='******'),
super_power='invisibility')
profile.save()
json_field = SerializedObjectField()
self.assertEqual(
json_field._serialize(profile),
'[{"pk": 2, "model": "test_app1.superuserprofile",'\
' "fields": {"super_power": "invisibility"}}, '\
'{"pk": 2, "model": "test_app1.userprofile", "fields":'\
' {"url": "http://www.test.com", "user": 2,'\
' "description": "Profile for new super user"}}]')
def test_deserialize_many_objects(self):
value = '[{"pk": 1, "model": "test_app.userprofile", '\
'"fields": {"url": "http://www.google.com",'\
' "user": 1, "description": "Profile description"}},'\
' {"pk": 2, "model": "test_app.userprofile", "fields":'\
' {"url": "http://www.yahoo.com", "user": 2, '\
'"description": "Profile description 2"}}]'
json_field = SerializedObjectField()
objects = json_field._deserialize(value)
self.assertTrue(isinstance(objects, list))
self.assertTrue(isinstance(objects[0], UserProfile))
self.assertEqual(repr(objects[0]),
'<UserProfile: moderator - http://www.google.com>')
self.assertTrue(isinstance(objects[1], UserProfile))
self.assertEqual(repr(objects[1]),
'<UserProfile: user1 - http://www.yahoo.com>')
def test_serialize_with_inheritance(self):
"""Test if object is properly serialized to json"""
profile = SuperUserProfile(description='Profile for new super user',
url='http://www.test.com',
user=User.objects.get(username='******'),
super_power='invisibility')
profile.save()
json_field = SerializedObjectField()
serialized_str = json_field._serialize(profile)
self.assertIn('"pk": 2', serialized_str)
self.assertIn('"model": "tests.superuserprofile"', serialized_str)
self.assertIn('"fields": {"super_power": "invisibility"}',
serialized_str)
self.assertIn('"pk": 2', serialized_str)
self.assertIn('"model": "tests.userprofile"', serialized_str)
self.assertIn('"url": "http://www.test.com"', serialized_str)
self.assertIn('"user": 2', serialized_str)
self.assertIn('"description": "Profile for new super user"',
serialized_str)
self.assertIn('"fields": {', serialized_str)
def test_serialize_with_inheritance(self):
"""Test if object is properly serialized to json"""
profile = SuperUserProfile(description='Profile for new super user',
url='http://www.test.com',
user=User.objects.get(username='******'),
super_power='invisibility')
profile.save()
json_field = SerializedObjectField()
serialized_str = json_field._serialize(profile)
self.assertIn('"pk": 2', serialized_str)
self.assertIn('"model": "tests.superuserprofile"', serialized_str)
self.assertIn('"fields": {"super_power": "invisibility"}',
serialized_str)
self.assertIn('"pk": 2', serialized_str)
self.assertIn('"model": "tests.userprofile"', serialized_str)
self.assertIn('"url": "http://www.test.com"', serialized_str)
self.assertIn('"user": 2', serialized_str)
self.assertIn('"description": "Profile for new super user"',
serialized_str)
self.assertIn('"fields": {', serialized_str)
class ModeratedObject(models.Model):
content_type = models.ForeignKey(ContentType,
null=True,
blank=True,
editable=False)
object_pk = models.PositiveIntegerField(null=True,
blank=True,
editable=False)
content_object = GenericForeignKey(ct_field="content_type",
fk_field="object_pk")
date_created = models.DateTimeField(auto_now_add=True, editable=False)
date_updated = models.DateTimeField(auto_now=True)
moderation_state = models.SmallIntegerField(choices=MODERATION_STATES,
default=MODERATION_DRAFT_STATE,
editable=False)
moderation_status = models.SmallIntegerField(
choices=STATUS_CHOICES,
default=MODERATION_STATUS_PENDING,
editable=False)
moderated_by = models.ForeignKey(getattr(settings, 'AUTH_USER_MODEL',
'auth.User'),
blank=True,
null=True,
editable=False,
related_name='moderated_by_set')
moderation_date = models.DateTimeField(editable=False,
blank=True,
null=True)
moderation_reason = models.TextField(blank=True, null=True)
changed_object = SerializedObjectField(serialize_format='json',
editable=False)
changed_by = models.ForeignKey(getattr(settings, 'AUTH_USER_MODEL',
'auth.User'),
blank=True,
null=True,
editable=True,
related_name='changed_by_set')
objects = ModeratedObjectManager()
content_type.content_type_filter = True
def __init__(self, *args, **kwargs):
self.instance = kwargs.get('content_object')
super(ModeratedObject, self).__init__(*args, **kwargs)
def __unicode__(self):
return "%s" % self.changed_object
def __str__(self):
return "%s" % self.changed_object
def save(self, *args, **kwargs):
if self.instance:
self.changed_object = self.instance
super(ModeratedObject, self).save(*args, **kwargs)
class Meta:
ordering = ['moderation_status', 'date_created']
def automoderate(self, user=None):
'''Auto moderate object for given user.
Returns status of moderation.
'''
if user is None:
user = self.changed_by
else:
self.changed_by = user
# No need to save here, both reject() and approve() will save us.
# Just save below if the moderation result is PENDING.
if self.moderator.visible_until_rejected:
changed_object = self.get_object_for_this_type()
else:
changed_object = self.changed_object
moderate_status, reason = self._get_moderation_status_and_reason(
changed_object, user)
if moderate_status == MODERATION_STATUS_REJECTED:
self.reject(moderated_by=self.moderated_by, reason=reason)
elif moderate_status == MODERATION_STATUS_APPROVED:
self.approve(moderated_by=self.moderated_by, reason=reason)
else: # MODERATION_STATUS_PENDING
self.save()
return moderate_status
def _get_moderation_status_and_reason(self, obj, user):
'''
Returns tuple of moderation status and reason for auto moderation
'''
reason = self.moderator.is_auto_reject(obj, user)
if reason:
return MODERATION_STATUS_REJECTED, reason
else:
reason = self.moderator.is_auto_approve(obj, user)
if reason:
return MODERATION_STATUS_APPROVED, reason
return MODERATION_STATUS_PENDING, None
def get_object_for_this_type(self):
pk = self.object_pk
obj = self.content_type.model_class()._default_manager.get(pk=pk)
return obj
def get_absolute_url(self):
if hasattr(self.changed_object, 'get_absolute_url'):
return self.changed_object.get_absolute_url()
return None
def get_admin_moderate_url(self):
return "/admin/moderation/moderatedobject/%s/" % self.pk
@property
def moderator(self):
from moderation import moderation
model_class = self.content_object.__class__
return moderation.get_moderator(model_class)
def _moderate(self, new_status, moderated_by, reason):
# See register.py pre_save_handler() for the case where the model is
# reset to its old values, and the new values are stored in the
# ModeratedObject. In such cases, on approval, we should restore the
# changes to the base object by saving the one attached to the
# ModeratedObject.
if (self.moderation_status == MODERATION_STATUS_PENDING
and new_status == MODERATION_STATUS_APPROVED
and not self.moderator.visible_until_rejected):
base_object = self.changed_object
base_object_force_save = True
else:
# The model in the database contains the most recent data already,
# or we're not ready to approve the changes stored in
# ModeratedObject.
obj_class = self.changed_object.__class__
pk = self.changed_object.pk
base_object = obj_class._default_manager.get(pk=pk)
base_object_force_save = False
if new_status == MODERATION_STATUS_APPROVED:
# This version is now approved, and will be reverted to if
# future changes are rejected by a moderator.
self.moderation_state = MODERATION_READY_STATE
self.moderation_status = new_status
self.moderation_date = datetime.datetime.now()
self.moderated_by = moderated_by
self.moderation_reason = reason
self.save()
if self.moderator.visibility_column:
old_visible = getattr(base_object,
self.moderator.visibility_column)
if new_status == MODERATION_STATUS_APPROVED:
new_visible = True
elif new_status == MODERATION_STATUS_REJECTED:
new_visible = False
else: # MODERATION_STATUS_PENDING
new_visible = self.moderator.visible_until_rejected
if new_visible != old_visible:
setattr(base_object, self.moderator.visibility_column,
new_visible)
base_object_force_save = True
if base_object_force_save:
# avoid triggering pre/post_save_handler
base_object.save_base(raw=True)
if self.changed_by:
self.moderator.inform_user(self.content_object, self.changed_by)
def has_object_been_changed(self, original_obj, fields_exclude=None):
if fields_exclude is None:
fields_exclude = self.moderator.fields_exclude
changes = get_changes_between_models(original_obj, self.changed_object,
fields_exclude)
for change in changes:
left_change, right_change = changes[change].change
if left_change != right_change:
return True
return False
def approve(self, moderated_by=None, reason=None):
pre_moderation.send(sender=self.changed_object.__class__,
instance=self.changed_object,
status=MODERATION_STATUS_APPROVED)
self._moderate(MODERATION_STATUS_APPROVED, moderated_by, reason)
post_moderation.send(sender=self.content_object.__class__,
instance=self.content_object,
status=MODERATION_STATUS_APPROVED)
def reject(self, moderated_by=None, reason=None):
pre_moderation.send(sender=self.changed_object.__class__,
instance=self.changed_object,
status=MODERATION_STATUS_REJECTED)
self._moderate(MODERATION_STATUS_REJECTED, moderated_by, reason)
post_moderation.send(sender=self.content_object.__class__,
instance=self.content_object,
status=MODERATION_STATUS_REJECTED)
class ModeratedObject(models.Model):
content_type = models.ForeignKey(ContentType,
null=True,
blank=True,
editable=False)
object_pk = models.PositiveIntegerField(null=True,
blank=True,
editable=False)
content_object = generic.GenericForeignKey(ct_field="content_type",
fk_field="object_pk")
date_created = models.DateTimeField(auto_now_add=True, editable=False)
moderation_state = models.SmallIntegerField(choices=MODERATION_STATES,
default=MODERATION_READY_STATE,
editable=False)
moderation_status = models.SmallIntegerField(
choices=STATUS_CHOICES,
default=MODERATION_STATUS_PENDING,
editable=False)
moderated_by = models.ForeignKey(User,
blank=True,
null=True,
editable=False,
related_name='moderated_by_set')
moderation_date = models.DateTimeField(editable=False,
blank=True,
null=True)
moderation_reason = models.TextField(blank=True, null=True)
changed_object = SerializedObjectField(serialize_format='json',
editable=False)
changed_by = models.ForeignKey(User,
blank=True,
null=True,
editable=True,
related_name='changed_by_set')
objects = ModeratedObjectManager()
content_type.content_type_filter = True
def __init__(self, *args, **kwargs):
self.instance = kwargs.get('content_object')
super(ModeratedObject, self).__init__(*args, **kwargs)
def __unicode__(self):
return u"%s" % self.changed_object
def save(self, *args, **kwargs):
if self.instance:
self.changed_object = self.instance
super(ModeratedObject, self).save(*args, **kwargs)
class Meta:
ordering = ['moderation_status', 'date_created']
def automoderate(self, user=None):
'''Auto moderate object for given user.
Returns status of moderation.
'''
if user is None:
user = self.changed_by
else:
self.changed_by = user
self.save()
if self.moderator.visible_until_rejected:
changed_object = self.get_object_for_this_type()
else:
changed_object = self.changed_object
moderate_status, reason = self._get_moderation_status_and_reason(
changed_object, user)
if moderate_status == MODERATION_STATUS_REJECTED:
self.reject(moderated_by=self.moderated_by, reason=reason)
elif moderate_status == MODERATION_STATUS_APPROVED:
self.approve(moderated_by=self.moderated_by, reason=reason)
return moderate_status
def _get_moderation_status_and_reason(self, obj, user):
'''
Returns tuple of moderation status and reason for auto moderation
'''
reason = self.moderator.is_auto_reject(obj, user)
if reason:
return MODERATION_STATUS_REJECTED, reason
else:
reason = self.moderator.is_auto_approve(obj, user)
if reason:
return MODERATION_STATUS_APPROVED, reason
return MODERATION_STATUS_PENDING, None
def get_object_for_this_type(self):
pk = self.object_pk
obj = self.content_type.model_class()._default_manager.get(pk=pk)
return obj
def get_absolute_url(self):
if hasattr(self.changed_object, 'get_absolute_url'):
return self.changed_object.get_absolute_url()
return None
def get_admin_moderate_url(self):
return u"/admin/moderation/moderatedobject/%s/" % self.pk
@property
def moderator(self):
from moderation import moderation
model_class = self.content_object.__class__
return moderation.get_moderator(model_class)
def _moderate(self, status, moderated_by, reason):
self.moderation_status = status
self.moderation_date = datetime.datetime.now()
self.moderated_by = moderated_by
self.moderation_reason = reason
if status == MODERATION_STATUS_APPROVED:
if self.moderator.visible_until_rejected:
try:
obj_class = self.changed_object.__class__
pk = self.changed_object.pk
unchanged_obj = obj_class._default_manager.get(pk=pk)
except obj_class.DoesNotExist:
unchanged_obj = None
self.changed_object = unchanged_obj
if self.moderator.visibility_column:
setattr(self.changed_object, self.moderator.visibility_column,
True)
self.save()
self.changed_object.save()
else:
self.save()
if status == MODERATION_STATUS_REJECTED and\
self.moderator.visible_until_rejected:
self.changed_object.save()
if self.changed_by:
self.moderator.inform_user(self.content_object, self.changed_by)
def has_object_been_changed(self, original_obj, fields_exclude=None):
if fields_exclude is None:
fields_exclude = self.moderator.fields_exclude
changes = get_changes_between_models(original_obj, self.changed_object,
fields_exclude)
for change in changes:
left_change, right_change = changes[change].change
if left_change != right_change:
return True
return False
def approve(self, moderated_by=None, reason=None):
pre_moderation.send(sender=self.changed_object.__class__,
instance=self.changed_object,
status=MODERATION_STATUS_APPROVED)
self._moderate(MODERATION_STATUS_APPROVED, moderated_by, reason)
post_moderation.send(sender=self.content_object.__class__,
instance=self.content_object,
status=MODERATION_STATUS_APPROVED)
def reject(self, moderated_by=None, reason=None):
pre_moderation.send(sender=self.changed_object.__class__,
instance=self.changed_object,
status=MODERATION_STATUS_REJECTED)
self._moderate(MODERATION_STATUS_REJECTED, moderated_by, reason)
post_moderation.send(sender=self.content_object.__class__,
instance=self.content_object,
status=MODERATION_STATUS_REJECTED)
