/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

1st cut merge of bzr.dev r3907

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
76
83
""")
77
84
 
78
85
from bzrlib import symbol_versioning
79
86
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
87
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
80
88
from bzrlib.lockable_files import LockableFiles
81
89
from bzrlib.lockdir import LockDir
82
90
import bzrlib.mutabletree
83
91
from bzrlib.mutabletree import needs_tree_write_lock
84
92
from bzrlib import osutils
85
93
from bzrlib.osutils import (
 
94
    compact_date,
86
95
    file_kind,
87
96
    isdir,
88
97
    normpath,
89
98
    pathjoin,
 
99
    rand_chars,
90
100
    realpath,
91
101
    safe_unicode,
92
102
    splitpath,
95
105
from bzrlib.filters import filtered_input_file
96
106
from bzrlib.trace import mutter, note
97
107
from bzrlib.transport.local import LocalTransport
98
 
from bzrlib.revision import CURRENT_REVISION
 
108
from bzrlib.progress import DummyProgress, ProgressPhase
 
109
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
99
110
from bzrlib.rio import RioReader, rio_file, Stanza
100
 
from bzrlib.symbol_versioning import (
101
 
    deprecated_passed,
102
 
    DEPRECATED_PARAMETER,
103
 
    )
 
111
from bzrlib.symbol_versioning import (deprecated_passed,
 
112
        deprecated_method,
 
113
        deprecated_function,
 
114
        DEPRECATED_PARAMETER,
 
115
        )
104
116
 
105
117
 
106
118
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
107
 
# TODO: Modifying the conflict objects or their type is currently nearly
108
 
# impossible as there is no clear relationship between the working tree format
109
 
# and the conflict list file format.
110
119
CONFLICT_HEADER_1 = "BZR conflict list format 1"
111
120
 
112
121
ERROR_PATH_NOT_FOUND = 3    # WindowsError errno code, equivalent to ENOENT
115
124
class TreeEntry(object):
116
125
    """An entry that implements the minimum interface used by commands.
117
126
 
118
 
    This needs further inspection, it may be better to have
 
127
    This needs further inspection, it may be better to have 
119
128
    InventoryEntries without ids - though that seems wrong. For now,
120
129
    this is a parallel hierarchy to InventoryEntry, and needs to become
121
130
    one of several things: decorates to that hierarchy, children of, or
124
133
    no InventoryEntry available - i.e. for unversioned objects.
125
134
    Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
126
135
    """
127
 
 
 
136
 
128
137
    def __eq__(self, other):
129
138
        # yes, this us ugly, TODO: best practice __eq__ style.
130
139
        return (isinstance(other, TreeEntry)
131
140
                and other.__class__ == self.__class__)
132
 
 
 
141
 
133
142
    def kind_character(self):
134
143
        return "???"
135
144
 
167
176
        return ''
168
177
 
169
178
 
170
 
class WorkingTree(bzrlib.mutabletree.MutableTree,
171
 
    bzrdir.ControlComponent):
 
179
class WorkingTree(bzrlib.mutabletree.MutableTree):
172
180
    """Working copy tree.
173
181
 
174
182
    The inventory is held in the `Branch` working-inventory, and the
178
186
    not listed in the Inventory and vice versa.
179
187
    """
180
188
 
181
 
    # override this to set the strategy for storing views
182
 
    def _make_views(self):
183
 
        return views.DisabledViews(self)
184
 
 
185
189
    def __init__(self, basedir='.',
186
190
                 branch=DEPRECATED_PARAMETER,
187
191
                 _inventory=None,
223
227
        cache_filename = wt_trans.local_abspath('stat-cache')
224
228
        self._hashcache = hashcache.HashCache(basedir, cache_filename,
225
229
            self.bzrdir._get_file_mode(),
226
 
            self._content_filter_stack_provider())
 
230
            lambda path, file_id: self._content_filter_stack(path, file_id))
227
231
        hc = self._hashcache
228
232
        hc.read()
229
233
        # is this scan needed ? it makes things kinda slow.
245
249
            self._set_inventory(_inventory, dirty=False)
246
250
        self._detect_case_handling()
247
251
        self._rules_searcher = None
248
 
        self.views = self._make_views()
249
 
 
250
 
    @property
251
 
    def user_transport(self):
252
 
        return self.bzrdir.user_transport
253
 
 
254
 
    @property
255
 
    def control_transport(self):
256
 
        return self._transport
257
252
 
258
253
    def _detect_case_handling(self):
259
254
        wt_trans = self.bzrdir.get_workingtree_transport(None)
285
280
        self._control_files.break_lock()
286
281
        self.branch.break_lock()
287
282
 
288
 
    def _get_check_refs(self):
289
 
        """Return the references needed to perform a check of this tree.
290
 
        
291
 
        The default implementation returns no refs, and is only suitable for
292
 
        trees that have no local caching and can commit on ghosts at any time.
293
 
 
294
 
        :seealso: bzrlib.check for details about check_refs.
295
 
        """
296
 
        return []
297
 
 
298
283
    def requires_rich_root(self):
299
284
        return self._format.requires_rich_root
300
285
 
301
286
    def supports_tree_reference(self):
302
287
        return False
303
288
 
304
 
    def supports_content_filtering(self):
305
 
        return self._format.supports_content_filtering()
306
 
 
307
 
    def supports_views(self):
308
 
        return self.views.supports_views()
309
 
 
310
289
    def _set_inventory(self, inv, dirty):
311
290
        """Set the internal cached inventory.
312
291
 
400
379
 
401
380
    def basis_tree(self):
402
381
        """Return RevisionTree for the current last revision.
403
 
 
 
382
        
404
383
        If the left most parent is a ghost then the returned tree will be an
405
 
        empty tree - one obtained by calling
 
384
        empty tree - one obtained by calling 
406
385
        repository.revision_tree(NULL_REVISION).
407
386
        """
408
387
        try:
424
403
            return self.branch.repository.revision_tree(revision_id)
425
404
        except (errors.RevisionNotPresent, errors.NoSuchRevision):
426
405
            # the basis tree *may* be a ghost or a low level error may have
427
 
            # occurred. If the revision is present, its a problem, if its not
 
406
            # occured. If the revision is present, its a problem, if its not
428
407
            # its a ghost.
429
408
            if self.branch.repository.has_revision(revision_id):
430
409
                raise
437
416
 
438
417
    def relpath(self, path):
439
418
        """Return the local path portion from a given path.
440
 
 
441
 
        The path may be absolute or relative. If its a relative path it is
 
419
        
 
420
        The path may be absolute or relative. If its a relative path it is 
442
421
        interpreted relative to the python current working directory.
443
422
        """
444
423
        return osutils.relpath(self.basedir, path)
447
426
        return osutils.lexists(self.abspath(filename))
448
427
 
449
428
    def get_file(self, file_id, path=None, filtered=True):
450
 
        return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
 
429
        if path is None:
 
430
            path = self.id2path(file_id)
 
431
        return self.get_file_byname(path, filtered=filtered)
451
432
 
452
 
    def get_file_with_stat(self, file_id, path=None, filtered=True,
453
 
        _fstat=os.fstat):
454
 
        """See Tree.get_file_with_stat."""
 
433
    def get_file_with_stat(self, file_id, path=None, _fstat=os.fstat):
 
434
        """See MutableTree.get_file_with_stat."""
455
435
        if path is None:
456
436
            path = self.id2path(file_id)
457
437
        file_obj = self.get_file_byname(path, filtered=False)
458
 
        stat_value = _fstat(file_obj.fileno())
459
 
        if filtered and self.supports_content_filtering():
460
 
            filters = self._content_filter_stack(path)
461
 
            file_obj = filtered_input_file(file_obj, filters)
462
 
        return (file_obj, stat_value)
 
438
        return (file_obj, _fstat(file_obj.fileno()))
463
439
 
464
440
    def get_file_text(self, file_id, path=None, filtered=True):
465
441
        return self.get_file(file_id, path=path, filtered=filtered).read()
467
443
    def get_file_byname(self, filename, filtered=True):
468
444
        path = self.abspath(filename)
469
445
        f = file(path, 'rb')
