← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Martin Pool
  • Date: 2009-01-13 03:11:04 UTC
  • mto: This revision was merged to the branch mainline in revision 3937.
  • Revision ID: mbp@sourcefrog.net-20090113031104-03my054s02i9l2pe
Bump version to 1.12 and add news template

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/workingtree.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""WorkingTree object and friends.
18
18
 
19
19
A WorkingTree represents the editable working copy of a branch.
20
 
Operations which represent the WorkingTree are also done here,
21
 
such as renaming or adding files.  The WorkingTree has an inventory
22
 
which is updated by these operations.  A commit produces a
 
20
Operations which represent the WorkingTree are also done here, 
 
21
such as renaming or adding files.  The WorkingTree has an inventory 
 
22
which is updated by these operations.  A commit produces a 
23
23
new revision based on the workingtree and its inventory.
24
24
 
25
25
At the moment every WorkingTree has its own branch.  Remote
29
29
WorkingTree.open(dir).
30
30
"""
31
31
 
 
32
# TODO: Give the workingtree sole responsibility for the working inventory;
 
33
# remove the variable and references to it from the branch.  This may require
 
34
# updating the commit code so as to update the inventory within the working
 
35
# copy, and making sure there's only one WorkingTree for any directory on disk.
 
36
# At the moment they may alias the inventory and have old copies of it in
 
37
# memory.  (Now done? -- mbp 20060309)
32
38
 
33
39
from cStringIO import StringIO
34
40
import os
42
48
import itertools
43
49
import operator
44
50
import stat
 
51
from time import time
 
52
import warnings
45
53
import re
46
54
 
47
55
import bzrlib
49
57
    branch,
50
58
    bzrdir,
51
59
    conflicts as _mod_conflicts,
 
60
    dirstate,
52
61
    errors,
53
62
    generate_ids,
54
63
    globbing,
55
 
    graph as _mod_graph,
56
64
    hashcache,
57
65
    ignores,
58
 
    inventory,
59
66
    merge,
60
67
    revision as _mod_revision,
61
68
    revisiontree,
 
69
    repository,
 
70
    textui,
62
71
    trace,
63
72
    transform,
64
73
    ui,
65
 
    views,
 
74
    urlutils,
66
75
    xml5,
 
76
    xml6,
67
77
    xml7,
68
78
    )
69
79
import bzrlib.branch
70
80
from bzrlib.transport import get_transport
71
 
from bzrlib.workingtree_4 import (
72
 
    WorkingTreeFormat4,
73
 
    WorkingTreeFormat5,
74
 
    WorkingTreeFormat6,
75
 
    )
 
81
import bzrlib.ui
 
82
from bzrlib.workingtree_4 import WorkingTreeFormat4, WorkingTreeFormat5
76
83
""")
77
84
 
78
85
from bzrlib import symbol_versioning
79
86
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
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,
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
 
305
288
        return self._format.supports_content_filtering()
306
289
 
307
290
    def supports_views(self):
308
 
        return self.views.supports_views()
 
291
        return self._format.supports_views()
309
292
 
310
293
    def _set_inventory(self, inv, dirty):
311
294
        """Set the internal cached inventory.
400
383
 
401
384
    def basis_tree(self):
402
385
        """Return RevisionTree for the current last revision.
403
 
 
 
386
        
404
387
        If the left most parent is a ghost then the returned tree will be an
405
 
        empty tree - one obtained by calling
 
388
        empty tree - one obtained by calling 
406
389
        repository.revision_tree(NULL_REVISION).
407
390
        """
408
391
        try:
424
407
            return self.branch.repository.revision_tree(revision_id)
425
408
        except (errors.RevisionNotPresent, errors.NoSuchRevision):
426
409
            # 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
 
410
            # occured. If the revision is present, its a problem, if its not
428
411
            # its a ghost.
429
412
            if self.branch.repository.has_revision(revision_id):
430
413
                raise
437
420
 
438
421
    def relpath(self, path):
439
422
        """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
 
423
        
 
424
        The path may be absolute or relative. If its a relative path it is 
442
425
        interpreted relative to the python current working directory.
443
426
        """
444
427
        return osutils.relpath(self.basedir, path)
446
429
    def has_filename(self, filename):
447
430
        return osutils.lexists(self.abspath(filename))
448
431
 
449
 
    def get_file(self, file_id, path=None, filtered=True):
450
 
        return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
 
432
    def get_file(self, file_id, path=None):
 
433
        return self.get_file_with_stat(file_id, path)[0]
451
434
 
452
 
    def get_file_with_stat(self, file_id, path=None, filtered=True,
453
 
        _fstat=os.fstat):
454
 
        """See Tree.get_file_with_stat."""
 
435
    def get_file_with_stat(self, file_id, path=None, _fstat=os.fstat):
 
436
        """See MutableTree.get_file_with_stat."""
455
437
        if path is None:
456
438
            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):
 
439
        file_obj = self.get_file_byname(path)
 
440
        return (file_obj, _fstat(file_obj.fileno()))
 
441
 
 
442
    def get_file_byname(self, filename):
 
443
        return file(self.abspath(filename), 'rb')
 
444
 
 
445
    def get_file_lines(self, file_id, path=None):
477
446
        """See Tree.get_file_lines()"""
478
 
        file = self.get_file(file_id, path, filtered=filtered)
 
447
        file = self.get_file(file_id, path)
479
448
        try:
480
449
            return file.readlines()
481
450
        finally:
492
461
        incorrectly attributed to CURRENT_REVISION (but after committing, the
493
462
        attribution will be correct).
494
463
        """
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
 
464
        basis = self.basis_tree()
 
465
        basis.lock_read()
 
466
        try:
 
467
            changes = self.iter_changes(basis, True, [self.id2path(file_id)],
 
468
                require_versioned=True).next()
 
469
            changed_content, kind = changes[2], changes[6]
 
470
            if not changed_content:
 
471
                return basis.annotate_iter(file_id)
 
472
            if kind[1] is None:
 
473
                return None
 
474
            import annotate
 
475
            if kind[0] != 'file':
 
476
                old_lines = []
 
477
            else:
 
