models.py 24.4 KB
Newer Older
Jeremy Kerr's avatar
Jeremy Kerr committed
1 2
# Patchwork - automated patch tracking system
# Copyright (C) 2008 Jeremy Kerr <jk@ozlabs.org>
3
# Copyright (C) 2015 Intel Corporation
Jeremy Kerr's avatar
Jeremy Kerr committed
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
#
# This file is part of the Patchwork package.
#
# Patchwork is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# Patchwork is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Patchwork; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

from django.db import models
22
from django.db.models import Q
23
import django.dispatch
24
from django.contrib import auth
Jeremy Kerr's avatar
Jeremy Kerr committed
25 26 27
from django.contrib.auth.models import User
from django.core.urlresolvers import reverse
from django.contrib.sites.models import Site
28
from django.conf import settings
Jeremy Kerr's avatar
Jeremy Kerr committed
29 30
from django.utils.functional import cached_property
from patchwork.parser import hash_patch, extract_tags
31
import jsonfield
Jeremy Kerr's avatar
Jeremy Kerr committed
32 33 34 35

import re
import datetime, time
import random
Jeremy Kerr's avatar
Jeremy Kerr committed
36
from collections import Counter, OrderedDict
37

Jeremy Kerr's avatar
Jeremy Kerr committed
38 39
class Person(models.Model):
    email = models.CharField(max_length=255, unique = True)
40
    name = models.CharField(max_length=255, null = True, blank = True)
41 42
    user = models.ForeignKey(User, null = True, blank = True,
            on_delete = models.SET_NULL)
Jeremy Kerr's avatar
Jeremy Kerr committed
43

44
    def display_name(self):
Jeremy Kerr's avatar
Jeremy Kerr committed
45
        if self.name:
46
            return self.name
Jeremy Kerr's avatar
Jeremy Kerr committed
47 48 49
        else:
            return self.email

50 51 52 53 54 55
    def email_name(self):
        if (self.name):
            return "%s <%s>" % (self.name, self.email)
        else:
            return self.email

56 57 58
    def __unicode__(self):
        return self.display_name()

Jeremy Kerr's avatar
Jeremy Kerr committed
59
    def link_to_user(self, user):
60
        self.name = user.profile.name()
Jeremy Kerr's avatar
Jeremy Kerr committed
61 62 63 64 65 66 67 68
        self.user = user

    class Meta:
        verbose_name_plural = 'People'

class Project(models.Model):
    linkname = models.CharField(max_length=255, unique=True)
    name = models.CharField(max_length=255, unique=True)
69
    listid = models.CharField(max_length=255)
Jeremy Kerr's avatar
Jeremy Kerr committed
70
    listemail = models.CharField(max_length=200)
Simo Sorce's avatar
Simo Sorce committed
71 72 73
    web_url = models.CharField(max_length=2000, blank=True)
    scm_url = models.CharField(max_length=2000, blank=True)
    webscm_url = models.CharField(max_length=2000, blank=True)
Jeremy Kerr's avatar
Jeremy Kerr committed
74
    send_notifications = models.BooleanField(default=False)
Jeremy Kerr's avatar
Jeremy Kerr committed
75
    use_tags = models.BooleanField(default=True)
76
    git_send_email_only = models.BooleanField(default=False)
77 78
    subject_prefix_tags = models.CharField(max_length=255, blank=True,
            help_text='Comma separated list of tags')
Jeremy Kerr's avatar
Jeremy Kerr committed
79

80
    def __unicode__(self):
Jeremy Kerr's avatar
Jeremy Kerr committed
81 82
        return self.name

83 84 85
    def is_editable(self, user):
        if not user.is_authenticated():
            return False
86
        return self in user.profile.maintainer_projects.all()
87

Jeremy Kerr's avatar
Jeremy Kerr committed
88 89 90 91 92 93
    @cached_property
    def tags(self):
        if not self.use_tags:
            return []
        return list(Tag.objects.all())

94 95 96 97 98
    def get_subject_prefix_tags(self):
        tags = [t.strip() for t in self.subject_prefix_tags.split(',')]
        tags = [tag for tag in tags if tag]
        return tags

99 100 101
    class Meta:
        ordering = ['linkname']

