/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/dirstate.py

  • Committer: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006, 2007, 2008 Canonical Ltd
 
1
# Copyright (C) 2006-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
"""DirState objects record the state of a directory and its bzr metadata.
18
18
 
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 its a file. The fingerprint is a
86
 
    sha1 value.
 
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.
87
88
'l' is a symlink entry: As for directory, but a symlink. The fingerprint is the
88
89
    link target.
89
90
't' is a reference to a nested subtree; the fingerprint is the referenced
99
100
 
100
101
--- Format 1 had the following different definition: ---
101
102
rows = dirname, NULL, basename, NULL, MINIKIND, NULL, fileid_utf8, NULL,
102
 
    WHOLE NUMBER (* size *), NULL, packed stat, NULL, sha1|symlink target, 
 
103
    WHOLE NUMBER (* size *), NULL, packed stat, NULL, sha1|symlink target,
103
104
    {PARENT ROW}
104
105
PARENT ROW = NULL, revision_utf8, NULL, MINIKIND, NULL, dirname, NULL,
105
106
    basename, NULL, WHOLE NUMBER (* size *), NULL, "y" | "n", NULL,
130
131
operations for the less common but still occurs a lot status/diff/commit
131
132
on specific files). Operations on specific files involve a scan for all
132
133
the children of a path, *in every involved tree*, which the current
133
 
format did not accommodate. 
 
134
format did not accommodate.
134
135
----
135
136
 
136
137
Design priorities:
148
149
 
149
150
Memory representation:
150
151
 vector of all directories, and vector of the childen ?
151
 
   i.e. 
152
 
     root_entrie = (direntry for root, [parent_direntries_for_root]), 
 
152
   i.e.
 
153
     root_entrie = (direntry for root, [parent_direntries_for_root]),
153
154
     dirblocks = [
154
155
     ('', ['data for achild', 'data for bchild', 'data for cchild'])
155
156
     ('dir', ['achild', 'cchild', 'echild'])
158
159
    - in-order for serialisation - this is 'dirblock' grouping.
159
160
    - insertion of a file '/a' affects only the '/' child-vector, that is, to
160
161
      insert 10K elements from scratch does not generates O(N^2) memoves of a
161
 
      single vector, rather each individual, which tends to be limited to a 
162
 
      manageable number. Will scale badly on trees with 10K entries in a 
 
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
163
164
      single directory. compare with Inventory.InventoryDirectory which has
164
165
      a dictionary for the children. No bisect capability, can only probe for
165
166
      exact matches, or grab all elements and sort.
166
167
    - What's the risk of error here? Once we have the base format being processed
167
 
      we should have a net win regardless of optimality. So we are going to 
 
168
      we should have a net win regardless of optimality. So we are going to
168
169
      go with what seems reasonable.
169
170
open questions:
170
171
 
186
187
the file on disk, and then immediately discard, the overhead of object creation
187
188
becomes a significant cost.
188
189
 
189
 
Figures: Creating a tuple from from 3 elements was profiled at 0.0625
 
190
Figures: Creating a tuple from 3 elements was profiled at 0.0625
190
191
microseconds, whereas creating a object which is subclassed from tuple was
191
192
0.500 microseconds, and creating an object with 3 elements and slots was 3
192
193
microseconds long. 0.1 milliseconds is 100 microseconds, and ideally we'll get
203
204
import bisect
204
205
import binascii
205
206
import errno
 
207
import operator
206
208
import os
207
209
from stat import S_IEXEC
208
210
import stat
262
264
        # return '%X.%X' % (int(st.st_mtime), st.st_mode)
263
265
 
264
266
 
 
267
class SHA1Provider(object):
 
268
    """An interface for getting sha1s of a file."""
 
269
 
 
270
    def sha1(self, abspath):
 
271
        """Return the sha1 of a file given its absolute path.
 
272
 
 
273
        :param abspath:  May be a filesystem encoded absolute path
 
274
             or a unicode path.
 
275
        """
 
276
        raise NotImplementedError(self.sha1)
 
277
 
 
278
    def stat_and_sha1(self, abspath):
 
279
        """Return the stat and sha1 of a file given its absolute path.
 
280
        
 
281
        :param abspath:  May be a filesystem encoded absolute path
 
282
             or a unicode path.
 
283
 
 
284
        Note: the stat should be the stat of the physical file
 
285
        while the sha may be the sha of its canonical content.
 
286
        """
 
287
        raise NotImplementedError(self.stat_and_sha1)
 
288
 
 
289
 
 
290
class DefaultSHA1Provider(SHA1Provider):
 
291
    """A SHA1Provider that reads directly from the filesystem."""
 
292
 
 
293
    def sha1(self, abspath):
 
294
        """Return the sha1 of a file given its absolute path."""
 
295
        return osutils.sha_file_by_name(abspath)
 
296
 
 
297
    def stat_and_sha1(self, abspath):
 
298
        """Return the stat and sha1 of a file given its absolute path."""
 
299
        file_obj = file(abspath, 'rb')
 
300
        try:
 
301
            statvalue = os.fstat(file_obj.fileno())
 
302
            sha1 = osutils.sha_file(file_obj)
 
303
        finally:
 
304
            file_obj.close()
 
305
        return statvalue, sha1
 
306
 
 
307
 
265
308
class DirState(object):
266
309
    """Record directory and metadata state for fast access.
267
310
 
320
363
    HEADER_FORMAT_2 = '#bazaar dirstate flat format 2\n'
321
364
    HEADER_FORMAT_3 = '#bazaar dirstate flat format 3\n'
322
365
 
323
 
    def __init__(self, path):
 
366
    def __init__(self, path, sha1_provider):
324
367
        """Create a  DirState object.
325
368
 
326
369
        :param path: The path at which the dirstate file on disk should live.
 
370
        :param sha1_provider: an object meeting the SHA1Provider interface.
327
371
        """
328
372
        # _header_state and _dirblock_state represent the current state
329
373
        # of the dirstate metadata and the per-row data respectiely.
331
375
        # IN_MEMORY_UNMODIFIED indicates that what we have in memory
332
376
        #   is the same as is on disk
333
377
        # IN_MEMORY_MODIFIED indicates that we have a modified version
334
 
        #   of what is on disk. 
 
378
        #   of what is on disk.
335
379
        # In future we will add more granularity, for instance _dirblock_state
336
380
        # will probably support partially-in-memory as a separate variable,
337
381
        # allowing for partially-in-memory unmodified and partially-in-memory
338
382
        # modified states.
339
383
        self._header_state = DirState.NOT_IN_MEMORY
340
384
        self._dirblock_state = DirState.NOT_IN_MEMORY
341
 
        # If true, an error has been detected while updating the dirstate, and 
 
385
        # If true, an error has been detected while updating the dirstate, and
342
386
        # for safety we're not going to commit to disk.
343
387
        self._changes_aborted = False
344
388
        self._dirblocks = []
355
399
        self._cutoff_time = None
356
400
        self._split_path_cache = {}
357
401
        self._bisect_page_size = DirState.BISECT_PAGE_SIZE
 
402
        self._sha1_provider = sha1_provider
358
403
        if 'hashcache' in debug.debug_flags:
359
404
            self._sha1_file = self._sha1_file_and_mutter
360
405
        else:
361
 
            self._sha1_file = osutils.sha_file_by_name
 
406
            self._sha1_file = self._sha1_provider.sha1
362
407
        # These two attributes provide a simple cache for lookups into the
363
408
        # dirstate in-memory vectors. By probing respectively for the last
364
409
        # block, and for the next entry, we save nearly 2 bisections per path
