← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/rules.py

Lift Branch.set_stacked_on_url up from BzrBranch7.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/rules.py
 
1
# Copyright (C) 2008 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 bzrlib import (
 
23
    config,
 
24
    commands,
 
25
    errors,
 
26
    globbing,
 
27
    osutils,
 
28
    )
 
29
from bzrlib.util.configobj import configobj
 
30
 
 
31
 
 
32
# Name of the file holding rules in a tree
 
33
RULES_TREE_FILENAME = ".bzrrules"
 
34
 
 
35
# Namespace prefix for per file preferences
 
36
FILE_PREFS_PREFIX = 'name '
 
37
FILE_PREFS_PREFIX_LEN = len(FILE_PREFS_PREFIX)
 
38
 
 
39
 
 
40
class _RulesSearcher(object):
 
41
    """An object that provides rule-based preferences."""
 
42
 
 
43
    def get_items(self, path):
 
44
        """Return the preferences for a path as name,value tuples.
 
45
 
 
46
        :param path: tree relative path
 
47
        :return: () if no rule matched, otherwise a sequence of name,value
 
48
          tuples.
 
49
        """
 
50
        raise NotImplementedError(self.get_items)
 
51
 
 
52
    def get_selected_items(self, path, names):
 
53
        """Return selected preferences for a path as name,value tuples.
 
54
 
 
55
        :param path: tree relative path
 
56
        :param names: the list of preferences to lookup
 
57
        :return: () if no rule matched, otherwise a sequence of name,value
 
58
          tuples. The sequence is the same length as names,
 
59
          tuple order matches the order in names, and
 
60
          undefined preferences are given the value None.
 
61
        """
 
62
        raise NotImplementedError(self.get_selected_items)
 
63
 
 
64
 
 
65
class _IniBasedRulesSearcher(_RulesSearcher):
 
66
 
 
67
    def __init__(self, inifile):
 
68
        """Construct a _RulesSearcher based on an ini file.
 
69
 
 
70
        The content will be decoded as utf-8.
 
71
 
 
72
        :param inifile: the name of the file or a sequence of lines.
 
73
        """
 
74
        options = {'encoding': 'utf-8'}
 
75
        self._cfg = configobj.ConfigObj(inifile, options=options)
 
76
        sections = self._cfg.keys()
 
77
        patterns = []
 
78
        self.pattern_to_section = {}
 
79
        for s in sections:
 
80
            if s.startswith(FILE_PREFS_PREFIX):
 
81
                file_patterns = commands.shlex_split_unicode(
 
82
                    s[FILE_PREFS_PREFIX_LEN:])
 
83
                patterns.extend(file_patterns)
 
84
                for fp in file_patterns:
 
85
                    self.pattern_to_section[fp] = s
 
86
        if len(patterns) < len(sections):
 
87
            unknowns = [s for s in sections
 
88
                if not s.startswith(FILE_PREFS_PREFIX)]
 
89
            raise errors.UnknownRules(unknowns)
 
90
        elif patterns:
 
91
            self._globster = globbing._OrderedGlobster(patterns)
 
92
        else:
 
93
            self._globster = None
 
94
 
 
95
    def get_items(self, path):
 
96
        """See _RulesSearcher.get_items."""
 
97
        if self._globster is None:
 
98
            return ()
 
99
        pat = self._globster.match(path)
 
100
        if pat is None:
 
101
            return ()
 
102
        else:
 
103
            all = self._cfg[self.pattern_to_section[pat]]
 
104
            return tuple(all.items())
 
105
 
 
106
    def get_selected_items(self, path, names):
 
107
        """See _RulesSearcher.get_selected_items."""
 
108
        if self._globster is None:
 
109
            return ()
 
110
        pat = self._globster.match(path)
 
111
        if pat is None:
 
112
            return ()
 
113
        else:
 
114
            all = self._cfg[self.pattern_to_section[pat]]
 
115
            return tuple((k, all.get(k)) for k in names)
 
116
 
 
117
 
 
118
class _StackedRulesSearcher(_RulesSearcher):
 
119
 
 
120
    def __init__(self, searchers):
 
121
        """Construct a _RulesSearcher based on a stack of other ones.
 
122
 
 
123
        :param searchers: a sequence of searchers.
 
124
        """
 
125
        self.searchers = searchers
 
126
 
 
127
    def get_items(self, path):
 
128
        """See _RulesSearcher.get_items."""
 
129
        for searcher in self.searchers:
 
130
            result = searcher.get_items(path)
 
131
            if result:
 
132
                return result
 
133
        return ()
 
134
 
 
135
    def get_selected_items(self, path, names):
 
136
        """See _RulesSearcher.get_selected_items."""
 
137
        for searcher in self.searchers:
 
138
            result = searcher.get_selected_items(path, names)
 
139
            if result:
 
140
                return result
 
141
        return ()
 
142
 
 
143
 
 
144
def rules_filename():
 
145
    """Return the default rules filename."""
 
146
    return osutils.pathjoin(config.config_dir(), 'rules')
 
147
 
 
148
 
 
149
# The object providing default rules
 
150
_per_user_searcher = _IniBasedRulesSearcher(rules_filename())