models.py 26.2 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
#
# 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

21
from django.contrib import auth
Jeremy Kerr's avatar
Jeremy Kerr committed
22 23 24
from django.contrib.auth.models import User
from django.core.urlresolvers import reverse
from django.contrib.sites.models import Site
25
from django.conf import settings
26 27 28 29 30
from django.db import models
from django.db.models import Q
import django.dispatch
from django.utils import six
from django.utils.encoding import python_2_unicode_compatible
Jeremy Kerr's avatar
Jeremy Kerr committed
31
from django.utils.functional import cached_property
32
from django.utils.six import add_metaclass
33
import jsonfield
Jeremy Kerr's avatar
Jeremy Kerr committed
34

35 36
from patchwork.parser import hash_patch, extract_tags

Jeremy Kerr's avatar
Jeremy Kerr committed
37 38 39
import re
import datetime, time
import random
Jeremy Kerr's avatar
Jeremy Kerr committed
40
from collections import Counter, OrderedDict
41

42
@python_2_unicode_compatible
Jeremy Kerr's avatar
Jeremy Kerr committed
43 44
class Person(models.Model):
    email = models.CharField(max_length=255, unique = True)
45
    name = models.CharField(max_length=255, null = True, blank = True)
46 47
    user = models.ForeignKey(User, null = True, blank = True,
            on_delete = models.SET_NULL)
Jeremy Kerr's avatar
Jeremy Kerr committed
48

49
    def display_name(self):
Jeremy Kerr's avatar
Jeremy Kerr committed
50
        if self.name:
51
            return self.name
Jeremy Kerr's avatar
Jeremy Kerr committed
52 53 54
        else:
            return self.email

55 56 57 58 59 60
    def email_name(self):
        if (self.name):
            return "%s <%s>" % (self.name, self.email)
        else:
            return self.email

Jeremy Kerr's avatar
Jeremy Kerr committed
61
    def link_to_user(self, user):
62
        self.name = user.profile.name()
Jeremy Kerr's avatar
Jeremy Kerr committed
63 64
        self.user = user

65 66 67
    def __str__(self):
        return self.display_name()

Jeremy Kerr's avatar
Jeremy Kerr committed
68 69 70
    class Meta:
        verbose_name_plural = 'People'

71
def get_comma_separated_field(value):
72 73
    if not value:
        return []
74 75 76 77
    tags = [v.strip() for v in value.split(',')]
    tags = [tag for tag in tags if tag]
    return tags

78
@python_2_unicode_compatible
Jeremy Kerr's avatar
Jeremy Kerr committed
79 80 81
class Project(models.Model):
    linkname = models.CharField(max_length=255, unique=True)
    name = models.CharField(max_length=255, unique=True)
82
    description = models.TextField(blank=True, null=True)
83
    listid = models.CharField(max_length=255)
Jeremy Kerr's avatar
Jeremy Kerr committed
84
    listemail = models.CharField(max_length=200)
Simo Sorce's avatar
Simo Sorce committed
85 86 87
    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
88
    send_notifications = models.BooleanField(default=False)
Jeremy Kerr's avatar
Jeremy Kerr committed
89
    use_tags = models.BooleanField(default=True)
90
    git_send_email_only = models.BooleanField(default=False)
91 92
    subject_prefix_tags = models.CharField(max_length=255, blank=True,
            help_text='Comma separated list of tags')
Jeremy Kerr's avatar
Jeremy Kerr committed
93

94 95 96
    def is_editable(self, user):
        if not user.is_authenticated():
            return False
97
        return self in user.profile.maintainer_projects.all()
98

Jeremy Kerr's avatar
Jeremy Kerr committed
99 100 101 102 103 104
    @cached_property
    def tags(self):
        if not self.use_tags:
            return []
        return list(Tag.objects.all())

105
    def get_subject_prefix_tags(self):
106
        return get_comma_separated_field(self.subject_prefix_tags)
107

108 109 110
    def __str__(self):
        return self.name

111 112 113
    class Meta:
        ordering = ['linkname']

114 115
def user_name(user):
    if user.first_name or user.last_name:
116
        names = list(filter(bool, [user.first_name, user.last_name]))
117 118
        return u' '.join(names)
    return user.username
119

120 121
auth.models.User.add_to_class('name', user_name)

