~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/dirstate.py

  • Committer: Ian Clatworthy
  • Date: 2007-08-13 14:16:53 UTC
  • mto: (2733.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 2734.
  • Revision ID: ian.clatworthy@internode.on.net-20070813141653-3cbrp00xowq58zv1
Added mini tutorial

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006, 2007, 2008 Canonical Ltd
 
1
# Copyright (C) 2006, 2007 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""DirState objects record the state of a directory and its bzr metadata.
18
18
 
29
29
 
30
30
dirstate format = header line, full checksum, row count, parent details,
31
31
 ghost_details, entries;
32
 
header line = "#bazaar dirstate flat format 3", NL;
 
32
header line = "#bazaar dirstate flat format 2", NL;
33
33
full checksum = "crc32: ", ["-"], WHOLE_NUMBER, NL;
34
 
row count = "num_entries: ", WHOLE_NUMBER, NL;
 
34
row count = "num_entries: ", digit, NL;
35
35
parent_details = WHOLE NUMBER, {REVISION_ID}* NL;
36
36
ghost_details = WHOLE NUMBER, {REVISION_ID}*, NL;
37
37
entries = {entry};
82
82
'a' is an absent entry: In that tree the id is not present at this path.
83
83
'd' is a directory entry: This path in this tree is a directory with the
84
84
    current file id. There is no fingerprint for directories.
85
 
'f' is a file entry: As for directory, but it's a file. The fingerprint is the
86
 
    sha1 value of the file's canonical form, i.e. after any read filters have
87
 
    been applied to the convenience form stored in the working tree.
 
85
'f' is a file entry: As for directory, but its a file. The fingerprint is a
 
86
    sha1 value.
88
87
'l' is a symlink entry: As for directory, but a symlink. The fingerprint is the
89
88
    link target.
90
89
't' is a reference to a nested subtree; the fingerprint is the referenced
100
99
 
101
100
--- Format 1 had the following different definition: ---
102
101
rows = dirname, NULL, basename, NULL, MINIKIND, NULL, fileid_utf8, NULL,
103
 
    WHOLE NUMBER (* size *), NULL, packed stat, NULL, sha1|symlink target,
 
102
    WHOLE NUMBER (* size *), NULL, packed stat, NULL, sha1|symlink target, 
104
103
    {PARENT ROW}
105
104
PARENT ROW = NULL, revision_utf8, NULL, MINIKIND, NULL, dirname, NULL,
106
105
    basename, NULL, WHOLE NUMBER (* size *), NULL, "y" | "n", NULL,
119
118
where we need id->path mapping; we also usually read the whole file, so
120
119
I'm going to skip that for the moment, as we have the ability to locate
121
120
via bisect any path in any tree, and if we lookup things by path, we can
122
 
accumulate an id->path mapping as we go, which will tend to match what we
 
121
accumulate a id->path mapping as we go, which will tend to match what we
123
122
looked for.
124
123
 
125
124
I plan to implement this asap, so please speak up now to alter/tweak the
131
130
operations for the less common but still occurs a lot status/diff/commit
132
131
on specific files). Operations on specific files involve a scan for all
133
132
the children of a path, *in every involved tree*, which the current
134
 
format did not accommodate.
 
133
format did not accommodate. 
135
134
----
136
135
 
137
136
Design priorities:
144
143
Locking:
145
144
 Eventually reuse dirstate objects across locks IFF the dirstate file has not
146
145
 been modified, but will require that we flush/ignore cached stat-hit data
147
 
 because we won't want to restat all files on disk just because a lock was
 
146
 because we wont want to restat all files on disk just because a lock was
148
147
 acquired, yet we cannot trust the data after the previous lock was released.
149
148
 
150
149
Memory representation:
151
150
 vector of all directories, and vector of the childen ?
152
 
   i.e.
153
 
     root_entrie = (direntry for root, [parent_direntries_for_root]),
 
151
   i.e. 
 
152
     root_entrie = (direntry for root, [parent_direntries_for_root]), 
