/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to breezy/git/tree.py

  • Committer: Jelmer Vernooij
  • Date: 2019-09-27 01:38:48 UTC
  • mto: This revision was merged to the branch mainline in revision 7402.
  • Revision ID: jelmer@jelmer.uk-20190927013848-px4eoymu6bqjq8rj
Allow has_id to be unsupported.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/git/tree.py
 
1
# Copyright (C) 2009-2018 Jelmer Vernooij <jelmer@jelmer.uk>
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
 
 
18
"""Git Trees."""
 
19
 
 
20
from __future__ import absolute_import
 
21
 
 
22
from collections import deque
 
23
import errno
 
24
from io import BytesIO
 
25
import os
 
26
 
 
27
from dulwich.index import (
 
28
    blob_from_path_and_stat,
 
29
    cleanup_mode,
 
30
    commit_tree,
 
31
    index_entry_from_stat,
 
32
    )
 
33
from dulwich.object_store import (
 
34
    tree_lookup_path,
 
35
    OverlayObjectStore,
 
36
    )
 
37
from dulwich.objects import (
 
38
    Blob,
 
39
    Tree,
 
40
    ZERO_SHA,
 
41
    S_IFGITLINK,
 
42
    S_ISGITLINK,
 
43
    )
 
44
import stat
 
45
import posixpath
 
46
 
 
47
from .. import (
 
48
    controldir as _mod_controldir,
 
49
    delta,
 
50
    errors,
 
51
    mutabletree,
 
52
    osutils,
 
53
    revisiontree,
 
54
    trace,
 
55
    tree as _mod_tree,
 
56
    workingtree,
 
57
    )
 
58
from ..revision import (
 
59
    CURRENT_REVISION,
 
60
    NULL_REVISION,
 
61
    )
 
62
from ..sixish import (
 
63
    text_type,
 
64
    viewitems,
 
65
    )
 
66
 
 
67
from .mapping import (
 
68
    mode_is_executable,
 
69
    mode_kind,
 
70
    default_mapping,
 
71
    )
 
72
 
 
73
 
 
74
class GitTreeDirectory(_mod_tree.TreeDirectory):
 
75
 
 
76
    __slots__ = ['file_id', 'name', 'parent_id', 'children']
 
77
 
 
78
    def __init__(self, file_id, name, parent_id):
 
79
        self.file_id = file_id
 
80
        self.name = name
 
81
        self.parent_id = parent_id
 
82
        # TODO(jelmer)
 
83
        self.children = {}
 
84
 
 
85
    @property
 
86
    def kind(self):
 
87
        return 'directory'
 
88
 
 
89
    @property
 
90
    def executable(self):
 
91
        return False
 
92
 
 
93
    def copy(self):
 
94
        return self.__class__(
 
95
            self.file_id, self.name, self.parent_id)
 
96
 
 
97
    def __repr__(self):
 
98
        return "%s(file_id=%r, name=%r, parent_id=%r)" % (
 
99
            self.__class__.__name__, self.file_id, self.name,
 
100
            self.parent_id)
 
101
 
 
102
    def __eq__(self, other):
 
103
        return (self.kind == other.kind and
 
104
                self.file_id == other.file_id and
 
105
                self.name == other.name and
 
106
                self.parent_id == other.parent_id)
 
107
 
 
108
 
 
109
class GitTreeFile(_mod_tree.TreeFile):
 
110
 
 
111
    __slots__ = ['file_id', 'name', 'parent_id', 'text_size', 'text_sha1',
 
112
                 'executable']
 
113
 
 
114
    def __init__(self, file_id, name, parent_id, text_size=None,
 
115
                 text_sha1=None, executable=None):
 
116
        self.file_id = file_id
 
117
        self.name = name
 
118
        self.parent_id = parent_id
 
119
        self.text_size = text_size
 
120
        self.text_sha1 = text_sha1
 
121
        self.executable = executable
 
122
 
 
123
    @property
 
124
    def kind(self):
 
125
        return 'file'
 
126
 
 
127
    def __eq__(self, other):
 
128
        return (self.kind == other.kind and
 
129
                self.file_id == other.file_id and
 
130
                self.name == other.name and
 
131
                self.parent_id == other.parent_id and
 
132
                self.text_sha1 == other.text_sha1 and
 
133
                self.text_size == other.text_size and
 
134
                self.executable == other.executable)
 
135
 
 
136
    def __repr__(self):
 
137
        return ("%s(file_id=%r, name=%r, parent_id=%r, text_size=%r, "
 
138
                "text_sha1=%r, executable=%r)") % (
 
139
            type(self).__name__, self.file_id, self.name, self.parent_id,
 
140
            self.text_size, self.text_sha1, self.executable)
 
141
 
 
142
    def copy(self):
 
143
        ret = self.__class__(
 
144
            self.file_id, self.name, self.parent_id)
 
145
        ret.text_sha1 = self.text_sha1
 
146
        ret.text_size = self.text_size
 
147
        ret.executable = self.executable
 
148
        return ret
 
149
 
 
150
 
 
151
class GitTreeSymlink(_mod_tree.TreeLink):
 
152
 
 
153
    __slots__ = ['file_id', 'name', 'parent_id', 'symlink_target']
 
154
 
 
155
    def __init__(self, file_id, name, parent_id,
 
156
                 symlink_target=None):
 
157
        self.file_id = file_id
 
158
        self.name = name
 
159
        self.parent_id = parent_id
 
160
        self.symlink_target = symlink_target
 
161
 
 
162
    @property
 
163
    def kind(self):
 
164
        return 'symlink'
 
165
 
 
166
    @property
 
167
    def executable(self):
 
168
        return False
 
169
 
 
170
    @property
 
171
    def text_size(self):
 
172
        return None
 
173
 
 
174
    def __repr__(self):
 
175
        return "%s(file_id=%r, name=%r, parent_id=%r, symlink_target=%r)" % (
 
176
            type(self).__name__, self.file_id, self.name, self.parent_id,
 
177
            self.symlink_target)
 
178
 
 
179
    def __eq__(self, other):
 
180
        return (self.kind == other.kind and
 
181
                self.file_id == other.file_id and
 
182
                self.name == other.name and
 
183
                self.parent_id == other.parent_id and
 
184
                self.symlink_target == other.symlink_target)
 
185
 
 
186
    def copy(self):
 
187
        return self.__class__(
 
188
            self.file_id, self.name, self.parent_id,
 
189
            self.symlink_target)
 
190
 
 
191
 
 
192
class GitTreeSubmodule(_mod_tree.TreeLink):
 
193
 
 
194
    __slots__ = ['file_id', 'name', 'parent_id', 'reference_revision']
 
195
 
 
196
    def __init__(self, file_id, name, parent_id, reference_revision=None):
 
197
        self.file_id = file_id
 
198
        self.name = name
 
199
        self.parent_id = parent_id
 
200
        self.reference_revision = reference_revision
 
201
 
 
202
    @property
 
203
    def kind(self):
 
204
        return 'tree-reference'
 
205
 
 
206
    def __repr__(self):
 
207
        return ("%s(file_id=%r, name=%r, parent_id=%r, "
 
208
                "reference_revision=%r)") % (
 
209
            type(self).__name__, self.file_id, self.name, self.parent_id,
 
210
            self.reference_revision)
 
211
 
 
212
    def __eq__(self, other):
 
213
        return (self.kind == other.kind and
 
214
                self.file_id == other.file_id and
 
215
                self.name == other.name and
 
216
                self.parent_id == other.parent_id and
 
217
                self.reference_revision == other.reference_revision)
 
218
 
 
219
    def copy(self):
 
220
        return self.__class__(
 
221
            self.file_id, self.name, self.parent_id,
 
222
            self.reference_revision)
 
223
 
 
224
 
 
225
entry_factory = {
 
226
    'directory': GitTreeDirectory,
 
227
    'file': GitTreeFile,
 
228
    'symlink': GitTreeSymlink,
 
229
    'tree-reference': GitTreeSubmodule,
 
230
    }
 
231
 
 
232
 
 
233
def ensure_normalized_path(path):
 
234
    """Check whether path is normalized.
 
235
 
 
236
    :raises InvalidNormalization: When path is not normalized, and cannot be
 
237
        accessed on this platform by the normalized path.
 
238
    :return: The NFC normalised version of path.
 
239
    """
 
240
    norm_path, can_access = osutils.normalized_filename(path)
 
241
    if norm_path != path:
 
