/usr/lib/python2.7/dist-packages/bzrlib/views.py is in python-bzrlib 2.7.0-2ubuntu3.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 | # Copyright (C) 2008 Canonical Ltd
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
"""View management.
Views are contained within a working tree and normally constructed
when first accessed. Clients should do, for example, ...
tree.views.lookup_view()
"""
from __future__ import absolute_import
import re
from bzrlib import (
errors,
osutils,
)
_VIEWS_FORMAT_MARKER_RE = re.compile(r'Bazaar views format (\d+)')
_VIEWS_FORMAT1_MARKER = "Bazaar views format 1\n"
class _Views(object):
"""Base class for View managers."""
def supports_views(self):
raise NotImplementedError(self.supports_views)
class PathBasedViews(_Views):
"""View storage in an unversioned tree control file.
Views are stored in terms of paths relative to the tree root.
The top line of the control file is a format marker in the format:
Bazaar views format X
where X is an integer number. After this top line, version 1 format is
stored as follows:
* optional name-values pairs in the format 'name=value'
* optional view definitions, one per line in the format
views:
name file1 file2 ...
name file1 file2 ...
where the fields are separated by a nul character (\0). The views file
is encoded in utf-8. The only supported keyword in version 1 is
'current' which stores the name of the current view, if any.
"""
def __init__(self, tree):
self.tree = tree
self._loaded = False
self._current = None
self._views = {}
def supports_views(self):
return True
def get_view_info(self):
"""Get the current view and dictionary of views.
:return: current, views where
current = the name of the current view or None if no view is enabled
views = a map from view name to list of files/directories
"""
self._load_view_info()
return self._current, self._views
def set_view_info(self, current, views):
"""Set the current view and dictionary of views.
:param current: the name of the current view or None if no view is
enabled
:param views: a map from view name to list of files/directories
"""
if current is not None and current not in views:
raise errors.NoSuchView(current)
self.tree.lock_write()
try:
self._current = current
self._views = views
self._save_view_info()
finally:
self.tree.unlock()
def lookup_view(self, view_name=None):
"""Return the contents of a view.
:param view_Name: name of the view or None to lookup the current view
:return: the list of files/directories in the requested view
"""
self._load_view_info()
try:
if view_name is None:
if self._current:
view_name = self._current
else:
return []
return self._views[view_name]
except KeyError:
raise errors.NoSuchView(view_name)
def set_view(self, view_name, view_files, make_current=True):
"""Add or update a view definition.
:param view_name: the name of the view
:param view_files: the list of files/directories in the view
:param make_current: make this view the current one or not
"""
self.tree.lock_write()
try:
self._load_view_info()
self._views[view_name] = view_files
if make_current:
self._current = view_name
self._save_view_info()
finally:
self.tree.unlock()
def delete_view(self, view_name):
"""Delete a view definition.
If the view deleted is the current one, the current view is reset.
"""
self.tree.lock_write()
try:
self._load_view_info()
try:
del self._views[view_name]
except KeyError:
raise errors.NoSuchView(view_name)
if view_name == self._current:
self._current = None
self._save_view_info()
finally:
self.tree.unlock()
def _save_view_info(self):
"""Save the current view and all view definitions.
Be sure to have initialised self._current and self._views before
calling this method.
"""
self.tree.lock_write()
try:
if self._current is None:
keywords = {}
else:
keywords = {'current': self._current}
self.tree._transport.put_bytes('views',
self._serialize_view_content(keywords, self._views))
finally:
self.tree.unlock()
def _load_view_info(self):
"""Load the current view and dictionary of view definitions."""
if not self._loaded:
self.tree.lock_read()
try:
try:
view_content = self.tree._transport.get_bytes('views')
except errors.NoSuchFile, e:
self._current, self._views = None, {}
else:
keywords, self._views = \
self._deserialize_view_content(view_content)
self._current = keywords.get('current')
finally:
self.tree.unlock()
self._loaded = True
def _serialize_view_content(self, keywords, view_dict):
"""Convert view keywords and a view dictionary into a stream."""
lines = [_VIEWS_FORMAT1_MARKER]
for key in keywords:
line = "%s=%s\n" % (key,keywords[key])
lines.append(line.encode('utf-8'))
if view_dict:
lines.append("views:\n".encode('utf-8'))
for view in sorted(view_dict):
view_data = "%s\0%s\n" % (view, "\0".join(view_dict[view]))
lines.append(view_data.encode('utf-8'))
return "".join(lines)
def _deserialize_view_content(self, view_content):
"""Convert a stream into view keywords and a dictionary of views."""
# as a special case to make initialization easy, an empty definition
# maps to no current view and an empty view dictionary
if view_content == '':
return {}, {}
lines = view_content.splitlines()
match = _VIEWS_FORMAT_MARKER_RE.match(lines[0])
if not match:
raise ValueError(
"format marker missing from top of views file")
elif match.group(1) != '1':
raise ValueError(
"cannot decode views format %s" % match.group(1))
try:
keywords = {}
views = {}
in_views = False
for line in lines[1:]:
text = line.decode('utf-8')
if in_views:
parts = text.split('\0')
view = parts.pop(0)
views[view] = parts
elif text == 'views:':
in_views = True
continue
elif text.find('=') >= 0:
# must be a name-value pair
keyword, value = text.split('=', 1)
keywords[keyword] = value
else:
raise ValueError("failed to deserialize views line %s",
text)
return keywords, views
except ValueError, e:
raise ValueError("failed to deserialize views content %r: %s"
% (view_content, e))
class DisabledViews(_Views):
"""View storage that refuses to store anything.
This is used by older formats that can't store views.
"""
def __init__(self, tree):
self.tree = tree
def supports_views(self):
return False
def _not_supported(self, *a, **k):
raise errors.ViewsNotSupported(self.tree)
get_view_info = _not_supported
set_view_info = _not_supported
lookup_view = _not_supported
set_view = _not_supported
delete_view = _not_supported
def view_display_str(view_files, encoding=None):
"""Get the display string for a list of view files.
:param view_files: the list of file names
:param encoding: the encoding to display the files in
"""
if encoding is None:
return ", ".join(view_files)
else:
return ", ".join([v.encode(encoding, 'replace') for v in view_files])
def check_path_in_view(tree, relpath):
"""If a working tree has a view enabled, check the path is within it."""
if tree.supports_views():
view_files = tree.views.lookup_view()
if view_files and not osutils.is_inside_any(view_files, relpath):
raise errors.FileOutsideView(relpath, view_files)
|