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.html import format_html, strip_tags
  12 from django.utils.translation import ugettext_lazy as _
  13 from django.utils import timezone
  14 from jsonfield import JSONField
  15
  16 from contact.models import Contact
  17
  18
  19 class Participant(models.Model):
  20     contact = models.ForeignKey(Contact, verbose_name=_('contact'), null=True)
  21     key = models.CharField(_('key'), max_length=30, unique=True)
  22     first_name = models.CharField(_('first name'), max_length=100)
  23     last_name = models.CharField(_('last_name'), max_length=100)
  24     email = models.EmailField(_('email'), max_length=100, unique=True)
  25     key_sent = models.BooleanField(_('key sent'), default=False)
  26     complete_set = models.BooleanField(default=False)
  27
  28     class Meta:
  29         verbose_name = _('participant')
  30         verbose_name_plural = _('participants')
  31
  32     def __unicode__(self):
  33         return ', '.join((self.last_name, self.first_name, self.email))
  34
  35     # copy-paste from wtem
  36     @classmethod
  37     def generate_key(cls):
  38         key = ''
  39         while not key or key in [record['key'] for record in cls.objects.values('key')]:
  40             key = ''.join(random.choice(string.ascii_uppercase + string.ascii_lowercase + string.digits)
  41                           for i in range(30))
  42         return key
  43
  44     # copy-paste from wtem
  45     @classmethod
  46     def create(cls, first_name, last_name, email, key=None, contact=None):
  47         return cls.objects.create(
  48             contact=contact,
  49             key=key if key else cls.generate_key(),
  50             first_name=first_name,
  51             last_name=last_name,
  52             email=email)
  53
  54     def check(self, key):
  55         return key == self.key
  56
  57     def score(self):
  58         return sum(answer.score() for answer in self.answer_set.all())
  59
  60
  61 class Assignment(models.Model):
  62     title = models.CharField(_('title'), max_length=128)
  63     content = models.TextField(_('content'))
  64     content_url = models.URLField(_('URL'))
  65     deadline = models.DateTimeField(_('deadline'))
  66     max_points = models.IntegerField(_('max points'))
  67     experts = models.ManyToManyField(
  68         settings.AUTH_USER_MODEL, verbose_name=_('experts'), related_name='stage2_assignments')
  69     arbiters = models.ManyToManyField(
  70         settings.AUTH_USER_MODEL, blank=True, verbose_name=_('arbiters'), related_name='stage2_arbitrated')
  71     supervisors = models.ManyToManyField(
  72         settings.AUTH_USER_MODEL, verbose_name=_('supervisors'), related_name='stage2_supervised')
  73     file_descriptions = JSONField(_('file descriptions'), default=[], blank=True)
  74     field_descriptions = JSONField(_('field descriptions'), default=[], blank=True)
  75
  76     class Meta:
  77         ordering = ['deadline', 'title']
  78         verbose_name = _('assignment')
  79         verbose_name_plural = _('assignments')
  80
  81     def __unicode__(self):
  82         return self.title
  83
  84     def available_answers(self, expert, marked=False):
  85         if marked:
  86             return self.answer_set.filter(mark__expert=expert).order_by('id').distinct('id')
  87         answers = self.answer_set.exclude(mark__expert=expert)
  88         assigned_to_expert = self.answer_set.filter(experts=expert).exists()
  89         is_supervisor = expert in self.supervisors.all()
  90         is_arbiter = expert in self.arbiters.all()
  91         if assigned_to_expert:
  92             expert_answers = answers.filter(experts=expert)
  93             if expert_answers or not is_arbiter:
  94                 answers = expert_answers
  95         answers = answers.extra(where=[
  96             "field_values::text ~ ': *\"[^\"]+\"' "
  97             "OR EXISTS (SELECT id FROM stage2_attachment WHERE answer_id = stage2_answer.id) "
  98             "OR EXISTS (SELECT id FROM stage2_fieldoption WHERE answer_id = stage2_answer.id)"])
  99         if not is_supervisor:
 100             answers = answers.exclude(complete=True)
 101         if not is_supervisor or not self.is_active():
 102             answers = answers.filter(participant__complete_set=True)
 103         if is_arbiter:
 104             answers = answers.filter(need_arbiter=True)
 105         return answers
 106
 107     def field_counts(self, answers):
 108         for field_desc in self.field_descriptions:
 109             field_name, params = field_desc
 110             if params['type'] == 'options':
 111                 field_count = FieldOption.objects.filter(
 112                     answer__in=list(answers), set__name=params['option_set']).count()
 113             else:  # text, link
 114                 field_count = sum(1 for answer in answers if answer.field_values.get(field_name))
 115             yield field_name, field_count
 116
 117     def expert_counts(self):
 118         for expert in self.experts.all():
 119             assigned_count = self.answer_set.filter(experts=expert).count()
 120             marked_count = self.available_answers(expert, marked=True).count()
 121             if assigned_count != 0 or marked_count != 0:
 122                 yield expert, marked_count, assigned_count
 123
 124     def complete_answers(self):
 125         return self.answer_set.filter(complete=True)
 126
 127     def needing_arbiter(self):
 128         return self.answer_set.filter(need_arbiter=True)
 129
 130     def is_active(self):
 131         return self.deadline >= timezone.now()
 132
 133
 134 class MarkCriterion(models.Model):
 135     assignment = models.ForeignKey(Assignment)
 136     order = models.IntegerField()
 137     label = models.CharField(max_length=1024)
 138     max_points = models.IntegerField()
 139
 140     class Meta:
 141         ordering = ['order']
 142         unique_together = ['assignment', 'order']
 143
 144     def __unicode__(self):
 145         return strip_tags(self.form_label())
 146
 147     def form_label(self):
 148         return '%s. %s' % (self.order, self.label)
 149
 150
 151 class Answer(models.Model):
 152     participant = models.ForeignKey(Participant)
 153     assignment = models.ForeignKey(Assignment)
 154     field_values = JSONField(_('field values'), default={})
 155     experts = models.ManyToManyField(
 156         settings.AUTH_USER_MODEL, verbose_name=_('experts'), related_name='stage2_assigned_answers')
 157     # useful redundancy
 158     complete = models.BooleanField(default=False)
 159     need_arbiter = models.BooleanField(default=False)
 160
 161     class Meta:
 162         unique_together = ['participant', 'assignment']
 163
 164     def fields(self):
 165         for field_desc in self.assignment.field_descriptions:
 166             field_name, params = field_desc
 167             if params['type'] == 'options':
 168                 option = self.fieldoption_set.filter(set__name=params['option_set'])
 169                 value = option.get().value if option else '--------'
 170             else:  # text, link
 171                 value = self.field_values.get(field_name, '')
 172             if params['type'] == 'link':
 173                 value = format_html(u'<a href="{url}">{url}</a>', url=value)
 174             yield field_name, value
 175
 176     def total_points(self):
 177         criterion_count = self.assignment.markcriterion_set.count()
 178         for expert in self.experts.all():
 179             marks = self.mark_set.filter(expert=expert)
 180             if len(marks) == criterion_count:
 181                 yield sum(mark.points for mark in marks)
 182
 183     def update_complete(self):
 184         total_points = list(self.total_points())
 185         if len(total_points) < 2:
 186             complete = False
 187             need_arbiter = False
 188         elif len(total_points) == 2:
 189             points1, points2 = total_points
 190             complete = abs(points1 - points2) < 0.2 * self.assignment.max_points
 191             need_arbiter = not complete
 192         else:
 193             complete = True
 194             need_arbiter = False
 195         self.complete = complete
 196         self.need_arbiter = need_arbiter
 197         self.save()
 198
 199     def score(self):
 200         total_marks = list(self.total_points())
 201         if len(total_marks) < 2:
 202             return None
 203         return sum(total_marks) / len(total_marks)
 204
 205     # unrelated to `complete' attribute, but whatever
 206     def is_complete(self):
 207         file_count = len(self.assignment.file_descriptions)
 208         field_count = len(self.assignment.field_descriptions)
 209         if self.attachment_set.count() < file_count:
 210             return False
 211         if self.fieldoption_set.count() + sum(1 for k, v in self.field_values.iteritems() if v) < field_count:
 212             return False
 213         return True
 214
 215
 216 class FieldOptionSet(models.Model):
 217     name = models.CharField(verbose_name=_('nazwa'), max_length=32, db_index=True)
 218
 219     class Meta:
 220         verbose_name = _('option set')
 221         verbose_name_plural = _('option sets')
 222
 223     def __unicode__(self):
 224         return self.name
 225
 226     def choices(self, answer):
 227         return [('', '--------')] + [
 228             (option.id, option.value)
 229             for option in self.fieldoption_set.extra(
 230                 where=['answer_id is null or answer_id = %s'],
 231                 params=[answer.id])]
 232
 233
 234 class FieldOption(models.Model):
 235     set = models.ForeignKey(FieldOptionSet, verbose_name=_('zestaw'))
 236     value = models.CharField(verbose_name=_('value'), max_length=255)
 237     answer = models.ForeignKey(Answer, verbose_name=_('answer'), null=True, blank=True)
 238
 239     class Meta:
 240         ordering = ['set', 'value']
 241         verbose_name = _('option')
 242         verbose_name_plural = _('options')
 243
 244     def __unicode__(self):
 245         return self.value
 246
 247
 248 def attachment_path(instance, filename):
 249     answer = instance.answer
 250     return 'stage2/attachment/%s/%s/%s/%s' % (answer.participant_id, answer.assignment_id, instance.file_no, filename)
 251
 252
 253 class Attachment(models.Model):
 254     answer = models.ForeignKey(Answer)
 255     file_no = models.IntegerField()
 256     file = models.FileField(upload_to=attachment_path)
 257
 258     class Meta:
 259         ordering = ['file_no']
 260
 261     def filename(self):
 262         return os.path.basename(self.file.name)
 263
 264     def download_url(self):
 265         return reverse(
 266             'stage2_participant_file',
 267             args=(self.answer.assignment_id, self.file_no,
 268                   self.answer.participant_id, self.answer.participant.key))
 269
 270     def expert_download_url(self):
 271         return reverse('stage2_expert_download', args=[self.id])
 272
 273
 274 class Mark(models.Model):
 275     expert = models.ForeignKey(settings.AUTH_USER_MODEL)
 276     answer = models.ForeignKey(Answer)
 277     criterion = models.ForeignKey(MarkCriterion)
 278     points = models.DecimalField(verbose_name=_('points'), max_digits=3, decimal_places=1)
 279
 280     class Meta:
 281         unique_together = ['expert', 'answer', 'criterion']
 282
 283
 284 @receiver(post_save, sender=Mark, dispatch_uid='update_answer')
 285 def update_answer(sender, **kwargs):
 286     mark = kwargs['instance']
 287     mark.answer.update_complete()