← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: John Arbash Meinel
  • Date: 2008-10-14 21:35:27 UTC
  • mto: This revision was merged to the branch mainline in revision 3805.
  • Revision ID: john@arbash-meinel.com-20081014213527-4j9uc93aq1qmn43b
Add in a shortcut when we haven't cached much yet.

Document the current algorithm more completely, including the proper
justification for the various steps.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/workingtree.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""WorkingTree object and friends.
18
18
 
19
19
A WorkingTree represents the editable working copy of a branch.
20
 
Operations which represent the WorkingTree are also done here,
21
 
such as renaming or adding files.  The WorkingTree has an inventory
22
 
which is updated by these operations.  A commit produces a
 
20
Operations which represent the WorkingTree are also done here, 
 
21
such as renaming or adding files.  The WorkingTree has an inventory 
 
22
which is updated by these operations.  A commit produces a 
23
23
new revision based on the workingtree and its inventory.
24
24
 
25
25
At the moment every WorkingTree has its own branch.  Remote
29
29
WorkingTree.open(dir).
30
30
"""
31
31
 
 
32
# TODO: Give the workingtree sole responsibility for the working inventory;
 
33
# remove the variable and references to it from the branch.  This may require
 
34
# updating the commit code so as to update the inventory within the working
 
35
# copy, and making sure there's only one WorkingTree for any directory on disk.
 
36
# At the moment they may alias the inventory and have old copies of it in
 
37
# memory.  (Now done? -- mbp 20060309)
32
38
 
33
39
from cStringIO import StringIO
34
40
import os
42
48
import itertools
43
49
import operator
44
50
import stat
 
51
from time import time
 
52
import warnings
45
53
import re
46
54
 
47
55
import bzrlib
49
57
    branch,
50
58
    bzrdir,
51
59
    conflicts as _mod_conflicts,
 
60
    dirstate,
52
61
    errors,
53
62
    generate_ids,
54
63
    globbing,
55
 
    graph as _mod_graph,
56
64
    hashcache,
57
65
    ignores,
58
 
    inventory,
59
66
    merge,
60
67
    revision as _mod_revision,
61
68
    revisiontree,
 
69
    repository,
 
70
    textui,
62
71
    trace,
63
72
    transform,
64
73
    ui,
65
 
    views,
 
74
    urlutils,
66
75
    xml5,
 
76
    xml6,
67
77
    xml7,
68
78
    )
69
79
import bzrlib.branch
70
80
from bzrlib.transport import get_transport
71
 
from bzrlib.workingtree_4 import (
72
 
    WorkingTreeFormat4,
73
 
    WorkingTreeFormat5,
74
 
    WorkingTreeFormat6,
75
 
    )
 
81
import bzrlib.ui
 
82
from bzrlib.workingtree_4 import WorkingTreeFormat4
76
83
""")
77
84
 
78
85
from bzrlib import symbol_versioning
79
86
from bzrlib.decorators import needs_read_lock, needs_write_lock
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_text(self, file_id):
 
437
        return self.get_file(file_id).read()
 
438
 
 
439
    def get_file_byname(self, filename):
 
440
        return file(self.abspath(filename), 'rb')
483
441
 
484
442
    @needs_read_lock
485
443
    def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
492
450
        incorrectly attributed to CURRENT_REVISION (but after committing, the
493
451
        attribution will be correct).
494
452
        """
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
 
453
        basis = self.basis_tree()
 
454
        basis.lock_read()
 
455
        try:
 
456
            changes = self.iter_changes(basis, True, [self.id2path(file_id)],
 
457
                require_versioned=True).next()
 
458
            changed_content, kind = changes[2], changes[6]
 
459
            if not changed_content:
 
460
                return basis.annotate_iter(file_id)
 
461
            if kind[1] is None:
 
462
                return None
 
463
            import annotate
 
464
            if kind[0] != 'file':
 
465
                old_lines = []
 
466
            else:
 
467
                old_lines = list(basis.annotate_iter(file_id))
 
468
            old = [old_lines]
 
469
            for tree in self.branch.repository.revision_trees(
 
470
                self.get_parent_ids()[1:]):
 
471
                if file_id not in tree:
 
472
                    continue
 
473
                old.append(list(tree.annotate_iter(file_id)))
 
474
            return annotate.reannotate(old, self.get_file(file_id).readlines(),
 
475
                                       default_revision)
 
476
        finally:
 
477
            basis.unlock()
531
478
 
532
479
    def _get_ancestors(self, default_revision):
533
480
        ancestors = set([default_revision])
538
485
 
539
486
    def get_parent_ids(self):
540
487
        """See Tree.get_parent_ids.
541
 
 
 
488
        
542
489
        This implementation reads the pending merges list and last_revision
543
490
        value and uses that to decide what the parents list should be.
544
491
        """
548
495
        else:
549
496
            parents = [last_rev]
550
497
        try:
551
 
            merges_bytes = self._transport.get_bytes('pending-merges')
 
498
            merges_file = self._transport.get('pending-merges')
552
499
        except errors.NoSuchFile:
553
500
            pass
554
501
        else:
555
 
            for l in osutils.split_lines(merges_bytes):
 
502
            for l in merges_file.readlines():
556
503
                revision_id = l.rstrip('\n')
557
504
                parents.append(revision_id)
558
505
        return parents
561
508
    def get_root_id(self):
562
509
        """Return the id of this trees root"""
563
510
        return self._inventory.root.file_id
564
 
 
 
511
        
565
512
    def _get_store_filename(self, file_id):
566
513
        ## XXX: badly named; this is not in the store at all
567
514
        return self.abspath(self.id2path(file_id))
569
516
    @needs_read_lock
570
517
    def clone(self, to_bzrdir, revision_id=None):
571
518
        """Duplicate this working tree into to_bzr, including all state.
572
 
 
 
519
        
573
520
        Specifically modified files are kept as modified, but
574
521
        ignored and unknown files are discarded.
575
522
 
576
523
        If you want to make a new line of development, see bzrdir.sprout()
577
524
 
578
525
        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
 
526
            If not None, the cloned tree will have its last revision set to 
 
527
            revision, and and difference between the source trees last revision
581
528
            and this one merged in.
