/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/dirstate.py

  • Committer: Jelmer Vernooij
  • Date: 2017-06-08 00:00:28 UTC
  • mto: This revision was merged to the branch mainline in revision 6672.
  • Revision ID: jelmer@jelmer.uk-20170608000028-e3ggtt4wjbcjh91j
Drop pycurl support.

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]: ''
 
82
    entries[0][1]: ''
 
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
    '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
    'a' is an absent entry: In that tree the id is not present at this path.
 
93
    '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
    '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
    'l' is a symlink entry: As for directory, but a symlink. The fingerprint is
 
100
        the link target.
 
101
    '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 breezy import (
217
234
    cache_utf8,
 
235
    config,
218
236
    debug,
219
237
    errors,
220
238
    inventory,
221
239
    lock,
222
240
    osutils,
 
241
    static_tuple,
223
242
    trace,
 
243
    urlutils,
 
244
    )
 
245
from .sixish import (
 
246
    range,
 
247
    viewitems,
 
248
    viewvalues,
224
249
    )
225
250
 
226
251
 
231
256
ERROR_DIRECTORY = 267
232
257
 
233
258
 
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)
265
 
 
266
 
 
267
259
class SHA1Provider(object):
268
260
    """An interface for getting sha1s of a file."""
269
261
 
354
346
    NOT_IN_MEMORY = 0
355
347
    IN_MEMORY_UNMODIFIED = 1
356
348
    IN_MEMORY_MODIFIED = 2
 
349
    IN_MEMORY_HASH_MODIFIED = 3 # Only hash-cache updates
357
350
 
358
351
    # A pack_stat (the x's) that is just noise and will never match the output
359
352
    # of base64 encode.
360
353
    NULLSTAT = 'x' * 32
361
 
    NULL_PARENT_DETAILS = ('a', '', 0, False, '')
 
354
    NULL_PARENT_DETAILS = static_tuple.StaticTuple('a', '', 0, False, '')
362
355
 
363
356
    HEADER_FORMAT_2 = '#bazaar dirstate flat format 2\n'
364
357
    HEADER_FORMAT_3 = '#bazaar dirstate flat format 3\n'
365
358
 
366
 
    def __init__(self, path, sha1_provider):
 
359
    def __init__(self, path, sha1_provider, worth_saving_limit=0):
367
360
        """Create a  DirState object.
368
361
 
369
362
        :param path: The path at which the dirstate file on disk should live.
370
363
        :param sha1_provider: an object meeting the SHA1Provider interface.
 
364
        :param worth_saving_limit: when the exact number of hash changed
 
365
            entries is known, only bother saving the dirstate if more than
 
366
            this count of entries have changed.
 
367
            -1 means never save hash changes, 0 means always save hash changes.
371
368
        """
372
369
        # _header_state and _dirblock_state represent the current state
373
370
        # of the dirstate metadata and the per-row data respectiely.
410
407
        # during commit.
411
408
        self._last_block_index = None
412
409
        self._last_entry_index = None
 
410
        # The set of known hash changes
 
411
        self._known_hash_changes = set()
 
412
        # How many hash changed entries can we have without saving
 
413
        self._worth_saving_limit = worth_saving_limit
 
414
        self._config_stack = config.LocationStack(urlutils.local_path_to_url(
 
415
            path))
413
416
 
414
417
    def __repr__(self):
415
418
        return "%s(%r)" % \
416
419
            (self.__class__.__name__, self._filename)
417
420
 
 
421
    def _mark_modified(self, hash_changed_entries=None, header_modified=False):
 
422
        """Mark this dirstate as modified.
 
423
 
 
424
        :param hash_changed_entries: if non-None, mark just these entries as
 
425
            having their hash modified.
 
426
        :param header_modified: mark the header modified as well, not just the
 
427
            dirblocks.
 
428
        """
 
429
        #trace.mutter_callsite(3, "modified hash entries: %s", hash_changed_entries)
 
430
        if hash_changed_entries:
 
431
            self._known_hash_changes.update([e[0] for e in hash_changed_entries])
 
432
            if self._dirblock_state in (DirState.NOT_IN_MEMORY,
 
433
                                        DirState.IN_MEMORY_UNMODIFIED):
 
434
                # If the dirstate is already marked a IN_MEMORY_MODIFIED, then
 
435
                # that takes precedence.
 
436
                self._dirblock_state = DirState.IN_MEMORY_HASH_MODIFIED
 
437
        else:
 
438
            # TODO: Since we now have a IN_MEMORY_HASH_MODIFIED state, we
 
439
            #       should fail noisily if someone tries to set
 
440
            #       IN_MEMORY_MODIFIED but we don't have a write-lock!
 
441
            # We don't know exactly what changed so disable smart saving
 
442
            self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
443
        if header_modified:
 
444
            self._header_state = DirState.IN_MEMORY_MODIFIED
 
445
 
 
446
    def _mark_unmodified(self):
 
447
        """Mark this dirstate as unmodified."""
 
448
        self._header_state = DirState.IN_MEMORY_UNMODIFIED
 
449
        self._dirblock_state = DirState.IN_MEMORY_UNMODIFIED
 
450
        self._known_hash_changes = set()
 
451
 
418
452
    def add(self, path, file_id, kind, stat, fingerprint):
419
453
        """Add a path to be tracked.
420
454
 
489
523
                block[entry_index][0][0:2] == first_key[0:2]):
490
524
                if block[entry_index][1][0][0] not in 'ar':
491
525
                    # this path is in the dirstate in the current tree.
492
 
                    raise Exception, "adding already added path!"
 
526
                    raise Exception("adding already added path!")
493
527
                entry_index += 1
494
528
        else:
495
529
            # The block where we want to put the file is not present. But it
546
580
        if kind == 'directory':
547
581
           # insert a new dirblock
548
582
           self._ensure_block(block_index, entry_index, utf8path)
549
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
583
        self._mark_modified()
550
584
        if self._id_index:
551
 
            self._id_index.setdefault(entry_key[2], set()).add(entry_key)
 
585
            self._add_to_id_index(self._id_index, entry_key)
552
586
 
553
587
    def _bisect(self, paths):
554
588
        """Bisect through the disk structure for specific rows.
705
739
                    # careful if we should append rather than overwrite
706
740
                    if last_entry_num != first_entry_num:
707
741
                        paths.setdefault(last_path, []).append(last_fields)
708
 
                    for num in xrange(first_entry_num+1, last_entry_num):
 
742
                    for num in range(first_entry_num+1, last_entry_num):
709
743
                        # TODO: jam 20070223 We are already splitting here, so
710
744
                        #       shouldn't we just split the whole thing rather
711
745
                        #       than doing the split again in add_one_record?
891
925
                    # careful if we should append rather than overwrite
892
926
                    if last_entry_num != first_entry_num:
893
927
                        paths.setdefault(last_dir, []).append(last_fields)
894
 
                    for num in xrange(first_entry_num+1, last_entry_num):
 
928
                    for num in range(first_entry_num+1, last_entry_num):
895
929
                        # TODO: jam 20070223 We are already splitting here, so
896
930
                        #       shouldn't we just split the whole thing rather
897
931
                        #       than doing the split again in add_one_record?
943
977
            # Directories that need to be read
944
978
            pending_dirs = set()
945
979
            paths_to_search = set()
946
 
            for entry_list in newly_found.itervalues():
 
980
            for entry_list in viewvalues(newly_found):
947
981
                for dir_name_id, trees_info in entry_list:
948
982
                    found[dir_name_id] = trees_info
949
983
                    found_dir_names.add(dir_name_id[:2])
993
1027
            return
994
1028
        # only require all dirblocks if we are doing a full-pass removal.
995
1029
        self._read_dirblocks_if_needed()
996
 
        dead_patterns = set([('a', 'r'), ('a', 'a'), ('r', 'r'), ('r', 'a')])
 
1030
        dead_patterns = {('a', 'r'), ('a', 'a'), ('r', 'r'), ('r', 'a')}
997
1031
        def iter_entries_removable():
998
1032
            for block in self._dirblocks:
999
1033
                deleted_positions = []
1018
1052
 
1019
1053
        self._ghosts = []
1020
1054
        self._parents = [parents[0]]
1021
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
1022
 
        self._header_state = DirState.IN_MEMORY_MODIFIED
 
1055
        self._mark_modified(header_modified=True)
1023
1056
 
1024
1057
    def _empty_parent_info(self):
