summaryrefslogtreecommitdiffstats
path: root/packages/models.py
blob: 18d57c581f4c6c38915869535bd3bf0f790a45e5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
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
85
86
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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
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
205
206
207
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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
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
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
from collections import namedtuple

from django.db import models
from django.db.models.signals import pre_save
from django.contrib.admin.models import ADDITION, CHANGE, DELETION
from django.contrib.auth.models import User

from main.models import Arch, Repo, Package
from main.utils import set_created_field, database_vendor
from packages.alpm import AlpmAPI


class PackageRelation(models.Model):
    '''
    Represents maintainership (or interest) in a package by a given developer.
    It is not a true foreign key to packages as we want to key off
    pkgbase/pkgname instead, as well as preserve this information across
    package deletes, adds, and in all repositories.
    '''
    MAINTAINER = 1
    WATCHER = 2
    TYPE_CHOICES = (
            (MAINTAINER, 'Maintainer'),
            (WATCHER, 'Watcher'),
    )
    pkgbase = models.CharField(max_length=255)
    user = models.ForeignKey(User, related_name="package_relations")
    type = models.PositiveIntegerField(choices=TYPE_CHOICES, default=MAINTAINER)
    created = models.DateTimeField(editable=False)

    def get_associated_packages(self):
        return Package.objects.normal().filter(pkgbase=self.pkgbase)

    def repositories(self):
        packages = self.get_associated_packages()
        return sorted({p.repo for p in packages})

    def __unicode__(self):
        return u'%s: %s (%s)' % (
                self.pkgbase, self.user, self.get_type_display())

    class Meta:
        unique_together = (('pkgbase', 'user', 'type'),)


class SignoffSpecificationManager(models.Manager):
    def get_from_package(self, pkg):
        '''Utility method to pull all relevant name-version fields from a
        package and get a matching signoff specification.'''
        return self.get(
                pkgbase=pkg.pkgbase, pkgver=pkg.pkgver, pkgrel=pkg.pkgrel,
                epoch=pkg.epoch, arch=pkg.arch, repo=pkg.repo)

    def get_or_default_from_package(self, pkg):
        '''utility method to pull all relevant name-version fields from a
        package and get a matching signoff specification, or return the default
        base case.'''
        try:
            return self.get(
                    pkgbase=pkg.pkgbase, pkgver=pkg.pkgver, pkgrel=pkg.pkgrel,
                    epoch=pkg.epoch, arch=pkg.arch, repo=pkg.repo)
        except SignoffSpecification.DoesNotExist:
            return DEFAULT_SIGNOFF_SPEC

class SignoffSpecification(models.Model):
    '''
    A specification for the signoff policy for this particular revision of a
    package. The default is requiring two signoffs for a given package. These
    are created only if necessary; e.g., if one wanted to override the
    required=2 attribute, otherwise a sane default object is used.
    '''
    pkgbase = models.CharField(max_length=255, db_index=True)
    pkgver = models.CharField(max_length=255)
    pkgrel = models.CharField(max_length=255)
    epoch = models.PositiveIntegerField(default=0)
    arch = models.ForeignKey(Arch)
    repo = models.ForeignKey(Repo)
    user = models.ForeignKey(User, null=True)
    created = models.DateTimeField(editable=False)
    required = models.PositiveIntegerField(default=2,
        help_text="How many signoffs are required for this package?")
    enabled = models.BooleanField(default=True,
        help_text="Is this package eligible for signoffs?")
    known_bad = models.BooleanField(default=False,
        help_text="Is package is known to be broken in some way?")
    comments = models.TextField(null=True, blank=True)

    objects = SignoffSpecificationManager()

    @property
    def full_version(self):
        if self.epoch > 0:
            return u'%d:%s-%s' % (self.epoch, self.pkgver, self.pkgrel)
        return u'%s-%s' % (self.pkgver, self.pkgrel)

    def __unicode__(self):
        return u'%s-%s' % (self.pkgbase, self.full_version)


# fake default signoff spec when we don't have a persisted one in the database
FakeSignoffSpecification = namedtuple('FakeSignoffSpecification',
        ('required', 'enabled', 'known_bad', 'comments'))
DEFAULT_SIGNOFF_SPEC = FakeSignoffSpecification(2, True, False, u'')


