models.py 16.1 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 21 22 23
# 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
from django.contrib.auth.models import User
from django.core.urlresolvers import reverse
from django.contrib.sites.models import Site
24
from django.conf import settings
Jeremy Kerr's avatar
Jeremy Kerr committed
25 26
from django.utils.functional import cached_property
from patchwork.parser import hash_patch, extract_tags
Jeremy Kerr's avatar
Jeremy Kerr committed
27 28 29 30

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

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

39
    def __unicode__(self):
Jeremy Kerr's avatar
Jeremy Kerr committed
40
        if self.name:
41
            return u'%s <%s>' % (self.name, self.email)
Jeremy Kerr's avatar
Jeremy Kerr committed
42 43 44 45
        else:
            return self.email

    def link_to_user(self, user):
46
        self.name = user.profile.name()
Jeremy Kerr's avatar
Jeremy Kerr committed
47 48 49 50 51 52 53 54 55 56
        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
57 58 59
    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
60
    send_notifications = models.BooleanField(default=False)
Jeremy Kerr's avatar
Jeremy Kerr committed
61
    use_tags = models.BooleanField(default=True)
Jeremy Kerr's avatar
Jeremy Kerr committed
62

63
    def __unicode__(self):
Jeremy Kerr's avatar
Jeremy Kerr committed
64 65
        return self.name

66 67 68
    def is_editable(self, user):
        if not user.is_authenticated():
            return False
69
        return self in user.profile.maintainer_projects.all()
70

Jeremy Kerr's avatar
Jeremy Kerr committed
71 72 73 74 75 76
    @cached_property
    def tags(self):
        if not self.use_tags:
            return []
        return list(Tag.objects.all())

77 78 79 80
    class Meta:
        ordering = ['linkname']


Jeremy Kerr's avatar
Jeremy Kerr committed
81
class UserProfile(models.Model):
82
    user = models.OneToOneField(User, unique = True, related_name='profile')
83
    primary_project = models.ForeignKey(Project, null = True, blank = True)
Jeremy Kerr's avatar
Jeremy Kerr committed
84 85 86 87 88 89 90 91 92 93 94
    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):
        if self.user.first_name or self.user.last_name:
95
            names = filter(bool, [self.user.first_name, self.user.last_name])
96
            return u' '.join(names)
Jeremy Kerr's avatar
Jeremy Kerr committed
97 98 99 100
        return self.user.username

    def contributor_projects(self):
        submitters = Person.objects.filter(user = self.user)
101 102 103 104
        return Project.objects.filter(id__in =
                                        Patch.objects.filter(
                                            submitter__in = submitters)
                                        .values('project_id').query)
Jeremy Kerr's avatar
Jeremy Kerr committed
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121

    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) \
122 123
             .filter(state__in =
                     State.objects.filter(action_required = True)
Jeremy Kerr's avatar
Jeremy Kerr committed
124 125 126
                         .values('pk').query)
        return qs

127
    def __unicode__(self):
Jeremy Kerr's avatar
Jeremy Kerr committed
128 129
        return self.name()

130 131
def _user_saved_callback(sender, created, instance, **kwargs):
    try:
132
        profile = instance.profile
133 134
    except UserProfile.DoesNotExist:
        profile = UserProfile(user = instance)
135 136
    profile.save()

137
models.signals.post_save.connect(_user_saved_callback, sender = User)
138

Jeremy Kerr's avatar
Jeremy Kerr committed
139 140 141 142 143
class State(models.Model):
    name = models.CharField(max_length = 100)
    ordering = models.IntegerField(unique = True)
    action_required = models.BooleanField(default = True)

144
    def __unicode__(self):
Jeremy Kerr's avatar
Jeremy Kerr committed
145 146 147 148 149
        return self.name

    class Meta:
        ordering = ['ordering']

Jeremy Kerr's avatar
Jeremy Kerr committed
150
class HashField(models.CharField):
Jeremy Kerr's avatar
Jeremy Kerr committed
151 152 153 154
    __metaclass__ = models.SubfieldBase

    def __init__(self, algorithm = 'sha1', *args, **kwargs):
        self.algorithm = algorithm
Nate Case's avatar
Nate Case committed
155 156
        try:
            import hashlib
