/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/dirstate.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-09-26 05:14:51 UTC
  • mfrom: (3737.1.3 trivial_python_compat)
  • Revision ID: pqm@pqm.ubuntu.com-20080926051451-dvc1qg5inn7msjvr
(jam) Some win32 tweaks for the faster iter_changes code.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2006, 2007, 2008 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
"""DirState objects record the state of a directory and its bzr metadata.
 
18
 
 
19
Pseudo EBNF grammar for the state file. Fields are separated by NULLs, and
 
20
lines by NL. The field delimiters are ommitted in the grammar, line delimiters
 
21
are not - this is done for clarity of reading. All string data is in utf8.
 
22
 
 
23
MINIKIND = "f" | "d" | "l" | "a" | "r" | "t";
 
24
NL = "\n";
 
25
NULL = "\0";
 
26
WHOLE_NUMBER = {digit}, digit;
 
27
BOOLEAN = "y" | "n";
 
28
REVISION_ID = a non-empty utf8 string;
 
29
 
 
30
dirstate format = header line, full checksum, row count, parent details,
 
31
 ghost_details, entries;
 
32
header line = "#bazaar dirstate flat format 3", NL;
 
33
full checksum = "crc32: ", ["-"], WHOLE_NUMBER, NL;
 
34
row count = "num_entries: ", WHOLE_NUMBER, NL;
 
35
parent_details = WHOLE NUMBER, {REVISION_ID}* NL;
 
36
ghost_details = WHOLE NUMBER, {REVISION_ID}*, NL;
 
37
entries = {entry};
 
38
entry = entry_key, current_entry_details, {parent_entry_details};
 
39
entry_key = dirname,  basename, fileid;
 
40
current_entry_details = common_entry_details, working_entry_details;
 
41
parent_entry_details = common_entry_details, history_entry_details;
 
42
common_entry_details = MINIKIND, fingerprint, size, executable
 
43
working_entry_details = packed_stat
 
44
history_entry_details = REVISION_ID;
 
45
executable = BOOLEAN;
 
46
size = WHOLE_NUMBER;
 
47
fingerprint = a nonempty utf8 sequence with meaning defined by minikind.
 
48
 
 
49
Given this definition, the following is useful to know:
 
50
entry (aka row) - all the data for a given key.
 
51
entry[0]: The key (dirname, basename, fileid)
 
52
entry[0][0]: dirname
 
53
entry[0][1]: basename
 
54
entry[0][2]: fileid
 
55
entry[1]: The tree(s) data for this path and id combination.
 
56
entry[1][0]: The current tree
 
57
entry[1][1]: The second tree
 
58
 
 
59
For an entry for a tree, we have (using tree 0 - current tree) to demonstrate:
 
60
entry[1][0][0]: minikind
 
61
entry[1][0][1]: fingerprint
 
62
entry[1][0][2]: size
 
63
entry[1][0][3]: executable
 
64
entry[1][0][4]: packed_stat
 
65
OR (for non tree-0)
 
66
entry[1][1][4]: revision_id
 
67
 
 
68
There may be multiple rows at the root, one per id present in the root, so the
 
69
in memory root row is now:
 
70
self._dirblocks[0] -> ('', [entry ...]),
 
71
and the entries in there are
 
72
entries[0][0]: ''
 
73
entries[0][1]: ''
 
74
entries[0][2]: file_id
 
75
entries[1][0]: The tree data for the current tree for this fileid at /
 
76
etc.
 
77
 
 
78
Kinds:
 
79
'r' is a relocated entry: This path is not present in this tree with this id,
 
80
    but the id can be found at another location. The fingerprint is used to
 
81
    point to the target location.
 
82
'a' is an absent entry: In that tree the id is not present at this path.
 
83
'd' is a directory entry: This path in this tree is a directory with the
 
84
    current file id. There is no fingerprint for directories.
 
85
'f' is a file entry: As for directory, but its a file. The fingerprint is a
 
86
    sha1 value.
 
87
'l' is a symlink entry: As for directory, but a symlink. The fingerprint is the
 
88
    link target.
 
89
't' is a reference to a nested subtree; the fingerprint is the referenced
 
90
    revision.
 
91
 
 
92
Ordering:
 
93
 
 
94
The entries on disk and in memory are ordered according to the following keys:
 
95
 
 
96
    directory, as a list of components
 
97
    filename
 
98
    file-id
 
99
 
 
100
--- Format 1 had the following different definition: ---
 
101
rows = dirname, NULL, basename, NULL, MINIKIND, NULL, fileid_utf8, NULL,
 
102
    WHOLE NUMBER (* size *), NULL, packed stat, NULL, sha1|symlink target, 
 
103
    {PARENT ROW}
 
104
PARENT ROW = NULL, revision_utf8, NULL, MINIKIND, NULL, dirname, NULL,
 
105
    basename, NULL, WHOLE NUMBER (* size *), NULL, "y" | "n", NULL,
 
106
    SHA1
 
107
 
 
108
PARENT ROW's are emitted for every parent that is not in the ghosts details
 
109
line. That is, if the parents are foo, bar, baz, and the ghosts are bar, then
 
110
each row will have a PARENT ROW for foo and baz, but not for bar.
 
111
 
 
112
 
 
113
In any tree, a kind of 'moved' indicates that the fingerprint field
 
114
(which we treat as opaque data specific to the 'kind' anyway) has the
 
115
details for the id of this row in that tree.
 
116
 
 
117
I'm strongly tempted to add a id->path index as well, but I think that
 
118
where we need id->path mapping; we also usually read the whole file, so
 
119
I'm going to skip that for the moment, as we have the ability to locate
 
120
via bisect any path in any tree, and if we lookup things by path, we can
 
121
accumulate an id->path mapping as we go, which will tend to match what we
 
122
looked for.
 
123
 
 
124
I plan to implement this asap, so please speak up now to alter/tweak the
 
125
design - and once we stabilise on this, I'll update the wiki page for
 
126
it.
 
127
 
 
128
The rationale for all this is that we want fast operations for the
 
129
common case (diff/status/commit/merge on all files) and extremely fast
 
130
operations for the less common but still occurs a lot status/diff/commit
 
131
on specific files). Operations on specific files involve a scan for all
 
132
the children of a path, *in every involved tree*, which the current
 
133
format did not accommodate. 
 
134
----
 
135
 
 
136
Design priorities:
 
137
 1) Fast end to end use for bzr's top 5 uses cases. (commmit/diff/status/merge/???)
 
138
 2) fall back current object model as needed.
 
139
 3) scale usably to the largest trees known today - say 50K entries. (mozilla
 
140
    is an example of this)
 
141
 
 
142
 
 
143
Locking:
 
144
 Eventually reuse dirstate objects across locks IFF the dirstate file has not
 
145
 been modified, but will require that we flush/ignore cached stat-hit data
 
146
 because we won't want to restat all files on disk just because a lock was
 
147
 acquired, yet we cannot trust the data after the previous lock was released.
 
148
 
 
149
Memory representation:
 
150
 vector of all directories, and vector of the childen ?
 
151
   i.e. 
 
152
     root_entrie = (direntry for root, [parent_direntries_for_root]), 
 
153
     dirblocks = [
 
154
     ('', ['data for achild', 'data for bchild', 'data for cchild'])
 
155
     ('dir', ['achild', 'cchild', 'echild'])
 
156
     ]
 
157
    - single bisect to find N subtrees from a path spec
 
158
    - in-order for serialisation - this is 'dirblock' grouping.
 
159
    - insertion of a file '/a' affects only the '/' child-vector, that is, to
 
160
      insert 10K elements from scratch does not generates O(N^2) memoves of a
 
161
      single vector, rather each individual, which tends to be limited to a 
 
162
      manageable number. Will scale badly on trees with 10K entries in a 
 
163
      single directory. compare with Inventory.InventoryDirectory which has
 
164
      a dictionary for the children. No bisect capability, can only probe for
 
165
      exact matches, or grab all elements and sort.
 
166
    - What's the risk of error here? Once we have the base format being processed
 
167
      we should have a net win regardless of optimality. So we are going to 
 
168
      go with what seems reasonable.
 
169
open questions:
 
170
 
 
171
Maybe we should do a test profile of the core structure - 10K simulated
 
172
searches/lookups/etc?
 
173
 
 
174
Objects for each row?
 
175
The lifetime of Dirstate objects is current per lock, but see above for
 
176
possible extensions. The lifetime of a row from a dirstate is expected to be
 
177
very short in the optimistic case: which we are optimising for. For instance,
 
178
subtree status will determine from analysis of the disk data what rows need to
 
179
be examined at all, and will be able to determine from a single row whether
 
180
that file has altered or not, so we are aiming to process tens of thousands of
 
181
entries each second within the dirstate context, before exposing anything to
 
182
the larger codebase. This suggests we want the time for a single file
 
183
comparison to be < 0.1 milliseconds. That would give us 10000 paths per second
 
184
processed, and to scale to 100 thousand we'll another order of magnitude to do
 
185
that. Now, as the lifetime for all unchanged entries is the time to parse, stat
 
186
the file on disk, and then immediately discard, the overhead of object creation
 
187
becomes a significant cost.
 
188
 
 
189
Figures: Creating a tuple from from 3 elements was profiled at 0.0625
 
190
microseconds, whereas creating a object which is subclassed from tuple was
 
191
0.500 microseconds, and creating an object with 3 elements and slots was 3
 
192
microseconds long. 0.1 milliseconds is 100 microseconds, and ideally we'll get
 
193
down to 10 microseconds for the total processing - having 33% of that be object
 
194
creation is a huge overhead. There is a potential cost in using tuples within
 
195
each row which is that the conditional code to do comparisons may be slower
 
196
than method invocation, but method invocation is known to be slow due to stack
 
197
frame creation, so avoiding methods in these tight inner loops in unfortunately
 
198
desirable. We can consider a pyrex version of this with objects in future if
 
199
desired.
 
200
 
 
201
"""
 
202
 
 
203
import bisect
 
204
import binascii
 
205
import errno
 
206
import os
 
207
from stat import S_IEXEC
 
208
import stat
 
209
import struct
 
210
import sys
 
211
import time
 
212
import zlib
 
213
 
 
214
from bzrlib import (
 
215
    cache_utf8,
 
216
    debug,
 
217
    errors,
 
218
    inventory,
 
219
    lock,
 
220
    osutils,
 
221
    trace,
 
222
    )
 
223
 
 
224
 
 
225
# This is the Windows equivalent of ENOTDIR
 
226
# It is defined in pywin32.winerror, but we don't want a strong dependency for
 
227
# just an error code.
 
228
ERROR_PATH_NOT_FOUND = 3
 
229
ERROR_DIRECTORY = 267
 
230
 
 
231
 
 
232
if not getattr(struct, '_compile', None):
 
233
    # Cannot pre-compile the dirstate pack_stat
 
234
    def pack_stat(st, _encode=binascii.b2a_base64, _pack=struct.pack):
 
235
        """Convert stat values into a packed representation."""
 
236
        return _encode(_pack('>LLLLLL', st.st_size, int(st.st_mtime),
 
237
            int(st.st_ctime), st.st_dev, st.st_ino & 0xFFFFFFFF,
 
238
            st.st_mode))[:-1]
 
239
else:
 
240
    # compile the struct compiler we need, so as to only do it once
 
241
    from _struct import Struct
 
242
    _compiled_pack = Struct('>LLLLLL').pack
 
243
    def pack_stat(st, _encode=binascii.b2a_base64, _pack=_compiled_pack):
 
244
        """Convert stat values into a packed representation."""
 
245
        # jam 20060614 it isn't really worth removing more entries if we
 
246
        # are going to leave it in packed form.
 
247
        # With only st_mtime and st_mode filesize is 5.5M and read time is 275ms
 
248
        # With all entries, filesize is 5.9M and read time is maybe 280ms
 
249
        # well within the noise margin
 
250
 
 
251
        # base64 encoding always adds a final newline, so strip it off
 
252
        # The current version
 
253
        return _encode(_pack(st.st_size, int(st.st_mtime), int(st.st_ctime),
 
254
            st.st_dev, st.st_ino & 0xFFFFFFFF, st.st_mode))[:-1]
 
255
        # This is 0.060s / 1.520s faster by not encoding as much information
 
256
        # return _encode(_pack('>LL', int(st.st_mtime), st.st_mode))[:-1]
 
257
        # This is not strictly faster than _encode(_pack())[:-1]
 
258
        # return '%X.%X.%X.%X.%X.%X' % (
 
259
        #      st.st_size, int(st.st_mtime), int(st.st_ctime),
 
260
        #      st.st_dev, st.st_ino, st.st_mode)
 
261
        # Similar to the _encode(_pack('>LL'))
 
262
        # return '%X.%X' % (int(st.st_mtime), st.st_mode)
 
263
 
 
264
 
 
265
class DirState(object):
 
266
    """Record directory and metadata state for fast access.
 
267
 
 
268
    A dirstate is a specialised data structure for managing local working
 
269
    tree state information. Its not yet well defined whether it is platform
 
270
    specific, and if it is how we detect/parameterize that.
 
271
 
 
272
    Dirstates use the usual lock_write, lock_read and unlock mechanisms.
 
273
    Unlike most bzr disk formats, DirStates must be locked for reading, using
 
274
    lock_read.  (This is an os file lock internally.)  This is necessary
 
275
    because the file can be rewritten in place.
 
276
 
 
277
    DirStates must be explicitly written with save() to commit changes; just
 
278
    unlocking them does not write the changes to disk.
 
279
    """
 
280
 
 
281
    _kind_to_minikind = {
 
282
            'absent': 'a',
 
283
            'file': 'f',
 
284
            'directory': 'd',
 
285
            'relocated': 'r',
 
286
            'symlink': 'l',
 
287
            'tree-reference': 't',
 
288
        }
 
289
    _minikind_to_kind = {
 
290
            'a': 'absent',
 
291
            'f': 'file',
 
292
            'd': 'directory',
 
293
            'l':'symlink',
 
294
            'r': 'relocated',
 
295
            't': 'tree-reference',
 
296
        }
 
297
    _stat_to_minikind = {
 
298
        stat.S_IFDIR:'d',
 
299
        stat.S_IFREG:'f',
 
300
        stat.S_IFLNK:'l',
 
301
    }
 
302
    _to_yesno = {True:'y', False: 'n'} # TODO profile the performance gain
 
303
     # of using int conversion rather than a dict here. AND BLAME ANDREW IF
 
304
     # it is faster.
 
305
 
 
306
    # TODO: jam 20070221 Figure out what to do if we have a record that exceeds
 
307
    #       the BISECT_PAGE_SIZE. For now, we just have to make it large enough
 
308
    #       that we are sure a single record will always fit.
 
309
    BISECT_PAGE_SIZE = 4096
 
310
 
 
311
    NOT_IN_MEMORY = 0
 
312
    IN_MEMORY_UNMODIFIED = 1
 
313
    IN_MEMORY_MODIFIED = 2
 
314
 
 
315
    # A pack_stat (the x's) that is just noise and will never match the output
 
316
    # of base64 encode.
 
317
    NULLSTAT = 'x' * 32
 
318
    NULL_PARENT_DETAILS = ('a', '', 0, False, '')
 
319
 
 
320
    HEADER_FORMAT_2 = '#bazaar dirstate flat format 2\n'
 
321
    HEADER_FORMAT_3 = '#bazaar dirstate flat format 3\n'
 
322
 
 
323
    def __init__(self, path):
 
324
        """Create a  DirState object.
 
325
 
 
326
        :param path: The path at which the dirstate file on disk should live.
 
327
        """
 
328
        # _header_state and _dirblock_state represent the current state
 
329
        # of the dirstate metadata and the per-row data respectiely.
 
330
        # NOT_IN_MEMORY indicates that no data is in memory
 
331
        # IN_MEMORY_UNMODIFIED indicates that what we have in memory
 
332
        #   is the same as is on disk
 
333
        # IN_MEMORY_MODIFIED indicates that we have a modified version
 
334
        #   of what is on disk. 
 
335
        # In future we will add more granularity, for instance _dirblock_state
 
336
        # will probably support partially-in-memory as a separate variable,
 
337
        # allowing for partially-in-memory unmodified and partially-in-memory
 
338
        # modified states.
 
339
        self._header_state = DirState.NOT_IN_MEMORY
 
340
        self._dirblock_state = DirState.NOT_IN_MEMORY
 
341
        # If true, an error has been detected while updating the dirstate, and 
 
342
        # for safety we're not going to commit to disk.
 
343
        self._changes_aborted = False
 
344
        self._dirblocks = []
 
345
        self._ghosts = []
 
346
        self._parents = []
 
347
        self._state_file = None
 
348
        self._filename = path
 
349
        self._lock_token = None
 
350
        self._lock_state = None
 
351
        self._id_index = None
 
352
        # a map from packed_stat to sha's.
 
353
        self._packed_stat_index = None
 
354
        self._end_of_header = None
 
355
        self._cutoff_time = None
 
356
        self._split_path_cache = {}
 
357
        self._bisect_page_size = DirState.BISECT_PAGE_SIZE
 
358
        if 'hashcache' in debug.debug_flags:
 
359
            self._sha1_file = self._sha1_file_and_mutter
 
360
        else:
 
361
            self._sha1_file = osutils.sha_file_by_name
 
362
        # These two attributes provide a simple cache for lookups into the
 
363
        # dirstate in-memory vectors. By probing respectively for the last
 
364
        # block, and for the next entry, we save nearly 2 bisections per path
 
365
        # during commit.
 
366
        self._last_block_index = None
 
367
        self._last_entry_index = None
 
368
 
 
369
    def __repr__(self):
 
370
        return "%s(%r)" % \
 
371
            (self.__class__.__name__, self._filename)
 
372
 
 
373
    def add(self, path, file_id, kind, stat, fingerprint):
 
374
        """Add a path to be tracked.
 
375
 
 
376
        :param path: The path within the dirstate - '' is the root, 'foo' is the
 
377
            path foo within the root, 'foo/bar' is the path bar within foo 
 
378
            within the root.
 
379
        :param file_id: The file id of the path being added.
 
380
        :param kind: The kind of the path, as a string like 'file', 
 
381
            'directory', etc.
 
382
        :param stat: The output of os.lstat for the path.
 
383
        :param fingerprint: The sha value of the file,
 
384
            or the target of a symlink,
 
385
            or the referenced revision id for tree-references,
 
386
            or '' for directories.
 
387
        """
 
388
        # adding a file:
 
389
        # find the block its in. 
 
390
        # find the location in the block.
 
391
        # check its not there
 
392
        # add it.
 
393
        #------- copied from inventory.ensure_normalized_name - keep synced.
 
394
        # --- normalized_filename wants a unicode basename only, so get one.
 
395
        dirname, basename = osutils.split(path)
 
396
        # we dont import normalized_filename directly because we want to be
 
397
        # able to change the implementation at runtime for tests.
 
398
        norm_name, can_access = osutils.normalized_filename(basename)
 
399
        if norm_name != basename:
 
400
            if can_access:
 
401
                basename = norm_name
 
402
            else:
 
403
                raise errors.InvalidNormalization(path)
 
404
        # you should never have files called . or ..; just add the directory
 
405
        # in the parent, or according to the special treatment for the root
 
406
        if basename == '.' or basename == '..':
 
407
            raise errors.InvalidEntryName(path)
 
408
        # now that we've normalised, we need the correct utf8 path and 
 
409
        # dirname and basename elements. This single encode and split should be
 
410
        # faster than three separate encodes.
 
411
        utf8path = (dirname + '/' + basename).strip('/').encode('utf8')
 
412
        dirname, basename = osutils.split(utf8path)
 
413
        # uses __class__ for speed; the check is needed for safety
 
414
        if file_id.__class__ is not str:
 
415
            raise AssertionError(
 
416
                "must be a utf8 file_id not %s" % (type(file_id), ))
 
417
        # Make sure the file_id does not exist in this tree
 
418
        file_id_entry = self._get_entry(0, fileid_utf8=file_id)
 
419
        if file_id_entry != (None, None):
 
420
            path = osutils.pathjoin(file_id_entry[0][0], file_id_entry[0][1])
 
421
            kind = DirState._minikind_to_kind[file_id_entry[1][0][0]]
 
422
            info = '%s:%s' % (kind, path)
 
423
            raise errors.DuplicateFileId(file_id, info)
 
424
        first_key = (dirname, basename, '')
 
425
        block_index, present = self._find_block_index_from_key(first_key)
 
426
        if present:
 
427
            # check the path is not in the tree
 
428
            block = self._dirblocks[block_index][1]
 
429
            entry_index, _ = self._find_entry_index(first_key, block)
 
430
            while (entry_index < len(block) and 
 
431
                block[entry_index][0][0:2] == first_key[0:2]):
 
432
                if block[entry_index][1][0][0] not in 'ar':
 
433
                    # this path is in the dirstate in the current tree.
 
434
                    raise Exception, "adding already added path!"
 
435
                entry_index += 1
 
436
        else:
 
437
            # The block where we want to put the file is not present. But it
 
438
            # might be because the directory was empty, or not loaded yet. Look
 
