models.py 21.9 KB
Newer Older
Jeremy Kerr's avatar
Jeremy Kerr committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
# Patchwork - automated patch tracking system
# Copyright (C) 2008 Jeremy Kerr <jk@ozlabs.org>
#
# 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

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

import re
import datetime, time
import random
Jeremy Kerr's avatar
Jeremy Kerr committed
35
from collections import Counter, OrderedDict
36

Jeremy Kerr's avatar
Jeremy Kerr committed
37 38
class Person(models.Model):
    email = models.CharField(max_length=255, unique = True)
39
    name = models.CharField(max_length=255, null = True, blank = True)
40 41
    user = models.ForeignKey(User, null = True, blank = True,
            on_delete = models.SET_NULL)
Jeremy Kerr's avatar
Jeremy Kerr committed
42

43
    def display_name(self):
Jeremy Kerr's avatar
Jeremy Kerr committed
44
        if self.name:
45
            return self.name
Jeremy Kerr's avatar
Jeremy Kerr committed
46 47 48
        else:
            return self.email

49 50 51
    def __unicode__(self):
        return self.display_name()

Jeremy Kerr's avatar
Jeremy Kerr committed
52
    def link_to_user(self, user):
53
        self.name = user.profile.name()
Jeremy Kerr's avatar
Jeremy Kerr committed
54 55 56 57 58 59 60 61 62 63
        self.user = user

    class Meta:
        verbose_name_plural = 'People'

class Project(models.Model):
    linkname = models.CharField(max_length=255, unique=True)
    name = models.CharField(max_length=255, unique=True)
    listid = models.CharField(max_length=255, unique=True)
    listemail = models.CharField(max_length=200)
Simo Sorce's avatar
Simo Sorce committed
64 65 66
    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
67
    send_notifications = models.BooleanField(default=False)
Jeremy Kerr's avatar
Jeremy Kerr committed
68
    use_tags = models.BooleanField(default=True)
69
    git_send_email_only = models.BooleanField(default=False)
Jeremy Kerr's avatar
Jeremy Kerr committed
70

71
    def __unicode__(self):
Jeremy Kerr's avatar
Jeremy Kerr committed
72 73
        return self.name

74 75 76
    def is_editable(self, user):
        if not user.is_authenticated():
            return False
77
        return self in user.profile.maintainer_projects.all()
78

Jeremy Kerr's avatar
Jeremy Kerr committed
79 80 81 82 83 84
    @cached_property
    def tags(self):
        if not self.use_tags:
            return []
        return list(Tag.objects.all())

85 86 87
    class Meta:
        ordering = ['linkname']

88 89 90 91 92
def user_name(user):
    if user.first_name or user.last_name:
        names = filter(bool, [user.first_name, user.last_name])
        return u' '.join(names)
    return user.username
93

94 95
auth.models.User.add_to_class('name', user_name)

Jeremy Kerr's avatar
Jeremy Kerr committed
96
class UserProfile(models.Model):
97
    user = models.OneToOneField(User, unique = True, related_name='profile')
98
    primary_project = models.ForeignKey(Project, null = True, blank = True)
Jeremy Kerr's avatar
Jeremy Kerr committed
99 100 101 102 103 104 105 106 107 108
    maintainer_projects = models.ManyToManyField(Project,
            related_name = 'maintainer_project')
    send_email = models.BooleanField(default = False,
            help_text = 'Selecting this option allows patchwork to send ' +
                'email on your behalf')
    patches_per_page = models.PositiveIntegerField(default = 100,
            null = False, blank = False,
            help_text = 'Number of patches to display per page')

    def name(self):
109
        return user_name(self.user)
Jeremy Kerr's avatar
Jeremy Kerr committed
110 111 112

    def contributor_projects(self):
        submitters = Person.objects.filter(user = self.user)
113 114 115 116
        return Project.objects.filter(id__in =
                                        Patch.objects.filter(
                                            submitter__in = submitters)
                                        .values('project_id').query)