242
        if can_access:
 
243
            return norm_path
 
244
        else:
 
245
            raise errors.InvalidNormalization(path)
 
246
    return path
 
247
 
 
248
 
 
249
class GitRevisionTree(revisiontree.RevisionTree):
 
250
    """Revision tree implementation based on Git objects."""
 
251
 
 
252
    def __init__(self, repository, revision_id):
 
253
        self._revision_id = revision_id
 
254
        self._repository = repository
 
255
        self._submodules = None
 
256
        self.store = repository._git.object_store
 
257
        if not isinstance(revision_id, bytes):
 
258
            raise TypeError(revision_id)
 
259
        self.commit_id, self.mapping = repository.lookup_bzr_revision_id(
 
260
            revision_id)
 
261
        if revision_id == NULL_REVISION:
 
262
            self.tree = None
 
263
            self.mapping = default_mapping
 
264
        else:
 
265
            try:
 
266
                commit = self.store[self.commit_id]
 
267
            except KeyError:
 
268
                raise errors.NoSuchRevision(repository, revision_id)
 
269
            self.tree = commit.tree
 
270
 
 
271
    def _submodule_info(self):
 
272
        if self._submodules is None:
 
273
            try:
 
274
                with self.get_file('.gitmodules') as f:
 
275
                    config = GitConfigFile.from_file(f)
 
276
                    self._submodules = {
 
277
                        path: (url, section)
 
278
                        for path, url, section in parse_submodules(config)}
 
279
            except errors.NoSuchFile:
 
280
                self._submodules = {}
 
281
        return self._submodules
 
282
 
 
283
    def _get_submodule_repository(self, relpath):
 
284
        if not isinstance(relpath, bytes):
 
285
            raise TypeError(relpath)
 
286
        try:
 
287
            info = self._submodule_info()[relpath]
 
288
        except KeyError:
 
289
            nested_repo_transport = self._repository.user_transport.clone(relpath.decode('utf-8'))
 
290
        else:
 
291
            nested_repo_transport = self._repository.control_transport.clone(
 
292
                posixpath.join('modules', info[0]))
 
293
        nested_controldir = _mod_controldir.ControlDir.open_from_transport(
 
294
            nested_repo_transport)
 
295
        return nested_controldir.find_repository()
 
296
 
 
297
    def get_nested_tree(self, path):
 
298
        encoded_path = path.encode('utf-8')
 
299
        nested_repo = self._get_submodule_repository(encoded_path)
 
300
        ref_rev = self.get_reference_revision(path)
 
301
        return nested_repo.revision_tree(ref_rev)
 
302
 
 
303
    def supports_rename_tracking(self):
 
304
        return False
 
305
 
 
306
    def get_file_revision(self, path):
 
307
        change_scanner = self._repository._file_change_scanner
 
308
        if self.commit_id == ZERO_SHA:
 
309
            return NULL_REVISION
 
310
        (unused_path, commit_id) = change_scanner.find_last_change_revision(
 
311
            path.encode('utf-8'), self.commit_id)
 
312
        return self._repository.lookup_foreign_revision_id(
 
313
            commit_id, self.mapping)
 
314
 
 
315
    def get_file_mtime(self, path):
 
316
        try:
 
317
            revid = self.get_file_revision(path)
 
318
        except KeyError:
 
319
            raise errors.NoSuchFile(path)
 
320
        try:
 
321
            rev = self._repository.get_revision(revid)
 
322
        except errors.NoSuchRevision:
 
323
            raise _mod_tree.FileTimestampUnavailable(path)
 
324
        return rev.timestamp
 
325
 
 
326
    def id2path(self, file_id):
 
327
        try:
 
328
            path = self.mapping.parse_file_id(file_id)
 
329
        except ValueError:
 
330
            raise errors.NoSuchId(self, file_id)
 
331
        if self.is_versioned(path):
 
332
            return path
 
333
        raise errors.NoSuchId(self, file_id)
 
334
 
 
335
    def is_versioned(self, path):
 
336
        return self.has_filename(path)
 
337
 
 
338
    def path2id(self, path):
 
339
        if self.mapping.is_special_file(path):
 
340
            return None
 
341
        if not self.is_versioned(path):
 
342
            return None
 
343
        return self.mapping.generate_file_id(osutils.safe_unicode(path))
 
344
 
 
345
    def all_file_ids(self):
 
346
        raise errors.UnsupportedOperation(self.all_file_ids, self)
 
347
 
 
348
    def all_versioned_paths(self):
 
349
        ret = {u''}
 
350
        todo = [(self.store, b'', self.tree)]
 
351
        while todo:
 
352
            (store, path, tree_id) = todo.pop()
 
353
            if tree_id is None:
 
354
                continue
 
355
            tree = store[tree_id]
 
356
            for name, mode, hexsha in tree.items():
 
357
                subpath = posixpath.join(path, name)
 
358
                ret.add(subpath.decode('utf-8'))
 
359
                if stat.S_ISDIR(mode):
 
360
                    todo.append((store, subpath, hexsha))
 
361
        return ret
 
362
 
 
363
    def has_id(self, file_id):
 
364
        raise errors.UnsupportedOperation(self.has_id, self)
 
365
 
 
366
    def _lookup_path(self, path):
 
367
        if self.tree is None:
 
368
            raise errors.NoSuchFile(path)
 
369
        try:
 
370
            (mode, hexsha) = tree_lookup_path(
 
371
                self.store.__getitem__, self.tree, path.encode('utf-8'))
 
372
        except KeyError:
 
373
            raise errors.NoSuchFile(self, path)
 
374
        else:
 
375
            return (self.store, mode, hexsha)
 
376
 
 
377
    def is_executable(self, path):
 
378
        (store, mode, hexsha) = self._lookup_path(path)
 
379
        if mode is None:
 
380
            # the tree root is a directory
 
381
            return False
 
382
        return mode_is_executable(mode)
 
383
 
 
384
    def kind(self, path):
 
385
        (store, mode, hexsha) = self._lookup_path(path)
 
386
        if mode is None:
 
387
            # the tree root is a directory
 
388
            return "directory"
 
389
        return mode_kind(mode)
 
390
 
 
391
    def has_filename(self, path):
 
392
        try:
 
393
            self._lookup_path(path)
 
394
        except errors.NoSuchFile:
 
395
            return False
 
396
        else:
 
397
            return True
 
398
 
 
399
    def list_files(self, include_root=False, from_dir=None, recursive=True):
 
400
        if self.tree is None:
 
401
            return
 
402
        if from_dir is None or from_dir == '.':
 
403
            from_dir = u""
 
404
        (store, mode, hexsha) = self._lookup_path(from_dir)
 
405
        if mode is None:  # Root
 
406
            root_ie = self._get_dir_ie(b"", None)
 
407
        else:
 
408
            parent_path = posixpath.dirname(from_dir)
 
409
            parent_id = self.mapping.generate_file_id(parent_path)
 
410
            if mode_kind(mode) == 'directory':
 
411
                root_ie = self._get_dir_ie(from_dir.encode("utf-8"), parent_id)
 
412
            else:
 
413
                root_ie = self._get_file_ie(
 
414
                    store, from_dir.encode("utf-8"),
 
415
                    posixpath.basename(from_dir), mode, hexsha)
 
416
        if include_root:
 
417
            yield (from_dir, "V", root_ie.kind, root_ie)
 
418
        todo = []
 
419
        if root_ie.kind == 'directory':
 
420
            todo.append((store, from_dir.encode("utf-8"),
 
421
                         b"", hexsha, root_ie.file_id))
 
422
        while todo:
 
423
            (store, path, relpath, hexsha, parent_id) = todo.pop()
 
424
            tree = store[hexsha]
 
425
            for name, mode, hexsha in tree.iteritems():
 
426
                if self.mapping.is_special_file(name):
 
427
                    continue
 
428
                child_path = posixpath.join(path, name)
 
429
                child_relpath = posixpath.join(relpath, name)
 
430
                if stat.S_ISDIR(mode):
 
431
                    ie = self._get_dir_ie(child_path, parent_id)
 
432
                    if recursive:
 
433
                        todo.append(
 
434
                            (store, child_path, child_relpath, hexsha,
 
435
                             ie.file_id))
 
436
                else:
 
437
                    ie = self._get_file_ie(
 
438
                        store, child_path, name, mode, hexsha, parent_id)
 
439
                yield (child_relpath.decode('utf-8'), "V", ie.kind, ie)
 
