/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: Aaron Bentley
  • Date: 2008-10-12 15:38:00 UTC
  • mto: This revision was merged to the branch mainline in revision 3803.
  • Revision ID: aaron@aaronbentley.com-20081012153800-8ff72bdslnbknfdi
Test Tree.get_file_lines, provide a default implementation

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
80
 
from bzrlib.lockable_files import LockableFiles
 
87
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
 
88
from bzrlib.lockable_files import LockableFiles, TransportLock
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,
93
103
    supports_executable,
94
104
    )
95
 
from bzrlib.filters import filtered_input_file
96
105
from bzrlib.trace import mutter, note
97
106
from bzrlib.transport.local import LocalTransport
98
 
from bzrlib.revision import CURRENT_REVISION
 
107
from bzrlib.progress import DummyProgress, ProgressPhase
 
108
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
99
109
from bzrlib.rio import RioReader, rio_file, Stanza
100
 
from bzrlib.symbol_versioning import (
101
 
    deprecated_passed,
102
 
    DEPRECATED_PARAMETER,
103
 
    )
 
110
from bzrlib.symbol_versioning import (deprecated_passed,
 
111
        deprecated_method,
 
112
        deprecated_function,
 
113
        DEPRECATED_PARAMETER,
 
114
        )
104
115
 
105
116
 
106
117
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
118
CONFLICT_HEADER_1 = "BZR conflict list format 1"
111
119
 
112
120
ERROR_PATH_NOT_FOUND = 3    # WindowsError errno code, equivalent to ENOENT
115
123
class TreeEntry(object):
116
124
    """An entry that implements the minimum interface used by commands.
117
125
 
118
 
    This needs further inspection, it may be better to have
 
126
    This needs further inspection, it may be better to have 
119
127
    InventoryEntries without ids - though that seems wrong. For now,
120
128
    this is a parallel hierarchy to InventoryEntry, and needs to become
121
129
    one of several things: decorates to that hierarchy, children of, or
124
132
    no InventoryEntry available - i.e. for unversioned objects.
125
133
    Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
126
134
    """
127
 
 
 
135
 
128
136
    def __eq__(self, other):
129
137
        # yes, this us ugly, TODO: best practice __eq__ style.
130
138
        return (isinstance(other, TreeEntry)
131
139
                and other.__class__ == self.__class__)
132
 
 
 
140
 
133
141
    def kind_character(self):
134
142
        return "???"
135
143
 
167
175
        return ''
168
176
 
169
177
 
170
 
class WorkingTree(bzrlib.mutabletree.MutableTree,
171
 
    bzrdir.ControlComponent):
 
178
class WorkingTree(bzrlib.mutabletree.MutableTree):
172
179
    """Working copy tree.
173
180
 
174
181
    The inventory is held in the `Branch` working-inventory, and the
178
185
    not listed in the Inventory and vice versa.
179
186
    """
180
187
 
181
 
    # override this to set the strategy for storing views
182
 
    def _make_views(self):
183
 
        return views.DisabledViews(self)
184
 
 
185
188
    def __init__(self, basedir='.',
186
189
                 branch=DEPRECATED_PARAMETER,
187
190
                 _inventory=None,
222
225
        wt_trans = self.bzrdir.get_workingtree_transport(None)
223
226
        cache_filename = wt_trans.local_abspath('stat-cache')
224
227
        self._hashcache = hashcache.HashCache(basedir, cache_filename,
225
 
            self.bzrdir._get_file_mode(),
226
 
            self._content_filter_stack_provider())
 
228
            self.bzrdir._get_file_mode())
227
229
        hc = self._hashcache
228
230
        hc.read()
229
231
        # is this scan needed ? it makes things kinda slow.
245
247
            self._set_inventory(_inventory, dirty=False)
246
248
        self._detect_case_handling()
247
249
        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
250
 
258
251
    def _detect_case_handling(self):
259
252
        wt_trans = self.bzrdir.get_workingtree_transport(None)
285
278
        self._control_files.break_lock()
286
279
        self.branch.break_lock()
287
280
 
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
281
    def requires_rich_root(self):
299
282
        return self._format.requires_rich_root
300
283
 
301
284
    def supports_tree_reference(self):
302
285
        return False
303
286
 
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
287
    def _set_inventory(self, inv, dirty):
311
288
        """Set the internal cached inventory.
312
289
 
400
377
 
401
378
    def basis_tree(self):
402
379
        """Return RevisionTree for the current last revision.
403
 
 
 
380
        
404
381
        If the left most parent is a ghost then the returned tree will be an
405
 
        empty tree - one obtained by calling
 
382
        empty tree - one obtained by calling 
406
383
        repository.revision_tree(NULL_REVISION).
407
384
        """
408
385
        try:
424
401
            return self.branch.repository.revision_tree(revision_id)
425
402
        except (errors.RevisionNotPresent, errors.NoSuchRevision):
426
403
            # 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
 
404
            # occured. If the revision is present, its a problem, if its not
428
405
            # its a ghost.
429
406
            if self.branch.repository.has_revision(revision_id):
430
407
                raise
437
414
 
438
415
    def relpath(self, path):
439
416
        """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
 
417
        
 
418
        The path may be absolute or relative. If its a relative path it is 
442
419
        interpreted relative to the python current working directory.
443
420
        """
444
421
        return osutils.relpath(self.basedir, path)
446
423
    def has_filename(self, filename):
447
424
        return osutils.lexists(self.abspath(filename))
448
425
 
449
 
    def get_file(self, file_id, path=None, filtered=True):
450
 
        return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
 
426
    def get_file(self, file_id, path=None):
 
427
        return self.get_file_with_stat(file_id, path)[0]
451
428
 
452
 
    def get_file_with_stat(self, file_id, path=None, filtered=True,
453
 
        _fstat=os.fstat):
454
 
        """See Tree.get_file_with_stat."""
 
429
    def get_file_with_stat(self, file_id, path=None, _fstat=os.fstat):
 
430
        """See MutableTree.get_file_with_stat."""
455
431
        if path is None:
456
432
            path = self.id2path(file_id)
457
 
        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)
463
 
 
464
 
    def get_file_text(self, file_id, path=None, filtered=True):
465
 
        return self.get_file(file_id, path=path, filtered=filtered).read()
466
 
 
467
 
    def get_file_byname(self, filename, filtered=True):
468
 
        path = self.abspath(filename)
469
 
        f = file(path, 'rb')
470
 
        if filtered and self.supports_content_filtering():
471
 
            filters = self._content_filter_stack(filename)
472
 
            return filtered_input_file(f, filters)
473
 
        else:
474
 
            return f
475
 
 
476
 
    def get_file_lines(self, file_id, path=None, filtered=True):
477
 
        """See Tree.get_file_lines()"""
478
 
        file = self.get_file(file_id, path, filtered=filtered)
479
 
        try:
480
 
            return file.readlines()
481
 
        finally:
482
 
            file.close()
 
433
        file_obj = self.get_file_byname(path)
 
434
        return (file_obj, _fstat(file_obj.fileno()))
 
435
 
 
436
    def get_file_byname(self, filename):
 
437
        return file(self.abspath(filename), 'rb')
483
438
 
484
439
    @needs_read_lock
485
440
    def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
492
447
        incorrectly attributed to CURRENT_REVISION (but after committing, the
493
448
        attribution will be correct).
494
449
        """
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
 