478
                old_lines = list(basis.annotate_iter(file_id))
 
479
            old = [old_lines]
 
480
            for tree in self.branch.repository.revision_trees(
 
481
                self.get_parent_ids()[1:]):
 
482
                if file_id not in tree:
 
483
                    continue
 
484
                old.append(list(tree.annotate_iter(file_id)))
 
485
            return annotate.reannotate(old, self.get_file(file_id).readlines(),
 
486
                                       default_revision)
 
487
        finally:
 
488
            basis.unlock()
531
489
 
532
490
    def _get_ancestors(self, default_revision):
533
491
        ancestors = set([default_revision])
538
496
 
539
497
    def get_parent_ids(self):
540
498
        """See Tree.get_parent_ids.
541
 
 
 
499
        
542
500
        This implementation reads the pending merges list and last_revision
543
501
        value and uses that to decide what the parents list should be.
544
502
        """
548
506
        else:
549
507
            parents = [last_rev]
550
508
        try:
551
 
            merges_bytes = self._transport.get_bytes('pending-merges')
 
509
            merges_file = self._transport.get('pending-merges')
552
510
        except errors.NoSuchFile:
553
511
            pass
554
512
        else:
555
 
            for l in osutils.split_lines(merges_bytes):
 
513
            for l in merges_file.readlines():
556
514
                revision_id = l.rstrip('\n')
557
515
                parents.append(revision_id)
558
516
        return parents
561
519
    def get_root_id(self):
562
520
        """Return the id of this trees root"""
563
521
        return self._inventory.root.file_id
564
 
 
 
522
        
565
523
    def _get_store_filename(self, file_id):
566
524
        ## XXX: badly named; this is not in the store at all
567
525
        return self.abspath(self.id2path(file_id))
569
527
    @needs_read_lock
570
528
    def clone(self, to_bzrdir, revision_id=None):
571
529
        """Duplicate this working tree into to_bzr, including all state.
572
 
 
 
530
        
573
531
        Specifically modified files are kept as modified, but
574
532
        ignored and unknown files are discarded.
575
533
 
576
534
        If you want to make a new line of development, see bzrdir.sprout()
577
535
 
578
536
        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
 
537
            If not None, the cloned tree will have its last revision set to 
 
538
            revision, and and difference between the source trees last revision
581
539
            and this one merged in.
582
540
        """
583
541
        # assumes the target bzr dir format is compatible.
617
575
 
618
576
    def get_file_size(self, file_id):
619
577
        """See Tree.get_file_size"""
620
 
        # XXX: this returns the on-disk size; it should probably return the
621
 
        # canonical size
622
578
        try:
623
579
            return os.path.getsize(self.id2abspath(file_id))
624
580
        except OSError, e:
640
596
 
641
597
    def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
642
598
        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
599
        return self._inventory[file_id].executable
648
600
 
649
601
    def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
671
623
        """See MutableTree._add."""
672
624
        # TODO: Re-adding a file that is removed in the working copy
673
625
        # should probably put it back with the previous ID.
674
 
        # the read and write working inventory should not occur in this
 
626
        # the read and write working inventory should not occur in this 
675
627
        # function - they should be part of lock_write and unlock.
676
628
        inv = self.inventory
677
629
        for f, file_id, kind in zip(files, ids, kinds):
759
711
            raise
760
712
        kind = _mapper(stat_result.st_mode)
761
713
        if kind == 'file':
762
 
            return self._file_content_summary(path, stat_result)
 
714
            size = stat_result.st_size
 
715
            # try for a stat cache lookup
 
716
            executable = self._is_executable_from_path_and_stat(path, stat_result)
 
717
            return (kind, size, executable, self._sha_from_stat(
 
718
                path, stat_result))
763
719
        elif kind == 'directory':
764
720
            # perhaps it looks like a plain directory, but it's really a
765
721
            # reference.
767
723
                kind = 'tree-reference'
768
724
            return kind, None, None, None
769
725
        elif kind == 'symlink':
770
 
            target = osutils.readlink(abspath)
771
 
            return ('symlink', None, None, target)
 
726
            return ('symlink', None, None, os.readlink(abspath))
772
727
        else:
773
728
            return (kind, None, None, None)
774
729
 
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
730
    def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
783
731
        """Common ghost checking functionality from set_parent_*.
784
732
 
794
742
    def _set_merges_from_parent_ids(self, parent_ids):
795
743
        merges = parent_ids[1:]
796
744
        self._transport.put_bytes('pending-merges', '\n'.join(merges),
797
 
            mode=self.bzrdir._get_file_mode())
 
745
            mode=self._control_files._file_mode)
798
746
 
799
747
    def _filter_parent_ids_by_ancestry(self, revision_ids):
800
748
        """Check that all merged revisions are proper 'heads'.
801
749
 
802
750
        This will always return the first revision_id, and any merged revisions
803
 
        which are
 
751
        which are 
804
752
        """
805
753
        if len(revision_ids) == 0:
806
754
            return revision_ids
818
766
    @needs_tree_write_lock
819
767
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
820
768
        """Set the parent ids to revision_ids.
821
 
 
 
769
        
822
770
        See also set_parent_trees. This api will try to retrieve the tree data
823
771
        for each element of revision_ids from the trees repository. If you have
824
772
        tree data already available, it is more efficient to use
900
848
        self._must_be_locked()
901
849
        my_file = rio_file(stanzas, header)
902
850
        self._transport.put_file(filename, my_file,
903
 
            mode=self.bzrdir._get_file_mode())
 
851
            mode=self._control_files._file_mode)
904
852
 
905
853
    @needs_write_lock # because merge pulls data into the branch.
906
854
    def merge_from_branch(self, branch, to_revision=None, from_revision=None,
907
 
                          merge_type=None, force=False):
 
855
        merge_type=None):
908
856
        """Merge from a branch into this working tree.
909
857
 
910
858
        :param branch: The branch to merge from.
914
862
            branch.last_revision().
915
863
        """
916
864
        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()
 
865
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
866
        try:
 
867
            merger = Merger(self.branch, this_tree=self, pb=pb)
 
