models.py 32.7 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 26 27
from collections import Counter, OrderedDict
import datetime
import jsonfield
import random
import re
import threadlocalrequest

28
import django
Damien Lespiau's avatar
Damien Lespiau committed
29
from django.conf import settings
30
from django.contrib import auth
Jeremy Kerr's avatar
Jeremy Kerr committed
31 32
from django.contrib.auth.models import User
from django.contrib.sites.models import Site
Damien Lespiau's avatar
Damien Lespiau committed
33
from django.core.urlresolvers import reverse
34 35 36 37
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
38
from django.utils.functional import cached_property
39 40
from django.utils import six
from django.utils.six.moves import filter
Jeremy Kerr's avatar
Jeremy Kerr committed
41

42 43
from patchwork.parser import hash_patch, extract_tags

44

45
@python_2_unicode_compatible
Jeremy Kerr's avatar
Jeremy Kerr committed
46
class Person(models.Model):
47 48 49 50
    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
51

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

58 59 60 61 62 63
    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
64
    def link_to_user(self, user):
65
        self.name = user.profile.name()
Jeremy Kerr's avatar
Jeremy Kerr committed
66 67
        self.user = user

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

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

74

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

82

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

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

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

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

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

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

119

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

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

128

129 130 131 132 133 134 135 136 137 138 139 140 141 142 143
@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'))


144
@python_2_unicode_compatible
Jeremy Kerr's avatar
Jeremy Kerr committed
145
class UserProfile(models.Model):
146 147
    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
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
models.signals.post_save.connect(_user_saved_callback, sender=User)

210

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

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

    class Meta:
        ordering = ['ordering']

223

224 225 226 227 228 229 230
if django.VERSION < (1, 8):
    HashFieldBase = six.with_metaclass(models.SubfieldBase, models.CharField)
else:
    HashFieldBase = models.CharField


class HashField(HashFieldBase):
Jeremy Kerr's avatar
Jeremy Kerr committed
231

232
    def __init__(self, algorithm='sha1', *args, **kwargs):
Jeremy Kerr's avatar
Jeremy Kerr committed
233
        self.algorithm = algorithm
Nate Case's avatar
Nate Case committed
234 235
        try:
            import hashlib
236 237

            def _construct(string=''):
238 239
                if isinstance(string, six.text_type):
                    string = string.encode('utf-8')
Jeremy Kerr's avatar
Jeremy Kerr committed
240 241
                return hashlib.new(self.algorithm, string)
            self.construct = _construct
242
            self.n_bytes = len(hashlib.new(self.algorithm).hexdigest())
Nate Case's avatar
Nate Case committed
243
        except ImportError:
244
            modules = {'sha1': 'sha', 'md5': 'md5'}
Jeremy Kerr's avatar
Jeremy Kerr committed
245

246
            if algorithm not in modules:
Nate Case's avatar
Nate Case committed
247
                raise NameError("Unknown algorithm '%s'" % algorithm)
Jeremy Kerr's avatar
Jeremy Kerr committed
248 249 250 251

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

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

253
        kwargs['max_length'] = self.n_bytes
Jeremy Kerr's avatar
Jeremy Kerr committed
254 255
        super(HashField, self).__init__(*args, **kwargs)

256 257 258
    def from_db_value(self, value, expression, connection, context):
        return self.to_python(value)

259
    def db_type(self, connection=None):
260
        return 'char(%d)' % self.n_bytes
Jeremy Kerr's avatar
Jeremy Kerr committed
261

262

263
@python_2_unicode_compatible
Jeremy Kerr's avatar
Jeremy Kerr committed
264 265 266
class Tag(models.Model):
    name = models.CharField(max_length=20)
    pattern = models.CharField(max_length=50,
267 268 269
            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
270
    abbrev = models.CharField(max_length=2, unique=True,
271 272
            help_text='Short (one-or-two letter) abbreviation for the tag, '
                       'used in table column headers')
Jeremy Kerr's avatar
Jeremy Kerr committed
273 274 275 276 277

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

278 279 280
    def __str__(self):
        return self.name

Jeremy Kerr's avatar
Jeremy Kerr committed
281 282 283
    class Meta:
        ordering = ['abbrev']

284

Jeremy Kerr's avatar
Jeremy Kerr committed
285 286 287 288 289 290 291 292
class PatchTag(models.Model):
    patch = models.ForeignKey('Patch')
    tag = models.ForeignKey('Tag')
    count = models.IntegerField(default=1)

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

293

294 295 296
def get_default_initial_patch_state():
    return State.objects.get(ordering=0)

297

Jeremy Kerr's avatar
Jeremy Kerr committed
298 299 300 301 302 303 304 305 306 307 308 309 310 311
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:
312 313 314 315 316
            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
317 318 319 320
            select_params.append(tag.id)

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

321

Jeremy Kerr's avatar
Jeremy Kerr committed
322 323 324 325 326 327 328 329 330
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)