450
        basis = self.basis_tree()
 
451
        basis.lock_read()
 
452
        try:
 
453
            changes = self.iter_changes(basis, True, [self.id2path(file_id)],
 
454
                require_versioned=True).next()
 
455
            changed_content, kind = changes[2], changes[6]
 
456
            if not changed_content:
 
457
                return basis.annotate_iter(file_id)
 
458
            if kind[1] is None:
 
459
                return None
 
460
            import annotate
 
461
            if kind[0] != 'file':
 
462
                old_lines = []
 
463
            else:
 
464
                old_lines = list(basis.annotate_iter(file_id))
 
465
            old = [old_lines]
 
466
            for tree in self.branch.repository.revision_trees(
 
467
                self.get_parent_ids()[1:]):
 
468
                if file_id not in tree:
 
469
                    continue
 
470
                old.append(list(tree.annotate_iter(file_id)))
 
471
            return annotate.reannotate(old, self.get_file(file_id).readlines(),
 
472
                                       default_revision)
 
473
        finally:
 
474
            basis.unlock()
531
475
 
532
476
    def _get_ancestors(self, default_revision):
533
477
        ancestors = set([default_revision])
538
482
 
539
483
    def get_parent_ids(self):
540
484
        """See Tree.get_parent_ids.
541
 
 
 
485
        
542
486
        This implementation reads the pending merges list and last_revision
543
487
        value and uses that to decide what the parents list should be.
544
488
        """
548
492
        else:
549
493
            parents = [last_rev]
550
494
        try:
551
 
            merges_bytes = self._transport.get_bytes('pending-merges')
 
495
            merges_file = self._transport.get('pending-merges')
552
496
        except errors.NoSuchFile:
553
497
            pass
554
498
        else:
555
 
            for l in osutils.split_lines(merges_bytes):
 
499
            for l in merges_file.readlines():
556
500
                revision_id = l.rstrip('\n')
557
501
                parents.append(revision_id)
558
502
        return parents
561
505
    def get_root_id(self):
562
506
        """Return the id of this trees root"""
563
507
        return self._inventory.root.file_id
564
 
 
 
508
        
565
509
    def _get_store_filename(self, file_id):
566
510
        ## XXX: badly named; this is not in the store at all
567
511
        return self.abspath(self.id2path(file_id))
569
513
    @needs_read_lock
570
514
    def clone(self, to_bzrdir, revision_id=None):
571
515
        """Duplicate this working tree into to_bzr, including all state.
572
 
 
 
516
        
573
517
        Specifically modified files are kept as modified, but
574
518
        ignored and unknown files are discarded.
575
519
 
576
520
        If you want to make a new line of development, see bzrdir.sprout()
577
521
 
578
522
        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
 
523
            If not None, the cloned tree will have its last revision set to 
 
524
            revision, and and difference between the source trees last revision
581
525
            and this one merged in.
582
526
        """
583
527
        # assumes the target bzr dir format is compatible.
617
561
 
618
562
    def get_file_size(self, file_id):
619
563
        """See Tree.get_file_size"""
620
 
        # XXX: this returns the on-disk size; it should probably return the
621
 
        # canonical size
622
564
        try:
623
565
            return os.path.getsize(self.id2abspath(file_id))
624
566
        except OSError, e:
640
582
 
641
583
    def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
642
584
        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
585
        return self._inventory[file_id].executable
648
586
 
649
587
    def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
671
609
        """See MutableTree._add."""
672
610
        # TODO: Re-adding a file that is removed in the working copy
673
611
        # should probably put it back with the previous ID.
674
 
        # the read and write working inventory should not occur in this
 
612
        # the read and write working inventory should not occur in this 
675
613
        # function - they should be part of lock_write and unlock.
676
614
        inv = self.inventory
677
615
        for f, file_id, kind in zip(files, ids, kinds):
759
697
            raise
760
698
        kind = _mapper(stat_result.st_mode)
761
699
        if kind == 'file':
762
 
            return self._file_content_summary(path, stat_result)
 
700
            size = stat_result.st_size
 
701
            # try for a stat cache lookup
 
702
            executable = self._is_executable_from_path_and_stat(path, stat_result)
 
703
            return (kind, size, executable, self._sha_from_stat(
 
704
                path, stat_result))
763
705
        elif kind == 'directory':
764
706
            # perhaps it looks like a plain directory, but it's really a
765
707
            # reference.
767
709
                kind = 'tree-reference'
768
710
            return kind, None, None, None
769
711
        elif kind == 'symlink':
770
 
            target = osutils.readlink(abspath)
771
 
            return ('symlink', None, None, target)
 
712
            return ('symlink', None, None, os.readlink(abspath))
772
713
        else:
773
714
            return (kind, None, None, None)
774
715
 
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
716
    def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
783
717
        """Common ghost checking functionality from set_parent_*.
784
718
 
794
728
    def _set_merges_from_parent_ids(self, parent_ids):
795
729
        merges = parent_ids[1:]
796
730
        self._transport.put_bytes('pending-merges', '\n'.join(merges),
797
 
            mode=self.bzrdir._get_file_mode())
 
731
            mode=self._control_files._file_mode)
798
732
 
799
733
    def _filter_parent_ids_by_ancestry(self, revision_ids):
800
734
        """Check that all merged revisions are proper 'heads'.
801
735
 
802
736
        This will always return the first revision_id, and any merged revisions
803
 
        which are
 
737
        which are 
804
738
        """
805
739
        if len(revision_ids) == 0:
806
740
            return revision_ids
818
752
    @needs_tree_write_lock
819
753
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
820
754
        """Set the parent ids to revision_ids.
821
 
 
 
755
        
822
756
        See also set_parent_trees. This api will try to retrieve the tree data
823
757
        for each element of revision_ids from the trees repository. If you have
824
758
        tree data already available, it is more efficient to use
900
834
        self._must_be_locked()
901
835
        my_file = rio_file(stanzas, header)
902
836
        self._transport.put_file(filename, my_file,
903
 
            mode=self.bzrdir._get_file_mode())
 
837
            mode=self._control_files._file_mode)
904
838
 
905
839
    @needs_write_lock # because merge pulls data into the branch.
906
840
    def merge_from_branch(self, branch, to_revision=None, from_revision=None,
907
 
                          merge_type=None, force=False):
 
