models.py 33.9 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

Damien Lespiau's avatar
Damien Lespiau committed
21 22 23 24 25
from collections import Counter, OrderedDict
import datetime
import jsonfield
import random
import re
26
import patchwork.threadlocalrequest as threadlocalrequest
Damien Lespiau's avatar
Damien Lespiau committed
27 28

from django.conf import settings
29
from django.contrib import auth
Jeremy Kerr's avatar
Jeremy Kerr committed
30 31
from django.contrib.auth.models import User
from django.contrib.sites.models import Site
Damien Lespiau's avatar
Damien Lespiau committed
32
from django.core.urlresolvers import reverse
33 34 35 36
from django.db import models
from django.db.models import Q
import django.dispatch
from django.utils.encoding import python_2_unicode_compatible
Jeremy Kerr's avatar
Jeremy Kerr committed
37
from django.utils.functional import cached_property
38
from django.utils.six.moves import filter
Jeremy Kerr's avatar
Jeremy Kerr committed
39

40
from patchwork.fields import HashField
41 42
from patchwork.parser import hash_patch, extract_tags

43

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

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

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

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

67 68 69
    def __str__(self):
        return self.display_name()

Jeremy Kerr's avatar
Jeremy Kerr committed
70 71 72
    class Meta:
        verbose_name_plural = 'People'

73

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

81

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

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

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

107 108 109
    def get_listemail_tag(self):
        return self.listemail.split("@")[0]

110 111 112
    def __str__(self):
        return self.name

113 114 115
    class Meta:
        ordering = ['linkname']

116

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

123

124 125
auth.models.User.add_to_class('name', user_name)

126

127 128
@python_2_unicode_compatible
class DelegationRule(models.Model):
129
    user = models.ForeignKey(User, on_delete=models.CASCADE)
130
    path = models.CharField(max_length=255)
131
    project = models.ForeignKey(Project, on_delete=models.CASCADE)
132 133 134 135 136 137 138 139 140 141
    priority = models.IntegerField(default=0)

    def __str__(self):
        return self.path

    class Meta:
        ordering = ['-priority', 'path']
        unique_together = (('path', 'project'))


142
@python_2_unicode_compatible
Jeremy Kerr's avatar
Jeremy Kerr committed
143
class UserProfile(models.Model):
144 145 146 147
    user = models.OneToOneField(User, unique=True, related_name='profile',
                                on_delete=models.CASCADE)
    primary_project = models.ForeignKey(Project, null=True, blank=True,
                                        on_delete=models.CASCADE)
Jeremy Kerr's avatar
Jeremy Kerr committed
148
    maintainer_projects = models.ManyToManyField(Project,
149
             related_name='maintainer_project', blank=True)
150
    send_email = models.BooleanField(default=False,
151
             help_text='Selecting this option allows patchwork to send '
152 153 154 155
             'email on your behalf')
    patches_per_page = models.PositiveIntegerField(
            default=100, null=False, blank=False,
            help_text='Number of patches to display per page')
Jeremy Kerr's avatar
Jeremy Kerr committed
156 157

    def name(self):
158
        return user_name(self.user)
Jeremy Kerr's avatar
Jeremy Kerr committed
159 160

    def contributor_projects(self):
161 162 163 164
        submitters = Person.objects.filter(user=self.user)
        return Project.objects.filter(id__in=Patch.objects.filter(
            submitter__in=submitters)
            .values('project_id').query)
Jeremy Kerr's avatar
Jeremy Kerr committed
165 166 167 168

    def sync_person(self):
        pass

169 170
    def n_todo(self):
        return self.todo_patches().count() + self.todo_series().count()
Jeremy Kerr's avatar
Jeremy Kerr committed
171

172
    def todo_patches(self, project=None):
Jeremy Kerr's avatar
Jeremy Kerr committed
173 174 175

        # filter on project, if necessary
        if project:
176
            qs = Patch.objects.filter(project=project)
Jeremy Kerr's avatar
Jeremy Kerr committed
177 178 179
        else:
            qs = Patch.objects