439
            # for a parent entry, if not found, raise NotVersionedError
 
440
            parent_dir, parent_base = osutils.split(dirname)
 
441
            parent_block_idx, parent_entry_idx, _, parent_present = \
 
442
                self._get_block_entry_index(parent_dir, parent_base, 0)
 
443
            if not parent_present:
 
444
                raise errors.NotVersionedError(path, str(self))
 
445
            self._ensure_block(parent_block_idx, parent_entry_idx, dirname)
 
446
        block = self._dirblocks[block_index][1]
 
447
        entry_key = (dirname, basename, file_id)
 
448
        if stat is None:
 
449
            size = 0
 
450
            packed_stat = DirState.NULLSTAT
 
451
        else:
 
452
            size = stat.st_size
 
453
            packed_stat = pack_stat(stat)
 
454
        parent_info = self._empty_parent_info()
 
455
        minikind = DirState._kind_to_minikind[kind]
 
456
        if kind == 'file':
 
457
            entry_data = entry_key, [
 
458
                (minikind, fingerprint, size, False, packed_stat),
 
459
                ] + parent_info
 
460
        elif kind == 'directory':
 
461
            entry_data = entry_key, [
 
462
                (minikind, '', 0, False, packed_stat),
 
463
                ] + parent_info
 
464
        elif kind == 'symlink':
 
465
            entry_data = entry_key, [
 
466
                (minikind, fingerprint, size, False, packed_stat),
 
467
                ] + parent_info
 
468
        elif kind == 'tree-reference':
 
469
            entry_data = entry_key, [
 
470
                (minikind, fingerprint, 0, False, packed_stat),
 
471
                ] + parent_info
 
472
        else:
 
473
            raise errors.BzrError('unknown kind %r' % kind)
 
474
        entry_index, present = self._find_entry_index(entry_key, block)
 
475
        if not present:
 
476
            block.insert(entry_index, entry_data)
 
477
        else:
 
478
            if block[entry_index][1][0][0] != 'a':
 
479
                raise AssertionError(" %r(%r) already added" % (basename, file_id))
 
480
            block[entry_index][1][0] = entry_data[1][0]
 
481
 
 
482
        if kind == 'directory':
 
483
           # insert a new dirblock
 
484
           self._ensure_block(block_index, entry_index, utf8path)
 
485
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
486
        if self._id_index:
 
487
            self._id_index.setdefault(entry_key[2], set()).add(entry_key)
 
488
 
 
489
    def _bisect(self, paths):
 
490
        """Bisect through the disk structure for specific rows.
 
491
 
 
492
        :param paths: A list of paths to find
 
493
        :return: A dict mapping path => entries for found entries. Missing
 
494
                 entries will not be in the map.
 
495
                 The list is not sorted, and entries will be populated
 
496
                 based on when they were read.
 
497
        """
 
498
        self._requires_lock()
 
499
        # We need the file pointer to be right after the initial header block
 
500
        self._read_header_if_needed()
 
501
        # If _dirblock_state was in memory, we should just return info from
 
502
        # there, this function is only meant to handle when we want to read
 
503
        # part of the disk.
 
504
        if self._dirblock_state != DirState.NOT_IN_MEMORY:
 
505
            raise AssertionError("bad dirblock state %r" % self._dirblock_state)
 
506
 
 
507
        # The disk representation is generally info + '\0\n\0' at the end. But
 
508
        # for bisecting, it is easier to treat this as '\0' + info + '\0\n'
 
509
        # Because it means we can sync on the '\n'
 
510
        state_file = self._state_file
 
511
        file_size = os.fstat(state_file.fileno()).st_size
 
512
        # We end up with 2 extra fields, we should have a trailing '\n' to
 
513
        # ensure that we read the whole record, and we should have a precursur
 
514
        # '' which ensures that we start after the previous '\n'
 
515
        entry_field_count = self._fields_per_entry() + 1
 
516
 
 
517
        low = self._end_of_header
 
518
        high = file_size - 1 # Ignore the final '\0'
 
519
        # Map from (dir, name) => entry
 
520
        found = {}
 
521
 
 
522
        # Avoid infinite seeking
 
523
        max_count = 30*len(paths)
 
524
        count = 0
 
525
        # pending is a list of places to look.
 
526
        # each entry is a tuple of low, high, dir_names
 
527
        #   low -> the first byte offset to read (inclusive)
 
528
        #   high -> the last byte offset (inclusive)
 
529
        #   dir_names -> The list of (dir, name) pairs that should be found in
 
530
        #                the [low, high] range
 
531
        pending = [(low, high, paths)]
 
532
 
 
533
        page_size = self._bisect_page_size
 
534
 
 
535
        fields_to_entry = self._get_fields_to_entry()
 
536
 
 
537
        while pending:
 
538
            low, high, cur_files = pending.pop()
 
539
 
 
540
            if not cur_files or low >= high:
 
541
                # Nothing to find
 
542
                continue
 
543
 
 
544
            count += 1
 
545
            if count > max_count:
 
546
                raise errors.BzrError('Too many seeks, most likely a bug.')
 
547
 
 
548
            mid = max(low, (low+high-page_size)/2)
 
549
 
 
550
            state_file.seek(mid)
 
551
            # limit the read size, so we don't end up reading data that we have
 
552
            # already read.
 
553
            read_size = min(page_size, (high-mid)+1)
 
554
            block = state_file.read(read_size)
 
555
 
 
556
            start = mid
 
557
            entries = block.split('\n')
 
558
 
 
559
            if len(entries) < 2:
 
560
                # We didn't find a '\n', so we cannot have found any records.
 
561
                # So put this range back and try again. But we know we have to
 
562
                # increase the page size, because a single read did not contain
 
563
                # a record break (so records must be larger than page_size)
 
564
                page_size *= 2
 
565
                pending.append((low, high, cur_files))
 
566
                continue
 
567
 
 
568
            # Check the first and last entries, in case they are partial, or if
 
569
            # we don't care about the rest of this page
 
570
            first_entry_num = 0
 
571
            first_fields = entries[0].split('\0')
 
572
            if len(first_fields) < entry_field_count:
 
573
                # We didn't get the complete first entry
 
574
                # so move start, and grab the next, which
 
575
                # should be a full entry
 
576
                start += len(entries[0])+1
 
577
                first_fields = entries[1].split('\0')
 
578
                first_entry_num = 1
 
579
 
 
580
            if len(first_fields) <= 2:
 
581
                # We didn't even get a filename here... what do we do?
 
582
                # Try a large page size and repeat this query
 
583
                page_size *= 2
 
584
                pending.append((low, high, cur_files))
 
585
                continue
 
586
            else:
 
587
                # Find what entries we are looking for, which occur before and
 
588
                # after this first record.
 
589
                after = start
 
590
                if first_fields[1]:
 
591
                    first_path = first_fields[1] + '/' + first_fields[2]
 
592
                else:
 
593
                    first_path = first_fields[2]
 
594
                first_loc = _bisect_path_left(cur_files, first_path)
 
595
 
 
596
                # These exist before the current location
 
597
                pre = cur_files[:first_loc]
 
598
                # These occur after the current location, which may be in the
 
599
                # data we read, or might be after the last entry
 
600
                post = cur_files[first_loc:]
 
601
 
 
602
            if post and len(first_fields) >= entry_field_count:
 
603
                # We have files after the first entry
 
604
 
 
605
                # Parse the last entry
 
606
                last_entry_num = len(entries)-1
 
607
                last_fields = entries[last_entry_num].split('\0')
 
608
                if len(last_fields) < entry_field_count:
 
609
                    # The very last hunk was not complete,
 
610
                    # read the previous hunk
 
611
                    after = mid + len(block) - len(entries[-1])
 
612
                    last_entry_num -= 1
 
613
                    last_fields = entries[last_entry_num].split('\0')
 
614
                else:
 
615
                    after = mid + len(block)
 
616
 
 
617
                if last_fields[1]:
 
618
                    last_path = last_fields[1] + '/' + last_fields[2]
 
619
                else:
 
620
                    last_path = last_fields[2]
 
621
                last_loc = _bisect_path_right(post, last_path)
 
622
 
 
623
                middle_files = post[:last_loc]
 
624
                post = post[last_loc:]
 
625
 
 
626
                if middle_files:
 
627
                    # We have files that should occur in this block
 
628
                    # (>= first, <= last)
 
629
                    # Either we will find them here, or we can mark them as
 
630
                    # missing.
 
631
 
 
632
                    if middle_files[0] == first_path:
 
633
                        # We might need to go before this location
 
634
                        pre.append(first_path)
 
635
                    if middle_files[-1] == last_path:
 
636
                        post.insert(0, last_path)
 
637
 
 
638
                    # Find out what paths we have
 
639
                    paths = {first_path:[first_fields]}
 
640
                    # last_path might == first_path so we need to be
 
641
                    # careful if we should append rather than overwrite
 
642
                    if last_entry_num != first_entry_num:
 
643
                        paths.setdefault(last_path, []).append(last_fields)
 
644
                    for num in xrange(first_entry_num+1, last_entry_num):
 
645
                        # TODO: jam 20070223 We are already splitting here, so
 
646
                        #       shouldn't we just split the whole thing rather
 
647
                        #       than doing the split again in add_one_record?
 
648
                        fields = entries[num].split('\0')
 
649
                        if fields[1]:
 
650
                            path = fields[1] + '/' + fields[2]
 
651
                        else:
 
652
                            path = fields[2]
 
653
                        paths.setdefault(path, []).append(fields)
 
654
 
 
655
                    for path in middle_files:
 
656
                        for fields in paths.get(path, []):
 
657
                            # offset by 1 because of the opening '\0'
 
658
                            # consider changing fields_to_entry to avoid the
 
659
                            # extra list slice
 
660
                            entry = fields_to_entry(fields[1:])
 
661
                            found.setdefault(path, []).append(entry)
 
662
 
 
663
            # Now we have split up everything into pre, middle, and post, and
 
664
            # we have handled everything that fell in 'middle'.
 
665
            # We add 'post' first, so that we prefer to seek towards the
 
666
            # beginning, so that we will tend to go as early as we need, and
 
667
            # then only seek forward after that.
 
668
            if post:
 
669
                pending.append((after, high, post))
 
670
            if pre:
 
671
                pending.append((low, start-1, pre))
 
672
 
 
673
        # Consider that we may want to return the directory entries in sorted
 
674
        # order. For now, we just return them in whatever order we found them,
 
675
        # and leave it up to the caller if they care if it is ordered or not.
 
676
        return found
 
677
 
 
678
    def _bisect_dirblocks(self, dir_list):
 
679
        """Bisect through the disk structure to find entries in given dirs.
 
680
 
 
681
        _bisect_dirblocks is meant to find the contents of directories, which
 
682
        differs from _bisect, which only finds individual entries.
 
683
 
 
684
        :param dir_list: A sorted list of directory names ['', 'dir', 'foo'].
 
685
        :return: A map from dir => entries_for_dir
 
686
        """
 
687
        # TODO: jam 20070223 A lot of the bisecting logic could be shared
 
688
        #       between this and _bisect. It would require parameterizing the
 
689
        #       inner loop with a function, though. We should evaluate the
 
690
        #       performance difference.
 
691
        self._requires_lock()
 
692
        # We need the file pointer to be right after the initial header block
 
693
        self._read_header_if_needed()
 
694
        # If _dirblock_state was in memory, we should just return info from
 
695
        # there, this function is only meant to handle when we want to read
 
696
        # part of the disk.
 
697
        if self._dirblock_state != DirState.NOT_IN_MEMORY:
 
698
            raise AssertionError("bad dirblock state %r" % self._dirblock_state)
 
699
        # The disk representation is generally info + '\0\n\0' at the end. But
 
700
        # for bisecting, it is easier to treat this as '\0' + info + '\0\n'
 
701
        # Because it means we can sync on the '\n'
 
702
        state_file = self._state_file
 
703
        file_size = os.fstat(state_file.fileno()).st_size
 
704
        # We end up with 2 extra fields, we should have a trailing '\n' to
 
705
        # ensure that we read the whole record, and we should have a precursur
 
706
        # '' which ensures that we start after the previous '\n'
 
707
        entry_field_count = self._fields_per_entry() + 1
 
708
 
 
709
        low = self._end_of_header
 
710
        high = file_size - 1 # Ignore the final '\0'
 
711
        # Map from dir => entry
 
712
        found = {}
 
713
 
 
714
        # Avoid infinite seeking
 
715
        max_count = 30*len(dir_list)
 
716
        count = 0
 
717
        # pending is a list of places to look.
 
718
        # each entry is a tuple of low, high, dir_names
 
719
        #   low -> the first byte offset to read (inclusive)
 
720
        #   high -> the last byte offset (inclusive)
 
721
        #   dirs -> The list of directories that should be found in
 
722
        #                the [low, high] range
 
723
        pending = [(low, high, dir_list)]
 
724
 
 
725
        page_size = self._bisect_page_size
 
726
 
 
727
        fields_to_entry = self._get_fields_to_entry()
 
728
 
 
729
        while pending:
 
730
            low, high, cur_dirs = pending.pop()
 
731
 
 
732
            if not cur_dirs or low >= high:
 
733
                # Nothing to find
 
734
                continue
 
735
 
 
736
            count += 1
 
737
            if count > max_count:
 
738
                raise errors.BzrError('Too many seeks, most likely a bug.')
 
739
 
 
740
            mid = max(low, (low+high-page_size)/2)
 
741
 
 
742
            state_file.seek(mid)
 
743
            # limit the read size, so we don't end up reading data that we have
 
744
            # already read.
 
745
            read_size = min(page_size, (high-mid)+1)
 
746
            block = state_file.read(read_size)
 
747
 
 
748
            start = mid
 
749
            entries = block.split('\n')
 
750
 
 
751
            if len(entries) < 2:
 
752
                # We didn't find a '\n', so we cannot have found any records.
 
753
                # So put this range back and try again. But we know we have to
 
754
                # increase the page size, because a single read did not contain
 
755
                # a record break (so records must be larger than page_size)
 
756
                page_size *= 2
 
757
                pending.append((low, high, cur_dirs))
 
758
                continue
 
759
 
 
760
            # Check the first and last entries, in case they are partial, or if
 
761
            # we don't care about the rest of this page
 
762
            first_entry_num = 0
 
763
            first_fields = entries[0].split('\0')
 
764
            if len(first_fields) < entry_field_count:
 
765
                # We didn't get the complete first entry
 
766
                # so move start, and grab the next, which
 
767
                # should be a full entry
 
768
                start += len(entries[0])+1
 
769
                first_fields = entries[1].split('\0')
 
770
                first_entry_num = 1
 
771
 
 
772
            if len(first_fields) <= 1:
 
773
                # We didn't even get a dirname here... what do we do?
 
774
                # Try a large page size and repeat this query
 
775
                page_size *= 2
 
776
                pending.append((low, high, cur_dirs))
 
777
                continue
 
778
            else:
 
779
                # Find what entries we are looking for, which occur before and
 
780
                # after this first record.
 
781
                after = start
 
782
                first_dir = first_fields[1]
 
783
                first_loc = bisect.bisect_left(cur_dirs, first_dir)
 
784
 
 
785
                # These exist before the current location
 
786
                pre = cur_dirs[:first_loc]
 
787
                # These occur after the current location, which may be in the
 
788
                # data we read, or might be after the last entry
 
789
                post = cur_dirs[first_loc:]
 
790
 
 
791
            if post and len(first_fields) >= entry_field_count:
 
792
                # We have records to look at after the first entry
 
793
 
 
794
                # Parse the last entry
 
795
                last_entry_num = len(entries)-1
 
796
                last_fields = entries[last_entry_num].split('\0')
 
797
                if len(last_fields) < entry_field_count:
 
798
                    # The very last hunk was not complete,
 
799
                    # read the previous hunk
 
800
                    after = mid + len(block) - len(entries[-1])
 
801
                    last_entry_num -= 1
 
802
                    last_fields = entries[last_entry_num].split('\0')
 
803
                else:
 
804
                    after = mid + len(block)
 
805
 
 
806
                last_dir = last_fields[1]
 
807
                last_loc = bisect.bisect_right(post, last_dir)
 
808
 
 
809
                middle_files = post[:last_loc]
 
810
                post = post[last_loc:]
 
811
 
 
812
                if middle_files:
 
813
                    # We have files that should occur in this block
 
814
                    # (>= first, <= last)
 
815
                    # Either we will find them here, or we can mark them as
 
816
                    # missing.
 
817
 
 
818
                    if middle_files[0] == first_dir:
 
819
                        # We might need to go before this location
 
820
                        pre.append(first_dir)
 
821
                    if middle_files[-1] == last_dir:
 
822
                        post.insert(0, last_dir)
 
823
 
 
824
                    # Find out what paths we have
 
825
                    paths = {first_dir:[first_fields]}
 
826
                    # last_dir might == first_dir so we need to be
 
827
                    # careful if we should append rather than overwrite
 
828
                    if last_entry_num != first_entry_num:
 
829
                        paths.setdefault(last_dir, []).append(last_fields)
 
830
                    for num in xrange(first_entry_num+1, last_entry_num):
 
831
                        # TODO: jam 20070223 We are already splitting here, so
 
832
                        #       shouldn't we just split the whole thing rather
 
833
                        #       than doing the split again in add_one_record?
 
834
                        fields = entries[num].split('\0')
 
835
                        paths.setdefault(fields[1], []).append(fields)
 
836
 
 
837
                    for cur_dir in middle_files:
 
838
                        for fields in paths.get(cur_dir, []):
 
839
                            # offset by 1 because of the opening '\0'
 
840
                            # consider changing fields_to_entry to avoid the
 
841
                            # extra list slice
 
842
                            entry = fields_to_entry(fields[1:])
 
843
                            found.setdefault(cur_dir, []).append(entry)
 
844
 
 
845
            # Now we have split up everything into pre, middle, and post, and
 
846
            # we have handled everything that fell in 'middle'.
 
847
            # We add 'post' first, so that we prefer to seek towards the
 
848
            # beginning, so that we will tend to go as early as we need, and
 
849
            # then only seek forward after that.
 
850
            if post:
 
851
                pending.append((after, high, post))
 
852
            if pre:
 
853
                pending.append((low, start-1, pre))
 
854
 
 
855
        return found
 
856
 
 
857
    def _bisect_recursive(self, paths):
 
858
        """Bisect for entries for all paths and their children.
 
859
 
 
860
        This will use bisect to find all records for the supplied paths. It
 
861
        will then continue to bisect for any records which are marked as
 
862
        directories. (and renames?)
 
863
 
 
864
        :param paths: A sorted list of (dir, name) pairs
 
865
             eg: [('', 'a'), ('', 'f'), ('a/b', 'c')]
 
866
        :return: A dictionary mapping (dir, name, file_id) => [tree_info]
 
867
        """
 
868
        # Map from (dir, name, file_id) => [tree_info]
 
869
        found = {}
 
870
 
 
871
        found_dir_names = set()
 
872
 
 
873
        # Directories that have been read
 
874
        processed_dirs = set()
 
875
        # Get the ball rolling with the first bisect for all entries.
 
876
        newly_found = self._bisect(paths)
 
877
 
 
878
        while newly_found:
 
879
            # Directories that need to be read
 
880
            pending_dirs = set()
 
881
            paths_to_search = set()
 
882
            for entry_list in newly_found.itervalues():
 
883
                for dir_name_id, trees_info in entry_list:
 
884
                    found[dir_name_id] = trees_info
 
885
                    found_dir_names.add(dir_name_id[:2])
 
886
                    is_dir = False
 
887
                    for tree_info in trees_info:
 
888
                        minikind = tree_info[0]
 
889
                        if minikind == 'd':
 
890
                            if is_dir:
 
891
                                # We already processed this one as a directory,
 
892
                                # we don't need to do the extra work again.
 
893
                                continue
 
894
                            subdir, name, file_id = dir_name_id
 
895
                            path = osutils.pathjoin(subdir, name)
 
896
                            is_dir = True
 
897
                            if path not in processed_dirs:
 
898
                                pending_dirs.add(path)
 
899
                        elif minikind == 'r':
 
900
                            # Rename, we need to directly search the target
 
901
                            # which is contained in the fingerprint column
 
902
                            dir_name = osutils.split(tree_info[1])
 
903
                            if dir_name[0] in pending_dirs:
 
904
                                # This entry will be found in the dir search
 
905
                                continue
 
906
                            if dir_name not in found_dir_names:
 
907
                                paths_to_search.add(tree_info[1])
 
908
            # Now we have a list of paths to look for directly, and
 
909
            # directory blocks that need to be read.
 
910
            # newly_found is mixing the keys between (dir, name) and path
 
911
            # entries, but that is okay, because we only really care about the
 
912
            # targets.
 
913
            newly_found = self._bisect(sorted(paths_to_search))
 
914
            newly_found.update(self._bisect_dirblocks(sorted(pending_dirs)))
 
915
            processed_dirs.update(pending_dirs)
 
916
        return found
 
917
 
 
918
    def _discard_merge_parents(self):
 
