← 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-09-24 12:51:22 UTC
  • mto: (3697.7.4 1.7)
  • mto: This revision was merged to the branch mainline in revision 3748.
  • Revision ID: john@arbash-meinel.com-20080924125122-0893ip9kz0ik5cjt
Revert the path2id fix, because to_dir can be anywhere, not just
in the same directory.

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 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
 
326
303
 
327
304
        """
328
305
        if path is None:
329
 
            path = osutils.getcwd()
 
306
            path = os.path.getcwdu()
330
307
        control = bzrdir.BzrDir.open(path, _unsupported)
331
308
        return control.open_workingtree(_unsupported)
332
 
 
 
309
        
333
310
    @staticmethod
334
311
    def open_containing(path=None):
335
312
        """Open an existing working tree which has its root about path.
336
 
 
 
313
        
337
314
        This probes for a working tree at path and searches upwards from there.
338
315
 
339
316
        Basically we keep looking up until we find the control directory or
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]
451
 
 
452
 
    def get_file_with_stat(self, file_id, path=None, filtered=True,
453
 
        _fstat=os.fstat):
454
 
        """See Tree.get_file_with_stat."""
 
426
    def get_file(self, file_id, path=None):
455
427
        if path is None:
456
428
            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()
 
429
        return self.get_file_byname(path)
 
430
 
 
431
    def get_file_text(self, file_id):
 
432
        return self.get_file(file_id).read()
 
433
 
 
434
    def get_file_byname(self, filename):
 
435
        return file(self.abspath(filename), 'rb')
483
436
 
484
437
    @needs_read_lock
485
438
    def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
492
445
        incorrectly attributed to CURRENT_REVISION (but after committing, the
493
446
        attribution will be correct).
494
447
        """
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
 
448
        basis = self.basis_tree()
 
449
        basis.lock_read()
 
450
        try:
 
451
            changes = self.iter_changes(basis, True, [self.id2path(file_id)],
 
452
                require_versioned=True).next()
 
453
            changed_content, kind = changes[2], changes[6]
 
454
            if not changed_content:
 
455
                return basis.annotate_iter(file_id)
 
456
            if kind[1] is None:
 
457
                return None
 
458
            import annotate
 
459
            if kind[0] != 'file':
 
460
                old_lines = []
 
461
            else:
 
462
                old_lines = list(basis.annotate_iter(file_id))
 
463
            old = [old_lines]
 
464
            for tree in self.branch.repository.revision_trees(
 
465
                self.get_parent_ids()[1:]):
 
466
                if file_id not in tree:
 
467
                    continue
 
468
                old.append(list(tree.annotate_iter(file_id)))
 
469
            return annotate.reannotate(old, self.get_file(file_id).readlines(),
 
470
                                       default_revision)
 
471
        finally:
 
472
            basis.unlock()
531
473
 
532
474
    def _get_ancestors(self, default_revision):
533
475
        ancestors = set([default_revision])
538
480
 
539
481
    def get_parent_ids(self):
540
482
        """See Tree.get_parent_ids.
541
 
 
 
483
        
542
484
        This implementation reads the pending merges list and last_revision
543
485
        value and uses that to decide what the parents list should be.
544
486
        """
548
490
        else:
549
491
            parents = [last_rev]
550
492
        try:
551
 
            merges_bytes = self._transport.get_bytes('pending-merges')
 
493
            merges_file = self._transport.get('pending-merges')
552
494
        except errors.NoSuchFile:
553
495
            pass
554
496
        else:
555
 
            for l in osutils.split_lines(merges_bytes):
 
497
            for l in merges_file.readlines():
556
498
                revision_id = l.rstrip('\n')
557
499
                parents.append(revision_id)
558
500
        return parents
561
503
    def get_root_id(self):
562
504
        """Return the id of this trees root"""
563
505
        return self._inventory.root.file_id
564
 
 
 
506
        
565
507
    def _get_store_filename(self, file_id):
566
508
        ## XXX: badly named; this is not in the store at all
567
509
        return self.abspath(self.id2path(file_id))
569
511
    @needs_read_lock
570
512
    def clone(self, to_bzrdir, revision_id=None):
571
513
        """Duplicate this working tree into to_bzr, including all state.
572
 
 
 
514
        
573
515
        Specifically modified files are kept as modified, but
574
516
        ignored and unknown files are discarded.
575
517
 
576
518
        If you want to make a new line of development, see bzrdir.sprout()
577
519
 
578
520
        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
 
521
            If not None, the cloned tree will have its last revision set to 
 
522
            revision, and and difference between the source trees last revision
581
523
            and this one merged in.
582
524
        """
583
525
        # assumes the target bzr dir format is compatible.
617
559
 
618
560
    def get_file_size(self, file_id):
619
561
        """See Tree.get_file_size"""
620
 
        # XXX: this returns the on-disk size; it should probably return the
621
 
        # canonical size
622
562
        try:
623
563
            return os.path.getsize(self.id2abspath(file_id))
624
564
        except OSError, e:
640
580
 
641
581
    def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
642
582
        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
583
        return self._inventory[file_id].executable
648
584
 
649
585
    def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
671
607
        """See MutableTree._add."""
672
608
        # TODO: Re-adding a file that is removed in the working copy
673
609
        # should probably put it back with the previous ID.
674
 
        # the read and write working inventory should not occur in this
 
610
        # the read and write working inventory should not occur in this 
675
611
        # function - they should be part of lock_write and unlock.
676
612
        inv = self.inventory
677
613
        for f, file_id, kind in zip(files, ids, kinds):
759
695
            raise
760
696
        kind = _mapper(stat_result.st_mode)
761
697
        if kind == 'file':
762
 
            return self._file_content_summary(path, stat_result)
 
698
            size = stat_result.st_size
 
699
            # try for a stat cache lookup
 
700
            executable = self._is_executable_from_path_and_stat(path, stat_result)
 
701
            return (kind, size, executable, self._sha_from_stat(
 
702
                path, stat_result))
763
703
        elif kind == 'directory':
764
704
            # perhaps it looks like a plain directory, but it's really a
765
705
            # reference.
767
707
                kind = 'tree-reference'
768
708
            return kind, None, None, None
769
709
        elif kind == 'symlink':
770
 
            target = osutils.readlink(abspath)
771
 
            return ('symlink', None, None, target)
 
710
            return ('symlink', None, None, os.readlink(abspath))
772
711
        else:
773
712
            return (kind, None, None, None)
774
713
 
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
714
    def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
783
715
        """Common ghost checking functionality from set_parent_*.