470
 
        if filtered and self.supports_content_filtering():
 
446
        if filtered:
471
447
            filters = self._content_filter_stack(filename)
472
448
            return filtered_input_file(f, filters)
473
449
        else:
474
450
            return f
475
451
 
476
 
    def get_file_lines(self, file_id, path=None, filtered=True):
 
452
    def get_special_file(self, type):
 
453
        """Get a file special to Bazaar.
 
454
 
 
455
        :type: a type of XXX maps to a file path .bzrXXX
 
456
        :return: a file-like object or None if the file does not exist
 
457
        """
 
458
        path = self.abspath(".bzr" + type)
 
459
        try:
 
460
            return open(path, 'rb')
 
461
        except IOError:
 
462
            return None
 
463
 
 
464
    def get_file_lines(self, file_id, path=None):
477
465
        """See Tree.get_file_lines()"""
478
 
        file = self.get_file(file_id, path, filtered=filtered)
 
466
        file = self.get_file(file_id, path)
479
467
        try:
480
468
            return file.readlines()
481
469
        finally:
492
480
        incorrectly attributed to CURRENT_REVISION (but after committing, the
493
481
        attribution will be correct).
494
482
        """
495
 
        maybe_file_parent_keys = []
496
 
        for parent_id in self.get_parent_ids():
497
 
            try:
498
 
                parent_tree = self.revision_tree(parent_id)
499
 
            except errors.NoSuchRevisionInTree:
500
 
                parent_tree = self.branch.repository.revision_tree(parent_id)
501
 
            parent_tree.lock_read()
502
 
            try:
503
 
                if file_id not in parent_tree:
504
 
                    continue
505
 
                ie = parent_tree.inventory[file_id]
506
 
                if ie.kind != 'file':
507
 
                    # Note: this is slightly unnecessary, because symlinks and
508
 
                    # directories have a "text" which is the empty text, and we
509
 
                    # know that won't mess up annotations. But it seems cleaner
510
 
                    continue
511
 
                parent_text_key = (file_id, ie.revision)
512
 
                if parent_text_key not in maybe_file_parent_keys:
513
 
                    maybe_file_parent_keys.append(parent_text_key)
514
 
            finally:
515
 
                parent_tree.unlock()
516
 
        graph = _mod_graph.Graph(self.branch.repository.texts)
517
 
        heads = graph.heads(maybe_file_parent_keys)
518
 
        file_parent_keys = []
519
 
        for key in maybe_file_parent_keys:
520
 
            if key in heads:
521
 
                file_parent_keys.append(key)
522
 
 
523
 
        # Now we have the parents of this content
524
 
        annotator = self.branch.repository.texts.get_annotator()
525
 
        text = self.get_file(file_id).read()
526
 
        this_key =(file_id, default_revision)
527
 
        annotator.add_special_text(this_key, file_parent_keys, text)
528
 
        annotations = [(key[-1], line)
529
 
                       for key, line in annotator.annotate_flat(this_key)]
530
 
        return annotations
 
483
        basis = self.basis_tree()
 
484
        basis.lock_read()
 
485
        try:
 
486
            changes = self.iter_changes(basis, True, [self.id2path(file_id)],
 
487
                require_versioned=True).next()
 
488
            changed_content, kind = changes[2], changes[6]
 
489
            if not changed_content:
 
490
                return basis.annotate_iter(file_id)
 
491
            if kind[1] is None:
 
492
                return None
 
493
            import annotate
 
494
            if kind[0] != 'file':
 
495
                old_lines = []
 
496
            else:
 
497
                old_lines = list(basis.annotate_iter(file_id))
 
498
            old = [old_lines]
 
499
            for tree in self.branch.repository.revision_trees(
 
500
                self.get_parent_ids()[1:]):
 
501
                if file_id not in tree:
 
502
                    continue
 
503
                old.append(list(tree.annotate_iter(file_id)))
 
504
            return annotate.reannotate(old, self.get_file(file_id).readlines(),
 
505
                                       default_revision)
 
506
        finally:
 
507
            basis.unlock()
531
508
 
532
509
    def _get_ancestors(self, default_revision):
533
510
        ancestors = set([default_revision])
538
515
 
539
516
    def get_parent_ids(self):
540
517
        """See Tree.get_parent_ids.
541
 
 
 
518
        
542
519
        This implementation reads the pending merges list and last_revision
543
520
        value and uses that to decide what the parents list should be.
544
521
        """
548
525
        else:
549
526
            parents = [last_rev]
550
527
        try:
551
 
            merges_bytes = self._transport.get_bytes('pending-merges')
 
528
            merges_file = self._transport.get('pending-merges')
552
529
        except errors.NoSuchFile:
553
530
            pass
554
531
        else:
555
 
            for l in osutils.split_lines(merges_bytes):
 
532
            for l in merges_file.readlines():
556
533
                revision_id = l.rstrip('\n')
557
534
                parents.append(revision_id)
558
535
        return parents
561
538
    def get_root_id(self):
562
539
        """Return the id of this trees root"""
563
540
        return self._inventory.root.file_id
564
 
 
 
541
        
565
542
    def _get_store_filename(self, file_id):
566
543
        ## XXX: badly named; this is not in the store at all
567
544
        return self.abspath(self.id2path(file_id))
569
546
    @needs_read_lock
570
547
    def clone(self, to_bzrdir, revision_id=None):
571
548
        """Duplicate this working tree into to_bzr, including all state.
572
 
 
 
549
        
573
550
        Specifically modified files are kept as modified, but
574
551
        ignored and unknown files are discarded.
575
552
 
576
553
        If you want to make a new line of development, see bzrdir.sprout()
577
554
 
578
555
        revision
579
 
            If not None, the cloned tree will have its last revision set to
580
 
            revision, and difference between the source trees last revision
 
556
            If not None, the cloned tree will have its last revision set to 
 
557
            revision, and and difference between the source trees last revision
581
558
            and this one merged in.
582
559
        """
583
560
        # assumes the target bzr dir format is compatible.
617
594
 
618
595
    def get_file_size(self, file_id):
619
596
        """See Tree.get_file_size"""
620
 
        # XXX: this returns the on-disk size; it should probably return the
621
 
        # canonical size
622
597
        try:
623
598
            return os.path.getsize(self.id2abspath(file_id))
624
599
        except OSError, e:
640
615
 
641
616
    def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
642
617
        file_id = self.path2id(path)
643
 
        if file_id is None:
644
 
            # For unversioned files on win32, we just assume they are not
645
 
            # executable
646
 
            return False
647
618
        return self._inventory[file_id].executable
648
619
 
649
620
    def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
671
642
        """See MutableTree._add."""
672
643
        # TODO: Re-adding a file that is removed in the working copy
673
644
        # should probably put it back with the previous ID.
674
 
        # the read and write working inventory should not occur in this
 
645
        # the read and write working inventory should not occur in this 
675
646
        # function - they should be part of lock_write and unlock.
676
647
        inv = self.inventory
677
648
        for f, file_id, kind in zip(files, ids, kinds):
759
730
            raise
760
731
        kind = _mapper(stat_result.st_mode)
761
732
        if kind == 'file':
762
 
            return self._file_content_summary(path, stat_result)
 
733
            size = stat_result.st_size
 
734
            # try for a stat cache lookup
 
735
            executable = self._is_executable_from_path_and_stat(path, stat_result)
 
736
            return (kind, size, executable, self._sha_from_stat(
 
737
                path, stat_result))
763
738
        elif kind == 'directory':
764
739
            # perhaps it looks like a plain directory, but it's really a
765
740
            # reference.
767
742
                kind = 'tree-reference'
768
743
            return kind, None, None, None
769
744
        elif kind == 'symlink':
770
 
            target = osutils.readlink(abspath)
771
 
            return ('symlink', None, None, target)
 
745
            return ('symlink', None, None, os.readlink(abspath))
772
746
        else:
773
747
            return (kind, None, None, None)
774
748
 
775
 
    def _file_content_summary(self, path, stat_result):
776
 
        size = stat_result.st_size
777
 
        executable = self._is_executable_from_path_and_stat(path, stat_result)
778
 
        # try for a stat cache lookup
779
 
        return ('file', size, executable, self._sha_from_stat(
780
 
            path, stat_result))
781
 
 
782
749
    def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
783
750
        """Common ghost checking functionality from set_parent_*.