841
        merge_type=None):
908
842
        """Merge from a branch into this working tree.
909
843
 
910
844
        :param branch: The branch to merge from.
914
848
            branch.last_revision().
915
849
        """
916
850
        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()
 
851
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
852
        try:
 
853
            merger = Merger(self.branch, this_tree=self, pb=pb)
 
854
            merger.pp = ProgressPhase("Merge phase", 5, pb)
 
855
            merger.pp.next_phase()
 
856
            # check that there are no
 
857
            # local alterations
 
858
            merger.check_basis(check_clean=True, require_commits=False)
 
859
            if to_revision is None:
 
860
                to_revision = _mod_revision.ensure_null(branch.last_revision())
 
861
            merger.other_rev_id = to_revision
 
862
            if _mod_revision.is_null(merger.other_rev_id):
 
863
                raise errors.NoCommits(branch)
 
864
            self.branch.fetch(branch, last_revision=merger.other_rev_id)
 
865
            merger.other_basis = merger.other_rev_id
 
866
            merger.other_tree = self.branch.repository.revision_tree(
 
867
                merger.other_rev_id)
 
868
            merger.other_branch = branch
 
869
            merger.pp.next_phase()
 
870
            if from_revision is None:
 
871
                merger.find_base()
 
872
            else:
 
873
                merger.set_base_revision(from_revision, branch)
 
874
            if merger.base_rev_id == merger.other_rev_id:
 
875
                raise errors.PointlessMerge
 
876
            merger.backup_files = False
 
877
            if merge_type is None:
 
878
                merger.merge_type = Merge3Merger
 
879
            else:
 
880
                merger.merge_type = merge_type
 
881
            merger.set_interesting_files(None)
 
882
            merger.show_base = False
 
883
            merger.reprocess = False
 
884
            conflicts = merger.do_merge()
 
885
            merger.set_pending()
 
886
        finally:
 
887
            pb.finished()
947
888
        return conflicts
948
889
 
949
890
    @needs_read_lock
950
891
    def merge_modified(self):
951
892
        """Return a dictionary of files modified by a merge.
952
893
 
953
 
        The list is initialized by WorkingTree.set_merge_modified, which is
 
894
        The list is initialized by WorkingTree.set_merge_modified, which is 
954
895
        typically called after we make some automatic updates to the tree
955
896
        because of a merge.
956
897
 
990
931
        return file_id
991
932
 
992
933
    def get_symlink_target(self, file_id):
993
 
        abspath = self.id2abspath(file_id)
994
 
        target = osutils.readlink(abspath)
995
 
        return target
 
934
        return os.readlink(self.id2abspath(file_id))
996
935
 
997
936
    @needs_write_lock
998
937
    def subsume(self, other_tree):
1048
987
        return False
1049
988
 
1050
989
    def _directory_may_be_tree_reference(self, relpath):
1051
 
        # as a special case, if a directory contains control files then
 
990
        # as a special case, if a directory contains control files then 
1052
991
        # it's a tree reference, except that the root of the tree is not
1053
992
        return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1054
993
        # TODO: We could ask all the control formats whether they
1065
1004
    @needs_tree_write_lock
1066
1005
    def extract(self, file_id, format=None):
1067
1006
        """Extract a subtree from this tree.
1068
 
 
 
1007
        
1069
1008
        A new branch will be created, relative to the path for this tree.
1070
1009
        """
1071
1010
        self.flush()
1076
1015
                transport = transport.clone(name)
1077
1016
                transport.ensure_base()
1078
1017
            return transport
1079
 
 
 
1018
            
1080
1019
        sub_path = self.id2path(file_id)
1081
1020
        branch_transport = mkdirs(sub_path)
1082
1021
        if format is None:
1096
1035
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
1097
1036
        if tree_transport.base != branch_transport.base:
1098
1037
            tree_bzrdir = format.initialize_on_transport(tree_transport)
1099
 
            branch.BranchReferenceFormat().initialize(tree_bzrdir,
1100
 
                target_branch=new_branch)
 
1038
            branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1101
1039
        else:
1102
1040
            tree_bzrdir = branch_bzrdir
1103
 
        wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
 
1041
        wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1104
1042
        wt.set_parent_ids(self.get_parent_ids())
1105
1043
        my_inv = self.inventory
1106
 
        child_inv = inventory.Inventory(root_id=None)
 
1044
        child_inv = Inventory(root_id=None)
1107
1045
        new_root = my_inv[file_id]
1108
1046
        my_inv.remove_recursive_id(file_id)
1109
1047
        new_root.parent_id = None
1128
1066
        self._serialize(self._inventory, sio)
1129
1067
        sio.seek(0)
1130
1068
        self._transport.put_file('inventory', sio,
1131
 
            mode=self.bzrdir._get_file_mode())
 
1069
            mode=self._control_files._file_mode)
1132
1070
        self._inventory_is_modified = False
1133
1071
 
1134
1072
    def _kind(self, relpath):
1135
1073
        return osutils.file_kind(self.abspath(relpath))
1136
1074
 
1137
 
    def list_files(self, include_root=False, from_dir=None, recursive=True):
1138
 
        """List all files as (path, class, kind, id, entry).
 
1075
    def list_files(self, include_root=False):
 
1076
        """Recursively list all files as (path, class, kind, id, entry).
1139
1077
 
1140
1078
        Lists, but does not descend into unversioned directories.
 
1079
 
1141
1080
        This does not include files that have been deleted in this
1142
 
        tree. Skips the control directory.
 
1081
        tree.
1143
1082
 
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
 
1083
        Skips the control directory.
1147
1084
        """
1148
1085
        # list_files is an iterator, so @needs_read_lock doesn't work properly
1149
1086
        # with it. So callers should be careful to always read_lock the tree.
1151
1088
            raise errors.ObjectNotLocked(self)
1152
1089
 
1153
1090
        inv = self.inventory
1154
 
        if from_dir is None and include_root is True:
 
1091
        if include_root is True:
1155
1092
            yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1156
1093
        # Convert these into local objects to save lookup times
1157
1094
        pathjoin = osutils.pathjoin
1164
1101
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1165
1102
 
1166
1103
        # 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)
 
1104
        children = os.listdir(self.basedir)
1177
1105
        children.sort()
1178
 
        # jam 20060527 The kernel sized tree seems equivalent whether we
 
1106
        # jam 20060527 The kernel sized tree seems equivalent whether we 
1179
1107
        # use a deque and popleft to keep them sorted, or if we use a plain
1180
1108
        # list and just reverse() them.
1181
1109
        children = collections.deque(children)
1182
 
        stack = [(from_dir_id, u'', from_dir_abspath, children)]
 
1110
        stack = [(inv.root.file_id, u'', self.basedir, children)]
1183
1111
        while stack:
1184
1112
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1185
1113
 
1201
1129
 
1202
1130
                # absolute path
