/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Andrew Bennetts
  • Date: 2008-10-30 01:05:59 UTC
  • mto: This revision was merged to the branch mainline in revision 3813.
  • Revision ID: andrew.bennetts@canonical.com-20081030010559-tumoefnsmhg4snxo
Add contrib/bzr_ssh_path_limiter.

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.lock import LogicalLockResult
81
 
from bzrlib.lockable_files import LockableFiles
 
87
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
 
88
from bzrlib.lockable_files import LockableFiles, TransportLock
82
89
from bzrlib.lockdir import LockDir
83
90
import bzrlib.mutabletree
84
91
from bzrlib.mutabletree import needs_tree_write_lock
85
92
from bzrlib import osutils
86
93
from bzrlib.osutils import (
 
94
    compact_date,
87
95
    file_kind,
88
96
    isdir,
89
97
    normpath,
90
98
    pathjoin,
 
99
    rand_chars,
91
100
    realpath,
92
101
    safe_unicode,
93
102
    splitpath,
94
103
    supports_executable,
95
104
    )
96
 
from bzrlib.filters import filtered_input_file
97
105
from bzrlib.trace import mutter, note
98
106
from bzrlib.transport.local import LocalTransport
99
 
from bzrlib.revision import CURRENT_REVISION
 
107
from bzrlib.progress import DummyProgress, ProgressPhase
 
108
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
100
109
from bzrlib.rio import RioReader, rio_file, Stanza
101
 
from bzrlib.symbol_versioning import (
102
 
    deprecated_passed,
103
 
    DEPRECATED_PARAMETER,
104
 
    )
 
110
from bzrlib.symbol_versioning import (deprecated_passed,
 
111
        deprecated_method,
 
112
        deprecated_function,
 
113
        DEPRECATED_PARAMETER,
 
114
        )
105
115
 
106
116
 
107
117
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
108
 
# TODO: Modifying the conflict objects or their type is currently nearly
109
 
# impossible as there is no clear relationship between the working tree format
110
 
# and the conflict list file format.
111
118
CONFLICT_HEADER_1 = "BZR conflict list format 1"
112
119
 
113
120
ERROR_PATH_NOT_FOUND = 3    # WindowsError errno code, equivalent to ENOENT
116
123
class TreeEntry(object):
117
124
    """An entry that implements the minimum interface used by commands.
118
125
 
119
 
    This needs further inspection, it may be better to have
 
126
    This needs further inspection, it may be better to have 
120
127
    InventoryEntries without ids - though that seems wrong. For now,
121
128
    this is a parallel hierarchy to InventoryEntry, and needs to become
122
129
    one of several things: decorates to that hierarchy, children of, or
125
132
    no InventoryEntry available - i.e. for unversioned objects.
126
133
    Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
127
134
    """
128
 
 
 
135
 
129
136
    def __eq__(self, other):
130
137
        # yes, this us ugly, TODO: best practice __eq__ style.
131
138
        return (isinstance(other, TreeEntry)
132
139
                and other.__class__ == self.__class__)
133
 
 
 
140
 
134
141
    def kind_character(self):
135
142
        return "???"
136
143
 
168
175
        return ''
169
176
 
170
177
 
171
 
class WorkingTree(bzrlib.mutabletree.MutableTree,
172
 
    bzrdir.ControlComponent):
 
178
class WorkingTree(bzrlib.mutabletree.MutableTree):
173
179
    """Working copy tree.
174
180
 
175
181
    The inventory is held in the `Branch` working-inventory, and the
179
185
    not listed in the Inventory and vice versa.
180
186
    """
181
187
 
182
 
    # override this to set the strategy for storing views
183
 
    def _make_views(self):
184
 
        return views.DisabledViews(self)
185
 
 
186
188
    def __init__(self, basedir='.',
187
189
                 branch=DEPRECATED_PARAMETER,
188
190
                 _inventory=None,
223
225
        wt_trans = self.bzrdir.get_workingtree_transport(None)
224
226
        cache_filename = wt_trans.local_abspath('stat-cache')
225
227
        self._hashcache = hashcache.HashCache(basedir, cache_filename,
226
 
            self.bzrdir._get_file_mode(),
227
 
            self._content_filter_stack_provider())
 
228
            self.bzrdir._get_file_mode())
228
229
        hc = self._hashcache
229
230
        hc.read()
230
231
        # is this scan needed ? it makes things kinda slow.
246
247
            self._set_inventory(_inventory, dirty=False)
247
248
        self._detect_case_handling()
248
249
        self._rules_searcher = None
249
 
        self.views = self._make_views()
250
 
 
251
 
    @property
252
 
    def user_transport(self):
253
 
        return self.bzrdir.user_transport
254
 
 
255
 
    @property
256
 
    def control_transport(self):
257
 
        return self._transport
258
250
 
259
251
    def _detect_case_handling(self):
260
252
        wt_trans = self.bzrdir.get_workingtree_transport(None)
286
278
        self._control_files.break_lock()
287
279
        self.branch.break_lock()
288
280
 
289
 
    def _get_check_refs(self):
290
 
        """Return the references needed to perform a check of this tree.
291
 
        
292
 
        The default implementation returns no refs, and is only suitable for
293
 
        trees that have no local caching and can commit on ghosts at any time.
294
 
 
295
 
        :seealso: bzrlib.check for details about check_refs.
296
 
        """
297
 
        return []
298
 
 
299
281
    def requires_rich_root(self):
300
282
        return self._format.requires_rich_root
301
283
 
302
284
    def supports_tree_reference(self):
303
285
        return False
304
286
 
305
 
    def supports_content_filtering(self):
306
 
        return self._format.supports_content_filtering()
307
 
 
308
 
    def supports_views(self):
309
 
        return self.views.supports_views()
310
 
 
311
287
    def _set_inventory(self, inv, dirty):
312
288
        """Set the internal cached inventory.
313
289
 
401
377
 
402
378
    def basis_tree(self):
403
379
        """Return RevisionTree for the current last revision.
404
 
 
 
380
        
405
381
        If the left most parent is a ghost then the returned tree will be an
406
 
        empty tree - one obtained by calling
 
382
        empty tree - one obtained by calling 
407
383
        repository.revision_tree(NULL_REVISION).
408
384
        """
409
385
        try:
425
401
            return self.branch.repository.revision_tree(revision_id)
426
402
        except (errors.RevisionNotPresent, errors.NoSuchRevision):
427
403
            # the basis tree *may* be a ghost or a low level error may have
428
 
            # occurred. If the revision is present, its a problem, if its not
 
404
            # occured. If the revision is present, its a problem, if its not
429
405
            # its a ghost.
430
406
            if self.branch.repository.has_revision(revision_id):
431
407
                raise
438
414
 
439
415
    def relpath(self, path):
440
416
        """Return the local path portion from a given path.
441
 
 
442
 
        The path may be absolute or relative. If its a relative path it is
 
417
        
 
418
        The path may be absolute or relative. If its a relative path it is 
443
419
        interpreted relative to the python current working directory.
444
420
        """
445
421
        return osutils.relpath(self.basedir, path)
447
423
    def has_filename(self, filename):
448
424
        return osutils.lexists(self.abspath(filename))
449
425
 
450
 
    def get_file(self, file_id, path=None, filtered=True):
451
 
        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]
452
428
 
453
 
    def get_file_with_stat(self, file_id, path=None, filtered=True,
454
 
        _fstat=os.fstat):
455
 
        """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."""
456
431
        if path is None:
457
432
            path = self.id2path(file_id)
458
 
        file_obj = self.get_file_byname(path, filtered=False)
459
 
        stat_value = _fstat(file_obj.fileno())
460
 
        if filtered and self.supports_content_filtering():
461
 
            filters = self._content_filter_stack(path)
462
 
            file_obj = filtered_input_file(file_obj, filters)
463
 
        return (file_obj, stat_value)
464
 
 
465
 
    def get_file_text(self, file_id, path=None, filtered=True):
466
 
        return self.get_file(file_id, path=path, filtered=filtered).read()
467
 
 
468
 
    def get_file_byname(self, filename, filtered=True):
469
 
        path = self.abspath(filename)
470
 
        f = file(path, 'rb')
471
 
        if filtered and self.supports_content_filtering():
472
 
            filters = self._content_filter_stack(filename)
473
 
            return filtered_input_file(f, filters)
474
 
        else:
475
 
            return f
476
 
 
477
 
    def get_file_lines(self, file_id, path=None, filtered=True):
 
433
        file_obj = self.get_file_byname(path)
 
434
        return (file_obj, _fstat(file_obj.fileno()))
 
435
 
 
436
    def get_file_byname(self, filename):
 
437
        return file(self.abspath(filename), 'rb')
 
438
 
 
439
    def get_file_lines(self, file_id, path=None):
478
440
        """See Tree.get_file_lines()"""
479
 
        file = self.get_file(file_id, path, filtered=filtered)
 
441
        file = self.get_file(file_id, path)
480
442
        try:
481
443
            return file.readlines()
482
444
        finally:
493
455
        incorrectly attributed to CURRENT_REVISION (but after committing, the
494
456
        attribution will be correct).
495
457
        """