784
751
 
794
761
    def _set_merges_from_parent_ids(self, parent_ids):
795
762
        merges = parent_ids[1:]
796
763
        self._transport.put_bytes('pending-merges', '\n'.join(merges),
797
 
            mode=self.bzrdir._get_file_mode())
 
764
            mode=self._control_files._file_mode)
798
765
 
799
766
    def _filter_parent_ids_by_ancestry(self, revision_ids):
800
767
        """Check that all merged revisions are proper 'heads'.
801
768
 
802
769
        This will always return the first revision_id, and any merged revisions
803
 
        which are
 
770
        which are 
804
771
        """
805
772
        if len(revision_ids) == 0:
806
773
            return revision_ids
818
785
    @needs_tree_write_lock
819
786
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
820
787
        """Set the parent ids to revision_ids.
821
 
 
 
788
        
822
789
        See also set_parent_trees. This api will try to retrieve the tree data
823
790
        for each element of revision_ids from the trees repository. If you have
824
791
        tree data already available, it is more efficient to use
900
867
        self._must_be_locked()
901
868
        my_file = rio_file(stanzas, header)
902
869
        self._transport.put_file(filename, my_file,
903
 
            mode=self.bzrdir._get_file_mode())
 
870
            mode=self._control_files._file_mode)
904
871
 
905
872
    @needs_write_lock # because merge pulls data into the branch.
906
873
    def merge_from_branch(self, branch, to_revision=None, from_revision=None,
907
 
                          merge_type=None, force=False):
 
874
        merge_type=None):
908
875
        """Merge from a branch into this working tree.
909
876
 
910
877
        :param branch: The branch to merge from.
914
881
            branch.last_revision().
915
882
        """
916
883
        from bzrlib.merge import Merger, Merge3Merger
917
 
        merger = Merger(self.branch, this_tree=self)
918
 
        # check that there are no local alterations
919
 
        if not force and self.has_changes():
920
 
            raise errors.UncommittedChanges(self)
921
 
        if to_revision is None:
922
 
            to_revision = _mod_revision.ensure_null(branch.last_revision())
923
 
        merger.other_rev_id = to_revision
924
 
        if _mod_revision.is_null(merger.other_rev_id):
925
 
            raise errors.NoCommits(branch)
926
 
        self.branch.fetch(branch, last_revision=merger.other_rev_id)
927
 
        merger.other_basis = merger.other_rev_id
928
 
        merger.other_tree = self.branch.repository.revision_tree(
929
 
            merger.other_rev_id)
930
 
        merger.other_branch = branch
931
 
        if from_revision is None:
932
 
            merger.find_base()
933
 
        else:
934
 
            merger.set_base_revision(from_revision, branch)
935
 
        if merger.base_rev_id == merger.other_rev_id:
936
 
            raise errors.PointlessMerge
937
 
        merger.backup_files = False
938
 
        if merge_type is None:
939
 
            merger.merge_type = Merge3Merger
940
 
        else:
941
 
            merger.merge_type = merge_type
942
 
        merger.set_interesting_files(None)
943
 
        merger.show_base = False
944
 
        merger.reprocess = False
945
 
        conflicts = merger.do_merge()
946
 
        merger.set_pending()
 
884
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
885
        try:
 
886
            merger = Merger(self.branch, this_tree=self, pb=pb)
 
887
            merger.pp = ProgressPhase("Merge phase", 5, pb)
 
888
            merger.pp.next_phase()
 
889
            # check that there are no
 
890
            # local alterations
 
891
            merger.check_basis(check_clean=True, require_commits=False)
 
892
            if to_revision is None:
 
893
                to_revision = _mod_revision.ensure_null(branch.last_revision())
 
894
            merger.other_rev_id = to_revision
 
895
            if _mod_revision.is_null(merger.other_rev_id):
 
896
                raise errors.NoCommits(branch)
 
897
            self.branch.fetch(branch, last_revision=merger.other_rev_id)
 
898
            merger.other_basis = merger.other_rev_id
 
899
            merger.other_tree = self.branch.repository.revision_tree(
 
900
                merger.other_rev_id)
 
901
            merger.other_branch = branch
 
902
            merger.pp.next_phase()
 
903
            if from_revision is None:
 
904
                merger.find_base()
 
905
            else:
 
906
                merger.set_base_revision(from_revision, branch)
 
907
            if merger.base_rev_id == merger.other_rev_id:
 
908
                raise errors.PointlessMerge
 
909
            merger.backup_files = False
 
910
            if merge_type is None:
 
911
                merger.merge_type = Merge3Merger
 
912
            else:
 
913
                merger.merge_type = merge_type
 
914
            merger.set_interesting_files(None)
 
915
            merger.show_base = False
 
916
            merger.reprocess = False
 
917
            conflicts = merger.do_merge()
 
918
            merger.set_pending()
 
919
        finally:
 
920
            pb.finished()
947
921
        return conflicts
948
922
 
949
923
    @needs_read_lock
950
924
    def merge_modified(self):
951
925
        """Return a dictionary of files modified by a merge.
952
926
 
953
 
        The list is initialized by WorkingTree.set_merge_modified, which is
 
927
        The list is initialized by WorkingTree.set_merge_modified, which is 
954
928
        typically called after we make some automatic updates to the tree
955
929
        because of a merge.
956
930
 
990
964
        return file_id
991
965
 
992
966
    def get_symlink_target(self, file_id):
993
 
        abspath = self.id2abspath(file_id)
994
 
        target = osutils.readlink(abspath)
995
 
        return target
 
967
        return os.readlink(self.id2abspath(file_id))
996
968
 
997
969
    @needs_write_lock
998
970
    def subsume(self, other_tree):
1048
1020
        return False
1049
1021
 
1050
1022
    def _directory_may_be_tree_reference(self, relpath):
1051
 
        # as a special case, if a directory contains control files then
 
1023
        # as a special case, if a directory contains control files then 
1052
1024
        # it's a tree reference, except that the root of the tree is not
1053
1025
        return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1054
1026
        # TODO: We could ask all the control formats whether they
1065
1037
    @needs_tree_write_lock
1066
1038
    def extract(self, file_id, format=None):
1067
1039
        """Extract a subtree from this tree.
1068
 
 
 
1040
        
1069
1041
        A new branch will be created, relative to the path for this tree.
1070
1042
        """
1071
1043
        self.flush()
1076
1048
                transport = transport.clone(name)
1077
1049
                transport.ensure_base()
1078
1050
            return transport
1079
 
 
 
1051
            
1080
1052
        sub_path = self.id2path(file_id)
1081
1053
        branch_transport = mkdirs(sub_path)
1082
1054
        if format is None:
1096
1068
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
1097
1069
        if tree_transport.base != branch_transport.base:
1098
1070
            tree_bzrdir = format.initialize_on_transport(tree_transport)
1099
 
            branch.BranchReferenceFormat().initialize(tree_bzrdir,
1100
 
                target_branch=new_branch)
 
1071
            branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1101
1072
        else:
1102
1073
            tree_bzrdir = branch_bzrdir
1103
 
        wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
 
1074
        wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1104
1075
        wt.set_parent_ids(self.get_parent_ids())
1105
1076
        my_inv = self.inventory
1106
 
        child_inv = inventory.Inventory(root_id=None)
 
1077
        child_inv = Inventory(root_id=None)
1107
1078
        new_root = my_inv[file_id]
1108
1079
        my_inv.remove_recursive_id(file_id)
1109
1080
        new_root.parent_id = None
1128
1099
        self._serialize(self._inventory, sio)
1129
1100
        sio.seek(0)
1130
1101
        self._transport.put_file('inventory', sio,
1131
 
            mode=self.bzrdir._get_file_mode())
 
1102
            mode=self._control_files._file_mode)
1132
1103
        self._inventory_is_modified = False
1133
1104
 
1134
1105
    def _kind(self, relpath):
1135
1106
        return osutils.file_kind(self.abspath(relpath))
1136
1107
 
