1
# Copyright (C) 2005, 2006, 2007 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""WorkingTree object and friends.
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. 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.
25
At the moment every WorkingTree has its own branch. Remote
26
WorkingTrees aren't supported.
28
To get a WorkingTree, call bzrdir.open_workingtree() or
29
WorkingTree.open(dir).
32
# TODO: Give the workingtree sole responsibility for the working inventory;
33
# remove the variable and references to it from the branch. This may require
34
# updating the commit code so as to update the inventory within the working
35
# copy, and making sure there's only one WorkingTree for any directory on disk.
36
# At the moment they may alias the inventory and have old copies of it in
37
# memory. (Now done? -- mbp 20060309)
39
from cStringIO import StringIO
43
from bzrlib.lazy_import import lazy_import
44
lazy_import(globals(), """
45
from bisect import bisect_left
59
conflicts as _mod_conflicts,
67
revision as _mod_revision,
80
from bzrlib.transport import get_transport
82
from bzrlib.workingtree_4 import WorkingTreeFormat4
85
from bzrlib import symbol_versioning
86
from bzrlib.decorators import needs_read_lock, needs_write_lock
87
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
88
from bzrlib.lockable_files import LockableFiles, TransportLock
89
from bzrlib.lockdir import LockDir
90
import bzrlib.mutabletree
91
from bzrlib.mutabletree import needs_tree_write_lock
92
from bzrlib import osutils
93
from bzrlib.osutils import (
105
from bzrlib.trace import mutter, note
106
from bzrlib.transport.local import LocalTransport
107
from bzrlib.progress import DummyProgress, ProgressPhase
108
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
109
from bzrlib.rio import RioReader, rio_file, Stanza
110
from bzrlib.symbol_versioning import (deprecated_passed,
113
DEPRECATED_PARAMETER,
117
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
118
CONFLICT_HEADER_1 = "BZR conflict list format 1"
120
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
123
class TreeEntry(object):
124
"""An entry that implements the minimum interface used by commands.
126
This needs further inspection, it may be better to have
127
InventoryEntries without ids - though that seems wrong. For now,
128
this is a parallel hierarchy to InventoryEntry, and needs to become
129
one of several things: decorates to that hierarchy, children of, or
131
Another note is that these objects are currently only used when there is
132
no InventoryEntry available - i.e. for unversioned objects.
133
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
136
def __eq__(self, other):
137
# yes, this us ugly, TODO: best practice __eq__ style.
138
return (isinstance(other, TreeEntry)
139
and other.__class__ == self.__class__)
141
def kind_character(self):
145
class TreeDirectory(TreeEntry):
146
"""See TreeEntry. This is a directory in a working tree."""
148
def __eq__(self, other):
149
return (isinstance(other, TreeDirectory)
150
and other.__class__ == self.__class__)
152
def kind_character(self):
156
class TreeFile(TreeEntry):
157
"""See TreeEntry. This is a regular file in a working tree."""
159
def __eq__(self, other):
160
return (isinstance(other, TreeFile)
161
and other.__class__ == self.__class__)
163
def kind_character(self):
167
class TreeLink(TreeEntry):
168
"""See TreeEntry. This is a symlink in a working tree."""
170
def __eq__(self, other):
171
return (isinstance(other, TreeLink)
172
and other.__class__ == self.__class__)
174
def kind_character(self):
178
class WorkingTree(bzrlib.mutabletree.MutableTree):
179
"""Working copy tree.
181
The inventory is held in the `Branch` working-inventory, and the
182
files are in a directory on disk.
184
It is possible for a `WorkingTree` to have a filename which is
185
not listed in the Inventory and vice versa.
188
def __init__(self, basedir='.',
189
branch=DEPRECATED_PARAMETER,
195
"""Construct a WorkingTree instance. This is not a public API.
197
:param branch: A branch to override probing for the branch.
199
self._format = _format
200
self.bzrdir = _bzrdir
202
raise errors.BzrError("Please use bzrdir.open_workingtree or "
203
"WorkingTree.open() to obtain a WorkingTree.")
204
basedir = safe_unicode(basedir)
205
mutter("opening working tree %r", basedir)
206
if deprecated_passed(branch):
207
self._branch = branch
209
self._branch = self.bzrdir.open_branch()
210
self.basedir = realpath(basedir)
211
# if branch is at our basedir and is a format 6 or less
212
if isinstance(self._format, WorkingTreeFormat2):
213
# share control object
214
self._control_files = self.branch.control_files
216
# assume all other formats have their own control files.
217
self._control_files = _control_files
218
self._transport = self._control_files._transport
219
# update the whole cache up front and write to disk if anything changed;
220
# in the future we might want to do this more selectively
221
# two possible ways offer themselves : in self._unlock, write the cache
222
# if needed, or, when the cache sees a change, append it to the hash
223
# cache file, and have the parser take the most recent entry for a
225
wt_trans = self.bzrdir.get_workingtree_transport(None)
226
cache_filename = wt_trans.local_abspath('stat-cache')
227
self._hashcache = hashcache.HashCache(basedir, cache_filename,
228
self.bzrdir._get_file_mode())
231
# is this scan needed ? it makes things kinda slow.
238
if _inventory is None:
239
# This will be acquired on lock_read() or lock_write()
240
self._inventory_is_modified = False
241
self._inventory = None
243
# the caller of __init__ has provided an inventory,
244
# we assume they know what they are doing - as its only
245
# the Format factory and creation methods that are
246
# permitted to do this.
247
self._set_inventory(_inventory, dirty=False)
248
self._detect_case_handling()
250
def _detect_case_handling(self):
251
wt_trans = self.bzrdir.get_workingtree_transport(None)
253
wt_trans.stat("FoRMaT")
254
except errors.NoSuchFile:
255
self.case_sensitive = True
257
self.case_sensitive = False
259
self._setup_directory_is_tree_reference()
262
fget=lambda self: self._branch,
263
doc="""The branch this WorkingTree is connected to.
265
This cannot be set - it is reflective of the actual disk structure
266
the working tree has been constructed from.
269
def break_lock(self):
270
"""Break a lock if one is present from another instance.
272
Uses the ui factory to ask for confirmation if the lock may be from
275
This will probe the repository for its lock as well.
277
self._control_files.break_lock()
278
self.branch.break_lock()
280
def requires_rich_root(self):
281
return self._format.requires_rich_root
283
def supports_tree_reference(self):
286
def _set_inventory(self, inv, dirty):
287
"""Set the internal cached inventory.
289
:param inv: The inventory to set.
290
:param dirty: A boolean indicating whether the inventory is the same
291
logical inventory as whats on disk. If True the inventory is not
292
the same and should be written to disk or data will be lost, if
293
False then the inventory is the same as that on disk and any
294
serialisation would be unneeded overhead.
296
self._inventory = inv
297
self._inventory_is_modified = dirty
300
def open(path=None, _unsupported=False):
301
"""Open an existing working tree at path.
305
path = os.path.getcwdu()
306
control = bzrdir.BzrDir.open(path, _unsupported)
307
return control.open_workingtree(_unsupported)
310
def open_containing(path=None):
311
"""Open an existing working tree which has its root about path.
313
This probes for a working tree at path and searches upwards from there.
315
Basically we keep looking up until we find the control directory or
316
run into /. If there isn't one, raises NotBranchError.
317
TODO: give this a new exception.
318
If there is one, it is returned, along with the unused portion of path.
320
:return: The WorkingTree that contains 'path', and the rest of path
323
path = osutils.getcwd()
324
control, relpath = bzrdir.BzrDir.open_containing(path)
326
return control.open_workingtree(), relpath
329
def open_downlevel(path=None):
330
"""Open an unsupported working tree.
332
Only intended for advanced situations like upgrading part of a bzrdir.
334
return WorkingTree.open(path, _unsupported=True)
337
def find_trees(location):
338
def list_current(transport):
339
return [d for d in transport.list_dir('') if d != '.bzr']
340
def evaluate(bzrdir):
342
tree = bzrdir.open_workingtree()
343
except errors.NoWorkingTree:
347
transport = get_transport(location)
348
iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
349
list_current=list_current)
350
return [t for t in iterator if t is not None]
352
# should be deprecated - this is slow and in any case treating them as a
353
# container is (we now know) bad style -- mbp 20070302
354
## @deprecated_method(zero_fifteen)
356
"""Iterate through file_ids for this tree.
358
file_ids are in a WorkingTree if they are in the working inventory
359
and the working file exists.
361
inv = self._inventory
362
for path, ie in inv.iter_entries():
363
if osutils.lexists(self.abspath(path)):
366
def all_file_ids(self):
367
"""See Tree.iter_all_file_ids"""
368
return set(self.inventory)
371
return "<%s of %s>" % (self.__class__.__name__,
372
getattr(self, 'basedir', None))
374
def abspath(self, filename):
375
return pathjoin(self.basedir, filename)
377
def basis_tree(self):
378
"""Return RevisionTree for the current last revision.
380
If the left most parent is a ghost then the returned tree will be an
381
empty tree - one obtained by calling repository.revision_tree(None).
384
revision_id = self.get_parent_ids()[0]
386
# no parents, return an empty revision tree.
387
# in the future this should return the tree for
388
# 'empty:' - the implicit root empty tree.
389
return self.branch.repository.revision_tree(None)
391
return self.revision_tree(revision_id)
392
except errors.NoSuchRevision:
394
# No cached copy available, retrieve from the repository.
395
# FIXME? RBC 20060403 should we cache the inventory locally
398
return self.branch.repository.revision_tree(revision_id)
399
except errors.RevisionNotPresent:
400
# the basis tree *may* be a ghost or a low level error may have
401
# occured. If the revision is present, its a problem, if its not
403
if self.branch.repository.has_revision(revision_id):
405
# the basis tree is a ghost so return an empty tree.
406
return self.branch.repository.revision_tree(None)
409
self._flush_ignore_list_cache()
411
def relpath(self, path):
412
"""Return the local path portion from a given path.
414
The path may be absolute or relative. If its a relative path it is
415
interpreted relative to the python current working directory.
417
return osutils.relpath(self.basedir, path)
419
def has_filename(self, filename):
420
return osutils.lexists(self.abspath(filename))
422
def get_file(self, file_id, path=None):
424
path = self.id2path(file_id)
425
return self.get_file_byname(path)
427
def get_file_text(self, file_id):
428
return self.get_file(file_id).read()
430
def get_file_byname(self, filename):
431
return file(self.abspath(filename), 'rb')
434
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
435
"""See Tree.annotate_iter
437
This implementation will use the basis tree implementation if possible.
438
Lines not in the basis are attributed to CURRENT_REVISION
440
If there are pending merges, lines added by those merges will be
441
incorrectly attributed to CURRENT_REVISION (but after committing, the
442
attribution will be correct).
444
basis = self.basis_tree()
447
changes = self.iter_changes(basis, True, [self.id2path(file_id)],
448
require_versioned=True).next()
449
changed_content, kind = changes[2], changes[6]
450
if not changed_content:
451
return basis.annotate_iter(file_id)
455
if kind[0] != 'file':
458
old_lines = list(basis.annotate_iter(file_id))
460
for tree in self.branch.repository.revision_trees(
461
self.get_parent_ids()[1:]):
462
if file_id not in tree:
464
old.append(list(tree.annotate_iter(file_id)))
465
return annotate.reannotate(old, self.get_file(file_id).readlines(),
470
def _get_ancestors(self, default_revision):
471
ancestors = set([default_revision])
472
for parent_id in self.get_parent_ids():
473
ancestors.update(self.branch.repository.get_ancestry(
474
parent_id, topo_sorted=False))
477
def get_parent_ids(self):
478
"""See Tree.get_parent_ids.
480
This implementation reads the pending merges list and last_revision
481
value and uses that to decide what the parents list should be.
483
last_rev = _mod_revision.ensure_null(self._last_revision())
484
if _mod_revision.NULL_REVISION == last_rev:
489
merges_file = self._transport.get('pending-merges')
490
except errors.NoSuchFile:
493
for l in merges_file.readlines():
494
revision_id = l.rstrip('\n')
495
parents.append(revision_id)
499
def get_root_id(self):
500
"""Return the id of this trees root"""
501
return self._inventory.root.file_id
503
def _get_store_filename(self, file_id):
504
## XXX: badly named; this is not in the store at all
505
return self.abspath(self.id2path(file_id))
508
def clone(self, to_bzrdir, revision_id=None):
509
"""Duplicate this working tree into to_bzr, including all state.
511
Specifically modified files are kept as modified, but
512
ignored and unknown files are discarded.
514
If you want to make a new line of development, see bzrdir.sprout()
517
If not None, the cloned tree will have its last revision set to
518
revision, and and difference between the source trees last revision
519
and this one merged in.
521
# assumes the target bzr dir format is compatible.
522
result = self._format.initialize(to_bzrdir)
523
self.copy_content_into(result, revision_id)
527
def copy_content_into(self, tree, revision_id=None):
528
"""Copy the current content and user files of this tree into tree."""
529
tree.set_root_id(self.get_root_id())
530
if revision_id is None:
531
merge.transform_tree(tree, self)
533
# TODO now merge from tree.last_revision to revision (to preserve
534
# user local changes)
535
merge.transform_tree(tree, self)
536
tree.set_parent_ids([revision_id])
538
def id2abspath(self, file_id):
539
return self.abspath(self.id2path(file_id))
541
def has_id(self, file_id):
542
# files that have been deleted are excluded
544
if not inv.has_id(file_id):
546
path = inv.id2path(file_id)
547
return osutils.lexists(self.abspath(path))
549
def has_or_had_id(self, file_id):
550
if file_id == self.inventory.root.file_id:
552
return self.inventory.has_id(file_id)
554
__contains__ = has_id
556
def get_file_size(self, file_id):
557
"""See Tree.get_file_size"""
559
return os.path.getsize(self.id2abspath(file_id))
561
if e.errno != errno.ENOENT:
567
def get_file_sha1(self, file_id, path=None, stat_value=None):
569
path = self._inventory.id2path(file_id)
570
return self._hashcache.get_sha1(path, stat_value)
572
def get_file_mtime(self, file_id, path=None):
574
path = self.inventory.id2path(file_id)
575
return os.lstat(self.abspath(path)).st_mtime
577
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
578
file_id = self.path2id(path)
579
return self._inventory[file_id].executable
581
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
582
mode = stat_result.st_mode
583
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
585
if not supports_executable():
586
def is_executable(self, file_id, path=None):
587
return self._inventory[file_id].executable
589
_is_executable_from_path_and_stat = \
590
_is_executable_from_path_and_stat_from_basis
592
def is_executable(self, file_id, path=None):
594
path = self.id2path(file_id)
595
mode = os.lstat(self.abspath(path)).st_mode
596
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
598
_is_executable_from_path_and_stat = \
599
_is_executable_from_path_and_stat_from_stat
601
@needs_tree_write_lock
602
def _add(self, files, ids, kinds):
603
"""See MutableTree._add."""
604
# TODO: Re-adding a file that is removed in the working copy
605
# should probably put it back with the previous ID.
606
# the read and write working inventory should not occur in this
607
# function - they should be part of lock_write and unlock.
609
for f, file_id, kind in zip(files, ids, kinds):
611
inv.add_path(f, kind=kind)
613
inv.add_path(f, kind=kind, file_id=file_id)
614
self._inventory_is_modified = True
616
@needs_tree_write_lock
617
def _gather_kinds(self, files, kinds):
618
"""See MutableTree._gather_kinds."""
619
for pos, f in enumerate(files):
620
if kinds[pos] is None:
621
fullpath = normpath(self.abspath(f))
623
kinds[pos] = file_kind(fullpath)
625
if e.errno == errno.ENOENT:
626
raise errors.NoSuchFile(fullpath)
629
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
630
"""Add revision_id as a parent.
632
This is equivalent to retrieving the current list of parent ids
633
and setting the list to its value plus revision_id.
635
:param revision_id: The revision id to add to the parent list. It may
636
be a ghost revision as long as its not the first parent to be added,
637
or the allow_leftmost_as_ghost parameter is set True.
638
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
640
parents = self.get_parent_ids() + [revision_id]
641
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
642
or allow_leftmost_as_ghost)
644
@needs_tree_write_lock
645
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
646
"""Add revision_id, tree tuple as a parent.
648
This is equivalent to retrieving the current list of parent trees
649
and setting the list to its value plus parent_tuple. See also
650
add_parent_tree_id - if you only have a parent id available it will be
651
simpler to use that api. If you have the parent already available, using
652
this api is preferred.
654
:param parent_tuple: The (revision id, tree) to add to the parent list.
655
If the revision_id is a ghost, pass None for the tree.
656
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
658
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
659
if len(parent_ids) > 1:
660
# the leftmost may have already been a ghost, preserve that if it
662
allow_leftmost_as_ghost = True
663
self.set_parent_ids(parent_ids,
664
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
666
@needs_tree_write_lock
667
def add_pending_merge(self, *revision_ids):
668
# TODO: Perhaps should check at this point that the
669
# history of the revision is actually present?
670
parents = self.get_parent_ids()
672
for rev_id in revision_ids:
673
if rev_id in parents:
675
parents.append(rev_id)
678
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
680
def path_content_summary(self, path, _lstat=os.lstat,
681
_mapper=osutils.file_kind_from_stat_mode):
682
"""See Tree.path_content_summary."""
683
abspath = self.abspath(path)
685
stat_result = _lstat(abspath)
687
if getattr(e, 'errno', None) == errno.ENOENT:
689
return ('missing', None, None, None)
690
# propagate other errors
692
kind = _mapper(stat_result.st_mode)
694
size = stat_result.st_size
695
# try for a stat cache lookup
696
executable = self._is_executable_from_path_and_stat(path, stat_result)
697
return (kind, size, executable, self._sha_from_stat(
699
elif kind == 'directory':
700
# perhaps it looks like a plain directory, but it's really a
702
if self._directory_is_tree_reference(path):
703
kind = 'tree-reference'
704
return kind, None, None, None
705
elif kind == 'symlink':
706
return ('symlink', None, None, os.readlink(abspath))
708
return (kind, None, None, None)
710
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
711
"""Common ghost checking functionality from set_parent_*.
713
This checks that the left hand-parent exists if there are any
716
if len(revision_ids) > 0:
717
leftmost_id = revision_ids[0]
718
if (not allow_leftmost_as_ghost and not
719
self.branch.repository.has_revision(leftmost_id)):
720
raise errors.GhostRevisionUnusableHere(leftmost_id)
722
def _set_merges_from_parent_ids(self, parent_ids):
723
merges = parent_ids[1:]
724
self._transport.put_bytes('pending-merges', '\n'.join(merges),
725
mode=self._control_files._file_mode)
727
def _filter_parent_ids_by_ancestry(self, revision_ids):
728
"""Check that all merged revisions are proper 'heads'.
730
This will always return the first revision_id, and any merged revisions
733
if len(revision_ids) == 0:
735
graph = self.branch.repository.get_graph()
736
heads = graph.heads(revision_ids)
737
new_revision_ids = revision_ids[:1]
738
for revision_id in revision_ids[1:]:
739
if revision_id in heads and revision_id not in new_revision_ids:
740
new_revision_ids.append(revision_id)
741
if new_revision_ids != revision_ids:
742
trace.mutter('requested to set revision_ids = %s,'
743
' but filtered to %s', revision_ids, new_revision_ids)
744
return new_revision_ids
746
@needs_tree_write_lock
747
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
748
"""Set the parent ids to revision_ids.
750
See also set_parent_trees. This api will try to retrieve the tree data
751
for each element of revision_ids from the trees repository. If you have
752
tree data already available, it is more efficient to use
753
set_parent_trees rather than set_parent_ids. set_parent_ids is however
754
an easier API to use.
756
:param revision_ids: The revision_ids to set as the parent ids of this
757
working tree. Any of these may be ghosts.
759
self._check_parents_for_ghosts(revision_ids,
760
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
761
for revision_id in revision_ids:
762
_mod_revision.check_not_reserved_id(revision_id)
764
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
766
if len(revision_ids) > 0:
767
self.set_last_revision(revision_ids[0])
769
self.set_last_revision(_mod_revision.NULL_REVISION)
771
self._set_merges_from_parent_ids(revision_ids)
773
@needs_tree_write_lock
774
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
775
"""See MutableTree.set_parent_trees."""
776
parent_ids = [rev for (rev, tree) in parents_list]
777
for revision_id in parent_ids:
778
_mod_revision.check_not_reserved_id(revision_id)
780
self._check_parents_for_ghosts(parent_ids,
781
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
783
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
785
if len(parent_ids) == 0:
786
leftmost_parent_id = _mod_revision.NULL_REVISION
787
leftmost_parent_tree = None
789
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
791
if self._change_last_revision(leftmost_parent_id):
792
if leftmost_parent_tree is None:
793
# If we don't have a tree, fall back to reading the
794
# parent tree from the repository.
795
self._cache_basis_inventory(leftmost_parent_id)
797
inv = leftmost_parent_tree.inventory
798
xml = self._create_basis_xml_from_inventory(
799
leftmost_parent_id, inv)
800
self._write_basis_inventory(xml)
801
self._set_merges_from_parent_ids(parent_ids)
803
@needs_tree_write_lock
804
def set_pending_merges(self, rev_list):
805
parents = self.get_parent_ids()
806
leftmost = parents[:1]
807
new_parents = leftmost + rev_list
808
self.set_parent_ids(new_parents)
810
@needs_tree_write_lock
811
def set_merge_modified(self, modified_hashes):
813
for file_id, hash in modified_hashes.iteritems():
814
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
815
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
817
def _sha_from_stat(self, path, stat_result):
818
"""Get a sha digest from the tree's stat cache.
820
The default implementation assumes no stat cache is present.
822
:param path: The path.
823
:param stat_result: The stat result being looked up.
827
def _put_rio(self, filename, stanzas, header):
828
self._must_be_locked()
829
my_file = rio_file(stanzas, header)
830
self._transport.put_file(filename, my_file,
831
mode=self._control_files._file_mode)
833
@needs_write_lock # because merge pulls data into the branch.
834
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
836
"""Merge from a branch into this working tree.
838
:param branch: The branch to merge from.
839
:param to_revision: If non-None, the merge will merge to to_revision,
840
but not beyond it. to_revision does not need to be in the history
841
of the branch when it is supplied. If None, to_revision defaults to
842
branch.last_revision().
844
from bzrlib.merge import Merger, Merge3Merger
845
pb = bzrlib.ui.ui_factory.nested_progress_bar()
847
merger = Merger(self.branch, this_tree=self, pb=pb)
848
merger.pp = ProgressPhase("Merge phase", 5, pb)
849
merger.pp.next_phase()
850
# check that there are no
852
merger.check_basis(check_clean=True, require_commits=False)
853
if to_revision is None:
854
to_revision = _mod_revision.ensure_null(branch.last_revision())
855
merger.other_rev_id = to_revision
856
if _mod_revision.is_null(merger.other_rev_id):
857
raise errors.NoCommits(branch)
858
self.branch.fetch(branch, last_revision=merger.other_rev_id)
859
merger.other_basis = merger.other_rev_id
860
merger.other_tree = self.branch.repository.revision_tree(
862
merger.other_branch = branch
863
merger.pp.next_phase()
864
if from_revision is None:
867
merger.set_base_revision(from_revision, branch)
868
if merger.base_rev_id == merger.other_rev_id:
869
raise errors.PointlessMerge
870
merger.backup_files = False
871
if merge_type is None:
872
merger.merge_type = Merge3Merger
874
merger.merge_type = merge_type
875
merger.set_interesting_files(None)
876
merger.show_base = False
877
merger.reprocess = False
878
conflicts = merger.do_merge()
885
def merge_modified(self):
886
"""Return a dictionary of files modified by a merge.
888
The list is initialized by WorkingTree.set_merge_modified, which is
889
typically called after we make some automatic updates to the tree
892
This returns a map of file_id->sha1, containing only files which are
893
still in the working inventory and have that text hash.
896
hashfile = self._transport.get('merge-hashes')
897
except errors.NoSuchFile:
901
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
902
raise errors.MergeModifiedFormatError()
903
except StopIteration:
904
raise errors.MergeModifiedFormatError()
905
for s in RioReader(hashfile):
906
# RioReader reads in Unicode, so convert file_ids back to utf8
907
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
908
if file_id not in self.inventory:
910
text_hash = s.get("hash")
911
if text_hash == self.get_file_sha1(file_id):
912
merge_hashes[file_id] = text_hash
916
def mkdir(self, path, file_id=None):
917
"""See MutableTree.mkdir()."""
919
file_id = generate_ids.gen_file_id(os.path.basename(path))
920
os.mkdir(self.abspath(path))
921
self.add(path, file_id, 'directory')
924
def get_symlink_target(self, file_id):
925
return os.readlink(self.id2abspath(file_id))
928
def subsume(self, other_tree):
929
def add_children(inventory, entry):
930
for child_entry in entry.children.values():
931
inventory._byid[child_entry.file_id] = child_entry
932
if child_entry.kind == 'directory':
933
add_children(inventory, child_entry)
934
if other_tree.get_root_id() == self.get_root_id():
935
raise errors.BadSubsumeSource(self, other_tree,
936
'Trees have the same root')
938
other_tree_path = self.relpath(other_tree.basedir)
939
except errors.PathNotChild:
940
raise errors.BadSubsumeSource(self, other_tree,
941
'Tree is not contained by the other')
942
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
943
if new_root_parent is None:
944
raise errors.BadSubsumeSource(self, other_tree,
945
'Parent directory is not versioned.')
946
# We need to ensure that the result of a fetch will have a
947
# versionedfile for the other_tree root, and only fetching into
948
# RepositoryKnit2 guarantees that.
949
if not self.branch.repository.supports_rich_root():
950
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
951
other_tree.lock_tree_write()
953
new_parents = other_tree.get_parent_ids()
954
other_root = other_tree.inventory.root
955
other_root.parent_id = new_root_parent
956
other_root.name = osutils.basename(other_tree_path)
957
self.inventory.add(other_root)
958
add_children(self.inventory, other_root)
959
self._write_inventory(self.inventory)
960
# normally we don't want to fetch whole repositories, but i think
961
# here we really do want to consolidate the whole thing.
962
for parent_id in other_tree.get_parent_ids():
963
self.branch.fetch(other_tree.branch, parent_id)
964
self.add_parent_tree_id(parent_id)
967
other_tree.bzrdir.retire_bzrdir()
969
def _setup_directory_is_tree_reference(self):
970
if self._branch.repository._format.supports_tree_reference:
971
self._directory_is_tree_reference = \
972
self._directory_may_be_tree_reference
974
self._directory_is_tree_reference = \
975
self._directory_is_never_tree_reference
977
def _directory_is_never_tree_reference(self, relpath):
980
def _directory_may_be_tree_reference(self, relpath):
981
# as a special case, if a directory contains control files then
982
# it's a tree reference, except that the root of the tree is not
983
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
984
# TODO: We could ask all the control formats whether they
985
# recognize this directory, but at the moment there's no cheap api
986
# to do that. Since we probably can only nest bzr checkouts and
987
# they always use this name it's ok for now. -- mbp 20060306
989
# FIXME: There is an unhandled case here of a subdirectory
990
# containing .bzr but not a branch; that will probably blow up
991
# when you try to commit it. It might happen if there is a
992
# checkout in a subdirectory. This can be avoided by not adding
995
@needs_tree_write_lock
996
def extract(self, file_id, format=None):
997
"""Extract a subtree from this tree.
999
A new branch will be created, relative to the path for this tree.
1003
segments = osutils.splitpath(path)
1004
transport = self.branch.bzrdir.root_transport
1005
for name in segments:
1006
transport = transport.clone(name)
1007
transport.ensure_base()
1010
sub_path = self.id2path(file_id)
1011
branch_transport = mkdirs(sub_path)
1013
format = self.bzrdir.cloning_metadir()
1014
branch_transport.ensure_base()
1015
branch_bzrdir = format.initialize_on_transport(branch_transport)
1017
repo = branch_bzrdir.find_repository()
1018
except errors.NoRepositoryPresent:
1019
repo = branch_bzrdir.create_repository()
1020
if not repo.supports_rich_root():
1021
raise errors.RootNotRich()
1022
new_branch = branch_bzrdir.create_branch()
1023
new_branch.pull(self.branch)
1024
for parent_id in self.get_parent_ids():
1025
new_branch.fetch(self.branch, parent_id)
1026
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1027
if tree_transport.base != branch_transport.base:
1028
tree_bzrdir = format.initialize_on_transport(tree_transport)
1029
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1031
tree_bzrdir = branch_bzrdir
1032
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1033
wt.set_parent_ids(self.get_parent_ids())
1034
my_inv = self.inventory
1035
child_inv = Inventory(root_id=None)
1036
new_root = my_inv[file_id]
1037
my_inv.remove_recursive_id(file_id)
1038
new_root.parent_id = None
1039
child_inv.add(new_root)
1040
self._write_inventory(my_inv)
1041
wt._write_inventory(child_inv)
1044
def _serialize(self, inventory, out_file):
1045
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1048
def _deserialize(selt, in_file):
1049
return xml5.serializer_v5.read_inventory(in_file)
1052
"""Write the in memory inventory to disk."""
1053
# TODO: Maybe this should only write on dirty ?
1054
if self._control_files._lock_mode != 'w':
1055
raise errors.NotWriteLocked(self)
1057
self._serialize(self._inventory, sio)
1059
self._transport.put_file('inventory', sio,
1060
mode=self._control_files._file_mode)
1061
self._inventory_is_modified = False
1063
def _kind(self, relpath):
1064
return osutils.file_kind(self.abspath(relpath))
1066
def list_files(self, include_root=False):
1067
"""Recursively list all files as (path, class, kind, id, entry).
1069
Lists, but does not descend into unversioned directories.
1071
This does not include files that have been deleted in this
1074
Skips the control directory.
1076
# list_files is an iterator, so @needs_read_lock doesn't work properly
1077
# with it. So callers should be careful to always read_lock the tree.
1078
if not self.is_locked():
1079
raise errors.ObjectNotLocked(self)
1081
inv = self.inventory
1082
if include_root is True:
1083
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1084
# Convert these into local objects to save lookup times
1085
pathjoin = osutils.pathjoin
1086
file_kind = self._kind
1088
# transport.base ends in a slash, we want the piece
1089
# between the last two slashes
1090
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1092
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1094
# directory file_id, relative path, absolute path, reverse sorted children
1095
children = os.listdir(self.basedir)
1097
# jam 20060527 The kernel sized tree seems equivalent whether we
1098
# use a deque and popleft to keep them sorted, or if we use a plain
1099
# list and just reverse() them.
1100
children = collections.deque(children)
1101
stack = [(inv.root.file_id, u'', self.basedir, children)]
1103
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1106
f = children.popleft()
1107
## TODO: If we find a subdirectory with its own .bzr
1108
## directory, then that is a separate tree and we
1109
## should exclude it.
1111
# the bzrdir for this tree
1112
if transport_base_dir == f:
1115
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1116
# and 'f' doesn't begin with one, we can do a string op, rather
1117
# than the checks of pathjoin(), all relative paths will have an extra slash
1119
fp = from_dir_relpath + '/' + f
1122
fap = from_dir_abspath + '/' + f
1124
f_ie = inv.get_child(from_dir_id, f)
1127
elif self.is_ignored(fp[1:]):
1130
# we may not have found this file, because of a unicode issue
1131
f_norm, can_access = osutils.normalized_filename(f)
1132
if f == f_norm or not can_access:
1133
# No change, so treat this file normally
1136
# this file can be accessed by a normalized path
1137
# check again if it is versioned
1138
# these lines are repeated here for performance
1140
fp = from_dir_relpath + '/' + f
1141
fap = from_dir_abspath + '/' + f
1142
f_ie = inv.get_child(from_dir_id, f)
1145
elif self.is_ignored(fp[1:]):
1152
# make a last minute entry
1154
yield fp[1:], c, fk, f_ie.file_id, f_ie
1157
yield fp[1:], c, fk, None, fk_entries[fk]()
1159
yield fp[1:], c, fk, None, TreeEntry()
1162
if fk != 'directory':
1165
# But do this child first
1166
new_children = os.listdir(fap)
1168
new_children = collections.deque(new_children)
1169
stack.append((f_ie.file_id, fp, fap, new_children))
1170
# Break out of inner loop,
1171
# so that we start outer loop with child
1174
# if we finished all children, pop it off the stack
1177
@needs_tree_write_lock
1178
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1181
to_dir must exist in the inventory.
1183
If to_dir exists and is a directory, the files are moved into
1184
it, keeping their old names.
1186
Note that to_dir is only the last component of the new name;
1187
this doesn't change the directory.
1189
For each entry in from_paths the move mode will be determined
1192
The first mode moves the file in the filesystem and updates the
1193
inventory. The second mode only updates the inventory without
1194
touching the file on the filesystem. This is the new mode introduced
1197
move uses the second mode if 'after == True' and the target is not
1198
versioned but present in the working tree.
1200
move uses the second mode if 'after == False' and the source is
1201
versioned but no longer in the working tree, and the target is not
1202
versioned but present in the working tree.
1204
move uses the first mode if 'after == False' and the source is
1205
versioned and present in the working tree, and the target is not
1206
versioned and not present in the working tree.
1208
Everything else results in an error.
1210
This returns a list of (from_path, to_path) pairs for each
1211
entry that is moved.
1216
# check for deprecated use of signature
1218
to_dir = kwargs.get('to_name', None)
1220
raise TypeError('You must supply a target directory')
1222
symbol_versioning.warn('The parameter to_name was deprecated'
1223
' in version 0.13. Use to_dir instead',
1226
# check destination directory
1227
if isinstance(from_paths, basestring):
1229
inv = self.inventory
1230
to_abs = self.abspath(to_dir)
1231
if not isdir(to_abs):
1232
raise errors.BzrMoveFailedError('',to_dir,
1233
errors.NotADirectory(to_abs))
1234
if not self.has_filename(to_dir):
1235
raise errors.BzrMoveFailedError('',to_dir,
1236
errors.NotInWorkingDirectory(to_dir))
1237
to_dir_id = inv.path2id(to_dir)
1238
if to_dir_id is None:
1239
raise errors.BzrMoveFailedError('',to_dir,
1240
errors.NotVersionedError(path=str(to_dir)))
1242
to_dir_ie = inv[to_dir_id]
1243
if to_dir_ie.kind != 'directory':
1244
raise errors.BzrMoveFailedError('',to_dir,
1245
errors.NotADirectory(to_abs))
1247
# create rename entries and tuples
1248
for from_rel in from_paths:
1249
from_tail = splitpath(from_rel)[-1]
1250
from_id = inv.path2id(from_rel)
1252
raise errors.BzrMoveFailedError(from_rel,to_dir,
1253
errors.NotVersionedError(path=str(from_rel)))
1255
from_entry = inv[from_id]
1256
from_parent_id = from_entry.parent_id
1257
to_rel = pathjoin(to_dir, from_tail)
1258
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1260
from_tail=from_tail,
1261
from_parent_id=from_parent_id,
1262
to_rel=to_rel, to_tail=from_tail,
1263
to_parent_id=to_dir_id)
1264
rename_entries.append(rename_entry)
1265
rename_tuples.append((from_rel, to_rel))
1267
# determine which move mode to use. checks also for movability
1268
rename_entries = self._determine_mv_mode(rename_entries, after)
1270
original_modified = self._inventory_is_modified
1273
self._inventory_is_modified = True
1274
self._move(rename_entries)
1276
# restore the inventory on error
1277
self._inventory_is_modified = original_modified
1279
self._write_inventory(inv)
1280
return rename_tuples
1282
def _determine_mv_mode(self, rename_entries, after=False):
1283
"""Determines for each from-to pair if both inventory and working tree
1284
or only the inventory has to be changed.
1286
Also does basic plausability tests.
1288
inv = self.inventory
1290
for rename_entry in rename_entries:
1291
# store to local variables for easier reference
1292
from_rel = rename_entry.from_rel
1293
from_id = rename_entry.from_id
1294
to_rel = rename_entry.to_rel
1295
to_id = inv.path2id(to_rel)
1296
only_change_inv = False
1298
# check the inventory for source and destination
1300
raise errors.BzrMoveFailedError(from_rel,to_rel,
1301
errors.NotVersionedError(path=str(from_rel)))
1302
if to_id is not None:
1303
raise errors.BzrMoveFailedError(from_rel,to_rel,
1304
errors.AlreadyVersionedError(path=str(to_rel)))
1306
# try to determine the mode for rename (only change inv or change
1307
# inv and file system)
1309
if not self.has_filename(to_rel):
1310
raise errors.BzrMoveFailedError(from_id,to_rel,
1311
errors.NoSuchFile(path=str(to_rel),
1312
extra="New file has not been created yet"))
1313
only_change_inv = True
1314
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1315
only_change_inv = True
1316
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1317
only_change_inv = False
1318
elif (sys.platform == 'win32'
1319
and from_rel.lower() == to_rel.lower()
1320
and self.has_filename(from_rel)):
1321
only_change_inv = False
1323
# something is wrong, so lets determine what exactly
1324
if not self.has_filename(from_rel) and \
1325
not self.has_filename(to_rel):
1326
raise errors.BzrRenameFailedError(from_rel,to_rel,
1327
errors.PathsDoNotExist(paths=(str(from_rel),
1330
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1331
rename_entry.only_change_inv = only_change_inv
1332
return rename_entries
1334
def _move(self, rename_entries):
1335
"""Moves a list of files.
1337
Depending on the value of the flag 'only_change_inv', the
1338
file will be moved on the file system or not.
1340
inv = self.inventory
1343
for entry in rename_entries:
1345
self._move_entry(entry)
1347
self._rollback_move(moved)
1351
def _rollback_move(self, moved):
1352
"""Try to rollback a previous move in case of an filesystem error."""
1353
inv = self.inventory
1356
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1357
entry.to_tail, entry.to_parent_id, entry.from_rel,
1358
entry.from_tail, entry.from_parent_id,
1359
entry.only_change_inv))
1360
except errors.BzrMoveFailedError, e:
1361
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1362
" The working tree is in an inconsistent state."
1363
" Please consider doing a 'bzr revert'."
1364
" Error message is: %s" % e)
1366
def _move_entry(self, entry):
1367
inv = self.inventory
1368
from_rel_abs = self.abspath(entry.from_rel)
1369
to_rel_abs = self.abspath(entry.to_rel)
1370
if from_rel_abs == to_rel_abs:
1371
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1372
"Source and target are identical.")
1374
if not entry.only_change_inv:
1376
osutils.rename(from_rel_abs, to_rel_abs)
1378
raise errors.BzrMoveFailedError(entry.from_rel,
1380
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1382
@needs_tree_write_lock
1383
def rename_one(self, from_rel, to_rel, after=False):
1386
This can change the directory or the filename or both.
1388
rename_one has several 'modes' to work. First, it can rename a physical
1389
file and change the file_id. That is the normal mode. Second, it can
1390
only change the file_id without touching any physical file. This is
1391
the new mode introduced in version 0.15.
1393
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1394
versioned but present in the working tree.
1396
rename_one uses the second mode if 'after == False' and 'from_rel' is
1397
versioned but no longer in the working tree, and 'to_rel' is not
1398
versioned but present in the working tree.
1400
rename_one uses the first mode if 'after == False' and 'from_rel' is
1401
versioned and present in the working tree, and 'to_rel' is not
1402
versioned and not present in the working tree.
1404
Everything else results in an error.
1406
inv = self.inventory
1409
# create rename entries and tuples
1410
from_tail = splitpath(from_rel)[-1]
1411
from_id = inv.path2id(from_rel)
1413
raise errors.BzrRenameFailedError(from_rel,to_rel,
1414
errors.NotVersionedError(path=str(from_rel)))
1415
from_entry = inv[from_id]
1416
from_parent_id = from_entry.parent_id
1417
to_dir, to_tail = os.path.split(to_rel)
1418
to_dir_id = inv.path2id(to_dir)
1419
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1421
from_tail=from_tail,
1422
from_parent_id=from_parent_id,
1423
to_rel=to_rel, to_tail=to_tail,
1424
to_parent_id=to_dir_id)
1425
rename_entries.append(rename_entry)
1427
# determine which move mode to use. checks also for movability
1428
rename_entries = self._determine_mv_mode(rename_entries, after)
1430
# check if the target changed directory and if the target directory is
1432
if to_dir_id is None:
1433
raise errors.BzrMoveFailedError(from_rel,to_rel,
1434
errors.NotVersionedError(path=str(to_dir)))
1436
# all checks done. now we can continue with our actual work
1437
mutter('rename_one:\n'
1442
' to_dir_id {%s}\n',
1443
from_id, from_rel, to_rel, to_dir, to_dir_id)
1445
self._move(rename_entries)
1446
self._write_inventory(inv)
1448
class _RenameEntry(object):
1449
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1450
to_rel, to_tail, to_parent_id, only_change_inv=False):
1451
self.from_rel = from_rel
1452
self.from_id = from_id
1453
self.from_tail = from_tail
1454
self.from_parent_id = from_parent_id
1455
self.to_rel = to_rel
1456
self.to_tail = to_tail
1457
self.to_parent_id = to_parent_id
1458
self.only_change_inv = only_change_inv
1462
"""Return all unknown files.
1464
These are files in the working directory that are not versioned or
1465
control files or ignored.
1467
# force the extras method to be fully executed before returning, to
1468
# prevent race conditions with the lock
1470
[subp for subp in self.extras() if not self.is_ignored(subp)])
1472
@needs_tree_write_lock
1473
def unversion(self, file_ids):
1474
"""Remove the file ids in file_ids from the current versioned set.
1476
When a file_id is unversioned, all of its children are automatically
1479
:param file_ids: The file ids to stop versioning.
1480
:raises: NoSuchId if any fileid is not currently versioned.
1482
for file_id in file_ids:
1483
if self._inventory.has_id(file_id):
1484
self._inventory.remove_recursive_id(file_id)
1486
raise errors.NoSuchId(self, file_id)
1488
# in the future this should just set a dirty bit to wait for the
1489
# final unlock. However, until all methods of workingtree start
1490
# with the current in -memory inventory rather than triggering
1491
# a read, it is more complex - we need to teach read_inventory
1492
# to know when to read, and when to not read first... and possibly
1493
# to save first when the in memory one may be corrupted.
1494
# so for now, we just only write it if it is indeed dirty.
1496
self._write_inventory(self._inventory)
1498
def _iter_conflicts(self):
1500
for info in self.list_files():
1502
stem = get_conflicted_stem(path)
1505
if stem not in conflicted:
1506
conflicted.add(stem)
1510
def pull(self, source, overwrite=False, stop_revision=None,
1511
change_reporter=None, possible_transports=None):
1512
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1515
pp = ProgressPhase("Pull phase", 2, top_pb)
1517
old_revision_info = self.branch.last_revision_info()
1518
basis_tree = self.basis_tree()
1519
count = self.branch.pull(source, overwrite, stop_revision,
1520
possible_transports=possible_transports)
1521
new_revision_info = self.branch.last_revision_info()
1522
if new_revision_info != old_revision_info:
1524
repository = self.branch.repository
1525
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1526
basis_tree.lock_read()
1528
new_basis_tree = self.branch.basis_tree()
1535
change_reporter=change_reporter)
1536
if (basis_tree.inventory.root is None and
1537
new_basis_tree.inventory.root is not None):
1538
self.set_root_id(new_basis_tree.get_root_id())
1542
# TODO - dedup parents list with things merged by pull ?
1543
# reuse the revisiontree we merged against to set the new
1545
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1546
# we have to pull the merge trees out again, because
1547
# merge_inner has set the ids. - this corner is not yet
1548
# layered well enough to prevent double handling.
1549
# XXX TODO: Fix the double handling: telling the tree about
1550
# the already known parent data is wasteful.
1551
merges = self.get_parent_ids()[1:]
1552
parent_trees.extend([
1553
(parent, repository.revision_tree(parent)) for
1555
self.set_parent_trees(parent_trees)
1562
def put_file_bytes_non_atomic(self, file_id, bytes):
1563
"""See MutableTree.put_file_bytes_non_atomic."""
1564
stream = file(self.id2abspath(file_id), 'wb')
1569
# TODO: update the hashcache here ?
1572
"""Yield all unversioned files in this WorkingTree.
1574
If there are any unversioned directories then only the directory is
1575
returned, not all its children. But if there are unversioned files
1576
under a versioned subdirectory, they are returned.
1578
Currently returned depth-first, sorted by name within directories.
1579
This is the same order used by 'osutils.walkdirs'.
1581
## TODO: Work from given directory downwards
1582
for path, dir_entry in self.inventory.directories():
1583
# mutter("search for unknowns in %r", path)
1584
dirabs = self.abspath(path)
1585
if not isdir(dirabs):
1586
# e.g. directory deleted
1590
for subf in os.listdir(dirabs):
1593
if subf not in dir_entry.children:
1594
subf_norm, can_access = osutils.normalized_filename(subf)
1595
if subf_norm != subf and can_access:
1596
if subf_norm not in dir_entry.children:
1597
fl.append(subf_norm)
1603
subp = pathjoin(path, subf)
1606
def ignored_files(self):
1607
"""Yield list of PATH, IGNORE_PATTERN"""
1608
for subp in self.extras():
1609
pat = self.is_ignored(subp)
1613
def get_ignore_list(self):
1614
"""Return list of ignore patterns.
1616
Cached in the Tree object after the first call.
1618
ignoreset = getattr(self, '_ignoreset', None)
1619
if ignoreset is not None:
1622
ignore_globs = set()
1623
ignore_globs.update(ignores.get_runtime_ignores())
1624
ignore_globs.update(ignores.get_user_ignores())
1625
if self.has_filename(bzrlib.IGNORE_FILENAME):
1626
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1628
ignore_globs.update(ignores.parse_ignore_file(f))
1631
self._ignoreset = ignore_globs
1634
def _flush_ignore_list_cache(self):
1635
"""Resets the cached ignore list to force a cache rebuild."""
1636
self._ignoreset = None
1637
self._ignoreglobster = None
1639
def is_ignored(self, filename):
1640
r"""Check whether the filename matches an ignore pattern.
1642
Patterns containing '/' or '\' need to match the whole path;
1643
others match against only the last component.
1645
If the file is ignored, returns the pattern which caused it to
1646
be ignored, otherwise None. So this can simply be used as a
1647
boolean if desired."""
1648
if getattr(self, '_ignoreglobster', None) is None:
1649
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1650
return self._ignoreglobster.match(filename)
1652
def kind(self, file_id):
1653
return file_kind(self.id2abspath(file_id))
1655
def stored_kind(self, file_id):
1656
"""See Tree.stored_kind"""
1657
return self.inventory[file_id].kind
1659
def _comparison_data(self, entry, path):
1660
abspath = self.abspath(path)
1662
stat_value = os.lstat(abspath)
1664
if getattr(e, 'errno', None) == errno.ENOENT:
1671
mode = stat_value.st_mode
1672
kind = osutils.file_kind_from_stat_mode(mode)
1673
if not supports_executable():
1674
executable = entry is not None and entry.executable
1676
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1677
return kind, executable, stat_value
1679
def _file_size(self, entry, stat_value):
1680
return stat_value.st_size
1682
def last_revision(self):
1683
"""Return the last revision of the branch for this tree.
1685
This format tree does not support a separate marker for last-revision
1686
compared to the branch.
1688
See MutableTree.last_revision
1690
return self._last_revision()
1693
def _last_revision(self):
1694
"""helper for get_parent_ids."""
1695
return _mod_revision.ensure_null(self.branch.last_revision())
1697
def is_locked(self):
1698
return self._control_files.is_locked()
1700
def _must_be_locked(self):
1701
if not self.is_locked():
1702
raise errors.ObjectNotLocked(self)
1704
def lock_read(self):
1705
"""See Branch.lock_read, and WorkingTree.unlock."""
1706
if not self.is_locked():
1708
self.branch.lock_read()
1710
return self._control_files.lock_read()
1712
self.branch.unlock()
1715
def lock_tree_write(self):
1716
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1717
if not self.is_locked():
1719
self.branch.lock_read()
1721
return self._control_files.lock_write()
1723
self.branch.unlock()
1726
def lock_write(self):
1727
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1728
if not self.is_locked():
1730
self.branch.lock_write()
1732
return self._control_files.lock_write()
1734
self.branch.unlock()
1737
def get_physical_lock_status(self):
1738
return self._control_files.get_physical_lock_status()
1740
def _basis_inventory_name(self):
1741
return 'basis-inventory-cache'
1743
def _reset_data(self):
1744
"""Reset transient data that cannot be revalidated."""
1745
self._inventory_is_modified = False
1746
result = self._deserialize(self._transport.get('inventory'))
1747
self._set_inventory(result, dirty=False)
1749
@needs_tree_write_lock
1750
def set_last_revision(self, new_revision):
1751
"""Change the last revision in the working tree."""
1752
if self._change_last_revision(new_revision):
1753
self._cache_basis_inventory(new_revision)
1755
def _change_last_revision(self, new_revision):
1756
"""Template method part of set_last_revision to perform the change.
1758
This is used to allow WorkingTree3 instances to not affect branch
1759
when their last revision is set.
1761
if _mod_revision.is_null(new_revision):
1762
self.branch.set_revision_history([])
1765
self.branch.generate_revision_history(new_revision)
1766
except errors.NoSuchRevision:
1767
# not present in the repo - dont try to set it deeper than the tip
1768
self.branch.set_revision_history([new_revision])
1771
def _write_basis_inventory(self, xml):
1772
"""Write the basis inventory XML to the basis-inventory file"""
1773
path = self._basis_inventory_name()
1775
self._transport.put_file(path, sio,
1776
mode=self._control_files._file_mode)
1778
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1779
"""Create the text that will be saved in basis-inventory"""
1780
inventory.revision_id = revision_id
1781
return xml7.serializer_v7.write_inventory_to_string(inventory)
1783
def _cache_basis_inventory(self, new_revision):
1784
"""Cache new_revision as the basis inventory."""
1785
# TODO: this should allow the ready-to-use inventory to be passed in,
1786
# as commit already has that ready-to-use [while the format is the
1789
# this double handles the inventory - unpack and repack -
1790
# but is easier to understand. We can/should put a conditional
1791
# in here based on whether the inventory is in the latest format
1792
# - perhaps we should repack all inventories on a repository
1794
# the fast path is to copy the raw xml from the repository. If the
1795
# xml contains 'revision_id="', then we assume the right
1796
# revision_id is set. We must check for this full string, because a
1797
# root node id can legitimately look like 'revision_id' but cannot
1799
xml = self.branch.repository.get_inventory_xml(new_revision)
1800
firstline = xml.split('\n', 1)[0]
1801
if (not 'revision_id="' in firstline or
1802
'format="7"' not in firstline):
1803
inv = self.branch.repository.deserialise_inventory(
1805
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1806
self._write_basis_inventory(xml)
1807
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1810
def read_basis_inventory(self):
1811
"""Read the cached basis inventory."""
1812
path = self._basis_inventory_name()
1813
return self._transport.get_bytes(path)
1816
def read_working_inventory(self):
1817
"""Read the working inventory.
1819
:raises errors.InventoryModified: read_working_inventory will fail
1820
when the current in memory inventory has been modified.
1822
# conceptually this should be an implementation detail of the tree.
1823
# XXX: Deprecate this.
1824
# ElementTree does its own conversion from UTF-8, so open in
1826
if self._inventory_is_modified:
1827
raise errors.InventoryModified(self)
1828
result = self._deserialize(self._transport.get('inventory'))
1829
self._set_inventory(result, dirty=False)
1832
@needs_tree_write_lock
1833
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1835
"""Remove nominated files from the working inventory.
1837
:files: File paths relative to the basedir.
1838
:keep_files: If true, the files will also be kept.
1839
:force: Delete files and directories, even if they are changed and
1840
even if the directories are not empty.
1842
if isinstance(files, basestring):
1848
unknown_nested_files=set()
1850
def recurse_directory_to_add_files(directory):
1851
# Recurse directory and add all files
1852
# so we can check if they have changed.
1853
for parent_info, file_infos in\
1854
osutils.walkdirs(self.abspath(directory),
1856
for relpath, basename, kind, lstat, abspath in file_infos:
1857
# Is it versioned or ignored?
1858
if self.path2id(relpath) or self.is_ignored(relpath):
1859
# Add nested content for deletion.
1860
new_files.add(relpath)
1862
# Files which are not versioned and not ignored
1863
# should be treated as unknown.
1864
unknown_nested_files.add((relpath, None, kind))
1866
for filename in files:
1867
# Get file name into canonical form.
1868
abspath = self.abspath(filename)
1869
filename = self.relpath(abspath)
1870
if len(filename) > 0:
1871
new_files.add(filename)
1872
if osutils.isdir(abspath):
1873
recurse_directory_to_add_files(filename)
1875
files = list(new_files)
1878
return # nothing to do
1880
# Sort needed to first handle directory content before the directory
1881
files.sort(reverse=True)
1883
# Bail out if we are going to delete files we shouldn't
1884
if not keep_files and not force:
1885
has_changed_files = len(unknown_nested_files) > 0
1886
if not has_changed_files:
1887
for (file_id, path, content_change, versioned, parent_id, name,
1888
kind, executable) in self.iter_changes(self.basis_tree(),
1889
include_unchanged=True, require_versioned=False,
1890
want_unversioned=True, specific_files=files):
1891
if versioned == (False, False):
1892
# The record is unknown ...
1893
if not self.is_ignored(path[1]):
1894
# ... but not ignored
1895
has_changed_files = True
1897
elif content_change and (kind[1] is not None):
1898
# Versioned and changed, but not deleted
1899
has_changed_files = True
1902
if has_changed_files:
1903
# Make delta show ALL applicable changes in error message.
1904
tree_delta = self.changes_from(self.basis_tree(),
1905
require_versioned=False, want_unversioned=True,
1906
specific_files=files)
1907
for unknown_file in unknown_nested_files:
1908
if unknown_file not in tree_delta.unversioned:
1909
tree_delta.unversioned.extend((unknown_file,))
1910
raise errors.BzrRemoveChangedFilesError(tree_delta)
1912
# Build inv_delta and delete files where applicaple,
1913
# do this before any modifications to inventory.
1915
fid = self.path2id(f)
1918
message = "%s is not versioned." % (f,)
1921
# having removed it, it must be either ignored or unknown
1922
if self.is_ignored(f):
1926
textui.show_status(new_status, self.kind(fid), f,
1929
inv_delta.append((f, None, fid, None))
1930
message = "removed %s" % (f,)
1933
abs_path = self.abspath(f)
1934
if osutils.lexists(abs_path):
1935
if (osutils.isdir(abs_path) and
1936
len(os.listdir(abs_path)) > 0):
1938
osutils.rmtree(abs_path)
1940
message = "%s is not an empty directory "\
1941
"and won't be deleted." % (f,)
1943
osutils.delete_any(abs_path)
1944
message = "deleted %s" % (f,)
1945
elif message is not None:
1946
# Only care if we haven't done anything yet.
1947
message = "%s does not exist." % (f,)
1949
# Print only one message (if any) per file.
1950
if message is not None:
1952
self.apply_inventory_delta(inv_delta)
1954
@needs_tree_write_lock
1955
def revert(self, filenames=None, old_tree=None, backups=True,
1956
pb=DummyProgress(), report_changes=False):
1957
from bzrlib.conflicts import resolve
1960
symbol_versioning.warn('Using [] to revert all files is deprecated'
1961
' as of bzr 0.91. Please use None (the default) instead.',
1962
DeprecationWarning, stacklevel=2)
1963
if old_tree is None:
1964
basis_tree = self.basis_tree()
1965
basis_tree.lock_read()
1966
old_tree = basis_tree
1970
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1972
if filenames is None and len(self.get_parent_ids()) > 1:
1974
last_revision = self.last_revision()
1975
if last_revision != NULL_REVISION:
1976
if basis_tree is None:
1977
basis_tree = self.basis_tree()
1978
basis_tree.lock_read()
1979
parent_trees.append((last_revision, basis_tree))
1980
self.set_parent_trees(parent_trees)
1983
resolve(self, filenames, ignore_misses=True, recursive=True)
1985
if basis_tree is not None:
1989
def revision_tree(self, revision_id):
1990
"""See Tree.revision_tree.
1992
WorkingTree can supply revision_trees for the basis revision only
1993
because there is only one cached inventory in the bzr directory.
1995
if revision_id == self.last_revision():
1997
xml = self.read_basis_inventory()
1998
except errors.NoSuchFile:
2002
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2003
# dont use the repository revision_tree api because we want
2004
# to supply the inventory.
2005
if inv.revision_id == revision_id:
2006
return revisiontree.RevisionTree(self.branch.repository,
2008
except errors.BadInventoryFormat:
2010
# raise if there was no inventory, or if we read the wrong inventory.
2011
raise errors.NoSuchRevisionInTree(self, revision_id)
2013
# XXX: This method should be deprecated in favour of taking in a proper
2014
# new Inventory object.
2015
@needs_tree_write_lock
2016
def set_inventory(self, new_inventory_list):
2017
from bzrlib.inventory import (Inventory,
2022
inv = Inventory(self.get_root_id())
2023
for path, file_id, parent, kind in new_inventory_list:
2024
name = os.path.basename(path)
2027
# fixme, there should be a factory function inv,add_??
2028
if kind == 'directory':
2029
inv.add(InventoryDirectory(file_id, name, parent))
2030
elif kind == 'file':
2031
inv.add(InventoryFile(file_id, name, parent))
2032
elif kind == 'symlink':
2033
inv.add(InventoryLink(file_id, name, parent))
2035
raise errors.BzrError("unknown kind %r" % kind)
2036
self._write_inventory(inv)
2038
@needs_tree_write_lock
2039
def set_root_id(self, file_id):
2040
"""Set the root id for this tree."""
2044
'WorkingTree.set_root_id with fileid=None')
2045
file_id = osutils.safe_file_id(file_id)
2046
self._set_root_id(file_id)
2048
def _set_root_id(self, file_id):
2049
"""Set the root id for this tree, in a format specific manner.
2051
:param file_id: The file id to assign to the root. It must not be
2052
present in the current inventory or an error will occur. It must
2053
not be None, but rather a valid file id.
2055
inv = self._inventory
2056
orig_root_id = inv.root.file_id
2057
# TODO: it might be nice to exit early if there was nothing
2058
# to do, saving us from trigger a sync on unlock.
2059
self._inventory_is_modified = True
2060
# we preserve the root inventory entry object, but
2061
# unlinkit from the byid index
2062
del inv._byid[inv.root.file_id]
2063
inv.root.file_id = file_id
2064
# and link it into the index with the new changed id.
2065
inv._byid[inv.root.file_id] = inv.root
2066
# and finally update all children to reference the new id.
2067
# XXX: this should be safe to just look at the root.children
2068
# list, not the WHOLE INVENTORY.
2071
if entry.parent_id == orig_root_id:
2072
entry.parent_id = inv.root.file_id
2075
"""See Branch.unlock.
2077
WorkingTree locking just uses the Branch locking facilities.
2078
This is current because all working trees have an embedded branch
2079
within them. IF in the future, we were to make branch data shareable
2080
between multiple working trees, i.e. via shared storage, then we
2081
would probably want to lock both the local tree, and the branch.
2083
raise NotImplementedError(self.unlock)
2085
def update(self, change_reporter=None, possible_transports=None):
2086
"""Update a working tree along its branch.
2088
This will update the branch if its bound too, which means we have
2089
multiple trees involved:
2091
- The new basis tree of the master.
2092
- The old basis tree of the branch.
2093
- The old basis tree of the working tree.
2094
- The current working tree state.
2096
Pathologically, all three may be different, and non-ancestors of each
2097
other. Conceptually we want to:
2099
- Preserve the wt.basis->wt.state changes
2100
- Transform the wt.basis to the new master basis.
2101
- Apply a merge of the old branch basis to get any 'local' changes from
2103
- Restore the wt.basis->wt.state changes.
2105
There isn't a single operation at the moment to do that, so we:
2106
- Merge current state -> basis tree of the master w.r.t. the old tree
2108
- Do a 'normal' merge of the old branch basis if it is relevant.
2110
if self.branch.get_bound_location() is not None:
2112
update_branch = True
2114
self.lock_tree_write()
2115
update_branch = False
2118
old_tip = self.branch.update(possible_transports)
2121
return self._update_tree(old_tip, change_reporter)
2125
@needs_tree_write_lock
2126
def _update_tree(self, old_tip=None, change_reporter=None):
2127
"""Update a tree to the master branch.
2129
:param old_tip: if supplied, the previous tip revision the branch,
2130
before it was changed to the master branch's tip.
2132
# here if old_tip is not None, it is the old tip of the branch before
2133
# it was updated from the master branch. This should become a pending
2134
# merge in the working tree to preserve the user existing work. we
2135
# cant set that until we update the working trees last revision to be
2136
# one from the new branch, because it will just get absorbed by the
2137
# parent de-duplication logic.
2139
# We MUST save it even if an error occurs, because otherwise the users
2140
# local work is unreferenced and will appear to have been lost.
2144
last_rev = self.get_parent_ids()[0]
2146
last_rev = _mod_revision.NULL_REVISION
2147
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2148
# merge tree state up to new branch tip.
2149
basis = self.basis_tree()
2152
to_tree = self.branch.basis_tree()
2153
if basis.inventory.root is None:
2154
self.set_root_id(to_tree.get_root_id())
2156
result += merge.merge_inner(
2161
change_reporter=change_reporter)
2164
# TODO - dedup parents list with things merged by pull ?
2165
# reuse the tree we've updated to to set the basis:
2166
parent_trees = [(self.branch.last_revision(), to_tree)]
2167
merges = self.get_parent_ids()[1:]
2168
# Ideally we ask the tree for the trees here, that way the working
2169
# tree can decide whether to give us teh entire tree or give us a
2170
# lazy initialised tree. dirstate for instance will have the trees
2171
# in ram already, whereas a last-revision + basis-inventory tree
2172
# will not, but also does not need them when setting parents.
2173
for parent in merges:
2174
parent_trees.append(
2175
(parent, self.branch.repository.revision_tree(parent)))
2176
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2177
parent_trees.append(
2178
(old_tip, self.branch.repository.revision_tree(old_tip)))
2179
self.set_parent_trees(parent_trees)
2180
last_rev = parent_trees[0][0]
2182
# the working tree had the same last-revision as the master
2183
# branch did. We may still have pivot local work from the local
2184
# branch into old_tip:
2185
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2186
self.add_parent_tree_id(old_tip)
2187
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2188
and old_tip != last_rev):
2189
# our last revision was not the prior branch last revision
2190
# and we have converted that last revision to a pending merge.
2191
# base is somewhere between the branch tip now
2192
# and the now pending merge
2194
# Since we just modified the working tree and inventory, flush out
2195
# the current state, before we modify it again.
2196
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2197
# requires it only because TreeTransform directly munges the
2198
# inventory and calls tree._write_inventory(). Ultimately we
2199
# should be able to remove this extra flush.
2201
graph = self.branch.repository.get_graph()
2202
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2204
base_tree = self.branch.repository.revision_tree(base_rev_id)
2205
other_tree = self.branch.repository.revision_tree(old_tip)
2206
result += merge.merge_inner(
2211
change_reporter=change_reporter)
2214
def _write_hashcache_if_dirty(self):
2215
"""Write out the hashcache if it is dirty."""
2216
if self._hashcache.needs_write:
2218
self._hashcache.write()
2220
if e.errno not in (errno.EPERM, errno.EACCES):
2222
# TODO: jam 20061219 Should this be a warning? A single line
2223
# warning might be sufficient to let the user know what
2225
mutter('Could not write hashcache for %s\nError: %s',
2226
self._hashcache.cache_file_name(), e)
2228
@needs_tree_write_lock
2229
def _write_inventory(self, inv):
2230
"""Write inventory as the current inventory."""
2231
self._set_inventory(inv, dirty=True)
2234
def set_conflicts(self, arg):
2235
raise errors.UnsupportedOperation(self.set_conflicts, self)
2237
def add_conflicts(self, arg):
2238
raise errors.UnsupportedOperation(self.add_conflicts, self)
2241
def conflicts(self):
2242
conflicts = _mod_conflicts.ConflictList()
2243
for conflicted in self._iter_conflicts():
2246
if file_kind(self.abspath(conflicted)) != "file":
2248
except errors.NoSuchFile:
2251
for suffix in ('.THIS', '.OTHER'):
2253
kind = file_kind(self.abspath(conflicted+suffix))
2256
except errors.NoSuchFile:
2260
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2261
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2263
file_id=self.path2id(conflicted)))
2266
def walkdirs(self, prefix=""):
2267
"""Walk the directories of this tree.
2269
returns a generator which yields items in the form:
2270
((curren_directory_path, fileid),
2271
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2274
This API returns a generator, which is only valid during the current
2275
tree transaction - within a single lock_read or lock_write duration.
2277
If the tree is not locked, it may cause an error to be raised,
2278
depending on the tree implementation.
2280
disk_top = self.abspath(prefix)
2281
if disk_top.endswith('/'):
2282
disk_top = disk_top[:-1]
2283
top_strip_len = len(disk_top) + 1
2284
inventory_iterator = self._walkdirs(prefix)
2285
disk_iterator = osutils.walkdirs(disk_top, prefix)
2287
current_disk = disk_iterator.next()
2288
disk_finished = False
2290
if not (e.errno == errno.ENOENT or
2291
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2294
disk_finished = True
2296
current_inv = inventory_iterator.next()
2297
inv_finished = False
2298
except StopIteration:
2301
while not inv_finished or not disk_finished:
2303
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2304
cur_disk_dir_content) = current_disk
2306
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2307
cur_disk_dir_content) = ((None, None), None)
2308
if not disk_finished:
2309
# strip out .bzr dirs
2310
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2311
len(cur_disk_dir_content) > 0):
2312
# osutils.walkdirs can be made nicer -
2313
# yield the path-from-prefix rather than the pathjoined
2315
bzrdir_loc = bisect_left(cur_disk_dir_content,
2317
if cur_disk_dir_content[bzrdir_loc][0] == '.bzr':
2318
# we dont yield the contents of, or, .bzr itself.
2319
del cur_disk_dir_content[bzrdir_loc]
2321
# everything is unknown
2324
# everything is missing
2327
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2329
# disk is before inventory - unknown
2330
dirblock = [(relpath, basename, kind, stat, None, None) for
2331
relpath, basename, kind, stat, top_path in
2332
cur_disk_dir_content]
2333
yield (cur_disk_dir_relpath, None), dirblock
2335
current_disk = disk_iterator.next()
2336
except StopIteration:
2337
disk_finished = True
2339
# inventory is before disk - missing.
2340
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2341
for relpath, basename, dkind, stat, fileid, kind in
2343
yield (current_inv[0][0], current_inv[0][1]), dirblock
2345
current_inv = inventory_iterator.next()
2346
except StopIteration:
2349
# versioned present directory
2350
# merge the inventory and disk data together
2352
for relpath, subiterator in itertools.groupby(sorted(
2353
current_inv[1] + cur_disk_dir_content,
2354
key=operator.itemgetter(0)), operator.itemgetter(1)):
2355
path_elements = list(subiterator)
2356
if len(path_elements) == 2:
2357
inv_row, disk_row = path_elements
2358
# versioned, present file
2359
dirblock.append((inv_row[0],
2360
inv_row[1], disk_row[2],
2361
disk_row[3], inv_row[4],
2363
elif len(path_elements[0]) == 5:
2365
dirblock.append((path_elements[0][0],
2366
path_elements[0][1], path_elements[0][2],
2367
path_elements[0][3], None, None))
2368
elif len(path_elements[0]) == 6:
2369
# versioned, absent file.
2370
dirblock.append((path_elements[0][0],
2371
path_elements[0][1], 'unknown', None,
2372
path_elements[0][4], path_elements[0][5]))
2374
raise NotImplementedError('unreachable code')
2375
yield current_inv[0], dirblock
2377
current_inv = inventory_iterator.next()
2378
except StopIteration:
2381
current_disk = disk_iterator.next()
2382
except StopIteration:
2383
disk_finished = True
2385
def _walkdirs(self, prefix=""):
2386
"""Walk the directories of this tree.
2388
:prefix: is used as the directrory to start with.
2389
returns a generator which yields items in the form:
2390
((curren_directory_path, fileid),
2391
[(file1_path, file1_name, file1_kind, None, file1_id,
2394
_directory = 'directory'
2395
# get the root in the inventory
2396
inv = self.inventory
2397
top_id = inv.path2id(prefix)
2401
pending = [(prefix, '', _directory, None, top_id, None)]
2404
currentdir = pending.pop()
2405
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2406
top_id = currentdir[4]
2408
relroot = currentdir[0] + '/'
2411
# FIXME: stash the node in pending
2413
for name, child in entry.sorted_children():
2414
dirblock.append((relroot + name, name, child.kind, None,
2415
child.file_id, child.kind
2417
yield (currentdir[0], entry.file_id), dirblock
2418
# push the user specified dirs from dirblock
2419
for dir in reversed(dirblock):
2420
if dir[2] == _directory:
2423
@needs_tree_write_lock
2424
def auto_resolve(self):
2425
"""Automatically resolve text conflicts according to contents.
2427
Only text conflicts are auto_resolvable. Files with no conflict markers
2428
are considered 'resolved', because bzr always puts conflict markers
2429
into files that have text conflicts. The corresponding .THIS .BASE and
2430
.OTHER files are deleted, as per 'resolve'.
2431
:return: a tuple of ConflictLists: (un_resolved, resolved).
2433
un_resolved = _mod_conflicts.ConflictList()
2434
resolved = _mod_conflicts.ConflictList()
2435
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2436
for conflict in self.conflicts():
2437
if (conflict.typestring != 'text conflict' or
2438
self.kind(conflict.file_id) != 'file'):
2439
un_resolved.append(conflict)
2441
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2443
for line in my_file:
2444
if conflict_re.search(line):
2445
un_resolved.append(conflict)
2448
resolved.append(conflict)
2451
resolved.remove_files(self)
2452
self.set_conflicts(un_resolved)
2453
return un_resolved, resolved
2455
def _validate(self):
2456
"""Validate internal structures.
2458
This is meant mostly for the test suite. To give it a chance to detect
2459
corruption after actions have occurred. The default implementation is a
2462
:return: None. An exception should be raised if there is an error.
2467
class WorkingTree2(WorkingTree):
2468
"""This is the Format 2 working tree.
2470
This was the first weave based working tree.
2471
- uses os locks for locking.
2472
- uses the branch last-revision.
2475
def __init__(self, *args, **kwargs):
2476
super(WorkingTree2, self).__init__(*args, **kwargs)
2477
# WorkingTree2 has more of a constraint that self._inventory must
2478
# exist. Because this is an older format, we don't mind the overhead
2479
# caused by the extra computation here.
2481
# Newer WorkingTree's should only have self._inventory set when they
2483
if self._inventory is None:
2484
self.read_working_inventory()
2486
def lock_tree_write(self):
2487
"""See WorkingTree.lock_tree_write().
2489
In Format2 WorkingTrees we have a single lock for the branch and tree
2490
so lock_tree_write() degrades to lock_write().
2492
self.branch.lock_write()
2494
return self._control_files.lock_write()
2496
self.branch.unlock()
2500
# do non-implementation specific cleanup
2503
# we share control files:
2504
if self._control_files._lock_count == 3:
2505
# _inventory_is_modified is always False during a read lock.
2506
if self._inventory_is_modified:
2508
self._write_hashcache_if_dirty()
2510
# reverse order of locking.
2512
return self._control_files.unlock()
2514
self.branch.unlock()
2517
class WorkingTree3(WorkingTree):
2518
"""This is the Format 3 working tree.
2520
This differs from the base WorkingTree by:
2521
- having its own file lock
2522
- having its own last-revision property.
2524
This is new in bzr 0.8
2528
def _last_revision(self):
2529
"""See Mutable.last_revision."""
2531
return self._transport.get_bytes('last-revision')
2532
except errors.NoSuchFile:
2533
return _mod_revision.NULL_REVISION
2535
def _change_last_revision(self, revision_id):
2536
"""See WorkingTree._change_last_revision."""
2537
if revision_id is None or revision_id == NULL_REVISION:
2539
self._transport.delete('last-revision')
2540
except errors.NoSuchFile:
2544
self._transport.put_bytes('last-revision', revision_id,
2545
mode=self._control_files._file_mode)
2548
@needs_tree_write_lock
2549
def set_conflicts(self, conflicts):
2550
self._put_rio('conflicts', conflicts.to_stanzas(),
2553
@needs_tree_write_lock
2554
def add_conflicts(self, new_conflicts):
2555
conflict_set = set(self.conflicts())
2556
conflict_set.update(set(list(new_conflicts)))
2557
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2558
key=_mod_conflicts.Conflict.sort_key)))
2561
def conflicts(self):
2563
confile = self._transport.get('conflicts')
2564
except errors.NoSuchFile:
2565
return _mod_conflicts.ConflictList()
2567
if confile.next() != CONFLICT_HEADER_1 + '\n':
2568
raise errors.ConflictFormatError()
2569
except StopIteration:
2570
raise errors.ConflictFormatError()
2571
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2574
# do non-implementation specific cleanup
2576
if self._control_files._lock_count == 1:
2577
# _inventory_is_modified is always False during a read lock.
2578
if self._inventory_is_modified:
2580
self._write_hashcache_if_dirty()
2581
# reverse order of locking.
2583
return self._control_files.unlock()
2585
self.branch.unlock()
2588
def get_conflicted_stem(path):
2589
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2590
if path.endswith(suffix):
2591
return path[:-len(suffix)]
2594
class WorkingTreeFormat(object):
2595
"""An encapsulation of the initialization and open routines for a format.
2597
Formats provide three things:
2598
* An initialization routine,
2602
Formats are placed in an dict by their format string for reference
2603
during workingtree opening. Its not required that these be instances, they
2604
can be classes themselves with class methods - it simply depends on
2605
whether state is needed for a given format or not.
2607
Once a format is deprecated, just deprecate the initialize and open
2608
methods on the format class. Do not deprecate the object, as the
2609
object will be created every time regardless.
2612
_default_format = None
2613
"""The default format used for new trees."""
2616
"""The known formats."""
2618
requires_rich_root = False
2620
upgrade_recommended = False
2623
def find_format(klass, a_bzrdir):
2624
"""Return the format for the working tree object in a_bzrdir."""
2626
transport = a_bzrdir.get_workingtree_transport(None)
2627
format_string = transport.get("format").read()
2628
return klass._formats[format_string]
2629
except errors.NoSuchFile:
2630
raise errors.NoWorkingTree(base=transport.base)
2632
raise errors.UnknownFormatError(format=format_string,
2633
kind="working tree")
2635
def __eq__(self, other):
2636
return self.__class__ is other.__class__
2638
def __ne__(self, other):
2639
return not (self == other)
2642
def get_default_format(klass):
2643
"""Return the current default format."""
2644
return klass._default_format
2646
def get_format_string(self):
2647
"""Return the ASCII format string that identifies this format."""
2648
raise NotImplementedError(self.get_format_string)
2650
def get_format_description(self):
2651
"""Return the short description for this format."""
2652
raise NotImplementedError(self.get_format_description)
2654
def is_supported(self):
2655
"""Is this format supported?
2657
Supported formats can be initialized and opened.
2658
Unsupported formats may not support initialization or committing or
2659
some other features depending on the reason for not being supported.
2664
def register_format(klass, format):
2665
klass._formats[format.get_format_string()] = format
2668
def set_default_format(klass, format):
2669
klass._default_format = format
2672
def unregister_format(klass, format):
2673
del klass._formats[format.get_format_string()]
2676
class WorkingTreeFormat2(WorkingTreeFormat):
2677
"""The second working tree format.
2679
This format modified the hash cache from the format 1 hash cache.
2682
upgrade_recommended = True
2684
def get_format_description(self):
2685
"""See WorkingTreeFormat.get_format_description()."""
2686
return "Working tree format 2"
2688
def _stub_initialize_remote(self, branch):
2689
"""As a special workaround create critical control files for a remote working tree.
2691
This ensures that it can later be updated and dealt with locally,
2692
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2693
no working tree. (See bug #43064).
2697
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2699
branch._transport.put_file('inventory', sio,
2700
mode=branch.control_files._file_mode)
2701
branch._transport.put_bytes('pending-merges', '',
2702
mode=branch.control_files._file_mode)
2705
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2706
accelerator_tree=None, hardlink=False):
2707
"""See WorkingTreeFormat.initialize()."""
2708
if not isinstance(a_bzrdir.transport, LocalTransport):
2709
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2710
if from_branch is not None:
2711
branch = from_branch
2713
branch = a_bzrdir.open_branch()
2714
if revision_id is None:
2715
revision_id = _mod_revision.ensure_null(branch.last_revision())
2718
branch.generate_revision_history(revision_id)
2722
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2728
basis_tree = branch.repository.revision_tree(revision_id)
2729
if basis_tree.inventory.root is not None:
2730
wt.set_root_id(basis_tree.get_root_id())
2731
# set the parent list and cache the basis tree.
2732
if _mod_revision.is_null(revision_id):
2735
parent_trees = [(revision_id, basis_tree)]
2736
wt.set_parent_trees(parent_trees)
2737
transform.build_tree(basis_tree, wt)
2741
super(WorkingTreeFormat2, self).__init__()
2742
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2744
def open(self, a_bzrdir, _found=False):
2745
"""Return the WorkingTree object for a_bzrdir
2747
_found is a private parameter, do not use it. It is used to indicate
2748
if format probing has already been done.
2751
# we are being called directly and must probe.
2752
raise NotImplementedError
2753
if not isinstance(a_bzrdir.transport, LocalTransport):
2754
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2755
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2761
class WorkingTreeFormat3(WorkingTreeFormat):
2762
"""The second working tree format updated to record a format marker.
2765
- exists within a metadir controlling .bzr
2766
- includes an explicit version marker for the workingtree control
2767
files, separate from the BzrDir format
2768
- modifies the hash cache format
2770
- uses a LockDir to guard access for writes.
2773
upgrade_recommended = True
2775
def get_format_string(self):
2776
"""See WorkingTreeFormat.get_format_string()."""
2777
return "Bazaar-NG Working Tree format 3"
2779
def get_format_description(self):
2780
"""See WorkingTreeFormat.get_format_description()."""
2781
return "Working tree format 3"
2783
_lock_file_name = 'lock'
2784
_lock_class = LockDir
2786
_tree_class = WorkingTree3
2788
def __get_matchingbzrdir(self):
2789
return bzrdir.BzrDirMetaFormat1()
2791
_matchingbzrdir = property(__get_matchingbzrdir)
2793
def _open_control_files(self, a_bzrdir):
2794
transport = a_bzrdir.get_workingtree_transport(None)
2795
return LockableFiles(transport, self._lock_file_name,
2798
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2799
accelerator_tree=None, hardlink=False):
2800
"""See WorkingTreeFormat.initialize().
2802
:param revision_id: if supplied, create a working tree at a different
2803
revision than the branch is at.
2804
:param accelerator_tree: A tree which can be used for retrieving file
2805
contents more quickly than the revision tree, i.e. a workingtree.
2806
The revision tree will be used for cases where accelerator_tree's
2807
content is different.
2808
:param hardlink: If true, hard-link files from accelerator_tree,
2811
if not isinstance(a_bzrdir.transport, LocalTransport):
2812
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2813
transport = a_bzrdir.get_workingtree_transport(self)
2814
control_files = self._open_control_files(a_bzrdir)
2815
control_files.create_lock()
2816
control_files.lock_write()
2817
transport.put_bytes('format', self.get_format_string(),
2818
mode=control_files._file_mode)
2819
if from_branch is not None:
2820
branch = from_branch
2822
branch = a_bzrdir.open_branch()
2823
if revision_id is None:
2824
revision_id = _mod_revision.ensure_null(branch.last_revision())
2825
# WorkingTree3 can handle an inventory which has a unique root id.
2826
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2827
# those trees. And because there isn't a format bump inbetween, we
2828
# are maintaining compatibility with older clients.
2829
# inv = Inventory(root_id=gen_root_id())
2830
inv = self._initial_inventory()
2831
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2837
_control_files=control_files)
2838
wt.lock_tree_write()
2840
basis_tree = branch.repository.revision_tree(revision_id)
2841
# only set an explicit root id if there is one to set.
2842
if basis_tree.inventory.root is not None:
2843
wt.set_root_id(basis_tree.get_root_id())
2844
if revision_id == NULL_REVISION:
2845
wt.set_parent_trees([])
2847
wt.set_parent_trees([(revision_id, basis_tree)])
2848
transform.build_tree(basis_tree, wt)
2850
# Unlock in this order so that the unlock-triggers-flush in
2851
# WorkingTree is given a chance to fire.
2852
control_files.unlock()
2856
def _initial_inventory(self):
2860
super(WorkingTreeFormat3, self).__init__()
2862
def open(self, a_bzrdir, _found=False):
2863
"""Return the WorkingTree object for a_bzrdir
2865
_found is a private parameter, do not use it. It is used to indicate
2866
if format probing has already been done.
2869
# we are being called directly and must probe.
2870
raise NotImplementedError
2871
if not isinstance(a_bzrdir.transport, LocalTransport):
2872
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2873
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2876
def _open(self, a_bzrdir, control_files):
2877
"""Open the tree itself.
2879
:param a_bzrdir: the dir for the tree.
2880
:param control_files: the control files for the tree.
2882
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2886
_control_files=control_files)
2889
return self.get_format_string()
2892
__default_format = WorkingTreeFormat4()
2893
WorkingTreeFormat.register_format(__default_format)
2894
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2895
WorkingTreeFormat.set_default_format(__default_format)
2896
# formats which have no format string are not discoverable
2897
# and not independently creatable, so are not registered.
2898
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
