~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/dirstate.py

  • Committer: Launchpad Translations on behalf of bzr-core
  • Date: 2012-11-17 04:30:28 UTC
  • mto: (6581.1.1 trunk)
  • mto: This revision was merged to the branch mainline in revision 6582.
  • Revision ID: launchpad_translations_on_behalf_of_bzr-core-20121117043028-bwwosyrarodgpq1x
Launchpad automatic translations update.

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 2", NL;
33
 
full checksum = "crc32: ", ["-"], WHOLE_NUMBER, NL;
34
 
row count = "num_entries: ", digit, 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
118
133
where we need id->path mapping; we also usually read the whole file, so
119
134
I'm going to skip that for the moment, as we have the ability to locate
120
135
via bisect any path in any tree, and if we lookup things by path, we can
121
 
accumulate a id->path mapping as we go, which will tend to match what we
 
136
accumulate an id->path mapping as we go, which will tend to match what we
122
137
looked for.
123
138
 
124
139
I plan to implement this asap, so please speak up now to alter/tweak the
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
 
 because we wont want to restat all files on disk just because a lock was
 
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
 
      exact matches, or grab all elements and sorta.
166
 
    - Whats 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 
168
 
      go with what seems reasonably.
 
182
      exact matches, or grab all elements and sort.
 
183
    - What's the risk of error here? Once we have the base format being processed
 
184
      we should have a net win regardless of optimality. So we are going to
 
185
      go with what seems reasonable.
 
186
 
169
187
open questions:
170
188
 
171
 
maybe we should do a test profile of these core structure - 10K simulated searches/lookups/etc?
 
189
Maybe we should do a test profile of the core structure - 10K simulated
 
190
searches/lookups/etc?
172
191
 
173
192
Objects for each row?
174
193
The lifetime of Dirstate objects is current per lock, but see above for
185
204
the file on disk, and then immediately discard, the overhead of object creation
186
205
becomes a significant cost.
187
206
 
188
 
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
189
208
microseconds, whereas creating a object which is subclassed from tuple was
190
209
0.500 microseconds, and creating an object with 3 elements and slots was 3
191
210
microseconds long. 0.1 milliseconds is 100 microseconds, and ideally we'll get
199
218
 
200
219
"""
201
220
 
 
221
from __future__ import absolute_import
202
222
 
203
 
import binascii
204
223
import bisect
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,
 
236
    debug,
215
237
    errors,
216
238
    inventory,
217
239
    lock,
218
240
    osutils,
 
241
    static_tuple,
219
242
    trace,
 
243
    urlutils,
220
244
    )
221
245
 
222
246
 
223
 
class _Bisector(object):
224
 
    """This just keeps track of information as we are bisecting."""
225
 
 
226
 
 
227
 
def pack_stat(st, _encode=binascii.b2a_base64, _pack=struct.pack):
228
 
    """Convert stat values into a packed representation."""
229
 
    # jam 20060614 it isn't really worth removing more entries if we
230
 
    # are going to leave it in packed form.
231
 
    # With only st_mtime and st_mode filesize is 5.5M and read time is 275ms
232
 
    # With all entries filesize is 5.9M and read time is mabye 280ms
233
 
    # well within the noise margin
234
 
 
235
 
    # base64 encoding always adds a final newline, so strip it off
236
 
    # The current version
237
 
    return _encode(_pack('>LLLLLL'
238
 
        , st.st_size, int(st.st_mtime), int(st.st_ctime)
239
 
        , st.st_dev, st.st_ino & 0xFFFFFFFF, st.st_mode))[:-1]
240
 
    # This is 0.060s / 1.520s faster by not encoding as much information
241
 
    # return _encode(_pack('>LL', int(st.st_mtime), st.st_mode))[:-1]
242
 
    # This is not strictly faster than _encode(_pack())[:-1]
243
 
    # return '%X.%X.%X.%X.%X.%X' % (
244
 
    #      st.st_size, int(st.st_mtime), int(st.st_ctime),
245
 
    #      st.st_dev, st.st_ino, st.st_mode)
246
 
    # Similar to the _encode(_pack('>LL'))
247
 
    # 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
248
293
 
249
294
 
250
295
class DirState(object):
252
297
 
253
298
    A dirstate is a specialised data structure for managing local working
254
299
    tree state information. Its not yet well defined whether it is platform
255
 
    specific, and if it is how we detect/parameterise that.
 
300
    specific, and if it is how we detect/parameterize that.
256
301
 
257
302
    Dirstates use the usual lock_write, lock_read and unlock mechanisms.
258
303
    Unlike most bzr disk formats, DirStates must be locked for reading, using
296
341
    NOT_IN_MEMORY = 0
297
342
    IN_MEMORY_UNMODIFIED = 1
298
343
    IN_MEMORY_MODIFIED = 2
 
344
    IN_MEMORY_HASH_MODIFIED = 3 # Only hash-cache updates
299
345
 
300
346
    # A pack_stat (the x's) that is just noise and will never match the output
301
347
    # of base64 encode.
302
348
    NULLSTAT = 'x' * 32
303
 
    NULL_PARENT_DETAILS = ('a', '', 0, False, '')
 
349
    NULL_PARENT_DETAILS = static_tuple.StaticTuple('a', '', 0, False, '')
304
350
 
305
351
    HEADER_FORMAT_2 = '#bazaar dirstate flat format 2\n'
306
352
    HEADER_FORMAT_3 = '#bazaar dirstate flat format 3\n'
307
353
 
308
 
    def __init__(self, path):
 
354
    def __init__(self, path, sha1_provider, worth_saving_limit=0):
309
355
        """Create a  DirState object.
310
356
 
311
 
        Attributes of note:
312
 
 
313
 
        :attr _root_entrie: The root row of the directory/file information,
314
 
            - contains the path to / - '', ''
315
 
            - kind of 'directory',
316
 
            - the file id of the root in utf8
317
 
            - size of 0
318
 
            - a packed state
319
 
            - and no sha information.
320
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.
321
363
        """
322
364
        # _header_state and _dirblock_state represent the current state
323
365
        # of the dirstate metadata and the per-row data respectiely.
325
367
        # IN_MEMORY_UNMODIFIED indicates that what we have in memory
326
368
        #   is the same as is on disk
327
369
        # IN_MEMORY_MODIFIED indicates that we have a modified version
328
 
        #   of what is on disk. 
 
370
        #   of what is on disk.
329
371
        # In future we will add more granularity, for instance _dirblock_state
330
372
        # will probably support partially-in-memory as a separate variable,
331
373
        # allowing for partially-in-memory unmodified and partially-in-memory
332
374
        # modified states.
333
375
        self._header_state = DirState.NOT_IN_MEMORY
334
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
335
380
        self._dirblocks = []
336
381
        self._ghosts = []
337
382
        self._parents = []
340
385
        self._lock_token = None
341
386
        self._lock_state = None
342
387
        self._id_index = None
 
388
        # a map from packed_stat to sha's.
 
389
        self._packed_stat_index = None
343
390
        self._end_of_header = None
344
391
        self._cutoff_time = None
345
392
        self._split_path_cache = {}
346
393
        self._bisect_page_size = DirState.BISECT_PAGE_SIZE
 
394
        self._sha1_provider = sha1_provider
 
395
        if 'hashcache' in debug.debug_flags:
 
396
            self._sha1_file = self._sha1_file_and_mutter
 
397
        else:
 
398
            self._sha1_file = self._sha1_provider.sha1
 
399
        # These two attributes provide a simple cache for lookups into the
 
400
        # dirstate in-memory vectors. By probing respectively for the last
 
401
        # block, and for the next entry, we save nearly 2 bisections per path
 
402
        # during commit.
 
403
        self._last_block_index = None
 
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))
347
411
 
348
412
    def __repr__(self):
349
413
        return "%s(%r)" % \
350
414
            (self.__class__.__name__, self._filename)
351
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
 
352
447
    def add(self, path, file_id, kind, stat, fingerprint):
353
448
        """Add a path to be tracked.
354
449
 
355
450
        :param path: The path within the dirstate - '' is the root, 'foo' is the
356
 
            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
357
452
            within the root.
358
453
        :param file_id: The file id of the path being added.
359
 
        :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',
360
455
            'directory', etc.
361
456
        :param stat: The output of os.lstat for the path.
362
 
        :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),
363
459
            or the target of a symlink,
364
460
            or the referenced revision id for tree-references,
365
461
            or '' for directories.
366
462
        """
367
463
        # adding a file:
368
 
        # find the block its in. 
 
464
        # find the block its in.
369
465
        # find the location in the block.
370
466
        # check its not there
371
467
        # add it.
372
 
        #------- copied from inventory.make_entry
 
468
        #------- copied from inventory.ensure_normalized_name - keep synced.
373
469
        # --- normalized_filename wants a unicode basename only, so get one.
374
470
        dirname, basename = osutils.split(path)
375
471
        # we dont import normalized_filename directly because we want to be
384
480
        # in the parent, or according to the special treatment for the root
385
481
        if basename == '.' or basename == '..':
386
482
            raise errors.InvalidEntryName(path)
387
 
        # 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
388
484
        # dirname and basename elements. This single encode and split should be
389
485
        # faster than three separate encodes.
390
486
        utf8path = (dirname + '/' + basename).strip('/').encode('utf8')
391
487
        dirname, basename = osutils.split(utf8path)
392
 
        assert file_id.__class__ == str, \
393
 
            "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), ))
394
492
        # Make sure the file_id does not exist in this tree
395
 
        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)
396
495
        if file_id_entry != (None, None):
397
 
            path = osutils.pathjoin(file_id_entry[0][0], file_id_entry[0][1])
398
 
            kind = DirState._minikind_to_kind[file_id_entry[1][0][0]]
399
 
            info = '%s:%s' % (kind, path)
400
 
            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)
401
511
        first_key = (dirname, basename, '')
402
512
        block_index, present = self._find_block_index_from_key(first_key)
403
513
        if present:
404
514
            # check the path is not in the tree
405
515
            block = self._dirblocks[block_index][1]
406
516
            entry_index, _ = self._find_entry_index(first_key, block)
407
 
            while (entry_index < len(block) and 
 
517
            while (entry_index < len(block) and
408
518
                block[entry_index][0][0:2] == first_key[0:2]):
409
519
                if block[entry_index][1][0][0] not in 'ar':
410
520
                    # this path is in the dirstate in the current tree.
430
540
            packed_stat = pack_stat(stat)
431
541
        parent_info = self._empty_parent_info()
432
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, '')
433
549
        if kind == 'file':
434
550
            entry_data = entry_key, [
435
551
                (minikind, fingerprint, size, False, packed_stat),
452
568
        if not present:
453
569
            block.insert(entry_index, entry_data)
454
570
        else:
455
 
            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))
456
573
            block[entry_index][1][0] = entry_data[1][0]
457
574
 
458
575
        if kind == 'directory':
459
576
           # insert a new dirblock
460
577
           self._ensure_block(block_index, entry_index, utf8path)
461
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
578
        self._mark_modified()
462
579
        if self._id_index:
463
 
            self._id_index.setdefault(entry_key[2], set()).add(entry_key)
 
580
            self._add_to_id_index(self._id_index, entry_key)
464
581
 
465
 
    def _bisect(self, dir_name_list):
 
582
    def _bisect(self, paths):
466
583
        """Bisect through the disk structure for specific rows.
467
584
 
468
 
        :param dir_name_list: A list of (dir, name) pairs.
469
 
        :return: A dict mapping (dir, name) => entry for found entries. Missing
 
585
        :param paths: A list of paths to find
 
586
        :return: A dict mapping path => entries for found entries. Missing
470
587
                 entries will not be in the map.
 
588
                 The list is not sorted, and entries will be populated
 
589
                 based on when they were read.
471
590
        """
472
591
        self._requires_lock()
473
592
        # We need the file pointer to be right after the initial header block
475
594
        # If _dirblock_state was in memory, we should just return info from
476
595
        # there, this function is only meant to handle when we want to read
477
596
        # part of the disk.
478
 
        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)
479
599
 
480
600
        # The disk representation is generally info + '\0\n\0' at the end. But
481
601
        # for bisecting, it is easier to treat this as '\0' + info + '\0\n'
493
613
        found = {}
494
614
 
495
615
        # Avoid infinite seeking
496
 
        max_count = 30*len(dir_name_list)
 
616
        max_count = 30*len(paths)
497
617
        count = 0
498
618
        # pending is a list of places to look.
499
619
        # each entry is a tuple of low, high, dir_names
501
621
        #   high -> the last byte offset (inclusive)
502
622
        #   dir_names -> The list of (dir, name) pairs that should be found in
503
623
        #                the [low, high] range
504
 
        pending = [(low, high, dir_name_list)]
 
624
        pending = [(low, high, paths)]
505
625
 
506
626
        page_size = self._bisect_page_size
507
627
 
560
680
                # Find what entries we are looking for, which occur before and
561
681
                # after this first record.
562
682
                after = start
563
 
                first_dir_name = (first_fields[1], first_fields[2])
564
 
                first_loc = bisect.bisect_left(cur_files, first_dir_name)
 
683
                if first_fields[1]:
 
684
                    first_path = first_fields[1] + '/' + first_fields[2]
 
685
                else:
 
686
                    first_path = first_fields[2]
 
687
                first_loc = _bisect_path_left(cur_files, first_path)
565
688
 
566
689
                # These exist before the current location
567
690
                pre = cur_files[:first_loc]
584
707
                else:
585
708
                    after = mid + len(block)
586
709
 
587
 
                last_dir_name = (last_fields[1], last_fields[2])
588
 
                last_loc = bisect.bisect_right(post, last_dir_name)
 
710
                if last_fields[1]:
 
711
                    last_path = last_fields[1] + '/' + last_fields[2]
 
712
                else:
 
713
                    last_path = last_fields[2]
 
714
                last_loc = _bisect_path_right(post, last_path)
589
715
 
590
716
                middle_files = post[:last_loc]
591
717
                post = post[last_loc:]
596
722
                    # Either we will find them here, or we can mark them as
597
723
                    # missing.
598
724
 
599
 
                    if middle_files[0] == first_dir_name:
 
725
                    if middle_files[0] == first_path:
600
726
                        # We might need to go before this location
601
 
                        pre.append(first_dir_name)
602
 
                    if middle_files[-1] == last_dir_name:
603
 
                        post.insert(0, last_dir_name)
 
727
                        pre.append(first_path)
 
728
                    if middle_files[-1] == last_path:
 
729
                        post.insert(0, last_path)
604
730
 
605
731
                    # Find out what paths we have
606
 
                    paths = {first_dir_name:[first_fields]}
607
 
                    # last_dir_name might == first_dir_name so we need to be
 
732
                    paths = {first_path:[first_fields]}
 
733
                    # last_path might == first_path so we need to be
608
734
                    # careful if we should append rather than overwrite
609
735
                    if last_entry_num != first_entry_num:
610
 
                        paths.setdefault(last_dir_name, []).append(last_fields)
 
736
                        paths.setdefault(last_path, []).append(last_fields)
611
737
                    for num in xrange(first_entry_num+1, last_entry_num):
612
738
                        # TODO: jam 20070223 We are already splitting here, so
613
739
                        #       shouldn't we just split the whole thing rather
614
740
                        #       than doing the split again in add_one_record?
615
741
                        fields = entries[num].split('\0')
616
 
                        dir_name = (fields[1], fields[2])
617
 
                        paths.setdefault(dir_name, []).append(fields)
 
742
                        if fields[1]:
 
743
                            path = fields[1] + '/' + fields[2]
 
744
                        else:
 
745
                            path = fields[2]
 
746
                        paths.setdefault(path, []).append(fields)
618
747
 
619
 
                    for dir_name in middle_files:
620
 
                        for fields in paths.get(dir_name, []):
 
748
                    for path in middle_files:
 
749
                        for fields in paths.get(path, []):
621
750
                            # offset by 1 because of the opening '\0'
622
751
                            # consider changing fields_to_entry to avoid the
623
752
                            # extra list slice
624
753
                            entry = fields_to_entry(fields[1:])
625
 
                            found.setdefault(dir_name, []).append(entry)
 
754
                            found.setdefault(path, []).append(entry)
626
755
 
627
756
            # Now we have split up everything into pre, middle, and post, and
628
757
            # we have handled everything that fell in 'middle'.
645
774
        _bisect_dirblocks is meant to find the contents of directories, which
646
775
        differs from _bisect, which only finds individual entries.
647
776
 
648
 
        :param dir_list: An sorted list of directory names ['', 'dir', 'foo'].
 
777
        :param dir_list: A sorted list of directory names ['', 'dir', 'foo'].
649
778
        :return: A map from dir => entries_for_dir
650
779
        """
651
780
        # TODO: jam 20070223 A lot of the bisecting logic could be shared
658
787
        # If _dirblock_state was in memory, we should just return info from
659
788
        # there, this function is only meant to handle when we want to read
660
789
        # part of the disk.
661
 
        assert self._dirblock_state == DirState.NOT_IN_MEMORY
662
 
 
 
790
        if self._dirblock_state != DirState.NOT_IN_MEMORY:
 
791
            raise AssertionError("bad dirblock state %r" % self._dirblock_state)
663
792
        # The disk representation is generally info + '\0\n\0' at the end. But
664
793
        # for bisecting, it is easier to treat this as '\0' + info + '\0\n'
665
794
        # Because it means we can sync on the '\n'
818
947
 
819
948
        return found
820
949
 
821
 
    def _bisect_recursive(self, dir_name_list):
 
950
    def _bisect_recursive(self, paths):
822
951
        """Bisect for entries for all paths and their children.
823
952
 
824
953
        This will use bisect to find all records for the supplied paths. It
837
966
        # Directories that have been read
838
967
        processed_dirs = set()
839
968
        # Get the ball rolling with the first bisect for all entries.
840
 
        newly_found = self._bisect(dir_name_list)
 
969
        newly_found = self._bisect(paths)
841
970
 
842
971
        while newly_found:
843
972
            # Directories that need to be read
867
996
                            if dir_name[0] in pending_dirs:
868
997
                                # This entry will be found in the dir search
869
998
                                continue
870
 
                            # TODO: We need to check if this entry has
871
 
                            #       already been found. Otherwise we might be
872
 
                            #       hitting infinite recursion.
873
999
                            if dir_name not in found_dir_names:
874
 
                                paths_to_search.add(dir_name)
 
1000
                                paths_to_search.add(tree_info[1])
875
1001
            # Now we have a list of paths to look for directly, and
876
1002
            # directory blocks that need to be read.
877
1003
            # newly_found is mixing the keys between (dir, name) and path
882
1008
            processed_dirs.update(pending_dirs)
883
1009
        return found
884
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
 
885
1052
    def _empty_parent_info(self):
886
1053
        return [DirState.NULL_PARENT_DETAILS] * (len(self._parents) -
887
1054
                                                    len(self._ghosts))
913
1080
        # the basename of the directory must be the end of its full name.
914
1081
        if not (parent_block_index == -1 and
915
1082
            parent_block_index == -1 and dirname == ''):
916
 
            assert dirname.endswith(
917
 
                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)
918
1086
        block_index, present = self._find_block_index_from_key((dirname, '', ''))
919
1087
        if not present:
920
 
            ## In future, when doing partial parsing, this should load and 
 
1088
            ## In future, when doing partial parsing, this should load and
921
1089
            # populate the entire block.
922
1090
            self._dirblocks.insert(block_index, (dirname, []))
923
1091
        return block_index
932
1100
            to prevent unneeded overhead when callers have a sorted list already.
933
1101
        :return: Nothing.
934
1102
        """
935
 
        assert new_entries[0][0][0:2] == ('', ''), \
936
 
            "Missing root row %r" % (new_entries[0][0],)
937
 
        # 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
938
1107
        # contents-of-root block.
939
1108
        self._dirblocks = [('', []), ('', [])]
940
1109
        current_block = self._dirblocks[0][1]
961
1130
        # The above loop leaves the "root block" entries mixed with the
962
1131
        # "contents-of-root block". But we don't want an if check on
963
1132
        # all entries, so instead we just fix it up here.
