~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/dirstate.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-03-16 16:58:03 UTC
  • mfrom: (3224.3.1 news-typo)
  • Revision ID: pqm@pqm.ubuntu.com-20080316165803-tisoc9mpob9z544o
(Matt Nordhoff) Trivial NEWS typo fix

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006-2011 Canonical Ltd
 
1
# Copyright (C) 2006, 2007, 2008 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""DirState objects record the state of a directory and its bzr metadata.
18
18
 
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
 
::
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
 
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
73
67
 
74
68
There may be multiple rows at the root, one per id present in the root, so the
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.
 
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 its a file. The fingerprint is a
 
86
    sha1 value.
 
87
'l' is a symlink entry: As for directory, but a symlink. The fingerprint is the
 
88
    link target.
 
89
't' is a reference to a nested subtree; the fingerprint is the referenced
 
90
    revision.
103
91
 
104
92
Ordering:
105
93
 
106
 
The entries on disk and in memory are ordered according to the following keys::
 
94
The entries on disk and in memory are ordered according to the following keys:
107
95
 
108
96
    directory, as a list of components
109
97
    filename
110
98
    file-id
111
99
 
112
100
--- Format 1 had the following different definition: ---
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
 
101
rows = dirname, NULL, basename, NULL, MINIKIND, NULL, fileid_utf8, NULL,
 
102
    WHOLE NUMBER (* size *), NULL, packed stat, NULL, sha1|symlink target, 
 
103
    {PARENT ROW}
 
104
PARENT ROW = NULL, revision_utf8, NULL, MINIKIND, NULL, dirname, NULL,
 
105
    basename, NULL, WHOLE NUMBER (* size *), NULL, "y" | "n", NULL,
 
106
    SHA1
122
107
 
123
108
PARENT ROW's are emitted for every parent that is not in the ghosts details
124
109
line. That is, if the parents are foo, bar, baz, and the ghosts are bar, then
145
130
operations for the less common but still occurs a lot status/diff/commit
146
131
on specific files). Operations on specific files involve a scan for all
147
132
the children of a path, *in every involved tree*, which the current
148
 
format did not accommodate.
 
133
format did not accommodate. 
149
134
----
150
135
 
151
136
Design priorities:
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
 
137
 1) Fast end to end use for bzr's top 5 uses cases. (commmit/diff/status/merge/???)
 
138
 2) fall back current object model as needed.
 
139
 3) scale usably to the largest trees known today - say 50K entries. (mozilla
155
140
    is an example of this)
156
141
 
157
142
 
158
143
Locking:
159
 
 
160
144
 Eventually reuse dirstate objects across locks IFF the dirstate file has not
161
145
 been modified, but will require that we flush/ignore cached stat-hit data
162
146
 because we won't want to restat all files on disk just because a lock was
163
147
 acquired, yet we cannot trust the data after the previous lock was released.
164
148
 
165
 
Memory representation::
166
 
 
 
149
Memory representation:
167
150
 vector of all directories, and vector of the childen ?
168
 
   i.e.
169
 
     root_entrie = (direntry for root, [parent_direntries_for_root]),
 
151
   i.e. 
 
152
     root_entrie = (direntry for root, [parent_direntries_for_root]), 
170
153
     dirblocks = [
171
154
     ('', ['data for achild', 'data for bchild', 'data for cchild'])
172
155
     ('dir', ['achild', 'cchild', 'echild'])
175
158
    - in-order for serialisation - this is 'dirblock' grouping.
176
159
    - insertion of a file '/a' affects only the '/' child-vector, that is, to
177
160
      insert 10K elements from scratch does not generates O(N^2) memoves of a
178
 
      single vector, rather each individual, which tends to be limited to a
179
 
      manageable number. Will scale badly on trees with 10K entries in a
 
161
      single vector, rather each individual, which tends to be limited to a 
 
162
      manageable number. Will scale badly on trees with 10K entries in a 
180
163
      single directory. compare with Inventory.InventoryDirectory which has
181
164
      a dictionary for the children. No bisect capability, can only probe for
182
165
      exact matches, or grab all elements and sort.
183
166
    - What's the risk of error here? Once we have the base format being processed
184
 
      we should have a net win regardless of optimality. So we are going to
 
167
      we should have a net win regardless of optimality. So we are going to 
185
168
      go with what seems reasonable.
186
 
 
187
169
open questions:
188
170
 
189
171
Maybe we should do a test profile of the core structure - 10K simulated
204
186
the file on disk, and then immediately discard, the overhead of object creation
205
187
becomes a significant cost.
206
188
 
207
 
Figures: Creating a tuple from 3 elements was profiled at 0.0625
 
189
Figures: Creating a tuple from from 3 elements was profiled at 0.0625
208
190
microseconds, whereas creating a object which is subclassed from tuple was
209
191
0.500 microseconds, and creating an object with 3 elements and slots was 3
210
192
microseconds long. 0.1 milliseconds is 100 microseconds, and ideally we'll get
219
201
"""
220
202
 
221
203
import bisect
 
204
import binascii
222
205
import errno
223
 
import operator
224
206
import os
225
207
from stat import S_IEXEC
226
208
import stat
 
209
import struct
227
210
import sys
228
211
import time
229
212
import zlib
230
213
 
231
214
from bzrlib import (
232
215
    cache_utf8,
233
 
    config,
234
216
    debug,
235
217
    errors,
236
218
    inventory,
237
219
    lock,
238
220
    osutils,
239
 
    static_tuple,
240
221
    trace,
241
 
    urlutils,
242
222
    )
243
223
 
244
224
 
245
 
# This is the Windows equivalent of ENOTDIR
246
 
# It is defined in pywin32.winerror, but we don't want a strong dependency for
247
 
# just an error code.
248
 
ERROR_PATH_NOT_FOUND = 3
249
 
ERROR_DIRECTORY = 267
250
 
 
251
 
 
252
 
class SHA1Provider(object):
253
 
    """An interface for getting sha1s of a file."""
254
 
 
255
 
    def sha1(self, abspath):
256
 
        """Return the sha1 of a file given its absolute path.
257
 
 
258
 
        :param abspath:  May be a filesystem encoded absolute path
259
 
             or a unicode path.
260
 
        """
261
 
        raise NotImplementedError(self.sha1)
262
 
 
263
 
    def stat_and_sha1(self, abspath):
264
 
        """Return the stat and sha1 of a file given its absolute path.
265
 
        
266
 
        :param abspath:  May be a filesystem encoded absolute path
267
 
             or a unicode path.
268
 
 
269
 
        Note: the stat should be the stat of the physical file
270
 
        while the sha may be the sha of its canonical content.
271
 
        """
272
 
        raise NotImplementedError(self.stat_and_sha1)
273
 
 
274
 
 
275
 
class DefaultSHA1Provider(SHA1Provider):
276
 
    """A SHA1Provider that reads directly from the filesystem."""
277
 
 
278
 
    def sha1(self, abspath):
279
 
        """Return the sha1 of a file given its absolute path."""
280
 
        return osutils.sha_file_by_name(abspath)
281
 
 
282
 
    def stat_and_sha1(self, abspath):
283
 
        """Return the stat and sha1 of a file given its absolute path."""
284
 
        file_obj = file(abspath, 'rb')
285
 
        try:
286
 
            statvalue = os.fstat(file_obj.fileno())
287
 
            sha1 = osutils.sha_file(file_obj)
288
 
        finally:
289
 
            file_obj.close()
290
 
        return statvalue, sha1
 
225
def pack_stat(st, _encode=binascii.b2a_base64, _pack=struct.pack):
 
226
    """Convert stat values into a packed representation."""
 
227
    # jam 20060614 it isn't really worth removing more entries if we
 
228
    # are going to leave it in packed form.
 
229
    # With only st_mtime and st_mode filesize is 5.5M and read time is 275ms
 
230
    # With all entries, filesize is 5.9M and read time is maybe 280ms
 
231
    # well within the noise margin
 
232
 
 
233
    # base64 encoding always adds a final newline, so strip it off
 
234
    # The current version
 
235
    return _encode(_pack('>LLLLLL'
 
236
        , st.st_size, int(st.st_mtime), int(st.st_ctime)
 
237
        , st.st_dev, st.st_ino & 0xFFFFFFFF, st.st_mode))[:-1]
 
238
    # This is 0.060s / 1.520s faster by not encoding as much information
 
239
    # return _encode(_pack('>LL', int(st.st_mtime), st.st_mode))[:-1]
 
240
    # This is not strictly faster than _encode(_pack())[:-1]
 
241
    # return '%X.%X.%X.%X.%X.%X' % (
 
242
    #      st.st_size, int(st.st_mtime), int(st.st_ctime),
 
243
    #      st.st_dev, st.st_ino, st.st_mode)
 
244
    # Similar to the _encode(_pack('>LL'))
 
245
    # return '%X.%X' % (int(st.st_mtime), st.st_mode)
291
246
 
292
247
 
293
248
class DirState(object):
339
294
    NOT_IN_MEMORY = 0
340
295
    IN_MEMORY_UNMODIFIED = 1
341
296
    IN_MEMORY_MODIFIED = 2
342
 
    IN_MEMORY_HASH_MODIFIED = 3 # Only hash-cache updates
343
297
 
344
298
    # A pack_stat (the x's) that is just noise and will never match the output
345
299
    # of base64 encode.
346
300
    NULLSTAT = 'x' * 32
347
 
    NULL_PARENT_DETAILS = static_tuple.StaticTuple('a', '', 0, False, '')
 
301
    NULL_PARENT_DETAILS = ('a', '', 0, False, '')
348
302
 
349
303
    HEADER_FORMAT_2 = '#bazaar dirstate flat format 2\n'
350
304
    HEADER_FORMAT_3 = '#bazaar dirstate flat format 3\n'
351
305
 
352
 
    def __init__(self, path, sha1_provider, worth_saving_limit=0):
 
306
    def __init__(self, path):
353
307
        """Create a  DirState object.
354
308
 
355
309
        :param path: The path at which the dirstate file on disk should live.
356
 
        :param sha1_provider: an object meeting the SHA1Provider interface.
357
 
        :param worth_saving_limit: when the exact number of hash changed
358
 
            entries is known, only bother saving the dirstate if more than
359
 
            this count of entries have changed.
360
 
            -1 means never save hash changes, 0 means always save hash changes.
361
310
        """
362
311
        # _header_state and _dirblock_state represent the current state
363
312
        # of the dirstate metadata and the per-row data respectiely.
365
314
        # IN_MEMORY_UNMODIFIED indicates that what we have in memory
366
315
        #   is the same as is on disk
367
316
        # IN_MEMORY_MODIFIED indicates that we have a modified version
368
 
        #   of what is on disk.
 
317
        #   of what is on disk. 
369
318
        # In future we will add more granularity, for instance _dirblock_state
370
319
        # will probably support partially-in-memory as a separate variable,
371
320
        # allowing for partially-in-memory unmodified and partially-in-memory
372
321
        # modified states.
373
322
        self._header_state = DirState.NOT_IN_MEMORY
374
323
        self._dirblock_state = DirState.NOT_IN_MEMORY
375
 
        # If true, an error has been detected while updating the dirstate, and
 
324
        # If true, an error has been detected while updating the dirstate, and 
376
325
        # for safety we're not going to commit to disk.
377
326
        self._changes_aborted = False
378
327
        self._dirblocks = []
389
338
        self._cutoff_time = None
390
339
        self._split_path_cache = {}
391
340
        self._bisect_page_size = DirState.BISECT_PAGE_SIZE
392
 
        self._sha1_provider = sha1_provider
393
341
        if 'hashcache' in debug.debug_flags:
394
342
            self._sha1_file = self._sha1_file_and_mutter
395
343
        else:
396
 
            self._sha1_file = self._sha1_provider.sha1
 
344
            self._sha1_file = osutils.sha_file_by_name
397
345
        # These two attributes provide a simple cache for lookups into the
398
346
        # dirstate in-memory vectors. By probing respectively for the last
399
347
        # block, and for the next entry, we save nearly 2 bisections per path
400
348
        # during commit.
401
349
        self._last_block_index = None
402
350
        self._last_entry_index = None
403
 
        # The set of known hash changes
404
 
        self._known_hash_changes = set()
405
 
        # How many hash changed entries can we have without saving
406
 
        self._worth_saving_limit = worth_saving_limit
407
 
        self._config_stack = config.LocationStack(urlutils.local_path_to_url(
408
 
            path))
409
351
 
410
352
    def __repr__(self):
411
353
        return "%s(%r)" % \
412
354
            (self.__class__.__name__, self._filename)
413
355
 
414
 
    def _mark_modified(self, hash_changed_entries=None, header_modified=False):
415
 
        """Mark this dirstate as modified.
416
 
 
417
 
        :param hash_changed_entries: if non-None, mark just these entries as
418
 
            having their hash modified.
419
 
        :param header_modified: mark the header modified as well, not just the
420
 
            dirblocks.
421
 
        """
422
 
        #trace.mutter_callsite(3, "modified hash entries: %s", hash_changed_entries)
423
 
        if hash_changed_entries:
424
 
            self._known_hash_changes.update([e[0] for e in hash_changed_entries])
425
 
            if self._dirblock_state in (DirState.NOT_IN_MEMORY,
426
 
                                        DirState.IN_MEMORY_UNMODIFIED):
427
 
                # If the dirstate is already marked a IN_MEMORY_MODIFIED, then
428
 
                # that takes precedence.
429
 
                self._dirblock_state = DirState.IN_MEMORY_HASH_MODIFIED
430
 
        else:
431
 
            # TODO: Since we now have a IN_MEMORY_HASH_MODIFIED state, we
432
 
            #       should fail noisily if someone tries to set
433
 
            #       IN_MEMORY_MODIFIED but we don't have a write-lock!
434
 
            # We don't know exactly what changed so disable smart saving
435
 
            self._dirblock_state = DirState.IN_MEMORY_MODIFIED
436
 
        if header_modified:
437
 
            self._header_state = DirState.IN_MEMORY_MODIFIED
438
 
 
439
 
    def _mark_unmodified(self):
440
 
        """Mark this dirstate as unmodified."""
441
 
        self._header_state = DirState.IN_MEMORY_UNMODIFIED
442
 
        self._dirblock_state = DirState.IN_MEMORY_UNMODIFIED
443
 
        self._known_hash_changes = set()
444
 
 
445
356
    def add(self, path, file_id, kind, stat, fingerprint):
446
357
        """Add a path to be tracked.
447
358
 
448
359
        :param path: The path within the dirstate - '' is the root, 'foo' is the
449
 
            path foo within the root, 'foo/bar' is the path bar within foo
 
360
            path foo within the root, 'foo/bar' is the path bar within foo 
450
361
            within the root.
451
362
        :param file_id: The file id of the path being added.
452
 
        :param kind: The kind of the path, as a string like 'file',
 
363
        :param kind: The kind of the path, as a string like 'file', 
453
364
            'directory', etc.
454
365
        :param stat: The output of os.lstat for the path.
455
 
        :param fingerprint: The sha value of the file's canonical form (i.e.
456
 
            after any read filters have been applied),
 
366
        :param fingerprint: The sha value of the file,
457
367
            or the target of a symlink,
458
368
            or the referenced revision id for tree-references,
459
369
            or '' for directories.
460
370
        """
461
371
        # adding a file:
462
 
        # find the block its in.
 
372
        # find the block its in. 
463
373
        # find the location in the block.
464
374
        # check its not there
465
375
        # add it.
478
388
        # in the parent, or according to the special treatment for the root
479
389
        if basename == '.' or basename == '..':
480
390
            raise errors.InvalidEntryName(path)
481
 
        # now that we've normalised, we need the correct utf8 path and
 
391
        # now that we've normalised, we need the correct utf8 path and 
482
392
        # dirname and basename elements. This single encode and split should be
483
393
        # faster than three separate encodes.
484
394
        utf8path = (dirname + '/' + basename).strip('/').encode('utf8')
485
395
        dirname, basename = osutils.split(utf8path)
486
 
        # uses __class__ for speed; the check is needed for safety
487
 
        if file_id.__class__ is not str:
488
 
            raise AssertionError(
489
 
                "must be a utf8 file_id not %s" % (type(file_id), ))
 
396
        assert file_id.__class__ == str, \
 
397
            "must be a utf8 file_id not %s" % (type(file_id))
490
398
        # Make sure the file_id does not exist in this tree
491
 
        rename_from = None
492
 
        file_id_entry = self._get_entry(0, fileid_utf8=file_id, include_deleted=True)
 
399
        file_id_entry = self._get_entry(0, fileid_utf8=file_id)
493
400
        if file_id_entry != (None, None):
494
 
            if file_id_entry[1][0][0] == 'a':
495
 
                if file_id_entry[0] != (dirname, basename, file_id):
496
 
                    # set the old name's current operation to rename
497
 
                    self.update_minimal(file_id_entry[0],
498
 
                        'r',
499
 
                        path_utf8='',
500
 
                        packed_stat='',
501
 
                        fingerprint=utf8path
502
 
                    )
503
 
                    rename_from = file_id_entry[0][0:2]
504
 
            else:
505
 
                path = osutils.pathjoin(file_id_entry[0][0], file_id_entry[0][1])
506
 
                kind = DirState._minikind_to_kind[file_id_entry[1][0][0]]
507
 
                info = '%s:%s' % (kind, path)
508
 
                raise errors.DuplicateFileId(file_id, info)
 
401
            path = osutils.pathjoin(file_id_entry[0][0], file_id_entry[0][1])
 
402
            kind = DirState._minikind_to_kind[file_id_entry[1][0][0]]
 
403
            info = '%s:%s' % (kind, path)
 
404
            raise errors.DuplicateFileId(file_id, info)
509
405
        first_key = (dirname, basename, '')
510
406
        block_index, present = self._find_block_index_from_key(first_key)
511
407
        if present:
512
408
            # check the path is not in the tree
513
409
            block = self._dirblocks[block_index][1]
514
410
            entry_index, _ = self._find_entry_index(first_key, block)
515
 
            while (entry_index < len(block) and
 
411
            while (entry_index < len(block) and 
516
412
                block[entry_index][0][0:2] == first_key[0:2]):
517
413
                if block[entry_index][1][0][0] not in 'ar':
518
414
                    # this path is in the dirstate in the current tree.
538
434
            packed_stat = pack_stat(stat)
539
435
        parent_info = self._empty_parent_info()
540
436
        minikind = DirState._kind_to_minikind[kind]
541
 
        if rename_from is not None:
542
 
            if rename_from[0]:
543
 
                old_path_utf8 = '%s/%s' % rename_from
544
 
            else:
545
 
                old_path_utf8 = rename_from[1]
546
 
            parent_info[0] = ('r', old_path_utf8, 0, False, '')
547
437
        if kind == 'file':
548
438
            entry_data = entry_key, [
549
439
                (minikind, fingerprint, size, False, packed_stat),
566
456
        if not present:
567
457
            block.insert(entry_index, entry_data)
568
458
        else:
569
 
            if block[entry_index][1][0][0] != 'a':
570
 
                raise AssertionError(" %r(%r) already added" % (basename, file_id))
 
459
            assert block[entry_index][1][0][0] == 'a', " %r(%r) already added" % (basename, file_id)
571
460
            block[entry_index][1][0] = entry_data[1][0]
572
461
 
573
462
        if kind == 'directory':
574
463
           # insert a new dirblock
575
464
           self._ensure_block(block_index, entry_index, utf8path)
576
 
        self._mark_modified()
 
465
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
577
466
        if self._id_index:
578
 
            self._add_to_id_index(self._id_index, entry_key)
 
467
            self._id_index.setdefault(entry_key[2], set()).add(entry_key)
579
468
 
580
469
    def _bisect(self, paths):
581
470
        """Bisect through the disk structure for specific rows.
592
481
        # If _dirblock_state was in memory, we should just return info from
593
482
        # there, this function is only meant to handle when we want to read
594
483
        # part of the disk.
595
 
        if self._dirblock_state != DirState.NOT_IN_MEMORY:
596
 
            raise AssertionError("bad dirblock state %r" % self._dirblock_state)
 
484
        assert self._dirblock_state == DirState.NOT_IN_MEMORY
597
485
 
598
486
        # The disk representation is generally info + '\0\n\0' at the end. But
599
487
        # for bisecting, it is easier to treat this as '\0' + info + '\0\n'
785
673
        # If _dirblock_state was in memory, we should just return info from
786
674
        # there, this function is only meant to handle when we want to read
787
675
        # part of the disk.
788
 
        if self._dirblock_state != DirState.NOT_IN_MEMORY:
