/usr/lib/python2.7/dist-packages/bzrlib/smart/branch.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 | # 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 branch related request implmentations."""
from __future__ import absolute_import
from bzrlib import (
bencode,
errors,
revision as _mod_revision,
)
from bzrlib.controldir import ControlDir
from bzrlib.smart.request import (
FailedSmartServerResponse,
SmartServerRequest,
SuccessfulSmartServerResponse,
)
class SmartServerBranchRequest(SmartServerRequest):
"""Base class for handling common branch request logic.
"""
def do(self, path, *args):
"""Execute a request for a branch at path.
All Branch requests take a path to the branch as their first argument.
If the branch is a branch reference, NotBranchError is raised.
:param path: The path for the repository as received from the
client.
:return: A SmartServerResponse from self.do_with_branch().
"""
transport = self.transport_from_client_path(path)
controldir = ControlDir.open_from_transport(transport)
if controldir.get_branch_reference() is not None:
raise errors.NotBranchError(transport.base)
branch = controldir.open_branch(ignore_fallbacks=True)
return self.do_with_branch(branch, *args)
class SmartServerLockedBranchRequest(SmartServerBranchRequest):
"""Base class for handling common branch request logic for requests that
need a write lock.
"""
def do_with_branch(self, branch, branch_token, repo_token, *args):
"""Execute a request for a branch.
A write lock will be acquired with the given tokens for the branch and
repository locks. The lock will be released once the request is
processed. The physical lock state won't be changed.
"""
# XXX: write a test for LockContention
branch.repository.lock_write(token=repo_token)
try:
branch.lock_write(token=branch_token)
try:
return self.do_with_locked_branch(branch, *args)
finally:
branch.unlock()
finally:
branch.repository.unlock()
class SmartServerBranchBreakLock(SmartServerBranchRequest):
def do_with_branch(self, branch):
"""Break a branch lock.
"""
branch.break_lock()
return SuccessfulSmartServerResponse(('ok', ), )
class SmartServerBranchGetConfigFile(SmartServerBranchRequest):
def do_with_branch(self, branch):
"""Return the content of branch.conf
The body is not utf8 decoded - its the literal bytestream from disk.
"""
try:
content = branch.control_transport.get_bytes('branch.conf')
except errors.NoSuchFile:
content = ''
return SuccessfulSmartServerResponse( ('ok', ), content)
class SmartServerBranchPutConfigFile(SmartServerBranchRequest):
"""Set the configuration data for a branch.
New in 2.5.
"""
def do_with_branch(self, branch, branch_token, repo_token):
"""Set the content of branch.conf.
The body is not utf8 decoded - its the literal bytestream for disk.
"""
self._branch = branch
self._branch_token = branch_token
self._repo_token = repo_token
# Signal we want a body
return None
def do_body(self, body_bytes):
self._branch.repository.lock_write(token=self._repo_token)
try:
self._branch.lock_write(token=self._branch_token)
try:
self._branch.control_transport.put_bytes(
'branch.conf', body_bytes)
finally:
self._branch.unlock()
finally:
self._branch.repository.unlock()
return SuccessfulSmartServerResponse(('ok', ))
class SmartServerBranchGetParent(SmartServerBranchRequest):
def do_with_branch(self, branch):
"""Return the parent of branch."""
parent = branch._get_parent_location() or ''
return SuccessfulSmartServerResponse((parent,))
class SmartServerBranchGetTagsBytes(SmartServerBranchRequest):
def do_with_branch(self, branch):
"""Return the _get_tags_bytes for a branch."""
bytes = branch._get_tags_bytes()
return SuccessfulSmartServerResponse((bytes,))
class SmartServerBranchSetTagsBytes(SmartServerLockedBranchRequest):
def __init__(self, backing_transport, root_client_path='/', jail_root=None):
SmartServerLockedBranchRequest.__init__(
self, backing_transport, root_client_path, jail_root)
self.locked = False
def do_with_locked_branch(self, branch):
"""Call _set_tags_bytes for a branch.
New in 1.18.
"""
# We need to keep this branch locked until we get a body with the tags
# bytes.
self.branch = branch
self.branch.lock_write()
self.locked = True
def do_body(self, bytes):
self.branch._set_tags_bytes(bytes)
return SuccessfulSmartServerResponse(())
def do_end(self):
# TODO: this request shouldn't have to do this housekeeping manually.
# Some of this logic probably belongs in a base class.
if not self.locked:
# We never acquired the branch successfully in the first place, so
# there's nothing more to do.
return
try:
return SmartServerLockedBranchRequest.do_end(self)
finally:
# Only try unlocking if we locked successfully in the first place
self.branch.unlock()
class SmartServerBranchHeadsToFetch(SmartServerBranchRequest):
def do_with_branch(self, branch):
"""Return the heads-to-fetch for a Branch as two bencoded lists.
See Branch.heads_to_fetch.
New in 2.4.
"""
must_fetch, if_present_fetch = branch.heads_to_fetch()
return SuccessfulSmartServerResponse(
(list(must_fetch), list(if_present_fetch)))
class SmartServerBranchRequestGetStackedOnURL(SmartServerBranchRequest):
def do_with_branch(self, branch):
stacked_on_url = branch.get_stacked_on_url()
return SuccessfulSmartServerResponse(('ok', stacked_on_url))
class SmartServerRequestRevisionHistory(SmartServerBranchRequest):
def do_with_branch(self, branch):
"""Get the revision history for the branch.
The revision list is returned as the body content,
with each revision utf8 encoded and \x00 joined.
"""
branch.lock_read()
try:
graph = branch.repository.get_graph()
stop_revisions = (None, _mod_revision.NULL_REVISION)
history = list(graph.iter_lefthand_ancestry(
branch.last_revision(), stop_revisions))
finally:
branch.unlock()
return SuccessfulSmartServerResponse(
('ok', ), ('\x00'.join(reversed(history))))
class SmartServerBranchRequestLastRevisionInfo(SmartServerBranchRequest):
def do_with_branch(self, branch):
"""Return branch.last_revision_info().
The revno is encoded in decimal, the revision_id is encoded as utf8.
"""
revno, last_revision = branch.last_revision_info()
return SuccessfulSmartServerResponse(('ok', str(revno), last_revision))
class SmartServerBranchRequestRevisionIdToRevno(SmartServerBranchRequest):
def do_with_branch(self, branch, revid):
"""Return branch.revision_id_to_revno().
New in 2.5.
The revno is encoded in decimal, the revision_id is encoded as utf8.
"""
try:
dotted_revno = branch.revision_id_to_dotted_revno(revid)
except errors.NoSuchRevision:
return FailedSmartServerResponse(('NoSuchRevision', revid))
return SuccessfulSmartServerResponse(
('ok', ) + tuple(map(str, dotted_revno)))
class SmartServerSetTipRequest(SmartServerLockedBranchRequest):
"""Base class for handling common branch request logic for requests that
update the branch tip.
"""
def do_with_locked_branch(self, branch, *args):
try:
return self.do_tip_change_with_locked_branch(branch, *args)
except errors.TipChangeRejected, e:
msg = e.msg
if isinstance(msg, unicode):
msg = msg.encode('utf-8')
return FailedSmartServerResponse(('TipChangeRejected', msg))
class SmartServerBranchRequestSetConfigOption(SmartServerLockedBranchRequest):
"""Set an option in the branch configuration."""
def do_with_locked_branch(self, branch, value, name, section):
if not section:
section = None
branch._get_config().set_option(value.decode('utf8'), name, section)
return SuccessfulSmartServerResponse(())
class SmartServerBranchRequestSetConfigOptionDict(SmartServerLockedBranchRequest):
"""Set an option in the branch configuration.
New in 2.2.
"""
def do_with_locked_branch(self, branch, value_dict, name, section):
utf8_dict = bencode.bdecode(value_dict)
value_dict = {}
for key, value in utf8_dict.items():
value_dict[key.decode('utf8')] = value.decode('utf8')
if not section:
section = None
branch._get_config().set_option(value_dict, name, section)
return SuccessfulSmartServerResponse(())
class SmartServerBranchRequestSetLastRevision(SmartServerSetTipRequest):
def do_tip_change_with_locked_branch(self, branch, new_last_revision_id):
if new_last_revision_id == 'null:':
branch.set_last_revision_info(0, new_last_revision_id)
else:
if not branch.repository.has_revision(new_last_revision_id):
return FailedSmartServerResponse(
('NoSuchRevision', new_last_revision_id))
branch.generate_revision_history(new_last_revision_id, None, None)
return SuccessfulSmartServerResponse(('ok',))
class SmartServerBranchRequestSetLastRevisionEx(SmartServerSetTipRequest):
def do_tip_change_with_locked_branch(self, branch, new_last_revision_id,
allow_divergence, allow_overwrite_descendant):
"""Set the last revision of the branch.
New in 1.6.
:param new_last_revision_id: the revision ID to set as the last
revision of the branch.
:param allow_divergence: A flag. If non-zero, change the revision ID
even if the new_last_revision_id's ancestry has diverged from the
current last revision. If zero, a 'Diverged' error will be
returned if new_last_revision_id is not a descendant of the current
last revision.
:param allow_overwrite_descendant: A flag. If zero and
new_last_revision_id is not a descendant of the current last
revision, then the last revision will not be changed. If non-zero
and there is no divergence, then the last revision is always
changed.
:returns: on success, a tuple of ('ok', revno, revision_id), where
revno and revision_id are the new values of the current last
revision info. The revision_id might be different to the
new_last_revision_id if allow_overwrite_descendant was not set.
"""
do_not_overwrite_descendant = not allow_overwrite_descendant
try:
last_revno, last_rev = branch.last_revision_info()
graph = branch.repository.get_graph()
if not allow_divergence or do_not_overwrite_descendant:
relation = branch._revision_relations(
last_rev, new_last_revision_id, graph)
if relation == 'diverged' and not allow_divergence:
return FailedSmartServerResponse(('Diverged',))
if relation == 'a_descends_from_b' and do_not_overwrite_descendant:
return SuccessfulSmartServerResponse(
('ok', last_revno, last_rev))
new_revno = graph.find_distance_to_null(
new_last_revision_id, [(last_rev, last_revno)])
branch.set_last_revision_info(new_revno, new_last_revision_id)
except errors.GhostRevisionsHaveNoRevno:
return FailedSmartServerResponse(
('NoSuchRevision', new_last_revision_id))
return SuccessfulSmartServerResponse(
('ok', new_revno, new_last_revision_id))
class SmartServerBranchRequestSetLastRevisionInfo(SmartServerSetTipRequest):
"""Branch.set_last_revision_info. Sets the revno and the revision ID of
the specified branch.
New in bzrlib 1.4.
"""
def do_tip_change_with_locked_branch(self, branch, new_revno,
new_last_revision_id):
try:
branch.set_last_revision_info(int(new_revno), new_last_revision_id)
except errors.NoSuchRevision:
return FailedSmartServerResponse(
('NoSuchRevision', new_last_revision_id))
return SuccessfulSmartServerResponse(('ok',))
class SmartServerBranchRequestSetParentLocation(SmartServerLockedBranchRequest):
"""Set the parent location for a branch.
Takes a location to set, which must be utf8 encoded.
"""
def do_with_locked_branch(self, branch, location):
branch._set_parent_location(location)
return SuccessfulSmartServerResponse(())
class SmartServerBranchRequestLockWrite(SmartServerBranchRequest):
def do_with_branch(self, branch, branch_token='', repo_token=''):
if branch_token == '':
branch_token = None
if repo_token == '':
repo_token = None
try:
repo_token = branch.repository.lock_write(
token=repo_token).repository_token
try:
branch_token = branch.lock_write(
token=branch_token).branch_token
finally:
# this leaves the repository with 1 lock
branch.repository.unlock()
except errors.LockContention:
return FailedSmartServerResponse(('LockContention',))
except errors.TokenMismatch:
return FailedSmartServerResponse(('TokenMismatch',))
except errors.UnlockableTransport:
return FailedSmartServerResponse(('UnlockableTransport',))
except errors.LockFailed, e:
return FailedSmartServerResponse(('LockFailed', str(e.lock), str(e.why)))
if repo_token is None:
repo_token = ''
else:
branch.repository.leave_lock_in_place()
branch.leave_lock_in_place()
branch.unlock()
return SuccessfulSmartServerResponse(('ok', branch_token, repo_token))
class SmartServerBranchRequestUnlock(SmartServerBranchRequest):
def do_with_branch(self, branch, branch_token, repo_token):
try:
branch.repository.lock_write(token=repo_token)
try:
branch.lock_write(token=branch_token)
finally:
branch.repository.unlock()
except errors.TokenMismatch:
return FailedSmartServerResponse(('TokenMismatch',))
if repo_token:
branch.repository.dont_leave_lock_in_place()
branch.dont_leave_lock_in_place()
branch.unlock()
return SuccessfulSmartServerResponse(('ok',))
class SmartServerBranchRequestGetPhysicalLockStatus(SmartServerBranchRequest):
"""Get the physical lock status for a branch.
New in 2.5.
"""
def do_with_branch(self, branch):
if branch.get_physical_lock_status():
return SuccessfulSmartServerResponse(('yes',))
else:
return SuccessfulSmartServerResponse(('no',))
|