/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: 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.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,
199
201
        if not _internal:
200
202
            raise errors.BzrError("Please use bzrdir.open_workingtree or "
201
203
                "WorkingTree.open() to obtain a WorkingTree.")
 
204
        assert isinstance(basedir, basestring), \
 
205
            "base directory %r is not a string" % basedir
202
206
        basedir = safe_unicode(basedir)
203
207
        mutter("opening working tree %r", basedir)
204
208
        if deprecated_passed(branch):
212
216
            self._control_files = self.branch.control_files
213
217
        else:
214
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
215
222
            self._control_files = _control_files
216
 
        self._transport = self._control_files._transport
217
223
        # update the whole cache up front and write to disk if anything changed;
218
224
        # in the future we might want to do this more selectively
219
225
        # two possible ways offer themselves : in self._unlock, write the cache
223
229
        wt_trans = self.bzrdir.get_workingtree_transport(None)
224
230
        cache_filename = wt_trans.local_abspath('stat-cache')
225
231
        self._hashcache = hashcache.HashCache(basedir, cache_filename,
226
 
            self.bzrdir._get_file_mode(),
227
 
            self._content_filter_stack_provider())
 
232
                                              self._control_files._file_mode)
228
233
        hc = self._hashcache
229
234
        hc.read()
230
235
        # is this scan needed ? it makes things kinda slow.
245
250
            # permitted to do this.
246
251
            self._set_inventory(_inventory, dirty=False)
247
252
        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
253
 
259
254
    def _detect_case_handling(self):
260
255
        wt_trans = self.bzrdir.get_workingtree_transport(None)
286
281
        self._control_files.break_lock()
287
282
        self.branch.break_lock()
288
283
 
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
284
    def requires_rich_root(self):
300
285
        return self._format.requires_rich_root
301
286
 
302
287
    def supports_tree_reference(self):
303
288
        return False
304
289
 
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
290
    def _set_inventory(self, inv, dirty):
312
291
        """Set the internal cached inventory.
313
292
 
318
297
            False then the inventory is the same as that on disk and any
319
298
            serialisation would be unneeded overhead.
320
299
        """
 
300
        assert inv.root is not None
321
301
        self._inventory = inv
322
302
        self._inventory_is_modified = dirty
323
303
 
327
307
 
328
308
        """
329
309
        if path is None:
330
 
            path = osutils.getcwd()
 
310
            path = os.path.getcwdu()
331
311
        control = bzrdir.BzrDir.open(path, _unsupported)
332
312
        return control.open_workingtree(_unsupported)
333
 
 
 
313
        
334
314
    @staticmethod
335
315
    def open_containing(path=None):
336
316
        """Open an existing working tree which has its root about path.
337
 
 
 
317
        
338
318
        This probes for a working tree at path and searches upwards from there.
339
319
 
340
320
        Basically we keep looking up until we find the control directory or
401
381
 
402
382
    def basis_tree(self):
403
383
        """Return RevisionTree for the current last revision.
404
 
 
 
384
        
405
385
        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).
 
386
        empty tree - one obtained by calling repository.revision_tree(None).
408
387
        """
409
388
        try:
410
389
            revision_id = self.get_parent_ids()[0]
412
391
            # no parents, return an empty revision tree.
413
392
            # in the future this should return the tree for
414
393
            # 'empty:' - the implicit root empty tree.
415
 
            return self.branch.repository.revision_tree(
416
 
                       _mod_revision.NULL_REVISION)
 
394
            return self.branch.repository.revision_tree(None)
417
395
        try:
418
396
            return self.revision_tree(revision_id)
419
397
        except errors.NoSuchRevision:
423
401
        # at this point ?
424
402
        try:
425
403
            return self.branch.repository.revision_tree(revision_id)
426
 
        except (errors.RevisionNotPresent, errors.NoSuchRevision):
 
404
        except errors.RevisionNotPresent:
427
405
            # 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
 
406
            # occured. If the revision is present, its a problem, if its not
429
407
            # its a ghost.
430
408
            if self.branch.repository.has_revision(revision_id):
431
409
                raise
432
410
            # the basis tree is a ghost so return an empty tree.
433
 
            return self.branch.repository.revision_tree(
434
 
                       _mod_revision.NULL_REVISION)
 
411
            return self.branch.repository.revision_tree(None)
435
412
 
436
413
    def _cleanup(self):
437
414
        self._flush_ignore_list_cache()
438
415
 
439
416
    def relpath(self, path):
440
417
        """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
 
418
        
 
419
        The path may be absolute or relative. If its a relative path it is 
443
420
        interpreted relative to the python current working directory.
444
421
        """
445
422
        return osutils.relpath(self.basedir, path)
447
424
    def has_filename(self, filename):
448
425
        return osutils.lexists(self.abspath(filename))
449
426
 
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."""
 
427
    def get_file(self, file_id, path=None):
456
428
        if path is None:
457
429
            path = self.id2path(file_id)
458
 
        file_obj = self.get_file_byname(path, filtered=False)
459
 
        stat_value = _fstat(file_obj.fileno())
460
 
        if filtered and self.supports_content_filtering():
461
 
            filters = self._content_filter_stack(path)
462
 
            file_obj = filtered_input_file(file_obj, filters)
463
 
        return (file_obj, stat_value)
464
 
 
465
 
    def get_file_text(self, file_id, path=None, filtered=True):
466
 
        return self.get_file(file_id, path=path, filtered=filtered).read()
467
 
 
468
 
    def get_file_byname(self, filename, filtered=True):
469
 
        path = self.abspath(filename)
470
 
        f = file(path, 'rb')
471
 
        if filtered and self.supports_content_filtering():
472
 
            filters = self._content_filter_stack(filename)
473
 
            return filtered_input_file(f, filters)
474
 
        else:
475
 
            return f
476
 
 
477
 
    def get_file_lines(self, file_id, path=None, filtered=True):
478
 
        """See Tree.get_file_lines()"""
479
 
        file = self.get_file(file_id, path, filtered=filtered)
480
 
        try:
481
 
            return file.readlines()
482
 
        finally:
483
 
            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')
484
437
 
485
438
    @needs_read_lock
486
439
    def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
493
446
        incorrectly attributed to CURRENT_REVISION (but after committing, the
494
447
        attribution will be correct).
495
448
        """
496
 
        maybe_file_parent_keys = []
497
 
        for parent_id in self.get_parent_ids():
498
 
            try:
499
 
                parent_tree = self.revision_tree(parent_id)
500
 
            except errors.NoSuchRevisionInTree:
501
 
                parent_tree = self.branch.repository.revision_tree(parent_id)
502
 
            parent_tree.lock_read()
503
 
            try:
504
 
                if file_id not in parent_tree:
505
 
                    continue
506
 
                ie = parent_tree.inventory[file_id]
507
 
                if ie.kind != 'file':
508
 
                    # Note: this is slightly unnecessary, because symlinks and
509
 
                    # directories have a "text" which is the empty text, and we
510
 
                    # know that won't mess up annotations. But it seems cleaner
511
 
                    continue
512
 
                parent_text_key = (file_id, ie.revision)
513
 
                if parent_text_key not in maybe_file_parent_keys:
514
 
                    maybe_file_parent_keys.append(parent_text_key)
515
 
            finally:
516
 
                parent_tree.unlock()
517
 
        graph = _mod_graph.Graph(self.branch.repository.texts)
518
 
        heads = graph.heads(maybe_file_parent_keys)
519
 
        file_parent_keys = []
520
 
        for key in maybe_file_parent_keys:
521
 
            if key in heads:
522
 
                file_parent_keys.append(key)
523
 
 
524
 
        # Now we have the parents of this content
525
 
        annotator = self.branch.repository.texts.get_annotator()
526
 
        text = self.get_file(file_id).read()
527
 
        this_key =(file_id, default_revision)
528
 
        annotator.add_special_text(this_key, file_parent_keys, text)
529
 
        annotations = [(key[-1], line)
530
 
                       for key, line in annotator.annotate_flat(this_key)]
531
 
        return annotations
 
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()
532
474
 
533
475
    def _get_ancestors(self, default_revision):
534
476
        ancestors = set([default_revision])
539
481
 
540
482
    def get_parent_ids(self):