789
 
            raise AssertionError("bad dirblock state %r" % self._dirblock_state)
 
676
        assert self._dirblock_state == DirState.NOT_IN_MEMORY
 
677
 
790
678
        # The disk representation is generally info + '\0\n\0' at the end. But
791
679
        # for bisecting, it is easier to treat this as '\0' + info + '\0\n'
792
680
        # Because it means we can sync on the '\n'
1008
896
 
1009
897
    def _discard_merge_parents(self):
1010
898
        """Discard any parents trees beyond the first.
1011
 
 
 
899
        
1012
900
        Note that if this fails the dirstate is corrupted.
1013
901
 
1014
902
        After this function returns the dirstate contains 2 trees, neither of
1045
933
 
1046
934
        self._ghosts = []
1047
935
        self._parents = [parents[0]]
1048
 
        self._mark_modified(header_modified=True)
 
936
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
937
        self._header_state = DirState.IN_MEMORY_MODIFIED
1049
938
 
1050
939
    def _empty_parent_info(self):
1051
940
        return [DirState.NULL_PARENT_DETAILS] * (len(self._parents) -
1078
967
        # the basename of the directory must be the end of its full name.
1079
968
        if not (parent_block_index == -1 and
1080
969
            parent_block_index == -1 and dirname == ''):
1081
 
            if not dirname.endswith(
1082
 
                    self._dirblocks[parent_block_index][1][parent_row_index][0][1]):
1083
 
                raise AssertionError("bad dirname %r" % dirname)
 
970
            assert dirname.endswith(
 
971
                self._dirblocks[parent_block_index][1][parent_row_index][0][1])
1084
972
        block_index, present = self._find_block_index_from_key((dirname, '', ''))
1085
973
        if not present:
1086
 
            ## In future, when doing partial parsing, this should load and
 
974
            ## In future, when doing partial parsing, this should load and 
1087
975
            # populate the entire block.
1088
976
            self._dirblocks.insert(block_index, (dirname, []))
1089
977
        return block_index
1098
986
            to prevent unneeded overhead when callers have a sorted list already.
1099
987
        :return: Nothing.
1100
988
        """
1101
 
        if new_entries[0][0][0:2] != ('', ''):
1102
 
            raise AssertionError(
1103
 
                "Missing root row %r" % (new_entries[0][0],))
1104
 
        # The two blocks here are deliberate: the root block and the
 
989
        assert new_entries[0][0][0:2] == ('', ''), \
 
990
            "Missing root row %r" % (new_entries[0][0],)
 
991
        # The two blocks here are deliberate: the root block and the 
1105
992
        # contents-of-root block.
1106
993
        self._dirblocks = [('', []), ('', [])]
1107
994
        current_block = self._dirblocks[0][1]
1128
1015
        # The above loop leaves the "root block" entries mixed with the
1129
1016
        # "contents-of-root block". But we don't want an if check on
1130
1017
        # all entries, so instead we just fix it up here.
1131
 
        if self._dirblocks[1] != ('', []):
1132
 
            raise ValueError("bad dirblock start %r" % (self._dirblocks[1],))
 
1018
        assert self._dirblocks[1] == ('', [])
1133
1019
        root_block = []
1134
1020
        contents_of_root_block = []
1135
1021
        for entry in self._dirblocks[0][1]:
1140
1026
        self._dirblocks[0] = ('', root_block)
1141
1027
        self._dirblocks[1] = ('', contents_of_root_block)
1142
1028
 
1143
 
    def _entries_for_path(self, path):
1144
 
        """Return a list with all the entries that match path for all ids."""
1145
 
        dirname, basename = os.path.split(path)
1146
 
        key = (dirname, basename, '')
1147
 
        block_index, present = self._find_block_index_from_key(key)
1148
 
        if not present:
1149
 
            # the block which should contain path is absent.
1150
 
            return []
1151
 
        result = []
1152
 
        block = self._dirblocks[block_index][1]
1153
 
        entry_index, _ = self._find_entry_index(key, block)
1154
 
        # we may need to look at multiple entries at this path: walk while the specific_files match.
1155
 
        while (entry_index < len(block) and
1156
 
            block[entry_index][0][0:2] == key[0:2]):
1157
 
            result.append(block[entry_index])
1158
 
            entry_index += 1
1159
 
        return result
1160
 
 
1161
1029
    def _entry_to_line(self, entry):
1162
1030
        """Serialize entry to a NULL delimited line ready for _get_output_lines.
1163
1031
 
1180
1048
    def _fields_per_entry(self):
1181
1049
        """How many null separated fields should be in each entry row.
1182
1050
 
1183
 
        Each line now has an extra '\\n' field which is not used
 
1051
        Each line now has an extra '\n' field which is not used
1184
1052
        so we just skip over it
1185
 
 
1186
 
        entry size::
 
1053
        entry size:
1187
1054
            3 fields for the key
1188
1055
            + number of fields per tree_data (5) * tree count
1189
1056
            + newline
1232
1099
        # one to use it. we use _right here because there are two
1233
1100
        # '' blocks - the root, and the contents of root
1234
1101
        # we always have a minimum of 2 in self._dirblocks: root and
1235
 
        # root-contents, and for '', we get 2 back, so this is
 
1102
        # root-contents, and for '', we get 2 back, so this is 
1236
1103
        # simple and correct:
1237
1104
        present = (block_index < len(self._dirblocks) and
1238
1105
            self._dirblocks[block_index][0] == key[0])
1267
1134
        return entry_index, present
1268
1135
 
1269
1136
    @staticmethod
1270
 
    def from_tree(tree, dir_state_filename, sha1_provider=None):
 
1137
    def from_tree(tree, dir_state_filename):
1271
1138
        """Create a dirstate from a bzr Tree.
1272
1139
 
1273
1140
        :param tree: The tree which should provide parent information and
1274
1141
            inventory ids.
1275
 
        :param sha1_provider: an object meeting the SHA1Provider interface.
1276
 
            If None, a DefaultSHA1Provider is used.
1277
1142
        :return: a DirState object which is currently locked for writing.
1278
1143
            (it was locked by DirState.initialize)
1279
1144
        """
1280
 
        result = DirState.initialize(dir_state_filename,
1281
 
            sha1_provider=sha1_provider)
 
1145
        result = DirState.initialize(dir_state_filename)
1282
1146
        try:
1283
1147
            tree.lock_read()
1284
1148
            try:
1302
1166
            raise
1303
1167
        return result
1304
1168
 
1305
 
    def _check_delta_is_valid(self, delta):
1306
 
        return list(inventory._check_delta_unique_ids(
1307
 
                    inventory._check_delta_unique_old_paths(
1308
 
                    inventory._check_delta_unique_new_paths(
1309
 
                    inventory._check_delta_ids_match_entry(
1310
 
                    inventory._check_delta_ids_are_valid(
1311
 
                    inventory._check_delta_new_path_entry_both_or_None(delta)))))))
1312
 
 
1313
1169
    def update_by_delta(self, delta):
1314
1170
        """Apply an inventory delta to the dirstate for tree 0
1315
1171
 
1316
 
        This is the workhorse for apply_inventory_delta in dirstate based
1317
 
        trees.
1318
 
 
1319
1172
        :param delta: An inventory delta.  See Inventory.apply_delta for
1320
1173
            details.
1321
1174
        """
1322
1175
        self._read_dirblocks_if_needed()
1323
 
        encode = cache_utf8.encode
1324
1176
        insertions = {}
1325
1177
        removals = {}
1326
 
        # Accumulate parent references (path_utf8, id), to check for parentless
1327
 
        # items or items placed under files/links/tree-references. We get
1328
 
        # references from every item in the delta that is not a deletion and
1329
 
        # is not itself the root.
1330
 
        parents = set()
1331
 
        # Added ids must not be in the dirstate already. This set holds those
1332
 
        # ids.
1333
 
        new_ids = set()
1334
 
        # This loop transforms the delta to single atomic operations that can
1335
 
        # be executed and validated.
1336
 
        delta = sorted(self._check_delta_is_valid(delta), reverse=True)
1337
 
        for old_path, new_path, file_id, inv_entry in delta:
1338
 
            if (file_id in insertions) or (file_id in removals):
1339
 
                self._raise_invalid(old_path or new_path, file_id,
1340
 
                    "repeated file_id")
 
1178
        for old_path, new_path, file_id, inv_entry in sorted(delta,
 
1179
                                                             reverse=True):
 
1180
            assert file_id not in insertions
 
1181
            assert file_id not in removals
1341
1182
            if old_path is not None:
1342
1183
                old_path = old_path.encode('utf-8')
1343
1184
                removals[file_id] = old_path
1344
 
            else:
1345
 
                new_ids.add(file_id)
1346
1185
            if new_path is not None:
1347
 
                if inv_entry is None:
1348
 
                    self._raise_invalid(new_path, file_id,
1349
 
                        "new_path with no entry")
1350
1186
                new_path = new_path.encode('utf-8')
1351
 
                dirname_utf8, basename = osutils.split(new_path)
1352
 
                if basename:
1353
 
                    parents.add((dirname_utf8, inv_entry.parent_id))
1354
 
                key = (dirname_utf8, basename, file_id)
 
1187
                dirname, basename = osutils.split(new_path)
 
1188
                key = (dirname, basename, file_id)
1355
1189
                minikind = DirState._kind_to_minikind[inv_entry.kind]
1356
1190
                if minikind == 't':
1357
 
                    fingerprint = inv_entry.reference_revision or ''
 
1191
                    fingerprint = inv_entry.reference_revision
1358
1192
                else:
1359
1193
                    fingerprint = ''
1360
1194
                insertions[file_id] = (key, minikind, inv_entry.executable,
1361
1195
                                       fingerprint, new_path)
1362
 
            # Transform moves into delete+add pairs
1363
1196
            if None not in (old_path, new_path):
1364
1197
                for child in self._iter_child_entries(0, old_path):
1365
1198
                    if child[0][2] in insertions or child[0][2] in removals:
1369
1202
                    minikind = child[1][0][0]
1370
1203
                    fingerprint = child[1][0][4]
1371
1204
                    executable = child[1][0][3]
1372
 
                    old_child_path = osutils.pathjoin(child_dirname,
1373
 
                                                      child_basename)
 
1205
                    old_child_path = osutils.pathjoin(child[0][0],
 
1206
                                                      child[0][1])
1374
1207
                    removals[child[0][2]] = old_child_path
1375
1208
                    child_suffix = child_dirname[len(old_path):]
1376
1209
                    new_child_dirname = (new_path + child_suffix)
1377
1210
                    key = (new_child_dirname, child_basename, child[0][2])
1378
 
                    new_child_path = osutils.pathjoin(new_child_dirname,
1379
 
                                                      child_basename)
 
1211
                    new_child_path = os.path.join(new_child_dirname,
 
1212
                                                  child_basename)
1380
1213
                    insertions[child[0][2]] = (key, minikind, executable,
1381
1214
                                               fingerprint, new_child_path)
1382
 
        self._check_delta_ids_absent(new_ids, delta, 0)
1383
 
        try:
1384
 
            self._apply_removals(removals.iteritems())
1385
 
            self._apply_insertions(insertions.values())
1386
 
            # Validate parents
1387
 
            self._after_delta_check_parents(parents, 0)
1388
 
        except errors.BzrError, e:
1389
 
            self._changes_aborted = True
1390
 
            if 'integrity error' not in str(e):
1391
 
                raise
1392
 
            # _get_entry raises BzrError when a request is inconsistent; we
1393
 
            # want such errors to be shown as InconsistentDelta - and that 
1394
 
            # fits the behaviour we trigger.
1395
 
            raise errors.InconsistentDeltaDelta(delta,
1396
 
                "error from _get_entry. %s" % (e,))
 
1215
        self._apply_removals(removals.values())
 
1216
        self._apply_insertions(insertions.values())
1397
1217
 
1398
1218
    def _apply_removals(self, removals):
1399
 
        for file_id, path in sorted(removals, reverse=True,
1400
 
            key=operator.itemgetter(1)):
 
1219
        for path in sorted(removals, reverse=True):
1401
1220
            dirname, basename = osutils.split(path)
1402
1221
            block_i, entry_i, d_present, f_present = \
1403
1222
                self._get_block_entry_index(dirname, basename, 0)
1404
 
            try:
1405
 
                entry = self._dirblocks[block_i][1][entry_i]
1406
 
            except IndexError:
1407
 
                self._raise_invalid(path, file_id,
1408
 
                    "Wrong path for old path.")
1409
 
            if not f_present or entry[1][0][0] in 'ar':
1410
 
                self._raise_invalid(path, file_id,
1411
 
                    "Wrong path for old path.")
1412
 
            if file_id != entry[0][2]:
1413
 
                self._raise_invalid(path, file_id,
1414
 
                    "Attempt to remove path has wrong id - found %r."
1415
 
                    % entry[0][2])
 
1223
            entry = self._dirblocks[block_i][1][entry_i]
1416
1224
            self._make_absent(entry)
1417
 
            # See if we have a malformed delta: deleting a directory must not
1418
 
            # leave crud behind. This increases the number of bisects needed
1419
 
            # substantially, but deletion or renames of large numbers of paths
1420
 
            # is rare enough it shouldn't be an issue (famous last words?) RBC
1421
 
            # 20080730.
1422
 
            block_i, entry_i, d_present, f_present = \
1423
 
                self._get_block_entry_index(path, '', 0)
1424
 
            if d_present:
1425
 
                # The dir block is still present in the dirstate; this could
1426
 
                # be due to it being in a parent tree, or a corrupt delta.
1427
 
                for child_entry in self._dirblocks[block_i][1]:
1428
 
                    if child_entry[1][0][0] not in ('r', 'a'):
1429
 
                        self._raise_invalid(path, entry[0][2],
1430
 
                            "The file id was deleted but its children were "
1431
 
                            "not deleted.")
1432
1225
 
1433
1226
    def _apply_insertions(self, adds):
1434
 
        try:
1435
 
            for key, minikind, executable, fingerprint, path_utf8 in sorted(adds):
1436
 
                self.update_minimal(key, minikind, executable, fingerprint,
1437
 
                                    path_utf8=path_utf8)
1438
 
        except errors.NotVersionedError:
1439
 
            self._raise_invalid(path_utf8.decode('utf8'), key[2],
1440
 
                "Missing parent")
 
1227
        for key, minikind, executable, fingerprint, path_utf8 in sorted(adds):
 
1228
            self.update_minimal(key, minikind, executable, fingerprint,
 
1229
                                path_utf8=path_utf8)
1441
1230
 
1442
1231
    def update_basis_by_delta(self, delta, new_revid):
1443
1232
        """Update the parents of this tree after a commit.
1450
1239
        Note that an exception during the operation of this method will leave
1451
1240
        the dirstate in a corrupt state where it should not be saved.
1452
1241
 
 
1242
        Finally, we expect all changes to be synchronising the basis tree with
 
1243
        the working tree.
 
1244
 
1453
1245
        :param new_revid: The new revision id for the trees parent.
1454
1246
        :param delta: An inventory delta (see apply_inventory_delta) describing
1455
1247
            the changes from the current left most parent revision to new_revid.
1467
1259
 
1468
1260
        self._parents[0] = new_revid
1469
1261
 
1470
 
        delta = sorted(self._check_delta_is_valid(delta), reverse=True)
 
1262
        delta = sorted(delta, reverse=True)
1471
1263
        adds = []
1472
1264
        changes = []
1473
1265
        deletes = []
1484
1276
        # At the same time, to reduce interface friction we convert the input
1485
1277
        # inventory entries to dirstate.
1486
1278
        root_only = ('', '')
1487
 
        # Accumulate parent references (path_utf8, id), to check for parentless
1488
 
        # items or items placed under files/links/tree-references. We get
1489
 
        # references from every item in the delta that is not a deletion and
1490
 
        # is not itself the root.
1491
 
        parents = set()
1492
 
        # Added ids must not be in the dirstate already. This set holds those
1493
 
        # ids.
1494
 
        new_ids = set()
1495
1279
        for old_path, new_path, file_id, inv_entry in delta:
1496
 
            if inv_entry is not None and file_id != inv_entry.file_id:
1497
 
                self._raise_invalid(new_path, file_id,
1498
 
                    "mismatched entry file_id %r" % inv_entry)
1499
 
            if new_path is None:
1500
 
                new_path_utf8 = None
1501
 
            else:
1502
 
                if inv_entry is None:
1503
 
                    self._raise_invalid(new_path, file_id,
1504
 
                        "new_path with no entry")
1505
 
                new_path_utf8 = encode(new_path)
1506
 
                # note the parent for validation
1507
 
                dirname_utf8, basename_utf8 = osutils.split(new_path_utf8)
1508
 
                if basename_utf8:
1509
 
                    parents.add((dirname_utf8, inv_entry.parent_id))
1510
 
            if old_path is None:
1511
 
                old_path_utf8 = None
1512
 
            else:
1513
 
                old_path_utf8 = encode(old_path)
1514
 
            if old_path is None:
1515
 
                adds.append((None, new_path_utf8, file_id,
 
1280
            if old_path is None:
 
1281
                adds.append((None, encode(new_path), file_id,
1516
1282
                    inv_to_entry(inv_entry), True))
1517
 
                new_ids.add(file_id)
1518
1283
            elif new_path is None:
1519
 
                deletes.append((old_path_utf8, None, file_id, None, True))
1520
 
            elif (old_path, new_path) == root_only:
1521
 
                # change things in-place
1522
 
                # Note: the case of a parent directory changing its file_id
1523
 
                #       tends to break optimizations here, because officially
1524
 
                #       the file has actually been moved, it just happens to
1525
 
                #       end up at the same path. If we can figure out how to
1526
 
                #       handle that case, we can avoid a lot of add+delete
1527
 
                #       pairs for objects that stay put.
1528
 
                # elif old_path == new_path:
1529
 
                changes.append((old_path_utf8, new_path_utf8, file_id,
1530
 
                                inv_to_entry(inv_entry)))
1531
 
            else:
 
1284
                deletes.append((encode(old_path), None, file_id, None, True))
 
1285
            elif (old_path, new_path) != root_only:
1532
1286
                # Renames:
1533
1287
                # Because renames must preserve their children we must have
1534
1288
                # processed all relocations and removes before hand. The sort
1543
1297
                # for 'r' items on every pass.
1544
1298
                self._update_basis_apply_deletes(deletes)
1545
1299
                deletes = []
 
1300
                new_path_utf8 = encode(new_path)
1546
1301
                # Split into an add/delete pair recursively.
1547
 
                adds.append((old_path_utf8, new_path_utf8, file_id,
1548
 
                             inv_to_entry(inv_entry), False))
 
1302
                adds.append((None, new_path_utf8, file_id,
 
1303
                    inv_to_entry(inv_entry), False))
1549
1304
                # Expunge deletes that we've seen so that deleted/renamed
1550
1305
                # children of a rename directory are handled correctly.
1551
 
                new_deletes = reversed(list(
1552
 
                    self._iter_child_entries(1, old_path_utf8)))
 
1306
                new_deletes = reversed(list(self._iter_child_entries(1,
 
1307
                    encode(old_path))))
1553
1308
                # Remove the current contents of the tree at orig_path, and
1554
1309
                # reinsert at the correct new path.
1555
1310
                for entry in new_deletes:
1556
 
                    child_dirname, child_basename, child_file_id = entry[0]
1557
 
                    if child_dirname:
1558
 
                        source_path = child_dirname + '/' + child_basename
 
1311
                    if entry[0][0]:
 
1312
                        source_path = entry[0][0] + '/' + entry[0][1]
1559
1313
                    else:
1560
 
                        source_path = child_basename
 
1314
                        source_path = entry[0][1]
1561
1315
                    if new_path_utf8:
1562
1316
                        target_path = new_path_utf8 + source_path[len(old_path):]
1563
1317
                    else:
1564
 
                        if old_path == '':
1565
 
                            raise AssertionError("cannot rename directory to"
1566
 
                                                 " itself")
 
1318
                        assert len(old_path) > 0, ("cannot rename directory to"
 
1319
                                                   " itself")
1567
1320
                        target_path = source_path[len(old_path) + 1:]
1568
1321
                    adds.append((None, target_path, entry[0][2], entry[1][1], False))
1569
1322
                    deletes.append(
1570
1323
                        (source_path, target_path, entry[0][2], None, False))
1571
 
                deletes.append((old_path_utf8, new_path, file_id, None, False))
1572
 
        self._check_delta_ids_absent(new_ids, delta, 1)
1573
 
        try:
1574
 
            # Finish expunging deletes/first half of renames.
1575
 
            self._update_basis_apply_deletes(deletes)
1576
 
            # Reinstate second half of renames and new paths.
1577
 
            self._update_basis_apply_adds(adds)
1578
 
            # Apply in-situ changes.
1579
 
            self._update_basis_apply_changes(changes)
1580
 
            # Validate parents
1581
 
            self._after_delta_check_parents(parents, 1)
1582
 
        except errors.BzrError, e:
1583
 
            self._changes_aborted = True
1584
 
            if 'integrity error' not in str(e):
1585
 
                raise
1586
 
            # _get_entry raises BzrError when a request is inconsistent; we
1587
 
            # want such errors to be shown as InconsistentDelta - and that
1588
 
            # fits the behaviour we trigger.
1589
 
            raise errors.InconsistentDeltaDelta(delta,
1590
 
                "error from _get_entry. %s" % (e,))
1591
 
 
1592
 
        self._mark_modified(header_modified=True)
 
1324
                deletes.append(
 
1325
                    (encode(old_path), new_path, file_id, None, False))
 
1326
            else:
 
1327
                # changes to just the root should not require remove/insertion
 
1328
                # of everything.
 
1329
                changes.append((encode(old_path), encode(new_path), file_id,
 
1330
                    inv_to_entry(inv_entry)))
 
1331
 
 
1332
        # Finish expunging deletes/first half of renames.
 
1333
        self._update_basis_apply_deletes(deletes)
 
1334
        # Reinstate second half of renames and new paths.
 
1335
        self._update_basis_apply_adds(adds)
 
1336
        # Apply in-situ changes.
 
1337
        self._update_basis_apply_changes(changes)
 
1338
 
 
1339
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
1340
        self._header_state = DirState.IN_MEMORY_MODIFIED
1593
1341
        self._id_index = None
1594
1342
        return
1595
1343
 
1596
 
    def _check_delta_ids_absent(self, new_ids, delta, tree_index):
1597
 
        """Check that none of the file_ids in new_ids are present in a tree."""
1598
 
        if not new_ids:
1599
 
            return
1600
 
        id_index = self._get_id_index()
1601
 
        for file_id in new_ids:
1602
 
            for key in id_index.get(file_id, ()):
1603
 
                block_i, entry_i, d_present, f_present = \
1604
 
                    self._get_block_entry_index(key[0], key[1], tree_index)
1605
 
                if not f_present:
1606
 
                    # In a different tree
1607
 
                    continue
1608
 
                entry = self._dirblocks[block_i][1][entry_i]
1609
 
                if entry[0][2] != file_id:
1610
 
                    # Different file_id, so not what we want.
1611
 
                    continue
1612
 
                self._raise_invalid(("%s/%s" % key[0:2]).decode('utf8'), file_id,
1613
 
                    "This file_id is new in the delta but already present in "
1614
 
                    "the target")
1615
 
 
1616
 
    def _raise_invalid(self, path, file_id, reason):
1617
 
        self._changes_aborted = True
1618
 
        raise errors.InconsistentDelta(path, file_id, reason)
1619
 
 
1620
1344
    def _update_basis_apply_adds(self, adds):
1621
1345
        """Apply a sequence of adds to tree 1 during update_basis_by_delta.