496
 
        maybe_file_parent_keys = []
497
 
        for parent_id in self.get_parent_ids():
498
 
            try:
499
 
                parent_tree = self.revision_tree(parent_id)
500
 
            except errors.NoSuchRevisionInTree:
501
 
                parent_tree = self.branch.repository.revision_tree(parent_id)
502
 
            parent_tree.lock_read()
503
 
            try:
504
 
                if file_id not in parent_tree:
505
 
                    continue
506
 
                ie = parent_tree.inventory[file_id]
507
 
                if ie.kind != 'file':
508
 
                    # Note: this is slightly unnecessary, because symlinks and
509
 
                    # directories have a "text" which is the empty text, and we
510
 
                    # know that won't mess up annotations. But it seems cleaner
511
 
                    continue
512
 
                parent_text_key = (file_id, ie.revision)
513
 
                if parent_text_key not in maybe_file_parent_keys:
514
 
                    maybe_file_parent_keys.append(parent_text_key)
515
 
            finally:
516
 
                parent_tree.unlock()
517
 
        graph = _mod_graph.Graph(self.branch.repository.texts)
518
 
        heads = graph.heads(maybe_file_parent_keys)
519
 
        file_parent_keys = []
520
 
        for key in maybe_file_parent_keys:
521
 
            if key in heads:
522
 
                file_parent_keys.append(key)
523
 
 
524
 
        # Now we have the parents of this content
525
 
        annotator = self.branch.repository.texts.get_annotator()
526
 
        text = self.get_file(file_id).read()
527
 
        this_key =(file_id, default_revision)
528
 
        annotator.add_special_text(this_key, file_parent_keys, text)
529
 
        annotations = [(key[-1], line)
530
 
                       for key, line in annotator.annotate_flat(this_key)]
531
 
        return annotations
 
458
        basis = self.basis_tree()
 
459
        basis.lock_read()
 
460
        try:
 
461
            changes = self.iter_changes(basis, True, [self.id2path(file_id)],
 
462
                require_versioned=True).next()
 
463
            changed_content, kind = changes[2], changes[6]
 
464
            if not changed_content:
 
465
                return basis.annotate_iter(file_id)
 
466
            if kind[1] is None:
 
467
                return None
 
468
            import annotate
 
469
            if kind[0] != 'file':
 
470
                old_lines = []
 
471
            else:
 
472
                old_lines = list(basis.annotate_iter(file_id))
 
473
            old = [old_lines]
 
474
            for tree in self.branch.repository.revision_trees(
 
475
                self.get_parent_ids()[1:]):
 
476
                if file_id not in tree:
 
477
                    continue
 
478
                old.append(list(tree.annotate_iter(file_id)))
 
479
            return annotate.reannotate(old, self.get_file(file_id).readlines(),
 
480
                                       default_revision)
 
481
        finally:
 
482
            basis.unlock()
532
483
 
533
484
    def _get_ancestors(self, default_revision):
534
485
        ancestors = set([default_revision])
539
490
 
540
491
    def get_parent_ids(self):
541
492
        """See Tree.get_parent_ids.
542
 
 
 
493
        
543
494
        This implementation reads the pending merges list and last_revision
544
495
        value and uses that to decide what the parents list should be.
545
496
        """
549
500
        else:
550
501
            parents = [last_rev]
551
502
        try:
552
 
            merges_bytes = self._transport.get_bytes('pending-merges')
 
503
            merges_file = self._transport.get('pending-merges')
553
504
        except errors.NoSuchFile:
554
505
            pass
555
506
        else:
556
 
            for l in osutils.split_lines(merges_bytes):
 
507
            for l in merges_file.readlines():
557
508
                revision_id = l.rstrip('\n')
558
509
                parents.append(revision_id)
559
510
        return parents
562
513
    def get_root_id(self):
563
514
        """Return the id of this trees root"""
564
515
        return self._inventory.root.file_id
565
 
 
 
516
        
566
517
    def _get_store_filename(self, file_id):
567
518
        ## XXX: badly named; this is not in the store at all
568
519
        return self.abspath(self.id2path(file_id))
570
521
    @needs_read_lock
571
522
    def clone(self, to_bzrdir, revision_id=None):
572
523
        """Duplicate this working tree into to_bzr, including all state.
573
 
 
 
524
        
574
525
        Specifically modified files are kept as modified, but
575
526
        ignored and unknown files are discarded.
576
527
 
577
528
        If you want to make a new line of development, see bzrdir.sprout()
578
529
 
579
530
        revision
580
 
            If not None, the cloned tree will have its last revision set to
581
 
            revision, and difference between the source trees last revision
 
531
            If not None, the cloned tree will have its last revision set to 
 
532
            revision, and and difference between the source trees last revision
582
533
            and this one merged in.
583
534
        """
584
535
        # assumes the target bzr dir format is compatible.
618
569
 
619
570
    def get_file_size(self, file_id):
620
571
        """See Tree.get_file_size"""
621
 
        # XXX: this returns the on-disk size; it should probably return the
622
 
        # canonical size
623
572
        try:
624
573
            return os.path.getsize(self.id2abspath(file_id))
625
574
        except OSError, e:
641
590
 
642
591
    def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
643
592
        file_id = self.path2id(path)
644
 
        if file_id is None:
645
 
            # For unversioned files on win32, we just assume they are not
646
 
            # executable
647
 
            return False
648
593
        return self._inventory[file_id].executable
649
594
 
650
595
    def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
672
617
        """See MutableTree._add."""
673
618
        # TODO: Re-adding a file that is removed in the working copy
674
619
        # should probably put it back with the previous ID.
675
 
        # the read and write working inventory should not occur in this
 
620
        # the read and write working inventory should not occur in this 
676
621
        # function - they should be part of lock_write and unlock.
677
622
        inv = self.inventory
678
623
        for f, file_id, kind in zip(files, ids, kinds):
760
705
            raise
761
706
        kind = _mapper(stat_result.st_mode)
762
707
        if kind == 'file':
763
 
            return self._file_content_summary(path, stat_result)
 
708
            size = stat_result.st_size
 
709
            # try for a stat cache lookup
 
710
            executable = self._is_executable_from_path_and_stat(path, stat_result)
 
711
            return (kind, size, executable, self._sha_from_stat(
 
712
                path, stat_result))
764
713
        elif kind == 'directory':
765
714
            # perhaps it looks like a plain directory, but it's really a
766
715
            # reference.
768
717
                kind = 'tree-reference'
769
718
            return kind, None, None, None
770
719
        elif kind == 'symlink':
771
 
            target = osutils.readlink(abspath)
772
 
            return ('symlink', None, None, target)
 
720
            return ('symlink', None, None, os.readlink(abspath))
773
721
        else:
774
722
            return (kind, None, None, None)
775
723
 
776
 
    def _file_content_summary(self, path, stat_result):
777
 
        size = stat_result.st_size
778
 
        executable = self._is_executable_from_path_and_stat(path, stat_result)
779
 
        # try for a stat cache lookup
780
 
        return ('file', size, executable, self._sha_from_stat(
781
 
            path, stat_result))
782
 
 
783
724
    def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
784
725
        """Common ghost checking functionality from set_parent_*.
785
726
 
795
736
    def _set_merges_from_parent_ids(self, parent_ids):
796
737
        merges = parent_ids[1:]
797
738
        self._transport.put_bytes('pending-merges', '\n'.join(merges),
798
 
            mode=self.bzrdir._get_file_mode())
 
739
            mode=self._control_files._file_mode)
799
740
 
800
741
    def _filter_parent_ids_by_ancestry(self, revision_ids):
801
742
        """Check that all merged revisions are proper 'heads'.
