/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_4.py

Fix "unprintable error" message for BzrCheckError and others

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2007-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
"""WorkingTree4 format and implementation.
18
18
 
28
28
 
29
29
from bzrlib.lazy_import import lazy_import
30
30
lazy_import(globals(), """
 
31
from bisect import bisect_left
 
32
import collections
 
33
from copy import deepcopy
31
34
import errno
 
35
import itertools
 
36
import operator
32
37
import stat
 
38
from time import time
 
39
import warnings
33
40
 
34
41
import bzrlib
35
42
from bzrlib import (
36
43
    bzrdir,
37
44
    cache_utf8,
 
45
    conflicts as _mod_conflicts,
38
46
    debug,
 
47
    delta,
39
48
    dirstate,
40
49
    errors,
41
50
    generate_ids,
 
51
    globbing,
 
52
    hashcache,
 
53
    ignores,
 
54
    merge,
42
55
    osutils,
43
56
    revision as _mod_revision,
44
57
    revisiontree,
 
58
    textui,
45
59
    trace,
46
60
    transform,
47
 
    views,
 
61
    urlutils,
 
62
    xml5,
 
63
    xml6,
48
64
    )
49
65
import bzrlib.branch
 
66
from bzrlib.transport import get_transport
50
67
import bzrlib.ui
51
68
""")
52
69
 
 
70
from bzrlib import symbol_versioning
53
71
from bzrlib.decorators import needs_read_lock, needs_write_lock
54
 
from bzrlib.filters import filtered_input_file, internal_size_sha_file_byname
55
 
from bzrlib.inventory import Inventory, ROOT_ID, entry_factory
56
 
from bzrlib.lock import LogicalLockResult
 
72
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, entry_factory
 
73
from bzrlib.lockable_files import LockableFiles, TransportLock
 
74
from bzrlib.lockdir import LockDir
 
75
import bzrlib.mutabletree
57
76
from bzrlib.mutabletree import needs_tree_write_lock
58
77
from bzrlib.osutils import (
59
78
    file_kind,
60
79
    isdir,
 
80
    normpath,
61
81
    pathjoin,
 
82
    rand_chars,
62
83
    realpath,
63
84
    safe_unicode,
 
85
    splitpath,
64
86
    )
65
 
from bzrlib.trace import mutter
 
87
from bzrlib.trace import mutter, note
66
88
from bzrlib.transport.local import LocalTransport
67
89
from bzrlib.tree import InterTree
 
90
from bzrlib.progress import DummyProgress, ProgressPhase
 
91
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
 
92
from bzrlib.rio import RioReader, rio_file, Stanza
 
93
from bzrlib.symbol_versioning import (deprecated_passed,
 
94
        deprecated_method,
 
95
        deprecated_function,
 
96
        DEPRECATED_PARAMETER,
 
97
        )
68
98
from bzrlib.tree import Tree
69
99
from bzrlib.workingtree import WorkingTree, WorkingTree3, WorkingTreeFormat3
70
100
 
71
101
 
72
 
class DirStateWorkingTree(WorkingTree3):
 
102
# This is the Windows equivalent of ENOTDIR
 
103
# It is defined in pywin32.winerror, but we don't want a strong dependency for
 
104
# just an error code.
 
105
ERROR_PATH_NOT_FOUND = 3
 
106
ERROR_DIRECTORY = 267
 
107
 
 
108
 
 
109
class WorkingTree4(WorkingTree3):
 
110
    """This is the Format 4 working tree.
 
111
 
 
112
    This differs from WorkingTree3 by:
 
113
     - Having a consolidated internal dirstate, stored in a
 
114
       randomly-accessible sorted file on disk.
 
115
     - Not having a regular inventory attribute.  One can be synthesized 
 
116
       on demand but this is expensive and should be avoided.
 
117
 
 
118
    This is new in bzr 0.15.
 
119
    """
 
120
 
73
121
    def __init__(self, basedir,
74
122
                 branch,
75
123
                 _control_files=None,
84
132
        """
85
133
        self._format = _format
86
134
        self.bzrdir = _bzrdir
 
135
        assert isinstance(basedir, basestring), \
 
136
            "base directory %r is not a string" % basedir
87
137
        basedir = safe_unicode(basedir)
88
138
        mutter("opening working tree %r", basedir)
89
139
        self._branch = branch
 
140
        assert isinstance(self.branch, bzrlib.branch.Branch), \
 
141
            "branch %r is not a Branch" % self.branch
90
142
        self.basedir = realpath(basedir)
91
143
        # if branch is at our basedir and is a format 6 or less
92
144
        # assume all other formats have their own control files.
 
145
        assert isinstance(_control_files, LockableFiles), \
 
146
            "_control_files must be a LockableFiles, not %r" % _control_files
93
147
        self._control_files = _control_files
94
 
        self._transport = self._control_files._transport
95
148
        self._dirty = None
96
149
        #-------------
97
150
        # during a read or write lock these objects are set, and are
99
152
        self._dirstate = None
100
153
        self._inventory = None
101
154
        #-------------
102
 
        self._setup_directory_is_tree_reference()
103
 
        self._detect_case_handling()
104
 
        self._rules_searcher = None
105
 
        self.views = self._make_views()
106
 
        #--- allow tests to select the dirstate iter_changes implementation
107
 
        self._iter_changes = dirstate._process_entry
108
155
 
109
156
    @needs_tree_write_lock
110
157
    def _add(self, files, ids, kinds):
112
159
        state = self.current_dirstate()
113
160
        for f, file_id, kind in zip(files, ids, kinds):
114
161
            f = f.strip('/')
 
162
            assert '//' not in f
 
163
            assert '..' not in f
115
164
            if self.path2id(f):
116
165
                # special case tree root handling.
117
166
                if f == '' and self.path2id(f) == ROOT_ID:
138
187
    @needs_tree_write_lock
139
188
    def add_reference(self, sub_tree):
140
189
        # use standard implementation, which calls back to self._add
141
 
        #
 
190
        # 
142
191
        # So we don't store the reference_revision in the working dirstate,
143
 
        # it's just recorded at the moment of commit.
 
192
        # it's just recorded at the moment of commit. 
144
193
        self._add_reference(sub_tree)
145
194
 
146
195
    def break_lock(self):
185
234
            WorkingTree3._comparison_data(self, entry, path)
186
235
        # it looks like a plain directory, but it's really a reference -- see
187
236
        # also kind()
188
 
        if (self._repo_supports_tree_reference and kind == 'directory'
189
 
            and entry is not None and entry.kind == 'tree-reference'):
 
237
        if (self._repo_supports_tree_reference and
 
238
            kind == 'directory' and
 
239
            self._directory_is_tree_reference(path)):
190
240
            kind = 'tree-reference'
191
241
        return kind, executable, stat_value
192
242
 
218
268
            return self._dirstate
219
269
        local_path = self.bzrdir.get_workingtree_transport(None
220
270
            ).local_abspath('dirstate')
221
 
        self._dirstate = dirstate.DirState.on_file(local_path,
222
 
            self._sha1_provider())
 
271
        self._dirstate = dirstate.DirState.on_file(local_path)
223
272
        return self._dirstate
224
273
 
225
 
    def _sha1_provider(self):
226
 
        """A function that returns a SHA1Provider suitable for this tree.
227
 
 
228
 
        :return: None if content filtering is not supported by this tree.
229
 
          Otherwise, a SHA1Provider is returned that sha's the canonical
230
 
          form of files, i.e. after read filters are applied.
231
 
        """
232
 
        if self.supports_content_filtering():
233
 
            return ContentFilterAwareSHA1Provider(self)
234
 
        else:
235
 
            return None
 
274
    def _directory_is_tree_reference(self, relpath):
 
275
        # as a special case, if a directory contains control files then 
 
276
        # it's a tree reference, except that the root of the tree is not
 
277
        return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
 
278
        # TODO: We could ask all the control formats whether they
 
279
        # recognize this directory, but at the moment there's no cheap api
 
280
        # to do that.  Since we probably can only nest bzr checkouts and
 
281
        # they always use this name it's ok for now.  -- mbp 20060306
 
282
        #
 
283
        # FIXME: There is an unhandled case here of a subdirectory
 
284
        # containing .bzr but not a branch; that will probably blow up
 
285
        # when you try to commit it.  It might happen if there is a
 
286
        # checkout in a subdirectory.  This can be avoided by not adding
 
287
        # it.  mbp 20070306
236
288
 
237
289
    def filter_unversioned_files(self, paths):
238
290
        """Filter out paths that are versioned.
271
323
 
272
324
    def _generate_inventory(self):
273
325
        """Create and set self.inventory from the dirstate object.
274
 
 
 
326
        
275
327
        This is relatively expensive: we have to walk the entire dirstate.
276
328
        Ideally we would not, and can deprecate this function.
277
329
        """
281
333
        state._read_dirblocks_if_needed()
282
334
        root_key, current_entry = self._get_entry(path='')
283
335
        current_id = root_key[2]
284
 
        if not (current_entry[0][0] == 'd'): # directory
285
 
            raise AssertionError(current_entry)
 
336
        assert current_entry[0][0] == 'd' # directory
286
337
        inv = Inventory(root_id=current_id)
287
338
        # Turn some things into local variables
288
339
        minikind_to_kind = dirstate.DirState._minikind_to_kind
321
372
                    # add this entry to the parent map.
322
373
                    parent_ies[(dirname + '/' + name).strip('/')] = inv_entry
323
374
                elif kind == 'tree-reference':
324
 
                    if not self._repo_supports_tree_reference:
325
 
                        raise errors.UnsupportedOperation(
326
 
                            self._generate_inventory,
327
 
                            self.branch.repository)
 
375
                    assert self._repo_supports_tree_reference, \
 
376
                        "repository of %r " \
 
377
                        "doesn't support tree references " \
 
378
                        "required by entry %r" \
 
379
                        % (self, name)
328
380
                    inv_entry.reference_revision = link_or_sha1 or None
329
381
                elif kind != 'symlink':
330
382
                    raise AssertionError("unknown kind %r" % kind)
331
383
                # These checks cost us around 40ms on a 55k entry tree
332
 
                if file_id in inv_byid:
333
 
                    raise AssertionError('file_id %s already in'
334
 
                        ' inventory as %s' % (file_id, inv_byid[file_id]))
335
 
                if name_unicode in parent_ie.children:
336
 
                    raise AssertionError('name %r already in parent'
337
 
                        % (name_unicode,))
 
384
                assert file_id not in inv_byid, ('file_id %s already in'
 
385
                    ' inventory as %s' % (file_id, inv_byid[file_id]))
 
386
                assert name_unicode not in parent_ie.children
338
387
                inv_byid[file_id] = inv_entry
339
388
                parent_ie.children[name_unicode] = inv_entry
340
389
        self._inventory = inv
345
394
        If either file_id or path is supplied, it is used as the key to lookup.
346
395
        If both are supplied, the fastest lookup is used, and an error is
347
396
        raised if they do not both point at the same row.
348
 
 
 
397
        
349
398
        :param file_id: An optional unicode file_id to be looked up.
350
399
        :param path: An optional unicode path to be looked up.
351
400
        :return: The dirstate row tuple for path/file_id, or (None, None)
375
424
                    return None
376
425
                else:
377
426
                    raise
378
 
        link_or_sha1 = dirstate.update_entry(state, entry, file_abspath,
379
 
            stat_value=stat_value)
 
427
        link_or_sha1 = state.update_entry(entry, file_abspath,
 
428
                                          stat_value=stat_value)
380
429
        if entry[1][0][0] == 'f':
381
 
            if link_or_sha1 is None:
382
 
                file_obj, statvalue = self.get_file_with_stat(file_id, path)
383
 
                try:
384
 
                    sha1 = osutils.sha_file(file_obj)
385
 
                finally:
386
 
                    file_obj.close()
387
 
                self._observed_sha1(file_id, path, (sha1, statvalue))
388
 
                return sha1
389
 
            else:
390
 
                return link_or_sha1
 
430
            return link_or_sha1
391
431
        return None
392
432
 
393
433
    def _get_inventory(self):
407
447
    @needs_read_lock
408
448
    def get_parent_ids(self):
409
449
        """See Tree.get_parent_ids.
410
 
 
 
450
        
411
451
        This implementation requests the ids list from the dirstate file.
