~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Martin Pool
  • Date: 2008-05-02 07:31:24 UTC
  • mto: (3408.2.1 integration)
  • mto: This revision was merged to the branch mainline in revision 3410.
  • Revision ID: mbp@sourcefrog.net-20080502073124-nxmeqrzkji6u2m76
Remove code deprecated prior to 1.1 and its tests

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 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""WorkingTree object and friends.
18
18
 
19
19
A WorkingTree represents the editable working copy of a branch.
20
 
Operations which represent the WorkingTree are also done here,
21
 
such as renaming or adding files.  The WorkingTree has an inventory
22
 
which is updated by these operations.  A commit produces a
 
20
Operations which represent the WorkingTree are also done here, 
 
21
such as renaming or adding files.  The WorkingTree has an inventory 
 
22
which is updated by these operations.  A commit produces a 
23
23
new revision based on the workingtree and its inventory.
24
24
 
25
25
At the moment every WorkingTree has its own branch.  Remote
29
29
WorkingTree.open(dir).
30
30
"""
31
31
 
 
32
# TODO: Give the workingtree sole responsibility for the working inventory;
 
33
# remove the variable and references to it from the branch.  This may require
 
34
# updating the commit code so as to update the inventory within the working
 
35
# copy, and making sure there's only one WorkingTree for any directory on disk.
 
36
# At the moment they may alias the inventory and have old copies of it in
 
37
# memory.  (Now done? -- mbp 20060309)
32
38
 
33
39
from cStringIO import StringIO
34
40
import os
42
48
import itertools
43
49
import operator
44
50
import stat
 
51
from time import time
 
52
import warnings
45
53
import re
46
54
 
47
55
import bzrlib
49
57
    branch,
50
58
    bzrdir,
51
59
    conflicts as _mod_conflicts,
 
60
    dirstate,
52
61
    errors,
53
62
    generate_ids,
54
63
    globbing,
55
 
    graph as _mod_graph,
56
64
    hashcache,
57
65
    ignores,
58
 
    inventory,
59
66
    merge,
60
67
    revision as _mod_revision,
61
68
    revisiontree,
 
69
    repository,
 
70
    textui,
62
71
    trace,
63
72
    transform,
64
73
    ui,
65
 
    views,
 
74
    urlutils,
66
75
    xml5,
 
76
    xml6,
67
77
    xml7,
68
78
    )
69
79
import bzrlib.branch
70
80
from bzrlib.transport import get_transport
71
 
from bzrlib.workingtree_4 import (
72
 
    WorkingTreeFormat4,
73
 
    WorkingTreeFormat5,
74
 
    WorkingTreeFormat6,
75
 
    )
 
81
import bzrlib.ui
 
82
from bzrlib.workingtree_4 import WorkingTreeFormat4
76
83
""")
77
84
 
78
85
from bzrlib import symbol_versioning
79
86
from bzrlib.decorators import needs_read_lock, needs_write_lock
80
 
from bzrlib.lockable_files import LockableFiles
 
87
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
 
88
from bzrlib.lockable_files import LockableFiles, TransportLock
81
89
from bzrlib.lockdir import LockDir
82
90
import bzrlib.mutabletree
83
91
from bzrlib.mutabletree import needs_tree_write_lock
84
92
from bzrlib import osutils
85
93
from bzrlib.osutils import (
 
94
    compact_date,
86
95
    file_kind,
87
96
    isdir,
88
97
    normpath,
89
98
    pathjoin,
 
99
    rand_chars,
90
100
    realpath,
91
101
    safe_unicode,
92
102
    splitpath,
93
103
    supports_executable,
94
104
    )
95
 
from bzrlib.filters import filtered_input_file
96
105
from bzrlib.trace import mutter, note
97
106
from bzrlib.transport.local import LocalTransport
98
 
from bzrlib.revision import CURRENT_REVISION
 
107
from bzrlib.progress import DummyProgress, ProgressPhase
 
108
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
99
109
from bzrlib.rio import RioReader, rio_file, Stanza
100
 
from bzrlib.symbol_versioning import (
101
 
    deprecated_passed,
102
 
    DEPRECATED_PARAMETER,
103
 
    )
 
110
from bzrlib.symbol_versioning import (deprecated_passed,
 
111
        deprecated_method,
 
112
        deprecated_function,
 
113
        DEPRECATED_PARAMETER,
 
114
        )
104
115
 
105
116
 
106
117
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
107
 
# TODO: Modifying the conflict objects or their type is currently nearly
108
 
# impossible as there is no clear relationship between the working tree format
109
 
# and the conflict list file format.
110
118
CONFLICT_HEADER_1 = "BZR conflict list format 1"
111
119
 
112
120
ERROR_PATH_NOT_FOUND = 3    # WindowsError errno code, equivalent to ENOENT
115
123
class TreeEntry(object):
116
124
    """An entry that implements the minimum interface used by commands.
117
125
 
118
 
    This needs further inspection, it may be better to have
 
126
    This needs further inspection, it may be better to have 
119
127
    InventoryEntries without ids - though that seems wrong. For now,
120
128
    this is a parallel hierarchy to InventoryEntry, and needs to become
121
129
    one of several things: decorates to that hierarchy, children of, or
124
132
    no InventoryEntry available - i.e. for unversioned objects.
125
133
    Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
126
134
    """
127
 
 
 
135
 
128
136
    def __eq__(self, other):
129
137
        # yes, this us ugly, TODO: best practice __eq__ style.
130
138
        return (isinstance(other, TreeEntry)
131
139
                and other.__class__ == self.__class__)
132
 
 
 
140
 
133
141
    def kind_character(self):
134
142
        return "???"
135
143
 
167
175
        return ''
168
176
 
169
177
 
170
 
class WorkingTree(bzrlib.mutabletree.MutableTree,
171
 
    bzrdir.ControlComponent):
 
178
class WorkingTree(bzrlib.mutabletree.MutableTree):
172
179
    """Working copy tree.
173
180
 
174
181
    The inventory is held in the `Branch` working-inventory, and the
178
185
    not listed in the Inventory and vice versa.
179
186
    """
180
187
 
181
 
    # override this to set the strategy for storing views
182
 
    def _make_views(self):
183
 
        return views.DisabledViews(self)
184
 
 
185
188
    def __init__(self, basedir='.',
186
189
                 branch=DEPRECATED_PARAMETER,
187
190
                 _inventory=None,
198
201
        if not _internal:
199
202
            raise errors.BzrError("Please use bzrdir.open_workingtree or "
200
203
                "WorkingTree.open() to obtain a WorkingTree.")
 
204
        assert isinstance(basedir, basestring), \
 
205
            "base directory %r is not a string" % basedir
201
206
        basedir = safe_unicode(basedir)
202
207
        mutter("opening working tree %r", basedir)
203
208
        if deprecated_passed(branch):
211
216
            self._control_files = self.branch.control_files
212
217
        else:
213
218
            # assume all other formats have their own control files.
 
219
            assert isinstance(_control_files, LockableFiles), \
 
220
                    "_control_files must be a LockableFiles, not %r" \
 
221
                    % _control_files
214
222
            self._control_files = _control_files
215
 
        self._transport = self._control_files._transport
216
223
        # update the whole cache up front and write to disk if anything changed;
217
224
        # in the future we might want to do this more selectively
218
225
        # two possible ways offer themselves : in self._unlock, write the cache
222
229
        wt_trans = self.bzrdir.get_workingtree_transport(None)
223
230
        cache_filename = wt_trans.local_abspath('stat-cache')
224
231
        self._hashcache = hashcache.HashCache(basedir, cache_filename,
225
 
            self.bzrdir._get_file_mode(),
226
 
            self._content_filter_stack_provider())
 
232
                                              self._control_files._file_mode)
227
233
        hc = self._hashcache
228
234
        hc.read()
229
235
        # is this scan needed ? it makes things kinda slow.
244
250
            # permitted to do this.
245
251
            self._set_inventory(_inventory, dirty=False)
246
252
        self._detect_case_handling()
247
 
        self._rules_searcher = None
248
 
        self.views = self._make_views()
249
 
 
250
 
    @property
251
 
    def user_transport(self):
252
 
        return self.bzrdir.user_transport
253
 
 
254
 
    @property
255
 
    def control_transport(self):
256
 
        return self._transport
257
253
 
258
254
    def _detect_case_handling(self):
259
255
        wt_trans = self.bzrdir.get_workingtree_transport(None)
285
281
        self._control_files.break_lock()
286
282
        self.branch.break_lock()
287
283
 
288
 
    def _get_check_refs(self):
289
 
        """Return the references needed to perform a check of this tree.
290
 
        
291
 
        The default implementation returns no refs, and is only suitable for
292
 
        trees that have no local caching and can commit on ghosts at any time.
293
 
 
294
 
        :seealso: bzrlib.check for details about check_refs.
295
 
        """
296
 
        return []
297
 
 
298
284
    def requires_rich_root(self):
299
285
        return self._format.requires_rich_root
300
286
 
301
287
    def supports_tree_reference(self):
302
288
        return False
303
289
 
304
 
    def supports_content_filtering(self):
305
 
        return self._format.supports_content_filtering()
306
 
 
307
 
    def supports_views(self):
308
 
        return self.views.supports_views()
309
 
 
310
290
    def _set_inventory(self, inv, dirty):
311
291
        """Set the internal cached inventory.
312
292
 
317
297
            False then the inventory is the same as that on disk and any
318
298
            serialisation would be unneeded overhead.
319
299
        """
 
300
        assert inv.root is not None
320
301
        self._inventory = inv
321
302
        self._inventory_is_modified = dirty
322
303
 
326
307
 