802
743
 
803
744
        This will always return the first revision_id, and any merged revisions
804
 
        which are
 
745
        which are 
805
746
        """
806
747
        if len(revision_ids) == 0:
807
748
            return revision_ids
819
760
    @needs_tree_write_lock
820
761
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
821
762
        """Set the parent ids to revision_ids.
822
 
 
 
763
        
823
764
        See also set_parent_trees. This api will try to retrieve the tree data
824
765
        for each element of revision_ids from the trees repository. If you have
825
766
        tree data already available, it is more efficient to use
901
842
        self._must_be_locked()
902
843
        my_file = rio_file(stanzas, header)
903
844
        self._transport.put_file(filename, my_file,
904
 
            mode=self.bzrdir._get_file_mode())
 
845
            mode=self._control_files._file_mode)
905
846
 
906
847
    @needs_write_lock # because merge pulls data into the branch.
907
848
    def merge_from_branch(self, branch, to_revision=None, from_revision=None,
908
 
                          merge_type=None, force=False):
 
849
        merge_type=None):
909
850
        """Merge from a branch into this working tree.
910
851
 
911
852
        :param branch: The branch to merge from.
915
856
            branch.last_revision().
916
857
        """
917
858
        from bzrlib.merge import Merger, Merge3Merger
918
 
        merger = Merger(self.branch, this_tree=self)
919
 
        # check that there are no local alterations
920
 
        if not force and self.has_changes():
921
 
            raise errors.UncommittedChanges(self)
922
 
        if to_revision is None:
923
 
            to_revision = _mod_revision.ensure_null(branch.last_revision())
924
 
        merger.other_rev_id = to_revision
925
 
        if _mod_revision.is_null(merger.other_rev_id):
926
 
            raise errors.NoCommits(branch)
927
 
        self.branch.fetch(branch, last_revision=merger.other_rev_id)
928
 
        merger.other_basis = merger.other_rev_id
929
 
        merger.other_tree = self.branch.repository.revision_tree(
930
 
            merger.other_rev_id)
931
 
        merger.other_branch = branch
932
 
        if from_revision is None:
933
 
            merger.find_base()
934
 
        else:
935
 
            merger.set_base_revision(from_revision, branch)
936
 
        if merger.base_rev_id == merger.other_rev_id:
937
 
            raise errors.PointlessMerge
938
 
        merger.backup_files = False
939
 
        if merge_type is None:
940
 
            merger.merge_type = Merge3Merger
941
 
        else:
942
 
            merger.merge_type = merge_type
943
 
        merger.set_interesting_files(None)
944
 
        merger.show_base = False
945
 
        merger.reprocess = False
946
 
        conflicts = merger.do_merge()
947
 
        merger.set_pending()
 
859
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
860
        try:
 
861
            merger = Merger(self.branch, this_tree=self, pb=pb)
 
862
            merger.pp = ProgressPhase("Merge phase", 5, pb)
 
863
            merger.pp.next_phase()
 
864
            # check that there are no
 
865
            # local alterations
 
866
            merger.check_basis(check_clean=True, require_commits=False)
 
867
            if to_revision is None:
 
868
                to_revision = _mod_revision.ensure_null(branch.last_revision())
 
869
            merger.other_rev_id = to_revision
 
870
            if _mod_revision.is_null(merger.other_rev_id):
 
871
                raise errors.NoCommits(branch)
 
872
            self.branch.fetch(branch, last_revision=merger.other_rev_id)
 
873
            merger.other_basis = merger.other_rev_id
 
874
            merger.other_tree = self.branch.repository.revision_tree(
 
875
                merger.other_rev_id)
 
876
            merger.other_branch = branch
 
877
            merger.pp.next_phase()
 
878
            if from_revision is None:
 
879
                merger.find_base()
 
880
            else:
 
881
                merger.set_base_revision(from_revision, branch)
 
882
            if merger.base_rev_id == merger.other_rev_id:
 
883
                raise errors.PointlessMerge
 
884
            merger.backup_files = False
 
885
            if merge_type is None:
 
886
                merger.merge_type = Merge3Merger
 
887
            else:
 
888
                merger.merge_type = merge_type
 
889
            merger.set_interesting_files(None)
 
890
            merger.show_base = False
 
891
            merger.reprocess = False
 
892
            conflicts = merger.do_merge()
 
893
            merger.set_pending()
 
894
        finally:
 
895
            pb.finished()
948
896
        return conflicts
949
897
 
950
898
    @needs_read_lock
951
899
    def merge_modified(self):
952
900
        """Return a dictionary of files modified by a merge.
953
901
 
954
 
        The list is initialized by WorkingTree.set_merge_modified, which is
 
902
        The list is initialized by WorkingTree.set_merge_modified, which is 
955
903
        typically called after we make some automatic updates to the tree
956
904
        because of a merge.
957
905
 
991
939
        return file_id
992
940
 
993
941
    def get_symlink_target(self, file_id):
994
 
        abspath = self.id2abspath(file_id)
995
 
        target = osutils.readlink(abspath)
996
 
        return target
 
942
        return os.readlink(self.id2abspath(file_id))
997
943
 
998
944
    @needs_write_lock
999
945
    def subsume(self, other_tree):
1049
995
        return False
1050
996
 
1051
997
    def _directory_may_be_tree_reference(self, relpath):
1052
 
        # as a special case, if a directory contains control files then
 
998
        # as a special case, if a directory contains control files then 
1053
999
        # it's a tree reference, except that the root of the tree is not
1054
1000
        return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1055
1001
        # TODO: We could ask all the control formats whether they
1066
1012
    @needs_tree_write_lock
1067
1013
    def extract(self, file_id, format=None):
1068
1014
        """Extract a subtree from this tree.
1069
 
 
 
1015
        
1070
1016
        A new branch will be created, relative to the path for this tree.
1071
1017
        """
1072
1018
        self.flush()
1077
1023
                transport = transport.clone(name)
1078
1024
                transport.ensure_base()
1079
1025
            return transport
1080
 
 
 
1026
            
1081
1027
        sub_path = self.id2path(file_id)
1082
1028
        branch_transport = mkdirs(sub_path)
1083
1029
        if format is None:
1097
1043
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
1098
1044
        if tree_transport.base != branch_transport.base:
1099
1045
            tree_bzrdir = format.initialize_on_transport(tree_transport)
1100
 
            branch.BranchReferenceFormat().initialize(tree_bzrdir,
1101
 
                target_branch=new_branch)
 
1046
            branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1102
1047
        else:
1103
1048
            tree_bzrdir = branch_bzrdir
1104
 
        wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
 
1049
        wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1105
1050
        wt.set_parent_ids(self.get_parent_ids())
1106
1051
        my_inv = self.inventory
1107
 
        child_inv = inventory.Inventory(root_id=None)
 
1052
        child_inv = Inventory(root_id=None)
1108
1053
        new_root = my_inv[file_id]
1109
1054
        my_inv.remove_recursive_id(file_id)
1110
1055
        new_root.parent_id = None
1129
1074
        self._serialize(self._inventory, sio)
1130
1075
        sio.seek(0)
1131
1076
        self._transport.put_file('inventory', sio,
1132
 
            mode=self.bzrdir._get_file_mode())
 
1077
            mode=self._control_files._file_mode)
1133
1078
        self._inventory_is_modified = False
1134
1079
 
1135
1080
    def _kind(self, relpath):
1136
1081
        return osutils.file_kind(self.abspath(relpath))
1137
1082
 
1138
 
    def list_files(self, include_root=False, from_dir=None, recursive=True):
1139
 
        """List all files as (path, class, kind, id, entry).
 
1083
    def list_files(self, include_root=False):
 
1084
        """Recursively list all files as (path, class, kind, id, entry).
1140
1085
 
1141
1086
        Lists, but does not descend into unversioned directories.
 
1087
 
1142
1088
        This does not include files that have been deleted in this
1143
 
        tree. Skips the control directory.
 
1089
        tree.
1144
1090
 
1145
 
        :param include_root: if True, return an entry for the root
1146
 
        :param from_dir: start from this directory or None for the root
1147
 
        :param recursive: whether to recurse into subdirectories or not
 
1091
        Skips the control directory.
1148
1092
        """
