/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/workingtree_4.py

  • Committer: Martin Pool
  • Date: 2008-06-18 05:35:02 UTC
  • mto: This revision was merged to the branch mainline in revision 3510.
  • Revision ID: mbp@sourcefrog.net-20080618053502-9ogi5d5tx7w5ybf6
Change stray pdb calls to exceptions

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2007-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""WorkingTree4 format and implementation.
18
18
 
28
28
 
29
29
from bzrlib.lazy_import import lazy_import
30
30
lazy_import(globals(), """
 
31
from bisect import bisect_left
 
32
import collections
 
33
from copy import deepcopy
31
34
import errno
 
35
import itertools
 
36
import operator
32
37
import stat
 
38
from time import time
 
39
import warnings
33
40
 
34
41
import bzrlib
35
42
from bzrlib import (
36
43
    bzrdir,
37
44
    cache_utf8,
 
45
    conflicts as _mod_conflicts,
38
46
    debug,
 
47
    delta,
39
48
    dirstate,
40
49
    errors,
41
50
    generate_ids,
 
51
    globbing,
 
52
    ignores,
 
53
    merge,
42
54
    osutils,
43
55
    revision as _mod_revision,
44
56
    revisiontree,
 
57
    textui,
45
58
    trace,
46
59
    transform,
47
 
    views,
 
60
    urlutils,
 
61
    xml5,
 
62
    xml6,
48
63
    )
49
64
import bzrlib.branch
 
65
from bzrlib.transport import get_transport
50
66
import bzrlib.ui
51
67
""")
52
68
 
 
69
from bzrlib import symbol_versioning
53
70
from bzrlib.decorators import needs_read_lock, needs_write_lock
54
 
from bzrlib.filters import filtered_input_file, internal_size_sha_file_byname
55
 
from bzrlib.inventory import Inventory, ROOT_ID, entry_factory
 
71
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, entry_factory
 
72
from bzrlib.lockable_files import LockableFiles, TransportLock
 
73
from bzrlib.lockdir import LockDir
 
74
import bzrlib.mutabletree
56
75
from bzrlib.mutabletree import needs_tree_write_lock
57
76
from bzrlib.osutils import (
58
77
    file_kind,
59
78
    isdir,
 
79
    normpath,
60
80
    pathjoin,
 
81
    rand_chars,
61
82
    realpath,
62
83
    safe_unicode,
 
84
    splitpath,
63
85
    )
64
 
from bzrlib.trace import mutter
 
86
from bzrlib.trace import mutter, note
65
87
from bzrlib.transport.local import LocalTransport
66
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
        )
67
97
from bzrlib.tree import Tree
68
98
from bzrlib.workingtree import WorkingTree, WorkingTree3, WorkingTreeFormat3
69
99
 
70
100
 
71
 
class DirStateWorkingTree(WorkingTree3):
 
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
    """
 
119
 
72
120
    def __init__(self, basedir,
73
121
                 branch,
74
122
                 _control_files=None,
100
148
        #-------------
101
149
        self._setup_directory_is_tree_reference()
102
150
        self._detect_case_handling()
103
 
        self._rules_searcher = None
104
 
        self.views = self._make_views()
105
 
        #--- allow tests to select the dirstate iter_changes implementation
106
 
        self._iter_changes = dirstate._process_entry
107
151
 
108
152
    @needs_tree_write_lock
109
153
    def _add(self, files, ids, kinds):
137
181
    @needs_tree_write_lock
138
182
    def add_reference(self, sub_tree):
139
183
        # use standard implementation, which calls back to self._add
140
 
        #
 
184
        # 
141
185
        # So we don't store the reference_revision in the working dirstate,
142
 
        # it's just recorded at the moment of commit.
 
186
        # it's just recorded at the moment of commit. 
143
187
        self._add_reference(sub_tree)
144
188
 
145
189
    def break_lock(self):
184
228
            WorkingTree3._comparison_data(self, entry, path)
185
229
        # it looks like a plain directory, but it's really a reference -- see
186
230
        # also kind()
187
 
        if (self._repo_supports_tree_reference and kind == 'directory'
188
 
            and entry is not None and entry.kind == 'tree-reference'):
 
231
        if (self._repo_supports_tree_reference and
 
232
            kind == 'directory' and
 
233
            self._directory_is_tree_reference(path)):
189
234
            kind = 'tree-reference'
190
235
        return kind, executable, stat_value
191
236
 
217
262
            return self._dirstate
218
263
        local_path = self.bzrdir.get_workingtree_transport(None
219
264
            ).local_abspath('dirstate')
220
 
        self._dirstate = dirstate.DirState.on_file(local_path,
221
 
            self._sha1_provider())
 
265
        self._dirstate = dirstate.DirState.on_file(local_path)
222
266
        return self._dirstate
223
267
 
224
 
    def _sha1_provider(self):
225
 
        """A function that returns a SHA1Provider suitable for this tree.
226
 
 
227
 
        :return: None if content filtering is not supported by this tree.
228
 
          Otherwise, a SHA1Provider is returned that sha's the canonical
229
 
          form of files, i.e. after read filters are applied.
230
 
        """
231
 
        if self.supports_content_filtering():
232
 
            return ContentFilterAwareSHA1Provider(self)
233
 
        else:
234
 
            return None
235
 
 
236
268
    def filter_unversioned_files(self, paths):
237
269
        """Filter out paths that are versioned.
238
270
 
270
302
 
271
303
    def _generate_inventory(self):
272
304
        """Create and set self.inventory from the dirstate object.
273
 
 
 
305
        
274
306
        This is relatively expensive: we have to walk the entire dirstate.
275
307
        Ideally we would not, and can deprecate this function.
276
308
        """
321
353
                    parent_ies[(dirname + '/' + name).strip('/')] = inv_entry
322
354
                elif kind == 'tree-reference':
323
355
                    if not self._repo_supports_tree_reference:
324
 
                        raise errors.UnsupportedOperation(
325
 
                            self._generate_inventory,
326
 
                            self.branch.repository)
 
356
                        raise AssertionError(
 
357
                            "repository of %r "
 
358
                            "doesn't support tree references "
 
359
                            "required by entry %r"
 
360
                            % (self, name))
327
361
                    inv_entry.reference_revision = link_or_sha1 or None
328
362
                elif kind != 'symlink':
329
363
                    raise AssertionError("unknown kind %r" % kind)
344
378
        If either file_id or path is supplied, it is used as the key to lookup.
345
379
        If both are supplied, the fastest lookup is used, and an error is
346
380
        raised if they do not both point at the same row.
347
 
 
 
381
        
348
382
        :param file_id: An optional unicode file_id to be looked up.
349
383
        :param path: An optional unicode path to be looked up.
350
384
        :return: The dirstate row tuple for path/file_id, or (None, None)
374
408
                    return None
375
409
                else:
376
410
                    raise
377
 
        link_or_sha1 = dirstate.update_entry(state, entry, file_abspath,
378
 
            stat_value=stat_value)
 
411
        link_or_sha1 = state.update_entry(entry, file_abspath,
 
412
                                          stat_value=stat_value)
379
413
        if entry[1][0][0] == 'f':
380
 
            if link_or_sha1 is None:
381
 
                file_obj, statvalue = self.get_file_with_stat(file_id, path)
382
 
                try:
383
 
                    sha1 = osutils.sha_file(file_obj)
384
 
                finally:
385
 
                    file_obj.close()
386
 
                self._observed_sha1(file_id, path, (sha1, statvalue))
387
 
                return sha1
388
 
            else:
389
 
                return link_or_sha1
 
414
            return link_or_sha1
390
415
        return None
391
416
 
392
417
    def _get_inventory(self):
406
431
    @needs_read_lock
407
432
    def get_parent_ids(self):
408
433
        """See Tree.get_parent_ids.
409
 
 
 
434
        
410
435
        This implementation requests the ids list from the dirstate file.
411
436
        """
412
437
        return self.current_dirstate().get_parent_ids()
434
459
        return osutils.lexists(pathjoin(
435
460
                    self.basedir, row[0].decode('utf8'), row[1].decode('utf8')))
436
461
 
437
 
    def has_or_had_id(self, file_id):
438
 
        state = self.current_dirstate()
439
 
        row, parents = self._get_entry(file_id=file_id)
440
 
        return row is not None
441
 
 
442
462
    @needs_read_lock
443
463
    def id2path(self, file_id):
444
464
        "Convert a file-id to a path."
508
528
        return iter(result)
509
529
 
510
530
    def iter_references(self):
511
 
        if not self._repo_supports_tree_reference:
512
 
            # When the repo doesn't support references, we will have nothing to
513
 
            # return
514
 
            return
515
531
        for key, tree_details in self.current_dirstate()._iter_entries():
516
532
            if tree_details[0][0] in ('a', 'r'): # absent, relocated
517
533
                # not relevant to the working tree
519
535
            if not key[1]:
520
536
                # the root is not a reference.
521
537
                continue
522
 
            relpath = pathjoin(key[0].decode('utf8'), key[1].decode('utf8'))
 
538
            path = pathjoin(self.basedir, key[0].decode('utf8'), key[1].decode('utf8'))
523
539
            try:
524
 
                if self._kind(relpath) == 'tree-reference':
525
 
                    yield relpath, key[2]
 
540
                if self._kind(path) == 'tree-reference':
 
541
                    yield path, key[2]
526
542
            except errors.NoSuchFile:
527
543
                # path is missing on disk.