1203
1131
                fap = from_dir_abspath + '/' + f
1204
 
 
 
1132
                
1205
1133
                f_ie = inv.get_child(from_dir_id, f)
1206
1134
                if f_ie:
1207
1135
                    c = 'V'
1239
1167
                    except KeyError:
1240
1168
                        yield fp[1:], c, fk, None, TreeEntry()
1241
1169
                    continue
1242
 
 
 
1170
                
1243
1171
                if fk != 'directory':
1244
1172
                    continue
1245
1173
 
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
 
1174
                # But do this child first
 
1175
                new_children = os.listdir(fap)
 
1176
                new_children.sort()
 
1177
                new_children = collections.deque(new_children)
 
1178
                stack.append((f_ie.file_id, fp, fap, new_children))
 
1179
                # Break out of inner loop,
 
1180
                # so that we start outer loop with child
 
1181
                break
1255
1182
            else:
1256
1183
                # if we finished all children, pop it off the stack
1257
1184
                stack.pop()
1263
1190
        to_dir must exist in the inventory.
1264
1191
 
1265
1192
        If to_dir exists and is a directory, the files are moved into
1266
 
        it, keeping their old names.
 
1193
        it, keeping their old names.  
1267
1194
 
1268
1195
        Note that to_dir is only the last component of the new name;
1269
1196
        this doesn't change the directory.
1435
1362
        inv = self.inventory
1436
1363
        for entry in moved:
1437
1364
            try:
1438
 
                self._move_entry(WorkingTree._RenameEntry(
1439
 
                    entry.to_rel, entry.from_id,
 
1365
                self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1440
1366
                    entry.to_tail, entry.to_parent_id, entry.from_rel,
1441
1367
                    entry.from_tail, entry.from_parent_id,
1442
1368
                    entry.only_change_inv))
1493
1419
        from_tail = splitpath(from_rel)[-1]
1494
1420
        from_id = inv.path2id(from_rel)
1495
1421
        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]
 
1422
            raise errors.BzrRenameFailedError(from_rel,to_rel,
 
1423
                errors.NotVersionedError(path=str(from_rel)))
 
1424
        from_entry = inv[from_id]
1507
1425
        from_parent_id = from_entry.parent_id
1508
1426
        to_dir, to_tail = os.path.split(to_rel)
1509
1427
        to_dir_id = inv.path2id(to_dir)
1555
1473
        These are files in the working directory that are not versioned or
1556
1474
        control files or ignored.
1557
1475
        """
1558
 
        # force the extras method to be fully executed before returning, to
 
1476
        # force the extras method to be fully executed before returning, to 
1559
1477
        # prevent race conditions with the lock
1560
1478
        return iter(
1561
1479
            [subp for subp in self.extras() if not self.is_ignored(subp)])
1571
1489
        :raises: NoSuchId if any fileid is not currently versioned.
1572
1490
        """
1573
1491
        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
1492
            if self._inventory.has_id(file_id):
1578
1493
                self._inventory.remove_recursive_id(file_id)
 
1494
            else:
 
1495
                raise errors.NoSuchId(self, file_id)
1579
1496
        if len(file_ids):
1580
 
            # in the future this should just set a dirty bit to wait for the
 
1497
            # in the future this should just set a dirty bit to wait for the 
1581
1498
            # final unlock. However, until all methods of workingtree start
1582
 
            # with the current in -memory inventory rather than triggering
 
1499
            # with the current in -memory inventory rather than triggering 
1583
1500
            # a read, it is more complex - we need to teach read_inventory
1584
1501
            # to know when to read, and when to not read first... and possibly
1585
1502
            # to save first when the in memory one may be corrupted.
1586
1503
            # so for now, we just only write it if it is indeed dirty.
1587
1504
            # - RBC 20060907
1588
1505
            self._write_inventory(self._inventory)
1589
 
 
 
1506
    
1590
1507
    def _iter_conflicts(self):
1591
1508
        conflicted = set()
1592
1509
        for info in self.list_files():
1600
1517
 
1601
1518
    @needs_write_lock
1602
1519
    def pull(self, source, overwrite=False, stop_revision=None,
1603
 
             change_reporter=None, possible_transports=None, local=False):
 
1520
             change_reporter=None, possible_transports=None):
 
1521
        top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1604
1522
        source.lock_read()
1605
1523
        try:
 
1524
            pp = ProgressPhase("Pull phase", 2, top_pb)
 
1525
            pp.next_phase()
1606
1526
            old_revision_info = self.branch.last_revision_info()
1607
1527
            basis_tree = self.basis_tree()
1608
1528
            count = self.branch.pull(source, overwrite, stop_revision,
1609
 
                                     possible_transports=possible_transports,
1610
 
                                     local=local)
 
1529
                                     possible_transports=possible_transports)
1611
1530
            new_revision_info = self.branch.last_revision_info()
1612
1531
            if new_revision_info != old_revision_info:
 
1532
                pp.next_phase()
1613
1533
                repository = self.branch.repository
 
1534
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
1614
1535
                basis_tree.lock_read()
1615
1536
                try:
1616
1537
                    new_basis_tree = self.branch.basis_tree()
1619
1540
                                new_basis_tree,
1620
1541
                                basis_tree,
1621
1542
                                this_tree=self,
1622
 
                                pb=None,
 
1543
                                pb=pb,
1623
1544
                                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)
 
1545
                    if (basis_tree.inventory.root is None and
 
1546
                        new_basis_tree.inventory.root is not None):
 
1547
                        self.set_root_id(new_basis_tree.get_root_id())
1628
1548
                finally:
 
1549
                    pb.finished()
1629
1550
                    basis_tree.unlock()
1630
1551
                # TODO - dedup parents list with things merged by pull ?
1631
1552
                # reuse the revisiontree we merged against to set the new
1632
1553
                # tree data.
1633
1554
                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
 
1555
                # we have to pull the merge trees out again, because 
 
1556
                # merge_inner has set the ids. - this corner is not yet 
1636
1557
                # layered well enough to prevent double handling.
1637
1558
                # XXX TODO: Fix the double handling: telling the tree about
1638
1559
                # the already known parent data is wasteful.
1644
1565
            return count
1645
1566
        finally:
1646
1567
            source.unlock()
 
1568
            top_pb.finished()
1647
1569
 
1648
1570
    @needs_write_lock
1649
1571
    def put_file_bytes_non_atomic(self, file_id, bytes):
1675
1597
 
1676
1598
            fl = []
1677
1599
            for subf in os.listdir(dirabs):
1678
 
                if self.bzrdir.is_control_filename(subf):
 
1600
                if subf == '.bzr':
1679
1601
                    continue
1680
1602
                if subf not in dir_entry.children:
1681
1603
                    try:
1691
1613
                            fl.append(subf_norm)
1692
1614
                    else:
1693
1615
                        fl.append(subf)