582
529
        """
583
530
        # assumes the target bzr dir format is compatible.
617
564
 
618
565
    def get_file_size(self, file_id):
619
566
        """See Tree.get_file_size"""
620
 
        # XXX: this returns the on-disk size; it should probably return the
621
 
        # canonical size
622
567
        try:
623
568
            return os.path.getsize(self.id2abspath(file_id))
624
569
        except OSError, e:
640
585
 
641
586
    def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
642
587
        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
588
        return self._inventory[file_id].executable
648
589
 
649
590
    def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
671
612
        """See MutableTree._add."""
672
613
        # TODO: Re-adding a file that is removed in the working copy
673
614
        # should probably put it back with the previous ID.
674
 
        # the read and write working inventory should not occur in this
 
615
        # the read and write working inventory should not occur in this 
675
616
        # function - they should be part of lock_write and unlock.
676
617
        inv = self.inventory
677
618
        for f, file_id, kind in zip(files, ids, kinds):
759
700
            raise
760
701
        kind = _mapper(stat_result.st_mode)
761
702
        if kind == 'file':
762
 
            return self._file_content_summary(path, stat_result)
 
703
            size = stat_result.st_size
 
704
            # try for a stat cache lookup
 
705
            executable = self._is_executable_from_path_and_stat(path, stat_result)
 
706
            return (kind, size, executable, self._sha_from_stat(
 
707
                path, stat_result))
763
708
        elif kind == 'directory':
764
709
            # perhaps it looks like a plain directory, but it's really a
765
710
            # reference.
767
712
                kind = 'tree-reference'
768
713
            return kind, None, None, None
769
714
        elif kind == 'symlink':
770
 
            target = osutils.readlink(abspath)
771
 
            return ('symlink', None, None, target)
 
715
            return ('symlink', None, None, os.readlink(abspath))
772
716
        else:
773
717
            return (kind, None, None, None)
774
718
 
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
719
    def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
783
720
        """Common ghost checking functionality from set_parent_*.
784
721
 
794
731
    def _set_merges_from_parent_ids(self, parent_ids):
795
732
        merges = parent_ids[1:]
796
733
        self._transport.put_bytes('pending-merges', '\n'.join(merges),
797
 
            mode=self.bzrdir._get_file_mode())
 
734
            mode=self._control_files._file_mode)
798
735
 
799
736
    def _filter_parent_ids_by_ancestry(self, revision_ids):
800
737
        """Check that all merged revisions are proper 'heads'.
801
738
 
802
739
        This will always return the first revision_id, and any merged revisions
803
 
        which are
 
740
        which are 
804
741
        """
805
742
        if len(revision_ids) == 0:
806
743
            return revision_ids
818
755
    @needs_tree_write_lock
819
756
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
820
757
        """Set the parent ids to revision_ids.
821
 
 
 
758
        
822
759
        See also set_parent_trees. This api will try to retrieve the tree data
823
760
        for each element of revision_ids from the trees repository. If you have
824
761
        tree data already available, it is more efficient to use
900
837
        self._must_be_locked()
901
838
        my_file = rio_file(stanzas, header)
902
839
        self._transport.put_file(filename, my_file,
903
 
            mode=self.bzrdir._get_file_mode())
 
840
            mode=self._control_files._file_mode)
904
841
 
905
842
    @needs_write_lock # because merge pulls data into the branch.
906
843
    def merge_from_branch(self, branch, to_revision=None, from_revision=None,
907
 
                          merge_type=None, force=False):
 
844
        merge_type=None):
908
845
        """Merge from a branch into this working tree.
909
846
 
910
847
        :param branch: The branch to merge from.
914
851
            branch.last_revision().
915
852
        """
916
853
        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()
 
854
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
855
        try:
 
856
            merger = Merger(self.branch, this_tree=self, pb=pb)
 
857
            merger.pp = ProgressPhase("Merge phase", 5, pb)
 
858
            merger.pp.next_phase()
 
859
            # check that there are no
 
860
            # local alterations
 
861
            merger.check_basis(check_clean=True, require_commits=False)
 
862
            if to_revision is None:
 
863
                to_revision = _mod_revision.ensure_null(branch.last_revision())
 
864
            merger.other_rev_id = to_revision
 
865
            if _mod_revision.is_null(merger.other_rev_id):
 
866
                raise errors.NoCommits(branch)
 
867
            self.branch.fetch(branch, last_revision=merger.other_rev_id)
 
868
            merger.other_basis = merger.other_rev_id
 
869
            merger.other_tree = self.branch.repository.revision_tree(
 
870
                merger.other_rev_id)
 
871
            merger.other_branch = branch
 
872
            merger.pp.next_phase()
 
873
            if from_revision is None:
 
874
                merger.find_base()
 
875
            else:
 
876
                merger.set_base_revision(from_revision, branch)
 
877
            if merger.base_rev_id == merger.other_rev_id:
 
878
                raise errors.PointlessMerge
 
879
            merger.backup_files = False
 
880
            if merge_type is None:
 
881
                merger.merge_type = Merge3Merger
 
882
            else:
 
883
                merger.merge_type = merge_type
 
884
            merger.set_interesting_files(None)
 
885
            merger.show_base = False
 
886
            merger.reprocess = False
 
887
            conflicts = merger.do_merge()
 
888
            merger.set_pending()
 
889
        finally:
 
890
            pb.finished()
947
891
        return conflicts
948
892
 
949
893
    @needs_read_lock
950
894
    def merge_modified(self):
951
895
        """Return a dictionary of files modified by a merge.
952
896
 
953
 
        The list is initialized by WorkingTree.set_merge_modified, which is
 
897
        The list is initialized by WorkingTree.set_merge_modified, which is 
954
898
        typically called after we make some automatic updates to the tree
955
899
        because of a merge.
956
900
 
990
934
        return file_id
991
935
 
992
936
    def get_symlink_target(self, file_id):
993
 
        abspath = self.id2abspath(file_id)
994
 
        target = osutils.readlink(abspath)
995
 
        return target
 
937
        return os.readlink(self.id2abspath(file_id))
996
938
 
997
939
    @needs_write_lock
998
940
    def subsume(self, other_tree):
1048
990
        return False
1049
991
 
1050
992
    def _directory_may_be_tree_reference(self, relpath):
1051
 
        # as a special case, if a directory contains control files then
 
993
        # as a special case, if a directory contains control files then 
1052
994
        # it's a tree reference, except that the root of the tree is not
1053
995
        return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1054
996
        # TODO: We could ask all the control formats whether they
1065
1007
    @needs_tree_write_lock
1066
1008
    def extract(self, file_id, format=None):
1067
1009
        """Extract a subtree from this tree.
1068
 
 
 
1010
        
1069
1011
        A new branch will be created, relative to the path for this tree.
1070
1012
        """
1071
1013
        self.flush()
1076
1018
                transport = transport.clone(name)
1077
1019
                transport.ensure_base()
1078
1020
            return transport
1079
 
 
 
1021
            
1080
1022
        sub_path = self.id2path(file_id)
1081
1023
        branch_transport = mkdirs(sub_path)
1082
1024
        if format is None:
1096
1038
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
1097
1039
        if tree_transport.base != branch_transport.base:
1098
1040
            tree_bzrdir = format.initialize_on_transport(tree_transport)
1099
 
            branch.BranchReferenceFormat().initialize(tree_bzrdir,
1100
 
                target_branch=new_branch)
 
1041
            branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1101
1042
        else:
1102
1043
            tree_bzrdir = branch_bzrdir
1103
 
        wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
 
1044
        wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1104
1045
        wt.set_parent_ids(self.get_parent_ids())
1105
1046
        my_inv = self.inventory
1106
 
        child_inv = inventory.Inventory(root_id=None)
 
1047
        child_inv = Inventory(root_id=None)
1107
1048
        new_root = my_inv[file_id]
1108
1049
        my_inv.remove_recursive_id(file_id)
1109
1050
        new_root.parent_id = None
1128
1069
        self._serialize(self._inventory, sio)
1129
1070
        sio.seek(0)
1130
1071
        self._transport.put_file('inventory', sio,
1131
 
            mode=self.bzrdir._get_file_mode())
 
1072
            mode=self._control_files._file_mode)
1132
1073
        self._inventory_is_modified = False
1133
1074
 
1134
1075
    def _kind(self, relpath):
1135
1076
        return osutils.file_kind(self.abspath(relpath))
1136
1077
 
1137
 
    def list_files(self, include_root=False, from_dir=None, recursive=True):
1138
 
        """List all files as (path, class, kind, id, entry).
 
1078
    def list_files(self, include_root=False):
 
1079
        """Recursively list all files as (path, class, kind, id, entry).
1139
1080
 
1140
1081
        Lists, but does not descend into unversioned directories.
 
1082
 
1141
1083
        This does not include files that have been deleted in this
1142
 
        tree. Skips the control directory.
 
1084
        tree.
1143
1085
 
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
 
1086
        Skips the control directory.
1147
1087
        """
1148
1088
        # list_files is an iterator, so @needs_read_lock doesn't work properly
1149
1089
        # with it. So callers should be careful to always read_lock the tree.
1151
1091
            raise errors.ObjectNotLocked(self)
1152
1092
 
1153
1093
        inv = self.inventory
1154
 
        if from_dir is None and include_root is True:
 
1094
        if include_root is True:
1155
1095
            yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1156
1096
        # Convert these into local objects to save lookup times
1157
1097
        pathjoin = osutils.pathjoin
1164
1104
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1165
1105
 
1166
1106
        # 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)
 
1107
        children = os.listdir(self.basedir)
1177
1108
        children.sort()
1178
 
        # jam 20060527 The kernel sized tree seems equivalent whether we
 
1109
        # jam 20060527 The kernel sized tree seems equivalent whether we 
1179
1110
        # use a deque and popleft to keep them sorted, or if we use a plain
1180
1111
        # list and just reverse() them.
1181
1112
        children = collections.deque(children)
1182
 
        stack = [(from_dir_id, u'', from_dir_abspath, children)]
 
1113
        stack = [(inv.root.file_id, u'', self.basedir, children)]
1183
1114
        while stack:
1184
1115
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1185
1116
 
1201
1132
 
1202
1133
                # absolute path
1203
1134
                fap = from_dir_abspath + '/' + f
1204
 
 
 
1135
                
1205
1136
                f_ie = inv.get_child(from_dir_id, f)
1206
1137
                if f_ie:
1207
1138
                    c = 'V'
1239
1170
                    except KeyError:
1240
1171
                        yield fp[1:], c, fk, None, TreeEntry()
1241
1172
                    continue
1242
 
 
 
1173
                
1243
1174
                if fk != 'directory':
1244
1175
                    continue
1245
1176
 
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
 
1177
                # But do this child first
 
1178
                new_children = os.listdir(fap)
 
1179
                new_children.sort()
 
1180
                new_children = collections.deque(new_children)
 
1181
                stack.append((f_ie.file_id, fp, fap, new_children))
 
1182
                # Break out of inner loop,
 
1183
                # so that we start outer loop with child
 
1184
                break
1255
1185
            else:
1256
1186
                # if we finished all children, pop it off the stack
1257
1187
                stack.pop()
1263
1193
        to_dir must exist in the inventory.
1264
1194
 
1265
1195
        If to_dir exists and is a directory, the files are moved into
1266
 
        it, keeping their old names.
 
1196
        it, keeping their old names.  
1267
1197
 
1268
1198
        Note that to_dir is only the last component of the new name;
1269
1199
        this doesn't change the directory.
1435
1365
        inv = self.inventory
1436
1366
        for entry in moved:
1437
1367
            try:
1438
 
                self._move_entry(WorkingTree._RenameEntry(
1439
 
                    entry.to_rel, entry.from_id,
 
1368
                self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1440
1369
                    entry.to_tail, entry.to_parent_id, entry.from_rel,
1441
1370
                    entry.from_tail, entry.from_parent_id,
1442
1371
                    entry.only_change_inv))
1493
1422
        from_tail = splitpath(from_rel)[-1]
1494
1423
        from_id = inv.path2id(from_rel)
1495
1424
        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]
 
1425
            raise errors.BzrRenameFailedError(from_rel,to_rel,
 
1426
                errors.NotVersionedError(path=str(from_rel)))
 
1427
        from_entry = inv[from_id]
1507
1428
        from_parent_id = from_entry.parent_id
1508
1429
        to_dir, to_tail = os.path.split(to_rel)
1509
1430
        to_dir_id = inv.path2id(to_dir)
1555
1476
        These are files in the working directory that are not versioned or
1556
1477
        control files or ignored.
1557
1478
        """
1558
 
        # force the extras method to be fully executed before returning, to
 
1479
        # force the extras method to be fully executed before returning, to 
1559
1480
        # prevent race conditions with the lock
1560
1481
        return iter(
1561
1482
            [subp for subp in self.extras() if not self.is_ignored(subp)])
1571
1492
        :raises: NoSuchId if any fileid is not currently versioned.
