~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Jelmer Vernooij
  • Date: 2009-02-10 04:10:44 UTC
  • mto: This revision was merged to the branch mainline in revision 3995.
  • Revision ID: jelmer@samba.org-20090210041044-42lmb09hskt9lt9l
Review from Ian.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""WorkingTree object and friends.
18
18
 
19
19
A WorkingTree represents the editable working copy of a branch.
20
 
Operations which represent the WorkingTree are also done here,
21
 
such as renaming or adding files.  The WorkingTree has an inventory
22
 
which is updated by these operations.  A commit produces a
 
20
Operations which represent the WorkingTree are also done here, 
 
21
such as renaming or adding files.  The WorkingTree has an inventory 
 
22
which is updated by these operations.  A commit produces a 
23
23
new revision based on the workingtree and its inventory.
24
24
 
25
25
At the moment every WorkingTree has its own branch.  Remote
29
29
WorkingTree.open(dir).
30
30
"""
31
31
 
 
32
# TODO: Give the workingtree sole responsibility for the working inventory;
 
33
# remove the variable and references to it from the branch.  This may require
 
34
# updating the commit code so as to update the inventory within the working
 
35
# copy, and making sure there's only one WorkingTree for any directory on disk.
 
36
# At the moment they may alias the inventory and have old copies of it in
 
37
# memory.  (Now done? -- mbp 20060309)
32
38
 
33
39
from cStringIO import StringIO
34
40
import os
42
48
import itertools
43
49
import operator
44
50
import stat
 
51
from time import time
 
52
import warnings
45
53
import re
46
54
 
47
55
import bzrlib
49
57
    branch,
50
58
    bzrdir,
51
59
    conflicts as _mod_conflicts,
 
60
    dirstate,
52
61
    errors,
53
62
    generate_ids,
54
63
    globbing,
55
 
    graph as _mod_graph,
56
64
    hashcache,
57
65
    ignores,
58
 
    inventory,
59
66
    merge,
60
67
    revision as _mod_revision,
61
68
    revisiontree,
 
69
    repository,
 
70
    textui,
62
71
    trace,
63
72
    transform,
64
 
    transport,
65
73
    ui,
66
 
    views,
 
74
    urlutils,
67
75
    xml5,
 
76
    xml6,
68
77
    xml7,
69
78
    )
70
 
from bzrlib.workingtree_4 import (
71
 
    WorkingTreeFormat4,
72
 
    WorkingTreeFormat5,
73
 
    WorkingTreeFormat6,
74
 
    )
 
79
import bzrlib.branch
 
80
from bzrlib.transport import get_transport
 
81
import bzrlib.ui
 
82
from bzrlib.workingtree_4 import WorkingTreeFormat4, WorkingTreeFormat5
75
83
""")
76
84
 
77
85
from bzrlib import symbol_versioning
78
86
from bzrlib.decorators import needs_read_lock, needs_write_lock
79
 
from bzrlib.lock import LogicalLockResult
 
87
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
80
88
from bzrlib.lockable_files import LockableFiles
81
89
from bzrlib.lockdir import LockDir
82
90
import bzrlib.mutabletree
83
91
from bzrlib.mutabletree import needs_tree_write_lock
84
92
from bzrlib import osutils
85
93
from bzrlib.osutils import (
 
94
    compact_date,
86
95
    file_kind,
87
96
    isdir,
88
97
    normpath,
89
98
    pathjoin,
 
99
    rand_chars,
90
100
    realpath,
91
101
    safe_unicode,
92
102
    splitpath,
93
103
    supports_executable,
94
104
    )
95
 
from bzrlib.filters import filtered_input_file
96
105
from bzrlib.trace import mutter, note
97
106
from bzrlib.transport.local import LocalTransport
98
 
from bzrlib.revision import CURRENT_REVISION
 
107
from bzrlib.progress import DummyProgress, ProgressPhase
 
108
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
99
109
from bzrlib.rio import RioReader, rio_file, Stanza
100
 
from bzrlib.symbol_versioning import (
101
 
    deprecated_passed,
102
 
    DEPRECATED_PARAMETER,
103
 
    )
 
110
from bzrlib.symbol_versioning import (deprecated_passed,
 
111
        deprecated_method,
 
112
        deprecated_function,
 
113
        DEPRECATED_PARAMETER,
 
114
        )
104
115
 
105
116
 
106
117
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
107
 
# TODO: Modifying the conflict objects or their type is currently nearly
108
 
# impossible as there is no clear relationship between the working tree format
109
 
# and the conflict list file format.
110
118
CONFLICT_HEADER_1 = "BZR conflict list format 1"
111
119
 
112
120
ERROR_PATH_NOT_FOUND = 3    # WindowsError errno code, equivalent to ENOENT
115
123
class TreeEntry(object):
116
124
    """An entry that implements the minimum interface used by commands.
117
125
 
118
 
    This needs further inspection, it may be better to have
 
126
    This needs further inspection, it may be better to have 
119
127
    InventoryEntries without ids - though that seems wrong. For now,
120
128
    this is a parallel hierarchy to InventoryEntry, and needs to become
121
129
    one of several things: decorates to that hierarchy, children of, or
124
132
    no InventoryEntry available - i.e. for unversioned objects.
125
133
    Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
126
134
    """
127
 
 
 
135
 
128
136
    def __eq__(self, other):
129
137
        # yes, this us ugly, TODO: best practice __eq__ style.
130
138
        return (isinstance(other, TreeEntry)
131
139
                and other.__class__ == self.__class__)
132
 
 
 
140
 
133
141
    def kind_character(self):
134
142
        return "???"
135
143
 
167
175
        return ''
168
176
 
169
177
 
170
 
class WorkingTree(bzrlib.mutabletree.MutableTree,
171
 
    bzrdir.ControlComponent):
 
178
class WorkingTree(bzrlib.mutabletree.MutableTree):
172
179
    """Working copy tree.
173
180
 
174
181
    The inventory is held in the `Branch` working-inventory, and the
176
183
 
177
184
    It is possible for a `WorkingTree` to have a filename which is
178
185
    not listed in the Inventory and vice versa.
179
 
 
180
 
    :ivar basedir: The root of the tree on disk. This is a unicode path object
181
 
        (as opposed to a URL).
182
186
    """
183
187
 
184
 
    # override this to set the strategy for storing views
185
 
    def _make_views(self):
186
 
        return views.DisabledViews(self)
187
 
 
188
188
    def __init__(self, basedir='.',
189
189
                 branch=DEPRECATED_PARAMETER,
190
190
                 _inventory=None,
225
225
        wt_trans = self.bzrdir.get_workingtree_transport(None)
226
226
        cache_filename = wt_trans.local_abspath('stat-cache')
227
227
        self._hashcache = hashcache.HashCache(basedir, cache_filename,
228
 
            self.bzrdir._get_file_mode(),
229
 
            self._content_filter_stack_provider())
 
228
            self.bzrdir._get_file_mode())
230
229
        hc = self._hashcache
231
230
        hc.read()
232
231
        # is this scan needed ? it makes things kinda slow.
248
247
            self._set_inventory(_inventory, dirty=False)
249
248
        self._detect_case_handling()
250
249
        self._rules_searcher = None
251
 
        self.views = self._make_views()
252
 
 
253
 
    @property
254
 
    def user_transport(self):
255
 
        return self.bzrdir.user_transport
256
 
 
257
 
    @property
258
 
    def control_transport(self):
259
 
        return self._transport
260
250
 
261
251
    def _detect_case_handling(self):
262
252
        wt_trans = self.bzrdir.get_workingtree_transport(None)
288
278
        self._control_files.break_lock()
289
279
        self.branch.break_lock()
290
280
 
291
 
    def _get_check_refs(self):
292
 
        """Return the references needed to perform a check of this tree.
293
 
        
294
 
        The default implementation returns no refs, and is only suitable for
295
 
        trees that have no local caching and can commit on ghosts at any time.
296
 
 
297
 
        :seealso: bzrlib.check for details about check_refs.
298
 
        """
299
 
        return []
300
 
 
301
281
    def requires_rich_root(self):
302
282
        return self._format.requires_rich_root
303
283
 
308
288
        return self._format.supports_content_filtering()
309
289
 
310
290
    def supports_views(self):
311
 
        return self.views.supports_views()
 
291
        return self._format.supports_views()
312
292
 
313
293
    def _set_inventory(self, inv, dirty):