412
452
        """
413
453
        return self.current_dirstate().get_parent_ids()
429
469
 
430
470
    def has_id(self, file_id):
431
471
        state = self.current_dirstate()
 
472
        file_id = osutils.safe_file_id(file_id)
432
473
        row, parents = self._get_entry(file_id=file_id)
433
474
        if row is None:
434
475
            return False
435
476
        return osutils.lexists(pathjoin(
436
477
                    self.basedir, row[0].decode('utf8'), row[1].decode('utf8')))
437
478
 
438
 
    def has_or_had_id(self, file_id):
439
 
        state = self.current_dirstate()
440
 
        row, parents = self._get_entry(file_id=file_id)
441
 
        return row is not None
442
 
 
443
479
    @needs_read_lock
444
480
    def id2path(self, file_id):
445
481
        "Convert a file-id to a path."
 
482
        file_id = osutils.safe_file_id(file_id)
446
483
        state = self.current_dirstate()
447
484
        entry = self._get_entry(file_id=file_id)
448
485
        if entry == (None, None):
450
487
        path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
451
488
        return path_utf8.decode('utf8')
452
489
 
453
 
    def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
454
 
        entry = self._get_entry(path=path)
455
 
        if entry == (None, None):
456
 
            return False # Missing entries are not executable
457
 
        return entry[1][0][3] # Executable?
458
 
 
459
490
    if not osutils.supports_executable():
460
491
        def is_executable(self, file_id, path=None):
461
492
            """Test if a file is executable or not.
462
493
 
463
494
            Note: The caller is expected to take a read-lock before calling this.
464
495
            """
 
496
            file_id = osutils.safe_file_id(file_id)
465
497
            entry = self._get_entry(file_id=file_id, path=path)
466
498
            if entry == (None, None):
467
499
                return False
468
500
            return entry[1][0][3]
469
 
 
470
 
        _is_executable_from_path_and_stat = \
471
 
            _is_executable_from_path_and_stat_from_basis
472
501
    else:
473
502
        def is_executable(self, file_id, path=None):
474
503
            """Test if a file is executable or not.
475
504
 
476
505
            Note: The caller is expected to take a read-lock before calling this.
477
506
            """
478
 
            self._must_be_locked()
479
507
            if not path:
 
508
                file_id = osutils.safe_file_id(file_id)
480
509
                path = self.id2path(file_id)
481
510
            mode = os.lstat(self.abspath(path)).st_mode
482
511
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
483
512
 
484
 
    def all_file_ids(self):
485
 
        """See Tree.iter_all_file_ids"""
486
 
        self._must_be_locked()
487
 
        result = set()
488
 
        for key, tree_details in self.current_dirstate()._iter_entries():
489
 
            if tree_details[0][0] in ('a', 'r'): # relocated
490
 
                continue
491
 
            result.add(key[2])
492
 
        return result
493
 
 
494
513
    @needs_read_lock
495
514
    def __iter__(self):
496
515
        """Iterate through file_ids for this tree.
509
528
        return iter(result)
510
529
 
511
530
    def iter_references(self):
512
 
        if not self._repo_supports_tree_reference:
513
 
            # When the repo doesn't support references, we will have nothing to
514
 
            # return
515
 
            return
516
531
        for key, tree_details in self.current_dirstate()._iter_entries():
517
532
            if tree_details[0][0] in ('a', 'r'): # absent, relocated
518
533
                # not relevant to the working tree
520
535
            if not key[1]:
521
536
                # the root is not a reference.
522
537
                continue
523
 
            relpath = pathjoin(key[0].decode('utf8'), key[1].decode('utf8'))
 
538
            path = pathjoin(self.basedir, key[0].decode('utf8'), key[1].decode('utf8'))
524
539
            try:
525
 
                if self._kind(relpath) == 'tree-reference':
526
 
                    yield relpath, key[2]
 
540
                if self._kind(path) == 'tree-reference':
 
541
                    yield path, key[2]
527
542
            except errors.NoSuchFile:
528
543
                # path is missing on disk.
529
544
                continue
530
545
 
531
 
    def _observed_sha1(self, file_id, path, (sha1, statvalue)):
532
 
        """See MutableTree._observed_sha1."""
533
 
        state = self.current_dirstate()
534
 
        entry = self._get_entry(file_id=file_id, path=path)
535
 
        state._observed_sha1(entry, sha1, statvalue)
536
 
 
537
546
    def kind(self, file_id):
538
547
        """Return the kind of a file.
539
548
 
543
552
        Note: The caller is expected to take a read-lock before calling this.
544
553
        """
545
554
        relpath = self.id2path(file_id)
546
 
        if relpath is None:
547
 
            raise AssertionError(
548
 
                "path for id {%s} is None!" % file_id)
 
555
        assert relpath != None, \
 
556
            "path for id {%s} is None!" % file_id
549
557
        return self._kind(relpath)
550
558
 
551
559
    def _kind(self, relpath):
552
560
        abspath = self.abspath(relpath)
553
561
        kind = file_kind(abspath)
554
 
        if (self._repo_supports_tree_reference and kind == 'directory'):
555
 
            entry = self._get_entry(path=relpath)
556
 
            if entry[1] is not None:
557
 
                if entry[1][0][0] == 't':
558
 
                    kind = 'tree-reference'
 
562
        if (self._repo_supports_tree_reference and
 
563
            kind == 'directory' and
 
564
            self._directory_is_tree_reference(relpath)):
 
565
            kind = 'tree-reference'
559
566
        return kind
560
567
 
561
568
    @needs_read_lock
568
575
            return _mod_revision.NULL_REVISION
569
576
 
570
577
    def lock_read(self):
571
 
        """See Branch.lock_read, and WorkingTree.unlock.
572
 
 
573
 
        :return: A bzrlib.lock.LogicalLockResult.
574
 
        """
 
578
        """See Branch.lock_read, and WorkingTree.unlock."""
575
579
        self.branch.lock_read()
576
580
        try:
577
581
            self._control_files.lock_read()
590
594
        except:
591
595
            self.branch.unlock()
592
596
            raise
593
 
        return LogicalLockResult(self.unlock)
594
597
 
595
598
    def _lock_self_write(self):
596
599
        """This should be called after the branch is locked."""
611
614
        except:
612
615
            self.branch.unlock()
613
616
            raise
614
 
        return LogicalLockResult(self.unlock)
615
617
 
616
618
    def lock_tree_write(self):
617
 
        """See MutableTree.lock_tree_write, and WorkingTree.unlock.
618
 
 
619
 
        :return: A bzrlib.lock.LogicalLockResult.
620
 
        """
 
619
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
621
620
        self.branch.lock_read()
622
 
        return self._lock_self_write()
 
621
        self._lock_self_write()
623
622
 
624
623
    def lock_write(self):
625
 
        """See MutableTree.lock_write, and WorkingTree.unlock.
626
 
 
627
 
        :return: A bzrlib.lock.LogicalLockResult.
628
 
        """
 
624
        """See MutableTree.lock_write, and WorkingTree.unlock."""
629
625
        self.branch.lock_write()
630
 
        return self._lock_self_write()
 
626
        self._lock_self_write()
631
627
 
632
628
    @needs_tree_write_lock
633
629
    def move(self, from_paths, to_dir, after=False):
635
631
        result = []
636
632
        if not from_paths:
637
633
            return result
 
634
 
638
635
        state = self.current_dirstate()
639
 
        if isinstance(from_paths, basestring):
640
 
            raise ValueError()
 
636
 
 
637
        assert not isinstance(from_paths, basestring)
641
638
        to_dir_utf8 = to_dir.encode('utf8')
642
639
        to_entry_dirname, to_basename = os.path.split(to_dir_utf8)
643
640
        id_index = state._get_id_index()
665
662
        if self._inventory is not None:
666
663
            update_inventory = True
667
664
            inv = self.inventory
 
665
            to_dir_ie = inv[to_dir_id]
668
666
            to_dir_id = to_entry[0][2]
669
 
            to_dir_ie = inv[to_dir_id]
670
667
        else:
671
668
            update_inventory = False
672
669
 
703
700
            from_entry = self._get_entry(path=from_rel)
704
701
            if from_entry == (None, None):
705
702
                raise errors.BzrMoveFailedError(from_rel,to_dir,
706
 
                    errors.NotVersionedError(path=from_rel))
 
703
                    errors.NotVersionedError(path=str(from_rel)))
707
704
 
708
705
            from_id = from_entry[0][2]
709
706
            to_rel = pathjoin(to_dir, from_tail)
736
733
                if from_missing: # implicitly just update our path mapping
737
734
                    move_file = False
738
735
                elif not after:
739
 
                    raise errors.RenameFailedFilesExist(from_rel, to_rel)
 
736
                    raise errors.RenameFailedFilesExist(from_rel, to_rel,
 
737
                        extra="(Use --after to update the Bazaar id)")
740
738
 
741
739
            rollbacks = []
742
740
            def rollback_rename():
798
796
                if minikind == 'd':
799
797
                    def update_dirblock(from_dir, to_key, to_dir_utf8):
800
798
                        """Recursively update all entries in this dirblock."""
801
 
                        if from_dir == '':
802
 
                            raise AssertionError("renaming root not supported")
 
799
                        assert from_dir != '', "renaming root not supported"
803
800
                        from_key = (from_dir, '')
804
801
                        from_block_idx, present = \
805
802
                            state._find_block_index_from_key(from_key)
818
815
 
819
816
                        # Grab a copy since move_one may update the list.
820
817
                        for entry in from_block[1][:]:
821
 
                            if not (entry[0][0] == from_dir):
822
 
                                raise AssertionError()
 
818
                            assert entry[0][0] == from_dir
823
819
                            cur_details = entry[1][0]
824
820
                            to_key = (to_dir_utf8, entry[0][1], entry[0][2])
825
821
                            from_path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
884
880
        for tree in trees:
885
881
            if not (isinstance(tree, DirStateRevisionTree) and tree._revision_id in
886
882
                parents):
887
 
                return super(DirStateWorkingTree, self).paths2ids(paths,
888
 
                    trees, require_versioned)
 
883
                return super(WorkingTree4, self).paths2ids(paths, trees, require_versioned)
889
884
        search_indexes = [0] + [1 + parents.index(tree._revision_id) for tree in trees]
890
885
        # -- make all paths utf8 --
891
886
        paths_utf8 = set()
952
947
                raise errors.PathsNotVersionedError(paths)
953
948
        # -- remove redundancy in supplied paths to prevent over-scanning --
954
949
        search_paths = osutils.minimum_path_selection(paths)
955
 
        # sketch:
 
950
        # sketch: 
956
951
        # for all search_indexs in each path at or under each element of
957
952
        # search_paths, if the detail is relocated: add the id, and add the
958
953
        # relocated path as one to search if its not searched already. If the
1014
1009
 
1015
1010
    def read_working_inventory(self):
1016
1011
        """Read the working inventory.
1017
 
 
 
1012
        
1018
1013
        This is a meaningless operation for dirstate, but we obey it anyhow.
1019
1014
        """
1020
1015
        return self.inventory
1025
1020
 
1026
1021
        WorkingTree4 supplies revision_trees for any basis tree.
1027
1022
        """
 
1023
        revision_id = osutils.safe_revision_id(revision_id)
1028
1024
        dirstate = self.current_dirstate()
1029
1025
        parent_ids = dirstate.get_parent_ids()
1030
1026
        if revision_id not in parent_ids:
1037
1033
    @needs_tree_write_lock
1038
1034
    def set_last_revision(self, new_revision):
1039
1035
        """Change the last revision in the working tree."""
 
1036
        new_revision = osutils.safe_revision_id(new_revision)
1040
1037
        parents = self.get_parent_ids()
1041
 
        if new_revision in (_mod_revision.NULL_REVISION, None):
1042
 
            if len(parents) >= 2:
1043
 
                raise AssertionError(
1044
 
                    "setting the last parent to none with a pending merge is "
1045
 
                    "unsupported.")
 
1038
        if new_revision in (NULL_REVISION, None):
 
1039
            assert len(parents) < 2, (
 
1040
                "setting the last parent to none with a pending merge is "
 
1041
                "unsupported.")
1046
1042
            self.set_parent_ids([])
1047
1043
        else:
1048
1044
            self.set_parent_ids([new_revision] + parents[1:],
1051
1047
    @needs_tree_write_lock
1052
1048
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
1053
1049
        """Set the parent ids to revision_ids.
1054
 
 
 
1050
        
1055
1051
        See also set_parent_trees. This api will try to retrieve the tree data
1056
1052
        for each element of revision_ids from the trees repository. If you have
1057
1053
        tree data already available, it is more efficient to use
1061
1057
        :param revision_ids: The revision_ids to set as the parent ids of this
1062
1058
            working tree. Any of these may be ghosts.