1694
 
 
 
1616
            
1695
1617
            fl.sort()
1696
1618
            for subf in fl:
1697
1619
                subp = pathjoin(path, subf)
1734
1656
        r"""Check whether the filename matches an ignore pattern.
1735
1657
 
1736
1658
        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.
 
1659
        others match against only the last component.
1740
1660
 
1741
1661
        If the file is ignored, returns the pattern which caused it to
1742
1662
        be ignored, otherwise None.  So this can simply be used as a
1743
1663
        boolean if desired."""
1744
1664
        if getattr(self, '_ignoreglobster', None) is None:
1745
 
            self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
 
1665
            self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1746
1666
        return self._ignoreglobster.match(filename)
1747
1667
 
1748
1668
    def kind(self, file_id):
1839
1759
    def _reset_data(self):
1840
1760
        """Reset transient data that cannot be revalidated."""
1841
1761
        self._inventory_is_modified = False
1842
 
        f = self._transport.get('inventory')
1843
 
        try:
1844
 
            result = self._deserialize(f)
1845
 
        finally:
1846
 
            f.close()
 
1762
        result = self._deserialize(self._transport.get('inventory'))
1847
1763
        self._set_inventory(result, dirty=False)
1848
1764
 
1849
1765
    @needs_tree_write_lock
1854
1770
 
1855
1771
    def _change_last_revision(self, new_revision):
1856
1772
        """Template method part of set_last_revision to perform the change.
1857
 
 
 
1773
        
1858
1774
        This is used to allow WorkingTree3 instances to not affect branch
1859
1775
        when their last revision is set.
1860
1776
        """
1873
1789
        path = self._basis_inventory_name()
1874
1790
        sio = StringIO(xml)
1875
1791
        self._transport.put_file(path, sio,
1876
 
            mode=self.bzrdir._get_file_mode())
 
1792
            mode=self._control_files._file_mode)
1877
1793
 
1878
1794
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
1879
1795
        """Create the text that will be saved in basis-inventory"""
1886
1802
        # as commit already has that ready-to-use [while the format is the
1887
1803
        # same, that is].
1888
1804
        try:
1889
 
            # this double handles the inventory - unpack and repack -
 
1805
            # this double handles the inventory - unpack and repack - 
1890
1806
            # but is easier to understand. We can/should put a conditional
1891
1807
            # in here based on whether the inventory is in the latest format
1892
1808
            # - perhaps we should repack all inventories on a repository
1893
1809
            # upgrade ?
1894
1810
            # the fast path is to copy the raw xml from the repository. If the
1895
 
            # xml contains 'revision_id="', then we assume the right
 
1811
            # xml contains 'revision_id="', then we assume the right 
1896
1812
            # revision_id is set. We must check for this full string, because a
1897
1813
            # root node id can legitimately look like 'revision_id' but cannot
1898
1814
            # contain a '"'.
1899
 
            xml = self.branch.repository._get_inventory_xml(new_revision)
 
1815
            xml = self.branch.repository.get_inventory_xml(new_revision)
1900
1816
            firstline = xml.split('\n', 1)[0]
1901
 
            if (not 'revision_id="' in firstline or
 
1817
            if (not 'revision_id="' in firstline or 
1902
1818
                'format="7"' not in firstline):
1903
 
                inv = self.branch.repository._serializer.read_inventory_from_string(
1904
 
                    xml, new_revision)
 
1819
                inv = self.branch.repository.deserialise_inventory(
 
1820
                    new_revision, xml)
1905
1821
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
1906
1822
            self._write_basis_inventory(xml)
1907
1823
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
1911
1827
        """Read the cached basis inventory."""
1912
1828
        path = self._basis_inventory_name()
1913
1829
        return self._transport.get_bytes(path)
1914
 
 
 
1830
        
1915
1831
    @needs_read_lock
1916
1832
    def read_working_inventory(self):
1917
1833
        """Read the working inventory.
1918
 
 
 
1834
        
1919
1835
        :raises errors.InventoryModified: read_working_inventory will fail
1920
1836
            when the current in memory inventory has been modified.
1921
1837
        """
1922
 
        # conceptually this should be an implementation detail of the tree.
 
1838
        # conceptually this should be an implementation detail of the tree. 
1923
1839
        # XXX: Deprecate this.
1924
1840
        # ElementTree does its own conversion from UTF-8, so open in
1925
1841
        # binary.
1926
1842
        if self._inventory_is_modified:
1927
1843
            raise errors.InventoryModified(self)
1928
 
        f = self._transport.get('inventory')
1929
 
        try:
1930
 
            result = self._deserialize(f)
1931
 
        finally:
1932
 
            f.close()
 
1844
        result = self._deserialize(self._transport.get('inventory'))
1933
1845
        self._set_inventory(result, dirty=False)
1934
1846
        return result
1935
1847
 
1950
1862
 
1951
1863
        new_files=set()
1952
1864
        unknown_nested_files=set()
1953
 
        if to_file is None:
1954
 
            to_file = sys.stdout
1955
1865
 
1956
1866
        def recurse_directory_to_add_files(directory):
1957
1867
            # Recurse directory and add all files
2013
1923
                        tree_delta.unversioned.extend((unknown_file,))
2014
1924
                raise errors.BzrRemoveChangedFilesError(tree_delta)
2015
1925
 
2016
 
        # Build inv_delta and delete files where applicable,
 
1926
        # Build inv_delta and delete files where applicaple,
2017
1927
        # do this before any modifications to inventory.
2018
1928
        for f in files:
2019
1929
            fid = self.path2id(f)
2027
1937
                        new_status = 'I'
2028
1938
                    else:
2029
1939
                        new_status = '?'
2030
 
                    # XXX: Really should be a more abstract reporter interface
2031
 
                    kind_ch = osutils.kind_marker(self.kind(fid))
2032
 
                    to_file.write(new_status + '       ' + f + kind_ch + '\n')
 
1940
                    textui.show_status(new_status, self.kind(fid), f,
 
1941
                                       to_file=to_file)
2033
1942
                # Unversion file
2034
1943
                inv_delta.append((f, None, fid, None))
2035
1944
                message = "removed %s" % (f,)
2058
1967
 
2059
1968
    @needs_tree_write_lock
2060
1969
    def revert(self, filenames=None, old_tree=None, backups=True,
2061
 
               pb=None, report_changes=False):
 
1970
               pb=DummyProgress(), report_changes=False):
2062
1971
        from bzrlib.conflicts import resolve
2063
1972
        if filenames == []:
2064
1973
            filenames = None
2077
1986
            if filenames is None and len(self.get_parent_ids()) > 1:
2078
1987
                parent_trees = []
2079
1988
                last_revision = self.last_revision()
2080
 
                if last_revision != _mod_revision.NULL_REVISION:
 
1989
                if last_revision != NULL_REVISION:
2081
1990
                    if basis_tree is None:
2082
1991
                        basis_tree = self.basis_tree()
2083
1992
                        basis_tree.lock_read()
2121
2030
    def set_inventory(self, new_inventory_list):
2122
2031
        from bzrlib.inventory import (Inventory,
2123
2032
                                      InventoryDirectory,
 
2033
                                      InventoryEntry,
2124
2034
                                      InventoryFile,
2125
2035
                                      InventoryLink)
2126
2036
        inv = Inventory(self.get_root_id())
2128
2038
            name = os.path.basename(path)
2129
2039
            if name == "":
2130
2040
                continue
2131
 
            # fixme, there should be a factory function inv,add_??
 
2041
            # fixme, there should be a factory function inv,add_?? 
2132
2042
            if kind == 'directory':
2133
2043
                inv.add(InventoryDirectory(file_id, name, parent))
2134
2044
            elif kind == 'file':
2142
2052
    @needs_tree_write_lock
2143
2053
    def set_root_id(self, file_id):
2144
2054
        """Set the root id for this tree."""
2145
 
        # for compatability
 
2055
        # for compatability 
2146
2056
        if file_id is None:
2147
2057
            raise ValueError(
2148
2058
                'WorkingTree.set_root_id with fileid=None')
2152
2062
    def _set_root_id(self, file_id):
2153
2063
        """Set the root id for this tree, in a format specific manner.
2154
2064
 
2155
 
        :param file_id: The file id to assign to the root. It must not be
 
2065
        :param file_id: The file id to assign to the root. It must not be 
2156
2066
            present in the current inventory or an error will occur. It must
2157
2067
            not be None, but rather a valid file id.
2158
2068
        """
2177
2087
 
2178
2088
    def unlock(self):
2179
2089
        """See Branch.unlock.
2180
 
 
 
2090
        
2181
2091
        WorkingTree locking just uses the Branch locking facilities.
2182
2092
        This is current because all working trees have an embedded branch
2183
2093
        within them. IF in the future, we were to make branch data shareable
2184
 
        between multiple working trees, i.e. via shared storage, then we
 
2094
        between multiple working trees, i.e. via shared storage, then we 
2185
2095
        would probably want to lock both the local tree, and the branch.
2186
2096
        """
2187
2097
        raise NotImplementedError(self.unlock)
2188
2098
 
2189
 
    _marker = object()
2190
 
 
2191
 
    def update(self, change_reporter=None, possible_transports=None,
2192
 
               revision=None, old_tip=_marker):
 
2099
    def update(self, change_reporter=None, possible_transports=None):
2193
2100
        """Update a working tree along its branch.
2194
2101
 
2195
2102
        This will update the branch if its bound too, which means we have
2213
2120
        - Merge current state -> basis tree of the master w.r.t. the old tree
2214
2121
          basis.
2215
2122
        - Do a 'normal' merge of the old branch basis if it is relevant.
2216
 
 
2217
 
        :param revision: The target revision to update to. Must be in the
2218
 
            revision history.
2219
 
        :param old_tip: If branch.update() has already been run, the value it
2220
 
            returned (old tip of the branch or None). _marker is used
2221
 
            otherwise.
2222
2123
        """
2223
2124
        if self.branch.get_bound_location() is not None:
2224
2125
            self.lock_write()
2225
 
            update_branch = (old_tip is self._marker)
 
2126
            update_branch = True
2226
2127
        else:
2227
2128
            self.lock_tree_write()
2228
2129
            update_branch = False
2230
2131
            if update_branch:
2231
2132
                old_tip = self.branch.update(possible_transports)
2232
2133
            else:
2233
 
                if old_tip is self._marker:
2234
 
                    old_tip = None
2235
 
            return self._update_tree(old_tip, change_reporter, revision)
 
2134
                old_tip = None
 
2135
            return self._update_tree(old_tip, change_reporter)
2236
2136
        finally:
2237
2137
            self.unlock()
2238
2138
 
2239
2139
    @needs_tree_write_lock
2240
 
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
 
2140
    def _update_tree(self, old_tip=None, change_reporter=None):