440
 
 
441
    def _get_file_ie(self, store, path, name, mode, hexsha, parent_id):
 
442
        if not isinstance(path, bytes):
 
443
            raise TypeError(path)
 
444
        if not isinstance(name, bytes):
 
445
            raise TypeError(name)
 
446
        kind = mode_kind(mode)
 
447
        path = path.decode('utf-8')
 
448
        name = name.decode("utf-8")
 
449
        file_id = self.mapping.generate_file_id(path)
 
450
        ie = entry_factory[kind](file_id, name, parent_id)
 
451
        if kind == 'symlink':
 
452
            ie.symlink_target = store[hexsha].data.decode('utf-8')
 
453
        elif kind == 'tree-reference':
 
454
            ie.reference_revision = self.mapping.revision_id_foreign_to_bzr(
 
455
                hexsha)
 
456
        else:
 
457
            data = store[hexsha].data
 
458
            ie.text_sha1 = osutils.sha_string(data)
 
459
            ie.text_size = len(data)
 
460
            ie.executable = mode_is_executable(mode)
 
461
        return ie
 
462
 
 
463
    def _get_dir_ie(self, path, parent_id):
 
464
        path = path.decode('utf-8')
 
465
        file_id = self.mapping.generate_file_id(path)
 
466
        return GitTreeDirectory(file_id, posixpath.basename(path), parent_id)
 
467
 
 
468
    def iter_child_entries(self, path):
 
469
        (store, mode, tree_sha) = self._lookup_path(path)
 
470
 
 
471
        if mode is not None and not stat.S_ISDIR(mode):
 
472
            return
 
473
 
 
474
        encoded_path = path.encode('utf-8')
 
475
        file_id = self.path2id(path)
 
476
        tree = store[tree_sha]
 
477
        for name, mode, hexsha in tree.iteritems():
 
478
            if self.mapping.is_special_file(name):
 
479
                continue
 
480
            child_path = posixpath.join(encoded_path, name)
 
481
            if stat.S_ISDIR(mode):
 
482
                yield self._get_dir_ie(child_path, file_id)
 
483
            else:
 
484
                yield self._get_file_ie(store, child_path, name, mode, hexsha,
 
485
                                        file_id)
 
486
 
 
487
    def iter_entries_by_dir(self, specific_files=None, yield_parents=False):
 
488
        if self.tree is None:
 
489
            return
 
490
        if yield_parents:
 
491
            # TODO(jelmer): Support yield parents
 
492
            raise NotImplementedError
 
493
        if specific_files is not None:
 
494
            if specific_files in ([""], []):
 
495
                specific_files = None
 
496
            else:
 
497
                specific_files = set([p.encode('utf-8')
 
498
                                      for p in specific_files])
 
499
        todo = deque([(self.store, b"", self.tree, self.path2id(''))])
 
500
        if specific_files is None or u"" in specific_files:
 
501
            yield u"", self._get_dir_ie(b"", None)
 
502
        while todo:
 
503
            store, path, tree_sha, parent_id = todo.popleft()
 
504
            tree = store[tree_sha]
 
505
            extradirs = []
 
506
            for name, mode, hexsha in tree.iteritems():
 
507
                if self.mapping.is_special_file(name):
 
508
                    continue
 
509
                child_path = posixpath.join(path, name)
 
510
                child_path_decoded = child_path.decode('utf-8')
 
511
                if stat.S_ISDIR(mode):
 
512
                    if (specific_files is None or
 
513
                            any([p for p in specific_files if p.startswith(
 
514
                                child_path)])):
 
515
                        extradirs.append(
 
516
                            (store, child_path, hexsha,
 
517
                             self.path2id(child_path_decoded)))
 
518
                if specific_files is None or child_path in specific_files:
 
519
                    if stat.S_ISDIR(mode):
 
520
                        yield (child_path_decoded,
 
521
                               self._get_dir_ie(child_path, parent_id))
 
522
                    else:
 
523
                        yield (child_path_decoded,
 
524
                               self._get_file_ie(store, child_path, name, mode,
 
525
                                                 hexsha, parent_id))
 
526
            todo.extendleft(reversed(extradirs))
 
527
 
 
528
    def iter_references(self):
 
529
        if self.supports_tree_reference():
 
530
            for path, entry in self.iter_entries_by_dir():
 
531
                if entry.kind == 'tree-reference':
 
532
                    yield path
 
533
 
 
534
    def get_revision_id(self):
 
535
        """See RevisionTree.get_revision_id."""
 
536
        return self._revision_id
 
537
 
 
538
    def get_file_sha1(self, path, stat_value=None):
 
539
        if self.tree is None:
 
540
            raise errors.NoSuchFile(path)
 
541
        return osutils.sha_string(self.get_file_text(path))
 
542
 
 
543
    def get_file_verifier(self, path, stat_value=None):
 
544
        (store, mode, hexsha) = self._lookup_path(path)
 
545
        return ("GIT", hexsha)
 
546
 
 
547
    def get_file_size(self, path):
 
548
        (store, mode, hexsha) = self._lookup_path(path)
 
549
        if stat.S_ISREG(mode):
 
550
            return len(store[hexsha].data)
 
551
        return None
 
552
 
 
553
    def get_file_text(self, path):
 
554
        """See RevisionTree.get_file_text."""
 
555
        (store, mode, hexsha) = self._lookup_path(path)
 
556
        if stat.S_ISREG(mode):
 
557
            return store[hexsha].data
 
558
        else:
 
559
            return b""
 
560
 
 
561
    def get_symlink_target(self, path):
 
562
        """See RevisionTree.get_symlink_target."""
 
563
        (store, mode, hexsha) = self._lookup_path(path)
 
564
        if stat.S_ISLNK(mode):
 
565
            return store[hexsha].data.decode('utf-8')
 
566
        else:
 
567
            return None
 
568
 
 
569
    def get_reference_revision(self, path):
 
570
        """See RevisionTree.get_symlink_target."""
 
571
        (store, mode, hexsha) = self._lookup_path(path)
 
572
        if S_ISGITLINK(mode):
 
573
            nested_repo = self._get_submodule_repository(path.encode('utf-8'))
 
574
            return nested_repo.lookup_foreign_revision_id(hexsha)
 
575
        else:
 
576
            return None
 
577
 
 
578
    def _comparison_data(self, entry, path):
 
579
        if entry is None:
 
580
            return None, False, None
 
581
        return entry.kind, entry.executable, None
 
582
 
 
583
    def path_content_summary(self, path):
 
584
        """See Tree.path_content_summary."""
 
585
        try:
 
586
            (store, mode, hexsha) = self._lookup_path(path)
 
587
        except errors.NoSuchFile:
 
588
            return ('missing', None, None, None)
 
589
        kind = mode_kind(mode)
 
590
        if kind == 'file':
 
591
            executable = mode_is_executable(mode)
 
592
            contents = store[hexsha].data
 
593
            return (kind, len(contents), executable,
 
594
                    osutils.sha_string(contents))
 
595
        elif kind == 'symlink':
 
596
            return (kind, None, None, store[hexsha].data.decode('utf-8'))
 
597
        elif kind == 'tree-reference':
 
598
            nested_repo = self._get_submodule_repository(path.encode('utf-8'))
 
599
            return (kind, None, None,
 
600
                    nested_repo.lookup_foreign_revision_id(hexsha))
 
601
        else:
 
602
            return (kind, None, None, None)
 
603
 
 
604
    def find_related_paths_across_trees(self, paths, trees=[],
 
605
                                        require_versioned=True):
 
606
        if paths is None:
 
607
            return None
 
608
        if require_versioned:
 
609
            trees = [self] + (trees if trees is not None else [])
 
610
            unversioned = set()
 
611
            for p in paths:
 
612
                for t in trees:
 
613
                    if t.is_versioned(p):
 
614
                        break
 
615
                else:
 
616
                    unversioned.add(p)
 
617
            if unversioned:
 
618
                raise errors.PathsNotVersionedError(unversioned)
 
619
        return filter(self.is_versioned, paths)
 
620
 
 
621
    def _iter_tree_contents(self, include_trees=False):
 
622
        if self.tree is None:
 
623
            return iter([])
 
624
        return self.store.iter_tree_contents(
 
625
            self.tree, include_trees=include_trees)
 
626
 
 
627
    def annotate_iter(self, path, default_revision=CURRENT_REVISION):
 
