models.py 12.6 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
24
# 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
from django.conf import settings
Jeremy Kerr's avatar
Jeremy Kerr committed
25
from patchwork.parser import hash_patch
Jeremy Kerr's avatar
Jeremy Kerr committed
26
27
28
29
30

import re
import datetime, time
import string
import random
31
32

try:
33
34
    from email.mime.nonmultipart import MIMENonMultipart
    from email.encoders import encode_7or8bit
35
    from email.parser import HeaderParser
36
37
38
    import email.utils
except ImportError:
    # Python 2.4 compatibility
39
40
    from email.MIMENonMultipart import MIMENonMultipart
    from email.Encoders import encode_7or8bit
41
42
    import email.Utils
    email.utils = email.Utils
Jeremy Kerr's avatar
Jeremy Kerr committed
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84

class Person(models.Model):
    email = models.CharField(max_length=255, unique = True)
    name = models.CharField(max_length=255, null = True)
    user = models.ForeignKey(User, null = True)

    def __str__(self):
        if self.name:
            return '%s <%s>' % (self.name, self.email)
        else:
            return self.email

    def link_to_user(self, user):
        self.name = user.get_profile().name()
        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)

    def __str__(self):
        return self.name

class UserProfile(models.Model):
    user = models.ForeignKey(User, unique = True)
    primary_project = models.ForeignKey(Project, null = True)
    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:
85
86
            names = filter(bool, [self.user.first_name, self.user.last_name])
            return ' '.join(names)
Jeremy Kerr's avatar
Jeremy Kerr committed
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
        return self.user.username

    def contributor_projects(self):
        submitters = Person.objects.filter(user = self.user)
        return Project.objects \
            .filter(id__in = \
                    Patch.objects.filter(
                        submitter__in = submitters) \
                    .values('project_id').query)


    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) \
             .filter(state__in = \
                     State.objects.filter(action_required = True) \
                         .values('pk').query)
        return qs

    def save(self):
120
121
122
123
124
        super(UserProfile, self).save()
        people = Person.objects.filter(email = self.user.email)
        if not people:
            person = Person(email = self.user.email,
                    name = self.name(), user = self.user)
Jeremy Kerr's avatar
Jeremy Kerr committed
125
            person.save()
126
127
        else:
            for person in people:
128
                 person.link_to_user(self.user)
129
                 person.save()
Jeremy Kerr's avatar
Jeremy Kerr committed
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

    def __str__(self):
        return self.name()

class State(models.Model):
    name = models.CharField(max_length = 100)
    ordering = models.IntegerField(unique = True)
    action_required = models.BooleanField(default = True)

    def __str__(self):
        return self.name

    class Meta:
        ordering = ['ordering']

Jeremy Kerr's avatar
Jeremy Kerr committed
145
class HashField(models.CharField):
Jeremy Kerr's avatar
Jeremy Kerr committed
146
147
148
149
    __metaclass__ = models.SubfieldBase

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

            if algorithm not in modules.keys():
Nate Case's avatar
Nate Case committed
160
                raise NameError("Unknown algorithm '%s'" % algorithm)
Jeremy Kerr's avatar
Jeremy Kerr committed
161
162
163
164

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

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

166
        kwargs['max_length'] = self.n_bytes
Jeremy Kerr's avatar
Jeremy Kerr committed
167
168
169
        super(HashField, self).__init__(*args, **kwargs)

    def db_type(self):
170
        return 'char(%d)' % self.n_bytes
Jeremy Kerr's avatar
Jeremy Kerr committed
171

172
173
174
175
176
177
178
179
class PatchMbox(MIMENonMultipart):
    patch_charset = 'utf-8'
    def __init__(self, _text):
        MIMENonMultipart.__init__(self, 'text', 'plain',
                        **{'charset': self.patch_charset})
        self.set_payload(_text.encode(self.patch_charset))
        encode_7or8bit(self)

Jeremy Kerr's avatar
Jeremy Kerr committed
180
181
class Patch(models.Model):
    project = models.ForeignKey(Project)
182
    msgid = models.CharField(max_length=255)
Jeremy Kerr's avatar
Jeremy Kerr committed
183
184
185
186
187
188
189
190
191
    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)
    state = models.ForeignKey(State)
    archived = models.BooleanField(default = False)
    headers = models.TextField(blank = True)
    content = models.TextField()
    commit_ref = models.CharField(max_length=255, null = True, blank = True)
Jeremy Kerr's avatar
Jeremy Kerr committed
192
    hash = HashField(null = True, db_index = True)
Jeremy Kerr's avatar
Jeremy Kerr committed
193
194
195
196
197

    def __str__(self):
        return self.name

    def comments(self):
198
        return Comment.objects.filter(patch = self)
Jeremy Kerr's avatar
Jeremy Kerr committed
199
200

    def save(self):
201
        try:
Jeremy Kerr's avatar
Jeremy Kerr committed
202
203
204
            s = self.state
        except:
            self.state = State.objects.get(ordering =  0)
Jeremy Kerr's avatar
Jeremy Kerr committed
205
206

        if self.hash is None:
Jeremy Kerr's avatar
Jeremy Kerr committed
207
            self.hash = hash_patch(self.content).hexdigest()
Jeremy Kerr's avatar
Jeremy Kerr committed
208

Jeremy Kerr's avatar
Jeremy Kerr committed
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
        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

        profile = user.get_profile()
        return self.project in user.get_profile().maintainer_projects.all()

    def form(self):
        f = PatchForm(instance = self, prefix = self.id)
        return f

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

    def mbox(self):
231
232
        postscript_re = re.compile('\n-{2,3} ?\n')

Jeremy Kerr's avatar
Jeremy Kerr committed
233
234
        comment = None
        try:
Jeremy Kerr's avatar
Jeremy Kerr committed
235
            comment = Comment.objects.get(patch = self, msgid = self.msgid)
Jeremy Kerr's avatar
Jeremy Kerr committed
236
237
238
239
240
        except Exception:
            pass

        body = ''
        if comment:
241
242
            body = comment.content.strip() + "\n"

243
244
245
246
247
248
249
250
        parts = postscript_re.split(body, 1)
        if len(parts) == 2:
            (body, postscript) = parts
            body = body.strip() + "\n"
            postscript = postscript.strip() + "\n"
        else:
            postscript = ''

251
252
253
254
255
256
257
258
        responses = False
        for comment in Comment.objects.filter(patch = self) \
                .exclude(msgid = self.msgid):
            body += comment.patch_responses()

        if body:
            body += '\n'

259
260
261
        if postscript:
            body += '---\n' + postscript.strip() + '\n'

262
        body += '\n' + self.content
Jeremy Kerr's avatar
Jeremy Kerr committed
263

264
        mail = PatchMbox(body)
Jeremy Kerr's avatar
Jeremy Kerr committed
265
266
267
        mail['Subject'] = self.name
        mail['Date'] = email.utils.formatdate(
                        time.mktime(self.date.utctimetuple()))
268
        mail['From'] = unicode(self.submitter)
Jeremy Kerr's avatar
Jeremy Kerr committed
269
        mail['X-Patchwork-Id'] = str(self.id)
270
        mail['Message-Id'] = self.msgid
Jeremy Kerr's avatar
Jeremy Kerr committed
271
272
273
        mail.set_unixfrom('From patchwork ' + self.date.ctime())


274
275
276
277
278
279
280
        copied_headers = ['To', 'Cc']
        orig_headers = HeaderParser().parsestr(str(self.headers))
        for header in copied_headers:
            if header in orig_headers:
                mail[header] = orig_headers[header]

        return mail
Jeremy Kerr's avatar
Jeremy Kerr committed
281
282
283
284
285
286
287
288

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

    class Meta:
        verbose_name_plural = 'Patches'
        ordering = ['date']
289
        unique_together = [('msgid', 'project')]
Jeremy Kerr's avatar
Jeremy Kerr committed
290
291
292

class Comment(models.Model):
    patch = models.ForeignKey(Patch)
293
    msgid = models.CharField(max_length=255)
Jeremy Kerr's avatar
Jeremy Kerr committed
294
295
296
297
298
    submitter = models.ForeignKey(Person)
    date = models.DateTimeField(default = datetime.datetime.now)
    headers = models.TextField(blank = True)
    content = models.TextField()

299
300
301
    response_re = re.compile( \
            '^(Tested|Reviewed|Acked|Signed-off|Nacked|Reported)-by: .*$',
            re.M | re.I)
302
303
304
305
306

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

Jeremy Kerr's avatar
Jeremy Kerr committed
307
308
    class Meta:
        ordering = ['date']
309
        unique_together = [('msgid', 'patch')]
Jeremy Kerr's avatar
Jeremy Kerr committed
310
311
312
313
314

class Bundle(models.Model):
    owner = models.ForeignKey(User)
    project = models.ForeignKey(Project)
    name = models.CharField(max_length = 50, null = False, blank = False)
315
    patches = models.ManyToManyField(Patch, through = 'BundlePatch')
Jeremy Kerr's avatar
Jeremy Kerr committed
316
317
318
319
320
    public = models.BooleanField(default = False)

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

Jeremy Kerr's avatar
Jeremy Kerr committed
321
322
323
    def ordered_patches(self):
        return self.patches.order_by('bundlepatch__order');

324
325
    def append_patch(self, patch):
        # todo: use the aggregate queries in django 1.1
Jeremy Kerr's avatar
Jeremy Kerr committed
326
327
328
329
330
331
332
333
334
335
336
        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")
337

Jeremy Kerr's avatar
Jeremy Kerr committed
338
339
        bp = BundlePatch.objects.create(bundle = self, patch = patch,
                order = max_order + 1)
340
341
        bp.save()

Jeremy Kerr's avatar
Jeremy Kerr committed
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
    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,
                reverse('patchwork.views.bundle.public',
                        kwargs = {
                                'username': self.owner.username,
                                'bundlename': self.name
                        }))

    def mbox(self):
        return '\n'.join([p.mbox().as_string(True) \
Jeremy Kerr's avatar
Jeremy Kerr committed
358
                        for p in self.ordered_patches()])
Jeremy Kerr's avatar
Jeremy Kerr committed
359

360
361
362
363
364
365
class BundlePatch(models.Model):
    patch = models.ForeignKey(Patch)
    bundle = models.ForeignKey(Bundle)
    order = models.IntegerField()

    class Meta:
Jeremy Kerr's avatar
Jeremy Kerr committed
366
367
        unique_together = [('bundle', 'patch')]
        ordering = ['order']
368

369
370
371
372
373
374
375
376
377
378
379
380
class UserPersonConfirmation(models.Model):
    user = models.ForeignKey(User)
    email = models.CharField(max_length = 200)
    key = HashField()
    date = models.DateTimeField(default=datetime.datetime.now)
    active = models.BooleanField(default = True)

    def confirm(self):
        if not self.active:
            return
        person = None
        try:
381
            person = Person.objects.get(email__iexact = self.email)
382
383
384
385
386
387
388
389
        except Exception:
            pass
        if not person:
            person = Person(email = self.email)

        person.link_to_user(self.user)
        person.save()
        self.active = False
390
        self.save()
391
392
393
394
395
396
397
398
399

    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()
        super(UserPersonConfirmation, self).save()