~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-09-11 06:10:59 UTC
  • mfrom: (3702.1.1 trivial)
  • Revision ID: pqm@pqm.ubuntu.com-20080911061059-svzqfejar17ui4zw
(mbp) KnitVersionedFiles repr

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
221
203
import bisect
222
204
import binascii
223
205
import errno
224
 
import operator
225
206
import os
226
207
from stat import S_IEXEC
227
208
import stat
232
213
 
233
214
from bzrlib import (
234
215
    cache_utf8,
235
 
    config,
236
216
    debug,
237
217
    errors,
238
218
    inventory,
239
219
    lock,
240
220
    osutils,
241
 
    static_tuple,
242
221
    trace,
243
 
    urlutils,
244
222
    )
245
223
 
246
224
 
247
 
# This is the Windows equivalent of ENOTDIR
248
 
# It is defined in pywin32.winerror, but we don't want a strong dependency for
249
 
# just an error code.
250
 
ERROR_PATH_NOT_FOUND = 3
251
 
ERROR_DIRECTORY = 267
252
 
 
253
 
 
254
 
if not getattr(struct, '_compile', None):
255
 
    # Cannot pre-compile the dirstate pack_stat
256
 
    def pack_stat(st, _encode=binascii.b2a_base64, _pack=struct.pack):
257
 
        """Convert stat values into a packed representation."""
258
 
        return _encode(_pack('>LLLLLL', st.st_size, int(st.st_mtime),
259
 
            int(st.st_ctime), st.st_dev, st.st_ino & 0xFFFFFFFF,
260
 
            st.st_mode))[:-1]
261
 
else:
262
 
    # compile the struct compiler we need, so as to only do it once
263
 
    from _struct import Struct
264
 
    _compiled_pack = Struct('>LLLLLL').pack
265
 
    def pack_stat(st, _encode=binascii.b2a_base64, _pack=_compiled_pack):
266
 
        """Convert stat values into a packed representation."""
267
 
        # jam 20060614 it isn't really worth removing more entries if we
268
 
        # are going to leave it in packed form.
269
 
        # With only st_mtime and st_mode filesize is 5.5M and read time is 275ms
270
 
        # With all entries, filesize is 5.9M and read time is maybe 280ms
271
 
        # well within the noise margin
272
 
 
273
 
        # base64 encoding always adds a final newline, so strip it off
274
 
        # The current version
275
 
        return _encode(_pack(st.st_size, int(st.st_mtime), int(st.st_ctime),
276
 
            st.st_dev, st.st_ino & 0xFFFFFFFF, st.st_mode))[:-1]
277
 
        # This is 0.060s / 1.520s faster by not encoding as much information
278
 
        # return _encode(_pack('>LL', int(st.st_mtime), st.st_mode))[:-1]
279
 
        # This is not strictly faster than _encode(_pack())[:-1]
280
 
        # return '%X.%X.%X.%X.%X.%X' % (
281
 
        #      st.st_size, int(st.st_mtime), int(st.st_ctime),
282
 
        #      st.st_dev, st.st_ino, st.st_mode)
283
 
        # Similar to the _encode(_pack('>LL'))
284
 
        # return '%X.%X' % (int(st.st_mtime), st.st_mode)
285
 
 
286
 
 
287
 
def _unpack_stat(packed_stat):
288
 
    """Turn a packed_stat back into the stat fields.
289
 
 
290
 
    This is meant as a debugging tool, should not be used in real code.
291
 
    """
292
 
    (st_size, st_mtime, st_ctime, st_dev, st_ino,
293
 
     st_mode) = struct.unpack('>LLLLLL', binascii.a2b_base64(packed_stat))
294
 
    return dict(st_size=st_size, st_mtime=st_mtime, st_ctime=st_ctime,
295
 
                st_dev=st_dev, st_ino=st_ino, st_mode=st_mode)
296
 
 
297
 
 
298
 
class SHA1Provider(object):
299
 
    """An interface for getting sha1s of a file."""
300
 
 
301
 
    def sha1(self, abspath):
302
 
        """Return the sha1 of a file given its absolute path.
303
 
 
304
 
        :param abspath:  May be a filesystem encoded absolute path
305
 
             or a unicode path.
306
 
        """
307
 
        raise NotImplementedError(self.sha1)
308
 
 
309
 
    def stat_and_sha1(self, abspath):
310
 
        """Return the stat and sha1 of a file given its absolute path.
311
 
        
312
 
        :param abspath:  May be a filesystem encoded absolute path
313
 
             or a unicode path.
314
 
 
315
 
        Note: the stat should be the stat of the physical file
316
 
        while the sha may be the sha of its canonical content.
317
 
        """
318
 
        raise NotImplementedError(self.stat_and_sha1)
319
 
 
320
 
 
321
 
class DefaultSHA1Provider(SHA1Provider):
322
 
    """A SHA1Provider that reads directly from the filesystem."""
323
 
 
324
 
    def sha1(self, abspath):
325
 
        """Return the sha1 of a file given its absolute path."""
326
 
        return osutils.sha_file_by_name(abspath)
327
 
 
328
 
    def stat_and_sha1(self, abspath):
329
 
        """Return the stat and sha1 of a file given its absolute path."""
330
 
        file_obj = file(abspath, 'rb')
331
 
        try:
332
 
            statvalue = os.fstat(file_obj.fileno())
333
 
            sha1 = osutils.sha_file(file_obj)
334
 
        finally:
335
 
            file_obj.close()
336
 
        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)
337
246
 
338
247
 
339
248
class DirState(object):
385
294
    NOT_IN_MEMORY = 0
386
295
    IN_MEMORY_UNMODIFIED = 1
387
296
    IN_MEMORY_MODIFIED = 2
388
 
    IN_MEMORY_HASH_MODIFIED = 3 # Only hash-cache updates
389
297
 
390
298
    # A pack_stat (the x's) that is just noise and will never match the output
391
299
    # of base64 encode.
392
300
    NULLSTAT = 'x' * 32
393
 
    NULL_PARENT_DETAILS = static_tuple.StaticTuple('a', '', 0, False, '')
 
301
    NULL_PARENT_DETAILS = ('a', '', 0, False, '')
394
302
 
395
303
    HEADER_FORMAT_2 = '#bazaar dirstate flat format 2\n'
396
304
    HEADER_FORMAT_3 = '#bazaar dirstate flat format 3\n'
397
305
 
398
 
    def __init__(self, path, sha1_provider, worth_saving_limit=0):
 
306
    def __init__(self, path):
399
307
        """Create a  DirState object.
400
308
 
401
309
        :param path: The path at which the dirstate file on disk should live.
402
 
        :param sha1_provider: an object meeting the SHA1Provider interface.
403
 
        :param worth_saving_limit: when the exact number of hash changed
404
 
            entries is known, only bother saving the dirstate if more than
405
 
            this count of entries have changed.
406
 
            -1 means never save hash changes, 0 means always save hash changes.
407
310
        """
408
311
        # _header_state and _dirblock_state represent the current state
409
312
        # of the dirstate metadata and the per-row data respectiely.
411
314
        # IN_MEMORY_UNMODIFIED indicates that what we have in memory
412
315
        #   is the same as is on disk
413
316
        # IN_MEMORY_MODIFIED indicates that we have a modified version
414
 
        #   of what is on disk.
 
317
        #   of what is on disk. 
415
318
        # In future we will add more granularity, for instance _dirblock_state
416
319
        # will probably support partially-in-memory as a separate variable,
417
320
        # allowing for partially-in-memory unmodified and partially-in-memory
418
321
        # modified states.
419
322
        self._header_state = DirState.NOT_IN_MEMORY
420
323
        self._dirblock_state = DirState.NOT_IN_MEMORY
421
 
        # 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 
422
325
        # for safety we're not going to commit to disk.
423
326
        self._changes_aborted = False
424
327
        self._dirblocks = []
435
338
        self._cutoff_time = None
436
339
        self._split_path_cache = {}
437
340
        self._bisect_page_size = DirState.BISECT_PAGE_SIZE
438
 
        self._sha1_provider = sha1_provider
439
341
        if 'hashcache' in debug.debug_flags:
440
342
            self._sha1_file = self._sha1_file_and_mutter
441
343
        else:
442
 
            self._sha1_file = self._sha1_provider.sha1
 
344
            self._sha1_file = osutils.sha_file_by_name
443
345
        # These two attributes provide a simple cache for lookups into the
444
346
        # dirstate in-memory vectors. By probing respectively for the last
445
347
        # block, and for the next entry, we save nearly 2 bisections per path
446
348
        # during commit.
447
349
        self._last_block_index = None
448
350
        self._last_entry_index = None
449
 
        # The set of known hash changes
450
 
        self._known_hash_changes = set()
451
 
        # How many hash changed entries can we have without saving
452
 
        self._worth_saving_limit = worth_saving_limit
453
 
        self._config_stack = config.LocationStack(urlutils.local_path_to_url(
454
 
            path))
455
351
 
456
352
    def __repr__(self):
457
353
        return "%s(%r)" % \
458
354
            (self.__class__.__name__, self._filename)
459
355
 
460
 
    def _mark_modified(self, hash_changed_entries=None, header_modified=False):
461
 
        """Mark this dirstate as modified.
462
 
 
463
 
        :param hash_changed_entries: if non-None, mark just these entries as
464
 
            having their hash modified.
465
 
        :param header_modified: mark the header modified as well, not just the
466
 
            dirblocks.
467
 
        """
468
 
        #trace.mutter_callsite(3, "modified hash entries: %s", hash_changed_entries)
469
 
        if hash_changed_entries:
470
 
            self._known_hash_changes.update([e[0] for e in hash_changed_entries])
471
 
            if self._dirblock_state in (DirState.NOT_IN_MEMORY,
472
 
                                        DirState.IN_MEMORY_UNMODIFIED):
473
 
                # If the dirstate is already marked a IN_MEMORY_MODIFIED, then
474
 
                # that takes precedence.
475
 
                self._dirblock_state = DirState.IN_MEMORY_HASH_MODIFIED
476
 
        else:
477
 
            # TODO: Since we now have a IN_MEMORY_HASH_MODIFIED state, we
478
 
            #       should fail noisily if someone tries to set
479
 
            #       IN_MEMORY_MODIFIED but we don't have a write-lock!
480
 
            # We don't know exactly what changed so disable smart saving
481
 
            self._dirblock_state = DirState.IN_MEMORY_MODIFIED
482
 
        if header_modified:
483
 
            self._header_state = DirState.IN_MEMORY_MODIFIED
484
 
 
485
 
    def _mark_unmodified(self):
486
 
        """Mark this dirstate as unmodified."""
487
 
        self._header_state = DirState.IN_MEMORY_UNMODIFIED
488
 
        self._dirblock_state = DirState.IN_MEMORY_UNMODIFIED
489
 
        self._known_hash_changes = set()
490
 
 
491
356
    def add(self, path, file_id, kind, stat, fingerprint):
492
357
        """Add a path to be tracked.
493
358
 
494
359
        :param path: The path within the dirstate - '' is the root, 'foo' is the
495
 
            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 
496
361
            within the root.
497
362
        :param file_id: The file id of the path being added.
498
 
        :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', 
499
364
            'directory', etc.
500
365
        :param stat: The output of os.lstat for the path.
501
 
        :param fingerprint: The sha value of the file's canonical form (i.e.
502
 
            after any read filters have been applied),
 
366
        :param fingerprint: The sha value of the file,
503
367
            or the target of a symlink,
504
368
            or the referenced revision id for tree-references,
505
369
            or '' for directories.
506
370
        """
507
371
        # adding a file:
508
 
        # find the block its in.
 
372
        # find the block its in. 
509
373
        # find the location in the block.
510
374
        # check its not there
511
375
        # add it.
524
388
        # in the parent, or according to the special treatment for the root
525
389
        if basename == '.' or basename == '..':
526
390
            raise errors.InvalidEntryName(path)
527
 
        # 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 
528
392
        # dirname and basename elements. This single encode and split should be
529
393
        # faster than three separate encodes.
530
394
        utf8path = (dirname + '/' + basename).strip('/').encode('utf8')
534
398
            raise AssertionError(
535
399
                "must be a utf8 file_id not %s" % (type(file_id), ))
536
400
        # Make sure the file_id does not exist in this tree
537
 
        rename_from = None
538
 
        file_id_entry = self._get_entry(0, fileid_utf8=file_id, include_deleted=True)
 
401
        file_id_entry = self._get_entry(0, fileid_utf8=file_id)
539
402
        if file_id_entry != (None, None):
540
 
            if file_id_entry[1][0][0] == 'a':
541
 
                if file_id_entry[0] != (dirname, basename, file_id):
542
 
                    # set the old name's current operation to rename
543
 
                    self.update_minimal(file_id_entry[0],
544
 
                        'r',
545
 
                        path_utf8='',
546
 
                        packed_stat='',
547
 
                        fingerprint=utf8path
548
 
                    )
549
 
                    rename_from = file_id_entry[0][0:2]
550
 
            else:
551
 
                path = osutils.pathjoin(file_id_entry[0][0], file_id_entry[0][1])
552
 
                kind = DirState._minikind_to_kind[file_id_entry[1][0][0]]
553
 
                info = '%s:%s' % (kind, path)
554
 
                raise errors.DuplicateFileId(file_id, info)
 
403
            path = osutils.pathjoin(file_id_entry[0][0], file_id_entry[0][1])
 
404
            kind = DirState._minikind_to_kind[file_id_entry[1][0][0]]
 
405
            info = '%s:%s' % (kind, path)
 
406
            raise errors.DuplicateFileId(file_id, info)
555
407
        first_key = (dirname, basename, '')
556
408
        block_index, present = self._find_block_index_from_key(first_key)
557
409
        if present:
558
410
            # check the path is not in the tree
559
411
            block = self._dirblocks[block_index][1]
560
412
            entry_index, _ = self._find_entry_index(first_key, block)
