/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-08 04:16:03 UTC
  • mto: This revision was merged to the branch mainline in revision 3415.
  • Revision ID: mbp@sourcefrog.net-20080508041603-bspsqou83t7p4l10
Restore some assertions as comments

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/workingtree.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""WorkingTree object and friends.
18
18
 
19
19
A WorkingTree represents the editable working copy of a branch.
20
 
Operations which represent the WorkingTree are also done here,
21
 
such as renaming or adding files.  The WorkingTree has an inventory
22
 
which is updated by these operations.  A commit produces a
 
20
Operations which represent the WorkingTree are also done here, 
 
21
such as renaming or adding files.  The WorkingTree has an inventory 
 
22
which is updated by these operations.  A commit produces a 
23
23
new revision based on the workingtree and its inventory.
24
24
 
25
25
At the moment every WorkingTree has its own branch.  Remote
29
29
WorkingTree.open(dir).
30
30
"""
31
31
 
 
32
# TODO: Give the workingtree sole responsibility for the working inventory;
 
33
# remove the variable and references to it from the branch.  This may require
 
34
# updating the commit code so as to update the inventory within the working
 
35
# copy, and making sure there's only one WorkingTree for any directory on disk.
 
36
# At the moment they may alias the inventory and have old copies of it in
 
37
# memory.  (Now done? -- mbp 20060309)
32
38
 
33
39
from cStringIO import StringIO
34
40
import os
42
48
import itertools
43
49
import operator
44
50
import stat
 
51
from time import time
 
52
import warnings
45
53
import re
46
54
 
47
55
import bzrlib
49
57
    branch,
50
58
    bzrdir,
51
59
    conflicts as _mod_conflicts,
 
60
    dirstate,
52
61
    errors,
53
62
    generate_ids,
54
63
    globbing,
55
 
    graph as _mod_graph,
56
64
    hashcache,
57
65
    ignores,
58
 
    inventory,
59
66
    merge,
60
67
    revision as _mod_revision,
61
68
    revisiontree,
 
69
    repository,
 
70
    textui,
62
71
    trace,
63
72
    transform,
64
73
    ui,
65
 
    views,
 
74
    urlutils,
66
75
    xml5,
 
76
    xml6,
67
77
    xml7,
68
78
    )
69
79
import bzrlib.branch
70
80
from bzrlib.transport import get_transport
71
 
from bzrlib.workingtree_4 import (
72
 
    WorkingTreeFormat4,
73
 
    WorkingTreeFormat5,
74
 
    WorkingTreeFormat6,
75
 
    )
 
81
import bzrlib.ui
 
82
from bzrlib.workingtree_4 import WorkingTreeFormat4
76
83
""")
77
84
 
78
85
from bzrlib import symbol_versioning
79
86
from bzrlib.decorators import needs_read_lock, needs_write_lock
80
 
from bzrlib.lockable_files import LockableFiles
 
87
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
 
88
from bzrlib.lockable_files import LockableFiles, TransportLock
81
89
from bzrlib.lockdir import LockDir
82
90
import bzrlib.mutabletree
83
91
from bzrlib.mutabletree import needs_tree_write_lock
84
92
from bzrlib import osutils
85
93
from bzrlib.osutils import (
 
94
    compact_date,
86
95
    file_kind,
87
96
    isdir,
88
97
    normpath,
89
98
    pathjoin,
 
99
    rand_chars,
90
100
    realpath,
91
101
    safe_unicode,
92
102
    splitpath,
93
103
    supports_executable,
94
104
    )
95
 
from bzrlib.filters import filtered_input_file
96
105
from bzrlib.trace import mutter, note
97
106
from bzrlib.transport.local import LocalTransport
98
 
from bzrlib.revision import CURRENT_REVISION
 
107
from bzrlib.progress import DummyProgress, ProgressPhase
 
108
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
99
109
from bzrlib.rio import RioReader, rio_file, Stanza
100
 
from bzrlib.symbol_versioning import (
101
 
    deprecated_passed,
102
 
    DEPRECATED_PARAMETER,
103
 
    )
 
110
from bzrlib.symbol_versioning import (deprecated_passed,
 
111
        deprecated_method,
 
112
        deprecated_function,
 
113
        DEPRECATED_PARAMETER,
 
114
        zero_eight,
 
115
        zero_eleven,
 
116
        zero_thirteen,
 
117
        )
104
118
 
105
119
 
106
120
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
121
CONFLICT_HEADER_1 = "BZR conflict list format 1"
111
122
 
112
123
ERROR_PATH_NOT_FOUND = 3    # WindowsError errno code, equivalent to ENOENT
113
124
 
114
125
 
 
126
@deprecated_function(zero_thirteen)
 
127
def gen_file_id(name):
 
128
    """Return new file id for the basename 'name'.
 
129
 
 
130
    Use bzrlib.generate_ids.gen_file_id() instead
 
131
    """
 
132
    return generate_ids.gen_file_id(name)
 
133
 
 
134
 
 
135
@deprecated_function(zero_thirteen)
 
136
def gen_root_id():
 
137
    """Return a new tree-root file id.
 
138
 
 
139
    This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
 
140
    """
 
141
    return generate_ids.gen_root_id()
 
142
 
 
143
 
115
144
class TreeEntry(object):
116
145
    """An entry that implements the minimum interface used by commands.
117
146
 
118
 
    This needs further inspection, it may be better to have
 
147
    This needs further inspection, it may be better to have 
119
148
    InventoryEntries without ids - though that seems wrong. For now,
120
149
    this is a parallel hierarchy to InventoryEntry, and needs to become
121
150
    one of several things: decorates to that hierarchy, children of, or
124
153
    no InventoryEntry available - i.e. for unversioned objects.
125
154
    Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
126
155
    """
127
 
 
 
156
 
128
157
    def __eq__(self, other):
129
158
        # yes, this us ugly, TODO: best practice __eq__ style.
130
159
        return (isinstance(other, TreeEntry)
131
160
                and other.__class__ == self.__class__)
132
 
 
 
161
 
133
162
    def kind_character(self):
134
163
        return "???"
135
164
 
167
196
        return ''
168
197
 
169
198
 
170
 
class WorkingTree(bzrlib.mutabletree.MutableTree,
171
 
    bzrdir.ControlComponent):
 
199
class WorkingTree(bzrlib.mutabletree.MutableTree):
172
200
    """Working copy tree.
173
201
 
174
202
    The inventory is held in the `Branch` working-inventory, and the
178
206
    not listed in the Inventory and vice versa.
179
207
    """
180
208
 
181
 
    # override this to set the strategy for storing views
182
 
    def _make_views(self):
183
 
        return views.DisabledViews(self)
184
 
 
185
209
    def __init__(self, basedir='.',
186
210
                 branch=DEPRECATED_PARAMETER,
187
211
                 _inventory=None,
212
236
        else:
213
237
            # assume all other formats have their own control files.
214
238
            self._control_files = _control_files
215
 
        self._transport = self._control_files._transport
216
239
        # update the whole cache up front and write to disk if anything changed;
217
240
        # in the future we might want to do this more selectively
218
241
        # two possible ways offer themselves : in self._unlock, write the cache
222
245
        wt_trans = self.bzrdir.get_workingtree_transport(None)
223
246
        cache_filename = wt_trans.local_abspath('stat-cache')
224
247
        self._hashcache = hashcache.HashCache(basedir, cache_filename,
225
 
            self.bzrdir._get_file_mode(),
226
 
            self._content_filter_stack_provider())
 
248
                                              self._control_files._file_mode)
227
249
        hc = self._hashcache
228
250
        hc.read()
229
251
        # is this scan needed ? it makes things kinda slow.
244
266
            # permitted to do this.
245
267
            self._set_inventory(_inventory, dirty=False)
246
268
        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
269
 
258
270
    def _detect_case_handling(self):
259
271
        wt_trans = self.bzrdir.get_workingtree_transport(None)
285
297
        self._control_files.break_lock()
286
298
        self.branch.break_lock()
287
299
 
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
300
    def requires_rich_root(self):
