/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Colin D Bennett
  • Date: 2009-02-12 16:57:39 UTC
  • mto: This revision was merged to the branch mainline in revision 4008.
  • Revision ID: colin@gibibit.com-20090212165739-02xv63odccfmxomw
Generate PDF version of the User Guide.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/workingtree.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""WorkingTree object and friends.
18
18
 
19
19
A WorkingTree represents the editable working copy of a branch.
20
 
Operations which represent the WorkingTree are also done here,
21
 
such as renaming or adding files.  The WorkingTree has an inventory
22
 
which is updated by these operations.  A commit produces a
 
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
23
new revision based on the workingtree and its inventory.
24
24
 
25
25
At the moment every WorkingTree has its own branch.  Remote
29
29
WorkingTree.open(dir).
30
30
"""
31
31
 
 
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)
32
38
 
33
39
from cStringIO import StringIO
34
40
import os
42
48
import itertools
43
49
import operator
44
50
import stat
 
51
from time import time
 
52
import warnings
45
53
import re
46
54
 
47
55
import bzrlib
49
57
    branch,
50
58
    bzrdir,
51
59
    conflicts as _mod_conflicts,
 
60
    dirstate,
52
61
    errors,
53
62
    generate_ids,
54
63
    globbing,
55
 
    graph as _mod_graph,
56
64
    hashcache,
57
65
    ignores,
58
 
    inventory,
59
66
    merge,
60
67
    revision as _mod_revision,
61
68
    revisiontree,
 
69
    repository,
 
70
    textui,
62
71
    trace,
63
72
    transform,
64
73
    ui,
65
 
    views,
 
74
    urlutils,
66
75
    xml5,
 
76
    xml6,
67
77
    xml7,
68
78
    )
69
79
import bzrlib.branch
70
80
from bzrlib.transport import get_transport
71
 
from bzrlib.workingtree_4 import (
72
 
    WorkingTreeFormat4,
73
 
    WorkingTreeFormat5,
74
 
    WorkingTreeFormat6,
75
 
    )
 
81
import bzrlib.ui
 
82
from bzrlib.workingtree_4 import WorkingTreeFormat4, WorkingTreeFormat5
76
83
""")
77
84
 
78
85
from bzrlib import symbol_versioning
79
86
from bzrlib.decorators import needs_read_lock, needs_write_lock
80
 
from bzrlib.lock import LogicalLockResult
 
87
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
81
88
from bzrlib.lockable_files import LockableFiles
82
89
from bzrlib.lockdir import LockDir
83
90
import bzrlib.mutabletree
84
91
from bzrlib.mutabletree import needs_tree_write_lock
85
92
from bzrlib import osutils
86
93
from bzrlib.osutils import (
 
94
    compact_date,
87
95
    file_kind,
88
96
    isdir,
89
97
    normpath,
90
98
    pathjoin,
 
99
    rand_chars,
91
100
    realpath,
92
101
    safe_unicode,
93
102
    splitpath,
94
103
    supports_executable,
95
104
    )
96
 
from bzrlib.filters import filtered_input_file
97
105
from bzrlib.trace import mutter, note
98
106
from bzrlib.transport.local import LocalTransport
99
 
from bzrlib.revision import CURRENT_REVISION
 
107
from bzrlib.progress import DummyProgress, ProgressPhase
 
108
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
100
109
from bzrlib.rio import RioReader, rio_file, Stanza
101
 
from bzrlib.symbol_versioning import (
102
 
    deprecated_passed,
103
 
    DEPRECATED_PARAMETER,
104
 
    )
 
110
from bzrlib.symbol_versioning import (deprecated_passed,
 
111
        deprecated_method,
 
112
        deprecated_function,
 
113
        DEPRECATED_PARAMETER,
 
114
        )
105
115
 
106
116
 
107
117
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
108
 
# TODO: Modifying the conflict objects or their type is currently nearly
109
 
# impossible as there is no clear relationship between the working tree format
110
 
# and the conflict list file format.
111
118
CONFLICT_HEADER_1 = "BZR conflict list format 1"
112
119
 
113
120
ERROR_PATH_NOT_FOUND = 3    # WindowsError errno code, equivalent to ENOENT
116
123
class TreeEntry(object):
117
124
    """An entry that implements the minimum interface used by commands.
118
125
 
119
 
    This needs further inspection, it may be better to have
 
126
    This needs further inspection, it may be better to have 
120
127
    InventoryEntries without ids - though that seems wrong. For now,
121
128
    this is a parallel hierarchy to InventoryEntry, and needs to become
122
129
    one of several things: decorates to that hierarchy, children of, or
125
132
    no InventoryEntry available - i.e. for unversioned objects.
126
133
    Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
127
134
    """
128
 
 
 
135
 
129
136
    def __eq__(self, other):
130
137
        # yes, this us ugly, TODO: best practice __eq__ style.
131
138
        return (isinstance(other, TreeEntry)
132
139
                and other.__class__ == self.__class__)
133
 
 
 
140
 
134
141
    def kind_character(self):
135
142
        return "???"
136
143
 
168
175
        return ''
169
176
 
170
177
 
171
 
class WorkingTree(bzrlib.mutabletree.MutableTree,
172
 
    bzrdir.ControlComponent):
 
178
class WorkingTree(bzrlib.mutabletree.MutableTree):
173
179
    """Working copy tree.
174
180
 
175
181
    The inventory is held in the `Branch` working-inventory, and the
179
185
    not listed in the Inventory and vice versa.
180
186
    """
181
187
 
182
 
    # override this to set the strategy for storing views
183
 
    def _make_views(self):
184
 
        return views.DisabledViews(self)
185
 
 
186
188
    def __init__(self, basedir='.',
187
189
                 branch=DEPRECATED_PARAMETER,
188
190
                 _inventory=None,
223
225
        wt_trans = self.bzrdir.get_workingtree_transport(None)
224
226
        cache_filename = wt_trans.local_abspath('stat-cache')
225
227
        self._hashcache = hashcache.HashCache(basedir, cache_filename,
226
 
            self.bzrdir._get_file_mode(),
227
 
            self._content_filter_stack_provider())
 
228
            self.bzrdir._get_file_mode())
228
229
        hc = self._hashcache
229
230
        hc.read()
230
231
        # is this scan needed ? it makes things kinda slow.
246
247
            self._set_inventory(_inventory, dirty=False)
247
248
        self._detect_case_handling()
248
249
        self._rules_searcher = None
249
 
        self.views = self._make_views()
250
 
 
251
 
    @property
252
 
    def user_transport(self):
253
 
        return self.bzrdir.user_transport
254
 
 
255
 
    @property
256
 
    def control_transport(self):
257
 
        return self._transport
258
250
 
259
251
    def _detect_case_handling(self):
260
252
        wt_trans = self.bzrdir.get_workingtree_transport(None)
286
278
        self._control_files.break_lock()
287
279
        self.branch.break_lock()
288
280
 
289
 
    def _get_check_refs(self):
290
 
        """Return the references needed to perform a check of this tree.
291
 
        
292
 
        The default implementation returns no refs, and is only suitable for
293
 
        trees that have no local caching and can commit on ghosts at any time.
294
 
 
295
 
        :seealso: bzrlib.check for details about check_refs.
296
 
        """
297
 
        return []
298
 
 
299
281
    def requires_rich_root(self):
300
282
        return self._format.requires_rich_root
301
283
 
306
288
        return self._format.supports_content_filtering()
307
289
 
308
290
    def supports_views(self):
309
 
        return self.views.supports_views()
 
291
        return self._format.supports_views()
310
292
 
311
293
    def _set_inventory(self, inv, dirty):
312
294
        """Set the internal cached inventory.
401
383
 
402
384
    def basis_tree(self):
403
385
        """Return RevisionTree for the current last revision.
404
 
 
 
386
        
405
387
        If the left most parent is a ghost then the returned tree will be an
406
 
        empty tree - one obtained by calling
 
388
        empty tree - one obtained by calling 
407
389
        repository.revision_tree(NULL_REVISION).
408
390
        """
409
391
        try:
425
407
            return self.branch.repository.revision_tree(revision_id)
426
408
        except (errors.RevisionNotPresent, errors.NoSuchRevision):
427
409
            # the basis tree *may* be a ghost or a low level error may have
428
 
            # occurred. If the revision is present, its a problem, if its not
 
410
            # occured. If the revision is present, its a problem, if its not
429
411
            # its a ghost.
430
412
            if self.branch.repository.has_revision(revision_id):
431
413
                raise
438
420
 
439
421
    def relpath(self, path):
440
422
        """Return the local path portion from a given path.
