/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/dirstate.py

1st cut merge of bzr.dev r3907

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2006, 2007, 2008 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
 
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,
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:
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
165
      exact matches, or grab all elements and sort.
167
166
    - 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
 
167
      we should have a net win regardless of optimality. So we are going to 
169
168
      go with what seems reasonable.
170
169
open questions:
171
170
 
187
186
the file on disk, and then immediately discard, the overhead of object creation
188
187
becomes a significant cost.
189
188
 
190
 
Figures: Creating a tuple from 3 elements was profiled at 0.0625
 
189
Figures: Creating a tuple from from 3 elements was profiled at 0.0625
191
190
microseconds, whereas creating a object which is subclassed from tuple was
192
191
0.500 microseconds, and creating an object with 3 elements and slots was 3
193
192
microseconds long. 0.1 milliseconds is 100 microseconds, and ideally we'll get
204
203
import bisect
205
204
import binascii
206
205
import errno
207
 
import operator
208
206
import os
209
207
from stat import S_IEXEC
210
208
import stat
217
215
    cache_utf8,
218
216
    debug,
219
217
    errors,
 
218
    filters,
220
219
    inventory,
221
220
    lock,
222
221
    osutils,
264
263
        # return '%X.%X' % (int(st.st_mtime), st.st_mode)
265
264
 
266
265
 
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
306
 
 
307
 
 
308
266
class DirState(object):
309
267
    """Record directory and metadata state for fast access.
310
268
 
363
321
    HEADER_FORMAT_2 = '#bazaar dirstate flat format 2\n'
364
322
    HEADER_FORMAT_3 = '#bazaar dirstate flat format 3\n'
365
323
 
366
 
    def __init__(self, path, sha1_provider):
 
324
    def __init__(self, path, content_filter_stack_provider=None):
367
325
        """Create a  DirState object.
368
326
 
369
327
        :param path: The path at which the dirstate file on disk should live.
370
 
        :param sha1_provider: an object meeting the SHA1Provider interface.
 
328
        :param content_filter_stack_provider: a function that takes a
 
329
            path (relative to the top of the tree) and a file-id as
 
330
            parameters and returns a stack of ContentFilters.
 
331
            If None, no content filtering is performed.
371
332
        """
372
333
        # _header_state and _dirblock_state represent the current state
373
334
        # of the dirstate metadata and the per-row data respectiely.
375
336
        # IN_MEMORY_UNMODIFIED indicates that what we have in memory
376
337
        #   is the same as is on disk
377
338
        # IN_MEMORY_MODIFIED indicates that we have a modified version
378
 
        #   of what is on disk.
 
339
        #   of what is on disk. 
379
340
        # In future we will add more granularity, for instance _dirblock_state
380
341
        # will probably support partially-in-memory as a separate variable,
381
342
        # allowing for partially-in-memory unmodified and partially-in-memory
382
343
        # modified states.
383
344
        self._header_state = DirState.NOT_IN_MEMORY
384
345
        self._dirblock_state = DirState.NOT_IN_MEMORY
385
 
        # If true, an error has been detected while updating the dirstate, and
 
346
        # If true, an error has been detected while updating the dirstate, and 
386
347
        # for safety we're not going to commit to disk.
387
348
        self._changes_aborted = False
388
349
        self._dirblocks = []
399
360
        self._cutoff_time = None
400
361
        self._split_path_cache = {}
401
362
        self._bisect_page_size = DirState.BISECT_PAGE_SIZE
402
 
        self._sha1_provider = sha1_provider
403
363
        if 'hashcache' in debug.debug_flags:
404
 
            self._sha1_file = self._sha1_file_and_mutter
 
364
            self._size_sha1_file = self._size_sha1_file_and_mutter
405
365
        else:
406
 
            self._sha1_file = self._sha1_provider.sha1
 
366
            self._size_sha1_file = filters.internal_size_sha_file_byname
407
367
        # These two attributes provide a simple cache for lookups into the
408
368
        # dirstate in-memory vectors. By probing respectively for the last
409
369
        # block, and for the next entry, we save nearly 2 bisections per path
410
370
        # during commit.
411
371
        self._last_block_index = None
412
372
        self._last_entry_index = None
 
373
        # Content filtering setup
 
374
        self._filter_provider = content_filter_stack_provider
413
375
 
414
376
    def __repr__(self):
415
377
        return "%s(%r)" % \
419
381
        """Add a path to be tracked.
420
382
 
421
383
        :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
 
384
            path foo within the root, 'foo/bar' is the path bar within foo 
423
385
            within the root.
424
386
        :param file_id: The file id of the path being added.
425
 
        :param kind: The kind of the path, as a string like 'file',
 
387
        :param kind: The kind of the path, as a string like 'file', 
426
388
            'directory', etc.
427
389
        :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),
 
390
        :param fingerprint: The sha value of the file,
430
391
            or the target of a symlink,
431
392
            or the referenced revision id for tree-references,
432
393
            or '' for directories.
433
394
        """
434
395
        # adding a file:
435
 
        # find the block its in.
 
396
        # find the block its in. 
436
397
        # find the location in the block.
437
398
        # check its not there
438
399
        # add it.
451
412
        # in the parent, or according to the special treatment for the root
452
413
        if basename == '.' or basename == '..':
453
414
            raise errors.InvalidEntryName(path)
454
 
        # now that we've normalised, we need the correct utf8 path and
 
415
        # now that we've normalised, we need the correct utf8 path and 
455
416
        # dirname and basename elements. This single encode and split should be
456
417
        # faster than three separate encodes.
457
418
        utf8path = (dirname + '/' + basename).strip('/').encode('utf8')
461
422
            raise AssertionError(
462
423
                "must be a utf8 file_id not %s" % (type(file_id), ))
463
424
        # 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)
 
425
        file_id_entry = self._get_entry(0, fileid_utf8=file_id)
466
426
        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)
 
427
            path = osutils.pathjoin(file_id_entry[0][0], file_id_entry[0][1])
 
428
            kind = DirState._minikind_to_kind[file_id_entry[1][0][0]]
 
429
            info = '%s:%s' % (kind, path)
 
430
            raise errors.DuplicateFileId(file_id, info)
482
431
        first_key = (dirname, basename, '')
483
432
        block_index, present = self._find_block_index_from_key(first_key)
484
433
        if present:
485
434
            # check the path is not in the tree
486
435
            block = self._dirblocks[block_index][1]
487
436
            entry_index, _ = self._find_entry_index(first_key, block)
488
 
            while (entry_index < len(block) and
 
437
            while (entry_index < len(block) and 
489
438
                block[entry_index][0][0:2] == first_key[0:2]):
490
439
                if block[entry_index][1][0][0] not in 'ar':
491
440
                    # this path is in the dirstate in the current tree.
511
460
            packed_stat = pack_stat(stat)
512
461
        parent_info = self._empty_parent_info()
513
462
        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
463
        if kind == 'file':
521
464
            entry_data = entry_key, [
522
465
                (minikind, fingerprint, size, False, packed_stat),
981
924
 
982
925
    def _discard_merge_parents(self):
983
926
        """Discard any parents trees beyond the first.
984
 
 
 
927
        
985
928
        Note that if this fails the dirstate is corrupted.
986
929
 
987
930
        After this function returns the dirstate contains 2 trees, neither of
1057
1000
                raise AssertionError("bad dirname %r" % dirname)
1058
1001
        block_index, present = self._find_block_index_from_key((dirname, '', ''))
1059
1002
        if not present:
1060
 
            ## In future, when doing partial parsing, this should load and
 
1003
            ## In future, when doing partial parsing, this should load and 
1061
1004
            # populate the entire block.
1062
1005
            self._dirblocks.insert(block_index, (dirname, []))
1063
1006
        return block_index
1075
1018
        if new_entries[0][0][0:2] != ('', ''):
1076
1019
            raise AssertionError(
1077
1020
                "Missing root row %r" % (new_entries[0][0],))
1078
 
        # The two blocks here are deliberate: the root block and the
 
1021
        # The two blocks here are deliberate: the root block and the 
1079
1022
        # contents-of-root block.
1080
1023
        self._dirblocks = [('', []), ('', [])]
1081
1024
        current_block = self._dirblocks[0][1]
1205
1148
        # one to use it. we use _right here because there are two
1206
1149
        # '' blocks - the root, and the contents of root