class SignoffManager(models.Manager):
    def get_from_package(self, pkg, user, revoked=False):
        '''Utility method to pull all relevant name-version fields from a
        package and get a matching signoff.'''
        not_revoked = not revoked
        return self.get(
                pkgbase=pkg.pkgbase, pkgver=pkg.pkgver, pkgrel=pkg.pkgrel,
                epoch=pkg.epoch, arch=pkg.arch, repo=pkg.repo,
                revoked__isnull=not_revoked, user=user)

    def get_or_create_from_package(self, pkg, user):
        '''Utility method to pull all relevant name-version fields from a
        package and get or create a matching signoff.'''
        return self.get_or_create(
                pkgbase=pkg.pkgbase, pkgver=pkg.pkgver, pkgrel=pkg.pkgrel,
                epoch=pkg.epoch, arch=pkg.arch, repo=pkg.repo,
                revoked=None, user=user)

    def for_package(self, pkg):
        return self.select_related('user').filter(
                pkgbase=pkg.pkgbase, pkgver=pkg.pkgver, pkgrel=pkg.pkgrel,
                epoch=pkg.epoch, arch=pkg.arch, repo=pkg.repo)

class Signoff(models.Model):
    '''
    A signoff for a package (by pkgbase) at a given point in time. These are
    not keyed directly to a Package object so they don't ever get deleted when
    Packages come and go from testing repositories.
    '''
    pkgbase = models.CharField(max_length=255, db_index=True)
    pkgver = models.CharField(max_length=255)
    pkgrel = models.CharField(max_length=255)
    epoch = models.PositiveIntegerField(default=0)
    arch = models.ForeignKey(Arch)
    repo = models.ForeignKey(Repo)
    user = models.ForeignKey(User, related_name="package_signoffs")
    created = models.DateTimeField(editable=False, db_index=True)
    revoked = models.DateTimeField(null=True)
    comments = models.TextField(null=True, blank=True)

    objects = SignoffManager()

    @property
    def packages(self):
        return Package.objects.normal().filter(pkgbase=self.pkgbase,
                pkgver=self.pkgver, pkgrel=self.pkgrel, epoch=self.epoch,
                arch=self.arch, repo=self.repo)

    @property
    def full_version(self):
        if self.epoch > 0:
            return u'%d:%s-%s' % (self.epoch, self.pkgver, self.pkgrel)
        return u'%s-%s' % (self.pkgver, self.pkgrel)

    def __unicode__(self):
        revoked = u''
        if self.revoked:
            revoked = u' (revoked)'
        return u'%s-%s: %s%s' % (
                self.pkgbase, self.full_version, self.user, revoked)


class FlagRequest(models.Model):
    '''
    A notification the package is out-of-date submitted through the web site.
    '''
    user = models.ForeignKey(User, blank=True, null=True)
    user_email = models.EmailField('email address')
    created = models.DateTimeField(editable=False, db_index=True)
    # Great work, Django... https://code.djangoproject.com/ticket/18212
    ip_address = models.GenericIPAddressField(verbose_name='IP address',
            unpack_ipv4=True)
    pkgbase = models.CharField(max_length=255, db_index=True)
    pkgver = models.CharField(max_length=255)
    pkgrel = models.CharField(max_length=255)
    epoch = models.PositiveIntegerField(default=0)
    repo = models.ForeignKey(Repo)
    num_packages = models.PositiveIntegerField('number of packages', default=1)
    message = models.TextField('message to developer', blank=True)
    is_spam = models.BooleanField(default=False,
            help_text="Is this comment from a real person?")
    is_legitimate = models.BooleanField(default=True,
            help_text="Is this actually an out-of-date flag request?")

    class Meta:
        get_latest_by = 'created'

    def who(self):
        if self.user:
            return self.user.get_full_name()
        return self.user_email

    @property
    def full_version(self):
        # Difference here from other implementations at the moment: we need to
        # handle the case of pkgver and pkgrel being null as this table didn't
        # originally have version columns.
        if self.pkgver == '' and self.pkgrel == '':
            return u''
        if self.epoch > 0:
            return u'%d:%s-%s' % (self.epoch, self.pkgver, self.pkgrel)
        return u'%s-%s' % (self.pkgver, self.pkgrel)

    def __unicode__(self):
        return u'%s from %s on %s' % (self.pkgbase, self.who(), self.created)