180 181 182 183
        qs = qs.filter(archived=False) \
            .filter(delegate=self.user) \
            .filter(state__in=State.objects.filter(action_required=True)
                    .values('pk').query)
Jeremy Kerr's avatar
Jeremy Kerr committed
184 185
        return qs

186 187 188 189 190 191 192
    def todo_series(self, project=None):
        # filter on project, if necessary
        if project:
            qs = Series.objects.filter(project=project)
        else:
            qs = Series.objects

193 194
        qs = qs.filter(Q(reviewer=self.user),
                       ~Q(last_revision__state=RevisionState.DONE))
195 196
        return qs

197
    def __str__(self):
Jeremy Kerr's avatar
Jeremy Kerr committed
198 199
        return self.name()

200

201 202
def _user_saved_callback(sender, created, instance, **kwargs):
    try:
203
        profile = instance.profile
204
    except UserProfile.DoesNotExist:
205
        profile = UserProfile(user=instance)
206 207
    profile.save()

208

209 210
models.signals.post_save.connect(_user_saved_callback, sender=User)

211

212
@python_2_unicode_compatible
Jeremy Kerr's avatar
Jeremy Kerr committed
213
class State(models.Model):
214 215 216
    name = models.CharField(max_length=100)
    ordering = models.IntegerField(unique=True)
    action_required = models.BooleanField(default=True)
Jeremy Kerr's avatar
Jeremy Kerr committed
217

218 219 220 221
    @classmethod
    def from_string(cls, name):
        return State.objects.get(name__iexact=name)

222
    def __str__(self):
Jeremy Kerr's avatar
Jeremy Kerr committed
223 224 225 226 227
        return self.name

    class Meta:
        ordering = ['ordering']

228

229
@python_2_unicode_compatible
Jeremy Kerr's avatar
Jeremy Kerr committed
230 231 232
class Tag(models.Model):
    name = models.CharField(max_length=20)
    pattern = models.CharField(max_length=50,
233 234 235
            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:')
Jeremy Kerr's avatar
Jeremy Kerr committed
236
    abbrev = models.CharField(max_length=2, unique=True,
237 238
            help_text='Short (one-or-two letter) abbreviation for the tag, '
                       'used in table column headers')
Jeremy Kerr's avatar
Jeremy Kerr committed
239 240 241 242 243

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

244 245 246
    def __str__(self):
        return self.name

Jeremy Kerr's avatar
Jeremy Kerr committed
247 248 249
    class Meta:
        ordering = ['abbrev']

250

Jeremy Kerr's avatar
Jeremy Kerr committed
251
class PatchTag(models.Model):
252 253
    patch = models.ForeignKey('Patch', on_delete=models.CASCADE)
    tag = models.ForeignKey('Tag', on_delete=models.CASCADE)
Jeremy Kerr's avatar
Jeremy Kerr committed
254 255 256 257 258
    count = models.IntegerField(default=1)

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

259

260 261 262
def get_default_initial_patch_state():
    return State.objects.get(ordering=0)

263

Jeremy Kerr's avatar
Jeremy Kerr committed
264 265 266 267 268 269 270 271 272 273 274 275 276 277
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:
278 279 280 281 282
            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)")
Jeremy Kerr's avatar
Jeremy Kerr committed
283 284 285 286
            select_params.append(tag.id)

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

287

Jeremy Kerr's avatar
Jeremy Kerr committed
288 289 290 291 292 293 294 295 296
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)

297

298
def filename(name, ext):
299
    fname_re = re.compile(r'[^-_A-Za-z0-9\.]+')
300 301 302
    str = fname_re.sub('-', name)
    return str.strip('-') + ext

303

304
@python_2_unicode_compatible
Jeremy Kerr's avatar
Jeremy Kerr committed
305
class Patch(models.Model):
306
    project = models.ForeignKey(Project, on_delete=models.CASCADE)
307
    msgid = models.CharField(max_length=255)