102 103 104 105 106
def user_name(user):
    if user.first_name or user.last_name:
        names = filter(bool, [user.first_name, user.last_name])
        return u' '.join(names)
    return user.username
107

108 109
auth.models.User.add_to_class('name', user_name)

Jeremy Kerr's avatar
Jeremy Kerr committed
110
class UserProfile(models.Model):
111
    user = models.OneToOneField(User, unique = True, related_name='profile')
112
    primary_project = models.ForeignKey(Project, null = True, blank = True)
Jeremy Kerr's avatar
Jeremy Kerr committed
113 114 115 116 117 118 119 120 121 122
    maintainer_projects = models.ManyToManyField(Project,
            related_name = 'maintainer_project')
    send_email = models.BooleanField(default = False,
            help_text = 'Selecting this option allows patchwork to send ' +
                'email on your behalf')
    patches_per_page = models.PositiveIntegerField(default = 100,
            null = False, blank = False,
            help_text = 'Number of patches to display per page')

    def name(self):
123
        return user_name(self.user)
Jeremy Kerr's avatar
Jeremy Kerr committed
124 125 126

    def contributor_projects(self):
        submitters = Person.objects.filter(user = self.user)
127 128 129 130
        return Project.objects.filter(id__in =
                                        Patch.objects.filter(
                                            submitter__in = submitters)
                                        .values('project_id').query)
Jeremy Kerr's avatar
Jeremy Kerr committed
131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147

    def sync_person(self):
        pass

    def n_todo_patches(self):
        return self.todo_patches().count()

    def todo_patches(self, project = None):

        # filter on project, if necessary
        if project:
            qs = Patch.objects.filter(project = project)
        else:
            qs = Patch.objects

        qs = qs.filter(archived = False) \
             .filter(delegate = self.user) \
148 149
             .filter(state__in =
                     State.objects.filter(action_required = True)
Jeremy Kerr's avatar
Jeremy Kerr committed
150 151 152
                         .values('pk').query)
        return qs

153
    def __unicode__(self):
Jeremy Kerr's avatar
Jeremy Kerr committed
154 155
        return self.name()

156 157
def _user_saved_callback(sender, created, instance, **kwargs):
    try:
158
        profile = instance.profile
159 160
    except UserProfile.DoesNotExist:
        profile = UserProfile(user = instance)
161 162
    profile.save()

163
models.signals.post_save.connect(_user_saved_callback, sender = User)
164

Jeremy Kerr's avatar
Jeremy Kerr committed
165 166 167 168 169
class State(models.Model):
    name = models.CharField(max_length = 100)
    ordering = models.IntegerField(unique = True)
    action_required = models.BooleanField(default = True)

170
    def __unicode__(self):
Jeremy Kerr's avatar
Jeremy Kerr committed
171 172 173 174 175
        return self.name

    class Meta:
        ordering = ['ordering']

Jeremy Kerr's avatar
Jeremy Kerr committed
176
class HashField(models.CharField):
Jeremy Kerr's avatar
Jeremy Kerr committed
177 178 179 180
    __metaclass__ = models.SubfieldBase

    def __init__(self, algorithm = 'sha1', *args, **kwargs):
        self.algorithm = algorithm
Nate Case's avatar
Nate Case committed
181 182
        try:
            import hashlib
Jeremy Kerr's avatar
Jeremy Kerr committed
183 184 185
            def _construct(string = ''):
                return hashlib.new(self.algorithm, string)
            self.construct = _construct
186
            self.n_bytes = len(hashlib.new(self.algorithm).hexdigest())
Nate Case's avatar
Nate Case committed
187
        except ImportError:
Jeremy Kerr's avatar
Jeremy Kerr committed
188 189 190
            modules = { 'sha1': 'sha', 'md5': 'md5'}

            if algorithm not in modules.keys():
Nate Case's avatar
Nate Case committed
191
                raise NameError("Unknown algorithm '%s'" % algorithm)
Jeremy Kerr's avatar
Jeremy Kerr committed
192 193 194 195

            self.construct = __import__(modules[algorithm]).new

        self.n_bytes = len(self.construct().hexdigest())
Jeremy Kerr's avatar
Jeremy Kerr committed
196

197
        kwargs['max_length'] = self.n_bytes
