stage2/models.py

   1 # -*- coding: utf-8 -*-
   2 import os
   3 import random
   4 import string
   5
   6 from django.contrib.auth.models import User
   7 from django.core.urlresolvers import reverse
   8 from django.db import models
   9 from django.db.models.signals import post_save
  10 from django.dispatch import receiver
  11 from django.utils.translation import ugettext_lazy as _
  12 from django.utils import timezone
  13 from jsonfield import JSONField
  14
  15 from contact.models import Contact
  16
  17
  18 class Participant(models.Model):
  19     contact = models.ForeignKey(Contact, verbose_name=_('contact'), null=True)
  20     key = models.CharField(_('key'), max_length=30, unique=True)
  21     first_name = models.CharField(_('first name'), max_length=100)
  22     last_name = models.CharField(_('last_name'), max_length=100)
  23     email = models.EmailField(_('email'), max_length=100, unique=True)
  24     key_sent = models.BooleanField(_('key sent'), default=False)
  25     complete_set = models.BooleanField(default=False)
  26
  27     class Meta:
  28         verbose_name = _('participant')
  29         verbose_name_plural = _('participants')
  30
  31     def __unicode__(self):
  32         return ', '.join((self.last_name, self.first_name, self.email))
  33
  34     # copy-paste from wtem
  35     @classmethod
  36     def generate_key(cls):
  37         key = ''
  38         while not key or key in [record['key'] for record in cls.objects.values('key')]:
  39             key = ''.join(random.choice(string.ascii_uppercase + string.ascii_lowercase + string.digits)
  40                           for i in range(30))
  41         return key
  42
  43     # copy-paste from wtem
  44     @classmethod
  45     def create(cls, first_name, last_name, email, key=None, contact=None):
  46         return cls.objects.create(
  47             contact=contact,
  48             key=key if key else cls.generate_key(),
  49             first_name=first_name,
  50             last_name=last_name,
  51             email=email)
  52
  53     def check(self, key):
  54         return key == self.key
  55
  56     def score(self):
  57         return sum(answer.score() for answer in self.answer_set.all())
  58
  59
  60 class Assignment(models.Model):
  61     title = models.CharField(_('title'), max_length=128)
  62     content = models.TextField(_('content'))
  63     content_url = models.URLField(_('URL'))
  64     deadline = models.DateTimeField(_('deadline'))
  65     max_points = models.IntegerField(_('max points'))
  66     experts = models.ManyToManyField(User, verbose_name=_('experts'), related_name='stage2_assignments')
  67     arbiters = models.ManyToManyField(
  68         User, blank=True, verbose_name=_('arbiters'), related_name='stage2_arbitrated')
  69     file_descriptions = JSONField(_('file descriptions'))
  70
  71     class Meta:
  72         ordering = ['deadline', 'title']
  73         verbose_name = _('assignment')
  74         verbose_name_plural = _('assignments')
  75
  76     def __unicode__(self):
  77         return self.title
  78
  79     def available_answers(self, expert):
  80         answers = self.answer_set.exclude(mark__expert=expert).exclude(complete=True)\
  81             .filter(participant__complete_set=True)
  82         if expert in self.arbiters.all():
  83             answers = answers.filter(need_arbiter=True)
  84         return answers
  85
  86     def is_active(self):
  87         return self.deadline >= timezone.now()
  88
  89
  90 class Answer(models.Model):
  91     participant = models.ForeignKey(Participant)
  92     assignment = models.ForeignKey(Assignment)
  93     # useful redundancy
  94     complete = models.BooleanField(default=False)
  95     need_arbiter = models.BooleanField(default=False)
  96
  97     class Meta:
  98         unique_together = ['participant', 'assignment']
  99
 100     def update_complete(self):
 101         marks = self.mark_set.all()
 102         if len(marks) < 2:
 103             complete = False
 104             need_arbiter = False
 105         elif len(marks) == 2:
 106             mark1, mark2 = marks
 107             complete = abs(mark1.points - mark2.points) < 0.2 * self.assignment.max_points
 108             need_arbiter = not complete
 109         else:
 110             complete = True
 111             need_arbiter = False
 112         self.complete = complete
 113         self.need_arbiter = need_arbiter
 114         self.save()
 115
 116     def score(self):
 117         marks = self.mark_set.all()
 118         if len(marks) < 2:
 119             return None
 120         return self.mark_set.aggregate(models.Avg('points'))
 121
 122
 123 def attachment_path(instance, filename):
 124     answer = instance.answer
 125     return 'stage2/attachment/%s/%s/%s/%s' % (answer.participant_id, answer.assignment_id, instance.file_no, filename)
 126
 127
 128 class Attachment(models.Model):
 129     answer = models.ForeignKey(Answer)
 130     file_no = models.IntegerField()
 131     file = models.FileField(upload_to=attachment_path)
 132
 133     class Meta:
 134         ordering = ['file_no']
 135
 136     def filename(self):
 137         return os.path.basename(self.file.name)
 138
 139     def download_url(self):
 140         return reverse(
 141             'stage2_participant_file',
 142             args=(self.answer.assignment_id, self.file_no,
 143                   self.answer.participant_id, self.answer.participant.key))
 144
 145     def expert_download_url(self):
 146         return reverse('stage2_expert_download', args=[self.id])
 147
 148
 149 class Mark(models.Model):
 150     expert = models.ForeignKey(User)
 151     answer = models.ForeignKey(Answer)
 152     points = models.DecimalField(verbose_name=_('points'), max_digits=3, decimal_places=1)
 153
 154     class Meta:
 155         unique_together = ['expert', 'answer']
 156
 157
 158 @receiver(post_save, sender=Mark, dispatch_uid='update_answer')
 159 def update_answer(sender, **kwargs):
 160     mark = kwargs['instance']
 161     mark.answer.update_complete()