Jeremy Kerr's avatar
Jeremy Kerr committed
157 158 159
            def _construct(string = ''):
                return hashlib.new(self.algorithm, string)
            self.construct = _construct
160
            self.n_bytes = len(hashlib.new(self.algorithm).hexdigest())
Nate Case's avatar
Nate Case committed
161
        except ImportError:
Jeremy Kerr's avatar
Jeremy Kerr committed
162 163 164
            modules = { 'sha1': 'sha', 'md5': 'md5'}

            if algorithm not in modules.keys():
Nate Case's avatar
Nate Case committed
165
                raise NameError("Unknown algorithm '%s'" % algorithm)
Jeremy Kerr's avatar
Jeremy Kerr committed
166 167 168 169

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

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

171
        kwargs['max_length'] = self.n_bytes
Jeremy Kerr's avatar
Jeremy Kerr committed
172 173
        super(HashField, self).__init__(*args, **kwargs)

174
    def db_type(self, connection=None):
175
        return 'char(%d)' % self.n_bytes
Jeremy Kerr's avatar
Jeremy Kerr committed
176

Jeremy Kerr's avatar
Jeremy Kerr committed
177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
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')]

205 206 207
def get_default_initial_patch_state():
    return State.objects.get(ordering=0)

Jeremy Kerr's avatar
Jeremy Kerr committed
208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238
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)

Jeremy Kerr's avatar
Jeremy Kerr committed
239 240
class Patch(models.Model):
    project = models.ForeignKey(Project)
241
    msgid = models.CharField(max_length=255)
Jeremy Kerr's avatar
Jeremy Kerr committed
242 243 244 245
    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)
246
    state = models.ForeignKey(State, default=get_default_initial_patch_state)
Jeremy Kerr's avatar
Jeremy Kerr committed
247 248
    archived = models.BooleanField(default = False)
    headers = models.TextField(blank = True)
249 250
    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
251
    commit_ref = models.CharField(max_length=255, null = True, blank = True)
252
    hash = HashField(null = True, blank = True)
Jeremy Kerr's avatar
Jeremy Kerr committed
253 254 255
    tags = models.ManyToManyField(Tag, through=PatchTag)

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

257
    def __unicode__(self):
Jeremy Kerr's avatar
Jeremy Kerr committed
258 259 260
        return self.name

    def comments(self):
261
        return Comment.objects.filter(patch = self)
Jeremy Kerr's avatar
Jeremy Kerr committed
262

Jeremy Kerr's avatar
Jeremy Kerr committed
263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280
    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
281
    def save(self):
282
        try:
Jeremy Kerr's avatar
Jeremy Kerr committed
283 284 285
            s = self.state
        except:
            self.state = State.objects.get(ordering =  0)
Jeremy Kerr's avatar
Jeremy Kerr committed
286

287
        if self.hash is None and self.content is not None:
Jeremy Kerr's avatar
Jeremy Kerr committed
288
            self.hash = hash_patch(self.content).hexdigest()
Jeremy Kerr's avatar
Jeremy Kerr committed
289

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

299
        return self.project.is_editable(user)
Jeremy Kerr's avatar
Jeremy Kerr committed
300 301 302 303 304 305 306 307 308 309 310 311 312

    def filename(self):
        fname_re = re.compile('[^-_A-Za-z0-9\.]+')
        str = fname_re.sub('-', self.name)
        return str.strip('-') + '.patch'

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

    class Meta:
        verbose_name_plural = 'Patches'
        ordering = ['date']
313
        unique_together = [('msgid', 'project')]
Jeremy Kerr's avatar
Jeremy Kerr committed
314 315 316

class Comment(models.Model):
    patch = models.ForeignKey(Patch)
317
    msgid = models.CharField(max_length=255)
Jeremy Kerr's avatar
Jeremy Kerr committed
318 319 320 321 322
    submitter = models.ForeignKey(Person)
    date = models.DateTimeField(default = datetime.datetime.now)
    headers = models.TextField(blank = True)
    content = models.TextField()

323 324 325
    response_re = re.compile( \
            '^(Tested|Reviewed|Acked|Signed-off|Nacked|Reported)-by: .*$',
            re.M | re.I)