1572
1493
        """
1573
1494
        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
1495
            if self._inventory.has_id(file_id):
1578
1496
                self._inventory.remove_recursive_id(file_id)
 
1497
            else:
 
1498
                raise errors.NoSuchId(self, file_id)
1579
1499
        if len(file_ids):
1580
 
            # in the future this should just set a dirty bit to wait for the
 
1500
            # in the future this should just set a dirty bit to wait for the 
1581
1501
            # final unlock. However, until all methods of workingtree start
1582
 
            # with the current in -memory inventory rather than triggering
 
1502
            # with the current in -memory inventory rather than triggering 
1583
1503
            # a read, it is more complex - we need to teach read_inventory
1584
1504
            # to know when to read, and when to not read first... and possibly
1585
1505
            # to save first when the in memory one may be corrupted.
1586
1506
            # so for now, we just only write it if it is indeed dirty.
1587
1507
            # - RBC 20060907
1588
1508
            self._write_inventory(self._inventory)
1589
 
 
 
1509
    
1590
1510
    def _iter_conflicts(self):
1591
1511
        conflicted = set()
1592
1512
        for info in self.list_files():
1600
1520
 
1601
1521
    @needs_write_lock
1602
1522
    def pull(self, source, overwrite=False, stop_revision=None,
1603
 
             change_reporter=None, possible_transports=None, local=False):
 
1523
             change_reporter=None, possible_transports=None):
 
1524
        top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1604
1525
        source.lock_read()
1605
1526
        try:
 
1527
            pp = ProgressPhase("Pull phase", 2, top_pb)
 
1528
            pp.next_phase()
1606
1529
            old_revision_info = self.branch.last_revision_info()
1607
1530
            basis_tree = self.basis_tree()
1608
1531
            count = self.branch.pull(source, overwrite, stop_revision,
1609
 
                                     possible_transports=possible_transports,
1610
 
                                     local=local)
 
1532
                                     possible_transports=possible_transports)
1611
1533
            new_revision_info = self.branch.last_revision_info()
1612
1534
            if new_revision_info != old_revision_info:
 
1535
                pp.next_phase()
1613
1536
                repository = self.branch.repository
 
1537
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
1614
1538
                basis_tree.lock_read()
1615
1539
                try:
1616
1540
                    new_basis_tree = self.branch.basis_tree()
1619
1543
                                new_basis_tree,
1620
1544
                                basis_tree,
1621
1545
                                this_tree=self,
1622
 
                                pb=None,
 
1546
                                pb=pb,
1623
1547
                                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)
 
1548
                    if (basis_tree.inventory.root is None and
 
1549
                        new_basis_tree.inventory.root is not None):
 
1550
                        self.set_root_id(new_basis_tree.get_root_id())
1628
1551
                finally:
 
1552
                    pb.finished()
1629
1553
                    basis_tree.unlock()
1630
1554
                # TODO - dedup parents list with things merged by pull ?
1631
1555
                # reuse the revisiontree we merged against to set the new
1632
1556
                # tree data.
1633
1557
                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
 
1558
                # we have to pull the merge trees out again, because 
 
1559
                # merge_inner has set the ids. - this corner is not yet 
1636
1560
                # layered well enough to prevent double handling.
1637
1561
                # XXX TODO: Fix the double handling: telling the tree about
1638
1562
                # the already known parent data is wasteful.
1644
1568
            return count
1645
1569
        finally:
1646
1570
            source.unlock()
 
1571
            top_pb.finished()
1647
1572
 
1648
1573
    @needs_write_lock
1649
1574
    def put_file_bytes_non_atomic(self, file_id, bytes):
1675
1600
 
1676
1601
            fl = []
1677
1602
            for subf in os.listdir(dirabs):
1678
 
                if self.bzrdir.is_control_filename(subf):
 
1603
                if subf == '.bzr':
1679
1604
                    continue
1680
1605
                if subf not in dir_entry.children:
1681
1606
                    try:
1691
1616
                            fl.append(subf_norm)
1692
1617
                    else:
1693
1618
                        fl.append(subf)
1694
 
 
 
1619
            
1695
1620
            fl.sort()
1696
1621
            for subf in fl:
1697
1622
                subp = pathjoin(path, subf)
1734
1659
        r"""Check whether the filename matches an ignore pattern.
1735
1660
 
1736
1661
        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.
 
1662
        others match against only the last component.
1740
1663
 
1741
1664
        If the file is ignored, returns the pattern which caused it to
1742
1665
        be ignored, otherwise None.  So this can simply be used as a
1743
1666
        boolean if desired."""
1744
1667
        if getattr(self, '_ignoreglobster', None) is None:
1745
 
            self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
 
1668
            self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1746
1669
        return self._ignoreglobster.match(filename)
1747
1670
 
1748
1671
    def kind(self, file_id):
1798
1721
            raise errors.ObjectNotLocked(self)
1799
1722
 
1800
1723
    def lock_read(self):
1801
 
        """Lock the tree for reading.
1802
 
 
1803
 
        This also locks the branch, and can be unlocked via self.unlock().
1804
 
 
1805
 
        :return: An object with an unlock method which will release the lock
1806
 
            obtained.
1807
 
        """
 
1724
        """See Branch.lock_read, and WorkingTree.unlock."""
1808
1725
        if not self.is_locked():
1809
1726
            self._reset_data()
1810
1727
        self.branch.lock_read()
1811
1728
        try:
1812
 
            self._control_files.lock_read()
1813
 
            return self
 
1729
            return self._control_files.lock_read()
1814
1730
        except:
1815
1731
            self.branch.unlock()
1816
1732
            raise
1817
1733
 
1818
1734
    def lock_tree_write(self):
1819
 
        """See MutableTree.lock_tree_write, and WorkingTree.unlock.
1820
 
 
1821
 
        :return: An object with an unlock method which will release the lock
1822
 
            obtained.
1823
 
        """
 
1735
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1824
1736
        if not self.is_locked():
1825
1737
            self._reset_data()
1826
1738
        self.branch.lock_read()
1827
1739
        try:
1828
 
            self._control_files.lock_write()
1829
 
            return self
 
1740
            return self._control_files.lock_write()
1830
1741
        except:
1831
1742
            self.branch.unlock()
1832
1743
            raise
1833
1744
 
1834
1745
    def lock_write(self):
1835
 
        """See MutableTree.lock_write, and WorkingTree.unlock.
1836
 
 
1837
 
        :return: An object with an unlock method which will release the lock
1838
 
            obtained.
1839
 
        """
 
1746
        """See MutableTree.lock_write, and WorkingTree.unlock."""
1840
1747
        if not self.is_locked():
1841
1748
            self._reset_data()
1842
1749
        self.branch.lock_write()
1843
1750
        try:
1844
 
            self._control_files.lock_write()
1845
 
            return self
 
1751
            return self._control_files.lock_write()
1846
1752
        except:
1847
1753
            self.branch.unlock()
1848
1754
            raise
1856
1762
    def _reset_data(self):
1857
1763
        """Reset transient data that cannot be revalidated."""
1858
1764
        self._inventory_is_modified = False
1859
 
        f = self._transport.get('inventory')
1860
 
        try:
1861
 
            result = self._deserialize(f)
1862
 
        finally:
1863
 
            f.close()
 
1765
        result = self._deserialize(self._transport.get('inventory'))
1864
1766
        self._set_inventory(result, dirty=False)
1865
1767
 
1866
1768
    @needs_tree_write_lock
1871
1773
 
1872
1774
    def _change_last_revision(self, new_revision):
1873
1775
        """Template method part of set_last_revision to perform the change.