2241
2141
        """Update a tree to the master branch.
2242
2142
 
2243
2143
        :param old_tip: if supplied, the previous tip revision the branch,
2249
2149
        # cant set that until we update the working trees last revision to be
2250
2150
        # one from the new branch, because it will just get absorbed by the
2251
2151
        # parent de-duplication logic.
2252
 
        #
 
2152
        # 
2253
2153
        # We MUST save it even if an error occurs, because otherwise the users
2254
2154
        # local work is unreferenced and will appear to have been lost.
2255
 
        #
2256
 
        nb_conflicts = 0
 
2155
        # 
 
2156
        result = 0
2257
2157
        try:
2258
2158
            last_rev = self.get_parent_ids()[0]
2259
2159
        except IndexError:
2260
2160
            last_rev = _mod_revision.NULL_REVISION
2261
 
        if revision is None:
2262
 
            revision = self.branch.last_revision()
2263
 
 
2264
 
        old_tip = old_tip or _mod_revision.NULL_REVISION
2265
 
 
2266
 
        if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2267
 
            # the branch we are bound to was updated
2268
 
            # merge those changes in first
2269
 
            base_tree  = self.basis_tree()
2270
 
            other_tree = self.branch.repository.revision_tree(old_tip)
2271
 
            nb_conflicts = merge.merge_inner(self.branch, other_tree,
2272
 
                                             base_tree, this_tree=self,
2273
 
                                             change_reporter=change_reporter)
2274
 
            if nb_conflicts:
2275
 
                self.add_parent_tree((old_tip, other_tree))
2276
 
                trace.note('Rerun update after fixing the conflicts.')
2277
 
                return nb_conflicts
2278
 
 
2279
 
        if last_rev != _mod_revision.ensure_null(revision):
2280
 
            # the working tree is up to date with the branch
2281
 
            # we can merge the specified revision from master
2282
 
            to_tree = self.branch.repository.revision_tree(revision)
2283
 
            to_root_id = to_tree.get_root_id()
2284
 
 
 
2161
        if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
 
2162
            # merge tree state up to new branch tip.
2285
2163
            basis = self.basis_tree()
2286
2164
            basis.lock_read()
2287
2165
            try:
2288
 
                if (basis.inventory.root is None
2289
 
                    or basis.inventory.root.file_id != to_root_id):
2290
 
                    self.set_root_id(to_root_id)
 
2166
                to_tree = self.branch.basis_tree()
 
2167
                if basis.inventory.root is None:
 
2168
                    self.set_root_id(to_tree.get_root_id())
2291
2169
                    self.flush()
 
2170
                result += merge.merge_inner(
 
2171
                                      self.branch,
 
2172
                                      to_tree,
 
2173
                                      basis,
 
2174
                                      this_tree=self,
 
2175
                                      change_reporter=change_reporter)
2292
2176
            finally:
2293
2177
                basis.unlock()
2294
 
 
2295
 
            # determine the branch point
2296
 
            graph = self.branch.repository.get_graph()
2297
 
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2298
 
                                                last_rev)
2299
 
            base_tree = self.branch.repository.revision_tree(base_rev_id)
2300
 
 
2301
 
            nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2302
 
                                             this_tree=self,
2303
 
                                             change_reporter=change_reporter)
2304
 
            self.set_last_revision(revision)
2305
2178
            # TODO - dedup parents list with things merged by pull ?
2306
2179
            # reuse the tree we've updated to to set the basis:
2307
 
            parent_trees = [(revision, to_tree)]
 
2180
            parent_trees = [(self.branch.last_revision(), to_tree)]
2308
2181
            merges = self.get_parent_ids()[1:]
2309
2182
            # Ideally we ask the tree for the trees here, that way the working
2310
 
            # tree can decide whether to give us the entire tree or give us a
 
2183
            # tree can decide whether to give us teh entire tree or give us a
2311
2184
            # lazy initialised tree. dirstate for instance will have the trees
2312
2185
            # in ram already, whereas a last-revision + basis-inventory tree
2313
2186
            # will not, but also does not need them when setting parents.
2314
2187
            for parent in merges:
2315
2188
                parent_trees.append(
2316
2189
                    (parent, self.branch.repository.revision_tree(parent)))
2317
 
            if not _mod_revision.is_null(old_tip):
 
2190
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2318
2191
                parent_trees.append(
2319
2192
                    (old_tip, self.branch.repository.revision_tree(old_tip)))
2320
2193
            self.set_parent_trees(parent_trees)
2321
2194
            last_rev = parent_trees[0][0]
2322
 
        return nb_conflicts
 
2195
        else:
 
2196
            # the working tree had the same last-revision as the master
 
2197
            # branch did. We may still have pivot local work from the local
 
2198
            # branch into old_tip:
 
2199
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
 
2200
                self.add_parent_tree_id(old_tip)
 
2201
        if (old_tip is not None and not _mod_revision.is_null(old_tip)
 
2202
            and old_tip != last_rev):
 
2203
            # our last revision was not the prior branch last revision
 
2204
            # and we have converted that last revision to a pending merge.
 
2205
            # base is somewhere between the branch tip now
 
2206
            # and the now pending merge
 
2207
 
 
2208
            # Since we just modified the working tree and inventory, flush out
 
2209
            # the current state, before we modify it again.
 
2210
            # TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
 
2211
            #       requires it only because TreeTransform directly munges the
 
2212
            #       inventory and calls tree._write_inventory(). Ultimately we
 
2213
            #       should be able to remove this extra flush.
 
2214
            self.flush()
 
2215
            graph = self.branch.repository.get_graph()
 
2216
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
 
2217
                                                old_tip)
 
2218
            base_tree = self.branch.repository.revision_tree(base_rev_id)
 
2219
            other_tree = self.branch.repository.revision_tree(old_tip)
 
2220
            result += merge.merge_inner(
 
2221
                                  self.branch,
 
2222
                                  other_tree,
 
2223
                                  base_tree,
 
2224
                                  this_tree=self,
 
2225
                                  change_reporter=change_reporter)
 
2226
        return result
2323
2227
 
2324
2228
    def _write_hashcache_if_dirty(self):
2325
2229
        """Write out the hashcache if it is dirty."""
2425
2329
                    bzrdir_loc = bisect_left(cur_disk_dir_content,
2426
2330
                        ('.bzr', '.bzr'))
2427
2331
                    if (bzrdir_loc < len(cur_disk_dir_content)
2428
 
                        and self.bzrdir.is_control_filename(
2429
 
                            cur_disk_dir_content[bzrdir_loc][0])):
 
2332
                        and cur_disk_dir_content[bzrdir_loc][0] == '.bzr'):
2430
2333
                        # we dont yield the contents of, or, .bzr itself.
2431
2334
                        del cur_disk_dir_content[bzrdir_loc]
2432
2335
            if inv_finished:
2566
2469
        return un_resolved, resolved
2567
2470
 
2568
2471
    @needs_read_lock
2569
 
    def _check(self, references):
2570
 
        """Check the tree for consistency.
2571
 
 
2572
 
        :param references: A dict with keys matching the items returned by
2573
 
            self._get_check_refs(), and values from looking those keys up in
2574
 
            the repository.
2575
 
        """
 
2472
    def _check(self):
2576
2473
        tree_basis = self.basis_tree()
2577
2474
        tree_basis.lock_read()
2578
2475
        try:
2579
 
            repo_basis = references[('trees', self.last_revision())]
 
2476
            repo_basis = self.branch.repository.revision_tree(
 
2477
                self.last_revision())
2580
2478
            if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2581
2479
                raise errors.BzrCheckError(
2582
2480
                    "Mismatched basis inventory content.")
2595
2493
        """
2596
2494
        return
2597
2495
 
 
2496
    @needs_read_lock
2598
2497
    def _get_rules_searcher(self, default_searcher):
2599
2498
        """See Tree._get_rules_searcher."""
2600
2499
        if self._rules_searcher is None:
2602
2501
                self)._get_rules_searcher(default_searcher)
2603
2502
        return self._rules_searcher
2604
2503
 
2605
 
    def get_shelf_manager(self):
2606
 
        """Return the ShelfManager for this WorkingTree."""
2607
 
        from bzrlib.shelf import ShelfManager
2608
 
        return ShelfManager(self, self._transport)
2609
 
 
2610
2504
 
2611
2505
class WorkingTree2(WorkingTree):
2612
2506
    """This is the Format 2 working tree.
2613
2507
 
2614
 
    This was the first weave based working tree.
 
2508
    This was the first weave based working tree. 
2615
2509
     - uses os locks for locking.
2616
2510
     - uses the branch last-revision.
2617
2511
    """
2627
2521
        if self._inventory is None:
2628
2522
            self.read_working_inventory()
2629
2523
 
2630
 
    def _get_check_refs(self):
2631
 
        """Return the references needed to perform a check of this tree."""
2632
 
        return [('trees', self.last_revision())]
2633
 
 
2634
2524
    def lock_tree_write(self):