374
419
        """Add a path to be tracked.
375
420
 
376
421
        :param path: The path within the dirstate - '' is the root, 'foo' is the
377
 
            path foo within the root, 'foo/bar' is the path bar within foo 
 
422
            path foo within the root, 'foo/bar' is the path bar within foo
378
423
            within the root.
379
424
        :param file_id: The file id of the path being added.
380
 
        :param kind: The kind of the path, as a string like 'file', 
 
425
        :param kind: The kind of the path, as a string like 'file',
381
426
            'directory', etc.
382
427
        :param stat: The output of os.lstat for the path.
383
 
        :param fingerprint: The sha value of the file,
 
428
        :param fingerprint: The sha value of the file's canonical form (i.e.
 
429
            after any read filters have been applied),
384
430
            or the target of a symlink,
385
431
            or the referenced revision id for tree-references,
386
432
            or '' for directories.
387
433
        """
388
434
        # adding a file:
389
 
        # find the block its in. 
 
435
        # find the block its in.
390
436
        # find the location in the block.
391
437
        # check its not there
392
438
        # add it.
405
451
        # in the parent, or according to the special treatment for the root
406
452
        if basename == '.' or basename == '..':
407
453
            raise errors.InvalidEntryName(path)
408
 
        # now that we've normalised, we need the correct utf8 path and 
 
454
        # now that we've normalised, we need the correct utf8 path and
409
455
        # dirname and basename elements. This single encode and split should be
410
456
        # faster than three separate encodes.
411
457
        utf8path = (dirname + '/' + basename).strip('/').encode('utf8')
415
461
            raise AssertionError(
416
462
                "must be a utf8 file_id not %s" % (type(file_id), ))
417
463
        # Make sure the file_id does not exist in this tree
418
 
        file_id_entry = self._get_entry(0, fileid_utf8=file_id)
 
464
        rename_from = None
 
465
        file_id_entry = self._get_entry(0, fileid_utf8=file_id, include_deleted=True)
419
466
        if file_id_entry != (None, None):
420
 
            path = osutils.pathjoin(file_id_entry[0][0], file_id_entry[0][1])
421
 
            kind = DirState._minikind_to_kind[file_id_entry[1][0][0]]
422
 
            info = '%s:%s' % (kind, path)
423
 
            raise errors.DuplicateFileId(file_id, info)
 
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)
424
482
        first_key = (dirname, basename, '')
425
483
        block_index, present = self._find_block_index_from_key(first_key)
426
484
        if present:
427
485
            # check the path is not in the tree
428
486
            block = self._dirblocks[block_index][1]
429
487
            entry_index, _ = self._find_entry_index(first_key, block)
430
 
            while (entry_index < len(block) and 
 
488
            while (entry_index < len(block) and
431
489
                block[entry_index][0][0:2] == first_key[0:2]):
432
490
                if block[entry_index][1][0][0] not in 'ar':
433
491
                    # this path is in the dirstate in the current tree.
453
511
            packed_stat = pack_stat(stat)
454
512
        parent_info = self._empty_parent_info()
455
513
        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, '')
456
520
        if kind == 'file':