1149
1093
        # list_files is an iterator, so @needs_read_lock doesn't work properly
1150
1094
        # with it. So callers should be careful to always read_lock the tree.
1152
1096
            raise errors.ObjectNotLocked(self)
1153
1097
 
1154
1098
        inv = self.inventory
1155
 
        if from_dir is None and include_root is True:
 
1099
        if include_root is True:
1156
1100
            yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1157
1101
        # Convert these into local objects to save lookup times
1158
1102
        pathjoin = osutils.pathjoin
1165
1109
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1166
1110
 
1167
1111
        # directory file_id, relative path, absolute path, reverse sorted children
1168
 
        if from_dir is not None:
1169
 
            from_dir_id = inv.path2id(from_dir)
1170
 
            if from_dir_id is None:
1171
 
                # Directory not versioned
1172
 
                return
1173
 
            from_dir_abspath = pathjoin(self.basedir, from_dir)
1174
 
        else:
1175
 
            from_dir_id = inv.root.file_id
1176
 
            from_dir_abspath = self.basedir
1177
 
        children = os.listdir(from_dir_abspath)
 
1112
        children = os.listdir(self.basedir)
1178
1113
        children.sort()
1179
 
        # jam 20060527 The kernel sized tree seems equivalent whether we
 
1114
        # jam 20060527 The kernel sized tree seems equivalent whether we 
1180
1115
        # use a deque and popleft to keep them sorted, or if we use a plain
1181
1116
        # list and just reverse() them.
1182
1117
        children = collections.deque(children)
1183
 
        stack = [(from_dir_id, u'', from_dir_abspath, children)]
 
1118
        stack = [(inv.root.file_id, u'', self.basedir, children)]
1184
1119
        while stack:
1185
1120
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1186
1121
 
1202
1137
 
1203
1138
                # absolute path
1204
1139
                fap = from_dir_abspath + '/' + f
1205
 
 
 
1140
                
1206
1141
                f_ie = inv.get_child(from_dir_id, f)
1207
1142
                if f_ie:
1208
1143
                    c = 'V'
1240
1175
                    except KeyError:
1241
1176
                        yield fp[1:], c, fk, None, TreeEntry()
1242
1177
                    continue
1243
 
 
 
1178
                
1244
1179
                if fk != 'directory':
1245
1180
                    continue
1246
1181
 
1247
 
                # But do this child first if recursing down
1248
 
                if recursive:
1249
 
                    new_children = os.listdir(fap)
1250
 
                    new_children.sort()
1251
 
                    new_children = collections.deque(new_children)
1252
 
                    stack.append((f_ie.file_id, fp, fap, new_children))
1253
 
                    # Break out of inner loop,
1254
 
                    # so that we start outer loop with child
1255
 
                    break
 
1182
                # But do this child first
 
1183
                new_children = os.listdir(fap)
 
1184
                new_children.sort()
 
1185
                new_children = collections.deque(new_children)
 
1186
                stack.append((f_ie.file_id, fp, fap, new_children))
 
1187
                # Break out of inner loop,
 
1188
                # so that we start outer loop with child
 
1189
                break
1256
1190
            else:
1257
1191
                # if we finished all children, pop it off the stack
1258
1192
                stack.pop()
1264
1198
        to_dir must exist in the inventory.
1265
1199
 
1266
1200
        If to_dir exists and is a directory, the files are moved into
1267
 
        it, keeping their old names.
 
1201
        it, keeping their old names.  
1268
1202
 
1269
1203
        Note that to_dir is only the last component of the new name;
1270
1204
        this doesn't change the directory.
1436
1370
        inv = self.inventory
1437
1371
        for entry in moved:
1438
1372
            try:
1439
 
                self._move_entry(WorkingTree._RenameEntry(
1440
 
                    entry.to_rel, entry.from_id,
 
1373
                self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1441
1374
                    entry.to_tail, entry.to_parent_id, entry.from_rel,
1442
1375
                    entry.from_tail, entry.from_parent_id,
1443
1376
                    entry.only_change_inv))
1494
1427
        from_tail = splitpath(from_rel)[-1]
1495
1428
        from_id = inv.path2id(from_rel)
1496
1429
        if from_id is None:
1497
 
            # if file is missing in the inventory maybe it's in the basis_tree
1498
 
            basis_tree = self.branch.basis_tree()
1499
 
            from_id = basis_tree.path2id(from_rel)
1500
 
            if from_id is None:
1501
 
                raise errors.BzrRenameFailedError(from_rel,to_rel,
1502
 
                    errors.NotVersionedError(path=str(from_rel)))
1503
 
            # put entry back in the inventory so we can rename it
1504
 
            from_entry = basis_tree.inventory[from_id].copy()
1505
 
            inv.add(from_entry)
1506
 
        else:
1507
 
            from_entry = inv[from_id]
 
1430
            raise errors.BzrRenameFailedError(from_rel,to_rel,
 
1431
                errors.NotVersionedError(path=str(from_rel)))
 
1432
        from_entry = inv[from_id]
1508
1433
        from_parent_id = from_entry.parent_id
1509
1434
        to_dir, to_tail = os.path.split(to_rel)
1510
1435
        to_dir_id = inv.path2id(to_dir)
1556
1481
        These are files in the working directory that are not versioned or
1557
1482
        control files or ignored.
1558
1483
        """
1559
 
        # force the extras method to be fully executed before returning, to
 
1484
        # force the extras method to be fully executed before returning, to 
1560
1485
        # prevent race conditions with the lock
1561
1486
        return iter(
1562
1487
            [subp for subp in self.extras() if not self.is_ignored(subp)])
1572
1497
        :raises: NoSuchId if any fileid is not currently versioned.
1573
1498
        """
1574
1499
        for file_id in file_ids:
1575
 
            if file_id not in self._inventory:
1576
 
                raise errors.NoSuchId(self, file_id)
1577
 
        for file_id in file_ids:
1578
1500
            if self._inventory.has_id(file_id):
1579
1501
                self._inventory.remove_recursive_id(file_id)
 
1502
            else:
 
1503
                raise errors.NoSuchId(self, file_id)
1580
1504
        if len(file_ids):
1581
 
            # in the future this should just set a dirty bit to wait for the
 
1505
            # in the future this should just set a dirty bit to wait for the 
1582
1506
            # final unlock. However, until all methods of workingtree start
1583
 
            # with the current in -memory inventory rather than triggering
 
1507
            # with the current in -memory inventory rather than triggering 
1584
1508
            # a read, it is more complex - we need to teach read_inventory
1585
1509
            # to know when to read, and when to not read first... and possibly
1586
1510
            # to save first when the in memory one may be corrupted.
1587
1511
            # so for now, we just only write it if it is indeed dirty.
1588
1512
            # - RBC 20060907
1589
1513
            self._write_inventory(self._inventory)
1590
 
 
 
1514
    
1591
1515
    def _iter_conflicts(self):
1592
1516
        conflicted = set()
1593
1517
        for info in self.list_files():
1601
1525
 
1602
1526
    @needs_write_lock
1603
1527
    def pull(self, source, overwrite=False, stop_revision=None,
1604
 
             change_reporter=None, possible_transports=None, local=False):
 
1528
             change_reporter=None, possible_transports=None):
 
1529
        top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1605
1530
        source.lock_read()
1606
1531
        try:
 
1532
            pp = ProgressPhase("Pull phase", 2, top_pb)
 
1533
            pp.next_phase()
1607
1534
            old_revision_info = self.branch.last_revision_info()
1608
1535
            basis_tree = self.basis_tree()
1609
1536
            count = self.branch.pull(source, overwrite, stop_revision,
1610
 
                                     possible_transports=possible_transports,
1611
 
                                     local=local)
 
1537
                                     possible_transports=possible_transports)
1612
1538
            new_revision_info = self.branch.last_revision_info()
1613
1539
            if new_revision_info != old_revision_info:
 
1540
                pp.next_phase()
1614
1541
                repository = self.branch.repository
 
1542
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
1615
1543
                basis_tree.lock_read()
1616
1544
                try:
1617
1545
                    new_basis_tree = self.branch.basis_tree()
1620
1548
                                new_basis_tree,
1621
1549
                                basis_tree,
1622
1550
                                this_tree=self,
