~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/dirstate.py

  • Committer: John Ferlito
  • Date: 2009-09-02 04:31:45 UTC
  • mto: (4665.7.1 serve-init)
  • mto: This revision was merged to the branch mainline in revision 4913.
  • Revision ID: johnf@inodes.org-20090902043145-gxdsfw03ilcwbyn5
Add a debian init script for bzr --serve

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
222
224
    )
223
225
 
224
226
 
225
 
def pack_stat(st, _encode=binascii.b2a_base64, _pack=struct.pack):
226
 
    """Convert stat values into a packed representation."""
227
 
    # jam 20060614 it isn't really worth removing more entries if we
228
 
    # are going to leave it in packed form.
229
 
    # With only st_mtime and st_mode filesize is 5.5M and read time is 275ms
230
 
    # With all entries, filesize is 5.9M and read time is maybe 280ms
231
 
    # well within the noise margin
232
 
 
233
 
    # base64 encoding always adds a final newline, so strip it off
234
 
    # The current version
235
 
    return _encode(_pack('>LLLLLL'
236
 
        , st.st_size, int(st.st_mtime), int(st.st_ctime)
237
 
        , st.st_dev, st.st_ino & 0xFFFFFFFF, st.st_mode))[:-1]
238
 
    # This is 0.060s / 1.520s faster by not encoding as much information
239
 
    # return _encode(_pack('>LL', int(st.st_mtime), st.st_mode))[:-1]
240
 
    # This is not strictly faster than _encode(_pack())[:-1]
241
 
    # return '%X.%X.%X.%X.%X.%X' % (
242
 
    #      st.st_size, int(st.st_mtime), int(st.st_ctime),
243
 
    #      st.st_dev, st.st_ino, st.st_mode)
244
 
    # Similar to the _encode(_pack('>LL'))
245
 
    # return '%X.%X' % (int(st.st_mtime), st.st_mode)
 
227
# This is the Windows equivalent of ENOTDIR
 
228
# It is defined in pywin32.winerror, but we don't want a strong dependency for
 
229
# just an error code.
 
230
ERROR_PATH_NOT_FOUND = 3
 
231
ERROR_DIRECTORY = 267
 
232
 
 
233
 
 
234
if not getattr(struct, '_compile', None):
 
235
    # Cannot pre-compile the dirstate pack_stat
 
236
    def pack_stat(st, _encode=binascii.b2a_base64, _pack=struct.pack):
 
237
        """Convert stat values into a packed representation."""
 
238
        return _encode(_pack('>LLLLLL', st.st_size, int(st.st_mtime),
 
239
            int(st.st_ctime), st.st_dev, st.st_ino & 0xFFFFFFFF,
 
240
            st.st_mode))[:-1]
 
241
else:
 
242
    # compile the struct compiler we need, so as to only do it once
 
243
    from _struct import Struct
 
244
    _compiled_pack = Struct('>LLLLLL').pack
 
245
    def pack_stat(st, _encode=binascii.b2a_base64, _pack=_compiled_pack):
 
246
        """Convert stat values into a packed representation."""
 
247
        # jam 20060614 it isn't really worth removing more entries if we
 
248
        # are going to leave it in packed form.
 
249
        # With only st_mtime and st_mode filesize is 5.5M and read time is 275ms
 
250
        # With all entries, filesize is 5.9M and read time is maybe 280ms
 
251
        # well within the noise margin
 
252
 
 
253
        # base64 encoding always adds a final newline, so strip it off
 
254
        # The current version
 
255
        return _encode(_pack(st.st_size, int(st.st_mtime), int(st.st_ctime),
 
256
            st.st_dev, st.st_ino & 0xFFFFFFFF, st.st_mode))[:-1]
 
257
        # This is 0.060s / 1.520s faster by not encoding as much information
 
258
        # return _encode(_pack('>LL', int(st.st_mtime), st.st_mode))[:-1]
 
259
        # This is not strictly faster than _encode(_pack())[:-1]
 
260
        # return '%X.%X.%X.%X.%X.%X' % (
 
261
        #      st.st_size, int(st.st_mtime), int(st.st_ctime),
 
262
        #      st.st_dev, st.st_ino, st.st_mode)
 
263
        # Similar to the _encode(_pack('>LL'))
 
264
        # return '%X.%X' % (int(st.st_mtime), st.st_mode)
 
265
 
 
266
 
 
267
class SHA1Provider(object):
 
268
    """An interface for getting sha1s of a file."""
 
269
 
 
270
    def sha1(self, abspath):
 
271
        """Return the sha1 of a file given its absolute path.
 
272
 
 
273
        :param abspath:  May be a filesystem encoded absolute path
 
274
             or a unicode path.
 
275
        """
 
276
        raise NotImplementedError(self.sha1)
 
277
 
 
278
    def stat_and_sha1(self, abspath):
 
279
        """Return the stat and sha1 of a file given its absolute path.
 
280
        
 
281
        :param abspath:  May be a filesystem encoded absolute path
 
282
             or a unicode path.
 
283
 
 
284
        Note: the stat should be the stat of the physical file
 
285
        while the sha may be the sha of its canonical content.
 
286
        """
 
287
        raise NotImplementedError(self.stat_and_sha1)
 
288
 
 
289
 
 
290
class DefaultSHA1Provider(SHA1Provider):
 
291
    """A SHA1Provider that reads directly from the filesystem."""
 
292
 
 
293
    def sha1(self, abspath):
 
294
        """Return the sha1 of a file given its absolute path."""
 
295
        return osutils.sha_file_by_name(abspath)
 
296
 
 
297
    def stat_and_sha1(self, abspath):
 
298
        """Return the stat and sha1 of a file given its absolute path."""
 
299
        file_obj = file(abspath, 'rb')
 
300
        try:
 
301
            statvalue = os.fstat(file_obj.fileno())
 
302
            sha1 = osutils.sha_file(file_obj)
 
303
        finally:
 
304
            file_obj.close()
 
305
        return statvalue, sha1
246
306
 
247
307
 
248
308
class DirState(object):
303
363
    HEADER_FORMAT_2 = '#bazaar dirstate flat format 2\n'
304
364
    HEADER_FORMAT_3 = '#bazaar dirstate flat format 3\n'
305
365
 
306
 
    def __init__(self, path):
 
366
    def __init__(self, path, sha1_provider):
307
367
        """Create a  DirState object.
308
368
 
309
369
        :param path: The path at which the dirstate file on disk should live.
 
370
        :param sha1_provider: an object meeting the SHA1Provider interface.
310
371
        """
311
372
        # _header_state and _dirblock_state represent the current state
312
373
        # of the dirstate metadata and the per-row data respectiely.
314
375
        # IN_MEMORY_UNMODIFIED indicates that what we have in memory
315
376
        #   is the same as is on disk
316
377
        # IN_MEMORY_MODIFIED indicates that we have a modified version
317
 
        #   of what is on disk. 
 
378
        #   of what is on disk.
318
379
        # In future we will add more granularity, for instance _dirblock_state
319
380
        # will probably support partially-in-memory as a separate variable,
320
381
        # allowing for partially-in-memory unmodified and partially-in-memory
321
382
        # modified states.
322
383
        self._header_state = DirState.NOT_IN_MEMORY
323
384
        self._dirblock_state = DirState.NOT_IN_MEMORY
324
 
        # 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
325
386
        # for safety we're not going to commit to disk.
326
387
        self._changes_aborted = False
327
388
        self._dirblocks = []
338
399
        self._cutoff_time = None
339
400
        self._split_path_cache = {}
340
401
        self._bisect_page_size = DirState.BISECT_PAGE_SIZE
 
402
        self._sha1_provider = sha1_provider
341
403
        if 'hashcache' in debug.debug_flags:
342
404
            self._sha1_file = self._sha1_file_and_mutter
343
405
        else:
344
 
            self._sha1_file = osutils.sha_file_by_name
 
406
            self._sha1_file = self._sha1_provider.sha1
345
407
        # These two attributes provide a simple cache for lookups into the
346
408
        # dirstate in-memory vectors. By probing respectively for the last
347
409
        # block, and for the next entry, we save nearly 2 bisections per path
357
419
        """Add a path to be tracked.
358
420
 
359
421
        :param path: The path within the dirstate - '' is the root, 'foo' is the
360
 
            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
361
423
            within the root.
362
424
        :param file_id: The file id of the path being added.
363
 
        :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',
364
426
            'directory', etc.
365
427
        :param stat: The output of os.lstat for the path.
366
 
        :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),
367
430
            or the target of a symlink,
368
431
            or the referenced revision id for tree-references,
369
432
            or '' for directories.
370
433
        """
371
434
        # adding a file:
372
 
        # find the block its in. 
 
435
        # find the block its in.
373
436
        # find the location in the block.
374
437
        # check its not there
375
438
        # add it.
388
451
        # in the parent, or according to the special treatment for the root
389
452
        if basename == '.' or basename == '..':
390
453
            raise errors.InvalidEntryName(path)
391
 
        # 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
392
455
        # dirname and basename elements. This single encode and split should be
393
456
        # faster than three separate encodes.
394
457
        utf8path = (dirname + '/' + basename).strip('/').encode('utf8')
398
461
            raise AssertionError(
399
462
                "must be a utf8 file_id not %s" % (type(file_id), ))
400
463
        # Make sure the file_id does not exist in this tree
401
 
        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)
402
466
        if file_id_entry != (None, None):
403
 
            path = osutils.pathjoin(file_id_entry[0][0], file_id_entry[0][1])
404
 
            kind = DirState._minikind_to_kind[file_id_entry[1][0][0]]
405
 
            info = '%s:%s' % (kind, path)
406
 
            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)
407
482
        first_key = (dirname, basename, '')
408
483
        block_index, present = self._find_block_index_from_key(first_key)
409
484
        if present:
410
485
            # check the path is not in the tree
411
486
            block = self._dirblocks[block_index][1]
412
487
            entry_index, _ = self._find_entry_index(first_key, block)
413
 
            while (entry_index < len(block) and 
 
488
            while (entry_index < len(block) and
414
489
                block[entry_index][0][0:2] == first_key[0:2]):
415
490
                if block[entry_index][1][0][0] not in 'ar':
416
491
                    # this path is in the dirstate in the current tree.
436
511
            packed_stat = pack_stat(stat)
437
512
        parent_info = self._empty_parent_info()
438
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, '')
439
520
        if kind == 'file':