528
544
                continue
529
545
 
530
 
    def _observed_sha1(self, file_id, path, (sha1, statvalue)):
531
 
        """See MutableTree._observed_sha1."""
532
 
        state = self.current_dirstate()
533
 
        entry = self._get_entry(file_id=file_id, path=path)
534
 
        state._observed_sha1(entry, sha1, statvalue)
535
 
 
536
546
    def kind(self, file_id):
537
547
        """Return the kind of a file.
538
548
 
550
560
    def _kind(self, relpath):
551
561
        abspath = self.abspath(relpath)
552
562
        kind = file_kind(abspath)
553
 
        if (self._repo_supports_tree_reference and kind == 'directory'):
554
 
            entry = self._get_entry(path=relpath)
555
 
            if entry[1] is not None:
556
 
                if entry[1][0][0] == 't':
557
 
                    kind = 'tree-reference'
 
563
        if (self._repo_supports_tree_reference and
 
564
            kind == 'directory' and
 
565
            self._directory_is_tree_reference(relpath)):
 
566
            kind = 'tree-reference'
558
567
        return kind
559
568
 
560
569
    @needs_read_lock
691
700
            from_entry = self._get_entry(path=from_rel)
692
701
            if from_entry == (None, None):
693
702
                raise errors.BzrMoveFailedError(from_rel,to_dir,
694
 
                    errors.NotVersionedError(path=from_rel))
 
703
                    errors.NotVersionedError(path=str(from_rel)))
695
704
 
696
705
            from_id = from_entry[0][2]
697
706
            to_rel = pathjoin(to_dir, from_tail)
872
881
        for tree in trees:
873
882
            if not (isinstance(tree, DirStateRevisionTree) and tree._revision_id in
874
883
                parents):
875
 
                return super(DirStateWorkingTree, self).paths2ids(paths,
876
 
                    trees, require_versioned)
 
884
                return super(WorkingTree4, self).paths2ids(paths, trees, require_versioned)
877
885
        search_indexes = [0] + [1 + parents.index(tree._revision_id) for tree in trees]
878
886
        # -- make all paths utf8 --
879
887
        paths_utf8 = set()
940
948
                raise errors.PathsNotVersionedError(paths)
941
949
        # -- remove redundancy in supplied paths to prevent over-scanning --
942
950
        search_paths = osutils.minimum_path_selection(paths)
943
 
        # sketch:
 
951
        # sketch: 
944
952
        # for all search_indexs in each path at or under each element of
945
953
        # search_paths, if the detail is relocated: add the id, and add the
946
954
        # relocated path as one to search if its not searched already. If the
1002
1010
 
1003
1011
    def read_working_inventory(self):
1004
1012
        """Read the working inventory.
1005
 
 
 
1013
        
1006
1014
        This is a meaningless operation for dirstate, but we obey it anyhow.
1007
1015
        """
1008
1016
        return self.inventory
1026
1034
    def set_last_revision(self, new_revision):
1027
1035
        """Change the last revision in the working tree."""
1028
1036
        parents = self.get_parent_ids()
1029
 
        if new_revision in (_mod_revision.NULL_REVISION, None):
 
1037
        if new_revision in (NULL_REVISION, None):
1030
1038
            if len(parents) >= 2:
1031
1039
                raise AssertionError(
1032
1040
                    "setting the last parent to none with a pending merge is "
1039
1047
    @needs_tree_write_lock
1040
1048
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
1041
1049
        """Set the parent ids to revision_ids.
1042
 
 
 
1050
        
1043
1051
        See also set_parent_trees. This api will try to retrieve the tree data
1044
1052
        for each element of revision_ids from the trees repository. If you have
1045
1053
        tree data already available, it is more efficient to use
1097
1105
                real_trees.append((rev_id, tree))
1098
1106
            else:
1099
1107
                real_trees.append((rev_id,
1100
 
                    self.branch.repository.revision_tree(
1101
 
                        _mod_revision.NULL_REVISION)))
 
1108
                    self.branch.repository.revision_tree(None)))
1102
1109
                ghosts.append(rev_id)
1103
1110
            accepted_revisions.add(rev_id)
1104
1111
        dirstate.set_parent_trees(real_trees, ghosts=ghosts)
1199
1206
                # just forget the whole block.
1200
1207
                entry_index = 0
1201
1208
                while entry_index < len(block[1]):
 
1209
                    # Mark this file id as having been removed
1202
1210
                    entry = block[1][entry_index]
1203
 
                    if entry[1][0][0] in 'ar':
1204
 
                        # don't remove absent or renamed entries
 
1211
                    ids_to_unversion.discard(entry[0][2])
 
1212
                    if (entry[1][0][0] in 'ar' # don't remove absent or renamed
 
1213
                                               # entries
 
1214
                        or not state._make_absent(entry)):
1205
1215
                        entry_index += 1
1206
 
                    else:
1207
 
                        # Mark this file id as having been removed
1208
 
                        ids_to_unversion.discard(entry[0][2])
1209
 
                        if not state._make_absent(entry):
1210
 
                            # The block has not shrunk.
1211
 
                            entry_index += 1
1212
1216
                # go to the next block. (At the moment we dont delete empty
1213
1217
                # dirblocks)
1214
1218
                block_index += 1
1266
1270
        if self._dirty:
1267
1271
            raise AssertionError("attempting to write an inventory when the "
1268
1272
                "dirstate is dirty will lose pending changes")
1269
 
        had_inventory = self._inventory is not None
1270
 
        # Setting self._inventory = None forces the dirstate to regenerate the
1271
 
        # working inventory. We do this because self.inventory may be inv, or
1272
 
        # may have been modified, and either case would prevent a clean delta
1273
 
        # being created.
1274
 
        self._inventory = None
1275
 
        # generate a delta,
1276
 
        delta = inv._make_delta(self.inventory)
1277
 
        # and apply it.
1278
 
        self.apply_inventory_delta(delta)
1279
 
        if had_inventory:
 
1273
        self.current_dirstate().set_state_from_inventory(inv)
 
1274
        self._make_dirty(reset_inventory=False)
 
1275
        if self._inventory is not None:
1280
1276
            self._inventory = inv
1281
1277
        self.flush()
1282
1278
 
1283
1279
 
1284
 
class ContentFilterAwareSHA1Provider(dirstate.SHA1Provider):
1285
 
 
1286
 
    def __init__(self, tree):
1287
 
        self.tree = tree
1288
 
 
1289
 
    def sha1(self, abspath):
1290
 
        """See dirstate.SHA1Provider.sha1()."""
1291
 
        filters = self.tree._content_filter_stack(
1292
 
            self.tree.relpath(osutils.safe_unicode(abspath)))
1293
 
        return internal_size_sha_file_byname(abspath, filters)[1]
1294
 
 
1295
 
    def stat_and_sha1(self, abspath):
1296
 
        """See dirstate.SHA1Provider.stat_and_sha1()."""
1297
 
        filters = self.tree._content_filter_stack(
1298
 
            self.tree.relpath(osutils.safe_unicode(abspath)))
1299
 
        file_obj = file(abspath, 'rb', 65000)
1300
 
        try:
1301
 
            statvalue = os.fstat(file_obj.fileno())
1302
 
            if filters:
1303
 
                file_obj = filtered_input_file(file_obj, filters)
1304
 
            sha1 = osutils.size_sha_file(file_obj)[1]
1305
 
        finally:
1306
 
            file_obj.close()
1307
 
        return statvalue, sha1
1308
 
 
1309
 
 
1310
 
class ContentFilteringDirStateWorkingTree(DirStateWorkingTree):
1311
 
    """Dirstate working tree that supports content filtering.
1312
 
 
1313
 
    The dirstate holds the hash and size of the canonical form of the file, 
1314
 
    and most methods must return that.
1315
 
    """
1316
 
 
1317
 
    def _file_content_summary(self, path, stat_result):
1318
 
        # This is to support the somewhat obsolete path_content_summary method
1319
 
        # with content filtering: see
1320
 
        # <https://bugs.edge.launchpad.net/bzr/+bug/415508>.
1321
 
        #
1322
 
        # If the dirstate cache is up to date and knows the hash and size,
1323
 
        # return that.
1324
 
        # Otherwise if there are no content filters, return the on-disk size
1325
 
        # and leave the hash blank.
1326
 
        # Otherwise, read and filter the on-disk file and use its size and
1327
 
        # hash.
1328
 
        #
1329
 
        # The dirstate doesn't store the size of the canonical form so we
1330
 
        # can't trust it for content-filtered trees.  We just return None.
1331
 
        dirstate_sha1 = self._dirstate.sha1_from_stat(path, stat_result)
1332
 
        executable = self._is_executable_from_path_and_stat(path, stat_result)
1333
 
        return ('file', None, executable, dirstate_sha1)
1334
 
 
1335
 
 
1336
 
class WorkingTree4(DirStateWorkingTree):
1337
 
    """This is the Format 4 working tree.
1338
 
 
1339
 
    This differs from WorkingTree3 by:
1340
 
     - Having a consolidated internal dirstate, stored in a
1341
 
       randomly-accessible sorted file on disk.
1342
 
     - Not having a regular inventory attribute.  One can be synthesized
1343
 
       on demand but this is expensive and should be avoided.
1344
 
 
1345
 
    This is new in bzr 0.15.
1346
 
    """
1347
 
 
1348
 
 
1349
 