122
@python_2_unicode_compatible
Jeremy Kerr's avatar
Jeremy Kerr committed
123
class UserProfile(models.Model):
124
    user = models.OneToOneField(User, unique = True, related_name='profile')
125
    primary_project = models.ForeignKey(Project, null = True, blank = True)
Jeremy Kerr's avatar
Jeremy Kerr committed
126 127 128 129 130 131 132 133 134 135
    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):
136
        return user_name(self.user)
Jeremy Kerr's avatar
Jeremy Kerr committed
137 138 139

    def contributor_projects(self):
        submitters = Person.objects.filter(user = self.user)
140 141 142 143
        return Project.objects.filter(id__in =
                                        Patch.objects.filter(
                                            submitter__in = submitters)
                                        .values('project_id').query)
Jeremy Kerr's avatar
Jeremy Kerr committed
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160

    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) \
161 162
             .filter(state__in =
                     State.objects.filter(action_required = True)
Jeremy Kerr's avatar
Jeremy Kerr committed
163 164 165
                         .values('pk').query)
        return qs

166
    def __str__(self):
Jeremy Kerr's avatar
Jeremy Kerr committed
167 168
        return self.name()

169 170
def _user_saved_callback(sender, created, instance, **kwargs):
    try:
171
        profile = instance.profile
172 173
    except UserProfile.DoesNotExist:
        profile = UserProfile(user = instance)
174 175
    profile.save()

176
models.signals.post_save.connect(_user_saved_callback, sender = User)
177

178
@python_2_unicode_compatible
Jeremy Kerr's avatar
Jeremy Kerr committed
179 180 181 182 183
class State(models.Model):
    name = models.CharField(max_length = 100)
    ordering = models.IntegerField(unique = True)
    action_required = models.BooleanField(default = True)

184
    def __str__(self):
Jeremy Kerr's avatar
Jeremy Kerr committed
185 186 187 188 189
        return self.name

    class Meta:
        ordering = ['ordering']

190
@add_metaclass(models.SubfieldBase)
Jeremy Kerr's avatar
Jeremy Kerr committed
191
class HashField(models.CharField):
Jeremy Kerr's avatar
Jeremy Kerr committed
192 193 194

    def __init__(self, algorithm = 'sha1', *args, **kwargs):
        self.algorithm = algorithm
Nate Case's avatar
Nate Case committed
195 196
        try:
            import hashlib
Jeremy Kerr's avatar
Jeremy Kerr committed
197
            def _construct(string = ''):
198 199
                if isinstance(string, six.text_type):
                    string = string.encode('utf-8')
Jeremy Kerr's avatar
Jeremy Kerr committed
200 201
                return hashlib.new(self.algorithm, string)
            self.construct = _construct
202
            self.n_bytes = len(hashlib.new(self.algorithm).hexdigest())
Nate Case's avatar
Nate Case committed
203
        except ImportError:
Jeremy Kerr's avatar
Jeremy Kerr committed
204 205
            modules = { 'sha1': 'sha', 'md5': 'md5'}

206
            if algorithm not in modules:
Nate Case's avatar
Nate Case committed
207
                raise NameError("Unknown algorithm '%s'" % algorithm)
Jeremy Kerr's avatar
Jeremy Kerr committed
208 209 210 211

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

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

213
        kwargs['max_length'] = self.n_bytes
Jeremy Kerr's avatar
Jeremy Kerr committed
214 215
        super(HashField, self).__init__(*args, **kwargs)

216
    def db_type(self, connection=None):
217
        return 'char(%d)' % self.n_bytes
Jeremy Kerr's avatar
Jeremy Kerr committed
218

219
@python_2_unicode_compatible
Jeremy Kerr's avatar
Jeremy Kerr committed
220 221 222 223 224 225 226 227 228 229 230 231 232 233
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')

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

234 235 236
    def __str__(self):
        return self.name

Jeremy Kerr's avatar
Jeremy Kerr committed
237 238 239 240 241 242 243 244 245 246 247
    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')]

248 249 250
def get_default_initial_patch_state():
    return State.objects.get(ordering=0)

Jeremy Kerr's avatar
Jeremy Kerr committed
251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281
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)

282 283 284 285 286
def filename(name, ext):
    fname_re = re.compile('[^-_A-Za-z0-9\.]+')
    str = fname_re.sub('-', name)
    return str.strip('-') + ext