Jeremy Kerr's avatar
Jeremy Kerr committed
198 199
        super(HashField, self).__init__(*args, **kwargs)

200
    def db_type(self, connection=None):
201
        return 'char(%d)' % self.n_bytes
Jeremy Kerr's avatar
Jeremy Kerr committed
202

Jeremy Kerr's avatar
Jeremy Kerr committed
203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230
class Tag(models.Model):
    name = models.CharField(max_length=20)
    pattern = models.CharField(max_length=50,
                help_text='A simple regex to match the tag in the content of '
                    'a message. Will be used with MULTILINE and IGNORECASE '
                    'flags. eg. ^Acked-by:')
    abbrev = models.CharField(max_length=2, unique=True,
                help_text='Short (one-or-two letter) abbreviation for the tag, '
                    'used in table column headers')

    def __unicode__(self):
        return self.name

    @property
    def attr_name(self):
        return 'tag_%d_count' % self.id

    class Meta:
        ordering = ['abbrev']

class PatchTag(models.Model):
    patch = models.ForeignKey('Patch')
    tag = models.ForeignKey('Tag')
    count = models.IntegerField(default=1)

    class Meta:
        unique_together = [('patch', 'tag')]

231 232 233
def get_default_initial_patch_state():
    return State.objects.get(ordering=0)

Jeremy Kerr's avatar
Jeremy Kerr committed
234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264
class PatchQuerySet(models.query.QuerySet):

    def with_tag_counts(self, project):
        if not project.use_tags:
            return self

        # We need the project's use_tags field loaded for Project.tags().
        # Using prefetch_related means we'll share the one instance of
        # Project, and share the project.tags cache between all patch.project
        # references.
        qs = self.prefetch_related('project')
        select = OrderedDict()
        select_params = []
        for tag in project.tags:
            select[tag.attr_name] = ("coalesce("
                "(SELECT count FROM patchwork_patchtag "
                "WHERE patchwork_patchtag.patch_id=patchwork_patch.id "
                    "AND patchwork_patchtag.tag_id=%s), 0)")
            select_params.append(tag.id)

        return qs.extra(select=select, select_params=select_params)

class PatchManager(models.Manager):
    use_for_related_fields = True

    def get_queryset(self):
        return PatchQuerySet(self.model, using=self.db)

    def with_tag_counts(self, project):
        return self.get_queryset().with_tag_counts(project)

265 266 267 268 269
def filename(name, ext):
    fname_re = re.compile('[^-_A-Za-z0-9\.]+')
    str = fname_re.sub('-', name)
    return str.strip('-') + ext

Jeremy Kerr's avatar
Jeremy Kerr committed
270 271
class Patch(models.Model):
    project = models.ForeignKey(Project)
272
    msgid = models.CharField(max_length=255)
Jeremy Kerr's avatar
Jeremy Kerr committed
273 274 275 276
    name = models.CharField(max_length=255)
    date = models.DateTimeField(default=datetime.datetime.now)
    submitter = models.ForeignKey(Person)
    delegate = models.ForeignKey(User, blank = True, null = True)
277
    state = models.ForeignKey(State, null=True)
Jeremy Kerr's avatar
Jeremy Kerr committed
278 279
    archived = models.BooleanField(default = False)
    headers = models.TextField(blank = True)
280 281
    content = models.TextField(null = True, blank = True)
    pull_url = models.CharField(max_length=255, null = True, blank = True)
Jeremy Kerr's avatar
Jeremy Kerr committed
282
    commit_ref = models.CharField(max_length=255, null = True, blank = True)
283
    hash = HashField(null = True, blank = True)
Jeremy Kerr's avatar
Jeremy Kerr committed
284 285 286
    tags = models.ManyToManyField(Tag, through=PatchTag)

    objects = PatchManager()
Jeremy Kerr's avatar
Jeremy Kerr committed
287

288
    def __unicode__(self):
Jeremy Kerr's avatar
Jeremy Kerr committed
289 290
        return self.name

291 292 293 294 295 296 297 298
    def commit_message(self):
        """Retrieves the commit message"""
        return Comment.objects.filter(patch=self, msgid=self.msgid)

    def answers(self):
        """Retrieves the answers (ie all comments but the commit message)"""
        return Comment.objects.filter(Q(patch=self) & ~Q(msgid=self.msgid))