1622
1346
 
1630
1354
        """
1631
1355
        # Adds are accumulated partly from renames, so can be in any input
1632
1356
        # order - sort it.
1633
 
        # TODO: we may want to sort in dirblocks order. That way each entry
1634
 
        #       will end up in the same directory, allowing the _get_entry
1635
 
        #       fast-path for looking up 2 items in the same dir work.
1636
 
        adds.sort(key=lambda x: x[1])
 
1357
        adds.sort()
1637
1358
        # adds is now in lexographic order, which places all parents before
1638
1359
        # their children, so we can process it linearly.
1639
1360
        absent = 'ar'
1640
 
        st = static_tuple.StaticTuple
1641
1361
        for old_path, new_path, file_id, new_details, real_add in adds:
1642
 
            dirname, basename = osutils.split(new_path)
1643
 
            entry_key = st(dirname, basename, file_id)
1644
 
            block_index, present = self._find_block_index_from_key(entry_key)
1645
 
            if not present:
1646
 
                self._raise_invalid(new_path, file_id,
1647
 
                    "Unable to find block for this record."
1648
 
                    " Was the parent added?")
1649
 
            block = self._dirblocks[block_index][1]
1650
 
            entry_index, present = self._find_entry_index(entry_key, block)
1651
 
            if real_add:
1652
 
                if old_path is not None:
1653
 
                    self._raise_invalid(new_path, file_id,
1654
 
                        'considered a real add but still had old_path at %s'
1655
 
                        % (old_path,))
1656
 
            if present:
1657
 
                entry = block[entry_index]
1658
 
                basis_kind = entry[1][1][0]
1659
 
                if basis_kind == 'a':
1660
 
                    entry[1][1] = new_details
1661
 
                elif basis_kind == 'r':
1662
 
                    raise NotImplementedError()
1663
 
                else:
1664
 
                    self._raise_invalid(new_path, file_id,
1665
 
                        "An entry was marked as a new add"
1666
 
                        " but the basis target already existed")
1667
 
            else:
1668
 
                # The exact key was not found in the block. However, we need to
1669
 
                # check if there is a key next to us that would have matched.
1670
 
                # We only need to check 2 locations, because there are only 2
1671
 
                # trees present.
1672
 
                for maybe_index in range(entry_index-1, entry_index+1):
1673
 
                    if maybe_index < 0 or maybe_index >= len(block):
1674
 
                        continue
1675
 
                    maybe_entry = block[maybe_index]
1676
 
                    if maybe_entry[0][:2] != (dirname, basename):
1677
 
                        # Just a random neighbor
1678
 
                        continue
1679
 
                    if maybe_entry[0][2] == file_id:
1680
 
                        raise AssertionError(
1681
 
                            '_find_entry_index didnt find a key match'
1682
 
                            ' but walking the data did, for %s'
1683
 
                            % (entry_key,))
1684
 
                    basis_kind = maybe_entry[1][1][0]
1685
 
                    if basis_kind not in 'ar':
1686
 
                        self._raise_invalid(new_path, file_id,
1687
 
                            "we have an add record for path, but the path"
1688
 
                            " is already present with another file_id %s"
1689
 
                            % (maybe_entry[0][2],))
1690
 
 
1691
 
                entry = (entry_key, [DirState.NULL_PARENT_DETAILS,
1692
 
                                     new_details])
1693
 
                block.insert(entry_index, entry)
1694
 
 
1695
 
            active_kind = entry[1][0][0]
1696
 
            if active_kind == 'a':
1697
 
                # The active record shows up as absent, this could be genuine,
1698
 
                # or it could be present at some other location. We need to
1699
 
                # verify.
1700
 
                id_index = self._get_id_index()
1701
 
                # The id_index may not be perfectly accurate for tree1, because
1702
 
                # we haven't been keeping it updated. However, it should be
1703
 
                # fine for tree0, and that gives us enough info for what we
1704
 
                # need
1705
 
                keys = id_index.get(file_id, ())
1706
 
                for key in keys:
1707
 
                    block_i, entry_i, d_present, f_present = \
1708
 
                        self._get_block_entry_index(key[0], key[1], 0)
1709
 
                    if not f_present:
1710
 
                        continue
1711
 
                    active_entry = self._dirblocks[block_i][1][entry_i]
1712
 
                    if (active_entry[0][2] != file_id):
1713
 
                        # Some other file is at this path, we don't need to
1714
 
                        # link it.
1715
 
                        continue
1716
 
                    real_active_kind = active_entry[1][0][0]
1717
 
                    if real_active_kind in 'ar':
1718
 
                        # We found a record, which was not *this* record,
1719
 
                        # which matches the file_id, but is not actually
1720
 
                        # present. Something seems *really* wrong.
1721
 
                        self._raise_invalid(new_path, file_id,
1722
 
                            "We found a tree0 entry that doesnt make sense")
1723
 
                    # Now, we've found a tree0 entry which matches the file_id
1724
 
                    # but is at a different location. So update them to be
1725
 
                    # rename records.
1726
 
                    active_dir, active_name = active_entry[0][:2]
1727
 
                    if active_dir:
1728
 
                        active_path = active_dir + '/' + active_name
1729
 
                    else:
1730
 
                        active_path = active_name
1731
 
                    active_entry[1][1] = st('r', new_path, 0, False, '')
1732
 
                    entry[1][0] = st('r', active_path, 0, False, '')
1733
 
            elif active_kind == 'r':
1734
 
                raise NotImplementedError()
1735
 
 
1736
 
            new_kind = new_details[0]
1737
 
            if new_kind == 'd':
1738
 
                self._ensure_block(block_index, entry_index, new_path)
 
1362
            assert old_path is None
 
1363
            # the entry for this file_id must be in tree 0.
 
1364
            entry = self._get_entry(0, file_id, new_path)
 
1365
            if entry[0] is None or entry[0][2] != file_id:
 
1366
                self._changes_aborted = True
 
1367
                raise errors.InconsistentDelta(new_path, file_id,
 
1368
                    'working tree does not contain new entry')
 
1369
            if real_add and entry[1][1][0] not in absent:
 
1370
                self._changes_aborted = True
 
1371
                raise errors.InconsistentDelta(new_path, file_id,
 
1372
                    'The entry was considered to be a genuinely new record,'
 
1373
                    ' but there was already an old record for it.')
 
1374
            # We don't need to update the target of an 'r' because the handling
 
1375
            # of renames turns all 'r' situations into a delete at the original
 
1376
            # location.
 
1377
            entry[1][1] = new_details
1739
1378
 
1740
1379
    def _update_basis_apply_changes(self, changes):
1741
1380
        """Apply a sequence of changes to tree 1 during update_basis_by_delta.
1745
1384
        """
1746
1385
        absent = 'ar'
1747
1386
        for old_path, new_path, file_id, new_details in changes:
 
1387
            assert old_path == new_path
1748
1388
            # the entry for this file_id must be in tree 0.
1749
 
            entry = self._get_entry(1, file_id, new_path)
1750
 
            if entry[0] is None or entry[1][1][0] in 'ar':
1751
 
                self._raise_invalid(new_path, file_id,
1752
 
                    'changed entry considered not present')
 
1389
            entry = self._get_entry(0, file_id, new_path)
 
1390
            if entry[0] is None or entry[0][2] != file_id:
 
1391
                self._changes_aborted = True
 
1392
                raise errors.InconsistentDelta(new_path, file_id,
 
1393
                    'working tree does not contain new entry')
 
1394
            if (entry[1][0][0] in absent or
 
1395
                entry[1][1][0] in absent):
 
1396
                self._changes_aborted = True
 
1397
                raise errors.InconsistentDelta(new_path, file_id,
 
1398
                    'changed considered absent')
1753
1399
            entry[1][1] = new_details
1754
1400
 
1755
1401
    def _update_basis_apply_deletes(self, deletes):
1766
1412
        """
1767
1413
        null = DirState.NULL_PARENT_DETAILS
1768
1414
        for old_path, new_path, file_id, _, real_delete in deletes:
1769
 
            if real_delete != (new_path is None):
1770
 
                self._raise_invalid(old_path, file_id, "bad delete delta")
 
1415
            if real_delete:
 
1416
                assert new_path is None
 
1417
            else:
 
1418
                assert new_path is not None
1771
1419
            # the entry for this file_id must be in tree 1.
1772
1420
            dirname, basename = osutils.split(old_path)
1773
1421
            block_index, entry_index, dir_present, file_present = \
1774
1422
                self._get_block_entry_index(dirname, basename, 1)
1775
1423
            if not file_present:
1776
 
                self._raise_invalid(old_path, file_id,
 
1424
                self._changes_aborted = True
 
1425
                raise errors.InconsistentDelta(old_path, file_id,
1777
1426
                    'basis tree does not contain removed entry')
1778
1427
            entry = self._dirblocks[block_index][1][entry_index]
1779
 
            # The state of the entry in the 'active' WT
1780
 
            active_kind = entry[1][0][0]
1781
1428
            if entry[0][2] != file_id:
1782
 
                self._raise_invalid(old_path, file_id,
 
1429
                self._changes_aborted = True
 
1430
                raise errors.InconsistentDelta(old_path, file_id,
1783
1431
                    'mismatched file_id in tree 1')
1784
 
            dir_block = ()
1785
 
            old_kind = entry[1][1][0]
1786
 
            if active_kind in 'ar':
1787
 
                # The active tree doesn't have this file_id.
1788
 
                # The basis tree is changing this record. If this is a
1789
 
                # rename, then we don't want the record here at all
1790
 
                # anymore. If it is just an in-place change, we want the
1791
 
                # record here, but we'll add it if we need to. So we just
1792
 
                # delete it
1793
 
                if active_kind == 'r':
1794
 
                    active_path = entry[1][0][1]
1795
 
                    active_entry = self._get_entry(0, file_id, active_path)
1796
 
                    if active_entry[1][1][0] != 'r':
1797
 
                        self._raise_invalid(old_path, file_id,
1798
 
                            "Dirstate did not have matching rename entries")
1799
 
                    elif active_entry[1][0][0] in 'ar':
1800
 
                        self._raise_invalid(old_path, file_id,
1801
 
                            "Dirstate had a rename pointing at an inactive"
1802
 
                            " tree0")
1803
 
                    active_entry[1][1] = null
 
1432
            if real_delete:
 
1433
                if entry[1][0][0] != 'a':
 
1434
                    self._changes_aborted = True
 
1435
                    raise errors.InconsistentDelta(old_path, file_id,
 
1436
                            'This was marked as a real delete, but the WT state'
 
1437
                            ' claims that it still exists and is versioned.')
1804
1438
                del self._dirblocks[block_index][1][entry_index]
1805
 
                if old_kind == 'd':
1806
 
                    # This was a directory, and the active tree says it
1807
 
                    # doesn't exist, and now the basis tree says it doesn't
1808
 
                    # exist. Remove its dirblock if present
1809
 
                    (dir_block_index,
1810
 
                     present) = self._find_block_index_from_key(
1811
 
                        (old_path, '', ''))
1812
 
                    if present:
1813
 
                        dir_block = self._dirblocks[dir_block_index][1]
1814
 
                        if not dir_block:
1815
 
                            # This entry is empty, go ahead and just remove it
1816
 
                            del self._dirblocks[dir_block_index]
1817
1439
            else:
1818
 
                # There is still an active record, so just mark this
1819
 
                # removed.
1820
 
                entry[1][1] = null
1821
 
                block_i, entry_i, d_present, f_present = \
1822
 
                    self._get_block_entry_index(old_path, '', 1)
1823
 
                if d_present:
1824
 
                    dir_block = self._dirblocks[block_i][1]
1825
 
            for child_entry in dir_block:
1826
 
                child_basis_kind = child_entry[1][1][0]
1827
 
                if child_basis_kind not in 'ar':
1828
 
                    self._raise_invalid(old_path, file_id,
1829
 
                        "The file id was deleted but its children were "
1830
 
                        "not deleted.")
1831
 
 
1832
 
    def _after_delta_check_parents(self, parents, index):
1833
 
        """Check that parents required by the delta are all intact.
1834
 
        
1835
 
        :param parents: An iterable of (path_utf8, file_id) tuples which are
1836
 
            required to be present in tree 'index' at path_utf8 with id file_id
1837
 
            and be a directory.
1838
 
        :param index: The column in the dirstate to check for parents in.
1839
 
        """
1840
 
        for dirname_utf8, file_id in parents:
1841
 
            # Get the entry - the ensures that file_id, dirname_utf8 exists and
1842
 
            # has the right file id.
1843
 
            entry = self._get_entry(index, file_id, dirname_utf8)
1844
 
            if entry[1] is None:
1845
 
                self._raise_invalid(dirname_utf8.decode('utf8'),
1846
 
                    file_id, "This parent is not present.")
1847
 
            # Parents of things must be directories
1848
 
            if entry[1][index][0] != 'd':
1849
 
                self._raise_invalid(dirname_utf8.decode('utf8'),
1850
 
                    file_id, "This parent is not a directory.")
1851
 
 
1852
 
    def _observed_sha1(self, entry, sha1, stat_value,
1853
 
        _stat_to_minikind=_stat_to_minikind):
1854
 
        """Note the sha1 of a file.
1855
 
 
1856
 
        :param entry: The entry the sha1 is for.
1857
 
        :param sha1: The observed sha1.
1858
 
        :param stat_value: The os.lstat for the file.
 
1440
                if entry[1][0][0] == 'a':
 
1441
                    self._changes_aborted = True
 
1442
                    raise errors.InconsistentDelta(old_path, file_id,
 
1443
                        'The entry was considered a rename, but the source path'
 
1444
                        ' is marked as absent.')
 
1445
                    # For whatever reason, we were asked to rename an entry
 
1446
                    # that was originally marked as deleted. This could be
 
1447
                    # because we are renaming the parent directory, and the WT
 
1448
                    # current state has the file marked as deleted.
 
1449
                elif entry[1][0][0] == 'r':
 
1450
                    # implement the rename
 
1451
                    del self._dirblocks[block_index][1][entry_index]
 
1452
                else:
 
1453
                    # it is being resurrected here, so blank it out temporarily.
 
1454
                    self._dirblocks[block_index][1][entry_index][1][1] = null
 
1455
 
 
1456
    def update_entry(self, entry, abspath, stat_value,
 
1457
                     _stat_to_minikind=_stat_to_minikind,
 
1458
                     _pack_stat=pack_stat):
 
1459
        """Update the entry based on what is actually on disk.
 
1460
 
 
1461
        :param entry: This is the dirblock entry for the file in question.
 
1462
        :param abspath: The path on disk for this file.
 
1463
        :param stat_value: (optional) if we already have done a stat on the
 
1464
            file, re-use it.
 
1465
        :return: The sha1 hexdigest of the file (40 bytes) or link target of a
 
1466
                symlink.
1859
1467
        """
1860
1468
        try:
1861
1469
            minikind = _stat_to_minikind[stat_value.st_mode & 0170000]
1862
1470
        except KeyError:
1863
1471
            # Unhandled kind
1864
1472
            return None
 
1473
        packed_stat = _pack_stat(stat_value)
 
1474
        (saved_minikind, saved_link_or_sha1, saved_file_size,
 
1475
         saved_executable, saved_packed_stat) = entry[1][0]
 
1476
 
 
1477
        if (minikind == saved_minikind
 
1478
            and packed_stat == saved_packed_stat):
 
1479
            # The stat hasn't changed since we saved, so we can re-use the
 
1480
            # saved sha hash.
 
1481
            if minikind == 'd':
 
1482
                return None
 
1483
 
 
1484
            # size should also be in packed_stat
 
1485
            if saved_file_size == stat_value.st_size:
 
1486
                return saved_link_or_sha1
 
1487
 
 
1488
        # If we have gotten this far, that means that we need to actually
 
1489
        # process this entry.
 
1490
        link_or_sha1 = None
1865
1491
        if minikind == 'f':
1866
 
            if self._cutoff_time is None:
1867
 
                self._sha_cutoff_time()
1868
 
            if (stat_value.st_mtime < self._cutoff_time
1869
 
                and stat_value.st_ctime < self._cutoff_time):
1870
 
                entry[1][0] = ('f', sha1, stat_value.st_size, entry[1][0][3],
1871
 
                               pack_stat(stat_value))
1872
 
                self._mark_modified([entry])
 
1492
            link_or_sha1 = self._sha1_file(abspath)
 
1493
            executable = self._is_executable(stat_value.st_mode,
 
1494
                                             saved_executable)
 
1495
            if self._cutoff_time is None:
 
1496
                self._sha_cutoff_time()
 
1497
            if (stat_value.st_mtime < self._cutoff_time
 
1498
                and stat_value.st_ctime < self._cutoff_time):
 
1499
                entry[1][0] = ('f', link_or_sha1, stat_value.st_size,
 
1500
                               executable, packed_stat)
 
1501
            else:
 
1502
                entry[1][0] = ('f', '', stat_value.st_size,
 
1503
                               executable, DirState.NULLSTAT)
 
1504
        elif minikind == 'd':
 
1505
            link_or_sha1 = None
 
1506
            entry[1][0] = ('d', '', 0, False, packed_stat)
 
1507
            if saved_minikind != 'd':
 
1508
                # This changed from something into a directory. Make sure we
 
1509
                # have a directory block for it. This doesn't happen very
 
1510
                # often, so this doesn't have to be super fast.
 
1511
                block_index, entry_index, dir_present, file_present = \
 
1512
                    self._get_block_entry_index(entry[0][0], entry[0][1], 0)
 
1513
                self._ensure_block(block_index, entry_index,
 
1514
                                   osutils.pathjoin(entry[0][0], entry[0][1]))
 
1515
        elif minikind == 'l':
 
1516
            link_or_sha1 = self._read_link(abspath, saved_link_or_sha1)
 
1517
            if self._cutoff_time is None:
 
1518
                self._sha_cutoff_time()
 
1519
            if (stat_value.st_mtime < self._cutoff_time
 
1520
                and stat_value.st_ctime < self._cutoff_time):
 
1521
                entry[1][0] = ('l', link_or_sha1, stat_value.st_size,
 
1522
                               False, packed_stat)
 
1523
            else:
 
1524
                entry[1][0] = ('l', '', stat_value.st_size,
 
1525
                               False, DirState.NULLSTAT)
 
1526
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
1527
        return link_or_sha1
1873
1528
 
1874
1529
    def _sha_cutoff_time(self):
1875
1530
        """Return cutoff time.
1892
1547
        # when -Dhashcache is turned on, this is monkey-patched in to log
1893
1548
        # file reads
1894
1549
        trace.mutter("dirstate sha1 " + abspath)
1895
 
        return self._sha1_provider.sha1(abspath)
 
1550
        return osutils.sha_file_by_name(abspath)
1896
1551
 
1897
1552
    def _is_executable(self, mode, old_executable):
1898
1553
        """Is this file executable?"""
1911
1566
        #       already in memory. However, this really needs to be done at a
1912
1567
        #       higher level, because there either won't be anything on disk,
1913
1568
        #       or the thing on disk will be a file.
1914
 
        fs_encoding = osutils._fs_enc
1915
 
        if isinstance(abspath, unicode):
1916
 
            # abspath is defined as the path to pass to lstat. readlink is
1917
 
            # buggy in python < 2.6 (it doesn't encode unicode path into FS
1918
 
            # encoding), so we need to encode ourselves knowing that unicode
1919
 
            # paths are produced by UnicodeDirReader on purpose.
1920
 
            abspath = abspath.encode(fs_encoding)
1921
 
        target = os.readlink(abspath)
1922
 
        if fs_encoding not in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
1923
 
            # Change encoding if needed
1924
 
            target = target.decode(fs_encoding).encode('UTF-8')
1925
 
        return target
 
1569
        return os.readlink(abspath)
1926
1570
 
1927
1571
    def get_ghosts(self):
1928
1572
        """Return a list of the parent tree revision ids that are ghosts."""
1933
1577
        """Serialise the entire dirstate to a sequence of lines."""
1934
1578
        if (self._header_state == DirState.IN_MEMORY_UNMODIFIED and
1935
1579
            self._dirblock_state == DirState.IN_MEMORY_UNMODIFIED):
1936
 
            # read what's on disk.
 
1580
            # read whats on disk.
1937
1581
            self._state_file.seek(0)
1938
1582
            return self._state_file.readlines()
1939
1583
        lines = []
1940
1584
        lines.append(self._get_parents_line(self.get_parent_ids()))
1941
1585
        lines.append(self._get_ghosts_line(self._ghosts))
1942
 
        lines.extend(self._get_entry_lines())
 
1586
        # append the root line which is special cased
 
1587
        lines.extend(map(self._entry_to_line, self._iter_entries()))
1943
1588
        return self._get_output_lines(lines)
1944
1589
 
1945
1590
    def _get_ghosts_line(self, ghost_ids):
1950
1595
        """Create a line for the state file for parents information."""
1951
1596
        return '\0'.join([str(len(parent_ids))] + parent_ids)
1952
1597
 
1953
 
    def _get_entry_lines(self):
1954
 
        """Create lines for entries."""
1955
 
        return map(self._entry_to_line, self._iter_entries())
1956
 
 
1957
1598
    def _get_fields_to_entry(self):
1958
1599
        """Get a function which converts entry fields into a entry record.
1959
1600
 
2077
1718
            entry_index += 1
2078
1719
        return block_index, entry_index, True, False
2079
1720
 
2080
 
    def _get_entry(self, tree_index, fileid_utf8=None, path_utf8=None,
2081
 
                   include_deleted=False):
 
1721
    def _get_entry(self, tree_index, fileid_utf8=None, path_utf8=None):
2082
1722
        """Get the dirstate entry for path in tree tree_index.
2083
1723
 
2084
1724
        If either file_id or path is supplied, it is used as the key to lookup.
2092
1732
            trees.
2093
1733
        :param fileid_utf8: A utf8 file_id to look up.
2094
1734
        :param path_utf8: An utf8 path to be looked up.
2095
 
        :param include_deleted: If True, and performing a lookup via
2096
 
            fileid_utf8 rather than path_utf8, return an entry for deleted
2097
 
            (absent) paths.
2098
1735
        :return: The dirstate entry tuple for path, or (None, None)
2099
1736
        """
2100
1737
        self._read_dirblocks_if_needed()
2101
1738
        if path_utf8 is not None:
2102
 
            if type(path_utf8) is not str:
2103
 
                raise errors.BzrError('path_utf8 is not a str: %s %r'
2104
 
                    % (type(path_utf8), path_utf8))
 
1739
            assert path_utf8.__class__ == str, ('path_utf8 is not a str: %s %s'
 
1740
                % (type(path_utf8), path_utf8))
2105
1741
            # path lookups are faster
2106
1742
            dirname, basename = osutils.split(path_utf8)
2107
1743
            block_index, entry_index, dir_present, file_present = \
2109
1745
            if not file_present:
2110
1746
                return None, None
2111
1747
            entry = self._dirblocks[block_index][1][entry_index]
2112
 
            if not (entry[0][2] and entry[1][tree_index][0] not in ('a', 'r')):
2113
 
                raise AssertionError('unversioned entry?')
 
1748
            assert entry[0][2] and entry[1][tree_index][0] not in ('a', 'r'), 'unversioned entry?!?!'
2114
1749
            if fileid_utf8:
2115
1750
                if entry[0][2] != fileid_utf8:
2116
1751
                    self._changes_aborted = True
2118
1753
                                          ' tree_index, file_id and path')
2119
1754
            return entry
2120
1755
        else:
2121
 
            possible_keys = self._get_id_index().get(fileid_utf8, ())
 
1756
            assert fileid_utf8 is not None
 
1757
            possible_keys = self._get_id_index().get(fileid_utf8, None)
2122
1758
            if not possible_keys:
2123
1759
                return None, None
2124
1760
            for key in possible_keys:
2135
1771
                entry_index, present = self._find_entry_index(key, block)
2136
1772
                if present:
2137
1773
                    entry = self._dirblocks[block_index][1][entry_index]
2138
 
                    # TODO: We might want to assert that entry[0][2] ==
2139
 
                    #       fileid_utf8.
2140
1774
                    if entry[1][tree_index][0] in 'fdlt':
2141
 
                        # this is the result we are looking for: the
 
1775
                        # this is the result we are looking for: the  
2142
1776
                        # real home of this file_id in this tree.
2143
1777
                        return entry
2144
1778
                    if entry[1][tree_index][0] == 'a':
2145
1779
                        # there is no home for this entry in this tree
2146
 
                        if include_deleted:
2147
 
                            return entry
2148
1780
                        return None, None
2149
 
                    if entry[1][tree_index][0] != 'r':
2150
 
                        raise AssertionError(
2151
 
                            "entry %r has invalid minikind %r for tree %r" \
2152
 
                            % (entry,
2153
 
                               entry[1][tree_index][0],
2154
 
                               tree_index))
 
1781
                    assert entry[1][tree_index][0] == 'r', \
 
1782
                        "entry %r has invalid minikind %r for tree %r" \
 
1783
                        % (entry,
 
1784
                           entry[1][tree_index][0],
 
1785
                           tree_index)
2155
1786
                    real_path = entry[1][tree_index][1]
2156
1787
                    return self._get_entry(tree_index, fileid_utf8=fileid_utf8,
2157
1788
                        path_utf8=real_path)
2158
1789
            return None, None
2159
1790
 
2160
1791
    @classmethod
2161
 
    def initialize(cls, path, sha1_provider=None):
 
1792
    def initialize(cls, path):
2162
1793
        """Create a new dirstate on path.
2163
1794
 
2164
1795
        The new dirstate will be an empty tree - that is it has no parents,
2165
1796
        and only a root node - which has id ROOT_ID.
2166
1797
 
2167
1798
        :param path: The name of the file for the dirstate.
2168
 
        :param sha1_provider: an object meeting the SHA1Provider interface.
2169
 
            If None, a DefaultSHA1Provider is used.
2170
1799
        :return: A write-locked DirState object.
2171
1800
        """
2172
1801
        # This constructs a new DirState object on a path, sets the _state_file
2174
1803
        # stock empty dirstate information - a root with ROOT_ID, no children,
2175
1804
        # and no parents. Finally it calls save() to ensure that this data will
2176
1805
        # persist.
2177
 
        if sha1_provider is None:
2178
 
            sha1_provider = DefaultSHA1Provider()
2179
 
        result = cls(path, sha1_provider)
 
1806
        result = cls(path)
2180
1807
        # root dir and root dir contents with no children.
2181
1808
        empty_tree_dirblocks = [('', []), ('', [])]
2182
1809
        # a new root directory, with a NULLSTAT.
2193
1820
            raise
2194
1821
        return result
2195
1822
 
2196
 
    @staticmethod
2197
 
    def _inv_entry_to_details(inv_entry):
 
1823
    def _inv_entry_to_details(self, inv_entry):
2198
1824
        """Convert an inventory entry (from a revision tree) to state details.
2199
1825
 
2200
1826
        :param inv_entry: An inventory entry whose sha1 and link targets can be
2205
1831
        kind = inv_entry.kind
2206
1832
        minikind = DirState._kind_to_minikind[kind]
2207
1833
        tree_data = inv_entry.revision
 
1834
        assert tree_data, 'empty revision for the inv_entry %s.' % \
 
1835
            inv_entry.file_id
2208
1836
        if kind == 'directory':
2209
1837
            fingerprint = ''
2210
1838
            size = 0
2211
1839
            executable = False
2212
1840
        elif kind == 'symlink':
2213
 
            if inv_entry.symlink_target is None:
2214
 
                fingerprint = ''
2215
 
            else:
2216
 
                fingerprint = inv_entry.symlink_target.encode('utf8')
 
1841
            fingerprint = inv_entry.symlink_target or ''
2217
1842
            size = 0
2218
1843
            executable = False
2219
1844
        elif kind == 'file':
2226
1851
            executable = False
2227
1852
        else:
2228
1853
            raise Exception("can't pack %s" % inv_entry)
2229
 
        return static_tuple.StaticTuple(minikind, fingerprint, size,
2230
 
                                        executable, tree_data)
 
1854
        return (minikind, fingerprint, size, executable, tree_data)
2231
1855
 
2232
1856
    def _iter_child_entries(self, tree_index, path_utf8):
2233
1857
        """Iterate over all the entries that are children of path_utf.
2234
1858
 
2235
 
        This only returns entries that are present (not in 'a', 'r') in
 
1859
        This only returns entries that are present (not in 'a', 'r') in 
2236
1860
        tree_index. tree_index data is not refreshed, so if tree 0 is used,
2237
1861
        results may differ from that obtained if paths were statted to
2238
1862
        determine what ones were directories.
2269
1893
                        else:
2270
1894
                            path = entry[0][1]
2271
1895
                        next_pending_dirs.append(path)
2272
 
 
 
1896
    
2273
1897
    def _iter_entries(self):
2274
1898
        """Iterate over all the entries in the dirstate.
2275
1899
 
2282
1906
                yield entry
2283
1907
 
2284
1908
    def _get_id_index(self):
2285
 
        """Get an id index of self._dirblocks.
2286
 
 
2287
 
        This maps from file_id => [(directory, name, file_id)] entries where
2288
 
        that file_id appears in one of the trees.
2289
 
        """
 
1909
        """Get an id index of self._dirblocks."""
2290
1910
        if self._id_index is None:
2291
1911
            id_index = {}
2292
1912
            for key, tree_details in self._iter_entries():
2293
 
                self._add_to_id_index(id_index, key)
 
1913
                id_index.setdefault(key[2], set()).add(key)
2294
1914
            self._id_index = id_index
2295
1915
        return self._id_index
2296
1916
 
2297
 
    def _add_to_id_index(self, id_index, entry_key):
2298
 
        """Add this entry to the _id_index mapping."""
2299
 
        # This code used to use a set for every entry in the id_index. However,
2300
 
        # it is *rare* to have more than one entry. So a set is a large
2301
 
        # overkill. And even when we do, we won't ever have more than the
2302
 
        # number of parent trees. Which is still a small number (rarely >2). As
2303
 
        # such, we use a simple tuple, and do our own uniqueness checks. While
2304
 
        # the 'in' check is O(N) since N is nicely bounded it shouldn't ever
2305
 
        # cause quadratic failure.
2306
 
        file_id = entry_key[2]
2307
 
        entry_key = static_tuple.StaticTuple.from_sequence(entry_key)
2308
 
        if file_id not in id_index:
2309
 
            id_index[file_id] = static_tuple.StaticTuple(entry_key,)
2310
 
        else:
2311
 
            entry_keys = id_index[file_id]
2312
 
            if entry_key not in entry_keys:
2313
 
                id_index[file_id] = entry_keys + (entry_key,)
2314
 
 
2315
 
    def _remove_from_id_index(self, id_index, entry_key):
2316
 
        """Remove this entry from the _id_index mapping.
2317
 
 
2318
 
        It is an programming error to call this when the entry_key is not
2319
 
        already present.
2320
 
        """
2321
 
        file_id = entry_key[2]
2322
 
        entry_keys = list(id_index[file_id])
2323
 
        entry_keys.remove(entry_key)
2324
 
        id_index[file_id] = static_tuple.StaticTuple.from_sequence(entry_keys)
2325
 
 
2326
1917
    def _get_output_lines(self, lines):
2327
1918
        """Format lines for final output.
2328
1919
 
2348
1939
        """The number of parent entries in each record row."""
2349
1940
        return len(self._parents) - len(self._ghosts)
2350
1941
 
2351
 
    @classmethod
2352
 
    def on_file(cls, path, sha1_provider=None, worth_saving_limit=0):
2353
 
        """Construct a DirState on the file at path "path".
 
1942
    @staticmethod
 
1943
    def on_file(path):
 
1944
        """Construct a DirState on the file at path path.
2354
1945
 
2355
 
        :param path: The path at which the dirstate file on disk should live.
2356
 
        :param sha1_provider: an object meeting the SHA1Provider interface.
2357
 
            If None, a DefaultSHA1Provider is used.
2358
 
        :param worth_saving_limit: when the exact number of hash changed
2359
 
            entries is known, only bother saving the dirstate if more than
2360
 
            this count of entries have changed. -1 means never save.
2361
1946
        :return: An unlocked DirState object, associated with the given path.
2362
1947
        """
2363
 
        if sha1_provider is None:
2364
 
            sha1_provider = DefaultSHA1Provider()
2365
 
        result = cls(path, sha1_provider,
2366
 
                     worth_saving_limit=worth_saving_limit)
 
1948
        result = DirState(path)
2367
1949
        return result
2368
1950
 
2369
1951
    def _read_dirblocks_if_needed(self):
2370
1952
        """Read in all the dirblocks from the file if they are not in memory.
2371
 
 
 
1953
        
2372
1954
        This populates self._dirblocks, and sets self._dirblock_state to
2373
1955
        IN_MEMORY_UNMODIFIED. It is not currently ready for incremental block
2374
1956
        loading.
2389
1971
        parent_line = self._state_file.readline()
2390
1972
        info = parent_line.split('\0')
2391
1973
        num_parents = int(info[0])
 
1974
        assert num_parents == len(info)-2, 'incorrect parent info line'
2392
1975
        self._parents = info[1:-1]
 
1976
 
2393
1977
        ghost_line = self._state_file.readline()
2394
1978
        info = ghost_line.split('\0')
2395
1979
        num_ghosts = int(info[1])
 
1980
        assert num_ghosts == len(info)-3, 'incorrect ghost info line'
2396
1981
        self._ghosts = info[2:-1]
2397
1982
        self._header_state = DirState.IN_MEMORY_UNMODIFIED
2398
1983
        self._end_of_header = self._state_file.tell()
2415
2000
        and their ids. Followed by a newline.
2416
2001
        """
2417
2002
        header = self._state_file.readline()
2418
 
        if header != DirState.HEADER_FORMAT_3:
2419
 
            raise errors.BzrError(
2420
 
                'invalid header line: %r' % (header,))
 
2003
        assert header == DirState.HEADER_FORMAT_3, \
 
2004
            'invalid header line: %r' % (header,)
2421
2005
        crc_line = self._state_file.readline()
2422
 
        if not crc_line.startswith('crc32: '):
2423
 
            raise errors.BzrError('missing crc32 checksum: %r' % crc_line)
 
2006
        assert crc_line.startswith('crc32: '), 'missing crc32 checksum'
2424
2007
        self.crc_expected = int(crc_line[len('crc32: '):-1])
2425
2008
        num_entries_line = self._state_file.readline()
2426
 
        if not num_entries_line.startswith('num_entries: '):
2427
 
            raise errors.BzrError('missing num_entries line')
 
2009
        assert num_entries_line.startswith('num_entries: '), 'missing num_entries line'
2428
2010
        self._num_entries = int(num_entries_line[len('num_entries: '):-1])
2429
2011
 
2430
 
    def sha1_from_stat(self, path, stat_result):
 
2012
    def sha1_from_stat(self, path, stat_result, _pack_stat=pack_stat):
2431
2013
        """Find a sha1 given a stat lookup."""
2432
 
        return self._get_packed_stat_index().get(pack_stat(stat_result), None)
 
2014
        return self._get_packed_stat_index().get(_pack_stat(stat_result), None)
2433
2015
 
2434
2016
    def _get_packed_stat_index(self):
2435
2017
        """Get a packed_stat index of self._dirblocks."""
2461
2043
            trace.mutter('Not saving DirState because '
2462
2044
                    '_changes_aborted is set.')
2463
2045
            return
2464
 
        # TODO: Since we now distinguish IN_MEMORY_MODIFIED from
2465
 
        #       IN_MEMORY_HASH_MODIFIED, we should only fail quietly if we fail
2466
 
        #       to save an IN_MEMORY_HASH_MODIFIED, and fail *noisily* if we
2467
 
        #       fail to save IN_MEMORY_MODIFIED
2468
 
        if not self._worth_saving():
2469
 
            return
 
2046
        if (self._header_state == DirState.IN_MEMORY_MODIFIED or
 
2047
            self._dirblock_state == DirState.IN_MEMORY_MODIFIED):
2470
2048
 
2471
 
        grabbed_write_lock = False
2472
 
        if self._lock_state != 'w':
2473
 
            grabbed_write_lock, new_lock = self._lock_token.temporary_write_lock()
2474
 
            # Switch over to the new lock, as the old one may be closed.
2475
 
            # TODO: jam 20070315 We should validate the disk file has
2476
 
            #       not changed contents, since temporary_write_lock may
2477
 
            #       not be an atomic operation.
2478
 
            self._lock_token = new_lock
2479
 
            self._state_file = new_lock.f
2480
 
            if not grabbed_write_lock:
2481
 
                # We couldn't grab a write lock, so we switch back to a read one
2482
 
                return
2483
 
        try:
2484
 
            lines = self.get_lines()
2485
 
            self._state_file.seek(0)
2486
 
            self._state_file.writelines(lines)
2487
 
            self._state_file.truncate()
2488
 
            self._state_file.flush()
2489
 
            self._maybe_fdatasync()
2490
 
            self._mark_unmodified()
2491
 
        finally:
2492
 
            if grabbed_write_lock:
2493
 
                self._lock_token = self._lock_token.restore_read_lock()
2494
 
                self._state_file = self._lock_token.f
 
2049
            grabbed_write_lock = False
 
2050
            if self._lock_state != 'w':
 
2051
                grabbed_write_lock, new_lock = self._lock_token.temporary_write_lock()
 
2052
                # Switch over to the new lock, as the old one may be closed.
2495
2053
                # TODO: jam 20070315 We should validate the disk file has
2496
 
                #       not changed contents. Since restore_read_lock may
2497
 
                #       not be an atomic operation.                
2498
 
 
2499
 
    def _maybe_fdatasync(self):
2500
 
        """Flush to disk if possible and if not configured off."""
2501
 
        if self._config_stack.get('dirstate.fdatasync'):
2502
 
            osutils.fdatasync(self._state_file.fileno())
2503
 
 
2504
 
    def _worth_saving(self):
2505
 
        """Is it worth saving the dirstate or not?"""
2506
 
        if (self._header_state == DirState.IN_MEMORY_MODIFIED
2507
 
            or self._dirblock_state == DirState.IN_MEMORY_MODIFIED):
2508
 
            return True
2509
 
        if self._dirblock_state == DirState.IN_MEMORY_HASH_MODIFIED:
2510
 
            if self._worth_saving_limit == -1:
2511
 
                # We never save hash changes when the limit is -1
2512
 
                return False
2513
 
            # If we're using smart saving and only a small number of
2514
 
            # entries have changed their hash, don't bother saving. John has
2515
 
            # suggested using a heuristic here based on the size of the
2516
 
            # changed files and/or tree. For now, we go with a configurable
2517
 
            # number of changes, keeping the calculation time
2518
 
            # as low overhead as possible. (This also keeps all existing
2519
 
            # tests passing as the default is 0, i.e. always save.)
2520
 
            if len(self._known_hash_changes) >= self._worth_saving_limit:
2521
 
                return True
2522
 
        return False
 
2054
                #       not changed contents. Since temporary_write_lock may
 
2055
                #       not be an atomic operation.
 
2056
                self._lock_token = new_lock
 
2057
                self._state_file = new_lock.f
 
2058
                if not grabbed_write_lock:
 
2059
                    # We couldn't grab a write lock, so we switch back to a read one
 
2060
                    return
 
2061
            try:
 
2062
                self._state_file.seek(0)
 
2063
                self._state_file.writelines(self.get_lines())
 
2064
                self._state_file.truncate()
 
2065
                self._state_file.flush()
 
2066
                self._header_state = DirState.IN_MEMORY_UNMODIFIED
 
2067
                self._dirblock_state = DirState.IN_MEMORY_UNMODIFIED
 
2068
            finally:
 
2069
                if grabbed_write_lock:
 
2070
                    self._lock_token = self._lock_token.restore_read_lock()
 
2071
                    self._state_file = self._lock_token.f
 
2072
                    # TODO: jam 20070315 We should validate the disk file has
 
2073
                    #       not changed contents. Since restore_read_lock may
 
2074
                    #       not be an atomic operation.
2523
2075
 
2524
2076
    def _set_data(self, parent_ids, dirblocks):
2525
2077
        """Set the full dirstate data in memory.
2529
2081
 
2530
2082
        :param parent_ids: A list of parent tree revision ids.
2531
2083
        :param dirblocks: A list containing one tuple for each directory in the
2532
 
            tree. Each tuple contains the directory path and a list of entries
 
2084
            tree. Each tuple contains the directory path and a list of entries 
2533
2085
            found in that directory.
2534
2086
        """
2535
2087
        # our memory copy is now authoritative.
2536
2088
        self._dirblocks = dirblocks
2537
 
        self._mark_modified(header_modified=True)
 
2089
        self._header_state = DirState.IN_MEMORY_MODIFIED
 
2090
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
2538
2091
        self._parents = list(parent_ids)
2539
2092
        self._id_index = None
2540
2093
        self._packed_stat_index = None
2547
2100
        :param new_id: The new id to assign to the path. This must be a utf8
2548
2101
            file id (not unicode, and not None).
2549
2102
        """
 
2103
        assert new_id.__class__ == str, \
 
2104
            "path_id %r is not a plain string" % (new_id,)
2550
2105
        self._read_dirblocks_if_needed()
2551
2106
        if len(path):
2552
2107
            # TODO: logic not written
2560
2115
        self._make_absent(entry)
2561
2116
        self.update_minimal(('', '', new_id), 'd',
2562
2117
            path_utf8='', packed_stat=entry[1][0][4])
2563
 
        self._mark_modified()
2564
 
        # XXX: This was added by Ian, we need to make sure there
2565
 
        #      are tests for it, because it isn't in bzr.dev TRUNK
2566
 
        #      It looks like the only place it is called is in setting the root
2567
 
        #      id of the tree. So probably we never had an _id_index when we
2568
 
        #      don't even have a root yet.
 
2118
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
2569
2119
        if self._id_index is not None:
2570
 
            self._add_to_id_index(self._id_index, entry[0])
 
2120
            self._id_index.setdefault(new_id, set()).add(entry[0])
2571
2121
 
2572
2122
    def set_parent_trees(self, trees, ghosts):
2573
2123
        """Set the parent trees for the dirstate.
2574
2124
 
2575
2125
        :param trees: A list of revision_id, tree tuples. tree must be provided
2576
 
            even if the revision_id refers to a ghost: supply an empty tree in
 
2126
            even if the revision_id refers to a ghost: supply an empty tree in 
2577
2127
            this case.
2578
2128
        :param ghosts: A list of the revision_ids that are ghosts at the time
2579
2129
            of setting.
2580
 
        """
2581
 
        # TODO: generate a list of parent indexes to preserve to save
 
2130
        """ 
 
2131
        # TODO: generate a list of parent indexes to preserve to save 
2582
2132
        # processing specific parent trees. In the common case one tree will
2583
2133
        # be preserved - the left most parent.
2584
2134
        # TODO: if the parent tree is a dirstate, we might want to walk them
2589
2139
        # map and then walk the new parent trees only, mapping them into the
2590
2140
        # dirstate. Walk the dirstate at the same time to remove unreferenced
2591
2141
        # entries.
2592
 
        # for now:
2593
 
        # sketch: loop over all entries in the dirstate, cherry picking
 
2142
        # for now: 
 
2143
        # sketch: loop over all entries in the dirstate, cherry picking 
2594
2144
        # entries from the parent trees, if they are not ghost trees.
2595
2145
        # after we finish walking the dirstate, all entries not in the dirstate
2596
2146
        # are deletes, so we want to append them to the end as per the design
2601
2151
        #   links. We dont't trivially use the inventory from other trees
2602
2152
        #   because this leads to either double touching, or to accessing
2603
2153
        #   missing keys,
2604
 
        # - find other keys containing a path
2605
 
        # We accumulate each entry via this dictionary, including the root
 
2154
        # - find other keys containing a path 
 
2155
        # We accumulate each entry via this dictionary, including the root 
2606
2156
        by_path = {}
2607
2157
        id_index = {}
2608
2158
        # we could do parallel iterators, but because file id data may be
2612
2162
        # parent, but for now the common cases are adding a new parent (merge),
2613
2163
        # and replacing completely (commit), and commit is more common: so
2614
2164
        # optimise merge later.
2615
 
 
 
2165
        
2616
2166
        # ---- start generation of full tree mapping data
2617
2167
        # what trees should we use?
2618
2168
        parent_trees = [tree for rev_id, tree in trees if rev_id not in ghosts]
2619
 
        # how many trees do we end up with
 
2169
        # how many trees do we end up with 
2620
2170
        parent_count = len(parent_trees)
2621
 
        st = static_tuple.StaticTuple
2622
2171
 
2623
2172
        # one: the current tree
2624
2173
        for entry in self._iter_entries():
2627
2176
                continue
2628
2177
            by_path[entry[0]] = [entry[1][0]] + \
2629
2178
                [DirState.NULL_PARENT_DETAILS] * parent_count
2630
 
            # TODO: Possibly inline this, since we know it isn't present yet
2631
 
            #       id_index[entry[0][2]] = (entry[0],)
2632
 
            self._add_to_id_index(id_index, entry[0])
2633
 
 
 
2179
            id_index[entry[0][2]] = set([entry[0]])
 
2180
        
2634
2181
        # now the parent trees:
2635
2182
        for tree_index, tree in enumerate(parent_trees):
2636
2183
            # the index is off by one, adjust it.
2641
2188
            # the suffix is from tree_index+1:parent_count+1.
2642
2189
            new_location_suffix = [DirState.NULL_PARENT_DETAILS] * (parent_count - tree_index)
2643
2190
            # now stitch in all the entries from this tree
2644
 
            last_dirname = None
2645
 
            for path, entry in tree.iter_entries_by_dir():
 
2191
            for path, entry in tree.inventory.iter_entries_by_dir():
2646
2192
                # here we process each trees details for each item in the tree.
2647
2193
                # we first update any existing entries for the id at other paths,
2648
2194
                # then we either create or update the entry for the id at the
2651
2197
                # avoid checking all known paths for the id when generating a
2652
2198
                # new entry at this path: by adding the id->path mapping last,
2653
2199
                # all the mappings are valid and have correct relocation
2654
 
                # records where needed.
 
2200
                # records where needed. 
2655
2201
                file_id = entry.file_id
2656
2202
                path_utf8 = path.encode('utf8')
2657
2203
                dirname, basename = osutils.split(path_utf8)
2658
 
                if dirname == last_dirname:
2659
 
                    # Try to re-use objects as much as possible
2660
 
                    dirname = last_dirname
2661
 
                else:
2662
 
                    last_dirname = dirname
2663
 
                new_entry_key = st(dirname, basename, file_id)
 
2204
                new_entry_key = (dirname, basename, file_id)
2664
2205
                # tree index consistency: All other paths for this id in this tree
2665
2206
                # index must point to the correct path.
2666
 
                entry_keys = id_index.get(file_id, ())
2667
 
                for entry_key in entry_keys:
 
2207
                for entry_key in id_index.setdefault(file_id, set()):
2668
2208
                    # TODO:PROFILING: It might be faster to just update
2669
2209
                    # rather than checking if we need to, and then overwrite
2670
2210
                    # the one we are located at.
2673
2213
                        # other trees, so put absent pointers there
2674
2214
                        # This is the vertical axis in the matrix, all pointing
2675
2215
                        # to the real path.
2676
 
                        by_path[entry_key][tree_index] = st('r', path_utf8, 0,
2677
 
                                                            False, '')
2678
 
                # by path consistency: Insert into an existing path record
2679
 
                # (trivial), or add a new one with relocation pointers for the
2680
 
                # other tree indexes.
2681
 
                if new_entry_key in entry_keys:
2682
 
                    # there is already an entry where this data belongs, just
2683
 
                    # insert it.
 
2216
                        by_path[entry_key][tree_index] = ('r', path_utf8, 0, False, '')
 
2217
                # by path consistency: Insert into an existing path record (trivial), or 
 
2218
                # add a new one with relocation pointers for the other tree indexes.
 
2219
                if new_entry_key in id_index[file_id]:
 
2220
                    # there is already an entry where this data belongs, just insert it.
2684
2221
                    by_path[new_entry_key][tree_index] = \
2685
2222
                        self._inv_entry_to_details(entry)
2686
2223
                else:
2690
2227
                    new_details = []
2691
2228
                    for lookup_index in xrange(tree_index):
2692
2229
                        # boundary case: this is the first occurence of file_id
2693
 
                        # so there are no id_indexes, possibly take this out of
 
2230
                        # so there are no id_indexs, possibly take this out of
2694
2231
                        # the loop?
2695
 
                        if not len(entry_keys):
 
2232
                        if not len(id_index[file_id]):
2696
2233
                            new_details.append(DirState.NULL_PARENT_DETAILS)
2697
2234
                        else:
2698
2235
                            # grab any one entry, use it to find the right path.
2699
 
                            a_key = iter(entry_keys).next()
 
2236
                            # TODO: optimise this to reduce memory use in highly 
 
2237
                            # fragmented situations by reusing the relocation
 
2238
                            # records.
 
2239
                            a_key = iter(id_index[file_id]).next()
2700
2240
                            if by_path[a_key][lookup_index][0] in ('r', 'a'):
2701
 
                                # its a pointer or missing statement, use it as
2702
 
                                # is.
 
2241
                                # its a pointer or missing statement, use it as is.
2703
2242
                                new_details.append(by_path[a_key][lookup_index])
2704
2243
                            else:
2705
2244
                                # we have the right key, make a pointer to it.
2706
2245
                                real_path = ('/'.join(a_key[0:2])).strip('/')
2707
 
                                new_details.append(st('r', real_path, 0, False,
2708
 
                                                      ''))
 
2246
                                new_details.append(('r', real_path, 0, False, ''))
2709
2247
                    new_details.append(self._inv_entry_to_details(entry))
2710
2248
                    new_details.extend(new_location_suffix)
2711
2249
                    by_path[new_entry_key] = new_details
2712
 
                    self._add_to_id_index(id_index, new_entry_key)
 
2250
                    id_index[file_id].add(new_entry_key)
2713
2251
        # --- end generation of full tree mappings
2714
2252
 
2715
2253
        # sort and output all the entries
2717
2255
        self._entries_to_current_state(new_entries)
2718
2256
        self._parents = [rev_id for rev_id, tree in trees]
2719
2257
        self._ghosts = list(ghosts)
2720
 
        self._mark_modified(header_modified=True)
 
2258
        self._header_state = DirState.IN_MEMORY_MODIFIED
 
2259
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
2721
2260
        self._id_index = id_index
2722
2261
 
2723
2262
    def _sort_entries(self, entry_list):
2727
2266
        try to keep everything in sorted blocks all the time, but sometimes
2728
2267
        it's easier to sort after the fact.
2729
2268
        """
2730
 
        # When sorting, we usually have 10x more entries than directories. (69k
2731
 
        # total entries, 4k directories). So cache the results of splitting.
2732
 
        # Saving time and objects. Also, use StaticTuple to avoid putting all
2733
 
        # of these object into python's garbage collector.
2734
 
        split_dirs = {}
2735
 
        def _key(entry, _split_dirs=split_dirs, _st=static_tuple.StaticTuple):
 
2269
        def _key(entry):
2736
2270
            # sort by: directory parts, file name, file id
2737
 
            dirpath, fname, file_id = entry[0]
2738
 
            try:
2739
 
                split = _split_dirs[dirpath]
2740
 
            except KeyError:
2741
 
                split = _st.from_sequence(dirpath.split('/'))
2742
 
                _split_dirs[dirpath] = split
2743
 
            return _st(split, fname, file_id)
 
2271
            return entry[0][0].split('/'), entry[0][1], entry[0][2]
2744
2272
        return sorted(entry_list, key=_key)
2745
2273
 
2746
2274
    def set_state_from_inventory(self, new_inv):
2747
 
        """Set new_inv as the current state.
 
2275
        """Set new_inv as the current state. 
2748
2276
 
2749
2277
        This API is called by tree transform, and will usually occur with
2750
2278
        existing parent trees.
2754
2282
        if 'evil' in debug.debug_flags:
2755
2283
            trace.mutter_callsite(1,
2756
2284
                "set_state_from_inventory called; please mutate the tree instead")
2757
 
        tracing = 'dirstate' in debug.debug_flags
2758
 
        if tracing:
2759
 
            trace.mutter("set_state_from_inventory trace:")
2760
2285
        self._read_dirblocks_if_needed()
2761
2286
        # sketch:
2762
 
        # Two iterators: current data and new data, both in dirblock order.
 
2287
        # Two iterators: current data and new data, both in dirblock order. 
2763
2288
        # We zip them together, which tells about entries that are new in the
2764
2289
        # inventory, or removed in the inventory, or present in both and
2765
 
        # possibly changed.
 
2290
        # possibly changed.  
2766
2291
        #
2767
2292
        # You might think we could just synthesize a new dirstate directly
2768
2293
        # since we're processing it in the right order.  However, we need to
2771
2296
        new_iterator = new_inv.iter_entries_by_dir()
2772
2297
        # we will be modifying the dirstate, so we need a stable iterator. In
2773
2298
        # future we might write one, for now we just clone the state into a
2774
 
        # list using a copy so that we see every original item and don't have
2775
 
        # to adjust the position when items are inserted or deleted in the
2776
 
        # underlying dirstate.
 
2299
        # list - which is a shallow copy.
2777
2300
        old_iterator = iter(list(self._iter_entries()))
2778
2301
        # both must have roots so this is safe:
2779
2302
        current_new = new_iterator.next()
2813
2336
            # we make both end conditions explicit
2814
2337
            if not current_old:
2815
2338
                # old is finished: insert current_new into the state.
2816
 
                if tracing:
2817
 
                    trace.mutter("Appending from new '%s'.",
2818
 
                        new_path_utf8.decode('utf8'))
2819
2339
                self.update_minimal(new_entry_key, current_new_minikind,
2820
2340
                    executable=current_new[1].executable,
2821
 
                    path_utf8=new_path_utf8, fingerprint=fingerprint,
2822
 
                    fullscan=True)
 
2341
                    path_utf8=new_path_utf8, fingerprint=fingerprint)
2823
2342
                current_new = advance(new_iterator)
2824
2343
            elif not current_new:
2825
2344
                # new is finished
2826
 
                if tracing:
2827
 
                    trace.mutter("Truncating from old '%s/%s'.",
2828
 
                        current_old[0][0].decode('utf8'),
2829
 
                        current_old[0][1].decode('utf8'))
2830
2345
                self._make_absent(current_old)
2831
2346
                current_old = advance(old_iterator)
2832
2347
            elif new_entry_key == current_old[0]:
2839
2354
                # kind has changed.
2840
2355
                if (current_old[1][0][3] != current_new[1].executable or
2841
2356
                    current_old[1][0][0] != current_new_minikind):
2842
 
                    if tracing:
2843
 
                        trace.mutter("Updating in-place change '%s'.",
2844
 
                            new_path_utf8.decode('utf8'))
2845
2357
                    self.update_minimal(current_old[0], current_new_minikind,
2846
2358
                        executable=current_new[1].executable,
2847
 
                        path_utf8=new_path_utf8, fingerprint=fingerprint,
2848
 
                        fullscan=True)
 
2359
                        path_utf8=new_path_utf8, fingerprint=fingerprint)
2849
2360
                # both sides are dealt with, move on
2850
2361
                current_old = advance(old_iterator)
2851
2362
                current_new = advance(new_iterator)
2854
2365
                      and new_entry_key[1:] < current_old[0][1:])):
2855
2366
                # new comes before:
2856
2367
                # add a entry for this and advance new
2857
 
                if tracing:
2858
 
                    trace.mutter("Inserting from new '%s'.",
2859
 
                        new_path_utf8.decode('utf8'))
2860
2368
                self.update_minimal(new_entry_key, current_new_minikind,
2861
2369
                    executable=current_new[1].executable,
2862
 
                    path_utf8=new_path_utf8, fingerprint=fingerprint,
2863
 
                    fullscan=True)
 
2370
                    path_utf8=new_path_utf8, fingerprint=fingerprint)
2864
2371
                current_new = advance(new_iterator)
2865
2372
            else:
2866
2373
                # we've advanced past the place where the old key would be,
2867
2374
                # without seeing it in the new list.  so it must be gone.
2868
 
                if tracing:
2869
 
                    trace.mutter("Deleting from old '%s/%s'.",
2870
 
                        current_old[0][0].decode('utf8'),
2871
 
                        current_old[0][1].decode('utf8'))
2872
2375
                self._make_absent(current_old)
2873
2376
                current_old = advance(old_iterator)
2874
 
        self._mark_modified()
 
2377
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
2875
2378
        self._id_index = None
2876
2379
        self._packed_stat_index = None
2877
 
        if tracing:
2878
 
            trace.mutter("set_state_from_inventory complete.")
2879
 
 
2880
 
    def set_state_from_scratch(self, working_inv, parent_trees, parent_ghosts):
2881
 
        """Wipe the currently stored state and set it to something new.
2882
 
 
2883
 
        This is a hard-reset for the data we are working with.
2884
 
        """
2885
 
        # Technically, we really want a write lock, but until we write, we
2886
 
        # don't really need it.
2887
 
        self._requires_lock()
2888
 
        # root dir and root dir contents with no children. We have to have a
2889
 
        # root for set_state_from_inventory to work correctly.
2890
 
        empty_root = (('', '', inventory.ROOT_ID),
2891
 
                      [('d', '', 0, False, DirState.NULLSTAT)])
2892
 
        empty_tree_dirblocks = [('', [empty_root]), ('', [])]
2893
 
        self._set_data([], empty_tree_dirblocks)
2894
 
        self.set_state_from_inventory(working_inv)
2895
 
        self.set_parent_trees(parent_trees, parent_ghosts)
2896
2380
 
2897
2381
    def _make_absent(self, current_old):
2898
2382
        """Mark current_old - an entry - as absent for tree 0.
2919
2403
            # Remove it, its meaningless.
2920
2404
            block = self._find_block(current_old[0])
2921
2405
            entry_index, present = self._find_entry_index(current_old[0], block[1])
2922
 
            if not present:
2923
 
                raise AssertionError('could not find entry for %s' % (current_old,))
 
2406
            assert present, 'could not find entry for %s' % (current_old,)
2924
2407
            block[1].pop(entry_index)
2925
2408
            # if we have an id_index in use, remove this key from it for this id.
2926
2409
            if self._id_index is not None:
2927
 
                self._remove_from_id_index(self._id_index, current_old[0])
 
2410
                self._id_index[current_old[0][2]].remove(current_old[0])
2928
2411
        # update all remaining keys for this id to record it as absent. The
2929
2412
        # existing details may either be the record we are marking as deleted
2930
2413
        # (if there were other trees with the id present at this path), or may
2932
2415
        for update_key in all_remaining_keys:
2933
2416
            update_block_index, present = \
2934
2417
                self._find_block_index_from_key(update_key)
2935
 
            if not present:
2936
 
                raise AssertionError('could not find block for %s' % (update_key,))
 
2418
            assert present, 'could not find block for %s' % (update_key,)
2937
2419
            update_entry_index, present = \
2938
2420
                self._find_entry_index(update_key, self._dirblocks[update_block_index][1])
2939
 
            if not present:
2940
 
                raise AssertionError('could not find entry for %s' % (update_key,))
 
2421
            assert present, 'could not find entry for %s' % (update_key,)
2941
2422
            update_tree_details = self._dirblocks[update_block_index][1][update_entry_index][1]
2942
2423
            # it must not be absent at the moment
2943
 
            if update_tree_details[0][0] == 'a': # absent
2944
 
                raise AssertionError('bad row %r' % (update_tree_details,))
 
2424
            assert update_tree_details[0][0] != 'a' # absent
2945
2425
            update_tree_details[0] = DirState.NULL_PARENT_DETAILS
2946
 
        self._mark_modified()
 
2426
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
2947
2427
        return last_reference
2948
2428
 
2949
2429
    def update_minimal(self, key, minikind, executable=False, fingerprint='',
2950
 
        packed_stat=None, size=0, path_utf8=None, fullscan=False):
 
2430
                       packed_stat=None, size=0, path_utf8=None):
2951
2431
        """Update an entry to the state in tree 0.
2952
2432
 
2953
2433
        This will either create a new entry at 'key' or update an existing one.
2958
2438
        :param minikind: The type for the entry ('f' == 'file', 'd' ==
2959
2439
                'directory'), etc.
2960
2440
        :param executable: Should the executable bit be set?
2961
 
        :param fingerprint: Simple fingerprint for new entry: canonical-form
2962
 
            sha1 for files, referenced revision id for subtrees, etc.
 
2441
        :param fingerprint: Simple fingerprint for new entry: sha1 for files, 
 
2442
            referenced revision id for subtrees, etc.
2963
2443
        :param packed_stat: Packed stat value for new entry.
2964
2444
        :param size: Size information for new entry
2965
2445
        :param path_utf8: key[0] + '/' + key[1], just passed in to avoid doing
2966
2446
                extra computation.
2967
 
        :param fullscan: If True then a complete scan of the dirstate is being
2968
 
            done and checking for duplicate rows should not be done. This
2969
 
            should only be set by set_state_from_inventory and similar methods.
2970
2447
 
2971
2448
        If packed_stat and fingerprint are not given, they're invalidated in
2972
2449
        the entry.
2981
2458
        new_details = (minikind, fingerprint, size, executable, packed_stat)
2982
2459
        id_index = self._get_id_index()
2983
2460
        if not present:
2984
 
            # New record. Check there isn't a entry at this path already.
2985
 
            if not fullscan:
2986
 
                low_index, _ = self._find_entry_index(key[0:2] + ('',), block)
2987
 
                while low_index < len(block):
2988
 
                    entry = block[low_index]
2989
 
                    if entry[0][0:2] == key[0:2]:
2990
 
                        if entry[1][0][0] not in 'ar':
2991
 
                            # This entry has the same path (but a different id) as
2992
 
                            # the new entry we're adding, and is present in ths
2993
 
                            # tree.
2994
 
                            self._raise_invalid(
2995
 
                                ("%s/%s" % key[0:2]).decode('utf8'), key[2],
2996
 
                                "Attempt to add item at path already occupied by "
2997
 
                                "id %r" % entry[0][2])
2998
 
                        low_index += 1
2999
 
                    else:
3000
 
                        break
3001
2461
            # new entry, synthesis cross reference here,
3002
 
            existing_keys = id_index.get(key[2], ())
 
2462
            existing_keys = id_index.setdefault(key[2], set())
3003
2463
            if not existing_keys:
3004
2464
                # not currently in the state, simplest case
3005
2465
                new_entry = key, [new_details] + self._empty_parent_info()
3008
2468
                # grab one of them and use it to generate parent
3009
2469
                # relocation/absent entries.
3010
2470
                new_entry = key, [new_details]
3011
 
                # existing_keys can be changed as we iterate.
3012
 
                for other_key in tuple(existing_keys):
 
2471
                for other_key in existing_keys:
3013
2472
                    # change the record at other to be a pointer to this new
3014
2473
                    # record. The loop looks similar to the change to
3015
2474
                    # relocations when updating an existing record but its not:
3016
2475
                    # the test for existing kinds is different: this can be
3017
2476
                    # factored out to a helper though.
3018
 
                    other_block_index, present = self._find_block_index_from_key(
3019
 
                        other_key)
3020
 
                    if not present:
3021
 
                        raise AssertionError('could not find block for %s' % (
3022
 
                            other_key,))
3023
 
                    other_block = self._dirblocks[other_block_index][1]
3024
 
                    other_entry_index, present = self._find_entry_index(
3025
 
                        other_key, other_block)
3026
 
                    if not present:
3027
 
                        raise AssertionError(
3028
 
                            'update_minimal: could not find other entry for %s'
3029
 
                            % (other_key,))
3030
 
                    if path_utf8 is None:
3031
 
                        raise AssertionError('no path')
3032
 
                    # Turn this other location into a reference to the new
3033
 
                    # location. This also updates the aliased iterator
3034
 
                    # (current_old in set_state_from_inventory) so that the old
3035
 
                    # entry, if not already examined, is skipped over by that
3036
 
                    # loop.
3037
 
                    other_entry = other_block[other_entry_index]
3038
 
                    other_entry[1][0] = ('r', path_utf8, 0, False, '')
3039
 
                    if self._maybe_remove_row(other_block, other_entry_index,
3040
 
                                              id_index):
3041
 
                        # If the row holding this was removed, we need to
3042
 
                        # recompute where this entry goes
3043
 
                        entry_index, _ = self._find_entry_index(key, block)
 
2477
                    other_block_index, present = self._find_block_index_from_key(other_key)
 
2478
                    assert present, 'could not find block for %s' % (other_key,)
 
2479
                    other_entry_index, present = self._find_entry_index(other_key,
 
2480
                                            self._dirblocks[other_block_index][1])
 
2481
                    assert present, 'could not find entry for %s' % (other_key,)
 
2482
                    assert path_utf8 is not None
 
2483
                    self._dirblocks[other_block_index][1][other_entry_index][1][0] = \
 
2484
                        ('r', path_utf8, 0, False, '')
3044
2485
 
3045
 
                # This loop:
3046
 
                # adds a tuple to the new details for each column
3047
 
                #  - either by copying an existing relocation pointer inside that column
3048
 
                #  - or by creating a new pointer to the right row inside that column
3049
2486
                num_present_parents = self._num_present_parents()
3050
 
                if num_present_parents:
3051
 
                    # TODO: This re-evaluates the existing_keys set, do we need
3052
 
                    #       to do that ourselves?
3053
 
                    other_key = list(existing_keys)[0]
3054
2487
                for lookup_index in xrange(1, num_present_parents + 1):
3055
2488
                    # grab any one entry, use it to find the right path.
3056
 
                    # TODO: optimise this to reduce memory use in highly
 
2489
                    # TODO: optimise this to reduce memory use in highly 
3057
2490
                    # fragmented situations by reusing the relocation
3058
2491
                    # records.
3059
2492
                    update_block_index, present = \
3060
2493
                        self._find_block_index_from_key(other_key)
3061
 
                    if not present:
3062
 
                        raise AssertionError('could not find block for %s' % (other_key,))
 
2494
                    assert present, 'could not find block for %s' % (other_key,)
3063
2495
                    update_entry_index, present = \
3064
2496
                        self._find_entry_index(other_key, self._dirblocks[update_block_index][1])
3065
 
                    if not present:
3066
 
                        raise AssertionError('update_minimal: could not find entry for %s' % (other_key,))
 
2497
                    assert present, 'could not find entry for %s' % (other_key,)
3067
2498
                    update_details = self._dirblocks[update_block_index][1][update_entry_index][1][lookup_index]
3068
2499
                    if update_details[0] in 'ar': # relocated, absent
3069
2500
                        # its a pointer or absent in lookup_index's tree, use
3074
2505
                        pointer_path = osutils.pathjoin(*other_key[0:2])
3075
2506
                        new_entry[1].append(('r', pointer_path, 0, False, ''))
3076
2507
            block.insert(entry_index, new_entry)
3077
 
            self._add_to_id_index(id_index, key)
 
2508
            existing_keys.add(key)
3078
2509
        else:
3079
 
            # Does the new state matter?
 
2510
            # Does the new state matter? 
3080
2511
            block[entry_index][1][0] = new_details
3081
2512
            # parents cannot be affected by what we do.
3082
 
            # other occurences of this id can be found
 
2513
            # other occurences of this id can be found 
3083
2514
            # from the id index.
3084
2515
            # ---
3085
2516
            # tree index consistency: All other paths for this id in this tree
3087
2518
            # we may have passed entries in the state with this file id already
3088
2519
            # that were absent - where parent entries are - and they need to be
3089
2520
            # converted to relocated.
3090
 
            if path_utf8 is None:
3091
 
                raise AssertionError('no path')
3092
 
            existing_keys = id_index.get(key[2], ())
3093
 
            if key not in existing_keys:
3094
 
                raise AssertionError('We found the entry in the blocks, but'
3095
 
                    ' the key is not in the id_index.'
3096
 
                    ' key: %s, existing_keys: %s' % (key, existing_keys))
3097
 
            for entry_key in existing_keys:
 
2521
            assert path_utf8 is not None
 
2522
            for entry_key in id_index.setdefault(key[2], set()):
3098
2523
                # TODO:PROFILING: It might be faster to just update
3099
2524
                # rather than checking if we need to, and then overwrite
3100
2525
                # the one we are located at.
3104
2529
                    # This is the vertical axis in the matrix, all pointing
3105
2530
                    # to the real path.
3106
2531
                    block_index, present = self._find_block_index_from_key(entry_key)
3107
 
                    if not present:
3108
 
                        raise AssertionError('not present: %r', entry_key)
 
2532
                    assert present
3109
2533
                    entry_index, present = self._find_entry_index(entry_key, self._dirblocks[block_index][1])
3110
 
                    if not present:
3111
 
                        raise AssertionError('not present: %r', entry_key)
 
2534
                    assert present
3112
2535
                    self._dirblocks[block_index][1][entry_index][1][0] = \
3113
2536
                        ('r', path_utf8, 0, False, '')
3114
2537
        # add a containing dirblock if needed.
3118
2541
            if not present:
3119
2542
                self._dirblocks.insert(block_index, (subdir_key[0], []))
3120
2543
 
3121
 
        self._mark_modified()
3122
 
 
3123
 
    def _maybe_remove_row(self, block, index, id_index):
3124
 
        """Remove index if it is absent or relocated across the row.
3125
 
        
3126
 
        id_index is updated accordingly.
3127
 
        :return: True if we removed the row, False otherwise
3128
 
        """
3129
 
        present_in_row = False
3130
 
        entry = block[index]
3131
 
        for column in entry[1]:
3132
 
            if column[0] not in 'ar':
3133
 
                present_in_row = True
3134
 
                break
3135
 
        if not present_in_row:
3136
 
            block.pop(index)
3137
 
            self._remove_from_id_index(id_index, entry[0])
3138
 
            return True
3139
 
        return False
 
2544
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
3140
2545
 
3141
2546
    def _validate(self):
3142
2547
        """Check that invariants on the dirblock are correct.
3143
2548
 
3144
 
        This can be useful in debugging; it shouldn't be necessary in
 
2549
        This can be useful in debugging; it shouldn't be necessary in 
3145
2550
        normal code.
3146
2551
 
3147
2552
        This must be called with a lock held.
3163
2568
            if not self._dirblocks[0][0] == '':
3164
2569
                raise AssertionError(
3165
2570
                    "dirblocks don't start with root block:\n" + \
3166
 
                    pformat(self._dirblocks))
 
2571
                    pformat(dirblocks))