154
153
     dirblocks = [
155
154
     ('', ['data for achild', 'data for bchild', 'data for cchild'])
156
155
     ('dir', ['achild', 'cchild', 'echild'])
159
158
    - in-order for serialisation - this is 'dirblock' grouping.
160
159
    - insertion of a file '/a' affects only the '/' child-vector, that is, to
161
160
      insert 10K elements from scratch does not generates O(N^2) memoves of a
162
 
      single vector, rather each individual, which tends to be limited to a
163
 
      manageable number. Will scale badly on trees with 10K entries in a
 
161
      single vector, rather each individual, which tends to be limited to a 
 
162
      manageable number. Will scale badly on trees with 10K entries in a 
164
163
      single directory. compare with Inventory.InventoryDirectory which has
165
164
      a dictionary for the children. No bisect capability, can only probe for
166
 
      exact matches, or grab all elements and sort.
167
 
    - What's the risk of error here? Once we have the base format being processed
168
 
      we should have a net win regardless of optimality. So we are going to
169
 
      go with what seems reasonable.
 
165
      exact matches, or grab all elements and sorta.
 
166
    - Whats the risk of error here? Once we have the base format being processed
 
167
      we should have a net win regardless of optimality. So we are going to 
 
168
      go with what seems reasonably.
170
169
open questions:
171
170
 
172
 
Maybe we should do a test profile of the core structure - 10K simulated
173
 
searches/lookups/etc?
 
171
maybe we should do a test profile of these core structure - 10K simulated searches/lookups/etc?
174
172
 
175
173
Objects for each row?
176
174
The lifetime of Dirstate objects is current per lock, but see above for
187
185
the file on disk, and then immediately discard, the overhead of object creation
188
186
becomes a significant cost.
189
187
 
190
 
Figures: Creating a tuple from 3 elements was profiled at 0.0625
 
188
Figures: Creating a tuple from from 3 elements was profiled at 0.0625
191
189
microseconds, whereas creating a object which is subclassed from tuple was
192
190
0.500 microseconds, and creating an object with 3 elements and slots was 3
193
191
microseconds long. 0.1 milliseconds is 100 microseconds, and ideally we'll get
204
202
import bisect
205
203
import binascii
206
204
import errno
207
 
import operator
208
205
import os
209
206
from stat import S_IEXEC
210
207
import stat
214
211
import zlib
215
212
 
216
213
from bzrlib import (
217
 
    cache_utf8,
218
 
    debug,
219
214
    errors,
220
215
    inventory,
221
216
    lock,
224
219
    )
225
220
 
226
221
 
227
 
# This is the Windows equivalent of ENOTDIR
228
 
# It is defined in pywin32.winerror, but we don't want a strong dependency for
229
 
# just an error code.
230
 
ERROR_PATH_NOT_FOUND = 3
231
 
ERROR_DIRECTORY = 267
232
 
 
233
 
 
234
 
if not getattr(struct, '_compile', None):
235
 
    # Cannot pre-compile the dirstate pack_stat
236
 
    def pack_stat(st, _encode=binascii.b2a_base64, _pack=struct.pack):
237
 
        """Convert stat values into a packed representation."""
238
 
        return _encode(_pack('>LLLLLL', st.st_size, int(st.st_mtime),
239
 
            int(st.st_ctime), st.st_dev, st.st_ino & 0xFFFFFFFF,
240
 
            st.st_mode))[:-1]
241
 
else:
242
 
    # compile the struct compiler we need, so as to only do it once
243
 
    from _struct import Struct
244
 
    _compiled_pack = Struct('>LLLLLL').pack
245
 
    def pack_stat(st, _encode=binascii.b2a_base64, _pack=_compiled_pack):
246
 
        """Convert stat values into a packed representation."""
247
 
        # jam 20060614 it isn't really worth removing more entries if we
248
 
        # are going to leave it in packed form.
249
 
        # With only st_mtime and st_mode filesize is 5.5M and read time is 275ms
250
 
        # With all entries, filesize is 5.9M and read time is maybe 280ms
251
 
        # well within the noise margin
252
 
 
253
 
        # base64 encoding always adds a final newline, so strip it off
254
 
        # The current version
255
 
        return _encode(_pack(st.st_size, int(st.st_mtime), int(st.st_ctime),
256
 
            st.st_dev, st.st_ino & 0xFFFFFFFF, st.st_mode))[:-1]
257
 
        # This is 0.060s / 1.520s faster by not encoding as much information
258
 
        # return _encode(_pack('>LL', int(st.st_mtime), st.st_mode))[:-1]
259
 
        # This is not strictly faster than _encode(_pack())[:-1]
260
 
        # return '%X.%X.%X.%X.%X.%X' % (
261
 
        #      st.st_size, int(st.st_mtime), int(st.st_ctime),
262
 
        #      st.st_dev, st.st_ino, st.st_mode)
263
 
        # Similar to the _encode(_pack('>LL'))
264
 
        # return '%X.%X' % (int(st.st_mtime), st.st_mode)
265
 
 
266
 
 
267
 
class SHA1Provider(object):
268
 
    """An interface for getting sha1s of a file."""
269
 
 
270
 
    def sha1(self, abspath):
271
 
        """Return the sha1 of a file given its absolute path.
272
 
 
273
 
        :param abspath:  May be a filesystem encoded absolute path
274
 
             or a unicode path.
275
 
        """
276
 
        raise NotImplementedError(self.sha1)
277
 
 
278
 
    def stat_and_sha1(self, abspath):
279
 
        """Return the stat and sha1 of a file given its absolute path.
280
 
        
281
 
        :param abspath:  May be a filesystem encoded absolute path
282
 
             or a unicode path.
283
 
 
284
 
        Note: the stat should be the stat of the physical file
285
 
        while the sha may be the sha of its canonical content.
286
 
        """
287
 
        raise NotImplementedError(self.stat_and_sha1)
288
 
 
289
 
 
290
 
class DefaultSHA1Provider(SHA1Provider):
291
 
    """A SHA1Provider that reads directly from the filesystem."""
292
 
 
293
 
    def sha1(self, abspath):
294
 
        """Return the sha1 of a file given its absolute path."""
295
 
        return osutils.sha_file_by_name(abspath)
296
 
 
297
 
    def stat_and_sha1(self, abspath):
298
 
        """Return the stat and sha1 of a file given its absolute path."""
299
 
        file_obj = file(abspath, 'rb')
300
 
        try:
301
 
            statvalue = os.fstat(file_obj.fileno())
302
 
            sha1 = osutils.sha_file(file_obj)
303
 
        finally:
304
 
            file_obj.close()
305
 
        return statvalue, sha1
 
222
def pack_stat(st, _encode=binascii.b2a_base64, _pack=struct.pack):
 
223
    """Convert stat values into a packed representation."""
 
224
    # jam 20060614 it isn't really worth removing more entries if we
 
225
    # are going to leave it in packed form.
 
226
    # With only st_mtime and st_mode filesize is 5.5M and read time is 275ms
 
227
    # With all entries filesize is 5.9M and read time is mabye 280ms
 
228
    # well within the noise margin
 
229
 
 
230
    # base64 encoding always adds a final newline, so strip it off
 
231
    # The current version
 
232
    return _encode(_pack('>LLLLLL'
 
233
        , st.st_size, int(st.st_mtime), int(st.st_ctime)
 
234
        , st.st_dev, st.st_ino & 0xFFFFFFFF, st.st_mode))[:-1]
 
235
    # This is 0.060s / 1.520s faster by not encoding as much information
 
236
    # return _encode(_pack('>LL', int(st.st_mtime), st.st_mode))[:-1]
 
237
    # This is not strictly faster than _encode(_pack())[:-1]
 
238
    # return '%X.%X.%X.%X.%X.%X' % (
 
239
    #      st.st_size, int(st.st_mtime), int(st.st_ctime),
 
240
    #      st.st_dev, st.st_ino, st.st_mode)
 
241
    # Similar to the _encode(_pack('>LL'))
 
242
    # return '%X.%X' % (int(st.st_mtime), st.st_mode)
306
243
 
307
244
 
308
245
class DirState(object):
310
247
 
311
248
    A dirstate is a specialised data structure for managing local working
312
249
    tree state information. Its not yet well defined whether it is platform
313
 
    specific, and if it is how we detect/parameterize that.
 
250
    specific, and if it is how we detect/parameterise that.
314
251
 
315
252
    Dirstates use the usual lock_write, lock_read and unlock mechanisms.
316
253
    Unlike most bzr disk formats, DirStates must be locked for reading, using
363
300
    HEADER_FORMAT_2 = '#bazaar dirstate flat format 2\n'
364
301
    HEADER_FORMAT_3 = '#bazaar dirstate flat format 3\n'
365
302
 
366
 
    def __init__(self, path, sha1_provider):
 
303
    def __init__(self, path):
367
304
        """Create a  DirState object.
368
305
 
 
306
        Attributes of note:
 
307
 
 
308
        :attr _root_entrie: The root row of the directory/file information,
 
309
            - contains the path to / - '', ''
 
310
            - kind of 'directory',
 
311
            - the file id of the root in utf8
 
312
            - size of 0
 
313
            - a packed state
 
314
            - and no sha information.
369
315
        :param path: The path at which the dirstate file on disk should live.
370
 
        :param sha1_provider: an object meeting the SHA1Provider interface.
371
316
        """
372
317
        # _header_state and _dirblock_state represent the current state
373
318
        # of the dirstate metadata and the per-row data respectiely.
375
320
        # IN_MEMORY_UNMODIFIED indicates that what we have in memory
376
321
        #   is the same as is on disk
377
322
        # IN_MEMORY_MODIFIED indicates that we have a modified version
378
 
        #   of what is on disk.
 
323
        #   of what is on disk. 
379
324
        # In future we will add more granularity, for instance _dirblock_state
380
325
        # will probably support partially-in-memory as a separate variable,
381
326
        # allowing for partially-in-memory unmodified and partially-in-memory
382
327
        # modified states.
383
328
        self._header_state = DirState.NOT_IN_MEMORY
384
329
        self._dirblock_state = DirState.NOT_IN_MEMORY
385
 
        # If true, an error has been detected while updating the dirstate, and
386
 
        # for safety we're not going to commit to disk.
387
 
        self._changes_aborted = False
388
330
        self._dirblocks = []
389
331
        self._ghosts = []
390
332
        self._parents = []
393
335
        self._lock_token = None
394
336
        self._lock_state = None
395
337
        self._id_index = None
396
 
        # a map from packed_stat to sha's.
397
 
        self._packed_stat_index = None
398
338
        self._end_of_header = None
399
339
        self._cutoff_time = None
400
340
        self._split_path_cache = {}
401
341
        self._bisect_page_size = DirState.BISECT_PAGE_SIZE
402
 
        self._sha1_provider = sha1_provider
403
 
        if 'hashcache' in debug.debug_flags:
404
 
            self._sha1_file = self._sha1_file_and_mutter
405
 
        else:
406
 
            self._sha1_file = self._sha1_provider.sha1
407
 
        # These two attributes provide a simple cache for lookups into the
408
 
        # dirstate in-memory vectors. By probing respectively for the last
409
 
        # block, and for the next entry, we save nearly 2 bisections per path
410
 
        # during commit.
411
 
        self._last_block_index = None
412
 
        self._last_entry_index = None
413
342
 
414
343
    def __repr__(self):
415
344
        return "%s(%r)" % \
419
348
        """Add a path to be tracked.
420
349
 
421
350
        :param path: The path within the dirstate - '' is the root, 'foo' is the
422
 
            path foo within the root, 'foo/bar' is the path bar within foo
 
351
            path foo within the root, 'foo/bar' is the path bar within foo 
423
352
            within the root.
424
353
        :param file_id: The file id of the path being added.
425
 
        :param kind: The kind of the path, as a string like 'file',
 
354
        :param kind: The kind of the path, as a string like 'file', 
426
355
            'directory', etc.
427
356
        :param stat: The output of os.lstat for the path.
428
 
        :param fingerprint: The sha value of the file's canonical form (i.e.
429
 
            after any read filters have been applied),
 
357
        :param fingerprint: The sha value of the file,
430
358
            or the target of a symlink,
431
359
            or the referenced revision id for tree-references,
432
360
            or '' for directories.
433
361
        """
434
362
        # adding a file:
435
 
        # find the block its in.
 
363
        # find the block its in. 
436
364
        # find the location in the block.
437
365
        # check its not there
438
366
        # add it.
439
 
        #------- copied from inventory.ensure_normalized_name - keep synced.
 
367
        #------- copied from inventory.make_entry
440
368
        # --- normalized_filename wants a unicode basename only, so get one.
441
369
        dirname, basename = osutils.split(path)
442
370
        # we dont import normalized_filename directly because we want to be
451
379
        # in the parent, or according to the special treatment for the root
452
380
        if basename == '.' or basename == '..':
453
381
            raise errors.InvalidEntryName(path)
454
 
        # now that we've normalised, we need the correct utf8 path and
 
382
        # now that we've normalised, we need the correct utf8 path and 
455
383
        # dirname and basename elements. This single encode and split should be
456
384
        # faster than three separate encodes.
457
385
        utf8path = (dirname + '/' + basename).strip('/').encode('utf8')
458
386
        dirname, basename = osutils.split(utf8path)
459
 
        # uses __class__ for speed; the check is needed for safety
460
 
        if file_id.__class__ is not str:
461
 
            raise AssertionError(
462
 
                "must be a utf8 file_id not %s" % (type(file_id), ))
 
387
        assert file_id.__class__ == str, \
 
388
            "must be a utf8 file_id not %s" % (type(file_id))
463
389
        # Make sure the file_id does not exist in this tree
464
 
        rename_from = None
465
 
        file_id_entry = self._get_entry(0, fileid_utf8=file_id, include_deleted=True)
 
390
        file_id_entry = self._get_entry(0, fileid_utf8=file_id)
466
391
        if file_id_entry != (None, None):
467
 
            if file_id_entry[1][0][0] == 'a':
468
 
                if file_id_entry[0] != (dirname, basename, file_id):
469
 
                    # set the old name's current operation to rename
470
 
                    self.update_minimal(file_id_entry[0],
471
 
                        'r',
472
 
                        path_utf8='',
473
 
                        packed_stat='',
474
 
                        fingerprint=utf8path
475
 
                    )
476
 
                    rename_from = file_id_entry[0][0:2]
477
 
            else:
478
 
                path = osutils.pathjoin(file_id_entry[0][0], file_id_entry[0][1])
479
 
                kind = DirState._minikind_to_kind[file_id_entry[1][0][0]]
480
 
                info = '%s:%s' % (kind, path)
481
 
                raise errors.DuplicateFileId(file_id, info)
 
392
            path = osutils.pathjoin(file_id_entry[0][0], file_id_entry[0][1])
 
393
            kind = DirState._minikind_to_kind[file_id_entry[1][0][0]]
 
394
            info = '%s:%s' % (kind, path)
 
395
            raise errors.DuplicateFileId(file_id, info)
482
396
        first_key = (dirname, basename, '')
483
397
        block_index, present = self._find_block_index_from_key(first_key)
484
398
        if present:
485
399
            # check the path is not in the tree
486
400
            block = self._dirblocks[block_index][1]
487
401
            entry_index, _ = self._find_entry_index(first_key, block)
488
 
            while (entry_index < len(block) and
 
402
            while (entry_index < len(block) and 
489
403
                block[entry_index][0][0:2] == first_key[0:2]):
490
404
                if block[entry_index][1][0][0] not in 'ar':
491
405
                    # this path is in the dirstate in the current tree.
511
425
            packed_stat = pack_stat(stat)
512
426
        parent_info = self._empty_parent_info()
513
427
        minikind = DirState._kind_to_minikind[kind]
514
 
        if rename_from is not None:
515
 
            if rename_from[0]:
516
 
                old_path_utf8 = '%s/%s' % rename_from
517
 
            else:
518
 
                old_path_utf8 = rename_from[1]
519
 
            parent_info[0] = ('r', old_path_utf8, 0, False, '')
520
428
        if kind == 'file':
521
429
            entry_data = entry_key, [
522
430
                (minikind, fingerprint, size, False, packed_stat),
539
447
        if not present:
540
448
            block.insert(entry_index, entry_data)
541
449
        else:
542
 
            if block[entry_index][1][0][0] != 'a':
543
 
                raise AssertionError(" %r(%r) already added" % (basename, file_id))
 
450
            assert block[entry_index][1][0][0] == 'a', " %r(%r) already added" % (basename, file_id)
544
451
            block[entry_index][1][0] = entry_data[1][0]
545
452
 
546
453
        if kind == 'directory':
565
472
        # If _dirblock_state was in memory, we should just return info from
566
473
        # there, this function is only meant to handle when we want to read
567
474
        # part of the disk.
568
 
        if self._dirblock_state != DirState.NOT_IN_MEMORY:
569
 
            raise AssertionError("bad dirblock state %r" % self._dirblock_state)
 
475
        assert self._dirblock_state == DirState.NOT_IN_MEMORY
570
476
 
571
477
        # The disk representation is generally info + '\0\n\0' at the end. But
572
478
        # for bisecting, it is easier to treat this as '\0' + info + '\0\n'
745
651
        _bisect_dirblocks is meant to find the contents of directories, which
746
652
        differs from _bisect, which only finds individual entries.
747
653
 
748
 
        :param dir_list: A sorted list of directory names ['', 'dir', 'foo'].
 
654
        :param dir_list: An sorted list of directory names ['', 'dir', 'foo'].
749
655
        :return: A map from dir => entries_for_dir
750
656
        """
751
657
        # TODO: jam 20070223 A lot of the bisecting logic could be shared
758
664
        # If _dirblock_state was in memory, we should just return info from
759
665
        # there, this function is only meant to handle when we want to read
760
666
        # part of the disk.
761
 
        if self._dirblock_state != DirState.NOT_IN_MEMORY:
762
 
            raise AssertionError("bad dirblock state %r" % self._dirblock_state)
 
667
        assert self._dirblock_state == DirState.NOT_IN_MEMORY
 
668
 
763
669
        # The disk representation is generally info + '\0\n\0' at the end. But
764
670
        # for bisecting, it is easier to treat this as '\0' + info + '\0\n'
765
671
        # Because it means we can sync on the '\n'
979
885
            processed_dirs.update(pending_dirs)
980
886
        return found
981
887
 
982
 
    def _discard_merge_parents(self):
983
 
        """Discard any parents trees beyond the first.
984
 
 
985
 
        Note that if this fails the dirstate is corrupted.
986
 
 
987
 
        After this function returns the dirstate contains 2 trees, neither of
988
 
        which are ghosted.
989
 
        """
990
 
        self._read_header_if_needed()
991
 
        parents = self.get_parent_ids()
992
 
        if len(parents) < 1:
993
 
            return
994
 
        # only require all dirblocks if we are doing a full-pass removal.
995
 
        self._read_dirblocks_if_needed()
996
 
        dead_patterns = set([('a', 'r'), ('a', 'a'), ('r', 'r'), ('r', 'a')])
997
 
        def iter_entries_removable():
998
 
            for block in self._dirblocks:
999
 
                deleted_positions = []
1000
 
                for pos, entry in enumerate(block[1]):
1001
 
                    yield entry
1002
 
                    if (entry[1][0][0], entry[1][1][0]) in dead_patterns:
1003
 
                        deleted_positions.append(pos)
1004
 
                if deleted_positions:
1005
 
                    if len(deleted_positions) == len(block[1]):
1006
 
                        del block[1][:]
1007
 
                    else:
1008
 
                        for pos in reversed(deleted_positions):
1009
 
                            del block[1][pos]
1010
 
        # if the first parent is a ghost:
1011
 
        if parents[0] in self.get_ghosts():
1012
 
            empty_parent = [DirState.NULL_PARENT_DETAILS]
1013
 
            for entry in iter_entries_removable():
1014
 
                entry[1][1:] = empty_parent
1015
 
        else:
1016
 
            for entry in iter_entries_removable():
1017
 
                del entry[1][2:]
1018
 
 
1019
 
        self._ghosts = []
1020
 
        self._parents = [parents[0]]
1021
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
1022
 
        self._header_state = DirState.IN_MEMORY_MODIFIED
1023
 
 
1024
888
    def _empty_parent_info(self):
1025
889
        return [DirState.NULL_PARENT_DETAILS] * (len(self._parents) -
1026
890
                                                    len(self._ghosts))
1052
916
        # the basename of the directory must be the end of its full name.
1053
917
        if not (parent_block_index == -1 and
1054
918
            parent_block_index == -1 and dirname == ''):
1055
 
            if not dirname.endswith(
1056
 
                    self._dirblocks[parent_block_index][1][parent_row_index][0][1]):
1057
 
                raise AssertionError("bad dirname %r" % dirname)
 
919
            assert dirname.endswith(
 
920
                self._dirblocks[parent_block_index][1][parent_row_index][0][1])
1058
921
        block_index, present = self._find_block_index_from_key((dirname, '', ''))
1059
922
        if not present:
1060
 
            ## In future, when doing partial parsing, this should load and
 
923
            ## In future, when doing partial parsing, this should load and 
1061
924
            # populate the entire block.
1062
925
            self._dirblocks.insert(block_index, (dirname, []))
1063
926
        return block_index
1072
935
            to prevent unneeded overhead when callers have a sorted list already.
1073
936
        :return: Nothing.
1074
937
        """
1075
 
        if new_entries[0][0][0:2] != ('', ''):
1076
 
            raise AssertionError(
1077
 
                "Missing root row %r" % (new_entries[0][0],))
1078
 
        # The two blocks here are deliberate: the root block and the
 
938
        assert new_entries[0][0][0:2] == ('', ''), \
 
939
            "Missing root row %r" % (new_entries[0][0],)
 
940
        # The two blocks here are deliberate: the root block and the 
1079
941
        # contents-of-root block.
1080
942
        self._dirblocks = [('', []), ('', [])]
1081
943
        current_block = self._dirblocks[0][1]
1102
964
        # The above loop leaves the "root block" entries mixed with the
1103
965
        # "contents-of-root block". But we don't want an if check on
1104
966
        # all entries, so instead we just fix it up here.
1105
 
        if self._dirblocks[1] != ('', []):
1106
 
            raise ValueError("bad dirblock start %r" % (self._dirblocks[1],))
 
967
        assert self._dirblocks[1] == ('', [])
1107
968
        root_block = []
1108
969
        contents_of_root_block = []
1109
970
        for entry in self._dirblocks[0][1]:
1114
975
        self._dirblocks[0] = ('', root_block)
1115
976
        self._dirblocks[1] = ('', contents_of_root_block)
1116
977
 
1117
 
    def _entries_for_path(self, path):
1118
 
        """Return a list with all the entries that match path for all ids."""
1119
 
        dirname, basename = os.path.split(path)
1120
 
        key = (dirname, basename, '')
1121
 
        block_index, present = self._find_block_index_from_key(key)
1122
 
        if not present:
1123
 
            # the block which should contain path is absent.
1124
 
            return []
1125
 
        result = []
1126
 
        block = self._dirblocks[block_index][1]
1127
 
        entry_index, _ = self._find_entry_index(key, block)
1128
 
        # we may need to look at multiple entries at this path: walk while the specific_files match.
1129
 
        while (entry_index < len(block) and
1130
 
            block[entry_index][0][0:2] == key[0:2]):
1131
 
            result.append(block[entry_index])
1132
 
            entry_index += 1
1133
 
        return result
1134
 
 
1135
978
    def _entry_to_line(self, entry):
1136
979
        """Serialize entry to a NULL delimited line ready for _get_output_lines.
1137
980
 
1193
1036
        """
1194
1037
        if key[0:2] == ('', ''):
1195
1038
            return 0, True
1196
 
        try:
1197
 
            if (self._last_block_index is not None and
1198
 
                self._dirblocks[self._last_block_index][0] == key[0]):
1199
 
                return self._last_block_index, True
1200
 
        except IndexError:
1201
 
            pass
1202
1039
        block_index = bisect_dirblock(self._dirblocks, key[0], 1,
1203
1040
                                      cache=self._split_path_cache)
1204
1041
        # _right returns one-past-where-key is so we have to subtract
1205
1042
        # one to use it. we use _right here because there are two
1206
1043
        # '' blocks - the root, and the contents of root
1207
1044
        # we always have a minimum of 2 in self._dirblocks: root and
1208
 
        # root-contents, and for '', we get 2 back, so this is
 
1045
        # root-contents, and for '', we get 2 back, so this is 
1209
1046
        # simple and correct:
1210
1047
        present = (block_index < len(self._dirblocks) and
1211
1048
            self._dirblocks[block_index][0] == key[0])
1212
 
        self._last_block_index = block_index
1213
 
        # Reset the entry index cache to the beginning of the block.
1214
 
        self._last_entry_index = -1
1215
1049
        return block_index, present
1216
1050
 
1217
1051
    def _find_entry_index(self, key, block):
1219
1053
 
1220
1054
        :return: The entry index, True if the entry for the key is present.
1221
1055
        """
1222
 
        len_block = len(block)
1223
 
        try:
1224
 
            if self._last_entry_index is not None:
1225
 
                # mini-bisect here.
1226
 
                entry_index = self._last_entry_index + 1
1227
 
                # A hit is when the key is after the last slot, and before or
1228
 
                # equal to the next slot.
1229
 
                if ((entry_index > 0 and block[entry_index - 1][0] < key) and
1230
 
                    key <= block[entry_index][0]):
1231
 
                    self._last_entry_index = entry_index
1232
 
                    present = (block[entry_index][0] == key)
1233
 
                    return entry_index, present
1234
 
        except IndexError:
1235
 
            pass
1236
1056
        entry_index = bisect.bisect_left(block, (key, []))
1237
 
        present = (entry_index < len_block and
 
1057
        present = (entry_index < len(block) and
1238
1058
            block[entry_index][0] == key)
1239
 
        self._last_entry_index = entry_index
1240
1059
        return entry_index, present
1241
1060
 
1242
1061
    @staticmethod
1243
 
    def from_tree(tree, dir_state_filename, sha1_provider=None):
 
1062
    def from_tree(tree, dir_state_filename):
1244
1063
        """Create a dirstate from a bzr Tree.
1245
1064
 
1246
1065
        :param tree: The tree which should provide parent information and
1247
1066
            inventory ids.
1248
 
        :param sha1_provider: an object meeting the SHA1Provider interface.
1249
 
            If None, a DefaultSHA1Provider is used.
1250
1067
        :return: a DirState object which is currently locked for writing.
1251
1068
            (it was locked by DirState.initialize)
1252
1069
        """
1253
 
        result = DirState.initialize(dir_state_filename,
1254
 
            sha1_provider=sha1_provider)
 
1070
        result = DirState.initialize(dir_state_filename)
1255
1071
        try:
1256
1072
            tree.lock_read()
1257
1073
            try:
1275
1091
            raise
1276
1092
        return result
1277
1093
 
1278
 
    def update_by_delta(self, delta):
1279
 
        """Apply an inventory delta to the dirstate for tree 0
1280
 
 
1281
 
        This is the workhorse for apply_inventory_delta in dirstate based
1282
 
        trees.
1283
 
 
1284
 
        :param delta: An inventory delta.  See Inventory.apply_delta for
1285
 
            details.
1286
 
        """
1287
 
        self._read_dirblocks_if_needed()
1288
 
        encode = cache_utf8.encode
1289
 
        insertions = {}
1290
 
        removals = {}
1291
 
        # Accumulate parent references (path_utf8, id), to check for parentless
1292
 
        # items or items placed under files/links/tree-references. We get
1293
 
        # references from every item in the delta that is not a deletion and
1294
 
        # is not itself the root.
1295
 
        parents = set()
1296
 
        # Added ids must not be in the dirstate already. This set holds those
1297
 
        # ids.
1298
 
        new_ids = set()
1299
 
        # This loop transforms the delta to single atomic operations that can
1300
 
        # be executed and validated.
1301
 
        for old_path, new_path, file_id, inv_entry in sorted(
1302
 
            inventory._check_delta_unique_old_paths(
1303
 
            inventory._check_delta_unique_new_paths(
1304
 
            inventory._check_delta_ids_match_entry(
1305
 
            inventory._check_delta_ids_are_valid(
1306
 
            inventory._check_delta_new_path_entry_both_or_None(delta))))),
1307
 
            reverse=True):
1308
 
            if (file_id in insertions) or (file_id in removals):
1309
 
                raise errors.InconsistentDelta(old_path or new_path, file_id,
1310
 
                    "repeated file_id")
1311
 
            if old_path is not None:
1312
 
                old_path = old_path.encode('utf-8')
1313
 
                removals[file_id] = old_path
1314
 
            else:
1315
 
                new_ids.add(file_id)
1316
 
            if new_path is not None:
1317
 
                if inv_entry is None:
1318
 
                    raise errors.InconsistentDelta(new_path, file_id,
1319
 
                        "new_path with no entry")
1320
 
                new_path = new_path.encode('utf-8')
1321
 
                dirname_utf8, basename = osutils.split(new_path)
1322
 
                if basename:
1323
 
                    parents.add((dirname_utf8, inv_entry.parent_id))
1324
 
                key = (dirname_utf8, basename, file_id)
1325
 
                minikind = DirState._kind_to_minikind[inv_entry.kind]
1326
 
                if minikind == 't':
1327
 
                    fingerprint = inv_entry.reference_revision
1328
 
                else:
1329
 
                    fingerprint = ''
1330
 
                insertions[file_id] = (key, minikind, inv_entry.executable,
1331
 
                                       fingerprint, new_path)
1332
 
            # Transform moves into delete+add pairs
1333
 
            if None not in (old_path, new_path):
1334
 
                for child in self._iter_child_entries(0, old_path):
1335
 
                    if child[0][2] in insertions or child[0][2] in removals:
1336
 
                        continue
1337
 
                    child_dirname = child[0][0]
1338
 
                    child_basename = child[0][1]
1339
 
                    minikind = child[1][0][0]
1340
 
                    fingerprint = child[1][0][4]
1341
 
                    executable = child[1][0][3]
1342
 
                    old_child_path = osutils.pathjoin(child[0][0],
1343
 
                                                      child[0][1])
1344
 
                    removals[child[0][2]] = old_child_path
1345
 
                    child_suffix = child_dirname[len(old_path):]
1346
 
                    new_child_dirname = (new_path + child_suffix)
1347
 
                    key = (new_child_dirname, child_basename, child[0][2])
1348
 
                    new_child_path = os.path.join(new_child_dirname,
1349
 
                                                  child_basename)
1350
 
                    insertions[child[0][2]] = (key, minikind, executable,
1351
 
                                               fingerprint, new_child_path)
1352
 
        self._check_delta_ids_absent(new_ids, delta, 0)
1353
 
        try:
1354
 
            self._apply_removals(removals.iteritems())
1355
 
            self._apply_insertions(insertions.values())
1356
 
            # Validate parents
1357
 
            self._after_delta_check_parents(parents, 0)
1358
 
        except errors.BzrError, e:
1359
 
            self._changes_aborted = True
1360
 
            if 'integrity error' not in str(e):
1361
 
                raise
1362
 
            # _get_entry raises BzrError when a request is inconsistent; we
1363
 
            # want such errors to be shown as InconsistentDelta - and that 
1364
 
            # fits the behaviour we trigger.
1365
 
            raise errors.InconsistentDeltaDelta(delta, "error from _get_entry.")
1366
 
 
1367
 
    def _apply_removals(self, removals):
1368
 
        for file_id, path in sorted(removals, reverse=True,
1369
 
            key=operator.itemgetter(1)):
1370
 
            dirname, basename = osutils.split(path)
1371
 
            block_i, entry_i, d_present, f_present = \
1372
 
                self._get_block_entry_index(dirname, basename, 0)
1373
 
            try:
1374
 
                entry = self._dirblocks[block_i][1][entry_i]
1375
 
            except IndexError:
1376
 
                self._changes_aborted = True
1377
 
                raise errors.InconsistentDelta(path, file_id,
1378
 
                    "Wrong path for old path.")
1379
 
            if not f_present or entry[1][0][0] in 'ar':
1380
 
                self._changes_aborted = True
1381
 
                raise errors.InconsistentDelta(path, file_id,
1382
 
                    "Wrong path for old path.")
1383
 
            if file_id != entry[0][2]:
1384
 
                self._changes_aborted = True
1385
 
                raise errors.InconsistentDelta(path, file_id,
1386
 
                    "Attempt to remove path has wrong id - found %r."
1387
 
                    % entry[0][2])
1388
 
            self._make_absent(entry)
1389
 
            # See if we have a malformed delta: deleting a directory must not
1390
 
            # leave crud behind. This increases the number of bisects needed
1391
 
            # substantially, but deletion or renames of large numbers of paths
1392
 
            # is rare enough it shouldn't be an issue (famous last words?) RBC
1393
 
            # 20080730.
1394
 
            block_i, entry_i, d_present, f_present = \
1395
 
                self._get_block_entry_index(path, '', 0)
1396
 
            if d_present:
1397
 
                # The dir block is still present in the dirstate; this could
1398
 
                # be due to it being in a parent tree, or a corrupt delta.
1399
 
                for child_entry in self._dirblocks[block_i][1]:
1400
 
                    if child_entry[1][0][0] not in ('r', 'a'):
1401
 
                        self._changes_aborted = True
1402
 
                        raise errors.InconsistentDelta(path, entry[0][2],
1403
 
                            "The file id was deleted but its children were "
1404
 
                            "not deleted.")
1405
 
 
1406
 
    def _apply_insertions(self, adds):
1407
 
        try:
1408
 
            for key, minikind, executable, fingerprint, path_utf8 in sorted(adds):
1409
 
                self.update_minimal(key, minikind, executable, fingerprint,
1410
 
                                    path_utf8=path_utf8)
1411
 
        except errors.NotVersionedError:
1412
 
            self._changes_aborted = True
1413
 
            raise errors.InconsistentDelta(path_utf8.decode('utf8'), key[2],
1414
 
                "Missing parent")
1415
 
 
1416
 
    def update_basis_by_delta(self, delta, new_revid):
1417
 
        """Update the parents of this tree after a commit.
1418
 
 
1419
 
        This gives the tree one parent, with revision id new_revid. The
1420
 
        inventory delta is applied to the current basis tree to generate the
1421
 
        inventory for the parent new_revid, and all other parent trees are
1422
 
        discarded.
1423
 
 
1424
 
        Note that an exception during the operation of this method will leave
1425
 
        the dirstate in a corrupt state where it should not be saved.
1426
 
 
1427
 
        Finally, we expect all changes to be synchronising the basis tree with
1428
 
        the working tree.
1429
 
 
1430
 
        :param new_revid: The new revision id for the trees parent.
1431
 
        :param delta: An inventory delta (see apply_inventory_delta) describing
1432
 
            the changes from the current left most parent revision to new_revid.
1433
 
        """
1434
 
        self._read_dirblocks_if_needed()
1435
 
        self._discard_merge_parents()
1436
 
        if self._ghosts != []:
1437
 
            raise NotImplementedError(self.update_basis_by_delta)
1438
 
        if len(self._parents) == 0:
1439
 
            # setup a blank tree, the most simple way.
1440
 
            empty_parent = DirState.NULL_PARENT_DETAILS
1441
 
            for entry in self._iter_entries():
1442
 
                entry[1].append(empty_parent)
1443
 
            self._parents.append(new_revid)
1444
 
 
1445
 
        self._parents[0] = new_revid
1446
 
 
1447
 
        delta = sorted(delta, reverse=True)
1448
 
        adds = []
1449
 
        changes = []
1450
 
        deletes = []
1451
 
        # The paths this function accepts are unicode and must be encoded as we
1452
 
        # go.
1453
 
        encode = cache_utf8.encode
1454
 
        inv_to_entry = self._inv_entry_to_details
1455
 
        # delta is now (deletes, changes), (adds) in reverse lexographical
1456
 
        # order.
1457
 
        # deletes in reverse lexographic order are safe to process in situ.
1458
 
        # renames are not, as a rename from any path could go to a path
1459
 
        # lexographically lower, so we transform renames into delete, add pairs,
1460
 
        # expanding them recursively as needed.
1461
 
        # At the same time, to reduce interface friction we convert the input
1462
 
        # inventory entries to dirstate.
1463
 
        root_only = ('', '')
1464
 
        # Accumulate parent references (path_utf8, id), to check for parentless
1465
 
        # items or items placed under files/links/tree-references. We get
1466
 
        # references from every item in the delta that is not a deletion and
1467
 
        # is not itself the root.
1468
 
        parents = set()
1469
 
        # Added ids must not be in the dirstate already. This set holds those
1470
 
        # ids.
1471
 
        new_ids = set()
1472
 
        for old_path, new_path, file_id, inv_entry in delta:
1473
 
            if inv_entry is not None and file_id != inv_entry.file_id:
1474
 
                raise errors.InconsistentDelta(new_path, file_id,
1475
 
                    "mismatched entry file_id %r" % inv_entry)
1476
 
            if new_path is not None:
1477
 
                if inv_entry is None:
1478
 
                    raise errors.InconsistentDelta(new_path, file_id,
1479
 
                        "new_path with no entry")
1480
 
                new_path_utf8 = encode(new_path)
1481
 
                # note the parent for validation
1482
 
                dirname_utf8, basename_utf8 = osutils.split(new_path_utf8)
1483
 
                if basename_utf8:
1484
 
                    parents.add((dirname_utf8, inv_entry.parent_id))
1485
 
            if old_path is None:
1486
 
                adds.append((None, encode(new_path), file_id,
1487
 
                    inv_to_entry(inv_entry), True))
1488
 
                new_ids.add(file_id)
1489
 
            elif new_path is None:
1490
 
                deletes.append((encode(old_path), None, file_id, None, True))
1491
 
            elif (old_path, new_path) != root_only:
1492
 
                # Renames:
1493
 
                # Because renames must preserve their children we must have
1494
 
                # processed all relocations and removes before hand. The sort
1495
 
                # order ensures we've examined the child paths, but we also
1496
 
                # have to execute the removals, or the split to an add/delete
1497
 
                # pair will result in the deleted item being reinserted, or
1498
 
                # renamed items being reinserted twice - and possibly at the
1499
 
                # wrong place. Splitting into a delete/add pair also simplifies
1500
 
                # the handling of entries with ('f', ...), ('r' ...) because
1501
 
                # the target of the 'r' is old_path here, and we add that to
1502
 
                # deletes, meaning that the add handler does not need to check
1503
 
                # for 'r' items on every pass.
1504
 
                self._update_basis_apply_deletes(deletes)
1505
 
                deletes = []
1506
 
                # Split into an add/delete pair recursively.
1507
 
                adds.append((None, new_path_utf8, file_id,
1508
 
                    inv_to_entry(inv_entry), False))
1509
 
                # Expunge deletes that we've seen so that deleted/renamed
1510
 
                # children of a rename directory are handled correctly.
1511
 
                new_deletes = reversed(list(self._iter_child_entries(1,
1512
 
                    encode(old_path))))
1513
 
                # Remove the current contents of the tree at orig_path, and
1514
 
                # reinsert at the correct new path.
1515
 
                for entry in new_deletes:
1516
 
                    if entry[0][0]:
1517
 
                        source_path = entry[0][0] + '/' + entry[0][1]
1518
 
                    else:
1519
 
                        source_path = entry[0][1]
1520
 
                    if new_path_utf8:
1521
 
                        target_path = new_path_utf8 + source_path[len(old_path):]
1522
 
                    else:
1523
 
                        if old_path == '':
1524
 
                            raise AssertionError("cannot rename directory to"
1525
 
                                " itself")
1526
 
                        target_path = source_path[len(old_path) + 1:]
1527
 
                    adds.append((None, target_path, entry[0][2], entry[1][1], False))
1528
 
                    deletes.append(
1529
 
                        (source_path, target_path, entry[0][2], None, False))
1530
 
                deletes.append(
1531
 
                    (encode(old_path), new_path, file_id, None, False))
1532
 
            else:
1533
 
                # changes to just the root should not require remove/insertion
1534
 
                # of everything.
1535
 
                changes.append((encode(old_path), encode(new_path), file_id,
1536
 
                    inv_to_entry(inv_entry)))
1537
 
        self._check_delta_ids_absent(new_ids, delta, 1)
1538
 
        try:
1539
 
            # Finish expunging deletes/first half of renames.
1540
 
            self._update_basis_apply_deletes(deletes)
1541
 
            # Reinstate second half of renames and new paths.
1542
 
            self._update_basis_apply_adds(adds)
1543
 
            # Apply in-situ changes.
1544
 
            self._update_basis_apply_changes(changes)
1545
 
            # Validate parents
1546
 
            self._after_delta_check_parents(parents, 1)
1547
 
        except errors.BzrError, e:
1548
 
            self._changes_aborted = True
1549
 
            if 'integrity error' not in str(e):
1550
 
                raise
1551
 
            # _get_entry raises BzrError when a request is inconsistent; we
1552
 
            # want such errors to be shown as InconsistentDelta - and that 
1553
 
            # fits the behaviour we trigger. Partof this is driven by dirstate
1554
 
            # only supporting deltas that turn the basis into a closer fit to
1555
 
            # the active tree.
1556
 
            raise errors.InconsistentDeltaDelta(delta, "error from _get_entry.")
1557
 
 
1558
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
1559
 
        self._header_state = DirState.IN_MEMORY_MODIFIED
1560
 
        self._id_index = None
1561
 
        return
1562
 
 
1563
 
    def _check_delta_ids_absent(self, new_ids, delta, tree_index):
1564
 
        """Check that none of the file_ids in new_ids are present in a tree."""
1565
 
        if not new_ids:
1566
 
            return
1567
 
        id_index = self._get_id_index()
1568
 
        for file_id in new_ids:
1569
 
            for key in id_index.get(file_id, []):
1570
 
                block_i, entry_i, d_present, f_present = \
1571
 
                    self._get_block_entry_index(key[0], key[1], tree_index)
1572
 
                if not f_present:
1573
 
                    # In a different tree
1574
 
                    continue
1575
 
                entry = self._dirblocks[block_i][1][entry_i]
1576
 
                if entry[0][2] != file_id:
1577
 
                    # Different file_id, so not what we want.
1578
 
                    continue
1579
 
                # NB: No changes made before this helper is called, so no need
1580
 
                # to set the _changes_aborted flag.
1581
 
                raise errors.InconsistentDelta(
1582
 
                    ("%s/%s" % key[0:2]).decode('utf8'), file_id,
1583
 
                    "This file_id is new in the delta but already present in "
1584
 
                    "the target")
1585
 
 
1586
 
    def _update_basis_apply_adds(self, adds):
1587
 
        """Apply a sequence of adds to tree 1 during update_basis_by_delta.
1588
 
 
1589
 
        They may be adds, or renames that have been split into add/delete
1590
 
        pairs.
1591
 
 
1592
 
        :param adds: A sequence of adds. Each add is a tuple:
1593
 
            (None, new_path_utf8, file_id, (entry_details), real_add). real_add
1594
 
            is False when the add is the second half of a remove-and-reinsert
1595
 
            pair created to handle renames and deletes.
1596
 
        """
1597
 
        # Adds are accumulated partly from renames, so can be in any input
1598
 
        # order - sort it.
1599
 
        adds.sort()
1600
 
        # adds is now in lexographic order, which places all parents before
1601
 
        # their children, so we can process it linearly.
1602
 
        absent = 'ar'
1603
 
        for old_path, new_path, file_id, new_details, real_add in adds:
1604
 
            # the entry for this file_id must be in tree 0.
1605
 
            entry = self._get_entry(0, file_id, new_path)
1606
 
            if entry[0] is None or entry[0][2] != file_id:
1607
 
                self._changes_aborted = True
1608
 
                raise errors.InconsistentDelta(new_path, file_id,
1609
 
                    'working tree does not contain new entry')
1610
 
            if real_add and entry[1][1][0] not in absent:
1611
 
                self._changes_aborted = True
1612
 
                raise errors.InconsistentDelta(new_path, file_id,
1613
 
                    'The entry was considered to be a genuinely new record,'
1614
 
                    ' but there was already an old record for it.')
1615
 
            # We don't need to update the target of an 'r' because the handling
1616
 
            # of renames turns all 'r' situations into a delete at the original
1617
 
            # location.
1618
 
            entry[1][1] = new_details
1619
 
 
1620
 
    def _update_basis_apply_changes(self, changes):
1621
 
        """Apply a sequence of changes to tree 1 during update_basis_by_delta.
1622
 
 
1623
 
        :param adds: A sequence of changes. Each change is a tuple:
1624
 
            (path_utf8, path_utf8, file_id, (entry_details))
1625
 
        """
1626
 
        absent = 'ar'
1627
 
        for old_path, new_path, file_id, new_details in changes:
1628
 
            # the entry for this file_id must be in tree 0.
1629
 
            entry = self._get_entry(0, file_id, new_path)
1630
 
            if entry[0] is None or entry[0][2] != file_id:
1631
 
                self._changes_aborted = True
1632
 
                raise errors.InconsistentDelta(new_path, file_id,
1633
 
                    'working tree does not contain new entry')
1634
 
            if (entry[1][0][0] in absent or
1635
 
                entry[1][1][0] in absent):
1636
 
                self._changes_aborted = True
1637
 
                raise errors.InconsistentDelta(new_path, file_id,
1638
 
                    'changed considered absent')
1639
 
            entry[1][1] = new_details
1640
 
 
1641
 
    def _update_basis_apply_deletes(self, deletes):
1642
 
        """Apply a sequence of deletes to tree 1 during update_basis_by_delta.
1643
 
 
1644
 
        They may be deletes, or renames that have been split into add/delete
1645
 
        pairs.
1646
 
 
1647
 
        :param deletes: A sequence of deletes. Each delete is a tuple:
1648
 
            (old_path_utf8, new_path_utf8, file_id, None, real_delete).
1649
 
            real_delete is True when the desired outcome is an actual deletion
1650
 
            rather than the rename handling logic temporarily deleting a path
1651
 
            during the replacement of a parent.
1652
 
        """
1653
 
        null = DirState.NULL_PARENT_DETAILS
1654
 
        for old_path, new_path, file_id, _, real_delete in deletes:
1655
 
            if real_delete != (new_path is None):
1656
 
                self._changes_aborted = True
1657
 
                raise AssertionError("bad delete delta")
1658
 
            # the entry for this file_id must be in tree 1.
1659
 
            dirname, basename = osutils.split(old_path)
1660
 
            block_index, entry_index, dir_present, file_present = \
1661
 
                self._get_block_entry_index(dirname, basename, 1)
1662
 
            if not file_present:
1663
 
                self._changes_aborted = True
1664
 
                raise errors.InconsistentDelta(old_path, file_id,
1665
 
                    'basis tree does not contain removed entry')
1666
 
            entry = self._dirblocks[block_index][1][entry_index]
1667
 
            if entry[0][2] != file_id:
1668
 
                self._changes_aborted = True
1669
 
                raise errors.InconsistentDelta(old_path, file_id,
1670
 
                    'mismatched file_id in tree 1')
1671
 
            if real_delete:
1672
 
                if entry[1][0][0] != 'a':
1673
 
                    self._changes_aborted = True
1674
 
                    raise errors.InconsistentDelta(old_path, file_id,
1675
 
                            'This was marked as a real delete, but the WT state'
1676
 
                            ' claims that it still exists and is versioned.')
1677
 
                del self._dirblocks[block_index][1][entry_index]
1678
 
            else:
1679
 
                if entry[1][0][0] == 'a':
1680
 
                    self._changes_aborted = True
1681
 
                    raise errors.InconsistentDelta(old_path, file_id,
1682
 
                        'The entry was considered a rename, but the source path'
1683
 
                        ' is marked as absent.')
1684
 
                    # For whatever reason, we were asked to rename an entry
1685
 
                    # that was originally marked as deleted. This could be
1686
 
                    # because we are renaming the parent directory, and the WT
1687
 
                    # current state has the file marked as deleted.
1688
 
                elif entry[1][0][0] == 'r':
1689
 
                    # implement the rename
1690
 
                    del self._dirblocks[block_index][1][entry_index]
1691
 
                else:
1692
 
                    # it is being resurrected here, so blank it out temporarily.
1693
 
                    self._dirblocks[block_index][1][entry_index][1][1] = null
1694
 
 
1695
 
    def _after_delta_check_parents(self, parents, index):
1696
 
        """Check that parents required by the delta are all intact.
1697
 
        
1698
 
        :param parents: An iterable of (path_utf8, file_id) tuples which are
1699
 
            required to be present in tree 'index' at path_utf8 with id file_id
1700
 
            and be a directory.
1701
 
        :param index: The column in the dirstate to check for parents in.
1702
 
        """
1703
 
        for dirname_utf8, file_id in parents:
1704
 
            # Get the entry - the ensures that file_id, dirname_utf8 exists and
1705
 
            # has the right file id.
1706
 
            entry = self._get_entry(index, file_id, dirname_utf8)
1707
 
            if entry[1] is None:
1708
 
                self._changes_aborted = True
1709
 
                raise errors.InconsistentDelta(dirname_utf8.decode('utf8'),
1710
 
                    file_id, "This parent is not present.")
1711
 
            # Parents of things must be directories
1712
 
            if entry[1][index][0] != 'd':
1713
 
                self._changes_aborted = True
1714
 
                raise errors.InconsistentDelta(dirname_utf8.decode('utf8'),
1715
 
                    file_id, "This parent is not a directory.")
1716
 
 
1717
 
    def _observed_sha1(self, entry, sha1, stat_value,
1718
 
        _stat_to_minikind=_stat_to_minikind, _pack_stat=pack_stat):
1719
 
        """Note the sha1 of a file.
1720
 
 
1721
 
        :param entry: The entry the sha1 is for.
1722
 
        :param sha1: The observed sha1.
1723
 
        :param stat_value: The os.lstat for the file.
 
1094
    def update_entry(self, entry, abspath, stat_value,
 
1095
                     _stat_to_minikind=_stat_to_minikind,
 
1096
                     _pack_stat=pack_stat):
 
1097
        """Update the entry based on what is actually on disk.
 
1098
 
 
1099
        :param entry: This is the dirblock entry for the file in question.
 
1100
        :param abspath: The path on disk for this file.
 
1101
        :param stat_value: (optional) if we already have done a stat on the
 
1102
            file, re-use it.
 
1103
        :return: The sha1 hexdigest of the file (40 bytes) or link target of a
 
1104
                symlink.
1724
1105
        """
1725
1106
        try:
1726
1107
            minikind = _stat_to_minikind[stat_value.st_mode & 0170000]
1728
1109
            # Unhandled kind
1729
1110
            return None
1730
1111
        packed_stat = _pack_stat(stat_value)
 
1112
        (saved_minikind, saved_link_or_sha1, saved_file_size,
 
1113
         saved_executable, saved_packed_stat) = entry[1][0]
 
1114
 
 
1115
        if (minikind == saved_minikind
 
1116
            and packed_stat == saved_packed_stat):
 
1117
            # The stat hasn't changed since we saved, so we can re-use the
 
1118
            # saved sha hash.
 
1119
            if minikind == 'd':
 
1120
                return None
 
1121
 
 
1122
            # size should also be in packed_stat
 
1123
            if saved_file_size == stat_value.st_size:
 
1124
                return saved_link_or_sha1
 
1125
 
 
1126
        # If we have gotten this far, that means that we need to actually
 
1127
        # process this entry.
 
1128
        link_or_sha1 = None
1731
1129
        if minikind == 'f':
1732
 
            if self._cutoff_time is None:
1733
 
                self._sha_cutoff_time()
1734
 
            if (stat_value.st_mtime < self._cutoff_time
1735
 
                and stat_value.st_ctime < self._cutoff_time):
1736
 
                entry[1][0] = ('f', sha1, entry[1][0][2], entry[1][0][3],
1737
 
                    packed_stat)
1738
 
                self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
1130
            link_or_sha1 = self._sha1_file(abspath, entry)
 
1131
            executable = self._is_executable(stat_value.st_mode,
 
1132
                                             saved_executable)
 
1133
            if self._cutoff_time is None:
 
1134
                self._sha_cutoff_time()
 
1135
            if (stat_value.st_mtime < self._cutoff_time
 
1136
                and stat_value.st_ctime < self._cutoff_time):
 
1137
                entry[1][0] = ('f', link_or_sha1, stat_value.st_size,
 
1138
                               executable, packed_stat)
 
1139
            else:
 
1140
                entry[1][0] = ('f', '', stat_value.st_size,
 
1141
                               executable, DirState.NULLSTAT)
 
1142
        elif minikind == 'd':
 
1143
            link_or_sha1 = None
 
1144
            entry[1][0] = ('d', '', 0, False, packed_stat)
 
1145
            if saved_minikind != 'd':
 
1146
                # This changed from something into a directory. Make sure we
 
1147
                # have a directory block for it. This doesn't happen very
 
1148
                # often, so this doesn't have to be super fast.
 
1149
                block_index, entry_index, dir_present, file_present = \
 
1150
                    self._get_block_entry_index(entry[0][0], entry[0][1], 0)
 
1151
                self._ensure_block(block_index, entry_index,
 
1152
                                   osutils.pathjoin(entry[0][0], entry[0][1]))
 
1153
        elif minikind == 'l':
 
1154
            link_or_sha1 = self._read_link(abspath, saved_link_or_sha1)
 
1155
            if self._cutoff_time is None:
 
1156
                self._sha_cutoff_time()
 
1157
            if (stat_value.st_mtime < self._cutoff_time
 
1158
                and stat_value.st_ctime < self._cutoff_time):
 
1159
                entry[1][0] = ('l', link_or_sha1, stat_value.st_size,
 
1160
                               False, packed_stat)
 
1161
            else:
 
1162
                entry[1][0] = ('l', '', stat_value.st_size,
 
1163
                               False, DirState.NULLSTAT)
 
1164
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
1165
        return link_or_sha1
1739
1166
 
1740
1167
    def _sha_cutoff_time(self):
1741
1168
        """Return cutoff time.
1754
1181
        """Return the os.lstat value for this path."""
1755
1182
        return os.lstat(abspath)
1756
1183
 
1757
 
    def _sha1_file_and_mutter(self, abspath):
1758
 
        # when -Dhashcache is turned on, this is monkey-patched in to log
1759
 
        # file reads
1760
 
        trace.mutter("dirstate sha1 " + abspath)
1761
 
        return self._sha1_provider.sha1(abspath)
 
1184
    def _sha1_file(self, abspath, entry):
 
1185
        """Calculate the SHA1 of a file by reading the full text"""
 
1186
        f = file(abspath, 'rb', buffering=65000)
 
1187
        try:
 
1188
            return osutils.sha_file(f)
 
1189
        finally:
 
1190
            f.close()
1762
1191
 
1763
1192
    def _is_executable(self, mode, old_executable):
1764
1193
        """Is this file executable?"""
1777
1206
        #       already in memory. However, this really needs to be done at a
1778
1207
        #       higher level, because there either won't be anything on disk,
1779
1208
        #       or the thing on disk will be a file.
1780
 
        fs_encoding = osutils._fs_enc
1781
 
        if isinstance(abspath, unicode):
1782
 
            # abspath is defined as the path to pass to lstat. readlink is
1783
 
            # buggy in python < 2.6 (it doesn't encode unicode path into FS
1784
 
            # encoding), so we need to encode ourselves knowing that unicode
1785
 
            # paths are produced by UnicodeDirReader on purpose.
1786
 
            abspath = abspath.encode(fs_encoding)
1787
 
        target = os.readlink(abspath)
1788
 
        if fs_encoding not in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
1789
 
            # Change encoding if needed
1790
 
            target = target.decode(fs_encoding).encode('UTF-8')
1791
 
        return target
 
1209
        return os.readlink(abspath)
1792
1210
 
1793
1211
    def get_ghosts(self):
1794
1212
        """Return a list of the parent tree revision ids that are ghosts."""
1912
1330
            be attempted.
1913
1331
        :return: A tuple describing where the path is located, or should be
1914
1332
            inserted. The tuple contains four fields: the block index, the row
1915
 
            index, the directory is present (boolean), the entire path is
1916
 
            present (boolean).  There is no guarantee that either
 
1333
            index, anda two booleans are True when the directory is present, and
 
1334
            when the entire path is present.  There is no guarantee that either
1917
1335
            coordinate is currently reachable unless the found field for it is
1918
1336
            True. For instance, a directory not present in the searched tree
1919
1337
            may be returned with a value one greater than the current highest
1931
1349
            return block_index, 0, False, False
1932
1350
        block = self._dirblocks[block_index][1] # access the entries only
1933
1351
        entry_index, present = self._find_entry_index(key, block)
1934
 
        # linear search through entries at this path to find the one
 
1352
        # linear search through present entries at this path to find the one
1935
1353
        # requested.
1936
1354
        while entry_index < len(block) and block[entry_index][0][1] == basename:
1937
 
            if block[entry_index][1][tree_index][0] not in 'ar':
1938
 
                # neither absent or relocated
 
1355
            if block[entry_index][1][tree_index][0] not in \
 
1356
                       ('a', 'r'): # absent, relocated
1939
1357
                return block_index, entry_index, True, True
1940
1358
            entry_index += 1
1941
1359
        return block_index, entry_index, True, False
1942
1360
 
1943
 
    def _get_entry(self, tree_index, fileid_utf8=None, path_utf8=None, include_deleted=False):
1944
 
        """Get the dirstate entry for path in tree tree_index.
 
1361
    def _get_entry(self, tree_index, fileid_utf8=None, path_utf8=None):
 
1362
        """Get the dirstate entry for path in tree tree_index
1945
1363
 
1946
1364
        If either file_id or path is supplied, it is used as the key to lookup.
1947
1365
        If both are supplied, the fastest lookup is used, and an error is
1954
1372
            trees.
1955
1373
        :param fileid_utf8: A utf8 file_id to look up.
1956
1374
        :param path_utf8: An utf8 path to be looked up.
1957
 
        :param include_deleted: If True, and performing a lookup via
1958
 
            fileid_utf8 rather than path_utf8, return an entry for deleted
1959
 
            (absent) paths.
1960
1375
        :return: The dirstate entry tuple for path, or (None, None)
1961
1376
        """
1962
1377
        self._read_dirblocks_if_needed()
1963
1378
        if path_utf8 is not None:
1964
 
            if type(path_utf8) is not str:
1965
 
                raise errors.BzrError('path_utf8 is not a str: %s %r'
1966
 
                    % (type(path_utf8), path_utf8))
 
1379
            assert path_utf8.__class__ == str, 'path_utf8 is not a str: %s %s' % (type(path_utf8), path_utf8)
1967
1380
            # path lookups are faster
1968
1381
            dirname, basename = osutils.split(path_utf8)
1969
1382
            block_index, entry_index, dir_present, file_present = \
1971
1384
            if not file_present:
1972
1385
                return None, None
1973
1386
            entry = self._dirblocks[block_index][1][entry_index]
1974
 
            if not (entry[0][2] and entry[1][tree_index][0] not in ('a', 'r')):
1975
 
                raise AssertionError('unversioned entry?')
 
1387
            assert entry[0][2] and entry[1][tree_index][0] not in ('a', 'r'), 'unversioned entry?!?!'
1976
1388
            if fileid_utf8:
1977
1389
                if entry[0][2] != fileid_utf8:
1978
 
                    self._changes_aborted = True
1979
1390
                    raise errors.BzrError('integrity error ? : mismatching'
1980
1391
                                          ' tree_index, file_id and path')
1981
1392
            return entry
1982
1393
        else:
 
1394
            assert fileid_utf8 is not None
1983
1395
            possible_keys = self._get_id_index().get(fileid_utf8, None)
1984
1396
            if not possible_keys:
1985
1397
                return None, None
1992
1404
                    continue
1993
1405
                # WARNING: DO not change this code to use _get_block_entry_index
1994
1406
                # as that function is not suitable: it does not use the key
1995
 
                # to lookup, and thus the wrong coordinates are returned.
 
1407
                # to lookup, and thus the wront coordinates are returned.
1996
1408
                block = self._dirblocks[block_index][1]
1997
1409
                entry_index, present = self._find_entry_index(key, block)
1998
1410
                if present:
1999
1411
                    entry = self._dirblocks[block_index][1][entry_index]
2000
1412
                    if entry[1][tree_index][0] in 'fdlt':
2001
 
                        # this is the result we are looking for: the
 
1413
                        # this is the result we are looking for: the  
2002
1414
                        # real home of this file_id in this tree.
2003
1415
                        return entry
2004
1416
                    if entry[1][tree_index][0] == 'a':
2005
1417
                        # there is no home for this entry in this tree
2006
 
                        if include_deleted:
2007
 
                            return entry
2008
1418
                        return None, None
2009
 
                    if entry[1][tree_index][0] != 'r':
2010
 
                        raise AssertionError(
2011
 
                            "entry %r has invalid minikind %r for tree %r" \
2012
 
                            % (entry,
2013
 
                               entry[1][tree_index][0],
2014
 
                               tree_index))
 
1419
                    assert entry[1][tree_index][0] == 'r', \
 
1420
                        "entry %r has invalid minikind %r for tree %r" \
 
1421
                        % (entry,
 
1422
                           entry[1][tree_index][0],
 
1423
                           tree_index)
2015
1424
                    real_path = entry[1][tree_index][1]
2016
1425
                    return self._get_entry(tree_index, fileid_utf8=fileid_utf8,
2017
1426
                        path_utf8=real_path)
2018
1427
            return None, None
2019
1428
 
2020
1429
    @classmethod
2021
 
    def initialize(cls, path, sha1_provider=None):
 
1430
    def initialize(cls, path):
2022
1431
        """Create a new dirstate on path.
2023
1432
 
2024
1433
        The new dirstate will be an empty tree - that is it has no parents,
2025
1434
        and only a root node - which has id ROOT_ID.
2026
1435
 
2027
1436
        :param path: The name of the file for the dirstate.
2028
 
        :param sha1_provider: an object meeting the SHA1Provider interface.
2029
 
            If None, a DefaultSHA1Provider is used.
2030
1437
        :return: A write-locked DirState object.
2031
1438
        """
2032
1439
        # This constructs a new DirState object on a path, sets the _state_file
2034
1441
        # stock empty dirstate information - a root with ROOT_ID, no children,
2035
1442
        # and no parents. Finally it calls save() to ensure that this data will
2036
1443
        # persist.
2037
 
        if sha1_provider is None:
2038
 
            sha1_provider = DefaultSHA1Provider()
2039
 
        result = cls(path, sha1_provider)
 
1444
        result = cls(path)
2040
1445
        # root dir and root dir contents with no children.
2041
1446
        empty_tree_dirblocks = [('', []), ('', [])]
2042
1447
        # a new root directory, with a NULLSTAT.
2053
1458
            raise
2054
1459
        return result
2055
1460
 
2056
 
    @staticmethod
2057
 
    def _inv_entry_to_details(inv_entry):
 
1461
    def _inv_entry_to_details(self, inv_entry):
2058
1462
        """Convert an inventory entry (from a revision tree) to state details.
2059
1463
 
2060
1464
        :param inv_entry: An inventory entry whose sha1 and link targets can be
2065
1469
        kind = inv_entry.kind
2066
1470
        minikind = DirState._kind_to_minikind[kind]
2067
1471
        tree_data = inv_entry.revision
 
1472
        assert len(tree_data) > 0, 'empty revision for the inv_entry.'
2068
1473
        if kind == 'directory':
2069
1474
            fingerprint = ''
2070
1475
            size = 0
2071
1476
            executable = False
2072
1477
        elif kind == 'symlink':
2073
 
            if inv_entry.symlink_target is None:
2074
 
                fingerprint = ''
2075
 
            else:
2076
 
                fingerprint = inv_entry.symlink_target.encode('utf8')
 
1478
            fingerprint = inv_entry.symlink_target or ''
2077
1479
            size = 0
2078
1480
            executable = False
2079
1481
        elif kind == 'file':
2088
1490
            raise Exception("can't pack %s" % inv_entry)
2089
1491
        return (minikind, fingerprint, size, executable, tree_data)
2090
1492
 
2091
 
    def _iter_child_entries(self, tree_index, path_utf8):
2092
 
        """Iterate over all the entries that are children of path_utf.
2093
 
 
2094
 
        This only returns entries that are present (not in 'a', 'r') in
2095
 
        tree_index. tree_index data is not refreshed, so if tree 0 is used,
2096
 
        results may differ from that obtained if paths were statted to
2097
 
        determine what ones were directories.
2098
 
 
2099
 
        Asking for the children of a non-directory will return an empty
2100
 
        iterator.
2101
 
        """
2102
 
        pending_dirs = []
2103
 
        next_pending_dirs = [path_utf8]
2104
 
        absent = 'ar'
2105
 
        while next_pending_dirs:
2106
 
            pending_dirs = next_pending_dirs
2107
 
            next_pending_dirs = []
2108
 
            for path in pending_dirs:
2109
 
                block_index, present = self._find_block_index_from_key(
2110
 
                    (path, '', ''))
2111
 
                if block_index == 0:
2112
 
                    block_index = 1
2113
 
                    if len(self._dirblocks) == 1:
2114
 
                        # asked for the children of the root with no other
2115
 
                        # contents.
2116
 
                        return
2117
 
                if not present:
2118
 
                    # children of a non-directory asked for.
2119
 
                    continue
2120
 
                block = self._dirblocks[block_index]
2121
 
                for entry in block[1]:
2122
 
                    kind = entry[1][tree_index][0]
2123
 
                    if kind not in absent:
2124
 
                        yield entry
2125
 
                    if kind == 'd':
2126
 
                        if entry[0][0]:
2127
 
                            path = entry[0][0] + '/' + entry[0][1]
2128
 
                        else:
2129
 
                            path = entry[0][1]
2130
 
                        next_pending_dirs.append(path)
2131
 
 
2132
1493
    def _iter_entries(self):
2133
1494
        """Iterate over all the entries in the dirstate.
2134
1495
 
2150
1511
        return self._id_index
2151
1512
 
2152
1513
    def _get_output_lines(self, lines):
2153
 
        """Format lines for final output.
 
1514
        """format lines for final output.
2154
1515
 
2155
 
        :param lines: A sequence of lines containing the parents list and the
 
1516
        :param lines: A sequece of lines containing the parents list and the
2156
1517
            path lines.
2157
1518
        """
2158
1519
        output_lines = [DirState.HEADER_FORMAT_3]
2166
1527
        return output_lines
2167
1528
 
2168
1529
    def _make_deleted_row(self, fileid_utf8, parents):
2169
 
        """Return a deleted row for fileid_utf8."""
 
1530
        """Return a deleted for for fileid_utf8."""
2170
1531
        return ('/', 'RECYCLED.BIN', 'file', fileid_utf8, 0, DirState.NULLSTAT,
2171
1532
            ''), parents
2172
1533
 
2175
1536
        return len(self._parents) - len(self._ghosts)
2176
1537
 
2177
1538
    @staticmethod
2178
 
    def on_file(path, sha1_provider=None):
2179
 
        """Construct a DirState on the file at path "path".
 
1539
    def on_file(path):
 
1540
        """Construct a DirState on the file at path path.
2180
1541
 
2181
 
        :param path: The path at which the dirstate file on disk should live.
2182
 
        :param sha1_provider: an object meeting the SHA1Provider interface.
2183
 
            If None, a DefaultSHA1Provider is used.
2184
1542
        :return: An unlocked DirState object, associated with the given path.
2185
1543
        """
2186
 
        if sha1_provider is None:
2187
 
            sha1_provider = DefaultSHA1Provider()
2188
 
        result = DirState(path, sha1_provider)
 
1544
        result = DirState(path)
2189
1545
        return result
2190
1546
 
2191
1547
    def _read_dirblocks_if_needed(self):
2192
1548
        """Read in all the dirblocks from the file if they are not in memory.
2193
 
 
 
1549
        
2194
1550
        This populates self._dirblocks, and sets self._dirblock_state to
2195
1551
        IN_MEMORY_UNMODIFIED. It is not currently ready for incremental block
2196
1552
        loading.
2211
1567
        parent_line = self._state_file.readline()
2212
1568
        info = parent_line.split('\0')
2213
1569
        num_parents = int(info[0])
 
1570
        assert num_parents == len(info)-2, 'incorrect parent info line'
2214
1571
        self._parents = info[1:-1]
 
1572
 
2215
1573
        ghost_line = self._state_file.readline()
2216
1574
        info = ghost_line.split('\0')
2217
1575
        num_ghosts = int(info[1])
 
1576
        assert num_ghosts == len(info)-3, 'incorrect ghost info line'
2218
1577
        self._ghosts = info[2:-1]
2219
1578
        self._header_state = DirState.IN_MEMORY_UNMODIFIED
2220
1579
        self._end_of_header = self._state_file.tell()
2228
1587
            self._read_header()
2229
1588
 
2230
1589
    def _read_prelude(self):
2231
 
        """Read in the prelude header of the dirstate file.
 
1590
        """Read in the prelude header of the dirstate file
2232
1591
 
2233
1592
        This only reads in the stuff that is not connected to the crc
2234
1593
        checksum. The position will be correct to read in the rest of
2237
1596
        and their ids. Followed by a newline.
2238
1597
        """
2239
1598
        header = self._state_file.readline()
2240
 
        if header != DirState.HEADER_FORMAT_3:
2241
 
            raise errors.BzrError(
2242
 
                'invalid header line: %r' % (header,))
 
1599
        assert header == DirState.HEADER_FORMAT_3, \
 
1600
            'invalid header line: %r' % (header,)
2243
1601
        crc_line = self._state_file.readline()
2244
 
        if not crc_line.startswith('crc32: '):
2245
 
            raise errors.BzrError('missing crc32 checksum: %r' % crc_line)
 
1602
        assert crc_line.startswith('crc32: '), 'missing crc32 checksum'
2246
1603
        self.crc_expected = int(crc_line[len('crc32: '):-1])
2247
1604
        num_entries_line = self._state_file.readline()
2248
 
        if not num_entries_line.startswith('num_entries: '):
2249
 
            raise errors.BzrError('missing num_entries line')
 
1605
        assert num_entries_line.startswith('num_entries: '), 'missing num_entries line'
2250
1606
        self._num_entries = int(num_entries_line[len('num_entries: '):-1])
2251
1607
 
2252
 
    def sha1_from_stat(self, path, stat_result, _pack_stat=pack_stat):
2253
 
        """Find a sha1 given a stat lookup."""
2254
 
        return self._get_packed_stat_index().get(_pack_stat(stat_result), None)
2255
 
 
2256
 
    def _get_packed_stat_index(self):
2257
 
        """Get a packed_stat index of self._dirblocks."""
2258
 
        if self._packed_stat_index is None:
2259
 
            index = {}
2260
 
            for key, tree_details in self._iter_entries():
2261
 
                if tree_details[0][0] == 'f':
2262
 
                    index[tree_details[0][4]] = tree_details[0][1]
2263
 
            self._packed_stat_index = index
2264
 
        return self._packed_stat_index
2265
 
 
2266
1608
    def save(self):
2267
1609
        """Save any pending changes created during this session.
2268
1610
 
2269
1611
        We reuse the existing file, because that prevents race conditions with
2270
1612
        file creation, and use oslocks on it to prevent concurrent modification
2271
 
        and reads - because dirstate's incremental data aggregation is not
 
1613
        and reads - because dirstates incremental data aggretation is not
2272
1614
        compatible with reading a modified file, and replacing a file in use by
2273
 
        another process is impossible on Windows.
 
1615
        another process is impossible on windows.
2274
1616
 
2275
1617
        A dirstate in read only mode should be smart enough though to validate
2276
1618
        that the file has not changed, and otherwise discard its cache and
2277
1619
        start over, to allow for fine grained read lock duration, so 'status'
2278
1620
        wont block 'commit' - for example.
2279
1621
        """
2280
 
        if self._changes_aborted:
2281
 
            # Should this be a warning? For now, I'm expecting that places that
2282
 
            # mark it inconsistent will warn, making a warning here redundant.
2283
 
            trace.mutter('Not saving DirState because '
2284
 
                    '_changes_aborted is set.')
2285
 
            return
2286
1622
        if (self._header_state == DirState.IN_MEMORY_MODIFIED or
2287
1623
            self._dirblock_state == DirState.IN_MEMORY_MODIFIED):
2288
1624
 
2321
1657
 
2322
1658
        :param parent_ids: A list of parent tree revision ids.
2323
1659
        :param dirblocks: A list containing one tuple for each directory in the
2324
 
            tree. Each tuple contains the directory path and a list of entries
 
1660
            tree. Each tuple contains the directory path and a list of entries 
2325
1661
            found in that directory.
2326
1662
        """
2327
1663
        # our memory copy is now authoritative.
2330
1666
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
2331
1667
        self._parents = list(parent_ids)
2332
1668
        self._id_index = None
2333
 
        self._packed_stat_index = None
2334
1669
 
2335
1670
    def set_path_id(self, path, new_id):
2336
1671
        """Change the id of path to new_id in the current working tree.
2340
1675
        :param new_id: The new id to assign to the path. This must be a utf8
2341
1676
            file id (not unicode, and not None).
2342
1677
        """
 
1678
        assert new_id.__class__ == str, \
 
1679
            "path_id %r is not a plain string" % (new_id,)
2343
1680
        self._read_dirblocks_if_needed()
2344
1681
        if len(path):
2345
 
            # TODO: logic not written
 
1682
            # logic not written
2346
1683
            raise NotImplementedError(self.set_path_id)
2347
1684
        # TODO: check new id is unique
2348
1685
        entry = self._get_entry(0, path_utf8=path)
2361
1698
        """Set the parent trees for the dirstate.
2362
1699
 
2363
1700
        :param trees: A list of revision_id, tree tuples. tree must be provided
2364
 
            even if the revision_id refers to a ghost: supply an empty tree in
 
1701
            even if the revision_id refers to a ghost: supply an empty tree in 
2365
1702
            this case.
2366
1703
        :param ghosts: A list of the revision_ids that are ghosts at the time
2367
1704
            of setting.
2368
 
        """
2369
 
        # TODO: generate a list of parent indexes to preserve to save
 
1705
        """ 
 
1706
        # TODO: generate a list of parent indexes to preserve to save 
2370
1707
        # processing specific parent trees. In the common case one tree will
2371
1708
        # be preserved - the left most parent.
2372
1709
        # TODO: if the parent tree is a dirstate, we might want to walk them
2377
1714
        # map and then walk the new parent trees only, mapping them into the
2378
1715
        # dirstate. Walk the dirstate at the same time to remove unreferenced
2379
1716
        # entries.
2380
 
        # for now:
2381
 
        # sketch: loop over all entries in the dirstate, cherry picking
 
1717
        # for now: 
 
1718
        # sketch: loop over all entries in the dirstate, cherry picking 
2382
1719
        # entries from the parent trees, if they are not ghost trees.
2383
1720
        # after we finish walking the dirstate, all entries not in the dirstate
2384
1721
        # are deletes, so we want to append them to the end as per the design
2389
1726
        #   links. We dont't trivially use the inventory from other trees
2390
1727
        #   because this leads to either double touching, or to accessing
2391
1728
        #   missing keys,
2392
 
        # - find other keys containing a path
2393
 
        # We accumulate each entry via this dictionary, including the root
 
1729
        # - find other keys containing a path 
 
1730
        # We accumulate each entry via this dictionary, including the root 
2394
1731
        by_path = {}
2395
1732
        id_index = {}
2396
1733
        # we could do parallel iterators, but because file id data may be
2400
1737
        # parent, but for now the common cases are adding a new parent (merge),
2401
1738
        # and replacing completely (commit), and commit is more common: so
2402
1739
        # optimise merge later.
2403
 
 
 
1740
        
2404
1741
        # ---- start generation of full tree mapping data
2405
1742
        # what trees should we use?
2406
1743
        parent_trees = [tree for rev_id, tree in trees if rev_id not in ghosts]
2407
 
        # how many trees do we end up with
 
1744
        # how many trees do we end up with 
2408
1745
        parent_count = len(parent_trees)
2409
1746
 
2410
1747
        # one: the current tree
2411
1748
        for entry in self._iter_entries():
2412
1749
            # skip entries not in the current tree
2413
 
            if entry[1][0][0] in 'ar': # absent, relocated
 
1750
            if entry[1][0][0] in ('a', 'r'): # absent, relocated
2414
1751
                continue
2415
1752
            by_path[entry[0]] = [entry[1][0]] + \
2416
1753
                [DirState.NULL_PARENT_DETAILS] * parent_count
2417
1754
            id_index[entry[0][2]] = set([entry[0]])
2418
 
 
 
1755
        
2419
1756
        # now the parent trees:
2420
1757
        for tree_index, tree in enumerate(parent_trees):
2421
1758
            # the index is off by one, adjust it.
2435
1772
                # avoid checking all known paths for the id when generating a
2436
1773
                # new entry at this path: by adding the id->path mapping last,
2437
1774
                # all the mappings are valid and have correct relocation
2438
 
                # records where needed.
 
1775
                # records where needed. 
2439
1776
                file_id = entry.file_id
2440
1777
                path_utf8 = path.encode('utf8')
2441
1778
                dirname, basename = osutils.split(path_utf8)
2450
1787
                        # this file id is at a different path in one of the
2451
1788
                        # other trees, so put absent pointers there
2452
1789
                        # This is the vertical axis in the matrix, all pointing
2453
 
                        # to the real path.
 
1790
                        # tot he real path.
2454
1791
                        by_path[entry_key][tree_index] = ('r', path_utf8, 0, False, '')
2455
 
                # by path consistency: Insert into an existing path record (trivial), or
 
1792
                # by path consistency: Insert into an existing path record (trivial), or 
2456
1793
                # add a new one with relocation pointers for the other tree indexes.
2457
1794
                if new_entry_key in id_index[file_id]:
2458
1795
                    # there is already an entry where this data belongs, just insert it.
2471
1808
                            new_details.append(DirState.NULL_PARENT_DETAILS)
2472
1809
                        else:
2473
1810
                            # grab any one entry, use it to find the right path.
2474
 
                            # TODO: optimise this to reduce memory use in highly
 
1811
                            # TODO: optimise this to reduce memory use in highly 
2475
1812
                            # fragmented situations by reusing the relocation
2476
1813
                            # records.
2477
1814
                            a_key = iter(id_index[file_id]).next()
2504
1841
        try to keep everything in sorted blocks all the time, but sometimes
2505
1842
        it's easier to sort after the fact.
2506
1843
        """
 
1844
        # TODO: Might be faster to do a schwartzian transform?
2507
1845
        def _key(entry):
2508
1846
            # sort by: directory parts, file name, file id
2509
1847
            return entry[0][0].split('/'), entry[0][1], entry[0][2]
2510
1848
        return sorted(entry_list, key=_key)
2511
1849
 
2512
1850
    def set_state_from_inventory(self, new_inv):
2513
 
        """Set new_inv as the current state.
 
1851
        """Set new_inv as the current state. 
2514
1852
 
2515
1853
        This API is called by tree transform, and will usually occur with
2516
1854
        existing parent trees.
2517
1855
 
2518
1856
        :param new_inv: The inventory object to set current state from.
2519
1857
        """
2520
 
        if 'evil' in debug.debug_flags:
2521
 
            trace.mutter_callsite(1,
2522
 
                "set_state_from_inventory called; please mutate the tree instead")
2523
 
        tracing = 'dirstate' in debug.debug_flags
2524
 
        if tracing:
2525
 
            trace.mutter("set_state_from_inventory trace:")
2526
1858
        self._read_dirblocks_if_needed()
2527
1859
        # sketch:
2528
 
        # Two iterators: current data and new data, both in dirblock order.
2529
 
        # We zip them together, which tells about entries that are new in the
2530
 
        # inventory, or removed in the inventory, or present in both and
2531
 
        # possibly changed.
2532
 
        #
2533
 
        # You might think we could just synthesize a new dirstate directly
2534
 
        # since we're processing it in the right order.  However, we need to
2535
 
        # also consider there may be any number of parent trees and relocation
2536
 
        # pointers, and we don't want to duplicate that here.
 
1860
        # incremental algorithm:
 
1861
        # two iterators: current data and new data, both in dirblock order. 
2537
1862
        new_iterator = new_inv.iter_entries_by_dir()
2538
1863
        # we will be modifying the dirstate, so we need a stable iterator. In
2539
1864
        # future we might write one, for now we just clone the state into a
2540
 
        # list using a copy so that we see every original item and don't have
2541
 
        # to adjust the position when items are inserted or deleted in the
2542
 
        # underlying dirstate.
 
1865
        # list - which is a shallow copy, so each 
2543
1866
        old_iterator = iter(list(self._iter_entries()))
2544
1867
        # both must have roots so this is safe:
2545
1868
        current_new = new_iterator.next()
2551
1874
                return None
2552
1875
        while current_new or current_old:
2553
1876
            # skip entries in old that are not really there
2554
 
            if current_old and current_old[1][0][0] in 'ar':
 
1877
            if current_old and current_old[1][0][0] in ('r', 'a'):
2555
1878
                # relocated or absent
2556
1879
                current_old = advance(old_iterator)
2557
1880
                continue
2564
1887
                current_new_minikind = \
2565
1888
                    DirState._kind_to_minikind[current_new[1].kind]
2566
1889
                if current_new_minikind == 't':
2567
 
                    fingerprint = current_new[1].reference_revision or ''
 
1890
                    fingerprint = current_new[1].reference_revision
2568
1891
                else:
2569
 
                    # We normally only insert or remove records, or update
2570
 
                    # them when it has significantly changed.  Then we want to
2571
 
                    # erase its fingerprint.  Unaffected records should
2572
 
                    # normally not be updated at all.
2573
1892
                    fingerprint = ''
2574
1893
            else:
2575
1894
                # for safety disable variables
2576
 
                new_path_utf8 = new_dirname = new_basename = new_id = \
2577
 
                    new_entry_key = None
 
1895
                new_path_utf8 = new_dirname = new_basename = new_id = new_entry_key = None
2578
1896
            # 5 cases, we dont have a value that is strictly greater than everything, so
2579
1897
            # we make both end conditions explicit
2580
1898
            if not current_old:
2581
1899
                # old is finished: insert current_new into the state.
2582
 
                if tracing:
2583
 
                    trace.mutter("Appending from new '%s'.",
2584
 
                        new_path_utf8.decode('utf8'))
2585
1900
                self.update_minimal(new_entry_key, current_new_minikind,
2586
1901
                    executable=current_new[1].executable,
2587
 
                    path_utf8=new_path_utf8, fingerprint=fingerprint,
2588
 
                    fullscan=True)
 
1902
                    path_utf8=new_path_utf8, fingerprint=fingerprint)
2589
1903
                current_new = advance(new_iterator)
2590
1904
            elif not current_new:
2591
1905
                # new is finished
2592
 
                if tracing:
2593
 
                    trace.mutter("Truncating from old '%s/%s'.",
2594
 
                        current_old[0][0].decode('utf8'),
2595
 
                        current_old[0][1].decode('utf8'))
2596
1906
                self._make_absent(current_old)
2597
1907
                current_old = advance(old_iterator)
2598
1908
            elif new_entry_key == current_old[0]:
2599
1909
                # same -  common case
2600
 
                # We're looking at the same path and id in both the dirstate
2601
 
                # and inventory, so just need to update the fields in the
2602
 
                # dirstate from the one in the inventory.
2603
1910
                # TODO: update the record if anything significant has changed.
2604
1911
                # the minimal required trigger is if the execute bit or cached
2605
1912
                # kind has changed.
2606
1913
                if (current_old[1][0][3] != current_new[1].executable or
2607
1914
                    current_old[1][0][0] != current_new_minikind):
2608
 
                    if tracing:
2609
 
                        trace.mutter("Updating in-place change '%s'.",
2610
 
                            new_path_utf8.decode('utf8'))
2611
1915
                    self.update_minimal(current_old[0], current_new_minikind,
2612
1916
                        executable=current_new[1].executable,
2613
 
                        path_utf8=new_path_utf8, fingerprint=fingerprint,
2614
 
                        fullscan=True)
 
1917
                        path_utf8=new_path_utf8, fingerprint=fingerprint)
2615
1918
                # both sides are dealt with, move on
2616
1919
                current_old = advance(old_iterator)
2617
1920
                current_new = advance(new_iterator)
2618
 
            elif (cmp_by_dirs(new_dirname, current_old[0][0]) < 0
2619
 
                  or (new_dirname == current_old[0][0]
2620
 
                      and new_entry_key[1:] < current_old[0][1:])):
 
1921
            elif (new_entry_key[0].split('/') < current_old[0][0].split('/')
 
1922
                  and new_entry_key[1:] < current_old[0][1:]):
2621
1923
                # new comes before:
2622
1924
                # add a entry for this and advance new
2623
 
                if tracing:
2624
 
                    trace.mutter("Inserting from new '%s'.",
2625
 
                        new_path_utf8.decode('utf8'))
2626
1925
                self.update_minimal(new_entry_key, current_new_minikind,
2627
1926
                    executable=current_new[1].executable,
2628
 
                    path_utf8=new_path_utf8, fingerprint=fingerprint,
2629
 
                    fullscan=True)
 
1927
                    path_utf8=new_path_utf8, fingerprint=fingerprint)