Jeremy Kerr's avatar
Jeremy Kerr committed
299
    def comments(self):
300 301
        """Retrieves all comments of this patch ie. the commit message and the
           answers"""
302
        return Comment.objects.filter(patch = self)
Jeremy Kerr's avatar
Jeremy Kerr committed
303

Jeremy Kerr's avatar
Jeremy Kerr committed
304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321
    def _set_tag(self, tag, count):
        if count == 0:
            self.patchtag_set.filter(tag=tag).delete()
            return
        (patchtag, _) = PatchTag.objects.get_or_create(patch=self, tag=tag)
        if patchtag.count != count:
            patchtag.count = count
            patchtag.save()

    def refresh_tag_counts(self):
        tags = self.project.tags
        counter = Counter()
        for comment in self.comment_set.all():
            counter = counter + extract_tags(comment.content, tags)

        for tag in tags:
            self._set_tag(tag, counter[tag])

Jeremy Kerr's avatar
Jeremy Kerr committed
322
    def save(self):
323 324
        if not hasattr(self, 'state') or not self.state:
            self.state = get_default_initial_patch_state()
Jeremy Kerr's avatar
Jeremy Kerr committed
325

326
        if self.hash is None and self.content is not None:
Jeremy Kerr's avatar
Jeremy Kerr committed
327
            self.hash = hash_patch(self.content).hexdigest()
Jeremy Kerr's avatar
Jeremy Kerr committed
328

Jeremy Kerr's avatar
Jeremy Kerr committed
329 330 331 332 333 334 335 336 337
        super(Patch, self).save()

    def is_editable(self, user):
        if not user.is_authenticated():
            return False

        if self.submitter.user == user or self.delegate == user:
            return True

338
        return self.project.is_editable(user)
Jeremy Kerr's avatar
Jeremy Kerr committed
339 340

    def filename(self):
341
        return filename(self.name, '.patch')
Jeremy Kerr's avatar
Jeremy Kerr committed
342 343 344 345 346 347 348 349

    @models.permalink
    def get_absolute_url(self):
        return ('patchwork.views.patch.patch', (), {'patch_id': self.id})

    class Meta:
        verbose_name_plural = 'Patches'
        ordering = ['date']
350
        unique_together = [('msgid', 'project')]
Jeremy Kerr's avatar
Jeremy Kerr committed
351 352 353

class Comment(models.Model):
    patch = models.ForeignKey(Patch)
354
    msgid = models.CharField(max_length=255)
Jeremy Kerr's avatar
Jeremy Kerr committed
355 356 357 358 359
    submitter = models.ForeignKey(Person)
    date = models.DateTimeField(default = datetime.datetime.now)
    headers = models.TextField(blank = True)
    content = models.TextField()

360 361 362
    response_re = re.compile( \
            '^(Tested|Reviewed|Acked|Signed-off|Nacked|Reported)-by: .*$',
            re.M | re.I)
363 364

    def patch_responses(self):
365
        return ''.join([ match.group(0) + '\n' for match in
366 367
                                self.response_re.finditer(self.content)])

Jeremy Kerr's avatar
Jeremy Kerr committed
368 369 370 371 372 373 374 375
    def save(self, *args, **kwargs):
        super(Comment, self).save(*args, **kwargs)
        self.patch.refresh_tag_counts()

    def delete(self, *args, **kwargs):
        super(Comment, self).delete(*args, **kwargs)
        self.patch.refresh_tag_counts()

Jeremy Kerr's avatar
Jeremy Kerr committed
376 377
    class Meta:
        ordering = ['date']
378
        unique_together = [('msgid', 'patch')]
Jeremy Kerr's avatar
Jeremy Kerr committed
379 380 381 382 383

class Bundle(models.Model):
    owner = models.ForeignKey(User)
    project = models.ForeignKey(Project)
    name = models.CharField(max_length = 50, null = False, blank = False)
384
    patches = models.ManyToManyField(Patch, through = 'BundlePatch')
Jeremy Kerr's avatar
Jeremy Kerr committed
385 386 387 388 389
    public = models.BooleanField(default = False)

    def n_patches(self):
        return self.patches.all().count()