457
521
            entry_data = entry_key, [
458
522
                (minikind, fingerprint, size, False, packed_stat),
917
981
 
918
982
    def _discard_merge_parents(self):
919
983
        """Discard any parents trees beyond the first.
920
 
        
 
984
 
921
985
        Note that if this fails the dirstate is corrupted.
922
986
 
923
987
        After this function returns the dirstate contains 2 trees, neither of
993
1057
                raise AssertionError("bad dirname %r" % dirname)
994
1058
        block_index, present = self._find_block_index_from_key((dirname, '', ''))
995
1059
        if not present:
996
 
            ## In future, when doing partial parsing, this should load and 
 
1060
            ## In future, when doing partial parsing, this should load and
997
1061
            # populate the entire block.
998
1062
            self._dirblocks.insert(block_index, (dirname, []))
999
1063
        return block_index
1011
1075
        if new_entries[0][0][0:2] != ('', ''):
1012
1076
            raise AssertionError(
1013
1077
                "Missing root row %r" % (new_entries[0][0],))
1014
 
        # The two blocks here are deliberate: the root block and the 
 
1078
        # The two blocks here are deliberate: the root block and the
1015
1079
        # contents-of-root block.
1016
1080
        self._dirblocks = [('', []), ('', [])]
1017
1081
        current_block = self._dirblocks[0][1]
1141
1205
        # one to use it. we use _right here because there are two
1142
1206
        # '' blocks - the root, and the contents of root
1143
1207
        # we always have a minimum of 2 in self._dirblocks: root and
1144
 
        # root-contents, and for '', we get 2 back, so this is 
 
1208
        # root-contents, and for '', we get 2 back, so this is
1145
1209
        # simple and correct:
1146
1210
        present = (block_index < len(self._dirblocks) and
1147
1211
            self._dirblocks[block_index][0] == key[0])
1176
1240
        return entry_index, present
1177
1241
 
1178
1242
    @staticmethod
1179
 
    def from_tree(tree, dir_state_filename):
 
1243
    def from_tree(tree, dir_state_filename, sha1_provider=None):
1180
1244
        """Create a dirstate from a bzr Tree.
1181
1245
 
1182
1246
        :param tree: The tree which should provide parent information and
1183
1247
            inventory ids.
 
1248
        :param sha1_provider: an object meeting the SHA1Provider interface.
 
1249
            If None, a DefaultSHA1Provider is used.
1184
1250
        :return: a DirState object which is currently locked for writing.
1185
1251
            (it was locked by DirState.initialize)
1186
1252
        """
1187
 
        result = DirState.initialize(dir_state_filename)
 
1253
        result = DirState.initialize(dir_state_filename,
 
1254
            sha1_provider=sha1_provider)
1188
1255
        try:
1189
1256
            tree.lock_read()
1190
1257
            try:
1211
1278
    def update_by_delta(self, delta):
1212
1279
        """Apply an inventory delta to the dirstate for tree 0
1213
1280
 
 
1281
        This is the workhorse for apply_inventory_delta in dirstate based
 
1282
        trees.
 
1283
 
1214
1284
        :param delta: An inventory delta.  See Inventory.apply_delta for
1215
1285
            details.
1216
1286
        """
1217
1287
        self._read_dirblocks_if_needed()
 
1288
        encode = cache_utf8.encode
1218
1289
        insertions = {}
1219
1290
        removals = {}
1220
 
        for old_path, new_path, file_id, inv_entry in sorted(delta, reverse=True):
 
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):
1221
1308
            if (file_id in insertions) or (file_id in removals):
1222
 
                raise AssertionError("repeated file id in delta %r" % (file_id,))
 
1309
                raise errors.InconsistentDelta(old_path or new_path, file_id,
 
1310
                    "repeated file_id")
1223
1311
            if old_path is not None:
1224
1312
                old_path = old_path.encode('utf-8')
1225
1313
                removals[file_id] = old_path
 
1314
            else:
 
1315
                new_ids.add(file_id)
1226
1316
            if new_path is not None:
 
1317
                if inv_entry is None:
 
1318
                    raise errors.InconsistentDelta(new_path, file_id,
 
1319
                        "new_path with no entry")
1227
1320
                new_path = new_path.encode('utf-8')
1228
 
                dirname, basename = osutils.split(new_path)
1229
 
                key = (dirname, basename, file_id)
 
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)
1230
1325
                minikind = DirState._kind_to_minikind[inv_entry.kind]
1231
1326
                if minikind == 't':
1232
 
                    fingerprint = inv_entry.reference_revision
 
1327
                    fingerprint = inv_entry.reference_revision or ''
1233
1328
                else:
1234
1329
                    fingerprint = ''
1235
1330
                insertions[file_id] = (key, minikind, inv_entry.executable,
1244
1339
                    minikind = child[1][0][0]
1245
1340
                    fingerprint = child[1][0][4]
1246
1341
                    executable = child[1][0][3]
1247
 
                    old_child_path = osutils.pathjoin(child[0][0],
1248
 
                                                      child[0][1])
 
1342
                    old_child_path = osutils.pathjoin(child_dirname,
 
1343
                                                      child_basename)
1249
1344
                    removals[child[0][2]] = old_child_path
1250
1345
                    child_suffix = child_dirname[len(old_path):]
1251
1346
                    new_child_dirname = (new_path + child_suffix)
1252
1347
                    key = (new_child_dirname, child_basename, child[0][2])
1253
 
                    new_child_path = os.path.join(new_child_dirname,
1254
 
                                                  child_basename)
 
1348
                    new_child_path = osutils.pathjoin(new_child_dirname,
 
1349
                                                      child_basename)
1255
1350
                    insertions[child[0][2]] = (key, minikind, executable,
1256
1351
                                               fingerprint, new_child_path)
1257
 
        self._apply_removals(removals.values())
1258
 
        self._apply_insertions(insertions.values())
 
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.")
1259
1366
 
1260
1367
    def _apply_removals(self, removals):
1261
 
        for path in sorted(removals, reverse=True):
 
1368
        for file_id, path in sorted(removals, reverse=True,
 
1369
            key=operator.itemgetter(1)):
1262
1370
            dirname, basename = osutils.split(path)
1263
1371
            block_i, entry_i, d_present, f_present = \
1264
1372
                self._get_block_entry_index(dirname, basename, 0)
1265
 
            entry = self._dirblocks[block_i][1][entry_i]
 
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])
1266
1388
            self._make_absent(entry)
1267
1389
            # See if we have a malformed delta: deleting a directory must not
1268
1390
            # leave crud behind. This increases the number of bisects needed
1276
1398
                # be due to it being in a parent tree, or a corrupt delta.
1277
1399
                for child_entry in self._dirblocks[block_i][1]:
1278
1400
                    if child_entry[1][0][0] not in ('r', 'a'):
 
1401
                        self._changes_aborted = True
1279
1402
                        raise errors.InconsistentDelta(path, entry[0][2],
1280
1403
                            "The file id was deleted but its children were "
1281
1404
                            "not deleted.")
1282
1405
 
1283
1406
    def _apply_insertions(self, adds):
1284
 
        for key, minikind, executable, fingerprint, path_utf8 in sorted(adds):
1285
 
            self.update_minimal(key, minikind, executable, fingerprint,
1286
 
                                path_utf8=path_utf8)
 
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")
1287
1415
 
1288
1416
    def update_basis_by_delta(self, delta, new_revid):
1289
1417
        """Update the parents of this tree after a commit.
1333
1461
        # At the same time, to reduce interface friction we convert the input
1334
1462
        # inventory entries to dirstate.
1335
1463
        root_only = ('', '')
 
1464
        # Accumulate parent references (path_utf8, id), to check for parentless
 
1465
        # items or items placed under files/links/tree-references. We get
 
1466
        # references from every item in the delta that is not a deletion and
 
1467
        # is not itself the root.
 
1468
        parents = set()
 
1469
        # Added ids must not be in the dirstate already. This set holds those
 
1470
        # ids.
 
1471
        new_ids = set()
1336
1472
        for old_path, new_path, file_id, inv_entry in delta:
 
1473
            if inv_entry is not None and file_id != inv_entry.file_id:
 
1474
                raise errors.InconsistentDelta(new_path, file_id,
 
1475
                    "mismatched entry file_id %r" % inv_entry)
 
1476
            if new_path is not None:
 
1477
                if inv_entry is None:
 
1478
                    raise errors.InconsistentDelta(new_path, file_id,
 
1479
                        "new_path with no entry")
 
1480
                new_path_utf8 = encode(new_path)
 
1481
                # note the parent for validation
 
1482
                dirname_utf8, basename_utf8 = osutils.split(new_path_utf8)
 
1483
                if basename_utf8:
 
1484
                    parents.add((dirname_utf8, inv_entry.parent_id))
1337
1485
            if old_path is None:
1338
1486
                adds.append((None, encode(new_path), file_id,
1339
1487
                    inv_to_entry(inv_entry), True))
 
1488
                new_ids.add(file_id)
1340
1489
            elif new_path is None:
1341
1490
                deletes.append((encode(old_path), None, file_id, None, True))
1342
1491
            elif (old_path, new_path) != root_only:
1354
1503
                # for 'r' items on every pass.
1355
1504
                self._update_basis_apply_deletes(deletes)
1356
1505
                deletes = []
1357
 
                new_path_utf8 = encode(new_path)
1358
1506
                # Split into an add/delete pair recursively.
1359
1507
                adds.append((None, new_path_utf8, file_id,
1360
1508
                    inv_to_entry(inv_entry), False))
1386
1534
                # of everything.
1387
1535
                changes.append((encode(old_path), encode(new_path), file_id,
1388
1536
                    inv_to_entry(inv_entry)))
1389
 
 
1390
 
        # Finish expunging deletes/first half of renames.
1391
 
        self._update_basis_apply_deletes(deletes)
1392
 
        # Reinstate second half of renames and new paths.
1393
 
        self._update_basis_apply_adds(adds)
1394
 
        # Apply in-situ changes.
1395
 
        self._update_basis_apply_changes(changes)
 
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
1557
 
1397
1558
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
1398
1559
        self._header_state = DirState.IN_MEMORY_MODIFIED
1399
1560
        self._id_index = None
1400
1561
        return
1401
1562
 
 
1563
    def _check_delta_ids_absent(self, new_ids, delta, tree_index):
 
1564
        """Check that none of the file_ids in new_ids are present in a tree."""
 
1565
        if not new_ids:
 
1566
            return
 
1567
        id_index = self._get_id_index()
 
1568
        for file_id in new_ids:
 
1569
            for key in id_index.get(file_id, []):
 
1570
                block_i, entry_i, d_present, f_present = \
 
1571
                    self._get_block_entry_index(key[0], key[1], tree_index)
 
1572
                if not f_present:
 
1573
                    # In a different tree
 
1574
                    continue
 
1575
                entry = self._dirblocks[block_i][1][entry_i]
 
1576
                if entry[0][2] != file_id:
 
1577
                    # Different file_id, so not what we want.
 
1578
                    continue
 
1579
                # NB: No changes made before this helper is called, so no need
 
1580
                # to set the _changes_aborted flag.
 
1581
                raise errors.InconsistentDelta(
 
1582
                    ("%s/%s" % key[0:2]).decode('utf8'), file_id,
 
1583
                    "This file_id is new in the delta but already present in "
 
1584
                    "the target")
 
1585
 
1402
1586
    def _update_basis_apply_adds(self, adds):
1403
1587
        """Apply a sequence of adds to tree 1 during update_basis_by_delta.
1404
1588
 
1469
1653
        null = DirState.NULL_PARENT_DETAILS
1470
1654
        for old_path, new_path, file_id, _, real_delete in deletes:
1471
1655
            if real_delete != (new_path is None):
 
1656
                self._changes_aborted = True
1472
1657
                raise AssertionError("bad delete delta")
1473
1658
            # the entry for this file_id must be in tree 1.
1474
1659
            dirname, basename = osutils.split(old_path)
1507
1692
                    # it is being resurrected here, so blank it out temporarily.
1508
1693
                    self._dirblocks[block_index][1][entry_index][1][1] = null
1509
1694
 
 
1695
    def _after_delta_check_parents(self, parents, index):
 
1696
        """Check that parents required by the delta are all intact.
 
1697
        
 
1698
        :param parents: An iterable of (path_utf8, file_id) tuples which are
 
1699
            required to be present in tree 'index' at path_utf8 with id file_id
 
1700
            and be a directory.
 
1701
        :param index: The column in the dirstate to check for parents in.
 
1702
        """
 
1703
        for dirname_utf8, file_id in parents:
 
1704
            # Get the entry - the ensures that file_id, dirname_utf8 exists and
 
1705
            # has the right file id.
 
1706
            entry = self._get_entry(index, file_id, dirname_utf8)
 
1707
            if entry[1] is None:
 
1708
                self._changes_aborted = True
 
1709
                raise errors.InconsistentDelta(dirname_utf8.decode('utf8'),
 
1710
                    file_id, "This parent is not present.")
 
1711
            # Parents of things must be directories
 
1712
            if entry[1][index][0] != 'd':
 
1713
                self._changes_aborted = True
 
1714
                raise errors.InconsistentDelta(dirname_utf8.decode('utf8'),
 
1715
                    file_id, "This parent is not a directory.")
 
1716
 
1510
1717
    def _observed_sha1(self, entry, sha1, stat_value,
1511
1718
        _stat_to_minikind=_stat_to_minikind, _pack_stat=pack_stat):
1512
1719
        """Note the sha1 of a file.
1551
1758
        # when -Dhashcache is turned on, this is monkey-patched in to log
1552
1759
        # file reads
1553
1760
        trace.mutter("dirstate sha1 " + abspath)
1554
 
        return osutils.sha_file_by_name(abspath)
 
1761
        return self._sha1_provider.sha1(abspath)
1555
1762
 
1556
1763
    def _is_executable(self, mode, old_executable):
1557
1764
        """Is this file executable?"""
1570
1777
        #       already in memory. However, this really needs to be done at a
1571
1778
        #       higher level, because there either won't be anything on disk,
1572
1779
        #       or the thing on disk will be a file.
1573
 
        return os.readlink(abspath)
 
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
1574
1792
 
1575
1793
    def get_ghosts(self):
1576
1794
        """Return a list of the parent tree revision ids that are ghosts."""
1722
1940
            entry_index += 1
1723
1941
        return block_index, entry_index, True, False
1724
1942
 
1725
 
    def _get_entry(self, tree_index, fileid_utf8=None, path_utf8=None):
 
1943
    def _get_entry(self, tree_index, fileid_utf8=None, path_utf8=None, include_deleted=False):
1726
1944
        """Get the dirstate entry for path in tree tree_index.
1727
1945
 
1728
1946
        If either file_id or path is supplied, it is used as the key to lookup.
1736
1954
            trees.
1737
1955
        :param fileid_utf8: A utf8 file_id to look up.
1738
1956
        :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.
1739
1960
        :return: The dirstate entry tuple for path, or (None, None)
1740
1961
        """
1741
1962
        self._read_dirblocks_if_needed()
1742
1963
        if path_utf8 is not None:
1743
1964
            if type(path_utf8) is not str:
1744
 
                raise AssertionError('path_utf8 is not a str: %s %s'
 
1965
                raise errors.BzrError('path_utf8 is not a str: %s %r'
1745
1966
                    % (type(path_utf8), path_utf8))
1746
1967
            # path lookups are faster
1747
1968
            dirname, basename = osutils.split(path_utf8)
1776
1997
                entry_index, present = self._find_entry_index(key, block)
1777
1998
                if present:
1778
1999
                    entry = self._dirblocks[block_index][1][entry_index]
 
2000
                    # TODO: We might want to assert that entry[0][2] ==
 
2001
                    #       fileid_utf8.
1779
2002
                    if entry[1][tree_index][0] in 'fdlt':
1780
 
                        # this is the result we are looking for: the  
 
2003
                        # this is the result we are looking for: the
1781
2004
                        # real home of this file_id in this tree.
1782
2005
                        return entry
1783
2006
                    if entry[1][tree_index][0] == 'a':
1784
2007
                        # there is no home for this entry in this tree
 
2008
                        if include_deleted:
 
2009
                            return entry
1785
2010
                        return None, None
1786
2011
                    if entry[1][tree_index][0] != 'r':
1787
2012
                        raise AssertionError(
1795
2020
            return None, None
1796
2021
 
1797
2022
    @classmethod
1798
 
    def initialize(cls, path):
 
2023
    def initialize(cls, path, sha1_provider=None):
1799
2024
        """Create a new dirstate on path.
1800
2025
 
1801
2026
        The new dirstate will be an empty tree - that is it has no parents,
1802
2027
        and only a root node - which has id ROOT_ID.
1803
2028
 
1804
2029
        :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.
1805
2032
        :return: A write-locked DirState object.
1806
2033
        """
1807
2034
        # This constructs a new DirState object on a path, sets the _state_file
1809
2036
        # stock empty dirstate information - a root with ROOT_ID, no children,
1810
2037
        # and no parents. Finally it calls save() to ensure that this data will
1811
2038
        # persist.
1812
 
        result = cls(path)
 
2039
        if sha1_provider is None:
 
2040
            sha1_provider = DefaultSHA1Provider()
 
2041
        result = cls(path, sha1_provider)
1813
2042
        # root dir and root dir contents with no children.
1814
2043
        empty_tree_dirblocks = [('', []), ('', [])]
1815
2044
        # a new root directory, with a NULLSTAT.
1843
2072
            size = 0
1844
2073
            executable = False
1845
2074
        elif kind == 'symlink':
1846
 
            # We don't support non-ascii targets for symlinks yet.
1847
 
            fingerprint = str(inv_entry.symlink_target or '')
 
2075
            if inv_entry.symlink_target is None:
 
2076
                fingerprint = ''
 
2077
            else:
 
2078
                fingerprint = inv_entry.symlink_target.encode('utf8')
1848
2079
            size = 0
1849
2080
            executable = False
1850
2081
        elif kind == 'file':
1862
2093
    def _iter_child_entries(self, tree_index, path_utf8):
1863
2094
        """Iterate over all the entries that are children of path_utf.
1864
2095
 
1865
 
        This only returns entries that are present (not in 'a', 'r') in 
 
2096
        This only returns entries that are present (not in 'a', 'r') in
1866
2097
        tree_index. tree_index data is not refreshed, so if tree 0 is used,
1867
2098
        results may differ from that obtained if paths were statted to
1868
2099
        determine what ones were directories.
1899
2130
                        else:
1900
2131
                            path = entry[0][1]
1901
2132
                        next_pending_dirs.append(path)
1902
 
    
 
2133
 
1903
2134
    def _iter_entries(self):
1904
2135
        """Iterate over all the entries in the dirstate.
1905
2136
 
1946
2177
        return len(self._parents) - len(self._ghosts)
1947
2178
 
1948
2179
    @staticmethod
1949
 
    def on_file(path):
1950
 
        """Construct a DirState on the file at path path.
 
2180
    def on_file(path, sha1_provider=None):
 
2181
        """Construct a DirState on the file at path "path".
1951
2182
 
 
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.
1952
2186
        :return: An unlocked DirState object, associated with the given path.
1953
2187
        """
1954
 
        result = DirState(path)
 
2188
        if sha1_provider is None:
 
2189
            sha1_provider = DefaultSHA1Provider()
 
2190
        result = DirState(path, sha1_provider)
1955
2191
        return result
1956
2192
 
1957
2193
    def _read_dirblocks_if_needed(self):
1958
2194
        """Read in all the dirblocks from the file if they are not in memory.
1959
 
        
 
2195
 
1960
2196
        This populates self._dirblocks, and sets self._dirblock_state to
1961
2197
        IN_MEMORY_UNMODIFIED. It is not currently ready for incremental block
1962
2198
        loading.
2087
2323
 
2088
2324
        :param parent_ids: A list of parent tree revision ids.
2089
2325
        :param dirblocks: A list containing one tuple for each directory in the
2090
 
            tree. Each tuple contains the directory path and a list of entries 
 
2326
            tree. Each tuple contains the directory path and a list of entries
2091
2327
            found in that directory.
2092
2328
        """
2093
2329
        # our memory copy is now authoritative.
2120
2356
        self.update_minimal(('', '', new_id), 'd',
2121
2357
            path_utf8='', packed_stat=entry[1][0][4])
2122
2358
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
2123
 
        if self._id_index is not None:
2124
 
            self._id_index.setdefault(new_id, set()).add(entry[0])
2125
2359
 
2126
2360
    def set_parent_trees(self, trees, ghosts):
2127
2361
        """Set the parent trees for the dirstate.
2128
2362
 
2129
2363
        :param trees: A list of revision_id, tree tuples. tree must be provided
2130
 
            even if the revision_id refers to a ghost: supply an empty tree in 
 
2364
            even if the revision_id refers to a ghost: supply an empty tree in
2131
2365
            this case.
2132
2366
        :param ghosts: A list of the revision_ids that are ghosts at the time
2133
2367
            of setting.
2134
 
        """ 
2135
 
        # TODO: generate a list of parent indexes to preserve to save 
 
2368
        """
 
2369
        # TODO: generate a list of parent indexes to preserve to save
2136
2370
        # processing specific parent trees. In the common case one tree will
2137
2371
        # be preserved - the left most parent.
2138
2372
        # TODO: if the parent tree is a dirstate, we might want to walk them
2143
2377
        # map and then walk the new parent trees only, mapping them into the
2144
2378
        # dirstate. Walk the dirstate at the same time to remove unreferenced
2145
2379
        # entries.
2146
 
        # for now: 
2147
 
        # sketch: loop over all entries in the dirstate, cherry picking 
 
2380
        # for now:
 
2381
        # sketch: loop over all entries in the dirstate, cherry picking
2148
2382
        # entries from the parent trees, if they are not ghost trees.
2149
2383
        # after we finish walking the dirstate, all entries not in the dirstate
2150
2384
        # are deletes, so we want to append them to the end as per the design
2155
2389
        #   links. We dont't trivially use the inventory from other trees
2156
2390
        #   because this leads to either double touching, or to accessing
2157
2391
        #   missing keys,
2158
 
        # - find other keys containing a path 
2159
 
        # We accumulate each entry via this dictionary, including the root 
 
2392
        # - find other keys containing a path
 
2393
        # We accumulate each entry via this dictionary, including the root
2160
2394
        by_path = {}
2161
2395
        id_index = {}
2162
2396
        # we could do parallel iterators, but because file id data may be
2166
2400
        # parent, but for now the common cases are adding a new parent (merge),
2167
2401
        # and replacing completely (commit), and commit is more common: so
2168
2402
        # optimise merge later.
2169
 
        
 
2403
 
2170
2404
        # ---- start generation of full tree mapping data
2171
2405
        # what trees should we use?
2172
2406
        parent_trees = [tree for rev_id, tree in trees if rev_id not in ghosts]
2173
 
        # how many trees do we end up with 
 
2407
        # how many trees do we end up with
2174
2408
        parent_count = len(parent_trees)
2175
2409
 
2176
2410
        # one: the current tree
2181
2415
            by_path[entry[0]] = [entry[1][0]] + \
2182
2416
                [DirState.NULL_PARENT_DETAILS] * parent_count
2183
2417
            id_index[entry[0][2]] = set([entry[0]])
2184
 
        
 
2418
 
2185
2419
        # now the parent trees:
2186
2420
        for tree_index, tree in enumerate(parent_trees):
2187
2421
            # the index is off by one, adjust it.
2201
2435
                # avoid checking all known paths for the id when generating a
2202
2436
                # new entry at this path: by adding the id->path mapping last,
2203
2437
                # all the mappings are valid and have correct relocation
2204
 
                # records where needed. 
 
2438
                # records where needed.
2205
2439
                file_id = entry.file_id
2206
2440
                path_utf8 = path.encode('utf8')
2207
2441
                dirname, basename = osutils.split(path_utf8)
2218
2452
                        # This is the vertical axis in the matrix, all pointing
2219
2453
                        # to the real path.
2220
2454
                        by_path[entry_key][tree_index] = ('r', path_utf8, 0, False, '')
2221
 
                # by path consistency: Insert into an existing path record (trivial), or 
 
2455
                # by path consistency: Insert into an existing path record (trivial), or
2222
2456
                # add a new one with relocation pointers for the other tree indexes.
2223
2457
                if new_entry_key in id_index[file_id]:
2224
2458
                    # there is already an entry where this data belongs, just insert it.
2237
2471
                            new_details.append(DirState.NULL_PARENT_DETAILS)
2238
2472
                        else:
2239
2473
                            # grab any one entry, use it to find the right path.
2240
 
                            # TODO: optimise this to reduce memory use in highly 
 
2474
                            # TODO: optimise this to reduce memory use in highly
2241
2475
                            # fragmented situations by reusing the relocation
2242
2476
                            # records.
2243
2477
                            a_key = iter(id_index[file_id]).next()
2276
2510
        return sorted(entry_list, key=_key)
2277
2511
 
2278
2512
    def set_state_from_inventory(self, new_inv):
2279
 
        """Set new_inv as the current state. 
 
2513
        """Set new_inv as the current state.
2280
2514
 
2281
2515
        This API is called by tree transform, and will usually occur with
2282
2516
        existing parent trees.
2286
2520
        if 'evil' in debug.debug_flags:
2287
2521
            trace.mutter_callsite(1,
2288
2522
                "set_state_from_inventory called; please mutate the tree instead")
 
2523
        tracing = 'dirstate' in debug.debug_flags
 
2524
        if tracing:
 
2525
            trace.mutter("set_state_from_inventory trace:")
2289
2526
        self._read_dirblocks_if_needed()
2290
2527
        # sketch:
2291
 
        # Two iterators: current data and new data, both in dirblock order. 
 
2528
        # Two iterators: current data and new data, both in dirblock order.
2292
2529
        # We zip them together, which tells about entries that are new in the
2293
2530
        # inventory, or removed in the inventory, or present in both and
2294
 
        # possibly changed.  
 
2531
        # possibly changed.
2295
2532
        #
2296
2533
        # You might think we could just synthesize a new dirstate directly
2297
2534
        # since we're processing it in the right order.  However, we need to
2300
2537
        new_iterator = new_inv.iter_entries_by_dir()
2301
2538
        # we will be modifying the dirstate, so we need a stable iterator. In
2302
2539
        # future we might write one, for now we just clone the state into a
2303
 
        # list - which is a shallow copy.
 
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.
2304
2543
        old_iterator = iter(list(self._iter_entries()))
2305
2544
        # both must have roots so this is safe:
2306
2545
        current_new = new_iterator.next()
2340
2579
            # we make both end conditions explicit
2341
2580
            if not current_old:
2342
2581
                # 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'))
2343
2585
                self.update_minimal(new_entry_key, current_new_minikind,
2344
2586
                    executable=current_new[1].executable,
2345
 
                    path_utf8=new_path_utf8, fingerprint=fingerprint)
 
2587
                    path_utf8=new_path_utf8, fingerprint=fingerprint,
 
2588
                    fullscan=True)
2346
2589
                current_new = advance(new_iterator)
2347
2590
            elif not current_new:
2348
2591
                # 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'))
2349
2596
                self._make_absent(current_old)
2350
2597
                current_old = advance(old_iterator)
2351
2598
            elif new_entry_key == current_old[0]:
2358
2605
                # kind has changed.
2359
2606
                if (current_old[1][0][3] != current_new[1].executable or
2360
2607
                    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'))
2361
2611
                    self.update_minimal(current_old[0], current_new_minikind,
2362
2612
                        executable=current_new[1].executable,
2363
 
                        path_utf8=new_path_utf8, fingerprint=fingerprint)
 
2613
                        path_utf8=new_path_utf8, fingerprint=fingerprint,
 
2614
                        fullscan=True)
2364
2615
                # both sides are dealt with, move on
2365
2616
                current_old = advance(old_iterator)
2366
2617
                current_new = advance(new_iterator)
2369
2620
                      and new_entry_key[1:] < current_old[0][1:])):
