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.revision import NULL_REVISION
23
from bzrlib.smart.request import SmartServerRequest, SmartServerResponse
26
class SmartServerBranchRequest(SmartServerRequest):
27
"""Base class for handling common branch request logic."""
29
def do(self, path, *args):
30
"""Execute a request for a branch at path.
32
If the branch is a branch reference, NotBranchError is raised.
34
transport = self._backing_transport.clone(path)
35
bzrdir = BzrDir.open_from_transport(transport)
36
if bzrdir.get_branch_reference() is not None:
37
raise errors.NotBranchError(transport.base)
38
branch = bzrdir.open_branch()
39
return self.do_with_branch(branch, *args)
42
class SmartServerLockedBranchRequest(SmartServerBranchRequest):
43
"""Base class for handling common branch request logic for requests that
47
def do_with_branch(self, branch, branch_token, repo_token, *args):
48
"""Execute a request for a branch.
50
A write lock will be acquired with the given tokens for the branch and
51
repository locks. The lock will be released once the request is
52
processed. The physical lock state won't be changed.
54
# XXX: write a test for LockContention
55
branch.repository.lock_write(token=repo_token)
57
branch.lock_write(token=branch_token)
59
return self.do_with_locked_branch(branch, *args)
63
branch.repository.unlock()
66
class SmartServerBranchGetConfigFile(SmartServerBranchRequest):
68
def do_with_branch(self, branch):
69
"""Return the content of branch.control_files.get('branch.conf').
71
The body is not utf8 decoded - its the literal bytestream from disk.
74
content = branch.control_files.get('branch.conf').read()
75
except errors.NoSuchFile:
77
return SmartServerResponse( ('ok', ), content)
80
class SmartServerRequestRevisionHistory(SmartServerBranchRequest):
82
def do_with_branch(self, branch):
83
"""Get the revision history for the branch.
85
The revision list is returned as the body content,
86
with each revision utf8 encoded and \x00 joined.
88
return SmartServerResponse(
89
('ok', ), ('\x00'.join(branch.revision_history())))
92
class SmartServerBranchRequestLastRevisionInfo(SmartServerBranchRequest):
94
def do_with_branch(self, branch):
95
"""Return branch.last_revision_info().
97
The revno is encoded in decimal, the revision_id is encoded as utf8.
99
revno, last_revision = branch.last_revision_info()
100
if last_revision == NULL_REVISION:
102
return SmartServerResponse(('ok', str(revno), last_revision))
105
class SmartServerBranchRequestSetLastRevision(SmartServerLockedBranchRequest):
107
def do_with_locked_branch(self, branch, new_last_revision_id):
108
if new_last_revision_id == '':
109
branch.set_revision_history([])
111
if not branch.repository.has_revision(new_last_revision_id):
112
return SmartServerResponse(
113
('NoSuchRevision', new_last_revision_id))
114
branch.generate_revision_history(new_last_revision_id)
115
return SmartServerResponse(('ok',))
118
class SmartServerBranchRequestLockWrite(SmartServerBranchRequest):
120
def do_with_branch(self, branch, branch_token='', repo_token=''):
121
if branch_token == '':
126
repo_token = branch.repository.lock_write(token=repo_token)
128
branch_token = branch.lock_write(token=branch_token)
130
branch.repository.unlock()
131
except errors.LockContention:
132
return SmartServerResponse(('LockContention',))
133
except errors.TokenMismatch:
134
return SmartServerResponse(('TokenMismatch',))
135
except errors.UnlockableTransport:
136
return SmartServerResponse(('UnlockableTransport',))
137
branch.repository.leave_lock_in_place()
138
branch.leave_lock_in_place()
140
return SmartServerResponse(('ok', branch_token, repo_token))
143
class SmartServerBranchRequestUnlock(SmartServerBranchRequest):
145
def do_with_branch(self, branch, branch_token, repo_token):
147
branch.repository.lock_write(token=repo_token)
149
branch.lock_write(token=branch_token)
151
branch.repository.unlock()
152
except errors.TokenMismatch:
153
return SmartServerResponse(('TokenMismatch',))
154
branch.repository.dont_leave_lock_in_place()
155
branch.dont_leave_lock_in_place()
157
return SmartServerResponse(('ok',))