1063
1059
        """
 
1060
        revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1064
1061
        trees = []
1065
1062
        for revision_id in revision_ids:
1066
1063
            try:
1089
1086
                raise errors.GhostRevisionUnusableHere(parents_list[0][0])
1090
1087
        real_trees = []
1091
1088
        ghosts = []
1092
 
 
1093
 
        parent_ids = [rev_id for rev_id, tree in parents_list]
1094
 
        graph = self.branch.repository.get_graph()
1095
 
        heads = graph.heads(parent_ids)
1096
 
        accepted_revisions = set()
1097
 
 
1098
1089
        # convert absent trees to the null tree, which we convert back to
1099
1090
        # missing on access.
1100
1091
        for rev_id, tree in parents_list:
1101
 
            if len(accepted_revisions) > 0:
1102
 
                # we always accept the first tree
1103
 
                if rev_id in accepted_revisions or rev_id not in heads:
1104
 
                    # We have already included either this tree, or its
1105
 
                    # descendent, so we skip it.
1106
 
                    continue
 
1092
            rev_id = osutils.safe_revision_id(rev_id)
1107
1093
            _mod_revision.check_not_reserved_id(rev_id)
1108
1094
            if tree is not None:
1109
1095
                real_trees.append((rev_id, tree))
1110
1096
            else:
1111
1097
                real_trees.append((rev_id,
1112
 
                    self.branch.repository.revision_tree(
1113
 
                        _mod_revision.NULL_REVISION)))
 
1098
                    self.branch.repository.revision_tree(None)))
1114
1099
                ghosts.append(rev_id)
1115
 
            accepted_revisions.add(rev_id)
1116
1100
        dirstate.set_parent_trees(real_trees, ghosts=ghosts)
1117
1101
        self._make_dirty(reset_inventory=False)
1118
1102
 
1123
1107
        if state._dirblock_state == dirstate.DirState.IN_MEMORY_MODIFIED:
1124
1108
            self._make_dirty(reset_inventory=True)
1125
1109
 
1126
 
    def _sha_from_stat(self, path, stat_result):
1127
 
        """Get a sha digest from the tree's stat cache.
1128
 
 
1129
 
        The default implementation assumes no stat cache is present.
1130
 
 
1131
 
        :param path: The path.
1132
 
        :param stat_result: The stat result being looked up.
1133
 
        """
1134
 
        return self.current_dirstate().sha1_from_stat(path, stat_result)
1135
 
 
1136
1110
    @needs_read_lock
1137
1111
    def supports_tree_reference(self):
1138
1112
        return self._repo_supports_tree_reference
1178
1152
            return
1179
1153
        state = self.current_dirstate()
1180
1154
        state._read_dirblocks_if_needed()
1181
 
        ids_to_unversion = set(file_ids)
 
1155
        ids_to_unversion = set()
 
1156
        for file_id in file_ids:
 
1157
            ids_to_unversion.add(osutils.safe_file_id(file_id))
1182
1158
        paths_to_unversion = set()
1183
1159
        # sketch:
1184
1160
        # check if the root is to be unversioned, if so, assert for now.
1211
1187
                # just forget the whole block.
1212
1188
                entry_index = 0
1213
1189
                while entry_index < len(block[1]):
 
1190
                    # Mark this file id as having been removed
1214
1191
                    entry = block[1][entry_index]
1215
 
                    if entry[1][0][0] in 'ar':
1216
 
                        # don't remove absent or renamed entries
 
1192
                    ids_to_unversion.discard(entry[0][2])
 
1193
                    if (entry[1][0][0] == 'a'
 
1194
                        or not state._make_absent(entry)):
1217
1195
                        entry_index += 1
1218
 
                    else:
1219
 
                        # Mark this file id as having been removed
1220
 
                        ids_to_unversion.discard(entry[0][2])
1221
 
                        if not state._make_absent(entry):
1222
 
                            # The block has not shrunk.
1223
 
                            entry_index += 1
1224
1196
                # go to the next block. (At the moment we dont delete empty
1225
1197
                # dirblocks)
1226
1198
                block_index += 1
1249
1221
            for file_id in file_ids:
1250
1222
                self._inventory.remove_recursive_id(file_id)
1251
1223
 
1252
 
    @needs_tree_write_lock
1253
 
    def rename_one(self, from_rel, to_rel, after=False):
1254
 
        """See WorkingTree.rename_one"""
1255
 
        self.flush()
1256
 
        WorkingTree.rename_one(self, from_rel, to_rel, after)
1257
 
 
1258
 
    @needs_tree_write_lock
1259
 
    def apply_inventory_delta(self, changes):
1260
 
        """See MutableTree.apply_inventory_delta"""
1261
 
        state = self.current_dirstate()
1262
 
        state.update_by_delta(changes)
1263
 
        self._make_dirty(reset_inventory=True)
1264
 
 
1265
 
    def update_basis_by_delta(self, new_revid, delta):
1266
 
        """See MutableTree.update_basis_by_delta."""
1267
 
        if self.last_revision() == new_revid:
1268
 
            raise AssertionError()
1269
 
        self.current_dirstate().update_basis_by_delta(delta, new_revid)
1270
 
 
1271
1224
    @needs_read_lock
1272
1225
    def _validate(self):
1273
1226
        self._dirstate._validate()
1275
1228
    @needs_tree_write_lock
1276
1229
    def _write_inventory(self, inv):
1277
1230
        """Write inventory as the current inventory."""
1278
 
        if self._dirty:
1279
 
            raise AssertionError("attempting to write an inventory when the "
1280
 
                "dirstate is dirty will lose pending changes")
1281
 
        had_inventory = self._inventory is not None
1282
 
        # Setting self._inventory = None forces the dirstate to regenerate the
1283
 
        # working inventory. We do this because self.inventory may be inv, or
1284
 
        # may have been modified, and either case would prevent a clean delta
1285
 
        # being created.
1286
 
        self._inventory = None
1287
 
        # generate a delta,
1288
 
        delta = inv._make_delta(self.inventory)
1289
 
        # and apply it.
1290
 
        self.apply_inventory_delta(delta)
1291
 
        if had_inventory:
 
1231
        assert not self._dirty, "attempting to write an inventory when the dirstate is dirty will cause data loss"
 
1232
        self.current_dirstate().set_state_from_inventory(inv)
 
1233
        self._make_dirty(reset_inventory=False)
 
1234
        if self._inventory is not None:
1292
1235
            self._inventory = inv
1293
1236
        self.flush()
1294
1237
 
1295
1238
 
1296
 
class ContentFilterAwareSHA1Provider(dirstate.SHA1Provider):
1297
 
 
1298
 
    def __init__(self, tree):
1299
 
        self.tree = tree
1300
 
 
1301
 
    def sha1(self, abspath):
1302
 
        """See dirstate.SHA1Provider.sha1()."""
1303
 
        filters = self.tree._content_filter_stack(
1304
 
            self.tree.relpath(osutils.safe_unicode(abspath)))
1305
 
        return internal_size_sha_file_byname(abspath, filters)[1]
1306
 
 
1307
 
    def stat_and_sha1(self, abspath):
1308
 
        """See dirstate.SHA1Provider.stat_and_sha1()."""
1309
 
        filters = self.tree._content_filter_stack(
1310
 
            self.tree.relpath(osutils.safe_unicode(abspath)))
1311
 
        file_obj = file(abspath, 'rb', 65000)
1312
 
        try:
1313
 
            statvalue = os.fstat(file_obj.fileno())
1314
 
            if filters:
1315
 
                file_obj = filtered_input_file(file_obj, filters)
1316
 
            sha1 = osutils.size_sha_file(file_obj)[1]
1317
 
        finally:
1318
 
            file_obj.close()
1319
 
        return statvalue, sha1
1320
 
 
1321
 
 
1322
 
class ContentFilteringDirStateWorkingTree(DirStateWorkingTree):
1323
 
    """Dirstate working tree that supports content filtering.
1324
 
 
1325
 
    The dirstate holds the hash and size of the canonical form of the file, 
1326
 
    and most methods must return that.
1327
 
    """
1328
 
 
1329
 
    def _file_content_summary(self, path, stat_result):
1330
 
        # This is to support the somewhat obsolete path_content_summary method
1331
 
        # with content filtering: see
1332
 
        # <https://bugs.edge.launchpad.net/bzr/+bug/415508>.
1333
 
        #
1334
 
        # If the dirstate cache is up to date and knows the hash and size,
1335
 
        # return that.
1336
 
        # Otherwise if there are no content filters, return the on-disk size
1337
 
        # and leave the hash blank.
1338
 
        # Otherwise, read and filter the on-disk file and use its size and
1339
 
        # hash.
1340
 
        #
1341
 
        # The dirstate doesn't store the size of the canonical form so we
1342
 
        # can't trust it for content-filtered trees.  We just return None.
1343
 
        dirstate_sha1 = self._dirstate.sha1_from_stat(path, stat_result)
1344
 
        executable = self._is_executable_from_path_and_stat(path, stat_result)
1345
 
        return ('file', None, executable, dirstate_sha1)
1346
 
 
1347
 
 
1348
 
class WorkingTree4(DirStateWorkingTree):
1349
 
    """This is the Format 4 working tree.
1350
 
 
1351
 
    This differs from WorkingTree3 by:
1352
 
     - Having a consolidated internal dirstate, stored in a
1353
 
       randomly-accessible sorted file on disk.
1354
 
     - Not having a regular inventory attribute.  One can be synthesized
1355
 
       on demand but this is expensive and should be avoided.
1356
 
 
1357
 
    This is new in bzr 0.15.
1358
 
    """
1359
 
 
1360
 
 
1361
 
class WorkingTree5(ContentFilteringDirStateWorkingTree):
1362
 
    """This is the Format 5 working tree.
1363
 
 
1364
 
    This differs from WorkingTree4 by:
1365
 
     - Supporting content filtering.
1366
 
 
1367
 
    This is new in bzr 1.11.
1368
 
    """
1369
 
 
1370
 
 
1371
 
class WorkingTree6(ContentFilteringDirStateWorkingTree):
1372
 
    """This is the Format 6 working tree.
1373
 
 
1374
 
    This differs from WorkingTree5 by:
1375
 
     - Supporting a current view that may mask the set of files in a tree
1376
 
       impacted by most user operations.
1377
 
 
1378
 
    This is new in bzr 1.14.
1379
 
    """
1380
 
 
1381
 
    def _make_views(self):
1382
 
        return views.PathBasedViews(self)
1383
 
 
1384
 
 
1385
 
class DirStateWorkingTreeFormat(WorkingTreeFormat3):
1386
 
 
1387
 
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
1388
 
                   accelerator_tree=None, hardlink=False):
 
1239
class WorkingTreeFormat4(WorkingTreeFormat3):
 
1240
    """The first consolidated dirstate working tree format.
 
1241
 
 
1242
    This format:
 
1243
        - exists within a metadir controlling .bzr
 
1244
        - includes an explicit version marker for the workingtree control
 
1245
          files, separate from the BzrDir format
 
1246
        - modifies the hash cache format
 
1247
        - is new in bzr 0.15
 
1248
        - uses a LockDir to guard access to it.
 
1249
    """
 
1250
 
 
1251
    upgrade_recommended = False
 
1252
 
 
1253
    def get_format_string(self):
 
1254
        """See WorkingTreeFormat.get_format_string()."""
 
1255
        return "Bazaar Working Tree Format 4 (bzr 0.15)\n"
 
1256
 
 
1257
    def get_format_description(self):
 
1258
        """See WorkingTreeFormat.get_format_description()."""
 
1259
        return "Working tree format 4"
 
1260
 
 
1261
    def initialize(self, a_bzrdir, revision_id=None):
1389
1262
        """See WorkingTreeFormat.initialize().
1390
1263
 
1391
1264
        :param revision_id: allows creating a working tree at a different
1392
1265
        revision than the branch is at.
1393
 
        :param accelerator_tree: A tree which can be used for retrieving file
1394
 
            contents more quickly than the revision tree, i.e. a workingtree.
1395
 
            The revision tree will be used for cases where accelerator_tree's
1396
 
            content is different.
1397
 
        :param hardlink: If true, hard-link files from accelerator_tree,
1398
 
            where possible.
1399
1266
 
1400
1267
        These trees get an initial random root id, if their repository supports
1401
1268
        rich root data, TREE_ROOT otherwise.
