~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree_4.py

  • Committer: Ian Clatworthy
  • Date: 2007-08-14 03:59:22 UTC
  • mto: (2733.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 2734.
  • Revision ID: ian.clatworthy@internode.on.net-20070814035922-siavg542cwvkf4r5
Fix pretty doc generation so works for all html docs

Show diffs side-by-side

added added

removed removed

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