541
483
        """See Tree.get_parent_ids.
542
 
 
 
484
        
543
485
        This implementation reads the pending merges list and last_revision
544
486
        value and uses that to decide what the parents list should be.
545
487
        """
549
491
        else:
550
492
            parents = [last_rev]
551
493
        try:
552
 
            merges_bytes = self._transport.get_bytes('pending-merges')
 
494
            merges_file = self._control_files.get('pending-merges')
553
495
        except errors.NoSuchFile:
554
496
            pass
555
497
        else:
556
 
            for l in osutils.split_lines(merges_bytes):
 
498
            for l in merges_file.readlines():
557
499
                revision_id = l.rstrip('\n')
558
500
                parents.append(revision_id)
559
501
        return parents
562
504
    def get_root_id(self):
563
505
        """Return the id of this trees root"""
564
506
        return self._inventory.root.file_id
565
 
 
 
507
        
566
508
    def _get_store_filename(self, file_id):
567
509
        ## XXX: badly named; this is not in the store at all
568
510
        return self.abspath(self.id2path(file_id))
570
512
    @needs_read_lock
571
513
    def clone(self, to_bzrdir, revision_id=None):
572
514
        """Duplicate this working tree into to_bzr, including all state.
573
 
 
 
515
        
574
516
        Specifically modified files are kept as modified, but
575
517
        ignored and unknown files are discarded.
576
518
 
577
519
        If you want to make a new line of development, see bzrdir.sprout()
578
520
 
579
521
        revision
580
 
            If not None, the cloned tree will have its last revision set to
581
 
            revision, and difference between the source trees last revision
 
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
582
524
            and this one merged in.
583
525
        """
584
526
        # assumes the target bzr dir format is compatible.
585
 
        result = to_bzrdir.create_workingtree()
 
527
        result = self._format.initialize(to_bzrdir)
586
528
        self.copy_content_into(result, revision_id)
587
529
        return result
588
530
 
618
560
 
619
561
    def get_file_size(self, file_id):
620
562
        """See Tree.get_file_size"""
621
 
        # XXX: this returns the on-disk size; it should probably return the
622
 
        # canonical size
623
563
        try:
624
564
            return os.path.getsize(self.id2abspath(file_id))
625
565
        except OSError, e:
641
581
 
642
582
    def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
643
583
        file_id = self.path2id(path)
644
 
        if file_id is None:
645
 
            # For unversioned files on win32, we just assume they are not
646
 
            # executable
647
 
            return False
648
584
        return self._inventory[file_id].executable
649
585
 
650
586
    def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
672
608
        """See MutableTree._add."""
673
609
        # TODO: Re-adding a file that is removed in the working copy
674
610
        # should probably put it back with the previous ID.
675
 
        # the read and write working inventory should not occur in this
 
611
        # the read and write working inventory should not occur in this 
676
612
        # function - they should be part of lock_write and unlock.
677
613
        inv = self.inventory
678
614
        for f, file_id, kind in zip(files, ids, kinds):
 
615
            assert kind is not None
679
616
            if file_id is None:
680
617
                inv.add_path(f, kind=kind)
681
618
            else:
760
697
            raise
761
698
        kind = _mapper(stat_result.st_mode)
762
699
        if kind == 'file':
763
 
            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))
764
705
        elif kind == 'directory':
765
706
            # perhaps it looks like a plain directory, but it's really a
766
707
            # reference.
768
709
                kind = 'tree-reference'
769
710
            return kind, None, None, None
770
711
        elif kind == 'symlink':
771
 
            target = osutils.readlink(abspath)
772
 
            return ('symlink', None, None, target)
 
712
            return ('symlink', None, None, os.readlink(abspath))
773
713
        else:
774
714
            return (kind, None, None, None)
775
715
 
776
 
    def _file_content_summary(self, path, stat_result):
777
 
        size = stat_result.st_size
778
 
        executable = self._is_executable_from_path_and_stat(path, stat_result)
779
 
        # try for a stat cache lookup
780
 
        return ('file', size, executable, self._sha_from_stat(
781
 
            path, stat_result))
782
 
 
783
716
    def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
784
717
        """Common ghost checking functionality from set_parent_*.
785
718
 
794
727
 
795
728
    def _set_merges_from_parent_ids(self, parent_ids):
796
729
        merges = parent_ids[1:]
797
 
        self._transport.put_bytes('pending-merges', '\n'.join(merges),
798
 
            mode=self.bzrdir._get_file_mode())
799
 
 
800
 
    def _filter_parent_ids_by_ancestry(self, revision_ids):
801
 
        """Check that all merged revisions are proper 'heads'.
802
 
 
803
 
        This will always return the first revision_id, and any merged revisions
804
 
        which are
805
 
        """
806
 
        if len(revision_ids) == 0:
807
 
            return revision_ids
808
 
        graph = self.branch.repository.get_graph()
809
 
        heads = graph.heads(revision_ids)
810
 
        new_revision_ids = revision_ids[:1]
811
 
        for revision_id in revision_ids[1:]:
812
 
            if revision_id in heads and revision_id not in new_revision_ids:
813
 
                new_revision_ids.append(revision_id)
814
 
        if new_revision_ids != revision_ids:
815
 
            trace.mutter('requested to set revision_ids = %s,'
816
 
                         ' but filtered to %s', revision_ids, new_revision_ids)
817
 
        return new_revision_ids
 
730
        self._control_files.put_bytes('pending-merges', '\n'.join(merges))
818
731
 
819
732
    @needs_tree_write_lock
820
733
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
821
734
        """Set the parent ids to revision_ids.
822
 
 
 
735
        
823
736
        See also set_parent_trees. This api will try to retrieve the tree data
824
737
        for each element of revision_ids from the trees repository. If you have
825
738
        tree data already available, it is more efficient to use
834
747
        for revision_id in revision_ids:
835
748
            _mod_revision.check_not_reserved_id(revision_id)
836
749
 
837
 
        revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
838
 
 
839
750
        if len(revision_ids) > 0:
840
751
            self.set_last_revision(revision_ids[0])
841
752
        else:
853
764
        self._check_parents_for_ghosts(parent_ids,
854
765
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
855
766
 
856
 
        parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
857
 
 
858
767
        if len(parent_ids) == 0:
859
768
            leftmost_parent_id = _mod_revision.NULL_REVISION
860
769
            leftmost_parent_tree = None
900
809
    def _put_rio(self, filename, stanzas, header):
901
810
        self._must_be_locked()
902
811
        my_file = rio_file(stanzas, header)
903
 
        self._transport.put_file(filename, my_file,
904
 
            mode=self.bzrdir._get_file_mode())
 
812
        self._control_files.put(filename, my_file)
905
813
 
906
814
    @needs_write_lock # because merge pulls data into the branch.
907
815
    def merge_from_branch(self, branch, to_revision=None, from_revision=None,
908
 
                          merge_type=None, force=False):
 
816
        merge_type=None):
909
817
        """Merge from a branch into this working tree.
910
818
 
911
819
        :param branch: The branch to merge from.
915
823
            branch.last_revision().
916
824
        """
917
825
        from bzrlib.merge import Merger, Merge3Merger
918
 
        merger = Merger(self.branch, this_tree=self)
919
 
        # check that there are no local alterations
920
 
        if not force and self.has_changes():
921
 
            raise errors.UncommittedChanges(self)
922
 
        if to_revision is None:
923
 
            to_revision = _mod_revision.ensure_null(branch.last_revision())
924
 
        merger.other_rev_id = to_revision
925
 
        if _mod_revision.is_null(merger.other_rev_id):
926
 
            raise errors.NoCommits(branch)
927
 
        self.branch.fetch(branch, last_revision=merger.other_rev_id)
928
 
        merger.other_basis = merger.other_rev_id
929
 
        merger.other_tree = self.branch.repository.revision_tree(
930
 
            merger.other_rev_id)
931
 
        merger.other_branch = branch
932
 
        if from_revision is None:
933
 
            merger.find_base()
934
 
        else:
935
 
            merger.set_base_revision(from_revision, branch)
936
 
        if merger.base_rev_id == merger.other_rev_id:
937
 
            raise errors.PointlessMerge
938
 
        merger.backup_files = False
939
 
        if merge_type is None:
940
 
            merger.merge_type = Merge3Merger