440
521
            entry_data = entry_key, [
441
522
                (minikind, fingerprint, size, False, packed_stat),
900
981
 
901
982
    def _discard_merge_parents(self):
902
983
        """Discard any parents trees beyond the first.
903
 
        
 
984
 
904
985
        Note that if this fails the dirstate is corrupted.
905
986
 
906
987
        After this function returns the dirstate contains 2 trees, neither of
976
1057
                raise AssertionError("bad dirname %r" % dirname)
977
1058
        block_index, present = self._find_block_index_from_key((dirname, '', ''))
978
1059
        if not present:
979
 
            ## In future, when doing partial parsing, this should load and 
 
1060
            ## In future, when doing partial parsing, this should load and
980
1061
            # populate the entire block.
981
1062
            self._dirblocks.insert(block_index, (dirname, []))
982
1063
        return block_index
994
1075
        if new_entries[0][0][0:2] != ('', ''):
995
1076
            raise AssertionError(
996
1077
                "Missing root row %r" % (new_entries[0][0],))
997
 
        # The two blocks here are deliberate: the root block and the 
 
1078
        # The two blocks here are deliberate: the root block and the
998
1079
        # contents-of-root block.
999
1080
        self._dirblocks = [('', []), ('', [])]
1000
1081
        current_block = self._dirblocks[0][1]
1033
1114
        self._dirblocks[0] = ('', root_block)
1034
1115
        self._dirblocks[1] = ('', contents_of_root_block)
1035
1116
 
 
1117
    def _entries_for_path(self, path):
 
1118
        """Return a list with all the entries that match path for all ids."""
 
1119
        dirname, basename = os.path.split(path)
 
1120
        key = (dirname, basename, '')
 
1121
        block_index, present = self._find_block_index_from_key(key)
 
1122
        if not present:
 
1123
            # the block which should contain path is absent.
 
1124
            return []
 
1125
        result = []
 
1126
        block = self._dirblocks[block_index][1]
 
1127
        entry_index, _ = self._find_entry_index(key, block)
 
1128
        # we may need to look at multiple entries at this path: walk while the specific_files match.
 
1129
        while (entry_index < len(block) and
 
1130
            block[entry_index][0][0:2] == key[0:2]):
 
1131
            result.append(block[entry_index])
 
1132
            entry_index += 1
 
1133
        return result
 
1134
 
1036
1135
    def _entry_to_line(self, entry):
1037
1136
        """Serialize entry to a NULL delimited line ready for _get_output_lines.
1038
1137
 
1106
1205
        # one to use it. we use _right here because there are two
1107
1206
        # '' blocks - the root, and the contents of root
1108
1207
        # we always have a minimum of 2 in self._dirblocks: root and
1109
 
        # root-contents, and for '', we get 2 back, so this is 
 
1208
        # root-contents, and for '', we get 2 back, so this is
1110
1209
        # simple and correct:
1111
1210
        present = (block_index < len(self._dirblocks) and
1112
1211
            self._dirblocks[block_index][0] == key[0])
1141
1240
        return entry_index, present
1142
1241
 
1143
1242
    @staticmethod
1144
 
    def from_tree(tree, dir_state_filename):
 
1243
    def from_tree(tree, dir_state_filename, sha1_provider=None):
1145
1244
        """Create a dirstate from a bzr Tree.
1146
1245
 
1147
1246
        :param tree: The tree which should provide parent information and
1148
1247
            inventory ids.
 
1248
        :param sha1_provider: an object meeting the SHA1Provider interface.
 
1249
            If None, a DefaultSHA1Provider is used.
1149
1250
        :return: a DirState object which is currently locked for writing.
1150
1251
            (it was locked by DirState.initialize)
1151
1252
        """
1152
 
        result = DirState.initialize(dir_state_filename)
 
1253
        result = DirState.initialize(dir_state_filename,
 
1254
            sha1_provider=sha1_provider)
1153
1255
        try:
1154
1256
            tree.lock_read()
1155
1257
            try:
1176
1278
    def update_by_delta(self, delta):
1177
1279
        """Apply an inventory delta to the dirstate for tree 0
1178
1280
 
 
1281
        This is the workhorse for apply_inventory_delta in dirstate based
 
1282
        trees.
 
1283
 
1179
1284
        :param delta: An inventory delta.  See Inventory.apply_delta for
1180
1285
            details.
1181
1286
        """
1182
1287
        self._read_dirblocks_if_needed()
 
1288
        encode = cache_utf8.encode
1183
1289
        insertions = {}
1184
1290
        removals = {}
1185
 
        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):
1186
1308
            if (file_id in insertions) or (file_id in removals):
1187
 
                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")
1188
1311
            if old_path is not None:
1189
1312
                old_path = old_path.encode('utf-8')
1190
1313
                removals[file_id] = old_path
 
1314
            else:
 
1315
                new_ids.add(file_id)
1191
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")
1192
1320
                new_path = new_path.encode('utf-8')
1193
 
                dirname, basename = osutils.split(new_path)
1194
 
                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)
1195
1325
                minikind = DirState._kind_to_minikind[inv_entry.kind]
1196
1326
                if minikind == 't':
1197
1327
                    fingerprint = inv_entry.reference_revision
1219
1349
                                                  child_basename)
1220
1350
                    insertions[child[0][2]] = (key, minikind, executable,
1221
1351
                                               fingerprint, new_child_path)
1222
 
        self._apply_removals(removals.values())
1223
 
        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.")
1224
1366
 
1225
1367
    def _apply_removals(self, removals):
1226
 
        for path in sorted(removals, reverse=True):
 
1368
        for file_id, path in sorted(removals, reverse=True,
 
1369
            key=operator.itemgetter(1)):
1227
1370
            dirname, basename = osutils.split(path)
1228
1371
            block_i, entry_i, d_present, f_present = \
1229
1372
                self._get_block_entry_index(dirname, basename, 0)
1230
 
            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])
1231
1388
            self._make_absent(entry)
1232
1389
            # See if we have a malformed delta: deleting a directory must not
1233
1390
            # leave crud behind. This increases the number of bisects needed
1241
1398
                # be due to it being in a parent tree, or a corrupt delta.
1242
1399
                for child_entry in self._dirblocks[block_i][1]:
1243
1400
                    if child_entry[1][0][0] not in ('r', 'a'):
 
1401
                        self._changes_aborted = True
1244
1402
                        raise errors.InconsistentDelta(path, entry[0][2],
1245
1403
                            "The file id was deleted but its children were "
1246
1404
                            "not deleted.")
1247
1405
 
1248
1406
    def _apply_insertions(self, adds):
1249
 
        for key, minikind, executable, fingerprint, path_utf8 in sorted(adds):
1250
 
            self.update_minimal(key, minikind, executable, fingerprint,
1251
 
                                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")
1252
1415
 
1253
1416
    def update_basis_by_delta(self, delta, new_revid):
1254
1417
        """Update the parents of this tree after a commit.
1298
1461
        # At the same time, to reduce interface friction we convert the input
1299
1462
        # inventory entries to dirstate.
1300
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()
1301
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))
1302
1485
            if old_path is None:
1303
1486
                adds.append((None, encode(new_path), file_id,
1304
1487
                    inv_to_entry(inv_entry), True))
 
1488
                new_ids.add(file_id)
1305
1489
            elif new_path is None:
1306
1490
                deletes.append((encode(old_path), None, file_id, None, True))
1307
1491
            elif (old_path, new_path) != root_only:
1319
1503
                # for 'r' items on every pass.
1320
1504
                self._update_basis_apply_deletes(deletes)
1321
1505
                deletes = []
1322
 
                new_path_utf8 = encode(new_path)
1323
1506
                # Split into an add/delete pair recursively.
1324
1507
                adds.append((None, new_path_utf8, file_id,
1325
1508
                    inv_to_entry(inv_entry), False))
1351
1534
                # of everything.
1352
1535
                changes.append((encode(old_path), encode(new_path), file_id,
1353
1536
                    inv_to_entry(inv_entry)))
1354
 
 
1355
 
        # Finish expunging deletes/first half of renames.
1356
 
        self._update_basis_apply_deletes(deletes)
1357
 
        # Reinstate second half of renames and new paths.
1358
 
        self._update_basis_apply_adds(adds)
1359
 
        # Apply in-situ changes.
1360
 
        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.")
1361
1557
 
1362
1558
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
1363
1559
        self._header_state = DirState.IN_MEMORY_MODIFIED
1364
1560
        self._id_index = None
1365
1561
        return
1366
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
 
1367
1586
    def _update_basis_apply_adds(self, adds):
1368
1587
        """Apply a sequence of adds to tree 1 during update_basis_by_delta.
1369
1588
 
1434
1653
        null = DirState.NULL_PARENT_DETAILS
1435
1654
        for old_path, new_path, file_id, _, real_delete in deletes:
1436
1655
            if real_delete != (new_path is None):
 
1656
                self._changes_aborted = True
1437
1657
                raise AssertionError("bad delete delta")
1438
1658
            # the entry for this file_id must be in tree 1.
1439
1659
            dirname, basename = osutils.split(old_path)
1472
1692
                    # it is being resurrected here, so blank it out temporarily.
1473
1693
                    self._dirblocks[block_index][1][entry_index][1][1] = null
1474
1694
 
1475
 
    def update_entry(self, entry, abspath, stat_value,
1476
 
                     _stat_to_minikind=_stat_to_minikind,
1477
 
                     _pack_stat=pack_stat):
1478
 
        """Update the entry based on what is actually on disk.
1479
 
 
1480
 
        :param entry: This is the dirblock entry for the file in question.
1481
 
        :param abspath: The path on disk for this file.
1482
 
        :param stat_value: (optional) if we already have done a stat on the
1483
 
            file, re-use it.
1484
 
        :return: The sha1 hexdigest of the file (40 bytes) or link target of a
1485
 
                symlink.
 
1695
    def _after_delta_check_parents(self, parents, index):
 
1696
        """Check that parents required by the delta are all intact.
 
1697
        
 
1698
        :param parents: An iterable of (path_utf8, file_id) tuples which are
 
1699
            required to be present in tree 'index' at path_utf8 with id file_id
 
1700
            and be a directory.
 
1701
        :param index: The column in the dirstate to check for parents in.
 
1702
        """
 
1703
        for dirname_utf8, file_id in parents:
 
1704
            # Get the entry - the ensures that file_id, dirname_utf8 exists and
 
1705
            # has the right file id.
 
1706
            entry = self._get_entry(index, file_id, dirname_utf8)
 
1707
            if entry[1] is None:
 
1708
                self._changes_aborted = True
 
1709
                raise errors.InconsistentDelta(dirname_utf8.decode('utf8'),
 
1710
                    file_id, "This parent is not present.")
 
1711
            # Parents of things must be directories
 
1712
            if entry[1][index][0] != 'd':
 
1713
                self._changes_aborted = True
 
1714
                raise errors.InconsistentDelta(dirname_utf8.decode('utf8'),
 
1715
                    file_id, "This parent is not a directory.")
 
1716
 
 
1717
    def _observed_sha1(self, entry, sha1, stat_value,
 
1718
        _stat_to_minikind=_stat_to_minikind, _pack_stat=pack_stat):
 
1719
        """Note the sha1 of a file.
 
1720
 
 
1721
        :param entry: The entry the sha1 is for.
 
1722
        :param sha1: The observed sha1.
 
1723
        :param stat_value: The os.lstat for the file.
1486
1724
        """
1487
1725
        try:
1488
1726
            minikind = _stat_to_minikind[stat_value.st_mode & 0170000]
1490
1728
            # Unhandled kind
1491
1729
            return None
1492
1730
        packed_stat = _pack_stat(stat_value)
1493
 
        (saved_minikind, saved_link_or_sha1, saved_file_size,
1494
 
         saved_executable, saved_packed_stat) = entry[1][0]
1495
 
 
1496
 
        if (minikind == saved_minikind
1497
 
            and packed_stat == saved_packed_stat):
1498
 
            # The stat hasn't changed since we saved, so we can re-use the
1499
 
            # saved sha hash.
1500
 
            if minikind == 'd':
1501
 
                return None
1502
 
 
1503
 
            # size should also be in packed_stat
1504
 
            if saved_file_size == stat_value.st_size:
1505
 
                return saved_link_or_sha1
1506
 
 
1507
 
        # If we have gotten this far, that means that we need to actually
1508
 
        # process this entry.
1509
 
        link_or_sha1 = None
1510
1731
        if minikind == 'f':
1511
 
            link_or_sha1 = self._sha1_file(abspath)
1512
 
            executable = self._is_executable(stat_value.st_mode,
1513
 
                                             saved_executable)
1514
 
            if self._cutoff_time is None:
1515
 
                self._sha_cutoff_time()
1516
 
            if (stat_value.st_mtime < self._cutoff_time
1517
 
                and stat_value.st_ctime < self._cutoff_time):
1518
 
                entry[1][0] = ('f', link_or_sha1, stat_value.st_size,
1519
 
                               executable, packed_stat)
1520
 
            else:
1521
 
                entry[1][0] = ('f', '', stat_value.st_size,
1522
 
                               executable, DirState.NULLSTAT)
1523
 
        elif minikind == 'd':
1524
 
            link_or_sha1 = None
1525
 
            entry[1][0] = ('d', '', 0, False, packed_stat)
1526
 
            if saved_minikind != 'd':
1527
 
                # This changed from something into a directory. Make sure we
1528
 
                # have a directory block for it. This doesn't happen very
1529
 
                # often, so this doesn't have to be super fast.
1530
 
                block_index, entry_index, dir_present, file_present = \
1531
 
                    self._get_block_entry_index(entry[0][0], entry[0][1], 0)
1532
 
                self._ensure_block(block_index, entry_index,
1533
 
                                   osutils.pathjoin(entry[0][0], entry[0][1]))
1534
 
        elif minikind == 'l':
1535
 
            link_or_sha1 = self._read_link(abspath, saved_link_or_sha1)
1536
 
            if self._cutoff_time is None:
1537
 
                self._sha_cutoff_time()
1538
 
            if (stat_value.st_mtime < self._cutoff_time
1539
 
                and stat_value.st_ctime < self._cutoff_time):
1540
 
                entry[1][0] = ('l', link_or_sha1, stat_value.st_size,
1541
 
                               False, packed_stat)
1542
 
            else:
1543
 
                entry[1][0] = ('l', '', stat_value.st_size,
1544
 
                               False, DirState.NULLSTAT)
1545
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
1546
 
        return link_or_sha1
 
1732
            if self._cutoff_time is None:
 
1733
                self._sha_cutoff_time()
 
1734
            if (stat_value.st_mtime < self._cutoff_time
 
1735
                and stat_value.st_ctime < self._cutoff_time):
 
1736
                entry[1][0] = ('f', sha1, entry[1][0][2], entry[1][0][3],
 
1737
                    packed_stat)
 
1738
                self._dirblock_state = DirState.IN_MEMORY_MODIFIED
1547
1739
 
1548
1740
    def _sha_cutoff_time(self):
1549
1741
        """Return cutoff time.
1566
1758
        # when -Dhashcache is turned on, this is monkey-patched in to log
1567
1759
        # file reads
1568
1760
        trace.mutter("dirstate sha1 " + abspath)
1569
 
        return osutils.sha_file_by_name(abspath)
 
1761
        return self._sha1_provider.sha1(abspath)
1570
1762
 
1571
1763
    def _is_executable(self, mode, old_executable):
1572
1764
        """Is this file executable?"""
1585
1777
        #       already in memory. However, this really needs to be done at a
1586
1778
        #       higher level, because there either won't be anything on disk,
1587
1779
        #       or the thing on disk will be a file.
1588
 
        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
1589
1792
 
1590
1793
    def get_ghosts(self):
1591
1794
        """Return a list of the parent tree revision ids that are ghosts."""
1737
1940
            entry_index += 1
1738
1941
        return block_index, entry_index, True, False
1739
1942
 
1740
 
    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):