299
301
        return self._format.requires_rich_root
300
302
 
301
303
    def supports_tree_reference(self):
302
304
        return False
303
305
 
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
306
    def _set_inventory(self, inv, dirty):
311
307
        """Set the internal cached inventory.
312
308
 
326
322
 
327
323
        """
328
324
        if path is None:
329
 
            path = osutils.getcwd()
 
325
            path = os.path.getcwdu()
330
326
        control = bzrdir.BzrDir.open(path, _unsupported)
331
327
        return control.open_workingtree(_unsupported)
332
 
 
 
328
        
333
329
    @staticmethod
334
330
    def open_containing(path=None):
335
331
        """Open an existing working tree which has its root about path.
336
 
 
 
332
        
337
333
        This probes for a working tree at path and searches upwards from there.
338
334
 
339
335
        Basically we keep looking up until we find the control directory or
400
396
 
401
397
    def basis_tree(self):
402
398
        """Return RevisionTree for the current last revision.
403
 
 
 
399
        
404
400
        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).
 
401
        empty tree - one obtained by calling repository.revision_tree(None).
407
402
        """
408
403
        try:
409
404
            revision_id = self.get_parent_ids()[0]
411
406
            # no parents, return an empty revision tree.
412
407
            # in the future this should return the tree for
413
408
            # 'empty:' - the implicit root empty tree.
414
 
            return self.branch.repository.revision_tree(
415
 
                       _mod_revision.NULL_REVISION)
 
409
            return self.branch.repository.revision_tree(None)
416
410
        try:
417
411
            return self.revision_tree(revision_id)
418
412
        except errors.NoSuchRevision:
422
416
        # at this point ?
423
417
        try:
424
418
            return self.branch.repository.revision_tree(revision_id)
425
 
        except (errors.RevisionNotPresent, errors.NoSuchRevision):
 
419
        except errors.RevisionNotPresent:
426
420
            # 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
 
421
            # occured. If the revision is present, its a problem, if its not
428
422
            # its a ghost.
429
423
            if self.branch.repository.has_revision(revision_id):
430
424
                raise
431
425
            # the basis tree is a ghost so return an empty tree.
432
 
            return self.branch.repository.revision_tree(
433
 
                       _mod_revision.NULL_REVISION)
 
426
            return self.branch.repository.revision_tree(None)
434
427
 
435
428
    def _cleanup(self):
436
429
        self._flush_ignore_list_cache()
437
430
 
 
431
    @staticmethod
 
432
    @deprecated_method(zero_eight)
 
433
    def create(branch, directory):
 
434
        """Create a workingtree for branch at directory.
 
435
 
 
436
        If existing_directory already exists it must have a .bzr directory.
 
437
        If it does not exist, it will be created.
 
438
 
 
439
        This returns a new WorkingTree object for the new checkout.
 
440
 
 
441
        TODO FIXME RBC 20060124 when we have checkout formats in place this
 
442
        should accept an optional revisionid to checkout [and reject this if
 
443
        checking out into the same dir as a pre-checkout-aware branch format.]
 
444
 
 
445
        XXX: When BzrDir is present, these should be created through that 
 
446
        interface instead.
 
447
        """
 
448
        warnings.warn('delete WorkingTree.create', stacklevel=3)
 
449
        transport = get_transport(directory)
 
450
        if branch.bzrdir.root_transport.base == transport.base:
 
451
            # same dir 
 
452
            return branch.bzrdir.create_workingtree()
 
453
        # different directory, 
 
454
        # create a branch reference
 
455
        # and now a working tree.
 
456
        raise NotImplementedError
 
457
 
 
458
    @staticmethod
 
459
    @deprecated_method(zero_eight)
 
460
    def create_standalone(directory):
 
461
        """Create a checkout and a branch and a repo at directory.
 
462
 
 
463
        Directory must exist and be empty.
 
464
 
 
465
        please use BzrDir.create_standalone_workingtree
 
466
        """
 
467
        return bzrdir.BzrDir.create_standalone_workingtree(directory)
 
468
 
438
469
    def relpath(self, path):
439
470
        """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
 
471
        
 
472
        The path may be absolute or relative. If its a relative path it is 
442
473
        interpreted relative to the python current working directory.
443
474
        """
444
475
        return osutils.relpath(self.basedir, path)
446
477
    def has_filename(self, filename):
447
478
        return osutils.lexists(self.abspath(filename))
448
479
 
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."""
 
480
    def get_file(self, file_id, path=None):
455
481
        if path is None:
456
482
            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()
 
483
        return self.get_file_byname(path)
 
484
 
 
485
    def get_file_text(self, file_id):
 
486
        return self.get_file(file_id).read()
 
487
 
 
488
    def get_file_byname(self, filename):
 
489
        return file(self.abspath(filename), 'rb')
483
490
 
484
491
    @needs_read_lock
485
492
    def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
492
499
        incorrectly attributed to CURRENT_REVISION (but after committing, the
493
500
        attribution will be correct).
494
501
        """
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
 
502
        basis = self.basis_tree()
 
503
        basis.lock_read()
 
504
        try:
 
505
            changes = self.iter_changes(basis, True, [self.id2path(file_id)],
 
506
                require_versioned=True).next()
 
507
            changed_content, kind = changes[2], changes[6]
 
508
            if not changed_content:
 
509
                return basis.annotate_iter(file_id)
 
510
            if kind[1] is None:
 
511
                return None
 
512
            import annotate
 
513
            if kind[0] != 'file':
 
514
                old_lines = []
 
515
            else:
 
516
                old_lines = list(basis.annotate_iter(file_id))
 
517
            old = [old_lines]
 
518
            for tree in self.branch.repository.revision_trees(
 
519
                self.get_parent_ids()[1:]):
 
520
                if file_id not in tree:
 
521
                    continue
 
522
                old.append(list(tree.annotate_iter(file_id)))
 
523
            return annotate.reannotate(old, self.get_file(file_id).readlines(),
 
524
                                       default_revision)
 
525
        finally:
 
526
            basis.unlock()
531
527
 
532
528
    def _get_ancestors(self, default_revision):
533
529
        ancestors = set([default_revision])
538
534
 
539
535
    def get_parent_ids(self):
540
536
        """See Tree.get_parent_ids.
541
 
 
 
537
        
542
538
        This implementation reads the pending merges list and last_revision
543
539
        value and uses that to decide what the parents list should be.
544
540
        """
548
544
        else:
549
545
            parents = [last_rev]
550
546
        try:
551
 
            merges_bytes = self._transport.get_bytes('pending-merges')
 
547
            merges_file = self._control_files.get('pending-merges')
552
548
        except errors.NoSuchFile:
553
549
            pass
554
550
        else:
555
 
            for l in osutils.split_lines(merges_bytes):
 
551
            for l in merges_file.readlines():
556
552
                revision_id = l.rstrip('\n')
557
553
                parents.append(revision_id)
558
554
        return parents
561
557
    def get_root_id(self):
562
558
        """Return the id of this trees root"""
563
559
        return self._inventory.root.file_id
564
 
 
 
560
        
565
561
    def _get_store_filename(self, file_id):
566
562
        ## XXX: badly named; this is not in the store at all
567
563
        return self.abspath(self.id2path(file_id))
569
565
    @needs_read_lock
570
566
    def clone(self, to_bzrdir, revision_id=None):
571
567
        """Duplicate this working tree into to_bzr, including all state.
572
 
 
 
568
        
573
569
        Specifically modified files are kept as modified, but
574
570
        ignored and unknown files are discarded.
575
571
 
576
572
        If you want to make a new line of development, see bzrdir.sprout()
577
573
 
578
574
        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
 
575
            If not None, the cloned tree will have its last revision set to 
 
576
            revision, and and difference between the source trees last revision
581
577
            and this one merged in.
