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