941
 
        else:
942
 
            merger.merge_type = merge_type
943
 
        merger.set_interesting_files(None)
944
 
        merger.show_base = False
945
 
        merger.reprocess = False
946
 
        conflicts = merger.do_merge()
947
 
        merger.set_pending()
 
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()
948
863
        return conflicts
949
864
 
950
865
    @needs_read_lock
951
866
    def merge_modified(self):
952
867
        """Return a dictionary of files modified by a merge.
953
868
 
954
 
        The list is initialized by WorkingTree.set_merge_modified, which is
 
869
        The list is initialized by WorkingTree.set_merge_modified, which is 
955
870
        typically called after we make some automatic updates to the tree
956
871
        because of a merge.
957
872
 
959
874
        still in the working inventory and have that text hash.
960
875
        """
961
876
        try:
962
 
            hashfile = self._transport.get('merge-hashes')
 
877
            hashfile = self._control_files.get('merge-hashes')
963
878
        except errors.NoSuchFile:
964
879
            return {}
 
880
        merge_hashes = {}
965
881
        try:
966
 
            merge_hashes = {}
967
 
            try:
968
 
                if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
969
 
                    raise errors.MergeModifiedFormatError()
970
 
            except StopIteration:
 
882
            if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
971
883
                raise errors.MergeModifiedFormatError()
972
 
            for s in RioReader(hashfile):
973
 
                # RioReader reads in Unicode, so convert file_ids back to utf8
974
 
                file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
975
 
                if file_id not in self.inventory:
976
 
                    continue
977
 
                text_hash = s.get("hash")
978
 
                if text_hash == self.get_file_sha1(file_id):
979
 
                    merge_hashes[file_id] = text_hash
980
 
            return merge_hashes
981
 
        finally:
982
 
            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
983
895
 
984
896
    @needs_write_lock
985
897
    def mkdir(self, path, file_id=None):
991
903
        return file_id
992
904
 
993
905
    def get_symlink_target(self, file_id):
994
 
        abspath = self.id2abspath(file_id)
995
 
        target = osutils.readlink(abspath)
996
 
        return target
 
906
        return os.readlink(self.id2abspath(file_id))
997
907
 
998
908
    @needs_write_lock
999
909
    def subsume(self, other_tree):
1049
959
        return False
1050
960
 
1051
961
    def _directory_may_be_tree_reference(self, relpath):
1052
 
        # as a special case, if a directory contains control files then
 
962
        # as a special case, if a directory contains control files then 
1053
963
        # it's a tree reference, except that the root of the tree is not
1054
964
        return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1055
965
        # TODO: We could ask all the control formats whether they
1066
976
    @needs_tree_write_lock
1067
977
    def extract(self, file_id, format=None):
1068
978
        """Extract a subtree from this tree.
1069
 
 
 
979
        
1070
980
        A new branch will be created, relative to the path for this tree.
1071
981
        """
1072
982
        self.flush()
1077
987
                transport = transport.clone(name)
1078
988
                transport.ensure_base()
1079
989
            return transport
1080
 
 
 
990
            
1081
991
        sub_path = self.id2path(file_id)
1082
992
        branch_transport = mkdirs(sub_path)
1083
993
        if format is None:
1097
1007
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
1098
1008
        if tree_transport.base != branch_transport.base:
1099
1009
            tree_bzrdir = format.initialize_on_transport(tree_transport)
1100
 
            branch.BranchReferenceFormat().initialize(tree_bzrdir,
1101
 
                target_branch=new_branch)
 
1010
            branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1102
1011
        else:
1103
1012
            tree_bzrdir = branch_bzrdir
1104
 
        wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
 
1013
        wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1105
1014
        wt.set_parent_ids(self.get_parent_ids())
1106
1015
        my_inv = self.inventory
1107
 
        child_inv = inventory.Inventory(root_id=None)
 
1016
        child_inv = Inventory(root_id=None)
1108
1017
        new_root = my_inv[file_id]
1109
1018
        my_inv.remove_recursive_id(file_id)
1110
1019
        new_root.parent_id = None
1128
1037
        sio = StringIO()
1129
1038
        self._serialize(self._inventory, sio)
1130
1039
        sio.seek(0)
1131
 
        self._transport.put_file('inventory', sio,
1132
 
            mode=self.bzrdir._get_file_mode())
 
1040
        self._control_files.put('inventory', sio)
1133
1041
        self._inventory_is_modified = False
1134
1042
 
1135
1043
    def _kind(self, relpath):
1136
1044
        return osutils.file_kind(self.abspath(relpath))
1137
1045
 
1138
 
    def list_files(self, include_root=False, from_dir=None, recursive=True):
1139
 
        """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).
1140
1048
 
1141
1049
        Lists, but does not descend into unversioned directories.
 
1050
 
1142
1051
        This does not include files that have been deleted in this
1143
 
        tree. Skips the control directory.
 
1052
        tree.
1144
1053
 
1145
 
        :param include_root: if True, return an entry for the root
1146
 
        :param from_dir: start from this directory or None for the root
1147
 
        :param recursive: whether to recurse into subdirectories or not
 
1054
        Skips the control directory.
1148
1055
        """
1149
1056
        # list_files is an iterator, so @needs_read_lock doesn't work properly
1150
1057
        # with it. So callers should be careful to always read_lock the tree.
1152
1059
            raise errors.ObjectNotLocked(self)
1153
1060
 
1154
1061
        inv = self.inventory
1155
 
        if from_dir is None and include_root is True:
 
1062
        if include_root is True:
1156
1063
            yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1157
1064
        # Convert these into local objects to save lookup times
1158
1065
        pathjoin = osutils.pathjoin
1165
1072
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1166
1073
 
1167
1074
        # directory file_id, relative path, absolute path, reverse sorted children
1168
 
        if from_dir is not None:
1169
 
            from_dir_id = inv.path2id(from_dir)
1170
 
            if from_dir_id is None:
1171
 
                # Directory not versioned
1172
 
                return
1173
 
            from_dir_abspath = pathjoin(self.basedir, from_dir)
1174
 
        else:
1175
 
            from_dir_id = inv.root.file_id
1176
 
            from_dir_abspath = self.basedir
1177
 
        children = os.listdir(from_dir_abspath)
 
1075
        children = os.listdir(self.basedir)
1178
1076
        children.sort()
1179
 
        # jam 20060527 The kernel sized tree seems equivalent whether we
 
1077
        # jam 20060527 The kernel sized tree seems equivalent whether we 
1180
1078
        # use a deque and popleft to keep them sorted, or if we use a plain
1181
1079
        # list and just reverse() them.
1182
1080
        children = collections.deque(children)
1183
 
        stack = [(from_dir_id, u'', from_dir_abspath, children)]
 
1081
        stack = [(inv.root.file_id, u'', self.basedir, children)]
1184
1082
        while stack:
1185
1083
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1186
1084
 
1202
1100
 
1203
1101
                # absolute path
1204
1102
                fap = from_dir_abspath + '/' + f
1205
 
 
 
1103
                
1206
1104
                f_ie = inv.get_child(from_dir_id, f)
1207
1105
                if f_ie:
1208
1106
                    c = 'V'
1240
1138
                    except KeyError:
1241
1139
                        yield fp[1:], c, fk, None, TreeEntry()
1242
1140
                    continue
1243
 
 
 
1141
                
1244
1142
                if fk != 'directory':
1245
1143
                    continue
1246
1144
 
1247
 
                # But do this child first if recursing down
1248
 
                if recursive:
1249
 
                    new_children = os.listdir(fap)
1250
 
                    new_children.sort()
1251
 
                    new_children = collections.deque(new_children)
1252
 
                    stack.append((f_ie.file_id, fp, fap, new_children))
1253
 
                    # Break out of inner loop,
1254
 
                    # so that we start outer loop with child
1255
 
                    break
 
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
1256
1153
            else:
1257
1154
                # if we finished all children, pop it off the stack
1258
1155
                stack.pop()
1264
1161
        to_dir must exist in the inventory.
1265
1162
 
1266
1163
        If to_dir exists and is a directory, the files are moved into
1267
 
        it, keeping their old names.
 
1164
        it, keeping their old names.  
1268
1165
 
1269
1166
        Note that to_dir is only the last component of the new name;
