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 (
44
conflicts as _mod_conflicts,
55
from bzrlib.decorators import (
58
from bzrlib.mutabletree import needs_tree_write_lock
61
from bzrlib.plugins.git.dir import (
64
from bzrlib.plugins.git.tree import (
65
changes_from_git_changes,
66
tree_delta_from_git_changes,
68
from bzrlib.plugins.git.mapping import (
73
IGNORE_FILENAME = ".gitignore"
76
class GitWorkingTree(workingtree.WorkingTree):
77
"""A Git working tree."""
79
def __init__(self, bzrdir, repo, branch, index):
80
self.basedir = bzrdir.root_transport.local_abspath('.')
82
self.repository = repo
83
self.store = self.repository._git.object_store
84
self.mapping = self.repository.get_mapping()
86
self._transport = bzrdir.transport
88
self.controldir = self.bzrdir.transport.local_abspath('bzr')
91
os.makedirs(self.controldir)
92
os.makedirs(os.path.join(self.controldir, 'lock'))
96
self._control_files = lockable_files.LockableFiles(
97
transport.get_transport(self.controldir), 'lock', lockdir.LockDir)
98
self._format = GitWorkingTreeFormat()
100
self._versioned_dirs = None
101
self.views = self._make_views()
102
self._rules_searcher = None
103
self._detect_case_handling()
105
self._fileid_map = self._basis_fileid_map.copy()
107
def merge_modified(self):
110
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
111
self.set_parent_ids([p for p, t in parents_list])
113
def _index_add_entry(self, path, file_id, kind):
114
assert isinstance(path, basestring)
115
assert type(file_id) == str or file_id is None
116
if kind == "directory":
117
# Git indexes don't contain directories
122
file, stat_val = self.get_file_with_stat(file_id, path)
123
except (errors.NoSuchFile, IOError):
124
# TODO: Rather than come up with something here, use the old index
126
from posix import stat_result
127
stat_val = stat_result((stat.S_IFREG | 0644, 0, 0, 0, 0, 0, 0, 0, 0, 0))
128
blob.set_raw_string(file.read())
129
elif kind == "symlink":
132
stat_val = os.lstat(self.abspath(path))
133
except (errors.NoSuchFile, OSError):
134
# TODO: Rather than come up with something here, use the
136
from posix import stat_result
137
stat_val = stat_result((stat.S_IFLNK, 0, 0, 0, 0, 0, 0, 0, 0, 0))
138
blob.set_raw_string(self.get_symlink_target(file_id).encode("utf-8"))
140
raise AssertionError("unknown kind '%s'" % kind)
141
# Add object to the repository if it didn't exist yet
142
if not blob.id in self.store:
143
self.store.add_object(blob)
144
# Add an entry to the index or update the existing entry
146
encoded_path = path.encode("utf-8")
147
self.index[encoded_path] = (stat_val.st_ctime,
148
stat_val.st_mtime, stat_val.st_dev, stat_val.st_ino,
149
stat_val.st_mode, stat_val.st_uid, stat_val.st_gid,
150
stat_val.st_size, blob.id, flags)
151
if self._versioned_dirs is not None:
152
self._ensure_versioned_dir(encoded_path)
154
def _ensure_versioned_dir(self, dirname):
155
if dirname in self._versioned_dirs:
158
self._ensure_versioned_dir(posixpath.dirname(dirname))
159
self._versioned_dirs.add(dirname)
161
def _load_dirs(self):
162
self._versioned_dirs = set()
164
self._ensure_versioned_dir(posixpath.dirname(p))
166
def _unversion_path(self, path):
167
encoded_path = path.encode("utf-8")
169
del self.index[encoded_path]
171
# A directory, perhaps?
172
for p in list(self.index):
173
if p.startswith(encoded_path+"/"):
175
# FIXME: remove empty directories
177
def unversion(self, file_ids):
178
for file_id in file_ids:
179
path = self.id2path(file_id)
180
self._unversion_path(path)
182
def check_state(self):
183
"""Check that the working state is/isn't valid."""
186
def remove(self, files, verbose=False, to_file=None, keep_files=True,
188
"""Remove nominated files from the working tree metadata.
190
:param files: File paths relative to the basedir.
191
:param keep_files: If true, the files will also be kept.
192
:param force: Delete files and directories, even if they are changed
193
and even if the directories are not empty.
195
all_files = set() # specified and nested files
197
if isinstance(files, basestring):
203
files = list(all_files)
206
return # nothing to do
208
# Sort needed to first handle directory content before the directory
209
files.sort(reverse=True)
211
def backup(file_to_backup):
212
abs_path = self.abspath(file_to_backup)
213
backup_name = self.bzrdir._available_backup_name(file_to_backup)
214
osutils.rename(abs_path, self.abspath(backup_name))
215
return "removed %s (but kept a copy: %s)" % (
216
file_to_backup, backup_name)
219
fid = self.path2id(f)
221
message = "%s is not versioned." % (f,)
223
abs_path = self.abspath(f)
225
# having removed it, it must be either ignored or unknown
226
if self.is_ignored(f):
230
# XXX: Really should be a more abstract reporter interface
231
kind_ch = osutils.kind_marker(self.kind(fid))
232
to_file.write(new_status + ' ' + f + kind_ch + '\n')
234
# FIXME: _unversion_path() is O(size-of-index) for directories
235
self._unversion_path(f)
236
message = "removed %s" % (f,)
237
if osutils.lexists(abs_path):
238
if (osutils.isdir(abs_path) and
239
len(os.listdir(abs_path)) > 0):
241
osutils.rmtree(abs_path)
242
message = "deleted %s" % (f,)
247
osutils.delete_any(abs_path)
248
message = "deleted %s" % (f,)
250
# print only one message (if any) per file.
251
if message is not None:
254
def _add(self, files, ids, kinds):
255
for (path, file_id, kind) in zip(files, ids, kinds):
256
if file_id is not None:
257
self._fileid_map.set_file_id(path.encode("utf-8"), file_id)
259
file_id = self._fileid_map.lookup_file_id(path.encode("utf-8"))
260
self._index_add_entry(path, file_id, kind)
262
@needs_tree_write_lock
263
def smart_add(self, file_list, recurse=True, action=None, save=True):
267
for filepath in osutils.canonical_relpaths(self.basedir, file_list):
268
abspath = self.abspath(filepath)
269
kind = osutils.file_kind(abspath)
270
if action is not None:
271
file_id = action(self, None, filepath, kind)
274
if kind in ("file", "symlink"):
276
self._index_add_entry(filepath, file_id, kind)
277
added.append(filepath)
278
elif kind == "directory":
280
user_dirs.append(filepath)
282
raise errors.BadFileKindError(filename=abspath, kind=kind)
283
for user_dir in user_dirs:
284
abs_user_dir = self.abspath(user_dir)
285
for name in os.listdir(abs_user_dir):
286
subp = os.path.join(user_dir, name)
287
if self.is_control_filename(subp):
289
ignore_glob = self.is_ignored(subp)
290
if ignore_glob is not None:
291
ignored.setdefault(ignore_glob, []).append(subp)
293
abspath = self.abspath(subp)
294
kind = osutils.file_kind(abspath)
295
if kind == "directory":
296
user_dirs.append(subp)
298
if action is not None:
303
self._index_add_entry(subp, file_id, kind)
306
return added, ignored
308
def _set_root_id(self, file_id):
309
self._fileid_map.set_file_id("", file_id)
311
@needs_tree_write_lock
312
def move(self, from_paths, to_dir=None, after=False):
314
to_abs = self.abspath(to_dir)
315
if not os.path.isdir(to_abs):
316
raise errors.BzrMoveFailedError('', to_dir,
317
errors.NotADirectory(to_abs))
319
for from_rel in from_paths:
320
from_tail = os.path.split(from_rel)[-1]
321
to_rel = os.path.join(to_dir, from_tail)
322
self.rename_one(from_rel, to_rel, after=after)
323
rename_tuples.append((from_rel, to_rel))
326
@needs_tree_write_lock
327
def rename_one(self, from_rel, to_rel, after=False):
329
os.rename(self.abspath(from_rel), self.abspath(to_rel))
330
from_path = from_rel.encode("utf-8")
331
to_path = to_rel.encode("utf-8")
332
if not self.has_filename(to_rel):
333
raise errors.BzrMoveFailedError(from_rel, to_rel,
334
errors.NoSuchFile(to_rel))
335
if not from_path in self.index:
336
raise errors.BzrMoveFailedError(from_rel, to_rel,
337
errors.NotVersionedError(path=from_rel))
338
self.index[to_path] = self.index[from_path]
339
del self.index[from_path]
341
def get_root_id(self):
342
return self.path2id("")
344
def _has_dir(self, path):
345
if self._versioned_dirs is None:
347
return path in self._versioned_dirs
350
def path2id(self, path):
351
encoded_path = path.encode("utf-8")
352
if self._is_versioned(encoded_path):
353
return self._fileid_map.lookup_file_id(encoded_path)
357
"""Yield all unversioned files in this WorkingTree.
359
present_files = set()
360
for (dirpath, dirnames, filenames) in os.walk(self.basedir):
361
dir_relpath = dirpath[len(self.basedir):].strip("/")
362
if self.bzrdir.is_control_filename(dir_relpath):
364
for filename in filenames:
365
relpath = os.path.join(dir_relpath, filename)
366
present_files.add(relpath)
367
return present_files - set(self.index)
370
# non-implementation specific cleanup
373
# reverse order of locking.
375
return self._control_files.unlock()
380
# TODO: Maybe this should only write on dirty ?
381
if self._control_files._lock_mode != 'w':
382
raise errors.NotWriteLocked(self)
386
for path in self.index:
387
yield self.path2id(path)
389
for path in self._versioned_dirs:
390
yield self.path2id(path)
392
def has_or_had_id(self, file_id):
393
if self.has_id(file_id):
395
if self.had_id(file_id):
399
def had_id(self, file_id):
400
path = self._basis_fileid_map.lookup_file_id(file_id)
402
head = self.repository._git.head()
404
# Assume no if basis is not accessible
408
root_tree = self.store[head].tree
410
tree_lookup_path(self.store.__getitem__, root_tree, path)
416
def has_id(self, file_id):
418
self.id2path(file_id)
419
except errors.NoSuchId:
424
def id2path(self, file_id):
425
if type(file_id) != str:
427
path = self._fileid_map.lookup_path(file_id)
428
# FIXME: What about directories?
429
if self._is_versioned(path):
430
return path.decode("utf-8")
431
raise errors.NoSuchId(self, file_id)
433
def get_file_mtime(self, file_id, path=None):
434
"""See Tree.get_file_mtime."""
436
path = self.id2path(file_id)
437
return os.lstat(self.abspath(path)).st_mtime
439
def get_ignore_list(self):
440
ignoreset = getattr(self, '_ignoreset', None)
441
if ignoreset is not None:
445
ignore_globs.update(ignores.get_runtime_ignores())
446
ignore_globs.update(ignores.get_user_ignores())
447
if self.has_filename(IGNORE_FILENAME):
448
f = self.get_file_byname(IGNORE_FILENAME)
450
# FIXME: Parse git file format, rather than assuming it's
451
# the same as for bzr's native formats.
452
ignore_globs.update(ignores.parse_ignore_file(f))
455
self._ignoreset = ignore_globs
458
def set_last_revision(self, revid):
459
self._change_last_revision(revid)
461
def _reset_data(self):
463
head = self.repository._git.head()
464
except KeyError, name:
465
raise errors.NotBranchError("branch %s at %s" % (name,
466
self.repository.base))
468
self._basis_fileid_map = GitFileIdMap({}, self.mapping)
470
self._basis_fileid_map = self.mapping.get_fileid_map(
471
self.store.__getitem__, self.store[head].tree)
474
def get_file_verifier(self, file_id, path=None, stat_value=None):
476
path = self.id2path(file_id)
477
return ("GIT", self.index[path][-2])
480
def get_file_sha1(self, file_id, path=None, stat_value=None):
482
path = self.id2path(file_id)
483
abspath = self.abspath(path).encode(osutils._fs_enc)
485
return osutils.sha_file_by_name(abspath)
486
except OSError, (num, msg):
487
if num in (errno.EISDIR, errno.ENOENT):
491
def revision_tree(self, revid):
492
return self.repository.revision_tree(revid)
494
def _is_versioned(self, path):
495
return (path in self.index or self._has_dir(path))
497
def filter_unversioned_files(self, files):
498
return set([p for p in files if not self._is_versioned(p.encode("utf-8"))])
500
def _get_dir_ie(self, path, parent_id):
501
file_id = self.path2id(path)
502
return inventory.InventoryDirectory(file_id,
503
posixpath.basename(path).strip("/"), parent_id)
505
def _add_missing_parent_ids(self, path, dir_ids):
508
parent = posixpath.dirname(path).strip("/")
509
ret = self._add_missing_parent_ids(parent, dir_ids)
510
parent_id = dir_ids[parent]
511
ie = self._get_dir_ie(path, parent_id)
512
dir_ids[path] = ie.file_id
513
ret.append((path, ie))
516
def _get_file_ie(self, path, value, parent_id):
517
assert isinstance(path, unicode)
518
assert isinstance(value, tuple) and len(value) == 10
519
(ctime, mtime, dev, ino, mode, uid, gid, size, sha, flags) = value
520
file_id = self.path2id(path)
521
if type(file_id) != str:
523
kind = mode_kind(mode)
524
ie = inventory.entry_factory[kind](file_id,
525
posixpath.basename(path), parent_id)
526
if kind == 'symlink':
527
ie.symlink_target = self.get_symlink_target(file_id)
529
data = self.get_file_text(file_id, path)
530
ie.text_sha1 = osutils.sha_string(data)
531
ie.text_size = len(data)
532
ie.executable = self.is_executable(file_id, path)
536
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
537
mode = stat_result.st_mode
538
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
540
def stored_kind(self, file_id, path=None):
542
path = self.id2path(file_id)
543
head = self.repository._git.head()
545
raise errors.NoSuchId(self, file_id)
546
root_tree = self.store[head].tree
547
(mode, hexsha) = tree_lookup_path(self.store.__getitem__, root_tree, path)
548
return mode_kind(mode)
550
if not osutils.supports_executable():
551
def is_executable(self, file_id, path=None):
552
basis_tree = self.basis_tree()
553
if file_id in basis_tree:
554
return basis_tree.is_executable(file_id)
555
# Default to not executable
558
def is_executable(self, file_id, path=None):
560
path = self.id2path(file_id)
561
mode = os.lstat(self.abspath(path)).st_mode
562
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
564
_is_executable_from_path_and_stat = \
565
_is_executable_from_path_and_stat_from_stat
567
def list_files(self, include_root=False, from_dir=None, recursive=True):
568
# FIXME: Yield non-versioned files
569
# FIXME: support from_dir
570
# FIXME: Support recursive
572
root_ie = self._get_dir_ie(u"", None)
573
if include_root and not from_dir:
574
yield "", "V", root_ie.kind, root_ie.file_id, root_ie
575
dir_ids[u""] = root_ie.file_id
576
for path, value in self.index.iteritems():
577
path = path.decode("utf-8")
578
parent = posixpath.dirname(path).strip("/")
579
for dir_path, dir_ie in self._add_missing_parent_ids(parent, dir_ids):
580
yield dir_path, "V", dir_ie.kind, dir_ie.file_id, dir_ie
581
ie = self._get_file_ie(path, value, dir_ids[parent])
582
yield path, "V", ie.kind, ie.file_id, ie
584
def all_file_ids(self):
585
ids = {u"": self.path2id("")}
586
for path in self.index:
587
path = path.decode("utf-8")
588
parent = posixpath.dirname(path).strip("/")
589
for e in self._add_missing_parent_ids(parent, ids):
591
ids[path] = self.path2id(path)
592
return set(ids.values())
594
def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
595
# FIXME: Is return order correct?
597
raise NotImplementedError(self.iter_entries_by_dir)
598
if specific_file_ids is not None:
599
specific_paths = [self.id2path(file_id) for file_id in specific_file_ids]
600
if specific_paths in ([u""], []):
601
specific_paths = None
603
specific_paths = set(specific_paths)
605
specific_paths = None
606
root_ie = self._get_dir_ie(u"", None)
607
if specific_paths is None:
609
dir_ids = {u"": root_ie.file_id}
610
for path, value in self.index.iteritems():
611
path = path.decode("utf-8")
612
if specific_paths is not None and not path in specific_paths:
615
file_ie = self._get_file_ie(path, value, None)
618
parent = posixpath.dirname(path).strip("/")
619
for (dir_path, dir_ie) in self._add_missing_parent_ids(parent,
621
yield dir_path, dir_ie
622
file_ie.parent_id = self.path2id(parent)
628
return _mod_conflicts.ConflictList()
630
def update_basis_by_delta(self, new_revid, delta):
631
# The index just contains content, which won't have changed.
634
def _walkdirs(self, prefix=""):
637
per_dir = defaultdict(list)
638
for path, value in self.index.iteritems():
639
if not path.startswith(prefix):
641
(dirname, child_name) = posixpath.split(path)
642
dirname = dirname.decode("utf-8")
643
dir_file_id = self.path2id(dirname)
644
assert isinstance(value, tuple) and len(value) == 10
645
(ctime, mtime, dev, ino, mode, uid, gid, size, sha, flags) = value
646
stat_result = posix.stat_result((mode, ino,
647
dev, 1, uid, gid, size,
649
per_dir[(dirname, dir_file_id)].append(
650
(path.decode("utf-8"), child_name.decode("utf-8"),
651
mode_kind(mode), stat_result,
652
self.path2id(path.decode("utf-8")),
654
return per_dir.iteritems()
657
class GitWorkingTreeFormat(workingtree.WorkingTreeFormat):
659
_tree_class = GitWorkingTree
661
supports_versioned_directories = False
664
def _matchingbzrdir(self):
665
from bzrlib.plugins.git.dir import LocalGitControlDirFormat
666
return LocalGitControlDirFormat()
668
def get_format_description(self):
669
return "Git Working Tree"
671
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
672
accelerator_tree=None, hardlink=False):
673
"""See WorkingTreeFormat.initialize()."""
674
if not isinstance(a_bzrdir, LocalGitDir):
675
raise errors.IncompatibleFormat(self, a_bzrdir)
676
index = Index(a_bzrdir.root_transport.local_abspath(".git/index"))
678
return GitWorkingTree(a_bzrdir, a_bzrdir.open_repository(),
679
a_bzrdir.open_branch(), index)
682
class InterIndexGitTree(tree.InterTree):
683
"""InterTree that works between a Git revision tree and an index."""
685
def __init__(self, source, target):
686
super(InterIndexGitTree, self).__init__(source, target)
687
self._index = target.index
690
def is_compatible(cls, source, target):
691
from bzrlib.plugins.git.repository import GitRevisionTree
692
return (isinstance(source, GitRevisionTree) and
693
isinstance(target, GitWorkingTree))
695
def compare(self, want_unchanged=False, specific_files=None,
696
extra_trees=None, require_versioned=False, include_root=False,
697
want_unversioned=False):
698
changes = self._index.changes_from_tree(
699
self.source.store, self.source.tree,
700
want_unchanged=want_unchanged)
701
source_fileid_map = self.source.mapping.get_fileid_map(
702
self.source.store.__getitem__,
704
if self.target.mapping.BZR_FILE_IDS_FILE is not None:
705
file_id = self.target.path2id(
706
self.target.mapping.BZR_FILE_IDS_FILE)
708
target_fileid_map = {}
710
target_fileid_map = self.target.mapping.import_fileid_map(
711
Blob.from_string(self.target.get_file_text(file_id)))
713
target_fileid_map = {}
714
target_fileid_map = GitFileIdMap(target_fileid_map,
716
ret = tree_delta_from_git_changes(changes, self.target.mapping,
717
(source_fileid_map, target_fileid_map),
718
specific_file=specific_files, require_versioned=require_versioned)
720
for e in self.target.extras():
721
ret.unversioned.append((e, None,
722
osutils.file_kind(self.target.abspath(e))))
725
def iter_changes(self, include_unchanged=False, specific_files=None,
726
pb=None, extra_trees=[], require_versioned=True,
727
want_unversioned=False):
728
changes = self._index.changes_from_tree(
729
self.source.store, self.source.tree,
730
want_unchanged=include_unchanged)
731
# FIXME: Handle want_unversioned
732
return changes_from_git_changes(changes, self.target.mapping,
733
specific_file=specific_files)
736
tree.InterTree.register_optimiser(InterIndexGitTree)