868
            merger.pp = ProgressPhase("Merge phase", 5, pb)
 
869
            merger.pp.next_phase()
 
870
            # check that there are no
 
871
            # local alterations
 
872
            merger.check_basis(check_clean=True, require_commits=False)
 
873
            if to_revision is None:
 
874
                to_revision = _mod_revision.ensure_null(branch.last_revision())
 
875
            merger.other_rev_id = to_revision
 
876
            if _mod_revision.is_null(merger.other_rev_id):
 
877
                raise errors.NoCommits(branch)
 
878
            self.branch.fetch(branch, last_revision=merger.other_rev_id)
 
879
            merger.other_basis = merger.other_rev_id
 
880
            merger.other_tree = self.branch.repository.revision_tree(
 
881
                merger.other_rev_id)
 
882
            merger.other_branch = branch
 
883
            merger.pp.next_phase()
 
884
            if from_revision is None:
 
885
                merger.find_base()
 
886
            else:
 
887
                merger.set_base_revision(from_revision, branch)
 
888
            if merger.base_rev_id == merger.other_rev_id:
 
889
                raise errors.PointlessMerge
 
890
            merger.backup_files = False
 
891
            if merge_type is None:
 
892
                merger.merge_type = Merge3Merger
 
893
            else:
 
894
                merger.merge_type = merge_type
 
895
            merger.set_interesting_files(None)
 
896
            merger.show_base = False
 
897
            merger.reprocess = False
 
898
            conflicts = merger.do_merge()
 
899
            merger.set_pending()
 
900
        finally:
 
901
            pb.finished()
947
902
        return conflicts
948
903
 
949
904
    @needs_read_lock
950
905
    def merge_modified(self):
951
906
        """Return a dictionary of files modified by a merge.
952
907
 
953
 
        The list is initialized by WorkingTree.set_merge_modified, which is
 
908
        The list is initialized by WorkingTree.set_merge_modified, which is 
954
909
        typically called after we make some automatic updates to the tree
955
910
        because of a merge.
956
911
 
990
945
        return file_id
991
946
 
992
947
    def get_symlink_target(self, file_id):
993
 
        abspath = self.id2abspath(file_id)
994
 
        target = osutils.readlink(abspath)
995
 
        return target
 
948
        return os.readlink(self.id2abspath(file_id))
996
949
 
997
950
    @needs_write_lock
998
951
    def subsume(self, other_tree):
1048
1001
        return False
1049
1002
 
1050
1003
    def _directory_may_be_tree_reference(self, relpath):
1051
 
        # as a special case, if a directory contains control files then
 
1004
        # as a special case, if a directory contains control files then 
1052
1005
        # it's a tree reference, except that the root of the tree is not
1053
1006
        return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1054
1007
        # TODO: We could ask all the control formats whether they
1065
1018
    @needs_tree_write_lock
1066
1019
    def extract(self, file_id, format=None):
1067
1020
        """Extract a subtree from this tree.
1068
 
 
 
1021
        
1069
1022
        A new branch will be created, relative to the path for this tree.
1070
1023
        """
1071
1024
        self.flush()
1076
1029
                transport = transport.clone(name)
1077
1030
                transport.ensure_base()
1078
1031
            return transport
1079
 
 
 
1032
            
1080
1033
        sub_path = self.id2path(file_id)
1081
1034
        branch_transport = mkdirs(sub_path)
1082
1035
        if format is None:
1096
1049
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
1097
1050
        if tree_transport.base != branch_transport.base:
1098
1051
            tree_bzrdir = format.initialize_on_transport(tree_transport)
1099
 
            branch.BranchReferenceFormat().initialize(tree_bzrdir,
1100
 
                target_branch=new_branch)
 
1052
            branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1101
1053
        else:
1102
1054
            tree_bzrdir = branch_bzrdir
1103
 
        wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
 
1055
        wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1104
1056
        wt.set_parent_ids(self.get_parent_ids())
1105
1057
        my_inv = self.inventory
1106
 
        child_inv = inventory.Inventory(root_id=None)
 
1058
        child_inv = Inventory(root_id=None)
1107
1059
        new_root = my_inv[file_id]
1108
1060
        my_inv.remove_recursive_id(file_id)
1109
1061
        new_root.parent_id = None
1128
1080
        self._serialize(self._inventory, sio)
1129
1081
        sio.seek(0)
1130
1082
        self._transport.put_file('inventory', sio,
1131
 
            mode=self.bzrdir._get_file_mode())
 
1083
            mode=self._control_files._file_mode)
1132
1084
        self._inventory_is_modified = False
1133
1085
 
1134
1086
    def _kind(self, relpath):
1135
1087
        return osutils.file_kind(self.abspath(relpath))
1136
1088
 
1137
 
    def list_files(self, include_root=False, from_dir=None, recursive=True):
1138
 
        """List all files as (path, class, kind, id, entry).
 
1089
    def list_files(self, include_root=False):
 
1090
        """Recursively list all files as (path, class, kind, id, entry).
1139
1091
 
1140
1092
        Lists, but does not descend into unversioned directories.
 
1093
 
1141
1094
        This does not include files that have been deleted in this
1142
 
        tree. Skips the control directory.
 
1095
        tree.
1143
1096
 
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
 
1097
        Skips the control directory.
1147
1098
        """
1148
1099
        # list_files is an iterator, so @needs_read_lock doesn't work properly
1149
1100
        # with it. So callers should be careful to always read_lock the tree.
1151
1102
            raise errors.ObjectNotLocked(self)
1152
1103
 
1153
1104
        inv = self.inventory
1154
 
        if from_dir is None and include_root is True:
 
1105
        if include_root is True:
1155
1106
            yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1156
1107
        # Convert these into local objects to save lookup times
1157
1108
        pathjoin = osutils.pathjoin
1164
1115
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1165
1116
 
1166
1117
        # 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)
 
1118
        children = os.listdir(self.basedir)
1177
1119
        children.sort()
1178
 
        # jam 20060527 The kernel sized tree seems equivalent whether we
 
1120
        # jam 20060527 The kernel sized tree seems equivalent whether we 
1179
1121
        # use a deque and popleft to keep them sorted, or if we use a plain
