1
# Copyright (C) 2008 Canonical Ltd
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.
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.
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
19
Views are contained within a working tree and normally constructed
20
when first accessed. Clients should do, for example, ...
22
tree.views.lookup_view()
25
from __future__ import absolute_import
35
_VIEWS_FORMAT_MARKER_RE = re.compile(r'Bazaar views format (\d+)')
36
_VIEWS_FORMAT1_MARKER = "Bazaar views format 1\n"
39
class NoSuchView(errors.BzrError):
40
"""A view does not exist.
43
_fmt = u"No such view: %(view_name)s."
45
def __init__(self, view_name):
46
self.view_name = view_name
49
class ViewsNotSupported(errors.BzrError):
50
"""Views are not supported by a tree format.
53
_fmt = ("Views are not supported by %(tree)s;"
54
" use 'brz upgrade' to change your tree to a later format.")
56
def __init__(self, tree):
60
class FileOutsideView(errors.BzrError):
62
_fmt = ('Specified file "%(file_name)s" is outside the current view: '
65
def __init__(self, file_name, view_files):
66
self.file_name = file_name
67
self.view_str = ", ".join(view_files)
71
"""Base class for View managers."""
73
def supports_views(self):
74
raise NotImplementedError(self.supports_views)
77
class PathBasedViews(_Views):
78
"""View storage in an unversioned tree control file.
80
Views are stored in terms of paths relative to the tree root.
82
The top line of the control file is a format marker in the format:
86
where X is an integer number. After this top line, version 1 format is
89
* optional name-values pairs in the format 'name=value'
91
* optional view definitions, one per line in the format
97
where the fields are separated by a nul character (\0). The views file
98
is encoded in utf-8. The only supported keyword in version 1 is
99
'current' which stores the name of the current view, if any.
102
def __init__(self, tree):
108
def supports_views(self):
111
def get_view_info(self):
112
"""Get the current view and dictionary of views.
114
:return: current, views where
115
current = the name of the current view or None if no view is enabled
116
views = a map from view name to list of files/directories
118
self._load_view_info()
119
return self._current, self._views
121
def set_view_info(self, current, views):
122
"""Set the current view and dictionary of views.
124
:param current: the name of the current view or None if no view is
126
:param views: a map from view name to list of files/directories
128
if current is not None and current not in views:
129
raise NoSuchView(current)
130
self.tree.lock_write()
132
self._current = current
134
self._save_view_info()
138
def lookup_view(self, view_name=None):
139
"""Return the contents of a view.
141
:param view_Name: name of the view or None to lookup the current view
142
:return: the list of files/directories in the requested view
144
self._load_view_info()
146
if view_name is None:
148
view_name = self._current
151
return self._views[view_name]
153
raise NoSuchView(view_name)
155
def set_view(self, view_name, view_files, make_current=True):
156
"""Add or update a view definition.
158
:param view_name: the name of the view
159
:param view_files: the list of files/directories in the view
160
:param make_current: make this view the current one or not
162
self.tree.lock_write()
164
self._load_view_info()
165
self._views[view_name] = view_files
167
self._current = view_name
168
self._save_view_info()
172
def delete_view(self, view_name):
173
"""Delete a view definition.
175
If the view deleted is the current one, the current view is reset.
177
self.tree.lock_write()
179
self._load_view_info()
181
del self._views[view_name]
183
raise NoSuchView(view_name)
184
if view_name == self._current:
186
self._save_view_info()
190
def _save_view_info(self):
191
"""Save the current view and all view definitions.
193
Be sure to have initialised self._current and self._views before
196
self.tree.lock_write()
198
if self._current is None:
201
keywords = {'current': self._current}
202
self.tree._transport.put_bytes('views',
203
self._serialize_view_content(keywords, self._views))
207
def _load_view_info(self):
208
"""Load the current view and dictionary of view definitions."""
210
with self.tree.lock_read():
212
view_content = self.tree._transport.get_bytes('views')
213
except errors.NoSuchFile as e:
214
self._current, self._views = None, {}
216
keywords, self._views = \
217
self._deserialize_view_content(view_content)
218
self._current = keywords.get('current')
221
def _serialize_view_content(self, keywords, view_dict):
222
"""Convert view keywords and a view dictionary into a stream."""
223
lines = [_VIEWS_FORMAT1_MARKER]
225
line = "%s=%s\n" % (key, keywords[key])
226
lines.append(line.encode('utf-8'))
228
lines.append("views:\n".encode('utf-8'))
229
for view in sorted(view_dict):
230
view_data = "%s\0%s\n" % (view, "\0".join(view_dict[view]))
231
lines.append(view_data.encode('utf-8'))
232
return "".join(lines)
234
def _deserialize_view_content(self, view_content):
235
"""Convert a stream into view keywords and a dictionary of views."""
236
# as a special case to make initialization easy, an empty definition
237
# maps to no current view and an empty view dictionary
238
if view_content == '':
240
lines = view_content.splitlines()
241
match = _VIEWS_FORMAT_MARKER_RE.match(lines[0])
244
"format marker missing from top of views file")
245
elif match.group(1) != '1':
247
"cannot decode views format %s" % match.group(1))
252
for line in lines[1:]:
253
text = line.decode('utf-8')
255
parts = text.split('\0')
258
elif text == 'views:':
261
elif text.find('=') >= 0:
262
# must be a name-value pair
263
keyword, value = text.split('=', 1)
264
keywords[keyword] = value
266
raise ValueError("failed to deserialize views line %s",
268
return keywords, views
269
except ValueError as e:
270
raise ValueError("failed to deserialize views content %r: %s"
274
class DisabledViews(_Views):
275
"""View storage that refuses to store anything.
277
This is used by older formats that can't store views.
280
def __init__(self, tree):
283
def supports_views(self):
286
def _not_supported(self, *a, **k):
287
raise ViewsNotSupported(self.tree)
289
get_view_info = _not_supported
290
set_view_info = _not_supported
291
lookup_view = _not_supported
292
set_view = _not_supported
293
delete_view = _not_supported
296
def view_display_str(view_files, encoding=None):
297
"""Get the display string for a list of view files.
299
:param view_files: the list of file names
300
:param encoding: the encoding to display the files in
303
return ", ".join(view_files)
305
return ", ".join([v.encode(encoding, 'replace') for v in view_files])
308
def check_path_in_view(tree, relpath):
309
"""If a working tree has a view enabled, check the path is within it."""
310
if tree.supports_views():
311
view_files = tree.views.lookup_view()
312
if view_files and not osutils.is_inside_any(view_files, relpath):
313
raise FileOutsideView(relpath, view_files)
added
removed
breezy/views.py