628
        """Return an iterator of revision_id, line tuples.
 
629
 
 
630
        For working trees (and mutable trees in general), the special
 
631
        revision_id 'current:' will be used for lines that are new in this
 
632
        tree, e.g. uncommitted changes.
 
633
        :param default_revision: For lines that don't match a basis, mark them
 
634
            with this revision id. Not all implementations will make use of
 
635
            this value.
 
636
        """
 
637
        with self.lock_read():
 
638
            # Now we have the parents of this content
 
639
            from breezy.annotate import Annotator
 
640
            from .annotate import AnnotateProvider
 
641
            annotator = Annotator(AnnotateProvider(
 
642
                self._repository._file_change_scanner))
 
643
            this_key = (path, self.get_file_revision(path))
 
644
            annotations = [(key[-1], line)
 
645
                           for key, line in annotator.annotate_flat(this_key)]
 
646
            return annotations
 
647
 
 
648
    def _get_rules_searcher(self, default_searcher):
 
649
        return default_searcher
 
650
 
 
651
    def walkdirs(self, prefix=u""):
 
652
        (store, mode, hexsha) = self._lookup_path(prefix)
 
653
        todo = deque(
 
654
            [(store, prefix.encode('utf-8'), hexsha, self.path2id(prefix))])
 
655
        while todo:
 
656
            store, path, tree_sha, parent_id = todo.popleft()
 
657
            path_decoded = path.decode('utf-8')
 
658
            tree = store[tree_sha]
 
659
            children = []
 
660
            for name, mode, hexsha in tree.iteritems():
 
661
                if self.mapping.is_special_file(name):
 
662
                    continue
 
663
                child_path = posixpath.join(path, name)
 
664
                file_id = self.path2id(child_path.decode('utf-8'))
 
665
                if stat.S_ISDIR(mode):
 
666
                    todo.append((store, child_path, hexsha, file_id))
 
667
                children.append(
 
668
                    (child_path.decode('utf-8'), name.decode('utf-8'),
 
669
                        mode_kind(mode), None,
 
670
                        file_id, mode_kind(mode)))
 
671
            yield (path_decoded, parent_id), children
 
672
 
 
673
 
 
674
def tree_delta_from_git_changes(changes, mappings,
 
675
                                specific_files=None,
 
676
                                require_versioned=False, include_root=False,
 
677
                                target_extras=None):
 
678
    """Create a TreeDelta from two git trees.
 
679
 
 
680
    source and target are iterators over tuples with:
 
681
        (filename, sha, mode)
 
682
    """
 
683
    (old_mapping, new_mapping) = mappings
 
684
    if target_extras is None:
 
685
        target_extras = set()
 
686
    ret = delta.TreeDelta()
 
687
    added = []
 
688
    for (oldpath, newpath), (oldmode, newmode), (oldsha, newsha) in changes:
 
689
        if newpath == b'' and not include_root:
 
690
            continue
 
691
        if oldpath is not None:
 
692
            oldpath_decoded = oldpath.decode('utf-8')
 
693
        else:
 
694
            oldpath_decoded = None
 
695
        if newpath is not None:
 
696
            newpath_decoded = newpath.decode('utf-8')
 
697
        else:
 
698
            newpath_decoded = None
 
699
        if not (specific_files is None or
 
700
                (oldpath is not None and
 
701
                    osutils.is_inside_or_parent_of_any(
 
702
                        specific_files, oldpath_decoded)) or
 
703
                (newpath is not None and
 
704
                    osutils.is_inside_or_parent_of_any(
 
705
                        specific_files, newpath_decoded))):
 
706
            continue
 
707
 
 
708
        if oldpath_decoded is None:
 
709
            fileid = new_mapping.generate_file_id(newpath_decoded)
 
710
            oldexe = None
 
711
            oldkind = None
 
712
            oldname = None
 
713
            oldparent = None
 
714
            oldversioned = False
 
715
        else:
 
716
            oldversioned = True
 
717
            if oldmode:
 
718
                oldexe = mode_is_executable(oldmode)
 
719
                oldkind = mode_kind(oldmode)
 
720
            else:
 
721
                oldexe = False
 
722
                oldkind = None
 
723
            if oldpath_decoded == u'':
 
724
                oldparent = None
 
725
                oldname = u''
 
726
            else:
 
727
                (oldparentpath, oldname) = osutils.split(oldpath_decoded)
 
728
                oldparent = old_mapping.generate_file_id(oldparentpath)
 
729
            fileid = old_mapping.generate_file_id(oldpath_decoded)
 
730
        if newpath_decoded is None:
 
731
            newexe = None
 
732
            newkind = None
 
733
            newname = None
 
734
            newparent = None
 
735
            newversioned = False
 
736
        else:
 
737
            newversioned = (newpath_decoded not in target_extras)
 
738
            if newmode:
 
739
                newexe = mode_is_executable(newmode)
 
740
                newkind = mode_kind(newmode)
 
741
            else:
 
742
                newexe = False
 
743
                newkind = None
 
744
            if newpath_decoded == u'':
 
745
                newparent = None
 
746
                newname = u''
 
747
            else:
 
748
                newparentpath, newname = osutils.split(newpath_decoded)
 
749
                newparent = new_mapping.generate_file_id(newparentpath)
 
750
        if old_mapping.is_special_file(oldpath):
 
751
            oldpath = None
 
752
        if new_mapping.is_special_file(newpath):
 
753
            newpath = None
 
754
        if oldpath is None and newpath is None:
 
755
            continue
 
756
        change = _mod_tree.TreeChange(
 
757
            fileid, (oldpath_decoded, newpath_decoded), (oldsha != newsha),
 
758
            (oldversioned, newversioned),
 
759
            (oldparent, newparent), (oldname, newname),
 
760
            (oldkind, newkind), (oldexe, newexe))
 
761
        if oldpath is None:
 
762
            added.append((newpath, newkind))
 
763
        elif newpath is None or newmode == 0:
 
764
            ret.removed.append(change)
 
765
        elif oldpath != newpath:
 
766
            ret.renamed.append(change)
 
767
        elif mode_kind(oldmode) != mode_kind(newmode):
 
768
            ret.kind_changed.append(change)
 
769
        elif oldsha != newsha or oldmode != newmode:
 
770
            if stat.S_ISDIR(oldmode) and stat.S_ISDIR(newmode):
 
771
                continue
 
772
            ret.modified.append(change)
 
773
        else:
 
774
            ret.unchanged.append(change)
 
775
 
 
776
    implicit_dirs = {b''}
 
777
    for path, kind in added:
 
778
        if kind == 'directory' or path in target_extras:
 
779
            continue
 
780
        implicit_dirs.update(osutils.parent_directories(path))
 
781
 
 
782
    for path, kind in added:
 
783
        if kind == 'directory' and path not in implicit_dirs:
 
784
            continue
 
785
        path_decoded = osutils.normalized_filename(path)[0]
 
786
        parent_path, basename = osutils.split(path_decoded)
 
787
        parent_id = new_mapping.generate_file_id(parent_path)
 
788
        if path in target_extras:
 
789
            ret.unversioned.append(_mod_tree.TreeChange(
 
790
                None, (None, path_decoded),
 
791
                True, (False, False), (None, parent_id),
 
792
                (None, basename), (None, kind), (None, False)))
 
793
        else:
 
794
            file_id = new_mapping.generate_file_id(path_decoded)
 
795
            ret.added.append(
 
796
                _mod_tree.TreeChange(
 
797
                    file_id, (None, path_decoded), True,
 
798
                    (False, True),
 
799
                    (None, parent_id),
 
800
                    (None, basename), (None, kind), (None, False)))
 
801
 
 
802
    return ret
 
803
 
 
804
 
 
805
def changes_from_git_changes(changes, mapping, specific_files=None,
 
806
                             include_unchanged=False, target_extras=None):
 
807
    """Create a iter_changes-like generator from a git stream.
 
808
 
 
809
    source and target are iterators over tuples with:
 
810
        (filename, sha, mode)
 
811
    """
 
812
    if target_extras is None:
 
813
        target_extras = set()
 
814
    for (oldpath, newpath), (oldmode, newmode), (oldsha, newsha) in changes:
 
815
        if oldpath is not None:
 
816
            oldpath_decoded = oldpath.decode('utf-8')
 
817
        else:
 
818
            oldpath_decoded = None
 
819
        if newpath is not None:
 
820
            newpath_decoded = newpath.decode('utf-8')
 
821
        else:
 
822
            newpath_decoded = None
 
