1
# protocol.py -- Shared parts of the git protocols
2
# Copryight (C) 2008 John Carr <john.carr@unrouted.co.uk>
3
# Copyright (C) 2008 Jelmer Vernooij <jelmer@samba.org>
5
# This program is free software; you can redistribute it and/or
6
# modify it under the terms of the GNU General Public License
7
# as published by the Free Software Foundation; version 2
8
# or (at your option) any later version of the License.
10
# This program is distributed in the hope that it will be useful,
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
# GNU General Public License for more details.
15
# You should have received a copy of the GNU General Public License
16
# along with this program; if not, write to the Free Software
17
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
20
from errors import HangupException
24
class ProtocolFile(object):
26
Some network ops are like file ops. The file ops expect to operate on
27
file objects, so provide them with a dummy file.
30
def __init__(self, read, write):
41
class Protocol(object):
43
def __init__(self, read, write):
47
def read_pkt_line(self):
49
Reads a 'pkt line' from the remote git process
51
:return: The next string from the stream
53
sizestr = self.read(4)
55
raise HangupException()
56
size = int(sizestr, 16)
59
return self.read(size-4)
61
def read_pkt_seq(self):
62
pkt = self.read_pkt_line()
65
pkt = self.read_pkt_line()
67
def write_pkt_line(self, line):
69
Sends a 'pkt line' to the remote git process
71
:param line: A string containing the data to send
76
self.write("%04x%s" % (len(line)+4, line))
78
def write_sideband(self, channel, blob):
80
Write data to the sideband (a git multiplexing method)
82
:param channel: int specifying which channel to write to
83
:param blob: a blob of data (as a string) to send on this channel
85
# a pktline can be a max of 65520. a sideband line can therefore be
87
# WTF: Why have the len in ASCII, but the channel in binary.
89
self.write_pkt_line("%s%s" % (chr(channel), blob[:65515]))
92
def send_cmd(self, cmd, *args):
94
Send a command and some arguments to a git server
98
:param cmd: The remote service to access
99
:param args: List of arguments to send to remove service
101
self.write_pkt_line("%s %s" % (cmd, "".join(["%s\0" % a for a in args])))
105
Read a command and some arguments from the git client
109
:return: A tuple of (command, [list of arguments])
111
line = self.read_pkt_line()
112
splice_at = line.find(" ")
113
cmd, args = line[:splice_at], line[splice_at+1:]
114
return cmd, args.split(chr(0))
117
def extract_capabilities(text):
120
capabilities = text.split("\0")
121
return (capabilities[0], capabilities[1:])