327
308
        """
328
309
        if path is None:
329
 
            path = osutils.getcwd()
 
310
            path = os.path.getcwdu()
330
311
        control = bzrdir.BzrDir.open(path, _unsupported)
331
312
        return control.open_workingtree(_unsupported)
332
 
 
 
313
        
333
314
    @staticmethod
334
315
    def open_containing(path=None):
335
316
        """Open an existing working tree which has its root about path.
336
 
 
 
317
        
337
318
        This probes for a working tree at path and searches upwards from there.
338
319
 
339
320
        Basically we keep looking up until we find the control directory or
400
381
 
401
382
    def basis_tree(self):
402
383
        """Return RevisionTree for the current last revision.
403
 
 
 
384
        
404
385
        If the left most parent is a ghost then the returned tree will be an
405
 
        empty tree - one obtained by calling
406
 
        repository.revision_tree(NULL_REVISION).
 
386
        empty tree - one obtained by calling repository.revision_tree(None).
407
387
        """
408
388
        try:
409
389
            revision_id = self.get_parent_ids()[0]
411
391
            # no parents, return an empty revision tree.
412
392
            # in the future this should return the tree for
413
393
            # 'empty:' - the implicit root empty tree.
414
 
            return self.branch.repository.revision_tree(
415
 
                       _mod_revision.NULL_REVISION)
 
394
            return self.branch.repository.revision_tree(None)
416
395
        try:
417
396
            return self.revision_tree(revision_id)
418
397
        except errors.NoSuchRevision:
422
401
        # at this point ?
423
402
        try:
424
403
            return self.branch.repository.revision_tree(revision_id)
425
 
        except (errors.RevisionNotPresent, errors.NoSuchRevision):
 
404
        except errors.RevisionNotPresent:
426
405
            # the basis tree *may* be a ghost or a low level error may have
427
 
            # occurred. If the revision is present, its a problem, if its not
 
406
            # occured. If the revision is present, its a problem, if its not
428
407
            # its a ghost.
429
408
            if self.branch.repository.has_revision(revision_id):
430
409
                raise
431
410
            # the basis tree is a ghost so return an empty tree.
432
 
            return self.branch.repository.revision_tree(
433
 
                       _mod_revision.NULL_REVISION)
 
411
            return self.branch.repository.revision_tree(None)
434
412
 
435
413
    def _cleanup(self):
436
414
        self._flush_ignore_list_cache()
437
415
 
438
416
    def relpath(self, path):
439
417
        """Return the local path portion from a given path.
440
 
 
441
 
        The path may be absolute or relative. If its a relative path it is
 
418
        
 
419
        The path may be absolute or relative. If its a relative path it is 
442
420
        interpreted relative to the python current working directory.
443
421
        """
444
422
        return osutils.relpath(self.basedir, path)
446
424
    def has_filename(self, filename):
447
425
        return osutils.lexists(self.abspath(filename))
448
426
 
449
 
    def get_file(self, file_id, path=None, filtered=True):
450
 
        return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
451
 
 
452
 
    def get_file_with_stat(self, file_id, path=None, filtered=True,
453
 
        _fstat=os.fstat):
454
 
        """See Tree.get_file_with_stat."""
 
427
    def get_file(self, file_id, path=None):
455
428
        if path is None:
456
429
            path = self.id2path(file_id)
457
 
        file_obj = self.get_file_byname(path, filtered=False)
458
 
        stat_value = _fstat(file_obj.fileno())
459
 
        if filtered and self.supports_content_filtering():
460
 
            filters = self._content_filter_stack(path)
461
 
            file_obj = filtered_input_file(file_obj, filters)
462
 
        return (file_obj, stat_value)
463
 
 
464
 
    def get_file_text(self, file_id, path=None, filtered=True):
465
 
        return self.get_file(file_id, path=path, filtered=filtered).read()
466
 
 
467
 
    def get_file_byname(self, filename, filtered=True):
468
 
        path = self.abspath(filename)
469
 
        f = file(path, 'rb')
470
 
        if filtered and self.supports_content_filtering():
471
 
            filters = self._content_filter_stack(filename)
472
 
            return filtered_input_file(f, filters)
473
 
        else:
474
 
            return f
475
 
 
476
 
    def get_file_lines(self, file_id, path=None, filtered=True):
477
 
        """See Tree.get_file_lines()"""
478
 
        file = self.get_file(file_id, path, filtered=filtered)
479
 
        try:
480
 
            return file.readlines()
481
 
        finally:
482
 
            file.close()
 
430
        return self.get_file_byname(path)
 
431
 
 
432
    def get_file_text(self, file_id):
 
433
        return self.get_file(file_id).read()
 
434
 
 
435
    def get_file_byname(self, filename):
 
436
        return file(self.abspath(filename), 'rb')
483
437
 
484
438
    @needs_read_lock
485
439
    def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
492
446
        incorrectly attributed to CURRENT_REVISION (but after committing, the
493
447
        attribution will be correct).
494
448
        """
495
 
        maybe_file_parent_keys = []
496
 
        for parent_id in self.get_parent_ids():
497
 
            try:
498
 
                parent_tree = self.revision_tree(parent_id)
499
 
            except errors.NoSuchRevisionInTree:
500
 
                parent_tree = self.branch.repository.revision_tree(parent_id)
501
 
            parent_tree.lock_read()
502
 
            try:
503
 
                if file_id not in parent_tree:
504
 
                    continue
505
 
                ie = parent_tree.inventory[file_id]
506
 
                if ie.kind != 'file':
507
 
                    # Note: this is slightly unnecessary, because symlinks and
508
 
                    # directories have a "text" which is the empty text, and we
509
 
                    # know that won't mess up annotations. But it seems cleaner
510
 
                    continue
511
 
                parent_text_key = (file_id, ie.revision)
512
 
                if parent_text_key not in maybe_file_parent_keys:
513
 
                    maybe_file_parent_keys.append(parent_text_key)
514
 
            finally:
515
 
                parent_tree.unlock()
516
 
        graph = _mod_graph.Graph(self.branch.repository.texts)
517
 
        heads = graph.heads(maybe_file_parent_keys)
518
 
        file_parent_keys = []
519
 
        for key in maybe_file_parent_keys:
520
 
            if key in heads:
521
 
                file_parent_keys.append(key)
522
 
 
523
 
        # Now we have the parents of this content
524
 
        annotator = self.branch.repository.texts.get_annotator()
525
 
        text = self.get_file(file_id).read()
526
 
        this_key =(file_id, default_revision)
527
 
        annotator.add_special_text(this_key, file_parent_keys, text)
528
 
        annotations = [(key[-1], line)
529
 
                       for key, line in annotator.annotate_flat(this_key)]
530
 
        return annotations
 
449
        basis = self.basis_tree()
 
450
        basis.lock_read()
 
451
        try:
 
452
            changes = self.iter_changes(basis, True, [self.id2path(file_id)],
 
453
                require_versioned=True).next()
 
454
            changed_content, kind = changes[2], changes[6]
 
455
            if not changed_content:
 
456
                return basis.annotate_iter(file_id)
 
457
            if kind[1] is None:
 
458
                return None
 
459
            import annotate
 
460
            if kind[0] != 'file':
 
461
                old_lines = []
 
462
            else:
 
463
                old_lines = list(basis.annotate_iter(file_id))
 
464
            old = [old_lines]
 
465
            for tree in self.branch.repository.revision_trees(
 
466
                self.get_parent_ids()[1:]):
 
467
                if file_id not in tree:
 
468
                    continue
 
469
                old.append(list(tree.annotate_iter(file_id)))
 
470
            return annotate.reannotate(old, self.get_file(file_id).readlines(),
 
471
                                       default_revision)
 
472
        finally:
 
473
            basis.unlock()
531
474
 
532
475
    def _get_ancestors(self, default_revision):
533
476
        ancestors = set([default_revision])
538
481
 
539
482
    def get_parent_ids(self):
540
483
        """See Tree.get_parent_ids.
541
 
 
 
484
        
542
485
        This implementation reads the pending merges list and last_revision
543
486
        value and uses that to decide what the parents list should be.
544
487
        """
548
491
        else:
549
492
            parents = [last_rev]
550
493
        try:
551
 
            merges_bytes = self._transport.get_bytes('pending-merges')
 
494
            merges_file = self._control_files.get('pending-merges')
552
495
        except errors.NoSuchFile:
553
496
            pass
554
497
        else:
555
 
            for l in osutils.split_lines(merges_bytes):
 
498
            for l in merges_file.readlines():
556
499
                revision_id = l.rstrip('\n')
557
500
                parents.append(revision_id)
558
501
        return parents
561
504
    def get_root_id(self):
562
505
        """Return the id of this trees root"""
563
506
        return self._inventory.root.file_id
564
 
 
 
507
        
565
508
    def _get_store_filename(self, file_id):
566
509
        ## XXX: badly named; this is not in the store at all
567
510
        return self.abspath(self.id2path(file_id))
569
512
    @needs_read_lock
570
513
    def clone(self, to_bzrdir, revision_id=None):
571
514
        """Duplicate this working tree into to_bzr, including all state.
572
 
 
 
515
        
573
516
        Specifically modified files are kept as modified, but
574
517
        ignored and unknown files are discarded.
575
518
 
576
519
        If you want to make a new line of development, see bzrdir.sprout()
577
520
 
578
521
        revision
579
 
            If not None, the cloned tree will have its last revision set to
580
 
            revision, and difference between the source trees last revision
 
522
            If not None, the cloned tree will have its last revision set to 
 
523
            revision, and and difference between the source trees last revision
581
524
            and this one merged in.