3167
2572
        if len(self._dirblocks) > 1:
3168
2573
            if not self._dirblocks[1][0] == '':
3169
2574
                raise AssertionError(
3170
2575
                    "dirblocks missing root directory:\n" + \
3171
 
                    pformat(self._dirblocks))
 
2576
                    pformat(dirblocks))
3172
2577
        # the dirblocks are sorted by their path components, name, and dir id
3173
2578
        dir_names = [d[0].split('/')
3174
2579
                for d in self._dirblocks[1:]]
3216
2621
        # For each file id, for each tree: either
3217
2622
        # the file id is not present at all; all rows with that id in the
3218
2623
        # key have it marked as 'absent'
3219
 
        # OR the file id is present under exactly one name; any other entries
 
2624
        # OR the file id is present under exactly one name; any other entries 
3220
2625
        # that mention that id point to the correct name.
3221
2626
        #
3222
2627
        # We check this with a dict per tree pointing either to the present
3269
2674
                        # absent; should not occur anywhere else
3270
2675
                        this_tree_map[file_id] = None, this_path
3271
2676
                    elif minikind == 'r':
3272
 
                        # relocation, must occur at expected location
 
2677
                        # relocation, must occur at expected location 
3273
2678
                        this_tree_map[file_id] = tree_state[1], this_path
