myModelSerializer.py 5.66 KB
Newer Older
1
2
from rest_framework import serializers
from django.utils import timezone
3
from .pendingModeration import PendingModeration
4
5
from django.conf import settings
from django.contrib.contenttypes.models import ContentType
6
from backend.utils import is_member
Florent Chehab's avatar
Florent Chehab committed
7
from .myModel import MyModel
Florent Chehab's avatar
Florent Chehab committed
8
from .pendingModeration import PendingModerationSerializer
9
10


Florent Chehab's avatar
Florent Chehab committed
11
12
13
14
15
16
17
18
19
20
21
22
23
24
CLEANED_MY_MODEL_DATA = {
    'moderated_by': None,
    'moderated_on': None,
    'updated_by': None,
    'updated_on': None,
}


def override_data(old_data, new_data):
    for key in new_data:
        old_data[key] = new_data[key]
    return old_data


25
26
27
28
29
class MyModelSerializer(serializers.ModelSerializer):
    moderated_on = serializers.DateTimeField(
        format="%Y-%m-%d %H:%M:%S", read_only=True)
    updated_on = serializers.DateTimeField(
        format="%Y-%m-%d %H:%M:%S", read_only=True)
30
31
    moderated_by = serializers.CharField(read_only=True)
    updated_by = serializers.CharField(read_only=True)
32
33
    pending_moderation = serializers.SerializerMethodField()
    # pending_moderation = PendingModerationSerializer(many=True, read_only=True)
34

Florent Chehab's avatar
Florent Chehab committed
35
    # TODO : updated_by_username useless ? See in rest API
36
37
38
39
40
41
42
43
    updated_by_username = serializers.SerializerMethodField(read_only=True)

    def get_updated_by_username(self, obj):
        if obj.updated_by:
            return obj.updated_by.username
        else:
            return None

44
45
46
47
48
    def get_pending_moderation(self, obj):
        if self.context['view'].action != 'list':
            return PendingModerationSerializer(obj.pending_moderation, many=True, read_only=True, context=self.context).data
        return None

49
50
51
52
    class Meta:
        model = MyModel

    def moderation_required(self):
Florent Chehab's avatar
Florent Chehab committed
53
54
55
        if hasattr(self.Meta, 'NEVER_MODERATE') and self.Meta.NEVER_MODERATE:
            return False

56
        user = self.get_user_in_request()
57
58
59
60
61
62
63
        request = self.context['request']

        if user.is_staff:
            return False

        if settings.MODERATION_ACTIVATED:
            if request.method in ['POST', 'PUT']:  # should be always the case
64
                return not is_member('Moderators', request.user)
65
66
67

        return False

68
69
70
    def get_user_in_request(self):
        return self.context['request'].user

71
    def set_model_attr_no_moder(self, moderated_and_updated):
72
        user = self.get_user_in_request()
73
        now = timezone.now()
Florent Chehab's avatar
Florent Chehab committed
74
75
76
77
        self.override_validated_data({
            'moderated_by': user,
            'moderated_on': now,
        })
78
79

        if moderated_and_updated:
Florent Chehab's avatar
Florent Chehab committed
80
81
82
83
            self.override_validated_data({
                'updated_by': user,
                'updated_on': now,
            })
84
85

    def clean_validated_data(self):
Florent Chehab's avatar
Florent Chehab committed
86
        self.override_validated_data(CLEANED_MY_MODEL_DATA)
87

88
89
90
91
92
    def get_pending_models(self):
        ct = ContentType.objects.get_for_model(self.Meta.model)
        return PendingModeration.objects.filter(
            content_type=ct, object_id=self.instance.pk)

Florent Chehab's avatar
Florent Chehab committed
93
94
95
96
97
98
99
100
101
102
    def override_validated_data(self, new_data):
        """
        Method used to force specific attributes when saving a model
        """
        for key in new_data:
            self.validated_data[key] = new_data[key]

    def my_pre_save(self):
        pass

Florent Chehab's avatar
Florent Chehab committed
103
104
    def save(self, *args, **kwargs):
        return self.my_save(*args, **kwargs)
105

Florent Chehab's avatar
Florent Chehab committed
106
    def my_save(self, *args, **kwargs):
107
        user = self.get_user_in_request()
108
        self.clean_validated_data()
Florent Chehab's avatar
Florent Chehab committed
109
        self.my_pre_save()
110

111
112
113
        if self.moderation_required():
            if self.instance is None:  # we need to create the main model
                self.instance = super(
Florent Chehab's avatar
Florent Chehab committed
114
                    MyModelSerializer, self).save(*args, **kwargs)
115

116
            objs_pending_db = self.get_pending_models()
117

Florent Chehab's avatar
Florent Chehab committed
118
119
120
121
122
123
124
125
126
            data_to_save = dict()
            for key in self.validated_data:
                try:
                    # retreive the submitted data
                    data_to_save[key] = self.initial_data[key]
                except KeyError:
                    pass

            data_to_save = override_data(data_to_save, CLEANED_MY_MODEL_DATA)
127
128
            if len(objs_pending_db) > 0:
                pending_instance = objs_pending_db[0]
129
130
                pending_instance.updated_on = timezone.now()
                pending_instance.updated_by = user
Florent Chehab's avatar
Florent Chehab committed
131
                pending_instance.new_object = data_to_save
132
            else:
Florent Chehab's avatar
Florent Chehab committed
133
                # there is no pending instance, we have to create one
134
135
                pending_instance = PendingModeration(
                    referenced_object=self.instance,
136
137
                    updated_by=user,
                    updated_on=timezone.now(),
Florent Chehab's avatar
Florent Chehab committed
138
                    new_object=data_to_save
139
                )
Florent Chehab's avatar
Florent Chehab committed
140

141
            pending_instance.save()
142
143
144
            return self.instance

        else:
145

146
            moderated_and_updated = True
147
            if self.instance is None:
148
                self.set_model_attr_no_moder(moderated_and_updated)
Florent Chehab's avatar
Florent Chehab committed
149
                return super(MyModelSerializer, self).save(*args, **kwargs)
150
151
            else:
                # We check if we don't have any moderation pending
152
                objs_pending_db = self.get_pending_models()
153
                if len(objs_pending_db) > 0:
154
155
156
157
158
159
160
                    obj_pending_db = objs_pending_db[0]
                    self.clean_validated_data()  # Make that it is done...
                    if obj_pending_db.new_object == self.validated_data:
                        moderated_and_updated = False
                        self.validated_data['updated_by'] = obj_pending_db.updated_by
                        self.validated_data['updated_on'] = obj_pending_db.updated_on

161
162
                    objs_pending_db.delete()

163
                self.set_model_attr_no_moder(moderated_and_updated)
Florent Chehab's avatar
Florent Chehab committed
164
                return super(MyModelSerializer, self).save(*args, **kwargs)