17
17
"""Server-side branch related request implmentations."""
19
from __future__ import absolute_import
20
from bzrlib import errors
21
from bzrlib.bzrdir import BzrDir
22
from bzrlib.smart.request import (
24
revision as _mod_revision,
26
from ...controldir import ControlDir
27
from ...sixish import text_type
28
from .request import (
23
29
FailedSmartServerResponse,
24
30
SmartServerRequest,
25
31
SuccessfulSmartServerResponse,
42
48
:return: A SmartServerResponse from self.do_with_branch().
44
50
transport = self.transport_from_client_path(path)
45
bzrdir = BzrDir.open_from_transport(transport)
46
if bzrdir.get_branch_reference() is not None:
51
controldir = ControlDir.open_from_transport(transport)
52
if controldir.get_branch_reference() is not None:
47
53
raise errors.NotBranchError(transport.base)
48
branch = bzrdir.open_branch(ignore_fallbacks=True)
54
branch = controldir.open_branch(ignore_fallbacks=True)
49
55
return self.do_with_branch(branch, *args)
62
68
processed. The physical lock state won't be changed.
64
70
# XXX: write a test for LockContention
65
branch.repository.lock_write(token=repo_token)
67
branch.lock_write(token=branch_token)
71
with branch.repository.lock_write(token=repo_token), \
72
branch.lock_write(token=branch_token):
69
73
return self.do_with_locked_branch(branch, *args)
73
branch.repository.unlock()
76
class SmartServerBranchBreakLock(SmartServerBranchRequest):
78
def do_with_branch(self, branch):
79
"""Break a branch lock.
82
return SuccessfulSmartServerResponse((b'ok', ), )
76
85
class SmartServerBranchGetConfigFile(SmartServerBranchRequest):
81
90
The body is not utf8 decoded - its the literal bytestream from disk.
84
content = branch._transport.get_bytes('branch.conf')
93
content = branch.control_transport.get_bytes('branch.conf')
85
94
except errors.NoSuchFile:
87
return SuccessfulSmartServerResponse( ('ok', ), content)
96
return SuccessfulSmartServerResponse((b'ok', ), content)
99
class SmartServerBranchPutConfigFile(SmartServerBranchRequest):
100
"""Set the configuration data for a branch.
105
def do_with_branch(self, branch, branch_token, repo_token):
106
"""Set the content of branch.conf.
108
The body is not utf8 decoded - its the literal bytestream for disk.
110
self._branch = branch
111
self._branch_token = branch_token
112
self._repo_token = repo_token
113
# Signal we want a body
116
def do_body(self, body_bytes):
117
with self._branch.repository.lock_write(token=self._repo_token), \
118
self._branch.lock_write(token=self._branch_token):
119
self._branch.control_transport.put_bytes(
120
'branch.conf', body_bytes)
121
return SuccessfulSmartServerResponse((b'ok', ))
90
124
class SmartServerBranchGetParent(SmartServerBranchRequest):
139
173
self.branch.unlock()
176
class SmartServerBranchHeadsToFetch(SmartServerBranchRequest):
178
def do_with_branch(self, branch):
179
"""Return the heads-to-fetch for a Branch as two bencoded lists.
181
See Branch.heads_to_fetch.
185
must_fetch, if_present_fetch = branch.heads_to_fetch()
186
return SuccessfulSmartServerResponse(
187
(list(must_fetch), list(if_present_fetch)))
142
190
class SmartServerBranchRequestGetStackedOnURL(SmartServerBranchRequest):
144
192
def do_with_branch(self, branch):
145
193
stacked_on_url = branch.get_stacked_on_url()
146
return SuccessfulSmartServerResponse(('ok', stacked_on_url))
194
return SuccessfulSmartServerResponse((b'ok', stacked_on_url.encode('ascii')))
149
197
class SmartServerRequestRevisionHistory(SmartServerBranchRequest):
154
202
The revision list is returned as the body content,
155
203
with each revision utf8 encoded and \x00 joined.
205
with branch.lock_read():
206
graph = branch.repository.get_graph()
207
stop_revisions = (None, _mod_revision.NULL_REVISION)
208
history = list(graph.iter_lefthand_ancestry(
209
branch.last_revision(), stop_revisions))
157
210
return SuccessfulSmartServerResponse(
158
('ok', ), ('\x00'.join(branch.revision_history())))
211
(b'ok', ), (b'\x00'.join(reversed(history))))
161
214
class SmartServerBranchRequestLastRevisionInfo(SmartServerBranchRequest):
166
219
The revno is encoded in decimal, the revision_id is encoded as utf8.
168
221
revno, last_revision = branch.last_revision_info()
169
return SuccessfulSmartServerResponse(('ok', str(revno), last_revision))
222
return SuccessfulSmartServerResponse(
223
(b'ok', str(revno).encode('ascii'), last_revision))
226
class SmartServerBranchRequestRevisionIdToRevno(SmartServerBranchRequest):
228
def do_with_branch(self, branch, revid):
229
"""Return branch.revision_id_to_revno().
233
The revno is encoded in decimal, the revision_id is encoded as utf8.
236
dotted_revno = branch.revision_id_to_dotted_revno(revid)
237
except errors.NoSuchRevision:
238
return FailedSmartServerResponse((b'NoSuchRevision', revid))
239
return SuccessfulSmartServerResponse(
240
(b'ok', ) + tuple([b'%d' % x for x in dotted_revno]))
172
243
class SmartServerSetTipRequest(SmartServerLockedBranchRequest):
177
248
def do_with_locked_branch(self, branch, *args):
179
250
return self.do_tip_change_with_locked_branch(branch, *args)
180
except errors.TipChangeRejected, e:
251
except errors.TipChangeRejected as e:
182
if isinstance(msg, unicode):
253
if isinstance(msg, text_type):
183
254
msg = msg.encode('utf-8')
184
return FailedSmartServerResponse(('TipChangeRejected', msg))
255
return FailedSmartServerResponse((b'TipChangeRejected', msg))
187
258
class SmartServerBranchRequestSetConfigOption(SmartServerLockedBranchRequest):
190
261
def do_with_locked_branch(self, branch, value, name, section):
193
branch._get_config().set_option(value.decode('utf8'), name, section)
264
branch._get_config().set_option(
265
value.decode('utf-8'), name.decode('utf-8'),
266
section.decode('utf-8') if section is not None else None)
267
return SuccessfulSmartServerResponse(())
270
class SmartServerBranchRequestSetConfigOptionDict(SmartServerLockedBranchRequest):
271
"""Set an option in the branch configuration.
276
def do_with_locked_branch(self, branch, value_dict, name, section):
277
utf8_dict = bencode.bdecode(value_dict)
279
for key, value in utf8_dict.items():
280
value_dict[key.decode('utf8')] = value.decode('utf8')
284
section = section.decode('utf-8')
285
branch._get_config().set_option(value_dict, name.decode('utf-8'), section)
194
286
return SuccessfulSmartServerResponse(())
197
289
class SmartServerBranchRequestSetLastRevision(SmartServerSetTipRequest):
199
291
def do_tip_change_with_locked_branch(self, branch, new_last_revision_id):
200
if new_last_revision_id == 'null:':
201
branch.set_revision_history([])
292
if new_last_revision_id == b'null:':
293
branch.set_last_revision_info(0, new_last_revision_id)
203
295
if not branch.repository.has_revision(new_last_revision_id):
204
296
return FailedSmartServerResponse(
205
('NoSuchRevision', new_last_revision_id))
206
branch.set_revision_history(branch._lefthand_history(
207
new_last_revision_id, None, None))
208
return SuccessfulSmartServerResponse(('ok',))
297
(b'NoSuchRevision', new_last_revision_id))
298
branch.generate_revision_history(new_last_revision_id, None, None)
299
return SuccessfulSmartServerResponse((b'ok',))
211
302
class SmartServerBranchRequestSetLastRevisionEx(SmartServerSetTipRequest):
242
333
relation = branch._revision_relations(
243
334
last_rev, new_last_revision_id, graph)
244
335
if relation == 'diverged' and not allow_divergence:
245
return FailedSmartServerResponse(('Diverged',))
336
return FailedSmartServerResponse((b'Diverged',))
246
337
if relation == 'a_descends_from_b' and do_not_overwrite_descendant:
247
338
return SuccessfulSmartServerResponse(
248
('ok', last_revno, last_rev))
339
(b'ok', last_revno, last_rev))
249
340
new_revno = graph.find_distance_to_null(
250
341
new_last_revision_id, [(last_rev, last_revno)])
251
342
branch.set_last_revision_info(new_revno, new_last_revision_id)
252
343
except errors.GhostRevisionsHaveNoRevno:
253
344
return FailedSmartServerResponse(
254
('NoSuchRevision', new_last_revision_id))
345
(b'NoSuchRevision', new_last_revision_id))
255
346
return SuccessfulSmartServerResponse(
256
('ok', new_revno, new_last_revision_id))
347
(b'ok', new_revno, new_last_revision_id))
259
350
class SmartServerBranchRequestSetLastRevisionInfo(SmartServerSetTipRequest):
260
351
"""Branch.set_last_revision_info. Sets the revno and the revision ID of
261
352
the specified branch.
266
357
def do_tip_change_with_locked_branch(self, branch, new_revno,
269
360
branch.set_last_revision_info(int(new_revno), new_last_revision_id)
270
361
except errors.NoSuchRevision:
271
362
return FailedSmartServerResponse(
272
('NoSuchRevision', new_last_revision_id))
273
return SuccessfulSmartServerResponse(('ok',))
363
(b'NoSuchRevision', new_last_revision_id))
364
return SuccessfulSmartServerResponse((b'ok',))
276
367
class SmartServerBranchRequestSetParentLocation(SmartServerLockedBranchRequest):
287
378
class SmartServerBranchRequestLockWrite(SmartServerBranchRequest):
289
def do_with_branch(self, branch, branch_token='', repo_token=''):
290
if branch_token == '':
380
def do_with_branch(self, branch, branch_token=b'', repo_token=b''):
381
if branch_token == b'':
291
382
branch_token = None
383
if repo_token == b'':
293
384
repo_token = None
295
repo_token = branch.repository.lock_write(token=repo_token)
386
repo_token = branch.repository.lock_write(
387
token=repo_token).repository_token
297
branch_token = branch.lock_write(token=branch_token)
389
branch_token = branch.lock_write(
390
token=branch_token).token
299
392
# this leaves the repository with 1 lock
300
393
branch.repository.unlock()
301
394
except errors.LockContention:
302
return FailedSmartServerResponse(('LockContention',))
395
return FailedSmartServerResponse((b'LockContention',))
303
396
except errors.TokenMismatch:
304
return FailedSmartServerResponse(('TokenMismatch',))
397
return FailedSmartServerResponse((b'TokenMismatch',))
305
398
except errors.UnlockableTransport:
306
return FailedSmartServerResponse(('UnlockableTransport',))
307
except errors.LockFailed, e:
308
return FailedSmartServerResponse(('LockFailed', str(e.lock), str(e.why)))
399
return FailedSmartServerResponse((b'UnlockableTransport',))
400
except errors.LockFailed as e:
401
return FailedSmartServerResponse((b'LockFailed', str(e.lock), str(e.why)))
309
402
if repo_token is None:
312
405
branch.repository.leave_lock_in_place()
313
406
branch.leave_lock_in_place()
315
return SuccessfulSmartServerResponse(('ok', branch_token, repo_token))
408
return SuccessfulSmartServerResponse((b'ok', branch_token, repo_token))
318
411
class SmartServerBranchRequestUnlock(SmartServerBranchRequest):
320
413
def do_with_branch(self, branch, branch_token, repo_token):
322
branch.repository.lock_write(token=repo_token)
415
with branch.repository.lock_write(token=repo_token):
324
416
branch.lock_write(token=branch_token)
326
branch.repository.unlock()
327
417
except errors.TokenMismatch:
328
return FailedSmartServerResponse(('TokenMismatch',))
418
return FailedSmartServerResponse((b'TokenMismatch',))
330
420
branch.repository.dont_leave_lock_in_place()
331
421
branch.dont_leave_lock_in_place()
333
return SuccessfulSmartServerResponse(('ok',))
423
return SuccessfulSmartServerResponse((b'ok',))
426
class SmartServerBranchRequestGetPhysicalLockStatus(SmartServerBranchRequest):
427
"""Get the physical lock status for a branch.
432
def do_with_branch(self, branch):
433
if branch.get_physical_lock_status():
434
return SuccessfulSmartServerResponse((b'yes',))
436
return SuccessfulSmartServerResponse((b'no',))