3274
2679
                    else:
3275
2680
                        this_tree_map[file_id] = this_path, this_path
3277
2682
            if absent_positions == tree_count:
3278
2683
                raise AssertionError(
3279
2684
                    "entry %r has no data for any tree." % (entry,))
3280
 
        if self._id_index is not None:
3281
 
            for file_id, entry_keys in self._id_index.iteritems():
3282
 
                for entry_key in entry_keys:
3283
 
                    if entry_key[2] != file_id:
3284
 
                        raise AssertionError(
3285
 
                            'file_id %r did not match entry key %s'
3286
 
                            % (file_id, entry_key))
3287
 
                if len(entry_keys) != len(set(entry_keys)):
3288
 
                    raise AssertionError(
3289
 
                        'id_index contained non-unique data for %s'
3290
 
                        % (entry_keys,))
3291
2685
 
3292
2686
    def _wipe_state(self):
3293
2687
        """Forget all state information about the dirstate."""
3349
2743
            raise errors.ObjectNotLocked(self)
3350
2744
 
3351
2745
 
3352
 
def py_update_entry(state, entry, abspath, stat_value,
3353
 
                 _stat_to_minikind=DirState._stat_to_minikind):
3354
 
    """Update the entry based on what is actually on disk.
3355
 
 
3356
 
    This function only calculates the sha if it needs to - if the entry is
3357
 
    uncachable, or clearly different to the first parent's entry, no sha
3358
 
    is calculated, and None is returned.
3359
 
 
3360
 
    :param state: The dirstate this entry is in.
3361
 
    :param entry: This is the dirblock entry for the file in question.
3362
 
    :param abspath: The path on disk for this file.
3363
 
    :param stat_value: The stat value done on the path.
3364
 
    :return: None, or The sha1 hexdigest of the file (40 bytes) or link
3365
 
        target of a symlink.
3366
 
    """
3367
 
    try:
3368
 
        minikind = _stat_to_minikind[stat_value.st_mode & 0170000]
3369
 
    except KeyError:
3370
 
        # Unhandled kind
3371
 
        return None
3372
 
    packed_stat = pack_stat(stat_value)
3373
 
    (saved_minikind, saved_link_or_sha1, saved_file_size,
3374
 
     saved_executable, saved_packed_stat) = entry[1][0]
3375
 
 
3376
 
    if minikind == 'd' and saved_minikind == 't':
3377
 
        minikind = 't'
3378
 
    if (minikind == saved_minikind
3379
 
        and packed_stat == saved_packed_stat):
3380
 
        # The stat hasn't changed since we saved, so we can re-use the
3381
 
        # saved sha hash.
3382
 
        if minikind == 'd':
3383
 
            return None
3384
 
 
3385
 
        # size should also be in packed_stat
3386
 
        if saved_file_size == stat_value.st_size:
3387
 
            return saved_link_or_sha1
3388
 
 
3389
 
    # If we have gotten this far, that means that we need to actually
3390
 
    # process this entry.
3391
 
    link_or_sha1 = None
3392
 
    worth_saving = True
3393
 
    if minikind == 'f':
3394
 
        executable = state._is_executable(stat_value.st_mode,
3395
 
                                         saved_executable)
3396
 
        if state._cutoff_time is None:
3397
 
            state._sha_cutoff_time()
3398
 
        if (stat_value.st_mtime < state._cutoff_time
3399
 
            and stat_value.st_ctime < state._cutoff_time
3400
 
            and len(entry[1]) > 1
3401
 
            and entry[1][1][0] != 'a'):
3402
 
            # Could check for size changes for further optimised
3403
 
            # avoidance of sha1's. However the most prominent case of
3404
 
            # over-shaing is during initial add, which this catches.
3405
 
            # Besides, if content filtering happens, size and sha
3406
 
            # are calculated at the same time, so checking just the size
3407
 
            # gains nothing w.r.t. performance.
3408
 
            link_or_sha1 = state._sha1_file(abspath)
3409
 
            entry[1][0] = ('f', link_or_sha1, stat_value.st_size,
3410
 
                           executable, packed_stat)
3411
 
        else:
3412
 
            entry[1][0] = ('f', '', stat_value.st_size,
3413
 
                           executable, DirState.NULLSTAT)
3414
 
            worth_saving = False
3415
 
    elif minikind == 'd':
3416
 
        link_or_sha1 = None
3417
 
        entry[1][0] = ('d', '', 0, False, packed_stat)
3418
 
        if saved_minikind != 'd':
3419
 
            # This changed from something into a directory. Make sure we
3420
 
            # have a directory block for it. This doesn't happen very
3421
 
            # often, so this doesn't have to be super fast.
3422
 
            block_index, entry_index, dir_present, file_present = \
3423
 
                state._get_block_entry_index(entry[0][0], entry[0][1], 0)
3424
 
            state._ensure_block(block_index, entry_index,
3425
 
                               osutils.pathjoin(entry[0][0], entry[0][1]))
3426
 
        else:
3427
 
            worth_saving = False
3428
 
    elif minikind == 'l':
3429
 
        if saved_minikind == 'l':
3430
 
            worth_saving = False
3431
 
        link_or_sha1 = state._read_link(abspath, saved_link_or_sha1)
3432
 
        if state._cutoff_time is None:
3433
 
            state._sha_cutoff_time()
3434
 
        if (stat_value.st_mtime < state._cutoff_time
3435
 
            and stat_value.st_ctime < state._cutoff_time):
3436
 
            entry[1][0] = ('l', link_or_sha1, stat_value.st_size,
3437
 
                           False, packed_stat)
3438
 
        else:
3439
 
            entry[1][0] = ('l', '', stat_value.st_size,
3440
 
                           False, DirState.NULLSTAT)
3441
 
    if worth_saving:
3442
 
        state._mark_modified([entry])
3443
 
    return link_or_sha1
3444
 
 
3445
 
 
3446
 
class ProcessEntryPython(object):
3447
 
 
3448
 
    __slots__ = ["old_dirname_to_file_id", "new_dirname_to_file_id",
3449
 
        "last_source_parent", "last_target_parent", "include_unchanged",
3450
 
        "partial", "use_filesystem_for_exec", "utf8_decode",
3451
 
        "searched_specific_files", "search_specific_files",
3452
 
        "searched_exact_paths", "search_specific_file_parents", "seen_ids",
3453
 
        "state", "source_index", "target_index", "want_unversioned", "tree"]
3454
 
 
3455
 
    def __init__(self, include_unchanged, use_filesystem_for_exec,
3456
 
        search_specific_files, state, source_index, target_index,
3457
 
        want_unversioned, tree):
3458
 
        self.old_dirname_to_file_id = {}
3459
 
        self.new_dirname_to_file_id = {}
3460
 
        # Are we doing a partial iter_changes?
