~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree_4.py

  • Committer: Martin Pool
  • Date: 2008-05-08 04:18:41 UTC
  • mto: This revision was merged to the branch mainline in revision 3415.
  • Revision ID: mbp@sourcefrog.net-20080508041841-6cv1owy6y1gukja5
Remove dead main method from test_patches

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2007-2012 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
 
22
22
WorkingTree.open(dir).
23
23
"""
24
24
 
25
 
from __future__ import absolute_import
26
 
 
27
25
from cStringIO import StringIO
28
26
import os
29
27
import sys
30
28
 
31
29
from bzrlib.lazy_import import lazy_import
32
30
lazy_import(globals(), """
 
31
from bisect import bisect_left
 
32
import collections
 
33
from copy import deepcopy
33
34
import errno
 
35
import itertools
 
36
import operator
34
37
import stat
 
38
from time import time
 
39
import warnings
35
40
 
 
41
import bzrlib
36
42
from bzrlib import (
37
43
    bzrdir,
38
44
    cache_utf8,
39
 
    config,
40
45
    conflicts as _mod_conflicts,
41
 
    controldir,
42
46
    debug,
 
47
    delta,
43
48
    dirstate,
44
49
    errors,
45
 
    filters as _mod_filters,
46
50
    generate_ids,
 
51
    globbing,
 
52
    ignores,
 
53
    merge,
47
54
    osutils,
48
55
    revision as _mod_revision,
49
56
    revisiontree,
 
57
    textui,
50
58
    trace,
51
59
    transform,
52
 
    views,
 
60
    urlutils,
 
61
    xml5,
 
62
    xml6,
53
63
    )
 
64
import bzrlib.branch
 
65
from bzrlib.transport import get_transport
 
66
import bzrlib.ui
54
67
""")
55
68
 
 
69
from bzrlib import symbol_versioning
56
70
from bzrlib.decorators import needs_read_lock, needs_write_lock
57
 
from bzrlib.inventory import Inventory, ROOT_ID, entry_factory
58
 
from bzrlib.lock import LogicalLockResult
59
 
from bzrlib.lockable_files import LockableFiles
 
71
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, entry_factory
 
72
from bzrlib.lockable_files import LockableFiles, TransportLock
60
73
from bzrlib.lockdir import LockDir
61
 
from bzrlib.mutabletree import (
62
 
    MutableTree,
63
 
    needs_tree_write_lock,
64
 
    )
 
74
import bzrlib.mutabletree
 
75
from bzrlib.mutabletree import needs_tree_write_lock
65
76
from bzrlib.osutils import (
66
77
    file_kind,
67
78
    isdir,
 
79
    normpath,
68
80
    pathjoin,
 
81
    rand_chars,
69
82
    realpath,
70
83
    safe_unicode,
71
 
    )
72
 
from bzrlib.symbol_versioning import (
73
 
    deprecated_in,
74
 
    deprecated_method,
75
 
    )
 
84
    splitpath,
 
85
    )
 
86
from bzrlib.trace import mutter, note
76
87
from bzrlib.transport.local import LocalTransport
77
 
from bzrlib.tree import (
78
 
    InterTree,
79
 
    InventoryTree,
80
 
    )
81
 
from bzrlib.workingtree import (
82
 
    InventoryWorkingTree,
83
 
    WorkingTree,
84
 
    WorkingTreeFormatMetaDir,
85
 
    )
86
 
 
87
 
 
88
 
class DirStateWorkingTree(InventoryWorkingTree):
 
88
from bzrlib.tree import InterTree
 
89
from bzrlib.progress import DummyProgress, ProgressPhase
 
90
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
 
91
from bzrlib.rio import RioReader, rio_file, Stanza
 
92
from bzrlib.symbol_versioning import (deprecated_passed,
 
93
        deprecated_method,
 
94
        deprecated_function,
 
95
        DEPRECATED_PARAMETER,
 
96
        )
 
97
from bzrlib.tree import Tree
 
98
from bzrlib.workingtree import WorkingTree, WorkingTree3, WorkingTreeFormat3
 
99
 
 
100
 
 
101
# This is the Windows equivalent of ENOTDIR
 
102
# It is defined in pywin32.winerror, but we don't want a strong dependency for
 
103
# just an error code.
 
104
ERROR_PATH_NOT_FOUND = 3
 
105
ERROR_DIRECTORY = 267
 
106
 
 
107
 
 
108
class WorkingTree4(WorkingTree3):
 
109
    """This is the Format 4 working tree.
 
110
 
 
111
    This differs from WorkingTree3 by:
 
112
     - Having a consolidated internal dirstate, stored in a
 
113
       randomly-accessible sorted file on disk.
 
114
     - Not having a regular inventory attribute.  One can be synthesized 
 
115
       on demand but this is expensive and should be avoided.
 
116
 
 
117
    This is new in bzr 0.15.
 
118
    """
89
119
 
90
120
    def __init__(self, basedir,
91
121
                 branch,
102
132
        self._format = _format
103
133
        self.bzrdir = _bzrdir
104
134
        basedir = safe_unicode(basedir)
105
 
        trace.mutter("opening working tree %r", basedir)
 
135
        mutter("opening working tree %r", basedir)
106
136
        self._branch = branch
107
137
        self.basedir = realpath(basedir)
108
138
        # if branch is at our basedir and is a format 6 or less
109
139
        # assume all other formats have their own control files.
110
140
        self._control_files = _control_files
111
 
        self._transport = self._control_files._transport
112
141
        self._dirty = None
113
142
        #-------------
114
143
        # during a read or write lock these objects are set, and are
118
147
        #-------------
119
148
        self._setup_directory_is_tree_reference()
120
149
        self._detect_case_handling()
121
 
        self._rules_searcher = None
122
 
        self.views = self._make_views()
123
 
        #--- allow tests to select the dirstate iter_changes implementation
124
 
        self._iter_changes = dirstate._process_entry
125
150
 
126
151
    @needs_tree_write_lock
127
152
    def _add(self, files, ids, kinds):
142
167
            state.add(f, file_id, kind, None, '')
143
168
        self._make_dirty(reset_inventory=True)
144
169
 
145
 
    def _get_check_refs(self):
146
 
        """Return the references needed to perform a check of this tree."""
147
 
        return [('trees', self.last_revision())]
148
 
 
149
170
    def _make_dirty(self, reset_inventory):
150
171
        """Make the tree state dirty.
151
172
 
159
180
    @needs_tree_write_lock
160
181
    def add_reference(self, sub_tree):
161
182
        # use standard implementation, which calls back to self._add
162
 
        #
 
183
        # 
163
184
        # So we don't store the reference_revision in the working dirstate,
164
 
        # it's just recorded at the moment of commit.
 
185
        # it's just recorded at the moment of commit. 
165
186
        self._add_reference(sub_tree)
166
187
 
167
188
    def break_lock(self):
203
224
 
204
225
    def _comparison_data(self, entry, path):
205
226
        kind, executable, stat_value = \
206
 
            WorkingTree._comparison_data(self, entry, path)
 
227
            WorkingTree3._comparison_data(self, entry, path)
207
228
        # it looks like a plain directory, but it's really a reference -- see
208
229
        # also kind()
209
 
        if (self._repo_supports_tree_reference and kind == 'directory'
210
 
            and entry is not None and entry.kind == 'tree-reference'):
 
230
        if (self._repo_supports_tree_reference and
 
231
            kind == 'directory' and
 
232
            self._directory_is_tree_reference(path)):
211
233
            kind = 'tree-reference'
212
234
        return kind, executable, stat_value
213
235
 
215
237
    def commit(self, message=None, revprops=None, *args, **kwargs):
216
238
        # mark the tree as dirty post commit - commit
217
239
        # can change the current versioned list by doing deletes.
218
 
        result = WorkingTree.commit(self, message, revprops, *args, **kwargs)
 
240
        result = WorkingTree3.commit(self, message, revprops, *args, **kwargs)
219
241
        self._make_dirty(reset_inventory=True)
220
242
        return result
221
243
 
239
261
            return self._dirstate
240
262
        local_path = self.bzrdir.get_workingtree_transport(None
241
263
            ).local_abspath('dirstate')
242
 
        self._dirstate = dirstate.DirState.on_file(local_path,
243
 
            self._sha1_provider(), self._worth_saving_limit())
 
264
        self._dirstate = dirstate.DirState.on_file(local_path)
244
265
        return self._dirstate
245
266
 
246
 
    def _sha1_provider(self):
247
 
        """A function that returns a SHA1Provider suitable for this tree.
248
 
 
249
 
        :return: None if content filtering is not supported by this tree.
250
 
          Otherwise, a SHA1Provider is returned that sha's the canonical
251
 
          form of files, i.e. after read filters are applied.
252
 
        """
253
 
        if self.supports_content_filtering():
254
 
            return ContentFilterAwareSHA1Provider(self)
255
 
        else:
256
 
            return None
257
 
 
258
 
    def _worth_saving_limit(self):
259
 
        """How many hash changes are ok before we must save the dirstate.
260
 
 
261
 
        :return: an integer. -1 means never save.
262
 
        """
263
 
        conf = self.get_config_stack()
264
 
        return conf.get('bzr.workingtree.worth_saving_limit')
265
 
 
266
267
    def filter_unversioned_files(self, paths):
267
268
        """Filter out paths that are versioned.
268
269
 
300
301
 
301
302
    def _generate_inventory(self):
302
303
        """Create and set self.inventory from the dirstate object.
303
 
 
 
304
        
304
305
        This is relatively expensive: we have to walk the entire dirstate.
305
306
        Ideally we would not, and can deprecate this function.
306
307
        """
351
352
                    parent_ies[(dirname + '/' + name).strip('/')] = inv_entry
352
353
                elif kind == 'tree-reference':
353
354
                    if not self._repo_supports_tree_reference:
354
 
                        raise errors.UnsupportedOperation(
355
 
                            self._generate_inventory,
356
 
                            self.branch.repository)
 
355
                        raise AssertionError(
 
356
                            "repository of %r "
 
357
                            "doesn't support tree references "
 
358
                            "required by entry %r"
 
359
                            % (self, name))
357
360
                    inv_entry.reference_revision = link_or_sha1 or None
358
361
                elif kind != 'symlink':
359
362
                    raise AssertionError("unknown kind %r" % kind)
374
377
        If either file_id or path is supplied, it is used as the key to lookup.
375
378
        If both are supplied, the fastest lookup is used, and an error is
376
379
        raised if they do not both point at the same row.
377
 
 
 
380
        
378
381
        :param file_id: An optional unicode file_id to be looked up.
379
382
        :param path: An optional unicode path to be looked up.
380
383
        :return: The dirstate row tuple for path/file_id, or (None, None)
398
401
        state = self.current_dirstate()
399
402
        if stat_value is None:
400
403
            try:
401
 
                stat_value = osutils.lstat(file_abspath)
 
404
                stat_value = os.lstat(file_abspath)
402
405
            except OSError, e:
403
406
                if e.errno == errno.ENOENT:
404
407
                    return None
405
408
                else:
406
409
                    raise
407
 
        link_or_sha1 = dirstate.update_entry(state, entry, file_abspath,
408
 
            stat_value=stat_value)
 
410
        link_or_sha1 = state.update_entry(entry, file_abspath,
 
411
                                          stat_value=stat_value)
409
412
        if entry[1][0][0] == 'f':
410
 
            if link_or_sha1 is None:
411
 
                file_obj, statvalue = self.get_file_with_stat(file_id, path)
412
 
                try:
413
 
                    sha1 = osutils.sha_file(file_obj)
414
 
                finally:
415
 
                    file_obj.close()
416
 
                self._observed_sha1(file_id, path, (sha1, statvalue))
417
 
                return sha1
418
 
            else:
419
 
                return link_or_sha1
 
413
            return link_or_sha1
420
414
        return None
421
415
 
422
 
    def _get_root_inventory(self):
 
416
    def _get_inventory(self):
423
417
        """Get the inventory for the tree. This is only valid within a lock."""
424
418
        if 'evil' in debug.debug_flags:
425
419
            trace.mutter_callsite(2,
430
424
        self._generate_inventory()
431
425
        return self._inventory
432
426
 
433
 
    @deprecated_method(deprecated_in((2, 5, 0)))
434
 
    def _get_inventory(self):
435
 
        return self.root_inventory
436
 
 
437
427
    inventory = property(_get_inventory,
438
428
                         doc="Inventory of this Tree")
439
429
 
440
 
    root_inventory = property(_get_root_inventory,
441
 
        "Root inventory of this tree")
442
 
 
443
430
    @needs_read_lock
444
431
    def get_parent_ids(self):
445
432
        """See Tree.get_parent_ids.