441
 
 
442
 
        The path may be absolute or relative. If its a relative path it is
 
423
        
 
424
        The path may be absolute or relative. If its a relative path it is 
443
425
        interpreted relative to the python current working directory.
444
426
        """
445
427
        return osutils.relpath(self.basedir, path)
447
429
    def has_filename(self, filename):
448
430
        return osutils.lexists(self.abspath(filename))
449
431
 
450
 
    def get_file(self, file_id, path=None, filtered=True):
451
 
        return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
 
432
    def get_file(self, file_id, path=None):
 
433
        return self.get_file_with_stat(file_id, path)[0]
452
434
 
453
 
    def get_file_with_stat(self, file_id, path=None, filtered=True,
454
 
        _fstat=os.fstat):
455
 
        """See Tree.get_file_with_stat."""
 
435
    def get_file_with_stat(self, file_id, path=None, _fstat=os.fstat):
 
436
        """See MutableTree.get_file_with_stat."""
456
437
        if path is None:
457
438
            path = self.id2path(file_id)
458
 
        file_obj = self.get_file_byname(path, filtered=False)
459
 
        stat_value = _fstat(file_obj.fileno())
460
 
        if filtered and self.supports_content_filtering():
461
 
            filters = self._content_filter_stack(path)
462
 
            file_obj = filtered_input_file(file_obj, filters)
463
 
        return (file_obj, stat_value)
464
 
 
465
 
    def get_file_text(self, file_id, path=None, filtered=True):
466
 
        return self.get_file(file_id, path=path, filtered=filtered).read()
467
 
 
468
 
    def get_file_byname(self, filename, filtered=True):
469
 
        path = self.abspath(filename)
470
 
        f = file(path, 'rb')
471
 
        if filtered and self.supports_content_filtering():
472
 
            filters = self._content_filter_stack(filename)
473
 
            return filtered_input_file(f, filters)
474
 
        else:
475
 
            return f
476
 
 
477
 
    def get_file_lines(self, file_id, path=None, filtered=True):
 
439
        file_obj = self.get_file_byname(path)
 
440
        return (file_obj, _fstat(file_obj.fileno()))
 
441
 
 
442
    def get_file_byname(self, filename):
 
443
        return file(self.abspath(filename), 'rb')
 
444
 
 
445
    def get_file_lines(self, file_id, path=None):
478
446
        """See Tree.get_file_lines()"""
479
 
        file = self.get_file(file_id, path, filtered=filtered)
 
447
        file = self.get_file(file_id, path)
480
448
        try:
481
449
            return file.readlines()
482
450
        finally:
493
461
        incorrectly attributed to CURRENT_REVISION (but after committing, the
494
462
        attribution will be correct).
495
463
        """
496
 
        maybe_file_parent_keys = []
497
 
        for parent_id in self.get_parent_ids():
498
 
            try:
499
 
                parent_tree = self.revision_tree(parent_id)
500
 
            except errors.NoSuchRevisionInTree:
501
 
                parent_tree = self.branch.repository.revision_tree(parent_id)
502
 
            parent_tree.lock_read()
503
 
            try:
504
 
                if file_id not in parent_tree:
505
 
                    continue
506
 
                ie = parent_tree.inventory[file_id]
507
 
                if ie.kind != 'file':
508
 
                    # Note: this is slightly unnecessary, because symlinks and
509
 
                    # directories have a "text" which is the empty text, and we
510
 
                    # know that won't mess up annotations. But it seems cleaner
511
 
                    continue
512
 
                parent_text_key = (file_id, ie.revision)
513
 
                if parent_text_key not in maybe_file_parent_keys:
514
 
                    maybe_file_parent_keys.append(parent_text_key)
515
 
            finally:
516
 
                parent_tree.unlock()
517
 
        graph = _mod_graph.Graph(self.branch.repository.texts)
518
 
        heads = graph.heads(maybe_file_parent_keys)
519
 
        file_parent_keys = []
520
 
        for key in maybe_file_parent_keys:
521
 
            if key in heads:
522
 
                file_parent_keys.append(key)
523
 
 
524
 
        # Now we have the parents of this content
525
 
        annotator = self.branch.repository.texts.get_annotator()
526
 
        text = self.get_file(file_id).read()
527
 
        this_key =(file_id, default_revision)
528
 
        annotator.add_special_text(this_key, file_parent_keys, text)
529
 
        annotations = [(key[-1], line)
530
 
                       for key, line in annotator.annotate_flat(this_key)]
531
 
        return annotations
 
464
        basis = self.basis_tree()
 
465
        basis.lock_read()
 
466
        try:
 
467
            changes = self.iter_changes(basis, True, [self.id2path(file_id)],
 
468
                require_versioned=True).next()
 
469
            changed_content, kind = changes[2], changes[6]
 
470
            if not changed_content:
 
471
                return basis.annotate_iter(file_id)
 
472
            if kind[1] is None:
 
473
                return None
 
474
            import annotate
 
475
            if kind[0] != 'file':
 
476
                old_lines = []
 
477
            else:
 
478
                old_lines = list(basis.annotate_iter(file_id))
 
479
            old = [old_lines]
 
480
            for tree in self.branch.repository.revision_trees(
 
481
                self.get_parent_ids()[1:]):
 
482
                if file_id not in tree:
 
483
                    continue
 
484
                old.append(list(tree.annotate_iter(file_id)))
 
485
            return annotate.reannotate(old, self.get_file(file_id).readlines(),
 
486
                                       default_revision)
 
487
        finally:
 
488
            basis.unlock()
532
489
 
533
490
    def _get_ancestors(self, default_revision):
534
491
        ancestors = set([default_revision])
539
496
 
540
497
    def get_parent_ids(self):
541
498
        """See Tree.get_parent_ids.
542
 
 
 
499
        
543
500
        This implementation reads the pending merges list and last_revision
544
501
        value and uses that to decide what the parents list should be.
545
502
        """
549
506
        else:
550
507
            parents = [last_rev]
551
508
        try:
552
 
            merges_bytes = self._transport.get_bytes('pending-merges')
 
509
            merges_file = self._transport.get('pending-merges')
553
510
        except errors.NoSuchFile:
554
511
            pass
555
512
        else:
556
 
            for l in osutils.split_lines(merges_bytes):
 
513
            for l in merges_file.readlines():
557
514
                revision_id = l.rstrip('\n')
558
515
                parents.append(revision_id)
559
516
        return parents
562
519
    def get_root_id(self):
563
520
        """Return the id of this trees root"""
564
521
        return self._inventory.root.file_id
565
 
 
 
522
        
566
523
    def _get_store_filename(self, file_id):
567
524
        ## XXX: badly named; this is not in the store at all
568
525
        return self.abspath(self.id2path(file_id))
570
527
    @needs_read_lock
571
528
    def clone(self, to_bzrdir, revision_id=None):
572
529
        """Duplicate this working tree into to_bzr, including all state.
573
 
 
 
530
        
574
531
        Specifically modified files are kept as modified, but
575
532
        ignored and unknown files are discarded.
576
533
 
577
534
        If you want to make a new line of development, see bzrdir.sprout()
578
535
 
579
536
        revision
580
 
            If not None, the cloned tree will have its last revision set to
581
 
            revision, and difference between the source trees last revision
 
537
            If not None, the cloned tree will have its last revision set to 
 
538
            revision, and and difference between the source trees last revision
582
539
            and this one merged in.
583
540
        """
584
541
        # assumes the target bzr dir format is compatible.
618
575
 
619
576
    def get_file_size(self, file_id):
620
577
        """See Tree.get_file_size"""
621
 
        # XXX: this returns the on-disk size; it should probably return the
622
 
        # canonical size
623
578
        try:
624
579
            return os.path.getsize(self.id2abspath(file_id))
625
580
        except OSError, e:
641
596
 
642
597
    def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
643
598
        file_id = self.path2id(path)
644
 
        if file_id is None:
645
 
            # For unversioned files on win32, we just assume they are not
646
 
            # executable
647
 
            return False
648
599
        return self._inventory[file_id].executable
649
600
 
650
601
    def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
672
623
        """See MutableTree._add."""