784
716
 
794
726
    def _set_merges_from_parent_ids(self, parent_ids):
795
727
        merges = parent_ids[1:]
796
728
        self._transport.put_bytes('pending-merges', '\n'.join(merges),
797
 
            mode=self.bzrdir._get_file_mode())
 
729
            mode=self._control_files._file_mode)
798
730
 
799
731
    def _filter_parent_ids_by_ancestry(self, revision_ids):
800
732
        """Check that all merged revisions are proper 'heads'.
801
733
 
802
734
        This will always return the first revision_id, and any merged revisions
803
 
        which are
 
735
        which are 
804
736
        """
805
737
        if len(revision_ids) == 0:
806
738
            return revision_ids
818
750
    @needs_tree_write_lock
819
751
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
820
752
        """Set the parent ids to revision_ids.
821
 
 
 
753
        
822
754
        See also set_parent_trees. This api will try to retrieve the tree data
823
755
        for each element of revision_ids from the trees repository. If you have
824
756
        tree data already available, it is more efficient to use
900
832
        self._must_be_locked()
901
833
        my_file = rio_file(stanzas, header)
902
834
        self._transport.put_file(filename, my_file,
903
 
            mode=self.bzrdir._get_file_mode())
 
835
            mode=self._control_files._file_mode)
904
836
 
905
837
    @needs_write_lock # because merge pulls data into the branch.
906
838
    def merge_from_branch(self, branch, to_revision=None, from_revision=None,
907
 
                          merge_type=None, force=False):
 
839
        merge_type=None):
908
840
        """Merge from a branch into this working tree.
909
841
 
910
842
        :param branch: The branch to merge from.
914
846
            branch.last_revision().
915
847
        """
916
848
        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()
 
849
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
850
        try:
 
851
            merger = Merger(self.branch, this_tree=self, pb=pb)
 
852
            merger.pp = ProgressPhase("Merge phase", 5, pb)
 
853
            merger.pp.next_phase()
 
854
            # check that there are no
 
855
            # local alterations
 
856
            merger.check_basis(check_clean=True, require_commits=False)
 
857
            if to_revision is None:
 
858
                to_revision = _mod_revision.ensure_null(branch.last_revision())
 
859
            merger.other_rev_id = to_revision
 
860
            if _mod_revision.is_null(merger.other_rev_id):
 
861
                raise errors.NoCommits(branch)
 
862
            self.branch.fetch(branch, last_revision=merger.other_rev_id)
 
863
            merger.other_basis = merger.other_rev_id
 
864
            merger.other_tree = self.branch.repository.revision_tree(
 
865
                merger.other_rev_id)
 
866
            merger.other_branch = branch
 
867
            merger.pp.next_phase()
 
868
            if from_revision is None:
 
869
                merger.find_base()
 
870
            else:
 
871
                merger.set_base_revision(from_revision, branch)
 
872
            if merger.base_rev_id == merger.other_rev_id:
 
873
                raise errors.PointlessMerge
 
874
            merger.backup_files = False
 
875
            if merge_type is None:
 
876
                merger.merge_type = Merge3Merger
 
877
            else:
 
878
                merger.merge_type = merge_type
 
879
            merger.set_interesting_files(None)
 
880
            merger.show_base = False
 
881
            merger.reprocess = False
 
882
            conflicts = merger.do_merge()
 
883
            merger.set_pending()
 
884
        finally:
 
885
            pb.finished()
947
886
        return conflicts
948
887
 
949
888
    @needs_read_lock
950
889
    def merge_modified(self):
951
890
        """Return a dictionary of files modified by a merge.
952
891
 
953
 
        The list is initialized by WorkingTree.set_merge_modified, which is
 
892
        The list is initialized by WorkingTree.set_merge_modified, which is 
954
893
        typically called after we make some automatic updates to the tree
955
894
        because of a merge.
956
895
 
961
900
            hashfile = self._transport.get('merge-hashes')
962
901
        except errors.NoSuchFile:
963
902
            return {}
 
903
        merge_hashes = {}
964
904
        try:
965
 
            merge_hashes = {}
966
 
            try:
967
 
                if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
968
 
                    raise errors.MergeModifiedFormatError()
969
 
            except StopIteration:
 
905
            if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
970
906
                raise errors.MergeModifiedFormatError()
971
 
            for s in RioReader(hashfile):
972
 
                # RioReader reads in Unicode, so convert file_ids back to utf8
973
 
                file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
974
 
                if file_id not in self.inventory:
975
 
                    continue
976
 
                text_hash = s.get("hash")
977
 
                if text_hash == self.get_file_sha1(file_id):
978
 
                    merge_hashes[file_id] = text_hash
979
 
            return merge_hashes
980
 
        finally:
981
 
            hashfile.close()
 
907
        except StopIteration:
 
908
            raise errors.MergeModifiedFormatError()
 
909
        for s in RioReader(hashfile):
 
910
            # RioReader reads in Unicode, so convert file_ids back to utf8
 
911
            file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
 
912
            if file_id not in self.inventory:
 
913
                continue
 
914
            text_hash = s.get("hash")
 
915
            if text_hash == self.get_file_sha1(file_id):
 
916
                merge_hashes[file_id] = text_hash
 
917
        return merge_hashes
982
918
 
983
919
    @needs_write_lock
984
920
    def mkdir(self, path, file_id=None):
990
926
        return file_id
991
927
 
992
928
    def get_symlink_target(self, file_id):
993
 
        abspath = self.id2abspath(file_id)
994
 
        target = osutils.readlink(abspath)
995
 
        return target
 
929
        return os.readlink(self.id2abspath(file_id))
996
930
 
997
931
    @needs_write_lock
998
932
    def subsume(self, other_tree):
1048
982
        return False
1049
983
 
1050
984
    def _directory_may_be_tree_reference(self, relpath):
1051
 
        # as a special case, if a directory contains control files then
 
985
        # as a special case, if a directory contains control files then 
1052
986
        # it's a tree reference, except that the root of the tree is not
1053
987
        return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1054
988
        # TODO: We could ask all the control formats whether they
1065
999
    @needs_tree_write_lock
1066
1000
    def extract(self, file_id, format=None):
1067
1001
        """Extract a subtree from this tree.
1068
 
 
 
1002
        
1069
1003
        A new branch will be created, relative to the path for this tree.
1070
1004
        """
