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 SmartServerBranchRequestSetLastRevisionInfo(
132
SmartServerLockedBranchRequest):
133
"""Branch.set_last_revision_info. Sets the revno and the revision ID of
134
the specified branch.
139
def do_with_locked_branch(self, branch, new_revno, new_last_revision_id):
141
branch.set_last_revision_info(int(new_revno), new_last_revision_id)
142
except errors.NoSuchRevision:
143
return FailedSmartServerResponse(
144
('NoSuchRevision', new_last_revision_id))
145
return SuccessfulSmartServerResponse(('ok',))
148
class SmartServerBranchRequestLockWrite(SmartServerBranchRequest):
150
def do_with_branch(self, branch, branch_token='', repo_token=''):
151
if branch_token == '':
156
repo_token = branch.repository.lock_write(token=repo_token)
158
branch_token = branch.lock_write(token=branch_token)
160
# this leaves the repository with 1 lock
161
branch.repository.unlock()
162
except errors.LockContention:
163
return FailedSmartServerResponse(('LockContention',))
164
except errors.TokenMismatch:
165
return FailedSmartServerResponse(('TokenMismatch',))
166
except errors.UnlockableTransport:
167
return FailedSmartServerResponse(('UnlockableTransport',))
168
except errors.LockFailed, e:
169
return FailedSmartServerResponse(('LockFailed', str(e.lock), str(e.why)))
170
if repo_token is None:
173
branch.repository.leave_lock_in_place()
174
branch.leave_lock_in_place()
176
return SuccessfulSmartServerResponse(('ok', branch_token, repo_token))
179
class SmartServerBranchRequestUnlock(SmartServerBranchRequest):
181
def do_with_branch(self, branch, branch_token, repo_token):
183
branch.repository.lock_write(token=repo_token)
185
branch.lock_write(token=branch_token)
187
branch.repository.unlock()
188
except errors.TokenMismatch:
189
return FailedSmartServerResponse(('TokenMismatch',))
191
branch.repository.dont_leave_lock_in_place()
192
branch.dont_leave_lock_in_place()
194
return SuccessfulSmartServerResponse(('ok',))
added
removed
bzrlib/smart/branch.py