1874
 
 
 
1776
        
1875
1777
        This is used to allow WorkingTree3 instances to not affect branch
1876
1778
        when their last revision is set.
1877
1779
        """
1890
1792
        path = self._basis_inventory_name()
1891
1793
        sio = StringIO(xml)
1892
1794
        self._transport.put_file(path, sio,
1893
 
            mode=self.bzrdir._get_file_mode())
 
1795
            mode=self._control_files._file_mode)
1894
1796
 
1895
1797
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
1896
1798
        """Create the text that will be saved in basis-inventory"""
1903
1805
        # as commit already has that ready-to-use [while the format is the
1904
1806
        # same, that is].
1905
1807
        try:
1906
 
            # this double handles the inventory - unpack and repack -
 
1808
            # this double handles the inventory - unpack and repack - 
1907
1809
            # but is easier to understand. We can/should put a conditional
1908
1810
            # in here based on whether the inventory is in the latest format
1909
1811
            # - perhaps we should repack all inventories on a repository
1910
1812
            # upgrade ?
1911
1813
            # the fast path is to copy the raw xml from the repository. If the
1912
 
            # xml contains 'revision_id="', then we assume the right
 
1814
            # xml contains 'revision_id="', then we assume the right 
1913
1815
            # revision_id is set. We must check for this full string, because a
1914
1816
            # root node id can legitimately look like 'revision_id' but cannot
1915
1817
            # contain a '"'.
1916
 
            xml = self.branch.repository._get_inventory_xml(new_revision)
 
1818
            xml = self.branch.repository.get_inventory_xml(new_revision)
1917
1819
            firstline = xml.split('\n', 1)[0]
1918
 
            if (not 'revision_id="' in firstline or
 
1820
            if (not 'revision_id="' in firstline or 
1919
1821
                'format="7"' not in firstline):
1920
 
                inv = self.branch.repository._serializer.read_inventory_from_string(
1921
 
                    xml, new_revision)
 
1822
                inv = self.branch.repository.deserialise_inventory(
 
1823
                    new_revision, xml)
1922
1824
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
1923
1825
            self._write_basis_inventory(xml)
1924
1826
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
1928
1830
        """Read the cached basis inventory."""
1929
1831
        path = self._basis_inventory_name()
1930
1832
        return self._transport.get_bytes(path)
1931
 
 
 
1833
        
1932
1834
    @needs_read_lock
1933
1835
    def read_working_inventory(self):
1934
1836
        """Read the working inventory.
1935
 
 
 
1837
        
1936
1838
        :raises errors.InventoryModified: read_working_inventory will fail
1937
1839
            when the current in memory inventory has been modified.
1938
1840
        """
1939
 
        # conceptually this should be an implementation detail of the tree.
 
1841
        # conceptually this should be an implementation detail of the tree. 
1940
1842
        # XXX: Deprecate this.
1941
1843
        # ElementTree does its own conversion from UTF-8, so open in
1942
1844
        # binary.
1943
1845
        if self._inventory_is_modified:
1944
1846
            raise errors.InventoryModified(self)
1945
 
        f = self._transport.get('inventory')
1946
 
        try:
1947
 
            result = self._deserialize(f)
1948
 
        finally:
1949
 
            f.close()
 
1847
        result = self._deserialize(self._transport.get('inventory'))
1950
1848
        self._set_inventory(result, dirty=False)
1951
1849
        return result
1952
1850
 
1967
1865
 
1968
1866
        new_files=set()
1969
1867
        unknown_nested_files=set()
1970
 
        if to_file is None:
1971
 
            to_file = sys.stdout
1972
1868
 
1973
1869
        def recurse_directory_to_add_files(directory):
1974
1870
            # Recurse directory and add all files
2030
1926
                        tree_delta.unversioned.extend((unknown_file,))
2031
1927
                raise errors.BzrRemoveChangedFilesError(tree_delta)
2032
1928
 
2033
 
        # Build inv_delta and delete files where applicable,
 
1929
        # Build inv_delta and delete files where applicaple,
2034
1930
        # do this before any modifications to inventory.
2035
1931
        for f in files:
2036
1932
            fid = self.path2id(f)
2044
1940
                        new_status = 'I'
2045
1941
                    else:
2046
1942
                        new_status = '?'
2047
 
                    # XXX: Really should be a more abstract reporter interface
2048
 
                    kind_ch = osutils.kind_marker(self.kind(fid))
2049
 
                    to_file.write(new_status + '       ' + f + kind_ch + '\n')
 
1943
                    textui.show_status(new_status, self.kind(fid), f,
 
1944
                                       to_file=to_file)
2050
1945
                # Unversion file
2051
1946
                inv_delta.append((f, None, fid, None))
2052
1947
                message = "removed %s" % (f,)
2075
1970
 
2076
1971
    @needs_tree_write_lock
2077
1972
    def revert(self, filenames=None, old_tree=None, backups=True,
2078
 
               pb=None, report_changes=False):
 
1973
               pb=DummyProgress(), report_changes=False):
2079
1974
        from bzrlib.conflicts import resolve
2080
1975
        if filenames == []:
2081
1976
            filenames = None
2094
1989
            if filenames is None and len(self.get_parent_ids()) > 1:
2095
1990
                parent_trees = []
2096
1991
                last_revision = self.last_revision()
2097
 
                if last_revision != _mod_revision.NULL_REVISION:
 
1992
                if last_revision != NULL_REVISION:
2098
1993
                    if basis_tree is None:
2099
1994
                        basis_tree = self.basis_tree()
2100
1995
                        basis_tree.lock_read()
2138
2033
    def set_inventory(self, new_inventory_list):
2139
2034
        from bzrlib.inventory import (Inventory,
2140
2035
                                      InventoryDirectory,
 
2036
                                      InventoryEntry,
2141
2037
                                      InventoryFile,
2142
2038
                                      InventoryLink)
2143
2039
        inv = Inventory(self.get_root_id())
2145
2041
            name = os.path.basename(path)
2146
2042
            if name == "":
2147
2043
                continue
2148
 
            # fixme, there should be a factory function inv,add_??
 
2044
            # fixme, there should be a factory function inv,add_?? 
2149
2045
            if kind == 'directory':
2150
2046
                inv.add(InventoryDirectory(file_id, name, parent))
2151
2047
            elif kind == 'file':
2159
2055
    @needs_tree_write_lock
2160
2056
    def set_root_id(self, file_id):
2161
2057
        """Set the root id for this tree."""
2162
 
        # for compatability
 
2058
        # for compatability 
2163
2059
        if file_id is None:
2164
2060
            raise ValueError(
2165
2061
                'WorkingTree.set_root_id with fileid=None')
2169
2065
    def _set_root_id(self, file_id):
2170
2066
        """Set the root id for this tree, in a format specific manner.