582
525
        """
583
526
        # assumes the target bzr dir format is compatible.
584
 
        result = to_bzrdir.create_workingtree()
 
527
        result = self._format.initialize(to_bzrdir)
585
528
        self.copy_content_into(result, revision_id)
586
529
        return result
587
530
 
617
560
 
618
561
    def get_file_size(self, file_id):
619
562
        """See Tree.get_file_size"""
620
 
        # XXX: this returns the on-disk size; it should probably return the
621
 
        # canonical size
622
563
        try:
623
564
            return os.path.getsize(self.id2abspath(file_id))
624
565
        except OSError, e:
640
581
 
641
582
    def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
642
583
        file_id = self.path2id(path)
643
 
        if file_id is None:
644
 
            # For unversioned files on win32, we just assume they are not
645
 
            # executable
646
 
            return False
647
584
        return self._inventory[file_id].executable
648
585
 
649
586
    def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
671
608
        """See MutableTree._add."""
672
609
        # TODO: Re-adding a file that is removed in the working copy
673
610
        # should probably put it back with the previous ID.
674
 
        # the read and write working inventory should not occur in this
 
611
        # the read and write working inventory should not occur in this 
675
612
        # function - they should be part of lock_write and unlock.
676
613
        inv = self.inventory
677
614
        for f, file_id, kind in zip(files, ids, kinds):
 
615
            assert kind is not None
678
616
            if file_id is None:
679
617
                inv.add_path(f, kind=kind)
680
618
            else:
759
697
            raise
760
698
        kind = _mapper(stat_result.st_mode)
761
699
        if kind == 'file':
762
 
            return self._file_content_summary(path, stat_result)
 
700
            size = stat_result.st_size
 
701
            # try for a stat cache lookup
 
702
            executable = self._is_executable_from_path_and_stat(path, stat_result)
 
703
            return (kind, size, executable, self._sha_from_stat(
 
704
                path, stat_result))
763
705
        elif kind == 'directory':
764
706
            # perhaps it looks like a plain directory, but it's really a
765
707
            # reference.
767
709
                kind = 'tree-reference'
768
710
            return kind, None, None, None
769
711
        elif kind == 'symlink':
770
 
            target = osutils.readlink(abspath)
771
 
            return ('symlink', None, None, target)
 
712
            return ('symlink', None, None, os.readlink(abspath))
772
713
        else:
773
714
            return (kind, None, None, None)
774
715
 
775
 
    def _file_content_summary(self, path, stat_result):
776
 
        size = stat_result.st_size
777
 
        executable = self._is_executable_from_path_and_stat(path, stat_result)
778
 
        # try for a stat cache lookup
779
 
        return ('file', size, executable, self._sha_from_stat(
780
 
            path, stat_result))
781
 
 
782
716
    def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
783
717
        """Common ghost checking functionality from set_parent_*.
784
718
 
793
727
 
794
728
    def _set_merges_from_parent_ids(self, parent_ids):
795
729
        merges = parent_ids[1:]
796
 
        self._transport.put_bytes('pending-merges', '\n'.join(merges),
797
 
            mode=self.bzrdir._get_file_mode())
798
 
 
799
 
    def _filter_parent_ids_by_ancestry(self, revision_ids):
800
 
        """Check that all merged revisions are proper 'heads'.
801
 
 
802
 
        This will always return the first revision_id, and any merged revisions
803
 
        which are
804
 
        """
805
 
        if len(revision_ids) == 0:
806
 
            return revision_ids
807
 
        graph = self.branch.repository.get_graph()
808
 
        heads = graph.heads(revision_ids)
809
 
        new_revision_ids = revision_ids[:1]
810
 
        for revision_id in revision_ids[1:]:
811
 
            if revision_id in heads and revision_id not in new_revision_ids:
812
 
                new_revision_ids.append(revision_id)
813
 
        if new_revision_ids != revision_ids:
814
 
            trace.mutter('requested to set revision_ids = %s,'
815
 
                         ' but filtered to %s', revision_ids, new_revision_ids)
816
 
        return new_revision_ids
 
730
        self._control_files.put_bytes('pending-merges', '\n'.join(merges))
817
731
 
818
732
    @needs_tree_write_lock
819
733
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
820
734
        """Set the parent ids to revision_ids.
821
 
 
 
735
        
822
736
        See also set_parent_trees. This api will try to retrieve the tree data
823
737
        for each element of revision_ids from the trees repository. If you have
824
738
        tree data already available, it is more efficient to use
833
747
        for revision_id in revision_ids:
834
748
            _mod_revision.check_not_reserved_id(revision_id)
835
749
 
836
 
        revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
837
 
 
838
750
        if len(revision_ids) > 0:
839
751
            self.set_last_revision(revision_ids[0])
840
752
        else:
852
764
        self._check_parents_for_ghosts(parent_ids,
853
765
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
854
766
 
855
 
        parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
856
 
 
857
767
        if len(parent_ids) == 0:
858
768
            leftmost_parent_id = _mod_revision.NULL_REVISION
859
769
            leftmost_parent_tree = None
899
809
    def _put_rio(self, filename, stanzas, header):
900
810
        self._must_be_locked()
901
811
        my_file = rio_file(stanzas, header)
902
 
        self._transport.put_file(filename, my_file,
903
 
            mode=self.bzrdir._get_file_mode())
 
812
        self._control_files.put(filename, my_file)
904
813
 
905
814
    @needs_write_lock # because merge pulls data into the branch.
906
815
    def merge_from_branch(self, branch, to_revision=None, from_revision=None,
907
 
                          merge_type=None, force=False):
 
816
        merge_type=None):
908
817
        """Merge from a branch into this working tree.
909
818
 
910
819
        :param branch: The branch to merge from.
914
823
            branch.last_revision().
915
824
        """
916
825
        from bzrlib.merge import Merger, Merge3Merger
917
 
        merger = Merger(self.branch, this_tree=self)
918
 
        # check that there are no local alterations
919
 
        if not force and self.has_changes():
920
 
            raise errors.UncommittedChanges(self)
921
 
        if to_revision is None:
922
 
            to_revision = _mod_revision.ensure_null(branch.last_revision())
923
 
        merger.other_rev_id = to_revision
924
 
        if _mod_revision.is_null(merger.other_rev_id):
925
 
            raise errors.NoCommits(branch)
926
 
        self.branch.fetch(branch, last_revision=merger.other_rev_id)
927
 
        merger.other_basis = merger.other_rev_id
928
 
        merger.other_tree = self.branch.repository.revision_tree(
929
 
            merger.other_rev_id)
930
 
        merger.other_branch = branch
931
 
        if from_revision is None:
932
 
            merger.find_base()
933
 
        else:
934
 
            merger.set_base_revision(from_revision, branch)
935
 
        if merger.base_rev_id == merger.other_rev_id:
936
 
            raise errors.PointlessMerge
937
 
        merger.backup_files = False
938
 
        if merge_type is None:
939
 
            merger.merge_type = Merge3Merger
940
 
        else:
941
 
            merger.merge_type = merge_type
942
 
        merger.set_interesting_files(None)
943
 
        merger.show_base = False
944
 
        merger.reprocess = False
945
 
        conflicts = merger.do_merge()
946
 
        merger.set_pending()
 
826
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
827
        try:
 
828
            merger = Merger(self.branch, this_tree=self, pb=pb)
 
829
            merger.pp = ProgressPhase("Merge phase", 5, pb)
 
830
            merger.pp.next_phase()
 
831
            # check that there are no
 
832
            # local alterations
 
833
            merger.check_basis(check_clean=True, require_commits=False)
 
834
            if to_revision is None:
 
835
                to_revision = _mod_revision.ensure_null(branch.last_revision())
 
836
            merger.other_rev_id = to_revision
 
837
            if _mod_revision.is_null(merger.other_rev_id):
 
838
                raise errors.NoCommits(branch)
 
839
            self.branch.fetch(branch, last_revision=merger.other_rev_id)
 
840
            merger.other_basis = merger.other_rev_id
 
841
            merger.other_tree = self.branch.repository.revision_tree(
 
842
                merger.other_rev_id)
 
843
            merger.other_branch = branch
 
844
            merger.pp.next_phase()
 
845
            if from_revision is None:
 
846
                merger.find_base()
 
847
            else:
 
848
                merger.set_base_revision(from_revision, branch)
 
849
            if merger.base_rev_id == merger.other_rev_id:
 
850
                raise errors.PointlessMerge
 
851
            merger.backup_files = False
 
852
            if merge_type is None:
 
853
                merger.merge_type = Merge3Merger
 
854
            else:
 
855
                merger.merge_type = merge_type
 
856
            merger.set_interesting_files(None)
 
857
            merger.show_base = False
 
858
            merger.reprocess = False
 
859
            conflicts = merger.do_merge()
 
860
            merger.set_pending()
 
861
        finally:
 
862
            pb.finished()
947
863
        return conflicts
948
864
 
949
865
    @needs_read_lock
950
866
    def merge_modified(self):
951
867
        """Return a dictionary of files modified by a merge.
952
868
 
953
 
        The list is initialized by WorkingTree.set_merge_modified, which is
 
869
        The list is initialized by WorkingTree.set_merge_modified, which is 
954
870
        typically called after we make some automatic updates to the tree
955
871
        because of a merge.
956
872
 
958
874
        still in the working inventory and have that text hash.