1623
 
                                pb=None,
 
1551
                                pb=pb,
1624
1552
                                change_reporter=change_reporter)
1625
 
                    basis_root_id = basis_tree.get_root_id()
1626
 
                    new_root_id = new_basis_tree.get_root_id()
1627
 
                    if basis_root_id != new_root_id:
1628
 
                        self.set_root_id(new_root_id)
 
1553
                    if (basis_tree.inventory.root is None and
 
1554
                        new_basis_tree.inventory.root is not None):
 
1555
                        self.set_root_id(new_basis_tree.get_root_id())
1629
1556
                finally:
 
1557
                    pb.finished()
1630
1558
                    basis_tree.unlock()
1631
1559
                # TODO - dedup parents list with things merged by pull ?
1632
1560
                # reuse the revisiontree we merged against to set the new
1633
1561
                # tree data.
1634
1562
                parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1635
 
                # we have to pull the merge trees out again, because
1636
 
                # merge_inner has set the ids. - this corner is not yet
 
1563
                # we have to pull the merge trees out again, because 
 
1564
                # merge_inner has set the ids. - this corner is not yet 
1637
1565
                # layered well enough to prevent double handling.
1638
1566
                # XXX TODO: Fix the double handling: telling the tree about
1639
1567
                # the already known parent data is wasteful.
1645
1573
            return count
1646
1574
        finally:
1647
1575
            source.unlock()
 
1576
            top_pb.finished()
1648
1577
 
1649
1578
    @needs_write_lock
1650
1579
    def put_file_bytes_non_atomic(self, file_id, bytes):
1676
1605
 
1677
1606
            fl = []
1678
1607
            for subf in os.listdir(dirabs):
1679
 
                if self.bzrdir.is_control_filename(subf):
 
1608
                if subf == '.bzr':
1680
1609
                    continue
1681
1610
                if subf not in dir_entry.children:
1682
1611
                    try:
1692
1621
                            fl.append(subf_norm)
1693
1622
                    else:
1694
1623
                        fl.append(subf)
1695
 
 
 
1624
            
1696
1625
            fl.sort()
1697
1626
            for subf in fl:
1698
1627
                subp = pathjoin(path, subf)
1735
1664
        r"""Check whether the filename matches an ignore pattern.
1736
1665
 
1737
1666
        Patterns containing '/' or '\' need to match the whole path;
1738
 
        others match against only the last component.  Patterns starting
1739
 
        with '!' are ignore exceptions.  Exceptions take precedence
1740
 
        over regular patterns and cause the filename to not be ignored.
 
1667
        others match against only the last component.
1741
1668
 
1742
1669
        If the file is ignored, returns the pattern which caused it to
1743
1670
        be ignored, otherwise None.  So this can simply be used as a
1744
1671
        boolean if desired."""
1745
1672
        if getattr(self, '_ignoreglobster', None) is None:
1746
 
            self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
 
1673
            self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1747
1674
        return self._ignoreglobster.match(filename)
1748
1675
 
1749
1676
    def kind(self, file_id):
1799
1726
            raise errors.ObjectNotLocked(self)
1800
1727
 
1801
1728
    def lock_read(self):
1802
 
        """Lock the tree for reading.
1803
 
 
1804
 
        This also locks the branch, and can be unlocked via self.unlock().
1805
 
 
1806
 
        :return: A bzrlib.lock.LogicalLockResult.
1807
 
        """
 
1729
        """See Branch.lock_read, and WorkingTree.unlock."""
1808
1730
        if not self.is_locked():
1809
1731
            self._reset_data()
1810
1732
        self.branch.lock_read()
1811
1733
        try:
1812
 
            self._control_files.lock_read()
1813
 
            return LogicalLockResult(self.unlock)
 
1734
            return self._control_files.lock_read()
1814
1735
        except:
1815
1736
            self.branch.unlock()
1816
1737
            raise
1817
1738
 
1818
1739
    def lock_tree_write(self):
1819
 
        """See MutableTree.lock_tree_write, and WorkingTree.unlock.
1820
 
 
1821
 
        :return: A bzrlib.lock.LogicalLockResult.
1822
 
        """
 
1740
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1823
1741
        if not self.is_locked():
1824
1742
            self._reset_data()
1825
1743
        self.branch.lock_read()
1826
1744
        try:
1827
 
            self._control_files.lock_write()
1828
 
            return LogicalLockResult(self.unlock)
 
1745
            return self._control_files.lock_write()
1829
1746
        except:
1830
1747
            self.branch.unlock()
1831
1748
            raise
1832
1749
 
1833
1750
    def lock_write(self):
1834
 
        """See MutableTree.lock_write, and WorkingTree.unlock.
1835
 
 
1836
 
        :return: A bzrlib.lock.LogicalLockResult.
1837
 
        """
 
1751
        """See MutableTree.lock_write, and WorkingTree.unlock."""
1838
1752
        if not self.is_locked():
1839
1753
            self._reset_data()
1840
1754
        self.branch.lock_write()
1841
1755
        try:
1842
 
            self._control_files.lock_write()
1843
 
            return LogicalLockResult(self.unlock)
 
1756
            return self._control_files.lock_write()
1844
1757
        except:
1845
1758
            self.branch.unlock()
1846
1759
            raise
1854
1767
    def _reset_data(self):
1855
1768
        """Reset transient data that cannot be revalidated."""
1856
1769
        self._inventory_is_modified = False
1857
 
        f = self._transport.get('inventory')
1858
 
        try:
1859
 
            result = self._deserialize(f)
1860
 
        finally:
1861
 
            f.close()
 
1770
        result = self._deserialize(self._transport.get('inventory'))
1862
1771
        self._set_inventory(result, dirty=False)
1863
1772
 
1864
1773
    @needs_tree_write_lock
1869
1778
 
1870
1779
    def _change_last_revision(self, new_revision):
1871
1780
        """Template method part of set_last_revision to perform the change.
1872
 
 
 
1781
        
1873
1782
        This is used to allow WorkingTree3 instances to not affect branch
1874
1783
        when their last revision is set.
1875
1784
        """
1888
1797
        path = self._basis_inventory_name()
1889
1798
        sio = StringIO(xml)
1890
1799
        self._transport.put_file(path, sio,
1891
 
            mode=self.bzrdir._get_file_mode())
 
1800
            mode=self._control_files._file_mode)
1892
1801
 
1893
1802
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
1894
1803
        """Create the text that will be saved in basis-inventory"""
1901
1810
        # as commit already has that ready-to-use [while the format is the
1902
1811
        # same, that is].
1903
1812
        try:
1904
 
            # this double handles the inventory - unpack and repack -
 
1813
            # this double handles the inventory - unpack and repack - 
1905
1814
            # but is easier to understand. We can/should put a conditional
1906
1815
            # in here based on whether the inventory is in the latest format
1907
1816
            # - perhaps we should repack all inventories on a repository
1908
1817
            # upgrade ?
1909
1818
            # the fast path is to copy the raw xml from the repository. If the
1910
 
            # xml contains 'revision_id="', then we assume the right
 
1819
            # xml contains 'revision_id="', then we assume the right 
1911
1820
            # revision_id is set. We must check for this full string, because a
1912
1821
            # root node id can legitimately look like 'revision_id' but cannot
1913
1822
            # contain a '"'.
1914
 
            xml = self.branch.repository._get_inventory_xml(new_revision)
 
1823
            xml = self.branch.repository.get_inventory_xml(new_revision)
1915
1824
            firstline = xml.split('\n', 1)[0]