446
 
 
 
433
        
447
434
        This implementation requests the ids list from the dirstate file.
448
435
        """
449
436
        return self.current_dirstate().get_parent_ids()
471
458
        return osutils.lexists(pathjoin(
472
459
                    self.basedir, row[0].decode('utf8'), row[1].decode('utf8')))
473
460
 
474
 
    def has_or_had_id(self, file_id):
475
 
        state = self.current_dirstate()
476
 
        row, parents = self._get_entry(file_id=file_id)
477
 
        return row is not None
478
 
 
479
461
    @needs_read_lock
480
462
    def id2path(self, file_id):
481
463
        "Convert a file-id to a path."
492
474
            return False # Missing entries are not executable
493
475
        return entry[1][0][3] # Executable?
494
476
 
495
 
    def is_executable(self, file_id, path=None):
496
 
        """Test if a file is executable or not.
 
477
    if not osutils.supports_executable():
 
478
        def is_executable(self, file_id, path=None):
 
479
            """Test if a file is executable or not.
497
480
 
498
 
        Note: The caller is expected to take a read-lock before calling this.
499
 
        """
500
 
        if not self._supports_executable():
 
481
            Note: The caller is expected to take a read-lock before calling this.
 
482
            """
501
483
            entry = self._get_entry(file_id=file_id, path=path)
502
484
            if entry == (None, None):
503
485
                return False
504
486
            return entry[1][0][3]
505
 
        else:
 
487
 
 
488
        _is_executable_from_path_and_stat = \
 
489
            _is_executable_from_path_and_stat_from_basis
 
490
    else:
 
491
        def is_executable(self, file_id, path=None):
 
492
            """Test if a file is executable or not.
 
493
 
 
494
            Note: The caller is expected to take a read-lock before calling this.
 
495
            """
506
496
            self._must_be_locked()
507
497
            if not path:
508
498
                path = self.id2path(file_id)
509
 
            mode = osutils.lstat(self.abspath(path)).st_mode
 
499
            mode = os.lstat(self.abspath(path)).st_mode
510
500
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
511
501
 
512
502
    def all_file_ids(self):
537
527
        return iter(result)
538
528
 
539
529
    def iter_references(self):
540
 
        if not self._repo_supports_tree_reference:
541
 
            # When the repo doesn't support references, we will have nothing to
542
 
            # return
543
 
            return
544
530
        for key, tree_details in self.current_dirstate()._iter_entries():
545
531
            if tree_details[0][0] in ('a', 'r'): # absent, relocated
546
532
                # not relevant to the working tree
548
534
            if not key[1]:
549
535
                # the root is not a reference.
550
536
                continue
551
 
            relpath = pathjoin(key[0].decode('utf8'), key[1].decode('utf8'))
 
537
            path = pathjoin(self.basedir, key[0].decode('utf8'), key[1].decode('utf8'))
552
538
            try:
553
 
                if self._kind(relpath) == 'tree-reference':
554
 
                    yield relpath, key[2]
 
539
                if self._kind(path) == 'tree-reference':
 
540
                    yield path, key[2]
555
541
            except errors.NoSuchFile:
556
542
                # path is missing on disk.
557
543
                continue
558
544
 
559
 
    def _observed_sha1(self, file_id, path, (sha1, statvalue)):
560
 
        """See MutableTree._observed_sha1."""
561
 
        state = self.current_dirstate()
562
 
        entry = self._get_entry(file_id=file_id, path=path)
563
 
        state._observed_sha1(entry, sha1, statvalue)
564
 
 
565
545
    def kind(self, file_id):
566
546
        """Return the kind of a file.
567
547
 
571
551
        Note: The caller is expected to take a read-lock before calling this.
572
552
        """
573
553
        relpath = self.id2path(file_id)
574
 
        if relpath is None:
 
554
        if relpath == None:
575
555
            raise AssertionError(
576
556
                "path for id {%s} is None!" % file_id)
577
557
        return self._kind(relpath)
579
559
    def _kind(self, relpath):
580
560
        abspath = self.abspath(relpath)
581
561
        kind = file_kind(abspath)
582
 
        if (self._repo_supports_tree_reference and kind == 'directory'):
583
 
            entry = self._get_entry(path=relpath)
584
 
            if entry[1] is not None:
585
 
                if entry[1][0][0] == 't':
586
 
                    kind = 'tree-reference'
 
562
        if (self._repo_supports_tree_reference and
 
563
            kind == 'directory' and
 
564
            self._directory_is_tree_reference(relpath)):
 
565
            kind = 'tree-reference'
587
566
        return kind
588
567
 
589
568
    @needs_read_lock
596
575
            return _mod_revision.NULL_REVISION
597
576
 
598
577
    def lock_read(self):
599
 
        """See Branch.lock_read, and WorkingTree.unlock.
600
 
 
601
 
        :return: A bzrlib.lock.LogicalLockResult.
602
 
        """
 
578
        """See Branch.lock_read, and WorkingTree.unlock."""
603
579
        self.branch.lock_read()
604
580
        try:
605
581
            self._control_files.lock_read()
618
594
        except:
619
595
            self.branch.unlock()
620
596
            raise
621
 
        return LogicalLockResult(self.unlock)
622
597
 
623
598
    def _lock_self_write(self):
624
599
        """This should be called after the branch is locked."""
639
614
        except:
640
615
            self.branch.unlock()
641
616
            raise
642
 
        return LogicalLockResult(self.unlock)
643
617
 
644
618
    def lock_tree_write(self):
645
 
        """See MutableTree.lock_tree_write, and WorkingTree.unlock.
646
 
 
647
 
        :return: A bzrlib.lock.LogicalLockResult.
648
 
        """
 
619
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
649
620
        self.branch.lock_read()
650
 
        return self._lock_self_write()
 
621
        self._lock_self_write()
651
622
 
652
623
    def lock_write(self):
653
 
        """See MutableTree.lock_write, and WorkingTree.unlock.
654
 
 
655
 
        :return: A bzrlib.lock.LogicalLockResult.
656
 
        """
 
624
        """See MutableTree.lock_write, and WorkingTree.unlock."""
657
625
        self.branch.lock_write()
658
 
        return self._lock_self_write()
 
626
        self._lock_self_write()
659
627
 
660
628
    @needs_tree_write_lock
661
629
    def move(self, from_paths, to_dir, after=False):
692
660
 
693
661
        if self._inventory is not None:
694
662
            update_inventory = True
695
 
            inv = self.root_inventory
 
663
            inv = self.inventory
696
664
            to_dir_id = to_entry[0][2]
697
665
            to_dir_ie = inv[to_dir_id]
698
666
        else:
731
699
            from_entry = self._get_entry(path=from_rel)
732
700
            if from_entry == (None, None):
733
701
                raise errors.BzrMoveFailedError(from_rel,to_dir,
734
 
                    errors.NotVersionedError(path=from_rel))
 
702
                    errors.NotVersionedError(path=str(from_rel)))
735
703
 
736
704
            from_id = from_entry[0][2]
737
705
            to_rel = pathjoin(to_dir, from_tail)
878
846
                rollback_rename()
879
847
                raise
880
848
            result.append((from_rel, to_rel))
881
 
            state._mark_modified()
 
849
            state._dirblock_state = dirstate.DirState.IN_MEMORY_MODIFIED
882
850
            self._make_dirty(reset_inventory=False)
883
851
 
884
852
        return result
894
862
    @needs_read_lock
895
863
    def path2id(self, path):
896
864
        """Return the id for path in this tree."""
897
 
        if isinstance(path, list):
898
 
            if path == []:
899
 
                path = [""]
900
 
            path = osutils.pathjoin(*path)
901
865
        path = path.strip('/')
902
866
        entry = self._get_entry(path=path)
903
867
        if entry == (None, None):
916
880
        for tree in trees:
917
881
            if not (isinstance(tree, DirStateRevisionTree) and tree._revision_id in
918
882
                parents):
919
 
                return super(DirStateWorkingTree, self).paths2ids(paths,
920
 
                    trees, require_versioned)
 
883
                return super(WorkingTree4, self).paths2ids(paths, trees, require_versioned)
921
884
        search_indexes = [0] + [1 + parents.index(tree._revision_id) for tree in trees]
922
885
        # -- make all paths utf8 --
923
886
        paths_utf8 = set()
981
944
                    all_versioned = False
982
945
                    break
983
946
            if not all_versioned:
984
 
                raise errors.PathsNotVersionedError(
985
 
                    [p.decode('utf-8') for p in paths])
 
947
                raise errors.PathsNotVersionedError(paths)
986
948
        # -- remove redundancy in supplied paths to prevent over-scanning --
987
949
        search_paths = osutils.minimum_path_selection(paths)
988
 
        # sketch:
 
950
        # sketch: 
989
951
        # for all search_indexs in each path at or under each element of
990
952
        # search_paths, if the detail is relocated: add the id, and add the
991
953
        # relocated path as one to search if its not searched already. If the
1037
999
            found_dir_names = set(dir_name_id[:2] for dir_name_id in found)
1038
1000
            for dir_name in split_paths:
1039
1001
                if dir_name not in found_dir_names:
1040
 
                    raise errors.PathsNotVersionedError(
1041
 
                        [p.decode('utf-8') for p in paths])
 
1002
                    raise errors.PathsNotVersionedError(paths)
1042
1003
 
1043
1004
        for dir_name_id, trees_info in found.iteritems():
1044
1005
            for index in search_indexes:
1048
1009
 
1049
1010
    def read_working_inventory(self):
1050
1011
        """Read the working inventory.
1051
 
 
 
1012
        
1052
1013
        This is a meaningless operation for dirstate, but we obey it anyhow.
1053
1014
        """
1054
 
        return self.root_inventory
 
1015
        return self.inventory
1055
1016
 
1056
1017
    @needs_read_lock
1057
1018
    def revision_tree(self, revision_id):
1072
1033
    def set_last_revision(self, new_revision):
1073
1034
        """Change the last revision in the working tree."""
1074
1035
        parents = self.get_parent_ids()
1075
 
        if new_revision in (_mod_revision.NULL_REVISION, None):
 
1036
        if new_revision in (NULL_REVISION, None):
1076
1037
            if len(parents) >= 2:
1077
1038
                raise AssertionError(
1078
1039
                    "setting the last parent to none with a pending merge is "
1085
1046
    @needs_tree_write_lock
1086
1047
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
1087
1048
        """Set the parent ids to revision_ids.
1088
 
 
 
1049
        
1089
1050
        See also set_parent_trees. This api will try to retrieve the tree data
1090
1051
        for each element of revision_ids from the trees repository. If you have
1091
1052
        tree data already available, it is more efficient to use
1123
1084
                raise errors.GhostRevisionUnusableHere(parents_list[0][0])
1124
1085
        real_trees = []
1125
1086
        ghosts = []
1126
 
 
1127
 
        parent_ids = [rev_id for rev_id, tree in parents_list]
1128
 
        graph = self.branch.repository.get_graph()
1129
 
        heads = graph.heads(parent_ids)
1130
 
        accepted_revisions = set()
1131
 
 
1132
1087
        # convert absent trees to the null tree, which we convert back to
1133
1088
        # missing on access.
1134
1089
        for rev_id, tree in parents_list:
1135
 
            if len(accepted_revisions) > 0:
1136
 
                # we always accept the first tree
1137
 
                if rev_id in accepted_revisions or rev_id not in heads:
1138
 
                    # We have already included either this tree, or its
1139
 
                    # descendent, so we skip it.
1140
 
                    continue
1141
1090
            _mod_revision.check_not_reserved_id(rev_id)
1142
1091
            if tree is not None:
1143
1092
                real_trees.append((rev_id, tree))
1144
1093
            else:
1145
1094
                real_trees.append((rev_id,
1146
 
                    self.branch.repository.revision_tree(
1147
 
                        _mod_revision.NULL_REVISION)))
 
1095
                    self.branch.repository.revision_tree(None)))
1148
1096
                ghosts.append(rev_id)
1149
 
            accepted_revisions.add(rev_id)
1150
 
        updated = False
1151
 
        if (len(real_trees) == 1
1152
 
            and not ghosts
1153
 
            and self.branch.repository._format.fast_deltas
1154
 
            and isinstance(real_trees[0][1],
1155
 
                revisiontree.InventoryRevisionTree)
1156
 
            and self.get_parent_ids()):
1157
 
            rev_id, rev_tree = real_trees[0]