2630
1928
                current_new = advance(new_iterator)
2631
1929
            else:
2632
 
                # we've advanced past the place where the old key would be,
2633
 
                # without seeing it in the new list.  so it must be gone.
2634
 
                if tracing:
2635
 
                    trace.mutter("Deleting from old '%s/%s'.",
2636
 
                        current_old[0][0].decode('utf8'),
2637
 
                        current_old[0][1].decode('utf8'))
 
1930
                # old comes before:
2638
1931
                self._make_absent(current_old)
2639
1932
                current_old = advance(old_iterator)
2640
1933
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
2641
1934
        self._id_index = None
2642
 
        self._packed_stat_index = None
2643
 
        if tracing:
2644
 
            trace.mutter("set_state_from_inventory complete.")
2645
1935
 
2646
1936
    def _make_absent(self, current_old):
2647
1937
        """Mark current_old - an entry - as absent for tree 0.
2648
1938
 
2649
 
        :return: True if this was the last details entry for the entry key:
 
1939
        :return: True if this was the last details entry for they entry key:
2650
1940
            that is, if the underlying block has had the entry removed, thus
2651
1941
            shrinking in length.
2652
1942
        """
2653
1943
        # build up paths that this id will be left at after the change is made,
2654
1944
        # so we can update their cross references in tree 0
