1
# Copyright (C) 2005-2011 Canonical Ltd
1
# Copyright (C) 2005 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
17
"""WorkingTree object and friends.
19
19
A WorkingTree represents the editable working copy of a branch.
20
Operations which represent the WorkingTree are also done here,
21
such as renaming or adding files.
20
Operations which represent the WorkingTree are also done here,
21
such as renaming or adding files. The WorkingTree has an inventory
22
which is updated by these operations. A commit produces a
23
new revision based on the workingtree and its inventory.
23
25
At the moment every WorkingTree has its own branch. Remote
24
26
WorkingTrees aren't supported.
26
To get a WorkingTree, call controldir.open_workingtree() or
27
WorkingTree.open(dir).
28
To get a WorkingTree, call Branch.working_tree():
32
# TODO: Don't allow WorkingTrees to be constructed for remote branches if
35
# FIXME: I don't know if writing out the cache from the destructor is really a
36
# good idea, because destructors are considered poor taste in Python, and it's
37
# not predictable when it will be written out.
39
# TODO: Give the workingtree sole responsibility for the working inventory;
40
# remove the variable and references to it from the branch. This may require
41
# updating the commit code so as to update the inventory within the working
42
# copy, and making sure there's only one WorkingTree for any directory on disk.
43
# At the momenthey may alias the inventory and have old copies of it in memory.
45
from copy import deepcopy
37
from .lazy_import import lazy_import
38
lazy_import(globals(), """
43
conflicts as _mod_conflicts,
44
filters as _mod_filters,
46
revision as _mod_revision,
51
from breezy.bzr import (
59
from .controldir import (
61
ControlComponentFormatRegistry,
62
ControlComponentFormat,
69
from .i18n import gettext
70
from . import mutabletree
71
from .symbol_versioning import deprecated_method, deprecated_in
72
from .trace import mutter, note
75
class SettingFileIdUnsupported(errors.BzrError):
77
_fmt = "This format does not support setting file ids."
80
class ShelvingUnsupported(errors.BzrError):
82
_fmt = "This format does not support shelving changes."
85
class WorkingTree(mutabletree.MutableTree, ControlComponent):
50
from bzrlib.branch import (Branch,
55
from bzrlib.errors import (BzrCheckError,
58
WeaveRevisionNotPresent,
61
from bzrlib.inventory import InventoryEntry
62
from bzrlib.osutils import (appendpath,
72
from bzrlib.textui import show_status
74
from bzrlib.trace import mutter
78
def gen_file_id(name):
79
"""Return new file id.
81
This should probably generate proper UUIDs, but for the moment we
82
cope with just randomness because running uuidgen every time is
85
from binascii import hexlify
92
idx = name.rfind('\\')
96
# make it not a hidden file
97
name = name.lstrip('.')
99
# remove any wierd characters; we don't escape them but rather
101
name = re.sub(r'[^\w.]', '', name)
103
s = hexlify(rand_bytes(8))
104
return '-'.join((name, compact_date(time()), s))
108
"""Return a new tree-root file id."""
109
return gen_file_id('TREE_ROOT')
112
class TreeEntry(object):
113
"""An entry that implements the minium interface used by commands.
115
This needs further inspection, it may be better to have
116
InventoryEntries without ids - though that seems wrong. For now,
117
this is a parallel hierarchy to InventoryEntry, and needs to become
118
one of several things: decorates to that hierarchy, children of, or
120
Another note is that these objects are currently only used when there is
121
no InventoryEntry available - i.e. for unversioned objects.
122
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
125
def __eq__(self, other):
126
# yes, this us ugly, TODO: best practice __eq__ style.
127
return (isinstance(other, TreeEntry)
128
and other.__class__ == self.__class__)
130
def kind_character(self):
134
class TreeDirectory(TreeEntry):
135
"""See TreeEntry. This is a directory in a working tree."""
137
def __eq__(self, other):
138
return (isinstance(other, TreeDirectory)
139
and other.__class__ == self.__class__)
141
def kind_character(self):
145
class TreeFile(TreeEntry):
146
"""See TreeEntry. This is a regular file in a working tree."""
148
def __eq__(self, other):
149
return (isinstance(other, TreeFile)
150
and other.__class__ == self.__class__)
152
def kind_character(self):
156
class TreeLink(TreeEntry):
157
"""See TreeEntry. This is a symlink in a working tree."""
159
def __eq__(self, other):
160
return (isinstance(other, TreeLink)
161
and other.__class__ == self.__class__)
163
def kind_character(self):
167
class WorkingTree(bzrlib.tree.Tree):
86
168
"""Working copy tree.
88
:ivar basedir: The root of the tree on disk. This is a unicode path object
89
(as opposed to a URL).
170
The inventory is held in the `Branch` working-inventory, and the
171
files are in a directory on disk.
173
It is possible for a `WorkingTree` to have a filename which is
174
not listed in the Inventory and vice versa.
92
# override this to set the strategy for storing views
93
def _make_views(self):
94
return views.DisabledViews(self)
96
def __init__(self, basedir='.',
102
"""Construct a WorkingTree instance. This is not a public API.
104
:param branch: A branch to override probing for the branch.
106
self._format = _format
107
self.controldir = _controldir
109
raise errors.BzrError("Please use controldir.open_workingtree or "
110
"WorkingTree.open() to obtain a WorkingTree.")
111
basedir = osutils.safe_unicode(basedir)
112
mutter("opening working tree %r", basedir)
113
if branch is not None:
114
self._branch = branch
116
self._branch = self.controldir.open_branch()
117
self.basedir = osutils.realpath(basedir)
118
self._transport = _transport
119
self._rules_searcher = None
120
self.views = self._make_views()
123
def user_transport(self):
124
return self.controldir.user_transport
127
def control_transport(self):
128
return self._transport
130
def supports_symlinks(self):
131
return osutils.supports_symlinks(self.basedir)
133
def is_control_filename(self, filename):
134
"""True if filename is the name of a control file in this tree.
136
:param filename: A filename within the tree. This is a relative path
137
from the root of this tree.
139
This is true IF and ONLY IF the filename is part of the meta data
140
that bzr controls in this tree. I.E. a random .bzr directory placed
141
on disk will not be a control file for this tree.
143
return self.controldir.is_control_filename(filename)
146
fget=lambda self: self._branch,
147
doc="""The branch this WorkingTree is connected to.
149
This cannot be set - it is reflective of the actual disk structure
150
the working tree has been constructed from.
153
def has_versioned_directories(self):
154
"""See `Tree.has_versioned_directories`."""
155
return self._format.supports_versioned_directories
157
def supports_merge_modified(self):
158
"""Indicate whether this workingtree supports storing merge_modified.
160
return self._format.supports_merge_modified
162
def _supports_executable(self):
163
return osutils.supports_executable(self.basedir)
165
def break_lock(self):
166
"""Break a lock if one is present from another instance.
168
Uses the ui factory to ask for confirmation if the lock may be from
171
This will probe the repository for its lock as well.
173
raise NotImplementedError(self.break_lock)
175
def requires_rich_root(self):
176
return self._format.requires_rich_root
178
def supports_tree_reference(self):
181
def supports_content_filtering(self):
182
return self._format.supports_content_filtering()
184
def supports_views(self):
185
return self.views.supports_views()
187
def supports_setting_file_ids(self):
188
return self._format.supports_setting_file_ids
190
def get_config_stack(self):
191
"""Retrieve the config stack for this tree.
193
:return: A ``breezy.config.Stack``
195
# For the moment, just provide the branch config stack.
196
return self.branch.get_config_stack()
199
def open(path=None, _unsupported=False):
200
"""Open an existing working tree at path.
204
path = osutils.getcwd()
205
control = ControlDir.open(path, _unsupported=_unsupported)
206
return control.open_workingtree(unsupported=_unsupported)
177
def __init__(self, basedir=u'.', branch=None):
178
"""Construct a WorkingTree for basedir.
180
If the branch is not supplied, it is opened automatically.
181
If the branch is supplied, it must be the branch for this basedir.
182
(branch.base is not cross checked, because for remote branches that
183
would be meaningless).
185
from bzrlib.hashcache import HashCache
186
from bzrlib.trace import note, mutter
187
assert isinstance(basedir, basestring), \
188
"base directory %r is not a string" % basedir
190
branch = Branch.open(basedir)
191
assert isinstance(branch, Branch), \
192
"branch %r is not a Branch" % branch
194
self.basedir = realpath(basedir)
196
self._set_inventory(self.read_working_inventory())
198
# update the whole cache up front and write to disk if anything changed;
199
# in the future we might want to do this more selectively
200
# two possible ways offer themselves : in self._unlock, write the cache
201
# if needed, or, when the cache sees a change, append it to the hash
202
# cache file, and have the parser take the most recent entry for a
204
hc = self._hashcache = HashCache(basedir)
212
def _set_inventory(self, inv):
213
self._inventory = inv
214
self.path2id = self._inventory.path2id
209
217
def open_containing(path=None):
210
218
"""Open an existing working tree which has its root about path.
212
220
This probes for a working tree at path and searches upwards from there.
214
222
Basically we keep looking up until we find the control directory or
215
223
run into /. If there isn't one, raises NotBranchError.
216
224
TODO: give this a new exception.
217
225
If there is one, it is returned, along with the unused portion of path.
219
:return: The WorkingTree that contains 'path', and the rest of path
222
path = osutils.getcwd()
223
control, relpath = ControlDir.open_containing(path)
224
return control.open_workingtree(), relpath
227
def open_containing_paths(file_list, default_directory=None,
228
canonicalize=True, apply_view=True):
229
"""Open the WorkingTree that contains a set of paths.
231
Fail if the paths given are not all in a single tree.
233
This is used for the many command-line interfaces that take a list of
234
any number of files and that require they all be in the same tree.
236
if default_directory is None:
237
default_directory = u'.'
238
# recommended replacement for builtins.internal_tree_files
239
if file_list is None or len(file_list) == 0:
240
tree = WorkingTree.open_containing(default_directory)[0]
241
# XXX: doesn't really belong here, and seems to have the strange
242
# side effect of making it return a bunch of files, not the whole
243
# tree -- mbp 20100716
244
if tree.supports_views() and apply_view:
245
view_files = tree.views.lookup_view()
247
file_list = view_files
248
view_str = views.view_display_str(view_files)
249
note(gettext("Ignoring files outside view. View is %s") % view_str)
250
return tree, file_list
251
if default_directory == u'.':
254
seed = default_directory
255
file_list = [osutils.pathjoin(default_directory, f)
257
tree = WorkingTree.open_containing(seed)[0]
258
return tree, tree.safe_relpath_files(file_list, canonicalize,
259
apply_view=apply_view)
261
def safe_relpath_files(self, file_list, canonicalize=True, apply_view=True):
262
"""Convert file_list into a list of relpaths in tree.
264
:param self: A tree to operate on.
265
:param file_list: A list of user provided paths or None.
266
:param apply_view: if True and a view is set, apply it or check that
267
specified files are within it
268
:return: A list of relative paths.
269
:raises errors.PathNotChild: When a provided path is in a different self
272
if file_list is None:
274
if self.supports_views() and apply_view:
275
view_files = self.views.lookup_view()
279
# self.relpath exists as a "thunk" to osutils, but canonical_relpath
280
# doesn't - fix that up here before we enter the loop.
283
return osutils.canonical_relpath(self.basedir, p)
286
for filename in file_list:
287
relpath = fixer(osutils.dereference_path(filename))
288
if view_files and not osutils.is_inside_any(view_files, relpath):
289
raise views.FileOutsideView(filename, view_files)
290
new_list.append(relpath)
294
def open_downlevel(path=None):
295
"""Open an unsupported working tree.
297
Only intended for advanced situations like upgrading part of a controldir.
299
return WorkingTree.open(path, _unsupported=True)
231
if path.find('://') != -1:
232
raise NotBranchError(path=path)
233
path = os.path.abspath(path)
237
return WorkingTree(path), tail
238
except NotBranchError:
241
tail = os.path.join(os.path.basename(path), tail)
243
tail = os.path.basename(path)
244
path = os.path.dirname(path)
245
# FIXME: top in windows is indicated how ???
246
if path == os.path.sep:
247
# reached the root, whatever that may be
248
raise NotBranchError(path=path)
251
"""Iterate through file_ids for this tree.
253
file_ids are in a WorkingTree if they are in the working inventory
254
and the working file exists.
256
inv = self._inventory
257
for path, ie in inv.iter_entries():
258
if bzrlib.osutils.lexists(self.abspath(path)):
301
261
def __repr__(self):
302
262
return "<%s of %s>" % (self.__class__.__name__,
303
263
getattr(self, 'basedir', None))
305
265
def abspath(self, filename):
306
return osutils.pathjoin(self.basedir, filename)
308
def basis_tree(self):
309
"""Return RevisionTree for the current last revision.
311
If the left most parent is a ghost then the returned tree will be an
312
empty tree - one obtained by calling
313
repository.revision_tree(NULL_REVISION).
316
revision_id = self.get_parent_ids()[0]
318
# no parents, return an empty revision tree.
319
# in the future this should return the tree for
320
# 'empty:' - the implicit root empty tree.
321
return self.branch.repository.revision_tree(
322
_mod_revision.NULL_REVISION)
324
return self.revision_tree(revision_id)
325
except errors.NoSuchRevision:
327
# No cached copy available, retrieve from the repository.
328
# FIXME? RBC 20060403 should we cache the tree locally
331
return self.branch.repository.revision_tree(revision_id)
332
except (errors.RevisionNotPresent, errors.NoSuchRevision):
333
# the basis tree *may* be a ghost or a low level error may have
334
# occurred. If the revision is present, its a problem, if its not
336
if self.branch.repository.has_revision(revision_id):
338
# the basis tree is a ghost so return an empty tree.
339
return self.branch.repository.revision_tree(
340
_mod_revision.NULL_REVISION)
342
def relpath(self, path):
343
"""Return the local path portion from a given path.
345
The path may be absolute or relative. If its a relative path it is
346
interpreted relative to the python current working directory.
348
return osutils.relpath(self.basedir, path)
266
return os.path.join(self.basedir, filename)
268
def relpath(self, abspath):
269
"""Return the local path portion from a given absolute path."""
270
return relpath(self.basedir, abspath)
350
272
def has_filename(self, filename):
351
return osutils.lexists(self.abspath(filename))
353
def get_file(self, path, filtered=True):
354
return self.get_file_with_stat(path, filtered=filtered)[0]
356
def get_file_with_stat(self, path, filtered=True,
357
_fstat=osutils.fstat):
358
"""See Tree.get_file_with_stat."""
359
abspath = self.abspath(path)
361
file_obj = open(abspath, 'rb')
362
except EnvironmentError as e:
363
if e.errno == errno.ENOENT:
364
raise errors.NoSuchFile(path)
366
stat_value = _fstat(file_obj.fileno())
367
if filtered and self.supports_content_filtering():
368
filters = self._content_filter_stack(path)
370
file_obj, size = _mod_filters.filtered_input_file(
372
stat_value = _mod_filters.FilteredStat(
373
stat_value, st_size=size)
374
return (file_obj, stat_value)
376
def get_file_text(self, path, filtered=True):
377
with self.get_file(path, filtered=filtered) as my_file:
378
return my_file.read()
380
def get_file_lines(self, path, filtered=True):
381
"""See Tree.get_file_lines()"""
382
with self.get_file(path, filtered=filtered) as file:
383
return file.readlines()
385
def get_parent_ids(self):
386
"""See Tree.get_parent_ids.
388
This implementation reads the pending merges list and last_revision
389
value and uses that to decide what the parents list should be.
391
last_rev = _mod_revision.ensure_null(self._last_revision())
392
if _mod_revision.NULL_REVISION == last_rev:
397
merges_bytes = self._transport.get_bytes('pending-merges')
398
except errors.NoSuchFile:
401
for l in osutils.split_lines(merges_bytes):
402
revision_id = l.rstrip(b'\n')
403
parents.append(revision_id)
406
def clone(self, to_controldir, revision_id=None):
407
"""Duplicate this working tree into to_bzr, including all state.
409
Specifically modified files are kept as modified, but
410
ignored and unknown files are discarded.
412
If you want to make a new line of development, see ControlDir.sprout()
415
If not None, the cloned tree will have its last revision set to
416
revision, and difference between the source trees last revision
417
and this one merged in.
419
with self.lock_read():
420
# assumes the target bzr dir format is compatible.
421
result = to_controldir.create_workingtree()
422
self.copy_content_into(result, revision_id)
425
def copy_content_into(self, tree, revision_id=None):
426
"""Copy the current content and user files of this tree into tree."""
427
with self.lock_read():
428
tree.set_root_id(self.path2id(''))
429
if revision_id is None:
430
merge.transform_tree(tree, self)
432
# TODO now merge from tree.last_revision to revision (to
433
# preserve user local changes)
435
other_tree = self.revision_tree(revision_id)
436
except errors.NoSuchRevision:
437
other_tree = self.branch.repository.revision_tree(
440
merge.transform_tree(tree, other_tree)
441
if revision_id == _mod_revision.NULL_REVISION:
444
new_parents = [revision_id]
445
tree.set_parent_ids(new_parents)
447
def get_file_size(self, path):
448
"""See Tree.get_file_size"""
449
# XXX: this returns the on-disk size; it should probably return the
452
return os.path.getsize(self.abspath(path))
454
if e.errno != errno.ENOENT:
459
def _gather_kinds(self, files, kinds):
460
"""See MutableTree._gather_kinds."""
461
with self.lock_tree_write():
462
for pos, f in enumerate(files):
463
if kinds[pos] is None:
464
fullpath = osutils.normpath(self.abspath(f))
466
kinds[pos] = osutils.file_kind(fullpath)
468
if e.errno == errno.ENOENT:
469
raise errors.NoSuchFile(fullpath)
471
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
472
"""Add revision_id as a parent.
474
This is equivalent to retrieving the current list of parent ids
475
and setting the list to its value plus revision_id.
477
:param revision_id: The revision id to add to the parent list. It may
478
be a ghost revision as long as its not the first parent to be
479
added, or the allow_leftmost_as_ghost parameter is set True.
480
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
482
with self.lock_write():
483
parents = self.get_parent_ids() + [revision_id]
484
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
485
or allow_leftmost_as_ghost)
487
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
488
"""Add revision_id, tree tuple as a parent.
490
This is equivalent to retrieving the current list of parent trees
491
and setting the list to its value plus parent_tuple. See also
492
add_parent_tree_id - if you only have a parent id available it will be
493
simpler to use that api. If you have the parent already available, using
494
this api is preferred.
496
:param parent_tuple: The (revision id, tree) to add to the parent list.
497
If the revision_id is a ghost, pass None for the tree.
498
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
500
with self.lock_tree_write():
501
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
502
if len(parent_ids) > 1:
503
# the leftmost may have already been a ghost, preserve that if it
505
allow_leftmost_as_ghost = True
506
self.set_parent_ids(parent_ids,
507
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
273
return bzrlib.osutils.lexists(self.abspath(filename))
275
def get_file(self, file_id):
276
return self.get_file_byname(self.id2path(file_id))
278
def get_file_byname(self, filename):
279
return file(self.abspath(filename), 'rb')
281
def get_root_id(self):
282
"""Return the id of this trees root"""
283
inv = self.read_working_inventory()
284
return inv.root.file_id
286
def _get_store_filename(self, file_id):
287
## XXX: badly named; this is not in the store at all
288
return self.abspath(self.id2path(file_id))
291
def commit(self, *args, **kw):
292
from bzrlib.commit import Commit
293
Commit().commit(self.branch, *args, **kw)
294
self._set_inventory(self.read_working_inventory())
296
def id2abspath(self, file_id):
297
return self.abspath(self.id2path(file_id))
299
def has_id(self, file_id):
300
# files that have been deleted are excluded
301
inv = self._inventory
302
if not inv.has_id(file_id):
304
path = inv.id2path(file_id)
305
return bzrlib.osutils.lexists(self.abspath(path))
307
def has_or_had_id(self, file_id):
308
if file_id == self.inventory.root.file_id:
310
return self.inventory.has_id(file_id)
312
__contains__ = has_id
314
def get_file_size(self, file_id):
315
return os.path.getsize(self.id2abspath(file_id))
317
def get_file_sha1(self, file_id):
318
path = self._inventory.id2path(file_id)
319
return self._hashcache.get_sha1(path)
321
def is_executable(self, file_id):
323
return self._inventory[file_id].executable
325
path = self._inventory.id2path(file_id)
326
mode = os.lstat(self.abspath(path)).st_mode
327
return bool(stat.S_ISREG(mode) and stat.S_IEXEC&mode)
330
def add(self, files, ids=None):
331
"""Make files versioned.
333
Note that the command line normally calls smart_add instead,
334
which can automatically recurse.
336
This adds the files to the inventory, so that they will be
337
recorded by the next commit.
340
List of paths to add, relative to the base of the tree.
343
If set, use these instead of automatically generated ids.
344
Must be the same length as the list of files, but may
345
contain None for ids that are to be autogenerated.
347
TODO: Perhaps have an option to add the ids even if the files do
350
TODO: Perhaps callback with the ids and paths as they're added.
352
# TODO: Re-adding a file that is removed in the working copy
353
# should probably put it back with the previous ID.
354
if isinstance(files, basestring):
355
assert(ids is None or isinstance(ids, basestring))
361
ids = [None] * len(files)
363
assert(len(ids) == len(files))
365
inv = self.read_working_inventory()
366
for f,file_id in zip(files, ids):
367
if is_control_file(f):
368
raise BzrError("cannot add control file %s" % quotefn(f))
373
raise BzrError("cannot add top-level %r" % f)
375
fullpath = os.path.normpath(self.abspath(f))
378
kind = file_kind(fullpath)
380
# maybe something better?
381
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
383
if not InventoryEntry.versionable_kind(kind):
384
raise BzrError('cannot add: not a versionable file ('
385
'i.e. regular file, symlink or directory): %s' % quotefn(f))
388
file_id = gen_file_id(f)
389
inv.add_path(f, kind=kind, file_id=file_id)
391
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
392
self._write_inventory(inv)
509
395
def add_pending_merge(self, *revision_ids):
510
with self.lock_tree_write():
511
# TODO: Perhaps should check at this point that the
512
# history of the revision is actually present?
513
parents = self.get_parent_ids()
515
for rev_id in revision_ids:
516
if rev_id in parents:
518
parents.append(rev_id)
521
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
523
def path_content_summary(self, path, _lstat=os.lstat,
524
_mapper=osutils.file_kind_from_stat_mode):
525
"""See Tree.path_content_summary."""
526
abspath = self.abspath(path)
528
stat_result = _lstat(abspath)
530
if getattr(e, 'errno', None) == errno.ENOENT:
532
return ('missing', None, None, None)
533
# propagate other errors
535
kind = _mapper(stat_result.st_mode)
537
return self._file_content_summary(path, stat_result)
538
elif kind == 'directory':
539
# perhaps it looks like a plain directory, but it's really a
541
if self._directory_is_tree_reference(path):
542
kind = 'tree-reference'
543
return kind, None, None, None
544
elif kind == 'symlink':
545
target = osutils.readlink(abspath)
546
return ('symlink', None, None, target)
548
return (kind, None, None, None)
550
def _file_content_summary(self, path, stat_result):
551
size = stat_result.st_size
552
executable = self._is_executable_from_path_and_stat(path, stat_result)
553
# try for a stat cache lookup
554
return ('file', size, executable, self._sha_from_stat(
557
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
558
"""Common ghost checking functionality from set_parent_*.
560
This checks that the left hand-parent exists if there are any
563
if len(revision_ids) > 0:
564
leftmost_id = revision_ids[0]
565
if (not allow_leftmost_as_ghost and not
566
self.branch.repository.has_revision(leftmost_id)):
567
raise errors.GhostRevisionUnusableHere(leftmost_id)
569
def _set_merges_from_parent_ids(self, parent_ids):
570
merges = parent_ids[1:]
571
self._transport.put_bytes('pending-merges', b'\n'.join(merges),
572
mode=self.controldir._get_file_mode())
574
def _filter_parent_ids_by_ancestry(self, revision_ids):
575
"""Check that all merged revisions are proper 'heads'.
577
This will always return the first revision_id, and any merged revisions
580
if len(revision_ids) == 0:
582
graph = self.branch.repository.get_graph()
583
heads = graph.heads(revision_ids)
584
new_revision_ids = revision_ids[:1]
585
for revision_id in revision_ids[1:]:
586
if revision_id in heads and revision_id not in new_revision_ids:
587
new_revision_ids.append(revision_id)
588
if new_revision_ids != revision_ids:
589
mutter('requested to set revision_ids = %s,'
590
' but filtered to %s', revision_ids, new_revision_ids)
591
return new_revision_ids
593
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
594
"""Set the parent ids to revision_ids.
596
See also set_parent_trees. This api will try to retrieve the tree data
597
for each element of revision_ids from the trees repository. If you have
598
tree data already available, it is more efficient to use
599
set_parent_trees rather than set_parent_ids. set_parent_ids is however
600
an easier API to use.
602
:param revision_ids: The revision_ids to set as the parent ids of this
603
working tree. Any of these may be ghosts.
605
with self.lock_tree_write():
606
self._check_parents_for_ghosts(revision_ids,
607
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
608
for revision_id in revision_ids:
609
_mod_revision.check_not_reserved_id(revision_id)
611
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
613
if len(revision_ids) > 0:
614
self.set_last_revision(revision_ids[0])
616
self.set_last_revision(_mod_revision.NULL_REVISION)
618
self._set_merges_from_parent_ids(revision_ids)
396
# TODO: Perhaps should check at this point that the
397
# history of the revision is actually present?
398
p = self.pending_merges()
400
for rev_id in revision_ids:
406
self.set_pending_merges(p)
408
def pending_merges(self):
409
"""Return a list of pending merges.
411
These are revisions that have been merged into the working
412
directory but not yet committed.
414
cfn = self.branch._rel_controlfilename('pending-merges')
415
if not self.branch._transport.has(cfn):
418
for l in self.branch.controlfile('pending-merges', 'r').readlines():
419
p.append(l.rstrip('\n'))
620
423
def set_pending_merges(self, rev_list):
621
with self.lock_tree_write():
622
parents = self.get_parent_ids()
623
leftmost = parents[:1]
624
new_parents = leftmost + rev_list
625
self.set_parent_ids(new_parents)
627
def set_merge_modified(self, modified_hashes):
628
"""Set the merge modified hashes."""
629
raise NotImplementedError(self.set_merge_modified)
631
def _sha_from_stat(self, path, stat_result):
632
"""Get a sha digest from the tree's stat cache.
634
The default implementation assumes no stat cache is present.
636
:param path: The path.
637
:param stat_result: The stat result being looked up.
641
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
642
merge_type=None, force=False):
643
"""Merge from a branch into this working tree.
645
:param branch: The branch to merge from.
646
:param to_revision: If non-None, the merge will merge to to_revision,
647
but not beyond it. to_revision does not need to be in the history
648
of the branch when it is supplied. If None, to_revision defaults to
649
branch.last_revision().
651
from .merge import Merger, Merge3Merger
652
with self.lock_write():
653
merger = Merger(self.branch, this_tree=self)
654
# check that there are no local alterations
655
if not force and self.has_changes():
656
raise errors.UncommittedChanges(self)
657
if to_revision is None:
658
to_revision = _mod_revision.ensure_null(branch.last_revision())
659
merger.other_rev_id = to_revision
660
if _mod_revision.is_null(merger.other_rev_id):
661
raise errors.NoCommits(branch)
662
self.branch.fetch(branch, stop_revision=merger.other_rev_id)
663
merger.other_basis = merger.other_rev_id
664
merger.other_tree = self.branch.repository.revision_tree(
666
merger.other_branch = branch
667
if from_revision is None:
670
merger.set_base_revision(from_revision, branch)
671
if merger.base_rev_id == merger.other_rev_id:
672
raise errors.PointlessMerge
673
merger.backup_files = False
674
if merge_type is None:
675
merger.merge_type = Merge3Merger
677
merger.merge_type = merge_type
678
merger.set_interesting_files(None)
679
merger.show_base = False
680
merger.reprocess = False
681
conflicts = merger.do_merge()
685
def merge_modified(self):
686
"""Return a dictionary of files modified by a merge.
688
The list is initialized by WorkingTree.set_merge_modified, which is
689
typically called after we make some automatic updates to the tree
692
This returns a map of file_id->sha1, containing only files which are
693
still in the working tree and have that text hash.
695
raise NotImplementedError(self.merge_modified)
697
def mkdir(self, path, file_id=None):
698
"""See MutableTree.mkdir()."""
700
if self.supports_setting_file_ids():
701
file_id = generate_ids.gen_file_id(os.path.basename(path))
424
self.branch.put_controlfile('pending-merges', '\n'.join(rev_list))
426
def get_symlink_target(self, file_id):
427
return os.readlink(self.id2abspath(file_id))
429
def file_class(self, filename):
430
if self.path2id(filename):
432
elif self.is_ignored(filename):
703
if not self.supports_setting_file_ids():
704
raise SettingFileIdUnsupported()
705
with self.lock_write():
706
os.mkdir(self.abspath(path))
707
self.add(path, file_id, 'directory')
710
def get_symlink_target(self, path):
711
abspath = self.abspath(path)
712
target = osutils.readlink(abspath)
715
def subsume(self, other_tree):
716
raise NotImplementedError(self.subsume)
718
def _directory_is_tree_reference(self, relpath):
719
raise NotImplementedError(self._directory_is_tree_reference)
721
def extract(self, path, format=None):
722
"""Extract a subtree from this tree.
724
A new branch will be created, relative to the path for this tree.
726
raise NotImplementedError(self.extract)
729
"""Write the in memory meta data to disk."""
730
raise NotImplementedError(self.flush)
732
def kind(self, relpath):
733
return osutils.file_kind(self.abspath(relpath))
735
def list_files(self, include_root=False, from_dir=None, recursive=True,
736
recurse_nested=False):
737
"""List all files as (path, class, kind, id, entry).
438
def list_files(self):
439
"""Recursively list all files as (path, class, kind, id).
739
441
Lists, but does not descend into unversioned directories.
740
443
This does not include files that have been deleted in this
741
tree. Skips the control directory.
743
:param include_root: if True, return an entry for the root
744
:param from_dir: start from this directory or None for the root
745
:param recursive: whether to recurse into subdirectories or not
446
Skips the control directory.
747
raise NotImplementedError(self.list_files)
749
def move(self, from_paths, to_dir=None, after=False):
448
inv = self._inventory
450
def descend(from_dir_relpath, from_dir_id, dp):
454
## TODO: If we find a subdirectory with its own .bzr
455
## directory, then that is a separate tree and we
456
## should exclude it.
457
if bzrlib.BZRDIR == f:
461
fp = appendpath(from_dir_relpath, f)
464
fap = appendpath(dp, f)
466
f_ie = inv.get_child(from_dir_id, f)
469
elif self.is_ignored(fp):
478
raise BzrCheckError("file %r entered as kind %r id %r, "
480
% (fap, f_ie.kind, f_ie.file_id, fk))
482
# make a last minute entry
486
if fk == 'directory':
487
entry = TreeDirectory()
490
elif fk == 'symlink':
495
yield fp, c, fk, (f_ie and f_ie.file_id), entry
497
if fk != 'directory':
501
# don't descend unversioned directories
504
for ff in descend(fp, f_ie.file_id, fap):
507
for f in descend(u'', inv.root.file_id, self.basedir):
511
def move(self, from_paths, to_name):
752
to_dir must be known to the working tree.
754
If to_dir exists and is a directory, the files are moved into
755
it, keeping their old names.
757
Note that to_dir is only the last component of the new name;
514
to_name must exist in the inventory.
516
If to_name exists and is a directory, the files are moved into
517
it, keeping their old names.
519
Note that to_name is only the last component of the new name;
758
520
this doesn't change the directory.
760
For each entry in from_paths the move mode will be determined
763
The first mode moves the file in the filesystem and updates the
764
working tree metadata. The second mode only updates the working tree
765
metadata without touching the file on the filesystem.
767
move uses the second mode if 'after == True' and the target is not
768
versioned but present in the working tree.
770
move uses the second mode if 'after == False' and the source is
771
versioned but no longer in the working tree, and the target is not
772
versioned but present in the working tree.
774
move uses the first mode if 'after == False' and the source is
775
versioned and present in the working tree, and the target is not
776
versioned and not present in the working tree.
778
Everything else results in an error.
780
522
This returns a list of (from_path, to_path) pairs for each
781
523
entry that is moved.
783
raise NotImplementedError(self.move)
785
def copy_one(self, from_rel, to_rel):
786
"""Copy a file in the tree to a new location.
788
This default implementation just copies the file, then
791
:param from_rel: From location (relative to tree root)
792
:param to_rel: Target location (relative to tree root)
526
## TODO: Option to move IDs only
527
assert not isinstance(from_paths, basestring)
529
to_abs = self.abspath(to_name)
530
if not isdir(to_abs):
531
raise BzrError("destination %r is not a directory" % to_abs)
532
if not self.has_filename(to_name):
533
raise BzrError("destination %r not in working directory" % to_abs)
534
to_dir_id = inv.path2id(to_name)
535
if to_dir_id == None and to_name != '':
536
raise BzrError("destination %r is not a versioned directory" % to_name)
537
to_dir_ie = inv[to_dir_id]
538
if to_dir_ie.kind not in ('directory', 'root_directory'):
539
raise BzrError("destination %r is not a directory" % to_abs)
541
to_idpath = inv.get_idpath(to_dir_id)
544
if not self.has_filename(f):
545
raise BzrError("%r does not exist in working tree" % f)
546
f_id = inv.path2id(f)
548
raise BzrError("%r is not versioned" % f)
549
name_tail = splitpath(f)[-1]
550
dest_path = appendpath(to_name, name_tail)
551
if self.has_filename(dest_path):
552
raise BzrError("destination %r already exists" % dest_path)
553
if f_id in to_idpath:
554
raise BzrError("can't move %r to a subdirectory of itself" % f)
556
# OK, so there's a race here, it's possible that someone will
557
# create a file in this interval and then the rename might be
558
# left half-done. But we should have caught most problems.
559
orig_inv = deepcopy(self.inventory)
562
name_tail = splitpath(f)[-1]
563
dest_path = appendpath(to_name, name_tail)
564
result.append((f, dest_path))
565
inv.rename(inv.path2id(f), to_dir_id, name_tail)
567
rename(self.abspath(f), self.abspath(dest_path))
569
raise BzrError("failed to rename %r to %r: %s" %
570
(f, dest_path, e[1]),
571
["rename rolled back"])
573
# restore the inventory on error
574
self._set_inventory(orig_inv)
576
self._write_inventory(inv)
580
def rename_one(self, from_rel, to_rel):
583
This can change the directory or the filename or both.
794
shutil.copyfile(self.abspath(from_rel), self.abspath(to_rel))
586
if not self.has_filename(from_rel):
587
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
588
if self.has_filename(to_rel):
589
raise BzrError("can't rename: new working file %r already exists" % to_rel)
591
file_id = inv.path2id(from_rel)
593
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
596
from_parent = entry.parent_id
597
from_name = entry.name
599
if inv.path2id(to_rel):
600
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
602
to_dir, to_tail = os.path.split(to_rel)
603
to_dir_id = inv.path2id(to_dir)
604
if to_dir_id == None and to_dir != '':
605
raise BzrError("can't determine destination directory id for %r" % to_dir)
607
mutter("rename_one:")
608
mutter(" file_id {%s}" % file_id)
609
mutter(" from_rel %r" % from_rel)
610
mutter(" to_rel %r" % to_rel)
611
mutter(" to_dir %r" % to_dir)
612
mutter(" to_dir_id {%s}" % to_dir_id)
614
inv.rename(file_id, to_dir_id, to_tail)
616
from_abs = self.abspath(from_rel)
617
to_abs = self.abspath(to_rel)
619
rename(from_abs, to_abs)
621
inv.rename(file_id, from_parent, from_name)
622
raise BzrError("failed to rename %r to %r: %s"
623
% (from_abs, to_abs, e[1]),
624
["rename rolled back"])
625
self._write_inventory(inv)
797
628
def unknowns(self):
798
629
"""Return all unknown files.
800
631
These are files in the working directory that are not versioned or
801
632
control files or ignored.
803
with self.lock_read():
804
# force the extras method to be fully executed before returning, to
805
# prevent race conditions with the lock
807
[subp for subp in self.extras() if not self.is_ignored(subp)])
809
def unversion(self, paths):
810
"""Remove the path in pahs from the current versioned set.
812
When a path is unversioned, all of its children are automatically
815
:param paths: The paths to stop versioning.
816
:raises NoSuchFile: if any path is not currently versioned.
818
raise NotImplementedError(self.unversion)
820
def pull(self, source, overwrite=False, stop_revision=None,
821
change_reporter=None, possible_transports=None, local=False,
822
show_base=False, tag_selector=None):
823
with self.lock_write(), source.lock_read():
824
old_revision_info = self.branch.last_revision_info()
825
basis_tree = self.basis_tree()
826
count = self.branch.pull(source, overwrite, stop_revision,
827
possible_transports=possible_transports,
828
local=local, tag_selector=tag_selector)
829
new_revision_info = self.branch.last_revision_info()
830
if new_revision_info != old_revision_info:
831
repository = self.branch.repository
832
if repository._format.fast_deltas:
833
parent_ids = self.get_parent_ids()
835
basis_id = parent_ids[0]
836
basis_tree = repository.revision_tree(basis_id)
837
with basis_tree.lock_read():
838
new_basis_tree = self.branch.basis_tree()
844
change_reporter=change_reporter,
846
basis_root_id = basis_tree.path2id('')
847
new_root_id = new_basis_tree.path2id('')
848
if new_root_id is not None and basis_root_id != new_root_id:
849
self.set_root_id(new_root_id)
850
# TODO - dedup parents list with things merged by pull ?
851
# reuse the revisiontree we merged against to set the new
854
if self.branch.last_revision() != _mod_revision.NULL_REVISION:
856
(self.branch.last_revision(), new_basis_tree))
857
# we have to pull the merge trees out again, because
858
# merge_inner has set the ids. - this corner is not yet
859
# layered well enough to prevent double handling.
860
# XXX TODO: Fix the double handling: telling the tree about
861
# the already known parent data is wasteful.
862
merges = self.get_parent_ids()[1:]
863
parent_trees.extend([
864
(parent, repository.revision_tree(parent)) for
866
self.set_parent_trees(parent_trees)
634
>>> from bzrlib.branch import ScratchBranch
635
>>> b = ScratchBranch(files=['foo', 'foo~'])
636
>>> tree = WorkingTree(b.base, b)
637
>>> map(str, tree.unknowns())
640
>>> list(b.unknowns())
642
>>> tree.remove('foo')
643
>>> list(b.unknowns())
646
for subp in self.extras():
647
if not self.is_ignored(subp):
650
def iter_conflicts(self):
652
for path in (s[0] for s in self.list_files()):
653
stem = get_conflicted_stem(path)
656
if stem not in conflicted:
661
def pull(self, source, overwrite=False):
662
from bzrlib.merge import merge_inner
665
old_revision_history = self.branch.revision_history()
666
count = self.branch.pull(source, overwrite)
667
new_revision_history = self.branch.revision_history()
668
if new_revision_history != old_revision_history:
669
if len(old_revision_history):
670
other_revision = old_revision_history[-1]
672
other_revision = None
673
merge_inner(self.branch,
674
self.branch.basis_tree(),
675
self.branch.revision_tree(other_revision))
869
def put_file_bytes_non_atomic(self, path, bytes):
870
"""See MutableTree.put_file_bytes_non_atomic."""
871
with self.lock_write(), open(self.abspath(path), 'wb') as stream:
874
680
def extras(self):
875
"""Yield all unversioned files in this WorkingTree.
681
"""Yield all unknown files in this WorkingTree.
877
If there are any unversioned directories and the file format
878
supports versioning directories, then only the directory is returned,
879
not all its children. But if there are unversioned files under a
880
versioned subdirectory, they are returned.
683
If there are any unknown directories then only the directory is
684
returned, not all its children. But if there are unknown files
685
under a versioned subdirectory, they are returned.
882
687
Currently returned depth-first, sorted by name within directories.
883
This is the same order used by 'osutils.walkdirs'.
885
raise NotImplementedError(self.extras)
689
## TODO: Work from given directory downwards
690
for path, dir_entry in self.inventory.directories():
691
mutter("search for unknowns in %r", path)
692
dirabs = self.abspath(path)
693
if not isdir(dirabs):
694
# e.g. directory deleted
698
for subf in os.listdir(dirabs):
700
and (subf not in dir_entry.children)):
705
subp = appendpath(path, subf)
887
709
def ignored_files(self):
888
710
"""Yield list of PATH, IGNORE_PATTERN"""
889
711
for subp in self.extras():
890
712
pat = self.is_ignored(subp)
717
def get_ignore_list(self):
718
"""Return list of ignore patterns.
720
Cached in the Tree object after the first call.
722
if hasattr(self, '_ignorelist'):
723
return self._ignorelist
725
l = bzrlib.DEFAULT_IGNORE[:]
726
if self.has_filename(bzrlib.IGNORE_FILENAME):
727
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
728
l.extend([line.rstrip("\n\r") for line in f.readlines()])
894
733
def is_ignored(self, filename):
895
734
r"""Check whether the filename matches an ignore pattern.
897
raise NotImplementedError(self.is_ignored)
899
def stored_kind(self, path):
900
"""See Tree.stored_kind"""
901
raise NotImplementedError(self.stored_kind)
903
def _comparison_data(self, entry, path):
904
abspath = self.abspath(path)
906
stat_value = os.lstat(abspath)
908
if getattr(e, 'errno', None) == errno.ENOENT:
736
Patterns containing '/' or '\' need to match the whole path;
737
others match against only the last component.
739
If the file is ignored, returns the pattern which caused it to
740
be ignored, otherwise None. So this can simply be used as a
741
boolean if desired."""
743
# TODO: Use '**' to match directories, and other extended
744
# globbing stuff from cvs/rsync.
746
# XXX: fnmatch is actually not quite what we want: it's only
747
# approximately the same as real Unix fnmatch, and doesn't
748
# treat dotfiles correctly and allows * to match /.
749
# Eventually it should be replaced with something more
752
for pat in self.get_ignore_list():
753
if '/' in pat or '\\' in pat:
755
# as a special case, you can put ./ at the start of a
756
# pattern; this is good to match in the top-level
759
if (pat[:2] == './') or (pat[:2] == '.\\'):
763
if fnmatch.fnmatchcase(filename, newpat):
766
if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
915
mode = stat_value.st_mode
916
kind = osutils.file_kind_from_stat_mode(mode)
917
if not self._supports_executable():
918
executable = entry is not None and entry.executable
920
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
921
return kind, executable, stat_value
923
def last_revision(self):
924
"""Return the last revision of the branch for this tree.
926
This format tree does not support a separate marker for last-revision
927
compared to the branch.
929
See MutableTree.last_revision
931
return self._last_revision()
933
def _last_revision(self):
934
"""helper for get_parent_ids."""
935
with self.lock_read():
936
return _mod_revision.ensure_null(self.branch.last_revision())
939
"""Check if this tree is locked."""
940
raise NotImplementedError(self.is_locked)
771
def kind(self, file_id):
772
return file_kind(self.id2abspath(file_id))
942
774
def lock_read(self):
943
"""Lock the tree for reading.
945
This also locks the branch, and can be unlocked via self.unlock().
947
:return: A breezy.lock.LogicalLockResult.
949
raise NotImplementedError(self.lock_read)
951
def lock_tree_write(self):
952
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
954
:return: A breezy.lock.LogicalLockResult.
956
raise NotImplementedError(self.lock_tree_write)
775
"""See Branch.lock_read, and WorkingTree.unlock."""
776
return self.branch.lock_read()
958
778
def lock_write(self):
959
"""See MutableTree.lock_write, and WorkingTree.unlock.
961
:return: A breezy.lock.LogicalLockResult.
963
raise NotImplementedError(self.lock_write)
965
def get_physical_lock_status(self):
966
raise NotImplementedError(self.get_physical_lock_status)
968
def set_last_revision(self, new_revision):
969
"""Change the last revision in the working tree."""
970
raise NotImplementedError(self.set_last_revision)
972
def _change_last_revision(self, new_revision):
973
"""Template method part of set_last_revision to perform the change.
975
This is used to allow WorkingTree3 instances to not affect branch
976
when their last revision is set.
978
if _mod_revision.is_null(new_revision):
979
self.branch.set_last_revision_info(0, new_revision)
981
_mod_revision.check_not_reserved_id(new_revision)
779
"""See Branch.lock_write, and WorkingTree.unlock."""
780
return self.branch.lock_write()
782
def _basis_inventory_name(self, revision_id):
783
return 'basis-inventory.%s' % revision_id
785
def set_last_revision(self, new_revision, old_revision=None):
788
path = self._basis_inventory_name(old_revision)
789
path = self.branch._rel_controlfilename(path)
790
self.branch._transport.delete(path)
983
self.branch.generate_revision_history(new_revision)
984
except errors.NoSuchRevision:
985
# not present in the repo - dont try to set it deeper than the tip
986
self.branch._set_revision_history([new_revision])
989
def remove(self, files, verbose=False, to_file=None, keep_files=True,
991
"""Remove nominated files from the working tree metadata.
993
:files: File paths relative to the basedir.
994
:keep_files: If true, the files will also be kept.
995
:force: Delete files and directories, even if they are changed and
996
even if the directories are not empty.
998
raise NotImplementedError(self.remove)
1000
def revert(self, filenames=None, old_tree=None, backups=True,
1001
pb=None, report_changes=False):
1002
from .conflicts import resolve
1003
with contextlib.ExitStack() as exit_stack:
1004
exit_stack.enter_context(self.lock_tree_write())
1005
if old_tree is None:
1006
basis_tree = self.basis_tree()
1007
exit_stack.enter_context(basis_tree.lock_read())
1008
old_tree = basis_tree
1011
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1013
if filenames is None and len(self.get_parent_ids()) > 1:
1015
last_revision = self.last_revision()
1016
if last_revision != _mod_revision.NULL_REVISION:
1017
if basis_tree is None:
1018
basis_tree = self.basis_tree()
1019
exit_stack.enter_context(basis_tree.lock_read())
1020
parent_trees.append((last_revision, basis_tree))
1021
self.set_parent_trees(parent_trees)
1024
resolve(self, filenames, ignore_misses=True, recursive=True)
1027
def store_uncommitted(self):
1028
"""Store uncommitted changes from the tree in the branch."""
1029
raise NotImplementedError(self.store_uncommitted)
1031
def restore_uncommitted(self):
1032
"""Restore uncommitted changes from the branch into the tree."""
1033
raise NotImplementedError(self.restore_uncommitted)
1035
def revision_tree(self, revision_id):
1036
"""See Tree.revision_tree.
1038
For trees that can be obtained from the working tree, this
1039
will do so. For other trees, it will fall back to the repository.
1041
raise NotImplementedError(self.revision_tree)
794
xml = self.branch.get_inventory_xml(new_revision)
795
path = self._basis_inventory_name(new_revision)
796
self.branch.put_controlfile(path, xml)
797
except WeaveRevisionNotPresent:
800
def read_basis_inventory(self, revision_id):
801
"""Read the cached basis inventory."""
802
path = self._basis_inventory_name(revision_id)
803
return self.branch.controlfile(path, 'r').read()
806
def read_working_inventory(self):
807
"""Read the working inventory."""
808
# ElementTree does its own conversion from UTF-8, so open in
810
f = self.branch.controlfile('inventory', 'rb')
811
return bzrlib.xml5.serializer_v5.read_inventory(f)
814
def remove(self, files, verbose=False):
815
"""Remove nominated files from the working inventory..
817
This does not remove their text. This does not run on XXX on what? RBC
819
TODO: Refuse to remove modified files unless --force is given?
821
TODO: Do something useful with directories.
823
TODO: Should this remove the text or not? Tough call; not
824
removing may be useful and the user can just use use rm, and
825
is the opposite of add. Removing it is consistent with most
826
other tools. Maybe an option.
828
## TODO: Normalize names
829
## TODO: Remove nested loops; better scalability
830
if isinstance(files, basestring):
835
# do this before any modifications
839
# TODO: Perhaps make this just a warning, and continue?
840
# This tends to happen when
841
raise NotVersionedError(path=f)
842
mutter("remove inventory entry %s {%s}", quotefn(f), fid)
844
# having remove it, it must be either ignored or unknown
845
if self.is_ignored(f):
849
show_status(new_status, inv[fid].kind, quotefn(f))
852
self._write_inventory(inv)
855
def revert(self, filenames, old_tree=None, backups=True):
856
from bzrlib.merge import merge_inner
858
old_tree = self.branch.basis_tree()
859
merge_inner(self.branch, old_tree,
860
self, ignore_zero=True,
861
backup_files=backups,
862
interesting_files=filenames)
863
if not len(filenames):
864
self.set_pending_merges([])
867
def set_inventory(self, new_inventory_list):
868
from bzrlib.inventory import (Inventory,
873
inv = Inventory(self.get_root_id())
874
for path, file_id, parent, kind in new_inventory_list:
875
name = os.path.basename(path)
878
# fixme, there should be a factory function inv,add_??
879
if kind == 'directory':
880
inv.add(InventoryDirectory(file_id, name, parent))
882
inv.add(InventoryFile(file_id, name, parent))
883
elif kind == 'symlink':
884
inv.add(InventoryLink(file_id, name, parent))
886
raise BzrError("unknown kind %r" % kind)
887
self._write_inventory(inv)
1043
890
def set_root_id(self, file_id):
1044
891
"""Set the root id for this tree."""
1045
if not self.supports_setting_file_ids():
1046
raise SettingFileIdUnsupported()
1047
with self.lock_tree_write():
1051
'WorkingTree.set_root_id with fileid=None')
1052
self._set_root_id(file_id)
1054
def _set_root_id(self, file_id):
1055
"""Set the root id for this tree, in a format specific manner.
1057
:param file_id: The file id to assign to the root. It must not be
1058
present in the current inventory or an error will occur. It must
1059
not be None, but rather a valid file id.
1061
raise NotImplementedError(self._set_root_id)
892
inv = self.read_working_inventory()
893
orig_root_id = inv.root.file_id
894
del inv._byid[inv.root.file_id]
895
inv.root.file_id = file_id
896
inv._byid[inv.root.file_id] = inv.root
899
if entry.parent_id in (None, orig_root_id):
900
entry.parent_id = inv.root.file_id
901
self._write_inventory(inv)
1063
903
def unlock(self):
1064
904
"""See Branch.unlock.
1066
906
WorkingTree locking just uses the Branch locking facilities.
1067
907
This is current because all working trees have an embedded branch
1068
908
within them. IF in the future, we were to make branch data shareable
1069
between multiple working trees, i.e. via shared storage, then we
909
between multiple working trees, i.e. via shared storage, then we
1070
910
would probably want to lock both the local tree, and the branch.
1072
raise NotImplementedError(self.unlock)
1076
def update(self, change_reporter=None, possible_transports=None,
1077
revision=None, old_tip=_marker, show_base=False):
1078
"""Update a working tree along its branch.
1080
This will update the branch if its bound too, which means we have
1081
multiple trees involved:
1083
- The new basis tree of the master.
1084
- The old basis tree of the branch.
1085
- The old basis tree of the working tree.
1086
- The current working tree state.
1088
Pathologically, all three may be different, and non-ancestors of each
1089
other. Conceptually we want to:
1091
- Preserve the wt.basis->wt.state changes
1092
- Transform the wt.basis to the new master basis.
1093
- Apply a merge of the old branch basis to get any 'local' changes from
1095
- Restore the wt.basis->wt.state changes.
1097
There isn't a single operation at the moment to do that, so we:
1099
- Merge current state -> basis tree of the master w.r.t. the old tree
1101
- Do a 'normal' merge of the old branch basis if it is relevant.
1103
:param revision: The target revision to update to. Must be in the
1105
:param old_tip: If branch.update() has already been run, the value it
1106
returned (old tip of the branch or None). _marker is used
1109
if self.branch.get_bound_location() is not None:
1111
update_branch = (old_tip is self._marker)
1113
self.lock_tree_write()
1114
update_branch = False
912
return self.branch.unlock()
915
def _write_inventory(self, inv):
916
"""Write inventory as the current inventory."""
917
from cStringIO import StringIO
918
from bzrlib.atomicfile import AtomicFile
920
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
922
f = AtomicFile(self.branch.controlfilename('inventory'))
1117
old_tip = self.branch.update(possible_transports)
1119
if old_tip is self._marker:
1121
return self._update_tree(old_tip, change_reporter, revision, show_base)
1125
def _update_tree(self, old_tip=None, change_reporter=None, revision=None,
1127
"""Update a tree to the master branch.
1129
:param old_tip: if supplied, the previous tip revision the branch,
1130
before it was changed to the master branch's tip.
1132
# here if old_tip is not None, it is the old tip of the branch before
1133
# it was updated from the master branch. This should become a pending
1134
# merge in the working tree to preserve the user existing work. we
1135
# cant set that until we update the working trees last revision to be
1136
# one from the new branch, because it will just get absorbed by the
1137
# parent de-duplication logic.
1139
# We MUST save it even if an error occurs, because otherwise the users
1140
# local work is unreferenced and will appear to have been lost.
1142
with self.lock_tree_write():
1145
last_rev = self.get_parent_ids()[0]
1147
last_rev = _mod_revision.NULL_REVISION
1148
if revision is None:
1149
revision = self.branch.last_revision()
1151
old_tip = old_tip or _mod_revision.NULL_REVISION
1153
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
1154
# the branch we are bound to was updated
1155
# merge those changes in first
1156
base_tree = self.basis_tree()
1157
other_tree = self.branch.repository.revision_tree(old_tip)
1158
nb_conflicts = merge.merge_inner(self.branch, other_tree,
1159
base_tree, this_tree=self,
1160
change_reporter=change_reporter,
1161
show_base=show_base)
1163
self.add_parent_tree((old_tip, other_tree))
1164
note(gettext('Rerun update after fixing the conflicts.'))
1167
if last_rev != _mod_revision.ensure_null(revision):
1168
# the working tree is up to date with the branch
1169
# we can merge the specified revision from master
1170
to_tree = self.branch.repository.revision_tree(revision)
1171
to_root_id = to_tree.path2id('')
1173
basis = self.basis_tree()
1174
with basis.lock_read():
1175
if (basis.path2id('') is None or basis.path2id('') != to_root_id):
1176
self.set_root_id(to_root_id)
1179
# determine the branch point
1180
graph = self.branch.repository.get_graph()
1181
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
1183
base_tree = self.branch.repository.revision_tree(base_rev_id)
1185
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
1187
change_reporter=change_reporter,
1188
show_base=show_base)
1189
self.set_last_revision(revision)
1190
# TODO - dedup parents list with things merged by pull ?
1191
# reuse the tree we've updated to to set the basis:
1192
parent_trees = [(revision, to_tree)]
1193
merges = self.get_parent_ids()[1:]
1194
# Ideally we ask the tree for the trees here, that way the working
1195
# tree can decide whether to give us the entire tree or give us a
1196
# lazy initialised tree. dirstate for instance will have the trees
1197
# in ram already, whereas a last-revision + basis-inventory tree
1198
# will not, but also does not need them when setting parents.
1199
for parent in merges:
1200
parent_trees.append(
1201
(parent, self.branch.repository.revision_tree(parent)))
1202
if not _mod_revision.is_null(old_tip):
1203
parent_trees.append(
1204
(old_tip, self.branch.repository.revision_tree(old_tip)))
1205
self.set_parent_trees(parent_trees)
1206
last_rev = parent_trees[0][0]
1209
def set_conflicts(self, arg):
1210
raise errors.UnsupportedOperation(self.set_conflicts, self)
1212
def add_conflicts(self, arg):
1213
raise errors.UnsupportedOperation(self.add_conflicts, self)
1215
def conflicts(self):
1216
raise NotImplementedError(self.conflicts)
1218
def walkdirs(self, prefix=""):
1219
"""Walk the directories of this tree.
1221
returns a generator which yields items in the form:
1222
((curren_directory_path, fileid),
1223
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
1226
This API returns a generator, which is only valid during the current
1227
tree transaction - within a single lock_read or lock_write duration.
1229
If the tree is not locked, it may cause an error to be raised,
1230
depending on the tree implementation.
1232
raise NotImplementedError(self.walkdirs)
1234
@deprecated_method(deprecated_in((3, 0, 1)))
1235
def auto_resolve(self):
1236
"""Automatically resolve text conflicts according to contents.
1238
Only text conflicts are auto_resolvable. Files with no conflict markers
1239
are considered 'resolved', because bzr always puts conflict markers
1240
into files that have text conflicts. The corresponding .THIS .BASE and
1241
.OTHER files are deleted, as per 'resolve'.
1243
:return: a tuple of ConflictLists: (un_resolved, resolved).
1245
with self.lock_tree_write():
1246
un_resolved = _mod_conflicts.ConflictList()
1247
resolved = _mod_conflicts.ConflictList()
1248
for conflict in self.conflicts():
1250
conflict.action_auto(self)
1251
except NotImplementedError:
1252
un_resolved.append(conflict)
1254
conflict.cleanup(self)
1255
resolved.append(conflict)
1256
self.set_conflicts(un_resolved)
1257
return un_resolved, resolved
1259
def _validate(self):
1260
"""Validate internal structures.
1262
This is meant mostly for the test suite. To give it a chance to detect
1263
corruption after actions have occurred. The default implementation is a
1266
:return: None. An exception should be raised if there is an error.
1270
def check_state(self):
1271
"""Check that the working state is/isn't valid."""
1272
raise NotImplementedError(self.check_state)
1274
def reset_state(self, revision_ids=None):
1275
"""Reset the state of the working tree.
1277
This does a hard-reset to a last-known-good state. This is a way to
1278
fix if something got corrupted (like the .bzr/checkout/dirstate file)
1280
raise NotImplementedError(self.reset_state)
1282
def _get_rules_searcher(self, default_searcher):
1283
"""See Tree._get_rules_searcher."""
1284
if self._rules_searcher is None:
1285
self._rules_searcher = super(WorkingTree,
1286
self)._get_rules_searcher(default_searcher)
1287
return self._rules_searcher
1289
def get_shelf_manager(self):
1290
"""Return the ShelfManager for this WorkingTree."""
1291
raise NotImplementedError(self.get_shelf_manager)
1293
def get_canonical_paths(self, paths):
1294
"""Like get_canonical_path() but works on multiple items.
1296
:param paths: A sequence of paths relative to the root of the tree.
1297
:return: A list of paths, with each item the corresponding input path
1298
adjusted to account for existing elements that match case
1301
with self.lock_read():
1305
def get_canonical_path(self, path):
1306
"""Returns the first item in the tree that matches a path.
1308
This is meant to allow case-insensitive path lookups on e.g.
1311
If a path matches exactly, it is returned. If no path matches exactly
1312
but more than one path matches according to the underlying file system,
1313
it is implementation defined which is returned.
1315
If no path matches according to the file system, the input path is
1316
returned, but with as many path entries that do exist changed to their
1319
If you need to resolve many names from the same tree, you should
1320
use get_canonical_paths() to avoid O(N) behaviour.
1322
:param path: A paths relative to the root of the tree.
1323
:return: The input path adjusted to account for existing elements
1324
that match case insensitively.
1326
with self.lock_read():
1327
return next(self.get_canonical_paths([path]))
1329
def reference_parent(self, path, branch=None, possible_transports=None):
1330
raise errors.UnsupportedOperation(self.reference_parent, self)
1332
def get_reference_info(self, path, branch=None):
1333
raise errors.UnsupportedOperation(self.get_reference_info, self)
1335
def set_reference_info(self, tree_path, branch_location):
1336
raise errors.UnsupportedOperation(self.set_reference_info, self)
1339
class WorkingTreeFormatRegistry(ControlComponentFormatRegistry):
1340
"""Registry for working tree formats."""
1342
def __init__(self, other_registry=None):
1343
super(WorkingTreeFormatRegistry, self).__init__(other_registry)
1344
self._default_format = None
1345
self._default_format_key = None
1347
def get_default(self):
1348
"""Return the current default format."""
1349
if (self._default_format_key is not None and
1350
self._default_format is None):
1351
self._default_format = self.get(self._default_format_key)
1352
return self._default_format
1354
def set_default(self, format):
1355
"""Set the default format."""
1356
self._default_format = format
1357
self._default_format_key = None
1359
def set_default_key(self, format_string):
1360
"""Set the default format by its format string."""
1361
self._default_format_key = format_string
1362
self._default_format = None
1365
format_registry = WorkingTreeFormatRegistry()
1368
class WorkingTreeFormat(ControlComponentFormat):
1369
"""An encapsulation of the initialization and open routines for a format.
1371
Formats provide three things:
1372
* An initialization routine,
1376
Formats are placed in an dict by their format string for reference
1377
during workingtree opening. Its not required that these be instances, they
1378
can be classes themselves with class methods - it simply depends on
1379
whether state is needed for a given format or not.
1381
Once a format is deprecated, just deprecate the initialize and open
1382
methods on the format class. Do not deprecate the object, as the
1383
object will be created every time regardless.
1386
requires_rich_root = False
1388
upgrade_recommended = False
1390
requires_normalized_unicode_filenames = False
1392
case_sensitive_filename = "FoRMaT"
1394
missing_parent_conflicts = False
1395
"""If this format supports missing parent conflicts."""
1397
supports_versioned_directories = None
1399
supports_merge_modified = True
1400
"""If this format supports storing merge modified hashes."""
1402
supports_setting_file_ids = True
1403
"""If this format allows setting the file id."""
1405
supports_store_uncommitted = True
1406
"""If this format supports shelve-like functionality."""
1408
supports_leftmost_parent_id_as_ghost = True
1410
supports_righthand_parent_id_as_ghost = True
1412
ignore_filename = None
1413
"""Name of file with ignore patterns, if any. """
1415
def initialize(self, controldir, revision_id=None, from_branch=None,
1416
accelerator_tree=None, hardlink=False):
1417
"""Initialize a new working tree in controldir.
1419
:param controldir: ControlDir to initialize the working tree in.
1420
:param revision_id: allows creating a working tree at a different
1421
revision than the branch is at.
1422
:param from_branch: Branch to checkout
1423
:param accelerator_tree: A tree which can be used for retrieving file
1424
contents more quickly than the revision tree, i.e. a workingtree.
1425
The revision tree will be used for cases where accelerator_tree's
1426
content is different.
1427
:param hardlink: If true, hard-link files from accelerator_tree,
1430
raise NotImplementedError(self.initialize)
1432
def __eq__(self, other):
1433
return self.__class__ is other.__class__
1435
def __ne__(self, other):
1436
return not (self == other)
1438
def get_format_description(self):
1439
"""Return the short description for this format."""
1440
raise NotImplementedError(self.get_format_description)
1442
def is_supported(self):
1443
"""Is this format supported?
1445
Supported formats can be initialized and opened.
1446
Unsupported formats may not support initialization or committing or
1447
some other features depending on the reason for not being supported.
1451
def supports_content_filtering(self):
1452
"""True if this format supports content filtering."""
1455
def supports_views(self):
1456
"""True if this format supports stored views."""
1459
def get_controldir_for_branch(self):
1460
"""Get the control directory format for creating branches.
1462
This is to support testing of working tree formats that can not exist
1463
in the same control directory as a branch.
1465
return self._matchingcontroldir
1468
format_registry.register_lazy(b"Bazaar Working Tree Format 4 (bzr 0.15)\n",
1469
"breezy.bzr.workingtree_4", "WorkingTreeFormat4")
1470
format_registry.register_lazy(b"Bazaar Working Tree Format 5 (bzr 1.11)\n",
1471
"breezy.bzr.workingtree_4", "WorkingTreeFormat5")
1472
format_registry.register_lazy(b"Bazaar Working Tree Format 6 (bzr 1.14)\n",
1473
"breezy.bzr.workingtree_4", "WorkingTreeFormat6")
1474
format_registry.register_lazy(b"Bazaar-NG Working Tree format 3",
1475
"breezy.bzr.workingtree_3", "WorkingTreeFormat3")
1476
format_registry.set_default_key(b"Bazaar Working Tree Format 6 (bzr 1.14)\n")
928
self._set_inventory(inv)
929
mutter('wrote working inventory')
932
CONFLICT_SUFFIXES = ('.THIS', '.BASE', '.OTHER')
933
def get_conflicted_stem(path):
934
for suffix in CONFLICT_SUFFIXES:
935
if path.endswith(suffix):
936
return path[:-len(suffix)]
added
removed
bzrlib/workingtree.py
