models.py 32.3 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
34
import threadlocalrequest
Jeremy Kerr's avatar
Jeremy Kerr committed
35

36 37
from patchwork.parser import hash_patch, extract_tags

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

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 59 60 61 62
    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
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

98 99 100
    def is_editable(self, user):
        if not user.is_authenticated():
            return False
101
        return self in user.profile.maintainer_projects.all()
102

Jeremy Kerr's avatar
Jeremy Kerr committed
103 104 105 106 107 108
    @cached_property
    def tags(self):
        if not self.use_tags:
            return []
        return list(Tag.objects.all())

109
    def get_subject_prefix_tags(self):
110
        return get_comma_separated_field(self.subject_prefix_tags)
111

112 113 114
    def __str__(self):
        return self.name

115 116 117
    class Meta:
        ordering = ['linkname']

118

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

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

127

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

    def __str__(self):
        return self.path

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


143
@python_2_unicode_compatible
Jeremy Kerr's avatar
Jeremy Kerr committed
144
class UserProfile(models.Model):
145 146
    user = models.OneToOneField(User, unique=True, related_name='profile')
    primary_project = models.ForeignKey(Project, null=True, blank=True)
Jeremy Kerr's avatar
Jeremy Kerr committed
147
    maintainer_projects = models.ManyToManyField(Project,
148
             related_name='maintainer_project')
