← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/rules.py

  • Committer: Martin Pool
  • Date: 2005-05-11 06:20:05 UTC
  • Revision ID: mbp@sourcefrog.net-20050511062005-297af3451635dae0
- Don't lose first line of command help!

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