919
        """Discard any parents trees beyond the first.
 
920
        
 
921
        Note that if this fails the dirstate is corrupted.
 
922
 
 
923
        After this function returns the dirstate contains 2 trees, neither of
 
924
        which are ghosted.
 
925
        """
 
926
        self._read_header_if_needed()
 
927
        parents = self.get_parent_ids()
 
928
        if len(parents) < 1:
 
929
            return
 
930
        # only require all dirblocks if we are doing a full-pass removal.
 
931
        self._read_dirblocks_if_needed()
 
932
        dead_patterns = set([('a', 'r'), ('a', 'a'), ('r', 'r'), ('r', 'a')])
 
933
        def iter_entries_removable():
 
934
            for block in self._dirblocks:
 
935
                deleted_positions = []
 
936
                for pos, entry in enumerate(block[1]):
 
937
                    yield entry
 
938
                    if (entry[1][0][0], entry[1][1][0]) in dead_patterns:
 
939
                        deleted_positions.append(pos)
 
940
                if deleted_positions:
 
941
                    if len(deleted_positions) == len(block[1]):
 
942
                        del block[1][:]
 
943
                    else:
 
944
                        for pos in reversed(deleted_positions):
 
945
                            del block[1][pos]
 
946
        # if the first parent is a ghost:
 
947
        if parents[0] in self.get_ghosts():
 
948
            empty_parent = [DirState.NULL_PARENT_DETAILS]
 
949
            for entry in iter_entries_removable():
 
950
                entry[1][1:] = empty_parent
 
951
        else:
 
952
            for entry in iter_entries_removable():
 
953
                del entry[1][2:]
 
954
 
 
955
        self._ghosts = []
 
956
        self._parents = [parents[0]]
 
957
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
958
        self._header_state = DirState.IN_MEMORY_MODIFIED
 
959
 
 
960
    def _empty_parent_info(self):
 
961
        return [DirState.NULL_PARENT_DETAILS] * (len(self._parents) -
 
962
                                                    len(self._ghosts))
 
963
 
 
964
    def _ensure_block(self, parent_block_index, parent_row_index, dirname):
 
965
        """Ensure a block for dirname exists.
 
966
 
 
967
        This function exists to let callers which know that there is a
 
968
        directory dirname ensure that the block for it exists. This block can
 
969
        fail to exist because of demand loading, or because a directory had no
 
970
        children. In either case it is not an error. It is however an error to
 
971
        call this if there is no parent entry for the directory, and thus the
 
972
        function requires the coordinates of such an entry to be provided.
 
973
 
 
974
        The root row is special cased and can be indicated with a parent block
 
975
        and row index of -1
 
976
 
 
977
        :param parent_block_index: The index of the block in which dirname's row
 
978
            exists.
 
979
        :param parent_row_index: The index in the parent block where the row
 
980
            exists.
 
981
        :param dirname: The utf8 dirname to ensure there is a block for.
 
982
        :return: The index for the block.
 
983
        """
 
984
        if dirname == '' and parent_row_index == 0 and parent_block_index == 0:
 
985
            # This is the signature of the root row, and the
 
986
            # contents-of-root row is always index 1
 
987
            return 1
 
988
        # the basename of the directory must be the end of its full name.
 
989
        if not (parent_block_index == -1 and
 
990
            parent_block_index == -1 and dirname == ''):
 
991
            if not dirname.endswith(
 
992
                    self._dirblocks[parent_block_index][1][parent_row_index][0][1]):
 
993
                raise AssertionError("bad dirname %r" % dirname)
 
994
        block_index, present = self._find_block_index_from_key((dirname, '', ''))
 
995
        if not present:
 
996
            ## In future, when doing partial parsing, this should load and 
 
997
            # populate the entire block.
 
998
            self._dirblocks.insert(block_index, (dirname, []))
 
999
        return block_index
 
1000
 
 
1001
    def _entries_to_current_state(self, new_entries):
 
1002
        """Load new_entries into self.dirblocks.
 
1003
 
 
1004
        Process new_entries into the current state object, making them the active
 
1005
        state.  The entries are grouped together by directory to form dirblocks.
 
1006
 
 
1007
        :param new_entries: A sorted list of entries. This function does not sort
 
1008
            to prevent unneeded overhead when callers have a sorted list already.
 
1009
        :return: Nothing.
 
1010
        """
 
1011
        if new_entries[0][0][0:2] != ('', ''):
 
1012
            raise AssertionError(
 
1013
                "Missing root row %r" % (new_entries[0][0],))
 
1014
        # The two blocks here are deliberate: the root block and the 
 
1015
        # contents-of-root block.
 
1016
        self._dirblocks = [('', []), ('', [])]
 
1017
        current_block = self._dirblocks[0][1]
 
1018
        current_dirname = ''
 
1019
        root_key = ('', '')
 
1020
        append_entry = current_block.append
 
1021
        for entry in new_entries:
 
1022
            if entry[0][0] != current_dirname:
 
1023
                # new block - different dirname
 
1024
                current_block = []
 
1025
                current_dirname = entry[0][0]
 
1026
                self._dirblocks.append((current_dirname, current_block))
 
1027
                append_entry = current_block.append
 
1028
            # append the entry to the current block
 
1029
            append_entry(entry)
 
1030
        self._split_root_dirblock_into_contents()
 
1031
 
 
1032
    def _split_root_dirblock_into_contents(self):
 
1033
        """Split the root dirblocks into root and contents-of-root.
 
1034
 
 
1035
        After parsing by path, we end up with root entries and contents-of-root
 
1036
        entries in the same block. This loop splits them out again.
 
1037
        """
 
1038
        # The above loop leaves the "root block" entries mixed with the
 
1039
        # "contents-of-root block". But we don't want an if check on
 
1040
        # all entries, so instead we just fix it up here.
 
1041
        if self._dirblocks[1] != ('', []):
 
1042
            raise ValueError("bad dirblock start %r" % (self._dirblocks[1],))
 
1043
        root_block = []
 
1044
        contents_of_root_block = []
 
1045
        for entry in self._dirblocks[0][1]:
 
1046
            if not entry[0][1]: # This is a root entry
 
1047
                root_block.append(entry)
 
1048
            else:
 
1049
                contents_of_root_block.append(entry)
 
1050
        self._dirblocks[0] = ('', root_block)
 
1051
        self._dirblocks[1] = ('', contents_of_root_block)
 
1052
 
 
1053
    def _entries_for_path(self, path):
 
1054
        """Return a list with all the entries that match path for all ids."""
 
1055
        dirname, basename = os.path.split(path)
 
1056
        key = (dirname, basename, '')
 
1057
        block_index, present = self._find_block_index_from_key(key)
 
1058
        if not present:
 
1059
            # the block which should contain path is absent.
 
1060
            return []
 
1061
        result = []
 
1062
        block = self._dirblocks[block_index][1]
 
1063
        entry_index, _ = self._find_entry_index(key, block)
 
1064
        # we may need to look at multiple entries at this path: walk while the specific_files match.
 
1065
        while (entry_index < len(block) and
 
1066
            block[entry_index][0][0:2] == key[0:2]):
 
1067
            result.append(block[entry_index])
 
1068
            entry_index += 1
 
1069
        return result
 
1070
 
 
1071
    def _entry_to_line(self, entry):
 
1072
        """Serialize entry to a NULL delimited line ready for _get_output_lines.
 
1073
 
 
1074
        :param entry: An entry_tuple as defined in the module docstring.
 
1075
        """
 
1076
        entire_entry = list(entry[0])
 
1077
        for tree_number, tree_data in enumerate(entry[1]):
 
1078
            # (minikind, fingerprint, size, executable, tree_specific_string)
 
1079
            entire_entry.extend(tree_data)
 
1080
            # 3 for the key, 5 for the fields per tree.
 
1081
            tree_offset = 3 + tree_number * 5
 
1082
            # minikind
 
1083
            entire_entry[tree_offset + 0] = tree_data[0]
 
1084
            # size
 
1085
            entire_entry[tree_offset + 2] = str(tree_data[2])
 
1086
            # executable
 
1087
            entire_entry[tree_offset + 3] = DirState._to_yesno[tree_data[3]]
 
1088
        return '\0'.join(entire_entry)
 
1089
 
 
1090
    def _fields_per_entry(self):
 
1091
        """How many null separated fields should be in each entry row.
 
1092
 
 
1093
        Each line now has an extra '\n' field which is not used
 
1094
        so we just skip over it
 
1095
        entry size:
 
1096
            3 fields for the key
 
1097
            + number of fields per tree_data (5) * tree count
 
1098
            + newline
 
1099
         """
 
1100
        tree_count = 1 + self._num_present_parents()
 
1101
        return 3 + 5 * tree_count + 1
 
1102
 
 
1103
    def _find_block(self, key, add_if_missing=False):
 
1104
        """Return the block that key should be present in.
 
1105
 
 
1106
        :param key: A dirstate entry key.
 
1107
        :return: The block tuple.
 
1108
        """
 
1109
        block_index, present = self._find_block_index_from_key(key)
 
1110
        if not present:
 
1111
            if not add_if_missing:
 
1112
                # check to see if key is versioned itself - we might want to
 
1113
                # add it anyway, because dirs with no entries dont get a
 
1114
                # dirblock at parse time.
 
1115
                # This is an uncommon branch to take: most dirs have children,
 
1116
                # and most code works with versioned paths.
 
1117
                parent_base, parent_name = osutils.split(key[0])
 
1118
                if not self._get_block_entry_index(parent_base, parent_name, 0)[3]:
 
1119
                    # some parent path has not been added - its an error to add
 
1120
                    # this child
 
1121
                    raise errors.NotVersionedError(key[0:2], str(self))
 
1122
            self._dirblocks.insert(block_index, (key[0], []))
 
1123
        return self._dirblocks[block_index]
 
1124
 
 
1125
    def _find_block_index_from_key(self, key):
 
1126
        """Find the dirblock index for a key.
 
1127
 
 
1128
        :return: The block index, True if the block for the key is present.
 
1129
        """
 
1130
        if key[0:2] == ('', ''):
 
1131
            return 0, True
 
1132
        try:
 
1133
            if (self._last_block_index is not None and
 
1134
                self._dirblocks[self._last_block_index][0] == key[0]):
 
1135
                return self._last_block_index, True
 
1136
        except IndexError:
 
1137
            pass
 
1138
        block_index = bisect_dirblock(self._dirblocks, key[0], 1,
 
1139
                                      cache=self._split_path_cache)
 
1140
        # _right returns one-past-where-key is so we have to subtract
 
1141
        # one to use it. we use _right here because there are two
 
1142
        # '' blocks - the root, and the contents of root
 
1143
        # we always have a minimum of 2 in self._dirblocks: root and
 
1144
        # root-contents, and for '', we get 2 back, so this is 
 
1145
        # simple and correct:
 
1146
        present = (block_index < len(self._dirblocks) and
 
1147
            self._dirblocks[block_index][0] == key[0])
 
1148
        self._last_block_index = block_index
 
1149
        # Reset the entry index cache to the beginning of the block.
 
1150
        self._last_entry_index = -1
 
1151
        return block_index, present
 
1152
 
 
1153
    def _find_entry_index(self, key, block):
 
1154
        """Find the entry index for a key in a block.
 
1155
 
 
1156
        :return: The entry index, True if the entry for the key is present.
 
1157
        """
 
1158
        len_block = len(block)
 
1159
        try:
 
1160
            if self._last_entry_index is not None:
 
1161
                # mini-bisect here.
 
1162
                entry_index = self._last_entry_index + 1
 
1163
                # A hit is when the key is after the last slot, and before or
 
1164
                # equal to the next slot.
 
1165
                if ((entry_index > 0 and block[entry_index - 1][0] < key) and
 
1166
                    key <= block[entry_index][0]):
 
1167
                    self._last_entry_index = entry_index
 
1168
                    present = (block[entry_index][0] == key)
 
1169
                    return entry_index, present
 
1170
        except IndexError:
 
1171
            pass
 
1172
        entry_index = bisect.bisect_left(block, (key, []))
 
1173
        present = (entry_index < len_block and
 
1174
            block[entry_index][0] == key)
 
1175
        self._last_entry_index = entry_index
 
1176
        return entry_index, present
 
1177
 
 
1178
    @staticmethod
 
1179
    def from_tree(tree, dir_state_filename):
 
1180
        """Create a dirstate from a bzr Tree.
 
1181
 
 
1182
        :param tree: The tree which should provide parent information and
 
1183
            inventory ids.
 
1184
        :return: a DirState object which is currently locked for writing.
 
1185
            (it was locked by DirState.initialize)
 
1186
        """
 
1187
        result = DirState.initialize(dir_state_filename)
 
1188
        try:
 
1189
            tree.lock_read()
 
1190
            try:
 
1191
                parent_ids = tree.get_parent_ids()
 
1192
                num_parents = len(parent_ids)
 
1193
                parent_trees = []
 
1194
                for parent_id in parent_ids:
 
1195
                    parent_tree = tree.branch.repository.revision_tree(parent_id)
 
1196
                    parent_trees.append((parent_id, parent_tree))
 
1197
                    parent_tree.lock_read()
 
1198
                result.set_parent_trees(parent_trees, [])
 
1199
                result.set_state_from_inventory(tree.inventory)
 
1200
            finally:
 
1201
                for revid, parent_tree in parent_trees:
 
1202
                    parent_tree.unlock()
 
1203
                tree.unlock()
 
1204
        except:
 
1205
            # The caller won't have a chance to unlock this, so make sure we
 
1206
            # cleanup ourselves
 
1207
            result.unlock()
 
1208
            raise
 
1209
        return result
 
1210
 
 
1211
    def update_by_delta(self, delta):
 
1212
        """Apply an inventory delta to the dirstate for tree 0
 
1213
 
 
1214
        :param delta: An inventory delta.  See Inventory.apply_delta for
 
1215
            details.
 
1216
        """
 
1217
        self._read_dirblocks_if_needed()
 
1218
        insertions = {}
 
1219
        removals = {}
 
1220
        for old_path, new_path, file_id, inv_entry in sorted(delta, reverse=True):
 
1221
            if (file_id in insertions) or (file_id in removals):
 
1222
                raise AssertionError("repeated file id in delta %r" % (file_id,))
 
1223
            if old_path is not None:
 
1224
                old_path = old_path.encode('utf-8')
 
1225
                removals[file_id] = old_path
 
1226
            if new_path is not None:
 
1227
                new_path = new_path.encode('utf-8')
 
1228
                dirname, basename = osutils.split(new_path)
 
1229
                key = (dirname, basename, file_id)
 
1230
                minikind = DirState._kind_to_minikind[inv_entry.kind]
 
1231
                if minikind == 't':
 
1232
                    fingerprint = inv_entry.reference_revision
 
1233
                else:
 
1234
                    fingerprint = ''
 
1235
                insertions[file_id] = (key, minikind, inv_entry.executable,
 
1236
                                       fingerprint, new_path)
 
1237
            # Transform moves into delete+add pairs
 
1238
            if None not in (old_path, new_path):
 
1239
                for child in self._iter_child_entries(0, old_path):
 
1240
                    if child[0][2] in insertions or child[0][2] in removals:
 
1241
                        continue
 
1242
                    child_dirname = child[0][0]
 
1243
                    child_basename = child[0][1]
 
1244
                    minikind = child[1][0][0]
 
1245
                    fingerprint = child[1][0][4]
 
1246
                    executable = child[1][0][3]
 
1247
                    old_child_path = osutils.pathjoin(child[0][0],
 
1248
                                                      child[0][1])
 
1249
                    removals[child[0][2]] = old_child_path
 
1250
                    child_suffix = child_dirname[len(old_path):]
 
1251
                    new_child_dirname = (new_path + child_suffix)
 
1252
                    key = (new_child_dirname, child_basename, child[0][2])
 
1253
                    new_child_path = os.path.join(new_child_dirname,
 
1254
                                                  child_basename)
 
1255
                    insertions[child[0][2]] = (key, minikind, executable,
 
1256
                                               fingerprint, new_child_path)
 
1257
        self._apply_removals(removals.values())
 
1258
        self._apply_insertions(insertions.values())
 
1259
 
 
1260
    def _apply_removals(self, removals):
 
1261
        for path in sorted(removals, reverse=True):
 
1262
            dirname, basename = osutils.split(path)
 
1263
            block_i, entry_i, d_present, f_present = \
 
1264
                self._get_block_entry_index(dirname, basename, 0)
 
1265
            entry = self._dirblocks[block_i][1][entry_i]
 
1266
            self._make_absent(entry)
 
1267
            # See if we have a malformed delta: deleting a directory must not
 
1268
            # leave crud behind. This increases the number of bisects needed
 
1269
            # substantially, but deletion or renames of large numbers of paths
 
1270
            # is rare enough it shouldn't be an issue (famous last words?) RBC
 
1271
            # 20080730.
 
1272
            block_i, entry_i, d_present, f_present = \
 
1273
                self._get_block_entry_index(path, '', 0)
 
1274
            if d_present:
 
1275
                # The dir block is still present in the dirstate; this could
 
1276
                # be due to it being in a parent tree, or a corrupt delta.
 
1277
                for child_entry in self._dirblocks[block_i][1]:
 
1278
                    if child_entry[1][0][0] not in ('r', 'a'):
 
1279
                        raise errors.InconsistentDelta(path, entry[0][2],
 
1280
                            "The file id was deleted but its children were "
 
1281
                            "not deleted.")
 
1282
 
 
1283
    def _apply_insertions(self, adds):
 
1284
        for key, minikind, executable, fingerprint, path_utf8 in sorted(adds):
 
1285
            self.update_minimal(key, minikind, executable, fingerprint,
 
1286
                                path_utf8=path_utf8)
 
1287
 
 
1288
    def update_basis_by_delta(self, delta, new_revid):
 
1289
        """Update the parents of this tree after a commit.
 
1290
 
 
1291
        This gives the tree one parent, with revision id new_revid. The
 
1292
        inventory delta is applied to the current basis tree to generate the
 
1293
        inventory for the parent new_revid, and all other parent trees are
 
1294
        discarded.
 
1295
 
 
1296
        Note that an exception during the operation of this method will leave
 
1297
        the dirstate in a corrupt state where it should not be saved.
 
1298
 
 
1299
        Finally, we expect all changes to be synchronising the basis tree with
 
1300
        the working tree.
 
1301
 
 
1302
        :param new_revid: The new revision id for the trees parent.
 
1303
        :param delta: An inventory delta (see apply_inventory_delta) describing
 
1304
            the changes from the current left most parent revision to new_revid.
 
1305
        """
 
1306
        self._read_dirblocks_if_needed()
 
1307
        self._discard_merge_parents()
 
1308
        if self._ghosts != []:
 
1309
            raise NotImplementedError(self.update_basis_by_delta)
 
1310
        if len(self._parents) == 0:
 
1311
            # setup a blank tree, the most simple way.
 
1312
            empty_parent = DirState.NULL_PARENT_DETAILS
 
1313
            for entry in self._iter_entries():
 
1314
                entry[1].append(empty_parent)
 
1315
            self._parents.append(new_revid)
 
1316
 
 
1317
        self._parents[0] = new_revid
 
1318
 
 
1319
        delta = sorted(delta, reverse=True)
 
1320
        adds = []
 
1321
        changes = []
 
1322
        deletes = []
 
1323
        # The paths this function accepts are unicode and must be encoded as we
 
1324
        # go.
 
1325
        encode = cache_utf8.encode
 
1326
        inv_to_entry = self._inv_entry_to_details
 
1327
        # delta is now (deletes, changes), (adds) in reverse lexographical
 
1328
        # order.
 
1329
        # deletes in reverse lexographic order are safe to process in situ.
 
1330
        # renames are not, as a rename from any path could go to a path
 
1331
        # lexographically lower, so we transform renames into delete, add pairs,
 
1332
        # expanding them recursively as needed.
 
1333
        # At the same time, to reduce interface friction we convert the input
 
1334
        # inventory entries to dirstate.
 
1335
        root_only = ('', '')
 
1336
        for old_path, new_path, file_id, inv_entry in delta:
 
1337
            if old_path is None:
 
1338
                adds.append((None, encode(new_path), file_id,
 
1339
                    inv_to_entry(inv_entry), True))
 
1340
            elif new_path is None:
 
1341
                deletes.append((encode(old_path), None, file_id, None, True))
 
1342
            elif (old_path, new_path) != root_only:
 
1343
                # Renames:
 
1344
                # Because renames must preserve their children we must have
 
1345
                # processed all relocations and removes before hand. The sort
 
1346
                # order ensures we've examined the child paths, but we also
 
1347
                # have to execute the removals, or the split to an add/delete
 
1348
                # pair will result in the deleted item being reinserted, or
 
1349
                # renamed items being reinserted twice - and possibly at the
 
1350
                # wrong place. Splitting into a delete/add pair also simplifies
 
1351
                # the handling of entries with ('f', ...), ('r' ...) because
 
1352
                # the target of the 'r' is old_path here, and we add that to
 
1353
                # deletes, meaning that the add handler does not need to check
 
1354
                # for 'r' items on every pass.
 
1355
                self._update_basis_apply_deletes(deletes)
 
1356
                deletes = []
 
1357
                new_path_utf8 = encode(new_path)
 
