1
# Copyright (C) 2007 Canonical Ltd
2
# Copyright (C) 2010-2018 Jelmer Vernooij
4
# This program is free software; you can redistribute it and/or modify
5
# it under the terms of the GNU General Public License as published by
6
# the Free Software Foundation; either version 2 of the License, or
7
# (at your option) any later version.
9
# This program is distributed in the hope that it will be useful,
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
# GNU General Public License for more details.
14
# You should have received a copy of the GNU General Public License
15
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
"""An adapter between a Git control dir and a Bazaar ControlDir."""
20
from __future__ import absolute_import
23
branch as _mod_branch,
30
from ..sixish import (
34
from ..transport import (
35
do_catching_redirections,
36
get_transport_from_path,
39
from ..controldir import (
44
RepositoryAcquisitionPolicy,
50
from .transportgit import (
56
class GitDirConfig(object):
58
def get_default_stack_on(self):
61
def set_default_stack_on(self, value):
62
raise brz_errors.BzrError("Cannot set configuration")
65
class GitControlDirFormat(ControlDirFormat):
67
colocated_branches = True
68
fixed_components = True
70
def __eq__(self, other):
71
return type(self) == type(other)
73
def is_supported(self):
76
def network_name(self):
80
class UseExistingRepository(RepositoryAcquisitionPolicy):
81
"""A policy of reusing an existing repository"""
83
def __init__(self, repository, stack_on=None, stack_on_pwd=None,
84
require_stacking=False):
87
:param repository: The repository to use.
88
:param stack_on: A location to stack on
89
:param stack_on_pwd: If stack_on is relative, the location it is
92
super(UseExistingRepository, self).__init__(
93
stack_on, stack_on_pwd, require_stacking)
94
self._repository = repository
96
def acquire_repository(self, make_working_trees=None, shared=False,
97
possible_transports=None):
98
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
100
Returns an existing repository to use.
102
return self._repository, False
105
class GitDir(ControlDir):
106
"""An adapter to the '.git' dir used by git."""
108
def is_supported(self):
111
def can_convert_format(self):
114
def break_lock(self):
115
# There are no global locks, so nothing to break.
116
raise NotImplementedError(self.break_lock)
118
def cloning_metadir(self, stacked=False):
119
return format_registry.make_controldir("git")
121
def checkout_metadir(self, stacked=False):
122
return format_registry.make_controldir("git")
124
def _get_selected_ref(self, branch, ref=None):
125
if ref is not None and branch is not None:
126
raise brz_errors.BzrError("can't specify both ref and branch")
129
if branch is not None:
130
from .refs import branch_name_to_ref
131
return branch_name_to_ref(branch)
132
segment_parameters = getattr(
133
self.user_transport, "get_segment_parameters", lambda: {})()
134
ref = segment_parameters.get("ref")
136
return urlutils.unquote_to_bytes(ref)
137
if branch is None and getattr(self, "_get_selected_branch", False):
138
branch = self._get_selected_branch()
139
if branch is not None:
140
from .refs import branch_name_to_ref
141
return branch_name_to_ref(branch)
144
def get_config(self):
145
return GitDirConfig()
147
def _available_backup_name(self, base):
148
return osutils.available_backup_name(base, self.root_transport.has)
150
def sprout(self, url, revision_id=None, force_new_repo=False,
151
recurse='down', possible_transports=None,
152
accelerator_tree=None, hardlink=False, stacked=False,
153
source_branch=None, create_tree_if_local=True):
154
from ..repository import InterRepository
155
from ..transport.local import LocalTransport
156
from ..transport import get_transport
157
target_transport = get_transport(url, possible_transports)
158
target_transport.ensure_base()
159
cloning_format = self.cloning_metadir()
160
# Create/update the result branch
162
result = ControlDir.open_from_transport(target_transport)
163
except brz_errors.NotBranchError:
164
result = cloning_format.initialize_on_transport(target_transport)
165
source_branch = self.open_branch()
166
source_repository = self.find_repository()
168
result_repo = result.find_repository()
169
except brz_errors.NoRepositoryPresent:
170
result_repo = result.create_repository()
172
raise _mod_branch.UnstackableBranchFormat(
173
self._format, self.user_url)
174
interrepo = InterRepository.get(source_repository, result_repo)
176
if revision_id is not None:
177
determine_wants = interrepo.get_determine_wants_revids(
178
[revision_id], include_tags=True)
180
determine_wants = interrepo.determine_wants_all
181
interrepo.fetch_objects(determine_wants=determine_wants,
182
mapping=source_branch.mapping)
183
result_branch = source_branch.sprout(
184
result, revision_id=revision_id, repository=result_repo)
185
if (create_tree_if_local and
186
result.open_branch(name="").name == result_branch.name and
187
isinstance(target_transport, LocalTransport) and
188
(result_repo is None or result_repo.make_working_trees())):
189
wt = result.create_workingtree(
190
accelerator_tree=accelerator_tree,
191
hardlink=hardlink, from_branch=result_branch)
194
if recurse == 'down':
195
with cleanup.ExitStack() as stack:
198
basis = wt.basis_tree()
199
elif result_branch is not None:
200
basis = result_branch.basis_tree()
201
elif source_branch is not None:
202
basis = source_branch.basis_tree()
203
if basis is not None:
204
stack.enter_context(basis.lock_read())
205
subtrees = basis.iter_references()
208
for path in subtrees:
209
target = urlutils.join(url, urlutils.escape(path))
210
sublocation = wt.reference_parent(
211
path, possible_transports=possible_transports)
212
if sublocation is None:
214
'Ignoring nested tree %s, parent location unknown.',
217
sublocation.controldir.sprout(
218
target, basis.get_reference_revision(path),
219
force_new_repo=force_new_repo, recurse=recurse,
223
def clone_on_transport(self, transport, revision_id=None,
224
force_new_repo=False, preserve_stacking=False,
225
stacked_on=None, create_prefix=False,
226
use_existing_dir=True, no_tree=False,
228
"""See ControlDir.clone_on_transport."""
229
from ..repository import InterRepository
230
from .mapping import default_mapping
231
if stacked_on is not None:
232
raise _mod_branch.UnstackableBranchFormat(
233
self._format, self.user_url)
235
format = BareLocalGitControlDirFormat()
237
format = LocalGitControlDirFormat()
238
(target_repo, target_controldir, stacking,
239
repo_policy) = format.initialize_on_transport_ex(
240
transport, use_existing_dir=use_existing_dir,
241
create_prefix=create_prefix,
242
force_new_repo=force_new_repo)
243
target_repo = target_controldir.find_repository()
244
target_git_repo = target_repo._git
245
source_repo = self.find_repository()
246
interrepo = InterRepository.get(source_repo, target_repo)
247
if revision_id is not None:
248
determine_wants = interrepo.get_determine_wants_revids(
249
[revision_id], include_tags=True, tag_selector=tag_selector)
251
determine_wants = interrepo.determine_wants_all
252
(pack_hint, _, refs) = interrepo.fetch_objects(determine_wants,
253
mapping=default_mapping)
254
for name, val in viewitems(refs):
255
target_git_repo.refs[name] = val
256
result_dir = self.__class__(transport, target_git_repo, format)
257
if revision_id is not None:
258
result_dir.open_branch().set_last_revision(revision_id)
260
# Cheaper to check if the target is not local, than to try making
262
result_dir.root_transport.local_abspath('.')
263
if result_dir.open_repository().make_working_trees():
264
self.open_workingtree().clone(
265
result_dir, revision_id=revision_id)
266
except (brz_errors.NoWorkingTree, brz_errors.NotLocalUrl):
271
def find_repository(self):
272
"""Find the repository that should be used.
274
This does not require a branch as we use it to find the repo for
275
new branches as well as to hook existing branches up to their
278
return self._gitrepository_class(self._find_commondir())
280
def get_refs_container(self):
281
"""Retrieve the refs container.
283
raise NotImplementedError(self.get_refs_container)
285
def determine_repository_policy(self, force_new_repo=False, stack_on=None,
286
stack_on_pwd=None, require_stacking=False):
287
"""Return an object representing a policy to use.
289
This controls whether a new repository is created, and the format of
290
that repository, or some existing shared repository used instead.
292
If stack_on is supplied, will not seek a containing shared repo.
294
:param force_new_repo: If True, require a new repository to be created.
295
:param stack_on: If supplied, the location to stack on. If not
296
supplied, a default_stack_on location may be used.
297
:param stack_on_pwd: If stack_on is relative, the location it is
300
return UseExistingRepository(self.find_repository())
302
def get_branches(self):
303
from .refs import ref_to_branch_name
305
for ref in self.get_refs_container().keys():
307
branch_name = ref_to_branch_name(ref)
308
except UnicodeDecodeError:
309
trace.warning("Ignoring branch %r with unicode error ref", ref)
313
ret[branch_name] = self.open_branch(ref=ref)
316
def list_branches(self):
317
return list(self.get_branches().values())
319
def push_branch(self, source, revision_id=None, overwrite=False,
320
remember=False, create_prefix=False, lossy=False,
321
name=None, tag_selector=None):
322
"""Push the source branch into this ControlDir."""
323
push_result = GitPushResult()
324
push_result.workingtree_updated = None
325
push_result.master_branch = None
326
push_result.source_branch = source
327
push_result.stacked_on = None
328
from .branch import GitBranch
329
if isinstance(source, GitBranch) and lossy:
330
raise brz_errors.LossyPushToSameVCS(source.controldir, self)
331
target = self.open_branch(name, nascent_ok=True)
332
push_result.branch_push_result = source.push(
333
target, overwrite=overwrite, stop_revision=revision_id,
334
lossy=lossy, tag_selector=tag_selector)
335
push_result.new_revid = push_result.branch_push_result.new_revid
336
push_result.old_revid = push_result.branch_push_result.old_revid
338
wt = self.open_workingtree()
339
except brz_errors.NoWorkingTree:
340
push_result.workingtree_updated = None
342
if self.open_branch(name="").name == target.name:
344
old_revision=push_result.old_revid,
345
new_revision=push_result.new_revid)
346
push_result.workingtree_updated = True
348
push_result.workingtree_updated = False
349
push_result.target_branch = target
350
if source.get_push_location() is None or remember:
351
source.set_push_location(push_result.target_branch.base)
355
class LocalGitControlDirFormat(GitControlDirFormat):
356
"""The .git directory control format."""
361
def _known_formats(self):
362
return set([LocalGitControlDirFormat()])
365
def repository_format(self):
366
from .repository import GitRepositoryFormat
367
return GitRepositoryFormat()
370
def workingtree_format(self):
371
from .workingtree import GitWorkingTreeFormat
372
return GitWorkingTreeFormat()
374
def get_branch_format(self):
375
from .branch import LocalGitBranchFormat
376
return LocalGitBranchFormat()
378
def open(self, transport, _found=None):
379
"""Open this directory.
382
from .transportgit import TransportRepo
384
def _open(transport):
386
return TransportRepo(transport, self.bare,
387
refs_text=getattr(self, "_refs_text", None))
388
except ValueError as e:
389
if e.args == ('Expected file to start with \'gitdir: \'', ):
390
raise brz_errors.NotBranchError(path=transport.base)
393
def redirected(transport, e, redirection_notice):
394
trace.note(redirection_notice)
395
return transport._redirected_to(e.source, e.target)
396
gitrepo = do_catching_redirections(_open, transport, redirected)
397
if not _found and not gitrepo._controltransport.has('objects'):
398
raise brz_errors.NotBranchError(path=transport.base)
399
return LocalGitDir(transport, gitrepo, self)
401
def get_format_description(self):
402
return "Local Git Repository"
404
def initialize_on_transport(self, transport):
405
from .transportgit import TransportRepo
406
git_repo = TransportRepo.init(transport, bare=self.bare)
407
return LocalGitDir(transport, git_repo, self)
409
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
410
create_prefix=False, force_new_repo=False,
412
stack_on_pwd=None, repo_format_name=None,
413
make_working_trees=None,
414
shared_repo=False, vfs_only=False):
416
raise brz_errors.SharedRepositoriesUnsupported(self)
418
def make_directory(transport):
422
def redirected(transport, e, redirection_notice):
423
trace.note(redirection_notice)
424
return transport._redirected_to(e.source, e.target)
426
transport = do_catching_redirections(
427
make_directory, transport, redirected)
428
except brz_errors.FileExists:
429
if not use_existing_dir:
431
except brz_errors.NoSuchFile:
432
if not create_prefix:
434
transport.create_prefix()
435
controldir = self.initialize_on_transport(transport)
437
result_repo = controldir.find_repository()
438
repository_policy = UseExistingRepository(result_repo)
439
result_repo.lock_write()
442
repository_policy = None
443
return (result_repo, controldir, False,
446
def is_supported(self):
449
def supports_transport(self, transport):
451
external_url = transport.external_url()
452
except brz_errors.InProcessTransport:
453
raise brz_errors.NotBranchError(path=transport.base)
454
return external_url.startswith("file:")
456
def is_control_filename(self, filename):
457
return (filename == '.git'
458
or filename.startswith('.git/')
459
or filename.startswith('.git\\'))
462
class BareLocalGitControlDirFormat(LocalGitControlDirFormat):
465
supports_workingtrees = False
467
def get_format_description(self):
468
return "Local Git Repository (bare)"
470
def is_control_filename(self, filename):
474
class LocalGitDir(GitDir):
475
"""An adapter to the '.git' dir used by git."""
477
def _get_gitrepository_class(self):
478
from .repository import LocalGitRepository
479
return LocalGitRepository
482
return "<%s at %r>" % (
483
self.__class__.__name__, self.root_transport.base)
485
_gitrepository_class = property(_get_gitrepository_class)
488
def user_transport(self):
489
return self.root_transport
492
def control_transport(self):
493
return self._git._controltransport
495
def __init__(self, transport, gitrepo, format):
496
self._format = format
497
self.root_transport = transport
498
self._mode_check_done = False
501
self.transport = transport
503
self.transport = transport.clone('.git')
504
self._mode_check_done = None
506
def _get_symref(self, ref):
507
ref_chain, unused_sha = self._git.refs.follow(ref)
508
if len(ref_chain) == 1:
512
def set_branch_reference(self, target_branch, name=None):
513
ref = self._get_selected_ref(name)
514
target_transport = target_branch.controldir.control_transport
515
if self.control_transport.base == target_transport.base:
516
if ref == target_branch.ref:
517
raise BranchReferenceLoop(target_branch)
518
self._git.refs.set_symbolic_ref(ref, target_branch.ref)
522
target_branch.controldir.control_transport.local_abspath(
524
except brz_errors.NotLocalUrl:
525
raise brz_errors.IncompatibleFormat(
526
target_branch._format, self._format)
527
# TODO(jelmer): Do some consistency checking across branches..
528
self.control_transport.put_bytes(
529
'commondir', target_path.encode('utf-8'))
530
# TODO(jelmer): Urgh, avoid mucking about with internals.
531
self._git._commontransport = (
532
target_branch.repository._git._commontransport.clone())
533
self._git.object_store = TransportObjectStore(
534
self._git._commontransport.clone(OBJECTDIR))
535
self._git.refs.transport = self._git._commontransport
536
target_ref_chain, unused_sha = (
537
target_branch.controldir._git.refs.follow(target_branch.ref))
538
for target_ref in target_ref_chain:
539
if target_ref == b'HEAD':
543
# Can't create a reference to something that is not a in a repository.
544
raise brz_errors.IncompatibleFormat(
545
self.set_branch_reference, self)
546
self._git.refs.set_symbolic_ref(ref, target_ref)
548
def get_branch_reference(self, name=None):
549
ref = self._get_selected_ref(name)
550
target_ref = self._get_symref(ref)
551
if target_ref is not None:
552
from .refs import ref_to_branch_name
554
branch_name = ref_to_branch_name(target_ref)
556
params = {'ref': urlutils.quote(
557
target_ref.decode('utf-8'), '')}
559
if branch_name != '':
560
params = {'branch': urlutils.quote(branch_name, '')}
564
commondir = self.control_transport.get_bytes('commondir')
565
except brz_errors.NoSuchFile:
566
base_url = self.user_url.rstrip('/')
568
base_url = urlutils.local_path_to_url(
569
commondir.decode(osutils._fs_enc)).rstrip('/.git/') + '/'
571
params = {k: v.encode('utf-8') for (k, v) in viewitems(params)}
572
return urlutils.join_segment_parameters(base_url, params)
575
def find_branch_format(self, name=None):
576
from .branch import (
577
LocalGitBranchFormat,
579
return LocalGitBranchFormat()
581
def get_branch_transport(self, branch_format, name=None):
582
if branch_format is None:
583
return self.transport
584
if isinstance(branch_format, LocalGitControlDirFormat):
585
return self.transport
586
raise brz_errors.IncompatibleFormat(branch_format, self._format)
588
def get_repository_transport(self, format):
590
return self.transport
591
if isinstance(format, LocalGitControlDirFormat):
592
return self.transport
593
raise brz_errors.IncompatibleFormat(format, self._format)
595
def get_workingtree_transport(self, format):
597
return self.transport
598
if isinstance(format, LocalGitControlDirFormat):
599
return self.transport
600
raise brz_errors.IncompatibleFormat(format, self._format)
602
def open_branch(self, name=None, unsupported=False, ignore_fallbacks=None,
603
ref=None, possible_transports=None, nascent_ok=False):
604
"""'create' a branch for this dir."""
605
repo = self.find_repository()
606
from .branch import LocalGitBranch
607
ref = self._get_selected_ref(name, ref)
608
if not nascent_ok and ref not in self._git.refs:
609
raise brz_errors.NotBranchError(
610
self.root_transport.base, controldir=self)
611
ref_chain, unused_sha = self._git.refs.follow(ref)
612
if ref_chain[-1] == b'HEAD':
615
controldir = self._find_commondir()
616
return LocalGitBranch(controldir, repo, ref_chain[-1])
618
def destroy_branch(self, name=None):
619
refname = self._get_selected_ref(name)
620
if refname == b'HEAD':
621
# HEAD can't be removed
622
raise brz_errors.UnsupportedOperation(
623
self.destroy_branch, self)
625
del self._git.refs[refname]
627
raise brz_errors.NotBranchError(
628
self.root_transport.base, controldir=self)
630
def destroy_repository(self):
631
raise brz_errors.UnsupportedOperation(self.destroy_repository, self)
633
def destroy_workingtree(self):
634
raise brz_errors.UnsupportedOperation(self.destroy_workingtree, self)
636
def destroy_workingtree_metadata(self):
637
raise brz_errors.UnsupportedOperation(
638
self.destroy_workingtree_metadata, self)
640
def needs_format_conversion(self, format=None):
641
return not isinstance(self._format, format.__class__)
643
def open_repository(self):
644
"""'open' a repository for this dir."""
645
if self.control_transport.has('commondir'):
646
raise brz_errors.NoRepositoryPresent(self)
647
return self._gitrepository_class(self)
649
def has_workingtree(self):
650
return not self._git.bare
652
def open_workingtree(self, recommend_upgrade=True, unsupported=False):
653
if not self._git.bare:
654
repo = self.find_repository()
655
from .workingtree import GitWorkingTree
656
branch = self.open_branch(ref=b'HEAD', nascent_ok=True)
657
return GitWorkingTree(self, repo, branch)
658
loc = urlutils.unescape_for_display(self.root_transport.base, 'ascii')
659
raise brz_errors.NoWorkingTree(loc)
661
def create_repository(self, shared=False):
662
from .repository import GitRepositoryFormat
664
raise brz_errors.IncompatibleFormat(
665
GitRepositoryFormat(), self._format)
666
return self.find_repository()
668
def create_branch(self, name=None, repository=None,
669
append_revisions_only=None, ref=None):
670
refname = self._get_selected_ref(name, ref)
671
if refname != b'HEAD' and refname in self._git.refs:
672
raise brz_errors.AlreadyBranchError(self.user_url)
673
repo = self.open_repository()
674
if refname in self._git.refs:
675
ref_chain, unused_sha = self._git.refs.follow(
676
self._get_selected_ref(None))
677
if ref_chain[0] == b'HEAD':
678
refname = ref_chain[1]
679
from .branch import LocalGitBranch
680
branch = LocalGitBranch(self, repo, refname)
681
if append_revisions_only:
682
branch.set_append_revisions_only(append_revisions_only)
685
def backup_bzrdir(self):
686
if not self._git.bare:
687
self.root_transport.copy_tree(".git", ".git.backup")
688
return (self.root_transport.abspath(".git"),
689
self.root_transport.abspath(".git.backup"))
691
basename = urlutils.basename(self.root_transport.base)
692
parent = self.root_transport.clone('..')
693
parent.copy_tree(basename, basename + ".backup")
695
def create_workingtree(self, revision_id=None, from_branch=None,
696
accelerator_tree=None, hardlink=False):
698
raise brz_errors.UnsupportedOperation(
699
self.create_workingtree, self)
700
if from_branch is None:
701
from_branch = self.open_branch(nascent_ok=True)
702
if revision_id is None:
703
revision_id = from_branch.last_revision()
704
repo = self.find_repository()
705
from .workingtree import GitWorkingTree
706
wt = GitWorkingTree(self, repo, from_branch)
707
wt.set_last_revision(revision_id)
708
wt._build_checkout_with_index()
711
def _find_or_create_repository(self, force_new_repo=None):
712
return self.create_repository(shared=False)
714
def _find_creation_modes(self):
715
"""Determine the appropriate modes for files and directories.
717
They're always set to be consistent with the base directory,
718
assuming that this transport allows setting modes.
720
# TODO: Do we need or want an option (maybe a config setting) to turn
721
# this off or override it for particular locations? -- mbp 20080512
722
if self._mode_check_done:
724
self._mode_check_done = True
726
st = self.transport.stat('.')
727
except brz_errors.TransportNotPossible:
728
self._dir_mode = None
729
self._file_mode = None
731
# Check the directory mode, but also make sure the created
732
# directories and files are read-write for this user. This is
733
# mostly a workaround for filesystems which lie about being able to
734
# write to a directory (cygwin & win32)
735
if (st.st_mode & 0o7777 == 0o0000):
736
# FTP allows stat but does not return dir/file modes
737
self._dir_mode = None
738
self._file_mode = None
740
self._dir_mode = (st.st_mode & 0o7777) | 0o0700
741
# Remove the sticky and execute bits for files
742
self._file_mode = self._dir_mode & ~0o7111
744
def _get_file_mode(self):
745
"""Return Unix mode for newly created files, or None.
747
if not self._mode_check_done:
748
self._find_creation_modes()
749
return self._file_mode
751
def _get_dir_mode(self):
752
"""Return Unix mode for newly created directories, or None.
754
if not self._mode_check_done:
755
self._find_creation_modes()
756
return self._dir_mode
758
def get_refs_container(self):
759
return self._git.refs
761
def get_peeled(self, ref):
762
return self._git.get_peeled(ref)
764
def _find_commondir(self):
766
commondir = self.control_transport.get_bytes('commondir')
767
except brz_errors.NoSuchFile:
770
commondir = commondir.rstrip(b'/.git/').decode(osutils._fs_enc)
771
return ControlDir.open_from_transport(
772
get_transport_from_path(commondir))
added
removed
breezy/git/dir.py