287
@python_2_unicode_compatible
Jeremy Kerr's avatar
Jeremy Kerr committed
288 289
class Patch(models.Model):
    project = models.ForeignKey(Project)
290
    msgid = models.CharField(max_length=255)
Jeremy Kerr's avatar
Jeremy Kerr committed
291 292 293 294
    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)
295
    state = models.ForeignKey(State, null=True)
Jeremy Kerr's avatar
Jeremy Kerr committed
296 297
    archived = models.BooleanField(default = False)
    headers = models.TextField(blank = True)
298 299
    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
300
    commit_ref = models.CharField(max_length=255, null = True, blank = True)
301
    hash = HashField(null = True, blank = True)
Jeremy Kerr's avatar
Jeremy Kerr committed
302 303 304
    tags = models.ManyToManyField(Tag, through=PatchTag)

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

306 307 308 309 310 311 312 313
    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
314
    def comments(self):
315 316
        """Retrieves all comments of this patch ie. the commit message and the
           answers"""
317
        return Comment.objects.filter(patch = self)
Jeremy Kerr's avatar
Jeremy Kerr committed
318

Jeremy Kerr's avatar
Jeremy Kerr committed
319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
    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
337
    def save(self):
338 339
        if not hasattr(self, 'state') or not self.state:
            self.state = get_default_initial_patch_state()
Jeremy Kerr's avatar
Jeremy Kerr committed
340

341
        if self.hash is None and self.content is not None:
Jeremy Kerr's avatar
Jeremy Kerr committed
342
            self.hash = hash_patch(self.content).hexdigest()
Jeremy Kerr's avatar
Jeremy Kerr committed
343

Jeremy Kerr's avatar
Jeremy Kerr committed
344 345 346 347 348 349 350 351 352
        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

353
        return self.project.is_editable(user)
Jeremy Kerr's avatar
Jeremy Kerr committed
354 355

    def filename(self):
356
        return filename(self.name, '.patch')
Jeremy Kerr's avatar
Jeremy Kerr committed
357 358 359 360 361

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

362 363 364
    def __str__(self):
        return self.name

Jeremy Kerr's avatar
Jeremy Kerr committed
365 366 367
    class Meta:
        verbose_name_plural = 'Patches'
        ordering = ['date']
368
        unique_together = [('msgid', 'project')]
Jeremy Kerr's avatar
Jeremy Kerr committed
369 370 371

class Comment(models.Model):
    patch = models.ForeignKey(Patch)
372
    msgid = models.CharField(max_length=255)
Jeremy Kerr's avatar
Jeremy Kerr committed
373 374 375 376 377
    submitter = models.ForeignKey(Person)
    date = models.DateTimeField(default = datetime.datetime.now)
    headers = models.TextField(blank = True)
    content = models.TextField()

378 379 380
    response_re = re.compile( \
            '^(Tested|Reviewed|Acked|Signed-off|Nacked|Reported)-by: .*$',
            re.M | re.I)
381 382

    def patch_responses(self):
383
        return ''.join([ match.group(0) + '\n' for match in
384 385
                                self.response_re.finditer(self.content)])

Jeremy Kerr's avatar
Jeremy Kerr committed
386 387 388 389 390 391 392 393
    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
394 395
    class Meta:
        ordering = ['date']
396
        unique_together = [('msgid', 'patch')]
Jeremy Kerr's avatar
Jeremy Kerr committed
397 398 399 400 401

class Bundle(models.Model):
    owner = models.ForeignKey(User)
    project = models.ForeignKey(Project)
    name = models.CharField(max_length = 50, null = False, blank = False)
402
    patches = models.ManyToManyField(Patch, through = 'BundlePatch')
Jeremy Kerr's avatar
Jeremy Kerr committed
403 404 405 406 407
    public = models.BooleanField(default = False)

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

Jeremy Kerr's avatar
Jeremy Kerr committed
408
    def ordered_patches(self):
Guilherme Salgado's avatar
Guilherme Salgado committed
409
        return self.patches.order_by('bundlepatch__order')
Jeremy Kerr's avatar
Jeremy Kerr committed
410

411 412
    def append_patch(self, patch):
        # todo: use the aggregate queries in django 1.1
Jeremy Kerr's avatar
Jeremy Kerr committed
413 414 415 416 417 418 419 420 421 422 423
        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")
