/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

Deprecate LockableFiles.put_utf8 and put_bytes.

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,
198
222
        if not _internal:
199
223
            raise errors.BzrError("Please use bzrdir.open_workingtree or "
200
224
                "WorkingTree.open() to obtain a WorkingTree.")
 
225
        assert isinstance(basedir, basestring), \
 
226
            "base directory %r is not a string" % basedir
201
227
        basedir = safe_unicode(basedir)
202
228
        mutter("opening working tree %r", basedir)
203
229
        if deprecated_passed(branch):
211
237
            self._control_files = self.branch.control_files
212
238
        else:
213
239
            # assume all other formats have their own control files.
 
240
            assert isinstance(_control_files, LockableFiles), \
 
241
                    "_control_files must be a LockableFiles, not %r" \
 
242
                    % _control_files
214
243
            self._control_files = _control_files
215
244
        self._transport = self._control_files._transport
216
245
        # update the whole cache up front and write to disk if anything changed;
222
251
        wt_trans = self.bzrdir.get_workingtree_transport(None)
223
252
        cache_filename = wt_trans.local_abspath('stat-cache')
224
253
        self._hashcache = hashcache.HashCache(basedir, cache_filename,
225
 
            self.bzrdir._get_file_mode(),
226
 
            self._content_filter_stack_provider())
 
254
                                              self._control_files._file_mode)
227
255
        hc = self._hashcache
228
256
        hc.read()
229
257
        # is this scan needed ? it makes things kinda slow.
244
272
            # permitted to do this.
245
273
            self._set_inventory(_inventory, dirty=False)
246
274
        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
275
 
258
276
    def _detect_case_handling(self):
259
277
        wt_trans = self.bzrdir.get_workingtree_transport(None)
285
303
        self._control_files.break_lock()
286
304
        self.branch.break_lock()
287
305
 
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
306
    def requires_rich_root(self):
299
307
        return self._format.requires_rich_root
300
308
 
301
309
    def supports_tree_reference(self):
302
310
        return False
303
311
 
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
312
    def _set_inventory(self, inv, dirty):
311
313
        """Set the internal cached inventory.
312
314
 
317
319
            False then the inventory is the same as that on disk and any
318
320
            serialisation would be unneeded overhead.
319
321
        """
 
322
        assert inv.root is not None
320
323
        self._inventory = inv
321
324
        self._inventory_is_modified = dirty
322
325
 
326
329
 
327
330
        """
328
331
        if path is None:
329
 
            path = osutils.getcwd()
 
332
            path = os.path.getcwdu()
330
333
        control = bzrdir.BzrDir.open(path, _unsupported)
331
334
        return control.open_workingtree(_unsupported)
332
 
 
 
335
        
333
336
    @staticmethod
334
337
    def open_containing(path=None):
335
338
        """Open an existing working tree which has its root about path.
336
 
 
 
339
        
337
340
        This probes for a working tree at path and searches upwards from there.
338
341
 
339
342
        Basically we keep looking up until we find the control directory or
400
403
 
401
404
    def basis_tree(self):
402
405
        """Return RevisionTree for the current last revision.
403
 
 
 
406
        
404
407
        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).
 
408
        empty tree - one obtained by calling repository.revision_tree(None).
407
409
        """
408
410
        try:
409
411
            revision_id = self.get_parent_ids()[0]
411
413
            # no parents, return an empty revision tree.
412
414
            # in the future this should return the tree for
413
415
            # 'empty:' - the implicit root empty tree.
414
 
            return self.branch.repository.revision_tree(
415
 
                       _mod_revision.NULL_REVISION)
 
416
            return self.branch.repository.revision_tree(None)
416
417
        try:
417
418
            return self.revision_tree(revision_id)
418
419
        except errors.NoSuchRevision:
422
423
        # at this point ?
423
424
        try:
424
425
            return self.branch.repository.revision_tree(revision_id)
425
 
        except (errors.RevisionNotPresent, errors.NoSuchRevision):
 
426
        except errors.RevisionNotPresent:
426
427
            # 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
 
428
            # occured. If the revision is present, its a problem, if its not
428
429
            # its a ghost.
429
430
            if self.branch.repository.has_revision(revision_id):
430
431
                raise
431
432
            # the basis tree is a ghost so return an empty tree.
432
 
            return self.branch.repository.revision_tree(
433
 
                       _mod_revision.NULL_REVISION)
 
433
            return self.branch.repository.revision_tree(None)
434
434
 
435
435
    def _cleanup(self):
436
436
        self._flush_ignore_list_cache()
437
437
 
 
438
    @staticmethod
 
439
    @deprecated_method(zero_eight)
 
440
    def create(branch, directory):
 
441
        """Create a workingtree for branch at directory.
 
442
 
 
443
        If existing_directory already exists it must have a .bzr directory.
 
444
        If it does not exist, it will be created.
 
445
 
 
446
        This returns a new WorkingTree object for the new checkout.
 
447
 
 
448
        TODO FIXME RBC 20060124 when we have checkout formats in place this
 
449
        should accept an optional revisionid to checkout [and reject this if
 
450
        checking out into the same dir as a pre-checkout-aware branch format.]
 
451
 
 
452
        XXX: When BzrDir is present, these should be created through that 
 
453
        interface instead.
 
454
        """
 
455
        warnings.warn('delete WorkingTree.create', stacklevel=3)
 
456
        transport = get_transport(directory)
 
457
        if branch.bzrdir.root_transport.base == transport.base:
 
458
            # same dir 
 
459
            return branch.bzrdir.create_workingtree()
 
460
        # different directory, 
 
461
        # create a branch reference
 
462
        # and now a working tree.
 
463
        raise NotImplementedError
 
464
 
 
465
    @staticmethod
 
466
    @deprecated_method(zero_eight)
 
467
    def create_standalone(directory):
 
468
        """Create a checkout and a branch and a repo at directory.
 
469
 
 
470
        Directory must exist and be empty.
 
471
 
 
472
        please use BzrDir.create_standalone_workingtree
 
473
        """
 
474
        return bzrdir.BzrDir.create_standalone_workingtree(directory)
 
475
 
438
476
    def relpath(self, path):
439
477
        """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
 
478
        
 
479
        The path may be absolute or relative. If its a relative path it is 
442
480
        interpreted relative to the python current working directory.
443
481
        """
444
482
        return osutils.relpath(self.basedir, path)
446
484
    def has_filename(self, filename):
447
485
        return osutils.lexists(self.abspath(filename))
448
486
 
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."""
 
487
    def get_file(self, file_id, path=None):
455
488
        if path is None:
456
489
            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()
 
490
        return self.get_file_byname(path)
 
491
 
 
492
    def get_file_text(self, file_id):
 
493
        return self.get_file(file_id).read()
 
494
 
 
495
    def get_file_byname(self, filename):
 
496
        return file(self.abspath(filename), 'rb')
483
497
 
484
498
    @needs_read_lock
485
499
    def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
492
506
        incorrectly attributed to CURRENT_REVISION (but after committing, the
493
507
        attribution will be correct).
494
508
        """
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
 
509
        basis = self.basis_tree()
 
510
        basis.lock_read()
 
511
        try:
 
512
            changes = self.iter_changes(basis, True, [self.id2path(file_id)],
 
513
                require_versioned=True).next()
 