964
 
        assert self._dirblocks[1] == ('', [])
 
1133
        if self._dirblocks[1] != ('', []):
 
1134
            raise ValueError("bad dirblock start %r" % (self._dirblocks[1],))
965
1135
        root_block = []
966
1136
        contents_of_root_block = []
967
1137
        for entry in self._dirblocks[0][1]:
972
1142
        self._dirblocks[0] = ('', root_block)
973
1143
        self._dirblocks[1] = ('', contents_of_root_block)
974
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
 
975
1163
    def _entry_to_line(self, entry):
976
1164
        """Serialize entry to a NULL delimited line ready for _get_output_lines.
977
1165
 
994
1182
    def _fields_per_entry(self):
995
1183
        """How many null separated fields should be in each entry row.
996
1184
 
997
 
        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
998
1186
        so we just skip over it
999
 
        entry size:
 
1187
 
 
1188
        entry size::
1000
1189
            3 fields for the key
1001
1190
            + number of fields per tree_data (5) * tree count
1002
1191
            + newline
1033
1222
        """
1034
1223
        if key[0:2] == ('', ''):
1035
1224
            return 0, True
 
1225
        try:
 
1226
            if (self._last_block_index is not None and
 
1227
                self._dirblocks[self._last_block_index][0] == key[0]):
 
1228
                return self._last_block_index, True
 
1229
        except IndexError:
 
1230
            pass
1036
1231
        block_index = bisect_dirblock(self._dirblocks, key[0], 1,
1037
1232
                                      cache=self._split_path_cache)
1038
1233
        # _right returns one-past-where-key is so we have to subtract
1039
1234
        # one to use it. we use _right here because there are two
1040
1235
        # '' blocks - the root, and the contents of root
1041
1236
        # we always have a minimum of 2 in self._dirblocks: root and
1042
 
        # root-contents, and for '', we get 2 back, so this is 
 
1237
        # root-contents, and for '', we get 2 back, so this is
1043
1238
        # simple and correct:
1044
1239
        present = (block_index < len(self._dirblocks) and
1045
1240
            self._dirblocks[block_index][0] == key[0])
 
1241
        self._last_block_index = block_index
 
1242
        # Reset the entry index cache to the beginning of the block.
 
1243
        self._last_entry_index = -1
1046
1244
        return block_index, present
1047
1245
 
1048
1246
    def _find_entry_index(self, key, block):
1050
1248
 
1051
1249
        :return: The entry index, True if the entry for the key is present.
1052
1250
        """
 
1251
        len_block = len(block)
 
1252
        try:
 
1253
            if self._last_entry_index is not None:
 
1254
                # mini-bisect here.
 
1255
                entry_index = self._last_entry_index + 1
 
1256
                # A hit is when the key is after the last slot, and before or
 
1257
                # equal to the next slot.
 
1258
                if ((entry_index > 0 and block[entry_index - 1][0] < key) and
 
1259
                    key <= block[entry_index][0]):
 
1260
                    self._last_entry_index = entry_index
 
1261
                    present = (block[entry_index][0] == key)
 
1262
                    return entry_index, present
 
1263
        except IndexError:
 
1264
            pass
1053
1265
        entry_index = bisect.bisect_left(block, (key, []))