561
 
            while (entry_index < len(block) and
 
413
            while (entry_index < len(block) and 
562
414
                block[entry_index][0][0:2] == first_key[0:2]):
563
415
                if block[entry_index][1][0][0] not in 'ar':
564
416
                    # this path is in the dirstate in the current tree.
584
436
            packed_stat = pack_stat(stat)
585
437
        parent_info = self._empty_parent_info()
586
438
        minikind = DirState._kind_to_minikind[kind]
587
 
        if rename_from is not None:
588
 
            if rename_from[0]:
589
 
                old_path_utf8 = '%s/%s' % rename_from
590
 
            else:
591
 
                old_path_utf8 = rename_from[1]
592
 
            parent_info[0] = ('r', old_path_utf8, 0, False, '')
593
439
        if kind == 'file':
594
440
            entry_data = entry_key, [
595
441
                (minikind, fingerprint, size, False, packed_stat),
619
465
        if kind == 'directory':
620
466
           # insert a new dirblock
621
467
           self._ensure_block(block_index, entry_index, utf8path)
622
 
        self._mark_modified()
 
468
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
623
469
        if self._id_index:
624
 
            self._add_to_id_index(self._id_index, entry_key)
 
470
            self._id_index.setdefault(entry_key[2], set()).add(entry_key)
625
471
 
626
472
    def _bisect(self, paths):
627
473
        """Bisect through the disk structure for specific rows.
1054
900
 
1055
901
    def _discard_merge_parents(self):
1056
902
        """Discard any parents trees beyond the first.
1057
 
 
 
903
        
1058
904
        Note that if this fails the dirstate is corrupted.
1059
905
 
1060
906
        After this function returns the dirstate contains 2 trees, neither of
1091
937
 
1092
938
        self._ghosts = []
1093
939
        self._parents = [parents[0]]
1094
 
        self._mark_modified(header_modified=True)
 
940
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
941
        self._header_state = DirState.IN_MEMORY_MODIFIED
1095
942
 
1096
943
    def _empty_parent_info(self):
1097
944
        return [DirState.NULL_PARENT_DETAILS] * (len(self._parents) -
1129
976
                raise AssertionError("bad dirname %r" % dirname)
1130
977
        block_index, present = self._find_block_index_from_key((dirname, '', ''))
1131
978
        if not present:
1132
 
            ## In future, when doing partial parsing, this should load and
 
979
            ## In future, when doing partial parsing, this should load and 
1133
980
            # populate the entire block.
1134
981
            self._dirblocks.insert(block_index, (dirname, []))
1135
982
        return block_index
1147
994
        if new_entries[0][0][0:2] != ('', ''):
1148
995
            raise AssertionError(
1149
996
                "Missing root row %r" % (new_entries[0][0],))
1150
 
        # The two blocks here are deliberate: the root block and the
 
997
        # The two blocks here are deliberate: the root block and the 
1151
998
        # contents-of-root block.
1152
999
        self._dirblocks = [('', []), ('', [])]
1153
1000
        current_block = self._dirblocks[0][1]
1186
1033
        self._dirblocks[0] = ('', root_block)
1187
1034
        self._dirblocks[1] = ('', contents_of_root_block)
1188
1035
 
1189
 
    def _entries_for_path(self, path):
1190
 
        """Return a list with all the entries that match path for all ids."""
1191
 
        dirname, basename = os.path.split(path)
1192
 
        key = (dirname, basename, '')
1193
 
        block_index, present = self._find_block_index_from_key(key)
1194
 
        if not present:
1195
 
            # the block which should contain path is absent.
1196
 
            return []
1197
 
        result = []
1198
 
        block = self._dirblocks[block_index][1]
1199
 
        entry_index, _ = self._find_entry_index(key, block)
1200
 
        # we may need to look at multiple entries at this path: walk while the specific_files match.
1201
 
        while (entry_index < len(block) and
1202
 
            block[entry_index][0][0:2] == key[0:2]):
1203
 
            result.append(block[entry_index])
1204
 
            entry_index += 1
1205
 
        return result
1206
 
 
1207
1036
    def _entry_to_line(self, entry):
1208
1037
        """Serialize entry to a NULL delimited line ready for _get_output_lines.
1209
1038
 
1226
1055
    def _fields_per_entry(self):
1227
1056
        """How many null separated fields should be in each entry row.
1228
1057
 
1229
 
        Each line now has an extra '\\n' field which is not used
 
1058
        Each line now has an extra '\n' field which is not used
1230
1059
        so we just skip over it
1231
 
 
1232
 
        entry size::
 
1060
        entry size:
1233
1061
            3 fields for the key
1234
1062
            + number of fields per tree_data (5) * tree count
1235
1063
            + newline
1278
1106
        # one to use it. we use _right here because there are two
1279
1107
        # '' blocks - the root, and the contents of root
1280
1108
        # we always have a minimum of 2 in self._dirblocks: root and
1281
 
        # root-contents, and for '', we get 2 back, so this is
 
1109
        # root-contents, and for '', we get 2 back, so this is 
1282
1110
        # simple and correct:
1283
1111
        present = (block_index < len(self._dirblocks) and
1284
1112
            self._dirblocks[block_index][0] == key[0])
1313
1141
        return entry_index, present
1314
1142
 
1315
1143
    @staticmethod
1316
 
    def from_tree(tree, dir_state_filename, sha1_provider=None):
 
1144
    def from_tree(tree, dir_state_filename):
1317
1145
        """Create a dirstate from a bzr Tree.
1318
1146
 
1319
1147
        :param tree: The tree which should provide parent information and
1320
1148
            inventory ids.
1321
 
        :param sha1_provider: an object meeting the SHA1Provider interface.
1322
 
            If None, a DefaultSHA1Provider is used.
1323
1149
        :return: a DirState object which is currently locked for writing.
1324
1150
            (it was locked by DirState.initialize)
1325
1151
        """
1326
 
        result = DirState.initialize(dir_state_filename,
1327
 
            sha1_provider=sha1_provider)
 
1152
        result = DirState.initialize(dir_state_filename)
1328
1153
        try:
1329
1154
            tree.lock_read()
1330
1155
            try:
1348
1173
            raise
1349
1174
        return result
1350
1175
 
1351
 
    def _check_delta_is_valid(self, delta):
1352
 
        return list(inventory._check_delta_unique_ids(
1353
 
                    inventory._check_delta_unique_old_paths(
1354
 
                    inventory._check_delta_unique_new_paths(
1355
 
                    inventory._check_delta_ids_match_entry(
1356
 
                    inventory._check_delta_ids_are_valid(
1357
 
                    inventory._check_delta_new_path_entry_both_or_None(delta)))))))
1358
 
 
1359
1176
    def update_by_delta(self, delta):
1360
1177
        """Apply an inventory delta to the dirstate for tree 0
1361
1178
 
1362
 
        This is the workhorse for apply_inventory_delta in dirstate based
1363
 
        trees.
1364
 
 
1365
1179
        :param delta: An inventory delta.  See Inventory.apply_delta for
1366
1180
            details.
1367
1181
        """
1368
1182
        self._read_dirblocks_if_needed()
1369
 
        encode = cache_utf8.encode
1370
1183
        insertions = {}
1371
1184
        removals = {}
1372
 
        # Accumulate parent references (path_utf8, id), to check for parentless
1373
 
        # items or items placed under files/links/tree-references. We get
1374
 
        # references from every item in the delta that is not a deletion and
1375
 
        # is not itself the root.
1376
 
        parents = set()
1377
 
        # Added ids must not be in the dirstate already. This set holds those
1378
 
        # ids.
1379
 
        new_ids = set()
1380
 
        # This loop transforms the delta to single atomic operations that can
1381
 
        # be executed and validated.
1382
 
        delta = sorted(self._check_delta_is_valid(delta), reverse=True)
1383
 
        for old_path, new_path, file_id, inv_entry in delta:
 
1185
        for old_path, new_path, file_id, inv_entry in sorted(delta, reverse=True):
1384
1186
            if (file_id in insertions) or (file_id in removals):
1385
 
                self._raise_invalid(old_path or new_path, file_id,
1386
 
                    "repeated file_id")
 
1187
                raise AssertionError("repeated file id in delta %r" % (file_id,))
1387
1188
            if old_path is not None:
1388
1189
                old_path = old_path.encode('utf-8')
1389
1190
                removals[file_id] = old_path
1390
 
            else:
1391
 
                new_ids.add(file_id)
1392
1191
            if new_path is not None:
1393
 
                if inv_entry is None:
1394
 
                    self._raise_invalid(new_path, file_id,
1395
 
                        "new_path with no entry")
1396
1192
                new_path = new_path.encode('utf-8')
1397
 
                dirname_utf8, basename = osutils.split(new_path)
1398
 
                if basename:
1399
 
                    parents.add((dirname_utf8, inv_entry.parent_id))
1400
 
                key = (dirname_utf8, basename, file_id)
 
1193
                dirname, basename = osutils.split(new_path)
 
1194
                key = (dirname, basename, file_id)
1401
1195
                minikind = DirState._kind_to_minikind[inv_entry.kind]
1402
1196
                if minikind == 't':
1403
 
                    fingerprint = inv_entry.reference_revision or ''
 
1197
                    fingerprint = inv_entry.reference_revision
1404
1198
                else:
1405
1199
                    fingerprint = ''
1406
1200
                insertions[file_id] = (key, minikind, inv_entry.executable,
1415
1209
                    minikind = child[1][0][0]
1416
1210
                    fingerprint = child[1][0][4]
1417
1211
                    executable = child[1][0][3]
1418
 
                    old_child_path = osutils.pathjoin(child_dirname,
1419
 
                                                      child_basename)
 
1212
                    old_child_path = osutils.pathjoin(child[0][0],
 
1213
                                                      child[0][1])
1420
1214
                    removals[child[0][2]] = old_child_path
1421
1215
                    child_suffix = child_dirname[len(old_path):]
1422
1216
                    new_child_dirname = (new_path + child_suffix)
1423
1217
                    key = (new_child_dirname, child_basename, child[0][2])
1424
 
                    new_child_path = osutils.pathjoin(new_child_dirname,
1425
 
                                                      child_basename)
 
1218
                    new_child_path = os.path.join(new_child_dirname,
 
1219
                                                  child_basename)
1426
1220
                    insertions[child[0][2]] = (key, minikind, executable,
1427
1221
                                               fingerprint, new_child_path)
1428
 
        self._check_delta_ids_absent(new_ids, delta, 0)
1429
 
        try:
1430
 
            self._apply_removals(removals.iteritems())
1431
 
            self._apply_insertions(insertions.values())
1432
 
            # Validate parents
1433
 
            self._after_delta_check_parents(parents, 0)
1434
 
        except errors.BzrError, e:
1435
 
            self._changes_aborted = True
1436
 
            if 'integrity error' not in str(e):
1437
 
                raise
1438
 
            # _get_entry raises BzrError when a request is inconsistent; we
1439
 
            # want such errors to be shown as InconsistentDelta - and that 
1440
 
            # fits the behaviour we trigger.
1441
 
            raise errors.InconsistentDeltaDelta(delta,
1442
 
                "error from _get_entry. %s" % (e,))
 
1222
        self._apply_removals(removals.values())
 
1223
        self._apply_insertions(insertions.values())
1443
1224
 
1444
1225
    def _apply_removals(self, removals):
1445
 
        for file_id, path in sorted(removals, reverse=True,
1446
 
            key=operator.itemgetter(1)):
 
1226
        for path in sorted(removals, reverse=True):
1447
1227
            dirname, basename = osutils.split(path)
1448
1228
            block_i, entry_i, d_present, f_present = \
1449
1229
                self._get_block_entry_index(dirname, basename, 0)
1450
 
            try:
1451
 
                entry = self._dirblocks[block_i][1][entry_i]
1452
 
            except IndexError:
1453
 
                self._raise_invalid(path, file_id,
1454
 
                    "Wrong path for old path.")
1455
 
            if not f_present or entry[1][0][0] in 'ar':
1456
 
                self._raise_invalid(path, file_id,
1457
 
                    "Wrong path for old path.")
1458
 
            if file_id != entry[0][2]:
1459
 
                self._raise_invalid(path, file_id,
1460
 
                    "Attempt to remove path has wrong id - found %r."
1461
 
                    % entry[0][2])
 
1230
            entry = self._dirblocks[block_i][1][entry_i]
1462
1231
            self._make_absent(entry)
1463
1232
            # See if we have a malformed delta: deleting a directory must not
1464
1233
            # leave crud behind. This increases the number of bisects needed
1472
1241
                # be due to it being in a parent tree, or a corrupt delta.
1473
1242
                for child_entry in self._dirblocks[block_i][1]:
1474
1243
                    if child_entry[1][0][0] not in ('r', 'a'):
1475
 
                        self._raise_invalid(path, entry[0][2],
 
1244
                        raise errors.InconsistentDelta(path, entry[0][2],
1476
1245
                            "The file id was deleted but its children were "
1477
1246
                            "not deleted.")
1478
1247
 
1479
1248
    def _apply_insertions(self, adds):
1480
 
        try:
1481
 
            for key, minikind, executable, fingerprint, path_utf8 in sorted(adds):
1482
 
                self.update_minimal(key, minikind, executable, fingerprint,
1483
 
                                    path_utf8=path_utf8)
1484
 
        except errors.NotVersionedError:
1485
 
            self._raise_invalid(path_utf8.decode('utf8'), key[2],
1486
 
                "Missing parent")
 
1249
        for key, minikind, executable, fingerprint, path_utf8 in sorted(adds):
 
1250
            self.update_minimal(key, minikind, executable, fingerprint,
 
1251
                                path_utf8=path_utf8)
1487
1252
 
1488
1253
    def update_basis_by_delta(self, delta, new_revid):
1489
1254
        """Update the parents of this tree after a commit.
1496
1261
        Note that an exception during the operation of this method will leave
1497
1262
        the dirstate in a corrupt state where it should not be saved.
1498
1263
 
 
1264
        Finally, we expect all changes to be synchronising the basis tree with
 
1265
        the working tree.
 
1266
 
1499
1267
        :param new_revid: The new revision id for the trees parent.
1500
1268
        :param delta: An inventory delta (see apply_inventory_delta) describing
1501
1269
            the changes from the current left most parent revision to new_revid.
1513
1281
 
1514
1282
        self._parents[0] = new_revid
1515
1283
 
1516
 
        delta = sorted(self._check_delta_is_valid(delta), reverse=True)
 
1284
        delta = sorted(delta, reverse=True)
1517
1285
        adds = []
1518
1286
        changes = []
1519
1287
        deletes = []
1530
1298
        # At the same time, to reduce interface friction we convert the input
1531
1299
        # inventory entries to dirstate.
1532
1300
        root_only = ('', '')
1533
 
        # Accumulate parent references (path_utf8, id), to check for parentless
1534
 
        # items or items placed under files/links/tree-references. We get
1535
 
        # references from every item in the delta that is not a deletion and
1536
 
        # is not itself the root.
1537
 
        parents = set()
1538
 
        # Added ids must not be in the dirstate already. This set holds those
1539
 
        # ids.
1540
 
        new_ids = set()
1541
1301
        for old_path, new_path, file_id, inv_entry in delta:
1542
 
            if inv_entry is not None and file_id != inv_entry.file_id:
1543
 
                self._raise_invalid(new_path, file_id,
1544
 
                    "mismatched entry file_id %r" % inv_entry)
1545
 
            if new_path is None:
1546
 
                new_path_utf8 = None
1547
 
            else:
1548
 
                if inv_entry is None:
1549
 
                    self._raise_invalid(new_path, file_id,
1550
 
                        "new_path with no entry")
1551
 
                new_path_utf8 = encode(new_path)
1552
 
                # note the parent for validation
1553
 
                dirname_utf8, basename_utf8 = osutils.split(new_path_utf8)
1554
 
                if basename_utf8:
1555
 
                    parents.add((dirname_utf8, inv_entry.parent_id))
1556
 
            if old_path is None:
1557
 
                old_path_utf8 = None
1558
 
            else:
1559
 
                old_path_utf8 = encode(old_path)
1560
 
            if old_path is None:
1561
 
                adds.append((None, new_path_utf8, file_id,
 
1302
            if old_path is None:
 
1303
                adds.append((None, encode(new_path), file_id,
1562
1304
                    inv_to_entry(inv_entry), True))
1563
 
                new_ids.add(file_id)
1564
1305
            elif new_path is None:
1565
 
                deletes.append((old_path_utf8, None, file_id, None, True))
1566
 
            elif (old_path, new_path) == root_only:
1567
 
                # change things in-place
1568
 
                # Note: the case of a parent directory changing its file_id
1569
 
                #       tends to break optimizations here, because officially
1570
 
                #       the file has actually been moved, it just happens to
1571
 
                #       end up at the same path. If we can figure out how to
1572
 
                #       handle that case, we can avoid a lot of add+delete
1573
 
                #       pairs for objects that stay put.
1574
 
                # elif old_path == new_path:
1575
 
                changes.append((old_path_utf8, new_path_utf8, file_id,
1576
 
                                inv_to_entry(inv_entry)))
1577
 
            else:
 
1306
                deletes.append((encode(old_path), None, file_id, None, True))
 
1307
            elif (old_path, new_path) != root_only:
1578
1308
                # Renames:
1579
1309
                # Because renames must preserve their children we must have
1580
1310
                # processed all relocations and removes before hand. The sort
1589
1319
                # for 'r' items on every pass.
1590
1320
                self._update_basis_apply_deletes(deletes)
1591
1321
                deletes = []
 
1322
                new_path_utf8 = encode(new_path)
1592
1323
                # Split into an add/delete pair recursively.
1593
 
                adds.append((old_path_utf8, new_path_utf8, file_id,
1594
 
                             inv_to_entry(inv_entry), False))
 
1324
                adds.append((None, new_path_utf8, file_id,
 
1325
                    inv_to_entry(inv_entry), False))
1595
1326
                # Expunge deletes that we've seen so that deleted/renamed
1596
1327
                # children of a rename directory are handled correctly.
1597
 
                new_deletes = reversed(list(
1598
 
                    self._iter_child_entries(1, old_path_utf8)))
 
1328
                new_deletes = reversed(list(self._iter_child_entries(1,
 
1329
                    encode(old_path))))
1599
1330
                # Remove the current contents of the tree at orig_path, and
1600
1331
                # reinsert at the correct new path.
1601
1332
                for entry in new_deletes:
1602
 
                    child_dirname, child_basename, child_file_id = entry[0]
1603
 
                    if child_dirname:
1604
 
                        source_path = child_dirname + '/' + child_basename
 
1333
                    if entry[0][0]:
 
1334
                        source_path = entry[0][0] + '/' + entry[0][1]
1605
1335
                    else:
1606
 
                        source_path = child_basename
 
1336
                        source_path = entry[0][1]
1607
1337
                    if new_path_utf8:
1608
1338
                        target_path = new_path_utf8 + source_path[len(old_path):]
1609
1339
                    else:
1610
1340
                        if old_path == '':
1611
1341
                            raise AssertionError("cannot rename directory to"
1612
 
                                                 " itself")
 
1342
                                " itself")
1613
1343
                        target_path = source_path[len(old_path) + 1:]
1614
1344
                    adds.append((None, target_path, entry[0][2], entry[1][1], False))
1615
1345
                    deletes.append(
1616
1346
                        (source_path, target_path, entry[0][2], None, False))
1617
 
                deletes.append((old_path_utf8, new_path, file_id, None, False))
1618
 
        self._check_delta_ids_absent(new_ids, delta, 1)
1619
 
        try:
1620
 
            # Finish expunging deletes/first half of renames.
1621
 
            self._update_basis_apply_deletes(deletes)
1622
 
            # Reinstate second half of renames and new paths.
1623
 
            self._update_basis_apply_adds(adds)
1624
 
            # Apply in-situ changes.
1625
 
            self._update_basis_apply_changes(changes)
1626
 
            # Validate parents
1627
 
            self._after_delta_check_parents(parents, 1)
1628
 
        except errors.BzrError, e:
1629
 
            self._changes_aborted = True
1630
 
            if 'integrity error' not in str(e):
1631
 
                raise
1632
 
            # _get_entry raises BzrError when a request is inconsistent; we
1633
 
            # want such errors to be shown as InconsistentDelta - and that
1634
 
            # fits the behaviour we trigger.
1635
 
            raise errors.InconsistentDeltaDelta(delta,
1636
 
                "error from _get_entry. %s" % (e,))
1637
 
 
1638
 
        self._mark_modified(header_modified=True)
 
1347
                deletes.append(
 
1348
                    (encode(old_path), new_path, file_id, None, False))
 
1349
            else:
 
1350
                # changes to just the root should not require remove/insertion
 
1351
                # of everything.
 
1352
                changes.append((encode(old_path), encode(new_path), file_id,
 
1353
                    inv_to_entry(inv_entry)))
 
1354
 
 
1355
        # Finish expunging deletes/first half of renames.
 
1356
        self._update_basis_apply_deletes(deletes)
 
1357
        # Reinstate second half of renames and new paths.
 
1358
        self._update_basis_apply_adds(adds)
 
1359
        # Apply in-situ changes.
 
1360
        self._update_basis_apply_changes(changes)
 
1361
 
 
1362
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
1363
        self._header_state = DirState.IN_MEMORY_MODIFIED
1639
1364
        self._id_index = None
1640
1365
        return
1641
1366
 
1642
 
    def _check_delta_ids_absent(self, new_ids, delta, tree_index):
1643
 
        """Check that none of the file_ids in new_ids are present in a tree."""
1644
 
        if not new_ids:
1645
 
            return
1646
 
        id_index = self._get_id_index()
1647
 
        for file_id in new_ids:
1648
 
            for key in id_index.get(file_id, ()):
1649
 
                block_i, entry_i, d_present, f_present = \
1650
 
                    self._get_block_entry_index(key[0], key[1], tree_index)
1651
 
                if not f_present:
1652
 
                    # In a different tree
1653
 
                    continue
1654
 
                entry = self._dirblocks[block_i][1][entry_i]
1655
 
                if entry[0][2] != file_id:
1656
 
                    # Different file_id, so not what we want.
1657
 
                    continue
1658
 
                self._raise_invalid(("%s/%s" % key[0:2]).decode('utf8'), file_id,
1659
 
                    "This file_id is new in the delta but already present in "
1660
 
                    "the target")
1661
 
 
1662
 
    def _raise_invalid(self, path, file_id, reason):
1663
 
        self._changes_aborted = True
1664
 
        raise errors.InconsistentDelta(path, file_id, reason)
1665
 
 
1666
1367
    def _update_basis_apply_adds(self, adds):
1667
1368
        """Apply a sequence of adds to tree 1 during update_basis_by_delta.
1668
1369
 
1676
1377
        """
1677
1378
        # Adds are accumulated partly from renames, so can be in any input
1678
1379
        # order - sort it.
1679
 
        # TODO: we may want to sort in dirblocks order. That way each entry
1680
 
        #       will end up in the same directory, allowing the _get_entry
1681
 
        #       fast-path for looking up 2 items in the same dir work.
1682
 
        adds.sort(key=lambda x: x[1])
 
1380
        adds.sort()
1683
1381
        # adds is now in lexographic order, which places all parents before
1684
1382
        # their children, so we can process it linearly.
1685
1383
        absent = 'ar'
1686
 
        st = static_tuple.StaticTuple
1687
1384
        for old_path, new_path, file_id, new_details, real_add in adds:
1688
 
            dirname, basename = osutils.split(new_path)
1689
 
            entry_key = st(dirname, basename, file_id)
1690
 
            block_index, present = self._find_block_index_from_key(entry_key)
1691
 
            if not present:
1692
 
                self._raise_invalid(new_path, file_id,
1693
 
                    "Unable to find block for this record."
1694
 
                    " Was the parent added?")
1695
 
            block = self._dirblocks[block_index][1]
1696
 
            entry_index, present = self._find_entry_index(entry_key, block)
1697
 
            if real_add:
1698
 
                if old_path is not None:
1699
 
                    self._raise_invalid(new_path, file_id,
1700
 
                        'considered a real add but still had old_path at %s'
1701
 
                        % (old_path,))
1702
 
            if present:
1703
 
                entry = block[entry_index]
1704
 
                basis_kind = entry[1][1][0]
1705
 
                if basis_kind == 'a':
1706
 
                    entry[1][1] = new_details
1707
 
                elif basis_kind == 'r':
1708
 
                    raise NotImplementedError()
1709
 
                else:
1710
 
                    self._raise_invalid(new_path, file_id,
1711
 
                        "An entry was marked as a new add"
1712
 
                        " but the basis target already existed")
1713
 
            else:
1714
 
                # The exact key was not found in the block. However, we need to
1715
 
                # check if there is a key next to us that would have matched.
1716
 
                # We only need to check 2 locations, because there are only 2
1717
 
                # trees present.
1718
 
                for maybe_index in range(entry_index-1, entry_index+1):
1719
 
                    if maybe_index < 0 or maybe_index >= len(block):
1720
 
                        continue
1721
 
                    maybe_entry = block[maybe_index]
1722
 
                    if maybe_entry[0][:2] != (dirname, basename):
1723
 
                        # Just a random neighbor
1724
 
                        continue
1725
 
                    if maybe_entry[0][2] == file_id:
1726
 
                        raise AssertionError(
1727
 
                            '_find_entry_index didnt find a key match'
1728
 
                            ' but walking the data did, for %s'
1729
 
                            % (entry_key,))
1730
 
                    basis_kind = maybe_entry[1][1][0]
1731
 
                    if basis_kind not in 'ar':
1732
 
                        self._raise_invalid(new_path, file_id,
1733
 
                            "we have an add record for path, but the path"
1734
 
                            " is already present with another file_id %s"
1735
 
                            % (maybe_entry[0][2],))
1736
 
 
1737
 
                entry = (entry_key, [DirState.NULL_PARENT_DETAILS,
1738
 
                                     new_details])
1739
 
                block.insert(entry_index, entry)
1740
 
 
1741
 
            active_kind = entry[1][0][0]
1742
 
            if active_kind == 'a':
1743
 
                # The active record shows up as absent, this could be genuine,
1744
 
                # or it could be present at some other location. We need to
1745
 
                # verify.
1746
 
                id_index = self._get_id_index()
1747
 
                # The id_index may not be perfectly accurate for tree1, because
1748
 
                # we haven't been keeping it updated. However, it should be
1749
 
                # fine for tree0, and that gives us enough info for what we
1750
 
                # need
1751
 
                keys = id_index.get(file_id, ())
1752
 
                for key in keys:
1753
 
                    block_i, entry_i, d_present, f_present = \
1754
 
                        self._get_block_entry_index(key[0], key[1], 0)
1755
 
                    if not f_present:
1756
 
                        continue
1757
 
                    active_entry = self._dirblocks[block_i][1][entry_i]
1758
 
                    if (active_entry[0][2] != file_id):
1759
 
                        # Some other file is at this path, we don't need to
1760
 
                        # link it.
1761
 
                        continue
1762
 
                    real_active_kind = active_entry[1][0][0]
1763
 
                    if real_active_kind in 'ar':
1764
 
                        # We found a record, which was not *this* record,
1765
 
                        # which matches the file_id, but is not actually
1766
 
                        # present. Something seems *really* wrong.
1767
 
                        self._raise_invalid(new_path, file_id,
1768
 
                            "We found a tree0 entry that doesnt make sense")
1769
 
                    # Now, we've found a tree0 entry which matches the file_id
1770
 
                    # but is at a different location. So update them to be
1771
 
                    # rename records.
1772
 
                    active_dir, active_name = active_entry[0][:2]
1773
 
                    if active_dir:
1774
 
                        active_path = active_dir + '/' + active_name
1775
 
                    else:
1776
 
                        active_path = active_name
1777
 
                    active_entry[1][1] = st('r', new_path, 0, False, '')
1778
 
                    entry[1][0] = st('r', active_path, 0, False, '')
1779
 
            elif active_kind == 'r':
1780
 
                raise NotImplementedError()
1781
 
 
1782
 
            new_kind = new_details[0]
1783
 
            if new_kind == 'd':
1784
 
                self._ensure_block(block_index, entry_index, new_path)
 
1385
            # the entry for this file_id must be in tree 0.
 
1386
            entry = self._get_entry(0, file_id, new_path)
 
1387
            if entry[0] is None or entry[0][2] != file_id:
 
1388
                self._changes_aborted = True
 
1389
                raise errors.InconsistentDelta(new_path, file_id,
 
1390
                    'working tree does not contain new entry')
 
1391
            if real_add and entry[1][1][0] not in absent:
 
1392
                self._changes_aborted = True
 
1393
                raise errors.InconsistentDelta(new_path, file_id,
 
1394
                    'The entry was considered to be a genuinely new record,'
 
1395
                    ' but there was already an old record for it.')
 
1396
            # We don't need to update the target of an 'r' because the handling
 
1397
            # of renames turns all 'r' situations into a delete at the original
 
1398
            # location.
 
1399
            entry[1][1] = new_details
1785
1400
 
1786
1401
    def _update_basis_apply_changes(self, changes):
1787
1402
        """Apply a sequence of changes to tree 1 during update_basis_by_delta.
1792
1407
        absent = 'ar'
1793
1408
        for old_path, new_path, file_id, new_details in changes:
1794
1409
            # the entry for this file_id must be in tree 0.
1795
 
            entry = self._get_entry(1, file_id, new_path)
1796
 
            if entry[0] is None or entry[1][1][0] in 'ar':
1797
 
                self._raise_invalid(new_path, file_id,
1798
 
                    'changed entry considered not present')
 
1410
            entry = self._get_entry(0, file_id, new_path)
 
1411
            if entry[0] is None or entry[0][2] != file_id:
 
1412
                self._changes_aborted = True
 
1413
                raise errors.InconsistentDelta(new_path, file_id,
 
1414
                    'working tree does not contain new entry')
 
1415
            if (entry[1][0][0] in absent or
 
1416
                entry[1][1][0] in absent):
 
1417
                self._changes_aborted = True
 
1418
                raise errors.InconsistentDelta(new_path, file_id,
 
1419
                    'changed considered absent')
1799
1420
            entry[1][1] = new_details
1800
1421
 
1801
1422
    def _update_basis_apply_deletes(self, deletes):
1813
1434
        null = DirState.NULL_PARENT_DETAILS
1814
1435
        for old_path, new_path, file_id, _, real_delete in deletes:
1815
1436
            if real_delete != (new_path is None):
1816
 
                self._raise_invalid(old_path, file_id, "bad delete delta")
 
1437
                raise AssertionError("bad delete delta")
1817
1438
            # the entry for this file_id must be in tree 1.
1818
1439
            dirname, basename = osutils.split(old_path)
1819
1440
            block_index, entry_index, dir_present, file_present = \
1820
1441
                self._get_block_entry_index(dirname, basename, 1)
1821
1442
            if not file_present:
1822
 
                self._raise_invalid(old_path, file_id,
 
1443
                self._changes_aborted = True
 
1444
                raise errors.InconsistentDelta(old_path, file_id,
1823
1445
                    'basis tree does not contain removed entry')
1824
1446
            entry = self._dirblocks[block_index][1][entry_index]
1825
 
            # The state of the entry in the 'active' WT
1826
 
            active_kind = entry[1][0][0]
1827
1447
            if entry[0][2] != file_id:
1828
 
                self._raise_invalid(old_path, file_id,
 
1448
                self._changes_aborted = True
 
1449
                raise errors.InconsistentDelta(old_path, file_id,
1829
1450
                    'mismatched file_id in tree 1')
1830
 
            dir_block = ()
1831
 
            old_kind = entry[1][1][0]
1832
 
            if active_kind in 'ar':
1833
 
                # The active tree doesn't have this file_id.
1834
 
                # The basis tree is changing this record. If this is a
1835
 
                # rename, then we don't want the record here at all
1836
 
                # anymore. If it is just an in-place change, we want the
1837
 
                # record here, but we'll add it if we need to. So we just
1838
 
                # delete it
1839
 
                if active_kind == 'r':
1840
 
                    active_path = entry[1][0][1]
1841
 
                    active_entry = self._get_entry(0, file_id, active_path)
1842
 
                    if active_entry[1][1][0] != 'r':
1843
 
                        self._raise_invalid(old_path, file_id,
1844
 
                            "Dirstate did not have matching rename entries")
1845
 
                    elif active_entry[1][0][0] in 'ar':
1846
 
                        self._raise_invalid(old_path, file_id,
1847
 
                            "Dirstate had a rename pointing at an inactive"
1848
 
                            " tree0")
1849
 
                    active_entry[1][1] = null
 
1451
            if real_delete:
 
1452
                if entry[1][0][0] != 'a':
 
1453
                    self._changes_aborted = True
 
1454
                    raise errors.InconsistentDelta(old_path, file_id,
 
1455
                            'This was marked as a real delete, but the WT state'
 
1456
                            ' claims that it still exists and is versioned.')
1850
1457
                del self._dirblocks[block_index][1][entry_index]
1851
 
                if old_kind == 'd':
1852
 
                    # This was a directory, and the active tree says it
1853
 
                    # doesn't exist, and now the basis tree says it doesn't
1854
 
                    # exist. Remove its dirblock if present
1855
 
                    (dir_block_index,
1856
 
                     present) = self._find_block_index_from_key(
1857
 
                        (old_path, '', ''))
1858
 
                    if present:
1859
 
                        dir_block = self._dirblocks[dir_block_index][1]
1860
 
                        if not dir_block:
1861
 
                            # This entry is empty, go ahead and just remove it
1862
 
                            del self._dirblocks[dir_block_index]
1863
1458
            else:
1864
 
                # There is still an active record, so just mark this
1865
 
                # removed.
1866
 
                entry[1][1] = null
1867
 
                block_i, entry_i, d_present, f_present = \
1868
 
                    self._get_block_entry_index(old_path, '', 1)
1869
 
                if d_present:
1870
 
                    dir_block = self._dirblocks[block_i][1]
1871
 
            for child_entry in dir_block:
1872
 
                child_basis_kind = child_entry[1][1][0]
1873
 
                if child_basis_kind not in 'ar':
1874
 
                    self._raise_invalid(old_path, file_id,
1875
 
                        "The file id was deleted but its children were "
1876
 
                        "not deleted.")
1877
 
 
1878
 
    def _after_delta_check_parents(self, parents, index):
1879
 
        """Check that parents required by the delta are all intact.
1880
 
        
1881
 
        :param parents: An iterable of (path_utf8, file_id) tuples which are
1882
 
            required to be present in tree 'index' at path_utf8 with id file_id
1883
 
            and be a directory.
1884
 
        :param index: The column in the dirstate to check for parents in.
1885
 
        """
1886
 
        for dirname_utf8, file_id in parents:
1887
 
            # Get the entry - the ensures that file_id, dirname_utf8 exists and
1888
 
            # has the right file id.
1889
 
            entry = self._get_entry(index, file_id, dirname_utf8)
1890
 
            if entry[1] is None:
1891
 
                self._raise_invalid(dirname_utf8.decode('utf8'),
1892
 
                    file_id, "This parent is not present.")
1893
 
            # Parents of things must be directories
1894
 
            if entry[1][index][0] != 'd':
1895
 
                self._raise_invalid(dirname_utf8.decode('utf8'),
1896
 
                    file_id, "This parent is not a directory.")
1897
 
 
1898
 
    def _observed_sha1(self, entry, sha1, stat_value,
1899
 
        _stat_to_minikind=_stat_to_minikind, _pack_stat=pack_stat):
1900
 
        """Note the sha1 of a file.
1901
 
 
1902
 
        :param entry: The entry the sha1 is for.
1903
 
        :param sha1: The observed sha1.
1904
 
        :param stat_value: The os.lstat for the file.
 
1459
                if entry[1][0][0] == 'a':
 
1460
                    self._changes_aborted = True
 
1461
                    raise errors.InconsistentDelta(old_path, file_id,
 
1462
                        'The entry was considered a rename, but the source path'
 
1463
                        ' is marked as absent.')
 
1464
                    # For whatever reason, we were asked to rename an entry
 
1465
                    # that was originally marked as deleted. This could be
 
1466
                    # because we are renaming the parent directory, and the WT
 
1467
                    # current state has the file marked as deleted.
 
1468
                elif entry[1][0][0] == 'r':
 
1469
                    # implement the rename
 
1470
                    del self._dirblocks[block_index][1][entry_index]
 
1471
                else:
 
1472
                    # it is being resurrected here, so blank it out temporarily.
 
1473
                    self._dirblocks[block_index][1][entry_index][1][1] = null
 
1474
 
 
1475
    def update_entry(self, entry, abspath, stat_value,
 
1476
                     _stat_to_minikind=_stat_to_minikind,
 
1477
                     _pack_stat=pack_stat):
 
1478
        """Update the entry based on what is actually on disk.
 
1479
 
 
1480
        :param entry: This is the dirblock entry for the file in question.
 
1481
        :param abspath: The path on disk for this file.
 
1482
        :param stat_value: (optional) if we already have done a stat on the
 
1483
            file, re-use it.
 
1484
        :return: The sha1 hexdigest of the file (40 bytes) or link target of a
 
1485
                symlink.
1905
1486
        """
1906
1487
        try:
1907
1488
            minikind = _stat_to_minikind[stat_value.st_mode & 0170000]
1909
1490
            # Unhandled kind
1910
1491
            return None
1911
1492
        packed_stat = _pack_stat(stat_value)
 
1493
        (saved_minikind, saved_link_or_sha1, saved_file_size,
 
1494
         saved_executable, saved_packed_stat) = entry[1][0]
 
1495
 
 
1496
        if (minikind == saved_minikind
 
1497
            and packed_stat == saved_packed_stat):
 
1498
            # The stat hasn't changed since we saved, so we can re-use the
 
1499
            # saved sha hash.
 
1500
            if minikind == 'd':
 
1501
                return None
 
1502
 
 
1503
            # size should also be in packed_stat
 
1504
            if saved_file_size == stat_value.st_size:
 
1505
                return saved_link_or_sha1
 
1506
 
 
1507
        # If we have gotten this far, that means that we need to actually
 
1508
        # process this entry.
 
1509
        link_or_sha1 = None
1912
1510
        if minikind == 'f':
1913
 
            if self._cutoff_time is None:
1914
 
                self._sha_cutoff_time()
1915
 
            if (stat_value.st_mtime < self._cutoff_time
1916
 
                and stat_value.st_ctime < self._cutoff_time):
1917
 
                entry[1][0] = ('f', sha1, stat_value.st_size, entry[1][0][3],
1918
 
                               packed_stat)
1919
 
                self._mark_modified([entry])
 
1511
            link_or_sha1 = self._sha1_file(abspath)
 
1512
            executable = self._is_executable(stat_value.st_mode,
 
1513
                                             saved_executable)
 
1514
            if self._cutoff_time is None:
 
1515
                self._sha_cutoff_time()
 
1516
            if (stat_value.st_mtime < self._cutoff_time
 
1517
                and stat_value.st_ctime < self._cutoff_time):
 
1518
                entry[1][0] = ('f', link_or_sha1, stat_value.st_size,
 
1519
                               executable, packed_stat)
 
1520
            else:
 
1521
                entry[1][0] = ('f', '', stat_value.st_size,
 
1522
                               executable, DirState.NULLSTAT)
 
1523
        elif minikind == 'd':
 
1524
            link_or_sha1 = None
 
1525
            entry[1][0] = ('d', '', 0, False, packed_stat)
 
1526
            if saved_minikind != 'd':
 
1527
                # This changed from something into a directory. Make sure we
 
1528
                # have a directory block for it. This doesn't happen very
 
1529
                # often, so this doesn't have to be super fast.
 
1530
                block_index, entry_index, dir_present, file_present = \
 
1531
                    self._get_block_entry_index(entry[0][0], entry[0][1], 0)
 
1532
                self._ensure_block(block_index, entry_index,
 
1533
                                   osutils.pathjoin(entry[0][0], entry[0][1]))
 
1534
        elif minikind == 'l':
 
1535
            link_or_sha1 = self._read_link(abspath, saved_link_or_sha1)
 
1536
            if self._cutoff_time is None:
 
1537
                self._sha_cutoff_time()
 
1538
            if (stat_value.st_mtime < self._cutoff_time
 
1539
                and stat_value.st_ctime < self._cutoff_time):
 
1540
                entry[1][0] = ('l', link_or_sha1, stat_value.st_size,
 
1541
                               False, packed_stat)
 
1542
            else:
 
1543
                entry[1][0] = ('l', '', stat_value.st_size,
 
1544
                               False, DirState.NULLSTAT)
 
1545
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
1546
        return link_or_sha1
1920
1547
 
1921
1548
    def _sha_cutoff_time(self):
1922
1549
        """Return cutoff time.
1939
1566
        # when -Dhashcache is turned on, this is monkey-patched in to log
1940
1567
        # file reads
1941
1568
        trace.mutter("dirstate sha1 " + abspath)
1942
 
        return self._sha1_provider.sha1(abspath)
 
1569
        return osutils.sha_file_by_name(abspath)
1943
1570
 
1944
1571
    def _is_executable(self, mode, old_executable):
1945
1572
        """Is this file executable?"""
1958
1585
        #       already in memory. However, this really needs to be done at a
1959
1586
        #       higher level, because there either won't be anything on disk,
1960
1587
        #       or the thing on disk will be a file.
1961
 
        fs_encoding = osutils._fs_enc
1962
 
        if isinstance(abspath, unicode):
1963
 
            # abspath is defined as the path to pass to lstat. readlink is
1964
 
            # buggy in python < 2.6 (it doesn't encode unicode path into FS
1965
 
            # encoding), so we need to encode ourselves knowing that unicode
1966
 
            # paths are produced by UnicodeDirReader on purpose.
1967
 
            abspath = abspath.encode(fs_encoding)
1968
 
        target = os.readlink(abspath)
1969
 
        if fs_encoding not in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
1970
 
            # Change encoding if needed
1971
 
            target = target.decode(fs_encoding).encode('UTF-8')
1972
 
        return target
 
1588
        return os.readlink(abspath)
1973
1589
 
1974
1590
    def get_ghosts(self):
1975
1591
        """Return a list of the parent tree revision ids that are ghosts."""
1980
1596
        """Serialise the entire dirstate to a sequence of lines."""
1981
1597
        if (self._header_state == DirState.IN_MEMORY_UNMODIFIED and
1982
1598
            self._dirblock_state == DirState.IN_MEMORY_UNMODIFIED):
1983
 
            # read what's on disk.
 
1599
            # read whats on disk.
1984
1600
            self._state_file.seek(0)
1985
1601
            return self._state_file.readlines()
1986
1602
        lines = []
1987
1603
        lines.append(self._get_parents_line(self.get_parent_ids()))
1988
1604
        lines.append(self._get_ghosts_line(self._ghosts))
1989
 
        lines.extend(self._get_entry_lines())
 
1605
        # append the root line which is special cased
 
1606
        lines.extend(map(self._entry_to_line, self._iter_entries()))
1990
1607
        return self._get_output_lines(lines)
1991
1608
 
1992
1609
    def _get_ghosts_line(self, ghost_ids):
1997
1614
        """Create a line for the state file for parents information."""
1998
1615
        return '\0'.join([str(len(parent_ids))] + parent_ids)
1999
1616
 
2000
 
    def _get_entry_lines(self):
2001
 
        """Create lines for entries."""
2002
 
        return map(self._entry_to_line, self._iter_entries())
2003
 
 
2004
1617
    def _get_fields_to_entry(self):
2005
1618
        """Get a function which converts entry fields into a entry record.
2006
1619
 
2124
1737
            entry_index += 1
2125
1738
        return block_index, entry_index, True, False
2126
1739
 
2127
 
    def _get_entry(self, tree_index, fileid_utf8=None, path_utf8=None,
2128
 
                   include_deleted=False):
 
1740
    def _get_entry(self, tree_index, fileid_utf8=None, path_utf8=None):
2129
1741
        """Get the dirstate entry for path in tree tree_index.
2130
1742
 
2131
1743
        If either file_id or path is supplied, it is used as the key to lookup.
2139
1751
            trees.
2140
1752
        :param fileid_utf8: A utf8 file_id to look up.
2141
1753
        :param path_utf8: An utf8 path to be looked up.
2142
 
        :param include_deleted: If True, and performing a lookup via
2143
 
            fileid_utf8 rather than path_utf8, return an entry for deleted
2144
 
            (absent) paths.
2145
1754
        :return: The dirstate entry tuple for path, or (None, None)
2146
1755
        """
2147
1756
        self._read_dirblocks_if_needed()
2148
1757
        if path_utf8 is not None:
2149
1758
            if type(path_utf8) is not str:
2150
 
                raise errors.BzrError('path_utf8 is not a str: %s %r'
 
1759
                raise AssertionError('path_utf8 is not a str: %s %s'
2151
1760
                    % (type(path_utf8), path_utf8))
2152
1761
            # path lookups are faster
2153
1762
            dirname, basename = osutils.split(path_utf8)
2165
1774
                                          ' tree_index, file_id and path')
2166
1775
            return entry
2167
1776
        else:
2168
 
            possible_keys = self._get_id_index().get(fileid_utf8, ())
 
1777
            possible_keys = self._get_id_index().get(fileid_utf8, None)
2169
1778
            if not possible_keys:
2170
1779
                return None, None
2171
1780
            for key in possible_keys:
2182
1791
                entry_index, present = self._find_entry_index(key, block)
2183
1792
                if present:
2184
1793
                    entry = self._dirblocks[block_index][1][entry_index]
2185
 
                    # TODO: We might want to assert that entry[0][2] ==
2186
 
                    #       fileid_utf8.
2187
1794
                    if entry[1][tree_index][0] in 'fdlt':
2188
 
                        # this is the result we are looking for: the
 
1795
                        # this is the result we are looking for: the  
2189
1796
                        # real home of this file_id in this tree.
2190
1797
                        return entry
2191
1798
                    if entry[1][tree_index][0] == 'a':
2192
1799
                        # there is no home for this entry in this tree
2193
 
                        if include_deleted:
2194
 
                            return entry
2195
1800
                        return None, None
2196
1801
                    if entry[1][tree_index][0] != 'r':
2197
1802
                        raise AssertionError(
2205
1810
            return None, None
2206
1811
 
2207
1812
    @classmethod
2208
 
    def initialize(cls, path, sha1_provider=None):
 
1813
    def initialize(cls, path):
2209
1814
        """Create a new dirstate on path.
2210
1815
 
2211
1816
        The new dirstate will be an empty tree - that is it has no parents,
2212
1817
        and only a root node - which has id ROOT_ID.
2213
1818
 
2214
1819
        :param path: The name of the file for the dirstate.
2215
 
        :param sha1_provider: an object meeting the SHA1Provider interface.
2216
 
            If None, a DefaultSHA1Provider is used.
2217
1820
        :return: A write-locked DirState object.
2218
1821
        """
2219
1822
        # This constructs a new DirState object on a path, sets the _state_file
2221
1824
        # stock empty dirstate information - a root with ROOT_ID, no children,
2222
1825
        # and no parents. Finally it calls save() to ensure that this data will
2223
1826
        # persist.
2224
 
        if sha1_provider is None:
2225
 
            sha1_provider = DefaultSHA1Provider()
2226
 
        result = cls(path, sha1_provider)
 
1827
        result = cls(path)
2227
1828
        # root dir and root dir contents with no children.
2228
1829
        empty_tree_dirblocks = [('', []), ('', [])]
2229
1830
        # a new root directory, with a NULLSTAT.
2257
1858
            size = 0
2258
1859
            executable = False
2259
1860
        elif kind == 'symlink':
2260
 
            if inv_entry.symlink_target is None:
2261
 
                fingerprint = ''
2262
 
            else:
2263
 
                fingerprint = inv_entry.symlink_target.encode('utf8')
 
1861
            # We don't support non-ascii targets for symlinks yet.
 
1862
            fingerprint = str(inv_entry.symlink_target or '')
2264
1863
            size = 0
2265
1864
            executable = False
2266
1865
        elif kind == 'file':
2273
1872
            executable = False
2274
1873
        else:
2275
1874
            raise Exception("can't pack %s" % inv_entry)
2276
 
        return static_tuple.StaticTuple(minikind, fingerprint, size,
2277
 
                                        executable, tree_data)
 
1875
        return (minikind, fingerprint, size, executable, tree_data)
2278
1876
 
2279
1877
    def _iter_child_entries(self, tree_index, path_utf8):
2280
1878
        """Iterate over all the entries that are children of path_utf.
2281
1879
 
2282
 
        This only returns entries that are present (not in 'a', 'r') in
 
1880
        This only returns entries that are present (not in 'a', 'r') in 
2283
1881
        tree_index. tree_index data is not refreshed, so if tree 0 is used,
2284
1882
        results may differ from that obtained if paths were statted to
2285
1883
        determine what ones were directories.
2316
1914
                        else:
2317
1915
                            path = entry[0][1]
2318
1916
                        next_pending_dirs.append(path)
2319
 
 
 
1917
    
2320
1918
    def _iter_entries(self):
2321
1919
        """Iterate over all the entries in the dirstate.
2322
1920
 
2329
1927
                yield entry
2330
1928
 
2331
1929
    def _get_id_index(self):
2332
 
        """Get an id index of self._dirblocks.
2333
 
 
2334
 
        This maps from file_id => [(directory, name, file_id)] entries where
2335
 
        that file_id appears in one of the trees.
2336
 
        """
 
1930
        """Get an id index of self._dirblocks."""
2337
1931
        if self._id_index is None:
2338
1932
            id_index = {}
2339
1933
            for key, tree_details in self._iter_entries():
2340
 
                self._add_to_id_index(id_index, key)
 
1934
                id_index.setdefault(key[2], set()).add(key)
2341
1935
            self._id_index = id_index
2342
1936
        return self._id_index
2343
1937
 
2344
 
    def _add_to_id_index(self, id_index, entry_key):
2345
 
        """Add this entry to the _id_index mapping."""
2346
 
        # This code used to use a set for every entry in the id_index. However,
2347
 
        # it is *rare* to have more than one entry. So a set is a large
2348
 
        # overkill. And even when we do, we won't ever have more than the
2349
 
        # number of parent trees. Which is still a small number (rarely >2). As
2350
 
        # such, we use a simple tuple, and do our own uniqueness checks. While
2351
 
        # the 'in' check is O(N) since N is nicely bounded it shouldn't ever
2352
 
        # cause quadratic failure.
2353
 
        file_id = entry_key[2]
2354
 
        entry_key = static_tuple.StaticTuple.from_sequence(entry_key)
2355
 
        if file_id not in id_index:
2356
 
            id_index[file_id] = static_tuple.StaticTuple(entry_key,)
2357
 
        else:
2358
 
            entry_keys = id_index[file_id]
2359
 
            if entry_key not in entry_keys:
2360
 
                id_index[file_id] = entry_keys + (entry_key,)
2361
 
 
2362
 
    def _remove_from_id_index(self, id_index, entry_key):
2363
 
        """Remove this entry from the _id_index mapping.
2364
 
 
2365
 
        It is an programming error to call this when the entry_key is not
2366
 
        already present.
2367
 
        """
2368
 
        file_id = entry_key[2]
2369
 
        entry_keys = list(id_index[file_id])
2370
 
        entry_keys.remove(entry_key)
2371
 
        id_index[file_id] = static_tuple.StaticTuple.from_sequence(entry_keys)
2372
 
 
2373
1938
    def _get_output_lines(self, lines):
2374
1939
        """Format lines for final output.
2375
1940
 
2395
1960
        """The number of parent entries in each record row."""
2396
1961
        return len(self._parents) - len(self._ghosts)
2397
1962
 
2398
 
    @classmethod
2399
 
    def on_file(cls, path, sha1_provider=None, worth_saving_limit=0):
2400
 
        """Construct a DirState on the file at path "path".
 
1963
    @staticmethod
 
1964
    def on_file(path):
 
1965
        """Construct a DirState on the file at path path.
2401
1966
 
2402
 
        :param path: The path at which the dirstate file on disk should live.
2403
 
        :param sha1_provider: an object meeting the SHA1Provider interface.
2404
 
            If None, a DefaultSHA1Provider is used.
2405
 
        :param worth_saving_limit: when the exact number of hash changed
2406
 
            entries is known, only bother saving the dirstate if more than
2407
 
            this count of entries have changed. -1 means never save.
2408
1967
        :return: An unlocked DirState object, associated with the given path.
2409
1968
        """
2410
 
        if sha1_provider is None:
2411
 
            sha1_provider = DefaultSHA1Provider()
2412
 
        result = cls(path, sha1_provider,
2413
 
                     worth_saving_limit=worth_saving_limit)
 
1969
        result = DirState(path)
2414
1970
        return result
2415
1971
 
2416
1972
    def _read_dirblocks_if_needed(self):
2417
1973
        """Read in all the dirblocks from the file if they are not in memory.
2418
 
 
 
1974
        
2419
1975
        This populates self._dirblocks, and sets self._dirblock_state to
2420
1976
        IN_MEMORY_UNMODIFIED. It is not currently ready for incremental block
2421
1977
        loading.
2508
2064
            trace.mutter('Not saving DirState because '
2509
2065
                    '_changes_aborted is set.')
2510
2066
            return
2511
 
        # TODO: Since we now distinguish IN_MEMORY_MODIFIED from
2512
 
        #       IN_MEMORY_HASH_MODIFIED, we should only fail quietly if we fail
2513
 
        #       to save an IN_MEMORY_HASH_MODIFIED, and fail *noisily* if we
2514
 
        #       fail to save IN_MEMORY_MODIFIED
2515
 
        if not self._worth_saving():
2516
 
            return
 
2067
        if (self._header_state == DirState.IN_MEMORY_MODIFIED or
 
2068
            self._dirblock_state == DirState.IN_MEMORY_MODIFIED):
2517
2069
 
2518
 
        grabbed_write_lock = False
2519
 
        if self._lock_state != 'w':
2520
 
            grabbed_write_lock, new_lock = self._lock_token.temporary_write_lock()
2521
 
            # Switch over to the new lock, as the old one may be closed.
2522
 
            # TODO: jam 20070315 We should validate the disk file has
2523
 
            #       not changed contents, since temporary_write_lock may
2524
 
            #       not be an atomic operation.
2525
 
            self._lock_token = new_lock
2526
 
            self._state_file = new_lock.f
2527
 
            if not grabbed_write_lock:
2528
 
                # We couldn't grab a write lock, so we switch back to a read one
2529
 
                return
2530
 
        try:
2531
 
            lines = self.get_lines()
2532
 
            self._state_file.seek(0)
2533
 
            self._state_file.writelines(lines)
2534
 
            self._state_file.truncate()
2535
 
            self._state_file.flush()
2536
 
            self._maybe_fdatasync()
2537
 
            self._mark_unmodified()
2538
 
        finally:
2539
 
            if grabbed_write_lock:
2540
 
                self._lock_token = self._lock_token.restore_read_lock()
2541
 
                self._state_file = self._lock_token.f
 
2070
            grabbed_write_lock = False
 
2071
            if self._lock_state != 'w':
 
2072
                grabbed_write_lock, new_lock = self._lock_token.temporary_write_lock()
 
2073
                # Switch over to the new lock, as the old one may be closed.
2542
2074
                # TODO: jam 20070315 We should validate the disk file has
2543
 
                #       not changed contents. Since restore_read_lock may
2544
 
                #       not be an atomic operation.                
2545
 
 
2546
 
    def _maybe_fdatasync(self):
2547
 
        """Flush to disk if possible and if not configured off."""
2548
 
        if self._config_stack.get('dirstate.fdatasync'):
2549
 
            osutils.fdatasync(self._state_file.fileno())
2550
 
 
2551
 
    def _worth_saving(self):
2552
 
        """Is it worth saving the dirstate or not?"""
2553
 
        if (self._header_state == DirState.IN_MEMORY_MODIFIED
2554
 
            or self._dirblock_state == DirState.IN_MEMORY_MODIFIED):
2555
 
            return True
2556
 
        if self._dirblock_state == DirState.IN_MEMORY_HASH_MODIFIED:
2557
 
            if self._worth_saving_limit == -1:
2558
 
                # We never save hash changes when the limit is -1
2559
 
                return False
2560
 
            # If we're using smart saving and only a small number of
2561
 
            # entries have changed their hash, don't bother saving. John has
2562
 
            # suggested using a heuristic here based on the size of the
2563
 
            # changed files and/or tree. For now, we go with a configurable
2564
 
            # number of changes, keeping the calculation time
2565
 
            # as low overhead as possible. (This also keeps all existing
2566
 
            # tests passing as the default is 0, i.e. always save.)
2567
 
            if len(self._known_hash_changes) >= self._worth_saving_limit:
2568
 
                return True
2569
 
        return False
 
2075
                #       not changed contents. Since temporary_write_lock may
 
2076
                #       not be an atomic operation.
 
2077
                self._lock_token = new_lock
 
2078
                self._state_file = new_lock.f
 
2079
                if not grabbed_write_lock:
 
2080
                    # We couldn't grab a write lock, so we switch back to a read one
 
2081
                    return
 
2082
            try:
 
2083
                self._state_file.seek(0)
 
2084
                self._state_file.writelines(self.get_lines())
 
2085
                self._state_file.truncate()
 
2086
                self._state_file.flush()
 
2087
                self._header_state = DirState.IN_MEMORY_UNMODIFIED
 
2088
                self._dirblock_state = DirState.IN_MEMORY_UNMODIFIED
 
2089
            finally:
 
2090
                if grabbed_write_lock:
 
2091
                    self._lock_token = self._lock_token.restore_read_lock()
 
2092
                    self._state_file = self._lock_token.f
 
2093
                    # TODO: jam 20070315 We should validate the disk file has
 
2094
                    #       not changed contents. Since restore_read_lock may
 
2095
                    #       not be an atomic operation.
2570
2096
 
2571
2097
    def _set_data(self, parent_ids, dirblocks):
2572
2098
        """Set the full dirstate data in memory.
2576
2102
 
2577
2103
        :param parent_ids: A list of parent tree revision ids.
2578
2104
        :param dirblocks: A list containing one tuple for each directory in the
2579
 
            tree. Each tuple contains the directory path and a list of entries
 
2105
            tree. Each tuple contains the directory path and a list of entries 
2580
2106
            found in that directory.
2581
2107
        """
2582
2108
        # our memory copy is now authoritative.
2583
2109
        self._dirblocks = dirblocks
2584
 
        self._mark_modified(header_modified=True)
 
2110
        self._header_state = DirState.IN_MEMORY_MODIFIED
 
2111
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
2585
2112
        self._parents = list(parent_ids)
2586
2113
        self._id_index = None
2587
2114
        self._packed_stat_index = None
2607
2134
        self._make_absent(entry)
2608
2135
        self.update_minimal(('', '', new_id), 'd',
2609
2136
            path_utf8='', packed_stat=entry[1][0][4])
2610
 
        self._mark_modified()
2611
 
        # XXX: This was added by Ian, we need to make sure there
2612
 
        #      are tests for it, because it isn't in bzr.dev TRUNK
2613
 
        #      It looks like the only place it is called is in setting the root
2614
 
        #      id of the tree. So probably we never had an _id_index when we
2615
 
        #      don't even have a root yet.
 
2137
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
2616
2138
        if self._id_index is not None:
2617
 
            self._add_to_id_index(self._id_index, entry[0])
 
2139
            self._id_index.setdefault(new_id, set()).add(entry[0])
2618
2140
 
2619
2141
    def set_parent_trees(self, trees, ghosts):
2620
2142
        """Set the parent trees for the dirstate.
2621
2143
 
2622
2144
        :param trees: A list of revision_id, tree tuples. tree must be provided
2623
 
            even if the revision_id refers to a ghost: supply an empty tree in
 
2145
            even if the revision_id refers to a ghost: supply an empty tree in 
2624
2146
            this case.
2625
2147
        :param ghosts: A list of the revision_ids that are ghosts at the time
2626
2148
            of setting.
2627
 
        """
2628
 
        # TODO: generate a list of parent indexes to preserve to save
 
2149
        """ 
 
2150
        # TODO: generate a list of parent indexes to preserve to save 
2629
2151
        # processing specific parent trees. In the common case one tree will
2630
2152
        # be preserved - the left most parent.
2631
2153
        # TODO: if the parent tree is a dirstate, we might want to walk them
2636
2158
        # map and then walk the new parent trees only, mapping them into the
2637
2159
        # dirstate. Walk the dirstate at the same time to remove unreferenced
2638
2160
        # entries.
2639
 
        # for now:
2640
 
        # sketch: loop over all entries in the dirstate, cherry picking
 
2161
        # for now: 
 
2162
        # sketch: loop over all entries in the dirstate, cherry picking 
2641
2163
        # entries from the parent trees, if they are not ghost trees.
2642
2164
        # after we finish walking the dirstate, all entries not in the dirstate
2643
2165
        # are deletes, so we want to append them to the end as per the design
2648
2170
        #   links. We dont't trivially use the inventory from other trees
2649
2171
        #   because this leads to either double touching, or to accessing
2650
2172
        #   missing keys,
2651
 
        # - find other keys containing a path
2652
 
        # We accumulate each entry via this dictionary, including the root
 
2173
        # - find other keys containing a path 
 
2174
        # We accumulate each entry via this dictionary, including the root 
2653
2175
        by_path = {}
2654
2176
        id_index = {}
2655
2177
        # we could do parallel iterators, but because file id data may be
2659
2181
        # parent, but for now the common cases are adding a new parent (merge),
2660
2182
        # and replacing completely (commit), and commit is more common: so
2661
2183
        # optimise merge later.
2662
 
 
 
2184
        
2663
2185
        # ---- start generation of full tree mapping data
2664
2186
        # what trees should we use?
2665
2187
        parent_trees = [tree for rev_id, tree in trees if rev_id not in ghosts]
2666
 
        # how many trees do we end up with
 
2188
        # how many trees do we end up with 
2667
2189
        parent_count = len(parent_trees)
2668
 
        st = static_tuple.StaticTuple
2669
2190
 
2670
2191
        # one: the current tree
2671
2192
        for entry in self._iter_entries():
2674
2195
                continue
2675
2196
            by_path[entry[0]] = [entry[1][0]] + \
2676
2197
                [DirState.NULL_PARENT_DETAILS] * parent_count
2677
 
            # TODO: Possibly inline this, since we know it isn't present yet
2678
 
            #       id_index[entry[0][2]] = (entry[0],)
2679
 
            self._add_to_id_index(id_index, entry[0])
2680
 
 
 
2198
            id_index[entry[0][2]] = set([entry[0]])
 
2199
        
2681
2200
        # now the parent trees:
2682
2201
        for tree_index, tree in enumerate(parent_trees):
2683
2202
            # the index is off by one, adjust it.
2688
2207
            # the suffix is from tree_index+1:parent_count+1.
2689
2208
            new_location_suffix = [DirState.NULL_PARENT_DETAILS] * (parent_count - tree_index)
2690
2209
            # now stitch in all the entries from this tree
2691
 
            last_dirname = None
2692
 
            for path, entry in tree.iter_entries_by_dir():
 
2210
            for path, entry in tree.inventory.iter_entries_by_dir():
2693
2211
                # here we process each trees details for each item in the tree.
2694
2212
                # we first update any existing entries for the id at other paths,
2695
2213
                # then we either create or update the entry for the id at the
2698
2216
                # avoid checking all known paths for the id when generating a
2699
2217
                # new entry at this path: by adding the id->path mapping last,
2700
2218
                # all the mappings are valid and have correct relocation
2701
 
                # records where needed.
 
2219
                # records where needed. 
2702
2220
                file_id = entry.file_id
2703
2221
                path_utf8 = path.encode('utf8')
2704
2222
                dirname, basename = osutils.split(path_utf8)
2705
 
                if dirname == last_dirname:
2706
 
                    # Try to re-use objects as much as possible
2707
 
                    dirname = last_dirname
2708
 
                else:
2709
 
                    last_dirname = dirname
2710
 
                new_entry_key = st(dirname, basename, file_id)
 
2223
                new_entry_key = (dirname, basename, file_id)
2711
2224
                # tree index consistency: All other paths for this id in this tree
2712
2225
                # index must point to the correct path.
2713
 
                entry_keys = id_index.get(file_id, ())
2714
 
                for entry_key in entry_keys:
 
2226
                for entry_key in id_index.setdefault(file_id, set()):
2715
2227
                    # TODO:PROFILING: It might be faster to just update
2716
2228
                    # rather than checking if we need to, and then overwrite
2717
2229
                    # the one we are located at.
2720
2232
                        # other trees, so put absent pointers there
2721
2233
                        # This is the vertical axis in the matrix, all pointing
2722
2234
                        # to the real path.
2723
 
                        by_path[entry_key][tree_index] = st('r', path_utf8, 0,
2724
 
                                                            False, '')
2725
 
                # by path consistency: Insert into an existing path record
2726
 
                # (trivial), or add a new one with relocation pointers for the
2727
 
                # other tree indexes.
2728
 
                if new_entry_key in entry_keys:
2729
 
                    # there is already an entry where this data belongs, just
2730
 
                    # insert it.
 
2235
                        by_path[entry_key][tree_index] = ('r', path_utf8, 0, False, '')
 
2236
                # by path consistency: Insert into an existing path record (trivial), or 
 
2237
                # add a new one with relocation pointers for the other tree indexes.
 
2238
                if new_entry_key in id_index[file_id]:
 
2239
                    # there is already an entry where this data belongs, just insert it.
2731
2240
                    by_path[new_entry_key][tree_index] = \
2732
2241
                        self._inv_entry_to_details(entry)
2733
2242
                else:
2737
2246
                    new_details = []
2738
2247
                    for lookup_index in xrange(tree_index):
2739
2248
                        # boundary case: this is the first occurence of file_id
2740
 
                        # so there are no id_indexes, possibly take this out of
 
2249
                        # so there are no id_indexs, possibly take this out of
2741
2250
                        # the loop?
2742
 
                        if not len(entry_keys):
 
2251
                        if not len(id_index[file_id]):
2743
2252
                            new_details.append(DirState.NULL_PARENT_DETAILS)
2744
2253
                        else:
2745
2254
                            # grab any one entry, use it to find the right path.
2746
 
                            a_key = iter(entry_keys).next()
 
2255
                            # TODO: optimise this to reduce memory use in highly 
 
2256
                            # fragmented situations by reusing the relocation
 
2257
                            # records.
 
2258
                            a_key = iter(id_index[file_id]).next()
2747
2259
                            if by_path[a_key][lookup_index][0] in ('r', 'a'):
2748
 
                                # its a pointer or missing statement, use it as
2749
 
                                # is.
 
2260
                                # its a pointer or missing statement, use it as is.
2750
2261
                                new_details.append(by_path[a_key][lookup_index])
2751
2262
                            else:
2752
2263
                                # we have the right key, make a pointer to it.
2753
2264
                                real_path = ('/'.join(a_key[0:2])).strip('/')
2754
 
                                new_details.append(st('r', real_path, 0, False,
2755
 
                                                      ''))
 
2265
                                new_details.append(('r', real_path, 0, False, ''))
2756
2266
                    new_details.append(self._inv_entry_to_details(entry))
2757
2267
                    new_details.extend(new_location_suffix)
2758
2268
                    by_path[new_entry_key] = new_details
2759
 
                    self._add_to_id_index(id_index, new_entry_key)
 
2269
                    id_index[file_id].add(new_entry_key)
2760
2270
        # --- end generation of full tree mappings
2761
2271
 
2762
2272
        # sort and output all the entries
2764
2274
        self._entries_to_current_state(new_entries)
2765
2275
        self._parents = [rev_id for rev_id, tree in trees]
2766
2276
        self._ghosts = list(ghosts)
2767
 
        self._mark_modified(header_modified=True)
 
2277
        self._header_state = DirState.IN_MEMORY_MODIFIED
 
2278
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
2768
2279
        self._id_index = id_index
2769
2280
 
2770
2281
    def _sort_entries(self, entry_list):
2774
2285
        try to keep everything in sorted blocks all the time, but sometimes
2775
2286
        it's easier to sort after the fact.
2776
2287
        """
2777
 
        # When sorting, we usually have 10x more entries than directories. (69k
2778
 
        # total entries, 4k directories). So cache the results of splitting.
2779
 
        # Saving time and objects. Also, use StaticTuple to avoid putting all
2780
 
        # of these object into python's garbage collector.
2781
 
        split_dirs = {}
2782
 
        def _key(entry, _split_dirs=split_dirs, _st=static_tuple.StaticTuple):
 
2288
        def _key(entry):
2783
2289
            # sort by: directory parts, file name, file id
2784
 
            dirpath, fname, file_id = entry[0]
2785
 
            try:
2786
 
                split = _split_dirs[dirpath]
2787
 
            except KeyError:
2788
 
                split = _st.from_sequence(dirpath.split('/'))
2789
 
                _split_dirs[dirpath] = split
2790
 
            return _st(split, fname, file_id)
 
2290
            return entry[0][0].split('/'), entry[0][1], entry[0][2]
2791
2291
        return sorted(entry_list, key=_key)
2792
2292
 
2793
2293
    def set_state_from_inventory(self, new_inv):
2794
 
        """Set new_inv as the current state.
 
2294
        """Set new_inv as the current state. 
2795
2295
 
2796
2296
        This API is called by tree transform, and will usually occur with
2797
2297
        existing parent trees.
2801
2301
        if 'evil' in debug.debug_flags:
2802
2302
            trace.mutter_callsite(1,
2803
2303
                "set_state_from_inventory called; please mutate the tree instead")
2804
 
        tracing = 'dirstate' in debug.debug_flags
2805
 
        if tracing:
2806
 
            trace.mutter("set_state_from_inventory trace:")
2807
2304
        self._read_dirblocks_if_needed()
2808
2305
        # sketch:
2809
 
        # Two iterators: current data and new data, both in dirblock order.
 
2306
        # Two iterators: current data and new data, both in dirblock order. 
2810
2307
        # We zip them together, which tells about entries that are new in the
2811
2308
        # inventory, or removed in the inventory, or present in both and
2812
 
        # possibly changed.
 
2309
        # possibly changed.  
2813
2310
        #
2814
2311
        # You might think we could just synthesize a new dirstate directly
2815
2312
        # since we're processing it in the right order.  However, we need to
2818
2315
        new_iterator = new_inv.iter_entries_by_dir()
2819
2316
        # we will be modifying the dirstate, so we need a stable iterator. In
2820
2317
        # future we might write one, for now we just clone the state into a
2821
 
        # list using a copy so that we see every original item and don't have
2822
 
        # to adjust the position when items are inserted or deleted in the
2823
 
        # underlying dirstate.
 
2318
        # list - which is a shallow copy.
2824
2319
        old_iterator = iter(list(self._iter_entries()))
2825
2320
        # both must have roots so this is safe:
2826
2321
        current_new = new_iterator.next()
2860
2355
            # we make both end conditions explicit
2861
2356
            if not current_old:
2862
2357
                # old is finished: insert current_new into the state.
2863
 
                if tracing:
2864
 
                    trace.mutter("Appending from new '%s'.",
2865
 
                        new_path_utf8.decode('utf8'))
2866
2358
                self.update_minimal(new_entry_key, current_new_minikind,
2867
2359
                    executable=current_new[1].executable,
2868
 
                    path_utf8=new_path_utf8, fingerprint=fingerprint,
2869
 
                    fullscan=True)
 
2360
                    path_utf8=new_path_utf8, fingerprint=fingerprint)
2870
2361
                current_new = advance(new_iterator)
2871
2362
            elif not current_new:
2872
2363
                # new is finished
2873
 
                if tracing:
2874
 
                    trace.mutter("Truncating from old '%s/%s'.",
2875
 
                        current_old[0][0].decode('utf8'),
2876
 
                        current_old[0][1].decode('utf8'))
2877
2364
                self._make_absent(current_old)
2878
2365
                current_old = advance(old_iterator)
2879
2366
            elif new_entry_key == current_old[0]:
2886
2373
                # kind has changed.
2887
2374
                if (current_old[1][0][3] != current_new[1].executable or
2888
2375
                    current_old[1][0][0] != current_new_minikind):
2889
 
                    if tracing:
2890
 
                        trace.mutter("Updating in-place change '%s'.",
2891
 
                            new_path_utf8.decode('utf8'))
2892
2376
                    self.update_minimal(current_old[0], current_new_minikind,
2893
2377
                        executable=current_new[1].executable,
2894
 
                        path_utf8=new_path_utf8, fingerprint=fingerprint,
2895
 
                        fullscan=True)
 
2378
                        path_utf8=new_path_utf8, fingerprint=fingerprint)
2896
2379
                # both sides are dealt with, move on
2897
2380
                current_old = advance(old_iterator)
2898
2381
                current_new = advance(new_iterator)
2901
2384
                      and new_entry_key[1:] < current_old[0][1:])):
2902
2385
                # new comes before:
2903
2386
                # add a entry for this and advance new
2904
 
                if tracing:
2905
 
                    trace.mutter("Inserting from new '%s'.",
2906
 
                        new_path_utf8.decode('utf8'))
2907
2387
                self.update_minimal(new_entry_key, current_new_minikind,
2908
2388
                    executable=current_new[1].executable,
2909
 
                    path_utf8=new_path_utf8, fingerprint=fingerprint,
2910
 
                    fullscan=True)
 
2389
                    path_utf8=new_path_utf8, fingerprint=fingerprint)
2911
2390
                current_new = advance(new_iterator)
2912
2391
            else:
2913
2392
                # we've advanced past the place where the old key would be,
2914
2393
                # without seeing it in the new list.  so it must be gone.
2915
 
                if tracing:
2916
 
                    trace.mutter("Deleting from old '%s/%s'.",
2917
 
                        current_old[0][0].decode('utf8'),
2918
 
                        current_old[0][1].decode('utf8'))
2919
2394
                self._make_absent(current_old)
2920
2395
                current_old = advance(old_iterator)
2921
 
        self._mark_modified()
 
2396
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
2922
2397
        self._id_index = None
2923
2398
        self._packed_stat_index = None
2924
 
        if tracing:
2925
 
            trace.mutter("set_state_from_inventory complete.")
2926
 
 
2927
 
    def set_state_from_scratch(self, working_inv, parent_trees, parent_ghosts):
2928
 
        """Wipe the currently stored state and set it to something new.
2929
 
 
2930
 
        This is a hard-reset for the data we are working with.
2931
 
        """
2932
 
        # Technically, we really want a write lock, but until we write, we
2933
 
        # don't really need it.
2934
 
        self._requires_lock()
2935
 
        # root dir and root dir contents with no children. We have to have a
2936
 
        # root for set_state_from_inventory to work correctly.
2937
 
        empty_root = (('', '', inventory.ROOT_ID),
2938
 
                      [('d', '', 0, False, DirState.NULLSTAT)])
2939
 
        empty_tree_dirblocks = [('', [empty_root]), ('', [])]
2940
 
        self._set_data([], empty_tree_dirblocks)
2941
 
        self.set_state_from_inventory(working_inv)
2942
 
        self.set_parent_trees(parent_trees, parent_ghosts)
2943
2399
 
2944
2400
    def _make_absent(self, current_old):
2945
2401
        """Mark current_old - an entry - as absent for tree 0.
2971
2427
            block[1].pop(entry_index)
2972
2428
            # if we have an id_index in use, remove this key from it for this id.
2973
2429
            if self._id_index is not None:
2974
 
                self._remove_from_id_index(self._id_index, current_old[0])
 
2430
                self._id_index[current_old[0][2]].remove(current_old[0])
2975
2431
        # update all remaining keys for this id to record it as absent. The
2976
2432
        # existing details may either be the record we are marking as deleted
2977
2433
        # (if there were other trees with the id present at this path), or may
2990
2446
            if update_tree_details[0][0] == 'a': # absent
2991
2447
                raise AssertionError('bad row %r' % (update_tree_details,))
2992
2448
            update_tree_details[0] = DirState.NULL_PARENT_DETAILS
2993
 
        self._mark_modified()
 
2449
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
2994
2450
        return last_reference
2995
2451
 
2996
2452
    def update_minimal(self, key, minikind, executable=False, fingerprint='',
2997
 
        packed_stat=None, size=0, path_utf8=None, fullscan=False):
 
2453
                       packed_stat=None, size=0, path_utf8=None):
2998
2454
        """Update an entry to the state in tree 0.
2999
2455
 
3000
2456
        This will either create a new entry at 'key' or update an existing one.
3005
2461
        :param minikind: The type for the entry ('f' == 'file', 'd' ==
3006
2462
                'directory'), etc.
3007
2463
        :param executable: Should the executable bit be set?
3008
 
        :param fingerprint: Simple fingerprint for new entry: canonical-form
3009
 
            sha1 for files, referenced revision id for subtrees, etc.
 
2464
        :param fingerprint: Simple fingerprint for new entry: sha1 for files, 
 
2465
            referenced revision id for subtrees, etc.
3010
2466
        :param packed_stat: Packed stat value for new entry.
3011
2467
        :param size: Size information for new entry
3012
2468
        :param path_utf8: key[0] + '/' + key[1], just passed in to avoid doing
3013
2469
                extra computation.
3014
 
        :param fullscan: If True then a complete scan of the dirstate is being
3015
 
            done and checking for duplicate rows should not be done. This
3016
 
            should only be set by set_state_from_inventory and similar methods.
3017
2470
 
3018
2471
        If packed_stat and fingerprint are not given, they're invalidated in
3019
2472
        the entry.
3028
2481
        new_details = (minikind, fingerprint, size, executable, packed_stat)
3029
2482
        id_index = self._get_id_index()
3030
2483
        if not present:
3031
 
            # New record. Check there isn't a entry at this path already.
3032
 
            if not fullscan:
3033
 
                low_index, _ = self._find_entry_index(key[0:2] + ('',), block)
3034
 
                while low_index < len(block):
3035
 
                    entry = block[low_index]
3036
 
                    if entry[0][0:2] == key[0:2]:
3037
 
                        if entry[1][0][0] not in 'ar':
3038
 
                            # This entry has the same path (but a different id) as
3039
 
                            # the new entry we're adding, and is present in ths
3040
 
                            # tree.
3041
 
                            self._raise_invalid(
3042
 
                                ("%s/%s" % key[0:2]).decode('utf8'), key[2],
3043
 
                                "Attempt to add item at path already occupied by "
3044
 
                                "id %r" % entry[0][2])
3045
 
                        low_index += 1
3046
 
                    else:
3047
 
                        break
3048
2484
            # new entry, synthesis cross reference here,
3049
 
            existing_keys = id_index.get(key[2], ())
 
2485
            existing_keys = id_index.setdefault(key[2], set())
3050
2486
            if not existing_keys:
3051
2487
                # not currently in the state, simplest case
3052
2488
                new_entry = key, [new_details] + self._empty_parent_info()
3055
2491
                # grab one of them and use it to generate parent
3056
2492
                # relocation/absent entries.
3057
2493
                new_entry = key, [new_details]
3058
 
                # existing_keys can be changed as we iterate.
3059
 
                for other_key in tuple(existing_keys):
 
2494
                for other_key in existing_keys:
3060
2495
                    # change the record at other to be a pointer to this new
3061
2496
                    # record. The loop looks similar to the change to
3062
2497
                    # relocations when updating an existing record but its not:
3063
2498
                    # the test for existing kinds is different: this can be
3064
2499
                    # factored out to a helper though.
3065
 
                    other_block_index, present = self._find_block_index_from_key(
3066
 
                        other_key)
3067
 
                    if not present:
3068
 
                        raise AssertionError('could not find block for %s' % (
3069
 
                            other_key,))
3070
 
                    other_block = self._dirblocks[other_block_index][1]
3071
 
                    other_entry_index, present = self._find_entry_index(
3072
 
                        other_key, other_block)
3073
 
                    if not present:
3074
 
                        raise AssertionError(
3075
 
                            'update_minimal: could not find other entry for %s'
3076
 
                            % (other_key,))
 
2500
                    other_block_index, present = self._find_block_index_from_key(other_key)
 
2501
                    if not present:
 
2502
                        raise AssertionError('could not find block for %s' % (other_key,))
 
2503
                    other_entry_index, present = self._find_entry_index(other_key,
 
2504
                                            self._dirblocks[other_block_index][1])
 
2505
                    if not present:
 
2506
                        raise AssertionError('could not find entry for %s' % (other_key,))
3077
2507
                    if path_utf8 is None:
3078
2508
                        raise AssertionError('no path')
3079
 
                    # Turn this other location into a reference to the new
3080
 
                    # location. This also updates the aliased iterator
3081
 
                    # (current_old in set_state_from_inventory) so that the old
3082
 
                    # entry, if not already examined, is skipped over by that
3083
 
                    # loop.
3084
 
                    other_entry = other_block[other_entry_index]
3085
 
                    other_entry[1][0] = ('r', path_utf8, 0, False, '')
3086
 
                    if self._maybe_remove_row(other_block, other_entry_index,
3087
 
                                              id_index):
3088
 
                        # If the row holding this was removed, we need to
3089
 
                        # recompute where this entry goes
3090
 
                        entry_index, _ = self._find_entry_index(key, block)
 
2509
                    self._dirblocks[other_block_index][1][other_entry_index][1][0] = \
 
2510
                        ('r', path_utf8, 0, False, '')
3091
2511
 
3092
 
                # This loop:
3093
 
                # adds a tuple to the new details for each column
3094
 
                #  - either by copying an existing relocation pointer inside that column
3095
 
                #  - or by creating a new pointer to the right row inside that column
3096
2512
                num_present_parents = self._num_present_parents()
3097
 
                if num_present_parents:
3098
 
                    # TODO: This re-evaluates the existing_keys set, do we need
3099
 
                    #       to do that ourselves?
3100
 
                    other_key = list(existing_keys)[0]
3101
2513
                for lookup_index in xrange(1, num_present_parents + 1):
3102
2514
                    # grab any one entry, use it to find the right path.
3103
 
                    # TODO: optimise this to reduce memory use in highly
 
2515
                    # TODO: optimise this to reduce memory use in highly 
3104
2516
                    # fragmented situations by reusing the relocation
3105
2517
                    # records.
3106
2518
                    update_block_index, present = \
3110
2522
                    update_entry_index, present = \
3111
2523
                        self._find_entry_index(other_key, self._dirblocks[update_block_index][1])
3112
2524
                    if not present:
3113
 
                        raise AssertionError('update_minimal: could not find entry for %s' % (other_key,))
 
2525
                        raise AssertionError('could not find entry for %s' % (other_key,))
3114
2526
                    update_details = self._dirblocks[update_block_index][1][update_entry_index][1][lookup_index]
3115
2527
                    if update_details[0] in 'ar': # relocated, absent
3116
2528
                        # its a pointer or absent in lookup_index's tree, use
3121
2533
                        pointer_path = osutils.pathjoin(*other_key[0:2])
3122
2534
                        new_entry[1].append(('r', pointer_path, 0, False, ''))
3123
2535
            block.insert(entry_index, new_entry)
3124
 
            self._add_to_id_index(id_index, key)
 
2536
            existing_keys.add(key)
3125
2537
        else:
3126
 
            # Does the new state matter?
 
2538
            # Does the new state matter? 
3127
2539
            block[entry_index][1][0] = new_details
3128
2540
            # parents cannot be affected by what we do.
3129
 
            # other occurences of this id can be found
 
2541
            # other occurences of this id can be found 
3130
2542
            # from the id index.
3131
2543
            # ---
3132
2544
            # tree index consistency: All other paths for this id in this tree
3136
2548
            # converted to relocated.
3137
2549
            if path_utf8 is None:
3138
2550
                raise AssertionError('no path')
3139
 
            existing_keys = id_index.get(key[2], ())
3140
 
            if key not in existing_keys:
3141
 
                raise AssertionError('We found the entry in the blocks, but'
3142
 
                    ' the key is not in the id_index.'
3143
 
                    ' key: %s, existing_keys: %s' % (key, existing_keys))
3144
 
            for entry_key in existing_keys:
 
2551
            for entry_key in id_index.setdefault(key[2], set()):
3145
2552
                # TODO:PROFILING: It might be faster to just update
3146
2553
                # rather than checking if we need to, and then overwrite
3147
2554
                # the one we are located at.
3165
2572
            if not present:
3166
2573
                self._dirblocks.insert(block_index, (subdir_key[0], []))
3167
2574
 
3168
 
        self._mark_modified()
3169
 
 
3170
 
    def _maybe_remove_row(self, block, index, id_index):
3171
 
        """Remove index if it is absent or relocated across the row.
3172
 
        
3173
 
        id_index is updated accordingly.
3174
 
        :return: True if we removed the row, False otherwise
3175
 
        """
3176
 
        present_in_row = False
3177
 
        entry = block[index]
3178
 
        for column in entry[1]:
3179
 
            if column[0] not in 'ar':
3180
 
                present_in_row = True
3181
 
                break
3182
 
        if not present_in_row:
3183
 
            block.pop(index)
3184
 
            self._remove_from_id_index(id_index, entry[0])
3185
 
            return True
3186
 
        return False
 
2575
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
3187
2576
 
3188
2577
    def _validate(self):
3189
2578
        """Check that invariants on the dirblock are correct.
3190
2579
 
3191
 
        This can be useful in debugging; it shouldn't be necessary in
 
2580
        This can be useful in debugging; it shouldn't be necessary in 
3192
2581
        normal code.
3193
2582
 
3194
2583
        This must be called with a lock held.
3263
2652
        # For each file id, for each tree: either
3264
2653
        # the file id is not present at all; all rows with that id in the
3265
2654
        # key have it marked as 'absent'
3266
 
        # OR the file id is present under exactly one name; any other entries
 
2655
        # OR the file id is present under exactly one name; any other entries 
3267
2656
        # that mention that id point to the correct name.
3268
2657
        #
3269
2658
        # We check this with a dict per tree pointing either to the present
3316
2705
                        # absent; should not occur anywhere else
3317
2706
                        this_tree_map[file_id] = None, this_path
3318
2707
                    elif minikind == 'r':
3319
 
                        # relocation, must occur at expected location
 
2708
                        # relocation, must occur at expected location 
3320
2709
                        this_tree_map[file_id] = tree_state[1], this_path
3321
2710
                    else:
3322
2711
                        this_tree_map[file_id] = this_path, this_path
3324
2713
            if absent_positions == tree_count:
3325
2714
                raise AssertionError(
3326
2715
                    "entry %r has no data for any tree." % (entry,))
3327
 
        if self._id_index is not None:
3328
 
            for file_id, entry_keys in self._id_index.iteritems():
3329
 
                for entry_key in entry_keys:
3330
 
                    if entry_key[2] != file_id:
3331
 
                        raise AssertionError(
3332
 
                            'file_id %r did not match entry key %s'
3333
 
                            % (file_id, entry_key))
3334
 
                if len(entry_keys) != len(set(entry_keys)):
3335
 
                    raise AssertionError(
3336
 
                        'id_index contained non-unique data for %s'
3337
 
                        % (entry_keys,))
3338
2716
 
3339
2717
    def _wipe_state(self):
3340
2718
        """Forget all state information about the dirstate."""
3396
2774
            raise errors.ObjectNotLocked(self)
3397
2775
 
3398
2776
 
3399
 
def py_update_entry(state, entry, abspath, stat_value,
3400
 
                 _stat_to_minikind=DirState._stat_to_minikind,
3401
 
                 _pack_stat=pack_stat):
3402
 
    """Update the entry based on what is actually on disk.
3403
 
 
3404
 
    This function only calculates the sha if it needs to - if the entry is
3405
 
    uncachable, or clearly different to the first parent's entry, no sha
3406
 
    is calculated, and None is returned.
3407
 
 
3408
 
    :param state: The dirstate this entry is in.
3409
 
    :param entry: This is the dirblock entry for the file in question.
3410
 
    :param abspath: The path on disk for this file.
3411
 
    :param stat_value: The stat value done on the path.
3412
 
    :return: None, or The sha1 hexdigest of the file (40 bytes) or link
3413
 
        target of a symlink.
3414
 
    """
3415
 
    try:
3416
 
        minikind = _stat_to_minikind[stat_value.st_mode & 0170000]
3417
 
    except KeyError:
3418
 
        # Unhandled kind
3419
 
        return None
3420
 
    packed_stat = _pack_stat(stat_value)
3421
 
    (saved_minikind, saved_link_or_sha1, saved_file_size,
3422
 
     saved_executable, saved_packed_stat) = entry[1][0]
3423
 
 
3424
 
    if minikind == 'd' and saved_minikind == 't':
3425
 
        minikind = 't'
3426
 
    if (minikind == saved_minikind
3427
 
        and packed_stat == saved_packed_stat):
3428
 
        # The stat hasn't changed since we saved, so we can re-use the
3429
 
        # saved sha hash.
3430
 
        if minikind == 'd':
3431
 
            return None
3432
 
 
3433
 
        # size should also be in packed_stat
3434
 
        if saved_file_size == stat_value.st_size:
3435
 
            return saved_link_or_sha1
3436
 
 
3437
 
    # If we have gotten this far, that means that we need to actually
3438
 
    # process this entry.
3439
 
    link_or_sha1 = None
3440
 
    worth_saving = True
3441
 
    if minikind == 'f':
3442
 
        executable = state._is_executable(stat_value.st_mode,
3443
 
                                         saved_executable)
3444
 
        if state._cutoff_time is None:
3445
 
            state._sha_cutoff_time()
3446
 
        if (stat_value.st_mtime < state._cutoff_time
3447
 
            and stat_value.st_ctime < state._cutoff_time
3448
 
            and len(entry[1]) > 1
3449
 
            and entry[1][1][0] != 'a'):
3450
 
            # Could check for size changes for further optimised
3451
 
            # avoidance of sha1's. However the most prominent case of
3452
 
            # over-shaing is during initial add, which this catches.
3453
 
            # Besides, if content filtering happens, size and sha
3454
 
            # are calculated at the same time, so checking just the size
3455
 
            # gains nothing w.r.t. performance.
3456
 
            link_or_sha1 = state._sha1_file(abspath)
3457
 
            entry[1][0] = ('f', link_or_sha1, stat_value.st_size,
3458
 
                           executable, packed_stat)
3459
 
        else:
3460
 
            entry[1][0] = ('f', '', stat_value.st_size,
3461
 
                           executable, DirState.NULLSTAT)
3462
 
            worth_saving = False
3463
 
    elif minikind == 'd':
3464
 
        link_or_sha1 = None
3465
 
        entry[1][0] = ('d', '', 0, False, packed_stat)
3466
 
        if saved_minikind != 'd':
3467
 
            # This changed from something into a directory. Make sure we
3468
 
            # have a directory block for it. This doesn't happen very
3469
 
            # often, so this doesn't have to be super fast.
3470
 
            block_index, entry_index, dir_present, file_present = \
3471
 
                state._get_block_entry_index(entry[0][0], entry[0][1], 0)
3472
 
            state._ensure_block(block_index, entry_index,
3473
 
                               osutils.pathjoin(entry[0][0], entry[0][1]))
3474
 
        else:
3475
 
            worth_saving = False
3476
 
    elif minikind == 'l':
3477
 
        if saved_minikind == 'l':
3478
 
            worth_saving = False
3479
 
        link_or_sha1 = state._read_link(abspath, saved_link_or_sha1)
3480
 
        if state._cutoff_time is None:
3481
 
            state._sha_cutoff_time()
3482
 
        if (stat_value.st_mtime < state._cutoff_time
3483
 
            and stat_value.st_ctime < state._cutoff_time):
3484
 
            entry[1][0] = ('l', link_or_sha1, stat_value.st_size,
3485
 
                           False, packed_stat)
3486
 
        else:
3487
 
            entry[1][0] = ('l', '', stat_value.st_size,
3488
 
                           False, DirState.NULLSTAT)
3489
 
    if worth_saving:
3490
 
        state._mark_modified([entry])
3491
 
    return link_or_sha1
3492
 
 
3493
 
 
3494
 
class ProcessEntryPython(object):
3495
 
 
3496
 
    __slots__ = ["old_dirname_to_file_id", "new_dirname_to_file_id",
3497
 
        "last_source_parent", "last_target_parent", "include_unchanged",
3498
 
        "partial", "use_filesystem_for_exec", "utf8_decode",
3499
 
        "searched_specific_files", "search_specific_files",
3500
 
        "searched_exact_paths", "search_specific_file_parents", "seen_ids",
3501
 
        "state", "source_index", "target_index", "want_unversioned", "tree"]
3502
 
 
3503
 
    def __init__(self, include_unchanged, use_filesystem_for_exec,
3504
 
        search_specific_files, state, source_index, target_index,
3505
 
        want_unversioned, tree):
3506
 
        self.old_dirname_to_file_id = {}
3507
 
        self.new_dirname_to_file_id = {}
3508
 
        # Are we doing a partial iter_changes?
3509
 
        self.partial = search_specific_files != set([''])
3510
 
        # Using a list so that we can access the values and change them in
3511
 
        # nested scope. Each one is [path, file_id, entry]
3512
 
        self.last_source_parent = [None, None]
3513
 
        self.last_target_parent = [None, None]
3514
 
        self.include_unchanged = include_unchanged
3515
 
        self.use_filesystem_for_exec = use_filesystem_for_exec
3516
 
        self.utf8_decode = cache_utf8._utf8_decode
3517
 
        # for all search_indexs in each path at or under each element of
3518
 
        # search_specific_files, if the detail is relocated: add the id, and
3519
 
        # add the relocated path as one to search if its not searched already.
3520
 
        # If the detail is not relocated, add the id.
3521
 
        self.searched_specific_files = set()
3522
 
        # When we search exact paths without expanding downwards, we record
3523
 
        # that here.
3524
 
        self.searched_exact_paths = set()
3525
 
        self.search_specific_files = search_specific_files
3526
 
        # The parents up to the root of the paths we are searching.
3527
 
        # After all normal paths are returned, these specific items are returned.
3528
 
        self.search_specific_file_parents = set()
3529
 
        # The ids we've sent out in the delta.
3530
 
        self.seen_ids = set()
3531
 
        self.state = state
3532
 
        self.source_index = source_index
3533
 
        self.target_index = target_index
3534
 
        if target_index != 0:
3535
 
            # A lot of code in here depends on target_index == 0
3536
 
            raise errors.BzrError('unsupported target index')
3537
 
        self.want_unversioned = want_unversioned
3538
 
        self.tree = tree
3539
 
 
3540
 
    def _process_entry(self, entry, path_info, pathjoin=osutils.pathjoin):
3541
 
        """Compare an entry and real disk to generate delta information.
3542
 
 
3543
 
        :param path_info: top_relpath, basename, kind, lstat, abspath for
3544
 
            the path of entry. If None, then the path is considered absent in 
3545
 
            the target (Perhaps we should pass in a concrete entry for this ?)
3546
 
            Basename is returned as a utf8 string because we expect this
3547
 
            tuple will be ignored, and don't want to take the time to
3548
 
            decode.
3549
 
        :return: (iter_changes_result, changed). If the entry has not been
3550
 
            handled then changed is None. Otherwise it is False if no content
3551
 
            or metadata changes have occurred, and True if any content or
3552
 
            metadata change has occurred. If self.include_unchanged is True then
3553
 
            if changed is not None, iter_changes_result will always be a result
3554
 
            tuple. Otherwise, iter_changes_result is None unless changed is
3555
 
            True.
3556
 
        """
3557
 
        if self.source_index is None:
3558
 
            source_details = DirState.NULL_PARENT_DETAILS
3559
 
        else:
3560
 
            source_details = entry[1][self.source_index]
3561
 
        target_details = entry[1][self.target_index]
3562
 
        target_minikind = target_details[0]
3563
 
        if path_info is not None and target_minikind in 'fdlt':
3564
 
            if not (self.target_index == 0):
3565
 
                raise AssertionError()
3566
 
            link_or_sha1 = update_entry(self.state, entry,
3567
 
                abspath=path_info[4], stat_value=path_info[3])
3568
 
            # The entry may have been modified by update_entry
3569
 
            target_details = entry[1][self.target_index]
3570
 
            target_minikind = target_details[0]
3571
 
        else:
3572
 
            link_or_sha1 = None
3573
 
        file_id = entry[0][2]
3574
 
        source_minikind = source_details[0]
3575
 
        if source_minikind in 'fdltr' and target_minikind in 'fdlt':
3576
 
            # claimed content in both: diff
3577
 
            #   r    | fdlt   |      | add source to search, add id path move and perform
3578
 
            #        |        |      | diff check on source-target
3579
 
            #   r    | fdlt   |  a   | dangling file that was present in the basis.
3580
 
            #        |        |      | ???
3581
 
            if source_minikind in 'r':
3582
 
                # add the source to the search path to find any children it
3583
 
                # has.  TODO ? : only add if it is a container ?
3584
 
                if not osutils.is_inside_any(self.searched_specific_files,
3585
 
                                             source_details[1]):
3586
 
                    self.search_specific_files.add(source_details[1])
3587
 
                # generate the old path; this is needed for stating later
3588
 
                # as well.
3589
 
                old_path = source_details[1]
3590
 
                old_dirname, old_basename = os.path.split(old_path)
3591
 
                path = pathjoin(entry[0][0], entry[0][1])
3592
 
                old_entry = self.state._get_entry(self.source_index,
3593
 
                                             path_utf8=old_path)
3594
 
                # update the source details variable to be the real
3595
 
                # location.
3596
 
                if old_entry == (None, None):
3597
 
                    raise errors.CorruptDirstate(self.state._filename,
3598
 
                        "entry '%s/%s' is considered renamed from %r"
3599
 
                        " but source does not exist\n"
3600
 
                        "entry: %s" % (entry[0][0], entry[0][1], old_path, entry))
3601
 
                source_details = old_entry[1][self.source_index]
3602
 
                source_minikind = source_details[0]
3603
 
            else:
3604
 
                old_dirname = entry[0][0]
3605
 
                old_basename = entry[0][1]
3606
 
                old_path = path = None
3607
 
            if path_info is None:
3608
 
                # the file is missing on disk, show as removed.
3609
 
                content_change = True
3610
 
                target_kind = None
3611
 
                target_exec = False
3612
 
            else:
3613
 
                # source and target are both versioned and disk file is present.
3614
 
                target_kind = path_info[2]
3615
 
                if target_kind == 'directory':
3616
 
                    if path is None:
3617
 
                        old_path = path = pathjoin(old_dirname, old_basename)
3618
 
                    self.new_dirname_to_file_id[path] = file_id
3619
 
                    if source_minikind != 'd':
3620
 
                        content_change = True
3621
 
                    else:
3622
 
                        # directories have no fingerprint
3623
 
                        content_change = False
3624
 
                    target_exec = False
3625
 
                elif target_kind == 'file':
3626
 
                    if source_minikind != 'f':
3627
 
                        content_change = True
3628
 
                    else:
3629
 
                        # Check the sha. We can't just rely on the size as
3630
 
                        # content filtering may mean differ sizes actually
3631
 
                        # map to the same content
3632
 
                        if link_or_sha1 is None:
3633
 
                            # Stat cache miss:
3634
 
                            statvalue, link_or_sha1 = \
3635
 
                                self.state._sha1_provider.stat_and_sha1(
3636
 
                                path_info[4])
3637
 
                            self.state._observed_sha1(entry, link_or_sha1,
3638
 
                                statvalue)
3639
 
                        content_change = (link_or_sha1 != source_details[1])
3640
 
                    # Target details is updated at update_entry time
3641
 
                    if self.use_filesystem_for_exec:
3642
 
                        # We don't need S_ISREG here, because we are sure
3643
 
                        # we are dealing with a file.
3644
 
                        target_exec = bool(stat.S_IEXEC & path_info[3].st_mode)
3645
 
                    else:
3646
 
                        target_exec = target_details[3]
3647
 
                elif target_kind == 'symlink':
3648
 
                    if source_minikind != 'l':
3649
 
                        content_change = True
3650
 
                    else:
3651
 
                        content_change = (link_or_sha1 != source_details[1])
3652
 
                    target_exec = False
3653
 
                elif target_kind == 'tree-reference':
3654
 
                    if source_minikind != 't':
3655
 
                        content_change = True
3656
 
                    else:
3657
 
                        content_change = False
3658
 
                    target_exec = False
3659
 
                else:
3660
 
                    if path is None:
3661
 
                        path = pathjoin(old_dirname, old_basename)
3662
 
                    raise errors.BadFileKindError(path, path_info[2])
3663
 
            if source_minikind == 'd':
3664
 
                if path is None:
3665
 
                    old_path = path = pathjoin(old_dirname, old_basename)
3666
 
                self.old_dirname_to_file_id[old_path] = file_id
3667
 
            # parent id is the entry for the path in the target tree
3668
 
            if old_basename and old_dirname == self.last_source_parent[0]:
3669
 
                source_parent_id = self.last_source_parent[1]
3670
 
            else:
3671
 
                try:
3672
 
                    source_parent_id = self.old_dirname_to_file_id[old_dirname]
3673
 
                except KeyError:
3674
 
                    source_parent_entry = self.state._get_entry(self.source_index,
3675
 
                                                           path_utf8=old_dirname)
3676
 
                    source_parent_id = source_parent_entry[0][2]
3677
 
                if source_parent_id == entry[0][2]:
3678
 
                    # This is the root, so the parent is None
3679
 
                    source_parent_id = None
3680
 
                else:
3681
 
                    self.last_source_parent[0] = old_dirname
3682
 
                    self.last_source_parent[1] = source_parent_id
3683
 
            new_dirname = entry[0][0]
3684
 
            if entry[0][1] and new_dirname == self.last_target_parent[0]:
3685
 
                target_parent_id = self.last_target_parent[1]
3686
 
            else:
3687
 
                try:
3688
 
                    target_parent_id = self.new_dirname_to_file_id[new_dirname]
3689
 
                except KeyError:
3690
 
                    # TODO: We don't always need to do the lookup, because the
3691
 
                    #       parent entry will be the same as the source entry.
3692
 
                    target_parent_entry = self.state._get_entry(self.target_index,
3693
 
                                                           path_utf8=new_dirname)
3694
 
                    if target_parent_entry == (None, None):
3695
 
                        raise AssertionError(
3696
 
                            "Could not find target parent in wt: %s\nparent of: %s"
3697
 
                            % (new_dirname, entry))
3698
 
                    target_parent_id = target_parent_entry[0][2]
3699
 
                if target_parent_id == entry[0][2]:
3700
 
                    # This is the root, so the parent is None
3701
 
                    target_parent_id = None
3702
 
                else:
3703
 
                    self.last_target_parent[0] = new_dirname
3704
 
                    self.last_target_parent[1] = target_parent_id
3705
 
 
3706
 
            source_exec = source_details[3]
3707
 
            changed = (content_change
3708
 
                or source_parent_id != target_parent_id
3709
 
                or old_basename != entry[0][1]
3710
 
                or source_exec != target_exec
3711
 
                )
3712
 
            if not changed and not self.include_unchanged:
3713
 
                return None, False
3714
 
            else:
3715
 
                if old_path is None:
3716
 
                    old_path = path = pathjoin(old_dirname, old_basename)
3717
 
                    old_path_u = self.utf8_decode(old_path)[0]
3718
 
                    path_u = old_path_u
3719
 
                else:
3720
 
                    old_path_u = self.utf8_decode(old_path)[0]
3721
 
                    if old_path == path:
3722
 
                        path_u = old_path_u
3723
 
                    else:
3724
 
                        path_u = self.utf8_decode(path)[0]
3725
 
                source_kind = DirState._minikind_to_kind[source_minikind]
3726
 
                return (entry[0][2],
3727
 
                       (old_path_u, path_u),
3728
 
                       content_change,
3729
 
                       (True, True),
3730
 
                       (source_parent_id, target_parent_id),
3731
 
                       (self.utf8_decode(old_basename)[0], self.utf8_decode(entry[0][1])[0]),
3732
 
                       (source_kind, target_kind),
3733
 
                       (source_exec, target_exec)), changed
3734
 
        elif source_minikind in 'a' and target_minikind in 'fdlt':
3735
 
            # looks like a new file
3736
 
            path = pathjoin(entry[0][0], entry[0][1])
3737
 
            # parent id is the entry for the path in the target tree
3738
 
            # TODO: these are the same for an entire directory: cache em.
3739
 
            parent_id = self.state._get_entry(self.target_index,
3740
 
                                         path_utf8=entry[0][0])[0][2]
3741
 
            if parent_id == entry[0][2]:
3742
 
                parent_id = None
3743
 
            if path_info is not None:
3744
 
                # Present on disk:
3745
 
                if self.use_filesystem_for_exec:
3746
 
                    # We need S_ISREG here, because we aren't sure if this
3747
 
                    # is a file or not.
3748
 
                    target_exec = bool(
3749
 
                        stat.S_ISREG(path_info[3].st_mode)
3750
 
                        and stat.S_IEXEC & path_info[3].st_mode)
3751
 
                else:
3752
 
                    target_exec = target_details[3]
3753
 
                return (entry[0][2],
3754
 
                       (None, self.utf8_decode(path)[0]),
3755
 
                       True,
3756
 
                       (False, True),
3757
 
                       (None, parent_id),
3758
 
                       (None, self.utf8_decode(entry[0][1])[0]),
3759
 
                       (None, path_info[2]),
3760
 
                       (None, target_exec)), True
3761
 
            else:
3762
 
                # Its a missing file, report it as such.
3763
 
                return (entry[0][2],
3764
 
                       (None, self.utf8_decode(path)[0]),
3765
 
                       False,
3766
 
                       (False, True),
3767
 
                       (None, parent_id),
3768
 
                       (None, self.utf8_decode(entry[0][1])[0]),
3769
 
                       (None, None),
3770
 
                       (None, False)), True
3771
 
        elif source_minikind in 'fdlt' and target_minikind in 'a':
3772
 
            # unversioned, possibly, or possibly not deleted: we dont care.
3773
 
            # if its still on disk, *and* theres no other entry at this
3774
 
            # path [we dont know this in this routine at the moment -
3775
 
            # perhaps we should change this - then it would be an unknown.
3776
 
            old_path = pathjoin(entry[0][0], entry[0][1])
3777
 
            # parent id is the entry for the path in the target tree
3778
 
            parent_id = self.state._get_entry(self.source_index, path_utf8=entry[0][0])[0][2]
3779
 
            if parent_id == entry[0][2]:
3780
 
                parent_id = None
3781
 
            return (entry[0][2],
3782
 
                   (self.utf8_decode(old_path)[0], None),
3783
 
                   True,
3784
 
                   (True, False),
3785
 
                   (parent_id, None),
3786
 
                   (self.utf8_decode(entry[0][1])[0], None),
3787
 
                   (DirState._minikind_to_kind[source_minikind], None),
3788
 
                   (source_details[3], None)), True
3789
 
        elif source_minikind in 'fdlt' and target_minikind in 'r':
3790
 
            # a rename; could be a true rename, or a rename inherited from
3791
 
            # a renamed parent. TODO: handle this efficiently. Its not
3792
 
            # common case to rename dirs though, so a correct but slow
3793
 
            # implementation will do.
3794
 
            if not osutils.is_inside_any(self.searched_specific_files, target_details[1]):
3795
 
                self.search_specific_files.add(target_details[1])
3796
 
        elif source_minikind in 'ra' and target_minikind in 'ra':
3797
 
            # neither of the selected trees contain this file,
3798
 
            # so skip over it. This is not currently directly tested, but
3799
 
            # is indirectly via test_too_much.TestCommands.test_conflicts.
3800
 
            pass
3801
 
        else:
3802
 
            raise AssertionError("don't know how to compare "
3803
 
                "source_minikind=%r, target_minikind=%r"
3804
 
                % (source_minikind, target_minikind))
3805
 
        return None, None
3806
 
 
3807
 
    def __iter__(self):
3808
 
        return self
3809
 
 
3810
 
    def _gather_result_for_consistency(self, result):
3811
 
        """Check a result we will yield to make sure we are consistent later.
3812
 
        
3813
 
        This gathers result's parents into a set to output later.
3814
 
 
3815
 
        :param result: A result tuple.
3816
 
        """
3817
 
        if not self.partial or not result[0]:
3818
 
            return
3819
 
        self.seen_ids.add(result[0])
3820
 
        new_path = result[1][1]
3821
 
        if new_path:
3822
 
            # Not the root and not a delete: queue up the parents of the path.
3823
 
            self.search_specific_file_parents.update(
3824
 
                osutils.parent_directories(new_path.encode('utf8')))
3825
 
            # Add the root directory which parent_directories does not
3826
 
            # provide.
3827
 
            self.search_specific_file_parents.add('')
3828
 
 
3829
 
    def iter_changes(self):
3830
 
        """Iterate over the changes."""
3831
 
        utf8_decode = cache_utf8._utf8_decode
3832
 
        _cmp_by_dirs = cmp_by_dirs
3833
 
        _process_entry = self._process_entry
3834
 
        search_specific_files = self.search_specific_files
3835
 
        searched_specific_files = self.searched_specific_files
3836
 
        splitpath = osutils.splitpath
3837
 
        # sketch:
3838
 
        # compare source_index and target_index at or under each element of search_specific_files.
3839
 
        # follow the following comparison table. Note that we only want to do diff operations when
3840
 
        # the target is fdl because thats when the walkdirs logic will have exposed the pathinfo
3841
 
        # for the target.
3842
 
        # cases:
3843
 
        #
3844
 
        # Source | Target | disk | action
3845
 
        #   r    | fdlt   |      | add source to search, add id path move and perform
3846
 
        #        |        |      | diff check on source-target
3847
 
        #   r    | fdlt   |  a   | dangling file that was present in the basis.
3848
 
        #        |        |      | ???
3849
 
        #   r    |  a     |      | add source to search
3850
 
        #   r    |  a     |  a   |
3851
 
        #   r    |  r     |      | this path is present in a non-examined tree, skip.
3852
 
        #   r    |  r     |  a   | this path is present in a non-examined tree, skip.
3853
 
        #   a    | fdlt   |      | add new id
3854
 
        #   a    | fdlt   |  a   | dangling locally added file, skip
3855
 
        #   a    |  a     |      | not present in either tree, skip
3856
 
        #   a    |  a     |  a   | not present in any tree, skip
3857
 
        #   a    |  r     |      | not present in either tree at this path, skip as it
3858
 
        #        |        |      | may not be selected by the users list of paths.
3859
 
        #   a    |  r     |  a   | not present in either tree at this path, skip as it
3860
 
        #        |        |      | may not be selected by the users list of paths.
3861
 
        #  fdlt  | fdlt   |      | content in both: diff them
3862
 
        #  fdlt  | fdlt   |  a   | deleted locally, but not unversioned - show as deleted ?
3863
 
        #  fdlt  |  a     |      | unversioned: output deleted id for now
3864
 
        #  fdlt  |  a     |  a   | unversioned and deleted: output deleted id
3865
 
        #  fdlt  |  r     |      | relocated in this tree, so add target to search.
3866
 
        #        |        |      | Dont diff, we will see an r,fd; pair when we reach
3867
 
        #        |        |      | this id at the other path.
3868
 
        #  fdlt  |  r     |  a   | relocated in this tree, so add target to search.
3869
 
        #        |        |      | Dont diff, we will see an r,fd; pair when we reach
3870
 
        #        |        |      | this id at the other path.
3871
 
 
3872
 
        # TODO: jam 20070516 - Avoid the _get_entry lookup overhead by
3873
 
        #       keeping a cache of directories that we have seen.
3874
 
 
3875
 
        while search_specific_files:
3876
 
            # TODO: the pending list should be lexically sorted?  the
3877
 
            # interface doesn't require it.
3878
 
            current_root = search_specific_files.pop()
3879
 
            current_root_unicode = current_root.decode('utf8')
3880
 
            searched_specific_files.add(current_root)
3881
 
            # process the entries for this containing directory: the rest will be
3882
 
            # found by their parents recursively.
3883
 
            root_entries = self.state._entries_for_path(current_root)
3884
 
            root_abspath = self.tree.abspath(current_root_unicode)
3885
 
            try:
3886
 
                root_stat = os.lstat(root_abspath)
3887
 
            except OSError, e:
3888
 
                if e.errno == errno.ENOENT:
3889
 
                    # the path does not exist: let _process_entry know that.
3890
 
                    root_dir_info = None
3891
 
                else:
3892
 
                    # some other random error: hand it up.
3893
 
                    raise
3894
 
            else:
3895
 
                root_dir_info = ('', current_root,
3896
 
                    osutils.file_kind_from_stat_mode(root_stat.st_mode), root_stat,
3897
 
                    root_abspath)
3898
 
                if root_dir_info[2] == 'directory':
3899
 
                    if self.tree._directory_is_tree_reference(
3900
 
                        current_root.decode('utf8')):
3901
 
                        root_dir_info = root_dir_info[:2] + \
3902
 
                            ('tree-reference',) + root_dir_info[3:]
3903
 
 
3904
 
            if not root_entries and not root_dir_info:
3905
 
                # this specified path is not present at all, skip it.
3906
 
                continue
3907
 
            path_handled = False
3908
 
            for entry in root_entries:
3909
 
                result, changed = _process_entry(entry, root_dir_info)
3910
 
                if changed is not None:
3911
 
                    path_handled = True
3912
 
                    if changed:
3913
 
                        self._gather_result_for_consistency(result)
3914
 
                    if changed or self.include_unchanged:
3915
 
                        yield result
3916
 
            if self.want_unversioned and not path_handled and root_dir_info:
3917
 
                new_executable = bool(
3918
 
                    stat.S_ISREG(root_dir_info[3].st_mode)
3919
 
                    and stat.S_IEXEC & root_dir_info[3].st_mode)
3920
 
                yield (None,
3921
 
                       (None, current_root_unicode),
3922
 
                       True,
3923
 
                       (False, False),
3924
 
                       (None, None),
3925
 
                       (None, splitpath(current_root_unicode)[-1]),
3926
 
                       (None, root_dir_info[2]),
3927
 
                       (None, new_executable)
3928
 
                      )
3929
 
            initial_key = (current_root, '', '')
3930
 
            block_index, _ = self.state._find_block_index_from_key(initial_key)
3931
 
            if block_index == 0:
3932
 
                # we have processed the total root already, but because the
3933
 
                # initial key matched it we should skip it here.
3934
 
                block_index +=1
3935
 
            if root_dir_info and root_dir_info[2] == 'tree-reference':
3936
 
                current_dir_info = None
3937
 
            else:
3938
 
                dir_iterator = osutils._walkdirs_utf8(root_abspath, prefix=current_root)
3939
 
                try:
3940
 
                    current_dir_info = dir_iterator.next()
3941
 
                except OSError, e:
3942
 
                    # on win32, python2.4 has e.errno == ERROR_DIRECTORY, but
3943
 
                    # python 2.5 has e.errno == EINVAL,
3944
 
                    #            and e.winerror == ERROR_DIRECTORY
3945
 
                    e_winerror = getattr(e, 'winerror', None)
3946
 
                    win_errors = (ERROR_DIRECTORY, ERROR_PATH_NOT_FOUND)
3947
 
                    # there may be directories in the inventory even though
3948
 
                    # this path is not a file on disk: so mark it as end of
3949
 
                    # iterator
3950
 
                    if e.errno in (errno.ENOENT, errno.ENOTDIR, errno.EINVAL):
3951
 
                        current_dir_info = None
3952
 
                    elif (sys.platform == 'win32'
3953
 
                          and (e.errno in win_errors
3954
 
                               or e_winerror in win_errors)):
3955
 
                        current_dir_info = None
3956
 
                    else:
3957
 
                        raise
3958
 
                else:
3959
 
                    if current_dir_info[0][0] == '':
3960
 
                        # remove .bzr from iteration
3961
 
                        bzr_index = bisect.bisect_left(current_dir_info[1], ('.bzr',))
3962
 
                        if current_dir_info[1][bzr_index][0] != '.bzr':
3963
 
                            raise AssertionError()
3964
 
                        del current_dir_info[1][bzr_index]
3965
 
            # walk until both the directory listing and the versioned metadata
3966
 
            # are exhausted.
3967
 
            if (block_index < len(self.state._dirblocks) and
3968
 
                osutils.is_inside(current_root, self.state._dirblocks[block_index][0])):
3969
 
                current_block = self.state._dirblocks[block_index]
3970
 
            else:
3971
 
                current_block = None
3972
 
            while (current_dir_info is not None or
3973
 
                   current_block is not None):
3974
 
                if (current_dir_info and current_block
3975
 
                    and current_dir_info[0][0] != current_block[0]):
3976
 
                    if _cmp_by_dirs(current_dir_info[0][0], current_block[0]) < 0:
3977
 
                        # filesystem data refers to paths not covered by the dirblock.
3978
 
                        # this has two possibilities:
3979
 
                        # A) it is versioned but empty, so there is no block for it
3980
 
                        # B) it is not versioned.
3981
 
 
3982
 
                        # if (A) then we need to recurse into it to check for
3983
 
                        # new unknown files or directories.
3984
 
                        # if (B) then we should ignore it, because we don't
3985
 
                        # recurse into unknown directories.
3986
 
                        path_index = 0
3987
 
                        while path_index < len(current_dir_info[1]):
3988
 
                                current_path_info = current_dir_info[1][path_index]
3989
 
                                if self.want_unversioned:
3990
 
                                    if current_path_info[2] == 'directory':
3991
 
                                        if self.tree._directory_is_tree_reference(
3992
 
                                            current_path_info[0].decode('utf8')):
3993
 
                                            current_path_info = current_path_info[:2] + \
3994
 
                                                ('tree-reference',) + current_path_info[3:]
3995
 
                                    new_executable = bool(
3996
 
                                        stat.S_ISREG(current_path_info[3].st_mode)
3997
 
                                        and stat.S_IEXEC & current_path_info[3].st_mode)
3998
 
                                    yield (None,
3999
 
                                        (None, utf8_decode(current_path_info[0])[0]),
4000
 
                                        True,
4001
 
                                        (False, False),
4002
 
                                        (None, None),
4003
 
                                        (None, utf8_decode(current_path_info[1])[0]),
4004
 
                                        (None, current_path_info[2]),
4005
 
                                        (None, new_executable))
4006
 
                                # dont descend into this unversioned path if it is
4007
 
                                # a dir
4008
 
                                if current_path_info[2] in ('directory',
4009
 
                                                            'tree-reference'):
4010
 
                                    del current_dir_info[1][path_index]
4011
 
                                    path_index -= 1
4012
 
                                path_index += 1
4013
 
 
4014
 
                        # This dir info has been handled, go to the next
4015
 
                        try:
4016
 
                            current_dir_info = dir_iterator.next()
4017
 
                        except StopIteration:
4018
 
                            current_dir_info = None
4019
 
                    else:
4020
 
                        # We have a dirblock entry for this location, but there
4021
 
                        # is no filesystem path for this. This is most likely
4022
 
                        # because a directory was removed from the disk.
4023
 
                        # We don't have to report the missing directory,
4024
 
                        # because that should have already been handled, but we
4025
 
                        # need to handle all of the files that are contained
4026
 
                        # within.
4027
 
                        for current_entry in current_block[1]:
4028
 
                            # entry referring to file not present on disk.
4029
 
                            # advance the entry only, after processing.
4030
 
                            result, changed = _process_entry(current_entry, None)
4031
 
                            if changed is not None:
4032
 
                                if changed:
4033
 
                                    self._gather_result_for_consistency(result)
4034
 
                                if changed or self.include_unchanged:
4035
 
                                    yield result
4036
 
                        block_index +=1
4037
 
                        if (block_index < len(self.state._dirblocks) and
4038
 
                            osutils.is_inside(current_root,
4039
 
                                              self.state._dirblocks[block_index][0])):
4040
 
                            current_block = self.state._dirblocks[block_index]
4041
 
                        else:
4042
 
                            current_block = None
4043
 
                    continue
4044
 
                entry_index = 0
4045
 
                if current_block and entry_index < len(current_block[1]):
4046
 
                    current_entry = current_block[1][entry_index]
4047
 
                else:
4048
 
                    current_entry = None
4049
 
                advance_entry = True
4050
 
                path_index = 0
4051
 
                if current_dir_info and path_index < len(current_dir_info[1]):
4052
 
                    current_path_info = current_dir_info[1][path_index]
4053
 
                    if current_path_info[2] == 'directory':
4054
 
                        if self.tree._directory_is_tree_reference(
4055
 
                            current_path_info[0].decode('utf8')):
4056
 
                            current_path_info = current_path_info[:2] + \
4057
 
                                ('tree-reference',) + current_path_info[3:]
4058
 
                else:
4059
 
                    current_path_info = None
4060
 
                advance_path = True
4061
 
                path_handled = False
4062
 
                while (current_entry is not None or
4063
 
                    current_path_info is not None):
4064
 
                    if current_entry is None:
4065
 
                        # the check for path_handled when the path is advanced
4066
 
                        # will yield this path if needed.
4067
 
                        pass
4068
 
                    elif current_path_info is None:
4069
 
                        # no path is fine: the per entry code will handle it.
4070
 
                        result, changed = _process_entry(current_entry, current_path_info)
4071
 
                        if changed is not None:
4072
 
                            if changed:
4073
 
                                self._gather_result_for_consistency(result)
4074
 
                            if changed or self.include_unchanged:
4075
 
                                yield result
4076
 
                    elif (current_entry[0][1] != current_path_info[1]
4077
 
                          or current_entry[1][self.target_index][0] in 'ar'):
4078
 
                        # The current path on disk doesn't match the dirblock
4079
 
                        # record. Either the dirblock is marked as absent, or
4080
 
                        # the file on disk is not present at all in the
4081
 
                        # dirblock. Either way, report about the dirblock
4082
 
                        # entry, and let other code handle the filesystem one.
4083
 
 
4084
 
                        # Compare the basename for these files to determine
4085
 
                        # which comes first
4086
 
                        if current_path_info[1] < current_entry[0][1]:
4087
 
                            # extra file on disk: pass for now, but only
4088
 
                            # increment the path, not the entry
4089
 
                            advance_entry = False
4090
 
                        else:
4091
 
                            # entry referring to file not present on disk.
4092
 
                            # advance the entry only, after processing.
4093
 
                            result, changed = _process_entry(current_entry, None)
4094
 
                            if changed is not None:
4095
 
                                if changed:
4096
 
                                    self._gather_result_for_consistency(result)
4097
 
                                if changed or self.include_unchanged:
4098
 
                                    yield result
4099
 
                            advance_path = False
4100
 
                    else:
4101
 
                        result, changed = _process_entry(current_entry, current_path_info)
4102
 
                        if changed is not None:
4103
 
                            path_handled = True
4104
 
                            if changed:
4105
 
                                self._gather_result_for_consistency(result)
4106
 
                            if changed or self.include_unchanged:
4107
 
                                yield result
4108
 
                    if advance_entry and current_entry is not None:
4109
 
                        entry_index += 1
4110
 
                        if entry_index < len(current_block[1]):
4111
 
                            current_entry = current_block[1][entry_index]
4112
 
                        else:
4113
 
                            current_entry = None
4114
 
                    else:
4115
 
                        advance_entry = True # reset the advance flaga
4116
 
                    if advance_path and current_path_info is not None:
4117
 
                        if not path_handled:
4118
 
                            # unversioned in all regards
4119
 
                            if self.want_unversioned:
4120
 
                                new_executable = bool(
4121
 
                                    stat.S_ISREG(current_path_info[3].st_mode)
4122
 
                                    and stat.S_IEXEC & current_path_info[3].st_mode)
4123
 
                                try:
4124
 
                                    relpath_unicode = utf8_decode(current_path_info[0])[0]
4125
 
                                except UnicodeDecodeError:
4126
 
                                    raise errors.BadFilenameEncoding(
4127
 
                                        current_path_info[0], osutils._fs_enc)
4128
 
                                yield (None,
4129
 
                                    (None, relpath_unicode),
4130
 
                                    True,
4131
 
                                    (False, False),
4132
 
                                    (None, None),
4133
 
                                    (None, utf8_decode(current_path_info[1])[0]),
4134
 
                                    (None, current_path_info[2]),
4135
 
                                    (None, new_executable))
4136
 
                            # dont descend into this unversioned path if it is
4137
 
                            # a dir
4138
 
                            if current_path_info[2] in ('directory'):
4139
 
                                del current_dir_info[1][path_index]
4140
 
                                path_index -= 1
4141
 
                        # dont descend the disk iterator into any tree
4142
 
                        # paths.
4143
 
                        if current_path_info[2] == 'tree-reference':
4144
 
                            del current_dir_info[1][path_index]
4145
 
                            path_index -= 1
4146
 
                        path_index += 1
4147
 
                        if path_index < len(current_dir_info[1]):
4148
 
                            current_path_info = current_dir_info[1][path_index]
4149
 
                            if current_path_info[2] == 'directory':
4150
 
                                if self.tree._directory_is_tree_reference(
4151
 
                                    current_path_info[0].decode('utf8')):
4152
 
                                    current_path_info = current_path_info[:2] + \
4153
 
                                        ('tree-reference',) + current_path_info[3:]
4154
 
                        else:
4155
 
                            current_path_info = None
4156
 
                        path_handled = False
4157
 
                    else:
4158
 
                        advance_path = True # reset the advance flagg.
4159
 
                if current_block is not None:
4160
 
                    block_index += 1
4161
 
                    if (block_index < len(self.state._dirblocks) and
4162
 
                        osutils.is_inside(current_root, self.state._dirblocks[block_index][0])):
4163
 
                        current_block = self.state._dirblocks[block_index]
4164
 
                    else:
4165
 
                        current_block = None
4166
 
                if current_dir_info is not None:
4167
 
                    try:
4168
 
                        current_dir_info = dir_iterator.next()
4169
 
                    except StopIteration:
4170
 
                        current_dir_info = None
4171
 
        for result in self._iter_specific_file_parents():
4172
 
            yield result
4173
 
 
4174
 
    def _iter_specific_file_parents(self):
4175
 
        """Iter over the specific file parents."""
4176
 
        while self.search_specific_file_parents:
4177
 
            # Process the parent directories for the paths we were iterating.
4178
 
            # Even in extremely large trees this should be modest, so currently
4179
 
            # no attempt is made to optimise.
4180
 
            path_utf8 = self.search_specific_file_parents.pop()
4181
 
            if osutils.is_inside_any(self.searched_specific_files, path_utf8):
4182
 
                # We've examined this path.
4183
 
                continue
4184
 
            if path_utf8 in self.searched_exact_paths:
4185
 
                # We've examined this path.
4186
 
                continue
4187
 
            path_entries = self.state._entries_for_path(path_utf8)
4188
 
            # We need either one or two entries. If the path in
4189
 
            # self.target_index has moved (so the entry in source_index is in
4190
 
            # 'ar') then we need to also look for the entry for this path in
4191
 
            # self.source_index, to output the appropriate delete-or-rename.
4192
 
            selected_entries = []
4193
 
            found_item = False
4194
 
            for candidate_entry in path_entries:
4195
 
                # Find entries present in target at this path:
4196
 
                if candidate_entry[1][self.target_index][0] not in 'ar':
4197
 
                    found_item = True
4198
 
                    selected_entries.append(candidate_entry)
4199
 
                # Find entries present in source at this path:
4200
 
                elif (self.source_index is not None and
4201
 
                    candidate_entry[1][self.source_index][0] not in 'ar'):
4202
 
                    found_item = True
4203
 
                    if candidate_entry[1][self.target_index][0] == 'a':
4204
 
                        # Deleted, emit it here.
4205
 
                        selected_entries.append(candidate_entry)
4206
 
                    else:
4207
 
                        # renamed, emit it when we process the directory it
4208
 
                        # ended up at.
4209
 
                        self.search_specific_file_parents.add(
4210
 
                            candidate_entry[1][self.target_index][1])
4211
 
            if not found_item:
4212
 
                raise AssertionError(
4213
 
                    "Missing entry for specific path parent %r, %r" % (
4214
 
                    path_utf8, path_entries))
4215
 
            path_info = self._path_info(path_utf8, path_utf8.decode('utf8'))
4216
 
            for entry in selected_entries:
4217
 
                if entry[0][2] in self.seen_ids:
4218
 
                    continue
4219
 
                result, changed = self._process_entry(entry, path_info)
4220
 
                if changed is None:
4221
 
                    raise AssertionError(
4222
 
                        "Got entry<->path mismatch for specific path "
4223
 
                        "%r entry %r path_info %r " % (
4224
 
                        path_utf8, entry, path_info))
4225
 
                # Only include changes - we're outside the users requested
4226
 
                # expansion.
4227
 
                if changed:
4228
 
                    self._gather_result_for_consistency(result)
4229
 
                    if (result[6][0] == 'directory' and
4230
 
                        result[6][1] != 'directory'):
4231
 
                        # This stopped being a directory, the old children have
4232
 
                        # to be included.
4233
 
                        if entry[1][self.source_index][0] == 'r':
4234
 
                            # renamed, take the source path
4235
 
                            entry_path_utf8 = entry[1][self.source_index][1]
4236
 
                        else:
4237
 
                            entry_path_utf8 = path_utf8
4238
 
                        initial_key = (entry_path_utf8, '', '')
4239
 
                        block_index, _ = self.state._find_block_index_from_key(
4240
 
                            initial_key)
4241
 
                        if block_index == 0:
4242
 
                            # The children of the root are in block index 1.
4243
 
                            block_index +=1
4244
 
                        current_block = None
4245
 
                        if block_index < len(self.state._dirblocks):
4246
 
                            current_block = self.state._dirblocks[block_index]
4247
 
                            if not osutils.is_inside(
4248
 
                                entry_path_utf8, current_block[0]):
4249
 
                                # No entries for this directory at all.
4250
 
                                current_block = None
4251
 
                        if current_block is not None:
4252
 
                            for entry in current_block[1]:
4253
 
                                if entry[1][self.source_index][0] in 'ar':
4254
 
                                    # Not in the source tree, so doesn't have to be
4255
 
                                    # included.
4256
 
                                    continue
4257
 
                                # Path of the entry itself.
4258
 
 
4259
 
                                self.search_specific_file_parents.add(
4260
 
                                    osutils.pathjoin(*entry[0][:2]))
4261
 
                if changed or self.include_unchanged:
4262
 
                    yield result
4263
 
            self.searched_exact_paths.add(path_utf8)
4264
 
 
4265
 
    def _path_info(self, utf8_path, unicode_path):
4266
 
        """Generate path_info for unicode_path.
4267
 
 
4268
 
        :return: None if unicode_path does not exist, or a path_info tuple.
4269
 
        """
4270
 
        abspath = self.tree.abspath(unicode_path)
4271
 
        try:
4272
 
            stat = os.lstat(abspath)
4273
 
        except OSError, e:
4274
 
            if e.errno == errno.ENOENT:
4275
 
                # the path does not exist.
4276
 
                return None
4277
 
            else:
4278
 
                raise
4279
 
        utf8_basename = utf8_path.rsplit('/', 1)[-1]
4280
 
        dir_info = (utf8_path, utf8_basename,
4281
 
            osutils.file_kind_from_stat_mode(stat.st_mode), stat,
4282
 
            abspath)
4283
 
        if dir_info[2] == 'directory':
4284
 
            if self.tree._directory_is_tree_reference(
4285
 
                unicode_path):
4286
 
                self.root_dir_info = self.root_dir_info[:2] + \
4287
 
                    ('tree-reference',) + self.root_dir_info[3:]
4288
 
        return dir_info
4289
 
 
4290
 
 
4291
2777
# Try to load the compiled form if possible
4292
2778
try:
4293
 
    from bzrlib._dirstate_helpers_pyx import (
4294
 
        _read_dirblocks,
4295
 
        bisect_dirblock,
4296
 
        _bisect_path_left,
4297
 
        _bisect_path_right,
4298
 
        cmp_by_dirs,
4299
 
        ProcessEntryC as _process_entry,
4300
 
        update_entry as update_entry,
 
2779
    from bzrlib._dirstate_helpers_c import (
 
2780
        _read_dirblocks_c as _read_dirblocks,
 
2781
        bisect_dirblock_c as bisect_dirblock,
 
2782
        _bisect_path_left_c as _bisect_path_left,
 
2783
        _bisect_path_right_c as _bisect_path_right,
 
2784
        cmp_by_dirs_c as cmp_by_dirs,
4301
2785
        )
4302
 
except ImportError, e:
4303
 
    osutils.failed_to_load_extension(e)
 
2786
except ImportError:
4304
2787
    from bzrlib._dirstate_helpers_py import (
4305
 
        _read_dirblocks,
4306
 
        bisect_dirblock,
4307
 
        _bisect_path_left,
4308
 
        _bisect_path_right,
4309
 
        cmp_by_dirs,
 
2788
        _read_dirblocks_py as _read_dirblocks,
 
2789
        bisect_dirblock_py as bisect_dirblock,
 
2790
        _bisect_path_left_py as _bisect_path_left,
 
2791
        _bisect_path_right_py as _bisect_path_right,
 
2792
        cmp_by_dirs_py as cmp_by_dirs,
4310
2793
        )
4311
 
    # FIXME: It would be nice to be able to track moved lines so that the
4312
 
    # corresponding python code can be moved to the _dirstate_helpers_py
4313
 
    # module. I don't want to break the history for this important piece of
4314
 
    # code so I left the code here -- vila 20090622
4315
 
    update_entry = py_update_entry
4316
 
    _process_entry = ProcessEntryPython