331

332 333 334 335 336
def filename(name, ext):
    fname_re = re.compile('[^-_A-Za-z0-9\.]+')
    str = fname_re.sub('-', name)
    return str.strip('-') + ext

337

338
@python_2_unicode_compatible
Jeremy Kerr's avatar
Jeremy Kerr committed
339 340
class Patch(models.Model):
    project = models.ForeignKey(Project)
341
    msgid = models.CharField(max_length=255)
Jeremy Kerr's avatar
Jeremy Kerr committed
342 343 344
    name = models.CharField(max_length=255)
    date = models.DateTimeField(default=datetime.datetime.now)
    submitter = models.ForeignKey(Person)
345
    delegate = models.ForeignKey(User, blank=True, null=True)
346
    state = models.ForeignKey(State, null=True)
347 348 349 350 351 352
    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
353 354 355
    tags = models.ManyToManyField(Tag, through=PatchTag)

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

357 358 359 360 361 362 363 364
    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
365
    def comments(self):
366 367
        """Retrieves all comments of this patch ie. the commit message and the
           answers"""
368
        return Comment.objects.filter(patch=self)
Jeremy Kerr's avatar
Jeremy Kerr committed
369

Jeremy Kerr's avatar
Jeremy Kerr committed
370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387
    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
388
    def save(self):
389 390
        if not hasattr(self, 'state') or not self.state:
            self.state = get_default_initial_patch_state()
Jeremy Kerr's avatar
Jeremy Kerr committed
391

392
        if self.hash is None and self.content is not None:
Jeremy Kerr's avatar
Jeremy Kerr committed
393
            self.hash = hash_patch(self.content).hexdigest()
Jeremy Kerr's avatar
Jeremy Kerr committed
394

Jeremy Kerr's avatar
Jeremy Kerr committed
395 396 397 398 399 400 401 402 403
        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

404
        return self.project.is_editable(user)
Jeremy Kerr's avatar
Jeremy Kerr committed
405 406

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

409 410 411
    def human_name(self):
        return self.name

Jeremy Kerr's avatar
Jeremy Kerr committed
412 413 414 415
    @models.permalink
    def get_absolute_url(self):
        return ('patchwork.views.patch.patch', (), {'patch_id': self.id})

416 417 418
    def __str__(self):
        return self.name

Jeremy Kerr's avatar
Jeremy Kerr committed
419 420 421
    class Meta:
        verbose_name_plural = 'Patches'
        ordering = ['date']
422
        unique_together = [('msgid', 'project')]
Jeremy Kerr's avatar
Jeremy Kerr committed
423

424

Jeremy Kerr's avatar
Jeremy Kerr committed
425 426
class Comment(models.Model):
    patch = models.ForeignKey(Patch)
427
    msgid = models.CharField(max_length=255)
Jeremy Kerr's avatar
Jeremy Kerr committed
428
    submitter = models.ForeignKey(Person)
429 430
    date = models.DateTimeField(default=datetime.datetime.now)
    headers = models.TextField(blank=True)
Jeremy Kerr's avatar
Jeremy Kerr committed
431 432
    content = models.TextField()

433 434 435
    response_re = re.compile(
        '^(Tested|Reviewed|Acked|Signed-off|Nacked|Reported)-by: .*$',
        re.M | re.I)
436 437

    def patch_responses(self):
438 439
        return ''.join([match.group(0) + '\n' for match in
                        self.response_re.finditer(self.content)])
440

Jeremy Kerr's avatar
Jeremy Kerr committed
441 442 443 444 445 446 447 448
    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
449 450
    class Meta:
        ordering = ['date']
451
        unique_together = [('msgid', 'patch')]