1158
 
            basis_id = self.get_parent_ids()[0]
1159
 
            # There are times when basis_tree won't be in
1160
 
            # self.branch.repository, (switch, for example)
1161
 
            try:
1162
 
                basis_tree = self.branch.repository.revision_tree(basis_id)
1163
 
            except errors.NoSuchRevision:
1164
 
                # Fall back to the set_parent_trees(), since we can't use
1165
 
                # _make_delta if we can't get the RevisionTree
1166
 
                pass
1167
 
            else:
1168
 
                delta = rev_tree.root_inventory._make_delta(
1169
 
                    basis_tree.root_inventory)
1170
 
                dirstate.update_basis_by_delta(delta, rev_id)
1171
 
                updated = True
1172
 
        if not updated:
1173
 
            dirstate.set_parent_trees(real_trees, ghosts=ghosts)
 
1097
        dirstate.set_parent_trees(real_trees, ghosts=ghosts)
1174
1098
        self._make_dirty(reset_inventory=False)
1175
1099
 
1176
1100
    def _set_root_id(self, file_id):
1196
1120
 
1197
1121
    def unlock(self):
1198
1122
        """Unlock in format 4 trees needs to write the entire dirstate."""
 
1123
        # do non-implementation specific cleanup
 
1124
        self._cleanup()
 
1125
 
1199
1126
        if self._control_files._lock_count == 1:
1200
 
            # do non-implementation specific cleanup
1201
 
            self._cleanup()
1202
 
 
1203
1127
            # eventually we should do signature checking during read locks for
1204
1128
            # dirstate updates.
1205
1129
            if self._control_files._lock_mode == 'w':
1268
1192
                # just forget the whole block.
1269
1193
                entry_index = 0
1270
1194
                while entry_index < len(block[1]):
 
1195
                    # Mark this file id as having been removed
1271
1196
                    entry = block[1][entry_index]
1272
 
                    if entry[1][0][0] in 'ar':
1273
 
                        # don't remove absent or renamed entries
 
1197
                    ids_to_unversion.discard(entry[0][2])
 
1198
                    if (entry[1][0][0] in 'ar' # don't remove absent or renamed
 
1199
                                               # entries
 
1200
                        or not state._make_absent(entry)):
1274
1201
                        entry_index += 1
1275
 
                    else:
1276
 
                        # Mark this file id as having been removed
1277
 
                        ids_to_unversion.discard(entry[0][2])
1278
 
                        if not state._make_absent(entry):
1279
 
                            # The block has not shrunk.
1280
 
                            entry_index += 1
1281
1202
                # go to the next block. (At the moment we dont delete empty
1282
1203
                # dirblocks)
1283
1204
                block_index += 1
1304
1225
        # have to change the legacy inventory too.
1305
1226
        if self._inventory is not None:
1306
1227
            for file_id in file_ids:
1307
 
                if self._inventory.has_id(file_id):
1308
 
                    self._inventory.remove_recursive_id(file_id)
 
1228
                self._inventory.remove_recursive_id(file_id)
1309
1229
 
1310
1230
    @needs_tree_write_lock
1311
1231
    def rename_one(self, from_rel, to_rel, after=False):
1312
1232
        """See WorkingTree.rename_one"""
1313
1233
        self.flush()
1314
 
        super(DirStateWorkingTree, self).rename_one(from_rel, to_rel, after)
 
1234
        WorkingTree.rename_one(self, from_rel, to_rel, after)
1315
1235
 
1316
1236
    @needs_tree_write_lock
1317
1237
    def apply_inventory_delta(self, changes):
1336
1256
        if self._dirty:
1337
1257
            raise AssertionError("attempting to write an inventory when the "
1338
1258
                "dirstate is dirty will lose pending changes")
1339
 
        had_inventory = self._inventory is not None
1340
 
        # Setting self._inventory = None forces the dirstate to regenerate the
1341
 
        # working inventory. We do this because self.inventory may be inv, or
1342
 
        # may have been modified, and either case would prevent a clean delta
1343
 
        # being created.
1344
 
        self._inventory = None
1345
 
        # generate a delta,
1346
 
        delta = inv._make_delta(self.root_inventory)
1347
 
        # and apply it.
1348
 
        self.apply_inventory_delta(delta)
1349
 
        if had_inventory:
 
1259
        self.current_dirstate().set_state_from_inventory(inv)
 
1260
        self._make_dirty(reset_inventory=False)
 
1261
        if self._inventory is not None:
1350
1262
            self._inventory = inv
1351
1263
        self.flush()
1352
1264
 
1353
 
    @needs_tree_write_lock
1354
 
    def reset_state(self, revision_ids=None):
1355
 
        """Reset the state of the working tree.
1356
 
 
1357
 
        This does a hard-reset to a last-known-good state. This is a way to
1358
 
        fix if something got corrupted (like the .bzr/checkout/dirstate file)
1359
 
        """
1360
 
        if revision_ids is None:
1361
 
            revision_ids = self.get_parent_ids()
1362
 
        if not revision_ids:
1363
 
            base_tree = self.branch.repository.revision_tree(
1364
 
                _mod_revision.NULL_REVISION)
1365
 
            trees = []
1366
 
        else:
1367
 
            trees = zip(revision_ids,
1368
 
                        self.branch.repository.revision_trees(revision_ids))
1369
 
            base_tree = trees[0][1]
1370
 
        state = self.current_dirstate()
1371
 
        # We don't support ghosts yet
1372
 
        state.set_state_from_scratch(base_tree.root_inventory, trees, [])
1373
 
 
1374
 
 
1375
 
class ContentFilterAwareSHA1Provider(dirstate.SHA1Provider):
1376
 
 
1377
 
    def __init__(self, tree):
1378
 
        self.tree = tree
1379
 
 
1380
 
    def sha1(self, abspath):
1381
 
        """See dirstate.SHA1Provider.sha1()."""
1382
 
        filters = self.tree._content_filter_stack(
1383
 
            self.tree.relpath(osutils.safe_unicode(abspath)))
1384
 
        return _mod_filters.internal_size_sha_file_byname(abspath, filters)[1]
1385
 
 
1386
 
    def stat_and_sha1(self, abspath):
1387
 
        """See dirstate.SHA1Provider.stat_and_sha1()."""
1388
 
        filters = self.tree._content_filter_stack(
1389
 
            self.tree.relpath(osutils.safe_unicode(abspath)))
1390
 
        file_obj = file(abspath, 'rb', 65000)
1391
 
        try:
1392
 
            statvalue = os.fstat(file_obj.fileno())
1393
 
            if filters:
1394
 
                file_obj = _mod_filters.filtered_input_file(file_obj, filters)
1395
 
            sha1 = osutils.size_sha_file(file_obj)[1]
1396
 
        finally:
1397
 
            file_obj.close()
1398
 
        return statvalue, sha1
1399
 
 
1400
 
 
1401
 
class ContentFilteringDirStateWorkingTree(DirStateWorkingTree):
1402
 
    """Dirstate working tree that supports content filtering.
1403
 
 
1404
 
    The dirstate holds the hash and size of the canonical form of the file, 
1405
 
    and most methods must return that.
1406
 
    """
1407
 
 
1408
 
    def _file_content_summary(self, path, stat_result):
1409
 
        # This is to support the somewhat obsolete path_content_summary method
1410
 
        # with content filtering: see
1411
 
        # <https://bugs.launchpad.net/bzr/+bug/415508>.
1412
 
        #
1413
 
        # If the dirstate cache is up to date and knows the hash and size,
1414
 
        # return that.
1415
 
        # Otherwise if there are no content filters, return the on-disk size
1416
 
        # and leave the hash blank.
1417
 
        # Otherwise, read and filter the on-disk file and use its size and
1418
 
        # hash.
1419
 
        #
1420
 
        # The dirstate doesn't store the size of the canonical form so we
1421
 
        # can't trust it for content-filtered trees.  We just return None.
1422
 
        dirstate_sha1 = self._dirstate.sha1_from_stat(path, stat_result)
1423
 
        executable = self._is_executable_from_path_and_stat(path, stat_result)
1424
 
        return ('file', None, executable, dirstate_sha1)
1425
 
 
1426
 
 
1427
 
class WorkingTree4(DirStateWorkingTree):
1428
 
    """This is the Format 4 working tree.
1429
 
 
1430
 
    This differs from WorkingTree by:
1431
 
     - Having a consolidated internal dirstate, stored in a
1432
 
       randomly-accessible sorted file on disk.
1433
 
     - Not having a regular inventory attribute.  One can be synthesized
1434
 
       on demand but this is expensive and should be avoided.
1435
 
 
1436
 
    This is new in bzr 0.15.
1437
 
    """
1438
 
 
1439
 
 
1440
 
class WorkingTree5(ContentFilteringDirStateWorkingTree):
1441
 
    """This is the Format 5 working tree.
1442
 
 
1443
 
    This differs from WorkingTree4 by:
1444
 
     - Supporting content filtering.
1445
 
 
1446
 
    This is new in bzr 1.11.
1447
 
    """
1448
 
 
1449
 
 
1450
 
class WorkingTree6(ContentFilteringDirStateWorkingTree):
1451
 
    """This is the Format 6 working tree.
1452
 
 
1453
 
    This differs from WorkingTree5 by:
1454
 
     - Supporting a current view that may mask the set of files in a tree
1455
 
       impacted by most user operations.
1456
 
 
1457
 
    This is new in bzr 1.14.
1458
 
    """
1459
 
 
1460
 
    def _make_views(self):
1461
 
        return views.PathBasedViews(self)
1462
 
 
1463
 
 
1464
 
class DirStateWorkingTreeFormat(WorkingTreeFormatMetaDir):
1465
 
 
1466
 
    missing_parent_conflicts = True
1467
 
 
1468
 
    supports_versioned_directories = True
1469
 
 
1470
 
    _lock_class = LockDir
1471
 
    _lock_file_name = 'lock'
1472
 
 
1473
 
    def _open_control_files(self, a_bzrdir):
1474
 
        transport = a_bzrdir.get_workingtree_transport(None)
1475
 
        return LockableFiles(transport, self._lock_file_name,
1476
 
                             self._lock_class)
 
1265
 
 
1266
class WorkingTreeFormat4(WorkingTreeFormat3):
 
1267
    """The first consolidated dirstate working tree format.
 
1268
 
 
1269
    This format:
 
1270
        - exists within a metadir controlling .bzr
 
1271
        - includes an explicit version marker for the workingtree control
 
1272
          files, separate from the BzrDir format
 
1273
        - modifies the hash cache format
 
1274
        - is new in bzr 0.15
 
1275
        - uses a LockDir to guard access to it.
 
1276
    """
 
1277
 
 
1278
    upgrade_recommended = False
 
1279
 
 
1280
    def get_format_string(self):
 
1281
        """See WorkingTreeFormat.get_format_string()."""
 
1282
        return "Bazaar Working Tree Format 4 (bzr 0.15)\n"
 
1283
 
 
1284
    def get_format_description(self):
 
1285
        """See WorkingTreeFormat.get_format_description()."""
 
1286
        return "Working tree format 4"
1477
1287
 
1478
1288
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
1479
1289
                   accelerator_tree=None, hardlink=False):