582
578
        """
583
579
        # assumes the target bzr dir format is compatible.
584
 
        result = to_bzrdir.create_workingtree()
 
580
        result = self._format.initialize(to_bzrdir)
585
581
        self.copy_content_into(result, revision_id)
586
582
        return result
587
583
 
616
612
    __contains__ = has_id
617
613
 
618
614
    def get_file_size(self, file_id):
619
 
        """See Tree.get_file_size"""
620
 
        # XXX: this returns the on-disk size; it should probably return the
621
 
        # canonical size
622
 
        try:
623
 
            return os.path.getsize(self.id2abspath(file_id))
624
 
        except OSError, e:
625
 
            if e.errno != errno.ENOENT:
626
 
                raise
627
 
            else:
628
 
                return None
 
615
        return os.path.getsize(self.id2abspath(file_id))
629
616
 
630
617
    @needs_read_lock
631
618
    def get_file_sha1(self, file_id, path=None, stat_value=None):
640
627
 
641
628
    def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
642
629
        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
630
        return self._inventory[file_id].executable
648
631
 
649
632
    def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
671
654
        """See MutableTree._add."""
672
655
        # TODO: Re-adding a file that is removed in the working copy
673
656
        # should probably put it back with the previous ID.
674
 
        # the read and write working inventory should not occur in this
 
657
        # the read and write working inventory should not occur in this 
675
658
        # function - they should be part of lock_write and unlock.
676
659
        inv = self.inventory
677
660
        for f, file_id, kind in zip(files, ids, kinds):
759
742
            raise
760
743
        kind = _mapper(stat_result.st_mode)
761
744
        if kind == 'file':
762
 
            return self._file_content_summary(path, stat_result)
 
745
            size = stat_result.st_size
 
746
            # try for a stat cache lookup
 
747
            executable = self._is_executable_from_path_and_stat(path, stat_result)
 
748
            return (kind, size, executable, self._sha_from_stat(
 
749
                path, stat_result))
763
750
        elif kind == 'directory':
764
751
            # perhaps it looks like a plain directory, but it's really a
765
752
            # reference.
767
754
                kind = 'tree-reference'
768
755
            return kind, None, None, None
769
756
        elif kind == 'symlink':
770
 
            target = osutils.readlink(abspath)
771
 
            return ('symlink', None, None, target)
 
757
            return ('symlink', None, None, os.readlink(abspath))
772
758
        else:
773
759
            return (kind, None, None, None)
774
760
 
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))
 
761
    @deprecated_method(zero_eleven)
 
762
    @needs_read_lock
 
763
    def pending_merges(self):
 
764
        """Return a list of pending merges.
 
765
 
 
766
        These are revisions that have been merged into the working
 
767
        directory but not yet committed.
 
768
 
 
769
        As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
 
770
        instead - which is available on all tree objects.
 
771
        """
 
772
        return self.get_parent_ids()[1:]
781
773
 
782
774
    def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
783
775
        """Common ghost checking functionality from set_parent_*.
793
785
 
794
786
    def _set_merges_from_parent_ids(self, parent_ids):
795
787
        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
 
788
        self._control_files.put_bytes('pending-merges', '\n'.join(merges))
817
789
 
818
790
    @needs_tree_write_lock
819
791
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
820
792
        """Set the parent ids to revision_ids.
821
 
 
 
793
        
822
794
        See also set_parent_trees. This api will try to retrieve the tree data
823
795
        for each element of revision_ids from the trees repository. If you have
824
796
        tree data already available, it is more efficient to use
833
805
        for revision_id in revision_ids:
834
806
            _mod_revision.check_not_reserved_id(revision_id)
835
807
 
836
 
        revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
837
 
 
838
808
        if len(revision_ids) > 0:
839
809
            self.set_last_revision(revision_ids[0])
840
810
        else:
852
822
        self._check_parents_for_ghosts(parent_ids,
853
823
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
854
824
 
855
 
        parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
856
 
 
857
825
        if len(parent_ids) == 0:
858
826
            leftmost_parent_id = _mod_revision.NULL_REVISION
859
827
            leftmost_parent_tree = None
899
867
    def _put_rio(self, filename, stanzas, header):
900
868
        self._must_be_locked()
901
869
        my_file = rio_file(stanzas, header)
902
 
        self._transport.put_file(filename, my_file,
903
 
            mode=self.bzrdir._get_file_mode())
 
870
        self._control_files.put(filename, my_file)
904
871
 
905
872
    @needs_write_lock # because merge pulls data into the branch.
906
873
    def merge_from_branch(self, branch, to_revision=None, from_revision=None,
907
 
                          merge_type=None, force=False):
 
874
        merge_type=None):
908
875
        """Merge from a branch into this working tree.
909
876
 
910
877
        :param branch: The branch to merge from.
914
881
            branch.last_revision().
915
882
        """
916
883
        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()
 
884
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
885
        try:
 
886
            merger = Merger(self.branch, this_tree=self, pb=pb)
 
887
            merger.pp = ProgressPhase("Merge phase", 5, pb)
 
888
            merger.pp.next_phase()
 
889
            # check that there are no
 
890
            # local alterations
 
891
            merger.check_basis(check_clean=True, require_commits=False)
 
892
            if to_revision is None:
 
893
                to_revision = _mod_revision.ensure_null(branch.last_revision())
 
894
            merger.other_rev_id = to_revision
 
895
            if _mod_revision.is_null(merger.other_rev_id):
 
896
                raise errors.NoCommits(branch)
 
897
            self.branch.fetch(branch, last_revision=merger.other_rev_id)
 
898
            merger.other_basis = merger.other_rev_id
 
899
            merger.other_tree = self.branch.repository.revision_tree(
 
900
                merger.other_rev_id)
 
901
            merger.other_branch = branch
 
902
            merger.pp.next_phase()
 
903
            if from_revision is None:
 
904
                merger.find_base()
 
905
            else:
 
906
                merger.set_base_revision(from_revision, branch)
 
907
            if merger.base_rev_id == merger.other_rev_id:
 
908
                raise errors.PointlessMerge
 
909
            merger.backup_files = False
 
910
            if merge_type is None:
 
911
                merger.merge_type = Merge3Merger
 
912
            else:
 
913
                merger.merge_type = merge_type
 
914
            merger.set_interesting_files(None)
 
915
            merger.show_base = False
 
916
            merger.reprocess = False
 
917
            conflicts = merger.do_merge()
 
918
            merger.set_pending()
 
919
        finally:
 
920
            pb.finished()
947
921
        return conflicts
948
922
 
949
923
    @needs_read_lock
950
924
    def merge_modified(self):
951
925
        """Return a dictionary of files modified by a merge.
952
926
 
953
 
        The list is initialized by WorkingTree.set_merge_modified, which is
 
927
        The list is initialized by WorkingTree.set_merge_modified, which is 
954
928
        typically called after we make some automatic updates to the tree
955
929
        because of a merge.
956
930
 
958
932
        still in the working inventory and have that text hash.
959
933
        """
960
934
        try:
961
 
            hashfile = self._transport.get('merge-hashes')
 
935
            hashfile = self._control_files.get('merge-hashes')
962
936
        except errors.NoSuchFile:
963
937
            return {}
 
938
        merge_hashes = {}
964
939
        try:
965
 
            merge_hashes = {}
966
 
            try:
967
 
                if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
968
 
                    raise errors.MergeModifiedFormatError()
969
 
            except StopIteration:
 
940
            if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
970
941
                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()
 
942
        except StopIteration:
 
943
            raise errors.MergeModifiedFormatError()
 
944
        for s in RioReader(hashfile):
 
945
            # RioReader reads in Unicode, so convert file_ids back to utf8
 
946
            file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
 
947
            if file_id not in self.inventory:
 
948
                continue
 
949
            text_hash = s.get("hash")
 
950
            if text_hash == self.get_file_sha1(file_id):
 
951
                merge_hashes[file_id] = text_hash
 
952
        return merge_hashes
982
953
 
983
954
    @needs_write_lock
984
955
    def mkdir(self, path, file_id=None):
990
961
        return file_id
991
962
 
992
963
    def get_symlink_target(self, file_id):
993
 
        abspath = self.id2abspath(file_id)
994
 
        target = osutils.readlink(abspath)
995
 
        return target
 
964
        return os.readlink(self.id2abspath(file_id))
996
965
 
997
966
    @needs_write_lock
998
967
    def subsume(self, other_tree):
1048
1017
        return False
1049
1018
 
1050
1019
    def _directory_may_be_tree_reference(self, relpath):
1051
 
        # as a special case, if a directory contains control files then
 
1020
        # as a special case, if a directory contains control files then 
1052
1021
        # it's a tree reference, except that the root of the tree is not
1053
1022
        return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1054
1023
        # TODO: We could ask all the control formats whether they
1065
1034
    @needs_tree_write_lock
1066
1035
    def extract(self, file_id, format=None):
1067
1036
        """Extract a subtree from this tree.