2655
1945
        all_remaining_keys = set()
2656
 
        # Dont check the working tree, because it's going.
 
1946
        # Dont check the working tree, because its going.
2657
1947
        for details in current_old[1][1:]:
2658
 
            if details[0] not in 'ar': # absent, relocated
 
1948
            if details[0] not in ('a', 'r'): # absent, relocated
2659
1949
                all_remaining_keys.add(current_old[0])
2660
1950
            elif details[0] == 'r': # relocated
2661
1951
                # record the key for the real path.
2668
1958
            # Remove it, its meaningless.
2669
1959
            block = self._find_block(current_old[0])
2670
1960
            entry_index, present = self._find_entry_index(current_old[0], block[1])
2671
 
            if not present:
2672
 
                raise AssertionError('could not find entry for %s' % (current_old,))
 
1961
            assert present, 'could not find entry for %s' % (current_old,)
2673
1962
            block[1].pop(entry_index)
2674
1963
            # if we have an id_index in use, remove this key from it for this id.
2675
1964
            if self._id_index is not None:
2676
1965
                self._id_index[current_old[0][2]].remove(current_old[0])
2677
1966
        # update all remaining keys for this id to record it as absent. The
2678
 
        # existing details may either be the record we are marking as deleted
 
1967
        # existing details may either be the record we are making as deleted
