src/api/models.py

   1 # This file is part of Wolnelektury, licensed under GNU Affero GPLv3 or later.
   2 # Copyright © Fundacja Nowoczesna Polska. See NOTICE for more information.
   3 #
   4 from django.conf import settings
   5 from django.contrib.auth.models import User
   6 from django.contrib.contenttypes.models import ContentType
   7 from django.db import models
   8 from django.db.models.signals import pre_delete
   9 from django.utils.translation import gettext_lazy as _
  10
  11 from catalogue.models import Book, Tag
  12
  13
  14 class Deleted(models.Model):
  15     object_id = models.IntegerField()
  16     slug = models.SlugField(_('slug'), max_length=120, blank=True, db_index=True)
  17     content_type = models.ForeignKey(ContentType, models.CASCADE)
  18     category = models.CharField(max_length=64, null=True, blank=True, db_index=True)
  19     created_at = models.DateTimeField(editable=False, db_index=True)
  20     deleted_at = models.DateTimeField(auto_now_add=True, db_index=True)
  21
  22     class Meta:
  23         unique_together = (('content_type', 'object_id'),)
  24
  25
  26 def _pre_delete_handler(sender, instance, **kwargs):
  27     """ save deleted objects for change history purposes """
  28
  29     if sender in (Book, Tag):
  30         if sender == Tag:
  31             if instance.category in ('book', 'set'):
  32                 return
  33             category = instance.category
  34         else:
  35             category = None
  36         content_type = ContentType.objects.get_for_model(sender)
  37         Deleted.objects.create(
  38             content_type=content_type,
  39             object_id=instance.id,
  40             created_at=instance.created_at,
  41             category=category,
  42             slug=instance.slug
  43         )
  44 pre_delete.connect(_pre_delete_handler)
  45
  46
  47 class BookUserData(models.Model):
  48     book = models.ForeignKey(Book, models.CASCADE)
  49     user = models.ForeignKey(User, models.CASCADE)
  50     complete = models.BooleanField(default=False)
  51     last_changed = models.DateTimeField(auto_now=True)
  52
  53     class Meta:
  54         unique_together = [('user', 'book')]
  55
  56     @property
  57     def state(self):
  58         return 'complete' if self.complete else 'reading'
  59
  60     @classmethod
  61     def update(cls, book, user, state):
  62         instance, created = cls.objects.get_or_create(book=book, user=user)
  63         instance.complete = state == 'complete'
  64         instance.save()
  65         return instance
  66
  67
  68 KEY_SIZE = 18
  69 SECRET_SIZE = 32
  70
  71 CONSUMER_STATES = (
  72     ('pending', 'Pending approval'),
  73     ('accepted', 'Accepted'),
  74     ('canceled', 'Canceled'),
  75 )
  76
  77
  78 class Nonce(models.Model):
  79     token_key = models.CharField(max_length=KEY_SIZE)
  80     consumer_key = models.CharField(max_length=KEY_SIZE)
  81     key = models.CharField(max_length=255)
  82
  83     def __str__(self):
  84         return "Nonce %s for %s" % (self.key, self.consumer_key)
  85
  86
  87 class Consumer(models.Model):
  88     name = models.CharField(max_length=255)
  89     description = models.TextField()
  90     key = models.CharField(max_length=KEY_SIZE)
  91     secret = models.CharField(max_length=SECRET_SIZE)
  92     status = models.CharField(max_length=16, choices=CONSUMER_STATES, default='pending')
  93     user = models.ForeignKey(
  94         settings.AUTH_USER_MODEL, models.CASCADE,
  95         null=True, blank=True, related_name='consumers'
  96     )
  97
  98     def __str__(self):
  99         return "Consumer %s with key %s" % (self.name, self.key)
 100
 101
 102 class Token(models.Model):
 103     REQUEST = 1
 104     ACCESS = 2
 105     TOKEN_TYPES = ((REQUEST, 'Request'), (ACCESS, 'Access'))
 106
 107     key = models.CharField(max_length=KEY_SIZE)
 108     secret = models.CharField(max_length=SECRET_SIZE)
 109     token_type = models.IntegerField(choices=TOKEN_TYPES)
 110     timestamp = models.IntegerField()
 111     is_approved = models.BooleanField(default=False)
 112     user = models.ForeignKey(
 113         settings.AUTH_USER_MODEL, models.CASCADE,
 114         null=True, blank=True, related_name='tokens'
 115     )
 116     consumer = models.ForeignKey(Consumer, models.CASCADE)
 117
 118     def __str__(self):
 119         return "%s Token %s for %s" % (self.get_token_type_display(), self.key, self.consumer)