~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/dirstate.py

  • Committer: Patch Queue Manager
  • Date: 2014-02-12 18:22:22 UTC
  • mfrom: (6589.2.1 trunk)
  • Revision ID: pqm@pqm.ubuntu.com-20140212182222-beouo25gaf1cny76
(vila) The XDG Base Directory Specification uses the XDG_CACHE_HOME,
 not XDG_CACHE_DIR. (Andrew Starr-Bochicchio)

Show diffs side-by-side

added added

removed removed

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