823
        if not (specific_files is None or
 
824
                (oldpath_decoded is not None and
 
825
                    osutils.is_inside_or_parent_of_any(
 
826
                        specific_files, oldpath_decoded)) or
 
827
                (newpath_decoded is not None and
 
828
                    osutils.is_inside_or_parent_of_any(
 
829
                        specific_files, newpath_decoded))):
 
830
            continue
 
831
        if oldpath is not None and mapping.is_special_file(oldpath):
 
832
            continue
 
833
        if newpath is not None and mapping.is_special_file(newpath):
 
834
            continue
 
835
        if oldpath_decoded is None:
 
836
            fileid = mapping.generate_file_id(newpath_decoded)
 
837
            oldexe = None
 
838
            oldkind = None
 
839
            oldname = None
 
840
            oldparent = None
 
841
            oldversioned = False
 
842
        else:
 
843
            oldversioned = True
 
844
            if oldmode:
 
845
                oldexe = mode_is_executable(oldmode)
 
846
                oldkind = mode_kind(oldmode)
 
847
            else:
 
848
                oldexe = False
 
849
                oldkind = None
 
850
            if oldpath_decoded == u'':
 
851
                oldparent = None
 
852
                oldname = u''
 
853
            else:
 
854
                (oldparentpath, oldname) = osutils.split(oldpath_decoded)
 
855
                oldparent = mapping.generate_file_id(oldparentpath)
 
856
            fileid = mapping.generate_file_id(oldpath_decoded)
 
857
        if newpath_decoded is None:
 
858
            newexe = None
 
859
            newkind = None
 
860
            newname = None
 
861
            newparent = None
 
862
            newversioned = False
 
863
        else:
 
864
            newversioned = (newpath_decoded not in target_extras)
 
865
            if newmode:
 
866
                newexe = mode_is_executable(newmode)
 
867
                newkind = mode_kind(newmode)
 
868
            else:
 
869
                newexe = False
 
870
                newkind = None
 
871
            if newpath_decoded == u'':
 
872
                newparent = None
 
873
                newname = u''
 
874
            else:
 
875
                newparentpath, newname = osutils.split(newpath_decoded)
 
876
                newparent = mapping.generate_file_id(newparentpath)
 
877
        if (not include_unchanged and
 
878
            oldkind == 'directory' and newkind == 'directory' and
 
879
                oldpath_decoded == newpath_decoded):
 
880
            continue
 
881
        yield _mod_tree.TreeChange(
 
882
            fileid, (oldpath_decoded, newpath_decoded), (oldsha != newsha),
 
883
            (oldversioned, newversioned),
 
884
            (oldparent, newparent), (oldname, newname),
 
885
            (oldkind, newkind), (oldexe, newexe))
 
886
 
 
887
 
 
888
class InterGitTrees(_mod_tree.InterTree):
 
889
    """InterTree that works between two git trees."""
 
890
 
 
891
    _matching_from_tree_format = None
 
892
    _matching_to_tree_format = None
 
893
    _test_mutable_trees_to_test_trees = None
 
894
 
 
895
    @classmethod
 
896
    def is_compatible(cls, source, target):
 
897
        return (isinstance(source, GitRevisionTree) and
 
898
                isinstance(target, GitRevisionTree))
 
899
 
 
900
    def compare(self, want_unchanged=False, specific_files=None,
 
901
                extra_trees=None, require_versioned=False, include_root=False,
 
902
                want_unversioned=False):
 
903
        with self.lock_read():
 
904
            changes, target_extras = self._iter_git_changes(
 
905
                want_unchanged=want_unchanged,
 
906
                require_versioned=require_versioned,
 
907
                specific_files=specific_files,
 
908
                extra_trees=extra_trees,
 
909
                want_unversioned=want_unversioned)
 
910
            return tree_delta_from_git_changes(
 
911
                changes, (self.source.mapping, self.target.mapping),
 
912
                specific_files=specific_files,
 
913
                include_root=include_root, target_extras=target_extras)
 
914
 
 
915
    def iter_changes(self, include_unchanged=False, specific_files=None,
 
916
                     pb=None, extra_trees=[], require_versioned=True,
 
917
                     want_unversioned=False):
 
918
        with self.lock_read():
 
919
            changes, target_extras = self._iter_git_changes(
 
920
                want_unchanged=include_unchanged,
 
921
                require_versioned=require_versioned,
 
922
                specific_files=specific_files,
 
923
                extra_trees=extra_trees,
 
924
                want_unversioned=want_unversioned)
 
925
            return changes_from_git_changes(
 
926
                changes, self.target.mapping,
 
927
                specific_files=specific_files,
 
928
                include_unchanged=include_unchanged,
 
929
                target_extras=target_extras)
 
930
 
 
931
    def _iter_git_changes(self, want_unchanged=False, specific_files=None,
 
932
                          require_versioned=False, extra_trees=None,
 
933
                          want_unversioned=False):
 
934
        raise NotImplementedError(self._iter_git_changes)
 
935
 
 
936
 
 
937
class InterGitRevisionTrees(InterGitTrees):
 
938
    """InterTree that works between two git revision trees."""
 
939
 
 
940
    _matching_from_tree_format = None
 
941
    _matching_to_tree_format = None
 
942
    _test_mutable_trees_to_test_trees = None
 
943
 
 
944
    @classmethod
 
945
    def is_compatible(cls, source, target):
 
946
        return (isinstance(source, GitRevisionTree) and
 
947
                isinstance(target, GitRevisionTree))
 
948
 
 
949
    def _iter_git_changes(self, want_unchanged=False, specific_files=None,
 
950
                          require_versioned=True, extra_trees=None,
 
951
                          want_unversioned=False):
 
952
        trees = [self.source]
 
953
        if extra_trees is not None:
 
954
            trees.extend(extra_trees)
 
955
        if specific_files is not None:
 
956
            specific_files = self.target.find_related_paths_across_trees(
 
957
                specific_files, trees,
 
958
                require_versioned=require_versioned)
 
959
 
 
960
        if (self.source._repository._git.object_store !=
 
961
                self.target._repository._git.object_store):
 
962
            store = OverlayObjectStore(
 
963
                [self.source._repository._git.object_store,
 
964
                    self.target._repository._git.object_store])
 
965
        else:
 
966
            store = self.source._repository._git.object_store
 
967
        return store.tree_changes(
 
968
            self.source.tree, self.target.tree, want_unchanged=want_unchanged,
 
969
            include_trees=True, change_type_same=True), set()
 
970
 
 
971
 
 
972
_mod_tree.InterTree.register_optimiser(InterGitRevisionTrees)
 
973
 
 
974
 
 
975
class MutableGitIndexTree(mutabletree.MutableTree):
 
976
 
 
977
    def __init__(self):
 
978
        self._lock_mode = None
 
979
        self._lock_count = 0
 
980
        self._versioned_dirs = None
 
981
        self._index_dirty = False
 
982
 
 
983
    def is_versioned(self, path):
 
984
        with self.lock_read():
 
985
            path = path.rstrip('/').encode('utf-8')
 
986
            (index, subpath) = self._lookup_index(path)
 
987
            return (subpath in index or self._has_dir(path))
 
988
 
 
989
    def _has_dir(self, path):
 
990
        if not isinstance(path, bytes):
 
991
            raise TypeError(path)
 
992
        if path == b"":
 
993
            return True
 
994
        if self._versioned_dirs is None:
 
995
            self._load_dirs()
 
996
        return path in self._versioned_dirs
 
997
 
 
998
    def _load_dirs(self):
 
999
        if self._lock_mode is None:
 
1000
            raise errors.ObjectNotLocked(self)
 
1001
        self._versioned_dirs = set()
 
1002
        # TODO(jelmer): Browse over all indexes
 
1003
        for p, i in self._recurse_index_entries():
 
1004
            self._ensure_versioned_dir(posixpath.dirname(p))
 
1005
 
 
1006
    def _ensure_versioned_dir(self, dirname):
 
1007
        if not isinstance(dirname, bytes):
 
1008
            raise TypeError(dirname)
 
1009
        if dirname in self._versioned_dirs:
 
1010
            return
 
1011
        if dirname != b"":
 
1012
            self._ensure_versioned_dir(posixpath.dirname(dirname))
 
1013
        self._versioned_dirs.add(dirname)
 
1014
 
 
1015
    def path2id(self, path):
 
1016
        with self.lock_read():
 