1207
1150
        # we always have a minimum of 2 in self._dirblocks: root and
1208
 
        # root-contents, and for '', we get 2 back, so this is
 
1151
        # root-contents, and for '', we get 2 back, so this is 
1209
1152
        # simple and correct:
1210
1153
        present = (block_index < len(self._dirblocks) and
1211
1154
            self._dirblocks[block_index][0] == key[0])
1240
1183
        return entry_index, present
1241
1184
 
1242
1185
    @staticmethod
1243
 
    def from_tree(tree, dir_state_filename, sha1_provider=None):
 
1186
    def from_tree(tree, dir_state_filename):
1244
1187
        """Create a dirstate from a bzr Tree.
1245
1188
 
1246
1189
        :param tree: The tree which should provide parent information and
1247
1190
            inventory ids.
1248
 
        :param sha1_provider: an object meeting the SHA1Provider interface.
1249
 
            If None, a DefaultSHA1Provider is used.
1250
1191
        :return: a DirState object which is currently locked for writing.
1251
1192
            (it was locked by DirState.initialize)
1252
1193
        """
1253
 
        result = DirState.initialize(dir_state_filename,
1254
 
            sha1_provider=sha1_provider)
 
1194
        result = DirState.initialize(dir_state_filename)
1255
1195
        try:
1256
1196
            tree.lock_read()
1257
1197
            try:
1278
1218
    def update_by_delta(self, delta):
1279
1219
        """Apply an inventory delta to the dirstate for tree 0
1280
1220
 
1281
 
        This is the workhorse for apply_inventory_delta in dirstate based
1282
 
        trees.
1283
 
 
1284
1221
        :param delta: An inventory delta.  See Inventory.apply_delta for
1285
1222
            details.
1286
1223
        """
1287
1224
        self._read_dirblocks_if_needed()
1288
 
        encode = cache_utf8.encode
1289
1225
        insertions = {}
1290
1226
        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):
 
1227
        for old_path, new_path, file_id, inv_entry in sorted(delta, reverse=True):
1308
1228
            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")
 
1229
                raise AssertionError("repeated file id in delta %r" % (file_id,))
1311
1230
            if old_path is not None:
1312
1231
                old_path = old_path.encode('utf-8')
1313
1232
                removals[file_id] = old_path
1314
 
            else:
1315
 
                new_ids.add(file_id)
1316
1233
            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
1234
                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)
 
1235
                dirname, basename = osutils.split(new_path)
 
1236
                key = (dirname, basename, file_id)
1325
1237
                minikind = DirState._kind_to_minikind[inv_entry.kind]
1326
1238
                if minikind == 't':
1327
 
                    fingerprint = inv_entry.reference_revision or ''
 
1239
                    fingerprint = inv_entry.reference_revision
1328
1240
                else:
1329
1241
                    fingerprint = ''
1330
1242
                insertions[file_id] = (key, minikind, inv_entry.executable,
1339
1251
                    minikind = child[1][0][0]
1340
1252
                    fingerprint = child[1][0][4]
1341
1253
                    executable = child[1][0][3]
1342
 
                    old_child_path = osutils.pathjoin(child_dirname,
1343
 
                                                      child_basename)
 
1254
                    old_child_path = osutils.pathjoin(child[0][0],
 
1255
                                                      child[0][1])
1344
1256
                    removals[child[0][2]] = old_child_path
1345
1257
                    child_suffix = child_dirname[len(old_path):]
1346
1258
                    new_child_dirname = (new_path + child_suffix)
1347
1259
                    key = (new_child_dirname, child_basename, child[0][2])
1348
 
                    new_child_path = osutils.pathjoin(new_child_dirname,
1349
 
                                                      child_basename)
 
1260
                    new_child_path = os.path.join(new_child_dirname,
 
1261
                                                  child_basename)
1350
1262
                    insertions[child[0][2]] = (key, minikind, executable,
1351
1263
                                               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.")
 
1264
        self._apply_removals(removals.values())
 
1265
        self._apply_insertions(insertions.values())
1366
1266
 
1367
1267
    def _apply_removals(self, removals):
1368
 
        for file_id, path in sorted(removals, reverse=True,
1369
 
            key=operator.itemgetter(1)):
 
1268
        for path in sorted(removals, reverse=True):
1370
1269
            dirname, basename = osutils.split(path)
1371
1270
            block_i, entry_i, d_present, f_present = \
1372
1271
                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])
 
1272
            entry = self._dirblocks[block_i][1][entry_i]
1388
1273
            self._make_absent(entry)
1389
1274
            # See if we have a malformed delta: deleting a directory must not
1390
1275
            # leave crud behind. This increases the number of bisects needed
1398
1283
                # be due to it being in a parent tree, or a corrupt delta.
1399
1284
                for child_entry in self._dirblocks[block_i][1]:
1400
1285
                    if child_entry[1][0][0] not in ('r', 'a'):
1401
 
                        self._changes_aborted = True
1402
1286
                        raise errors.InconsistentDelta(path, entry[0][2],
1403
1287
                            "The file id was deleted but its children were "
1404
1288
                            "not deleted.")
1405
1289
 
1406
1290
    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")
 
1291
        for key, minikind, executable, fingerprint, path_utf8 in sorted(adds):
 
1292
            self.update_minimal(key, minikind, executable, fingerprint,
 
1293
                                path_utf8=path_utf8)
1415
1294
 
1416
1295
    def update_basis_by_delta(self, delta, new_revid):
1417
1296
        """Update the parents of this tree after a commit.
1461
1340
        # At the same time, to reduce interface friction we convert the input
1462
1341
        # inventory entries to dirstate.
1463
1342
        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
1343
        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
1344
            if old_path is None:
1486
1345
                adds.append((None, encode(new_path), file_id,
1487
1346
                    inv_to_entry(inv_entry), True))
1488
 
                new_ids.add(file_id)
1489
1347
            elif new_path is None:
1490
1348
                deletes.append((encode(old_path), None, file_id, None, True))
1491
1349
            elif (old_path, new_path) != root_only:
1503
1361
                # for 'r' items on every pass.
1504
1362
                self._update_basis_apply_deletes(deletes)
1505
1363
                deletes = []
 
1364
                new_path_utf8 = encode(new_path)
1506
1365
                # Split into an add/delete pair recursively.
1507
1366
                adds.append((None, new_path_utf8, file_id,
1508
1367
                    inv_to_entry(inv_entry), False))
1534
1393
                # of everything.
1535
1394
                changes.append((encode(old_path), encode(new_path), file_id,
1536
1395
                    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.")
 
1396
 
 
1397
        # Finish expunging deletes/first half of renames.
 
1398
        self._update_basis_apply_deletes(deletes)
 
1399
        # Reinstate second half of renames and new paths.
 
1400
        self._update_basis_apply_adds(adds)
 
1401
        # Apply in-situ changes.
 
1402
        self._update_basis_apply_changes(changes)
1557
1403
 
1558
1404
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
1559
1405
        self._header_state = DirState.IN_MEMORY_MODIFIED
1560
1406
        self._id_index = None
1561
1407
        return
1562
1408
 
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
1409
    def _update_basis_apply_adds(self, adds):
1587
1410
        """Apply a sequence of adds to tree 1 during update_basis_by_delta.
1588
1411
 
1653
1476
        null = DirState.NULL_PARENT_DETAILS
1654
1477
        for old_path, new_path, file_id, _, real_delete in deletes:
1655
1478
            if real_delete != (new_path is None):
1656
 
                self._changes_aborted = True
1657
1479
                raise AssertionError("bad delete delta")
1658
1480
            # the entry for this file_id must be in tree 1.
1659
1481
            dirname, basename = osutils.split(old_path)
1692
1514
                    # it is being resurrected here, so blank it out temporarily.
1693
1515
                    self._dirblocks[block_index][1][entry_index][1][1] = null
1694
1516
 
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
1517
    def _observed_sha1(self, entry, sha1, stat_value,
1718
1518
        _stat_to_minikind=_stat_to_minikind, _pack_stat=pack_stat):