2635
2525
        """See WorkingTree.lock_tree_write().
2636
2526
 
2654
2544
            if self._inventory_is_modified:
2655
2545
                self.flush()
2656
2546
            self._write_hashcache_if_dirty()
2657
 
 
 
2547
                    
2658
2548
        # reverse order of locking.
2659
2549
        try:
2660
2550
            return self._control_files.unlock()
2682
2572
 
2683
2573
    def _change_last_revision(self, revision_id):
2684
2574
        """See WorkingTree._change_last_revision."""
2685
 
        if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
 
2575
        if revision_id is None or revision_id == NULL_REVISION:
2686
2576
            try:
2687
2577
                self._transport.delete('last-revision')
2688
2578
            except errors.NoSuchFile:
2690
2580
            return False
2691
2581
        else:
2692
2582
            self._transport.put_bytes('last-revision', revision_id,
2693
 
                mode=self.bzrdir._get_file_mode())
 
2583
                mode=self._control_files._file_mode)
2694
2584
            return True
2695
2585
 
2696
 
    def _get_check_refs(self):
2697
 
        """Return the references needed to perform a check of this tree."""
2698
 
        return [('trees', self.last_revision())]
2699
 
 
2700
2586
    @needs_tree_write_lock
2701
2587
    def set_conflicts(self, conflicts):
2702
 
        self._put_rio('conflicts', conflicts.to_stanzas(),
 
2588
        self._put_rio('conflicts', conflicts.to_stanzas(), 
2703
2589
                      CONFLICT_HEADER_1)
2704
2590
 
2705
2591
    @needs_tree_write_lock
2754
2640
     * a format string,
2755
2641
     * an open routine.
2756
2642
 
2757
 
    Formats are placed in an dict by their format string for reference
 
2643
    Formats are placed in an dict by their format string for reference 
2758
2644
    during workingtree opening. Its not required that these be instances, they
2759
 
    can be classes themselves with class methods - it simply depends on
 
2645
    can be classes themselves with class methods - it simply depends on 
2760
2646
    whether state is needed for a given format or not.
2761
2647
 
2762
2648
    Once a format is deprecated, just deprecate the initialize and open
2763
 
    methods on the format class. Do not deprecate the object, as the
 
2649
    methods on the format class. Do not deprecate the object, as the 
2764
2650
    object will be created every time regardless.
2765
2651
    """
2766
2652
 
2779
2665
        """Return the format for the working tree object in a_bzrdir."""
2780
2666
        try:
2781
2667
            transport = a_bzrdir.get_workingtree_transport(None)
2782
 
            format_string = transport.get_bytes("format")
 
2668
            format_string = transport.get("format").read()
2783
2669
            return klass._formats[format_string]
2784
2670
        except errors.NoSuchFile:
2785
2671
            raise errors.NoWorkingTree(base=transport.base)
2810
2696
        """Is this format supported?
2811
2697
 
2812
2698
        Supported formats can be initialized and opened.
2813
 
        Unsupported formats may not support initialization or committing or
 
2699
        Unsupported formats may not support initialization or committing or 
2814
2700
        some other features depending on the reason for not being supported.
2815
2701
        """
2816
2702
        return True
2817
2703
 
2818
 
    def supports_content_filtering(self):
2819
 
        """True if this format supports content filtering."""
2820
 
        return False
2821
 
 
2822
 
    def supports_views(self):
2823
 
        """True if this format supports stored views."""
2824
 
        return False
2825
 
 
2826
2704
    @classmethod
2827
2705
    def register_format(klass, format):
2828
2706
        klass._formats[format.get_format_string()] = format
2837
2715
 
2838
2716
 
2839
2717
class WorkingTreeFormat2(WorkingTreeFormat):
2840
 
    """The second working tree format.
 
2718
    """The second working tree format. 
2841
2719
 
2842
2720
    This format modified the hash cache from the format 1 hash cache.
2843
2721
    """
2856
2734
        no working tree.  (See bug #43064).
2857
2735
        """
2858
2736
        sio = StringIO()
2859
 
        inv = inventory.Inventory()
 
2737
        inv = Inventory()
2860
2738
        xml5.serializer_v5.write_inventory(inv, sio, working=True)
2861
2739
        sio.seek(0)
2862
2740
        transport.put_file('inventory', sio, file_mode)
2878
2756
            branch.generate_revision_history(revision_id)
2879
2757
        finally:
2880
2758
            branch.unlock()
2881
 
        inv = inventory.Inventory()
 
2759
        inv = Inventory()
2882
2760
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2883
2761
                         branch,
2884
2762
                         inv,
2929
2807
        - is new in bzr 0.8
2930
2808
        - uses a LockDir to guard access for writes.
2931
2809
    """
2932
 
 
 
2810
    
2933
2811
    upgrade_recommended = True
2934
2812
 
2935
2813
    def get_format_string(self):
2952
2830
 
2953
2831
    def _open_control_files(self, a_bzrdir):
2954
2832
        transport = a_bzrdir.get_workingtree_transport(None)
2955
 
        return LockableFiles(transport, self._lock_file_name,
 
2833
        return LockableFiles(transport, self._lock_file_name, 
2956
2834
                             self._lock_class)
2957
2835
 
2958
2836
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2959
2837
                   accelerator_tree=None, hardlink=False):
2960
2838
        """See WorkingTreeFormat.initialize().
2961
 
 
 
2839
        
2962
2840
        :param revision_id: if supplied, create a working tree at a different
2963
2841
            revision than the branch is at.
2964
2842
        :param accelerator_tree: A tree which can be used for retrieving file
2975
2853
        control_files.create_lock()
2976
2854
        control_files.lock_write()
2977
2855
        transport.put_bytes('format', self.get_format_string(),
2978
 
            mode=a_bzrdir._get_file_mode())
 
2856
            mode=control_files._file_mode)
2979
2857
        if from_branch is not None:
2980
2858
            branch = from_branch
2981
2859
        else:
3001
2879
            # only set an explicit root id if there is one to set.
3002
2880
            if basis_tree.inventory.root is not None:
3003
2881
                wt.set_root_id(basis_tree.get_root_id())
3004
 
            if revision_id == _mod_revision.NULL_REVISION:
 
2882
            if revision_id == NULL_REVISION:
3005
2883
                wt.set_parent_trees([])
3006
2884
            else:
3007
2885
                wt.set_parent_trees([(revision_id, basis_tree)])
3014
2892
        return wt
3015
2893
 
3016
2894
    def _initial_inventory(self):
3017
 
        return inventory.Inventory()
 
2895
        return Inventory()
3018
2896
 
3019
2897
    def __init__(self):
3020
2898
        super(WorkingTreeFormat3, self).__init__()
3035
2913
 
3036
2914
    def _open(self, a_bzrdir, control_files):
3037
2915
        """Open the tree itself.
3038
 
 
 
2916
        
3039
2917
        :param a_bzrdir: the dir for the tree.
3040
2918
        :param control_files: the control files for the tree.
3041
2919
        """
3049
2927
        return self.get_format_string()
3050
2928
 
3051
2929
 
3052
 
__default_format = WorkingTreeFormat6()
 
2930
__default_format = WorkingTreeFormat4()
3053
2931
WorkingTreeFormat.register_format(__default_format)
3054
 
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3055
 
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3056
2932
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3057
2933
WorkingTreeFormat.set_default_format(__default_format)
3058
2934
# formats which have no format string are not discoverable