673
624
        # TODO: Re-adding a file that is removed in the working copy
674
625
        # should probably put it back with the previous ID.
675
 
        # the read and write working inventory should not occur in this
 
626
        # the read and write working inventory should not occur in this 
676
627
        # function - they should be part of lock_write and unlock.
677
628
        inv = self.inventory
678
629
        for f, file_id, kind in zip(files, ids, kinds):
760
711
            raise
761
712
        kind = _mapper(stat_result.st_mode)
762
713
        if kind == 'file':
763
 
            return self._file_content_summary(path, stat_result)
 
714
            size = stat_result.st_size
 
715
            # try for a stat cache lookup
 
716
            executable = self._is_executable_from_path_and_stat(path, stat_result)
 
717
            return (kind, size, executable, self._sha_from_stat(
 
718
                path, stat_result))
764
719
        elif kind == 'directory':
765
720
            # perhaps it looks like a plain directory, but it's really a
766
721
            # reference.
768
723
                kind = 'tree-reference'
769
724
            return kind, None, None, None
770
725
        elif kind == 'symlink':
771
 
            target = osutils.readlink(abspath)
772
 
            return ('symlink', None, None, target)
 
726
            return ('symlink', None, None, os.readlink(abspath.encode(osutils._fs_enc)))
773
727
        else:
774
728
            return (kind, None, None, None)
775
729
 
776
 
    def _file_content_summary(self, path, stat_result):
777
 
        size = stat_result.st_size
778
 
        executable = self._is_executable_from_path_and_stat(path, stat_result)
779
 
        # try for a stat cache lookup
780
 
        return ('file', size, executable, self._sha_from_stat(
781
 
            path, stat_result))
782
 
 
783
730
    def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
784
731
        """Common ghost checking functionality from set_parent_*.
785
732
 
795
742
    def _set_merges_from_parent_ids(self, parent_ids):
796
743
        merges = parent_ids[1:]
797
744
        self._transport.put_bytes('pending-merges', '\n'.join(merges),
798
 
            mode=self.bzrdir._get_file_mode())
 
745
            mode=self._control_files._file_mode)
799
746
 
800
747
    def _filter_parent_ids_by_ancestry(self, revision_ids):
801
748
        """Check that all merged revisions are proper 'heads'.
802
749
 
803
750
        This will always return the first revision_id, and any merged revisions
804
 
        which are
 
751
        which are 
805
752
        """
806
753
        if len(revision_ids) == 0:
807
754
            return revision_ids
819
766
    @needs_tree_write_lock
820
767
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
821
768
        """Set the parent ids to revision_ids.
822
 
 
 
769
        
823
770
        See also set_parent_trees. This api will try to retrieve the tree data
824
771
        for each element of revision_ids from the trees repository. If you have
825
772
        tree data already available, it is more efficient to use
901
848
        self._must_be_locked()
902
849
        my_file = rio_file(stanzas, header)
903
850
        self._transport.put_file(filename, my_file,
904
 
            mode=self.bzrdir._get_file_mode())
 
851
            mode=self._control_files._file_mode)
905
852
 
906
853
    @needs_write_lock # because merge pulls data into the branch.
907
854
    def merge_from_branch(self, branch, to_revision=None, from_revision=None,
908
 
                          merge_type=None, force=False):
 
855
        merge_type=None):
909
856
        """Merge from a branch into this working tree.
910
857
 
911
858
        :param branch: The branch to merge from.
915
862
            branch.last_revision().
916
863
        """
917
864
        from bzrlib.merge import Merger, Merge3Merger
918
 
        merger = Merger(self.branch, this_tree=self)
919
 
        # check that there are no local alterations
920
 
        if not force and self.has_changes():
921
 
            raise errors.UncommittedChanges(self)
922
 
        if to_revision is None:
923
 
            to_revision = _mod_revision.ensure_null(branch.last_revision())
924
 
        merger.other_rev_id = to_revision
925
 
        if _mod_revision.is_null(merger.other_rev_id):
926
 
            raise errors.NoCommits(branch)
927
 
        self.branch.fetch(branch, last_revision=merger.other_rev_id)
928
 
        merger.other_basis = merger.other_rev_id
929
 
        merger.other_tree = self.branch.repository.revision_tree(
930
 
            merger.other_rev_id)
931
 
        merger.other_branch = branch
932
 
        if from_revision is None:
933
 
            merger.find_base()
934
 
        else:
935
 
            merger.set_base_revision(from_revision, branch)
936
 
        if merger.base_rev_id == merger.other_rev_id:
937
 
            raise errors.PointlessMerge
938
 
        merger.backup_files = False
939
 
        if merge_type is None:
940
 
            merger.merge_type = Merge3Merger
941
 
        else:
942
 
            merger.merge_type = merge_type
943
 
        merger.set_interesting_files(None)
944
 
        merger.show_base = False
945
 
        merger.reprocess = False
946
 
        conflicts = merger.do_merge()
947
 
        merger.set_pending()
 
865
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
866
        try:
 
867
            merger = Merger(self.branch, this_tree=self, pb=pb)
 
868
            merger.pp = ProgressPhase("Merge phase", 5, pb)
 
869
            merger.pp.next_phase()
 
870
            # check that there are no
 
871
            # local alterations
 
872
            merger.check_basis(check_clean=True, require_commits=False)
 
873
            if to_revision is None:
 
874
                to_revision = _mod_revision.ensure_null(branch.last_revision())
 
875
            merger.other_rev_id = to_revision
 
876
            if _mod_revision.is_null(merger.other_rev_id):
 
877
                raise errors.NoCommits(branch)
 
878
            self.branch.fetch(branch, last_revision=merger.other_rev_id)
 
879
            merger.other_basis = merger.other_rev_id
 
880
            merger.other_tree = self.branch.repository.revision_tree(
 
881
                merger.other_rev_id)
 
882
            merger.other_branch = branch
 
883
            merger.pp.next_phase()
 
884
            if from_revision is None:
 
885
                merger.find_base()
 
886
            else:
 
887
                merger.set_base_revision(from_revision, branch)
 
888
            if merger.base_rev_id == merger.other_rev_id:
 
889
                raise errors.PointlessMerge
 
890
            merger.backup_files = False
 
891
            if merge_type is None:
 
892
                merger.merge_type = Merge3Merger
 
893
            else:
 
894
                merger.merge_type = merge_type
 
895
            merger.set_interesting_files(None)
 
896
            merger.show_base = False
 
897
            merger.reprocess = False
 
898
            conflicts = merger.do_merge()
 
899
            merger.set_pending()
 
900
        finally:
 
901
            pb.finished()
948
902
        return conflicts
949
903
 
950
904
    @needs_read_lock
951
905
    def merge_modified(self):
952
906
        """Return a dictionary of files modified by a merge.
953
907
 
954
 
        The list is initialized by WorkingTree.set_merge_modified, which is
 
908
        The list is initialized by WorkingTree.set_merge_modified, which is 
955
909
        typically called after we make some automatic updates to the tree
956
910
        because of a merge.
957
911
 
991
945
        return file_id
992
946
 
993
947
    def get_symlink_target(self, file_id):
994
 
        abspath = self.id2abspath(file_id)
995
 
        target = osutils.readlink(abspath)
996
 
        return target
 
948
        return os.readlink(self.id2abspath(file_id).encode(osutils._fs_enc))
997
949
 
998
950
    @needs_write_lock
999
951
    def subsume(self, other_tree):
1049
1001
        return False
1050
1002
 
1051
1003
    def _directory_may_be_tree_reference(self, relpath):
1052
 
        # as a special case, if a directory contains control files then
 
1004
        # as a special case, if a directory contains control files then 
1053
1005
        # it's a tree reference, except that the root of the tree is not
1054
1006
        return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1055
1007
        # TODO: We could ask all the control formats whether they
1066
1018
    @needs_tree_write_lock
1067
1019
    def extract(self, file_id, format=None):
1068
1020
        """Extract a subtree from this tree.
1069
 
 
 
1021
        
1070
1022
        A new branch will be created, relative to the path for this tree.