1719
1519
        """Note the sha1 of a file.
1754
1554
        """Return the os.lstat value for this path."""
1755
1555
        return os.lstat(abspath)
1756
1556
 
1757
 
    def _sha1_file_and_mutter(self, abspath):
 
1557
    def _size_sha1_file_and_mutter(self, abspath, filter_list):
1758
1558
        # when -Dhashcache is turned on, this is monkey-patched in to log
1759
1559
        # file reads
1760
1560
        trace.mutter("dirstate sha1 " + abspath)
1761
 
        return self._sha1_provider.sha1(abspath)
 
1561
        return filters.internal_size_sha_file_byname(abspath, filter_list)
1762
1562
 
1763
1563
    def _is_executable(self, mode, old_executable):
1764
1564
        """Is this file executable?"""
1777
1577
        #       already in memory. However, this really needs to be done at a
1778
1578
        #       higher level, because there either won't be anything on disk,
1779
1579
        #       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
 
1580
        return os.readlink(abspath)
1792
1581
 
1793
1582
    def get_ghosts(self):
1794
1583
        """Return a list of the parent tree revision ids that are ghosts."""
1940
1729
            entry_index += 1
1941
1730
        return block_index, entry_index, True, False
1942
1731
 
1943
 
    def _get_entry(self, tree_index, fileid_utf8=None, path_utf8=None, include_deleted=False):
 
1732
    def _get_entry(self, tree_index, fileid_utf8=None, path_utf8=None):
1944
1733
        """Get the dirstate entry for path in tree tree_index.
1945
1734
 
1946
1735
        If either file_id or path is supplied, it is used as the key to lookup.
1954
1743
            trees.
1955
1744
        :param fileid_utf8: A utf8 file_id to look up.
1956
1745
        :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
1746
        :return: The dirstate entry tuple for path, or (None, None)
1961
1747
        """
1962
1748
        self._read_dirblocks_if_needed()
1963
1749
        if path_utf8 is not None:
1964
1750
            if type(path_utf8) is not str:
1965
 
                raise errors.BzrError('path_utf8 is not a str: %s %r'
 
1751
                raise AssertionError('path_utf8 is not a str: %s %s'
1966
1752
                    % (type(path_utf8), path_utf8))
1967
1753
            # path lookups are faster
1968
1754
            dirname, basename = osutils.split(path_utf8)
1997
1783
                entry_index, present = self._find_entry_index(key, block)
1998
1784
                if present:
1999
1785
                    entry = self._dirblocks[block_index][1][entry_index]
2000
 
                    # TODO: We might want to assert that entry[0][2] ==
2001
 
                    #       fileid_utf8.
2002
1786
                    if entry[1][tree_index][0] in 'fdlt':
2003
 
                        # this is the result we are looking for: the
 
1787
                        # this is the result we are looking for: the  
2004
1788
                        # real home of this file_id in this tree.
2005
1789
                        return entry
2006
1790
                    if entry[1][tree_index][0] == 'a':
2007
1791
                        # there is no home for this entry in this tree
2008
 
                        if include_deleted:
2009
 
                            return entry
2010
1792
                        return None, None
2011
1793
                    if entry[1][tree_index][0] != 'r':
2012
1794
                        raise AssertionError(
2020
1802
            return None, None
2021
1803
 
2022
1804
    @classmethod
2023
 
    def initialize(cls, path, sha1_provider=None):
 
1805
    def initialize(cls, path):
2024
1806
        """Create a new dirstate on path.
2025
1807
 
2026
1808
        The new dirstate will be an empty tree - that is it has no parents,
2027
1809
        and only a root node - which has id ROOT_ID.
2028
1810
 
2029
1811
        :param path: The name of the file for the dirstate.
2030
 
        :param sha1_provider: an object meeting the SHA1Provider interface.
2031
 
            If None, a DefaultSHA1Provider is used.
2032
1812
        :return: A write-locked DirState object.
2033
1813
        """
2034
1814
        # This constructs a new DirState object on a path, sets the _state_file
2036
1816
        # stock empty dirstate information - a root with ROOT_ID, no children,
2037
1817
        # and no parents. Finally it calls save() to ensure that this data will
2038
1818
        # persist.
2039
 
        if sha1_provider is None:
2040
 
            sha1_provider = DefaultSHA1Provider()
2041
 
        result = cls(path, sha1_provider)
 
1819
        result = cls(path)
2042
1820
        # root dir and root dir contents with no children.
2043
1821
        empty_tree_dirblocks = [('', []), ('', [])]
2044
1822
        # a new root directory, with a NULLSTAT.
2072
1850
            size = 0
2073
1851
            executable = False
2074
1852
        elif kind == 'symlink':
2075
 
            if inv_entry.symlink_target is None:
2076
 
                fingerprint = ''
2077
 
            else:
2078
 
                fingerprint = inv_entry.symlink_target.encode('utf8')
 
1853
            # We don't support non-ascii targets for symlinks yet.
 
1854
            fingerprint = str(inv_entry.symlink_target or '')
2079
1855
            size = 0
2080
1856
            executable = False
2081
1857
        elif kind == 'file':
2093
1869
    def _iter_child_entries(self, tree_index, path_utf8):
2094
1870
        """Iterate over all the entries that are children of path_utf.
2095
1871
 
2096
 
        This only returns entries that are present (not in 'a', 'r') in
 
1872
        This only returns entries that are present (not in 'a', 'r') in 
2097
1873
        tree_index. tree_index data is not refreshed, so if tree 0 is used,
2098
1874
        results may differ from that obtained if paths were statted to
2099
1875
        determine what ones were directories.
2130
1906
                        else:
2131
1907
                            path = entry[0][1]
2132
1908
                        next_pending_dirs.append(path)
2133
 
 
 
1909
    
2134
1910
    def _iter_entries(self):
2135
1911
        """Iterate over all the entries in the dirstate.
2136
1912
 
2177
1953
        return len(self._parents) - len(self._ghosts)
2178
1954
 
2179
1955
    @staticmethod
2180
 
    def on_file(path, sha1_provider=None):
2181
 
        """Construct a DirState on the file at path "path".
 
1956
    def on_file(path, content_filter_stack_provider=None):
 
1957
        """Construct a DirState on the file at path path.
2182
1958
 
2183
 
        :param path: The path at which the dirstate file on disk should live.
2184
 
        :param sha1_provider: an object meeting the SHA1Provider interface.
2185
 
            If None, a DefaultSHA1Provider is used.
 
1959
        :param content_filter_stack_provider: a function that takes a
 
1960
            path (relative to the top of the tree) and a file-id as
 
1961
            parameters and returns a stack of ContentFilters.
 
1962
            If None, no content filtering is performed.
2186
1963
        :return: An unlocked DirState object, associated with the given path.
2187
1964
        """
2188
 
        if sha1_provider is None:
2189
 
            sha1_provider = DefaultSHA1Provider()
2190
 
        result = DirState(path, sha1_provider)
 
1965
        result = DirState(path, content_filter_stack_provider)
2191
1966
        return result
2192
1967
 
2193
1968
    def _read_dirblocks_if_needed(self):
2194
1969
        """Read in all the dirblocks from the file if they are not in memory.
2195
 
 
 
1970
        
2196
1971
        This populates self._dirblocks, and sets self._dirblock_state to
2197
1972
        IN_MEMORY_UNMODIFIED. It is not currently ready for incremental block
2198
1973
        loading.
2323
2098
 
2324
2099
        :param parent_ids: A list of parent tree revision ids.
2325
2100
        :param dirblocks: A list containing one tuple for each directory in the
2326
 
            tree. Each tuple contains the directory path and a list of entries
 
2101
            tree. Each tuple contains the directory path and a list of entries 
2327
2102
            found in that directory.
2328
2103
        """
2329
2104
        # our memory copy is now authoritative.
2356
2131
        self.update_minimal(('', '', new_id), 'd',
2357
2132
            path_utf8='', packed_stat=entry[1][0][4])
2358
2133
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
2134
        if self._id_index is not None:
 
2135
            self._id_index.setdefault(new_id, set()).add(entry[0])
2359
2136
 
2360
2137
    def set_parent_trees(self, trees, ghosts):
2361
2138
        """Set the parent trees for the dirstate.
2362
2139
 
2363
2140
        :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
 
2141
            even if the revision_id refers to a ghost: supply an empty tree in 
2365
2142
            this case.
2366
2143
        :param ghosts: A list of the revision_ids that are ghosts at the time
2367
2144
            of setting.
2368
 
        """
2369
 
        # TODO: generate a list of parent indexes to preserve to save
 