149
    send_email = models.BooleanField(default=False,
150 151 152 153 154
             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')
Jeremy Kerr's avatar
Jeremy Kerr committed
155 156

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

    def contributor_projects(self):
160 161 162 163
        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
164 165 166 167

    def sync_person(self):
        pass

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

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

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

179 180 181 182
        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
183 184
        return qs

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

        qs = qs.filter(reviewer=self.user)
        return qs

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

198

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

206 207
models.signals.post_save.connect(_user_saved_callback, sender=User)

208

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

215
    def __str__(self):
Jeremy Kerr's avatar
Jeremy Kerr committed
216 217 218 219 220
        return self.name

    class Meta:
        ordering = ['ordering']

221

222
@add_metaclass(models.SubfieldBase)
Jeremy Kerr's avatar
Jeremy Kerr committed
223
class HashField(models.CharField):
Jeremy Kerr's avatar
Jeremy Kerr committed
224

225
    def __init__(self, algorithm='sha1', *args, **kwargs):
Jeremy Kerr's avatar
Jeremy Kerr committed
226
        self.algorithm = algorithm
Nate Case's avatar
Nate Case committed
227 228
        try:
            import hashlib
229 230

            def _construct(string=''):
231 232
                if isinstance(string, six.text_type):
                    string = string.encode('utf-8')
Jeremy Kerr's avatar
Jeremy Kerr committed
233 234
                return hashlib.new(self.algorithm, string)
            self.construct = _construct
235
            self.n_bytes = len(hashlib.new(self.algorithm).hexdigest())
Nate Case's avatar
Nate Case committed
236
        except ImportError:
237
            modules = {'sha1': 'sha', 'md5': 'md5'}
Jeremy Kerr's avatar
Jeremy Kerr committed
238

239
            if algorithm not in modules:
Nate Case's avatar
Nate Case committed
240
                raise NameError("Unknown algorithm '%s'" % algorithm)
Jeremy Kerr's avatar
Jeremy Kerr committed
241 242 243 244

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

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

246
        kwargs['max_length'] = self.n_bytes
Jeremy Kerr's avatar
Jeremy Kerr committed
247 248
        super(HashField, self).__init__(*args, **kwargs)

249
    def db_type(self, connection=None):
250
        return 'char(%d)' % self.n_bytes
Jeremy Kerr's avatar
Jeremy Kerr committed
251

252

253
@python_2_unicode_compatible
Jeremy Kerr's avatar
Jeremy Kerr committed
254 255 256
class Tag(models.Model):
    name = models.CharField(max_length=20)
    pattern = models.CharField(max_length=50,
257 258 259
            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
260
    abbrev = models.CharField(max_length=2, unique=True,
261 262
            help_text='Short (one-or-two letter) abbreviation for the tag, '
                       'used in table column headers')
Jeremy Kerr's avatar
Jeremy Kerr committed
263 264 265 266 267

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

268 269 270
    def __str__(self):
        return self.name

Jeremy Kerr's avatar
Jeremy Kerr committed
271 272 273
    class Meta:
        ordering = ['abbrev']

274

Jeremy Kerr's avatar
Jeremy Kerr committed
275 276 277 278 279 280 281 282
class PatchTag(models.Model):
    patch = models.ForeignKey('Patch')
    tag = models.ForeignKey('Tag')
    count = models.IntegerField(default=1)

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

283

284 285 286
def get_default_initial_patch_state():
    return State.objects.get(ordering=0)

287

Jeremy Kerr's avatar
Jeremy Kerr committed
288 289 290 291 292 293 294 295 296 297 298 299 300 301
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:
302 303 304 305 306
            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
307 308 309 310
            select_params.append(tag.id)

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

311

Jeremy Kerr's avatar
Jeremy Kerr committed
312 313 314 315 316 317 318 319 320
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)

321

322 323 324 325 326
def filename(name, ext):
    fname_re = re.compile('[^-_A-Za-z0-9\.]+')
    str = fname_re.sub('-', name)
    return str.strip('-') + ext

327

328
@python_2_unicode_compatible
Jeremy Kerr's avatar
Jeremy Kerr committed
329 330
class Patch(models.Model):
    project = models.ForeignKey(Project)
331
    msgid = models.CharField(max_length=255)
Jeremy Kerr's avatar
Jeremy Kerr committed
332 333 334
    name = models.CharField(max_length=255)
    date = models.DateTimeField(default=datetime.datetime.now)
    submitter = models.ForeignKey(Person)
335
    delegate = models.ForeignKey(User, blank=True, null=True)
336
    state = models.ForeignKey(State, null=True)
337 338 339 340 341 342
    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
343 344 345
    tags = models.ManyToManyField(Tag, through=PatchTag)

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

347 348 349 350 351 352 353 354
    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
355
    def comments(self):
356 357
        """Retrieves all comments of this patch ie. the commit message and the
           answers"""
358
        return Comment.objects.filter(patch=self)
Jeremy Kerr's avatar
Jeremy Kerr committed
359

Jeremy Kerr's avatar
Jeremy Kerr committed
360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377
    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
378
    def save(self):
379 380
        if not hasattr(self, 'state') or not self.state:
            self.state = get_default_initial_patch_state()
Jeremy Kerr's avatar
Jeremy Kerr committed
381

382
        if self.hash is None and self.content is not None:
Jeremy Kerr's avatar
Jeremy Kerr committed
383
            self.hash = hash_patch(self.content).hexdigest()
Jeremy Kerr's avatar
Jeremy Kerr committed
384

Jeremy Kerr's avatar
Jeremy Kerr committed
385 386 387 388 389 390 391 392 393
        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

394
        return self.project.is_editable(user)
Jeremy Kerr's avatar
Jeremy Kerr committed
395 396

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

399 400 401
    def human_name(self):
        return self.name

Jeremy Kerr's avatar
Jeremy Kerr committed
402 403 404 405
    @models.permalink
    def get_absolute_url(self):
        return ('patchwork.views.patch.patch', (), {'patch_id': self.id})

406 407 408
    def __str__(self):
        return self.name

Jeremy Kerr's avatar
Jeremy Kerr committed
409 410 411
    class Meta:
        verbose_name_plural = 'Patches'
        ordering = ['date']
412
        unique_together = [('msgid', 'project')]
Jeremy Kerr's avatar
Jeremy Kerr committed
413

414

Jeremy Kerr's avatar
Jeremy Kerr committed
415 416
class Comment(models.Model):
    patch = models.ForeignKey(Patch)
417
    msgid = models.CharField(max_length=255)
Jeremy Kerr's avatar
Jeremy Kerr committed
418
    submitter = models.ForeignKey(Person)
419 420
    date = models.DateTimeField(default=datetime.datetime.now)
    headers = models.TextField(blank=True)
Jeremy Kerr's avatar
Jeremy Kerr committed
421 422
    content = models.TextField()

423 424 425
    response_re = re.compile(
        '^(Tested|Reviewed|Acked|Signed-off|Nacked|Reported)-by: .*$',
        re.M | re.I)
426 427

    def patch_responses(self):
428 429
        return ''.join([match.group(0) + '\n' for match in
                        self.response_re.finditer(self.content)])
430

Jeremy Kerr's avatar
Jeremy Kerr committed
431 432 433 434 435 436 437 438
    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
439 440
    class Meta:
        ordering = ['date']
441
        unique_together = [('msgid', 'patch')]
Jeremy Kerr's avatar
Jeremy Kerr committed
442

443

Jeremy Kerr's avatar
Jeremy Kerr committed
444 445 446
class Bundle(models.Model):
    owner = models.ForeignKey(User)
    project = models.ForeignKey(Project)
447 448 449
    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
450 451 452 453

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

Jeremy Kerr's avatar
Jeremy Kerr committed
454
    def ordered_patches(self):
Guilherme Salgado's avatar
Guilherme Salgado committed
455
        return self.patches.order_by('bundlepatch__order')
Jeremy Kerr's avatar
Jeremy Kerr committed
456

457 458
    def append_patch(self, patch):
        # todo: use the aggregate queries in django 1.1
459 460
        orders = BundlePatch.objects.filter(bundle=self).order_by('-order') \
            .values('order')
Jeremy Kerr's avatar
Jeremy Kerr committed
461 462 463 464 465 466 467

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

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

471 472
        bp = BundlePatch.objects.create(bundle=self, patch=patch,
                                        order=max_order + 1)
473 474
        bp.save()

Jeremy Kerr's avatar
Jeremy Kerr committed
475 476 477 478 479
    def public_url(self):
        if not self.public:
            return None
        site = Site.objects.get_current()
        return 'http://%s%s' % (site.domain,
480 481 482 483 484
                                reverse('patchwork.views.bundle.bundle',
                                        kwargs={
                                            'username': self.owner.username,
                                            'bundlename': self.name
                                        }))
Jeremy Kerr's avatar
Jeremy Kerr committed
485

486 487 488
    @models.permalink
    def get_absolute_url(self):
        return ('patchwork.views.bundle.bundle', (), {
489 490 491
            'username': self.owner.username,
            'bundlename': self.name,
        })
492

493 494 495
    class Meta:
        unique_together = [('owner', 'name')]

496

497 498 499 500 501 502
class BundlePatch(models.Model):
    patch = models.ForeignKey(Patch)
    bundle = models.ForeignKey(Bundle)
    order = models.IntegerField()

    class Meta:
Jeremy Kerr's avatar
Jeremy Kerr committed
503 504
        unique_together = [('bundle', 'patch')]
        ordering = ['order']
505

Damien Lespiau's avatar
Damien Lespiau committed
506 507
SERIES_DEFAULT_NAME = "Series without cover letter"

508 509 510 511 512 513 514 515 516 517 518 519 520

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

521 522 523 524 525
    @classmethod
    def from_string(cls, s):
        s2i = {s: i for i, s in cls.STATE_CHOICES}
        return s2i[s]

526

Damien Lespiau's avatar
Damien Lespiau committed
527 528
# This Model represents the "top level" Series, an object that doesn't change
# with the various versions of patches sent to the mailing list.
529
@python_2_unicode_compatible
Damien Lespiau's avatar
Damien Lespiau committed
530 531 532 533 534 535 536 537
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)
538 539 540 541
    # 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