1480
1290
        """See WorkingTreeFormat.initialize().
1481
1291
 
1482
1292
        :param revision_id: allows creating a working tree at a different
1483
 
            revision than the branch is at.
 
1293
        revision than the branch is at.
1484
1294
        :param accelerator_tree: A tree which can be used for retrieving file
1485
1295
            contents more quickly than the revision tree, i.e. a workingtree.
1486
1296
            The revision tree will be used for cases where accelerator_tree's
1497
1307
        control_files = self._open_control_files(a_bzrdir)
1498
1308
        control_files.create_lock()
1499
1309
        control_files.lock_write()
1500
 
        transport.put_bytes('format', self.as_string(),
1501
 
            mode=a_bzrdir._get_file_mode())
 
1310
        control_files.put_utf8('format', self.get_format_string())
1502
1311
        if from_branch is not None:
1503
1312
            branch = from_branch
1504
1313
        else:
1510
1319
        state = dirstate.DirState.initialize(local_path)
1511
1320
        state.unlock()
1512
1321
        del state
1513
 
        wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
 
1322
        wt = WorkingTree4(a_bzrdir.root_transport.local_abspath('.'),
1514
1323
                         branch,
1515
1324
                         _format=self,
1516
1325
                         _bzrdir=a_bzrdir,
1518
1327
        wt._new_tree()
1519
1328
        wt.lock_tree_write()
1520
1329
        try:
1521
 
            self._init_custom_control_files(wt)
1522
 
            if revision_id in (None, _mod_revision.NULL_REVISION):
 
1330
            if revision_id in (None, NULL_REVISION):
1523
1331
                if branch.repository.supports_rich_root():
1524
1332
                    wt._set_root_id(generate_ids.gen_root_id())
1525
1333
                else:
1536
1344
                    pass
1537
1345
            if basis is None:
1538
1346
                basis = branch.repository.revision_tree(revision_id)
1539
 
            if revision_id == _mod_revision.NULL_REVISION:
 
1347
            if revision_id == NULL_REVISION:
1540
1348
                parents_list = []
1541
1349
            else:
1542
1350
                parents_list = [(revision_id, basis)]
1550
1358
                if basis_root_id is not None:
1551
1359
                    wt._set_root_id(basis_root_id)
1552
1360
                    wt.flush()
1553
 
                if wt.supports_content_filtering():
1554
 
                    # The original tree may not have the same content filters
1555
 
                    # applied so we can't safely build the inventory delta from
1556
 
                    # the source tree.
1557
 
                    delta_from_tree = False
1558
 
                else:
1559
 
                    delta_from_tree = True
1560
 
                # delta_from_tree is safe even for DirStateRevisionTrees,
1561
 
                # because wt4.apply_inventory_delta does not mutate the input
1562
 
                # inventory entries.
1563
1361
                transform.build_tree(basis, wt, accelerator_tree,
1564
 
                                     hardlink=hardlink,
1565
 
                                     delta_from_tree=delta_from_tree)
1566
 
                for hook in MutableTree.hooks['post_build_tree']:
1567
 
                    hook(wt)
 
1362
                                     hardlink=hardlink)
1568
1363
            finally:
1569
1364
                basis.unlock()
1570
1365
        finally:
1572
1367
            wt.unlock()
1573
1368
        return wt
1574
1369
 
1575
 
    def _init_custom_control_files(self, wt):
1576
 
        """Subclasses with custom control files should override this method.
1577
 
 
1578
 
        The working tree and control files are locked for writing when this
1579
 
        method is called.
1580
 
 
1581
 
        :param wt: the WorkingTree object
1582
 
        """
1583
 
 
1584
 
    def open(self, a_bzrdir, _found=False):
1585
 
        """Return the WorkingTree object for a_bzrdir
1586
 
 
1587
 
        _found is a private parameter, do not use it. It is used to indicate
1588
 
               if format probing has already been done.
1589
 
        """
1590
 
        if not _found:
1591
 
            # we are being called directly and must probe.
1592
 
            raise NotImplementedError
1593
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
1594
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
1595
 
        wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
1596
 
        return wt
1597
 
 
1598
1370
    def _open(self, a_bzrdir, control_files):
1599
1371
        """Open the tree itself.
1600
1372
 
1601
1373
        :param a_bzrdir: the dir for the tree.
1602
1374
        :param control_files: the control files for the tree.
1603
1375
        """
1604
 
        return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
 
1376
        return WorkingTree4(a_bzrdir.root_transport.local_abspath('.'),
1605
1377
                           branch=a_bzrdir.open_branch(),
1606
1378
                           _format=self,
1607
1379
                           _bzrdir=a_bzrdir,
1608
1380
                           _control_files=control_files)
1609
1381
 
1610
1382
    def __get_matchingbzrdir(self):
1611
 
        return self._get_matchingbzrdir()
1612
 
 
1613
 
    def _get_matchingbzrdir(self):
1614
 
        """Overrideable method to get a bzrdir for testing."""
1615
1383
        # please test against something that will let us do tree references
1616
 
        return controldir.format_registry.make_bzrdir(
1617
 
            'development-subtree')
 
1384
        return bzrdir.format_registry.make_bzrdir(
 
1385
            'dirstate-with-subtree')
1618
1386
 
1619
1387
    _matchingbzrdir = property(__get_matchingbzrdir)
1620
1388
 
1621
1389
 
1622
 
class WorkingTreeFormat4(DirStateWorkingTreeFormat):
1623
 
    """The first consolidated dirstate working tree format.
1624
 
 
1625
 
    This format:
1626
 
        - exists within a metadir controlling .bzr
1627
 
        - includes an explicit version marker for the workingtree control
1628
 
          files, separate from the ControlDir format
1629
 
        - modifies the hash cache format
1630
 
        - is new in bzr 0.15
1631
 
        - uses a LockDir to guard access to it.
1632
 
    """
1633
 
 
1634
 
    upgrade_recommended = False
1635
 
 
1636
 
    _tree_class = WorkingTree4
1637
 
 
1638
 
    @classmethod
1639
 
    def get_format_string(cls):
1640
 
        """See WorkingTreeFormat.get_format_string()."""
1641
 
        return "Bazaar Working Tree Format 4 (bzr 0.15)\n"
1642
 
 
1643
 
    def get_format_description(self):
1644
 
        """See WorkingTreeFormat.get_format_description()."""
1645
 
        return "Working tree format 4"
1646
 
 
1647
 
 
1648
 
class WorkingTreeFormat5(DirStateWorkingTreeFormat):
1649
 
    """WorkingTree format supporting content filtering.
1650
 
    """
1651
 
 
1652
 
    upgrade_recommended = False
1653
 
 
1654
 
    _tree_class = WorkingTree5
1655
 
 
1656
 
    @classmethod
1657
 
    def get_format_string(cls):
1658
 
        """See WorkingTreeFormat.get_format_string()."""
1659
 
        return "Bazaar Working Tree Format 5 (bzr 1.11)\n"
1660
 
 
1661
 
    def get_format_description(self):
1662
 
        """See WorkingTreeFormat.get_format_description()."""
1663
 
        return "Working tree format 5"
1664
 
 
1665
 
    def supports_content_filtering(self):
1666
 
        return True
1667
 
 
1668
 
 
1669
 
class WorkingTreeFormat6(DirStateWorkingTreeFormat):
1670
 
    """WorkingTree format supporting views.
1671
 
    """
1672
 
 
1673
 
    upgrade_recommended = False
1674
 
 
1675
 
    _tree_class = WorkingTree6
1676
 
 
1677
 
    @classmethod
1678
 
    def get_format_string(cls):
1679
 
        """See WorkingTreeFormat.get_format_string()."""
1680
 
        return "Bazaar Working Tree Format 6 (bzr 1.14)\n"
1681
 
 
1682
 
    def get_format_description(self):
1683
 
        """See WorkingTreeFormat.get_format_description()."""
1684
 
        return "Working tree format 6"
1685
 
 
1686
 
    def _init_custom_control_files(self, wt):
1687
 
        """Subclasses with custom control files should override this method."""
1688
 
        wt._transport.put_bytes('views', '', mode=wt.bzrdir._get_file_mode())
1689
 
 
1690
 
    def supports_content_filtering(self):
1691
 
        return True
1692
 
 
1693
 
    def supports_views(self):
1694
 
        return True
1695
 
 
1696
 
    def _get_matchingbzrdir(self):
1697
 
        """Overrideable method to get a bzrdir for testing."""
1698
 
        # We use 'development-subtree' instead of '2a', because we have a
1699
 
        # few tests that want to test tree references
1700
 
        return bzrdir.format_registry.make_bzrdir('development-subtree')
1701
 
 
1702
 
 
1703
 
class DirStateRevisionTree(InventoryTree):
1704
 
    """A revision tree pulling the inventory from a dirstate.
1705
 
    
1706
 
    Note that this is one of the historical (ie revision) trees cached in the
1707
 
    dirstate for easy access, not the workingtree.
1708
 
    """
 
1390
class DirStateRevisionTree(Tree):
 
1391
    """A revision tree pulling the inventory from a dirstate."""
1709
1392
 
1710
1393
    def __init__(self, dirstate, revision_id, repository):
1711
1394
        self._dirstate = dirstate
1714
1397
        self._inventory = None
1715
1398
        self._locked = 0
1716
1399
        self._dirstate_locked = False
1717
 
        self._repo_supports_tree_reference = getattr(
1718
 
            repository._format, "supports_tree_reference",
1719
 
            False)
1720
1400
 
1721
1401
    def __repr__(self):
1722
1402
        return "<%s of %s in %s>" % \
1725
1405
    def annotate_iter(self, file_id,
1726
1406
                      default_revision=_mod_revision.CURRENT_REVISION):
1727
1407
        """See Tree.annotate_iter"""
1728
 
        text_key = (file_id, self.get_file_revision(file_id))
1729
 
        annotations = self._repository.texts.annotate(text_key)
1730
 
        return [(key[-1], line) for (key, line) in annotations]
 
1408
        w = self._get_weave(file_id)
 
1409
        return w.annotate(self.inventory[file_id].revision)
1731
1410
 
 
1411
    def _get_ancestors(self, default_revision):
 
1412
        return set(self._repository.get_ancestry(self._revision_id,
 
1413
                                                 topo_sorted=False))
1732
1414
    def _comparison_data(self, entry, path):
1733
1415
        """See Tree._comparison_data."""
1734
1416
        if entry is None:
1759
1441
        path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
1760
1442
        return path_utf8.decode('utf8')
1761
1443
 
1762
 
    def iter_references(self):
1763
 
        if not self._repo_supports_tree_reference:
1764
 
            # When the repo doesn't support references, we will have nothing to
1765
 
            # return
1766
 
            return iter([])
1767
 
        # Otherwise, fall back to the default implementation
1768
 
        return super(DirStateRevisionTree, self).iter_references()
1769
 
 
1770
1444
    def _get_parent_index(self):
1771
1445
        """Return the index in the dirstate referenced by this tree."""
1772
1446
        return self._dirstate.get_parent_ids().index(self._revision_id) + 1
1777
1451
        If either file_id or path is supplied, it is used as the key to lookup.
1778
1452
        If both are supplied, the fastest lookup is used, and an error is
1779
1453
        raised if they do not both point at the same row.
1780
 
 
 
1454
        
1781
1455
        :param file_id: An optional unicode file_id to be looked up.
1782
1456
        :param path: An optional unicode path to be looked up.
1783
1457
        :return: The dirstate row tuple for path/file_id, or (None, None)
1787
1461
        if path is not None:
1788
1462
            path = path.encode('utf8')
1789
1463
        parent_index = self._get_parent_index()
1790
 
        return self._dirstate._get_entry(parent_index, fileid_utf8=file_id,
1791
 
            path_utf8=path)
 
1464
        return self._dirstate._get_entry(parent_index, fileid_utf8=file_id, path_utf8=path)
1792
1465
 
1793
1466
    def _generate_inventory(self):
1794
1467
        """Create and set self.inventory from the dirstate object.
1851
1524
                elif kind == 'directory':
1852
1525
                    parent_ies[(dirname + '/' + name).strip('/')] = inv_entry
1853
1526
                elif kind == 'symlink':
 
1527
                    inv_entry.executable = False
 
1528
                    inv_entry.text_size = None
1854
1529
                    inv_entry.symlink_target = utf8_decode(fingerprint)[0]
1855
1530
                elif kind == 'tree-reference':
1856
1531
                    inv_entry.reference_revision = fingerprint or None
1876
1551
        # Make sure the file exists
1877
1552
        entry = self._get_entry(file_id, path=path)
1878
1553
        if entry == (None, None): # do we raise?
1879
 
            raise errors.NoSuchId(self, file_id)
 
1554
            return None
1880
1555
        parent_index = self._get_parent_index()
1881
1556
        last_changed_revision = entry[1][parent_index][4]
1882
 
        try:
1883
 
            rev = self._repository.get_revision(last_changed_revision)
1884
 
        except errors.NoSuchRevision:
1885
 
            raise errors.FileTimestampUnavailable(self.id2path(file_id))
1886
 
        return rev.timestamp
 
1557
        return self._repository.get_revision(last_changed_revision).timestamp
1887
1558
 
1888
1559
    def get_file_sha1(self, file_id, path=None, stat_value=None):
1889
1560
        entry = self._get_entry(file_id=file_id, path=path)
1893
1564
            return parent_details[1]
1894
1565
        return None
1895
1566
 
1896
 
    @needs_read_lock
1897
 
    def get_file_revision(self, file_id):
1898
 
        inv, inv_file_id = self._unpack_file_id(file_id)
1899
 
        return inv[inv_file_id].revision
 
1567
    @symbol_versioning.deprecated_method(symbol_versioning.zero_ninety)
 
1568
    def get_weave(self, file_id):
 
1569
        return self._get_weave(file_id)
 
1570
 
 
1571
    def _get_weave(self, file_id):
 