1180
1122
        # list and just reverse() them.
1181
1123
        children = collections.deque(children)
1182
 
        stack = [(from_dir_id, u'', from_dir_abspath, children)]
 
1124
        stack = [(inv.root.file_id, u'', self.basedir, children)]
1183
1125
        while stack:
1184
1126
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1185
1127
 
1201
1143
 
1202
1144
                # absolute path
1203
1145
                fap = from_dir_abspath + '/' + f
1204
 
 
 
1146
                
1205
1147
                f_ie = inv.get_child(from_dir_id, f)
1206
1148
                if f_ie:
1207
1149
                    c = 'V'
1239
1181
                    except KeyError:
1240
1182
                        yield fp[1:], c, fk, None, TreeEntry()
1241
1183
                    continue
1242
 
 
 
1184
                
1243
1185
                if fk != 'directory':
1244
1186
                    continue
1245
1187
 
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
 
1188
                # But do this child first
 
1189
                new_children = os.listdir(fap)
 
1190
                new_children.sort()
 
1191
                new_children = collections.deque(new_children)
 
1192
                stack.append((f_ie.file_id, fp, fap, new_children))
 
1193
                # Break out of inner loop,
 
1194
                # so that we start outer loop with child
 
1195
                break
1255
1196
            else:
1256
1197
                # if we finished all children, pop it off the stack
1257
1198
                stack.pop()
1263
1204
        to_dir must exist in the inventory.
1264
1205
 
1265
1206
        If to_dir exists and is a directory, the files are moved into
1266
 
        it, keeping their old names.
 
1207
        it, keeping their old names.  
1267
1208
 
1268
1209
        Note that to_dir is only the last component of the new name;
1269
1210
        this doesn't change the directory.
1435
1376
        inv = self.inventory
1436
1377
        for entry in moved:
1437
1378
            try:
1438
 
                self._move_entry(WorkingTree._RenameEntry(
1439
 
                    entry.to_rel, entry.from_id,
 
1379
                self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1440
1380
                    entry.to_tail, entry.to_parent_id, entry.from_rel,
1441
1381
                    entry.from_tail, entry.from_parent_id,
1442
1382
                    entry.only_change_inv))
1493
1433
        from_tail = splitpath(from_rel)[-1]
1494
1434
        from_id = inv.path2id(from_rel)
1495
1435
        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]
 
1436
            raise errors.BzrRenameFailedError(from_rel,to_rel,
 
1437
                errors.NotVersionedError(path=str(from_rel)))
 
1438
        from_entry = inv[from_id]
1507
1439
        from_parent_id = from_entry.parent_id
1508
1440
        to_dir, to_tail = os.path.split(to_rel)
1509
1441
        to_dir_id = inv.path2id(to_dir)
1555
1487
        These are files in the working directory that are not versioned or
1556
1488
        control files or ignored.
1557
1489
        """
1558
 
        # force the extras method to be fully executed before returning, to
 
1490
        # force the extras method to be fully executed before returning, to 
1559
1491
        # prevent race conditions with the lock
1560
1492
        return iter(
1561
1493
            [subp for subp in self.extras() if not self.is_ignored(subp)])
1571
1503
        :raises: NoSuchId if any fileid is not currently versioned.
1572
1504
        """
1573
1505
        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
1506
            if self._inventory.has_id(file_id):
1578
1507
                self._inventory.remove_recursive_id(file_id)
 
1508
            else:
 
1509
                raise errors.NoSuchId(self, file_id)
1579
1510
        if len(file_ids):
1580
 
            # in the future this should just set a dirty bit to wait for the
 
1511
            # in the future this should just set a dirty bit to wait for the 
1581
1512
            # final unlock. However, until all methods of workingtree start
1582
 
            # with the current in -memory inventory rather than triggering
 
1513
            # with the current in -memory inventory rather than triggering 
1583
1514
            # a read, it is more complex - we need to teach read_inventory
1584
1515
            # to know when to read, and when to not read first... and possibly
1585
1516
            # to save first when the in memory one may be corrupted.
1586
1517
            # so for now, we just only write it if it is indeed dirty.
1587
1518
            # - RBC 20060907
1588
1519
            self._write_inventory(self._inventory)
1589
 
 
 
1520
    
1590
1521
    def _iter_conflicts(self):
1591
1522
        conflicted = set()
1592
1523
        for info in self.list_files():
1600
1531
 
1601
1532
    @needs_write_lock
1602
1533
    def pull(self, source, overwrite=False, stop_revision=None,
1603
 
             change_reporter=None, possible_transports=None, local=False):
 
1534
             change_reporter=None, possible_transports=None):
 
1535
        top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1604
1536
        source.lock_read()
1605
1537
        try:
 
1538
            pp = ProgressPhase("Pull phase", 2, top_pb)
 
1539
            pp.next_phase()
1606
1540
            old_revision_info = self.branch.last_revision_info()
1607
1541
            basis_tree = self.basis_tree()
1608
1542
            count = self.branch.pull(source, overwrite, stop_revision,
1609
 
                                     possible_transports=possible_transports,
1610
 
                                     local=local)
 
1543
                                     possible_transports=possible_transports)
1611
1544
            new_revision_info = self.branch.last_revision_info()
1612
1545
            if new_revision_info != old_revision_info:
 
1546
                pp.next_phase()
1613
1547
                repository = self.branch.repository
 
1548
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
1614
1549
                basis_tree.lock_read()
1615
1550
                try:
1616
1551
                    new_basis_tree = self.branch.basis_tree()
1619
1554
                                new_basis_tree,
1620
1555
                                basis_tree,
1621
1556
                                this_tree=self,
1622
 
                                pb=None,
 
1557
                                pb=pb,
1623
1558
                                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)
 
1559
                    if (basis_tree.inventory.root is None and
 
1560
                        new_basis_tree.inventory.root is not None):
 
1561
                        self.set_root_id(new_basis_tree.get_root_id())
1628
1562
                finally:
 
1563
                    pb.finished()
1629
1564
                    basis_tree.unlock()
1630
1565
                # TODO - dedup parents list with things merged by pull ?