2171
2067
 
2172
 
        :param file_id: The file id to assign to the root. It must not be
 
2068
        :param file_id: The file id to assign to the root. It must not be 
2173
2069
            present in the current inventory or an error will occur. It must
2174
2070
            not be None, but rather a valid file id.
2175
2071
        """
2194
2090
 
2195
2091
    def unlock(self):
2196
2092
        """See Branch.unlock.
2197
 
 
 
2093
        
2198
2094
        WorkingTree locking just uses the Branch locking facilities.
2199
2095
        This is current because all working trees have an embedded branch
2200
2096
        within them. IF in the future, we were to make branch data shareable
2201
 
        between multiple working trees, i.e. via shared storage, then we
 
2097
        between multiple working trees, i.e. via shared storage, then we 
2202
2098
        would probably want to lock both the local tree, and the branch.
2203
2099
        """
2204
2100
        raise NotImplementedError(self.unlock)
2205
2101
 
2206
 
    _marker = object()
2207
 
 
2208
 
    def update(self, change_reporter=None, possible_transports=None,
2209
 
               revision=None, old_tip=_marker):
 
2102
    def update(self, change_reporter=None, possible_transports=None):
2210
2103
        """Update a working tree along its branch.
2211
2104
 
2212
2105
        This will update the branch if its bound too, which means we have
2230
2123
        - Merge current state -> basis tree of the master w.r.t. the old tree
2231
2124
          basis.
2232
2125
        - Do a 'normal' merge of the old branch basis if it is relevant.
2233
 
 
2234
 
        :param revision: The target revision to update to. Must be in the
2235
 
            revision history.
2236
 
        :param old_tip: If branch.update() has already been run, the value it
2237
 
            returned (old tip of the branch or None). _marker is used
2238
 
            otherwise.
2239
2126
        """
2240
2127
        if self.branch.get_bound_location() is not None:
2241
2128
            self.lock_write()
2242
 
            update_branch = (old_tip is self._marker)
 
2129
            update_branch = True
2243
2130
        else:
2244
2131
            self.lock_tree_write()
2245
2132
            update_branch = False
2247
2134
            if update_branch:
2248
2135
                old_tip = self.branch.update(possible_transports)
2249
2136
            else:
2250
 
                if old_tip is self._marker:
2251
 
                    old_tip = None
2252
 
            return self._update_tree(old_tip, change_reporter, revision)
 
2137
                old_tip = None
 
2138
            return self._update_tree(old_tip, change_reporter)
2253
2139
        finally:
2254
2140
            self.unlock()
2255
2141
 
2256
2142
    @needs_tree_write_lock
2257
 
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
 
2143
    def _update_tree(self, old_tip=None, change_reporter=None):
2258
2144
        """Update a tree to the master branch.
2259
2145
 
2260
2146
        :param old_tip: if supplied, the previous tip revision the branch,
2266
2152
        # cant set that until we update the working trees last revision to be
2267
2153
        # one from the new branch, because it will just get absorbed by the
2268
2154
        # parent de-duplication logic.
2269
 
        #
 
2155
        # 
2270
2156
        # We MUST save it even if an error occurs, because otherwise the users
2271
2157
        # local work is unreferenced and will appear to have been lost.
2272
 
        #
2273
 
        nb_conflicts = 0
 
2158
        # 
 
2159
        result = 0
2274
2160
        try:
2275
2161
            last_rev = self.get_parent_ids()[0]
2276
2162
        except IndexError:
2277
2163
            last_rev = _mod_revision.NULL_REVISION
2278
 
        if revision is None:
2279
 
            revision = self.branch.last_revision()
2280
 
 
2281
 
        old_tip = old_tip or _mod_revision.NULL_REVISION
2282
 
 
2283
 
        if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2284
 
            # the branch we are bound to was updated
2285
 
            # merge those changes in first
2286
 
            base_tree  = self.basis_tree()
2287
 
            other_tree = self.branch.repository.revision_tree(old_tip)
2288
 
            nb_conflicts = merge.merge_inner(self.branch, other_tree,
2289
 
                                             base_tree, this_tree=self,
2290
 
                                             change_reporter=change_reporter)
2291
 
            if nb_conflicts:
2292
 
                self.add_parent_tree((old_tip, other_tree))
2293
 
                trace.note('Rerun update after fixing the conflicts.')
2294
 
                return nb_conflicts
2295
 
 
2296
 
        if last_rev != _mod_revision.ensure_null(revision):
2297
 
            # the working tree is up to date with the branch
2298
 
            # we can merge the specified revision from master
2299
 
            to_tree = self.branch.repository.revision_tree(revision)
2300
 
            to_root_id = to_tree.get_root_id()
2301
 
 
 
2164
        if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
 
2165
            # merge tree state up to new branch tip.
2302
2166
            basis = self.basis_tree()
2303
2167
            basis.lock_read()
2304
2168
            try:
2305
 
                if (basis.inventory.root is None
2306
 
                    or basis.inventory.root.file_id != to_root_id):
2307
 
                    self.set_root_id(to_root_id)
 
2169
                to_tree = self.branch.basis_tree()
 
2170
                if basis.inventory.root is None:
 
2171
                    self.set_root_id(to_tree.get_root_id())
2308
2172
                    self.flush()
 
2173
                result += merge.merge_inner(
 
2174
                                      self.branch,
 
2175
                                      to_tree,
 
2176
                                      basis,
 
2177
                                      this_tree=self,
 
2178
                                      change_reporter=change_reporter)
2309
2179
            finally:
2310
2180
                basis.unlock()
2311
 
 
2312
 
            # determine the branch point
2313
 
            graph = self.branch.repository.get_graph()
2314
 
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2315
 
                                                last_rev)
2316
 
            base_tree = self.branch.repository.revision_tree(base_rev_id)
2317
 
 
2318
 
            nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2319
 
                                             this_tree=self,
2320
 
                                             change_reporter=change_reporter)
2321
 
            self.set_last_revision(revision)
2322
2181
            # TODO - dedup parents list with things merged by pull ?
2323
2182
            # reuse the tree we've updated to to set the basis:
2324
 
            parent_trees = [(revision, to_tree)]
 
2183
            parent_trees = [(self.branch.last_revision(), to_tree)]
2325
2184
            merges = self.get_parent_ids()[1:]
2326
2185
            # Ideally we ask the tree for the trees here, that way the working