2145
        """ 
 
2146
        # TODO: generate a list of parent indexes to preserve to save 
2370
2147
        # processing specific parent trees. In the common case one tree will
2371
2148
        # be preserved - the left most parent.
2372
2149
        # TODO: if the parent tree is a dirstate, we might want to walk them
2377
2154
        # map and then walk the new parent trees only, mapping them into the
2378
2155
        # dirstate. Walk the dirstate at the same time to remove unreferenced
2379
2156
        # entries.
2380
 
        # for now:
2381
 
        # sketch: loop over all entries in the dirstate, cherry picking
 
2157
        # for now: 
 
2158
        # sketch: loop over all entries in the dirstate, cherry picking 
2382
2159
        # entries from the parent trees, if they are not ghost trees.
2383
2160
        # after we finish walking the dirstate, all entries not in the dirstate
2384
2161
        # are deletes, so we want to append them to the end as per the design
2389
2166
        #   links. We dont't trivially use the inventory from other trees
2390
2167
        #   because this leads to either double touching, or to accessing
2391
2168
        #   missing keys,
2392
 
        # - find other keys containing a path
2393
 
        # We accumulate each entry via this dictionary, including the root
 
2169
        # - find other keys containing a path 
 
2170
        # We accumulate each entry via this dictionary, including the root 
2394
2171
        by_path = {}
2395
2172
        id_index = {}
2396
2173
        # we could do parallel iterators, but because file id data may be
2400
2177
        # parent, but for now the common cases are adding a new parent (merge),
2401
2178
        # and replacing completely (commit), and commit is more common: so
2402
2179
        # optimise merge later.
2403
 
 
 
2180
        
2404
2181
        # ---- start generation of full tree mapping data
2405
2182
        # what trees should we use?
2406
2183
        parent_trees = [tree for rev_id, tree in trees if rev_id not in ghosts]
2407
 
        # how many trees do we end up with
 
2184
        # how many trees do we end up with 
2408
2185
        parent_count = len(parent_trees)
2409
2186
 
2410
2187
        # one: the current tree
2415
2192
            by_path[entry[0]] = [entry[1][0]] + \
2416
2193
                [DirState.NULL_PARENT_DETAILS] * parent_count
2417
2194
            id_index[entry[0][2]] = set([entry[0]])
2418
 
 
 
2195
        
2419
2196
        # now the parent trees:
2420
2197
        for tree_index, tree in enumerate(parent_trees):
2421
2198
            # the index is off by one, adjust it.
2435
2212
                # avoid checking all known paths for the id when generating a
2436
2213
                # new entry at this path: by adding the id->path mapping last,
2437
2214
                # all the mappings are valid and have correct relocation
2438
 
                # records where needed.
 
2215
                # records where needed. 
2439
2216
                file_id = entry.file_id
2440
2217
                path_utf8 = path.encode('utf8')
2441
2218
                dirname, basename = osutils.split(path_utf8)
2452
2229
                        # This is the vertical axis in the matrix, all pointing
2453
2230
                        # to the real path.
2454
2231
                        by_path[entry_key][tree_index] = ('r', path_utf8, 0, False, '')
2455
 
                # by path consistency: Insert into an existing path record (trivial), or
 
2232
                # by path consistency: Insert into an existing path record (trivial), or 
2456
2233
                # add a new one with relocation pointers for the other tree indexes.
2457
2234
                if new_entry_key in id_index[file_id]:
2458
2235
                    # there is already an entry where this data belongs, just insert it.
2471
2248
                            new_details.append(DirState.NULL_PARENT_DETAILS)
2472
2249
                        else:
2473
2250
                            # grab any one entry, use it to find the right path.
2474
 
                            # TODO: optimise this to reduce memory use in highly
 
2251
                            # TODO: optimise this to reduce memory use in highly 
2475
2252
                            # fragmented situations by reusing the relocation
2476
2253
                            # records.
2477
2254
                            a_key = iter(id_index[file_id]).next()
2510
2287
        return sorted(entry_list, key=_key)
2511
2288
 
2512
2289
    def set_state_from_inventory(self, new_inv):
2513
 
        """Set new_inv as the current state.
 
2290
        """Set new_inv as the current state. 
2514
2291
 
2515
2292
        This API is called by tree transform, and will usually occur with
2516
2293
        existing parent trees.
2520
2297
        if 'evil' in debug.debug_flags:
2521
2298
            trace.mutter_callsite(1,
2522
2299
                "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
2300
        self._read_dirblocks_if_needed()
2527
2301
        # sketch:
2528
 
        # Two iterators: current data and new data, both in dirblock order.
 
2302
        # Two iterators: current data and new data, both in dirblock order. 
2529
2303
        # We zip them together, which tells about entries that are new in the
2530
2304
        # inventory, or removed in the inventory, or present in both and
2531
 
        # possibly changed.
 
2305
        # possibly changed.  
2532
2306
        #
2533
2307
        # You might think we could just synthesize a new dirstate directly
2534
2308
        # since we're processing it in the right order.  However, we need to
2537
2311
        new_iterator = new_inv.iter_entries_by_dir()
2538
2312
        # we will be modifying the dirstate, so we need a stable iterator. In
2539
2313
        # 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.
 
2314
        # list - which is a shallow copy.
2543
2315
        old_iterator = iter(list(self._iter_entries()))
2544
2316
        # both must have roots so this is safe:
2545
2317
        current_new = new_iterator.next()
2579
2351
            # we make both end conditions explicit
2580
2352
            if not current_old:
2581
2353
                # 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
2354
                self.update_minimal(new_entry_key, current_new_minikind,
2586
2355
                    executable=current_new[1].executable,
2587
 
                    path_utf8=new_path_utf8, fingerprint=fingerprint,
2588
 
                    fullscan=True)
 
2356
                    path_utf8=new_path_utf8, fingerprint=fingerprint)
2589
2357
                current_new = advance(new_iterator)
2590
2358
            elif not current_new:
2591
2359
                # 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
2360
                self._make_absent(current_old)
2597
2361
                current_old = advance(old_iterator)
2598
2362
            elif new_entry_key == current_old[0]:
2605
2369
                # kind has changed.
2606
2370
                if (current_old[1][0][3] != current_new[1].executable or
2607
2371
                    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
2372
                    self.update_minimal(current_old[0], current_new_minikind,
2612
2373
                        executable=current_new[1].executable,
2613
 
                        path_utf8=new_path_utf8, fingerprint=fingerprint,
2614
 
                        fullscan=True)
 
2374
                        path_utf8=new_path_utf8, fingerprint=fingerprint)
2615
2375
                # both sides are dealt with, move on
2616
2376
                current_old = advance(old_iterator)
2617
2377
                current_new = advance(new_iterator)
2620
2380
                      and new_entry_key[1:] < current_old[0][1:])):
2621
2381
                # new comes before:
2622
2382
                # 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
2383
                self.update_minimal(new_entry_key, current_new_minikind,
2627
2384
                    executable=current_new[1].executable,
2628
 
                    path_utf8=new_path_utf8, fingerprint=fingerprint,
2629
 
                    fullscan=True)
 
2385
                    path_utf8=new_path_utf8, fingerprint=fingerprint)
2630
2386
                current_new = advance(new_iterator)
2631
2387
            else:
2632
2388
                # we've advanced past the place where the old key would be,
2633
2389
                # 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'))
2638
2390
                self._make_absent(current_old)
2639
2391
                current_old = advance(old_iterator)
2640
2392
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
2641
2393
        self._id_index = None
2642
2394
        self._packed_stat_index = None
2643
 
        if tracing:
2644
 
            trace.mutter("set_state_from_inventory complete.")
2645
2395
 
2646
2396
    def _make_absent(self, current_old):
2647
2397
        """Mark current_old - an entry - as absent for tree 0.
2696
2446
        return last_reference
2697
2447
 
2698
2448
    def update_minimal(self, key, minikind, executable=False, fingerprint='',
2699
 
        packed_stat=None, size=0, path_utf8=None, fullscan=False):
 
2449
                       packed_stat=None, size=0, path_utf8=None):