542 543 544 545 546 547 548 549

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

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

    def get_absolute_url(self):
550
        return reverse('series', kwargs={'series': self.pk})
Damien Lespiau's avatar
Damien Lespiau committed
551 552 553 554 555

    def dump(self):
        print('')
        print('===')
        print('Series: %s' % self)
556 557
        print('    version: %d' % self.version)
        print('    n_patches: %d' % self.n_patches)
Damien Lespiau's avatar
Damien Lespiau committed
558 559 560 561 562 563 564 565 566
        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

567 568 569
    def filename(self):
        return filename(self.name, '.mbox')

570 571 572 573
    def human_name(self):
        name = self.name
        if name == SERIES_DEFAULT_NAME:
            name = "series starting with " + \
574
                    self.last_revision.ordered_patches()[0].name
575 576
        return name

577 578 579
    def __str__(self):
        return self.name

580 581 582
    class Meta:
        verbose_name_plural = 'Series'

583 584 585 586
# 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"])

587 588 589 590 591 592 593 594 595 596 597 598 599

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

600 601 602 603 604 605
    i2s = dict(CHOICES)

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

606 607 608 609 610
    @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
611 612
# 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.
613 614


615
@python_2_unicode_compatible
Damien Lespiau's avatar
Damien Lespiau committed
616 617 618 619
class SeriesRevision(models.Model):
    series = models.ForeignKey(Series)
    version = models.IntegerField(default=1)
    root_msgid = models.CharField(max_length=255)