2327
 
            # tree can decide whether to give us the entire tree or give us a
 
2186
            # tree can decide whether to give us teh entire tree or give us a
2328
2187
            # lazy initialised tree. dirstate for instance will have the trees
2329
2188
            # in ram already, whereas a last-revision + basis-inventory tree
2330
2189
            # will not, but also does not need them when setting parents.
2331
2190
            for parent in merges:
2332
2191
                parent_trees.append(
2333
2192
                    (parent, self.branch.repository.revision_tree(parent)))
2334
 
            if not _mod_revision.is_null(old_tip):
 
2193
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2335
2194
                parent_trees.append(
2336
2195
                    (old_tip, self.branch.repository.revision_tree(old_tip)))
2337
2196
            self.set_parent_trees(parent_trees)
2338
2197
            last_rev = parent_trees[0][0]
2339
 
        return nb_conflicts
 
2198
        else:
 
2199
            # the working tree had the same last-revision as the master
 
2200
            # branch did. We may still have pivot local work from the local
 
2201
            # branch into old_tip:
 
2202
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
 
2203
                self.add_parent_tree_id(old_tip)
 
2204
        if (old_tip is not None and not _mod_revision.is_null(old_tip)
 
2205
            and old_tip != last_rev):
 
2206
            # our last revision was not the prior branch last revision
 
2207
            # and we have converted that last revision to a pending merge.
 
2208
            # base is somewhere between the branch tip now
 
2209
            # and the now pending merge
 
2210
 
 
2211
            # Since we just modified the working tree and inventory, flush out
 
2212
            # the current state, before we modify it again.
 
2213
            # TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
 
2214
            #       requires it only because TreeTransform directly munges the
 
2215
            #       inventory and calls tree._write_inventory(). Ultimately we
 
2216
            #       should be able to remove this extra flush.
 
2217
            self.flush()
 
2218
            graph = self.branch.repository.get_graph()
 
2219
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
 
2220
                                                old_tip)
 
2221
            base_tree = self.branch.repository.revision_tree(base_rev_id)
 
2222
            other_tree = self.branch.repository.revision_tree(old_tip)
 
2223
            result += merge.merge_inner(
 
2224
                                  self.branch,
 
2225
                                  other_tree,
 
2226
                                  base_tree,
 
2227
                                  this_tree=self,
 
2228
                                  change_reporter=change_reporter)
 
2229
        return result
2340
2230
 
2341
2231
    def _write_hashcache_if_dirty(self):
2342
2232
        """Write out the hashcache if it is dirty."""
2442
2332
                    bzrdir_loc = bisect_left(cur_disk_dir_content,
2443
2333
                        ('.bzr', '.bzr'))
2444
2334
                    if (bzrdir_loc < len(cur_disk_dir_content)
2445
 
                        and self.bzrdir.is_control_filename(
2446
 
                            cur_disk_dir_content[bzrdir_loc][0])):
 
2335
                        and cur_disk_dir_content[bzrdir_loc][0] == '.bzr'):
2447
2336
                        # we dont yield the contents of, or, .bzr itself.
2448
2337
                        del cur_disk_dir_content[bzrdir_loc]
2449
2338
            if inv_finished:
2583
2472
        return un_resolved, resolved
2584
2473
 
2585
2474
    @needs_read_lock
2586
 
    def _check(self, references):
2587
 
        """Check the tree for consistency.
2588
 
 
2589
 
        :param references: A dict with keys matching the items returned by
2590
 
            self._get_check_refs(), and values from looking those keys up in
2591
 
            the repository.
2592
 
        """
 
2475
    def _check(self):
2593
2476
        tree_basis = self.basis_tree()
2594
2477
        tree_basis.lock_read()
2595
2478
        try:
2596
 
            repo_basis = references[('trees', self.last_revision())]
 
2479
            repo_basis = self.branch.repository.revision_tree(
 
2480
                self.last_revision())
2597
2481
            if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2598
2482
                raise errors.BzrCheckError(
2599
2483
                    "Mismatched basis inventory content.")
2612
2496
        """
2613
2497
        return
2614
2498
 
 
2499
    @needs_read_lock
2615
2500
    def _get_rules_searcher(self, default_searcher):
2616
2501
        """See Tree._get_rules_searcher."""
2617
2502
        if self._rules_searcher is None:
2619
2504
                self)._get_rules_searcher(default_searcher)
2620
2505
        return self._rules_searcher
2621
2506
 
2622
 
    def get_shelf_manager(self):
2623
 
        """Return the ShelfManager for this WorkingTree."""
2624
 
        from bzrlib.shelf import ShelfManager
2625
 
        return ShelfManager(self, self._transport)
2626
 
 
2627
2507
 
2628
2508
class WorkingTree2(WorkingTree):
2629
2509
    """This is the Format 2 working tree.
2630
2510
 
2631
 
    This was the first weave based working tree.
 
2511
    This was the first weave based working tree. 
2632
2512
     - uses os locks for locking.
2633
2513
     - uses the branch last-revision.
2634
2514
    """
2644
2524
        if self._inventory is None:
2645
2525
            self.read_working_inventory()
2646
2526
 
2647
 
    def _get_check_refs(self):
2648
 
        """Return the references needed to perform a check of this tree."""
2649
 
        return [('trees', self.last_revision())]
2650
 
 
2651
2527
    def lock_tree_write(self):
2652
2528
        """See WorkingTree.lock_tree_write().
2653
2529
 
2654
2530
        In Format2 WorkingTrees we have a single lock for the branch and tree
2655
2531
        so lock_tree_write() degrades to lock_write().
2656
 
 
2657
 
        :return: An object with an unlock method which will release the lock
2658
 
            obtained.