2700
2450
        """Update an entry to the state in tree 0.
2701
2451
 
2702
2452
        This will either create a new entry at 'key' or update an existing one.
2707
2457
        :param minikind: The type for the entry ('f' == 'file', 'd' ==
2708
2458
                'directory'), etc.
2709
2459
        :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.
 
2460
        :param fingerprint: Simple fingerprint for new entry: sha1 for files, 
 
2461
            referenced revision id for subtrees, etc.
2712
2462
        :param packed_stat: Packed stat value for new entry.
2713
2463
        :param size: Size information for new entry
2714
2464
        :param path_utf8: key[0] + '/' + key[1], just passed in to avoid doing
2715
2465
                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
2466
 
2720
2467
        If packed_stat and fingerprint are not given, they're invalidated in
2721
2468
        the entry.
2730
2477
        new_details = (minikind, fingerprint, size, executable, packed_stat)
2731
2478
        id_index = self._get_id_index()
2732
2479
        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
2480
            # new entry, synthesis cross reference here,
2751
2481
            existing_keys = id_index.setdefault(key[2], set())
2752
2482
            if not existing_keys:
2757
2487
                # grab one of them and use it to generate parent
2758
2488
                # relocation/absent entries.
2759
2489
                new_entry = key, [new_details]
2760
 
                # existing_keys can be changed as we iterate.
2761
 
                for other_key in tuple(existing_keys):
 
2490
                for other_key in existing_keys:
2762
2491
                    # change the record at other to be a pointer to this new
2763
2492
                    # record. The loop looks similar to the change to
2764
2493
                    # relocations when updating an existing record but its not:
2765
2494
                    # the test for existing kinds is different: this can be
2766
2495
                    # 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,))
 
2496
                    other_block_index, present = self._find_block_index_from_key(other_key)
 
2497
                    if not present:
 
2498
                        raise AssertionError('could not find block for %s' % (other_key,))
 
2499
                    other_entry_index, present = self._find_entry_index(other_key,
 
2500
                                            self._dirblocks[other_block_index][1])
 
2501
                    if not present:
 
2502
                        raise AssertionError('could not find entry for %s' % (other_key,))
2779
2503
                    if path_utf8 is None:
2780
2504
                        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)
 
2505
                    self._dirblocks[other_block_index][1][other_entry_index][1][0] = \
 
2506
                        ('r', path_utf8, 0, False, '')
2790
2507
 
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
2508
                num_present_parents = self._num_present_parents()
2796
 
                if num_present_parents:
2797
 
                    other_key = list(existing_keys)[0]
2798
2509
                for lookup_index in xrange(1, num_present_parents + 1):
2799
2510
                    # grab any one entry, use it to find the right path.
2800
 
                    # TODO: optimise this to reduce memory use in highly
 
2511
                    # TODO: optimise this to reduce memory use in highly 
2801
2512
                    # fragmented situations by reusing the relocation
2802
2513
                    # records.
2803
2514
                    update_block_index, present = \
2807
2518
                    update_entry_index, present = \
2808
2519
                        self._find_entry_index(other_key, self._dirblocks[update_block_index][1])
2809
2520
                    if not present:
2810
 
                        raise AssertionError('update_minimal: could not find entry for %s' % (other_key,))
 
2521
                        raise AssertionError('could not find entry for %s' % (other_key,))
2811
2522
                    update_details = self._dirblocks[update_block_index][1][update_entry_index][1][lookup_index]
2812
2523
                    if update_details[0] in 'ar': # relocated, absent
2813
2524
                        # its a pointer or absent in lookup_index's tree, use
2820
2531
            block.insert(entry_index, new_entry)
2821
2532
            existing_keys.add(key)
2822
2533
        else:
2823
 
            # Does the new state matter?
 
2534
            # Does the new state matter? 
2824
2535
            block[entry_index][1][0] = new_details
2825
2536
            # parents cannot be affected by what we do.
2826
 
            # other occurences of this id can be found
 
2537
            # other occurences of this id can be found 
2827
2538
            # from the id index.
2828
2539
            # ---
2829
2540
            # tree index consistency: All other paths for this id in this tree
2859
2570
 
2860
2571
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
2861
2572
 
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
2573
    def _validate(self):
2878
2574
        """Check that invariants on the dirblock are correct.
2879
2575
 
2880
 
        This can be useful in debugging; it shouldn't be necessary in
 
2576
        This can be useful in debugging; it shouldn't be necessary in 
2881
2577
        normal code.
2882
2578
 
2883
2579
        This must be called with a lock held.
2952
2648
        # For each file id, for each tree: either
2953
2649
        # the file id is not present at all; all rows with that id in the
2954
2650
        # key have it marked as 'absent'
2955
 
        # OR the file id is present under exactly one name; any other entries
 
2651
        # OR the file id is present under exactly one name; any other entries 
2956
2652
        # that mention that id point to the correct name.
2957
2653
        #
2958
2654
        # We check this with a dict per tree pointing either to the present
3005
2701
                        # absent; should not occur anywhere else
3006
2702
                        this_tree_map[file_id] = None, this_path
3007
2703
                    elif minikind == 'r':
3008
 
                        # relocation, must occur at expected location
 
2704
                        # relocation, must occur at expected location 
3009
2705
                        this_tree_map[file_id] = tree_state[1], this_path
3010
2706
                    else:
3011
2707
                        this_tree_map[file_id] = this_path, this_path
3013
2709
            if absent_positions == tree_count:
3014
2710
                raise AssertionError(
3015
2711
                    "entry %r has no data for any tree." % (entry,))
3016
 
        if self._id_index is not None:
3017
 
            for file_id, entry_keys in self._id_index.iteritems():
3018
 
                for entry_key in entry_keys:
3019
 
                    if entry_key[2] != file_id:
3020
 
                        raise AssertionError(
3021
 
                            'file_id %r did not match entry key %s'
3022
 
                            % (file_id, entry_key))
3023
2712
 
3024
2713
    def _wipe_state(self):
3025
2714
        """Forget all state information about the dirstate."""
3106
2795
    (saved_minikind, saved_link_or_sha1, saved_file_size,
3107
2796
     saved_executable, saved_packed_stat) = entry[1][0]
3108
2797
 
3109
 
    if minikind == 'd' and saved_minikind == 't':
3110
 
        minikind = 't'
3111
2798
    if (minikind == saved_minikind
3112
2799
        and packed_stat == saved_packed_stat):
3113
2800
        # The stat hasn't changed since we saved, so we can re-use the
3131
2818
            and stat_value.st_ctime < state._cutoff_time
3132
2819
            and len(entry[1]) > 1
3133
2820
            and entry[1][1][0] != 'a'):
3134
 
            # Could check for size changes for further optimised
3135
 
            # avoidance of sha1's. However the most prominent case of
3136
 
            # over-shaing is during initial add, which this catches.
3137
 
            # Besides, if content filtering happens, size and sha
3138
 
            # are calculated at the same time, so checking just the size
3139
 
            # gains nothing w.r.t. performance.
3140
 
            link_or_sha1 = state._sha1_file(abspath)
 
2821
                # Could check for size changes for further optimised
 
2822
                # avoidance of sha1's. However the most prominent case of
 
2823
                # over-shaing is during initial add, which this catches.
 
2824
                # Besides, if content filtering happens, size and sha
 
2825
                # need to be checked together - checking just the size
 
2826
                # would be wrong.
 
2827
            if state._filter_provider is None:
 
2828
                filter_list = []
 
2829
            else:
 
2830
                relpath = osutils.pathjoin(entry[0][0], entry[0][1])
 
2831
                file_id = entry[0][2]
 
2832
                filter_list = state._filter_provider(relpath, file_id)
 
2833
            link_or_sha1 = state._size_sha1_file(abspath, filter_list)[1]
3141
2834
            entry[1][0] = ('f', link_or_sha1, stat_value.st_size,
3142
2835
                           executable, packed_stat)
3143
2836
        else:
3167
2860
                           False, DirState.NULLSTAT)
3168
2861
    state._dirblock_state = DirState.IN_MEMORY_MODIFIED
3169
2862
    return link_or_sha1
 
2863
update_entry = py_update_entry
3170
2864
 
3171
2865
 
3172
2866
class ProcessEntryPython(object):
3173
2867
 
3174
 
    __slots__ = ["old_dirname_to_file_id", "new_dirname_to_file_id",
 
2868
    __slots__ = ["old_dirname_to_file_id", "new_dirname_to_file_id", "uninteresting",
3175
2869
        "last_source_parent", "last_target_parent", "include_unchanged",
3176
 
        "partial", "use_filesystem_for_exec", "utf8_decode",
3177
 
        "searched_specific_files", "search_specific_files",
3178
 
        "searched_exact_paths", "search_specific_file_parents", "seen_ids",
3179
 
        "state", "source_index", "target_index", "want_unversioned", "tree"]
 
2870
        "use_filesystem_for_exec", "utf8_decode", "searched_specific_files",
 
2871
        "search_specific_files", "state", "source_index", "target_index",
 
2872
        "want_unversioned", "tree"]