1017
            path = path.rstrip('/')
 
1018
            if self.is_versioned(path.rstrip('/')):
 
1019
                return self.mapping.generate_file_id(
 
1020
                    osutils.safe_unicode(path))
 
1021
            return None
 
1022
 
 
1023
    def has_id(self, file_id):
 
1024
        raise errors.UnsupportedOperation(self.has_id, self)
 
1025
 
 
1026
    def id2path(self, file_id):
 
1027
        if file_id is None:
 
1028
            return ''
 
1029
        if type(file_id) is not bytes:
 
1030
            raise TypeError(file_id)
 
1031
        with self.lock_read():
 
1032
            try:
 
1033
                path = self.mapping.parse_file_id(file_id)
 
1034
            except ValueError:
 
1035
                raise errors.NoSuchId(self, file_id)
 
1036
            if self.is_versioned(path):
 
1037
                return path
 
1038
            raise errors.NoSuchId(self, file_id)
 
1039
 
 
1040
    def _set_root_id(self, file_id):
 
1041
        raise errors.UnsupportedOperation(self._set_root_id, self)
 
1042
 
 
1043
    def _add(self, files, ids, kinds):
 
1044
        for (path, file_id, kind) in zip(files, ids, kinds):
 
1045
            if file_id is not None:
 
1046
                raise workingtree.SettingFileIdUnsupported()
 
1047
            path, can_access = osutils.normalized_filename(path)
 
1048
            if not can_access:
 
1049
                raise errors.InvalidNormalization(path)
 
1050
            self._index_add_entry(path, kind)
 
1051
 
 
1052
    def _read_submodule_head(self, path):
 
1053
        raise NotImplementedError(self._read_submodule_head)
 
1054
 
 
1055
    def _lookup_index(self, encoded_path):
 
1056
        if not isinstance(encoded_path, bytes):
 
1057
            raise TypeError(encoded_path)
 
1058
        # TODO(jelmer): Look in other indexes
 
1059
        return self.index, encoded_path
 
1060
 
 
1061
    def _index_del_entry(self, index, path):
 
1062
        del index[path]
 
1063
        # TODO(jelmer): Keep track of dirty per index
 
1064
        self._index_dirty = True
 
1065
 
 
1066
    def _index_add_entry(self, path, kind, flags=0, reference_revision=None):
 
1067
        if kind == "directory":
 
1068
            # Git indexes don't contain directories
 
1069
            return
 
1070
        if kind == "file":
 
1071
            blob = Blob()
 
1072
            try:
 
1073
                file, stat_val = self.get_file_with_stat(path)
 
1074
            except (errors.NoSuchFile, IOError):
 
1075
                # TODO: Rather than come up with something here, use the old
 
1076
                # index
 
1077
                file = BytesIO()
 
1078
                stat_val = os.stat_result(
 
1079
                    (stat.S_IFREG | 0o644, 0, 0, 0, 0, 0, 0, 0, 0, 0))
 
1080
            with file:
 
1081
                blob.set_raw_string(file.read())
 
1082
            # Add object to the repository if it didn't exist yet
 
1083
            if blob.id not in self.store:
 
1084
                self.store.add_object(blob)
 
1085
            hexsha = blob.id
 
1086
        elif kind == "symlink":
 
1087
            blob = Blob()
 
1088
            try:
 
1089
                stat_val = self._lstat(path)
 
1090
            except EnvironmentError:
 
1091
                # TODO: Rather than come up with something here, use the
 
1092
                # old index
 
1093
                stat_val = os.stat_result(
 
1094
                    (stat.S_IFLNK, 0, 0, 0, 0, 0, 0, 0, 0, 0))
 
1095
            blob.set_raw_string(
 
1096
                self.get_symlink_target(path).encode("utf-8"))
 
1097
            # Add object to the repository if it didn't exist yet
 
1098
            if blob.id not in self.store:
 
1099
                self.store.add_object(blob)
 
1100
            hexsha = blob.id
 
1101
        elif kind == "tree-reference":
 
1102
            if reference_revision is not None:
 
1103
                hexsha = self.branch.lookup_bzr_revision_id(
 
1104
                    reference_revision)[0]
 
1105
            else:
 
1106
                hexsha = self._read_submodule_head(path)
 
1107
                if hexsha is None:
 
1108
                    raise errors.NoCommits(path)
 
1109
            try:
 
1110
                stat_val = self._lstat(path)
 
1111
            except EnvironmentError:
 
1112
                stat_val = os.stat_result(
 
1113
                    (S_IFGITLINK, 0, 0, 0, 0, 0, 0, 0, 0, 0))
 
1114
            stat_val = os.stat_result((S_IFGITLINK, ) + stat_val[1:])
 
1115
        else:
 
1116
            raise AssertionError("unknown kind '%s'" % kind)
 
1117
        # Add an entry to the index or update the existing entry
 
1118
        ensure_normalized_path(path)
 
1119
        encoded_path = path.encode("utf-8")
 
1120
        if b'\r' in encoded_path or b'\n' in encoded_path:
 
1121
            # TODO(jelmer): Why do we need to do this?
 
1122
            trace.mutter('ignoring path with invalid newline in it: %r', path)
 
1123
            return
 
1124
        (index, index_path) = self._lookup_index(encoded_path)
 
1125
        index[index_path] = index_entry_from_stat(stat_val, hexsha, flags)
 
1126
        self._index_dirty = True
 
1127
        if self._versioned_dirs is not None:
 
1128
            self._ensure_versioned_dir(index_path)
 
1129
 
 
1130
    def _recurse_index_entries(self, index=None, basepath=b""):
 
1131
        # Iterate over all index entries
 
1132
        with self.lock_read():
 
1133
            if index is None:
 
1134
                index = self.index
 
1135
            for path, value in index.items():
 
1136
                yield (posixpath.join(basepath, path), value)
 
1137
                (ctime, mtime, dev, ino, mode, uid, gid, size, sha,
 
1138
                 flags) = value
 
1139
                if S_ISGITLINK(mode):
 
1140
                    pass  # TODO(jelmer): dive into submodule
 
1141
 
 
1142
    def iter_entries_by_dir(self, specific_files=None, yield_parents=False):
 
1143
        if yield_parents:
 
1144
            raise NotImplementedError(self.iter_entries_by_dir)
 
1145
        with self.lock_read():
 
1146
            if specific_files is not None:
 
1147
                specific_files = set(specific_files)
 
1148
            else:
 
1149
                specific_files = None
 
1150
            root_ie = self._get_dir_ie(u"", None)
 
1151
            ret = {}
 
1152
            if specific_files is None or u"" in specific_files:
 
1153
                ret[(u"", u"")] = root_ie
 
1154
            dir_ids = {u"": root_ie.file_id}
 
1155
            for path, value in self._recurse_index_entries():
 
1156
                if self.mapping.is_special_file(path):
 
1157
                    continue
 
1158
                path = path.decode("utf-8")
 
1159
                if specific_files is not None and path not in specific_files:
 
1160
                    continue
 
1161
                (parent, name) = posixpath.split(path)
 
1162
                try:
 
1163
                    file_ie = self._get_file_ie(name, path, value, None)
 
1164
                except errors.NoSuchFile:
 
1165
                    continue
 
1166
                if yield_parents or specific_files is None:
 
1167
                    for (dir_path, dir_ie) in self._add_missing_parent_ids(
 
1168
                            parent, dir_ids):
 
1169
                        ret[(posixpath.dirname(dir_path), dir_path)] = dir_ie
 
1170
                file_ie.parent_id = self.path2id(parent)
 
1171
                ret[(posixpath.dirname(path), path)] = file_ie
 
1172
            return ((path, ie) for ((_, path), ie) in sorted(viewitems(ret)))
 
1173
 
 
1174
    def iter_references(self):
 
1175
        # TODO(jelmer): Implement a more efficient version of this
 
1176
        for path, entry in self.iter_entries_by_dir():
 
1177
            if entry.kind == 'tree-reference':
 
1178
                yield path
 
1179
 
 
1180
    def _get_dir_ie(self, path, parent_id):
 
1181
        file_id = self.path2id(path)
 
1182
        return GitTreeDirectory(file_id,
 
1183
                                posixpath.basename(path).strip("/"), parent_id)
 
1184
 
 
1185
    def _get_file_ie(self, name, path, value, parent_id):
 
1186
        if not isinstance(name, text_type):
 
1187
            raise TypeError(name)
 
1188
        if not isinstance(path, text_type):
 