1270
1167
        this doesn't change the directory.
1307
1204
                                       DeprecationWarning)
1308
1205
 
1309
1206
        # check destination directory
1310
 
        if isinstance(from_paths, basestring):
1311
 
            raise ValueError()
 
1207
        assert not isinstance(from_paths, basestring)
1312
1208
        inv = self.inventory
1313
1209
        to_abs = self.abspath(to_dir)
1314
1210
        if not isdir(to_abs):
1398
1294
                only_change_inv = True
1399
1295
            elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1400
1296
                only_change_inv = False
1401
 
            elif (not self.case_sensitive
1402
 
                  and from_rel.lower() == to_rel.lower()
1403
 
                  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)):
1404
1300
                only_change_inv = False
1405
1301
            else:
1406
1302
                # something is wrong, so lets determine what exactly
1436
1332
        inv = self.inventory
1437
1333
        for entry in moved:
1438
1334
            try:
1439
 
                self._move_entry(WorkingTree._RenameEntry(
1440
 
                    entry.to_rel, entry.from_id,
 
1335
                self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1441
1336
                    entry.to_tail, entry.to_parent_id, entry.from_rel,
1442
1337
                    entry.from_tail, entry.from_parent_id,
1443
1338
                    entry.only_change_inv))
1494
1389
        from_tail = splitpath(from_rel)[-1]
1495
1390
        from_id = inv.path2id(from_rel)
1496
1391
        if from_id is None:
1497
 
            # if file is missing in the inventory maybe it's in the basis_tree
1498
 
            basis_tree = self.branch.basis_tree()
1499
 
            from_id = basis_tree.path2id(from_rel)
1500
 
            if from_id is None:
1501
 
                raise errors.BzrRenameFailedError(from_rel,to_rel,
1502
 
                    errors.NotVersionedError(path=str(from_rel)))
1503
 
            # put entry back in the inventory so we can rename it
1504
 
            from_entry = basis_tree.inventory[from_id].copy()
1505
 
            inv.add(from_entry)
1506
 
        else:
1507
 
            from_entry = inv[from_id]
 
1392
            raise errors.BzrRenameFailedError(from_rel,to_rel,
 
1393
                errors.NotVersionedError(path=str(from_rel)))
 
1394
        from_entry = inv[from_id]
1508
1395
        from_parent_id = from_entry.parent_id
1509
1396
        to_dir, to_tail = os.path.split(to_rel)
1510
1397
        to_dir_id = inv.path2id(to_dir)
1556
1443
        These are files in the working directory that are not versioned or
1557
1444
        control files or ignored.
1558
1445
        """
1559
 
        # force the extras method to be fully executed before returning, to
 
1446
        # force the extras method to be fully executed before returning, to 
1560
1447
        # prevent race conditions with the lock
1561
1448
        return iter(
1562
1449
            [subp for subp in self.extras() if not self.is_ignored(subp)])
1572
1459
        :raises: NoSuchId if any fileid is not currently versioned.
1573
1460
        """
1574
1461
        for file_id in file_ids:
1575
 
            if file_id not in self._inventory:
1576
 
                raise errors.NoSuchId(self, file_id)
1577
 
        for file_id in file_ids:
1578
1462
            if self._inventory.has_id(file_id):
1579
1463
                self._inventory.remove_recursive_id(file_id)
 
1464
            else:
 
1465
                raise errors.NoSuchId(self, file_id)
1580
1466
        if len(file_ids):
1581
 
            # 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 
1582
1468
            # final unlock. However, until all methods of workingtree start
1583
 
            # with the current in -memory inventory rather than triggering
 
1469
            # with the current in -memory inventory rather than triggering 
1584
1470
            # a read, it is more complex - we need to teach read_inventory
1585
1471
            # to know when to read, and when to not read first... and possibly
1586
1472
            # to save first when the in memory one may be corrupted.
1587
1473
            # so for now, we just only write it if it is indeed dirty.
1588
1474
            # - RBC 20060907
1589
1475
            self._write_inventory(self._inventory)
1590
 
 
 
1476
    
1591
1477
    def _iter_conflicts(self):
1592
1478
        conflicted = set()
1593
1479
        for info in self.list_files():
1601
1487
 
1602
1488
    @needs_write_lock
1603
1489
    def pull(self, source, overwrite=False, stop_revision=None,
1604
 
             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()
1605
1492
        source.lock_read()
1606
1493
        try:
 
1494
            pp = ProgressPhase("Pull phase", 2, top_pb)
 
1495
            pp.next_phase()
1607
1496
            old_revision_info = self.branch.last_revision_info()
1608
1497
            basis_tree = self.basis_tree()
1609
1498
            count = self.branch.pull(source, overwrite, stop_revision,
1610
 
                                     possible_transports=possible_transports,
1611
 
                                     local=local)
 
1499
                                     possible_transports=possible_transports)
1612
1500
            new_revision_info = self.branch.last_revision_info()
1613
1501
            if new_revision_info != old_revision_info:
 
1502
                pp.next_phase()
1614
1503
                repository = self.branch.repository
 
1504
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
1615
1505
                basis_tree.lock_read()
1616
1506
                try:
1617
1507
                    new_basis_tree = self.branch.basis_tree()
1620
1510
                                new_basis_tree,
1621
1511
                                basis_tree,
1622
1512
                                this_tree=self,
1623
 
                                pb=None,
 
1513
                                pb=pb,
1624
1514
                                change_reporter=change_reporter)
1625
 
                    basis_root_id = basis_tree.get_root_id()
1626
 
                    new_root_id = new_basis_tree.get_root_id()
1627
 
                    if basis_root_id != new_root_id:
1628
 
                        self.set_root_id(new_root_id)
 
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())
1629
1518
                finally:
 
1519
                    pb.finished()
1630
1520
                    basis_tree.unlock()
1631
1521
                # TODO - dedup parents list with things merged by pull ?
1632
1522
                # reuse the revisiontree we merged against to set the new
1633
1523
                # tree data.
1634
1524
                parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1635
 
                # we have to pull the merge trees out again, because
1636
 
                # merge_inner has set the ids. - this corner is not yet
 
1525
                # we have to pull the merge trees out again, because 
 
1526
                # merge_inner has set the ids. - this corner is not yet 
1637
1527
                # layered well enough to prevent double handling.
1638
1528
                # XXX TODO: Fix the double handling: telling the tree about
1639
1529
                # the already known parent data is wasteful.
1645
1535
            return count
1646
1536
        finally:
1647
1537
            source.unlock()
 
1538
            top_pb.finished()
1648
1539
 
1649
1540
    @needs_write_lock
1650
1541
    def put_file_bytes_non_atomic(self, file_id, bytes):
1676
1567
 
1677
1568
            fl = []
1678
1569
            for subf in os.listdir(dirabs):
1679
 
                if self.bzrdir.is_control_filename(subf):
 
1570
                if subf == '.bzr':
1680
1571
                    continue
1681
1572
                if subf not in dir_entry.children:
1682
 
                    try:
1683
 
                        (subf_norm,
1684
 
                         can_access) = osutils.normalized_filename(subf)
1685
 
                    except UnicodeDecodeError:
1686
 
                        path_os_enc = path.encode(osutils._fs_enc)
1687
 
                        relpath = path_os_enc + '/' + subf
1688
 
                        raise errors.BadFilenameEncoding(relpath,
1689
 
                                                         osutils._fs_enc)
 
1573
                    subf_norm, can_access = osutils.normalized_filename(subf)
1690
1574
                    if subf_norm != subf and can_access:
1691
1575
                        if subf_norm not in dir_entry.children:
1692
1576
                            fl.append(subf_norm)
1693
1577
                    else:
1694
1578
                        fl.append(subf)
1695
 
 
 
1579
            
1696
1580
            fl.sort()
1697
1581
            for subf in fl:
1698
1582
                subp = pathjoin(path, subf)
1735
1619
        r"""Check whether the filename matches an ignore pattern.
1736
1620
 
1737
1621
        Patterns containing '/' or '\' need to match the whole path;
1738
 
        others match against only the last component.  Patterns starting
1739
 
        with '!' are ignore exceptions.  Exceptions take precedence
1740
 
        over regular patterns and cause the filename to not be ignored.
 
1622
        others match against only the last component.
1741
1623
 
1742
1624
        If the file is ignored, returns the pattern which caused it to
1743
1625
        be ignored, otherwise None.  So this can simply be used as a
1744
1626
        boolean if desired."""
