server/python/django2/renkanmanager/models.py
author durandn
Tue, 07 Jun 2016 10:44:41 +0200
changeset 611 f0f07e2b841f
parent 610 b9edc1c1538a
child 614 23416a833ca8
permissions -rw-r--r--
serverside: translation + timestamp handling + logging
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
587
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
     1
'''
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
     2
Created on Jul 17, 2014
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
     3
Reworked in December, 2015
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
     4
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
     5
@author: tc, nd
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
     6
'''
609
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
     7
import uuid, logging, json, datetime
587
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
     8
from django.conf import settings
609
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
     9
from django.db import models, transaction
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    10
from django.core.exceptions import ValidationError
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    11
from django.utils import timezone, dateparse
611
f0f07e2b841f serverside: translation + timestamp handling + logging
durandn
parents: 610
diff changeset
    12
from django.utils.translation import ugettext_lazy as _
587
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
    13
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
    14
609
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    15
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    16
logger = logging.getLogger(__name__)
587
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
    17
auth_user_model = getattr(settings, 'AUTH_USER_MODEL', 'auth.User')
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
    18
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
    19
class Workspace(models.Model):
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
    20
    
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
    21
    workspace_guid = models.CharField(max_length=1024, default=uuid.uuid4, unique=True, blank=False, null=False) # typically UUID
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
    22
    title = models.CharField(max_length=1024, null=True)
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
    23
    creator = models.ForeignKey(auth_user_model, blank=True, null=True, related_name="workspace_creator")
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
    24
    creation_date = models.DateTimeField(auto_now_add=True)
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
    25
    
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
    26
    @property
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
    27
    def renkan_count(self):
609
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    28
        return Renkan.objects.filter(workspace__workspace_guid=self.workspace_guid).count()
587
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
    29
    
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
    30
    class Meta:
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
    31
        app_label = 'renkanmanager'
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
    32
        permissions = (
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
    33
            ('view_workspace', 'Can view workspace'),
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
    34
        )
609
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    35
        
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    36
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    37
class RenkanManager(models.Manager):
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    38
    
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    39
    @transaction.atomic
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    40
    def create_renkan(self, creator, title='', content='', source_revision=None, workspace = None):
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    41
        new_renkan = Renkan()
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    42
        new_renkan.creator = creator
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    43
        new_renkan_workspace_guid = ""
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    44
        new_renkan_title = title
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    45
        new_renkan_content = content
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    46
        if workspace is not None:
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    47
            new_renkan.workspace = workspace
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    48
            new_renkan_workspace_guid = workspace.workspace_guid
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    49
        if source_revision is not None:
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    50
            new_renkan.source_revision = source_revision
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    51
            if not title:
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    52
                new_renkan_title = source_revision.title
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    53
            new_renkan_content = source_revision.content
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    54
        new_renkan.save()
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    55
        initial_revision = Revision(parent_renkan=new_renkan)
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    56
        initial_revision.modification_date = timezone.now()
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    57
        initial_revision.creator = creator
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    58
        initial_revision.last_updated_by = creator
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    59
        initial_revision.save() # saving once to set the creation date as we need it to fill the json content
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    60
        if initial_revision.modification_date != initial_revision.creation_date:
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    61
            initial_revision.modification_date = initial_revision.creation_date
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    62
        initial_revision.title = new_renkan_title if new_renkan_title else "Untitled Renkan"
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    63
        if new_renkan_content:
610
b9edc1c1538a reworked views and serializers to pass and take into account the "validation timestamp" to the model + refactored models to have a content validation method + adapted tests
durandn
parents: 609
diff changeset
    64
            new_renkan_content_dict = json.loads(new_renkan.validate_json_content(new_renkan_content))
609
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    65
            new_renkan_content_dict["created"] = str(initial_revision.creation_date)
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    66
            new_renkan_content_dict["updated"] = str(initial_revision.modification_date)
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    67
        else: 
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    68
            new_renkan_content_dict = {
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    69
                "id": str(new_renkan.renkan_guid),
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    70
                "title": initial_revision.title,
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    71
                "description": "",
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    72
                "created": str(initial_revision.creation_date),
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    73
                "updated": str(initial_revision.modification_date),
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    74
                "edges": [],
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    75
                "nodes": [],
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    76
                "users": [],
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    77
                "space_id": new_renkan_workspace_guid,
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    78
                "views": []
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    79
            }
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    80
        initial_revision.content = json.dumps(new_renkan_content_dict)
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    81
        initial_revision.save()
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    82
        return new_renkan
