← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/rules.py

  • Committer: Patch Queue Manager
  • Date: 2012-01-18 16:23:31 UTC
  • mfrom: (6439.1.1 work)
  • Revision ID: pqm@pqm.ubuntu.com-20120118162331-md4sf1tw6hyuw344
(vila) Ensure people get an easy access to the release details from
 announcements. (Vincent Ladeuil)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/rules.py
 
1
# Copyright (C) 2008, 2009, 2010 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
"""Rule-based definition of preferences for selected files in selected branches.
 
18
 
 
19
See ``bzr help rules`` for details.
 
20
"""
 
21
 
 
22
from __future__ import absolute_import
 
23
 
 
24
from bzrlib import (
 
25
    config,
 
26
    cmdline,
 
27
    errors,
 
28
    globbing,
 
29
    osutils,
 
30
    )
 
31
from bzrlib.util.configobj import configobj
 
32
 
 
33
 
 
34
# Name of the file holding rules in a tree
 
35
RULES_TREE_FILENAME = ".bzrrules"
 
36
 
 
37
# Namespace prefix for per file preferences
 
38
FILE_PREFS_PREFIX = 'name '
 
39
FILE_PREFS_PREFIX_LEN = len(FILE_PREFS_PREFIX)
 
40
 
 
41
# The object providing default rules
 
42
_per_user_searcher = None
 
43
 
 
44
 
 
45
class _RulesSearcher(object):
 
46
    """An object that provides rule-based preferences."""
 
47
 
 
48
    def get_items(self, path):
 
49
        """Return the preferences for a path as name,value tuples.
 
50
 
 
51
        :param path: tree relative path
 
52
        :return: () if no rule matched, otherwise a sequence of name,value
 
53
          tuples.
 
54
        """
 
55
        raise NotImplementedError(self.get_items)
 
56
 
 
57
    def get_selected_items(self, path, names):
 
58
        """Return selected preferences for a path as name,value tuples.
 
59
 
 
60
        :param path: tree relative path
 
61
        :param names: the list of preferences to lookup
 
62
        :return: () if no rule matched, otherwise a sequence of name,value
 
63
          tuples. The sequence is the same length as names,
 
64
          tuple order matches the order in names, and
 
65
          undefined preferences are given the value None.
 
66
        """
 
67
        raise NotImplementedError(self.get_selected_items)
 
68
 
 
69
    def get_single_value(self, path, preference_name):
 
70
        """Get a single preference for a single file.
 
71
        
 
72
        :returns: The string preference value, or None.
 
73
        """
 
74
        for key, value in self.get_selected_items(path, [preference_name]):
 
75
            return value
 
76
        return None
 
77
 
 
78
 
 
79
class _IniBasedRulesSearcher(_RulesSearcher):
 
80
 
 
81
    def __init__(self, inifile):
 
82
        """Construct a _RulesSearcher based on an ini file.
 
83
 
 
84
        The content will be decoded as utf-8.
 
85
 
 
86
        :param inifile: the name of the file or a sequence of lines.
 
87
        """
 
88
        self._cfg = configobj.ConfigObj(inifile, encoding='utf-8')
 
89
        sections = self._cfg.keys()
 
90
        patterns = []
 
91
        self.pattern_to_section = {}
 
92
        for s in sections:
 
93
            if s.startswith(FILE_PREFS_PREFIX):
 
94
                file_patterns = cmdline.split(s[FILE_PREFS_PREFIX_LEN:])
 
95
                patterns.extend(file_patterns)
 
96
                for fp in file_patterns:
 
97
                    self.pattern_to_section[fp] = s
 
98
        if len(patterns) < len(sections):
 
99
            unknowns = [s for s in sections
 
100
                if not s.startswith(FILE_PREFS_PREFIX)]
 
101
            raise errors.UnknownRules(unknowns)
 
102
        elif patterns:
 
103
            self._globster = globbing._OrderedGlobster(patterns)
 
104
        else:
 
105
            self._globster = None
 
106
 
 
107
    def get_items(self, path):
 
108
        """See _RulesSearcher.get_items."""
 
109
        if self._globster is None:
 
110
            return ()
 
111
        pat = self._globster.match(path)
 
112
        if pat is None:
 
113
            return ()
 
114
        else:
 
115
            all = self._cfg[self.pattern_to_section[pat]]
 
116
            return tuple(all.items())
 
117
 
 
118
    def get_selected_items(self, path, names):
 
119
        """See _RulesSearcher.get_selected_items."""
 
120
        if self._globster is None:
 
121
            return ()
 
122
        pat = self._globster.match(path)
 
123
        if pat is None:
 
124
            return ()
 
125
        else:
 
126
            all = self._cfg[self.pattern_to_section[pat]]
 
127
            return tuple((k, all.get(k)) for k in names)
 
128
 
 
129
 
 
130
class _StackedRulesSearcher(_RulesSearcher):
 
131
 
 
132
    def __init__(self, searchers):
 
133
        """Construct a _RulesSearcher based on a stack of other ones.
 
134
 
 
135
        :param searchers: a sequence of searchers.
 
136
        """
 
137
        self.searchers = searchers
 
138
 
 
139
    def get_items(self, path):
 
140
        """See _RulesSearcher.get_items."""
 
141
        for searcher in self.searchers:
 
142
            result = searcher.get_items(path)
 
143
            if result:
 
144
                return result
 
145
        return ()
 
146
 
 
147
    def get_selected_items(self, path, names):
 
148
        """See _RulesSearcher.get_selected_items."""
 
149
        for searcher in self.searchers:
 
150
            result = searcher.get_selected_items(path, names)
 
151
            if result:
 
152
                return result
 
153
        return ()
 
154
 
 
155
 
 
156
def rules_filename():
 
157
    """Return the default rules filename."""
 
158
    return osutils.pathjoin(config.config_dir(), 'rules')
 
159
 
 
160
 
 
161
def reset_rules():
 
162
    global _per_user_searcher
 
163
    _per_user_searcher = _IniBasedRulesSearcher(rules_filename())
 
164
 
 
165
reset_rules()