2679
1968
        # (if there were other trees with the id present at this path), or may
2680
1969
        # be relocations.
2681
1970
        for update_key in all_remaining_keys:
2682
1971
            update_block_index, present = \
2683
1972
                self._find_block_index_from_key(update_key)
2684
 
            if not present:
2685
 
                raise AssertionError('could not find block for %s' % (update_key,))
 
1973
            assert present, 'could not find block for %s' % (update_key,)
2686
1974
            update_entry_index, present = \
2687
1975
                self._find_entry_index(update_key, self._dirblocks[update_block_index][1])
2688
 
            if not present:
2689
 
                raise AssertionError('could not find entry for %s' % (update_key,))
 
1976
            assert present, 'could not find entry for %s' % (update_key,)
2690
1977
            update_tree_details = self._dirblocks[update_block_index][1][update_entry_index][1]
2691
1978
            # it must not be absent at the moment
2692
 
            if update_tree_details[0][0] == 'a': # absent
2693
 
                raise AssertionError('bad row %r' % (update_tree_details,))
 
1979
            assert update_tree_details[0][0] != 'a' # absent
2694
1980
            update_tree_details[0] = DirState.NULL_PARENT_DETAILS
2695
1981
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
2696
1982
        return last_reference
2697
1983
 
2698
1984
    def update_minimal(self, key, minikind, executable=False, fingerprint='',
2699
 
        packed_stat=None, size=0, path_utf8=None, fullscan=False):
 