424

Jeremy Kerr's avatar
Jeremy Kerr committed
425 426
        bp = BundlePatch.objects.create(bundle = self, patch = patch,
                order = max_order + 1)
427 428
        bp.save()

Jeremy Kerr's avatar
Jeremy Kerr committed
429 430 431 432 433
    def public_url(self):
        if not self.public:
            return None
        site = Site.objects.get_current()
        return 'http://%s%s' % (site.domain,
434
                reverse('patchwork.views.bundle.bundle',
Jeremy Kerr's avatar
Jeremy Kerr committed
435 436 437 438 439
                        kwargs = {
                                'username': self.owner.username,
                                'bundlename': self.name
                        }))

440 441 442 443 444 445 446
    @models.permalink
    def get_absolute_url(self):
        return ('patchwork.views.bundle.bundle', (), {
                                'username': self.owner.username,
                                'bundlename': self.name,
                            })

447 448 449
    class Meta:
        unique_together = [('owner', 'name')]

450 451 452 453 454 455
class BundlePatch(models.Model):
    patch = models.ForeignKey(Patch)
    bundle = models.ForeignKey(Bundle)
    order = models.IntegerField()

    class Meta:
Jeremy Kerr's avatar
Jeremy Kerr committed
456 457
        unique_together = [('bundle', 'patch')]
        ordering = ['order']
458

Damien Lespiau's avatar
Damien Lespiau committed
459 460
SERIES_DEFAULT_NAME = "Series without cover letter"

461

462

463 464 465 466 467 468 469 470 471 472 473 474 475
class TestState:
    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'),
    )


Damien Lespiau's avatar
Damien Lespiau committed
476 477
# This Model represents the "top level" Series, an object that doesn't change
# with the various versions of patches sent to the mailing list.
478
@python_2_unicode_compatible
Damien Lespiau's avatar
Damien Lespiau committed
479 480 481 482 483 484 485 486
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)
487 488 489 490
    # direct access to the latest revision so we can get the latest revision
    # information with a JOIN
    last_revision = models.OneToOneField('SeriesRevision', null=True,
                                         related_name='+')
Damien Lespiau's avatar
Damien Lespiau committed
491 492 493 494 495 496 497 498 499 500 501 502 503 504

    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)
505 506
        print('    version: %d' % self.version)
        print('    n_patches: %d' % self.n_patches)
Damien Lespiau's avatar
Damien Lespiau committed
507 508 509 510 511 512 513 514 515
        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

516 517 518
    def filename(self):
        return filename(self.name, '.mbox')

519 520 521
    def __str__(self):
        return self.name

522 523 524 525
# 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
526 527
# 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.
528
@python_2_unicode_compatible
Damien Lespiau's avatar
Damien Lespiau committed
529 530 531 532 533
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)
534
    n_patches = models.IntegerField(default=0)
Damien Lespiau's avatar
Damien Lespiau committed
535
    patches = models.ManyToManyField(Patch, through = 'SeriesRevisionPatch')
536 537
    test_state = models.SmallIntegerField(choices=TestState.STATE_CHOICES,
                                          null=True)
Damien Lespiau's avatar
Damien Lespiau committed
538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555

    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()

556
        revision_complete = self.patches.count() == self.n_patches
557 558 559
        if revision_complete:
            series_revision_complete.send(sender=self.__class__, revision=self)

560 561 562 563 564
    def duplicate_meta(self):
        new = SeriesRevision.objects.get(pk=self.pk)
        new.pk = None
        new.cover_letter = None
        new.version = self.version + 1
565
        new.test_state = None
566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583
        new.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

584 585 586 587 588
    def refresh_test_state(self):
        results = TestResult.objects.filter(revision=self)
        if results.count() > 0:
            self.test_state = max([r.state for r in results])
            self.save()
589
            self.series.save()
590

591
    def __str__(self):
592
        return "Revision " + str(self.version)
Damien Lespiau's avatar
Damien Lespiau committed
593 594 595 596 597 598 599 600 601 602

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']

603 604 605 606 607 608 609 610
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)
611
    parameters = jsonfield.JSONField(null=True)
612 613 614 615

    class Meta:
        ordering = ['-event_time']

616
@python_2_unicode_compatible
617
class Test(models.Model):
618 619 620 621 622 623 624
    # 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