620
    cover_letter = models.TextField(null=True, blank=True)
621
    n_patches = models.IntegerField(default=0)
622
    patches = models.ManyToManyField(Patch, through='SeriesRevisionPatch')
623 624 625
    state = models.SmallIntegerField(choices=RevisionState.CHOICES,
                                     default=RevisionState.INCOMPLETE)
    state_summary = jsonfield.JSONField(null=True)
626 627
    test_state = models.SmallIntegerField(choices=TestState.STATE_CHOICES,
                                          null=True)
Damien Lespiau's avatar
Damien Lespiau committed
628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645

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

646
        revision_complete = self.patches.count() == self.n_patches
647 648 649
        if revision_complete:
            series_revision_complete.send(sender=self.__class__, revision=self)

650 651 652 653 654
    def duplicate_meta(self):
        new = SeriesRevision.objects.get(pk=self.pk)
        new.pk = None
        new.cover_letter = None
        new.version = self.version + 1
655
        new.test_state = None
656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673
        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

674 675 676 677 678
    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()
679
            self.series.save()
680

681 682 683 684 685 686 687 688
    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

689
    def __str__(self):
690
        return "Revision " + str(self.version)
Damien Lespiau's avatar
Damien Lespiau committed
691

692

Damien Lespiau's avatar
Damien Lespiau committed
693 694 695 696 697 698 699 700 701
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']

702

703 704 705
class Event(models.Model):
    name = models.CharField(max_length=20)

706

707 708 709 710 711
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)
712
    parameters = jsonfield.JSONField(null=True)
713
    patch = models.ForeignKey(Patch, null=True)
714 715 716 717

    class Meta:
        ordering = ['-event_time']

718

719
@python_2_unicode_compatible
720
class Test(models.Model):
721 722 723 724 725 726 727
    # 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
728 729
    # send mail to the addresses listed in the mail_to_list field only
    RECIPIENT_TO_LIST = 3
730 731 732 733
    RECIPIENT_CHOICES = (
        (RECIPIENT_NONE, 'none'),
        (RECIPIENT_SUBMITTER, 'submitter'),
        (RECIPIENT_MAILING_LIST, 'mailing list'),
734
        (RECIPIENT_TO_LIST, 'recipient list'),
735 736 737 738
    )

    # send result mail on any state (but pending)
    CONDITION_ALWAYS = 0
739 740 741 742
    # send result mail on warning or failure
    CONDITION_ON_WARNING = 1
    # send result mail on error
    CONDITION_ON_FAILURE = 2
743 744
    CONDITION_CHOICES = (
        (CONDITION_ALWAYS, 'always'),
745
        (CONDITION_ON_WARNING, 'on warning/failure'),
746 747 748
        (CONDITION_ON_FAILURE, 'on failure'),
    )

749 750
    project = models.ForeignKey(Project)
    name = models.CharField(max_length=255)
751 752
    mail_recipient = models.SmallIntegerField(choices=RECIPIENT_CHOICES,
                                              default=RECIPIENT_NONE)
753 754 755
    # 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,
756
                                    help_text='Comma separated list of emails')
757
    mail_cc_list = models.CharField(max_length=255, blank=True, null=True,
758
                                    help_text='Comma separated list of emails')
759 760
    mail_condition = models.SmallIntegerField(choices=CONDITION_CHOICES,
                                              default=CONDITION_ALWAYS)
761 762 763 764

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

765 766 767 768 769 770
    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)

771
    def __str__(self):
772 773
        return self.name

774

775
@python_2_unicode_compatible
776 777 778 779 780 781
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)
782
    date = models.DateTimeField(auto_now=True)
783
    state = models.SmallIntegerField(choices=TestState.STATE_CHOICES)
784 785 786
    url = models.URLField(blank=True, null=True)
    summary = models.TextField(blank=True, null=True)

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

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

793

794
class EmailConfirmation(models.Model):
795 796 797 798 799 800 801 802
    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)
    user = models.ForeignKey(User, null=True)
803
    key = HashField()
804 805
    date = models.DateTimeField(default=datetime.datetime.now)
    active = models.BooleanField(default=True)
806

807
    def deactivate(self):
808
        self.active = False
809
        self.save()
810

811 812 813
    def is_valid(self):
        return self.date + self.validity > datetime.datetime.now()