1071
1023
        """
1072
1024
        self.flush()
1077
1029
                transport = transport.clone(name)
1078
1030
                transport.ensure_base()
1079
1031
            return transport
1080
 
 
 
1032
            
1081
1033
        sub_path = self.id2path(file_id)
1082
1034
        branch_transport = mkdirs(sub_path)
1083
1035
        if format is None:
1097
1049
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
1098
1050
        if tree_transport.base != branch_transport.base:
1099
1051
            tree_bzrdir = format.initialize_on_transport(tree_transport)
1100
 
            branch.BranchReferenceFormat().initialize(tree_bzrdir,
1101
 
                target_branch=new_branch)
 
1052
            branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1102
1053
        else:
1103
1054
            tree_bzrdir = branch_bzrdir
1104
 
        wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
 
1055
        wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1105
1056
        wt.set_parent_ids(self.get_parent_ids())
1106
1057
        my_inv = self.inventory
1107
 
        child_inv = inventory.Inventory(root_id=None)
 
1058
        child_inv = Inventory(root_id=None)
1108
1059
        new_root = my_inv[file_id]
1109
1060
        my_inv.remove_recursive_id(file_id)
1110
1061
        new_root.parent_id = None
1129
1080
        self._serialize(self._inventory, sio)
1130
1081
        sio.seek(0)
1131
1082
        self._transport.put_file('inventory', sio,
1132
 
            mode=self.bzrdir._get_file_mode())
 
1083
            mode=self._control_files._file_mode)
1133
1084
        self._inventory_is_modified = False
1134
1085
 
1135
1086
    def _kind(self, relpath):
1136
1087
        return osutils.file_kind(self.abspath(relpath))
1137
1088
 
1138
 
    def list_files(self, include_root=False, from_dir=None, recursive=True):
1139
 
        """List all files as (path, class, kind, id, entry).
 
1089
    def list_files(self, include_root=False):
 
1090
        """Recursively list all files as (path, class, kind, id, entry).
1140
1091
 
1141
1092
        Lists, but does not descend into unversioned directories.
 
1093
 
1142
1094
        This does not include files that have been deleted in this
1143
 
        tree. Skips the control directory.
 
1095
        tree.
1144
1096
 
1145
 
        :param include_root: if True, return an entry for the root
1146
 
        :param from_dir: start from this directory or None for the root
1147
 
        :param recursive: whether to recurse into subdirectories or not
 
1097
        Skips the control directory.
1148
1098
        """
1149
1099
        # list_files is an iterator, so @needs_read_lock doesn't work properly
1150
1100
        # with it. So callers should be careful to always read_lock the tree.
1152
1102
            raise errors.ObjectNotLocked(self)
1153
1103
 
1154
1104
        inv = self.inventory
1155
 
        if from_dir is None and include_root is True:
 
1105
        if include_root is True:
1156
1106
            yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1157
1107
        # Convert these into local objects to save lookup times
1158
1108
        pathjoin = osutils.pathjoin
1165
1115
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1166
1116
 
1167
1117
        # directory file_id, relative path, absolute path, reverse sorted children
1168
 
        if from_dir is not None:
1169
 
            from_dir_id = inv.path2id(from_dir)
1170
 
            if from_dir_id is None:
1171
 
                # Directory not versioned
1172
 
                return
1173
 
            from_dir_abspath = pathjoin(self.basedir, from_dir)
1174
 
        else:
1175
 
            from_dir_id = inv.root.file_id
1176
 
            from_dir_abspath = self.basedir
1177
 
        children = os.listdir(from_dir_abspath)
 
1118
        children = os.listdir(self.basedir)
1178
1119
        children.sort()
1179
 
        # jam 20060527 The kernel sized tree seems equivalent whether we
 
1120
        # jam 20060527 The kernel sized tree seems equivalent whether we 
1180
1121
        # use a deque and popleft to keep them sorted, or if we use a plain
1181
1122
        # list and just reverse() them.
1182
1123
        children = collections.deque(children)
1183
 
        stack = [(from_dir_id, u'', from_dir_abspath, children)]
 
1124
        stack = [(inv.root.file_id, u'', self.basedir, children)]
1184
1125
        while stack:
1185
1126
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1186
1127
 
1202
1143
 
1203
1144
                # absolute path
1204
1145
                fap = from_dir_abspath + '/' + f
1205
 
 
 
1146
                
1206
1147
                f_ie = inv.get_child(from_dir_id, f)
1207
1148
                if f_ie:
1208
1149
                    c = 'V'
1240
1181
                    except KeyError:
1241
1182
                        yield fp[1:], c, fk, None, TreeEntry()
1242
1183
                    continue
1243
 
 
 
1184
                
1244
1185
                if fk != 'directory':
1245
1186
                    continue
1246
1187
 
1247
 
                # But do this child first if recursing down
1248
 
                if recursive:
1249
 
                    new_children = os.listdir(fap)
1250
 
                    new_children.sort()
1251
 
                    new_children = collections.deque(new_children)
1252
 
                    stack.append((f_ie.file_id, fp, fap, new_children))
1253
 
                    # Break out of inner loop,
1254
 
                    # so that we start outer loop with child
1255
 
                    break
 
1188
                # But do this child first
 
1189
                new_children = os.listdir(fap)
 
1190
                new_children.sort()
 
1191
                new_children = collections.deque(new_children)
 
1192
                stack.append((f_ie.file_id, fp, fap, new_children))
 
1193
                # Break out of inner loop,
 
1194
                # so that we start outer loop with child
 
1195
                break
1256
1196
            else:
1257
1197
                # if we finished all children, pop it off the stack
1258
1198
                stack.pop()
1264
1204
        to_dir must exist in the inventory.
1265
1205
 
1266
1206
        If to_dir exists and is a directory, the files are moved into
1267
 
        it, keeping their old names.
 
1207
        it, keeping their old names.  
1268
1208
 
1269
1209
        Note that to_dir is only the last component of the new name;
1270
1210
        this doesn't change the directory.
1436
1376
        inv = self.inventory
1437
1377
        for entry in moved:
1438
1378
            try:
1439
 
                self._move_entry(WorkingTree._RenameEntry(
1440
 
                    entry.to_rel, entry.from_id,
 
1379
                self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1441
1380
                    entry.to_tail, entry.to_parent_id, entry.from_rel,
1442
1381
                    entry.from_tail, entry.from_parent_id,
1443
1382
                    entry.only_change_inv))
1494
1433
        from_tail = splitpath(from_rel)[-1]
1495
1434
        from_id = inv.path2id(from_rel)
1496
1435
        if from_id is None:
1497
 
            # if file is missing in the inventory maybe it's in the basis_tree
1498
 
            basis_tree = self.branch.basis_tree()
1499
 
            from_id = basis_tree.path2id(from_rel)
1500
 
            if from_id is None:
1501
 
                raise errors.BzrRenameFailedError(from_rel,to_rel,
1502
 
                    errors.NotVersionedError(path=str(from_rel)))
1503
 
            # put entry back in the inventory so we can rename it
1504
 
            from_entry = basis_tree.inventory[from_id].copy()
1505
 
            inv.add(from_entry)
1506
 
        else:
1507
 
            from_entry = inv[from_id]
 
1436
            raise errors.BzrRenameFailedError(from_rel,to_rel,
 
1437
                errors.NotVersionedError(path=str(from_rel)))
 
1438
        from_entry = inv[from_id]
1508
1439
        from_parent_id = from_entry.parent_id
1509
1440
        to_dir, to_tail = os.path.split(to_rel)
1510
1441
        to_dir_id = inv.path2id(to_dir)
1556
1487
        These are files in the working directory that are not versioned or
1557
1488
        control files or ignored.
1558
1489
        """
1559
 
        # force the extras method to be fully executed before returning, to
 
1490
        # force the extras method to be fully executed before returning, to 
1560
1491
        # prevent race conditions with the lock
1561
1492
        return iter(
1562
1493
            [subp for subp in self.extras() if not self.is_ignored(subp)])
1572
1503
        :raises: NoSuchId if any fileid is not currently versioned.
1573
1504
        """
1574
1505
        for file_id in file_ids:
1575
 
            if file_id not in self._inventory:
1576
 
                raise errors.NoSuchId(self, file_id)
1577
 
        for file_id in file_ids:
1578
1506
            if self._inventory.has_id(file_id):
1579
1507
                self._inventory.remove_recursive_id(file_id)
 
1508
            else:
 
1509
                raise errors.NoSuchId(self, file_id)
1580
1510
        if len(file_ids):
1581
 
            # in the future this should just set a dirty bit to wait for the
 
1511
            # in the future this should just set a dirty bit to wait for the 