959
875
        """
960
876
        try:
961
 
            hashfile = self._transport.get('merge-hashes')
 
877
            hashfile = self._control_files.get('merge-hashes')
962
878
        except errors.NoSuchFile:
963
879
            return {}
 
880
        merge_hashes = {}
964
881
        try:
965
 
            merge_hashes = {}
966
 
            try:
967
 
                if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
968
 
                    raise errors.MergeModifiedFormatError()
969
 
            except StopIteration:
 
882
            if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
970
883
                raise errors.MergeModifiedFormatError()
971
 
            for s in RioReader(hashfile):
972
 
                # RioReader reads in Unicode, so convert file_ids back to utf8
973
 
                file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
974
 
                if file_id not in self.inventory:
975
 
                    continue
976
 
                text_hash = s.get("hash")
977
 
                if text_hash == self.get_file_sha1(file_id):
978
 
                    merge_hashes[file_id] = text_hash
979
 
            return merge_hashes
980
 
        finally:
981
 
            hashfile.close()
 
884
        except StopIteration:
 
885
            raise errors.MergeModifiedFormatError()
 
886
        for s in RioReader(hashfile):
 
887
            # RioReader reads in Unicode, so convert file_ids back to utf8
 
888
            file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
 
889
            if file_id not in self.inventory:
 
890
                continue
 
891
            text_hash = s.get("hash")
 
892
            if text_hash == self.get_file_sha1(file_id):
 
893
                merge_hashes[file_id] = text_hash
 
894
        return merge_hashes
982
895
 
983
896
    @needs_write_lock
984
897
    def mkdir(self, path, file_id=None):
990
903
        return file_id
991
904
 
992
905
    def get_symlink_target(self, file_id):
993
 
        abspath = self.id2abspath(file_id)
994
 
        target = osutils.readlink(abspath)
995
 
        return target
 
906
        return os.readlink(self.id2abspath(file_id))
996
907
 
997
908
    @needs_write_lock
998
909
    def subsume(self, other_tree):
1048
959
        return False
1049
960
 
1050
961
    def _directory_may_be_tree_reference(self, relpath):
1051
 
        # as a special case, if a directory contains control files then
 
962
        # as a special case, if a directory contains control files then 
1052
963
        # it's a tree reference, except that the root of the tree is not
1053
964
        return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1054
965
        # TODO: We could ask all the control formats whether they
1065
976
    @needs_tree_write_lock
1066
977
    def extract(self, file_id, format=None):
1067
978
        """Extract a subtree from this tree.
1068
 
 
 
979
        
1069
980
        A new branch will be created, relative to the path for this tree.
1070
981
        """
1071
982
        self.flush()
1076
987
                transport = transport.clone(name)
1077
988
                transport.ensure_base()
1078
989
            return transport
1079
 
 
 
990
            
1080
991
        sub_path = self.id2path(file_id)
1081
992
        branch_transport = mkdirs(sub_path)
1082
993
        if format is None:
1096
1007
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
1097
1008
        if tree_transport.base != branch_transport.base:
1098
1009
            tree_bzrdir = format.initialize_on_transport(tree_transport)
1099
 
            branch.BranchReferenceFormat().initialize(tree_bzrdir,
1100
 
                target_branch=new_branch)
 
1010
            branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1101
1011
        else:
1102
1012
            tree_bzrdir = branch_bzrdir
1103
 
        wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
 
1013
        wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1104
1014
        wt.set_parent_ids(self.get_parent_ids())
1105
1015
        my_inv = self.inventory
1106
 
        child_inv = inventory.Inventory(root_id=None)
 
1016
        child_inv = Inventory(root_id=None)
1107
1017
        new_root = my_inv[file_id]
1108
1018
        my_inv.remove_recursive_id(file_id)
1109
1019
        new_root.parent_id = None
1127
1037
        sio = StringIO()
1128
1038
        self._serialize(self._inventory, sio)
1129
1039
        sio.seek(0)
1130
 
        self._transport.put_file('inventory', sio,
1131
 
            mode=self.bzrdir._get_file_mode())
 
1040
        self._control_files.put('inventory', sio)
1132
1041
        self._inventory_is_modified = False
1133
1042
 
1134
1043
    def _kind(self, relpath):
1135
1044
        return osutils.file_kind(self.abspath(relpath))
1136
1045
 
1137
 
    def list_files(self, include_root=False, from_dir=None, recursive=True):
1138
 
        """List all files as (path, class, kind, id, entry).
 
1046
    def list_files(self, include_root=False):
 
1047
        """Recursively list all files as (path, class, kind, id, entry).
1139
1048
 
1140
1049
        Lists, but does not descend into unversioned directories.
 
1050
 
1141
1051
        This does not include files that have been deleted in this
1142
 
        tree. Skips the control directory.
 
1052
        tree.
1143
1053
 
1144
 
        :param include_root: if True, return an entry for the root
1145
 
        :param from_dir: start from this directory or None for the root
1146
 
        :param recursive: whether to recurse into subdirectories or not
 
1054
        Skips the control directory.
1147
1055
        """
1148
1056
        # list_files is an iterator, so @needs_read_lock doesn't work properly
1149
1057
        # with it. So callers should be careful to always read_lock the tree.
1151
1059
            raise errors.ObjectNotLocked(self)
1152
1060
 
1153
1061
        inv = self.inventory
1154
 
        if from_dir is None and include_root is True:
 
1062
        if include_root is True:
1155
1063
            yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1156
1064
        # Convert these into local objects to save lookup times
1157
1065
        pathjoin = osutils.pathjoin
1164
1072
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1165
1073
 
1166
1074
        # directory file_id, relative path, absolute path, reverse sorted children
1167
 
        if from_dir is not None:
1168
 
            from_dir_id = inv.path2id(from_dir)
1169
 
            if from_dir_id is None:
1170
 
                # Directory not versioned
1171
 
                return
1172
 
            from_dir_abspath = pathjoin(self.basedir, from_dir)
1173
 
        else:
1174
 
            from_dir_id = inv.root.file_id
1175
 
            from_dir_abspath = self.basedir
1176
 
        children = os.listdir(from_dir_abspath)
 
1075
        children = os.listdir(self.basedir)
1177
1076
        children.sort()
1178
 
        # jam 20060527 The kernel sized tree seems equivalent whether we
 
1077
        # jam 20060527 The kernel sized tree seems equivalent whether we 
1179
1078
        # use a deque and popleft to keep them sorted, or if we use a plain
1180
1079
        # list and just reverse() them.
1181
1080
        children = collections.deque(children)
1182
 
        stack = [(from_dir_id, u'', from_dir_abspath, children)]
 
1081
        stack = [(inv.root.file_id, u'', self.basedir, children)]
1183
1082
        while stack:
1184
1083
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1185
1084
 
1201
1100
 
1202
1101
                # absolute path
1203
1102
                fap = from_dir_abspath + '/' + f
1204
 
 
 
1103
                
1205
1104
                f_ie = inv.get_child(from_dir_id, f)
1206
1105
                if f_ie:
1207
1106
                    c = 'V'
1239
1138
                    except KeyError:
1240
1139
                        yield fp[1:], c, fk, None, TreeEntry()
1241
1140
                    continue
1242
 
 
 
1141
                
1243
1142
                if fk != 'directory':
1244
1143
                    continue
1245
1144
 
1246
 
                # But do this child first if recursing down
1247
 
                if recursive:
1248
 
                    new_children = os.listdir(fap)
1249
 
                    new_children.sort()
1250
 
                    new_children = collections.deque(new_children)
1251
 
                    stack.append((f_ie.file_id, fp, fap, new_children))
1252
 
                    # Break out of inner loop,
1253
 
                    # so that we start outer loop with child
1254
 
                    break
 
1145
                # But do this child first
 
1146
                new_children = os.listdir(fap)
 
1147
                new_children.sort()
 
1148
                new_children = collections.deque(new_children)
 
1149
                stack.append((f_ie.file_id, fp, fap, new_children))
 
1150
                # Break out of inner loop,
 
1151
                # so that we start outer loop with child
 
1152
                break
1255
1153
            else:
1256
1154
                # if we finished all children, pop it off the stack
1257
1155
                stack.pop()
1263
1161
        to_dir must exist in the inventory.
1264
1162
 
1265
1163
        If to_dir exists and is a directory, the files are moved into
1266
 
        it, keeping their old names.
 
1164
        it, keeping their old names.  
1267
1165
 
1268
1166
        Note that to_dir is only the last component of the new name;
1269
1167
        this doesn't change the directory.
1306
1204
                                       DeprecationWarning)
1307
1205
 
1308
1206
        # check destination directory
1309
 
        if isinstance(from_paths, basestring):
1310
 
            raise ValueError()
 
1207
        assert not isinstance(from_paths, basestring)
1311
1208
        inv = self.inventory
1312
1209
        to_abs = self.abspath(to_dir)
1313
1210
        if not isdir(to_abs):
1397
1294
                only_change_inv = True
1398
1295
            elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1399
1296
                only_change_inv = False
1400
 
            elif (not self.case_sensitive
1401
 
                  and from_rel.lower() == to_rel.lower()
1402
 
                  and self.has_filename(from_rel)):
 
1297
            elif (sys.platform == 'win32'
 
1298
                and from_rel.lower() == to_rel.lower()
 
1299
                and self.has_filename(from_rel)):
1403
1300
                only_change_inv = False
1404
1301
            else:
1405
1302
                # something is wrong, so lets determine what exactly
1435
1332
        inv = self.inventory
1436
1333
        for entry in moved:
1437
1334
            try:
1438
 
                self._move_entry(WorkingTree._RenameEntry(
1439
 
                    entry.to_rel, entry.from_id,
 
1335
                self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1440
1336
                    entry.to_tail, entry.to_parent_id, entry.from_rel,
1441
1337
                    entry.from_tail, entry.from_parent_id,
1442
1338
                    entry.only_change_inv))
1493
1389
        from_tail = splitpath(from_rel)[-1]
1494
1390
        from_id = inv.path2id(from_rel)
1495
1391
        if from_id is None:
1496
 
            # if file is missing in the inventory maybe it's in the basis_tree
1497
 
            basis_tree = self.branch.basis_tree()
1498
 
            from_id = basis_tree.path2id(from_rel)
1499
 
            if from_id is None:
1500
 
                raise errors.BzrRenameFailedError(from_rel,to_rel,
1501
 
                    errors.NotVersionedError(path=str(from_rel)))
1502
 
            # put entry back in the inventory so we can rename it
1503
 
            from_entry = basis_tree.inventory[from_id].copy()
1504
 
            inv.add(from_entry)
1505
 
        else:
1506
 
            from_entry = inv[from_id]
 
1392
            raise errors.BzrRenameFailedError(from_rel,to_rel,
 
1393
                errors.NotVersionedError(path=str(from_rel)))
 
1394
        from_entry = inv[from_id]
1507
1395
        from_parent_id = from_entry.parent_id
1508
1396
        to_dir, to_tail = os.path.split(to_rel)
1509
1397
        to_dir_id = inv.path2id(to_dir)
1555
1443
        These are files in the working directory that are not versioned or
1556
1444
        control files or ignored.
1557
1445
        """
1558
 
        # force the extras method to be fully executed before returning, to
 
1446
        # force the extras method to be fully executed before returning, to 
1559
1447
        # prevent race conditions with the lock
1560
1448
        return iter(
1561
1449
            [subp for subp in self.extras() if not self.is_ignored(subp)])
1571
1459
        :raises: NoSuchId if any fileid is not currently versioned.
1572
1460
        """
1573
1461
        for file_id in file_ids:
1574
 
            if file_id not in self._inventory:
1575
 
                raise errors.NoSuchId(self, file_id)
1576
 
        for file_id in file_ids:
1577
1462
            if self._inventory.has_id(file_id):
1578
1463
                self._inventory.remove_recursive_id(file_id)
 
1464
            else:
 
1465
                raise errors.NoSuchId(self, file_id)
1579
1466
        if len(file_ids):
1580
 
            # in the future this should just set a dirty bit to wait for the
 
1467
            # in the future this should just set a dirty bit to wait for the 
1581
1468
            # final unlock. However, until all methods of workingtree start
1582
 
            # with the current in -memory inventory rather than triggering
 
1469
            # with the current in -memory inventory rather than triggering 
1583
1470
            # a read, it is more complex - we need to teach read_inventory
1584
1471
            # to know when to read, and when to not read first... and possibly
1585
1472
            # to save first when the in memory one may be corrupted.
1586
1473
            # so for now, we just only write it if it is indeed dirty.
1587
1474
            # - RBC 20060907
1588
1475
            self._write_inventory(self._inventory)
1589
 
 
 
1476
    
1590
1477
    def _iter_conflicts(self):
1591
1478
        conflicted = set()
1592
1479
        for info in self.list_files():
1600
1487
 
1601
1488
    @needs_write_lock
1602
1489
    def pull(self, source, overwrite=False, stop_revision=None,
1603
 
             change_reporter=None, possible_transports=None, local=False):
 
1490
             change_reporter=None, possible_transports=None):
 
1491
        top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1604
1492
        source.lock_read()
1605
1493
        try:
 
1494
            pp = ProgressPhase("Pull phase", 2, top_pb)
 
1495
            pp.next_phase()
1606
1496
            old_revision_info = self.branch.last_revision_info()
1607
1497
            basis_tree = self.basis_tree()
1608
1498
            count = self.branch.pull(source, overwrite, stop_revision,
1609
 
                                     possible_transports=possible_transports,
1610
 
                                     local=local)
 
1499
                                     possible_transports=possible_transports)
1611
1500
            new_revision_info = self.branch.last_revision_info()
1612
1501
            if new_revision_info != old_revision_info:
 
1502
                pp.next_phase()
1613
1503
                repository = self.branch.repository
 
1504
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
1614
1505
                basis_tree.lock_read()
1615
1506
                try:
1616
1507
                    new_basis_tree = self.branch.basis_tree()
1619
1510
                                new_basis_tree,
1620
1511
                                basis_tree,
1621
1512
                                this_tree=self,
1622
 
                                pb=None,
 
1513
                                pb=pb,
1623
1514
                                change_reporter=change_reporter)
1624
 
                    basis_root_id = basis_tree.get_root_id()
1625
 
                    new_root_id = new_basis_tree.get_root_id()
1626
 
                    if basis_root_id != new_root_id:
1627
 
                        self.set_root_id(new_root_id)
 
1515
                    if (basis_tree.inventory.root is None and
 
1516
                        new_basis_tree.inventory.root is not None):
 
1517
                        self.set_root_id(new_basis_tree.get_root_id())
1628
1518
                finally:
 
1519
                    pb.finished()
1629
1520
                    basis_tree.unlock()
1630
1521
                # TODO - dedup parents list with things merged by pull ?
1631
1522
                # reuse the revisiontree we merged against to set the new
1632
1523
                # tree data.
1633
1524
                parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1634
 
                # we have to pull the merge trees out again, because
1635
 
                # merge_inner has set the ids. - this corner is not yet
 
1525
                # we have to pull the merge trees out again, because 
 
1526
                # merge_inner has set the ids. - this corner is not yet 
1636
1527
                # layered well enough to prevent double handling.
1637
1528
                # XXX TODO: Fix the double handling: telling the tree about
1638
1529
                # the already known parent data is wasteful.
1644
1535
            return count
1645
1536
        finally:
1646
1537
            source.unlock()
 
1538
            top_pb.finished()
1647
1539
 
1648
1540
    @needs_write_lock
1649
1541
    def put_file_bytes_non_atomic(self, file_id, bytes):
1675
1567
 
1676
1568
            fl = []
1677
1569
            for subf in os.listdir(dirabs):
1678
 
                if self.bzrdir.is_control_filename(subf):
 
1570
                if subf == '.bzr':
1679
1571
                    continue
1680
1572
                if subf not in dir_entry.children:
1681
 
                    try:
1682
 
                        (subf_norm,
1683
 
                         can_access) = osutils.normalized_filename(subf)
1684
 
                    except UnicodeDecodeError:
1685
 
                        path_os_enc = path.encode(osutils._fs_enc)
1686
 
                        relpath = path_os_enc + '/' + subf
1687
 
                        raise errors.BadFilenameEncoding(relpath,
1688
 
                                                         osutils._fs_enc)
 
1573
                    subf_norm, can_access = osutils.normalized_filename(subf)
1689
1574
                    if subf_norm != subf and can_access:
1690
1575
                        if subf_norm not in dir_entry.children:
1691
1576
                            fl.append(subf_norm)
1692
1577
                    else:
1693
1578
                        fl.append(subf)
1694
 
 
 
1579
            
1695
1580
            fl.sort()
1696
1581
            for subf in fl:
1697
1582
                subp = pathjoin(path, subf)
1734
1619
        r"""Check whether the filename matches an ignore pattern.
1735
1620
 
1736
1621
        Patterns containing '/' or '\' need to match the whole path;
1737
 
        others match against only the last component.  Patterns starting
1738
 
        with '!' are ignore exceptions.  Exceptions take precedence
1739
 
        over regular patterns and cause the filename to not be ignored.
 
1622
        others match against only the last component.
1740
1623
 
1741
1624
        If the file is ignored, returns the pattern which caused it to
1742
1625
        be ignored, otherwise None.  So this can simply be used as a
1743
1626
        boolean if desired."""
1744
1627
        if getattr(self, '_ignoreglobster', None) is None:
1745
 
            self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
 
1628
            self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1746
1629
        return self._ignoreglobster.match(filename)
1747
1630
 
1748
1631
    def kind(self, file_id):
1839
1722
    def _reset_data(self):
1840
1723
        """Reset transient data that cannot be revalidated."""
1841
1724
        self._inventory_is_modified = False
1842
 
        f = self._transport.get('inventory')
1843
 
        try:
1844
 
            result = self._deserialize(f)
1845
 
        finally:
1846
 
            f.close()
 
1725
        result = self._deserialize(self._control_files.get('inventory'))
1847
1726
        self._set_inventory(result, dirty=False)
1848
1727
 
1849
1728
    @needs_tree_write_lock
1854
1733
 
1855
1734
    def _change_last_revision(self, new_revision):
1856
1735
        """Template method part of set_last_revision to perform the change.
1857
 
 
 
1736
        
1858
1737
        This is used to allow WorkingTree3 instances to not affect branch
1859
1738
        when their last revision is set.
1860
1739
        """
1870
1749
 
1871
1750
    def _write_basis_inventory(self, xml):
1872
1751
        """Write the basis inventory XML to the basis-inventory file"""
 
1752
        assert isinstance(xml, str), 'serialised xml must be bytestring.'
1873
1753
        path = self._basis_inventory_name()
1874
1754
        sio = StringIO(xml)
1875
 
        self._transport.put_file(path, sio,
1876
 
            mode=self.bzrdir._get_file_mode())
 
1755
        self._control_files.put(path, sio)
1877
1756
 
1878
1757
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
1879
1758
        """Create the text that will be saved in basis-inventory"""
1886
1765
        # as commit already has that ready-to-use [while the format is the
1887
1766
        # same, that is].
1888
1767
        try:
1889
 
            # this double handles the inventory - unpack and repack -
 
1768
            # this double handles the inventory - unpack and repack - 
1890
1769
            # but is easier to understand. We can/should put a conditional
1891
1770
            # in here based on whether the inventory is in the latest format
1892
1771
            # - perhaps we should repack all inventories on a repository
1893
1772
            # upgrade ?
1894
1773
            # the fast path is to copy the raw xml from the repository. If the
1895
 
            # xml contains 'revision_id="', then we assume the right
 
1774
            # xml contains 'revision_id="', then we assume the right 
1896
1775
            # revision_id is set. We must check for this full string, because a
1897
1776
            # root node id can legitimately look like 'revision_id' but cannot
1898
1777
            # contain a '"'.