2370
2621
                # new comes before:
2371
2622
                # add a entry for this and advance new
 
2623
                if tracing:
 
2624
                    trace.mutter("Inserting from new '%s'.",
 
2625
                        new_path_utf8.decode('utf8'))
2372
2626
                self.update_minimal(new_entry_key, current_new_minikind,
2373
2627
                    executable=current_new[1].executable,
2374
 
                    path_utf8=new_path_utf8, fingerprint=fingerprint)
 
2628
                    path_utf8=new_path_utf8, fingerprint=fingerprint,
 
2629
                    fullscan=True)
2375
2630
                current_new = advance(new_iterator)
2376
2631
            else:
2377
2632
                # we've advanced past the place where the old key would be,
2378
2633
                # without seeing it in the new list.  so it must be gone.
 
2634
                if tracing:
 
2635
                    trace.mutter("Deleting from old '%s/%s'.",
 
2636
                        current_old[0][0].decode('utf8'),
 
2637
                        current_old[0][1].decode('utf8'))
2379
2638
                self._make_absent(current_old)
2380
2639
                current_old = advance(old_iterator)
2381
2640
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
2382
2641
        self._id_index = None
2383
2642
        self._packed_stat_index = None
 
2643
        if tracing:
 
2644
            trace.mutter("set_state_from_inventory complete.")