1068
 
 
 
1037
        
1069
1038
        A new branch will be created, relative to the path for this tree.
1070
1039
        """
1071
1040
        self.flush()
1076
1045
                transport = transport.clone(name)
1077
1046
                transport.ensure_base()
1078
1047
            return transport
1079
 
 
 
1048
            
1080
1049
        sub_path = self.id2path(file_id)
1081
1050
        branch_transport = mkdirs(sub_path)
1082
1051
        if format is None:
1096
1065
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
1097
1066
        if tree_transport.base != branch_transport.base:
1098
1067
            tree_bzrdir = format.initialize_on_transport(tree_transport)
1099
 
            branch.BranchReferenceFormat().initialize(tree_bzrdir,
1100
 
                target_branch=new_branch)
 
1068
            branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1101
1069
        else:
1102
1070
            tree_bzrdir = branch_bzrdir
1103
 
        wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
 
1071
        wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1104
1072
        wt.set_parent_ids(self.get_parent_ids())
1105
1073
        my_inv = self.inventory
1106
 
        child_inv = inventory.Inventory(root_id=None)
 
1074
        child_inv = Inventory(root_id=None)
1107
1075
        new_root = my_inv[file_id]
1108
1076
        my_inv.remove_recursive_id(file_id)
1109
1077
        new_root.parent_id = None
1127
1095
        sio = StringIO()
1128
1096
        self._serialize(self._inventory, sio)
1129
1097
        sio.seek(0)
1130
 
        self._transport.put_file('inventory', sio,
1131
 
            mode=self.bzrdir._get_file_mode())
 
1098
        self._control_files.put('inventory', sio)
1132
1099
        self._inventory_is_modified = False
1133
1100
 
1134
1101
    def _kind(self, relpath):
1135
1102
        return osutils.file_kind(self.abspath(relpath))
1136
1103
 
1137
 
    def list_files(self, include_root=False, from_dir=None, recursive=True):
1138
 
        """List all files as (path, class, kind, id, entry).
 
1104
    def list_files(self, include_root=False):
 
1105
        """Recursively list all files as (path, class, kind, id, entry).
1139
1106
 
1140
1107
        Lists, but does not descend into unversioned directories.
 
1108
 
1141
1109
        This does not include files that have been deleted in this
1142
 
        tree. Skips the control directory.
 
1110
        tree.
1143
1111
 
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
 
1112
        Skips the control directory.
1147
1113
        """
1148
1114
        # list_files is an iterator, so @needs_read_lock doesn't work properly
1149
1115
        # with it. So callers should be careful to always read_lock the tree.
1151
1117
            raise errors.ObjectNotLocked(self)
1152
1118
 
1153
1119
        inv = self.inventory
1154
 
        if from_dir is None and include_root is True:
 
1120
        if include_root is True:
1155
1121
            yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1156
1122
        # Convert these into local objects to save lookup times
1157
1123
        pathjoin = osutils.pathjoin
1164
1130
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1165
1131
 
1166
1132
        # 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)
 
1133
        children = os.listdir(self.basedir)
1177
1134
        children.sort()
1178
 
        # jam 20060527 The kernel sized tree seems equivalent whether we
 
1135
        # jam 20060527 The kernel sized tree seems equivalent whether we 
1179
1136
        # use a deque and popleft to keep them sorted, or if we use a plain
1180
1137
        # list and just reverse() them.
1181
1138
        children = collections.deque(children)
1182
 
        stack = [(from_dir_id, u'', from_dir_abspath, children)]
 
1139
        stack = [(inv.root.file_id, u'', self.basedir, children)]
1183
1140
        while stack:
1184
1141
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1185
1142
 
1201
1158
 
1202
1159
                # absolute path
1203
1160
                fap = from_dir_abspath + '/' + f
1204
 
 
 
1161
                
1205
1162
                f_ie = inv.get_child(from_dir_id, f)
1206
1163
                if f_ie:
1207
1164
                    c = 'V'
1239
1196
                    except KeyError:
1240
1197
                        yield fp[1:], c, fk, None, TreeEntry()
1241
1198
                    continue
1242
 
 
 
1199
                
1243
1200
                if fk != 'directory':
1244
1201
                    continue
1245
1202
 
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
 
1203
                # But do this child first
 
1204
                new_children = os.listdir(fap)
 
1205
                new_children.sort()
 
1206
                new_children = collections.deque(new_children)
 
1207
                stack.append((f_ie.file_id, fp, fap, new_children))
 
1208
                # Break out of inner loop,
 
1209
                # so that we start outer loop with child
 
1210
                break
1255
1211
            else:
1256
1212
                # if we finished all children, pop it off the stack
1257
1213
                stack.pop()
1263
1219
        to_dir must exist in the inventory.
1264
1220
 
1265
1221
        If to_dir exists and is a directory, the files are moved into
1266
 
        it, keeping their old names.
 
1222
        it, keeping their old names.  
1267
1223
 
1268
1224
        Note that to_dir is only the last component of the new name;
1269
1225
        this doesn't change the directory.
1397
1353
                only_change_inv = True
1398
1354
            elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1399
1355
                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)):
 
1356
            elif (sys.platform == 'win32'
 
1357
                and from_rel.lower() == to_rel.lower()
 
1358
                and self.has_filename(from_rel)):
1403
1359
                only_change_inv = False
1404
1360
            else:
1405
1361
                # something is wrong, so lets determine what exactly
1435
1391
        inv = self.inventory
1436
1392
        for entry in moved:
1437
1393
            try:
1438
 
                self._move_entry(WorkingTree._RenameEntry(
1439
 
                    entry.to_rel, entry.from_id,
 
1394
                self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1440
1395
                    entry.to_tail, entry.to_parent_id, entry.from_rel,
1441
1396
                    entry.from_tail, entry.from_parent_id,
1442
1397
                    entry.only_change_inv))
1493
1448
        from_tail = splitpath(from_rel)[-1]
1494
1449
        from_id = inv.path2id(from_rel)
1495
1450
        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]
 
1451
            raise errors.BzrRenameFailedError(from_rel,to_rel,
 
1452
                errors.NotVersionedError(path=str(from_rel)))
 
1453
        from_entry = inv[from_id]
1507
1454
        from_parent_id = from_entry.parent_id
1508
1455
        to_dir, to_tail = os.path.split(to_rel)
1509
1456
        to_dir_id = inv.path2id(to_dir)
1555
1502
        These are files in the working directory that are not versioned or
1556
1503
        control files or ignored.
1557
1504
        """
1558
 
        # force the extras method to be fully executed before returning, to
 
1505
        # force the extras method to be fully executed before returning, to 
1559
1506
        # prevent race conditions with the lock
1560
1507
        return iter(
1561
1508
            [subp for subp in self.extras() if not self.is_ignored(subp)])
1571
1518
        :raises: NoSuchId if any fileid is not currently versioned.
1572
1519
        """
1573
1520
        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
1521
            if self._inventory.has_id(file_id):
1578
1522
                self._inventory.remove_recursive_id(file_id)
 
1523
            else:
 
1524
                raise errors.NoSuchId(self, file_id)
1579
1525
        if len(file_ids):
1580
 
            # in the future this should just set a dirty bit to wait for the
 
1526
            # in the future this should just set a dirty bit to wait for the 
1581
1527
            # final unlock. However, until all methods of workingtree start