1054
 
        present = (entry_index < len(block) and
 
1266
        present = (entry_index < len_block and
1055
1267
            block[entry_index][0] == key)
 
1268
        self._last_entry_index = entry_index
1056
1269
        return entry_index, present
1057
1270
 
1058
1271
    @staticmethod
1059
 
    def from_tree(tree, dir_state_filename):
 
1272
    def from_tree(tree, dir_state_filename, sha1_provider=None):
1060
1273
        """Create a dirstate from a bzr Tree.
1061
1274
 
1062
1275
        :param tree: The tree which should provide parent information and
1063
1276
            inventory ids.
 
1277
        :param sha1_provider: an object meeting the SHA1Provider interface.
 
1278
            If None, a DefaultSHA1Provider is used.
1064
1279
        :return: a DirState object which is currently locked for writing.
1065
1280
            (it was locked by DirState.initialize)
1066
1281
        """
1067
 
        result = DirState.initialize(dir_state_filename)
 
1282
        result = DirState.initialize(dir_state_filename,
 
1283
            sha1_provider=sha1_provider)
1068
1284
        try:
1069
1285
            tree.lock_read()
1070
1286
            try:
1076
1292
                    parent_trees.append((parent_id, parent_tree))
1077
1293
                    parent_tree.lock_read()
1078
1294
                result.set_parent_trees(parent_trees, [])
1079
 
                result.set_state_from_inventory(tree.inventory)
 
1295
                result.set_state_from_inventory(tree.root_inventory)
1080
1296
            finally:
1081
1297
                for revid, parent_tree in parent_trees:
1082
1298
                    parent_tree.unlock()
1088
1304
            raise
1089
1305
        return result
1090
1306
 
1091
 
    def update_entry(self, entry, abspath, stat_value,
1092
 
                     _stat_to_minikind=_stat_to_minikind,
1093
 
                     _pack_stat=pack_stat):
1094
 
        """Update the entry based on what is actually on disk.
1095
 
 
1096
 
        :param entry: This is the dirblock entry for the file in question.
1097
 
        :param abspath: The path on disk for this file.
1098
 
        :param stat_value: (optional) if we already have done a stat on the
1099
 
            file, re-use it.
1100
 
        :return: The sha1 hexdigest of the file (40 bytes) or link target of a
1101
 
                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
                self._raise_invalid(new_path, file_id,
 
1652
                    "Unable to find block for this record."
 
1653
                    " Was the parent added?")
 
1654
            block = self._dirblocks[block_index][1]
 
1655
            entry_index, present = self._find_entry_index(entry_key, block)
 
1656
            if real_add:
 
1657
                if old_path is not None:
 
1658
                    self._raise_invalid(new_path, file_id,
 
1659
                        'considered a real add but still had old_path at %s'
 
1660
                        % (old_path,))
 
1661
            if present:
 
1662
                entry = block[entry_index]
 
1663
                basis_kind = entry[1][1][0]
 
1664
                if basis_kind == 'a':
 
1665
                    entry[1][1] = new_details
 
1666
                elif basis_kind == 'r':
 
1667
                    raise NotImplementedError()
 
1668
                else:
 
1669
                    self._raise_invalid(new_path, file_id,
 
1670
                        "An entry was marked as a new add"
 
1671
                        " but the basis target already existed")
 
1672
            else:
 
1673
                # The exact key was not found in the block. However, we need to
 
1674
                # check if there is a key next to us that would have matched.
 
1675
                # We only need to check 2 locations, because there are only 2
 
1676
                # trees present.
 
1677
                for maybe_index in range(entry_index-1, entry_index+1):
 
1678
                    if maybe_index < 0 or maybe_index >= len(block):
 
1679
                        continue
 
1680
                    maybe_entry = block[maybe_index]
 
1681
                    if maybe_entry[0][:2] != (dirname, basename):
 
1682
                        # Just a random neighbor
 
1683
                        continue
 
1684
                    if maybe_entry[0][2] == file_id:
 
1685
                        raise AssertionError(
 
1686
                            '_find_entry_index didnt find a key match'
 
1687
                            ' but walking the data did, for %s'
 
1688
                            % (entry_key,))
 
1689
                    basis_kind = maybe_entry[1][1][0]
 
1690
                    if basis_kind not in 'ar':
 
1691
                        self._raise_invalid(new_path, file_id,
 
1692
                            "we have an add record for path, but the path"
 
1693
                            " is already present with another file_id %s"
 
1694
                            % (maybe_entry[0][2],))
 
1695
 
 
1696
                entry = (entry_key, [DirState.NULL_PARENT_DETAILS,
 
1697
                                     new_details])
 
1698
                block.insert(entry_index, entry)
 
1699
 
 
1700
            active_kind = entry[1][0][0]
 
1701
            if active_kind == 'a':
 
1702
                # The active record shows up as absent, this could be genuine,
 
1703
                # or it could be present at some other location. We need to
 
1704
                # verify.
 
1705
                id_index = self._get_id_index()
 
1706
                # The id_index may not be perfectly accurate for tree1, because
 
1707
                # we haven't been keeping it updated. However, it should be
 
1708
                # fine for tree0, and that gives us enough info for what we
 
1709
                # need
 
1710
                keys = id_index.get(file_id, ())
 
1711
                for key in keys:
 
1712
                    block_i, entry_i, d_present, f_present = \
 
1713
                        self._get_block_entry_index(key[0], key[1], 0)
 
1714
                    if not f_present:
 
1715
                        continue
 
1716
                    active_entry = self._dirblocks[block_i][1][entry_i]
 
1717
                    if (active_entry[0][2] != file_id):
 
1718
                        # Some other file is at this path, we don't need to
 
1719
                        # link it.
 
1720
                        continue
 
1721
                    real_active_kind = active_entry[1][0][0]
 
1722
                    if real_active_kind in 'ar':
 
1723
                        # We found a record, which was not *this* record,
 
1724
                        # which matches the file_id, but is not actually
 
1725
                        # present. Something seems *really* wrong.
 
1726
                        self._raise_invalid(new_path, file_id,
 
1727
                            "We found a tree0 entry that doesnt make sense")
 
1728
                    # Now, we've found a tree0 entry which matches the file_id
 
1729
                    # but is at a different location. So update them to be
 
1730
                    # rename records.
 
1731
                    active_dir, active_name = active_entry[0][:2]
 
1732
                    if active_dir:
 
1733
                        active_path = active_dir + '/' + active_name
 
1734
                    else:
 
1735
                        active_path = active_name
 
1736
                    active_entry[1][1] = st('r', new_path, 0, False, '')
 
1737
                    entry[1][0] = st('r', active_path, 0, False, '')
 
1738
            elif active_kind == 'r':
 
1739
                raise NotImplementedError()
 
1740
 
 
1741
            new_kind = new_details[0]
 
1742
            if new_kind == 'd':
 
1743
                self._ensure_block(block_index, entry_index, new_path)
 
1744
 
 
1745
    def _update_basis_apply_changes(self, changes):
 
1746
        """Apply a sequence of changes to tree 1 during update_basis_by_delta.
 
1747
 
 
1748
        :param adds: A sequence of changes. Each change is a tuple:
 
1749
            (path_utf8, path_utf8, file_id, (entry_details))
 
1750
        """
 
1751
        absent = 'ar'
 
1752
        for old_path, new_path, file_id, new_details in changes:
 
1753
            # the entry for this file_id must be in tree 0.
 
1754
            entry = self._get_entry(1, file_id, new_path)
 
1755
            if entry[0] is None or entry[1][1][0] in 'ar':
 
1756
                self._raise_invalid(new_path, file_id,
 
1757
                    'changed entry considered not present')
 
1758
            entry[1][1] = new_details
 
1759
 
 
1760
    def _update_basis_apply_deletes(self, deletes):
 
1761
        """Apply a sequence of deletes to tree 1 during update_basis_by_delta.
 
1762
 
 
1763
        They may be deletes, or renames that have been split into add/delete
 
1764
        pairs.
 
1765
 
 
1766
        :param deletes: A sequence of deletes. Each delete is a tuple:
 
1767
            (old_path_utf8, new_path_utf8, file_id, None, real_delete).
 
1768
            real_delete is True when the desired outcome is an actual deletion
 
1769
            rather than the rename handling logic temporarily deleting a path
 
1770
            during the replacement of a parent.
 
1771
        """
 
1772
        null = DirState.NULL_PARENT_DETAILS
 
1773
        for old_path, new_path, file_id, _, real_delete in deletes:
 
1774
            if real_delete != (new_path is None):
 
1775
                self._raise_invalid(old_path, file_id, "bad delete delta")
 
1776
            # the entry for this file_id must be in tree 1.
 
1777
            dirname, basename = osutils.split(old_path)
 
1778
            block_index, entry_index, dir_present, file_present = \
 
1779
                self._get_block_entry_index(dirname, basename, 1)
 
1780
            if not file_present:
 
1781
                self._raise_invalid(old_path, file_id,
 
1782
                    'basis tree does not contain removed entry')
 
1783
            entry = self._dirblocks[block_index][1][entry_index]
 
1784
            # The state of the entry in the 'active' WT
 
1785
            active_kind = entry[1][0][0]
 
1786
            if entry[0][2] != file_id:
 
1787
                self._raise_invalid(old_path, file_id,
 
1788
                    'mismatched file_id in tree 1')
 
1789
            dir_block = ()
 
1790
            old_kind = entry[1][1][0]
 
1791
            if active_kind in 'ar':
 
1792
                # The active tree doesn't have this file_id.
 
1793
                # The basis tree is changing this record. If this is a
 
1794
                # rename, then we don't want the record here at all
 
1795
                # anymore. If it is just an in-place change, we want the
 
1796
                # record here, but we'll add it if we need to. So we just
 
1797
                # delete it
 
1798
                if active_kind == 'r':
 
1799
                    active_path = entry[1][0][1]
 
1800
                    active_entry = self._get_entry(0, file_id, active_path)
 
1801
                    if active_entry[1][1][0] != 'r':
 
1802
                        self._raise_invalid(old_path, file_id,
 
1803
                            "Dirstate did not have matching rename entries")
 
1804
                    elif active_entry[1][0][0] in 'ar':
 
1805
                        self._raise_invalid(old_path, file_id,
 
1806
                            "Dirstate had a rename pointing at an inactive"
 
1807
                            " tree0")
 
1808
                    active_entry[1][1] = null
 
1809
                del self._dirblocks[block_index][1][entry_index]
 
1810
                if old_kind == 'd':
 
1811
                    # This was a directory, and the active tree says it
 
1812
                    # doesn't exist, and now the basis tree says it doesn't
 
1813
                    # exist. Remove its dirblock if present
 
1814
                    (dir_block_index,
 
1815
                     present) = self._find_block_index_from_key(
 
1816
                        (old_path, '', ''))
 
1817
                    if present:
 
1818
                        dir_block = self._dirblocks[dir_block_index][1]
 
1819
                        if not dir_block:
 
1820
                            # This entry is empty, go ahead and just remove it
 
1821
                            del self._dirblocks[dir_block_index]
 
1822
            else:
 
1823
                # There is still an active record, so just mark this
 
1824
                # removed.
 
1825
                entry[1][1] = null
 
1826
                block_i, entry_i, d_present, f_present = \
 
1827
                    self._get_block_entry_index(old_path, '', 1)
 
1828
                if d_present:
 
1829
                    dir_block = self._dirblocks[block_i][1]
 
1830
            for child_entry in dir_block:
 
1831
                child_basis_kind = child_entry[1][1][0]
 
1832
                if child_basis_kind not in 'ar':
 
1833
                    self._raise_invalid(old_path, file_id,
 
1834
                        "The file id was deleted but its children were "
 
1835
                        "not deleted.")
 
1836
 
 
1837
    def _after_delta_check_parents(self, parents, index):
 
1838
        """Check that parents required by the delta are all intact.
 
1839
        
 
1840
        :param parents: An iterable of (path_utf8, file_id) tuples which are
 
1841
            required to be present in tree 'index' at path_utf8 with id file_id
 
1842
            and be a directory.
 
1843
        :param index: The column in the dirstate to check for parents in.
 
1844
        """
 
1845
        for dirname_utf8, file_id in parents:
 
1846
            # Get the entry - the ensures that file_id, dirname_utf8 exists and
 
1847
            # has the right file id.
 
1848
            entry = self._get_entry(index, file_id, dirname_utf8)
 
1849
            if entry[1] is None:
 
1850
                self._raise_invalid(dirname_utf8.decode('utf8'),
 
1851
                    file_id, "This parent is not present.")
 
1852
            # Parents of things must be directories
 
1853
            if entry[1][index][0] != 'd':
 
1854
                self._raise_invalid(dirname_utf8.decode('utf8'),
 
1855
                    file_id, "This parent is not a directory.")
 
1856
 
 
1857
    def _observed_sha1(self, entry, sha1, stat_value,
 
1858
        _stat_to_minikind=_stat_to_minikind):
 
1859
        """Note the sha1 of a file.
 
1860
 
 
1861
        :param entry: The entry the sha1 is for.
 
1862
        :param sha1: The observed sha1.
 
1863
        :param stat_value: The os.lstat for the file.
1102
1864
        """
1103
1865
        try:
1104
1866
            minikind = _stat_to_minikind[stat_value.st_mode & 0170000]
1105
1867
        except KeyError:
1106
1868
            # Unhandled kind
1107
1869
            return None
1108
 
        packed_stat = _pack_stat(stat_value)
1109
 
        (saved_minikind, saved_link_or_sha1, saved_file_size,
1110
 
         saved_executable, saved_packed_stat) = entry[1][0]
1111
 
 
1112
 
        if (minikind == saved_minikind
1113
 
            and packed_stat == saved_packed_stat):
1114
 
            # The stat hasn't changed since we saved, so we can re-use the
1115
 
            # saved sha hash.
1116
 
            if minikind == 'd':
1117
 
                return None
1118
 
 
1119
 
            # size should also be in packed_stat
1120
 
            if saved_file_size == stat_value.st_size:
1121
 
                return saved_link_or_sha1
1122
 
 
1123
 
        # If we have gotten this far, that means that we need to actually
1124
 
        # process this entry.
1125
 
        link_or_sha1 = None
1126
1870
        if minikind == 'f':
1127
 
            link_or_sha1 = self._sha1_file(abspath, entry)
1128
 
            executable = self._is_executable(stat_value.st_mode,
1129
 
                                             saved_executable)
1130
 
            if self._cutoff_time is None:
1131
 
                self._sha_cutoff_time()
1132
 
            if (stat_value.st_mtime < self._cutoff_time
1133
 
                and stat_value.st_ctime < self._cutoff_time):
1134
 
                entry[1][0] = ('f', link_or_sha1, stat_value.st_size,
1135
 
                               executable, packed_stat)
1136
 
            else:
1137
 
                entry[1][0] = ('f', '', stat_value.st_size,
1138
 
                               executable, DirState.NULLSTAT)
1139
 
        elif minikind == 'd':
1140
 
            link_or_sha1 = None
1141
 
            entry[1][0] = ('d', '', 0, False, packed_stat)
1142
 
            if saved_minikind != 'd':
1143
 
                # This changed from something into a directory. Make sure we
1144
 
                # have a directory block for it. This doesn't happen very
1145
 
                # often, so this doesn't have to be super fast.
1146
 
                block_index, entry_index, dir_present, file_present = \
1147
 
                    self._get_block_entry_index(entry[0][0], entry[0][1], 0)
1148
 
                self._ensure_block(block_index, entry_index,
1149
 
                                   osutils.pathjoin(entry[0][0], entry[0][1]))
1150
 
        elif minikind == 'l':
1151
 
            link_or_sha1 = self._read_link(abspath, saved_link_or_sha1)
1152
 
            if self._cutoff_time is None:
1153
 
                self._sha_cutoff_time()
1154
 
            if (stat_value.st_mtime < self._cutoff_time
1155
 
                and stat_value.st_ctime < self._cutoff_time):
1156
 
                entry[1][0] = ('l', link_or_sha1, stat_value.st_size,
1157
 
                               False, packed_stat)
1158
 
            else:
1159
 
                entry[1][0] = ('l', '', stat_value.st_size,
1160
 
                               False, DirState.NULLSTAT)
1161
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
1162
 
        return link_or_sha1
 
1871
            if self._cutoff_time is None:
 
1872
                self._sha_cutoff_time()
 
1873
            if (stat_value.st_mtime < self._cutoff_time
 
1874
                and stat_value.st_ctime < self._cutoff_time):
 
1875
                entry[1][0] = ('f', sha1, stat_value.st_size, entry[1][0][3],
 
1876
                               pack_stat(stat_value))
 
1877
                self._mark_modified([entry])
1163
1878
 
1164
1879
    def _sha_cutoff_time(self):
1165
1880
        """Return cutoff time.
1178
1893
        """Return the os.lstat value for this path."""
1179
1894
        return os.lstat(abspath)
1180
1895
 
1181
 
    def _sha1_file(self, abspath, entry):
1182
 
        """Calculate the SHA1 of a file by reading the full text"""
1183
 
        f = file(abspath, 'rb', buffering=65000)
1184
 
        try:
1185
 
            return osutils.sha_file(f)
1186
 
        finally:
1187
 
            f.close()
 
1896
    def _sha1_file_and_mutter(self, abspath):
 
1897
        # when -Dhashcache is turned on, this is monkey-patched in to log
 
1898
        # file reads
 
1899
        trace.mutter("dirstate sha1 " + abspath)
 
1900
        return self._sha1_provider.sha1(abspath)
1188
1901
 
1189
1902
    def _is_executable(self, mode, old_executable):
1190
1903
        """Is this file executable?"""
1203
1916
        #       already in memory. However, this really needs to be done at a
1204
1917
        #       higher level, because there either won't be anything on disk,
1205
1918
        #       or the thing on disk will be a file.
1206
 
        return os.readlink(abspath)
 
1919
        fs_encoding = osutils._fs_enc
 
1920
        if isinstance(abspath, unicode):
 
1921
            # abspath is defined as the path to pass to lstat. readlink is
 
1922
            # buggy in python < 2.6 (it doesn't encode unicode path into FS
 
1923
            # encoding), so we need to encode ourselves knowing that unicode
 
1924
            # paths are produced by UnicodeDirReader on purpose.
 
1925
            abspath = abspath.encode(fs_encoding)
 
1926
        target = os.readlink(abspath)
 
1927
        if fs_encoding not in ('utf-8', 'ascii'):
 
1928
            # Change encoding if needed
 
1929
            target = target.decode(fs_encoding).encode('UTF-8')
 
1930
        return target
1207
1931
 
1208
1932
    def get_ghosts(self):
1209
1933
        """Return a list of the parent tree revision ids that are ghosts."""
1214
1938
        """Serialise the entire dirstate to a sequence of lines."""
1215
1939
        if (self._header_state == DirState.IN_MEMORY_UNMODIFIED and
1216
1940
            self._dirblock_state == DirState.IN_MEMORY_UNMODIFIED):
1217
 
            # read whats on disk.
 
1941
            # read what's on disk.
1218
1942
            self._state_file.seek(0)
1219
1943
            return self._state_file.readlines()
1220
1944
        lines = []
1221
1945
        lines.append(self._get_parents_line(self.get_parent_ids()))
1222
1946
        lines.append(self._get_ghosts_line(self._ghosts))
1223
 
        # append the root line which is special cased
1224
 
        lines.extend(map(self._entry_to_line, self._iter_entries()))
 
1947
        lines.extend(self._get_entry_lines())
1225
1948
        return self._get_output_lines(lines)
1226
1949
 
1227
1950
    def _get_ghosts_line(self, ghost_ids):
1232
1955
        """Create a line for the state file for parents information."""
1233
1956
        return '\0'.join([str(len(parent_ids))] + parent_ids)
1234
1957
 
 
1958
    def _get_entry_lines(self):
 
1959
        """Create lines for entries."""
 
1960
        return map(self._entry_to_line, self._iter_entries())
 
1961
 
1235
1962
    def _get_fields_to_entry(self):
1236
1963
        """Get a function which converts entry fields into a entry record.
1237
1964
 
1327
2054
            be attempted.
1328
2055
        :return: A tuple describing where the path is located, or should be
1329
2056
            inserted. The tuple contains four fields: the block index, the row
1330
 
            index, anda two booleans are True when the directory is present, and
1331
 
            when the entire path is present.  There is no guarantee that either
 
2057
            index, the directory is present (boolean), the entire path is
 
2058
            present (boolean).  There is no guarantee that either
1332
2059
            coordinate is currently reachable unless the found field for it is
1333
2060
            True. For instance, a directory not present in the searched tree
1334
2061
            may be returned with a value one greater than the current highest
1346
2073
            return block_index, 0, False, False
1347
2074
        block = self._dirblocks[block_index][1] # access the entries only
1348
2075
        entry_index, present = self._find_entry_index(key, block)
1349
 
        # linear search through present entries at this path to find the one
 
2076
        # linear search through entries at this path to find the one
1350
2077
        # requested.
1351
2078
        while entry_index < len(block) and block[entry_index][0][1] == basename:
1352
 
            if block[entry_index][1][tree_index][0] not in \
1353
 
                       ('a', 'r'): # absent, relocated
 
2079
            if block[entry_index][1][tree_index][0] not in 'ar':
 
2080
                # neither absent or relocated
1354
2081
                return block_index, entry_index, True, True
1355
2082
            entry_index += 1
1356
2083
        return block_index, entry_index, True, False
1357
2084
 
1358
 
    def _get_entry(self, tree_index, fileid_utf8=None, path_utf8=None):
1359
 
        """Get the dirstate entry for path in tree tree_index
 
2085
    def _get_entry(self, tree_index, fileid_utf8=None, path_utf8=None,
 
2086
                   include_deleted=False):
 
2087
        """Get the dirstate entry for path in tree tree_index.
1360
2088
 
1361
2089
        If either file_id or path is supplied, it is used as the key to lookup.
1362
2090
        If both are supplied, the fastest lookup is used, and an error is
1369
2097
            trees.
1370
2098
        :param fileid_utf8: A utf8 file_id to look up.
1371
2099
        :param path_utf8: An utf8 path to be looked up.
 
2100
        :param include_deleted: If True, and performing a lookup via
 
2101
            fileid_utf8 rather than path_utf8, return an entry for deleted
 
2102
            (absent) paths.
1372
2103
        :return: The dirstate entry tuple for path, or (None, None)
1373
2104
        """
1374
2105
        self._read_dirblocks_if_needed()
1375
2106
        if path_utf8 is not None:
1376
 
            assert path_utf8.__class__ == str, 'path_utf8 is not a str: %s %s' % (type(path_utf8), path_utf8)
 
2107
            if type(path_utf8) is not str:
 
2108
                raise errors.BzrError('path_utf8 is not a str: %s %r'
 
2109
                    % (type(path_utf8), path_utf8))
1377
2110
            # path lookups are faster
1378
2111
            dirname, basename = osutils.split(path_utf8)
1379
2112
            block_index, entry_index, dir_present, file_present = \
1381
2114
            if not file_present:
1382
2115
                return None, None
1383
2116
            entry = self._dirblocks[block_index][1][entry_index]
1384
 
            assert entry[0][2] and entry[1][tree_index][0] not in ('a', 'r'), 'unversioned entry?!?!'
 
2117
            if not (entry[0][2] and entry[1][tree_index][0] not in ('a', 'r')):
 
2118
                raise AssertionError('unversioned entry?')
1385
2119
            if fileid_utf8:
1386
2120
                if entry[0][2] != fileid_utf8:
 
2121
                    self._changes_aborted = True
1387
2122
                    raise errors.BzrError('integrity error ? : mismatching'
1388
2123
                                          ' tree_index, file_id and path')
1389
2124
            return entry
1390
2125
        else:
1391
 
            assert fileid_utf8 is not None
1392
 
            possible_keys = self._get_id_index().get(fileid_utf8, None)
 
2126
            possible_keys = self._get_id_index().get(fileid_utf8, ())
1393
2127
            if not possible_keys:
1394
2128
                return None, None
1395
2129
            for key in possible_keys:
1401
2135
                    continue
1402
2136
                # WARNING: DO not change this code to use _get_block_entry_index
1403
2137
                # as that function is not suitable: it does not use the key
1404
 
                # to lookup, and thus the wront coordinates are returned.
 
2138
                # to lookup, and thus the wrong coordinates are returned.
1405
2139
                block = self._dirblocks[block_index][1]
1406
2140
                entry_index, present = self._find_entry_index(key, block)
1407
2141
                if present:
1408
2142
                    entry = self._dirblocks[block_index][1][entry_index]
 
2143
                    # TODO: We might want to assert that entry[0][2] ==
 
2144
                    #       fileid_utf8.
1409
2145
                    if entry[1][tree_index][0] in 'fdlt':
1410
 
                        # this is the result we are looking for: the  
 
2146
                        # this is the result we are looking for: the
1411
2147
                        # real home of this file_id in this tree.
1412
2148
                        return entry
1413
2149
                    if entry[1][tree_index][0] == 'a':
1414
2150
                        # there is no home for this entry in this tree
 
2151
                        if include_deleted:
 
2152
                            return entry
1415
2153
                        return None, None
1416
 
                    assert entry[1][tree_index][0] == 'r', \
1417
 
                        "entry %r has invalid minikind %r for tree %r" \
1418
 
                        % (entry,
1419
 
                           entry[1][tree_index][0],
1420
 
                           tree_index)
 
2154
                    if entry[1][tree_index][0] != 'r':
 
2155
                        raise AssertionError(
 
2156
                            "entry %r has invalid minikind %r for tree %r" \
 
2157
                            % (entry,
 
2158
                               entry[1][tree_index][0],
 
2159
                               tree_index))
1421
2160
                    real_path = entry[1][tree_index][1]
1422
2161
                    return self._get_entry(tree_index, fileid_utf8=fileid_utf8,
1423
2162
                        path_utf8=real_path)
1424
2163
            return None, None
1425
2164
 
1426
2165
    @classmethod
1427
 
    def initialize(cls, path):
 
2166
    def initialize(cls, path, sha1_provider=None):
1428
2167
        """Create a new dirstate on path.
1429
2168
 
1430
2169
        The new dirstate will be an empty tree - that is it has no parents,
1431
2170
        and only a root node - which has id ROOT_ID.
1432
2171
 
1433
2172
        :param path: The name of the file for the dirstate.
 
2173
        :param sha1_provider: an object meeting the SHA1Provider interface.
 
2174
            If None, a DefaultSHA1Provider is used.
1434
2175
        :return: A write-locked DirState object.
1435
2176
        """
1436
2177
        # This constructs a new DirState object on a path, sets the _state_file
1438
2179
        # stock empty dirstate information - a root with ROOT_ID, no children,
1439
2180
        # and no parents. Finally it calls save() to ensure that this data will
1440
2181
        # persist.
1441
 
        result = cls(path)
 
2182
        if sha1_provider is None:
 
2183
            sha1_provider = DefaultSHA1Provider()
 
2184
        result = cls(path, sha1_provider)
1442
2185
        # root dir and root dir contents with no children.
1443
2186
        empty_tree_dirblocks = [('', []), ('', [])]
1444
2187
        # a new root directory, with a NULLSTAT.
1455
2198
            raise
1456
2199
        return result
1457
2200
 
1458
 
    def _inv_entry_to_details(self, inv_entry):
 
2201
    @staticmethod
 
2202
    def _inv_entry_to_details(inv_entry):
1459
2203
        """Convert an inventory entry (from a revision tree) to state details.
1460
2204
 
1461
2205
        :param inv_entry: An inventory entry whose sha1 and link targets can be
1466
2210
        kind = inv_entry.kind
1467
2211
        minikind = DirState._kind_to_minikind[kind]
1468
2212
        tree_data = inv_entry.revision
1469
 
        assert len(tree_data) > 0, 'empty revision for the inv_entry.'
1470
2213
        if kind == 'directory':
1471
2214
            fingerprint = ''
1472
2215
            size = 0
1473
2216
            executable = False
1474
2217
        elif kind == 'symlink':
1475
 
            fingerprint = inv_entry.symlink_target or ''
 
2218
            if inv_entry.symlink_target is None:
 
2219
                fingerprint = ''
 
2220
            else:
 
2221
                fingerprint = inv_entry.symlink_target.encode('utf8')
1476
2222
            size = 0
1477
2223
            executable = False
1478
2224
        elif kind == 'file':
1485
2231
            executable = False
1486
2232
        else:
1487
2233
            raise Exception("can't pack %s" % inv_entry)
1488
 
        return (minikind, fingerprint, size, executable, tree_data)
 
2234
        return static_tuple.StaticTuple(minikind, fingerprint, size,
 
2235
                                        executable, tree_data)
 
2236
 
 
2237
    def _iter_child_entries(self, tree_index, path_utf8):
 
2238
        """Iterate over all the entries that are children of path_utf.
 
2239
 
 
2240
        This only returns entries that are present (not in 'a', 'r') in
 
2241
        tree_index. tree_index data is not refreshed, so if tree 0 is used,
 
2242
        results may differ from that obtained if paths were statted to
 
2243
        determine what ones were directories.
 
2244
 
 
2245
        Asking for the children of a non-directory will return an empty
 
2246
        iterator.
 
2247
        """
 
2248
        pending_dirs = []
 
2249
        next_pending_dirs = [path_utf8]
 
2250
        absent = 'ar'
 
2251
        while next_pending_dirs:
 
2252
            pending_dirs = next_pending_dirs
 
2253
            next_pending_dirs = []
 
2254
            for path in pending_dirs:
 
2255
                block_index, present = self._find_block_index_from_key(
 
2256
                    (path, '', ''))
 
2257
                if block_index == 0:
 
2258
                    block_index = 1
 
2259
                    if len(self._dirblocks) == 1:
 
2260
                        # asked for the children of the root with no other
 
2261
                        # contents.
 
2262
                        return
 
2263
                if not present:
 
2264
                    # children of a non-directory asked for.
 
2265
                    continue
 
2266
                block = self._dirblocks[block_index]
 
2267
                for entry in block[1]:
 
2268
                    kind = entry[1][tree_index][0]
 
2269
                    if kind not in absent:
 
2270
                        yield entry
 
2271
                    if kind == 'd':
 
2272
                        if entry[0][0]:
 
2273
                            path = entry[0][0] + '/' + entry[0][1]
 
2274
                        else:
 
2275
                            path = entry[0][1]
 
2276
                        next_pending_dirs.append(path)
1489
2277
 
1490
2278
    def _iter_entries(self):
1491
2279
        """Iterate over all the entries in the dirstate.
1499
2287
                yield entry
1500
2288
 
1501
2289
    def _get_id_index(self):
1502
 
        """Get an id index of self._dirblocks."""
 
2290
        """Get an id index of self._dirblocks.
 
2291
 
 
2292
        This maps from file_id => [(directory, name, file_id)] entries where
 
2293
        that file_id appears in one of the trees.
 
2294
        """
1503
2295
        if self._id_index is None:
1504
2296
            id_index = {}
1505
2297
            for key, tree_details in self._iter_entries():
1506
 
                id_index.setdefault(key[2], set()).add(key)
 
2298
                self._add_to_id_index(id_index, key)
1507
2299
            self._id_index = id_index
1508
2300
        return self._id_index
1509
2301
 
 
2302
    def _add_to_id_index(self, id_index, entry_key):
 
2303
        """Add this entry to the _id_index mapping."""
 
2304
        # This code used to use a set for every entry in the id_index. However,
 
2305
        # it is *rare* to have more than one entry. So a set is a large
 
2306
        # overkill. And even when we do, we won't ever have more than the
 
2307
        # number of parent trees. Which is still a small number (rarely >2). As
 
2308
        # such, we use a simple tuple, and do our own uniqueness checks. While
 
2309
        # the 'in' check is O(N) since N is nicely bounded it shouldn't ever
 
2310
        # cause quadratic failure.
 
2311
        file_id = entry_key[2]
 
2312
        entry_key = static_tuple.StaticTuple.from_sequence(entry_key)
 
2313
        if file_id not in id_index:
 
2314
            id_index[file_id] = static_tuple.StaticTuple(entry_key,)
 
2315
        else:
 
2316
            entry_keys = id_index[file_id]
 
2317
            if entry_key not in entry_keys:
 
2318
                id_index[file_id] = entry_keys + (entry_key,)
 
2319
 
 
2320
    def _remove_from_id_index(self, id_index, entry_key):
 
2321
        """Remove this entry from the _id_index mapping.
 
2322
 
 
2323
        It is an programming error to call this when the entry_key is not
 
2324
        already present.
 
2325
        """
 
2326
        file_id = entry_key[2]
 
2327
        entry_keys = list(id_index[file_id])
 
2328
        entry_keys.remove(entry_key)
 
2329
        id_index[file_id] = static_tuple.StaticTuple.from_sequence(entry_keys)
 
2330
 
1510
2331
    def _get_output_lines(self, lines):
1511
 
        """format lines for final output.
 
2332
        """Format lines for final output.
1512
2333
 
1513
 
        :param lines: A sequece of lines containing the parents list and the
 
2334
        :param lines: A sequence of lines containing the parents list and the
1514
2335
            path lines.
1515
2336
        """
1516
2337
        output_lines = [DirState.HEADER_FORMAT_3]
1524
2345
        return output_lines
1525
2346
 
1526
2347
    def _make_deleted_row(self, fileid_utf8, parents):
1527
 
        """Return a deleted for for fileid_utf8."""
 
2348
        """Return a deleted row for fileid_utf8."""
1528
2349
        return ('/', 'RECYCLED.BIN', 'file', fileid_utf8, 0, DirState.NULLSTAT,
1529
2350
            ''), parents
1530
2351
 
1532
2353
        """The number of parent entries in each record row."""
1533
2354
        return len(self._parents) - len(self._ghosts)
1534
2355
 
1535
 
    @staticmethod
1536
 
    def on_file(path):
1537
 
        """Construct a DirState on the file at path path.
 
2356
    @classmethod
 
2357
    def on_file(cls, path, sha1_provider=None, worth_saving_limit=0):
 
2358
        """Construct a DirState on the file at path "path".
1538
2359
 
 
2360
        :param path: The path at which the dirstate file on disk should live.
 
2361
        :param sha1_provider: an object meeting the SHA1Provider interface.
 
2362
            If None, a DefaultSHA1Provider is used.
 
2363
        :param worth_saving_limit: when the exact number of hash changed
 
2364
            entries is known, only bother saving the dirstate if more than
 
2365
            this count of entries have changed. -1 means never save.
1539
2366
        :return: An unlocked DirState object, associated with the given path.
1540
2367
        """
1541
 
        result = DirState(path)
 
2368
        if sha1_provider is None:
 
2369
            sha1_provider = DefaultSHA1Provider()
 
2370
        result = cls(path, sha1_provider,
 
2371
                     worth_saving_limit=worth_saving_limit)
1542
2372
        return result
1543
2373
 
1544
2374
    def _read_dirblocks_if_needed(self):
1545
2375
        """Read in all the dirblocks from the file if they are not in memory.
1546
 
        
 
2376
 
1547
2377
        This populates self._dirblocks, and sets self._dirblock_state to
1548
2378
        IN_MEMORY_UNMODIFIED. It is not currently ready for incremental block
1549
2379
        loading.
1550
2380
        """
1551
2381
        self._read_header_if_needed()
1552
2382
        if self._dirblock_state == DirState.NOT_IN_MEMORY:
1553
 
            # move the _state_file pointer to after the header (in case bisect
1554
 
            # has been called in the mean time)
1555
 
            self._state_file.seek(self._end_of_header)
1556
 
            text = self._state_file.read()
1557
 
            # TODO: check the crc checksums. crc_measured = zlib.crc32(text)
1558
 
 
1559
 
            fields = text.split('\0')
1560
 
            # Remove the last blank entry
1561
 
            trailing = fields.pop()
1562
 
            assert trailing == ''
1563
 
            # consider turning fields into a tuple.
1564
 
 
1565
 
            # skip the first field which is the trailing null from the header.
1566
 
            cur = 1
1567
 
            # Each line now has an extra '\n' field which is not used
1568
 
            # so we just skip over it
1569
 
            # entry size:
1570
 
            #  3 fields for the key
1571
 
            #  + number of fields per tree_data (5) * tree count
1572
 
            #  + newline
1573
 
            num_present_parents = self._num_present_parents()
1574
 
            tree_count = 1 + num_present_parents
1575
 
            entry_size = self._fields_per_entry()
1576
 
            expected_field_count = entry_size * self._num_entries
1577
 
            field_count = len(fields)
1578
 
            # this checks our adjustment, and also catches file too short.
1579
 
            assert field_count - cur == expected_field_count, \
1580
 
                'field count incorrect %s != %s, entry_size=%s, '\
1581
 
                'num_entries=%s fields=%r' % (
1582
 
                    field_count - cur, expected_field_count, entry_size,
1583
 
                    self._num_entries, fields)
1584
 
 
1585
 
            if num_present_parents == 1:
1586
 
                # Bind external functions to local names
1587
 
                _int = int
1588
 
                # We access all fields in order, so we can just iterate over
1589
 
                # them. Grab an straight iterator over the fields. (We use an
1590
 
                # iterator because we don't want to do a lot of additions, nor
1591
 
                # do we want to do a lot of slicing)
1592
 
                next = iter(fields).next
1593
 
                # Move the iterator to the current position
1594
 
                for x in xrange(cur):
1595
 
                    next()
1596
 
                # The two blocks here are deliberate: the root block and the
1597
 
                # contents-of-root block.
1598
 
                self._dirblocks = [('', []), ('', [])]
1599
 
                current_block = self._dirblocks[0][1]
1600
 
                current_dirname = ''
1601
 
                append_entry = current_block.append
1602
 
                for count in xrange(self._num_entries):
1603
 
                    dirname = next()
1604
 
                    name = next()
1605
 
                    file_id = next()
1606
 
                    if dirname != current_dirname:
1607
 
                        # new block - different dirname
1608
 
                        current_block = []
1609
 
                        current_dirname = dirname
1610
 
                        self._dirblocks.append((current_dirname, current_block))
1611
 
                        append_entry = current_block.append
1612
 
                    # we know current_dirname == dirname, so re-use it to avoid
1613
 
                    # creating new strings
1614
 
                    entry = ((current_dirname, name, file_id),
1615
 
                             [(# Current Tree
1616
 
                                 next(),                # minikind
1617
 
                                 next(),                # fingerprint
1618
 
                                 _int(next()),          # size
1619
 
                                 next() == 'y',         # executable
1620
 
                                 next(),                # packed_stat or revision_id
1621
 
                             ),
1622
 
                             ( # Parent 1
1623
 
                                 next(),                # minikind
1624
 
                                 next(),                # fingerprint
1625
 
                                 _int(next()),          # size
1626
 
                                 next() == 'y',         # executable
1627
 
                                 next(),                # packed_stat or revision_id
1628
 
                             ),
1629
 
                             ])
1630
 
                    trailing = next()
1631
 
                    assert trailing == '\n'
1632
 
                    # append the entry to the current block
1633
 
                    append_entry(entry)
1634
 
                self._split_root_dirblock_into_contents()
1635
 
            else:
1636
 
                fields_to_entry = self._get_fields_to_entry()
1637
 
                entries = [fields_to_entry(fields[pos:pos+entry_size])
1638
 
                           for pos in xrange(cur, field_count, entry_size)]
1639
 
                self._entries_to_current_state(entries)
1640
 
            # To convert from format 2  => format 3
1641
 
            # self._dirblocks = sorted(self._dirblocks,
1642
 
            #                          key=lambda blk:blk[0].split('/'))
1643
 
            # To convert from format 3 => format 2
1644
 
            # self._dirblocks = sorted(self._dirblocks)
1645
 
            self._dirblock_state = DirState.IN_MEMORY_UNMODIFIED
 
2383
            _read_dirblocks(self)
1646
2384
 
1647
2385
    def _read_header(self):
1648
2386
        """This reads in the metadata header, and the parent ids.
1656
2394
        parent_line = self._state_file.readline()
1657
2395
        info = parent_line.split('\0')
1658
2396
        num_parents = int(info[0])
1659
 
        assert num_parents == len(info)-2, 'incorrect parent info line'
1660
2397
        self._parents = info[1:-1]
1661
 
 
1662
2398
        ghost_line = self._state_file.readline()
1663
2399
        info = ghost_line.split('\0')
1664
2400
        num_ghosts = int(info[1])
1665
 
        assert num_ghosts == len(info)-3, 'incorrect ghost info line'
1666
2401
        self._ghosts = info[2:-1]
1667
2402
        self._header_state = DirState.IN_MEMORY_UNMODIFIED
1668
2403
        self._end_of_header = self._state_file.tell()
1676
2411
            self._read_header()
1677
2412
 
1678
2413
    def _read_prelude(self):
1679
 
        """Read in the prelude header of the dirstate file
 
2414
        """Read in the prelude header of the dirstate file.
1680
2415
 
1681
2416
        This only reads in the stuff that is not connected to the crc
1682
2417
        checksum. The position will be correct to read in the rest of
1685
2420
        and their ids. Followed by a newline.
1686
2421
        """
1687
2422
        header = self._state_file.readline()
1688
 
        assert header == DirState.HEADER_FORMAT_3, \
1689
 
            'invalid header line: %r' % (header,)
 
2423
        if header != DirState.HEADER_FORMAT_3:
 
2424
            raise errors.BzrError(
 
2425
                'invalid header line: %r' % (header,))
1690
2426
        crc_line = self._state_file.readline()
1691
 
        assert crc_line.startswith('crc32: '), 'missing crc32 checksum'
 
2427
        if not crc_line.startswith('crc32: '):
 
2428
            raise errors.BzrError('missing crc32 checksum: %r' % crc_line)
1692
2429
        self.crc_expected = int(crc_line[len('crc32: '):-1])
1693
2430
        num_entries_line = self._state_file.readline()
1694
 
        assert num_entries_line.startswith('num_entries: '), 'missing num_entries line'
 
2431
        if not num_entries_line.startswith('num_entries: '):
 
2432
            raise errors.BzrError('missing num_entries line')
1695
2433
        self._num_entries = int(num_entries_line[len('num_entries: '):-1])
1696
2434
 
 
2435
    def sha1_from_stat(self, path, stat_result):
 
2436
        """Find a sha1 given a stat lookup."""
 
2437
        return self._get_packed_stat_index().get(pack_stat(stat_result), None)
 
2438
 
 
2439
    def _get_packed_stat_index(self):
 
2440
        """Get a packed_stat index of self._dirblocks."""
 
2441
        if self._packed_stat_index is None:
 
2442
            index = {}
 
2443
            for key, tree_details in self._iter_entries():
 
2444
                if tree_details[0][0] == 'f':
 
2445
                    index[tree_details[0][4]] = tree_details[0][1]
 
2446
            self._packed_stat_index = index
 
2447
        return self._packed_stat_index
 
2448
 
1697
2449
    def save(self):
1698
2450
        """Save any pending changes created during this session.
1699
2451
 
1700
2452
        We reuse the existing file, because that prevents race conditions with
1701
2453
        file creation, and use oslocks on it to prevent concurrent modification
1702
 
        and reads - because dirstates incremental data aggretation is not
 
2454
        and reads - because dirstate's incremental data aggregation is not
1703
2455
        compatible with reading a modified file, and replacing a file in use by
1704
 
        another process is impossible on windows.
 
2456
        another process is impossible on Windows.
1705
2457
 
1706
2458
        A dirstate in read only mode should be smart enough though to validate
1707
2459
        that the file has not changed, and otherwise discard its cache and
1708
2460
        start over, to allow for fine grained read lock duration, so 'status'
1709
2461
        wont block 'commit' - for example.
1710
2462
        """
1711
 
        if (self._header_state == DirState.IN_MEMORY_MODIFIED or
1712
 
            self._dirblock_state == DirState.IN_MEMORY_MODIFIED):
 
2463
        if self._changes_aborted:
 
2464
            # Should this be a warning? For now, I'm expecting that places that
 
2465
            # mark it inconsistent will warn, making a warning here redundant.
 
2466
            trace.mutter('Not saving DirState because '
 
2467
                    '_changes_aborted is set.')
 
2468
            return
 
2469
        # TODO: Since we now distinguish IN_MEMORY_MODIFIED from
 
2470
        #       IN_MEMORY_HASH_MODIFIED, we should only fail quietly if we fail
 
2471
        #       to save an IN_MEMORY_HASH_MODIFIED, and fail *noisily* if we
 
2472
        #       fail to save IN_MEMORY_MODIFIED
 
2473
        if not self._worth_saving():
 
2474
            return
1713
2475
 
1714
 
            grabbed_write_lock = False
1715
 
            if self._lock_state != 'w':
1716
 
                grabbed_write_lock, new_lock = self._lock_token.temporary_write_lock()
1717
 
                # Switch over to the new lock, as the old one may be closed.
 
2476
        grabbed_write_lock = False
 
2477
        if self._lock_state != 'w':
 
2478
            grabbed_write_lock, new_lock = self._lock_token.temporary_write_lock()
 
2479
            # Switch over to the new lock, as the old one may be closed.
 
2480
            # TODO: jam 20070315 We should validate the disk file has
 
2481
            #       not changed contents, since temporary_write_lock may
 
2482
            #       not be an atomic operation.
 
2483
            self._lock_token = new_lock
 
2484
            self._state_file = new_lock.f
 
2485
            if not grabbed_write_lock:
 
2486
                # We couldn't grab a write lock, so we switch back to a read one
 
2487
                return
 
2488
        try:
 
2489
            lines = self.get_lines()
 
2490
            self._state_file.seek(0)
 
2491
            self._state_file.writelines(lines)
 
2492
            self._state_file.truncate()
 
2493
            self._state_file.flush()
 
2494
            self._maybe_fdatasync()
 
2495
            self._mark_unmodified()
 
2496
        finally:
 
2497
            if grabbed_write_lock:
 
2498
                self._lock_token = self._lock_token.restore_read_lock()
 
2499
                self._state_file = self._lock_token.f
1718
2500
                # TODO: jam 20070315 We should validate the disk file has
1719
 
                #       not changed contents. Since temporary_write_lock may
1720
 
                #       not be an atomic operation.
1721
 
                self._lock_token = new_lock
1722
 
                self._state_file = new_lock.f
1723
 
                if not grabbed_write_lock:
1724
 
                    # We couldn't grab a write lock, so we switch back to a read one
1725
 
                    return
1726
 
            try:
1727
 
                self._state_file.seek(0)
1728
 
                self._state_file.writelines(self.get_lines())
1729
 
                self._state_file.truncate()
1730
 
                self._state_file.flush()
1731
 
                self._header_state = DirState.IN_MEMORY_UNMODIFIED
1732
 
                self._dirblock_state = DirState.IN_MEMORY_UNMODIFIED
1733
 
            finally:
1734
 
                if grabbed_write_lock:
1735
 
                    self._lock_token = self._lock_token.restore_read_lock()
1736
 
                    self._state_file = self._lock_token.f
1737
 
                    # TODO: jam 20070315 We should validate the disk file has
1738
 
                    #       not changed contents. Since restore_read_lock may
1739
 
                    #       not be an atomic operation.
 
2501
                #       not changed contents. Since restore_read_lock may
 
2502
                #       not be an atomic operation.                
 
2503
 
 
2504
    def _maybe_fdatasync(self):
 
2505
        """Flush to disk if possible and if not configured off."""
 
2506
        if self._config_stack.get('dirstate.fdatasync'):
 
2507
            osutils.fdatasync(self._state_file.fileno())
 
2508
 
 
2509
    def _worth_saving(self):
 
2510
        """Is it worth saving the dirstate or not?"""
 
2511
        if (self._header_state == DirState.IN_MEMORY_MODIFIED
 
2512
            or self._dirblock_state == DirState.IN_MEMORY_MODIFIED):
 
2513
            return True
 
2514
        if self._dirblock_state == DirState.IN_MEMORY_HASH_MODIFIED:
 
2515
            if self._worth_saving_limit == -1:
 
2516
                # We never save hash changes when the limit is -1
 
2517
                return False
 
2518
            # If we're using smart saving and only a small number of
 
2519
            # entries have changed their hash, don't bother saving. John has
 
2520
            # suggested using a heuristic here based on the size of the
 
2521
            # changed files and/or tree. For now, we go with a configurable
 
2522
            # number of changes, keeping the calculation time
 
2523
            # as low overhead as possible. (This also keeps all existing
 
2524
            # tests passing as the default is 0, i.e. always save.)
 
2525
            if len(self._known_hash_changes) >= self._worth_saving_limit:
 
2526
                return True
 
2527
        return False
1740
2528
 
1741
2529
    def _set_data(self, parent_ids, dirblocks):
1742
2530
        """Set the full dirstate data in memory.
1746
2534
 
1747
2535
        :param parent_ids: A list of parent tree revision ids.
1748
2536
        :param dirblocks: A list containing one tuple for each directory in the
1749
 
            tree. Each tuple contains the directory path and a list of entries 
 
2537
            tree. Each tuple contains the directory path and a list of entries
1750
2538
            found in that directory.
1751
2539
        """
1752
2540
        # our memory copy is now authoritative.
1753
2541
        self._dirblocks = dirblocks
1754
 
        self._header_state = DirState.IN_MEMORY_MODIFIED
1755
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
2542
        self._mark_modified(header_modified=True)
1756
2543
        self._parents = list(parent_ids)
1757
2544
        self._id_index = None
 
2545
        self._packed_stat_index = None
1758
2546
 
1759
2547
    def set_path_id(self, path, new_id):
1760
2548
        """Change the id of path to new_id in the current working tree.
1764
2552
        :param new_id: The new id to assign to the path. This must be a utf8
1765
2553
            file id (not unicode, and not None).
1766
2554
        """
1767
 
        assert new_id.__class__ == str, \
1768
 
            "path_id %r is not a plain string" % (new_id,)
1769
2555
        self._read_dirblocks_if_needed()
1770
2556
        if len(path):
1771
 
            # logic not written
 
2557
            # TODO: logic not written
1772
2558
            raise NotImplementedError(self.set_path_id)
1773
2559
        # TODO: check new id is unique
1774
2560
        entry = self._get_entry(0, path_utf8=path)
1779
2565
        self._make_absent(entry)
1780
2566
        self.update_minimal(('', '', new_id), 'd',
1781
2567
            path_utf8='', packed_stat=entry[1][0][4])
1782
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
2568
        self._mark_modified()
 
2569
        # XXX: This was added by Ian, we need to make sure there
 
2570
        #      are tests for it, because it isn't in bzr.dev TRUNK
 
2571
        #      It looks like the only place it is called is in setting the root
 
2572
        #      id of the tree. So probably we never had an _id_index when we
 
2573
        #      don't even have a root yet.
1783
2574
        if self._id_index is not None:
1784
 
            self._id_index.setdefault(new_id, set()).add(entry[0])
 
2575
            self._add_to_id_index(self._id_index, entry[0])
1785
2576
 
1786
2577
    def set_parent_trees(self, trees, ghosts):
1787
2578
        """Set the parent trees for the dirstate.
1788
2579
 
1789
2580
        :param trees: A list of revision_id, tree tuples. tree must be provided
1790
 
            even if the revision_id refers to a ghost: supply an empty tree in 
 
2581
            even if the revision_id refers to a ghost: supply an empty tree in
1791
2582
            this case.
1792
2583
        :param ghosts: A list of the revision_ids that are ghosts at the time
1793
2584
            of setting.
1794
 
        """ 
1795
 
        # TODO: generate a list of parent indexes to preserve to save 
 
2585
        """
 
2586
        # TODO: generate a list of parent indexes to preserve to save
1796
2587
        # processing specific parent trees. In the common case one tree will
1797
2588
        # be preserved - the left most parent.
1798
2589
        # TODO: if the parent tree is a dirstate, we might want to walk them
1803
2594
        # map and then walk the new parent trees only, mapping them into the
1804
2595
        # dirstate. Walk the dirstate at the same time to remove unreferenced
1805
2596
        # entries.
1806
 
        # for now: 
1807
 
        # sketch: loop over all entries in the dirstate, cherry picking 
 
2597
        # for now:
 
2598
        # sketch: loop over all entries in the dirstate, cherry picking
1808
2599
        # entries from the parent trees, if they are not ghost trees.
1809
2600
        # after we finish walking the dirstate, all entries not in the dirstate
1810
2601
        # are deletes, so we want to append them to the end as per the design
1815
2606
        #   links. We dont't trivially use the inventory from other trees
1816
2607
        #   because this leads to either double touching, or to accessing
1817
2608
        #   missing keys,
1818
 
        # - find other keys containing a path 
1819
 
        # We accumulate each entry via this dictionary, including the root 
 
2609
        # - find other keys containing a path
 
2610
        # We accumulate each entry via this dictionary, including the root
1820
2611
        by_path = {}
1821
2612
        id_index = {}
1822
2613
        # we could do parallel iterators, but because file id data may be
1826
2617
        # parent, but for now the common cases are adding a new parent (merge),
1827
2618
        # and replacing completely (commit), and commit is more common: so
1828
2619
        # optimise merge later.
1829
 
        
 
2620
 
1830
2621
        # ---- start generation of full tree mapping data
1831
2622
        # what trees should we use?
1832
2623
        parent_trees = [tree for rev_id, tree in trees if rev_id not in ghosts]
1833
 
        # how many trees do we end up with 
 
2624
        # how many trees do we end up with
1834
2625
        parent_count = len(parent_trees)
 
2626
        st = static_tuple.StaticTuple
1835
2627
 
1836
2628
        # one: the current tree
1837
2629
        for entry in self._iter_entries():
1838
2630
            # skip entries not in the current tree
1839
 
            if entry[1][0][0] in ('a', 'r'): # absent, relocated
 
2631
            if entry[1][0][0] in 'ar': # absent, relocated
1840
2632
                continue
1841
2633
            by_path[entry[0]] = [entry[1][0]] + \
1842
2634
                [DirState.NULL_PARENT_DETAILS] * parent_count
1843
 
            id_index[entry[0][2]] = set([entry[0]])
1844
 
        
 
2635
            # TODO: Possibly inline this, since we know it isn't present yet
 
2636
            #       id_index[entry[0][2]] = (entry[0],)
 
2637
            self._add_to_id_index(id_index, entry[0])
 
2638
 
1845
2639
        # now the parent trees:
1846
2640
        for tree_index, tree in enumerate(parent_trees):
1847
2641
            # the index is off by one, adjust it.
1852
2646
            # the suffix is from tree_index+1:parent_count+1.
1853
2647
            new_location_suffix = [DirState.NULL_PARENT_DETAILS] * (parent_count - tree_index)
1854
2648
            # now stitch in all the entries from this tree
1855
 
            for path, entry in tree.inventory.iter_entries_by_dir():
 
2649
            last_dirname = None
 
2650
            for path, entry in tree.iter_entries_by_dir():
1856
2651
                # here we process each trees details for each item in the tree.
1857
2652
                # we first update any existing entries for the id at other paths,
1858
2653
                # then we either create or update the entry for the id at the
1861
2656
                # avoid checking all known paths for the id when generating a
1862
2657
                # new entry at this path: by adding the id->path mapping last,
1863
2658
                # all the mappings are valid and have correct relocation
1864
 
                # records where needed. 
 
2659
                # records where needed.
1865
2660
                file_id = entry.file_id
1866
2661
                path_utf8 = path.encode('utf8')
1867
2662
                dirname, basename = osutils.split(path_utf8)
1868
 
                new_entry_key = (dirname, basename, file_id)
 
2663
                if dirname == last_dirname:
 
2664
                    # Try to re-use objects as much as possible
 
2665
                    dirname = last_dirname
 
2666
                else:
 
2667
                    last_dirname = dirname
 
2668
                new_entry_key = st(dirname, basename, file_id)
1869
2669
                # tree index consistency: All other paths for this id in this tree
1870
2670
                # index must point to the correct path.
1871
 
                for entry_key in id_index.setdefault(file_id, set()):
 
2671
                entry_keys = id_index.get(file_id, ())
 
2672
                for entry_key in entry_keys:
1872
2673
                    # TODO:PROFILING: It might be faster to just update
1873
2674
                    # rather than checking if we need to, and then overwrite
1874
2675
                    # the one we are located at.
1876
2677
                        # this file id is at a different path in one of the
1877
2678
                        # other trees, so put absent pointers there
1878
2679
                        # This is the vertical axis in the matrix, all pointing
1879
 
                        # tot he real path.
1880
 
                        by_path[entry_key][tree_index] = ('r', path_utf8, 0, False, '')
1881
 
                # by path consistency: Insert into an existing path record (trivial), or 
1882
 
                # add a new one with relocation pointers for the other tree indexes.
1883
 
                if new_entry_key in id_index[file_id]:
1884
 
                    # there is already an entry where this data belongs, just insert it.
 
2680
                        # to the real path.
 
2681
                        by_path[entry_key][tree_index] = st('r', path_utf8, 0,
 
2682
                                                            False, '')
 
2683
                # by path consistency: Insert into an existing path record
 
2684
                # (trivial), or add a new one with relocation pointers for the
 
2685
                # other tree indexes.
 
2686
                if new_entry_key in entry_keys:
 
2687
                    # there is already an entry where this data belongs, just
 
2688
                    # insert it.
1885
2689
                    by_path[new_entry_key][tree_index] = \
1886
2690
                        self._inv_entry_to_details(entry)
1887
2691
                else:
1891
2695
                    new_details = []
1892
2696
                    for lookup_index in xrange(tree_index):
1893
2697
                        # boundary case: this is the first occurence of file_id
1894
 
                        # so there are no id_indexs, possibly take this out of
 
2698
                        # so there are no id_indexes, possibly take this out of
1895
2699
                        # the loop?
1896
 
                        if not len(id_index[file_id]):
 
2700
                        if not len(entry_keys):
1897
2701
                            new_details.append(DirState.NULL_PARENT_DETAILS)
1898
2702
                        else:
1899
2703
                            # grab any one entry, use it to find the right path.
1900
 
                            # TODO: optimise this to reduce memory use in highly 
1901
 
                            # fragmented situations by reusing the relocation
1902
 
                            # records.
1903
 
                            a_key = iter(id_index[file_id]).next()
 
2704
                            a_key = iter(entry_keys).next()
1904
2705
                            if by_path[a_key][lookup_index][0] in ('r', 'a'):
1905
 
                                # its a pointer or missing statement, use it as is.
 
2706
                                # its a pointer or missing statement, use it as
 
2707
                                # is.
1906
2708
                                new_details.append(by_path[a_key][lookup_index])
1907
2709
                            else:
1908
2710
                                # we have the right key, make a pointer to it.
1909
2711
                                real_path = ('/'.join(a_key[0:2])).strip('/')
1910
 
                                new_details.append(('r', real_path, 0, False, ''))
 
2712
                                new_details.append(st('r', real_path, 0, False,
 
2713
                                                      ''))
1911
2714
                    new_details.append(self._inv_entry_to_details(entry))
1912
2715
                    new_details.extend(new_location_suffix)
1913
2716
                    by_path[new_entry_key] = new_details
1914
 
                    id_index[file_id].add(new_entry_key)
 
2717
                    self._add_to_id_index(id_index, new_entry_key)
1915
2718
        # --- end generation of full tree mappings
1916
2719
 
1917
2720
        # sort and output all the entries
1919
2722
        self._entries_to_current_state(new_entries)
1920
2723
        self._parents = [rev_id for rev_id, tree in trees]
1921
2724
        self._ghosts = list(ghosts)
1922
 
        self._header_state = DirState.IN_MEMORY_MODIFIED
1923
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
2725
        self._mark_modified(header_modified=True)
1924
2726
        self._id_index = id_index
1925
2727
 
1926
2728
    def _sort_entries(self, entry_list):
1930
2732
        try to keep everything in sorted blocks all the time, but sometimes
1931
2733
        it's easier to sort after the fact.
1932
2734
        """
1933
 
        # TODO: Might be faster to do a schwartzian transform?
1934
 
        def _key(entry):
 
2735
        # When sorting, we usually have 10x more entries than directories. (69k
 
2736
        # total entries, 4k directories). So cache the results of splitting.
 
2737
        # Saving time and objects. Also, use StaticTuple to avoid putting all
 
2738
        # of these object into python's garbage collector.
 
2739
        split_dirs = {}
 
2740
        def _key(entry, _split_dirs=split_dirs, _st=static_tuple.StaticTuple):
1935
2741
            # sort by: directory parts, file name, file id
1936
 
            return entry[0][0].split('/'), entry[0][1], entry[0][2]
 
2742
            dirpath, fname, file_id = entry[0]
 
2743
            try:
 
2744
                split = _split_dirs[dirpath]
 
2745
            except KeyError:
 
2746
                split = _st.from_sequence(dirpath.split('/'))
 
2747
                _split_dirs[dirpath] = split
 
2748
            return _st(split, fname, file_id)
1937
2749
        return sorted(entry_list, key=_key)
1938
2750
 
1939
2751
    def set_state_from_inventory(self, new_inv):
1940
 
        """Set new_inv as the current state. 
 
2752
        """Set new_inv as the current state.
1941
2753
 
1942
2754
        This API is called by tree transform, and will usually occur with
1943
2755
        existing parent trees.
1944
2756
 
1945
2757
        :param new_inv: The inventory object to set current state from.
1946
2758
        """
 
2759
        if 'evil' in debug.debug_flags:
 
2760
            trace.mutter_callsite(1,
 
2761
                "set_state_from_inventory called; please mutate the tree instead")
 
2762
        tracing = 'dirstate' in debug.debug_flags
 
2763
        if tracing:
 
2764
            trace.mutter("set_state_from_inventory trace:")
1947
2765
        self._read_dirblocks_if_needed()
1948
2766
        # sketch:
1949
 
        # incremental algorithm:
1950
 
        # two iterators: current data and new data, both in dirblock order. 
 
2767
        # Two iterators: current data and new data, both in dirblock order.
 
2768
        # We zip them together, which tells about entries that are new in the
 
2769
        # inventory, or removed in the inventory, or present in both and
 
2770
        # possibly changed.
 
2771
        #
 
2772
        # You might think we could just synthesize a new dirstate directly
 
2773
        # since we're processing it in the right order.  However, we need to
 
2774
        # also consider there may be any number of parent trees and relocation
 
2775
        # pointers, and we don't want to duplicate that here.
1951
2776
        new_iterator = new_inv.iter_entries_by_dir()
1952
2777
        # we will be modifying the dirstate, so we need a stable iterator. In
1953
2778
        # future we might write one, for now we just clone the state into a
1954
 
        # list - which is a shallow copy, so each 
 
2779
        # list using a copy so that we see every original item and don't have
 
2780
        # to adjust the position when items are inserted or deleted in the
 
2781
        # underlying dirstate.
1955
2782
        old_iterator = iter(list(self._iter_entries()))
1956
2783
        # both must have roots so this is safe:
1957
2784
        current_new = new_iterator.next()
1963
2790
                return None
1964
2791
        while current_new or current_old:
1965
2792
            # skip entries in old that are not really there
1966
 
            if current_old and current_old[1][0][0] in ('r', 'a'):
 
2793
            if current_old and current_old[1][0][0] in 'ar':
1967
2794
                # relocated or absent
1968
2795
                current_old = advance(old_iterator)
1969
2796
                continue
1976
2803
                current_new_minikind = \
1977
2804
                    DirState._kind_to_minikind[current_new[1].kind]
1978
2805
                if current_new_minikind == 't':
1979
 
                    fingerprint = current_new[1].reference_revision
 
2806
                    fingerprint = current_new[1].reference_revision or ''
1980
2807
                else:
 
2808
                    # We normally only insert or remove records, or update
 
2809
                    # them when it has significantly changed.  Then we want to
 
2810
                    # erase its fingerprint.  Unaffected records should
 
2811
                    # normally not be updated at all.
1981
2812
                    fingerprint = ''
1982
2813
            else:
1983
2814
                # for safety disable variables
1984
 
                new_path_utf8 = new_dirname = new_basename = new_id = new_entry_key = None
 
2815
                new_path_utf8 = new_dirname = new_basename = new_id = \
 
2816
                    new_entry_key = None
1985
2817
            # 5 cases, we dont have a value that is strictly greater than everything, so
1986
2818
            # we make both end conditions explicit
1987
2819
            if not current_old:
1988
2820
                # old is finished: insert current_new into the state.
 
2821
                if tracing:
 
2822
                    trace.mutter("Appending from new '%s'.",
 
2823
                        new_path_utf8.decode('utf8'))
1989
2824
                self.update_minimal(new_entry_key, current_new_minikind,
1990
2825
                    executable=current_new[1].executable,
1991
 
                    path_utf8=new_path_utf8, fingerprint=fingerprint)
 
2826
                    path_utf8=new_path_utf8, fingerprint=fingerprint,
 
2827
                    fullscan=True)
1992
2828
                current_new = advance(new_iterator)
1993
2829
            elif not current_new:
1994
2830
                # new is finished
 
2831
                if tracing:
 
2832
                    trace.mutter("Truncating from old '%s/%s'.",
 
2833
                        current_old[0][0].decode('utf8'),
 
2834
                        current_old[0][1].decode('utf8'))
1995
2835
                self._make_absent(current_old)
1996
2836
                current_old = advance(old_iterator)
1997
2837
            elif new_entry_key == current_old[0]:
1998
2838
                # same -  common case
 
2839
                # We're looking at the same path and id in both the dirstate
 
2840
                # and inventory, so just need to update the fields in the
 
2841
                # dirstate from the one in the inventory.
1999
2842
                # TODO: update the record if anything significant has changed.
2000
2843
                # the minimal required trigger is if the execute bit or cached
2001
2844
                # kind has changed.
2002
2845
                if (current_old[1][0][3] != current_new[1].executable or
2003
2846
                    current_old[1][0][0] != current_new_minikind):
 
2847
                    if tracing:
 
2848
                        trace.mutter("Updating in-place change '%s'.",
 
2849
                            new_path_utf8.decode('utf8'))
2004
2850
                    self.update_minimal(current_old[0], current_new_minikind,
2005
2851
                        executable=current_new[1].executable,
2006
 
                        path_utf8=new_path_utf8, fingerprint=fingerprint)
 
2852
                        path_utf8=new_path_utf8, fingerprint=fingerprint,
 
2853
                        fullscan=True)
2007
2854
                # both sides are dealt with, move on
2008
2855
                current_old = advance(old_iterator)
2009
2856
                current_new = advance(new_iterator)
2010
 
            elif (new_entry_key[0].split('/') < current_old[0][0].split('/')
2011
 
                  and new_entry_key[1:] < current_old[0][1:]):
 
2857
            elif (cmp_by_dirs(new_dirname, current_old[0][0]) < 0
 
2858
                  or (new_dirname == current_old[0][0]
 
2859
                      and new_entry_key[1:] < current_old[0][1:])):
2012
2860
                # new comes before:
2013
2861
                # add a entry for this and advance new
 
2862
                if tracing:
 
2863
                    trace.mutter("Inserting from new '%s'.",
 
2864
                        new_path_utf8.decode('utf8'))
2014
2865
                self.update_minimal(new_entry_key, current_new_minikind,
2015
2866
                    executable=current_new[1].executable,
2016
 
                    path_utf8=new_path_utf8, fingerprint=fingerprint)
 
2867
                    path_utf8=new_path_utf8, fingerprint=fingerprint,
 
2868
                    fullscan=True)
2017
2869
                current_new = advance(new_iterator)
2018
2870
            else:
2019
 
                # old comes before:
 
2871
                # we've advanced past the place where the old key would be,
 
2872
                # without seeing it in the new list.  so it must be gone.
 
2873
                if tracing:
 
2874
                    trace.mutter("Deleting from old '%s/%s'.",
 
2875
                        current_old[0][0].decode('utf8'),
 
2876
                        current_old[0][1].decode('utf8'))
2020
2877
                self._make_absent(current_old)
2021
2878
                current_old = advance(old_iterator)
2022
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
2879
        self._mark_modified()
2023
2880
        self._id_index = None
 
2881
        self._packed_stat_index = None
 
2882
        if tracing:
 
2883
            trace.mutter("set_state_from_inventory complete.")
 
2884
 
 
2885
    def set_state_from_scratch(self, working_inv, parent_trees, parent_ghosts):
 
2886
        """Wipe the currently stored state and set it to something new.
 
2887
 
 
2888
        This is a hard-reset for the data we are working with.
 
2889
        """
 
2890
        # Technically, we really want a write lock, but until we write, we
 
2891
        # don't really need it.
 
2892
        self._requires_lock()
 
2893
        # root dir and root dir contents with no children. We have to have a
 
2894
        # root for set_state_from_inventory to work correctly.
 
2895
        empty_root = (('', '', inventory.ROOT_ID),
 
2896
                      [('d', '', 0, False, DirState.NULLSTAT)])
 
2897
        empty_tree_dirblocks = [('', [empty_root]), ('', [])]
 
2898
        self._set_data([], empty_tree_dirblocks)
 
2899
        self.set_state_from_inventory(working_inv)
 
2900
        self.set_parent_trees(parent_trees, parent_ghosts)
2024
2901
 
2025
2902
    def _make_absent(self, current_old):
2026
2903
        """Mark current_old - an entry - as absent for tree 0.
2027
2904
 
2028
 
        :return: True if this was the last details entry for they entry key:
 
2905
        :return: True if this was the last details entry for the entry key:
2029
2906
            that is, if the underlying block has had the entry removed, thus
2030
2907
            shrinking in length.
2031
2908
        """
2032
2909
        # build up paths that this id will be left at after the change is made,
2033
2910
        # so we can update their cross references in tree 0
2034
2911
        all_remaining_keys = set()
2035
 
        # Dont check the working tree, because its going.
 
2912
        # Dont check the working tree, because it's going.
2036
2913
        for details in current_old[1][1:]:
2037
 
            if details[0] not in ('a', 'r'): # absent, relocated
 
2914
            if details[0] not in 'ar': # absent, relocated
2038
2915
                all_remaining_keys.add(current_old[0])
2039
2916
            elif details[0] == 'r': # relocated
2040
2917
                # record the key for the real path.
2047
2924
            # Remove it, its meaningless.
2048
2925
            block = self._find_block(current_old[0])
2049
2926
            entry_index, present = self._find_entry_index(current_old[0], block[1])
2050
 
            assert present, 'could not find entry for %s' % (current_old,)
 
2927
            if not present:
 
2928
                raise AssertionError('could not find entry for %s' % (current_old,))
2051
2929
            block[1].pop(entry_index)
2052
2930
            # if we have an id_index in use, remove this key from it for this id.
2053
2931
            if self._id_index is not None:
2054
 
                self._id_index[current_old[0][2]].remove(current_old[0])
 
2932
                self._remove_from_id_index(self._id_index, current_old[0])
2055
2933
        # update all remaining keys for this id to record it as absent. The
2056
 
        # existing details may either be the record we are making as deleted
 
2934
        # existing details may either be the record we are marking as deleted
2057
2935
        # (if there were other trees with the id present at this path), or may
2058
2936
        # be relocations.
2059
2937
        for update_key in all_remaining_keys:
2060
2938
            update_block_index, present = \
2061
2939
                self._find_block_index_from_key(update_key)
2062
 
            assert present, 'could not find block for %s' % (update_key,)
 
2940
            if not present:
 
2941
                raise AssertionError('could not find block for %s' % (update_key,))
2063
2942
            update_entry_index, present = \
2064
2943
                self._find_entry_index(update_key, self._dirblocks[update_block_index][1])
2065
 
            assert present, 'could not find entry for %s' % (update_key,)
 
2944
            if not present:
 
2945
                raise AssertionError('could not find entry for %s' % (update_key,))
2066
2946
            update_tree_details = self._dirblocks[update_block_index][1][update_entry_index][1]
2067
2947
            # it must not be absent at the moment
2068
 
            assert update_tree_details[0][0] != 'a' # absent
 
2948
            if update_tree_details[0][0] == 'a': # absent
 
2949
                raise AssertionError('bad row %r' % (update_tree_details,))
2069
2950
            update_tree_details[0] = DirState.NULL_PARENT_DETAILS
2070
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
2951
        self._mark_modified()
2071
2952
        return last_reference
2072
2953
 
2073
2954
    def update_minimal(self, key, minikind, executable=False, fingerprint='',
2074
 
                       packed_stat=None, size=0, path_utf8=None):
 
2955
        packed_stat=None, size=0, path_utf8=None, fullscan=False):
2075
2956
        """Update an entry to the state in tree 0.
2076
2957
 
2077
2958
        This will either create a new entry at 'key' or update an existing one.
2082
2963
        :param minikind: The type for the entry ('f' == 'file', 'd' ==
2083
2964
                'directory'), etc.
2084
2965
        :param executable: Should the executable bit be set?
2085
 
        :param fingerprint: Simple fingerprint for new entry.
2086
 
        :param packed_stat: packed stat value for new entry.
 
2966
        :param fingerprint: Simple fingerprint for new entry: canonical-form
 
2967
            sha1 for files, referenced revision id for subtrees, etc.
 
2968
        :param packed_stat: Packed stat value for new entry.
2087
2969
        :param size: Size information for new entry
2088
2970
        :param path_utf8: key[0] + '/' + key[1], just passed in to avoid doing
2089
2971
                extra computation.
 
2972
        :param fullscan: If True then a complete scan of the dirstate is being
 
2973
            done and checking for duplicate rows should not be done. This
 
2974
            should only be set by set_state_from_inventory and similar methods.
 
2975
 
 
2976
        If packed_stat and fingerprint are not given, they're invalidated in
 
2977
        the entry.
2090
2978
        """
2091
2979
        block = self._find_block(key)[1]
2092
2980
        if packed_stat is None:
2093
2981
            packed_stat = DirState.NULLSTAT
 
2982
        # XXX: Some callers pass '' as the packed_stat, and it seems to be
 
2983
        # sometimes present in the dirstate - this seems oddly inconsistent.
 
2984
        # mbp 20071008
2094
2985
        entry_index, present = self._find_entry_index(key, block)
2095
2986
        new_details = (minikind, fingerprint, size, executable, packed_stat)
2096
2987
        id_index = self._get_id_index()
2097
2988
        if not present:
 
2989
            # New record. Check there isn't a entry at this path already.
 
2990
            if not fullscan:
 
2991
                low_index, _ = self._find_entry_index(key[0:2] + ('',), block)
 
2992
                while low_index < len(block):
 
2993
                    entry = block[low_index]
 
2994
                    if entry[0][0:2] == key[0:2]:
 
2995
                        if entry[1][0][0] not in 'ar':
 
2996
                            # This entry has the same path (but a different id) as
 
2997
                            # the new entry we're adding, and is present in ths
 
2998
                            # tree.
 
2999
                            self._raise_invalid(
 
3000
                                ("%s/%s" % key[0:2]).decode('utf8'), key[2],
 
3001
                                "Attempt to add item at path already occupied by "
 
3002
                                "id %r" % entry[0][2])
 
3003
                        low_index += 1
 
3004
                    else:
 
3005
                        break
2098
3006
            # new entry, synthesis cross reference here,
2099
 
            existing_keys = id_index.setdefault(key[2], set())
 
3007
            existing_keys = id_index.get(key[2], ())
2100
3008
            if not existing_keys:
2101
3009
                # not currently in the state, simplest case
2102
3010
                new_entry = key, [new_details] + self._empty_parent_info()
2105
3013
                # grab one of them and use it to generate parent
2106
3014
                # relocation/absent entries.
2107
3015
                new_entry = key, [new_details]
2108
 
                for other_key in existing_keys:
 
3016
                # existing_keys can be changed as we iterate.
 
3017
                for other_key in tuple(existing_keys):
2109
3018
                    # change the record at other to be a pointer to this new
2110
3019
                    # record. The loop looks similar to the change to
2111
3020
                    # relocations when updating an existing record but its not:
2112
3021
                    # the test for existing kinds is different: this can be
2113
3022
                    # factored out to a helper though.
2114
 
                    other_block_index, present = self._find_block_index_from_key(other_key)
2115
 
                    assert present, 'could not find block for %s' % (other_key,)
2116
 
                    other_entry_index, present = self._find_entry_index(other_key,
2117
 
                                            self._dirblocks[other_block_index][1])
2118
 
                    assert present, 'could not find entry for %s' % (other_key,)
2119
 
                    assert path_utf8 is not None
2120
 
                    self._dirblocks[other_block_index][1][other_entry_index][1][0] = \
2121
 
                        ('r', path_utf8, 0, False, '')
 
3023
                    other_block_index, present = self._find_block_index_from_key(
 
3024
                        other_key)
 
3025
                    if not present:
 
3026
                        raise AssertionError('could not find block for %s' % (
 
3027
                            other_key,))
 
3028
                    other_block = self._dirblocks[other_block_index][1]
 
3029
                    other_entry_index, present = self._find_entry_index(
 
3030
                        other_key, other_block)
 
3031
                    if not present:
 
3032
                        raise AssertionError(
 
3033
                            'update_minimal: could not find other entry for %s'
 
3034
                            % (other_key,))
 
3035
                    if path_utf8 is None:
 
3036
                        raise AssertionError('no path')
 
3037
                    # Turn this other location into a reference to the new
 
3038
                    # location. This also updates the aliased iterator
 
3039
                    # (current_old in set_state_from_inventory) so that the old
 
3040
                    # entry, if not already examined, is skipped over by that
 
3041
                    # loop.
 
3042
                    other_entry = other_block[other_entry_index]
 
3043
                    other_entry[1][0] = ('r', path_utf8, 0, False, '')
 
3044
                    if self._maybe_remove_row(other_block, other_entry_index,
 
3045
                                              id_index):
 
3046
                        # If the row holding this was removed, we need to
 
3047
                        # recompute where this entry goes
 
3048
                        entry_index, _ = self._find_entry_index(key, block)
2122
3049
 
 
3050
                # This loop:
 
3051
                # adds a tuple to the new details for each column
 
3052
                #  - either by copying an existing relocation pointer inside that column
 
3053
                #  - or by creating a new pointer to the right row inside that column
2123
3054
                num_present_parents = self._num_present_parents()
 
3055
                if num_present_parents:
 
3056
                    # TODO: This re-evaluates the existing_keys set, do we need
 
3057
                    #       to do that ourselves?
 
3058
                    other_key = list(existing_keys)[0]
2124
3059
                for lookup_index in xrange(1, num_present_parents + 1):
2125
3060
                    # grab any one entry, use it to find the right path.
2126
 
                    # TODO: optimise this to reduce memory use in highly 
 
3061
                    # TODO: optimise this to reduce memory use in highly
2127
3062
                    # fragmented situations by reusing the relocation
2128
3063
                    # records.
2129
3064
                    update_block_index, present = \
2130
3065
                        self._find_block_index_from_key(other_key)
2131
 
                    assert present, 'could not find block for %s' % (other_key,)
 
3066
                    if not present:
 
3067
                        raise AssertionError('could not find block for %s' % (other_key,))
2132
3068
                    update_entry_index, present = \
2133
3069
                        self._find_entry_index(other_key, self._dirblocks[update_block_index][1])
2134
 
                    assert present, 'could not find entry for %s' % (other_key,)
 
3070
                    if not present:
 
3071
                        raise AssertionError('update_minimal: could not find entry for %s' % (other_key,))
2135
3072
                    update_details = self._dirblocks[update_block_index][1][update_entry_index][1][lookup_index]
2136
 
                    if update_details[0] in ('r', 'a'): # relocated, absent
 
3073
                    if update_details[0] in 'ar': # relocated, absent
2137
3074
                        # its a pointer or absent in lookup_index's tree, use
2138
3075
                        # it as is.
2139
3076
                        new_entry[1].append(update_details)
2142
3079
                        pointer_path = osutils.pathjoin(*other_key[0:2])
2143
3080
                        new_entry[1].append(('r', pointer_path, 0, False, ''))
2144
3081
            block.insert(entry_index, new_entry)
2145
 
            existing_keys.add(key)
 
3082
            self._add_to_id_index(id_index, key)
2146
3083
        else:
2147
 
            # Does the new state matter? 
 
3084
            # Does the new state matter?
2148
3085
            block[entry_index][1][0] = new_details
2149
3086
            # parents cannot be affected by what we do.
2150
 
            # other occurences of this id can be found 
 
3087
            # other occurences of this id can be found
2151
3088
            # from the id index.
2152
3089
            # ---
2153
3090
            # tree index consistency: All other paths for this id in this tree
2155
3092
            # we may have passed entries in the state with this file id already
2156
3093
            # that were absent - where parent entries are - and they need to be
2157
3094
            # converted to relocated.
2158
 
            assert path_utf8 is not None
2159
 
            for entry_key in id_index.setdefault(key[2], set()):
 
3095
            if path_utf8 is None:
 
3096
                raise AssertionError('no path')
 
3097
            existing_keys = id_index.get(key[2], ())
 
3098
            if key not in existing_keys:
 
3099
                raise AssertionError('We found the entry in the blocks, but'
 
3100
                    ' the key is not in the id_index.'
 
3101
                    ' key: %s, existing_keys: %s' % (key, existing_keys))
 
3102
            for entry_key in existing_keys:
2160
3103
                # TODO:PROFILING: It might be faster to just update
2161
3104
                # rather than checking if we need to, and then overwrite
2162
3105
                # the one we are located at.
2166
3109
                    # This is the vertical axis in the matrix, all pointing
2167
3110
                    # to the real path.
2168
3111
                    block_index, present = self._find_block_index_from_key(entry_key)
2169
 
                    assert present
 
3112
                    if not present:
 
3113
                        raise AssertionError('not present: %r', entry_key)
2170
3114
                    entry_index, present = self._find_entry_index(entry_key, self._dirblocks[block_index][1])
2171
 
                    assert present
 
3115
                    if not present:
 
3116
                        raise AssertionError('not present: %r', entry_key)
2172
3117
                    self._dirblocks[block_index][1][entry_index][1][0] = \
2173
3118
                        ('r', path_utf8, 0, False, '')
2174
3119
        # add a containing dirblock if needed.
2178
3123
            if not present:
2179
3124
                self._dirblocks.insert(block_index, (subdir_key[0], []))
2180
3125
 
2181
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
3126
        self._mark_modified()
 
3127
 
 
3128
    def _maybe_remove_row(self, block, index, id_index):
 
3129
        """Remove index if it is absent or relocated across the row.
 
3130
        
 
3131
        id_index is updated accordingly.
 
3132
        :return: True if we removed the row, False otherwise
 
3133
        """
 
3134
        present_in_row = False
 
3135
        entry = block[index]
 
3136
        for column in entry[1]:
 
3137
            if column[0] not in 'ar':
 
3138
                present_in_row = True
 
3139
                break
 
3140
        if not present_in_row:
 
3141
            block.pop(index)
 
3142
            self._remove_from_id_index(id_index, entry[0])
 
3143
            return True
 
3144
        return False
2182
3145
 
2183
3146
    def _validate(self):
2184
3147
        """Check that invariants on the dirblock are correct.
2185
3148
 
2186
 
        This can be useful in debugging; it shouldn't be necessary in 
 
3149
        This can be useful in debugging; it shouldn't be necessary in
2187
3150
        normal code.
2188
3151
 
2189
3152
        This must be called with a lock held.
2205
3168
            if not self._dirblocks[0][0] == '':
2206
3169
                raise AssertionError(
2207
3170
                    "dirblocks don't start with root block:\n" + \
2208
 
                    pformat(dirblocks))
 
3171
                    pformat(self._dirblocks))