1582
1512
            # final unlock. However, until all methods of workingtree start
1583
 
            # with the current in -memory inventory rather than triggering
 
1513
            # with the current in -memory inventory rather than triggering 
1584
1514
            # a read, it is more complex - we need to teach read_inventory
1585
1515
            # to know when to read, and when to not read first... and possibly
1586
1516
            # to save first when the in memory one may be corrupted.
1587
1517
            # so for now, we just only write it if it is indeed dirty.
1588
1518
            # - RBC 20060907
1589
1519
            self._write_inventory(self._inventory)
1590
 
 
 
1520
    
1591
1521
    def _iter_conflicts(self):
1592
1522
        conflicted = set()
1593
1523
        for info in self.list_files():
1601
1531
 
1602
1532
    @needs_write_lock
1603
1533
    def pull(self, source, overwrite=False, stop_revision=None,
1604
 
             change_reporter=None, possible_transports=None, local=False):
 
1534
             change_reporter=None, possible_transports=None):
 
1535
        top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1605
1536
        source.lock_read()
1606
1537
        try:
 
1538
            pp = ProgressPhase("Pull phase", 2, top_pb)
 
1539
            pp.next_phase()
1607
1540
            old_revision_info = self.branch.last_revision_info()
1608
1541
            basis_tree = self.basis_tree()
1609
1542
            count = self.branch.pull(source, overwrite, stop_revision,
1610
 
                                     possible_transports=possible_transports,
1611
 
                                     local=local)
 
1543
                                     possible_transports=possible_transports)
1612
1544
            new_revision_info = self.branch.last_revision_info()
1613
1545
            if new_revision_info != old_revision_info:
 
1546
                pp.next_phase()
1614
1547
                repository = self.branch.repository
 
1548
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
1615
1549
                basis_tree.lock_read()
1616
1550
                try:
1617
1551
                    new_basis_tree = self.branch.basis_tree()
1620
1554
                                new_basis_tree,
1621
1555
                                basis_tree,
1622
1556
                                this_tree=self,
1623
 
                                pb=None,
 
1557
                                pb=pb,
1624
1558
                                change_reporter=change_reporter)
1625
 
                    basis_root_id = basis_tree.get_root_id()
1626
 
                    new_root_id = new_basis_tree.get_root_id()
1627
 
                    if basis_root_id != new_root_id:
1628
 
                        self.set_root_id(new_root_id)
 
1559
                    if (basis_tree.inventory.root is None and
 
1560
                        new_basis_tree.inventory.root is not None):
 
1561
                        self.set_root_id(new_basis_tree.get_root_id())
1629
1562
                finally:
 
1563
                    pb.finished()
1630
1564
                    basis_tree.unlock()
1631
1565
                # TODO - dedup parents list with things merged by pull ?
1632
1566
                # reuse the revisiontree we merged against to set the new
1633
1567
                # tree data.
1634
1568
                parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1635
 
                # we have to pull the merge trees out again, because
1636
 
                # merge_inner has set the ids. - this corner is not yet
 
1569
                # we have to pull the merge trees out again, because 
 
1570
                # merge_inner has set the ids. - this corner is not yet 
1637
1571
                # layered well enough to prevent double handling.
1638
1572
                # XXX TODO: Fix the double handling: telling the tree about
1639
1573
                # the already known parent data is wasteful.
1645
1579
            return count
1646
1580
        finally:
1647
1581
            source.unlock()
 
1582
            top_pb.finished()
1648
1583
 
1649
1584
    @needs_write_lock
1650
1585
    def put_file_bytes_non_atomic(self, file_id, bytes):
1676
1611
 
1677
1612
            fl = []
1678
1613
            for subf in os.listdir(dirabs):
1679
 
                if self.bzrdir.is_control_filename(subf):
 
1614
                if subf == '.bzr':
1680
1615
                    continue
1681
1616
                if subf not in dir_entry.children:
1682
1617
                    try:
1692
1627
                            fl.append(subf_norm)
1693
1628
                    else:
1694
1629
                        fl.append(subf)
1695
 
 
 
1630
            
1696
1631
            fl.sort()
1697
1632
            for subf in fl:
1698
1633
                subp = pathjoin(path, subf)
1735
1670
        r"""Check whether the filename matches an ignore pattern.
1736
1671
 
1737
1672
        Patterns containing '/' or '\' need to match the whole path;
1738
 
        others match against only the last component.  Patterns starting
1739
 
        with '!' are ignore exceptions.  Exceptions take precedence
1740
 
        over regular patterns and cause the filename to not be ignored.
 
1673
        others match against only the last component.
1741
1674
 
1742
1675
        If the file is ignored, returns the pattern which caused it to
1743
1676
        be ignored, otherwise None.  So this can simply be used as a
1744
1677
        boolean if desired."""
1745
1678
        if getattr(self, '_ignoreglobster', None) is None:
1746
 
            self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
 
1679
            self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1747
1680
        return self._ignoreglobster.match(filename)
1748
1681
 
1749
1682
    def kind(self, file_id):
1799
1732
            raise errors.ObjectNotLocked(self)
1800
1733
 
1801
1734
    def lock_read(self):
1802
 
        """Lock the tree for reading.
1803
 
 
1804
 
        This also locks the branch, and can be unlocked via self.unlock().
1805
 
 
1806
 
        :return: A bzrlib.lock.LogicalLockResult.
1807
 
        """
 
1735
        """See Branch.lock_read, and WorkingTree.unlock."""
1808
1736
        if not self.is_locked():
1809
1737
            self._reset_data()
1810
1738
        self.branch.lock_read()
1811
1739
        try:
1812
 
            self._control_files.lock_read()
1813
 
            return LogicalLockResult(self.unlock)
 
1740
            return self._control_files.lock_read()
1814
1741
        except:
1815
1742
            self.branch.unlock()
1816
1743
            raise
1817
1744
 
1818
1745
    def lock_tree_write(self):
1819
 
        """See MutableTree.lock_tree_write, and WorkingTree.unlock.
1820
 
 
1821
 
        :return: A bzrlib.lock.LogicalLockResult.
1822
 
        """
 
1746
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1823
1747
        if not self.is_locked():
1824
1748
            self._reset_data()
1825
1749
        self.branch.lock_read()
1826
1750
        try:
1827
 
            self._control_files.lock_write()
1828
 
            return LogicalLockResult(self.unlock)
 
1751
            return self._control_files.lock_write()
1829
1752
        except:
1830
1753
            self.branch.unlock()
1831
1754
            raise
1832
1755
 
1833
1756
    def lock_write(self):
1834
 
        """See MutableTree.lock_write, and WorkingTree.unlock.
1835
 
 
1836
 
        :return: A bzrlib.lock.LogicalLockResult.
1837
 
        """
 
1757
        """See MutableTree.lock_write, and WorkingTree.unlock."""
1838
1758
        if not self.is_locked():
1839
1759
            self._reset_data()
1840
1760
        self.branch.lock_write()
1841
1761
        try:
1842
 
            self._control_files.lock_write()
1843
 
            return LogicalLockResult(self.unlock)
 
1762
            return self._control_files.lock_write()
1844
1763
        except:
1845
1764
            self.branch.unlock()
1846
1765
            raise
1854
1773
    def _reset_data(self):
1855
1774
        """Reset transient data that cannot be revalidated."""
1856
1775
        self._inventory_is_modified = False
1857
 
        f = self._transport.get('inventory')
1858
 
        try:
1859
 
            result = self._deserialize(f)
1860
 
        finally:
1861
 
            f.close()
 
1776
        result = self._deserialize(self._transport.get('inventory'))
1862
1777
        self._set_inventory(result, dirty=False)
1863
1778
 
1864
1779
    @needs_tree_write_lock
1869
1784
 
1870
1785
    def _change_last_revision(self, new_revision):
1871
1786
        """Template method part of set_last_revision to perform the change.
1872
 
 
 
1787
        
1873
1788
        This is used to allow WorkingTree3 instances to not affect branch
1874
1789
        when their last revision is set.
1875
1790
        """
1888
1803
        path = self._basis_inventory_name()
1889
1804
        sio = StringIO(xml)
1890
1805
        self._transport.put_file(path, sio,
1891
 
            mode=self.bzrdir._get_file_mode())
 
1806
            mode=self._control_files._file_mode)
1892
1807
 
