Start updating docs.
[wolnelektury.git] / 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 ugettext_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             else:
34                 category = instance.category
35         else:
36             category = None
37         content_type = ContentType.objects.get_for_model(sender)
38         Deleted.objects.create(
39             content_type=content_type, object_id=instance.id, created_at=instance.created_at, category=category,
40             slug=instance.slug)
41 pre_delete.connect(_pre_delete_handler)
42
43
44 class BookUserData(models.Model):
45     book = models.ForeignKey(Book, models.CASCADE)
46     user = models.ForeignKey(User, models.CASCADE)
47     complete = models.BooleanField(default=False)
48     last_changed = models.DateTimeField(auto_now=True)
49
50     @property
51     def state(self):
52         return 'complete' if self.complete else 'reading'
53
54     @classmethod
55     def update(cls, book, user, state):
56         instance, created = cls.objects.get_or_create(book=book, user=user)
57         instance.complete = state == 'complete'
58         instance.save()
59         return instance
60 from django.conf import settings
61
62
63 KEY_SIZE = 18
64 SECRET_SIZE = 32
65
66 CONSUMER_STATES = (
67     ('pending', 'Pending approval'),
68     ('accepted', 'Accepted'),
69     ('canceled', 'Canceled'),
70 )
71
72
73 class Nonce(models.Model):
74     token_key = models.CharField(max_length=KEY_SIZE)
75     consumer_key = models.CharField(max_length=KEY_SIZE)
76     key = models.CharField(max_length=255)
77
78     def __str__(self):
79         return "Nonce %s for %s" % (self.key, self.consumer_key)
80
81
82 class Consumer(models.Model):
83     name = models.CharField(max_length=255)
84     description = models.TextField()
85     key = models.CharField(max_length=KEY_SIZE)
86     secret = models.CharField(max_length=SECRET_SIZE)
87     status = models.CharField(max_length=16, choices=CONSUMER_STATES, default='pending')
88     user = models.ForeignKey(settings.AUTH_USER_MODEL, models.CASCADE, null=True, blank=True, related_name='consumers')
89
90     def __str__(self):
91         return "Consumer %s with key %s" % (self.name, self.key)
92
93
94 class Token(models.Model):
95     REQUEST = 1
96     ACCESS = 2
97     TOKEN_TYPES = ((REQUEST, 'Request'), (ACCESS, 'Access'))
98
99     key = models.CharField(max_length=KEY_SIZE)
100     secret = models.CharField(max_length=SECRET_SIZE)
101     token_type = models.IntegerField(choices=TOKEN_TYPES)
102     timestamp = models.IntegerField()
103     is_approved = models.BooleanField(default=False)
104     user = models.ForeignKey(settings.AUTH_USER_MODEL, models.CASCADE, null=True, blank=True, related_name='tokens')
105     consumer = models.ForeignKey(Consumer, models.CASCADE)
106
107     def __str__(self):
108         return "%s Token %s for %s" % (self.get_token_type_display(), self.key, self.consumer)