1741
1944
        """Get the dirstate entry for path in tree tree_index.
1742
1945
 
1743
1946
        If either file_id or path is supplied, it is used as the key to lookup.
1751
1954
            trees.
1752
1955
        :param fileid_utf8: A utf8 file_id to look up.
1753
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.
1754
1960
        :return: The dirstate entry tuple for path, or (None, None)
1755
1961
        """
1756
1962
        self._read_dirblocks_if_needed()
1757
1963
        if path_utf8 is not None:
1758
1964
            if type(path_utf8) is not str:
1759
 
                raise AssertionError('path_utf8 is not a str: %s %s'
 
1965
                raise errors.BzrError('path_utf8 is not a str: %s %r'
1760
1966
                    % (type(path_utf8), path_utf8))
1761
1967
            # path lookups are faster
1762
1968
            dirname, basename = osutils.split(path_utf8)
1792
1998
                if present:
1793
1999
                    entry = self._dirblocks[block_index][1][entry_index]
1794
2000
                    if entry[1][tree_index][0] in 'fdlt':
1795
 
                        # this is the result we are looking for: the  
 
2001
                        # this is the result we are looking for: the
1796
2002
                        # real home of this file_id in this tree.
1797
2003
                        return entry
1798
2004
                    if entry[1][tree_index][0] == 'a':
1799
2005
                        # there is no home for this entry in this tree
 
2006
                        if include_deleted:
 
2007
                            return entry
1800
2008
                        return None, None
1801
2009
                    if entry[1][tree_index][0] != 'r':
1802
2010
                        raise AssertionError(
1810
2018
            return None, None
1811
2019
 
1812
2020
    @classmethod
1813
 
    def initialize(cls, path):
 
2021
    def initialize(cls, path, sha1_provider=None):
1814
2022
        """Create a new dirstate on path.
1815
2023
 
1816
2024
        The new dirstate will be an empty tree - that is it has no parents,
1817
2025
        and only a root node - which has id ROOT_ID.
1818
2026
 
1819
2027
        :param path: The name of the file for the dirstate.
 
2028
        :param sha1_provider: an object meeting the SHA1Provider interface.
 
2029
            If None, a DefaultSHA1Provider is used.
1820
2030
        :return: A write-locked DirState object.
1821
2031
        """
1822
2032
        # This constructs a new DirState object on a path, sets the _state_file
1824
2034
        # stock empty dirstate information - a root with ROOT_ID, no children,
1825
2035
        # and no parents. Finally it calls save() to ensure that this data will
1826
2036
        # persist.
1827
 
        result = cls(path)
 
2037
        if sha1_provider is None:
 
2038
            sha1_provider = DefaultSHA1Provider()
 
2039
        result = cls(path, sha1_provider)
1828
2040
        # root dir and root dir contents with no children.
1829
2041
        empty_tree_dirblocks = [('', []), ('', [])]
1830
2042
        # a new root directory, with a NULLSTAT.
1858
2070
            size = 0
1859
2071
            executable = False
1860
2072
        elif kind == 'symlink':
1861
 
            # We don't support non-ascii targets for symlinks yet.
1862
 
            fingerprint = str(inv_entry.symlink_target or '')
 
2073
            if inv_entry.symlink_target is None:
 
2074
                fingerprint = ''
 
2075
            else:
 
2076
                fingerprint = inv_entry.symlink_target.encode('utf8')
1863
2077
            size = 0
1864
2078
            executable = False
1865
2079
        elif kind == 'file':
1877
2091
    def _iter_child_entries(self, tree_index, path_utf8):
1878
2092
        """Iterate over all the entries that are children of path_utf.
1879
2093
 
1880
 
        This only returns entries that are present (not in 'a', 'r') in 
 
2094
        This only returns entries that are present (not in 'a', 'r') in
1881
2095
        tree_index. tree_index data is not refreshed, so if tree 0 is used,
1882
2096
        results may differ from that obtained if paths were statted to
1883
2097
        determine what ones were directories.
1914
2128
                        else:
1915
2129
                            path = entry[0][1]
1916
2130
                        next_pending_dirs.append(path)
1917
 
    
 
2131
 
1918
2132
    def _iter_entries(self):
1919
2133
        """Iterate over all the entries in the dirstate.
1920
2134
 
1961
2175
        return len(self._parents) - len(self._ghosts)
1962
2176
 
1963
2177
    @staticmethod
1964
 
    def on_file(path):
1965
 
        """Construct a DirState on the file at path path.
 
2178
    def on_file(path, sha1_provider=None):
 
2179
        """Construct a DirState on the file at path "path".
1966
2180
 
 
2181
        :param path: The path at which the dirstate file on disk should live.
 
2182
        :param sha1_provider: an object meeting the SHA1Provider interface.
 
2183
            If None, a DefaultSHA1Provider is used.
1967
2184
        :return: An unlocked DirState object, associated with the given path.
1968
2185
        """
1969
 
        result = DirState(path)
 
2186
        if sha1_provider is None:
 
2187
            sha1_provider = DefaultSHA1Provider()
 
2188
        result = DirState(path, sha1_provider)
1970
2189
        return result
1971
2190
 
1972
2191
    def _read_dirblocks_if_needed(self):
1973
2192
        """Read in all the dirblocks from the file if they are not in memory.
1974
 
        
 
2193
 
1975
2194
        This populates self._dirblocks, and sets self._dirblock_state to
1976
2195
        IN_MEMORY_UNMODIFIED. It is not currently ready for incremental block
1977
2196
        loading.
2102
2321
 
2103
2322
        :param parent_ids: A list of parent tree revision ids.
2104
2323
        :param dirblocks: A list containing one tuple for each directory in the
2105
 
            tree. Each tuple contains the directory path and a list of entries 
 
2324
            tree. Each tuple contains the directory path and a list of entries
2106
2325
            found in that directory.
2107
2326
        """
2108
2327
        # our memory copy is now authoritative.
2142
2361
        """Set the parent trees for the dirstate.
2143
2362
 
2144
2363
        :param trees: A list of revision_id, tree tuples. tree must be provided
2145
 
            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
2146
2365
            this case.
2147
2366
        :param ghosts: A list of the revision_ids that are ghosts at the time
2148
2367
            of setting.
2149
 
        """ 
2150
 
        # TODO: generate a list of parent indexes to preserve to save 
 
2368
        """
 
2369
        # TODO: generate a list of parent indexes to preserve to save
2151
2370
        # processing specific parent trees. In the common case one tree will
2152
2371
        # be preserved - the left most parent.
2153
2372
        # TODO: if the parent tree is a dirstate, we might want to walk them
2158
2377
        # map and then walk the new parent trees only, mapping them into the
2159
2378
        # dirstate. Walk the dirstate at the same time to remove unreferenced
2160
2379
        # entries.
2161
 
        # for now: 
2162
 
        # sketch: loop over all entries in the dirstate, cherry picking 
 
2380
        # for now:
 
2381
        # sketch: loop over all entries in the dirstate, cherry picking
2163
2382
        # entries from the parent trees, if they are not ghost trees.
2164
2383
        # after we finish walking the dirstate, all entries not in the dirstate
2165
2384
        # are deletes, so we want to append them to the end as per the design
2170
2389
        #   links. We dont't trivially use the inventory from other trees
2171
2390
        #   because this leads to either double touching, or to accessing
2172
2391
        #   missing keys,
2173
 
        # - find other keys containing a path 
2174
 
        # 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
2175
2394
        by_path = {}
2176
2395
        id_index = {}
2177
2396
        # we could do parallel iterators, but because file id data may be
2181
2400
        # parent, but for now the common cases are adding a new parent (merge),
2182
2401
        # and replacing completely (commit), and commit is more common: so
2183
2402
        # optimise merge later.
2184
 
        
 
2403
 
2185
2404
        # ---- start generation of full tree mapping data
2186
2405
        # what trees should we use?
2187
2406
        parent_trees = [tree for rev_id, tree in trees if rev_id not in ghosts]
2188
 
        # how many trees do we end up with 
 
2407
        # how many trees do we end up with
2189
2408
        parent_count = len(parent_trees)
2190
2409
 
2191
2410
        # one: the current tree
2196
2415
            by_path[entry[0]] = [entry[1][0]] + \
2197
2416
                [DirState.NULL_PARENT_DETAILS] * parent_count
2198
2417
            id_index[entry[0][2]] = set([entry[0]])
2199
 
        
 
2418
 
2200
2419
        # now the parent trees:
2201
2420
        for tree_index, tree in enumerate(parent_trees):
2202
2421
            # the index is off by one, adjust it.
2216
2435
                # avoid checking all known paths for the id when generating a
2217
2436
                # new entry at this path: by adding the id->path mapping last,
2218
2437
                # all the mappings are valid and have correct relocation
2219
 
                # records where needed. 
 
2438
                # records where needed.
2220
2439
                file_id = entry.file_id
2221
2440
                path_utf8 = path.encode('utf8')
2222
2441
                dirname, basename = osutils.split(path_utf8)
2233
2452
                        # This is the vertical axis in the matrix, all pointing
2234
2453
                        # to the real path.
2235
2454
                        by_path[entry_key][tree_index] = ('r', path_utf8, 0, False, '')
2236
 
                # by path consistency: Insert into an existing path record (trivial), or 
 
2455
                # by path consistency: Insert into an existing path record (trivial), or
2237
2456
                # add a new one with relocation pointers for the other tree indexes.
2238
2457
                if new_entry_key in id_index[file_id]:
2239
2458
                    # there is already an entry where this data belongs, just insert it.
2252
2471
                            new_details.append(DirState.NULL_PARENT_DETAILS)
2253
2472
                        else:
2254
2473
                            # grab any one entry, use it to find the right path.
2255
 
                            # TODO: optimise this to reduce memory use in highly 
 
2474
                            # TODO: optimise this to reduce memory use in highly
2256
2475
                            # fragmented situations by reusing the relocation
2257
2476
                            # records.
2258
2477
                            a_key = iter(id_index[file_id]).next()
2291
2510
        return sorted(entry_list, key=_key)
2292
2511
 
2293
2512
    def set_state_from_inventory(self, new_inv):
2294
 
        """Set new_inv as the current state. 
 
2513
        """Set new_inv as the current state.
2295
2514
 
2296
2515
        This API is called by tree transform, and will usually occur with
2297
2516
        existing parent trees.
2301
2520
        if 'evil' in debug.debug_flags:
2302
2521
            trace.mutter_callsite(1,
2303
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:")
2304
2526
        self._read_dirblocks_if_needed()
2305
2527
        # sketch:
2306
 
        # Two iterators: current data and new data, both in dirblock order. 
 
2528
        # Two iterators: current data and new data, both in dirblock order.
2307
2529
        # We zip them together, which tells about entries that are new in the
2308
2530
        # inventory, or removed in the inventory, or present in both and
2309
 
        # possibly changed.  
 
2531
        # possibly changed.
2310
2532
        #
2311
2533
        # You might think we could just synthesize a new dirstate directly
2312
2534
        # since we're processing it in the right order.  However, we need to
2315
2537
        new_iterator = new_inv.iter_entries_by_dir()
2316
2538
        # we will be modifying the dirstate, so we need a stable iterator. In
2317
2539
        # future we might write one, for now we just clone the state into a
2318
 
        # 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.
2319
2543
        old_iterator = iter(list(self._iter_entries()))
2320
2544
        # both must have roots so this is safe:
2321
2545
        current_new = new_iterator.next()
2355
2579
            # we make both end conditions explicit
2356
2580
            if not current_old:
2357
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'))
2358
2585
                self.update_minimal(new_entry_key, current_new_minikind,
2359
2586
                    executable=current_new[1].executable,
2360
 
                    path_utf8=new_path_utf8, fingerprint=fingerprint)
 
2587
                    path_utf8=new_path_utf8, fingerprint=fingerprint,
 
2588
                    fullscan=True)
2361
2589
                current_new = advance(new_iterator)
2362
2590
            elif not current_new:
2363
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'))
2364
2596
                self._make_absent(current_old)
2365
2597
                current_old = advance(old_iterator)
2366
2598
            elif new_entry_key == current_old[0]:
2373
2605
                # kind has changed.
2374
2606
                if (current_old[1][0][3] != current_new[1].executable or
2375
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'))
2376
2611
                    self.update_minimal(current_old[0], current_new_minikind,
2377
2612
                        executable=current_new[1].executable,
2378
 
                        path_utf8=new_path_utf8, fingerprint=fingerprint)
 
2613
                        path_utf8=new_path_utf8, fingerprint=fingerprint,
 
2614
                        fullscan=True)
2379
2615
                # both sides are dealt with, move on
2380
2616
                current_old = advance(old_iterator)
2381
2617
                current_new = advance(new_iterator)
2384
2620
                      and new_entry_key[1:] < current_old[0][1:])):