1893
1808
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
1894
1809
        """Create the text that will be saved in basis-inventory"""
1901
1816
        # as commit already has that ready-to-use [while the format is the
1902
1817
        # same, that is].
1903
1818
        try:
1904
 
            # this double handles the inventory - unpack and repack -
 
1819
            # this double handles the inventory - unpack and repack - 
1905
1820
            # but is easier to understand. We can/should put a conditional
1906
1821
            # in here based on whether the inventory is in the latest format
1907
1822
            # - perhaps we should repack all inventories on a repository
1908
1823
            # upgrade ?
1909
1824
            # the fast path is to copy the raw xml from the repository. If the
1910
 
            # xml contains 'revision_id="', then we assume the right
 
1825
            # xml contains 'revision_id="', then we assume the right 
1911
1826
            # revision_id is set. We must check for this full string, because a
1912
1827
            # root node id can legitimately look like 'revision_id' but cannot
1913
1828
            # contain a '"'.
1914
 
            xml = self.branch.repository._get_inventory_xml(new_revision)
 
1829
            xml = self.branch.repository.get_inventory_xml(new_revision)
1915
1830
            firstline = xml.split('\n', 1)[0]
1916
 
            if (not 'revision_id="' in firstline or
 
1831
            if (not 'revision_id="' in firstline or 
1917
1832
                'format="7"' not in firstline):
1918
 
                inv = self.branch.repository._serializer.read_inventory_from_string(
1919
 
                    xml, new_revision)
 
1833
                inv = self.branch.repository.deserialise_inventory(
 
1834
                    new_revision, xml)
1920
1835
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
1921
1836
            self._write_basis_inventory(xml)
1922
1837
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
1926
1841
        """Read the cached basis inventory."""
1927
1842
        path = self._basis_inventory_name()
1928
1843
        return self._transport.get_bytes(path)
1929
 
 
 
1844
        
1930
1845
    @needs_read_lock
1931
1846
    def read_working_inventory(self):
1932
1847
        """Read the working inventory.
1933
 
 
 
1848
        
1934
1849
        :raises errors.InventoryModified: read_working_inventory will fail
1935
1850
            when the current in memory inventory has been modified.
1936
1851
        """
1937
 
        # conceptually this should be an implementation detail of the tree.
 
1852
        # conceptually this should be an implementation detail of the tree. 
1938
1853
        # XXX: Deprecate this.
1939
1854
        # ElementTree does its own conversion from UTF-8, so open in
1940
1855
        # binary.
1941
1856
        if self._inventory_is_modified:
1942
1857
            raise errors.InventoryModified(self)
1943
 
        f = self._transport.get('inventory')
1944
 
        try:
1945
 
            result = self._deserialize(f)
1946
 
        finally:
1947
 
            f.close()
 
1858
        result = self._deserialize(self._transport.get('inventory'))
1948
1859
        self._set_inventory(result, dirty=False)
1949
1860
        return result
1950
1861
 
1965
1876
 
1966
1877
        new_files=set()
1967
1878
        unknown_nested_files=set()
1968
 
        if to_file is None:
1969
 
            to_file = sys.stdout
1970
1879
 
1971
1880
        def recurse_directory_to_add_files(directory):
1972
1881
            # Recurse directory and add all files
2028
1937
                        tree_delta.unversioned.extend((unknown_file,))
2029
1938
                raise errors.BzrRemoveChangedFilesError(tree_delta)
2030
1939
 
2031
 
        # Build inv_delta and delete files where applicable,
 
1940
        # Build inv_delta and delete files where applicaple,
2032
1941
        # do this before any modifications to inventory.
2033
1942
        for f in files:
2034
1943
            fid = self.path2id(f)
2042
1951
                        new_status = 'I'
2043
1952
                    else:
2044
1953
                        new_status = '?'
2045
 
                    # XXX: Really should be a more abstract reporter interface
2046
 
                    kind_ch = osutils.kind_marker(self.kind(fid))
2047
 
                    to_file.write(new_status + '       ' + f + kind_ch + '\n')
 
1954
                    textui.show_status(new_status, self.kind(fid), f,
 
1955
                                       to_file=to_file)
2048
1956
                # Unversion file
2049
1957
                inv_delta.append((f, None, fid, None))
2050
1958
                message = "removed %s" % (f,)
2073
1981
 
2074
1982
    @needs_tree_write_lock
2075
1983
    def revert(self, filenames=None, old_tree=None, backups=True,
2076
 
               pb=None, report_changes=False):
 
1984
               pb=DummyProgress(), report_changes=False):
2077
1985
        from bzrlib.conflicts import resolve
2078
1986
        if filenames == []:
2079
1987
            filenames = None
2092
2000
            if filenames is None and len(self.get_parent_ids()) > 1:
2093
2001
                parent_trees = []
2094
2002
                last_revision = self.last_revision()
2095
 
                if last_revision != _mod_revision.NULL_REVISION:
 
2003
                if last_revision != NULL_REVISION:
2096
2004
                    if basis_tree is None:
2097
2005
                        basis_tree = self.basis_tree()
2098
2006
                        basis_tree.lock_read()
2136
2044
    def set_inventory(self, new_inventory_list):
2137
2045
        from bzrlib.inventory import (Inventory,
2138
2046
                                      InventoryDirectory,
 
2047
                                      InventoryEntry,
2139
2048
                                      InventoryFile,
2140
2049
                                      InventoryLink)
2141
2050
        inv = Inventory(self.get_root_id())
2143
2052
            name = os.path.basename(path)
2144
2053
            if name == "":
2145
2054
                continue
2146
 
            # fixme, there should be a factory function inv,add_??
 
2055
            # fixme, there should be a factory function inv,add_?? 
2147
2056
            if kind == 'directory':
2148
2057
                inv.add(InventoryDirectory(file_id, name, parent))
2149
2058
            elif kind == 'file':
2157
2066
    @needs_tree_write_lock
2158
2067
    def set_root_id(self, file_id):
2159
2068
        """Set the root id for this tree."""
2160
 
        # for compatability
 
2069
        # for compatability 
2161
2070
        if file_id is None:
2162
2071
            raise ValueError(
2163
2072
                'WorkingTree.set_root_id with fileid=None')
2167
2076
    def _set_root_id(self, file_id):
2168
2077
        """Set the root id for this tree, in a format specific manner.
2169
2078
 
2170
 
        :param file_id: The file id to assign to the root. It must not be
 
2079
        :param file_id: The file id to assign to the root. It must not be 
2171
2080
            present in the current inventory or an error will occur. It must
2172
2081
            not be None, but rather a valid file id.
2173
2082
        """
2192
2101
 
2193
2102
    def unlock(self):
2194
2103
        """See Branch.unlock.
2195
 
 
 
2104
        
2196
2105
        WorkingTree locking just uses the Branch locking facilities.
2197
2106
        This is current because all working trees have an embedded branch
2198
2107
        within them. IF in the future, we were to make branch data shareable
2199
 
        between multiple working trees, i.e. via shared storage, then we
 
2108
        between multiple working trees, i.e. via shared storage, then we 
2200
2109
        would probably want to lock both the local tree, and the branch.
2201
2110
        """
2202
2111
        raise NotImplementedError(self.unlock)
2203
2112
 
2204
 
    _marker = object()
2205
 
 
2206
 
    def update(self, change_reporter=None, possible_transports=None,
2207
 
               revision=None, old_tip=_marker):
 
2113
    def update(self, change_reporter=None, possible_transports=None):
2208
2114
        """Update a working tree along its branch.
2209
2115
 
2210
2116
        This will update the branch if its bound too, which means we have
2228
2134
        - Merge current state -> basis tree of the master w.r.t. the old tree
2229
2135
          basis.
2230
2136
        - Do a 'normal' merge of the old branch basis if it is relevant.
2231
 
 
2232
 
        :param revision: The target revision to update to. Must be in the
2233
 
            revision history.
2234
 
        :param old_tip: If branch.update() has already been run, the value it
2235
 
            returned (old tip of the branch or None). _marker is used
2236
 
            otherwise.
2237
2137
        """
2238
2138
        if self.branch.get_bound_location() is not None:
2239
2139
            self.lock_write()
2240
 
            update_branch = (old_tip is self._marker)
 
2140
            update_branch = True
2241
2141
        else:
2242
2142
            self.lock_tree_write()
2243
2143
            update_branch = False