2209
3172
        if len(self._dirblocks) > 1:
2210
3173
            if not self._dirblocks[1][0] == '':
2211
3174
                raise AssertionError(
2212
3175
                    "dirblocks missing root directory:\n" + \
2213
 
                    pformat(dirblocks))
 
3176
                    pformat(self._dirblocks))
2214
3177
        # the dirblocks are sorted by their path components, name, and dir id
2215
3178
        dir_names = [d[0].split('/')
2216
3179
                for d in self._dirblocks[1:]]
2234
3197
                    "dirblock for %r is not sorted:\n%s" % \
2235
3198
                    (dirblock[0], pformat(dirblock)))
2236
3199
 
2237
 
 
2238
3200
        def check_valid_parent():
2239
3201
            """Check that the current entry has a valid parent.
2240
3202
 
2259
3221
        # For each file id, for each tree: either
2260
3222
        # the file id is not present at all; all rows with that id in the
2261
3223
        # key have it marked as 'absent'
2262
 
        # OR the file id is present under exactly one name; any other entries 
 
3224
        # OR the file id is present under exactly one name; any other entries
2263
3225
        # that mention that id point to the correct name.
2264
3226
        #
2265
3227
        # We check this with a dict per tree pointing either to the present
2275
3237
                "wrong number of entry details for row\n%s" \
2276
3238
                ",\nexpected %d" % \
2277
3239
                (pformat(entry), tree_count))
 
3240
            absent_positions = 0
2278
3241
            for tree_index, tree_state in enumerate(entry[1]):
2279
3242
                this_tree_map = id_path_maps[tree_index]
2280
3243
                minikind = tree_state[0]
 
3244
                if minikind in 'ar':
 
3245
                    absent_positions += 1
2281
3246
                # have we seen this id before in this column?
2282
3247
                if file_id in this_tree_map:
2283
 
                    previous_path = this_tree_map[file_id]
 
3248
                    previous_path, previous_loc = this_tree_map[file_id]
2284
3249
                    # any later mention of this file must be consistent with
2285
3250
                    # what was said before
2286
3251
                    if minikind == 'a':
2300
3265
                        # pointed to by a relocation, which must point here
2301
3266
                        if previous_path != this_path:
2302
3267
                            raise AssertionError(
2303
 
                            "entry %r inconsistent with previous path %r" % \
2304
 
                            (entry, previous_path))
 
3268
                                "entry %r inconsistent with previous path %r "
 
3269
                                "seen at %r" %
 
3270
                                (entry, previous_path, previous_loc))
2305
3271
                        check_valid_parent()
2306
3272
                else:
2307
3273
                    if minikind == 'a':
2308
3274
                        # absent; should not occur anywhere else
2309
 
                        this_tree_map[file_id] = None
 
3275
                        this_tree_map[file_id] = None, this_path
2310
3276
                    elif minikind == 'r':
2311
 
                        # relocation, must occur at expected location 
2312
 
                        this_tree_map[file_id] = tree_state[1]
 
3277
                        # relocation, must occur at expected location
 
3278
                        this_tree_map[file_id] = tree_state[1], this_path
2313
3279
                    else:
2314
 
                        this_tree_map[file_id] = this_path
 
3280
                        this_tree_map[file_id] = this_path, this_path
2315
3281
                        check_valid_parent()
 
3282
            if absent_positions == tree_count:
 
3283
                raise AssertionError(
 
3284
                    "entry %r has no data for any tree." % (entry,))
 
3285
        if self._id_index is not None:
 
3286
            for file_id, entry_keys in self._id_index.iteritems():
 
3287
                for entry_key in entry_keys:
 
3288
                    if entry_key[2] != file_id:
 
3289
                        raise AssertionError(
 
3290
                            'file_id %r did not match entry key %s'
 
3291
                            % (file_id, entry_key))
 
3292
                if len(entry_keys) != len(set(entry_keys)):
 
3293
                    raise AssertionError(
 
3294
                        'id_index contained non-unique data for %s'
 
3295
                        % (entry_keys,))
2316
3296
 
2317
3297
    def _wipe_state(self):
2318
3298
        """Forget all state information about the dirstate."""
2319
3299
        self._header_state = DirState.NOT_IN_MEMORY
2320
3300
        self._dirblock_state = DirState.NOT_IN_MEMORY
 
3301
        self._changes_aborted = False
2321
3302
        self._parents = []
2322
3303
        self._ghosts = []
2323
3304
        self._dirblocks = []
2324
3305
        self._id_index = None
 
3306
        self._packed_stat_index = None
2325
3307
        self._end_of_header = None
2326
3308
        self._cutoff_time = None
2327
3309
        self._split_path_cache = {}
2328
3310
 
2329
3311
    def lock_read(self):
2330
 
        """Acquire a read lock on the dirstate"""
 
3312
        """Acquire a read lock on the dirstate."""
2331
3313
        if self._lock_token is not None:
2332
3314
            raise errors.LockContention(self._lock_token)
2333
3315
        # TODO: jam 20070301 Rather than wiping completely, if the blocks are
2340
3322
        self._wipe_state()
2341
3323
 
2342
3324
    def lock_write(self):
2343
 
        """Acquire a write lock on the dirstate"""
 
3325
        """Acquire a write lock on the dirstate."""
2344
3326
        if self._lock_token is not None:
2345
3327
            raise errors.LockContention(self._lock_token)
2346
3328
        # TODO: jam 20070301 Rather than wiping completely, if the blocks are
2353
3335
        self._wipe_state()
2354
3336
 
2355
3337
    def unlock(self):
2356
 
        """Drop any locks held on the dirstate"""
 
3338
        """Drop any locks held on the dirstate."""
2357
3339
        if self._lock_token is None:
2358
3340
            raise errors.LockNotHeld(self)
2359
3341
        # TODO: jam 20070301 Rather than wiping completely, if the blocks are
2367
3349
        self._split_path_cache = {}
2368
3350
 
2369
3351
    def _requires_lock(self):
2370
 
        """Checks that a lock is currently held by someone on the dirstate"""
 
3352
        """Check that a lock is currently held by someone on the dirstate."""
2371
3353
        if not self._lock_token:
2372
3354
            raise errors.ObjectNotLocked(self)
2373
3355
 
2374
3356
 
2375
 
def bisect_dirblock(dirblocks, dirname, lo=0, hi=None, cache={}):
2376
 
    """Return the index where to insert dirname into the dirblocks.