2385
2621
                # new comes before:
2386
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'))
2387
2626
                self.update_minimal(new_entry_key, current_new_minikind,
2388
2627
                    executable=current_new[1].executable,
2389
 
                    path_utf8=new_path_utf8, fingerprint=fingerprint)
 
2628
                    path_utf8=new_path_utf8, fingerprint=fingerprint,
 
2629
                    fullscan=True)
2390
2630
                current_new = advance(new_iterator)
2391
2631
            else:
2392
2632
                # we've advanced past the place where the old key would be,
2393
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'))
2394
2638
                self._make_absent(current_old)
2395
2639
                current_old = advance(old_iterator)
2396
2640
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
2397
2641
        self._id_index = None
2398
2642
        self._packed_stat_index = None
 
2643
        if tracing:
 
2644
            trace.mutter("set_state_from_inventory complete.")
2399
2645
 
2400
2646
    def _make_absent(self, current_old):
2401
2647
        """Mark current_old - an entry - as absent for tree 0.
2450
2696
        return last_reference
2451
2697
 
2452
2698
    def update_minimal(self, key, minikind, executable=False, fingerprint='',
2453
 
                       packed_stat=None, size=0, path_utf8=None):
 
2699
        packed_stat=None, size=0, path_utf8=None, fullscan=False):
2454
2700
        """Update an entry to the state in tree 0.
2455
2701
 
2456
2702
        This will either create a new entry at 'key' or update an existing one.
2461
2707
        :param minikind: The type for the entry ('f' == 'file', 'd' ==
2462
2708
                'directory'), etc.
2463
2709
        :param executable: Should the executable bit be set?
2464
 
        :param fingerprint: Simple fingerprint for new entry: sha1 for files, 
2465
 
            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.
2466
2712
        :param packed_stat: Packed stat value for new entry.
2467
2713
        :param size: Size information for new entry
2468
2714
        :param path_utf8: key[0] + '/' + key[1], just passed in to avoid doing
2469
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.
2470
2719
 
2471
2720
        If packed_stat and fingerprint are not given, they're invalidated in
2472
2721
        the entry.
2481
2730
        new_details = (minikind, fingerprint, size, executable, packed_stat)
2482
2731
        id_index = self._get_id_index()
2483
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
2484
2750
            # new entry, synthesis cross reference here,
2485
2751
            existing_keys = id_index.setdefault(key[2], set())
2486
2752
            if not existing_keys:
2491
2757
                # grab one of them and use it to generate parent
2492
2758
                # relocation/absent entries.
2493
2759
                new_entry = key, [new_details]
2494
 
                for other_key in existing_keys:
 
2760
                # existing_keys can be changed as we iterate.
 
2761
                for other_key in tuple(existing_keys):
2495
2762
                    # change the record at other to be a pointer to this new
2496
2763
                    # record. The loop looks similar to the change to
2497
2764
                    # relocations when updating an existing record but its not:
2498
2765
                    # the test for existing kinds is different: this can be
2499
2766
                    # factored out to a helper though.
2500
 
                    other_block_index, present = self._find_block_index_from_key(other_key)
2501
 
                    if not present:
2502
 
                        raise AssertionError('could not find block for %s' % (other_key,))
2503
 
                    other_entry_index, present = self._find_entry_index(other_key,
2504
 
                                            self._dirblocks[other_block_index][1])
2505
 
                    if not present:
2506
 
                        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,))
2507
2779
                    if path_utf8 is None:
2508
2780
                        raise AssertionError('no path')
2509
 
                    self._dirblocks[other_block_index][1][other_entry_index][1][0] = \