1899
 
            xml = self.branch.repository._get_inventory_xml(new_revision)
 
1778
            xml = self.branch.repository.get_inventory_xml(new_revision)
1900
1779
            firstline = xml.split('\n', 1)[0]
1901
 
            if (not 'revision_id="' in firstline or
 
1780
            if (not 'revision_id="' in firstline or 
1902
1781
                'format="7"' not in firstline):
1903
 
                inv = self.branch.repository._serializer.read_inventory_from_string(
1904
 
                    xml, new_revision)
 
1782
                inv = self.branch.repository.deserialise_inventory(
 
1783
                    new_revision, xml)
1905
1784
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
1906
1785
            self._write_basis_inventory(xml)
1907
1786
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
1910
1789
    def read_basis_inventory(self):
1911
1790
        """Read the cached basis inventory."""
1912
1791
        path = self._basis_inventory_name()
1913
 
        return self._transport.get_bytes(path)
1914
 
 
 
1792
        return self._control_files.get(path).read()
 
1793
        
1915
1794
    @needs_read_lock
1916
1795
    def read_working_inventory(self):
1917
1796
        """Read the working inventory.
1918
 
 
 
1797
        
1919
1798
        :raises errors.InventoryModified: read_working_inventory will fail
1920
1799
            when the current in memory inventory has been modified.
1921
1800
        """
1922
 
        # conceptually this should be an implementation detail of the tree.
 
1801
        # conceptually this should be an implementation detail of the tree. 
1923
1802
        # XXX: Deprecate this.
1924
1803
        # ElementTree does its own conversion from UTF-8, so open in
1925
1804
        # binary.
1926
1805
        if self._inventory_is_modified:
1927
1806
            raise errors.InventoryModified(self)
1928
 
        f = self._transport.get('inventory')
1929
 
        try:
1930
 
            result = self._deserialize(f)
1931
 
        finally:
1932
 
            f.close()
 
1807
        result = self._deserialize(self._control_files.get('inventory'))
1933
1808
        self._set_inventory(result, dirty=False)
1934
1809
        return result
1935
1810
 
1950
1825
 
1951
1826
        new_files=set()
1952
1827
        unknown_nested_files=set()
1953
 
        if to_file is None:
1954
 
            to_file = sys.stdout
1955
1828
 
1956
1829
        def recurse_directory_to_add_files(directory):
1957
1830
            # Recurse directory and add all files
1958
1831
            # so we can check if they have changed.
1959
1832
            for parent_info, file_infos in\
1960
 
                self.walkdirs(directory):
1961
 
                for relpath, basename, kind, lstat, fileid, kind in file_infos:
 
1833
                osutils.walkdirs(self.abspath(directory),
 
1834
                    directory):
 
1835
                for relpath, basename, kind, lstat, abspath in file_infos:
1962
1836
                    # Is it versioned or ignored?
1963
1837
                    if self.path2id(relpath) or self.is_ignored(relpath):
1964
1838
                        # Add nested content for deletion.
1974
1848
            filename = self.relpath(abspath)
1975
1849
            if len(filename) > 0:
1976
1850
                new_files.add(filename)
1977
 
                recurse_directory_to_add_files(filename)
 
1851
                if osutils.isdir(abspath):
 
1852
                    recurse_directory_to_add_files(filename)
1978
1853
 
1979
1854
        files = list(new_files)
1980
1855
 
1998
1873
                            # ... but not ignored
1999
1874
                            has_changed_files = True
2000
1875
                            break
2001
 
                    elif content_change and (kind[1] is not None):
 
1876
                    elif content_change and (kind[1] != None):
2002
1877
                        # Versioned and changed, but not deleted
2003
1878
                        has_changed_files = True
2004
1879
                        break
2013
1888
                        tree_delta.unversioned.extend((unknown_file,))
2014
1889
                raise errors.BzrRemoveChangedFilesError(tree_delta)
2015
1890
 
2016
 
        # Build inv_delta and delete files where applicable,
 
1891
        # Build inv_delta and delete files where applicaple,
2017
1892
        # do this before any modifications to inventory.
2018
1893
        for f in files:
2019
1894
            fid = self.path2id(f)
2027
1902
                        new_status = 'I'
2028
1903
                    else:
2029
1904
                        new_status = '?'
2030
 
                    # XXX: Really should be a more abstract reporter interface
2031
 
                    kind_ch = osutils.kind_marker(self.kind(fid))
2032
 
                    to_file.write(new_status + '       ' + f + kind_ch + '\n')
 
1905
                    textui.show_status(new_status, self.kind(fid), f,
 
1906
                                       to_file=to_file)
2033
1907
                # Unversion file
2034
1908
                inv_delta.append((f, None, fid, None))
2035
1909
                message = "removed %s" % (f,)
2058
1932
 
2059
1933
    @needs_tree_write_lock
2060
1934
    def revert(self, filenames=None, old_tree=None, backups=True,
2061
 
               pb=None, report_changes=False):
 
1935
               pb=DummyProgress(), report_changes=False):
2062
1936
        from bzrlib.conflicts import resolve
2063
1937
        if filenames == []:
2064
1938
            filenames = None
2077
1951
            if filenames is None and len(self.get_parent_ids()) > 1:
2078
1952
                parent_trees = []
2079
1953
                last_revision = self.last_revision()
2080
 
                if last_revision != _mod_revision.NULL_REVISION:
 
1954
                if last_revision != NULL_REVISION:
2081
1955
                    if basis_tree is None:
2082
1956
                        basis_tree = self.basis_tree()
2083
1957
                        basis_tree.lock_read()
2121
1995
    def set_inventory(self, new_inventory_list):
2122
1996
        from bzrlib.inventory import (Inventory,
2123
1997
                                      InventoryDirectory,
 
1998
                                      InventoryEntry,
2124
1999
                                      InventoryFile,
2125
2000
                                      InventoryLink)
2126
2001
        inv = Inventory(self.get_root_id())
2128
2003
            name = os.path.basename(path)
2129
2004
            if name == "":
2130
2005
                continue
2131
 
            # fixme, there should be a factory function inv,add_??
 
2006
            # fixme, there should be a factory function inv,add_?? 
2132
2007
            if kind == 'directory':
2133
2008
                inv.add(InventoryDirectory(file_id, name, parent))
2134
2009
            elif kind == 'file':
2142
2017
    @needs_tree_write_lock
2143
2018
    def set_root_id(self, file_id):
2144
2019
        """Set the root id for this tree."""
2145
 
        # for compatability
 
2020
        # for compatability 
2146
2021
        if file_id is None:
2147
2022
            raise ValueError(
2148
2023
                'WorkingTree.set_root_id with fileid=None')
2152
2027
    def _set_root_id(self, file_id):
2153
2028
        """Set the root id for this tree, in a format specific manner.
2154
2029
 
2155
 
        :param file_id: The file id to assign to the root. It must not be
 
2030
        :param file_id: The file id to assign to the root. It must not be 
2156
2031
            present in the current inventory or an error will occur. It must
2157
2032
            not be None, but rather a valid file id.
2158
2033
        """
2177
2052
 
2178
2053
    def unlock(self):
2179
2054
        """See Branch.unlock.
2180
 
 
 
2055
        
2181
2056
        WorkingTree locking just uses the Branch locking facilities.
2182
2057
        This is current because all working trees have an embedded branch
2183
2058
        within them. IF in the future, we were to make branch data shareable
2184
 
        between multiple working trees, i.e. via shared storage, then we
 
2059
        between multiple working trees, i.e. via shared storage, then we 
2185
2060
        would probably want to lock both the local tree, and the branch.
2186
2061
        """
2187
2062
        raise NotImplementedError(self.unlock)
2188
2063
 
2189
 
    _marker = object()
2190
 
 
2191
 
    def update(self, change_reporter=None, possible_transports=None,
2192
 
               revision=None, old_tip=_marker):
 
2064
    def update(self, change_reporter=None, possible_transports=None):
2193
2065
        """Update a working tree along its branch.
2194
2066
 
2195
2067
        This will update the branch if its bound too, which means we have
2213
2085
        - Merge current state -> basis tree of the master w.r.t. the old tree
2214
2086
          basis.
2215
2087
        - Do a 'normal' merge of the old branch basis if it is relevant.
2216
 
 
2217
 
        :param revision: The target revision to update to. Must be in the
2218
 
            revision history.
2219
 
        :param old_tip: If branch.update() has already been run, the value it
2220
 
            returned (old tip of the branch or None). _marker is used
2221
 
            otherwise.
2222
2088
        """
2223
2089
        if self.branch.get_bound_location() is not None:
2224
2090
            self.lock_write()
2225
 
            update_branch = (old_tip is self._marker)
 
2091
            update_branch = True
2226
2092
        else:
2227
2093
            self.lock_tree_write()
2228
2094
            update_branch = False
2230
2096
            if update_branch:
2231
2097
                old_tip = self.branch.update(possible_transports)
2232
2098
            else:
2233
 
                if old_tip is self._marker:
2234
 
                    old_tip = None
2235
 
            return self._update_tree(old_tip, change_reporter, revision)
 
2099
                old_tip = None
 
2100
            return self._update_tree(old_tip, change_reporter)
2236
2101
        finally:
2237
2102
            self.unlock()
2238
2103
 
2239
2104
    @needs_tree_write_lock
2240
 
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
 
2105
    def _update_tree(self, old_tip=None, change_reporter=None):
