~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree_4.py

  • Committer: Martin Pool
  • Date: 2009-03-24 05:21:02 UTC
  • mfrom: (4192 +trunk)
  • mto: This revision was merged to the branch mainline in revision 4202.
  • Revision ID: mbp@sourcefrog.net-20090324052102-8kk087b32tep3d9h
merge trunk

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008 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
58
58
    trace,
59
59
    transform,
60
60
    urlutils,
 
61
    views,
61
62
    xml5,
62
63
    xml6,
63
64
    )
68
69
 
69
70
from bzrlib import symbol_versioning
70
71
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
72
from bzrlib.filters import filtered_input_file, internal_size_sha_file_byname
71
73
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
74
import bzrlib.mutabletree
75
75
from bzrlib.mutabletree import needs_tree_write_lock
76
76
from bzrlib.osutils import (
98
98
from bzrlib.workingtree import WorkingTree, WorkingTree3, WorkingTreeFormat3
99
99
 
100
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
 
    """
119
 
 
 
101
class DirStateWorkingTree(WorkingTree3):
120
102
    def __init__(self, basedir,
121
103
                 branch,
122
104
                 _control_files=None,
148
130
        #-------------
149
131
        self._setup_directory_is_tree_reference()
150
132
        self._detect_case_handling()
 
133
        self._rules_searcher = None
 
134
        self.views = self._make_views()
 
135
        #--- allow tests to select the dirstate iter_changes implementation
 
136
        self._iter_changes = dirstate._process_entry
151
137
 
152
138
    @needs_tree_write_lock
153
139
    def _add(self, files, ids, kinds):
181
167
    @needs_tree_write_lock
182
168
    def add_reference(self, sub_tree):
183
169
        # use standard implementation, which calls back to self._add
184
 
        # 
 
170
        #
185
171
        # So we don't store the reference_revision in the working dirstate,
186
 
        # it's just recorded at the moment of commit. 
 
172
        # it's just recorded at the moment of commit.
187
173
        self._add_reference(sub_tree)
188
174
 
189
175
    def break_lock(self):
228
214
            WorkingTree3._comparison_data(self, entry, path)
229
215
        # it looks like a plain directory, but it's really a reference -- see
230
216
        # also kind()
231
 
        if (self._repo_supports_tree_reference and
232
 
            kind == 'directory' and
233
 
            self._directory_is_tree_reference(path)):
 
217
        if (self._repo_supports_tree_reference and kind == 'directory'
 
218
            and entry is not None and entry.kind == 'tree-reference'):
234
219
            kind = 'tree-reference'
235
220
        return kind, executable, stat_value
236
221
 
262
247
            return self._dirstate
263
248
        local_path = self.bzrdir.get_workingtree_transport(None
264
249
            ).local_abspath('dirstate')
265
 
        self._dirstate = dirstate.DirState.on_file(local_path)
 
250
        self._dirstate = dirstate.DirState.on_file(local_path,
 
251
            self._sha1_provider())
266
252
        return self._dirstate
267
253
 
 
254
    def _sha1_provider(self):
 
255
        """A function that returns a SHA1Provider suitable for this tree.
 
256
 
 
257
        :return: None if content filtering is not supported by this tree.
 
258
          Otherwise, a SHA1Provider is returned that sha's the canonical
 
259
          form of files, i.e. after read filters are applied.
 
260
        """
 
261
        if self.supports_content_filtering():
 
262
            return ContentFilterAwareSHA1Provider(self)
 
263
        else:
 
264
            return None
 
265
 
268
266
    def filter_unversioned_files(self, paths):
269
267
        """Filter out paths that are versioned.
270
268
 
302
300
 
303
301
    def _generate_inventory(self):
304
302
        """Create and set self.inventory from the dirstate object.
305
 
        
 
303
 
306
304
        This is relatively expensive: we have to walk the entire dirstate.
307
305
        Ideally we would not, and can deprecate this function.
308
306
        """
378
376
        If either file_id or path is supplied, it is used as the key to lookup.
379
377
        If both are supplied, the fastest lookup is used, and an error is
380
378
        raised if they do not both point at the same row.
381
 
        
 
379
 
382
380
        :param file_id: An optional unicode file_id to be looked up.
383
381
        :param path: An optional unicode path to be looked up.
384
382
        :return: The dirstate row tuple for path/file_id, or (None, None)
408
406
                    return None
409
407
                else:
410
408
                    raise
411
 
        link_or_sha1 = state.update_entry(entry, file_abspath,
412
 
                                          stat_value=stat_value)
 
409
        link_or_sha1 = dirstate.update_entry(state, entry, file_abspath,
 
410
            stat_value=stat_value)
413
411
        if entry[1][0][0] == 'f':
414
 
            return link_or_sha1
 
412
            if link_or_sha1 is None:
 
413
                file_obj, statvalue = self.get_file_with_stat(file_id, path)
 
414
                try:
 
415
                    sha1 = osutils.sha_file(file_obj)
 
416
                finally:
 
417
                    file_obj.close()
 
418
                self._observed_sha1(file_id, path, (sha1, statvalue))
 
419
                return sha1
 
420
            else:
 
421
                return link_or_sha1
415
422
        return None
416
423
 
417
424
    def _get_inventory(self):
431
438
    @needs_read_lock
432
439
    def get_parent_ids(self):
433
440
        """See Tree.get_parent_ids.
434
 
        
 
441
 
435
442
        This implementation requests the ids list from the dirstate file.
436
443
        """
437
444
        return self.current_dirstate().get_parent_ids()
528
535
        return iter(result)
529
536
 
530
537
    def iter_references(self):
 
538
        if not self._repo_supports_tree_reference:
 
539
            # When the repo doesn't support references, we will have nothing to
 
540
            # return
 
541
            return
531
542
        for key, tree_details in self.current_dirstate()._iter_entries():
532
543
            if tree_details[0][0] in ('a', 'r'): # absent, relocated
533
544
                # not relevant to the working tree
535
546
            if not key[1]:
536
547
                # the root is not a reference.
537
548
                continue
538
 
            path = pathjoin(self.basedir, key[0].decode('utf8'), key[1].decode('utf8'))
 
549
            relpath = pathjoin(key[0].decode('utf8'), key[1].decode('utf8'))
539
550
            try:
540
 
                if self._kind(path) == 'tree-reference':
541
 
                    yield path, key[2]
 
551
                if self._kind(relpath) == 'tree-reference':
 
552
                    yield relpath, key[2]
542
553
            except errors.NoSuchFile:
543
554
                # path is missing on disk.
544
555
                continue
545
556
 
 
557
    def _observed_sha1(self, file_id, path, (sha1, statvalue)):
 
558
        """See MutableTree._observed_sha1."""
 
559
        state = self.current_dirstate()
 
560
        entry = self._get_entry(file_id=file_id, path=path)
 
561
        state._observed_sha1(entry, sha1, statvalue)
 
562
 
546
563
    def kind(self, file_id):
547
564
        """Return the kind of a file.
548
565
 
560
577
    def _kind(self, relpath):
561
578
        abspath = self.abspath(relpath)
562
579
        kind = file_kind(abspath)
563
 
        if (self._repo_supports_tree_reference and
564
 
            kind == 'directory' and
565
 
            self._directory_is_tree_reference(relpath)):
566
 
            kind = 'tree-reference'
 
580
        if (self._repo_supports_tree_reference and kind == 'directory'):
 
581
            entry = self._get_entry(path=relpath)
 
582
            if entry[1] is not None:
 
583
                if entry[1][0][0] == 't':
 
584
                    kind = 'tree-reference'
567
585
        return kind
568
586
 
569
587
    @needs_read_lock
881
899
        for tree in trees:
882
900
            if not (isinstance(tree, DirStateRevisionTree) and tree._revision_id in
883
901
                parents):
884
 
                return super(WorkingTree4, self).paths2ids(paths, trees, require_versioned)
 
902
                return super(DirStateWorkingTree, self).paths2ids(paths,
 
903
                    trees, require_versioned)
885
904
        search_indexes = [0] + [1 + parents.index(tree._revision_id) for tree in trees]
886
905
        # -- make all paths utf8 --
887
906
        paths_utf8 = set()
948
967
                raise errors.PathsNotVersionedError(paths)
949
968
        # -- remove redundancy in supplied paths to prevent over-scanning --
950
969
        search_paths = osutils.minimum_path_selection(paths)
951
 
        # sketch: 
 
970
        # sketch:
952
971
        # for all search_indexs in each path at or under each element of
953
972
        # search_paths, if the detail is relocated: add the id, and add the
954
973
        # relocated path as one to search if its not searched already. If the
1010
1029
 
1011
1030
    def read_working_inventory(self):
1012
1031
        """Read the working inventory.
1013
 
        
 
1032
 
1014
1033
        This is a meaningless operation for dirstate, but we obey it anyhow.
1015
1034
        """
1016
1035
        return self.inventory
1047
1066
    @needs_tree_write_lock
1048
1067
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
1049
1068
        """Set the parent ids to revision_ids.
1050
 
        
 
1069
 
1051
1070
        See also set_parent_trees. This api will try to retrieve the tree data
1052
1071
        for each element of revision_ids from the trees repository. If you have
1053
1072
        tree data already available, it is more efficient to use
1085
1104
                raise errors.GhostRevisionUnusableHere(parents_list[0][0])
1086
1105
        real_trees = []
1087
1106
        ghosts = []
 
1107
 
 
1108
        parent_ids = [rev_id for rev_id, tree in parents_list]
 
1109
        graph = self.branch.repository.get_graph()
 
1110
        heads = graph.heads(parent_ids)
 
1111
        accepted_revisions = set()
 
1112
 
1088
1113
        # convert absent trees to the null tree, which we convert back to
1089
1114
        # missing on access.
1090
1115
        for rev_id, tree in parents_list:
 
1116
            if len(accepted_revisions) > 0:
 
1117
                # we always accept the first tree
 
1118
                if rev_id in accepted_revisions or rev_id not in heads:
 
1119
                    # We have already included either this tree, or its
 
1120
                    # descendent, so we skip it.
 
1121
                    continue
1091
1122
            _mod_revision.check_not_reserved_id(rev_id)
1092
1123
            if tree is not None:
1093
1124
                real_trees.append((rev_id, tree))
1094
1125
            else:
1095
1126
                real_trees.append((rev_id,
1096
 
                    self.branch.repository.revision_tree(None)))
 
1127
                    self.branch.repository.revision_tree(
 
1128
                        _mod_revision.NULL_REVISION)))
1097
1129
                ghosts.append(rev_id)
 
1130
            accepted_revisions.add(rev_id)
1098
1131
        dirstate.set_parent_trees(real_trees, ghosts=ghosts)
1099
1132
        self._make_dirty(reset_inventory=False)
1100
1133
 
1264
1297
        self.flush()
1265
1298
 
1266
1299
 
1267
 
class WorkingTreeFormat4(WorkingTreeFormat3):
1268
 
    """The first consolidated dirstate working tree format.
1269
 
 
1270
 
    This format:
1271
 
        - exists within a metadir controlling .bzr
1272
 
        - includes an explicit version marker for the workingtree control
1273
 
          files, separate from the BzrDir format
1274
 
        - modifies the hash cache format
1275
 
        - is new in bzr 0.15
1276
 
        - uses a LockDir to guard access to it.
1277
 
    """
1278
 
 
1279
 
    upgrade_recommended = False
1280
 
 
1281
 
    def get_format_string(self):
1282
 
        """See WorkingTreeFormat.get_format_string()."""
1283
 
        return "Bazaar Working Tree Format 4 (bzr 0.15)\n"
1284
 
 
1285
 
    def get_format_description(self):
1286
 
        """See WorkingTreeFormat.get_format_description()."""
1287
 
        return "Working tree format 4"
1288
 
 
 
1300
class ContentFilterAwareSHA1Provider(dirstate.SHA1Provider):
 
1301
 
 
1302
    def __init__(self, tree):
 
1303
        self.tree = tree
 
1304
 
 
1305
    def sha1(self, abspath):
 
1306
        """Return the sha1 of a file given its absolute path."""
 
1307
        filters = self.tree._content_filter_stack(self.tree.relpath(abspath))
 
1308
        return internal_size_sha_file_byname(abspath, filters)[1]
 
1309
 
 
1310
    def stat_and_sha1(self, abspath):
 
1311
        """Return the stat and sha1 of a file given its absolute path."""
 
1312
        filters = self.tree._content_filter_stack(self.tree.relpath(abspath))
 
1313
        file_obj = file(abspath, 'rb', 65000)
 
1314
        try:
 
1315
            statvalue = os.fstat(file_obj.fileno())
 
1316
            if filters:
 
1317
                file_obj = filtered_input_file(file_obj, filters)
 
1318
            sha1 = osutils.size_sha_file(file_obj)[1]
 
1319
        finally:
 
1320
            file_obj.close()
 
1321
        return statvalue, sha1
 
1322
 
 
1323
 
 
1324
class WorkingTree4(DirStateWorkingTree):
 
1325
    """This is the Format 4 working tree.
 
1326
 
 
1327
    This differs from WorkingTree3 by:
 
1328
     - Having a consolidated internal dirstate, stored in a
 
1329
       randomly-accessible sorted file on disk.
 
1330
     - Not having a regular inventory attribute.  One can be synthesized
 
1331
       on demand but this is expensive and should be avoided.
 
1332
 
 
1333
    This is new in bzr 0.15.
 
1334
    """
 
1335
 
 
1336
 
 
1337
class WorkingTree5(DirStateWorkingTree):
 
1338
    """This is the Format 5 working tree.
 
1339
 
 
1340
    This differs from WorkingTree4 by:
 
1341
     - Supporting content filtering.
 
1342
     - Supporting a current view that may mask the set of files in a tree
 
1343
       impacted by most user operations.
 
1344
 
 
1345
    This is new in bzr 1.11.
 
1346
    """
 
1347
 
 
1348
    def _make_views(self):
 
1349
        return views.PathBasedViews(self)
 
1350
 
 
1351
 
 
1352
class DirStateWorkingTreeFormat(WorkingTreeFormat3):
1289
1353
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
1290
1354
                   accelerator_tree=None, hardlink=False):
1291
1355
        """See WorkingTreeFormat.initialize().
1321
1385
        state = dirstate.DirState.initialize(local_path)
1322
1386
        state.unlock()
1323
1387
        del state
1324
 
        wt = WorkingTree4(a_bzrdir.root_transport.local_abspath('.'),
 
1388
        wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
1325
1389
                         branch,
1326
1390
                         _format=self,
1327
1391
                         _bzrdir=a_bzrdir,
1329
1393
        wt._new_tree()
1330
1394
        wt.lock_tree_write()
1331
1395
        try:
 
1396
            self._init_custom_control_files(wt)
1332
1397
            if revision_id in (None, NULL_REVISION):
1333
1398
                if branch.repository.supports_rich_root():
1334
1399
                    wt._set_root_id(generate_ids.gen_root_id())
1360
1425
                if basis_root_id is not None:
1361
1426
                    wt._set_root_id(basis_root_id)
1362
1427
                    wt.flush()
 
1428
                # delta_from_tree is safe even for DirStateRevisionTrees,
 
1429
                # because wt4.apply_inventory_delta does not mutate the input
 
1430
                # inventory entries.
1363
1431
                transform.build_tree(basis, wt, accelerator_tree,
1364
 
                                     hardlink=hardlink)
 
1432
                                     hardlink=hardlink, delta_from_tree=True)
1365
1433
            finally:
1366
1434
                basis.unlock()
1367
1435
        finally:
1369
1437
            wt.unlock()
1370
1438
        return wt
1371
1439
 
 
1440
    def _init_custom_control_files(self, wt):
 
1441
        """Subclasses with custom control files should override this method.
 
1442
 
 
1443
        The working tree and control files are locked for writing when this
 
1444
        method is called.
 
1445
 
 
1446
        :param wt: the WorkingTree object
 
1447
        """
 
1448
 
1372
1449
    def _open(self, a_bzrdir, control_files):
1373
1450
        """Open the tree itself.
1374
1451
 
1375
1452
        :param a_bzrdir: the dir for the tree.
1376
1453
        :param control_files: the control files for the tree.
1377
1454
        """
1378
 
        return WorkingTree4(a_bzrdir.root_transport.local_abspath('.'),
 
1455
        return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
1379
1456
                           branch=a_bzrdir.open_branch(),
1380
1457
                           _format=self,
1381
1458
                           _bzrdir=a_bzrdir,
1389
1466
    _matchingbzrdir = property(__get_matchingbzrdir)
1390
1467
 
1391
1468
 
 
1469
class WorkingTreeFormat4(DirStateWorkingTreeFormat):
 
1470
    """The first consolidated dirstate working tree format.
 
1471
 
 
1472
    This format:
 
1473
        - exists within a metadir controlling .bzr
 
1474
        - includes an explicit version marker for the workingtree control
 
1475
          files, separate from the BzrDir format
 
1476
        - modifies the hash cache format
 
1477
        - is new in bzr 0.15
 
1478
        - uses a LockDir to guard access to it.
 
1479
    """
 
1480
 
 
1481
    upgrade_recommended = False
 
1482
 
 
1483
    _tree_class = WorkingTree4
 
1484
 
 
1485
    def get_format_string(self):
 
1486
        """See WorkingTreeFormat.get_format_string()."""
 
1487
        return "Bazaar Working Tree Format 4 (bzr 0.15)\n"
 
1488
 
 
1489
    def get_format_description(self):
 
1490
        """See WorkingTreeFormat.get_format_description()."""
 
1491
        return "Working tree format 4"
 
1492
 
 
1493
 
 
1494
class WorkingTreeFormat5(DirStateWorkingTreeFormat):
 
1495
    """WorkingTree format supporting views.
 
1496
    """
 
1497
 
 
1498
    upgrade_recommended = False
 
1499
 
 
1500
    _tree_class = WorkingTree5
 
1501
 
 
1502
    def get_format_string(self):
 
1503
        """See WorkingTreeFormat.get_format_string()."""
 
1504
        return "Bazaar Working Tree Format 5 (bzr 1.11)\n"
 
1505
 
 
1506
    def get_format_description(self):
 
1507
        """See WorkingTreeFormat.get_format_description()."""
 
1508
        return "Working tree format 5"
 
1509
 
 
1510
    def _init_custom_control_files(self, wt):
 
1511
        """Subclasses with custom control files should override this method."""
 
1512
        wt._transport.put_bytes('views', '', mode=wt.bzrdir._get_file_mode())
 
1513
 
 
1514
    def supports_content_filtering(self):
 
1515
        return True
 
1516
 
 
1517
    def supports_views(self):
 
1518
        return True
 
1519
 
 
1520
 
1392
1521
class DirStateRevisionTree(Tree):
1393
1522
    """A revision tree pulling the inventory from a dirstate."""
1394
1523
 
1399
1528
        self._inventory = None
1400
1529
        self._locked = 0
1401
1530
        self._dirstate_locked = False
 
1531
        self._repo_supports_tree_reference = getattr(
 
1532
            repository._format, "supports_tree_reference",
 
1533
            False)
1402
1534
 
1403
1535
    def __repr__(self):
1404
1536
        return "<%s of %s in %s>" % \
1407
1539
    def annotate_iter(self, file_id,
1408
1540
                      default_revision=_mod_revision.CURRENT_REVISION):
1409
1541
        """See Tree.annotate_iter"""
1410
 
        w = self._get_weave(file_id)
1411
 
        return w.annotate(self.inventory[file_id].revision)
 
1542
        text_key = (file_id, self.inventory[file_id].revision)
 
1543
        annotations = self._repository.texts.annotate(text_key)
 
1544
        return [(key[-1], line) for (key, line) in annotations]
1412
1545
 
1413
1546
    def _get_ancestors(self, default_revision):
1414
1547
        return set(self._repository.get_ancestry(self._revision_id,
1443
1576
        path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
1444
1577
        return path_utf8.decode('utf8')
1445
1578
 
 
1579
    def iter_references(self):
 
1580
        if not self._repo_supports_tree_reference:
 
1581
            # When the repo doesn't support references, we will have nothing to
 
1582
            # return
 
1583
            return iter([])
 
1584
        # Otherwise, fall back to the default implementation
 
1585
        return super(DirStateRevisionTree, self).iter_references()
 
1586
 
1446
1587
    def _get_parent_index(self):
1447
1588
        """Return the index in the dirstate referenced by this tree."""
1448
1589
        return self._dirstate.get_parent_ids().index(self._revision_id) + 1
1453
1594
        If either file_id or path is supplied, it is used as the key to lookup.
1454
1595
        If both are supplied, the fastest lookup is used, and an error is
1455
1596
        raised if they do not both point at the same row.
1456
 
        
 
1597
 
1457
1598
        :param file_id: An optional unicode file_id to be looked up.
1458
1599
        :param path: An optional unicode path to be looked up.
1459
1600
        :return: The dirstate row tuple for path/file_id, or (None, None)
1566
1707
            return parent_details[1]
1567
1708
        return None
1568
1709
 
1569
 
    def _get_weave(self, file_id):
1570
 
        return self._repository.weave_store.get_weave(file_id,
1571
 
                self._repository.get_transaction())
1572
 
 
1573
1710
    def get_file(self, file_id, path=None):
1574
1711
        return StringIO(self.get_file_text(file_id))
1575
1712
 
1576
 
    def get_file_lines(self, file_id):
1577
 
        entry = self._get_entry(file_id=file_id)[1]
1578
 
        if entry is None:
1579
 
            raise errors.NoSuchId(tree=self, file_id=file_id)
1580
 
        return self._get_weave(file_id).get_lines(entry[1][4])
1581
 
 
1582
1713
    def get_file_size(self, file_id):
1583
1714
        """See Tree.get_file_size"""
1584
1715
        return self.inventory[file_id].text_size
1585
1716
 
1586
 
    def get_file_text(self, file_id):
1587
 
        return ''.join(self.get_file_lines(file_id))
 
1717
    def get_file_text(self, file_id, path=None):
 
1718
        return list(self.iter_files_bytes([(file_id, None)]))[0][1]
1588
1719
 
1589
1720
    def get_reference_revision(self, file_id, path=None):
1590
1721
        return self.inventory[file_id].reference_revision
1709
1840
                self._dirstate_locked = False
1710
1841
            self._repository.unlock()
1711
1842
 
 
1843
    @needs_read_lock
 
1844
    def supports_tree_reference(self):
 
1845
        return self._repo_supports_tree_reference
 
1846
 
1712
1847
    def walkdirs(self, prefix=""):
1713
1848
        # TODO: jam 20070215 This is the lazy way by using the RevisionTree
1714
 
        # implementation based on an inventory.  
 
1849
        # implementation based on an inventory.
1715
1850
        # This should be cleaned up to use the much faster Dirstate code
1716
1851
        # So for now, we just build up the parent inventory, and extract
1717
1852
        # it the same way RevisionTree does.
1746
1881
 
1747
1882
class InterDirStateTree(InterTree):
1748
1883
    """Fast path optimiser for changes_from with dirstate trees.
1749
 
    
1750
 
    This is used only when both trees are in the dirstate working file, and 
1751
 
    the source is any parent within the dirstate, and the destination is 
 
1884
 
 
1885
    This is used only when both trees are in the dirstate working file, and
 
1886
    the source is any parent within the dirstate, and the destination is
1752
1887
    the current working tree of the same dirstate.
1753
1888
    """
1754
1889
    # this could be generalized to allow comparisons between any trees in the
1767
1902
        target.set_parent_ids([revid])
1768
1903
        return target.basis_tree(), target
1769
1904
 
 
1905
    @classmethod
 
1906
    def make_source_parent_tree_python_dirstate(klass, test_case, source, target):
 
1907
        result = klass.make_source_parent_tree(source, target)
 
1908
        result[1]._iter_changes = dirstate.ProcessEntryPython
 
1909
        return result
 
1910
 
 
1911
    @classmethod
 
1912
    def make_source_parent_tree_compiled_dirstate(klass, test_case, source, target):
 
1913
        from bzrlib.tests.test__dirstate_helpers import \
 
1914
            CompiledDirstateHelpersFeature
 
1915
        if not CompiledDirstateHelpersFeature.available():
 
1916
            from bzrlib.tests import UnavailableFeature
 
1917
            raise UnavailableFeature(CompiledDirstateHelpersFeature)
 
1918
        from bzrlib._dirstate_helpers_c import ProcessEntryC
 
1919
        result = klass.make_source_parent_tree(source, target)
 
1920
        result[1]._iter_changes = ProcessEntryC
 
1921
        return result
 
1922
 
1770
1923
    _matching_from_tree_format = WorkingTreeFormat4()
1771
1924
    _matching_to_tree_format = WorkingTreeFormat4()
1772
 
    _test_mutable_trees_to_test_trees = make_source_parent_tree
 
1925
 
 
1926
    @classmethod
 
1927
    def _test_mutable_trees_to_test_trees(klass, test_case, source, target):
 
1928
        # This method shouldn't be called, because we have python and C
 
1929
        # specific flavours.
 
1930
        raise NotImplementedError
1773
1931
 
1774
1932
    def iter_changes(self, include_unchanged=False,
1775
1933
                      specific_files=None, pb=None, extra_trees=[],
1793
1951
            output. An unversioned file is defined as one with (False, False)
1794
1952
            for the versioned pair.
1795
1953
        """
1796
 
        utf8_decode = cache_utf8._utf8_decode
1797
 
        _minikind_to_kind = dirstate.DirState._minikind_to_kind
1798
 
        cmp_by_dirs = dirstate.cmp_by_dirs
1799
1954
        # NB: show_status depends on being able to pass in non-versioned files
1800
1955
        # and report them as unknown
1801
1956
        # TODO: handle extra trees in the dirstate.
1802
1957
        if (extra_trees or specific_files == []):
1803
1958
            # we can't fast-path these cases (yet)
1804
 
            for f in super(InterDirStateTree, self).iter_changes(
 
1959
            return super(InterDirStateTree, self).iter_changes(
1805
1960
                include_unchanged, specific_files, pb, extra_trees,
1806
 
                require_versioned, want_unversioned=want_unversioned):
1807
 
                yield f
1808
 
            return
 
1961
                require_versioned, want_unversioned=want_unversioned)
1809
1962
        parent_ids = self.target.get_parent_ids()
1810
1963
        if not (self.source._revision_id in parent_ids
1811
1964
                or self.source._revision_id == NULL_REVISION):
1828
1981
        if specific_files:
1829
1982
            specific_files_utf8 = set()
1830
1983
            for path in specific_files:
 
1984
                # Note, if there are many specific files, using cache_utf8
 
1985
                # would be good here.
1831
1986
                specific_files_utf8.add(path.encode('utf8'))
1832
1987
            specific_files = specific_files_utf8
1833
1988
        else:
1834
1989
            specific_files = set([''])
1835
1990
        # -- specific_files is now a utf8 path set --
 
1991
        search_specific_files = set()
1836
1992
        # -- get the state object and prepare it.
1837
1993
        state = self.target.current_dirstate()
1838
1994
        state._read_dirblocks_if_needed()
1839
 
        def _entries_for_path(path):
1840
 
            """Return a list with all the entries that match path for all ids.
1841
 
            """
1842
 
            dirname, basename = os.path.split(path)
1843
 
            key = (dirname, basename, '')
1844
 
            block_index, present = state._find_block_index_from_key(key)
1845
 
            if not present:
1846
 
                # the block which should contain path is absent.
1847
 
                return []
1848
 
            result = []
1849
 
            block = state._dirblocks[block_index][1]
1850
 
            entry_index, _ = state._find_entry_index(key, block)
1851
 
            # we may need to look at multiple entries at this path: walk while the specific_files match.
1852
 
            while (entry_index < len(block) and
1853
 
                block[entry_index][0][0:2] == key[0:2]):
1854
 
                result.append(block[entry_index])
1855
 
                entry_index += 1
1856
 
            return result
1857
1995
        if require_versioned:
1858
1996
            # -- check all supplied paths are versioned in a search tree. --
1859
1997
            all_versioned = True
1860
1998
            for path in specific_files:
1861
 
                path_entries = _entries_for_path(path)
 
1999
                path_entries = state._entries_for_path(path)
1862
2000
                if not path_entries:
1863
2001
                    # this specified path is not present at all: error
1864
2002
                    all_versioned = False
1880
2018
            if not all_versioned:
1881
2019
                raise errors.PathsNotVersionedError(specific_files)
1882
2020
        # -- remove redundancy in supplied specific_files to prevent over-scanning --
1883
 
        search_specific_files = set()
1884
2021
        for path in specific_files:
1885
2022
            other_specific_files = specific_files.difference(set([path]))
1886
2023
            if not osutils.is_inside_any(other_specific_files, path):
1887
2024
                # this is a top level path, we must check it.
1888
2025
                search_specific_files.add(path)
1889
 
        # sketch: 
1890
 
        # compare source_index and target_index at or under each element of search_specific_files.
1891
 
        # follow the following comparison table. Note that we only want to do diff operations when
1892
 
        # the target is fdl because thats when the walkdirs logic will have exposed the pathinfo 
1893
 
        # for the target.
1894
 
        # cases:
1895
 
        # 
1896
 
        # Source | Target | disk | action
1897
 
        #   r    | fdlt   |      | add source to search, add id path move and perform
1898
 
        #        |        |      | diff check on source-target
1899
 
        #   r    | fdlt   |  a   | dangling file that was present in the basis. 
1900
 
        #        |        |      | ???
1901
 
        #   r    |  a     |      | add source to search
1902
 
        #   r    |  a     |  a   | 
1903
 
        #   r    |  r     |      | this path is present in a non-examined tree, skip.
1904
 
        #   r    |  r     |  a   | this path is present in a non-examined tree, skip.
1905
 
        #   a    | fdlt   |      | add new id
1906
 
        #   a    | fdlt   |  a   | dangling locally added file, skip
1907
 
        #   a    |  a     |      | not present in either tree, skip
1908
 
        #   a    |  a     |  a   | not present in any tree, skip
1909
 
        #   a    |  r     |      | not present in either tree at this path, skip as it
1910
 
        #        |        |      | may not be selected by the users list of paths.
1911
 
        #   a    |  r     |  a   | not present in either tree at this path, skip as it
1912
 
        #        |        |      | may not be selected by the users list of paths.
1913
 
        #  fdlt  | fdlt   |      | content in both: diff them
1914
 
        #  fdlt  | fdlt   |  a   | deleted locally, but not unversioned - show as deleted ?
1915
 
        #  fdlt  |  a     |      | unversioned: output deleted id for now
1916
 
        #  fdlt  |  a     |  a   | unversioned and deleted: output deleted id
1917
 
        #  fdlt  |  r     |      | relocated in this tree, so add target to search.
1918
 
        #        |        |      | Dont diff, we will see an r,fd; pair when we reach
1919
 
        #        |        |      | this id at the other path.
1920
 
        #  fdlt  |  r     |  a   | relocated in this tree, so add target to search.
1921
 
        #        |        |      | Dont diff, we will see an r,fd; pair when we reach
1922
 
        #        |        |      | this id at the other path.
1923
 
 
1924
 
        # for all search_indexs in each path at or under each element of
1925
 
        # search_specific_files, if the detail is relocated: add the id, and add the
1926
 
        # relocated path as one to search if its not searched already. If the
1927
 
        # detail is not relocated, add the id.
1928
 
        searched_specific_files = set()
1929
 
        NULL_PARENT_DETAILS = dirstate.DirState.NULL_PARENT_DETAILS
1930
 
        # Using a list so that we can access the values and change them in
1931
 
        # nested scope. Each one is [path, file_id, entry]
1932
 
        last_source_parent = [None, None]
1933
 
        last_target_parent = [None, None]
1934
2026
 
1935
2027
        use_filesystem_for_exec = (sys.platform != 'win32')
1936
 
 
1937
 
        # Just a sentry, so that _process_entry can say that this
1938
 
        # record is handled, but isn't interesting to process (unchanged)
1939
 
        uninteresting = object()
1940
 
 
1941
 
 
1942
 
        old_dirname_to_file_id = {}
1943
 
        new_dirname_to_file_id = {}
1944
 
        # TODO: jam 20070516 - Avoid the _get_entry lookup overhead by
1945
 
        #       keeping a cache of directories that we have seen.
1946
 
 
1947
 
        def _process_entry(entry, path_info):
1948
 
            """Compare an entry and real disk to generate delta information.
1949
 
 
1950
 
            :param path_info: top_relpath, basename, kind, lstat, abspath for
1951
 
                the path of entry. If None, then the path is considered absent.
1952
 
                (Perhaps we should pass in a concrete entry for this ?)
1953
 
                Basename is returned as a utf8 string because we expect this
1954
 
                tuple will be ignored, and don't want to take the time to
1955
 
                decode.
1956
 
            :return: None if these don't match
1957
 
                     A tuple of information about the change, or
1958
 
                     the object 'uninteresting' if these match, but are
1959
 
                     basically identical.
1960
 
            """
1961
 
            if source_index is None:
1962
 
                source_details = NULL_PARENT_DETAILS
1963
 
            else:
1964
 
                source_details = entry[1][source_index]
1965
 
            target_details = entry[1][target_index]
1966
 
            target_minikind = target_details[0]
1967
 
            if path_info is not None and target_minikind in 'fdlt':
1968
 
                if not (target_index == 0):
1969
 
                    raise AssertionError()
1970
 
                link_or_sha1 = state.update_entry(entry, abspath=path_info[4],
1971
 
                                                  stat_value=path_info[3])
1972
 
                # The entry may have been modified by update_entry
1973
 
                target_details = entry[1][target_index]
1974
 
                target_minikind = target_details[0]
1975
 
            else:
1976
 
                link_or_sha1 = None
1977
 
            file_id = entry[0][2]
1978
 
            source_minikind = source_details[0]
1979
 
            if source_minikind in 'fdltr' and target_minikind in 'fdlt':
1980
 
                # claimed content in both: diff
1981
 
                #   r    | fdlt   |      | add source to search, add id path move and perform
1982
 
                #        |        |      | diff check on source-target
1983
 
                #   r    | fdlt   |  a   | dangling file that was present in the basis.
1984
 
                #        |        |      | ???
1985
 
                if source_minikind in 'r':
1986
 
                    # add the source to the search path to find any children it
1987
 
                    # has.  TODO ? : only add if it is a container ?
1988
 
                    if not osutils.is_inside_any(searched_specific_files,
1989
 
                                                 source_details[1]):
1990
 
                        search_specific_files.add(source_details[1])
1991
 
                    # generate the old path; this is needed for stating later
1992
 
                    # as well.
1993
 
                    old_path = source_details[1]
1994
 
                    old_dirname, old_basename = os.path.split(old_path)
1995
 
                    path = pathjoin(entry[0][0], entry[0][1])
1996
 
                    old_entry = state._get_entry(source_index,
1997
 
                                                 path_utf8=old_path)
1998
 
                    # update the source details variable to be the real
1999
 
                    # location.
2000
 
                    if old_entry == (None, None):
2001
 
                        raise errors.CorruptDirstate(state._filename,
2002
 
                            "entry '%s/%s' is considered renamed from %r"
2003
 
                            " but source does not exist\n"
2004
 
                            "entry: %s" % (entry[0][0], entry[0][1], old_path, entry))
2005
 
                    source_details = old_entry[1][source_index]
2006
 
                    source_minikind = source_details[0]
2007
 
                else:
2008
 
                    old_dirname = entry[0][0]
2009
 
                    old_basename = entry[0][1]
2010
 
                    old_path = path = None
2011
 
                if path_info is None:
2012
 
                    # the file is missing on disk, show as removed.
2013
 
                    content_change = True
2014
 
                    target_kind = None
2015
 
                    target_exec = False
2016
 
                else:
2017
 
                    # source and target are both versioned and disk file is present.
2018
 
                    target_kind = path_info[2]
2019
 
                    if target_kind == 'directory':
2020
 
                        if path is None:
2021
 
                            old_path = path = pathjoin(old_dirname, old_basename)
2022
 
                        new_dirname_to_file_id[path] = file_id
2023
 
                        if source_minikind != 'd':
2024
 
                            content_change = True
2025
 
                        else:
2026
 
                            # directories have no fingerprint
2027
 
                            content_change = False
2028
 
                        target_exec = False
2029
 
                    elif target_kind == 'file':
2030
 
                        if source_minikind != 'f':
2031
 
                            content_change = True
2032
 
                        else:
2033
 
                            # We could check the size, but we already have the
2034
 
                            # sha1 hash.
2035
 
                            content_change = (link_or_sha1 != source_details[1])
2036
 
                        # Target details is updated at update_entry time
2037
 
                        if use_filesystem_for_exec:
2038
 
                            # We don't need S_ISREG here, because we are sure
2039
 
                            # we are dealing with a file.
2040
 
                            target_exec = bool(stat.S_IEXEC & path_info[3].st_mode)
2041
 
                        else:
2042
 
                            target_exec = target_details[3]
2043
 
                    elif target_kind == 'symlink':
2044
 
                        if source_minikind != 'l':
2045
 
                            content_change = True
2046
 
                        else:
2047
 
                            content_change = (link_or_sha1 != source_details[1])
2048
 
                        target_exec = False
2049
 
                    elif target_kind == 'tree-reference':
2050
 
                        if source_minikind != 't':
2051
 
                            content_change = True
2052
 
                        else:
2053
 
                            content_change = False
2054
 
                        target_exec = False
2055
 
                    else:
2056
 
                        raise Exception, "unknown kind %s" % path_info[2]
2057
 
                if source_minikind == 'd':
2058
 
                    if path is None:
2059
 
                        old_path = path = pathjoin(old_dirname, old_basename)
2060
 
                    old_dirname_to_file_id[old_path] = file_id
2061
 
                # parent id is the entry for the path in the target tree
2062
 
                if old_dirname == last_source_parent[0]:
2063
 
                    source_parent_id = last_source_parent[1]
2064
 
                else:
2065
 
                    try:
2066
 
                        source_parent_id = old_dirname_to_file_id[old_dirname]
2067
 
                    except KeyError:
2068
 
                        source_parent_entry = state._get_entry(source_index,
2069
 
                                                               path_utf8=old_dirname)
2070
 
                        source_parent_id = source_parent_entry[0][2]
2071
 
                    if source_parent_id == entry[0][2]:
2072
 
                        # This is the root, so the parent is None
2073
 
                        source_parent_id = None
2074
 
                    else:
2075
 
                        last_source_parent[0] = old_dirname
2076
 
                        last_source_parent[1] = source_parent_id
2077
 
                new_dirname = entry[0][0]
2078
 
                if new_dirname == last_target_parent[0]:
2079
 
                    target_parent_id = last_target_parent[1]
2080
 
                else:
2081
 
                    try:
2082
 
                        target_parent_id = new_dirname_to_file_id[new_dirname]
2083
 
                    except KeyError:
2084
 
                        # TODO: We don't always need to do the lookup, because the
2085
 
                        #       parent entry will be the same as the source entry.
2086
 
                        target_parent_entry = state._get_entry(target_index,
2087
 
                                                               path_utf8=new_dirname)
2088
 
                        if target_parent_entry == (None, None):
2089
 
                            raise AssertionError(
2090
 
                                "Could not find target parent in wt: %s\nparent of: %s"
2091
 
                                % (new_dirname, entry))
2092
 
                        target_parent_id = target_parent_entry[0][2]
2093
 
                    if target_parent_id == entry[0][2]:
2094
 
                        # This is the root, so the parent is None
2095
 
                        target_parent_id = None
2096
 
                    else:
2097
 
                        last_target_parent[0] = new_dirname
2098
 
                        last_target_parent[1] = target_parent_id
2099
 
 
2100
 
                source_exec = source_details[3]
2101
 
                if (include_unchanged
2102
 
                    or content_change
2103
 
                    or source_parent_id != target_parent_id
2104
 
                    or old_basename != entry[0][1]
2105
 
                    or source_exec != target_exec
2106
 
                    ):
2107
 
                    if old_path is None:
2108
 
                        old_path = path = pathjoin(old_dirname, old_basename)
2109
 
                        old_path_u = utf8_decode(old_path)[0]
2110
 
                        path_u = old_path_u
2111
 
                    else:
2112
 
                        old_path_u = utf8_decode(old_path)[0]
2113
 
                        if old_path == path:
2114
 
                            path_u = old_path_u
2115
 
                        else:
2116
 
                            path_u = utf8_decode(path)[0]
2117
 
                    source_kind = _minikind_to_kind[source_minikind]
2118
 
                    return (entry[0][2],
2119
 
                           (old_path_u, path_u),
2120
 
                           content_change,
2121
 
                           (True, True),
2122
 
                           (source_parent_id, target_parent_id),
2123
 
                           (utf8_decode(old_basename)[0], utf8_decode(entry[0][1])[0]),
2124
 
                           (source_kind, target_kind),
2125
 
                           (source_exec, target_exec))
2126
 
                else:
2127
 
                    return uninteresting
2128
 
            elif source_minikind in 'a' and target_minikind in 'fdlt':
2129
 
                # looks like a new file
2130
 
                if path_info is not None:
2131
 
                    path = pathjoin(entry[0][0], entry[0][1])
2132
 
                    # parent id is the entry for the path in the target tree
2133
 
                    # TODO: these are the same for an entire directory: cache em.
2134
 
                    parent_id = state._get_entry(target_index,
2135
 
                                                 path_utf8=entry[0][0])[0][2]
2136
 
                    if parent_id == entry[0][2]:
2137
 
                        parent_id = None
2138
 
                    if use_filesystem_for_exec:
2139
 
                        # We need S_ISREG here, because we aren't sure if this
2140
 
                        # is a file or not.
2141
 
                        target_exec = bool(
2142
 
                            stat.S_ISREG(path_info[3].st_mode)
2143
 
                            and stat.S_IEXEC & path_info[3].st_mode)
2144
 
                    else:
2145
 
                        target_exec = target_details[3]
2146
 
                    return (entry[0][2],
2147
 
                           (None, utf8_decode(path)[0]),
2148
 
                           True,
2149
 
                           (False, True),
2150
 
                           (None, parent_id),
2151
 
                           (None, utf8_decode(entry[0][1])[0]),
2152
 
                           (None, path_info[2]),
2153
 
                           (None, target_exec))
2154
 
                else:
2155
 
                    # but its not on disk: we deliberately treat this as just
2156
 
                    # never-present. (Why ?! - RBC 20070224)
2157
 
                    pass
2158
 
            elif source_minikind in 'fdlt' and target_minikind in 'a':
2159
 
                # unversioned, possibly, or possibly not deleted: we dont care.
2160
 
                # if its still on disk, *and* theres no other entry at this
2161
 
                # path [we dont know this in this routine at the moment -
2162
 
                # perhaps we should change this - then it would be an unknown.
2163
 
                old_path = pathjoin(entry[0][0], entry[0][1])
2164
 
                # parent id is the entry for the path in the target tree
2165
 
                parent_id = state._get_entry(source_index, path_utf8=entry[0][0])[0][2]
2166
 
                if parent_id == entry[0][2]:
2167
 
                    parent_id = None
2168
 
                return (entry[0][2],
2169
 
                       (utf8_decode(old_path)[0], None),
2170
 
                       True,
2171
 
                       (True, False),
2172
 
                       (parent_id, None),
2173
 
                       (utf8_decode(entry[0][1])[0], None),
2174
 
                       (_minikind_to_kind[source_minikind], None),
2175
 
                       (source_details[3], None))
2176
 
            elif source_minikind in 'fdlt' and target_minikind in 'r':
2177
 
                # a rename; could be a true rename, or a rename inherited from
2178
 
                # a renamed parent. TODO: handle this efficiently. Its not
2179
 
                # common case to rename dirs though, so a correct but slow
2180
 
                # implementation will do.
2181
 
                if not osutils.is_inside_any(searched_specific_files, target_details[1]):
2182
 
                    search_specific_files.add(target_details[1])
2183
 
            elif source_minikind in 'ra' and target_minikind in 'ra':
2184
 
                # neither of the selected trees contain this file,
2185
 
                # so skip over it. This is not currently directly tested, but
2186
 
                # is indirectly via test_too_much.TestCommands.test_conflicts.
2187
 
                pass
2188
 
            else:
2189
 
                raise AssertionError("don't know how to compare "
2190
 
                    "source_minikind=%r, target_minikind=%r"
2191
 
                    % (source_minikind, target_minikind))
2192
 
                ## import pdb;pdb.set_trace()
2193
 
            return None
2194
 
 
2195
 
        while search_specific_files:
2196
 
            # TODO: the pending list should be lexically sorted?  the
2197
 
            # interface doesn't require it.
2198
 
            current_root = search_specific_files.pop()
2199
 
            current_root_unicode = current_root.decode('utf8')
2200
 
            searched_specific_files.add(current_root)
2201
 
            # process the entries for this containing directory: the rest will be
2202
 
            # found by their parents recursively.
2203
 
            root_entries = _entries_for_path(current_root)
2204
 
            root_abspath = self.target.abspath(current_root_unicode)
2205
 
            try:
2206
 
                root_stat = os.lstat(root_abspath)
2207
 
            except OSError, e:
2208
 
                if e.errno == errno.ENOENT:
2209
 
                    # the path does not exist: let _process_entry know that.
2210
 
                    root_dir_info = None
2211
 
                else:
2212
 
                    # some other random error: hand it up.
2213
 
                    raise
2214
 
            else:
2215
 
                root_dir_info = ('', current_root,
2216
 
                    osutils.file_kind_from_stat_mode(root_stat.st_mode), root_stat,
2217
 
                    root_abspath)
2218
 
                if root_dir_info[2] == 'directory':
2219
 
                    if self.target._directory_is_tree_reference(
2220
 
                        current_root.decode('utf8')):
2221
 
                        root_dir_info = root_dir_info[:2] + \
2222
 
                            ('tree-reference',) + root_dir_info[3:]
2223
 
 
2224
 
            if not root_entries and not root_dir_info:
2225
 
                # this specified path is not present at all, skip it.
2226
 
                continue
2227
 
            path_handled = False
2228
 
            for entry in root_entries:
2229
 
                result = _process_entry(entry, root_dir_info)
2230
 
                if result is not None:
2231
 
                    path_handled = True
2232
 
                    if result is not uninteresting:
2233
 
                        yield result
2234
 
            if want_unversioned and not path_handled and root_dir_info:
2235
 
                new_executable = bool(
2236
 
                    stat.S_ISREG(root_dir_info[3].st_mode)
2237
 
                    and stat.S_IEXEC & root_dir_info[3].st_mode)
2238
 
                yield (None,
2239
 
                       (None, current_root_unicode),
2240
 
                       True,
2241
 
                       (False, False),
2242
 
                       (None, None),
2243
 
                       (None, splitpath(current_root_unicode)[-1]),
2244
 
                       (None, root_dir_info[2]),
2245
 
                       (None, new_executable)
2246
 
                      )
2247
 
            initial_key = (current_root, '', '')
2248
 
            block_index, _ = state._find_block_index_from_key(initial_key)
2249
 
            if block_index == 0:
2250
 
                # we have processed the total root already, but because the
2251
 
                # initial key matched it we should skip it here.
2252
 
                block_index +=1
2253
 
            if root_dir_info and root_dir_info[2] == 'tree-reference':
2254
 
                current_dir_info = None
2255
 
            else:
2256
 
                dir_iterator = osutils._walkdirs_utf8(root_abspath, prefix=current_root)
2257
 
                try:
2258
 
                    current_dir_info = dir_iterator.next()
2259
 
                except OSError, e:
2260
 
                    # on win32, python2.4 has e.errno == ERROR_DIRECTORY, but
2261
 
                    # python 2.5 has e.errno == EINVAL,
2262
 
                    #            and e.winerror == ERROR_DIRECTORY
2263
 
                    e_winerror = getattr(e, 'winerror', None)
2264
 
                    win_errors = (ERROR_DIRECTORY, ERROR_PATH_NOT_FOUND)
2265
 
                    # there may be directories in the inventory even though
2266
 
                    # this path is not a file on disk: so mark it as end of
2267
 
                    # iterator
2268
 
                    if e.errno in (errno.ENOENT, errno.ENOTDIR, errno.EINVAL):
2269
 
                        current_dir_info = None
2270
 
                    elif (sys.platform == 'win32'
2271
 
                          and (e.errno in win_errors
2272
 
                               or e_winerror in win_errors)):
2273
 
                        current_dir_info = None
2274
 
                    else:
2275
 
                        raise
2276
 
                else:
2277
 
                    if current_dir_info[0][0] == '':
2278
 
                        # remove .bzr from iteration
2279
 
                        bzr_index = bisect_left(current_dir_info[1], ('.bzr',))
2280
 
                        if current_dir_info[1][bzr_index][0] != '.bzr':
2281
 
                            raise AssertionError()
2282
 
                        del current_dir_info[1][bzr_index]
2283
 
            # walk until both the directory listing and the versioned metadata
2284
 
            # are exhausted. 
2285
 
            if (block_index < len(state._dirblocks) and
2286
 
                osutils.is_inside(current_root, state._dirblocks[block_index][0])):
2287
 
                current_block = state._dirblocks[block_index]
2288
 
            else:
2289
 
                current_block = None
2290
 
            while (current_dir_info is not None or
2291
 
                   current_block is not None):
2292
 
                if (current_dir_info and current_block
2293
 
                    and current_dir_info[0][0] != current_block[0]):
2294
 
                    if cmp_by_dirs(current_dir_info[0][0], current_block[0]) < 0:
2295
 
                        # filesystem data refers to paths not covered by the dirblock.
2296
 
                        # this has two possibilities:
2297
 
                        # A) it is versioned but empty, so there is no block for it
2298
 
                        # B) it is not versioned.
2299
 
 
2300
 
                        # if (A) then we need to recurse into it to check for
2301
 
                        # new unknown files or directories.
2302
 
                        # if (B) then we should ignore it, because we don't
2303
 
                        # recurse into unknown directories.
2304
 
                        path_index = 0
2305
 
                        while path_index < len(current_dir_info[1]):
2306
 
                                current_path_info = current_dir_info[1][path_index]
2307
 
                                if want_unversioned:
2308
 
                                    if current_path_info[2] == 'directory':
2309
 
                                        if self.target._directory_is_tree_reference(
2310
 
                                            current_path_info[0].decode('utf8')):
2311
 
                                            current_path_info = current_path_info[:2] + \
2312
 
                                                ('tree-reference',) + current_path_info[3:]
2313
 
                                    new_executable = bool(
2314
 
                                        stat.S_ISREG(current_path_info[3].st_mode)
2315
 
                                        and stat.S_IEXEC & current_path_info[3].st_mode)
2316
 
                                    yield (None,
2317
 
                                        (None, utf8_decode(current_path_info[0])[0]),
2318
 
                                        True,
2319
 
                                        (False, False),
2320
 
                                        (None, None),
2321
 
                                        (None, utf8_decode(current_path_info[1])[0]),
2322
 
                                        (None, current_path_info[2]),
2323
 
                                        (None, new_executable))
2324
 
                                # dont descend into this unversioned path if it is
2325
 
                                # a dir
2326
 
                                if current_path_info[2] in ('directory',
2327
 
                                                            'tree-reference'):
2328
 
                                    del current_dir_info[1][path_index]
2329
 
                                    path_index -= 1
2330
 
                                path_index += 1
2331
 
 
2332
 
                        # This dir info has been handled, go to the next
2333
 
                        try:
2334
 
                            current_dir_info = dir_iterator.next()
2335
 
                        except StopIteration:
2336
 
                            current_dir_info = None
2337
 
                    else:
2338
 
                        # We have a dirblock entry for this location, but there
2339
 
                        # is no filesystem path for this. This is most likely
2340
 
                        # because a directory was removed from the disk.
2341
 
                        # We don't have to report the missing directory,
2342
 
                        # because that should have already been handled, but we
2343
 
                        # need to handle all of the files that are contained
2344
 
                        # within.
2345
 
                        for current_entry in current_block[1]:
2346
 
                            # entry referring to file not present on disk.
2347
 
                            # advance the entry only, after processing.
2348
 
                            result = _process_entry(current_entry, None)
2349
 
                            if result is not None:
2350
 
                                if result is not uninteresting:
2351
 
                                    yield result
2352
 
                        block_index +=1
2353
 
                        if (block_index < len(state._dirblocks) and
2354
 
                            osutils.is_inside(current_root,
2355
 
                                              state._dirblocks[block_index][0])):
2356
 
                            current_block = state._dirblocks[block_index]
2357
 
                        else:
2358
 
                            current_block = None
2359
 
                    continue
2360
 
                entry_index = 0
2361
 
                if current_block and entry_index < len(current_block[1]):
2362
 
                    current_entry = current_block[1][entry_index]
2363
 
                else:
2364
 
                    current_entry = None
2365
 
                advance_entry = True
2366
 
                path_index = 0
2367
 
                if current_dir_info and path_index < len(current_dir_info[1]):
2368
 
                    current_path_info = current_dir_info[1][path_index]
2369
 
                    if current_path_info[2] == 'directory':
2370
 
                        if self.target._directory_is_tree_reference(
2371
 
                            current_path_info[0].decode('utf8')):
2372
 
                            current_path_info = current_path_info[:2] + \
2373
 
                                ('tree-reference',) + current_path_info[3:]
2374
 
                else:
2375
 
                    current_path_info = None