1985
                       packed_stat=None, size=0, path_utf8=None):
2700
1986
        """Update an entry to the state in tree 0.
2701
1987
 
2702
1988
        This will either create a new entry at 'key' or update an existing one.
2707
1993
        :param minikind: The type for the entry ('f' == 'file', 'd' ==
2708
1994
                'directory'), etc.
2709
1995
        :param executable: Should the executable bit be set?
2710
 
        :param fingerprint: Simple fingerprint for new entry: canonical-form
2711
 
            sha1 for files, referenced revision id for subtrees, etc.
2712
 
        :param packed_stat: Packed stat value for new entry.
 
1996
        :param fingerprint: Simple fingerprint for new entry.
 
1997
        :param packed_stat: packed stat value for new entry.
2713
1998
        :param size: Size information for new entry
2714
1999
        :param path_utf8: key[0] + '/' + key[1], just passed in to avoid doing
2715
2000
                extra computation.
2716
 
        :param fullscan: If True then a complete scan of the dirstate is being
2717
 
            done and checking for duplicate rows should not be done. This
2718
 
            should only be set by set_state_from_inventory and similar methods.
2719
 
 
2720
 
        If packed_stat and fingerprint are not given, they're invalidated in
2721
 
        the entry.
2722
2001
        """
2723
2002
        block = self._find_block(key)[1]
2724
2003
        if packed_stat is None:
2725
2004
            packed_stat = DirState.NULLSTAT
2726
 
        # XXX: Some callers pass '' as the packed_stat, and it seems to be
2727
 
        # sometimes present in the dirstate - this seems oddly inconsistent.
2728
 
        # mbp 20071008
2729
2005
        entry_index, present = self._find_entry_index(key, block)
2730
2006
        new_details = (minikind, fingerprint, size, executable, packed_stat)
2731
2007
        id_index = self._get_id_index()
2732
2008
        if not present:
2733
 
            # New record. Check there isn't a entry at this path already.
2734
 
            if not fullscan:
2735
 
                low_index, _ = self._find_entry_index(key[0:2] + ('',), block)
2736
 
                while low_index < len(block):
2737
 
                    entry = block[low_index]
2738
 
                    if entry[0][0:2] == key[0:2]:
2739
 
                        if entry[1][0][0] not in 'ar':
2740
 
                            # This entry has the same path (but a different id) as
2741
 
                            # the new entry we're adding, and is present in ths
2742
 
                            # tree.
2743
 
                            raise errors.InconsistentDelta(
2744
 
                                ("%s/%s" % key[0:2]).decode('utf8'), key[2],
2745
 
                                "Attempt to add item at path already occupied by "
2746
 
                                "id %r" % entry[0][2])
2747
 
                        low_index += 1
2748
 
                    else:
2749
 
                        break
2750
2009
            # new entry, synthesis cross reference here,
2751
2010
            existing_keys = id_index.setdefault(key[2], set())
2752
2011
            if not existing_keys:
2757
2016
                # grab one of them and use it to generate parent
2758
2017
                # relocation/absent entries.
2759
2018
                new_entry = key, [new_details]
2760
 
                # existing_keys can be changed as we iterate.
2761
 
                for other_key in tuple(existing_keys):
 
2019
                for other_key in existing_keys:
2762
2020
                    # change the record at other to be a pointer to this new
2763
2021
                    # record. The loop looks similar to the change to
2764
2022
                    # relocations when updating an existing record but its not:
2765
2023
                    # the test for existing kinds is different: this can be
2766
2024
                    # factored out to a helper though.
2767
 
                    other_block_index, present = self._find_block_index_from_key(
2768
 
                        other_key)
2769
 
                    if not present:
2770
 
                        raise AssertionError('could not find block for %s' % (
2771
 
                            other_key,))
2772
 
                    other_block = self._dirblocks[other_block_index][1]
2773
 
                    other_entry_index, present = self._find_entry_index(
2774
 
                        other_key, other_block)
2775
 
                    if not present:
2776
 
                        raise AssertionError(
2777
 
                            'update_minimal: could not find other entry for %s'
2778
 
                            % (other_key,))
2779
 
                    if path_utf8 is None:
2780
 
                        raise AssertionError('no path')
2781
 
                    # Turn this other location into a reference to the new
2782
 
                    # location. This also updates the aliased iterator
2783
 
                    # (current_old in set_state_from_inventory) so that the old
2784
 
                    # entry, if not already examined, is skipped over by that
2785
 
                    # loop.
2786
 
                    other_entry = other_block[other_entry_index]
2787
 
                    other_entry[1][0] = ('r', path_utf8, 0, False, '')
2788
 
                    self._maybe_remove_row(other_block, other_entry_index,
2789
 
                        id_index)
 
2025
                    other_block_index, present = self._find_block_index_from_key(other_key)
 
2026
                    assert present, 'could not find block for %s' % (other_key,)
 
2027
                    other_entry_index, present = self._find_entry_index(other_key,
 
2028
                                            self._dirblocks[other_block_index][1])
 
2029
                    assert present, 'could not find entry for %s' % (other_key,)
 
2030
                    assert path_utf8 is not None
 
2031
                    self._dirblocks[other_block_index][1][other_entry_index][1][0] = \
 
2032
                        ('r', path_utf8, 0, False, '')
2790
2033
 
2791
 
                # This loop:
2792
 
                # adds a tuple to the new details for each column
2793
 
                #  - either by copying an existing relocation pointer inside that column
2794
 
                #  - or by creating a new pointer to the right row inside that column
2795
2034
                num_present_parents = self._num_present_parents()
2796
 
                if num_present_parents:
2797
 
                    other_key = list(existing_keys)[0]
2798
2035
                for lookup_index in xrange(1, num_present_parents + 1):
2799
2036
                    # grab any one entry, use it to find the right path.
2800
 
                    # TODO: optimise this to reduce memory use in highly
 
2037
                    # TODO: optimise this to reduce memory use in highly 
2801
2038
                    # fragmented situations by reusing the relocation
2802
2039
                    # records.
2803
2040
                    update_block_index, present = \
2804
2041
                        self._find_block_index_from_key(other_key)
2805
 
                    if not present:
2806
 
                        raise AssertionError('could not find block for %s' % (other_key,))
 
2042
                    assert present, 'could not find block for %s' % (other_key,)
2807
2043
                    update_entry_index, present = \
2808
2044
                        self._find_entry_index(other_key, self._dirblocks[update_block_index][1])
2809
 
                    if not present:
2810
 
                        raise AssertionError('update_minimal: could not find entry for %s' % (other_key,))
 
2045
                    assert present, 'could not find entry for %s' % (other_key,)
2811
2046
                    update_details = self._dirblocks[update_block_index][1][update_entry_index][1][lookup_index]
2812
 
                    if update_details[0] in 'ar': # relocated, absent
 
2047
                    if update_details[0] in ('r', 'a'): # relocated, absent
2813
2048
                        # its a pointer or absent in lookup_index's tree, use
2814
2049
                        # it as is.
2815
2050
                        new_entry[1].append(update_details)
2820
2055
            block.insert(entry_index, new_entry)
2821
2056
            existing_keys.add(key)
2822
2057
        else:
2823
 
            # Does the new state matter?
 
2058
            # Does the new state matter? 
2824
2059
            block[entry_index][1][0] = new_details
2825
2060
            # parents cannot be affected by what we do.
2826
 
            # other occurences of this id can be found
 
2061
            # other occurences of this id can be found 
2827
2062
            # from the id index.
2828
2063
            # ---
2829
2064
            # tree index consistency: All other paths for this id in this tree
2831
2066
            # we may have passed entries in the state with this file id already
2832
2067
            # that were absent - where parent entries are - and they need to be
2833
2068
            # converted to relocated.
2834
 
            if path_utf8 is None:
2835
 
                raise AssertionError('no path')
 
2069
            assert path_utf8 is not None
2836
2070
            for entry_key in id_index.setdefault(key[2], set()):
2837
2071
                # TODO:PROFILING: It might be faster to just update
2838
2072
                # rather than checking if we need to, and then overwrite
2843
2077
                    # This is the vertical axis in the matrix, all pointing
2844
2078
                    # to the real path.
2845
2079
                    block_index, present = self._find_block_index_from_key(entry_key)
2846
 
                    if not present:
2847
 
                        raise AssertionError('not present: %r', entry_key)
 
2080
                    assert present
2848
2081
                    entry_index, present = self._find_entry_index(entry_key, self._dirblocks[block_index][1])
2849
 
                    if not present:
2850
 
                        raise AssertionError('not present: %r', entry_key)
 
2082
                    assert present
2851
2083
                    self._dirblocks[block_index][1][entry_index][1][0] = \
2852
2084
                        ('r', path_utf8, 0, False, '')
2853
2085
        # add a containing dirblock if needed.
2859
2091
 
2860
2092
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
2861
2093
 
2862
 
    def _maybe_remove_row(self, block, index, id_index):
2863
 
        """Remove index if it is absent or relocated across the row.
2864
 
        
2865
 
        id_index is updated accordingly.
2866
 
        """
2867
 
        present_in_row = False
2868
 
        entry = block[index]
2869
 
        for column in entry[1]:
2870
 
            if column[0] not in 'ar':
2871
 
                present_in_row = True
2872
 
                break
2873
 
        if not present_in_row:
2874
 
            block.pop(index)
2875
 
            id_index[entry[0][2]].remove(entry[0])
2876
 
 
2877
2094
    def _validate(self):
2878
2095
        """Check that invariants on the dirblock are correct.
2879
2096
 
2880
 
        This can be useful in debugging; it shouldn't be necessary in
 
2097
        This can be useful in debugging; it shouldn't be necessary in 
2881
2098
        normal code.
2882
2099
 
2883
2100
        This must be called with a lock held.
2899
2116
            if not self._dirblocks[0][0] == '':
2900
2117
                raise AssertionError(
2901
2118
                    "dirblocks don't start with root block:\n" + \
2902
 
                    pformat(self._dirblocks))
 
2119
                    pformat(dirblocks))
2903
2120
        if len(self._dirblocks) > 1:
2904
2121
            if not self._dirblocks[1][0] == '':
2905
2122
                raise AssertionError(
2906
2123
                    "dirblocks missing root directory:\n" + \
2907
 
                    pformat(self._dirblocks))
 
2124
                    pformat(dirblocks))
2908
2125
        # the dirblocks are sorted by their path components, name, and dir id
2909
2126
        dir_names = [d[0].split('/')
2910
2127
                for d in self._dirblocks[1:]]
2928
2145
                    "dirblock for %r is not sorted:\n%s" % \
2929
2146
                    (dirblock[0], pformat(dirblock)))
2930
2147
 
 
2148
 
2931
2149
        def check_valid_parent():
2932
2150
            """Check that the current entry has a valid parent.
2933
2151
 
2952
2170
        # For each file id, for each tree: either
2953
2171
        # the file id is not present at all; all rows with that id in the
2954
2172
        # key have it marked as 'absent'
2955
 
        # OR the file id is present under exactly one name; any other entries
 
2173
        # OR the file id is present under exactly one name; any other entries 
2956
2174
        # that mention that id point to the correct name.
2957
2175
        #
2958
2176
        # We check this with a dict per tree pointing either to the present
2968
2186
                "wrong number of entry details for row\n%s" \
2969
2187
                ",\nexpected %d" % \
2970
2188
                (pformat(entry), tree_count))
2971
 
            absent_positions = 0
2972
2189
            for tree_index, tree_state in enumerate(entry[1]):
2973
2190
                this_tree_map = id_path_maps[tree_index]
2974
2191
                minikind = tree_state[0]
2975
 
                if minikind in 'ar':
2976
 
                    absent_positions += 1
2977
2192
                # have we seen this id before in this column?
2978
2193
                if file_id in this_tree_map:
2979
 
                    previous_path, previous_loc = this_tree_map[file_id]
 
2194
                    previous_path = this_tree_map[file_id]
2980
2195
                    # any later mention of this file must be consistent with
2981
2196
                    # what was said before
2982
2197
                    if minikind == 'a':
2996
2211
                        # pointed to by a relocation, which must point here
2997
2212
                        if previous_path != this_path:
2998
2213
                            raise AssertionError(
2999
 
                                "entry %r inconsistent with previous path %r "
3000
 
                                "seen at %r" %
3001
 
                                (entry, previous_path, previous_loc))
 
2214
                            "entry %r inconsistent with previous path %r" % \
 
2215
                            (entry, previous_path))
3002
2216
                        check_valid_parent()
3003
2217
                else:
3004
2218
                    if minikind == 'a':
3005
2219
                        # absent; should not occur anywhere else
3006
 
                        this_tree_map[file_id] = None, this_path
 
2220
                        this_tree_map[file_id] = None
3007
2221
                    elif minikind == 'r':
3008
 
                        # relocation, must occur at expected location
3009
 
                        this_tree_map[file_id] = tree_state[1], this_path
 
2222
                        # relocation, must occur at expected location 
 
2223
                        this_tree_map[file_id] = tree_state[1]
3010
2224
                    else:
3011
 
                        this_tree_map[file_id] = this_path, this_path
 
2225
                        this_tree_map[file_id] = this_path
3012
2226
                        check_valid_parent()
3013
 
            if absent_positions == tree_count:
3014
 
                raise AssertionError(
3015
 
                    "entry %r has no data for any tree." % (entry,))
3016
2227
 
3017
2228
    def _wipe_state(self):
3018
2229
        """Forget all state information about the dirstate."""
3019
2230
        self._header_state = DirState.NOT_IN_MEMORY
3020
2231
        self._dirblock_state = DirState.NOT_IN_MEMORY
3021
 
        self._changes_aborted = False
3022
2232
        self._parents = []
3023
2233
        self._ghosts = []
3024
2234
        self._dirblocks = []
3025
2235
        self._id_index = None
3026
 
        self._packed_stat_index = None
3027
2236
        self._end_of_header = None
3028
2237
        self._cutoff_time = None
3029
2238
        self._split_path_cache = {}
3030
2239
 
3031
2240
    def lock_read(self):
3032
 
        """Acquire a read lock on the dirstate."""
 
2241
        """Acquire a read lock on the dirstate"""
3033
2242
        if self._lock_token is not None:
3034
2243
            raise errors.LockContention(self._lock_token)
3035
2244
        # TODO: jam 20070301 Rather than wiping completely, if the blocks are
3042
2251
        self._wipe_state()
3043
2252
 
3044
2253
    def lock_write(self):
3045
 
        """Acquire a write lock on the dirstate."""
 
2254
        """Acquire a write lock on the dirstate"""
3046
2255
        if self._lock_token is not None:
3047
2256
            raise errors.LockContention(self._lock_token)
3048
2257
        # TODO: jam 20070301 Rather than wiping completely, if the blocks are
3055
2264
        self._wipe_state()
3056
2265
 
3057
2266
    def unlock(self):
3058
 
        """Drop any locks held on the dirstate."""
 
2267
        """Drop any locks held on the dirstate"""
3059
2268
        if self._lock_token is None:
3060
2269
            raise errors.LockNotHeld(self)
3061
2270
        # TODO: jam 20070301 Rather than wiping completely, if the blocks are
3069
2278
        self._split_path_cache = {}
3070
2279
 
3071
2280
    def _requires_lock(self):
3072
 
        """Check that a lock is currently held by someone on the dirstate."""
 
2281
        """Checks that a lock is currently held by someone on the dirstate"""
3073
2282
        if not self._lock_token:
3074
2283
            raise errors.ObjectNotLocked(self)
3075
2284
 
3076
2285
 
3077
 
def py_update_entry(state, entry, abspath, stat_value,
3078
 
                 _stat_to_minikind=DirState._stat_to_minikind,
3079
 
                 _pack_stat=pack_stat):
3080
 
    """Update the entry based on what is actually on disk.
3081
 
 
3082
 
    This function only calculates the sha if it needs to - if the entry is
3083
 
    uncachable, or clearly different to the first parent's entry, no sha
3084
 
    is calculated, and None is returned.
3085
 
 
3086
 
    :param state: The dirstate this entry is in.
3087
 
    :param entry: This is the dirblock entry for the file in question.
3088
 
    :param abspath: The path on disk for this file.
3089
 
    :param stat_value: The stat value done on the path.
3090
 
    :return: None, or The sha1 hexdigest of the file (40 bytes) or link
3091
 
        target of a symlink.
3092
 
    """
3093
 
    try:
3094
 
        minikind = _stat_to_minikind[stat_value.st_mode & 0170000]
3095
 
    except KeyError:
3096
 
        # Unhandled kind
3097
 
        return None
3098
 
    packed_stat = _pack_stat(stat_value)
3099
 
    (saved_minikind, saved_link_or_sha1, saved_file_size,
3100
 
     saved_executable, saved_packed_stat) = entry[1][0]
3101
 
 
3102
 
    if minikind == 'd' and saved_minikind == 't':
3103
 
        minikind = 't'
3104
 
    if (minikind == saved_minikind
3105
 
        and packed_stat == saved_packed_stat):
3106
 
        # The stat hasn't changed since we saved, so we can re-use the
3107
 
        # saved sha hash.
3108
 
        if minikind == 'd':
3109
 
            return None