514
            changed_content, kind = changes[2], changes[6]
 
515
            if not changed_content:
 
516
                return basis.annotate_iter(file_id)
 
517
            if kind[1] is None:
 
518
                return None
 
519
            import annotate
 
520
            if kind[0] != 'file':
 
521
                old_lines = []
 
522
            else:
 
523
                old_lines = list(basis.annotate_iter(file_id))
 
524
            old = [old_lines]
 
525
            for tree in self.branch.repository.revision_trees(
 
526
                self.get_parent_ids()[1:]):
 
527
                if file_id not in tree:
 
528
                    continue
 
529
                old.append(list(tree.annotate_iter(file_id)))
 
530
            return annotate.reannotate(old, self.get_file(file_id).readlines(),
 
531
                                       default_revision)
 
532
        finally:
 
533
            basis.unlock()
531
534
 
532
535
    def _get_ancestors(self, default_revision):
533
536
        ancestors = set([default_revision])
538
541
 
539
542
    def get_parent_ids(self):
540
543
        """See Tree.get_parent_ids.
541
 
 
 
544
        
542
545
        This implementation reads the pending merges list and last_revision
543
546
        value and uses that to decide what the parents list should be.
544
547
        """
548
551
        else:
549
552
            parents = [last_rev]
550
553
        try:
551
 
            merges_bytes = self._transport.get_bytes('pending-merges')
 
554
            merges_file = self._control_files._transport.get('pending-merges')
552
555
        except errors.NoSuchFile:
553
556
            pass
554
557
        else:
555
 
            for l in osutils.split_lines(merges_bytes):
 
558
            for l in merges_file.readlines():
556
559
                revision_id = l.rstrip('\n')
557
560
                parents.append(revision_id)
558
561
        return parents
561
564
    def get_root_id(self):
562
565
        """Return the id of this trees root"""
563
566
        return self._inventory.root.file_id
564
 
 
 
567
        
565
568
    def _get_store_filename(self, file_id):
566
569
        ## XXX: badly named; this is not in the store at all
567
570
        return self.abspath(self.id2path(file_id))
569
572
    @needs_read_lock
570
573
    def clone(self, to_bzrdir, revision_id=None):
571
574
        """Duplicate this working tree into to_bzr, including all state.
572
 
 
 
575
        
573
576
        Specifically modified files are kept as modified, but
574
577
        ignored and unknown files are discarded.
575
578
 
576
579
        If you want to make a new line of development, see bzrdir.sprout()
577
580
 
578
581
        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
 
582
            If not None, the cloned tree will have its last revision set to 
 
583
            revision, and and difference between the source trees last revision
581
584
            and this one merged in.
582
585
        """
583
586
        # assumes the target bzr dir format is compatible.
584
 
        result = to_bzrdir.create_workingtree()
 
587
        result = self._format.initialize(to_bzrdir)
585
588
        self.copy_content_into(result, revision_id)
586
589
        return result
587
590
 
617
620
 
618
621
    def get_file_size(self, file_id):
619
622
        """See Tree.get_file_size"""
620
 
        # XXX: this returns the on-disk size; it should probably return the
621
 
        # canonical size
622
623
        try:
623
624
            return os.path.getsize(self.id2abspath(file_id))
624
625
        except OSError, e:
640
641
 
641
642
    def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
642
643
        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
644
        return self._inventory[file_id].executable
648
645
 
649
646
    def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
671
668
        """See MutableTree._add."""
672
669
        # TODO: Re-adding a file that is removed in the working copy
673
670
        # should probably put it back with the previous ID.
674
 
        # the read and write working inventory should not occur in this
 
671
        # the read and write working inventory should not occur in this 
675
672
        # function - they should be part of lock_write and unlock.
676
673
        inv = self.inventory
677
674
        for f, file_id, kind in zip(files, ids, kinds):
 
675
            assert kind is not None
678
676
            if file_id is None:
679
677
                inv.add_path(f, kind=kind)
680
678
            else:
759
757
            raise
760
758
        kind = _mapper(stat_result.st_mode)
761
759
        if kind == 'file':
762
 
            return self._file_content_summary(path, stat_result)
 
760
            size = stat_result.st_size
 
761
            # try for a stat cache lookup
 
762
            executable = self._is_executable_from_path_and_stat(path, stat_result)
 
763
            return (kind, size, executable, self._sha_from_stat(
 
764
                path, stat_result))
763
765
        elif kind == 'directory':
764
766
            # perhaps it looks like a plain directory, but it's really a
765
767
            # reference.
767
769
                kind = 'tree-reference'
768
770
            return kind, None, None, None
769
771
        elif kind == 'symlink':
770
 
            target = osutils.readlink(abspath)
771
 
            return ('symlink', None, None, target)
 
772
            return ('symlink', None, None, os.readlink(abspath))
772
773
        else:
773
774
            return (kind, None, None, None)
774
775
 
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))
 
776
    @deprecated_method(zero_eleven)
 
777
    @needs_read_lock
 
778
    def pending_merges(self):
 
779
        """Return a list of pending merges.
 
780
 
 
781
        These are revisions that have been merged into the working
 
782
        directory but not yet committed.
 
783
 
 
784
        As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
 
785
        instead - which is available on all tree objects.
 
786
        """
 
787
        return self.get_parent_ids()[1:]
781
788
 
782
789
    def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
783
790
        """Common ghost checking functionality from set_parent_*.
794
801
    def _set_merges_from_parent_ids(self, parent_ids):
795
802
        merges = parent_ids[1:]
796
803
        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
 
804
            mode=self._control_files._file_mode)
817
805
 
818
806
    @needs_tree_write_lock
819
807
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
820
808
        """Set the parent ids to revision_ids.
821
 
 
 
809
        
822
810
        See also set_parent_trees. This api will try to retrieve the tree data
823
811
        for each element of revision_ids from the trees repository. If you have
824
812
        tree data already available, it is more efficient to use
833
821
        for revision_id in revision_ids:
834
822
            _mod_revision.check_not_reserved_id(revision_id)
835
823
 
836
 
        revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
837
 
 
838
824
        if len(revision_ids) > 0:
839
825
            self.set_last_revision(revision_ids[0])
840
826
        else:
852
838
        self._check_parents_for_ghosts(parent_ids,
853
839
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
854
840
 
855
 
        parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
856
 
 
857
841
        if len(parent_ids) == 0:
858
842
            leftmost_parent_id = _mod_revision.NULL_REVISION
859
843
            leftmost_parent_tree = None
900
884
        self._must_be_locked()
901
885
        my_file = rio_file(stanzas, header)
902
886
        self._transport.put_file(filename, my_file,
903
 
            mode=self.bzrdir._get_file_mode())
 
887
            mode=self._control_files._file_mode)
904
888
 
905
889
    @needs_write_lock # because merge pulls data into the branch.
906
890
    def merge_from_branch(self, branch, to_revision=None, from_revision=None,
907
 
                          merge_type=None, force=False):
 
891
        merge_type=None):
908
892
        """Merge from a branch into this working tree.
909
893
 
910
894
        :param branch: The branch to merge from.
914
898
            branch.last_revision().
915
899
        """
916
900
        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()
 
901
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
902
        try:
 
903
            merger = Merger(self.branch, this_tree=self, pb=pb)
 