1582
 
            # with the current in -memory inventory rather than triggering
 
1528
            # with the current in -memory inventory rather than triggering 
1583
1529
            # a read, it is more complex - we need to teach read_inventory
1584
1530
            # to know when to read, and when to not read first... and possibly
1585
1531
            # to save first when the in memory one may be corrupted.
1586
1532
            # so for now, we just only write it if it is indeed dirty.
1587
1533
            # - RBC 20060907
1588
1534
            self._write_inventory(self._inventory)
 
1535
    
 
1536
    @deprecated_method(zero_eight)
 
1537
    def iter_conflicts(self):
 
1538
        """List all files in the tree that have text or content conflicts.
 
1539
        DEPRECATED.  Use conflicts instead."""
 
1540
        return self._iter_conflicts()
1589
1541
 
1590
1542
    def _iter_conflicts(self):
1591
1543
        conflicted = set()
1600
1552
 
1601
1553
    @needs_write_lock
1602
1554
    def pull(self, source, overwrite=False, stop_revision=None,
1603
 
             change_reporter=None, possible_transports=None, local=False):
 
1555
             change_reporter=None, possible_transports=None):
 
1556
        top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1604
1557
        source.lock_read()
1605
1558
        try:
 
1559
            pp = ProgressPhase("Pull phase", 2, top_pb)
 
1560
            pp.next_phase()
1606
1561
            old_revision_info = self.branch.last_revision_info()
1607
1562
            basis_tree = self.basis_tree()
1608
1563
            count = self.branch.pull(source, overwrite, stop_revision,
1609
 
                                     possible_transports=possible_transports,
1610
 
                                     local=local)
 
1564
                                     possible_transports=possible_transports)
1611
1565
            new_revision_info = self.branch.last_revision_info()
1612
1566
            if new_revision_info != old_revision_info:
 
1567
                pp.next_phase()
1613
1568
                repository = self.branch.repository
 
1569
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
1614
1570
                basis_tree.lock_read()
1615
1571
                try:
1616
1572
                    new_basis_tree = self.branch.basis_tree()
1619
1575
                                new_basis_tree,
1620
1576
                                basis_tree,
1621
1577
                                this_tree=self,
1622
 
                                pb=None,
 
1578
                                pb=pb,
1623
1579
                                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)
 
1580
                    if (basis_tree.inventory.root is None and
 
1581
                        new_basis_tree.inventory.root is not None):
 
1582
                        self.set_root_id(new_basis_tree.get_root_id())
1628
1583
                finally:
 
1584
                    pb.finished()
1629
1585
                    basis_tree.unlock()
1630
1586
                # TODO - dedup parents list with things merged by pull ?
1631
1587
                # reuse the revisiontree we merged against to set the new
1632
1588
                # tree data.
1633
1589
                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
 
1590
                # we have to pull the merge trees out again, because 
 
1591
                # merge_inner has set the ids. - this corner is not yet 
1636
1592
                # layered well enough to prevent double handling.
1637
1593
                # XXX TODO: Fix the double handling: telling the tree about
1638
1594
                # the already known parent data is wasteful.
1644
1600
            return count
1645
1601
        finally:
1646
1602
            source.unlock()
 
1603
            top_pb.finished()
1647
1604
 
1648
1605
    @needs_write_lock
1649
1606
    def put_file_bytes_non_atomic(self, file_id, bytes):
1675
1632
 
1676
1633
            fl = []
1677
1634
            for subf in os.listdir(dirabs):
1678
 
                if self.bzrdir.is_control_filename(subf):
 
1635
                if subf == '.bzr':
1679
1636
                    continue
1680
1637
                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)
 
1638
                    subf_norm, can_access = osutils.normalized_filename(subf)
1689
1639
                    if subf_norm != subf and can_access:
1690
1640
                        if subf_norm not in dir_entry.children:
1691
1641
                            fl.append(subf_norm)
1692
1642
                    else:
1693
1643
                        fl.append(subf)
1694
 
 
 
1644
            
1695
1645
            fl.sort()
1696
1646
            for subf in fl:
1697
1647
                subp = pathjoin(path, subf)
1734
1684
        r"""Check whether the filename matches an ignore pattern.
1735
1685
 
1736
1686
        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.
 
1687
        others match against only the last component.
1740
1688
 
1741
1689
        If the file is ignored, returns the pattern which caused it to
1742
1690
        be ignored, otherwise None.  So this can simply be used as a
1743
1691
        boolean if desired."""
1744
1692
        if getattr(self, '_ignoreglobster', None) is None:
1745
 
            self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
 
1693
            self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1746
1694
        return self._ignoreglobster.match(filename)
1747
1695
 
1748
1696
    def kind(self, file_id):
1839
1787
    def _reset_data(self):
1840
1788
        """Reset transient data that cannot be revalidated."""
1841
1789
        self._inventory_is_modified = False
1842
 
        f = self._transport.get('inventory')
1843
 
        try:
1844
 
            result = self._deserialize(f)
1845
 
        finally:
1846
 
            f.close()
 
1790
        result = self._deserialize(self._control_files.get('inventory'))
1847
1791
        self._set_inventory(result, dirty=False)
1848
1792
 
1849
1793
    @needs_tree_write_lock
1854
1798
 
1855
1799
    def _change_last_revision(self, new_revision):
1856
1800
        """Template method part of set_last_revision to perform the change.
1857
 
 
 
1801
        
1858
1802
        This is used to allow WorkingTree3 instances to not affect branch
1859
1803
        when their last revision is set.
1860
1804
        """
1872
1816
        """Write the basis inventory XML to the basis-inventory file"""
1873
1817
        path = self._basis_inventory_name()
1874
1818
        sio = StringIO(xml)
1875
 
        self._transport.put_file(path, sio,
1876
 
            mode=self.bzrdir._get_file_mode())
 
1819
        self._control_files.put(path, sio)
1877
1820
 
1878
1821
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
1879
1822
        """Create the text that will be saved in basis-inventory"""
1886
1829
        # as commit already has that ready-to-use [while the format is the
1887
1830
        # same, that is].
1888
1831
        try:
1889
 
            # this double handles the inventory - unpack and repack -
 
1832
            # this double handles the inventory - unpack and repack - 
1890
1833
            # but is easier to understand. We can/should put a conditional
1891
1834
            # in here based on whether the inventory is in the latest format
1892
1835
            # - perhaps we should repack all inventories on a repository
1893
1836
            # upgrade ?
1894
1837
            # the fast path is to copy the raw xml from the repository. If the
1895
 
            # xml contains 'revision_id="', then we assume the right
 
1838
            # xml contains 'revision_id="', then we assume the right 
1896
1839
            # revision_id is set. We must check for this full string, because a
1897
1840
            # root node id can legitimately look like 'revision_id' but cannot
1898
1841
            # contain a '"'.
1899
 
            xml = self.branch.repository._get_inventory_xml(new_revision)
 
1842
            xml = self.branch.repository.get_inventory_xml(new_revision)
1900
1843
            firstline = xml.split('\n', 1)[0]