Jeremy Kerr's avatar
Jeremy Kerr committed
452

453

Jeremy Kerr's avatar
Jeremy Kerr committed
454 455 456
class Bundle(models.Model):
    owner = models.ForeignKey(User)
    project = models.ForeignKey(Project)
457 458 459
    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
460 461 462 463

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

Jeremy Kerr's avatar
Jeremy Kerr committed
464
    def ordered_patches(self):
Guilherme Salgado's avatar
Guilherme Salgado committed
465
        return self.patches.order_by('bundlepatch__order')
Jeremy Kerr's avatar
Jeremy Kerr committed
466

467 468
    def append_patch(self, patch):
        # todo: use the aggregate queries in django 1.1
469 470
        orders = BundlePatch.objects.filter(bundle=self).order_by('-order') \
            .values('order')
Jeremy Kerr's avatar
Jeremy Kerr committed
471 472 473 474 475 476 477

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

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

481 482
        bp = BundlePatch.objects.create(bundle=self, patch=patch,
                                        order=max_order + 1)
483 484
        bp.save()

Jeremy Kerr's avatar
Jeremy Kerr committed
485 486 487 488 489
    def public_url(self):
        if not self.public:
            return None
        site = Site.objects.get_current()
        return 'http://%s%s' % (site.domain,
490 491 492 493 494
                                reverse('patchwork.views.bundle.bundle',
                                        kwargs={
                                            'username': self.owner.username,
                                            'bundlename': self.name
                                        }))
Jeremy Kerr's avatar
Jeremy Kerr committed
495

496 497 498
    @models.permalink
    def get_absolute_url(self):
        return ('patchwork.views.bundle.bundle', (), {
499 500 501
            'username': self.owner.username,
            'bundlename': self.name,
        })
502

503 504 505
    class Meta:
        unique_together = [('owner', 'name')]

506

507 508 509 510 511 512
class BundlePatch(models.Model):
    patch = models.ForeignKey(Patch)
    bundle = models.ForeignKey(Bundle)
    order = models.IntegerField()

    class Meta:
Jeremy Kerr's avatar
Jeremy Kerr committed
513 514
        unique_together = [('bundle', 'patch')]
        ordering = ['order']
515

Damien Lespiau's avatar
Damien Lespiau committed
516 517
SERIES_DEFAULT_NAME = "Series without cover letter"

518 519 520 521 522 523 524 525 526 527 528 529 530

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

531 532 533 534 535
    @classmethod
    def from_string(cls, s):
        s2i = {s: i for i, s in cls.STATE_CHOICES}
        return s2i[s]

536

Damien Lespiau's avatar
Damien Lespiau committed
537 538
# This Model represents the "top level" Series, an object that doesn't change
# with the various versions of patches sent to the mailing list.
539
@python_2_unicode_compatible
Damien Lespiau's avatar
Damien Lespiau committed
540 541 542 543 544 545 546 547
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)
548 549 550 551
    # 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
552 553 554 555 556 557 558 559

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

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

    def get_absolute_url(self):
560
        return reverse('series', kwargs={'series': self.pk})
Damien Lespiau's avatar
Damien Lespiau committed
561 562 563 564 565

    def dump(self):
        print('')
        print('===')
        print('Series: %s' % self)
566 567
        print('    version: %d' % self.version)
        print('    n_patches: %d' % self.n_patches)
Damien Lespiau's avatar
Damien Lespiau committed
568 569 570 571 572 573 574 575 576
        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

577 578 579
    def filename(self):
        return filename(self.name, '.mbox')

580 581 582 583
    def human_name(self):
        name = self.name
        if name == SERIES_DEFAULT_NAME:
            name = "series starting with " + \
584
                    self.last_revision.ordered_patches()[0].name
585 586
        return name

587 588 589
    def __str__(self):
        return self.name

590 591 592
    class Meta:
        verbose_name_plural = 'Series'

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

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

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

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

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

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


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

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

656
        revision_complete = self.patches.count() == self.n_patches
657 658 659
        if revision_complete:
            series_revision_complete.send(sender=self.__class__, revision=self)

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

684 685 686 687 688
    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()
689
            self.series.save()
690

691 692 693 694 695 696 697 698
    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

699
    def __str__(self):
700
        return "Revision " + str(self.version)