class WorkingTree5(ContentFilteringDirStateWorkingTree):
1350
 
    """This is the Format 5 working tree.
1351
 
 
1352
 
    This differs from WorkingTree4 by:
1353
 
     - Supporting content filtering.
1354
 
 
1355
 
    This is new in bzr 1.11.
1356
 
    """
1357
 
 
1358
 
 
1359
 
class WorkingTree6(ContentFilteringDirStateWorkingTree):
1360
 
    """This is the Format 6 working tree.
1361
 
 
1362
 
    This differs from WorkingTree5 by:
1363
 
     - Supporting a current view that may mask the set of files in a tree
1364
 
       impacted by most user operations.
1365
 
 
1366
 
    This is new in bzr 1.14.
1367
 
    """
1368
 
 
1369
 
    def _make_views(self):
1370
 
        return views.PathBasedViews(self)
1371
 
 
1372
 
 
1373
 
class DirStateWorkingTreeFormat(WorkingTreeFormat3):
 
1280
class WorkingTreeFormat4(WorkingTreeFormat3):
 
1281
    """The first consolidated dirstate working tree format.
 
1282
 
 
1283
    This format:
 
1284
        - exists within a metadir controlling .bzr
 
1285
        - includes an explicit version marker for the workingtree control
 
1286
          files, separate from the BzrDir format
 
1287
        - modifies the hash cache format
 
1288
        - is new in bzr 0.15
 
1289
        - uses a LockDir to guard access to it.
 
1290
    """
 
1291
 
 
1292
    upgrade_recommended = False
 
1293
 
 
1294
    def get_format_string(self):
 
1295
        """See WorkingTreeFormat.get_format_string()."""
 
1296
        return "Bazaar Working Tree Format 4 (bzr 0.15)\n"
 
1297
 
 
1298
    def get_format_description(self):
 
1299
        """See WorkingTreeFormat.get_format_description()."""
 
1300
        return "Working tree format 4"
1374
1301
 
1375
1302
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
1376
1303
                   accelerator_tree=None, hardlink=False):
1407
1334
        state = dirstate.DirState.initialize(local_path)
1408
1335
        state.unlock()
1409
1336
        del state
1410
 
        wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
 
1337
        wt = WorkingTree4(a_bzrdir.root_transport.local_abspath('.'),
1411
1338
                         branch,
1412
1339
                         _format=self,
1413
1340
                         _bzrdir=a_bzrdir,
1415
1342
        wt._new_tree()
1416
1343
        wt.lock_tree_write()
1417
1344
        try:
1418
 
            self._init_custom_control_files(wt)
1419
 
            if revision_id in (None, _mod_revision.NULL_REVISION):
 
1345
            if revision_id in (None, NULL_REVISION):
1420
1346
                if branch.repository.supports_rich_root():
1421
1347
                    wt._set_root_id(generate_ids.gen_root_id())
1422
1348
                else:
1433
1359
                    pass
1434
1360
            if basis is None:
1435
1361
                basis = branch.repository.revision_tree(revision_id)
1436
 
            if revision_id == _mod_revision.NULL_REVISION:
 
1362
            if revision_id == NULL_REVISION:
1437
1363
                parents_list = []
1438
1364
            else:
1439
1365
                parents_list = [(revision_id, basis)]
1447
1373
                if basis_root_id is not None:
1448
1374
                    wt._set_root_id(basis_root_id)
1449
1375
                    wt.flush()
1450
 
                if wt.supports_content_filtering():
1451
 
                    # The original tree may not have the same content filters
1452
 
                    # applied so we can't safely build the inventory delta from
1453
 
                    # the source tree.
1454
 
                    delta_from_tree = False
1455
 
                else:
1456
 
                    delta_from_tree = True
1457
1376
                # delta_from_tree is safe even for DirStateRevisionTrees,
1458
1377
                # because wt4.apply_inventory_delta does not mutate the input
1459
1378
                # inventory entries.
1460
1379
                transform.build_tree(basis, wt, accelerator_tree,
1461
 
                                     hardlink=hardlink,
1462
 
                                     delta_from_tree=delta_from_tree)
 
1380
                                     hardlink=hardlink, delta_from_tree=True)
1463
1381
            finally:
1464
1382
                basis.unlock()
1465
1383
        finally:
1467
1385
            wt.unlock()
1468
1386
        return wt
1469
1387
 
1470
 
    def _init_custom_control_files(self, wt):
1471
 
        """Subclasses with custom control files should override this method.
1472
 
 
1473
 
        The working tree and control files are locked for writing when this
1474
 
        method is called.
1475
 
 
1476
 
        :param wt: the WorkingTree object
1477
 
        """
1478
 
 
1479
1388
    def _open(self, a_bzrdir, control_files):
1480
1389
        """Open the tree itself.
1481
1390
 
1482
1391
        :param a_bzrdir: the dir for the tree.
1483
1392
        :param control_files: the control files for the tree.
1484
1393
        """
1485
 
        return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
 
1394
        return WorkingTree4(a_bzrdir.root_transport.local_abspath('.'),
1486
1395
                           branch=a_bzrdir.open_branch(),
1487
1396
                           _format=self,
1488
1397
                           _bzrdir=a_bzrdir,
1489
1398
                           _control_files=control_files)
1490
1399
 
1491
1400
    def __get_matchingbzrdir(self):
1492
 
        return self._get_matchingbzrdir()
1493
 
 
1494
 
    def _get_matchingbzrdir(self):
1495
 
        """Overrideable method to get a bzrdir for testing."""
1496
1401
        # please test against something that will let us do tree references
1497
1402
        return bzrdir.format_registry.make_bzrdir(
1498
1403
            'dirstate-with-subtree')
1500
1405
    _matchingbzrdir = property(__get_matchingbzrdir)
1501
1406
 
1502
1407
 
1503
 
class WorkingTreeFormat4(DirStateWorkingTreeFormat):
1504
 
    """The first consolidated dirstate working tree format.
1505
 
 
1506
 
    This format:
1507
 
        - exists within a metadir controlling .bzr
1508
 
        - includes an explicit version marker for the workingtree control
1509
 
          files, separate from the BzrDir format
1510
 
        - modifies the hash cache format
1511
 
        - is new in bzr 0.15
1512
 
        - uses a LockDir to guard access to it.
1513
 
    """
1514
 
 
1515
 
    upgrade_recommended = False
1516
 
 
1517
 
    _tree_class = WorkingTree4
1518
 
 
1519
 
    def get_format_string(self):
1520
 
        """See WorkingTreeFormat.get_format_string()."""
1521
 
        return "Bazaar Working Tree Format 4 (bzr 0.15)\n"
1522
 
 
1523
 
    def get_format_description(self):
1524
 
        """See WorkingTreeFormat.get_format_description()."""
1525
 
        return "Working tree format 4"
1526
 
 
1527
 
 
1528
 
class WorkingTreeFormat5(DirStateWorkingTreeFormat):
1529
 
    """WorkingTree format supporting content filtering.
1530
 
    """
1531
 
 
1532
 
    upgrade_recommended = False
1533
 
 
1534
 
    _tree_class = WorkingTree5
1535
 
 
1536
 
    def get_format_string(self):
1537
 
        """See WorkingTreeFormat.get_format_string()."""
1538
 
        return "Bazaar Working Tree Format 5 (bzr 1.11)\n"
1539
 
 
1540
 
    def get_format_description(self):
1541
 
        """See WorkingTreeFormat.get_format_description()."""
1542
 
        return "Working tree format 5"
1543
 
 
1544
 
    def supports_content_filtering(self):
1545
 
        return True
1546
 
 
1547
 
 
1548
 
class WorkingTreeFormat6(DirStateWorkingTreeFormat):
1549
 
    """WorkingTree format supporting views.
1550
 
    """
1551
 
 
1552
 
    upgrade_recommended = False
1553
 
 
1554
 
    _tree_class = WorkingTree6
1555
 
 
1556
 
    def get_format_string(self):
1557
 
        """See WorkingTreeFormat.get_format_string()."""
1558
 
        return "Bazaar Working Tree Format 6 (bzr 1.14)\n"
1559
 
 
1560
 
    def get_format_description(self):
1561
 
        """See WorkingTreeFormat.get_format_description()."""
1562
 
        return "Working tree format 6"
1563
 
 
1564
 
    def _init_custom_control_files(self, wt):
1565
 
        """Subclasses with custom control files should override this method."""
1566
 
        wt._transport.put_bytes('views', '', mode=wt.bzrdir._get_file_mode())
1567
 
 
1568
 
    def supports_content_filtering(self):
1569
 
        return True
1570
 
 
1571
 
    def supports_views(self):
1572
 
        return True
1573
 
 
1574
 
 
1575
1408
class DirStateRevisionTree(Tree):
1576
 
    """A revision tree pulling the inventory from a dirstate.
1577
 
    
1578
 
    Note that this is one of the historical (ie revision) trees cached in the
1579
 
    dirstate for easy access, not the workingtree.
1580
 
    """
 
1409
    """A revision tree pulling the inventory from a dirstate."""
1581
1410
 
1582
1411
    def __init__(self, dirstate, revision_id, repository):
1583
1412
        self._dirstate = dirstate
1586
1415
        self._inventory = None
1587
1416
        self._locked = 0
1588
1417
        self._dirstate_locked = False
1589
 
        self._repo_supports_tree_reference = getattr(
1590
 
            repository._format, "supports_tree_reference",
1591
 
            False)
1592
1418
 
1593
1419
    def __repr__(self):