1631
1566
                # reuse the revisiontree we merged against to set the new
1632
1567
                # tree data.
1633
1568
                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
 
1569
                # we have to pull the merge trees out again, because 
 
1570
                # merge_inner has set the ids. - this corner is not yet 
1636
1571
                # layered well enough to prevent double handling.
1637
1572
                # XXX TODO: Fix the double handling: telling the tree about
1638
1573
                # the already known parent data is wasteful.
1644
1579
            return count
1645
1580
        finally:
1646
1581
            source.unlock()
 
1582
            top_pb.finished()
1647
1583
 
1648
1584
    @needs_write_lock
1649
1585
    def put_file_bytes_non_atomic(self, file_id, bytes):
1675
1611
 
1676
1612
            fl = []
1677
1613
            for subf in os.listdir(dirabs):
1678
 
                if self.bzrdir.is_control_filename(subf):
 
1614
                if subf == '.bzr':
1679
1615
                    continue
1680
1616
                if subf not in dir_entry.children:
1681
1617
                    try:
1691
1627
                            fl.append(subf_norm)
1692
1628
                    else:
1693
1629
                        fl.append(subf)
1694
 
 
 
1630
            
1695
1631
            fl.sort()
1696
1632
            for subf in fl:
1697
1633
                subp = pathjoin(path, subf)
1734
1670
        r"""Check whether the filename matches an ignore pattern.
1735
1671
 
1736
1672
        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.
 
1673
        others match against only the last component.
1740
1674
 
1741
1675
        If the file is ignored, returns the pattern which caused it to
1742
1676
        be ignored, otherwise None.  So this can simply be used as a
1743
1677
        boolean if desired."""
1744
1678
        if getattr(self, '_ignoreglobster', None) is None:
1745
 
            self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
 
1679
            self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1746
1680
        return self._ignoreglobster.match(filename)
1747
1681
 
1748
1682
    def kind(self, file_id):
1839
1773
    def _reset_data(self):
1840
1774
        """Reset transient data that cannot be revalidated."""
1841
1775
        self._inventory_is_modified = False
1842
 
        f = self._transport.get('inventory')
1843
 
        try:
1844
 
            result = self._deserialize(f)
1845
 
        finally:
1846
 
            f.close()
 
1776
        result = self._deserialize(self._transport.get('inventory'))
1847
1777
        self._set_inventory(result, dirty=False)
1848
1778
 
1849
1779
    @needs_tree_write_lock
1854
1784
 
1855
1785
    def _change_last_revision(self, new_revision):
1856
1786
        """Template method part of set_last_revision to perform the change.
1857
 
 
 
1787
        
1858
1788
        This is used to allow WorkingTree3 instances to not affect branch
1859
1789
        when their last revision is set.
1860
1790
        """
1873
1803
        path = self._basis_inventory_name()
1874
1804
        sio = StringIO(xml)
1875
1805
        self._transport.put_file(path, sio,
1876
 
            mode=self.bzrdir._get_file_mode())
 
1806
            mode=self._control_files._file_mode)
1877
1807
 
1878
1808
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
1879
1809
        """Create the text that will be saved in basis-inventory"""
1886
1816
        # as commit already has that ready-to-use [while the format is the
1887
1817
        # same, that is].
1888
1818
        try:
1889
 
            # this double handles the inventory - unpack and repack -
 
1819
            # this double handles the inventory - unpack and repack - 
1890
1820
            # but is easier to understand. We can/should put a conditional
1891
1821
            # in here based on whether the inventory is in the latest format
1892
1822
            # - perhaps we should repack all inventories on a repository
1893
1823
            # upgrade ?
1894
1824
            # the fast path is to copy the raw xml from the repository. If the
1895
 
            # xml contains 'revision_id="', then we assume the right
 
1825
            # xml contains 'revision_id="', then we assume the right 
1896
1826
            # revision_id is set. We must check for this full string, because a
1897
1827
            # root node id can legitimately look like 'revision_id' but cannot
1898
1828
            # contain a '"'.
1899
 
            xml = self.branch.repository._get_inventory_xml(new_revision)
 
1829
            xml = self.branch.repository.get_inventory_xml(new_revision)
1900
1830
            firstline = xml.split('\n', 1)[0]
1901
 
            if (not 'revision_id="' in firstline or
 
1831
            if (not 'revision_id="' in firstline or 
1902
1832
                'format="7"' not in firstline):
1903
 
                inv = self.branch.repository._serializer.read_inventory_from_string(
1904
 
                    xml, new_revision)
 
1833
                inv = self.branch.repository.deserialise_inventory(
 
1834
                    new_revision, xml)
1905
1835
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
1906
1836
            self._write_basis_inventory(xml)
1907
1837
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
1911
1841
        """Read the cached basis inventory."""
1912
1842
        path = self._basis_inventory_name()
1913
1843
        return self._transport.get_bytes(path)
1914
 
 
 
1844
        
1915
1845
    @needs_read_lock
1916
1846
    def read_working_inventory(self):
1917
1847
        """Read the working inventory.
1918
 
 
 
1848
        
1919
1849
        :raises errors.InventoryModified: read_working_inventory will fail
1920
1850
            when the current in memory inventory has been modified.
1921
1851
        """
1922
 
        # conceptually this should be an implementation detail of the tree.
 
1852
        # conceptually this should be an implementation detail of the tree. 
1923
1853
        # XXX: Deprecate this.
1924
1854
        # ElementTree does its own conversion from UTF-8, so open in
1925
1855
        # binary.
1926
1856
        if self._inventory_is_modified:
1927
1857
            raise errors.InventoryModified(self)
1928
 
        f = self._transport.get('inventory')
1929
 
        try:
1930
 
            result = self._deserialize(f)
1931
 
        finally:
1932
 
            f.close()
 
1858
        result = self._deserialize(self._transport.get('inventory'))
1933
1859
        self._set_inventory(result, dirty=False)
1934
1860
        return result
1935
1861
 
1950
1876
 
1951
1877
        new_files=set()
1952
1878
        unknown_nested_files=set()
1953
 
        if to_file is None:
1954
 
            to_file = sys.stdout
1955
1879
 
1956
1880
        def recurse_directory_to_add_files(directory):
1957
1881
            # Recurse directory and add all files
2013
1937
                        tree_delta.unversioned.extend((unknown_file,))
2014
1938
                raise errors.BzrRemoveChangedFilesError(tree_delta)
2015
1939
 
2016
 
        # Build inv_delta and delete files where applicable,
 
1940
        # Build inv_delta and delete files where applicaple,
2017
1941
        # do this before any modifications to inventory.
2018
1942
        for f in files:
2019
1943
            fid = self.path2id(f)
2027
1951
                        new_status = 'I'
2028
1952
                    else:
2029
1953
                        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')
 
1954
                    textui.show_status(new_status, self.kind(fid), f,
 
1955
                                       to_file=to_file)
2033
1956
                # Unversion file
2034
1957
                inv_delta.append((f, None, fid, None))
2035
1958
                message = "removed %s" % (f,)
2058
1981
 
2059
1982
    @needs_tree_write_lock
2060
1983
    def revert(self, filenames=None, old_tree=None, backups=True,
2061
 
               pb=None, report_changes=False):
 
1984
               pb=DummyProgress(), report_changes=False):