1745
1627
        if getattr(self, '_ignoreglobster', None) is None:
1746
 
            self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
 
1628
            self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1747
1629
        return self._ignoreglobster.match(filename)
1748
1630
 
1749
1631
    def kind(self, file_id):
1799
1681
            raise errors.ObjectNotLocked(self)
1800
1682
 
1801
1683
    def lock_read(self):
1802
 
        """Lock the tree for reading.
1803
 
 
1804
 
        This also locks the branch, and can be unlocked via self.unlock().
1805
 
 
1806
 
        :return: A bzrlib.lock.LogicalLockResult.
1807
 
        """
 
1684
        """See Branch.lock_read, and WorkingTree.unlock."""
1808
1685
        if not self.is_locked():
1809
1686
            self._reset_data()
1810
1687
        self.branch.lock_read()
1811
1688
        try:
1812
 
            self._control_files.lock_read()
1813
 
            return LogicalLockResult(self.unlock)
 
1689
            return self._control_files.lock_read()
1814
1690
        except:
1815
1691
            self.branch.unlock()
1816
1692
            raise
1817
1693
 
1818
1694
    def lock_tree_write(self):
1819
 
        """See MutableTree.lock_tree_write, and WorkingTree.unlock.
1820
 
 
1821
 
        :return: A bzrlib.lock.LogicalLockResult.
1822
 
        """
 
1695
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1823
1696
        if not self.is_locked():
1824
1697
            self._reset_data()
1825
1698
        self.branch.lock_read()
1826
1699
        try:
1827
 
            self._control_files.lock_write()
1828
 
            return LogicalLockResult(self.unlock)
 
1700
            return self._control_files.lock_write()
1829
1701
        except:
1830
1702
            self.branch.unlock()
1831
1703
            raise
1832
1704
 
1833
1705
    def lock_write(self):
1834
 
        """See MutableTree.lock_write, and WorkingTree.unlock.
1835
 
 
1836
 
        :return: A bzrlib.lock.LogicalLockResult.
1837
 
        """
 
1706
        """See MutableTree.lock_write, and WorkingTree.unlock."""
1838
1707
        if not self.is_locked():
1839
1708
            self._reset_data()
1840
1709
        self.branch.lock_write()
1841
1710
        try:
1842
 
            self._control_files.lock_write()
1843
 
            return LogicalLockResult(self.unlock)
 
1711
            return self._control_files.lock_write()
1844
1712
        except:
1845
1713
            self.branch.unlock()
1846
1714
            raise
1854
1722
    def _reset_data(self):
1855
1723
        """Reset transient data that cannot be revalidated."""
1856
1724
        self._inventory_is_modified = False
1857
 
        f = self._transport.get('inventory')
1858
 
        try:
1859
 
            result = self._deserialize(f)
1860
 
        finally:
1861
 
            f.close()
 
1725
        result = self._deserialize(self._control_files.get('inventory'))
1862
1726
        self._set_inventory(result, dirty=False)
1863
1727
 
1864
1728
    @needs_tree_write_lock
1869
1733
 
1870
1734
    def _change_last_revision(self, new_revision):
1871
1735
        """Template method part of set_last_revision to perform the change.
1872
 
 
 
1736
        
1873
1737
        This is used to allow WorkingTree3 instances to not affect branch
1874
1738
        when their last revision is set.
1875
1739
        """
1885
1749
 
1886
1750
    def _write_basis_inventory(self, xml):
1887
1751
        """Write the basis inventory XML to the basis-inventory file"""
 
1752
        assert isinstance(xml, str), 'serialised xml must be bytestring.'
1888
1753
        path = self._basis_inventory_name()
1889
1754
        sio = StringIO(xml)
1890
 
        self._transport.put_file(path, sio,
1891
 
            mode=self.bzrdir._get_file_mode())
 
1755
        self._control_files.put(path, sio)
1892
1756
 
1893
1757
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
1894
1758
        """Create the text that will be saved in basis-inventory"""
1901
1765
        # as commit already has that ready-to-use [while the format is the
1902
1766
        # same, that is].
1903
1767
        try:
1904
 
            # this double handles the inventory - unpack and repack -
 
1768
            # this double handles the inventory - unpack and repack - 
1905
1769
            # but is easier to understand. We can/should put a conditional
1906
1770
            # in here based on whether the inventory is in the latest format
1907
1771
            # - perhaps we should repack all inventories on a repository
1908
1772
            # upgrade ?
1909
1773
            # the fast path is to copy the raw xml from the repository. If the
1910
 
            # xml contains 'revision_id="', then we assume the right
 
1774
            # xml contains 'revision_id="', then we assume the right 
1911
1775
            # revision_id is set. We must check for this full string, because a
1912
1776
            # root node id can legitimately look like 'revision_id' but cannot
1913
1777
            # contain a '"'.
1914
 
            xml = self.branch.repository._get_inventory_xml(new_revision)
 
1778
            xml = self.branch.repository.get_inventory_xml(new_revision)
1915
1779
            firstline = xml.split('\n', 1)[0]
1916
 
            if (not 'revision_id="' in firstline or
 
1780
            if (not 'revision_id="' in firstline or 
1917
1781
                'format="7"' not in firstline):
1918
 
                inv = self.branch.repository._serializer.read_inventory_from_string(
1919
 
                    xml, new_revision)
 
1782
                inv = self.branch.repository.deserialise_inventory(
 
1783
                    new_revision, xml)
1920
1784
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
1921
1785
            self._write_basis_inventory(xml)
1922
1786
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
1925
1789
    def read_basis_inventory(self):
1926
1790
        """Read the cached basis inventory."""
1927
1791
        path = self._basis_inventory_name()
1928
 
        return self._transport.get_bytes(path)
1929
 
 
 
1792
        return self._control_files.get(path).read()
 
1793
        
1930
1794
    @needs_read_lock
1931
1795
    def read_working_inventory(self):
1932
1796
        """Read the working inventory.
1933
 
 
 
1797
        
1934
1798
        :raises errors.InventoryModified: read_working_inventory will fail
1935
1799
            when the current in memory inventory has been modified.
1936
1800
        """
1937
 
        # conceptually this should be an implementation detail of the tree.
 
1801
        # conceptually this should be an implementation detail of the tree. 
1938
1802
        # XXX: Deprecate this.
1939
1803
        # ElementTree does its own conversion from UTF-8, so open in
1940
1804
        # binary.
1941
1805
        if self._inventory_is_modified:
1942
1806
            raise errors.InventoryModified(self)
1943
 
        f = self._transport.get('inventory')
1944
 
        try:
1945
 
            result = self._deserialize(f)
1946
 
        finally:
1947
 
            f.close()
 
1807
        result = self._deserialize(self._control_files.get('inventory'))
1948
1808
        self._set_inventory(result, dirty=False)
1949
1809
        return result
1950
1810
 
1965
1825
 
1966
1826
        new_files=set()
1967
1827
        unknown_nested_files=set()
1968
 
        if to_file is None:
1969
 
            to_file = sys.stdout
1970
1828
 
1971
1829
        def recurse_directory_to_add_files(directory):
1972
1830
            # Recurse directory and add all files
1973
1831
            # so we can check if they have changed.
1974
 
            for parent_info, file_infos in self.walkdirs(directory):
1975
 
                for relpath, basename, kind, lstat, fileid, kind in file_infos:
 
1832
            for parent_info, file_infos in\
 
1833
                osutils.walkdirs(self.abspath(directory),
 
1834
                    directory):
 
1835
                for relpath, basename, kind, lstat, abspath in file_infos:
1976
1836
                    # Is it versioned or ignored?
1977
1837
                    if self.path2id(relpath) or self.is_ignored(relpath):
1978
1838
                        # Add nested content for deletion.
1988
1848
            filename = self.relpath(abspath)
1989
1849
            if len(filename) > 0:
1990
1850
                new_files.add(filename)
1991
 
                recurse_directory_to_add_files(filename)
 
1851
                if osutils.isdir(abspath):
 
1852
                    recurse_directory_to_add_files(filename)
1992
1853
 
1993
1854
        files = list(new_files)
1994
1855
 
2012
1873
                            # ... but not ignored
2013
1874
                            has_changed_files = True
2014
1875
                            break
2015
 
                    elif (content_change and (kind[1] is not None) and
2016
 
                            osutils.is_inside_any(files, path[1])):
2017
 
                        # Versioned and changed, but not deleted, and still
2018
 
                        # in one of the dirs to be deleted.
 
1876
                    elif content_change and (kind[1] != None):
 
1877
                        # Versioned and changed, but not deleted
2019
1878
                        has_changed_files = True
2020
1879
                        break
2021
1880
 
2029
1888
                        tree_delta.unversioned.extend((unknown_file,))
2030
1889
                raise errors.BzrRemoveChangedFilesError(tree_delta)
2031
1890
 
2032
 
        # Build inv_delta and delete files where applicable,
 
1891
        # Build inv_delta and delete files where applicaple,
2033
1892
        # do this before any modifications to inventory.
2034
1893
        for f in files:
2035
1894
            fid = self.path2id(f)
2043
1902
                        new_status = 'I'
2044
1903
                    else:
2045
1904
                        new_status = '?'
2046
 
                    # XXX: Really should be a more abstract reporter interface
2047
 
                    kind_ch = osutils.kind_marker(self.kind(fid))
2048
 
                    to_file.write(new_status + '       ' + f + kind_ch + '\n')
 
1905
                    textui.show_status(new_status, self.kind(fid), f,
 
1906
                                       to_file=to_file)
2049
1907
                # Unversion file
2050
1908
                inv_delta.append((f, None, fid, None))
2051
1909
                message = "removed %s" % (f,)
2074
1932
 
2075
1933
    @needs_tree_write_lock
2076
1934
    def revert(self, filenames=None, old_tree=None, backups=True,
2077
 
               pb=None, report_changes=False):
 
1935
               pb=DummyProgress(), report_changes=False):