1071
1005
        self.flush()
1076
1010
                transport = transport.clone(name)
1077
1011
                transport.ensure_base()
1078
1012
            return transport
1079
 
 
 
1013
            
1080
1014
        sub_path = self.id2path(file_id)
1081
1015
        branch_transport = mkdirs(sub_path)
1082
1016
        if format is None:
1096
1030
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
1097
1031
        if tree_transport.base != branch_transport.base:
1098
1032
            tree_bzrdir = format.initialize_on_transport(tree_transport)
1099
 
            branch.BranchReferenceFormat().initialize(tree_bzrdir,
1100
 
                target_branch=new_branch)
 
1033
            branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1101
1034
        else:
1102
1035
            tree_bzrdir = branch_bzrdir
1103
 
        wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
 
1036
        wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1104
1037
        wt.set_parent_ids(self.get_parent_ids())
1105
1038
        my_inv = self.inventory
1106
 
        child_inv = inventory.Inventory(root_id=None)
 
1039
        child_inv = Inventory(root_id=None)
1107
1040
        new_root = my_inv[file_id]
1108
1041
        my_inv.remove_recursive_id(file_id)
1109
1042
        new_root.parent_id = None
1128
1061
        self._serialize(self._inventory, sio)
1129
1062
        sio.seek(0)
1130
1063
        self._transport.put_file('inventory', sio,
1131
 
            mode=self.bzrdir._get_file_mode())
 
1064
            mode=self._control_files._file_mode)
1132
1065
        self._inventory_is_modified = False
1133
1066
 
1134
1067
    def _kind(self, relpath):
1135
1068
        return osutils.file_kind(self.abspath(relpath))
1136
1069
 
1137
 
    def list_files(self, include_root=False, from_dir=None, recursive=True):
1138
 
        """List all files as (path, class, kind, id, entry).
 
1070
    def list_files(self, include_root=False):
 
1071
        """Recursively list all files as (path, class, kind, id, entry).
1139
1072
 
1140
1073
        Lists, but does not descend into unversioned directories.
 
1074
 
1141
1075
        This does not include files that have been deleted in this
1142
 
        tree. Skips the control directory.
 
1076
        tree.
1143
1077
 
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
 
1078
        Skips the control directory.
1147
1079
        """
1148
1080
        # list_files is an iterator, so @needs_read_lock doesn't work properly
1149
1081
        # with it. So callers should be careful to always read_lock the tree.
1151
1083
            raise errors.ObjectNotLocked(self)
1152
1084
 
1153
1085
        inv = self.inventory
1154
 
        if from_dir is None and include_root is True:
 
1086
        if include_root is True:
1155
1087
            yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1156
1088
        # Convert these into local objects to save lookup times
1157
1089
        pathjoin = osutils.pathjoin
1164
1096
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1165
1097
 
1166
1098
        # 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)
 
1099
        children = os.listdir(self.basedir)
1177
1100
        children.sort()
1178
 
        # jam 20060527 The kernel sized tree seems equivalent whether we
 
1101
        # jam 20060527 The kernel sized tree seems equivalent whether we 
1179
1102
        # use a deque and popleft to keep them sorted, or if we use a plain
1180
1103
        # list and just reverse() them.
1181
1104
        children = collections.deque(children)
1182
 
        stack = [(from_dir_id, u'', from_dir_abspath, children)]
 
1105
        stack = [(inv.root.file_id, u'', self.basedir, children)]
1183
1106
        while stack:
1184
1107
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1185
1108
 
1201
1124
 
1202
1125
                # absolute path
1203
1126
                fap = from_dir_abspath + '/' + f
1204
 
 
 
1127
                
1205
1128
                f_ie = inv.get_child(from_dir_id, f)
1206
1129
                if f_ie:
1207
1130
                    c = 'V'
1239
1162
                    except KeyError:
1240
1163
                        yield fp[1:], c, fk, None, TreeEntry()
1241
1164
                    continue
1242
 
 
 
1165
                
1243
1166
                if fk != 'directory':
1244
1167
                    continue
1245
1168
 
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
 
1169
                # But do this child first
 
1170
                new_children = os.listdir(fap)
 
1171
                new_children.sort()
 
1172
                new_children = collections.deque(new_children)
 
1173
                stack.append((f_ie.file_id, fp, fap, new_children))
 
1174
                # Break out of inner loop,
 
1175
                # so that we start outer loop with child
 
1176
                break
1255
1177
            else:
1256
1178
                # if we finished all children, pop it off the stack
1257
1179
                stack.pop()
1263
1185
        to_dir must exist in the inventory.
1264
1186
 
1265
1187
        If to_dir exists and is a directory, the files are moved into
1266
 
        it, keeping their old names.
 
1188
        it, keeping their old names.  
1267
1189
 
1268
1190
        Note that to_dir is only the last component of the new name;
1269
1191
        this doesn't change the directory.
1435
1357
        inv = self.inventory
1436
1358
        for entry in moved:
1437
1359
            try:
1438
 
                self._move_entry(WorkingTree._RenameEntry(
1439
 
                    entry.to_rel, entry.from_id,
 
1360
                self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1440
1361
                    entry.to_tail, entry.to_parent_id, entry.from_rel,
1441
1362
                    entry.from_tail, entry.from_parent_id,
1442
1363
                    entry.only_change_inv))
1493
1414
        from_tail = splitpath(from_rel)[-1]
1494
1415
        from_id = inv.path2id(from_rel)
1495
1416
        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]
 
1417
            raise errors.BzrRenameFailedError(from_rel,to_rel,
 
1418
                errors.NotVersionedError(path=str(from_rel)))
 
1419
        from_entry = inv[from_id]
1507
1420
        from_parent_id = from_entry.parent_id
1508
1421
        to_dir, to_tail = os.path.split(to_rel)
1509
1422
        to_dir_id = inv.path2id(to_dir)
1555
1468
        These are files in the working directory that are not versioned or
1556
1469
        control files or ignored.
1557
1470
        """
1558
 
        # force the extras method to be fully executed before returning, to
 
1471
        # force the extras method to be fully executed before returning, to 
1559
1472
        # prevent race conditions with the lock
1560
1473
        return iter(
1561
1474
            [subp for subp in self.extras() if not self.is_ignored(subp)])
1571
1484
        :raises: NoSuchId if any fileid is not currently versioned.