1137
 
    def list_files(self, include_root=False, from_dir=None, recursive=True):
1138
 
        """List all files as (path, class, kind, id, entry).
 
1108
    def list_files(self, include_root=False):
 
1109
        """Recursively list all files as (path, class, kind, id, entry).
1139
1110
 
1140
1111
        Lists, but does not descend into unversioned directories.
 
1112
 
1141
1113
        This does not include files that have been deleted in this
1142
 
        tree. Skips the control directory.
 
1114
        tree.
1143
1115
 
1144
 
        :param include_root: if True, return an entry for the root
1145
 
        :param from_dir: start from this directory or None for the root
1146
 
        :param recursive: whether to recurse into subdirectories or not
 
1116
        Skips the control directory.
1147
1117
        """
1148
1118
        # list_files is an iterator, so @needs_read_lock doesn't work properly
1149
1119
        # with it. So callers should be careful to always read_lock the tree.
1151
1121
            raise errors.ObjectNotLocked(self)
1152
1122
 
1153
1123
        inv = self.inventory
1154
 
        if from_dir is None and include_root is True:
 
1124
        if include_root is True:
1155
1125
            yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1156
1126
        # Convert these into local objects to save lookup times
1157
1127
        pathjoin = osutils.pathjoin
1164
1134
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1165
1135
 
1166
1136
        # directory file_id, relative path, absolute path, reverse sorted children
1167
 
        if from_dir is not None:
1168
 
            from_dir_id = inv.path2id(from_dir)
1169
 
            if from_dir_id is None:
1170
 
                # Directory not versioned
1171
 
                return
1172
 
            from_dir_abspath = pathjoin(self.basedir, from_dir)
1173
 
        else:
1174
 
            from_dir_id = inv.root.file_id
1175
 
            from_dir_abspath = self.basedir
1176
 
        children = os.listdir(from_dir_abspath)
 
1137
        children = os.listdir(self.basedir)
1177
1138
        children.sort()
1178
 
        # jam 20060527 The kernel sized tree seems equivalent whether we
 
1139
        # jam 20060527 The kernel sized tree seems equivalent whether we 
1179
1140
        # use a deque and popleft to keep them sorted, or if we use a plain
1180
1141
        # list and just reverse() them.
1181
1142
        children = collections.deque(children)
1182
 
        stack = [(from_dir_id, u'', from_dir_abspath, children)]
 
1143
        stack = [(inv.root.file_id, u'', self.basedir, children)]
1183
1144
        while stack:
1184
1145
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1185
1146
 
1201
1162
 
1202
1163
                # absolute path
1203
1164
                fap = from_dir_abspath + '/' + f
1204
 
 
 
1165
                
1205
1166
                f_ie = inv.get_child(from_dir_id, f)
1206
1167
                if f_ie:
1207
1168
                    c = 'V'
1239
1200
                    except KeyError:
1240
1201
                        yield fp[1:], c, fk, None, TreeEntry()
1241
1202
                    continue
1242
 
 
 
1203
                
1243
1204
                if fk != 'directory':
1244
1205
                    continue
1245
1206
 
1246
 
                # But do this child first if recursing down
1247
 
                if recursive:
1248
 
                    new_children = os.listdir(fap)
1249
 
                    new_children.sort()
1250
 
                    new_children = collections.deque(new_children)
1251
 
                    stack.append((f_ie.file_id, fp, fap, new_children))
1252
 
                    # Break out of inner loop,
1253
 
                    # so that we start outer loop with child
1254
 
                    break
 
1207
                # But do this child first
 
1208
                new_children = os.listdir(fap)
 
1209
                new_children.sort()
 
1210
                new_children = collections.deque(new_children)
 
1211
                stack.append((f_ie.file_id, fp, fap, new_children))
 
1212
                # Break out of inner loop,
 
1213
                # so that we start outer loop with child
 
1214
                break
1255
1215
            else:
1256
1216
                # if we finished all children, pop it off the stack
1257
1217
                stack.pop()
1263
1223
        to_dir must exist in the inventory.
1264
1224
 
1265
1225
        If to_dir exists and is a directory, the files are moved into
1266
 
        it, keeping their old names.
 
1226
        it, keeping their old names.  
1267
1227
 
1268
1228
        Note that to_dir is only the last component of the new name;
1269
1229
        this doesn't change the directory.
1435
1395
        inv = self.inventory
1436
1396
        for entry in moved:
1437
1397
            try:
1438
 
                self._move_entry(WorkingTree._RenameEntry(
1439
 
                    entry.to_rel, entry.from_id,
 
1398
                self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1440
1399
                    entry.to_tail, entry.to_parent_id, entry.from_rel,
1441
1400
                    entry.from_tail, entry.from_parent_id,
1442
1401
                    entry.only_change_inv))
1493
1452
        from_tail = splitpath(from_rel)[-1]
1494
1453
        from_id = inv.path2id(from_rel)
1495
1454
        if from_id is None:
1496
 
            # if file is missing in the inventory maybe it's in the basis_tree
1497
 
            basis_tree = self.branch.basis_tree()
1498
 
            from_id = basis_tree.path2id(from_rel)
1499
 
            if from_id is None:
1500
 
                raise errors.BzrRenameFailedError(from_rel,to_rel,
1501
 
                    errors.NotVersionedError(path=str(from_rel)))
1502
 
            # put entry back in the inventory so we can rename it
1503
 
            from_entry = basis_tree.inventory[from_id].copy()
1504
 
            inv.add(from_entry)
1505
 
        else:
1506
 
            from_entry = inv[from_id]
 
1455
            raise errors.BzrRenameFailedError(from_rel,to_rel,
 
1456
                errors.NotVersionedError(path=str(from_rel)))
 
1457
        from_entry = inv[from_id]
1507
1458
        from_parent_id = from_entry.parent_id
1508
1459
        to_dir, to_tail = os.path.split(to_rel)
1509
1460
        to_dir_id = inv.path2id(to_dir)
1555
1506
        These are files in the working directory that are not versioned or
1556
1507
        control files or ignored.
1557
1508
        """
1558
 
        # force the extras method to be fully executed before returning, to
 
1509
        # force the extras method to be fully executed before returning, to 
1559
1510
        # prevent race conditions with the lock
1560
1511
        return iter(
1561
1512
            [subp for subp in self.extras() if not self.is_ignored(subp)])
1571
1522
        :raises: NoSuchId if any fileid is not currently versioned.