3110
 
 
3111
 
        # size should also be in packed_stat
3112
 
        if saved_file_size == stat_value.st_size:
3113
 
            return saved_link_or_sha1
3114
 
 
3115
 
    # If we have gotten this far, that means that we need to actually
3116
 
    # process this entry.
3117
 
    link_or_sha1 = None
3118
 
    if minikind == 'f':
3119
 
        executable = state._is_executable(stat_value.st_mode,
3120
 
                                         saved_executable)
3121
 
        if state._cutoff_time is None:
3122
 
            state._sha_cutoff_time()
3123
 
        if (stat_value.st_mtime < state._cutoff_time
3124
 
            and stat_value.st_ctime < state._cutoff_time
3125
 
            and len(entry[1]) > 1
3126
 
            and entry[1][1][0] != 'a'):
3127
 
            # Could check for size changes for further optimised
3128
 
            # avoidance of sha1's. However the most prominent case of
3129
 
            # over-shaing is during initial add, which this catches.
3130
 
            # Besides, if content filtering happens, size and sha
3131
 
            # are calculated at the same time, so checking just the size
3132
 
            # gains nothing w.r.t. performance.
3133
 
            link_or_sha1 = state._sha1_file(abspath)
3134
 
            entry[1][0] = ('f', link_or_sha1, stat_value.st_size,
3135
 
                           executable, packed_stat)
3136
 
        else:
3137
 
            entry[1][0] = ('f', '', stat_value.st_size,
3138
 
                           executable, DirState.NULLSTAT)
3139
 
    elif minikind == 'd':
3140
 
        link_or_sha1 = None
3141
 
        entry[1][0] = ('d', '', 0, False, packed_stat)
3142
 
        if saved_minikind != 'd':
3143
 
            # This changed from something into a directory. Make sure we
3144
 
            # have a directory block for it. This doesn't happen very
3145
 
            # often, so this doesn't have to be super fast.
3146
 
            block_index, entry_index, dir_present, file_present = \
3147
 
                state._get_block_entry_index(entry[0][0], entry[0][1], 0)
3148
 
            state._ensure_block(block_index, entry_index,
3149
 
                               osutils.pathjoin(entry[0][0], entry[0][1]))
3150
 
    elif minikind == 'l':
3151
 
        link_or_sha1 = state._read_link(abspath, saved_link_or_sha1)
3152
 
        if state._cutoff_time is None:
3153
 
            state._sha_cutoff_time()
3154
 
        if (stat_value.st_mtime < state._cutoff_time
3155
 
            and stat_value.st_ctime < state._cutoff_time):
3156
 
            entry[1][0] = ('l', link_or_sha1, stat_value.st_size,
3157
 
                           False, packed_stat)
3158
 
        else:
3159
 
            entry[1][0] = ('l', '', stat_value.st_size,
3160
 
                           False, DirState.NULLSTAT)
3161
 
    state._dirblock_state = DirState.IN_MEMORY_MODIFIED
3162
 
    return link_or_sha1
3163
 
 
3164
 
 
3165
 
class ProcessEntryPython(object):
3166
 
 
3167
 
    __slots__ = ["old_dirname_to_file_id", "new_dirname_to_file_id",
3168
 
        "last_source_parent", "last_target_parent", "include_unchanged",
3169
 
        "use_filesystem_for_exec", "utf8_decode", "searched_specific_files",
3170
 
        "search_specific_files", "state", "source_index", "target_index",
3171
 
        "want_unversioned", "tree"]
3172
 
 
3173
 
    def __init__(self, include_unchanged, use_filesystem_for_exec,
3174
 
        search_specific_files, state, source_index, target_index,
3175
 
        want_unversioned, tree):
3176
 
        self.old_dirname_to_file_id = {}
3177
 
        self.new_dirname_to_file_id = {}
3178
 
        # Using a list so that we can access the values and change them in
3179
 
        # nested scope. Each one is [path, file_id, entry]
3180
 
        self.last_source_parent = [None, None]
3181
 
        self.last_target_parent = [None, None]
3182
 
        self.include_unchanged = include_unchanged
3183
 
        self.use_filesystem_for_exec = use_filesystem_for_exec
3184
 
        self.utf8_decode = cache_utf8._utf8_decode
3185
 
        # for all search_indexs in each path at or under each element of
3186
 
        # search_specific_files, if the detail is relocated: add the id, and add the
3187
 
        # relocated path as one to search if its not searched already. If the
3188
 
        # detail is not relocated, add the id.
3189
 
        self.searched_specific_files = set()
3190
 
        self.search_specific_files = search_specific_files
3191
 
        self.state = state
3192
 
        self.source_index = source_index
3193
 
        self.target_index = target_index
3194
 
        self.want_unversioned = want_unversioned
3195
 
        self.tree = tree
3196
 
 
3197
 
    def _process_entry(self, entry, path_info, pathjoin=osutils.pathjoin):
3198
 
        """Compare an entry and real disk to generate delta information.
3199
 
 
3200
 
        :param path_info: top_relpath, basename, kind, lstat, abspath for
3201
 
            the path of entry. If None, then the path is considered absent.
3202
 
            (Perhaps we should pass in a concrete entry for this ?)
3203
 
            Basename is returned as a utf8 string because we expect this
3204
 
            tuple will be ignored, and don't want to take the time to
3205
 
            decode.
3206
 
        :return: (iter_changes_result, changed). If the entry has not been
3207
 
            handled then changed is None. Otherwise it is False if no content
3208
 
            or metadata changes have occured, and None if any content or
3209
 
            metadata change has occured. If self.include_unchanged is True then
3210
 
            if changed is not None, iter_changes_result will always be a result
3211
 
            tuple. Otherwise, iter_changes_result is None unless changed is
3212
 
            True.
3213
 
        """
3214
 
        if self.source_index is None:
3215
 
            source_details = DirState.NULL_PARENT_DETAILS
3216
 
        else:
3217
 
            source_details = entry[1][self.source_index]
3218
 
        target_details = entry[1][self.target_index]
3219
 
        target_minikind = target_details[0]
3220
 
        if path_info is not None and target_minikind in 'fdlt':
3221
 
            if not (self.target_index == 0):
3222
 
                raise AssertionError()
3223
 
            link_or_sha1 = update_entry(self.state, entry,
3224
 
                abspath=path_info[4], stat_value=path_info[3])
3225
 
            # The entry may have been modified by update_entry
3226
 
            target_details = entry[1][self.target_index]
3227
 
            target_minikind = target_details[0]
3228
 
        else:
3229
 
            link_or_sha1 = None
3230
 
        file_id = entry[0][2]
3231
 
        source_minikind = source_details[0]
3232
 
        if source_minikind in 'fdltr' and target_minikind in 'fdlt':
3233
 
            # claimed content in both: diff
3234
 
            #   r    | fdlt   |      | add source to search, add id path move and perform
3235
 
            #        |        |      | diff check on source-target
3236
 
            #   r    | fdlt   |  a   | dangling file that was present in the basis.
3237
 
            #        |        |      | ???
3238
 
            if source_minikind in 'r':
3239
 
                # add the source to the search path to find any children it
3240
 
                # has.  TODO ? : only add if it is a container ?
3241
 
                if not osutils.is_inside_any(self.searched_specific_files,
3242
 
                                             source_details[1]):
3243
 
                    self.search_specific_files.add(source_details[1])
3244
 
                # generate the old path; this is needed for stating later
3245
 
                # as well.
3246
 
                old_path = source_details[1]
3247
 
                old_dirname, old_basename = os.path.split(old_path)
3248
 
                path = pathjoin(entry[0][0], entry[0][1])
3249
 
                old_entry = self.state._get_entry(self.source_index,
3250
 
                                             path_utf8=old_path)
3251
 
                # update the source details variable to be the real
3252
 
                # location.
3253
 
                if old_entry == (None, None):
3254
 
                    raise errors.CorruptDirstate(self.state._filename,
3255
 
                        "entry '%s/%s' is considered renamed from %r"
3256
 
                        " but source does not exist\n"
3257
 
                        "entry: %s" % (entry[0][0], entry[0][1], old_path, entry))
3258
 
                source_details = old_entry[1][self.source_index]
3259
 
                source_minikind = source_details[0]
3260
 
            else:
3261
 
                old_dirname = entry[0][0]
3262
 
                old_basename = entry[0][1]
3263
 
                old_path = path = None
3264
 
            if path_info is None:
3265
 
                # the file is missing on disk, show as removed.
3266
 
                content_change = True
3267
 
                target_kind = None
3268
 
                target_exec = False
3269
 
            else:
3270
 
                # source and target are both versioned and disk file is present.
3271
 
                target_kind = path_info[2]
3272
 
                if target_kind == 'directory':
3273
 
                    if path is None:
3274
 
                        old_path = path = pathjoin(old_dirname, old_basename)
3275
 
                    self.new_dirname_to_file_id[path] = file_id
3276
 
                    if source_minikind != 'd':
3277
 
                        content_change = True
3278
 
                    else:
3279
 
                        # directories have no fingerprint
3280
 
                        content_change = False
3281
 
                    target_exec = False
3282
 
                elif target_kind == 'file':
3283
 
                    if source_minikind != 'f':
3284
 
                        content_change = True
3285
 
                    else:
3286
 
                        # Check the sha. We can't just rely on the size as
3287
 
                        # content filtering may mean differ sizes actually
3288
 
                        # map to the same content
3289
 
                        if link_or_sha1 is None:
3290
 
                            # Stat cache miss:
3291
 
                            statvalue, link_or_sha1 = \
3292
 
                                self.state._sha1_provider.stat_and_sha1(
3293
 
                                path_info[4])
3294
 
                            self.state._observed_sha1(entry, link_or_sha1,
3295
 
                                statvalue)
3296
 
                        content_change = (link_or_sha1 != source_details[1])
3297
 
                    # Target details is updated at update_entry time
3298
 
                    if self.use_filesystem_for_exec:
3299
 
                        # We don't need S_ISREG here, because we are sure
3300
 
                        # we are dealing with a file.
3301
 
                        target_exec = bool(stat.S_IEXEC & path_info[3].st_mode)
3302
 
                    else:
3303
 
                        target_exec = target_details[3]
3304
 
                elif target_kind == 'symlink':
3305
 
                    if source_minikind != 'l':
3306
 
                        content_change = True
3307
 
                    else:
3308
 
                        content_change = (link_or_sha1 != source_details[1])
3309
 
                    target_exec = False
3310
 
                elif target_kind == 'tree-reference':
3311
 
                    if source_minikind != 't':
3312
 
                        content_change = True
3313
 
                    else:
3314
 
                        content_change = False
3315
 
                    target_exec = False
3316
 
                else:
3317
 
                    raise Exception, "unknown kind %s" % path_info[2]
3318
 
            if source_minikind == 'd':
3319
 
                if path is None:
3320
 
                    old_path = path = pathjoin(old_dirname, old_basename)
3321
 
                self.old_dirname_to_file_id[old_path] = file_id
3322
 
            # parent id is the entry for the path in the target tree
3323
 
            if old_basename and old_dirname == self.last_source_parent[0]:
3324
 
                source_parent_id = self.last_source_parent[1]
3325
 
            else:
3326
 
                try:
3327
 
                    source_parent_id = self.old_dirname_to_file_id[old_dirname]
3328
 
                except KeyError:
3329
 
                    source_parent_entry = self.state._get_entry(self.source_index,
3330
 
                                                           path_utf8=old_dirname)
3331
 
                    source_parent_id = source_parent_entry[0][2]
3332
 
                if source_parent_id == entry[0][2]:
3333
 
                    # This is the root, so the parent is None
3334
 
                    source_parent_id = None
3335
 
                else:
3336
 
                    self.last_source_parent[0] = old_dirname
3337
 
                    self.last_source_parent[1] = source_parent_id
3338
 
            new_dirname = entry[0][0]
3339
 
            if entry[0][1] and new_dirname == self.last_target_parent[0]:
3340
 
                target_parent_id = self.last_target_parent[1]
3341
 
            else:
3342
 
                try:
3343
 
                    target_parent_id = self.new_dirname_to_file_id[new_dirname]
3344
 
                except KeyError:
3345
 
                    # TODO: We don't always need to do the lookup, because the
3346
 
                    #       parent entry will be the same as the source entry.
3347
 
                    target_parent_entry = self.state._get_entry(self.target_index,
3348
 
                                                           path_utf8=new_dirname)
3349
 
                    if target_parent_entry == (None, None):
3350
 
                        raise AssertionError(
3351
 
                            "Could not find target parent in wt: %s\nparent of: %s"
3352
 
                            % (new_dirname, entry))
3353
 
                    target_parent_id = target_parent_entry[0][2]
3354
 
                if target_parent_id == entry[0][2]:
3355
 
                    # This is the root, so the parent is None
3356
 
                    target_parent_id = None
3357
 
                else:
3358
 
                    self.last_target_parent[0] = new_dirname
3359
 
                    self.last_target_parent[1] = target_parent_id
3360
 
 
3361
 
            source_exec = source_details[3]
3362
 
            changed = (content_change
3363
 
                or source_parent_id != target_parent_id
3364
 
                or old_basename != entry[0][1]
3365
 
                or source_exec != target_exec
3366
 
                )
3367
 
            if not changed and not self.include_unchanged:
3368
 
                return None, False
3369
 
            else:
3370
 
                if old_path is None:
3371
 
                    old_path = path = pathjoin(old_dirname, old_basename)
3372
 
                    old_path_u = self.utf8_decode(old_path)[0]
3373
 
                    path_u = old_path_u
3374
 
                else:
3375
 
                    old_path_u = self.utf8_decode(old_path)[0]
3376
 
                    if old_path == path:
3377
 
                        path_u = old_path_u
3378
 
                    else:
3379
 
                        path_u = self.utf8_decode(path)[0]
3380
 
                source_kind = DirState._minikind_to_kind[source_minikind]
3381
 
                return (entry[0][2],
3382
 
                       (old_path_u, path_u),
3383
 
                       content_change,
3384
 
                       (True, True),
3385
 
                       (source_parent_id, target_parent_id),
3386
 
                       (self.utf8_decode(old_basename)[0], self.utf8_decode(entry[0][1])[0]),
3387
 
                       (source_kind, target_kind),
3388
 
                       (source_exec, target_exec)), changed
3389
 
        elif source_minikind in 'a' and target_minikind in 'fdlt':
3390
 
            # looks like a new file
3391
 
            path = pathjoin(entry[0][0], entry[0][1])
3392
 
            # parent id is the entry for the path in the target tree
3393
 
            # TODO: these are the same for an entire directory: cache em.
3394
 
            parent_id = self.state._get_entry(self.target_index,
3395
 
                                         path_utf8=entry[0][0])[0][2]
3396
 
            if parent_id == entry[0][2]:
3397
 
                parent_id = None
3398
 
            if path_info is not None:
3399
 
                # Present on disk:
3400
 
                if self.use_filesystem_for_exec:
3401
 
                    # We need S_ISREG here, because we aren't sure if this
3402
 
                    # is a file or not.
3403
 
                    target_exec = bool(
3404
 
                        stat.S_ISREG(path_info[3].st_mode)
3405
 
                        and stat.S_IEXEC & path_info[3].st_mode)
3406
 
                else:
3407
 
                    target_exec = target_details[3]
3408
 
                return (entry[0][2],
3409
 
                       (None, self.utf8_decode(path)[0]),
3410
 
                       True,
3411
 
                       (False, True),
3412
 
                       (None, parent_id),
3413
 
                       (None, self.utf8_decode(entry[0][1])[0]),
3414
 
                       (None, path_info[2]),
3415
 
                       (None, target_exec)), True
3416
 
            else:
3417
 
                # Its a missing file, report it as such.
3418
 
                return (entry[0][2],
3419
 
                       (None, self.utf8_decode(path)[0]),
3420
 
                       False,
3421
 
                       (False, True),
3422
 
                       (None, parent_id),
3423
 
                       (None, self.utf8_decode(entry[0][1])[0]),
3424
 
                       (None, None),
3425
 
                       (None, False)), True
3426
 
        elif source_minikind in 'fdlt' and target_minikind in 'a':
3427
 
            # unversioned, possibly, or possibly not deleted: we dont care.
3428
 
            # if its still on disk, *and* theres no other entry at this
3429
 
            # path [we dont know this in this routine at the moment -
3430
 
            # perhaps we should change this - then it would be an unknown.
3431
 
            old_path = pathjoin(entry[0][0], entry[0][1])
3432
 
            # parent id is the entry for the path in the target tree
3433
 
            parent_id = self.state._get_entry(self.source_index, path_utf8=entry[0][0])[0][2]
3434
 
            if parent_id == entry[0][2]:
3435
 
                parent_id = None
3436
 
            return (entry[0][2],
3437
 
                   (self.utf8_decode(old_path)[0], None),
3438
 
                   True,
3439
 
                   (True, False),
3440
 
                   (parent_id, None),
3441
 
                   (self.utf8_decode(entry[0][1])[0], None),
3442
 
                   (DirState._minikind_to_kind[source_minikind], None),
3443
 
                   (source_details[3], None)), True
3444
 
        elif source_minikind in 'fdlt' and target_minikind in 'r':
3445
 
            # a rename; could be a true rename, or a rename inherited from
3446
 
            # a renamed parent. TODO: handle this efficiently. Its not
3447
 
            # common case to rename dirs though, so a correct but slow
3448
 
            # implementation will do.
3449
 
            if not osutils.is_inside_any(self.searched_specific_files, target_details[1]):
3450
 
                self.search_specific_files.add(target_details[1])
3451
 
        elif source_minikind in 'ra' and target_minikind in 'ra':
3452
 
            # neither of the selected trees contain this file,
3453
 
            # so skip over it. This is not currently directly tested, but
3454
 
            # is indirectly via test_too_much.TestCommands.test_conflicts.
3455
 
            pass
3456
 
        else:
3457
 
            raise AssertionError("don't know how to compare "
3458
 
                "source_minikind=%r, target_minikind=%r"
3459
 
                % (source_minikind, target_minikind))
3460
 
            ## import pdb;pdb.set_trace()
3461
 
        return None, None
3462
 
 
3463
 
    def __iter__(self):
3464
 
        return self
3465
 
 
3466
 
    def iter_changes(self):
3467
 
        """Iterate over the changes."""
3468
 
        utf8_decode = cache_utf8._utf8_decode
3469
 
        _cmp_by_dirs = cmp_by_dirs
3470
 
        _process_entry = self._process_entry
3471
 
        search_specific_files = self.search_specific_files
