/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

added ianc tweaks to tbzr strategy doc

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.lock import LogicalLockResult
81
 
from bzrlib.lockable_files import LockableFiles
 
87
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
 
88
from bzrlib.lockable_files import LockableFiles, TransportLock
82
89
from bzrlib.lockdir import LockDir
83
90
import bzrlib.mutabletree
84
91
from bzrlib.mutabletree import needs_tree_write_lock
85
92
from bzrlib import osutils
86
93
from bzrlib.osutils import (
 
94
    compact_date,
87
95
    file_kind,
88
96
    isdir,
89
97
    normpath,
90
98
    pathjoin,
 
99
    rand_chars,
91
100
    realpath,
92
101
    safe_unicode,
93
102
    splitpath,
94
103
    supports_executable,
95
104
    )
96
 
from bzrlib.filters import filtered_input_file
97
105
from bzrlib.trace import mutter, note
98
106
from bzrlib.transport.local import LocalTransport
99
 
from bzrlib.revision import CURRENT_REVISION
 
107
from bzrlib.progress import DummyProgress, ProgressPhase
 
108
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
100
109
from bzrlib.rio import RioReader, rio_file, Stanza
101
 
from bzrlib.symbol_versioning import (
102
 
    deprecated_passed,
103
 
    DEPRECATED_PARAMETER,
104
 
    )
 
110
from bzrlib.symbol_versioning import (deprecated_passed,
 
111
        deprecated_method,
 
112
        deprecated_function,
 
113
        DEPRECATED_PARAMETER,
 
114
        )
105
115
 
106
116
 
107
117
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
108
 
# TODO: Modifying the conflict objects or their type is currently nearly
109
 
# impossible as there is no clear relationship between the working tree format
110
 
# and the conflict list file format.
111
118
CONFLICT_HEADER_1 = "BZR conflict list format 1"
112
119
 
113
120
ERROR_PATH_NOT_FOUND = 3    # WindowsError errno code, equivalent to ENOENT
116
123
class TreeEntry(object):
117
124
    """An entry that implements the minimum interface used by commands.
118
125
 
119
 
    This needs further inspection, it may be better to have
 
126
    This needs further inspection, it may be better to have 
120
127
    InventoryEntries without ids - though that seems wrong. For now,
121
128
    this is a parallel hierarchy to InventoryEntry, and needs to become
122
129
    one of several things: decorates to that hierarchy, children of, or
125
132
    no InventoryEntry available - i.e. for unversioned objects.
126
133
    Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
127
134
    """
128
 
 
 
135
 
129
136
    def __eq__(self, other):
130
137
        # yes, this us ugly, TODO: best practice __eq__ style.
131
138
        return (isinstance(other, TreeEntry)
132
139
                and other.__class__ == self.__class__)
133
 
 
 
140
 
134
141
    def kind_character(self):
135
142
        return "???"
136
143
 
168
175
        return ''
169
176
 
170
177
 
171
 
class WorkingTree(bzrlib.mutabletree.MutableTree,
172
 
    bzrdir.ControlComponent):
 
178
class WorkingTree(bzrlib.mutabletree.MutableTree):
173
179
    """Working copy tree.
174
180
 
175
181
    The inventory is held in the `Branch` working-inventory, and the
179
185
    not listed in the Inventory and vice versa.
180
186
    """
181
187
 
182
 
    # override this to set the strategy for storing views
183
 
    def _make_views(self):
184
 
        return views.DisabledViews(self)
185
 
 
186
188
    def __init__(self, basedir='.',
187
189
                 branch=DEPRECATED_PARAMETER,
188
190
                 _inventory=None,
213
215
        else:
214
216
            # assume all other formats have their own control files.
215
217
            self._control_files = _control_files
216
 
        self._transport = self._control_files._transport
217
218
        # update the whole cache up front and write to disk if anything changed;
218
219
        # in the future we might want to do this more selectively
219
220
        # two possible ways offer themselves : in self._unlock, write the cache
223
224
        wt_trans = self.bzrdir.get_workingtree_transport(None)
224
225
        cache_filename = wt_trans.local_abspath('stat-cache')
225
226
        self._hashcache = hashcache.HashCache(basedir, cache_filename,
226
 
            self.bzrdir._get_file_mode(),
227
 
            self._content_filter_stack_provider())
 
227
                                              self._control_files._file_mode)
228
228
        hc = self._hashcache
229
229
        hc.read()
230
230
        # is this scan needed ? it makes things kinda slow.
245
245
            # permitted to do this.
246
246
            self._set_inventory(_inventory, dirty=False)
247
247
        self._detect_case_handling()
248
 
        self._rules_searcher = None
249
 
        self.views = self._make_views()
250
 
 
251
 
    @property
252
 
    def user_transport(self):
253
 
        return self.bzrdir.user_transport
254
 
 
255
 
    @property
256
 
    def control_transport(self):
257
 
        return self._transport
258
248
 
259
249
    def _detect_case_handling(self):
260
250
        wt_trans = self.bzrdir.get_workingtree_transport(None)
286
276
        self._control_files.break_lock()
287
277
        self.branch.break_lock()
288
278
 
289
 
    def _get_check_refs(self):
290
 
        """Return the references needed to perform a check of this tree.
291
 
        
292
 
        The default implementation returns no refs, and is only suitable for
293
 
        trees that have no local caching and can commit on ghosts at any time.
294
 
 
295
 
        :seealso: bzrlib.check for details about check_refs.
296
 
        """
297
 
        return []
298
 
 
299
279
    def requires_rich_root(self):
300
280
        return self._format.requires_rich_root
301
281
 
302
282
    def supports_tree_reference(self):
303
283
        return False
304
284
 
305
 
    def supports_content_filtering(self):
306
 
        return self._format.supports_content_filtering()
307
 
 
308
 
    def supports_views(self):
309
 
        return self.views.supports_views()
310
 
 
311
285
    def _set_inventory(self, inv, dirty):
312
286
        """Set the internal cached inventory.
313
287
 
327
301
 
328
302
        """
329
303
        if path is None:
330
 
            path = osutils.getcwd()
 
304
            path = os.path.getcwdu()
331
305
        control = bzrdir.BzrDir.open(path, _unsupported)
332
306
        return control.open_workingtree(_unsupported)
333
 
 
 
307
        
334
308
    @staticmethod
335
309
    def open_containing(path=None):
336
310
        """Open an existing working tree which has its root about path.
337
 
 
 
311
        
338
312
        This probes for a working tree at path and searches upwards from there.
339
313
 
340
314
        Basically we keep looking up until we find the control directory or
401
375
 
402
376
    def basis_tree(self):
403
377
        """Return RevisionTree for the current last revision.
404
 
 
 
378
        
405
379
        If the left most parent is a ghost then the returned tree will be an
406
 
        empty tree - one obtained by calling
407
 
        repository.revision_tree(NULL_REVISION).
 
380
        empty tree - one obtained by calling repository.revision_tree(None).
408
381
        """
409
382
        try:
410
383
            revision_id = self.get_parent_ids()[0]
412
385
            # no parents, return an empty revision tree.
413
386
            # in the future this should return the tree for
414
387
            # 'empty:' - the implicit root empty tree.
415
 
            return self.branch.repository.revision_tree(
416
 
                       _mod_revision.NULL_REVISION)
 
388
            return self.branch.repository.revision_tree(None)
417
389
        try:
418
390
            return self.revision_tree(revision_id)
419
391
        except errors.NoSuchRevision:
423
395
        # at this point ?
424
396
        try:
425
397
            return self.branch.repository.revision_tree(revision_id)
426
 
        except (errors.RevisionNotPresent, errors.NoSuchRevision):
 
398
        except errors.RevisionNotPresent:
427
399
            # the basis tree *may* be a ghost or a low level error may have
428
 
            # occurred. If the revision is present, its a problem, if its not
 
400
            # occured. If the revision is present, its a problem, if its not
429
401
            # its a ghost.
430
402
            if self.branch.repository.has_revision(revision_id):
431
403
                raise
432
404
            # the basis tree is a ghost so return an empty tree.
433
 
            return self.branch.repository.revision_tree(
434
 
                       _mod_revision.NULL_REVISION)
 
405
            return self.branch.repository.revision_tree(None)
435
406
 
436
407
    def _cleanup(self):
437
408
        self._flush_ignore_list_cache()
438
409
 
439
410
    def relpath(self, path):
440
411
        """Return the local path portion from a given path.
441
 
 
442
 
        The path may be absolute or relative. If its a relative path it is
 
412
        
 
413
        The path may be absolute or relative. If its a relative path it is 
443
414
        interpreted relative to the python current working directory.
444
415
        """
445
416
        return osutils.relpath(self.basedir, path)
447
418
    def has_filename(self, filename):
448
419
        return osutils.lexists(self.abspath(filename))
449
420
 
450
 
    def get_file(self, file_id, path=None, filtered=True):
451
 
        return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
452
 
 
453
 
    def get_file_with_stat(self, file_id, path=None, filtered=True,
454
 
        _fstat=os.fstat):
455
 
        """See Tree.get_file_with_stat."""
 
421
    def get_file(self, file_id, path=None):
456
422
        if path is None:
457
423
            path = self.id2path(file_id)
458
 
        file_obj = self.get_file_byname(path, filtered=False)
459
 
        stat_value = _fstat(file_obj.fileno())
460
 
        if filtered and self.supports_content_filtering():
461
 
            filters = self._content_filter_stack(path)
462
 
            file_obj = filtered_input_file(file_obj, filters)
463
 
        return (file_obj, stat_value)
464
 
 
465
 
    def get_file_text(self, file_id, path=None, filtered=True):
466
 
        my_file = self.get_file(file_id, path=path, filtered=filtered)
467
 
        try:
468
 
            return my_file.read()
469
 
        finally:
470
 
            my_file.close()
471
 
 
472
 
    def get_file_byname(self, filename, filtered=True):
473
 
        path = self.abspath(filename)
474
 
        f = file(path, 'rb')
475
 
        if filtered and self.supports_content_filtering():
476
 
            filters = self._content_filter_stack(filename)
477
 
            return filtered_input_file(f, filters)
478
 
        else:
479
 
            return f
480
 
 
481
 
    def get_file_lines(self, file_id, path=None, filtered=True):
482
 
        """See Tree.get_file_lines()"""
483
 
        file = self.get_file(file_id, path, filtered=filtered)
484
 
        try:
485
 
            return file.readlines()
486
 
        finally:
487
 
            file.close()
 
424
        return self.get_file_byname(path)
 
425
 
 
426
    def get_file_text(self, file_id):
 
427
        return self.get_file(file_id).read()
 
428
 
 
429
    def get_file_byname(self, filename):
 
430
        return file(self.abspath(filename), 'rb')
488
431
 
489
432
    @needs_read_lock
490
433
    def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
497
440
        incorrectly attributed to CURRENT_REVISION (but after committing, the
498
441
        attribution will be correct).
499
442
        """
500
 
        maybe_file_parent_keys = []
501
 
        for parent_id in self.get_parent_ids():
502
 
            try:
503
 
                parent_tree = self.revision_tree(parent_id)
504
 
            except errors.NoSuchRevisionInTree:
505
 
                parent_tree = self.branch.repository.revision_tree(parent_id)
506
 
            parent_tree.lock_read()
507
 
            try:
508
 
                if file_id not in parent_tree:
509
 
                    continue
510
 
                ie = parent_tree.inventory[file_id]
511
 
                if ie.kind != 'file':
512
 
                    # Note: this is slightly unnecessary, because symlinks and
513
 
                    # directories have a "text" which is the empty text, and we
514
 
                    # know that won't mess up annotations. But it seems cleaner
515
 
                    continue
516
 
                parent_text_key = (file_id, ie.revision)
517
 
                if parent_text_key not in maybe_file_parent_keys:
518
 
                    maybe_file_parent_keys.append(parent_text_key)
519
 
            finally:
520
 
                parent_tree.unlock()
521
 
        graph = _mod_graph.Graph(self.branch.repository.texts)
522
 
        heads = graph.heads(maybe_file_parent_keys)
523
 
        file_parent_keys = []
524
 
        for key in maybe_file_parent_keys:
525
 
            if key in heads:
526
 
                file_parent_keys.append(key)
527
 
 
528
 
        # Now we have the parents of this content
529
 
        annotator = self.branch.repository.texts.get_annotator()
530
 
        text = self.get_file_text(file_id)
531
 
        this_key =(file_id, default_revision)
532
 
        annotator.add_special_text(this_key, file_parent_keys, text)
533
 
        annotations = [(key[-1], line)
534
 
                       for key, line in annotator.annotate_flat(this_key)]
535
 
        return annotations
 
443
        basis = self.basis_tree()
 
444
        basis.lock_read()
 
445
        try:
 
446
            changes = self.iter_changes(basis, True, [self.id2path(file_id)],
 
447
                require_versioned=True).next()
 
448
            changed_content, kind = changes[2], changes[6]
 
449
            if not changed_content:
 
450
                return basis.annotate_iter(file_id)
 
451
            if kind[1] is None:
 
452
                return None
 
453
            import annotate
 
454
            if kind[0] != 'file':
 
455
                old_lines = []
 
456
            else:
 
457
                old_lines = list(basis.annotate_iter(file_id))
 
458
            old = [old_lines]
 
459
            for tree in self.branch.repository.revision_trees(
 
460
                self.get_parent_ids()[1:]):
 
461
                if file_id not in tree:
 
462
                    continue
 
463
                old.append(list(tree.annotate_iter(file_id)))
 
464
            return annotate.reannotate(old, self.get_file(file_id).readlines(),
 
465
                                       default_revision)
 
466
        finally:
 
467
            basis.unlock()
536
468
 
537
469
    def _get_ancestors(self, default_revision):
538
470
        ancestors = set([default_revision])
543
475
 
544
476
    def get_parent_ids(self):
545
477
        """See Tree.get_parent_ids.
546
 
 
 
478
        
547
479
        This implementation reads the pending merges list and last_revision
548
480
        value and uses that to decide what the parents list should be.
549
481
        """
553
485
        else:
554
486
            parents = [last_rev]
555
487
        try:
556
 
            merges_bytes = self._transport.get_bytes('pending-merges')
 
488
            merges_file = self._control_files.get('pending-merges')
557
489
        except errors.NoSuchFile:
558
490
            pass
559
491
        else:
560
 
            for l in osutils.split_lines(merges_bytes):
 
492
            for l in merges_file.readlines():
561
493
                revision_id = l.rstrip('\n')
562
494
                parents.append(revision_id)
563
495
        return parents
566
498
    def get_root_id(self):
567
499
        """Return the id of this trees root"""
568
500
        return self._inventory.root.file_id
569
 
 
 
501
        
570
502
    def _get_store_filename(self, file_id):
571
503
        ## XXX: badly named; this is not in the store at all
572
504
        return self.abspath(self.id2path(file_id))
574
506
    @needs_read_lock
575
507
    def clone(self, to_bzrdir, revision_id=None):
576
508
        """Duplicate this working tree into to_bzr, including all state.
577
 
 
 
509
        
578
510
        Specifically modified files are kept as modified, but
579
511
        ignored and unknown files are discarded.
580
512
 
581
513
        If you want to make a new line of development, see bzrdir.sprout()
582
514
 
583
515
        revision
584
 
            If not None, the cloned tree will have its last revision set to
585
 
            revision, and difference between the source trees last revision
 
516
            If not None, the cloned tree will have its last revision set to 
 
517
            revision, and and difference between the source trees last revision
586
518
            and this one merged in.
587
519
        """
588
520
        # assumes the target bzr dir format is compatible.
589
 
        result = to_bzrdir.create_workingtree()
 
521
        result = self._format.initialize(to_bzrdir)
590
522
        self.copy_content_into(result, revision_id)
591
523
        return result
592
524
 
622
554
 
623
555
    def get_file_size(self, file_id):
624
556
        """See Tree.get_file_size"""
625
 
        # XXX: this returns the on-disk size; it should probably return the
626
 
        # canonical size
627
557
        try:
628
558
            return os.path.getsize(self.id2abspath(file_id))
629
559
        except OSError, e:
645
575
 
646
576
    def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
647
577
        file_id = self.path2id(path)
648
 
        if file_id is None:
649
 
            # For unversioned files on win32, we just assume they are not
650
 
            # executable
651
 
            return False
652
578
        return self._inventory[file_id].executable
653
579
 
654
580
    def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
676
602
        """See MutableTree._add."""
677
603
        # TODO: Re-adding a file that is removed in the working copy
678
604
        # should probably put it back with the previous ID.
679
 
        # the read and write working inventory should not occur in this
 
605
        # the read and write working inventory should not occur in this 
680
606
        # function - they should be part of lock_write and unlock.
681
607
        inv = self.inventory
682
608
        for f, file_id, kind in zip(files, ids, kinds):
764
690
            raise
765
691
        kind = _mapper(stat_result.st_mode)
766
692
        if kind == 'file':
767
 
            return self._file_content_summary(path, stat_result)
 
693
            size = stat_result.st_size
 
694
            # try for a stat cache lookup
 
695
            executable = self._is_executable_from_path_and_stat(path, stat_result)
 
696
            return (kind, size, executable, self._sha_from_stat(
 
697
                path, stat_result))
768
698
        elif kind == 'directory':
769
699
            # perhaps it looks like a plain directory, but it's really a
770
700
            # reference.
772
702
                kind = 'tree-reference'
773
703
            return kind, None, None, None
774
704
        elif kind == 'symlink':
775
 
            target = osutils.readlink(abspath)
776
 
            return ('symlink', None, None, target)
 
705
            return ('symlink', None, None, os.readlink(abspath))
777
706
        else:
778
707
            return (kind, None, None, None)
779
708
 
780
 
    def _file_content_summary(self, path, stat_result):
781
 
        size = stat_result.st_size
782
 
        executable = self._is_executable_from_path_and_stat(path, stat_result)
783
 
        # try for a stat cache lookup
784
 
        return ('file', size, executable, self._sha_from_stat(
785
 
            path, stat_result))
786
 
 
787
709
    def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
788
710
        """Common ghost checking functionality from set_parent_*.
789
711
 
798
720
 
799
721
    def _set_merges_from_parent_ids(self, parent_ids):
800
722
        merges = parent_ids[1:]
801
 
        self._transport.put_bytes('pending-merges', '\n'.join(merges),
802
 
            mode=self.bzrdir._get_file_mode())
803
 
 
804
 
    def _filter_parent_ids_by_ancestry(self, revision_ids):
805
 
        """Check that all merged revisions are proper 'heads'.
806
 
 
807
 
        This will always return the first revision_id, and any merged revisions
808
 
        which are
809
 
        """
810
 
        if len(revision_ids) == 0:
811
 
            return revision_ids
812
 
        graph = self.branch.repository.get_graph()
813
 
        heads = graph.heads(revision_ids)
814
 
        new_revision_ids = revision_ids[:1]
815
 
        for revision_id in revision_ids[1:]:
816
 
            if revision_id in heads and revision_id not in new_revision_ids:
817
 
                new_revision_ids.append(revision_id)
818
 
        if new_revision_ids != revision_ids:
819
 
            trace.mutter('requested to set revision_ids = %s,'
820
 
                         ' but filtered to %s', revision_ids, new_revision_ids)
821
 
        return new_revision_ids
 
723
        self._control_files.put_bytes('pending-merges', '\n'.join(merges))
822
724
 
823
725
    @needs_tree_write_lock
824
726
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
825
727
        """Set the parent ids to revision_ids.
826
 
 
 
728
        
827
729
        See also set_parent_trees. This api will try to retrieve the tree data
828
730
        for each element of revision_ids from the trees repository. If you have
829
731
        tree data already available, it is more efficient to use
838
740
        for revision_id in revision_ids:
839
741
            _mod_revision.check_not_reserved_id(revision_id)
840
742
 
841
 
        revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
842
 
 
843
743
        if len(revision_ids) > 0:
844
744
            self.set_last_revision(revision_ids[0])
845
745
        else:
857
757
        self._check_parents_for_ghosts(parent_ids,
858
758
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
859
759
 
860
 
        parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
861
 
 
862
760
        if len(parent_ids) == 0:
863
761
            leftmost_parent_id = _mod_revision.NULL_REVISION
864
762
            leftmost_parent_tree = None
904
802
    def _put_rio(self, filename, stanzas, header):
905
803
        self._must_be_locked()
906
804
        my_file = rio_file(stanzas, header)
907
 
        self._transport.put_file(filename, my_file,
908
 
            mode=self.bzrdir._get_file_mode())
 
805
        self._control_files.put(filename, my_file)
909
806
 
910
807
    @needs_write_lock # because merge pulls data into the branch.
911
808
    def merge_from_branch(self, branch, to_revision=None, from_revision=None,
912
 
                          merge_type=None, force=False):
 
809
        merge_type=None):
913
810
        """Merge from a branch into this working tree.
914
811
 
915
812
        :param branch: The branch to merge from.
919
816
            branch.last_revision().
920
817
        """
921
818
        from bzrlib.merge import Merger, Merge3Merger
922
 
        merger = Merger(self.branch, this_tree=self)
923
 
        # check that there are no local alterations
924
 
        if not force and self.has_changes():
925
 
            raise errors.UncommittedChanges(self)
926
 
        if to_revision is None:
927
 
            to_revision = _mod_revision.ensure_null(branch.last_revision())
928
 
        merger.other_rev_id = to_revision
929
 
        if _mod_revision.is_null(merger.other_rev_id):
930
 
            raise errors.NoCommits(branch)
931
 
        self.branch.fetch(branch, last_revision=merger.other_rev_id)
932
 
        merger.other_basis = merger.other_rev_id
933
 
        merger.other_tree = self.branch.repository.revision_tree(
934
 
            merger.other_rev_id)
935
 
        merger.other_branch = branch
936
 
        if from_revision is None:
937
 
            merger.find_base()
938
 
        else:
939
 
            merger.set_base_revision(from_revision, branch)
940
 
        if merger.base_rev_id == merger.other_rev_id:
941
 
            raise errors.PointlessMerge
942
 
        merger.backup_files = False
943
 
        if merge_type is None:
944
 
            merger.merge_type = Merge3Merger
945
 
        else:
946
 
            merger.merge_type = merge_type
947
 
        merger.set_interesting_files(None)
948
 
        merger.show_base = False
949
 
        merger.reprocess = False
950
 
        conflicts = merger.do_merge()
951
 
        merger.set_pending()
 
819
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
820
        try:
 
821
            merger = Merger(self.branch, this_tree=self, pb=pb)
 
822
            merger.pp = ProgressPhase("Merge phase", 5, pb)
 
823
            merger.pp.next_phase()
 
824
            # check that there are no
 
825
            # local alterations
 
826
            merger.check_basis(check_clean=True, require_commits=False)
 
827
            if to_revision is None:
 
828
                to_revision = _mod_revision.ensure_null(branch.last_revision())
 
829
            merger.other_rev_id = to_revision
 
830
            if _mod_revision.is_null(merger.other_rev_id):
 
831
                raise errors.NoCommits(branch)
 
832
            self.branch.fetch(branch, last_revision=merger.other_rev_id)
 
833
            merger.other_basis = merger.other_rev_id
 
834
            merger.other_tree = self.branch.repository.revision_tree(
 
835
                merger.other_rev_id)
 
836
            merger.other_branch = branch
 
837
            merger.pp.next_phase()
 
838
            if from_revision is None:
 
839
                merger.find_base()
 
840
            else:
 
841
                merger.set_base_revision(from_revision, branch)
 
842
            if merger.base_rev_id == merger.other_rev_id:
 
843
                raise errors.PointlessMerge
 
844
            merger.backup_files = False
 
845
            if merge_type is None:
 
846
                merger.merge_type = Merge3Merger
 
847
            else:
 
848
                merger.merge_type = merge_type
 
849
            merger.set_interesting_files(None)
 
850
            merger.show_base = False
 
851
            merger.reprocess = False
 
852
            conflicts = merger.do_merge()
 
853
            merger.set_pending()
 
854
        finally:
 
855
            pb.finished()
952
856
        return conflicts
953
857
 
954
858
    @needs_read_lock
955
859
    def merge_modified(self):
956
860
        """Return a dictionary of files modified by a merge.
957
861
 
958
 
        The list is initialized by WorkingTree.set_merge_modified, which is
 
862
        The list is initialized by WorkingTree.set_merge_modified, which is 
959
863
        typically called after we make some automatic updates to the tree
960
864
        because of a merge.
961
865
 
963
867
        still in the working inventory and have that text hash.
964
868
        """
965
869
        try:
966
 
            hashfile = self._transport.get('merge-hashes')
 
870
            hashfile = self._control_files.get('merge-hashes')
967
871
        except errors.NoSuchFile:
968
872
            return {}
 
873
        merge_hashes = {}
969
874
        try:
970
 
            merge_hashes = {}
971
 
            try:
972
 
                if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
973
 
                    raise errors.MergeModifiedFormatError()
974
 
            except StopIteration:
 
875
            if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
975
876
                raise errors.MergeModifiedFormatError()
976
 
            for s in RioReader(hashfile):
977
 
                # RioReader reads in Unicode, so convert file_ids back to utf8
978
 
                file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
979
 
                if file_id not in self.inventory:
980
 
                    continue
981
 
                text_hash = s.get("hash")
982
 
                if text_hash == self.get_file_sha1(file_id):
983
 
                    merge_hashes[file_id] = text_hash
984
 
            return merge_hashes
985
 
        finally:
986
 
            hashfile.close()
 
877
        except StopIteration:
 
878
            raise errors.MergeModifiedFormatError()
 
879
        for s in RioReader(hashfile):
 
880
            # RioReader reads in Unicode, so convert file_ids back to utf8
 
881
            file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
 
882
            if file_id not in self.inventory:
 
883
                continue
 
884
            text_hash = s.get("hash")
 
885
            if text_hash == self.get_file_sha1(file_id):
 
886
                merge_hashes[file_id] = text_hash
 
887
        return merge_hashes
987
888
 
988
889
    @needs_write_lock
989
890
    def mkdir(self, path, file_id=None):
995
896
        return file_id
996
897
 
997
898
    def get_symlink_target(self, file_id):
998
 
        abspath = self.id2abspath(file_id)
999
 
        target = osutils.readlink(abspath)
1000
 
        return target
 
899
        return os.readlink(self.id2abspath(file_id))
1001
900
 
1002
901
    @needs_write_lock
1003
902
    def subsume(self, other_tree):
1053
952
        return False
1054
953
 
1055
954
    def _directory_may_be_tree_reference(self, relpath):
1056
 
        # as a special case, if a directory contains control files then
 
955
        # as a special case, if a directory contains control files then 
1057
956
        # it's a tree reference, except that the root of the tree is not
1058
957
        return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1059
958
        # TODO: We could ask all the control formats whether they
1070
969
    @needs_tree_write_lock
1071
970
    def extract(self, file_id, format=None):
1072
971
        """Extract a subtree from this tree.
1073
 
 
 
972
        
1074
973
        A new branch will be created, relative to the path for this tree.
1075
974
        """
1076
975
        self.flush()
1081
980
                transport = transport.clone(name)
1082
981
                transport.ensure_base()
1083
982
            return transport
1084
 
 
 
983
            
1085
984
        sub_path = self.id2path(file_id)
1086
985
        branch_transport = mkdirs(sub_path)
1087
986
        if format is None:
1101
1000
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
1102
1001
        if tree_transport.base != branch_transport.base:
1103
1002
            tree_bzrdir = format.initialize_on_transport(tree_transport)
1104
 
            branch.BranchReferenceFormat().initialize(tree_bzrdir,
1105
 
                target_branch=new_branch)
 
1003
            branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1106
1004
        else:
1107
1005
            tree_bzrdir = branch_bzrdir
1108
 
        wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
 
1006
        wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1109
1007
        wt.set_parent_ids(self.get_parent_ids())
1110
1008
        my_inv = self.inventory
1111
 
        child_inv = inventory.Inventory(root_id=None)
 
1009
        child_inv = Inventory(root_id=None)
1112
1010
        new_root = my_inv[file_id]
1113
1011
        my_inv.remove_recursive_id(file_id)
1114
1012
        new_root.parent_id = None
1132
1030
        sio = StringIO()
1133
1031
        self._serialize(self._inventory, sio)
1134
1032
        sio.seek(0)
1135
 
        self._transport.put_file('inventory', sio,
1136
 
            mode=self.bzrdir._get_file_mode())
 
1033
        self._control_files.put('inventory', sio)
1137
1034
        self._inventory_is_modified = False
1138
1035
 
1139
1036
    def _kind(self, relpath):
1140
1037
        return osutils.file_kind(self.abspath(relpath))
1141
1038
 
1142
 
    def list_files(self, include_root=False, from_dir=None, recursive=True):
1143
 
        """List all files as (path, class, kind, id, entry).
 
1039
    def list_files(self, include_root=False):
 
1040
        """Recursively list all files as (path, class, kind, id, entry).
1144
1041
 
1145
1042
        Lists, but does not descend into unversioned directories.
 
1043
 
1146
1044
        This does not include files that have been deleted in this
1147
 
        tree. Skips the control directory.
 
1045
        tree.
1148
1046
 
1149
 
        :param include_root: if True, return an entry for the root
1150
 
        :param from_dir: start from this directory or None for the root
1151
 
        :param recursive: whether to recurse into subdirectories or not
 
1047
        Skips the control directory.
1152
1048
        """
1153
1049
        # list_files is an iterator, so @needs_read_lock doesn't work properly
1154
1050
        # with it. So callers should be careful to always read_lock the tree.
1156
1052
            raise errors.ObjectNotLocked(self)
1157
1053
 
1158
1054
        inv = self.inventory
1159
 
        if from_dir is None and include_root is True:
 
1055
        if include_root is True:
1160
1056
            yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1161
1057
        # Convert these into local objects to save lookup times
1162
1058
        pathjoin = osutils.pathjoin
1169
1065
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1170
1066
 
1171
1067
        # directory file_id, relative path, absolute path, reverse sorted children
1172
 
        if from_dir is not None:
1173
 
            from_dir_id = inv.path2id(from_dir)
1174
 
            if from_dir_id is None:
1175
 
                # Directory not versioned
1176
 
                return
1177
 
            from_dir_abspath = pathjoin(self.basedir, from_dir)
1178
 
        else:
1179
 
            from_dir_id = inv.root.file_id
1180
 
            from_dir_abspath = self.basedir
1181
 
        children = os.listdir(from_dir_abspath)
 
1068
        children = os.listdir(self.basedir)
1182
1069
        children.sort()
1183
 
        # jam 20060527 The kernel sized tree seems equivalent whether we
 
1070
        # jam 20060527 The kernel sized tree seems equivalent whether we 
1184
1071
        # use a deque and popleft to keep them sorted, or if we use a plain
1185
1072
        # list and just reverse() them.
1186
1073
        children = collections.deque(children)
1187
 
        stack = [(from_dir_id, u'', from_dir_abspath, children)]
 
1074
        stack = [(inv.root.file_id, u'', self.basedir, children)]
1188
1075
        while stack:
1189
1076
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1190
1077
 
1206
1093
 
1207
1094
                # absolute path
1208
1095
                fap = from_dir_abspath + '/' + f
1209
 
 
 
1096
                
1210
1097
                f_ie = inv.get_child(from_dir_id, f)
1211
1098
                if f_ie:
1212
1099
                    c = 'V'
1244
1131
                    except KeyError:
1245
1132
                        yield fp[1:], c, fk, None, TreeEntry()
1246
1133
                    continue
1247
 
 
 
1134
                
1248
1135
                if fk != 'directory':
1249
1136
                    continue
1250
1137
 
1251
 
                # But do this child first if recursing down
1252
 
                if recursive:
1253
 
                    new_children = os.listdir(fap)
1254
 
                    new_children.sort()
1255
 
                    new_children = collections.deque(new_children)
1256
 
                    stack.append((f_ie.file_id, fp, fap, new_children))
1257
 
                    # Break out of inner loop,
1258
 
                    # so that we start outer loop with child
1259
 
                    break
 
1138
                # But do this child first
 
1139
                new_children = os.listdir(fap)
 
1140
                new_children.sort()
 
1141
                new_children = collections.deque(new_children)
 
1142
                stack.append((f_ie.file_id, fp, fap, new_children))
 
1143
                # Break out of inner loop,
 
1144
                # so that we start outer loop with child
 
1145
                break
1260
1146
            else:
1261
1147
                # if we finished all children, pop it off the stack
1262
1148
                stack.pop()
1268
1154
        to_dir must exist in the inventory.
1269
1155
 
1270
1156
        If to_dir exists and is a directory, the files are moved into
1271
 
        it, keeping their old names.
 
1157
        it, keeping their old names.  
1272
1158
 
1273
1159
        Note that to_dir is only the last component of the new name;
1274
1160
        this doesn't change the directory.
1402
1288
                only_change_inv = True
1403
1289
            elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1404
1290
                only_change_inv = False
1405
 
            elif (not self.case_sensitive
1406
 
                  and from_rel.lower() == to_rel.lower()
1407
 
                  and self.has_filename(from_rel)):
 
1291
            elif (sys.platform == 'win32'
 
1292
                and from_rel.lower() == to_rel.lower()
 
1293
                and self.has_filename(from_rel)):
1408
1294
                only_change_inv = False
1409
1295
            else:
1410
1296
                # something is wrong, so lets determine what exactly
1440
1326
        inv = self.inventory
1441
1327
        for entry in moved:
1442
1328
            try:
1443
 
                self._move_entry(WorkingTree._RenameEntry(
1444
 
                    entry.to_rel, entry.from_id,
 
1329
                self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1445
1330
                    entry.to_tail, entry.to_parent_id, entry.from_rel,
1446
1331
                    entry.from_tail, entry.from_parent_id,
1447
1332
                    entry.only_change_inv))
1498
1383
        from_tail = splitpath(from_rel)[-1]
1499
1384
        from_id = inv.path2id(from_rel)
1500
1385
        if from_id is None:
1501
 
            # if file is missing in the inventory maybe it's in the basis_tree
1502
 
            basis_tree = self.branch.basis_tree()
1503
 
            from_id = basis_tree.path2id(from_rel)
1504
 
            if from_id is None:
1505
 
                raise errors.BzrRenameFailedError(from_rel,to_rel,
1506
 
                    errors.NotVersionedError(path=str(from_rel)))
1507
 
            # put entry back in the inventory so we can rename it
1508
 
            from_entry = basis_tree.inventory[from_id].copy()
1509
 
            inv.add(from_entry)
1510
 
        else:
1511
 
            from_entry = inv[from_id]
 
1386
            raise errors.BzrRenameFailedError(from_rel,to_rel,
 
1387
                errors.NotVersionedError(path=str(from_rel)))
 
1388
        from_entry = inv[from_id]
1512
1389
        from_parent_id = from_entry.parent_id
1513
1390
        to_dir, to_tail = os.path.split(to_rel)
1514
1391
        to_dir_id = inv.path2id(to_dir)
1560
1437
        These are files in the working directory that are not versioned or
1561
1438
        control files or ignored.
1562
1439
        """
1563
 
        # force the extras method to be fully executed before returning, to
 
1440
        # force the extras method to be fully executed before returning, to 
1564
1441
        # prevent race conditions with the lock
1565
1442
        return iter(
1566
1443
            [subp for subp in self.extras() if not self.is_ignored(subp)])
1576
1453
        :raises: NoSuchId if any fileid is not currently versioned.
1577
1454
        """
1578
1455
        for file_id in file_ids:
1579
 
            if file_id not in self._inventory:
1580
 
                raise errors.NoSuchId(self, file_id)
1581
 
        for file_id in file_ids:
1582
1456
            if self._inventory.has_id(file_id):
1583
1457
                self._inventory.remove_recursive_id(file_id)
 
1458
            else:
 
1459
                raise errors.NoSuchId(self, file_id)
1584
1460
        if len(file_ids):
1585
 
            # in the future this should just set a dirty bit to wait for the
 
1461
            # in the future this should just set a dirty bit to wait for the 
1586
1462
            # final unlock. However, until all methods of workingtree start
1587
 
            # with the current in -memory inventory rather than triggering
 
1463
            # with the current in -memory inventory rather than triggering 
1588
1464
            # a read, it is more complex - we need to teach read_inventory
1589
1465
            # to know when to read, and when to not read first... and possibly
1590
1466
            # to save first when the in memory one may be corrupted.
1591
1467
            # so for now, we just only write it if it is indeed dirty.
1592
1468
            # - RBC 20060907
1593
1469
            self._write_inventory(self._inventory)
1594
 
 
 
1470
    
1595
1471
    def _iter_conflicts(self):
1596
1472
        conflicted = set()
1597
1473
        for info in self.list_files():
1605
1481
 
1606
1482
    @needs_write_lock
1607
1483
    def pull(self, source, overwrite=False, stop_revision=None,
1608
 
             change_reporter=None, possible_transports=None, local=False):
 
1484
             change_reporter=None, possible_transports=None):
 
1485
        top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1609
1486
        source.lock_read()
1610
1487
        try:
 
1488
            pp = ProgressPhase("Pull phase", 2, top_pb)
 
1489
            pp.next_phase()
1611
1490
            old_revision_info = self.branch.last_revision_info()
1612
1491
            basis_tree = self.basis_tree()
1613
1492
            count = self.branch.pull(source, overwrite, stop_revision,
1614
 
                                     possible_transports=possible_transports,
1615
 
                                     local=local)
 
1493
                                     possible_transports=possible_transports)
1616
1494
            new_revision_info = self.branch.last_revision_info()
1617
1495
            if new_revision_info != old_revision_info:
 
1496
                pp.next_phase()
1618
1497
                repository = self.branch.repository
 
1498
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
1619
1499
                basis_tree.lock_read()
1620
1500
                try:
1621
1501
                    new_basis_tree = self.branch.basis_tree()
1624
1504
                                new_basis_tree,
1625
1505
                                basis_tree,
1626
1506
                                this_tree=self,
1627
 
                                pb=None,
 
1507
                                pb=pb,
1628
1508
                                change_reporter=change_reporter)
1629
 
                    basis_root_id = basis_tree.get_root_id()
1630
 
                    new_root_id = new_basis_tree.get_root_id()
1631
 
                    if basis_root_id != new_root_id:
1632
 
                        self.set_root_id(new_root_id)
 
1509
                    if (basis_tree.inventory.root is None and
 
1510
                        new_basis_tree.inventory.root is not None):
 
1511
                        self.set_root_id(new_basis_tree.get_root_id())
1633
1512
                finally:
 
1513
                    pb.finished()
1634
1514
                    basis_tree.unlock()
1635
1515
                # TODO - dedup parents list with things merged by pull ?
1636
1516
                # reuse the revisiontree we merged against to set the new
1637
1517
                # tree data.
1638
1518
                parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1639
 
                # we have to pull the merge trees out again, because
1640
 
                # merge_inner has set the ids. - this corner is not yet
 
1519
                # we have to pull the merge trees out again, because 
 
1520
                # merge_inner has set the ids. - this corner is not yet 
1641
1521
                # layered well enough to prevent double handling.
1642
1522
                # XXX TODO: Fix the double handling: telling the tree about
1643
1523
                # the already known parent data is wasteful.
1649
1529
            return count
1650
1530
        finally:
1651
1531
            source.unlock()
 
1532
            top_pb.finished()
1652
1533
 
1653
1534
    @needs_write_lock
1654
1535
    def put_file_bytes_non_atomic(self, file_id, bytes):
1680
1561
 
1681
1562
            fl = []
1682
1563
            for subf in os.listdir(dirabs):
1683
 
                if self.bzrdir.is_control_filename(subf):
 
1564
                if subf == '.bzr':
1684
1565
                    continue
1685
1566
                if subf not in dir_entry.children:
1686
 
                    try:
1687
 
                        (subf_norm,
1688
 
                         can_access) = osutils.normalized_filename(subf)
1689
 
                    except UnicodeDecodeError:
1690
 
                        path_os_enc = path.encode(osutils._fs_enc)
1691
 
                        relpath = path_os_enc + '/' + subf
1692
 
                        raise errors.BadFilenameEncoding(relpath,
1693
 
                                                         osutils._fs_enc)
 
1567
                    subf_norm, can_access = osutils.normalized_filename(subf)
1694
1568
                    if subf_norm != subf and can_access:
1695
1569
                        if subf_norm not in dir_entry.children:
1696
1570
                            fl.append(subf_norm)
1697
1571
                    else:
1698
1572
                        fl.append(subf)
1699
 
 
 
1573
            
1700
1574
            fl.sort()
1701
1575
            for subf in fl:
1702
1576
                subp = pathjoin(path, subf)
1739
1613
        r"""Check whether the filename matches an ignore pattern.
1740
1614
 
1741
1615
        Patterns containing '/' or '\' need to match the whole path;
1742
 
        others match against only the last component.  Patterns starting
1743
 
        with '!' are ignore exceptions.  Exceptions take precedence
1744
 
        over regular patterns and cause the filename to not be ignored.
 
1616
        others match against only the last component.
1745
1617
 
1746
1618
        If the file is ignored, returns the pattern which caused it to
1747
1619
        be ignored, otherwise None.  So this can simply be used as a
1748
1620
        boolean if desired."""
1749
1621
        if getattr(self, '_ignoreglobster', None) is None:
1750
 
            self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
 
1622
            self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1751
1623
        return self._ignoreglobster.match(filename)
1752
1624
 
1753
1625
    def kind(self, file_id):
1803
1675
            raise errors.ObjectNotLocked(self)
1804
1676
 
1805
1677
    def lock_read(self):
1806
 
        """Lock the tree for reading.
1807
 
 
1808
 
        This also locks the branch, and can be unlocked via self.unlock().
1809
 
 
1810
 
        :return: A bzrlib.lock.LogicalLockResult.
1811
 
        """
 
1678
        """See Branch.lock_read, and WorkingTree.unlock."""
1812
1679
        if not self.is_locked():
1813
1680
            self._reset_data()
1814
1681
        self.branch.lock_read()
1815
1682
        try:
1816
 
            self._control_files.lock_read()
1817
 
            return LogicalLockResult(self.unlock)
 
1683
            return self._control_files.lock_read()
1818
1684
        except:
1819
1685
            self.branch.unlock()
1820
1686
            raise
1821
1687
 
1822
1688
    def lock_tree_write(self):
1823
 
        """See MutableTree.lock_tree_write, and WorkingTree.unlock.
1824
 
 
1825
 
        :return: A bzrlib.lock.LogicalLockResult.
1826
 
        """
 
1689
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1827
1690
        if not self.is_locked():
1828
1691
            self._reset_data()
1829
1692
        self.branch.lock_read()
1830
1693
        try:
1831
 
            self._control_files.lock_write()
1832
 
            return LogicalLockResult(self.unlock)
 
1694
            return self._control_files.lock_write()
1833
1695
        except:
1834
1696
            self.branch.unlock()
1835
1697
            raise
1836
1698
 
1837
1699
    def lock_write(self):
1838
 
        """See MutableTree.lock_write, and WorkingTree.unlock.
1839
 
 
1840
 
        :return: A bzrlib.lock.LogicalLockResult.
1841
 
        """
 
1700
        """See MutableTree.lock_write, and WorkingTree.unlock."""
1842
1701
        if not self.is_locked():
1843
1702
            self._reset_data()
1844
1703
        self.branch.lock_write()
1845
1704
        try:
1846
 
            self._control_files.lock_write()
1847
 
            return LogicalLockResult(self.unlock)
 
1705
            return self._control_files.lock_write()
1848
1706
        except:
1849
1707
            self.branch.unlock()
1850
1708
            raise
1858
1716
    def _reset_data(self):
1859
1717
        """Reset transient data that cannot be revalidated."""
1860
1718
        self._inventory_is_modified = False
1861
 
        f = self._transport.get('inventory')
1862
 
        try:
1863
 
            result = self._deserialize(f)
1864
 
        finally:
1865
 
            f.close()
 
1719
        result = self._deserialize(self._control_files.get('inventory'))
1866
1720
        self._set_inventory(result, dirty=False)
1867
1721
 
1868
1722
    @needs_tree_write_lock
1873
1727
 
1874
1728
    def _change_last_revision(self, new_revision):
1875
1729
        """Template method part of set_last_revision to perform the change.
1876
 
 
 
1730
        
1877
1731
        This is used to allow WorkingTree3 instances to not affect branch
1878
1732
        when their last revision is set.
1879
1733
        """
1891
1745
        """Write the basis inventory XML to the basis-inventory file"""
1892
1746
        path = self._basis_inventory_name()
1893
1747
        sio = StringIO(xml)
1894
 
        self._transport.put_file(path, sio,
1895
 
            mode=self.bzrdir._get_file_mode())
 
1748
        self._control_files.put(path, sio)
1896
1749
 
1897
1750
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
1898
1751
        """Create the text that will be saved in basis-inventory"""
1905
1758
        # as commit already has that ready-to-use [while the format is the
1906
1759
        # same, that is].
1907
1760
        try:
1908
 
            # this double handles the inventory - unpack and repack -
 
1761
            # this double handles the inventory - unpack and repack - 
1909
1762
            # but is easier to understand. We can/should put a conditional
1910
1763
            # in here based on whether the inventory is in the latest format
1911
1764
            # - perhaps we should repack all inventories on a repository
1912
1765
            # upgrade ?
1913
1766
            # the fast path is to copy the raw xml from the repository. If the
1914
 
            # xml contains 'revision_id="', then we assume the right
 
1767
            # xml contains 'revision_id="', then we assume the right 
1915
1768
            # revision_id is set. We must check for this full string, because a
1916
1769
            # root node id can legitimately look like 'revision_id' but cannot
1917
1770
            # contain a '"'.
1918
 
            xml = self.branch.repository._get_inventory_xml(new_revision)
 
1771
            xml = self.branch.repository.get_inventory_xml(new_revision)
1919
1772
            firstline = xml.split('\n', 1)[0]
1920
 
            if (not 'revision_id="' in firstline or
 
1773
            if (not 'revision_id="' in firstline or 
1921
1774
                'format="7"' not in firstline):
1922
 
                inv = self.branch.repository._serializer.read_inventory_from_string(
1923
 
                    xml, new_revision)
 
1775
                inv = self.branch.repository.deserialise_inventory(
 
1776
                    new_revision, xml)
1924
1777
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
1925
1778
            self._write_basis_inventory(xml)
1926
1779
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
1929
1782
    def read_basis_inventory(self):
1930
1783
        """Read the cached basis inventory."""
1931
1784
        path = self._basis_inventory_name()
1932
 
        return self._transport.get_bytes(path)
1933
 
 
 
1785
        return self._control_files.get(path).read()
 
1786
        
1934
1787
    @needs_read_lock
1935
1788
    def read_working_inventory(self):
1936
1789
        """Read the working inventory.
1937
 
 
 
1790
        
1938
1791
        :raises errors.InventoryModified: read_working_inventory will fail
1939
1792
            when the current in memory inventory has been modified.
1940
1793
        """
1941
 
        # conceptually this should be an implementation detail of the tree.
 
1794
        # conceptually this should be an implementation detail of the tree. 
1942
1795
        # XXX: Deprecate this.
1943
1796
        # ElementTree does its own conversion from UTF-8, so open in
1944
1797
        # binary.
1945
1798
        if self._inventory_is_modified:
1946
1799
            raise errors.InventoryModified(self)
1947
 
        f = self._transport.get('inventory')
1948
 
        try:
1949
 
            result = self._deserialize(f)
1950
 
        finally:
1951
 
            f.close()
 
1800
        result = self._deserialize(self._control_files.get('inventory'))
1952
1801
        self._set_inventory(result, dirty=False)
1953
1802
        return result
1954
1803
 
1969
1818
 
1970
1819
        new_files=set()
1971
1820
        unknown_nested_files=set()
1972
 
        if to_file is None:
1973
 
            to_file = sys.stdout
1974
1821
 
1975
1822
        def recurse_directory_to_add_files(directory):
1976
1823
            # Recurse directory and add all files
1977
1824
            # so we can check if they have changed.
1978
 
            for parent_info, file_infos in self.walkdirs(directory):
1979
 
                for relpath, basename, kind, lstat, fileid, kind in file_infos:
 
1825
            for parent_info, file_infos in\
 
1826
                osutils.walkdirs(self.abspath(directory),
 
1827
                    directory):
 
1828
                for relpath, basename, kind, lstat, abspath in file_infos:
1980
1829
                    # Is it versioned or ignored?
1981
1830
                    if self.path2id(relpath) or self.is_ignored(relpath):
1982
1831
                        # Add nested content for deletion.
1992
1841
            filename = self.relpath(abspath)
1993
1842
            if len(filename) > 0:
1994
1843
                new_files.add(filename)
1995
 
                recurse_directory_to_add_files(filename)
 
1844
                if osutils.isdir(abspath):
 
1845
                    recurse_directory_to_add_files(filename)
1996
1846
 
1997
1847
        files = list(new_files)
1998
1848
 
2016
1866
                            # ... but not ignored
2017
1867
                            has_changed_files = True
2018
1868
                            break
2019
 
                    elif (content_change and (kind[1] is not None) and
2020
 
                            osutils.is_inside_any(files, path[1])):
2021
 
                        # Versioned and changed, but not deleted, and still
2022
 
                        # in one of the dirs to be deleted.
 
1869
                    elif content_change and (kind[1] is not None):
 
1870
                        # Versioned and changed, but not deleted
2023
1871
                        has_changed_files = True
2024
1872
                        break
2025
1873
 
2033
1881
                        tree_delta.unversioned.extend((unknown_file,))
2034
1882
                raise errors.BzrRemoveChangedFilesError(tree_delta)
2035
1883
 
2036
 
        # Build inv_delta and delete files where applicable,
 
1884
        # Build inv_delta and delete files where applicaple,
2037
1885
        # do this before any modifications to inventory.
2038
1886
        for f in files:
2039
1887
            fid = self.path2id(f)
2047
1895
                        new_status = 'I'
2048
1896
                    else:
2049
1897
                        new_status = '?'
2050
 
                    # XXX: Really should be a more abstract reporter interface
2051
 
                    kind_ch = osutils.kind_marker(self.kind(fid))
2052
 
                    to_file.write(new_status + '       ' + f + kind_ch + '\n')
 
1898
                    textui.show_status(new_status, self.kind(fid), f,
 
1899
                                       to_file=to_file)
2053
1900
                # Unversion file
2054
1901
                inv_delta.append((f, None, fid, None))
2055
1902
                message = "removed %s" % (f,)
2078
1925
 
2079
1926
    @needs_tree_write_lock
2080
1927
    def revert(self, filenames=None, old_tree=None, backups=True,
2081
 
               pb=None, report_changes=False):
 
1928
               pb=DummyProgress(), report_changes=False):
2082
1929
        from bzrlib.conflicts import resolve
2083
1930
        if filenames == []:
2084
1931
            filenames = None
2097
1944
            if filenames is None and len(self.get_parent_ids()) > 1:
2098
1945
                parent_trees = []
2099
1946
                last_revision = self.last_revision()
2100
 
                if last_revision != _mod_revision.NULL_REVISION:
 
1947
                if last_revision != NULL_REVISION:
2101
1948
                    if basis_tree is None:
2102
1949
                        basis_tree = self.basis_tree()
2103
1950
                        basis_tree.lock_read()
2141
1988
    def set_inventory(self, new_inventory_list):
2142
1989
        from bzrlib.inventory import (Inventory,
2143
1990
                                      InventoryDirectory,
 
1991
                                      InventoryEntry,
2144
1992
                                      InventoryFile,
2145
1993
                                      InventoryLink)
2146
1994
        inv = Inventory(self.get_root_id())
2148
1996
            name = os.path.basename(path)
2149
1997
            if name == "":
2150
1998
                continue
2151
 
            # fixme, there should be a factory function inv,add_??
 
1999
            # fixme, there should be a factory function inv,add_?? 
2152
2000
            if kind == 'directory':
2153
2001
                inv.add(InventoryDirectory(file_id, name, parent))
2154
2002
            elif kind == 'file':
2162
2010
    @needs_tree_write_lock
2163
2011
    def set_root_id(self, file_id):
2164
2012
        """Set the root id for this tree."""
2165
 
        # for compatability
 
2013
        # for compatability 
2166
2014
        if file_id is None:
2167
2015
            raise ValueError(
2168
2016
                'WorkingTree.set_root_id with fileid=None')
2172
2020
    def _set_root_id(self, file_id):
2173
2021
        """Set the root id for this tree, in a format specific manner.
2174
2022
 
2175
 
        :param file_id: The file id to assign to the root. It must not be
 
2023
        :param file_id: The file id to assign to the root. It must not be 
2176
2024
            present in the current inventory or an error will occur. It must
2177
2025
            not be None, but rather a valid file id.
2178
2026
        """
2197
2045
 
2198
2046
    def unlock(self):
2199
2047
        """See Branch.unlock.
2200
 
 
 
2048
        
2201
2049
        WorkingTree locking just uses the Branch locking facilities.
2202
2050
        This is current because all working trees have an embedded branch
2203
2051
        within them. IF in the future, we were to make branch data shareable
2204
 
        between multiple working trees, i.e. via shared storage, then we
 
2052
        between multiple working trees, i.e. via shared storage, then we 
2205
2053
        would probably want to lock both the local tree, and the branch.
2206
2054
        """
2207
2055
        raise NotImplementedError(self.unlock)
2208
2056
 
2209
 
    _marker = object()
2210
 
 
2211
 
    def update(self, change_reporter=None, possible_transports=None,
2212
 
               revision=None, old_tip=_marker):
 
2057
    def update(self, change_reporter=None, possible_transports=None):
2213
2058
        """Update a working tree along its branch.
2214
2059
 
2215
2060
        This will update the branch if its bound too, which means we have
2233
2078
        - Merge current state -> basis tree of the master w.r.t. the old tree
2234
2079
          basis.
2235
2080
        - Do a 'normal' merge of the old branch basis if it is relevant.
2236
 
 
2237
 
        :param revision: The target revision to update to. Must be in the
2238
 
            revision history.
2239
 
        :param old_tip: If branch.update() has already been run, the value it
2240
 
            returned (old tip of the branch or None). _marker is used
2241
 
            otherwise.
2242
2081
        """
2243
2082
        if self.branch.get_bound_location() is not None:
2244
2083
            self.lock_write()
2245
 
            update_branch = (old_tip is self._marker)
 
2084
            update_branch = True
2246
2085
        else:
2247
2086
            self.lock_tree_write()
2248
2087
            update_branch = False
2250
2089
            if update_branch:
2251
2090
                old_tip = self.branch.update(possible_transports)
2252
2091
            else:
2253
 
                if old_tip is self._marker:
2254
 
                    old_tip = None
2255
 
            return self._update_tree(old_tip, change_reporter, revision)
 
2092
                old_tip = None
 
2093
            return self._update_tree(old_tip, change_reporter)
2256
2094
        finally:
2257
2095
            self.unlock()
2258
2096
 
2259
2097
    @needs_tree_write_lock
2260
 
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
 
2098
    def _update_tree(self, old_tip=None, change_reporter=None):
2261
2099
        """Update a tree to the master branch.
2262
2100
 
2263
2101
        :param old_tip: if supplied, the previous tip revision the branch,
2269
2107
        # cant set that until we update the working trees last revision to be
2270
2108
        # one from the new branch, because it will just get absorbed by the
2271
2109
        # parent de-duplication logic.
2272
 
        #
 
2110
        # 
2273
2111
        # We MUST save it even if an error occurs, because otherwise the users
2274
2112
        # local work is unreferenced and will appear to have been lost.
2275
 
        #
2276
 
        nb_conflicts = 0
 
2113
        # 
 
2114
        result = 0
2277
2115
        try:
2278
2116
            last_rev = self.get_parent_ids()[0]
2279
2117
        except IndexError:
2280
2118
            last_rev = _mod_revision.NULL_REVISION
2281
 
        if revision is None:
2282
 
            revision = self.branch.last_revision()
2283
 
 
2284
 
        old_tip = old_tip or _mod_revision.NULL_REVISION
2285
 
 
2286
 
        if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2287
 
            # the branch we are bound to was updated
2288
 
            # merge those changes in first
2289
 
            base_tree  = self.basis_tree()
2290
 
            other_tree = self.branch.repository.revision_tree(old_tip)
2291
 
            nb_conflicts = merge.merge_inner(self.branch, other_tree,
2292
 
                                             base_tree, this_tree=self,
2293
 
                                             change_reporter=change_reporter)
2294
 
            if nb_conflicts:
2295
 
                self.add_parent_tree((old_tip, other_tree))
2296
 
                trace.note('Rerun update after fixing the conflicts.')
2297
 
                return nb_conflicts
2298
 
 
2299
 
        if last_rev != _mod_revision.ensure_null(revision):
2300
 
            # the working tree is up to date with the branch
2301
 
            # we can merge the specified revision from master
2302
 
            to_tree = self.branch.repository.revision_tree(revision)
2303
 
            to_root_id = to_tree.get_root_id()
2304
 
 
 
2119
        if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
 
2120
            # merge tree state up to new branch tip.
2305
2121
            basis = self.basis_tree()
2306
2122
            basis.lock_read()
2307
2123
            try:
2308
 
                if (basis.inventory.root is None
2309
 
                    or basis.inventory.root.file_id != to_root_id):
2310
 
                    self.set_root_id(to_root_id)
 
2124
                to_tree = self.branch.basis_tree()
 
2125
                if basis.inventory.root is None:
 
2126
                    self.set_root_id(to_tree.get_root_id())
2311
2127
                    self.flush()
 
2128
                result += merge.merge_inner(
 
2129
                                      self.branch,
 
2130
                                      to_tree,
 
2131
                                      basis,
 
2132
                                      this_tree=self,
 
2133
                                      change_reporter=change_reporter)
2312
2134
            finally:
2313
2135
                basis.unlock()
2314
 
 
2315
 
            # determine the branch point
2316
 
            graph = self.branch.repository.get_graph()
2317
 
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2318
 
                                                last_rev)
2319
 
            base_tree = self.branch.repository.revision_tree(base_rev_id)
2320
 
 
2321
 
            nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2322
 
                                             this_tree=self,
2323
 
                                             change_reporter=change_reporter)
2324
 
            self.set_last_revision(revision)
2325
2136
            # TODO - dedup parents list with things merged by pull ?
2326
2137
            # reuse the tree we've updated to to set the basis:
2327
 
            parent_trees = [(revision, to_tree)]
 
2138
            parent_trees = [(self.branch.last_revision(), to_tree)]
2328
2139
            merges = self.get_parent_ids()[1:]
2329
2140
            # Ideally we ask the tree for the trees here, that way the working
2330
 
            # tree can decide whether to give us the entire tree or give us a
 
2141
            # tree can decide whether to give us teh entire tree or give us a
2331
2142
            # lazy initialised tree. dirstate for instance will have the trees
2332
2143
            # in ram already, whereas a last-revision + basis-inventory tree
2333
2144
            # will not, but also does not need them when setting parents.
2334
2145
            for parent in merges:
2335
2146
                parent_trees.append(
2336
2147
                    (parent, self.branch.repository.revision_tree(parent)))
2337
 
            if not _mod_revision.is_null(old_tip):
 
2148
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2338
2149
                parent_trees.append(
2339
2150
                    (old_tip, self.branch.repository.revision_tree(old_tip)))
2340
2151
            self.set_parent_trees(parent_trees)
2341
2152
            last_rev = parent_trees[0][0]
2342
 
        return nb_conflicts
 
2153
        else:
 
2154
            # the working tree had the same last-revision as the master
 
2155
            # branch did. We may still have pivot local work from the local
 
2156
            # branch into old_tip:
 
2157
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
 
2158
                self.add_parent_tree_id(old_tip)
 
2159
        if (old_tip is not None and not _mod_revision.is_null(old_tip)
 
2160
            and old_tip != last_rev):
 
2161
            # our last revision was not the prior branch last revision
 
2162
            # and we have converted that last revision to a pending merge.
 
2163
            # base is somewhere between the branch tip now
 
2164
            # and the now pending merge
 
2165
 
 
2166
            # Since we just modified the working tree and inventory, flush out
 
2167
            # the current state, before we modify it again.
 
2168
            # TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
 
2169
            #       requires it only because TreeTransform directly munges the
 
2170
            #       inventory and calls tree._write_inventory(). Ultimately we
 
2171
            #       should be able to remove this extra flush.
 
2172
            self.flush()
 
2173
            graph = self.branch.repository.get_graph()
 
2174
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
 
2175
                                                old_tip)
 
2176
            base_tree = self.branch.repository.revision_tree(base_rev_id)
 
2177
            other_tree = self.branch.repository.revision_tree(old_tip)
 
2178
            result += merge.merge_inner(
 
2179
                                  self.branch,
 
2180
                                  other_tree,
 
2181
                                  base_tree,
 
2182
                                  this_tree=self,
 
2183
                                  change_reporter=change_reporter)
 
2184
        return result
2343
2185
 
2344
2186
    def _write_hashcache_if_dirty(self):
2345
2187
        """Write out the hashcache if it is dirty."""
2444
2286
                    # value.
2445
2287
                    bzrdir_loc = bisect_left(cur_disk_dir_content,
2446
2288
                        ('.bzr', '.bzr'))
2447
 
                    if (bzrdir_loc < len(cur_disk_dir_content)
2448
 
                        and self.bzrdir.is_control_filename(
2449
 
                            cur_disk_dir_content[bzrdir_loc][0])):
 
2289
                    if cur_disk_dir_content[bzrdir_loc][0] == '.bzr':
2450
2290
                        # we dont yield the contents of, or, .bzr itself.
2451
2291
                        del cur_disk_dir_content[bzrdir_loc]
2452
2292
            if inv_finished:
2542
2382
                relroot = ""
2543
2383
            # FIXME: stash the node in pending
2544
2384
            entry = inv[top_id]
2545
 
            if entry.kind == 'directory':
2546
 
                for name, child in entry.sorted_children():
2547
 
                    dirblock.append((relroot + name, name, child.kind, None,
2548
 
                        child.file_id, child.kind
2549
 
                        ))
 
2385
            for name, child in entry.sorted_children():
 
2386
                dirblock.append((relroot + name, name, child.kind, None,
 
2387
                    child.file_id, child.kind
 
2388
                    ))
2550
2389
            yield (currentdir[0], entry.file_id), dirblock
2551
2390
            # push the user specified dirs from dirblock
2552
2391
            for dir in reversed(dirblock):
2585
2424
        self.set_conflicts(un_resolved)
2586
2425
        return un_resolved, resolved
2587
2426
 
2588
 
    @needs_read_lock
2589
 
    def _check(self, references):
2590
 
        """Check the tree for consistency.
2591
 
 
2592
 
        :param references: A dict with keys matching the items returned by
2593
 
            self._get_check_refs(), and values from looking those keys up in
2594
 
            the repository.
2595
 
        """
2596
 
        tree_basis = self.basis_tree()
2597
 
        tree_basis.lock_read()
2598
 
        try:
2599
 
            repo_basis = references[('trees', self.last_revision())]
2600
 
            if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2601
 
                raise errors.BzrCheckError(
2602
 
                    "Mismatched basis inventory content.")
2603
 
            self._validate()
2604
 
        finally:
2605
 
            tree_basis.unlock()
2606
 
 
2607
2427
    def _validate(self):
2608
2428
        """Validate internal structures.
2609
2429
 
2615
2435
        """
2616
2436
        return
2617
2437
 
2618
 
    def _get_rules_searcher(self, default_searcher):
2619
 
        """See Tree._get_rules_searcher."""
2620
 
        if self._rules_searcher is None:
2621
 
            self._rules_searcher = super(WorkingTree,
2622
 
                self)._get_rules_searcher(default_searcher)
2623
 
        return self._rules_searcher
2624
 
 
2625
 
    def get_shelf_manager(self):
2626
 
        """Return the ShelfManager for this WorkingTree."""
2627
 
        from bzrlib.shelf import ShelfManager
2628
 
        return ShelfManager(self, self._transport)
2629
 
 
2630
2438
 
2631
2439
class WorkingTree2(WorkingTree):
2632
2440
    """This is the Format 2 working tree.
2633
2441
 
2634
 
    This was the first weave based working tree.
 
2442
    This was the first weave based working tree. 
2635
2443
     - uses os locks for locking.
2636
2444
     - uses the branch last-revision.
2637
2445
    """
2647
2455
        if self._inventory is None:
2648
2456
            self.read_working_inventory()
2649
2457
 
2650
 
    def _get_check_refs(self):
2651
 
        """Return the references needed to perform a check of this tree."""
2652
 
        return [('trees', self.last_revision())]
2653
 
 
2654
2458
    def lock_tree_write(self):
2655
2459
        """See WorkingTree.lock_tree_write().
2656
2460
 
2657
2461
        In Format2 WorkingTrees we have a single lock for the branch and tree
2658
2462
        so lock_tree_write() degrades to lock_write().
2659
 
 
2660
 
        :return: An object with an unlock method which will release the lock
2661
 
            obtained.
2662
2463
        """
2663
2464
        self.branch.lock_write()
2664
2465
        try:
2665
 
            self._control_files.lock_write()
2666
 
            return self
 
2466
            return self._control_files.lock_write()
2667
2467
        except:
2668
2468
            self.branch.unlock()
2669
2469
            raise
2678
2478
            if self._inventory_is_modified:
2679
2479
                self.flush()
2680
2480
            self._write_hashcache_if_dirty()
2681
 
 
 
2481
                    
2682
2482
        # reverse order of locking.
2683
2483
        try:
2684
2484
            return self._control_files.unlock()
2700
2500
    def _last_revision(self):
2701
2501
        """See Mutable.last_revision."""
2702
2502
        try:
2703
 
            return self._transport.get_bytes('last-revision')
 
2503
            return self._control_files.get('last-revision').read()
2704
2504
        except errors.NoSuchFile:
2705
2505
            return _mod_revision.NULL_REVISION
2706
2506
 
2707
2507
    def _change_last_revision(self, revision_id):
2708
2508
        """See WorkingTree._change_last_revision."""
2709
 
        if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
 
2509
        if revision_id is None or revision_id == NULL_REVISION:
2710
2510
            try:
2711
 
                self._transport.delete('last-revision')
 
2511
                self._control_files._transport.delete('last-revision')
2712
2512
            except errors.NoSuchFile:
2713
2513
                pass
2714
2514
            return False
2715
2515
        else:
2716
 
            self._transport.put_bytes('last-revision', revision_id,
2717
 
                mode=self.bzrdir._get_file_mode())
 
2516
            self._control_files.put_bytes('last-revision', revision_id)
2718
2517
            return True
2719
2518
 
2720
 
    def _get_check_refs(self):
2721
 
        """Return the references needed to perform a check of this tree."""
2722
 
        return [('trees', self.last_revision())]
2723
 
 
2724
2519
    @needs_tree_write_lock
2725
2520
    def set_conflicts(self, conflicts):
2726
 
        self._put_rio('conflicts', conflicts.to_stanzas(),
 
2521
        self._put_rio('conflicts', conflicts.to_stanzas(), 
2727
2522
                      CONFLICT_HEADER_1)
2728
2523
 
2729
2524
    @needs_tree_write_lock
2736
2531
    @needs_read_lock
2737
2532
    def conflicts(self):
2738
2533
        try:
2739
 
            confile = self._transport.get('conflicts')
 
2534
            confile = self._control_files.get('conflicts')
2740
2535
        except errors.NoSuchFile:
2741
2536
            return _mod_conflicts.ConflictList()
2742
2537
        try:
2743
 
            try:
2744
 
                if confile.next() != CONFLICT_HEADER_1 + '\n':
2745
 
                    raise errors.ConflictFormatError()
2746
 
            except StopIteration:
 
2538
            if confile.next() != CONFLICT_HEADER_1 + '\n':
2747
2539
                raise errors.ConflictFormatError()
2748
 
            return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2749
 
        finally:
2750
 
            confile.close()
 
2540
        except StopIteration:
 
2541
            raise errors.ConflictFormatError()
 
2542
        return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2751
2543
 
2752
2544
    def unlock(self):
2753
2545
        # do non-implementation specific cleanup
2778
2570
     * a format string,
2779
2571
     * an open routine.
2780
2572
 
2781
 
    Formats are placed in an dict by their format string for reference
 
2573
    Formats are placed in an dict by their format string for reference 
2782
2574
    during workingtree opening. Its not required that these be instances, they
2783
 
    can be classes themselves with class methods - it simply depends on
 
2575
    can be classes themselves with class methods - it simply depends on 
2784
2576
    whether state is needed for a given format or not.
2785
2577
 
2786
2578
    Once a format is deprecated, just deprecate the initialize and open
2787
 
    methods on the format class. Do not deprecate the object, as the
 
2579
    methods on the format class. Do not deprecate the object, as the 
2788
2580
    object will be created every time regardless.
2789
2581
    """
2790
2582
 
2803
2595
        """Return the format for the working tree object in a_bzrdir."""
2804
2596
        try:
2805
2597
            transport = a_bzrdir.get_workingtree_transport(None)
2806
 
            format_string = transport.get_bytes("format")
 
2598
            format_string = transport.get("format").read()
2807
2599
            return klass._formats[format_string]
2808
2600
        except errors.NoSuchFile:
2809
2601
            raise errors.NoWorkingTree(base=transport.base)
2834
2626
        """Is this format supported?
2835
2627
 
2836
2628
        Supported formats can be initialized and opened.
2837
 
        Unsupported formats may not support initialization or committing or
 
2629
        Unsupported formats may not support initialization or committing or 
2838
2630
        some other features depending on the reason for not being supported.
2839
2631
        """
2840
2632
        return True
2841
2633
 
2842
 
    def supports_content_filtering(self):
2843
 
        """True if this format supports content filtering."""
2844
 
        return False
2845
 
 
2846
 
    def supports_views(self):
2847
 
        """True if this format supports stored views."""
2848
 
        return False
2849
 
 
2850
2634
    @classmethod
2851
2635
    def register_format(klass, format):
2852
2636
        klass._formats[format.get_format_string()] = format
2861
2645
 
2862
2646
 
2863
2647
class WorkingTreeFormat2(WorkingTreeFormat):
2864
 
    """The second working tree format.
 
2648
    """The second working tree format. 
2865
2649
 
2866
2650
    This format modified the hash cache from the format 1 hash cache.
2867
2651
    """
2872
2656
        """See WorkingTreeFormat.get_format_description()."""
2873
2657
        return "Working tree format 2"
2874
2658
 
2875
 
    def _stub_initialize_on_transport(self, transport, file_mode):
2876
 
        """Workaround: create control files for a remote working tree.
2877
 
 
 
2659
    def stub_initialize_remote(self, control_files):
 
2660
        """As a special workaround create critical control files for a remote working tree
 
2661
        
2878
2662
        This ensures that it can later be updated and dealt with locally,
2879
 
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
 
2663
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with 
2880
2664
        no working tree.  (See bug #43064).
2881
2665
        """
2882
2666
        sio = StringIO()
2883
 
        inv = inventory.Inventory()
 
2667
        inv = Inventory()
2884
2668
        xml5.serializer_v5.write_inventory(inv, sio, working=True)
2885
2669
        sio.seek(0)
2886
 
        transport.put_file('inventory', sio, file_mode)
2887
 
        transport.put_bytes('pending-merges', '', file_mode)
 
2670
        control_files.put('inventory', sio)
 
2671
 
 
2672
        control_files.put_bytes('pending-merges', '')
 
2673
        
2888
2674
 
2889
2675
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2890
2676
                   accelerator_tree=None, hardlink=False):
2902
2688
            branch.generate_revision_history(revision_id)
2903
2689
        finally:
2904
2690
            branch.unlock()
2905
 
        inv = inventory.Inventory()
 
2691
        inv = Inventory()
2906
2692
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2907
2693
                         branch,
2908
2694
                         inv,
2953
2739
        - is new in bzr 0.8
2954
2740
        - uses a LockDir to guard access for writes.
2955
2741
    """
2956
 
 
 
2742
    
2957
2743
    upgrade_recommended = True
2958
2744
 
2959
2745
    def get_format_string(self):
2976
2762
 
2977
2763
    def _open_control_files(self, a_bzrdir):
2978
2764
        transport = a_bzrdir.get_workingtree_transport(None)
2979
 
        return LockableFiles(transport, self._lock_file_name,
 
2765
        return LockableFiles(transport, self._lock_file_name, 
2980
2766
                             self._lock_class)
2981
2767
 
2982
2768
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2983
2769
                   accelerator_tree=None, hardlink=False):
2984
2770
        """See WorkingTreeFormat.initialize().
2985
 
 
 
2771
        
2986
2772
        :param revision_id: if supplied, create a working tree at a different
2987
2773
            revision than the branch is at.
2988
2774
        :param accelerator_tree: A tree which can be used for retrieving file
2998
2784
        control_files = self._open_control_files(a_bzrdir)
2999
2785
        control_files.create_lock()
3000
2786
        control_files.lock_write()
3001
 
        transport.put_bytes('format', self.get_format_string(),
3002
 
            mode=a_bzrdir._get_file_mode())
 
2787
        control_files.put_utf8('format', self.get_format_string())
3003
2788
        if from_branch is not None:
3004
2789
            branch = from_branch
3005
2790
        else:
3025
2810
            # only set an explicit root id if there is one to set.
3026
2811
            if basis_tree.inventory.root is not None:
3027
2812
                wt.set_root_id(basis_tree.get_root_id())
3028
 
            if revision_id == _mod_revision.NULL_REVISION:
 
2813
            if revision_id == NULL_REVISION:
3029
2814
                wt.set_parent_trees([])
3030
2815
            else:
3031
2816
                wt.set_parent_trees([(revision_id, basis_tree)])
3038
2823
        return wt
3039
2824
 
3040
2825
    def _initial_inventory(self):
3041
 
        return inventory.Inventory()
 
2826
        return Inventory()
3042
2827
 
3043
2828
    def __init__(self):
3044
2829
        super(WorkingTreeFormat3, self).__init__()
3059
2844
 
3060
2845
    def _open(self, a_bzrdir, control_files):
3061
2846
        """Open the tree itself.
3062
 
 
 
2847
        
3063
2848
        :param a_bzrdir: the dir for the tree.
3064
2849
        :param control_files: the control files for the tree.
3065
2850
        """
3073
2858
        return self.get_format_string()
3074
2859
 
3075
2860
 
3076
 
__default_format = WorkingTreeFormat6()
 
2861
__default_format = WorkingTreeFormat4()
3077
2862
WorkingTreeFormat.register_format(__default_format)
3078
 
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3079
 
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3080
2863
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3081
2864
WorkingTreeFormat.set_default_format(__default_format)
3082
2865
# formats which have no format string are not discoverable