2377
 
 
2378
 
    The return value idx is such that all directories blocks in dirblock[:idx]
2379
 
    have names < dirname, and all blocks in dirblock[idx:] have names >=
2380
 
    dirname.
2381
 
 
2382
 
    Optional args lo (default 0) and hi (default len(dirblocks)) bound the
2383
 
    slice of a to be searched.
 
3357
def py_update_entry(state, entry, abspath, stat_value,
 
3358
                 _stat_to_minikind=DirState._stat_to_minikind):
 
3359
    """Update the entry based on what is actually on disk.
 
3360
 
 
3361
    This function only calculates the sha if it needs to - if the entry is
 
3362
    uncachable, or clearly different to the first parent's entry, no sha
 
3363
    is calculated, and None is returned.
 
3364
 
 
3365
    :param state: The dirstate this entry is in.
 
3366
    :param entry: This is the dirblock entry for the file in question.
 
3367
    :param abspath: The path on disk for this file.
 
3368
    :param stat_value: The stat value done on the path.
 
3369
    :return: None, or The sha1 hexdigest of the file (40 bytes) or link
 
3370
        target of a symlink.
2384
3371
    """
2385
 
    if hi is None:
2386
 
        hi = len(dirblocks)
2387
3372
    try:
2388
 
        dirname_split = cache[dirname]
 