1594
1420
        return "<%s of %s in %s>" % \
1599
1425
        """See Tree.annotate_iter"""
1600
1426
        text_key = (file_id, self.inventory[file_id].revision)
1601
1427
        annotations = self._repository.texts.annotate(text_key)
1602
 
        return [(key[-1], line) for (key, line) in annotations]
 
1428
        return [(key[-1], line) for key, line in annotations]
1603
1429
 
1604
1430
    def _get_ancestors(self, default_revision):
1605
1431
        return set(self._repository.get_ancestry(self._revision_id,
1634
1460
        path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
1635
1461
        return path_utf8.decode('utf8')
1636
1462
 
1637
 
    def iter_references(self):
1638
 
        if not self._repo_supports_tree_reference:
1639
 
            # When the repo doesn't support references, we will have nothing to
1640
 
            # return
1641
 
            return iter([])
1642
 
        # Otherwise, fall back to the default implementation
1643
 
        return super(DirStateRevisionTree, self).iter_references()
1644
 
 
1645
1463
    def _get_parent_index(self):
1646
1464
        """Return the index in the dirstate referenced by this tree."""
1647
1465
        return self._dirstate.get_parent_ids().index(self._revision_id) + 1
1652
1470
        If either file_id or path is supplied, it is used as the key to lookup.
1653
1471
        If both are supplied, the fastest lookup is used, and an error is
1654
1472
        raised if they do not both point at the same row.
1655
 
 
 
1473
        
1656
1474
        :param file_id: An optional unicode file_id to be looked up.
1657
1475
        :param path: An optional unicode path to be looked up.
1658
1476
        :return: The dirstate row tuple for path/file_id, or (None, None)
1755
1573
            return None
1756
1574
        parent_index = self._get_parent_index()
1757
1575
        last_changed_revision = entry[1][parent_index][4]
1758
 
        try:
1759
 
            rev = self._repository.get_revision(last_changed_revision)
1760
 
        except errors.NoSuchRevision:
1761
 
            raise errors.FileTimestampUnavailable(self.id2path(file_id))
1762
 
        return rev.timestamp
 
1576
        return self._repository.get_revision(last_changed_revision).timestamp
1763
1577
 
1764
1578
    def get_file_sha1(self, file_id, path=None, stat_value=None):
1765
1579
        entry = self._get_entry(file_id=file_id, path=path)
1772
1586
    def get_file(self, file_id, path=None):
1773
1587
        return StringIO(self.get_file_text(file_id))
1774
1588
 
 
1589
    def get_file_lines(self, file_id):
 
1590
        return osutils.split_lines(self.get_file_text(file_id))
 
1591
 
1775
1592
    def get_file_size(self, file_id):
1776
1593
        """See Tree.get_file_size"""
1777
1594
        return self.inventory[file_id].text_size
1778
1595
 
1779
 
    def get_file_text(self, file_id, path=None):
1780
 
        _, content = list(self.iter_files_bytes([(file_id, None)]))[0]
1781
 
        return ''.join(content)
 
1596
    def get_file_text(self, file_id):
 
1597
        return list(self.iter_files_bytes([(file_id, None)]))[0][1]
1782
1598
 
1783
1599
    def get_reference_revision(self, file_id, path=None):
1784
1600
        return self.inventory[file_id].reference_revision
1803
1619
        if entry[1][parent_index][0] != 'l':
1804
1620
            return None
1805
1621
        else:
1806
 
            target = entry[1][parent_index][1]
1807
 
            target = target.decode('utf8')
1808
 
            return target
 
1622
            # At present, none of the tree implementations supports non-ascii
 
1623
            # symlink targets. So we will just assume that the dirstate path is
 
1624
            # correct.
 
1625
            return entry[1][parent_index][1]
1809
1626
 
1810
1627
    def get_revision_id(self):
1811
1628
        """Return the revision id for this tree."""
1832
1649
        entry = self._get_entry(file_id=file_id)[1]
1833
1650
        if entry is None:
1834
1651
            raise errors.NoSuchId(tree=self, file_id=file_id)
1835
 
        parent_index = self._get_parent_index()
1836
 
        return dirstate.DirState._minikind_to_kind[entry[parent_index][0]]
 
1652
        return dirstate.DirState._minikind_to_kind[entry[1][0]]
1837
1653
 
1838
1654
    def stored_kind(self, file_id):
1839
1655
        """See Tree.stored_kind"""
1859
1675
            return None
1860
1676
        return ie.executable
1861
1677
 
1862
 
    def list_files(self, include_root=False, from_dir=None, recursive=True):
 
1678
    def list_files(self, include_root=False):
1863
1679
        # We use a standard implementation, because DirStateRevisionTree is
1864
1680
        # dealing with one of the parents of the current state
1865
1681
        inv = self._get_inventory()
1866
 
        if from_dir is None:
1867
 
            from_dir_id = None
1868
 
        else:
1869
 
            from_dir_id = inv.path2id(from_dir)
1870
 
            if from_dir_id is None:
1871
 
                # Directory not versioned
1872
 
                return
1873
 
        entries = inv.iter_entries(from_dir=from_dir_id, recursive=recursive)
1874
 
        if inv.root is not None and not include_root and from_dir is None:
 
1682
        entries = inv.iter_entries()
 
1683
        if self.inventory.root is not None and not include_root:
1875
1684
            entries.next()
1876
1685
        for path, entry in entries:
1877
1686
            yield path, 'V', entry.kind, entry.file_id, entry
1910
1719
                self._dirstate_locked = False
1911
1720
            self._repository.unlock()
1912
1721
 
1913
 
    @needs_read_lock
1914
 
    def supports_tree_reference(self):
1915
 
        return self._repo_supports_tree_reference
1916
 
 
1917
1722
    def walkdirs(self, prefix=""):
1918
1723
        # TODO: jam 20070215 This is the lazy way by using the RevisionTree
1919
 
        # implementation based on an inventory.
 
1724
        # implementation based on an inventory.  
1920
1725
        # This should be cleaned up to use the much faster Dirstate code
1921
1726
        # So for now, we just build up the parent inventory, and extract
1922
1727
        # it the same way RevisionTree does.
1951
1756
 
1952
1757
class InterDirStateTree(InterTree):
1953
1758
    """Fast path optimiser for changes_from with dirstate trees.
1954
 
 
1955
 
    This is used only when both trees are in the dirstate working file, and
1956
 
    the source is any parent within the dirstate, and the destination is
 
1759
    
 
1760
    This is used only when both trees are in the dirstate working file, and 
 
1761
    the source is any parent within the dirstate, and the destination is 
1957
1762
    the current working tree of the same dirstate.
1958
1763
    """
1959
1764
    # this could be generalized to allow comparisons between any trees in the
1972
1777
        target.set_parent_ids([revid])
1973
1778
        return target.basis_tree(), target
1974
1779
 
1975
 
    @classmethod
1976
 
    def make_source_parent_tree_python_dirstate(klass, test_case, source, target):
1977
 
        result = klass.make_source_parent_tree(source, target)
1978
 
        result[1]._iter_changes = dirstate.ProcessEntryPython
1979
 
        return result
1980
 
 
1981
 
    @classmethod
1982
 
    def make_source_parent_tree_compiled_dirstate(klass, test_case, source,
1983
 
                                                  target):
1984
 
        from bzrlib.tests.test__dirstate_helpers import \
1985
 
            compiled_dirstate_helpers_feature
1986
 
        test_case.requireFeature(compiled_dirstate_helpers_feature)
1987
 
        from bzrlib._dirstate_helpers_pyx import ProcessEntryC
1988
 
        result = klass.make_source_parent_tree(source, target)
1989
 
        result[1]._iter_changes = ProcessEntryC
1990
 
        return result
1991
 
 
1992
1780
    _matching_from_tree_format = WorkingTreeFormat4()
1993
1781
    _matching_to_tree_format = WorkingTreeFormat4()
1994
 
 
1995
 
    @classmethod
1996
 
    def _test_mutable_trees_to_test_trees(klass, test_case, source, target):
1997
 
        # This method shouldn't be called, because we have python and C
1998
 
        # specific flavours.
1999
 
        raise NotImplementedError
 
1782
    _test_mutable_trees_to_test_trees = make_source_parent_tree
2000
1783
 
2001
1784
    def iter_changes(self, include_unchanged=False,
2002
1785
                      specific_files=None, pb=None, extra_trees=[],
2020
1803
            output. An unversioned file is defined as one with (False, False)
2021
1804
            for the versioned pair.
2022
1805
        """
 
1806
        utf8_decode = cache_utf8._utf8_decode
 
1807
        _minikind_to_kind = dirstate.DirState._minikind_to_kind
 
1808
        cmp_by_dirs = dirstate.cmp_by_dirs
 
1809
        # NB: show_status depends on being able to pass in non-versioned files
 
1810
        # and report them as unknown
2023
1811
        # TODO: handle extra trees in the dirstate.
2024
1812
        if (extra_trees or specific_files == []):
2025
1813
            # we can't fast-path these cases (yet)
2026
 
            return super(InterDirStateTree, self).iter_changes(
 
1814
            for f in super(InterDirStateTree, self).iter_changes(
2027
1815
                include_unchanged, specific_files, pb, extra_trees,
2028
 
                require_versioned, want_unversioned=want_unversioned)
 
1816
                require_versioned, want_unversioned=want_unversioned):
 
1817
                yield f
 
1818
            return
2029
1819
        parent_ids = self.target.get_parent_ids()
2030
1820
        if not (self.source._revision_id in parent_ids
2031
 
                or self.source._revision_id == _mod_revision.NULL_REVISION):
 
1821
                or self.source._revision_id == NULL_REVISION):
2032
1822
            raise AssertionError(
2033
1823
                "revision {%s} is not stored in {%s}, but %s "
2034
1824
                "can only be used for trees stored in the dirstate"
2035
1825
                % (self.source._revision_id, self.target, self.iter_changes))
2036
1826
        target_index = 0
2037
 
        if self.source._revision_id == _mod_revision.NULL_REVISION:
 
1827
        if self.source._revision_id == NULL_REVISION:
2038
1828
            source_index = None
2039
1829
            indices = (target_index,)
2040
1830
        else:
2048
1838
        if specific_files:
2049
1839
            specific_files_utf8 = set()
2050
1840
            for path in specific_files:
2051
 
                # Note, if there are many specific files, using cache_utf8
2052
 
                # would be good here.
2053
1841
                specific_files_utf8.add(path.encode('utf8'))
2054
1842
            specific_files = specific_files_utf8
2055
1843
        else:
2056
1844
            specific_files = set([''])
2057
1845
        # -- specific_files is now a utf8 path set --
2058
 
 
2059
1846
        # -- get the state object and prepare it.
2060
1847
        state = self.target.current_dirstate()
2061
1848
        state._read_dirblocks_if_needed()
 
1849
        def _entries_for_path(path):
 
1850
            """Return a list with all the entries that match path for all ids.
 
1851
            """
 
1852
            dirname, basename = os.path.split(path)
 
1853
            key = (dirname, basename, '')
 
1854
            block_index, present = state._find_block_index_from_key(key)
 
1855
            if not present:
 
1856
                # the block which should contain path is absent.
 
1857
                return []
 
1858
            result = []
 
1859
            block = state._dirblocks[block_index][1]
 
1860
            entry_index, _ = state._find_entry_index(key, block)
 
1861
            # we may need to look at multiple entries at this path: walk while the specific_files match.
 
1862
            while (entry_index < len(block) and
 
1863
                block[entry_index][0][0:2] == key[0:2]):
 
1864
                result.append(block[entry_index])
 
1865
                entry_index += 1
 
1866
            return result
2062
1867
        if require_versioned:
2063
1868
            # -- check all supplied paths are versioned in a search tree. --
2064
 
            not_versioned = []
 
1869
            all_versioned = True
2065
1870
            for path in specific_files:
2066
 
                path_entries = state._entries_for_path(path)
 
1871
                path_entries = _entries_for_path(path)
2067
1872
                if not path_entries:
2068
1873
                    # this specified path is not present at all: error
2069
 
                    not_versioned.append(path)
2070
 
                    continue
 
1874
                    all_versioned = False
 
1875
                    break
2071
1876
                found_versioned = False
2072
1877
                # for each id at this path
2073
1878
                for entry in path_entries:
2080
1885
                if not found_versioned:
2081
1886
                    # none of the indexes was not 'absent' at all ids for this
2082
1887
                    # path.
2083
 
                    not_versioned.append(path)
2084
 
            if len(not_versioned) > 0:
2085
 
                raise errors.PathsNotVersionedError(not_versioned)
 
1888
                    all_versioned = False
 
1889
                    break
 
1890
            if not all_versioned:
 
1891
                raise errors.PathsNotVersionedError(specific_files)
2086
1892
        # -- remove redundancy in supplied specific_files to prevent over-scanning --
2087
 
        search_specific_files = osutils.minimum_path_selection(specific_files)
 
1893
        search_specific_files = set()
 
1894
        for path in specific_files:
 
1895
            other_specific_files = specific_files.difference(set([path]))
 
1896
            if not osutils.is_inside_any(other_specific_files, path):
 
1897
                # this is a top level path, we must check it.
 
1898
                search_specific_files.add(path)
 
1899
        # sketch: 
 
1900
        # compare source_index and target_index at or under each element of search_specific_files.
 
1901
        # follow the following comparison table. Note that we only want to do diff operations when
 
1902
        # the target is fdl because thats when the walkdirs logic will have exposed the pathinfo 
 
1903
        # for the target.
 
1904
        # cases:
 
1905
        # 
 
1906
        # Source | Target | disk | action
 
1907
        #   r    | fdlt   |      | add source to search, add id path move and perform
 
1908
        #        |        |      | diff check on source-target
 
1909
        #   r    | fdlt   |  a   | dangling file that was present in the basis. 
 
1910
        #        |        |      | ???
 
1911
        #   r    |  a     |      | add source to search
 
1912
        #   r    |  a     |  a   | 
 
1913
        #   r    |  r     |      | this path is present in a non-examined tree, skip.
 
1914
        #   r    |  r     |  a   | this path is present in a non-examined tree, skip.
 
1915
        #   a    | fdlt   |      | add new id
 
1916
        #   a    | fdlt   |  a   | dangling locally added file, skip
 
1917
        #   a    |  a     |      | not present in either tree, skip
 
1918
        #   a    |  a     |  a   | not present in any tree, skip
 
1919
        #   a    |  r     |      | not present in either tree at this path, skip as it
 
1920
        #        |        |      | may not be selected by the users list of paths.
 
1921
        #   a    |  r     |  a   | not present in either tree at this path, skip as it
 
1922
        #        |        |      | may not be selected by the users list of paths.
 
1923
        #  fdlt  | fdlt   |      | content in both: diff them
 
1924
        #  fdlt  | fdlt   |  a   | deleted locally, but not unversioned - show as deleted ?
 
1925
        #  fdlt  |  a     |      | unversioned: output deleted id for now
 
1926
        #  fdlt  |  a     |  a   | unversioned and deleted: output deleted id
 
1927
        #  fdlt  |  r     |      | relocated in this tree, so add target to search.
 
1928
        #        |        |      | Dont diff, we will see an r,fd; pair when we reach
 
1929
        #        |        |      | this id at the other path.
 
1930
        #  fdlt  |  r     |  a   | relocated in this tree, so add target to search.
 
1931
        #        |        |      | Dont diff, we will see an r,fd; pair when we reach
 
1932
        #        |        |      | this id at the other path.
 
1933
 
 
1934
        # for all search_indexs in each path at or under each element of
 
1935
        # search_specific_files, if the detail is relocated: add the id, and add the
 
1936
        # relocated path as one to search if its not searched already. If the
 
1937
        # detail is not relocated, add the id.
 
1938
        searched_specific_files = set()
 
1939
        NULL_PARENT_DETAILS = dirstate.DirState.NULL_PARENT_DETAILS
 
1940
        # Using a list so that we can access the values and change them in
 
1941
        # nested scope. Each one is [path, file_id, entry]
 
1942
        last_source_parent = [None, None]
 
1943
        last_target_parent = [None, None]
2088
1944
 
2089
1945
        use_filesystem_for_exec = (sys.platform != 'win32')
2090
 
        iter_changes = self.target._iter_changes(include_unchanged,
2091
 
            use_filesystem_for_exec, search_specific_files, state,
2092
 
            source_index, target_index, want_unversioned, self.target)
2093
 
        return iter_changes.iter_changes()
 
1946
 
 
1947
        # Just a sentry, so that _process_entry can say that this
 
1948
        # record is handled, but isn't interesting to process (unchanged)
 
1949
        uninteresting = object()
 
1950
 
 
1951
 
 
1952
        old_dirname_to_file_id = {}
 
1953
        new_dirname_to_file_id = {}
 
1954
        # TODO: jam 20070516 - Avoid the _get_entry lookup overhead by
 
1955
        #       keeping a cache of directories that we have seen.
 
1956
 
 
1957
        def _process_entry(entry, path_info):
 
1958
            """Compare an entry and real disk to generate delta information.
 
1959
 
 
1960
            :param path_info: top_relpath, basename, kind, lstat, abspath for
 
1961
                the path of entry. If None, then the path is considered absent.
 
1962
                (Perhaps we should pass in a concrete entry for this ?)
 
1963
                Basename is returned as a utf8 string because we expect this
 
1964
                tuple will be ignored, and don't want to take the time to
 
1965
                decode.
 
1966
            :return: None if these don't match
 
1967
                     A tuple of information about the change, or
 
1968
                     the object 'uninteresting' if these match, but are
 
1969
                     basically identical.
 
1970
            """
 
1971
            if source_index is None:
 
1972
                source_details = NULL_PARENT_DETAILS
 
1973
            else:
 
1974
                source_details = entry[1][source_index]
 
1975
            target_details = entry[1][target_index]
 
1976
            target_minikind = target_details[0]
 
1977
            if path_info is not None and target_minikind in 'fdlt':
 
1978
                if not (target_index == 0):
 
1979
                    raise AssertionError()
 
1980
                link_or_sha1 = state.update_entry(entry, abspath=path_info[4],
 
1981
                                                  stat_value=path_info[3])
 
1982
                # The entry may have been modified by update_entry
 
1983
                target_details = entry[1][target_index]
 
1984
                target_minikind = target_details[0]
 
1985
            else:
 
1986
                link_or_sha1 = None
 
1987
            file_id = entry[0][2]
 
1988
            source_minikind = source_details[0]
 
1989
            if source_minikind in 'fdltr' and target_minikind in 'fdlt':
 
1990
                # claimed content in both: diff
 
1991
                #   r    | fdlt   |      | add source to search, add id path move and perform
 
1992
                #        |        |      | diff check on source-target
 
1993
                #   r    | fdlt   |  a   | dangling file that was present in the basis.
 
1994
                #        |        |      | ???
 
1995
                if source_minikind in 'r':
 
1996
                    # add the source to the search path to find any children it
 
1997
                    # has.  TODO ? : only add if it is a container ?
 
1998
                    if not osutils.is_inside_any(searched_specific_files,
 
1999
                                                 source_details[1]):
 
2000
                        search_specific_files.add(source_details[1])
 
2001
                    # generate the old path; this is needed for stating later
 
2002
                    # as well.
 
2003
                    old_path = source_details[1]
 
2004
                    old_dirname, old_basename = os.path.split(old_path)
 
2005
                    path = pathjoin(entry[0][0], entry[0][1])
 
2006
                    old_entry = state._get_entry(source_index,
 
2007
                                                 path_utf8=old_path)
 
2008
                    # update the source details variable to be the real
 
2009
                    # location.
 
2010
                    if old_entry == (None, None):
 
2011
                        raise errors.CorruptDirstate(state._filename,
 
2012
                            "entry '%s/%s' is considered renamed from %r"
 
2013
                            " but source does not exist\n"
 
2014
                            "entry: %s" % (entry[0][0], entry[0][1], old_path, entry))
 
2015
                    source_details = old_entry[1][source_index]
 
2016
                    source_minikind = source_details[0]
 
2017
                else:
 
2018
                    old_dirname = entry[0][0]
 
2019
                    old_basename = entry[0][1]
 
2020
                    old_path = path = None
 
2021
                if path_info is None:
 
2022
                    # the file is missing on disk, show as removed.
 
2023
                    content_change = True
 
2024
                    target_kind = None
 
2025
                    target_exec = False
 
2026
                else:
 
2027
                    # source and target are both versioned and disk file is present.
 
2028
                    target_kind = path_info[2]
 
2029
                    if target_kind == 'directory':
 
2030
                        if path is None:
 
2031
                            old_path = path = pathjoin(old_dirname, old_basename)
 
2032
                        new_dirname_to_file_id[path] = file_id
 
2033
                        if source_minikind != 'd':
 
2034
                            content_change = True
 
2035
                        else:
 
2036
                            # directories have no fingerprint
 
2037
                            content_change = False
 
2038
                        target_exec = False
 
2039
                    elif target_kind == 'file':
 
2040
                        if source_minikind != 'f':
 
2041
                            content_change = True
 
2042
                        else:
 
2043
                            # We could check the size, but we already have the
 
2044
                            # sha1 hash.
 
2045
                            content_change = (link_or_sha1 != source_details[1])
 
2046
                        # Target details is updated at update_entry time
 
2047
                        if use_filesystem_for_exec:
 
2048
                            # We don't need S_ISREG here, because we are sure
 
2049
                            # we are dealing with a file.
 
2050
                            target_exec = bool(stat.S_IEXEC & path_info[3].st_mode)
 
2051
                        else:
 
2052
                            target_exec = target_details[3]
 
2053
                    elif target_kind == 'symlink':
 
2054
                        if source_minikind != 'l':
 
2055
                            content_change = True
 
2056
                        else:
 
2057
                            content_change = (link_or_sha1 != source_details[1])
 
2058
                        target_exec = False
 
2059
                    elif target_kind == 'tree-reference':
 
2060
                        if source_minikind != 't':
 
2061
                            content_change = True
 
2062
                        else:
 
2063
                            content_change = False
 
2064
                        target_exec = False
 
2065
                    else:
 
2066
                        raise Exception, "unknown kind %s" % path_info[2]
 
2067
                if source_minikind == 'd':
 
2068
                    if path is None:
 
2069
                        old_path = path = pathjoin(old_dirname, old_basename)
 
2070
                    old_dirname_to_file_id[old_path] = file_id
 
2071
                # parent id is the entry for the path in the target tree
 
2072
                if old_dirname == last_source_parent[0]:
 
2073
                    source_parent_id = last_source_parent[1]
 
2074
                else:
 
2075
                    try:
 
2076
                        source_parent_id = old_dirname_to_file_id[old_dirname]
 
2077
                    except KeyError:
 
2078
                        source_parent_entry = state._get_entry(source_index,
 
2079
                                                               path_utf8=old_dirname)
 
2080
                        source_parent_id = source_parent_entry[0][2]
 
2081
                    if source_parent_id == entry[0][2]:
 
2082
                        # This is the root, so the parent is None
 
2083
                        source_parent_id = None
 
2084
                    else:
 
2085
                        last_source_parent[0] = old_dirname
 
2086
                        last_source_parent[1] = source_parent_id
 
2087
                new_dirname = entry[0][0]
 
2088
                if new_dirname == last_target_parent[0]:
 
2089
                    target_parent_id = last_target_parent[1]
 
2090
                else:
 
2091
                    try:
 
2092
                        target_parent_id = new_dirname_to_file_id[new_dirname]
 
2093
                    except KeyError:
 
2094
                        # TODO: We don't always need to do the lookup, because the
 
2095
                        #       parent entry will be the same as the source entry.
 
2096
                        target_parent_entry = state._get_entry(target_index,
 
2097
                                                               path_utf8=new_dirname)
 
2098
                        if target_parent_entry == (None, None):
 
2099
                            raise AssertionError(
 
2100
                                "Could not find target parent in wt: %s\nparent of: %s"
 
2101
                                % (new_dirname, entry))
 
2102
                        target_parent_id = target_parent_entry[0][2]
 
2103
                    if target_parent_id == entry[0][2]:
 
2104
                        # This is the root, so the parent is None
 
2105
                        target_parent_id = None
 
2106
                    else:
 
2107
                        last_target_parent[0] = new_dirname
 
2108
                        last_target_parent[1] = target_parent_id
 
2109
 
 
2110
                source_exec = source_details[3]
 
2111
                if (include_unchanged
 
2112
                    or content_change
 
2113
                    or source_parent_id != target_parent_id
 
2114
                    or old_basename != entry[0][1]
 
2115
                    or source_exec != target_exec
 
2116
                    ):
 
2117
                    if old_path is None:
 
2118
                        old_path = path = pathjoin(old_dirname, old_basename)
 
2119
                        old_path_u = utf8_decode(old_path)[0]
 
2120
                        path_u = old_path_u
 
2121
                    else:
 
2122
                        old_path_u = utf8_decode(old_path)[0]
 
2123
                        if old_path == path:
 
2124
                            path_u = old_path_u
 
2125
                        else:
 
2126
                            path_u = utf8_decode(path)[0]
 
2127
                    source_kind = _minikind_to_kind[source_minikind]
 
2128
                    return (entry[0][2],
 
2129
                           (old_path_u, path_u),
 
2130
                           content_change,
 
2131
                           (True, True),
 
2132
                           (source_parent_id, target_parent_id),
 
2133
                           (utf8_decode(old_basename)[0], utf8_decode(entry[0][1])[0]),
 
2134
                           (source_kind, target_kind),
 
2135
                           (source_exec, target_exec))
 
2136
                else:
 
2137
                    return uninteresting
 
2138
            elif source_minikind in 'a' and target_minikind in 'fdlt':
 
2139
                # looks like a new file
 
2140
                if path_info is not None:
 
2141
                    path = pathjoin(entry[0][0], entry[0][1])
 
2142
                    # parent id is the entry for the path in the target tree
 
2143
                    # TODO: these are the same for an entire directory: cache em.
 
2144
                    parent_id = state._get_entry(target_index,
 
2145
                                                 path_utf8=entry[0][0])[0][2]
 
2146
                    if parent_id == entry[0][2]:
 
2147
                        parent_id = None
 
2148
                    if use_filesystem_for_exec:
 
2149
                        # We need S_ISREG here, because we aren't sure if this
 
2150
                        # is a file or not.
 
2151
                        target_exec = bool(
 
2152
                            stat.S_ISREG(path_info[3].st_mode)
 
2153
                            and stat.S_IEXEC & path_info[3].st_mode)
 
2154
                    else:
 
2155
                        target_exec = target_details[3]
 
2156
                    return (entry[0][2],
 
2157
                           (None, utf8_decode(path)[0]),
 
2158
                           True,
 
2159
                           (False, True),
 
2160
                           (None, parent_id),
 
2161
                           (None, utf8_decode(entry[0][1])[0]),
 
2162
                           (None, path_info[2]),
 
2163
                           (None, target_exec))
 
2164
                else:
 
2165
                    # but its not on disk: we deliberately treat this as just
 
2166
                    # never-present. (Why ?! - RBC 20070224)
 
2167
                    pass
 
2168
            elif source_minikind in 'fdlt' and target_minikind in 'a':
 
2169
                # unversioned, possibly, or possibly not deleted: we dont care.
 
2170
                # if its still on disk, *and* theres no other entry at this
 
2171
                # path [we dont know this in this routine at the moment -
 
2172
                # perhaps we should change this - then it would be an unknown.
 
2173
                old_path = pathjoin(entry[0][0], entry[0][1])
 
2174
                # parent id is the entry for the path in the target tree
 
2175
                parent_id = state._get_entry(source_index, path_utf8=entry[0][0])[0][2]
 
2176
                if parent_id == entry[0][2]:
 
2177
                    parent_id = None
 
2178
                return (entry[0][2],
 
2179
                       (utf8_decode(old_path)[0], None),
 
2180
                       True,
 
2181
                       (True, False),
 
2182
                       (parent_id, None),
 
2183
                       (utf8_decode(entry[0][1])[0], None),
 
2184
                       (_minikind_to_kind[source_minikind], None),
 
2185
                       (source_details[3], None))
 
2186
            elif source_minikind in 'fdlt' and target_minikind in 'r':
 
2187
                # a rename; could be a true rename, or a rename inherited from
 
2188
                # a renamed parent. TODO: handle this efficiently. Its not
 
2189
                # common case to rename dirs though, so a correct but slow
 
2190
                # implementation will do.
 
2191
                if not osutils.is_inside_any(searched_specific_files, target_details[1]):
 
2192
                    search_specific_files.add(target_details[1])
 
2193
            elif source_minikind in 'ra' and target_minikind in 'ra':
 
2194
                # neither of the selected trees contain this file,
 
2195
                # so skip over it. This is not currently directly tested, but
 
2196
                # is indirectly via test_too_much.TestCommands.test_conflicts.
 
2197
                pass
 
2198
            else:
 
2199
                raise AssertionError("don't know how to compare "
 
2200
                    "source_minikind=%r, target_minikind=%r"
 
2201
                    % (source_minikind, target_minikind))
 
2202
                ## import pdb;pdb.set_trace()
 
2203
            return None
 
2204
 
 
2205
        while search_specific_files:
 
2206
            # TODO: the pending list should be lexically sorted?  the
 
2207
            # interface doesn't require it.
 
2208
            current_root = search_specific_files.pop()
 
2209
            current_root_unicode = current_root.decode('utf8')
 
2210
            searched_specific_files.add(current_root)
 
2211
            # process the entries for this containing directory: the rest will be
 
2212
            # found by their parents recursively.
 
2213
            root_entries = _entries_for_path(current_root)
 
2214
            root_abspath = self.target.abspath(current_root_unicode)
 
2215
            try:
 
2216
                root_stat = os.lstat(root_abspath)
 
2217
            except OSError, e:
 
2218
                if e.errno == errno.ENOENT:
 
2219
                    # the path does not exist: let _process_entry know that.
 
2220
                    root_dir_info = None
 
2221
                else:
 
2222
                    # some other random error: hand it up.
 
2223
                    raise
 
2224
            else:
 
2225
                root_dir_info = ('', current_root,
 
2226
                    osutils.file_kind_from_stat_mode(root_stat.st_mode), root_stat,
 
2227
                    root_abspath)
 
2228
                if root_dir_info[2] == 'directory':
 
2229
                    if self.target._directory_is_tree_reference(
 
2230
                        current_root.decode('utf8')):
 
2231
                        root_dir_info = root_dir_info[:2] + \
 
2232
                            ('tree-reference',) + root_dir_info[3:]
 
2233
 
 
2234
            if not root_entries and not root_dir_info:
 
2235
                # this specified path is not present at all, skip it.
 
2236
                continue
 
2237
            path_handled = False
 
2238
            for entry in root_entries:
 
2239
                result = _process_entry(entry, root_dir_info)
 
2240
                if result is not None:
 
2241
                    path_handled = True
 
2242
                    if result is not uninteresting:
 
2243
                        yield result
 
2244
            if want_unversioned and not path_handled and root_dir_info:
 
2245
                new_executable = bool(
 
2246
                    stat.S_ISREG(root_dir_info[3].st_mode)
 
2247
                    and stat.S_IEXEC & root_dir_info[3].st_mode)
 
2248
                yield (None,
 
2249
                       (None, current_root_unicode),
 
2250
                       True,
 
2251
                       (False, False),
 
2252
                       (None, None),
 
2253
                       (None, splitpath(current_root_unicode)[-1]),
 
2254
                       (None, root_dir_info[2]),
 
2255
                       (None, new_executable)
 
2256
                      )
 
2257
            initial_key = (current_root, '', '')
 
2258
            block_index, _ = state._find_block_index_from_key(initial_key)
 
2259
            if block_index == 0:
 
2260
                # we have processed the total root already, but because the
 
2261
                # initial key matched it we should skip it here.
 
2262
                block_index +=1
 
2263
            if root_dir_info and root_dir_info[2] == 'tree-reference':
 
2264
                current_dir_info = None
 
2265
            else:
 
2266
                dir_iterator = osutils._walkdirs_utf8(root_abspath, prefix=current_root)
 
2267
                try:
 
2268
                    current_dir_info = dir_iterator.next()
 
2269
                except OSError, e:
 
2270
                    # on win32, python2.4 has e.errno == ERROR_DIRECTORY, but
 
2271
                    # python 2.5 has e.errno == EINVAL,
 
2272
                    #            and e.winerror == ERROR_DIRECTORY
 
2273
                    e_winerror = getattr(e, 'winerror', None)
 
2274
                    win_errors = (ERROR_DIRECTORY, ERROR_PATH_NOT_FOUND)
 
2275
                    # there may be directories in the inventory even though
 
2276
                    # this path is not a file on disk: so mark it as end of
 
2277
                    # iterator
 
2278
                    if e.errno in (errno.ENOENT, errno.ENOTDIR, errno.EINVAL):
 
2279
                        current_dir_info = None
 
2280
                    elif (sys.platform == 'win32'
 
2281
                          and (e.errno in win_errors
 
2282
                               or e_winerror in win_errors)):
 
2283
                        current_dir_info = None
 
2284
                    else:
 
2285
                        raise
 
2286
                else:
 
2287
                    if current_dir_info[0][0] == '':
 
2288
                        # remove .bzr from iteration
 
2289
                        bzr_index = bisect_left(current_dir_info[1], ('.bzr',))
 
2290
                        if current_dir_info[1][bzr_index][0] != '.bzr':
 
2291
                            raise AssertionError()
 
2292
                        del current_dir_info[1][bzr_index]
 
2293
            # walk until both the directory listing and the versioned metadata
 
2294
            # are exhausted. 
 
2295
            if (block_index < len(state._dirblocks) and
 
2296
                osutils.is_inside(current_root, state._dirblocks[block_index][0])):
 
2297
                current_block = state._dirblocks[block_index]
 
2298
            else:
 
2299
                current_block = None
 
2300
            while (current_dir_info is not None or
 
2301
                   current_block is not None):
 
2302
                if (current_dir_info and current_block
 
2303
                    and current_dir_info[0][0] != current_block[0]):
 
2304
                    if cmp_by_dirs(current_dir_info[0][0], current_block[0]) < 0:
 
2305
                        # filesystem data refers to paths not covered by the dirblock.
 
2306
                        # this has two possibilities:
 
2307
                        # A) it is versioned but empty, so there is no block for it
 
2308
                        # B) it is not versioned.
 
2309
 
 
2310
                        # if (A) then we need to recurse into it to check for
 
2311
                        # new unknown files or directories.
 
2312
                        # if (B) then we should ignore it, because we don't
 
2313
                        # recurse into unknown directories.
 
2314
                        path_index = 0
 
2315
                        while path_index < len(current_dir_info[1]):
 
2316
                                current_path_info = current_dir_info[1][path_index]
 
2317
                                if want_unversioned:
 
2318
                                    if current_path_info[2] == 'directory':
 
2319
                                        if self.target._directory_is_tree_reference(
 
2320
                                            current_path_info[0].decode('utf8')):
 
2321
                                            current_path_info = current_path_info[:2] + \
 
2322
                                                ('tree-reference',) + current_path_info[3:]
 
2323
                                    new_executable = bool(
 
2324
                                        stat.S_ISREG(current_path_info[3].st_mode)
 
2325
                                        and stat.S_IEXEC & current_path_info[3].st_mode)
 
2326
                                    yield (None,
 
2327
                                        (None, utf8_decode(current_path_info[0])[0]),
 
2328
                                        True,
 
2329
                                        (False, False),
 
2330
                                        (None, None),
 
2331
                                        (None, utf8_decode(current_path_info[1])[0]),
 
2332
                                        (None, current_path_info[2]),
 
2333
                                        (None, new_executable))
 
2334
                                # dont descend into this unversioned path if it is
 
2335
                                # a dir
 
2336
                                if current_path_info[2] in ('directory',
 
2337
                                                            'tree-reference'):
 
2338
                                    del current_dir_info[1][path_index]
 
2339
                                    path_index -= 1
 
2340
                                path_index += 1
 
2341
 
 
2342
                        # This dir info has been handled, go to the next
 
2343
                        try:
 
2344
                            current_dir_info = dir_iterator.next()
 
2345
                        except StopIteration:
 
2346
                            current_dir_info = None
 
2347
                    else:
 
2348
                        # We have a dirblock entry for this location, but there
 
2349
                        # is no filesystem path for this. This is most likely
 
2350
                        # because a directory was removed from the disk.
 
2351
                        # We don't have to report the missing directory,
 
2352
                        # because that should have already been handled, but we
 
2353
                        # need to handle all of the files that are contained
 
2354
                        # within.
 
2355
                        for current_entry in current_block[1]:
 
2356
                            # entry referring to file not present on disk.
 
2357
                            # advance the entry only, after processing.
 
2358
                            result = _process_entry(current_entry, None)
 
2359
                            if result is not None:
 
2360
                                if result is not uninteresting:
 
2361
                                    yield result
 
2362
                        block_index +=1
 
2363
                        if (block_index < len(state._dirblocks) and
 
2364
                            osutils.is_inside(current_root,
 
2365
                                              state._dirblocks[block_index][0])):
 
2366
                            current_block = state._dirblocks[block_index]
 
2367
                        else:
 
2368
                            current_block = None
 
2369
                    continue
 
2370
                entry_index = 0
 
2371
                if current_block and entry_index < len(current_block[1]):
 
2372
                    current_entry = current_block[1][entry_index]
 
2373
                else:
 
2374
                    current_entry = None
 
2375
                advance_entry = True
 
2376
                path_index = 0
 
2377
                if current_dir_info and path_index < len(current_dir_info[1]):
 
2378
                    current_path_info = current_dir_info[1][path_index]
 
2379
                    if current_path_info[2] == 'directory':
 
2380
                        if self.target._directory_is_tree_reference(
 
2381
                            current_path_info[0].decode('utf8')):
 
2382
                            current_path_info = current_path_info[:2] + \
 
2383
                                ('tree-reference',) + current_path_info[3:]
 
2384
                else:
 
2385
                    current_path_info = None
 
2386
                advance_path = True
 
2387
                path_handled = False
 
2388
                while (current_entry is not None or
 
2389
                    current_path_info is not None):
 
2390
                    if current_entry is None:
 
2391
                        # the check for path_handled when the path is adnvaced
 
2392
                        # will yield this path if needed.
 
2393
                        pass
 
2394
                    elif current_path_info is None:
 
2395
                        # no path is fine: the per entry code will handle it.
 
2396
                        result = _process_entry(current_entry, current_path_info)
 
2397
                        if result is not None:
 
2398
                            if result is not uninteresting:
 
2399
                                yield result
 
2400
                    elif (current_entry[0][1] != current_path_info[1]
 
2401
                          or current_entry[1][target_index][0] in 'ar'):
 
2402
                        # The current path on disk doesn't match the dirblock
 
2403
                        # record. Either the dirblock is marked as absent, or
 
2404
                        # the file on disk is not present at all in the
 
2405
                        # dirblock. Either way, report about the dirblock
 
2406
                        # entry, and let other code handle the filesystem one.
 
2407
 
 
2408
                        # Compare the basename for these files to determine
 
2409
                        # which comes first
 
2410
                        if current_path_info[1] < current_entry[0][1]:
 
2411
                            # extra file on disk: pass for now, but only
 
2412
                            # increment the path, not the entry
 
2413
                            advance_entry = False
 
2414
                        else:
 
2415
                            # entry referring to file not present on disk.
 
2416
                            # advance the entry only, after processing.
 
2417
                            result = _process_entry(current_entry, None)
 
2418
                            if result is not None:
 
2419
                                if result is not uninteresting:
 
2420
                                    yield result
 
2421
                            advance_path = False
 
2422
                    else:
 
2423
                        result = _process_entry(current_entry, current_path_info)
 
2424
                        if result is not None:
 
2425
                            path_handled = True
 
2426
                            if result is not uninteresting:
 
2427
                                yield result
 
2428
                    if advance_entry and current_entry is not None:
 
2429
                        entry_index += 1
 
2430
                        if entry_index < len(current_block[1]):
 
2431
                            current_entry = current_block[1][entry_index]
 
2432
                        else:
 
2433
                            current_entry = None
 
2434
                    else:
 
2435
                        advance_entry = True # reset the advance flaga
 
2436
                    if advance_path and current_path_info is not None:
 
2437
                        if not path_handled:
 
2438
                            # unversioned in all regards
 
2439
                            if want_unversioned:
 
2440
                                new_executable = bool(
 
2441
                                    stat.S_ISREG(current_path_info[3].st_mode)
 
2442
                                    and stat.S_IEXEC & current_path_info[3].st_mode)
 
2443
                                yield (None,
 
2444
                                    (None, utf8_decode(current_path_info[0])[0]),
 
2445
                                    True,
 
2446
                                    (False, False),
 
2447
                                    (None, None),
 
2448
                                    (None, utf8_decode(current_path_info[1])[0]),
 
2449
                                    (None, current_path_info[2]),
 
2450
                                    (None, new_executable))
 
2451
                            # dont descend into this unversioned path if it is
 
2452
                            # a dir
 
2453
                            if current_path_info[2] in ('directory'):
 
2454
                                del current_dir_info[1][path_index]
 
2455
                                path_index -= 1
 
2456
                        # dont descend the disk iterator into any tree 
 
2457
                        # paths.
 
2458
                        if current_path_info[2] == 'tree-reference':
 
2459
                            del current_dir_info[1][path_index]
 
2460
                            path_index -= 1
 
2461
                        path_index += 1
 
2462
                        if path_index < len(current_dir_info[1]):
 
2463
                            current_path_info = current_dir_info[1][path_index]
 
2464
                            if current_path_info[2] == 'directory':
 
2465
                                if self.target._directory_is_tree_reference(
 
2466
                                    current_path_info[0].decode('utf8')):
 
2467
                                    current_path_info = current_path_info[:2] + \
 
2468
                                        ('tree-reference',) + current_path_info[3:]
 
2469
                        else:
 
2470
                            current_path_info = None
 
2471
                        path_handled = False
 
2472
                    else:
 
2473
                        advance_path = True # reset the advance flagg.
 
2474
                if current_block is not None:
 
2475
                    block_index += 1
 
2476
                    if (block_index < len(state._dirblocks) and
 
2477
                        osutils.is_inside(current_root, state._dirblocks[block_index][0])):
 
2478
                        current_block = state._dirblocks[block_index]
 
2479
                    else:
 
2480
                        current_block = None
 
2481
                if current_dir_info is not None:
 
2482
                    try:
 
2483
                        current_dir_info = dir_iterator.next()
 
2484
                    except StopIteration:
 
2485
                        current_dir_info = None
 
2486
 
2094
2487
 
2095
2488
    @staticmethod
2096
2489
    def is_compatible(source, target):
2097
2490
        # the target must be a dirstate working tree
2098
 
        if not isinstance(target, DirStateWorkingTree):
 
2491
        if not isinstance(target, WorkingTree4):
2099
2492
            return False
2100
 
        # the source must be a revtree or dirstate rev tree.
 
2493
        # the source must be a revtreee or dirstate rev tree.
2101
2494
        if not isinstance(source,
2102
2495
            (revisiontree.RevisionTree, DirStateRevisionTree)):
2103
2496
            return False
2104
2497
        # the source revid must be in the target dirstate
2105
 
        if not (source._revision_id == _mod_revision.NULL_REVISION or
 
2498
        if not (source._revision_id == NULL_REVISION or
2106
2499
            source._revision_id in target.get_parent_ids()):
2107
 
            # TODO: what about ghosts? it may well need to
 
2500
            # TODO: what about ghosts? it may well need to 
2108
2501
            # check for them explicitly.
2109
2502
            return False
2110
2503
        return True
2120
2513
 
2121
2514
    def convert(self, tree):
2122
2515
        # lock the control files not the tree, so that we dont get tree
2123
 
        # on-unlock behaviours, and so that noone else diddles with the
 
2516
        # on-unlock behaviours, and so that noone else diddles with the 
2124
2517
        # tree during upgrade.
2125
2518
        tree._control_files.lock_write()
2126
2519
        try:
2155
2548
        tree._transport.put_bytes('format',
2156
2549
            self.target_format.get_format_string(),
2157
2550
            mode=tree.bzrdir._get_file_mode())
2158
 
 
2159
 
 
2160
 
class Converter4to5(object):
2161
 
    """Perform an in-place upgrade of format 4 to format 5 trees."""
2162
 
 
2163
 
    def __init__(self):
2164
 
        self.target_format = WorkingTreeFormat5()
2165
 
 
2166
 
    def convert(self, tree):
2167
 
        # lock the control files not the tree, so that we don't get tree
2168
 
        # on-unlock behaviours, and so that no-one else diddles with the
2169
 
        # tree during upgrade.
2170
 
        tree._control_files.lock_write()
2171
 
        try:
2172
 
            self.update_format(tree)
2173
 
        finally:
2174
 
            tree._control_files.unlock()
2175
 
 
2176
 
    def update_format(self, tree):
2177
 
        """Change the format marker."""
2178
 
        tree._transport.put_bytes('format',
2179
 
            self.target_format.get_format_string(),
2180
 
            mode=tree.bzrdir._get_file_mode())
2181
 
 
2182
 
 
2183
 
class Converter4or5to6(object):
2184
 
    """Perform an in-place upgrade of format 4 or 5 to format 6 trees."""
2185
 
 
2186
 
    def __init__(self):
2187
 
        self.target_format = WorkingTreeFormat6()
2188
 
 
2189
 
    def convert(self, tree):
2190
 
        # lock the control files not the tree, so that we don't get tree
2191
 
        # on-unlock behaviours, and so that no-one else diddles with the
2192
 
        # tree during upgrade.
2193
 
        tree._control_files.lock_write()
2194
 
        try:
2195
 
            self.init_custom_control_files(tree)
2196
 
            self.update_format(tree)
2197
 
        finally:
2198
 
            tree._control_files.unlock()
2199
 
 
2200
 
    def init_custom_control_files(self, tree):
2201
 
        """Initialize custom control files."""
2202
 
        tree._transport.put_bytes('views', '',
2203
 
            mode=tree.bzrdir._get_file_mode())
2204
 
 
2205
 
    def update_format(self, tree):
2206
 
        """Change the format marker."""
2207
 
        tree._transport.put_bytes('format',
2208
 
            self.target_format.get_format_string(),
2209
 
            mode=tree.bzrdir._get_file_mode())