2241
2106
        """Update a tree to the master branch.
2242
2107
 
2243
2108
        :param old_tip: if supplied, the previous tip revision the branch,
2249
2114
        # cant set that until we update the working trees last revision to be
2250
2115
        # one from the new branch, because it will just get absorbed by the
2251
2116
        # parent de-duplication logic.
2252
 
        #
 
2117
        # 
2253
2118
        # We MUST save it even if an error occurs, because otherwise the users
2254
2119
        # local work is unreferenced and will appear to have been lost.
2255
 
        #
2256
 
        nb_conflicts = 0
 
2120
        # 
 
2121
        result = 0
2257
2122
        try:
2258
2123
            last_rev = self.get_parent_ids()[0]
2259
2124
        except IndexError:
2260
2125
            last_rev = _mod_revision.NULL_REVISION
2261
 
        if revision is None:
2262
 
            revision = self.branch.last_revision()
2263
 
 
2264
 
        old_tip = old_tip or _mod_revision.NULL_REVISION
2265
 
 
2266
 
        if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2267
 
            # the branch we are bound to was updated
2268
 
            # merge those changes in first
2269
 
            base_tree  = self.basis_tree()
2270
 
            other_tree = self.branch.repository.revision_tree(old_tip)
2271
 
            nb_conflicts = merge.merge_inner(self.branch, other_tree,
2272
 
                                             base_tree, this_tree=self,
2273
 
                                             change_reporter=change_reporter)
2274
 
            if nb_conflicts:
2275
 
                self.add_parent_tree((old_tip, other_tree))
2276
 
                trace.note('Rerun update after fixing the conflicts.')
2277
 
                return nb_conflicts
2278
 
 
2279
 
        if last_rev != _mod_revision.ensure_null(revision):
2280
 
            # the working tree is up to date with the branch
2281
 
            # we can merge the specified revision from master
2282
 
            to_tree = self.branch.repository.revision_tree(revision)
2283
 
            to_root_id = to_tree.get_root_id()
2284
 
 
 
2126
        if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
 
2127
            # merge tree state up to new branch tip.
2285
2128
            basis = self.basis_tree()
2286
2129
            basis.lock_read()
2287
2130
            try:
2288
 
                if (basis.inventory.root is None
2289
 
                    or basis.inventory.root.file_id != to_root_id):
2290
 
                    self.set_root_id(to_root_id)
 
2131
                to_tree = self.branch.basis_tree()
 
2132
                if basis.inventory.root is None:
 
2133
                    self.set_root_id(to_tree.get_root_id())
2291
2134
                    self.flush()
 
2135
                result += merge.merge_inner(
 
2136
                                      self.branch,
 
2137
                                      to_tree,
 
2138
                                      basis,
 
2139
                                      this_tree=self,
 
2140
                                      change_reporter=change_reporter)
2292
2141
            finally:
2293
2142
                basis.unlock()
2294
 
 
2295
 
            # determine the branch point
2296
 
            graph = self.branch.repository.get_graph()
2297
 
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2298
 
                                                last_rev)
2299
 
            base_tree = self.branch.repository.revision_tree(base_rev_id)
2300
 
 
2301
 
            nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2302
 
                                             this_tree=self,
2303
 
                                             change_reporter=change_reporter)
2304
 
            self.set_last_revision(revision)
2305
2143
            # TODO - dedup parents list with things merged by pull ?
2306
2144
            # reuse the tree we've updated to to set the basis:
2307
 
            parent_trees = [(revision, to_tree)]
 
2145
            parent_trees = [(self.branch.last_revision(), to_tree)]
2308
2146
            merges = self.get_parent_ids()[1:]
2309
2147
            # Ideally we ask the tree for the trees here, that way the working
2310
 
            # tree can decide whether to give us the entire tree or give us a
 
2148
            # tree can decide whether to give us teh entire tree or give us a
2311
2149
            # lazy initialised tree. dirstate for instance will have the trees
2312
2150
            # in ram already, whereas a last-revision + basis-inventory tree
2313
2151
            # will not, but also does not need them when setting parents.
2314
2152
            for parent in merges:
2315
2153
                parent_trees.append(
2316
2154
                    (parent, self.branch.repository.revision_tree(parent)))
2317
 
            if not _mod_revision.is_null(old_tip):
 
2155
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2318
2156
                parent_trees.append(
2319
2157
                    (old_tip, self.branch.repository.revision_tree(old_tip)))
2320
2158
            self.set_parent_trees(parent_trees)
2321
2159
            last_rev = parent_trees[0][0]
2322
 
        return nb_conflicts
 
2160
        else:
 
2161
            # the working tree had the same last-revision as the master
 
2162
            # branch did. We may still have pivot local work from the local
 
2163
            # branch into old_tip:
 
2164
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
 
2165
                self.add_parent_tree_id(old_tip)
 
2166
        if (old_tip is not None and not _mod_revision.is_null(old_tip)
 
2167
            and old_tip != last_rev):
 
2168
            # our last revision was not the prior branch last revision
 
2169
            # and we have converted that last revision to a pending merge.
 
2170
            # base is somewhere between the branch tip now
 
2171
            # and the now pending merge
 
2172
 
 
2173
            # Since we just modified the working tree and inventory, flush out
 
2174
            # the current state, before we modify it again.
 
2175
            # TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
 
2176
            #       requires it only because TreeTransform directly munges the
 
2177
            #       inventory and calls tree._write_inventory(). Ultimately we
 
2178
            #       should be able to remove this extra flush.
 
2179
            self.flush()
 
2180
            graph = self.branch.repository.get_graph()
 
2181
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
 
2182
                                                old_tip)
 
2183
            base_tree = self.branch.repository.revision_tree(base_rev_id)
 
2184
            other_tree = self.branch.repository.revision_tree(old_tip)
 
2185
            result += merge.merge_inner(
 
2186
                                  self.branch,
 
2187
                                  other_tree,
 
2188
                                  base_tree,
 
2189
                                  this_tree=self,
 
2190
                                  change_reporter=change_reporter)
 
2191
        return result
2323
2192
 
2324
2193
    def _write_hashcache_if_dirty(self):
2325
2194
        """Write out the hashcache if it is dirty."""
2424
2293
                    # value.
2425
2294
                    bzrdir_loc = bisect_left(cur_disk_dir_content,
2426
2295
                        ('.bzr', '.bzr'))
2427
 
                    if (bzrdir_loc < len(cur_disk_dir_content)
2428
 
                        and self.bzrdir.is_control_filename(
2429
 
                            cur_disk_dir_content[bzrdir_loc][0])):
 
2296
                    if cur_disk_dir_content[bzrdir_loc][0] == '.bzr':
2430
2297
                        # we dont yield the contents of, or, .bzr itself.
2431
2298
                        del cur_disk_dir_content[bzrdir_loc]
2432
2299
            if inv_finished:
2522
2389
                relroot = ""
2523
2390
            # FIXME: stash the node in pending
2524
2391
            entry = inv[top_id]
2525
 
            if entry.kind == 'directory':
2526
 
                for name, child in entry.sorted_children():
2527
 
                    dirblock.append((relroot + name, name, child.kind, None,
2528
 
                        child.file_id, child.kind
2529
 
                        ))
 
2392
            for name, child in entry.sorted_children():
 
2393
                dirblock.append((relroot + name, name, child.kind, None,
 
2394
                    child.file_id, child.kind
 
2395
                    ))
2530
2396
            yield (currentdir[0], entry.file_id), dirblock
2531
2397
            # push the user specified dirs from dirblock
2532
2398
            for dir in reversed(dirblock):
2565
2431
        self.set_conflicts(un_resolved)
2566
2432
        return un_resolved, resolved
2567
2433
 
2568
 
    @needs_read_lock
2569
 
    def _check(self, references):
2570
 
        """Check the tree for consistency.
2571
 
 
2572
 
        :param references: A dict with keys matching the items returned by
2573
 
            self._get_check_refs(), and values from looking those keys up in
2574
 
            the repository.
2575
 
        """
2576
 
        tree_basis = self.basis_tree()
2577
 
        tree_basis.lock_read()
2578
 
        try:
2579
 
            repo_basis = references[('trees', self.last_revision())]
2580
 
            if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2581
 
                raise errors.BzrCheckError(
2582
 
                    "Mismatched basis inventory content.")
2583
 
            self._validate()
2584
 
        finally:
2585
 
            tree_basis.unlock()
2586
 
 
2587
2434
    def _validate(self):
2588
2435
        """Validate internal structures.
2589
2436
 
2595
2442
        """
2596
2443
        return
2597
2444
 
2598
 
    def _get_rules_searcher(self, default_searcher):
2599
 
        """See Tree._get_rules_searcher."""
2600
 
        if self._rules_searcher is None:
2601
 
            self._rules_searcher = super(WorkingTree,
2602
 
                self)._get_rules_searcher(default_searcher)
2603
 
        return self._rules_searcher
2604
 
 
2605
 
    def get_shelf_manager(self):
2606
 
        """Return the ShelfManager for this WorkingTree."""
2607
 
        from bzrlib.shelf import ShelfManager
2608
 
        return ShelfManager(self, self._transport)
2609
 
 
2610
2445
 
2611
2446
class WorkingTree2(WorkingTree):
2612
2447
    """This is the Format 2 working tree.
2613
2448
 
2614
 
    This was the first weave based working tree.
 
2449
    This was the first weave based working tree. 
2615
2450
     - uses os locks for locking.
2616
2451
     - uses the branch last-revision.
2617
2452
    """
2627
2462
        if self._inventory is None:
2628
2463
            self.read_working_inventory()
2629
2464
 
2630
 
    def _get_check_refs(self):
2631
 
        """Return the references needed to perform a check of this tree."""
2632
 
        return [('trees', self.last_revision())]
2633
 
 
2634
2465
    def lock_tree_write(self):
2635
2466
        """See WorkingTree.lock_tree_write().
2636
2467
 
2654
2485
            if self._inventory_is_modified:
2655
2486
                self.flush()
2656
2487
            self._write_hashcache_if_dirty()
