~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/dirstate.py

  • Committer: Patch Queue Manager
  • Date: 2015-09-30 16:43:21 UTC
  • mfrom: (6603.2.2 fix-keep-dirty)
  • Revision ID: pqm@pqm.ubuntu.com-20150930164321-ct2v2qnmvimqt8qf
(vila) Avoid associating dirty patch headers with the previous file in the
 patch. (Colin Watson)

Show diffs side-by-side

added added

removed removed

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