1
# Copyright (C) 2006 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""Server-side branch related request implmentations."""
20
from bzrlib import errors
21
from bzrlib.bzrdir import BzrDir
22
from bzrlib.smart.request import (
23
FailedSmartServerResponse,
25
SuccessfulSmartServerResponse,
29
class SmartServerBranchRequest(SmartServerRequest):
30
"""Base class for handling common branch request logic.
33
def do(self, path, *args):
34
"""Execute a request for a branch at path.
36
All Branch requests take a path to the branch as their first argument.
38
If the branch is a branch reference, NotBranchError is raised.
40
:param path: The path for the repository as received from the
42
:return: A SmartServerResponse from self.do_with_branch().
44
transport = self.transport_from_client_path(path)
45
bzrdir = BzrDir.open_from_transport(transport)
46
if bzrdir.get_branch_reference() is not None:
47
raise errors.NotBranchError(transport.base)
48
branch = bzrdir.open_branch()
49
return self.do_with_branch(branch, *args)
52
class SmartServerLockedBranchRequest(SmartServerBranchRequest):
53
"""Base class for handling common branch request logic for requests that
57
def do_with_branch(self, branch, branch_token, repo_token, *args):
58
"""Execute a request for a branch.
60
A write lock will be acquired with the given tokens for the branch and
61
repository locks. The lock will be released once the request is
62
processed. The physical lock state won't be changed.
64
# XXX: write a test for LockContention
65
branch.repository.lock_write(token=repo_token)
67
branch.lock_write(token=branch_token)
69
return self.do_with_locked_branch(branch, *args)
73
branch.repository.unlock()
76
class SmartServerBranchGetConfigFile(SmartServerBranchRequest):
78
def do_with_branch(self, branch):
79
"""Return the content of branch.conf
81
The body is not utf8 decoded - its the literal bytestream from disk.
83
# This was at one time called by RemoteBranchLockableFiles
84
# intercepting access to this file; as of 1.5 it is not called by the
85
# client but retained for compatibility. It may be called again to
86
# allow the client to get the configuration without needing vfs
89
content = branch._transport.get_bytes('branch.conf')
90
except errors.NoSuchFile:
92
return SuccessfulSmartServerResponse( ('ok', ), content)
95
class SmartServerBranchRequestGetStackedOnURL(SmartServerBranchRequest):
97
def do_with_branch(self, branch):
98
stacked_on_url = branch.get_stacked_on_url()
99
return SuccessfulSmartServerResponse(('ok', stacked_on_url))
102
class SmartServerRequestRevisionHistory(SmartServerBranchRequest):
104
def do_with_branch(self, branch):
105
"""Get the revision history for the branch.
107
The revision list is returned as the body content,
108
with each revision utf8 encoded and \x00 joined.
110
return SuccessfulSmartServerResponse(
111
('ok', ), ('\x00'.join(branch.revision_history())))
114
class SmartServerBranchRequestLastRevisionInfo(SmartServerBranchRequest):
116
def do_with_branch(self, branch):
117
"""Return branch.last_revision_info().
119
The revno is encoded in decimal, the revision_id is encoded as utf8.
121
revno, last_revision = branch.last_revision_info()
122
return SuccessfulSmartServerResponse(('ok', str(revno), last_revision))
125
class SmartServerSetTipRequest(SmartServerLockedBranchRequest):
126
"""Base class for handling common branch request logic for requests that
127
update the branch tip.
130
def do_with_locked_branch(self, branch, *args):
132
return self.do_tip_change_with_locked_branch(branch, *args)
133
except errors.TipChangeRejected, e:
135
if isinstance(msg, unicode):
136
msg = msg.encode('utf-8')
137
return FailedSmartServerResponse(('TipChangeRejected', msg))
140
class SmartServerBranchRequestSetLastRevision(SmartServerSetTipRequest):
142
def do_tip_change_with_locked_branch(self, branch, new_last_revision_id):
143
if new_last_revision_id == 'null:':
144
branch.set_revision_history([])
146
if not branch.repository.has_revision(new_last_revision_id):
147
return FailedSmartServerResponse(
148
('NoSuchRevision', new_last_revision_id))
149
branch.set_revision_history(branch._lefthand_history(
150
new_last_revision_id, None, None))
151
return SuccessfulSmartServerResponse(('ok',))
154
class SmartServerBranchRequestSetLastRevisionEx(SmartServerSetTipRequest):
156
def do_tip_change_with_locked_branch(self, branch, new_last_revision_id,
157
allow_divergence, allow_overwrite_descendant):
158
"""Set the last revision of the branch.
162
:param new_last_revision_id: the revision ID to set as the last
163
revision of the branch.
164
:param allow_divergence: A flag. If non-zero, change the revision ID
165
even if the new_last_revision_id's ancestry has diverged from the
166
current last revision. If zero, a 'Diverged' error will be
167
returned if new_last_revision_id is not a descendant of the current
169
:param allow_overwrite_descendant: A flag. If zero and
170
new_last_revision_id is not a descendant of the current last
171
revision, then the last revision will not be changed. If non-zero
172
and there is no divergence, then the last revision is always
175
:returns: on success, a tuple of ('ok', revno, revision_id), where
176
revno and revision_id are the new values of the current last
177
revision info. The revision_id might be different to the
178
new_last_revision_id if allow_overwrite_descendant was not set.
180
do_not_overwrite_descendant = not allow_overwrite_descendant
182
last_revno, last_rev = branch.last_revision_info()
183
graph = branch.repository.get_graph()
184
if not allow_divergence or do_not_overwrite_descendant:
185
relation = branch._revision_relations(
186
last_rev, new_last_revision_id, graph)
187
if relation == 'diverged' and not allow_divergence:
188
return FailedSmartServerResponse(('Diverged',))
189
if relation == 'a_descends_from_b' and do_not_overwrite_descendant:
190
return SuccessfulSmartServerResponse(
191
('ok', last_revno, last_rev))
192
new_revno = graph.find_distance_to_null(
193
new_last_revision_id, [(last_rev, last_revno)])
194
branch.set_last_revision_info(new_revno, new_last_revision_id)
195
except errors.GhostRevisionsHaveNoRevno:
196
return FailedSmartServerResponse(
197
('NoSuchRevision', new_last_revision_id))
198
return SuccessfulSmartServerResponse(
199
('ok', new_revno, new_last_revision_id))
202
class SmartServerBranchRequestSetLastRevisionInfo(SmartServerSetTipRequest):
203
"""Branch.set_last_revision_info. Sets the revno and the revision ID of
204
the specified branch.
209
def do_tip_change_with_locked_branch(self, branch, new_revno,
210
new_last_revision_id):
212
branch.set_last_revision_info(int(new_revno), new_last_revision_id)
213
except errors.NoSuchRevision:
214
return FailedSmartServerResponse(
215
('NoSuchRevision', new_last_revision_id))
216
return SuccessfulSmartServerResponse(('ok',))
219
class SmartServerBranchRequestLockWrite(SmartServerBranchRequest):
221
def do_with_branch(self, branch, branch_token='', repo_token=''):
222
if branch_token == '':
227
repo_token = branch.repository.lock_write(token=repo_token)
229
branch_token = branch.lock_write(token=branch_token)
231
# this leaves the repository with 1 lock
232
branch.repository.unlock()
233
except errors.LockContention:
234
return FailedSmartServerResponse(('LockContention',))
235
except errors.TokenMismatch:
236
return FailedSmartServerResponse(('TokenMismatch',))
237
except errors.UnlockableTransport:
238
return FailedSmartServerResponse(('UnlockableTransport',))
239
except errors.LockFailed, e:
240
return FailedSmartServerResponse(('LockFailed', str(e.lock), str(e.why)))
241
if repo_token is None:
244
branch.repository.leave_lock_in_place()
245
branch.leave_lock_in_place()
247
return SuccessfulSmartServerResponse(('ok', branch_token, repo_token))
250
class SmartServerBranchRequestUnlock(SmartServerBranchRequest):
252
def do_with_branch(self, branch, branch_token, repo_token):
254
branch.repository.lock_write(token=repo_token)
256
branch.lock_write(token=branch_token)
258
branch.repository.unlock()
259
except errors.TokenMismatch:
260
return FailedSmartServerResponse(('TokenMismatch',))
262
branch.repository.dont_leave_lock_in_place()
263
branch.dont_leave_lock_in_place()
265
return SuccessfulSmartServerResponse(('ok',))
added
removed
bzrlib/smart/branch.py