Jeremy Kerr's avatar
Jeremy Kerr committed
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133

    def sync_person(self):
        pass

    def n_todo_patches(self):
        return self.todo_patches().count()

    def todo_patches(self, project = None):

        # filter on project, if necessary
        if project:
            qs = Patch.objects.filter(project = project)
        else:
            qs = Patch.objects

        qs = qs.filter(archived = False) \
             .filter(delegate = self.user) \
134 135
             .filter(state__in =
                     State.objects.filter(action_required = True)
Jeremy Kerr's avatar
Jeremy Kerr committed
136 137 138
                         .values('pk').query)
        return qs

139
    def __unicode__(self):
Jeremy Kerr's avatar
Jeremy Kerr committed
140 141
        return self.name()

142 143
def _user_saved_callback(sender, created, instance, **kwargs):
    try:
144
        profile = instance.profile
145 146
    except UserProfile.DoesNotExist:
        profile = UserProfile(user = instance)
147 148
    profile.save()

149
models.signals.post_save.connect(_user_saved_callback, sender = User)
150

Jeremy Kerr's avatar
Jeremy Kerr committed
151 152 153 154 155
class State(models.Model):
    name = models.CharField(max_length = 100)
    ordering = models.IntegerField(unique = True)
    action_required = models.BooleanField(default = True)

156
    def __unicode__(self):
Jeremy Kerr's avatar
Jeremy Kerr committed
157 158 159 160 161
        return self.name

    class Meta:
        ordering = ['ordering']

Jeremy Kerr's avatar
Jeremy Kerr committed
162
class HashField(models.CharField):
Jeremy Kerr's avatar
Jeremy Kerr committed
163 164 165 166
    __metaclass__ = models.SubfieldBase

    def __init__(self, algorithm = 'sha1', *args, **kwargs):
        self.algorithm = algorithm
Nate Case's avatar
Nate Case committed
167 168
        try:
            import hashlib
Jeremy Kerr's avatar
Jeremy Kerr committed
169 170 171
            def _construct(string = ''):
                return hashlib.new(self.algorithm, string)
            self.construct = _construct
172
            self.n_bytes = len(hashlib.new(self.algorithm).hexdigest())
Nate Case's avatar
Nate Case committed
173
        except ImportError:
Jeremy Kerr's avatar
Jeremy Kerr committed
174 175 176
            modules = { 'sha1': 'sha', 'md5': 'md5'}

            if algorithm not in modules.keys():
Nate Case's avatar
Nate Case committed
177
                raise NameError("Unknown algorithm '%s'" % algorithm)
Jeremy Kerr's avatar
Jeremy Kerr committed
178 179 180 181

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

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

183
        kwargs['max_length'] = self.n_bytes
Jeremy Kerr's avatar
Jeremy Kerr committed
184 185
        super(HashField, self).__init__(*args, **kwargs)

186
    def db_type(self, connection=None):
187
        return 'char(%d)' % self.n_bytes
Jeremy Kerr's avatar
Jeremy Kerr committed
188

Jeremy Kerr's avatar
Jeremy Kerr committed
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
class Tag(models.Model):
    name = models.CharField(max_length=20)
    pattern = models.CharField(max_length=50,
                help_text='A simple regex to match the tag in the content of '
                    'a message. Will be used with MULTILINE and IGNORECASE '
                    'flags. eg. ^Acked-by:')
    abbrev = models.CharField(max_length=2, unique=True,
                help_text='Short (one-or-two letter) abbreviation for the tag, '
                    'used in table column headers')

    def __unicode__(self):
        return self.name

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

    class Meta:
        ordering = ['abbrev']

class PatchTag(models.Model):
    patch = models.ForeignKey('Patch')
    tag = models.ForeignKey('Tag')
    count = models.IntegerField(default=1)

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

217 218 219
def get_default_initial_patch_state():
    return State.objects.get(ordering=0)

Jeremy Kerr's avatar
Jeremy Kerr committed
220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250
class PatchQuerySet(models.query.QuerySet):

    def with_tag_counts(self, project):
        if not project.use_tags:
            return self

        # We need the project's use_tags field loaded for Project.tags().
        # Using prefetch_related means we'll share the one instance of
        # Project, and share the project.tags cache between all patch.project
        # references.
        qs = self.prefetch_related('project')
        select = OrderedDict()
        select_params = []
        for tag in project.tags:
            select[tag.attr_name] = ("coalesce("
                "(SELECT count FROM patchwork_patchtag "
                "WHERE patchwork_patchtag.patch_id=patchwork_patch.id "
                    "AND patchwork_patchtag.tag_id=%s), 0)")
            select_params.append(tag.id)

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

