1
# Copyright (C) 2008-2011 Jelmer Vernooij <jelmer@samba.org>
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.
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.
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
"""An adapter between a Git index and a Bazaar Working Tree"""
21
from cStringIO import (
24
from collections import defaultdict
26
from dulwich.index import (
29
from dulwich.object_store import (
32
from dulwich.objects import (
43
conflicts as _mod_conflicts,
54
from bzrlib.decorators import (
57
from bzrlib.mutabletree import needs_tree_write_lock
60
from bzrlib.plugins.git.dir import (
63
from bzrlib.plugins.git.tree import (
64
changes_from_git_changes,
65
tree_delta_from_git_changes,
67
from bzrlib.plugins.git.mapping import (
72
IGNORE_FILENAME = ".gitignore"
75
class GitWorkingTree(workingtree.WorkingTree):
76
"""A Git working tree."""
78
def __init__(self, bzrdir, repo, branch, index):
79
self.basedir = bzrdir.root_transport.local_abspath('.')
81
self.repository = repo
82
self.store = self.repository._git.object_store
83
self.mapping = self.repository.get_mapping()
85
self._transport = bzrdir.transport
87
self.controldir = self.bzrdir.transport.local_abspath('bzr')
90
os.makedirs(self.controldir)
91
os.makedirs(os.path.join(self.controldir, 'lock'))
95
self._control_files = lockable_files.LockableFiles(
96
transport.get_transport(self.controldir), 'lock', lockdir.LockDir)
97
self._format = GitWorkingTreeFormat()
99
self._versioned_dirs = None
100
self.views = self._make_views()
101
self._rules_searcher = None
102
self._detect_case_handling()
104
self._fileid_map = self._basis_fileid_map.copy()
106
def _detect_case_handling(self):
108
self._transport.stat(".git/cOnFiG")
109
except errors.NoSuchFile:
110
self.case_sensitive = True
112
self.case_sensitive = False
114
def merge_modified(self):
117
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
118
self.set_parent_ids([p for p, t in parents_list])
120
def _index_add_entry(self, path, file_id, kind):
121
assert isinstance(path, basestring)
122
assert type(file_id) == str or file_id is None
123
if kind == "directory":
124
# Git indexes don't contain directories
129
file, stat_val = self.get_file_with_stat(file_id, path)
130
except (errors.NoSuchFile, IOError):
131
# TODO: Rather than come up with something here, use the old index
133
stat_val = os.stat_result(
134
(stat.S_IFREG | 0644, 0, 0, 0, 0, 0, 0, 0, 0, 0))
135
blob.set_raw_string(file.read())
136
elif kind == "symlink":
139
stat_val = os.lstat(self.abspath(path))
140
except (errors.NoSuchFile, OSError):
141
# TODO: Rather than come up with something here, use the
143
stat_val = os.stat_result(
144
(stat.S_IFLNK, 0, 0, 0, 0, 0, 0, 0, 0, 0))
146
self.get_symlink_target(file_id, path).encode("utf-8"))
148
raise AssertionError("unknown kind '%s'" % kind)
149
# Add object to the repository if it didn't exist yet
150
if not blob.id in self.store:
151
self.store.add_object(blob)
152
# Add an entry to the index or update the existing entry
154
encoded_path = path.encode("utf-8")
155
self.index[encoded_path] = (stat_val.st_ctime,
156
stat_val.st_mtime, stat_val.st_dev, stat_val.st_ino,
157
stat_val.st_mode, stat_val.st_uid, stat_val.st_gid,
158
stat_val.st_size, blob.id, flags)
159
if self._versioned_dirs is not None:
160
self._ensure_versioned_dir(encoded_path)
162
def _ensure_versioned_dir(self, dirname):
163
if dirname in self._versioned_dirs:
166
self._ensure_versioned_dir(posixpath.dirname(dirname))
167
self._versioned_dirs.add(dirname)
169
def _load_dirs(self):
170
self._versioned_dirs = set()
172
self._ensure_versioned_dir(posixpath.dirname(p))
174
def _unversion_path(self, path):
175
encoded_path = path.encode("utf-8")
177
del self.index[encoded_path]
179
# A directory, perhaps?
180
for p in list(self.index):
181
if p.startswith(encoded_path+"/"):
183
# FIXME: remove empty directories
185
@needs_tree_write_lock
186
def unversion(self, file_ids):
187
for file_id in file_ids:
188
path = self.id2path(file_id)
189
self._unversion_path(path)
192
def check_state(self):
193
"""Check that the working state is/isn't valid."""
196
@needs_tree_write_lock
197
def remove(self, files, verbose=False, to_file=None, keep_files=True,
199
"""Remove nominated files from the working tree metadata.
201
:param files: File paths relative to the basedir.
202
:param keep_files: If true, the files will also be kept.
203
:param force: Delete files and directories, even if they are changed
204
and even if the directories are not empty.
206
all_files = set() # specified and nested files
208
if isinstance(files, basestring):
214
files = list(all_files)
217
return # nothing to do
219
# Sort needed to first handle directory content before the directory
220
files.sort(reverse=True)
222
def backup(file_to_backup):
223
abs_path = self.abspath(file_to_backup)
224
backup_name = self.bzrdir._available_backup_name(file_to_backup)
225
osutils.rename(abs_path, self.abspath(backup_name))
226
return "removed %s (but kept a copy: %s)" % (
227
file_to_backup, backup_name)
230
fid = self.path2id(f)
232
message = "%s is not versioned." % (f,)
234
abs_path = self.abspath(f)
236
# having removed it, it must be either ignored or unknown
237
if self.is_ignored(f):
241
# XXX: Really should be a more abstract reporter interface
242
kind_ch = osutils.kind_marker(self.kind(fid))
243
to_file.write(new_status + ' ' + f + kind_ch + '\n')
245
# FIXME: _unversion_path() is O(size-of-index) for directories
246
self._unversion_path(f)
247
message = "removed %s" % (f,)
248
if osutils.lexists(abs_path):
249
if (osutils.isdir(abs_path) and
250
len(os.listdir(abs_path)) > 0):
252
osutils.rmtree(abs_path)
253
message = "deleted %s" % (f,)
258
osutils.delete_any(abs_path)
259
message = "deleted %s" % (f,)
261
# print only one message (if any) per file.
262
if message is not None:
266
def _add(self, files, ids, kinds):
267
for (path, file_id, kind) in zip(files, ids, kinds):
268
if file_id is not None:
269
self._fileid_map.set_file_id(path.encode("utf-8"), file_id)
271
file_id = self._fileid_map.lookup_file_id(path.encode("utf-8"))
272
self._index_add_entry(path, file_id, kind)
274
@needs_tree_write_lock
275
def smart_add(self, file_list, recurse=True, action=None, save=True):
279
for filepath in osutils.canonical_relpaths(self.basedir, file_list):
280
abspath = self.abspath(filepath)
281
kind = osutils.file_kind(abspath)
282
if action is not None:
283
file_id = action(self, None, filepath, kind)
286
if kind in ("file", "symlink"):
288
self._index_add_entry(filepath, file_id, kind)
289
added.append(filepath)
290
elif kind == "directory":
292
user_dirs.append(filepath)
294
raise errors.BadFileKindError(filename=abspath, kind=kind)
295
for user_dir in user_dirs:
296
abs_user_dir = self.abspath(user_dir)
297
for name in os.listdir(abs_user_dir):
298
subp = os.path.join(user_dir, name)
299
if self.is_control_filename(subp) or self.mapping.is_special_file(subp):
301
ignore_glob = self.is_ignored(subp)
302
if ignore_glob is not None:
303
ignored.setdefault(ignore_glob, []).append(subp)
305
abspath = self.abspath(subp)
306
kind = osutils.file_kind(abspath)
307
if kind == "directory":
308
user_dirs.append(subp)
310
if action is not None:
315
self._index_add_entry(subp, file_id, kind)
318
return added, ignored
320
def _set_root_id(self, file_id):
321
self._fileid_map.set_file_id("", file_id)
323
@needs_tree_write_lock
324
def move(self, from_paths, to_dir=None, after=False):
326
to_abs = self.abspath(to_dir)
327
if not os.path.isdir(to_abs):
328
raise errors.BzrMoveFailedError('', to_dir,
329
errors.NotADirectory(to_abs))
331
for from_rel in from_paths:
332
from_tail = os.path.split(from_rel)[-1]
333
to_rel = os.path.join(to_dir, from_tail)
334
self.rename_one(from_rel, to_rel, after=after)
335
rename_tuples.append((from_rel, to_rel))
339
@needs_tree_write_lock
340
def rename_one(self, from_rel, to_rel, after=False):
341
from_path = from_rel.encode("utf-8")
342
to_path = to_rel.encode("utf-8")
343
if not self.has_filename(to_rel):
344
raise errors.BzrMoveFailedError(from_rel, to_rel,
345
errors.NoSuchFile(to_rel))
346
if not from_path in self.index:
347
raise errors.BzrMoveFailedError(from_rel, to_rel,
348
errors.NotVersionedError(path=from_rel))
350
os.rename(self.abspath(from_rel), self.abspath(to_rel))
351
self.index[to_path] = self.index[from_path]
352
del self.index[from_path]
355
def get_root_id(self):
356
return self.path2id("")
358
def _has_dir(self, path):
361
if self._versioned_dirs is None:
363
return path in self._versioned_dirs
366
def path2id(self, path):
367
encoded_path = path.encode("utf-8")
368
if self._is_versioned(encoded_path):
369
return self._fileid_map.lookup_file_id(encoded_path)
372
def _iter_files_recursive(self, from_dir=None):
375
for (dirpath, dirnames, filenames) in os.walk(self.abspath(from_dir)):
376
dir_relpath = dirpath[len(self.basedir):].strip("/")
377
if self.bzrdir.is_control_filename(dir_relpath):
379
for filename in filenames:
380
if not self.mapping.is_special_file(filename):
381
yield os.path.join(dir_relpath, filename)
384
"""Yield all unversioned files in this WorkingTree.
386
return set(self._iter_files_recursive()) - set(self.index)
389
# non-implementation specific cleanup
392
# reverse order of locking.
394
return self._control_files.unlock()
399
# TODO: Maybe this should only write on dirty ?
400
if self._control_files._lock_mode != 'w':
401
raise errors.NotWriteLocked(self)
405
for path in self.index:
406
yield self.path2id(path)
408
for path in self._versioned_dirs:
409
yield self.path2id(path)
411
def has_or_had_id(self, file_id):
412
if self.has_id(file_id):
414
if self.had_id(file_id):
418
def had_id(self, file_id):
419
path = self._basis_fileid_map.lookup_file_id(file_id)
421
head = self.repository._git.head()
423
# Assume no if basis is not accessible
427
root_tree = self.store[head].tree
429
tree_lookup_path(self.store.__getitem__, root_tree, path)
435
def has_id(self, file_id):
437
self.id2path(file_id)
438
except errors.NoSuchId:
443
def id2path(self, file_id):
444
if type(file_id) != str:
446
path = self._fileid_map.lookup_path(file_id)
447
# FIXME: What about directories?
448
if self._is_versioned(path):
449
return path.decode("utf-8")
450
raise errors.NoSuchId(self, file_id)
452
def get_file_mtime(self, file_id, path=None):
453
"""See Tree.get_file_mtime."""
455
path = self.id2path(file_id)
456
return os.lstat(self.abspath(path)).st_mtime
458
def get_ignore_list(self):
459
ignoreset = getattr(self, '_ignoreset', None)
460
if ignoreset is not None:
464
ignore_globs.update(ignores.get_runtime_ignores())
465
ignore_globs.update(ignores.get_user_ignores())
466
if self.has_filename(IGNORE_FILENAME):
467
f = self.get_file_byname(IGNORE_FILENAME)
469
# FIXME: Parse git file format, rather than assuming it's
470
# the same as for bzr's native formats.
471
ignore_globs.update(ignores.parse_ignore_file(f))
474
self._ignoreset = ignore_globs
477
def set_last_revision(self, revid):
478
self._change_last_revision(revid)
480
def _reset_data(self):
482
head = self.repository._git.head()
483
except KeyError, name:
484
raise errors.NotBranchError("branch %s at %s" % (name,
485
self.repository.base))
487
self._basis_fileid_map = GitFileIdMap({}, self.mapping)
489
self._basis_fileid_map = self.mapping.get_fileid_map(
490
self.store.__getitem__, self.store[head].tree)
493
def get_file_verifier(self, file_id, path=None, stat_value=None):
495
path = self.id2path(file_id)
496
return ("GIT", self.index[path][-2])
499
def get_file_sha1(self, file_id, path=None, stat_value=None):
501
path = self.id2path(file_id)
502
abspath = self.abspath(path).encode(osutils._fs_enc)
504
return osutils.sha_file_by_name(abspath)
505
except OSError, (num, msg):
506
if num in (errno.EISDIR, errno.ENOENT):
510
def revision_tree(self, revid):
511
return self.repository.revision_tree(revid)
513
def _is_versioned(self, path):
514
return (path in self.index or self._has_dir(path))
516
def filter_unversioned_files(self, files):
517
return set([p for p in files if not self._is_versioned(p.encode("utf-8"))])
519
def _get_dir_ie(self, path, parent_id):
520
file_id = self.path2id(path)
521
return inventory.InventoryDirectory(file_id,
522
posixpath.basename(path).strip("/"), parent_id)
524
def _add_missing_parent_ids(self, path, dir_ids):
527
parent = posixpath.dirname(path).strip("/")
528
ret = self._add_missing_parent_ids(parent, dir_ids)
529
parent_id = dir_ids[parent]
530
ie = self._get_dir_ie(path, parent_id)
531
dir_ids[path] = ie.file_id
532
ret.append((path, ie))
535
def _get_file_ie(self, name, path, value, parent_id):
536
assert isinstance(name, unicode)
537
assert isinstance(path, unicode)
538
assert isinstance(value, tuple) and len(value) == 10
539
(ctime, mtime, dev, ino, mode, uid, gid, size, sha, flags) = value
540
file_id = self.path2id(path)
541
if type(file_id) != str:
543
kind = mode_kind(mode)
544
ie = inventory.entry_factory[kind](file_id, name, parent_id)
545
if kind == 'symlink':
546
ie.symlink_target = self.get_symlink_target(file_id)
548
data = self.get_file_text(file_id, path)
549
ie.text_sha1 = osutils.sha_string(data)
550
ie.text_size = len(data)
551
ie.executable = self.is_executable(file_id, path)
555
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
556
mode = stat_result.st_mode
557
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
559
def stored_kind(self, file_id, path=None):
561
path = self.id2path(file_id)
563
return mode_kind(self.index[path.encode("utf-8")][4])
565
# Maybe it's a directory?
566
if self._has_dir(path):
568
raise errors.NoSuchId(self, file_id)
570
if not osutils.supports_executable():
571
def is_executable(self, file_id, path=None):
572
basis_tree = self.basis_tree()
573
if file_id in basis_tree:
574
return basis_tree.is_executable(file_id)
575
# Default to not executable
578
def is_executable(self, file_id, path=None):
580
path = self.id2path(file_id)
581
mode = os.lstat(self.abspath(path)).st_mode
582
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
584
_is_executable_from_path_and_stat = \
585
_is_executable_from_path_and_stat_from_stat
587
def list_files(self, include_root=False, from_dir=None, recursive=True):
588
# FIXME: Yield non-versioned files
592
fk_entries = {'directory': workingtree.TreeDirectory,
593
'file': workingtree.TreeFile,
594
'symlink': workingtree.TreeLink}
595
root_ie = self._get_dir_ie(u"", None)
596
if include_root and not from_dir:
597
yield "", "V", root_ie.kind, root_ie.file_id, root_ie
598
dir_ids[u""] = root_ie.file_id
600
path_iterator = self._iter_files_recursive(from_dir)
605
start = os.path.join(self.basedir, from_dir)
606
path_iterator = sorted([os.path.join(from_dir, name) for name in
607
os.listdir(start) if not self.bzrdir.is_control_filename(name)
608
and not self.mapping.is_special_file(name)])
609
for path in path_iterator:
611
value = self.index[path]
614
path = path.decode("utf-8")
615
parent, name = posixpath.split(path)
616
for dir_path, dir_ie in self._add_missing_parent_ids(parent, dir_ids):
617
yield dir_path, "V", dir_ie.kind, dir_ie.file_id, dir_ie
618
if value is not None:
619
ie = self._get_file_ie(name, path, value, dir_ids[parent])
620
yield path, "V", ie.kind, ie.file_id, ie
622
kind = osutils.file_kind(self.abspath(path))
623
ie = fk_entries[kind]()
624
yield path, "?", kind, None, ie
626
def all_file_ids(self):
627
ids = {u"": self.path2id("")}
628
for path in self.index:
629
if self.mapping.is_special_file(path):
631
path = path.decode("utf-8")
632
parent = posixpath.dirname(path).strip("/")
633
for e in self._add_missing_parent_ids(parent, ids):
635
ids[path] = self.path2id(path)
636
return set(ids.values())
638
def _directory_is_tree_reference(self, path):
639
# FIXME: Check .gitsubmodules for path
642
def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
643
# FIXME: Is return order correct?
645
raise NotImplementedError(self.iter_entries_by_dir)
646
if specific_file_ids is not None:
647
specific_paths = [self.id2path(file_id) for file_id in specific_file_ids]
648
if specific_paths in ([u""], []):
649
specific_paths = None
651
specific_paths = set(specific_paths)
653
specific_paths = None
654
root_ie = self._get_dir_ie(u"", None)
655
if specific_paths is None:
657
dir_ids = {u"": root_ie.file_id}
658
for path, value in self.index.iteritems():
659
if self.mapping.is_special_file(path):
661
path = path.decode("utf-8")
662
if specific_paths is not None and not path in specific_paths:
664
(parent, name) = posixpath.split(path)
666
file_ie = self._get_file_ie(name, path, value, None)
669
for (dir_path, dir_ie) in self._add_missing_parent_ids(parent,
671
yield dir_path, dir_ie
672
file_ie.parent_id = self.path2id(parent)
678
return _mod_conflicts.ConflictList()
680
def update_basis_by_delta(self, new_revid, delta):
681
# The index just contains content, which won't have changed.
684
def get_canonical_inventory_path(self, path):
686
if p.lower() == path.lower():
691
def _walkdirs(self, prefix=""):
694
per_dir = defaultdict(list)
695
for path, value in self.index.iteritems():
696
if self.mapping.is_special_file(path):
698
if not path.startswith(prefix):
700
(dirname, child_name) = posixpath.split(path)
701
dirname = dirname.decode("utf-8")
702
dir_file_id = self.path2id(dirname)
703
assert isinstance(value, tuple) and len(value) == 10
704
(ctime, mtime, dev, ino, mode, uid, gid, size, sha, flags) = value
705
stat_result = os.stat_result((mode, ino,
706
dev, 1, uid, gid, size,
708
per_dir[(dirname, dir_file_id)].append(
709
(path.decode("utf-8"), child_name.decode("utf-8"),
710
mode_kind(mode), stat_result,
711
self.path2id(path.decode("utf-8")),
713
return per_dir.iteritems()
716
class GitWorkingTreeFormat(workingtree.WorkingTreeFormat):
718
_tree_class = GitWorkingTree
720
supports_versioned_directories = False
723
def _matchingbzrdir(self):
724
from bzrlib.plugins.git.dir import LocalGitControlDirFormat
725
return LocalGitControlDirFormat()
727
def get_format_description(self):
728
return "Git Working Tree"
730
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
731
accelerator_tree=None, hardlink=False):
732
"""See WorkingTreeFormat.initialize()."""
733
if not isinstance(a_bzrdir, LocalGitDir):
734
raise errors.IncompatibleFormat(self, a_bzrdir)
735
index = Index(a_bzrdir.root_transport.local_abspath(".git/index"))
737
return GitWorkingTree(a_bzrdir, a_bzrdir.open_repository(),
738
a_bzrdir.open_branch(), index)
741
class InterIndexGitTree(tree.InterTree):
742
"""InterTree that works between a Git revision tree and an index."""
744
def __init__(self, source, target):
745
super(InterIndexGitTree, self).__init__(source, target)
746
self._index = target.index
749
def is_compatible(cls, source, target):
750
from bzrlib.plugins.git.repository import GitRevisionTree
751
return (isinstance(source, GitRevisionTree) and
752
isinstance(target, GitWorkingTree))
754
def compare(self, want_unchanged=False, specific_files=None,
755
extra_trees=None, require_versioned=False, include_root=False,
756
want_unversioned=False):
757
changes = self._index.changes_from_tree(
758
self.source.store, self.source.tree,
759
want_unchanged=want_unchanged)
760
source_fileid_map = self.source._fileid_map
761
target_fileid_map = self.target._fileid_map
762
ret = tree_delta_from_git_changes(changes, self.target.mapping,
763
(source_fileid_map, target_fileid_map),
764
specific_file=specific_files, require_versioned=require_versioned)
766
for e in self.target.extras():
767
ret.unversioned.append((e, None,
768
osutils.file_kind(self.target.abspath(e))))
771
def iter_changes(self, include_unchanged=False, specific_files=None,
772
pb=None, extra_trees=[], require_versioned=True,
773
want_unversioned=False):
774
changes = self._index.changes_from_tree(
775
self.source.store, self.source.tree,
776
want_unchanged=include_unchanged)
777
# FIXME: Handle want_unversioned
778
return changes_from_git_changes(changes, self.target.mapping,
779
specific_file=specific_files)
782
tree.InterTree.register_optimiser(InterIndexGitTree)