814 815 816 817 818
    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()
819
        super(EmailConfirmation, self).save()
820

821

822
@python_2_unicode_compatible
Jeremy Kerr's avatar
Jeremy Kerr committed
823
class EmailOptout(models.Model):
824
    email = models.CharField(max_length=200, primary_key=True)
825

Jeremy Kerr's avatar
Jeremy Kerr committed
826 827 828
    @classmethod
    def is_optout(cls, email):
        email = email.lower().strip()
829
        return cls.objects.filter(email=email).count() > 0
Jeremy Kerr's avatar
Jeremy Kerr committed
830

831 832 833
    def __str__(self):
        return self.email

834

835
class PatchChangeNotification(models.Model):
836 837
    patch = models.OneToOneField(Patch, primary_key=True)
    last_modified = models.DateTimeField(default=datetime.datetime.now)
838 839
    orig_state = models.ForeignKey(State)

840

841 842 843 844 845 846 847 848
def find_series_for_patch(patch):
    try:
        revision = SeriesRevisionPatch.objects.filter(patch=patch)[0].revision
        return revision.series
    except:
        return None


849
def _patch_change_log_event(old_patch, new_patch):
850 851 852
    # If state changed, log the event
    event_state_change = Event.objects.get(name='patch-state-change')
    curr_user = threadlocalrequest.get_current_user()
853 854
    previous_state = str(old_patch.state)
    new_state = str(new_patch.state)
855 856 857

    # Do not log patch-state-change events for Patches that are not part of a
    # Series (ie patches older than the introduction of Series)
858
    series = find_series_for_patch(old_patch)
859 860
    if series:
        log = EventLog(event=event_state_change,
861 862
                       user=curr_user,
                       series_id=series.id,
863
                       patch=old_patch,
864 865 866
                       parameters={'previous_state': previous_state,
                                   'new_state': new_state,
                                  })
867 868
        log.save()

869 870 871

def _patch_change_send_notification(old_patch, new_patch):
    if not new_patch.project.send_notifications:
872 873
        return

874 875
    notification = None
    try:
876
        notification = PatchChangeNotification.objects.get(patch=new_patch)
877 878 879 880
    except PatchChangeNotification.DoesNotExist:
        pass

    if notification is None:
881 882
        notification = PatchChangeNotification(patch=new_patch,
                                               orig_state=old_patch.state)
883

884
    elif notification.orig_state == new_patch.state:
885 886 887 888 889 890 891
        # 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()

892

893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953
def _revision_is_done(revision, summary):
    for entry in summary:
        if entry[2]:  # state__action_required
            return False
    return True


def _revision_update_state(revision):
    # the order_by() clears the default ordering (from the Meta class) which
    # would be used in the GROUP BY clause otherwise. See:
    # https://docs.djangoproject.com/en/1.8/topics/db/aggregation/#interaction-with-default-ordering-or-order-by
    summary = revision.patches.values_list('state', 'state__name',
                                           'state__action_required',
                                           'state__ordering') \
                              .annotate(count=models.Count('state')) \
                              .order_by()
    summary = list(summary)
    summary.sort(key=lambda e: e[3])
    revision.state_summary = [{
        'name': s[1],
        'final': not s[2],
        'count': s[4],
    } for s in summary]

    # revision not yet complete
    revision_complete = revision.patches.count() == revision.n_patches
    if not revision_complete:
        revision.state = RevisionState.INCOMPLETE

    # initial state
    elif len(summary) == 1 and \
       summary[0][0] == get_default_initial_patch_state().pk:
        revision.state = RevisionState.INITIAL

    # done: all patches are in a 'final' state, ie. a state that doesn't
    # require any more action
    elif _revision_is_done(revision, summary):
        revision.state = RevisionState.DONE

    # in progress
    else:
        revision.state = RevisionState.IN_PROGRESS

    revision.save()


def _patch_change_update_revision_state(new_patch):
    # gather all the revisions we need to update (a patch can be part of more
    # than one revision)
    revisions = new_patch.seriesrevision_set.all()

    # we shouldn't hit this since we're careful to not call this function on
    # brand new patches that haven't been linked to a revision yet
    if len(revisions) == 0:
        return

    for rev in revisions:
        _revision_update_state(rev)


def _patch_pre_change_callback(sender, instance, **kwargs):
954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973
    # we only want notification of modified patches
    if instance.pk is None:
        return

    if instance.project is