class UpdateManager(models.Manager):
    def log_update(self, old_pkg, new_pkg):
        '''Utility method to help log an update. This will determine the type
        based on how many packages are passed in, and will pull the relevant
        necesary fields off the given packages.
        Note that in some cases, this is a no-op if we know this database type
        supports triggers to add these rows instead.'''
        if database_vendor(Package, 'write') in ('sqlite', 'postgresql'):
            # we log updates using database triggers for these backends
            return
        update = Update()
        if new_pkg:
            update.action_flag = ADDITION
            update.package = new_pkg
            update.arch = new_pkg.arch
            update.repo = new_pkg.repo
            update.pkgname = new_pkg.pkgname
            update.pkgbase = new_pkg.pkgbase
            update.new_pkgver = new_pkg.pkgver
            update.new_pkgrel = new_pkg.pkgrel
            update.new_epoch = new_pkg.epoch
        if old_pkg:
            if new_pkg:
                update.action_flag = CHANGE
                # ensure we should even be logging this
                if (old_pkg.pkgver == new_pkg.pkgver and
                        old_pkg.pkgrel == new_pkg.pkgrel and
                        old_pkg.epoch == new_pkg.epoch):
                    # all relevant fields were the same; e.g. a force update
                    return
            else:
                update.action_flag = DELETION
                update.arch = old_pkg.arch
                update.repo = old_pkg.repo
                update.pkgname = old_pkg.pkgname
                update.pkgbase = old_pkg.pkgbase

            update.old_pkgver = old_pkg.pkgver
            update.old_pkgrel = old_pkg.pkgrel
            update.old_epoch = old_pkg.epoch

        update.save(force_insert=True)
        return update


class Update(models.Model):
    UPDATE_ACTION_CHOICES = (
        (ADDITION, 'Addition'),
        (CHANGE, 'Change'),
        (DELETION, 'Deletion'),
    )

    package = models.ForeignKey(Package, related_name="updates",
            null=True, on_delete=models.SET_NULL)
    repo = models.ForeignKey(Repo, related_name="updates")
    arch = models.ForeignKey(Arch, related_name="updates")
    pkgname = models.CharField(max_length=255, db_index=True)
    pkgbase = models.CharField(max_length=255)
    action_flag = models.PositiveSmallIntegerField('action flag',
            choices=UPDATE_ACTION_CHOICES)
    created = models.DateTimeField(editable=False, db_index=True)

    old_pkgver = models.CharField(max_length=255, null=True)
    old_pkgrel = models.CharField(max_length=255, null=True)
    old_epoch = models.PositiveIntegerField(null=True)

    new_pkgver = models.CharField(max_length=255, null=True)
    new_pkgrel = models.CharField(max_length=255, null=True)
    new_epoch = models.PositiveIntegerField(null=True)

    objects = UpdateManager()

    class Meta:
        get_latest_by = 'created'

    def is_addition(self):
        return self.action_flag == ADDITION

    def is_change(self):
        return self.action_flag == CHANGE

    def is_deletion(self):
        return self.action_flag == DELETION

    @property
    def old_version(self):
        if self.action_flag == ADDITION:
            return None
        if self.old_epoch > 0:
            return u'%d:%s-%s' % (self.old_epoch, self.old_pkgver, self.old_pkgrel)
        return u'%s-%s' % (self.old_pkgver, self.old_pkgrel)

    @property
    def new_version(self):
        if self.action_flag == DELETION:
            return None
        if self.new_epoch > 0:
            return u'%d:%s-%s' % (self.new_epoch, self.new_pkgver, self.new_pkgrel)
        return u'%s-%s' % (self.new_pkgver, self.new_pkgrel)

    def elsewhere(self):
        return Package.objects.filter(pkgname=self.pkgname, arch=self.arch)

    def __unicode__(self):
        return u'%s of %s on %s' % (self.get_action_flag_display(),
                self.pkgname, self.created)


class PackageGroup(models.Model):
    '''
    Represents a group a package is in. There is no actual group entity,
    only names that link to given packages.
    '''
    pkg = models.ForeignKey(Package, related_name='groups')
    name = models.CharField(max_length=255, db_index=True)

    def __unicode__(self):
        return "%s: %s" % (self.name, self.pkg)

    class Meta:
        ordering = ('name',)


class License(models.Model):
    pkg = models.ForeignKey(Package, related_name='licenses')
    name = models.CharField(max_length=255)

    def __unicode__(self):
        return self.name

    class Meta:
        ordering = ('name',)