1402
1269
        """
 
1270
        revision_id = osutils.safe_revision_id(revision_id)
1403
1271
        if not isinstance(a_bzrdir.transport, LocalTransport):
1404
1272
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
1405
1273
        transport = a_bzrdir.get_workingtree_transport(self)
1406
1274
        control_files = self._open_control_files(a_bzrdir)
1407
1275
        control_files.create_lock()
1408
1276
        control_files.lock_write()
1409
 
        transport.put_bytes('format', self.get_format_string(),
1410
 
            mode=a_bzrdir._get_file_mode())
1411
 
        if from_branch is not None:
1412
 
            branch = from_branch
1413
 
        else:
1414
 
            branch = a_bzrdir.open_branch()
 
1277
        control_files.put_utf8('format', self.get_format_string())
 
1278
        branch = a_bzrdir.open_branch()
1415
1279
        if revision_id is None:
1416
1280
            revision_id = branch.last_revision()
1417
1281
        local_path = transport.local_abspath('dirstate')
1419
1283
        state = dirstate.DirState.initialize(local_path)
1420
1284
        state.unlock()
1421
1285
        del state
1422
 
        wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
 
1286
        wt = WorkingTree4(a_bzrdir.root_transport.local_abspath('.'),
1423
1287
                         branch,
1424
1288
                         _format=self,
1425
1289
                         _bzrdir=a_bzrdir,
1427
1291
        wt._new_tree()
1428
1292
        wt.lock_tree_write()
1429
1293
        try:
1430
 
            self._init_custom_control_files(wt)
1431
 
            if revision_id in (None, _mod_revision.NULL_REVISION):
 
1294
            if revision_id in (None, NULL_REVISION):
1432
1295
                if branch.repository.supports_rich_root():
1433
1296
                    wt._set_root_id(generate_ids.gen_root_id())
1434
1297
                else:
1435
1298
                    wt._set_root_id(ROOT_ID)
1436
1299
                wt.flush()
1437
 
            basis = None
1438
 
            # frequently, we will get here due to branching.  The accelerator
1439
 
            # tree will be the tree from the branch, so the desired basis
1440
 
            # tree will often be a parent of the accelerator tree.
1441
 
            if accelerator_tree is not None:
1442
 
                try:
1443
 
                    basis = accelerator_tree.revision_tree(revision_id)
1444
 
                except errors.NoSuchRevision:
1445
 
                    pass
1446
 
            if basis is None:
1447
 
                basis = branch.repository.revision_tree(revision_id)
1448
 
            if revision_id == _mod_revision.NULL_REVISION:
1449
 
                parents_list = []
1450
 
            else:
1451
 
                parents_list = [(revision_id, basis)]
 
1300
            wt.set_last_revision(revision_id)
 
1301
            wt.flush()
 
1302
            basis = wt.basis_tree()
1452
1303
            basis.lock_read()
1453
 
            try:
1454
 
                wt.set_parent_trees(parents_list, allow_leftmost_as_ghost=True)
 
1304
            # if the basis has a root id we have to use that; otherwise we use
 
1305
            # a new random one
 
1306
            basis_root_id = basis.get_root_id()
 
1307
            if basis_root_id is not None:
 
1308
                wt._set_root_id(basis_root_id)
1455
1309
                wt.flush()
1456
 
                # if the basis has a root id we have to use that; otherwise we
1457
 
                # use a new random one
1458
 
                basis_root_id = basis.get_root_id()
1459
 
                if basis_root_id is not None:
1460
 
                    wt._set_root_id(basis_root_id)
1461
 
                    wt.flush()
1462
 
                if wt.supports_content_filtering():
1463
 
                    # The original tree may not have the same content filters
1464
 
                    # applied so we can't safely build the inventory delta from
1465
 
                    # the source tree.
1466
 
                    delta_from_tree = False
1467
 
                else:
1468
 
                    delta_from_tree = True
1469
 
                # delta_from_tree is safe even for DirStateRevisionTrees,
1470
 
                # because wt4.apply_inventory_delta does not mutate the input
1471
 
                # inventory entries.
1472
 
                transform.build_tree(basis, wt, accelerator_tree,
1473
 
                                     hardlink=hardlink,
1474
 
                                     delta_from_tree=delta_from_tree)
1475
 
            finally:
1476
 
                basis.unlock()
 
1310
            transform.build_tree(basis, wt)
 
1311
            basis.unlock()
1477
1312
        finally:
1478
1313
            control_files.unlock()
1479
1314
            wt.unlock()
1480
1315
        return wt
1481
1316
 
1482
 
    def _init_custom_control_files(self, wt):
1483
 
        """Subclasses with custom control files should override this method.
1484
 
 
1485
 
        The working tree and control files are locked for writing when this
1486
 
        method is called.
1487
 
 
1488
 
        :param wt: the WorkingTree object
1489
 
        """
1490
 
 
1491
1317
    def _open(self, a_bzrdir, control_files):
1492
1318
        """Open the tree itself.
1493
1319
 
1494
1320
        :param a_bzrdir: the dir for the tree.
1495
1321
        :param control_files: the control files for the tree.
1496
1322
        """
1497
 
        return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
 
1323
        return WorkingTree4(a_bzrdir.root_transport.local_abspath('.'),
1498
1324
                           branch=a_bzrdir.open_branch(),
1499
1325
                           _format=self,
1500
1326
                           _bzrdir=a_bzrdir,
1501
1327
                           _control_files=control_files)
1502
1328
 
1503
1329
    def __get_matchingbzrdir(self):
1504
 
        return self._get_matchingbzrdir()
1505
 
 
1506
 
    def _get_matchingbzrdir(self):
1507
 
        """Overrideable method to get a bzrdir for testing."""
1508
1330
        # please test against something that will let us do tree references
1509
1331
        return bzrdir.format_registry.make_bzrdir(
1510
1332
            'dirstate-with-subtree')
1512
1334
    _matchingbzrdir = property(__get_matchingbzrdir)
1513
1335
 
1514
1336
 
1515
 
class WorkingTreeFormat4(DirStateWorkingTreeFormat):
1516
 
    """The first consolidated dirstate working tree format.
1517
 
 
1518
 
    This format:
1519
 
        - exists within a metadir controlling .bzr
1520
 
        - includes an explicit version marker for the workingtree control
1521
 
          files, separate from the BzrDir format
1522
 
        - modifies the hash cache format
1523
 
        - is new in bzr 0.15
1524
 
        - uses a LockDir to guard access to it.
1525
 
    """
1526
 
 
1527
 
    upgrade_recommended = False
1528
 
 
1529
 
    _tree_class = WorkingTree4
1530
 
 
1531
 
    def get_format_string(self):
1532
 
        """See WorkingTreeFormat.get_format_string()."""
1533
 
        return "Bazaar Working Tree Format 4 (bzr 0.15)\n"
1534
 
 
1535
 
    def get_format_description(self):
1536
 
        """See WorkingTreeFormat.get_format_description()."""
1537
 
        return "Working tree format 4"
1538
 
 
1539
 
 
1540
 
class WorkingTreeFormat5(DirStateWorkingTreeFormat):
1541
 
    """WorkingTree format supporting content filtering.
1542
 
    """
1543
 
 
1544
 
    upgrade_recommended = False
1545
 
 
1546
 
    _tree_class = WorkingTree5
1547
 
 
1548
 
    def get_format_string(self):
1549
 
        """See WorkingTreeFormat.get_format_string()."""
1550
 
        return "Bazaar Working Tree Format 5 (bzr 1.11)\n"
1551
 
 
1552
 
    def get_format_description(self):
1553
 
        """See WorkingTreeFormat.get_format_description()."""
1554
 
        return "Working tree format 5"
1555
 
 
1556
 
    def supports_content_filtering(self):
1557
 
        return True
1558
 
 
1559
 
 
1560
 
class WorkingTreeFormat6(DirStateWorkingTreeFormat):
1561
 
    """WorkingTree format supporting views.
1562
 
    """
1563
 
 
1564
 
    upgrade_recommended = False
1565
 
 
1566
 
    _tree_class = WorkingTree6
1567
 
 
1568
 
    def get_format_string(self):
1569
 
        """See WorkingTreeFormat.get_format_string()."""
1570
 
        return "Bazaar Working Tree Format 6 (bzr 1.14)\n"
1571
 
 
1572
 
    def get_format_description(self):
1573
 
        """See WorkingTreeFormat.get_format_description()."""
1574
 
        return "Working tree format 6"
1575
 
 
1576
 
    def _init_custom_control_files(self, wt):
1577
 
        """Subclasses with custom control files should override this method."""
1578
 
        wt._transport.put_bytes('views', '', mode=wt.bzrdir._get_file_mode())
1579
 
 
1580
 
    def supports_content_filtering(self):
1581
 
        return True
1582
 
 
1583
 
    def supports_views(self):
1584
 
        return True
1585
 
 
1586
 
 
1587
1337
class DirStateRevisionTree(Tree):
1588
 
    """A revision tree pulling the inventory from a dirstate.
1589
 
    
1590
 
    Note that this is one of the historical (ie revision) trees cached in the
1591
 
    dirstate for easy access, not the workingtree.
1592
 
    """
 
1338
    """A revision tree pulling the inventory from a dirstate."""
1593
1339
 
1594
1340
    def __init__(self, dirstate, revision_id, repository):
1595
1341
        self._dirstate = dirstate
1596
 
        self._revision_id = revision_id
 
1342
        self._revision_id = osutils.safe_revision_id(revision_id)
1597
1343
        self._repository = repository
1598
1344
        self._inventory = None
1599
1345
        self._locked = 0
1600
1346
        self._dirstate_locked = False
1601
 
        self._repo_supports_tree_reference = getattr(
1602
 
            repository._format, "supports_tree_reference",
1603
 
            False)
1604
1347
 
1605
1348
    def __repr__(self):
1606
1349
        return "<%s of %s in %s>" % \
1609
1352
    def annotate_iter(self, file_id,
1610
1353
                      default_revision=_mod_revision.CURRENT_REVISION):
1611
1354
        """See Tree.annotate_iter"""
1612
 
        text_key = (file_id, self.inventory[file_id].revision)
1613
 
        annotations = self._repository.texts.annotate(text_key)
1614
 
        return [(key[-1], line) for (key, line) in annotations]
 
1355
        w = self._get_weave(file_id)
 
1356
        return w.annotate_iter(self.inventory[file_id].revision)
1615
1357
 
1616
1358
    def _get_ancestors(self, default_revision):
1617
1359
        return set(self._repository.get_ancestry(self._revision_id,
1638
1380
    def get_root_id(self):
1639
1381
        return self.path2id('')
1640
1382
 
1641
 
    def id2path(self, file_id):
1642
 
        "Convert a file-id to a path."
1643
 
        entry = self._get_entry(file_id=file_id)
1644
 
        if entry == (None, None):
1645
 
            raise errors.NoSuchId(tree=self, file_id=file_id)
1646
 
        path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
1647
 
        return path_utf8.decode('utf8')
1648
 
 
1649
 
    def iter_references(self):
1650
 
        if not self._repo_supports_tree_reference:
1651
 
            # When the repo doesn't support references, we will have nothing to
1652
 
            # return
1653
 
            return iter([])
1654
 
        # Otherwise, fall back to the default implementation
1655
 
        return super(DirStateRevisionTree, self).iter_references()
1656
 
 
1657
1383
    def _get_parent_index(self):
1658
1384
        """Return the index in the dirstate referenced by this tree."""
1659
1385
        return self._dirstate.get_parent_ids().index(self._revision_id) + 1
1664
1390
        If either file_id or path is supplied, it is used as the key to lookup.
1665
1391
        If both are supplied, the fastest lookup is used, and an error is
1666
1392
        raised if they do not both point at the same row.
1667
 
 
 
1393
        
1668
1394
        :param file_id: An optional unicode file_id to be looked up.
1669
1395
        :param path: An optional unicode path to be looked up.
1670
1396
        :return: The dirstate row tuple for path/file_id, or (None, None)
1671
1397
        """
1672
1398
        if file_id is None and path is None:
1673
1399
            raise errors.BzrError('must supply file_id or path')
 
1400
        file_id = osutils.safe_file_id(file_id)
1674
1401
        if path is not None:
1675
1402
            path = path.encode('utf8')
1676
1403
        parent_index = self._get_parent_index()
1684
1411
 
1685
1412
        This is relatively expensive: we have to walk the entire dirstate.