1916
 
            if (not 'revision_id="' in firstline or
 
1825
            if (not 'revision_id="' in firstline or 
1917
1826
                'format="7"' not in firstline):
1918
 
                inv = self.branch.repository._serializer.read_inventory_from_string(
1919
 
                    xml, new_revision)
 
1827
                inv = self.branch.repository.deserialise_inventory(
 
1828
                    new_revision, xml)
1920
1829
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
1921
1830
            self._write_basis_inventory(xml)
1922
1831
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
1926
1835
        """Read the cached basis inventory."""
1927
1836
        path = self._basis_inventory_name()
1928
1837
        return self._transport.get_bytes(path)
1929
 
 
 
1838
        
1930
1839
    @needs_read_lock
1931
1840
    def read_working_inventory(self):
1932
1841
        """Read the working inventory.
1933
 
 
 
1842
        
1934
1843
        :raises errors.InventoryModified: read_working_inventory will fail
1935
1844
            when the current in memory inventory has been modified.
1936
1845
        """
1937
 
        # conceptually this should be an implementation detail of the tree.
 
1846
        # conceptually this should be an implementation detail of the tree. 
1938
1847
        # XXX: Deprecate this.
1939
1848
        # ElementTree does its own conversion from UTF-8, so open in
1940
1849
        # binary.
1941
1850
        if self._inventory_is_modified:
1942
1851
            raise errors.InventoryModified(self)
1943
 
        f = self._transport.get('inventory')
1944
 
        try:
1945
 
            result = self._deserialize(f)
1946
 
        finally:
1947
 
            f.close()
 
1852
        result = self._deserialize(self._transport.get('inventory'))
1948
1853
        self._set_inventory(result, dirty=False)
1949
1854
        return result
1950
1855
 
1965
1870
 
1966
1871
        new_files=set()
1967
1872
        unknown_nested_files=set()
1968
 
        if to_file is None:
1969
 
            to_file = sys.stdout
1970
1873
 
1971
1874
        def recurse_directory_to_add_files(directory):
1972
1875
            # Recurse directory and add all files
1973
1876
            # so we can check if they have changed.
1974
 
            for parent_info, file_infos in self.walkdirs(directory):
 
1877
            for parent_info, file_infos in\
 
1878
                self.walkdirs(directory):
1975
1879
                for relpath, basename, kind, lstat, fileid, kind in file_infos:
1976
1880
                    # Is it versioned or ignored?
1977
1881
                    if self.path2id(relpath) or self.is_ignored(relpath):
2012
1916
                            # ... but not ignored
2013
1917
                            has_changed_files = True
2014
1918
                            break
2015
 
                    elif (content_change and (kind[1] is not None) and
2016
 
                            osutils.is_inside_any(files, path[1])):
2017
 
                        # Versioned and changed, but not deleted, and still
2018
 
                        # in one of the dirs to be deleted.
 
1919
                    elif content_change and (kind[1] is not None):
 
1920
                        # Versioned and changed, but not deleted
2019
1921
                        has_changed_files = True
2020
1922
                        break
2021
1923
 
2029
1931
                        tree_delta.unversioned.extend((unknown_file,))
2030
1932
                raise errors.BzrRemoveChangedFilesError(tree_delta)
2031
1933
 
2032
 
        # Build inv_delta and delete files where applicable,
 
1934
        # Build inv_delta and delete files where applicaple,
2033
1935
        # do this before any modifications to inventory.
2034
1936
        for f in files:
2035
1937
            fid = self.path2id(f)
2043
1945
                        new_status = 'I'
2044
1946
                    else:
2045
1947
                        new_status = '?'
2046
 
                    # XXX: Really should be a more abstract reporter interface
2047
 
                    kind_ch = osutils.kind_marker(self.kind(fid))
2048
 
                    to_file.write(new_status + '       ' + f + kind_ch + '\n')
 
1948
                    textui.show_status(new_status, self.kind(fid), f,
 
1949
                                       to_file=to_file)
2049
1950
                # Unversion file
2050
1951
                inv_delta.append((f, None, fid, None))
2051
1952
                message = "removed %s" % (f,)
2074
1975
 
2075
1976
    @needs_tree_write_lock
2076
1977
    def revert(self, filenames=None, old_tree=None, backups=True,
2077
 
               pb=None, report_changes=False):
 
1978
               pb=DummyProgress(), report_changes=False):
2078
1979
        from bzrlib.conflicts import resolve
2079
1980
        if filenames == []:
2080
1981
            filenames = None
2093
1994
            if filenames is None and len(self.get_parent_ids()) > 1:
2094
1995
                parent_trees = []
2095
1996
                last_revision = self.last_revision()
2096
 
                if last_revision != _mod_revision.NULL_REVISION:
 
1997
                if last_revision != NULL_REVISION:
2097
1998
                    if basis_tree is None:
2098
1999
                        basis_tree = self.basis_tree()
2099
2000
                        basis_tree.lock_read()
2137
2038
    def set_inventory(self, new_inventory_list):
2138
2039
        from bzrlib.inventory import (Inventory,
2139
2040
                                      InventoryDirectory,
 
2041
                                      InventoryEntry,
2140
2042
                                      InventoryFile,
2141
2043
                                      InventoryLink)
2142
2044
        inv = Inventory(self.get_root_id())
2144
2046
            name = os.path.basename(path)
2145
2047
            if name == "":
2146
2048
                continue
2147
 
            # fixme, there should be a factory function inv,add_??
 
2049
            # fixme, there should be a factory function inv,add_?? 
2148
2050
            if kind == 'directory':
2149
2051
                inv.add(InventoryDirectory(file_id, name, parent))
2150
2052
            elif kind == 'file':
2158
2060
    @needs_tree_write_lock
2159
2061
    def set_root_id(self, file_id):
2160
2062
        """Set the root id for this tree."""
2161
 
        # for compatability
 
2063
        # for compatability 
2162
2064
        if file_id is None:
2163
2065
            raise ValueError(
2164
2066
                'WorkingTree.set_root_id with fileid=None')
2168
2070
    def _set_root_id(self, file_id):
2169
2071
        """Set the root id for this tree, in a format specific manner.
2170
2072
 
2171
 
        :param file_id: The file id to assign to the root. It must not be
 
2073
        :param file_id: The file id to assign to the root. It must not be 
2172
2074
            present in the current inventory or an error will occur. It must
2173
2075
            not be None, but rather a valid file id.
2174
2076
        """
2193
2095
 
2194
2096
    def unlock(self):
2195
2097
        """See Branch.unlock.
2196
 
 
 
2098
        
2197
2099
        WorkingTree locking just uses the Branch locking facilities.
2198
2100
        This is current because all working trees have an embedded branch
2199
2101
        within them. IF in the future, we were to make branch data shareable
2200
 
        between multiple working trees, i.e. via shared storage, then we
 
2102
        between multiple working trees, i.e. via shared storage, then we 
2201
2103
        would probably want to lock both the local tree, and the branch.
2202
2104
        """
2203
2105
        raise NotImplementedError(self.unlock)
2204
2106
 
2205
 
    _marker = object()
2206
 
 
2207
 
    def update(self, change_reporter=None, possible_transports=None,
2208
 
               revision=None, old_tip=_marker):
 
2107
    def update(self, change_reporter=None, possible_transports=None):
2209
2108
        """Update a working tree along its branch.
2210
2109
 
2211
2110
        This will update the branch if its bound too, which means we have
2229
2128
        - Merge current state -> basis tree of the master w.r.t. the old tree
2230
2129
          basis.
2231
2130
        - Do a 'normal' merge of the old branch basis if it is relevant.
2232
 
 
2233
 
        :param revision: The target revision to update to. Must be in the
2234
 
            revision history.
2235
 
        :param old_tip: If branch.update() has already been run, the value it
2236
 
            returned (old tip of the branch or None). _marker is used
2237
 
            otherwise.
2238
2131
        """
2239
2132
        if self.branch.get_bound_location() is not None:
2240
2133
            self.lock_write()
2241
 
            update_branch = (old_tip is self._marker)
 
2134
            update_branch = True
2242
2135
        else:
2243
2136
            self.lock_tree_write()
2244
2137
            update_branch = False
2246
2139
            if update_branch:
2247
2140
                old_tip = self.branch.update(possible_transports)
2248
2141
            else:
2249
 
                if old_tip is self._marker:
2250
 
                    old_tip = None
2251
 
            return self._update_tree(old_tip, change_reporter, revision)
 
2142
                old_tip = None
 
2143
            return self._update_tree(old_tip, change_reporter)
2252
2144
        finally:
2253
2145
            self.unlock()
2254
2146
 
2255
2147
    @needs_tree_write_lock
2256
 
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
 
2148
    def _update_tree(self, old_tip=None, change_reporter=None):