1572
1485
        """
1573
1486
        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
1487
            if self._inventory.has_id(file_id):
1578
1488
                self._inventory.remove_recursive_id(file_id)
 
1489
            else:
 
1490
                raise errors.NoSuchId(self, file_id)
1579
1491
        if len(file_ids):
1580
 
            # in the future this should just set a dirty bit to wait for the
 
1492
            # in the future this should just set a dirty bit to wait for the 
1581
1493
            # final unlock. However, until all methods of workingtree start
1582
 
            # with the current in -memory inventory rather than triggering
 
1494
            # with the current in -memory inventory rather than triggering 
1583
1495
            # a read, it is more complex - we need to teach read_inventory
1584
1496
            # to know when to read, and when to not read first... and possibly
1585
1497
            # to save first when the in memory one may be corrupted.
1586
1498
            # so for now, we just only write it if it is indeed dirty.
1587
1499
            # - RBC 20060907
1588
1500
            self._write_inventory(self._inventory)
1589
 
 
 
1501
    
1590
1502
    def _iter_conflicts(self):
1591
1503
        conflicted = set()
1592
1504
        for info in self.list_files():
1600
1512
 
1601
1513
    @needs_write_lock
1602
1514
    def pull(self, source, overwrite=False, stop_revision=None,
1603
 
             change_reporter=None, possible_transports=None, local=False):
 
1515
             change_reporter=None, possible_transports=None):
 
1516
        top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1604
1517
        source.lock_read()
1605
1518
        try:
 
1519
            pp = ProgressPhase("Pull phase", 2, top_pb)
 
1520
            pp.next_phase()
1606
1521
            old_revision_info = self.branch.last_revision_info()
1607
1522
            basis_tree = self.basis_tree()
1608
1523
            count = self.branch.pull(source, overwrite, stop_revision,
1609
 
                                     possible_transports=possible_transports,
1610
 
                                     local=local)
 
1524
                                     possible_transports=possible_transports)
1611
1525
            new_revision_info = self.branch.last_revision_info()
1612
1526
            if new_revision_info != old_revision_info:
 
1527
                pp.next_phase()
1613
1528
                repository = self.branch.repository
 
1529
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
1614
1530
                basis_tree.lock_read()
1615
1531
                try:
1616
1532
                    new_basis_tree = self.branch.basis_tree()
1619
1535
                                new_basis_tree,
1620
1536
                                basis_tree,
1621
1537
                                this_tree=self,
1622
 
                                pb=None,
 
1538
                                pb=pb,
1623
1539
                                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)
 
1540
                    if (basis_tree.inventory.root is None and
 
1541
                        new_basis_tree.inventory.root is not None):
 
1542
                        self.set_root_id(new_basis_tree.get_root_id())
1628
1543
                finally:
 
1544
                    pb.finished()
1629
1545
                    basis_tree.unlock()
1630
1546
                # TODO - dedup parents list with things merged by pull ?
1631
1547
                # reuse the revisiontree we merged against to set the new
1632
1548
                # tree data.
1633
1549
                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
 
1550
                # we have to pull the merge trees out again, because 
 
1551
                # merge_inner has set the ids. - this corner is not yet 
1636
1552
                # layered well enough to prevent double handling.
1637
1553
                # XXX TODO: Fix the double handling: telling the tree about
1638
1554
                # the already known parent data is wasteful.
1644
1560
            return count
1645
1561
        finally:
1646
1562
            source.unlock()
 
1563
            top_pb.finished()
1647
1564
 
1648
1565
    @needs_write_lock
1649
1566
    def put_file_bytes_non_atomic(self, file_id, bytes):
1675
1592
 
1676
1593
            fl = []
1677
1594
            for subf in os.listdir(dirabs):
1678
 
                if self.bzrdir.is_control_filename(subf):
 
1595
                if subf == '.bzr':
1679
1596
                    continue
1680
1597
                if subf not in dir_entry.children:
1681
1598
                    try:
1691
1608
                            fl.append(subf_norm)
1692
1609
                    else:
1693
1610
                        fl.append(subf)
1694
 
 
 
1611
            
1695
1612
            fl.sort()
1696
1613
            for subf in fl:
1697
1614
                subp = pathjoin(path, subf)
1734
1651
        r"""Check whether the filename matches an ignore pattern.
1735
1652
 
1736
1653
        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.
 
1654
        others match against only the last component.
1740
1655
 
1741
1656
        If the file is ignored, returns the pattern which caused it to
1742
1657
        be ignored, otherwise None.  So this can simply be used as a
1743
1658
        boolean if desired."""
1744
1659
        if getattr(self, '_ignoreglobster', None) is None:
1745
 
            self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
 
1660
            self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1746
1661
        return self._ignoreglobster.match(filename)
1747
1662
 
1748
1663
    def kind(self, file_id):
1839
1754
    def _reset_data(self):
1840
1755
        """Reset transient data that cannot be revalidated."""
1841
1756
        self._inventory_is_modified = False
1842
 
        f = self._transport.get('inventory')
1843
 
        try:
1844
 
            result = self._deserialize(f)
1845
 
        finally:
1846
 
            f.close()
 
1757
        result = self._deserialize(self._transport.get('inventory'))
1847
1758
        self._set_inventory(result, dirty=False)
1848
1759
 
1849
1760
    @needs_tree_write_lock
1854
1765
 
1855
1766
    def _change_last_revision(self, new_revision):
1856
1767
        """Template method part of set_last_revision to perform the change.
1857
 
 
 
1768
        
1858
1769
        This is used to allow WorkingTree3 instances to not affect branch
1859
1770
        when their last revision is set.