1686
1413
        """
1687
 
        if not self._locked:
1688
 
            raise AssertionError(
1689
 
                'cannot generate inventory of an unlocked '
1690
 
                'dirstate revision tree')
 
1414
        assert self._locked, 'cannot generate inventory of an unlocked '\
 
1415
            'dirstate revision tree'
1691
1416
        # separate call for profiling - makes it clear where the costs are.
1692
1417
        self._dirstate._read_dirblocks_if_needed()
1693
 
        if self._revision_id not in self._dirstate.get_parent_ids():
1694
 
            raise AssertionError(
1695
 
                'parent %s has disappeared from %s' % (
1696
 
                self._revision_id, self._dirstate.get_parent_ids()))
 
1418
        assert self._revision_id in self._dirstate.get_parent_ids(), \
 
1419
            'parent %s has disappeared from %s' % (
 
1420
            self._revision_id, self._dirstate.get_parent_ids())
1697
1421
        parent_index = self._dirstate.get_parent_ids().index(self._revision_id) + 1
1698
1422
        # This is identical now to the WorkingTree _generate_inventory except
1699
1423
        # for the tree index use.
1700
1424
        root_key, current_entry = self._dirstate._get_entry(parent_index, path_utf8='')
1701
1425
        current_id = root_key[2]
1702
 
        if current_entry[parent_index][0] != 'd':
1703
 
            raise AssertionError()
 
1426
        assert current_entry[parent_index][0] == 'd'
1704
1427
        inv = Inventory(root_id=current_id, revision_id=self._revision_id)
1705
1428
        inv.root.revision = current_entry[parent_index][4]
1706
1429
        # Turn some things into local variables
1746
1469
                    raise AssertionError("cannot convert entry %r into an InventoryEntry"
1747
1470
                            % entry)
1748
1471
                # These checks cost us around 40ms on a 55k entry tree
1749
 
                if file_id in inv_byid:
1750
 
                    raise AssertionError('file_id %s already in'
1751
 
                        ' inventory as %s' % (file_id, inv_byid[file_id]))
1752
 
                if name_unicode in parent_ie.children:
1753
 
                    raise AssertionError('name %r already in parent'
1754
 
                        % (name_unicode,))
 
1472
                assert file_id not in inv_byid
 
1473
                assert name_unicode not in parent_ie.children
1755
1474
                inv_byid[file_id] = inv_entry
1756
1475
                parent_ie.children[name_unicode] = inv_entry
1757
1476
        self._inventory = inv
1767
1486
            return None
1768
1487
        parent_index = self._get_parent_index()
1769
1488
        last_changed_revision = entry[1][parent_index][4]
1770
 
        try:
1771
 
            rev = self._repository.get_revision(last_changed_revision)
1772
 
        except errors.NoSuchRevision:
1773
 
            raise errors.FileTimestampUnavailable(self.id2path(file_id))
1774
 
        return rev.timestamp
 
1489
        return self._repository.get_revision(last_changed_revision).timestamp
1775
1490
 
1776
1491
    def get_file_sha1(self, file_id, path=None, stat_value=None):
1777
1492
        entry = self._get_entry(file_id=file_id, path=path)
1781
1496
            return parent_details[1]
1782
1497
        return None
1783
1498
 
 
1499
    @symbol_versioning.deprecated_method(symbol_versioning.zero_ninety)
 
1500
    def get_weave(self, file_id):
 
1501
        return self._get_weave(file_id)
 
1502
 
 
1503
    def _get_weave(self, file_id):
 
1504
        return self._repository.weave_store.get_weave(file_id,
 
1505
                self._repository.get_transaction())
 
1506
 
1784
1507
    def get_file(self, file_id, path=None):
1785
1508
        return StringIO(self.get_file_text(file_id))
1786
1509
 
 
1510
    def get_file_lines(self, file_id):
 
1511
        ie = self.inventory[file_id]
 
1512
        return self._get_weave(file_id).get_lines(ie.revision)
 
1513
 
1787
1514
    def get_file_size(self, file_id):
1788
 
        """See Tree.get_file_size"""
1789
1515
        return self.inventory[file_id].text_size
1790
1516
 
1791
 
    def get_file_text(self, file_id, path=None):
1792
 
        _, content = list(self.iter_files_bytes([(file_id, None)]))[0]
1793
 
        return ''.join(content)
 
1517
    def get_file_text(self, file_id):
 
1518
        return ''.join(self.get_file_lines(file_id))
1794
1519
 
1795
1520
    def get_reference_revision(self, file_id, path=None):
1796
1521
        return self.inventory[file_id].reference_revision
1815
1540
        if entry[1][parent_index][0] != 'l':
1816
1541
            return None
1817
1542
        else:
1818
 
            target = entry[1][parent_index][1]
1819
 
            target = target.decode('utf8')
1820
 
            return target
 
1543
            # At present, none of the tree implementations supports non-ascii
 
1544
            # symlink targets. So we will just assume that the dirstate path is
 
1545
            # correct.
 
1546
            return entry[1][parent_index][1]
1821
1547
 
1822
1548
    def get_revision_id(self):
1823
1549
        """Return the revision id for this tree."""
1841
1567
        return bool(self.path2id(filename))
1842
1568
 
1843
1569
    def kind(self, file_id):
1844
 
        entry = self._get_entry(file_id=file_id)[1]
1845
 
        if entry is None:
1846
 
            raise errors.NoSuchId(tree=self, file_id=file_id)
1847
 
        parent_index = self._get_parent_index()
1848
 
        return dirstate.DirState._minikind_to_kind[entry[parent_index][0]]
1849
 
 
1850
 
    def stored_kind(self, file_id):
1851
 
        """See Tree.stored_kind"""
1852
 
        return self.kind(file_id)
1853
 
 
1854
 
    def path_content_summary(self, path):
1855
 
        """See Tree.path_content_summary."""
1856
 
        id = self.inventory.path2id(path)
1857
 
        if id is None:
1858
 
            return ('missing', None, None, None)
1859
 
        entry = self._inventory[id]
1860
 
        kind = entry.kind
1861
 
        if kind == 'file':
1862
 
            return (kind, entry.text_size, entry.executable, entry.text_sha1)
1863
 
        elif kind == 'symlink':
1864
 
            return (kind, None, None, entry.symlink_target)
1865
 
        else:
1866
 
            return (kind, None, None, None)
 
1570
        return self.inventory[file_id].kind
1867
1571
 
1868
1572
    def is_executable(self, file_id, path=None):
1869
1573
        ie = self.inventory[file_id]
1871
1575
            return None
1872
1576
        return ie.executable
1873
1577
 
1874
 
    def is_locked(self):
1875
 
        return self._locked
1876
 
 
1877
 
    def list_files(self, include_root=False, from_dir=None, recursive=True):
 
1578
    def list_files(self, include_root=False):
1878
1579
        # We use a standard implementation, because DirStateRevisionTree is
1879
1580
        # dealing with one of the parents of the current state
1880
1581
        inv = self._get_inventory()
1881
 
        if from_dir is None:
1882
 
            from_dir_id = None
1883
 
        else:
1884
 
            from_dir_id = inv.path2id(from_dir)
1885
 
            if from_dir_id is None:
1886
 
                # Directory not versioned
1887
 
                return
1888
 
        entries = inv.iter_entries(from_dir=from_dir_id, recursive=recursive)
1889
 
        if inv.root is not None and not include_root and from_dir is None:
 
1582
        entries = inv.iter_entries()
 
1583
        if self.inventory.root is not None and not include_root:
1890
1584
            entries.next()
1891
1585
        for path, entry in entries:
1892
1586
            yield path, 'V', entry.kind, entry.file_id, entry
1893
1587
 
1894
1588
    def lock_read(self):
1895
 
        """Lock the tree for a set of operations.
1896
 
 
1897
 
        :return: A bzrlib.lock.LogicalLockResult.
1898
 
        """
 
1589
        """Lock the tree for a set of operations."""
1899
1590
        if not self._locked:
1900
1591
            self._repository.lock_read()
1901
1592
            if self._dirstate._lock_token is None:
1902
1593
                self._dirstate.lock_read()
1903
1594
                self._dirstate_locked = True
1904
1595
        self._locked += 1
1905
 
        return LogicalLockResult(self.unlock)
1906
1596
 
1907
1597
    def _must_be_locked(self):
1908
1598
        if not self._locked:
1929
1619
                self._dirstate_locked = False
1930
1620
            self._repository.unlock()
1931
1621
 
1932
 
    @needs_read_lock
1933
 
    def supports_tree_reference(self):
1934
 
        return self._repo_supports_tree_reference
1935
 
 
1936
1622
    def walkdirs(self, prefix=""):
1937
1623
        # TODO: jam 20070215 This is the lazy way by using the RevisionTree
1938
 
        # implementation based on an inventory.
 
1624
        # implementation based on an inventory.  
1939
1625
        # This should be cleaned up to use the much faster Dirstate code
1940
1626
        # So for now, we just build up the parent inventory, and extract
1941
1627
        # it the same way RevisionTree does.
1970
1656
 
1971
1657
class InterDirStateTree(InterTree):
1972
1658
    """Fast path optimiser for changes_from with dirstate trees.
1973
 
 
1974
 
    This is used only when both trees are in the dirstate working file, and
1975
 
    the source is any parent within the dirstate, and the destination is
 
1659
    
 
1660
    This is used only when both trees are in the dirstate working file, and 
 
1661
    the source is any parent within the dirstate, and the destination is 
1976
1662
    the current working tree of the same dirstate.
1977
1663
    """
1978
1664
    # this could be generalized to allow comparisons between any trees in the
1991
1677
        target.set_parent_ids([revid])
1992
1678
        return target.basis_tree(), target
1993
1679
 
1994
 
    @classmethod
1995
 
    def make_source_parent_tree_python_dirstate(klass, test_case, source, target):
1996
 
        result = klass.make_source_parent_tree(source, target)
1997
 
        result[1]._iter_changes = dirstate.ProcessEntryPython
1998
 
        return result
1999
 
 
2000
 
    @classmethod
2001
 
    def make_source_parent_tree_compiled_dirstate(klass, test_case, source,
2002
 
                                                  target):
2003
 
        from bzrlib.tests.test__dirstate_helpers import \
2004
 
            compiled_dirstate_helpers_feature
2005
 
        test_case.requireFeature(compiled_dirstate_helpers_feature)
2006
 
        from bzrlib._dirstate_helpers_pyx import ProcessEntryC
2007
 
        result = klass.make_source_parent_tree(source, target)
2008
 
        result[1]._iter_changes = ProcessEntryC
2009
 
        return result
2010
 
 
2011
1680
    _matching_from_tree_format = WorkingTreeFormat4()
2012
1681
    _matching_to_tree_format = WorkingTreeFormat4()
2013
 
 
2014
 
    @classmethod
2015
 
    def _test_mutable_trees_to_test_trees(klass, test_case, source, target):
2016
 
        # This method shouldn't be called, because we have python and C
2017
 
        # specific flavours.
2018
 
        raise NotImplementedError
2019
 
 
2020
 
    def iter_changes(self, include_unchanged=False,
 
1682
    _test_mutable_trees_to_test_trees = make_source_parent_tree
 
1683
 
 
1684
    def _iter_changes(self, include_unchanged=False,
2021
1685
                      specific_files=None, pb=None, extra_trees=[],
2022
1686
                      require_versioned=True, want_unversioned=False):
2023
1687
        """Return the changes from source to target.
2024
1688
 
2025
 
        :return: An iterator that yields tuples. See InterTree.iter_changes
 
1689
        :return: An iterator that yields tuples. See InterTree._iter_changes
2026
1690
            for details.
2027
1691
        :param specific_files: An optional list of file paths to restrict the
2028
1692
            comparison to. When mapping filenames to ids, all matches in all
2039
1703
            output. An unversioned file is defined as one with (False, False)
2040
1704
            for the versioned pair.