Jeremy Kerr's avatar
Jeremy Kerr committed
390
    def ordered_patches(self):
Guilherme Salgado's avatar
Guilherme Salgado committed
391
        return self.patches.order_by('bundlepatch__order')
Jeremy Kerr's avatar
Jeremy Kerr committed
392

393 394
    def append_patch(self, patch):
        # todo: use the aggregate queries in django 1.1
Jeremy Kerr's avatar
Jeremy Kerr committed
395 396 397 398 399 400 401 402 403 404 405
        orders = BundlePatch.objects.filter(bundle = self).order_by('-order') \
                 .values('order')

        if len(orders) > 0:
            max_order = orders[0]['order']
        else:
            max_order = 0

        # see if the patch is already in this bundle
        if BundlePatch.objects.filter(bundle = self, patch = patch).count():
            raise Exception("patch is already in bundle")
406

Jeremy Kerr's avatar
Jeremy Kerr committed
407 408
        bp = BundlePatch.objects.create(bundle = self, patch = patch,
                order = max_order + 1)
409 410
        bp.save()

Jeremy Kerr's avatar
Jeremy Kerr committed
411 412 413 414 415 416 417 418
    class Meta:
        unique_together = [('owner', 'name')]

    def public_url(self):
        if not self.public:
            return None
        site = Site.objects.get_current()
        return 'http://%s%s' % (site.domain,
419
                reverse('patchwork.views.bundle.bundle',
Jeremy Kerr's avatar
Jeremy Kerr committed
420 421 422 423 424
                        kwargs = {
                                'username': self.owner.username,
                                'bundlename': self.name
                        }))

425 426 427 428 429 430 431
    @models.permalink
    def get_absolute_url(self):
        return ('patchwork.views.bundle.bundle', (), {
                                'username': self.owner.username,
                                'bundlename': self.name,
                            })

432 433 434 435 436 437
class BundlePatch(models.Model):
    patch = models.ForeignKey(Patch)
    bundle = models.ForeignKey(Bundle)
    order = models.IntegerField()

    class Meta:
Jeremy Kerr's avatar
Jeremy Kerr committed
438 439
        unique_together = [('bundle', 'patch')]
        ordering = ['order']
440

Damien Lespiau's avatar
Damien Lespiau committed
441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474
SERIES_DEFAULT_NAME = "Series without cover letter"

# This Model represents the "top level" Series, an object that doesn't change
# with the various versions of patches sent to the mailing list.
class Series(models.Model):
    project = models.ForeignKey(Project)
    name = models.CharField(max_length=200, default=SERIES_DEFAULT_NAME)
    submitter = models.ForeignKey(Person, related_name='submitters')
    reviewer = models.ForeignKey(User, related_name='reviewers', null=True,
                                 blank=True)
    submitted = models.DateTimeField(default=datetime.datetime.now)
    last_updated = models.DateTimeField(auto_now=True)
    # Caches the latest version so we can display it without looking at the max
    # of all SeriesRevision.version
    version = models.IntegerField(default=1)
    # This is the number of patches of the latest version.
    n_patches = models.IntegerField(default=0)

    def __unicode__(self):
        return self.name

    def revisions(self):
        return SeriesRevision.objects.filter(series=self)

    def latest_revision(self):
        return self.revisions().reverse()[0]

    def get_absolute_url(self):
        return reverse('series', kwargs={ 'series': self.pk })

    def dump(self):
        print('')
        print('===')
        print('Series: %s' % self)
475 476
        print('    version: %d' % self.version)
        print('    n_patches: %d' % self.n_patches)
Damien Lespiau's avatar
Damien Lespiau committed
477 478 479 480 481 482 483 484 485
        for rev in self.revisions():
            print('    rev %d:' % rev.version)
            i = 1
            for patch in rev.ordered_patches():
                print('        patch %d:' % i)
                print('            subject: %s' % patch.name)
                print('            msgid  : %s' % patch.msgid)
                i += 1

486 487 488
    def filename(self):
        return filename(self.name, '.mbox')

489 490 491 492
# Signal one can listen to to know when a revision is complete (ie. has all of
# its patches)
series_revision_complete = django.dispatch.Signal(providing_args=["revision"])