1860
1771
        """
1873
1784
        path = self._basis_inventory_name()
1874
1785
        sio = StringIO(xml)
1875
1786
        self._transport.put_file(path, sio,
1876
 
            mode=self.bzrdir._get_file_mode())
 
1787
            mode=self._control_files._file_mode)
1877
1788
 
1878
1789
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
1879
1790
        """Create the text that will be saved in basis-inventory"""
1886
1797
        # as commit already has that ready-to-use [while the format is the
1887
1798
        # same, that is].
1888
1799
        try:
1889
 
            # this double handles the inventory - unpack and repack -
 
1800
            # this double handles the inventory - unpack and repack - 
1890
1801
            # but is easier to understand. We can/should put a conditional
1891
1802
            # in here based on whether the inventory is in the latest format
1892
1803
            # - perhaps we should repack all inventories on a repository
1893
1804
            # upgrade ?
1894
1805
            # the fast path is to copy the raw xml from the repository. If the
1895
 
            # xml contains 'revision_id="', then we assume the right
 
1806
            # xml contains 'revision_id="', then we assume the right 
1896
1807
            # revision_id is set. We must check for this full string, because a
1897
1808
            # root node id can legitimately look like 'revision_id' but cannot
1898
1809
            # contain a '"'.
1899
 
            xml = self.branch.repository._get_inventory_xml(new_revision)
 
1810
            xml = self.branch.repository.get_inventory_xml(new_revision)
1900
1811
            firstline = xml.split('\n', 1)[0]
1901
 
            if (not 'revision_id="' in firstline or
 
1812
            if (not 'revision_id="' in firstline or 
1902
1813
                'format="7"' not in firstline):
1903
 
                inv = self.branch.repository._serializer.read_inventory_from_string(
1904
 
                    xml, new_revision)
 
1814
                inv = self.branch.repository.deserialise_inventory(
 
1815
                    new_revision, xml)
1905
1816
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
1906
1817
            self._write_basis_inventory(xml)
1907
1818
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
1911
1822
        """Read the cached basis inventory."""
1912
1823
        path = self._basis_inventory_name()
1913
1824
        return self._transport.get_bytes(path)
1914
 
 
 
1825
        
1915
1826
    @needs_read_lock
1916
1827
    def read_working_inventory(self):
1917
1828
        """Read the working inventory.
1918
 
 
 
1829
        
1919
1830
        :raises errors.InventoryModified: read_working_inventory will fail
1920
1831
            when the current in memory inventory has been modified.
1921
1832
        """
1922
 
        # conceptually this should be an implementation detail of the tree.
 
1833
        # conceptually this should be an implementation detail of the tree. 
1923
1834
        # XXX: Deprecate this.
1924
1835
        # ElementTree does its own conversion from UTF-8, so open in
1925
1836
        # binary.
1926
1837
        if self._inventory_is_modified:
1927
1838
            raise errors.InventoryModified(self)
1928
 
        f = self._transport.get('inventory')
1929
 
        try:
1930
 
            result = self._deserialize(f)
1931
 
        finally:
1932
 
            f.close()
 
1839
        result = self._deserialize(self._transport.get('inventory'))
1933
1840
        self._set_inventory(result, dirty=False)
1934
1841
        return result
1935
1842
 
1950
1857
 
1951
1858
        new_files=set()
1952
1859
        unknown_nested_files=set()
1953
 
        if to_file is None:
1954
 
            to_file = sys.stdout
1955
1860
 
1956
1861
        def recurse_directory_to_add_files(directory):
1957
1862
            # Recurse directory and add all files
2013
1918
                        tree_delta.unversioned.extend((unknown_file,))
2014
1919
                raise errors.BzrRemoveChangedFilesError(tree_delta)
2015
1920
 
2016
 
        # Build inv_delta and delete files where applicable,
 
1921
        # Build inv_delta and delete files where applicaple,
2017
1922
        # do this before any modifications to inventory.
2018
1923
        for f in files:
2019
1924
            fid = self.path2id(f)
2027
1932
                        new_status = 'I'
2028
1933
                    else:
2029
1934
                        new_status = '?'
2030
 
                    # XXX: Really should be a more abstract reporter interface
2031
 
                    kind_ch = osutils.kind_marker(self.kind(fid))
2032
 
                    to_file.write(new_status + '       ' + f + kind_ch + '\n')
 
1935
                    textui.show_status(new_status, self.kind(fid), f,
 
1936
                                       to_file=to_file)
2033
1937
                # Unversion file
2034
1938
                inv_delta.append((f, None, fid, None))
2035
1939
                message = "removed %s" % (f,)
2058
1962
 
2059
1963
    @needs_tree_write_lock
2060
1964
    def revert(self, filenames=None, old_tree=None, backups=True,
2061
 
               pb=None, report_changes=False):
 
1965
               pb=DummyProgress(), report_changes=False):
2062
1966
        from bzrlib.conflicts import resolve
2063
1967
        if filenames == []:
2064
1968
            filenames = None
2077
1981
            if filenames is None and len(self.get_parent_ids()) > 1:
2078
1982
                parent_trees = []
2079
1983
                last_revision = self.last_revision()
2080
 
                if last_revision != _mod_revision.NULL_REVISION:
 
1984
                if last_revision != NULL_REVISION:
2081
1985
                    if basis_tree is None:
2082
1986
                        basis_tree = self.basis_tree()
2083
1987
                        basis_tree.lock_read()
2121
2025
    def set_inventory(self, new_inventory_list):
2122
2026
        from bzrlib.inventory import (Inventory,
2123
2027
                                      InventoryDirectory,
 
2028
                                      InventoryEntry,
2124
2029
                                      InventoryFile,
2125
2030
                                      InventoryLink)
2126
2031
        inv = Inventory(self.get_root_id())
2128
2033
            name = os.path.basename(path)
2129
2034
            if name == "":
2130
2035
                continue
2131
 
            # fixme, there should be a factory function inv,add_??
 
2036
            # fixme, there should be a factory function inv,add_?? 
2132
2037
            if kind == 'directory':
2133
2038
                inv.add(InventoryDirectory(file_id, name, parent))
2134
2039
            elif kind == 'file':
2142
2047
    @needs_tree_write_lock
2143
2048
    def set_root_id(self, file_id):
2144
2049
        """Set the root id for this tree."""
2145
 
        # for compatability
 
2050
        # for compatability 
2146
2051
        if file_id is None:
2147
2052
            raise ValueError(
2148
2053
                'WorkingTree.set_root_id with fileid=None')
2152
2057
    def _set_root_id(self, file_id):
2153
2058
        """Set the root id for this tree, in a format specific manner.
2154
2059
 
2155
 
        :param file_id: The file id to assign to the root. It must not be
 
2060
        :param file_id: The file id to assign to the root. It must not be 
2156
2061
            present in the current inventory or an error will occur. It must
2157
2062
            not be None, but rather a valid file id.
2158
2063
        """
2177
2082
 
2178
2083
    def unlock(self):
2179
2084
        """See Branch.unlock.
2180
 
 
 
2085
        
2181
2086
        WorkingTree locking just uses the Branch locking facilities.
2182
2087
        This is current because all working trees have an embedded branch
2183
2088
        within them. IF in the future, we were to make branch data shareable