314
294
        """Set the internal cached inventory.
371
351
                return True, None
372
352
            else:
373
353
                return True, tree
374
 
        t = transport.get_transport(location)
375
 
        iterator = bzrdir.BzrDir.find_bzrdirs(t, evaluate=evaluate,
 
354
        transport = get_transport(location)
 
355
        iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
376
356
                                              list_current=list_current)
377
 
        return [tr for tr in iterator if tr is not None]
 
357
        return [t for t in iterator if t is not None]
378
358
 
379
359
    # should be deprecated - this is slow and in any case treating them as a
380
360
    # container is (we now know) bad style -- mbp 20070302
403
383
 
404
384
    def basis_tree(self):
405
385
        """Return RevisionTree for the current last revision.
406
 
 
 
386
        
407
387
        If the left most parent is a ghost then the returned tree will be an
408
 
        empty tree - one obtained by calling
 
388
        empty tree - one obtained by calling 
409
389
        repository.revision_tree(NULL_REVISION).
410
390
        """
411
391
        try:
427
407
            return self.branch.repository.revision_tree(revision_id)
428
408
        except (errors.RevisionNotPresent, errors.NoSuchRevision):
429
409
            # the basis tree *may* be a ghost or a low level error may have
430
 
            # occurred. If the revision is present, its a problem, if its not
 
410
            # occured. If the revision is present, its a problem, if its not
431
411
            # its a ghost.
432
412
            if self.branch.repository.has_revision(revision_id):
433
413
                raise
440
420
 
441
421
    def relpath(self, path):
442
422
        """Return the local path portion from a given path.
443
 
 
444
 
        The path may be absolute or relative. If its a relative path it is
 
423
        
 
424
        The path may be absolute or relative. If its a relative path it is 
445
425
        interpreted relative to the python current working directory.
446
426
        """
447
427
        return osutils.relpath(self.basedir, path)
449
429
    def has_filename(self, filename):
450
430
        return osutils.lexists(self.abspath(filename))
451
431
 
452
 
    def get_file(self, file_id, path=None, filtered=True):
453
 
        return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
 
432
    def get_file(self, file_id, path=None):
 
433
        return self.get_file_with_stat(file_id, path)[0]
454
434
 
455
 
    def get_file_with_stat(self, file_id, path=None, filtered=True,
456
 
        _fstat=os.fstat):
457
 
        """See Tree.get_file_with_stat."""
 
435
    def get_file_with_stat(self, file_id, path=None, _fstat=os.fstat):
 
436
        """See MutableTree.get_file_with_stat."""
458
437
        if path is None:
459
438
            path = self.id2path(file_id)
460
 
        file_obj = self.get_file_byname(path, filtered=False)
461
 
        stat_value = _fstat(file_obj.fileno())
462
 
        if filtered and self.supports_content_filtering():
463
 
            filters = self._content_filter_stack(path)
464
 
            file_obj = filtered_input_file(file_obj, filters)
465
 
        return (file_obj, stat_value)
466
 
 
467
 
    def get_file_text(self, file_id, path=None, filtered=True):
468
 
        my_file = self.get_file(file_id, path=path, filtered=filtered)
469
 
        try:
470
 
            return my_file.read()
471
 
        finally:
472
 
            my_file.close()
473
 
 
474
 
    def get_file_byname(self, filename, filtered=True):
475
 
        path = self.abspath(filename)
476
 
        f = file(path, 'rb')
477
 
        if filtered and self.supports_content_filtering():
478
 
            filters = self._content_filter_stack(filename)
479
 
            return filtered_input_file(f, filters)
480
 
        else:
481
 
            return f
482
 
 
483
 
    def get_file_lines(self, file_id, path=None, filtered=True):
 
439
        file_obj = self.get_file_byname(path)
 
440
        return (file_obj, _fstat(file_obj.fileno()))
 
441
 
 
442
    def get_file_byname(self, filename):
 
443
        return file(self.abspath(filename), 'rb')
 
444
 
 
445
    def get_file_lines(self, file_id, path=None):
484
446
        """See Tree.get_file_lines()"""
485
 
        file = self.get_file(file_id, path, filtered=filtered)
 
447
        file = self.get_file(file_id, path)
486
448
        try:
487
449
            return file.readlines()
488
450
        finally:
499
461
        incorrectly attributed to CURRENT_REVISION (but after committing, the
500
462
        attribution will be correct).
501
463
        """
502
 
        maybe_file_parent_keys = []
503
 
        for parent_id in self.get_parent_ids():
504
 
            try:
505
 
                parent_tree = self.revision_tree(parent_id)
506
 
            except errors.NoSuchRevisionInTree:
507
 
                parent_tree = self.branch.repository.revision_tree(parent_id)
508
 
            parent_tree.lock_read()
509
 
            try:
510
 
                if file_id not in parent_tree:
511
 
                    continue
512
 
                ie = parent_tree.inventory[file_id]
513
 
                if ie.kind != 'file':
514
 
                    # Note: this is slightly unnecessary, because symlinks and
515
 
                    # directories have a "text" which is the empty text, and we
516
 
                    # know that won't mess up annotations. But it seems cleaner
517
 
                    continue
518
 
                parent_text_key = (file_id, ie.revision)
519
 
                if parent_text_key not in maybe_file_parent_keys:
520
 
                    maybe_file_parent_keys.append(parent_text_key)
521
 
            finally:
522
 
                parent_tree.unlock()
523
 
        graph = _mod_graph.Graph(self.branch.repository.texts)
524
 
        heads = graph.heads(maybe_file_parent_keys)
525
 
        file_parent_keys = []
526
 
        for key in maybe_file_parent_keys:
527
 
            if key in heads:
528
 
                file_parent_keys.append(key)
529
 
 
530
 
        # Now we have the parents of this content
531
 
        annotator = self.branch.repository.texts.get_annotator()
532
 
        text = self.get_file_text(file_id)
533
 
        this_key =(file_id, default_revision)
534
 
        annotator.add_special_text(this_key, file_parent_keys, text)
535
 
        annotations = [(key[-1], line)
536
 
                       for key, line in annotator.annotate_flat(this_key)]
537
 
        return annotations
 
464
        basis = self.basis_tree()
 
465
        basis.lock_read()
 
466
        try:
 
467
            changes = self.iter_changes(basis, True, [self.id2path(file_id)],
 
468
                require_versioned=True).next()
 
469
            changed_content, kind = changes[2], changes[6]
 
470
            if not changed_content:
 
471
                return basis.annotate_iter(file_id)
 
472
            if kind[1] is None:
 
473
                return None
 
474
            import annotate
 
475
            if kind[0] != 'file':
 
476
                old_lines = []
 
477
            else:
 
478
                old_lines = list(basis.annotate_iter(file_id))
 
479
            old = [old_lines]
 
480
            for tree in self.branch.repository.revision_trees(
 
481
                self.get_parent_ids()[1:]):
 
482
                if file_id not in tree:
 
483
                    continue
 
484
                old.append(list(tree.annotate_iter(file_id)))
 
485
            return annotate.reannotate(old, self.get_file(file_id).readlines(),
 
486
                                       default_revision)
 
487
        finally:
 
488
            basis.unlock()
538
489
 
539
490
    def _get_ancestors(self, default_revision):
540
491
        ancestors = set([default_revision])
545
496
 
546
497
    def get_parent_ids(self):
547
498
        """See Tree.get_parent_ids.
548
 
 
 
499
        
549
500
        This implementation reads the pending merges list and last_revision
550
501
        value and uses that to decide what the parents list should be.
551
502
        """
555
506
        else:
556
507
            parents = [last_rev]
557
508
        try:
558
 
            merges_bytes = self._transport.get_bytes('pending-merges')
 
509
            merges_file = self._transport.get('pending-merges')
559
510
        except errors.NoSuchFile:
560
511
            pass
561
512
        else:
562
 
            for l in osutils.split_lines(merges_bytes):
 
513
            for l in merges_file.readlines():
563
514
                revision_id = l.rstrip('\n')
564
515
                parents.append(revision_id)
565
516
        return parents
568
519
    def get_root_id(self):
569
520
        """Return the id of this trees root"""
570
521
        return self._inventory.root.file_id
571
 
 
 
522
        
572
523
    def _get_store_filename(self, file_id):
573
524
        ## XXX: badly named; this is not in the store at all
574
525
        return self.abspath(self.id2path(file_id))
576
527
    @needs_read_lock
577
528
    def clone(self, to_bzrdir, revision_id=None):
578
529
        """Duplicate this working tree into to_bzr, including all state.
579
 
 
 
530
        
580
531
        Specifically modified files are kept as modified, but
581
532
        ignored and unknown files are discarded.
582
533
 
583
534
        If you want to make a new line of development, see bzrdir.sprout()
584
535
 
585
536
        revision
586
 
            If not None, the cloned tree will have its last revision set to
587
 
            revision, and difference between the source trees last revision
 
537
            If not None, the cloned tree will have its last revision set to 
 
538
            revision, and and difference between the source trees last revision
588
539
            and this one merged in.
589
540
        """