610
b9edc1c1538a reworked views and serializers to pass and take into account the "validation timestamp" to the model + refactored models to have a content validation method + adapted tests
durandn
parents: 609
diff changeset
    83
    
587
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
    84
class Renkan(models.Model):
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
    85
    
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
    86
    renkan_guid = models.CharField(max_length=256, default=uuid.uuid4, unique=True, blank=False, null=False) # typically UUID
609
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    87
    workspace = models.ForeignKey('Workspace', null=True, blank=True, to_field='workspace_guid')
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    88
    source_revision = models.ForeignKey('Revision', null=True, blank=True, related_name="renkan_source_revision", to_field='revision_guid', on_delete=models.SET_NULL)
587
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
    89
    creator = models.ForeignKey(auth_user_model, blank=True, null=True, related_name="renkan_creator")
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
    90
    creation_date = models.DateTimeField(auto_now_add=True)
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
    91
    state = models.IntegerField(default=1)
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
    92
    
609
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    93
    objects = RenkanManager()
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    94
    
587
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
    95
    @property
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
    96
    def revision_count(self):
609
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
    97
        return Revision.objects.filter(parent_renkan__renkan_guid=self.renkan_guid).count()
587
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
    98
    
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
    99
    @property
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
   100
    def is_copy(self):
609
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   101
        return bool(self.source_revision)
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   102
    
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   103
    # Current revision object or None if there is none
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   104
    @property
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   105
    def current_revision(self):
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   106
        return Revision.objects.filter(parent_renkan__renkan_guid=self.renkan_guid).order_by('-creation_date').first()
587
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
   107
    
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
   108
    # Current revision title
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
   109
    @property
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
   110
    def title(self):
609
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   111
        if self.current_revision:
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   112
            return self.current_revision.title
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   113
        else:
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   114
            return ''
587
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
   115
    
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
   116
    # Current revision content
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
   117
    @property
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
   118
    def content(self):
609
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   119
        if self.current_revision:
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   120
            return self.current_revision.content
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   121
        else:
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   122
            return ''
587
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
   123
    
611
f0f07e2b841f serverside: translation + timestamp handling + logging
durandn
parents: 610
diff changeset
   124
    def __unicode__(self):
f0f07e2b841f serverside: translation + timestamp handling + logging
durandn
parents: 610
diff changeset
   125
        return self.renkan_guid
f0f07e2b841f serverside: translation + timestamp handling + logging
durandn
parents: 610
diff changeset
   126
    
f0f07e2b841f serverside: translation + timestamp handling + logging
durandn
parents: 610
diff changeset
   127
    def __str__(self):
f0f07e2b841f serverside: translation + timestamp handling + logging
durandn
parents: 610
diff changeset
   128
        return self.renkan_guid
f0f07e2b841f serverside: translation + timestamp handling + logging
durandn
parents: 610
diff changeset
   129
    
609
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   130
    @transaction.atomic
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   131
    def save_renkan(self, updator, timestamp="", title="", content="", create_new_revision=False):
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   132
        """
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   133
            Saves over current revision or saves a new revision entirely. 
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   134
            Timestamp must be the current revision modification_date.
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   135
        """
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   136
        if (not timestamp) or ((self.current_revision is not None) and dateparse.parse_datetime(timestamp) < self.current_revision.modification_date):
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   137
            logger.error("SAVING RENKAN: provided timestamp is %r, which isn't current revision modification_date %r", timestamp, self.current_revision.modification_date)
611
f0f07e2b841f serverside: translation + timestamp handling + logging
durandn
parents: 610
diff changeset
   138
            raise ValidationError(_("Cannot save, provided timestamp is invalid"))
609
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   139
        else:
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   140
            dt_timestamp = dateparse.parse_datetime(timestamp)
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   141
        self.save()
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   142
        if create_new_revision:
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   143
            revision_to_update = Revision(parent_renkan=self)
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   144
            revision_to_update.creator = updator
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   145
        else:
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   146
            revision_to_update = Revision.objects.select_for_update().get(revision_guid=self.current_revision.revision_guid)
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   147
        
610
b9edc1c1538a reworked views and serializers to pass and take into account the "validation timestamp" to the model + refactored models to have a content validation method + adapted tests
durandn
parents: 609
diff changeset
   148
        updated_content = self.validate_json_content(content) if content else current_revision.content
b9edc1c1538a reworked views and serializers to pass and take into account the "validation timestamp" to the model + refactored models to have a content validation method + adapted tests
durandn
parents: 609
diff changeset
   149
        updated_content_dict = json.loads(updated_content)