1572
1523
        """
1573
1524
        for file_id in file_ids:
1574
 
            if file_id not in self._inventory:
1575
 
                raise errors.NoSuchId(self, file_id)
1576
 
        for file_id in file_ids:
1577
1525
            if self._inventory.has_id(file_id):
1578
1526
                self._inventory.remove_recursive_id(file_id)
 
1527
            else:
 
1528
                raise errors.NoSuchId(self, file_id)
1579
1529
        if len(file_ids):
1580
 
            # in the future this should just set a dirty bit to wait for the
 
1530
            # in the future this should just set a dirty bit to wait for the 
1581
1531
            # final unlock. However, until all methods of workingtree start
1582
 
            # with the current in -memory inventory rather than triggering
 
1532
            # with the current in -memory inventory rather than triggering 
1583
1533
            # a read, it is more complex - we need to teach read_inventory
1584
1534
            # to know when to read, and when to not read first... and possibly
1585
1535
            # to save first when the in memory one may be corrupted.
1586
1536
            # so for now, we just only write it if it is indeed dirty.
1587
1537
            # - RBC 20060907
1588
1538
            self._write_inventory(self._inventory)
1589
 
 
 
1539
    
1590
1540
    def _iter_conflicts(self):
1591
1541
        conflicted = set()
1592
1542
        for info in self.list_files():
1600
1550
 
1601
1551
    @needs_write_lock
1602
1552
    def pull(self, source, overwrite=False, stop_revision=None,
1603
 
             change_reporter=None, possible_transports=None, local=False):
 
1553
             change_reporter=None, possible_transports=None):
 
1554
        top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1604
1555
        source.lock_read()
1605
1556
        try:
 
1557
            pp = ProgressPhase("Pull phase", 2, top_pb)
 
1558
            pp.next_phase()
1606
1559
            old_revision_info = self.branch.last_revision_info()
1607
1560
            basis_tree = self.basis_tree()
1608
1561
            count = self.branch.pull(source, overwrite, stop_revision,
1609
 
                                     possible_transports=possible_transports,
1610
 
                                     local=local)
 
1562
                                     possible_transports=possible_transports)
1611
1563
            new_revision_info = self.branch.last_revision_info()
1612
1564
            if new_revision_info != old_revision_info:
 
1565
                pp.next_phase()
1613
1566
                repository = self.branch.repository
 
1567
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
1614
1568
                basis_tree.lock_read()
1615
1569
                try:
1616
1570
                    new_basis_tree = self.branch.basis_tree()
1619
1573
                                new_basis_tree,
1620
1574
                                basis_tree,
1621
1575
                                this_tree=self,
1622
 
                                pb=None,
 
1576
                                pb=pb,
1623
1577
                                change_reporter=change_reporter)
1624
 
                    basis_root_id = basis_tree.get_root_id()
1625
 
                    new_root_id = new_basis_tree.get_root_id()
1626
 
                    if basis_root_id != new_root_id:
1627
 
                        self.set_root_id(new_root_id)
 
1578
                    if (basis_tree.inventory.root is None and
 
1579
                        new_basis_tree.inventory.root is not None):
 
1580
                        self.set_root_id(new_basis_tree.get_root_id())
1628
1581
                finally:
 
1582
                    pb.finished()
1629
1583
                    basis_tree.unlock()
1630
1584
                # TODO - dedup parents list with things merged by pull ?
1631
1585
                # reuse the revisiontree we merged against to set the new
1632
1586
                # tree data.
1633
1587
                parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1634
 
                # we have to pull the merge trees out again, because
1635
 
                # merge_inner has set the ids. - this corner is not yet
 
1588
                # we have to pull the merge trees out again, because 
 
1589
                # merge_inner has set the ids. - this corner is not yet 
1636
1590
                # layered well enough to prevent double handling.
1637
1591
                # XXX TODO: Fix the double handling: telling the tree about
1638
1592
                # the already known parent data is wasteful.
1644
1598
            return count
1645
1599
        finally:
1646
1600
            source.unlock()
 
1601
            top_pb.finished()
1647
1602
 
1648
1603
    @needs_write_lock
1649
1604
    def put_file_bytes_non_atomic(self, file_id, bytes):
1675
1630
 
1676
1631
            fl = []
1677
1632
            for subf in os.listdir(dirabs):
1678
 
                if self.bzrdir.is_control_filename(subf):
 
1633
                if subf == '.bzr':
1679
1634
                    continue
1680
1635
                if subf not in dir_entry.children:
1681
1636
                    try:
1691
1646
                            fl.append(subf_norm)
1692
1647
                    else:
1693
1648
                        fl.append(subf)
1694
 
 
 
1649
            
1695
1650
            fl.sort()
1696
1651
            for subf in fl:
1697
1652
                subp = pathjoin(path, subf)
1734
1689
        r"""Check whether the filename matches an ignore pattern.
1735
1690
 
1736
1691
        Patterns containing '/' or '\' need to match the whole path;
1737
 
        others match against only the last component.  Patterns starting
1738
 
        with '!' are ignore exceptions.  Exceptions take precedence
1739
 
        over regular patterns and cause the filename to not be ignored.
 
1692
        others match against only the last component.
1740
1693
 
1741
1694
        If the file is ignored, returns the pattern which caused it to
1742
1695
        be ignored, otherwise None.  So this can simply be used as a
1743
1696
        boolean if desired."""
1744
1697
        if getattr(self, '_ignoreglobster', None) is None:
1745
 
            self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
 
1698
            self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1746
1699
        return self._ignoreglobster.match(filename)
1747
1700
 
1748
1701
    def kind(self, file_id):
1798
1751
            raise errors.ObjectNotLocked(self)
1799
1752
 
1800
1753
    def lock_read(self):
1801
 
        """Lock the tree for reading.
1802
 
 
1803
 
        This also locks the branch, and can be unlocked via self.unlock().
1804
 
 
1805
 
        :return: An object with an unlock method which will release the lock
1806
 
            obtained.
1807
 
        """
 
1754
        """See Branch.lock_read, and WorkingTree.unlock."""
1808
1755
        if not self.is_locked():
1809
1756
            self._reset_data()
1810
1757
        self.branch.lock_read()
1811
1758
        try:
1812
 
            self._control_files.lock_read()
1813
 
            return self
 
1759
            return self._control_files.lock_read()
1814
1760
        except:
1815
1761
            self.branch.unlock()
1816
1762
            raise
1817
1763
 
1818
1764
    def lock_tree_write(self):
1819
 
        """See MutableTree.lock_tree_write, and WorkingTree.unlock.
1820
 
 
1821
 
        :return: An object with an unlock method which will release the lock
1822
 
            obtained.
1823
 
        """
 
1765
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1824
1766
        if not self.is_locked():
1825
1767
            self._reset_data()
1826
1768
        self.branch.lock_read()
1827
1769
        try:
1828
 
            self._control_files.lock_write()
1829
 
            return self
 
1770
            return self._control_files.lock_write()
1830
1771
        except:
1831
1772
            self.branch.unlock()
1832
1773
            raise
1833
1774
 
1834
1775
    def lock_write(self):
1835
 
        """See MutableTree.lock_write, and WorkingTree.unlock.
1836
 
 
1837
 
        :return: An object with an unlock method which will release the lock
1838
 
            obtained.
1839
 
        """
 
1776
        """See MutableTree.lock_write, and WorkingTree.unlock."""
1840
1777
        if not self.is_locked():
1841
1778
            self._reset_data()
1842
1779
        self.branch.lock_write()
1843
1780
        try:
1844
 
            self._control_files.lock_write()
1845
 
            return self
 
1781
            return self._control_files.lock_write()
1846
1782
        except:
1847
1783
            self.branch.unlock()
1848
1784
            raise
1856
1792
    def _reset_data(self):
1857
1793
        """Reset transient data that cannot be revalidated."""
1858
1794
        self._inventory_is_modified = False
1859
 
        f = self._transport.get('inventory')
1860
 
        try:
1861
 
            result = self._deserialize(f)
1862
 
        finally:
1863
 
            f.close()
 
1795
        result = self._deserialize(self._transport.get('inventory'))
1864
1796
        self._set_inventory(result, dirty=False)
1865
1797
 
1866
1798
    @needs_tree_write_lock
1871
1803
 
1872
1804
    def _change_last_revision(self, new_revision):
1873
1805
        """Template method part of set_last_revision to perform the change.
1874
 
 
 
1806
        
1875
1807
        This is used to allow WorkingTree3 instances to not affect branch
1876
1808
        when their last revision is set.
1877
1809
        """
1890
1822
        path = self._basis_inventory_name()
1891
1823
        sio = StringIO(xml)
1892
1824
        self._transport.put_file(path, sio,
1893
 
            mode=self.bzrdir._get_file_mode())
 
1825
            mode=self._control_files._file_mode)
1894
1826
 
1895
1827
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
1896
1828
        """Create the text that will be saved in basis-inventory"""
1903
1835
        # as commit already has that ready-to-use [while the format is the
1904
1836
        # same, that is].
1905
1837
        try:
1906
 
            # this double handles the inventory - unpack and repack -
 
1838
            # this double handles the inventory - unpack and repack - 
1907
1839
            # but is easier to understand. We can/should put a conditional
1908
1840
            # in here based on whether the inventory is in the latest format
1909
1841
            # - perhaps we should repack all inventories on a repository
1910
1842
            # upgrade ?
1911
1843
            # the fast path is to copy the raw xml from the repository. If the
1912
 
            # xml contains 'revision_id="', then we assume the right
 
1844
            # xml contains 'revision_id="', then we assume the right 
1913
1845
            # revision_id is set. We must check for this full string, because a
1914
1846
            # root node id can legitimately look like 'revision_id' but cannot
1915
1847
            # contain a '"'.
1916
 
            xml = self.branch.repository._get_inventory_xml(new_revision)
 
1848
            xml = self.branch.repository.get_inventory_xml(new_revision)
1917
1849
            firstline = xml.split('\n', 1)[0]
1918
 
            if (not 'revision_id="' in firstline or
 
1850
            if (not 'revision_id="' in firstline or 
1919
1851
                'format="7"' not in firstline):
1920
 
                inv = self.branch.repository._serializer.read_inventory_from_string(
1921
 
                    xml, new_revision)
 
1852
                inv = self.branch.repository.deserialise_inventory(
 
1853
                    new_revision, xml)
1922
1854
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
1923
1855
            self._write_basis_inventory(xml)
1924
1856
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
1928
1860
        """Read the cached basis inventory."""
1929
1861
        path = self._basis_inventory_name()
1930
1862
        return self._transport.get_bytes(path)
1931
 
 
 
1863
        
1932
1864
    @needs_read_lock
1933
1865
    def read_working_inventory(self):
1934
1866
        """Read the working inventory.