1572
        return self._repository.weave_store.get_weave(file_id,
 
1573
                self._repository.get_transaction())
1900
1574
 
1901
1575
    def get_file(self, file_id, path=None):
1902
1576
        return StringIO(self.get_file_text(file_id))
1903
1577
 
 
1578
    def get_file_lines(self, file_id):
 
1579
        entry = self._get_entry(file_id=file_id)[1]
 
1580
        if entry == None:
 
1581
            raise errors.NoSuchId(tree=self, file_id=file_id)
 
1582
        return self._get_weave(file_id).get_lines(entry[1][4])
 
1583
 
1904
1584
    def get_file_size(self, file_id):
1905
 
        """See Tree.get_file_size"""
1906
 
        inv, inv_file_id = self._unpack_file_id(file_id)
1907
 
        return inv[inv_file_id].text_size
 
1585
        return self.inventory[file_id].text_size
1908
1586
 
1909
 
    def get_file_text(self, file_id, path=None):
1910
 
        content = None
1911
 
        for _, content_iter in self.iter_files_bytes([(file_id, None)]):
1912
 
            if content is not None:
1913
 
                raise AssertionError('iter_files_bytes returned'
1914
 
                    ' too many entries')
1915
 
            # For each entry returned by iter_files_bytes, we must consume the
1916
 
            # content_iter before we step the files iterator.
1917
 
            content = ''.join(content_iter)
1918
 
        if content is None:
1919
 
            raise AssertionError('iter_files_bytes did not return'
1920
 
                ' the requested data')
1921
 
        return content
 
1587
    def get_file_text(self, file_id):
 
1588
        return ''.join(self.get_file_lines(file_id))
1922
1589
 
1923
1590
    def get_reference_revision(self, file_id, path=None):
1924
 
        inv, inv_file_id = self._unpack_file_id(file_id)
1925
 
        return inv[inv_file_id].reference_revision
 
1591
        return self.inventory[file_id].reference_revision
1926
1592
 
1927
1593
    def iter_files_bytes(self, desired_files):
1928
1594
        """See Tree.iter_files_bytes.
1938
1604
                                       identifier))
1939
1605
        return self._repository.iter_files_bytes(repo_desired_files)
1940
1606
 
1941
 
    def get_symlink_target(self, file_id, path=None):
 
1607
    def get_symlink_target(self, file_id):
1942
1608
        entry = self._get_entry(file_id=file_id)
1943
1609
        parent_index = self._get_parent_index()
1944
1610
        if entry[1][parent_index][0] != 'l':
1945
1611
            return None
1946
1612
        else:
1947
 
            target = entry[1][parent_index][1]
1948
 
            target = target.decode('utf8')
1949
 
            return target
 
1613
            # At present, none of the tree implementations supports non-ascii
 
1614
            # symlink targets. So we will just assume that the dirstate path is
 
1615
            # correct.
 
1616
            return entry[1][parent_index][1]
1950
1617
 
1951
1618
    def get_revision_id(self):
1952
1619
        """Return the revision id for this tree."""
1953
1620
        return self._revision_id
1954
1621
 
1955
 
    def _get_root_inventory(self):
 
1622
    def _get_inventory(self):
1956
1623
        if self._inventory is not None:
1957
1624
            return self._inventory
1958
1625
        self._must_be_locked()
1959
1626
        self._generate_inventory()
1960
1627
        return self._inventory
1961
1628
 
1962
 
    root_inventory = property(_get_root_inventory,
1963
 
                         doc="Inventory of this Tree")
1964
 
 
1965
 
    @deprecated_method(deprecated_in((2, 5, 0)))
1966
 
    def _get_inventory(self):
1967
 
        return self.root_inventory
1968
 
 
1969
1629
    inventory = property(_get_inventory,
1970
1630
                         doc="Inventory of this Tree")
1971
1631
 
1978
1638
 
1979
1639
    def kind(self, file_id):
1980
1640
        entry = self._get_entry(file_id=file_id)[1]
1981
 
        if entry is None:
 
1641
        if entry == None:
1982
1642
            raise errors.NoSuchId(tree=self, file_id=file_id)
1983
 
        parent_index = self._get_parent_index()
1984
 
        return dirstate.DirState._minikind_to_kind[entry[parent_index][0]]
 
1643
        return dirstate.DirState._minikind_to_kind[entry[1][0]]
1985
1644
 
1986
1645
    def stored_kind(self, file_id):
1987
1646
        """See Tree.stored_kind"""
1989
1648
 
1990
1649
    def path_content_summary(self, path):
1991
1650
        """See Tree.path_content_summary."""
1992
 
        inv, inv_file_id = self._path2inv_file_id(path)
1993
 
        if inv_file_id is None:
 
1651
        id = self.inventory.path2id(path)
 
1652
        if id is None:
1994
1653
            return ('missing', None, None, None)
1995
 
        entry = inv[inv_file_id]
 
1654
        entry = self._inventory[id]
1996
1655
        kind = entry.kind
1997
1656
        if kind == 'file':
1998
1657
            return (kind, entry.text_size, entry.executable, entry.text_sha1)
2002
1661
            return (kind, None, None, None)
2003
1662
 
2004
1663
    def is_executable(self, file_id, path=None):
2005
 
        inv, inv_file_id = self._unpack_file_id(file_id)
2006
 
        ie = inv[inv_file_id]
 
1664
        ie = self.inventory[file_id]
2007
1665
        if ie.kind != "file":
2008
 
            return False
 
1666
            return None
2009
1667
        return ie.executable
2010
1668
 
2011
 
    def is_locked(self):
2012
 
        return self._locked
2013
 
 
2014
 
    def list_files(self, include_root=False, from_dir=None, recursive=True):
 
1669
    def list_files(self, include_root=False):
2015
1670
        # We use a standard implementation, because DirStateRevisionTree is
2016
1671
        # dealing with one of the parents of the current state
2017
 
        if from_dir is None:
2018
 
            inv = self.root_inventory
2019
 
            from_dir_id = None
2020
 
        else:
2021
 
            inv, from_dir_id = self._path2inv_file_id(from_dir)
2022
 
            if from_dir_id is None:
2023
 
                # Directory not versioned
2024
 
                return
2025
 
        # FIXME: Support nested trees
2026
 
        entries = inv.iter_entries(from_dir=from_dir_id, recursive=recursive)
2027
 
        if inv.root is not None and not include_root and from_dir is None:
 
1672
        inv = self._get_inventory()
 
1673
        entries = inv.iter_entries()
 
1674
        if self.inventory.root is not None and not include_root:
2028
1675
            entries.next()
2029
1676
        for path, entry in entries:
2030
1677
            yield path, 'V', entry.kind, entry.file_id, entry
2031
1678
 
2032
1679
    def lock_read(self):
2033
 
        """Lock the tree for a set of operations.
2034
 
 
2035
 
        :return: A bzrlib.lock.LogicalLockResult.
2036
 
        """
 
1680
        """Lock the tree for a set of operations."""
2037
1681
        if not self._locked:
2038
1682
            self._repository.lock_read()
2039
1683
            if self._dirstate._lock_token is None:
2040
1684
                self._dirstate.lock_read()
2041
1685
                self._dirstate_locked = True
2042
1686
        self._locked += 1
2043
 
        return LogicalLockResult(self.unlock)
2044
1687
 
2045
1688
    def _must_be_locked(self):
2046
1689
        if not self._locked:
2050
1693
    def path2id(self, path):
2051
1694
        """Return the id for path in this tree."""
2052
1695
        # lookup by path: faster than splitting and walking the ivnentory.
2053
 
        if isinstance(path, list):
2054
 
            if path == []:
2055
 
                path = [""]
2056
 
            path = osutils.pathjoin(*path)
2057
1696
        entry = self._get_entry(path=path)
2058
1697
        if entry == (None, None):
2059
1698
            return None
2071
1710
                self._dirstate_locked = False
2072
1711
            self._repository.unlock()
2073
1712
 
2074
 
    @needs_read_lock
2075
 
    def supports_tree_reference(self):
2076
 
        return self._repo_supports_tree_reference
2077
 
 
2078
1713
    def walkdirs(self, prefix=""):
2079
1714
        # TODO: jam 20070215 This is the lazy way by using the RevisionTree
2080
 
        # implementation based on an inventory.
 
1715
        # implementation based on an inventory.  
2081
1716
        # This should be cleaned up to use the much faster Dirstate code
2082
1717
        # So for now, we just build up the parent inventory, and extract
2083
1718
        # it the same way RevisionTree does.
2084
1719
        _directory = 'directory'
2085
 
        inv = self._get_root_inventory()
 
1720
        inv = self._get_inventory()
2086
1721
        top_id = inv.path2id(prefix)
2087
1722
        if top_id is None:
2088
1723
            pending = []
2112
1747
 
2113
1748
class InterDirStateTree(InterTree):
2114
1749
    """Fast path optimiser for changes_from with dirstate trees.
2115
 
 
2116
 
    This is used only when both trees are in the dirstate working file, and
2117
 
    the source is any parent within the dirstate, and the destination is
 
1750
    
 
1751
    This is used only when both trees are in the dirstate working file, and 
 
1752
    the source is any parent within the dirstate, and the destination is 
2118
1753
    the current working tree of the same dirstate.
2119
1754
    """
2120
1755
    # this could be generalized to allow comparisons between any trees in the
2129
1764
    def make_source_parent_tree(source, target):
2130
1765
        """Change the source tree into a parent of the target."""
2131
1766
        revid = source.commit('record tree')
2132
 
        target.branch.fetch(source.branch, revid)
 
1767
        target.branch.repository.fetch(source.branch.repository, revid)
2133
1768
        target.set_parent_ids([revid])
2134
1769
        return target.basis_tree(), target
2135
1770
 
2136
 
    @classmethod
2137
 
    def make_source_parent_tree_python_dirstate(klass, test_case, source, target):
2138
 
        result = klass.make_source_parent_tree(source, target)
2139
 
        result[1]._iter_changes = dirstate.ProcessEntryPython
2140
 
        return result
2141
 
 
2142
 
    @classmethod
2143
 
    def make_source_parent_tree_compiled_dirstate(klass, test_case, source,
2144
 
                                                  target):
2145
 
        from bzrlib.tests.test__dirstate_helpers import \
2146
 
            compiled_dirstate_helpers_feature
2147
 
        test_case.requireFeature(compiled_dirstate_helpers_feature)
2148
 
        from bzrlib._dirstate_helpers_pyx import ProcessEntryC
2149
 
        result = klass.make_source_parent_tree(source, target)
2150
 
        result[1]._iter_changes = ProcessEntryC
2151
 
        return result
2152
 
 
2153
1771
    _matching_from_tree_format = WorkingTreeFormat4()
2154
1772
    _matching_to_tree_format = WorkingTreeFormat4()
2155
 
 
2156
 
    @classmethod
2157
 
    def _test_mutable_trees_to_test_trees(klass, test_case, source, target):
2158
 
        # This method shouldn't be called, because we have python and C
2159
 
        # specific flavours.
2160
 
        raise NotImplementedError
 
1773
    _test_mutable_trees_to_test_trees = make_source_parent_tree
2161
1774
 
2162
1775
    def iter_changes(self, include_unchanged=False,
2163
1776
                      specific_files=None, pb=None, extra_trees=[],
2181
1794
            output. An unversioned file is defined as one with (False, False)
2182
1795
            for the versioned pair.
2183
1796
        """
 
1797
        utf8_decode = cache_utf8._utf8_decode
 
1798
        _minikind_to_kind = dirstate.DirState._minikind_to_kind
 
1799
        cmp_by_dirs = dirstate.cmp_by_dirs
 
1800
        # NB: show_status depends on being able to pass in non-versioned files
 
1801
        # and report them as unknown
2184
1802
        # TODO: handle extra trees in the dirstate.
2185
1803
        if (extra_trees or specific_files == []):
2186
1804
            # we can't fast-path these cases (yet)
2187
 
            return super(InterDirStateTree, self).iter_changes(
 
1805
            for f in super(InterDirStateTree, self).iter_changes(
2188
1806
                include_unchanged, specific_files, pb, extra_trees,
2189
 
                require_versioned, want_unversioned=want_unversioned)
 
1807
                require_versioned, want_unversioned=want_unversioned):
 
1808
                yield f
 
1809
            return
2190
1810
        parent_ids = self.target.get_parent_ids()
2191
1811
        if not (self.source._revision_id in parent_ids
2192
 
                or self.source._revision_id == _mod_revision.NULL_REVISION):
 