2041
1705
        """
 
1706
        utf8_decode = cache_utf8._utf8_decode
 
1707
        _minikind_to_kind = dirstate.DirState._minikind_to_kind
 
1708
        cmp_by_dirs = dirstate.cmp_by_dirs
 
1709
        # NB: show_status depends on being able to pass in non-versioned files
 
1710
        # and report them as unknown
2042
1711
        # TODO: handle extra trees in the dirstate.
2043
 
        if (extra_trees or specific_files == []):
 
1712
        # TODO: handle comparisons as an empty tree as a different special
 
1713
        # case? mbp 20070226
 
1714
        if (extra_trees or (self.source._revision_id == NULL_REVISION)
 
1715
            or specific_files == []):
2044
1716
            # we can't fast-path these cases (yet)
2045
 
            return super(InterDirStateTree, self).iter_changes(
 
1717
            for f in super(InterDirStateTree, self)._iter_changes(
2046
1718
                include_unchanged, specific_files, pb, extra_trees,
2047
 
                require_versioned, want_unversioned=want_unversioned)
 
1719
                require_versioned, want_unversioned=want_unversioned):
 
1720
                yield f
 
1721
            return
2048
1722
        parent_ids = self.target.get_parent_ids()
2049
 
        if not (self.source._revision_id in parent_ids
2050
 
                or self.source._revision_id == _mod_revision.NULL_REVISION):
2051
 
            raise AssertionError(
2052
 
                "revision {%s} is not stored in {%s}, but %s "
2053
 
                "can only be used for trees stored in the dirstate"
2054
 
                % (self.source._revision_id, self.target, self.iter_changes))
 
1723
        assert (self.source._revision_id in parent_ids), \
 
1724
                "revision {%s} is not stored in {%s}, but %s " \
 
1725
                "can only be used for trees stored in the dirstate" \
 
1726
                % (self.source._revision_id, self.target, self._iter_changes)
2055
1727
        target_index = 0
2056
 
        if self.source._revision_id == _mod_revision.NULL_REVISION:
 
1728
        if self.source._revision_id == NULL_REVISION:
2057
1729
            source_index = None
2058
1730
            indices = (target_index,)
2059
1731
        else:
2060
 
            if not (self.source._revision_id in parent_ids):
2061
 
                raise AssertionError(
2062
 
                    "Failure: source._revision_id: %s not in target.parent_ids(%s)" % (
2063
 
                    self.source._revision_id, parent_ids))
 
1732
            assert (self.source._revision_id in parent_ids), \
 
1733
                "Failure: source._revision_id: %s not in target.parent_ids(%s)" % (
 
1734
                self.source._revision_id, parent_ids)
2064
1735
            source_index = 1 + parent_ids.index(self.source._revision_id)
2065
 
            indices = (source_index, target_index)
 
1736
            indices = (source_index,target_index)
2066
1737
        # -- make all specific_files utf8 --
2067
1738
        if specific_files:
2068
1739
            specific_files_utf8 = set()
2069
1740
            for path in specific_files:
2070
 
                # Note, if there are many specific files, using cache_utf8
2071
 
                # would be good here.
2072
1741
                specific_files_utf8.add(path.encode('utf8'))
2073
1742
            specific_files = specific_files_utf8
2074
1743
        else:
2075
1744
            specific_files = set([''])
2076
1745
        # -- specific_files is now a utf8 path set --
2077
 
 
2078
1746
        # -- get the state object and prepare it.
2079
1747
        state = self.target.current_dirstate()
2080
1748
        state._read_dirblocks_if_needed()
 
1749
        def _entries_for_path(path):
 
1750
            """Return a list with all the entries that match path for all ids.
 
1751
            """
 
1752
            dirname, basename = os.path.split(path)
 
1753
            key = (dirname, basename, '')
 
1754
            block_index, present = state._find_block_index_from_key(key)
 
1755
            if not present:
 
1756
                # the block which should contain path is absent.
 
1757
                return []
 
1758
            result = []
 
1759
            block = state._dirblocks[block_index][1]
 
1760
            entry_index, _ = state._find_entry_index(key, block)
 
1761
            # we may need to look at multiple entries at this path: walk while the specific_files match.
 
1762
            while (entry_index < len(block) and
 
1763
                block[entry_index][0][0:2] == key[0:2]):
 
1764
                result.append(block[entry_index])
 
1765
                entry_index += 1
 
1766
            return result
2081
1767
        if require_versioned:
2082
1768
            # -- check all supplied paths are versioned in a search tree. --
2083
 
            not_versioned = []
 
1769
            all_versioned = True
2084
1770
            for path in specific_files:
2085
 
                path_entries = state._entries_for_path(path)
 
1771
                path_entries = _entries_for_path(path)
2086
1772
                if not path_entries:
2087
1773
                    # this specified path is not present at all: error
2088
 
                    not_versioned.append(path)
2089
 
                    continue
 
1774
                    all_versioned = False
 
1775
                    break
2090
1776
                found_versioned = False
2091
1777
                # for each id at this path
2092
1778
                for entry in path_entries:
2099
1785
                if not found_versioned:
2100
1786
                    # none of the indexes was not 'absent' at all ids for this
2101
1787
                    # path.
2102
 
                    not_versioned.append(path)
2103
 
            if len(not_versioned) > 0:
2104
 
                raise errors.PathsNotVersionedError(not_versioned)
 
1788
                    all_versioned = False
 
1789
                    break
 
1790
            if not all_versioned:
 
1791
                raise errors.PathsNotVersionedError(specific_files)
2105
1792
        # -- remove redundancy in supplied specific_files to prevent over-scanning --
2106
 
        search_specific_files = osutils.minimum_path_selection(specific_files)
 
1793
        search_specific_files = set()
 
1794
        for path in specific_files:
 
1795
            other_specific_files = specific_files.difference(set([path]))
 
1796
            if not osutils.is_inside_any(other_specific_files, path):
 
1797
                # this is a top level path, we must check it.
 
1798
                search_specific_files.add(path)
 
1799
        # sketch: 
 
1800
        # compare source_index and target_index at or under each element of search_specific_files.
 
1801
        # follow the following comparison table. Note that we only want to do diff operations when
 
1802
        # the target is fdl because thats when the walkdirs logic will have exposed the pathinfo 
 
1803
        # for the target.
 
1804
        # cases:
 
1805
        # 
 
1806
        # Source | Target | disk | action
 
1807
        #   r    | fdlt   |      | add source to search, add id path move and perform
 
1808
        #        |        |      | diff check on source-target
 
1809
        #   r    | fdlt   |  a   | dangling file that was present in the basis. 
 
1810
        #        |        |      | ???
 
1811
        #   r    |  a     |      | add source to search
 
1812
        #   r    |  a     |  a   | 
 
1813
        #   r    |  r     |      | this path is present in a non-examined tree, skip.
 
1814
        #   r    |  r     |  a   | this path is present in a non-examined tree, skip.
 
1815
        #   a    | fdlt   |      | add new id
 
1816
        #   a    | fdlt   |  a   | dangling locally added file, skip
 
1817
        #   a    |  a     |      | not present in either tree, skip
 
1818
        #   a    |  a     |  a   | not present in any tree, skip
 
1819
        #   a    |  r     |      | not present in either tree at this path, skip as it
 
1820
        #        |        |      | may not be selected by the users list of paths.
 
1821
        #   a    |  r     |  a   | not present in either tree at this path, skip as it
 
1822
        #        |        |      | may not be selected by the users list of paths.
 
1823
        #  fdlt  | fdlt   |      | content in both: diff them
 
1824
        #  fdlt  | fdlt   |  a   | deleted locally, but not unversioned - show as deleted ?
 
1825
        #  fdlt  |  a     |      | unversioned: output deleted id for now
 
1826
        #  fdlt  |  a     |  a   | unversioned and deleted: output deleted id
 
1827
        #  fdlt  |  r     |      | relocated in this tree, so add target to search.
 
1828
        #        |        |      | Dont diff, we will see an r,fd; pair when we reach
 
1829
        #        |        |      | this id at the other path.
 
1830
        #  fdlt  |  r     |  a   | relocated in this tree, so add target to search.
 
1831
        #        |        |      | Dont diff, we will see an r,fd; pair when we reach
 
1832
        #        |        |      | this id at the other path.
 
1833
 
 
1834
        # for all search_indexs in each path at or under each element of
 
1835
        # search_specific_files, if the detail is relocated: add the id, and add the
 
1836
        # relocated path as one to search if its not searched already. If the
 
1837
        # detail is not relocated, add the id.
 
1838
        searched_specific_files = set()
 
1839
        NULL_PARENT_DETAILS = dirstate.DirState.NULL_PARENT_DETAILS
 
1840
        # Using a list so that we can access the values and change them in
 
1841
        # nested scope. Each one is [path, file_id, entry]
 
1842
        last_source_parent = [None, None]
 
1843
        last_target_parent = [None, None]
2107
1844
 
2108
1845
        use_filesystem_for_exec = (sys.platform != 'win32')
2109
 
        iter_changes = self.target._iter_changes(include_unchanged,
2110
 
            use_filesystem_for_exec, search_specific_files, state,
2111
 
            source_index, target_index, want_unversioned, self.target)
2112
 
        return iter_changes.iter_changes()
 
1846
 
 
1847
        # Just a sentry, so that _process_entry can say that this
 
1848
        # record is handled, but isn't interesting to process (unchanged)
 
1849
        uninteresting = object()
 
1850
 
 
1851
 
 
1852
        old_dirname_to_file_id = {}
 
1853
        new_dirname_to_file_id = {}
 
1854
        # TODO: jam 20070516 - Avoid the _get_entry lookup overhead by
 
1855
        #       keeping a cache of directories that we have seen.
 
1856
 
 
1857
        def _process_entry(entry, path_info):
 
1858
            """Compare an entry and real disk to generate delta information.
 
1859
 
 
1860
            :param path_info: top_relpath, basename, kind, lstat, abspath for
 
1861
                the path of entry. If None, then the path is considered absent.
 
1862
                (Perhaps we should pass in a concrete entry for this ?)
 
1863
                Basename is returned as a utf8 string because we expect this
 
1864
                tuple will be ignored, and don't want to take the time to
 
1865
                decode.
 
1866
            :return: None if these don't match
 
1867
                     A tuple of information about the change, or
 
1868
                     the object 'uninteresting' if these match, but are
 
1869
                     basically identical.
 
