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.lock_write(tokens=(branch_token, repo_token))
57
return self.do_with_locked_branch(branch, *args)
62
class SmartServerBranchGetConfigFile(SmartServerBranchRequest):
64
def do_with_branch(self, branch):
65
"""Return the content of branch.control_files.get('branch.conf').
67
The body is not utf8 decoded - its the literal bytestream from disk.
70
content = branch.control_files.get('branch.conf').read()
71
except errors.NoSuchFile:
73
return SmartServerResponse( ('ok', ), content)
76
class SmartServerRequestRevisionHistory(SmartServerBranchRequest):
78
def do_with_branch(self, branch):
79
"""Get the revision history for the branch.
81
The revision list is returned as the body content,
82
with each revision utf8 encoded and \x00 joined.
84
return SmartServerResponse(('ok', ),
85
('\x00'.join(branch.revision_history())).encode('utf8'))
88
class SmartServerBranchRequestLastRevisionInfo(SmartServerBranchRequest):
90
def do_with_branch(self, branch):
91
"""Return branch.last_revision_info().
93
The revno is encoded in decimal, the revision_id is encoded as utf8.
95
revno, last_revision = branch.last_revision_info()
96
if last_revision == NULL_REVISION:
98
return SmartServerResponse(
99
('ok', str(revno), last_revision.encode('utf8')))
102
class SmartServerBranchRequestSetLastRevision(SmartServerLockedBranchRequest):
104
def do_with_locked_branch(self, branch, new_last_revision_id):
105
unicode_new_last_revision_id = new_last_revision_id.decode('utf-8') # XXX test
106
if new_last_revision_id == '':
107
branch.set_revision_history([])
109
if not branch.repository.has_revision(unicode_new_last_revision_id):
110
return SmartServerResponse(
111
('NoSuchRevision', new_last_revision_id))
112
branch.generate_revision_history(unicode_new_last_revision_id)
113
return SmartServerResponse(('ok',))
116
class SmartServerBranchRequestLockWrite(SmartServerBranchRequest):
118
def do_with_branch(self, branch, branch_token='', repo_token=''):
119
if branch_token == '':
123
tokens = (branch_token, repo_token)
124
if tokens == ('', ''):
127
branch_token, repo_token = branch.lock_write(tokens=tokens)
128
except errors.LockContention:
129
return SmartServerResponse(('LockContention',))
130
except errors.TokenMismatch:
131
return SmartServerResponse(('TokenMismatch',))
132
branch.repository.leave_lock_in_place()
133
branch.leave_lock_in_place()
135
return SmartServerResponse(('ok', branch_token, repo_token))
138
class SmartServerBranchRequestUnlock(SmartServerBranchRequest):
140
def do_with_branch(self, branch, branch_token, repo_token):
141
tokens = branch_token, repo_token
143
tokens = branch.lock_write(tokens=tokens)
144
except errors.TokenMismatch:
145
return SmartServerResponse(('TokenMismatch',))
146
branch.repository.dont_leave_lock_in_place()
147
branch.dont_leave_lock_in_place()
149
return SmartServerResponse(('ok',))
added
removed
bzrlib/smart/branch.py