class PatchManager(models.Manager):
    use_for_related_fields = True

    def get_queryset(self):
        return PatchQuerySet(self.model, using=self.db)

    def with_tag_counts(self, project):
        return self.get_queryset().with_tag_counts(project)

251 252 253 254 255
def filename(name, ext):
    fname_re = re.compile('[^-_A-Za-z0-9\.]+')
    str = fname_re.sub('-', name)
    return str.strip('-') + ext

Jeremy Kerr's avatar
Jeremy Kerr committed
256 257
class Patch(models.Model):
    project = models.ForeignKey(Project)
258
    msgid = models.CharField(max_length=255)
Jeremy Kerr's avatar
Jeremy Kerr committed
259 260 261 262
    name = models.CharField(max_length=255)
    date = models.DateTimeField(default=datetime.datetime.now)
    submitter = models.ForeignKey(Person)
    delegate = models.ForeignKey(User, blank = True, null = True)
263
    state = models.ForeignKey(State, null=True)
Jeremy Kerr's avatar
Jeremy Kerr committed
264 265
    archived = models.BooleanField(default = False)
    headers = models.TextField(blank = True)
266 267
    content = models.TextField(null = True, blank = True)
    pull_url = models.CharField(max_length=255, null = True, blank = True)
Jeremy Kerr's avatar
Jeremy Kerr committed
268
    commit_ref = models.CharField(max_length=255, null = True, blank = True)
269
    hash = HashField(null = True, blank = True)
Jeremy Kerr's avatar
Jeremy Kerr committed
270 271 272
    tags = models.ManyToManyField(Tag, through=PatchTag)

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

274
    def __unicode__(self):
Jeremy Kerr's avatar
Jeremy Kerr committed
275 276
        return self.name

277 278 279 280 281 282 283 284
    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
285
    def comments(self):
286 287
        """Retrieves all comments of this patch ie. the commit message and the
           answers"""
288
        return Comment.objects.filter(patch = self)
Jeremy Kerr's avatar
Jeremy Kerr committed
289

Jeremy Kerr's avatar
Jeremy Kerr committed
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307
    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
308
    def save(self):
309 310
        if not hasattr(self, 'state') or not self.state:
            self.state = get_default_initial_patch_state()
Jeremy Kerr's avatar
Jeremy Kerr committed
311

312
        if self.hash is None and self.content is not None:
Jeremy Kerr's avatar
Jeremy Kerr committed
313
            self.hash = hash_patch(self.content).hexdigest()
Jeremy Kerr's avatar
Jeremy Kerr committed
314

Jeremy Kerr's avatar
Jeremy Kerr committed
315 316 317 318 319 320 321 322 323
        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

324
        return self.project.is_editable(user)
Jeremy Kerr's avatar
Jeremy Kerr committed
325 326

    def filename(self):
327
        return filename(self.name, '.patch')
Jeremy Kerr's avatar
Jeremy Kerr committed
328 329 330 331 332 333 334 335

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

    class Meta:
        verbose_name_plural = 'Patches'
        ordering = ['date']
336
        unique_together = [('msgid', 'project')]
Jeremy Kerr's avatar
Jeremy Kerr committed
337 338 339

class Comment(models.Model):
    patch = models.ForeignKey(Patch)
340
    msgid = models.CharField(max_length=255)
Jeremy Kerr's avatar
Jeremy Kerr committed
341 342 343 344 345
    submitter = models.ForeignKey(Person)
    date = models.DateTimeField(default = datetime.datetime.now)
    headers = models.TextField(blank = True)
    content = models.TextField()

346 347 348
    response_re = re.compile( \
            '^(Tested|Reviewed|Acked|Signed-off|Nacked|Reported)-by: .*$',
            re.M | re.I)
349 350

    def patch_responses(self):
351
        return ''.join([ match.group(0) + '\n' for match in
352 353
                                self.response_re.finditer(self.content)])