1812
                or self.source._revision_id == NULL_REVISION):
2193
1813
            raise AssertionError(
2194
1814
                "revision {%s} is not stored in {%s}, but %s "
2195
1815
                "can only be used for trees stored in the dirstate"
2196
1816
                % (self.source._revision_id, self.target, self.iter_changes))
2197
1817
        target_index = 0
2198
 
        if self.source._revision_id == _mod_revision.NULL_REVISION:
 
1818
        if self.source._revision_id == NULL_REVISION:
2199
1819
            source_index = None
2200
1820
            indices = (target_index,)
2201
1821
        else:
2209
1829
        if specific_files:
2210
1830
            specific_files_utf8 = set()
2211
1831
            for path in specific_files:
2212
 
                # Note, if there are many specific files, using cache_utf8
2213
 
                # would be good here.
2214
1832
                specific_files_utf8.add(path.encode('utf8'))
2215
1833
            specific_files = specific_files_utf8
2216
1834
        else:
2217
1835
            specific_files = set([''])
2218
1836
        # -- specific_files is now a utf8 path set --
2219
 
 
2220
1837
        # -- get the state object and prepare it.
2221
1838
        state = self.target.current_dirstate()
2222
1839
        state._read_dirblocks_if_needed()
 
1840
        def _entries_for_path(path):
 
1841
            """Return a list with all the entries that match path for all ids.
 
1842
            """
 
1843
            dirname, basename = os.path.split(path)
 
1844
            key = (dirname, basename, '')
 
1845
            block_index, present = state._find_block_index_from_key(key)
 
1846
            if not present:
 
1847
                # the block which should contain path is absent.
 
1848
                return []
 
1849
            result = []
 
1850
            block = state._dirblocks[block_index][1]
 
1851
            entry_index, _ = state._find_entry_index(key, block)
 
1852
            # we may need to look at multiple entries at this path: walk while the specific_files match.
 
1853
            while (entry_index < len(block) and
 
1854
                block[entry_index][0][0:2] == key[0:2]):
 
1855
                result.append(block[entry_index])
 
1856
                entry_index += 1
 
1857
            return result
2223
1858
        if require_versioned:
2224
1859
            # -- check all supplied paths are versioned in a search tree. --
2225
 
            not_versioned = []
 
1860
            all_versioned = True
2226
1861
            for path in specific_files:
2227
 
                path_entries = state._entries_for_path(path)
 
1862
                path_entries = _entries_for_path(path)
2228
1863
                if not path_entries:
2229
1864
                    # this specified path is not present at all: error
2230
 
                    not_versioned.append(path.decode('utf-8'))
2231
 
                    continue
 
1865
                    all_versioned = False
 
1866
                    break
2232
1867
                found_versioned = False
2233
1868
                # for each id at this path
2234
1869
                for entry in path_entries:
2241
1876
                if not found_versioned:
2242
1877
                    # none of the indexes was not 'absent' at all ids for this
2243
1878
                    # path.
2244
 
                    not_versioned.append(path.decode('utf-8'))
2245
 
            if len(not_versioned) > 0:
2246
 
                raise errors.PathsNotVersionedError(not_versioned)
 
1879
                    all_versioned = False
 
1880
                    break
 
1881
            if not all_versioned:
 
1882
                raise errors.PathsNotVersionedError(specific_files)
2247
1883
        # -- remove redundancy in supplied specific_files to prevent over-scanning --
2248
 
        search_specific_files = osutils.minimum_path_selection(specific_files)
 
1884
        search_specific_files = set()
 
1885
        for path in specific_files:
 
1886
            other_specific_files = specific_files.difference(set([path]))
 
1887
            if not osutils.is_inside_any(other_specific_files, path):
 
1888
                # this is a top level path, we must check it.
 
1889
                search_specific_files.add(path)
 
1890
        # sketch: 
 
1891
        # compare source_index and target_index at or under each element of search_specific_files.
 
1892
        # follow the following comparison table. Note that we only want to do diff operations when
 
1893
        # the target is fdl because thats when the walkdirs logic will have exposed the pathinfo 
 
1894
        # for the target.
 
1895
        # cases:
 
1896
        # 
 
1897
        # Source | Target | disk | action
 
1898
        #   r    | fdlt   |      | add source to search, add id path move and perform
 
1899
        #        |        |      | diff check on source-target
 
1900
        #   r    | fdlt   |  a   | dangling file that was present in the basis. 
 
1901
        #        |        |      | ???
 
1902
        #   r    |  a     |      | add source to search
 
1903
        #   r    |  a     |  a   | 
 
1904
        #   r    |  r     |      | this path is present in a non-examined tree, skip.
 
1905
        #   r    |  r     |  a   | this path is present in a non-examined tree, skip.
 
1906
        #   a    | fdlt   |      | add new id
 
1907
        #   a    | fdlt   |  a   | dangling locally added file, skip
 
1908
        #   a    |  a     |      | not present in either tree, skip
 
1909
        #   a    |  a     |  a   | not present in any tree, skip
 
1910
        #   a    |  r     |      | not present in either tree at this path, skip as it
 
1911
        #        |        |      | may not be selected by the users list of paths.
 
1912
        #   a    |  r     |  a   | not present in either tree at this path, skip as it
 
1913
        #        |        |      | may not be selected by the users list of paths.
 
1914
        #  fdlt  | fdlt   |      | content in both: diff them
 
1915
        #  fdlt  | fdlt   |  a   | deleted locally, but not unversioned - show as deleted ?
 
1916
        #  fdlt  |  a     |      | unversioned: output deleted id for now
 
1917
        #  fdlt  |  a     |  a   | unversioned and deleted: output deleted id
 
1918
        #  fdlt  |  r     |      | relocated in this tree, so add target to search.
 
1919
        #        |        |      | Dont diff, we will see an r,fd; pair when we reach
 
1920
        #        |        |      | this id at the other path.
 
1921
        #  fdlt  |  r     |  a   | relocated in this tree, so add target to search.
 
1922
        #        |        |      | Dont diff, we will see an r,fd; pair when we reach
 
1923
        #        |        |      | this id at the other path.
 
1924
 
 
1925
        # for all search_indexs in each path at or under each element of
 
1926
        # search_specific_files, if the detail is relocated: add the id, and add the
 
1927
        # relocated path as one to search if its not searched already. If the
 
1928
        # detail is not relocated, add the id.
 
1929
        searched_specific_files = set()
 
1930
        NULL_PARENT_DETAILS = dirstate.DirState.NULL_PARENT_DETAILS
 
1931
        # Using a list so that we can access the values and change them in
 
1932
        # nested scope. Each one is [path, file_id, entry]
 
1933
        last_source_parent = [None, None]
 
1934
        last_target_parent = [None, None]
2249
1935
 
2250
1936
        use_filesystem_for_exec = (sys.platform != 'win32')
2251
 
        iter_changes = self.target._iter_changes(include_unchanged,
2252
 
            use_filesystem_for_exec, search_specific_files, state,
2253
 
            source_index, target_index, want_unversioned, self.target)
2254
 
        return iter_changes.iter_changes()
 
1937
 
 
1938
        # Just a sentry, so that _process_entry can say that this
 
1939
        # record is handled, but isn't interesting to process (unchanged)
 
1940
        uninteresting = object()
 
1941
 
 
1942
 
 
1943
        old_dirname_to_file_id = {}
 
1944
        new_dirname_to_file_id = {}
 
1945
        # TODO: jam 20070516 - Avoid the _get_entry lookup overhead by
 
1946
        #       keeping a cache of directories that we have seen.
 
1947
 
 
1948
        def _process_entry(entry, path_info):
 
1949
            """Compare an entry and real disk to generate delta information.
 
1950
 
 
1951
            :param path_info: top_relpath, basename, kind, lstat, abspath for
 
1952
                the path of entry. If None, then the path is considered absent.
 
1953
                (Perhaps we should pass in a concrete entry for this ?)
 
1954
                Basename is returned as a utf8 string because we expect this
 
1955
                tuple will be ignored, and don't want to take the time to
 
1956
                decode.
 
1957
            :return: None if these don't match
 
1958
                     A tuple of information about the change, or
 
1959
                     the object 'uninteresting' if these match, but are
 
1960
                     basically identical.
 
1961
            """
 
1962
            if source_index is None:
 
1963
                source_details = NULL_PARENT_DETAILS
 
1964
            else:
 
1965
                source_details = entry[1][source_index]
 
1966
            target_details = entry[1][target_index]
 
1967
            target_minikind = target_details[0]
 
1968
            if path_info is not None and target_minikind in 'fdlt':
 
1969
                if not (target_index == 0):
 
1970
                    raise AssertionError()
 
1971
                link_or_sha1 = state.update_entry(entry, abspath=path_info[4],
 
1972
                                                  stat_value=path_info[3])
 
1973
                # The entry may have been modified by update_entry
 
1974
                target_details = entry[1][target_index]
 
1975
                target_minikind = target_details[0]
 
1976
            else:
 
1977
                link_or_sha1 = None
 
1978
            file_id = entry[0][2]
 
1979
            source_minikind = source_details[0]
 
1980
            if source_minikind in 'fdltr' and target_minikind in 'fdlt':
 
1981
                # claimed content in both: diff
 
1982
                #   r    | fdlt   |      | add source to search, add id path move and perform
 
1983
                #        |        |      | diff check on source-target
 
1984
                #   r    | fdlt   |  a   | dangling file that was present in the basis.
 
1985
                #        |        |      | ???
 
1986
                if source_minikind in 'r':
 
1987
                    # add the source to the search path to find any children it
 
1988
                    # has.  TODO ? : only add if it is a container ?
 
1989
                    if not osutils.is_inside_any(searched_specific_files,
 
1990
                                                 source_details[1]):
 
1991
                        search_specific_files.add(source_details[1])
 
1992
                    # generate the old path; this is needed for stating later
 
1993
                    # as well.
 
1994
                    old_path = source_details[1]
 
1995
                    old_dirname, old_basename = os.path.split(old_path)
 
1996
                    path = pathjoin(entry[0][0], entry[0][1])
 
1997
                    old_entry = state._get_entry(source_index,
 
1998
                                                 path_utf8=old_path)
 
1999
                    # update the source details variable to be the real
 
2000
                    # location.
 
2001
                    if old_entry == (None, None):
 
2002
                        raise errors.CorruptDirstate(state._filename,
 
2003
                            "entry '%s/%s' is considered renamed from %r"
 
2004
                            " but source does not exist\n"
 
2005
                            "entry: %s" % (entry[0][0], entry[0][1], old_path, entry))
 
2006
                    source_details = old_entry[1][source_index]
 
2007
                    source_minikind = source_details[0]
 
2008
                else:
 
2009
                    old_dirname = entry[0][0]
 
2010
                    old_basename = entry[0][1]
 
2011
                    old_path = path = None
 
2012
                if path_info is None:
 
2013
                    # the file is missing on disk, show as removed.
 
2014
                    content_change = True
 
2015
                    target_kind = None
 
2016
                    target_exec = False
 
2017
                else:
 
2018
                    # source and target are both versioned and disk file is present.
 
2019
                    target_kind = path_info[2]
 
2020
                    if target_kind == 'directory':
 
2021
                        if path is None:
 
2022
                            old_path = path = pathjoin(old_dirname, old_basename)
 
2023
                        new_dirname_to_file_id[path] = file_id
 
2024
                        if source_minikind != 'd':
 
2025
                            content_change = True
 
2026
                        else:
 
2027
                            # directories have no fingerprint
 
2028
                            content_change = False
 
2029
                        target_exec = False
 
2030
                    elif target_kind == 'file':
 
2031
                        if source_minikind != 'f':
 
2032
                            content_change = True
 
2033
                        else:
 
2034
                            # We could check the size, but we already have the
 
2035
                            # sha1 hash.
 
2036
                            content_change = (link_or_sha1 != source_details[1])
 
2037
                        # Target details is updated at update_entry time
 
2038
                        if use_filesystem_for_exec:
 
2039
                            # We don't need S_ISREG here, because we are sure
 
2040
                            # we are dealing with a file.
 
2041
                            target_exec = bool(stat.S_IEXEC & path_info[3].st_mode)
 
2042
                        else:
 
2043
                            target_exec = target_details[3]
 
2044
                    elif target_kind == 'symlink':
 
2045
                        if source_minikind != 'l':
 
2046
                            content_change = True
 
2047
                        else:
 
2048
                            content_change = (link_or_sha1 != source_details[1])
 
2049
                        target_exec = False
 
2050
                    elif target_kind == 'tree-reference':
 
