stage2/models.py

   1 # -*- coding: utf-8 -*-
   2 import os
   3 import random
   4 import string
   5
   6 from django.conf import settings
   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(
  67         settings.AUTH_USER_MODEL, verbose_name=_('experts'), related_name='stage2_assignments')
  68     arbiters = models.ManyToManyField(
  69         settings.AUTH_USER_MODEL, blank=True, verbose_name=_('arbiters'), related_name='stage2_arbitrated')
  70     supervisors = models.ManyToManyField(
  71         settings.AUTH_USER_MODEL, verbose_name=_('supervisors'), related_name='stage2_supervised')
  72     file_descriptions = JSONField(_('file descriptions'), default=[], blank=True)
  73     field_descriptions = JSONField(_('field descriptions'), default=[], blank=True)
  74
  75     class Meta:
  76         ordering = ['deadline', 'title']
  77         verbose_name = _('assignment')
  78         verbose_name_plural = _('assignments')
  79
  80     def __unicode__(self):
  81         return self.title
  82
  83     def available_answers(self, expert):
  84         answers = self.answer_set.exclude(mark__expert=expert).filter(participant__complete_set=True)
  85         if expert not in self.supervisors.all():
  86             answers = answers.exclude(complete=True)
  87         if expert in self.arbiters.all():
  88             answers = answers.filter(need_arbiter=True)
  89         return answers
  90
  91     def is_active(self):
  92         return self.deadline >= timezone.now()
  93
  94
  95 class Answer(models.Model):
  96     participant = models.ForeignKey(Participant)
  97     assignment = models.ForeignKey(Assignment)
  98     field_values = JSONField(_('field values'), default={})
  99     # useful redundancy
 100     complete = models.BooleanField(default=False)
 101     need_arbiter = models.BooleanField(default=False)
 102
 103     class Meta:
 104         unique_together = ['participant', 'assignment']
 105
 106     def update_complete(self):
 107         marks = self.mark_set.all()
 108         if len(marks) < 2:
 109             complete = False
 110             need_arbiter = False
 111         elif len(marks) == 2:
 112             mark1, mark2 = marks
 113             complete = abs(mark1.points - mark2.points) < 0.2 * self.assignment.max_points
 114             need_arbiter = not complete
 115         else:
 116             complete = True
 117             need_arbiter = False
 118         self.complete = complete
 119         self.need_arbiter = need_arbiter
 120         self.save()
 121
 122     def score(self):
 123         marks = self.mark_set.all()
 124         if len(marks) < 2:
 125             return None
 126         return self.mark_set.aggregate(avg=models.Avg('points'))['avg']
 127
 128
 129 class FieldOptionSet(models.Model):
 130     name = models.CharField(verbose_name=_('nazwa'), max_length=32, db_index=True)
 131
 132     class Meta:
 133         verbose_name = _('option set')
 134         verbose_name_plural = _('option sets')
 135
 136     def __unicode__(self):
 137         return self.name
 138
 139     def choices(self, answer):
 140         return [('', '--------')] + [
 141             (option.id, option.value)
 142             for option in self.fieldoption_set.extra(
 143                 where=['answer_id is null or answer_id = %s'],
 144                 params=[answer.id])]
 145
 146
 147 class FieldOption(models.Model):
 148     set = models.ForeignKey(FieldOptionSet, verbose_name=_('zestaw'))
 149     value = models.CharField(verbose_name=_('value'), max_length=255)
 150     answer = models.ForeignKey(Answer, verbose_name=_('answer'), null=True, blank=True)
 151
 152     class Meta:
 153         ordering = ['set', 'value']
 154         verbose_name = _('option')
 155         verbose_name_plural = _('options')
 156
 157     def __unicode__(self):
 158         return self.value
 159
 160
 161 def attachment_path(instance, filename):
 162     answer = instance.answer
 163     return 'stage2/attachment/%s/%s/%s/%s' % (answer.participant_id, answer.assignment_id, instance.file_no, filename)
 164
 165
 166 class Attachment(models.Model):
 167     answer = models.ForeignKey(Answer)
 168     file_no = models.IntegerField()
 169     file = models.FileField(upload_to=attachment_path)
 170
 171     class Meta:
 172         ordering = ['file_no']
 173
 174     def filename(self):
 175         return os.path.basename(self.file.name)
 176
 177     def download_url(self):
 178         return reverse(
 179             'stage2_participant_file',
 180             args=(self.answer.assignment_id, self.file_no,
 181                   self.answer.participant_id, self.answer.participant.key))
 182
 183     def expert_download_url(self):
 184         return reverse('stage2_expert_download', args=[self.id])
 185
 186
 187 class Mark(models.Model):
 188     expert = models.ForeignKey(settings.AUTH_USER_MODEL)
 189     answer = models.ForeignKey(Answer)
 190     points = models.DecimalField(verbose_name=_('points'), max_digits=3, decimal_places=1)
 191
 192     class Meta:
 193         unique_together = ['expert', 'answer']
 194
 195
 196 @receiver(post_save, sender=Mark, dispatch_uid='update_answer')
 197 def update_answer(sender, **kwargs):
 198     mark = kwargs['instance']
 199     mark.answer.update_complete()