Damien Lespiau's avatar
Damien Lespiau committed
493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518
# A 'revision' of a series. Resending a new version of a patch or a full new
# iteration of a series will create a new revision.
class SeriesRevision(models.Model):
    series = models.ForeignKey(Series)
    version = models.IntegerField(default=1)
    root_msgid = models.CharField(max_length=255)
    cover_letter = models.TextField(null = True, blank = True)
    patches = models.ManyToManyField(Patch, through = 'SeriesRevisionPatch')

    class Meta:
        unique_together = [('series', 'version')]
        ordering = ['version']

    def ordered_patches(self):
        return self.patches.order_by('seriesrevisionpatch__order')

    def add_patch(self, patch, order):
        # see if the patch is already in this revision
        if SeriesRevisionPatch.objects.filter(revision=self,
                                              patch=patch).count():
            raise Exception("patch is already in revision")

        sp = SeriesRevisionPatch.objects.create(revision=self, patch=patch,
                                                order=order)
        sp.save()

519 520 521 522
        revision_complete = self.patches.count() == self.series.n_patches
        if revision_complete:
            series_revision_complete.send(sender=self.__class__, revision=self)

523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549
    def duplicate_meta(self):
        new = SeriesRevision.objects.get(pk=self.pk)
        new.pk = None
        new.cover_letter = None
        new.version = self.version + 1
        new.save()

        series = new.series
        series.version = new.version
        series.save()

        return new

    def duplicate(self, exclude_patches=()):
        """Create a new revision based on 'self', incrementing the version
           and populating the new revision with all 'self' patches.
           exclude_patch (a list of 'order's) can be used to exclude
           patches from the operation"""
        new = self.duplicate_meta()
        order = 0
        for p in self.ordered_patches():
            order += 1
            if order in exclude_patches:
                continue
            new.add_patch(p, order)
        return new

Damien Lespiau's avatar
Damien Lespiau committed
550
    def __unicode__(self):
551
        return "Revision " + str(self.version)
Damien Lespiau's avatar
Damien Lespiau committed
552 553 554 555 556 557 558 559 560 561

class SeriesRevisionPatch(models.Model):
    patch = models.ForeignKey(Patch)
    revision = models.ForeignKey(SeriesRevision)
    order = models.IntegerField()

    class Meta:
        unique_together = [('revision', 'patch'), ('revision', 'order')]
        ordering = ['order']

562 563 564 565 566 567 568 569
class Event(models.Model):
    name = models.CharField(max_length=20)

class EventLog(models.Model):
    event = models.ForeignKey(Event)
    event_time = models.DateTimeField(auto_now=True)
    series = models.ForeignKey(Series)
    user = models.ForeignKey(User, null=True)
570
    parameters = jsonfield.JSONField(null=True)
571 572 573 574

    class Meta:
        ordering = ['-event_time']

575
class Test(models.Model):
576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597
    # no mail, default so test systems/scripts can have a grace period to
    # settle down and give useful results
    RECIPIENT_NONE = 0
    # send mail only to submitter
    RECIPIENT_SUBMITTER = 1
    # send mail to submitter and mailing-list in Cc
    RECIPIENT_MAILING_LIST = 2
    RECIPIENT_CHOICES = (
        (RECIPIENT_NONE, 'none'),
        (RECIPIENT_SUBMITTER, 'submitter'),
        (RECIPIENT_MAILING_LIST, 'mailing list'),
    )

    # send result mail on any state (but pending)
    CONDITION_ALWAYS = 0
    # only send result on warning/failure
    CONDITION_ON_FAILURE = 1
    CONDITION_CHOICES = (
        (CONDITION_ALWAYS, 'always'),
        (CONDITION_ON_FAILURE, 'on failure'),
    )

598 599
    project = models.ForeignKey(Project)
    name = models.CharField(max_length=255)
600 601 602 603
    mail_recipient = models.SmallIntegerField(choices=RECIPIENT_CHOICES,
                                              default=RECIPIENT_NONE)
    mail_condition = models.SmallIntegerField(choices=CONDITION_CHOICES,
                                              default=CONDITION_ALWAYS)
604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637

    class Meta:
        unique_together = [('project', 'name')]

    def __unicode__(self):
        return self.name