2384
2645
 
2385
2646
    def _make_absent(self, current_old):
2386
2647
        """Mark current_old - an entry - as absent for tree 0.
2435
2696
        return last_reference
2436
2697
 
2437
2698
    def update_minimal(self, key, minikind, executable=False, fingerprint='',
2438
 
                       packed_stat=None, size=0, path_utf8=None):
 
2699
        packed_stat=None, size=0, path_utf8=None, fullscan=False):
2439
2700
        """Update an entry to the state in tree 0.
2440
2701
 
2441
2702
        This will either create a new entry at 'key' or update an existing one.
2446
2707
        :param minikind: The type for the entry ('f' == 'file', 'd' ==
2447
2708
                'directory'), etc.
2448
2709
        :param executable: Should the executable bit be set?
2449
 
        :param fingerprint: Simple fingerprint for new entry: sha1 for files, 
2450
 
            referenced revision id for subtrees, etc.
 
2710
        :param fingerprint: Simple fingerprint for new entry: canonical-form
 
2711
            sha1 for files, referenced revision id for subtrees, etc.
2451
2712
        :param packed_stat: Packed stat value for new entry.
2452
2713
        :param size: Size information for new entry
2453
2714
        :param path_utf8: key[0] + '/' + key[1], just passed in to avoid doing