326 327

    def patch_responses(self):
328
        return ''.join([ match.group(0) + '\n' for match in
329 330
                                self.response_re.finditer(self.content)])

Jeremy Kerr's avatar
Jeremy Kerr committed
331 332 333 334 335 336 337 338
    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
339 340
    class Meta:
        ordering = ['date']
341
        unique_together = [('msgid', 'patch')]
Jeremy Kerr's avatar
Jeremy Kerr committed
342 343 344 345 346

class Bundle(models.Model):
    owner = models.ForeignKey(User)
    project = models.ForeignKey(Project)
    name = models.CharField(max_length = 50, null = False, blank = False)
347
    patches = models.ManyToManyField(Patch, through = 'BundlePatch')
Jeremy Kerr's avatar
Jeremy Kerr committed
348 349 350 351 352
    public = models.BooleanField(default = False)

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

Jeremy Kerr's avatar
Jeremy Kerr committed
353
    def ordered_patches(self):
Guilherme Salgado's avatar
Guilherme Salgado committed
354
        return self.patches.order_by('bundlepatch__order')
Jeremy Kerr's avatar
Jeremy Kerr committed
355

356 357
    def append_patch(self, patch):
        # todo: use the aggregate queries in django 1.1
Jeremy Kerr's avatar
Jeremy Kerr committed
358 359 360 361 362 363 364 365 366 367 368
        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")
369

Jeremy Kerr's avatar
Jeremy Kerr committed
370 371
        bp = BundlePatch.objects.create(bundle = self, patch = patch,
                order = max_order + 1)
372 373
        bp.save()

Jeremy Kerr's avatar
Jeremy Kerr committed
374 375 376 377 378 379 380 381
    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,
382
                reverse('patchwork.views.bundle.bundle',
Jeremy Kerr's avatar
Jeremy Kerr committed
383 384 385 386 387
                        kwargs = {
                                'username': self.owner.username,
                                'bundlename': self.name
                        }))

388 389 390 391 392 393 394
    @models.permalink
    def get_absolute_url(self):
        return ('patchwork.views.bundle.bundle', (), {
                                'username': self.owner.username,
                                'bundlename': self.name,
                            })

395 396 397 398 399 400
class BundlePatch(models.Model):
    patch = models.ForeignKey(Patch)
    bundle = models.ForeignKey(Bundle)
    order = models.IntegerField()

    class Meta:
Jeremy Kerr's avatar
Jeremy Kerr committed
401 402
        unique_together = [('bundle', 'patch')]
        ordering = ['order']
403

404
class EmailConfirmation(models.Model):
405
    validity = datetime.timedelta(days = settings.CONFIRMATION_VALIDITY_DAYS)
406 407
    type = models.CharField(max_length = 20, choices = [
                                ('userperson', 'User-Person association'),
408
                                ('registration', 'Registration'),
Jeremy Kerr's avatar
Jeremy Kerr committed
409
                                ('optout', 'Email opt-out'),
410
                            ])
411
    email = models.CharField(max_length = 200)
412
    user = models.ForeignKey(User, null = True)
413
    key = HashField()
414
    date = models.DateTimeField(default = datetime.datetime.now)
415 416
    active = models.BooleanField(default = True)

417
    def deactivate(self):
418
        self.active = False
419
        self.save()
420

421 422 423
    def is_valid(self):
        return self.date + self.validity > datetime.datetime.now()

424 425 426 427 428
    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()
429
        super(EmailConfirmation, self).save()
430

Jeremy Kerr's avatar
Jeremy Kerr committed
431 432
class EmailOptout(models.Model):
    email = models.CharField(max_length = 200, primary_key = True)
433

Jeremy Kerr's avatar
Jeremy Kerr committed
434 435
    def __unicode__(self):
        return self.email
436

Jeremy Kerr's avatar
Jeremy Kerr committed
437 438 439 440 441
    @classmethod
    def is_optout(cls, email):
        email = email.lower().strip()
        return cls.objects.filter(email = email).count() > 0

442
class PatchChangeNotification(models.Model):
443
    patch = models.OneToOneField(Patch, primary_key = True)
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 471 472 473 474 475 476 477 478 479 480 481 482 483
    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)