2078
1936
        from bzrlib.conflicts import resolve
2079
1937
        if filenames == []:
2080
1938
            filenames = None
2093
1951
            if filenames is None and len(self.get_parent_ids()) > 1:
2094
1952
                parent_trees = []
2095
1953
                last_revision = self.last_revision()
2096
 
                if last_revision != _mod_revision.NULL_REVISION:
 
1954
                if last_revision != NULL_REVISION:
2097
1955
                    if basis_tree is None:
2098
1956
                        basis_tree = self.basis_tree()
2099
1957
                        basis_tree.lock_read()
2137
1995
    def set_inventory(self, new_inventory_list):
2138
1996
        from bzrlib.inventory import (Inventory,
2139
1997
                                      InventoryDirectory,
 
1998
                                      InventoryEntry,
2140
1999
                                      InventoryFile,
2141
2000
                                      InventoryLink)
2142
2001
        inv = Inventory(self.get_root_id())
2144
2003
            name = os.path.basename(path)
2145
2004
            if name == "":
2146
2005
                continue
2147
 
            # fixme, there should be a factory function inv,add_??
 
2006
            # fixme, there should be a factory function inv,add_?? 
2148
2007
            if kind == 'directory':
2149
2008
                inv.add(InventoryDirectory(file_id, name, parent))
2150
2009
            elif kind == 'file':
2158
2017
    @needs_tree_write_lock
2159
2018
    def set_root_id(self, file_id):
2160
2019
        """Set the root id for this tree."""
2161
 
        # for compatability
 
2020
        # for compatability 
2162
2021
        if file_id is None:
2163
2022
            raise ValueError(
2164
2023
                'WorkingTree.set_root_id with fileid=None')
2168
2027
    def _set_root_id(self, file_id):
2169
2028
        """Set the root id for this tree, in a format specific manner.
2170
2029
 
2171
 
        :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 
2172
2031
            present in the current inventory or an error will occur. It must
2173
2032
            not be None, but rather a valid file id.
2174
2033
        """
2193
2052
 
2194
2053
    def unlock(self):
2195
2054
        """See Branch.unlock.
2196
 
 
 
2055
        
2197
2056
        WorkingTree locking just uses the Branch locking facilities.
2198
2057
        This is current because all working trees have an embedded branch
2199
2058
        within them. IF in the future, we were to make branch data shareable
2200
 
        between multiple working trees, i.e. via shared storage, then we
 
2059
        between multiple working trees, i.e. via shared storage, then we 
2201
2060
        would probably want to lock both the local tree, and the branch.
2202
2061
        """
2203
2062
        raise NotImplementedError(self.unlock)
2204
2063
 
2205
 
    _marker = object()
2206
 
 
2207
 
    def update(self, change_reporter=None, possible_transports=None,
2208
 
               revision=None, old_tip=_marker):
 
2064
    def update(self, change_reporter=None, possible_transports=None):
2209
2065
        """Update a working tree along its branch.
2210
2066
 
2211
2067
        This will update the branch if its bound too, which means we have
2229
2085
        - Merge current state -> basis tree of the master w.r.t. the old tree
2230
2086
          basis.
2231
2087
        - Do a 'normal' merge of the old branch basis if it is relevant.
2232
 
 
2233
 
        :param revision: The target revision to update to. Must be in the
2234
 
            revision history.
2235
 
        :param old_tip: If branch.update() has already been run, the value it
2236
 
            returned (old tip of the branch or None). _marker is used
2237
 
            otherwise.
2238
2088
        """
2239
2089
        if self.branch.get_bound_location() is not None:
2240
2090
            self.lock_write()
2241
 
            update_branch = (old_tip is self._marker)
 
2091
            update_branch = True
2242
2092
        else:
2243
2093
            self.lock_tree_write()
2244
2094
            update_branch = False
2246
2096
            if update_branch:
2247
2097
                old_tip = self.branch.update(possible_transports)
2248
2098
            else:
2249
 
                if old_tip is self._marker:
2250
 
                    old_tip = None
2251
 
            return self._update_tree(old_tip, change_reporter, revision)
 
2099
                old_tip = None
 
2100
            return self._update_tree(old_tip, change_reporter)
2252
2101
        finally:
2253
2102
            self.unlock()
2254
2103
 
2255
2104
    @needs_tree_write_lock
2256
 
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
 
2105
    def _update_tree(self, old_tip=None, change_reporter=None):