904
            merger.pp = ProgressPhase("Merge phase", 5, pb)
 
905
            merger.pp.next_phase()
 
906
            # check that there are no
 
907
            # local alterations
 
908
            merger.check_basis(check_clean=True, require_commits=False)
 
909
            if to_revision is None:
 
910
                to_revision = _mod_revision.ensure_null(branch.last_revision())
 
911
            merger.other_rev_id = to_revision
 
912
            if _mod_revision.is_null(merger.other_rev_id):
 
913
                raise errors.NoCommits(branch)
 
914
            self.branch.fetch(branch, last_revision=merger.other_rev_id)
 
915
            merger.other_basis = merger.other_rev_id
 
916
            merger.other_tree = self.branch.repository.revision_tree(
 
917
                merger.other_rev_id)
 
918
            merger.other_branch = branch
 
919
            merger.pp.next_phase()
 
920
            if from_revision is None:
 
921
                merger.find_base()
 
922
            else:
 
923
                merger.set_base_revision(from_revision, branch)
 
924
            if merger.base_rev_id == merger.other_rev_id:
 
925
                raise errors.PointlessMerge
 
926
            merger.backup_files = False
 
927
            if merge_type is None:
 
928
                merger.merge_type = Merge3Merger
 
929
            else:
 
930
                merger.merge_type = merge_type
 
931
            merger.set_interesting_files(None)
 
932
            merger.show_base = False
 
933
            merger.reprocess = False
 
934
            conflicts = merger.do_merge()
 
935
            merger.set_pending()
 
936
        finally:
 
937
            pb.finished()
947
938
        return conflicts
948
939
 
949
940
    @needs_read_lock
950
941
    def merge_modified(self):
951
942
        """Return a dictionary of files modified by a merge.
952
943
 
953
 
        The list is initialized by WorkingTree.set_merge_modified, which is
 
944
        The list is initialized by WorkingTree.set_merge_modified, which is 
954
945
        typically called after we make some automatic updates to the tree
955
946
        because of a merge.
956
947
 
958
949
        still in the working inventory and have that text hash.
959
950
        """
960
951
        try:
961
 
            hashfile = self._transport.get('merge-hashes')
 
952
            hashfile = self._control_files._transport.get('merge-hashes')
962
953
        except errors.NoSuchFile:
963
954
            return {}
 
955
        merge_hashes = {}
964
956
        try:
965
 
            merge_hashes = {}
966
 
            try:
967
 
                if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
968
 
                    raise errors.MergeModifiedFormatError()
969
 
            except StopIteration:
 
957
            if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
970
958
                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()
 
959
        except StopIteration:
 
960
            raise errors.MergeModifiedFormatError()
 
961
        for s in RioReader(hashfile):
 
962
            # RioReader reads in Unicode, so convert file_ids back to utf8
 
963
            file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
 
964
            if file_id not in self.inventory:
 
965
                continue
 
966
            text_hash = s.get("hash")
 
967
            if text_hash == self.get_file_sha1(file_id):
 
968
                merge_hashes[file_id] = text_hash
 
969
        return merge_hashes
982
970
 
983
971
    @needs_write_lock
984
972
    def mkdir(self, path, file_id=None):
990
978
        return file_id
991
979
 
992
980
    def get_symlink_target(self, file_id):
993
 
        abspath = self.id2abspath(file_id)
994
 
        target = osutils.readlink(abspath)
995
 
        return target
 
981
        return os.readlink(self.id2abspath(file_id))
996
982
 
997
983
    @needs_write_lock
998
984
    def subsume(self, other_tree):
1048
1034
        return False
1049
1035
 
1050
1036
    def _directory_may_be_tree_reference(self, relpath):
1051
 
        # as a special case, if a directory contains control files then
 
1037
        # as a special case, if a directory contains control files then 
1052
1038
        # it's a tree reference, except that the root of the tree is not
1053
1039
        return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1054
1040
        # TODO: We could ask all the control formats whether they
1065
1051
    @needs_tree_write_lock
1066
1052
    def extract(self, file_id, format=None):
1067
1053
        """Extract a subtree from this tree.
1068
 
 
 
1054
        
1069
1055
        A new branch will be created, relative to the path for this tree.
1070
1056
        """
1071
1057
        self.flush()
1076
1062
                transport = transport.clone(name)
1077
1063
                transport.ensure_base()
1078
1064
            return transport
1079
 
 
 
1065
            
1080
1066
        sub_path = self.id2path(file_id)
1081
1067
        branch_transport = mkdirs(sub_path)
1082
1068
        if format is None:
1096
1082
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
1097
1083
        if tree_transport.base != branch_transport.base:
1098
1084
            tree_bzrdir = format.initialize_on_transport(tree_transport)
1099
 
            branch.BranchReferenceFormat().initialize(tree_bzrdir,
1100
 
                target_branch=new_branch)
 
1085
            branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1101
1086
        else:
1102
1087
            tree_bzrdir = branch_bzrdir
1103
 
        wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
 
1088
        wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1104
1089
        wt.set_parent_ids(self.get_parent_ids())
1105
1090
        my_inv = self.inventory
1106
 
        child_inv = inventory.Inventory(root_id=None)
 
1091
        child_inv = Inventory(root_id=None)
1107
1092
        new_root = my_inv[file_id]
1108
1093
        my_inv.remove_recursive_id(file_id)
1109
1094
        new_root.parent_id = None
1128
1113
        self._serialize(self._inventory, sio)
1129
1114
        sio.seek(0)
1130
1115
        self._transport.put_file('inventory', sio,
1131
 
            mode=self.bzrdir._get_file_mode())
 
1116
            mode=self._control_files._file_mode)
1132
1117
        self._inventory_is_modified = False
1133
1118
 
1134
1119
    def _kind(self, relpath):
1135
1120
        return osutils.file_kind(self.abspath(relpath))
1136
1121
 
1137
 
    def list_files(self, include_root=False, from_dir=None, recursive=True):
1138
 
        """List all files as (path, class, kind, id, entry).
 
1122
    def list_files(self, include_root=False):
 
1123
        """Recursively list all files as (path, class, kind, id, entry).
1139
1124
 
1140
1125
        Lists, but does not descend into unversioned directories.
 
1126
 
1141
1127
        This does not include files that have been deleted in this
1142
 
        tree. Skips the control directory.
 
1128
        tree.
1143
1129
 
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
 
1130
        Skips the control directory.