2454
2715
                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.
2455
2719
 
2456
2720
        If packed_stat and fingerprint are not given, they're invalidated in
2457
2721
        the entry.
2466
2730
        new_details = (minikind, fingerprint, size, executable, packed_stat)
2467
2731
        id_index = self._get_id_index()
2468
2732
        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
2469
2750
            # new entry, synthesis cross reference here,
2470
2751
            existing_keys = id_index.setdefault(key[2], set())
2471
2752
            if not existing_keys:
2476
2757
                # grab one of them and use it to generate parent
2477
2758
                # relocation/absent entries.
2478
2759
                new_entry = key, [new_details]
2479
 
                for other_key in existing_keys:
 
2760
                # existing_keys can be changed as we iterate.
 
2761
                for other_key in tuple(existing_keys):
2480
2762
                    # change the record at other to be a pointer to this new
2481
2763
                    # record. The loop looks similar to the change to
2482
2764
                    # relocations when updating an existing record but its not:
2483
2765
                    # the test for existing kinds is different: this can be
2484
2766
                    # factored out to a helper though.
2485
 
                    other_block_index, present = self._find_block_index_from_key(other_key)
2486
 
                    if not present:
2487
 
                        raise AssertionError('could not find block for %s' % (other_key,))
2488
 
                    other_entry_index, present = self._find_entry_index(other_key,
2489
 
                                            self._dirblocks[other_block_index][1])
2490
 
                    if not present:
2491
 
                        raise AssertionError('could not find entry for %s' % (other_key,))
 
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,))
2492
2779
                    if path_utf8 is None:
2493
2780
                        raise AssertionError('no path')
2494
 
                    self._dirblocks[other_block_index][1][other_entry_index][1][0] = \
2495
 
                        ('r', path_utf8, 0, False, '')
 
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)
2496
2790
 
 
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
2497
2795
                num_present_parents = self._num_present_parents()
 
2796
                if num_present_parents:
 
2797
                    other_key = list(existing_keys)[0]
2498
2798
                for lookup_index in xrange(1, num_present_parents + 1):
2499
2799
                    # grab any one entry, use it to find the right path.
2500
 
                    # TODO: optimise this to reduce memory use in highly 
 
2800
                    # TODO: optimise this to reduce memory use in highly
2501
2801
                    # fragmented situations by reusing the relocation
2502
2802
                    # records.
2503
2803
                    update_block_index, present = \
2507
2807
                    update_entry_index, present = \
2508
2808
                        self._find_entry_index(other_key, self._dirblocks[update_block_index][1])
2509
2809
                    if not present:
2510
 
                        raise AssertionError('could not find entry for %s' % (other_key,))
 
2810
                        raise AssertionError('update_minimal: could not find entry for %s' % (other_key,))
2511
2811
                    update_details = self._dirblocks[update_block_index][1][update_entry_index][1][lookup_index]
2512
2812
                    if update_details[0] in 'ar': # relocated, absent
2513
2813
                        # its a pointer or absent in lookup_index's tree, use
2520
2820
            block.insert(entry_index, new_entry)
2521
2821
            existing_keys.add(key)
2522
2822
        else:
2523
 
            # Does the new state matter? 
 
2823
            # Does the new state matter?
2524
2824
            block[entry_index][1][0] = new_details
2525
2825
            # parents cannot be affected by what we do.
2526
 
            # other occurences of this id can be found 
 
2826
            # other occurences of this id can be found
2527
2827
            # from the id index.
2528
2828
            # ---
2529
2829
            # tree index consistency: All other paths for this id in this tree
2559
2859
 
2560
2860
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
2561
2861
 
 
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
 
2562
2877
    def _validate(self):