2257
2106
        """Update a tree to the master branch.
2258
2107
 
2259
2108
        :param old_tip: if supplied, the previous tip revision the branch,
2265
2114
        # cant set that until we update the working trees last revision to be
2266
2115
        # one from the new branch, because it will just get absorbed by the
2267
2116
        # parent de-duplication logic.
2268
 
        #
 
2117
        # 
2269
2118
        # We MUST save it even if an error occurs, because otherwise the users
2270
2119
        # local work is unreferenced and will appear to have been lost.
2271
 
        #
2272
 
        nb_conflicts = 0
 
2120
        # 
 
2121
        result = 0
2273
2122
        try:
2274
2123
            last_rev = self.get_parent_ids()[0]
2275
2124
        except IndexError:
2276
2125
            last_rev = _mod_revision.NULL_REVISION
2277
 
        if revision is None:
2278
 
            revision = self.branch.last_revision()
2279
 
 
2280
 
        old_tip = old_tip or _mod_revision.NULL_REVISION
2281
 
 
2282
 
        if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2283
 
            # the branch we are bound to was updated
2284
 
            # merge those changes in first
2285
 
            base_tree  = self.basis_tree()
2286
 
            other_tree = self.branch.repository.revision_tree(old_tip)
2287
 
            nb_conflicts = merge.merge_inner(self.branch, other_tree,
2288
 
                                             base_tree, this_tree=self,
2289
 
                                             change_reporter=change_reporter)
2290
 
            if nb_conflicts:
2291
 
                self.add_parent_tree((old_tip, other_tree))
2292
 
                trace.note('Rerun update after fixing the conflicts.')
2293
 
                return nb_conflicts
2294
 
 
2295
 
        if last_rev != _mod_revision.ensure_null(revision):
2296
 
            # the working tree is up to date with the branch
2297
 
            # we can merge the specified revision from master
2298
 
            to_tree = self.branch.repository.revision_tree(revision)
2299
 
            to_root_id = to_tree.get_root_id()
2300
 
 
 
2126
        if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
 
2127
            # merge tree state up to new branch tip.
2301
2128
            basis = self.basis_tree()
2302
2129
            basis.lock_read()
2303
2130
            try:
2304
 
                if (basis.inventory.root is None
2305
 
                    or basis.inventory.root.file_id != to_root_id):
2306
 
                    self.set_root_id(to_root_id)
 
2131
                to_tree = self.branch.basis_tree()
 
2132
                if basis.inventory.root is None:
 
2133
                    self.set_root_id(to_tree.get_root_id())
2307
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)
2308
2141
            finally:
2309
2142
                basis.unlock()
2310
 
 
2311
 
            # determine the branch point
2312
 
            graph = self.branch.repository.get_graph()
2313
 
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2314
 
                                                last_rev)
2315
 
            base_tree = self.branch.repository.revision_tree(base_rev_id)
2316
 
 
2317
 
            nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2318
 
                                             this_tree=self,
2319
 
                                             change_reporter=change_reporter)
2320
 
            self.set_last_revision(revision)
2321
2143
            # TODO - dedup parents list with things merged by pull ?
2322
2144
            # reuse the tree we've updated to to set the basis:
2323
 
            parent_trees = [(revision, to_tree)]
 
2145
            parent_trees = [(self.branch.last_revision(), to_tree)]
2324
2146
            merges = self.get_parent_ids()[1:]
2325
2147
            # Ideally we ask the tree for the trees here, that way the working
2326
 
            # tree can decide whether to give us the entire tree or give us a
 
2148
            # tree can decide whether to give us teh entire tree or give us a
2327
2149
            # lazy initialised tree. dirstate for instance will have the trees
2328
2150
            # in ram already, whereas a last-revision + basis-inventory tree
2329
2151
            # will not, but also does not need them when setting parents.
2330
2152
            for parent in merges:
2331
2153
                parent_trees.append(
2332
2154
                    (parent, self.branch.repository.revision_tree(parent)))
2333
 
            if not _mod_revision.is_null(old_tip):
 
2155
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2334
2156
                parent_trees.append(
2335
2157
                    (old_tip, self.branch.repository.revision_tree(old_tip)))
2336
2158
            self.set_parent_trees(parent_trees)
2337
2159
            last_rev = parent_trees[0][0]
2338
 
        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
2339
2192
 
2340
2193
    def _write_hashcache_if_dirty(self):
2341
2194
        """Write out the hashcache if it is dirty."""
2440
2293
                    # value.
2441
2294
                    bzrdir_loc = bisect_left(cur_disk_dir_content,
2442
2295
                        ('.bzr', '.bzr'))
2443
 
                    if (bzrdir_loc < len(cur_disk_dir_content)
2444
 
                        and self.bzrdir.is_control_filename(
2445
 
                            cur_disk_dir_content[bzrdir_loc][0])):
 
2296
                    if cur_disk_dir_content[bzrdir_loc][0] == '.bzr':
2446
2297
                        # we dont yield the contents of, or, .bzr itself.
2447
2298
                        del cur_disk_dir_content[bzrdir_loc]
2448
2299
            if inv_finished:
2538
2389
                relroot = ""
2539
2390
            # FIXME: stash the node in pending
2540
2391
            entry = inv[top_id]
2541
 
            if entry.kind == 'directory':
2542
 
                for name, child in entry.sorted_children():
2543
 
                    dirblock.append((relroot + name, name, child.kind, None,
2544
 
                        child.file_id, child.kind
2545
 
                        ))
 
2392
            for name, child in entry.sorted_children():
 
2393
                dirblock.append((relroot + name, name, child.kind, None,
 
2394
                    child.file_id, child.kind
 
2395
                    ))
2546
2396
            yield (currentdir[0], entry.file_id), dirblock
2547
2397
            # push the user specified dirs from dirblock
2548
2398
            for dir in reversed(dirblock):
2581
2431
        self.set_conflicts(un_resolved)
2582
2432
        return un_resolved, resolved
2583
2433
 
2584
 
    @needs_read_lock
2585
 
    def _check(self, references):
2586
 
        """Check the tree for consistency.
2587
 
 
2588
 
        :param references: A dict with keys matching the items returned by
2589
 
            self._get_check_refs(), and values from looking those keys up in
2590
 
            the repository.
2591
 
        """
2592
 
        tree_basis = self.basis_tree()
2593
 
        tree_basis.lock_read()
2594
 
        try:
2595
 
            repo_basis = references[('trees', self.last_revision())]
2596
 
            if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2597
 
                raise errors.BzrCheckError(
2598
 
                    "Mismatched basis inventory content.")
2599
 
            self._validate()
2600
 
        finally:
2601
 
            tree_basis.unlock()
2602
 
 
2603
2434
    def _validate(self):
2604
2435
        """Validate internal structures.
2605
2436
 
2611
2442
        """
2612
2443
        return
2613
2444
 
2614
 
    def _get_rules_searcher(self, default_searcher):
2615
 
        """See Tree._get_rules_searcher."""
2616
 
        if self._rules_searcher is None:
2617
 
            self._rules_searcher = super(WorkingTree,
2618
 
                self)._get_rules_searcher(default_searcher)
2619
 
        return self._rules_searcher
2620
 
 
2621
 
    def get_shelf_manager(self):
2622
 
        """Return the ShelfManager for this WorkingTree."""
2623
 
        from bzrlib.shelf import ShelfManager
2624
 
        return ShelfManager(self, self._transport)
2625
 
 
2626
2445
 
2627
2446
class WorkingTree2(WorkingTree):
2628
2447
    """This is the Format 2 working tree.
2629
2448
 
2630
 
    This was the first weave based working tree.
 
2449
    This was the first weave based working tree. 
2631
2450
     - uses os locks for locking.
2632
2451
     - uses the branch last-revision.
2633
2452
    """
2643
2462
        if self._inventory is None:
2644
2463
            self.read_working_inventory()
2645
2464
 
2646
 
    def _get_check_refs(self):
2647
 
        """Return the references needed to perform a check of this tree."""
2648
 
        return [('trees', self.last_revision())]
2649
 
 
2650
2465
    def lock_tree_write(self):
2651
2466
        """See WorkingTree.lock_tree_write().
2652
2467
 
2653
2468
        In Format2 WorkingTrees we have a single lock for the branch and tree
2654
2469
        so lock_tree_write() degrades to lock_write().
2655
 
 
2656
 
        :return: An object with an unlock method which will release the lock
2657
 
            obtained.