2245
2145
            if update_branch:
2246
2146
                old_tip = self.branch.update(possible_transports)
2247
2147
            else:
2248
 
                if old_tip is self._marker:
2249
 
                    old_tip = None
2250
 
            return self._update_tree(old_tip, change_reporter, revision)
 
2148
                old_tip = None
 
2149
            return self._update_tree(old_tip, change_reporter)
2251
2150
        finally:
2252
2151
            self.unlock()
2253
2152
 
2254
2153
    @needs_tree_write_lock
2255
 
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
 
2154
    def _update_tree(self, old_tip=None, change_reporter=None):
2256
2155
        """Update a tree to the master branch.
2257
2156
 
2258
2157
        :param old_tip: if supplied, the previous tip revision the branch,
2264
2163
        # cant set that until we update the working trees last revision to be
2265
2164
        # one from the new branch, because it will just get absorbed by the
2266
2165
        # parent de-duplication logic.
2267
 
        #
 
2166
        # 
2268
2167
        # We MUST save it even if an error occurs, because otherwise the users
2269
2168
        # local work is unreferenced and will appear to have been lost.
2270
 
        #
2271
 
        nb_conflicts = 0
 
2169
        # 
 
2170
        result = 0
2272
2171
        try:
2273
2172
            last_rev = self.get_parent_ids()[0]
2274
2173
        except IndexError:
2275
2174
            last_rev = _mod_revision.NULL_REVISION
2276
 
        if revision is None:
2277
 
            revision = self.branch.last_revision()
2278
 
 
2279
 
        old_tip = old_tip or _mod_revision.NULL_REVISION
2280
 
 
2281
 
        if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2282
 
            # the branch we are bound to was updated
2283
 
            # merge those changes in first
2284
 
            base_tree  = self.basis_tree()
2285
 
            other_tree = self.branch.repository.revision_tree(old_tip)
2286
 
            nb_conflicts = merge.merge_inner(self.branch, other_tree,
2287
 
                                             base_tree, this_tree=self,
2288
 
                                             change_reporter=change_reporter)
2289
 
            if nb_conflicts:
2290
 
                self.add_parent_tree((old_tip, other_tree))
2291
 
                trace.note('Rerun update after fixing the conflicts.')
2292
 
                return nb_conflicts
2293
 
 
2294
 
        if last_rev != _mod_revision.ensure_null(revision):
2295
 
            # the working tree is up to date with the branch
2296
 
            # we can merge the specified revision from master
2297
 
            to_tree = self.branch.repository.revision_tree(revision)
2298
 
            to_root_id = to_tree.get_root_id()
2299
 
 
 
2175
        if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
 
2176
            # merge tree state up to new branch tip.
2300
2177
            basis = self.basis_tree()
2301
2178
            basis.lock_read()
2302
2179
            try:
2303
 
                if (basis.inventory.root is None
2304
 
                    or basis.inventory.root.file_id != to_root_id):
2305
 
                    self.set_root_id(to_root_id)
 
2180
                to_tree = self.branch.basis_tree()
 
2181
                if basis.inventory.root is None:
 
2182
                    self.set_root_id(to_tree.get_root_id())
2306
2183
                    self.flush()
 
2184
                result += merge.merge_inner(
 
2185
                                      self.branch,
 
2186
                                      to_tree,
 
2187
                                      basis,
 
2188
                                      this_tree=self,
 
2189
                                      change_reporter=change_reporter)
2307
2190
            finally:
2308
2191
                basis.unlock()
2309
 
 
2310
 
            # determine the branch point
2311
 
            graph = self.branch.repository.get_graph()
2312
 
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2313
 
                                                last_rev)
2314
 
            base_tree = self.branch.repository.revision_tree(base_rev_id)
2315
 
 
2316
 
            nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2317
 
                                             this_tree=self,
2318
 
                                             change_reporter=change_reporter)
2319
 
            self.set_last_revision(revision)
2320
2192
            # TODO - dedup parents list with things merged by pull ?
2321
2193
            # reuse the tree we've updated to to set the basis:
2322
 
            parent_trees = [(revision, to_tree)]
 
2194
            parent_trees = [(self.branch.last_revision(), to_tree)]
2323
2195
            merges = self.get_parent_ids()[1:]
2324
2196
            # Ideally we ask the tree for the trees here, that way the working
2325
 
            # tree can decide whether to give us the entire tree or give us a
 
2197
            # tree can decide whether to give us teh entire tree or give us a
2326
2198
            # lazy initialised tree. dirstate for instance will have the trees
2327
2199
            # in ram already, whereas a last-revision + basis-inventory tree
2328
2200
            # will not, but also does not need them when setting parents.
2329
2201
            for parent in merges:
2330
2202
                parent_trees.append(
2331
2203
                    (parent, self.branch.repository.revision_tree(parent)))
2332
 
            if not _mod_revision.is_null(old_tip):
 
2204
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2333
2205
                parent_trees.append(
2334
2206
                    (old_tip, self.branch.repository.revision_tree(old_tip)))
2335
2207
            self.set_parent_trees(parent_trees)
2336
2208
            last_rev = parent_trees[0][0]
2337
 
        return nb_conflicts
 
2209
        else:
 
2210
            # the working tree had the same last-revision as the master
 
2211
            # branch did. We may still have pivot local work from the local
 
2212
            # branch into old_tip:
 
2213
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
 
2214
                self.add_parent_tree_id(old_tip)
 
2215
        if (old_tip is not None and not _mod_revision.is_null(old_tip)
 
2216
            and old_tip != last_rev):
 
2217
            # our last revision was not the prior branch last revision
 
2218
            # and we have converted that last revision to a pending merge.
 
2219
            # base is somewhere between the branch tip now
 
2220
            # and the now pending merge
 
2221
 
 
2222
            # Since we just modified the working tree and inventory, flush out
 
2223
            # the current state, before we modify it again.
 
2224
            # TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
 
2225
            #       requires it only because TreeTransform directly munges the
 
2226
            #       inventory and calls tree._write_inventory(). Ultimately we
 
2227
            #       should be able to remove this extra flush.
 
2228
            self.flush()
 
2229
            graph = self.branch.repository.get_graph()
 
2230
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
 
2231
                                                old_tip)
 
2232
            base_tree = self.branch.repository.revision_tree(base_rev_id)
 
2233
            other_tree = self.branch.repository.revision_tree(old_tip)
 
2234
            result += merge.merge_inner(
 
2235
                                  self.branch,
 
2236
                                  other_tree,
 
2237
                                  base_tree,
 
2238
                                  this_tree=self,
 
2239
                                  change_reporter=change_reporter)
 
2240
        return result
2338
2241
 
2339
2242
    def _write_hashcache_if_dirty(self):
2340
2243
        """Write out the hashcache if it is dirty."""
2440
2343
                    bzrdir_loc = bisect_left(cur_disk_dir_content,
2441
2344
                        ('.bzr', '.bzr'))
2442
2345
                    if (bzrdir_loc < len(cur_disk_dir_content)
2443
 
                        and self.bzrdir.is_control_filename(
2444
 
                            cur_disk_dir_content[bzrdir_loc][0])):
 
2346
                        and cur_disk_dir_content[bzrdir_loc][0] == '.bzr'):
2445
2347
                        # we dont yield the contents of, or, .bzr itself.
2446
2348
                        del cur_disk_dir_content[bzrdir_loc]
2447
2349
            if inv_finished:
2581
2483
        return un_resolved, resolved
2582
2484
 
2583
2485
    @needs_read_lock
2584
 
    def _check(self, references):
2585
 
        """Check the tree for consistency.
2586
 
 
2587
 
        :param references: A dict with keys matching the items returned by
2588
 
            self._get_check_refs(), and values from looking those keys up in
2589
 
            the repository.
2590
 
        """
 
2486
    def _check(self):
2591
2487
        tree_basis = self.basis_tree()
2592
2488
        tree_basis.lock_read()
2593
2489
        try:
2594
 
            repo_basis = references[('trees', self.last_revision())]
 
2490
            repo_basis = self.branch.repository.revision_tree(
 
2491
                self.last_revision())
2595
2492
            if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2596
2493
                raise errors.BzrCheckError(
2597
2494
                    "Mismatched basis inventory content.")
2610
2507
        """
2611
2508
        return
2612
2509
 
 
2510
    @needs_read_lock