590
541
        # assumes the target bzr dir format is compatible.
624
575
 
625
576
    def get_file_size(self, file_id):
626
577
        """See Tree.get_file_size"""
627
 
        # XXX: this returns the on-disk size; it should probably return the
628
 
        # canonical size
629
578
        try:
630
579
            return os.path.getsize(self.id2abspath(file_id))
631
580
        except OSError, e:
647
596
 
648
597
    def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
649
598
        file_id = self.path2id(path)
650
 
        if file_id is None:
651
 
            # For unversioned files on win32, we just assume they are not
652
 
            # executable
653
 
            return False
654
599
        return self._inventory[file_id].executable
655
600
 
656
601
    def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
678
623
        """See MutableTree._add."""
679
624
        # TODO: Re-adding a file that is removed in the working copy
680
625
        # should probably put it back with the previous ID.
681
 
        # the read and write working inventory should not occur in this
 
626
        # the read and write working inventory should not occur in this 
682
627
        # function - they should be part of lock_write and unlock.
683
628
        inv = self.inventory
684
629
        for f, file_id, kind in zip(files, ids, kinds):
766
711
            raise
767
712
        kind = _mapper(stat_result.st_mode)
768
713
        if kind == 'file':
769
 
            return self._file_content_summary(path, stat_result)
 
714
            size = stat_result.st_size
 
715
            # try for a stat cache lookup
 
716
            executable = self._is_executable_from_path_and_stat(path, stat_result)
 
717
            return (kind, size, executable, self._sha_from_stat(
 
718
                path, stat_result))
770
719
        elif kind == 'directory':
771
720
            # perhaps it looks like a plain directory, but it's really a
772
721
            # reference.
774
723
                kind = 'tree-reference'
775
724
            return kind, None, None, None
776
725
        elif kind == 'symlink':
777
 
            target = osutils.readlink(abspath)
778
 
            return ('symlink', None, None, target)
 
726
            return ('symlink', None, None, os.readlink(abspath.encode(osutils._fs_enc)))
779
727
        else:
780
728
            return (kind, None, None, None)
781
729
 
782
 
    def _file_content_summary(self, path, stat_result):
783
 
        size = stat_result.st_size
784
 
        executable = self._is_executable_from_path_and_stat(path, stat_result)
785
 
        # try for a stat cache lookup
786
 
        return ('file', size, executable, self._sha_from_stat(
787
 
            path, stat_result))
788
 
 
789
730
    def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
790
731
        """Common ghost checking functionality from set_parent_*.
791
732
 
801
742
    def _set_merges_from_parent_ids(self, parent_ids):
802
743
        merges = parent_ids[1:]
803
744
        self._transport.put_bytes('pending-merges', '\n'.join(merges),
804
 
            mode=self.bzrdir._get_file_mode())
 
745
            mode=self._control_files._file_mode)
805
746
 
806
747
    def _filter_parent_ids_by_ancestry(self, revision_ids):
807
748
        """Check that all merged revisions are proper 'heads'.
808
749
 
809
750
        This will always return the first revision_id, and any merged revisions
810
 
        which are
 
751
        which are 
811
752
        """
812
753
        if len(revision_ids) == 0:
813
754
            return revision_ids
825
766
    @needs_tree_write_lock
826
767
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
827
768
        """Set the parent ids to revision_ids.
828
 
 
 
769
        
829
770
        See also set_parent_trees. This api will try to retrieve the tree data
830
771
        for each element of revision_ids from the trees repository. If you have
831
772
        tree data already available, it is more efficient to use
907
848
        self._must_be_locked()
908
849
        my_file = rio_file(stanzas, header)
909
850
        self._transport.put_file(filename, my_file,
910
 
            mode=self.bzrdir._get_file_mode())
 
851
            mode=self._control_files._file_mode)
911
852
 
912
853
    @needs_write_lock # because merge pulls data into the branch.
913
854
    def merge_from_branch(self, branch, to_revision=None, from_revision=None,
914
 
                          merge_type=None, force=False):
 
855
        merge_type=None):
915
856
        """Merge from a branch into this working tree.
916
857
 
917
858
        :param branch: The branch to merge from.
921
862
            branch.last_revision().
922
863
        """
923
864
        from bzrlib.merge import Merger, Merge3Merger
924
 
        merger = Merger(self.branch, this_tree=self)
925
 
        # check that there are no local alterations
926
 
        if not force and self.has_changes():
927
 
            raise errors.UncommittedChanges(self)
928
 
        if to_revision is None:
929
 
            to_revision = _mod_revision.ensure_null(branch.last_revision())
930
 
        merger.other_rev_id = to_revision
931
 
        if _mod_revision.is_null(merger.other_rev_id):
932
 
            raise errors.NoCommits(branch)
933
 
        self.branch.fetch(branch, last_revision=merger.other_rev_id)
934
 
        merger.other_basis = merger.other_rev_id
935
 
        merger.other_tree = self.branch.repository.revision_tree(
936
 
            merger.other_rev_id)
937
 
        merger.other_branch = branch
938
 
        if from_revision is None:
939
 
            merger.find_base()
940
 
        else:
941
 
            merger.set_base_revision(from_revision, branch)
942
 
        if merger.base_rev_id == merger.other_rev_id:
943
 
            raise errors.PointlessMerge
944
 
        merger.backup_files = False
945
 
        if merge_type is None:
946
 
            merger.merge_type = Merge3Merger
947
 
        else:
948
 
            merger.merge_type = merge_type
949
 
        merger.set_interesting_files(None)
950
 
        merger.show_base = False
951
 
        merger.reprocess = False
952
 
        conflicts = merger.do_merge()
953
 
        merger.set_pending()
 
865
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
866
        try:
 
867
            merger = Merger(self.branch, this_tree=self, pb=pb)
 
868
            merger.pp = ProgressPhase("Merge phase", 5, pb)
 
869
            merger.pp.next_phase()
 
870
            # check that there are no
 
871
            # local alterations
 
872
            merger.check_basis(check_clean=True, require_commits=False)
 
873
            if to_revision is None:
 
874
                to_revision = _mod_revision.ensure_null(branch.last_revision())
 
875
            merger.other_rev_id = to_revision
 
876
            if _mod_revision.is_null(merger.other_rev_id):
 
877
                raise errors.NoCommits(branch)
 
878
            self.branch.fetch(branch, last_revision=merger.other_rev_id)
 
879
            merger.other_basis = merger.other_rev_id
 
880
            merger.other_tree = self.branch.repository.revision_tree(
 
881
                merger.other_rev_id)
 
882
            merger.other_branch = branch
 
883
            merger.pp.next_phase()
 
884
            if from_revision is None:
 
885
                merger.find_base()
 
886
            else:
 
887
                merger.set_base_revision(from_revision, branch)
 
888
            if merger.base_rev_id == merger.other_rev_id:
 
889
                raise errors.PointlessMerge
 
890
            merger.backup_files = False
 
891
            if merge_type is None:
 
892
                merger.merge_type = Merge3Merger
 
893
            else:
 
894
                merger.merge_type = merge_type
 
895
            merger.set_interesting_files(None)
 
896
            merger.show_base = False
 
897
            merger.reprocess = False
 
898
            conflicts = merger.do_merge()
 
899
            merger.set_pending()
 
900
        finally:
 
901
            pb.finished()
954
902
        return conflicts
955
903
 
956
904
    @needs_read_lock
957
905
    def merge_modified(self):
958
906
        """Return a dictionary of files modified by a merge.
959
907
 
960
 
        The list is initialized by WorkingTree.set_merge_modified, which is
 
908
        The list is initialized by WorkingTree.set_merge_modified, which is 
961
909
        typically called after we make some automatic updates to the tree
962
910
        because of a merge.
963
911
 
997
945
        return file_id
998
946
 
999
947
    def get_symlink_target(self, file_id):
1000
 
        abspath = self.id2abspath(file_id)
1001
 
        target = osutils.readlink(abspath)
1002
 
        return target
 
948
        return os.readlink(self.id2abspath(file_id).encode(osutils._fs_enc))
1003
949
 
1004
950
    @needs_write_lock
1005
951
    def subsume(self, other_tree):
1055
1001
        return False
1056
1002
 
1057
1003
    def _directory_may_be_tree_reference(self, relpath):
1058
 
        # as a special case, if a directory contains control files then
 
1004
        # as a special case, if a directory contains control files then 
1059
1005
        # it's a tree reference, except that the root of the tree is not
1060
1006
        return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1061
1007
        # TODO: We could ask all the control formats whether they
1072
1018
    @needs_tree_write_lock
1073
1019
    def extract(self, file_id, format=None):
1074
1020
        """Extract a subtree from this tree.