3180
2873
 
3181
2874
    def __init__(self, include_unchanged, use_filesystem_for_exec,
3182
2875
        search_specific_files, state, source_index, target_index,
3183
2876
        want_unversioned, tree):
3184
2877
        self.old_dirname_to_file_id = {}
3185
2878
        self.new_dirname_to_file_id = {}
3186
 
        # Are we doing a partial iter_changes?
3187
 
        self.partial = search_specific_files != set([''])
 
2879
        # Just a sentry, so that _process_entry can say that this
 
2880
        # record is handled, but isn't interesting to process (unchanged)
 
2881
        self.uninteresting = object()
3188
2882
        # Using a list so that we can access the values and change them in
3189
2883
        # nested scope. Each one is [path, file_id, entry]
3190
2884
        self.last_source_parent = [None, None]
3193
2887
        self.use_filesystem_for_exec = use_filesystem_for_exec
3194
2888
        self.utf8_decode = cache_utf8._utf8_decode
3195
2889
        # for all search_indexs in each path at or under each element of
3196
 
        # search_specific_files, if the detail is relocated: add the id, and
3197
 
        # add the relocated path as one to search if its not searched already.
3198
 
        # If the detail is not relocated, add the id.
 
2890
        # search_specific_files, if the detail is relocated: add the id, and add the
 
2891
        # relocated path as one to search if its not searched already. If the
 
2892
        # detail is not relocated, add the id.
3199
2893
        self.searched_specific_files = set()
3200
 
        # When we search exact paths without expanding downwards, we record
3201
 
        # that here.
3202
 
        self.searched_exact_paths = set()
3203
2894
        self.search_specific_files = search_specific_files
3204
 
        # The parents up to the root of the paths we are searching.
3205
 
        # After all normal paths are returned, these specific items are returned.
3206
 
        self.search_specific_file_parents = set()
3207
 
        # The ids we've sent out in the delta.
3208
 
        self.seen_ids = set()
3209
2895
        self.state = state
3210
2896
        self.source_index = source_index
3211
2897
        self.target_index = target_index
3212
 
        if target_index != 0:
3213
 
            # A lot of code in here depends on target_index == 0
3214
 
            raise errors.BzrError('unsupported target index')
3215
2898
        self.want_unversioned = want_unversioned
3216
2899
        self.tree = tree
3217
2900
 
3219
2902
        """Compare an entry and real disk to generate delta information.
3220
2903
 
3221
2904
        :param path_info: top_relpath, basename, kind, lstat, abspath for
3222
 
            the path of entry. If None, then the path is considered absent in 
3223
 
            the target (Perhaps we should pass in a concrete entry for this ?)
 
2905
            the path of entry. If None, then the path is considered absent.
 
2906
            (Perhaps we should pass in a concrete entry for this ?)
3224
2907
            Basename is returned as a utf8 string because we expect this
3225
2908
            tuple will be ignored, and don't want to take the time to
3226
2909
            decode.
3227
 
        :return: (iter_changes_result, changed). If the entry has not been
3228
 
            handled then changed is None. Otherwise it is False if no content
3229
 
            or metadata changes have occurred, and True if any content or
3230
 
            metadata change has occurred. If self.include_unchanged is True then
3231
 
            if changed is not None, iter_changes_result will always be a result
3232
 
            tuple. Otherwise, iter_changes_result is None unless changed is
3233
 
            True.
 
2910
        :return: None if these don't match
 
2911
                 A tuple of information about the change, or
 
2912
                 the object 'uninteresting' if these match, but are
 
2913
                 basically identical.
3234
2914
        """
3235
2915
        if self.source_index is None:
3236
2916
            source_details = DirState.NULL_PARENT_DETAILS
3304
2984
                    if source_minikind != 'f':
3305
2985
                        content_change = True
3306
2986
                    else:
3307
 
                        # Check the sha. We can't just rely on the size as
3308
 
                        # content filtering may mean differ sizes actually
3309
 
                        # map to the same content
3310
 
                        if link_or_sha1 is None:
3311
 
                            # Stat cache miss:
3312
 
                            statvalue, link_or_sha1 = \
3313
 
                                self.state._sha1_provider.stat_and_sha1(
3314
 
                                path_info[4])
3315
 
                            self.state._observed_sha1(entry, link_or_sha1,
3316
 
                                statvalue)
3317
 
                        content_change = (link_or_sha1 != source_details[1])
 
2987
                        # If the size is the same, check the sha:
 
2988
                        if target_details[2] == source_details[2]:
 
2989
                            if link_or_sha1 is None:
 
2990
                                # Stat cache miss:
 
2991
                                file_obj = file(path_info[4], 'rb')
 
2992
                                try:
 
2993
                                    statvalue = os.fstat(file_obj.fileno())
 
2994
                                    link_or_sha1 = osutils.sha_file(file_obj)
 
2995
                                finally:
 
2996
                                    file_obj.close()
 
2997
                                self.state._observed_sha1(entry, link_or_sha1,
 
2998
                                    statvalue)
 
2999
                            content_change = (link_or_sha1 != source_details[1])
 
3000
                        else:
 
3001
                            # Size changed, so must be different
 
3002
                            content_change = True
3318
3003
                    # Target details is updated at update_entry time
3319
3004
                    if self.use_filesystem_for_exec:
3320
3005
                        # We don't need S_ISREG here, because we are sure
3335
3020
                        content_change = False
3336
3021
                    target_exec = False
3337
3022
                else:
3338
 
                    if path is None:
3339
 
                        path = pathjoin(old_dirname, old_basename)
3340
 
                    raise errors.BadFileKindError(path, path_info[2])
 
3023
                    raise Exception, "unknown kind %s" % path_info[2]
3341
3024
            if source_minikind == 'd':
3342
3025
                if path is None:
3343
3026
                    old_path = path = pathjoin(old_dirname, old_basename)
3344
3027
                self.old_dirname_to_file_id[old_path] = file_id
3345
3028
            # parent id is the entry for the path in the target tree
3346
 
            if old_basename and old_dirname == self.last_source_parent[0]:
 
3029
            if old_dirname == self.last_source_parent[0]:
3347
3030
                source_parent_id = self.last_source_parent[1]
3348
3031
            else:
3349
3032
                try:
3359
3042
                    self.last_source_parent[0] = old_dirname
3360
3043
                    self.last_source_parent[1] = source_parent_id
3361
3044
            new_dirname = entry[0][0]
3362
 
            if entry[0][1] and new_dirname == self.last_target_parent[0]:
 
3045
            if new_dirname == self.last_target_parent[0]:
3363
3046
                target_parent_id = self.last_target_parent[1]
3364
3047
            else:
3365
3048
                try:
3382
3065
                    self.last_target_parent[1] = target_parent_id
3383
3066
 
3384
3067
            source_exec = source_details[3]
3385
 
            changed = (content_change
 
3068
            if (self.include_unchanged
 
3069
                or content_change
3386
3070
                or source_parent_id != target_parent_id
3387
3071
                or old_basename != entry[0][1]
3388
3072
                or source_exec != target_exec
3389
 
                )
3390
 
            if not changed and not self.include_unchanged:
3391
 
                return None, False
3392
 
            else:
 
3073
                ):
3393
3074
                if old_path is None:
3394
3075
                    old_path = path = pathjoin(old_dirname, old_basename)
3395
3076
                    old_path_u = self.utf8_decode(old_path)[0]
3408
3089
                       (source_parent_id, target_parent_id),
3409
3090
                       (self.utf8_decode(old_basename)[0], self.utf8_decode(entry[0][1])[0]),
3410
3091
                       (source_kind, target_kind),
3411
 
                       (source_exec, target_exec)), changed
 
3092
                       (source_exec, target_exec))
 
3093
            else:
 
3094
                return self.uninteresting
3412
3095
        elif source_minikind in 'a' and target_minikind in 'fdlt':
3413
3096
            # looks like a new file
3414
3097
            path = pathjoin(entry[0][0], entry[0][1])
3435
3118
                       (None, parent_id),