2257
2149
        """Update a tree to the master branch.
2258
2150
 
2259
2151
        :param old_tip: if supplied, the previous tip revision the branch,
2265
2157
        # cant set that until we update the working trees last revision to be
2266
2158
        # one from the new branch, because it will just get absorbed by the
2267
2159
        # parent de-duplication logic.
2268
 
        #
 
2160
        # 
2269
2161
        # We MUST save it even if an error occurs, because otherwise the users
2270
2162
        # local work is unreferenced and will appear to have been lost.
2271
 
        #
2272
 
        nb_conflicts = 0
 
2163
        # 
 
2164
        result = 0
2273
2165
        try:
2274
2166
            last_rev = self.get_parent_ids()[0]
2275
2167
        except IndexError:
2276
2168
            last_rev = _mod_revision.NULL_REVISION
2277
 
        if revision is None:
2278
 
            revision = self.branch.last_revision()
2279
 
 
2280
 
        old_tip = old_tip or _mod_revision.NULL_REVISION
2281
 
 
2282
 
        if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2283
 
            # the branch we are bound to was updated
2284
 
            # merge those changes in first
2285
 
            base_tree  = self.basis_tree()
2286
 
            other_tree = self.branch.repository.revision_tree(old_tip)
2287
 
            nb_conflicts = merge.merge_inner(self.branch, other_tree,
2288
 
                                             base_tree, this_tree=self,
2289
 
                                             change_reporter=change_reporter)
2290
 
            if nb_conflicts:
2291
 
                self.add_parent_tree((old_tip, other_tree))
2292
 
                trace.note('Rerun update after fixing the conflicts.')
2293
 
                return nb_conflicts
2294
 
 
2295
 
        if last_rev != _mod_revision.ensure_null(revision):
2296
 
            # the working tree is up to date with the branch
2297
 
            # we can merge the specified revision from master
2298
 
            to_tree = self.branch.repository.revision_tree(revision)
2299
 
            to_root_id = to_tree.get_root_id()
2300
 
 
 
2169
        if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
 
2170
            # merge tree state up to new branch tip.
2301
2171
            basis = self.basis_tree()
2302
2172
            basis.lock_read()
2303
2173
            try:
2304
 
                if (basis.inventory.root is None
2305
 
                    or basis.inventory.root.file_id != to_root_id):
2306
 
                    self.set_root_id(to_root_id)
 
2174
                to_tree = self.branch.basis_tree()
 
2175
                if basis.inventory.root is None:
 
2176
                    self.set_root_id(to_tree.get_root_id())
2307
2177
                    self.flush()
 
2178
                result += merge.merge_inner(
 
2179
                                      self.branch,
 
2180
                                      to_tree,
 
2181
                                      basis,
 
2182
                                      this_tree=self,
 
2183
                                      change_reporter=change_reporter)
2308
2184
            finally:
2309
2185
                basis.unlock()
2310
 
 
2311
 
            # determine the branch point
2312
 
            graph = self.branch.repository.get_graph()
2313
 
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2314
 
                                                last_rev)
2315
 
            base_tree = self.branch.repository.revision_tree(base_rev_id)
2316
 
 
2317
 
            nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2318
 
                                             this_tree=self,
2319
 
                                             change_reporter=change_reporter)
2320
 
            self.set_last_revision(revision)
2321
2186
            # TODO - dedup parents list with things merged by pull ?
2322
2187
            # reuse the tree we've updated to to set the basis:
2323
 
            parent_trees = [(revision, to_tree)]
 
2188
            parent_trees = [(self.branch.last_revision(), to_tree)]
2324
2189
            merges = self.get_parent_ids()[1:]
2325
2190
            # Ideally we ask the tree for the trees here, that way the working
2326
 
            # tree can decide whether to give us the entire tree or give us a
 
2191
            # tree can decide whether to give us teh entire tree or give us a
2327
2192
            # lazy initialised tree. dirstate for instance will have the trees
2328
2193
            # in ram already, whereas a last-revision + basis-inventory tree
2329
2194
            # will not, but also does not need them when setting parents.
2330
2195
            for parent in merges:
2331
2196
                parent_trees.append(
2332
2197
                    (parent, self.branch.repository.revision_tree(parent)))
2333
 
            if not _mod_revision.is_null(old_tip):
 
2198
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2334
2199
                parent_trees.append(
2335
2200
                    (old_tip, self.branch.repository.revision_tree(old_tip)))
2336
2201
            self.set_parent_trees(parent_trees)
2337
2202
            last_rev = parent_trees[0][0]
2338
 
        return nb_conflicts
 
2203
        else:
 
2204
            # the working tree had the same last-revision as the master
 
2205
            # branch did. We may still have pivot local work from the local
 
2206
            # branch into old_tip:
 
2207
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
 
2208
                self.add_parent_tree_id(old_tip)
 
2209
        if (old_tip is not None and not _mod_revision.is_null(old_tip)
 
2210
            and old_tip != last_rev):
 
2211
            # our last revision was not the prior branch last revision
 
2212
            # and we have converted that last revision to a pending merge.
 
2213
            # base is somewhere between the branch tip now
 
2214
            # and the now pending merge
 
2215
 
 
2216
            # Since we just modified the working tree and inventory, flush out
 
2217
            # the current state, before we modify it again.
 
2218
            # TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
 
2219
            #       requires it only because TreeTransform directly munges the
 
2220
            #       inventory and calls tree._write_inventory(). Ultimately we
 
2221
            #       should be able to remove this extra flush.
 
2222
            self.flush()
 
2223
            graph = self.branch.repository.get_graph()
 
2224
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
 
2225
                                                old_tip)
 
2226
            base_tree = self.branch.repository.revision_tree(base_rev_id)
 
2227
            other_tree = self.branch.repository.revision_tree(old_tip)
 
2228
            result += merge.merge_inner(
 
2229
                                  self.branch,
 
2230
                                  other_tree,
 
2231
                                  base_tree,
 
2232
                                  this_tree=self,
 
2233
                                  change_reporter=change_reporter)
 
2234
        return result
2339
2235
 
2340
2236
    def _write_hashcache_if_dirty(self):
2341
2237
        """Write out the hashcache if it is dirty."""
2441
2337
                    bzrdir_loc = bisect_left(cur_disk_dir_content,
2442
2338
                        ('.bzr', '.bzr'))
2443
2339
                    if (bzrdir_loc < len(cur_disk_dir_content)
2444
 
                        and self.bzrdir.is_control_filename(
2445
 
                            cur_disk_dir_content[bzrdir_loc][0])):
 
2340
                        and cur_disk_dir_content[bzrdir_loc][0] == '.bzr'):
2446
2341
                        # we dont yield the contents of, or, .bzr itself.
2447
2342
                        del cur_disk_dir_content[bzrdir_loc]
2448
2343
            if inv_finished:
2582
2477
        return un_resolved, resolved
2583
2478
 
2584
2479
    @needs_read_lock
2585
 
    def _check(self, references):
2586
 
        """Check the tree for consistency.
2587
 
 
2588
 
        :param references: A dict with keys matching the items returned by
2589
 
            self._get_check_refs(), and values from looking those keys up in
2590
 
            the repository.
2591
 
        """
 
2480
    def _check(self):
2592
2481
        tree_basis = self.basis_tree()
2593
2482
        tree_basis.lock_read()
2594
2483
        try:
2595
 
            repo_basis = references[('trees', self.last_revision())]
 
2484
            repo_basis = self.branch.repository.revision_tree(
 
2485
                self.last_revision())
2596
2486
            if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2597
2487
                raise errors.BzrCheckError(
2598
2488
                    "Mismatched basis inventory content.")
2611
2501
        """
2612
2502
        return
2613
2503
 
 
2504
    @needs_read_lock
2614
2505
    def _get_rules_searcher(self, default_searcher):
2615
2506
        """See Tree._get_rules_searcher."""
2616
2507
        if self._rules_searcher is None:
2618
2509
                self)._get_rules_searcher(default_searcher)
2619
2510
        return self._rules_searcher
2620
2511
 
2621
 
    def get_shelf_manager(self):
2622
 
        """Return the ShelfManager for this WorkingTree."""
2623
 
        from bzrlib.shelf import ShelfManager
2624
 
        return ShelfManager(self, self._transport)
2625
 
 
2626
2512
 
2627
2513
class WorkingTree2(WorkingTree):
2628
2514
    """This is the Format 2 working tree.
2629
2515
 
2630
 
    This was the first weave based working tree.
 
2516
    This was the first weave based working tree. 
2631
2517
     - uses os locks for locking.
2632
2518
     - uses the branch last-revision.
2633
2519
    """