1075
 
 
 
1021
        
1076
1022
        A new branch will be created, relative to the path for this tree.
1077
1023
        """
1078
1024
        self.flush()
1083
1029
                transport = transport.clone(name)
1084
1030
                transport.ensure_base()
1085
1031
            return transport
1086
 
 
 
1032
            
1087
1033
        sub_path = self.id2path(file_id)
1088
1034
        branch_transport = mkdirs(sub_path)
1089
1035
        if format is None:
1103
1049
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
1104
1050
        if tree_transport.base != branch_transport.base:
1105
1051
            tree_bzrdir = format.initialize_on_transport(tree_transport)
1106
 
            branch.BranchReferenceFormat().initialize(tree_bzrdir,
1107
 
                target_branch=new_branch)
 
1052
            branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1108
1053
        else:
1109
1054
            tree_bzrdir = branch_bzrdir
1110
 
        wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
 
1055
        wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1111
1056
        wt.set_parent_ids(self.get_parent_ids())
1112
1057
        my_inv = self.inventory
1113
 
        child_inv = inventory.Inventory(root_id=None)
 
1058
        child_inv = Inventory(root_id=None)
1114
1059
        new_root = my_inv[file_id]
1115
1060
        my_inv.remove_recursive_id(file_id)
1116
1061
        new_root.parent_id = None
1135
1080
        self._serialize(self._inventory, sio)
1136
1081
        sio.seek(0)
1137
1082
        self._transport.put_file('inventory', sio,
1138
 
            mode=self.bzrdir._get_file_mode())
 
1083
            mode=self._control_files._file_mode)
1139
1084
        self._inventory_is_modified = False
1140
1085
 
1141
1086
    def _kind(self, relpath):
1142
1087
        return osutils.file_kind(self.abspath(relpath))
1143
1088
 
1144
 
    def list_files(self, include_root=False, from_dir=None, recursive=True):
1145
 
        """List all files as (path, class, kind, id, entry).
 
1089
    def list_files(self, include_root=False):
 
1090
        """Recursively list all files as (path, class, kind, id, entry).
1146
1091
 
1147
1092
        Lists, but does not descend into unversioned directories.
 
1093
 
1148
1094
        This does not include files that have been deleted in this
1149
 
        tree. Skips the control directory.
 
1095
        tree.
1150
1096
 
1151
 
        :param include_root: if True, return an entry for the root
1152
 
        :param from_dir: start from this directory or None for the root
1153
 
        :param recursive: whether to recurse into subdirectories or not
 
1097
        Skips the control directory.
1154
1098
        """
1155
1099
        # list_files is an iterator, so @needs_read_lock doesn't work properly
1156
1100
        # with it. So callers should be careful to always read_lock the tree.
1158
1102
            raise errors.ObjectNotLocked(self)
1159
1103
 
1160
1104
        inv = self.inventory
1161
 
        if from_dir is None and include_root is True:
 
1105
        if include_root is True:
1162
1106
            yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1163
1107
        # Convert these into local objects to save lookup times
1164
1108
        pathjoin = osutils.pathjoin
1171
1115
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1172
1116
 
1173
1117
        # directory file_id, relative path, absolute path, reverse sorted children
1174
 
        if from_dir is not None:
1175
 
            from_dir_id = inv.path2id(from_dir)
1176
 
            if from_dir_id is None:
1177
 
                # Directory not versioned
1178
 
                return
1179
 
            from_dir_abspath = pathjoin(self.basedir, from_dir)
1180
 
        else:
1181
 
            from_dir_id = inv.root.file_id
1182
 
            from_dir_abspath = self.basedir
1183
 
        children = os.listdir(from_dir_abspath)
 
1118
        children = os.listdir(self.basedir)
1184
1119
        children.sort()
1185
 
        # jam 20060527 The kernel sized tree seems equivalent whether we
 
1120
        # jam 20060527 The kernel sized tree seems equivalent whether we 
1186
1121
        # use a deque and popleft to keep them sorted, or if we use a plain
1187
1122
        # list and just reverse() them.
1188
1123
        children = collections.deque(children)
1189
 
        stack = [(from_dir_id, u'', from_dir_abspath, children)]
 
1124
        stack = [(inv.root.file_id, u'', self.basedir, children)]
1190
1125
        while stack:
1191
1126
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1192
1127
 
1208
1143
 
1209
1144
                # absolute path
1210
1145
                fap = from_dir_abspath + '/' + f
1211
 
 
 
1146
                
1212
1147
                f_ie = inv.get_child(from_dir_id, f)
1213
1148
                if f_ie:
1214
1149
                    c = 'V'
1246
1181
                    except KeyError:
1247
1182
                        yield fp[1:], c, fk, None, TreeEntry()
1248
1183
                    continue
1249
 
 
 
1184
                
1250
1185
                if fk != 'directory':
1251
1186
                    continue
1252
1187
 
1253
 
                # But do this child first if recursing down
1254
 
                if recursive:
1255
 
                    new_children = os.listdir(fap)
1256
 
                    new_children.sort()
1257
 
                    new_children = collections.deque(new_children)
1258
 
                    stack.append((f_ie.file_id, fp, fap, new_children))
1259
 
                    # Break out of inner loop,
1260
 
                    # so that we start outer loop with child
1261
 
                    break
 
1188
                # But do this child first
 
1189
                new_children = os.listdir(fap)
 
1190
                new_children.sort()
 
1191
                new_children = collections.deque(new_children)
 
1192
                stack.append((f_ie.file_id, fp, fap, new_children))
 
1193
                # Break out of inner loop,
 
1194
                # so that we start outer loop with child
 
1195
                break
1262
1196
            else:
1263
1197
                # if we finished all children, pop it off the stack
1264
1198
                stack.pop()
1270
1204
        to_dir must exist in the inventory.
1271
1205
 
1272
1206
        If to_dir exists and is a directory, the files are moved into
1273
 
        it, keeping their old names.
 
1207
        it, keeping their old names.  
1274
1208
 
1275
1209
        Note that to_dir is only the last component of the new name;
1276
1210
        this doesn't change the directory.
1442
1376
        inv = self.inventory
1443
1377
        for entry in moved:
1444
1378
            try:
1445
 
                self._move_entry(WorkingTree._RenameEntry(
1446
 
                    entry.to_rel, entry.from_id,
 
1379
                self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1447
1380
                    entry.to_tail, entry.to_parent_id, entry.from_rel,
1448
1381
                    entry.from_tail, entry.from_parent_id,
1449
1382
                    entry.only_change_inv))
1500
1433
        from_tail = splitpath(from_rel)[-1]
1501
1434
        from_id = inv.path2id(from_rel)
1502
1435
        if from_id is None:
1503
 
            # if file is missing in the inventory maybe it's in the basis_tree
1504
 
            basis_tree = self.branch.basis_tree()
1505
 
            from_id = basis_tree.path2id(from_rel)
1506
 
            if from_id is None:
1507
 
                raise errors.BzrRenameFailedError(from_rel,to_rel,
1508
 
                    errors.NotVersionedError(path=str(from_rel)))
1509
 
            # put entry back in the inventory so we can rename it
1510
 
            from_entry = basis_tree.inventory[from_id].copy()
1511
 
            inv.add(from_entry)
1512
 
        else:
1513
 
            from_entry = inv[from_id]
 
1436
            raise errors.BzrRenameFailedError(from_rel,to_rel,
 
1437
                errors.NotVersionedError(path=str(from_rel)))
 
1438
        from_entry = inv[from_id]
1514
1439
        from_parent_id = from_entry.parent_id
1515
1440
        to_dir, to_tail = os.path.split(to_rel)
1516
1441
        to_dir_id = inv.path2id(to_dir)
1562
1487
        These are files in the working directory that are not versioned or
1563
1488
        control files or ignored.
1564
1489
        """
1565
 
        # force the extras method to be fully executed before returning, to
 
1490
        # force the extras method to be fully executed before returning, to 
1566
1491
        # prevent race conditions with the lock
1567
1492
        return iter(
1568
1493
            [subp for subp in self.extras() if not self.is_ignored(subp)])
1578
1503
        :raises: NoSuchId if any fileid is not currently versioned.
1579
1504
        """
1580
1505
        for file_id in file_ids:
1581
 
            if file_id not in self._inventory:
1582
 
                raise errors.NoSuchId(self, file_id)
1583
 
        for file_id in file_ids:
1584
1506
            if self._inventory.has_id(file_id):
1585
1507
                self._inventory.remove_recursive_id(file_id)
 
1508
            else:
 
1509
                raise errors.NoSuchId(self, file_id)
1586
1510
        if len(file_ids):
1587
 
            # in the future this should just set a dirty bit to wait for the
 
1511
            # in the future this should just set a dirty bit to wait for the 
1588
1512
            # final unlock. However, until all methods of workingtree start
1589
 
            # with the current in -memory inventory rather than triggering
 
1513
            # with the current in -memory inventory rather than triggering 
1590
1514
            # a read, it is more complex - we need to teach read_inventory
1591
1515
            # to know when to read, and when to not read first... and possibly
1592
1516
            # to save first when the in memory one may be corrupted.
1593
1517
            # so for now, we just only write it if it is indeed dirty.
1594
1518
            # - RBC 20060907
1595
1519
            self._write_inventory(self._inventory)
1596
 
 
 
1520
    
1597
1521
    def _iter_conflicts(self):
1598
1522
        conflicted = set()
1599
1523
        for info in self.list_files():
1607
1531
 
1608
1532
    @needs_write_lock
1609
1533
    def pull(self, source, overwrite=False, stop_revision=None,
1610
 
             change_reporter=None, possible_transports=None, local=False):
 
1534
             change_reporter=None, possible_transports=None):
 
1535
        top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1611
1536
        source.lock_read()
1612
1537
        try:
 
1538
            pp = ProgressPhase("Pull phase", 2, top_pb)
 
1539
            pp.next_phase()
1613
1540
            old_revision_info = self.branch.last_revision_info()
1614
1541
            basis_tree = self.basis_tree()
1615
1542
            count = self.branch.pull(source, overwrite, stop_revision,
1616
 
                                     possible_transports=possible_transports,
1617
 
                                     local=local)
 
1543
                                     possible_transports=possible_transports)
1618
1544
            new_revision_info = self.branch.last_revision_info()
1619
1545
            if new_revision_info != old_revision_info:
 
1546
                pp.next_phase()
1620
1547
                repository = self.branch.repository
 
1548
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
1621
1549
                basis_tree.lock_read()
1622
1550
                try:
1623
1551
                    new_basis_tree = self.branch.basis_tree()
1626
1554
                                new_basis_tree,
1627
1555
                                basis_tree,
1628
1556
                                this_tree=self,
1629
 
                                pb=None,
 
1557
                                pb=pb,
1630
1558
                                change_reporter=change_reporter)
1631
 
                    basis_root_id = basis_tree.get_root_id()
1632
 
                    new_root_id = new_basis_tree.get_root_id()
1633
 
                    if basis_root_id != new_root_id:
1634
 
                        self.set_root_id(new_root_id)
 
1559
                    if (basis_tree.inventory.root is None and
 
1560
                        new_basis_tree.inventory.root is not None):
 
1561
                        self.set_root_id(new_basis_tree.get_root_id())
1635
1562
                finally:
 
1563
                    pb.finished()
1636
1564
                    basis_tree.unlock()
1637
1565
                # TODO - dedup parents list with things merged by pull ?
1638
1566
                # reuse the revisiontree we merged against to set the new
1639
1567
                # tree data.
1640
1568
                parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1641
 
                # we have to pull the merge trees out again, because
1642
 
                # merge_inner has set the ids. - this corner is not yet
 
1569
                # we have to pull the merge trees out again, because 
 
1570
                # merge_inner has set the ids. - this corner is not yet 
1643
1571
                # layered well enough to prevent double handling.
1644
1572
                # XXX TODO: Fix the double handling: telling the tree about
1645
1573
                # the already known parent data is wasteful.
1651
1579
            return count
1652
1580
        finally:
1653
1581
            source.unlock()
 
1582
            top_pb.finished()
1654
1583
 
1655
1584
    @needs_write_lock
1656
1585
    def put_file_bytes_non_atomic(self, file_id, bytes):
1682
1611
 
1683
1612
            fl = []
1684
1613
            for subf in os.listdir(dirabs):
1685
 
                if self.bzrdir.is_control_filename(subf):
 
1614
                if subf == '.bzr':
1686
1615
                    continue
1687
1616
                if subf not in dir_entry.children:
1688
1617
                    try:
1698
1627
                            fl.append(subf_norm)
1699
1628
                    else:
1700
1629
                        fl.append(subf)
1701
 
 
 
1630
            
1702
1631
            fl.sort()
1703
1632
            for subf in fl:
1704
1633
                subp = pathjoin(path, subf)
1741
1670
        r"""Check whether the filename matches an ignore pattern.
1742
1671
 
1743
1672
        Patterns containing '/' or '\' need to match the whole path;
1744
 
        others match against only the last component.  Patterns starting
1745
 
        with '!' are ignore exceptions.  Exceptions take precedence
1746
 
        over regular patterns and cause the filename to not be ignored.
 
1673
        others match against only the last component.
1747
1674
 
1748
1675
        If the file is ignored, returns the pattern which caused it to
1749
1676
        be ignored, otherwise None.  So this can simply be used as a
1750
1677
        boolean if desired."""
1751
1678
        if getattr(self, '_ignoreglobster', None) is None:
1752
 
            self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
 
1679
            self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1753
1680
        return self._ignoreglobster.match(filename)
1754
1681
 
1755
1682
    def kind(self, file_id):
1805
1732
            raise errors.ObjectNotLocked(self)
1806
1733
 
1807
1734
    def lock_read(self):
1808
 
        """Lock the tree for reading.
1809
 
 
1810
 
        This also locks the branch, and can be unlocked via self.unlock().
1811
 
 
1812
 
        :return: A bzrlib.lock.LogicalLockResult.
1813
 
        """
 
1735
        """See Branch.lock_read, and WorkingTree.unlock."""
1814
1736
        if not self.is_locked():
1815
1737
            self._reset_data()
1816
1738
        self.branch.lock_read()
1817
1739
        try:
1818
 
            self._control_files.lock_read()
1819
 
            return LogicalLockResult(self.unlock)
 
1740
            return self._control_files.lock_read()
1820
1741
        except:
1821
1742
            self.branch.unlock()
1822
1743
            raise
1823
1744
 
1824
1745
    def lock_tree_write(self):
1825
 
        """See MutableTree.lock_tree_write, and WorkingTree.unlock.
1826
 
 
1827
 
        :return: A bzrlib.lock.LogicalLockResult.
1828
 
        """
 
1746
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1829
1747
        if not self.is_locked():
1830
1748
            self._reset_data()
1831
1749
        self.branch.lock_read()
1832
1750
        try:
1833
 
            self._control_files.lock_write()
1834
 
            return LogicalLockResult(self.unlock)
 
1751
            return self._control_files.lock_write()
1835
1752
        except:
1836
1753
            self.branch.unlock()
1837
1754
            raise
1838
1755
 
1839
1756
    def lock_write(self):
1840
 
        """See MutableTree.lock_write, and WorkingTree.unlock.
1841
 
 
1842
 
        :return: A bzrlib.lock.LogicalLockResult.
1843
 
        """
 
1757
        """See MutableTree.lock_write, and WorkingTree.unlock."""
1844
1758
        if not self.is_locked():
1845
1759
            self._reset_data()
1846
1760
        self.branch.lock_write()
1847
1761
        try:
1848
 
            self._control_files.lock_write()
1849
 
            return LogicalLockResult(self.unlock)
 
1762
            return self._control_files.lock_write()
1850
1763
        except:
1851
1764
            self.branch.unlock()
1852
1765
            raise
1860
1773
    def _reset_data(self):
1861
1774
        """Reset transient data that cannot be revalidated."""
1862
1775
        self._inventory_is_modified = False
1863
 
        f = self._transport.get('inventory')
1864
 
        try:
1865
 
            result = self._deserialize(f)
1866
 
        finally:
1867
 
            f.close()
 
1776
        result = self._deserialize(self._transport.get('inventory'))
1868
1777
        self._set_inventory(result, dirty=False)
1869
1778
 
1870
1779
    @needs_tree_write_lock
1875
1784
 
1876
1785
    def _change_last_revision(self, new_revision):
1877
1786
        """Template method part of set_last_revision to perform the change.
1878
 
 
 
1787
        
1879
1788
        This is used to allow WorkingTree3 instances to not affect branch
1880
1789
        when their last revision is set.
1881
1790
        """
1894
1803
        path = self._basis_inventory_name()
1895
1804
        sio = StringIO(xml)
1896
1805
        self._transport.put_file(path, sio,
1897
 
            mode=self.bzrdir._get_file_mode())
 
1806
            mode=self._control_files._file_mode)
1898
1807
 
1899
1808
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
1900
1809
        """Create the text that will be saved in basis-inventory"""
1907
1816
        # as commit already has that ready-to-use [while the format is the
1908
1817
        # same, that is].
1909
1818
        try:
1910
 
            # this double handles the inventory - unpack and repack -
 
1819
            # this double handles the inventory - unpack and repack - 
1911
1820
            # but is easier to understand. We can/should put a conditional
1912
1821
            # in here based on whether the inventory is in the latest format
1913
1822
            # - perhaps we should repack all inventories on a repository
1914
1823
            # upgrade ?
1915
1824
            # the fast path is to copy the raw xml from the repository. If the
1916
 
            # xml contains 'revision_id="', then we assume the right
 
1825
            # xml contains 'revision_id="', then we assume the right 
1917
1826
            # revision_id is set. We must check for this full string, because a
1918
1827
            # root node id can legitimately look like 'revision_id' but cannot
1919
1828
            # contain a '"'.
1920
 
            xml = self.branch.repository._get_inventory_xml(new_revision)
 
1829
            xml = self.branch.repository.get_inventory_xml(new_revision)
1921
1830
            firstline = xml.split('\n', 1)[0]
1922
 
            if (not 'revision_id="' in firstline or
 
1831
            if (not 'revision_id="' in firstline or 
1923
1832
                'format="7"' not in firstline):
1924
 
                inv = self.branch.repository._serializer.read_inventory_from_string(
1925
 
                    xml, new_revision)
 
1833
                inv = self.branch.repository.deserialise_inventory(
 
1834
                    new_revision, xml)
1926
1835
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
1927
1836
            self._write_basis_inventory(xml)
1928
1837
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
1932
1841
        """Read the cached basis inventory."""
1933
1842
        path = self._basis_inventory_name()
1934
1843
        return self._transport.get_bytes(path)
1935
 
 
 
1844
        
1936
1845
    @needs_read_lock
1937
1846
    def read_working_inventory(self):
1938
1847
        """Read the working inventory.
1939
 
 
 
1848
        
1940
1849
        :raises errors.InventoryModified: read_working_inventory will fail
1941
1850
            when the current in memory inventory has been modified.
1942
1851
        """
1943
 
        # conceptually this should be an implementation detail of the tree.
 
1852
        # conceptually this should be an implementation detail of the tree. 
1944
1853
        # XXX: Deprecate this.
1945
1854
        # ElementTree does its own conversion from UTF-8, so open in
1946
1855
        # binary.
1947
1856
        if self._inventory_is_modified:
1948
1857
            raise errors.InventoryModified(self)
1949
 
        f = self._transport.get('inventory')
1950
 
        try:
1951
 
            result = self._deserialize(f)
1952
 
        finally:
1953
 
            f.close()
 
1858
        result = self._deserialize(self._transport.get('inventory'))
1954
1859
        self._set_inventory(result, dirty=False)
1955
1860
        return result
1956
1861
 
1971
1876
 
1972
1877
        new_files=set()
1973
1878
        unknown_nested_files=set()
1974
 
        if to_file is None:
1975
 
            to_file = sys.stdout
1976
1879
 
1977
1880
        def recurse_directory_to_add_files(directory):
1978
1881
            # Recurse directory and add all files
1979
1882
            # so we can check if they have changed.
1980
 
            for parent_info, file_infos in self.walkdirs(directory):
 
1883
            for parent_info, file_infos in\
 
1884
                self.walkdirs(directory):
1981
1885
                for relpath, basename, kind, lstat, fileid, kind in file_infos:
1982
1886
                    # Is it versioned or ignored?
1983
1887
                    if self.path2id(relpath) or self.is_ignored(relpath):
2018
1922
                            # ... but not ignored
2019
1923
                            has_changed_files = True
2020
1924
                            break
2021
 
                    elif (content_change and (kind[1] is not None) and
2022
 
                            osutils.is_inside_any(files, path[1])):
2023
 
                        # Versioned and changed, but not deleted, and still
2024
 
                        # in one of the dirs to be deleted.
 
1925
                    elif content_change and (kind[1] is not None):
 
1926
                        # Versioned and changed, but not deleted
2025
1927
                        has_changed_files = True
2026
1928
                        break
2027
1929
 
2035
1937
                        tree_delta.unversioned.extend((unknown_file,))
2036
1938
                raise errors.BzrRemoveChangedFilesError(tree_delta)
2037
1939
 
2038
 
        # Build inv_delta and delete files where applicable,
 
1940
        # Build inv_delta and delete files where applicaple,
2039
1941
        # do this before any modifications to inventory.
2040
1942
        for f in files:
2041
1943
            fid = self.path2id(f)
2049
1951
                        new_status = 'I'
2050
1952
                    else:
2051
1953
                        new_status = '?'
2052
 
                    # XXX: Really should be a more abstract reporter interface
2053
 
                    kind_ch = osutils.kind_marker(self.kind(fid))
2054
 
                    to_file.write(new_status + '       ' + f + kind_ch + '\n')
 
1954
                    textui.show_status(new_status, self.kind(fid), f,
 
1955
                                       to_file=to_file)
2055
1956
                # Unversion file
2056
1957
                inv_delta.append((f, None, fid, None))
2057
1958
                message = "removed %s" % (f,)
2080
1981
 
2081
1982
    @needs_tree_write_lock
2082
1983
    def revert(self, filenames=None, old_tree=None, backups=True,
2083
 
               pb=None, report_changes=False):
 
1984
               pb=DummyProgress(), report_changes=False):
2084
1985
        from bzrlib.conflicts import resolve
2085
1986
        if filenames == []:
2086
1987
            filenames = None
2099
2000
            if filenames is None and len(self.get_parent_ids()) > 1:
2100
2001
                parent_trees = []
2101
2002
                last_revision = self.last_revision()
2102
 
                if last_revision != _mod_revision.NULL_REVISION:
 
2003
                if last_revision != NULL_REVISION:
2103
2004
                    if basis_tree is None:
2104
2005
                        basis_tree = self.basis_tree()
2105
2006
                        basis_tree.lock_read()
2143
2044
    def set_inventory(self, new_inventory_list):
2144
2045
        from bzrlib.inventory import (Inventory,
2145
2046
                                      InventoryDirectory,
 
2047
                                      InventoryEntry,
2146
2048
                                      InventoryFile,
2147
2049
                                      InventoryLink)
2148
2050
        inv = Inventory(self.get_root_id())
2150
2052
            name = os.path.basename(path)
2151
2053
            if name == "":
2152
2054
                continue
2153
 
            # fixme, there should be a factory function inv,add_??
 
2055
            # fixme, there should be a factory function inv,add_?? 
2154
2056
            if kind == 'directory':
2155
2057
                inv.add(InventoryDirectory(file_id, name, parent))
2156
2058
            elif kind == 'file':
2164
2066
    @needs_tree_write_lock
2165
2067
    def set_root_id(self, file_id):
2166
2068
        """Set the root id for this tree."""
2167
 
        # for compatability
 
2069
        # for compatability 
2168
2070
        if file_id is None:
2169
2071
            raise ValueError(
2170
2072
                'WorkingTree.set_root_id with fileid=None')
2174
2076
    def _set_root_id(self, file_id):
2175
2077
        """Set the root id for this tree, in a format specific manner.
2176
2078
 
2177
 
        :param file_id: The file id to assign to the root. It must not be
 
2079
        :param file_id: The file id to assign to the root. It must not be 
2178
2080
            present in the current inventory or an error will occur. It must
2179
2081
            not be None, but rather a valid file id.
2180
2082
        """
2199
2101
 
2200
2102
    def unlock(self):
2201
2103
        """See Branch.unlock.
2202
 
 
 
2104
        
2203
2105
        WorkingTree locking just uses the Branch locking facilities.
2204
2106
        This is current because all working trees have an embedded branch
2205
2107
        within them. IF in the future, we were to make branch data shareable
2206
 
        between multiple working trees, i.e. via shared storage, then we
 
2108
        between multiple working trees, i.e. via shared storage, then we 
2207
2109
        would probably want to lock both the local tree, and the branch.
2208
2110
        """
2209
2111
        raise NotImplementedError(self.unlock)
2210
2112
 
2211
 
    _marker = object()
2212
 
 
2213
 
    def update(self, change_reporter=None, possible_transports=None,
2214
 
               revision=None, old_tip=_marker):
 
2113
    def update(self, change_reporter=None, possible_transports=None):
2215
2114
        """Update a working tree along its branch.
2216
2115
 
2217
2116
        This will update the branch if its bound too, which means we have
2235
2134
        - Merge current state -> basis tree of the master w.r.t. the old tree
2236
2135
          basis.
2237
2136
        - Do a 'normal' merge of the old branch basis if it is relevant.
2238
 
 
2239
 
        :param revision: The target revision to update to. Must be in the
2240
 
            revision history.
2241
 
        :param old_tip: If branch.update() has already been run, the value it
2242
 
            returned (old tip of the branch or None). _marker is used
2243
 
            otherwise.
2244
2137
        """
2245
2138
        if self.branch.get_bound_location() is not None:
2246
2139
            self.lock_write()
2247
 
            update_branch = (old_tip is self._marker)
 
2140
            update_branch = True
2248
2141
        else:
2249
2142
            self.lock_tree_write()
2250
2143
            update_branch = False
2252
2145
            if update_branch:
2253
2146
                old_tip = self.branch.update(possible_transports)
2254
2147
            else:
2255
 
                if old_tip is self._marker:
2256
 
                    old_tip = None
2257
 
            return self._update_tree(old_tip, change_reporter, revision)
 
2148
                old_tip = None
 
2149
            return self._update_tree(old_tip, change_reporter)
2258
2150
        finally:
2259
2151
            self.unlock()
2260
2152
 
2261
2153
    @needs_tree_write_lock
2262
 
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
 
2154
    def _update_tree(self, old_tip=None, change_reporter=None):
2263
2155
        """Update a tree to the master branch.
2264
2156
 
2265
2157
        :param old_tip: if supplied, the previous tip revision the branch,
2271
2163
        # cant set that until we update the working trees last revision to be
2272
2164
        # one from the new branch, because it will just get absorbed by the
2273
2165
        # parent de-duplication logic.
2274
 
        #
 
2166
        # 
2275
2167
        # We MUST save it even if an error occurs, because otherwise the users
2276
2168
        # local work is unreferenced and will appear to have been lost.
2277
 
        #
2278
 
        nb_conflicts = 0
 
2169
        # 
 
2170
        result = 0
2279
2171
        try:
2280
2172
            last_rev = self.get_parent_ids()[0]
2281
2173
        except IndexError:
2282
2174
            last_rev = _mod_revision.NULL_REVISION
2283
 
        if revision is None:
2284
 
            revision = self.branch.last_revision()
2285
 
 
2286
 
        old_tip = old_tip or _mod_revision.NULL_REVISION
2287
 
 
2288
 
        if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2289
 
            # the branch we are bound to was updated
2290
 
            # merge those changes in first
2291
 
            base_tree  = self.basis_tree()
2292
 
            other_tree = self.branch.repository.revision_tree(old_tip)
2293
 
            nb_conflicts = merge.merge_inner(self.branch, other_tree,
2294
 
                                             base_tree, this_tree=self,
2295
 
                                             change_reporter=change_reporter)
2296
 
            if nb_conflicts:
2297
 
                self.add_parent_tree((old_tip, other_tree))
2298
 
                trace.note('Rerun update after fixing the conflicts.')
2299
 
                return nb_conflicts
2300
 
 
2301
 
        if last_rev != _mod_revision.ensure_null(revision):
2302
 
            # the working tree is up to date with the branch
2303
 
            # we can merge the specified revision from master
2304
 
            to_tree = self.branch.repository.revision_tree(revision)
2305
 
            to_root_id = to_tree.get_root_id()
2306
 
 
 
2175
        if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
 
2176
            # merge tree state up to new branch tip.
2307
2177
            basis = self.basis_tree()
2308
2178
            basis.lock_read()
2309
2179
            try:
2310
 
                if (basis.inventory.root is None
2311
 
                    or basis.inventory.root.file_id != to_root_id):
2312
 
                    self.set_root_id(to_root_id)
 
2180
                to_tree = self.branch.basis_tree()
 
2181
                if basis.inventory.root is None:
 
2182
                    self.set_root_id(to_tree.get_root_id())
2313
2183
                    self.flush()
 
2184
                result += merge.merge_inner(
 
2185
                                      self.branch,
 
2186
                                      to_tree,
 
2187
                                      basis,
 
2188
                                      this_tree=self,
 
2189
                                      change_reporter=change_reporter)
2314
2190
            finally:
2315
2191
                basis.unlock()
2316
 
 
2317
 
            # determine the branch point
2318
 
            graph = self.branch.repository.get_graph()
2319
 
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2320
 
                                                last_rev)
2321
 
            base_tree = self.branch.repository.revision_tree(base_rev_id)
2322
 
 
2323
 
            nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2324
 
                                             this_tree=self,
2325
 
                                             change_reporter=change_reporter)
2326
 
            self.set_last_revision(revision)
2327
2192
            # TODO - dedup parents list with things merged by pull ?
2328
2193
            # reuse the tree we've updated to to set the basis:
2329
 
            parent_trees = [(revision, to_tree)]
 
2194
            parent_trees = [(self.branch.last_revision(), to_tree)]
2330
2195
            merges = self.get_parent_ids()[1:]
2331
2196
            # Ideally we ask the tree for the trees here, that way the working
2332
 
            # tree can decide whether to give us the entire tree or give us a
 
2197
            # tree can decide whether to give us teh entire tree or give us a
2333
2198
            # lazy initialised tree. dirstate for instance will have the trees
2334
2199
            # in ram already, whereas a last-revision + basis-inventory tree
2335
2200
            # will not, but also does not need them when setting parents.
2336
2201
            for parent in merges:
2337
2202
                parent_trees.append(
2338
2203
                    (parent, self.branch.repository.revision_tree(parent)))
2339
 
            if not _mod_revision.is_null(old_tip):
 
2204
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2340
2205
                parent_trees.append(
2341
2206
                    (old_tip, self.branch.repository.revision_tree(old_tip)))
2342
2207
            self.set_parent_trees(parent_trees)
2343
2208
            last_rev = parent_trees[0][0]
2344
 
        return nb_conflicts
 
2209
        else:
 
2210
            # the working tree had the same last-revision as the master
 
2211
            # branch did. We may still have pivot local work from the local
 
2212
            # branch into old_tip:
 
2213
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
 
2214
                self.add_parent_tree_id(old_tip)
 
2215
        if (old_tip is not None and not _mod_revision.is_null(old_tip)
 
2216
            and old_tip != last_rev):
 
2217
            # our last revision was not the prior branch last revision
 
2218
            # and we have converted that last revision to a pending merge.
 
2219
            # base is somewhere between the branch tip now
 
2220
            # and the now pending merge
 
2221
 
 
2222
            # Since we just modified the working tree and inventory, flush out
 
2223
            # the current state, before we modify it again.
 
2224
            # TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
 
2225
            #       requires it only because TreeTransform directly munges the
 
2226
            #       inventory and calls tree._write_inventory(). Ultimately we
 
2227
            #       should be able to remove this extra flush.
 
2228
            self.flush()
 
2229
            graph = self.branch.repository.get_graph()
 
2230
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
 
2231
                                                old_tip)
 
2232
            base_tree = self.branch.repository.revision_tree(base_rev_id)
 
2233
            other_tree = self.branch.repository.revision_tree(old_tip)
 
2234
            result += merge.merge_inner(
 
2235
                                  self.branch,
 
2236
                                  other_tree,
 
2237
                                  base_tree,
 
2238
                                  this_tree=self,
 
2239
                                  change_reporter=change_reporter)
 
2240
        return result
2345
2241
 
2346
2242
    def _write_hashcache_if_dirty(self):
2347
2243
        """Write out the hashcache if it is dirty."""
2447
2343
                    bzrdir_loc = bisect_left(cur_disk_dir_content,
2448
2344
                        ('.bzr', '.bzr'))
2449
2345
                    if (bzrdir_loc < len(cur_disk_dir_content)
2450
 
                        and self.bzrdir.is_control_filename(
2451
 
                            cur_disk_dir_content[bzrdir_loc][0])):
 
2346
                        and cur_disk_dir_content[bzrdir_loc][0] == '.bzr'):
2452
2347
                        # we dont yield the contents of, or, .bzr itself.
2453
2348
                        del cur_disk_dir_content[bzrdir_loc]
2454
2349
            if inv_finished:
2588
2483
        return un_resolved, resolved
2589
2484
 
2590
2485
    @needs_read_lock
2591
 
    def _check(self, references):
2592
 
        """Check the tree for consistency.
2593
 
 
2594
 
        :param references: A dict with keys matching the items returned by
2595
 
            self._get_check_refs(), and values from looking those keys up in
2596
 
            the repository.
2597
 
        """
 
2486
    def _check(self):
2598
2487
        tree_basis = self.basis_tree()
2599
2488
        tree_basis.lock_read()
2600
2489
        try:
2601
 
            repo_basis = references[('trees', self.last_revision())]
 
2490
            repo_basis = self.branch.repository.revision_tree(
 
2491
                self.last_revision())
2602
2492
            if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2603
2493
                raise errors.BzrCheckError(
2604
2494
                    "Mismatched basis inventory content.")
2617
2507
        """
2618
2508
        return
2619
2509
 
 
2510
    @needs_read_lock
2620
2511
    def _get_rules_searcher(self, default_searcher):
2621
2512
        """See Tree._get_rules_searcher."""
2622
2513
        if self._rules_searcher is None:
2633
2524
class WorkingTree2(WorkingTree):
2634
2525
    """This is the Format 2 working tree.
2635
2526
 
2636
 
    This was the first weave based working tree.
 
2527
    This was the first weave based working tree. 
2637
2528
     - uses os locks for locking.
2638
2529
     - uses the branch last-revision.
2639
2530
    """
2649
2540
        if self._inventory is None:
2650
2541
            self.read_working_inventory()
2651
2542
 
2652
 
    def _get_check_refs(self):
2653
 
        """Return the references needed to perform a check of this tree."""
2654
 
        return [('trees', self.last_revision())]
2655
 
 
2656
2543
    def lock_tree_write(self):
2657
2544
        """See WorkingTree.lock_tree_write().
2658
2545
 
2659
2546
        In Format2 WorkingTrees we have a single lock for the branch and tree
2660
2547
        so lock_tree_write() degrades to lock_write().
2661
 
 
2662
 
        :return: An object with an unlock method which will release the lock
2663
 
            obtained.
2664
2548
        """
2665
2549
        self.branch.lock_write()
2666
2550
        try:
2667
 
            self._control_files.lock_write()
2668
 
            return self
 
2551
            return self._control_files.lock_write()
2669
2552
        except:
2670
2553
            self.branch.unlock()
2671
2554
            raise
2680
2563
            if self._inventory_is_modified:
2681
2564
                self.flush()
2682
2565
            self._write_hashcache_if_dirty()
2683
 
 
 
2566
                    
2684
2567
        # reverse order of locking.
2685
2568
        try:
2686
2569
            return self._control_files.unlock()
2708
2591
 
2709
2592
    def _change_last_revision(self, revision_id):
2710
2593
        """See WorkingTree._change_last_revision."""
2711
 
        if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
 
2594
        if revision_id is None or revision_id == NULL_REVISION:
2712
2595
            try:
2713
2596
                self._transport.delete('last-revision')
2714
2597
            except errors.NoSuchFile:
2716
2599
            return False
2717
2600
        else:
2718
2601
            self._transport.put_bytes('last-revision', revision_id,
2719
 
                mode=self.bzrdir._get_file_mode())
 
2602
                mode=self._control_files._file_mode)
2720
2603
            return True
2721
2604
 
2722
 
    def _get_check_refs(self):
2723
 
        """Return the references needed to perform a check of this tree."""
2724
 
        return [('trees', self.last_revision())]
2725
 
 
2726
2605
    @needs_tree_write_lock
2727
2606
    def set_conflicts(self, conflicts):
2728
 
        self._put_rio('conflicts', conflicts.to_stanzas(),
 
2607
        self._put_rio('conflicts', conflicts.to_stanzas(), 
2729
2608
                      CONFLICT_HEADER_1)
2730
2609
 
2731
2610
    @needs_tree_write_lock
2780
2659
     * a format string,
2781
2660
     * an open routine.
2782
2661
 
2783
 
    Formats are placed in an dict by their format string for reference
 
2662
    Formats are placed in an dict by their format string for reference 
2784
2663
    during workingtree opening. Its not required that these be instances, they
2785
 
    can be classes themselves with class methods - it simply depends on
 
2664
    can be classes themselves with class methods - it simply depends on 
2786
2665
    whether state is needed for a given format or not.
2787
2666
 
2788
2667
    Once a format is deprecated, just deprecate the initialize and open
2789
 
    methods on the format class. Do not deprecate the object, as the
 
2668
    methods on the format class. Do not deprecate the object, as the 
2790
2669
    object will be created every time regardless.
2791
2670
    """
2792
2671
 
2805
2684
        """Return the format for the working tree object in a_bzrdir."""
2806
2685
        try:
2807
2686
            transport = a_bzrdir.get_workingtree_transport(None)
2808
 
            format_string = transport.get_bytes("format")
 
2687
            format_string = transport.get("format").read()
2809
2688
            return klass._formats[format_string]
2810
2689
        except errors.NoSuchFile:
2811
2690
            raise errors.NoWorkingTree(base=transport.base)
2836
2715
        """Is this format supported?
2837
2716
 
2838
2717
        Supported formats can be initialized and opened.
2839
 
        Unsupported formats may not support initialization or committing or
 
2718
        Unsupported formats may not support initialization or committing or 
2840
2719
        some other features depending on the reason for not being supported.
2841
2720
        """
2842
2721
        return True
2863
2742
 
2864
2743
 
2865
2744
class WorkingTreeFormat2(WorkingTreeFormat):
2866
 
    """The second working tree format.
 
2745
    """The second working tree format. 
2867
2746
 
2868
2747
    This format modified the hash cache from the format 1 hash cache.
2869
2748
    """
2882
2761
        no working tree.  (See bug #43064).
2883
2762
        """
2884
2763
        sio = StringIO()
2885
 
        inv = inventory.Inventory()
 
2764
        inv = Inventory()
2886
2765
        xml5.serializer_v5.write_inventory(inv, sio, working=True)
2887
2766
        sio.seek(0)
2888
2767
        transport.put_file('inventory', sio, file_mode)
2904
2783
            branch.generate_revision_history(revision_id)
2905
2784
        finally:
2906
2785
            branch.unlock()
2907
 
        inv = inventory.Inventory()
 
2786
        inv = Inventory()
2908
2787
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2909
2788
                         branch,
2910
2789
                         inv,
2955
2834
        - is new in bzr 0.8
2956
2835
        - uses a LockDir to guard access for writes.
2957
2836
    """
2958
 
 
 
2837
    
2959
2838
    upgrade_recommended = True
2960
2839
 
2961
2840
    def get_format_string(self):
2978
2857
 
2979
2858
    def _open_control_files(self, a_bzrdir):
2980
2859
        transport = a_bzrdir.get_workingtree_transport(None)
2981
 
        return LockableFiles(transport, self._lock_file_name,
 
2860
        return LockableFiles(transport, self._lock_file_name, 
2982
2861
                             self._lock_class)
2983
2862
 
2984
2863
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2985
2864
                   accelerator_tree=None, hardlink=False):
2986
2865
        """See WorkingTreeFormat.initialize().
2987
 
 
 
2866
        
2988
2867
        :param revision_id: if supplied, create a working tree at a different
2989
2868
            revision than the branch is at.
2990
2869
        :param accelerator_tree: A tree which can be used for retrieving file
3001
2880
        control_files.create_lock()
3002
2881
        control_files.lock_write()
3003
2882
        transport.put_bytes('format', self.get_format_string(),
3004
 
            mode=a_bzrdir._get_file_mode())
 
2883
            mode=control_files._file_mode)
3005
2884
        if from_branch is not None:
3006
2885
            branch = from_branch
3007
2886
        else:
3027
2906
            # only set an explicit root id if there is one to set.
3028
2907
            if basis_tree.inventory.root is not None:
3029
2908
                wt.set_root_id(basis_tree.get_root_id())
3030
 
            if revision_id == _mod_revision.NULL_REVISION:
 
2909
            if revision_id == NULL_REVISION:
3031
2910
                wt.set_parent_trees([])
3032
2911
            else:
3033
2912
                wt.set_parent_trees([(revision_id, basis_tree)])
3040
2919
        return wt
3041
2920
 
3042
2921
    def _initial_inventory(self):
3043
 
        return inventory.Inventory()
 
2922
        return Inventory()
3044
2923
 
3045
2924
    def __init__(self):
3046
2925
        super(WorkingTreeFormat3, self).__init__()
3061
2940
 
3062
2941
    def _open(self, a_bzrdir, control_files):
3063
2942
        """Open the tree itself.
3064
 
 
 
2943
        
3065
2944
        :param a_bzrdir: the dir for the tree.
3066
2945
        :param control_files: the control files for the tree.
3067
2946
        """
3075
2954
        return self.get_format_string()
3076
2955
 
3077
2956
 
3078
 
__default_format = WorkingTreeFormat6()
 
2957
__default_format = WorkingTreeFormat4()
3079
2958
WorkingTreeFormat.register_format(__default_format)
3080
2959
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3081
 
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3082
2960
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3083
2961
WorkingTreeFormat.set_default_format(__default_format)
3084
2962
# formats which have no format string are not discoverable