2062
1985
        from bzrlib.conflicts import resolve
2063
1986
        if filenames == []:
2064
1987
            filenames = None
2077
2000
            if filenames is None and len(self.get_parent_ids()) > 1:
2078
2001
                parent_trees = []
2079
2002
                last_revision = self.last_revision()
2080
 
                if last_revision != _mod_revision.NULL_REVISION:
 
2003
                if last_revision != NULL_REVISION:
2081
2004
                    if basis_tree is None:
2082
2005
                        basis_tree = self.basis_tree()
2083
2006
                        basis_tree.lock_read()
2121
2044
    def set_inventory(self, new_inventory_list):
2122
2045
        from bzrlib.inventory import (Inventory,
2123
2046
                                      InventoryDirectory,
 
2047
                                      InventoryEntry,
2124
2048
                                      InventoryFile,
2125
2049
                                      InventoryLink)
2126
2050
        inv = Inventory(self.get_root_id())
2128
2052
            name = os.path.basename(path)
2129
2053
            if name == "":
2130
2054
                continue
2131
 
            # fixme, there should be a factory function inv,add_??
 
2055
            # fixme, there should be a factory function inv,add_?? 
2132
2056
            if kind == 'directory':
2133
2057
                inv.add(InventoryDirectory(file_id, name, parent))
2134
2058
            elif kind == 'file':
2142
2066
    @needs_tree_write_lock
2143
2067
    def set_root_id(self, file_id):
2144
2068
        """Set the root id for this tree."""
2145
 
        # for compatability
 
2069
        # for compatability 
2146
2070
        if file_id is None:
2147
2071
            raise ValueError(
2148
2072
                'WorkingTree.set_root_id with fileid=None')
2152
2076
    def _set_root_id(self, file_id):
2153
2077
        """Set the root id for this tree, in a format specific manner.
2154
2078
 
2155
 
        :param file_id: The file id to assign to the root. It must not be
 
2079
        :param file_id: The file id to assign to the root. It must not be 
2156
2080
            present in the current inventory or an error will occur. It must
2157
2081
            not be None, but rather a valid file id.
2158
2082
        """
2177
2101
 
2178
2102
    def unlock(self):
2179
2103
        """See Branch.unlock.
2180
 
 
 
2104
        
2181
2105
        WorkingTree locking just uses the Branch locking facilities.
2182
2106
        This is current because all working trees have an embedded branch
2183
2107
        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
 
2108
        between multiple working trees, i.e. via shared storage, then we 
2185
2109
        would probably want to lock both the local tree, and the branch.
2186
2110
        """
2187
2111
        raise NotImplementedError(self.unlock)
2188
2112
 
2189
 
    _marker = object()
2190
 
 
2191
 
    def update(self, change_reporter=None, possible_transports=None,
2192
 
               revision=None, old_tip=_marker):
 
2113
    def update(self, change_reporter=None, possible_transports=None):
2193
2114
        """Update a working tree along its branch.
2194
2115
 
2195
2116
        This will update the branch if its bound too, which means we have
2213
2134
        - Merge current state -> basis tree of the master w.r.t. the old tree
2214
2135
          basis.
2215
2136
        - 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
2137
        """
2223
2138
        if self.branch.get_bound_location() is not None:
2224
2139
            self.lock_write()
2225
 
            update_branch = (old_tip is self._marker)
 
2140
            update_branch = True
2226
2141
        else:
2227
2142
            self.lock_tree_write()
2228
2143
            update_branch = False
2230
2145
            if update_branch:
2231
2146
                old_tip = self.branch.update(possible_transports)
2232
2147
            else:
2233
 
                if old_tip is self._marker:
2234
 
                    old_tip = None
2235
 
            return self._update_tree(old_tip, change_reporter, revision)
 
2148
                old_tip = None
 
2149
            return self._update_tree(old_tip, change_reporter)
2236
2150
        finally:
2237
2151
            self.unlock()
2238
2152
 
2239
2153
    @needs_tree_write_lock
2240
 
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
 
2154
    def _update_tree(self, old_tip=None, change_reporter=None):