2658
2470
        """
2659
2471
        self.branch.lock_write()
2660
2472
        try:
2661
 
            self._control_files.lock_write()
2662
 
            return self
 
2473
            return self._control_files.lock_write()
2663
2474
        except:
2664
2475
            self.branch.unlock()
2665
2476
            raise
2674
2485
            if self._inventory_is_modified:
2675
2486
                self.flush()
2676
2487
            self._write_hashcache_if_dirty()
2677
 
 
 
2488
                    
2678
2489
        # reverse order of locking.
2679
2490
        try:
2680
2491
            return self._control_files.unlock()
2696
2507
    def _last_revision(self):
2697
2508
        """See Mutable.last_revision."""
2698
2509
        try:
2699
 
            return self._transport.get_bytes('last-revision')
 
2510
            return self._control_files.get('last-revision').read()
2700
2511
        except errors.NoSuchFile:
2701
2512
            return _mod_revision.NULL_REVISION
2702
2513
 
2703
2514
    def _change_last_revision(self, revision_id):
2704
2515
        """See WorkingTree._change_last_revision."""
2705
 
        if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
 
2516
        if revision_id is None or revision_id == NULL_REVISION:
2706
2517
            try:
2707
 
                self._transport.delete('last-revision')
 
2518
                self._control_files._transport.delete('last-revision')
2708
2519
            except errors.NoSuchFile:
2709
2520
                pass
2710
2521
            return False
2711
2522
        else:
2712
 
            self._transport.put_bytes('last-revision', revision_id,
2713
 
                mode=self.bzrdir._get_file_mode())
 
2523
            self._control_files.put_bytes('last-revision', revision_id)
2714
2524
            return True
2715
2525
 
2716
 
    def _get_check_refs(self):
2717
 
        """Return the references needed to perform a check of this tree."""
2718
 
        return [('trees', self.last_revision())]
2719
 
 
2720
2526
    @needs_tree_write_lock
2721
2527
    def set_conflicts(self, conflicts):
2722
 
        self._put_rio('conflicts', conflicts.to_stanzas(),
 
2528
        self._put_rio('conflicts', conflicts.to_stanzas(), 
2723
2529
                      CONFLICT_HEADER_1)
2724
2530
 
2725
2531
    @needs_tree_write_lock
2732
2538
    @needs_read_lock
2733
2539
    def conflicts(self):
2734
2540
        try:
2735
 
            confile = self._transport.get('conflicts')
 
2541
            confile = self._control_files.get('conflicts')
2736
2542
        except errors.NoSuchFile:
2737
2543
            return _mod_conflicts.ConflictList()
2738
2544
        try:
2739
 
            try:
2740
 
                if confile.next() != CONFLICT_HEADER_1 + '\n':
2741
 
                    raise errors.ConflictFormatError()
2742
 
            except StopIteration:
 
2545
            if confile.next() != CONFLICT_HEADER_1 + '\n':
2743
2546
                raise errors.ConflictFormatError()
2744
 
            return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2745
 
        finally:
2746
 
            confile.close()
 
2547
        except StopIteration:
 
2548
            raise errors.ConflictFormatError()
 
2549
        return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2747
2550
 
2748
2551
    def unlock(self):
2749
2552
        # do non-implementation specific cleanup
2774
2577
     * a format string,
2775
2578
     * an open routine.
2776
2579
 
2777
 
    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 
2778
2581
    during workingtree opening. Its not required that these be instances, they
2779
 
    can be classes themselves with class methods - it simply depends on
 
2582
    can be classes themselves with class methods - it simply depends on 
2780
2583
    whether state is needed for a given format or not.
2781
2584
 
2782
2585
    Once a format is deprecated, just deprecate the initialize and open
2783
 
    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 
2784
2587
    object will be created every time regardless.
2785
2588
    """
2786
2589
 
2799
2602
        """Return the format for the working tree object in a_bzrdir."""
2800
2603
        try:
2801
2604
            transport = a_bzrdir.get_workingtree_transport(None)
2802
 
            format_string = transport.get_bytes("format")
 
2605
            format_string = transport.get("format").read()
2803
2606
            return klass._formats[format_string]
2804
2607
        except errors.NoSuchFile:
2805
2608
            raise errors.NoWorkingTree(base=transport.base)
2830
2633
        """Is this format supported?
2831
2634
 
2832
2635
        Supported formats can be initialized and opened.
2833
 
        Unsupported formats may not support initialization or committing or
 
2636
        Unsupported formats may not support initialization or committing or 
2834
2637
        some other features depending on the reason for not being supported.
2835
2638
        """
2836
2639
        return True
2837
2640
 
2838
 
    def supports_content_filtering(self):
2839
 
        """True if this format supports content filtering."""
2840
 
        return False
2841
 
 
2842
 
    def supports_views(self):
2843
 
        """True if this format supports stored views."""
2844
 
        return False
2845
 
 
2846
2641
    @classmethod
2847
2642
    def register_format(klass, format):
2848
2643
        klass._formats[format.get_format_string()] = format
2853
2648
 
2854
2649
    @classmethod
2855
2650
    def unregister_format(klass, format):
 
2651
        assert klass._formats[format.get_format_string()] is format
2856
2652
        del klass._formats[format.get_format_string()]
2857
2653
 
2858
2654
 
2859
2655
class WorkingTreeFormat2(WorkingTreeFormat):
2860
 
    """The second working tree format.
 
2656
    """The second working tree format. 
2861
2657
 
2862
2658
    This format modified the hash cache from the format 1 hash cache.
2863
2659
    """
2868
2664
        """See WorkingTreeFormat.get_format_description()."""
2869
2665
        return "Working tree format 2"
2870
2666
 
2871
 
    def _stub_initialize_on_transport(self, transport, file_mode):
2872
 
        """Workaround: create control files for a remote working tree.
2873
 
 
 
2667
    def stub_initialize_remote(self, control_files):
 
2668
        """As a special workaround create critical control files for a remote working tree
 
2669
        
2874
2670
        This ensures that it can later be updated and dealt with locally,
2875
 
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
 
2671
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with 
2876
2672
        no working tree.  (See bug #43064).
2877
2673
        """
2878
2674
        sio = StringIO()
2879
 
        inv = inventory.Inventory()
 
2675
        inv = Inventory()
2880
2676
        xml5.serializer_v5.write_inventory(inv, sio, working=True)
2881
2677
        sio.seek(0)
2882
 
        transport.put_file('inventory', sio, file_mode)
2883
 
        transport.put_bytes('pending-merges', '', file_mode)
 
2678
        control_files.put('inventory', sio)
 
2679
 
 
2680
        control_files.put_bytes('pending-merges', '')
 
2681
        
2884
2682
 
2885
2683
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2886
2684
                   accelerator_tree=None, hardlink=False):
2898
2696
            branch.generate_revision_history(revision_id)
2899
2697
        finally:
2900
2698
            branch.unlock()
2901
 
        inv = inventory.Inventory()
 
2699
        inv = Inventory()
2902
2700
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2903
2701
                         branch,
2904
2702
                         inv,
2949
2747
        - is new in bzr 0.8
2950
2748
        - uses a LockDir to guard access for writes.
2951
2749
    """
2952
 
 
 
2750
    
2953
2751
    upgrade_recommended = True
2954
2752
 
2955
2753
    def get_format_string(self):
2972
2770
 
2973
2771
    def _open_control_files(self, a_bzrdir):
2974
2772
        transport = a_bzrdir.get_workingtree_transport(None)
2975
 
        return LockableFiles(transport, self._lock_file_name,
 
2773
        return LockableFiles(transport, self._lock_file_name, 
2976
2774
                             self._lock_class)
2977
2775
 
2978
2776
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2979
2777
                   accelerator_tree=None, hardlink=False):
2980
2778
        """See WorkingTreeFormat.initialize().
2981
 
 
 
2779
        
2982
2780
        :param revision_id: if supplied, create a working tree at a different
2983
2781
            revision than the branch is at.
2984
2782
        :param accelerator_tree: A tree which can be used for retrieving file
2994
2792
        control_files = self._open_control_files(a_bzrdir)
2995
2793
        control_files.create_lock()
2996
2794
        control_files.lock_write()
2997
 
        transport.put_bytes('format', self.get_format_string(),
2998
 
            mode=a_bzrdir._get_file_mode())
 
2795
        control_files.put_utf8('format', self.get_format_string())
2999
2796
        if from_branch is not None:
3000
2797
            branch = from_branch
3001
2798
        else:
3021
2818
            # only set an explicit root id if there is one to set.
3022
2819
            if basis_tree.inventory.root is not None:
3023
2820
                wt.set_root_id(basis_tree.get_root_id())
3024
 
            if revision_id == _mod_revision.NULL_REVISION:
 
2821
            if revision_id == NULL_REVISION:
3025
2822
                wt.set_parent_trees([])
3026
2823
            else:
3027
2824
                wt.set_parent_trees([(revision_id, basis_tree)])
3034
2831
        return wt
3035
2832
 
3036
2833
    def _initial_inventory(self):
3037
 
        return inventory.Inventory()
 
2834
        return Inventory()
3038
2835
 
3039
2836
    def __init__(self):
3040
2837
        super(WorkingTreeFormat3, self).__init__()
3055
2852
 
3056
2853
    def _open(self, a_bzrdir, control_files):
3057
2854
        """Open the tree itself.
3058
 
 
 
2855
        
3059
2856
        :param a_bzrdir: the dir for the tree.
3060
2857
        :param control_files: the control files for the tree.
3061
2858
        """
3069
2866
        return self.get_format_string()
3070
2867
 
3071
2868
 
3072
 
__default_format = WorkingTreeFormat6()
 
2869
__default_format = WorkingTreeFormat4()
3073
2870
WorkingTreeFormat.register_format(__default_format)
3074
 
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3075
 
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3076
2871
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3077
2872
WorkingTreeFormat.set_default_format(__default_format)
3078
2873
# formats which have no format string are not discoverable