1147
1131
        """
1148
1132
        # list_files is an iterator, so @needs_read_lock doesn't work properly
1149
1133
        # with it. So callers should be careful to always read_lock the tree.
1151
1135
            raise errors.ObjectNotLocked(self)
1152
1136
 
1153
1137
        inv = self.inventory
1154
 
        if from_dir is None and include_root is True:
 
1138
        if include_root is True:
1155
1139
            yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1156
1140
        # Convert these into local objects to save lookup times
1157
1141
        pathjoin = osutils.pathjoin
1164
1148
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1165
1149
 
1166
1150
        # 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)
 
1151
        children = os.listdir(self.basedir)
1177
1152
        children.sort()
1178
 
        # jam 20060527 The kernel sized tree seems equivalent whether we
 
1153
        # jam 20060527 The kernel sized tree seems equivalent whether we 
1179
1154
        # use a deque and popleft to keep them sorted, or if we use a plain
1180
1155
        # list and just reverse() them.
1181
1156
        children = collections.deque(children)
1182
 
        stack = [(from_dir_id, u'', from_dir_abspath, children)]
 
1157
        stack = [(inv.root.file_id, u'', self.basedir, children)]
1183
1158
        while stack:
1184
1159
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1185
1160
 
1201
1176
 
1202
1177
                # absolute path
1203
1178
                fap = from_dir_abspath + '/' + f
1204
 
 
 
1179
                
1205
1180
                f_ie = inv.get_child(from_dir_id, f)
1206
1181
                if f_ie:
1207
1182
                    c = 'V'
1239
1214
                    except KeyError:
1240
1215
                        yield fp[1:], c, fk, None, TreeEntry()
1241
1216
                    continue
1242
 
 
 
1217
                
1243
1218
                if fk != 'directory':
1244
1219
                    continue
1245
1220
 
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
 
1221
                # But do this child first
 
1222
                new_children = os.listdir(fap)
 
1223
                new_children.sort()
 
1224
                new_children = collections.deque(new_children)
 
1225
                stack.append((f_ie.file_id, fp, fap, new_children))
 
1226
                # Break out of inner loop,
 
1227
                # so that we start outer loop with child
 
1228
                break
1255
1229
            else:
1256
1230
                # if we finished all children, pop it off the stack
1257
1231
                stack.pop()
1263
1237
        to_dir must exist in the inventory.
1264
1238
 
1265
1239
        If to_dir exists and is a directory, the files are moved into
1266
 
        it, keeping their old names.
 
1240
        it, keeping their old names.  
1267
1241
 
1268
1242
        Note that to_dir is only the last component of the new name;
1269
1243
        this doesn't change the directory.
1306
1280
                                       DeprecationWarning)
1307
1281
 
1308
1282
        # check destination directory
1309
 
        if isinstance(from_paths, basestring):
1310
 
            raise ValueError()
 
1283
        assert not isinstance(from_paths, basestring)
1311
1284
        inv = self.inventory
1312
1285
        to_abs = self.abspath(to_dir)
1313
1286
        if not isdir(to_abs):
1397
1370
                only_change_inv = True
1398
1371
            elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1399
1372
                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)):
 
1373
            elif (sys.platform == 'win32'
 
1374
                and from_rel.lower() == to_rel.lower()
 
1375
                and self.has_filename(from_rel)):
1403
1376
                only_change_inv = False
1404
1377
            else:
1405
1378
                # something is wrong, so lets determine what exactly
1435
1408
        inv = self.inventory
1436
1409
        for entry in moved:
1437
1410
            try:
1438
 
                self._move_entry(WorkingTree._RenameEntry(
1439
 
                    entry.to_rel, entry.from_id,
 
1411
                self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1440
1412
                    entry.to_tail, entry.to_parent_id, entry.from_rel,
1441
1413
                    entry.from_tail, entry.from_parent_id,
1442
1414
                    entry.only_change_inv))
1493
1465
        from_tail = splitpath(from_rel)[-1]
1494
1466
        from_id = inv.path2id(from_rel)
1495
1467
        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]
 
1468
            raise errors.BzrRenameFailedError(from_rel,to_rel,
 
1469
                errors.NotVersionedError(path=str(from_rel)))
 
1470
        from_entry = inv[from_id]
1507
1471
        from_parent_id = from_entry.parent_id
1508
1472
        to_dir, to_tail = os.path.split(to_rel)
1509
1473
        to_dir_id = inv.path2id(to_dir)
1555
1519
        These are files in the working directory that are not versioned or
1556
1520
        control files or ignored.
1557
1521
        """
1558
 
        # force the extras method to be fully executed before returning, to
 
1522
        # force the extras method to be fully executed before returning, to 
1559
1523
        # prevent race conditions with the lock
1560
1524
        return iter(
1561
1525
            [subp for subp in self.extras() if not self.is_ignored(subp)])
1571
1535
        :raises: NoSuchId if any fileid is not currently versioned.
1572
1536
        """
1573
1537
        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
1538
            if self._inventory.has_id(file_id):
1578
1539
                self._inventory.remove_recursive_id(file_id)
 
1540
            else:
 
1541
                raise errors.NoSuchId(self, file_id)
1579
1542
        if len(file_ids):
1580
 
            # in the future this should just set a dirty bit to wait for the
 
1543
            # in the future this should just set a dirty bit to wait for the 
1581
1544
            # final unlock. However, until all methods of workingtree start
1582
 
            # with the current in -memory inventory rather than triggering
 
1545
            # with the current in -memory inventory rather than triggering 
1583
1546
            # a read, it is more complex - we need to teach read_inventory
1584
1547
            # to know when to read, and when to not read first... and possibly
1585
1548
            # to save first when the in memory one may be corrupted.
1586
1549
            # so for now, we just only write it if it is indeed dirty.
1587
1550
            # - RBC 20060907
1588
1551
            self._write_inventory(self._inventory)
 
1552
    
 
1553
    @deprecated_method(zero_eight)
 
1554
    def iter_conflicts(self):
 
1555
        """List all files in the tree that have text or content conflicts.
 
1556
        DEPRECATED.  Use conflicts instead."""
 
1557
        return self._iter_conflicts()
1589
1558
 
1590
1559
    def _iter_conflicts(self):
1591
1560
        conflicted = set()
1600
1569
 
1601
1570
    @needs_write_lock
1602
1571
    def pull(self, source, overwrite=False, stop_revision=None,
1603
 
             change_reporter=None, possible_transports=None, local=False):
 
1572
             change_reporter=None, possible_transports=None):
 
1573
        top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1604
1574
        source.lock_read()
1605
1575
        try:
 
1576
            pp = ProgressPhase("Pull phase", 2, top_pb)
 
1577
            pp.next_phase()
1606
1578
            old_revision_info = self.branch.last_revision_info()
1607
1579
            basis_tree = self.basis_tree()
1608
1580
            count = self.branch.pull(source, overwrite, stop_revision,
1609
 
                                     possible_transports=possible_transports,
1610
 
                                     local=local)
 
1581
                                     possible_transports=possible_transports)
1611
1582
            new_revision_info = self.branch.last_revision_info()
1612
1583
            if new_revision_info != old_revision_info:
 
1584
                pp.next_phase()
1613
1585
                repository = self.branch.repository
 
1586
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
1614
1587
                basis_tree.lock_read()
1615
1588
                try:
1616
1589
                    new_basis_tree = self.branch.basis_tree()
1619
1592
                                new_basis_tree,
1620
1593
                                basis_tree,
1621
1594
                                this_tree=self,
1622
 
                                pb=None,
 
1595
                                pb=pb,
1623
1596
                                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)
 
1597
                    if (basis_tree.inventory.root is None and
 
1598
                        new_basis_tree.inventory.root is not None):
 
1599
                        self.set_root_id(new_basis_tree.get_root_id())
1628
1600
                finally:
 
1601
                    pb.finished()
1629
1602
                    basis_tree.unlock()
1630
1603
                # TODO - dedup parents list with things merged by pull ?
1631
1604
                # reuse the revisiontree we merged against to set the new
1632
1605
                # tree data.
1633
1606
                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
 
1607
                # we have to pull the merge trees out again, because 
 
1608
                # merge_inner has set the ids. - this corner is not yet 
1636
1609
                # layered well enough to prevent double handling.
1637
1610
                # XXX TODO: Fix the double handling: telling the tree about
1638
1611
                # the already known parent data is wasteful.
1644
1617
            return count
1645
1618
        finally:
1646
1619
            source.unlock()
 
1620
            top_pb.finished()
1647
1621
 
1648
1622
    @needs_write_lock
1649
1623
    def put_file_bytes_non_atomic(self, file_id, bytes):
1675
1649
 
1676
1650
            fl = []
1677
1651
            for subf in os.listdir(dirabs):
1678
 
                if self.bzrdir.is_control_filename(subf):
 
1652
                if subf == '.bzr':
1679
1653
                    continue
1680
1654
                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)
 
1655
                    subf_norm, can_access = osutils.normalized_filename(subf)
1689
1656
                    if subf_norm != subf and can_access:
1690
1657
                        if subf_norm not in dir_entry.children:
1691
1658
                            fl.append(subf_norm)
1692
1659
                    else:
1693
1660
                        fl.append(subf)
1694
 
 
 
1661
            
1695
1662
            fl.sort()
1696
1663
            for subf in fl:
1697
1664
                subp = pathjoin(path, subf)
1734
1701
        r"""Check whether the filename matches an ignore pattern.
1735
1702
 
1736
1703
        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.
 
1704
        others match against only the last component.
1740
1705
 
1741
1706
        If the file is ignored, returns the pattern which caused it to
1742
1707
        be ignored, otherwise None.  So this can simply be used as a
1743
1708
        boolean if desired."""
1744
1709
        if getattr(self, '_ignoreglobster', None) is None:
1745
 
            self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
 
1710
            self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1746
1711
        return self._ignoreglobster.match(filename)
1747
1712
 
1748
1713
    def kind(self, file_id):
1839
1804
    def _reset_data(self):
1840
1805
        """Reset transient data that cannot be revalidated."""
1841
1806
        self._inventory_is_modified = False
1842
 
        f = self._transport.get('inventory')
1843
 
        try:
1844
 
            result = self._deserialize(f)
1845
 
        finally:
1846
 
            f.close()
 
1807
        result = self._deserialize(self._transport.get('inventory'))
1847
1808
        self._set_inventory(result, dirty=False)
1848
1809
 
1849
1810
    @needs_tree_write_lock
1854
1815
 
1855
1816
    def _change_last_revision(self, new_revision):
1856
1817
        """Template method part of set_last_revision to perform the change.
1857
 
 
 
1818
        
1858
1819
        This is used to allow WorkingTree3 instances to not affect branch
1859
1820
        when their last revision is set.
1860
1821
        """
1870
1831
 
1871
1832
    def _write_basis_inventory(self, xml):
1872
1833
        """Write the basis inventory XML to the basis-inventory file"""
 
1834
        assert isinstance(xml, str), 'serialised xml must be bytestring.'
1873
1835
        path = self._basis_inventory_name()
1874
1836
        sio = StringIO(xml)
1875
1837
        self._transport.put_file(path, sio,
1876
 
            mode=self.bzrdir._get_file_mode())
 
1838
            mode=self._control_files._file_mode)
1877
1839
 
1878
1840
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
1879
1841
        """Create the text that will be saved in basis-inventory"""
1886
1848
        # as commit already has that ready-to-use [while the format is the
1887
1849
        # same, that is].
1888
1850
        try:
1889
 
            # this double handles the inventory - unpack and repack -
 
1851
            # this double handles the inventory - unpack and repack - 
1890
1852
            # but is easier to understand. We can/should put a conditional
1891
1853
            # in here based on whether the inventory is in the latest format
1892
1854
            # - perhaps we should repack all inventories on a repository
1893
1855
            # upgrade ?
1894
1856
            # the fast path is to copy the raw xml from the repository. If the
1895
 
            # xml contains 'revision_id="', then we assume the right
 
1857
            # xml contains 'revision_id="', then we assume the right 
1896
1858
            # revision_id is set. We must check for this full string, because a
1897
1859
            # root node id can legitimately look like 'revision_id' but cannot
1898
1860
            # contain a '"'.
1899
 
            xml = self.branch.repository._get_inventory_xml(new_revision)
 
1861
            xml = self.branch.repository.get_inventory_xml(new_revision)
1900
1862
            firstline = xml.split('\n', 1)[0]
1901
 
            if (not 'revision_id="' in firstline or
 
1863
            if (not 'revision_id="' in firstline or 
1902
1864
                'format="7"' not in firstline):
1903
 
                inv = self.branch.repository._serializer.read_inventory_from_string(
1904
 
                    xml, new_revision)
 
1865
                inv = self.branch.repository.deserialise_inventory(
 
1866
                    new_revision, xml)
1905
1867
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
1906
1868
            self._write_basis_inventory(xml)
1907
1869
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
1910
1872
    def read_basis_inventory(self):
1911
1873
        """Read the cached basis inventory."""
1912
1874
        path = self._basis_inventory_name()
1913
 
        return self._transport.get_bytes(path)
1914
 
 
 
1875
        return self._control_files._transport.get_bytes(path)
 
1876
        
1915
1877
    @needs_read_lock
1916
1878
    def read_working_inventory(self):
1917
1879
        """Read the working inventory.
1918
 
 
 
1880
        
1919
1881
        :raises errors.InventoryModified: read_working_inventory will fail
1920
1882
            when the current in memory inventory has been modified.
1921
1883
        """
1922
 
        # conceptually this should be an implementation detail of the tree.
 
1884
        # conceptually this should be an implementation detail of the tree. 
1923
1885
        # XXX: Deprecate this.
1924
1886
        # ElementTree does its own conversion from UTF-8, so open in
1925
1887
        # binary.
1926
1888
        if self._inventory_is_modified:
1927
1889
            raise errors.InventoryModified(self)
1928
 
        f = self._transport.get('inventory')
1929
 
        try:
1930
 
            result = self._deserialize(f)
1931
 
        finally:
1932
 
            f.close()
 
1890
        result = self._deserialize(self._control_files._transport.get('inventory'))
1933
1891
        self._set_inventory(result, dirty=False)
1934
1892
        return result
1935
1893
 
1950
1908
 
1951
1909
        new_files=set()
1952
1910
        unknown_nested_files=set()
1953
 
        if to_file is None:
1954
 
            to_file = sys.stdout
1955
1911
 
1956
1912
        def recurse_directory_to_add_files(directory):
1957
1913
            # Recurse directory and add all files
1958
1914
            # so we can check if they have changed.
1959
1915
            for parent_info, file_infos in\
1960
 
                self.walkdirs(directory):
1961
 
                for relpath, basename, kind, lstat, fileid, kind in file_infos:
 
1916
                osutils.walkdirs(self.abspath(directory),
 
1917
                    directory):
 
1918
                for relpath, basename, kind, lstat, abspath in file_infos:
1962
1919
                    # Is it versioned or ignored?
1963
1920
                    if self.path2id(relpath) or self.is_ignored(relpath):
1964
1921
                        # Add nested content for deletion.
1974
1931
            filename = self.relpath(abspath)
1975
1932
            if len(filename) > 0:
1976
1933
                new_files.add(filename)
1977
 
                recurse_directory_to_add_files(filename)
 
1934
                if osutils.isdir(abspath):
 
1935
                    recurse_directory_to_add_files(filename)
1978
1936
 
1979
1937
        files = list(new_files)
1980
1938
 
1998
1956
                            # ... but not ignored
1999
1957
                            has_changed_files = True
2000
1958
                            break
2001
 
                    elif content_change and (kind[1] is not None):
 
1959
                    elif content_change and (kind[1] != None):
2002
1960
                        # Versioned and changed, but not deleted
2003
1961
                        has_changed_files = True
2004
1962
                        break
2013
1971
                        tree_delta.unversioned.extend((unknown_file,))
2014
1972
                raise errors.BzrRemoveChangedFilesError(tree_delta)
2015
1973
 
2016
 
        # Build inv_delta and delete files where applicable,
 
1974
        # Build inv_delta and delete files where applicaple,
2017
1975
        # do this before any modifications to inventory.
2018
1976
        for f in files:
2019
1977
            fid = self.path2id(f)
2027
1985
                        new_status = 'I'
2028
1986
                    else:
2029
1987
                        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')
 
1988
                    textui.show_status(new_status, self.kind(fid), f,
 
1989
                                       to_file=to_file)
2033
1990
                # Unversion file
2034
1991
                inv_delta.append((f, None, fid, None))
2035
1992
                message = "removed %s" % (f,)
2058
2015
 
2059
2016
    @needs_tree_write_lock
2060
2017
    def revert(self, filenames=None, old_tree=None, backups=True,
2061
 
               pb=None, report_changes=False):
 
2018
               pb=DummyProgress(), report_changes=False):
2062
2019
        from bzrlib.conflicts import resolve
2063
2020
        if filenames == []:
2064
2021
            filenames = None
2077
2034
            if filenames is None and len(self.get_parent_ids()) > 1:
2078
2035
                parent_trees = []
2079
2036
                last_revision = self.last_revision()
2080
 
                if last_revision != _mod_revision.NULL_REVISION:
 
2037
                if last_revision != NULL_REVISION:
2081
2038
                    if basis_tree is None:
2082
2039
                        basis_tree = self.basis_tree()
2083
2040
                        basis_tree.lock_read()
2121
2078
    def set_inventory(self, new_inventory_list):
2122
2079
        from bzrlib.inventory import (Inventory,
2123
2080
                                      InventoryDirectory,
 
2081
                                      InventoryEntry,
2124
2082
                                      InventoryFile,
2125
2083
                                      InventoryLink)
2126
2084
        inv = Inventory(self.get_root_id())
2128
2086
            name = os.path.basename(path)
2129
2087
            if name == "":
2130
2088
                continue
2131
 
            # fixme, there should be a factory function inv,add_??
 
2089
            # fixme, there should be a factory function inv,add_?? 
2132
2090
            if kind == 'directory':
2133
2091
                inv.add(InventoryDirectory(file_id, name, parent))
2134
2092
            elif kind == 'file':
2142
2100
    @needs_tree_write_lock
2143
2101
    def set_root_id(self, file_id):
2144
2102
        """Set the root id for this tree."""
2145
 
        # for compatability
 
2103
        # for compatability 
2146
2104
        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)
 
2105
            symbol_versioning.warn(symbol_versioning.zero_twelve
 
2106
                % 'WorkingTree.set_root_id with fileid=None',
 
2107
                DeprecationWarning,
 
2108
                stacklevel=3)
 
2109
            file_id = ROOT_ID
 
2110
        else:
 
2111
            file_id = osutils.safe_file_id(file_id)
2150
2112
        self._set_root_id(file_id)
2151
2113
 
2152
2114
    def _set_root_id(self, file_id):
2153
2115
        """Set the root id for this tree, in a format specific manner.
2154
2116
 
2155
 
        :param file_id: The file id to assign to the root. It must not be
 
2117
        :param file_id: The file id to assign to the root. It must not be 
2156
2118
            present in the current inventory or an error will occur. It must
2157
2119
            not be None, but rather a valid file id.
2158
2120
        """
2177
2139
 
2178
2140
    def unlock(self):
2179
2141
        """See Branch.unlock.
2180
 
 
 
2142
        
2181
2143
        WorkingTree locking just uses the Branch locking facilities.
2182
2144
        This is current because all working trees have an embedded branch
2183
2145
        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
 
2146
        between multiple working trees, i.e. via shared storage, then we 
2185
2147
        would probably want to lock both the local tree, and the branch.
2186
2148
        """
2187
2149
        raise NotImplementedError(self.unlock)
2188
2150
 
2189
 
    _marker = object()
2190
 
 
2191
 
    def update(self, change_reporter=None, possible_transports=None,
2192
 
               revision=None, old_tip=_marker):
 
2151
    def update(self, change_reporter=None, possible_transports=None):
2193
2152
        """Update a working tree along its branch.
2194
2153
 
2195
2154
        This will update the branch if its bound too, which means we have
2213
2172
        - Merge current state -> basis tree of the master w.r.t. the old tree
2214
2173
          basis.
2215
2174
        - 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
2175
        """
2223
2176
        if self.branch.get_bound_location() is not None:
2224
2177
            self.lock_write()
2225
 
            update_branch = (old_tip is self._marker)
 
2178
            update_branch = True
2226
2179
        else:
2227
2180
            self.lock_tree_write()
2228
2181
            update_branch = False
2230
2183
            if update_branch:
2231
2184
                old_tip = self.branch.update(possible_transports)
2232
2185
            else:
2233
 
                if old_tip is self._marker:
2234
 
                    old_tip = None
2235
 
            return self._update_tree(old_tip, change_reporter, revision)
 
2186
                old_tip = None
 
2187
            return self._update_tree(old_tip, change_reporter)
2236
2188
        finally:
2237
2189
            self.unlock()
2238
2190
 
2239
2191
    @needs_tree_write_lock
2240
 
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
 
2192
    def _update_tree(self, old_tip=None, change_reporter=None):
2241
2193
        """Update a tree to the master branch.
2242
2194
 
2243
2195
        :param old_tip: if supplied, the previous tip revision the branch,
2249
2201
        # cant set that until we update the working trees last revision to be
2250
2202
        # one from the new branch, because it will just get absorbed by the
2251
2203
        # parent de-duplication logic.
2252
 
        #
 
2204
        # 
2253
2205
        # We MUST save it even if an error occurs, because otherwise the users
2254
2206
        # local work is unreferenced and will appear to have been lost.
2255
 
        #
2256
 
        nb_conflicts = 0
 
2207
        # 
 
2208
        result = 0
2257
2209
        try:
2258
2210
            last_rev = self.get_parent_ids()[0]
2259
2211
        except IndexError:
2260
2212
            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
 
 
 
2213
        if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
 
2214
            # merge tree state up to new branch tip.
2285
2215
            basis = self.basis_tree()
2286
2216
            basis.lock_read()
2287
2217
            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)
 
2218
                to_tree = self.branch.basis_tree()
 
2219
                if basis.inventory.root is None:
 
2220
                    self.set_root_id(to_tree.get_root_id())
2291
2221
                    self.flush()
 
