/usr/lib/python2.7/dist-packages/bzrlib/smart/bzrdir.py is in python-bzrlib 2.7.0-2ubuntu3.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 | # Copyright (C) 2006-2010 Canonical Ltd
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
"""Server-side bzrdir related request implmentations."""
from __future__ import absolute_import
from bzrlib import (
bencode,
branch,
errors,
repository,
urlutils,
)
from bzrlib.bzrdir import (
BzrDir,
BzrDirFormat,
BzrProber,
)
from bzrlib.controldir import (
network_format_registry,
)
from bzrlib.smart.request import (
FailedSmartServerResponse,
SmartServerRequest,
SuccessfulSmartServerResponse,
)
class SmartServerRequestOpenBzrDir(SmartServerRequest):
def do(self, path):
try:
t = self.transport_from_client_path(path)
except errors.PathNotChild:
# The client is trying to ask about a path that they have no access
# to.
# Ideally we'd return a FailedSmartServerResponse here rather than
# a "successful" negative, but we want to be compatibile with
# clients that don't anticipate errors from this method.
answer = 'no'
else:
bzr_prober = BzrProber()
try:
bzr_prober.probe_transport(t)
except (errors.NotBranchError, errors.UnknownFormatError):
answer = 'no'
else:
answer = 'yes'
return SuccessfulSmartServerResponse((answer,))
class SmartServerRequestOpenBzrDir_2_1(SmartServerRequest):
def do(self, path):
"""Is there a BzrDir present, and if so does it have a working tree?
New in 2.1.
"""
try:
t = self.transport_from_client_path(path)
except errors.PathNotChild:
# The client is trying to ask about a path that they have no access
# to.
return SuccessfulSmartServerResponse(('no',))
try:
bd = BzrDir.open_from_transport(t)
except errors.NotBranchError:
answer = ('no',)
else:
answer = ('yes',)
if bd.has_workingtree():
answer += ('yes',)
else:
answer += ('no',)
return SuccessfulSmartServerResponse(answer)
class SmartServerRequestBzrDir(SmartServerRequest):
def do(self, path, *args):
"""Open a BzrDir at path, and return `self.do_bzrdir_request(*args)`."""
try:
self._bzrdir = BzrDir.open_from_transport(
self.transport_from_client_path(path))
except errors.NotBranchError, e:
return FailedSmartServerResponse(('nobranch',))
return self.do_bzrdir_request(*args)
def _boolean_to_yes_no(self, a_boolean):
if a_boolean:
return 'yes'
else:
return 'no'
def _format_to_capabilities(self, repo_format):
rich_root = self._boolean_to_yes_no(repo_format.rich_root_data)
tree_ref = self._boolean_to_yes_no(
repo_format.supports_tree_reference)
external_lookup = self._boolean_to_yes_no(
repo_format.supports_external_lookups)
return rich_root, tree_ref, external_lookup
def _repo_relpath(self, current_transport, repository):
"""Get the relative path for repository from current_transport."""
# the relpath of the bzrdir in the found repository gives us the
# path segments to pop-out.
relpath = repository.user_transport.relpath(
current_transport.base)
if len(relpath):
segments = ['..'] * len(relpath.split('/'))
else:
segments = []
return '/'.join(segments)
class SmartServerBzrDirRequestDestroyBranch(SmartServerRequestBzrDir):
def do_bzrdir_request(self, name=None):
"""Destroy the branch with the specified name.
New in 2.5.0.
:return: On success, 'ok'.
"""
try:
self._bzrdir.destroy_branch(name)
except errors.NotBranchError, e:
return FailedSmartServerResponse(('nobranch',))
return SuccessfulSmartServerResponse(('ok',))
class SmartServerBzrDirRequestHasWorkingTree(SmartServerRequestBzrDir):
def do_bzrdir_request(self, name=None):
"""Check whether there is a working tree present.
New in 2.5.0.
:return: If there is a working tree present, 'yes'.
Otherwise 'no'.
"""
if self._bzrdir.has_workingtree():
return SuccessfulSmartServerResponse(('yes', ))
else:
return SuccessfulSmartServerResponse(('no', ))
class SmartServerBzrDirRequestDestroyRepository(SmartServerRequestBzrDir):
def do_bzrdir_request(self, name=None):
"""Destroy the repository.
New in 2.5.0.
:return: On success, 'ok'.
"""
try:
self._bzrdir.destroy_repository()
except errors.NoRepositoryPresent, e:
return FailedSmartServerResponse(('norepository',))
return SuccessfulSmartServerResponse(('ok',))
class SmartServerBzrDirRequestCloningMetaDir(SmartServerRequestBzrDir):
def do_bzrdir_request(self, require_stacking):
"""Get the format that should be used when cloning from this dir.
New in 1.13.
:return: on success, a 3-tuple of network names for (control,
repository, branch) directories, where '' signifies "not present".
If this BzrDir contains a branch reference then this will fail with
BranchReference; clients should resolve branch references before
calling this RPC.
"""
try:
branch_ref = self._bzrdir.get_branch_reference()
except errors.NotBranchError:
branch_ref = None
if branch_ref is not None:
# The server shouldn't try to resolve references, and it quite
# possibly can't reach them anyway. The client needs to resolve
# the branch reference to determine the cloning_metadir.
return FailedSmartServerResponse(('BranchReference',))
if require_stacking == "True":
require_stacking = True
else:
require_stacking = False
control_format = self._bzrdir.cloning_metadir(
require_stacking=require_stacking)
control_name = control_format.network_name()
if not control_format.fixed_components:
branch_name = ('branch',
control_format.get_branch_format().network_name())
repository_name = control_format.repository_format.network_name()
else:
# Only MetaDir has delegated formats today.
branch_name = ('branch', '')
repository_name = ''
return SuccessfulSmartServerResponse((control_name, repository_name,
branch_name))
class SmartServerBzrDirRequestCheckoutMetaDir(SmartServerRequestBzrDir):
"""Get the format to use for checkouts.
New in 2.5.
:return: on success, a 3-tuple of network names for (control,
repository, branch) directories, where '' signifies "not present".
If this BzrDir contains a branch reference then this will fail with
BranchReference; clients should resolve branch references before
calling this RPC (they should not try to create a checkout of a
checkout).
"""
def do_bzrdir_request(self):
try:
branch_ref = self._bzrdir.get_branch_reference()
except errors.NotBranchError:
branch_ref = None
if branch_ref is not None:
# The server shouldn't try to resolve references, and it quite
# possibly can't reach them anyway. The client needs to resolve
# the branch reference to determine the cloning_metadir.
return FailedSmartServerResponse(('BranchReference',))
control_format = self._bzrdir.checkout_metadir()
control_name = control_format.network_name()
if not control_format.fixed_components:
branch_name = control_format.get_branch_format().network_name()
repo_name = control_format.repository_format.network_name()
else:
branch_name = ''
repo_name = ''
return SuccessfulSmartServerResponse(
(control_name, repo_name, branch_name))
class SmartServerRequestCreateBranch(SmartServerRequestBzrDir):
def do(self, path, network_name):
"""Create a branch in the bzr dir at path.
This operates precisely like 'bzrdir.create_branch'.
If a bzrdir is not present, an exception is propogated
rather than 'no branch' because these are different conditions (and
this method should only be called after establishing that a bzr dir
exists anyway).
This is the initial version of this method introduced to the smart
server for 1.13.
:param path: The path to the bzrdir.
:param network_name: The network name of the branch type to create.
:return: ('ok', branch_format, repo_path, rich_root, tree_ref,
external_lookup, repo_format)
"""
bzrdir = BzrDir.open_from_transport(
self.transport_from_client_path(path))
format = branch.network_format_registry.get(network_name)
bzrdir.branch_format = format
result = format.initialize(bzrdir, name="")
rich_root, tree_ref, external_lookup = self._format_to_capabilities(
result.repository._format)
branch_format = result._format.network_name()
repo_format = result.repository._format.network_name()
repo_path = self._repo_relpath(bzrdir.root_transport,
result.repository)
# branch format, repo relpath, rich_root, tree_ref, external_lookup,
# repo_network_name
return SuccessfulSmartServerResponse(('ok', branch_format, repo_path,
rich_root, tree_ref, external_lookup, repo_format))
class SmartServerRequestCreateRepository(SmartServerRequestBzrDir):
def do(self, path, network_name, shared):
"""Create a repository in the bzr dir at path.
This operates precisely like 'bzrdir.create_repository'.
If a bzrdir is not present, an exception is propagated
rather than 'no branch' because these are different conditions (and
this method should only be called after establishing that a bzr dir
exists anyway).
This is the initial version of this method introduced to the smart
server for 1.13.
:param path: The path to the bzrdir.
:param network_name: The network name of the repository type to create.
:param shared: The value to pass create_repository for the shared
parameter.
:return: (ok, rich_root, tree_ref, external_lookup, network_name)
"""
bzrdir = BzrDir.open_from_transport(
self.transport_from_client_path(path))
shared = shared == 'True'
format = repository.network_format_registry.get(network_name)
bzrdir.repository_format = format
result = format.initialize(bzrdir, shared=shared)
rich_root, tree_ref, external_lookup = self._format_to_capabilities(
result._format)
return SuccessfulSmartServerResponse(('ok', rich_root, tree_ref,
external_lookup, result._format.network_name()))
class SmartServerRequestFindRepository(SmartServerRequestBzrDir):
def _find(self, path):
"""try to find a repository from path upwards
This operates precisely like 'bzrdir.find_repository'.
:return: (relpath, rich_root, tree_ref, external_lookup, network_name).
All are strings, relpath is a / prefixed path, the next three are
either 'yes' or 'no', and the last is a repository format network
name.
:raises errors.NoRepositoryPresent: When there is no repository
present.
"""
bzrdir = BzrDir.open_from_transport(
self.transport_from_client_path(path))
repository = bzrdir.find_repository()
path = self._repo_relpath(bzrdir.root_transport, repository)
rich_root, tree_ref, external_lookup = self._format_to_capabilities(
repository._format)
network_name = repository._format.network_name()
return path, rich_root, tree_ref, external_lookup, network_name
class SmartServerRequestFindRepositoryV1(SmartServerRequestFindRepository):
def do(self, path):
"""try to find a repository from path upwards
This operates precisely like 'bzrdir.find_repository'.
If a bzrdir is not present, an exception is propagated
rather than 'no branch' because these are different conditions.
This is the initial version of this method introduced with the smart
server. Modern clients will try the V2 method that adds support for the
supports_external_lookups attribute.
:return: norepository or ok, relpath.
"""
try:
path, rich_root, tree_ref, external_lookup, name = self._find(path)
return SuccessfulSmartServerResponse(('ok', path, rich_root, tree_ref))
except errors.NoRepositoryPresent:
return FailedSmartServerResponse(('norepository', ))
class SmartServerRequestFindRepositoryV2(SmartServerRequestFindRepository):
def do(self, path):
"""try to find a repository from path upwards
This operates precisely like 'bzrdir.find_repository'.
If a bzrdir is not present, an exception is propagated
rather than 'no branch' because these are different conditions.
This is the second edition of this method introduced in bzr 1.3, which
returns information about the supports_external_lookups format
attribute too.
:return: norepository or ok, relpath, rich_root, tree_ref,
external_lookup.
"""
try:
path, rich_root, tree_ref, external_lookup, name = self._find(path)
return SuccessfulSmartServerResponse(
('ok', path, rich_root, tree_ref, external_lookup))
except errors.NoRepositoryPresent:
return FailedSmartServerResponse(('norepository', ))
class SmartServerRequestFindRepositoryV3(SmartServerRequestFindRepository):
def do(self, path):
"""try to find a repository from path upwards
This operates precisely like 'bzrdir.find_repository'.
If a bzrdir is not present, an exception is propogated
rather than 'no branch' because these are different conditions.
This is the third edition of this method introduced in bzr 1.13, which
returns information about the network name of the repository format.
:return: norepository or ok, relpath, rich_root, tree_ref,
external_lookup, network_name.
"""
try:
path, rich_root, tree_ref, external_lookup, name = self._find(path)
return SuccessfulSmartServerResponse(
('ok', path, rich_root, tree_ref, external_lookup, name))
except errors.NoRepositoryPresent:
return FailedSmartServerResponse(('norepository', ))
class SmartServerBzrDirRequestConfigFile(SmartServerRequestBzrDir):
def do_bzrdir_request(self):
"""Get the configuration bytes for a config file in bzrdir.
The body is not utf8 decoded - it is the literal bytestream from disk.
"""
config = self._bzrdir._get_config()
if config is None:
content = ''
else:
content = config._get_config_file().read()
return SuccessfulSmartServerResponse((), content)
class SmartServerBzrDirRequestGetBranches(SmartServerRequestBzrDir):
def do_bzrdir_request(self):
"""Get the branches in a control directory.
The body is a bencoded dictionary, with values similar to the return
value of the open branch request.
"""
branches = self._bzrdir.get_branches()
ret = {}
for name, b in branches.iteritems():
if name is None:
name = ""
ret[name] = ("branch", b._format.network_name())
return SuccessfulSmartServerResponse(
("success", ), bencode.bencode(ret))
class SmartServerRequestInitializeBzrDir(SmartServerRequest):
def do(self, path):
"""Initialize a bzrdir at path.
The default format of the server is used.
:return: SmartServerResponse(('ok', ))
"""
target_transport = self.transport_from_client_path(path)
BzrDirFormat.get_default_format().initialize_on_transport(target_transport)
return SuccessfulSmartServerResponse(('ok', ))
class SmartServerRequestBzrDirInitializeEx(SmartServerRequestBzrDir):
def parse_NoneTrueFalse(self, arg):
if not arg:
return None
if arg == 'False':
return False
if arg == 'True':
return True
raise AssertionError("invalid arg %r" % arg)
def parse_NoneString(self, arg):
return arg or None
def _serialize_NoneTrueFalse(self, arg):
if arg is False:
return 'False'
if not arg:
return ''
return 'True'
def do(self, bzrdir_network_name, path, use_existing_dir, create_prefix,
force_new_repo, stacked_on, stack_on_pwd, repo_format_name,
make_working_trees, shared_repo):
"""Initialize a bzrdir at path as per
BzrDirFormat.initialize_on_transport_ex.
New in 1.16. (Replaces BzrDirFormat.initialize_ex verb from 1.15).
:return: return SuccessfulSmartServerResponse((repo_path, rich_root,
tree_ref, external_lookup, repo_network_name,
repo_bzrdir_network_name, bzrdir_format_network_name,
NoneTrueFalse(stacking), final_stack, final_stack_pwd,
repo_lock_token))
"""
target_transport = self.transport_from_client_path(path)
format = network_format_registry.get(bzrdir_network_name)
use_existing_dir = self.parse_NoneTrueFalse(use_existing_dir)
create_prefix = self.parse_NoneTrueFalse(create_prefix)
force_new_repo = self.parse_NoneTrueFalse(force_new_repo)
stacked_on = self.parse_NoneString(stacked_on)
stack_on_pwd = self.parse_NoneString(stack_on_pwd)
make_working_trees = self.parse_NoneTrueFalse(make_working_trees)
shared_repo = self.parse_NoneTrueFalse(shared_repo)
if stack_on_pwd == '.':
stack_on_pwd = target_transport.base
repo_format_name = self.parse_NoneString(repo_format_name)
repo, bzrdir, stacking, repository_policy = \
format.initialize_on_transport_ex(target_transport,
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
force_new_repo=force_new_repo, stacked_on=stacked_on,
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
make_working_trees=make_working_trees, shared_repo=shared_repo)
if repo is None:
repo_path = ''
repo_name = ''
rich_root = tree_ref = external_lookup = ''
repo_bzrdir_name = ''
final_stack = None
final_stack_pwd = None
repo_lock_token = ''
else:
repo_path = self._repo_relpath(bzrdir.root_transport, repo)
if repo_path == '':
repo_path = '.'
rich_root, tree_ref, external_lookup = self._format_to_capabilities(
repo._format)
repo_name = repo._format.network_name()
repo_bzrdir_name = repo.bzrdir._format.network_name()
final_stack = repository_policy._stack_on
final_stack_pwd = repository_policy._stack_on_pwd
# It is returned locked, but we need to do the lock to get the lock
# token.
repo.unlock()
repo_lock_token = repo.lock_write().repository_token or ''
if repo_lock_token:
repo.leave_lock_in_place()
repo.unlock()
final_stack = final_stack or ''
final_stack_pwd = final_stack_pwd or ''
# We want this to be relative to the bzrdir.
if final_stack_pwd:
final_stack_pwd = urlutils.relative_url(
target_transport.base, final_stack_pwd)
# Can't meaningfully return a root path.
if final_stack.startswith('/'):
client_path = self._root_client_path + final_stack[1:]
final_stack = urlutils.relative_url(
self._root_client_path, client_path)
final_stack_pwd = '.'
return SuccessfulSmartServerResponse((repo_path, rich_root, tree_ref,
external_lookup, repo_name, repo_bzrdir_name,
bzrdir._format.network_name(),
self._serialize_NoneTrueFalse(stacking), final_stack,
final_stack_pwd, repo_lock_token))
class SmartServerRequestOpenBranch(SmartServerRequestBzrDir):
def do_bzrdir_request(self):
"""open a branch at path and return the branch reference or branch."""
try:
reference_url = self._bzrdir.get_branch_reference()
if reference_url is None:
return SuccessfulSmartServerResponse(('ok', ''))
else:
return SuccessfulSmartServerResponse(('ok', reference_url))
except errors.NotBranchError, e:
return FailedSmartServerResponse(('nobranch',))
class SmartServerRequestOpenBranchV2(SmartServerRequestBzrDir):
def do_bzrdir_request(self):
"""open a branch at path and return the reference or format."""
try:
reference_url = self._bzrdir.get_branch_reference()
if reference_url is None:
br = self._bzrdir.open_branch(ignore_fallbacks=True)
format = br._format.network_name()
return SuccessfulSmartServerResponse(('branch', format))
else:
return SuccessfulSmartServerResponse(('ref', reference_url))
except errors.NotBranchError, e:
return FailedSmartServerResponse(('nobranch',))
class SmartServerRequestOpenBranchV3(SmartServerRequestBzrDir):
def do_bzrdir_request(self):
"""Open a branch at path and return the reference or format.
This version introduced in 2.1.
Differences to SmartServerRequestOpenBranchV2:
* can return 2-element ('nobranch', extra), where 'extra' is a string
with an explanation like 'location is a repository'. Previously
a 'nobranch' response would never have more than one element.
"""
try:
reference_url = self._bzrdir.get_branch_reference()
if reference_url is None:
br = self._bzrdir.open_branch(ignore_fallbacks=True)
format = br._format.network_name()
return SuccessfulSmartServerResponse(('branch', format))
else:
return SuccessfulSmartServerResponse(('ref', reference_url))
except errors.NotBranchError, e:
# Stringify the exception so that its .detail attribute will be
# filled out.
str(e)
resp = ('nobranch',)
detail = e.detail
if detail:
if detail.startswith(': '):
detail = detail[2:]
resp += (detail,)
return FailedSmartServerResponse(resp)
|