2051
                        if source_minikind != 't':
 
2052
                            content_change = True
 
2053
                        else:
 
2054
                            content_change = False
 
2055
                        target_exec = False
 
2056
                    else:
 
2057
                        raise Exception, "unknown kind %s" % path_info[2]
 
2058
                if source_minikind == 'd':
 
2059
                    if path is None:
 
2060
                        old_path = path = pathjoin(old_dirname, old_basename)
 
2061
                    old_dirname_to_file_id[old_path] = file_id
 
2062
                # parent id is the entry for the path in the target tree
 
2063
                if old_dirname == last_source_parent[0]:
 
2064
                    source_parent_id = last_source_parent[1]
 
2065
                else:
 
2066
                    try:
 
2067
                        source_parent_id = old_dirname_to_file_id[old_dirname]
 
2068
                    except KeyError:
 
2069
                        source_parent_entry = state._get_entry(source_index,
 
2070
                                                               path_utf8=old_dirname)
 
2071
                        source_parent_id = source_parent_entry[0][2]
 
2072
                    if source_parent_id == entry[0][2]:
 
2073
                        # This is the root, so the parent is None
 
2074
                        source_parent_id = None
 
2075
                    else:
 
2076
                        last_source_parent[0] = old_dirname
 
2077
                        last_source_parent[1] = source_parent_id
 
2078
                new_dirname = entry[0][0]
 
2079
                if new_dirname == last_target_parent[0]:
 
2080
                    target_parent_id = last_target_parent[1]
 
2081
                else:
 
2082
                    try:
 
2083
                        target_parent_id = new_dirname_to_file_id[new_dirname]
 
2084
                    except KeyError:
 
2085
                        # TODO: We don't always need to do the lookup, because the
 
2086
                        #       parent entry will be the same as the source entry.
 
2087
                        target_parent_entry = state._get_entry(target_index,
 
2088
                                                               path_utf8=new_dirname)
 
2089
                        if target_parent_entry == (None, None):
 
2090
                            raise AssertionError(
 
2091
                                "Could not find target parent in wt: %s\nparent of: %s"
 
2092
                                % (new_dirname, entry))
 
2093
                        target_parent_id = target_parent_entry[0][2]
 
2094
                    if target_parent_id == entry[0][2]:
 
2095
                        # This is the root, so the parent is None
 
2096
                        target_parent_id = None
 
2097
                    else:
 
2098
                        last_target_parent[0] = new_dirname
 
2099
                        last_target_parent[1] = target_parent_id
 
2100
 
 
2101
                source_exec = source_details[3]
 
2102
                if (include_unchanged
 
2103
                    or content_change
 
2104
                    or source_parent_id != target_parent_id
 
2105
                    or old_basename != entry[0][1]
 
2106
                    or source_exec != target_exec
 
2107
                    ):
 
2108
                    if old_path is None:
 
2109
                        old_path = path = pathjoin(old_dirname, old_basename)
 
2110
                        old_path_u = utf8_decode(old_path)[0]
 
2111
                        path_u = old_path_u
 
2112
                    else:
 
2113
                        old_path_u = utf8_decode(old_path)[0]
 
2114
                        if old_path == path:
 
2115
                            path_u = old_path_u
 
2116
                        else:
 
2117
                            path_u = utf8_decode(path)[0]
 
2118
                    source_kind = _minikind_to_kind[source_minikind]
 
2119
                    return (entry[0][2],
 
2120
                           (old_path_u, path_u),
 
2121
                           content_change,
 
2122
                           (True, True),
 
2123
                           (source_parent_id, target_parent_id),
 
2124
                           (utf8_decode(old_basename)[0], utf8_decode(entry[0][1])[0]),
 
2125
                           (source_kind, target_kind),
 
2126
                           (source_exec, target_exec))
 
2127
                else:
 
2128
                    return uninteresting
 
2129
            elif source_minikind in 'a' and target_minikind in 'fdlt':
 
2130
                # looks like a new file
 
2131
                if path_info is not None:
 
2132
                    path = pathjoin(entry[0][0], entry[0][1])
 
2133
                    # parent id is the entry for the path in the target tree
 
2134
                    # TODO: these are the same for an entire directory: cache em.
 
2135
                    parent_id = state._get_entry(target_index,
 
2136
                                                 path_utf8=entry[0][0])[0][2]
 
2137
                    if parent_id == entry[0][2]:
 
2138
                        parent_id = None
 
2139
                    if use_filesystem_for_exec:
 
2140
                        # We need S_ISREG here, because we aren't sure if this
 
2141
                        # is a file or not.
 
2142
                        target_exec = bool(
 
2143
                            stat.S_ISREG(path_info[3].st_mode)
 
2144
                            and stat.S_IEXEC & path_info[3].st_mode)
 
2145
                    else:
 
2146
                        target_exec = target_details[3]
 
2147
                    return (entry[0][2],
 
2148
                           (None, utf8_decode(path)[0]),
 
2149
                           True,
 
2150
                           (False, True),
 
2151
                           (None, parent_id),
 
2152
                           (None, utf8_decode(entry[0][1])[0]),
 
2153
                           (None, path_info[2]),
 
2154
                           (None, target_exec))
 
2155
                else:
 
2156
                    # but its not on disk: we deliberately treat this as just
 
2157
                    # never-present. (Why ?! - RBC 20070224)
 
2158
                    pass
 
2159
            elif source_minikind in 'fdlt' and target_minikind in 'a':
 
2160
                # unversioned, possibly, or possibly not deleted: we dont care.
 
2161
                # if its still on disk, *and* theres no other entry at this
 
2162
                # path [we dont know this in this routine at the moment -
 
2163
                # perhaps we should change this - then it would be an unknown.
 
2164
                old_path = pathjoin(entry[0][0], entry[0][1])
 
2165
                # parent id is the entry for the path in the target tree
 
2166
                parent_id = state._get_entry(source_index, path_utf8=entry[0][0])[0][2]
 
2167
                if parent_id == entry[0][2]:
 
2168
                    parent_id = None
 
2169
                return (entry[0][2],
 
2170
                       (utf8_decode(old_path)[0], None),
 
2171
                       True,
 
2172
                       (True, False),
 
2173
                       (parent_id, None),
 
2174
                       (utf8_decode(entry[0][1])[0], None),
 
2175
                       (_minikind_to_kind[source_minikind], None),
 
2176
                       (source_details[3], None))
 
2177
            elif source_minikind in 'fdlt' and target_minikind in 'r':
 
2178
                # a rename; could be a true rename, or a rename inherited from
 
2179
                # a renamed parent. TODO: handle this efficiently. Its not
 
2180
                # common case to rename dirs though, so a correct but slow
 
2181
                # implementation will do.
 
2182
                if not osutils.is_inside_any(searched_specific_files, target_details[1]):
 
2183
                    search_specific_files.add(target_details[1])
 
2184
            elif source_minikind in 'ra' and target_minikind in 'ra':
 
2185
                # neither of the selected trees contain this file,
 
2186
                # so skip over it. This is not currently directly tested, but
 
2187
                # is indirectly via test_too_much.TestCommands.test_conflicts.
 
2188
                pass
 
2189
            else:
 
2190
                raise AssertionError("don't know how to compare "
 
2191
                    "source_minikind=%r, target_minikind=%r"
 
2192
                    % (source_minikind, target_minikind))
 
2193
                ## import pdb;pdb.set_trace()
 
2194
            return None
 
2195
 
 
2196
        while search_specific_files:
 
2197
            # TODO: the pending list should be lexically sorted?  the
 
2198
            # interface doesn't require it.
 
2199
            current_root = search_specific_files.pop()
 
2200
            current_root_unicode = current_root.decode('utf8')
 
2201
            searched_specific_files.add(current_root)
 
2202
            # process the entries for this containing directory: the rest will be
 
2203
            # found by their parents recursively.
 
2204
            root_entries = _entries_for_path(current_root)
 
2205
            root_abspath = self.target.abspath(current_root_unicode)
 
2206
            try:
 
2207
                root_stat = os.lstat(root_abspath)
 
2208
            except OSError, e:
 
2209
                if e.errno == errno.ENOENT:
 
2210
                    # the path does not exist: let _process_entry know that.
 
2211
                    root_dir_info = None
 
2212
                else:
 
2213
                    # some other random error: hand it up.
 
2214
                    raise
 
2215
            else:
 
2216
                root_dir_info = ('', current_root,
 
2217
                    osutils.file_kind_from_stat_mode(root_stat.st_mode), root_stat,
 
2218
                    root_abspath)
 
2219
                if root_dir_info[2] == 'directory':
 
2220
                    if self.target._directory_is_tree_reference(
 
2221
                        current_root.decode('utf8')):
 
2222
                        root_dir_info = root_dir_info[:2] + \
 
2223
                            ('tree-reference',) + root_dir_info[3:]
 
2224
 
 
2225
            if not root_entries and not root_dir_info:
 
2226
                # this specified path is not present at all, skip it.
 
2227
                continue
 
2228
            path_handled = False
 
2229
            for entry in root_entries:
 
2230
                result = _process_entry(entry, root_dir_info)
 
2231
                if result is not None:
 
2232
                    path_handled = True
 
2233
                    if result is not uninteresting:
 
2234
                        yield result
 
2235
            if want_unversioned and not path_handled and root_dir_info:
 
2236
                new_executable = bool(
 
2237
                    stat.S_ISREG(root_dir_info[3].st_mode)
 
2238
                    and stat.S_IEXEC & root_dir_info[3].st_mode)
 
2239
                yield (None,
 
2240
                       (None, current_root_unicode),
 
2241
                       True,
 
2242
                       (False, False),
 
2243
                       (None, None),
 
2244
                       (None, splitpath(current_root_unicode)[-1]),
 
2245
                       (None, root_dir_info[2]),
 
2246
                       (None, new_executable)
 
2247
                      )
 
2248
            initial_key = (current_root, '', '')
 
2249
            block_index, _ = state._find_block_index_from_key(initial_key)
 
2250
            if block_index == 0:
 
2251
                # we have processed the total root already, but because the
 
2252
                # initial key matched it we should skip it here.
 
2253
                block_index +=1
 
2254
            if root_dir_info and root_dir_info[2] == 'tree-reference':
 
2255
                current_dir_info = None
 
2256
            else:
 
2257
                dir_iterator = osutils._walkdirs_utf8(root_abspath, prefix=current_root)
 
2258
                try:
 
2259
                    current_dir_info = dir_iterator.next()
 
2260
                except OSError, e:
 
2261
                    # on win32, python2.4 has e.errno == ERROR_DIRECTORY, but
 
2262
                    # python 2.5 has e.errno == EINVAL,
 
2263
                    #            and e.winerror == ERROR_DIRECTORY
 
2264
                    e_winerror = getattr(e, 'winerror', None)
 
2265
                    win_errors = (ERROR_DIRECTORY, ERROR_PATH_NOT_FOUND)
 
2266
                    # there may be directories in the inventory even though
 
2267
                    # this path is not a file on disk: so mark it as end of
 
2268
                    # iterator
 
2269
                    if e.errno in (errno.ENOENT, errno.ENOTDIR, errno.EINVAL):
 
2270
                        current_dir_info = None
 
2271
                    elif (sys.platform == 'win32'
 
2272
                          and (e.errno in win_errors
 
2273
                               or e_winerror in win_errors)):
 
2274
                        current_dir_info = None
 
2275
                    else:
 
2276
                        raise
 
2277
                else:
 
2278
                    if current_dir_info[0][0] == '':
 
2279
                        # remove .bzr from iteration
 
2280
                        bzr_index = bisect_left(current_dir_info[1], ('.bzr',))
 
2281
                        if current_dir_info[1][bzr_index][0] != '.bzr':
 
2282
                            raise AssertionError()
 
2283
                        del current_dir_info[1][bzr_index]
 
2284
            # walk until both the directory listing and the versioned metadata
 
2285
            # are exhausted. 
 
2286
            if (block_index < len(state._dirblocks) and
 
2287
                osutils.is_inside(current_root, state._dirblocks[block_index][0])):
 
2288
                current_block = state._dirblocks[block_index]
 
2289
            else:
 
2290
                current_block = None
 
2291
            while (current_dir_info is not None or
 
2292
                   current_block is not None):
 
2293
                if (current_dir_info and current_block
 
2294
                    and current_dir_info[0][0] != current_block[0]):
 
2295
                    if cmp_by_dirs(current_dir_info[0][0], current_block[0]) < 0:
 
2296
                        # filesystem data refers to paths not covered by the dirblock.
 
