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,
29
from ..sixish import (
33
from ..transport import (
34
do_catching_redirections,
35
get_transport_from_path,
38
from ..controldir import (
43
RepositoryAcquisitionPolicy,
49
from .transportgit import (
55
class GitDirConfig(object):
57
def get_default_stack_on(self):
60
def set_default_stack_on(self, value):
61
raise brz_errors.BzrError("Cannot set configuration")
64
class GitControlDirFormat(ControlDirFormat):
66
colocated_branches = True
67
fixed_components = True
69
def __eq__(self, other):
70
return type(self) == type(other)
72
def is_supported(self):
75
def network_name(self):
79
class UseExistingRepository(RepositoryAcquisitionPolicy):
80
"""A policy of reusing an existing repository"""
82
def __init__(self, repository, stack_on=None, stack_on_pwd=None,
83
require_stacking=False):
86
:param repository: The repository to use.
87
:param stack_on: A location to stack on
88
:param stack_on_pwd: If stack_on is relative, the location it is
91
super(UseExistingRepository, self).__init__(
92
stack_on, stack_on_pwd, require_stacking)
93
self._repository = repository
95
def acquire_repository(self, make_working_trees=None, shared=False,
96
possible_transports=None):
97
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
99
Returns an existing repository to use.
101
return self._repository, False
104
class GitDir(ControlDir):
105
"""An adapter to the '.git' dir used by git."""
107
def is_supported(self):
110
def can_convert_format(self):
113
def break_lock(self):
114
# There are no global locks, so nothing to break.
115
raise NotImplementedError(self.break_lock)
117
def cloning_metadir(self, stacked=False):
118
return format_registry.make_controldir("git")
120
def checkout_metadir(self, stacked=False):
121
return format_registry.make_controldir("git")
123
def _get_selected_ref(self, branch, ref=None):
124
if ref is not None and branch is not None:
125
raise brz_errors.BzrError("can't specify both ref and branch")
128
if branch is not None:
129
from .refs import branch_name_to_ref
130
return branch_name_to_ref(branch)
131
segment_parameters = getattr(
132
self.user_transport, "get_segment_parameters", lambda: {})()
133
ref = segment_parameters.get("ref")
135
return urlutils.unquote_to_bytes(ref)
136
if branch is None and getattr(self, "_get_selected_branch", False):
137
branch = self._get_selected_branch()
138
if branch is not None:
139
from .refs import branch_name_to_ref
140
return branch_name_to_ref(branch)
143
def get_config(self):
144
return GitDirConfig()
146
def _available_backup_name(self, base):
147
return osutils.available_backup_name(base, self.root_transport.has)
149
def sprout(self, url, revision_id=None, force_new_repo=False,
150
recurse='down', possible_transports=None,
151
accelerator_tree=None, hardlink=False, stacked=False,
152
source_branch=None, create_tree_if_local=True):
153
from ..repository import InterRepository
154
from ..transport.local import LocalTransport
155
from ..transport import get_transport
156
target_transport = get_transport(url, possible_transports)
157
target_transport.ensure_base()
158
cloning_format = self.cloning_metadir()
159
# Create/update the result branch
161
result = ControlDir.open_from_transport(target_transport)
162
except brz_errors.NotBranchError:
163
result = cloning_format.initialize_on_transport(target_transport)
164
source_branch = self.open_branch()
165
source_repository = self.find_repository()
167
result_repo = result.find_repository()
168
except brz_errors.NoRepositoryPresent:
169
result_repo = result.create_repository()
171
raise _mod_branch.UnstackableBranchFormat(
172
self._format, self.user_url)
173
interrepo = InterRepository.get(source_repository, result_repo)
175
if revision_id is not None:
176
determine_wants = interrepo.get_determine_wants_revids(
177
[revision_id], include_tags=True)
179
determine_wants = interrepo.determine_wants_all
180
interrepo.fetch_objects(determine_wants=determine_wants,
181
mapping=source_branch.mapping)
182
result_branch = source_branch.sprout(
183
result, revision_id=revision_id, repository=result_repo)
184
if (create_tree_if_local and
185
isinstance(target_transport, LocalTransport) and
186
(result_repo is None or result_repo.make_working_trees())):
187
result.create_workingtree(
188
accelerator_tree=accelerator_tree,
189
hardlink=hardlink, from_branch=result_branch)
192
def clone_on_transport(self, transport, revision_id=None,
193
force_new_repo=False, preserve_stacking=False,
194
stacked_on=None, create_prefix=False,
195
use_existing_dir=True, no_tree=False):
196
"""See ControlDir.clone_on_transport."""
197
from ..repository import InterRepository
198
from .mapping import default_mapping
199
if stacked_on is not None:
200
raise _mod_branch.UnstackableBranchFormat(
201
self._format, self.user_url)
203
format = BareLocalGitControlDirFormat()
205
format = LocalGitControlDirFormat()
206
(target_repo, target_controldir, stacking,
207
repo_policy) = format.initialize_on_transport_ex(
208
transport, use_existing_dir=use_existing_dir,
209
create_prefix=create_prefix,
210
force_new_repo=force_new_repo)
211
target_repo = target_controldir.find_repository()
212
target_git_repo = target_repo._git
213
source_repo = self.find_repository()
214
interrepo = InterRepository.get(source_repo, target_repo)
215
if revision_id is not None:
216
determine_wants = interrepo.get_determine_wants_revids(
217
[revision_id], include_tags=True)
219
determine_wants = interrepo.determine_wants_all
220
(pack_hint, _, refs) = interrepo.fetch_objects(determine_wants,
221
mapping=default_mapping)
222
for name, val in viewitems(refs):
223
target_git_repo.refs[name] = val
224
result_dir = self.__class__(transport, target_git_repo, format)
225
if revision_id is not None:
226
result_dir.open_branch().set_last_revision(revision_id)
228
# Cheaper to check if the target is not local, than to try making
230
result_dir.root_transport.local_abspath('.')
231
if result_dir.open_repository().make_working_trees():
232
self.open_workingtree().clone(
233
result_dir, revision_id=revision_id)
234
except (brz_errors.NoWorkingTree, brz_errors.NotLocalUrl):
239
def find_repository(self):
240
"""Find the repository that should be used.
242
This does not require a branch as we use it to find the repo for
243
new branches as well as to hook existing branches up to their
246
return self._gitrepository_class(self._find_commondir())
248
def get_refs_container(self):
249
"""Retrieve the refs container.
251
raise NotImplementedError(self.get_refs_container)
253
def determine_repository_policy(self, force_new_repo=False, stack_on=None,
254
stack_on_pwd=None, require_stacking=False):
255
"""Return an object representing a policy to use.
257
This controls whether a new repository is created, and the format of
258
that repository, or some existing shared repository used instead.
260
If stack_on is supplied, will not seek a containing shared repo.
262
:param force_new_repo: If True, require a new repository to be created.
263
:param stack_on: If supplied, the location to stack on. If not
264
supplied, a default_stack_on location may be used.
265
:param stack_on_pwd: If stack_on is relative, the location it is
268
return UseExistingRepository(self.find_repository())
270
def get_branches(self):
271
from .refs import ref_to_branch_name
273
for ref in self.get_refs_container().keys():
275
branch_name = ref_to_branch_name(ref)
276
except UnicodeDecodeError:
277
trace.warning("Ignoring branch %r with unicode error ref", ref)
281
ret[branch_name] = self.open_branch(ref=ref)
284
def list_branches(self):
285
return list(self.get_branches().values())
287
def push_branch(self, source, revision_id=None, overwrite=False,
288
remember=False, create_prefix=False, lossy=False,
290
"""Push the source branch into this ControlDir."""
291
push_result = GitPushResult()
292
push_result.workingtree_updated = None
293
push_result.master_branch = None
294
push_result.source_branch = source
295
push_result.stacked_on = None
296
from .branch import GitBranch
297
if isinstance(source, GitBranch) and lossy:
298
raise brz_errors.LossyPushToSameVCS(source.controldir, self)
299
target = self.open_branch(name, nascent_ok=True)
300
push_result.branch_push_result = source.push(
301
target, overwrite=overwrite, stop_revision=revision_id,
303
push_result.new_revid = push_result.branch_push_result.new_revid
304
push_result.old_revid = push_result.branch_push_result.old_revid
305
push_result.target_branch = target
306
if source.get_push_location() is None or remember:
307
source.set_push_location(push_result.target_branch.base)
311
class LocalGitControlDirFormat(GitControlDirFormat):
312
"""The .git directory control format."""
317
def _known_formats(self):
318
return set([LocalGitControlDirFormat()])
321
def repository_format(self):
322
from .repository import GitRepositoryFormat
323
return GitRepositoryFormat()
326
def workingtree_format(self):
327
from .workingtree import GitWorkingTreeFormat
328
return GitWorkingTreeFormat()
330
def get_branch_format(self):
331
from .branch import LocalGitBranchFormat
332
return LocalGitBranchFormat()
334
def open(self, transport, _found=None):
335
"""Open this directory.
338
from .transportgit import TransportRepo
340
def _open(transport):
341
return TransportRepo(transport, self.bare,
342
refs_text=getattr(self, "_refs_text", None))
344
def redirected(transport, e, redirection_notice):
345
trace.note(redirection_notice)
346
return transport._redirected_to(e.source, e.target)
347
gitrepo = do_catching_redirections(_open, transport, redirected)
348
if not gitrepo._controltransport.has('HEAD'):
349
raise brz_errors.NotBranchError(path=transport.base)
350
return LocalGitDir(transport, gitrepo, self)
352
def get_format_description(self):
353
return "Local Git Repository"
355
def initialize_on_transport(self, transport):
356
from .transportgit import TransportRepo
357
git_repo = TransportRepo.init(transport, bare=self.bare)
358
return LocalGitDir(transport, git_repo, self)
360
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
361
create_prefix=False, force_new_repo=False,
363
stack_on_pwd=None, repo_format_name=None,
364
make_working_trees=None,
365
shared_repo=False, vfs_only=False):
366
def make_directory(transport):
370
def redirected(transport, e, redirection_notice):
371
trace.note(redirection_notice)
372
return transport._redirected_to(e.source, e.target)
374
transport = do_catching_redirections(
375
make_directory, transport, redirected)
376
except brz_errors.FileExists:
377
if not use_existing_dir:
379
except brz_errors.NoSuchFile:
380
if not create_prefix:
382
transport.create_prefix()
383
controldir = self.initialize_on_transport(transport)
385
result_repo = controldir.find_repository()
386
repository_policy = UseExistingRepository(result_repo)
387
result_repo.lock_write()
390
repository_policy = None
391
return (result_repo, controldir, False,
394
def is_supported(self):
397
def supports_transport(self, transport):
399
external_url = transport.external_url()
400
except brz_errors.InProcessTransport:
401
raise brz_errors.NotBranchError(path=transport.base)
402
return external_url.startswith("file:")
404
def is_control_filename(self, filename):
405
return (filename == '.git'
406
or filename.startswith('.git/')
407
or filename.startswith('.git\\'))
410
class BareLocalGitControlDirFormat(LocalGitControlDirFormat):
413
supports_workingtrees = False
415
def get_format_description(self):
416
return "Local Git Repository (bare)"
418
def is_control_filename(self, filename):
422
class LocalGitDir(GitDir):
423
"""An adapter to the '.git' dir used by git."""
425
def _get_gitrepository_class(self):
426
from .repository import LocalGitRepository
427
return LocalGitRepository
430
return "<%s at %r>" % (
431
self.__class__.__name__, self.root_transport.base)
433
_gitrepository_class = property(_get_gitrepository_class)
436
def user_transport(self):
437
return self.root_transport
440
def control_transport(self):
441
return self._git._controltransport
443
def __init__(self, transport, gitrepo, format):
444
self._format = format
445
self.root_transport = transport
446
self._mode_check_done = False
449
self.transport = transport
451
self.transport = transport.clone('.git')
452
self._mode_check_done = None
454
def _get_symref(self, ref):
455
ref_chain, unused_sha = self._git.refs.follow(ref)
456
if len(ref_chain) == 1:
460
def set_branch_reference(self, target_branch, name=None):
461
ref = self._get_selected_ref(name)
462
target_transport = target_branch.controldir.control_transport
463
if self.control_transport.base == target_transport.base:
464
if ref == target_branch.ref:
465
raise BranchReferenceLoop(target_branch)
466
self._git.refs.set_symbolic_ref(ref, target_branch.ref)
470
target_branch.controldir.control_transport.local_abspath(
472
except brz_errors.NotLocalUrl:
473
raise brz_errors.IncompatibleFormat(
474
target_branch._format, self._format)
475
# TODO(jelmer): Do some consistency checking across branches..
476
self.control_transport.put_bytes(
477
'commondir', target_path.encode('utf-8'))
478
# TODO(jelmer): Urgh, avoid mucking about with internals.
479
self._git._commontransport = (
480
target_branch.repository._git._commontransport.clone())
481
self._git.object_store = TransportObjectStore(
482
self._git._commontransport.clone(OBJECTDIR))
483
self._git.refs.transport = self._git._commontransport
484
target_ref_chain, unused_sha = (
485
target_branch.controldir._git.refs.follow(target_branch.ref))
486
for target_ref in target_ref_chain:
487
if target_ref == b'HEAD':
491
# Can't create a reference to something that is not a in a repository.
492
raise brz_errors.IncompatibleFormat(
493
self.set_branch_reference, self)
494
self._git.refs.set_symbolic_ref(ref, target_ref)
496
def get_branch_reference(self, name=None):
497
ref = self._get_selected_ref(name)
498
target_ref = self._get_symref(ref)
499
if target_ref is not None:
500
from .refs import ref_to_branch_name
502
branch_name = ref_to_branch_name(target_ref)
504
params = {'ref': urlutils.quote(
505
target_ref.decode('utf-8'), '')}
507
if branch_name != '':
508
params = {'branch': urlutils.quote(branch_name, '')}
512
commondir = self.control_transport.get_bytes('commondir')
513
except brz_errors.NoSuchFile:
514
base_url = self.user_url.rstrip('/')
516
base_url = urlutils.local_path_to_url(
517
commondir.decode(osutils._fs_enc)).rstrip('/.git/') + '/'
519
params = {k: v.encode('utf-8') for (k, v) in viewitems(params)}
520
return urlutils.join_segment_parameters(base_url, params)
523
def find_branch_format(self, name=None):
524
from .branch import (
525
LocalGitBranchFormat,
527
return LocalGitBranchFormat()
529
def get_branch_transport(self, branch_format, name=None):
530
if branch_format is None:
531
return self.transport
532
if isinstance(branch_format, LocalGitControlDirFormat):
533
return self.transport
534
raise brz_errors.IncompatibleFormat(branch_format, self._format)
536
def get_repository_transport(self, format):
538
return self.transport
539
if isinstance(format, LocalGitControlDirFormat):
540
return self.transport
541
raise brz_errors.IncompatibleFormat(format, self._format)
543
def get_workingtree_transport(self, format):
545
return self.transport
546
if isinstance(format, LocalGitControlDirFormat):
547
return self.transport
548
raise brz_errors.IncompatibleFormat(format, self._format)
550
def open_branch(self, name=None, unsupported=False, ignore_fallbacks=None,
551
ref=None, possible_transports=None, nascent_ok=False):
552
"""'create' a branch for this dir."""
553
repo = self.find_repository()
554
from .branch import LocalGitBranch
555
ref = self._get_selected_ref(name, ref)
556
if not nascent_ok and ref not in self._git.refs:
557
raise brz_errors.NotBranchError(
558
self.root_transport.base, controldir=self)
559
ref_chain, unused_sha = self._git.refs.follow(ref)
560
if ref_chain[-1] == b'HEAD':
563
controldir = self._find_commondir()
564
return LocalGitBranch(controldir, repo, ref_chain[-1])
566
def destroy_branch(self, name=None):
567
refname = self._get_selected_ref(name)
568
if refname == b'HEAD':
569
# HEAD can't be removed
570
raise brz_errors.UnsupportedOperation(
571
self.destroy_branch, self)
573
del self._git.refs[refname]
575
raise brz_errors.NotBranchError(
576
self.root_transport.base, controldir=self)
578
def destroy_repository(self):
579
raise brz_errors.UnsupportedOperation(self.destroy_repository, self)
581
def destroy_workingtree(self):
582
raise brz_errors.UnsupportedOperation(self.destroy_workingtree, self)
584
def destroy_workingtree_metadata(self):
585
raise brz_errors.UnsupportedOperation(
586
self.destroy_workingtree_metadata, self)
588
def needs_format_conversion(self, format=None):
589
return not isinstance(self._format, format.__class__)
591
def open_repository(self):
592
"""'open' a repository for this dir."""
593
if self.control_transport.has('commondir'):
594
raise brz_errors.NoRepositoryPresent(self)
595
return self._gitrepository_class(self)
597
def has_workingtree(self):
598
return not self._git.bare
600
def open_workingtree(self, recommend_upgrade=True, unsupported=False):
601
if not self._git.bare:
602
repo = self.find_repository()
603
from .workingtree import GitWorkingTree
604
branch = self.open_branch(ref=b'HEAD', nascent_ok=True)
605
return GitWorkingTree(self, repo, branch)
606
loc = urlutils.unescape_for_display(self.root_transport.base, 'ascii')
607
raise brz_errors.NoWorkingTree(loc)
609
def create_repository(self, shared=False):
610
from .repository import GitRepositoryFormat
612
raise brz_errors.IncompatibleFormat(
613
GitRepositoryFormat(), self._format)
614
return self.find_repository()
616
def create_branch(self, name=None, repository=None,
617
append_revisions_only=None, ref=None):
618
refname = self._get_selected_ref(name, ref)
619
if refname != b'HEAD' and refname in self._git.refs:
620
raise brz_errors.AlreadyBranchError(self.user_url)
621
repo = self.open_repository()
622
if refname in self._git.refs:
623
ref_chain, unused_sha = self._git.refs.follow(
624
self._get_selected_ref(None))
625
if ref_chain[0] == b'HEAD':
626
refname = ref_chain[1]
627
from .branch import LocalGitBranch
628
branch = LocalGitBranch(self, repo, refname)
629
if append_revisions_only:
630
branch.set_append_revisions_only(append_revisions_only)
633
def backup_bzrdir(self):
634
if not self._git.bare:
635
self.root_transport.copy_tree(".git", ".git.backup")
636
return (self.root_transport.abspath(".git"),
637
self.root_transport.abspath(".git.backup"))
639
basename = urlutils.basename(self.root_transport.base)
640
parent = self.root_transport.clone('..')
641
parent.copy_tree(basename, basename + ".backup")
643
def create_workingtree(self, revision_id=None, from_branch=None,
644
accelerator_tree=None, hardlink=False):
646
raise brz_errors.UnsupportedOperation(
647
self.create_workingtree, self)
648
if from_branch is None:
649
from_branch = self.open_branch(nascent_ok=True)
650
if revision_id is None:
651
revision_id = from_branch.last_revision()
652
repo = self.find_repository()
653
from .workingtree import GitWorkingTree
654
wt = GitWorkingTree(self, repo, from_branch)
655
wt.set_last_revision(revision_id)
656
wt._build_checkout_with_index()
659
def _find_or_create_repository(self, force_new_repo=None):
660
return self.create_repository(shared=False)
662
def _find_creation_modes(self):
663
"""Determine the appropriate modes for files and directories.
665
They're always set to be consistent with the base directory,
666
assuming that this transport allows setting modes.
668
# TODO: Do we need or want an option (maybe a config setting) to turn
669
# this off or override it for particular locations? -- mbp 20080512
670
if self._mode_check_done:
672
self._mode_check_done = True
674
st = self.transport.stat('.')
675
except brz_errors.TransportNotPossible:
676
self._dir_mode = None
677
self._file_mode = None
679
# Check the directory mode, but also make sure the created
680
# directories and files are read-write for this user. This is
681
# mostly a workaround for filesystems which lie about being able to
682
# write to a directory (cygwin & win32)
683
if (st.st_mode & 0o7777 == 0o0000):
684
# FTP allows stat but does not return dir/file modes
685
self._dir_mode = None
686
self._file_mode = None
688
self._dir_mode = (st.st_mode & 0o7777) | 0o0700
689
# Remove the sticky and execute bits for files
690
self._file_mode = self._dir_mode & ~0o7111
692
def _get_file_mode(self):
693
"""Return Unix mode for newly created files, or None.
695
if not self._mode_check_done:
696
self._find_creation_modes()
697
return self._file_mode
699
def _get_dir_mode(self):
700
"""Return Unix mode for newly created directories, or None.
702
if not self._mode_check_done:
703
self._find_creation_modes()
704
return self._dir_mode
706
def get_refs_container(self):
707
return self._git.refs
709
def get_peeled(self, ref):
710
return self._git.get_peeled(ref)
712
def _find_commondir(self):
714
commondir = self.control_transport.get_bytes('commondir')
715
except brz_errors.NoSuchFile:
718
commondir = commondir.rstrip(b'/.git/').decode(osutils._fs_enc)
719
return ControlDir.open_from_transport(
720
get_transport_from_path(commondir))
added
removed
breezy/git/dir.py