2510
 
                        ('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)
2511
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
2512
2795
                num_present_parents = self._num_present_parents()
 
2796
                if num_present_parents:
 
2797
                    other_key = list(existing_keys)[0]
2513
2798
                for lookup_index in xrange(1, num_present_parents + 1):
2514
2799
                    # grab any one entry, use it to find the right path.
2515
 
                    # TODO: optimise this to reduce memory use in highly 
 
2800
                    # TODO: optimise this to reduce memory use in highly
2516
2801
                    # fragmented situations by reusing the relocation
2517
2802
                    # records.
2518
2803
                    update_block_index, present = \
2522
2807
                    update_entry_index, present = \
2523
2808
                        self._find_entry_index(other_key, self._dirblocks[update_block_index][1])
2524
2809
                    if not present:
2525
 
                        raise AssertionError('could not find entry for %s' % (other_key,))
 
2810
                        raise AssertionError('update_minimal: could not find entry for %s' % (other_key,))
2526
2811
                    update_details = self._dirblocks[update_block_index][1][update_entry_index][1][lookup_index]
2527
2812
                    if update_details[0] in 'ar': # relocated, absent
2528
2813
                        # its a pointer or absent in lookup_index's tree, use
2535
2820
            block.insert(entry_index, new_entry)
2536
2821
            existing_keys.add(key)
2537
2822
        else:
2538
 
            # Does the new state matter? 
 
2823
            # Does the new state matter?
2539
2824
            block[entry_index][1][0] = new_details
2540
2825
            # parents cannot be affected by what we do.
2541
 
            # other occurences of this id can be found 
 
2826
            # other occurences of this id can be found
2542
2827
            # from the id index.
2543
2828
            # ---
2544
2829
            # tree index consistency: All other paths for this id in this tree
2574
2859
 
2575
2860
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
2576
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
 
2577
2877
    def _validate(self):
2578
2878
        """Check that invariants on the dirblock are correct.
2579
2879
 
2580
 
        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
2581
2881
        normal code.
2582
2882
 
2583
2883
        This must be called with a lock held.
2652
2952
        # For each file id, for each tree: either
2653
2953
        # the file id is not present at all; all rows with that id in the
2654
2954
        # key have it marked as 'absent'
2655
 
        # 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
2656
2956
        # that mention that id point to the correct name.
2657
2957
        #
2658
2958
        # We check this with a dict per tree pointing either to the present
2705
3005
                        # absent; should not occur anywhere else
2706
3006
                        this_tree_map[file_id] = None, this_path
2707
3007
                    elif minikind == 'r':
2708
 
                        # relocation, must occur at expected location 
 
3008
                        # relocation, must occur at expected location
2709
3009
                        this_tree_map[file_id] = tree_state[1], this_path
2710
3010
                    else:
2711
3011
                        this_tree_map[file_id] = this_path, this_path
2774
3074
            raise errors.ObjectNotLocked(self)
2775
3075
 
2776
3076
 
 
3077
def py_update_entry(state, entry, abspath, stat_value,
 
3078
                 _stat_to_minikind=DirState._stat_to_minikind,
 
3079
                 _pack_stat=pack_stat):
 
3080
    """Update the entry based on what is actually on disk.
 
3081
 
 
3082
    This function only calculates the sha if it needs to - if the entry is
 
3083
    uncachable, or clearly different to the first parent's entry, no sha
 
3084
    is calculated, and None is returned.
 
3085
 
 
3086
    :param state: The dirstate this entry is in.
 
3087
    :param entry: This is the dirblock entry for the file in question.
 
3088
    :param abspath: The path on disk for this file.
 
3089
    :param stat_value: The stat value done on the path.
 
3090
    :return: None, or The sha1 hexdigest of the file (40 bytes) or link
 
3091
        target of a symlink.
 
3092
    """
 
3093
    try:
 
3094
        minikind = _stat_to_minikind[stat_value.st_mode & 0170000]
 
3095
    except KeyError:
 
3096
        # Unhandled kind
 
3097
        return None
 
3098
    packed_stat = _pack_stat(stat_value)
 
3099
    (saved_minikind, saved_link_or_sha1, saved_file_size,
 
3100
     saved_executable, saved_packed_stat) = entry[1][0]
 
3101
 
 
3102
    if minikind == 'd' and saved_minikind == 't':
 
3103
        minikind = 't'
 
3104
    if (minikind == saved_minikind
 
3105
        and packed_stat == saved_packed_stat):
 
3106
        # The stat hasn't changed since we saved, so we can re-use the
 
3107
        # saved sha hash.
 
3108
        if minikind == 'd':
 
3109
            return None
 
3110
 
 
3111
        # size should also be in packed_stat
 
3112
        if saved_file_size == stat_value.st_size:
 
3113
            return saved_link_or_sha1
 
3114
 
 
3115
    # If we have gotten this far, that means that we need to actually
 
3116
    # process this entry.
 
3117
    link_or_sha1 = None
 
3118
    if minikind == 'f':
 
3119
        executable = state._is_executable(stat_value.st_mode,
 
3120
                                         saved_executable)
 
3121
        if state._cutoff_time is None:
 
3122
            state._sha_cutoff_time()
 
3123
        if (stat_value.st_mtime < state._cutoff_time
 
3124
            and stat_value.st_ctime < state._cutoff_time
 
3125
            and len(entry[1]) > 1
 
3126
            and entry[1][1][0] != 'a'):
 
3127
            # Could check for size changes for further optimised
 
3128
            # avoidance of sha1's. However the most prominent case of
 
3129
            # over-shaing is during initial add, which this catches.
 
3130
            # Besides, if content filtering happens, size and sha
 
3131
            # are calculated at the same time, so checking just the size
 
3132
            # gains nothing w.r.t. performance.
 
3133
            link_or_sha1 = state._sha1_file(abspath)
 
3134
            entry[1][0] = ('f', link_or_sha1, stat_value.st_size,
 
3135
                           executable, packed_stat)
 
3136
        else:
 
3137
            entry[1][0] = ('f', '', stat_value.st_size,
 
3138
                           executable, DirState.NULLSTAT)
 
3139
    elif minikind == 'd':
 
3140
        link_or_sha1 = None
 
3141
        entry[1][0] = ('d', '', 0, False, packed_stat)
 
3142
        if saved_minikind != 'd':
 
3143
            # This changed from something into a directory. Make sure we
 
3144
            # have a directory block for it. This doesn't happen very
 
3145
            # often, so this doesn't have to be super fast.
 
3146
            block_index, entry_index, dir_present, file_present = \
 
3147
                state._get_block_entry_index(entry[0][0], entry[0][1], 0)
 
3148
            state._ensure_block(block_index, entry_index,
 
3149
                               osutils.pathjoin(entry[0][0], entry[0][1]))
 
3150
    elif minikind == 'l':
 
3151
        link_or_sha1 = state._read_link(abspath, saved_link_or_sha1)
 
3152
        if state._cutoff_time is None:
 
3153
            state._sha_cutoff_time()
 
3154
        if (stat_value.st_mtime < state._cutoff_time
 
3155
            and stat_value.st_ctime < state._cutoff_time):
 
3156
            entry[1][0] = ('l', link_or_sha1, stat_value.st_size,
 
3157
                           False, packed_stat)
 
3158
        else:
 
3159
            entry[1][0] = ('l', '', stat_value.st_size,
 
3160
                           False, DirState.NULLSTAT)
 
3161
    state._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
3162
    return link_or_sha1
 
3163
 
 
3164
 
 
3165
class ProcessEntryPython(object):
 
3166
 
 
3167
    __slots__ = ["old_dirname_to_file_id", "new_dirname_to_file_id",
 
3168
        "last_source_parent", "last_target_parent", "include_unchanged",
 
3169
        "partial", "use_filesystem_for_exec", "utf8_decode",
 
3170
        "searched_specific_files", "search_specific_files",
 
3171
        "searched_exact_paths", "search_specific_file_parents", "seen_ids",
 
3172
        "state", "source_index", "target_index", "want_unversioned", "tree"]
 
3173
 
 
3174
    def __init__(self, include_unchanged, use_filesystem_for_exec,
 
3175
        search_specific_files, state, source_index, target_index,
 
3176
        want_unversioned, tree):
 
3177
        self.old_dirname_to_file_id = {}
 
3178
        self.new_dirname_to_file_id = {}
 
3179
        # Are we doing a partial iter_changes?
 
3180
        self.partial = search_specific_files != set([''])
 
3181
        # Using a list so that we can access the values and change them in
 
3182
        # nested scope. Each one is [path, file_id, entry]
 
3183
        self.last_source_parent = [None, None]
 
3184
        self.last_target_parent = [None, None]
 
3185
        self.include_unchanged = include_unchanged
 
3186
        self.use_filesystem_for_exec = use_filesystem_for_exec
 
3187
        self.utf8_decode = cache_utf8._utf8_decode
 
3188
        # for all search_indexs in each path at or under each element of
 
3189
        # search_specific_files, if the detail is relocated: add the id, and
 
3190
        # add the relocated path as one to search if its not searched already.
 
3191
        # If the detail is not relocated, add the id.
 
3192
        self.searched_specific_files = set()
 
3193
        # When we search exact paths without expanding downwards, we record
 
3194
        # that here.
 
3195
        self.searched_exact_paths = set()
 
3196
        self.search_specific_files = search_specific_files
 
3197
        # The parents up to the root of the paths we are searching.
 
3198
        # After all normal paths are returned, these specific items are returned.
 
3199
        self.search_specific_file_parents = set()
 
3200
        # The ids we've sent out in the delta.
 
3201
        self.seen_ids = set()
 
3202
        self.state = state
 
3203
        self.source_index = source_index
 
3204
        self.target_index = target_index
 
3205
        if target_index != 0:
 
3206
            # A lot of code in here depends on target_index == 0
 
3207
            raise errors.BzrError('unsupported target index')
 
3208
        self.want_unversioned = want_unversioned
 
3209
        self.tree = tree
 
3210
 
 
3211
    def _process_entry(self, entry, path_info, pathjoin=osutils.pathjoin):
 
3212
        """Compare an entry and real disk to generate delta information.
 
3213
 
 
3214
        :param path_info: top_relpath, basename, kind, lstat, abspath for
 
3215
            the path of entry. If None, then the path is considered absent in 
 
3216
            the target (Perhaps we should pass in a concrete entry for this ?)
 
3217
            Basename is returned as a utf8 string because we expect this
 
3218
            tuple will be ignored, and don't want to take the time to
 
3219
            decode.
 
3220
        :return: (iter_changes_result, changed). If the entry has not been
 
3221
            handled then changed is None. Otherwise it is False if no content
 
3222
            or metadata changes have occurred, and True if any content or
 
3223
            metadata change has occurred. If self.include_unchanged is True then
 
3224
            if changed is not None, iter_changes_result will always be a result
 
3225
            tuple. Otherwise, iter_changes_result is None unless changed is
 
3226
            True.
 
3227
        """
 
3228
        if self.source_index is None:
 
3229
            source_details = DirState.NULL_PARENT_DETAILS
 
3230
        else:
 
3231
            source_details = entry[1][self.source_index]
 
3232
        target_details = entry[1][self.target_index]
 
3233
        target_minikind = target_details[0]
 
3234
        if path_info is not None and target_minikind in 'fdlt':
 
3235
            if not (self.target_index == 0):
 
3236
                raise AssertionError()
 
3237
            link_or_sha1 = update_entry(self.state, entry,
 
3238
                abspath=path_info[4], stat_value=path_info[3])
 
3239
            # The entry may have been modified by update_entry
 
3240
            target_details = entry[1][self.target_index]
 
3241
            target_minikind = target_details[0]
 
3242
        else:
 
3243
            link_or_sha1 = None
 
3244
        file_id = entry[0][2]
 
3245
        source_minikind = source_details[0]
 
3246
        if source_minikind in 'fdltr' and target_minikind in 'fdlt':
 
3247
            # claimed content in both: diff
 
3248
            #   r    | fdlt   |      | add source to search, add id path move and perform
 
3249
            #        |        |      | diff check on source-target
 
3250
            #   r    | fdlt   |  a   | dangling file that was present in the basis.
 
3251
            #        |        |      | ???
 
3252
            if source_minikind in 'r':
 
3253
                # add the source to the search path to find any children it
 
3254
                # has.  TODO ? : only add if it is a container ?
 
3255
                if not osutils.is_inside_any(self.searched_specific_files,
 
3256
                                             source_details[1]):
 
3257
                    self.search_specific_files.add(source_details[1])
 
3258
                # generate the old path; this is needed for stating later
 
3259
                # as well.
 
3260
                old_path = source_details[1]
 
3261
                old_dirname, old_basename = os.path.split(old_path)
 
3262
                path = pathjoin(entry[0][0], entry[0][1])
 
3263
                old_entry = self.state._get_entry(self.source_index,
 
3264
                                             path_utf8=old_path)
 
3265
                # update the source details variable to be the real
 
3266
                # location.
 
3267
                if old_entry == (None, None):
 
3268
                    raise errors.CorruptDirstate(self.state._filename,
 
3269
                        "entry '%s/%s' is considered renamed from %r"
 
3270
                        " but source does not exist\n"
 
3271
                        "entry: %s" % (entry[0][0], entry[0][1], old_path, entry))
 
3272
                source_details = old_entry[1][self.source_index]
 
3273
                source_minikind = source_details[0]
 
3274
            else:
 
3275
                old_dirname = entry[0][0]
 
3276
                old_basename = entry[0][1]
 
3277
                old_path = path = None
 
3278
            if path_info is None:
 
3279
                # the file is missing on disk, show as removed.
 
3280
                content_change = True
 
3281
                target_kind = None
 
3282
                target_exec = False
 
3283
            else:
 
3284
                # source and target are both versioned and disk file is present.
 
3285
                target_kind = path_info[2]
 
3286
                if target_kind == 'directory':
 
3287
                    if path is None:
 
3288
                        old_path = path = pathjoin(old_dirname, old_basename)
 
3289
                    self.new_dirname_to_file_id[path] = file_id
 
3290
                    if source_minikind != 'd':
 
3291
                        content_change = True
 
3292
                    else:
 
3293
                        # directories have no fingerprint
 
3294
                        content_change = False
 
3295
                    target_exec = False
 
3296
                elif target_kind == 'file':
 
3297
                    if source_minikind != 'f':
 
3298
                        content_change = True
 
3299
                    else:
 
3300
                        # Check the sha. We can't just rely on the size as
 
3301
                        # content filtering may mean differ sizes actually
 
3302
                        # map to the same content
 
3303
                        if link_or_sha1 is None:
 
3304
                            # Stat cache miss:
 
3305
                            statvalue, link_or_sha1 = \
 
3306
                                self.state._sha1_provider.stat_and_sha1(
 
3307
                                path_info[4])
 
3308
                            self.state._observed_sha1(entry, link_or_sha1,
 
3309
                                statvalue)
 
3310
                        content_change = (link_or_sha1 != source_details[1])
 
3311
                    # Target details is updated at update_entry time
 
3312
                    if self.use_filesystem_for_exec:
 
3313
                        # We don't need S_ISREG here, because we are sure
 
3314
                        # we are dealing with a file.
 
3315
                        target_exec = bool(stat.S_IEXEC & path_info[3].st_mode)
 
3316
                    else:
 
3317
                        target_exec = target_details[3]
 
3318
                elif target_kind == 'symlink':
 
3319
                    if source_minikind != 'l':
 
3320
                        content_change = True
 
3321
                    else:
 
3322
                        content_change = (link_or_sha1 != source_details[1])
 
3323
                    target_exec = False
 
3324
                elif target_kind == 'tree-reference':
 
3325
                    if source_minikind != 't':
 
3326
                        content_change = True
 
3327
                    else:
 
3328
                        content_change = False
 
3329
                    target_exec = False
 
3330
                else:
 
3331
                    raise Exception, "unknown kind %s" % path_info[2]
 
3332
            if source_minikind == 'd':
 
3333
                if path is None:
 
3334
                    old_path = path = pathjoin(old_dirname, old_basename)
 
3335
                self.old_dirname_to_file_id[old_path] = file_id
 
3336
            # parent id is the entry for the path in the target tree
 
3337
            if old_basename and old_dirname == self.last_source_parent[0]:
 
3338
                source_parent_id = self.last_source_parent[1]
 
3339
            else:
 
3340
                try:
 
3341
                    source_parent_id = self.old_dirname_to_file_id[old_dirname]
 
3342
                except KeyError:
 
3343
                    source_parent_entry = self.state._get_entry(self.source_index,
 
3344
                                                           path_utf8=old_dirname)
 
3345
                    source_parent_id = source_parent_entry[0][2]
 
3346
                if source_parent_id == entry[0][2]:
 
3347
                    # This is the root, so the parent is None
 
3348
                    source_parent_id = None
 
3349
                else:
 
3350
                    self.last_source_parent[0] = old_dirname
 
3351
                    self.last_source_parent[1] = source_parent_id
 
3352
            new_dirname = entry[0][0]
 
3353
            if entry[0][1] and new_dirname == self.last_target_parent[0]:
 
3354
                target_parent_id = self.last_target_parent[1]
 
3355
            else:
 
3356
                try:
 
3357
                    target_parent_id = self.new_dirname_to_file_id[new_dirname]
 
3358
                except KeyError:
 
3359
                    # TODO: We don't always need to do the lookup, because the
 
3360
                    #       parent entry will be the same as the source entry.
 
3361
                    target_parent_entry = self.state._get_entry(self.target_index,
 
3362
                                                           path_utf8=new_dirname)
 
3363
                    if target_parent_entry == (None, None):
 
3364
                        raise AssertionError(
 
3365
                            "Could not find target parent in wt: %s\nparent of: %s"
 
3366
                            % (new_dirname, entry))
 
3367
                    target_parent_id = target_parent_entry[0][2]
 
3368
                if target_parent_id == entry[0][2]:
 
3369
                    # This is the root, so the parent is None
 
3370
                    target_parent_id = None
 
3371
                else:
 
3372
                    self.last_target_parent[0] = new_dirname
 
3373
                    self.last_target_parent[1] = target_parent_id
 
3374
 
 
3375
            source_exec = source_details[3]
 
3376
            changed = (content_change
 
3377
                or source_parent_id != target_parent_id
 
3378
                or old_basename != entry[0][1]
 
3379
                or source_exec != target_exec
 
3380
                )
 
3381
            if not changed and not self.include_unchanged:
 
3382
                return None, False
 
3383
            else:
 
3384
                if old_path is None:
 
3385
                    old_path = path = pathjoin(old_dirname, old_basename)
 
3386
                    old_path_u = self.utf8_decode(old_path)[0]
 
3387
                    path_u = old_path_u
 
3388
                else:
 
3389
                    old_path_u = self.utf8_decode(old_path)[0]
 
3390
                    if old_path == path:
 
3391
                        path_u = old_path_u
 
3392
                    else:
 
3393
                        path_u = self.utf8_decode(path)[0]
 
3394
                source_kind = DirState._minikind_to_kind[source_minikind]
 
3395
                return (entry[0][2],
 
3396
                       (old_path_u, path_u),
 
3397
                       content_change,
 
3398
                       (True, True),
 
3399
                       (source_parent_id, target_parent_id),
 
3400
                       (self.utf8_decode(old_basename)[0], self.utf8_decode(entry[0][1])[0]),
 
3401
                       (source_kind, target_kind),
 
3402
                       (source_exec, target_exec)), changed
 
3403
        elif source_minikind in 'a' and target_minikind in 'fdlt':
 
3404
            # looks like a new file
 
3405
            path = pathjoin(entry[0][0], entry[0][1])
 
3406
            # parent id is the entry for the path in the target tree
 
3407
            # TODO: these are the same for an entire directory: cache em.
 
3408
            parent_id = self.state._get_entry(self.target_index,
 
3409
                                         path_utf8=entry[0][0])[0][2]
 
3410
            if parent_id == entry[0][2]:
 
3411
                parent_id = None
 
3412
            if path_info is not None:
 
3413
                # Present on disk:
 
3414
                if self.use_filesystem_for_exec:
 
3415
                    # We need S_ISREG here, because we aren't sure if this
 
3416
                    # is a file or not.
 
3417
                    target_exec = bool(
 
3418
                        stat.S_ISREG(path_info[3].st_mode)
 
3419
                        and stat.S_IEXEC & path_info[3].st_mode)
 
3420
                else:
 
3421
                    target_exec = target_details[3]
 
3422
                return (entry[0][2],
 
3423
                       (None, self.utf8_decode(path)[0]),
 
3424
                       True,
 
3425
                       (False, True),
 
3426
                       (None, parent_id),
 
3427
                       (None, self.utf8_decode(entry[0][1])[0]),
 
3428
                       (None, path_info[2]),
 
3429
                       (None, target_exec)), True
 
3430
            else:
 
3431
                # Its a missing file, report it as such.
 
3432
                return (entry[0][2],
 
3433
                       (None, self.utf8_decode(path)[0]),
 
3434
                       False,
 
3435
                       (False, True),
 
3436
                       (None, parent_id),
 
3437
                       (None, self.utf8_decode(entry[0][1])[0]),
 
3438
                       (None, None),
 
3439
                       (None, False)), True
 
3440
        elif source_minikind in 'fdlt' and target_minikind in 'a':
 
3441
            # unversioned, possibly, or possibly not deleted: we dont care.
 
3442
            # if its still on disk, *and* theres no other entry at this
 
3443
            # path [we dont know this in this routine at the moment -
 
3444
            # perhaps we should change this - then it would be an unknown.
 
3445
            old_path = pathjoin(entry[0][0], entry[0][1])
 
3446
            # parent id is the entry for the path in the target tree
 
3447
            parent_id = self.state._get_entry(self.source_index, path_utf8=entry[0][0])[0][2]
 
3448
            if parent_id == entry[0][2]:
 
3449
                parent_id = None
 
3450
            return (entry[0][2],
 
3451
                   (self.utf8_decode(old_path)[0], None),
 
3452
                   True,
 
3453
                   (True, False),
 
3454
                   (parent_id, None),
 
3455
                   (self.utf8_decode(entry[0][1])[0], None),
 
3456
                   (DirState._minikind_to_kind[source_minikind], None),
 
3457
                   (source_details[3], None)), True
 
3458
        elif source_minikind in 'fdlt' and target_minikind in 'r':
 
3459
            # a rename; could be a true rename, or a rename inherited from
 
3460
            # a renamed parent. TODO: handle this efficiently. Its not
 
3461
            # common case to rename dirs though, so a correct but slow
 
3462
            # implementation will do.
 
3463
            if not osutils.is_inside_any(self.searched_specific_files, target_details[1]):
 
3464
                self.search_specific_files.add(target_details[1])
 
3465
        elif source_minikind in 'ra' and target_minikind in 'ra':
 
3466
            # neither of the selected trees contain this file,
 
3467
            # so skip over it. This is not currently directly tested, but
 
3468
            # is indirectly via test_too_much.TestCommands.test_conflicts.
 
3469
            pass
 
3470
        else:
 
3471
            raise AssertionError("don't know how to compare "
 
3472
                "source_minikind=%r, target_minikind=%r"
 
3473
                % (source_minikind, target_minikind))
 
3474
            ## import pdb;pdb.set_trace()
 
3475
        return None, None
 
3476
 
 
3477
    def __iter__(self):
 
3478
        return self
 
3479
 
 
3480
    def _gather_result_for_consistency(self, result):
 
3481
        """Check a result we will yield to make sure we are consistent later.
 
3482
        
 
3483
        This gathers result's parents into a set to output later.
 
3484
 
 
3485
        :param result: A result tuple.
 
3486
        """
 
3487
        if not self.partial or not result[0]:
 
3488
            return
 
3489
        self.seen_ids.add(result[0])
 
3490
        new_path = result[1][1]
 
3491
        if new_path:
 
3492
            # Not the root and not a delete: queue up the parents of the path.
 
3493
            self.search_specific_file_parents.update(
 
3494
                osutils.parent_directories(new_path.encode('utf8')))
 
3495
            # Add the root directory which parent_directories does not
 
3496
            # provide.
 
3497
            self.search_specific_file_parents.add('')
 
3498
 
 
3499
    def iter_changes(self):
 
3500
        """Iterate over the changes."""
 
3501
        utf8_decode = cache_utf8._utf8_decode
 
3502
        _cmp_by_dirs = cmp_by_dirs
 
3503
        _process_entry = self._process_entry
 
3504
        search_specific_files = self.search_specific_files
 
3505
        searched_specific_files = self.searched_specific_files
 
3506
        splitpath = osutils.splitpath
 
3507
        # sketch:
 
3508
        # compare source_index and target_index at or under each element of search_specific_files.
 
3509
        # follow the following comparison table. Note that we only want to do diff operations when
 
3510
        # the target is fdl because thats when the walkdirs logic will have exposed the pathinfo
 
3511
        # for the target.
 
3512
        # cases:
 
3513
        #
 
3514
        # Source | Target | disk | action
 
3515
        #   r    | fdlt   |      | add source to search, add id path move and perform
 
3516
        #        |        |      | diff check on source-target
 
3517
        #   r    | fdlt   |  a   | dangling file that was present in the basis.
 
3518
        #        |        |      | ???
 
3519
        #   r    |  a     |      | add source to search
 
3520
        #   r    |  a     |  a   |
 
3521
        #   r    |  r     |      | this path is present in a non-examined tree, skip.
 
3522
        #   r    |  r     |  a   | this path is present in a non-examined tree, skip.
 
3523
        #   a    | fdlt   |      | add new id
 
3524
        #   a    | fdlt   |  a   | dangling locally added file, skip
 
3525
        #   a    |  a     |      | not present in either tree, skip
 
3526
        #   a    |  a     |  a   | not present in any tree, skip
 
3527
        #   a    |  r     |      | not present in either tree at this path, skip as it
 
3528
        #        |        |      | may not be selected by the users list of paths.
 
3529
        #   a    |  r     |  a   | not present in either tree at this path, skip as it
 
3530
        #        |        |      | may not be selected by the users list of paths.
 
3531
        #  fdlt  | fdlt   |      | content in both: diff them
 
3532
        #  fdlt  | fdlt   |  a   | deleted locally, but not unversioned - show as deleted ?
 
3533
        #  fdlt  |  a     |      | unversioned: output deleted id for now
 
3534
        #  fdlt  |  a     |  a   | unversioned and deleted: output deleted id
 
3535
        #  fdlt  |  r     |      | relocated in this tree, so add target to search.
 
3536
        #        |        |      | Dont diff, we will see an r,fd; pair when we reach
 
3537
        #        |        |      | this id at the other path.
 
3538
        #  fdlt  |  r     |  a   | relocated in this tree, so add target to search.
 
3539
        #        |        |      | Dont diff, we will see an r,fd; pair when we reach
 
3540
        #        |        |      | this id at the other path.
 
3541
 
 
3542
        # TODO: jam 20070516 - Avoid the _get_entry lookup overhead by
 
3543
        #       keeping a cache of directories that we have seen.
 
3544
 
 
3545
        while search_specific_files:
 
3546
            # TODO: the pending list should be lexically sorted?  the
 
3547
            # interface doesn't require it.
 
3548
            current_root = search_specific_files.pop()
 
3549
            current_root_unicode = current_root.decode('utf8')
 
3550
            searched_specific_files.add(current_root)
 
3551
            # process the entries for this containing directory: the rest will be
 
3552
            # found by their parents recursively.
 
3553
            root_entries = self.state._entries_for_path(current_root)
 
3554
            root_abspath = self.tree.abspath(current_root_unicode)
 
3555
            try:
 
3556
                root_stat = os.lstat(root_abspath)
 
3557
            except OSError, e:
 
3558
                if e.errno == errno.ENOENT:
 
3559
                    # the path does not exist: let _process_entry know that.
 
3560
                    root_dir_info = None
 
3561
                else:
 
3562
                    # some other random error: hand it up.
 
3563
                    raise
 
3564
            else:
 
3565
                root_dir_info = ('', current_root,
 
3566
                    osutils.file_kind_from_stat_mode(root_stat.st_mode), root_stat,
 
3567
                    root_abspath)
 
3568
                if root_dir_info[2] == 'directory':
 
3569
                    if self.tree._directory_is_tree_reference(
 
3570
                        current_root.decode('utf8')):
 
3571
                        root_dir_info = root_dir_info[:2] + \
 
3572
                            ('tree-reference',) + root_dir_info[3:]
 
3573
 
 
3574
            if not root_entries and not root_dir_info:
 
3575
                # this specified path is not present at all, skip it.
 
3576
                continue
 
3577
            path_handled = False
 
3578
            for entry in root_entries:
 
3579
                result, changed = _process_entry(entry, root_dir_info)
 
3580
                if changed is not None:
 
3581
                    path_handled = True
 
3582
                    if changed:
 
3583
                        self._gather_result_for_consistency(result)
 
3584
                    if changed or self.include_unchanged:
 
3585
                        yield result
 
3586
            if self.want_unversioned and not path_handled and root_dir_info:
 
3587
                new_executable = bool(
 
3588
                    stat.S_ISREG(root_dir_info[3].st_mode)
 
3589
                    and stat.S_IEXEC & root_dir_info[3].st_mode)
 
3590
                yield (None,
 
3591
                       (None, current_root_unicode),
 
3592
                       True,
 
3593
                       (False, False),
 
3594
                       (None, None),
 
3595
                       (None, splitpath(current_root_unicode)[-1]),
 
3596
                       (None, root_dir_info[2]),
 
3597
                       (None, new_executable)
 
3598
                      )
 
3599
            initial_key = (current_root, '', '')
 
3600
            block_index, _ = self.state._find_block_index_from_key(initial_key)
 
3601
            if block_index == 0:
 
3602
                # we have processed the total root already, but because the
 
3603
                # initial key matched it we should skip it here.
 
3604
                block_index +=1
 
3605
            if root_dir_info and root_dir_info[2] == 'tree-reference':
 
3606
                current_dir_info = None
 
3607
            else:
 
3608
                dir_iterator = osutils._walkdirs_utf8(root_abspath, prefix=current_root)
 
3609
                try:
 
3610
                    current_dir_info = dir_iterator.next()
 
3611
                except OSError, e:
 
3612
                    # on win32, python2.4 has e.errno == ERROR_DIRECTORY, but
 
3613
                    # python 2.5 has e.errno == EINVAL,
 
3614
                    #            and e.winerror == ERROR_DIRECTORY
 
3615
                    e_winerror = getattr(e, 'winerror', None)
 
3616
                    win_errors = (ERROR_DIRECTORY, ERROR_PATH_NOT_FOUND)
 
3617
                    # there may be directories in the inventory even though
 
3618
                    # this path is not a file on disk: so mark it as end of
 
3619
                    # iterator
 
3620
                    if e.errno in (errno.ENOENT, errno.ENOTDIR, errno.EINVAL):
 
3621
                        current_dir_info = None
 
3622
                    elif (sys.platform == 'win32'
 
3623
                          and (e.errno in win_errors
 
3624
                               or e_winerror in win_errors)):
 
3625
                        current_dir_info = None
 
3626
                    else:
 
3627
                        raise
 
3628
                else:
 
3629
                    if current_dir_info[0][0] == '':
 
3630
                        # remove .bzr from iteration
 
3631
                        bzr_index = bisect.bisect_left(current_dir_info[1], ('.bzr',))
 
3632
                        if current_dir_info[1][bzr_index][0] != '.bzr':
 
3633
                            raise AssertionError()
 
3634
                        del current_dir_info[1][bzr_index]
 
3635
            # walk until both the directory listing and the versioned metadata
 
3636
            # are exhausted.
 
3637
            if (block_index < len(self.state._dirblocks) and
 
3638
                osutils.is_inside(current_root, self.state._dirblocks[block_index][0])):
 
3639
                current_block = self.state._dirblocks[block_index]
 
3640
            else:
 
3641
                current_block = None
 
3642
            while (current_dir_info is not None or
 
3643
                   current_block is not None):
 
3644
                if (current_dir_info and current_block
 
3645
                    and current_dir_info[0][0] != current_block[0]):
 
3646
                    if _cmp_by_dirs(current_dir_info[0][0], current_block[0]) < 0:
 
3647
                        # filesystem data refers to paths not covered by the dirblock.
 
3648
                        # this has two possibilities:
 
3649
                        # A) it is versioned but empty, so there is no block for it
 
3650
                        # B) it is not versioned.
 
3651
 
 
3652
                        # if (A) then we need to recurse into it to check for
 
3653
                        # new unknown files or directories.
 
3654
                        # if (B) then we should ignore it, because we don't
 
3655
                        # recurse into unknown directories.
 
3656
                        path_index = 0
 
3657
                        while path_index < len(current_dir_info[1]):
 
3658
                                current_path_info = current_dir_info[1][path_index]
 
3659
                                if self.want_unversioned:
 
3660
                                    if current_path_info[2] == 'directory':
 
3661
                                        if self.tree._directory_is_tree_reference(
 
3662
                                            current_path_info[0].decode('utf8')):
 
3663
                                            current_path_info = current_path_info[:2] + \
 
3664
                                                ('tree-reference',) + current_path_info[3:]
 
3665
                                    new_executable = bool(
 
3666
                                        stat.S_ISREG(current_path_info[3].st_mode)
 
3667
                                        and stat.S_IEXEC & current_path_info[3].st_mode)
 
3668
                                    yield (None,
 
3669
                                        (None, utf8_decode(current_path_info[0])[0]),
 
3670
                                        True,
 
3671
                                        (False, False),
 
3672
                                        (None, None),
 
3673
                                        (None, utf8_decode(current_path_info[1])[0]),
 
3674
                                        (None, current_path_info[2]),
 
3675
                                        (None, new_executable))
 
3676
                                # dont descend into this unversioned path if it is
 
3677
                                # a dir
 
3678
                                if current_path_info[2] in ('directory',
 
3679
                                                            'tree-reference'):
 
3680
                                    del current_dir_info[1][path_index]
 
3681
                                    path_index -= 1
 
3682
                                path_index += 1
 
3683
 
 
3684
                        # This dir info has been handled, go to the next
 
3685
                        try:
 
3686
                            current_dir_info = dir_iterator.next()
 
3687
                        except StopIteration:
 
3688
                            current_dir_info = None
 
3689
                    else:
 
3690
                        # We have a dirblock entry for this location, but there
 
3691
                        # is no filesystem path for this. This is most likely
 
3692
                        # because a directory was removed from the disk.
 
3693
                        # We don't have to report the missing directory,
 
3694
                        # because that should have already been handled, but we
 
3695
                        # need to handle all of the files that are contained
 
3696
                        # within.
 
3697
                        for current_entry in current_block[1]:
 
3698
                            # entry referring to file not present on disk.
 
3699
                            # advance the entry only, after processing.
 
3700
                            result, changed = _process_entry(current_entry, None)
 
3701
                            if changed is not None:
 
3702
                                if changed:
 
3703
                                    self._gather_result_for_consistency(result)
 
3704
                                if changed or self.include_unchanged:
 
3705
                                    yield result
 
3706
                        block_index +=1
 
3707
                        if (block_index < len(self.state._dirblocks) and
 
3708
                            osutils.is_inside(current_root,
 
3709
                                              self.state._dirblocks[block_index][0])):
 
3710
                            current_block = self.state._dirblocks[block_index]
 
3711
                        else:
 
3712
                            current_block = None
 
3713
                    continue
 
3714
                entry_index = 0
 
3715
                if current_block and entry_index < len(current_block[1]):
 
3716
                    current_entry = current_block[1][entry_index]
 
3717
                else:
 
3718
                    current_entry = None
 
3719
                advance_entry = True
 
3720
                path_index = 0
 
3721
                if current_dir_info and path_index < len(current_dir_info[1]):
 
3722
                    current_path_info = current_dir_info[1][path_index]
 
3723
                    if current_path_info[2] == 'directory':
 
3724
                        if self.tree._directory_is_tree_reference(
 
3725
                            current_path_info[0].decode('utf8')):
 
3726
                            current_path_info = current_path_info[:2] + \
 
3727
                                ('tree-reference',) + current_path_info[3:]
 
3728
                else:
 
3729
                    current_path_info = None
 
3730
                advance_path = True
 
3731
                path_handled = False
 
3732
                while (current_entry is not None or
 
3733
                    current_path_info is not None):
 
3734
                    if current_entry is None:
 
3735
                        # the check for path_handled when the path is advanced
 
3736
                        # will yield this path if needed.
 
3737
                        pass
 
3738
                    elif current_path_info is None:
 
3739
                        # no path is fine: the per entry code will handle it.
 
3740
                        result, changed = _process_entry(current_entry, current_path_info)
 
3741
                        if changed is not None:
 
3742
                            if changed:
 
3743
                                self._gather_result_for_consistency(result)
 
3744
                            if changed or self.include_unchanged:
 
3745
                                yield result
 
3746
                    elif (current_entry[0][1] != current_path_info[1]
 
3747
                          or current_entry[1][self.target_index][0] in 'ar'):
 
3748
                        # The current path on disk doesn't match the dirblock
 
3749
                        # record. Either the dirblock is marked as absent, or
 
3750
                        # the file on disk is not present at all in the
 
3751
                        # dirblock. Either way, report about the dirblock
 
3752
                        # entry, and let other code handle the filesystem one.
 
3753
 
 
3754
                        # Compare the basename for these files to determine
 
3755
                        # which comes first
 
3756
                        if current_path_info[1] < current_entry[0][1]:
 
3757
                            # extra file on disk: pass for now, but only
 
3758
                            # increment the path, not the entry
 
3759
                            advance_entry = False
 
3760
                        else:
 
3761
                            # entry referring to file not present on disk.
 
3762
                            # advance the entry only, after processing.
 
3763
                            result, changed = _process_entry(current_entry, None)
 
3764
                            if changed is not None:
 
3765
                                if changed:
 
3766
                                    self._gather_result_for_consistency(result)
 
3767
                                if changed or self.include_unchanged:
 
3768
                                    yield result
 
3769
                            advance_path = False
 
3770
                    else:
 
3771
                        result, changed = _process_entry(current_entry, current_path_info)
 
3772
                        if changed is not None:
 
3773
                            path_handled = True
 
3774
                            if changed:
 
3775
                                self._gather_result_for_consistency(result)
 
3776
                            if changed or self.include_unchanged:
 
3777
                                yield result
 
3778
                    if advance_entry and current_entry is not None:
 
3779
                        entry_index += 1
 
3780
                        if entry_index < len(current_block[1]):
 
3781
                            current_entry = current_block[1][entry_index]
 
3782
                        else:
 
3783
                            current_entry = None
 
3784
                    else:
 
3785
                        advance_entry = True # reset the advance flaga
 
3786
                    if advance_path and current_path_info is not None:
 
3787
                        if not path_handled:
 
3788
                            # unversioned in all regards
 
3789
                            if self.want_unversioned:
 
3790
                                new_executable = bool(
 
3791
                                    stat.S_ISREG(current_path_info[3].st_mode)
 
3792
                                    and stat.S_IEXEC & current_path_info[3].st_mode)
 
3793
                                try:
 
3794
                                    relpath_unicode = utf8_decode(current_path_info[0])[0]
 
3795
                                except UnicodeDecodeError:
 
3796
                                    raise errors.BadFilenameEncoding(
 
3797
                                        current_path_info[0], osutils._fs_enc)
 
3798
                                yield (None,
 
3799
                                    (None, relpath_unicode),
 
3800
                                    True,
 
3801
                                    (False, False),
 
3802
                                    (None, None),
 
3803
                                    (None, utf8_decode(current_path_info[1])[0]),
 
3804
                                    (None, current_path_info[2]),
 
3805
                                    (None, new_executable))
 
3806
                            # dont descend into this unversioned path if it is
 
3807
                            # a dir
 
3808
                            if current_path_info[2] in ('directory'):
 
3809
                                del current_dir_info[1][path_index]
 
3810
                                path_index -= 1
 
3811
                        # dont descend the disk iterator into any tree
 
3812
                        # paths.
 
3813
                        if current_path_info[2] == 'tree-reference':
 
3814
                            del current_dir_info[1][path_index]
 
3815
                            path_index -= 1
 
3816
                        path_index += 1
 
3817
                        if path_index < len(current_dir_info[1]):
 
3818
                            current_path_info = current_dir_info[1][path_index]
 
3819
                            if current_path_info[2] == 'directory':
 
3820
                                if self.tree._directory_is_tree_reference(
 
3821
                                    current_path_info[0].decode('utf8')):
 
3822
                                    current_path_info = current_path_info[:2] + \
 
3823
                                        ('tree-reference',) + current_path_info[3:]
 
3824
                        else:
 
3825
                            current_path_info = None
 
3826
                        path_handled = False
 
3827
                    else:
 
3828
                        advance_path = True # reset the advance flagg.
 
3829
                if current_block is not None:
 
3830
                    block_index += 1
 
3831
                    if (block_index < len(self.state._dirblocks) and
 
3832
                        osutils.is_inside(current_root, self.state._dirblocks[block_index][0])):
 
3833
                        current_block = self.state._dirblocks[block_index]
 
3834
                    else:
 
3835
                        current_block = None
 
3836
                if current_dir_info is not None:
 
3837
                    try:
 
3838
                        current_dir_info = dir_iterator.next()
 
3839
                    except StopIteration:
 
3840
                        current_dir_info = None
 
3841
        for result in self._iter_specific_file_parents():
 
3842
            yield result
 
3843
 
 
3844
    def _iter_specific_file_parents(self):
 
3845
        """Iter over the specific file parents."""
 
3846
        while self.search_specific_file_parents:
 
3847
            # Process the parent directories for the paths we were iterating.
 
3848
            # Even in extremely large trees this should be modest, so currently
 
3849
            # no attempt is made to optimise.
 
3850
            path_utf8 = self.search_specific_file_parents.pop()
 
3851
            if osutils.is_inside_any(self.searched_specific_files, path_utf8):
 
3852
                # We've examined this path.
 
3853
                continue
 
3854
            if path_utf8 in self.searched_exact_paths:
 
3855
                # We've examined this path.
 
3856
                continue
 
3857
            path_entries = self.state._entries_for_path(path_utf8)
 
3858
            # We need either one or two entries. If the path in
 
3859
            # self.target_index has moved (so the entry in source_index is in
 
3860
            # 'ar') then we need to also look for the entry for this path in
 
3861
            # self.source_index, to output the appropriate delete-or-rename.
 
3862
            selected_entries = []
 
3863
            found_item = False
 
3864
            for candidate_entry in path_entries:
 
3865
                # Find entries present in target at this path:
 
3866
                if candidate_entry[1][self.target_index][0] not in 'ar':
 
3867
                    found_item = True
 
3868
                    selected_entries.append(candidate_entry)
 
3869
                # Find entries present in source at this path:
 
3870
                elif (self.source_index is not None and
 
3871
                    candidate_entry[1][self.source_index][0] not in 'ar'):
 
3872
                    found_item = True
 
3873
                    if candidate_entry[1][self.target_index][0] == 'a':
 
3874
                        # Deleted, emit it here.
 
3875
                        selected_entries.append(candidate_entry)
 
3876
                    else:
 
3877
                        # renamed, emit it when we process the directory it
 
3878
                        # ended up at.
 
3879
                        self.search_specific_file_parents.add(
 
3880
                            candidate_entry[1][self.target_index][1])
 
3881
            if not found_item:
 
3882
                raise AssertionError(
 
3883
                    "Missing entry for specific path parent %r, %r" % (
 
3884
                    path_utf8, path_entries))
 
3885
            path_info = self._path_info(path_utf8, path_utf8.decode('utf8'))
 
3886
            for entry in selected_entries:
 
3887
                if entry[0][2] in self.seen_ids:
 
3888
                    continue
 
3889
                result, changed = self._process_entry(entry, path_info)
 
3890
                if changed is None:
 
3891
                    raise AssertionError(
 
3892
                        "Got entry<->path mismatch for specific path "
 
3893
                        "%r entry %r path_info %r " % (
 
3894
                        path_utf8, entry, path_info))
 
3895
                # Only include changes - we're outside the users requested
 
3896
                # expansion.
 
3897
                if changed:
 
3898
                    self._gather_result_for_consistency(result)
 
3899
                    if (result[6][0] == 'directory' and
 
3900
                        result[6][1] != 'directory'):
 
3901
                        # This stopped being a directory, the old children have
 
3902
                        # to be included.
 
3903
                        if entry[1][self.source_index][0] == 'r':
 
3904
                            # renamed, take the source path
 
3905
                            entry_path_utf8 = entry[1][self.source_index][1]
 
3906
                        else:
 
3907
                            entry_path_utf8 = path_utf8
 
3908
                        initial_key = (entry_path_utf8, '', '')
 
3909
                        block_index, _ = self.state._find_block_index_from_key(
 
3910
                            initial_key)
 
3911
                        if block_index == 0:
 
3912
                            # The children of the root are in block index 1.
 
3913
                            block_index +=1
 
3914
                        current_block = None
 
3915
                        if block_index < len(self.state._dirblocks):
 
3916
                            current_block = self.state._dirblocks[block_index]
 
3917
                            if not osutils.is_inside(
 
3918
                                entry_path_utf8, current_block[0]):
 
3919
                                # No entries for this directory at all.
 
3920
                                current_block = None
 
3921
                        if current_block is not None:
 
3922
                            for entry in current_block[1]:
 
3923
                                if entry[1][self.source_index][0] in 'ar':
 
3924
                                    # Not in the source tree, so doesn't have to be
 
3925
                                    # included.
 
3926
                                    continue
 
3927
                                # Path of the entry itself.
 
3928
 
 
3929
                                self.search_specific_file_parents.add(
 
3930
                                    osutils.pathjoin(*entry[0][:2]))
 
3931
                if changed or self.include_unchanged:
 
3932
                    yield result
 
3933
            self.searched_exact_paths.add(path_utf8)
 
3934
 
 
3935
    def _path_info(self, utf8_path, unicode_path):
 
3936
        """Generate path_info for unicode_path.
 
3937
 
 
3938
        :return: None if unicode_path does not exist, or a path_info tuple.
 
3939
        """
 
3940
        abspath = self.tree.abspath(unicode_path)
 
3941
        try:
 
3942
            stat = os.lstat(abspath)
 
3943
        except OSError, e:
 
3944
            if e.errno == errno.ENOENT:
 
3945
                # the path does not exist.
 
3946
                return None
 
3947
            else:
 
3948
                raise
 
3949
        utf8_basename = utf8_path.rsplit('/', 1)[-1]
 
3950
        dir_info = (utf8_path, utf8_basename,
 
3951
            osutils.file_kind_from_stat_mode(stat.st_mode), stat,
 
3952
            abspath)
 
3953
        if dir_info[2] == 'directory':
 
3954
            if self.tree._directory_is_tree_reference(
 
3955
                unicode_path):
 
3956
                self.root_dir_info = self.root_dir_info[:2] + \
 
3957
                    ('tree-reference',) + self.root_dir_info[3:]
 
3958
        return dir_info
 
3959
 
 
3960
 
2777
3961
# Try to load the compiled form if possible
2778
3962
try:
2779
 
    from bzrlib._dirstate_helpers_c import (
2780
 
        _read_dirblocks_c as _read_dirblocks,
2781
 
        bisect_dirblock_c as bisect_dirblock,
2782
 
        _bisect_path_left_c as _bisect_path_left,
2783
 
        _bisect_path_right_c as _bisect_path_right,
2784
 
        cmp_by_dirs_c as cmp_by_dirs,
 
3963
    from bzrlib._dirstate_helpers_pyx import (
 
3964
        _read_dirblocks,
 
3965
        bisect_dirblock,
 
3966
        _bisect_path_left,
 
3967
        _bisect_path_right,
 
3968
        cmp_by_dirs,
 
3969
        ProcessEntryC as _process_entry,
 
3970
        update_entry as update_entry,
2785
3971
        )
2786
3972
except ImportError:
2787
3973
    from bzrlib._dirstate_helpers_py import (
2788
 
        _read_dirblocks_py as _read_dirblocks,
2789
 
        bisect_dirblock_py as bisect_dirblock,
2790
 
        _bisect_path_left_py as _bisect_path_left,
2791
 
        _bisect_path_right_py as _bisect_path_right,
2792
 
        cmp_by_dirs_py as cmp_by_dirs,
 
3974
        _read_dirblocks,
 
3975
        bisect_dirblock,
 
3976
        _bisect_path_left,
 
3977
        _bisect_path_right,
 
3978
        cmp_by_dirs,
2793
3979
        )
 
3980
    # FIXME: It would be nice to be able to track moved lines so that the
 
3981
    # corresponding python code can be moved to the _dirstate_helpers_py
 
3982
    # module. I don't want to break the history for this important piece of
 
3983
    # code so I left the code here -- vila 20090622
 
3984
    update_entry = py_update_entry
 
3985
    _process_entry = ProcessEntryPython