2297
                        # this has two possibilities:
 
2298
                        # A) it is versioned but empty, so there is no block for it
 
2299
                        # B) it is not versioned.
 
2300
 
 
2301
                        # if (A) then we need to recurse into it to check for
 
2302
                        # new unknown files or directories.
 
2303
                        # if (B) then we should ignore it, because we don't
 
2304
                        # recurse into unknown directories.
 
2305
                        path_index = 0
 
2306
                        while path_index < len(current_dir_info[1]):
 
2307
                                current_path_info = current_dir_info[1][path_index]
 
2308
                                if want_unversioned:
 
2309
                                    if current_path_info[2] == 'directory':
 
2310
                                        if self.target._directory_is_tree_reference(
 
2311
                                            current_path_info[0].decode('utf8')):
 
2312
                                            current_path_info = current_path_info[:2] + \
 
2313
                                                ('tree-reference',) + current_path_info[3:]
 
2314
                                    new_executable = bool(
 
2315
                                        stat.S_ISREG(current_path_info[3].st_mode)
 
2316
                                        and stat.S_IEXEC & current_path_info[3].st_mode)
 
2317
                                    yield (None,
 
2318
                                        (None, utf8_decode(current_path_info[0])[0]),
 
2319
                                        True,
 
2320
                                        (False, False),
 
2321
                                        (None, None),
 
2322
                                        (None, utf8_decode(current_path_info[1])[0]),
 
2323
                                        (None, current_path_info[2]),
 
2324
                                        (None, new_executable))
 
2325
                                # dont descend into this unversioned path if it is
 
2326
                                # a dir
 
2327
                                if current_path_info[2] in ('directory',
 
2328
                                                            'tree-reference'):
 
2329
                                    del current_dir_info[1][path_index]
 
2330
                                    path_index -= 1
 
2331
                                path_index += 1
 
2332
 
 
2333
                        # This dir info has been handled, go to the next
 
2334
                        try:
 
2335
                            current_dir_info = dir_iterator.next()
 
2336
                        except StopIteration:
 
2337
                            current_dir_info = None
 
2338
                    else:
 
2339
                        # We have a dirblock entry for this location, but there
 
2340
                        # is no filesystem path for this. This is most likely
 
2341
                        # because a directory was removed from the disk.
 
2342
                        # We don't have to report the missing directory,
 
2343
                        # because that should have already been handled, but we
 
2344
                        # need to handle all of the files that are contained
 
2345
                        # within.
 
2346
                        for current_entry in current_block[1]:
 
2347
                            # entry referring to file not present on disk.
 
2348
                            # advance the entry only, after processing.
 
2349
                            result = _process_entry(current_entry, None)
 
2350
                            if result is not None:
 
2351
                                if result is not uninteresting:
 
2352
                                    yield result
 
2353
                        block_index +=1
 
2354
                        if (block_index < len(state._dirblocks) and
 
2355
                            osutils.is_inside(current_root,
 
2356
                                              state._dirblocks[block_index][0])):
 
2357
                            current_block = state._dirblocks[block_index]
 
2358
                        else:
 
2359
                            current_block = None
 
2360
                    continue
 
2361
                entry_index = 0
 
2362
                if current_block and entry_index < len(current_block[1]):
 
2363
                    current_entry = current_block[1][entry_index]
 
2364
                else:
 
2365
                    current_entry = None
 
2366
                advance_entry = True
 
2367
                path_index = 0
 
2368
                if current_dir_info and path_index < len(current_dir_info[1]):
 
2369
                    current_path_info = current_dir_info[1][path_index]
 
2370
                    if current_path_info[2] == 'directory':
 
2371
                        if self.target._directory_is_tree_reference(
 
2372
                            current_path_info[0].decode('utf8')):
 
2373
                            current_path_info = current_path_info[:2] + \
 
2374
                                ('tree-reference',) + current_path_info[3:]
 
2375
                else:
 
2376
                    current_path_info = None
 
2377
                advance_path = True
 
2378
                path_handled = False
 
2379
                while (current_entry is not None or
 
2380
                    current_path_info is not None):
 
2381
                    if current_entry is None:
 
2382
                        # the check for path_handled when the path is adnvaced
 
2383
                        # will yield this path if needed.
 
2384
                        pass
 
2385
                    elif current_path_info is None:
 
2386
                        # no path is fine: the per entry code will handle it.
 
2387
                        result = _process_entry(current_entry, current_path_info)
 
2388
                        if result is not None:
 
2389
                            if result is not uninteresting:
 
2390
                                yield result
 
2391
                    elif (current_entry[0][1] != current_path_info[1]
 
2392
                          or current_entry[1][target_index][0] in 'ar'):
 
2393
                        # The current path on disk doesn't match the dirblock
 
2394
                        # record. Either the dirblock is marked as absent, or
 
2395
                        # the file on disk is not present at all in the
 
2396
                        # dirblock. Either way, report about the dirblock
 
2397
                        # entry, and let other code handle the filesystem one.
 
2398
 
 
2399
                        # Compare the basename for these files to determine
 
2400
                        # which comes first
 
2401
                        if current_path_info[1] < current_entry[0][1]:
 
2402
                            # extra file on disk: pass for now, but only
 
2403
                            # increment the path, not the entry
 
2404
                            advance_entry = False
 
2405
                        else:
 
2406
                            # entry referring to file not present on disk.
 
2407
                            # advance the entry only, after processing.
 
2408
                            result = _process_entry(current_entry, None)
 
2409
                            if result is not None:
 
2410
                                if result is not uninteresting:
 
2411
                                    yield result
 
2412
                            advance_path = False
 
2413
                    else:
 
2414
                        result = _process_entry(current_entry, current_path_info)
 
2415
                        if result is not None:
 
2416
                            path_handled = True
 
2417
                            if result is not uninteresting:
 
2418
                                yield result
 
2419
                    if advance_entry and current_entry is not None:
 
2420
                        entry_index += 1
 
2421
                        if entry_index < len(current_block[1]):
 
2422
                            current_entry = current_block[1][entry_index]
 
2423
                        else:
 
2424
                            current_entry = None
 
2425
                    else:
 
2426
                        advance_entry = True # reset the advance flaga
 
2427
                    if advance_path and current_path_info is not None:
 
2428
                        if not path_handled:
 
2429
                            # unversioned in all regards
 
2430
                            if want_unversioned:
 
2431
                                new_executable = bool(
 
2432
                                    stat.S_ISREG(current_path_info[3].st_mode)
 
2433
                                    and stat.S_IEXEC & current_path_info[3].st_mode)
 
2434
                                yield (None,
 
2435
                                    (None, utf8_decode(current_path_info[0])[0]),
 
2436
                                    True,
 
2437
                                    (False, False),
 
2438
                                    (None, None),
 
2439
                                    (None, utf8_decode(current_path_info[1])[0]),
 
2440
                                    (None, current_path_info[2]),
 
2441
                                    (None, new_executable))
 
2442
                            # dont descend into this unversioned path if it is
 
2443
                            # a dir
 
2444
                            if current_path_info[2] in ('directory'):
 
2445
                                del current_dir_info[1][path_index]
 
2446
                                path_index -= 1
 
2447
                        # dont descend the disk iterator into any tree 
 
2448
                        # paths.
 
2449
                        if current_path_info[2] == 'tree-reference':
 
2450
                            del current_dir_info[1][path_index]
 
2451
                            path_index -= 1
 
2452
                        path_index += 1
 
2453
                        if path_index < len(current_dir_info[1]):
 
2454
                            current_path_info = current_dir_info[1][path_index]
 
2455
                            if current_path_info[2] == 'directory':
 
2456
                                if self.target._directory_is_tree_reference(
 
2457
                                    current_path_info[0].decode('utf8')):
 
2458
                                    current_path_info = current_path_info[:2] + \
 
2459
                                        ('tree-reference',) + current_path_info[3:]
 
2460
                        else:
 
2461
                            current_path_info = None
 
2462
                        path_handled = False
 
2463
                    else:
 
2464
                        advance_path = True # reset the advance flagg.
 
2465
                if current_block is not None:
 
2466
                    block_index += 1
 
2467
                    if (block_index < len(state._dirblocks) and
 
2468
                        osutils.is_inside(current_root, state._dirblocks[block_index][0])):
 
2469
                        current_block = state._dirblocks[block_index]
 
2470
                    else:
 
2471
                        current_block = None
 
2472
                if current_dir_info is not None:
 
2473
                    try:
 
2474
                        current_dir_info = dir_iterator.next()
 
2475
                    except StopIteration:
 
2476
                        current_dir_info = None
 
2477
 
2255
2478
 
2256
2479
    @staticmethod
2257
2480
    def is_compatible(source, target):
2258
2481
        # the target must be a dirstate working tree
2259
 
        if not isinstance(target, DirStateWorkingTree):
 
2482
        if not isinstance(target, WorkingTree4):
2260
2483
            return False
2261
 
        # the source must be a revtree or dirstate rev tree.
 
2484
        # the source must be a revtreee or dirstate rev tree.
2262
2485
        if not isinstance(source,
2263
2486
            (revisiontree.RevisionTree, DirStateRevisionTree)):
2264
2487
            return False
2265
2488
        # the source revid must be in the target dirstate
2266
 
        if not (source._revision_id == _mod_revision.NULL_REVISION or
 
2489
        if not (source._revision_id == NULL_REVISION or
2267
2490
            source._revision_id in target.get_parent_ids()):
2268
 
            # TODO: what about ghosts? it may well need to
 
2491
            # TODO: what about ghosts? it may well need to 
2269
2492
            # check for them explicitly.
2270
2493
            return False
2271
2494
        return True
2281
2504
 
2282
2505
    def convert(self, tree):
2283
2506
        # lock the control files not the tree, so that we dont get tree
2284
 
        # on-unlock behaviours, and so that noone else diddles with the
 
2507
        # on-unlock behaviours, and so that noone else diddles with the 
2285
2508
        # tree during upgrade.
2286
2509
        tree._control_files.lock_write()
2287
2510
        try:
2313
2536
 
2314
2537
    def update_format(self, tree):
2315
2538
        """Change the format marker."""
2316
 
        tree._transport.put_bytes('format',
2317
 
            self.target_format.as_string(),
2318
 
            mode=tree.bzrdir._get_file_mode())
2319
 
 
2320
 
 
2321
 
class Converter4to5(object):
2322
 
    """Perform an in-place upgrade of format 4 to format 5 trees."""
2323
 
 
2324
 
    def __init__(self):
2325
 
        self.target_format = WorkingTreeFormat5()
2326
 
 
2327
 
    def convert(self, tree):
2328
 
        # lock the control files not the tree, so that we don't get tree
2329
 
        # on-unlock behaviours, and so that no-one else diddles with the
2330
 
        # tree during upgrade.
2331
 
        tree._control_files.lock_write()
2332
 
        try:
2333
 
            self.update_format(tree)
2334
 
        finally:
2335
 
            tree._control_files.unlock()
2336
 
 
2337
 
    def update_format(self, tree):
2338
 
        """Change the format marker."""
2339
 
        tree._transport.put_bytes('format',
2340
 
            self.target_format.as_string(),
2341
 
            mode=tree.bzrdir._get_file_mode())
2342
 
 
2343
 
 
2344
 
class Converter4or5to6(object):
2345
 
    """Perform an in-place upgrade of format 4 or 5 to format 6 trees."""
2346
 
 
2347
 
    def __init__(self):
2348
 
        self.target_format = WorkingTreeFormat6()
2349
 
 
2350
 
    def convert(self, tree):
2351
 
        # lock the control files not the tree, so that we don't get tree
2352
 
        # on-unlock behaviours, and so that no-one else diddles with the
2353
 
        # tree during upgrade.
2354
 
        tree._control_files.lock_write()
2355
 
        try:
2356
 
            self.init_custom_control_files(tree)
2357
 
            self.update_format(tree)
2358
 
        finally:
2359
 
            tree._control_files.unlock()
2360
 
 
2361
 
    def init_custom_control_files(self, tree):
2362
 
        """Initialize custom control files."""
2363
 
        tree._transport.put_bytes('views', '',
2364
 
            mode=tree.bzrdir._get_file_mode())
2365
 
 
2366
 
    def update_format(self, tree):
2367
 
        """Change the format marker."""
2368
 
        tree._transport.put_bytes('format',
2369
 
            self.target_format.as_string(),
2370
 
            mode=tree.bzrdir._get_file_mode())
 
2539
        tree._control_files.put_utf8('format',
 
2540
            self.target_format.get_format_string())