1935
 
 
 
1867
        
1936
1868
        :raises errors.InventoryModified: read_working_inventory will fail
1937
1869
            when the current in memory inventory has been modified.
1938
1870
        """
1939
 
        # conceptually this should be an implementation detail of the tree.
 
1871
        # conceptually this should be an implementation detail of the tree. 
1940
1872
        # XXX: Deprecate this.
1941
1873
        # ElementTree does its own conversion from UTF-8, so open in
1942
1874
        # binary.
1943
1875
        if self._inventory_is_modified:
1944
1876
            raise errors.InventoryModified(self)
1945
 
        f = self._transport.get('inventory')
1946
 
        try:
1947
 
            result = self._deserialize(f)
1948
 
        finally:
1949
 
            f.close()
 
1877
        result = self._deserialize(self._transport.get('inventory'))
1950
1878
        self._set_inventory(result, dirty=False)
1951
1879
        return result
1952
1880
 
1967
1895
 
1968
1896
        new_files=set()
1969
1897
        unknown_nested_files=set()
1970
 
        if to_file is None:
1971
 
            to_file = sys.stdout
1972
1898
 
1973
1899
        def recurse_directory_to_add_files(directory):
1974
1900
            # Recurse directory and add all files
2030
1956
                        tree_delta.unversioned.extend((unknown_file,))
2031
1957
                raise errors.BzrRemoveChangedFilesError(tree_delta)
2032
1958
 
2033
 
        # Build inv_delta and delete files where applicable,
 
1959
        # Build inv_delta and delete files where applicaple,
2034
1960
        # do this before any modifications to inventory.
2035
1961
        for f in files:
2036
1962
            fid = self.path2id(f)
2044
1970
                        new_status = 'I'
2045
1971
                    else:
2046
1972
                        new_status = '?'
2047
 
                    # XXX: Really should be a more abstract reporter interface
2048
 
                    kind_ch = osutils.kind_marker(self.kind(fid))
2049
 
                    to_file.write(new_status + '       ' + f + kind_ch + '\n')
 
1973
                    textui.show_status(new_status, self.kind(fid), f,
 
1974
                                       to_file=to_file)
2050
1975
                # Unversion file
2051
1976
                inv_delta.append((f, None, fid, None))
2052
1977
                message = "removed %s" % (f,)
2075
2000
 
2076
2001
    @needs_tree_write_lock
2077
2002
    def revert(self, filenames=None, old_tree=None, backups=True,
2078
 
               pb=None, report_changes=False):
 
2003
               pb=DummyProgress(), report_changes=False):
2079
2004
        from bzrlib.conflicts import resolve
2080
2005
        if filenames == []:
2081
2006
            filenames = None
2094
2019
            if filenames is None and len(self.get_parent_ids()) > 1:
2095
2020
                parent_trees = []
2096
2021
                last_revision = self.last_revision()
2097
 
                if last_revision != _mod_revision.NULL_REVISION:
 
2022
                if last_revision != NULL_REVISION:
2098
2023
                    if basis_tree is None:
2099
2024
                        basis_tree = self.basis_tree()
2100
2025
                        basis_tree.lock_read()
2138
2063
    def set_inventory(self, new_inventory_list):
2139
2064
        from bzrlib.inventory import (Inventory,
2140
2065
                                      InventoryDirectory,
 
2066
                                      InventoryEntry,
2141
2067
                                      InventoryFile,
2142
2068
                                      InventoryLink)
2143
2069
        inv = Inventory(self.get_root_id())
2145
2071
            name = os.path.basename(path)
2146
2072
            if name == "":
2147
2073
                continue
2148
 
            # fixme, there should be a factory function inv,add_??
 
2074
            # fixme, there should be a factory function inv,add_?? 
2149
2075
            if kind == 'directory':
2150
2076
                inv.add(InventoryDirectory(file_id, name, parent))
2151
2077
            elif kind == 'file':
2159
2085
    @needs_tree_write_lock
2160
2086
    def set_root_id(self, file_id):
2161
2087
        """Set the root id for this tree."""
2162
 
        # for compatability
 
2088
        # for compatability 
2163
2089
        if file_id is None:
2164
2090
            raise ValueError(
2165
2091
                'WorkingTree.set_root_id with fileid=None')
2169
2095
    def _set_root_id(self, file_id):
2170
2096
        """Set the root id for this tree, in a format specific manner.
2171
2097
 
2172
 
        :param file_id: The file id to assign to the root. It must not be
 
2098
        :param file_id: The file id to assign to the root. It must not be 
2173
2099
            present in the current inventory or an error will occur. It must
2174
2100
            not be None, but rather a valid file id.
2175
2101
        """
2194
2120
 
2195
2121
    def unlock(self):
2196
2122
        """See Branch.unlock.
2197
 
 
 
2123
        
2198
2124
        WorkingTree locking just uses the Branch locking facilities.
2199
2125
        This is current because all working trees have an embedded branch
2200
2126
        within them. IF in the future, we were to make branch data shareable
2201
 
        between multiple working trees, i.e. via shared storage, then we
 
2127
        between multiple working trees, i.e. via shared storage, then we 
2202
2128
        would probably want to lock both the local tree, and the branch.
2203
2129
        """
2204
2130
        raise NotImplementedError(self.unlock)
2205
2131
 
2206
 
    _marker = object()
2207
 
 
2208
 
    def update(self, change_reporter=None, possible_transports=None,
2209
 
               revision=None, old_tip=_marker):
 
2132
    def update(self, change_reporter=None, possible_transports=None):
2210
2133
        """Update a working tree along its branch.
2211
2134
 
2212
2135
        This will update the branch if its bound too, which means we have
2230
2153
        - Merge current state -> basis tree of the master w.r.t. the old tree
2231
2154
          basis.
2232
2155
        - Do a 'normal' merge of the old branch basis if it is relevant.
2233
 
 
2234
 
        :param revision: The target revision to update to. Must be in the
2235
 
            revision history.
2236
 
        :param old_tip: If branch.update() has already been run, the value it
2237
 
            returned (old tip of the branch or None). _marker is used
2238
 
            otherwise.
2239
2156
        """
2240
2157
        if self.branch.get_bound_location() is not None:
2241
2158
            self.lock_write()
2242
 
            update_branch = (old_tip is self._marker)
 
2159
            update_branch = True
2243
2160
        else:
2244
2161
            self.lock_tree_write()
2245
2162
            update_branch = False
2247
2164
            if update_branch:
2248
2165
                old_tip = self.branch.update(possible_transports)
2249
2166
            else:
2250
 
                if old_tip is self._marker:
2251
 
                    old_tip = None
2252
 
            return self._update_tree(old_tip, change_reporter, revision)
 
2167
                old_tip = None
 
2168
            return self._update_tree(old_tip, change_reporter)
2253
2169
        finally:
2254
2170
            self.unlock()
2255
2171
 
2256
2172
    @needs_tree_write_lock
2257
 
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
 
2173
    def _update_tree(self, old_tip=None, change_reporter=None):
2258
2174
        """Update a tree to the master branch.
2259
2175
 
2260
2176
        :param old_tip: if supplied, the previous tip revision the branch,
2266
2182
        # cant set that until we update the working trees last revision to be