1358
                # Split into an add/delete pair recursively.
 
1359
                adds.append((None, new_path_utf8, file_id,
 
1360
                    inv_to_entry(inv_entry), False))
 
1361
                # Expunge deletes that we've seen so that deleted/renamed
 
1362
                # children of a rename directory are handled correctly.
 
1363
                new_deletes = reversed(list(self._iter_child_entries(1,
 
1364
                    encode(old_path))))
 
1365
                # Remove the current contents of the tree at orig_path, and
 
1366
                # reinsert at the correct new path.
 
1367
                for entry in new_deletes:
 
1368
                    if entry[0][0]:
 
1369
                        source_path = entry[0][0] + '/' + entry[0][1]
 
1370
                    else:
 
1371
                        source_path = entry[0][1]
 
1372
                    if new_path_utf8:
 
1373
                        target_path = new_path_utf8 + source_path[len(old_path):]
 
1374
                    else:
 
1375
                        if old_path == '':
 
1376
                            raise AssertionError("cannot rename directory to"
 
1377
                                " itself")
 
1378
                        target_path = source_path[len(old_path) + 1:]
 
1379
                    adds.append((None, target_path, entry[0][2], entry[1][1], False))
 
1380
                    deletes.append(
 
1381
                        (source_path, target_path, entry[0][2], None, False))
 
1382
                deletes.append(
 
1383
                    (encode(old_path), new_path, file_id, None, False))
 
1384
            else:
 
1385
                # changes to just the root should not require remove/insertion
 
1386
                # of everything.
 
1387
                changes.append((encode(old_path), encode(new_path), file_id,
 
1388
                    inv_to_entry(inv_entry)))
 
1389
 
 
1390
        # Finish expunging deletes/first half of renames.
 
1391
        self._update_basis_apply_deletes(deletes)
 
1392
        # Reinstate second half of renames and new paths.
 
1393
        self._update_basis_apply_adds(adds)
 
1394
        # Apply in-situ changes.
 
1395
        self._update_basis_apply_changes(changes)
 
1396
 
 
1397
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
1398
        self._header_state = DirState.IN_MEMORY_MODIFIED
 
1399
        self._id_index = None
 
1400
        return
 
1401
 
 
1402
    def _update_basis_apply_adds(self, adds):
 
1403
        """Apply a sequence of adds to tree 1 during update_basis_by_delta.
 
1404
 
 
1405
        They may be adds, or renames that have been split into add/delete
 
1406
        pairs.
 
1407
 
 
1408
        :param adds: A sequence of adds. Each add is a tuple:
 
1409
            (None, new_path_utf8, file_id, (entry_details), real_add). real_add
 
1410
            is False when the add is the second half of a remove-and-reinsert
 
1411
            pair created to handle renames and deletes.
 
1412
        """
 
1413
        # Adds are accumulated partly from renames, so can be in any input
 
1414
        # order - sort it.
 
1415
        adds.sort()
 
1416
        # adds is now in lexographic order, which places all parents before
 
1417
        # their children, so we can process it linearly.
 
1418
        absent = 'ar'
 
1419
        for old_path, new_path, file_id, new_details, real_add in adds:
 
1420
            # the entry for this file_id must be in tree 0.
 
1421
            entry = self._get_entry(0, file_id, new_path)
 
1422
            if entry[0] is None or entry[0][2] != file_id:
 
1423
                self._changes_aborted = True
 
1424
                raise errors.InconsistentDelta(new_path, file_id,
 
1425
                    'working tree does not contain new entry')
 
1426
            if real_add and entry[1][1][0] not in absent:
 
1427
                self._changes_aborted = True
 
1428
                raise errors.InconsistentDelta(new_path, file_id,
 
1429
                    'The entry was considered to be a genuinely new record,'
 
1430
                    ' but there was already an old record for it.')
 
1431
            # We don't need to update the target of an 'r' because the handling
 
1432
            # of renames turns all 'r' situations into a delete at the original
 
1433
            # location.
 
1434
            entry[1][1] = new_details
 
1435
 
 
1436
    def _update_basis_apply_changes(self, changes):
 
1437
        """Apply a sequence of changes to tree 1 during update_basis_by_delta.
 
1438
 
 
1439
        :param adds: A sequence of changes. Each change is a tuple:
 
1440
            (path_utf8, path_utf8, file_id, (entry_details))
 
1441
        """
 
1442
        absent = 'ar'
 
1443
        for old_path, new_path, file_id, new_details in changes:
 
1444
            # the entry for this file_id must be in tree 0.
 
1445
            entry = self._get_entry(0, file_id, new_path)
 
1446
            if entry[0] is None or entry[0][2] != file_id:
 
1447
                self._changes_aborted = True
 
1448
                raise errors.InconsistentDelta(new_path, file_id,
 
1449
                    'working tree does not contain new entry')
 
1450
            if (entry[1][0][0] in absent or
 
1451
                entry[1][1][0] in absent):
 
1452
                self._changes_aborted = True
 
1453
                raise errors.InconsistentDelta(new_path, file_id,
 
1454
                    'changed considered absent')
 
1455
            entry[1][1] = new_details
 
1456
 
 
1457
    def _update_basis_apply_deletes(self, deletes):
 
1458
        """Apply a sequence of deletes to tree 1 during update_basis_by_delta.
 
1459
 
 
1460
        They may be deletes, or renames that have been split into add/delete
 
1461
        pairs.
 
1462
 
 
1463
        :param deletes: A sequence of deletes. Each delete is a tuple:
 
1464
            (old_path_utf8, new_path_utf8, file_id, None, real_delete).
 
1465
            real_delete is True when the desired outcome is an actual deletion
 
1466
            rather than the rename handling logic temporarily deleting a path
 
1467
            during the replacement of a parent.
 
1468
        """
 
1469
        null = DirState.NULL_PARENT_DETAILS
 
1470
        for old_path, new_path, file_id, _, real_delete in deletes:
 
1471
            if real_delete != (new_path is None):
 
1472
                raise AssertionError("bad delete delta")
 
1473
            # the entry for this file_id must be in tree 1.
 
1474
            dirname, basename = osutils.split(old_path)
 
1475
            block_index, entry_index, dir_present, file_present = \
 
1476
                self._get_block_entry_index(dirname, basename, 1)
 
1477
            if not file_present:
 
1478
                self._changes_aborted = True
 
1479
                raise errors.InconsistentDelta(old_path, file_id,
 
1480
                    'basis tree does not contain removed entry')
 
1481
            entry = self._dirblocks[block_index][1][entry_index]
 
1482
            if entry[0][2] != file_id:
 
1483
                self._changes_aborted = True
 
1484
                raise errors.InconsistentDelta(old_path, file_id,
 
1485
                    'mismatched file_id in tree 1')
 
1486
            if real_delete:
 
1487
                if entry[1][0][0] != 'a':
 
1488
                    self._changes_aborted = True
 
1489
                    raise errors.InconsistentDelta(old_path, file_id,
 
1490
                            'This was marked as a real delete, but the WT state'
 
1491
                            ' claims that it still exists and is versioned.')
 
1492
                del self._dirblocks[block_index][1][entry_index]
 
1493
            else:
 
1494
                if entry[1][0][0] == 'a':
 
1495
                    self._changes_aborted = True
 
1496
                    raise errors.InconsistentDelta(old_path, file_id,
 
1497
                        'The entry was considered a rename, but the source path'
 
1498
                        ' is marked as absent.')
 
1499
                    # For whatever reason, we were asked to rename an entry
 
1500
                    # that was originally marked as deleted. This could be
 
1501
                    # because we are renaming the parent directory, and the WT
 
1502
                    # current state has the file marked as deleted.
 
1503
                elif entry[1][0][0] == 'r':
 
1504
                    # implement the rename
 
1505
                    del self._dirblocks[block_index][1][entry_index]
 
1506
                else:
 
1507
                    # it is being resurrected here, so blank it out temporarily.
 
1508
                    self._dirblocks[block_index][1][entry_index][1][1] = null
 
1509
 
 
1510
    def _sha_cutoff_time(self):
 
1511
        """Return cutoff time.
 
1512
 
 
1513
        Files modified more recently than this time are at risk of being
 
1514
        undetectably modified and so can't be cached.
 
1515
        """
 
1516
        # Cache the cutoff time as long as we hold a lock.
 
1517
        # time.time() isn't super expensive (approx 3.38us), but
 
1518
        # when you call it 50,000 times it adds up.
 
1519
        # For comparison, os.lstat() costs 7.2us if it is hot.
 
1520
        self._cutoff_time = int(time.time()) - 3
 
1521
        return self._cutoff_time
 
1522
 
 
1523
    def _lstat(self, abspath, entry):
 
1524
        """Return the os.lstat value for this path."""
 
1525
        return os.lstat(abspath)
 
1526
 
 
1527
    def _sha1_file_and_mutter(self, abspath):
 
1528
        # when -Dhashcache is turned on, this is monkey-patched in to log
 
1529
        # file reads
 
1530
        trace.mutter("dirstate sha1 " + abspath)
 
1531
        return osutils.sha_file_by_name(abspath)
 
1532
 
 
1533
    def _is_executable(self, mode, old_executable):
 
1534
        """Is this file executable?"""
 
1535
        return bool(S_IEXEC & mode)
 
1536
 
 
1537
    def _is_executable_win32(self, mode, old_executable):
 
1538
        """On win32 the executable bit is stored in the dirstate."""
 
1539
        return old_executable
 
1540
 
 
1541
    if sys.platform == 'win32':
 
1542
        _is_executable = _is_executable_win32
 
1543
 
 
1544
    def _read_link(self, abspath, old_link):
 
1545
        """Read the target of a symlink"""
 
1546
        # TODO: jam 200700301 On Win32, this could just return the value
 
1547
        #       already in memory. However, this really needs to be done at a
 
1548
        #       higher level, because there either won't be anything on disk,
 
1549
        #       or the thing on disk will be a file.
 
1550
        return os.readlink(abspath)
 
1551
 
 
1552
    def get_ghosts(self):
 
1553
        """Return a list of the parent tree revision ids that are ghosts."""
 
1554
        self._read_header_if_needed()
 
1555
        return self._ghosts
 
1556
 
 
1557
    def get_lines(self):
 
1558
        """Serialise the entire dirstate to a sequence of lines."""
 
1559
        if (self._header_state == DirState.IN_MEMORY_UNMODIFIED and
 
1560
            self._dirblock_state == DirState.IN_MEMORY_UNMODIFIED):
 
1561
            # read whats on disk.
 
1562
            self._state_file.seek(0)
 
1563
            return self._state_file.readlines()
 
1564
        lines = []
 
1565
        lines.append(self._get_parents_line(self.get_parent_ids()))
 
1566
        lines.append(self._get_ghosts_line(self._ghosts))
 
1567
        # append the root line which is special cased
 
1568
        lines.extend(map(self._entry_to_line, self._iter_entries()))
 
1569
        return self._get_output_lines(lines)
 
1570
 
 
1571
    def _get_ghosts_line(self, ghost_ids):
 
1572
        """Create a line for the state file for ghost information."""
 
1573
        return '\0'.join([str(len(ghost_ids))] + ghost_ids)
 
1574
 
 
1575
    def _get_parents_line(self, parent_ids):
 
1576
        """Create a line for the state file for parents information."""
 
1577
        return '\0'.join([str(len(parent_ids))] + parent_ids)
 
1578
 
 
1579
    def _get_fields_to_entry(self):
 
1580
        """Get a function which converts entry fields into a entry record.
 
1581
 
 
1582
        This handles size and executable, as well as parent records.
 
1583
 
 
1584
        :return: A function which takes a list of fields, and returns an
 
1585
            appropriate record for storing in memory.
 
1586
        """
 
1587
        # This is intentionally unrolled for performance
 
1588
        num_present_parents = self._num_present_parents()
 
1589
        if num_present_parents == 0:
 
1590
            def fields_to_entry_0_parents(fields, _int=int):
 
1591
                path_name_file_id_key = (fields[0], fields[1], fields[2])
 
1592
                return (path_name_file_id_key, [
 
1593
                    ( # Current tree
 
1594
                        fields[3],                # minikind
 
1595
                        fields[4],                # fingerprint
 
1596
                        _int(fields[5]),          # size
 
1597
                        fields[6] == 'y',         # executable
 
1598
                        fields[7],                # packed_stat or revision_id
 
1599
                    )])
 
1600
            return fields_to_entry_0_parents
 
1601
        elif num_present_parents == 1:
 
1602
            def fields_to_entry_1_parent(fields, _int=int):
 
1603
                path_name_file_id_key = (fields[0], fields[1], fields[2])
 
1604
                return (path_name_file_id_key, [
 
1605
                    ( # Current tree
 
1606
                        fields[3],                # minikind
 
1607
                        fields[4],                # fingerprint
 
1608
                        _int(fields[5]),          # size
 
1609
                        fields[6] == 'y',         # executable
 
1610
                        fields[7],                # packed_stat or revision_id
 
1611
                    ),
 
1612
                    ( # Parent 1
 
1613
                        fields[8],                # minikind
 
1614
                        fields[9],                # fingerprint
 
1615
                        _int(fields[10]),         # size
 
1616
                        fields[11] == 'y',        # executable
 
1617
                        fields[12],               # packed_stat or revision_id
 
1618
                    ),
 
1619
                    ])
 
1620
            return fields_to_entry_1_parent
 
1621
        elif num_present_parents == 2:
 
1622
            def fields_to_entry_2_parents(fields, _int=int):
 
1623
                path_name_file_id_key = (fields[0], fields[1], fields[2])
 
1624
                return (path_name_file_id_key, [
 
1625
                    ( # Current tree
 
1626
                        fields[3],                # minikind
 
1627
                        fields[4],                # fingerprint
 
1628
                        _int(fields[5]),          # size
 
1629
                        fields[6] == 'y',         # executable
 
1630
                        fields[7],                # packed_stat or revision_id
 
1631
                    ),
 
1632
                    ( # Parent 1
 
1633
                        fields[8],                # minikind
 
1634
                        fields[9],                # fingerprint
 
1635
                        _int(fields[10]),         # size
 
1636
                        fields[11] == 'y',        # executable
 
1637
                        fields[12],               # packed_stat or revision_id
 
1638
                    ),
 
1639
                    ( # Parent 2
 
1640
                        fields[13],               # minikind
 
1641
                        fields[14],               # fingerprint
 
1642
                        _int(fields[15]),         # size
 
1643
                        fields[16] == 'y',        # executable
 
1644
                        fields[17],               # packed_stat or revision_id
 
1645
                    ),
 
1646
                    ])
 
1647
            return fields_to_entry_2_parents
 
1648
        else:
 
1649
            def fields_to_entry_n_parents(fields, _int=int):
 
1650
                path_name_file_id_key = (fields[0], fields[1], fields[2])
 
1651
                trees = [(fields[cur],                # minikind
 
1652
                          fields[cur+1],              # fingerprint
 
1653
                          _int(fields[cur+2]),        # size
 
1654
                          fields[cur+3] == 'y',       # executable
 
1655
                          fields[cur+4],              # stat or revision_id
 
1656
                         ) for cur in xrange(3, len(fields)-1, 5)]
 
1657
                return path_name_file_id_key, trees
 
1658
            return fields_to_entry_n_parents
 
1659
 
 
1660
    def get_parent_ids(self):
 
1661
        """Return a list of the parent tree ids for the directory state."""
 
1662
        self._read_header_if_needed()
 
1663
        return list(self._parents)
 
1664
 
 
1665
    def _get_block_entry_index(self, dirname, basename, tree_index):
 
1666
        """Get the coordinates for a path in the state structure.
 
1667
 
 
1668
        :param dirname: The utf8 dirname to lookup.
 
1669
        :param basename: The utf8 basename to lookup.
 
1670
        :param tree_index: The index of the tree for which this lookup should
 
1671
            be attempted.
 
1672
        :return: A tuple describing where the path is located, or should be
 
1673
            inserted. The tuple contains four fields: the block index, the row
 
1674
            index, the directory is present (boolean), the entire path is
 
1675
            present (boolean).  There is no guarantee that either
 
1676
            coordinate is currently reachable unless the found field for it is
 
1677
            True. For instance, a directory not present in the searched tree
 
1678
            may be returned with a value one greater than the current highest
 
1679
            block offset. The directory present field will always be True when
 
1680
            the path present field is True. The directory present field does
 
1681
            NOT indicate that the directory is present in the searched tree,
 
1682
            rather it indicates that there are at least some files in some
 
1683
            tree present there.
 
1684
        """
 
1685
        self._read_dirblocks_if_needed()
 
1686
        key = dirname, basename, ''
 
1687
        block_index, present = self._find_block_index_from_key(key)
 
1688
        if not present:
 
1689
            # no such directory - return the dir index and 0 for the row.
 
1690
            return block_index, 0, False, False
 
1691
        block = self._dirblocks[block_index][1] # access the entries only
 
1692
        entry_index, present = self._find_entry_index(key, block)
 
1693
        # linear search through entries at this path to find the one
 
1694
        # requested.
 
1695
        while entry_index < len(block) and block[entry_index][0][1] == basename:
 
1696
            if block[entry_index][1][tree_index][0] not in 'ar':
 
1697
                # neither absent or relocated
 
1698
                return block_index, entry_index, True, True
 
1699
            entry_index += 1
 
1700
        return block_index, entry_index, True, False
 
1701
 
 
1702
    def _get_entry(self, tree_index, fileid_utf8=None, path_utf8=None):
 
1703
        """Get the dirstate entry for path in tree tree_index.
 
1704
 
 
1705
        If either file_id or path is supplied, it is used as the key to lookup.
 
1706
        If both are supplied, the fastest lookup is used, and an error is
 
1707
        raised if they do not both point at the same row.
 
1708
 
 
1709
        :param tree_index: The index of the tree we wish to locate this path
 
1710
            in. If the path is present in that tree, the entry containing its
 
1711
            details is returned, otherwise (None, None) is returned
 
1712
            0 is the working tree, higher indexes are successive parent
 
1713
            trees.
 
1714
        :param fileid_utf8: A utf8 file_id to look up.
 
1715
        :param path_utf8: An utf8 path to be looked up.
 
1716
        :return: The dirstate entry tuple for path, or (None, None)
 
1717
        """
 
1718
        self._read_dirblocks_if_needed()
 
1719
        if path_utf8 is not None:
 
1720
            if type(path_utf8) is not str:
 
1721
                raise AssertionError('path_utf8 is not a str: %s %s'
 
1722
                    % (type(path_utf8), path_utf8))
 
1723
            # path lookups are faster
 
1724
            dirname, basename = osutils.split(path_utf8)
 
1725
            block_index, entry_index, dir_present, file_present = \
 
1726
                self._get_block_entry_index(dirname, basename, tree_index)
 
1727
            if not file_present:
 
1728
                return None, None
 
1729
            entry = self._dirblocks[block_index][1][entry_index]
 
1730
            if not (entry[0][2] and entry[1][tree_index][0] not in ('a', 'r')):
 
1731
                raise AssertionError('unversioned entry?')
 
1732
            if fileid_utf8:
 
1733
                if entry[0][2] != fileid_utf8:
 
1734
                    self._changes_aborted = True
 
1735
                    raise errors.BzrError('integrity error ? : mismatching'
 
1736
                                          ' tree_index, file_id and path')
 
1737
            return entry
 
1738
        else:
 
1739
            possible_keys = self._get_id_index().get(fileid_utf8, None)
 
1740
            if not possible_keys:
 
1741
                return None, None
 
1742
            for key in possible_keys:
 
1743
                block_index, present = \
 
1744
                    self._find_block_index_from_key(key)
 
1745
                # strange, probably indicates an out of date
 
1746
                # id index - for now, allow this.
 
1747
                if not present:
 
1748
                    continue
 
1749
                # WARNING: DO not change this code to use _get_block_entry_index
 
1750
                # as that function is not suitable: it does not use the key
 
1751
                # to lookup, and thus the wrong coordinates are returned.
 
1752
                block = self._dirblocks[block_index][1]
 
1753
                entry_index, present = self._find_entry_index(key, block)
 
1754
                if present:
 
1755
                    entry = self._dirblocks[block_index][1][entry_index]
 
1756
                    if entry[1][tree_index][0] in 'fdlt':
 
1757
                        # this is the result we are looking for: the  
 
1758
                        # real home of this file_id in this tree.
 
1759
                        return entry
 
1760
                    if entry[1][tree_index][0] == 'a':
 
1761
                        # there is no home for this entry in this tree
 
1762
                        return None, None
 
1763
                    if entry[1][tree_index][0] != 'r':
 
1764
                        raise AssertionError(
 
1765
                            "entry %r has invalid minikind %r for tree %r" \
 
1766
                            % (entry,
 
1767
                               entry[1][tree_index][0],
 
1768
                               tree_index))
 
1769
                    real_path = entry[1][tree_index][1]
 
1770
                    return self._get_entry(tree_index, fileid_utf8=fileid_utf8,
 
1771
                        path_utf8=real_path)
 
1772
            return None, None
 
1773
 
 
1774
    @classmethod
 
1775
    def initialize(cls, path):
 