3373
        minikind = _stat_to_minikind[stat_value.st_mode & 0170000]
2389
3374
    except KeyError:
2390
 
        dirname_split = dirname.split('/')
2391
 
        cache[dirname] = dirname_split
2392
 
    while lo < hi:
2393
 
        mid = (lo+hi)//2
2394
 
        # Grab the dirname for the current dirblock
2395
 
        cur = dirblocks[mid][0]
 
3375
        # Unhandled kind
 
3376
        return None
 
3377
    packed_stat = pack_stat(stat_value)
 
3378
    (saved_minikind, saved_link_or_sha1, saved_file_size,
 
3379
     saved_executable, saved_packed_stat) = entry[1][0]
 
3380
 
 
3381
    if minikind == 'd' and saved_minikind == 't':
 
3382
        minikind = 't'
 
3383
    if (minikind == saved_minikind
 
3384
        and packed_stat == saved_packed_stat):
 
3385
        # The stat hasn't changed since we saved, so we can re-use the
 
3386
        # saved sha hash.
 
3387
        if minikind == 'd':
 
3388
            return None
 
3389
 
 
3390
        # size should also be in packed_stat
 
3391
        if saved_file_size == stat_value.st_size:
 
3392
            return saved_link_or_sha1
 
3393
 
 
3394
    # If we have gotten this far, that means that we need to actually
 
3395
    # process this entry.
 
3396
    link_or_sha1 = None
 
3397
    worth_saving = True
 
3398
    if minikind == 'f':
 
3399
        executable = state._is_executable(stat_value.st_mode,
 
3400
                                         saved_executable)
 
3401
        if state._cutoff_time is None:
 
3402
            state._sha_cutoff_time()
 
3403
        if (stat_value.st_mtime < state._cutoff_time
 
3404
            and stat_value.st_ctime < state._cutoff_time
 
3405
            and len(entry[1]) > 1
 
3406
            and entry[1][1][0] != 'a'):
 
3407
            # Could check for size changes for further optimised
 
3408
            # avoidance of sha1's. However the most prominent case of
 
3409
            # over-shaing is during initial add, which this catches.
 
3410
            # Besides, if content filtering happens, size and sha
 
3411
            # are calculated at the same time, so checking just the size
 
3412
            # gains nothing w.r.t. performance.
 
3413
            link_or_sha1 = state._sha1_file(abspath)
 
3414
            entry[1][0] = ('f', link_or_sha1, stat_value.st_size,
 
3415
                           executable, packed_stat)
 
3416
        else:
 
3417
            entry[1][0] = ('f', '', stat_value.st_size,
 
3418
                           executable, DirState.NULLSTAT)
 
3419
            worth_saving = False
 
3420
    elif minikind == 'd':
 
3421
        link_or_sha1 = None
 
3422
        entry[1][0] = ('d', '', 0, False, packed_stat)
 
3423
        if saved_minikind != 'd':
 
3424
            # This changed from something into a directory. Make sure we
 
3425
            # have a directory block for it. This doesn't happen very
 
3426
            # often, so this doesn't have to be super fast.
 
3427
            block_index, entry_index, dir_present, file_present = \
 
3428
                state._get_block_entry_index(entry[0][0], entry[0][1], 0)
 
3429
            state._ensure_block(block_index, entry_index,
 
3430
                               osutils.pathjoin(entry[0][0], entry[0][1]))
 
3431
        else:
 
3432
            worth_saving = False
 
3433
    elif minikind == 'l':
 
3434
        if saved_minikind == 'l':
 
3435
            worth_saving = False
 
3436
        link_or_sha1 = state._read_link(abspath, saved_link_or_sha1)
 
3437
        if state._cutoff_time is None:
 
3438
            state._sha_cutoff_time()
 
3439
        if (stat_value.st_mtime < state._cutoff_time
 
3440
            and stat_value.st_ctime < state._cutoff_time):
 
3441
            entry[1][0] = ('l', link_or_sha1, stat_value.st_size,
 
3442
                           False, packed_stat)
 
3443
        else:
 
3444
            entry[1][0] = ('l', '', stat_value.st_size,
 
3445
                           False, DirState.NULLSTAT)
 
3446
    if worth_saving:
 
3447
        state._mark_modified([entry])
 
3448
    return link_or_sha1
 
3449
 
 
3450
 
 
3451
class ProcessEntryPython(object):
 
3452
 
 
3453
    __slots__ = ["old_dirname_to_file_id", "new_dirname_to_file_id",
 
3454
        "last_source_parent", "last_target_parent", "include_unchanged",
 
3455
        "partial", "use_filesystem_for_exec", "utf8_decode",
 
3456
        "searched_specific_files", "search_specific_files",
 
3457
        "searched_exact_paths", "search_specific_file_parents", "seen_ids",
 
3458
        "state", "source_index", "target_index", "want_unversioned", "tree"]
 
3459
 
 
3460
    def __init__(self, include_unchanged, use_filesystem_for_exec,
 
3461
        search_specific_files, state, source_index, target_index,
 
3462
        want_unversioned, tree):
 
3463
        self.old_dirname_to_file_id = {}
 
3464
        self.new_dirname_to_file_id = {}
 
3465
        # Are we doing a partial iter_changes?
 
3466
        self.partial = search_specific_files != set([''])
 
3467
        # Using a list so that we can access the values and change them in
 
3468
        # nested scope. Each one is [path, file_id, entry]
 
3469
        self.last_source_parent = [None, None]
 
3470
        self.last_target_parent = [None, None]
 
3471
        self.include_unchanged = include_unchanged
 
3472
        self.use_filesystem_for_exec = use_filesystem_for_exec
 