1870
            """
 
1871
            if source_index is None:
 
1872
                source_details = NULL_PARENT_DETAILS
 
1873
            else:
 
1874
                source_details = entry[1][source_index]
 
1875
            target_details = entry[1][target_index]
 
1876
            target_minikind = target_details[0]
 
1877
            if path_info is not None and target_minikind in 'fdlt':
 
1878
                assert target_index == 0
 
1879
                link_or_sha1 = state.update_entry(entry, abspath=path_info[4],
 
1880
                                                  stat_value=path_info[3])
 
1881
                # The entry may have been modified by update_entry
 
1882
                target_details = entry[1][target_index]
 
1883
                target_minikind = target_details[0]
 
1884
            else:
 
1885
                link_or_sha1 = None
 
1886
            file_id = entry[0][2]
 
1887
            source_minikind = source_details[0]
 
1888
            if source_minikind in 'fdltr' and target_minikind in 'fdlt':
 
1889
                # claimed content in both: diff
 
1890
                #   r    | fdlt   |      | add source to search, add id path move and perform
 
1891
                #        |        |      | diff check on source-target
 
1892
                #   r    | fdlt   |  a   | dangling file that was present in the basis.
 
1893
                #        |        |      | ???
 
1894
                if source_minikind in 'r':
 
1895
                    # add the source to the search path to find any children it
 
1896
                    # has.  TODO ? : only add if it is a container ?
 
1897
                    if not osutils.is_inside_any(searched_specific_files,
 
1898
                                                 source_details[1]):
 
1899
                        search_specific_files.add(source_details[1])
 
1900
                    # generate the old path; this is needed for stating later
 
1901
                    # as well.
 
1902
                    old_path = source_details[1]
 
1903
                    old_dirname, old_basename = os.path.split(old_path)
 
1904
                    path = pathjoin(entry[0][0], entry[0][1])
 
1905
                    old_entry = state._get_entry(source_index,
 
1906
                                                 path_utf8=old_path)
 
1907
                    # update the source details variable to be the real
 
1908
                    # location.
 
1909
                    source_details = old_entry[1][source_index]
 
1910
                    source_minikind = source_details[0]
 
1911
                else:
 
1912
                    old_dirname = entry[0][0]
 
1913
                    old_basename = entry[0][1]
 
1914
                    old_path = path = None
 
1915
                if path_info is None:
 
1916
                    # the file is missing on disk, show as removed.
 
1917
                    content_change = True
 
1918
                    target_kind = None
 
1919
                    target_exec = False
 
1920
                else:
 
1921
                    # source and target are both versioned and disk file is present.
 
1922
                    target_kind = path_info[2]
 
1923
                    if target_kind == 'directory':
 
1924
                        if path is None:
 
1925
                            old_path = path = pathjoin(old_dirname, old_basename)
 
1926
                        new_dirname_to_file_id[path] = file_id
 
1927
                        if source_minikind != 'd':
 
1928
                            content_change = True
 
1929
                        else:
 
1930
                            # directories have no fingerprint
 
1931
                            content_change = False
 
1932
                        target_exec = False
 
1933
                    elif target_kind == 'file':
 
1934
                        if source_minikind != 'f':
 
1935
                            content_change = True
 
1936
                        else:
 
1937
                            # We could check the size, but we already have the
 
1938
                            # sha1 hash.
 
1939
                            content_change = (link_or_sha1 != source_details[1])
 
1940
                        # Target details is updated at update_entry time
 
1941
                        if use_filesystem_for_exec:
 
1942
                            # We don't need S_ISREG here, because we are sure
 
1943
                            # we are dealing with a file.
 
1944
                            target_exec = bool(stat.S_IEXEC & path_info[3].st_mode)
 
1945
                        else:
 
1946
                            target_exec = target_details[3]
 
1947
                    elif target_kind == 'symlink':
 
1948
                        if source_minikind != 'l':
 
1949
                            content_change = True
 
1950
                        else:
 
1951
                            content_change = (link_or_sha1 != source_details[1])
 
1952
                        target_exec = False
 
1953
                    elif target_kind == 'tree-reference':
 
1954
                        if source_minikind != 't':
 
1955
                            content_change = True
 
1956
                        else:
 
1957
                            content_change = False
 
1958
                        target_exec = False
 
1959
                    else:
 
1960
                        raise Exception, "unknown kind %s" % path_info[2]
 
1961
                if source_minikind == 'd':
 
1962
                    if path is None:
 
1963
                        old_path = path = pathjoin(old_dirname, old_basename)
 
1964
                    old_dirname_to_file_id[old_path] = file_id
 
1965
                # parent id is the entry for the path in the target tree
 
1966
                if old_dirname == last_source_parent[0]:
 
1967
                    source_parent_id = last_source_parent[1]
 
1968
                else:
 
1969
                    try:
 
1970
                        source_parent_id = old_dirname_to_file_id[old_dirname]
 
1971
                    except KeyError:
 
1972
                        source_parent_entry = state._get_entry(source_index,
 
1973
                                                               path_utf8=old_dirname)
 
1974
                        source_parent_id = source_parent_entry[0][2]
 
1975
                    if source_parent_id == entry[0][2]:
 
1976
                        # This is the root, so the parent is None
 
1977
                        source_parent_id = None
 
1978
                    else:
 
1979
                        last_source_parent[0] = old_dirname
 
1980
                        last_source_parent[1] = source_parent_id
 
1981
                new_dirname = entry[0][0]
 
1982
                if new_dirname == last_target_parent[0]:
 
1983
                    target_parent_id = last_target_parent[1]
 
1984
                else:
 
1985
                    try:
 
1986
                        target_parent_id = new_dirname_to_file_id[new_dirname]
 
1987
                    except KeyError:
 
1988
                        # TODO: We don't always need to do the lookup, because the
 
1989
                        #       parent entry will be the same as the source entry.
 
1990
                        target_parent_entry = state._get_entry(target_index,
 
1991
                                                               path_utf8=new_dirname)
 
1992
                        assert target_parent_entry != (None, None), (
 
1993
                            "Could not find target parent in wt: %s\nparent of: %s"
 
1994
                            % (new_dirname, entry))
 
1995
                        target_parent_id = target_parent_entry[0][2]
 
1996
                    if target_parent_id == entry[0][2]:
 
1997
                        # This is the root, so the parent is None
 
1998
                        target_parent_id = None
 
1999
                    else:
 
2000
                        last_target_parent[0] = new_dirname
 
2001
                        last_target_parent[1] = target_parent_id
 
2002
 
 
2003
                source_exec = source_details[3]
 
2004
                if (include_unchanged
 
2005
                    or content_change
 
2006
                    or source_parent_id != target_parent_id
 
2007
                    or old_basename != entry[0][1]
 
2008
                    or source_exec != target_exec
 
2009
                    ):
 
2010
                    if old_path is None:
 
2011
                        old_path = path = pathjoin(old_dirname, old_basename)
 
2012
                        old_path_u = utf8_decode(old_path)[0]
 
2013
                        path_u = old_path_u
 
2014
                    else:
 
2015
                        old_path_u = utf8_decode(old_path)[0]
 
2016
                        if old_path == path:
 
2017
                            path_u = old_path_u
 
2018
                        else:
 
2019
                            path_u = utf8_decode(path)[0]
 
2020
                    source_kind = _minikind_to_kind[source_minikind]
 
2021
                    return (entry[0][2],
 
2022
                           (old_path_u, path_u),
 
2023
                           content_change,
 
2024
                           (True, True),
 
2025
                           (source_parent_id, target_parent_id),
 
2026
                           (utf8_decode(old_basename)[0], utf8_decode(entry[0][1])[0]),
 
2027
                           (source_kind, target_kind),
 
2028
                           (source_exec, target_exec))
 
2029
                else:
 
2030
                    return uninteresting
 
2031
            elif source_minikind in 'a' and target_minikind in 'fdlt':
 
2032
                # looks like a new file
 
2033
                if path_info is not None:
 
2034
                    path = pathjoin(entry[0][0], entry[0][1])
 
2035
                    # parent id is the entry for the path in the target tree
 
2036
                    # TODO: these are the same for an entire directory: cache em.
 
2037
                    parent_id = state._get_entry(target_index,
 
2038
                                                 path_utf8=entry[0][0])[0][2]
 
2039
                    if parent_id == entry[0][2]:
 
2040
                        parent_id = None
 
2041
                    if use_filesystem_for_exec:
 
2042
                        # We need S_ISREG here, because we aren't sure if this
 
2043
                        # is a file or not.
 
2044
                        target_exec = bool(
 
2045
                            stat.S_ISREG(path_info[3].st_mode)
 
2046
                            and stat.S_IEXEC & path_info[3].st_mode)
 
2047
                    else:
 
2048
                        target_exec = target_details[3]
 
2049
                    return (entry[0][2],
 
2050
                           (None, utf8_decode(path)[0]),
 
2051
                           True,
 
2052
                           (False, True),
 
2053
                           (None, parent_id),
 
2054
                           (None, utf8_decode(entry[0][1])[0]),
 
2055
                           (None, path_info[2]),
 
2056
                           (None, target_exec))
 
2057
                else:
 
2058
                    # but its not on disk: we deliberately treat this as just
 
2059
                    # never-present. (Why ?! - RBC 20070224)
 
2060
                    pass
 
2061
            elif source_minikind in 'fdlt' and target_minikind in 'a':
 
2062
                # unversioned, possibly, or possibly not deleted: we dont care.
 
2063
                # if its still on disk, *and* theres no other entry at this
 
2064
                # path [we dont know this in this routine at the moment -
 
2065
                # perhaps we should change this - then it would be an unknown.
 
2066
                old_path = pathjoin(entry[0][0], entry[0][1])
 
2067
                # parent id is the entry for the path in the target tree
 
2068
                parent_id = state._get_entry(source_index, path_utf8=entry[0][0])[0][2]
 
2069
                if parent_id == entry[0][2]:
 
2070
                    parent_id = None
 
2071
                return (entry[0][2],
 
2072
                       (utf8_decode(old_path)[0], None),
 
2073
                       True,
 
2074
                       (True, False),
 
2075
                       (parent_id, None),
 
2076
                       (utf8_decode(entry[0][1])[0], None),
 
2077
                       (_minikind_to_kind[source_minikind], None),
 
2078
                       (source_details[3], None))
 
2079
            elif source_minikind in 'fdlt' and target_minikind in 'r':
 
2080
                # a rename; could be a true rename, or a rename inherited from
 
2081
                # a renamed parent. TODO: handle this efficiently. Its not
 
2082
                # common case to rename dirs though, so a correct but slow
 
2083
                # implementation will do.
 
2084
                if not osutils.is_inside_any(searched_specific_files, target_details[1]):
 
2085
                    search_specific_files.add(target_details[1])
 
2086
            elif source_minikind in 'ra' and target_minikind in 'ra':
 
2087
                # neither of the selected trees contain this file,
 
2088
                # so skip over it. This is not currently directly tested, but
 
2089
                # is indirectly via test_too_much.TestCommands.test_conflicts.
 
2090
                pass
 
2091
            else:
 
2092
                raise AssertionError("don't know how to compare "
 
2093
                    "source_minikind=%r, target_minikind=%r"
 
2094
                    % (source_minikind, target_minikind))
 
2095
                ## import pdb;pdb.set_trace()
 
2096
            return None
 
2097
 
 
2098
        while search_specific_files:
 
2099
            # TODO: the pending list should be lexically sorted?  the
 
2100
            # interface doesn't require it.
 
2101
            current_root = search_specific_files.pop()
 
2102
            current_root_unicode = current_root.decode('utf8')
 
2103
            searched_specific_files.add(current_root)
 
2104
            # process the entries for this containing directory: the rest will be
 
2105
            # found by their parents recursively.
 
2106
            root_entries = _entries_for_path(current_root)
 
2107
            root_abspath = self.target.abspath(current_root_unicode)
 
2108
            try:
 
2109
                root_stat = os.lstat(root_abspath)
 
2110
            except OSError, e:
 
2111
                if e.errno == errno.ENOENT:
 
2112
                    # the path does not exist: let _process_entry know that.
 
2113
                    root_dir_info = None
 
2114
                else:
 
2115
                    # some other random error: hand it up.
 
2116
                    raise
 
2117
            else:
 
2118
                root_dir_info = ('', current_root,
 
2119
                    osutils.file_kind_from_stat_mode(root_stat.st_mode), root_stat,
 
2120
                    root_abspath)
 
2121
                if root_dir_info[2] == 'directory':
 
2122
                    if self.target._directory_is_tree_reference(
 
2123
                        current_root.decode('utf8')):
 
2124
                        root_dir_info = root_dir_info[:2] + \
 
2125
                            ('tree-reference',) + root_dir_info[3:]
 
2126
 
 
2127
            if not root_entries and not root_dir_info:
 
2128
                # this specified path is not present at all, skip it.
 
2129
                continue
 
2130
            path_handled = False
 
2131
            for entry in root_entries:
 
2132
                result = _process_entry(entry, root_dir_info)
 
2133
                if result is not None:
 
2134
                    path_handled = True
 
2135
                    if result is not uninteresting:
 
2136
                        yield result
 
2137
            if want_unversioned and not path_handled and root_dir_info:
 
2138
                new_executable = bool(
 
2139
                    stat.S_ISREG(root_dir_info[3].st_mode)
 
2140
                    and stat.S_IEXEC & root_dir_info[3].st_mode)
 
2141
                yield (None,
 
2142
                       (None, current_root_unicode),
 
2143
                       True,
 
2144
                       (False, False),
 
2145
                       (None, None),
 
2146
                       (None, splitpath(current_root_unicode)[-1]),
 
2147
                       (None, root_dir_info[2]),
 
2148
                       (None, new_executable)
 
2149
                      )
 
2150
            initial_key = (current_root, '', '')
 
2151
            block_index, _ = state._find_block_index_from_key(initial_key)
 
2152
            if block_index == 0:
 
2153
                # we have processed the total root already, but because the
 
2154
                # initial key matched it we should skip it here.
 
2155
                block_index +=1
 
2156
            if root_dir_info and root_dir_info[2] == 'tree-reference':
 
2157
                current_dir_info = None
 
2158
            else:
 
2159
                dir_iterator = osutils._walkdirs_utf8(root_abspath, prefix=current_root)
 
2160
                try:
 
2161
                    current_dir_info = dir_iterator.next()
 
2162
                except OSError, e:
 
2163
                    # on win32, python2.4 has e.errno == ERROR_DIRECTORY, but
 
2164
                    # python 2.5 has e.errno == EINVAL,
 
2165
                    #            and e.winerror == ERROR_DIRECTORY
 
2166
                    e_winerror = getattr(e, 'winerror', None)
 
2167
                    win_errors = (ERROR_DIRECTORY, ERROR_PATH_NOT_FOUND)
 
2168
                    # there may be directories in the inventory even though
 
2169
                    # this path is not a file on disk: so mark it as end of
 
2170
                    # iterator
 
2171
                    if e.errno in (errno.ENOENT, errno.ENOTDIR, errno.EINVAL):
 
2172
                        current_dir_info = None
 
2173
                    elif (sys.platform == 'win32'
 
2174
                          and (e.errno in win_errors
 
2175
                               or e_winerror in win_errors)):
 
2176
                        current_dir_info = None
 
2177
                    else:
 
2178
                        raise
 
2179
                else:
 
2180
                    if current_dir_info[0][0] == '':
 
2181
                        # remove .bzr from iteration
 
2182
                        bzr_index = bisect_left(current_dir_info[1], ('.bzr',))
 
2183
                        assert current_dir_info[1][bzr_index][0] == '.bzr'
 
2184
                        del current_dir_info[1][bzr_index]
 
2185
            # walk until both the directory listing and the versioned metadata
 
2186
            # are exhausted. 
 
2187
            if (block_index < len(state._dirblocks) and
 
2188
                osutils.is_inside(current_root, state._dirblocks[block_index][0])):
 
2189
                current_block = state._dirblocks[block_index]
 
2190
            else:
 
2191
                current_block = None
 
2192
            while (current_dir_info is not None or
 
2193
                   current_block is not None):
 
2194
                if (current_dir_info and current_block
 
2195
                    and current_dir_info[0][0] != current_block[0]):
 
2196
                    if cmp_by_dirs(current_dir_info[0][0], current_block[0]) < 0:
 
2197
                        # filesystem data refers to paths not covered by the dirblock.
 
2198
                        # this has two possibilities:
 
2199
                        # A) it is versioned but empty, so there is no block for it
 
2200
                        # B) it is not versioned.
 
2201
 
 
2202
                        # if (A) then we need to recurse into it to check for
 
2203
                        # new unknown files or directories.
 
2204
                        # if (B) then we should ignore it, because we don't
 
2205
                        # recurse into unknown directories.
 
2206
                        path_index = 0
 
2207
                        while path_index < len(current_dir_info[1]):
 
2208
                                current_path_info = current_dir_info[1][path_index]
 
2209
                                if want_unversioned:
 
2210
                                    if current_path_info[2] == 'directory':
 
2211
                                        if self.target._directory_is_tree_reference(
 
2212
                                            current_path_info[0].decode('utf8')):
 
2213
                                            current_path_info = current_path_info[:2] + \
 
2214
                                                ('tree-reference',) + current_path_info[3:]
 
2215
                                    new_executable = bool(
 
2216
                                        stat.S_ISREG(current_path_info[3].st_mode)
 
2217
                                        and stat.S_IEXEC & current_path_info[3].st_mode)
 
2218
                                    yield (None,
 
2219
                                        (None, utf8_decode(current_path_info[0])[0]),
 
2220
                                        True,
 
2221
                                        (False, False),
 
2222
                                        (None, None),
 
2223
                                        (None, utf8_decode(current_path_info[1])[0]),
 
2224
                                        (None, current_path_info[2]),
 
2225
                                        (None, new_executable))
 
2226
                                # dont descend into this unversioned path if it is
 
2227
                                # a dir
 
2228
                                if current_path_info[2] in ('directory',
 
2229
                                                            'tree-reference'):
 
2230
                                    del current_dir_info[1][path_index]
 
2231
                                    path_index -= 1
 
2232
                                path_index += 1
 
2233
 
 
2234
                        # This dir info has been handled, go to the next
 
2235
                        try:
 
2236
                            current_dir_info = dir_iterator.next()
 
2237
                        except StopIteration:
 
2238
                            current_dir_info = None
 
2239
                    else:
 
2240
                        # We have a dirblock entry for this location, but there
 
2241
                        # is no filesystem path for this. This is most likely
 
2242
                        # because a directory was removed from the disk.
 
2243
                        # We don't have to report the missing directory,
 
2244
                        # because that should have already been handled, but we
 
2245
                        # need to handle all of the files that are contained
 
2246
                        # within.
 
2247
                        for current_entry in current_block[1]:
 
2248
                            # entry referring to file not present on disk.
 
2249
                            # advance the entry only, after processing.
 
2250
                            result = _process_entry(current_entry, None)
 
2251
                            if result is not None:
 
2252
                                if result is not uninteresting:
 
2253
                                    yield result
 
2254
                        block_index +=1
 
2255
                        if (block_index < len(state._dirblocks) and
 
2256
                            osutils.is_inside(current_root,
 
2257
                                              state._dirblocks[block_index][0])):
 
2258
                            current_block = state._dirblocks[block_index]
 
2259
                        else:
 
2260
                            current_block = None
 
2261
                    continue
 
2262
                entry_index = 0
 
2263
                if current_block and entry_index < len(current_block[1]):
 
2264
                    current_entry = current_block[1][entry_index]
 
2265
                else:
 
2266
                    current_entry = None
 
2267
                advance_entry = True
 
2268
                path_index = 0
 
2269
                if current_dir_info and path_index < len(current_dir_info[1]):
 
2270
                    current_path_info = current_dir_info[1][path_index]
 
2271
                    if current_path_info[2] == 'directory':
 
2272
                        if self.target._directory_is_tree_reference(
 
2273
                            current_path_info[0].decode('utf8')):
 
2274
                            current_path_info = current_path_info[:2] + \
 
2275
                                ('tree-reference',) + current_path_info[3:]
 
2276
                else:
 
2277
                    current_path_info = None
 
2278
                advance_path = True
 
2279
                path_handled = False
 
2280
                while (current_entry is not None or
 
2281
                    current_path_info is not None):
 
2282
                    if current_entry is None:
 
2283
                        # the check for path_handled when the path is adnvaced
 
2284
                        # will yield this path if needed.
 
2285
                        pass
 
2286
                    elif current_path_info is None:
 
2287
                        # no path is fine: the per entry code will handle it.
 
2288
                        result = _process_entry(current_entry, current_path_info)
 
2289
                        if result is not None:
 
2290
                            if result is not uninteresting:
 
2291
                                yield result
 
2292
                    elif (current_entry[0][1] != current_path_info[1]
 
2293
                          or current_entry[1][target_index][0] in 'ar'):
 
2294
                        # The current path on disk doesn't match the dirblock
 
2295
                        # record. Either the dirblock is marked as absent, or
 
2296
                        # the file on disk is not present at all in the
 
2297
                        # dirblock. Either way, report about the dirblock
 
2298
                        # entry, and let other code handle the filesystem one.
 
2299
 
 
2300
                        # Compare the basename for these files to determine
 
2301
                        # which comes first
 
2302
                        if current_path_info[1] < current_entry[0][1]:
 
2303
                            # extra file on disk: pass for now, but only
 
2304
                            # increment the path, not the entry
 
2305
                            advance_entry = False
 
2306
                        else:
 
2307
                            # entry referring to file not present on disk.
 
2308
                            # advance the entry only, after processing.
 
2309
                            result = _process_entry(current_entry, None)
 
2310
                            if result is not None:
 
2311
                                if result is not uninteresting:
 
2312
                                    yield result
 
2313
                            advance_path = False
 
2314
                    else:
 
2315
                        result = _process_entry(current_entry, current_path_info)
 
2316
                        if result is not None:
 
2317
                            path_handled = True
 
2318
                            if result is not uninteresting:
 
2319
                                yield result
 
2320
                    if advance_entry and current_entry is not None:
 
2321
                        entry_index += 1
 
2322
                        if entry_index < len(current_block[1]):
 
2323
                            current_entry = current_block[1][entry_index]
 
2324
                        else:
 
2325
                            current_entry = None
 
2326
                    else:
 
2327
                        advance_entry = True # reset the advance flaga
 
2328
                    if advance_path and current_path_info is not None:
 
2329
                        if not path_handled:
 
2330
                            # unversioned in all regards
 
2331
                            if want_unversioned:
 
2332
                                new_executable = bool(
 
2333
                                    stat.S_ISREG(current_path_info[3].st_mode)
 
2334
                                    and stat.S_IEXEC & current_path_info[3].st_mode)
 
2335
                                yield (None,
 
2336
                                    (None, utf8_decode(current_path_info[0])[0]),
 
2337
                                    True,
 
2338
                                    (False, False),
 
2339
                                    (None, None),
 
2340
                                    (None, utf8_decode(current_path_info[1])[0]),
 
2341
                                    (None, current_path_info[2]),
 
2342
                                    (None, new_executable))
 
2343
                            # dont descend into this unversioned path if it is
 
2344
                            # a dir
 
2345
                            if current_path_info[2] in ('directory'):
 
2346
                                del current_dir_info[1][path_index]
 
2347
                                path_index -= 1
 
2348
                        # dont descend the disk iterator into any tree 
 
2349
                        # paths.
 
2350
                        if current_path_info[2] == 'tree-reference':
 
2351
                            del current_dir_info[1][path_index]
 
2352
                            path_index -= 1
 
2353
                        path_index += 1
 
2354
                        if path_index < len(current_dir_info[1]):
 
2355
                            current_path_info = current_dir_info[1][path_index]
 
2356
                            if current_path_info[2] == 'directory':
 
2357
                                if self.target._directory_is_tree_reference(
 
2358
                                    current_path_info[0].decode('utf8')):
 
2359
                                    current_path_info = current_path_info[:2] + \
 
2360
                                        ('tree-reference',) + current_path_info[3:]
 
2361
                        else:
 
2362
                            current_path_info = None
 
2363
                        path_handled = False
 
2364
                    else:
 
2365
                        advance_path = True # reset the advance flagg.
 
2366
                if current_block is not None:
 
2367
                    block_index += 1
 
2368
                    if (block_index < len(state._dirblocks) and
 
2369
                        osutils.is_inside(current_root, state._dirblocks[block_index][0])):
 
2370
                        current_block = state._dirblocks[block_index]
 
2371
                    else:
 
2372
                        current_block = None
 
2373
                if current_dir_info is not None:
 
2374
                    try:
 
2375
                        current_dir_info = dir_iterator.next()
 
2376
                    except StopIteration:
 
2377
                        current_dir_info = None
 
2378
 
2113
2379
 
2114
2380
    @staticmethod
2115
2381
    def is_compatible(source, target):
2116
2382
        # the target must be a dirstate working tree
2117
 
        if not isinstance(target, DirStateWorkingTree):
 
2383
        if not isinstance(target, WorkingTree4):
2118
2384
            return False
2119
 
        # the source must be a revtree or dirstate rev tree.
 
2385
        # the source must be a revtreee or dirstate rev tree.
2120
2386
        if not isinstance(source,
2121
2387
            (revisiontree.RevisionTree, DirStateRevisionTree)):
2122
2388
            return False
2123
2389
        # the source revid must be in the target dirstate
2124
 
        if not (source._revision_id == _mod_revision.NULL_REVISION or
 
2390
        if not (source._revision_id == NULL_REVISION or
2125
2391
            source._revision_id in target.get_parent_ids()):
2126
 
            # TODO: what about ghosts? it may well need to
 
2392
            # TODO: what about ghosts? it may well need to 
2127
2393
            # check for them explicitly.
2128
2394
            return False
2129
2395
        return True
2139
2405
 
2140
2406
    def convert(self, tree):
2141
2407
        # lock the control files not the tree, so that we dont get tree
2142
 
        # on-unlock behaviours, and so that noone else diddles with the
 
2408
        # on-unlock behaviours, and so that noone else diddles with the 
2143
2409
        # tree during upgrade.
2144
2410
        tree._control_files.lock_write()
2145
2411
        try:
2171
2437
 
2172
2438
    def update_format(self, tree):
2173
2439
        """Change the format marker."""
2174
 
        tree._transport.put_bytes('format',
2175
 
            self.target_format.get_format_string(),
2176
 
            mode=tree.bzrdir._get_file_mode())
2177
 
 
2178
 
 
2179
 
class Converter4to5(object):
2180
 
    """Perform an in-place upgrade of format 4 to format 5 trees."""
2181
 
 
2182
 
    def __init__(self):
2183
 
        self.target_format = WorkingTreeFormat5()
2184
 
 
2185
 
    def convert(self, tree):
2186
 
        # lock the control files not the tree, so that we don't get tree
2187
 
        # on-unlock behaviours, and so that no-one else diddles with the
2188
 
        # tree during upgrade.
2189
 
        tree._control_files.lock_write()
2190
 
        try:
2191
 
            self.update_format(tree)
2192
 
        finally:
2193
 
            tree._control_files.unlock()
2194
 
 
2195
 
    def update_format(self, tree):
2196
 
        """Change the format marker."""
2197
 
        tree._transport.put_bytes('format',
2198
 
            self.target_format.get_format_string(),
2199
 
            mode=tree.bzrdir._get_file_mode())
2200
 
 
2201
 
 
2202
 
class Converter4or5to6(object):
2203
 
    """Perform an in-place upgrade of format 4 or 5 to format 6 trees."""
2204
 
 
2205
 
    def __init__(self):
2206
 
        self.target_format = WorkingTreeFormat6()
2207
 
 
2208
 
    def convert(self, tree):
2209
 
        # lock the control files not the tree, so that we don't get tree
2210
 
        # on-unlock behaviours, and so that no-one else diddles with the
2211
 
        # tree during upgrade.
2212
 
        tree._control_files.lock_write()
2213
 
        try:
2214
 
            self.init_custom_control_files(tree)
2215
 
            self.update_format(tree)
2216
 
        finally:
2217
 
            tree._control_files.unlock()
2218
 
 
2219
 
    def init_custom_control_files(self, tree):
2220
 
        """Initialize custom control files."""
2221
 
        tree._transport.put_bytes('views', '',
2222
 
            mode=tree.bzrdir._get_file_mode())
2223
 
 
2224
 
    def update_format(self, tree):
2225
 
        """Change the format marker."""
2226
 
        tree._transport.put_bytes('format',
2227
 
            self.target_format.get_format_string(),
2228
 
            mode=tree.bzrdir._get_file_mode())
 
2440
        tree._control_files.put_utf8('format',
 
2441
            self.target_format.get_format_string())