625 626
    # send mail to the addresses listed in the mail_to_list field only
    RECIPIENT_TO_LIST = 3
627 628 629 630
    RECIPIENT_CHOICES = (
        (RECIPIENT_NONE, 'none'),
        (RECIPIENT_SUBMITTER, 'submitter'),
        (RECIPIENT_MAILING_LIST, 'mailing list'),
631
        (RECIPIENT_TO_LIST, 'recipient list'),
632 633 634 635 636 637 638 639 640 641 642
    )

    # 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'),
    )

643 644
    project = models.ForeignKey(Project)
    name = models.CharField(max_length=255)
645 646
    mail_recipient = models.SmallIntegerField(choices=RECIPIENT_CHOICES,
                                              default=RECIPIENT_NONE)
647 648 649 650 651 652
    # email addresses in these lists are always added to the To: and Cc:fields,
    # unless we don't want to send any email at all.
    mail_to_list = models.CharField(max_length=255, blank=True, null=True,
            help_text='Comma separated list of emails')
    mail_cc_list = models.CharField(max_length=255, blank=True, null=True,
            help_text='Comma separated list of emails')
653 654
    mail_condition = models.SmallIntegerField(choices=CONDITION_CHOICES,
                                              default=CONDITION_ALWAYS)
655 656 657 658

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

659 660 661 662 663 664
    def get_to_list(self):
        return get_comma_separated_field(self.mail_to_list)

    def get_cc_list(self):
        return get_comma_separated_field(self.mail_cc_list)

665
    def __str__(self):
666 667
        return self.name

668
@python_2_unicode_compatible
669 670 671 672 673 674
class TestResult(models.Model):

    test = models.ForeignKey(Test)
    revision = models.ForeignKey(SeriesRevision, blank=True, null=True)
    patch = models.ForeignKey(Patch, blank=True, null=True)
    user = models.ForeignKey(User)
675
    date = models.DateTimeField(auto_now=True)
676
    state = models.SmallIntegerField(choices=TestState.STATE_CHOICES)
677 678 679
    url = models.URLField(blank=True, null=True)
    summary = models.TextField(blank=True, null=True)

680 681 682
    def __str__(self):
        return self.get_state_display()

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

686
class EmailConfirmation(models.Model):
687
    validity = datetime.timedelta(days = settings.CONFIRMATION_VALIDITY_DAYS)
688 689
    type = models.CharField(max_length = 20, choices = [
                                ('userperson', 'User-Person association'),
690
                                ('registration', 'Registration'),
Jeremy Kerr's avatar
Jeremy Kerr committed
691
                                ('optout', 'Email opt-out'),
692
                            ])
693
    email = models.CharField(max_length = 200)
694
    user = models.ForeignKey(User, null = True)
695
    key = HashField()
696
    date = models.DateTimeField(default = datetime.datetime.now)
697 698
    active = models.BooleanField(default = True)

699
    def deactivate(self):
700
        self.active = False
701
        self.save()
702

703 704 705
    def is_valid(self):
        return self.date + self.validity > datetime.datetime.now()

706 707 708 709 710
    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()
711
        super(EmailConfirmation, self).save()
712

713
@python_2_unicode_compatible
Jeremy Kerr's avatar
Jeremy Kerr committed
714 715
class EmailOptout(models.Model):
    email = models.CharField(max_length = 200, primary_key = True)
716

Jeremy Kerr's avatar
Jeremy Kerr committed
717 718 719 720 721
    @classmethod
    def is_optout(cls, email):
        email = email.lower().strip()
        return cls.objects.filter(email = email).count() > 0

722 723 724
    def __str__(self):
        return self.email

725
class PatchChangeNotification(models.Model):
726
    patch = models.OneToOneField(Patch, primary_key = True)
727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766
    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)
767 768

def _on_revision_complete(sender, revision, **kwargs):
769 770 771 772 773 774 775
    series = revision.series

    # update series.last_revision
    series.last_revision = series.latest_revision()
    series.save()

    # log event
776
    new_revision = Event.objects.get(name='series-new-revision')
777 778
    log = EventLog(event=new_revision, series=series,
                   user=series.submitter.user,
779
                   parameters={'revision': revision.version})
780 781 782
    log.save()

series_revision_complete.connect(_on_revision_complete)