3473
        self.utf8_decode = cache_utf8._utf8_decode
 
3474
        # for all search_indexs in each path at or under each element of
 
3475
        # search_specific_files, if the detail is relocated: add the id, and
 
3476
        # add the relocated path as one to search if its not searched already.
 
3477
        # If the detail is not relocated, add the id.
 
3478
        self.searched_specific_files = set()
 
3479
        # When we search exact paths without expanding downwards, we record
 
3480
        # that here.
 
3481
        self.searched_exact_paths = set()
 
3482
        self.search_specific_files = search_specific_files
 
3483
        # The parents up to the root of the paths we are searching.
 
3484
        # After all normal paths are returned, these specific items are returned.
 
3485
        self.search_specific_file_parents = set()
 
3486
        # The ids we've sent out in the delta.
 
3487
        self.seen_ids = set()
 
3488
        self.state = state
 
3489
        self.source_index = source_index
 
3490
        self.target_index = target_index
 
3491
        if target_index != 0:
 
3492
            # A lot of code in here depends on target_index == 0
 
3493
            raise errors.BzrError('unsupported target index')
 
3494
        self.want_unversioned = want_unversioned
 
3495
        self.tree = tree
 
3496
 
 
3497
    def _process_entry(self, entry, path_info, pathjoin=osutils.pathjoin):
 
3498
        """Compare an entry and real disk to generate delta information.
 
3499
 
 
3500
        :param path_info: top_relpath, basename, kind, lstat, abspath for
 
3501
            the path of entry. If None, then the path is considered absent in 
 
3502
            the target (Perhaps we should pass in a concrete entry for this ?)
 
3503
            Basename is returned as a utf8 string because we expect this
 
3504
            tuple will be ignored, and don't want to take the time to
 
3505
            decode.
 
3506
        :return: (iter_changes_result, changed). If the entry has not been
 
3507
            handled then changed is None. Otherwise it is False if no content
 
3508
            or metadata changes have occurred, and True if any content or
 
3509
            metadata change has occurred. If self.include_unchanged is True then
 
3510
            if changed is not None, iter_changes_result will always be a result
 
3511
            tuple. Otherwise, iter_changes_result is None unless changed is
 
3512
            True.
 
3513
        """
 
3514
        if self.source_index is None:
 
3515
            source_details = DirState.NULL_PARENT_DETAILS
 
3516
        else:
 
3517
            source_details = entry[1][self.source_index]
 
3518
        target_details = entry[1][self.target_index]
 
3519
        target_minikind = target_details[0]
 
3520
        if path_info is not None and target_minikind in 'fdlt':
 
3521
            if not (self.target_index == 0):
 
3522
                raise AssertionError()
 
3523
            link_or_sha1 = update_entry(self.state, entry,
 
3524
                abspath=path_info[4], stat_value=path_info[3])
 
3525
            # The entry may have been modified by update_entry
 
3526
            target_details = entry[1][self.target_index]
 
3527
            target_minikind = target_details[0]
 
3528
        else:
 
3529
            link_or_sha1 = None
 
3530
        file_id = entry[0][2]
 
3531
        source_minikind = source_details[0]
 
3532
        if source_minikind in 'fdltr' and target_minikind in 'fdlt':
 
3533
            # claimed content in both: diff
 
3534
            #   r    | fdlt   |      | add source to search, add id path move and perform
 
3535
            #        |        |      | diff check on source-target
 
3536
            #   r    | fdlt   |  a   | dangling file that was present in the basis.
 
3537
            #        |        |      | ???
 
3538
            if source_minikind in 'r':
 
3539
                # add the source to the search path to find any children it
 
3540
                # has.  TODO ? : only add if it is a container ?
 
3541
                if not osutils.is_inside_any(self.searched_specific_files,
 
3542
                                             source_details[1]):
 
3543
                    self.search_specific_files.add(source_details[1])
 
3544
                # generate the old path; this is needed for stating later
 
3545
                # as well.
 
3546
                old_path = source_details[1]
 
3547
                old_dirname, old_basename = os.path.split(old_path)
 
3548
                path = pathjoin(entry[0][0], entry[0][1])
 
3549
                old_entry = self.state._get_entry(self.source_index,
 
3550
                                             path_utf8=old_path)
 
3551
                # update the source details variable to be the real
 
3552
                # location.
 
3553
                if old_entry == (None, None):
 
3554
                    raise errors.CorruptDirstate(self.state._filename,
 
3555
                        "entry '%s/%s' is considered renamed from %r"
 
3556
                        " but source does not exist\n"
 
3557
                        "entry: %s" % (entry[0][0], entry[0][1], old_path, entry))
 
3558
                source_details = old_entry[1][self.source_index]
 
3559
                source_minikind = source_details[0]
 
3560
            else:
 
3561
                old_dirname = entry[0][0]
 
3562
                old_basename = entry[0][1]
 
3563
                old_path = path = None
 
3564
            if path_info is None:
 
3565
                # the file is missing on disk, show as removed.
 
3566
                content_change = True
 
3567
                target_kind = None
 
3568
                target_exec = False
 
3569
            else:
 
3570
                # source and target are both versioned and disk file is present.
 
3571
                target_kind = path_info[2]
 
3572
                if target_kind == 'directory':
 
3573
                    if path is None:
 
3574
                        old_path = path = pathjoin(old_dirname, old_basename)
 
3575
                    self.new_dirname_to_file_id[path] = file_id
 
3576
                    if source_minikind != 'd':
 
3577
                        content_change = True
 
3578
                    else:
 
3579
                        # directories have no fingerprint
 
3580
                        content_change = False
 
3581
                    target_exec = False
 
3582
                elif target_kind == 'file':
 
3583
                    if source_minikind != 'f':
 
3584
                        content_change = True
 
3585
                    else:
 
3586
                        # Check the sha. We can't just rely on the size as
 
3587
                        # content filtering may mean differ sizes actually
 
3588
                        # map to the same content
 
3589
                        if link_or_sha1 is None:
 
3590
                            # Stat cache miss:
 
3591
                            statvalue, link_or_sha1 = \
 
3592
                                self.state._sha1_provider.stat_and_sha1(
 
3593
                                path_info[4])
 
3594
                            self.state._observed_sha1(entry, link_or_sha1,
 
3595
                                statvalue)
 
3596
                        content_change = (link_or_sha1 != source_details[1])
 
3597
                    # Target details is updated at update_entry time
 
3598
                    if self.use_filesystem_for_exec:
 
3599
                        # We don't need S_ISREG here, because we are sure
 
3600
                        # we are dealing with a file.
 
3601
                        target_exec = bool(stat.S_IEXEC & path_info[3].st_mode)
 
3602
                    else:
 
3603
                        target_exec = target_details[3]
 
3604
                elif target_kind == 'symlink':
 
3605
                    if source_minikind != 'l':
 
3606
                        content_change = True
 
3607
                    else:
 
3608
                        content_change = (link_or_sha1 != source_details[1])
 
3609
                    target_exec = False
 
3610
                elif target_kind == 'tree-reference':
 
3611
                    if source_minikind != 't':
 
3612
                        content_change = True
 
3613
                    else:
 
3614
                        content_change = False
 
3615
                    target_exec = False
 
3616
                else:
 
3617
                    if path is None:
 
3618
                        path = pathjoin(old_dirname, old_basename)
 
3619
                    raise errors.BadFileKindError(path, path_info[2])
 
3620
            if source_minikind == 'd':
 
3621
                if path is None:
 
3622
                    old_path = path = pathjoin(old_dirname, old_basename)
 
3623
                self.old_dirname_to_file_id[old_path] = file_id
 
3624
            # parent id is the entry for the path in the target tree
 
3625
            if old_basename and old_dirname == self.last_source_parent[0]:
 
3626
                source_parent_id = self.last_source_parent[1]
 
3627
            else:
 
3628
                try:
 
3629
                    source_parent_id = self.old_dirname_to_file_id[old_dirname]
 
3630
                except KeyError:
 
3631
                    source_parent_entry = self.state._get_entry(self.source_index,
 
3632
                                                           path_utf8=old_dirname)
 
3633
                    source_parent_id = source_parent_entry[0][2]
 
3634
                if source_parent_id == entry[0][2]:
 
3635
                    # This is the root, so the parent is None
 
3636
                    source_parent_id = None
 
3637
                else:
 
3638
                    self.last_source_parent[0] = old_dirname
 
3639
                    self.last_source_parent[1] = source_parent_id
 
3640
            new_dirname = entry[0][0]
 
3641
            if entry[0][1] and new_dirname == self.last_target_parent[0]:
 
3642
                target_parent_id = self.last_target_parent[1]
 
3643
            else:
 
3644
                try:
 
3645
                    target_parent_id = self.new_dirname_to_file_id[new_dirname]
 
3646
                except KeyError:
 
3647
                    # TODO: We don't always need to do the lookup, because the
 
3648
                    #       parent entry will be the same as the source entry.
 
3649
                    target_parent_entry = self.state._get_entry(self.target_index,
 
3650
                                                           path_utf8=new_dirname)
 
3651
                    if target_parent_entry == (None, None):
 
3652
                        raise AssertionError(
 
3653
                            "Could not find target parent in wt: %s\nparent of: %s"
 
3654
                            % (new_dirname, entry))
 
3655
                    target_parent_id = target_parent_entry[0][2]
 
3656
                if target_parent_id == entry[0][2]:
 
3657
                    # This is the root, so the parent is None
 
3658
                    target_parent_id = None
 
3659
                else:
 
3660
                    self.last_target_parent[0] = new_dirname
 
3661
                    self.last_target_parent[1] = target_parent_id
 
3662
 
 
3663
            source_exec = source_details[3]
 
3664
            changed = (content_change
 
3665
                or source_parent_id != target_parent_id
 
3666
                or old_basename != entry[0][1]
 
3667
                or source_exec != target_exec
 
3668
                )
 
3669
            if not changed and not self.include_unchanged:
 
3670
                return None, False
 
3671
            else:
 
3672
                if old_path is None:
 
3673
                    old_path = path = pathjoin(old_dirname, old_basename)
 
3674
                    old_path_u = self.utf8_decode(old_path)[0]
 
3675
                    path_u = old_path_u
 
3676
                else:
 
3677
                    old_path_u = self.utf8_decode(old_path)[0]
 
3678
                    if old_path == path:
 
3679
                        path_u = old_path_u
 
3680
                    else:
 
3681
                        path_u = self.utf8_decode(path)[0]
 
3682
                source_kind = DirState._minikind_to_kind[source_minikind]
 
3683
                return (entry[0][2],
 
3684
                       (old_path_u, path_u),
 
3685
                       content_change,
 
3686
                       (True, True),
 
3687
                       (source_parent_id, target_parent_id),
 
3688
                       (self.utf8_decode(old_basename)[0], self.utf8_decode(entry[0][1])[0]),
 
3689
                       (source_kind, target_kind),
 
3690
                       (source_exec, target_exec)), changed
 
3691
        elif source_minikind in 'a' and target_minikind in 'fdlt':
 
3692
            # looks like a new file
 
3693
            path = pathjoin(entry[0][0], entry[0][1])
 
3694
            # parent id is the entry for the path in the target tree
 
3695
            # TODO: these are the same for an entire directory: cache em.
 
3696
            parent_id = self.state._get_entry(self.target_index,
 
3697
                                         path_utf8=entry[0][0])[0][2]
 
3698
            if parent_id == entry[0][2]:
 
3699
                parent_id = None
 
3700
            if path_info is not None:
 
3701
                # Present on disk:
 
3702
                if self.use_filesystem_for_exec:
 
3703
                    # We need S_ISREG here, because we aren't sure if this
 
3704
                    # is a file or not.
 
3705
                    target_exec = bool(
 
3706
                        stat.S_ISREG(path_info[3].st_mode)
 
3707
                        and stat.S_IEXEC & path_info[3].st_mode)
 
3708
                else:
 
3709
                    target_exec = target_details[3]
 
3710
                return (entry[0][2],
 
3711
                       (None, self.utf8_decode(path)[0]),
 
3712
                       True,
 
3713
                       (False, True),
 
3714
                       (None, parent_id),
 
3715
                       (None, self.utf8_decode(entry[0][1])[0]),
 
3716
                       (None, path_info[2]),
 
3717
                       (None, target_exec)), True
 
3718
            else:
 
3719
                # Its a missing file, report it as such.
 
3720
                return (entry[0][2],
 
3721
                       (None, self.utf8_decode(path)[0]),
 
3722
                       False,
 
3723
                       (False, True),
 
3724
                       (None, parent_id),
 
3725
                       (None, self.utf8_decode(entry[0][1])[0]),
 
3726
                       (None, None),
 
3727
                       (None, False)), True
 
3728
        elif source_minikind in 'fdlt' and target_minikind in 'a':
 
3729
            # unversioned, possibly, or possibly not deleted: we dont care.
 
3730
            # if its still on disk, *and* theres no other entry at this
 
3731
            # path [we dont know this in this routine at the moment -
 
3732
            # perhaps we should change this - then it would be an unknown.
 
3733
            old_path = pathjoin(entry[0][0], entry[0][1])
 
3734
            # parent id is the entry for the path in the target tree
 
3735
            parent_id = self.state._get_entry(self.source_index, path_utf8=entry[0][0])[0][2]
 
3736
            if parent_id == entry[0][2]:
 
3737
                parent_id = None
 
3738
            return (entry[0][2],
 
3739
                   (self.utf8_decode(old_path)[0], None),
 
3740
                   True,
 
3741
                   (True, False),
 
3742
                   (parent_id, None),
 
3743
                   (self.utf8_decode(entry[0][1])[0], None),
 
3744
                   (DirState._minikind_to_kind[source_minikind], None),
 
3745
                   (source_details[3], None)), True
 
3746
        elif source_minikind in 'fdlt' and target_minikind in 'r':
 
3747
            # a rename; could be a true rename, or a rename inherited from
 
3748
            # a renamed parent. TODO: handle this efficiently. Its not
 
3749
            # common case to rename dirs though, so a correct but slow
 
3750
            # implementation will do.
 
3751
            if not osutils.is_inside_any(self.searched_specific_files, target_details[1]):
 
3752
                self.search_specific_files.add(target_details[1])
 
3753
        elif source_minikind in 'ra' and target_minikind in 'ra':
 
3754
            # neither of the selected trees contain this file,
 
3755
            # so skip over it. This is not currently directly tested, but
 
3756
            # is indirectly via test_too_much.TestCommands.test_conflicts.
 
3757
            pass
 
3758
        else:
 
3759
            raise AssertionError("don't know how to compare "
 
3760
                "source_minikind=%r, target_minikind=%r"
 
3761
                % (source_minikind, target_minikind))
 
3762
        return None, None
 
3763
 
 
3764
    def __iter__(self):
 
3765
        return self
 
3766
 
 
3767
    def _gather_result_for_consistency(self, result):
 
3768
        """Check a result we will yield to make sure we are consistent later.
 
3769
        
 
3770
        This gathers result's parents into a set to output later.
 
3771
 
 
3772
        :param result: A result tuple.
 
3773
        """
 
3774
        if not self.partial or not result[0]:
 
3775
            return
 
3776
        self.seen_ids.add(result[0])
 
3777
        new_path = result[1][1]
 
3778
        if new_path:
 
3779
            # Not the root and not a delete: queue up the parents of the path.
 
3780
            self.search_specific_file_parents.update(
 
3781
                osutils.parent_directories(new_path.encode('utf8')))
 
3782
            # Add the root directory which parent_directories does not
 
3783
            # provide.
 
3784
            self.search_specific_file_parents.add('')
 
3785
 
 
3786
    def iter_changes(self):
 
3787
        """Iterate over the changes."""
 
3788
        utf8_decode = cache_utf8._utf8_decode
 
3789
        _cmp_by_dirs = cmp_by_dirs
 
3790
        _process_entry = self._process_entry
 
3791
        search_specific_files = self.search_specific_files
 
3792
        searched_specific_files = self.searched_specific_files
 
3793
        splitpath = osutils.splitpath
 
3794
        # sketch:
 
3795
        # compare source_index and target_index at or under each element of search_specific_files.
 
3796
        # follow the following comparison table. Note that we only want to do diff operations when
 
3797
        # the target is fdl because thats when the walkdirs logic will have exposed the pathinfo
 
3798
        # for the target.
 
3799
        # cases:
 
3800
        #
 
3801
        # Source | Target | disk | action
 
3802
        #   r    | fdlt   |      | add source to search, add id path move and perform
 
3803
        #        |        |      | diff check on source-target
 
3804
        #   r    | fdlt   |  a   | dangling file that was present in the basis.
 
3805
        #        |        |      | ???
 
3806
        #   r    |  a     |      | add source to search
 
3807
        #   r    |  a     |  a   |
 
3808
        #   r    |  r     |      | this path is present in a non-examined tree, skip.
 
3809
        #   r    |  r     |  a   | this path is present in a non-examined tree, skip.
 
3810
        #   a    | fdlt   |      | add new id
 
3811
        #   a    | fdlt   |  a   | dangling locally added file, skip
 
3812
        #   a    |  a     |      | not present in either tree, skip
 
3813
        #   a    |  a     |  a   | not present in any tree, skip
 
3814
        #   a    |  r     |      | not present in either tree at this path, skip as it
 
3815
        #        |        |      | may not be selected by the users list of paths.
 
3816
        #   a    |  r     |  a   | not present in either tree at this path, skip as it
 
3817
        #        |        |      | may not be selected by the users list of paths.
 
3818
        #  fdlt  | fdlt   |      | content in both: diff them
 
3819
        #  fdlt  | fdlt   |  a   | deleted locally, but not unversioned - show as deleted ?
 
3820
        #  fdlt  |  a     |      | unversioned: output deleted id for now
 
3821
        #  fdlt  |  a     |  a   | unversioned and deleted: output deleted id
 
3822
        #  fdlt  |  r     |      | relocated in this tree, so add target to search.
 
3823
        #        |        |      | Dont diff, we will see an r,fd; pair when we reach
 
3824
        #        |        |      | this id at the other path.
 
3825
        #  fdlt  |  r     |  a   | relocated in this tree, so add target to search.
 
3826
        #        |        |      | Dont diff, we will see an r,fd; pair when we reach
 
3827
        #        |        |      | this id at the other path.
 
3828
 
 
3829
        # TODO: jam 20070516 - Avoid the _get_entry lookup overhead by
 
3830
        #       keeping a cache of directories that we have seen.
 
3831
 
 
3832
        while search_specific_files:
 
3833
            # TODO: the pending list should be lexically sorted?  the
 
3834
            # interface doesn't require it.
 
3835
            current_root = search_specific_files.pop()
 
3836
            current_root_unicode = current_root.decode('utf8')
 
3837
            searched_specific_files.add(current_root)
 
3838
            # process the entries for this containing directory: the rest will be
 
3839
            # found by their parents recursively.
 
3840
            root_entries = self.state._entries_for_path(current_root)
 
3841
            root_abspath = self.tree.abspath(current_root_unicode)
 
3842
            try:
 
3843
                root_stat = os.lstat(root_abspath)
 
3844
            except OSError, e:
 
3845
                if e.errno == errno.ENOENT:
 
3846
                    # the path does not exist: let _process_entry know that.
 
3847
                    root_dir_info = None
 
3848
                else:
 
3849
                    # some other random error: hand it up.
 
3850
                    raise
 
3851
            else:
 
3852
                root_dir_info = ('', current_root,
 
3853
                    osutils.file_kind_from_stat_mode(root_stat.st_mode), root_stat,
 
3854
                    root_abspath)
 
3855
                if root_dir_info[2] == 'directory':
 
3856
                    if self.tree._directory_is_tree_reference(
 
3857
                        current_root.decode('utf8')):
 
3858
                        root_dir_info = root_dir_info[:2] + \
 
3859
                            ('tree-reference',) + root_dir_info[3:]
 
3860
 
 
3861
            if not root_entries and not root_dir_info:
 
3862
                # this specified path is not present at all, skip it.
 
3863
                continue
 
3864
            path_handled = False
 
3865
            for entry in root_entries:
 
