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

345 346 347 348 349
    def all_revisions(self):
        srp = SeriesRevisionPatch.objects.filter(patch=self)
        revs = [x.revision for x in srp]
        return revs

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

372
        if self.hash is None and self.content is not None:
Jeremy Kerr's avatar
Jeremy Kerr committed
373
            self.hash = hash_patch(self.content).hexdigest()
Jeremy Kerr's avatar
Jeremy Kerr committed
374

Jeremy Kerr's avatar
Jeremy Kerr committed
375 376 377
        super(Patch, self).save()

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

380 381 382
    def human_name(self):
        return self.name

Jeremy Kerr's avatar
Jeremy Kerr committed
383 384
    @models.permalink
    def get_absolute_url(self):
Arkadiusz Hiler's avatar
Arkadiusz Hiler committed
385
        return ('patch', (), {'patch_id': self.id})
Jeremy Kerr's avatar
Jeremy Kerr committed
386

387 388 389
    def __str__(self):
        return self.name

Jeremy Kerr's avatar
Jeremy Kerr committed
390 391 392
    class Meta:
        verbose_name_plural = 'Patches'
        ordering = ['date']
393
        unique_together = [('msgid', 'project')]
Jeremy Kerr's avatar
Jeremy Kerr committed
394

395

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

404
    response_re = re.compile(
405
        '^((Tested|Reviewed|Acked|Signed-off|Nacked|Reported)-by|Fixes): .*$',
406
        re.M | re.I)
407 408

    def patch_responses(self):
409 410
        return ''.join([match.group(0) + '\n' for match in
                        self.response_re.finditer(self.content)])
411

Jeremy Kerr's avatar
Jeremy Kerr committed
412 413 414 415 416 417 418 419
    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
420 421
    class Meta:
        ordering = ['date']
422
        unique_together = [('msgid', 'patch')]
Jeremy Kerr's avatar
Jeremy Kerr committed
423

424

Jeremy Kerr's avatar
Jeremy Kerr committed
425
class Bundle(models.Model):
426 427
    owner = models.ForeignKey(User, on_delete=models.CASCADE)
    project = models.ForeignKey(Project, on_delete=models.CASCADE)
428 429 430
    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
431 432 433 434

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

Jeremy Kerr's avatar
Jeremy Kerr committed
435
    def ordered_patches(self):
Guilherme Salgado's avatar
Guilherme Salgado committed
436
        return self.patches.order_by('bundlepatch__order')
Jeremy Kerr's avatar
Jeremy Kerr committed
437

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

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

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

452 453
        bp = BundlePatch.objects.create(bundle=self, patch=patch,
                                        order=max_order + 1)
454 455
        bp.save()

Jeremy Kerr's avatar
Jeremy Kerr committed
456 457 458 459 460
    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
461
                                reverse('bundle',
462 463 464 465
                                        kwargs={
                                            'username': self.owner.username,
                                            'bundlename': self.name
                                        }))
Jeremy Kerr's avatar
Jeremy Kerr committed
466

467 468
    @models.permalink
    def get_absolute_url(self):
Arkadiusz Hiler's avatar
Arkadiusz Hiler committed
469
        return ('bundle', (), {
470 471 472
            'username': self.owner.username,
            'bundlename': self.name,
        })
473

474 475 476
    class Meta:
        unique_together = [('owner', 'name')]

477

478
class BundlePatch(models.Model):
479 480
    patch = models.ForeignKey(Patch, on_delete=models.CASCADE)
    bundle = models.ForeignKey(Bundle, on_delete=models.CASCADE)
481 482 483
    order = models.IntegerField()

    class Meta:
Jeremy Kerr's avatar
Jeremy Kerr committed
484 485
        unique_together = [('bundle', 'patch')]
        ordering = ['order']
486

487

Damien Lespiau's avatar
Damien Lespiau committed
488 489
SERIES_DEFAULT_NAME = "Series without cover letter"

490 491 492

class TestState:
    STATE_PENDING = 0
493 494 495 496
    STATE_INFO = 1
    STATE_SUCCESS = 2
    STATE_WARNING = 3
    STATE_FAILURE = 4
497 498
    STATE_CHOICES = (
        (STATE_PENDING, 'pending'),
499
        (STATE_INFO, 'info'),
500 501 502 503 504
        (STATE_SUCCESS, 'success'),
        (STATE_WARNING, 'warning'),
        (STATE_FAILURE, 'failure'),
    )