2267
2183
        # one from the new branch, because it will just get absorbed by the
2268
2184
        # parent de-duplication logic.
2269
 
        #
 
2185
        # 
2270
2186
        # We MUST save it even if an error occurs, because otherwise the users
2271
2187
        # local work is unreferenced and will appear to have been lost.
2272
 
        #
2273
 
        nb_conflicts = 0
 
2188
        # 
 
2189
        result = 0
2274
2190
        try:
2275
2191
            last_rev = self.get_parent_ids()[0]
2276
2192
        except IndexError:
2277
2193
            last_rev = _mod_revision.NULL_REVISION
2278
 
        if revision is None:
2279
 
            revision = self.branch.last_revision()
2280
 
 
2281
 
        old_tip = old_tip or _mod_revision.NULL_REVISION
2282
 
 
2283
 
        if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2284
 
            # the branch we are bound to was updated
2285
 
            # merge those changes in first
2286
 
            base_tree  = self.basis_tree()
2287
 
            other_tree = self.branch.repository.revision_tree(old_tip)
2288
 
            nb_conflicts = merge.merge_inner(self.branch, other_tree,
2289
 
                                             base_tree, this_tree=self,
2290
 
                                             change_reporter=change_reporter)
2291
 
            if nb_conflicts:
2292
 
                self.add_parent_tree((old_tip, other_tree))
2293
 
                trace.note('Rerun update after fixing the conflicts.')
2294
 
                return nb_conflicts
2295
 
 
2296
 
        if last_rev != _mod_revision.ensure_null(revision):
2297
 
            # the working tree is up to date with the branch
2298
 
            # we can merge the specified revision from master
2299
 
            to_tree = self.branch.repository.revision_tree(revision)
2300
 
            to_root_id = to_tree.get_root_id()
2301
 
 
 
2194
        if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
 
2195
            # merge tree state up to new branch tip.
2302
2196
            basis = self.basis_tree()
2303
2197
            basis.lock_read()
2304
2198
            try:
2305
 
                if (basis.inventory.root is None
2306
 
                    or basis.inventory.root.file_id != to_root_id):
2307
 
                    self.set_root_id(to_root_id)
 
2199
                to_tree = self.branch.basis_tree()
 
2200
                if basis.inventory.root is None:
 
2201
                    self.set_root_id(to_tree.get_root_id())
2308
2202
                    self.flush()
 
2203
                result += merge.merge_inner(
 
2204
                                      self.branch,
 
2205
                                      to_tree,
 
2206
                                      basis,
 
2207
                                      this_tree=self,
 
2208
                                      change_reporter=change_reporter)
2309
2209
            finally:
2310
2210
                basis.unlock()
2311
 
 
2312
 
            # determine the branch point
2313
 
            graph = self.branch.repository.get_graph()
2314
 
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2315
 
                                                last_rev)
2316
 
            base_tree = self.branch.repository.revision_tree(base_rev_id)
2317
 
 
2318
 
            nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2319
 
                                             this_tree=self,
2320
 
                                             change_reporter=change_reporter)
2321
 
            self.set_last_revision(revision)
2322
2211
            # TODO - dedup parents list with things merged by pull ?
2323
2212
            # reuse the tree we've updated to to set the basis:
2324
 
            parent_trees = [(revision, to_tree)]
 
2213
            parent_trees = [(self.branch.last_revision(), to_tree)]
2325
2214
            merges = self.get_parent_ids()[1:]
2326
2215
            # Ideally we ask the tree for the trees here, that way the working
2327
 
            # tree can decide whether to give us the entire tree or give us a
 
2216
            # tree can decide whether to give us teh entire tree or give us a
2328
2217
            # lazy initialised tree. dirstate for instance will have the trees
2329
2218
            # in ram already, whereas a last-revision + basis-inventory tree
2330
2219
            # will not, but also does not need them when setting parents.
2331
2220
            for parent in merges:
2332
2221
                parent_trees.append(
2333
2222
                    (parent, self.branch.repository.revision_tree(parent)))
2334
 
            if not _mod_revision.is_null(old_tip):
 
2223
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2335
2224
                parent_trees.append(
2336
2225
                    (old_tip, self.branch.repository.revision_tree(old_tip)))
2337
2226
            self.set_parent_trees(parent_trees)
2338
2227
            last_rev = parent_trees[0][0]
2339
 
        return nb_conflicts
 
2228
        else:
 
2229
            # the working tree had the same last-revision as the master
 
2230
            # branch did. We may still have pivot local work from the local
 
2231
            # branch into old_tip:
 
2232
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
 
2233
                self.add_parent_tree_id(old_tip)
 
2234
        if (old_tip is not None and not _mod_revision.is_null(old_tip)
 
2235
            and old_tip != last_rev):
 
2236
            # our last revision was not the prior branch last revision
 
2237
            # and we have converted that last revision to a pending merge.
 
2238
            # base is somewhere between the branch tip now
 
2239
            # and the now pending merge
 
2240
 
 
2241
            # Since we just modified the working tree and inventory, flush out
 
2242
            # the current state, before we modify it again.
 
2243
            # TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
 
2244
            #       requires it only because TreeTransform directly munges the
 
2245
            #       inventory and calls tree._write_inventory(). Ultimately we
 
2246
            #       should be able to remove this extra flush.
 
2247
            self.flush()
 
2248
            graph = self.branch.repository.get_graph()
 
2249
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
 
2250
                                                old_tip)
 
2251
            base_tree = self.branch.repository.revision_tree(base_rev_id)
 
2252
            other_tree = self.branch.repository.revision_tree(old_tip)
 
2253
            result += merge.merge_inner(
 
2254
                                  self.branch,
 
2255
                                  other_tree,
 
2256
                                  base_tree,
 
2257
                                  this_tree=self,
 
2258
                                  change_reporter=change_reporter)
 
2259
        return result
2340
2260
 
2341
2261
    def _write_hashcache_if_dirty(self):
2342
2262
        """Write out the hashcache if it is dirty."""
2442
2362
                    bzrdir_loc = bisect_left(cur_disk_dir_content,
2443
2363
                        ('.bzr', '.bzr'))
2444
2364
                    if (bzrdir_loc < len(cur_disk_dir_content)
2445
 
                        and self.bzrdir.is_control_filename(
2446
 
                            cur_disk_dir_content[bzrdir_loc][0])):
 
2365
                        and cur_disk_dir_content[bzrdir_loc][0] == '.bzr'):
2447
2366
                        # we dont yield the contents of, or, .bzr itself.
2448
2367
                        del cur_disk_dir_content[bzrdir_loc]
2449
2368
            if inv_finished:
2583
2502
        return un_resolved, resolved
2584
2503
 
2585
2504
    @needs_read_lock
2586
 
    def _check(self, references):
2587
 
        """Check the tree for consistency.
2588
 
 
2589
 
        :param references: A dict with keys matching the items returned by
2590
 
            self._get_check_refs(), and values from looking those keys up in
2591
 
            the repository.
2592
 
        """
 
2505
    def _check(self):
2593
2506
        tree_basis = self.basis_tree()
2594
2507
        tree_basis.lock_read()
2595
2508
        try:
2596
 
            repo_basis = references[('trees', self.last_revision())]
 
2509
            repo_basis = self.branch.repository.revision_tree(
 
2510
                self.last_revision())
2597
2511
            if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2598
2512
                raise errors.BzrCheckError(
2599
2513
                    "Mismatched basis inventory content.")
2612
2526
        """
2613
2527
        return
2614
2528
 
 
2529
    @needs_read_lock
2615
2530
    def _get_rules_searcher(self, default_searcher):
2616
2531
        """See Tree._get_rules_searcher."""
2617
2532
        if self._rules_searcher is None:
2628
2543
class WorkingTree2(WorkingTree):
2629
2544
    """This is the Format 2 working tree.
2630
2545
 
2631
 
    This was the first weave based working tree.
 
2546
    This was the first weave based working tree. 
2632
2547
     - uses os locks for locking.
2633
2548
     - uses the branch last-revision.