1901
 
            if (not 'revision_id="' in firstline or
 
1844
            if (not 'revision_id="' in firstline or 
1902
1845
                'format="7"' not in firstline):
1903
 
                inv = self.branch.repository._serializer.read_inventory_from_string(
1904
 
                    xml, new_revision)
 
1846
                inv = self.branch.repository.deserialise_inventory(
 
1847
                    new_revision, xml)
1905
1848
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
1906
1849
            self._write_basis_inventory(xml)
1907
1850
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
1910
1853
    def read_basis_inventory(self):
1911
1854
        """Read the cached basis inventory."""
1912
1855
        path = self._basis_inventory_name()
1913
 
        return self._transport.get_bytes(path)
1914
 
 
 
1856
        return self._control_files.get(path).read()
 
1857
        
1915
1858
    @needs_read_lock
1916
1859
    def read_working_inventory(self):
1917
1860
        """Read the working inventory.
1918
 
 
 
1861
        
1919
1862
        :raises errors.InventoryModified: read_working_inventory will fail
1920
1863
            when the current in memory inventory has been modified.
1921
1864
        """
1922
 
        # conceptually this should be an implementation detail of the tree.
 
1865
        # conceptually this should be an implementation detail of the tree. 
1923
1866
        # XXX: Deprecate this.
1924
1867
        # ElementTree does its own conversion from UTF-8, so open in
1925
1868
        # binary.
1926
1869
        if self._inventory_is_modified:
1927
1870
            raise errors.InventoryModified(self)
1928
 
        f = self._transport.get('inventory')
1929
 
        try:
1930
 
            result = self._deserialize(f)
1931
 
        finally:
1932
 
            f.close()
 
1871
        result = self._deserialize(self._control_files.get('inventory'))
1933
1872
        self._set_inventory(result, dirty=False)
1934
1873
        return result
1935
1874
 
1950
1889
 
1951
1890
        new_files=set()
1952
1891
        unknown_nested_files=set()
1953
 
        if to_file is None:
1954
 
            to_file = sys.stdout
1955
1892
 
1956
1893
        def recurse_directory_to_add_files(directory):
1957
1894
            # Recurse directory and add all files
1958
1895
            # so we can check if they have changed.
1959
1896
            for parent_info, file_infos in\
1960
 
                self.walkdirs(directory):
1961
 
                for relpath, basename, kind, lstat, fileid, kind in file_infos:
 
1897
                osutils.walkdirs(self.abspath(directory),
 
1898
                    directory):
 
1899
                for relpath, basename, kind, lstat, abspath in file_infos:
1962
1900
                    # Is it versioned or ignored?
1963
1901
                    if self.path2id(relpath) or self.is_ignored(relpath):
1964
1902
                        # Add nested content for deletion.
1974
1912
            filename = self.relpath(abspath)
1975
1913
            if len(filename) > 0:
1976
1914
                new_files.add(filename)
1977
 
                recurse_directory_to_add_files(filename)
 
1915
                if osutils.isdir(abspath):
 
1916
                    recurse_directory_to_add_files(filename)
1978
1917
 
1979
1918
        files = list(new_files)
1980
1919
 
1998
1937
                            # ... but not ignored
1999
1938
                            has_changed_files = True
2000
1939
                            break
2001
 
                    elif content_change and (kind[1] is not None):
 
1940
                    elif content_change and (kind[1] != None):
2002
1941
                        # Versioned and changed, but not deleted
2003
1942
                        has_changed_files = True
2004
1943
                        break
2013
1952
                        tree_delta.unversioned.extend((unknown_file,))
2014
1953
                raise errors.BzrRemoveChangedFilesError(tree_delta)
2015
1954
 
2016
 
        # Build inv_delta and delete files where applicable,
 
1955
        # Build inv_delta and delete files where applicaple,
2017
1956
        # do this before any modifications to inventory.
2018
1957
        for f in files:
2019
1958
            fid = self.path2id(f)
2027
1966
                        new_status = 'I'
2028
1967
                    else:
2029
1968
                        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')
 
1969
                    textui.show_status(new_status, self.kind(fid), f,
 
1970
                                       to_file=to_file)
2033
1971
                # Unversion file
2034
1972
                inv_delta.append((f, None, fid, None))
2035
1973
                message = "removed %s" % (f,)
2058
1996
 
2059
1997
    @needs_tree_write_lock
2060
1998
    def revert(self, filenames=None, old_tree=None, backups=True,
2061
 
               pb=None, report_changes=False):
 
1999
               pb=DummyProgress(), report_changes=False):
2062
2000
        from bzrlib.conflicts import resolve
2063
2001
        if filenames == []:
2064
2002
            filenames = None
2077
2015
            if filenames is None and len(self.get_parent_ids()) > 1:
2078
2016
                parent_trees = []
2079
2017
                last_revision = self.last_revision()
2080
 
                if last_revision != _mod_revision.NULL_REVISION:
 
2018
                if last_revision != NULL_REVISION:
2081
2019
                    if basis_tree is None:
2082
2020
                        basis_tree = self.basis_tree()
2083
2021
                        basis_tree.lock_read()
2121
2059
    def set_inventory(self, new_inventory_list):
2122
2060
        from bzrlib.inventory import (Inventory,
2123
2061
                                      InventoryDirectory,
 
2062
                                      InventoryEntry,
2124
2063
                                      InventoryFile,
2125
2064
                                      InventoryLink)
2126
2065
        inv = Inventory(self.get_root_id())
2128
2067
            name = os.path.basename(path)
2129
2068
            if name == "":
2130
2069
                continue
2131
 
            # fixme, there should be a factory function inv,add_??
 
2070
            # fixme, there should be a factory function inv,add_?? 
2132
2071
            if kind == 'directory':
2133
2072
                inv.add(InventoryDirectory(file_id, name, parent))
2134
2073
            elif kind == 'file':
2142
2081
    @needs_tree_write_lock
2143
2082
    def set_root_id(self, file_id):
2144
2083
        """Set the root id for this tree."""
2145
 
        # for compatability
 
2084
        # for compatability 
2146
2085
        if file_id is None:
2147
 
            raise ValueError(
2148
 
                'WorkingTree.set_root_id with fileid=None')
2149
 
        file_id = osutils.safe_file_id(file_id)
 
2086
            symbol_versioning.warn(symbol_versioning.zero_twelve
 
2087
                % 'WorkingTree.set_root_id with fileid=None',
 
2088
                DeprecationWarning,
 
2089
                stacklevel=3)
 
2090
            file_id = ROOT_ID
 
2091
        else:
 
2092
            file_id = osutils.safe_file_id(file_id)
2150
2093
        self._set_root_id(file_id)
2151
2094
 
2152
2095
    def _set_root_id(self, file_id):
2153
2096
        """Set the root id for this tree, in a format specific manner.
2154
2097
 
2155
 
        :param file_id: The file id to assign to the root. It must not be
 
2098
        :param file_id: The file id to assign to the root. It must not be 
2156
2099
            present in the current inventory or an error will occur. It must
2157
2100
            not be None, but rather a valid file id.
2158
2101
        """
2177
2120
 
2178
2121
    def unlock(self):
2179
2122
        """See Branch.unlock.
2180
 
 
 
2123
        
2181
2124
        WorkingTree locking just uses the Branch locking facilities.
2182
2125
        This is current because all working trees have an embedded branch
2183
2126
        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
 
2127
        between multiple working trees, i.e. via shared storage, then we 
2185
2128
        would probably want to lock both the local tree, and the branch.
2186
2129
        """
2187
2130
        raise NotImplementedError(self.unlock)
2188
2131
 
2189
 
    _marker = object()
2190
 
 
2191
 
    def update(self, change_reporter=None, possible_transports=None,
2192
 
               revision=None, old_tip=_marker):
 
2132
    def update(self, change_reporter=None, possible_transports=None):
2193
2133
        """Update a working tree along its branch.
2194
2134
 
2195
2135
        This will update the branch if its bound too, which means we have
2213
2153
        - Merge current state -> basis tree of the master w.r.t. the old tree
2214
2154
          basis.
2215
2155
        - 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
2156
        """
2223
2157
        if self.branch.get_bound_location() is not None:
2224
2158
            self.lock_write()
2225
 
            update_branch = (old_tip is self._marker)
 
2159
            update_branch = True
2226
2160
        else:
2227
2161
            self.lock_tree_write()
2228
2162
            update_branch = False
2230
2164
            if update_branch:
2231
2165
                old_tip = self.branch.update(possible_transports)
2232
2166
            else:
2233
 
                if old_tip is self._marker:
2234
 
                    old_tip = None
2235
 
            return self._update_tree(old_tip, change_reporter, revision)
 
2167
                old_tip = None
 
2168
            return self._update_tree(old_tip, change_reporter)
2236
2169
        finally:
2237
2170
            self.unlock()
2238
2171
 
2239
2172
    @needs_tree_write_lock
2240
 
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
 
2173
    def _update_tree(self, old_tip=None, change_reporter=None):
