approval.models.monitored

 1from typing import List
 2
 3from django.core.exceptions import ObjectDoesNotExist
 4from django.db import models
 5import logging
 6
 7from django.utils.translation import pgettext_lazy
 8
 9
10logger = logging.getLogger("approval")
11
12
13class MonitoredModel(models.Model):
14    """
15    Moderated table mixin.
16
17    If you want to mark a model to make it subject to a moderation stage,
18    you must make it inherit from ``MonitoredModel``. No need to make it
19    also inherit from ``django.db.models.Model``, since it's already
20    a parent class of the mixin.
21
22    .. code-block:: python
23        :linenos:
24
25        from approval.models import MonitoredModel
26        from django.db import models
27
28        class Post(MonitoredModel):  # Inherit from MonitoredModel
29            # Add your own fields. Having a visibility field is a good idea.
30            user = models.ForeignKey(settings.AUTH_USER_MODEL, on_delete=models.CASCADE, related_name="entries")
31            is_visible = models.BooleanField(default=True, verbose_name="visible")
32            content = models.TextField(blank=False, verbose_name="content")
33
34    Inheriting from ``MonitoredModel`` allows provided ``pre-save`` and ``post-save`` signal
35    hooks to automatically manage your model.
36    """
37
38    class Meta:
39        abstract = True
40
41    def _get_authors(self) -> List[models.Model]:
42        """Get the authors of the current instance."""
43        # Use user from request as author only if allowed
44        if getattr(self, "approval", None):
45            if self.approval.auto_approve_by_request:
46                if getattr(self, "request") and getattr(self.request, "user", None):
47                    logger.debug(pgettext_lazy("approval", f"Using request user as author of {self}."))
48                    return [self.request.user]
49            return self.approval._get_authors()
50        return []
51
52    def _revert(self) -> bool:
53        """
54        Revert the instance to its last saved state.
55
56        This method deletes unsaved changes on source model instance,
57        by reloading what's stored in the database.
58
59        Returns:
60            `True` if revert was possible, `False` otherwise.
61        """
62        try:
63            self.refresh_from_db()
64            logger.debug(pgettext_lazy("approval", "Monitored {obj} was reverted to last DB state.").format(obj=self))
65            return True
66        except ObjectDoesNotExist:
67            return False