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

"""Translation access and sharing policy."""

__metaclass__ = type
__all__ = [
    'TranslationPolicyMixin',
    ]

from storm.expr import (
    And,
    LeftJoin,
    )
from zope.component import getUtility

from canonical.launchpad.interfaces.lpstorm import IStore
from lp.app.interfaces.launchpad import ILaunchpadCelebrities
from lp.registry.model.person import Person
from lp.translations.enums import TranslationPermission
from lp.translations.interfaces.translationsperson import ITranslationsPerson
from lp.translations.model.translationgroup import TranslationGroup
from lp.translations.model.translator import Translator


def has_translators(translators_list):
    """Did `getTranslators` find any translators?"""
    for group, translator, team in translators_list:
        if team is not None:
            return True
    return False


def is_in_one_of_translators(translators_list, person):
    """Is `person` a member of one of the entries in `getTranslators`?"""
    for group, translator, team in translators_list:
        if team is not None and person.inTeam(team):
            return True
    return False


class TranslationPolicyMixin:
    """Implementation mixin for `ITranslationPolicy`."""

    def getInheritedTranslationPolicy(self):
        """Get any `ITranslationPolicy` objects that this one inherits.

        To be overridden by the implementing class.  A `Product` may
        inherit a policy from a `ProjectGroup` it's in.
        """
        return None

    def isTranslationsOwner(self, person):
        """Is `person` one of the owners of these translations?

        To be overridden by the implementing class if it grants special
        translation rights to certain people.
        """
        return False

    def _hasSpecialTranslationPrivileges(self, person):
        """Does this person have special translation editing rights here?"""
        celebs = getUtility(ILaunchpadCelebrities)
        return (
            person.inTeam(celebs.admin) or
            person.inTeam(celebs.rosetta_experts) or
            self.isTranslationsOwner(person))

    def _canTranslate(self, person):
        """Is `person` in a position to translate?

        Someone who has declined the translations relicensing agreement
        is not.  Someone who hasn't decided on the agreement yet is, but
        may be redirected to a form to sign first.
        """
        translations_person = ITranslationsPerson(person)
        agreement = translations_person.translations_relicensing_agreement
        return agreement is not False

    def getTranslationGroups(self):
        """See `ITranslationPolicy`."""
        inherited = self.getInheritedTranslationPolicy()
        if inherited is None:
            groups = []
        else:
            groups = inherited.getTranslationGroups()
        my_group = self.translationgroup
        if my_group is not None and my_group not in groups:
            groups.append(my_group)
        return groups

    def _getTranslator(self, translationgroup, language, store):
        """Retrieve one (TranslationGroup, Translator, Person) tuple."""
        translator_join = LeftJoin(Translator, And(
            Translator.translationgroupID == TranslationGroup.id,
            Translator.languageID == language.id))
        person_join = LeftJoin(
            Person, Person.id == Translator.translatorID)

        source = store.using(TranslationGroup, translator_join, person_join)
        return source.find(
            (TranslationGroup, Translator, Person),
            TranslationGroup.id == translationgroup.id).one()

    def getTranslators(self, language, store=None):
        """See `ITranslationPolicy`."""
        if store is None:
            store = IStore(TranslationGroup)
        return [
            self._getTranslator(group, language, store)
            for group in self.getTranslationGroups()]

    def getEffectiveTranslationPermission(self):
        """See `ITranslationPolicy`."""
        inherited = self.getInheritedTranslationPolicy()
        if inherited is None:
            return self.translationpermission
        else:
            return max([
                self.translationpermission,
                inherited.getEffectiveTranslationPermission()])

    def invitesTranslationEdits(self, person, language):
        """See `ITranslationPolicy`."""
        if person is None:
            return False

        model = self.getEffectiveTranslationPermission()
        if model == TranslationPermission.OPEN:
            # Open permissions invite all contributions.
            return True

        translators = self.getTranslators(language)
        if model == TranslationPermission.STRUCTURED:
            # Structured permissions act like Open if no translators
            # have been assigned for the language.
            if not has_translators(translators):
                return True

        # Translation-team members are always invited to edit.
        return is_in_one_of_translators(translators, person)

    def invitesTranslationSuggestions(self, person, language):
        """See `ITranslationPolicy`."""
        if person is None:
            return False

        model = self.getEffectiveTranslationPermission()

        # These models always invite suggestions from anyone.
        welcoming_models = [
            TranslationPermission.OPEN,
            TranslationPermission.STRUCTURED,
            ]
        if model in welcoming_models:
            return True

        translators = self.getTranslators(language)
        if model == TranslationPermission.RESTRICTED:
            if has_translators(translators):
                # Restricted invites any user's suggestions as long as
                # there is a translation team to handle them.
                return True

        # Translation-team members are always invited to suggest.
        return is_in_one_of_translators(translators, person)

    def allowsTranslationEdits(self, person, language):
        """See `ITranslationPolicy`."""
        if person is None:
            return False
        if self._hasSpecialTranslationPrivileges(person):
            return True
        return (
            self._canTranslate(person) and
            self.invitesTranslationEdits(person, language))

    def allowsTranslationSuggestions(self, person, language):
        """See `ITranslationPolicy`."""
        if person is None:
            return False
        if self._hasSpecialTranslationPrivileges(person):
            return True
        return (
            self._canTranslate(person) and
            self.invitesTranslationSuggestions(person, language))