Jeremy Kerr's avatar
Jeremy Kerr committed
354 355 356 357 358 359 360 361
    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
362 363
    class Meta:
        ordering = ['date']
364
        unique_together = [('msgid', 'patch')]
Jeremy Kerr's avatar
Jeremy Kerr committed
365 366 367 368 369

class Bundle(models.Model):
    owner = models.ForeignKey(User)
    project = models.ForeignKey(Project)
    name = models.CharField(max_length = 50, null = False, blank = False)
370
    patches = models.ManyToManyField(Patch, through = 'BundlePatch')
Jeremy Kerr's avatar
Jeremy Kerr committed
371 372 373 374 375
    public = models.BooleanField(default = False)

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

Jeremy Kerr's avatar
Jeremy Kerr committed
376
    def ordered_patches(self):
Guilherme Salgado's avatar
Guilherme Salgado committed
377
        return self.patches.order_by('bundlepatch__order')
Jeremy Kerr's avatar
Jeremy Kerr committed
378

379 380
    def append_patch(self, patch):
        # todo: use the aggregate queries in django 1.1
Jeremy Kerr's avatar
Jeremy Kerr committed
381 382 383 384 385 386 387 388 389 390 391
        orders = BundlePatch.objects.filter(bundle = self).order_by('-order') \
                 .values('order')

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

        # see if the patch is already in this bundle
        if BundlePatch.objects.filter(bundle = self, patch = patch).count():
            raise Exception("patch is already in bundle")
392

Jeremy Kerr's avatar
Jeremy Kerr committed
393 394
        bp = BundlePatch.objects.create(bundle = self, patch = patch,
                order = max_order + 1)
395 396
        bp.save()

Jeremy Kerr's avatar
Jeremy Kerr committed
397 398 399 400 401 402 403 404
    class Meta:
        unique_together = [('owner', 'name')]

    def public_url(self):
        if not self.public:
            return None
        site = Site.objects.get_current()
        return 'http://%s%s' % (site.domain,
405
                reverse('patchwork.views.bundle.bundle',
Jeremy Kerr's avatar
Jeremy Kerr committed
406 407 408 409 410
                        kwargs = {
                                'username': self.owner.username,
                                'bundlename': self.name
                        }))

411 412 413 414 415 416 417
    @models.permalink
    def get_absolute_url(self):
        return ('patchwork.views.bundle.bundle', (), {
                                'username': self.owner.username,
                                'bundlename': self.name,
                            })

418 419 420 421 422 423
class BundlePatch(models.Model):
    patch = models.ForeignKey(Patch)
    bundle = models.ForeignKey(Bundle)
    order = models.IntegerField()

    class Meta:
Jeremy Kerr's avatar
Jeremy Kerr committed
424 425
        unique_together = [('bundle', 'patch')]
        ordering = ['order']
426

Damien Lespiau's avatar
Damien Lespiau committed
427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470
SERIES_DEFAULT_NAME = "Series without cover letter"

# This Model represents the "top level" Series, an object that doesn't change
# with the various versions of patches sent to the mailing list.
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)
    # Caches the latest version so we can display it without looking at the max
    # of all SeriesRevision.version
    version = models.IntegerField(default=1)
    # This is the number of patches of the latest version.
    n_patches = models.IntegerField(default=0)

    def __unicode__(self):
        return self.name

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

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

    def get_absolute_url(self):
        return reverse('series', kwargs={ 'series': self.pk })

    def dump(self):
        print('')
        print('===')
        print('Series: %s' % self)
        print('    version %d' % self.version)
        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

471 472 473
    def filename(self):
        return filename(self.name, '.mbox')

474 475 476 477
# Signal one can listen to to know when a revision is complete (ie. has all of
# its patches)
series_revision_complete = django.dispatch.Signal(providing_args=["revision"])

Damien Lespiau's avatar
Damien Lespiau committed
478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503
# 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.
class SeriesRevision(models.Model):
    series = models.ForeignKey(Series)
    version = models.IntegerField(default=1)
    root_msgid = models.CharField(max_length=255)
    cover_letter = models.TextField(null = True, blank = True)
    patches = models.ManyToManyField(Patch, through = 'SeriesRevisionPatch')

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