1776
        """Create a new dirstate on path.
 
1777
 
 
1778
        The new dirstate will be an empty tree - that is it has no parents,
 
1779
        and only a root node - which has id ROOT_ID.
 
1780
 
 
1781
        :param path: The name of the file for the dirstate.
 
1782
        :return: A write-locked DirState object.
 
1783
        """
 
1784
        # This constructs a new DirState object on a path, sets the _state_file
 
1785
        # to a new empty file for that path. It then calls _set_data() with our
 
1786
        # stock empty dirstate information - a root with ROOT_ID, no children,
 
1787
        # and no parents. Finally it calls save() to ensure that this data will
 
1788
        # persist.
 
1789
        result = cls(path)
 
1790
        # root dir and root dir contents with no children.
 
1791
        empty_tree_dirblocks = [('', []), ('', [])]
 
1792
        # a new root directory, with a NULLSTAT.
 
1793
        empty_tree_dirblocks[0][1].append(
 
1794
            (('', '', inventory.ROOT_ID), [
 
1795
                ('d', '', 0, False, DirState.NULLSTAT),
 
1796
            ]))
 
1797
        result.lock_write()
 
1798
        try:
 
1799
            result._set_data([], empty_tree_dirblocks)
 
1800
            result.save()
 
1801
        except:
 
1802
            result.unlock()
 
1803
            raise
 
1804
        return result
 
1805
 
 
1806
    @staticmethod
 
1807
    def _inv_entry_to_details(inv_entry):
 
1808
        """Convert an inventory entry (from a revision tree) to state details.
 
1809
 
 
1810
        :param inv_entry: An inventory entry whose sha1 and link targets can be
 
1811
            relied upon, and which has a revision set.
 
1812
        :return: A details tuple - the details for a single tree at a path +
 
1813
            id.
 
1814
        """
 
1815
        kind = inv_entry.kind
 
1816
        minikind = DirState._kind_to_minikind[kind]
 
1817
        tree_data = inv_entry.revision
 
1818
        if kind == 'directory':
 
1819
            fingerprint = ''
 
1820
            size = 0
 
1821
            executable = False
 
1822
        elif kind == 'symlink':
 
1823
            # We don't support non-ascii targets for symlinks yet.
 
1824
            fingerprint = str(inv_entry.symlink_target or '')
 
1825
            size = 0
 
1826
            executable = False
 
1827
        elif kind == 'file':
 
1828
            fingerprint = inv_entry.text_sha1 or ''
 
1829
            size = inv_entry.text_size or 0
 
1830
            executable = inv_entry.executable
 
1831
        elif kind == 'tree-reference':
 
1832
            fingerprint = inv_entry.reference_revision or ''
 
1833
            size = 0
 
1834
            executable = False
 
1835
        else:
 
1836
            raise Exception("can't pack %s" % inv_entry)
 
1837
        return (minikind, fingerprint, size, executable, tree_data)
 
1838
 
 
1839
    def _iter_child_entries(self, tree_index, path_utf8):
 
1840
        """Iterate over all the entries that are children of path_utf.
 
1841
 
 
1842
        This only returns entries that are present (not in 'a', 'r') in 
 
1843
        tree_index. tree_index data is not refreshed, so if tree 0 is used,
 
1844
        results may differ from that obtained if paths were statted to
 
1845
        determine what ones were directories.
 
1846
 
 
1847
        Asking for the children of a non-directory will return an empty
 
1848
        iterator.
 
1849
        """
 
1850
        pending_dirs = []
 
1851
        next_pending_dirs = [path_utf8]
 
1852
        absent = 'ar'
 
1853
        while next_pending_dirs:
 
1854
            pending_dirs = next_pending_dirs
 
1855
            next_pending_dirs = []
 
1856
            for path in pending_dirs:
 
1857
                block_index, present = self._find_block_index_from_key(
 
1858
                    (path, '', ''))
 
1859
                if block_index == 0:
 
1860
                    block_index = 1
 
1861
                    if len(self._dirblocks) == 1:
 
1862
                        # asked for the children of the root with no other
 
1863
                        # contents.
 
1864
                        return
 
1865
                if not present:
 
1866
                    # children of a non-directory asked for.
 
1867
                    continue
 
1868
                block = self._dirblocks[block_index]
 
1869
                for entry in block[1]:
 
1870
                    kind = entry[1][tree_index][0]
 
1871
                    if kind not in absent:
 
1872
                        yield entry
 
1873
                    if kind == 'd':
 
1874
                        if entry[0][0]:
 
1875
                            path = entry[0][0] + '/' + entry[0][1]
 
1876
                        else:
 
1877
                            path = entry[0][1]
 
1878
                        next_pending_dirs.append(path)
 
1879
    
 
1880
    def _iter_entries(self):
 
1881
        """Iterate over all the entries in the dirstate.
 
1882
 
 
1883
        Each yelt item is an entry in the standard format described in the
 
1884
        docstring of bzrlib.dirstate.
 
1885
        """
 
1886
        self._read_dirblocks_if_needed()
 
1887
        for directory in self._dirblocks:
 
1888
            for entry in directory[1]:
 
1889
                yield entry
 
1890
 
 
1891
    def _get_id_index(self):
 
1892
        """Get an id index of self._dirblocks."""
 
1893
        if self._id_index is None:
 
1894
            id_index = {}
 
1895
            for key, tree_details in self._iter_entries():
 
1896
                id_index.setdefault(key[2], set()).add(key)
 
1897
            self._id_index = id_index
 
1898
        return self._id_index
 
1899
 
 
1900
    def _get_output_lines(self, lines):
 
1901
        """Format lines for final output.
 
1902
 
 
1903
        :param lines: A sequence of lines containing the parents list and the
 
1904
            path lines.
 
1905
        """
 
1906
        output_lines = [DirState.HEADER_FORMAT_3]
 
1907
        lines.append('') # a final newline
 
1908
        inventory_text = '\0\n\0'.join(lines)
 
1909
        output_lines.append('crc32: %s\n' % (zlib.crc32(inventory_text),))
 
1910
        # -3, 1 for num parents, 1 for ghosts, 1 for final newline
 
1911
        num_entries = len(lines)-3
 
1912
        output_lines.append('num_entries: %s\n' % (num_entries,))
 
1913
        output_lines.append(inventory_text)
 
1914
        return output_lines
 
1915
 
 
1916
    def _make_deleted_row(self, fileid_utf8, parents):
 
1917
        """Return a deleted row for fileid_utf8."""
 
1918
        return ('/', 'RECYCLED.BIN', 'file', fileid_utf8, 0, DirState.NULLSTAT,
 
1919
            ''), parents
 
1920
 
 
1921
    def _num_present_parents(self):
 
1922
        """The number of parent entries in each record row."""
 
1923
        return len(self._parents) - len(self._ghosts)
 
1924
 
 
1925
    @staticmethod
 
1926
    def on_file(path):
 
1927
        """Construct a DirState on the file at path path.
 
1928
 
 
1929
        :return: An unlocked DirState object, associated with the given path.
 
1930
        """
 
1931
        result = DirState(path)
 
1932
        return result
 
1933
 
 
1934
    def _read_dirblocks_if_needed(self):
 
1935
        """Read in all the dirblocks from the file if they are not in memory.
 
1936
        
 
1937
        This populates self._dirblocks, and sets self._dirblock_state to
 
1938
        IN_MEMORY_UNMODIFIED. It is not currently ready for incremental block
 
1939
        loading.
 
1940
        """
 
1941
        self._read_header_if_needed()
 
1942
        if self._dirblock_state == DirState.NOT_IN_MEMORY:
 
1943
            _read_dirblocks(self)
 
1944
 
 
1945
    def _read_header(self):
 
1946
        """This reads in the metadata header, and the parent ids.
 
1947
 
 
1948
        After reading in, the file should be positioned at the null
 
1949
        just before the start of the first record in the file.
 
1950
 
 
1951
        :return: (expected crc checksum, number of entries, parent list)
 
1952
        """
 
1953
        self._read_prelude()
 
1954
        parent_line = self._state_file.readline()
 
1955
        info = parent_line.split('\0')
 
1956
        num_parents = int(info[0])
 
1957
        self._parents = info[1:-1]
 
1958
        ghost_line = self._state_file.readline()
 
1959
        info = ghost_line.split('\0')
 
1960
        num_ghosts = int(info[1])
 
1961
        self._ghosts = info[2:-1]
 
1962
        self._header_state = DirState.IN_MEMORY_UNMODIFIED
 
1963
        self._end_of_header = self._state_file.tell()
 
1964
 
 
1965
    def _read_header_if_needed(self):
 
1966
        """Read the header of the dirstate file if needed."""
 
1967
        # inline this as it will be called a lot
 
1968
        if not self._lock_token:
 
1969
            raise errors.ObjectNotLocked(self)
 
1970
        if self._header_state == DirState.NOT_IN_MEMORY:
 
1971
            self._read_header()
 
1972
 
 
1973
    def _read_prelude(self):
 
1974
        """Read in the prelude header of the dirstate file.
 
1975
 
 
1976
        This only reads in the stuff that is not connected to the crc
 
1977
        checksum. The position will be correct to read in the rest of
 
1978
        the file and check the checksum after this point.
 
1979
        The next entry in the file should be the number of parents,
 
1980
        and their ids. Followed by a newline.
 
1981
        """
 
1982
        header = self._state_file.readline()
 
1983
        if header != DirState.HEADER_FORMAT_3:
 
1984
            raise errors.BzrError(
 
1985
                'invalid header line: %r' % (header,))
 
1986
        crc_line = self._state_file.readline()
 
1987
        if not crc_line.startswith('crc32: '):
 
1988
            raise errors.BzrError('missing crc32 checksum: %r' % crc_line)
 
1989
        self.crc_expected = int(crc_line[len('crc32: '):-1])
 
1990
        num_entries_line = self._state_file.readline()
 
1991
        if not num_entries_line.startswith('num_entries: '):
 
1992
            raise errors.BzrError('missing num_entries line')
 
1993
        self._num_entries = int(num_entries_line[len('num_entries: '):-1])
 
1994
 
 
1995
    def sha1_from_stat(self, path, stat_result, _pack_stat=pack_stat):
 
1996
        """Find a sha1 given a stat lookup."""
 
1997
        return self._get_packed_stat_index().get(_pack_stat(stat_result), None)
 
1998
 
 
1999
    def _get_packed_stat_index(self):
 
2000
        """Get a packed_stat index of self._dirblocks."""
 
2001
        if self._packed_stat_index is None:
 
2002
            index = {}
 
2003
            for key, tree_details in self._iter_entries():
 
2004
                if tree_details[0][0] == 'f':
 
2005
                    index[tree_details[0][4]] = tree_details[0][1]
 
2006
            self._packed_stat_index = index
 
2007
        return self._packed_stat_index
 
2008
 
 
2009
    def save(self):
 
2010
        """Save any pending changes created during this session.
 
2011
 
 
2012
        We reuse the existing file, because that prevents race conditions with
 
2013
        file creation, and use oslocks on it to prevent concurrent modification
 
2014
        and reads - because dirstate's incremental data aggregation is not
 
2015
        compatible with reading a modified file, and replacing a file in use by
 
2016
        another process is impossible on Windows.
 
2017
 
 
2018
        A dirstate in read only mode should be smart enough though to validate
 
2019
        that the file has not changed, and otherwise discard its cache and
 
2020
        start over, to allow for fine grained read lock duration, so 'status'
 
2021
        wont block 'commit' - for example.
 
2022
        """
 
2023
        if self._changes_aborted:
 
2024
            # Should this be a warning? For now, I'm expecting that places that
 
2025
            # mark it inconsistent will warn, making a warning here redundant.
 
2026
            trace.mutter('Not saving DirState because '
 
2027
                    '_changes_aborted is set.')
 
2028
            return
 
2029
        if (self._header_state == DirState.IN_MEMORY_MODIFIED or
 
2030
            self._dirblock_state == DirState.IN_MEMORY_MODIFIED):
 
2031
 
 
2032
            grabbed_write_lock = False
 
2033
            if self._lock_state != 'w':
 
2034
                grabbed_write_lock, new_lock = self._lock_token.temporary_write_lock()
 
2035
                # Switch over to the new lock, as the old one may be closed.
 
2036
                # TODO: jam 20070315 We should validate the disk file has
 
2037
                #       not changed contents. Since temporary_write_lock may
 
2038
                #       not be an atomic operation.
 
2039
                self._lock_token = new_lock
 
2040
                self._state_file = new_lock.f
 
2041
                if not grabbed_write_lock:
 
2042
                    # We couldn't grab a write lock, so we switch back to a read one
 
2043
                    return
 
2044
            try:
 
2045
                self._state_file.seek(0)
 
2046
                self._state_file.writelines(self.get_lines())
 
2047
                self._state_file.truncate()
 
2048
                self._state_file.flush()
 
2049
                self._header_state = DirState.IN_MEMORY_UNMODIFIED
 
2050
                self._dirblock_state = DirState.IN_MEMORY_UNMODIFIED
 
2051
            finally:
 
2052
                if grabbed_write_lock:
 
2053
                    self._lock_token = self._lock_token.restore_read_lock()
 
2054
                    self._state_file = self._lock_token.f
 
2055
                    # TODO: jam 20070315 We should validate the disk file has
 
2056
                    #       not changed contents. Since restore_read_lock may
 
2057
                    #       not be an atomic operation.
 
2058
 
 
2059
    def _set_data(self, parent_ids, dirblocks):
 
2060
        """Set the full dirstate data in memory.
 
2061
 
 
2062
        This is an internal function used to completely replace the objects
 
2063
        in memory state. It puts the dirstate into state 'full-dirty'.
 
2064
 
 
2065
        :param parent_ids: A list of parent tree revision ids.
 
2066
        :param dirblocks: A list containing one tuple for each directory in the
 
2067
            tree. Each tuple contains the directory path and a list of entries 
 
2068
            found in that directory.
 
2069
        """
 
2070
        # our memory copy is now authoritative.
 
2071
        self._dirblocks = dirblocks
 
2072
        self._header_state = DirState.IN_MEMORY_MODIFIED
 
2073
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
2074
        self._parents = list(parent_ids)
 
2075
        self._id_index = None
 
2076
        self._packed_stat_index = None
 
2077
 
 
2078
    def set_path_id(self, path, new_id):
 
2079
        """Change the id of path to new_id in the current working tree.
 
2080
 
 
2081
        :param path: The path inside the tree to set - '' is the root, 'foo'
 
2082
            is the path foo in the root.
 
2083
        :param new_id: The new id to assign to the path. This must be a utf8
 
2084
            file id (not unicode, and not None).
 
2085
        """
 
2086
        self._read_dirblocks_if_needed()
 
2087
        if len(path):
 
2088
            # TODO: logic not written
 
2089
            raise NotImplementedError(self.set_path_id)
 
2090
        # TODO: check new id is unique
 
2091
        entry = self._get_entry(0, path_utf8=path)
 
2092
        if entry[0][2] == new_id:
 
2093
            # Nothing to change.
 
2094
            return
 
2095
        # mark the old path absent, and insert a new root path
 
2096
        self._make_absent(entry)
 
2097
        self.update_minimal(('', '', new_id), 'd',
 
2098
            path_utf8='', packed_stat=entry[1][0][4])
 
2099
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
2100
        if self._id_index is not None:
 
2101
            self._id_index.setdefault(new_id, set()).add(entry[0])
 
2102
 
 
2103
    def set_parent_trees(self, trees, ghosts):
 
2104
        """Set the parent trees for the dirstate.
 
2105
 
 
2106
        :param trees: A list of revision_id, tree tuples. tree must be provided
 
2107
            even if the revision_id refers to a ghost: supply an empty tree in 
 
2108
            this case.
 
2109
        :param ghosts: A list of the revision_ids that are ghosts at the time
 
2110
            of setting.
 
2111
        """ 
 
2112
        # TODO: generate a list of parent indexes to preserve to save 
 
2113
        # processing specific parent trees. In the common case one tree will
 
2114
        # be preserved - the left most parent.
 
2115
        # TODO: if the parent tree is a dirstate, we might want to walk them
 
2116
        # all by path in parallel for 'optimal' common-case performance.
 
2117
        # generate new root row.
 
2118
        self._read_dirblocks_if_needed()
 
2119
        # TODO future sketch: Examine the existing parents to generate a change
 
2120
        # map and then walk the new parent trees only, mapping them into the
 
2121
        # dirstate. Walk the dirstate at the same time to remove unreferenced
 
2122
        # entries.
 
2123
        # for now: 
 
2124
        # sketch: loop over all entries in the dirstate, cherry picking 
 
2125
        # entries from the parent trees, if they are not ghost trees.
 
2126
        # after we finish walking the dirstate, all entries not in the dirstate
 
2127
        # are deletes, so we want to append them to the end as per the design
 
2128
        # discussions. So do a set difference on ids with the parents to
 
2129
        # get deletes, and add them to the end.
 
2130
        # During the update process we need to answer the following questions:
 
2131
        # - find other keys containing a fileid in order to create cross-path
 
2132
        #   links. We dont't trivially use the inventory from other trees
 
2133
        #   because this leads to either double touching, or to accessing
 
2134
        #   missing keys,
 
2135
        # - find other keys containing a path 
 
2136
        # We accumulate each entry via this dictionary, including the root 
 
2137
        by_path = {}
 
2138
        id_index = {}
 
2139
        # we could do parallel iterators, but because file id data may be
 
2140
        # scattered throughout, we dont save on index overhead: we have to look
 
2141
        # at everything anyway. We can probably save cycles by reusing parent
 
2142
        # data and doing an incremental update when adding an additional
 
2143
        # parent, but for now the common cases are adding a new parent (merge),
 
2144
        # and replacing completely (commit), and commit is more common: so
 
2145
        # optimise merge later.
 
2146
        
 
2147
        # ---- start generation of full tree mapping data
 
2148
        # what trees should we use?
 
2149
        parent_trees = [tree for rev_id, tree in trees if rev_id not in ghosts]
 
2150
        # how many trees do we end up with 
 
2151
        parent_count = len(parent_trees)
 
2152
 
 
2153
        # one: the current tree
 
2154
        for entry in self._iter_entries():
 
2155
            # skip entries not in the current tree
 
2156
            if entry[1][0][0] in 'ar': # absent, relocated
 
2157
                continue
 
2158
            by_path[entry[0]] = [entry[1][0]] + \
 
2159
                [DirState.NULL_PARENT_DETAILS] * parent_count
 
2160
            id_index[entry[0][2]] = set([entry[0]])
 
2161
        
 
2162
        # now the parent trees:
 
2163
        for tree_index, tree in enumerate(parent_trees):
 
2164
            # the index is off by one, adjust it.
 
2165
            tree_index = tree_index + 1
 
2166
            # when we add new locations for a fileid we need these ranges for
 
2167
            # any fileid in this tree as we set the by_path[id] to:
 
2168
            # already_processed_tree_details + new_details + new_location_suffix
 
2169
            # the suffix is from tree_index+1:parent_count+1.
 
2170
            new_location_suffix = [DirState.NULL_PARENT_DETAILS] * (parent_count - tree_index)
 
2171
            # now stitch in all the entries from this tree
 
2172
            for path, entry in tree.inventory.iter_entries_by_dir():
 
2173
                # here we process each trees details for each item in the tree.
 
2174
                # we first update any existing entries for the id at other paths,
 
2175
                # then we either create or update the entry for the id at the
 
2176
                # right path, and finally we add (if needed) a mapping from
 
2177
                # file_id to this path. We do it in this order to allow us to
 
2178
                # avoid checking all known paths for the id when generating a
 
2179
                # new entry at this path: by adding the id->path mapping last,
 
2180
                # all the mappings are valid and have correct relocation
 
2181
                # records where needed. 
 
2182
                file_id = entry.file_id
 
2183
                path_utf8 = path.encode('utf8')
 
2184
                dirname, basename = osutils.split(path_utf8)
 
2185
                new_entry_key = (dirname, basename, file_id)
 
2186
                # tree index consistency: All other paths for this id in this tree
 
2187
                # index must point to the correct path.
 
2188
                for entry_key in id_index.setdefault(file_id, set()):
 
2189
                    # TODO:PROFILING: It might be faster to just update
 
2190
                    # rather than checking if we need to, and then overwrite
 
2191
                    # the one we are located at.
 
2192
                    if entry_key != new_entry_key:
 
2193
                        # this file id is at a different path in one of the
 
2194
                        # other trees, so put absent pointers there
 
2195
                        # This is the vertical axis in the matrix, all pointing
 
2196
                        # to the real path.
 
2197
                        by_path[entry_key][tree_index] = ('r', path_utf8, 0, False, '')
 
2198
                # by path consistency: Insert into an existing path record (trivial), or 
 
2199
                # add a new one with relocation pointers for the other tree indexes.
 
2200
                if new_entry_key in id_index[file_id]:
 
2201
                    # there is already an entry where this data belongs, just insert it.
 
2202
                    by_path[new_entry_key][tree_index] = \
 
2203
                        self._inv_entry_to_details(entry)
 
2204
                else:
 