3436
3119
                       (None, self.utf8_decode(entry[0][1])[0]),
3437
3120
                       (None, path_info[2]),
3438
 
                       (None, target_exec)), True
 
3121
                       (None, target_exec))
3439
3122
            else:
3440
3123
                # Its a missing file, report it as such.
3441
3124
                return (entry[0][2],
3445
3128
                       (None, parent_id),
3446
3129
                       (None, self.utf8_decode(entry[0][1])[0]),
3447
3130
                       (None, None),
3448
 
                       (None, False)), True
 
3131
                       (None, False))
3449
3132
        elif source_minikind in 'fdlt' and target_minikind in 'a':
3450
3133
            # unversioned, possibly, or possibly not deleted: we dont care.
3451
3134
            # if its still on disk, *and* theres no other entry at this
3463
3146
                   (parent_id, None),
3464
3147
                   (self.utf8_decode(entry[0][1])[0], None),
3465
3148
                   (DirState._minikind_to_kind[source_minikind], None),
3466
 
                   (source_details[3], None)), True
 
3149
                   (source_details[3], None))
3467
3150
        elif source_minikind in 'fdlt' and target_minikind in 'r':
3468
3151
            # a rename; could be a true rename, or a rename inherited from
3469
3152
            # a renamed parent. TODO: handle this efficiently. Its not
3481
3164
                "source_minikind=%r, target_minikind=%r"
3482
3165
                % (source_minikind, target_minikind))
3483
3166
            ## import pdb;pdb.set_trace()
3484
 
        return None, None
 
3167
        return None
3485
3168
 
3486
3169
    def __iter__(self):
3487
3170
        return self
3488
3171
 
3489
 
    def _gather_result_for_consistency(self, result):
3490
 
        """Check a result we will yield to make sure we are consistent later.
3491
 
        
3492
 
        This gathers result's parents into a set to output later.
3493
 
 
3494
 
        :param result: A result tuple.
3495
 
        """
3496
 
        if not self.partial or not result[0]:
3497
 
            return
3498
 
        self.seen_ids.add(result[0])
3499
 
        new_path = result[1][1]
3500
 
        if new_path:
3501
 
            # Not the root and not a delete: queue up the parents of the path.
3502
 
            self.search_specific_file_parents.update(
3503
 
                osutils.parent_directories(new_path.encode('utf8')))
3504
 
            # Add the root directory which parent_directories does not
3505
 
            # provide.
3506
 
            self.search_specific_file_parents.add('')
3507
 
 
3508
3172
    def iter_changes(self):
3509
3173
        """Iterate over the changes."""
3510
3174
        utf8_decode = cache_utf8._utf8_decode
3511
3175
        _cmp_by_dirs = cmp_by_dirs
3512
3176
        _process_entry = self._process_entry
 
3177
        uninteresting = self.uninteresting
3513
3178
        search_specific_files = self.search_specific_files
3514
3179
        searched_specific_files = self.searched_specific_files
3515
3180
        splitpath = osutils.splitpath
3516
 
        # sketch:
 
3181
        # sketch: 
3517
3182
        # compare source_index and target_index at or under each element of search_specific_files.
3518
3183
        # follow the following comparison table. Note that we only want to do diff operations when
3519
 
        # the target is fdl because thats when the walkdirs logic will have exposed the pathinfo
 
3184
        # the target is fdl because thats when the walkdirs logic will have exposed the pathinfo 
3520
3185
        # for the target.
3521
3186
        # cases:
3522
 
        #
 
3187
        # 
3523
3188
        # Source | Target | disk | action
3524
3189
        #   r    | fdlt   |      | add source to search, add id path move and perform
3525
3190
        #        |        |      | diff check on source-target
3526
 
        #   r    | fdlt   |  a   | dangling file that was present in the basis.
 
3191
        #   r    | fdlt   |  a   | dangling file that was present in the basis. 
3527
3192
        #        |        |      | ???
3528
3193
        #   r    |  a     |      | add source to search
3529
 
        #   r    |  a     |  a   |
 
3194
        #   r    |  a     |  a   | 
3530
3195
        #   r    |  r     |      | this path is present in a non-examined tree, skip.
3531
3196
        #   r    |  r     |  a   | this path is present in a non-examined tree, skip.
3532
3197
        #   a    | fdlt   |      | add new id
3585
3250
                continue
3586
3251
            path_handled = False
3587
3252
            for entry in root_entries:
3588
 
                result, changed = _process_entry(entry, root_dir_info)
3589
 
                if changed is not None:
 
3253
                result = _process_entry(entry, root_dir_info)
 
3254
                if result is not None:
3590
3255
                    path_handled = True
3591
 
                    if changed:
3592
 
                        self._gather_result_for_consistency(result)
3593
 
                    if changed or self.include_unchanged:
 
3256
                    if result is not uninteresting:
3594
3257
                        yield result
3595
3258
            if self.want_unversioned and not path_handled and root_dir_info:
