aboutsummaryrefslogtreecommitdiffstats
path: root/layerindex/models.py
blob: ac2967bb2cac7ed2042795e2c866aff29ae36cfc (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
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
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
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
# layerindex-web - model definitions
#
# Copyright (C) 2013-2016 Intel Corporation
#
# Licensed under the MIT license, see COPYING.MIT for details

from django.db import models
from datetime import datetime
from django.contrib.auth.models import User
from django.core.urlresolvers import reverse
from django.core.validators import URLValidator
from django.db.models.signals import pre_save
from django.dispatch import receiver
import os.path
import re
import posixpath

from . import utils


logger = utils.logger_create('LayerIndexModels')


@receiver(pre_save)
def truncate_charfield_values(sender, instance, *args, **kwargs):
    # Instead of leaving this up to the database, check and handle it
    # ourselves to avoid nasty exceptions; as a bonus we won't miss when
    # the max length is too short with databases that don't enforce
    # the limits (e.g. sqlite)
    for field in instance._meta.get_fields():
        if isinstance(field, models.CharField):
            value = getattr(instance, field.name)
            if value and len(value) > field.max_length:
                logger.warning('%s.%s: length %s exceeds maximum (%s), truncating' % (instance.__class__.__name__, field.name, len(value), field.max_length))
                setattr(instance, field.name, value[:field.max_length])


class PythonEnvironment(models.Model):
    name = models.CharField(max_length=50)
    python_command = models.CharField(max_length=255, default='python')
    virtualenv_path = models.CharField(max_length=255, blank=True)

    def get_command(self):
        if self.virtualenv_path:
            cmd = '. %s/bin/activate; %s' % (self.virtualenv_path, self.python_command)
        else:
            cmd = self.python_command
        return cmd

    def __str__(self):
        return self.name


class Branch(models.Model):
    name = models.CharField('Branch name', max_length=50)
    bitbake_branch = models.CharField(max_length=50)
    short_description = models.CharField(max_length=50, blank=True)
    sort_priority = models.IntegerField(blank=True, null=True)
    updates_enabled = models.BooleanField('Enable updates', default=True, help_text='Enable automatically updating layer metadata for this branch via the update script')
    update_environment = models.ForeignKey(PythonEnvironment, blank=True, null=True, on_delete=models.SET_NULL)

    updated = models.DateTimeField(auto_now=True, blank=True, null=True)

    class Meta:
        verbose_name_plural = "Branches"
        ordering = ['sort_priority']

    def __str__(self):
        if self.short_description:
            return '%s (%s)' % (self.name, self.short_description)
        else:
            return self.name


class Update(models.Model):
    started = models.DateTimeField()
    finished = models.DateTimeField(blank=True, null=True)
    log = models.TextField(blank=True)
    reload = models.BooleanField('Reloaded', default=False, help_text='Was this update a reload?')

    def __str__(self):
        return '%s' % self.started


class LayerItem(models.Model):
    LAYER_STATUS_CHOICES = (
        ('N', 'New'),
        ('P', 'Published'),
        ('X', 'No update'),
    )
    LAYER_TYPE_CHOICES = (
        ('A', 'Base'),
        ('B', 'Machine (BSP)'),
        ('S', 'Software'),
        ('D', 'Distribution'),
        ('M', 'Miscellaneous'),
    )
    name = models.CharField('Layer name', max_length=40, unique=True, help_text='Name of the layer - must be unique and can only contain letters, numbers and dashes')
    status = models.CharField(max_length=1, choices=LAYER_STATUS_CHOICES, default='N')
    layer_type = models.CharField(max_length=1, choices=LAYER_TYPE_CHOICES)
    summary = models.CharField(max_length=200, help_text='One-line description of the layer')
    description = models.TextField()
    vcs_url = models.CharField('Repository URL', max_length=255, help_text='Fetch/clone URL of the repository')
    vcs_web_url = models.URLField('Repository web interface URL', blank=True, help_text='URL of the web interface for browsing the repository, if any')
    vcs_web_tree_base_url = models.CharField('Repository web interface tree base URL', max_length=255, blank=True, help_text='Base URL for the web interface for browsing directories within the repository, if any')
    vcs_web_file_base_url = models.CharField('Repository web interface file base URL', max_length=255, blank=True, help_text='Base URL for the web interface for viewing files (blobs) within the repository, if any')
    vcs_web_commit_url = models.CharField('Repository web interface commit URL', max_length=255, blank=True, help_text='Base URL for the web interface for viewing a single commit within the repository, if any')
    usage_url = models.CharField('Usage web page URL', max_length=255, blank=True, help_text='URL of a web page with more information about the layer and how to use it, if any (or path to file within repository)')
    mailing_list_url = models.URLField('Mailing list URL', blank=True, help_text='URL of the info page for a mailing list for discussing the layer, if any')
    index_preference = models.IntegerField('Preference', default=0, help_text='Number used to find preferred recipes in recipe search results (higher number is greater preference)')
    classic = models.BooleanField('Classic', default=False, help_text='Is this OE-Classic?')

    updated = models.DateTimeField(auto_now=True)

    class Meta:
        verbose_name = "Layer"
        permissions = (
            ("publish_layer", "Can publish layers"),
        )

    def change_status(self, newstatus, username):
        self.status = newstatus

    def get_layerbranch(self, branchname):
        if branchname:
            res = list(self.layerbranch_set.filter(branch__name=branchname)[:1])
        else:
            res = list(self.layerbranch_set.all()[:1])
        if res:
            return res[0]
        return None

    def active_maintainers(self):
        matches = None
        for layerbranch in self.layerbranch_set.all():
            branchmatches = layerbranch.layermaintainer_set.filter(status='A')
            if matches:
                matches |= branchmatches
            else:
                matches = branchmatches
        return matches

    def user_can_edit(self, user):
        if user.is_authenticated():
            user_email = user.email.strip().lower()
            for maintainer in self.active_maintainers():
                if maintainer.email.strip().lower() == user_email:
                    return True
        return False

    def get_fetch_dir(self):
        fetch_dir = ""
        for c in self.vcs_url:
            if c in '/ .=+?:':
                fetch_dir += "_"
            else:
                fetch_dir += c
        return fetch_dir

    def get_absolute_url(self):
        return reverse('layer_item', args=('master',self.name));

    def __str__(self):
        return self.name

class YPCompatibleVersion(models.Model):
    name = models.CharField('Yocto Project Version', max_length=25, unique=True, help_text='Name of this Yocto Project compatible version (e.g. "2.0")')
    description = models.TextField(blank=True)
    image_url = models.CharField('Image URL', max_length=300, blank=True)
    link_url = models.CharField('Link URL', max_length=100, blank=True)

    class Meta:
        verbose_name = 'Yocto Project Compatible version'
        ordering = ('name',)

    def __str__(self):
        return self.name

class LayerBranch(models.Model):
    layer = models.ForeignKey(LayerItem)
    branch = models.ForeignKey(Branch)
    collection = models.CharField('Layer Collection', max_length=40, null=True, blank=True, help_text='Name of the collection that the layer provides for the purpose of expressing dependencies (as specified in BBFILE_COLLECTIONS). Can only contain letters, numbers and dashes.')
    version = models.CharField('Layer Version', max_length=10, null=True, blank=True, help_text='The layer version for this particular branch.')
    vcs_subdir = models.CharField('Repository subdirectory', max_length=40, blank=True, help_text='Subdirectory within the repository where the layer is located, if not in the root (usually only used if the repository contains more than one layer)')
    vcs_last_fetch = models.DateTimeField('Last successful fetch', blank=True, null=True)
    vcs_last_rev = models.CharField('Last revision fetched', max_length=80, blank=True)
    vcs_last_commit = models.DateTimeField('Last commit date', blank=True, null=True)
    actual_branch = models.CharField('Actual Branch', max_length=80, blank=True, help_text='Name of the actual branch in the repository matching the core branch')
    yp_compatible_version = models.ForeignKey(YPCompatibleVersion, verbose_name='Yocto Project Compatible version', null=True, blank=True, on_delete=models.SET_NULL, help_text='Which version of the Yocto Project Compatible program has this layer been approved for for?')

    updated = models.DateTimeField(auto_now=True)

    class Meta:
        verbose_name_plural = "Layer branches"
        permissions = (
            ("set_yp_compatibility", "Can set YP compatibility"),
        )

    def sorted_recipes(self):
        return self.recipe_set.order_by('pn', '-pv')

    def active_maintainers(self):
        return self.layermaintainer_set.filter(status='A')

    def _handle_url_path(self, base_url, path):
        if base_url:
            if self.vcs_subdir:
                if path:
                    extra_path = self.vcs_subdir + '/' + path
                    # Normalise out ../ in path for usage URL
                    extra_path = posixpath.normpath(extra_path)
                    # Minor workaround to handle case where subdirectory has been added between branches
                    # (should probably support usage URL per branch to handle this... sigh...)
                    if extra_path.startswith('../'):
                        extra_path = extra_path[3:]
                else:
                    extra_path = self.vcs_subdir
            else:
                extra_path = path
            if self.actual_branch:
                branchname = self.actual_branch
            else:
                branchname = self.branch.name
            url = base_url.replace('%branch%', branchname)

            # If there's a % in the path (e.g. a wildcard bbappend) we need to encode it
            if extra_path:
                extra_path = extra_path.replace('%', '%25')

            if '%path%' in base_url:
                if extra_path:
                    url = re.sub(r'\[([^\]]*%path%[^\]]*)\]', '\\1', url)
                else:
                    url = re.sub(r'\[([^\]]*%path%[^\]]*)\]', '', url)
                return url.replace('%path%', extra_path)
            else:
                return url + extra_path
        return None

    def tree_url(self, path = ''):
        return self._handle_url_path(self.layer.vcs_web_tree_base_url, path)

    def file_url(self, path = ''):
        return self._handle_url_path(self.layer.vcs_web_file_base_url, path)

    def commit_url(self, commit_hash):
        url = self.layer.vcs_web_commit_url
        url = url.replace('%hash%', commit_hash)
        if self.actual_branch:
            branchname = self.actual_branch
        else:
            branchname = self.branch.name
        url = url.replace('%branch%', branchname)
        return url

    def test_tree_url(self):
        return self.tree_url('conf')

    def test_file_url(self):
        return self.file_url('conf/layer.conf')

    def get_usage_url(self):
        usage_url = self.layer.usage_url
        if usage_url.startswith('http'):
            return usage_url
        else:
            url = self.file_url(usage_url)
            if url:
                if '/../' in url:
                    url = resolveComponents(url)
            return url

    def __str__(self):
        return "%s: %s" % (self.layer.name, self.branch.name)


    def get_required(self):
        return self.dependencies_set.filter(required=True)

    def get_recommends(self):
        return self.dependencies_set.filter(required=False)

class LayerMaintainer(models.Model):
    MAINTAINER_STATUS_CHOICES = (
        ('A', 'Active'),
        ('I', 'Inactive'),
    )
    layerbranch = models.ForeignKey(LayerBranch)
    name = models.CharField(max_length=255)
    email = models.CharField(max_length=255)
    responsibility = models.CharField(max_length=200, blank=True, help_text='Specific area(s) this maintainer is responsible for, if not the entire layer')
    status = models.CharField(max_length=1, choices=MAINTAINER_STATUS_CHOICES, default='A')

    def __str__(self):
        respstr = ""
        if self.responsibility:
            respstr = " (%s)" % self.responsibility
        return "%s: %s <%s>%s" % (self.layerbranch.layer.name, self.name, self.email, respstr)


class LayerDependency(models.Model):
    layerbranch = models.ForeignKey(LayerBranch, related_name='dependencies_set')
    dependency = models.ForeignKey(LayerItem, related_name='dependents_set')
    required = models.BooleanField(default=True)

    class Meta:
        verbose_name_plural = "Layer dependencies"

    def __str__(self):
        return "%s depends on %s" % (self.layerbranch.layer.name, self.dependency.name)


class LayerNote(models.Model):
    layer = models.ForeignKey(LayerItem)
    text = models.TextField()

    def __str__(self):
        return "%s: %s" % (self.layer.name, self.text)


class LayerUpdate(models.Model):
    layerbranch = models.ForeignKey(LayerBranch)
    update = models.ForeignKey(Update)
    started = models.DateTimeField()
    finished = models.DateTimeField()
    errors = models.IntegerField(default=0)
    warnings = models.IntegerField(default=0)
    log = models.TextField(blank=True)

    def save(self):
        warnings = 0
        errors = 0
        for line in self.log.splitlines():
            if line.startswith('WARNING:'):
                warnings += 1
            elif line.startswith('ERROR:'):
                errors += 1
        self.warnings = warnings
        self.errors = errors
        super(LayerUpdate, self).save()

    def __str__(self):
        return "%s: %s: %s" % (self.layerbranch.layer.name, self.layerbranch.branch.name, self.started)


class Recipe(models.Model):
    layerbranch = models.ForeignKey(LayerBranch)
    filename = models.CharField(max_length=255)
    filepath = models.CharField(max_length=255, blank=True)
    pn = models.CharField(max_length=100, blank=True)
    pv = models.CharField(max_length=100, blank=True)
    summary = models.CharField(max_length=200, blank=True)
    description = models.TextField(blank=True)
    section = models.CharField(max_length=100, blank=True)
    license = models.CharField(max_length=2048, blank=True)
    homepage = models.URLField(blank=True)
    bugtracker = models.URLField(blank=True)
    provides = models.CharField(max_length=2048, blank=True)
    bbclassextend = models.CharField(max_length=100, blank=True)
    inherits = models.CharField(max_length=255, blank=True)
    updated = models.DateTimeField(auto_now=True)
    blacklisted = models.CharField(max_length=255, blank=True)

    def vcs_web_url(self):
        url = self.layerbranch.file_url(os.path.join(self.filepath, self.filename))
        return url or ''

    def full_path(self):
        return os.path.join(self.filepath, self.filename)

    def short_desc(self):
        if self.summary:
            return self.summary
        else:
            return self.description

    def name(self):
        if self.pn:
            return self.pn
        else:
            return self.filename.split('_')[0]

    def homepage_url_only(self):
        if '://' in self.homepage:
            return self.homepage
        else:
            return None

    def __str__(self):
        return os.path.join(self.filepath, self.filename)

class Source(models.Model):
    recipe = models.ForeignKey(Recipe)
    url = models.CharField(max_length=255)

    def __str__(self):
        return '%s - %s' % (self.recipe.pn, self.url)

class PackageConfig(models.Model):
    recipe = models.ForeignKey(Recipe)
    feature = models.CharField(max_length=255)
    with_option = models.CharField(max_length=255, blank=True)
    without_option = models.CharField(max_length=255, blank=True)
    build_deps = models.CharField(max_length=255, blank=True)

    def __str__(self):
        return "%s - %s" % (self.recipe, self.feature)

    def get_deps_list(self):
        return self.build_deps.split()

class StaticBuildDep(models.Model):
    recipes = models.ManyToManyField(Recipe)
    name = models.CharField(max_length=255)

    def __str__(self):
        return self.name

class DynamicBuildDep(models.Model):
    package_configs = models.ManyToManyField(PackageConfig)
    recipes = models.ManyToManyField(Recipe)
    name = models.CharField(max_length=255)

    def __str__(self):
        return self.name

class RecipeFileDependency(models.Model):
    recipe = models.ForeignKey(Recipe)
    layerbranch = models.ForeignKey(LayerBranch, related_name='+')
    path = models.CharField(max_length=255, db_index=True)

    class Meta:
        verbose_name_plural = "Recipe file dependencies"

    def __str__(self):
        return '%s' % self.path


class ClassicRecipe(Recipe):
    COVER_STATUS_CHOICES = [
        ('U', 'Unknown'),
        ('N', 'Not available'),
        ('R', 'Replaced'),
        ('P', 'Provided (BBCLASSEXTEND)'),
        ('C', 'Provided (PACKAGECONFIG)'),
        ('O', 'Obsolete'),
        ('E', 'Equivalent functionality'),
        ('D', 'Direct match'),
    ]
    cover_layerbranch = models.ForeignKey(LayerBranch, verbose_name='Covering layer', blank=True, null=True, limit_choices_to = {'branch__name': 'master'}, on_delete=models.SET_NULL)
    cover_pn = models.CharField('Covering recipe', max_length=100, blank=True)
    cover_status = models.CharField(max_length=1, choices=COVER_STATUS_CHOICES, default='U')
    cover_verified = models.BooleanField(default=False)
    cover_comment = models.TextField(blank=True)
    classic_category = models.CharField('OE-Classic Category', max_length=100, blank=True)

    class Meta:
        permissions = (
            ("edit_classic", "Can edit OE-Classic recipes"),
        )

    def get_cover_desc(self):
        desc = self.get_cover_status_display()
        if self.cover_layerbranch:
            cover_layer = self.cover_layerbranch.layer.name
        else:
            cover_layer = '(unknown layer)'
        if self.cover_status == 'D':
            desc = 'Direct match exists in %s' % cover_layer
        elif self.cover_pn:
            if self.cover_status == 'R':
                desc = 'Replaced by %s in %s' % (self.cover_pn, cover_layer)
            elif self.cover_status == 'P':
                desc = 'Provided by %s in %s (BBCLASSEXTEND)' % (self.cover_pn, cover_layer)
            elif self.cover_status == 'C':
                desc = 'Provided by %s in %s (as a PACKAGECONFIG option)' % (self.cover_pn, cover_layer)
            elif self.cover_status == 'E':
                desc = 'Equivalent functionality provided by %s in %s' % (self.cover_pn, cover_layer)
        if self.cover_comment:
            if self.cover_comment[0] == '(':
                desc = "%s %s" % (desc, self.cover_comment)
            else:
                desc = "%s - %s" % (desc, self.cover_comment)
        return desc


class Machine(models.Model):
    layerbranch = models.ForeignKey(LayerBranch)
    name = models.CharField(max_length=255)
    description = models.CharField(max_length=255)

    updated = models.DateTimeField(auto_now=True)

    def vcs_web_url(self):
        url = self.layerbranch.file_url(os.path.join('conf/machine/%s.conf' % self.name))
        return url or ''

    def __str__(self):
        return '%s (%s)' % (self.name, self.layerbranch.layer.name)

class Distro(models.Model):
    layerbranch = models.ForeignKey(LayerBranch)
    name = models.CharField(max_length=255)
    description = models.CharField(max_length=255)

    updated = models.DateTimeField(auto_now=True)

    def vcs_web_url(self):
        url = self.layerbranch.file_url(os.path.join('conf/distro/%s.conf' % self.name))
        return url or ''

    def __str__(self):
        return '%s (%s)' % (self.name, self.layerbranch.layer.name)


class BBAppend(models.Model):
    layerbranch = models.ForeignKey(LayerBranch)
    filename = models.CharField(max_length=255)
    filepath = models.CharField(max_length=255, blank=True)

    class Meta:
        verbose_name = "Append"

    def vcs_web_url(self):
        url = self.layerbranch.file_url(os.path.join(self.filepath, self.filename))
        return url or ''

    def matches_recipe(self, recipe):
        recipename = recipe.filename[:-3]
        appendname = self.filename[:-9]
        if recipename == appendname:
            return True
        elif '%' in appendname:
            import fnmatch
            return fnmatch.fnmatch(recipename, appendname.replace('%', '*'))
        return False

    def __str__(self):
        return os.path.join(self.filepath, self.filename)


class BBClass(models.Model):
    layerbranch = models.ForeignKey(LayerBranch)
    name = models.CharField(max_length=100)

    class Meta:
        verbose_name = "Class"
        verbose_name_plural = "Classes"

    def vcs_web_url(self):
        url = self.layerbranch.file_url(os.path.join('classes', "%s.bbclass" % self.name))
        return url or ''

    def __str__(self):
        return '%s (%s)' % (self.name, self.layerbranch.layer.name)


class RecipeChangeset(models.Model):
    user = models.ForeignKey(User)
    name = models.CharField(max_length=255)

    def __str__(self):
        return '%s' % (self.name)


class RecipeChange(models.Model):
    RECIPE_VARIABLE_MAP = {
        'summary': 'SUMMARY',
        'description': 'DESCRIPTION',
        'section': 'SECTION',
        'license': 'LICENSE',
        'homepage': 'HOMEPAGE',
        'bugtracker': 'BUGTRACKER',
    }

    changeset = models.ForeignKey(RecipeChangeset)
    recipe = models.ForeignKey(Recipe, related_name='+')
    summary = models.CharField(max_length=100, blank=True)
    description = models.TextField(blank=True)
    section = models.CharField(max_length=100, blank=True)
    license = models.CharField(max_length=100, blank=True)
    homepage = models.URLField("Homepage URL", blank=True)
    bugtracker = models.URLField("Bug tracker URL", blank=True)

    def changed_fields(self, mapped = False):
        res = {}
        for fieldname in self.RECIPE_VARIABLE_MAP:
            value = getattr(self, fieldname)
            origvalue = getattr(self.recipe, fieldname)
            if value != origvalue:
                if mapped:
                    res[self.RECIPE_VARIABLE_MAP[fieldname]] = value
                else:
                    res[fieldname] = value
        return res

    def reset_fields(self):
        for fieldname in self.RECIPE_VARIABLE_MAP:
            setattr(self, fieldname, getattr(self.recipe, fieldname))