Jeremy Kerr's avatar
Jeremy Kerr committed
308 309
    name = models.CharField(max_length=255)
    date = models.DateTimeField(default=datetime.datetime.now)
310
    last_updated = models.DateTimeField(auto_now=True)
311 312 313 314
    submitter = models.ForeignKey(Person, on_delete=models.CASCADE)
    delegate = models.ForeignKey(User, blank=True, null=True,
                                 on_delete=models.CASCADE)
    state = models.ForeignKey(State, null=True, on_delete=models.CASCADE)
315 316 317 318 319 320
    archived = models.BooleanField(default=False)
    headers = models.TextField(blank=True)
    content = models.TextField(null=True, blank=True)
    pull_url = models.CharField(max_length=255, null=True, blank=True)
    commit_ref = models.CharField(max_length=255, null=True, blank=True)
    hash = HashField(null=True, blank=True)
Jeremy Kerr's avatar
Jeremy Kerr committed
321 322 323
    tags = models.ManyToManyField(Tag, through=PatchTag)

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

325 326 327 328 329 330 331 332
    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
333
    def comments(self):
334 335
        """Retrieves all comments of this patch ie. the commit message and the
           answers"""
336
        return Comment.objects.filter(patch=self)
Jeremy Kerr's avatar
Jeremy Kerr committed
337

338 339 340 341
    def series(self):
        try:
            rev = SeriesRevisionPatch.objects.filter(patch=self)[0].revision
            return rev.series
342
        except Exception:
343 344
            return None

Jeremy Kerr's avatar
Jeremy Kerr committed
345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362
    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
363
    def save(self):
364 365
        if not hasattr(self, 'state') or not self.state:
            self.state = get_default_initial_patch_state()
Jeremy Kerr's avatar
Jeremy Kerr committed
366

367
        if self.hash is None and self.content is not None:
Jeremy Kerr's avatar
Jeremy Kerr committed
368
            self.hash = hash_patch(self.content).hexdigest()
Jeremy Kerr's avatar
Jeremy Kerr committed
369

Jeremy Kerr's avatar
Jeremy Kerr committed
370 371 372
        super(Patch, self).save()

    def filename(self):
373
        return filename(self.name, '.patch')
Jeremy Kerr's avatar
Jeremy Kerr committed
374

375 376 377
    def human_name(self):
        return self.name

Jeremy Kerr's avatar
Jeremy Kerr committed
378 379
    @models.permalink
    def get_absolute_url(self):
Arkadiusz Hiler's avatar
Arkadiusz Hiler committed
380
        return ('patch', (), {'patch_id': self.id})
Jeremy Kerr's avatar
Jeremy Kerr committed
381

382 383 384
    def __str__(self):
        return self.name

Jeremy Kerr's avatar
Jeremy Kerr committed
385 386 387
    class Meta:
        verbose_name_plural = 'Patches'
        ordering = ['date']
388
        unique_together = [('msgid', 'project')]
Jeremy Kerr's avatar
Jeremy Kerr committed
389

390

Jeremy Kerr's avatar
Jeremy Kerr committed
391
class Comment(models.Model):
392
    patch = models.ForeignKey(Patch, on_delete=models.CASCADE)
393
    msgid = models.CharField(max_length=255)
394
    submitter = models.ForeignKey(Person, on_delete=models.CASCADE)
395 396
    date = models.DateTimeField(default=datetime.datetime.now)
    headers = models.TextField(blank=True)
Jeremy Kerr's avatar
Jeremy Kerr committed
397 398
    content = models.TextField()

399
    response_re = re.compile(
400
        '^((Tested|Reviewed|Acked|Signed-off|Nacked|Reported)-by|Fixes): .*$',
401
        re.M | re.I)
402 403

    def patch_responses(self):
404 405
        return ''.join([match.group(0) + '\n' for match in
                        self.response_re.finditer(self.content)])
406

Jeremy Kerr's avatar
Jeremy Kerr committed
407 408 409 410 411 412 413 414
    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
415 416
    class Meta:
        ordering = ['date']
417
        unique_together = [('msgid', 'patch')]