2643
2529
        if self._inventory is None:
2644
2530
            self.read_working_inventory()
2645
2531
 
2646
 
    def _get_check_refs(self):
2647
 
        """Return the references needed to perform a check of this tree."""
2648
 
        return [('trees', self.last_revision())]
2649
 
 
2650
2532
    def lock_tree_write(self):
2651
2533
        """See WorkingTree.lock_tree_write().
2652
2534
 
2653
2535
        In Format2 WorkingTrees we have a single lock for the branch and tree
2654
2536
        so lock_tree_write() degrades to lock_write().
2655
 
 
2656
 
        :return: An object with an unlock method which will release the lock
2657
 
            obtained.
2658
2537
        """
2659
2538
        self.branch.lock_write()
2660
2539
        try:
2661
 
            self._control_files.lock_write()
2662
 
            return self
 
2540
            return self._control_files.lock_write()
2663
2541
        except:
2664
2542
            self.branch.unlock()
2665
2543
            raise
2674
2552
            if self._inventory_is_modified:
2675
2553
                self.flush()
2676
2554
            self._write_hashcache_if_dirty()
2677
 
 
 
2555
                    
2678
2556
        # reverse order of locking.
2679
2557
        try:
2680
2558
            return self._control_files.unlock()
2702
2580
 
2703
2581
    def _change_last_revision(self, revision_id):
2704
2582
        """See WorkingTree._change_last_revision."""
2705
 
        if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
 
2583
        if revision_id is None or revision_id == NULL_REVISION:
2706
2584
            try:
2707
2585
                self._transport.delete('last-revision')
2708
2586
            except errors.NoSuchFile:
2710
2588
            return False
2711
2589
        else:
2712
2590
            self._transport.put_bytes('last-revision', revision_id,
2713
 
                mode=self.bzrdir._get_file_mode())
 
2591
                mode=self._control_files._file_mode)
2714
2592
            return True
2715
2593
 
2716
 
    def _get_check_refs(self):
2717
 
        """Return the references needed to perform a check of this tree."""
2718
 
        return [('trees', self.last_revision())]
2719
 
 
2720
2594
    @needs_tree_write_lock
2721
2595
    def set_conflicts(self, conflicts):
2722
 
        self._put_rio('conflicts', conflicts.to_stanzas(),
 
2596
        self._put_rio('conflicts', conflicts.to_stanzas(), 
2723
2597
                      CONFLICT_HEADER_1)
2724
2598
 
2725
2599
    @needs_tree_write_lock
2774
2648
     * a format string,
2775
2649
     * an open routine.
2776
2650
 
2777
 
    Formats are placed in an dict by their format string for reference
 
2651
    Formats are placed in an dict by their format string for reference 
2778
2652
    during workingtree opening. Its not required that these be instances, they
2779
 
    can be classes themselves with class methods - it simply depends on
 
2653
    can be classes themselves with class methods - it simply depends on 
2780
2654
    whether state is needed for a given format or not.
2781
2655
 
2782
2656
    Once a format is deprecated, just deprecate the initialize and open
2783
 
    methods on the format class. Do not deprecate the object, as the
 
2657
    methods on the format class. Do not deprecate the object, as the 
2784
2658
    object will be created every time regardless.
2785
2659
    """
2786
2660
 
2799
2673
        """Return the format for the working tree object in a_bzrdir."""
2800
2674
        try:
2801
2675
            transport = a_bzrdir.get_workingtree_transport(None)
2802
 
            format_string = transport.get_bytes("format")
 
2676
            format_string = transport.get("format").read()
2803
2677
            return klass._formats[format_string]
2804
2678
        except errors.NoSuchFile:
2805
2679
            raise errors.NoWorkingTree(base=transport.base)
2830
2704
        """Is this format supported?
2831
2705
 
2832
2706
        Supported formats can be initialized and opened.
2833
 
        Unsupported formats may not support initialization or committing or
 
2707
        Unsupported formats may not support initialization or committing or 
2834
2708
        some other features depending on the reason for not being supported.
2835
2709
        """
2836
2710
        return True
2837
2711
 
2838
 
    def supports_content_filtering(self):
2839
 
        """True if this format supports content filtering."""
2840
 
        return False
2841
 
 
2842
 
    def supports_views(self):
2843
 
        """True if this format supports stored views."""
2844
 
        return False
2845
 
 
2846
2712
    @classmethod
2847
2713
    def register_format(klass, format):
2848
2714
        klass._formats[format.get_format_string()] = format
2857
2723
 
2858
2724
 
2859
2725
class WorkingTreeFormat2(WorkingTreeFormat):
2860
 
    """The second working tree format.
 
2726
    """The second working tree format. 
2861
2727
 
2862
2728
    This format modified the hash cache from the format 1 hash cache.
2863
2729
    """
2876
2742
        no working tree.  (See bug #43064).
2877
2743
        """
2878
2744
        sio = StringIO()
2879
 
        inv = inventory.Inventory()
 
2745
        inv = Inventory()
2880
2746
        xml5.serializer_v5.write_inventory(inv, sio, working=True)
2881
2747
        sio.seek(0)
2882
2748
        transport.put_file('inventory', sio, file_mode)
2898
2764
            branch.generate_revision_history(revision_id)
2899
2765
        finally:
2900
2766
            branch.unlock()
2901
 
        inv = inventory.Inventory()
 
2767
        inv = Inventory()
2902
2768
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2903
2769
                         branch,
2904
2770
                         inv,
2949
2815
        - is new in bzr 0.8
2950
2816
        - uses a LockDir to guard access for writes.
2951
2817
    """
2952
 
 
 
2818
    
2953
2819
    upgrade_recommended = True
2954
2820
 
2955
2821
    def get_format_string(self):
2972
2838
 
2973
2839
    def _open_control_files(self, a_bzrdir):
2974
2840
        transport = a_bzrdir.get_workingtree_transport(None)
2975
 
        return LockableFiles(transport, self._lock_file_name,
 
2841
        return LockableFiles(transport, self._lock_file_name, 
2976
2842
                             self._lock_class)
2977
2843
 
2978
2844
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2979
2845
                   accelerator_tree=None, hardlink=False):
2980
2846
        """See WorkingTreeFormat.initialize().
2981
 
 
 
2847
        
2982
2848
        :param revision_id: if supplied, create a working tree at a different
2983
2849
            revision than the branch is at.
2984
2850
        :param accelerator_tree: A tree which can be used for retrieving file
2995
2861
        control_files.create_lock()
2996
2862
        control_files.lock_write()
2997
2863
        transport.put_bytes('format', self.get_format_string(),
2998
 
            mode=a_bzrdir._get_file_mode())
 
2864
            mode=control_files._file_mode)
2999
2865
        if from_branch is not None:
3000
2866
            branch = from_branch
3001
2867
        else:
3021
2887
            # only set an explicit root id if there is one to set.
3022
2888
            if basis_tree.inventory.root is not None:
3023
2889
                wt.set_root_id(basis_tree.get_root_id())
3024
 
            if revision_id == _mod_revision.NULL_REVISION:
 
2890
            if revision_id == NULL_REVISION:
3025
2891
                wt.set_parent_trees([])
3026
2892
            else:
3027
2893
                wt.set_parent_trees([(revision_id, basis_tree)])
3034
2900
        return wt
3035
2901
 
3036
2902
    def _initial_inventory(self):
3037
 
        return inventory.Inventory()
 
2903
        return Inventory()
3038
2904
 
3039
2905
    def __init__(self):
3040
2906
        super(WorkingTreeFormat3, self).__init__()
3055
2921
 
3056
2922
    def _open(self, a_bzrdir, control_files):
3057
2923
        """Open the tree itself.
3058
 
 
 
2924
        
3059
2925
        :param a_bzrdir: the dir for the tree.
3060
2926
        :param control_files: the control files for the tree.
3061
2927
        """
3069
2935
        return self.get_format_string()
3070
2936
 
3071
2937
 
3072
 
__default_format = WorkingTreeFormat6()
 
2938
__default_format = WorkingTreeFormat4()
3073
2939
WorkingTreeFormat.register_format(__default_format)
3074
 
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3075
 
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3076
2940
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3077
2941
WorkingTreeFormat.set_default_format(__default_format)
3078
2942
# formats which have no format string are not discoverable