3866
                result, changed = _process_entry(entry, root_dir_info)
 
3867
                if changed is not None:
 
3868
                    path_handled = True
 
3869
                    if changed:
 
3870
                        self._gather_result_for_consistency(result)
 
3871
                    if changed or self.include_unchanged:
 
3872
                        yield result
 
3873
            if self.want_unversioned and not path_handled and root_dir_info:
 
3874
                new_executable = bool(
 
3875
                    stat.S_ISREG(root_dir_info[3].st_mode)
 
3876
                    and stat.S_IEXEC & root_dir_info[3].st_mode)
 
3877
                yield (None,
 
3878
                       (None, current_root_unicode),
 
3879
                       True,
 
3880
                       (False, False),
 
3881
                       (None, None),
 
3882
                       (None, splitpath(current_root_unicode)[-1]),
 
3883
                       (None, root_dir_info[2]),
 
3884
                       (None, new_executable)
 
3885
                      )
 
3886
            initial_key = (current_root, '', '')
 
3887
            block_index, _ = self.state._find_block_index_from_key(initial_key)
 
3888
            if block_index == 0:
 
3889
                # we have processed the total root already, but because the
 
3890
                # initial key matched it we should skip it here.
 
3891
                block_index +=1
 
3892
            if root_dir_info and root_dir_info[2] == 'tree-reference':
 
3893
                current_dir_info = None
 
3894
            else:
 
3895
                dir_iterator = osutils._walkdirs_utf8(root_abspath, prefix=current_root)
 
3896
                try:
 
3897
                    current_dir_info = dir_iterator.next()
 
3898
                except OSError, e:
 
3899
                    # on win32, python2.4 has e.errno == ERROR_DIRECTORY, but
 
3900
                    # python 2.5 has e.errno == EINVAL,
 
3901
                    #            and e.winerror == ERROR_DIRECTORY
 
3902
                    e_winerror = getattr(e, 'winerror', None)
 
3903
                    win_errors = (ERROR_DIRECTORY, ERROR_PATH_NOT_FOUND)
 
3904
                    # there may be directories in the inventory even though
 
3905
                    # this path is not a file on disk: so mark it as end of
 
3906
                    # iterator
 
3907
                    if e.errno in (errno.ENOENT, errno.ENOTDIR, errno.EINVAL):
 
3908
                        current_dir_info = None
 
3909
                    elif (sys.platform == 'win32'
 
3910
                          and (e.errno in win_errors
 
3911
                               or e_winerror in win_errors)):
 
3912
                        current_dir_info = None
 
3913
                    else:
 
3914
                        raise
 
3915
                else:
 
3916
                    if current_dir_info[0][0] == '':
 
3917
                        # remove .bzr from iteration
 
3918
                        bzr_index = bisect.bisect_left(current_dir_info[1], ('.bzr',))
 
3919
                        if current_dir_info[1][bzr_index][0] != '.bzr':
 
3920
                            raise AssertionError()
 
3921
                        del current_dir_info[1][bzr_index]
 
3922
            # walk until both the directory listing and the versioned metadata
 
3923
            # are exhausted.
 
3924
            if (block_index < len(self.state._dirblocks) and
 
3925
                osutils.is_inside(current_root, self.state._dirblocks[block_index][0])):
 
3926
                current_block = self.state._dirblocks[block_index]
 
3927
            else:
 
3928
                current_block = None
 
3929
            while (current_dir_info is not None or
 
3930
                   current_block is not None):
 
3931
                if (current_dir_info and current_block
 
3932
                    and current_dir_info[0][0] != current_block[0]):
 
3933
                    if _cmp_by_dirs(current_dir_info[0][0], current_block[0]) < 0:
 
3934
                        # filesystem data refers to paths not covered by the dirblock.
 
3935
                        # this has two possibilities:
 
3936
                        # A) it is versioned but empty, so there is no block for it
 
3937
                        # B) it is not versioned.
 
3938
 
 
3939
                        # if (A) then we need to recurse into it to check for
 
3940
                        # new unknown files or directories.
 
3941
                        # if (B) then we should ignore it, because we don't
 
3942
                        # recurse into unknown directories.
 
3943
                        path_index = 0
 
3944
                        while path_index < len(current_dir_info[1]):
 
3945
                                current_path_info = current_dir_info[1][path_index]
 
3946
                                if self.want_unversioned:
 
3947
                                    if current_path_info[2] == 'directory':
 
3948
                                        if self.tree._directory_is_tree_reference(
 
3949
                                            current_path_info[0].decode('utf8')):
 
3950
                                            current_path_info = current_path_info[:2] + \
 
3951
                                                ('tree-reference',) + current_path_info[3:]
 
3952
                                    new_executable = bool(
 
3953
                                        stat.S_ISREG(current_path_info[3].st_mode)
 
3954
                                        and stat.S_IEXEC & current_path_info[3].st_mode)
 
3955
                                    yield (None,
 
3956
                                        (None, utf8_decode(current_path_info[0])[0]),
 
3957
                                        True,
 
3958
                                        (False, False),
 
3959
                                        (None, None),
 
3960
                                        (None, utf8_decode(current_path_info[1])[0]),
 
3961
                                        (None, current_path_info[2]),
 
3962
                                        (None, new_executable))
 
3963
                                # dont descend into this unversioned path if it is
 
3964
                                # a dir
 
3965
                                if current_path_info[2] in ('directory',
 
3966
                                                            'tree-reference'):
 
3967
                                    del current_dir_info[1][path_index]
 
3968
                                    path_index -= 1
 
3969
                                path_index += 1
 
3970
 
 
3971
                        # This dir info has been handled, go to the next
 
3972
                        try:
 
3973
                            current_dir_info = dir_iterator.next()
 
3974
                        except StopIteration:
 
3975
                            current_dir_info = None
 
3976
                    else:
 
3977
                        # We have a dirblock entry for this location, but there
 
3978
                        # is no filesystem path for this. This is most likely
 
3979
                        # because a directory was removed from the disk.
 
3980
                        # We don't have to report the missing directory,
 
3981
                        # because that should have already been handled, but we
 
3982
                        # need to handle all of the files that are contained
 
3983
                        # within.
 
3984
                        for current_entry in current_block[1]:
 
3985
                            # entry referring to file not present on disk.
 
3986
                            # advance the entry only, after processing.
 
3987
                            result, changed = _process_entry(current_entry, None)
 
3988
                            if changed is not None:
 
3989
                                if changed:
 
3990
                                    self._gather_result_for_consistency(result)
 
3991
                                if changed or self.include_unchanged:
 
3992
                                    yield result
 
3993
                        block_index +=1
 
3994
                        if (block_index < len(self.state._dirblocks) and
 
3995
                            osutils.is_inside(current_root,
 
3996
                                              self.state._dirblocks[block_index][0])):
 
3997
                            current_block = self.state._dirblocks[block_index]
 
3998
                        else:
 
3999
                            current_block = None
 
4000
                    continue
 
4001
                entry_index = 0
 
4002
                if current_block and entry_index < len(current_block[1]):
 
4003
                    current_entry = current_block[1][entry_index]
 
4004
                else:
 
4005
                    current_entry = None
 
4006
                advance_entry = True
 
4007
                path_index = 0
 
4008
                if current_dir_info and path_index < len(current_dir_info[1]):
 
4009
                    current_path_info = current_dir_info[1][path_index]
 
4010
                    if current_path_info[2] == 'directory':
 
4011
                        if self.tree._directory_is_tree_reference(
 
4012
                            current_path_info[0].decode('utf8')):
 
4013
                            current_path_info = current_path_info[:2] + \
 
4014
                                ('tree-reference',) + current_path_info[3:]
 
4015
                else:
 
4016
                    current_path_info = None
 
4017
                advance_path = True
 
4018
                path_handled = False
 
4019
                while (current_entry is not None or
 
4020
                    current_path_info is not None):
 
4021
                    if current_entry is None:
 
4022
                        # the check for path_handled when the path is advanced
 
4023
                        # will yield this path if needed.
 
4024
                        pass
 
4025
                    elif current_path_info is None:
 
4026
                        # no path is fine: the per entry code will handle it.
 
4027
                        result, changed = _process_entry(current_entry, current_path_info)
 
4028
                        if changed is not None:
 
4029
                            if changed:
 
4030
                                self._gather_result_for_consistency(result)
 
4031
                            if changed or self.include_unchanged:
 
4032
                                yield result
 
4033
                    elif (current_entry[0][1] != current_path_info[1]
 
4034
                          or current_entry[1][self.target_index][0] in 'ar'):
 
4035
                        # The current path on disk doesn't match the dirblock
 
4036
                        # record. Either the dirblock is marked as absent, or
 
4037
                        # the file on disk is not present at all in the
 
4038
                        # dirblock. Either way, report about the dirblock
 
4039
                        # entry, and let other code handle the filesystem one.
 
4040
 
 
4041
                        # Compare the basename for these files to determine
 
4042
                        # which comes first
 
4043
                        if current_path_info[1] < current_entry[0][1]:
 
4044
                            # extra file on disk: pass for now, but only
 
4045
                            # increment the path, not the entry
 
4046
                            advance_entry = False
 
4047
                        else:
 
4048
                            # entry referring to file not present on disk.
 
4049
                            # advance the entry only, after processing.
 
4050
                            result, changed = _process_entry(current_entry, None)
 
4051
                            if changed is not None:
 
4052
                                if changed:
 
4053
                                    self._gather_result_for_consistency(result)
 
4054
                                if changed or self.include_unchanged:
 
4055
                                    yield result
 
4056
                            advance_path = False
 
4057
                    else:
 
4058
                        result, changed = _process_entry(current_entry, current_path_info)
 
4059
                        if changed is not None:
 
4060
                            path_handled = True
 
4061
                            if changed:
 
4062
                                self._gather_result_for_consistency(result)
 
4063
                            if changed or self.include_unchanged:
 
4064
                                yield result
 
4065
                    if advance_entry and current_entry is not None:
 
4066
                        entry_index += 1
 
4067
                        if entry_index < len(current_block[1]):
 
4068
                            current_entry = current_block[1][entry_index]
 
4069
                        else:
 
4070
                            current_entry = None
 
4071
                    else:
 
4072
                        advance_entry = True # reset the advance flaga
 
4073
                    if advance_path and current_path_info is not None:
 
4074
                        if not path_handled:
 
4075
                            # unversioned in all regards
 
4076
                            if self.want_unversioned:
 
4077
                                new_executable = bool(
 
4078
                                    stat.S_ISREG(current_path_info[3].st_mode)
 
4079
                                    and stat.S_IEXEC & current_path_info[3].st_mode)
 
4080
                                try:
 
4081
                                    relpath_unicode = utf8_decode(current_path_info[0])[0]
 
4082
                                except UnicodeDecodeError:
 
4083
                                    raise errors.BadFilenameEncoding(
 
4084
                                        current_path_info[0], osutils._fs_enc)
 
4085
                                yield (None,
 
4086
                                    (None, relpath_unicode),
 
4087
                                    True,
 
4088
                                    (False, False),
 
4089
                                    (None, None),
 
4090
                                    (None, utf8_decode(current_path_info[1])[0]),
 
4091
                                    (None, current_path_info[2]),
 
4092
                                    (None, new_executable))
 
4093
                            # dont descend into this unversioned path if it is
 
4094
                            # a dir
 
4095
                            if current_path_info[2] in ('directory'):
 
4096
                                del current_dir_info[1][path_index]
 
4097
                                path_index -= 1
 
4098
                        # dont descend the disk iterator into any tree
 
4099
                        # paths.
 
4100
                        if current_path_info[2] == 'tree-reference':
 
4101
                            del current_dir_info[1][path_index]
 
4102
                            path_index -= 1
 
4103
                        path_index += 1
 
4104
                        if path_index < len(current_dir_info[1]):
 
4105
                            current_path_info = current_dir_info[1][path_index]
 
4106
                            if current_path_info[2] == 'directory':
 
4107
                                if self.tree._directory_is_tree_reference(
 
4108
                                    current_path_info[0].decode('utf8')):
 
4109
                                    current_path_info = current_path_info[:2] + \
 
4110
                                        ('tree-reference',) + current_path_info[3:]
 
4111
                        else:
 
4112
                            current_path_info = None
 
4113
                        path_handled = False
 
4114
                    else:
 
4115
                        advance_path = True # reset the advance flagg.
 
4116
                if current_block is not None:
 
4117
                    block_index += 1
 
4118
                    if (block_index < len(self.state._dirblocks) and
 
4119
                        osutils.is_inside(current_root, self.state._dirblocks[block_index][0])):
 
4120
                        current_block = self.state._dirblocks[block_index]
 
4121
                    else:
 
4122
                        current_block = None
 
4123
                if current_dir_info is not None:
 
4124
                    try:
 
4125
                        current_dir_info = dir_iterator.next()
 
4126
                    except StopIteration:
 
4127
                        current_dir_info = None
 
4128
        for result in self._iter_specific_file_parents():
 
4129
            yield result
 
4130
 
 
4131
    def _iter_specific_file_parents(self):
 
4132
        """Iter over the specific file parents."""
 
4133
        while self.search_specific_file_parents:
 
4134
            # Process the parent directories for the paths we were iterating.
 
4135
            # Even in extremely large trees this should be modest, so currently
 
4136
            # no attempt is made to optimise.
 
4137
            path_utf8 = self.search_specific_file_parents.pop()
 
4138
            if osutils.is_inside_any(self.searched_specific_files, path_utf8):
 
4139
                # We've examined this path.
 
4140
                continue
 
4141
            if path_utf8 in self.searched_exact_paths:
 
4142
                # We've examined this path.
 
4143
                continue
 
4144
            path_entries = self.state._entries_for_path(path_utf8)
 
4145
            # We need either one or two entries. If the path in
 
4146
            # self.target_index has moved (so the entry in source_index is in
 
4147
            # 'ar') then we need to also look for the entry for this path in
 
4148
            # self.source_index, to output the appropriate delete-or-rename.
 
4149
            selected_entries = []
 
4150
            found_item = False
 
4151
            for candidate_entry in path_entries:
 
4152
                # Find entries present in target at this path:
 
4153
                if candidate_entry[1][self.target_index][0] not in 'ar':
 
4154
                    found_item = True
 
4155
                    selected_entries.append(candidate_entry)
 
4156
                # Find entries present in source at this path:
 
4157
                elif (self.source_index is not None and
 
4158
                    candidate_entry[1][self.source_index][0] not in 'ar'):
 
4159
                    found_item = True
 
4160
                    if candidate_entry[1][self.target_index][0] == 'a':
 
4161
                        # Deleted, emit it here.
 
4162
                        selected_entries.append(candidate_entry)
 
4163
                    else:
 
4164
                        # renamed, emit it when we process the directory it
 
4165
                        # ended up at.
 
4166
                        self.search_specific_file_parents.add(
 
4167
                            candidate_entry[1][self.target_index][1])
 
4168
            if not found_item:
 
4169
                raise AssertionError(
 
4170
                    "Missing entry for specific path parent %r, %r" % (
 
4171
                    path_utf8, path_entries))
 
4172
            path_info = self._path_info(path_utf8, path_utf8.decode('utf8'))
 
4173
            for entry in selected_entries:
 
4174
                if entry[0][2] in self.seen_ids:
 
4175
                    continue
 
4176
                result, changed = self._process_entry(entry, path_info)
 
4177
                if changed is None:
 
4178
                    raise AssertionError(
 
4179
                        "Got entry<->path mismatch for specific path "
 
4180
                        "%r entry %r path_info %r " % (
 
4181
                        path_utf8, entry, path_info))
 
4182
                # Only include changes - we're outside the users requested
 
4183
                # expansion.
 
4184
                if changed:
 
4185
                    self._gather_result_for_consistency(result)
 
4186
                    if (result[6][0] == 'directory' and
 
4187
                        result[6][1] != 'directory'):
 
4188
                        # This stopped being a directory, the old children have
 
4189
                        # to be included.
 
4190
                        if entry[1][self.source_index][0] == 'r':
 
4191
                            # renamed, take the source path
 
4192
                            entry_path_utf8 = entry[1][self.source_index][1]
 
4193
                        else:
 
4194
                            entry_path_utf8 = path_utf8
 
4195
                        initial_key = (entry_path_utf8, '', '')
 
4196
                        block_index, _ = self.state._find_block_index_from_key(
 
4197
                            initial_key)
 
4198
                        if block_index == 0:
 
4199
                            # The children of the root are in block index 1.
 
4200
                            block_index +=1
 
4201
                        current_block = None
 
4202
                        if block_index < len(self.state._dirblocks):
 
4203
                            current_block = self.state._dirblocks[block_index]
 
4204
                            if not osutils.is_inside(
 
4205
                                entry_path_utf8, current_block[0]):
 
4206
                                # No entries for this directory at all.
 
4207
                                current_block = None
 
4208
                        if current_block is not None:
 
4209
                            for entry in current_block[1]:
 
4210
                                if entry[1][self.source_index][0] in 'ar':
 
4211
                                    # Not in the source tree, so doesn't have to be
 
4212
                                    # included.
 
4213
                                    continue
 
4214
                                # Path of the entry itself.
 
4215
 
 
4216
                                self.search_specific_file_parents.add(
 
4217
                                    osutils.pathjoin(*entry[0][:2]))
 
4218
                if changed or self.include_unchanged:
 
4219
                    yield result
 
4220
            self.searched_exact_paths.add(path_utf8)
 
4221
 
 
4222
    def _path_info(self, utf8_path, unicode_path):
 
4223
        """Generate path_info for unicode_path.
 
4224
 
 
4225
        :return: None if unicode_path does not exist, or a path_info tuple.
 
4226
        """
 
4227
        abspath = self.tree.abspath(unicode_path)
2396
4228
        try:
2397
 
            cur_split = cache[cur]
2398
 
        except KeyError:
2399
 
            cur_split = cur.split('/')
2400
 
            cache[cur] = cur_split
2401
 
        if cur_split < dirname_split: lo = mid+1
2402
 
        else: hi = mid
2403
 
    return lo
 
4229
            stat = os.lstat(abspath)
 
4230
        except OSError, e:
 
4231
            if e.errno == errno.ENOENT:
 
4232
                # the path does not exist.
 
4233
                return None
 
4234
            else:
 
4235
                raise
 
4236
        utf8_basename = utf8_path.rsplit('/', 1)[-1]
 
4237
        dir_info = (utf8_path, utf8_basename,
 
4238
            osutils.file_kind_from_stat_mode(stat.st_mode), stat,
 
4239
            abspath)
 
4240
        if dir_info[2] == 'directory':
 
4241
            if self.tree._directory_is_tree_reference(
 
4242
                unicode_path):
 
4243
                self.root_dir_info = self.root_dir_info[:2] + \
 
4244
                    ('tree-reference',) + self.root_dir_info[3:]
 
4245
        return dir_info
 
4246
 
 
4247
 
 
4248
# Try to load the compiled form if possible
 
4249
try:
 
4250
    from bzrlib._dirstate_helpers_pyx import (
 
4251
        _read_dirblocks,
 
4252
        bisect_dirblock,
 
4253
        _bisect_path_left,
 
4254
        _bisect_path_right,
 
4255
        cmp_by_dirs,
 
4256
        pack_stat,
 
4257
        ProcessEntryC as _process_entry,
 
4258
        update_entry as update_entry,
 
4259
        )
 
4260
except ImportError, e:
 
4261
    osutils.failed_to_load_extension(e)
 
4262
    from bzrlib._dirstate_helpers_py import (
 
4263
        _read_dirblocks,
 
4264
        bisect_dirblock,
 
4265
        _bisect_path_left,
 
4266
        _bisect_path_right,
 
4267
        cmp_by_dirs,
 
4268
        pack_stat,
 
4269
        )
 
4270
    # FIXME: It would be nice to be able to track moved lines so that the
 
4271
    # corresponding python code can be moved to the _dirstate_helpers_py
 
4272
    # module. I don't want to break the history for this important piece of
 
4273
    # code so I left the code here -- vila 20090622
 
4274
    update_entry = py_update_entry
 
4275
    _process_entry = ProcessEntryPython