Damien Lespiau's avatar
Damien Lespiau committed
701

702

Damien Lespiau's avatar
Damien Lespiau committed
703 704 705 706 707 708 709 710 711
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']

712

713 714 715
class Event(models.Model):
    name = models.CharField(max_length=20)

716

717 718 719 720 721
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)
722
    parameters = jsonfield.JSONField(null=True)
723
    patch = models.ForeignKey(Patch, null=True)
724 725 726 727

    class Meta:
        ordering = ['-event_time']

728

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

    # send result mail on any state (but pending)
    CONDITION_ALWAYS = 0
749 750 751 752
    # send result mail on warning or failure
    CONDITION_ON_WARNING = 1
    # send result mail on error
    CONDITION_ON_FAILURE = 2
753 754
    CONDITION_CHOICES = (
        (CONDITION_ALWAYS, 'always'),
755
        (CONDITION_ON_WARNING, 'on warning/failure'),
756 757 758
        (CONDITION_ON_FAILURE, 'on failure'),
    )

759 760
    project = models.ForeignKey(Project)
    name = models.CharField(max_length=255)
761 762
    mail_recipient = models.SmallIntegerField(choices=RECIPIENT_CHOICES,
                                              default=RECIPIENT_NONE)
763 764 765
    # 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,
766
                                    help_text='Comma separated list of emails')
767
    mail_cc_list = models.CharField(max_length=255, blank=True, null=True,
768
                                    help_text='Comma separated list of emails')
769 770
    mail_condition = models.SmallIntegerField(choices=CONDITION_CHOICES,
                                              default=CONDITION_ALWAYS)
771 772 773 774

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

775 776 777 778 779 780
    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)

781
    def __str__(self):
782 783
        return self.name

784

785
@python_2_unicode_compatible
786 787 788 789 790 791
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)
792
    date = models.DateTimeField(auto_now=True)
793
    state = models.SmallIntegerField(choices=TestState.STATE_CHOICES)
794 795 796
    url = models.URLField(blank=True, null=True)
    summary = models.TextField(blank=True, null=True)

797 798 799
    def __str__(self):
        return self.get_state_display()

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

803

804
class EmailConfirmation(models.Model):
805 806 807 808 809 810 811 812
    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)
813
    key = HashField()
814 815
    date = models.DateTimeField(default=datetime.datetime.now)
    active = models.BooleanField(default=True)
816

817
    def deactivate(self):
818
        self.active = False
819
        self.save()
820

821 822 823
    def is_valid(self):
        return self.date + self.validity > datetime.datetime.now()

824 825 826 827 828
    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()
829
        super(EmailConfirmation, self).save()
830

831

832
@python_2_unicode_compatible
Jeremy Kerr's avatar
Jeremy Kerr committed
833
class EmailOptout(models.Model):
834
    email = models.CharField(max_length=200, primary_key=True)
835

Jeremy Kerr's avatar
Jeremy Kerr committed
836 837 838
    @classmethod
    def is_optout(cls, email):
        email = email.lower().strip()
839
        return cls.objects.filter(email=email).count() > 0
Jeremy Kerr's avatar
Jeremy Kerr committed
840

841 842 843
    def __str__(self):
        return self.email

844

845
class PatchChangeNotification(models.Model):
846 847
    patch = models.OneToOneField(Patch, primary_key=True)
    last_modified = models.DateTimeField(default=datetime.datetime.now)
848 849
    orig_state = models.ForeignKey(State)

850

851 852 853 854 855 856 857 858
def find_series_for_patch(patch):
    try:
        revision = SeriesRevisionPatch.objects.filter(patch=patch)[0].revision
        return revision.series
    except:
        return None


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

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

879 880 881

def _patch_change_send_notification(old_patch, new_patch):
    if not new_patch.project.send_notifications:
882 883
        return

884 885
    notification = None
    try:
886
        notification = PatchChangeNotification.objects.get(patch=new_patch)
887 888 889 890
    except PatchChangeNotification.DoesNotExist:
        pass

    if notification is None:
891 892
        notification = PatchChangeNotification(patch=new_patch,
                                               orig_state=old_patch.state)
893

894
    elif notification.orig_state == new_patch.state:
895 896 897 898 899 900 901
        # 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()

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 954 955 956 957 958 959 960 961 962 963
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):
964 965 966 967 968