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 SmartServerRequestRevisionHistory(SmartServerBranchRequest):
97
def do_with_branch(self, branch):
98
"""Get the revision history for the branch.
100
The revision list is returned as the body content,
101
with each revision utf8 encoded and \x00 joined.
103
return SuccessfulSmartServerResponse(
104
('ok', ), ('\x00'.join(branch.revision_history())))
107
class SmartServerBranchRequestLastRevisionInfo(SmartServerBranchRequest):
109
def do_with_branch(self, branch):
110
"""Return branch.last_revision_info().
112
The revno is encoded in decimal, the revision_id is encoded as utf8.
114
revno, last_revision = branch.last_revision_info()
115
return SuccessfulSmartServerResponse(('ok', str(revno), last_revision))
118
class SmartServerBranchRequestSetLastRevision(SmartServerLockedBranchRequest):
120
def do_with_locked_branch(self, branch, new_last_revision_id):
121
if new_last_revision_id == 'null:':
122
branch.set_revision_history([])
124
if not branch.repository.has_revision(new_last_revision_id):
125
return FailedSmartServerResponse(
126
('NoSuchRevision', new_last_revision_id))
127
branch.generate_revision_history(new_last_revision_id)
128
return SuccessfulSmartServerResponse(('ok',))
131
class SmartServerBranchRequestSetLastRevisionEx(SmartServerLockedBranchRequest):
133
def do_with_locked_branch(self, branch, new_last_revision_id,
134
allow_divergence, allow_overwrite_descendant):
135
"""Set the last revision of the branch.
139
:param new_last_revision_id: the revision ID to set as the last
140
revision of the branch.
141
:param allow_divergence: A flag. If non-zero, change the revision ID
142
even if the new_last_revision_id's ancestry has diverged from the
143
current last revision. If zero, a 'Diverged' error will be
144
returned if new_last_revision_id is not a descendant of the current
146
:param allow_overwrite_descendant: A flag. If zero and
147
new_last_revision_id is not a descendant of the current last
148
revision, then the last revision will not be changed. If non-zero
149
and there is no divergence, then the last revision is always
152
:returns: on success, a tuple of ('ok', revno, revision_id), where
153
revno and revision_id are the new values of the current last
154
revision info. The revision_id might be different to the
155
new_last_revision_id if allow_overwrite_descendant was not set.
157
do_not_overwrite_descendant = not allow_overwrite_descendant
159
last_revno, last_rev = branch.last_revision_info()
160
graph = branch.repository.get_graph()
161
if not allow_divergence or do_not_overwrite_descendant:
162
relation = branch._revision_relations(
163
last_rev, new_last_revision_id, graph)
164
if relation == 'diverged' and not allow_divergence:
165
return FailedSmartServerResponse(('Diverged',))
166
if relation == 'a_descends_from_b' and do_not_overwrite_descendant:
167
return SuccessfulSmartServerResponse(
168
('ok', last_revno, last_rev))
169
new_revno = graph.find_distance_to_null(
170
new_last_revision_id, [(last_rev, last_revno)])
171
branch.set_last_revision_info(new_revno, new_last_revision_id)
172
except errors.GhostRevisionsHaveNoRevno:
173
return FailedSmartServerResponse(
174
('NoSuchRevision', new_last_revision_id))
175
return SuccessfulSmartServerResponse(
176
('ok', new_revno, new_last_revision_id))
179
class SmartServerBranchRequestSetLastRevisionInfo(
180
SmartServerLockedBranchRequest):
181
"""Branch.set_last_revision_info. Sets the revno and the revision ID of
182
the specified branch.
187
def do_with_locked_branch(self, branch, new_revno, new_last_revision_id):
189
branch.set_last_revision_info(int(new_revno), new_last_revision_id)
190
except errors.NoSuchRevision:
191
return FailedSmartServerResponse(
192
('NoSuchRevision', new_last_revision_id))
193
return SuccessfulSmartServerResponse(('ok',))
196
class SmartServerBranchRequestLockWrite(SmartServerBranchRequest):
198
def do_with_branch(self, branch, branch_token='', repo_token=''):
199
if branch_token == '':
204
repo_token = branch.repository.lock_write(token=repo_token)
206
branch_token = branch.lock_write(token=branch_token)
208
# this leaves the repository with 1 lock
209
branch.repository.unlock()
210
except errors.LockContention:
211
return FailedSmartServerResponse(('LockContention',))
212
except errors.TokenMismatch:
213
return FailedSmartServerResponse(('TokenMismatch',))
214
except errors.UnlockableTransport:
215
return FailedSmartServerResponse(('UnlockableTransport',))
216
except errors.LockFailed, e:
217
return FailedSmartServerResponse(('LockFailed', str(e.lock), str(e.why)))
218
if repo_token is None:
221
branch.repository.leave_lock_in_place()
222
branch.leave_lock_in_place()
224
return SuccessfulSmartServerResponse(('ok', branch_token, repo_token))
227
class SmartServerBranchRequestUnlock(SmartServerBranchRequest):
229
def do_with_branch(self, branch, branch_token, repo_token):
231
branch.repository.lock_write(token=repo_token)
233
branch.lock_write(token=branch_token)
235
branch.repository.unlock()
236
except errors.TokenMismatch:
237
return FailedSmartServerResponse(('TokenMismatch',))
239
branch.repository.dont_leave_lock_in_place()
240
branch.dont_leave_lock_in_place()
242
return SuccessfulSmartServerResponse(('ok',))
added
removed
bzrlib/smart/branch.py