1189
            raise TypeError(path)
 
1190
        if not isinstance(value, tuple) or len(value) != 10:
 
1191
            raise TypeError(value)
 
1192
        (ctime, mtime, dev, ino, mode, uid, gid, size, sha, flags) = value
 
1193
        file_id = self.path2id(path)
 
1194
        if not isinstance(file_id, bytes):
 
1195
            raise TypeError(file_id)
 
1196
        kind = mode_kind(mode)
 
1197
        ie = entry_factory[kind](file_id, name, parent_id)
 
1198
        if kind == 'symlink':
 
1199
            ie.symlink_target = self.get_symlink_target(path)
 
1200
        elif kind == 'tree-reference':
 
1201
            ie.reference_revision = self.get_reference_revision(path)
 
1202
        else:
 
1203
            try:
 
1204
                data = self.get_file_text(path)
 
1205
            except errors.NoSuchFile:
 
1206
                data = None
 
1207
            except IOError as e:
 
1208
                if e.errno != errno.ENOENT:
 
1209
                    raise
 
1210
                data = None
 
1211
            if data is None:
 
1212
                data = self.branch.repository._git.object_store[sha].data
 
1213
            ie.text_sha1 = osutils.sha_string(data)
 
1214
            ie.text_size = len(data)
 
1215
            ie.executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
 
1216
        return ie
 
1217
 
 
1218
    def _add_missing_parent_ids(self, path, dir_ids):
 
1219
        if path in dir_ids:
 
1220
            return []
 
1221
        parent = posixpath.dirname(path).strip("/")
 
1222
        ret = self._add_missing_parent_ids(parent, dir_ids)
 
1223
        parent_id = dir_ids[parent]
 
1224
        ie = self._get_dir_ie(path, parent_id)
 
1225
        dir_ids[path] = ie.file_id
 
1226
        ret.append((path, ie))
 
1227
        return ret
 
1228
 
 
1229
    def _comparison_data(self, entry, path):
 
1230
        if entry is None:
 
1231
            return None, False, None
 
1232
        return entry.kind, entry.executable, None
 
1233
 
 
1234
    def _unversion_path(self, path):
 
1235
        if self._lock_mode is None:
 
1236
            raise errors.ObjectNotLocked(self)
 
1237
        encoded_path = path.encode("utf-8")
 
1238
        count = 0
 
1239
        (index, subpath) = self._lookup_index(encoded_path)
 
1240
        try:
 
1241
            self._index_del_entry(index, encoded_path)
 
1242
        except KeyError:
 
1243
            # A directory, perhaps?
 
1244
            # TODO(jelmer): Deletes that involve submodules?
 
1245
            for p in list(index):
 
1246
                if p.startswith(subpath + b"/"):
 
1247
                    count += 1
 
1248
                    self._index_del_entry(index, p)
 
1249
        else:
 
1250
            count = 1
 
1251
        self._versioned_dirs = None
 
1252
        return count
 
1253
 
 
1254
    def unversion(self, paths):
 
1255
        with self.lock_tree_write():
 
1256
            for path in paths:
 
1257
                if self._unversion_path(path) == 0:
 
1258
                    raise errors.NoSuchFile(path)
 
1259
            self._versioned_dirs = None
 
1260
            self.flush()
 
1261
 
 
1262
    def flush(self):
 
1263
        pass
 
1264
 
 
1265
    def update_basis_by_delta(self, revid, delta):
 
1266
        # TODO(jelmer): This shouldn't be called, it's inventory specific.
 
1267
        for (old_path, new_path, file_id, ie) in delta:
 
1268
            if old_path is not None:
 
1269
                (index, old_subpath) = self._lookup_index(
 
1270
                    old_path.encode('utf-8'))
 
1271
                if old_subpath in index:
 
1272
                    self._index_del_entry(index, old_subpath)
 
1273
                    self._versioned_dirs = None
 
1274
            if new_path is not None and ie.kind != 'directory':
 
1275
                self._index_add_entry(new_path, ie.kind)
 
1276
        self.flush()
 
1277
        self._set_merges_from_parent_ids([])
 
1278
 
 
1279
    def move(self, from_paths, to_dir=None, after=None):
 
1280
        rename_tuples = []
 
1281
        with self.lock_tree_write():
 
1282
            to_abs = self.abspath(to_dir)
 
1283
            if not os.path.isdir(to_abs):
 
1284
                raise errors.BzrMoveFailedError('', to_dir,
 
1285
                                                errors.NotADirectory(to_abs))
 
1286
 
 
1287
            for from_rel in from_paths:
 
1288
                from_tail = os.path.split(from_rel)[-1]
 
1289
                to_rel = os.path.join(to_dir, from_tail)
 
1290
                self.rename_one(from_rel, to_rel, after=after)
 
1291
                rename_tuples.append((from_rel, to_rel))
 
1292
            self.flush()
 
1293
            return rename_tuples
 
1294
 
 
1295
    def rename_one(self, from_rel, to_rel, after=None):
 
1296
        from_path = from_rel.encode("utf-8")
 
1297
        to_rel, can_access = osutils.normalized_filename(to_rel)
 
1298
        if not can_access:
 
1299
            raise errors.InvalidNormalization(to_rel)
 
1300
        to_path = to_rel.encode("utf-8")
 
1301
        with self.lock_tree_write():
 
1302
            if not after:
 
1303
                # Perhaps it's already moved?
 
1304
                after = (
 
1305
                    not self.has_filename(from_rel) and
 
1306
                    self.has_filename(to_rel) and
 
1307
                    not self.is_versioned(to_rel))
 
1308
            if after:
 
1309
                if not self.has_filename(to_rel):
 
1310
                    raise errors.BzrMoveFailedError(
 
1311
                        from_rel, to_rel, errors.NoSuchFile(to_rel))
 
1312
                if self.basis_tree().is_versioned(to_rel):
 
1313
                    raise errors.BzrMoveFailedError(
 
1314
                        from_rel, to_rel, errors.AlreadyVersionedError(to_rel))
 
1315
 
 
1316
                kind = self.kind(to_rel)
 
1317
            else:
 
1318
                try:
 
1319
                    to_kind = self.kind(to_rel)
 
1320
                except errors.NoSuchFile:
 
1321
                    exc_type = errors.BzrRenameFailedError
 
1322
                    to_kind = None
 
1323
                else:
 
1324
                    exc_type = errors.BzrMoveFailedError
 
1325
                if self.is_versioned(to_rel):
 
1326
                    raise exc_type(from_rel, to_rel,
 
1327
                                   errors.AlreadyVersionedError(to_rel))
 
1328
                if not self.has_filename(from_rel):
 
1329
                    raise errors.BzrMoveFailedError(
 
1330
                        from_rel, to_rel, errors.NoSuchFile(from_rel))
 
1331
                kind = self.kind(from_rel)
 
1332
                if not self.is_versioned(from_rel) and kind != 'directory':
 
1333
                    raise exc_type(from_rel, to_rel,
 
1334
                                   errors.NotVersionedError(from_rel))
 
1335
                if self.has_filename(to_rel):
 
1336
                    raise errors.RenameFailedFilesExist(
 
1337
                        from_rel, to_rel, errors.FileExists(to_rel))
 
1338
 
 
1339
                kind = self.kind(from_rel)
 
1340
 
 
1341
            if not after and kind != 'directory':
 
1342
                (index, from_subpath) = self._lookup_index(from_path)
 
1343
                if from_subpath not in index:
 
1344
                    # It's not a file
 
1345
                    raise errors.BzrMoveFailedError(
 
1346
                        from_rel, to_rel,
 
1347
                        errors.NotVersionedError(path=from_rel))
 
1348
 
 
1349
            if not after:
 
1350
                try:
 
1351
                    self._rename_one(from_rel, to_rel)
 
1352
                except OSError as e:
 
1353
                    if e.errno == errno.ENOENT:
 
1354
                        raise errors.BzrMoveFailedError(
 
1355
                            from_rel, to_rel, errors.NoSuchFile(to_rel))
 
1356
                    raise
 
1357
            if kind != 'directory':
 
1358
                (index, from_index_path) = self._lookup_index(from_path)
 
1359
                try:
 
1360
                    self._index_del_entry(index, from_path)
 
1361
                except KeyError:
 
1362
                    pass
 
1363
                self._index_add_entry(to_rel, kind)
 
1364
            else:
 