Jeremy Kerr's avatar
Jeremy Kerr committed
418

419

Jeremy Kerr's avatar
Jeremy Kerr committed
420
class Bundle(models.Model):
421 422
    owner = models.ForeignKey(User, on_delete=models.CASCADE)
    project = models.ForeignKey(Project, on_delete=models.CASCADE)
423 424 425
    name = models.CharField(max_length=50, null=False, blank=False)
    patches = models.ManyToManyField(Patch, through='BundlePatch')
    public = models.BooleanField(default=False)
Jeremy Kerr's avatar
Jeremy Kerr committed
426 427 428 429

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

Jeremy Kerr's avatar
Jeremy Kerr committed
430
    def ordered_patches(self):
Guilherme Salgado's avatar
Guilherme Salgado committed
431
        return self.patches.order_by('bundlepatch__order')
Jeremy Kerr's avatar
Jeremy Kerr committed
432

433 434
    def append_patch(self, patch):
        # todo: use the aggregate queries in django 1.1
435 436
        orders = BundlePatch.objects.filter(bundle=self).order_by('-order') \
            .values('order')
Jeremy Kerr's avatar
Jeremy Kerr committed
437 438 439 440 441 442 443

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

        # see if the patch is already in this bundle
444
        if BundlePatch.objects.filter(bundle=self, patch=patch).count():
Jeremy Kerr's avatar
Jeremy Kerr committed
445
            raise Exception("patch is already in bundle")
446

447 448
        bp = BundlePatch.objects.create(bundle=self, patch=patch,
                                        order=max_order + 1)
449 450
        bp.save()

Jeremy Kerr's avatar
Jeremy Kerr committed
451 452 453 454 455
    def public_url(self):
        if not self.public:
            return None
        site = Site.objects.get_current()
        return 'http://%s%s' % (site.domain,
Arkadiusz Hiler's avatar
Arkadiusz Hiler committed
456
                                reverse('bundle',
457 458 459 460
                                        kwargs={
                                            'username': self.owner.username,
                                            'bundlename': self.name
                                        }))
Jeremy Kerr's avatar
Jeremy Kerr committed
461

462 463
    @models.permalink
    def get_absolute_url(self):
Arkadiusz Hiler's avatar
Arkadiusz Hiler committed
464
        return ('bundle', (), {
465 466 467
            'username': self.owner.username,
            'bundlename': self.name,
        })
468

469 470 471
    class Meta:
        unique_together = [('owner', 'name')]

472

473
class BundlePatch(models.Model):
474 475
    patch = models.ForeignKey(Patch, on_delete=models.CASCADE)
    bundle = models.ForeignKey(Bundle, on_delete=models.CASCADE)
476 477 478
    order = models.IntegerField()

    class Meta:
Jeremy Kerr's avatar
Jeremy Kerr committed
479 480
        unique_together = [('bundle', 'patch')]
        ordering = ['order']
481

482

Damien Lespiau's avatar
Damien Lespiau committed
483 484
SERIES_DEFAULT_NAME = "Series without cover letter"

485 486 487

class TestState:
    STATE_PENDING = 0
488 489 490 491
    STATE_INFO = 1
    STATE_SUCCESS = 2
    STATE_WARNING = 3
    STATE_FAILURE = 4
492 493
    STATE_CHOICES = (
        (STATE_PENDING, 'pending'),
494
        (STATE_INFO, 'info'),
495 496 497 498 499
        (STATE_SUCCESS, 'success'),
        (STATE_WARNING, 'warning'),
        (STATE_FAILURE, 'failure'),
    )

500 501 502 503 504
    @classmethod
    def from_string(cls, s):
        s2i = {s: i for i, s in cls.STATE_CHOICES}
        return s2i[s]

505

Damien Lespiau's avatar
Damien Lespiau committed
506 507
# This Model represents the "top level" Series, an object that doesn't change
# with the various versions of patches sent to the mailing list.
508
@python_2_unicode_compatible
Damien Lespiau's avatar
Damien Lespiau committed
509
class Series(models.Model):
510
    project = models.ForeignKey(Project, on_delete=models.CASCADE)
Damien Lespiau's avatar
Damien Lespiau committed
511
    name = models.CharField(max_length=200, default=SERIES_DEFAULT_NAME)
512 513
    submitter = models.ForeignKey(Person, related_name='submitters',
                                  on_delete=models.CASCADE)
Damien Lespiau's avatar
Damien Lespiau committed
514
    reviewer = models.ForeignKey(User, related_name='reviewers', null=True,
515
                                 blank=True, on_delete=models.CASCADE)
Damien Lespiau's avatar
Damien Lespiau committed
516 517
    submitted = models.DateTimeField(default=datetime.datetime.now)
    last_updated = models.DateTimeField(auto_now=True)
518 519 520
    # direct access to the latest revision so we can get the latest revision
    # information with a JOIN
    last_revision = models.OneToOneField('SeriesRevision', null=True,
521 522
                                         related_name='+',
                                         on_delete=models.CASCADE)
Damien Lespiau's avatar
Damien Lespiau committed
523 524 525 526 527 528 529 530

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

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

    def get_absolute_url(self):
531
        return reverse('series', kwargs={'series': self.pk})
Damien Lespiau's avatar
Damien Lespiau committed
532 533 534 535 536

    def dump(self):
        print('')
        print('===')
        print('Series: %s' % self)
537 538
        print('    version: %d' % self.version)
        print('    n_patches: %d' % self.n_patches)
Damien Lespiau's avatar
Damien Lespiau committed
539 540 541 542 543 544 545 546 547
        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

548 549 550
    def filename(self):
        return filename(self.name, '.mbox')

551
    def human_name(self):
552 553 554 555 556 557 558 559
        if self.name == SERIES_DEFAULT_NAME:
            if self.last_revision:
                ordered_patches = self.last_revision.ordered_patches()
                if ordered_patches:
                    return "series starting with " + ordered_patches[0].name
            return "Incomplete Series"
        else:
            return self.name
560

561 562 563
    def __str__(self):
        return self.name

564 565
    class Meta:
        verbose_name_plural = 'Series'
566
        ordering = ["-id"]
567

568

569 570 571 572
# 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"])

573 574 575 576 577 578 579 580 581 582 583 584 585

class RevisionState:
    INCOMPLETE = 0
    INITIAL = 1
    IN_PROGRESS = 2
    DONE = 3
    CHOICES = (
        (INCOMPLETE, 'incomplete'),
        (INITIAL, 'initial'),
        (IN_PROGRESS, 'in progress'),
        (DONE, 'done'),
    )

586 587 588 589 590 591
    i2s = dict(CHOICES)

    @classmethod
    def to_string(cls, i):
        return cls.i2s[i]

592 593 594 595 596
    @classmethod
    def from_string(cls, s):
        s2i = {s: i for i, s in cls.CHOICES}
        return s2i[s]

Damien Lespiau's avatar
Damien Lespiau committed
597 598
# 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.
599 600


601
@python_2_unicode_compatible
Damien Lespiau's avatar
Damien Lespiau committed
602
class SeriesRevision(models.Model):
603
    series = models.ForeignKey(Series, on_delete=models.CASCADE)
Damien Lespiau's avatar
Damien Lespiau committed
604 605
    version = models.IntegerField(default=1)
    root_msgid = models.CharField(max_length=255)
606
    cover_letter = models.TextField(null=True, blank=True)
607
    n_patches = models.IntegerField(default=0)
608
    patches = models.ManyToManyField(Patch, through='SeriesRevisionPatch')
609 610 611
    state = models.SmallIntegerField(choices=RevisionState.CHOICES,
                                     default=RevisionState.INCOMPLETE)
    state_summary = jsonfield.JSONField(null=True)
612
    test_state = models.SmallIntegerField(choices=TestState.STATE_CHOICES,
613
                                          null=True, blank=True)
614
    is_rerun = models.BooleanField(default=False)
Damien Lespiau's avatar
Damien Lespiau committed
615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632

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

633
        if self.patches_count == self.n_patches:
634 635
            series_revision_complete.send(sender=self.__class__, revision=self)

636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655
    @property
    def patches_count(self):
        return self.patches.count()

    @property
    def is_complete(self):
        return self.patches_count >= self.n_patches

    @property
    def is_strange(self):
        if self.patches_count > self.n_patches:
            return True

        names = [patch.name for patch in self.ordered_patches()]

        # one patch "series", not much to break
        if len(names) == 1:
            return False

        for index, name in enumerate(names):
656
            match = re.search(r"\[[^]]*?(\d+)/(\d+).*\]", name)
657 658 659 660 661 662 663
            if not match:  # we have a patch without proper numbering
                return True
            if (index + 1) != int(match.group(1)):  # numbering is off
                return True

        return False

664 665 666 667 668
    def duplicate_meta(self):
        new = SeriesRevision.objects.get(pk=self.pk)
        new.pk = None
        new.cover_letter = None
        new.version = self.version + 1
669
        new.test_state = None
670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687
        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

688 689 690 691
    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])
692 693 694 695
        else:
            self.test_state = None
        self.save()
        self.series.save()
696

697 698 699 700 701 702 703 704
    def human_name(self):
        name = self.series.name
        if name == SERIES_DEFAULT_NAME:
            name = "series starting with " + self.ordered_patches()[0].name
        if self.version > 1:
            name += " (rev%d)" % self.version
        return name

705
    def __str__(self):
706
        return "Revision " + str(self.version)
Damien Lespiau's avatar
Damien Lespiau committed
707

708

Damien Lespiau's avatar
Damien Lespiau committed
709
class SeriesRevisionPatch(models.Model):
710 711
    patch = models.ForeignKey(Patch, on_delete=models.CASCADE)
    revision = models.ForeignKey(SeriesRevision, on_delete=models.CASCADE)
Damien Lespiau's avatar
Damien Lespiau committed
712 713 714 715 716 717
    order = models.IntegerField()

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

718

719 720 721
class Event(models.Model):
    name = models.CharField(max_length=20)

722

723
class EventLog(models.Model):
724
    event = models.ForeignKey(Event, on_delete=models.CASCADE)
725
    event_time = models.DateTimeField(auto_now=True)
726 727
    series = models.ForeignKey(Series, null=True, on_delete=models.CASCADE)
    user = models.ForeignKey(User, null=True, on_delete=models.CASCADE)
728
    parameters = jsonfield.JSONField(null=True)
729
    patch = models.ForeignKey(Patch, null=True, on_delete=models.CASCADE)
730 731 732 733

    class Meta:
        ordering = ['-event_time']

734

735
@python_2_unicode_compatible
736
class Test(models.Model):
737 738 739 740 741 742 743
    # 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
744 745
    # send mail to the addresses listed in the mail_to_list field only
    RECIPIENT_TO_LIST = 3
746 747 748 749
    RECIPIENT_CHOICES = (
        (RECIPIENT_NONE, 'none'),
        (RECIPIENT_SUBMITTER, 'submitter'),
        (RECIPIENT_MAILING_LIST, 'mailing list'),
750
        (RECIPIENT_TO_LIST, 'recipient list'),
751 752 753 754
    )

    # send result mail on any state (but pending)
    CONDITION_ALWAYS = 0
755 756 757 758
    # send result mail on warning or failure
    CONDITION_ON_WARNING = 1
    # send result mail on error
    CONDITION_ON_FAILURE = 2
759 760
    CONDITION_CHOICES = (
        (CONDITION_ALWAYS, 'always'),
761
        (CONDITION_ON_WARNING, 'on warning/failure'),
762 763 764
        (CONDITION_ON_FAILURE, 'on failure'),
    )

765
    project = models.ForeignKey(Project, on_delete=models.CASCADE)
766
    name = models.CharField(max_length=255)