3596
3259
                new_executable = bool(
3642
3305
                            raise AssertionError()
3643
3306
                        del current_dir_info[1][bzr_index]
3644
3307
            # walk until both the directory listing and the versioned metadata
3645
 
            # are exhausted.
 
3308
            # are exhausted. 
3646
3309
            if (block_index < len(self.state._dirblocks) and
3647
3310
                osutils.is_inside(current_root, self.state._dirblocks[block_index][0])):
3648
3311
                current_block = self.state._dirblocks[block_index]
3706
3369
                        for current_entry in current_block[1]:
3707
3370
                            # entry referring to file not present on disk.
3708
3371
                            # advance the entry only, after processing.
3709
 
                            result, changed = _process_entry(current_entry, None)
3710
 
                            if changed is not None:
3711
 
                                if changed:
3712
 
                                    self._gather_result_for_consistency(result)
3713
 
                                if changed or self.include_unchanged:
 
3372
                            result = _process_entry(current_entry, None)
 
3373
                            if result is not None:
 
3374
                                if result is not uninteresting:
3714
3375
                                    yield result
3715
3376
                        block_index +=1
3716
3377
                        if (block_index < len(self.state._dirblocks) and
3741
3402
                while (current_entry is not None or
3742
3403
                    current_path_info is not None):
3743
3404
                    if current_entry is None:
3744
 
                        # the check for path_handled when the path is advanced
 
3405
                        # the check for path_handled when the path is adnvaced
3745
3406
                        # will yield this path if needed.
3746
3407
                        pass
3747
3408
                    elif current_path_info is None:
3748
3409
                        # no path is fine: the per entry code will handle it.
3749
 
                        result, changed = _process_entry(current_entry, current_path_info)
3750
 
                        if changed is not None:
3751
 
                            if changed:
3752
 
                                self._gather_result_for_consistency(result)
3753
 
                            if changed or self.include_unchanged:
 
3410
                        result = _process_entry(current_entry, current_path_info)
 
3411
                        if result is not None:
 
3412
                            if result is not uninteresting:
3754
3413
                                yield result
3755
3414
                    elif (current_entry[0][1] != current_path_info[1]
3756
3415
                          or current_entry[1][self.target_index][0] in 'ar'):
3769
3428
                        else:
3770
3429
                            # entry referring to file not present on disk.
3771
3430
                            # advance the entry only, after processing.
3772
 
                            result, changed = _process_entry(current_entry, None)
3773
 
                            if changed is not None:
3774
 
                                if changed:
3775
 
                                    self._gather_result_for_consistency(result)
3776
 
                                if changed or self.include_unchanged:
 
3431
                            result = _process_entry(current_entry, None)
 
3432
                            if result is not None:
 
3433
                                if result is not uninteresting:
3777
3434
                                    yield result
3778
3435
                            advance_path = False
3779
3436
                    else:
3780
 
                        result, changed = _process_entry(current_entry, current_path_info)
3781
 
                        if changed is not None:
 
3437
                        result = _process_entry(current_entry, current_path_info)
 
3438
                        if result is not None:
3782
3439
                            path_handled = True
3783
 
                            if changed:
3784
 
                                self._gather_result_for_consistency(result)
3785
 
                            if changed or self.include_unchanged:
 
3440
                            if result is not uninteresting:
3786
3441
                                yield result
3787
3442
                    if advance_entry and current_entry is not None:
3788
3443
                        entry_index += 1
3817
3472
                            if current_path_info[2] in ('directory'):
3818
3473
                                del current_dir_info[1][path_index]
3819
3474
                                path_index -= 1
3820
 
                        # dont descend the disk iterator into any tree
 
3475
                        # dont descend the disk iterator into any tree 
3821
3476
                        # paths.
3822
3477
                        if current_path_info[2] == 'tree-reference':
3823
3478
                            del current_dir_info[1][path_index]
3847
3502
                        current_dir_info = dir_iterator.next()
3848
3503
                    except StopIteration:
3849
3504
                        current_dir_info = None
3850
 
        for result in self._iter_specific_file_parents():
3851
 
            yield result
3852
 
 
3853
 
    def _iter_specific_file_parents(self):
3854
 
        """Iter over the specific file parents."""
3855
 
        while self.search_specific_file_parents:
3856
 
            # Process the parent directories for the paths we were iterating.
3857
 
            # Even in extremely large trees this should be modest, so currently
3858
 
            # no attempt is made to optimise.
3859
 
            path_utf8 = self.search_specific_file_parents.pop()
3860
 
            if osutils.is_inside_any(self.searched_specific_files, path_utf8):
3861
 
                # We've examined this path.
3862
 
                continue
3863
 
            if path_utf8 in self.searched_exact_paths:
3864
 
                # We've examined this path.
3865
 
                continue
3866
 
            path_entries = self.state._entries_for_path(path_utf8)
3867
 
            # We need either one or two entries. If the path in
3868
 
            # self.target_index has moved (so the entry in source_index is in
3869
 
            # 'ar') then we need to also look for the entry for this path in
3870
 
            # self.source_index, to output the appropriate delete-or-rename.
3871
 
            selected_entries = []
3872
 
            found_item = False
3873
 
            for candidate_entry in path_entries:
3874
 
                # Find entries present in target at this path:
3875
 
                if candidate_entry[1][self.target_index][0] not in 'ar':
3876
 
                    found_item = True
3877
 
                    selected_entries.append(candidate_entry)
3878
 
                # Find entries present in source at this path:
3879
 
                elif (self.source_index is not None and
3880
 
                    candidate_entry[1][self.source_index][0] not in 'ar'):
3881
 
                    found_item = True
3882
 
                    if candidate_entry[1][self.target_index][0] == 'a':
3883
 
                        # Deleted, emit it here.
3884
 
                        selected_entries.append(candidate_entry)
3885
 
                    else:
3886
 
                        # renamed, emit it when we process the directory it
3887
 
                        # ended up at.
3888
 
                        self.search_specific_file_parents.add(
3889
 
                            candidate_entry[1][self.target_index][1])
3890
 
            if not found_item:
3891
 
                raise AssertionError(
3892
 
                    "Missing entry for specific path parent %r, %r" % (
3893
 
                    path_utf8, path_entries))
3894
 
            path_info = self._path_info(path_utf8, path_utf8.decode('utf8'))
3895
 
            for entry in selected_entries:
3896
 
                if entry[0][2] in self.seen_ids:
3897
 
                    continue
3898
 
                result, changed = self._process_entry(entry, path_info)
3899
 
                if changed is None:
3900
 
                    raise AssertionError(
3901
 
                        "Got entry<->path mismatch for specific path "
3902
 
                        "%r entry %r path_info %r " % (
3903
 
                        path_utf8, entry, path_info))
3904
 
                # Only include changes - we're outside the users requested
3905
 
                # expansion.
3906
 
                if changed:
3907
 
                    self._gather_result_for_consistency(result)
3908
 
                    if (result[6][0] == 'directory' and
3909
 
                        result[6][1] != 'directory'):
3910
 
                        # This stopped being a directory, the old children have
3911
 
                        # to be included.
3912
 
                        if entry[1][self.source_index][0] == 'r':
3913
 
                            # renamed, take the source path
3914
 
                            entry_path_utf8 = entry[1][self.source_index][1]
3915
 
                        else:
3916
 
                            entry_path_utf8 = path_utf8
3917
 
                        initial_key = (entry_path_utf8, '', '')
3918
 
                        block_index, _ = self.state._find_block_index_from_key(
3919
 
                            initial_key)
3920
 
                        if block_index == 0:
3921
 
                            # The children of the root are in block index 1.
3922
 
                            block_index +=1
3923
 
                        current_block = None
3924
 
                        if block_index < len(self.state._dirblocks):
3925
 
                            current_block = self.state._dirblocks[block_index]
3926
 
                            if not osutils.is_inside(
3927
 
                                entry_path_utf8, current_block[0]):
3928
 
                                # No entries for this directory at all.
3929
 
                                current_block = None
3930
 
                        if current_block is not None:
3931
 
                            for entry in current_block[1]:
3932
 
                                if entry[1][self.source_index][0] in 'ar':
3933
 
                                    # Not in the source tree, so doesn't have to be
3934
 
                                    # included.
3935
 
                                    continue
3936
 
                                # Path of the entry itself.
3937
 
 
3938
 
                                self.search_specific_file_parents.add(
3939
 
                                    osutils.pathjoin(*entry[0][:2]))
3940
 
                if changed or self.include_unchanged:
3941
 
                    yield result
3942
 
            self.searched_exact_paths.add(path_utf8)
3943
 
 
3944
 
    def _path_info(self, utf8_path, unicode_path):
3945
 
        """Generate path_info for unicode_path.
3946
 
 
3947
 
        :return: None if unicode_path does not exist, or a path_info tuple.
3948
 
        """
3949
 
        abspath = self.tree.abspath(unicode_path)
3950
 
        try:
3951
 
            stat = os.lstat(abspath)
3952
 
        except OSError, e:
3953
 
            if e.errno == errno.ENOENT:
3954
 
                # the path does not exist.
3955
 
                return None
3956
 
            else:
3957
 
                raise
3958
 
        utf8_basename = utf8_path.rsplit('/', 1)[-1]
3959
 
        dir_info = (utf8_path, utf8_basename,
3960
 
            osutils.file_kind_from_stat_mode(stat.st_mode), stat,
3961
 
            abspath)
3962
 
        if dir_info[2] == 'directory':
3963
 
            if self.tree._directory_is_tree_reference(
3964
 
                unicode_path):
3965
 
                self.root_dir_info = self.root_dir_info[:2] + \
3966
 
                    ('tree-reference',) + self.root_dir_info[3:]
3967
 
        return dir_info
 
3505
_process_entry = ProcessEntryPython
3968
3506
 
3969
3507
 
3970
3508
# Try to load the compiled form if possible
3971
3509
try:
3972
 
    from bzrlib._dirstate_helpers_pyx import (
3973
 
        _read_dirblocks,
3974
 
        bisect_dirblock,
3975
 
        _bisect_path_left,
3976
 
        _bisect_path_right,
3977
 
        cmp_by_dirs,
 
3510
    from bzrlib._dirstate_helpers_c import (
 
3511
        _read_dirblocks_c as _read_dirblocks,
 
3512
        bisect_dirblock_c as bisect_dirblock,
 
3513
        _bisect_path_left_c as _bisect_path_left,
 
3514
        _bisect_path_right_c as _bisect_path_right,
 
3515
        cmp_by_dirs_c as cmp_by_dirs,
3978
3516
        ProcessEntryC as _process_entry,
3979
3517
        update_entry as update_entry,
3980
3518
        )
3981
 
except ImportError, e:
3982
 
    osutils.failed_to_load_extension(e)
 
3519
except ImportError:
3983
3520
    from bzrlib._dirstate_helpers_py import (
3984
 
        _read_dirblocks,
3985
 
        bisect_dirblock,
3986
 
        _bisect_path_left,
3987
 
        _bisect_path_right,
3988
 
        cmp_by_dirs,
 
3521
        _read_dirblocks_py as _read_dirblocks,
 
3522
        bisect_dirblock_py as bisect_dirblock,
 
3523
        _bisect_path_left_py as _bisect_path_left,
 
3524
        _bisect_path_right_py as _bisect_path_right,
 
3525
        cmp_by_dirs_py as cmp_by_dirs,
3989
3526
        )
3990
 
    # FIXME: It would be nice to be able to track moved lines so that the
3991
 
    # corresponding python code can be moved to the _dirstate_helpers_py
3992
 
    # module. I don't want to break the history for this important piece of
3993
 
    # code so I left the code here -- vila 20090622
3994
 
    update_entry = py_update_entry
3995
 
    _process_entry = ProcessEntryPython