1025
1058
        return [DirState.NULL_PARENT_DETAILS] * (len(self._parents) -
1154
1187
    def _fields_per_entry(self):
1155
1188
        """How many null separated fields should be in each entry row.
1156
1189
 
1157
 
        Each line now has an extra '\n' field which is not used
 
1190
        Each line now has an extra '\\n' field which is not used
1158
1191
        so we just skip over it
1159
 
        entry size:
 
1192
 
 
1193
        entry size::
1160
1194
            3 fields for the key
1161
1195
            + number of fields per tree_data (5) * tree count
1162
1196
            + newline
1263
1297
                    parent_trees.append((parent_id, parent_tree))
1264
1298
                    parent_tree.lock_read()
1265
1299
                result.set_parent_trees(parent_trees, [])
1266
 
                result.set_state_from_inventory(tree.inventory)
 
1300
                result.set_state_from_inventory(tree.root_inventory)
1267
1301
            finally:
1268
1302
                for revid, parent_tree in parent_trees:
1269
1303
                    parent_tree.unlock()
1275
1309
            raise
1276
1310
        return result
1277
1311
 
 
1312
    def _check_delta_is_valid(self, delta):
 
1313
        return list(inventory._check_delta_unique_ids(
 
1314
                    inventory._check_delta_unique_old_paths(
 
1315
                    inventory._check_delta_unique_new_paths(
 
1316
                    inventory._check_delta_ids_match_entry(
 
1317
                    inventory._check_delta_ids_are_valid(
 
1318
                    inventory._check_delta_new_path_entry_both_or_None(delta)))))))
 
1319
 
1278
1320
    def update_by_delta(self, delta):
1279
1321
        """Apply an inventory delta to the dirstate for tree 0
1280
1322
 
1298
1340
        new_ids = set()
1299
1341
        # This loop transforms the delta to single atomic operations that can
1300
1342
        # 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):
 
1343
        delta = sorted(self._check_delta_is_valid(delta), reverse=True)
 
1344
        for old_path, new_path, file_id, inv_entry in delta:
1308
1345
            if (file_id in insertions) or (file_id in removals):
1309
 
                raise errors.InconsistentDelta(old_path or new_path, file_id,
 
1346
                self._raise_invalid(old_path or new_path, file_id,
1310
1347
                    "repeated file_id")
1311
1348
            if old_path is not None:
1312
1349
                old_path = old_path.encode('utf-8')
1315
1352
                new_ids.add(file_id)
1316
1353
            if new_path is not None:
1317
1354
                if inv_entry is None:
1318
 
                    raise errors.InconsistentDelta(new_path, file_id,
 
1355
                    self._raise_invalid(new_path, file_id,
1319
1356
                        "new_path with no entry")
1320
1357
                new_path = new_path.encode('utf-8')
1321
1358
                dirname_utf8, basename = osutils.split(new_path)
1351
1388
                                               fingerprint, new_child_path)
1352
1389
        self._check_delta_ids_absent(new_ids, delta, 0)
1353
1390
        try:
1354
 
            self._apply_removals(removals.iteritems())
1355
 
            self._apply_insertions(insertions.values())
 
1391
            self._apply_removals(viewitems(removals))
 
1392
            self._apply_insertions(viewvalues(insertions))
1356
1393
            # Validate parents
1357
1394
            self._after_delta_check_parents(parents, 0)
1358
 
        except errors.BzrError, e:
 
1395
        except errors.BzrError as e:
1359
1396
            self._changes_aborted = True
1360
1397
            if 'integrity error' not in str(e):
1361
1398
                raise
1362
1399
            # _get_entry raises BzrError when a request is inconsistent; we
1363
1400
            # want such errors to be shown as InconsistentDelta - and that 
1364
1401
            # fits the behaviour we trigger.
1365
 
            raise errors.InconsistentDeltaDelta(delta, "error from _get_entry.")
 
1402
            raise errors.InconsistentDeltaDelta(delta,
 
1403
                "error from _get_entry. %s" % (e,))
1366
1404
 
1367
1405
    def _apply_removals(self, removals):
1368
1406
        for file_id, path in sorted(removals, reverse=True,
1373
1411
            try:
1374
1412
                entry = self._dirblocks[block_i][1][entry_i]
1375
1413
            except IndexError:
1376
 
                self._changes_aborted = True
1377
 
                raise errors.InconsistentDelta(path, file_id,
 
1414
                self._raise_invalid(path, file_id,
1378
1415
                    "Wrong path for old path.")
1379
1416
            if not f_present or entry[1][0][0] in 'ar':
1380
 
                self._changes_aborted = True
1381
 
                raise errors.InconsistentDelta(path, file_id,
 
1417
                self._raise_invalid(path, file_id,
1382
1418
                    "Wrong path for old path.")
1383
1419
            if file_id != entry[0][2]:
1384
 
                self._changes_aborted = True
1385
 
                raise errors.InconsistentDelta(path, file_id,
 
1420
                self._raise_invalid(path, file_id,
1386
1421
                    "Attempt to remove path has wrong id - found %r."
1387
1422
                    % entry[0][2])
1388
1423
            self._make_absent(entry)
1398
1433
                # be due to it being in a parent tree, or a corrupt delta.
1399
1434
                for child_entry in self._dirblocks[block_i][1]:
1400
1435
                    if child_entry[1][0][0] not in ('r', 'a'):
1401
 
                        self._changes_aborted = True
1402
 
                        raise errors.InconsistentDelta(path, entry[0][2],
 
1436
                        self._raise_invalid(path, entry[0][2],
1403
1437
                            "The file id was deleted but its children were "
1404
1438
                            "not deleted.")
1405
1439
 
1409
1443
                self.update_minimal(key, minikind, executable, fingerprint,
1410
1444
                                    path_utf8=path_utf8)
1411
1445
        except errors.NotVersionedError:
1412
 
            self._changes_aborted = True
1413
 
            raise errors.InconsistentDelta(path_utf8.decode('utf8'), key[2],
 
1446
            self._raise_invalid(path_utf8.decode('utf8'), key[2],
1414
1447
                "Missing parent")
1415
1448
 
1416
1449
    def update_basis_by_delta(self, delta, new_revid):
1424
1457
        Note that an exception during the operation of this method will leave
1425
1458
        the dirstate in a corrupt state where it should not be saved.
1426
1459
 
1427
 
        Finally, we expect all changes to be synchronising the basis tree with
1428
 
        the working tree.
1429
 
 
1430
1460
        :param new_revid: The new revision id for the trees parent.
1431
1461
        :param delta: An inventory delta (see apply_inventory_delta) describing
1432
1462
            the changes from the current left most parent revision to new_revid.
1444
1474
 
1445
1475
        self._parents[0] = new_revid
1446
1476
 
1447
 
        delta = sorted(delta, reverse=True)
 
1477
        delta = sorted(self._check_delta_is_valid(delta), reverse=True)
1448
1478
        adds = []
1449
1479
        changes = []
1450
1480
        deletes = []
1471
1501
        new_ids = set()
1472
1502
        for old_path, new_path, file_id, inv_entry in delta:
1473
1503
            if inv_entry is not None and file_id != inv_entry.file_id:
1474
 
                raise errors.InconsistentDelta(new_path, file_id,
 
1504
                self._raise_invalid(new_path, file_id,
1475
1505
                    "mismatched entry file_id %r" % inv_entry)
1476
 
            if new_path is not None:
 
1506
            if new_path is None:
 
1507
                new_path_utf8 = None
 
1508
            else:
1477
1509
                if inv_entry is None:
1478
 
                    raise errors.InconsistentDelta(new_path, file_id,
 
1510
                    self._raise_invalid(new_path, file_id,
1479
1511
                        "new_path with no entry")
1480
1512
                new_path_utf8 = encode(new_path)
1481
1513
                # note the parent for validation
1483
1515
                if basename_utf8:
1484
1516
                    parents.add((dirname_utf8, inv_entry.parent_id))
1485
1517
            if old_path is None:
1486
 
                adds.append((None, encode(new_path), file_id,
 
1518
                old_path_utf8 = None
 
1519
            else:
 
1520
                old_path_utf8 = encode(old_path)
 
1521
            if old_path is None:
 
1522
                adds.append((None, new_path_utf8, file_id,
1487
1523
                    inv_to_entry(inv_entry), True))
1488
1524
                new_ids.add(file_id)
1489
1525
            elif new_path is None:
1490
 
                deletes.append((encode(old_path), None, file_id, None, True))
1491
 
            elif (old_path, new_path) != root_only:
 
1526
                deletes.append((old_path_utf8, None, file_id, None, True))
 
1527
            elif (old_path, new_path) == root_only:
 
1528
                # change things in-place
 
1529
                # Note: the case of a parent directory changing its file_id
 
1530
                #       tends to break optimizations here, because officially
 
1531
                #       the file has actually been moved, it just happens to
 
1532
                #       end up at the same path. If we can figure out how to
 
1533
                #       handle that case, we can avoid a lot of add+delete
 
1534
                #       pairs for objects that stay put.
 
1535
                # elif old_path == new_path:
 
1536
                changes.append((old_path_utf8, new_path_utf8, file_id,
 
1537
                                inv_to_entry(inv_entry)))
 
1538
            else:
1492
1539
                # Renames:
1493
1540
                # Because renames must preserve their children we must have
1494
1541
                # processed all relocations and removes before hand. The sort
1504
1551
                self._update_basis_apply_deletes(deletes)
1505
1552
                deletes = []
1506
1553
                # Split into an add/delete pair recursively.
1507
 
                adds.append((None, new_path_utf8, file_id,
1508
 
                    inv_to_entry(inv_entry), False))
 
1554
                adds.append((old_path_utf8, new_path_utf8, file_id,
 
1555
                             inv_to_entry(inv_entry), False))
1509
1556
                # Expunge deletes that we've seen so that deleted/renamed
1510
1557
                # children of a rename directory are handled correctly.
1511
 
                new_deletes = reversed(list(self._iter_child_entries(1,
1512
 
                    encode(old_path))))
 
1558
                new_deletes = reversed(list(
 
1559
                    self._iter_child_entries(1, old_path_utf8)))
1513
1560
                # Remove the current contents of the tree at orig_path, and
1514
1561
                # reinsert at the correct new path.
1515
1562
                for entry in new_deletes:
1516
 
                    if entry[0][0]:
1517
 
                        source_path = entry[0][0] + '/' + entry[0][1]
 
1563
                    child_dirname, child_basename, child_file_id = entry[0]
 
1564
                    if child_dirname:
 
1565
                        source_path = child_dirname + '/' + child_basename
1518
1566
                    else:
1519
 
                        source_path = entry[0][1]
 
1567
                        source_path = child_basename
1520
1568
                    if new_path_utf8:
1521
 
                        target_path = new_path_utf8 + source_path[len(old_path):]
 
1569
                        target_path = \
 
1570
                            new_path_utf8 + source_path[len(old_path_utf8):]
1522
1571
                    else:
1523
 
                        if old_path == '':
 
1572
                        if old_path_utf8 == '':
1524
1573
                            raise AssertionError("cannot rename directory to"
1525
 
                                " itself")
1526
 
                        target_path = source_path[len(old_path) + 1:]
 
1574
                                                 " itself")
 
1575
                        target_path = source_path[len(old_path_utf8) + 1:]
1527
1576
                    adds.append((None, target_path, entry[0][2], entry[1][1], False))
1528
1577
                    deletes.append(
1529
1578
                        (source_path, target_path, entry[0][2], None, False))
1530
1579
                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)))
 
1580
                    (old_path_utf8, new_path_utf8, file_id, None, False))
 
1581
 
1537
1582
        self._check_delta_ids_absent(new_ids, delta, 1)
1538
1583
        try:
1539
1584
            # Finish expunging deletes/first half of renames.
1544
1589
            self._update_basis_apply_changes(changes)
1545
1590
            # Validate parents
1546
1591
            self._after_delta_check_parents(parents, 1)
1547
 
        except errors.BzrError, e:
 
1592
        except errors.BzrError as e:
1548
1593
            self._changes_aborted = True
1549
1594
            if 'integrity error' not in str(e):
1550
1595
                raise
1551
1596
            # _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.")
 
1597
            # want such errors to be shown as InconsistentDelta - and that
 
1598
            # fits the behaviour we trigger.
 
1599
            raise errors.InconsistentDeltaDelta(delta,
 
1600
                "error from _get_entry. %s" % (e,))
1557
1601
 
1558
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
1559
 
        self._header_state = DirState.IN_MEMORY_MODIFIED
 
1602
        self._mark_modified(header_modified=True)
1560
1603
        self._id_index = None
1561
1604
        return
1562
1605
 
1566
1609
            return
1567
1610
        id_index = self._get_id_index()
1568
1611
        for file_id in new_ids:
1569
 
            for key in id_index.get(file_id, []):
 
1612
            for key in id_index.get(file_id, ()):
1570
1613
                block_i, entry_i, d_present, f_present = \
1571
1614
                    self._get_block_entry_index(key[0], key[1], tree_index)
1572
1615
                if not f_present:
1576
1619
                if entry[0][2] != file_id:
1577
1620
                    # Different file_id, so not what we want.
1578
1621
                    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,
 
1622
                self._raise_invalid(("%s/%s" % key[0:2]).decode('utf8'), file_id,
1583
1623
                    "This file_id is new in the delta but already present in "
1584
1624
                    "the target")
1585
1625
 
 
1626
    def _raise_invalid(self, path, file_id, reason):
 
1627
        self._changes_aborted = True
 
1628
        raise errors.InconsistentDelta(path, file_id, reason)
 
1629
 
1586
1630
    def _update_basis_apply_adds(self, adds):
1587
1631
        """Apply a sequence of adds to tree 1 during update_basis_by_delta.
1588
1632
 
1596
1640
        """
1597
1641
        # Adds are accumulated partly from renames, so can be in any input
1598
1642
        # order - sort it.
1599
 
        adds.sort()
 
1643
        # TODO: we may want to sort in dirblocks order. That way each entry
 
1644
        #       will end up in the same directory, allowing the _get_entry
 
1645
        #       fast-path for looking up 2 items in the same dir work.
 
1646
        adds.sort(key=lambda x: x[1])
1600
1647
        # adds is now in lexographic order, which places all parents before
1601
1648
        # their children, so we can process it linearly.
1602
1649
        absent = 'ar'
 
1650
        st = static_tuple.StaticTuple
1603
1651
        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
 
1652
            dirname, basename = osutils.split(new_path)
 
1653
            entry_key = st(dirname, basename, file_id)
 
1654
            block_index, present = self._find_block_index_from_key(entry_key)
 
1655
            if not present:
 
1656
                # The block where we want to put the file is not present.
 
1657
                # However, it might have just been an empty directory. Look for
 
1658
                # the parent in the basis-so-far before throwing an error.
 
1659
                parent_dir, parent_base = osutils.split(dirname)
 
1660
                parent_block_idx, parent_entry_idx, _, parent_present = \
 
1661
                    self._get_block_entry_index(parent_dir, parent_base, 1)
 
1662
                if not parent_present:
 
1663
                    self._raise_invalid(new_path, file_id,
 
1664
                        "Unable to find block for this record."
 
1665
                        " Was the parent added?")
 
1666
                self._ensure_block(parent_block_idx, parent_entry_idx, dirname)
 
1667
 
 
1668
            block = self._dirblocks[block_index][1]
 
1669
            entry_index, present = self._find_entry_index(entry_key, block)
 
1670
            if real_add:
 
1671
                if old_path is not None:
 
1672
                    self._raise_invalid(new_path, file_id,
 
1673
                        'considered a real add but still had old_path at %s'
 
1674
                        % (old_path,))
 
1675
            if present:
 
1676
                entry = block[entry_index]
 
1677
                basis_kind = entry[1][1][0]
 
1678
                if basis_kind == 'a':
 
1679
                    entry[1][1] = new_details
 
1680
                elif basis_kind == 'r':
 
1681
                    raise NotImplementedError()
 
1682
                else:
 
1683
                    self._raise_invalid(new_path, file_id,
 
1684
                        "An entry was marked as a new add"
 
1685
                        " but the basis target already existed")
 
1686
            else:
 
1687
                # The exact key was not found in the block. However, we need to
 
1688
                # check if there is a key next to us that would have matched.
 
1689
                # We only need to check 2 locations, because there are only 2
 
1690
                # trees present.
 
1691
                for maybe_index in range(entry_index-1, entry_index+1):
 
1692
                    if maybe_index < 0 or maybe_index >= len(block):
 
1693
                        continue
 
1694
                    maybe_entry = block[maybe_index]
 
1695
                    if maybe_entry[0][:2] != (dirname, basename):
 
1696
                        # Just a random neighbor
 
1697
                        continue
 
1698
                    if maybe_entry[0][2] == file_id:
 
1699
                        raise AssertionError(
 
1700
                            '_find_entry_index didnt find a key match'
 
1701
                            ' but walking the data did, for %s'
 
1702
                            % (entry_key,))
 
1703
                    basis_kind = maybe_entry[1][1][0]
 
1704
                    if basis_kind not in 'ar':
 
1705
                        self._raise_invalid(new_path, file_id,
 
1706
                            "we have an add record for path, but the path"
 
1707
                            " is already present with another file_id %s"
 
1708
                            % (maybe_entry[0][2],))
 
1709
 
 
1710
                entry = (entry_key, [DirState.NULL_PARENT_DETAILS,
 
1711
                                     new_details])
 
1712
                block.insert(entry_index, entry)
 
1713
 
 
1714
            active_kind = entry[1][0][0]
 
1715
            if active_kind == 'a':
 
1716
                # The active record shows up as absent, this could be genuine,
 
1717
                # or it could be present at some other location. We need to
 
1718
                # verify.
 
1719
                id_index = self._get_id_index()
 
1720
                # The id_index may not be perfectly accurate for tree1, because
 
1721
                # we haven't been keeping it updated. However, it should be
 
1722
                # fine for tree0, and that gives us enough info for what we
 
1723
                # need
 
1724
                keys = id_index.get(file_id, ())
 
1725
                for key in keys:
 
1726
                    block_i, entry_i, d_present, f_present = \
 
1727
                        self._get_block_entry_index(key[0], key[1], 0)
 
1728
                    if not f_present:
 
1729
                        continue
 
1730
                    active_entry = self._dirblocks[block_i][1][entry_i]
 
1731
                    if (active_entry[0][2] != file_id):
 
1732
                        # Some other file is at this path, we don't need to
 
1733
                        # link it.
 
1734
                        continue
 
1735
                    real_active_kind = active_entry[1][0][0]
 
1736
                    if real_active_kind in 'ar':
 
1737
                        # We found a record, which was not *this* record,
 
1738
                        # which matches the file_id, but is not actually
 
1739
                        # present. Something seems *really* wrong.
 
1740
                        self._raise_invalid(new_path, file_id,
 
1741
                            "We found a tree0 entry that doesnt make sense")
 
1742
                    # Now, we've found a tree0 entry which matches the file_id
 
1743
                    # but is at a different location. So update them to be
 
1744
                    # rename records.
 
1745
                    active_dir, active_name = active_entry[0][:2]
 
1746
                    if active_dir:
 
1747
                        active_path = active_dir + '/' + active_name
 
1748
                    else:
 
1749
                        active_path = active_name
 
1750
                    active_entry[1][1] = st('r', new_path, 0, False, '')
 
1751
                    entry[1][0] = st('r', active_path, 0, False, '')
 
1752
            elif active_kind == 'r':
 
1753
                raise NotImplementedError()
 
1754
 
 
1755
            new_kind = new_details[0]
 
1756
            if new_kind == 'd':
 
1757
                self._ensure_block(block_index, entry_index, new_path)
1619
1758
 
1620
1759
    def _update_basis_apply_changes(self, changes):
1621
1760
        """Apply a sequence of changes to tree 1 during update_basis_by_delta.
1626
1765
        absent = 'ar'
1627
1766
        for old_path, new_path, file_id, new_details in changes:
1628
1767
            # 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')
 
1768
            entry = self._get_entry(1, file_id, new_path)
 
1769
            if entry[0] is None or entry[1][1][0] in 'ar':
 
1770
                self._raise_invalid(new_path, file_id,
 
1771
                    'changed entry considered not present')
1639
1772
            entry[1][1] = new_details
1640
1773
 
1641
1774
    def _update_basis_apply_deletes(self, deletes):
1653
1786
        null = DirState.NULL_PARENT_DETAILS
1654
1787
        for old_path, new_path, file_id, _, real_delete in deletes:
1655
1788
            if real_delete != (new_path is None):
1656
 
                self._changes_aborted = True
1657
 
                raise AssertionError("bad delete delta")
 
1789
                self._raise_invalid(old_path, file_id, "bad delete delta")
1658
1790
            # the entry for this file_id must be in tree 1.
1659
1791
            dirname, basename = osutils.split(old_path)
1660
1792
            block_index, entry_index, dir_present, file_present = \
1661
1793
                self._get_block_entry_index(dirname, basename, 1)
1662
1794
            if not file_present:
1663
 
                self._changes_aborted = True
1664
 
                raise errors.InconsistentDelta(old_path, file_id,
 
1795
                self._raise_invalid(old_path, file_id,
1665
1796
                    'basis tree does not contain removed entry')
1666
1797
            entry = self._dirblocks[block_index][1][entry_index]
 
1798
            # The state of the entry in the 'active' WT
 
1799
            active_kind = entry[1][0][0]
1667
1800
            if entry[0][2] != file_id:
1668
 
                self._changes_aborted = True
1669
 
                raise errors.InconsistentDelta(old_path, file_id,
 
1801
                self._raise_invalid(old_path, file_id,
1670
1802
                    '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.')
 
1803
            dir_block = ()
 
1804
            old_kind = entry[1][1][0]
 
1805
            if active_kind in 'ar':
 
1806
                # The active tree doesn't have this file_id.
 
1807
                # The basis tree is changing this record. If this is a
 
1808
                # rename, then we don't want the record here at all
 
1809
                # anymore. If it is just an in-place change, we want the
 
1810
                # record here, but we'll add it if we need to. So we just
 
1811
                # delete it
 
1812
                if active_kind == 'r':
 
1813
                    active_path = entry[1][0][1]
 
1814
                    active_entry = self._get_entry(0, file_id, active_path)
 
1815
                    if active_entry[1][1][0] != 'r':
 
1816
                        self._raise_invalid(old_path, file_id,
 
1817
                            "Dirstate did not have matching rename entries")
 
1818
                    elif active_entry[1][0][0] in 'ar':
 
1819
                        self._raise_invalid(old_path, file_id,
 
1820
                            "Dirstate had a rename pointing at an inactive"
 
1821
                            " tree0")
 
1822
                    active_entry[1][1] = null
1677
1823
                del self._dirblocks[block_index][1][entry_index]
 
1824
                if old_kind == 'd':
 
1825
                    # This was a directory, and the active tree says it
 
1826
                    # doesn't exist, and now the basis tree says it doesn't
 
1827
                    # exist. Remove its dirblock if present
 
1828
                    (dir_block_index,
 
1829
                     present) = self._find_block_index_from_key(
 
1830
                        (old_path, '', ''))
 
1831
                    if present:
 
1832
                        dir_block = self._dirblocks[dir_block_index][1]
 
1833
                        if not dir_block:
 
1834
                            # This entry is empty, go ahead and just remove it
 
1835
                            del self._dirblocks[dir_block_index]
1678
1836
            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
 
1837
                # There is still an active record, so just mark this
 
1838
                # removed.
 
1839
                entry[1][1] = null
 
1840
                block_i, entry_i, d_present, f_present = \
 
1841
                    self._get_block_entry_index(old_path, '', 1)
 
1842
                if d_present:
 
1843
                    dir_block = self._dirblocks[block_i][1]
 
1844
            for child_entry in dir_block:
 
1845
                child_basis_kind = child_entry[1][1][0]
 
1846
                if child_basis_kind not in 'ar':
 
1847
                    self._raise_invalid(old_path, file_id,
 
1848
                        "The file id was deleted but its children were "
 
1849
                        "not deleted.")
1694
1850
 
1695
1851
    def _after_delta_check_parents(self, parents, index):
1696
1852
        """Check that parents required by the delta are all intact.
1705
1861
            # has the right file id.
1706
1862
            entry = self._get_entry(index, file_id, dirname_utf8)
1707
1863
            if entry[1] is None:
1708
 
                self._changes_aborted = True
1709
 
                raise errors.InconsistentDelta(dirname_utf8.decode('utf8'),
 
1864
                self._raise_invalid(dirname_utf8.decode('utf8'),
1710
1865
                    file_id, "This parent is not present.")
1711
1866
            # Parents of things must be directories
1712
1867
            if entry[1][index][0] != 'd':
1713
 
                self._changes_aborted = True
1714
 
                raise errors.InconsistentDelta(dirname_utf8.decode('utf8'),
 
1868
                self._raise_invalid(dirname_utf8.decode('utf8'),
1715
1869
                    file_id, "This parent is not a directory.")
1716
1870
 
1717
1871
    def _observed_sha1(self, entry, sha1, stat_value,
1718
 
        _stat_to_minikind=_stat_to_minikind, _pack_stat=pack_stat):
 
1872
        _stat_to_minikind=_stat_to_minikind):
1719
1873
        """Note the sha1 of a file.
1720
1874
 
1721
1875
        :param entry: The entry the sha1 is for.
1723
1877
        :param stat_value: The os.lstat for the file.
1724
1878
        """
1725
1879
        try:
1726
 
            minikind = _stat_to_minikind[stat_value.st_mode & 0170000]
 
1880
            minikind = _stat_to_minikind[stat_value.st_mode & 0o170000]
1727
1881
        except KeyError:
1728
1882
            # Unhandled kind
1729
1883
            return None
1730
 
        packed_stat = _pack_stat(stat_value)
1731
1884
        if minikind == 'f':
1732
1885
            if self._cutoff_time is None:
1733
1886
                self._sha_cutoff_time()
1734
1887
            if (stat_value.st_mtime < self._cutoff_time
1735
1888
                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
 
1889
                entry[1][0] = ('f', sha1, stat_value.st_size, entry[1][0][3],
 
1890
                               pack_stat(stat_value))
 
1891
                self._mark_modified([entry])
1739
1892
 
1740
1893
    def _sha_cutoff_time(self):
1741
1894
        """Return cutoff time.
1785
1938
            # paths are produced by UnicodeDirReader on purpose.
1786
1939
            abspath = abspath.encode(fs_encoding)
1787
1940
        target = os.readlink(abspath)
1788
 
        if fs_encoding not in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
 
1941
        if fs_encoding not in ('utf-8', 'ascii'):
1789
1942
            # Change encoding if needed
1790
1943
            target = target.decode(fs_encoding).encode('UTF-8')
1791
1944
        return target
1799
1952
        """Serialise the entire dirstate to a sequence of lines."""
1800
1953
        if (self._header_state == DirState.IN_MEMORY_UNMODIFIED and
1801
1954
            self._dirblock_state == DirState.IN_MEMORY_UNMODIFIED):
1802
 
            # read whats on disk.
 
1955
            # read what's on disk.
1803
1956
            self._state_file.seek(0)
1804
1957
            return self._state_file.readlines()
1805
1958
        lines = []
1806
1959
        lines.append(self._get_parents_line(self.get_parent_ids()))
1807
1960
        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()))
 
1961
        lines.extend(self._iter_entry_lines())
1810
1962
        return self._get_output_lines(lines)
1811
1963
 
1812
1964
    def _get_ghosts_line(self, ghost_ids):
1817
1969
        """Create a line for the state file for parents information."""
1818
1970
        return '\0'.join([str(len(parent_ids))] + parent_ids)
1819
1971
 
 
1972
    def _iter_entry_lines(self):
 
1973
        """Create lines for entries."""
 
1974
        return map(self._entry_to_line, self._iter_entries())
 
1975
 
1820
1976
    def _get_fields_to_entry(self):
1821
1977
        """Get a function which converts entry fields into a entry record.
1822
1978
 
1894
2050
                          _int(fields[cur+2]),        # size
1895
2051
                          fields[cur+3] == 'y',       # executable
1896
2052
                          fields[cur+4],              # stat or revision_id
1897
 
                         ) for cur in xrange(3, len(fields)-1, 5)]
 
2053
                         ) for cur in range(3, len(fields)-1, 5)]
1898
2054
                return path_name_file_id_key, trees
1899
2055
            return fields_to_entry_n_parents
1900
2056
 
1940
2096
            entry_index += 1
1941
2097
        return block_index, entry_index, True, False
1942
2098
 
1943
 
    def _get_entry(self, tree_index, fileid_utf8=None, path_utf8=None, include_deleted=False):
 
2099
    def _get_entry(self, tree_index, fileid_utf8=None, path_utf8=None,
 
2100
                   include_deleted=False):
1944
2101
        """Get the dirstate entry for path in tree tree_index.
1945
2102
 
1946
2103
        If either file_id or path is supplied, it is used as the key to lookup.
1961
2118
        """
1962
2119
        self._read_dirblocks_if_needed()
1963
2120
        if path_utf8 is not None:
1964
 
            if type(path_utf8) is not str:
 
2121
            if not isinstance(path_utf8, str):
1965
2122
                raise errors.BzrError('path_utf8 is not a str: %s %r'
1966
2123
                    % (type(path_utf8), path_utf8))
1967
2124
            # path lookups are faster
1980
2137
                                          ' tree_index, file_id and path')
1981
2138
            return entry
1982
2139
        else:
1983
 
            possible_keys = self._get_id_index().get(fileid_utf8, None)
 
2140
            possible_keys = self._get_id_index().get(fileid_utf8, ())
1984
2141
            if not possible_keys:
1985
2142
                return None, None
1986
2143
            for key in possible_keys:
2088
2245
            executable = False
2089
2246
        else:
2090
2247
            raise Exception("can't pack %s" % inv_entry)
2091
 
        return (minikind, fingerprint, size, executable, tree_data)
 
2248
        return static_tuple.StaticTuple(minikind, fingerprint, size,
 
2249
                                        executable, tree_data)
2092
2250
 
2093
2251
    def _iter_child_entries(self, tree_index, path_utf8):
2094
2252
        """Iterate over all the entries that are children of path_utf.
2135
2293
        """Iterate over all the entries in the dirstate.
2136
2294
 
2137
2295
        Each yelt item is an entry in the standard format described in the
2138
 
        docstring of bzrlib.dirstate.
 
2296
        docstring of breezy.dirstate.
2139
2297
        """
2140
2298
        self._read_dirblocks_if_needed()
2141
2299
        for directory in self._dirblocks:
2143
2301
                yield entry
2144
2302
 
2145
2303
    def _get_id_index(self):
2146
 
        """Get an id index of self._dirblocks."""
 
2304
        """Get an id index of self._dirblocks.
 
2305
 
 
2306
        This maps from file_id => [(directory, name, file_id)] entries where
 
2307
        that file_id appears in one of the trees.
 
2308
        """
2147
2309
        if self._id_index is None:
2148
2310
            id_index = {}
2149
2311
            for key, tree_details in self._iter_entries():
2150
 
                id_index.setdefault(key[2], set()).add(key)
 
2312
                self._add_to_id_index(id_index, key)
2151
2313
            self._id_index = id_index
2152
2314
        return self._id_index
2153
2315
 
 
2316
    def _add_to_id_index(self, id_index, entry_key):
 
2317
        """Add this entry to the _id_index mapping."""
 
2318
        # This code used to use a set for every entry in the id_index. However,
 
2319
        # it is *rare* to have more than one entry. So a set is a large
 
2320
        # overkill. And even when we do, we won't ever have more than the
 
2321
        # number of parent trees. Which is still a small number (rarely >2). As
 
2322
        # such, we use a simple tuple, and do our own uniqueness checks. While
 
2323
        # the 'in' check is O(N) since N is nicely bounded it shouldn't ever
 
2324
        # cause quadratic failure.
 
2325
        file_id = entry_key[2]
 
2326
        entry_key = static_tuple.StaticTuple.from_sequence(entry_key)
 
2327
        if file_id not in id_index:
 
2328
            id_index[file_id] = static_tuple.StaticTuple(entry_key,)
 
2329
        else:
 
2330
            entry_keys = id_index[file_id]
 
2331
            if entry_key not in entry_keys:
 
2332
                id_index[file_id] = entry_keys + (entry_key,)
 
2333
 
 
2334
    def _remove_from_id_index(self, id_index, entry_key):
 
2335
        """Remove this entry from the _id_index mapping.
 
2336
 
 
2337
        It is an programming error to call this when the entry_key is not
 
2338
        already present.
 
2339
        """
 
2340
        file_id = entry_key[2]
 
2341
        entry_keys = list(id_index[file_id])
 
2342
        entry_keys.remove(entry_key)
 
2343
        id_index[file_id] = static_tuple.StaticTuple.from_sequence(entry_keys)
 
2344
 
2154
2345
    def _get_output_lines(self, lines):
2155
2346
        """Format lines for final output.
2156
2347
 
2176
2367
        """The number of parent entries in each record row."""
2177
2368
        return len(self._parents) - len(self._ghosts)
2178
2369
 
2179
 
    @staticmethod
2180
 
    def on_file(path, sha1_provider=None):
 
2370
    @classmethod
 
2371
    def on_file(cls, path, sha1_provider=None, worth_saving_limit=0):
2181
2372
        """Construct a DirState on the file at path "path".
2182
2373
 
2183
2374
        :param path: The path at which the dirstate file on disk should live.
2184
2375
        :param sha1_provider: an object meeting the SHA1Provider interface.
2185
2376
            If None, a DefaultSHA1Provider is used.
 
2377
        :param worth_saving_limit: when the exact number of hash changed
 
2378
            entries is known, only bother saving the dirstate if more than
 
2379
            this count of entries have changed. -1 means never save.
2186
2380
        :return: An unlocked DirState object, associated with the given path.
2187
2381
        """
2188
2382
        if sha1_provider is None:
2189
2383
            sha1_provider = DefaultSHA1Provider()
2190
 
        result = DirState(path, sha1_provider)
 
2384
        result = cls(path, sha1_provider,
 
2385
                     worth_saving_limit=worth_saving_limit)
2191
2386
        return result
2192
2387
 
2193
2388
    def _read_dirblocks_if_needed(self):
2251
2446
            raise errors.BzrError('missing num_entries line')
2252
2447
        self._num_entries = int(num_entries_line[len('num_entries: '):-1])
2253
2448
 
2254
 
    def sha1_from_stat(self, path, stat_result, _pack_stat=pack_stat):
 
2449
    def sha1_from_stat(self, path, stat_result):
2255
2450
        """Find a sha1 given a stat lookup."""
2256
 
        return self._get_packed_stat_index().get(_pack_stat(stat_result), None)
 
2451
        return self._get_packed_stat_index().get(pack_stat(stat_result), None)
2257
2452
 
2258
2453
    def _get_packed_stat_index(self):
2259
2454
        """Get a packed_stat index of self._dirblocks."""
2285
2480
            trace.mutter('Not saving DirState because '
2286
2481
                    '_changes_aborted is set.')
2287
2482
            return
2288
 
        if (self._header_state == DirState.IN_MEMORY_MODIFIED or
2289
 
            self._dirblock_state == DirState.IN_MEMORY_MODIFIED):
 
2483
        # TODO: Since we now distinguish IN_MEMORY_MODIFIED from
 
2484
        #       IN_MEMORY_HASH_MODIFIED, we should only fail quietly if we fail
 
2485
        #       to save an IN_MEMORY_HASH_MODIFIED, and fail *noisily* if we
 
2486
        #       fail to save IN_MEMORY_MODIFIED
 
2487
        if not self._worth_saving():
 
2488
            return
2290
2489
 
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.
 
2490
        grabbed_write_lock = False
 
2491
        if self._lock_state != 'w':
 
2492
            grabbed_write_lock, new_lock = self._lock_token.temporary_write_lock()
 
2493
            # Switch over to the new lock, as the old one may be closed.
 
2494
            # TODO: jam 20070315 We should validate the disk file has
 
2495
            #       not changed contents, since temporary_write_lock may
 
2496
            #       not be an atomic operation.
 
2497
            self._lock_token = new_lock
 
2498
            self._state_file = new_lock.f
 
2499
            if not grabbed_write_lock:
 
2500
                # We couldn't grab a write lock, so we switch back to a read one
 
2501
                return
 
2502
        try:
 
2503
            lines = self.get_lines()
 
2504
            self._state_file.seek(0)
 
2505
            self._state_file.writelines(lines)
 
2506
            self._state_file.truncate()
 
2507
            self._state_file.flush()
 
2508
            self._maybe_fdatasync()
 
2509
            self._mark_unmodified()
 
2510
        finally:
 
2511
            if grabbed_write_lock:
 
2512
                self._lock_token = self._lock_token.restore_read_lock()
 
2513
                self._state_file = self._lock_token.f
2295
2514
                # TODO: jam 20070315 We should validate the disk file has
2296
 
                #       not changed contents. Since temporary_write_lock may
2297
 
                #       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.
 
2515
                #       not changed contents. Since restore_read_lock may
 
2516
                #       not be an atomic operation.                
 
2517
 
 
2518
    def _maybe_fdatasync(self):
 
2519
        """Flush to disk if possible and if not configured off."""
 
2520
        if self._config_stack.get('dirstate.fdatasync'):
 
2521
            osutils.fdatasync(self._state_file.fileno())
 
2522
 
 
2523
    def _worth_saving(self):
 
2524
        """Is it worth saving the dirstate or not?"""
 
2525
        if (self._header_state == DirState.IN_MEMORY_MODIFIED
 
2526
            or self._dirblock_state == DirState.IN_MEMORY_MODIFIED):
 
2527
            return True
 
2528
        if self._dirblock_state == DirState.IN_MEMORY_HASH_MODIFIED:
 
2529
            if self._worth_saving_limit == -1:
 
2530
                # We never save hash changes when the limit is -1
 
2531
                return False
 
2532
            # If we're using smart saving and only a small number of
 
2533
            # entries have changed their hash, don't bother saving. John has
 
2534
            # suggested using a heuristic here based on the size of the
 
2535
            # changed files and/or tree. For now, we go with a configurable
 
2536
            # number of changes, keeping the calculation time
 
2537
            # as low overhead as possible. (This also keeps all existing
 
2538
            # tests passing as the default is 0, i.e. always save.)
 
2539
            if len(self._known_hash_changes) >= self._worth_saving_limit:
 
2540
                return True
 
2541
        return False
2317
2542
 
2318
2543
    def _set_data(self, parent_ids, dirblocks):
2319
2544
        """Set the full dirstate data in memory.
2328
2553
        """
2329
2554
        # our memory copy is now authoritative.
2330
2555
        self._dirblocks = dirblocks
2331
 
        self._header_state = DirState.IN_MEMORY_MODIFIED
2332
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
2556
        self._mark_modified(header_modified=True)
2333
2557
        self._parents = list(parent_ids)
2334
2558
        self._id_index = None
2335
2559
        self._packed_stat_index = None
2355
2579
        self._make_absent(entry)
2356
2580
        self.update_minimal(('', '', new_id), 'd',
2357
2581
            path_utf8='', packed_stat=entry[1][0][4])
2358
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
2582
        self._mark_modified()
2359
2583
 
2360
2584
    def set_parent_trees(self, trees, ghosts):
2361
2585
        """Set the parent trees for the dirstate.
2406
2630
        parent_trees = [tree for rev_id, tree in trees if rev_id not in ghosts]
2407
2631
        # how many trees do we end up with
2408
2632
        parent_count = len(parent_trees)
 
2633
        st = static_tuple.StaticTuple
2409
2634
 
2410
2635
        # one: the current tree
2411
2636
        for entry in self._iter_entries():
2414
2639
                continue
2415
2640
            by_path[entry[0]] = [entry[1][0]] + \
2416
2641
                [DirState.NULL_PARENT_DETAILS] * parent_count
2417
 
            id_index[entry[0][2]] = set([entry[0]])
 
2642
            # TODO: Possibly inline this, since we know it isn't present yet
 
2643
            #       id_index[entry[0][2]] = (entry[0],)
 
2644
            self._add_to_id_index(id_index, entry[0])
2418
2645
 
2419
2646
        # now the parent trees:
2420
2647
        for tree_index, tree in enumerate(parent_trees):
2426
2653
            # the suffix is from tree_index+1:parent_count+1.
2427
2654
            new_location_suffix = [DirState.NULL_PARENT_DETAILS] * (parent_count - tree_index)
2428
2655
            # now stitch in all the entries from this tree
2429
 
            for path, entry in tree.inventory.iter_entries_by_dir():
 
2656
            last_dirname = None
 
2657
            for path, entry in tree.iter_entries_by_dir():
2430
2658
                # here we process each trees details for each item in the tree.
2431
2659
                # we first update any existing entries for the id at other paths,
2432
2660
                # then we either create or update the entry for the id at the
2439
2667
                file_id = entry.file_id
2440
2668
                path_utf8 = path.encode('utf8')
2441
2669
                dirname, basename = osutils.split(path_utf8)
2442
 
                new_entry_key = (dirname, basename, file_id)
 
2670
                if dirname == last_dirname:
 
2671
                    # Try to re-use objects as much as possible
 
2672
                    dirname = last_dirname
 
2673
                else:
 
2674
                    last_dirname = dirname
 
2675
                new_entry_key = st(dirname, basename, file_id)
2443
2676
                # tree index consistency: All other paths for this id in this tree
2444
2677
                # index must point to the correct path.
2445
 
                for entry_key in id_index.setdefault(file_id, set()):
 
2678
                entry_keys = id_index.get(file_id, ())
 
2679
                for entry_key in entry_keys:
2446
2680
                    # TODO:PROFILING: It might be faster to just update
2447
2681
                    # rather than checking if we need to, and then overwrite
2448
2682
                    # the one we are located at.
2451
2685
                        # other trees, so put absent pointers there
2452
2686
                        # This is the vertical axis in the matrix, all pointing
2453
2687
                        # 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.
 
2688
                        by_path[entry_key][tree_index] = st('r', path_utf8, 0,
 
2689
                                                            False, '')
 
2690
                # by path consistency: Insert into an existing path record
 
2691
                # (trivial), or add a new one with relocation pointers for the
 
2692
                # other tree indexes.
 
2693
                if new_entry_key in entry_keys:
 
2694
                    # there is already an entry where this data belongs, just
 
2695
                    # insert it.
2459
2696
                    by_path[new_entry_key][tree_index] = \
2460
2697
                        self._inv_entry_to_details(entry)
2461
2698
                else:
2463
2700
                    # mapping from path,id. We need to look up the correct path
2464
2701
                    # for the indexes from 0 to tree_index -1
2465
2702
                    new_details = []
2466
 
                    for lookup_index in xrange(tree_index):
 
2703
                    for lookup_index in range(tree_index):
2467
2704
                        # boundary case: this is the first occurence of file_id
2468
 
                        # so there are no id_indexs, possibly take this out of
 
2705
                        # so there are no id_indexes, possibly take this out of
2469
2706
                        # the loop?
2470
 
                        if not len(id_index[file_id]):
 
2707
                        if not len(entry_keys):
2471
2708
                            new_details.append(DirState.NULL_PARENT_DETAILS)
2472
2709
                        else:
2473
2710
                            # 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()
 
2711
                            a_key = next(iter(entry_keys))
2478
2712
                            if by_path[a_key][lookup_index][0] in ('r', 'a'):
2479
 
                                # its a pointer or missing statement, use it as is.
 
2713
                                # its a pointer or missing statement, use it as
 
2714
                                # is.
2480
2715
                                new_details.append(by_path[a_key][lookup_index])
2481
2716
                            else:
2482
2717
                                # we have the right key, make a pointer to it.
2483
2718
                                real_path = ('/'.join(a_key[0:2])).strip('/')
2484
 
                                new_details.append(('r', real_path, 0, False, ''))
 
2719
                                new_details.append(st('r', real_path, 0, False,
 
2720
                                                      ''))
2485
2721
                    new_details.append(self._inv_entry_to_details(entry))
2486
2722
                    new_details.extend(new_location_suffix)
2487
2723
                    by_path[new_entry_key] = new_details
2488
 
                    id_index[file_id].add(new_entry_key)
 
2724
                    self._add_to_id_index(id_index, new_entry_key)
2489
2725
        # --- end generation of full tree mappings
2490
2726
 
2491
2727
        # sort and output all the entries
2492
 
        new_entries = self._sort_entries(by_path.items())
 
2728
        new_entries = self._sort_entries(viewitems(by_path))
2493
2729
        self._entries_to_current_state(new_entries)
2494
2730
        self._parents = [rev_id for rev_id, tree in trees]
2495
2731
        self._ghosts = list(ghosts)
2496
 
        self._header_state = DirState.IN_MEMORY_MODIFIED
2497
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
2732
        self._mark_modified(header_modified=True)
2498
2733
        self._id_index = id_index
2499
2734
 
2500
2735
    def _sort_entries(self, entry_list):
2504
2739
        try to keep everything in sorted blocks all the time, but sometimes
2505
2740
        it's easier to sort after the fact.
2506
2741
        """
2507
 
        def _key(entry):
 
2742
        # When sorting, we usually have 10x more entries than directories. (69k
 
2743
        # total entries, 4k directories). So cache the results of splitting.
 
2744
        # Saving time and objects. Also, use StaticTuple to avoid putting all
 
2745
        # of these object into python's garbage collector.
 
2746
        split_dirs = {}
 
2747
        def _key(entry, _split_dirs=split_dirs, _st=static_tuple.StaticTuple):
2508
2748
            # sort by: directory parts, file name, file id
2509
 
            return entry[0][0].split('/'), entry[0][1], entry[0][2]
 
2749
            dirpath, fname, file_id = entry[0]
 
2750
            try:
 
2751
                split = _split_dirs[dirpath]
 
2752
            except KeyError:
 
2753
                split = _st.from_sequence(dirpath.split('/'))
 
2754
                _split_dirs[dirpath] = split
 
2755
            return _st(split, fname, file_id)
2510
2756
        return sorted(entry_list, key=_key)
2511
2757
 
2512
2758
    def set_state_from_inventory(self, new_inv):
2542
2788
        # underlying dirstate.
2543
2789
        old_iterator = iter(list(self._iter_entries()))
2544
2790
        # both must have roots so this is safe:
2545
 
        current_new = new_iterator.next()
2546
 
        current_old = old_iterator.next()
 
2791
        current_new = next(new_iterator)
 
2792
        current_old = next(old_iterator)
2547
2793
        def advance(iterator):
2548
2794
            try:
2549
 
                return iterator.next()
 
2795
                return next(iterator)
2550
2796
            except StopIteration:
2551
2797
                return None
2552
2798
        while current_new or current_old:
2637
2883
                        current_old[0][1].decode('utf8'))
2638
2884
                self._make_absent(current_old)
2639
2885
                current_old = advance(old_iterator)
2640
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
2886
        self._mark_modified()
2641
2887
        self._id_index = None
2642
2888
        self._packed_stat_index = None
2643
2889
        if tracing:
2644
2890
            trace.mutter("set_state_from_inventory complete.")
2645
2891
 
 
2892
    def set_state_from_scratch(self, working_inv, parent_trees, parent_ghosts):
 
2893
        """Wipe the currently stored state and set it to something new.
 
2894
 
 
2895
        This is a hard-reset for the data we are working with.
 
2896
        """
 
2897
        # Technically, we really want a write lock, but until we write, we
 
2898
        # don't really need it.
 
2899
        self._requires_lock()
 
2900
        # root dir and root dir contents with no children. We have to have a
 
2901
        # root for set_state_from_inventory to work correctly.
 
2902
        empty_root = (('', '', inventory.ROOT_ID),
 
2903
                      [('d', '', 0, False, DirState.NULLSTAT)])
 
2904
        empty_tree_dirblocks = [('', [empty_root]), ('', [])]
 
2905
        self._set_data([], empty_tree_dirblocks)
 
2906
        self.set_state_from_inventory(working_inv)
 
2907
        self.set_parent_trees(parent_trees, parent_ghosts)
 
2908
 
2646
2909
    def _make_absent(self, current_old):
2647
2910
        """Mark current_old - an entry - as absent for tree 0.
2648
2911
 
2673
2936
            block[1].pop(entry_index)
2674
2937
            # if we have an id_index in use, remove this key from it for this id.
2675
2938
            if self._id_index is not None:
2676
 
                self._id_index[current_old[0][2]].remove(current_old[0])
 
2939
                self._remove_from_id_index(self._id_index, current_old[0])
2677
2940
        # update all remaining keys for this id to record it as absent. The
2678
2941
        # existing details may either be the record we are marking as deleted
2679
2942
        # (if there were other trees with the id present at this path), or may
2692
2955
            if update_tree_details[0][0] == 'a': # absent
2693
2956
                raise AssertionError('bad row %r' % (update_tree_details,))
2694
2957
            update_tree_details[0] = DirState.NULL_PARENT_DETAILS
2695
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
2958
        self._mark_modified()
2696
2959
        return last_reference
2697
2960
 
2698
2961
    def update_minimal(self, key, minikind, executable=False, fingerprint='',
2740
3003
                            # This entry has the same path (but a different id) as
2741
3004
                            # the new entry we're adding, and is present in ths
2742
3005
                            # tree.
2743
 
                            raise errors.InconsistentDelta(
 
3006
                            self._raise_invalid(
2744
3007
                                ("%s/%s" % key[0:2]).decode('utf8'), key[2],
2745
3008
                                "Attempt to add item at path already occupied by "
2746
3009
                                "id %r" % entry[0][2])
2748
3011
                    else:
2749
3012
                        break
2750
3013
            # new entry, synthesis cross reference here,
2751
 
            existing_keys = id_index.setdefault(key[2], set())
 
3014
            existing_keys = id_index.get(key[2], ())
2752
3015
            if not existing_keys:
2753
3016
                # not currently in the state, simplest case
2754
3017
                new_entry = key, [new_details] + self._empty_parent_info()
2785
3048
                    # loop.
2786
3049
                    other_entry = other_block[other_entry_index]
2787
3050
                    other_entry[1][0] = ('r', path_utf8, 0, False, '')
2788
 
                    self._maybe_remove_row(other_block, other_entry_index,
2789
 
                        id_index)
 
3051
                    if self._maybe_remove_row(other_block, other_entry_index,
 
3052
                                              id_index):
 
3053
                        # If the row holding this was removed, we need to
 
3054
                        # recompute where this entry goes
 
3055
                        entry_index, _ = self._find_entry_index(key, block)
2790
3056
 
2791
3057
                # This loop:
2792
3058
                # adds a tuple to the new details for each column
2794
3060
                #  - or by creating a new pointer to the right row inside that column
2795
3061
                num_present_parents = self._num_present_parents()
2796
3062
                if num_present_parents:
 
3063
                    # TODO: This re-evaluates the existing_keys set, do we need
 
3064
                    #       to do that ourselves?
2797
3065
                    other_key = list(existing_keys)[0]
2798
 
                for lookup_index in xrange(1, num_present_parents + 1):
 
3066
                for lookup_index in range(1, num_present_parents + 1):
2799
3067
                    # grab any one entry, use it to find the right path.
2800
3068
                    # TODO: optimise this to reduce memory use in highly
2801
3069
                    # fragmented situations by reusing the relocation
2818
3086
                        pointer_path = osutils.pathjoin(*other_key[0:2])
2819
3087
                        new_entry[1].append(('r', pointer_path, 0, False, ''))
2820
3088
            block.insert(entry_index, new_entry)
2821
 
            existing_keys.add(key)
 
3089
            self._add_to_id_index(id_index, key)
2822
3090
        else:
2823
3091
            # Does the new state matter?
2824
3092
            block[entry_index][1][0] = new_details
2833
3101
            # converted to relocated.
2834
3102
            if path_utf8 is None:
2835
3103
                raise AssertionError('no path')
2836
 
            for entry_key in id_index.setdefault(key[2], set()):
 
3104
            existing_keys = id_index.get(key[2], ())
 
3105
            if key not in existing_keys:
 
3106
                raise AssertionError('We found the entry in the blocks, but'
 
3107
                    ' the key is not in the id_index.'
 
3108
                    ' key: %s, existing_keys: %s' % (key, existing_keys))
 
3109
            for entry_key in existing_keys:
2837
3110
                # TODO:PROFILING: It might be faster to just update
2838
3111
                # rather than checking if we need to, and then overwrite
2839
3112
                # the one we are located at.
2857
3130
            if not present:
2858
3131
                self._dirblocks.insert(block_index, (subdir_key[0], []))
2859
3132
 
2860
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
3133
        self._mark_modified()
2861
3134
 
2862
3135
    def _maybe_remove_row(self, block, index, id_index):
2863
3136
        """Remove index if it is absent or relocated across the row.
2864
3137
        
2865
3138
        id_index is updated accordingly.
 
3139
        :return: True if we removed the row, False otherwise
2866
3140
        """
2867
3141
        present_in_row = False
2868
3142
        entry = block[index]
2872
3146
                break
2873
3147
        if not present_in_row:
2874
3148
            block.pop(index)
2875
 
            id_index[entry[0][2]].remove(entry[0])
 
3149
            self._remove_from_id_index(id_index, entry[0])
 
3150
            return True
 
3151
        return False
2876
3152
 
2877
3153
    def _validate(self):
2878
3154
        """Check that invariants on the dirblock are correct.
2958
3234
        # We check this with a dict per tree pointing either to the present
2959
3235
        # name, or None if absent.
2960
3236
        tree_count = self._num_present_parents() + 1
2961
 
        id_path_maps = [dict() for i in range(tree_count)]
 
3237
        id_path_maps = [{} for _ in range(tree_count)]
2962
3238
        # Make sure that all renamed entries point to the correct location.
2963
3239
        for entry in self._iter_entries():
2964
3240
            file_id = entry[0][2]
3014
3290
                raise AssertionError(
3015
3291
                    "entry %r has no data for any tree." % (entry,))
3016
3292
        if self._id_index is not None:
3017
 
            for file_id, entry_keys in self._id_index.iteritems():
 
3293
            for file_id, entry_keys in viewitems(self._id_index):
3018
3294
                for entry_key in entry_keys:
 
3295
                    # Check that the entry in the map is pointing to the same
 
3296
                    # file_id
3019
3297
                    if entry_key[2] != file_id:
3020
3298
                        raise AssertionError(
3021
3299
                            'file_id %r did not match entry key %s'
3022
3300
                            % (file_id, entry_key))
 
3301
                    # And that from this entry key, we can look up the original
 
3302
                    # record
 
3303
                    block_index, present = self._find_block_index_from_key(entry_key)
 
3304
                    if not present:
 
3305
                        raise AssertionError('missing block for entry key: %r', entry_key)
 
3306
                    entry_index, present = self._find_entry_index(entry_key, self._dirblocks[block_index][1])
 
3307
                    if not present:
 
3308
                        raise AssertionError('missing entry for key: %r', entry_key)
 
3309
                if len(entry_keys) != len(set(entry_keys)):
 
3310
                    raise AssertionError(
 
3311
                        'id_index contained non-unique data for %s'
 
3312
                        % (entry_keys,))
3023
3313
 
3024
3314
    def _wipe_state(self):
3025
3315
        """Forget all state information about the dirstate."""
3082
3372
 
3083
3373
 
3084
3374
def py_update_entry(state, entry, abspath, stat_value,
3085
 
                 _stat_to_minikind=DirState._stat_to_minikind,
3086
 
                 _pack_stat=pack_stat):
 
3375
                 _stat_to_minikind=DirState._stat_to_minikind):
3087
3376
    """Update the entry based on what is actually on disk.
3088
3377
 
3089
3378
    This function only calculates the sha if it needs to - if the entry is
3098
3387
        target of a symlink.
3099
3388
    """
3100
3389
    try:
3101
 
        minikind = _stat_to_minikind[stat_value.st_mode & 0170000]
 
3390
        minikind = _stat_to_minikind[stat_value.st_mode & 0o170000]
3102
3391
    except KeyError:
3103
3392
        # Unhandled kind
3104
3393
        return None
3105
 
    packed_stat = _pack_stat(stat_value)
 
3394
    packed_stat = pack_stat(stat_value)
3106
3395
    (saved_minikind, saved_link_or_sha1, saved_file_size,
3107
3396
     saved_executable, saved_packed_stat) = entry[1][0]
3108
3397
 
3122
3411
    # If we have gotten this far, that means that we need to actually
3123
3412
    # process this entry.
3124
3413
    link_or_sha1 = None
 
3414
    worth_saving = True
3125
3415
    if minikind == 'f':
3126
3416
        executable = state._is_executable(stat_value.st_mode,
3127
3417
                                         saved_executable)
3143
3433
        else:
3144
3434
            entry[1][0] = ('f', '', stat_value.st_size,
3145
3435
                           executable, DirState.NULLSTAT)
 
3436
            worth_saving = False
3146
3437
    elif minikind == 'd':
3147
3438
        link_or_sha1 = None
3148
3439
        entry[1][0] = ('d', '', 0, False, packed_stat)
3154
3445
                state._get_block_entry_index(entry[0][0], entry[0][1], 0)
3155
3446
            state._ensure_block(block_index, entry_index,
3156
3447
                               osutils.pathjoin(entry[0][0], entry[0][1]))
 
3448
        else:
 
3449
            worth_saving = False
3157
3450
    elif minikind == 'l':
 
3451
        if saved_minikind == 'l':
 
3452
            worth_saving = False
3158
3453
        link_or_sha1 = state._read_link(abspath, saved_link_or_sha1)
3159
3454
        if state._cutoff_time is None:
3160
3455
            state._sha_cutoff_time()
3165
3460
        else:
3166
3461
            entry[1][0] = ('l', '', stat_value.st_size,
3167
3462
                           False, DirState.NULLSTAT)
3168
 
    state._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
3463
    if worth_saving:
 
3464
        state._mark_modified([entry])
3169
3465
    return link_or_sha1
3170
3466
 
3171
3467
 
3184
3480
        self.old_dirname_to_file_id = {}
3185
3481
        self.new_dirname_to_file_id = {}
3186
3482
        # Are we doing a partial iter_changes?
3187
 
        self.partial = search_specific_files != set([''])
 
3483
        self.partial = search_specific_files != {''}
3188
3484
        # Using a list so that we can access the values and change them in
3189
3485
        # nested scope. Each one is [path, file_id, entry]
3190
3486
        self.last_source_parent = [None, None]
3480
3776
            raise AssertionError("don't know how to compare "
3481
3777
                "source_minikind=%r, target_minikind=%r"
3482
3778
                % (source_minikind, target_minikind))
3483
 
            ## import pdb;pdb.set_trace()
3484
3779
        return None, None
3485
3780
 
3486
3781
    def __iter__(self):
3563
3858
            root_abspath = self.tree.abspath(current_root_unicode)
3564
3859
            try:
3565
3860
                root_stat = os.lstat(root_abspath)
3566
 
            except OSError, e:
 
3861
            except OSError as e:
3567
3862
                if e.errno == errno.ENOENT:
3568
3863
                    # the path does not exist: let _process_entry know that.
3569
3864
                    root_dir_info = None
3616
3911
            else:
3617
3912
                dir_iterator = osutils._walkdirs_utf8(root_abspath, prefix=current_root)
3618
3913
                try:
3619
 
                    current_dir_info = dir_iterator.next()
3620
 
                except OSError, e:
 
3914
                    current_dir_info = next(dir_iterator)
 
3915
                except OSError as e:
3621
3916
                    # on win32, python2.4 has e.errno == ERROR_DIRECTORY, but
3622
3917
                    # python 2.5 has e.errno == EINVAL,
3623
3918
                    #            and e.winerror == ERROR_DIRECTORY
3692
3987
 
3693
3988
                        # This dir info has been handled, go to the next
3694
3989
                        try:
3695
 
                            current_dir_info = dir_iterator.next()
 
3990
                            current_dir_info = next(dir_iterator)
3696
3991
                        except StopIteration:
3697
3992
                            current_dir_info = None
3698
3993
                    else:
3844
4139
                        current_block = None
3845
4140
                if current_dir_info is not None:
3846
4141
                    try:
3847
 
                        current_dir_info = dir_iterator.next()
 
4142
                        current_dir_info = next(dir_iterator)
3848
4143
                    except StopIteration:
3849
4144
                        current_dir_info = None
3850
4145
        for result in self._iter_specific_file_parents():
3949
4244
        abspath = self.tree.abspath(unicode_path)
3950
4245
        try:
3951
4246
            stat = os.lstat(abspath)
3952
 
        except OSError, e:
 
4247
        except OSError as e:
3953
4248
            if e.errno == errno.ENOENT:
3954
4249
                # the path does not exist.
3955
4250
                return None
3969
4264
 
3970
4265
# Try to load the compiled form if possible
3971
4266
try:
3972
 
    from bzrlib._dirstate_helpers_pyx import (
 
4267
    from breezy._dirstate_helpers_pyx import (
3973
4268
        _read_dirblocks,
3974
4269
        bisect_dirblock,
3975
4270
        _bisect_path_left,
3976
4271
        _bisect_path_right,
3977
4272
        cmp_by_dirs,
 
4273
        pack_stat,
3978
4274
        ProcessEntryC as _process_entry,
3979
4275
        update_entry as update_entry,
3980
4276
        )
3981
 
except ImportError, e:
 
4277
except ImportError as e:
3982
4278
    osutils.failed_to_load_extension(e)
3983
 
    from bzrlib._dirstate_helpers_py import (
 
4279
    from breezy._dirstate_helpers_py import (
3984
4280
        _read_dirblocks,
3985
4281
        bisect_dirblock,
3986
4282
        _bisect_path_left,
3987
4283
        _bisect_path_right,
3988
4284
        cmp_by_dirs,
 
4285
        pack_stat,
3989
4286
        )
3990
4287
    # FIXME: It would be nice to be able to track moved lines so that the
3991
4288
    # corresponding python code can be moved to the _dirstate_helpers_py