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 SmartServerRequest, SmartServerResponse
25
class SmartServerBranchRequest(SmartServerRequest):
26
"""Base class for handling common branch request logic."""
28
def do(self, path, *args):
29
"""Execute a request for a branch at path.
31
If the branch is a branch reference, NotBranchError is raised.
33
transport = self._backing_transport.clone(path)
34
bzrdir = BzrDir.open_from_transport(transport)
35
if bzrdir.get_branch_reference() is not None:
36
raise errors.NotBranchError(transport.base)
37
branch = bzrdir.open_branch()
38
return self.do_with_branch(branch, *args)
41
class SmartServerLockedBranchRequest(SmartServerBranchRequest):
42
"""Base class for handling common branch request logic for requests that
46
def do_with_branch(self, branch, branch_token, repo_token, *args):
47
"""Execute a request for a branch.
49
A write lock will be acquired with the given tokens for the branch and
50
repository locks. The lock will be released once the request is
51
processed. The physical lock state won't be changed.
53
# XXX: write a test for LockContention
54
branch.repository.lock_write(token=repo_token)
56
branch.lock_write(token=branch_token)
58
return self.do_with_locked_branch(branch, *args)
62
branch.repository.unlock()
65
class SmartServerBranchGetConfigFile(SmartServerBranchRequest):
67
def do_with_branch(self, branch):
68
"""Return the content of branch.control_files.get('branch.conf').
70
The body is not utf8 decoded - its the literal bytestream from disk.
73
content = branch.control_files.get('branch.conf').read()
74
except errors.NoSuchFile:
76
return SmartServerResponse( ('ok', ), content)
79
class SmartServerRequestRevisionHistory(SmartServerBranchRequest):
81
def do_with_branch(self, branch):
82
"""Get the revision history for the branch.
84
The revision list is returned as the body content,
85
with each revision utf8 encoded and \x00 joined.
87
return SmartServerResponse(
88
('ok', ), ('\x00'.join(branch.revision_history())))
91
class SmartServerBranchRequestLastRevisionInfo(SmartServerBranchRequest):
93
def do_with_branch(self, branch):
94
"""Return branch.last_revision_info().
96
The revno is encoded in decimal, the revision_id is encoded as utf8.
98
revno, last_revision = branch.last_revision_info()
99
return SmartServerResponse(('ok', str(revno), last_revision))
102
class SmartServerBranchRequestSetLastRevision(SmartServerLockedBranchRequest):
104
def do_with_locked_branch(self, branch, new_last_revision_id):
105
if new_last_revision_id == 'null:':
106
branch.set_revision_history([])
108
if not branch.repository.has_revision(new_last_revision_id):
109
return SmartServerResponse(
110
('NoSuchRevision', new_last_revision_id))
111
branch.generate_revision_history(new_last_revision_id)
112
return SmartServerResponse(('ok',))
115
class SmartServerBranchRequestLockWrite(SmartServerBranchRequest):
117
def do_with_branch(self, branch, branch_token='', repo_token=''):
118
if branch_token == '':
123
repo_token = branch.repository.lock_write(token=repo_token)
125
branch_token = branch.lock_write(token=branch_token)
127
branch.repository.unlock()
128
except errors.LockContention:
129
return SmartServerResponse(('LockContention',))
130
except errors.TokenMismatch:
131
return SmartServerResponse(('TokenMismatch',))
132
except errors.UnlockableTransport:
133
return SmartServerResponse(('UnlockableTransport',))
134
branch.repository.leave_lock_in_place()
135
branch.leave_lock_in_place()
137
return SmartServerResponse(('ok', branch_token, repo_token))
140
class SmartServerBranchRequestUnlock(SmartServerBranchRequest):
142
def do_with_branch(self, branch, branch_token, repo_token):
144
branch.repository.lock_write(token=repo_token)
146
branch.lock_write(token=branch_token)
148
branch.repository.unlock()
149
except errors.TokenMismatch:
150
return SmartServerResponse(('TokenMismatch',))
151
branch.repository.dont_leave_lock_in_place()
152
branch.dont_leave_lock_in_place()
154
return SmartServerResponse(('ok',))
added
removed
bzrlib/smart/branch.py
