1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 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()
249
self._rules_searcher = None
251
def _detect_case_handling(self):
252
wt_trans = self.bzrdir.get_workingtree_transport(None)
254
wt_trans.stat("FoRMaT")
255
except errors.NoSuchFile:
256
self.case_sensitive = True
258
self.case_sensitive = False
260
self._setup_directory_is_tree_reference()
263
fget=lambda self: self._branch,
264
doc="""The branch this WorkingTree is connected to.
266
This cannot be set - it is reflective of the actual disk structure
267
the working tree has been constructed from.
270
def break_lock(self):
271
"""Break a lock if one is present from another instance.
273
Uses the ui factory to ask for confirmation if the lock may be from
276
This will probe the repository for its lock as well.
278
self._control_files.break_lock()
279
self.branch.break_lock()
281
def requires_rich_root(self):
282
return self._format.requires_rich_root
284
def supports_tree_reference(self):
287
def _set_inventory(self, inv, dirty):
288
"""Set the internal cached inventory.
290
:param inv: The inventory to set.
291
:param dirty: A boolean indicating whether the inventory is the same
292
logical inventory as whats on disk. If True the inventory is not
293
the same and should be written to disk or data will be lost, if
294
False then the inventory is the same as that on disk and any
295
serialisation would be unneeded overhead.
297
self._inventory = inv
298
self._inventory_is_modified = dirty
301
def open(path=None, _unsupported=False):
302
"""Open an existing working tree at path.
306
path = osutils.getcwd()
307
control = bzrdir.BzrDir.open(path, _unsupported)
308
return control.open_workingtree(_unsupported)
311
def open_containing(path=None):
312
"""Open an existing working tree which has its root about path.
314
This probes for a working tree at path and searches upwards from there.
316
Basically we keep looking up until we find the control directory or
317
run into /. If there isn't one, raises NotBranchError.
318
TODO: give this a new exception.
319
If there is one, it is returned, along with the unused portion of path.
321
:return: The WorkingTree that contains 'path', and the rest of path
324
path = osutils.getcwd()
325
control, relpath = bzrdir.BzrDir.open_containing(path)
327
return control.open_workingtree(), relpath
330
def open_downlevel(path=None):
331
"""Open an unsupported working tree.
333
Only intended for advanced situations like upgrading part of a bzrdir.
335
return WorkingTree.open(path, _unsupported=True)
338
def find_trees(location):
339
def list_current(transport):
340
return [d for d in transport.list_dir('') if d != '.bzr']
341
def evaluate(bzrdir):
343
tree = bzrdir.open_workingtree()
344
except errors.NoWorkingTree:
348
transport = get_transport(location)
349
iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
350
list_current=list_current)
351
return [t for t in iterator if t is not None]
353
# should be deprecated - this is slow and in any case treating them as a
354
# container is (we now know) bad style -- mbp 20070302
355
## @deprecated_method(zero_fifteen)
357
"""Iterate through file_ids for this tree.
359
file_ids are in a WorkingTree if they are in the working inventory
360
and the working file exists.
362
inv = self._inventory
363
for path, ie in inv.iter_entries():
364
if osutils.lexists(self.abspath(path)):
367
def all_file_ids(self):
368
"""See Tree.iter_all_file_ids"""
369
return set(self.inventory)
372
return "<%s of %s>" % (self.__class__.__name__,
373
getattr(self, 'basedir', None))
375
def abspath(self, filename):
376
return pathjoin(self.basedir, filename)
378
def basis_tree(self):
379
"""Return RevisionTree for the current last revision.
381
If the left most parent is a ghost then the returned tree will be an
382
empty tree - one obtained by calling
383
repository.revision_tree(NULL_REVISION).
386
revision_id = self.get_parent_ids()[0]
388
# no parents, return an empty revision tree.
389
# in the future this should return the tree for
390
# 'empty:' - the implicit root empty tree.
391
return self.branch.repository.revision_tree(
392
_mod_revision.NULL_REVISION)
394
return self.revision_tree(revision_id)
395
except errors.NoSuchRevision:
397
# No cached copy available, retrieve from the repository.
398
# FIXME? RBC 20060403 should we cache the inventory locally
401
return self.branch.repository.revision_tree(revision_id)
402
except (errors.RevisionNotPresent, errors.NoSuchRevision):
403
# the basis tree *may* be a ghost or a low level error may have
404
# occured. If the revision is present, its a problem, if its not
406
if self.branch.repository.has_revision(revision_id):
408
# the basis tree is a ghost so return an empty tree.
409
return self.branch.repository.revision_tree(
410
_mod_revision.NULL_REVISION)
413
self._flush_ignore_list_cache()
415
def relpath(self, path):
416
"""Return the local path portion from a given path.
418
The path may be absolute or relative. If its a relative path it is
419
interpreted relative to the python current working directory.
421
return osutils.relpath(self.basedir, path)
423
def has_filename(self, filename):
424
return osutils.lexists(self.abspath(filename))
426
def get_file(self, file_id, path=None):
427
return self.get_file_with_stat(file_id, path)[0]
429
def get_file_with_stat(self, file_id, path=None, _fstat=os.fstat):
430
"""See MutableTree.get_file_with_stat."""
432
path = self.id2path(file_id)
433
file_obj = self.get_file_byname(path)
434
return (file_obj, _fstat(file_obj.fileno()))
436
def get_file_byname(self, filename):
437
return file(self.abspath(filename), 'rb')
440
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
441
"""See Tree.annotate_iter
443
This implementation will use the basis tree implementation if possible.
444
Lines not in the basis are attributed to CURRENT_REVISION
446
If there are pending merges, lines added by those merges will be
447
incorrectly attributed to CURRENT_REVISION (but after committing, the
448
attribution will be correct).
450
basis = self.basis_tree()
453
changes = self.iter_changes(basis, True, [self.id2path(file_id)],
454
require_versioned=True).next()
455
changed_content, kind = changes[2], changes[6]
456
if not changed_content:
457
return basis.annotate_iter(file_id)
461
if kind[0] != 'file':
464
old_lines = list(basis.annotate_iter(file_id))
466
for tree in self.branch.repository.revision_trees(
467
self.get_parent_ids()[1:]):
468
if file_id not in tree:
470
old.append(list(tree.annotate_iter(file_id)))
471
return annotate.reannotate(old, self.get_file(file_id).readlines(),
476
def _get_ancestors(self, default_revision):
477
ancestors = set([default_revision])
478
for parent_id in self.get_parent_ids():
479
ancestors.update(self.branch.repository.get_ancestry(
480
parent_id, topo_sorted=False))
483
def get_parent_ids(self):
484
"""See Tree.get_parent_ids.
486
This implementation reads the pending merges list and last_revision
487
value and uses that to decide what the parents list should be.
489
last_rev = _mod_revision.ensure_null(self._last_revision())
490
if _mod_revision.NULL_REVISION == last_rev:
495
merges_file = self._transport.get('pending-merges')
496
except errors.NoSuchFile:
499
for l in merges_file.readlines():
500
revision_id = l.rstrip('\n')
501
parents.append(revision_id)
505
def get_root_id(self):
506
"""Return the id of this trees root"""
507
return self._inventory.root.file_id
509
def _get_store_filename(self, file_id):
510
## XXX: badly named; this is not in the store at all
511
return self.abspath(self.id2path(file_id))
514
def clone(self, to_bzrdir, revision_id=None):
515
"""Duplicate this working tree into to_bzr, including all state.
517
Specifically modified files are kept as modified, but
518
ignored and unknown files are discarded.
520
If you want to make a new line of development, see bzrdir.sprout()
523
If not None, the cloned tree will have its last revision set to
524
revision, and and difference between the source trees last revision
525
and this one merged in.
527
# assumes the target bzr dir format is compatible.
528
result = to_bzrdir.create_workingtree()
529
self.copy_content_into(result, revision_id)
533
def copy_content_into(self, tree, revision_id=None):
534
"""Copy the current content and user files of this tree into tree."""
535
tree.set_root_id(self.get_root_id())
536
if revision_id is None:
537
merge.transform_tree(tree, self)
539
# TODO now merge from tree.last_revision to revision (to preserve
540
# user local changes)
541
merge.transform_tree(tree, self)
542
tree.set_parent_ids([revision_id])
544
def id2abspath(self, file_id):
545
return self.abspath(self.id2path(file_id))
547
def has_id(self, file_id):
548
# files that have been deleted are excluded
550
if not inv.has_id(file_id):
552
path = inv.id2path(file_id)
553
return osutils.lexists(self.abspath(path))
555
def has_or_had_id(self, file_id):
556
if file_id == self.inventory.root.file_id:
558
return self.inventory.has_id(file_id)
560
__contains__ = has_id
562
def get_file_size(self, file_id):
563
"""See Tree.get_file_size"""
565
return os.path.getsize(self.id2abspath(file_id))
567
if e.errno != errno.ENOENT:
573
def get_file_sha1(self, file_id, path=None, stat_value=None):
575
path = self._inventory.id2path(file_id)
576
return self._hashcache.get_sha1(path, stat_value)
578
def get_file_mtime(self, file_id, path=None):
580
path = self.inventory.id2path(file_id)
581
return os.lstat(self.abspath(path)).st_mtime
583
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
584
file_id = self.path2id(path)
585
return self._inventory[file_id].executable
587
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
588
mode = stat_result.st_mode
589
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
591
if not supports_executable():
592
def is_executable(self, file_id, path=None):
593
return self._inventory[file_id].executable
595
_is_executable_from_path_and_stat = \
596
_is_executable_from_path_and_stat_from_basis
598
def is_executable(self, file_id, path=None):
600
path = self.id2path(file_id)
601
mode = os.lstat(self.abspath(path)).st_mode
602
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
604
_is_executable_from_path_and_stat = \
605
_is_executable_from_path_and_stat_from_stat
607
@needs_tree_write_lock
608
def _add(self, files, ids, kinds):
609
"""See MutableTree._add."""
610
# TODO: Re-adding a file that is removed in the working copy
611
# should probably put it back with the previous ID.
612
# the read and write working inventory should not occur in this
613
# function - they should be part of lock_write and unlock.
615
for f, file_id, kind in zip(files, ids, kinds):
617
inv.add_path(f, kind=kind)
619
inv.add_path(f, kind=kind, file_id=file_id)
620
self._inventory_is_modified = True
622
@needs_tree_write_lock
623
def _gather_kinds(self, files, kinds):
624
"""See MutableTree._gather_kinds."""
625
for pos, f in enumerate(files):
626
if kinds[pos] is None:
627
fullpath = normpath(self.abspath(f))
629
kinds[pos] = file_kind(fullpath)
631
if e.errno == errno.ENOENT:
632
raise errors.NoSuchFile(fullpath)
635
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
636
"""Add revision_id as a parent.
638
This is equivalent to retrieving the current list of parent ids
639
and setting the list to its value plus revision_id.
641
:param revision_id: The revision id to add to the parent list. It may
642
be a ghost revision as long as its not the first parent to be added,
643
or the allow_leftmost_as_ghost parameter is set True.
644
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
646
parents = self.get_parent_ids() + [revision_id]
647
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
648
or allow_leftmost_as_ghost)
650
@needs_tree_write_lock
651
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
652
"""Add revision_id, tree tuple as a parent.
654
This is equivalent to retrieving the current list of parent trees
655
and setting the list to its value plus parent_tuple. See also
656
add_parent_tree_id - if you only have a parent id available it will be
657
simpler to use that api. If you have the parent already available, using
658
this api is preferred.
660
:param parent_tuple: The (revision id, tree) to add to the parent list.
661
If the revision_id is a ghost, pass None for the tree.
662
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
664
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
665
if len(parent_ids) > 1:
666
# the leftmost may have already been a ghost, preserve that if it
668
allow_leftmost_as_ghost = True
669
self.set_parent_ids(parent_ids,
670
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
672
@needs_tree_write_lock
673
def add_pending_merge(self, *revision_ids):
674
# TODO: Perhaps should check at this point that the
675
# history of the revision is actually present?
676
parents = self.get_parent_ids()
678
for rev_id in revision_ids:
679
if rev_id in parents:
681
parents.append(rev_id)
684
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
686
def path_content_summary(self, path, _lstat=os.lstat,
687
_mapper=osutils.file_kind_from_stat_mode):
688
"""See Tree.path_content_summary."""
689
abspath = self.abspath(path)
691
stat_result = _lstat(abspath)
693
if getattr(e, 'errno', None) == errno.ENOENT:
695
return ('missing', None, None, None)
696
# propagate other errors
698
kind = _mapper(stat_result.st_mode)
700
size = stat_result.st_size
701
# try for a stat cache lookup
702
executable = self._is_executable_from_path_and_stat(path, stat_result)
703
return (kind, size, executable, self._sha_from_stat(
705
elif kind == 'directory':
706
# perhaps it looks like a plain directory, but it's really a
708
if self._directory_is_tree_reference(path):
709
kind = 'tree-reference'
710
return kind, None, None, None
711
elif kind == 'symlink':
712
return ('symlink', None, None, os.readlink(abspath))
714
return (kind, None, None, None)
716
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
717
"""Common ghost checking functionality from set_parent_*.
719
This checks that the left hand-parent exists if there are any
722
if len(revision_ids) > 0:
723
leftmost_id = revision_ids[0]
724
if (not allow_leftmost_as_ghost and not
725
self.branch.repository.has_revision(leftmost_id)):
726
raise errors.GhostRevisionUnusableHere(leftmost_id)
728
def _set_merges_from_parent_ids(self, parent_ids):
729
merges = parent_ids[1:]
730
self._transport.put_bytes('pending-merges', '\n'.join(merges),
731
mode=self._control_files._file_mode)
733
def _filter_parent_ids_by_ancestry(self, revision_ids):
734
"""Check that all merged revisions are proper 'heads'.
736
This will always return the first revision_id, and any merged revisions
739
if len(revision_ids) == 0:
741
graph = self.branch.repository.get_graph()
742
heads = graph.heads(revision_ids)
743
new_revision_ids = revision_ids[:1]
744
for revision_id in revision_ids[1:]:
745
if revision_id in heads and revision_id not in new_revision_ids:
746
new_revision_ids.append(revision_id)
747
if new_revision_ids != revision_ids:
748
trace.mutter('requested to set revision_ids = %s,'
749
' but filtered to %s', revision_ids, new_revision_ids)
750
return new_revision_ids
752
@needs_tree_write_lock
753
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
754
"""Set the parent ids to revision_ids.
756
See also set_parent_trees. This api will try to retrieve the tree data
757
for each element of revision_ids from the trees repository. If you have
758
tree data already available, it is more efficient to use
759
set_parent_trees rather than set_parent_ids. set_parent_ids is however
760
an easier API to use.
762
:param revision_ids: The revision_ids to set as the parent ids of this
763
working tree. Any of these may be ghosts.
765
self._check_parents_for_ghosts(revision_ids,
766
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
767
for revision_id in revision_ids:
768
_mod_revision.check_not_reserved_id(revision_id)
770
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
772
if len(revision_ids) > 0:
773
self.set_last_revision(revision_ids[0])
775
self.set_last_revision(_mod_revision.NULL_REVISION)
777
self._set_merges_from_parent_ids(revision_ids)
779
@needs_tree_write_lock
780
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
781
"""See MutableTree.set_parent_trees."""
782
parent_ids = [rev for (rev, tree) in parents_list]
783
for revision_id in parent_ids:
784
_mod_revision.check_not_reserved_id(revision_id)
786
self._check_parents_for_ghosts(parent_ids,
787
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
789
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
791
if len(parent_ids) == 0:
792
leftmost_parent_id = _mod_revision.NULL_REVISION
793
leftmost_parent_tree = None
795
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
797
if self._change_last_revision(leftmost_parent_id):
798
if leftmost_parent_tree is None:
799
# If we don't have a tree, fall back to reading the
800
# parent tree from the repository.
801
self._cache_basis_inventory(leftmost_parent_id)
803
inv = leftmost_parent_tree.inventory
804
xml = self._create_basis_xml_from_inventory(
805
leftmost_parent_id, inv)
806
self._write_basis_inventory(xml)
807
self._set_merges_from_parent_ids(parent_ids)
809
@needs_tree_write_lock
810
def set_pending_merges(self, rev_list):
811
parents = self.get_parent_ids()
812
leftmost = parents[:1]
813
new_parents = leftmost + rev_list
814
self.set_parent_ids(new_parents)
816
@needs_tree_write_lock
817
def set_merge_modified(self, modified_hashes):
819
for file_id, hash in modified_hashes.iteritems():
820
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
821
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
823
def _sha_from_stat(self, path, stat_result):
824
"""Get a sha digest from the tree's stat cache.
826
The default implementation assumes no stat cache is present.
828
:param path: The path.
829
:param stat_result: The stat result being looked up.
833
def _put_rio(self, filename, stanzas, header):
834
self._must_be_locked()
835
my_file = rio_file(stanzas, header)
836
self._transport.put_file(filename, my_file,
837
mode=self._control_files._file_mode)
839
@needs_write_lock # because merge pulls data into the branch.
840
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
842
"""Merge from a branch into this working tree.
844
:param branch: The branch to merge from.
845
:param to_revision: If non-None, the merge will merge to to_revision,
846
but not beyond it. to_revision does not need to be in the history
847
of the branch when it is supplied. If None, to_revision defaults to
848
branch.last_revision().
850
from bzrlib.merge import Merger, Merge3Merger
851
pb = bzrlib.ui.ui_factory.nested_progress_bar()
853
merger = Merger(self.branch, this_tree=self, pb=pb)
854
merger.pp = ProgressPhase("Merge phase", 5, pb)
855
merger.pp.next_phase()
856
# check that there are no
858
merger.check_basis(check_clean=True, require_commits=False)
859
if to_revision is None:
860
to_revision = _mod_revision.ensure_null(branch.last_revision())
861
merger.other_rev_id = to_revision
862
if _mod_revision.is_null(merger.other_rev_id):
863
raise errors.NoCommits(branch)
864
self.branch.fetch(branch, last_revision=merger.other_rev_id)
865
merger.other_basis = merger.other_rev_id
866
merger.other_tree = self.branch.repository.revision_tree(
868
merger.other_branch = branch
869
merger.pp.next_phase()
870
if from_revision is None:
873
merger.set_base_revision(from_revision, branch)
874
if merger.base_rev_id == merger.other_rev_id:
875
raise errors.PointlessMerge
876
merger.backup_files = False
877
if merge_type is None:
878
merger.merge_type = Merge3Merger
880
merger.merge_type = merge_type
881
merger.set_interesting_files(None)
882
merger.show_base = False
883
merger.reprocess = False
884
conflicts = merger.do_merge()
891
def merge_modified(self):
892
"""Return a dictionary of files modified by a merge.
894
The list is initialized by WorkingTree.set_merge_modified, which is
895
typically called after we make some automatic updates to the tree
898
This returns a map of file_id->sha1, containing only files which are
899
still in the working inventory and have that text hash.
902
hashfile = self._transport.get('merge-hashes')
903
except errors.NoSuchFile:
908
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
909
raise errors.MergeModifiedFormatError()
910
except StopIteration:
911
raise errors.MergeModifiedFormatError()
912
for s in RioReader(hashfile):
913
# RioReader reads in Unicode, so convert file_ids back to utf8
914
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
915
if file_id not in self.inventory:
917
text_hash = s.get("hash")
918
if text_hash == self.get_file_sha1(file_id):
919
merge_hashes[file_id] = text_hash
925
def mkdir(self, path, file_id=None):
926
"""See MutableTree.mkdir()."""
928
file_id = generate_ids.gen_file_id(os.path.basename(path))
929
os.mkdir(self.abspath(path))
930
self.add(path, file_id, 'directory')
933
def get_symlink_target(self, file_id):
934
return os.readlink(self.id2abspath(file_id))
937
def subsume(self, other_tree):
938
def add_children(inventory, entry):
939
for child_entry in entry.children.values():
940
inventory._byid[child_entry.file_id] = child_entry
941
if child_entry.kind == 'directory':
942
add_children(inventory, child_entry)
943
if other_tree.get_root_id() == self.get_root_id():
944
raise errors.BadSubsumeSource(self, other_tree,
945
'Trees have the same root')
947
other_tree_path = self.relpath(other_tree.basedir)
948
except errors.PathNotChild:
949
raise errors.BadSubsumeSource(self, other_tree,
950
'Tree is not contained by the other')
951
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
952
if new_root_parent is None:
953
raise errors.BadSubsumeSource(self, other_tree,
954
'Parent directory is not versioned.')
955
# We need to ensure that the result of a fetch will have a
956
# versionedfile for the other_tree root, and only fetching into
957
# RepositoryKnit2 guarantees that.
958
if not self.branch.repository.supports_rich_root():
959
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
960
other_tree.lock_tree_write()
962
new_parents = other_tree.get_parent_ids()
963
other_root = other_tree.inventory.root
964
other_root.parent_id = new_root_parent
965
other_root.name = osutils.basename(other_tree_path)
966
self.inventory.add(other_root)
967
add_children(self.inventory, other_root)
968
self._write_inventory(self.inventory)
969
# normally we don't want to fetch whole repositories, but i think
970
# here we really do want to consolidate the whole thing.
971
for parent_id in other_tree.get_parent_ids():
972
self.branch.fetch(other_tree.branch, parent_id)
973
self.add_parent_tree_id(parent_id)
976
other_tree.bzrdir.retire_bzrdir()
978
def _setup_directory_is_tree_reference(self):
979
if self._branch.repository._format.supports_tree_reference:
980
self._directory_is_tree_reference = \
981
self._directory_may_be_tree_reference
983
self._directory_is_tree_reference = \
984
self._directory_is_never_tree_reference
986
def _directory_is_never_tree_reference(self, relpath):
989
def _directory_may_be_tree_reference(self, relpath):
990
# as a special case, if a directory contains control files then
991
# it's a tree reference, except that the root of the tree is not
992
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
993
# TODO: We could ask all the control formats whether they
994
# recognize this directory, but at the moment there's no cheap api
995
# to do that. Since we probably can only nest bzr checkouts and
996
# they always use this name it's ok for now. -- mbp 20060306
998
# FIXME: There is an unhandled case here of a subdirectory
999
# containing .bzr but not a branch; that will probably blow up
1000
# when you try to commit it. It might happen if there is a
1001
# checkout in a subdirectory. This can be avoided by not adding
1004
@needs_tree_write_lock
1005
def extract(self, file_id, format=None):
1006
"""Extract a subtree from this tree.
1008
A new branch will be created, relative to the path for this tree.
1012
segments = osutils.splitpath(path)
1013
transport = self.branch.bzrdir.root_transport
1014
for name in segments:
1015
transport = transport.clone(name)
1016
transport.ensure_base()
1019
sub_path = self.id2path(file_id)
1020
branch_transport = mkdirs(sub_path)
1022
format = self.bzrdir.cloning_metadir()
1023
branch_transport.ensure_base()
1024
branch_bzrdir = format.initialize_on_transport(branch_transport)
1026
repo = branch_bzrdir.find_repository()
1027
except errors.NoRepositoryPresent:
1028
repo = branch_bzrdir.create_repository()
1029
if not repo.supports_rich_root():
1030
raise errors.RootNotRich()
1031
new_branch = branch_bzrdir.create_branch()
1032
new_branch.pull(self.branch)
1033
for parent_id in self.get_parent_ids():
1034
new_branch.fetch(self.branch, parent_id)
1035
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1036
if tree_transport.base != branch_transport.base:
1037
tree_bzrdir = format.initialize_on_transport(tree_transport)
1038
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1040
tree_bzrdir = branch_bzrdir
1041
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1042
wt.set_parent_ids(self.get_parent_ids())
1043
my_inv = self.inventory
1044
child_inv = Inventory(root_id=None)
1045
new_root = my_inv[file_id]
1046
my_inv.remove_recursive_id(file_id)
1047
new_root.parent_id = None
1048
child_inv.add(new_root)
1049
self._write_inventory(my_inv)
1050
wt._write_inventory(child_inv)
1053
def _serialize(self, inventory, out_file):
1054
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1057
def _deserialize(selt, in_file):
1058
return xml5.serializer_v5.read_inventory(in_file)
1061
"""Write the in memory inventory to disk."""
1062
# TODO: Maybe this should only write on dirty ?
1063
if self._control_files._lock_mode != 'w':
1064
raise errors.NotWriteLocked(self)
1066
self._serialize(self._inventory, sio)
1068
self._transport.put_file('inventory', sio,
1069
mode=self._control_files._file_mode)
1070
self._inventory_is_modified = False
1072
def _kind(self, relpath):
1073
return osutils.file_kind(self.abspath(relpath))
1075
def list_files(self, include_root=False):
1076
"""Recursively list all files as (path, class, kind, id, entry).
1078
Lists, but does not descend into unversioned directories.
1080
This does not include files that have been deleted in this
1083
Skips the control directory.
1085
# list_files is an iterator, so @needs_read_lock doesn't work properly
1086
# with it. So callers should be careful to always read_lock the tree.
1087
if not self.is_locked():
1088
raise errors.ObjectNotLocked(self)
1090
inv = self.inventory
1091
if include_root is True:
1092
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1093
# Convert these into local objects to save lookup times
1094
pathjoin = osutils.pathjoin
1095
file_kind = self._kind
1097
# transport.base ends in a slash, we want the piece
1098
# between the last two slashes
1099
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1101
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1103
# directory file_id, relative path, absolute path, reverse sorted children
1104
children = os.listdir(self.basedir)
1106
# jam 20060527 The kernel sized tree seems equivalent whether we
1107
# use a deque and popleft to keep them sorted, or if we use a plain
1108
# list and just reverse() them.
1109
children = collections.deque(children)
1110
stack = [(inv.root.file_id, u'', self.basedir, children)]
1112
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1115
f = children.popleft()
1116
## TODO: If we find a subdirectory with its own .bzr
1117
## directory, then that is a separate tree and we
1118
## should exclude it.
1120
# the bzrdir for this tree
1121
if transport_base_dir == f:
1124
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1125
# and 'f' doesn't begin with one, we can do a string op, rather
1126
# than the checks of pathjoin(), all relative paths will have an extra slash
1128
fp = from_dir_relpath + '/' + f
1131
fap = from_dir_abspath + '/' + f
1133
f_ie = inv.get_child(from_dir_id, f)
1136
elif self.is_ignored(fp[1:]):
1139
# we may not have found this file, because of a unicode issue
1140
f_norm, can_access = osutils.normalized_filename(f)
1141
if f == f_norm or not can_access:
1142
# No change, so treat this file normally
1145
# this file can be accessed by a normalized path
1146
# check again if it is versioned
1147
# these lines are repeated here for performance
1149
fp = from_dir_relpath + '/' + f
1150
fap = from_dir_abspath + '/' + f
1151
f_ie = inv.get_child(from_dir_id, f)
1154
elif self.is_ignored(fp[1:]):
1161
# make a last minute entry
1163
yield fp[1:], c, fk, f_ie.file_id, f_ie
1166
yield fp[1:], c, fk, None, fk_entries[fk]()
1168
yield fp[1:], c, fk, None, TreeEntry()
1171
if fk != 'directory':
1174
# But do this child first
1175
new_children = os.listdir(fap)
1177
new_children = collections.deque(new_children)
1178
stack.append((f_ie.file_id, fp, fap, new_children))
1179
# Break out of inner loop,
1180
# so that we start outer loop with child
1183
# if we finished all children, pop it off the stack
1186
@needs_tree_write_lock
1187
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1190
to_dir must exist in the inventory.
1192
If to_dir exists and is a directory, the files are moved into
1193
it, keeping their old names.
1195
Note that to_dir is only the last component of the new name;
1196
this doesn't change the directory.
1198
For each entry in from_paths the move mode will be determined
1201
The first mode moves the file in the filesystem and updates the
1202
inventory. The second mode only updates the inventory without
1203
touching the file on the filesystem. This is the new mode introduced
1206
move uses the second mode if 'after == True' and the target is not
1207
versioned but present in the working tree.
1209
move uses the second mode if 'after == False' and the source is
1210
versioned but no longer in the working tree, and the target is not
1211
versioned but present in the working tree.
1213
move uses the first mode if 'after == False' and the source is
1214
versioned and present in the working tree, and the target is not
1215
versioned and not present in the working tree.
1217
Everything else results in an error.
1219
This returns a list of (from_path, to_path) pairs for each
1220
entry that is moved.
1225
# check for deprecated use of signature
1227
to_dir = kwargs.get('to_name', None)
1229
raise TypeError('You must supply a target directory')
1231
symbol_versioning.warn('The parameter to_name was deprecated'
1232
' in version 0.13. Use to_dir instead',
1235
# check destination directory
1236
if isinstance(from_paths, basestring):
1238
inv = self.inventory
1239
to_abs = self.abspath(to_dir)
1240
if not isdir(to_abs):
1241
raise errors.BzrMoveFailedError('',to_dir,
1242
errors.NotADirectory(to_abs))
1243
if not self.has_filename(to_dir):
1244
raise errors.BzrMoveFailedError('',to_dir,
1245
errors.NotInWorkingDirectory(to_dir))
1246
to_dir_id = inv.path2id(to_dir)
1247
if to_dir_id is None:
1248
raise errors.BzrMoveFailedError('',to_dir,
1249
errors.NotVersionedError(path=str(to_dir)))
1251
to_dir_ie = inv[to_dir_id]
1252
if to_dir_ie.kind != 'directory':
1253
raise errors.BzrMoveFailedError('',to_dir,
1254
errors.NotADirectory(to_abs))
1256
# create rename entries and tuples
1257
for from_rel in from_paths:
1258
from_tail = splitpath(from_rel)[-1]
1259
from_id = inv.path2id(from_rel)
1261
raise errors.BzrMoveFailedError(from_rel,to_dir,
1262
errors.NotVersionedError(path=str(from_rel)))
1264
from_entry = inv[from_id]
1265
from_parent_id = from_entry.parent_id
1266
to_rel = pathjoin(to_dir, from_tail)
1267
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1269
from_tail=from_tail,
1270
from_parent_id=from_parent_id,
1271
to_rel=to_rel, to_tail=from_tail,
1272
to_parent_id=to_dir_id)
1273
rename_entries.append(rename_entry)
1274
rename_tuples.append((from_rel, to_rel))
1276
# determine which move mode to use. checks also for movability
1277
rename_entries = self._determine_mv_mode(rename_entries, after)
1279
original_modified = self._inventory_is_modified
1282
self._inventory_is_modified = True
1283
self._move(rename_entries)
1285
# restore the inventory on error
1286
self._inventory_is_modified = original_modified
1288
self._write_inventory(inv)
1289
return rename_tuples
1291
def _determine_mv_mode(self, rename_entries, after=False):
1292
"""Determines for each from-to pair if both inventory and working tree
1293
or only the inventory has to be changed.
1295
Also does basic plausability tests.
1297
inv = self.inventory
1299
for rename_entry in rename_entries:
1300
# store to local variables for easier reference
1301
from_rel = rename_entry.from_rel
1302
from_id = rename_entry.from_id
1303
to_rel = rename_entry.to_rel
1304
to_id = inv.path2id(to_rel)
1305
only_change_inv = False
1307
# check the inventory for source and destination
1309
raise errors.BzrMoveFailedError(from_rel,to_rel,
1310
errors.NotVersionedError(path=str(from_rel)))
1311
if to_id is not None:
1312
raise errors.BzrMoveFailedError(from_rel,to_rel,
1313
errors.AlreadyVersionedError(path=str(to_rel)))
1315
# try to determine the mode for rename (only change inv or change
1316
# inv and file system)
1318
if not self.has_filename(to_rel):
1319
raise errors.BzrMoveFailedError(from_id,to_rel,
1320
errors.NoSuchFile(path=str(to_rel),
1321
extra="New file has not been created yet"))
1322
only_change_inv = True
1323
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1324
only_change_inv = True
1325
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1326
only_change_inv = False
1327
elif (not self.case_sensitive
1328
and from_rel.lower() == to_rel.lower()
1329
and self.has_filename(from_rel)):
1330
only_change_inv = False
1332
# something is wrong, so lets determine what exactly
1333
if not self.has_filename(from_rel) and \
1334
not self.has_filename(to_rel):
1335
raise errors.BzrRenameFailedError(from_rel,to_rel,
1336
errors.PathsDoNotExist(paths=(str(from_rel),
1339
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1340
rename_entry.only_change_inv = only_change_inv
1341
return rename_entries
1343
def _move(self, rename_entries):
1344
"""Moves a list of files.
1346
Depending on the value of the flag 'only_change_inv', the
1347
file will be moved on the file system or not.
1349
inv = self.inventory
1352
for entry in rename_entries:
1354
self._move_entry(entry)
1356
self._rollback_move(moved)
1360
def _rollback_move(self, moved):
1361
"""Try to rollback a previous move in case of an filesystem error."""
1362
inv = self.inventory
1365
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1366
entry.to_tail, entry.to_parent_id, entry.from_rel,
1367
entry.from_tail, entry.from_parent_id,
1368
entry.only_change_inv))
1369
except errors.BzrMoveFailedError, e:
1370
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1371
" The working tree is in an inconsistent state."
1372
" Please consider doing a 'bzr revert'."
1373
" Error message is: %s" % e)
1375
def _move_entry(self, entry):
1376
inv = self.inventory
1377
from_rel_abs = self.abspath(entry.from_rel)
1378
to_rel_abs = self.abspath(entry.to_rel)
1379
if from_rel_abs == to_rel_abs:
1380
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1381
"Source and target are identical.")
1383
if not entry.only_change_inv:
1385
osutils.rename(from_rel_abs, to_rel_abs)
1387
raise errors.BzrMoveFailedError(entry.from_rel,
1389
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1391
@needs_tree_write_lock
1392
def rename_one(self, from_rel, to_rel, after=False):
1395
This can change the directory or the filename or both.
1397
rename_one has several 'modes' to work. First, it can rename a physical
1398
file and change the file_id. That is the normal mode. Second, it can
1399
only change the file_id without touching any physical file. This is
1400
the new mode introduced in version 0.15.
1402
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1403
versioned but present in the working tree.
1405
rename_one uses the second mode if 'after == False' and 'from_rel' is
1406
versioned but no longer in the working tree, and 'to_rel' is not
1407
versioned but present in the working tree.
1409
rename_one uses the first mode if 'after == False' and 'from_rel' is
1410
versioned and present in the working tree, and 'to_rel' is not
1411
versioned and not present in the working tree.
1413
Everything else results in an error.
1415
inv = self.inventory
1418
# create rename entries and tuples
1419
from_tail = splitpath(from_rel)[-1]
1420
from_id = inv.path2id(from_rel)
1422
raise errors.BzrRenameFailedError(from_rel,to_rel,
1423
errors.NotVersionedError(path=str(from_rel)))
1424
from_entry = inv[from_id]
1425
from_parent_id = from_entry.parent_id
1426
to_dir, to_tail = os.path.split(to_rel)
1427
to_dir_id = inv.path2id(to_dir)
1428
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1430
from_tail=from_tail,
1431
from_parent_id=from_parent_id,
1432
to_rel=to_rel, to_tail=to_tail,
1433
to_parent_id=to_dir_id)
1434
rename_entries.append(rename_entry)
1436
# determine which move mode to use. checks also for movability
1437
rename_entries = self._determine_mv_mode(rename_entries, after)
1439
# check if the target changed directory and if the target directory is
1441
if to_dir_id is None:
1442
raise errors.BzrMoveFailedError(from_rel,to_rel,
1443
errors.NotVersionedError(path=str(to_dir)))
1445
# all checks done. now we can continue with our actual work
1446
mutter('rename_one:\n'
1451
' to_dir_id {%s}\n',
1452
from_id, from_rel, to_rel, to_dir, to_dir_id)
1454
self._move(rename_entries)
1455
self._write_inventory(inv)
1457
class _RenameEntry(object):
1458
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1459
to_rel, to_tail, to_parent_id, only_change_inv=False):
1460
self.from_rel = from_rel
1461
self.from_id = from_id
1462
self.from_tail = from_tail
1463
self.from_parent_id = from_parent_id
1464
self.to_rel = to_rel
1465
self.to_tail = to_tail
1466
self.to_parent_id = to_parent_id
1467
self.only_change_inv = only_change_inv
1471
"""Return all unknown files.
1473
These are files in the working directory that are not versioned or
1474
control files or ignored.
1476
# force the extras method to be fully executed before returning, to
1477
# prevent race conditions with the lock
1479
[subp for subp in self.extras() if not self.is_ignored(subp)])
1481
@needs_tree_write_lock
1482
def unversion(self, file_ids):
1483
"""Remove the file ids in file_ids from the current versioned set.
1485
When a file_id is unversioned, all of its children are automatically
1488
:param file_ids: The file ids to stop versioning.
1489
:raises: NoSuchId if any fileid is not currently versioned.
1491
for file_id in file_ids:
1492
if self._inventory.has_id(file_id):
1493
self._inventory.remove_recursive_id(file_id)
1495
raise errors.NoSuchId(self, file_id)
1497
# in the future this should just set a dirty bit to wait for the
1498
# final unlock. However, until all methods of workingtree start
1499
# with the current in -memory inventory rather than triggering
1500
# a read, it is more complex - we need to teach read_inventory
1501
# to know when to read, and when to not read first... and possibly
1502
# to save first when the in memory one may be corrupted.
1503
# so for now, we just only write it if it is indeed dirty.
1505
self._write_inventory(self._inventory)
1507
def _iter_conflicts(self):
1509
for info in self.list_files():
1511
stem = get_conflicted_stem(path)
1514
if stem not in conflicted:
1515
conflicted.add(stem)
1519
def pull(self, source, overwrite=False, stop_revision=None,
1520
change_reporter=None, possible_transports=None):
1521
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1524
pp = ProgressPhase("Pull phase", 2, top_pb)
1526
old_revision_info = self.branch.last_revision_info()
1527
basis_tree = self.basis_tree()
1528
count = self.branch.pull(source, overwrite, stop_revision,
1529
possible_transports=possible_transports)
1530
new_revision_info = self.branch.last_revision_info()
1531
if new_revision_info != old_revision_info:
1533
repository = self.branch.repository
1534
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1535
basis_tree.lock_read()
1537
new_basis_tree = self.branch.basis_tree()
1544
change_reporter=change_reporter)
1545
if (basis_tree.inventory.root is None and
1546
new_basis_tree.inventory.root is not None):
1547
self.set_root_id(new_basis_tree.get_root_id())
1551
# TODO - dedup parents list with things merged by pull ?
1552
# reuse the revisiontree we merged against to set the new
1554
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1555
# we have to pull the merge trees out again, because
1556
# merge_inner has set the ids. - this corner is not yet
1557
# layered well enough to prevent double handling.
1558
# XXX TODO: Fix the double handling: telling the tree about
1559
# the already known parent data is wasteful.
1560
merges = self.get_parent_ids()[1:]
1561
parent_trees.extend([
1562
(parent, repository.revision_tree(parent)) for
1564
self.set_parent_trees(parent_trees)
1571
def put_file_bytes_non_atomic(self, file_id, bytes):
1572
"""See MutableTree.put_file_bytes_non_atomic."""
1573
stream = file(self.id2abspath(file_id), 'wb')
1578
# TODO: update the hashcache here ?
1581
"""Yield all unversioned files in this WorkingTree.
1583
If there are any unversioned directories then only the directory is
1584
returned, not all its children. But if there are unversioned files
1585
under a versioned subdirectory, they are returned.
1587
Currently returned depth-first, sorted by name within directories.
1588
This is the same order used by 'osutils.walkdirs'.
1590
## TODO: Work from given directory downwards
1591
for path, dir_entry in self.inventory.directories():
1592
# mutter("search for unknowns in %r", path)
1593
dirabs = self.abspath(path)
1594
if not isdir(dirabs):
1595
# e.g. directory deleted
1599
for subf in os.listdir(dirabs):
1602
if subf not in dir_entry.children:
1605
can_access) = osutils.normalized_filename(subf)
1606
except UnicodeDecodeError:
1607
path_os_enc = path.encode(osutils._fs_enc)
1608
relpath = path_os_enc + '/' + subf
1609
raise errors.BadFilenameEncoding(relpath,
1611
if subf_norm != subf and can_access:
1612
if subf_norm not in dir_entry.children:
1613
fl.append(subf_norm)
1619
subp = pathjoin(path, subf)
1622
def ignored_files(self):
1623
"""Yield list of PATH, IGNORE_PATTERN"""
1624
for subp in self.extras():
1625
pat = self.is_ignored(subp)
1629
def get_ignore_list(self):
1630
"""Return list of ignore patterns.
1632
Cached in the Tree object after the first call.
1634
ignoreset = getattr(self, '_ignoreset', None)
1635
if ignoreset is not None:
1638
ignore_globs = set()
1639
ignore_globs.update(ignores.get_runtime_ignores())
1640
ignore_globs.update(ignores.get_user_ignores())
1641
if self.has_filename(bzrlib.IGNORE_FILENAME):
1642
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1644
ignore_globs.update(ignores.parse_ignore_file(f))
1647
self._ignoreset = ignore_globs
1650
def _flush_ignore_list_cache(self):
1651
"""Resets the cached ignore list to force a cache rebuild."""
1652
self._ignoreset = None
1653
self._ignoreglobster = None
1655
def is_ignored(self, filename):
1656
r"""Check whether the filename matches an ignore pattern.
1658
Patterns containing '/' or '\' need to match the whole path;
1659
others match against only the last component.
1661
If the file is ignored, returns the pattern which caused it to
1662
be ignored, otherwise None. So this can simply be used as a
1663
boolean if desired."""
1664
if getattr(self, '_ignoreglobster', None) is None:
1665
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1666
return self._ignoreglobster.match(filename)
1668
def kind(self, file_id):
1669
return file_kind(self.id2abspath(file_id))
1671
def stored_kind(self, file_id):
1672
"""See Tree.stored_kind"""
1673
return self.inventory[file_id].kind
1675
def _comparison_data(self, entry, path):
1676
abspath = self.abspath(path)
1678
stat_value = os.lstat(abspath)
1680
if getattr(e, 'errno', None) == errno.ENOENT:
1687
mode = stat_value.st_mode
1688
kind = osutils.file_kind_from_stat_mode(mode)
1689
if not supports_executable():
1690
executable = entry is not None and entry.executable
1692
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1693
return kind, executable, stat_value
1695
def _file_size(self, entry, stat_value):
1696
return stat_value.st_size
1698
def last_revision(self):
1699
"""Return the last revision of the branch for this tree.
1701
This format tree does not support a separate marker for last-revision
1702
compared to the branch.
1704
See MutableTree.last_revision
1706
return self._last_revision()
1709
def _last_revision(self):
1710
"""helper for get_parent_ids."""
1711
return _mod_revision.ensure_null(self.branch.last_revision())
1713
def is_locked(self):
1714
return self._control_files.is_locked()
1716
def _must_be_locked(self):
1717
if not self.is_locked():
1718
raise errors.ObjectNotLocked(self)
1720
def lock_read(self):
1721
"""See Branch.lock_read, and WorkingTree.unlock."""
1722
if not self.is_locked():
1724
self.branch.lock_read()
1726
return self._control_files.lock_read()
1728
self.branch.unlock()
1731
def lock_tree_write(self):
1732
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1733
if not self.is_locked():
1735
self.branch.lock_read()
1737
return self._control_files.lock_write()
1739
self.branch.unlock()
1742
def lock_write(self):
1743
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1744
if not self.is_locked():
1746
self.branch.lock_write()
1748
return self._control_files.lock_write()
1750
self.branch.unlock()
1753
def get_physical_lock_status(self):
1754
return self._control_files.get_physical_lock_status()
1756
def _basis_inventory_name(self):
1757
return 'basis-inventory-cache'
1759
def _reset_data(self):
1760
"""Reset transient data that cannot be revalidated."""
1761
self._inventory_is_modified = False
1762
result = self._deserialize(self._transport.get('inventory'))
1763
self._set_inventory(result, dirty=False)
1765
@needs_tree_write_lock
1766
def set_last_revision(self, new_revision):
1767
"""Change the last revision in the working tree."""
1768
if self._change_last_revision(new_revision):
1769
self._cache_basis_inventory(new_revision)
1771
def _change_last_revision(self, new_revision):
1772
"""Template method part of set_last_revision to perform the change.
1774
This is used to allow WorkingTree3 instances to not affect branch
1775
when their last revision is set.
1777
if _mod_revision.is_null(new_revision):
1778
self.branch.set_revision_history([])
1781
self.branch.generate_revision_history(new_revision)
1782
except errors.NoSuchRevision:
1783
# not present in the repo - dont try to set it deeper than the tip
1784
self.branch.set_revision_history([new_revision])
1787
def _write_basis_inventory(self, xml):
1788
"""Write the basis inventory XML to the basis-inventory file"""
1789
path = self._basis_inventory_name()
1791
self._transport.put_file(path, sio,
1792
mode=self._control_files._file_mode)
1794
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1795
"""Create the text that will be saved in basis-inventory"""
1796
inventory.revision_id = revision_id
1797
return xml7.serializer_v7.write_inventory_to_string(inventory)
1799
def _cache_basis_inventory(self, new_revision):
1800
"""Cache new_revision as the basis inventory."""
1801
# TODO: this should allow the ready-to-use inventory to be passed in,
1802
# as commit already has that ready-to-use [while the format is the
1805
# this double handles the inventory - unpack and repack -
1806
# but is easier to understand. We can/should put a conditional
1807
# in here based on whether the inventory is in the latest format
1808
# - perhaps we should repack all inventories on a repository
1810
# the fast path is to copy the raw xml from the repository. If the
1811
# xml contains 'revision_id="', then we assume the right
1812
# revision_id is set. We must check for this full string, because a
1813
# root node id can legitimately look like 'revision_id' but cannot
1815
xml = self.branch.repository.get_inventory_xml(new_revision)
1816
firstline = xml.split('\n', 1)[0]
1817
if (not 'revision_id="' in firstline or
1818
'format="7"' not in firstline):
1819
inv = self.branch.repository.deserialise_inventory(
1821
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1822
self._write_basis_inventory(xml)
1823
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1826
def read_basis_inventory(self):
1827
"""Read the cached basis inventory."""
1828
path = self._basis_inventory_name()
1829
return self._transport.get_bytes(path)
1832
def read_working_inventory(self):
1833
"""Read the working inventory.
1835
:raises errors.InventoryModified: read_working_inventory will fail
1836
when the current in memory inventory has been modified.
1838
# conceptually this should be an implementation detail of the tree.
1839
# XXX: Deprecate this.
1840
# ElementTree does its own conversion from UTF-8, so open in
1842
if self._inventory_is_modified:
1843
raise errors.InventoryModified(self)
1844
result = self._deserialize(self._transport.get('inventory'))
1845
self._set_inventory(result, dirty=False)
1848
@needs_tree_write_lock
1849
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1851
"""Remove nominated files from the working inventory.
1853
:files: File paths relative to the basedir.
1854
:keep_files: If true, the files will also be kept.
1855
:force: Delete files and directories, even if they are changed and
1856
even if the directories are not empty.
1858
if isinstance(files, basestring):
1864
unknown_nested_files=set()
1866
def recurse_directory_to_add_files(directory):
1867
# Recurse directory and add all files
1868
# so we can check if they have changed.
1869
for parent_info, file_infos in\
1870
self.walkdirs(directory):
1871
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1872
# Is it versioned or ignored?
1873
if self.path2id(relpath) or self.is_ignored(relpath):
1874
# Add nested content for deletion.
1875
new_files.add(relpath)
1877
# Files which are not versioned and not ignored
1878
# should be treated as unknown.
1879
unknown_nested_files.add((relpath, None, kind))
1881
for filename in files:
1882
# Get file name into canonical form.
1883
abspath = self.abspath(filename)
1884
filename = self.relpath(abspath)
1885
if len(filename) > 0:
1886
new_files.add(filename)
1887
recurse_directory_to_add_files(filename)
1889
files = list(new_files)
1892
return # nothing to do
1894
# Sort needed to first handle directory content before the directory
1895
files.sort(reverse=True)
1897
# Bail out if we are going to delete files we shouldn't
1898
if not keep_files and not force:
1899
has_changed_files = len(unknown_nested_files) > 0
1900
if not has_changed_files:
1901
for (file_id, path, content_change, versioned, parent_id, name,
1902
kind, executable) in self.iter_changes(self.basis_tree(),
1903
include_unchanged=True, require_versioned=False,
1904
want_unversioned=True, specific_files=files):
1905
if versioned == (False, False):
1906
# The record is unknown ...
1907
if not self.is_ignored(path[1]):
1908
# ... but not ignored
1909
has_changed_files = True
1911
elif content_change and (kind[1] is not None):
1912
# Versioned and changed, but not deleted
1913
has_changed_files = True
1916
if has_changed_files:
1917
# Make delta show ALL applicable changes in error message.
1918
tree_delta = self.changes_from(self.basis_tree(),
1919
require_versioned=False, want_unversioned=True,
1920
specific_files=files)
1921
for unknown_file in unknown_nested_files:
1922
if unknown_file not in tree_delta.unversioned:
1923
tree_delta.unversioned.extend((unknown_file,))
1924
raise errors.BzrRemoveChangedFilesError(tree_delta)
1926
# Build inv_delta and delete files where applicaple,
1927
# do this before any modifications to inventory.
1929
fid = self.path2id(f)
1932
message = "%s is not versioned." % (f,)
1935
# having removed it, it must be either ignored or unknown
1936
if self.is_ignored(f):
1940
textui.show_status(new_status, self.kind(fid), f,
1943
inv_delta.append((f, None, fid, None))
1944
message = "removed %s" % (f,)
1947
abs_path = self.abspath(f)
1948
if osutils.lexists(abs_path):
1949
if (osutils.isdir(abs_path) and
1950
len(os.listdir(abs_path)) > 0):
1952
osutils.rmtree(abs_path)
1954
message = "%s is not an empty directory "\
1955
"and won't be deleted." % (f,)
1957
osutils.delete_any(abs_path)
1958
message = "deleted %s" % (f,)
1959
elif message is not None:
1960
# Only care if we haven't done anything yet.
1961
message = "%s does not exist." % (f,)
1963
# Print only one message (if any) per file.
1964
if message is not None:
1966
self.apply_inventory_delta(inv_delta)
1968
@needs_tree_write_lock
1969
def revert(self, filenames=None, old_tree=None, backups=True,
1970
pb=DummyProgress(), report_changes=False):
1971
from bzrlib.conflicts import resolve
1974
symbol_versioning.warn('Using [] to revert all files is deprecated'
1975
' as of bzr 0.91. Please use None (the default) instead.',
1976
DeprecationWarning, stacklevel=2)
1977
if old_tree is None:
1978
basis_tree = self.basis_tree()
1979
basis_tree.lock_read()
1980
old_tree = basis_tree
1984
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1986
if filenames is None and len(self.get_parent_ids()) > 1:
1988
last_revision = self.last_revision()
1989
if last_revision != NULL_REVISION:
1990
if basis_tree is None:
1991
basis_tree = self.basis_tree()
1992
basis_tree.lock_read()
1993
parent_trees.append((last_revision, basis_tree))
1994
self.set_parent_trees(parent_trees)
1997
resolve(self, filenames, ignore_misses=True, recursive=True)
1999
if basis_tree is not None:
2003
def revision_tree(self, revision_id):
2004
"""See Tree.revision_tree.
2006
WorkingTree can supply revision_trees for the basis revision only
2007
because there is only one cached inventory in the bzr directory.
2009
if revision_id == self.last_revision():
2011
xml = self.read_basis_inventory()
2012
except errors.NoSuchFile:
2016
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2017
# dont use the repository revision_tree api because we want
2018
# to supply the inventory.
2019
if inv.revision_id == revision_id:
2020
return revisiontree.RevisionTree(self.branch.repository,
2022
except errors.BadInventoryFormat:
2024
# raise if there was no inventory, or if we read the wrong inventory.
2025
raise errors.NoSuchRevisionInTree(self, revision_id)
2027
# XXX: This method should be deprecated in favour of taking in a proper
2028
# new Inventory object.
2029
@needs_tree_write_lock
2030
def set_inventory(self, new_inventory_list):
2031
from bzrlib.inventory import (Inventory,
2036
inv = Inventory(self.get_root_id())
2037
for path, file_id, parent, kind in new_inventory_list:
2038
name = os.path.basename(path)
2041
# fixme, there should be a factory function inv,add_??
2042
if kind == 'directory':
2043
inv.add(InventoryDirectory(file_id, name, parent))
2044
elif kind == 'file':
2045
inv.add(InventoryFile(file_id, name, parent))
2046
elif kind == 'symlink':
2047
inv.add(InventoryLink(file_id, name, parent))
2049
raise errors.BzrError("unknown kind %r" % kind)
2050
self._write_inventory(inv)
2052
@needs_tree_write_lock
2053
def set_root_id(self, file_id):
2054
"""Set the root id for this tree."""
2058
'WorkingTree.set_root_id with fileid=None')
2059
file_id = osutils.safe_file_id(file_id)
2060
self._set_root_id(file_id)
2062
def _set_root_id(self, file_id):
2063
"""Set the root id for this tree, in a format specific manner.
2065
:param file_id: The file id to assign to the root. It must not be
2066
present in the current inventory or an error will occur. It must
2067
not be None, but rather a valid file id.
2069
inv = self._inventory
2070
orig_root_id = inv.root.file_id
2071
# TODO: it might be nice to exit early if there was nothing
2072
# to do, saving us from trigger a sync on unlock.
2073
self._inventory_is_modified = True
2074
# we preserve the root inventory entry object, but
2075
# unlinkit from the byid index
2076
del inv._byid[inv.root.file_id]
2077
inv.root.file_id = file_id
2078
# and link it into the index with the new changed id.
2079
inv._byid[inv.root.file_id] = inv.root
2080
# and finally update all children to reference the new id.
2081
# XXX: this should be safe to just look at the root.children
2082
# list, not the WHOLE INVENTORY.
2085
if entry.parent_id == orig_root_id:
2086
entry.parent_id = inv.root.file_id
2089
"""See Branch.unlock.
2091
WorkingTree locking just uses the Branch locking facilities.
2092
This is current because all working trees have an embedded branch
2093
within them. IF in the future, we were to make branch data shareable
2094
between multiple working trees, i.e. via shared storage, then we
2095
would probably want to lock both the local tree, and the branch.
2097
raise NotImplementedError(self.unlock)
2099
def update(self, change_reporter=None, possible_transports=None):
2100
"""Update a working tree along its branch.
2102
This will update the branch if its bound too, which means we have
2103
multiple trees involved:
2105
- The new basis tree of the master.
2106
- The old basis tree of the branch.
2107
- The old basis tree of the working tree.
2108
- The current working tree state.
2110
Pathologically, all three may be different, and non-ancestors of each
2111
other. Conceptually we want to:
2113
- Preserve the wt.basis->wt.state changes
2114
- Transform the wt.basis to the new master basis.
2115
- Apply a merge of the old branch basis to get any 'local' changes from
2117
- Restore the wt.basis->wt.state changes.
2119
There isn't a single operation at the moment to do that, so we:
2120
- Merge current state -> basis tree of the master w.r.t. the old tree
2122
- Do a 'normal' merge of the old branch basis if it is relevant.
2124
if self.branch.get_bound_location() is not None:
2126
update_branch = True
2128
self.lock_tree_write()
2129
update_branch = False
2132
old_tip = self.branch.update(possible_transports)
2135
return self._update_tree(old_tip, change_reporter)
2139
@needs_tree_write_lock
2140
def _update_tree(self, old_tip=None, change_reporter=None):
2141
"""Update a tree to the master branch.
2143
:param old_tip: if supplied, the previous tip revision the branch,
2144
before it was changed to the master branch's tip.
2146
# here if old_tip is not None, it is the old tip of the branch before
2147
# it was updated from the master branch. This should become a pending
2148
# merge in the working tree to preserve the user existing work. we
2149
# cant set that until we update the working trees last revision to be
2150
# one from the new branch, because it will just get absorbed by the
2151
# parent de-duplication logic.
2153
# We MUST save it even if an error occurs, because otherwise the users
2154
# local work is unreferenced and will appear to have been lost.
2158
last_rev = self.get_parent_ids()[0]
2160
last_rev = _mod_revision.NULL_REVISION
2161
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2162
# merge tree state up to new branch tip.
2163
basis = self.basis_tree()
2166
to_tree = self.branch.basis_tree()
2167
if basis.inventory.root is None:
2168
self.set_root_id(to_tree.get_root_id())
2170
result += merge.merge_inner(
2175
change_reporter=change_reporter)
2178
# TODO - dedup parents list with things merged by pull ?
2179
# reuse the tree we've updated to to set the basis:
2180
parent_trees = [(self.branch.last_revision(), to_tree)]
2181
merges = self.get_parent_ids()[1:]
2182
# Ideally we ask the tree for the trees here, that way the working
2183
# tree can decide whether to give us teh entire tree or give us a
2184
# lazy initialised tree. dirstate for instance will have the trees
2185
# in ram already, whereas a last-revision + basis-inventory tree
2186
# will not, but also does not need them when setting parents.
2187
for parent in merges:
2188
parent_trees.append(
2189
(parent, self.branch.repository.revision_tree(parent)))
2190
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2191
parent_trees.append(
2192
(old_tip, self.branch.repository.revision_tree(old_tip)))
2193
self.set_parent_trees(parent_trees)
2194
last_rev = parent_trees[0][0]
2196
# the working tree had the same last-revision as the master
2197
# branch did. We may still have pivot local work from the local
2198
# branch into old_tip:
2199
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2200
self.add_parent_tree_id(old_tip)
2201
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2202
and old_tip != last_rev):
2203
# our last revision was not the prior branch last revision
2204
# and we have converted that last revision to a pending merge.
2205
# base is somewhere between the branch tip now
2206
# and the now pending merge
2208
# Since we just modified the working tree and inventory, flush out
2209
# the current state, before we modify it again.
2210
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2211
# requires it only because TreeTransform directly munges the
2212
# inventory and calls tree._write_inventory(). Ultimately we
2213
# should be able to remove this extra flush.
2215
graph = self.branch.repository.get_graph()
2216
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2218
base_tree = self.branch.repository.revision_tree(base_rev_id)
2219
other_tree = self.branch.repository.revision_tree(old_tip)
2220
result += merge.merge_inner(
2225
change_reporter=change_reporter)
2228
def _write_hashcache_if_dirty(self):
2229
"""Write out the hashcache if it is dirty."""
2230
if self._hashcache.needs_write:
2232
self._hashcache.write()
2234
if e.errno not in (errno.EPERM, errno.EACCES):
2236
# TODO: jam 20061219 Should this be a warning? A single line
2237
# warning might be sufficient to let the user know what
2239
mutter('Could not write hashcache for %s\nError: %s',
2240
self._hashcache.cache_file_name(), e)
2242
@needs_tree_write_lock
2243
def _write_inventory(self, inv):
2244
"""Write inventory as the current inventory."""
2245
self._set_inventory(inv, dirty=True)
2248
def set_conflicts(self, arg):
2249
raise errors.UnsupportedOperation(self.set_conflicts, self)
2251
def add_conflicts(self, arg):
2252
raise errors.UnsupportedOperation(self.add_conflicts, self)
2255
def conflicts(self):
2256
conflicts = _mod_conflicts.ConflictList()
2257
for conflicted in self._iter_conflicts():
2260
if file_kind(self.abspath(conflicted)) != "file":
2262
except errors.NoSuchFile:
2265
for suffix in ('.THIS', '.OTHER'):
2267
kind = file_kind(self.abspath(conflicted+suffix))
2270
except errors.NoSuchFile:
2274
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2275
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2277
file_id=self.path2id(conflicted)))
2280
def walkdirs(self, prefix=""):
2281
"""Walk the directories of this tree.
2283
returns a generator which yields items in the form:
2284
((curren_directory_path, fileid),
2285
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2288
This API returns a generator, which is only valid during the current
2289
tree transaction - within a single lock_read or lock_write duration.
2291
If the tree is not locked, it may cause an error to be raised,
2292
depending on the tree implementation.
2294
disk_top = self.abspath(prefix)
2295
if disk_top.endswith('/'):
2296
disk_top = disk_top[:-1]
2297
top_strip_len = len(disk_top) + 1
2298
inventory_iterator = self._walkdirs(prefix)
2299
disk_iterator = osutils.walkdirs(disk_top, prefix)
2301
current_disk = disk_iterator.next()
2302
disk_finished = False
2304
if not (e.errno == errno.ENOENT or
2305
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2308
disk_finished = True
2310
current_inv = inventory_iterator.next()
2311
inv_finished = False
2312
except StopIteration:
2315
while not inv_finished or not disk_finished:
2317
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2318
cur_disk_dir_content) = current_disk
2320
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2321
cur_disk_dir_content) = ((None, None), None)
2322
if not disk_finished:
2323
# strip out .bzr dirs
2324
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2325
len(cur_disk_dir_content) > 0):
2326
# osutils.walkdirs can be made nicer -
2327
# yield the path-from-prefix rather than the pathjoined
2329
bzrdir_loc = bisect_left(cur_disk_dir_content,
2331
if (bzrdir_loc < len(cur_disk_dir_content)
2332
and cur_disk_dir_content[bzrdir_loc][0] == '.bzr'):
2333
# we dont yield the contents of, or, .bzr itself.
2334
del cur_disk_dir_content[bzrdir_loc]
2336
# everything is unknown
2339
# everything is missing
2342
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2344
# disk is before inventory - unknown
2345
dirblock = [(relpath, basename, kind, stat, None, None) for
2346
relpath, basename, kind, stat, top_path in
2347
cur_disk_dir_content]
2348
yield (cur_disk_dir_relpath, None), dirblock
2350
current_disk = disk_iterator.next()
2351
except StopIteration:
2352
disk_finished = True
2354
# inventory is before disk - missing.
2355
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2356
for relpath, basename, dkind, stat, fileid, kind in
2358
yield (current_inv[0][0], current_inv[0][1]), dirblock
2360
current_inv = inventory_iterator.next()
2361
except StopIteration:
2364
# versioned present directory
2365
# merge the inventory and disk data together
2367
for relpath, subiterator in itertools.groupby(sorted(
2368
current_inv[1] + cur_disk_dir_content,
2369
key=operator.itemgetter(0)), operator.itemgetter(1)):
2370
path_elements = list(subiterator)
2371
if len(path_elements) == 2:
2372
inv_row, disk_row = path_elements
2373
# versioned, present file
2374
dirblock.append((inv_row[0],
2375
inv_row[1], disk_row[2],
2376
disk_row[3], inv_row[4],
2378
elif len(path_elements[0]) == 5:
2380
dirblock.append((path_elements[0][0],
2381
path_elements[0][1], path_elements[0][2],
2382
path_elements[0][3], None, None))
2383
elif len(path_elements[0]) == 6:
2384
# versioned, absent file.
2385
dirblock.append((path_elements[0][0],
2386
path_elements[0][1], 'unknown', None,
2387
path_elements[0][4], path_elements[0][5]))
2389
raise NotImplementedError('unreachable code')
2390
yield current_inv[0], dirblock
2392
current_inv = inventory_iterator.next()
2393
except StopIteration:
2396
current_disk = disk_iterator.next()
2397
except StopIteration:
2398
disk_finished = True
2400
def _walkdirs(self, prefix=""):
2401
"""Walk the directories of this tree.
2403
:prefix: is used as the directrory to start with.
2404
returns a generator which yields items in the form:
2405
((curren_directory_path, fileid),
2406
[(file1_path, file1_name, file1_kind, None, file1_id,
2409
_directory = 'directory'
2410
# get the root in the inventory
2411
inv = self.inventory
2412
top_id = inv.path2id(prefix)
2416
pending = [(prefix, '', _directory, None, top_id, None)]
2419
currentdir = pending.pop()
2420
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2421
top_id = currentdir[4]
2423
relroot = currentdir[0] + '/'
2426
# FIXME: stash the node in pending
2428
if entry.kind == 'directory':
2429
for name, child in entry.sorted_children():
2430
dirblock.append((relroot + name, name, child.kind, None,
2431
child.file_id, child.kind
2433
yield (currentdir[0], entry.file_id), dirblock
2434
# push the user specified dirs from dirblock
2435
for dir in reversed(dirblock):
2436
if dir[2] == _directory:
2439
@needs_tree_write_lock
2440
def auto_resolve(self):
2441
"""Automatically resolve text conflicts according to contents.
2443
Only text conflicts are auto_resolvable. Files with no conflict markers
2444
are considered 'resolved', because bzr always puts conflict markers
2445
into files that have text conflicts. The corresponding .THIS .BASE and
2446
.OTHER files are deleted, as per 'resolve'.
2447
:return: a tuple of ConflictLists: (un_resolved, resolved).
2449
un_resolved = _mod_conflicts.ConflictList()
2450
resolved = _mod_conflicts.ConflictList()
2451
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2452
for conflict in self.conflicts():
2453
if (conflict.typestring != 'text conflict' or
2454
self.kind(conflict.file_id) != 'file'):
2455
un_resolved.append(conflict)
2457
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2459
for line in my_file:
2460
if conflict_re.search(line):
2461
un_resolved.append(conflict)
2464
resolved.append(conflict)
2467
resolved.remove_files(self)
2468
self.set_conflicts(un_resolved)
2469
return un_resolved, resolved
2473
tree_basis = self.basis_tree()
2474
tree_basis.lock_read()
2476
repo_basis = self.branch.repository.revision_tree(
2477
self.last_revision())
2478
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2479
raise errors.BzrCheckError(
2480
"Mismatched basis inventory content.")
2485
def _validate(self):
2486
"""Validate internal structures.
2488
This is meant mostly for the test suite. To give it a chance to detect
2489
corruption after actions have occurred. The default implementation is a
2492
:return: None. An exception should be raised if there is an error.
2497
def _get_rules_searcher(self, default_searcher):
2498
"""See Tree._get_rules_searcher."""
2499
if self._rules_searcher is None:
2500
self._rules_searcher = super(WorkingTree,
2501
self)._get_rules_searcher(default_searcher)
2502
return self._rules_searcher
2505
class WorkingTree2(WorkingTree):
2506
"""This is the Format 2 working tree.
2508
This was the first weave based working tree.
2509
- uses os locks for locking.
2510
- uses the branch last-revision.
2513
def __init__(self, *args, **kwargs):
2514
super(WorkingTree2, self).__init__(*args, **kwargs)
2515
# WorkingTree2 has more of a constraint that self._inventory must
2516
# exist. Because this is an older format, we don't mind the overhead
2517
# caused by the extra computation here.
2519
# Newer WorkingTree's should only have self._inventory set when they
2521
if self._inventory is None:
2522
self.read_working_inventory()
2524
def lock_tree_write(self):
2525
"""See WorkingTree.lock_tree_write().
2527
In Format2 WorkingTrees we have a single lock for the branch and tree
2528
so lock_tree_write() degrades to lock_write().
2530
self.branch.lock_write()
2532
return self._control_files.lock_write()
2534
self.branch.unlock()
2538
# do non-implementation specific cleanup
2541
# we share control files:
2542
if self._control_files._lock_count == 3:
2543
# _inventory_is_modified is always False during a read lock.
2544
if self._inventory_is_modified:
2546
self._write_hashcache_if_dirty()
2548
# reverse order of locking.
2550
return self._control_files.unlock()
2552
self.branch.unlock()
2555
class WorkingTree3(WorkingTree):
2556
"""This is the Format 3 working tree.
2558
This differs from the base WorkingTree by:
2559
- having its own file lock
2560
- having its own last-revision property.
2562
This is new in bzr 0.8
2566
def _last_revision(self):
2567
"""See Mutable.last_revision."""
2569
return self._transport.get_bytes('last-revision')
2570
except errors.NoSuchFile:
2571
return _mod_revision.NULL_REVISION
2573
def _change_last_revision(self, revision_id):
2574
"""See WorkingTree._change_last_revision."""
2575
if revision_id is None or revision_id == NULL_REVISION:
2577
self._transport.delete('last-revision')
2578
except errors.NoSuchFile:
2582
self._transport.put_bytes('last-revision', revision_id,
2583
mode=self._control_files._file_mode)
2586
@needs_tree_write_lock
2587
def set_conflicts(self, conflicts):
2588
self._put_rio('conflicts', conflicts.to_stanzas(),
2591
@needs_tree_write_lock
2592
def add_conflicts(self, new_conflicts):
2593
conflict_set = set(self.conflicts())
2594
conflict_set.update(set(list(new_conflicts)))
2595
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2596
key=_mod_conflicts.Conflict.sort_key)))
2599
def conflicts(self):
2601
confile = self._transport.get('conflicts')
2602
except errors.NoSuchFile:
2603
return _mod_conflicts.ConflictList()
2606
if confile.next() != CONFLICT_HEADER_1 + '\n':
2607
raise errors.ConflictFormatError()
2608
except StopIteration:
2609
raise errors.ConflictFormatError()
2610
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2615
# do non-implementation specific cleanup
2617
if self._control_files._lock_count == 1:
2618
# _inventory_is_modified is always False during a read lock.
2619
if self._inventory_is_modified:
2621
self._write_hashcache_if_dirty()
2622
# reverse order of locking.
2624
return self._control_files.unlock()
2626
self.branch.unlock()
2629
def get_conflicted_stem(path):
2630
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2631
if path.endswith(suffix):
2632
return path[:-len(suffix)]
2635
class WorkingTreeFormat(object):
2636
"""An encapsulation of the initialization and open routines for a format.
2638
Formats provide three things:
2639
* An initialization routine,
2643
Formats are placed in an dict by their format string for reference
2644
during workingtree opening. Its not required that these be instances, they
2645
can be classes themselves with class methods - it simply depends on
2646
whether state is needed for a given format or not.
2648
Once a format is deprecated, just deprecate the initialize and open
2649
methods on the format class. Do not deprecate the object, as the
2650
object will be created every time regardless.
2653
_default_format = None
2654
"""The default format used for new trees."""
2657
"""The known formats."""
2659
requires_rich_root = False
2661
upgrade_recommended = False
2664
def find_format(klass, a_bzrdir):
2665
"""Return the format for the working tree object in a_bzrdir."""
2667
transport = a_bzrdir.get_workingtree_transport(None)
2668
format_string = transport.get("format").read()
2669
return klass._formats[format_string]
2670
except errors.NoSuchFile:
2671
raise errors.NoWorkingTree(base=transport.base)
2673
raise errors.UnknownFormatError(format=format_string,
2674
kind="working tree")
2676
def __eq__(self, other):
2677
return self.__class__ is other.__class__
2679
def __ne__(self, other):
2680
return not (self == other)
2683
def get_default_format(klass):
2684
"""Return the current default format."""
2685
return klass._default_format
2687
def get_format_string(self):
2688
"""Return the ASCII format string that identifies this format."""
2689
raise NotImplementedError(self.get_format_string)
2691
def get_format_description(self):
2692
"""Return the short description for this format."""
2693
raise NotImplementedError(self.get_format_description)
2695
def is_supported(self):
2696
"""Is this format supported?
2698
Supported formats can be initialized and opened.
2699
Unsupported formats may not support initialization or committing or
2700
some other features depending on the reason for not being supported.
2705
def register_format(klass, format):
2706
klass._formats[format.get_format_string()] = format
2709
def set_default_format(klass, format):
2710
klass._default_format = format
2713
def unregister_format(klass, format):
2714
del klass._formats[format.get_format_string()]
2717
class WorkingTreeFormat2(WorkingTreeFormat):
2718
"""The second working tree format.
2720
This format modified the hash cache from the format 1 hash cache.
2723
upgrade_recommended = True
2725
def get_format_description(self):
2726
"""See WorkingTreeFormat.get_format_description()."""
2727
return "Working tree format 2"
2729
def _stub_initialize_on_transport(self, transport, file_mode):
2730
"""Workaround: create control files for a remote working tree.
2732
This ensures that it can later be updated and dealt with locally,
2733
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2734
no working tree. (See bug #43064).
2738
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2740
transport.put_file('inventory', sio, file_mode)
2741
transport.put_bytes('pending-merges', '', file_mode)
2743
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2744
accelerator_tree=None, hardlink=False):
2745
"""See WorkingTreeFormat.initialize()."""
2746
if not isinstance(a_bzrdir.transport, LocalTransport):
2747
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2748
if from_branch is not None:
2749
branch = from_branch
2751
branch = a_bzrdir.open_branch()
2752
if revision_id is None:
2753
revision_id = _mod_revision.ensure_null(branch.last_revision())
2756
branch.generate_revision_history(revision_id)
2760
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2766
basis_tree = branch.repository.revision_tree(revision_id)
2767
if basis_tree.inventory.root is not None:
2768
wt.set_root_id(basis_tree.get_root_id())
2769
# set the parent list and cache the basis tree.
2770
if _mod_revision.is_null(revision_id):
2773
parent_trees = [(revision_id, basis_tree)]
2774
wt.set_parent_trees(parent_trees)
2775
transform.build_tree(basis_tree, wt)
2779
super(WorkingTreeFormat2, self).__init__()
2780
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2782
def open(self, a_bzrdir, _found=False):
2783
"""Return the WorkingTree object for a_bzrdir
2785
_found is a private parameter, do not use it. It is used to indicate
2786
if format probing has already been done.
2789
# we are being called directly and must probe.
2790
raise NotImplementedError
2791
if not isinstance(a_bzrdir.transport, LocalTransport):
2792
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2793
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2799
class WorkingTreeFormat3(WorkingTreeFormat):
2800
"""The second working tree format updated to record a format marker.
2803
- exists within a metadir controlling .bzr
2804
- includes an explicit version marker for the workingtree control
2805
files, separate from the BzrDir format
2806
- modifies the hash cache format
2808
- uses a LockDir to guard access for writes.
2811
upgrade_recommended = True
2813
def get_format_string(self):
2814
"""See WorkingTreeFormat.get_format_string()."""
2815
return "Bazaar-NG Working Tree format 3"
2817
def get_format_description(self):
2818
"""See WorkingTreeFormat.get_format_description()."""
2819
return "Working tree format 3"
2821
_lock_file_name = 'lock'
2822
_lock_class = LockDir
2824
_tree_class = WorkingTree3
2826
def __get_matchingbzrdir(self):
2827
return bzrdir.BzrDirMetaFormat1()
2829
_matchingbzrdir = property(__get_matchingbzrdir)
2831
def _open_control_files(self, a_bzrdir):
2832
transport = a_bzrdir.get_workingtree_transport(None)
2833
return LockableFiles(transport, self._lock_file_name,
2836
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2837
accelerator_tree=None, hardlink=False):
2838
"""See WorkingTreeFormat.initialize().
2840
:param revision_id: if supplied, create a working tree at a different
2841
revision than the branch is at.
2842
:param accelerator_tree: A tree which can be used for retrieving file
2843
contents more quickly than the revision tree, i.e. a workingtree.
2844
The revision tree will be used for cases where accelerator_tree's
2845
content is different.
2846
:param hardlink: If true, hard-link files from accelerator_tree,
2849
if not isinstance(a_bzrdir.transport, LocalTransport):
2850
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2851
transport = a_bzrdir.get_workingtree_transport(self)
2852
control_files = self._open_control_files(a_bzrdir)
2853
control_files.create_lock()
2854
control_files.lock_write()
2855
transport.put_bytes('format', self.get_format_string(),
2856
mode=control_files._file_mode)
2857
if from_branch is not None:
2858
branch = from_branch
2860
branch = a_bzrdir.open_branch()
2861
if revision_id is None:
2862
revision_id = _mod_revision.ensure_null(branch.last_revision())
2863
# WorkingTree3 can handle an inventory which has a unique root id.
2864
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2865
# those trees. And because there isn't a format bump inbetween, we
2866
# are maintaining compatibility with older clients.
2867
# inv = Inventory(root_id=gen_root_id())
2868
inv = self._initial_inventory()
2869
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2875
_control_files=control_files)
2876
wt.lock_tree_write()
2878
basis_tree = branch.repository.revision_tree(revision_id)
2879
# only set an explicit root id if there is one to set.
2880
if basis_tree.inventory.root is not None:
2881
wt.set_root_id(basis_tree.get_root_id())
2882
if revision_id == NULL_REVISION:
2883
wt.set_parent_trees([])
2885
wt.set_parent_trees([(revision_id, basis_tree)])
2886
transform.build_tree(basis_tree, wt)
2888
# Unlock in this order so that the unlock-triggers-flush in
2889
# WorkingTree is given a chance to fire.
2890
control_files.unlock()
2894
def _initial_inventory(self):
2898
super(WorkingTreeFormat3, self).__init__()
2900
def open(self, a_bzrdir, _found=False):
2901
"""Return the WorkingTree object for a_bzrdir
2903
_found is a private parameter, do not use it. It is used to indicate
2904
if format probing has already been done.
2907
# we are being called directly and must probe.
2908
raise NotImplementedError
2909
if not isinstance(a_bzrdir.transport, LocalTransport):
2910
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2911
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2914
def _open(self, a_bzrdir, control_files):
2915
"""Open the tree itself.
2917
:param a_bzrdir: the dir for the tree.
2918
:param control_files: the control files for the tree.
2920
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2924
_control_files=control_files)
2927
return self.get_format_string()
2930
__default_format = WorkingTreeFormat4()
2931
WorkingTreeFormat.register_format(__default_format)
2932
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2933
WorkingTreeFormat.set_default_format(__default_format)
2934
# formats which have no format string are not discoverable
2935
# and not independently creatable, so are not registered.
2936
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