class RelatedToBase(models.Model):
    '''A base class for conflicts/provides/replaces/etc.'''
    name = models.CharField(max_length=255, db_index=True)
    version = models.CharField(max_length=255, default='')

    def get_best_satisfier(self, main_pkg=None):
        '''Find a satisfier for this related package that best matches the
        given criteria. It will not search provisions, but will find packages
        named and matching repo characteristics if possible.'''
        if main_pkg is None:
            main_pkg = self.pkg
        pkgs = Package.objects.normal().filter(pkgname=self.name)
        if not main_pkg.arch.agnostic:
            # make sure we match architectures if possible
            arches = main_pkg.applicable_arches()
            pkgs = pkgs.filter(arch__in=arches)
        # if we have a comparison operation, make sure the packages we grab
        # actually satisfy the requirements
        if self.comparison and self.version:
            alpm = AlpmAPI()
            pkgs = [pkg for pkg in pkgs if not alpm.available or
                    alpm.compare_versions(pkg.full_version, self.comparison,
                        self.version)]
        if len(pkgs) == 0:
            # couldn't find a package in the DB
            # it should be a virtual depend (or a removed package)
            return None
        if len(pkgs) == 1:
            return pkgs[0]
        # more than one package, see if we can't shrink it down
        # grab the first though in case we fail
        pkg = pkgs[0]
        # prevents yet more DB queries, these lists should be short;
        # after each grab the best available in case we remove all entries
        pkgs = [p for p in pkgs if p.repo.staging == main_pkg.repo.staging]
        if len(pkgs) > 0:
            pkg = pkgs[0]

        pkgs = [p for p in pkgs if p.repo.testing == main_pkg.repo.testing]
        if len(pkgs) > 0:
            pkg = pkgs[0]

        return pkg

    def get_providers(self, main_pkg=None):
        '''Return providers of this related package. Does *not* include exact
        matches as it checks the Provision names only, use get_best_satisfier()
        instead for exact matches.'''
        if main_pkg is None:
            main_pkg = self.pkg
        pkgs = Package.objects.normal().filter(
                provides__name=self.name).order_by().distinct()
        if not main_pkg.arch.agnostic:
            # make sure we match architectures if possible
            arches = main_pkg.applicable_arches()
            pkgs = pkgs.filter(arch__in=arches)

        # If we have a comparison operation, make sure the packages we grab
        # actually satisfy the requirements.
        alpm = AlpmAPI()
        if alpm.available and self.comparison and self.version:
            pkgs = pkgs.prefetch_related('provides')
            new_pkgs = []
            for package in pkgs:
                for provide in package.provides.all():
                    if provide.name != self.name:
                        continue
                    if alpm.compare_versions(provide.version,
                            self.comparison, self.version):
                        new_pkgs.append(package)
            pkgs = new_pkgs

        # Sort providers by preference. We sort those in same staging/testing
        # combination first, followed by others. We sort by a (staging,
        # testing) match tuple that will be (True, True) in the best case.
        key_func = lambda x: (x.repo.staging == self.pkg.repo.staging,
                x.repo.testing == self.pkg.repo.testing)
        return sorted(pkgs, key=key_func, reverse=True)

    def __unicode__(self):
        if self.version:
            return u'%s%s%s' % (self.name, self.comparison, self.version)
        return self.name

    class Meta:
        abstract = True
        ordering = ('name',)


class Depend(RelatedToBase):
    DEPTYPE_CHOICES = (
        ('D', 'Depend'),
        ('O', 'Optional Depend'),
        ('M', 'Make Depend'),
        ('C', 'Check Depend'),
    )

    pkg = models.ForeignKey(Package, related_name='depends')
    comparison = models.CharField(max_length=255, default='')
    description = models.TextField(null=True, blank=True)
    deptype = models.CharField(max_length=1, default='D',
            choices=DEPTYPE_CHOICES)

    def __unicode__(self):
        '''For depends, we may also have a description and a modifier.'''
        to_str = super(Depend, self).__unicode__()
        if self.description:
            return u'%s: %s' % (to_str, self.description)
        return to_str


class Conflict(RelatedToBase):
    pkg = models.ForeignKey(Package, related_name='conflicts')
    comparison = models.CharField(max_length=255, default='')


class Provision(RelatedToBase):
    pkg = models.ForeignKey(Package, related_name='provides')
    # comparison must be '=' for provides

    @property
    def comparison(self):
        if self.version is not None and self.version != '':
            return '='
        return None


class Replacement(RelatedToBase):
    pkg = models.ForeignKey(Package, related_name='replaces')
    comparison = models.CharField(max_length=255, default='')


# hook up some signals
for sender in (FlagRequest, PackageRelation,
        SignoffSpecification, Signoff, Update):
    pre_save.connect(set_created_field, sender=sender,
            dispatch_uid="packages.models")

# vim: set ts=4 sw=4 et: