/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to breezy/bzr/dirstate.py

  • Committer: Jelmer Vernooij
  • Date: 2019-06-21 11:21:12 UTC
  • mto: This revision was merged to the branch mainline in revision 7352.
  • Revision ID: jelmer@jelmer.uk-20190621112112-v0uorrdgqib5z1ur
For python 2.x, install sphinx 1.8.5. Newer versions don't support python 2.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2006-2011 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
20
20
lines by NL. The field delimiters are ommitted in the grammar, line delimiters
21
21
are not - this is done for clarity of reading. All string data is in utf8.
22
22
 
23
 
MINIKIND = "f" | "d" | "l" | "a" | "r" | "t";
24
 
NL = "\n";
25
 
NULL = "\0";
26
 
WHOLE_NUMBER = {digit}, digit;
27
 
BOOLEAN = "y" | "n";
28
 
REVISION_ID = a non-empty utf8 string;
29
 
 
30
 
dirstate format = header line, full checksum, row count, parent details,
31
 
 ghost_details, entries;
32
 
header line = "#bazaar dirstate flat format 3", NL;
33
 
full checksum = "crc32: ", ["-"], WHOLE_NUMBER, NL;
34
 
row count = "num_entries: ", WHOLE_NUMBER, NL;
35
 
parent_details = WHOLE NUMBER, {REVISION_ID}* NL;
36
 
ghost_details = WHOLE NUMBER, {REVISION_ID}*, NL;
37
 
entries = {entry};
38
 
entry = entry_key, current_entry_details, {parent_entry_details};
39
 
entry_key = dirname,  basename, fileid;
40
 
current_entry_details = common_entry_details, working_entry_details;
41
 
parent_entry_details = common_entry_details, history_entry_details;
42
 
common_entry_details = MINIKIND, fingerprint, size, executable
43
 
working_entry_details = packed_stat
44
 
history_entry_details = REVISION_ID;
45
 
executable = BOOLEAN;
46
 
size = WHOLE_NUMBER;
47
 
fingerprint = a nonempty utf8 sequence with meaning defined by minikind.
48
 
 
49
 
Given this definition, the following is useful to know:
50
 
entry (aka row) - all the data for a given key.
51
 
entry[0]: The key (dirname, basename, fileid)
52
 
entry[0][0]: dirname
53
 
entry[0][1]: basename
54
 
entry[0][2]: fileid
55
 
entry[1]: The tree(s) data for this path and id combination.
56
 
entry[1][0]: The current tree
57
 
entry[1][1]: The second tree
58
 
 
59
 
For an entry for a tree, we have (using tree 0 - current tree) to demonstrate:
60
 
entry[1][0][0]: minikind
61
 
entry[1][0][1]: fingerprint
62
 
entry[1][0][2]: size
63
 
entry[1][0][3]: executable
64
 
entry[1][0][4]: packed_stat
65
 
OR (for non tree-0)
66
 
entry[1][1][4]: revision_id
 
23
::
 
24
 
 
25
    MINIKIND = "f" | "d" | "l" | "a" | "r" | "t";
 
26
    NL = "\\n";
 
27
    NULL = "\\0";
 
28
    WHOLE_NUMBER = {digit}, digit;
 
29
    BOOLEAN = "y" | "n";
 
30
    REVISION_ID = a non-empty utf8 string;
 
31
 
 
32
    dirstate format = header line, full checksum, row count, parent details,
 
33
     ghost_details, entries;
 
34
    header line = "#bazaar dirstate flat format 3", NL;
 
35
    full checksum = "crc32: ", ["-"], WHOLE_NUMBER, NL;
 
36
    row count = "num_entries: ", WHOLE_NUMBER, NL;
 
37
    parent_details = WHOLE NUMBER, {REVISION_ID}* NL;
 
38
    ghost_details = WHOLE NUMBER, {REVISION_ID}*, NL;
 
39
    entries = {entry};
 
40
    entry = entry_key, current_entry_details, {parent_entry_details};
 
41
    entry_key = dirname,  basename, fileid;
 
42
    current_entry_details = common_entry_details, working_entry_details;
 
43
    parent_entry_details = common_entry_details, history_entry_details;
 
44
    common_entry_details = MINIKIND, fingerprint, size, executable
 
45
    working_entry_details = packed_stat
 
46
    history_entry_details = REVISION_ID;
 
47
    executable = BOOLEAN;
 
48
    size = WHOLE_NUMBER;
 
49
    fingerprint = a nonempty utf8 sequence with meaning defined by minikind.
 
50
 
 
51
Given this definition, the following is useful to know::
 
52
 
 
53
    entry (aka row) - all the data for a given key.
 
54
    entry[0]: The key (dirname, basename, fileid)
 
55
    entry[0][0]: dirname
 
56
    entry[0][1]: basename
 
57
    entry[0][2]: fileid
 
58
    entry[1]: The tree(s) data for this path and id combination.
 
59
    entry[1][0]: The current tree
 
60
    entry[1][1]: The second tree
 
61
 
 
62
For an entry for a tree, we have (using tree 0 - current tree) to demonstrate::
 
63
 
 
64
    entry[1][0][0]: minikind
 
65
    entry[1][0][1]: fingerprint
 
66
    entry[1][0][2]: size
 
67
    entry[1][0][3]: executable
 
68
    entry[1][0][4]: packed_stat
 
69
 
 
70
OR (for non tree-0)::
 
71
 
 
72
    entry[1][1][4]: revision_id
67
73
 
68
74
There may be multiple rows at the root, one per id present in the root, so the
69
 
in memory root row is now:
70
 
self._dirblocks[0] -> ('', [entry ...]),
71
 
and the entries in there are
72
 
entries[0][0]: ''
73
 
entries[0][1]: ''
74
 
entries[0][2]: file_id
75
 
entries[1][0]: The tree data for the current tree for this fileid at /
76
 
etc.
77
 
 
78
 
Kinds:
79
 
'r' is a relocated entry: This path is not present in this tree with this id,
80
 
    but the id can be found at another location. The fingerprint is used to
81
 
    point to the target location.
82
 
'a' is an absent entry: In that tree the id is not present at this path.
83
 
'd' is a directory entry: This path in this tree is a directory with the
84
 
    current file id. There is no fingerprint for directories.
85
 
'f' is a file entry: As for directory, but it's a file. The fingerprint is the
86
 
    sha1 value of the file's canonical form, i.e. after any read filters have
87
 
    been applied to the convenience form stored in the working tree.
88
 
'l' is a symlink entry: As for directory, but a symlink. The fingerprint is the
89
 
    link target.
90
 
't' is a reference to a nested subtree; the fingerprint is the referenced
91
 
    revision.
 
75
in memory root row is now::
 
76
 
 
77
    self._dirblocks[0] -> ('', [entry ...]),
 
78
 
 
79
and the entries in there are::
 
80
 
 
81
    entries[0][0]: b''
 
82
    entries[0][1]: b''
 
83
    entries[0][2]: file_id
 
84
    entries[1][0]: The tree data for the current tree for this fileid at /
 
85
    etc.
 
86
 
 
87
Kinds::
 
88
 
 
89
   b'r' is a relocated entry: This path is not present in this tree with this
 
90
        id, but the id can be found at another location. The fingerprint is
 
91
        used to point to the target location.
 
92
   b'a' is an absent entry: In that tree the id is not present at this path.
 
93
   b'd' is a directory entry: This path in this tree is a directory with the
 
94
        current file id. There is no fingerprint for directories.
 
95
   b'f' is a file entry: As for directory, but it's a file. The fingerprint is
 
96
        the sha1 value of the file's canonical form, i.e. after any read
 
97
        filters have been applied to the convenience form stored in the working
 
98
        tree.
 
99
   b'l' is a symlink entry: As for directory, but a symlink. The fingerprint is
 
100
        the link target.
 
101
   b't' is a reference to a nested subtree; the fingerprint is the referenced
 
102
        revision.
92
103
 
93
104
Ordering:
94
105
 
95
 
The entries on disk and in memory are ordered according to the following keys:
 
106
The entries on disk and in memory are ordered according to the following keys::
96
107
 
97
108
    directory, as a list of components
98
109
    filename
99
110
    file-id
100
111
 
101
112
--- Format 1 had the following different definition: ---
102
 
rows = dirname, NULL, basename, NULL, MINIKIND, NULL, fileid_utf8, NULL,
103
 
    WHOLE NUMBER (* size *), NULL, packed stat, NULL, sha1|symlink target,
104
 
    {PARENT ROW}
105
 
PARENT ROW = NULL, revision_utf8, NULL, MINIKIND, NULL, dirname, NULL,
106
 
    basename, NULL, WHOLE NUMBER (* size *), NULL, "y" | "n", NULL,
107
 
    SHA1
 
113
 
 
114
::
 
115
 
 
116
    rows = dirname, NULL, basename, NULL, MINIKIND, NULL, fileid_utf8, NULL,
 
117
        WHOLE NUMBER (* size *), NULL, packed stat, NULL, sha1|symlink target,
 
118
        {PARENT ROW}
 
119
    PARENT ROW = NULL, revision_utf8, NULL, MINIKIND, NULL, dirname, NULL,
 
120
        basename, NULL, WHOLE NUMBER (* size *), NULL, "y" | "n", NULL,
 
121
        SHA1
108
122
 
109
123
PARENT ROW's are emitted for every parent that is not in the ghosts details
110
124
line. That is, if the parents are foo, bar, baz, and the ghosts are bar, then
135
149
----
136
150
 
137
151
Design priorities:
138
 
 1) Fast end to end use for bzr's top 5 uses cases. (commmit/diff/status/merge/???)
139
 
 2) fall back current object model as needed.
140
 
 3) scale usably to the largest trees known today - say 50K entries. (mozilla
 
152
 1. Fast end to end use for bzr's top 5 uses cases. (commmit/diff/status/merge/???)
 
153
 2. fall back current object model as needed.
 
154
 3. scale usably to the largest trees known today - say 50K entries. (mozilla
141
155
    is an example of this)
142
156
 
143
157
 
144
158
Locking:
 
159
 
145
160
 Eventually reuse dirstate objects across locks IFF the dirstate file has not
146
161
 been modified, but will require that we flush/ignore cached stat-hit data
147
162
 because we won't want to restat all files on disk just because a lock was
148
163
 acquired, yet we cannot trust the data after the previous lock was released.
149
164
 
150
 
Memory representation:
 
165
Memory representation::
 
166
 
151
167
 vector of all directories, and vector of the childen ?
152
168
   i.e.
153
 
     root_entrie = (direntry for root, [parent_direntries_for_root]),
 
169
     root_entries = (direntry for root, [parent_direntries_for_root]),
154
170
     dirblocks = [
155
171
     ('', ['data for achild', 'data for bchild', 'data for cchild'])
156
172
     ('dir', ['achild', 'cchild', 'echild'])
167
183
    - What's the risk of error here? Once we have the base format being processed
168
184
      we should have a net win regardless of optimality. So we are going to
169
185
      go with what seems reasonable.
 
186
 
170
187
open questions:
171
188
 
172
189
Maybe we should do a test profile of the core structure - 10K simulated
201
218
 
202
219
"""
203
220
 
 
221
from __future__ import absolute_import
 
222
 
204
223
import bisect
205
 
import binascii
206
224
import errno
207
225
import operator
208
226
import os
209
227
from stat import S_IEXEC
210
228
import stat
211
 
import struct
212
229
import sys
213
230
import time
214
231
import zlib
215
232
 
216
 
from bzrlib import (
 
233
from . import (
 
234
    inventory,
 
235
    )
 
236
from .. import (
217
237
    cache_utf8,
 
238
    config,
218
239
    debug,
219
240
    errors,
220
 
    inventory,
221
241
    lock,
222
242
    osutils,
 
243
    static_tuple,
223
244
    trace,
224
 
    )
 
245
    urlutils,
 
246
    )
 
247
from ..sixish import (
 
248
    range,
 
249
    text_type,
 
250
    viewitems,
 
251
    viewvalues,
 
252
    )
 
253
from ..tree import TreeChange
225
254
 
226
255
 
227
256
# This is the Windows equivalent of ENOTDIR
231
260
ERROR_DIRECTORY = 267
232
261
 
233
262
 
234
 
if not getattr(struct, '_compile', None):
235
 
    # Cannot pre-compile the dirstate pack_stat
236
 
    def pack_stat(st, _encode=binascii.b2a_base64, _pack=struct.pack):
237
 
        """Convert stat values into a packed representation."""
238
 
        return _encode(_pack('>LLLLLL', st.st_size, int(st.st_mtime),
239
 
            int(st.st_ctime), st.st_dev, st.st_ino & 0xFFFFFFFF,
240
 
            st.st_mode))[:-1]
241
 
else:
242
 
    # compile the struct compiler we need, so as to only do it once
243
 
    from _struct import Struct
244
 
    _compiled_pack = Struct('>LLLLLL').pack
245
 
    def pack_stat(st, _encode=binascii.b2a_base64, _pack=_compiled_pack):
246
 
        """Convert stat values into a packed representation."""
247
 
        # jam 20060614 it isn't really worth removing more entries if we
248
 
        # are going to leave it in packed form.
249
 
        # With only st_mtime and st_mode filesize is 5.5M and read time is 275ms
250
 
        # With all entries, filesize is 5.9M and read time is maybe 280ms
251
 
        # well within the noise margin
252
 
 
253
 
        # base64 encoding always adds a final newline, so strip it off
254
 
        # The current version
255
 
        return _encode(_pack(st.st_size, int(st.st_mtime), int(st.st_ctime),
256
 
            st.st_dev, st.st_ino & 0xFFFFFFFF, st.st_mode))[:-1]
257
 
        # This is 0.060s / 1.520s faster by not encoding as much information
258
 
        # return _encode(_pack('>LL', int(st.st_mtime), st.st_mode))[:-1]
259
 
        # This is not strictly faster than _encode(_pack())[:-1]
260
 
        # return '%X.%X.%X.%X.%X.%X' % (
261
 
        #      st.st_size, int(st.st_mtime), int(st.st_ctime),
262
 
        #      st.st_dev, st.st_ino, st.st_mode)
263
 
        # Similar to the _encode(_pack('>LL'))
264
 
        # return '%X.%X' % (int(st.st_mtime), st.st_mode)
 
263
class DirstateCorrupt(errors.BzrError):
 
264
 
 
265
    _fmt = "The dirstate file (%(state)s) appears to be corrupt: %(msg)s"
 
266
 
 
267
    def __init__(self, state, msg):
 
268
        errors.BzrError.__init__(self)
 
269
        self.state = state
 
270
        self.msg = msg
265
271
 
266
272
 
267
273
class SHA1Provider(object):
277
283
 
278
284
    def stat_and_sha1(self, abspath):
279
285
        """Return the stat and sha1 of a file given its absolute path.
280
 
        
 
286
 
281
287
        :param abspath:  May be a filesystem encoded absolute path
282
288
             or a unicode path.
283
289
 
296
302
 
297
303
    def stat_and_sha1(self, abspath):
298
304
        """Return the stat and sha1 of a file given its absolute path."""
299
 
        file_obj = file(abspath, 'rb')
300
 
        try:
 
305
        with open(abspath, 'rb') as file_obj:
301
306
            statvalue = os.fstat(file_obj.fileno())
302
307
            sha1 = osutils.sha_file(file_obj)
303
 
        finally:
304
 
            file_obj.close()
305
308
        return statvalue, sha1
306
309
 
307
310
 
322
325
    """
323
326
 
324
327
    _kind_to_minikind = {
325
 
            'absent': 'a',
326
 
            'file': 'f',
327
 
            'directory': 'd',
328
 
            'relocated': 'r',
329
 
            'symlink': 'l',
330
 
            'tree-reference': 't',
 
328
        'absent': b'a',
 
329
        'file': b'f',
 
330
        'directory': b'd',
 
331
        'relocated': b'r',
 
332
        'symlink': b'l',
 
333
        'tree-reference': b't',
331
334
        }
332
335
    _minikind_to_kind = {
333
 
            'a': 'absent',
334
 
            'f': 'file',
335
 
            'd': 'directory',
336
 
            'l':'symlink',
337
 
            'r': 'relocated',
338
 
            't': 'tree-reference',
 
336
        b'a': 'absent',
 
337
        b'f': 'file',
 
338
        b'd': 'directory',
 
339
        b'l': 'symlink',
 
340
        b'r': 'relocated',
 
341
        b't': 'tree-reference',
339
342
        }
340
343
    _stat_to_minikind = {
341
 
        stat.S_IFDIR:'d',
342
 
        stat.S_IFREG:'f',
343
 
        stat.S_IFLNK:'l',
 
344
        stat.S_IFDIR: b'd',
 
345
        stat.S_IFREG: b'f',
 
346
        stat.S_IFLNK: b'l',
344
347
    }
345
 
    _to_yesno = {True:'y', False: 'n'} # TODO profile the performance gain
346
 
     # of using int conversion rather than a dict here. AND BLAME ANDREW IF
347
 
     # it is faster.
 
348
    _to_yesno = {True: b'y', False: b'n'}  # TODO profile the performance gain
 
349
    # of using int conversion rather than a dict here. AND BLAME ANDREW IF
 
350
    # it is faster.
348
351
 
349
352
    # TODO: jam 20070221 Figure out what to do if we have a record that exceeds
350
353
    #       the BISECT_PAGE_SIZE. For now, we just have to make it large enough
354
357
    NOT_IN_MEMORY = 0
355
358
    IN_MEMORY_UNMODIFIED = 1
356
359
    IN_MEMORY_MODIFIED = 2
 
360
    IN_MEMORY_HASH_MODIFIED = 3  # Only hash-cache updates
357
361
 
358
362
    # A pack_stat (the x's) that is just noise and will never match the output
359
363
    # of base64 encode.
360
 
    NULLSTAT = 'x' * 32
361
 
    NULL_PARENT_DETAILS = ('a', '', 0, False, '')
362
 
 
363
 
    HEADER_FORMAT_2 = '#bazaar dirstate flat format 2\n'
364
 
    HEADER_FORMAT_3 = '#bazaar dirstate flat format 3\n'
365
 
 
366
 
    def __init__(self, path, sha1_provider):
 
364
    NULLSTAT = b'x' * 32
 
365
    NULL_PARENT_DETAILS = static_tuple.StaticTuple(b'a', b'', 0, False, b'')
 
366
 
 
367
    HEADER_FORMAT_2 = b'#bazaar dirstate flat format 2\n'
 
368
    HEADER_FORMAT_3 = b'#bazaar dirstate flat format 3\n'
 
369
 
 
370
    def __init__(self, path, sha1_provider, worth_saving_limit=0,
 
371
                 use_filesystem_for_exec=True):
367
372
        """Create a  DirState object.
368
373
 
369
374
        :param path: The path at which the dirstate file on disk should live.
370
375
        :param sha1_provider: an object meeting the SHA1Provider interface.
 
376
        :param worth_saving_limit: when the exact number of hash changed
 
377
            entries is known, only bother saving the dirstate if more than
 
378
            this count of entries have changed.
 
379
            -1 means never save hash changes, 0 means always save hash changes.
 
380
        :param use_filesystem_for_exec: Whether to trust the filesystem
 
381
            for executable bit information
371
382
        """
372
383
        # _header_state and _dirblock_state represent the current state
373
384
        # of the dirstate metadata and the per-row data respectiely.
410
421
        # during commit.
411
422
        self._last_block_index = None
412
423
        self._last_entry_index = None
 
424
        # The set of known hash changes
 
425
        self._known_hash_changes = set()
 
426
        # How many hash changed entries can we have without saving
 
427
        self._worth_saving_limit = worth_saving_limit
 
428
        self._config_stack = config.LocationStack(urlutils.local_path_to_url(
 
429
            path))
 
430
        self._use_filesystem_for_exec = use_filesystem_for_exec
413
431
 
414
432
    def __repr__(self):
415
433
        return "%s(%r)" % \
416
434
            (self.__class__.__name__, self._filename)
417
435
 
 
436
    def _mark_modified(self, hash_changed_entries=None, header_modified=False):
 
437
        """Mark this dirstate as modified.
 
438
 
 
439
        :param hash_changed_entries: if non-None, mark just these entries as
 
440
            having their hash modified.
 
441
        :param header_modified: mark the header modified as well, not just the
 
442
            dirblocks.
 
443
        """
 
444
        #trace.mutter_callsite(3, "modified hash entries: %s", hash_changed_entries)
 
445
        if hash_changed_entries:
 
446
            self._known_hash_changes.update(
 
447
                [e[0] for e in hash_changed_entries])
 
448
            if self._dirblock_state in (DirState.NOT_IN_MEMORY,
 
449
                                        DirState.IN_MEMORY_UNMODIFIED):
 
450
                # If the dirstate is already marked a IN_MEMORY_MODIFIED, then
 
451
                # that takes precedence.
 
452
                self._dirblock_state = DirState.IN_MEMORY_HASH_MODIFIED
 
453
        else:
 
454
            # TODO: Since we now have a IN_MEMORY_HASH_MODIFIED state, we
 
455
            #       should fail noisily if someone tries to set
 
456
            #       IN_MEMORY_MODIFIED but we don't have a write-lock!
 
457
            # We don't know exactly what changed so disable smart saving
 
458
            self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
459
        if header_modified:
 
460
            self._header_state = DirState.IN_MEMORY_MODIFIED
 
461
 
 
462
    def _mark_unmodified(self):
 
463
        """Mark this dirstate as unmodified."""
 
464
        self._header_state = DirState.IN_MEMORY_UNMODIFIED
 
465
        self._dirblock_state = DirState.IN_MEMORY_UNMODIFIED
 
466
        self._known_hash_changes = set()
 
467
 
418
468
    def add(self, path, file_id, kind, stat, fingerprint):
419
469
        """Add a path to be tracked.
420
470
 
421
 
        :param path: The path within the dirstate - '' is the root, 'foo' is the
 
471
        :param path: The path within the dirstate - b'' is the root, 'foo' is the
422
472
            path foo within the root, 'foo/bar' is the path bar within foo
423
473
            within the root.
424
474
        :param file_id: The file id of the path being added.
429
479
            after any read filters have been applied),
430
480
            or the target of a symlink,
431
481
            or the referenced revision id for tree-references,
432
 
            or '' for directories.
 
482
            or b'' for directories.
433
483
        """
434
484
        # adding a file:
435
485
        # find the block its in.
436
486
        # find the location in the block.
437
487
        # check its not there
438
488
        # add it.
439
 
        #------- copied from inventory.ensure_normalized_name - keep synced.
 
489
        # ------- copied from inventory.ensure_normalized_name - keep synced.
440
490
        # --- normalized_filename wants a unicode basename only, so get one.
441
491
        dirname, basename = osutils.split(path)
442
492
        # we dont import normalized_filename directly because we want to be
457
507
        utf8path = (dirname + '/' + basename).strip('/').encode('utf8')
458
508
        dirname, basename = osutils.split(utf8path)
459
509
        # uses __class__ for speed; the check is needed for safety
460
 
        if file_id.__class__ is not str:
 
510
        if file_id.__class__ is not bytes:
461
511
            raise AssertionError(
462
512
                "must be a utf8 file_id not %s" % (type(file_id), ))
463
513
        # Make sure the file_id does not exist in this tree
464
514
        rename_from = None
465
 
        file_id_entry = self._get_entry(0, fileid_utf8=file_id, include_deleted=True)
 
515
        file_id_entry = self._get_entry(
 
516
            0, fileid_utf8=file_id, include_deleted=True)
466
517
        if file_id_entry != (None, None):
467
 
            if file_id_entry[1][0][0] == 'a':
 
518
            if file_id_entry[1][0][0] == b'a':
468
519
                if file_id_entry[0] != (dirname, basename, file_id):
469
520
                    # set the old name's current operation to rename
470
521
                    self.update_minimal(file_id_entry[0],
471
 
                        'r',
472
 
                        path_utf8='',
473
 
                        packed_stat='',
474
 
                        fingerprint=utf8path
475
 
                    )
 
522
                                        b'r',
 
523
                                        path_utf8=b'',
 
524
                                        packed_stat=b'',
 
525
                                        fingerprint=utf8path
 
526
                                        )
476
527
                    rename_from = file_id_entry[0][0:2]
477
528
            else:
478
 
                path = osutils.pathjoin(file_id_entry[0][0], file_id_entry[0][1])
 
529
                path = osutils.pathjoin(
 
530
                    file_id_entry[0][0], file_id_entry[0][1])
479
531
                kind = DirState._minikind_to_kind[file_id_entry[1][0][0]]
480
532
                info = '%s:%s' % (kind, path)
481
533
                raise errors.DuplicateFileId(file_id, info)
482
 
        first_key = (dirname, basename, '')
 
534
        first_key = (dirname, basename, b'')
483
535
        block_index, present = self._find_block_index_from_key(first_key)
484
536
        if present:
485
537
            # check the path is not in the tree
486
538
            block = self._dirblocks[block_index][1]
487
539
            entry_index, _ = self._find_entry_index(first_key, block)
488
540
            while (entry_index < len(block) and
489
 
                block[entry_index][0][0:2] == first_key[0:2]):
490
 
                if block[entry_index][1][0][0] not in 'ar':
 
541
                   block[entry_index][0][0:2] == first_key[0:2]):
 
542
                if block[entry_index][1][0][0] not in (b'a', b'r'):
491
543
                    # this path is in the dirstate in the current tree.
492
 
                    raise Exception, "adding already added path!"
 
544
                    raise Exception("adding already added path!")
493
545
                entry_index += 1
494
546
        else:
495
547
            # The block where we want to put the file is not present. But it
513
565
        minikind = DirState._kind_to_minikind[kind]
514
566
        if rename_from is not None:
515
567
            if rename_from[0]:
516
 
                old_path_utf8 = '%s/%s' % rename_from
 
568
                old_path_utf8 = b'%s/%s' % rename_from
517
569
            else:
518
570
                old_path_utf8 = rename_from[1]
519
 
            parent_info[0] = ('r', old_path_utf8, 0, False, '')
 
571
            parent_info[0] = (b'r', old_path_utf8, 0, False, b'')
520
572
        if kind == 'file':
521
573
            entry_data = entry_key, [
522
574
                (minikind, fingerprint, size, False, packed_stat),
523
575
                ] + parent_info
524
576
        elif kind == 'directory':
525
577
            entry_data = entry_key, [
526
 
                (minikind, '', 0, False, packed_stat),
 
578
                (minikind, b'', 0, False, packed_stat),
527
579
                ] + parent_info
528
580
        elif kind == 'symlink':
529
581
            entry_data = entry_key, [
539
591
        if not present:
540
592
            block.insert(entry_index, entry_data)
541
593
        else:
542
 
            if block[entry_index][1][0][0] != 'a':
543
 
                raise AssertionError(" %r(%r) already added" % (basename, file_id))
 
594
            if block[entry_index][1][0][0] != b'a':
 
595
                raise AssertionError(" %r(%r) already added" %
 
596
                                     (basename, file_id))
544
597
            block[entry_index][1][0] = entry_data[1][0]
545
598
 
546
599
        if kind == 'directory':
547
 
           # insert a new dirblock
548
 
           self._ensure_block(block_index, entry_index, utf8path)
549
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
600
            # insert a new dirblock
 
601
            self._ensure_block(block_index, entry_index, utf8path)
 
602
        self._mark_modified()
550
603
        if self._id_index:
551
 
            self._id_index.setdefault(entry_key[2], set()).add(entry_key)
 
604
            self._add_to_id_index(self._id_index, entry_key)
552
605
 
553
606
    def _bisect(self, paths):
554
607
        """Bisect through the disk structure for specific rows.
566
619
        # there, this function is only meant to handle when we want to read
567
620
        # part of the disk.
568
621
        if self._dirblock_state != DirState.NOT_IN_MEMORY:
569
 
            raise AssertionError("bad dirblock state %r" % self._dirblock_state)
 
622
            raise AssertionError("bad dirblock state %r" %
 
623
                                 self._dirblock_state)
570
624
 
571
625
        # The disk representation is generally info + '\0\n\0' at the end. But
572
626
        # for bisecting, it is easier to treat this as '\0' + info + '\0\n'
575
629
        file_size = os.fstat(state_file.fileno()).st_size
576
630
        # We end up with 2 extra fields, we should have a trailing '\n' to
577
631
        # ensure that we read the whole record, and we should have a precursur
578
 
        # '' which ensures that we start after the previous '\n'
 
632
        # b'' which ensures that we start after the previous '\n'
579
633
        entry_field_count = self._fields_per_entry() + 1
580
634
 
581
635
        low = self._end_of_header
582
 
        high = file_size - 1 # Ignore the final '\0'
 
636
        high = file_size - 1  # Ignore the final '\0'
583
637
        # Map from (dir, name) => entry
584
638
        found = {}
585
639
 
586
640
        # Avoid infinite seeking
587
 
        max_count = 30*len(paths)
 
641
        max_count = 30 * len(paths)
588
642
        count = 0
589
643
        # pending is a list of places to look.
590
644
        # each entry is a tuple of low, high, dir_names
609
663
            if count > max_count:
610
664
                raise errors.BzrError('Too many seeks, most likely a bug.')
611
665
 
612
 
            mid = max(low, (low+high-page_size)/2)
 
666
            mid = max(low, (low + high - page_size) // 2)
613
667
 
614
668
            state_file.seek(mid)
615
669
            # limit the read size, so we don't end up reading data that we have
616
670
            # already read.
617
 
            read_size = min(page_size, (high-mid)+1)
 
671
            read_size = min(page_size, (high - mid) + 1)
618
672
            block = state_file.read(read_size)
619
673
 
620
674
            start = mid
621
 
            entries = block.split('\n')
 
675
            entries = block.split(b'\n')
622
676
 
623
677
            if len(entries) < 2:
624
678
                # We didn't find a '\n', so we cannot have found any records.
632
686
            # Check the first and last entries, in case they are partial, or if
633
687
            # we don't care about the rest of this page
634
688
            first_entry_num = 0
635
 
            first_fields = entries[0].split('\0')
 
689
            first_fields = entries[0].split(b'\0')
636
690
            if len(first_fields) < entry_field_count:
637
691
                # We didn't get the complete first entry
638
692
                # so move start, and grab the next, which
639
693
                # should be a full entry
640
 
                start += len(entries[0])+1
641
 
                first_fields = entries[1].split('\0')
 
694
                start += len(entries[0]) + 1
 
695
                first_fields = entries[1].split(b'\0')
642
696
                first_entry_num = 1
643
697
 
644
698
            if len(first_fields) <= 2:
652
706
                # after this first record.
653
707
                after = start
654
708
                if first_fields[1]:
655
 
                    first_path = first_fields[1] + '/' + first_fields[2]
 
709
                    first_path = first_fields[1] + b'/' + first_fields[2]
656
710
                else:
657
711
                    first_path = first_fields[2]
658
712
                first_loc = _bisect_path_left(cur_files, first_path)
667
721
                # We have files after the first entry
668
722
 
669
723
                # Parse the last entry
670
 
                last_entry_num = len(entries)-1
671
 
                last_fields = entries[last_entry_num].split('\0')
 
724
                last_entry_num = len(entries) - 1
 
725
                last_fields = entries[last_entry_num].split(b'\0')
672
726
                if len(last_fields) < entry_field_count:
673
727
                    # The very last hunk was not complete,
674
728
                    # read the previous hunk
675
729
                    after = mid + len(block) - len(entries[-1])
676
730
                    last_entry_num -= 1
677
 
                    last_fields = entries[last_entry_num].split('\0')
 
731
                    last_fields = entries[last_entry_num].split(b'\0')
678
732
                else:
679
733
                    after = mid + len(block)
680
734
 
681
735
                if last_fields[1]:
682
 
                    last_path = last_fields[1] + '/' + last_fields[2]
 
736
                    last_path = last_fields[1] + b'/' + last_fields[2]
683
737
                else:
684
738
                    last_path = last_fields[2]
685
739
                last_loc = _bisect_path_right(post, last_path)
700
754
                        post.insert(0, last_path)
701
755
 
702
756
                    # Find out what paths we have
703
 
                    paths = {first_path:[first_fields]}
 
757
                    paths = {first_path: [first_fields]}
704
758
                    # last_path might == first_path so we need to be
705
759
                    # careful if we should append rather than overwrite
706
760
                    if last_entry_num != first_entry_num:
707
761
                        paths.setdefault(last_path, []).append(last_fields)
708
 
                    for num in xrange(first_entry_num+1, last_entry_num):
 
762
                    for num in range(first_entry_num + 1, last_entry_num):
709
763
                        # TODO: jam 20070223 We are already splitting here, so
710
764
                        #       shouldn't we just split the whole thing rather
711
765
                        #       than doing the split again in add_one_record?
712
 
                        fields = entries[num].split('\0')
 
766
                        fields = entries[num].split(b'\0')
713
767
                        if fields[1]:
714
 
                            path = fields[1] + '/' + fields[2]
 
768
                            path = fields[1] + b'/' + fields[2]
715
769
                        else:
716
770
                            path = fields[2]
717
771
                        paths.setdefault(path, []).append(fields)
732
786
            if post:
733
787
                pending.append((after, high, post))
734
788
            if pre:
735
 
                pending.append((low, start-1, pre))
 
789
                pending.append((low, start - 1, pre))
736
790
 
737
791
        # Consider that we may want to return the directory entries in sorted
738
792
        # order. For now, we just return them in whatever order we found them,
759
813
        # there, this function is only meant to handle when we want to read
760
814
        # part of the disk.
761
815
        if self._dirblock_state != DirState.NOT_IN_MEMORY:
762
 
            raise AssertionError("bad dirblock state %r" % self._dirblock_state)
 
816
            raise AssertionError("bad dirblock state %r" %
 
817
                                 self._dirblock_state)
763
818
        # The disk representation is generally info + '\0\n\0' at the end. But
764
819
        # for bisecting, it is easier to treat this as '\0' + info + '\0\n'
765
820
        # Because it means we can sync on the '\n'
767
822
        file_size = os.fstat(state_file.fileno()).st_size
768
823
        # We end up with 2 extra fields, we should have a trailing '\n' to
769
824
        # ensure that we read the whole record, and we should have a precursur
770
 
        # '' which ensures that we start after the previous '\n'
 
825
        # b'' which ensures that we start after the previous '\n'
771
826
        entry_field_count = self._fields_per_entry() + 1
772
827
 
773
828
        low = self._end_of_header
774
 
        high = file_size - 1 # Ignore the final '\0'
 
829
        high = file_size - 1  # Ignore the final '\0'
775
830
        # Map from dir => entry
776
831
        found = {}
777
832
 
778
833
        # Avoid infinite seeking
779
 
        max_count = 30*len(dir_list)
 
834
        max_count = 30 * len(dir_list)
780
835
        count = 0
781
836
        # pending is a list of places to look.
782
837
        # each entry is a tuple of low, high, dir_names
801
856
            if count > max_count:
802
857
                raise errors.BzrError('Too many seeks, most likely a bug.')
803
858
 
804
 
            mid = max(low, (low+high-page_size)/2)
 
859
            mid = max(low, (low + high - page_size) // 2)
805
860
 
806
861
            state_file.seek(mid)
807
862
            # limit the read size, so we don't end up reading data that we have
808
863
            # already read.
809
 
            read_size = min(page_size, (high-mid)+1)
 
864
            read_size = min(page_size, (high - mid) + 1)
810
865
            block = state_file.read(read_size)
811
866
 
812
867
            start = mid
813
 
            entries = block.split('\n')
 
868
            entries = block.split(b'\n')
814
869
 
815
870
            if len(entries) < 2:
816
871
                # We didn't find a '\n', so we cannot have found any records.
824
879
            # Check the first and last entries, in case they are partial, or if
825
880
            # we don't care about the rest of this page
826
881
            first_entry_num = 0
827
 
            first_fields = entries[0].split('\0')
 
882
            first_fields = entries[0].split(b'\0')
828
883
            if len(first_fields) < entry_field_count:
829
884
                # We didn't get the complete first entry
830
885
                # so move start, and grab the next, which
831
886
                # should be a full entry
832
 
                start += len(entries[0])+1
833
 
                first_fields = entries[1].split('\0')
 
887
                start += len(entries[0]) + 1
 
888
                first_fields = entries[1].split(b'\0')
834
889
                first_entry_num = 1
835
890
 
836
891
            if len(first_fields) <= 1:
856
911
                # We have records to look at after the first entry
857
912
 
858
913
                # Parse the last entry
859
 
                last_entry_num = len(entries)-1
860
 
                last_fields = entries[last_entry_num].split('\0')
 
914
                last_entry_num = len(entries) - 1
 
915
                last_fields = entries[last_entry_num].split(b'\0')
861
916
                if len(last_fields) < entry_field_count:
862
917
                    # The very last hunk was not complete,
863
918
                    # read the previous hunk
864
919
                    after = mid + len(block) - len(entries[-1])
865
920
                    last_entry_num -= 1
866
 
                    last_fields = entries[last_entry_num].split('\0')
 
921
                    last_fields = entries[last_entry_num].split(b'\0')
867
922
                else:
868
923
                    after = mid + len(block)
869
924
 
886
941
                        post.insert(0, last_dir)
887
942
 
888
943
                    # Find out what paths we have
889
 
                    paths = {first_dir:[first_fields]}
 
944
                    paths = {first_dir: [first_fields]}
890
945
                    # last_dir might == first_dir so we need to be
891
946
                    # careful if we should append rather than overwrite
892
947
                    if last_entry_num != first_entry_num:
893
948
                        paths.setdefault(last_dir, []).append(last_fields)
894
 
                    for num in xrange(first_entry_num+1, last_entry_num):
 
949
                    for num in range(first_entry_num + 1, last_entry_num):
895
950
                        # TODO: jam 20070223 We are already splitting here, so
896
951
                        #       shouldn't we just split the whole thing rather
897
952
                        #       than doing the split again in add_one_record?
898
 
                        fields = entries[num].split('\0')
 
953
                        fields = entries[num].split(b'\0')
899
954
                        paths.setdefault(fields[1], []).append(fields)
900
955
 
901
956
                    for cur_dir in middle_files:
914
969
            if post:
915
970
                pending.append((after, high, post))
916
971
            if pre:
917
 
                pending.append((low, start-1, pre))
 
972
                pending.append((low, start - 1, pre))
918
973
 
919
974
        return found
920
975
 
926
981
        directories. (and renames?)
927
982
 
928
983
        :param paths: A sorted list of (dir, name) pairs
929
 
             eg: [('', 'a'), ('', 'f'), ('a/b', 'c')]
 
984
             eg: [('', b'a'), ('', b'f'), ('a/b', b'c')]
930
985
        :return: A dictionary mapping (dir, name, file_id) => [tree_info]
931
986
        """
932
987
        # Map from (dir, name, file_id) => [tree_info]
943
998
            # Directories that need to be read
944
999
            pending_dirs = set()
945
1000
            paths_to_search = set()
946
 
            for entry_list in newly_found.itervalues():
 
1001
            for entry_list in viewvalues(newly_found):
947
1002
                for dir_name_id, trees_info in entry_list:
948
1003
                    found[dir_name_id] = trees_info
949
1004
                    found_dir_names.add(dir_name_id[:2])
950
1005
                    is_dir = False
951
1006
                    for tree_info in trees_info:
952
1007
                        minikind = tree_info[0]
953
 
                        if minikind == 'd':
 
1008
                        if minikind == b'd':
954
1009
                            if is_dir:
955
1010
                                # We already processed this one as a directory,
956
1011
                                # we don't need to do the extra work again.
960
1015
                            is_dir = True
961
1016
                            if path not in processed_dirs:
962
1017
                                pending_dirs.add(path)
963
 
                        elif minikind == 'r':
 
1018
                        elif minikind == b'r':
964
1019
                            # Rename, we need to directly search the target
965
1020
                            # which is contained in the fingerprint column
966
1021
                            dir_name = osutils.split(tree_info[1])
993
1048
            return
994
1049
        # only require all dirblocks if we are doing a full-pass removal.
995
1050
        self._read_dirblocks_if_needed()
996
 
        dead_patterns = set([('a', 'r'), ('a', 'a'), ('r', 'r'), ('r', 'a')])
 
1051
        dead_patterns = {(b'a', b'r'), (b'a', b'a'),
 
1052
                         (b'r', b'r'), (b'r', b'a')}
 
1053
 
997
1054
        def iter_entries_removable():
998
1055
            for block in self._dirblocks:
999
1056
                deleted_positions = []
1018
1075
 
1019
1076
        self._ghosts = []
1020
1077
        self._parents = [parents[0]]
1021
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
1022
 
        self._header_state = DirState.IN_MEMORY_MODIFIED
 
1078
        self._mark_modified(header_modified=True)
1023
1079
 
1024
1080
    def _empty_parent_info(self):
1025
1081
        return [DirState.NULL_PARENT_DETAILS] * (len(self._parents) -
1026
 
                                                    len(self._ghosts))
 
1082
                                                 len(self._ghosts))
1027
1083
 
1028
1084
    def _ensure_block(self, parent_block_index, parent_row_index, dirname):
1029
1085
        """Ensure a block for dirname exists.
1045
1101
        :param dirname: The utf8 dirname to ensure there is a block for.
1046
1102
        :return: The index for the block.
1047
1103
        """
1048
 
        if dirname == '' and parent_row_index == 0 and parent_block_index == 0:
 
1104
        if dirname == b'' and parent_row_index == 0 and parent_block_index == 0:
1049
1105
            # This is the signature of the root row, and the
1050
1106
            # contents-of-root row is always index 1
1051
1107
            return 1
1052
1108
        # the basename of the directory must be the end of its full name.
1053
1109
        if not (parent_block_index == -1 and
1054
 
            parent_block_index == -1 and dirname == ''):
 
1110
                parent_block_index == -1 and dirname == b''):
1055
1111
            if not dirname.endswith(
1056
1112
                    self._dirblocks[parent_block_index][1][parent_row_index][0][1]):
1057
1113
                raise AssertionError("bad dirname %r" % dirname)
1058
 
        block_index, present = self._find_block_index_from_key((dirname, '', ''))
 
1114
        block_index, present = self._find_block_index_from_key(
 
1115
            (dirname, b'', b''))
1059
1116
        if not present:
1060
 
            ## In future, when doing partial parsing, this should load and
 
1117
            # In future, when doing partial parsing, this should load and
1061
1118
            # populate the entire block.
1062
1119
            self._dirblocks.insert(block_index, (dirname, []))
1063
1120
        return block_index
1072
1129
            to prevent unneeded overhead when callers have a sorted list already.
1073
1130
        :return: Nothing.
1074
1131
        """
1075
 
        if new_entries[0][0][0:2] != ('', ''):
 
1132
        if new_entries[0][0][0:2] != (b'', b''):
1076
1133
            raise AssertionError(
1077
1134
                "Missing root row %r" % (new_entries[0][0],))
1078
1135
        # The two blocks here are deliberate: the root block and the
1079
1136
        # contents-of-root block.
1080
 
        self._dirblocks = [('', []), ('', [])]
 
1137
        self._dirblocks = [(b'', []), (b'', [])]
1081
1138
        current_block = self._dirblocks[0][1]
1082
 
        current_dirname = ''
1083
 
        root_key = ('', '')
 
1139
        current_dirname = b''
 
1140
        root_key = (b'', b'')
1084
1141
        append_entry = current_block.append
1085
1142
        for entry in new_entries:
1086
1143
            if entry[0][0] != current_dirname:
1102
1159
        # The above loop leaves the "root block" entries mixed with the
1103
1160
        # "contents-of-root block". But we don't want an if check on
1104
1161
        # all entries, so instead we just fix it up here.
1105
 
        if self._dirblocks[1] != ('', []):
 
1162
        if self._dirblocks[1] != (b'', []):
1106
1163
            raise ValueError("bad dirblock start %r" % (self._dirblocks[1],))
1107
1164
        root_block = []
1108
1165
        contents_of_root_block = []
1109
1166
        for entry in self._dirblocks[0][1]:
1110
 
            if not entry[0][1]: # This is a root entry
 
1167
            if not entry[0][1]:  # This is a root entry
1111
1168
                root_block.append(entry)
1112
1169
            else:
1113
1170
                contents_of_root_block.append(entry)
1114
 
        self._dirblocks[0] = ('', root_block)
1115
 
        self._dirblocks[1] = ('', contents_of_root_block)
 
1171
        self._dirblocks[0] = (b'', root_block)
 
1172
        self._dirblocks[1] = (b'', contents_of_root_block)
1116
1173
 
1117
1174
    def _entries_for_path(self, path):
1118
1175
        """Return a list with all the entries that match path for all ids."""
1119
1176
        dirname, basename = os.path.split(path)
1120
 
        key = (dirname, basename, '')
 
1177
        key = (dirname, basename, b'')
1121
1178
        block_index, present = self._find_block_index_from_key(key)
1122
1179
        if not present:
1123
1180
            # the block which should contain path is absent.
1127
1184
        entry_index, _ = self._find_entry_index(key, block)
1128
1185
        # we may need to look at multiple entries at this path: walk while the specific_files match.
1129
1186
        while (entry_index < len(block) and
1130
 
            block[entry_index][0][0:2] == key[0:2]):
 
1187
               block[entry_index][0][0:2] == key[0:2]):
1131
1188
            result.append(block[entry_index])
1132
1189
            entry_index += 1
1133
1190
        return result
1146
1203
            # minikind
1147
1204
            entire_entry[tree_offset + 0] = tree_data[0]
1148
1205
            # size
1149
 
            entire_entry[tree_offset + 2] = str(tree_data[2])
 
1206
            entire_entry[tree_offset + 2] = b'%d' % tree_data[2]
1150
1207
            # executable
1151
1208
            entire_entry[tree_offset + 3] = DirState._to_yesno[tree_data[3]]
1152
 
        return '\0'.join(entire_entry)
 
1209
        return b'\0'.join(entire_entry)
1153
1210
 
1154
1211
    def _fields_per_entry(self):
1155
1212
        """How many null separated fields should be in each entry row.
1156
1213
 
1157
 
        Each line now has an extra '\n' field which is not used
 
1214
        Each line now has an extra '\\n' field which is not used
1158
1215
        so we just skip over it
1159
 
        entry size:
 
1216
 
 
1217
        entry size::
1160
1218
            3 fields for the key
1161
1219
            + number of fields per tree_data (5) * tree count
1162
1220
            + newline
1191
1249
 
1192
1250
        :return: The block index, True if the block for the key is present.
1193
1251
        """
1194
 
        if key[0:2] == ('', ''):
 
1252
        if key[0:2] == (b'', b''):
1195
1253
            return 0, True
1196
1254
        try:
1197
1255
            if (self._last_block_index is not None and
1198
 
                self._dirblocks[self._last_block_index][0] == key[0]):
 
1256
                    self._dirblocks[self._last_block_index][0] == key[0]):
1199
1257
                return self._last_block_index, True
1200
1258
        except IndexError:
1201
1259
            pass
1203
1261
                                      cache=self._split_path_cache)
1204
1262
        # _right returns one-past-where-key is so we have to subtract
1205
1263
        # one to use it. we use _right here because there are two
1206
 
        # '' blocks - the root, and the contents of root
 
1264
        # b'' blocks - the root, and the contents of root
1207
1265
        # we always have a minimum of 2 in self._dirblocks: root and
1208
 
        # root-contents, and for '', we get 2 back, so this is
 
1266
        # root-contents, and for b'', we get 2 back, so this is
1209
1267
        # simple and correct:
1210
1268
        present = (block_index < len(self._dirblocks) and
1211
 
            self._dirblocks[block_index][0] == key[0])
 
1269
                   self._dirblocks[block_index][0] == key[0])
1212
1270
        self._last_block_index = block_index
1213
1271
        # Reset the entry index cache to the beginning of the block.
1214
1272
        self._last_entry_index = -1
1227
1285
                # A hit is when the key is after the last slot, and before or
1228
1286
                # equal to the next slot.
1229
1287
                if ((entry_index > 0 and block[entry_index - 1][0] < key) and
1230
 
                    key <= block[entry_index][0]):
 
1288
                        key <= block[entry_index][0]):
1231
1289
                    self._last_entry_index = entry_index
1232
1290
                    present = (block[entry_index][0] == key)
1233
1291
                    return entry_index, present
1235
1293
            pass
1236
1294
        entry_index = bisect.bisect_left(block, (key, []))
1237
1295
        present = (entry_index < len_block and
1238
 
            block[entry_index][0] == key)
 
1296
                   block[entry_index][0] == key)
1239
1297
        self._last_entry_index = entry_index
1240
1298
        return entry_index, present
1241
1299
 
1251
1309
            (it was locked by DirState.initialize)
1252
1310
        """
1253
1311
        result = DirState.initialize(dir_state_filename,
1254
 
            sha1_provider=sha1_provider)
 
1312
                                     sha1_provider=sha1_provider)
1255
1313
        try:
1256
 
            tree.lock_read()
1257
 
            try:
1258
 
                parent_ids = tree.get_parent_ids()
1259
 
                num_parents = len(parent_ids)
1260
 
                parent_trees = []
1261
 
                for parent_id in parent_ids:
1262
 
                    parent_tree = tree.branch.repository.revision_tree(parent_id)
1263
 
                    parent_trees.append((parent_id, parent_tree))
1264
 
                    parent_tree.lock_read()
1265
 
                result.set_parent_trees(parent_trees, [])
1266
 
                result.set_state_from_inventory(tree.inventory)
1267
 
            finally:
1268
 
                for revid, parent_tree in parent_trees:
1269
 
                    parent_tree.unlock()
1270
 
                tree.unlock()
 
1314
            with tree.lock_read():
 
1315
                try:
 
1316
                    parent_ids = tree.get_parent_ids()
 
1317
                    num_parents = len(parent_ids)
 
1318
                    parent_trees = []
 
1319
                    for parent_id in parent_ids:
 
1320
                        parent_tree = tree.branch.repository.revision_tree(
 
1321
                            parent_id)
 
1322
                        parent_trees.append((parent_id, parent_tree))
 
1323
                        parent_tree.lock_read()
 
1324
                    result.set_parent_trees(parent_trees, [])
 
1325
                    result.set_state_from_inventory(tree.root_inventory)
 
1326
                finally:
 
1327
                    for revid, parent_tree in parent_trees:
 
1328
                        parent_tree.unlock()
1271
1329
        except:
1272
1330
            # The caller won't have a chance to unlock this, so make sure we
1273
1331
            # cleanup ourselves
1275
1333
            raise
1276
1334
        return result
1277
1335
 
 
1336
    def _check_delta_is_valid(self, delta):
 
1337
        delta = list(inventory._check_delta_unique_ids(
 
1338
                     inventory._check_delta_unique_old_paths(
 
1339
                         inventory._check_delta_unique_new_paths(
 
1340
                             inventory._check_delta_ids_match_entry(
 
1341
                                 inventory._check_delta_ids_are_valid(
 
1342
                                     inventory._check_delta_new_path_entry_both_or_None(delta)))))))
 
1343
 
 
1344
        def delta_key(d):
 
1345
            (old_path, new_path, file_id, new_entry) = d
 
1346
            if old_path is None:
 
1347
                old_path = ''
 
1348
            if new_path is None:
 
1349
                new_path = ''
 
1350
            return (old_path, new_path, file_id, new_entry)
 
1351
        delta.sort(key=delta_key, reverse=True)
 
1352
        return delta
 
1353
 
1278
1354
    def update_by_delta(self, delta):
1279
1355
        """Apply an inventory delta to the dirstate for tree 0
1280
1356
 
1298
1374
        new_ids = set()
1299
1375
        # This loop transforms the delta to single atomic operations that can
1300
1376
        # be executed and validated.
1301
 
        for old_path, new_path, file_id, inv_entry in sorted(
1302
 
            inventory._check_delta_unique_old_paths(
1303
 
            inventory._check_delta_unique_new_paths(
1304
 
            inventory._check_delta_ids_match_entry(
1305
 
            inventory._check_delta_ids_are_valid(
1306
 
            inventory._check_delta_new_path_entry_both_or_None(delta))))),
1307
 
            reverse=True):
 
1377
        delta = self._check_delta_is_valid(delta)
 
1378
        for old_path, new_path, file_id, inv_entry in delta:
 
1379
            if not isinstance(file_id, bytes):
 
1380
                raise AssertionError(
 
1381
                    "must be a utf8 file_id not %s" % (type(file_id), ))
1308
1382
            if (file_id in insertions) or (file_id in removals):
1309
 
                raise errors.InconsistentDelta(old_path or new_path, file_id,
1310
 
                    "repeated file_id")
 
1383
                self._raise_invalid(old_path or new_path, file_id,
 
1384
                                    "repeated file_id")
1311
1385
            if old_path is not None:
1312
1386
                old_path = old_path.encode('utf-8')
1313
1387
                removals[file_id] = old_path
1315
1389
                new_ids.add(file_id)
1316
1390
            if new_path is not None:
1317
1391
                if inv_entry is None:
1318
 
                    raise errors.InconsistentDelta(new_path, file_id,
1319
 
                        "new_path with no entry")
 
1392
                    self._raise_invalid(new_path, file_id,
 
1393
                                        "new_path with no entry")
1320
1394
                new_path = new_path.encode('utf-8')
1321
1395
                dirname_utf8, basename = osutils.split(new_path)
1322
1396
                if basename:
1323
1397
                    parents.add((dirname_utf8, inv_entry.parent_id))
1324
1398
                key = (dirname_utf8, basename, file_id)
1325
1399
                minikind = DirState._kind_to_minikind[inv_entry.kind]
1326
 
                if minikind == 't':
1327
 
                    fingerprint = inv_entry.reference_revision or ''
 
1400
                if minikind == b't':
 
1401
                    fingerprint = inv_entry.reference_revision or b''
1328
1402
                else:
1329
 
                    fingerprint = ''
 
1403
                    fingerprint = b''
1330
1404
                insertions[file_id] = (key, minikind, inv_entry.executable,
1331
1405
                                       fingerprint, new_path)
1332
1406
            # Transform moves into delete+add pairs
1351
1425
                                               fingerprint, new_child_path)
1352
1426
        self._check_delta_ids_absent(new_ids, delta, 0)
1353
1427
        try:
1354
 
            self._apply_removals(removals.iteritems())
1355
 
            self._apply_insertions(insertions.values())
 
1428
            self._apply_removals(viewitems(removals))
 
1429
            self._apply_insertions(viewvalues(insertions))
1356
1430
            # Validate parents
1357
1431
            self._after_delta_check_parents(parents, 0)
1358
 
        except errors.BzrError, e:
 
1432
        except errors.BzrError as e:
1359
1433
            self._changes_aborted = True
1360
1434
            if 'integrity error' not in str(e):
1361
1435
                raise
1362
1436
            # _get_entry raises BzrError when a request is inconsistent; we
1363
 
            # want such errors to be shown as InconsistentDelta - and that 
 
1437
            # want such errors to be shown as InconsistentDelta - and that
1364
1438
            # fits the behaviour we trigger.
1365
 
            raise errors.InconsistentDeltaDelta(delta, "error from _get_entry.")
 
1439
            raise errors.InconsistentDeltaDelta(delta,
 
1440
                                                "error from _get_entry. %s" % (e,))
1366
1441
 
1367
1442
    def _apply_removals(self, removals):
1368
1443
        for file_id, path in sorted(removals, reverse=True,
1369
 
            key=operator.itemgetter(1)):
 
1444
                                    key=operator.itemgetter(1)):
1370
1445
            dirname, basename = osutils.split(path)
1371
1446
            block_i, entry_i, d_present, f_present = \
1372
1447
                self._get_block_entry_index(dirname, basename, 0)
1373
1448
            try:
1374
1449
                entry = self._dirblocks[block_i][1][entry_i]
1375
1450
            except IndexError:
1376
 
                self._changes_aborted = True
1377
 
                raise errors.InconsistentDelta(path, file_id,
1378
 
                    "Wrong path for old path.")
1379
 
            if not f_present or entry[1][0][0] in 'ar':
1380
 
                self._changes_aborted = True
1381
 
                raise errors.InconsistentDelta(path, file_id,
1382
 
                    "Wrong path for old path.")
 
1451
                self._raise_invalid(path, file_id,
 
1452
                                    "Wrong path for old path.")
 
1453
            if not f_present or entry[1][0][0] in (b'a', b'r'):
 
1454
                self._raise_invalid(path, file_id,
 
1455
                                    "Wrong path for old path.")
1383
1456
            if file_id != entry[0][2]:
1384
 
                self._changes_aborted = True
1385
 
                raise errors.InconsistentDelta(path, file_id,
1386
 
                    "Attempt to remove path has wrong id - found %r."
1387
 
                    % entry[0][2])
 
1457
                self._raise_invalid(path, file_id,
 
1458
                                    "Attempt to remove path has wrong id - found %r."
 
1459
                                    % entry[0][2])
1388
1460
            self._make_absent(entry)
1389
1461
            # See if we have a malformed delta: deleting a directory must not
1390
1462
            # leave crud behind. This increases the number of bisects needed
1392
1464
            # is rare enough it shouldn't be an issue (famous last words?) RBC
1393
1465
            # 20080730.
1394
1466
            block_i, entry_i, d_present, f_present = \
1395
 
                self._get_block_entry_index(path, '', 0)
 
1467
                self._get_block_entry_index(path, b'', 0)
1396
1468
            if d_present:
1397
1469
                # The dir block is still present in the dirstate; this could
1398
1470
                # be due to it being in a parent tree, or a corrupt delta.
1399
1471
                for child_entry in self._dirblocks[block_i][1]:
1400
 
                    if child_entry[1][0][0] not in ('r', 'a'):
1401
 
                        self._changes_aborted = True
1402
 
                        raise errors.InconsistentDelta(path, entry[0][2],
1403
 
                            "The file id was deleted but its children were "
1404
 
                            "not deleted.")
 
1472
                    if child_entry[1][0][0] not in (b'r', b'a'):
 
1473
                        self._raise_invalid(path, entry[0][2],
 
1474
                                            "The file id was deleted but its children were "
 
1475
                                            "not deleted.")
1405
1476
 
1406
1477
    def _apply_insertions(self, adds):
1407
1478
        try:
1409
1480
                self.update_minimal(key, minikind, executable, fingerprint,
1410
1481
                                    path_utf8=path_utf8)
1411
1482
        except errors.NotVersionedError:
1412
 
            self._changes_aborted = True
1413
 
            raise errors.InconsistentDelta(path_utf8.decode('utf8'), key[2],
1414
 
                "Missing parent")
 
1483
            self._raise_invalid(path_utf8.decode('utf8'), key[2],
 
1484
                                "Missing parent")
1415
1485
 
1416
1486
    def update_basis_by_delta(self, delta, new_revid):
1417
1487
        """Update the parents of this tree after a commit.
1424
1494
        Note that an exception during the operation of this method will leave
1425
1495
        the dirstate in a corrupt state where it should not be saved.
1426
1496
 
1427
 
        Finally, we expect all changes to be synchronising the basis tree with
1428
 
        the working tree.
1429
 
 
1430
1497
        :param new_revid: The new revision id for the trees parent.
1431
1498
        :param delta: An inventory delta (see apply_inventory_delta) describing
1432
1499
            the changes from the current left most parent revision to new_revid.
1444
1511
 
1445
1512
        self._parents[0] = new_revid
1446
1513
 
1447
 
        delta = sorted(delta, reverse=True)
 
1514
        delta = self._check_delta_is_valid(delta)
1448
1515
        adds = []
1449
1516
        changes = []
1450
1517
        deletes = []
1470
1537
        # ids.
1471
1538
        new_ids = set()
1472
1539
        for old_path, new_path, file_id, inv_entry in delta:
 
1540
            if file_id.__class__ is not bytes:
 
1541
                raise AssertionError(
 
1542
                    "must be a utf8 file_id not %s" % (type(file_id), ))
1473
1543
            if inv_entry is not None and file_id != inv_entry.file_id:
1474
 
                raise errors.InconsistentDelta(new_path, file_id,
1475
 
                    "mismatched entry file_id %r" % inv_entry)
1476
 
            if new_path is not None:
 
1544
                self._raise_invalid(new_path, file_id,
 
1545
                                    "mismatched entry file_id %r" % inv_entry)
 
1546
            if new_path is None:
 
1547
                new_path_utf8 = None
 
1548
            else:
1477
1549
                if inv_entry is None:
1478
 
                    raise errors.InconsistentDelta(new_path, file_id,
1479
 
                        "new_path with no entry")
 
1550
                    self._raise_invalid(new_path, file_id,
 
1551
                                        "new_path with no entry")
1480
1552
                new_path_utf8 = encode(new_path)
1481
1553
                # note the parent for validation
1482
1554
                dirname_utf8, basename_utf8 = osutils.split(new_path_utf8)
1483
1555
                if basename_utf8:
1484
1556
                    parents.add((dirname_utf8, inv_entry.parent_id))
1485
1557
            if old_path is None:
1486
 
                adds.append((None, encode(new_path), file_id,
1487
 
                    inv_to_entry(inv_entry), True))
 
1558
                old_path_utf8 = None
 
1559
            else:
 
1560
                old_path_utf8 = encode(old_path)
 
1561
            if old_path is None:
 
1562
                adds.append((None, new_path_utf8, file_id,
 
1563
                             inv_to_entry(inv_entry), True))
1488
1564
                new_ids.add(file_id)
1489
1565
            elif new_path is None:
1490
 
                deletes.append((encode(old_path), None, file_id, None, True))
1491
 
            elif (old_path, new_path) != root_only:
 
1566
                deletes.append((old_path_utf8, None, file_id, None, True))
 
1567
            elif (old_path, new_path) == root_only:
 
1568
                # change things in-place
 
1569
                # Note: the case of a parent directory changing its file_id
 
1570
                #       tends to break optimizations here, because officially
 
1571
                #       the file has actually been moved, it just happens to
 
1572
                #       end up at the same path. If we can figure out how to
 
1573
                #       handle that case, we can avoid a lot of add+delete
 
1574
                #       pairs for objects that stay put.
 
1575
                # elif old_path == new_path:
 
1576
                changes.append((old_path_utf8, new_path_utf8, file_id,
 
1577
                                inv_to_entry(inv_entry)))
 
1578
            else:
1492
1579
                # Renames:
1493
1580
                # Because renames must preserve their children we must have
1494
1581
                # processed all relocations and removes before hand. The sort
1497
1584
                # pair will result in the deleted item being reinserted, or
1498
1585
                # renamed items being reinserted twice - and possibly at the
1499
1586
                # wrong place. Splitting into a delete/add pair also simplifies
1500
 
                # the handling of entries with ('f', ...), ('r' ...) because
1501
 
                # the target of the 'r' is old_path here, and we add that to
 
1587
                # the handling of entries with (b'f', ...), (b'r' ...) because
 
1588
                # the target of the b'r' is old_path here, and we add that to
1502
1589
                # deletes, meaning that the add handler does not need to check
1503
 
                # for 'r' items on every pass.
 
1590
                # for b'r' items on every pass.
1504
1591
                self._update_basis_apply_deletes(deletes)
1505
1592
                deletes = []
1506
1593
                # Split into an add/delete pair recursively.
1507
 
                adds.append((None, new_path_utf8, file_id,
1508
 
                    inv_to_entry(inv_entry), False))
 
1594
                adds.append((old_path_utf8, new_path_utf8, file_id,
 
1595
                             inv_to_entry(inv_entry), False))
1509
1596
                # Expunge deletes that we've seen so that deleted/renamed
1510
1597
                # children of a rename directory are handled correctly.
1511
 
                new_deletes = reversed(list(self._iter_child_entries(1,
1512
 
                    encode(old_path))))
 
1598
                new_deletes = reversed(list(
 
1599
                    self._iter_child_entries(1, old_path_utf8)))
1513
1600
                # Remove the current contents of the tree at orig_path, and
1514
1601
                # reinsert at the correct new path.
1515
1602
                for entry in new_deletes:
1516
 
                    if entry[0][0]:
1517
 
                        source_path = entry[0][0] + '/' + entry[0][1]
 
1603
                    child_dirname, child_basename, child_file_id = entry[0]
 
1604
                    if child_dirname:
 
1605
                        source_path = child_dirname + b'/' + child_basename
1518
1606
                    else:
1519
 
                        source_path = entry[0][1]
 
1607
                        source_path = child_basename
1520
1608
                    if new_path_utf8:
1521
 
                        target_path = new_path_utf8 + source_path[len(old_path):]
 
1609
                        target_path = \
 
1610
                            new_path_utf8 + source_path[len(old_path_utf8):]
1522
1611
                    else:
1523
 
                        if old_path == '':
 
1612
                        if old_path_utf8 == b'':
1524
1613
                            raise AssertionError("cannot rename directory to"
1525
 
                                " itself")
1526
 
                        target_path = source_path[len(old_path) + 1:]
1527
 
                    adds.append((None, target_path, entry[0][2], entry[1][1], False))
 
1614
                                                 " itself")
 
1615
                        target_path = source_path[len(old_path_utf8) + 1:]
 
1616
                    adds.append(
 
1617
                        (None, target_path, entry[0][2], entry[1][1], False))
1528
1618
                    deletes.append(
1529
1619
                        (source_path, target_path, entry[0][2], None, False))
1530
1620
                deletes.append(
1531
 
                    (encode(old_path), new_path, file_id, None, False))
1532
 
            else:
1533
 
                # changes to just the root should not require remove/insertion
1534
 
                # of everything.
1535
 
                changes.append((encode(old_path), encode(new_path), file_id,
1536
 
                    inv_to_entry(inv_entry)))
 
1621
                    (old_path_utf8, new_path_utf8, file_id, None, False))
 
1622
 
1537
1623
        self._check_delta_ids_absent(new_ids, delta, 1)
1538
1624
        try:
1539
1625
            # Finish expunging deletes/first half of renames.
1544
1630
            self._update_basis_apply_changes(changes)
1545
1631
            # Validate parents
1546
1632
            self._after_delta_check_parents(parents, 1)
1547
 
        except errors.BzrError, e:
 
1633
        except errors.BzrError as e:
1548
1634
            self._changes_aborted = True
1549
1635
            if 'integrity error' not in str(e):
1550
1636
                raise
1551
1637
            # _get_entry raises BzrError when a request is inconsistent; we
1552
 
            # want such errors to be shown as InconsistentDelta - and that 
1553
 
            # fits the behaviour we trigger. Partof this is driven by dirstate
1554
 
            # only supporting deltas that turn the basis into a closer fit to
1555
 
            # the active tree.
1556
 
            raise errors.InconsistentDeltaDelta(delta, "error from _get_entry.")
 
1638
            # want such errors to be shown as InconsistentDelta - and that
 
1639
            # fits the behaviour we trigger.
 
1640
            raise errors.InconsistentDeltaDelta(delta,
 
1641
                                                "error from _get_entry. %s" % (e,))
1557
1642
 
1558
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
1559
 
        self._header_state = DirState.IN_MEMORY_MODIFIED
 
1643
        self._mark_modified(header_modified=True)
1560
1644
        self._id_index = None
1561
1645
        return
1562
1646
 
1566
1650
            return
1567
1651
        id_index = self._get_id_index()
1568
1652
        for file_id in new_ids:
1569
 
            for key in id_index.get(file_id, []):
 
1653
            for key in id_index.get(file_id, ()):
1570
1654
                block_i, entry_i, d_present, f_present = \
1571
1655
                    self._get_block_entry_index(key[0], key[1], tree_index)
1572
1656
                if not f_present:
1576
1660
                if entry[0][2] != file_id:
1577
1661
                    # Different file_id, so not what we want.
1578
1662
                    continue
1579
 
                # NB: No changes made before this helper is called, so no need
1580
 
                # to set the _changes_aborted flag.
1581
 
                raise errors.InconsistentDelta(
1582
 
                    ("%s/%s" % key[0:2]).decode('utf8'), file_id,
1583
 
                    "This file_id is new in the delta but already present in "
1584
 
                    "the target")
 
1663
                self._raise_invalid((b"%s/%s" % key[0:2]).decode('utf8'), file_id,
 
1664
                                    "This file_id is new in the delta but already present in "
 
1665
                                    "the target")
 
1666
 
 
1667
    def _raise_invalid(self, path, file_id, reason):
 
1668
        self._changes_aborted = True
 
1669
        raise errors.InconsistentDelta(path, file_id, reason)
1585
1670
 
1586
1671
    def _update_basis_apply_adds(self, adds):
1587
1672
        """Apply a sequence of adds to tree 1 during update_basis_by_delta.
1596
1681
        """
1597
1682
        # Adds are accumulated partly from renames, so can be in any input
1598
1683
        # order - sort it.
1599
 
        adds.sort()
 
1684
        # TODO: we may want to sort in dirblocks order. That way each entry
 
1685
        #       will end up in the same directory, allowing the _get_entry
 
1686
        #       fast-path for looking up 2 items in the same dir work.
 
1687
        adds.sort(key=lambda x: x[1])
1600
1688
        # adds is now in lexographic order, which places all parents before
1601
1689
        # their children, so we can process it linearly.
1602
 
        absent = 'ar'
 
1690
        st = static_tuple.StaticTuple
1603
1691
        for old_path, new_path, file_id, new_details, real_add in adds:
1604
 
            # the entry for this file_id must be in tree 0.
1605
 
            entry = self._get_entry(0, file_id, new_path)
1606
 
            if entry[0] is None or entry[0][2] != file_id:
1607
 
                self._changes_aborted = True
1608
 
                raise errors.InconsistentDelta(new_path, file_id,
1609
 
                    'working tree does not contain new entry')
1610
 
            if real_add and entry[1][1][0] not in absent:
1611
 
                self._changes_aborted = True
1612
 
                raise errors.InconsistentDelta(new_path, file_id,
1613
 
                    'The entry was considered to be a genuinely new record,'
1614
 
                    ' but there was already an old record for it.')
1615
 
            # We don't need to update the target of an 'r' because the handling
1616
 
            # of renames turns all 'r' situations into a delete at the original
1617
 
            # location.
1618
 
            entry[1][1] = new_details
 
1692
            dirname, basename = osutils.split(new_path)
 
1693
            entry_key = st(dirname, basename, file_id)
 
1694
            block_index, present = self._find_block_index_from_key(entry_key)
 
1695
            if not present:
 
1696
                # The block where we want to put the file is not present.
 
1697
                # However, it might have just been an empty directory. Look for
 
1698
                # the parent in the basis-so-far before throwing an error.
 
1699
                parent_dir, parent_base = osutils.split(dirname)
 
1700
                parent_block_idx, parent_entry_idx, _, parent_present = \
 
1701
                    self._get_block_entry_index(parent_dir, parent_base, 1)
 
1702
                if not parent_present:
 
1703
                    self._raise_invalid(new_path, file_id,
 
1704
                                        "Unable to find block for this record."
 
1705
                                        " Was the parent added?")
 
1706
                self._ensure_block(parent_block_idx, parent_entry_idx, dirname)
 
1707
 
 
1708
            block = self._dirblocks[block_index][1]
 
1709
            entry_index, present = self._find_entry_index(entry_key, block)
 
1710
            if real_add:
 
1711
                if old_path is not None:
 
1712
                    self._raise_invalid(new_path, file_id,
 
1713
                                        'considered a real add but still had old_path at %s'
 
1714
                                        % (old_path,))
 
1715
            if present:
 
1716
                entry = block[entry_index]
 
1717
                basis_kind = entry[1][1][0]
 
1718
                if basis_kind == b'a':
 
1719
                    entry[1][1] = new_details
 
1720
                elif basis_kind == b'r':
 
1721
                    raise NotImplementedError()
 
1722
                else:
 
1723
                    self._raise_invalid(new_path, file_id,
 
1724
                                        "An entry was marked as a new add"
 
1725
                                        " but the basis target already existed")
 
1726
            else:
 
1727
                # The exact key was not found in the block. However, we need to
 
1728
                # check if there is a key next to us that would have matched.
 
1729
                # We only need to check 2 locations, because there are only 2
 
1730
                # trees present.
 
1731
                for maybe_index in range(entry_index - 1, entry_index + 1):
 
1732
                    if maybe_index < 0 or maybe_index >= len(block):
 
1733
                        continue
 
1734
                    maybe_entry = block[maybe_index]
 
1735
                    if maybe_entry[0][:2] != (dirname, basename):
 
1736
                        # Just a random neighbor
 
1737
                        continue
 
1738
                    if maybe_entry[0][2] == file_id:
 
1739
                        raise AssertionError(
 
1740
                            '_find_entry_index didnt find a key match'
 
1741
                            ' but walking the data did, for %s'
 
1742
                            % (entry_key,))
 
1743
                    basis_kind = maybe_entry[1][1][0]
 
1744
                    if basis_kind not in (b'a', b'r'):
 
1745
                        self._raise_invalid(new_path, file_id,
 
1746
                                            "we have an add record for path, but the path"
 
1747
                                            " is already present with another file_id %s"
 
1748
                                            % (maybe_entry[0][2],))
 
1749
 
 
1750
                entry = (entry_key, [DirState.NULL_PARENT_DETAILS,
 
1751
                                     new_details])
 
1752
                block.insert(entry_index, entry)
 
1753
 
 
1754
            active_kind = entry[1][0][0]
 
1755
            if active_kind == b'a':
 
1756
                # The active record shows up as absent, this could be genuine,
 
1757
                # or it could be present at some other location. We need to
 
1758
                # verify.
 
1759
                id_index = self._get_id_index()
 
1760
                # The id_index may not be perfectly accurate for tree1, because
 
1761
                # we haven't been keeping it updated. However, it should be
 
1762
                # fine for tree0, and that gives us enough info for what we
 
1763
                # need
 
1764
                keys = id_index.get(file_id, ())
 
1765
                for key in keys:
 
1766
                    block_i, entry_i, d_present, f_present = \
 
1767
                        self._get_block_entry_index(key[0], key[1], 0)
 
1768
                    if not f_present:
 
1769
                        continue
 
1770
                    active_entry = self._dirblocks[block_i][1][entry_i]
 
1771
                    if (active_entry[0][2] != file_id):
 
1772
                        # Some other file is at this path, we don't need to
 
1773
                        # link it.
 
1774
                        continue
 
1775
                    real_active_kind = active_entry[1][0][0]
 
1776
                    if real_active_kind in (b'a', b'r'):
 
1777
                        # We found a record, which was not *this* record,
 
1778
                        # which matches the file_id, but is not actually
 
1779
                        # present. Something seems *really* wrong.
 
1780
                        self._raise_invalid(new_path, file_id,
 
1781
                                            "We found a tree0 entry that doesnt make sense")
 
1782
                    # Now, we've found a tree0 entry which matches the file_id
 
1783
                    # but is at a different location. So update them to be
 
1784
                    # rename records.
 
1785
                    active_dir, active_name = active_entry[0][:2]
 
1786
                    if active_dir:
 
1787
                        active_path = active_dir + b'/' + active_name
 
1788
                    else:
 
1789
                        active_path = active_name
 
1790
                    active_entry[1][1] = st(b'r', new_path, 0, False, b'')
 
1791
                    entry[1][0] = st(b'r', active_path, 0, False, b'')
 
1792
            elif active_kind == b'r':
 
1793
                raise NotImplementedError()
 
1794
 
 
1795
            new_kind = new_details[0]
 
1796
            if new_kind == b'd':
 
1797
                self._ensure_block(block_index, entry_index, new_path)
1619
1798
 
1620
1799
    def _update_basis_apply_changes(self, changes):
1621
1800
        """Apply a sequence of changes to tree 1 during update_basis_by_delta.
1623
1802
        :param adds: A sequence of changes. Each change is a tuple:
1624
1803
            (path_utf8, path_utf8, file_id, (entry_details))
1625
1804
        """
1626
 
        absent = 'ar'
1627
1805
        for old_path, new_path, file_id, new_details in changes:
1628
1806
            # the entry for this file_id must be in tree 0.
1629
 
            entry = self._get_entry(0, file_id, new_path)
1630
 
            if entry[0] is None or entry[0][2] != file_id:
1631
 
                self._changes_aborted = True
1632
 
                raise errors.InconsistentDelta(new_path, file_id,
1633
 
                    'working tree does not contain new entry')
1634
 
            if (entry[1][0][0] in absent or
1635
 
                entry[1][1][0] in absent):
1636
 
                self._changes_aborted = True
1637
 
                raise errors.InconsistentDelta(new_path, file_id,
1638
 
                    'changed considered absent')
 
1807
            entry = self._get_entry(1, file_id, new_path)
 
1808
            if entry[0] is None or entry[1][1][0] in (b'a', b'r'):
 
1809
                self._raise_invalid(new_path, file_id,
 
1810
                                    'changed entry considered not present')
1639
1811
            entry[1][1] = new_details
1640
1812
 
1641
1813
    def _update_basis_apply_deletes(self, deletes):
1653
1825
        null = DirState.NULL_PARENT_DETAILS
1654
1826
        for old_path, new_path, file_id, _, real_delete in deletes:
1655
1827
            if real_delete != (new_path is None):
1656
 
                self._changes_aborted = True
1657
 
                raise AssertionError("bad delete delta")
 
1828
                self._raise_invalid(old_path, file_id, "bad delete delta")
1658
1829
            # the entry for this file_id must be in tree 1.
1659
1830
            dirname, basename = osutils.split(old_path)
1660
1831
            block_index, entry_index, dir_present, file_present = \
1661
1832
                self._get_block_entry_index(dirname, basename, 1)
1662
1833
            if not file_present:
1663
 
                self._changes_aborted = True
1664
 
                raise errors.InconsistentDelta(old_path, file_id,
1665
 
                    'basis tree does not contain removed entry')
 
1834
                self._raise_invalid(old_path, file_id,
 
1835
                                    'basis tree does not contain removed entry')
1666
1836
            entry = self._dirblocks[block_index][1][entry_index]
 
1837
            # The state of the entry in the 'active' WT
 
1838
            active_kind = entry[1][0][0]
1667
1839
            if entry[0][2] != file_id:
1668
 
                self._changes_aborted = True
1669
 
                raise errors.InconsistentDelta(old_path, file_id,
1670
 
                    'mismatched file_id in tree 1')
1671
 
            if real_delete:
1672
 
                if entry[1][0][0] != 'a':
1673
 
                    self._changes_aborted = True
1674
 
                    raise errors.InconsistentDelta(old_path, file_id,
1675
 
                            'This was marked as a real delete, but the WT state'
1676
 
                            ' claims that it still exists and is versioned.')
 
1840
                self._raise_invalid(old_path, file_id,
 
1841
                                    'mismatched file_id in tree 1')
 
1842
            dir_block = ()
 
1843
            old_kind = entry[1][1][0]
 
1844
            if active_kind in b'ar':
 
1845
                # The active tree doesn't have this file_id.
 
1846
                # The basis tree is changing this record. If this is a
 
1847
                # rename, then we don't want the record here at all
 
1848
                # anymore. If it is just an in-place change, we want the
 
1849
                # record here, but we'll add it if we need to. So we just
 
1850
                # delete it
 
1851
                if active_kind == b'r':
 
1852
                    active_path = entry[1][0][1]
 
1853
                    active_entry = self._get_entry(0, file_id, active_path)
 
1854
                    if active_entry[1][1][0] != b'r':
 
1855
                        self._raise_invalid(old_path, file_id,
 
1856
                                            "Dirstate did not have matching rename entries")
 
1857
                    elif active_entry[1][0][0] in b'ar':
 
1858
                        self._raise_invalid(old_path, file_id,
 
1859
                                            "Dirstate had a rename pointing at an inactive"
 
1860
                                            " tree0")
 
1861
                    active_entry[1][1] = null
1677
1862
                del self._dirblocks[block_index][1][entry_index]
 
1863
                if old_kind == b'd':
 
1864
                    # This was a directory, and the active tree says it
 
1865
                    # doesn't exist, and now the basis tree says it doesn't
 
1866
                    # exist. Remove its dirblock if present
 
1867
                    (dir_block_index,
 
1868
                     present) = self._find_block_index_from_key(
 
1869
                        (old_path, b'', b''))
 
1870
                    if present:
 
1871
                        dir_block = self._dirblocks[dir_block_index][1]
 
1872
                        if not dir_block:
 
1873
                            # This entry is empty, go ahead and just remove it
 
1874
                            del self._dirblocks[dir_block_index]
1678
1875
            else:
1679
 
                if entry[1][0][0] == 'a':
1680
 
                    self._changes_aborted = True
1681
 
                    raise errors.InconsistentDelta(old_path, file_id,
1682
 
                        'The entry was considered a rename, but the source path'
1683
 
                        ' is marked as absent.')
1684
 
                    # For whatever reason, we were asked to rename an entry
1685
 
                    # that was originally marked as deleted. This could be
1686
 
                    # because we are renaming the parent directory, and the WT
1687
 
                    # current state has the file marked as deleted.
1688
 
                elif entry[1][0][0] == 'r':
1689
 
                    # implement the rename
1690
 
                    del self._dirblocks[block_index][1][entry_index]
1691
 
                else:
1692
 
                    # it is being resurrected here, so blank it out temporarily.
1693
 
                    self._dirblocks[block_index][1][entry_index][1][1] = null
 
1876
                # There is still an active record, so just mark this
 
1877
                # removed.
 
1878
                entry[1][1] = null
 
1879
                block_i, entry_i, d_present, f_present = \
 
1880
                    self._get_block_entry_index(old_path, b'', 1)
 
1881
                if d_present:
 
1882
                    dir_block = self._dirblocks[block_i][1]
 
1883
            for child_entry in dir_block:
 
1884
                child_basis_kind = child_entry[1][1][0]
 
1885
                if child_basis_kind not in b'ar':
 
1886
                    self._raise_invalid(old_path, file_id,
 
1887
                                        "The file id was deleted but its children were "
 
1888
                                        "not deleted.")
1694
1889
 
1695
1890
    def _after_delta_check_parents(self, parents, index):
1696
1891
        """Check that parents required by the delta are all intact.
1697
 
        
 
1892
 
1698
1893
        :param parents: An iterable of (path_utf8, file_id) tuples which are
1699
1894
            required to be present in tree 'index' at path_utf8 with id file_id
1700
1895
            and be a directory.
1705
1900
            # has the right file id.
1706
1901
            entry = self._get_entry(index, file_id, dirname_utf8)
1707
1902
            if entry[1] is None:
1708
 
                self._changes_aborted = True
1709
 
                raise errors.InconsistentDelta(dirname_utf8.decode('utf8'),
1710
 
                    file_id, "This parent is not present.")
 
1903
                self._raise_invalid(dirname_utf8.decode('utf8'),
 
1904
                                    file_id, "This parent is not present.")
1711
1905
            # Parents of things must be directories
1712
 
            if entry[1][index][0] != 'd':
1713
 
                self._changes_aborted = True
1714
 
                raise errors.InconsistentDelta(dirname_utf8.decode('utf8'),
1715
 
                    file_id, "This parent is not a directory.")
 
1906
            if entry[1][index][0] != b'd':
 
1907
                self._raise_invalid(dirname_utf8.decode('utf8'),
 
1908
                                    file_id, "This parent is not a directory.")
1716
1909
 
1717
1910
    def _observed_sha1(self, entry, sha1, stat_value,
1718
 
        _stat_to_minikind=_stat_to_minikind, _pack_stat=pack_stat):
 
1911
                       _stat_to_minikind=_stat_to_minikind):
1719
1912
        """Note the sha1 of a file.
1720
1913
 
1721
1914
        :param entry: The entry the sha1 is for.
1723
1916
        :param stat_value: The os.lstat for the file.
1724
1917
        """
1725
1918
        try:
1726
 
            minikind = _stat_to_minikind[stat_value.st_mode & 0170000]
 
1919
            minikind = _stat_to_minikind[stat_value.st_mode & 0o170000]
1727
1920
        except KeyError:
1728
1921
            # Unhandled kind
1729
1922
            return None
1730
 
        packed_stat = _pack_stat(stat_value)
1731
 
        if minikind == 'f':
 
1923
        if minikind == b'f':
1732
1924
            if self._cutoff_time is None:
1733
1925
                self._sha_cutoff_time()
1734
1926
            if (stat_value.st_mtime < self._cutoff_time
1735
 
                and stat_value.st_ctime < self._cutoff_time):
1736
 
                entry[1][0] = ('f', sha1, entry[1][0][2], entry[1][0][3],
1737
 
                    packed_stat)
1738
 
                self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
1927
                    and stat_value.st_ctime < self._cutoff_time):
 
1928
                entry[1][0] = (b'f', sha1, stat_value.st_size, entry[1][0][3],
 
1929
                               pack_stat(stat_value))
 
1930
                self._mark_modified([entry])
1739
1931
 
1740
1932
    def _sha_cutoff_time(self):
1741
1933
        """Return cutoff time.
1762
1954
 
1763
1955
    def _is_executable(self, mode, old_executable):
1764
1956
        """Is this file executable?"""
1765
 
        return bool(S_IEXEC & mode)
1766
 
 
1767
 
    def _is_executable_win32(self, mode, old_executable):
1768
 
        """On win32 the executable bit is stored in the dirstate."""
1769
 
        return old_executable
1770
 
 
1771
 
    if sys.platform == 'win32':
1772
 
        _is_executable = _is_executable_win32
 
1957
        if self._use_filesystem_for_exec:
 
1958
            return bool(S_IEXEC & mode)
 
1959
        else:
 
1960
            return old_executable
1773
1961
 
1774
1962
    def _read_link(self, abspath, old_link):
1775
1963
        """Read the target of a symlink"""
1778
1966
        #       higher level, because there either won't be anything on disk,
1779
1967
        #       or the thing on disk will be a file.
1780
1968
        fs_encoding = osutils._fs_enc
1781
 
        if isinstance(abspath, unicode):
 
1969
        if isinstance(abspath, text_type):
1782
1970
            # abspath is defined as the path to pass to lstat. readlink is
1783
1971
            # buggy in python < 2.6 (it doesn't encode unicode path into FS
1784
1972
            # encoding), so we need to encode ourselves knowing that unicode
1785
1973
            # paths are produced by UnicodeDirReader on purpose.
1786
1974
            abspath = abspath.encode(fs_encoding)
1787
1975
        target = os.readlink(abspath)
1788
 
        if fs_encoding not in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
 
1976
        if fs_encoding not in ('utf-8', 'ascii'):
1789
1977
            # Change encoding if needed
1790
1978
            target = target.decode(fs_encoding).encode('UTF-8')
1791
1979
        return target
1798
1986
    def get_lines(self):
1799
1987
        """Serialise the entire dirstate to a sequence of lines."""
1800
1988
        if (self._header_state == DirState.IN_MEMORY_UNMODIFIED and
1801
 
            self._dirblock_state == DirState.IN_MEMORY_UNMODIFIED):
1802
 
            # read whats on disk.
 
1989
                self._dirblock_state == DirState.IN_MEMORY_UNMODIFIED):
 
1990
            # read what's on disk.
1803
1991
            self._state_file.seek(0)
1804
1992
            return self._state_file.readlines()
1805
1993
        lines = []
1806
1994
        lines.append(self._get_parents_line(self.get_parent_ids()))
1807
1995
        lines.append(self._get_ghosts_line(self._ghosts))
1808
 
        # append the root line which is special cased
1809
 
        lines.extend(map(self._entry_to_line, self._iter_entries()))
 
1996
        lines.extend(self._iter_entry_lines())
1810
1997
        return self._get_output_lines(lines)
1811
1998
 
1812
1999
    def _get_ghosts_line(self, ghost_ids):
1813
2000
        """Create a line for the state file for ghost information."""
1814
 
        return '\0'.join([str(len(ghost_ids))] + ghost_ids)
 
2001
        return b'\0'.join([b'%d' % len(ghost_ids)] + ghost_ids)
1815
2002
 
1816
2003
    def _get_parents_line(self, parent_ids):
1817
2004
        """Create a line for the state file for parents information."""
1818
 
        return '\0'.join([str(len(parent_ids))] + parent_ids)
 
2005
        return b'\0'.join([b'%d' % len(parent_ids)] + parent_ids)
 
2006
 
 
2007
    def _iter_entry_lines(self):
 
2008
        """Create lines for entries."""
 
2009
        return map(self._entry_to_line, self._iter_entries())
1819
2010
 
1820
2011
    def _get_fields_to_entry(self):
1821
2012
        """Get a function which converts entry fields into a entry record.
1831
2022
            def fields_to_entry_0_parents(fields, _int=int):
1832
2023
                path_name_file_id_key = (fields[0], fields[1], fields[2])
1833
2024
                return (path_name_file_id_key, [
1834
 
                    ( # Current tree
 
2025
                    (  # Current tree
1835
2026
                        fields[3],                # minikind
1836
2027
                        fields[4],                # fingerprint
1837
2028
                        _int(fields[5]),          # size
1838
 
                        fields[6] == 'y',         # executable
 
2029
                        fields[6] == b'y',         # executable
1839
2030
                        fields[7],                # packed_stat or revision_id
1840
2031
                    )])
1841
2032
            return fields_to_entry_0_parents
1843
2034
            def fields_to_entry_1_parent(fields, _int=int):
1844
2035
                path_name_file_id_key = (fields[0], fields[1], fields[2])
1845
2036
                return (path_name_file_id_key, [
1846
 
                    ( # Current tree
 
2037
                    (  # Current tree
1847
2038
                        fields[3],                # minikind
1848
2039
                        fields[4],                # fingerprint
1849
2040
                        _int(fields[5]),          # size
1850
 
                        fields[6] == 'y',         # executable
 
2041
                        fields[6] == b'y',         # executable
1851
2042
                        fields[7],                # packed_stat or revision_id
1852
2043
                    ),
1853
 
                    ( # Parent 1
 
2044
                    (  # Parent 1
1854
2045
                        fields[8],                # minikind
1855
2046
                        fields[9],                # fingerprint
1856
2047
                        _int(fields[10]),         # size
1857
 
                        fields[11] == 'y',        # executable
 
2048
                        fields[11] == b'y',        # executable
1858
2049
                        fields[12],               # packed_stat or revision_id
1859
2050
                    ),
1860
2051
                    ])
1863
2054
            def fields_to_entry_2_parents(fields, _int=int):
1864
2055
                path_name_file_id_key = (fields[0], fields[1], fields[2])
1865
2056
                return (path_name_file_id_key, [
1866
 
                    ( # Current tree
 
2057
                    (  # Current tree
1867
2058
                        fields[3],                # minikind
1868
2059
                        fields[4],                # fingerprint
1869
2060
                        _int(fields[5]),          # size
1870
 
                        fields[6] == 'y',         # executable
 
2061
                        fields[6] == b'y',         # executable
1871
2062
                        fields[7],                # packed_stat or revision_id
1872
2063
                    ),
1873
 
                    ( # Parent 1
 
2064
                    (  # Parent 1
1874
2065
                        fields[8],                # minikind
1875
2066
                        fields[9],                # fingerprint
1876
2067
                        _int(fields[10]),         # size
1877
 
                        fields[11] == 'y',        # executable
 
2068
                        fields[11] == b'y',        # executable
1878
2069
                        fields[12],               # packed_stat or revision_id
1879
2070
                    ),
1880
 
                    ( # Parent 2
 
2071
                    (  # Parent 2
1881
2072
                        fields[13],               # minikind
1882
2073
                        fields[14],               # fingerprint
1883
2074
                        _int(fields[15]),         # size
1884
 
                        fields[16] == 'y',        # executable
 
2075
                        fields[16] == b'y',        # executable
1885
2076
                        fields[17],               # packed_stat or revision_id
1886
2077
                    ),
1887
2078
                    ])
1890
2081
            def fields_to_entry_n_parents(fields, _int=int):
1891
2082
                path_name_file_id_key = (fields[0], fields[1], fields[2])
1892
2083
                trees = [(fields[cur],                # minikind
1893
 
                          fields[cur+1],              # fingerprint
1894
 
                          _int(fields[cur+2]),        # size
1895
 
                          fields[cur+3] == 'y',       # executable
1896
 
                          fields[cur+4],              # stat or revision_id
1897
 
                         ) for cur in xrange(3, len(fields)-1, 5)]
 
2084
                          fields[cur + 1],              # fingerprint
 
2085
                          _int(fields[cur + 2]),        # size
 
2086
                          fields[cur + 3] == b'y',       # executable
 
2087
                          fields[cur + 4],              # stat or revision_id
 
2088
                          ) for cur in range(3, len(fields) - 1, 5)]
1898
2089
                return path_name_file_id_key, trees
1899
2090
            return fields_to_entry_n_parents
1900
2091
 
1924
2115
            tree present there.
1925
2116
        """
1926
2117
        self._read_dirblocks_if_needed()
1927
 
        key = dirname, basename, ''
 
2118
        key = dirname, basename, b''
1928
2119
        block_index, present = self._find_block_index_from_key(key)
1929
2120
        if not present:
1930
2121
            # no such directory - return the dir index and 0 for the row.
1931
2122
            return block_index, 0, False, False
1932
 
        block = self._dirblocks[block_index][1] # access the entries only
 
2123
        block = self._dirblocks[block_index][1]  # access the entries only
1933
2124
        entry_index, present = self._find_entry_index(key, block)
1934
2125
        # linear search through entries at this path to find the one
1935
2126
        # requested.
1936
2127
        while entry_index < len(block) and block[entry_index][0][1] == basename:
1937
 
            if block[entry_index][1][tree_index][0] not in 'ar':
 
2128
            if block[entry_index][1][tree_index][0] not in (b'a', b'r'):
1938
2129
                # neither absent or relocated
1939
2130
                return block_index, entry_index, True, True
1940
2131
            entry_index += 1
1941
2132
        return block_index, entry_index, True, False
1942
2133
 
1943
 
    def _get_entry(self, tree_index, fileid_utf8=None, path_utf8=None, include_deleted=False):
 
2134
    def _get_entry(self, tree_index, fileid_utf8=None, path_utf8=None,
 
2135
                   include_deleted=False):
1944
2136
        """Get the dirstate entry for path in tree tree_index.
1945
2137
 
1946
2138
        If either file_id or path is supplied, it is used as the key to lookup.
1961
2153
        """
1962
2154
        self._read_dirblocks_if_needed()
1963
2155
        if path_utf8 is not None:
1964
 
            if type(path_utf8) is not str:
1965
 
                raise errors.BzrError('path_utf8 is not a str: %s %r'
1966
 
                    % (type(path_utf8), path_utf8))
 
2156
            if not isinstance(path_utf8, bytes):
 
2157
                raise errors.BzrError('path_utf8 is not bytes: %s %r'
 
2158
                                      % (type(path_utf8), path_utf8))
1967
2159
            # path lookups are faster
1968
2160
            dirname, basename = osutils.split(path_utf8)
1969
2161
            block_index, entry_index, dir_present, file_present = \
1971
2163
            if not file_present:
1972
2164
                return None, None
1973
2165
            entry = self._dirblocks[block_index][1][entry_index]
1974
 
            if not (entry[0][2] and entry[1][tree_index][0] not in ('a', 'r')):
 
2166
            if not (entry[0][2] and entry[1][tree_index][0] not in (b'a', b'r')):
1975
2167
                raise AssertionError('unversioned entry?')
1976
2168
            if fileid_utf8:
1977
2169
                if entry[0][2] != fileid_utf8:
1980
2172
                                          ' tree_index, file_id and path')
1981
2173
            return entry
1982
2174
        else:
1983
 
            possible_keys = self._get_id_index().get(fileid_utf8, None)
 
2175
            possible_keys = self._get_id_index().get(fileid_utf8, ())
1984
2176
            if not possible_keys:
1985
2177
                return None, None
1986
2178
            for key in possible_keys:
1999
2191
                    entry = self._dirblocks[block_index][1][entry_index]
2000
2192
                    # TODO: We might want to assert that entry[0][2] ==
2001
2193
                    #       fileid_utf8.
2002
 
                    if entry[1][tree_index][0] in 'fdlt':
 
2194
                    # GZ 2017-06-09: Hoist set of minkinds somewhere
 
2195
                    if entry[1][tree_index][0] in {b'f', b'd', b'l', b't'}:
2003
2196
                        # this is the result we are looking for: the
2004
2197
                        # real home of this file_id in this tree.
2005
2198
                        return entry
2006
 
                    if entry[1][tree_index][0] == 'a':
 
2199
                    if entry[1][tree_index][0] == b'a':
2007
2200
                        # there is no home for this entry in this tree
2008
2201
                        if include_deleted:
2009
2202
                            return entry
2010
2203
                        return None, None
2011
 
                    if entry[1][tree_index][0] != 'r':
 
2204
                    if entry[1][tree_index][0] != b'r':
2012
2205
                        raise AssertionError(
2013
 
                            "entry %r has invalid minikind %r for tree %r" \
 
2206
                            "entry %r has invalid minikind %r for tree %r"
2014
2207
                            % (entry,
2015
2208
                               entry[1][tree_index][0],
2016
2209
                               tree_index))
2017
2210
                    real_path = entry[1][tree_index][1]
2018
2211
                    return self._get_entry(tree_index, fileid_utf8=fileid_utf8,
2019
 
                        path_utf8=real_path)
 
2212
                                           path_utf8=real_path)
2020
2213
            return None, None
2021
2214
 
2022
2215
    @classmethod
2040
2233
            sha1_provider = DefaultSHA1Provider()
2041
2234
        result = cls(path, sha1_provider)
2042
2235
        # root dir and root dir contents with no children.
2043
 
        empty_tree_dirblocks = [('', []), ('', [])]
 
2236
        empty_tree_dirblocks = [(b'', []), (b'', [])]
2044
2237
        # a new root directory, with a NULLSTAT.
2045
2238
        empty_tree_dirblocks[0][1].append(
2046
 
            (('', '', inventory.ROOT_ID), [
2047
 
                ('d', '', 0, False, DirState.NULLSTAT),
 
2239
            ((b'', b'', inventory.ROOT_ID), [
 
2240
                (b'd', b'', 0, False, DirState.NULLSTAT),
2048
2241
            ]))
2049
2242
        result.lock_write()
2050
2243
        try:
2068
2261
        minikind = DirState._kind_to_minikind[kind]
2069
2262
        tree_data = inv_entry.revision
2070
2263
        if kind == 'directory':
2071
 
            fingerprint = ''
 
2264
            fingerprint = b''
2072
2265
            size = 0
2073
2266
            executable = False
2074
2267
        elif kind == 'symlink':
2075
2268
            if inv_entry.symlink_target is None:
2076
 
                fingerprint = ''
 
2269
                fingerprint = b''
2077
2270
            else:
2078
2271
                fingerprint = inv_entry.symlink_target.encode('utf8')
2079
2272
            size = 0
2080
2273
            executable = False
2081
2274
        elif kind == 'file':
2082
 
            fingerprint = inv_entry.text_sha1 or ''
 
2275
            fingerprint = inv_entry.text_sha1 or b''
2083
2276
            size = inv_entry.text_size or 0
2084
2277
            executable = inv_entry.executable
2085
2278
        elif kind == 'tree-reference':
2086
 
            fingerprint = inv_entry.reference_revision or ''
 
2279
            fingerprint = inv_entry.reference_revision or b''
2087
2280
            size = 0
2088
2281
            executable = False
2089
2282
        else:
2090
2283
            raise Exception("can't pack %s" % inv_entry)
2091
 
        return (minikind, fingerprint, size, executable, tree_data)
 
2284
        return static_tuple.StaticTuple(minikind, fingerprint, size,
 
2285
                                        executable, tree_data)
2092
2286
 
2093
2287
    def _iter_child_entries(self, tree_index, path_utf8):
2094
2288
        """Iterate over all the entries that are children of path_utf.
2095
2289
 
2096
 
        This only returns entries that are present (not in 'a', 'r') in
 
2290
        This only returns entries that are present (not in b'a', b'r') in
2097
2291
        tree_index. tree_index data is not refreshed, so if tree 0 is used,
2098
2292
        results may differ from that obtained if paths were statted to
2099
2293
        determine what ones were directories.
2103
2297
        """
2104
2298
        pending_dirs = []
2105
2299
        next_pending_dirs = [path_utf8]
2106
 
        absent = 'ar'
 
2300
        absent = (b'a', b'r')
2107
2301
        while next_pending_dirs:
2108
2302
            pending_dirs = next_pending_dirs
2109
2303
            next_pending_dirs = []
2110
2304
            for path in pending_dirs:
2111
2305
                block_index, present = self._find_block_index_from_key(
2112
 
                    (path, '', ''))
 
2306
                    (path, b'', b''))
2113
2307
                if block_index == 0:
2114
2308
                    block_index = 1
2115
2309
                    if len(self._dirblocks) == 1:
2124
2318
                    kind = entry[1][tree_index][0]
2125
2319
                    if kind not in absent:
2126
2320
                        yield entry
2127
 
                    if kind == 'd':
 
2321
                    if kind == b'd':
2128
2322
                        if entry[0][0]:
2129
 
                            path = entry[0][0] + '/' + entry[0][1]
 
2323
                            path = entry[0][0] + b'/' + entry[0][1]
2130
2324
                        else:
2131
2325
                            path = entry[0][1]
2132
2326
                        next_pending_dirs.append(path)
2135
2329
        """Iterate over all the entries in the dirstate.
2136
2330
 
2137
2331
        Each yelt item is an entry in the standard format described in the
2138
 
        docstring of bzrlib.dirstate.
 
2332
        docstring of breezy.dirstate.
2139
2333
        """
2140
2334
        self._read_dirblocks_if_needed()
2141
2335
        for directory in self._dirblocks:
2143
2337
                yield entry
2144
2338
 
2145
2339
    def _get_id_index(self):
2146
 
        """Get an id index of self._dirblocks."""
 
2340
        """Get an id index of self._dirblocks.
 
2341
 
 
2342
        This maps from file_id => [(directory, name, file_id)] entries where
 
2343
        that file_id appears in one of the trees.
 
2344
        """
2147
2345
        if self._id_index is None:
2148
2346
            id_index = {}
2149
2347
            for key, tree_details in self._iter_entries():
2150
 
                id_index.setdefault(key[2], set()).add(key)
 
2348
                self._add_to_id_index(id_index, key)
2151
2349
            self._id_index = id_index
2152
2350
        return self._id_index
2153
2351
 
 
2352
    def _add_to_id_index(self, id_index, entry_key):
 
2353
        """Add this entry to the _id_index mapping."""
 
2354
        # This code used to use a set for every entry in the id_index. However,
 
2355
        # it is *rare* to have more than one entry. So a set is a large
 
2356
        # overkill. And even when we do, we won't ever have more than the
 
2357
        # number of parent trees. Which is still a small number (rarely >2). As
 
2358
        # such, we use a simple tuple, and do our own uniqueness checks. While
 
2359
        # the 'in' check is O(N) since N is nicely bounded it shouldn't ever
 
2360
        # cause quadratic failure.
 
2361
        file_id = entry_key[2]
 
2362
        entry_key = static_tuple.StaticTuple.from_sequence(entry_key)
 
2363
        if file_id not in id_index:
 
2364
            id_index[file_id] = static_tuple.StaticTuple(entry_key,)
 
2365
        else:
 
2366
            entry_keys = id_index[file_id]
 
2367
            if entry_key not in entry_keys:
 
2368
                id_index[file_id] = entry_keys + (entry_key,)
 
2369
 
 
2370
    def _remove_from_id_index(self, id_index, entry_key):
 
2371
        """Remove this entry from the _id_index mapping.
 
2372
 
 
2373
        It is an programming error to call this when the entry_key is not
 
2374
        already present.
 
2375
        """
 
2376
        file_id = entry_key[2]
 
2377
        entry_keys = list(id_index[file_id])
 
2378
        entry_keys.remove(entry_key)
 
2379
        id_index[file_id] = static_tuple.StaticTuple.from_sequence(entry_keys)
 
2380
 
2154
2381
    def _get_output_lines(self, lines):
2155
2382
        """Format lines for final output.
2156
2383
 
2158
2385
            path lines.
2159
2386
        """
2160
2387
        output_lines = [DirState.HEADER_FORMAT_3]
2161
 
        lines.append('') # a final newline
2162
 
        inventory_text = '\0\n\0'.join(lines)
2163
 
        output_lines.append('crc32: %s\n' % (zlib.crc32(inventory_text),))
 
2388
        lines.append(b'')  # a final newline
 
2389
        inventory_text = b'\0\n\0'.join(lines)
 
2390
        output_lines.append(b'crc32: %d\n' % (zlib.crc32(inventory_text),))
2164
2391
        # -3, 1 for num parents, 1 for ghosts, 1 for final newline
2165
 
        num_entries = len(lines)-3
2166
 
        output_lines.append('num_entries: %s\n' % (num_entries,))
 
2392
        num_entries = len(lines) - 3
 
2393
        output_lines.append(b'num_entries: %d\n' % (num_entries,))
2167
2394
        output_lines.append(inventory_text)
2168
2395
        return output_lines
2169
2396
 
2170
2397
    def _make_deleted_row(self, fileid_utf8, parents):
2171
2398
        """Return a deleted row for fileid_utf8."""
2172
 
        return ('/', 'RECYCLED.BIN', 'file', fileid_utf8, 0, DirState.NULLSTAT,
2173
 
            ''), parents
 
2399
        return (b'/', b'RECYCLED.BIN', b'file', fileid_utf8, 0, DirState.NULLSTAT,
 
2400
                b''), parents
2174
2401
 
2175
2402
    def _num_present_parents(self):
2176
2403
        """The number of parent entries in each record row."""
2177
2404
        return len(self._parents) - len(self._ghosts)
2178
2405
 
2179
 
    @staticmethod
2180
 
    def on_file(path, sha1_provider=None):
 
2406
    @classmethod
 
2407
    def on_file(cls, path, sha1_provider=None, worth_saving_limit=0,
 
2408
                use_filesystem_for_exec=True):
2181
2409
        """Construct a DirState on the file at path "path".
2182
2410
 
2183
2411
        :param path: The path at which the dirstate file on disk should live.
2184
2412
        :param sha1_provider: an object meeting the SHA1Provider interface.
2185
2413
            If None, a DefaultSHA1Provider is used.
 
2414
        :param worth_saving_limit: when the exact number of hash changed
 
2415
            entries is known, only bother saving the dirstate if more than
 
2416
            this count of entries have changed. -1 means never save.
 
2417
        :param use_filesystem_for_exec: Whether to trust the filesystem
 
2418
            for executable bit information
2186
2419
        :return: An unlocked DirState object, associated with the given path.
2187
2420
        """
2188
2421
        if sha1_provider is None:
2189
2422
            sha1_provider = DefaultSHA1Provider()
2190
 
        result = DirState(path, sha1_provider)
 
2423
        result = cls(path, sha1_provider,
 
2424
                     worth_saving_limit=worth_saving_limit,
 
2425
                     use_filesystem_for_exec=use_filesystem_for_exec)
2191
2426
        return result
2192
2427
 
2193
2428
    def _read_dirblocks_if_needed(self):
2211
2446
        """
2212
2447
        self._read_prelude()
2213
2448
        parent_line = self._state_file.readline()
2214
 
        info = parent_line.split('\0')
 
2449
        info = parent_line.split(b'\0')
2215
2450
        num_parents = int(info[0])
2216
2451
        self._parents = info[1:-1]
2217
2452
        ghost_line = self._state_file.readline()
2218
 
        info = ghost_line.split('\0')
 
2453
        info = ghost_line.split(b'\0')
2219
2454
        num_ghosts = int(info[1])
2220
2455
        self._ghosts = info[2:-1]
2221
2456
        self._header_state = DirState.IN_MEMORY_UNMODIFIED
2243
2478
            raise errors.BzrError(
2244
2479
                'invalid header line: %r' % (header,))
2245
2480
        crc_line = self._state_file.readline()
2246
 
        if not crc_line.startswith('crc32: '):
 
2481
        if not crc_line.startswith(b'crc32: '):
2247
2482
            raise errors.BzrError('missing crc32 checksum: %r' % crc_line)
2248
 
        self.crc_expected = int(crc_line[len('crc32: '):-1])
 
2483
        self.crc_expected = int(crc_line[len(b'crc32: '):-1])
2249
2484
        num_entries_line = self._state_file.readline()
2250
 
        if not num_entries_line.startswith('num_entries: '):
 
2485
        if not num_entries_line.startswith(b'num_entries: '):
2251
2486
            raise errors.BzrError('missing num_entries line')
2252
 
        self._num_entries = int(num_entries_line[len('num_entries: '):-1])
 
2487
        self._num_entries = int(num_entries_line[len(b'num_entries: '):-1])
2253
2488
 
2254
 
    def sha1_from_stat(self, path, stat_result, _pack_stat=pack_stat):
 
2489
    def sha1_from_stat(self, path, stat_result):
2255
2490
        """Find a sha1 given a stat lookup."""
2256
 
        return self._get_packed_stat_index().get(_pack_stat(stat_result), None)
 
2491
        return self._get_packed_stat_index().get(pack_stat(stat_result), None)
2257
2492
 
2258
2493
    def _get_packed_stat_index(self):
2259
2494
        """Get a packed_stat index of self._dirblocks."""
2260
2495
        if self._packed_stat_index is None:
2261
2496
            index = {}
2262
2497
            for key, tree_details in self._iter_entries():
2263
 
                if tree_details[0][0] == 'f':
 
2498
                if tree_details[0][0] == b'f':
2264
2499
                    index[tree_details[0][4]] = tree_details[0][1]
2265
2500
            self._packed_stat_index = index
2266
2501
        return self._packed_stat_index
2283
2518
            # Should this be a warning? For now, I'm expecting that places that
2284
2519
            # mark it inconsistent will warn, making a warning here redundant.
2285
2520
            trace.mutter('Not saving DirState because '
2286
 
                    '_changes_aborted is set.')
2287
 
            return
2288
 
        if (self._header_state == DirState.IN_MEMORY_MODIFIED or
2289
 
            self._dirblock_state == DirState.IN_MEMORY_MODIFIED):
 
2521
                         '_changes_aborted is set.')
 
2522
            return
 
2523
        # TODO: Since we now distinguish IN_MEMORY_MODIFIED from
 
2524
        #       IN_MEMORY_HASH_MODIFIED, we should only fail quietly if we fail
 
2525
        #       to save an IN_MEMORY_HASH_MODIFIED, and fail *noisily* if we
 
2526
        #       fail to save IN_MEMORY_MODIFIED
 
2527
        if not self._worth_saving():
 
2528
            return
2290
2529
 
2291
 
            grabbed_write_lock = False
2292
 
            if self._lock_state != 'w':
2293
 
                grabbed_write_lock, new_lock = self._lock_token.temporary_write_lock()
2294
 
                # Switch over to the new lock, as the old one may be closed.
 
2530
        grabbed_write_lock = False
 
2531
        if self._lock_state != 'w':
 
2532
            grabbed_write_lock, new_lock = self._lock_token.temporary_write_lock()
 
2533
            # Switch over to the new lock, as the old one may be closed.
 
2534
            # TODO: jam 20070315 We should validate the disk file has
 
2535
            #       not changed contents, since temporary_write_lock may
 
2536
            #       not be an atomic operation.
 
2537
            self._lock_token = new_lock
 
2538
            self._state_file = new_lock.f
 
2539
            if not grabbed_write_lock:
 
2540
                # We couldn't grab a write lock, so we switch back to a read one
 
2541
                return
 
2542
        try:
 
2543
            lines = self.get_lines()
 
2544
            self._state_file.seek(0)
 
2545
            self._state_file.writelines(lines)
 
2546
            self._state_file.truncate()
 
2547
            self._state_file.flush()
 
2548
            self._maybe_fdatasync()
 
2549
            self._mark_unmodified()
 
2550
        finally:
 
2551
            if grabbed_write_lock:
 
2552
                self._lock_token = self._lock_token.restore_read_lock()
 
2553
                self._state_file = self._lock_token.f
2295
2554
                # TODO: jam 20070315 We should validate the disk file has
2296
 
                #       not changed contents. Since temporary_write_lock may
 
2555
                #       not changed contents. Since restore_read_lock may
2297
2556
                #       not be an atomic operation.
2298
 
                self._lock_token = new_lock
2299
 
                self._state_file = new_lock.f
2300
 
                if not grabbed_write_lock:
2301
 
                    # We couldn't grab a write lock, so we switch back to a read one
2302
 
                    return
2303
 
            try:
2304
 
                self._state_file.seek(0)
2305
 
                self._state_file.writelines(self.get_lines())
2306
 
                self._state_file.truncate()
2307
 
                self._state_file.flush()
2308
 
                self._header_state = DirState.IN_MEMORY_UNMODIFIED
2309
 
                self._dirblock_state = DirState.IN_MEMORY_UNMODIFIED
2310
 
            finally:
2311
 
                if grabbed_write_lock:
2312
 
                    self._lock_token = self._lock_token.restore_read_lock()
2313
 
                    self._state_file = self._lock_token.f
2314
 
                    # TODO: jam 20070315 We should validate the disk file has
2315
 
                    #       not changed contents. Since restore_read_lock may
2316
 
                    #       not be an atomic operation.
 
2557
 
 
2558
    def _maybe_fdatasync(self):
 
2559
        """Flush to disk if possible and if not configured off."""
 
2560
        if self._config_stack.get('dirstate.fdatasync'):
 
2561
            osutils.fdatasync(self._state_file.fileno())
 
2562
 
 
2563
    def _worth_saving(self):
 
2564
        """Is it worth saving the dirstate or not?"""
 
2565
        if (self._header_state == DirState.IN_MEMORY_MODIFIED
 
2566
                or self._dirblock_state == DirState.IN_MEMORY_MODIFIED):
 
2567
            return True
 
2568
        if self._dirblock_state == DirState.IN_MEMORY_HASH_MODIFIED:
 
2569
            if self._worth_saving_limit == -1:
 
2570
                # We never save hash changes when the limit is -1
 
2571
                return False
 
2572
            # If we're using smart saving and only a small number of
 
2573
            # entries have changed their hash, don't bother saving. John has
 
2574
            # suggested using a heuristic here based on the size of the
 
2575
            # changed files and/or tree. For now, we go with a configurable
 
2576
            # number of changes, keeping the calculation time
 
2577
            # as low overhead as possible. (This also keeps all existing
 
2578
            # tests passing as the default is 0, i.e. always save.)
 
2579
            if len(self._known_hash_changes) >= self._worth_saving_limit:
 
2580
                return True
 
2581
        return False
2317
2582
 
2318
2583
    def _set_data(self, parent_ids, dirblocks):
2319
2584
        """Set the full dirstate data in memory.
2328
2593
        """
2329
2594
        # our memory copy is now authoritative.
2330
2595
        self._dirblocks = dirblocks
2331
 
        self._header_state = DirState.IN_MEMORY_MODIFIED
2332
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
2596
        self._mark_modified(header_modified=True)
2333
2597
        self._parents = list(parent_ids)
2334
2598
        self._id_index = None
2335
2599
        self._packed_stat_index = None
2337
2601
    def set_path_id(self, path, new_id):
2338
2602
        """Change the id of path to new_id in the current working tree.
2339
2603
 
2340
 
        :param path: The path inside the tree to set - '' is the root, 'foo'
 
2604
        :param path: The path inside the tree to set - b'' is the root, 'foo'
2341
2605
            is the path foo in the root.
2342
2606
        :param new_id: The new id to assign to the path. This must be a utf8
2343
2607
            file id (not unicode, and not None).
2351
2615
        if entry[0][2] == new_id:
2352
2616
            # Nothing to change.
2353
2617
            return
 
2618
        if new_id.__class__ != bytes:
 
2619
            raise AssertionError(
 
2620
                "must be a utf8 file_id not %s" % (type(new_id), ))
2354
2621
        # mark the old path absent, and insert a new root path
2355
2622
        self._make_absent(entry)
2356
 
        self.update_minimal(('', '', new_id), 'd',
2357
 
            path_utf8='', packed_stat=entry[1][0][4])
2358
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
2623
        self.update_minimal((b'', b'', new_id), b'd',
 
2624
                            path_utf8=b'', packed_stat=entry[1][0][4])
 
2625
        self._mark_modified()
2359
2626
 
2360
2627
    def set_parent_trees(self, trees, ghosts):
2361
2628
        """Set the parent trees for the dirstate.
2406
2673
        parent_trees = [tree for rev_id, tree in trees if rev_id not in ghosts]
2407
2674
        # how many trees do we end up with
2408
2675
        parent_count = len(parent_trees)
 
2676
        st = static_tuple.StaticTuple
2409
2677
 
2410
2678
        # one: the current tree
2411
2679
        for entry in self._iter_entries():
2412
2680
            # skip entries not in the current tree
2413
 
            if entry[1][0][0] in 'ar': # absent, relocated
 
2681
            if entry[1][0][0] in (b'a', b'r'):  # absent, relocated
2414
2682
                continue
2415
2683
            by_path[entry[0]] = [entry[1][0]] + \
2416
2684
                [DirState.NULL_PARENT_DETAILS] * parent_count
2417
 
            id_index[entry[0][2]] = set([entry[0]])
 
2685
            # TODO: Possibly inline this, since we know it isn't present yet
 
2686
            #       id_index[entry[0][2]] = (entry[0],)
 
2687
            self._add_to_id_index(id_index, entry[0])
2418
2688
 
2419
2689
        # now the parent trees:
2420
2690
        for tree_index, tree in enumerate(parent_trees):
2424
2694
            # any fileid in this tree as we set the by_path[id] to:
2425
2695
            # already_processed_tree_details + new_details + new_location_suffix
2426
2696
            # the suffix is from tree_index+1:parent_count+1.
2427
 
            new_location_suffix = [DirState.NULL_PARENT_DETAILS] * (parent_count - tree_index)
 
2697
            new_location_suffix = [
 
2698
                DirState.NULL_PARENT_DETAILS] * (parent_count - tree_index)
2428
2699
            # now stitch in all the entries from this tree
2429
 
            for path, entry in tree.inventory.iter_entries_by_dir():
 
2700
            last_dirname = None
 
2701
            for path, entry in tree.iter_entries_by_dir():
2430
2702
                # here we process each trees details for each item in the tree.
2431
2703
                # we first update any existing entries for the id at other paths,
2432
2704
                # then we either create or update the entry for the id at the
2439
2711
                file_id = entry.file_id
2440
2712
                path_utf8 = path.encode('utf8')
2441
2713
                dirname, basename = osutils.split(path_utf8)
2442
 
                new_entry_key = (dirname, basename, file_id)
 
2714
                if dirname == last_dirname:
 
2715
                    # Try to re-use objects as much as possible
 
2716
                    dirname = last_dirname
 
2717
                else:
 
2718
                    last_dirname = dirname
 
2719
                new_entry_key = st(dirname, basename, file_id)
2443
2720
                # tree index consistency: All other paths for this id in this tree
2444
2721
                # index must point to the correct path.
2445
 
                for entry_key in id_index.setdefault(file_id, set()):
 
2722
                entry_keys = id_index.get(file_id, ())
 
2723
                for entry_key in entry_keys:
2446
2724
                    # TODO:PROFILING: It might be faster to just update
2447
2725
                    # rather than checking if we need to, and then overwrite
2448
2726
                    # the one we are located at.
2451
2729
                        # other trees, so put absent pointers there
2452
2730
                        # This is the vertical axis in the matrix, all pointing
2453
2731
                        # to the real path.
2454
 
                        by_path[entry_key][tree_index] = ('r', path_utf8, 0, False, '')
2455
 
                # by path consistency: Insert into an existing path record (trivial), or
2456
 
                # add a new one with relocation pointers for the other tree indexes.
2457
 
                if new_entry_key in id_index[file_id]:
2458
 
                    # there is already an entry where this data belongs, just insert it.
 
2732
                        by_path[entry_key][tree_index] = st(b'r', path_utf8, 0,
 
2733
                                                            False, b'')
 
2734
                # by path consistency: Insert into an existing path record
 
2735
                # (trivial), or add a new one with relocation pointers for the
 
2736
                # other tree indexes.
 
2737
                if new_entry_key in entry_keys:
 
2738
                    # there is already an entry where this data belongs, just
 
2739
                    # insert it.
2459
2740
                    by_path[new_entry_key][tree_index] = \
2460
2741
                        self._inv_entry_to_details(entry)
2461
2742
                else:
2463
2744
                    # mapping from path,id. We need to look up the correct path
2464
2745
                    # for the indexes from 0 to tree_index -1
2465
2746
                    new_details = []
2466
 
                    for lookup_index in xrange(tree_index):
 
2747
                    for lookup_index in range(tree_index):
2467
2748
                        # boundary case: this is the first occurence of file_id
2468
 
                        # so there are no id_indexs, possibly take this out of
 
2749
                        # so there are no id_indexes, possibly take this out of
2469
2750
                        # the loop?
2470
 
                        if not len(id_index[file_id]):
 
2751
                        if not len(entry_keys):
2471
2752
                            new_details.append(DirState.NULL_PARENT_DETAILS)
2472
2753
                        else:
2473
2754
                            # grab any one entry, use it to find the right path.
2474
 
                            # TODO: optimise this to reduce memory use in highly
2475
 
                            # fragmented situations by reusing the relocation
2476
 
                            # records.
2477
 
                            a_key = iter(id_index[file_id]).next()
2478
 
                            if by_path[a_key][lookup_index][0] in ('r', 'a'):
2479
 
                                # its a pointer or missing statement, use it as is.
2480
 
                                new_details.append(by_path[a_key][lookup_index])
 
2755
                            a_key = next(iter(entry_keys))
 
2756
                            if by_path[a_key][lookup_index][0] in (b'r', b'a'):
 
2757
                                # its a pointer or missing statement, use it as
 
2758
                                # is.
 
2759
                                new_details.append(
 
2760
                                    by_path[a_key][lookup_index])
2481
2761
                            else:
2482
2762
                                # we have the right key, make a pointer to it.
2483
 
                                real_path = ('/'.join(a_key[0:2])).strip('/')
2484
 
                                new_details.append(('r', real_path, 0, False, ''))
 
2763
                                real_path = (b'/'.join(a_key[0:2])).strip(b'/')
 
2764
                                new_details.append(st(b'r', real_path, 0, False,
 
2765
                                                      b''))
2485
2766
                    new_details.append(self._inv_entry_to_details(entry))
2486
2767
                    new_details.extend(new_location_suffix)
2487
2768
                    by_path[new_entry_key] = new_details
2488
 
                    id_index[file_id].add(new_entry_key)
 
2769
                    self._add_to_id_index(id_index, new_entry_key)
2489
2770
        # --- end generation of full tree mappings
2490
2771
 
2491
2772
        # sort and output all the entries
2492
 
        new_entries = self._sort_entries(by_path.items())
 
2773
        new_entries = self._sort_entries(viewitems(by_path))
2493
2774
        self._entries_to_current_state(new_entries)
2494
2775
        self._parents = [rev_id for rev_id, tree in trees]
2495
2776
        self._ghosts = list(ghosts)
2496
 
        self._header_state = DirState.IN_MEMORY_MODIFIED
2497
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
2777
        self._mark_modified(header_modified=True)
2498
2778
        self._id_index = id_index
2499
2779
 
2500
2780
    def _sort_entries(self, entry_list):
2504
2784
        try to keep everything in sorted blocks all the time, but sometimes
2505
2785
        it's easier to sort after the fact.
2506
2786
        """
2507
 
        def _key(entry):
 
2787
        # When sorting, we usually have 10x more entries than directories. (69k
 
2788
        # total entries, 4k directories). So cache the results of splitting.
 
2789
        # Saving time and objects. Also, use StaticTuple to avoid putting all
 
2790
        # of these object into python's garbage collector.
 
2791
        split_dirs = {}
 
2792
 
 
2793
        def _key(entry, _split_dirs=split_dirs, _st=static_tuple.StaticTuple):
2508
2794
            # sort by: directory parts, file name, file id
2509
 
            return entry[0][0].split('/'), entry[0][1], entry[0][2]
 
2795
            dirpath, fname, file_id = entry[0]
 
2796
            try:
 
2797
                split = _split_dirs[dirpath]
 
2798
            except KeyError:
 
2799
                split = _st.from_sequence(dirpath.split(b'/'))
 
2800
                _split_dirs[dirpath] = split
 
2801
            return _st(split, fname, file_id)
2510
2802
        return sorted(entry_list, key=_key)
2511
2803
 
2512
2804
    def set_state_from_inventory(self, new_inv):
2519
2811
        """
2520
2812
        if 'evil' in debug.debug_flags:
2521
2813
            trace.mutter_callsite(1,
2522
 
                "set_state_from_inventory called; please mutate the tree instead")
 
2814
                                  "set_state_from_inventory called; please mutate the tree instead")
2523
2815
        tracing = 'dirstate' in debug.debug_flags
2524
2816
        if tracing:
2525
2817
            trace.mutter("set_state_from_inventory trace:")
2542
2834
        # underlying dirstate.
2543
2835
        old_iterator = iter(list(self._iter_entries()))
2544
2836
        # both must have roots so this is safe:
2545
 
        current_new = new_iterator.next()
2546
 
        current_old = old_iterator.next()
 
2837
        current_new = next(new_iterator)
 
2838
        current_old = next(old_iterator)
 
2839
 
2547
2840
        def advance(iterator):
2548
2841
            try:
2549
 
                return iterator.next()
 
2842
                return next(iterator)
2550
2843
            except StopIteration:
2551
2844
                return None
2552
2845
        while current_new or current_old:
2553
2846
            # skip entries in old that are not really there
2554
 
            if current_old and current_old[1][0][0] in 'ar':
 
2847
            if current_old and current_old[1][0][0] in (b'a', b'r'):
2555
2848
                # relocated or absent
2556
2849
                current_old = advance(old_iterator)
2557
2850
                continue
2563
2856
                new_entry_key = (new_dirname, new_basename, new_id)
2564
2857
                current_new_minikind = \
2565
2858
                    DirState._kind_to_minikind[current_new[1].kind]
2566
 
                if current_new_minikind == 't':
2567
 
                    fingerprint = current_new[1].reference_revision or ''
 
2859
                if current_new_minikind == b't':
 
2860
                    fingerprint = current_new[1].reference_revision or b''
2568
2861
                else:
2569
2862
                    # We normally only insert or remove records, or update
2570
2863
                    # them when it has significantly changed.  Then we want to
2571
2864
                    # erase its fingerprint.  Unaffected records should
2572
2865
                    # normally not be updated at all.
2573
 
                    fingerprint = ''
 
2866
                    fingerprint = b''
2574
2867
            else:
2575
2868
                # for safety disable variables
2576
2869
                new_path_utf8 = new_dirname = new_basename = new_id = \
2581
2874
                # old is finished: insert current_new into the state.
2582
2875
                if tracing:
2583
2876
                    trace.mutter("Appending from new '%s'.",
2584
 
                        new_path_utf8.decode('utf8'))
 
2877
                                 new_path_utf8.decode('utf8'))
2585
2878
                self.update_minimal(new_entry_key, current_new_minikind,
2586
 
                    executable=current_new[1].executable,
2587
 
                    path_utf8=new_path_utf8, fingerprint=fingerprint,
2588
 
                    fullscan=True)
 
2879
                                    executable=current_new[1].executable,
 
2880
                                    path_utf8=new_path_utf8, fingerprint=fingerprint,
 
2881
                                    fullscan=True)
2589
2882
                current_new = advance(new_iterator)
2590
2883
            elif not current_new:
2591
2884
                # new is finished
2592
2885
                if tracing:
2593
2886
                    trace.mutter("Truncating from old '%s/%s'.",
2594
 
                        current_old[0][0].decode('utf8'),
2595
 
                        current_old[0][1].decode('utf8'))
 
2887
                                 current_old[0][0].decode('utf8'),
 
2888
                                 current_old[0][1].decode('utf8'))
2596
2889
                self._make_absent(current_old)
2597
2890
                current_old = advance(old_iterator)
2598
2891
            elif new_entry_key == current_old[0]:
2604
2897
                # the minimal required trigger is if the execute bit or cached
2605
2898
                # kind has changed.
2606
2899
                if (current_old[1][0][3] != current_new[1].executable or
2607
 
                    current_old[1][0][0] != current_new_minikind):
 
2900
                        current_old[1][0][0] != current_new_minikind):
2608
2901
                    if tracing:
2609
2902
                        trace.mutter("Updating in-place change '%s'.",
2610
 
                            new_path_utf8.decode('utf8'))
 
2903
                                     new_path_utf8.decode('utf8'))
2611
2904
                    self.update_minimal(current_old[0], current_new_minikind,
2612
 
                        executable=current_new[1].executable,
2613
 
                        path_utf8=new_path_utf8, fingerprint=fingerprint,
2614
 
                        fullscan=True)
 
2905
                                        executable=current_new[1].executable,
 
2906
                                        path_utf8=new_path_utf8, fingerprint=fingerprint,
 
2907
                                        fullscan=True)
2615
2908
                # both sides are dealt with, move on
2616
2909
                current_old = advance(old_iterator)
2617
2910
                current_new = advance(new_iterator)
2618
 
            elif (cmp_by_dirs(new_dirname, current_old[0][0]) < 0
2619
 
                  or (new_dirname == current_old[0][0]
2620
 
                      and new_entry_key[1:] < current_old[0][1:])):
 
2911
            elif (lt_by_dirs(new_dirname, current_old[0][0])
 
2912
                  or (new_dirname == current_old[0][0] and
 
2913
                      new_entry_key[1:] < current_old[0][1:])):
2621
2914
                # new comes before:
2622
2915
                # add a entry for this and advance new
2623
2916
                if tracing:
2624
2917
                    trace.mutter("Inserting from new '%s'.",
2625
 
                        new_path_utf8.decode('utf8'))
 
2918
                                 new_path_utf8.decode('utf8'))
2626
2919
                self.update_minimal(new_entry_key, current_new_minikind,
2627
 
                    executable=current_new[1].executable,
2628
 
                    path_utf8=new_path_utf8, fingerprint=fingerprint,
2629
 
                    fullscan=True)
 
2920
                                    executable=current_new[1].executable,
 
2921
                                    path_utf8=new_path_utf8, fingerprint=fingerprint,
 
2922
                                    fullscan=True)
2630
2923
                current_new = advance(new_iterator)
2631
2924
            else:
2632
2925
                # we've advanced past the place where the old key would be,
2633
2926
                # without seeing it in the new list.  so it must be gone.
2634
2927
                if tracing:
2635
2928
                    trace.mutter("Deleting from old '%s/%s'.",
2636
 
                        current_old[0][0].decode('utf8'),
2637
 
                        current_old[0][1].decode('utf8'))
 
2929
                                 current_old[0][0].decode('utf8'),
 
2930
                                 current_old[0][1].decode('utf8'))
2638
2931
                self._make_absent(current_old)
2639
2932
                current_old = advance(old_iterator)
2640
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
2933
        self._mark_modified()
2641
2934
        self._id_index = None
2642
2935
        self._packed_stat_index = None
2643
2936
        if tracing:
2644
2937
            trace.mutter("set_state_from_inventory complete.")
2645
2938
 
 
2939
    def set_state_from_scratch(self, working_inv, parent_trees, parent_ghosts):
 
2940
        """Wipe the currently stored state and set it to something new.
 
2941
 
 
2942
        This is a hard-reset for the data we are working with.
 
2943
        """
 
2944
        # Technically, we really want a write lock, but until we write, we
 
2945
        # don't really need it.
 
2946
        self._requires_lock()
 
2947
        # root dir and root dir contents with no children. We have to have a
 
2948
        # root for set_state_from_inventory to work correctly.
 
2949
        empty_root = ((b'', b'', inventory.ROOT_ID),
 
2950
                      [(b'd', b'', 0, False, DirState.NULLSTAT)])
 
2951
        empty_tree_dirblocks = [(b'', [empty_root]), (b'', [])]
 
2952
        self._set_data([], empty_tree_dirblocks)
 
2953
        self.set_state_from_inventory(working_inv)
 
2954
        self.set_parent_trees(parent_trees, parent_ghosts)
 
2955
 
2646
2956
    def _make_absent(self, current_old):
2647
2957
        """Mark current_old - an entry - as absent for tree 0.
2648
2958
 
2655
2965
        all_remaining_keys = set()
2656
2966
        # Dont check the working tree, because it's going.
2657
2967
        for details in current_old[1][1:]:
2658
 
            if details[0] not in 'ar': # absent, relocated
 
2968
            if details[0] not in (b'a', b'r'):  # absent, relocated
2659
2969
                all_remaining_keys.add(current_old[0])
2660
 
            elif details[0] == 'r': # relocated
 
2970
            elif details[0] == b'r':  # relocated
2661
2971
                # record the key for the real path.
2662
 
                all_remaining_keys.add(tuple(osutils.split(details[1])) + (current_old[0][2],))
 
2972
                all_remaining_keys.add(
 
2973
                    tuple(osutils.split(details[1])) + (current_old[0][2],))
2663
2974
            # absent rows are not present at any path.
2664
2975
        last_reference = current_old[0] not in all_remaining_keys
2665
2976
        if last_reference:
2667
2978
            # absent), and relocated or absent entries for the other trees:
2668
2979
            # Remove it, its meaningless.
2669
2980
            block = self._find_block(current_old[0])
2670
 
            entry_index, present = self._find_entry_index(current_old[0], block[1])
 
2981
            entry_index, present = self._find_entry_index(
 
2982
                current_old[0], block[1])
2671
2983
            if not present:
2672
 
                raise AssertionError('could not find entry for %s' % (current_old,))
 
2984
                raise AssertionError(
 
2985
                    'could not find entry for %s' % (current_old,))
2673
2986
            block[1].pop(entry_index)
2674
2987
            # if we have an id_index in use, remove this key from it for this id.
2675
2988
            if self._id_index is not None:
2676
 
                self._id_index[current_old[0][2]].remove(current_old[0])
 
2989
                self._remove_from_id_index(self._id_index, current_old[0])
2677
2990
        # update all remaining keys for this id to record it as absent. The
2678
2991
        # existing details may either be the record we are marking as deleted
2679
2992
        # (if there were other trees with the id present at this path), or may
2682
2995
            update_block_index, present = \
2683
2996
                self._find_block_index_from_key(update_key)
2684
2997
            if not present:
2685
 
                raise AssertionError('could not find block for %s' % (update_key,))
 
2998
                raise AssertionError(
 
2999
                    'could not find block for %s' % (update_key,))
2686
3000
            update_entry_index, present = \
2687
 
                self._find_entry_index(update_key, self._dirblocks[update_block_index][1])
 
3001
                self._find_entry_index(
 
3002
                    update_key, self._dirblocks[update_block_index][1])
2688
3003
            if not present:
2689
 
                raise AssertionError('could not find entry for %s' % (update_key,))
 
3004
                raise AssertionError(
 
3005
                    'could not find entry for %s' % (update_key,))
2690
3006
            update_tree_details = self._dirblocks[update_block_index][1][update_entry_index][1]
2691
3007
            # it must not be absent at the moment
2692
 
            if update_tree_details[0][0] == 'a': # absent
 
3008
            if update_tree_details[0][0] == b'a':  # absent
2693
3009
                raise AssertionError('bad row %r' % (update_tree_details,))
2694
3010
            update_tree_details[0] = DirState.NULL_PARENT_DETAILS
2695
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
3011
        self._mark_modified()
2696
3012
        return last_reference
2697
3013
 
2698
 
    def update_minimal(self, key, minikind, executable=False, fingerprint='',
2699
 
        packed_stat=None, size=0, path_utf8=None, fullscan=False):
 
3014
    def update_minimal(self, key, minikind, executable=False, fingerprint=b'',
 
3015
                       packed_stat=None, size=0, path_utf8=None, fullscan=False):
2700
3016
        """Update an entry to the state in tree 0.
2701
3017
 
2702
3018
        This will either create a new entry at 'key' or update an existing one.
2704
3020
        updated as well.
2705
3021
 
2706
3022
        :param key: (dir, name, file_id) for the new entry
2707
 
        :param minikind: The type for the entry ('f' == 'file', 'd' ==
 
3023
        :param minikind: The type for the entry (b'f' == 'file', b'd' ==
2708
3024
                'directory'), etc.
2709
3025
        :param executable: Should the executable bit be set?
2710
3026
        :param fingerprint: Simple fingerprint for new entry: canonical-form
2723
3039
        block = self._find_block(key)[1]
2724
3040
        if packed_stat is None:
2725
3041
            packed_stat = DirState.NULLSTAT
2726
 
        # XXX: Some callers pass '' as the packed_stat, and it seems to be
 
3042
        # XXX: Some callers pass b'' as the packed_stat, and it seems to be
2727
3043
        # sometimes present in the dirstate - this seems oddly inconsistent.
2728
3044
        # mbp 20071008
2729
3045
        entry_index, present = self._find_entry_index(key, block)
2732
3048
        if not present:
2733
3049
            # New record. Check there isn't a entry at this path already.
2734
3050
            if not fullscan:
2735
 
                low_index, _ = self._find_entry_index(key[0:2] + ('',), block)
 
3051
                low_index, _ = self._find_entry_index(key[0:2] + (b'',), block)
2736
3052
                while low_index < len(block):
2737
3053
                    entry = block[low_index]
2738
3054
                    if entry[0][0:2] == key[0:2]:
2739
 
                        if entry[1][0][0] not in 'ar':
 
3055
                        if entry[1][0][0] not in (b'a', b'r'):
2740
3056
                            # This entry has the same path (but a different id) as
2741
3057
                            # the new entry we're adding, and is present in ths
2742
3058
                            # tree.
2743
 
                            raise errors.InconsistentDelta(
2744
 
                                ("%s/%s" % key[0:2]).decode('utf8'), key[2],
 
3059
                            self._raise_invalid(
 
3060
                                (b"%s/%s" % key[0:2]).decode('utf8'), key[2],
2745
3061
                                "Attempt to add item at path already occupied by "
2746
3062
                                "id %r" % entry[0][2])
2747
3063
                        low_index += 1
2748
3064
                    else:
2749
3065
                        break
2750
3066
            # new entry, synthesis cross reference here,
2751
 
            existing_keys = id_index.setdefault(key[2], set())
 
3067
            existing_keys = id_index.get(key[2], ())
2752
3068
            if not existing_keys:
2753
3069
                # not currently in the state, simplest case
2754
3070
                new_entry = key, [new_details] + self._empty_parent_info()
2784
3100
                    # entry, if not already examined, is skipped over by that
2785
3101
                    # loop.
2786
3102
                    other_entry = other_block[other_entry_index]
2787
 
                    other_entry[1][0] = ('r', path_utf8, 0, False, '')
2788
 
                    self._maybe_remove_row(other_block, other_entry_index,
2789
 
                        id_index)
 
3103
                    other_entry[1][0] = (b'r', path_utf8, 0, False, b'')
 
3104
                    if self._maybe_remove_row(other_block, other_entry_index,
 
3105
                                              id_index):
 
3106
                        # If the row holding this was removed, we need to
 
3107
                        # recompute where this entry goes
 
3108
                        entry_index, _ = self._find_entry_index(key, block)
2790
3109
 
2791
3110
                # This loop:
2792
3111
                # adds a tuple to the new details for each column
2794
3113
                #  - or by creating a new pointer to the right row inside that column
2795
3114
                num_present_parents = self._num_present_parents()
2796
3115
                if num_present_parents:
 
3116
                    # TODO: This re-evaluates the existing_keys set, do we need
 
3117
                    #       to do that ourselves?
2797
3118
                    other_key = list(existing_keys)[0]
2798
 
                for lookup_index in xrange(1, num_present_parents + 1):
 
3119
                for lookup_index in range(1, num_present_parents + 1):
2799
3120
                    # grab any one entry, use it to find the right path.
2800
3121
                    # TODO: optimise this to reduce memory use in highly
2801
3122
                    # fragmented situations by reusing the relocation
2803
3124
                    update_block_index, present = \
2804
3125
                        self._find_block_index_from_key(other_key)
2805
3126
                    if not present:
2806
 
                        raise AssertionError('could not find block for %s' % (other_key,))
 
3127
                        raise AssertionError(
 
3128
                            'could not find block for %s' % (other_key,))
2807
3129
                    update_entry_index, present = \
2808
 
                        self._find_entry_index(other_key, self._dirblocks[update_block_index][1])
 
3130
                        self._find_entry_index(
 
3131
                            other_key, self._dirblocks[update_block_index][1])
2809
3132
                    if not present:
2810
 
                        raise AssertionError('update_minimal: could not find entry for %s' % (other_key,))
 
3133
                        raise AssertionError(
 
3134
                            'update_minimal: could not find entry for %s' % (other_key,))
2811
3135
                    update_details = self._dirblocks[update_block_index][1][update_entry_index][1][lookup_index]
2812
 
                    if update_details[0] in 'ar': # relocated, absent
 
3136
                    if update_details[0] in (b'a', b'r'):  # relocated, absent
2813
3137
                        # its a pointer or absent in lookup_index's tree, use
2814
3138
                        # it as is.
2815
3139
                        new_entry[1].append(update_details)
2816
3140
                    else:
2817
3141
                        # we have the right key, make a pointer to it.
2818
3142
                        pointer_path = osutils.pathjoin(*other_key[0:2])
2819
 
                        new_entry[1].append(('r', pointer_path, 0, False, ''))
 
3143
                        new_entry[1].append(
 
3144
                            (b'r', pointer_path, 0, False, b''))
2820
3145
            block.insert(entry_index, new_entry)
2821
 
            existing_keys.add(key)
 
3146
            self._add_to_id_index(id_index, key)
2822
3147
        else:
2823
3148
            # Does the new state matter?
2824
3149
            block[entry_index][1][0] = new_details
2833
3158
            # converted to relocated.
2834
3159
            if path_utf8 is None:
2835
3160
                raise AssertionError('no path')
2836
 
            for entry_key in id_index.setdefault(key[2], set()):
 
3161
            existing_keys = id_index.get(key[2], ())
 
3162
            if key not in existing_keys:
 
3163
                raise AssertionError('We found the entry in the blocks, but'
 
3164
                                     ' the key is not in the id_index.'
 
3165
                                     ' key: %s, existing_keys: %s' % (key, existing_keys))
 
3166
            for entry_key in existing_keys:
2837
3167
                # TODO:PROFILING: It might be faster to just update
2838
3168
                # rather than checking if we need to, and then overwrite
2839
3169
                # the one we are located at.
2842
3172
                    # other trees, so put absent pointers there
2843
3173
                    # This is the vertical axis in the matrix, all pointing
2844
3174
                    # to the real path.
2845
 
                    block_index, present = self._find_block_index_from_key(entry_key)
 
3175
                    block_index, present = self._find_block_index_from_key(
 
3176
                        entry_key)
2846
3177
                    if not present:
2847
3178
                        raise AssertionError('not present: %r', entry_key)
2848
 
                    entry_index, present = self._find_entry_index(entry_key, self._dirblocks[block_index][1])
 
3179
                    entry_index, present = self._find_entry_index(
 
3180
                        entry_key, self._dirblocks[block_index][1])
2849
3181
                    if not present:
2850
3182
                        raise AssertionError('not present: %r', entry_key)
2851
3183
                    self._dirblocks[block_index][1][entry_index][1][0] = \
2852
 
                        ('r', path_utf8, 0, False, '')
 
3184
                        (b'r', path_utf8, 0, False, b'')
2853
3185
        # add a containing dirblock if needed.
2854
 
        if new_details[0] == 'd':
2855
 
            subdir_key = (osutils.pathjoin(*key[0:2]), '', '')
 
3186
        if new_details[0] == b'd':
 
3187
            # GZ 2017-06-09: Using pathjoin why?
 
3188
            subdir_key = (osutils.pathjoin(*key[0:2]), b'', b'')
2856
3189
            block_index, present = self._find_block_index_from_key(subdir_key)
2857
3190
            if not present:
2858
3191
                self._dirblocks.insert(block_index, (subdir_key[0], []))
2859
3192
 
2860
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
3193
        self._mark_modified()
2861
3194
 
2862
3195
    def _maybe_remove_row(self, block, index, id_index):
2863
3196
        """Remove index if it is absent or relocated across the row.
2864
 
        
 
3197
 
2865
3198
        id_index is updated accordingly.
 
3199
        :return: True if we removed the row, False otherwise
2866
3200
        """
2867
3201
        present_in_row = False
2868
3202
        entry = block[index]
2869
3203
        for column in entry[1]:
2870
 
            if column[0] not in 'ar':
 
3204
            if column[0] not in (b'a', b'r'):
2871
3205
                present_in_row = True
2872
3206
                break
2873
3207
        if not present_in_row:
2874
3208
            block.pop(index)
2875
 
            id_index[entry[0][2]].remove(entry[0])
 
3209
            self._remove_from_id_index(id_index, entry[0])
 
3210
            return True
 
3211
        return False
2876
3212
 
2877
3213
    def _validate(self):
2878
3214
        """Check that invariants on the dirblock are correct.
2885
3221
        # NOTE: This must always raise AssertionError not just assert,
2886
3222
        # otherwise it may not behave properly under python -O
2887
3223
        #
2888
 
        # TODO: All entries must have some content that's not 'a' or 'r',
 
3224
        # TODO: All entries must have some content that's not b'a' or b'r',
2889
3225
        # otherwise it could just be removed.
2890
3226
        #
2891
3227
        # TODO: All relocations must point directly to a real entry.
2896
3232
        from pprint import pformat
2897
3233
        self._read_dirblocks_if_needed()
2898
3234
        if len(self._dirblocks) > 0:
2899
 
            if not self._dirblocks[0][0] == '':
 
3235
            if not self._dirblocks[0][0] == b'':
2900
3236
                raise AssertionError(
2901
 
                    "dirblocks don't start with root block:\n" + \
2902
 
                    pformat(self._dirblocks))
 
3237
                    "dirblocks don't start with root block:\n"
 
3238
                    + pformat(self._dirblocks))
2903
3239
        if len(self._dirblocks) > 1:
2904
 
            if not self._dirblocks[1][0] == '':
 
3240
            if not self._dirblocks[1][0] == b'':
2905
3241
                raise AssertionError(
2906
 
                    "dirblocks missing root directory:\n" + \
2907
 
                    pformat(self._dirblocks))
 
3242
                    "dirblocks missing root directory:\n"
 
3243
                    + pformat(self._dirblocks))
2908
3244
        # the dirblocks are sorted by their path components, name, and dir id
2909
 
        dir_names = [d[0].split('/')
2910
 
                for d in self._dirblocks[1:]]
 
3245
        dir_names = [d[0].split(b'/')
 
3246
                     for d in self._dirblocks[1:]]
2911
3247
        if dir_names != sorted(dir_names):
2912
3248
            raise AssertionError(
2913
 
                "dir names are not in sorted order:\n" + \
2914
 
                pformat(self._dirblocks) + \
 
3249
                "dir names are not in sorted order:\n" +
 
3250
                pformat(self._dirblocks) +
2915
3251
                "\nkeys:\n" +
2916
3252
                pformat(dir_names))
2917
3253
        for dirblock in self._dirblocks:
2925
3261
                        (entry, pformat(dirblock)))
2926
3262
            if dirblock[1] != sorted(dirblock[1]):
2927
3263
                raise AssertionError(
2928
 
                    "dirblock for %r is not sorted:\n%s" % \
 
3264
                    "dirblock for %r is not sorted:\n%s" %
2929
3265
                    (dirblock[0], pformat(dirblock)))
2930
3266
 
2931
3267
        def check_valid_parent():
2936
3272
            current tree. (It is invalid to have a non-absent file in an absent
2937
3273
            directory.)
2938
3274
            """
2939
 
            if entry[0][0:2] == ('', ''):
 
3275
            if entry[0][0:2] == (b'', b''):
2940
3276
                # There should be no parent for the root row
2941
3277
                return
2942
3278
            parent_entry = self._get_entry(tree_index, path_utf8=entry[0][0])
2944
3280
                raise AssertionError(
2945
3281
                    "no parent entry for: %s in tree %s"
2946
3282
                    % (this_path, tree_index))
2947
 
            if parent_entry[1][tree_index][0] != 'd':
 
3283
            if parent_entry[1][tree_index][0] != b'd':
2948
3284
                raise AssertionError(
2949
3285
                    "Parent entry for %s is not marked as a valid"
2950
3286
                    " directory. %s" % (this_path, parent_entry,))
2958
3294
        # We check this with a dict per tree pointing either to the present
2959
3295
        # name, or None if absent.
2960
3296
        tree_count = self._num_present_parents() + 1
2961
 
        id_path_maps = [dict() for i in range(tree_count)]
 
3297
        id_path_maps = [{} for _ in range(tree_count)]
2962
3298
        # Make sure that all renamed entries point to the correct location.
2963
3299
        for entry in self._iter_entries():
2964
3300
            file_id = entry[0][2]
2965
3301
            this_path = osutils.pathjoin(entry[0][0], entry[0][1])
2966
3302
            if len(entry[1]) != tree_count:
2967
3303
                raise AssertionError(
2968
 
                "wrong number of entry details for row\n%s" \
2969
 
                ",\nexpected %d" % \
2970
 
                (pformat(entry), tree_count))
 
3304
                    "wrong number of entry details for row\n%s"
 
3305
                    ",\nexpected %d" %
 
3306
                    (pformat(entry), tree_count))
2971
3307
            absent_positions = 0
2972
3308
            for tree_index, tree_state in enumerate(entry[1]):
2973
3309
                this_tree_map = id_path_maps[tree_index]
2974
3310
                minikind = tree_state[0]
2975
 
                if minikind in 'ar':
 
3311
                if minikind in (b'a', b'r'):
2976
3312
                    absent_positions += 1
2977
3313
                # have we seen this id before in this column?
2978
3314
                if file_id in this_tree_map:
2979
3315
                    previous_path, previous_loc = this_tree_map[file_id]
2980
3316
                    # any later mention of this file must be consistent with
2981
3317
                    # what was said before
2982
 
                    if minikind == 'a':
 
3318
                    if minikind == b'a':
2983
3319
                        if previous_path is not None:
2984
3320
                            raise AssertionError(
2985
 
                            "file %s is absent in row %r but also present " \
2986
 
                            "at %r"% \
2987
 
                            (file_id, entry, previous_path))
2988
 
                    elif minikind == 'r':
 
3321
                                "file %s is absent in row %r but also present "
 
3322
                                "at %r" %
 
3323
                                (file_id.decode('utf-8'), entry, previous_path))
 
3324
                    elif minikind == b'r':
2989
3325
                        target_location = tree_state[1]
2990
3326
                        if previous_path != target_location:
2991
3327
                            raise AssertionError(
2992
 
                            "file %s relocation in row %r but also at %r" \
2993
 
                            % (file_id, entry, previous_path))
 
3328
                                "file %s relocation in row %r but also at %r"
 
3329
                                % (file_id, entry, previous_path))
2994
3330
                    else:
2995
3331
                        # a file, directory, etc - may have been previously
2996
3332
                        # pointed to by a relocation, which must point here
3001
3337
                                (entry, previous_path, previous_loc))
3002
3338
                        check_valid_parent()
3003
3339
                else:
3004
 
                    if minikind == 'a':
 
3340
                    if minikind == b'a':
3005
3341
                        # absent; should not occur anywhere else
3006
3342
                        this_tree_map[file_id] = None, this_path
3007
 
                    elif minikind == 'r':
 
3343
                    elif minikind == b'r':
3008
3344
                        # relocation, must occur at expected location
3009
3345
                        this_tree_map[file_id] = tree_state[1], this_path
3010
3346
                    else:
3014
3350
                raise AssertionError(
3015
3351
                    "entry %r has no data for any tree." % (entry,))
3016
3352
        if self._id_index is not None:
3017
 
            for file_id, entry_keys in self._id_index.iteritems():
 
3353
            for file_id, entry_keys in viewitems(self._id_index):
3018
3354
                for entry_key in entry_keys:
 
3355
                    # Check that the entry in the map is pointing to the same
 
3356
                    # file_id
3019
3357
                    if entry_key[2] != file_id:
3020
3358
                        raise AssertionError(
3021
3359
                            'file_id %r did not match entry key %s'
3022
3360
                            % (file_id, entry_key))
 
3361
                    # And that from this entry key, we can look up the original
 
3362
                    # record
 
3363
                    block_index, present = self._find_block_index_from_key(
 
3364
                        entry_key)
 
3365
                    if not present:
 
3366
                        raise AssertionError(
 
3367
                            'missing block for entry key: %r', entry_key)
 
3368
                    entry_index, present = self._find_entry_index(
 
3369
                        entry_key, self._dirblocks[block_index][1])
 
3370
                    if not present:
 
3371
                        raise AssertionError(
 
3372
                            'missing entry for key: %r', entry_key)
 
3373
                if len(entry_keys) != len(set(entry_keys)):
 
3374
                    raise AssertionError(
 
3375
                        'id_index contained non-unique data for %s'
 
3376
                        % (entry_keys,))
3023
3377
 
3024
3378
    def _wipe_state(self):
3025
3379
        """Forget all state information about the dirstate."""
3047
3401
        self._lock_state = 'r'
3048
3402
        self._state_file = self._lock_token.f
3049
3403
        self._wipe_state()
 
3404
        return lock.LogicalLockResult(self.unlock)
3050
3405
 
3051
3406
    def lock_write(self):
3052
3407
        """Acquire a write lock on the dirstate."""
3060
3415
        self._lock_state = 'w'
3061
3416
        self._state_file = self._lock_token.f
3062
3417
        self._wipe_state()
 
3418
        return lock.LogicalLockResult(self.unlock, self._lock_token)
3063
3419
 
3064
3420
    def unlock(self):
3065
3421
        """Drop any locks held on the dirstate."""
3082
3438
 
3083
3439
 
3084
3440
def py_update_entry(state, entry, abspath, stat_value,
3085
 
                 _stat_to_minikind=DirState._stat_to_minikind,
3086
 
                 _pack_stat=pack_stat):
 
3441
                    _stat_to_minikind=DirState._stat_to_minikind):
3087
3442
    """Update the entry based on what is actually on disk.
3088
3443
 
3089
3444
    This function only calculates the sha if it needs to - if the entry is
3098
3453
        target of a symlink.
3099
3454
    """
3100
3455
    try:
3101
 
        minikind = _stat_to_minikind[stat_value.st_mode & 0170000]
 
3456
        minikind = _stat_to_minikind[stat_value.st_mode & 0o170000]
3102
3457
    except KeyError:
3103
3458
        # Unhandled kind
3104
3459
        return None
3105
 
    packed_stat = _pack_stat(stat_value)
 
3460
    packed_stat = pack_stat(stat_value)
3106
3461
    (saved_minikind, saved_link_or_sha1, saved_file_size,
3107
3462
     saved_executable, saved_packed_stat) = entry[1][0]
 
3463
    if not isinstance(saved_minikind, bytes):
 
3464
        raise TypeError(saved_minikind)
3108
3465
 
3109
 
    if minikind == 'd' and saved_minikind == 't':
3110
 
        minikind = 't'
 
3466
    if minikind == b'd' and saved_minikind == b't':
 
3467
        minikind = b't'
3111
3468
    if (minikind == saved_minikind
3112
 
        and packed_stat == saved_packed_stat):
 
3469
            and packed_stat == saved_packed_stat):
3113
3470
        # The stat hasn't changed since we saved, so we can re-use the
3114
3471
        # saved sha hash.
3115
 
        if minikind == 'd':
 
3472
        if minikind == b'd':
3116
3473
            return None
3117
3474
 
3118
3475
        # size should also be in packed_stat
3122
3479
    # If we have gotten this far, that means that we need to actually
3123
3480
    # process this entry.
3124
3481
    link_or_sha1 = None
3125
 
    if minikind == 'f':
 
3482
    worth_saving = True
 
3483
    if minikind == b'f':
3126
3484
        executable = state._is_executable(stat_value.st_mode,
3127
 
                                         saved_executable)
 
3485
                                          saved_executable)
3128
3486
        if state._cutoff_time is None:
3129
3487
            state._sha_cutoff_time()
3130
3488
        if (stat_value.st_mtime < state._cutoff_time
3131
3489
            and stat_value.st_ctime < state._cutoff_time
3132
3490
            and len(entry[1]) > 1
3133
 
            and entry[1][1][0] != 'a'):
 
3491
                and entry[1][1][0] != b'a'):
3134
3492
            # Could check for size changes for further optimised
3135
3493
            # avoidance of sha1's. However the most prominent case of
3136
3494
            # over-shaing is during initial add, which this catches.
3138
3496
            # are calculated at the same time, so checking just the size
3139
3497
            # gains nothing w.r.t. performance.
3140
3498
            link_or_sha1 = state._sha1_file(abspath)
3141
 
            entry[1][0] = ('f', link_or_sha1, stat_value.st_size,
 
3499
            entry[1][0] = (b'f', link_or_sha1, stat_value.st_size,
3142
3500
                           executable, packed_stat)
3143
3501
        else:
3144
 
            entry[1][0] = ('f', '', stat_value.st_size,
 
3502
            entry[1][0] = (b'f', b'', stat_value.st_size,
3145
3503
                           executable, DirState.NULLSTAT)
3146
 
    elif minikind == 'd':
 
3504
            worth_saving = False
 
3505
    elif minikind == b'd':
3147
3506
        link_or_sha1 = None
3148
 
        entry[1][0] = ('d', '', 0, False, packed_stat)
3149
 
        if saved_minikind != 'd':
 
3507
        entry[1][0] = (b'd', b'', 0, False, packed_stat)
 
3508
        if saved_minikind != b'd':
3150
3509
            # This changed from something into a directory. Make sure we
3151
3510
            # have a directory block for it. This doesn't happen very
3152
3511
            # often, so this doesn't have to be super fast.
3153
3512
            block_index, entry_index, dir_present, file_present = \
3154
3513
                state._get_block_entry_index(entry[0][0], entry[0][1], 0)
3155
3514
            state._ensure_block(block_index, entry_index,
3156
 
                               osutils.pathjoin(entry[0][0], entry[0][1]))
3157
 
    elif minikind == 'l':
 
3515
                                osutils.pathjoin(entry[0][0], entry[0][1]))
 
3516
        else:
 
3517
            worth_saving = False
 
3518
    elif minikind == b'l':
 
3519
        if saved_minikind == b'l':
 
3520
            worth_saving = False
3158
3521
        link_or_sha1 = state._read_link(abspath, saved_link_or_sha1)
3159
3522
        if state._cutoff_time is None:
3160
3523
            state._sha_cutoff_time()
3161
3524
        if (stat_value.st_mtime < state._cutoff_time
3162
 
            and stat_value.st_ctime < state._cutoff_time):
3163
 
            entry[1][0] = ('l', link_or_sha1, stat_value.st_size,
 
3525
                and stat_value.st_ctime < state._cutoff_time):
 
3526
            entry[1][0] = (b'l', link_or_sha1, stat_value.st_size,
3164
3527
                           False, packed_stat)
3165
3528
        else:
3166
 
            entry[1][0] = ('l', '', stat_value.st_size,
 
3529
            entry[1][0] = (b'l', b'', stat_value.st_size,
3167
3530
                           False, DirState.NULLSTAT)
3168
 
    state._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
3531
    if worth_saving:
 
3532
        state._mark_modified([entry])
3169
3533
    return link_or_sha1
3170
3534
 
3171
3535
 
3172
3536
class ProcessEntryPython(object):
3173
3537
 
3174
3538
    __slots__ = ["old_dirname_to_file_id", "new_dirname_to_file_id",
3175
 
        "last_source_parent", "last_target_parent", "include_unchanged",
3176
 
        "partial", "use_filesystem_for_exec", "utf8_decode",
3177
 
        "searched_specific_files", "search_specific_files",
3178
 
        "searched_exact_paths", "search_specific_file_parents", "seen_ids",
3179
 
        "state", "source_index", "target_index", "want_unversioned", "tree"]
 
3539
                 "last_source_parent", "last_target_parent", "include_unchanged",
 
3540
                 "partial", "use_filesystem_for_exec", "utf8_decode",
 
3541
                 "searched_specific_files", "search_specific_files",
 
3542
                 "searched_exact_paths", "search_specific_file_parents", "seen_ids",
 
3543
                 "state", "source_index", "target_index", "want_unversioned", "tree"]
3180
3544
 
3181
3545
    def __init__(self, include_unchanged, use_filesystem_for_exec,
3182
 
        search_specific_files, state, source_index, target_index,
3183
 
        want_unversioned, tree):
 
3546
                 search_specific_files, state, source_index, target_index,
 
3547
                 want_unversioned, tree):
3184
3548
        self.old_dirname_to_file_id = {}
3185
3549
        self.new_dirname_to_file_id = {}
3186
3550
        # Are we doing a partial iter_changes?
3187
 
        self.partial = search_specific_files != set([''])
 
3551
        self.partial = search_specific_files != {''}
3188
3552
        # Using a list so that we can access the values and change them in
3189
3553
        # nested scope. Each one is [path, file_id, entry]
3190
3554
        self.last_source_parent = [None, None]
3219
3583
        """Compare an entry and real disk to generate delta information.
3220
3584
 
3221
3585
        :param path_info: top_relpath, basename, kind, lstat, abspath for
3222
 
            the path of entry. If None, then the path is considered absent in 
 
3586
            the path of entry. If None, then the path is considered absent in
3223
3587
            the target (Perhaps we should pass in a concrete entry for this ?)
3224
3588
            Basename is returned as a utf8 string because we expect this
3225
3589
            tuple will be ignored, and don't want to take the time to
3236
3600
            source_details = DirState.NULL_PARENT_DETAILS
3237
3601
        else:
3238
3602
            source_details = entry[1][self.source_index]
 
3603
        # GZ 2017-06-09: Eck, more sets.
 
3604
        _fdltr = {b'f', b'd', b'l', b't', b'r'}
 
3605
        _fdlt = {b'f', b'd', b'l', b't'}
 
3606
        _ra = (b'r', b'a')
3239
3607
        target_details = entry[1][self.target_index]
3240
3608
        target_minikind = target_details[0]
3241
 
        if path_info is not None and target_minikind in 'fdlt':
 
3609
        if path_info is not None and target_minikind in _fdlt:
3242
3610
            if not (self.target_index == 0):
3243
3611
                raise AssertionError()
3244
3612
            link_or_sha1 = update_entry(self.state, entry,
3245
 
                abspath=path_info[4], stat_value=path_info[3])
 
3613
                                        abspath=path_info[4], stat_value=path_info[3])
3246
3614
            # The entry may have been modified by update_entry
3247
3615
            target_details = entry[1][self.target_index]
3248
3616
            target_minikind = target_details[0]
3250
3618
            link_or_sha1 = None
3251
3619
        file_id = entry[0][2]
3252
3620
        source_minikind = source_details[0]
3253
 
        if source_minikind in 'fdltr' and target_minikind in 'fdlt':
 
3621
        if source_minikind in _fdltr and target_minikind in _fdlt:
3254
3622
            # claimed content in both: diff
3255
3623
            #   r    | fdlt   |      | add source to search, add id path move and perform
3256
3624
            #        |        |      | diff check on source-target
3257
3625
            #   r    | fdlt   |  a   | dangling file that was present in the basis.
3258
3626
            #        |        |      | ???
3259
 
            if source_minikind in 'r':
 
3627
            if source_minikind == b'r':
3260
3628
                # add the source to the search path to find any children it
3261
3629
                # has.  TODO ? : only add if it is a container ?
3262
3630
                if not osutils.is_inside_any(self.searched_specific_files,
3268
3636
                old_dirname, old_basename = os.path.split(old_path)
3269
3637
                path = pathjoin(entry[0][0], entry[0][1])
3270
3638
                old_entry = self.state._get_entry(self.source_index,
3271
 
                                             path_utf8=old_path)
 
3639
                                                  path_utf8=old_path)
3272
3640
                # update the source details variable to be the real
3273
3641
                # location.
3274
3642
                if old_entry == (None, None):
3275
 
                    raise errors.CorruptDirstate(self.state._filename,
3276
 
                        "entry '%s/%s' is considered renamed from %r"
3277
 
                        " but source does not exist\n"
3278
 
                        "entry: %s" % (entry[0][0], entry[0][1], old_path, entry))
 
3643
                    raise DirstateCorrupt(self.state._filename,
 
3644
                                          "entry '%s/%s' is considered renamed from %r"
 
3645
                                          " but source does not exist\n"
 
3646
                                          "entry: %s" % (entry[0][0], entry[0][1], old_path, entry))
3279
3647
                source_details = old_entry[1][self.source_index]
3280
3648
                source_minikind = source_details[0]
3281
3649
            else:
3294
3662
                    if path is None:
3295
3663
                        old_path = path = pathjoin(old_dirname, old_basename)
3296
3664
                    self.new_dirname_to_file_id[path] = file_id
3297
 
                    if source_minikind != 'd':
 
3665
                    if source_minikind != b'd':
3298
3666
                        content_change = True
3299
3667
                    else:
3300
3668
                        # directories have no fingerprint
3301
3669
                        content_change = False
3302
3670
                    target_exec = False
3303
3671
                elif target_kind == 'file':
3304
 
                    if source_minikind != 'f':
 
3672
                    if source_minikind != b'f':
3305
3673
                        content_change = True
3306
3674
                    else:
3307
3675
                        # Check the sha. We can't just rely on the size as
3311
3679
                            # Stat cache miss:
3312
3680
                            statvalue, link_or_sha1 = \
3313
3681
                                self.state._sha1_provider.stat_and_sha1(
3314
 
                                path_info[4])
 
3682
                                    path_info[4])
3315
3683
                            self.state._observed_sha1(entry, link_or_sha1,
3316
 
                                statvalue)
 
3684
                                                      statvalue)
3317
3685
                        content_change = (link_or_sha1 != source_details[1])
3318
3686
                    # Target details is updated at update_entry time
3319
3687
                    if self.use_filesystem_for_exec:
3323
3691
                    else:
3324
3692
                        target_exec = target_details[3]
3325
3693
                elif target_kind == 'symlink':
3326
 
                    if source_minikind != 'l':
 
3694
                    if source_minikind != b'l':
3327
3695
                        content_change = True
3328
3696
                    else:
3329
3697
                        content_change = (link_or_sha1 != source_details[1])
3330
3698
                    target_exec = False
3331
3699
                elif target_kind == 'tree-reference':
3332
 
                    if source_minikind != 't':
 
3700
                    if source_minikind != b't':
3333
3701
                        content_change = True
3334
3702
                    else:
3335
3703
                        content_change = False
3338
3706
                    if path is None:
3339
3707
                        path = pathjoin(old_dirname, old_basename)
3340
3708
                    raise errors.BadFileKindError(path, path_info[2])
3341
 
            if source_minikind == 'd':
 
3709
            if source_minikind == b'd':
3342
3710
                if path is None:
3343
3711
                    old_path = path = pathjoin(old_dirname, old_basename)
3344
3712
                self.old_dirname_to_file_id[old_path] = file_id
3350
3718
                    source_parent_id = self.old_dirname_to_file_id[old_dirname]
3351
3719
                except KeyError:
3352
3720
                    source_parent_entry = self.state._get_entry(self.source_index,
3353
 
                                                           path_utf8=old_dirname)
 
3721
                                                                path_utf8=old_dirname)
3354
3722
                    source_parent_id = source_parent_entry[0][2]
3355
3723
                if source_parent_id == entry[0][2]:
3356
3724
                    # This is the root, so the parent is None
3368
3736
                    # TODO: We don't always need to do the lookup, because the
3369
3737
                    #       parent entry will be the same as the source entry.
3370
3738
                    target_parent_entry = self.state._get_entry(self.target_index,
3371
 
                                                           path_utf8=new_dirname)
 
3739
                                                                path_utf8=new_dirname)
3372
3740
                    if target_parent_entry == (None, None):
3373
3741
                        raise AssertionError(
3374
3742
                            "Could not find target parent in wt: %s\nparent of: %s"
3383
3751
 
3384
3752
            source_exec = source_details[3]
3385
3753
            changed = (content_change
3386
 
                or source_parent_id != target_parent_id
3387
 
                or old_basename != entry[0][1]
3388
 
                or source_exec != target_exec
3389
 
                )
 
3754
                       or source_parent_id != target_parent_id
 
3755
                       or old_basename != entry[0][1]
 
3756
                       or source_exec != target_exec
 
3757
                       )
3390
3758
            if not changed and not self.include_unchanged:
3391
3759
                return None, False
3392
3760
            else:
3401
3769
                    else:
3402
3770
                        path_u = self.utf8_decode(path)[0]
3403
3771
                source_kind = DirState._minikind_to_kind[source_minikind]
3404
 
                return (entry[0][2],
3405
 
                       (old_path_u, path_u),
3406
 
                       content_change,
3407
 
                       (True, True),
3408
 
                       (source_parent_id, target_parent_id),
3409
 
                       (self.utf8_decode(old_basename)[0], self.utf8_decode(entry[0][1])[0]),
3410
 
                       (source_kind, target_kind),
3411
 
                       (source_exec, target_exec)), changed
3412
 
        elif source_minikind in 'a' and target_minikind in 'fdlt':
 
3772
                return TreeChange(
 
3773
                    entry[0][2],
 
3774
                    (old_path_u, path_u),
 
3775
                    content_change,
 
3776
                    (True, True),
 
3777
                    (source_parent_id, target_parent_id),
 
3778
                    (self.utf8_decode(old_basename)[
 
3779
                     0], self.utf8_decode(entry[0][1])[0]),
 
3780
                    (source_kind, target_kind),
 
3781
                    (source_exec, target_exec)), changed
 
3782
        elif source_minikind in b'a' and target_minikind in _fdlt:
3413
3783
            # looks like a new file
3414
3784
            path = pathjoin(entry[0][0], entry[0][1])
3415
3785
            # parent id is the entry for the path in the target tree
3416
3786
            # TODO: these are the same for an entire directory: cache em.
3417
3787
            parent_id = self.state._get_entry(self.target_index,
3418
 
                                         path_utf8=entry[0][0])[0][2]
 
3788
                                              path_utf8=entry[0][0])[0][2]
3419
3789
            if parent_id == entry[0][2]:
3420
3790
                parent_id = None
3421
3791
            if path_info is not None:
3428
3798
                        and stat.S_IEXEC & path_info[3].st_mode)
3429
3799
                else:
3430
3800
                    target_exec = target_details[3]
3431
 
                return (entry[0][2],
3432
 
                       (None, self.utf8_decode(path)[0]),
3433
 
                       True,
3434
 
                       (False, True),
3435
 
                       (None, parent_id),
3436
 
                       (None, self.utf8_decode(entry[0][1])[0]),
3437
 
                       (None, path_info[2]),
3438
 
                       (None, target_exec)), True
 
3801
                return TreeChange(
 
3802
                    entry[0][2],
 
3803
                    (None, self.utf8_decode(path)[0]),
 
3804
                    True,
 
3805
                    (False, True),
 
3806
                    (None, parent_id),
 
3807
                    (None, self.utf8_decode(entry[0][1])[0]),
 
3808
                    (None, path_info[2]),
 
3809
                    (None, target_exec)), True
3439
3810
            else:
3440
3811
                # Its a missing file, report it as such.
3441
 
                return (entry[0][2],
3442
 
                       (None, self.utf8_decode(path)[0]),
3443
 
                       False,
3444
 
                       (False, True),
3445
 
                       (None, parent_id),
3446
 
                       (None, self.utf8_decode(entry[0][1])[0]),
3447
 
                       (None, None),
3448
 
                       (None, False)), True
3449
 
        elif source_minikind in 'fdlt' and target_minikind in 'a':
 
3812
                return TreeChange(
 
3813
                    entry[0][2],
 
3814
                    (None, self.utf8_decode(path)[0]),
 
3815
                    False,
 
3816
                    (False, True),
 
3817
                    (None, parent_id),
 
3818
                    (None, self.utf8_decode(entry[0][1])[0]),
 
3819
                    (None, None),
 
3820
                    (None, False)), True
 
3821
        elif source_minikind in _fdlt and target_minikind in b'a':
3450
3822
            # unversioned, possibly, or possibly not deleted: we dont care.
3451
3823
            # if its still on disk, *and* theres no other entry at this
3452
3824
            # path [we dont know this in this routine at the moment -
3453
3825
            # perhaps we should change this - then it would be an unknown.
3454
3826
            old_path = pathjoin(entry[0][0], entry[0][1])
3455
3827
            # parent id is the entry for the path in the target tree
3456
 
            parent_id = self.state._get_entry(self.source_index, path_utf8=entry[0][0])[0][2]
 
3828
            parent_id = self.state._get_entry(
 
3829
                self.source_index, path_utf8=entry[0][0])[0][2]
3457
3830
            if parent_id == entry[0][2]:
3458
3831
                parent_id = None
3459
 
            return (entry[0][2],
3460
 
                   (self.utf8_decode(old_path)[0], None),
3461
 
                   True,
3462
 
                   (True, False),
3463
 
                   (parent_id, None),
3464
 
                   (self.utf8_decode(entry[0][1])[0], None),
3465
 
                   (DirState._minikind_to_kind[source_minikind], None),
3466
 
                   (source_details[3], None)), True
3467
 
        elif source_minikind in 'fdlt' and target_minikind in 'r':
 
3832
            return TreeChange(
 
3833
                entry[0][2],
 
3834
                (self.utf8_decode(old_path)[0], None),
 
3835
                True,
 
3836
                (True, False),
 
3837
                (parent_id, None),
 
3838
                (self.utf8_decode(entry[0][1])[0], None),
 
3839
                (DirState._minikind_to_kind[source_minikind], None),
 
3840
                (source_details[3], None)), True
 
3841
        elif source_minikind in _fdlt and target_minikind in b'r':
3468
3842
            # a rename; could be a true rename, or a rename inherited from
3469
3843
            # a renamed parent. TODO: handle this efficiently. Its not
3470
3844
            # common case to rename dirs though, so a correct but slow
3471
3845
            # implementation will do.
3472
 
            if not osutils.is_inside_any(self.searched_specific_files, target_details[1]):
 
3846
            if not osutils.is_inside_any(self.searched_specific_files,
 
3847
                                         target_details[1]):
3473
3848
                self.search_specific_files.add(target_details[1])
3474
 
        elif source_minikind in 'ra' and target_minikind in 'ra':
 
3849
        elif source_minikind in _ra and target_minikind in _ra:
3475
3850
            # neither of the selected trees contain this file,
3476
3851
            # so skip over it. This is not currently directly tested, but
3477
3852
            # is indirectly via test_too_much.TestCommands.test_conflicts.
3478
3853
            pass
3479
3854
        else:
3480
3855
            raise AssertionError("don't know how to compare "
3481
 
                "source_minikind=%r, target_minikind=%r"
3482
 
                % (source_minikind, target_minikind))
3483
 
            ## import pdb;pdb.set_trace()
 
3856
                                 "source_minikind=%r, target_minikind=%r"
 
3857
                                 % (source_minikind, target_minikind))
3484
3858
        return None, None
3485
3859
 
3486
3860
    def __iter__(self):
3488
3862
 
3489
3863
    def _gather_result_for_consistency(self, result):
3490
3864
        """Check a result we will yield to make sure we are consistent later.
3491
 
        
 
3865
 
3492
3866
        This gathers result's parents into a set to output later.
3493
3867
 
3494
3868
        :param result: A result tuple.
3500
3874
        if new_path:
3501
3875
            # Not the root and not a delete: queue up the parents of the path.
3502
3876
            self.search_specific_file_parents.update(
3503
 
                osutils.parent_directories(new_path.encode('utf8')))
 
3877
                p.encode('utf8') for p in osutils.parent_directories(new_path))
3504
3878
            # Add the root directory which parent_directories does not
3505
3879
            # provide.
3506
 
            self.search_specific_file_parents.add('')
 
3880
            self.search_specific_file_parents.add(b'')
3507
3881
 
3508
3882
    def iter_changes(self):
3509
3883
        """Iterate over the changes."""
3510
3884
        utf8_decode = cache_utf8._utf8_decode
3511
 
        _cmp_by_dirs = cmp_by_dirs
 
3885
        _lt_by_dirs = lt_by_dirs
3512
3886
        _process_entry = self._process_entry
3513
3887
        search_specific_files = self.search_specific_files
3514
3888
        searched_specific_files = self.searched_specific_files
3563
3937
            root_abspath = self.tree.abspath(current_root_unicode)
3564
3938
            try:
3565
3939
                root_stat = os.lstat(root_abspath)
3566
 
            except OSError, e:
 
3940
            except OSError as e:
3567
3941
                if e.errno == errno.ENOENT:
3568
3942
                    # the path does not exist: let _process_entry know that.
3569
3943
                    root_dir_info = None
3571
3945
                    # some other random error: hand it up.
3572
3946
                    raise
3573
3947
            else:
3574
 
                root_dir_info = ('', current_root,
3575
 
                    osutils.file_kind_from_stat_mode(root_stat.st_mode), root_stat,
3576
 
                    root_abspath)
 
3948
                root_dir_info = (b'', current_root,
 
3949
                                 osutils.file_kind_from_stat_mode(
 
3950
                                     root_stat.st_mode), root_stat,
 
3951
                                 root_abspath)
3577
3952
                if root_dir_info[2] == 'directory':
3578
3953
                    if self.tree._directory_is_tree_reference(
3579
 
                        current_root.decode('utf8')):
 
3954
                            current_root.decode('utf8')):
3580
3955
                        root_dir_info = root_dir_info[:2] + \
3581
3956
                            ('tree-reference',) + root_dir_info[3:]
3582
3957
 
3596
3971
                new_executable = bool(
3597
3972
                    stat.S_ISREG(root_dir_info[3].st_mode)
3598
3973
                    and stat.S_IEXEC & root_dir_info[3].st_mode)
3599
 
                yield (None,
3600
 
                       (None, current_root_unicode),
3601
 
                       True,
3602
 
                       (False, False),
3603
 
                       (None, None),
3604
 
                       (None, splitpath(current_root_unicode)[-1]),
3605
 
                       (None, root_dir_info[2]),
3606
 
                       (None, new_executable)
3607
 
                      )
3608
 
            initial_key = (current_root, '', '')
 
3974
                yield TreeChange(
 
3975
                    None,
 
3976
                    (None, current_root_unicode),
 
3977
                    True,
 
3978
                    (False, False),
 
3979
                    (None, None),
 
3980
                    (None, splitpath(current_root_unicode)[-1]),
 
3981
                    (None, root_dir_info[2]),
 
3982
                    (None, new_executable)
 
3983
                    )
 
3984
            initial_key = (current_root, b'', b'')
3609
3985
            block_index, _ = self.state._find_block_index_from_key(initial_key)
3610
3986
            if block_index == 0:
3611
3987
                # we have processed the total root already, but because the
3612
3988
                # initial key matched it we should skip it here.
3613
 
                block_index +=1
 
3989
                block_index += 1
3614
3990
            if root_dir_info and root_dir_info[2] == 'tree-reference':
3615
3991
                current_dir_info = None
3616
3992
            else:
3617
 
                dir_iterator = osutils._walkdirs_utf8(root_abspath, prefix=current_root)
 
3993
                dir_iterator = osutils._walkdirs_utf8(
 
3994
                    root_abspath, prefix=current_root)
3618
3995
                try:
3619
 
                    current_dir_info = dir_iterator.next()
3620
 
                except OSError, e:
 
3996
                    current_dir_info = next(dir_iterator)
 
3997
                except OSError as e:
3621
3998
                    # on win32, python2.4 has e.errno == ERROR_DIRECTORY, but
3622
3999
                    # python 2.5 has e.errno == EINVAL,
3623
4000
                    #            and e.winerror == ERROR_DIRECTORY
3629
4006
                    if e.errno in (errno.ENOENT, errno.ENOTDIR, errno.EINVAL):
3630
4007
                        current_dir_info = None
3631
4008
                    elif (sys.platform == 'win32'
3632
 
                          and (e.errno in win_errors
3633
 
                               or e_winerror in win_errors)):
 
4009
                          and (e.errno in win_errors or
 
4010
                               e_winerror in win_errors)):
3634
4011
                        current_dir_info = None
3635
4012
                    else:
3636
4013
                        raise
3637
4014
                else:
3638
 
                    if current_dir_info[0][0] == '':
 
4015
                    if current_dir_info[0][0] == b'':
3639
4016
                        # remove .bzr from iteration
3640
 
                        bzr_index = bisect.bisect_left(current_dir_info[1], ('.bzr',))
3641
 
                        if current_dir_info[1][bzr_index][0] != '.bzr':
 
4017
                        bzr_index = bisect.bisect_left(
 
4018
                            current_dir_info[1], (b'.bzr',))
 
4019
                        if current_dir_info[1][bzr_index][0] != b'.bzr':
3642
4020
                            raise AssertionError()
3643
4021
                        del current_dir_info[1][bzr_index]
3644
4022
            # walk until both the directory listing and the versioned metadata
3645
4023
            # are exhausted.
3646
4024
            if (block_index < len(self.state._dirblocks) and
3647
 
                osutils.is_inside(current_root, self.state._dirblocks[block_index][0])):
 
4025
                osutils.is_inside(current_root,
 
4026
                                  self.state._dirblocks[block_index][0])):
3648
4027
                current_block = self.state._dirblocks[block_index]
3649
4028
            else:
3650
4029
                current_block = None
3651
4030
            while (current_dir_info is not None or
3652
4031
                   current_block is not None):
3653
4032
                if (current_dir_info and current_block
3654
 
                    and current_dir_info[0][0] != current_block[0]):
3655
 
                    if _cmp_by_dirs(current_dir_info[0][0], current_block[0]) < 0:
 
4033
                        and current_dir_info[0][0] != current_block[0]):
 
4034
                    if _lt_by_dirs(current_dir_info[0][0], current_block[0]):
3656
4035
                        # filesystem data refers to paths not covered by the dirblock.
3657
4036
                        # this has two possibilities:
3658
4037
                        # A) it is versioned but empty, so there is no block for it
3664
4043
                        # recurse into unknown directories.
3665
4044
                        path_index = 0
3666
4045
                        while path_index < len(current_dir_info[1]):
3667
 
                                current_path_info = current_dir_info[1][path_index]
3668
 
                                if self.want_unversioned:
3669
 
                                    if current_path_info[2] == 'directory':
3670
 
                                        if self.tree._directory_is_tree_reference(
 
4046
                            current_path_info = current_dir_info[1][path_index]
 
4047
                            if self.want_unversioned:
 
4048
                                if current_path_info[2] == 'directory':
 
4049
                                    if self.tree._directory_is_tree_reference(
3671
4050
                                            current_path_info[0].decode('utf8')):
3672
 
                                            current_path_info = current_path_info[:2] + \
3673
 
                                                ('tree-reference',) + current_path_info[3:]
3674
 
                                    new_executable = bool(
3675
 
                                        stat.S_ISREG(current_path_info[3].st_mode)
3676
 
                                        and stat.S_IEXEC & current_path_info[3].st_mode)
3677
 
                                    yield (None,
3678
 
                                        (None, utf8_decode(current_path_info[0])[0]),
3679
 
                                        True,
3680
 
                                        (False, False),
3681
 
                                        (None, None),
3682
 
                                        (None, utf8_decode(current_path_info[1])[0]),
3683
 
                                        (None, current_path_info[2]),
3684
 
                                        (None, new_executable))
3685
 
                                # dont descend into this unversioned path if it is
3686
 
                                # a dir
3687
 
                                if current_path_info[2] in ('directory',
3688
 
                                                            'tree-reference'):
3689
 
                                    del current_dir_info[1][path_index]
3690
 
                                    path_index -= 1
3691
 
                                path_index += 1
 
4051
                                        current_path_info = current_path_info[:2] + \
 
4052
                                            ('tree-reference',) + \
 
4053
                                            current_path_info[3:]
 
4054
                                new_executable = bool(
 
4055
                                    stat.S_ISREG(current_path_info[3].st_mode)
 
4056
                                    and stat.S_IEXEC & current_path_info[3].st_mode)
 
4057
                                yield TreeChange(
 
4058
                                    None,
 
4059
                                    (None, utf8_decode(current_path_info[0])[0]),
 
4060
                                    True,
 
4061
                                    (False, False),
 
4062
                                    (None, None),
 
4063
                                    (None, utf8_decode(current_path_info[1])[0]),
 
4064
                                    (None, current_path_info[2]),
 
4065
                                    (None, new_executable))
 
4066
                            # dont descend into this unversioned path if it is
 
4067
                            # a dir
 
4068
                            if current_path_info[2] in ('directory',
 
4069
                                                        'tree-reference'):
 
4070
                                del current_dir_info[1][path_index]
 
4071
                                path_index -= 1
 
4072
                            path_index += 1
3692
4073
 
3693
4074
                        # This dir info has been handled, go to the next
3694
4075
                        try:
3695
 
                            current_dir_info = dir_iterator.next()
 
4076
                            current_dir_info = next(dir_iterator)
3696
4077
                        except StopIteration:
3697
4078
                            current_dir_info = None
3698
4079
                    else:
3706
4087
                        for current_entry in current_block[1]:
3707
4088
                            # entry referring to file not present on disk.
3708
4089
                            # advance the entry only, after processing.
3709
 
                            result, changed = _process_entry(current_entry, None)
 
4090
                            result, changed = _process_entry(
 
4091
                                current_entry, None)
3710
4092
                            if changed is not None:
3711
4093
                                if changed:
3712
4094
                                    self._gather_result_for_consistency(result)
3713
4095
                                if changed or self.include_unchanged:
3714
4096
                                    yield result
3715
 
                        block_index +=1
 
4097
                        block_index += 1
3716
4098
                        if (block_index < len(self.state._dirblocks) and
3717
4099
                            osutils.is_inside(current_root,
3718
4100
                                              self.state._dirblocks[block_index][0])):
3731
4113
                    current_path_info = current_dir_info[1][path_index]
3732
4114
                    if current_path_info[2] == 'directory':
3733
4115
                        if self.tree._directory_is_tree_reference(
3734
 
                            current_path_info[0].decode('utf8')):
 
4116
                                current_path_info[0].decode('utf8')):
3735
4117
                            current_path_info = current_path_info[:2] + \
3736
4118
                                ('tree-reference',) + current_path_info[3:]
3737
4119
                else:
3739
4121
                advance_path = True
3740
4122
                path_handled = False
3741
4123
                while (current_entry is not None or
3742
 
                    current_path_info is not None):
 
4124
                       current_path_info is not None):
3743
4125
                    if current_entry is None:
3744
4126
                        # the check for path_handled when the path is advanced
3745
4127
                        # will yield this path if needed.
3746
4128
                        pass
3747
4129
                    elif current_path_info is None:
3748
4130
                        # no path is fine: the per entry code will handle it.
3749
 
                        result, changed = _process_entry(current_entry, current_path_info)
 
4131
                        result, changed = _process_entry(
 
4132
                            current_entry, current_path_info)
3750
4133
                        if changed is not None:
3751
4134
                            if changed:
3752
4135
                                self._gather_result_for_consistency(result)
3753
4136
                            if changed or self.include_unchanged:
3754
4137
                                yield result
3755
4138
                    elif (current_entry[0][1] != current_path_info[1]
3756
 
                          or current_entry[1][self.target_index][0] in 'ar'):
 
4139
                          or current_entry[1][self.target_index][0] in (b'a', b'r')):
3757
4140
                        # The current path on disk doesn't match the dirblock
3758
4141
                        # record. Either the dirblock is marked as absent, or
3759
4142
                        # the file on disk is not present at all in the
3769
4152
                        else:
3770
4153
                            # entry referring to file not present on disk.
3771
4154
                            # advance the entry only, after processing.
3772
 
                            result, changed = _process_entry(current_entry, None)
 
4155
                            result, changed = _process_entry(
 
4156
                                current_entry, None)
3773
4157
                            if changed is not None:
3774
4158
                                if changed:
3775
4159
                                    self._gather_result_for_consistency(result)
3777
4161
                                    yield result
3778
4162
                            advance_path = False
3779
4163
                    else:
3780
 
                        result, changed = _process_entry(current_entry, current_path_info)
 
4164
                        result, changed = _process_entry(
 
4165
                            current_entry, current_path_info)
3781
4166
                        if changed is not None:
3782
4167
                            path_handled = True
3783
4168
                            if changed:
3791
4176
                        else:
3792
4177
                            current_entry = None
3793
4178
                    else:
3794
 
                        advance_entry = True # reset the advance flaga
 
4179
                        advance_entry = True  # reset the advance flaga
3795
4180
                    if advance_path and current_path_info is not None:
3796
4181
                        if not path_handled:
3797
4182
                            # unversioned in all regards
3800
4185
                                    stat.S_ISREG(current_path_info[3].st_mode)
3801
4186
                                    and stat.S_IEXEC & current_path_info[3].st_mode)
3802
4187
                                try:
3803
 
                                    relpath_unicode = utf8_decode(current_path_info[0])[0]
 
4188
                                    relpath_unicode = utf8_decode(
 
4189
                                        current_path_info[0])[0]
3804
4190
                                except UnicodeDecodeError:
3805
4191
                                    raise errors.BadFilenameEncoding(
3806
4192
                                        current_path_info[0], osutils._fs_enc)
3807
 
                                yield (None,
 
4193
                                yield TreeChange(
 
4194
                                    None,
3808
4195
                                    (None, relpath_unicode),
3809
4196
                                    True,
3810
4197
                                    (False, False),
3827
4214
                            current_path_info = current_dir_info[1][path_index]
3828
4215
                            if current_path_info[2] == 'directory':
3829
4216
                                if self.tree._directory_is_tree_reference(
3830
 
                                    current_path_info[0].decode('utf8')):
 
4217
                                        current_path_info[0].decode('utf8')):
3831
4218
                                    current_path_info = current_path_info[:2] + \
3832
 
                                        ('tree-reference',) + current_path_info[3:]
 
4219
                                        ('tree-reference',) + \
 
4220
                                        current_path_info[3:]
3833
4221
                        else:
3834
4222
                            current_path_info = None
3835
4223
                        path_handled = False
3836
4224
                    else:
3837
 
                        advance_path = True # reset the advance flagg.
 
4225
                        advance_path = True  # reset the advance flagg.
3838
4226
                if current_block is not None:
3839
4227
                    block_index += 1
3840
4228
                    if (block_index < len(self.state._dirblocks) and
3841
 
                        osutils.is_inside(current_root, self.state._dirblocks[block_index][0])):
 
4229
                        osutils.is_inside(current_root,
 
4230
                                          self.state._dirblocks[block_index][0])):
3842
4231
                        current_block = self.state._dirblocks[block_index]
3843
4232
                    else:
3844
4233
                        current_block = None
3845
4234
                if current_dir_info is not None:
3846
4235
                    try:
3847
 
                        current_dir_info = dir_iterator.next()
 
4236
                        current_dir_info = next(dir_iterator)
3848
4237
                    except StopIteration:
3849
4238
                        current_dir_info = None
3850
4239
        for result in self._iter_specific_file_parents():
3872
4261
            found_item = False
3873
4262
            for candidate_entry in path_entries:
3874
4263
                # Find entries present in target at this path:
3875
 
                if candidate_entry[1][self.target_index][0] not in 'ar':
 
4264
                if candidate_entry[1][self.target_index][0] not in (b'a', b'r'):
3876
4265
                    found_item = True
3877
4266
                    selected_entries.append(candidate_entry)
3878
4267
                # Find entries present in source at this path:
3879
4268
                elif (self.source_index is not None and
3880
 
                    candidate_entry[1][self.source_index][0] not in 'ar'):
 
4269
                      candidate_entry[1][self.source_index][0] not in (b'a', b'r')):
3881
4270
                    found_item = True
3882
 
                    if candidate_entry[1][self.target_index][0] == 'a':
 
4271
                    if candidate_entry[1][self.target_index][0] == b'a':
3883
4272
                        # Deleted, emit it here.
3884
4273
                        selected_entries.append(candidate_entry)
3885
4274
                    else:
3890
4279
            if not found_item:
3891
4280
                raise AssertionError(
3892
4281
                    "Missing entry for specific path parent %r, %r" % (
3893
 
                    path_utf8, path_entries))
 
4282
                        path_utf8, path_entries))
3894
4283
            path_info = self._path_info(path_utf8, path_utf8.decode('utf8'))
3895
4284
            for entry in selected_entries:
3896
4285
                if entry[0][2] in self.seen_ids:
3900
4289
                    raise AssertionError(
3901
4290
                        "Got entry<->path mismatch for specific path "
3902
4291
                        "%r entry %r path_info %r " % (
3903
 
                        path_utf8, entry, path_info))
 
4292
                            path_utf8, entry, path_info))
3904
4293
                # Only include changes - we're outside the users requested
3905
4294
                # expansion.
3906
4295
                if changed:
3907
4296
                    self._gather_result_for_consistency(result)
3908
4297
                    if (result[6][0] == 'directory' and
3909
 
                        result[6][1] != 'directory'):
 
4298
                            result[6][1] != 'directory'):
3910
4299
                        # This stopped being a directory, the old children have
3911
4300
                        # to be included.
3912
 
                        if entry[1][self.source_index][0] == 'r':
 
4301
                        if entry[1][self.source_index][0] == b'r':
3913
4302
                            # renamed, take the source path
3914
4303
                            entry_path_utf8 = entry[1][self.source_index][1]
3915
4304
                        else:
3916
4305
                            entry_path_utf8 = path_utf8
3917
 
                        initial_key = (entry_path_utf8, '', '')
 
4306
                        initial_key = (entry_path_utf8, b'', b'')
3918
4307
                        block_index, _ = self.state._find_block_index_from_key(
3919
4308
                            initial_key)
3920
4309
                        if block_index == 0:
3921
4310
                            # The children of the root are in block index 1.
3922
 
                            block_index +=1
 
4311
                            block_index += 1
3923
4312
                        current_block = None
3924
4313
                        if block_index < len(self.state._dirblocks):
3925
4314
                            current_block = self.state._dirblocks[block_index]
3926
4315
                            if not osutils.is_inside(
3927
 
                                entry_path_utf8, current_block[0]):
 
4316
                                    entry_path_utf8, current_block[0]):
3928
4317
                                # No entries for this directory at all.
3929
4318
                                current_block = None
3930
4319
                        if current_block is not None:
3931
4320
                            for entry in current_block[1]:
3932
 
                                if entry[1][self.source_index][0] in 'ar':
 
4321
                                if entry[1][self.source_index][0] in (b'a', b'r'):
3933
4322
                                    # Not in the source tree, so doesn't have to be
3934
4323
                                    # included.
3935
4324
                                    continue
3949
4338
        abspath = self.tree.abspath(unicode_path)
3950
4339
        try:
3951
4340
            stat = os.lstat(abspath)
3952
 
        except OSError, e:
 
4341
        except OSError as e:
3953
4342
            if e.errno == errno.ENOENT:
3954
4343
                # the path does not exist.
3955
4344
                return None
3956
4345
            else:
3957
4346
                raise
3958
 
        utf8_basename = utf8_path.rsplit('/', 1)[-1]
 
4347
        utf8_basename = utf8_path.rsplit(b'/', 1)[-1]
3959
4348
        dir_info = (utf8_path, utf8_basename,
3960
 
            osutils.file_kind_from_stat_mode(stat.st_mode), stat,
3961
 
            abspath)
 
4349
                    osutils.file_kind_from_stat_mode(stat.st_mode), stat,
 
4350
                    abspath)
3962
4351
        if dir_info[2] == 'directory':
3963
4352
            if self.tree._directory_is_tree_reference(
3964
 
                unicode_path):
 
4353
                    unicode_path):
3965
4354
                self.root_dir_info = self.root_dir_info[:2] + \
3966
4355
                    ('tree-reference',) + self.root_dir_info[3:]
3967
4356
        return dir_info
3969
4358
 
3970
4359
# Try to load the compiled form if possible
3971
4360
try:
3972
 
    from bzrlib._dirstate_helpers_pyx import (
 
4361
    from ._dirstate_helpers_pyx import (
3973
4362
        _read_dirblocks,
3974
4363
        bisect_dirblock,
3975
4364
        _bisect_path_left,
3976
4365
        _bisect_path_right,
3977
 
        cmp_by_dirs,
 
4366
        lt_by_dirs,
 
4367
        pack_stat,
3978
4368
        ProcessEntryC as _process_entry,
3979
4369
        update_entry as update_entry,
3980
4370
        )
3981
 
except ImportError, e:
 
4371
except ImportError as e:
3982
4372
    osutils.failed_to_load_extension(e)
3983
 
    from bzrlib._dirstate_helpers_py import (
 
4373
    from ._dirstate_helpers_py import (
3984
4374
        _read_dirblocks,
3985
4375
        bisect_dirblock,
3986
4376
        _bisect_path_left,
3987
4377
        _bisect_path_right,
3988
 
        cmp_by_dirs,
 
4378
        lt_by_dirs,
 
4379
        pack_stat,
3989
4380
        )
3990
4381
    # FIXME: It would be nice to be able to track moved lines so that the
3991
4382
    # corresponding python code can be moved to the _dirstate_helpers_py