~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/dirstate.py

  • Committer: John Arbash Meinel
  • Date: 2007-04-12 21:33:07 UTC
  • mfrom: (2413.4.1 api-doc-builders)
  • mto: This revision was merged to the branch mainline in revision 2566.
  • Revision ID: john@arbash-meinel.com-20070412213307-kuh07cnzaud12wx1
[merge] api-doc-builder and remove the pydoctor build code for now.

Show diffs side-by-side

added added

removed removed

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