2205
                    # add relocated entries to the horizontal axis - this row
 
2206
                    # mapping from path,id. We need to look up the correct path
 
2207
                    # for the indexes from 0 to tree_index -1
 
2208
                    new_details = []
 
2209
                    for lookup_index in xrange(tree_index):
 
2210
                        # boundary case: this is the first occurence of file_id
 
2211
                        # so there are no id_indexs, possibly take this out of
 
2212
                        # the loop?
 
2213
                        if not len(id_index[file_id]):
 
2214
                            new_details.append(DirState.NULL_PARENT_DETAILS)
 
2215
                        else:
 
2216
                            # grab any one entry, use it to find the right path.
 
2217
                            # TODO: optimise this to reduce memory use in highly 
 
2218
                            # fragmented situations by reusing the relocation
 
2219
                            # records.
 
2220
                            a_key = iter(id_index[file_id]).next()
 
2221
                            if by_path[a_key][lookup_index][0] in ('r', 'a'):
 
2222
                                # its a pointer or missing statement, use it as is.
 
2223
                                new_details.append(by_path[a_key][lookup_index])
 
2224
                            else:
 
2225
                                # we have the right key, make a pointer to it.
 
2226
                                real_path = ('/'.join(a_key[0:2])).strip('/')
 
2227
                                new_details.append(('r', real_path, 0, False, ''))
 
2228
                    new_details.append(self._inv_entry_to_details(entry))
 
2229
                    new_details.extend(new_location_suffix)
 
2230
                    by_path[new_entry_key] = new_details
 
2231
                    id_index[file_id].add(new_entry_key)
 
2232
        # --- end generation of full tree mappings
 
2233
 
 
2234
        # sort and output all the entries
 
2235
        new_entries = self._sort_entries(by_path.items())
 
2236
        self._entries_to_current_state(new_entries)
 
2237
        self._parents = [rev_id for rev_id, tree in trees]
 
2238
        self._ghosts = list(ghosts)
 
2239
        self._header_state = DirState.IN_MEMORY_MODIFIED
 
2240
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
2241
        self._id_index = id_index
 
2242
 
 
2243
    def _sort_entries(self, entry_list):
 
2244
        """Given a list of entries, sort them into the right order.
 
2245
 
 
2246
        This is done when constructing a new dirstate from trees - normally we
 
2247
        try to keep everything in sorted blocks all the time, but sometimes
 
2248
        it's easier to sort after the fact.
 
2249
        """
 
2250
        def _key(entry):
 
2251
            # sort by: directory parts, file name, file id
 
2252
            return entry[0][0].split('/'), entry[0][1], entry[0][2]
 
2253
        return sorted(entry_list, key=_key)
 
2254
 
 
2255
    def set_state_from_inventory(self, new_inv):
 
2256
        """Set new_inv as the current state. 
 
2257
 
 
2258
        This API is called by tree transform, and will usually occur with
 
2259
        existing parent trees.
 
2260
 
 
2261
        :param new_inv: The inventory object to set current state from.
 
2262
        """
 
2263
        if 'evil' in debug.debug_flags:
 
2264
            trace.mutter_callsite(1,
 
2265
                "set_state_from_inventory called; please mutate the tree instead")
 
2266
        self._read_dirblocks_if_needed()
 
2267
        # sketch:
 
2268
        # Two iterators: current data and new data, both in dirblock order. 
 
2269
        # We zip them together, which tells about entries that are new in the
 
2270
        # inventory, or removed in the inventory, or present in both and
 
2271
        # possibly changed.  
 
2272
        #
 
2273
        # You might think we could just synthesize a new dirstate directly
 
2274
        # since we're processing it in the right order.  However, we need to
 
2275
        # also consider there may be any number of parent trees and relocation
 
2276
        # pointers, and we don't want to duplicate that here.
 
2277
        new_iterator = new_inv.iter_entries_by_dir()
 
2278
        # we will be modifying the dirstate, so we need a stable iterator. In
 
2279
        # future we might write one, for now we just clone the state into a
 
2280
        # list - which is a shallow copy.
 
2281
        old_iterator = iter(list(self._iter_entries()))
 
2282
        # both must have roots so this is safe:
 
2283
        current_new = new_iterator.next()
 
2284
        current_old = old_iterator.next()
 
2285
        def advance(iterator):
 
2286
            try:
 
2287
                return iterator.next()
 
2288
            except StopIteration:
 
2289
                return None
 
2290
        while current_new or current_old:
 
2291
            # skip entries in old that are not really there
 
2292
            if current_old and current_old[1][0][0] in 'ar':
 
2293
                # relocated or absent
 
2294
                current_old = advance(old_iterator)
 
2295
                continue
 
2296
            if current_new:
 
2297
                # convert new into dirblock style
 
2298
                new_path_utf8 = current_new[0].encode('utf8')
 
2299
                new_dirname, new_basename = osutils.split(new_path_utf8)
 
2300
                new_id = current_new[1].file_id
 
2301
                new_entry_key = (new_dirname, new_basename, new_id)
 
2302
                current_new_minikind = \
 
2303
                    DirState._kind_to_minikind[current_new[1].kind]
 
2304
                if current_new_minikind == 't':
 
2305
                    fingerprint = current_new[1].reference_revision or ''
 
2306
                else:
 
2307
                    # We normally only insert or remove records, or update
 
2308
                    # them when it has significantly changed.  Then we want to
 
2309
                    # erase its fingerprint.  Unaffected records should
 
2310
                    # normally not be updated at all.
 
2311
                    fingerprint = ''
 
2312
            else:
 
2313
                # for safety disable variables
 
2314
                new_path_utf8 = new_dirname = new_basename = new_id = \
 
2315
                    new_entry_key = None
 
2316
            # 5 cases, we dont have a value that is strictly greater than everything, so
 
2317
            # we make both end conditions explicit
 
2318
            if not current_old:
 
2319
                # old is finished: insert current_new into the state.
 
2320
                self.update_minimal(new_entry_key, current_new_minikind,
 
2321
                    executable=current_new[1].executable,
 
2322
                    path_utf8=new_path_utf8, fingerprint=fingerprint)
 
2323
                current_new = advance(new_iterator)
 
2324
            elif not current_new:
 
2325
                # new is finished
 
2326
                self._make_absent(current_old)
 
2327
                current_old = advance(old_iterator)
 
2328
            elif new_entry_key == current_old[0]:
 
2329
                # same -  common case
 
2330
                # We're looking at the same path and id in both the dirstate
 
2331
                # and inventory, so just need to update the fields in the
 
2332
                # dirstate from the one in the inventory.
 
2333
                # TODO: update the record if anything significant has changed.
 
2334
                # the minimal required trigger is if the execute bit or cached
 
2335
                # kind has changed.
 
2336
                if (current_old[1][0][3] != current_new[1].executable or
 
2337
                    current_old[1][0][0] != current_new_minikind):
 
2338
                    self.update_minimal(current_old[0], current_new_minikind,
 
2339
                        executable=current_new[1].executable,
 
2340
                        path_utf8=new_path_utf8, fingerprint=fingerprint)
 
2341
                # both sides are dealt with, move on
 
2342
                current_old = advance(old_iterator)
 
2343
                current_new = advance(new_iterator)
 
2344
            elif (cmp_by_dirs(new_dirname, current_old[0][0]) < 0
 
2345
                  or (new_dirname == current_old[0][0]
 
2346
                      and new_entry_key[1:] < current_old[0][1:])):
 
2347
                # new comes before:
 
2348
                # add a entry for this and advance new
 
2349
                self.update_minimal(new_entry_key, current_new_minikind,
 
2350
                    executable=current_new[1].executable,
 
2351
                    path_utf8=new_path_utf8, fingerprint=fingerprint)
 
2352
                current_new = advance(new_iterator)
 
2353
            else:
 
2354
                # we've advanced past the place where the old key would be,
 
2355
                # without seeing it in the new list.  so it must be gone.
 
2356
                self._make_absent(current_old)
 
2357
                current_old = advance(old_iterator)
 
2358
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
2359
        self._id_index = None
 
2360
        self._packed_stat_index = None
 
2361
 
 
2362
    def _make_absent(self, current_old):
 
2363
        """Mark current_old - an entry - as absent for tree 0.
 
2364
 
 
2365
        :return: True if this was the last details entry for the entry key:
 
2366
            that is, if the underlying block has had the entry removed, thus
 
2367
            shrinking in length.
 
2368
        """
 
2369
        # build up paths that this id will be left at after the change is made,
 
2370
        # so we can update their cross references in tree 0
 
2371
        all_remaining_keys = set()
 
2372
        # Dont check the working tree, because it's going.
 
2373
        for details in current_old[1][1:]:
 
2374
            if details[0] not in 'ar': # absent, relocated
 
2375
                all_remaining_keys.add(current_old[0])
 
2376
            elif details[0] == 'r': # relocated
 
2377
                # record the key for the real path.
 
2378
                all_remaining_keys.add(tuple(osutils.split(details[1])) + (current_old[0][2],))
 
2379
            # absent rows are not present at any path.
 
2380
        last_reference = current_old[0] not in all_remaining_keys
 
2381
        if last_reference:
 
2382
            # the current row consists entire of the current item (being marked
 
2383
            # absent), and relocated or absent entries for the other trees:
 
2384
            # Remove it, its meaningless.
 
2385
            block = self._find_block(current_old[0])
 
2386
            entry_index, present = self._find_entry_index(current_old[0], block[1])
 
2387
            if not present:
 
2388
                raise AssertionError('could not find entry for %s' % (current_old,))
 
2389
            block[1].pop(entry_index)
 
2390
            # if we have an id_index in use, remove this key from it for this id.
 
2391
            if self._id_index is not None:
 
2392
                self._id_index[current_old[0][2]].remove(current_old[0])
 
2393
        # update all remaining keys for this id to record it as absent. The
 
2394
        # existing details may either be the record we are marking as deleted
 
2395
        # (if there were other trees with the id present at this path), or may
 
2396
        # be relocations.
 
2397
        for update_key in all_remaining_keys:
 
2398
            update_block_index, present = \
 
2399
                self._find_block_index_from_key(update_key)
 
2400
            if not present:
 
2401
                raise AssertionError('could not find block for %s' % (update_key,))
 
2402
            update_entry_index, present = \
 
2403
                self._find_entry_index(update_key, self._dirblocks[update_block_index][1])
 
2404
            if not present:
 
2405
                raise AssertionError('could not find entry for %s' % (update_key,))
 
2406
            update_tree_details = self._dirblocks[update_block_index][1][update_entry_index][1]
 
2407
            # it must not be absent at the moment
 
2408
            if update_tree_details[0][0] == 'a': # absent
 
2409
                raise AssertionError('bad row %r' % (update_tree_details,))
 
2410
            update_tree_details[0] = DirState.NULL_PARENT_DETAILS
 
2411
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
2412
        return last_reference
 
2413
 
 
2414
    def update_minimal(self, key, minikind, executable=False, fingerprint='',
 
2415
                       packed_stat=None, size=0, path_utf8=None):
 
2416
        """Update an entry to the state in tree 0.
 
2417
 
 
2418
        This will either create a new entry at 'key' or update an existing one.
 
2419
        It also makes sure that any other records which might mention this are
 
2420
        updated as well.
 
2421
 
 
2422
        :param key: (dir, name, file_id) for the new entry
 
2423
        :param minikind: The type for the entry ('f' == 'file', 'd' ==
 
2424
                'directory'), etc.
 
2425
        :param executable: Should the executable bit be set?
 
2426
        :param fingerprint: Simple fingerprint for new entry: sha1 for files, 
 
2427
            referenced revision id for subtrees, etc.
 
2428
        :param packed_stat: Packed stat value for new entry.
 
2429
        :param size: Size information for new entry
 
2430
        :param path_utf8: key[0] + '/' + key[1], just passed in to avoid doing
 
2431
                extra computation.
 
2432
 
 
2433
        If packed_stat and fingerprint are not given, they're invalidated in
 
2434
        the entry.
 
2435
        """
 
2436
        block = self._find_block(key)[1]
 
2437
        if packed_stat is None:
 
2438
            packed_stat = DirState.NULLSTAT
 
2439
        # XXX: Some callers pass '' as the packed_stat, and it seems to be
 
2440
        # sometimes present in the dirstate - this seems oddly inconsistent.
 
2441
        # mbp 20071008
 
2442
        entry_index, present = self._find_entry_index(key, block)
 
2443
        new_details = (minikind, fingerprint, size, executable, packed_stat)
 
2444
        id_index = self._get_id_index()
 
2445
        if not present:
 
2446
            # new entry, synthesis cross reference here,
 
2447
            existing_keys = id_index.setdefault(key[2], set())
 
2448
            if not existing_keys:
 
2449
                # not currently in the state, simplest case
 
2450
                new_entry = key, [new_details] + self._empty_parent_info()
 
2451
            else:
 
2452
                # present at one or more existing other paths.
 
2453
                # grab one of them and use it to generate parent
 
2454
                # relocation/absent entries.
 
2455
                new_entry = key, [new_details]
 
2456
                for other_key in existing_keys:
 
2457
                    # change the record at other to be a pointer to this new
 
2458
                    # record. The loop looks similar to the change to
 
2459
                    # relocations when updating an existing record but its not:
 
2460
                    # the test for existing kinds is different: this can be
 
2461
                    # factored out to a helper though.
 
2462
                    other_block_index, present = self._find_block_index_from_key(other_key)
 
2463
                    if not present:
 
2464
                        raise AssertionError('could not find block for %s' % (other_key,))
 
2465
                    other_entry_index, present = self._find_entry_index(other_key,
 
2466
                                            self._dirblocks[other_block_index][1])
 
2467
                    if not present:
 
2468
                        raise AssertionError('could not find entry for %s' % (other_key,))
 
2469
                    if path_utf8 is None:
 
2470
                        raise AssertionError('no path')
 
2471
                    self._dirblocks[other_block_index][1][other_entry_index][1][0] = \
 
2472
                        ('r', path_utf8, 0, False, '')
 
2473
 
 
2474
                num_present_parents = self._num_present_parents()
 
2475
                for lookup_index in xrange(1, num_present_parents + 1):
 
2476
                    # grab any one entry, use it to find the right path.
 
2477
                    # TODO: optimise this to reduce memory use in highly 
 
2478
                    # fragmented situations by reusing the relocation
 
2479
                    # records.
 
2480
                    update_block_index, present = \
 
2481
                        self._find_block_index_from_key(other_key)
 
2482
                    if not present:
 
2483
                        raise AssertionError('could not find block for %s' % (other_key,))
 
2484
                    update_entry_index, present = \
 
2485
                        self._find_entry_index(other_key, self._dirblocks[update_block_index][1])
 
2486
                    if not present:
 
2487
                        raise AssertionError('could not find entry for %s' % (other_key,))
 
2488
                    update_details = self._dirblocks[update_block_index][1][update_entry_index][1][lookup_index]
 
2489
                    if update_details[0] in 'ar': # relocated, absent
 
2490
                        # its a pointer or absent in lookup_index's tree, use
 
2491
                        # it as is.
 
2492
                        new_entry[1].append(update_details)
 
2493
                    else:
 
2494
                        # we have the right key, make a pointer to it.
 
2495
                        pointer_path = osutils.pathjoin(*other_key[0:2])
 
2496
                        new_entry[1].append(('r', pointer_path, 0, False, ''))
 
2497
            block.insert(entry_index, new_entry)
 
2498
            existing_keys.add(key)
 
2499
        else:
 
2500
            # Does the new state matter? 
 
2501
            block[entry_index][1][0] = new_details
 
2502
            # parents cannot be affected by what we do.
 
2503
            # other occurences of this id can be found 
 
2504
            # from the id index.
 
2505
            # ---
 
2506
            # tree index consistency: All other paths for this id in this tree
 
2507
            # index must point to the correct path. We have to loop here because
 
2508
            # we may have passed entries in the state with this file id already
 
2509
            # that were absent - where parent entries are - and they need to be
 
2510
            # converted to relocated.
 
2511
            if path_utf8 is None:
 
2512
                raise AssertionError('no path')
 
2513
            for entry_key in id_index.setdefault(key[2], set()):
 
2514
                # TODO:PROFILING: It might be faster to just update
 
2515
                # rather than checking if we need to, and then overwrite
 
2516
                # the one we are located at.
 
2517
                if entry_key != key:
 
2518
                    # this file id is at a different path in one of the
 
2519
                    # other trees, so put absent pointers there
 
2520
                    # This is the vertical axis in the matrix, all pointing
 
2521
                    # to the real path.
 
2522
                    block_index, present = self._find_block_index_from_key(entry_key)
 
2523
                    if not present:
 
2524
                        raise AssertionError('not present: %r', entry_key)
 
2525
                    entry_index, present = self._find_entry_index(entry_key, self._dirblocks[block_index][1])
 
2526
                    if not present:
 
2527
                        raise AssertionError('not present: %r', entry_key)
 
2528
                    self._dirblocks[block_index][1][entry_index][1][0] = \
 
2529
                        ('r', path_utf8, 0, False, '')
 
2530
        # add a containing dirblock if needed.
 
2531
        if new_details[0] == 'd':
 
2532
            subdir_key = (osutils.pathjoin(*key[0:2]), '', '')
 
2533
            block_index, present = self._find_block_index_from_key(subdir_key)
 
2534
            if not present:
 
2535
                self._dirblocks.insert(block_index, (subdir_key[0], []))
 
2536
 
 
2537
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
2538
 
 
2539
    def _validate(self):
 
2540
        """Check that invariants on the dirblock are correct.
 
2541
 
 
2542
        This can be useful in debugging; it shouldn't be necessary in 
 
2543
        normal code.
 
2544
 
 
2545
        This must be called with a lock held.
 
2546
        """
 
2547
        # NOTE: This must always raise AssertionError not just assert,
 
2548
        # otherwise it may not behave properly under python -O
 
2549
        #
 
2550
        # TODO: All entries must have some content that's not 'a' or 'r',
 
2551
        # otherwise it could just be removed.
 
2552
        #
 
2553
        # TODO: All relocations must point directly to a real entry.
 
2554
        #
 
2555
        # TODO: No repeated keys.
 
2556
        #
 
2557
        # -- mbp 20070325
 
2558
        from pprint import pformat
 
2559
        self._read_dirblocks_if_needed()
 
2560
        if len(self._dirblocks) > 0:
 
2561
            if not self._dirblocks[0][0] == '':
 
2562
                raise AssertionError(
 
2563
                    "dirblocks don't start with root block:\n" + \
 
2564
                    pformat(self._dirblocks))
 
2565
        if len(self._dirblocks) > 1:
 
2566
            if not self._dirblocks[1][0] == '':
 
2567
                raise AssertionError(
 
2568
                    "dirblocks missing root directory:\n" + \
 
2569
                    pformat(self._dirblocks))
 
2570
        # the dirblocks are sorted by their path components, name, and dir id
 
2571
        dir_names = [d[0].split('/')
 
2572
                for d in self._dirblocks[1:]]
 
2573
        if dir_names != sorted(dir_names):
 
2574
            raise AssertionError(
 
2575
                "dir names are not in sorted order:\n" + \
 
2576
                pformat(self._dirblocks) + \
 
2577
                "\nkeys:\n" +
 
2578
                pformat(dir_names))
 
2579
        for dirblock in self._dirblocks:
 
2580
            # within each dirblock, the entries are sorted by filename and
 
2581
            # then by id.
 
2582
            for entry in dirblock[1]:
 
2583
                if dirblock[0] != entry[0][0]:
 
2584
                    raise AssertionError(
 
2585
                        "entry key for %r"
 
2586
                        "doesn't match directory name in\n%r" %
 
2587
                        (entry, pformat(dirblock)))
 
2588
            if dirblock[1] != sorted(dirblock[1]):
 
2589
                raise AssertionError(
 
2590
                    "dirblock for %r is not sorted:\n%s" % \
 
2591
                    (dirblock[0], pformat(dirblock)))
 
2592
 
 
2593
        def check_valid_parent():
 
2594
            """Check that the current entry has a valid parent.
 
2595
 
 
2596
            This makes sure that the parent has a record,
 
2597
            and that the parent isn't marked as "absent" in the
 
2598
            current tree. (It is invalid to have a non-absent file in an absent
 
2599
            directory.)
 
2600
            """
 
2601
            if entry[0][0:2] == ('', ''):
 
2602
                # There should be no parent for the root row
 
2603
                return
 
2604
            parent_entry = self._get_entry(tree_index, path_utf8=entry[0][0])
 
2605
            if parent_entry == (None, None):
 
2606
                raise AssertionError(
 
2607
                    "no parent entry for: %s in tree %s"
 
2608
                    % (this_path, tree_index))
 
2609
            if parent_entry[1][tree_index][0] != 'd':
 
2610
                raise AssertionError(
 
2611
                    "Parent entry for %s is not marked as a valid"
 
2612
                    " directory. %s" % (this_path, parent_entry,))
 
2613
 
 
2614
        # For each file id, for each tree: either
 
2615
        # the file id is not present at all; all rows with that id in the
 
2616
        # key have it marked as 'absent'
 
2617
        # OR the file id is present under exactly one name; any other entries 
 
