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."""
 
 
32
    def do(self, path, *args):
 
 
33
        """Execute a request for a branch at path.
 
 
35
        If the branch is a branch reference, NotBranchError is raised.
 
 
37
        transport = self._backing_transport.clone(path)
 
 
38
        bzrdir = BzrDir.open_from_transport(transport)
 
 
39
        if bzrdir.get_branch_reference() is not None:
 
 
40
            raise errors.NotBranchError(transport.base)
 
 
41
        branch = bzrdir.open_branch()
 
 
42
        return self.do_with_branch(branch, *args)
 
 
45
class SmartServerLockedBranchRequest(SmartServerBranchRequest):
 
 
46
    """Base class for handling common branch request logic for requests that
 
 
50
    def do_with_branch(self, branch, branch_token, repo_token, *args):
 
 
51
        """Execute a request for a branch.
 
 
53
        A write lock will be acquired with the given tokens for the branch and
 
 
54
        repository locks.  The lock will be released once the request is
 
 
55
        processed.  The physical lock state won't be changed.
 
 
57
        # XXX: write a test for LockContention
 
 
58
        branch.repository.lock_write(token=repo_token)
 
 
60
            branch.lock_write(token=branch_token)
 
 
62
                return self.do_with_locked_branch(branch, *args)
 
 
66
            branch.repository.unlock()
 
 
69
class SmartServerBranchGetConfigFile(SmartServerBranchRequest):
 
 
71
    def do_with_branch(self, branch):
 
 
72
        """Return the content of branch.control_files.get('branch.conf').
 
 
74
        The body is not utf8 decoded - its the literal bytestream from disk.
 
 
77
            content = branch.control_files.get('branch.conf').read()
 
 
78
        except errors.NoSuchFile:
 
 
80
        return SuccessfulSmartServerResponse( ('ok', ), content)
 
 
83
class SmartServerRequestRevisionHistory(SmartServerBranchRequest):
 
 
85
    def do_with_branch(self, branch):
 
 
86
        """Get the revision history for the branch.
 
 
88
        The revision list is returned as the body content,
 
 
89
        with each revision utf8 encoded and \x00 joined.
 
 
91
        return SuccessfulSmartServerResponse(
 
 
92
            ('ok', ), ('\x00'.join(branch.revision_history())))
 
 
95
class SmartServerBranchRequestLastRevisionInfo(SmartServerBranchRequest):
 
 
97
    def do_with_branch(self, branch):
 
 
98
        """Return branch.last_revision_info().
 
 
100
        The revno is encoded in decimal, the revision_id is encoded as utf8.
 
 
102
        revno, last_revision = branch.last_revision_info()
 
 
103
        return SuccessfulSmartServerResponse(('ok', str(revno), last_revision))
 
 
106
class SmartServerBranchRequestSetLastRevision(SmartServerLockedBranchRequest):
 
 
108
    def do_with_locked_branch(self, branch, new_last_revision_id):
 
 
109
        if new_last_revision_id == 'null:':
 
 
110
            branch.set_revision_history([])
 
 
112
            if not branch.repository.has_revision(new_last_revision_id):
 
 
113
                return FailedSmartServerResponse(
 
 
114
                    ('NoSuchRevision', new_last_revision_id))
 
 
115
            branch.generate_revision_history(new_last_revision_id)
 
 
116
        return SuccessfulSmartServerResponse(('ok',))
 
 
119
class SmartServerBranchRequestLockWrite(SmartServerBranchRequest):
 
 
121
    def do_with_branch(self, branch, branch_token='', repo_token=''):
 
 
122
        if branch_token == '':
 
 
127
            repo_token = branch.repository.lock_write(token=repo_token)
 
 
129
                branch_token = branch.lock_write(token=branch_token)
 
 
131
                # this leaves the repository with 1 lock
 
 
132
                branch.repository.unlock()
 
 
133
        except errors.LockContention:
 
 
134
            return FailedSmartServerResponse(('LockContention',))
 
 
135
        except errors.TokenMismatch:
 
 
136
            return FailedSmartServerResponse(('TokenMismatch',))
 
 
137
        except errors.UnlockableTransport:
 
 
138
            return FailedSmartServerResponse(('UnlockableTransport',))
 
 
139
        except errors.LockFailed, e:
 
 
140
            return FailedSmartServerResponse(('LockFailed', str(e.lock), str(e.why)))
 
 
141
        if repo_token is None:
 
 
144
            branch.repository.leave_lock_in_place()
 
 
145
        branch.leave_lock_in_place()
 
 
147
        return SuccessfulSmartServerResponse(('ok', branch_token, repo_token))
 
 
150
class SmartServerBranchRequestUnlock(SmartServerBranchRequest):
 
 
152
    def do_with_branch(self, branch, branch_token, repo_token):
 
 
154
            branch.repository.lock_write(token=repo_token)
 
 
156
                branch.lock_write(token=branch_token)
 
 
158
                branch.repository.unlock()
 
 
159
        except errors.TokenMismatch:
 
 
160
            return FailedSmartServerResponse(('TokenMismatch',))
 
 
162
            branch.repository.dont_leave_lock_in_place()
 
 
163
        branch.dont_leave_lock_in_place()
 
 
165
        return SuccessfulSmartServerResponse(('ok',))