/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/workingtree_4.py

  • Committer: Aaron Bentley
  • Date: 2007-07-22 17:36:22 UTC
  • mfrom: (2644.2.1 bzr.benchmarks)
  • mto: This revision was merged to the branch mainline in revision 2647.
  • Revision ID: aaron.bentley@utoronto.ca-20070722173622-1p4mw28bzp1qangs
Fix deprecation warnings on benchmarks (Lukáš Lalinský)

Show diffs side-by-side

added added

removed removed

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