2222
                result += merge.merge_inner(
 
2223
                                      self.branch,
 
2224
                                      to_tree,
 
2225
                                      basis,
 
2226
                                      this_tree=self,
 
2227
                                      change_reporter=change_reporter)
2292
2228
            finally:
2293
2229
                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
2230
            # TODO - dedup parents list with things merged by pull ?
2306
2231
            # reuse the tree we've updated to to set the basis:
2307
 
            parent_trees = [(revision, to_tree)]
 
2232
            parent_trees = [(self.branch.last_revision(), to_tree)]
2308
2233
            merges = self.get_parent_ids()[1:]
2309
2234
            # 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
 
2235
            # tree can decide whether to give us teh entire tree or give us a
2311
2236
            # lazy initialised tree. dirstate for instance will have the trees
2312
2237
            # in ram already, whereas a last-revision + basis-inventory tree
2313
2238
            # will not, but also does not need them when setting parents.
2314
2239
            for parent in merges:
2315
2240
                parent_trees.append(
2316
2241
                    (parent, self.branch.repository.revision_tree(parent)))
2317
 
            if not _mod_revision.is_null(old_tip):
 
2242
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2318
2243
                parent_trees.append(
2319
2244
                    (old_tip, self.branch.repository.revision_tree(old_tip)))
2320
2245
            self.set_parent_trees(parent_trees)
2321
2246
            last_rev = parent_trees[0][0]
2322
 
        return nb_conflicts
 
2247
        else:
 
2248
            # the working tree had the same last-revision as the master
 
2249
            # branch did. We may still have pivot local work from the local
 
2250
            # branch into old_tip:
 
2251
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
 
2252
                self.add_parent_tree_id(old_tip)
 
2253
        if (old_tip is not None and not _mod_revision.is_null(old_tip)
 
2254
            and old_tip != last_rev):
 
2255
            # our last revision was not the prior branch last revision
 
2256
            # and we have converted that last revision to a pending merge.
 
2257
            # base is somewhere between the branch tip now
 
2258
            # and the now pending merge
 
2259
 
 
2260
            # Since we just modified the working tree and inventory, flush out
 
2261
            # the current state, before we modify it again.
 
2262
            # TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
 
2263
            #       requires it only because TreeTransform directly munges the
 
2264
            #       inventory and calls tree._write_inventory(). Ultimately we
 
2265
            #       should be able to remove this extra flush.
 
2266
            self.flush()
 
2267
            graph = self.branch.repository.get_graph()
 
2268
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
 
2269
                                                old_tip)
 
2270
            base_tree = self.branch.repository.revision_tree(base_rev_id)
 
2271
            other_tree = self.branch.repository.revision_tree(old_tip)
 
2272
            result += merge.merge_inner(
 
2273
                                  self.branch,
 
2274
                                  other_tree,
 
2275
                                  base_tree,
 
2276
                                  this_tree=self,
 
2277
                                  change_reporter=change_reporter)
 
2278
        return result
2323
2279
 
2324
2280
    def _write_hashcache_if_dirty(self):
2325
2281
        """Write out the hashcache if it is dirty."""
2424
2380
                    # value.
2425
2381
                    bzrdir_loc = bisect_left(cur_disk_dir_content,
2426
2382
                        ('.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])):
 
2383
                    if cur_disk_dir_content[bzrdir_loc][0] == '.bzr':
2430
2384
                        # we dont yield the contents of, or, .bzr itself.
2431
2385
                        del cur_disk_dir_content[bzrdir_loc]
2432
2386
            if inv_finished:
2522
2476
                relroot = ""
2523
2477
            # FIXME: stash the node in pending
2524
2478
            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
 
                        ))
 
2479
            for name, child in entry.sorted_children():
 
2480
                dirblock.append((relroot + name, name, child.kind, None,
 
2481
                    child.file_id, child.kind
 
2482
                    ))
2530
2483
            yield (currentdir[0], entry.file_id), dirblock
2531
2484
            # push the user specified dirs from dirblock
2532
2485
            for dir in reversed(dirblock):
2565
2518
        self.set_conflicts(un_resolved)
2566
2519
        return un_resolved, resolved
2567
2520
 
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
2521
    def _validate(self):
2588
2522
        """Validate internal structures.
2589
2523
 
2595
2529
        """
2596
2530
        return
2597
2531
 
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
2532
 
2611
2533
class WorkingTree2(WorkingTree):
2612
2534
    """This is the Format 2 working tree.
2613
2535
 
2614
 
    This was the first weave based working tree.
 
2536
    This was the first weave based working tree. 
2615
2537
     - uses os locks for locking.
2616
2538
     - uses the branch last-revision.
2617
2539
    """
2627
2549
        if self._inventory is None:
2628
2550
            self.read_working_inventory()
2629
2551
 
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
2552
    def lock_tree_write(self):
2635
2553
        """See WorkingTree.lock_tree_write().
2636
2554
 
2654
2572
            if self._inventory_is_modified:
2655
2573
                self.flush()
2656
2574
            self._write_hashcache_if_dirty()
2657
 
 
 
2575
                    
2658
2576
        # reverse order of locking.
2659
2577
        try:
2660
2578
            return self._control_files.unlock()
2682
2600
 
2683
2601
    def _change_last_revision(self, revision_id):
2684
2602
        """See WorkingTree._change_last_revision."""
2685
 
        if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
 
2603
        if revision_id is None or revision_id == NULL_REVISION:
2686
2604
            try:
2687
 
                self._transport.delete('last-revision')
 
2605
                self._control_files._transport.delete('last-revision')
2688
2606
            except errors.NoSuchFile:
2689
2607
                pass
2690
2608
            return False
2691
2609
        else:
2692
2610
            self._transport.put_bytes('last-revision', revision_id,
2693
 
                mode=self.bzrdir._get_file_mode())
 
2611
                mode=self._control_files._file_mode)
2694
2612
            return True
2695
2613
 
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
2614
    @needs_tree_write_lock
2701
2615
    def set_conflicts(self, conflicts):
2702
 
        self._put_rio('conflicts', conflicts.to_stanzas(),
 
2616
        self._put_rio('conflicts', conflicts.to_stanzas(), 
2703
2617
                      CONFLICT_HEADER_1)
2704
2618
 
2705
2619
    @needs_tree_write_lock
2716
2630
        except errors.NoSuchFile:
2717
2631
            return _mod_conflicts.ConflictList()
2718
2632
        try:
2719
 
            try:
2720
 
                if confile.next() != CONFLICT_HEADER_1 + '\n':
2721
 
                    raise errors.ConflictFormatError()
2722
 
            except StopIteration:
 
2633
            if confile.next() != CONFLICT_HEADER_1 + '\n':
2723
2634
                raise errors.ConflictFormatError()
2724
 
            return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2725
 
        finally:
2726
 
            confile.close()
 
2635
        except StopIteration:
 
2636
            raise errors.ConflictFormatError()
 
2637
        return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2727
2638
 
2728
2639
    def unlock(self):
2729
2640
        # do non-implementation specific cleanup
2746
2657
            return path[:-len(suffix)]
2747
2658
 
2748
2659
 
 
2660
@deprecated_function(zero_eight)
 
2661
def is_control_file(filename):
 
2662
    """See WorkingTree.is_control_filename(filename)."""
 
2663
    ## FIXME: better check
 
2664
    filename = normpath(filename)
 
2665
    while filename != '':
 
2666
        head, tail = os.path.split(filename)
 
2667
        ## mutter('check %r for control file' % ((head, tail),))
 
2668
        if tail == '.bzr':
 
2669
            return True
 
2670
        if filename == head:
 
2671
            break
 
2672
        filename = head
 
2673
    return False
 
2674
 
 
2675
 
2749
2676
class WorkingTreeFormat(object):
2750
2677
    """An encapsulation of the initialization and open routines for a format.