3461
 
        self.partial = search_specific_files != set([''])
3462
 
        # Using a list so that we can access the values and change them in
3463
 
        # nested scope. Each one is [path, file_id, entry]
3464
 
        self.last_source_parent = [None, None]
3465
 
        self.last_target_parent = [None, None]
3466
 
        self.include_unchanged = include_unchanged
3467
 
        self.use_filesystem_for_exec = use_filesystem_for_exec
3468
 
        self.utf8_decode = cache_utf8._utf8_decode
3469
 
        # for all search_indexs in each path at or under each element of
3470
 
        # search_specific_files, if the detail is relocated: add the id, and
3471
 
        # add the relocated path as one to search if its not searched already.
3472
 
        # If the detail is not relocated, add the id.
3473
 
        self.searched_specific_files = set()
3474
 
        # When we search exact paths without expanding downwards, we record
3475
 
        # that here.
3476
 
        self.searched_exact_paths = set()
3477
 
        self.search_specific_files = search_specific_files
3478
 
        # The parents up to the root of the paths we are searching.
3479
 
        # After all normal paths are returned, these specific items are returned.
3480
 
        self.search_specific_file_parents = set()
3481
 
        # The ids we've sent out in the delta.
3482
 
        self.seen_ids = set()
3483
 
        self.state = state
3484
 
        self.source_index = source_index
3485
 
        self.target_index = target_index
3486
 
        if target_index != 0:
3487
 
            # A lot of code in here depends on target_index == 0
3488
 
            raise errors.BzrError('unsupported target index')
3489
 
        self.want_unversioned = want_unversioned
3490
 
        self.tree = tree
3491
 
 
3492
 
    def _process_entry(self, entry, path_info, pathjoin=osutils.pathjoin):
3493
 
        """Compare an entry and real disk to generate delta information.
3494
 
 
3495
 
        :param path_info: top_relpath, basename, kind, lstat, abspath for
3496
 
            the path of entry. If None, then the path is considered absent in 
3497
 
            the target (Perhaps we should pass in a concrete entry for this ?)
3498
 
            Basename is returned as a utf8 string because we expect this
3499
 
            tuple will be ignored, and don't want to take the time to
3500
 
            decode.
3501
 
        :return: (iter_changes_result, changed). If the entry has not been
3502
 
            handled then changed is None. Otherwise it is False if no content
3503
 
            or metadata changes have occurred, and True if any content or
3504
 
            metadata change has occurred. If self.include_unchanged is True then
3505
 
            if changed is not None, iter_changes_result will always be a result
3506
 
            tuple. Otherwise, iter_changes_result is None unless changed is
3507
 
            True.
3508
 
        """
3509
 
        if self.source_index is None:
3510
 
            source_details = DirState.NULL_PARENT_DETAILS
3511
 
        else:
3512
 
            source_details = entry[1][self.source_index]
3513
 
        target_details = entry[1][self.target_index]
3514
 
        target_minikind = target_details[0]
3515
 
        if path_info is not None and target_minikind in 'fdlt':
3516
 
            if not (self.target_index == 0):
3517
 
                raise AssertionError()
3518
 
            link_or_sha1 = update_entry(self.state, entry,
3519
 
                abspath=path_info[4], stat_value=path_info[3])
3520
 
            # The entry may have been modified by update_entry
3521
 
            target_details = entry[1][self.target_index]
3522
 
            target_minikind = target_details[0]
3523
 
        else:
3524
 
            link_or_sha1 = None
3525
 
        file_id = entry[0][2]
3526
 
        source_minikind = source_details[0]
3527
 
        if source_minikind in 'fdltr' and target_minikind in 'fdlt':
3528
 
            # claimed content in both: diff
3529
 
            #   r    | fdlt   |      | add source to search, add id path move and perform
3530
 
            #        |        |      | diff check on source-target
3531
 
            #   r    | fdlt   |  a   | dangling file that was present in the basis.
3532
 
            #        |        |      | ???
3533
 
            if source_minikind in 'r':
3534
 
                # add the source to the search path to find any children it
3535
 
                # has.  TODO ? : only add if it is a container ?
3536
 
                if not osutils.is_inside_any(self.searched_specific_files,
3537
 
                                             source_details[1]):
3538
 
                    self.search_specific_files.add(source_details[1])
3539
 
                # generate the old path; this is needed for stating later
3540
 
                # as well.
3541
 
                old_path = source_details[1]
3542
 
                old_dirname, old_basename = os.path.split(old_path)
3543
 
                path = pathjoin(entry[0][0], entry[0][1])
3544
 
                old_entry = self.state._get_entry(self.source_index,
3545
 
                                             path_utf8=old_path)
3546
 
                # update the source details variable to be the real
3547
 
                # location.
3548
 
                if old_entry == (None, None):
3549
 
                    raise errors.CorruptDirstate(self.state._filename,
3550
 
                        "entry '%s/%s' is considered renamed from %r"
3551
 
                        " but source does not exist\n"
3552
 
                        "entry: %s" % (entry[0][0], entry[0][1], old_path, entry))
3553
 
                source_details = old_entry[1][self.source_index]
3554
 
                source_minikind = source_details[0]
3555
 
            else:
3556
 
                old_dirname = entry[0][0]
3557
 
                old_basename = entry[0][1]
3558
 
                old_path = path = None
3559
 
            if path_info is None:
3560
 
                # the file is missing on disk, show as removed.
3561
 
                content_change = True
3562
 
                target_kind = None
3563
 
                target_exec = False
3564
 
            else:
3565
 
                # source and target are both versioned and disk file is present.
3566
 
                target_kind = path_info[2]
3567
 
                if target_kind == 'directory':
3568
 
                    if path is None:
3569
 
                        old_path = path = pathjoin(old_dirname, old_basename)
3570
 
                    self.new_dirname_to_file_id[path] = file_id
3571
 
                    if source_minikind != 'd':
3572
 
                        content_change = True
3573
 
                    else:
3574
 
                        # directories have no fingerprint
3575
 
                        content_change = False
3576
 
                    target_exec = False
3577
 
                elif target_kind == 'file':
3578
 
                    if source_minikind != 'f':
3579
 
                        content_change = True
3580
 
                    else:
3581
 
                        # Check the sha. We can't just rely on the size as
3582
 
                        # content filtering may mean differ sizes actually
3583
 
                        # map to the same content
3584
 
                        if link_or_sha1 is None:
3585
 
                            # Stat cache miss:
3586
 
                            statvalue, link_or_sha1 = \
3587
 
                                self.state._sha1_provider.stat_and_sha1(
3588
 
                                path_info[4])
3589
 
                            self.state._observed_sha1(entry, link_or_sha1,
3590
 
                                statvalue)
3591
 
                        content_change = (link_or_sha1 != source_details[1])
3592
 
                    # Target details is updated at update_entry time
3593
 
                    if self.use_filesystem_for_exec:
3594
 
                        # We don't need S_ISREG here, because we are sure
3595
 
                        # we are dealing with a file.
3596
 
                        target_exec = bool(stat.S_IEXEC & path_info[3].st_mode)
3597
 
                    else:
3598
 
                        target_exec = target_details[3]
3599
 
                elif target_kind == 'symlink':
3600
 
                    if source_minikind != 'l':
3601
 
                        content_change = True
3602
 
                    else:
3603
 
                        content_change = (link_or_sha1 != source_details[1])
3604
 
                    target_exec = False
3605
 
                elif target_kind == 'tree-reference':
3606
 
                    if source_minikind != 't':
3607
 
                        content_change = True
3608
 
                    else:
3609
 
                        content_change = False
3610
 
                    target_exec = False
3611
 
                else:
3612
 
                    if path is None:
3613
 
                        path = pathjoin(old_dirname, old_basename)
3614
 
                    raise errors.BadFileKindError(path, path_info[2])
3615
 
            if source_minikind == 'd':
3616
 
                if path is None:
3617
 
                    old_path = path = pathjoin(old_dirname, old_basename)
3618
 
                self.old_dirname_to_file_id[old_path] = file_id
3619
 
            # parent id is the entry for the path in the target tree
3620
 
            if old_basename and old_dirname == self.last_source_parent[0]:
3621
 
                source_parent_id = self.last_source_parent[1]
3622
 
            else:
3623
 
                try:
3624
 
                    source_parent_id = self.old_dirname_to_file_id[old_dirname]
3625
 
                except KeyError:
3626
 
                    source_parent_entry = self.state._get_entry(self.source_index,
3627
 
                                                           path_utf8=old_dirname)
3628
 
                    source_parent_id = source_parent_entry[0][2]
3629
 
                if source_parent_id == entry[0][2]:
3630
 
                    # This is the root, so the parent is None
3631
 
                    source_parent_id = None
3632
 
                else:
3633
 
                    self.last_source_parent[0] = old_dirname
3634
 
                    self.last_source_parent[1] = source_parent_id
3635
 
            new_dirname = entry[0][0]
3636
 
            if entry[0][1] and new_dirname == self.last_target_parent[0]:
3637
 
                target_parent_id = self.last_target_parent[1]
3638
 
            else:
3639
 
                try:
3640
 
                    target_parent_id = self.new_dirname_to_file_id[new_dirname]
3641
 
                except KeyError:
3642
 
                    # TODO: We don't always need to do the lookup, because the
3643
 
                    #       parent entry will be the same as the source entry.
3644
 
                    target_parent_entry = self.state._get_entry(self.target_index,
3645
 
                                                           path_utf8=new_dirname)
3646
 
                    if target_parent_entry == (None, None):
3647
 
                        raise AssertionError(
3648
 
                            "Could not find target parent in wt: %s\nparent of: %s"
3649
 
                            % (new_dirname, entry))
3650
 
                    target_parent_id = target_parent_entry[0][2]
3651
 
                if target_parent_id == entry[0][2]:
3652
 
                    # This is the root, so the parent is None
3653
 
                    target_parent_id = None
3654
 
                else:
3655
 
                    self.last_target_parent[0] = new_dirname
3656
 
                    self.last_target_parent[1] = target_parent_id
3657
 
 
3658
 
            source_exec = source_details[3]
3659
 
            changed = (content_change
3660
 
                or source_parent_id != target_parent_id
3661
 
                or old_basename != entry[0][1]
3662
 
                or source_exec != target_exec
3663
 
                )
3664
 
            if not changed and not self.include_unchanged:
3665
 
                return None, False
3666
 
            else:
3667
 
                if old_path is None:
3668
 
                    old_path = path = pathjoin(old_dirname, old_basename)
3669
 
                    old_path_u = self.utf8_decode(old_path)[0]
3670
 
                    path_u = old_path_u
3671
 
                else:
3672
 
                    old_path_u = self.utf8_decode(old_path)[0]
3673
 
                    if old_path == path:
3674
 
                        path_u = old_path_u
3675
 
                    else:
3676
 
                        path_u = self.utf8_decode(path)[0]
3677
 
                source_kind = DirState._minikind_to_kind[source_minikind]
3678
 
                return (entry[0][2],
3679
 
                       (old_path_u, path_u),
3680
 
                       content_change,
3681
 
                       (True, True),
3682
 
                       (source_parent_id, target_parent_id),
3683
 
                       (self.utf8_decode(old_basename)[0], self.utf8_decode(entry[0][1])[0]),
3684
 
                       (source_kind, target_kind),
3685
 
                       (source_exec, target_exec)), changed
3686
 
        elif source_minikind in 'a' and target_minikind in 'fdlt':
3687
 
            # looks like a new file
3688
 
            path = pathjoin(entry[0][0], entry[0][1])
3689
 
            # parent id is the entry for the path in the target tree
3690
 
            # TODO: these are the same for an entire directory: cache em.
3691
 
            parent_id = self.state._get_entry(self.target_index,
3692
 
                                         path_utf8=entry[0][0])[0][2]
3693
 
            if parent_id == entry[0][2]:
3694
 
                parent_id = None
3695
 
            if path_info is not None:
3696
 
                # Present on disk:
3697
 
                if self.use_filesystem_for_exec:
3698
 
                    # We need S_ISREG here, because we aren't sure if this
3699
 
                    # is a file or not.
3700
 
                    target_exec = bool(
3701
 
                        stat.S_ISREG(path_info[3].st_mode)
3702
 
                        and stat.S_IEXEC & path_info[3].st_mode)
3703
 
                else:
3704
 
                    target_exec = target_details[3]
3705
 
                return (entry[0][2],
3706
 
                       (None, self.utf8_decode(path)[0]),
3707
 
                       True,
3708
 
                       (False, True),
3709
 
                       (None, parent_id),
3710
 
                       (None, self.utf8_decode(entry[0][1])[0]),
3711
 
                       (None, path_info[2]),
3712
 
                       (None, target_exec)), True
3713
 
            else:
3714
 
                # Its a missing file, report it as such.
3715
 
                return (entry[0][2],
3716
 
                       (None, self.utf8_decode(path)[0]),
3717
 
                       False,
3718
 
                       (False, True),
3719
 
                       (None, parent_id),
3720
 
                       (None, self.utf8_decode(entry[0][1])[0]),
3721
 
                       (None, None),
3722
 
                       (None, False)), True
3723
 
        elif source_minikind in 'fdlt' and target_minikind in 'a':
3724
 
            # unversioned, possibly, or possibly not deleted: we dont care.
3725
 
            # if its still on disk, *and* theres no other entry at this
3726
 
            # path [we dont know this in this routine at the moment -
3727
 
            # perhaps we should change this - then it would be an unknown.
3728
 
            old_path = pathjoin(entry[0][0], entry[0][1])
3729
 
            # parent id is the entry for the path in the target tree
3730
 
            parent_id = self.state._get_entry(self.source_index, path_utf8=entry[0][0])[0][2]
3731
 
            if parent_id == entry[0][2]:
3732
 
                parent_id = None
3733
 
            return (entry[0][2],
3734
 
                   (self.utf8_decode(old_path)[0], None),
3735
 
                   True,
3736
 
                   (True, False),
3737
 
                   (parent_id, None),
3738
 
                   (self.utf8_decode(entry[0][1])[0], None),
3739
 
                   (DirState._minikind_to_kind[source_minikind], None),
3740
 
                   (source_details[3], None)), True
3741
 
        elif source_minikind in 'fdlt' and target_minikind in 'r':
3742
 
            # a rename; could be a true rename, or a rename inherited from
3743
 
            # a renamed parent. TODO: handle this efficiently. Its not
3744
 
            # common case to rename dirs though, so a correct but slow
3745
 
            # implementation will do.
3746
 
            if not osutils.is_inside_any(self.searched_specific_files, target_details[1]):
3747
 
                self.search_specific_files.add(target_details[1])
3748
 
        elif source_minikind in 'ra' and target_minikind in 'ra':
3749
 
            # neither of the selected trees contain this file,
3750
 
            # so skip over it. This is not currently directly tested, but
3751
 
            # is indirectly via test_too_much.TestCommands.test_conflicts.
3752
 
            pass
3753
 
        else:
3754
 
            raise AssertionError("don't know how to compare "
3755
 
                "source_minikind=%r, target_minikind=%r"
3756
 
                % (source_minikind, target_minikind))
3757
 
        return None, None
3758
 
 
3759
 
    def __iter__(self):
3760
 
        return self
3761
 
 
3762
 
    def _gather_result_for_consistency(self, result):
3763
 
        """Check a result we will yield to make sure we are consistent later.
3764
 
        
3765
 
        This gathers result's parents into a set to output later.
3766
 
 
3767
 
        :param result: A result tuple.
3768
 
        """
3769
 
        if not self.partial or not result[0]:
3770
 
            return
3771
 
        self.seen_ids.add(result[0])
3772
 
        new_path = result[1][1]
3773
 
        if new_path:
3774
 
            # Not the root and not a delete: queue up the parents of the path.
3775
 
            self.search_specific_file_parents.update(
3776
 
                osutils.parent_directories(new_path.encode('utf8')))
3777
 
            # Add the root directory which parent_directories does not
3778
 
            # provide.
3779
 
            self.search_specific_file_parents.add('')
3780
 
 
3781
 
    def iter_changes(self):
3782
 
        """Iterate over the changes."""
3783
 
        utf8_decode = cache_utf8._utf8_decode
3784
 
        _cmp_by_dirs = cmp_by_dirs
3785
 
        _process_entry = self._process_entry
3786
 
        search_specific_files = self.search_specific_files
3787
 
        searched_specific_files = self.searched_specific_files
3788
 
        splitpath = osutils.splitpath
3789
 
        # sketch:
3790
 
        # compare source_index and target_index at or under each element of search_specific_files.
3791
 
        # follow the following comparison table. Note that we only want to do diff operations when
3792
 
        # the target is fdl because thats when the walkdirs logic will have exposed the pathinfo
3793
 
        # for the target.
3794
 
        # cases:
3795
 
        #
3796
 
        # Source | Target | disk | action
3797
 
        #   r    | fdlt   |      | add source to search, add id path move and perform
3798
 
        #        |        |      | diff check on source-target
3799
 
        #   r    | fdlt   |  a   | dangling file that was present in the basis.
3800
 
        #        |        |      | ???
3801
 
        #   r    |  a     |      | add source to search
3802
 
        #   r    |  a     |  a   |
3803
 
        #   r    |  r     |      | this path is present in a non-examined tree, skip.
3804
 
        #   r    |  r     |  a   | this path is present in a non-examined tree, skip.
3805
 
        #   a    | fdlt   |      | add new id
3806
 
        #   a    | fdlt   |  a   | dangling locally added file, skip
3807
 
        #   a    |  a     |      | not present in either tree, skip
3808
 
        #   a    |  a     |  a   | not present in any tree, skip
3809
 
        #   a    |  r     |      | not present in either tree at this path, skip as it
3810
 
        #        |        |      | may not be selected by the users list of paths.
3811
 
        #   a    |  r     |  a   | not present in either tree at this path, skip as it
3812
 
        #        |        |      | may not be selected by the users list of paths.
3813
 
        #  fdlt  | fdlt   |      | content in both: diff them
3814
 
        #  fdlt  | fdlt   |  a   | deleted locally, but not unversioned - show as deleted ?
3815
 
        #  fdlt  |  a     |      | unversioned: output deleted id for now
3816
 
        #  fdlt  |  a     |  a   | unversioned and deleted: output deleted id
3817
 
        #  fdlt  |  r     |      | relocated in this tree, so add target to search.
3818
 
        #        |        |      | Dont diff, we will see an r,fd; pair when we reach
3819
 
        #        |        |      | this id at the other path.
3820
 
        #  fdlt  |  r     |  a   | relocated in this tree, so add target to search.
3821
 
        #        |        |      | Dont diff, we will see an r,fd; pair when we reach
3822
 
        #        |        |      | this id at the other path.
3823
 
 
3824
 
        # TODO: jam 20070516 - Avoid the _get_entry lookup overhead by
3825
 
        #       keeping a cache of directories that we have seen.
3826
 
 
3827
 
        while search_specific_files:
3828
 
            # TODO: the pending list should be lexically sorted?  the
3829
 
            # interface doesn't require it.
3830
 
            current_root = search_specific_files.pop()
3831
 
            current_root_unicode = current_root.decode('utf8')
3832
 
            searched_specific_files.add(current_root)
3833
 
            # process the entries for this containing directory: the rest will be
3834
 
            # found by their parents recursively.
3835
 
            root_entries = self.state._entries_for_path(current_root)
3836
 
            root_abspath = self.tree.abspath(current_root_unicode)
3837
 
            try:
3838
 
                root_stat = os.lstat(root_abspath)
3839
 
            except OSError, e:
3840
 
                if e.errno == errno.ENOENT:
3841
 
                    # the path does not exist: let _process_entry know that.
3842
 
                    root_dir_info = None
3843
 
                else:
3844
 
                    # some other random error: hand it up.
3845
 
                    raise
3846
 
            else:
3847
 
                root_dir_info = ('', current_root,
3848
 
                    osutils.file_kind_from_stat_mode(root_stat.st_mode), root_stat,
3849
 
                    root_abspath)
3850
 
                if root_dir_info[2] == 'directory':
3851
 
                    if self.tree._directory_is_tree_reference(
3852
 
                        current_root.decode('utf8')):
3853
 
                        root_dir_info = root_dir_info[:2] + \
3854
 
                            ('tree-reference',) + root_dir_info[3:]
3855
 
 
3856
 
            if not root_entries and not root_dir_info:
3857
 
                # this specified path is not present at all, skip it.
3858
 
                continue
3859
 
            path_handled = False
3860
 
            for entry in root_entries:
3861
 
                result, changed = _process_entry(entry, root_dir_info)