2657
 
 
 
2488
                    
2658
2489
        # reverse order of locking.
2659
2490
        try:
2660
2491
            return self._control_files.unlock()
2676
2507
    def _last_revision(self):
2677
2508
        """See Mutable.last_revision."""
2678
2509
        try:
2679
 
            return self._transport.get_bytes('last-revision')
 
2510
            return self._control_files.get('last-revision').read()
2680
2511
        except errors.NoSuchFile:
2681
2512
            return _mod_revision.NULL_REVISION
2682
2513
 
2683
2514
    def _change_last_revision(self, revision_id):
2684
2515
        """See WorkingTree._change_last_revision."""
2685
 
        if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
 
2516
        if revision_id is None or revision_id == NULL_REVISION:
2686
2517
            try:
2687
 
                self._transport.delete('last-revision')
 
2518
                self._control_files._transport.delete('last-revision')
2688
2519
            except errors.NoSuchFile:
2689
2520
                pass
2690
2521
            return False
2691
2522
        else:
2692
 
            self._transport.put_bytes('last-revision', revision_id,
2693
 
                mode=self.bzrdir._get_file_mode())
 
2523
            self._control_files.put_bytes('last-revision', revision_id)
2694
2524
            return True
2695
2525
 
2696
 
    def _get_check_refs(self):
2697
 
        """Return the references needed to perform a check of this tree."""
2698
 
        return [('trees', self.last_revision())]
2699
 
 
2700
2526
    @needs_tree_write_lock
2701
2527
    def set_conflicts(self, conflicts):
2702
 
        self._put_rio('conflicts', conflicts.to_stanzas(),
 
2528
        self._put_rio('conflicts', conflicts.to_stanzas(), 
2703
2529
                      CONFLICT_HEADER_1)
2704
2530
 
2705
2531
    @needs_tree_write_lock
2712
2538
    @needs_read_lock
2713
2539
    def conflicts(self):
2714
2540
        try:
2715
 
            confile = self._transport.get('conflicts')
 
2541
            confile = self._control_files.get('conflicts')
2716
2542
        except errors.NoSuchFile:
2717
2543
            return _mod_conflicts.ConflictList()
2718
2544
        try:
2719
 
            try:
2720
 
                if confile.next() != CONFLICT_HEADER_1 + '\n':
2721
 
                    raise errors.ConflictFormatError()
2722
 
            except StopIteration:
 
2545
            if confile.next() != CONFLICT_HEADER_1 + '\n':
2723
2546
                raise errors.ConflictFormatError()
2724
 
            return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2725
 
        finally:
2726
 
            confile.close()
 
2547
        except StopIteration:
 
2548
            raise errors.ConflictFormatError()
 
2549
        return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2727
2550
 
2728
2551
    def unlock(self):
2729
2552
        # do non-implementation specific cleanup
2754
2577
     * a format string,
2755
2578
     * an open routine.
2756
2579
 
2757
 
    Formats are placed in an dict by their format string for reference
 
2580
    Formats are placed in an dict by their format string for reference 
2758
2581
    during workingtree opening. Its not required that these be instances, they
2759
 
    can be classes themselves with class methods - it simply depends on
 
2582
    can be classes themselves with class methods - it simply depends on 
2760
2583
    whether state is needed for a given format or not.
2761
2584
 
2762
2585
    Once a format is deprecated, just deprecate the initialize and open
2763
 
    methods on the format class. Do not deprecate the object, as the
 
2586
    methods on the format class. Do not deprecate the object, as the 
2764
2587
    object will be created every time regardless.
2765
2588
    """
2766
2589
 
2779
2602
        """Return the format for the working tree object in a_bzrdir."""
2780
2603
        try:
2781
2604
            transport = a_bzrdir.get_workingtree_transport(None)
2782
 
            format_string = transport.get_bytes("format")
 
2605
            format_string = transport.get("format").read()
2783
2606
            return klass._formats[format_string]
2784
2607
        except errors.NoSuchFile:
2785
2608
            raise errors.NoWorkingTree(base=transport.base)
2810
2633
        """Is this format supported?
2811
2634
 
2812
2635
        Supported formats can be initialized and opened.
2813
 
        Unsupported formats may not support initialization or committing or
 
2636
        Unsupported formats may not support initialization or committing or 
2814
2637
        some other features depending on the reason for not being supported.
2815
2638
        """
2816
2639
        return True
2817
2640
 
2818
 
    def supports_content_filtering(self):
2819
 
        """True if this format supports content filtering."""
2820
 
        return False
2821
 
 
2822
 
    def supports_views(self):
2823
 
        """True if this format supports stored views."""
2824
 
        return False
2825
 
 
2826
2641
    @classmethod
2827
2642
    def register_format(klass, format):
2828
2643
        klass._formats[format.get_format_string()] = format
2833
2648
 
2834
2649
    @classmethod
2835
2650
    def unregister_format(klass, format):
 
2651
        assert klass._formats[format.get_format_string()] is format
2836
2652
        del klass._formats[format.get_format_string()]
2837
2653
 
2838
2654
 
2839
2655
class WorkingTreeFormat2(WorkingTreeFormat):
2840
 
    """The second working tree format.
 
2656
    """The second working tree format. 
2841
2657
 
2842
2658
    This format modified the hash cache from the format 1 hash cache.
2843
2659
    """
2848
2664
        """See WorkingTreeFormat.get_format_description()."""
2849
2665
        return "Working tree format 2"
2850
2666
 
2851
 
    def _stub_initialize_on_transport(self, transport, file_mode):
2852
 
        """Workaround: create control files for a remote working tree.
2853
 
 
 
2667
    def stub_initialize_remote(self, control_files):
 
2668
        """As a special workaround create critical control files for a remote working tree
 
2669
        
2854
2670
        This ensures that it can later be updated and dealt with locally,
2855
 
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
 
2671
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with 
2856
2672
        no working tree.  (See bug #43064).
2857
2673
        """
2858
2674
        sio = StringIO()
2859
 
        inv = inventory.Inventory()
 
2675
        inv = Inventory()
2860
2676
        xml5.serializer_v5.write_inventory(inv, sio, working=True)
2861
2677
        sio.seek(0)
2862
 
        transport.put_file('inventory', sio, file_mode)
2863
 
        transport.put_bytes('pending-merges', '', file_mode)
 
2678
        control_files.put('inventory', sio)
 
2679
 
 
2680
        control_files.put_bytes('pending-merges', '')
 
2681
        
2864
2682
 
2865
2683
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2866
2684
                   accelerator_tree=None, hardlink=False):
2878
2696
            branch.generate_revision_history(revision_id)
2879
2697
        finally:
2880
2698
            branch.unlock()
2881
 
        inv = inventory.Inventory()
 
2699
        inv = Inventory()
2882
2700
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2883
2701
                         branch,
2884
2702
                         inv,
2929
2747
        - is new in bzr 0.8
2930
2748
        - uses a LockDir to guard access for writes.
2931
2749
    """
2932
 
 
 
2750
    
2933
2751
    upgrade_recommended = True
2934
2752
 
2935
2753
    def get_format_string(self):
2952
2770
 
2953
2771
    def _open_control_files(self, a_bzrdir):
2954
2772
        transport = a_bzrdir.get_workingtree_transport(None)
2955
 
        return LockableFiles(transport, self._lock_file_name,
 
2773
        return LockableFiles(transport, self._lock_file_name, 
2956
2774
                             self._lock_class)
2957
2775
 
2958
2776
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2959
2777
                   accelerator_tree=None, hardlink=False):
2960
2778
        """See WorkingTreeFormat.initialize().
2961
 
 
 
2779
        
2962
2780
        :param revision_id: if supplied, create a working tree at a different
2963
2781
            revision than the branch is at.
2964
2782
        :param accelerator_tree: A tree which can be used for retrieving file
2974
2792
        control_files = self._open_control_files(a_bzrdir)
2975
2793
        control_files.create_lock()
2976
2794
        control_files.lock_write()
2977
 
        transport.put_bytes('format', self.get_format_string(),
2978
 
            mode=a_bzrdir._get_file_mode())
 
2795
        control_files.put_utf8('format', self.get_format_string())
2979
2796
        if from_branch is not None:
2980
2797
            branch = from_branch
2981
2798
        else:
3001
2818
            # only set an explicit root id if there is one to set.
3002
2819
            if basis_tree.inventory.root is not None:
3003
2820
                wt.set_root_id(basis_tree.get_root_id())
3004
 
            if revision_id == _mod_revision.NULL_REVISION:
 
2821
            if revision_id == NULL_REVISION:
3005
2822
                wt.set_parent_trees([])
3006
2823
            else:
3007
2824
                wt.set_parent_trees([(revision_id, basis_tree)])
3014
2831
        return wt
3015
2832
 
3016
2833
    def _initial_inventory(self):
3017
 
        return inventory.Inventory()
 
2834
        return Inventory()
3018
2835
 
3019
2836
    def __init__(self):
3020
2837
        super(WorkingTreeFormat3, self).__init__()
3035
2852
 
3036
2853
    def _open(self, a_bzrdir, control_files):
3037
2854
        """Open the tree itself.
3038
 
 
 
2855
        
3039
2856
        :param a_bzrdir: the dir for the tree.
3040
2857
        :param control_files: the control files for the tree.
3041
2858
        """
3049
2866
        return self.get_format_string()
3050
2867
 
3051
2868
 
3052
 
__default_format = WorkingTreeFormat6()
 
2869
__default_format = WorkingTreeFormat4()
3053
2870
WorkingTreeFormat.register_format(__default_format)
3054
 
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3055
 
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3056
2871
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3057
2872
WorkingTreeFormat.set_default_format(__default_format)
3058
2873
# formats which have no format string are not discoverable