505 506 507 508 509
    @classmethod
    def from_string(cls, s):
        s2i = {s: i for i, s in cls.STATE_CHOICES}
        return s2i[s]

510

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

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

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

    def get_absolute_url(self):
536
        return reverse('series', kwargs={'series': self.pk})
Damien Lespiau's avatar
Damien Lespiau committed
537 538 539 540 541

    def dump(self):
        print('')
        print('===')
        print('Series: %s' % self)
542 543
        print('    version: %d' % self.version)
        print('    n_patches: %d' % self.n_patches)
Damien Lespiau's avatar
Damien Lespiau committed
544 545 546 547 548 549 550 551 552
        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

553 554 555
    def filename(self):
        return filename(self.name, '.mbox')

556
    def human_name(self):
557 558 559 560 561 562 563 564
        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
565

566 567 568
    def __str__(self):
        return self.name

569 570
    class Meta:
        verbose_name_plural = 'Series'
571
        ordering = ["-id"]
572

573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590
    def __lt__(self, other):
        return self.pk < other.pk

    def __le__(self, other):
        return self.pk <= other.pk

    def __eq__(self, other):
        return self.pk == other.pk

    def __ne__(self, other):
        return self.pk != other.pk

    def __gt__(self, other):
        return self.pk > other.pk

    def __ge__(self, other):
        return self.pk >= other.pk

591

592 593 594 595
# 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"])

596 597 598 599 600 601 602 603 604 605 606 607 608

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

609 610 611 612 613 614
    i2s = dict(CHOICES)

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

615 616 617 618 619
    @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
620 621
# 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.
622 623


624
@python_2_unicode_compatible
Damien Lespiau's avatar
Damien Lespiau committed
625
class SeriesRevision(models.Model):
626
    series = models.ForeignKey(Series, on_delete=models.CASCADE)
Damien Lespiau's avatar
Damien Lespiau committed
627 628
    version = models.IntegerField(default=1)
    root_msgid = models.CharField(max_length=255)
629
    cover_letter = models.TextField(null=True, blank=True)
630 631
    raw_cover_letter = models.TextField(null=True, blank=True)
    raw_cover_letter_headers = models.TextField(null=True, blank=True)
632
    n_patches = models.IntegerField(default=0)
633
    patches = models.ManyToManyField(Patch, through='SeriesRevisionPatch')
634 635 636
    state = models.SmallIntegerField(choices=RevisionState.CHOICES,
                                     default=RevisionState.INCOMPLETE)
    state_summary = jsonfield.JSONField(null=True)
637
    test_state = models.SmallIntegerField(choices=TestState.STATE_CHOICES,
638
                                          null=True, blank=True)
639
    is_rerun = models.BooleanField(default=False)
Damien Lespiau's avatar
Damien Lespiau committed
640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657

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

658
        if self.patches_count == self.n_patches:
659 660
            series_revision_complete.send(sender=self.__class__, revision=self)

661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680
    @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):
681
            match = re.search(r"\[[^]]*?(\d+)/(\d+).*\]", name)
682 683 684 685 686 687 688
            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

689 690 691
    def duplicate_meta(self):
        new = SeriesRevision.objects.get(pk=self.pk)
        new.pk = None
692 693 694
        new.cover_letter = self.cover_letter
        new.raw_cover_letter = self.raw_cover_letter
        new.raw_cover_letter_headers = self.raw_cover_letter_headers
695
        new.version = self.version + 1
696
        new.test_state = None
697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714
        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

715 716 717 718
    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])
719 720 721 722
        else:
            self.test_state = None
        self.save()
        self.series.save()
723

724 725 726 727 728 729 730 731
    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

732
    def __str__(self):
733
        return "Revision " + str(self.version)
Damien Lespiau's avatar
Damien Lespiau committed
734

735

Damien Lespiau's avatar
Damien Lespiau committed
736
class SeriesRevisionPatch(models.Model):
737 738
    patch = models.ForeignKey(Patch, on_delete=models.CASCADE)
    revision = models.ForeignKey(SeriesRevision, on_delete=models.CASCADE)
Damien Lespiau's avatar
Damien Lespiau committed
739 740 741 742 743 744
    order = models.IntegerField()

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

745

746 747 748
class Event(models.Model):
    name = models.CharField(max_length=20)

749

750
class EventLog(models.Model):
751
    event = models.ForeignKey(Event, on_delete=models.CASCADE)