609
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   150
        
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   151
        # If title is passed as arg to the method, update the title in the json
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   152
        if title:
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   153
            updated_title = title
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   154
            updated_content_dict["title"] = title
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   155
        # If it is not, we use the one in the json instead
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   156
        else:
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   157
            updated_title = updated_content_dict["title"] 
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   158
        
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   159
        revision_to_update.modification_date = timezone.now()
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   160
        updated_content_dict["updated"] = str(revision_to_update.modification_date)
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   161
        updated_content = json.dumps(updated_content_dict)  
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   162
        revision_to_update.title = updated_title
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   163
        revision_to_update.content = updated_content
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   164
        if dt_timestamp == revision_to_update.modification_date:
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   165
            revision_to_update.modification_date += datetime.resolution
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   166
        revision_to_update.last_updated_by = updator
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   167
        revision_to_update.save()
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   168
    
610
b9edc1c1538a reworked views and serializers to pass and take into account the "validation timestamp" to the model + refactored models to have a content validation method + adapted tests
durandn
parents: 609
diff changeset
   169
    def validate_json_content(self, content):
b9edc1c1538a reworked views and serializers to pass and take into account the "validation timestamp" to the model + refactored models to have a content validation method + adapted tests
durandn
parents: 609
diff changeset
   170
        """
b9edc1c1538a reworked views and serializers to pass and take into account the "validation timestamp" to the model + refactored models to have a content validation method + adapted tests
durandn
parents: 609
diff changeset
   171
            Checks that the json content is valid (keys and structures), raise a ValidationError if format is wrong or value is wrong (for ids),
b9edc1c1538a reworked views and serializers to pass and take into account the "validation timestamp" to the model + refactored models to have a content validation method + adapted tests
durandn
parents: 609
diff changeset
   172
            if a key is missing, autocompletes with the empty default value
b9edc1c1538a reworked views and serializers to pass and take into account the "validation timestamp" to the model + refactored models to have a content validation method + adapted tests
durandn
parents: 609
diff changeset
   173
            
b9edc1c1538a reworked views and serializers to pass and take into account the "validation timestamp" to the model + refactored models to have a content validation method + adapted tests
durandn
parents: 609
diff changeset
   174
            Returns the validated json string
b9edc1c1538a reworked views and serializers to pass and take into account the "validation timestamp" to the model + refactored models to have a content validation method + adapted tests
durandn
parents: 609
diff changeset
   175
        """
b9edc1c1538a reworked views and serializers to pass and take into account the "validation timestamp" to the model + refactored models to have a content validation method + adapted tests
durandn
parents: 609
diff changeset
   176
        try:
b9edc1c1538a reworked views and serializers to pass and take into account the "validation timestamp" to the model + refactored models to have a content validation method + adapted tests
durandn
parents: 609
diff changeset
   177
            content_to_validate_dict = json.loads(content)
b9edc1c1538a reworked views and serializers to pass and take into account the "validation timestamp" to the model + refactored models to have a content validation method + adapted tests
durandn
parents: 609
diff changeset
   178
        except ValueError:
b9edc1c1538a reworked views and serializers to pass and take into account the "validation timestamp" to the model + refactored models to have a content validation method + adapted tests
durandn
parents: 609
diff changeset
   179
            raise ValidationError("Provided content to create Renkan is not a JSON-serializable")
b9edc1c1538a reworked views and serializers to pass and take into account the "validation timestamp" to the model + refactored models to have a content validation method + adapted tests
durandn
parents: 609
diff changeset
   180
        if "id" not in content_to_validate_dict or content_to_validate_dict["id"] == "" :
b9edc1c1538a reworked views and serializers to pass and take into account the "validation timestamp" to the model + refactored models to have a content validation method + adapted tests
durandn
parents: 609
diff changeset
   181
            content_to_validate_dict["id"] = str(self.renkan_guid)
b9edc1c1538a reworked views and serializers to pass and take into account the "validation timestamp" to the model + refactored models to have a content validation method + adapted tests
durandn
parents: 609
diff changeset
   182
        if "title" not in content_to_validate_dict:
b9edc1c1538a reworked views and serializers to pass and take into account the "validation timestamp" to the model + refactored models to have a content validation method + adapted tests
durandn
parents: 609
diff changeset
   183
            content_to_validate_dict["title"] = ""