2751
2678
 
2754
2681
     * a format string,
2755
2682
     * an open routine.
2756
2683
 
2757
 
    Formats are placed in an dict by their format string for reference
 
2684
    Formats are placed in an dict by their format string for reference 
2758
2685
    during workingtree opening. Its not required that these be instances, they
2759
 
    can be classes themselves with class methods - it simply depends on
 
2686
    can be classes themselves with class methods - it simply depends on 
2760
2687
    whether state is needed for a given format or not.
2761
2688
 
2762
2689
    Once a format is deprecated, just deprecate the initialize and open
2763
 
    methods on the format class. Do not deprecate the object, as the
 
2690
    methods on the format class. Do not deprecate the object, as the 
2764
2691
    object will be created every time regardless.
2765
2692
    """
2766
2693
 
2779
2706
        """Return the format for the working tree object in a_bzrdir."""
2780
2707
        try:
2781
2708
            transport = a_bzrdir.get_workingtree_transport(None)
2782
 
            format_string = transport.get_bytes("format")
 
2709
            format_string = transport.get("format").read()
2783
2710
            return klass._formats[format_string]
2784
2711
        except errors.NoSuchFile:
2785
2712
            raise errors.NoWorkingTree(base=transport.base)
2810
2737
        """Is this format supported?
2811
2738
 
2812
2739
        Supported formats can be initialized and opened.
2813
 
        Unsupported formats may not support initialization or committing or
 
2740
        Unsupported formats may not support initialization or committing or 
2814
2741
        some other features depending on the reason for not being supported.
2815
2742
        """
2816
2743
        return True
2817
2744
 
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
2745
    @classmethod
2827
2746
    def register_format(klass, format):
2828
2747
        klass._formats[format.get_format_string()] = format
2833
2752
 
2834
2753
    @classmethod
2835
2754
    def unregister_format(klass, format):
 
2755
        assert klass._formats[format.get_format_string()] is format
2836
2756
        del klass._formats[format.get_format_string()]
2837
2757
 
2838
2758
 
2839
2759
class WorkingTreeFormat2(WorkingTreeFormat):
2840
 
    """The second working tree format.
 
2760
    """The second working tree format. 
2841
2761
 
2842
2762
    This format modified the hash cache from the format 1 hash cache.
2843
2763
    """
2848
2768
        """See WorkingTreeFormat.get_format_description()."""
2849
2769
        return "Working tree format 2"
2850
2770
 
2851
 
    def _stub_initialize_on_transport(self, transport, file_mode):
2852
 
        """Workaround: create control files for a remote working tree.
2853
 
 
 
2771
    def stub_initialize_remote(self, control_files):
 
2772
        """As a special workaround create critical control files for a remote working tree
 
2773
        
2854
2774
        This ensures that it can later be updated and dealt with locally,
2855
 
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
 
2775
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with 
2856
2776
        no working tree.  (See bug #43064).
2857
2777
        """
2858
2778
        sio = StringIO()
2859
 
        inv = inventory.Inventory()
 
2779
        inv = Inventory()
2860
2780
        xml5.serializer_v5.write_inventory(inv, sio, working=True)
2861
2781
        sio.seek(0)
2862
 
        transport.put_file('inventory', sio, file_mode)
2863
 
        transport.put_bytes('pending-merges', '', file_mode)
 
2782
        control_files._transport.put_file('inventory', sio,
 
2783
            mode=control_files._file_mode)
 
2784
        control_files._transport.put_bytes('pending-merges', '',
 
2785
            mode=control_files._file_mode)
 
2786
        
2864
2787
 
2865
2788
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2866
2789
                   accelerator_tree=None, hardlink=False):
2878
2801
            branch.generate_revision_history(revision_id)
2879
2802
        finally:
2880
2803
            branch.unlock()
2881
 
        inv = inventory.Inventory()
 
2804
        inv = Inventory()
2882
2805
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2883
2806
                         branch,
2884
2807
                         inv,
2929
2852
        - is new in bzr 0.8
2930
2853
        - uses a LockDir to guard access for writes.
2931
2854
    """
2932
 
 
 
2855
    
2933
2856
    upgrade_recommended = True
2934
2857
 
2935
2858
    def get_format_string(self):
2952
2875
 
2953
2876
    def _open_control_files(self, a_bzrdir):
2954
2877
        transport = a_bzrdir.get_workingtree_transport(None)
2955
 
        return LockableFiles(transport, self._lock_file_name,
 
2878
        return LockableFiles(transport, self._lock_file_name, 
2956
2879
                             self._lock_class)
2957
2880
 
2958
2881
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2959
2882
                   accelerator_tree=None, hardlink=False):
2960
2883
        """See WorkingTreeFormat.initialize().
2961
 
 
 
2884
        
2962
2885
        :param revision_id: if supplied, create a working tree at a different
2963
2886
            revision than the branch is at.
2964
2887
        :param accelerator_tree: A tree which can be used for retrieving file
2975
2898
        control_files.create_lock()
2976
2899
        control_files.lock_write()
2977
2900
        transport.put_bytes('format', self.get_format_string(),
2978
 
            mode=a_bzrdir._get_file_mode())
 
2901
            mode=control_files._file_mode)
2979
2902
        if from_branch is not None:
2980
2903
            branch = from_branch
2981
2904
        else:
3001
2924
            # only set an explicit root id if there is one to set.
3002
2925
            if basis_tree.inventory.root is not None:
3003
2926
                wt.set_root_id(basis_tree.get_root_id())
3004
 
            if revision_id == _mod_revision.NULL_REVISION:
 
2927
            if revision_id == NULL_REVISION:
3005
2928
                wt.set_parent_trees([])
3006
2929
            else:
3007
2930
                wt.set_parent_trees([(revision_id, basis_tree)])
3014
2937
        return wt
3015
2938
 
3016
2939
    def _initial_inventory(self):
3017
 
        return inventory.Inventory()
 
2940
        return Inventory()
3018
2941
 
3019
2942
    def __init__(self):
3020
2943
        super(WorkingTreeFormat3, self).__init__()
3035
2958
 
3036
2959
    def _open(self, a_bzrdir, control_files):
3037
2960
        """Open the tree itself.
3038
 
 
 
2961
        
3039
2962
        :param a_bzrdir: the dir for the tree.
3040
2963
        :param control_files: the control files for the tree.
3041
2964
        """
3049
2972
        return self.get_format_string()
3050
2973
 
3051
2974
 
3052
 
__default_format = WorkingTreeFormat6()
 
2975
__default_format = WorkingTreeFormat4()
3053
2976
WorkingTreeFormat.register_format(__default_format)
3054
 
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3055
 
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3056
2977
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3057
2978
WorkingTreeFormat.set_default_format(__default_format)
3058
2979
# formats which have no format string are not discoverable