2184
 
        between multiple working trees, i.e. via shared storage, then we
 
2089
        between multiple working trees, i.e. via shared storage, then we 
2185
2090
        would probably want to lock both the local tree, and the branch.
2186
2091
        """
2187
2092
        raise NotImplementedError(self.unlock)
2188
2093
 
2189
 
    _marker = object()
2190
 
 
2191
 
    def update(self, change_reporter=None, possible_transports=None,
2192
 
               revision=None, old_tip=_marker):
 
2094
    def update(self, change_reporter=None, possible_transports=None):
2193
2095
        """Update a working tree along its branch.
2194
2096
 
2195
2097
        This will update the branch if its bound too, which means we have
2213
2115
        - Merge current state -> basis tree of the master w.r.t. the old tree
2214
2116
          basis.
2215
2117
        - Do a 'normal' merge of the old branch basis if it is relevant.
2216
 
 
2217
 
        :param revision: The target revision to update to. Must be in the
2218
 
            revision history.
2219
 
        :param old_tip: If branch.update() has already been run, the value it
2220
 
            returned (old tip of the branch or None). _marker is used
2221
 
            otherwise.
2222
2118
        """
2223
2119
        if self.branch.get_bound_location() is not None:
2224
2120
            self.lock_write()
2225
 
            update_branch = (old_tip is self._marker)
 
2121
            update_branch = True
2226
2122
        else:
2227
2123
            self.lock_tree_write()
2228
2124
            update_branch = False
2230
2126
            if update_branch:
2231
2127
                old_tip = self.branch.update(possible_transports)
2232
2128
            else:
2233
 
                if old_tip is self._marker:
2234
 
                    old_tip = None
2235
 
            return self._update_tree(old_tip, change_reporter, revision)
 
2129
                old_tip = None
 
2130
            return self._update_tree(old_tip, change_reporter)
2236
2131
        finally:
2237
2132
            self.unlock()
2238
2133
 
2239
2134
    @needs_tree_write_lock
2240
 
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
 
2135
    def _update_tree(self, old_tip=None, change_reporter=None):
2241
2136
        """Update a tree to the master branch.
2242
2137
 
2243
2138
        :param old_tip: if supplied, the previous tip revision the branch,
2249
2144
        # cant set that until we update the working trees last revision to be
2250
2145
        # one from the new branch, because it will just get absorbed by the
2251
2146
        # parent de-duplication logic.
2252
 
        #
 
2147
        # 
2253
2148
        # We MUST save it even if an error occurs, because otherwise the users
2254
2149
        # local work is unreferenced and will appear to have been lost.
2255
 
        #
2256
 
        nb_conflicts = 0
 
2150
        # 
 
2151
        result = 0
2257
2152
        try:
2258
2153
            last_rev = self.get_parent_ids()[0]
2259
2154
        except IndexError:
2260
2155
            last_rev = _mod_revision.NULL_REVISION
2261
 
        if revision is None:
2262
 
            revision = self.branch.last_revision()
2263
 
 
2264
 
        old_tip = old_tip or _mod_revision.NULL_REVISION
2265
 
 
2266
 
        if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2267
 
            # the branch we are bound to was updated
2268
 
            # merge those changes in first
2269
 
            base_tree  = self.basis_tree()
2270
 
            other_tree = self.branch.repository.revision_tree(old_tip)
2271
 
            nb_conflicts = merge.merge_inner(self.branch, other_tree,
2272
 
                                             base_tree, this_tree=self,
2273
 
                                             change_reporter=change_reporter)
2274
 
            if nb_conflicts:
2275
 
                self.add_parent_tree((old_tip, other_tree))
2276
 
                trace.note('Rerun update after fixing the conflicts.')
2277
 
                return nb_conflicts
2278
 
 
2279
 
        if last_rev != _mod_revision.ensure_null(revision):
2280
 
            # the working tree is up to date with the branch
2281
 
            # we can merge the specified revision from master
2282
 
            to_tree = self.branch.repository.revision_tree(revision)
2283
 
            to_root_id = to_tree.get_root_id()
2284
 
 
 
2156
        if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
 
2157
            # merge tree state up to new branch tip.
2285
2158
            basis = self.basis_tree()
2286
2159
            basis.lock_read()
2287
2160
            try:
2288
 
                if (basis.inventory.root is None
2289
 
                    or basis.inventory.root.file_id != to_root_id):
2290
 
                    self.set_root_id(to_root_id)
 
2161
                to_tree = self.branch.basis_tree()
 
2162
                if basis.inventory.root is None:
 
2163
                    self.set_root_id(to_tree.get_root_id())
2291
2164
                    self.flush()
 
2165
                result += merge.merge_inner(
 
2166
                                      self.branch,
 
2167
                                      to_tree,
 
2168
                                      basis,
 
2169
                                      this_tree=self,
 
2170
                                      change_reporter=change_reporter)
2292
2171
            finally:
2293
2172
                basis.unlock()
2294
 
 
2295
 
            # determine the branch point
2296
 
            graph = self.branch.repository.get_graph()
2297
 
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2298
 
                                                last_rev)
2299
 
            base_tree = self.branch.repository.revision_tree(base_rev_id)
2300
 
 
2301
 
            nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2302
 
                                             this_tree=self,
2303
 
                                             change_reporter=change_reporter)
2304
 
            self.set_last_revision(revision)
2305
2173
            # TODO - dedup parents list with things merged by pull ?
2306
2174
            # reuse the tree we've updated to to set the basis:
2307
 
            parent_trees = [(revision, to_tree)]
 
2175
            parent_trees = [(self.branch.last_revision(), to_tree)]
2308
2176
            merges = self.get_parent_ids()[1:]
2309
2177
            # Ideally we ask the tree for the trees here, that way the working
2310
 
            # tree can decide whether to give us the entire tree or give us a
 
2178
            # tree can decide whether to give us teh entire tree or give us a
2311
2179
            # lazy initialised tree. dirstate for instance will have the trees
2312
2180
            # in ram already, whereas a last-revision + basis-inventory tree
2313
2181
            # will not, but also does not need them when setting parents.
2314
2182
            for parent in merges:
2315
2183
                parent_trees.append(
2316
2184
                    (parent, self.branch.repository.revision_tree(parent)))
2317
 
            if not _mod_revision.is_null(old_tip):
 
2185
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2318
2186
                parent_trees.append(
2319
2187
                    (old_tip, self.branch.repository.revision_tree(old_tip)))