b9edc1c1538a reworked views and serializers to pass and take into account the "validation timestamp" to the model + refactored models to have a content validation method + adapted tests
durandn
parents: 609
diff changeset
   184
        if "description" not in content_to_validate_dict:
b9edc1c1538a reworked views and serializers to pass and take into account the "validation timestamp" to the model + refactored models to have a content validation method + adapted tests
durandn
parents: 609
diff changeset
   185
            content_to_validate_dict["description"] = ""
b9edc1c1538a reworked views and serializers to pass and take into account the "validation timestamp" to the model + refactored models to have a content validation method + adapted tests
durandn
parents: 609
diff changeset
   186
        if "created" not in content_to_validate_dict:
b9edc1c1538a reworked views and serializers to pass and take into account the "validation timestamp" to the model + refactored models to have a content validation method + adapted tests
durandn
parents: 609
diff changeset
   187
            content_to_validate_dict["description"] = ""
b9edc1c1538a reworked views and serializers to pass and take into account the "validation timestamp" to the model + refactored models to have a content validation method + adapted tests
durandn
parents: 609
diff changeset
   188
        if "updated" not in content_to_validate_dict:
b9edc1c1538a reworked views and serializers to pass and take into account the "validation timestamp" to the model + refactored models to have a content validation method + adapted tests
durandn
parents: 609
diff changeset
   189
            content_to_validate_dict["description"] = ""
b9edc1c1538a reworked views and serializers to pass and take into account the "validation timestamp" to the model + refactored models to have a content validation method + adapted tests
durandn
parents: 609
diff changeset
   190
        expected_workspace_id = str(self.workspace.workspace_guid) if self.workspace is not None else ""
b9edc1c1538a reworked views and serializers to pass and take into account the "validation timestamp" to the model + refactored models to have a content validation method + adapted tests
durandn
parents: 609
diff changeset
   191
        if "space_id" not in content_to_validate_dict:
b9edc1c1538a reworked views and serializers to pass and take into account the "validation timestamp" to the model + refactored models to have a content validation method + adapted tests
durandn
parents: 609
diff changeset
   192
            content_to_validate_dict["space_id"] = expected_workspace_id
b9edc1c1538a reworked views and serializers to pass and take into account the "validation timestamp" to the model + refactored models to have a content validation method + adapted tests
durandn
parents: 609
diff changeset
   193
        if "nodes" not in content_to_validate_dict:
b9edc1c1538a reworked views and serializers to pass and take into account the "validation timestamp" to the model + refactored models to have a content validation method + adapted tests
durandn
parents: 609
diff changeset
   194
            content_to_validate_dict["nodes"] = []
b9edc1c1538a reworked views and serializers to pass and take into account the "validation timestamp" to the model + refactored models to have a content validation method + adapted tests
durandn
parents: 609
diff changeset
   195
        if "edges" not in content_to_validate_dict:
b9edc1c1538a reworked views and serializers to pass and take into account the "validation timestamp" to the model + refactored models to have a content validation method + adapted tests
durandn
parents: 609
diff changeset
   196
            content_to_validate_dict["edges"] = []
b9edc1c1538a reworked views and serializers to pass and take into account the "validation timestamp" to the model + refactored models to have a content validation method + adapted tests
durandn
parents: 609
diff changeset
   197
        if "views" not in content_to_validate_dict:
b9edc1c1538a reworked views and serializers to pass and take into account the "validation timestamp" to the model + refactored models to have a content validation method + adapted tests
durandn
parents: 609
diff changeset
   198
            content_to_validate_dict["views"] = []
b9edc1c1538a reworked views and serializers to pass and take into account the "validation timestamp" to the model + refactored models to have a content validation method + adapted tests
durandn
parents: 609
diff changeset
   199
        if "users" not in content_to_validate_dict:
b9edc1c1538a reworked views and serializers to pass and take into account the "validation timestamp" to the model + refactored models to have a content validation method + adapted tests
durandn
parents: 609
diff changeset
   200
            content_to_validate_dict["users"] = []
b9edc1c1538a reworked views and serializers to pass and take into account the "validation timestamp" to the model + refactored models to have a content validation method + adapted tests
durandn
parents: 609
diff changeset
   201
        
b9edc1c1538a reworked views and serializers to pass and take into account the "validation timestamp" to the model + refactored models to have a content validation method + adapted tests
durandn
parents: 609
diff changeset
   202
        if type(content_to_validate_dict["nodes"]) is not list:
b9edc1c1538a reworked views and serializers to pass and take into account the "validation timestamp" to the model + refactored models to have a content validation method + adapted tests
durandn
parents: 609
diff changeset
   203
            raise ValidationError("Provided content has an invalid 'nodes' key: not a list")
b9edc1c1538a reworked views and serializers to pass and take into account the "validation timestamp" to the model + refactored models to have a content validation method + adapted tests
durandn
parents: 609
diff changeset
   204
        if type(content_to_validate_dict["edges"]) is not list:
b9edc1c1538a reworked views and serializers to pass and take into account the "validation timestamp" to the model + refactored models to have a content validation method + adapted tests
durandn
parents: 609
diff changeset
   205
            raise ValidationError("Provided content has an invalid 'edges' key: not a list")
b9edc1c1538a reworked views and serializers to pass and take into account the "validation timestamp" to the model + refactored models to have a content validation method + adapted tests
durandn
parents: 609
diff changeset
   206
        if type(content_to_validate_dict["views"]) is not list:
b9edc1c1538a reworked views and serializers to pass and take into account the "validation timestamp" to the model + refactored models to have a content validation method + adapted tests
durandn
parents: 609
diff changeset
   207
            raise ValidationError("Provided content has an invalid 'views' key: not a list")
b9edc1c1538a reworked views and serializers to pass and take into account the "validation timestamp" to the model + refactored models to have a content validation method + adapted tests
durandn
parents: 609
diff changeset
   208
        if type(content_to_validate_dict["users"]) is not list:
b9edc1c1538a reworked views and serializers to pass and take into account the "validation timestamp" to the model + refactored models to have a content validation method + adapted tests
durandn
parents: 609
diff changeset
   209
            raise ValidationError("Provided content has an invalid 'users' key: not a list")
b9edc1c1538a reworked views and serializers to pass and take into account the "validation timestamp" to the model + refactored models to have a content validation method + adapted tests
durandn
parents: 609
diff changeset
   210
        return json.dumps(content_to_validate_dict)
b9edc1c1538a reworked views and serializers to pass and take into account the "validation timestamp" to the model + refactored models to have a content validation method + adapted tests
durandn
parents: 609
diff changeset
   211
        
609
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   212
    @transaction.atomic
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   213
    def delete(self):
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   214
        """
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   215
            Deleting a renkan also deletes every related revision
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   216
        """
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   217
        renkan_revisions = Revision.objects.filter(parent_renkan__renkan_guid = self.renkan_guid)
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   218
        for child_revision in renkan_revisions:
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   219
            child_revision.delete()
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   220
        super(Renkan, self).delete()
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   221
        
587
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
   222
    class Meta:
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
   223
        app_label = 'renkanmanager'
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
   224
        permissions = (
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
   225
            ('view_renkan', 'Can view renkan'),
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
   226
        )
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
   227
609
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   228
        
587
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
   229
class Revision(models.Model):
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
   230
    
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
   231
    revision_guid = models.CharField(max_length=256, default=uuid.uuid4, unique=True) # typically UUID
609
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   232
    parent_renkan = models.ForeignKey('Renkan', null=False, blank=False, to_field='renkan_guid')
588
95536fa18d0d Minor adjustements to properly interact with Renkan client
durandn
parents: 587
diff changeset
   233
    title = models.CharField(max_length=1024, null=True, blank=True)
587
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
   234
    content = models.TextField(blank=True, null=True)
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
   235
    creator = models.ForeignKey(auth_user_model, blank=True, null=True, related_name="revision_creator")
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
   236
    last_updated_by = models.ForeignKey(auth_user_model, blank=True, null=True, related_name="revision_last_updated_by")
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
   237
    creation_date = models.DateTimeField(auto_now_add=True)
609
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   238
    modification_date = models.DateTimeField()
587
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
   239
    
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
   240
    @property
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
   241
    def is_current_revision(self):
609
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   242
        # No need to check if parent_renkan.current_revision is not None, as it won't be if we're calling from a revision
854a027c80ff models refactoring to use ForeignKey fields + associated migrations
durandn
parents: 589
diff changeset
   243
        return self.parent_renkan.current_revision.revision_guid == self.revision_guid
587
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
   244
    
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
   245
    class Meta:
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
   246
        app_label = 'renkanmanager'
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
   247
        permissions = (
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
   248
            ('view_revision', 'Can view revision'),
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
   249
        )       
fb0041aa74d3 transfer work on renkanmanager into a renkan/server/python2 folder: reworked models, implemented simple API basic permissions, wrote tests
durandn
parents:
diff changeset
   250