class TestResult(models.Model):
    STATE_PENDING = 0
    STATE_SUCCESS = 1
    STATE_WARNING = 2
    STATE_FAILURE = 3
    STATE_CHOICES = (
        (STATE_PENDING, 'pending'),
        (STATE_SUCCESS, 'success'),
        (STATE_WARNING, 'warning'),
        (STATE_FAILURE, 'failure'),
    )

    test = models.ForeignKey(Test)
    revision = models.ForeignKey(SeriesRevision, blank=True, null=True)
    patch = models.ForeignKey(Patch, blank=True, null=True)
    user = models.ForeignKey(User)
    date = models.DateTimeField(default=datetime.datetime.now)
    state = models.SmallIntegerField(choices=STATE_CHOICES)
    url = models.URLField(blank=True, null=True)
    summary = models.TextField(blank=True, null=True)

    class Meta:
        unique_together = [('test', 'revision'), ('test', 'patch')]

    def __unicode__(self):
        return self.get_state_display()

638
class EmailConfirmation(models.Model):
639
    validity = datetime.timedelta(days = settings.CONFIRMATION_VALIDITY_DAYS)
640 641
    type = models.CharField(max_length = 20, choices = [
                                ('userperson', 'User-Person association'),
642
                                ('registration', 'Registration'),
Jeremy Kerr's avatar
Jeremy Kerr committed
643
                                ('optout', 'Email opt-out'),
644
                            ])
645
    email = models.CharField(max_length = 200)
646
    user = models.ForeignKey(User, null = True)
647
    key = HashField()
648
    date = models.DateTimeField(default = datetime.datetime.now)
649 650
    active = models.BooleanField(default = True)

651
    def deactivate(self):
652
        self.active = False
653
        self.save()
654

655 656 657
    def is_valid(self):
        return self.date + self.validity > datetime.datetime.now()

658 659 660 661 662
    def save(self):
        max = 1 << 32
        if self.key == '':
            str = '%s%s%d' % (self.user, self.email, random.randint(0, max))
            self.key = self._meta.get_field('key').construct(str).hexdigest()
663
        super(EmailConfirmation, self).save()
664

Jeremy Kerr's avatar
Jeremy Kerr committed
665 666
class EmailOptout(models.Model):
    email = models.CharField(max_length = 200, primary_key = True)
667

Jeremy Kerr's avatar
Jeremy Kerr committed
668 669
    def __unicode__(self):
        return self.email
670

Jeremy Kerr's avatar
Jeremy Kerr committed
671 672 673 674 675
    @classmethod
    def is_optout(cls, email):
        email = email.lower().strip()
        return cls.objects.filter(email = email).count() > 0

676
class PatchChangeNotification(models.Model):
677
    patch = models.OneToOneField(Patch, primary_key = True)
678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717
    last_modified = models.DateTimeField(default = datetime.datetime.now)
    orig_state = models.ForeignKey(State)

def _patch_change_callback(sender, instance, **kwargs):
    # we only want notification of modified patches
    if instance.pk is None:
        return

    if instance.project is None or not instance.project.send_notifications:
        return

    try:
        orig_patch = Patch.objects.get(pk = instance.pk)
    except Patch.DoesNotExist:
        return

    # If there's no interesting changes, abort without creating the
    # notification
    if orig_patch.state == instance.state:
        return

    notification = None
    try:
        notification = PatchChangeNotification.objects.get(patch = instance)
    except PatchChangeNotification.DoesNotExist:
        pass

    if notification is None:
        notification = PatchChangeNotification(patch = instance,
                                               orig_state = orig_patch.state)

    elif notification.orig_state == instance.state:
        # If we're back at the original state, there is no need to notify
        notification.delete()
        return

    notification.last_modified = datetime.datetime.now()
    notification.save()

models.signals.pre_save.connect(_patch_change_callback, sender = Patch)
718 719 720 721

def _on_revision_complete(sender, revision, **kwargs):
    new_revision = Event.objects.get(name='series-new-revision')
    log = EventLog(event=new_revision, series=revision.series,
722 723
                   user=revision.series.submitter.user,
                   parameters={'revision': revision.version})
724 725 726
    log.save()

series_revision_complete.connect(_on_revision_complete)