2563
2878
        """Check that invariants on the dirblock are correct.
2564
2879
 
2565
 
        This can be useful in debugging; it shouldn't be necessary in 
 
2880
        This can be useful in debugging; it shouldn't be necessary in
2566
2881
        normal code.
2567
2882
 
2568
2883
        This must be called with a lock held.
2637
2952
        # For each file id, for each tree: either
2638
2953
        # the file id is not present at all; all rows with that id in the
2639
2954
        # key have it marked as 'absent'
2640
 
        # OR the file id is present under exactly one name; any other entries 
 
2955
        # OR the file id is present under exactly one name; any other entries
2641
2956
        # that mention that id point to the correct name.
2642
2957
        #
2643
2958
        # We check this with a dict per tree pointing either to the present
2690
3005
                        # absent; should not occur anywhere else
2691
3006
                        this_tree_map[file_id] = None, this_path
2692
3007
                    elif minikind == 'r':
2693
 
                        # relocation, must occur at expected location 
 
3008
                        # relocation, must occur at expected location
2694
3009
                        this_tree_map[file_id] = tree_state[1], this_path
2695
3010
                    else:
2696
3011
                        this_tree_map[file_id] = this_path, this_path
2698
3013
            if absent_positions == tree_count:
2699
3014
                raise AssertionError(
2700
3015
                    "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))
2701
3023
 
2702
3024
    def _wipe_state(self):
2703
3025
        """Forget all state information about the dirstate."""
2784
3106
    (saved_minikind, saved_link_or_sha1, saved_file_size,
2785
3107
     saved_executable, saved_packed_stat) = entry[1][0]
2786
3108
 
 
3109
    if minikind == 'd' and saved_minikind == 't':
 
3110
        minikind = 't'
2787
3111
    if (minikind == saved_minikind
2788
3112
        and packed_stat == saved_packed_stat):
2789
3113
        # The stat hasn't changed since we saved, so we can re-use the
2807
3131
            and stat_value.st_ctime < state._cutoff_time
2808
3132
            and len(entry[1]) > 1
2809
3133
            and entry[1][1][0] != 'a'):
2810
 
                # Could check for size changes for further optimised
2811
 
                # avoidance of sha1's. However the most prominent case of
2812
 
                # over-shaing is during initial add, which this catches.
 
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.
2813
3140
            link_or_sha1 = state._sha1_file(abspath)
2814
3141
            entry[1][0] = ('f', link_or_sha1, stat_value.st_size,
2815
3142
                           executable, packed_stat)
2840
3167
                           False, DirState.NULLSTAT)
2841
3168
    state._dirblock_state = DirState.IN_MEMORY_MODIFIED
2842
3169
    return link_or_sha1
2843
 
update_entry = py_update_entry
2844
3170
 
2845
3171
 
2846
3172
class ProcessEntryPython(object):
2847
3173
 
2848
 
    __slots__ = ["old_dirname_to_file_id", "new_dirname_to_file_id", "uninteresting",
 
3174
    __slots__ = ["old_dirname_to_file_id", "new_dirname_to_file_id",
2849
3175
        "last_source_parent", "last_target_parent", "include_unchanged",
2850
 
        "use_filesystem_for_exec", "utf8_decode", "searched_specific_files",
2851
 
        "search_specific_files", "state", "source_index", "target_index",
2852
 
        "want_unversioned", "tree"]
 
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"]
2853
3180
 
2854
3181
    def __init__(self, include_unchanged, use_filesystem_for_exec,
2855
3182
        search_specific_files, state, source_index, target_index,
2856
3183
        want_unversioned, tree):
2857
3184
        self.old_dirname_to_file_id = {}
2858
3185
        self.new_dirname_to_file_id = {}
2859
 
        # Just a sentry, so that _process_entry can say that this
2860
 
        # record is handled, but isn't interesting to process (unchanged)
2861
 
        self.uninteresting = object()
 
3186
        # Are we doing a partial iter_changes?
 
3187
        self.partial = search_specific_files != set([''])
2862
3188
        # Using a list so that we can access the values and change them in
2863
3189
        # nested scope. Each one is [path, file_id, entry]
2864
3190
        self.last_source_parent = [None, None]
2867
3193
        self.use_filesystem_for_exec = use_filesystem_for_exec
2868
3194
        self.utf8_decode = cache_utf8._utf8_decode
2869
3195
        # for all search_indexs in each path at or under each element of
2870
 
        # search_specific_files, if the detail is relocated: add the id, and add the
2871
 
        # relocated path as one to search if its not searched already. If the
2872
 
        # detail is not relocated, add the id.
 
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.
2873
3199
        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()
2874
3203
        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()
2875
3209
        self.state = state
2876
3210
        self.source_index = source_index
2877
3211
        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')
2878
3215
        self.want_unversioned = want_unversioned
2879
3216
        self.tree = tree
2880
3217
 
2882
3219
        """Compare an entry and real disk to generate delta information.
2883
3220
 
2884
3221
        :param path_info: top_relpath, basename, kind, lstat, abspath for
2885
 
            the path of entry. If None, then the path is considered absent.
2886
 
            (Perhaps we should pass in a concrete entry for this ?)
 
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 ?)
2887
3224
            Basename is returned as a utf8 string because we expect this
2888
3225
            tuple will be ignored, and don't want to take the time to
2889
3226
            decode.
2890
 
        :return: None if these don't match
2891
 
                 A tuple of information about the change, or
2892
 
                 the object 'uninteresting' if these match, but are