2659
2532
        """
2660
2533
        self.branch.lock_write()
2661
2534
        try:
2662
 
            self._control_files.lock_write()
2663
 
            return self
 
2535
            return self._control_files.lock_write()
2664
2536
        except:
2665
2537
            self.branch.unlock()
2666
2538
            raise
2675
2547
            if self._inventory_is_modified:
2676
2548
                self.flush()
2677
2549
            self._write_hashcache_if_dirty()
2678
 
 
 
2550
                    
2679
2551
        # reverse order of locking.
2680
2552
        try:
2681
2553
            return self._control_files.unlock()
2703
2575
 
2704
2576
    def _change_last_revision(self, revision_id):
2705
2577
        """See WorkingTree._change_last_revision."""
2706
 
        if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
 
2578
        if revision_id is None or revision_id == NULL_REVISION:
2707
2579
            try:
2708
2580
                self._transport.delete('last-revision')
2709
2581
            except errors.NoSuchFile:
2711
2583
            return False
2712
2584
        else:
2713
2585
            self._transport.put_bytes('last-revision', revision_id,
2714
 
                mode=self.bzrdir._get_file_mode())
 
2586
                mode=self._control_files._file_mode)
2715
2587
            return True
2716
2588
 
2717
 
    def _get_check_refs(self):
2718
 
        """Return the references needed to perform a check of this tree."""
2719
 
        return [('trees', self.last_revision())]
2720
 
 
2721
2589
    @needs_tree_write_lock
2722
2590
    def set_conflicts(self, conflicts):
2723
 
        self._put_rio('conflicts', conflicts.to_stanzas(),
 
2591
        self._put_rio('conflicts', conflicts.to_stanzas(), 
2724
2592
                      CONFLICT_HEADER_1)
2725
2593
 
2726
2594
    @needs_tree_write_lock
2775
2643
     * a format string,
2776
2644
     * an open routine.
2777
2645
 
2778
 
    Formats are placed in an dict by their format string for reference
 
2646
    Formats are placed in an dict by their format string for reference 
2779
2647
    during workingtree opening. Its not required that these be instances, they
2780
 
    can be classes themselves with class methods - it simply depends on
 
2648
    can be classes themselves with class methods - it simply depends on 
2781
2649
    whether state is needed for a given format or not.
2782
2650
 
2783
2651
    Once a format is deprecated, just deprecate the initialize and open
2784
 
    methods on the format class. Do not deprecate the object, as the
 
2652
    methods on the format class. Do not deprecate the object, as the 
2785
2653
    object will be created every time regardless.
2786
2654
    """
2787
2655
 
2800
2668
        """Return the format for the working tree object in a_bzrdir."""
2801
2669
        try:
2802
2670
            transport = a_bzrdir.get_workingtree_transport(None)
2803
 
            format_string = transport.get_bytes("format")
 
2671
            format_string = transport.get("format").read()
2804
2672
            return klass._formats[format_string]
2805
2673
        except errors.NoSuchFile:
2806
2674
            raise errors.NoWorkingTree(base=transport.base)
2831
2699
        """Is this format supported?
2832
2700
 
2833
2701
        Supported formats can be initialized and opened.
2834
 
        Unsupported formats may not support initialization or committing or
 
2702
        Unsupported formats may not support initialization or committing or 
2835
2703
        some other features depending on the reason for not being supported.
2836
2704
        """
2837
2705
        return True
2838
2706
 
2839
 
    def supports_content_filtering(self):
2840
 
        """True if this format supports content filtering."""
2841
 
        return False
2842
 
 
2843
 
    def supports_views(self):
2844
 
        """True if this format supports stored views."""
2845
 
        return False
2846
 
 
2847
2707
    @classmethod
2848
2708
    def register_format(klass, format):
2849
2709
        klass._formats[format.get_format_string()] = format
2858
2718
 
2859
2719
 
2860
2720
class WorkingTreeFormat2(WorkingTreeFormat):
2861
 
    """The second working tree format.
 
2721
    """The second working tree format. 
2862
2722
 
2863
2723
    This format modified the hash cache from the format 1 hash cache.
2864
2724
    """
2877
2737
        no working tree.  (See bug #43064).
2878
2738
        """
2879
2739
        sio = StringIO()
2880
 
        inv = inventory.Inventory()
 
2740
        inv = Inventory()
2881
2741
        xml5.serializer_v5.write_inventory(inv, sio, working=True)
2882
2742
        sio.seek(0)
2883
2743
        transport.put_file('inventory', sio, file_mode)
2899
2759
            branch.generate_revision_history(revision_id)
2900
2760
        finally:
2901
2761
            branch.unlock()
2902
 
        inv = inventory.Inventory()
 
2762
        inv = Inventory()
2903
2763
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2904
2764
                         branch,
2905
2765
                         inv,
2950
2810
        - is new in bzr 0.8
2951
2811
        - uses a LockDir to guard access for writes.
2952
2812
    """
2953
 
 
 
2813
    
2954
2814
    upgrade_recommended = True
2955
2815
 
2956
2816
    def get_format_string(self):
2973
2833
 
2974
2834
    def _open_control_files(self, a_bzrdir):
2975
2835
        transport = a_bzrdir.get_workingtree_transport(None)
2976
 
        return LockableFiles(transport, self._lock_file_name,
 
2836
        return LockableFiles(transport, self._lock_file_name, 
2977
2837
                             self._lock_class)
2978
2838
 
2979
2839
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2980
2840
                   accelerator_tree=None, hardlink=False):
2981
2841
        """See WorkingTreeFormat.initialize().
2982
 
 
 
2842
        
2983
2843
        :param revision_id: if supplied, create a working tree at a different
2984
2844
            revision than the branch is at.
2985
2845
        :param accelerator_tree: A tree which can be used for retrieving file
2996
2856
        control_files.create_lock()
2997
2857
        control_files.lock_write()
2998
2858
        transport.put_bytes('format', self.get_format_string(),
2999
 
            mode=a_bzrdir._get_file_mode())
 
2859
            mode=control_files._file_mode)
3000
2860
        if from_branch is not None:
3001
2861
            branch = from_branch
3002
2862
        else:
3022
2882
            # only set an explicit root id if there is one to set.
3023
2883
            if basis_tree.inventory.root is not None:
3024
2884
                wt.set_root_id(basis_tree.get_root_id())
3025
 
            if revision_id == _mod_revision.NULL_REVISION:
 
2885
            if revision_id == NULL_REVISION:
3026
2886
                wt.set_parent_trees([])
3027
2887
            else:
3028
2888
                wt.set_parent_trees([(revision_id, basis_tree)])
3035
2895
        return wt
3036
2896
 
3037
2897
    def _initial_inventory(self):
3038
 
        return inventory.Inventory()
 
2898
        return Inventory()
3039
2899
 
3040
2900
    def __init__(self):
3041
2901
        super(WorkingTreeFormat3, self).__init__()
3056
2916
 
3057
2917
    def _open(self, a_bzrdir, control_files):
3058
2918
        """Open the tree itself.
3059
 
 
 
2919
        
3060
2920
        :param a_bzrdir: the dir for the tree.
3061
2921
        :param control_files: the control files for the tree.
3062
2922
        """
3070
2930
        return self.get_format_string()
3071
2931
 
3072
2932
 
3073
 
__default_format = WorkingTreeFormat6()
 
2933
__default_format = WorkingTreeFormat4()
3074
2934
WorkingTreeFormat.register_format(__default_format)
3075
 
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3076
 
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3077
2935
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3078
2936
WorkingTreeFormat.set_default_format(__default_format)
3079
2937
# formats which have no format string are not discoverable