2634
2549
    """
2644
2559
        if self._inventory is None:
2645
2560
            self.read_working_inventory()
2646
2561
 
2647
 
    def _get_check_refs(self):
2648
 
        """Return the references needed to perform a check of this tree."""
2649
 
        return [('trees', self.last_revision())]
2650
 
 
2651
2562
    def lock_tree_write(self):
2652
2563
        """See WorkingTree.lock_tree_write().
2653
2564
 
2654
2565
        In Format2 WorkingTrees we have a single lock for the branch and tree
2655
2566
        so lock_tree_write() degrades to lock_write().
2656
 
 
2657
 
        :return: An object with an unlock method which will release the lock
2658
 
            obtained.
2659
2567
        """
2660
2568
        self.branch.lock_write()
2661
2569
        try:
2662
 
            self._control_files.lock_write()
2663
 
            return self
 
2570
            return self._control_files.lock_write()
2664
2571
        except:
2665
2572
            self.branch.unlock()
2666
2573
            raise
2675
2582
            if self._inventory_is_modified:
2676
2583
                self.flush()
2677
2584
            self._write_hashcache_if_dirty()
2678
 
 
 
2585
                    
2679
2586
        # reverse order of locking.
2680
2587
        try:
2681
2588
            return self._control_files.unlock()
2703
2610
 
2704
2611
    def _change_last_revision(self, revision_id):
2705
2612
        """See WorkingTree._change_last_revision."""
2706
 
        if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
 
2613
        if revision_id is None or revision_id == NULL_REVISION:
2707
2614
            try:
2708
2615
                self._transport.delete('last-revision')
2709
2616
            except errors.NoSuchFile:
2711
2618
            return False
2712
2619
        else:
2713
2620
            self._transport.put_bytes('last-revision', revision_id,
2714
 
                mode=self.bzrdir._get_file_mode())
 
2621
                mode=self._control_files._file_mode)
2715
2622
            return True
2716
2623
 
2717
 
    def _get_check_refs(self):
2718
 
        """Return the references needed to perform a check of this tree."""
2719
 
        return [('trees', self.last_revision())]
2720
 
 
2721
2624
    @needs_tree_write_lock
2722
2625
    def set_conflicts(self, conflicts):
2723
 
        self._put_rio('conflicts', conflicts.to_stanzas(),
 
2626
        self._put_rio('conflicts', conflicts.to_stanzas(), 
2724
2627
                      CONFLICT_HEADER_1)
2725
2628
 
2726
2629
    @needs_tree_write_lock
2775
2678
     * a format string,
2776
2679
     * an open routine.
2777
2680
 
2778
 
    Formats are placed in an dict by their format string for reference
 
2681
    Formats are placed in an dict by their format string for reference 
2779
2682
    during workingtree opening. Its not required that these be instances, they
2780
 
    can be classes themselves with class methods - it simply depends on
 
2683
    can be classes themselves with class methods - it simply depends on 
2781
2684
    whether state is needed for a given format or not.
2782
2685
 
2783
2686
    Once a format is deprecated, just deprecate the initialize and open
2784
 
    methods on the format class. Do not deprecate the object, as the
 
2687
    methods on the format class. Do not deprecate the object, as the 
2785
2688
    object will be created every time regardless.
2786
2689
    """
2787
2690
 
2800
2703
        """Return the format for the working tree object in a_bzrdir."""
2801
2704
        try:
2802
2705
            transport = a_bzrdir.get_workingtree_transport(None)
2803
 
            format_string = transport.get_bytes("format")
 
2706
            format_string = transport.get("format").read()
2804
2707
            return klass._formats[format_string]
2805
2708
        except errors.NoSuchFile:
2806
2709
            raise errors.NoWorkingTree(base=transport.base)
2831
2734
        """Is this format supported?
2832
2735
 
2833
2736
        Supported formats can be initialized and opened.
2834
 
        Unsupported formats may not support initialization or committing or
 
2737
        Unsupported formats may not support initialization or committing or 
2835
2738
        some other features depending on the reason for not being supported.
2836
2739
        """
2837
2740
        return True
2838
2741
 
2839
 
    def supports_content_filtering(self):
2840
 
        """True if this format supports content filtering."""
2841
 
        return False
2842
 
 
2843
 
    def supports_views(self):
2844
 
        """True if this format supports stored views."""
2845
 
        return False
2846
 
 
2847
2742
    @classmethod
2848
2743
    def register_format(klass, format):
2849
2744
        klass._formats[format.get_format_string()] = format
2858
2753
 
2859
2754
 
2860
2755
class WorkingTreeFormat2(WorkingTreeFormat):
2861
 
    """The second working tree format.
 
2756
    """The second working tree format. 
2862
2757
 
2863
2758
    This format modified the hash cache from the format 1 hash cache.
2864
2759
    """
2877
2772
        no working tree.  (See bug #43064).
2878
2773
        """
2879
2774
        sio = StringIO()
2880
 
        inv = inventory.Inventory()
 
2775
        inv = Inventory()
2881
2776
        xml5.serializer_v5.write_inventory(inv, sio, working=True)
2882
2777
        sio.seek(0)
2883
2778
        transport.put_file('inventory', sio, file_mode)
2899
2794
            branch.generate_revision_history(revision_id)
2900
2795
        finally:
2901
2796
            branch.unlock()
2902
 
        inv = inventory.Inventory()
 
2797
        inv = Inventory()
2903
2798
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2904
2799
                         branch,
2905
2800
                         inv,
2950
2845
        - is new in bzr 0.8
2951
2846
        - uses a LockDir to guard access for writes.
2952
2847
    """
2953
 
 
 
2848
    
2954
2849
    upgrade_recommended = True
2955
2850
 
2956
2851
    def get_format_string(self):
2973
2868
 
2974
2869
    def _open_control_files(self, a_bzrdir):
2975
2870
        transport = a_bzrdir.get_workingtree_transport(None)
2976
 
        return LockableFiles(transport, self._lock_file_name,
 
2871
        return LockableFiles(transport, self._lock_file_name, 
2977
2872
                             self._lock_class)
2978
2873
 
2979
2874
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2980
2875
                   accelerator_tree=None, hardlink=False):
2981
2876
        """See WorkingTreeFormat.initialize().
2982
 
 
 
2877
        
2983
2878
        :param revision_id: if supplied, create a working tree at a different
2984
2879
            revision than the branch is at.
2985
2880
        :param accelerator_tree: A tree which can be used for retrieving file
2996
2891
        control_files.create_lock()
2997
2892
        control_files.lock_write()
2998
2893
        transport.put_bytes('format', self.get_format_string(),
2999
 
            mode=a_bzrdir._get_file_mode())
 
2894
            mode=control_files._file_mode)
3000
2895
        if from_branch is not None:
3001
2896
            branch = from_branch
3002
2897
        else:
3022
2917
            # only set an explicit root id if there is one to set.
3023
2918
            if basis_tree.inventory.root is not None:
3024
2919
                wt.set_root_id(basis_tree.get_root_id())
3025
 
            if revision_id == _mod_revision.NULL_REVISION:
 
2920
            if revision_id == NULL_REVISION:
3026
2921
                wt.set_parent_trees([])
3027
2922
            else:
3028
2923
                wt.set_parent_trees([(revision_id, basis_tree)])
3035
2930
        return wt
3036
2931
 
3037
2932
    def _initial_inventory(self):
3038
 
        return inventory.Inventory()
 
2933
        return Inventory()
3039
2934
 
3040
2935
    def __init__(self):
3041
2936
        super(WorkingTreeFormat3, self).__init__()
3056
2951
 
3057
2952
    def _open(self, a_bzrdir, control_files):
3058
2953
        """Open the tree itself.
3059
 
 
 
2954
        
3060
2955
        :param a_bzrdir: the dir for the tree.
3061
2956
        :param control_files: the control files for the tree.
3062
2957
        """
3070
2965
        return self.get_format_string()
3071
2966
 
3072
2967
 
3073
 
__default_format = WorkingTreeFormat6()
 
2968
__default_format = WorkingTreeFormat4()
3074
2969
WorkingTreeFormat.register_format(__default_format)
3075
 
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3076
 
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3077
2970
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3078
2971
WorkingTreeFormat.set_default_format(__default_format)
3079
2972
# formats which have no format string are not discoverable