2613
2511
    def _get_rules_searcher(self, default_searcher):
2614
2512
        """See Tree._get_rules_searcher."""
2615
2513
        if self._rules_searcher is None:
2626
2524
class WorkingTree2(WorkingTree):
2627
2525
    """This is the Format 2 working tree.
2628
2526
 
2629
 
    This was the first weave based working tree.
 
2527
    This was the first weave based working tree. 
2630
2528
     - uses os locks for locking.
2631
2529
     - uses the branch last-revision.
2632
2530
    """
2642
2540
        if self._inventory is None:
2643
2541
            self.read_working_inventory()
2644
2542
 
2645
 
    def _get_check_refs(self):
2646
 
        """Return the references needed to perform a check of this tree."""
2647
 
        return [('trees', self.last_revision())]
2648
 
 
2649
2543
    def lock_tree_write(self):
2650
2544
        """See WorkingTree.lock_tree_write().
2651
2545
 
2652
2546
        In Format2 WorkingTrees we have a single lock for the branch and tree
2653
2547
        so lock_tree_write() degrades to lock_write().
2654
 
 
2655
 
        :return: An object with an unlock method which will release the lock
2656
 
            obtained.
2657
2548
        """
2658
2549
        self.branch.lock_write()
2659
2550
        try:
2660
 
            self._control_files.lock_write()
2661
 
            return self
 
2551
            return self._control_files.lock_write()
2662
2552
        except:
2663
2553
            self.branch.unlock()
2664
2554
            raise
2673
2563
            if self._inventory_is_modified:
2674
2564
                self.flush()
2675
2565
            self._write_hashcache_if_dirty()
2676
 
 
 
2566
                    
2677
2567
        # reverse order of locking.
2678
2568
        try:
2679
2569
            return self._control_files.unlock()
2701
2591
 
2702
2592
    def _change_last_revision(self, revision_id):
2703
2593
        """See WorkingTree._change_last_revision."""
2704
 
        if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
 
2594
        if revision_id is None or revision_id == NULL_REVISION:
2705
2595
            try:
2706
2596
                self._transport.delete('last-revision')
2707
2597
            except errors.NoSuchFile:
2709
2599
            return False
2710
2600
        else:
2711
2601
            self._transport.put_bytes('last-revision', revision_id,
2712
 
                mode=self.bzrdir._get_file_mode())
 
2602
                mode=self._control_files._file_mode)
2713
2603
            return True
2714
2604
 
2715
 
    def _get_check_refs(self):
2716
 
        """Return the references needed to perform a check of this tree."""
2717
 
        return [('trees', self.last_revision())]
2718
 
 
2719
2605
    @needs_tree_write_lock
2720
2606
    def set_conflicts(self, conflicts):
2721
 
        self._put_rio('conflicts', conflicts.to_stanzas(),
 
2607
        self._put_rio('conflicts', conflicts.to_stanzas(), 
2722
2608
                      CONFLICT_HEADER_1)
2723
2609
 
2724
2610
    @needs_tree_write_lock
2773
2659
     * a format string,
2774
2660
     * an open routine.
2775
2661
 
2776
 
    Formats are placed in an dict by their format string for reference
 
2662
    Formats are placed in an dict by their format string for reference 
2777
2663
    during workingtree opening. Its not required that these be instances, they
2778
 
    can be classes themselves with class methods - it simply depends on
 
2664
    can be classes themselves with class methods - it simply depends on 
2779
2665
    whether state is needed for a given format or not.
2780
2666
 
2781
2667
    Once a format is deprecated, just deprecate the initialize and open
2782
 
    methods on the format class. Do not deprecate the object, as the
 
2668
    methods on the format class. Do not deprecate the object, as the 
2783
2669
    object will be created every time regardless.
2784
2670
    """
2785
2671
 
2798
2684
        """Return the format for the working tree object in a_bzrdir."""
2799
2685
        try:
2800
2686
            transport = a_bzrdir.get_workingtree_transport(None)
2801
 
            format_string = transport.get_bytes("format")
 
2687
            format_string = transport.get("format").read()
2802
2688
            return klass._formats[format_string]
2803
2689
        except errors.NoSuchFile:
2804
2690
            raise errors.NoWorkingTree(base=transport.base)
2829
2715
        """Is this format supported?
2830
2716
 
2831
2717
        Supported formats can be initialized and opened.
2832
 
        Unsupported formats may not support initialization or committing or
 
2718
        Unsupported formats may not support initialization or committing or 
2833
2719
        some other features depending on the reason for not being supported.
2834
2720
        """
2835
2721
        return True
2856
2742
 
2857
2743
 
2858
2744
class WorkingTreeFormat2(WorkingTreeFormat):
2859
 
    """The second working tree format.
 
2745
    """The second working tree format. 
2860
2746
 
2861
2747
    This format modified the hash cache from the format 1 hash cache.
2862
2748
    """
2875
2761
        no working tree.  (See bug #43064).
2876
2762
        """
2877
2763
        sio = StringIO()
2878
 
        inv = inventory.Inventory()
 
2764
        inv = Inventory()
2879
2765
        xml5.serializer_v5.write_inventory(inv, sio, working=True)
2880
2766
        sio.seek(0)
2881
2767
        transport.put_file('inventory', sio, file_mode)
2897
2783
            branch.generate_revision_history(revision_id)
2898
2784
        finally:
2899
2785
            branch.unlock()
2900
 
        inv = inventory.Inventory()
 
2786
        inv = Inventory()
2901
2787
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2902
2788
                         branch,
2903
2789
                         inv,
2948
2834
        - is new in bzr 0.8
2949
2835
        - uses a LockDir to guard access for writes.
2950
2836
    """
2951
 
 
 
2837
    
2952
2838
    upgrade_recommended = True
2953
2839
 
2954
2840
    def get_format_string(self):
2971
2857
 
2972
2858
    def _open_control_files(self, a_bzrdir):
2973
2859
        transport = a_bzrdir.get_workingtree_transport(None)
2974
 
        return LockableFiles(transport, self._lock_file_name,
 
2860
        return LockableFiles(transport, self._lock_file_name, 
2975
2861
                             self._lock_class)
2976
2862
 
2977
2863
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2978
2864
                   accelerator_tree=None, hardlink=False):
2979
2865
        """See WorkingTreeFormat.initialize().
2980
 
 
 
2866
        
2981
2867
        :param revision_id: if supplied, create a working tree at a different
2982
2868
            revision than the branch is at.
2983
2869
        :param accelerator_tree: A tree which can be used for retrieving file
2994
2880
        control_files.create_lock()
2995
2881
        control_files.lock_write()
2996
2882
        transport.put_bytes('format', self.get_format_string(),
2997
 
            mode=a_bzrdir._get_file_mode())
 
2883
            mode=control_files._file_mode)
2998
2884
        if from_branch is not None:
2999
2885
            branch = from_branch
3000
2886
        else:
3020
2906
            # only set an explicit root id if there is one to set.
3021
2907
            if basis_tree.inventory.root is not None:
3022
2908
                wt.set_root_id(basis_tree.get_root_id())
3023
 
            if revision_id == _mod_revision.NULL_REVISION:
 
2909
            if revision_id == NULL_REVISION:
3024
2910
                wt.set_parent_trees([])
3025
2911
            else:
3026
2912
                wt.set_parent_trees([(revision_id, basis_tree)])
3033
2919
        return wt
3034
2920
 
3035
2921
    def _initial_inventory(self):
3036
 
        return inventory.Inventory()
 
2922
        return Inventory()
3037
2923
 
3038
2924
    def __init__(self):
3039
2925
        super(WorkingTreeFormat3, self).__init__()
3054
2940
 
3055
2941
    def _open(self, a_bzrdir, control_files):
3056
2942
        """Open the tree itself.
3057
 
 
 
2943
        
3058
2944
        :param a_bzrdir: the dir for the tree.
3059
2945
        :param control_files: the control files for the tree.
3060
2946
        """
3068
2954
        return self.get_format_string()
3069
2955
 
3070
2956
 
3071
 
__default_format = WorkingTreeFormat6()
 
2957
__default_format = WorkingTreeFormat4()
3072
2958
WorkingTreeFormat.register_format(__default_format)
3073
2959
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3074
 
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3075
2960
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3076
2961
WorkingTreeFormat.set_default_format(__default_format)
3077
2962
# formats which have no format string are not discoverable