3862
 
                if changed is not None:
3863
 
                    path_handled = True
3864
 
                    if changed:
3865
 
                        self._gather_result_for_consistency(result)
3866
 
                    if changed or self.include_unchanged:
3867
 
                        yield result
3868
 
            if self.want_unversioned and not path_handled and root_dir_info:
3869
 
                new_executable = bool(
3870
 
                    stat.S_ISREG(root_dir_info[3].st_mode)
3871
 
                    and stat.S_IEXEC & root_dir_info[3].st_mode)
3872
 
                yield (None,
3873
 
                       (None, current_root_unicode),
3874
 
                       True,
3875
 
                       (False, False),
3876
 
                       (None, None),
3877
 
                       (None, splitpath(current_root_unicode)[-1]),
3878
 
                       (None, root_dir_info[2]),
3879
 
                       (None, new_executable)
3880
 
                      )
3881
 
            initial_key = (current_root, '', '')
3882
 
            block_index, _ = self.state._find_block_index_from_key(initial_key)
3883
 
            if block_index == 0:
3884
 
                # we have processed the total root already, but because the
3885
 
                # initial key matched it we should skip it here.
3886
 
                block_index +=1
3887
 
            if root_dir_info and root_dir_info[2] == 'tree-reference':
3888
 
                current_dir_info = None
3889
 
            else:
3890
 
                dir_iterator = osutils._walkdirs_utf8(root_abspath, prefix=current_root)
3891
 
                try:
3892
 
                    current_dir_info = dir_iterator.next()
3893
 
                except OSError, e:
3894
 
                    # on win32, python2.4 has e.errno == ERROR_DIRECTORY, but
3895
 
                    # python 2.5 has e.errno == EINVAL,
3896
 
                    #            and e.winerror == ERROR_DIRECTORY
3897
 
                    e_winerror = getattr(e, 'winerror', None)
3898
 
                    win_errors = (ERROR_DIRECTORY, ERROR_PATH_NOT_FOUND)
3899
 
                    # there may be directories in the inventory even though
3900
 
                    # this path is not a file on disk: so mark it as end of
3901
 
                    # iterator
3902
 
                    if e.errno in (errno.ENOENT, errno.ENOTDIR, errno.EINVAL):
3903
 
                        current_dir_info = None
3904
 
                    elif (sys.platform == 'win32'
3905
 
                          and (e.errno in win_errors
3906
 
                               or e_winerror in win_errors)):
3907
 
                        current_dir_info = None
3908
 
                    else:
3909
 
                        raise
3910
 
                else:
3911
 
                    if current_dir_info[0][0] == '':
3912
 
                        # remove .bzr from iteration
3913
 
                        bzr_index = bisect.bisect_left(current_dir_info[1], ('.bzr',))
3914
 
                        if current_dir_info[1][bzr_index][0] != '.bzr':
3915
 
                            raise AssertionError()
3916
 
                        del current_dir_info[1][bzr_index]
3917
 
            # walk until both the directory listing and the versioned metadata
3918
 
            # are exhausted.
3919
 
            if (block_index < len(self.state._dirblocks) and
3920
 
                osutils.is_inside(current_root, self.state._dirblocks[block_index][0])):
3921
 
                current_block = self.state._dirblocks[block_index]
3922
 
            else:
3923
 
                current_block = None
3924
 
            while (current_dir_info is not None or
3925
 
                   current_block is not None):
3926
 
                if (current_dir_info and current_block
3927
 
                    and current_dir_info[0][0] != current_block[0]):
3928
 
                    if _cmp_by_dirs(current_dir_info[0][0], current_block[0]) < 0:
3929
 
                        # filesystem data refers to paths not covered by the dirblock.
3930
 
                        # this has two possibilities:
3931
 
                        # A) it is versioned but empty, so there is no block for it
3932
 
                        # B) it is not versioned.
3933
 
 
3934
 
                        # if (A) then we need to recurse into it to check for
3935
 
                        # new unknown files or directories.
3936
 
                        # if (B) then we should ignore it, because we don't
3937
 
                        # recurse into unknown directories.
3938
 
                        path_index = 0
3939
 
                        while path_index < len(current_dir_info[1]):
3940
 
                                current_path_info = current_dir_info[1][path_index]
3941
 
                                if self.want_unversioned:
3942
 
                                    if current_path_info[2] == 'directory':
3943
 
                                        if self.tree._directory_is_tree_reference(
3944
 
                                            current_path_info[0].decode('utf8')):
3945
 
                                            current_path_info = current_path_info[:2] + \
3946
 
                                                ('tree-reference',) + current_path_info[3:]
3947
 
                                    new_executable = bool(
3948
 
                                        stat.S_ISREG(current_path_info[3].st_mode)
3949
 
                                        and stat.S_IEXEC & current_path_info[3].st_mode)
3950
 
                                    yield (None,
3951
 
                                        (None, utf8_decode(current_path_info[0])[0]),
3952
 
                                        True,
3953
 
                                        (False, False),
3954
 
                                        (None, None),
3955
 
                                        (None, utf8_decode(current_path_info[1])[0]),
3956
 
                                        (None, current_path_info[2]),
3957
 
                                        (None, new_executable))
3958
 
                                # dont descend into this unversioned path if it is
3959
 
                                # a dir
3960
 
                                if current_path_info[2] in ('directory',
3961
 
                                                            'tree-reference'):
3962
 
                                    del current_dir_info[1][path_index]
3963
 
                                    path_index -= 1
3964
 
                                path_index += 1
3965
 
 
3966
 
                        # This dir info has been handled, go to the next
3967
 
                        try:
3968
 
                            current_dir_info = dir_iterator.next()
3969
 
                        except StopIteration:
3970
 
                            current_dir_info = None
3971
 
                    else:
3972
 
                        # We have a dirblock entry for this location, but there
3973
 
                        # is no filesystem path for this. This is most likely
3974
 
                        # because a directory was removed from the disk.
3975
 
                        # We don't have to report the missing directory,
3976
 
                        # because that should have already been handled, but we
3977
 
                        # need to handle all of the files that are contained
3978
 
                        # within.
3979
 
                        for current_entry in current_block[1]:
3980
 
                            # entry referring to file not present on disk.
3981
 
                            # advance the entry only, after processing.
3982
 
                            result, changed = _process_entry(current_entry, None)
3983
 
                            if changed is not None:
3984
 
                                if changed:
3985
 
                                    self._gather_result_for_consistency(result)
3986
 
                                if changed or self.include_unchanged:
3987
 
                                    yield result
3988
 
                        block_index +=1
3989
 
                        if (block_index < len(self.state._dirblocks) and
3990
 
                            osutils.is_inside(current_root,
3991
 
                                              self.state._dirblocks[block_index][0])):
3992
 
                            current_block = self.state._dirblocks[block_index]
3993
 
                        else:
3994
 
                            current_block = None
3995
 
                    continue
3996
 
                entry_index = 0
3997
 
                if current_block and entry_index < len(current_block[1]):
3998
 
                    current_entry = current_block[1][entry_index]
3999
 
                else:
4000
 
                    current_entry = None
4001
 
                advance_entry = True
4002
 
                path_index = 0
4003
 
                if current_dir_info and path_index < len(current_dir_info[1]):
4004
 
                    current_path_info = current_dir_info[1][path_index]
4005
 
                    if current_path_info[2] == 'directory':
4006
 
                        if self.tree._directory_is_tree_reference(
4007
 
                            current_path_info[0].decode('utf8')):
4008
 
                            current_path_info = current_path_info[:2] + \
4009
 
                                ('tree-reference',) + current_path_info[3:]
4010
 
                else:
4011
 
                    current_path_info = None
4012
 
                advance_path = True
4013
 
                path_handled = False
4014
 
                while (current_entry is not None or
4015
 
                    current_path_info is not None):
4016
 
                    if current_entry is None:
4017
 
                        # the check for path_handled when the path is advanced
4018
 
                        # will yield this path if needed.
4019
 
                        pass
4020
 
                    elif current_path_info is None:
4021
 
                        # no path is fine: the per entry code will handle it.
4022
 
                        result, changed = _process_entry(current_entry, current_path_info)
4023
 
                        if changed is not None:
4024
 
                            if changed:
4025
 
                                self._gather_result_for_consistency(result)
4026
 
                            if changed or self.include_unchanged:
4027
 
                                yield result
4028
 
                    elif (current_entry[0][1] != current_path_info[1]
4029
 
                          or current_entry[1][self.target_index][0] in 'ar'):
4030
 
                        # The current path on disk doesn't match the dirblock
4031
 
                        # record. Either the dirblock is marked as absent, or
4032
 
                        # the file on disk is not present at all in the
4033
 
                        # dirblock. Either way, report about the dirblock
4034
 
                        # entry, and let other code handle the filesystem one.
4035
 
 
4036
 
                        # Compare the basename for these files to determine
4037
 
                        # which comes first
4038
 
                        if current_path_info[1] < current_entry[0][1]:
4039
 
                            # extra file on disk: pass for now, but only
4040
 
                            # increment the path, not the entry
4041
 
                            advance_entry = False
4042
 
                        else:
4043
 
                            # entry referring to file not present on disk.
4044
 
                            # advance the entry only, after processing.
4045
 
                            result, changed = _process_entry(current_entry, None)
4046
 
                            if changed is not None:
4047
 
                                if changed:
4048
 
                                    self._gather_result_for_consistency(result)
4049
 
                                if changed or self.include_unchanged:
4050
 
                                    yield result
4051
 
                            advance_path = False
4052
 
                    else:
4053
 
                        result, changed = _process_entry(current_entry, current_path_info)
4054
 
                        if changed is not None:
4055
 
                            path_handled = True
4056
 
                            if changed:
4057
 
                                self._gather_result_for_consistency(result)
4058
 
                            if changed or self.include_unchanged:
4059
 
                                yield result
4060
 
                    if advance_entry and current_entry is not None:
4061
 
                        entry_index += 1
4062
 
                        if entry_index < len(current_block[1]):
4063
 
                            current_entry = current_block[1][entry_index]
4064
 
                        else:
4065
 
                            current_entry = None
4066
 
                    else:
4067
 
                        advance_entry = True # reset the advance flaga
4068
 
                    if advance_path and current_path_info is not None:
4069
 
                        if not path_handled:
4070
 
                            # unversioned in all regards
4071
 
                            if self.want_unversioned:
4072
 
                                new_executable = bool(
4073
 
                                    stat.S_ISREG(current_path_info[3].st_mode)
4074
 
                                    and stat.S_IEXEC & current_path_info[3].st_mode)
4075
 
                                try:
4076
 
                                    relpath_unicode = utf8_decode(current_path_info[0])[0]
4077
 
                                except UnicodeDecodeError:
4078
 
                                    raise errors.BadFilenameEncoding(
4079
 
                                        current_path_info[0], osutils._fs_enc)
4080
 
                                yield (None,
4081
 
                                    (None, relpath_unicode),
4082
 
                                    True,
4083
 
                                    (False, False),
4084
 
                                    (None, None),
4085
 
                                    (None, utf8_decode(current_path_info[1])[0]),
4086
 
                                    (None, current_path_info[2]),
4087
 
                                    (None, new_executable))
4088
 
                            # dont descend into this unversioned path if it is
4089
 
                            # a dir
4090
 
                            if current_path_info[2] in ('directory'):
4091
 
                                del current_dir_info[1][path_index]
4092
 
                                path_index -= 1
4093
 
                        # dont descend the disk iterator into any tree
4094
 
                        # paths.
4095
 
                        if current_path_info[2] == 'tree-reference':
4096
 
                            del current_dir_info[1][path_index]
4097
 
                            path_index -= 1
4098
 
                        path_index += 1
4099
 
                        if path_index < len(current_dir_info[1]):
4100
 
                            current_path_info = current_dir_info[1][path_index]
4101
 
                            if current_path_info[2] == 'directory':
4102
 
                                if self.tree._directory_is_tree_reference(
4103
 
                                    current_path_info[0].decode('utf8')):
4104
 
                                    current_path_info = current_path_info[:2] + \
4105
 
                                        ('tree-reference',) + current_path_info[3:]
4106
 
                        else:
4107
 
                            current_path_info = None
4108
 
                        path_handled = False
4109
 
                    else:
4110
 
                        advance_path = True # reset the advance flagg.
4111
 
                if current_block is not None:
4112
 
                    block_index += 1
4113
 
                    if (block_index < len(self.state._dirblocks) and
4114
 
                        osutils.is_inside(current_root, self.state._dirblocks[block_index][0])):
4115
 
                        current_block = self.state._dirblocks[block_index]
4116
 
                    else:
4117
 
                        current_block = None
4118
 
                if current_dir_info is not None:
4119
 
                    try:
4120
 
                        current_dir_info = dir_iterator.next()
4121
 
                    except StopIteration:
4122
 
                        current_dir_info = None
4123
 
        for result in self._iter_specific_file_parents():
4124
 
            yield result
4125
 
 
4126
 
    def _iter_specific_file_parents(self):
4127
 
        """Iter over the specific file parents."""
4128
 
        while self.search_specific_file_parents:
4129
 
            # Process the parent directories for the paths we were iterating.
4130
 
            # Even in extremely large trees this should be modest, so currently
4131
 
            # no attempt is made to optimise.
4132
 
            path_utf8 = self.search_specific_file_parents.pop()
4133
 
            if osutils.is_inside_any(self.searched_specific_files, path_utf8):
4134
 
                # We've examined this path.
4135
 
                continue
4136
 
            if path_utf8 in self.searched_exact_paths:
4137
 
                # We've examined this path.
4138
 
                continue
4139
 
            path_entries = self.state._entries_for_path(path_utf8)
4140
 
            # We need either one or two entries. If the path in
4141
 
            # self.target_index has moved (so the entry in source_index is in
4142
 
            # 'ar') then we need to also look for the entry for this path in
4143
 
            # self.source_index, to output the appropriate delete-or-rename.
4144
 
            selected_entries = []
4145
 
            found_item = False
4146
 
            for candidate_entry in path_entries:
4147
 
                # Find entries present in target at this path:
4148
 
                if candidate_entry[1][self.target_index][0] not in 'ar':
4149
 
                    found_item = True
4150
 
                    selected_entries.append(candidate_entry)
4151
 
                # Find entries present in source at this path:
4152
 
                elif (self.source_index is not None and
4153
 
                    candidate_entry[1][self.source_index][0] not in 'ar'):
4154
 
                    found_item = True
4155
 
                    if candidate_entry[1][self.target_index][0] == 'a':
4156
 
                        # Deleted, emit it here.
4157
 
                        selected_entries.append(candidate_entry)
4158
 
                    else:
4159
 
                        # renamed, emit it when we process the directory it
4160
 
                        # ended up at.
4161
 
                        self.search_specific_file_parents.add(
4162
 
                            candidate_entry[1][self.target_index][1])
4163
 
            if not found_item:
4164
 
                raise AssertionError(
4165
 
                    "Missing entry for specific path parent %r, %r" % (
4166
 
                    path_utf8, path_entries))
4167
 
            path_info = self._path_info(path_utf8, path_utf8.decode('utf8'))
4168
 
            for entry in selected_entries:
4169
 
                if entry[0][2] in self.seen_ids:
4170
 
                    continue
4171
 
                result, changed = self._process_entry(entry, path_info)
4172
 
                if changed is None:
4173
 
                    raise AssertionError(
4174
 
                        "Got entry<->path mismatch for specific path "
4175
 
                        "%r entry %r path_info %r " % (
4176
 
                        path_utf8, entry, path_info))
4177
 
                # Only include changes - we're outside the users requested
4178
 
                # expansion.
4179
 
                if changed:
4180
 
                    self._gather_result_for_consistency(result)
4181
 
                    if (result[6][0] == 'directory' and
4182
 
                        result[6][1] != 'directory'):
4183
 
                        # This stopped being a directory, the old children have
4184
 
                        # to be included.
4185
 
                        if entry[1][self.source_index][0] == 'r':
4186
 
                            # renamed, take the source path
4187
 
                            entry_path_utf8 = entry[1][self.source_index][1]
4188
 
                        else:
4189
 
                            entry_path_utf8 = path_utf8
4190
 
                        initial_key = (entry_path_utf8, '', '')
4191
 
                        block_index, _ = self.state._find_block_index_from_key(
4192
 
                            initial_key)
4193
 
                        if block_index == 0:
4194
 
                            # The children of the root are in block index 1.
4195
 
                            block_index +=1
4196
 
                        current_block = None
4197
 
                        if block_index < len(self.state._dirblocks):
4198
 
                            current_block = self.state._dirblocks[block_index]
4199
 
                            if not osutils.is_inside(
4200
 
                                entry_path_utf8, current_block[0]):
4201
 
                                # No entries for this directory at all.
4202
 
                                current_block = None
4203
 
                        if current_block is not None:
4204
 
                            for entry in current_block[1]:
4205
 
                                if entry[1][self.source_index][0] in 'ar':
4206
 
                                    # Not in the source tree, so doesn't have to be
4207
 
                                    # included.
4208
 
                                    continue
4209
 
                                # Path of the entry itself.
4210
 
 
4211
 
                                self.search_specific_file_parents.add(
4212
 
                                    osutils.pathjoin(*entry[0][:2]))
4213
 
                if changed or self.include_unchanged:
4214
 
                    yield result
4215
 
            self.searched_exact_paths.add(path_utf8)
4216
 
 
4217
 
    def _path_info(self, utf8_path, unicode_path):
4218
 
        """Generate path_info for unicode_path.
4219
 
 
4220
 
        :return: None if unicode_path does not exist, or a path_info tuple.
4221
 
        """
4222
 
        abspath = self.tree.abspath(unicode_path)
4223
 
        try:
4224
 
            stat = os.lstat(abspath)
4225
 
        except OSError, e:
4226
 
            if e.errno == errno.ENOENT:
4227
 
                # the path does not exist.
4228
 
                return None
4229
 
            else:
4230
 
                raise
4231
 
        utf8_basename = utf8_path.rsplit('/', 1)[-1]
4232
 
        dir_info = (utf8_path, utf8_basename,
4233
 
            osutils.file_kind_from_stat_mode(stat.st_mode), stat,
4234
 
            abspath)
4235
 
        if dir_info[2] == 'directory':
4236
 
            if self.tree._directory_is_tree_reference(
4237
 
                unicode_path):
4238
 
                self.root_dir_info = self.root_dir_info[:2] + \
4239
 
                    ('tree-reference',) + self.root_dir_info[3:]
4240
 
        return dir_info
4241
 
 
4242
 
 
4243
2746
# Try to load the compiled form if possible
4244
2747
try:
4245
 
    from bzrlib._dirstate_helpers_pyx import (
4246
 
        _read_dirblocks,
4247
 
        bisect_dirblock,
4248
 
        _bisect_path_left,
4249
 
        _bisect_path_right,
4250
 
        cmp_by_dirs,
4251
 
        pack_stat,
4252
 
        ProcessEntryC as _process_entry,
4253
 
        update_entry as update_entry,
 
2748
    from bzrlib._dirstate_helpers_c import (
 
2749
        _read_dirblocks_c as _read_dirblocks,
 
2750
        bisect_dirblock_c as bisect_dirblock,
 
2751
        _bisect_path_left_c as _bisect_path_left,
 
2752
        _bisect_path_right_c as _bisect_path_right,
 
2753
        cmp_by_dirs_c as cmp_by_dirs,
4254
2754
        )
4255
 
except ImportError, e:
4256
 
    osutils.failed_to_load_extension(e)
 
2755
except ImportError:
4257
2756
    from bzrlib._dirstate_helpers_py import (
4258
 
        _read_dirblocks,
4259
 
        bisect_dirblock,
4260
 
        _bisect_path_left,
4261
 
        _bisect_path_right,
4262
 
        cmp_by_dirs,
4263
 
        pack_stat,
 
2757
        _read_dirblocks_py as _read_dirblocks,
 
2758
        bisect_dirblock_py as bisect_dirblock,
 
2759
        _bisect_path_left_py as _bisect_path_left,
 
2760
        _bisect_path_right_py as _bisect_path_right,
 
2761
        cmp_by_dirs_py as cmp_by_dirs,
4264
2762
        )
4265
 
    # FIXME: It would be nice to be able to track moved lines so that the
4266
 
    # corresponding python code can be moved to the _dirstate_helpers_py
4267
 
    # module. I don't want to break the history for this important piece of
4268
 
    # code so I left the code here -- vila 20090622
4269
 
    update_entry = py_update_entry
4270
 
    _process_entry = ProcessEntryPython