2893
 
                 basically identical.
 
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.
2894
3234
        """
2895
3235
        if self.source_index is None:
2896
3236
            source_details = DirState.NULL_PARENT_DETAILS
2964
3304
                    if source_minikind != 'f':
2965
3305
                        content_change = True
2966
3306
                    else:
2967
 
                        # If the size is the same, check the sha:
2968
 
                        if target_details[2] == source_details[2]:
2969
 
                            if link_or_sha1 is None:
2970
 
                                # Stat cache miss:
2971
 
                                file_obj = file(path_info[4], 'rb')
2972
 
                                try:
2973
 
                                    statvalue = os.fstat(file_obj.fileno())
2974
 
                                    link_or_sha1 = osutils.sha_file(file_obj)
2975
 
                                finally:
2976
 
                                    file_obj.close()
2977
 
                                self.state._observed_sha1(entry, link_or_sha1,
2978
 
                                    statvalue)
2979
 
                            content_change = (link_or_sha1 != source_details[1])
2980
 
                        else:
2981
 
                            # Size changed, so must be different
2982
 
                            content_change = True
 
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])
2983
3318
                    # Target details is updated at update_entry time
2984
3319
                    if self.use_filesystem_for_exec:
2985
3320
                        # We don't need S_ISREG here, because we are sure
3000
3335
                        content_change = False
3001
3336
                    target_exec = False
3002
3337
                else:
3003
 
                    raise Exception, "unknown kind %s" % path_info[2]
 
3338
                    if path is None:
 
3339
                        path = pathjoin(old_dirname, old_basename)
 
3340
                    raise errors.BadFileKindError(path, path_info[2])
3004
3341
            if source_minikind == 'd':
3005
3342
                if path is None:
3006
3343
                    old_path = path = pathjoin(old_dirname, old_basename)
3007
3344
                self.old_dirname_to_file_id[old_path] = file_id
3008
3345
            # parent id is the entry for the path in the target tree
3009
 
            if old_dirname == self.last_source_parent[0]:
 
3346
            if old_basename and old_dirname == self.last_source_parent[0]:
3010
3347
                source_parent_id = self.last_source_parent[1]
3011
3348
            else:
3012
3349
                try:
3022
3359
                    self.last_source_parent[0] = old_dirname
3023
3360
                    self.last_source_parent[1] = source_parent_id
3024
3361
            new_dirname = entry[0][0]
3025
 
            if new_dirname == self.last_target_parent[0]:
 
3362
            if entry[0][1] and new_dirname == self.last_target_parent[0]:
3026
3363
                target_parent_id = self.last_target_parent[1]
3027
3364
            else:
3028
3365
                try:
3045
3382
                    self.last_target_parent[1] = target_parent_id
3046
3383
 
3047
3384
            source_exec = source_details[3]
3048
 
            if (self.include_unchanged
3049
 
                or content_change
 
3385
            changed = (content_change
3050
3386
                or source_parent_id != target_parent_id
3051
3387
                or old_basename != entry[0][1]
3052
3388
                or source_exec != target_exec
3053
 
                ):
 
3389
                )
 
3390
            if not changed and not self.include_unchanged:
 
3391
                return None, False
 
3392
            else:
3054
3393
                if old_path is None:
3055
3394
                    old_path = path = pathjoin(old_dirname, old_basename)
3056
3395
                    old_path_u = self.utf8_decode(old_path)[0]
3069
3408
                       (source_parent_id, target_parent_id),
3070
3409
                       (self.utf8_decode(old_basename)[0], self.utf8_decode(entry[0][1])[0]),
3071
3410
                       (source_kind, target_kind),
3072
 
                       (source_exec, target_exec))
3073
 
            else:
3074
 
                return self.uninteresting
 
3411
                       (source_exec, target_exec)), changed
3075
3412
        elif source_minikind in 'a' and target_minikind in 'fdlt':
3076
3413
            # looks like a new file
3077
3414
            path = pathjoin(entry[0][0], entry[0][1])
3098
3435
                       (None, parent_id),
3099
3436
                       (None, self.utf8_decode(entry[0][1])[0]),
3100
3437
                       (None, path_info[2]),
3101
 
                       (None, target_exec))
 
3438
                       (None, target_exec)), True
3102
3439
            else:
3103
3440
                # Its a missing file, report it as such.
3104
3441
                return (entry[0][2],
3108
3445
                       (None, parent_id),
3109
3446
                       (None, self.utf8_decode(entry[0][1])[0]),
3110
3447
                       (None, None),
3111
 
                       (None, False))
 
3448
                       (None, False)), True
3112
3449
        elif source_minikind in 'fdlt' and target_minikind in 'a':
3113
3450
            # unversioned, possibly, or possibly not deleted: we dont care.
3114
3451
            # if its still on disk, *and* theres no other entry at this
3126
3463
                   (parent_id, None),
3127
3464
                   (self.utf8_decode(entry[0][1])[0], None),
3128
3465
                   (DirState._minikind_to_kind[source_minikind], None),
3129
 
                   (source_details[3], None))
 
3466
                   (source_details[3], None)), True
3130
3467
        elif source_minikind in 'fdlt' and target_minikind in 'r':
3131
3468
            # a rename; could be a true rename, or a rename inherited from
3132
3469
            # a renamed parent. TODO: handle this efficiently. Its not
3144
3481
                "source_minikind=%r, target_minikind=%r"
3145
3482
                % (source_minikind, target_minikind))
3146
3483
            ## import pdb;pdb.set_trace()
3147
 
        return None
 
3484
        return None, None
3148
3485
 
3149
3486
    def __iter__(self):
3150
3487
        return self
3151
3488
 
 
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
 
3152
3508
    def iter_changes(self):
3153
3509
        """Iterate over the changes."""
3154
3510
        utf8_decode = cache_utf8._utf8_decode
3155
3511
        _cmp_by_dirs = cmp_by_dirs
3156
3512
        _process_entry = self._process_entry
3157
 
        uninteresting = self.uninteresting
3158
3513
        search_specific_files = self.search_specific_files
3159
3514
        searched_specific_files = self.searched_specific_files
3160
3515
        splitpath = osutils.splitpath
3161
 
        # sketch: 
 
3516
        # sketch:
3162
3517
        # compare source_index and target_index at or under each element of search_specific_files.
3163
3518
        # follow the following comparison table. Note that we only want to do diff operations when
3164
 
        # the target is fdl because thats when the walkdirs logic will have exposed the pathinfo 
 
3519
        # the target is fdl because thats when the walkdirs logic will have exposed the pathinfo
3165
3520
        # for the target.
3166
3521
        # cases:
3167
 
        # 
 
3522
        #
3168
3523
        # Source | Target | disk | action
3169
3524
        #   r    | fdlt   |      | add source to search, add id path move and perform
3170
3525
        #        |        |      | diff check on source-target
3171
 
        #   r    | fdlt   |  a   | dangling file that was present in the basis. 
 
3526
        #   r    | fdlt   |  a   | dangling file that was present in the basis.
3172
3527
        #        |        |      | ???
3173
3528
        #   r    |  a     |      | add source to search
3174
 
        #   r    |  a     |  a   | 
 
3529
        #   r    |  a     |  a   |
3175
3530
        #   r    |  r     |      | this path is present in a non-examined tree, skip.
3176
3531
        #   r    |  r     |  a   | this path is present in a non-examined tree, skip.
3177
3532
        #   a    | fdlt   |      | add new id
3230
3585
                continue
3231
3586
            path_handled = False
3232
3587
            for entry in root_entries:
3233
 
                result = _process_entry(entry, root_dir_info)
3234
 
                if result is not None:
 
3588
                result, changed = _process_entry(entry, root_dir_info)
 
3589
                if changed is not None:
3235
3590
                    path_handled = True
3236
 
                    if result is not uninteresting:
 
3591
                    if changed:
 
3592
                        self._gather_result_for_consistency(result)
 
3593
                    if changed or self.include_unchanged:
3237
3594
                        yield result
3238
3595
            if self.want_unversioned and not path_handled and root_dir_info:
3239
3596
                new_executable = bool(
3285
3642
                            raise AssertionError()
3286
3643
                        del current_dir_info[1][bzr_index]
3287
3644
            # walk until both the directory listing and the versioned metadata
3288
 
            # are exhausted. 
 
3645
            # are exhausted.
3289
3646
            if (block_index < len(self.state._dirblocks) and
3290
3647
                osutils.is_inside(current_root, self.state._dirblocks[block_index][0])):
3291
3648
                current_block = self.state._dirblocks[block_index]
3349
3706
                        for current_entry in current_block[1]:
3350
3707
                            # entry referring to file not present on disk.
3351
3708
                            # advance the entry only, after processing.
3352
 
                            result = _process_entry(current_entry, None)
3353
 
                            if result is not None:
3354
 
                                if result is not uninteresting:
 
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:
3355
3714
                                    yield result
3356
3715
                        block_index +=1
3357
3716
                        if (block_index < len(self.state._dirblocks) and
3382
3741
                while (current_entry is not None or
3383
3742
                    current_path_info is not None):
3384
3743
                    if current_entry is None:
3385
 
                        # the check for path_handled when the path is adnvaced
 
3744
                        # the check for path_handled when the path is advanced
3386
3745
                        # will yield this path if needed.
3387
3746
                        pass
3388
3747
                    elif current_path_info is None:
3389
3748
                        # no path is fine: the per entry code will handle it.
3390
 
                        result = _process_entry(current_entry, current_path_info)
3391
 
                        if result is not None:
3392
 
                            if result is not uninteresting:
 
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:
3393
3754
                                yield result
3394
3755
                    elif (current_entry[0][1] != current_path_info[1]
3395
3756
                          or current_entry[1][self.target_index][0] in 'ar'):
3408
3769
                        else:
3409
3770
                            # entry referring to file not present on disk.
3410
3771
                            # advance the entry only, after processing.
3411
 
                            result = _process_entry(current_entry, None)
3412
 
                            if result is not None:
3413
 
                                if result is not uninteresting:
 
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:
3414
3777
                                    yield result
3415
3778
                            advance_path = False
3416
3779
                    else:
3417
 
                        result = _process_entry(current_entry, current_path_info)
3418
 
                        if result is not None:
 
3780
                        result, changed = _process_entry(current_entry, current_path_info)
 
3781
                        if changed is not None:
3419
3782
                            path_handled = True
3420
 
                            if result is not uninteresting:
 
3783
                            if changed:
 
3784
                                self._gather_result_for_consistency(result)
 
3785
                            if changed or self.include_unchanged:
3421
3786
                                yield result
3422
3787
                    if advance_entry and current_entry is not None:
3423
3788
                        entry_index += 1
3452
3817
                            if current_path_info[2] in ('directory'):
3453
3818
                                del current_dir_info[1][path_index]
3454
3819
                                path_index -= 1
3455
 
                        # dont descend the disk iterator into any tree 
 
3820
                        # dont descend the disk iterator into any tree
3456
3821
                        # paths.
3457
3822
                        if current_path_info[2] == 'tree-reference':
3458
3823
                            del current_dir_info[1][path_index]
3482
3847
                        current_dir_info = dir_iterator.next()
3483
3848
                    except StopIteration:
3484
3849
                        current_dir_info = None
3485
 
_process_entry = ProcessEntryPython
 
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
3486
3968
 
3487
3969
 
3488
3970
# Try to load the compiled form if possible
3489
3971
try:
3490
 
    from bzrlib._dirstate_helpers_c import (
3491
 
        _read_dirblocks_c as _read_dirblocks,
3492
 
        bisect_dirblock_c as bisect_dirblock,
3493
 
        _bisect_path_left_c as _bisect_path_left,
3494
 
        _bisect_path_right_c as _bisect_path_right,
3495
 
        cmp_by_dirs_c as cmp_by_dirs,
 
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,
3496
3978
        ProcessEntryC as _process_entry,
3497
3979
        update_entry as update_entry,
3498
3980
        )
3499
 
except ImportError:
 
3981
except ImportError, e:
 
3982
    osutils.failed_to_load_extension(e)
3500
3983
    from bzrlib._dirstate_helpers_py import (
3501
 
        _read_dirblocks_py as _read_dirblocks,
3502
 
        bisect_dirblock_py as bisect_dirblock,
3503
 
        _bisect_path_left_py as _bisect_path_left,
3504
 
        _bisect_path_right_py as _bisect_path_right,
3505
 
        cmp_by_dirs_py as cmp_by_dirs,
 
3984
        _read_dirblocks,
 
3985
        bisect_dirblock,
 
3986
        _bisect_path_left,
 
3987
        _bisect_path_right,
 
3988
        cmp_by_dirs,
3506
3989
        )
 
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