2618
        # that mention that id point to the correct name.
 
2619
        #
 
2620
        # We check this with a dict per tree pointing either to the present
 
2621
        # name, or None if absent.
 
2622
        tree_count = self._num_present_parents() + 1
 
2623
        id_path_maps = [dict() for i in range(tree_count)]
 
2624
        # Make sure that all renamed entries point to the correct location.
 
2625
        for entry in self._iter_entries():
 
2626
            file_id = entry[0][2]
 
2627
            this_path = osutils.pathjoin(entry[0][0], entry[0][1])
 
2628
            if len(entry[1]) != tree_count:
 
2629
                raise AssertionError(
 
2630
                "wrong number of entry details for row\n%s" \
 
2631
                ",\nexpected %d" % \
 
2632
                (pformat(entry), tree_count))
 
2633
            absent_positions = 0
 
2634
            for tree_index, tree_state in enumerate(entry[1]):
 
2635
                this_tree_map = id_path_maps[tree_index]
 
2636
                minikind = tree_state[0]
 
2637
                if minikind in 'ar':
 
2638
                    absent_positions += 1
 
2639
                # have we seen this id before in this column?
 
2640
                if file_id in this_tree_map:
 
2641
                    previous_path, previous_loc = this_tree_map[file_id]
 
2642
                    # any later mention of this file must be consistent with
 
2643
                    # what was said before
 
2644
                    if minikind == 'a':
 
2645
                        if previous_path is not None:
 
2646
                            raise AssertionError(
 
2647
                            "file %s is absent in row %r but also present " \
 
2648
                            "at %r"% \
 
2649
                            (file_id, entry, previous_path))
 
2650
                    elif minikind == 'r':
 
2651
                        target_location = tree_state[1]
 
2652
                        if previous_path != target_location:
 
2653
                            raise AssertionError(
 
2654
                            "file %s relocation in row %r but also at %r" \
 
2655
                            % (file_id, entry, previous_path))
 
2656
                    else:
 
2657
                        # a file, directory, etc - may have been previously
 
2658
                        # pointed to by a relocation, which must point here
 
2659
                        if previous_path != this_path:
 
2660
                            raise AssertionError(
 
2661
                                "entry %r inconsistent with previous path %r "
 
2662
                                "seen at %r" %
 
2663
                                (entry, previous_path, previous_loc))
 
2664
                        check_valid_parent()
 
2665
                else:
 
2666
                    if minikind == 'a':
 
2667
                        # absent; should not occur anywhere else
 
2668
                        this_tree_map[file_id] = None, this_path
 
2669
                    elif minikind == 'r':
 
2670
                        # relocation, must occur at expected location 
 
2671
                        this_tree_map[file_id] = tree_state[1], this_path
 
2672
                    else:
 
2673
                        this_tree_map[file_id] = this_path, this_path
 
2674
                        check_valid_parent()
 
2675
            if absent_positions == tree_count:
 
2676
                raise AssertionError(
 
2677
                    "entry %r has no data for any tree." % (entry,))
 
2678
 
 
2679
    def _wipe_state(self):
 
2680
        """Forget all state information about the dirstate."""
 
2681
        self._header_state = DirState.NOT_IN_MEMORY
 
2682
        self._dirblock_state = DirState.NOT_IN_MEMORY
 
2683
        self._changes_aborted = False
 
2684
        self._parents = []
 
2685
        self._ghosts = []
 
2686
        self._dirblocks = []
 
2687
        self._id_index = None
 
2688
        self._packed_stat_index = None
 
2689
        self._end_of_header = None
 
2690
        self._cutoff_time = None
 
2691
        self._split_path_cache = {}
 
2692
 
 
2693
    def lock_read(self):
 
2694
        """Acquire a read lock on the dirstate."""
 
2695
        if self._lock_token is not None:
 
2696
            raise errors.LockContention(self._lock_token)
 
2697
        # TODO: jam 20070301 Rather than wiping completely, if the blocks are
 
2698
        #       already in memory, we could read just the header and check for
 
2699
        #       any modification. If not modified, we can just leave things
 
2700
        #       alone
 
2701
        self._lock_token = lock.ReadLock(self._filename)
 
2702
        self._lock_state = 'r'
 
2703
        self._state_file = self._lock_token.f
 
2704
        self._wipe_state()
 
2705
 
 
2706
    def lock_write(self):
 
2707
        """Acquire a write lock on the dirstate."""
 
2708
        if self._lock_token is not None:
 
2709
            raise errors.LockContention(self._lock_token)
 
2710
        # TODO: jam 20070301 Rather than wiping completely, if the blocks are
 
2711
        #       already in memory, we could read just the header and check for
 
2712
        #       any modification. If not modified, we can just leave things
 
2713
        #       alone
 
2714
        self._lock_token = lock.WriteLock(self._filename)
 
2715
        self._lock_state = 'w'
 
2716
        self._state_file = self._lock_token.f
 
2717
        self._wipe_state()
 
2718
 
 
2719
    def unlock(self):
 
2720
        """Drop any locks held on the dirstate."""
 
2721
        if self._lock_token is None:
 
2722
            raise errors.LockNotHeld(self)
 
2723
        # TODO: jam 20070301 Rather than wiping completely, if the blocks are
 
2724
        #       already in memory, we could read just the header and check for
 
2725
        #       any modification. If not modified, we can just leave things
 
2726
        #       alone
 
2727
        self._state_file = None
 
2728
        self._lock_state = None
 
2729
        self._lock_token.unlock()
 
2730
        self._lock_token = None
 
2731
        self._split_path_cache = {}
 
2732
 
 
2733
    def _requires_lock(self):
 
2734
        """Check that a lock is currently held by someone on the dirstate."""
 
2735
        if not self._lock_token:
 
2736
            raise errors.ObjectNotLocked(self)
 
2737
 
 
2738
 
 
2739
def py_update_entry(state, entry, abspath, stat_value,
 
2740
                 _stat_to_minikind=DirState._stat_to_minikind,
 
2741
                 _pack_stat=pack_stat):
 
2742
    """Update the entry based on what is actually on disk.
 
2743
 
 
2744
    :param state: The dirstate this entry is in.
 
2745
    :param entry: This is the dirblock entry for the file in question.
 
2746
    :param abspath: The path on disk for this file.
 
2747
    :param stat_value: The stat value done on the path.
 
2748
    :return: The sha1 hexdigest of the file (40 bytes) or link target of a
 
2749
            symlink.
 
2750
    """
 
2751
    try:
 
2752
        minikind = _stat_to_minikind[stat_value.st_mode & 0170000]
 
2753
    except KeyError:
 
2754
        # Unhandled kind
 
2755
        return None
 
2756
    packed_stat = _pack_stat(stat_value)
 
2757
    (saved_minikind, saved_link_or_sha1, saved_file_size,
 
2758
     saved_executable, saved_packed_stat) = entry[1][0]
 
2759
 
 
2760
    if (minikind == saved_minikind
 
2761
        and packed_stat == saved_packed_stat):
 
2762
        # The stat hasn't changed since we saved, so we can re-use the
 
2763
        # saved sha hash.
 
2764
        if minikind == 'd':
 
2765
            return None
 
2766
 
 
2767
        # size should also be in packed_stat
 
2768
        if saved_file_size == stat_value.st_size:
 
2769
            return saved_link_or_sha1
 
2770
 
 
2771
    # If we have gotten this far, that means that we need to actually
 
2772
    # process this entry.
 
2773
    link_or_sha1 = None
 
2774
    if minikind == 'f':
 
2775
        link_or_sha1 = state._sha1_file(abspath)
 
2776
        executable = state._is_executable(stat_value.st_mode,
 
2777
                                         saved_executable)
 
2778
        if state._cutoff_time is None:
 
2779
            state._sha_cutoff_time()
 
2780
        if (stat_value.st_mtime < state._cutoff_time
 
2781
            and stat_value.st_ctime < state._cutoff_time):
 
2782
            entry[1][0] = ('f', link_or_sha1, stat_value.st_size,
 
2783
                           executable, packed_stat)
 
2784
        else:
 
2785
            entry[1][0] = ('f', '', stat_value.st_size,
 
2786
                           executable, DirState.NULLSTAT)
 
2787
    elif minikind == 'd':
 
2788
        link_or_sha1 = None
 
2789
        entry[1][0] = ('d', '', 0, False, packed_stat)
 
2790
        if saved_minikind != 'd':
 
2791
            # This changed from something into a directory. Make sure we
 
2792
            # have a directory block for it. This doesn't happen very
 
2793
            # often, so this doesn't have to be super fast.
 
2794
            block_index, entry_index, dir_present, file_present = \
 
2795
                state._get_block_entry_index(entry[0][0], entry[0][1], 0)
 
2796
            state._ensure_block(block_index, entry_index,
 
2797
                               osutils.pathjoin(entry[0][0], entry[0][1]))
 
2798
    elif minikind == 'l':
 
2799
        link_or_sha1 = state._read_link(abspath, saved_link_or_sha1)
 
2800
        if state._cutoff_time is None:
 
2801
            state._sha_cutoff_time()
 
2802
        if (stat_value.st_mtime < state._cutoff_time
 
2803
            and stat_value.st_ctime < state._cutoff_time):
 
2804
            entry[1][0] = ('l', link_or_sha1, stat_value.st_size,
 
2805
                           False, packed_stat)
 
2806
        else:
 
2807
            entry[1][0] = ('l', '', stat_value.st_size,
 
2808
                           False, DirState.NULLSTAT)
 
2809
    state._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
2810
    return link_or_sha1
 
2811
update_entry = py_update_entry
 
2812
 
 
2813
 
 
2814
class ProcessEntryPython(object):
 
2815
 
 
2816
    __slots__ = ["old_dirname_to_file_id", "new_dirname_to_file_id", "uninteresting",
 
2817
        "last_source_parent", "last_target_parent", "include_unchanged",
 
2818
        "use_filesystem_for_exec", "utf8_decode", "searched_specific_files",
 
2819
        "search_specific_files", "state", "source_index", "target_index",
 
2820
        "want_unversioned", "tree"]
 
2821
 
 
2822
    def __init__(self, include_unchanged, use_filesystem_for_exec,
 
2823
        search_specific_files, state, source_index, target_index,
 
2824
        want_unversioned, tree):
 
2825
        self.old_dirname_to_file_id = {}
 
2826
        self.new_dirname_to_file_id = {}
 
2827
        # Just a sentry, so that _process_entry can say that this
 
2828
        # record is handled, but isn't interesting to process (unchanged)
 
2829
        self.uninteresting = object()
 
2830
        # Using a list so that we can access the values and change them in
 
2831
        # nested scope. Each one is [path, file_id, entry]
 
2832
        self.last_source_parent = [None, None]
 
2833
        self.last_target_parent = [None, None]
 
2834
        self.include_unchanged = include_unchanged
 
2835
        self.use_filesystem_for_exec = use_filesystem_for_exec
 
2836
        self.utf8_decode = cache_utf8._utf8_decode
 
2837
        # for all search_indexs in each path at or under each element of
 
2838
        # search_specific_files, if the detail is relocated: add the id, and add the
 
2839
        # relocated path as one to search if its not searched already. If the
 
2840
        # detail is not relocated, add the id.
 
2841
        self.searched_specific_files = set()
 
2842
        self.search_specific_files = search_specific_files
 
2843
        self.state = state
 
2844
        self.source_index = source_index
 
2845
        self.target_index = target_index
 
2846
        self.want_unversioned = want_unversioned
 
2847
        self.tree = tree
 
2848
 
 
2849
    def _process_entry(self, entry, path_info, pathjoin=osutils.pathjoin):
 
2850
        """Compare an entry and real disk to generate delta information.
 
2851
 
 
2852
        :param path_info: top_relpath, basename, kind, lstat, abspath for
 
2853
            the path of entry. If None, then the path is considered absent.
 
2854
            (Perhaps we should pass in a concrete entry for this ?)
 
2855
            Basename is returned as a utf8 string because we expect this
 
2856
            tuple will be ignored, and don't want to take the time to
 
2857
            decode.
 
2858
        :return: None if these don't match
 
2859
                 A tuple of information about the change, or
 
2860
                 the object 'uninteresting' if these match, but are
 
2861
                 basically identical.
 
2862
        """
 
2863
        if self.source_index is None:
 
2864
            source_details = DirState.NULL_PARENT_DETAILS
 
2865
        else:
 
2866
            source_details = entry[1][self.source_index]
 
2867
        target_details = entry[1][self.target_index]
 
2868
        target_minikind = target_details[0]
 
2869
        if path_info is not None and target_minikind in 'fdlt':
 
2870
            if not (self.target_index == 0):
 
2871
                raise AssertionError()
 
2872
            link_or_sha1 = update_entry(self.state, entry,
 
2873
                abspath=path_info[4], stat_value=path_info[3])
 
2874
            # The entry may have been modified by update_entry
 
2875
            target_details = entry[1][self.target_index]
 
2876
            target_minikind = target_details[0]
 
2877
        else:
 
2878
            link_or_sha1 = None
 
2879
        file_id = entry[0][2]
 
2880
        source_minikind = source_details[0]
 
2881
        if source_minikind in 'fdltr' and target_minikind in 'fdlt':
 
2882
            # claimed content in both: diff
 
2883
            #   r    | fdlt   |      | add source to search, add id path move and perform
 
2884
            #        |        |      | diff check on source-target
 
2885
            #   r    | fdlt   |  a   | dangling file that was present in the basis.
 
2886
            #        |        |      | ???
 
2887
            if source_minikind in 'r':
 
2888
                # add the source to the search path to find any children it
 
2889
                # has.  TODO ? : only add if it is a container ?
 
2890
                if not osutils.is_inside_any(self.searched_specific_files,
 
2891
                                             source_details[1]):
 
2892
                    self.search_specific_files.add(source_details[1])
 
2893
                # generate the old path; this is needed for stating later
 
2894
                # as well.
 
2895
                old_path = source_details[1]
 
2896
                old_dirname, old_basename = os.path.split(old_path)
 
2897
                path = pathjoin(entry[0][0], entry[0][1])
 
2898
                old_entry = self.state._get_entry(self.source_index,
 
2899
                                             path_utf8=old_path)
 
2900
                # update the source details variable to be the real
 
2901
                # location.
 
2902
                if old_entry == (None, None):
 
2903
                    raise errors.CorruptDirstate(self.state._filename,
 
2904
                        "entry '%s/%s' is considered renamed from %r"
 
2905
                        " but source does not exist\n"
 
2906
                        "entry: %s" % (entry[0][0], entry[0][1], old_path, entry))
 
2907
                source_details = old_entry[1][self.source_index]
 
2908
                source_minikind = source_details[0]
 
2909
            else:
 
2910
                old_dirname = entry[0][0]
 
2911
                old_basename = entry[0][1]
 
2912
                old_path = path = None
 
2913
            if path_info is None:
 
2914
                # the file is missing on disk, show as removed.
 
2915
                content_change = True
 
2916
                target_kind = None
 
2917
                target_exec = False
 
2918
            else:
 
2919
                # source and target are both versioned and disk file is present.
 
2920
                target_kind = path_info[2]
 
2921
                if target_kind == 'directory':
 
2922
                    if path is None:
 
2923
                        old_path = path = pathjoin(old_dirname, old_basename)
 
2924
                    self.new_dirname_to_file_id[path] = file_id
 
2925
                    if source_minikind != 'd':
 
2926
                        content_change = True
 
2927
                    else:
 
2928
                        # directories have no fingerprint
 
2929
                        content_change = False
 
2930
                    target_exec = False
 
2931
                elif target_kind == 'file':
 
2932
                    if source_minikind != 'f':
 
2933
                        content_change = True
 
2934
                    else:
 
2935
                        # We could check the size, but we already have the
 
2936
                        # sha1 hash.
 
2937
                        content_change = (link_or_sha1 != source_details[1])
 
2938
                    # Target details is updated at update_entry time
 
2939
                    if self.use_filesystem_for_exec:
 
2940
                        # We don't need S_ISREG here, because we are sure
 
2941
                        # we are dealing with a file.
 
2942
                        target_exec = bool(stat.S_IEXEC & path_info[3].st_mode)
 
2943
                    else:
 
2944
                        target_exec = target_details[3]
 
2945
                elif target_kind == 'symlink':
 
2946
                    if source_minikind != 'l':
 
2947
                        content_change = True
 
2948
                    else:
 
2949
                        content_change = (link_or_sha1 != source_details[1])
 
2950
                    target_exec = False
 
2951
                elif target_kind == 'tree-reference':
 
2952
                    if source_minikind != 't':
 
2953
                        content_change = True
 
2954
                    else:
 
2955
                        content_change = False
 
2956
                    target_exec = False
 
2957
                else:
 
2958
                    raise Exception, "unknown kind %s" % path_info[2]
 
2959
            if source_minikind == 'd':
 
2960
                if path is None:
 
2961
                    old_path = path = pathjoin(old_dirname, old_basename)
 
2962
                self.old_dirname_to_file_id[old_path] = file_id
 
2963
            # parent id is the entry for the path in the target tree
 
2964
            if old_dirname == self.last_source_parent[0]:
 
2965
                source_parent_id = self.last_source_parent[1]
 
2966
            else:
 
2967
                try:
 
2968
                    source_parent_id = self.old_dirname_to_file_id[old_dirname]
 
2969
                except KeyError:
 
2970
                    source_parent_entry = self.state._get_entry(self.source_index,
 
2971
                                                           path_utf8=old_dirname)
 
2972
                    source_parent_id = source_parent_entry[0][2]
 
2973
                if source_parent_id == entry[0][2]:
 
2974
                    # This is the root, so the parent is None
 
2975
                    source_parent_id = None
 
2976
                else:
 
2977
                    self.last_source_parent[0] = old_dirname
 
2978
                    self.last_source_parent[1] = source_parent_id
 
2979
            new_dirname = entry[0][0]
 
2980
            if new_dirname == self.last_target_parent[0]:
 
2981
                target_parent_id = self.last_target_parent[1]
 
2982
            else:
 
2983
                try:
 
2984
                    target_parent_id = self.new_dirname_to_file_id[new_dirname]
 
2985
                except KeyError:
 
2986
                    # TODO: We don't always need to do the lookup, because the
 
2987
                    #       parent entry will be the same as the source entry.
 
2988
                    target_parent_entry = self.state._get_entry(self.target_index,
 
2989
                                                           path_utf8=new_dirname)
 
2990
                    if target_parent_entry == (None, None):
 
2991
                        raise AssertionError(
 
2992
                            "Could not find target parent in wt: %s\nparent of: %s"
 
2993
                            % (new_dirname, entry))
 
2994
                    target_parent_id = target_parent_entry[0][2]
 
2995
                if target_parent_id == entry[0][2]:
 
2996
                    # This is the root, so the parent is None
 
2997
                    target_parent_id = None
 
2998
                else:
 
2999
                    self.last_target_parent[0] = new_dirname
 
3000
                    self.last_target_parent[1] = target_parent_id
 
3001
 
 
3002
            source_exec = source_details[3]
 
3003
            if (self.include_unchanged
 
3004
                or content_change
 
3005
                or source_parent_id != target_parent_id
 
3006
                or old_basename != entry[0][1]
 
3007
                or source_exec != target_exec
 
3008
                ):
 
3009
                if old_path is None:
 
3010
                    old_path = path = pathjoin(old_dirname, old_basename)
 
3011
                    old_path_u = self.utf8_decode(old_path)[0]
 
3012
                    path_u = old_path_u
 
3013
                else:
 
3014
                    old_path_u = self.utf8_decode(old_path)[0]
 
3015
                    if old_path == path:
 
3016
                        path_u = old_path_u
 
3017
                    else:
 
3018
                        path_u = self.utf8_decode(path)[0]
 
3019
                source_kind = DirState._minikind_to_kind[source_minikind]
 
3020
                return (entry[0][2],
 
3021
                       (old_path_u, path_u),
 
3022
                       content_change,
 
3023
                       (True, True),
 
3024
                       (source_parent_id, target_parent_id),
 
3025
                       (self.utf8_decode(old_basename)[0], self.utf8_decode(entry[0][1])[0]),
 
3026
                       (source_kind, target_kind),
 
3027
                       (source_exec, target_exec))
 
3028
            else:
 
3029
                return self.uninteresting
 
3030
        elif source_minikind in 'a' and target_minikind in 'fdlt':
 
3031
            # looks like a new file
 
3032
            path = pathjoin(entry[0][0], entry[0][1])
 
3033
            # parent id is the entry for the path in the target tree
 
3034
            # TODO: these are the same for an entire directory: cache em.
 
3035
            parent_id = self.state._get_entry(self.target_index,
 
3036
                                         path_utf8=entry[0][0])[0][2]
 
3037
            if parent_id == entry[0][2]:
 
3038
                parent_id = None
 
3039
            if path_info is not None:
 
3040
                # Present on disk:
 
3041
                if self.use_filesystem_for_exec:
 
3042
                    # We need S_ISREG here, because we aren't sure if this
 
3043
                    # is a file or not.
 
