~launchpad-pqm/launchpad/devel

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
# Copyright 2011 Canonical Ltd.  This software is licensed under the
# GNU Affero General Public License version 3 (see the file LICENSE).

"""Adapters to figure out affiliations between people and pillars/bugs etc.

When using a person in a given context, for example as a selection item in a
picker used to choose a bug task assignee, it is important to provide an
indication as to how that person may be affiliated with the context. Amongst
other reasons, this provides a visual cue that the correct person is being
selected for example.

The adapters herein are provided for various contexts so that for a given
person, the relevant affiliation details may be determined.

"""

__metaclass__ = type

__all__ = [
    'IHasAffiliation',
    ]

from zope.component import adapter
from zope.interface import (
    implements,
    Interface,
    )

from lp.bugs.interfaces.bugtask import IBugTask


class IHasAffiliation(Interface):
    """The affiliation status of a person with a context."""

    def getAffiliationBadge(person):
        """Return the badge name for the type of affiliation the person has.

        If the person has no affiliation with this object, return None.
        """


@adapter(Interface)
class PillarAffiliation(object):
    """Default affiliation adapter.

    No affiliation is returned.
    """

    implements(IHasAffiliation)

    def __init__(self, context):
        self.context = context

    def getAffiliationBadge(self, person):
        return None


# XXX: wallyworld 2011-05-24 bug=81692: TODO Work is required to determine
# exactly what is required in terms of figuring out affiliation..

@adapter(IBugTask)
class BugTaskPillarAffiliation(PillarAffiliation):
    """An affiliation adapter for bug tasks."""

    def getAffiliationBadge(self, person):
        pillar = self.context.pillar
        affiliated = person.inTeam(pillar.owner)
        if not affiliated:
            return None
        if self.context.distribution or self.context.distroseries:
            return "distribution-badge"
        if self.context.product or self.context.productseries:
            return "product-badge"