2241
2155
        """Update a tree to the master branch.
2242
2156
 
2243
2157
        :param old_tip: if supplied, the previous tip revision the branch,
2249
2163
        # cant set that until we update the working trees last revision to be
2250
2164
        # one from the new branch, because it will just get absorbed by the
2251
2165
        # parent de-duplication logic.
2252
 
        #
 
2166
        # 
2253
2167
        # We MUST save it even if an error occurs, because otherwise the users
2254
2168
        # local work is unreferenced and will appear to have been lost.
2255
 
        #
2256
 
        nb_conflicts = 0
 
2169
        # 
 
2170
        result = 0
2257
2171
        try:
2258
2172
            last_rev = self.get_parent_ids()[0]
2259
2173
        except IndexError:
2260
2174
            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
 
 
 
2175
        if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
 
2176
            # merge tree state up to new branch tip.
2285
2177
            basis = self.basis_tree()
2286
2178
            basis.lock_read()
2287
2179
            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)
 
2180
                to_tree = self.branch.basis_tree()
 
2181
                if basis.inventory.root is None:
 
2182
                    self.set_root_id(to_tree.get_root_id())
2291
2183
                    self.flush()
 
2184
                result += merge.merge_inner(
 
2185
                                      self.branch,
 
2186
                                      to_tree,
 
2187
                                      basis,
 
2188
                                      this_tree=self,
 
2189
                                      change_reporter=change_reporter)
2292
2190
            finally:
2293
2191
                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
2192
            # TODO - dedup parents list with things merged by pull ?
2306
2193
            # reuse the tree we've updated to to set the basis:
2307
 
            parent_trees = [(revision, to_tree)]
 
2194
            parent_trees = [(self.branch.last_revision(), to_tree)]
2308
2195
            merges = self.get_parent_ids()[1:]
2309
2196
            # 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
 
2197
            # tree can decide whether to give us teh entire tree or give us a
2311
2198
            # lazy initialised tree. dirstate for instance will have the trees
2312
2199
            # in ram already, whereas a last-revision + basis-inventory tree
2313
2200
            # will not, but also does not need them when setting parents.
2314
2201
            for parent in merges:
2315
2202
                parent_trees.append(
2316
2203
                    (parent, self.branch.repository.revision_tree(parent)))
2317
 
            if not _mod_revision.is_null(old_tip):
 
2204
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2318
2205
                parent_trees.append(
2319
2206
                    (old_tip, self.branch.repository.revision_tree(old_tip)))
2320
2207
            self.set_parent_trees(parent_trees)
2321
2208
            last_rev = parent_trees[0][0]
2322
 
        return nb_conflicts
 
2209
        else:
 
2210
            # the working tree had the same last-revision as the master
 
2211
            # branch did. We may still have pivot local work from the local
 
2212
            # branch into old_tip:
 
2213
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
 
2214
                self.add_parent_tree_id(old_tip)
 
2215
        if (old_tip is not None and not _mod_revision.is_null(old_tip)
 
2216
            and old_tip != last_rev):
 
2217
            # our last revision was not the prior branch last revision
 
2218
            # and we have converted that last revision to a pending merge.
 
2219
            # base is somewhere between the branch tip now
 
2220
            # and the now pending merge
 
2221
 
 
2222
            # Since we just modified the working tree and inventory, flush out
 
2223
            # the current state, before we modify it again.
 
2224
            # TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
 
2225
            #       requires it only because TreeTransform directly munges the
 
2226
            #       inventory and calls tree._write_inventory(). Ultimately we
 
2227
            #       should be able to remove this extra flush.
 
2228
            self.flush()
 
2229
            graph = self.branch.repository.get_graph()
 
2230
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
 
2231
                                                old_tip)
 
2232
            base_tree = self.branch.repository.revision_tree(base_rev_id)
 
2233
            other_tree = self.branch.repository.revision_tree(old_tip)
 
2234
            result += merge.merge_inner(
 
2235
                                  self.branch,
 
2236
                                  other_tree,
 
2237
                                  base_tree,
 
2238
                                  this_tree=self,
 
2239
                                  change_reporter=change_reporter)
 
2240
        return result
2323
2241
 
2324
2242
    def _write_hashcache_if_dirty(self):
2325
2243
        """Write out the hashcache if it is dirty."""
2425
2343
                    bzrdir_loc = bisect_left(cur_disk_dir_content,
2426
2344
                        ('.bzr', '.bzr'))
2427
2345
                    if (bzrdir_loc < len(cur_disk_dir_content)
2428
 
                        and self.bzrdir.is_control_filename(
2429
 
                            cur_disk_dir_content[bzrdir_loc][0])):
 
2346
                        and cur_disk_dir_content[bzrdir_loc][0] == '.bzr'):
2430
2347
                        # we dont yield the contents of, or, .bzr itself.
2431
2348
                        del cur_disk_dir_content[bzrdir_loc]
2432
2349
            if inv_finished:
2566
2483
        return un_resolved, resolved
2567
2484
 
2568
2485
    @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
 
        """
 
2486
    def _check(self):
2576
2487
        tree_basis = self.basis_tree()
2577
2488
        tree_basis.lock_read()
2578
2489
        try:
2579
 
            repo_basis = references[('trees', self.last_revision())]
 
2490
            repo_basis = self.branch.repository.revision_tree(
 
2491
                self.last_revision())
2580
2492
            if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2581
2493
                raise errors.BzrCheckError(
2582
2494
                    "Mismatched basis inventory content.")
2595
2507
        """
2596
2508
        return
2597
2509
 
 
2510
    @needs_read_lock
2598
2511
    def _get_rules_searcher(self, default_searcher):
2599
2512
        """See Tree._get_rules_searcher."""
2600
2513
        if self._rules_searcher is None:
2611
2524
class WorkingTree2(WorkingTree):
2612
2525
    """This is the Format 2 working tree.
2613
2526
 
2614
 
    This was the first weave based working tree.
 
2527
    This was the first weave based working tree. 
2615
2528
     - uses os locks for locking.
2616
2529
     - uses the branch last-revision.
2617
2530
    """
2627
2540
        if self._inventory is None:
2628
2541
            self.read_working_inventory()
2629
2542
 
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
2543
    def lock_tree_write(self):
2635
2544
        """See WorkingTree.lock_tree_write().
2636
2545
 
2654
2563
            if self._inventory_is_modified:
2655
2564
                self.flush()
2656
2565
            self._write_hashcache_if_dirty()
2657
 
 
 
2566
                    
2658
2567
        # reverse order of locking.
2659
2568
        try:
2660
2569
            return self._control_files.unlock()
2682
2591
 
2683
2592
    def _change_last_revision(self, revision_id):
2684
2593
        """See WorkingTree._change_last_revision."""
2685
 
        if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
 
2594
        if revision_id is None or revision_id == NULL_REVISION:
2686
2595
            try:
2687
2596
                self._transport.delete('last-revision')
2688
2597
            except errors.NoSuchFile:
2690
2599
            return False
2691
2600
        else:
2692
2601
            self._transport.put_bytes('last-revision', revision_id,
2693
 
                mode=self.bzrdir._get_file_mode())
 
2602
                mode=self._control_files._file_mode)
2694
2603
            return True
2695
2604
 
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
2605
    @needs_tree_write_lock
2701
2606
    def set_conflicts(self, conflicts):
2702
 
        self._put_rio('conflicts', conflicts.to_stanzas(),
 
2607
        self._put_rio('conflicts', conflicts.to_stanzas(), 
2703
2608
                      CONFLICT_HEADER_1)
2704
2609
 
2705
2610
    @needs_tree_write_lock
2754
2659
     * a format string,
2755
2660
     * an open routine.
2756
2661
 
2757
 
    Formats are placed in an dict by their format string for reference
 
2662
    Formats are placed in an dict by their format string for reference 
2758
2663
    during workingtree opening. Its not required that these be instances, they
2759
 
    can be classes themselves with class methods - it simply depends on
 
2664
    can be classes themselves with class methods - it simply depends on 
2760
2665
    whether state is needed for a given format or not.
2761
2666
 
2762
2667
    Once a format is deprecated, just deprecate the initialize and open
2763
 
    methods on the format class. Do not deprecate the object, as the
 
2668
    methods on the format class. Do not deprecate the object, as the 
2764
2669
    object will be created every time regardless.
2765
2670
    """
2766
2671
 
2779
2684
        """Return the format for the working tree object in a_bzrdir."""
2780
2685
        try:
2781
2686
            transport = a_bzrdir.get_workingtree_transport(None)
2782
 
            format_string = transport.get_bytes("format")
 
2687
            format_string = transport.get("format").read()
2783
2688
            return klass._formats[format_string]
2784
2689
        except errors.NoSuchFile:
2785
2690
            raise errors.NoWorkingTree(base=transport.base)
2810
2715
        """Is this format supported?
2811
2716
 
2812
2717
        Supported formats can be initialized and opened.
2813
 
        Unsupported formats may not support initialization or committing or
 
2718
        Unsupported formats may not support initialization or committing or 
2814
2719
        some other features depending on the reason for not being supported.
2815
2720
        """
2816
2721
        return True
2837
2742
 
2838
2743
 
2839
2744
class WorkingTreeFormat2(WorkingTreeFormat):
2840
 
    """The second working tree format.
 
2745
    """The second working tree format. 
2841
2746
 
2842
2747
    This format modified the hash cache from the format 1 hash cache.
2843
2748
    """
2856
2761
        no working tree.  (See bug #43064).
2857
2762
        """
2858
2763
        sio = StringIO()
2859
 
        inv = inventory.Inventory()
 
2764
        inv = Inventory()
2860
2765
        xml5.serializer_v5.write_inventory(inv, sio, working=True)
2861
2766
        sio.seek(0)
2862
2767
        transport.put_file('inventory', sio, file_mode)
2878
2783
            branch.generate_revision_history(revision_id)
2879
2784
        finally:
2880
2785
            branch.unlock()
2881
 
        inv = inventory.Inventory()
 
2786
        inv = Inventory()
2882
2787
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2883
2788
                         branch,
2884
2789
                         inv,
2929
2834
        - is new in bzr 0.8
2930
2835
        - uses a LockDir to guard access for writes.
2931
2836
    """
2932
 
 
 
2837
    
2933
2838
    upgrade_recommended = True
2934
2839
 
2935
2840
    def get_format_string(self):
2952
2857
 
2953
2858
    def _open_control_files(self, a_bzrdir):
2954
2859
        transport = a_bzrdir.get_workingtree_transport(None)
2955
 
        return LockableFiles(transport, self._lock_file_name,
 
2860
        return LockableFiles(transport, self._lock_file_name, 
2956
2861
                             self._lock_class)
2957
2862
 
2958
2863
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2959
2864
                   accelerator_tree=None, hardlink=False):
2960
2865
        """See WorkingTreeFormat.initialize().
2961
 
 
 
2866
        
2962
2867
        :param revision_id: if supplied, create a working tree at a different
2963
2868
            revision than the branch is at.
2964
2869
        :param accelerator_tree: A tree which can be used for retrieving file
2975
2880
        control_files.create_lock()
2976
2881
        control_files.lock_write()
2977
2882
        transport.put_bytes('format', self.get_format_string(),
2978
 
            mode=a_bzrdir._get_file_mode())
 
2883
            mode=control_files._file_mode)
2979
2884
        if from_branch is not None:
2980
2885
            branch = from_branch
2981
2886
        else:
3001
2906
            # only set an explicit root id if there is one to set.
3002
2907
            if basis_tree.inventory.root is not None:
3003
2908
                wt.set_root_id(basis_tree.get_root_id())
3004
 
            if revision_id == _mod_revision.NULL_REVISION:
 
2909
            if revision_id == NULL_REVISION:
3005
2910
                wt.set_parent_trees([])
3006
2911
            else:
3007
2912
                wt.set_parent_trees([(revision_id, basis_tree)])
3014
2919
        return wt
3015
2920
 
3016
2921
    def _initial_inventory(self):
3017
 
        return inventory.Inventory()
 
2922
        return Inventory()
3018
2923
 
3019
2924
    def __init__(self):
3020
2925
        super(WorkingTreeFormat3, self).__init__()
3035
2940
 
3036
2941
    def _open(self, a_bzrdir, control_files):
3037
2942
        """Open the tree itself.
3038
 
 
 
2943
        
3039
2944
        :param a_bzrdir: the dir for the tree.
3040
2945
        :param control_files: the control files for the tree.
3041
2946
        """
3049
2954
        return self.get_format_string()
3050
2955
 
3051
2956
 
3052
 
__default_format = WorkingTreeFormat6()
 
2957
__default_format = WorkingTreeFormat4()
3053
2958
WorkingTreeFormat.register_format(__default_format)
3054
2959
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3055
 
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3056
2960
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3057
2961
WorkingTreeFormat.set_default_format(__default_format)
3058
2962
# formats which have no format string are not discoverable