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