504 505 506 507
        revision_complete = self.patches.count() == self.series.n_patches
        if revision_complete:
            series_revision_complete.send(sender=self.__class__, revision=self)

508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534
    def duplicate_meta(self):
        new = SeriesRevision.objects.get(pk=self.pk)
        new.pk = None
        new.cover_letter = None
        new.version = self.version + 1
        new.save()

        series = new.series
        series.version = new.version
        series.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

Damien Lespiau's avatar
Damien Lespiau committed
535
    def __unicode__(self):
536
        return "Revision " + self.version
Damien Lespiau's avatar
Damien Lespiau committed
537 538 539 540 541 542 543 544 545 546

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

547 548 549 550 551 552 553 554
class Event(models.Model):
    name = models.CharField(max_length=20)

class EventLog(models.Model):
    event = models.ForeignKey(Event)
    event_time = models.DateTimeField(auto_now=True)
    series = models.ForeignKey(Series)
    user = models.ForeignKey(User, null=True)
555
    parameters = jsonfield.JSONField(null=True)
556 557 558 559

    class Meta:
        ordering = ['-event_time']

560
class EmailConfirmation(models.Model):
561
    validity = datetime.timedelta(days = settings.CONFIRMATION_VALIDITY_DAYS)
562 563
    type = models.CharField(max_length = 20, choices = [
                                ('userperson', 'User-Person association'),
564
                                ('registration', 'Registration'),
Jeremy Kerr's avatar
Jeremy Kerr committed
565
                                ('optout', 'Email opt-out'),
566
                            ])
567
    email = models.CharField(max_length = 200)
568
    user = models.ForeignKey(User, null = True)
569
    key = HashField()
570
    date = models.DateTimeField(default = datetime.datetime.now)
571 572
    active = models.BooleanField(default = True)

573
    def deactivate(self):
574
        self.active = False
575
        self.save()
576

577 578 579
    def is_valid(self):
        return self.date + self.validity > datetime.datetime.now()

580 581 582 583 584
    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()
585
        super(EmailConfirmation, self).save()
586

Jeremy Kerr's avatar
Jeremy Kerr committed
587 588
class EmailOptout(models.Model):
    email = models.CharField(max_length = 200, primary_key = True)
589

Jeremy Kerr's avatar
Jeremy Kerr committed
590 591
    def __unicode__(self):
        return self.email
592

Jeremy Kerr's avatar
Jeremy Kerr committed
593 594 595 596 597
    @classmethod
    def is_optout(cls, email):
        email = email.lower().strip()
        return cls.objects.filter(email = email).count() > 0

598
class PatchChangeNotification(models.Model):
599
    patch = models.OneToOneField(Patch, primary_key = True)
600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639
    last_modified = models.DateTimeField(default = datetime.datetime.now)
    orig_state = models.ForeignKey(State)

def _patch_change_callback(sender, instance, **kwargs):
    # we only want notification of modified patches
    if instance.pk is None:
        return

    if instance.project is None or not instance.project.send_notifications:
        return

    try:
        orig_patch = Patch.objects.get(pk = instance.pk)
    except Patch.DoesNotExist:
        return

    # If there's no interesting changes, abort without creating the
    # notification
    if orig_patch.state == instance.state:
        return

    notification = None
    try:
        notification = PatchChangeNotification.objects.get(patch = instance)
    except PatchChangeNotification.DoesNotExist:
        pass

    if notification is None:
        notification = PatchChangeNotification(patch = instance,
                                               orig_state = orig_patch.state)

    elif notification.orig_state == instance.state:
        # If we're back at the original state, there is no need to notify
        notification.delete()
        return

    notification.last_modified = datetime.datetime.now()
    notification.save()

models.signals.pre_save.connect(_patch_change_callback, sender = Patch)
640 641 642 643

def _on_revision_complete(sender, revision, **kwargs):
    new_revision = Event.objects.get(name='series-new-revision')
    log = EventLog(event=new_revision, series=revision.series,
644 645
                   user=revision.series.submitter.user,
                   parameters={'revision': revision.version})
646 647 648
    log.save()

series_revision_complete.connect(_on_revision_complete)