1365
                todo = [(p, i) for (p, i) in self._recurse_index_entries()
 
1366
                        if p.startswith(from_path + b'/')]
 
1367
                for child_path, child_value in todo:
 
1368
                    (child_to_index, child_to_index_path) = self._lookup_index(
 
1369
                        posixpath.join(to_path, posixpath.relpath(child_path, from_path)))
 
1370
                    child_to_index[child_to_index_path] = child_value
 
1371
                    # TODO(jelmer): Mark individual index as dirty
 
1372
                    self._index_dirty = True
 
1373
                    (child_from_index, child_from_index_path) = self._lookup_index(
 
1374
                        child_path)
 
1375
                    self._index_del_entry(
 
1376
                        child_from_index, child_from_index_path)
 
1377
 
 
1378
            self._versioned_dirs = None
 
1379
            self.flush()
 
1380
 
 
1381
    def find_related_paths_across_trees(self, paths, trees=[],
 
1382
                                        require_versioned=True):
 
1383
        if paths is None:
 
1384
            return None
 
1385
 
 
1386
        if require_versioned:
 
1387
            trees = [self] + (trees if trees is not None else [])
 
1388
            unversioned = set()
 
1389
            for p in paths:
 
1390
                for t in trees:
 
1391
                    if t.is_versioned(p):
 
1392
                        break
 
1393
                else:
 
1394
                    unversioned.add(p)
 
1395
            if unversioned:
 
1396
                raise errors.PathsNotVersionedError(unversioned)
 
1397
 
 
1398
        return filter(self.is_versioned, paths)
 
1399
 
 
1400
    def path_content_summary(self, path):
 
1401
        """See Tree.path_content_summary."""
 
1402
        try:
 
1403
            stat_result = self._lstat(path)
 
1404
        except OSError as e:
 
1405
            if getattr(e, 'errno', None) == errno.ENOENT:
 
1406
                # no file.
 
1407
                return ('missing', None, None, None)
 
1408
            # propagate other errors
 
1409
            raise
 
1410
        kind = mode_kind(stat_result.st_mode)
 
1411
        if kind == 'file':
 
1412
            return self._file_content_summary(path, stat_result)
 
1413
        elif kind == 'directory':
 
1414
            # perhaps it looks like a plain directory, but it's really a
 
1415
            # reference.
 
1416
            if self._directory_is_tree_reference(path):
 
1417
                kind = 'tree-reference'
 
1418
            return kind, None, None, None
 
1419
        elif kind == 'symlink':
 
1420
            target = osutils.readlink(self.abspath(path))
 
1421
            return ('symlink', None, None, target)
 
1422
        else:
 
1423
            return (kind, None, None, None)
 
1424
 
 
1425
    def kind(self, relpath):
 
1426
        kind = osutils.file_kind(self.abspath(relpath))
 
1427
        if kind == 'directory':
 
1428
            (index, index_path) = self._lookup_index(relpath.encode('utf-8'))
 
1429
            if index is None:
 
1430
                return kind
 
1431
            try:
 
1432
                mode = index[index_path].mode
 
1433
            except KeyError:
 
1434
                return kind
 
1435
            else:
 
1436
                if S_ISGITLINK(mode):
 
1437
                    return 'tree-reference'
 
1438
                return 'directory'
 
1439
        else:
 
1440
            return kind
 
1441
 
 
1442
    def _live_entry(self, relpath):
 
1443
        raise NotImplementedError(self._live_entry)
 
1444
 
 
1445
    def get_transform(self, pb=None):
 
1446
        from ..transform import TreeTransform
 
1447
        return TreeTransform(self, pb=pb)
 
1448
 
 
1449
 
 
1450
 
 
1451
class InterIndexGitTree(InterGitTrees):
 
1452
    """InterTree that works between a Git revision tree and an index."""
 
1453
 
 
1454
    def __init__(self, source, target):
 
1455
        super(InterIndexGitTree, self).__init__(source, target)
 
1456
        self._index = target.index
 
1457
 
 
1458
    @classmethod
 
1459
    def is_compatible(cls, source, target):
 
1460
        return (isinstance(source, GitRevisionTree) and
 
1461
                isinstance(target, MutableGitIndexTree))
 
1462
 
 
1463
    def _iter_git_changes(self, want_unchanged=False, specific_files=None,
 
1464
                          require_versioned=False, extra_trees=None,
 
1465
                          want_unversioned=False):
 
1466
        trees = [self.source]
 
1467
        if extra_trees is not None:
 
1468
            trees.extend(extra_trees)
 
1469
        if specific_files is not None:
 
1470
            specific_files = self.target.find_related_paths_across_trees(
 
1471
                specific_files, trees,
 
1472
                require_versioned=require_versioned)
 
1473
        # TODO(jelmer): Restrict to specific_files, for performance reasons.
 
1474
        with self.lock_read():
 
1475
            return changes_between_git_tree_and_working_copy(
 
1476
                self.source.store, self.source.tree,
 
1477
                self.target, want_unchanged=want_unchanged,
 
1478
                want_unversioned=want_unversioned)
 
1479
 
 
1480
 
 
1481
_mod_tree.InterTree.register_optimiser(InterIndexGitTree)
 
1482
 
 
1483
 
 
1484
def changes_between_git_tree_and_working_copy(store, from_tree_sha, target,
 
1485
                                              want_unchanged=False,
 
1486
                                              want_unversioned=False):
 
1487
    """Determine the changes between a git tree and a working tree with index.
 
1488
 
 
1489
    """
 
1490
    extras = set()
 
1491
    blobs = {}
 
1492
    # Report dirified directories to commit_tree first, so that they can be
 
1493
    # replaced with non-empty directories if they have contents.
 
1494
    dirified = []
 
1495
    trust_executable = target._supports_executable()
 
1496
    for path, index_entry in target._recurse_index_entries():
 
1497
        try:
 
1498
            live_entry = target._live_entry(path)
 
1499
        except EnvironmentError as e:
 
1500
            if e.errno == errno.ENOENT:
 
1501
                # Entry was removed; keep it listed, but mark it as gone.
 
1502
                blobs[path] = (ZERO_SHA, 0)
 
1503
            elif e.errno == errno.EISDIR:
 
1504
                # Backwards compatibility with Dulwich < 0.19.12;
 
1505
                # newer versions of Dulwich return either an entry for the
 
1506
                # submodule or None for directories.
 
1507
                if S_ISGITLINK(index_entry.mode):
 
1508
                    blobs[path] = (index_entry.sha, index_entry.mode)
 
1509
                else:
 
1510
                    # Entry was turned into a directory
 
1511
                    dirified.append((path, Tree().id, stat.S_IFDIR))
 
1512
                    store.add_object(Tree())
 
1513
            else:
 
1514
                raise
 
1515
        else:
 
1516
            if live_entry is None:
 
1517
                # Entry was turned into a directory
 
1518
                dirified.append((path, Tree().id, stat.S_IFDIR))
 
1519
                store.add_object(Tree())
 
1520
            else:
 
1521
                mode = live_entry.mode
 
1522
                if not trust_executable:
 
1523
                    if mode_is_executable(index_entry.mode):
 
1524
                        mode |= 0o111
 
1525
                    else:
 
1526
                        mode &= ~0o111
 
1527
                blobs[path] = (live_entry.sha, cleanup_mode(live_entry.mode))
 
1528
    if want_unversioned:
 
1529
        for e in target.extras():
 
1530
            st = target._lstat(e)
 
1531
            try:
 
1532
                np, accessible = osutils.normalized_filename(e)
 
1533
            except UnicodeDecodeError:
 
1534
                raise errors.BadFilenameEncoding(
 
1535
                    e, osutils._fs_enc)
 
1536
            if stat.S_ISDIR(st.st_mode):
 
1537
                blob = Tree()
 
1538
            else:
 
1539
                blob = blob_from_path_and_stat(
 
1540
                    target.abspath(e).encode(osutils._fs_enc), st)
 
1541
            store.add_object(blob)
 
1542
            np = np.encode('utf-8')
 
1543
            blobs[np] = (blob.id, cleanup_mode(st.st_mode))
 
1544
            extras.add(np)
 
1545
    to_tree_sha = commit_tree(
 
1546
        store, dirified + [(p, s, m) for (p, (s, m)) in blobs.items()])
 
1547
    return store.tree_changes(
 
1548
        from_tree_sha, to_tree_sha, include_trees=True,
 
1549
        want_unchanged=want_unchanged, change_type_same=True), extras