767 768
    mail_recipient = models.SmallIntegerField(choices=RECIPIENT_CHOICES,
                                              default=RECIPIENT_NONE)
769 770 771
    # 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,
772
                                    help_text='Comma separated list of emails')
773
    mail_cc_list = models.CharField(max_length=255, blank=True, null=True,
774
                                    help_text='Comma separated list of emails')
775 776
    mail_condition = models.SmallIntegerField(choices=CONDITION_CHOICES,
                                              default=CONDITION_ALWAYS)
777 778 779 780

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

781 782 783 784 785 786
    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)

787
    def __str__(self):
788 789
        return self.name

790

791
@python_2_unicode_compatible
792 793
class TestResult(models.Model):

794 795 796 797 798 799
    test = models.ForeignKey(Test, on_delete=models.CASCADE)
    revision = models.ForeignKey(SeriesRevision, blank=True, null=True,
                                 on_delete=models.CASCADE)
    patch = models.ForeignKey(Patch, blank=True, null=True,
                              on_delete=models.CASCADE)
    user = models.ForeignKey(User, on_delete=models.CASCADE)
800
    date = models.DateTimeField(auto_now=True)
801
    state = models.SmallIntegerField(choices=TestState.STATE_CHOICES)
802 803 804
    url = models.URLField(blank=True, null=True)
    summary = models.TextField(blank=True, null=True)

805 806 807
    def __str__(self):
        return self.get_state_display()

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

811

812
class EmailConfirmation(models.Model):
813 814 815 816 817 818 819
    validity = datetime.timedelta(days=settings.CONFIRMATION_VALIDITY_DAYS)
    type = models.CharField(max_length=20, choices=[
        ('userperson', 'User-Person association'),
        ('registration', 'Registration'),
        ('optout', 'Email opt-out'),
    ])
    email = models.CharField(max_length=200)
820
    user = models.ForeignKey(User, null=True, on_delete=models.CASCADE)
821
    key = HashField()
822 823
    date = models.DateTimeField(default=datetime.datetime.now)
    active = models.BooleanField(default=True)
824

825
    def deactivate(self):
826
        self.active = False
827
        self.save()
828

829 830 831
    def is_valid(self):
        return self.date + self.validity > datetime.datetime.now()

832 833 834 835 836
    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()
837
        super(EmailConfirmation, self).save()
838

839

840
@python_2_unicode_compatible
Jeremy Kerr's avatar
Jeremy Kerr committed
841
class EmailOptout(models.Model):
842
    email = models.CharField(max_length=200, primary_key=True)
843

Jeremy Kerr's avatar
Jeremy Kerr committed
844 845 846
    @classmethod
    def is_optout(cls, email):
        email = email.lower().strip()
847
        return cls.objects.filter(email=email).count() > 0
Jeremy Kerr's avatar
Jeremy Kerr committed
848

849 850 851
    def __str__(self):
        return self.email

852

853
class PatchChangeNotification(models.Model):
854 855
    patch = models.OneToOneField(Patch, primary_key=True,
                                 on_delete=models.CASCADE)
856
    last_modified = models.DateTimeField(default=datetime.datetime.now)
857
    orig_state = models.ForeignKey(State, on_delete=models.CASCADE)
858

859

860
def _patch_change_log_event(old_patch, new_patch):
861 862 863
    # If state changed, log the event
    event_state_change = Event.objects.get(name='patch-state-change')
    curr_user = threadlocalrequest.get_current_user()
864 865
    previous_state = str(old_patch.state)
    new_state = str(new_patch.state)
866 867 868

    # Do not log patch-state-change events for Patches that are not part of a
    # Series (ie patches older than the introduction of Series)
869
    series = old_patch.series()
870 871
    if series:
        log = EventLog(event=event_state_change,
872 873
                       user=curr_user,
                       series_id=series.id,
874
                       patch=old_patch,
875 876 877
                       parameters={'previous_state': previous_state,
                                   'new_state': new_state,
                                  })
878 879
        log.save()

880 881 882

def _patch_change_send_notification(old_patch, new_patch):
    if not