2376
 
                advance_path = True
2377
 
                path_handled = False
2378
 
                while (current_entry is not None or
2379
 
                    current_path_info is not None):
2380
 
                    if current_entry is None:
2381
 
                        # the check for path_handled when the path is adnvaced
2382
 
                        # will yield this path if needed.
2383
 
                        pass
2384
 
                    elif current_path_info is None:
2385
 
                        # no path is fine: the per entry code will handle it.
2386
 
                        result = _process_entry(current_entry, current_path_info)
2387
 
                        if result is not None:
2388
 
                            if result is not uninteresting:
2389
 
                                yield result
2390
 
                    elif (current_entry[0][1] != current_path_info[1]
2391
 
                          or current_entry[1][target_index][0] in 'ar'):
2392
 
                        # The current path on disk doesn't match the dirblock
2393
 
                        # record. Either the dirblock is marked as absent, or
2394
 
                        # the file on disk is not present at all in the
2395
 
                        # dirblock. Either way, report about the dirblock
2396
 
                        # entry, and let other code handle the filesystem one.
2397
 
 
2398
 
                        # Compare the basename for these files to determine
2399
 
                        # which comes first
2400
 
                        if current_path_info[1] < current_entry[0][1]:
2401
 
                            # extra file on disk: pass for now, but only
2402
 
                            # increment the path, not the entry
2403
 
                            advance_entry = False
2404
 
                        else:
2405
 
                            # entry referring to file not present on disk.
2406
 
                            # advance the entry only, after processing.
2407
 
                            result = _process_entry(current_entry, None)
2408
 
                            if result is not None:
2409
 
                                if result is not uninteresting:
2410
 
                                    yield result
2411
 
                            advance_path = False
2412
 
                    else:
2413
 
                        result = _process_entry(current_entry, current_path_info)
2414
 
                        if result is not None:
2415
 
                            path_handled = True
2416
 
                            if result is not uninteresting:
2417
 
                                yield result
2418
 
                    if advance_entry and current_entry is not None:
2419
 
                        entry_index += 1
2420
 
                        if entry_index < len(current_block[1]):
2421
 
                            current_entry = current_block[1][entry_index]
2422
 
                        else:
2423
 
                            current_entry = None
2424
 
                    else:
2425
 
                        advance_entry = True # reset the advance flaga
2426
 
                    if advance_path and current_path_info is not None:
2427
 
                        if not path_handled:
2428
 
                            # unversioned in all regards
2429
 
                            if want_unversioned:
2430
 
                                new_executable = bool(
2431
 
                                    stat.S_ISREG(current_path_info[3].st_mode)
2432
 
                                    and stat.S_IEXEC & current_path_info[3].st_mode)
2433
 
                                yield (None,
2434
 
                                    (None, utf8_decode(current_path_info[0])[0]),
2435
 
                                    True,
2436
 
                                    (False, False),
2437
 
                                    (None, None),
2438
 
                                    (None, utf8_decode(current_path_info[1])[0]),
2439
 
                                    (None, current_path_info[2]),
2440
 
                                    (None, new_executable))
2441
 
                            # dont descend into this unversioned path if it is
2442
 
                            # a dir
2443
 
                            if current_path_info[2] in ('directory'):
2444
 
                                del current_dir_info[1][path_index]
2445
 
                                path_index -= 1
2446
 
                        # dont descend the disk iterator into any tree 
2447
 
                        # paths.
2448
 
                        if current_path_info[2] == 'tree-reference':
2449
 
                            del current_dir_info[1][path_index]
2450
 
                            path_index -= 1
2451
 
                        path_index += 1
2452
 
                        if path_index < len(current_dir_info[1]):
2453
 
                            current_path_info = current_dir_info[1][path_index]
2454
 
                            if current_path_info[2] == 'directory':
2455
 
                                if self.target._directory_is_tree_reference(
2456
 
                                    current_path_info[0].decode('utf8')):
2457
 
                                    current_path_info = current_path_info[:2] + \
2458
 
                                        ('tree-reference',) + current_path_info[3:]
2459
 
                        else:
2460
 
                            current_path_info = None
2461
 
                        path_handled = False
2462
 
                    else:
2463
 
                        advance_path = True # reset the advance flagg.
2464
 
                if current_block is not None:
2465
 
                    block_index += 1
2466
 
                    if (block_index < len(state._dirblocks) and
2467
 
                        osutils.is_inside(current_root, state._dirblocks[block_index][0])):
2468
 
                        current_block = state._dirblocks[block_index]
2469
 
                    else:
2470
 
                        current_block = None
2471
 
                if current_dir_info is not None:
2472
 
                    try:
2473
 
                        current_dir_info = dir_iterator.next()
2474
 
                    except StopIteration:
2475
 
                        current_dir_info = None
2476
 
 
 
2028
        iter_changes = self.target._iter_changes(include_unchanged,
 
2029
            use_filesystem_for_exec, search_specific_files, state,
 
2030
            source_index, target_index, want_unversioned, self.target)
 
2031
        return iter_changes.iter_changes()
2477
2032
 
2478
2033
    @staticmethod
2479
2034
    def is_compatible(source, target):
2480
2035
        # the target must be a dirstate working tree
2481
 
        if not isinstance(target, WorkingTree4):
 
2036
        if not isinstance(target, DirStateWorkingTree):
2482
2037
            return False
2483
 
        # the source must be a revtreee or dirstate rev tree.
 
2038
        # the source must be a revtree or dirstate rev tree.
2484
2039
        if not isinstance(source,
2485
2040
            (revisiontree.RevisionTree, DirStateRevisionTree)):
2486
2041
            return False
2487
2042
        # the source revid must be in the target dirstate
2488
2043
        if not (source._revision_id == NULL_REVISION or
2489
2044
            source._revision_id in target.get_parent_ids()):
2490
 
            # TODO: what about ghosts? it may well need to 
 
2045
            # TODO: what about ghosts? it may well need to
2491
2046
            # check for them explicitly.
2492
2047
            return False
2493
2048
        return True
2503
2058
 
2504
2059
    def convert(self, tree):
2505
2060
        # lock the control files not the tree, so that we dont get tree
2506
 
        # on-unlock behaviours, and so that noone else diddles with the 
 
2061
        # on-unlock behaviours, and so that noone else diddles with the
2507
2062
        # tree during upgrade.
2508
2063
        tree._control_files.lock_write()
2509
2064
        try:
2538
2093
        tree._transport.put_bytes('format',
2539
2094
            self.target_format.get_format_string(),
2540
2095
            mode=tree.bzrdir._get_file_mode())
 
2096
 
 
2097
 
 
2098
class Converter4to5(object):
 
2099
    """Perform an in-place upgrade of format 4 to format 5 trees."""
 
2100
 
 
2101
    def __init__(self):
 
2102
        self.target_format = WorkingTreeFormat5()
 
2103
 
 
2104
    def convert(self, tree):
 
2105
        # lock the control files not the tree, so that we don't get tree
 
2106
        # on-unlock behaviours, and so that no-one else diddles with the
 
2107
        # tree during upgrade.
 
2108
        tree._control_files.lock_write()
 
2109
        try:
 
2110
            self.init_custom_control_files(tree)
 
2111
            self.update_format(tree)
 
2112
        finally:
 
2113
            tree._control_files.unlock()
 
2114
 
 
2115
    def init_custom_control_files(self, tree):
 
2116
        """Initialize custom control files."""
 
2117
        tree._transport.put_bytes('views', '',
 
2118
            mode=tree.bzrdir._get_file_mode())
 
2119
 
 
2120
    def update_format(self, tree):
 
2121
        """Change the format marker."""
 
2122
        tree._transport.put_bytes('format',
 
2123
            self.target_format.get_format_string(),
 
2124
            mode=tree.bzrdir._get_file_mode())