752
    event_time = models.DateTimeField(auto_now=True)
753 754
    series = models.ForeignKey(Series, null=True, on_delete=models.CASCADE)
    user = models.ForeignKey(User, null=True, on_delete=models.CASCADE)
755
    parameters = jsonfield.JSONField(null=True)
756
    patch = models.ForeignKey(Patch, null=True, on_delete=models.CASCADE)
757 758 759 760

    class Meta:
        ordering = ['-event_time']

761

762
@python_2_unicode_compatible
763
class Test(models.Model):
764 765 766 767 768 769 770
    # 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
771 772
    # send mail to the addresses listed in the mail_to_list field only
    RECIPIENT_TO_LIST = 3
773 774
    # send mail to mailing list only
    RECIPIENT_MAILING_LIST_ONLY = 4
775 776 777
    RECIPIENT_CHOICES = (
        (RECIPIENT_NONE, 'none'),
        (RECIPIENT_SUBMITTER, 'submitter'),
778
        (RECIPIENT_MAILING_LIST, 'submitter and mailing list'),
779
        (RECIPIENT_TO_LIST, 'recipient list'),
780
        (RECIPIENT_MAILING_LIST_ONLY, 'mailing list only'),
781 782 783 784
    )

    # send result mail on any state (but pending)
    CONDITION_ALWAYS = 0
785 786 787 788
    # send result mail on warning or failure
    CONDITION_ON_WARNING = 1
    # send result mail on error
    CONDITION_ON_FAILURE = 2
789 790
    CONDITION_CHOICES = (
        (CONDITION_ALWAYS, 'always'),
791
        (CONDITION_ON_WARNING, 'on warning/failure'),
792 793 794
        (CONDITION_ON_FAILURE, 'on failure'),
    )

795
    project = models.ForeignKey(Project, on_delete=models.CASCADE)
796
    name = models.CharField(max_length=255)
797 798
    mail_recipient = models.SmallIntegerField(choices=RECIPIENT_CHOICES,
                                              default=RECIPIENT_NONE)
799 800 801
    # 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,
802
                                    help_text='Comma separated list of emails')
803
    mail_cc_list = models.CharField(max_length=255, blank=True, null=True,
804
                                    help_text='Comma separated list of emails')
805 806
    mail_condition = models.SmallIntegerField(choices=CONDITION_CHOICES,
                                              default=CONDITION_ALWAYS)
807 808 809 810

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

811 812 813 814 815 816
    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)

817
    def __str__(self):
818 819
        return self.name

820

821
@python_2_unicode_compatible
822 823
class TestResult(models.Model):

824 825 826 827 828 829
    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)
830
    date = models.DateTimeField(auto_now=True)
831
    state = models.SmallIntegerField(choices=TestState.STATE_CHOICES)
832 833 834
    url = models.URLField(blank=True, null=True)
    summary = models.TextField(blank=True, null=True)

835 836 837
    def __str__(self):
        return self.get_state_display()

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

841

842
class EmailConfirmation(models.Model):
843 844 845 846 847 848 849
    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)
850
    user = models.ForeignKey(User, null=True, on_delete=models.CASCADE)
851
    key = HashField()
852 853
    date = models.DateTimeField(default=datetime.datetime.now)
    active = models.BooleanField(default=True)
854

855
    def deactivate(self):
856
        self.active = False
857
        self.save()
858

859 860 861
    def is_valid(self):
        return self.date + self.validity > datetime.datetime.now()

862 863 864 865 866
    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()
867
        super(EmailConfirmation, self).save()
868

869

870
@python_2_unicode_compatible
Jeremy Kerr's avatar
Jeremy Kerr committed
871
class EmailOptout(models.Model):
872
    email = models.CharField(max_length=200, primary_key=True)
873

Jeremy Kerr's avatar
Jeremy Kerr committed
874 875 876
    @classmethod
    def is_optout(cls, email):
        email = email.lower().strip()
877
        return cls.objects.filter(email=email).count() > 0
Jeremy Kerr's avatar
Jeremy Kerr committed
878

879 880 881
    def __str__(self):
        return self.email

882

883
class PatchChangeNotification(models.Model):
884 885
    patch = models.OneToOneField(Patch, primary_key=True,
                                 on_delete=models.CASCADE)
886
    last_modified = models.DateTimeField(default=datetime.datetime.now)
887
    orig_state = models.ForeignKey(State, on_delete=models.CASCADE)
888

889

Damien Lespiau's avatar