2241
2174
        """Update a tree to the master branch.
2242
2175
 
2243
2176
        :param old_tip: if supplied, the previous tip revision the branch,
2249
2182
        # cant set that until we update the working trees last revision to be
2250
2183
        # one from the new branch, because it will just get absorbed by the
2251
2184
        # parent de-duplication logic.
2252
 
        #
 
2185
        # 
2253
2186
        # We MUST save it even if an error occurs, because otherwise the users
2254
2187
        # local work is unreferenced and will appear to have been lost.
2255
 
        #
2256
 
        nb_conflicts = 0
 
2188
        # 
 
2189
        result = 0
2257
2190
        try:
2258
2191
            last_rev = self.get_parent_ids()[0]
2259
2192
        except IndexError:
2260
2193
            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
 
 
 
2194
        if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
 
2195
            # merge tree state up to new branch tip.
2285
2196
            basis = self.basis_tree()
2286
2197
            basis.lock_read()
2287
2198
            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)
 
2199
                to_tree = self.branch.basis_tree()
 
2200
                if basis.inventory.root is None:
 
2201
                    self.set_root_id(to_tree.get_root_id())
2291
2202
                    self.flush()
 
2203
                result += merge.merge_inner(
 
2204
                                      self.branch,
 
2205
                                      to_tree,
 
2206
                                      basis,
 
2207
                                      this_tree=self,
 
2208
                                      change_reporter=change_reporter)
2292
2209
            finally:
2293
2210
                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
2211
            # TODO - dedup parents list with things merged by pull ?
2306
2212
            # reuse the tree we've updated to to set the basis:
2307
 
            parent_trees = [(revision, to_tree)]
 
2213
            parent_trees = [(self.branch.last_revision(), to_tree)]
2308
2214
            merges = self.get_parent_ids()[1:]
2309
2215
            # 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
 
2216
            # tree can decide whether to give us teh entire tree or give us a
2311
2217
            # lazy initialised tree. dirstate for instance will have the trees
2312
2218
            # in ram already, whereas a last-revision + basis-inventory tree
2313
2219
            # will not, but also does not need them when setting parents.
2314
2220
            for parent in merges:
2315
2221
                parent_trees.append(
2316
2222
                    (parent, self.branch.repository.revision_tree(parent)))
2317
 
            if not _mod_revision.is_null(old_tip):
 
2223
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2318
2224
                parent_trees.append(
2319
2225
                    (old_tip, self.branch.repository.revision_tree(old_tip)))
2320
2226
            self.set_parent_trees(parent_trees)
2321
2227
            last_rev = parent_trees[0][0]
2322
 
        return nb_conflicts
 
2228
        else:
 
2229
            # the working tree had the same last-revision as the master
 
2230
            # branch did. We may still have pivot local work from the local
 
2231
            # branch into old_tip:
 
2232
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
 
2233
                self.add_parent_tree_id(old_tip)
 
2234
        if (old_tip is not None and not _mod_revision.is_null(old_tip)
 
2235
            and old_tip != last_rev):
 
2236
            # our last revision was not the prior branch last revision
 
2237
            # and we have converted that last revision to a pending merge.
 
2238
            # base is somewhere between the branch tip now
 
2239
            # and the now pending merge
 
2240
 
 
2241
            # Since we just modified the working tree and inventory, flush out
 
2242
            # the current state, before we modify it again.
 
2243
            # TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
 
2244
            #       requires it only because TreeTransform directly munges the
 
2245
            #       inventory and calls tree._write_inventory(). Ultimately we
 
2246
            #       should be able to remove this extra flush.
 
2247
            self.flush()
 
2248
            graph = self.branch.repository.get_graph()
 
2249
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
 
2250
                                                old_tip)
 
2251
            base_tree = self.branch.repository.revision_tree(base_rev_id)
 
2252
            other_tree = self.branch.repository.revision_tree(old_tip)
 
2253
            result += merge.merge_inner(
 
2254
                                  self.branch,
 
2255
                                  other_tree,
 
2256
                                  base_tree,
 
2257
                                  this_tree=self,
 
2258
                                  change_reporter=change_reporter)
 
2259
        return result
2323
2260
 
2324
2261
    def _write_hashcache_if_dirty(self):
2325
2262
        """Write out the hashcache if it is dirty."""
2424
2361
                    # value.
2425
2362
                    bzrdir_loc = bisect_left(cur_disk_dir_content,
2426
2363
                        ('.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])):
 
2364
                    if cur_disk_dir_content[bzrdir_loc][0] == '.bzr':
2430
2365
                        # we dont yield the contents of, or, .bzr itself.
2431
2366
                        del cur_disk_dir_content[bzrdir_loc]
2432
2367
            if inv_finished:
2522
2457
                relroot = ""
2523
2458
            # FIXME: stash the node in pending
2524
2459
            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
 
                        ))
 
2460
            for name, child in entry.sorted_children():
 
2461
                dirblock.append((relroot + name, name, child.kind, None,
 
2462
                    child.file_id, child.kind
 
2463
                    ))
2530
2464
            yield (currentdir[0], entry.file_id), dirblock
2531
2465
            # push the user specified dirs from dirblock
2532
2466
            for dir in reversed(dirblock):
2565
2499
        self.set_conflicts(un_resolved)
2566
2500
        return un_resolved, resolved
2567
2501
 
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
2502
    def _validate(self):
2588
2503
        """Validate internal structures.
2589
2504
 
2595
2510
        """
2596
2511
        return
2597
2512
 
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
2513
 
2611
2514
class WorkingTree2(WorkingTree):
2612
2515
    """This is the Format 2 working tree.
2613
2516
 
2614
 
    This was the first weave based working tree.
 
2517
    This was the first weave based working tree. 
2615
2518
     - uses os locks for locking.
2616
2519
     - uses the branch last-revision.
2617
2520
    """
2627
2530
        if self._inventory is None:
2628
2531
            self.read_working_inventory()
2629
2532
 
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
2533
    def lock_tree_write(self):
2635
2534
        """See WorkingTree.lock_tree_write().
2636
2535
 
2654
2553
            if self._inventory_is_modified:
2655
2554
                self.flush()
2656
2555
            self._write_hashcache_if_dirty()
2657
 
 
 
2556
                    
2658
2557
        # reverse order of locking.
2659
2558
        try:
2660
2559
            return self._control_files.unlock()
2676
2575
    def _last_revision(self):
2677
2576
        """See Mutable.last_revision."""
2678
2577
        try:
2679
 
            return self._transport.get_bytes('last-revision')
 
2578
            return self._control_files.get('last-revision').read()
2680
2579
        except errors.NoSuchFile:
2681
2580
            return _mod_revision.NULL_REVISION
2682
2581
 
2683
2582
    def _change_last_revision(self, revision_id):
2684
2583
        """See WorkingTree._change_last_revision."""
2685
 
        if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
 
2584
        if revision_id is None or revision_id == NULL_REVISION:
2686
2585
            try:
2687
 
                self._transport.delete('last-revision')
 
2586
                self._control_files._transport.delete('last-revision')
2688
2587
            except errors.NoSuchFile:
2689
2588
                pass
2690
2589
            return False
2691
2590
        else:
2692
 
            self._transport.put_bytes('last-revision', revision_id,
2693
 
                mode=self.bzrdir._get_file_mode())
 
2591
            self._control_files.put_bytes('last-revision', revision_id)
2694
2592
            return True
2695
2593
 
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
2594
    @needs_tree_write_lock
2701
2595
    def set_conflicts(self, conflicts):