2320
2188
            self.set_parent_trees(parent_trees)
2321
2189
            last_rev = parent_trees[0][0]
2322
 
        return nb_conflicts
 
2190
        else:
 
2191
            # the working tree had the same last-revision as the master
 
2192
            # branch did. We may still have pivot local work from the local
 
2193
            # branch into old_tip:
 
2194
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
 
2195
                self.add_parent_tree_id(old_tip)
 
2196
        if (old_tip is not None and not _mod_revision.is_null(old_tip)
 
2197
            and old_tip != last_rev):
 
2198
            # our last revision was not the prior branch last revision
 
2199
            # and we have converted that last revision to a pending merge.
 
2200
            # base is somewhere between the branch tip now
 
2201
            # and the now pending merge
 
2202
 
 
2203
            # Since we just modified the working tree and inventory, flush out
 
2204
            # the current state, before we modify it again.
 
2205
            # TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
 
2206
            #       requires it only because TreeTransform directly munges the
 
2207
            #       inventory and calls tree._write_inventory(). Ultimately we
 
2208
            #       should be able to remove this extra flush.
 
2209
            self.flush()
 
2210
            graph = self.branch.repository.get_graph()
 
2211
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
 
2212
                                                old_tip)
 
2213
            base_tree = self.branch.repository.revision_tree(base_rev_id)
 
2214
            other_tree = self.branch.repository.revision_tree(old_tip)
 
2215
            result += merge.merge_inner(
 
2216
                                  self.branch,
 
2217
                                  other_tree,
 
2218
                                  base_tree,
 
2219
                                  this_tree=self,
 
2220
                                  change_reporter=change_reporter)
 
2221
        return result
2323
2222
 
2324
2223
    def _write_hashcache_if_dirty(self):
2325
2224
        """Write out the hashcache if it is dirty."""
2424
2323
                    # value.
2425
2324
                    bzrdir_loc = bisect_left(cur_disk_dir_content,
2426
2325
                        ('.bzr', '.bzr'))
2427
 
                    if (bzrdir_loc < len(cur_disk_dir_content)
2428
 
                        and self.bzrdir.is_control_filename(
2429
 
                            cur_disk_dir_content[bzrdir_loc][0])):
 
2326
                    if cur_disk_dir_content[bzrdir_loc][0] == '.bzr':
2430
2327
                        # we dont yield the contents of, or, .bzr itself.
2431
2328
                        del cur_disk_dir_content[bzrdir_loc]
2432
2329
            if inv_finished:
2566
2463
        return un_resolved, resolved
2567
2464
 
2568
2465
    @needs_read_lock
2569
 
    def _check(self, references):
2570
 
        """Check the tree for consistency.
2571
 
 
2572
 
        :param references: A dict with keys matching the items returned by
2573
 
            self._get_check_refs(), and values from looking those keys up in
2574
 
            the repository.
2575
 
        """
 
2466
    def _check(self):
2576
2467
        tree_basis = self.basis_tree()
2577
2468
        tree_basis.lock_read()
2578
2469
        try:
2579
 
            repo_basis = references[('trees', self.last_revision())]
 
2470
            repo_basis = self.branch.repository.revision_tree(
 
2471
                self.last_revision())
2580
2472
            if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2581
2473
                raise errors.BzrCheckError(
2582
2474
                    "Mismatched basis inventory content.")
2595
2487
        """
2596
2488
        return
2597
2489
 
 
2490
    @needs_read_lock
2598
2491
    def _get_rules_searcher(self, default_searcher):
2599
2492
        """See Tree._get_rules_searcher."""
2600
2493
        if self._rules_searcher is None:
2602
2495
                self)._get_rules_searcher(default_searcher)
2603
2496
        return self._rules_searcher
2604
2497
 
2605
 
    def get_shelf_manager(self):
2606
 
        """Return the ShelfManager for this WorkingTree."""
2607
 
        from bzrlib.shelf import ShelfManager
2608
 
        return ShelfManager(self, self._transport)
2609
 
 
2610
2498
 
2611
2499
class WorkingTree2(WorkingTree):
2612
2500
    """This is the Format 2 working tree.
2613
2501
 
2614
 
    This was the first weave based working tree.
 
2502
    This was the first weave based working tree. 
2615
2503
     - uses os locks for locking.
2616
2504
     - uses the branch last-revision.
2617
2505
    """
2627
2515
        if self._inventory is None:
2628
2516
            self.read_working_inventory()
2629
2517
 
2630
 
    def _get_check_refs(self):
2631
 
        """Return the references needed to perform a check of this tree."""
2632
 
        return [('trees', self.last_revision())]
2633
 
 
2634
2518
    def lock_tree_write(self):
2635
2519
        """See WorkingTree.lock_tree_write().
2636
2520
 
2654
2538
            if self._inventory_is_modified:
2655
2539
                self.flush()
2656
2540
            self._write_hashcache_if_dirty()
2657
 
 
 
2541
                    
2658
2542
        # reverse order of locking.
2659
2543
        try:
2660
2544
            return self._control_files.unlock()
2682
2566
 
2683
2567
    def _change_last_revision(self, revision_id):
2684
2568
        """See WorkingTree._change_last_revision."""
2685
 
        if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
 
2569
        if revision_id is None or revision_id == NULL_REVISION:
2686
2570
            try:
2687
2571
                self._transport.delete('last-revision')
2688
2572
            except errors.NoSuchFile:
2690
2574
            return False
2691
2575
        else:
2692
2576
            self._transport.put_bytes('last-revision', revision_id,
2693
 
                mode=self.bzrdir._get_file_mode())
 
2577
                mode=self._control_files._file_mode)
2694
2578
            return True
2695
2579
 
2696
 
    def _get_check_refs(self):
2697
 
        """Return the references needed to perform a check of this tree."""
2698
 
        return [('trees', self.last_revision())]
2699
 
 
2700
2580
    @needs_tree_write_lock
2701
2581
    def set_conflicts(self, conflicts):
