~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree_4.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-04-08 06:17:41 UTC
  • mfrom: (4797.33.16 apport)
  • Revision ID: pqm@pqm.ubuntu.com-20100408061741-m7vl6z97vu33riv7
(robertc) Make sure ExecutablePath and InterpreterPath are set in
        Apport. (Martin Pool, James Westby, lp:528114)

Show diffs side-by-side

added added

removed removed

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