2702
 
        self._put_rio('conflicts', conflicts.to_stanzas(),
 
2596
        self._put_rio('conflicts', conflicts.to_stanzas(), 
2703
2597
                      CONFLICT_HEADER_1)
2704
2598
 
2705
2599
    @needs_tree_write_lock
2712
2606
    @needs_read_lock
2713
2607
    def conflicts(self):
2714
2608
        try:
2715
 
            confile = self._transport.get('conflicts')
 
2609
            confile = self._control_files.get('conflicts')
2716
2610
        except errors.NoSuchFile:
2717
2611
            return _mod_conflicts.ConflictList()
2718
2612
        try:
2719
 
            try:
2720
 
                if confile.next() != CONFLICT_HEADER_1 + '\n':
2721
 
                    raise errors.ConflictFormatError()
2722
 
            except StopIteration:
 
2613
            if confile.next() != CONFLICT_HEADER_1 + '\n':
2723
2614
                raise errors.ConflictFormatError()
2724
 
            return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2725
 
        finally:
2726
 
            confile.close()
 
2615
        except StopIteration:
 
2616
            raise errors.ConflictFormatError()
 
2617
        return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2727
2618
 
2728
2619
    def unlock(self):
2729
2620
        # do non-implementation specific cleanup
2746
2637
            return path[:-len(suffix)]
2747
2638
 
2748
2639
 
 
2640
@deprecated_function(zero_eight)
 
2641
def is_control_file(filename):
 
2642
    """See WorkingTree.is_control_filename(filename)."""
 
2643
    ## FIXME: better check
 
2644
    filename = normpath(filename)
 
2645
    while filename != '':
 
2646
        head, tail = os.path.split(filename)
 
2647
        ## mutter('check %r for control file' % ((head, tail),))
 
2648
        if tail == '.bzr':
 
2649
            return True
 
2650
        if filename == head:
 
2651
            break
 
2652
        filename = head
 
2653
    return False
 
2654
 
 
2655
 
2749
2656
class WorkingTreeFormat(object):
2750
2657
    """An encapsulation of the initialization and open routines for a format.
2751
2658
 
2754
2661
     * a format string,
2755
2662
     * an open routine.
2756
2663
 
2757
 
    Formats are placed in an dict by their format string for reference
 
2664
    Formats are placed in an dict by their format string for reference 
2758
2665
    during workingtree opening. Its not required that these be instances, they
2759
 
    can be classes themselves with class methods - it simply depends on
 
2666
    can be classes themselves with class methods - it simply depends on 
2760
2667
    whether state is needed for a given format or not.
2761
2668
 
2762
2669
    Once a format is deprecated, just deprecate the initialize and open
2763
 
    methods on the format class. Do not deprecate the object, as the
 
2670
    methods on the format class. Do not deprecate the object, as the 
2764
2671
    object will be created every time regardless.
2765
2672
    """
2766
2673
 
2779
2686
        """Return the format for the working tree object in a_bzrdir."""
2780
2687
        try:
2781
2688
            transport = a_bzrdir.get_workingtree_transport(None)
2782
 
            format_string = transport.get_bytes("format")
 
2689
            format_string = transport.get("format").read()
2783
2690
            return klass._formats[format_string]
2784
2691
        except errors.NoSuchFile:
2785
2692
            raise errors.NoWorkingTree(base=transport.base)
2810
2717
        """Is this format supported?
2811
2718
 
2812
2719
        Supported formats can be initialized and opened.
2813
 
        Unsupported formats may not support initialization or committing or
 
2720
        Unsupported formats may not support initialization or committing or 
2814
2721
        some other features depending on the reason for not being supported.
2815
2722
        """
2816
2723
        return True
2817
2724
 
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
2725
    @classmethod
2827
2726
    def register_format(klass, format):
2828
2727
        klass._formats[format.get_format_string()] = format
2837
2736
 
2838
2737
 
2839
2738
class WorkingTreeFormat2(WorkingTreeFormat):
2840
 
    """The second working tree format.
 
2739
    """The second working tree format. 
2841
2740
 
2842
2741
    This format modified the hash cache from the format 1 hash cache.
2843
2742
    """
2848
2747
        """See WorkingTreeFormat.get_format_description()."""
2849
2748
        return "Working tree format 2"
2850
2749
 
2851
 
    def _stub_initialize_on_transport(self, transport, file_mode):
2852
 
        """Workaround: create control files for a remote working tree.
2853
 
 
 
2750
    def stub_initialize_remote(self, control_files):
 
2751
        """As a special workaround create critical control files for a remote working tree
 
2752
        
2854
2753
        This ensures that it can later be updated and dealt with locally,
2855
 
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
 
2754
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with 
2856
2755
        no working tree.  (See bug #43064).
2857
2756
        """
2858
2757
        sio = StringIO()
2859
 
        inv = inventory.Inventory()
 
2758
        inv = Inventory()
2860
2759
        xml5.serializer_v5.write_inventory(inv, sio, working=True)
2861
2760
        sio.seek(0)
2862
 
        transport.put_file('inventory', sio, file_mode)
2863
 
        transport.put_bytes('pending-merges', '', file_mode)
 
2761
        control_files.put('inventory', sio)
 
2762
 
 
2763
        control_files.put_bytes('pending-merges', '')
 
2764
        
2864
2765
 
2865
2766
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2866
2767
                   accelerator_tree=None, hardlink=False):
2878
2779
            branch.generate_revision_history(revision_id)
2879
2780
        finally:
2880
2781
            branch.unlock()
2881
 
        inv = inventory.Inventory()
 
2782
        inv = Inventory()
2882
2783
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2883
2784
                         branch,
2884
2785
                         inv,
2929
2830
        - is new in bzr 0.8
2930
2831
        - uses a LockDir to guard access for writes.
2931
2832
    """
2932
 
 
 
2833
    
2933
2834
    upgrade_recommended = True
2934
2835
 
2935
2836
    def get_format_string(self):
2952
2853
 
2953
2854
    def _open_control_files(self, a_bzrdir):
2954
2855
        transport = a_bzrdir.get_workingtree_transport(None)
2955
 
        return LockableFiles(transport, self._lock_file_name,
 
2856
        return LockableFiles(transport, self._lock_file_name, 
2956
2857
                             self._lock_class)
2957
2858
 
2958
2859
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2959
2860
                   accelerator_tree=None, hardlink=False):
2960
2861
        """See WorkingTreeFormat.initialize().
2961
 
 
 
2862
        
2962
2863
        :param revision_id: if supplied, create a working tree at a different
2963
2864
            revision than the branch is at.
2964
2865
        :param accelerator_tree: A tree which can be used for retrieving file
2974
2875
        control_files = self._open_control_files(a_bzrdir)
2975
2876
        control_files.create_lock()
2976
2877
        control_files.lock_write()
2977
 
        transport.put_bytes('format', self.get_format_string(),
2978
 
            mode=a_bzrdir._get_file_mode())
 
2878
        control_files.put_utf8('format', self.get_format_string())
2979
2879
        if from_branch is not None:
2980
2880
            branch = from_branch
2981
2881
        else:
3001
2901
            # only set an explicit root id if there is one to set.
3002
2902
            if basis_tree.inventory.root is not None:
3003
2903
                wt.set_root_id(basis_tree.get_root_id())
3004
 
            if revision_id == _mod_revision.NULL_REVISION:
 
2904
            if revision_id == NULL_REVISION:
3005
2905
                wt.set_parent_trees([])
3006
2906
            else:
3007
2907
                wt.set_parent_trees([(revision_id, basis_tree)])
3014
2914
        return wt
3015
2915
 
3016
2916
    def _initial_inventory(self):
3017
 
        return inventory.Inventory()
 
2917
        return Inventory()
3018
2918
 
3019
2919
    def __init__(self):
3020
2920
        super(WorkingTreeFormat3, self).__init__()
3035
2935
 
3036
2936
    def _open(self, a_bzrdir, control_files):
3037
2937
        """Open the tree itself.
3038
 
 
 
2938
        
3039
2939
        :param a_bzrdir: the dir for the tree.
3040
2940
        :param control_files: the control files for the tree.
3041
2941
        """
3049
2949
        return self.get_format_string()
3050
2950
 
3051
2951
 
3052
 
__default_format = WorkingTreeFormat6()
 
2952
__default_format = WorkingTreeFormat4()
3053
2953
WorkingTreeFormat.register_format(__default_format)
3054
 
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3055
 
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3056
2954
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3057
2955
WorkingTreeFormat.set_default_format(__default_format)
3058
2956
# formats which have no format string are not discoverable