/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: 2018-11-21 03:39:28 UTC
  • mto: This revision was merged to the branch mainline in revision 7206.
  • Revision ID: jelmer@jelmer.uk-20181121033928-ck4sb5zfdwosw35b
Fix test.

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