2702
 
        self._put_rio('conflicts', conflicts.to_stanzas(),
 
2582
        self._put_rio('conflicts', conflicts.to_stanzas(), 
2703
2583
                      CONFLICT_HEADER_1)
2704
2584
 
2705
2585
    @needs_tree_write_lock
2716
2596
        except errors.NoSuchFile:
2717
2597
            return _mod_conflicts.ConflictList()
2718
2598
        try:
2719
 
            try:
2720
 
                if confile.next() != CONFLICT_HEADER_1 + '\n':
2721
 
                    raise errors.ConflictFormatError()
2722
 
            except StopIteration:
 
2599
            if confile.next() != CONFLICT_HEADER_1 + '\n':
2723
2600
                raise errors.ConflictFormatError()
2724
 
            return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2725
 
        finally:
2726
 
            confile.close()
 
2601
        except StopIteration:
 
2602
            raise errors.ConflictFormatError()
 
2603
        return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2727
2604
 
2728
2605
    def unlock(self):
2729
2606
        # do non-implementation specific cleanup
2754
2631
     * a format string,
2755
2632
     * an open routine.
2756
2633
 
2757
 
    Formats are placed in an dict by their format string for reference
 
2634
    Formats are placed in an dict by their format string for reference 
2758
2635
    during workingtree opening. Its not required that these be instances, they
2759
 
    can be classes themselves with class methods - it simply depends on
 
2636
    can be classes themselves with class methods - it simply depends on 
2760
2637
    whether state is needed for a given format or not.
2761
2638
 
2762
2639
    Once a format is deprecated, just deprecate the initialize and open
2763
 
    methods on the format class. Do not deprecate the object, as the
 
2640
    methods on the format class. Do not deprecate the object, as the 
2764
2641
    object will be created every time regardless.
2765
2642
    """
2766
2643
 
2779
2656
        """Return the format for the working tree object in a_bzrdir."""
2780
2657
        try:
2781
2658
            transport = a_bzrdir.get_workingtree_transport(None)
2782
 
            format_string = transport.get_bytes("format")
 
2659
            format_string = transport.get("format").read()
2783
2660
            return klass._formats[format_string]
2784
2661
        except errors.NoSuchFile:
2785
2662
            raise errors.NoWorkingTree(base=transport.base)
2810
2687
        """Is this format supported?
2811
2688
 
2812
2689
        Supported formats can be initialized and opened.
2813
 
        Unsupported formats may not support initialization or committing or
 
2690
        Unsupported formats may not support initialization or committing or 
2814
2691
        some other features depending on the reason for not being supported.
2815
2692
        """
2816
2693
        return True
2817
2694
 
2818
 
    def supports_content_filtering(self):
2819
 
        """True if this format supports content filtering."""
2820
 
        return False
2821
 
 
2822
 
    def supports_views(self):
2823
 
        """True if this format supports stored views."""
2824
 
        return False
2825
 
 
2826
2695
    @classmethod
2827
2696
    def register_format(klass, format):
2828
2697
        klass._formats[format.get_format_string()] = format
2837
2706
 
2838
2707
 
2839
2708
class WorkingTreeFormat2(WorkingTreeFormat):
2840
 
    """The second working tree format.
 
2709
    """The second working tree format. 
2841
2710
 
2842
2711
    This format modified the hash cache from the format 1 hash cache.
2843
2712
    """
2856
2725
        no working tree.  (See bug #43064).
2857
2726
        """
2858
2727
        sio = StringIO()
2859
 
        inv = inventory.Inventory()
 
2728
        inv = Inventory()
2860
2729
        xml5.serializer_v5.write_inventory(inv, sio, working=True)
2861
2730
        sio.seek(0)
2862
2731
        transport.put_file('inventory', sio, file_mode)
2878
2747
            branch.generate_revision_history(revision_id)
2879
2748
        finally:
2880
2749
            branch.unlock()
2881
 
        inv = inventory.Inventory()
 
2750
        inv = Inventory()
2882
2751
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2883
2752
                         branch,
2884
2753
                         inv,
2929
2798
        - is new in bzr 0.8
2930
2799
        - uses a LockDir to guard access for writes.
2931
2800
    """
2932
 
 
 
2801
    
2933
2802
    upgrade_recommended = True
2934
2803
 
2935
2804
    def get_format_string(self):
2952
2821
 
2953
2822
    def _open_control_files(self, a_bzrdir):
2954
2823
        transport = a_bzrdir.get_workingtree_transport(None)
2955
 
        return LockableFiles(transport, self._lock_file_name,
 
2824
        return LockableFiles(transport, self._lock_file_name, 
2956
2825
                             self._lock_class)
2957
2826
 
2958
2827
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2959
2828
                   accelerator_tree=None, hardlink=False):
2960
2829
        """See WorkingTreeFormat.initialize().
2961
 
 
 
2830
        
2962
2831
        :param revision_id: if supplied, create a working tree at a different
2963
2832
            revision than the branch is at.
2964
2833
        :param accelerator_tree: A tree which can be used for retrieving file
2975
2844
        control_files.create_lock()
2976
2845
        control_files.lock_write()
2977
2846
        transport.put_bytes('format', self.get_format_string(),
2978
 
            mode=a_bzrdir._get_file_mode())
 
2847
            mode=control_files._file_mode)
2979
2848
        if from_branch is not None:
2980
2849
            branch = from_branch
2981
2850
        else:
3001
2870
            # only set an explicit root id if there is one to set.
3002
2871
            if basis_tree.inventory.root is not None:
3003
2872
                wt.set_root_id(basis_tree.get_root_id())
3004
 
            if revision_id == _mod_revision.NULL_REVISION:
 
2873
            if revision_id == NULL_REVISION:
3005
2874
                wt.set_parent_trees([])
3006
2875
            else:
3007
2876
                wt.set_parent_trees([(revision_id, basis_tree)])
3014
2883
        return wt
3015
2884
 
3016
2885
    def _initial_inventory(self):
3017
 
        return inventory.Inventory()
 
2886
        return Inventory()
3018
2887
 
3019
2888
    def __init__(self):
3020
2889
        super(WorkingTreeFormat3, self).__init__()
3035
2904
 
3036
2905
    def _open(self, a_bzrdir, control_files):
3037
2906
        """Open the tree itself.
3038
 
 
 
2907
        
3039
2908
        :param a_bzrdir: the dir for the tree.
3040
2909
        :param control_files: the control files for the tree.
3041
2910
        """
3049
2918
        return self.get_format_string()
3050
2919
 
3051
2920
 
3052
 
__default_format = WorkingTreeFormat6()
 
2921
__default_format = WorkingTreeFormat4()
3053
2922
WorkingTreeFormat.register_format(__default_format)
3054
 
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3055
 
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3056
2923
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3057
2924
WorkingTreeFormat.set_default_format(__default_format)
3058
2925
# formats which have no format string are not discoverable