3044
                    target_exec = bool(
 
3045
                        stat.S_ISREG(path_info[3].st_mode)
 
3046
                        and stat.S_IEXEC & path_info[3].st_mode)
 
3047
                else:
 
3048
                    target_exec = target_details[3]
 
3049
                return (entry[0][2],
 
3050
                       (None, self.utf8_decode(path)[0]),
 
3051
                       True,
 
3052
                       (False, True),
 
3053
                       (None, parent_id),
 
3054
                       (None, self.utf8_decode(entry[0][1])[0]),
 
3055
                       (None, path_info[2]),
 
3056
                       (None, target_exec))
 
3057
            else:
 
3058
                # Its a missing file, report it as such.
 
3059
                return (entry[0][2],
 
3060
                       (None, self.utf8_decode(path)[0]),
 
3061
                       False,
 
3062
                       (False, True),
 
3063
                       (None, parent_id),
 
3064
                       (None, self.utf8_decode(entry[0][1])[0]),
 
3065
                       (None, None),
 
3066
                       (None, False))
 
3067
        elif source_minikind in 'fdlt' and target_minikind in 'a':
 
3068
            # unversioned, possibly, or possibly not deleted: we dont care.
 
3069
            # if its still on disk, *and* theres no other entry at this
 
3070
            # path [we dont know this in this routine at the moment -
 
3071
            # perhaps we should change this - then it would be an unknown.
 
3072
            old_path = pathjoin(entry[0][0], entry[0][1])
 
3073
            # parent id is the entry for the path in the target tree
 
3074
            parent_id = self.state._get_entry(self.source_index, path_utf8=entry[0][0])[0][2]
 
3075
            if parent_id == entry[0][2]:
 
3076
                parent_id = None
 
3077
            return (entry[0][2],
 
3078
                   (self.utf8_decode(old_path)[0], None),
 
3079
                   True,
 
3080
                   (True, False),
 
3081
                   (parent_id, None),
 
3082
                   (self.utf8_decode(entry[0][1])[0], None),
 
3083
                   (DirState._minikind_to_kind[source_minikind], None),
 
3084
                   (source_details[3], None))
 
3085
        elif source_minikind in 'fdlt' and target_minikind in 'r':
 
3086
            # a rename; could be a true rename, or a rename inherited from
 
3087
            # a renamed parent. TODO: handle this efficiently. Its not
 
3088
            # common case to rename dirs though, so a correct but slow
 
3089
            # implementation will do.
 
3090
            if not osutils.is_inside_any(self.searched_specific_files, target_details[1]):
 
3091
                self.search_specific_files.add(target_details[1])
 
3092
        elif source_minikind in 'ra' and target_minikind in 'ra':
 
3093
            # neither of the selected trees contain this file,
 
3094
            # so skip over it. This is not currently directly tested, but
 
3095
            # is indirectly via test_too_much.TestCommands.test_conflicts.
 
3096
            pass
 
3097
        else:
 
3098
            raise AssertionError("don't know how to compare "
 
3099
                "source_minikind=%r, target_minikind=%r"
 
3100
                % (source_minikind, target_minikind))
 
3101
            ## import pdb;pdb.set_trace()
 
3102
        return None
 
3103
 
 
3104
    def __iter__(self):
 
3105
        return self
 
3106
 
 
3107
    def iter_changes(self):
 
3108
        """Iterate over the changes."""
 
3109
        utf8_decode = cache_utf8._utf8_decode
 
3110
        _cmp_by_dirs = cmp_by_dirs
 
3111
        _process_entry = self._process_entry
 
3112
        uninteresting = self.uninteresting
 
3113
        search_specific_files = self.search_specific_files
 
3114
        searched_specific_files = self.searched_specific_files
 
3115
        splitpath = osutils.splitpath
 
3116
        # sketch: 
 
3117
        # compare source_index and target_index at or under each element of search_specific_files.
 
3118
        # follow the following comparison table. Note that we only want to do diff operations when
 
3119
        # the target is fdl because thats when the walkdirs logic will have exposed the pathinfo 
 
3120
        # for the target.
 
3121
        # cases:
 
3122
        # 
 
3123
        # Source | Target | disk | action
 
3124
        #   r    | fdlt   |      | add source to search, add id path move and perform
 
3125
        #        |        |      | diff check on source-target
 
3126
        #   r    | fdlt   |  a   | dangling file that was present in the basis. 
 
3127
        #        |        |      | ???
 
3128
        #   r    |  a     |      | add source to search
 
3129
        #   r    |  a     |  a   | 
 
3130
        #   r    |  r     |      | this path is present in a non-examined tree, skip.
 
3131
        #   r    |  r     |  a   | this path is present in a non-examined tree, skip.
 
3132
        #   a    | fdlt   |      | add new id
 
3133
        #   a    | fdlt   |  a   | dangling locally added file, skip
 
3134
        #   a    |  a     |      | not present in either tree, skip
 
3135
        #   a    |  a     |  a   | not present in any tree, skip
 
3136
        #   a    |  r     |      | not present in either tree at this path, skip as it
 
3137
        #        |        |      | may not be selected by the users list of paths.
 
3138
        #   a    |  r     |  a   | not present in either tree at this path, skip as it
 
3139
        #        |        |      | may not be selected by the users list of paths.
 
3140
        #  fdlt  | fdlt   |      | content in both: diff them
 
3141
        #  fdlt  | fdlt   |  a   | deleted locally, but not unversioned - show as deleted ?
 
3142
        #  fdlt  |  a     |      | unversioned: output deleted id for now
 
3143
        #  fdlt  |  a     |  a   | unversioned and deleted: output deleted id
 
3144
        #  fdlt  |  r     |      | relocated in this tree, so add target to search.
 
3145
        #        |        |      | Dont diff, we will see an r,fd; pair when we reach
 
3146
        #        |        |      | this id at the other path.
 
3147
        #  fdlt  |  r     |  a   | relocated in this tree, so add target to search.
 
3148
        #        |        |      | Dont diff, we will see an r,fd; pair when we reach
 
3149
        #        |        |      | this id at the other path.
 
3150
 
 
3151
        # TODO: jam 20070516 - Avoid the _get_entry lookup overhead by
 
3152
        #       keeping a cache of directories that we have seen.
 
3153
 
 
3154
        while search_specific_files:
 
3155
            # TODO: the pending list should be lexically sorted?  the
 
3156
            # interface doesn't require it.
 
3157
            current_root = search_specific_files.pop()
 
3158
            current_root_unicode = current_root.decode('utf8')
 
3159
            searched_specific_files.add(current_root)
 
3160
            # process the entries for this containing directory: the rest will be
 
3161
            # found by their parents recursively.
 
3162
            root_entries = self.state._entries_for_path(current_root)
 
3163
            root_abspath = self.tree.abspath(current_root_unicode)
 
3164
            try:
 
3165
                root_stat = os.lstat(root_abspath)
 
3166
            except OSError, e:
 
3167
                if e.errno == errno.ENOENT:
 
3168
                    # the path does not exist: let _process_entry know that.
 
3169
                    root_dir_info = None
 
3170
                else:
 
3171
                    # some other random error: hand it up.
 
3172
                    raise
 
3173
            else:
 
3174
                root_dir_info = ('', current_root,
 
3175
                    osutils.file_kind_from_stat_mode(root_stat.st_mode), root_stat,
 
3176
                    root_abspath)
 
3177
                if root_dir_info[2] == 'directory':
 
3178
                    if self.tree._directory_is_tree_reference(
 
3179
                        current_root.decode('utf8')):
 
3180
                        root_dir_info = root_dir_info[:2] + \
 
3181
                            ('tree-reference',) + root_dir_info[3:]
 
3182
 
 
3183
            if not root_entries and not root_dir_info:
 
3184
                # this specified path is not present at all, skip it.
 
3185
                continue
 
3186
            path_handled = False
 
3187
            for entry in root_entries:
 
3188
                result = _process_entry(entry, root_dir_info)
 
3189
                if result is not None:
 
3190
                    path_handled = True
 
3191
                    if result is not uninteresting:
 
3192
                        yield result
 
3193
            if self.want_unversioned and not path_handled and root_dir_info:
 
3194
                new_executable = bool(
 
3195
                    stat.S_ISREG(root_dir_info[3].st_mode)
 
3196
                    and stat.S_IEXEC & root_dir_info[3].st_mode)
 
3197
                yield (None,
 
3198
                       (None, current_root_unicode),
 
3199
                       True,
 
3200
                       (False, False),
 
3201
                       (None, None),
 
3202
                       (None, splitpath(current_root_unicode)[-1]),
 
3203
                       (None, root_dir_info[2]),
 
3204
                       (None, new_executable)
 
3205
                      )
 
3206
            initial_key = (current_root, '', '')
 
3207
            block_index, _ = self.state._find_block_index_from_key(initial_key)
 
3208
            if block_index == 0:
 
3209
                # we have processed the total root already, but because the
 
3210
                # initial key matched it we should skip it here.
 
3211
                block_index +=1
 
3212
            if root_dir_info and root_dir_info[2] == 'tree-reference':
 
3213
                current_dir_info = None
 
3214
            else:
 
3215
                dir_iterator = osutils._walkdirs_utf8(root_abspath, prefix=current_root)
 
3216
                try:
 
3217
                    current_dir_info = dir_iterator.next()
 
3218
                except OSError, e:
 
3219
                    # on win32, python2.4 has e.errno == ERROR_DIRECTORY, but
 
3220
                    # python 2.5 has e.errno == EINVAL,
 
3221
                    #            and e.winerror == ERROR_DIRECTORY
 
3222
                    e_winerror = getattr(e, 'winerror', None)
 
3223
                    win_errors = (ERROR_DIRECTORY, ERROR_PATH_NOT_FOUND)
 
3224
                    # there may be directories in the inventory even though
 
3225
                    # this path is not a file on disk: so mark it as end of
 
3226
                    # iterator
 
3227
                    if e.errno in (errno.ENOENT, errno.ENOTDIR, errno.EINVAL):
 
3228
                        current_dir_info = None
 
3229
                    elif (sys.platform == 'win32'
 
3230
                          and (e.errno in win_errors
 
3231
                               or e_winerror in win_errors)):
 
3232
                        current_dir_info = None
 
3233
                    else:
 
3234
                        raise
 
3235
                else:
 
3236
                    if current_dir_info[0][0] == '':
 
3237
                        # remove .bzr from iteration
 
3238
                        bzr_index = bisect.bisect_left(current_dir_info[1], ('.bzr',))
 
3239
                        if current_dir_info[1][bzr_index][0] != '.bzr':
 
3240
                            raise AssertionError()
 
3241
                        del current_dir_info[1][bzr_index]
 
3242
            # walk until both the directory listing and the versioned metadata
 
3243
            # are exhausted. 
 
3244
            if (block_index < len(self.state._dirblocks) and
 
3245
                osutils.is_inside(current_root, self.state._dirblocks[block_index][0])):
 
3246
                current_block = self.state._dirblocks[block_index]
 
3247
            else:
 
3248
                current_block = None
 
3249
            while (current_dir_info is not None or
 
3250
                   current_block is not None):
 
3251
                if (current_dir_info and current_block
 
3252
                    and current_dir_info[0][0] != current_block[0]):
 
3253
                    if _cmp_by_dirs(current_dir_info[0][0], current_block[0]) < 0:
 
3254
                        # filesystem data refers to paths not covered by the dirblock.
 
3255
                        # this has two possibilities:
 
3256
                        # A) it is versioned but empty, so there is no block for it
 
3257
                        # B) it is not versioned.
 
3258
 
 
3259
                        # if (A) then we need to recurse into it to check for
 
3260
                        # new unknown files or directories.
 
3261
                        # if (B) then we should ignore it, because we don't
 
3262
                        # recurse into unknown directories.
 
3263
                        path_index = 0
 
3264
                        while path_index < len(current_dir_info[1]):
 
3265
                                current_path_info = current_dir_info[1][path_index]
 
3266
                                if self.want_unversioned:
 
3267
                                    if current_path_info[2] == 'directory':
 
3268
                                        if self.tree._directory_is_tree_reference(
 
3269
                                            current_path_info[0].decode('utf8')):
 
3270
                                            current_path_info = current_path_info[:2] + \
 
3271
                                                ('tree-reference',) + current_path_info[3:]
 
3272
                                    new_executable = bool(
 
3273
                                        stat.S_ISREG(current_path_info[3].st_mode)
 
3274
                                        and stat.S_IEXEC & current_path_info[3].st_mode)
 
3275
                                    yield (None,
 
3276
                                        (None, utf8_decode(current_path_info[0])[0]),
 
3277
                                        True,
 
3278
                                        (False, False),
 
3279
                                        (None, None),
 
3280
                                        (None, utf8_decode(current_path_info[1])[0]),
 
3281
                                        (None, current_path_info[2]),
 
3282
                                        (None, new_executable))
 
3283
                                # dont descend into this unversioned path if it is
 
3284
                                # a dir
 
3285
                                if current_path_info[2] in ('directory',
 
3286
                                                            'tree-reference'):
 
3287
                                    del current_dir_info[1][path_index]
 
3288
                                    path_index -= 1
 
3289
                                path_index += 1
 
3290
 
 
3291
                        # This dir info has been handled, go to the next
 
3292
                        try:
 
3293
                            current_dir_info = dir_iterator.next()
 
3294
                        except StopIteration:
 
3295
                            current_dir_info = None
 
3296
                    else:
 
3297
                        # We have a dirblock entry for this location, but there
 
3298
                        # is no filesystem path for this. This is most likely
 
3299
                        # because a directory was removed from the disk.
 
3300
                        # We don't have to report the missing directory,
 
3301
                        # because that should have already been handled, but we
 
3302
                        # need to handle all of the files that are contained
 
3303
                        # within.
 
3304
                        for current_entry in current_block[1]:
 
3305
                            # entry referring to file not present on disk.
 
3306
                            # advance the entry only, after processing.
 
3307
                            result = _process_entry(current_entry, None)
 
3308
                            if result is not None:
 
3309
                                if result is not uninteresting:
 
3310
                                    yield result
 
3311
                        block_index +=1
 
3312
                        if (block_index < len(self.state._dirblocks) and
 
3313
                            osutils.is_inside(current_root,
 
3314
                                              self.state._dirblocks[block_index][0])):
 
3315
                            current_block = self.state._dirblocks[block_index]
 
3316
                        else:
 
3317
                            current_block = None
 
3318
                    continue
 
3319
                entry_index = 0
 
3320
                if current_block and entry_index < len(current_block[1]):
 
3321
                    current_entry = current_block[1][entry_index]
 
3322
                else:
 
3323
                    current_entry = None
 
3324
                advance_entry = True
 
3325
                path_index = 0
 
3326
                if current_dir_info and path_index < len(current_dir_info[1]):
 
3327
                    current_path_info = current_dir_info[1][path_index]
 
3328
                    if current_path_info[2] == 'directory':
 
3329
                        if self.tree._directory_is_tree_reference(
 
3330
                            current_path_info[0].decode('utf8')):
 
3331
                            current_path_info = current_path_info[:2] + \
 
3332
                                ('tree-reference',) + current_path_info[3:]
 
3333
                else:
 
3334
                    current_path_info = None
 
3335
                advance_path = True
 
3336
                path_handled = False
 
3337
                while (current_entry is not None or
 
3338
                    current_path_info is not None):
 
3339
                    if current_entry is None:
 
3340
                        # the check for path_handled when the path is adnvaced
 
3341
                        # will yield this path if needed.
 
3342
                        pass
 
3343
                    elif current_path_info is None:
 
3344
                        # no path is fine: the per entry code will handle it.
 
3345
                        result = _process_entry(current_entry, current_path_info)
 
3346
                        if result is not None:
 
3347
                            if result is not uninteresting:
 
3348
                                yield result
 
3349
                    elif (current_entry[0][1] != current_path_info[1]
 
3350
                          or current_entry[1][self.target_index][0] in 'ar'):
 
3351
                        # The current path on disk doesn't match the dirblock
 
3352
                        # record. Either the dirblock is marked as absent, or
 
3353
                        # the file on disk is not present at all in the
 
3354
                        # dirblock. Either way, report about the dirblock
 
3355
                        # entry, and let other code handle the filesystem one.
 
3356
 
 
3357
                        # Compare the basename for these files to determine
 
3358
                        # which comes first
 
3359
                        if current_path_info[1] < current_entry[0][1]:
 
3360
                            # extra file on disk: pass for now, but only
 
3361
                            # increment the path, not the entry
 
3362
                            advance_entry = False
 
3363
                        else:
 
3364
                            # entry referring to file not present on disk.
 
3365
                            # advance the entry only, after processing.
 
3366
                            result = _process_entry(current_entry, None)
 
3367
                            if result is not None:
 
3368
                                if result is not uninteresting:
 
3369
                                    yield result
 
3370
                            advance_path = False
 
3371
                    else:
 
3372
                        result = _process_entry(current_entry, current_path_info)
 
3373
                        if result is not None:
 
3374
                            path_handled = True
 
3375
                            if result is not uninteresting:
 
3376
                                yield result
 
3377
                    if advance_entry and current_entry is not None:
 
3378
                        entry_index += 1
 
3379
                        if entry_index < len(current_block[1]):
 
3380
                            current_entry = current_block[1][entry_index]
 
3381
                        else:
 
3382
                            current_entry = None
 
3383
                    else:
 
3384
                        advance_entry = True # reset the advance flaga
 
3385
                    if advance_path and current_path_info is not None:
 
3386
                        if not path_handled:
 
3387
                            # unversioned in all regards
 
3388
                            if self.want_unversioned:
 
3389
                                new_executable = bool(
 
3390
                                    stat.S_ISREG(current_path_info[3].st_mode)
 
3391
                                    and stat.S_IEXEC & current_path_info[3].st_mode)
 
3392
                                try:
 
3393
                                    relpath_unicode = utf8_decode(current_path_info[0])[0]
 
3394
                                except UnicodeDecodeError:
 
3395
                                    raise errors.BadFilenameEncoding(
 
3396
                                        current_path_info[0], osutils._fs_enc)
 
3397
                                yield (None,
 
3398
                                    (None, relpath_unicode),
 
3399
                                    True,
 
3400
                                    (False, False),
 
3401
                                    (None, None),
 
3402
                                    (None, utf8_decode(current_path_info[1])[0]),
 
3403
                                    (None, current_path_info[2]),
 
3404
                                    (None, new_executable))
 
3405
                            # dont descend into this unversioned path if it is
 
3406
                            # a dir
 
3407
                            if current_path_info[2] in ('directory'):
 
3408
                                del current_dir_info[1][path_index]
 
3409
                                path_index -= 1
 
3410
                        # dont descend the disk iterator into any tree 
 
3411
                        # paths.
 
3412
                        if current_path_info[2] == 'tree-reference':
 
3413
                            del current_dir_info[1][path_index]
 
3414
                            path_index -= 1
 
3415
                        path_index += 1
 
3416
                        if path_index < len(current_dir_info[1]):
 
3417
                            current_path_info = current_dir_info[1][path_index]
 
3418
                            if current_path_info[2] == 'directory':
 
3419
                                if self.tree._directory_is_tree_reference(
 
3420
                                    current_path_info[0].decode('utf8')):
 
3421
                                    current_path_info = current_path_info[:2] + \
 
3422
                                        ('tree-reference',) + current_path_info[3:]
 
3423
                        else:
 
3424
                            current_path_info = None
 
3425
                        path_handled = False
 
3426
                    else:
 
3427
                        advance_path = True # reset the advance flagg.
 
3428
                if current_block is not None:
 
3429
                    block_index += 1
 
3430
                    if (block_index < len(self.state._dirblocks) and
 
3431
                        osutils.is_inside(current_root, self.state._dirblocks[block_index][0])):
 
3432
                        current_block = self.state._dirblocks[block_index]
 
3433
                    else:
 
3434
                        current_block = None
 
3435
                if current_dir_info is not None:
 
3436
                    try:
 
3437
                        current_dir_info = dir_iterator.next()
 
3438
                    except StopIteration:
 
3439
                        current_dir_info = None
 
3440
_process_entry = ProcessEntryPython
 
3441
 
 
3442
 
 
3443
# Try to load the compiled form if possible
 
3444
try:
 
3445
    from bzrlib._dirstate_helpers_c import (
 
3446
        _read_dirblocks_c as _read_dirblocks,
 
3447
        bisect_dirblock_c as bisect_dirblock,
 
3448
        _bisect_path_left_c as _bisect_path_left,
 
3449
        _bisect_path_right_c as _bisect_path_right,
 
3450
        cmp_by_dirs_c as cmp_by_dirs,
 
3451
        ProcessEntryC as _process_entry,
 
3452
        update_entry as update_entry,
 
3453
        )
 
3454
except ImportError:
 
3455
    from bzrlib._dirstate_helpers_py import (
 
3456
        _read_dirblocks_py as _read_dirblocks,
 
3457
        bisect_dirblock_py as bisect_dirblock,
 
3458
        _bisect_path_left_py as _bisect_path_left,
 
3459
        _bisect_path_right_py as _bisect_path_right,
 
3460
        cmp_by_dirs_py as cmp_by_dirs,
 
3461
        )