3472
 
        searched_specific_files = self.searched_specific_files
3473
 
        splitpath = osutils.splitpath
3474
 
        # sketch:
3475
 
        # compare source_index and target_index at or under each element of search_specific_files.
3476
 
        # follow the following comparison table. Note that we only want to do diff operations when
3477
 
        # the target is fdl because thats when the walkdirs logic will have exposed the pathinfo
3478
 
        # for the target.
3479
 
        # cases:
3480
 
        #
3481
 
        # Source | Target | disk | action
3482
 
        #   r    | fdlt   |      | add source to search, add id path move and perform
3483
 
        #        |        |      | diff check on source-target
3484
 
        #   r    | fdlt   |  a   | dangling file that was present in the basis.
3485
 
        #        |        |      | ???
3486
 
        #   r    |  a     |      | add source to search
3487
 
        #   r    |  a     |  a   |
3488
 
        #   r    |  r     |      | this path is present in a non-examined tree, skip.
3489
 
        #   r    |  r     |  a   | this path is present in a non-examined tree, skip.
3490
 
        #   a    | fdlt   |      | add new id
3491
 
        #   a    | fdlt   |  a   | dangling locally added file, skip
3492
 
        #   a    |  a     |      | not present in either tree, skip
3493
 
        #   a    |  a     |  a   | not present in any tree, skip
3494
 
        #   a    |  r     |      | not present in either tree at this path, skip as it
3495
 
        #        |        |      | may not be selected by the users list of paths.
3496
 
        #   a    |  r     |  a   | not present in either tree at this path, skip as it
3497
 
        #        |        |      | may not be selected by the users list of paths.
3498
 
        #  fdlt  | fdlt   |      | content in both: diff them
3499
 
        #  fdlt  | fdlt   |  a   | deleted locally, but not unversioned - show as deleted ?
3500
 
        #  fdlt  |  a     |      | unversioned: output deleted id for now
3501
 
        #  fdlt  |  a     |  a   | unversioned and deleted: output deleted id
3502
 
        #  fdlt  |  r     |      | relocated in this tree, so add target to search.
3503
 
        #        |        |      | Dont diff, we will see an r,fd; pair when we reach
3504
 
        #        |        |      | this id at the other path.
3505
 
        #  fdlt  |  r     |  a   | relocated in this tree, so add target to search.
3506
 
        #        |        |      | Dont diff, we will see an r,fd; pair when we reach
3507
 
        #        |        |      | this id at the other path.
3508
 
 
3509
 
        # TODO: jam 20070516 - Avoid the _get_entry lookup overhead by
3510
 
        #       keeping a cache of directories that we have seen.
3511
 
 
3512
 
        while search_specific_files:
3513
 
            # TODO: the pending list should be lexically sorted?  the
3514
 
            # interface doesn't require it.
3515
 
            current_root = search_specific_files.pop()
3516
 
            current_root_unicode = current_root.decode('utf8')
3517
 
            searched_specific_files.add(current_root)
3518
 
            # process the entries for this containing directory: the rest will be
3519
 
            # found by their parents recursively.
3520
 
            root_entries = self.state._entries_for_path(current_root)
3521
 
            root_abspath = self.tree.abspath(current_root_unicode)
3522
 
            try:
3523
 
                root_stat = os.lstat(root_abspath)
3524
 
            except OSError, e:
3525
 
                if e.errno == errno.ENOENT:
3526
 
                    # the path does not exist: let _process_entry know that.
3527
 
                    root_dir_info = None
3528
 
                else:
3529
 
                    # some other random error: hand it up.
3530
 
                    raise
3531
 
            else:
3532
 
                root_dir_info = ('', current_root,
3533
 
                    osutils.file_kind_from_stat_mode(root_stat.st_mode), root_stat,
3534
 
                    root_abspath)
3535
 
                if root_dir_info[2] == 'directory':
3536
 
                    if self.tree._directory_is_tree_reference(
3537
 
                        current_root.decode('utf8')):
3538
 
                        root_dir_info = root_dir_info[:2] + \
3539
 
                            ('tree-reference',) + root_dir_info[3:]
3540
 
 
3541
 
            if not root_entries and not root_dir_info:
3542
 
                # this specified path is not present at all, skip it.
3543
 
                continue
3544
 
            path_handled = False
3545
 
            for entry in root_entries:
3546
 
                result, changed = _process_entry(entry, root_dir_info)
3547
 
                if changed is not None:
3548
 
                    path_handled = True
3549
 
                    if changed or self.include_unchanged:
3550
 
                        yield result
3551
 
            if self.want_unversioned and not path_handled and root_dir_info:
3552
 
                new_executable = bool(
3553
 
                    stat.S_ISREG(root_dir_info[3].st_mode)
3554
 
                    and stat.S_IEXEC & root_dir_info[3].st_mode)
3555
 
                yield (None,
3556
 
                       (None, current_root_unicode),
3557
 
                       True,
3558
 
                       (False, False),
3559
 
                       (None, None),
3560
 
                       (None, splitpath(current_root_unicode)[-1]),
3561
 
                       (None, root_dir_info[2]),
3562
 
                       (None, new_executable)
3563
 
                      )
3564
 
            initial_key = (current_root, '', '')
3565
 
            block_index, _ = self.state._find_block_index_from_key(initial_key)
3566
 
            if block_index == 0:
3567
 
                # we have processed the total root already, but because the
3568
 
                # initial key matched it we should skip it here.
3569
 
                block_index +=1
3570
 
            if root_dir_info and root_dir_info[2] == 'tree-reference':
3571
 
                current_dir_info = None
3572
 
            else:
3573
 
                dir_iterator = osutils._walkdirs_utf8(root_abspath, prefix=current_root)
3574
 
                try:
3575
 
                    current_dir_info = dir_iterator.next()
3576
 
                except OSError, e:
3577
 
                    # on win32, python2.4 has e.errno == ERROR_DIRECTORY, but
3578
 
                    # python 2.5 has e.errno == EINVAL,
3579
 
                    #            and e.winerror == ERROR_DIRECTORY
3580
 
                    e_winerror = getattr(e, 'winerror', None)
3581
 
                    win_errors = (ERROR_DIRECTORY, ERROR_PATH_NOT_FOUND)
3582
 
                    # there may be directories in the inventory even though
3583
 
                    # this path is not a file on disk: so mark it as end of
3584
 
                    # iterator
3585
 
                    if e.errno in (errno.ENOENT, errno.ENOTDIR, errno.EINVAL):
3586
 
                        current_dir_info = None
3587
 
                    elif (sys.platform == 'win32'
3588
 
                          and (e.errno in win_errors
3589
 
                               or e_winerror in win_errors)):
3590
 
                        current_dir_info = None
3591
 
                    else:
3592
 
                        raise
3593
 
                else:
3594
 
                    if current_dir_info[0][0] == '':
3595
 
                        # remove .bzr from iteration
3596
 
                        bzr_index = bisect.bisect_left(current_dir_info[1], ('.bzr',))
3597
 
                        if current_dir_info[1][bzr_index][0] != '.bzr':
3598
 
                            raise AssertionError()
3599
 
                        del current_dir_info[1][bzr_index]
3600
 
            # walk until both the directory listing and the versioned metadata
3601
 
            # are exhausted.
3602
 
            if (block_index < len(self.state._dirblocks) and
3603
 
                osutils.is_inside(current_root, self.state._dirblocks[block_index][0])):
3604
 
                current_block = self.state._dirblocks[block_index]
3605
 
            else:
3606
 
                current_block = None
3607
 
            while (current_dir_info is not None or
3608
 
                   current_block is not None):
3609
 
                if (current_dir_info and current_block
3610
 
                    and current_dir_info[0][0] != current_block[0]):
3611
 
                    if _cmp_by_dirs(current_dir_info[0][0], current_block[0]) < 0:
3612
 
                        # filesystem data refers to paths not covered by the dirblock.
3613
 
                        # this has two possibilities:
3614
 
                        # A) it is versioned but empty, so there is no block for it
3615
 
                        # B) it is not versioned.
3616
 
 
3617
 
                        # if (A) then we need to recurse into it to check for
3618
 
                        # new unknown files or directories.
3619
 
                        # if (B) then we should ignore it, because we don't
3620
 
                        # recurse into unknown directories.
3621
 
                        path_index = 0
3622
 
                        while path_index < len(current_dir_info[1]):
3623
 
                                current_path_info = current_dir_info[1][path_index]
3624
 
                                if self.want_unversioned:
3625
 
                                    if current_path_info[2] == 'directory':
3626
 
                                        if self.tree._directory_is_tree_reference(
3627
 
                                            current_path_info[0].decode('utf8')):
3628
 
                                            current_path_info = current_path_info[:2] + \
3629
 
                                                ('tree-reference',) + current_path_info[3:]
3630
 
                                    new_executable = bool(
3631
 
                                        stat.S_ISREG(current_path_info[3].st_mode)
3632
 
                                        and stat.S_IEXEC & current_path_info[3].st_mode)
3633
 
                                    yield (None,
3634
 
                                        (None, utf8_decode(current_path_info[0])[0]),
3635
 
                                        True,
3636
 
                                        (False, False),
3637
 
                                        (None, None),
3638
 
                                        (None, utf8_decode(current_path_info[1])[0]),
3639
 
                                        (None, current_path_info[2]),
3640
 
                                        (None, new_executable))
3641
 
                                # dont descend into this unversioned path if it is
3642
 
                                # a dir
3643
 
                                if current_path_info[2] in ('directory',
3644
 
                                                            'tree-reference'):
3645
 
                                    del current_dir_info[1][path_index]
3646
 
                                    path_index -= 1
3647
 
                                path_index += 1
3648
 
 
3649
 
                        # This dir info has been handled, go to the next
3650
 
                        try:
3651
 
                            current_dir_info = dir_iterator.next()
3652
 
                        except StopIteration:
3653
 
                            current_dir_info = None
3654
 
                    else:
3655
 
                        # We have a dirblock entry for this location, but there
3656
 
                        # is no filesystem path for this. This is most likely
3657
 
                        # because a directory was removed from the disk.
3658
 
                        # We don't have to report the missing directory,
3659
 
                        # because that should have already been handled, but we
3660
 
                        # need to handle all of the files that are contained
3661
 
                        # within.
3662
 
                        for current_entry in current_block[1]:
3663
 
                            # entry referring to file not present on disk.
3664
 
                            # advance the entry only, after processing.
3665
 
                            result, changed = _process_entry(current_entry, None)
3666
 
                            if changed is not None:
3667
 
                                if changed or self.include_unchanged:
3668
 
                                    yield result
3669
 
                        block_index +=1
3670
 
                        if (block_index < len(self.state._dirblocks) and
3671
 
                            osutils.is_inside(current_root,
3672
 
                                              self.state._dirblocks[block_index][0])):
3673
 
                            current_block = self.state._dirblocks[block_index]
3674
 
                        else:
3675
 
                            current_block = None
3676
 
                    continue
3677
 
                entry_index = 0
3678
 
                if current_block and entry_index < len(current_block[1]):
3679
 
                    current_entry = current_block[1][entry_index]
3680
 
                else:
3681
 
                    current_entry = None
3682
 
                advance_entry = True
3683
 
                path_index = 0
3684
 
                if current_dir_info and path_index < len(current_dir_info[1]):
3685
 
                    current_path_info = current_dir_info[1][path_index]
3686
 
                    if current_path_info[2] == 'directory':
3687
 
                        if self.tree._directory_is_tree_reference(
3688
 
                            current_path_info[0].decode('utf8')):
3689
 
                            current_path_info = current_path_info[:2] + \
3690
 
                                ('tree-reference',) + current_path_info[3:]
3691
 
                else:
3692
 
                    current_path_info = None
3693
 
                advance_path = True
3694
 
                path_handled = False
3695
 
                while (current_entry is not None or
3696
 
                    current_path_info is not None):
3697
 
                    if current_entry is None:
3698
 
                        # the check for path_handled when the path is advanced
3699
 
                        # will yield this path if needed.
3700
 
                        pass
3701
 
                    elif current_path_info is None:
3702
 
                        # no path is fine: the per entry code will handle it.
3703
 
                        result, changed = _process_entry(current_entry, current_path_info)
3704
 
                        if changed is not None:
3705
 
                            if changed or self.include_unchanged:
3706
 
                                yield result
3707
 
                    elif (current_entry[0][1] != current_path_info[1]
3708
 
                          or current_entry[1][self.target_index][0] in 'ar'):
3709
 
                        # The current path on disk doesn't match the dirblock
3710
 
                        # record. Either the dirblock is marked as absent, or
3711
 
                        # the file on disk is not present at all in the
3712
 
                        # dirblock. Either way, report about the dirblock
3713
 
                        # entry, and let other code handle the filesystem one.
3714
 
 
3715
 
                        # Compare the basename for these files to determine
3716
 
                        # which comes first
3717
 
                        if current_path_info[1] < current_entry[0][1]:
3718
 
                            # extra file on disk: pass for now, but only
3719
 
                            # increment the path, not the entry
3720
 
                            advance_entry = False
3721
 
                        else:
3722
 
                            # entry referring to file not present on disk.
3723
 
                            # advance the entry only, after processing.
3724
 
                            result, changed = _process_entry(current_entry, None)
3725
 
                            if changed is not None:
3726
 
                                if changed or self.include_unchanged:
3727
 
                                    yield result
3728
 
                            advance_path = False
3729
 
                    else:
3730
 
                        result, changed = _process_entry(current_entry, current_path_info)
3731
 
                        if changed is not None:
3732
 
                            path_handled = True
3733
 
                            if changed or self.include_unchanged:
3734
 
                                yield result
3735
 
                    if advance_entry and current_entry is not None:
3736
 
                        entry_index += 1
3737
 
                        if entry_index < len(current_block[1]):
3738
 
                            current_entry = current_block[1][entry_index]
3739
 
                        else:
3740
 
                            current_entry = None
3741
 
                    else:
3742
 
                        advance_entry = True # reset the advance flaga
3743
 
                    if advance_path and current_path_info is not None:
3744
 
                        if not path_handled:
3745
 
                            # unversioned in all regards
3746
 
                            if self.want_unversioned:
3747
 
                                new_executable = bool(
3748
 
                                    stat.S_ISREG(current_path_info[3].st_mode)
3749
 
                                    and stat.S_IEXEC & current_path_info[3].st_mode)
3750
 
                                try:
3751
 
                                    relpath_unicode = utf8_decode(current_path_info[0])[0]
3752
 
                                except UnicodeDecodeError:
3753
 
                                    raise errors.BadFilenameEncoding(
3754
 
                                        current_path_info[0], osutils._fs_enc)
3755
 
                                yield (None,
3756
 
                                    (None, relpath_unicode),
3757
 
                                    True,
3758
 
                                    (False, False),
3759
 
                                    (None, None),
3760
 
                                    (None, utf8_decode(current_path_info[1])[0]),
3761
 
                                    (None, current_path_info[2]),
3762
 
                                    (None, new_executable))
3763
 
                            # dont descend into this unversioned path if it is
3764
 
                            # a dir
3765
 
                            if current_path_info[2] in ('directory'):
3766
 
                                del current_dir_info[1][path_index]
3767
 
                                path_index -= 1
3768
 
                        # dont descend the disk iterator into any tree
3769
 
                        # paths.
3770
 
                        if current_path_info[2] == 'tree-reference':
3771
 
                            del current_dir_info[1][path_index]
3772
 
                            path_index -= 1
3773
 
                        path_index += 1
3774
 
                        if path_index < len(current_dir_info[1]):
3775
 
                            current_path_info = current_dir_info[1][path_index]
3776
 
                            if current_path_info[2] == 'directory':
3777
 
                                if self.tree._directory_is_tree_reference(
3778
 
                                    current_path_info[0].decode('utf8')):
3779
 
                                    current_path_info = current_path_info[:2] + \
3780
 
                                        ('tree-reference',) + current_path_info[3:]
3781
 
                        else:
3782
 
                            current_path_info = None
3783
 
                        path_handled = False
3784
 
                    else:
3785
 
                        advance_path = True # reset the advance flagg.
3786
 
                if current_block is not None:
3787
 
                    block_index += 1
3788
 
                    if (block_index < len(self.state._dirblocks) and
3789
 
                        osutils.is_inside(current_root, self.state._dirblocks[block_index][0])):
3790
 
                        current_block = self.state._dirblocks[block_index]
3791
 
                    else:
3792
 
                        current_block = None
3793
 
                if current_dir_info is not None:
3794
 
                    try:
3795
 
                        current_dir_info = dir_iterator.next()
3796
 
                    except StopIteration:
3797
 
                        current_dir_info = None
3798
 
 
3799
 
 
3800
2286
# Try to load the compiled form if possible
3801
2287
try:
3802
 
    from bzrlib._dirstate_helpers_pyx import (
3803
 
        _read_dirblocks,
3804
 
        bisect_dirblock,
3805
 
        _bisect_path_left,
3806
 
        _bisect_path_right,
3807
 
        cmp_by_dirs,
3808
 
        ProcessEntryC as _process_entry,
3809
 
        update_entry as update_entry,
 
2288
    from bzrlib._dirstate_helpers_c import (
 
2289
        _read_dirblocks_c as _read_dirblocks,
 
2290
        bisect_dirblock_c as bisect_dirblock,
 
2291
        _bisect_path_left_c as _bisect_path_left,
 
2292
        _bisect_path_right_c as _bisect_path_right,
 
2293
        cmp_by_dirs_c as cmp_by_dirs,
3810
2294
        )
3811
2295
except ImportError:
3812
2296
    from bzrlib._dirstate_helpers_py import (
3813
 
        _read_dirblocks,
3814
 
        bisect_dirblock,
3815
 
        _bisect_path_left,
3816
 
        _bisect_path_right,
3817
 
        cmp_by_dirs,
 
2297
        _read_dirblocks_py as _read_dirblocks,
 
2298
        bisect_dirblock_py as bisect_dirblock,
 
2299
        _bisect_path_left_py as _bisect_path_left,
 
2300
        _bisect_path_right_py as _bisect_path_right,
 
2301
        cmp_by_dirs_py as cmp_by_dirs,
3818
2302
        )
3819
 
    # FIXME: It would be nice to be able to track moved lines so that the
3820
 
    # corresponding python code can be moved to the _dirstate_helpers_py
3821
 
    # module. I don't want to break the history for this important piece of
3822
 
    # code so I left the code here -- vila 20090622
3823
 
    update_entry = py_update_entry
3824
 
    _process_entry = ProcessEntryPython