# server.py -- Implementation of the server side git protocols
-# Copryight (C) 2008 John Carr <john.carr@unrouted.co.uk>
+# Copyright (C) 2008 John Carr <john.carr@unrouted.co.uk>
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; version 2
-# of the License.
+# or (at your option) any later version of the License.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
# MA 02110-1301, USA.
+"""Git smart network protocol server implementation.
+
+For more detailed implementation on the network protocol, see the
+Documentation/technical directory in the cgit distribution, and in particular:
+
+* Documentation/technical/protocol-capabilities.txt
+* Documentation/technical/pack-protocol.txt
+"""
+
+
+import collections
+import socket
import SocketServer
-from dulwich.protocol import Protocol, ProtocolFile, TCP_GIT_PORT, extract_capabilities
-from dulwich.repo import Repo
-from dulwich.pack import PackData, Pack, write_pack_data
-import os, sha, tempfile
+import sys
+import zlib
+
+from dulwich.errors import (
+ ApplyDeltaError,
+ ChecksumMismatch,
+ GitProtocolError,
+ UnexpectedCommandError,
+ ObjectFormatException,
+ )
+from dulwich import log_utils
+from dulwich.objects import (
+ hex_to_sha,
+ )
+from dulwich.pack import (
+ PackStreamReader,
+ write_pack_data,
+ )
+from dulwich.protocol import (
+ MULTI_ACK,
+ MULTI_ACK_DETAILED,
+ ProtocolFile,
+ ReceivableProtocol,
+ SINGLE_ACK,
+ TCP_GIT_PORT,
+ ZERO_SHA,
+ ack_type,
+ extract_capabilities,
+ extract_want_line_capabilities,
+ BufferedPktLineWriter,
+ )
+from dulwich.repo import (
+ Repo,
+ )
+
+
+logger = log_utils.getLogger(__name__)
+
class Backend(object):
+ """A backend for the Git smart server implementation."""
+
+ def open_repository(self, path):
+ """Open the repository at a path."""
+ raise NotImplementedError(self.open_repository)
+
+
+class BackendRepo(object):
+ """Repository abstraction used by the Git server.
+
+ Please note that the methods required here are a
+ subset of those provided by dulwich.repo.Repo.
+ """
+
+ object_store = None
+ refs = None
def get_refs(self):
"""
"""
raise NotImplementedError
- def apply_pack(self, refs, read):
- """ Import a set of changes into a repository and update the refs
+ def get_peeled(self, name):
+ """Return the cached peeled value of a ref, if available.
- :param refs: list of tuple(name, sha)
- :param read: callback to read from the incoming pack
+ :param name: Name of the ref to peel
+ :return: The peeled value of the ref. If the ref is known not point to
+ a tag, this will be the SHA the ref refers to. If no cached
+ information about a tag is available, this method may return None,
+ but it should attempt to peel the tag if possible.
"""
- raise NotImplementedError
+ return None
- def fetch_objects(self, determine_wants, graph_walker, progress):
+ def fetch_objects(self, determine_wants, graph_walker, progress,
+ get_tagged=None):
"""
Yield the objects required for a list of commits.
:param progress: is a callback to send progress messages to the client
+ :param get_tagged: Function that returns a dict of pointed-to sha -> tag
+ sha for including tags.
"""
raise NotImplementedError
-class GitBackend(Backend):
+class PackStreamCopier(PackStreamReader):
+ """Class to verify a pack stream as it is being read.
- def __init__(self, gitdir=None):
- self.gitdir = gitdir
+ The pack is read from a ReceivableProtocol using read() or recv() as
+ appropriate and written out to the given file-like object.
+ """
- if not self.gitdir:
- self.gitdir = tempfile.mkdtemp()
- Repo.create(self.gitdir)
+ def __init__(self, read_all, read_some, outfile):
+ super(PackStreamCopier, self).__init__(read_all, read_some)
+ self.outfile = outfile
- self.repo = Repo(self.gitdir)
- self.fetch_objects = self.repo.fetch_objects
- self.get_refs = self.repo.get_refs
+ def _read(self, read, size):
+ data = super(PackStreamCopier, self)._read(read, size)
+ self.outfile.write(data)
+ return data
- def apply_pack(self, refs, read):
- fd, commit = self.repo.object_store.add_pack()
- fd.write(read())
- commit()
+ def verify(self):
+ """Verify a pack stream and write it to the output file.
+
+ See PackStreamReader.iterobjects for a list of exceptions this may
+ throw.
+ """
+ for _, _, _ in self.read_objects():
+ pass
- for oldsha, sha, ref in refs:
- if ref == "0" * 40:
- self.repo.remove_ref(ref)
- else:
- self.repo.set_ref(ref, sha)
- print "pack applied"
+class DictBackend(Backend):
+ """Trivial backend that looks up Git repositories in a dictionary."""
+
+ def __init__(self, repos):
+ self.repos = repos
+
+ def open_repository(self, path):
+ logger.debug('Opening repository at %s', path)
+ # FIXME: What to do in case there is no repo ?
+ return self.repos[path]
class Handler(object):
+ """Smart protocol command handler base class."""
- def __init__(self, backend, read, write):
+ def __init__(self, backend, proto):
self.backend = backend
- self.proto = Protocol(read, write)
-
- def capabilities(self):
- return " ".join(self.default_capabilities())
+ self.proto = proto
+ self._client_capabilities = None
+
+ @classmethod
+ def capability_line(cls):
+ return " ".join(cls.capabilities())
+
+ @classmethod
+ def capabilities(cls):
+ raise NotImplementedError(cls.capabilities)
+
+ @classmethod
+ def innocuous_capabilities(cls):
+ return ("include-tag", "thin-pack", "no-progress", "ofs-delta")
+
+ @classmethod
+ def required_capabilities(cls):
+ """Return a list of capabilities that we require the client to have."""
+ return []
+
+ def set_client_capabilities(self, caps):
+ allowable_caps = set(self.innocuous_capabilities())
+ allowable_caps.update(self.capabilities())
+ for cap in caps:
+ if cap not in allowable_caps:
+ raise GitProtocolError('Client asked for capability %s that '
+ 'was not advertised.' % cap)
+ for cap in self.required_capabilities():
+ if cap not in caps:
+ raise GitProtocolError('Client does not support required '
+ 'capability %s.' % cap)
+ self._client_capabilities = set(caps)
+ logger.info('Client capabilities: %s', caps)
+
+ def has_capability(self, cap):
+ if self._client_capabilities is None:
+ raise GitProtocolError('Server attempted to access capability %s '
+ 'before asking client' % cap)
+ return cap in self._client_capabilities
class UploadPackHandler(Handler):
+ """Protocol handler for uploading a pack to the server."""
+
+ def __init__(self, backend, args, proto,
+ stateless_rpc=False, advertise_refs=False):
+ Handler.__init__(self, backend, proto)
+ self.repo = backend.open_repository(args[0])
+ self._graph_walker = None
+ self.stateless_rpc = stateless_rpc
+ self.advertise_refs = advertise_refs
+
+ @classmethod
+ def capabilities(cls):
+ return ("multi_ack_detailed", "multi_ack", "side-band-64k", "thin-pack",
+ "ofs-delta", "no-progress", "include-tag")
+
+ @classmethod
+ def required_capabilities(cls):
+ return ("side-band-64k", "thin-pack", "ofs-delta")
+
+ def progress(self, message):
+ if self.has_capability("no-progress"):
+ return
+ self.proto.write_sideband(2, message)
- def default_capabilities(self):
- return ("multi_ack", "side-band-64k", "thin-pack", "ofs-delta")
+ def get_tagged(self, refs=None, repo=None):
+ """Get a dict of peeled values of tags to their original tag shas.
+
+ :param refs: dict of refname -> sha of possible tags; defaults to all of
+ the backend's refs.
+ :param repo: optional Repo instance for getting peeled refs; defaults to
+ the backend's repo, if available
+ :return: dict of peeled_sha -> tag_sha, where tag_sha is the sha of a
+ tag whose peeled value is peeled_sha.
+ """
+ if not self.has_capability("include-tag"):
+ return {}
+ if refs is None:
+ refs = self.repo.get_refs()
+ if repo is None:
+ repo = getattr(self.repo, "repo", None)
+ if repo is None:
+ # Bail if we don't have a Repo available; this is ok since
+ # clients must be able to handle if the server doesn't include
+ # all relevant tags.
+ # TODO: fix behavior when missing
+ return {}
+ tagged = {}
+ for name, sha in refs.iteritems():
+ peeled_sha = repo.get_peeled(name)
+ if peeled_sha != sha:
+ tagged[peeled_sha] = sha
+ return tagged
def handle(self):
- def determine_wants(heads):
- keys = heads.keys()
- if keys:
- self.proto.write_pkt_line("%s %s\x00%s\n" % ( heads[keys[0]], keys[0], self.capabilities()))
- for k in keys[1:]:
- self.proto.write_pkt_line("%s %s\n" % (heads[k], k))
+ write = lambda x: self.proto.write_sideband(1, x)
- # i'm done..
- self.proto.write("0000")
+ graph_walker = ProtocolGraphWalker(self, self.repo.object_store,
+ self.repo.get_peeled)
+ objects_iter = self.repo.fetch_objects(
+ graph_walker.determine_wants, graph_walker, self.progress,
+ get_tagged=self.get_tagged)
- # Now client will either send "0000", meaning that it doesnt want to pull.
- # or it will start sending want want want commands
- want = self.proto.read_pkt_line()
- if want == None:
- return []
+ # Do they want any objects?
+ if len(objects_iter) == 0:
+ return
+
+ self.progress("dul-daemon says what\n")
+ self.progress("counting objects: %d, done.\n" % len(objects_iter))
+ write_pack_data(ProtocolFile(None, write), objects_iter,
+ len(objects_iter))
+ self.progress("how was that, then?\n")
+ # we are done
+ self.proto.write("0000")
- want, self.client_capabilities = extract_capabilities(want)
- want_revs = []
- while want and want[:4] == 'want':
- want_revs.append(want[5:45])
- want = self.proto.read_pkt_line()
- return want_revs
+def _split_proto_line(line, allowed):
+ """Split a line read from the wire.
+
+ :param line: The line read from the wire.
+ :param allowed: An iterable of command names that should be allowed.
+ Command names not listed below as possible return values will be
+ ignored. If None, any commands from the possible return values are
+ allowed.
+ :return: a tuple having one of the following forms:
+ ('want', obj_id)
+ ('have', obj_id)
+ ('done', None)
+ (None, None) (for a flush-pkt)
+
+ :raise UnexpectedCommandError: if the line cannot be parsed into one of the
+ allowed return values.
+ """
+ if not line:
+ fields = [None]
+ else:
+ fields = line.rstrip('\n').split(' ', 1)
+ command = fields[0]
+ if allowed is not None and command not in allowed:
+ raise UnexpectedCommandError(command)
+ try:
+ if len(fields) == 1 and command in ('done', None):
+ return (command, None)
+ elif len(fields) == 2 and command in ('want', 'have'):
+ hex_to_sha(fields[1])
+ return tuple(fields)
+ except (TypeError, AssertionError), e:
+ raise GitProtocolError(e)
+ raise GitProtocolError('Received invalid line from client: %s' % line)
+
+
+class ProtocolGraphWalker(object):
+ """A graph walker that knows the git protocol.
+
+ As a graph walker, this class implements ack(), next(), and reset(). It
+ also contains some base methods for interacting with the wire and walking
+ the commit tree.
+
+ The work of determining which acks to send is passed on to the
+ implementation instance stored in _impl. The reason for this is that we do
+ not know at object creation time what ack level the protocol requires. A
+ call to set_ack_level() is required to set up the implementation, before any
+ calls to next() or ack() are made.
+ """
+ def __init__(self, handler, object_store, get_peeled):
+ self.handler = handler
+ self.store = object_store
+ self.get_peeled = get_peeled
+ self.proto = handler.proto
+ self.stateless_rpc = handler.stateless_rpc
+ self.advertise_refs = handler.advertise_refs
+ self._wants = []
+ self._cached = False
+ self._cache = []
+ self._cache_index = 0
+ self._impl = None
+
+ def determine_wants(self, heads):
+ """Determine the wants for a set of heads.
+
+ The given heads are advertised to the client, who then specifies which
+ refs he wants using 'want' lines. This portion of the protocol is the
+ same regardless of ack type, and in fact is used to set the ack type of
+ the ProtocolGraphWalker.
+
+ :param heads: a dict of refname->SHA1 to advertise
+ :return: a list of SHA1s requested by the client
+ """
+ if not heads:
+ raise GitProtocolError('No heads found')
+ values = set(heads.itervalues())
+ if self.advertise_refs or not self.stateless_rpc:
+ for i, (ref, sha) in enumerate(heads.iteritems()):
+ line = "%s %s" % (sha, ref)
+ if not i:
+ line = "%s\x00%s" % (line, self.handler.capability_line())
+ self.proto.write_pkt_line("%s\n" % line)
+ peeled_sha = self.get_peeled(ref)
+ if peeled_sha != sha:
+ self.proto.write_pkt_line('%s %s^{}\n' %
+ (peeled_sha, ref))
- progress = lambda x: self.proto.write_sideband(2, x)
- write = lambda x: self.proto.write_sideband(1, x)
+ # i'm done..
+ self.proto.write_pkt_line(None)
- class ProtocolGraphWalker(object):
+ if self.advertise_refs:
+ return []
- def __init__(self, proto):
- self.proto = proto
- self._last_sha = None
+ # Now client will sending want want want commands
+ want = self.proto.read_pkt_line()
+ if not want:
+ return []
+ line, caps = extract_want_line_capabilities(want)
+ self.handler.set_client_capabilities(caps)
+ self.set_ack_type(ack_type(caps))
+ allowed = ('want', None)
+ command, sha = _split_proto_line(line, allowed)
+
+ want_revs = []
+ while command != None:
+ if sha not in values:
+ raise GitProtocolError(
+ 'Client wants invalid object %s' % sha)
+ want_revs.append(sha)
+ command, sha = self.read_proto_line(allowed)
+
+ self.set_wants(want_revs)
+ return want_revs
+
+ def ack(self, have_ref):
+ return self._impl.ack(have_ref)
+
+ def reset(self):
+ self._cached = True
+ self._cache_index = 0
+
+ def next(self):
+ if not self._cached:
+ if not self._impl and self.stateless_rpc:
+ return None
+ return self._impl.next()
+ self._cache_index += 1
+ if self._cache_index > len(self._cache):
+ return None
+ return self._cache[self._cache_index]
+
+ def read_proto_line(self, allowed):
+ """Read a line from the wire.
+
+ :param allowed: An iterable of command names that should be allowed.
+ :return: A tuple of (command, value); see _split_proto_line.
+ :raise GitProtocolError: If an error occurred reading the line.
+ """
+ return _split_proto_line(self.proto.read_pkt_line(), allowed)
- def ack(self, have_ref):
- self.proto.write_pkt_line("ACK %s continue\n" % have_ref)
+ def send_ack(self, sha, ack_type=''):
+ if ack_type:
+ ack_type = ' %s' % ack_type
+ self.proto.write_pkt_line('ACK %s%s\n' % (sha, ack_type))
- def next(self):
- have = self.proto.read_pkt_line()
- if have[:4] == 'have':
- return have[5:45]
+ def send_nak(self):
+ self.proto.write_pkt_line('NAK\n')
- #if have[:4] == 'done':
- # return None
+ def set_wants(self, wants):
+ self._wants = wants
- if self._last_sha:
- # Oddness: Git seems to resend the last ACK, without the "continue" statement
- self.proto.write_pkt_line("ACK %s\n" % self._last_sha)
+ def _is_satisfied(self, haves, want, earliest):
+ """Check whether a want is satisfied by a set of haves.
- # The exchange finishes with a NAK
- self.proto.write_pkt_line("NAK\n")
+ A want, typically a branch tip, is "satisfied" only if there exists a
+ path back from that want to one of the haves.
- graph_walker = ProtocolGraphWalker(self.proto)
- objects = list(self.backend.fetch_objects(determine_wants, graph_walker, progress))
- progress("dul-daemon says what\n")
- progress("counting objects: %d, done.\n" % len(objects))
- write_pack_data(ProtocolFile(None, write), objects, len(objects))
- progress("how was that, then?\n")
- # we are done
- self.proto.write("0000")
+ :param haves: A set of commits we know the client has.
+ :param want: The want to check satisfaction for.
+ :param earliest: A timestamp beyond which the search for haves will be
+ terminated, presumably because we're searching too far down the
+ wrong branch.
+ """
+ o = self.store[want]
+ pending = collections.deque([o])
+ while pending:
+ commit = pending.popleft()
+ if commit.id in haves:
+ return True
+ if commit.type_name != "commit":
+ # non-commit wants are assumed to be satisfied
+ continue
+ for parent in commit.parents:
+ parent_obj = self.store[parent]
+ # TODO: handle parents with later commit times than children
+ if parent_obj.commit_time >= earliest:
+ pending.append(parent_obj)
+ return False
+
+ def all_wants_satisfied(self, haves):
+ """Check whether all the current wants are satisfied by a set of haves.
+
+ :param haves: A set of commits we know the client has.
+ :note: Wants are specified with set_wants rather than passed in since
+ in the current interface they are determined outside this class.
+ """
+ haves = set(haves)
+ earliest = min([self.store[h].commit_time for h in haves])
+ for want in self._wants:
+ if not self._is_satisfied(haves, want, earliest):
+ return False
+ return True
+
+ def set_ack_type(self, ack_type):
+ impl_classes = {
+ MULTI_ACK: MultiAckGraphWalkerImpl,
+ MULTI_ACK_DETAILED: MultiAckDetailedGraphWalkerImpl,
+ SINGLE_ACK: SingleAckGraphWalkerImpl,
+ }
+ self._impl = impl_classes[ack_type](self)
+
+
+_GRAPH_WALKER_COMMANDS = ('have', 'done', None)
+
+
+class SingleAckGraphWalkerImpl(object):
+ """Graph walker implementation that speaks the single-ack protocol."""
+
+ def __init__(self, walker):
+ self.walker = walker
+ self._sent_ack = False
+
+ def ack(self, have_ref):
+ if not self._sent_ack:
+ self.walker.send_ack(have_ref)
+ self._sent_ack = True
+
+ def next(self):
+ command, sha = self.walker.read_proto_line(_GRAPH_WALKER_COMMANDS)
+ if command in (None, 'done'):
+ if not self._sent_ack:
+ self.walker.send_nak()
+ return None
+ elif command == 'have':
+ return sha
+
+
+class MultiAckGraphWalkerImpl(object):
+ """Graph walker implementation that speaks the multi-ack protocol."""
+
+ def __init__(self, walker):
+ self.walker = walker
+ self._found_base = False
+ self._common = []
+
+ def ack(self, have_ref):
+ self._common.append(have_ref)
+ if not self._found_base:
+ self.walker.send_ack(have_ref, 'continue')
+ if self.walker.all_wants_satisfied(self._common):
+ self._found_base = True
+ # else we blind ack within next
+
+ def next(self):
+ while True:
+ command, sha = self.walker.read_proto_line(_GRAPH_WALKER_COMMANDS)
+ if command is None:
+ self.walker.send_nak()
+ # in multi-ack mode, a flush-pkt indicates the client wants to
+ # flush but more have lines are still coming
+ continue
+ elif command == 'done':
+ # don't nak unless no common commits were found, even if not
+ # everything is satisfied
+ if self._common:
+ self.walker.send_ack(self._common[-1])
+ else:
+ self.walker.send_nak()
+ return None
+ elif command == 'have':
+ if self._found_base:
+ # blind ack
+ self.walker.send_ack(sha, 'continue')
+ return sha
+
+
+class MultiAckDetailedGraphWalkerImpl(object):
+ """Graph walker implementation speaking the multi-ack-detailed protocol."""
+
+ def __init__(self, walker):
+ self.walker = walker
+ self._found_base = False
+ self._common = []
+
+ def ack(self, have_ref):
+ self._common.append(have_ref)
+ if not self._found_base:
+ self.walker.send_ack(have_ref, 'common')
+ if self.walker.all_wants_satisfied(self._common):
+ self._found_base = True
+ self.walker.send_ack(have_ref, 'ready')
+ # else we blind ack within next
+
+ def next(self):
+ while True:
+ command, sha = self.walker.read_proto_line(_GRAPH_WALKER_COMMANDS)
+ if command is None:
+ self.walker.send_nak()
+ if self.walker.stateless_rpc:
+ return None
+ continue
+ elif command == 'done':
+ # don't nak unless no common commits were found, even if not
+ # everything is satisfied
+ if self._common:
+ self.walker.send_ack(self._common[-1])
+ else:
+ self.walker.send_nak()
+ return None
+ elif command == 'have':
+ if self._found_base:
+ # blind ack; can happen if the client has more requests
+ # inflight
+ self.walker.send_ack(sha, 'ready')
+ return sha
class ReceivePackHandler(Handler):
+ """Protocol handler for downloading a pack from the client."""
+
+ def __init__(self, backend, args, proto,
+ stateless_rpc=False, advertise_refs=False):
+ Handler.__init__(self, backend, proto)
+ self.repo = backend.open_repository(args[0])
+ self.stateless_rpc = stateless_rpc
+ self.advertise_refs = advertise_refs
+
+ @classmethod
+ def capabilities(cls):
+ return ("report-status", "delete-refs", "side-band-64k")
+
+ def _apply_pack(self, refs):
+ f, commit = self.repo.object_store.add_thin_pack()
+ all_exceptions = (IOError, OSError, ChecksumMismatch, ApplyDeltaError,
+ AssertionError, socket.error, zlib.error,
+ ObjectFormatException)
+ status = []
+ # TODO: more informative error messages than just the exception string
+ try:
+ PackStreamCopier(self.proto.read, self.proto.recv, f).verify()
+ p = commit()
+ if not p:
+ raise IOError('Failed to write pack')
+ p.check()
+ status.append(('unpack', 'ok'))
+ except all_exceptions, e:
+ status.append(('unpack', str(e).replace('\n', '')))
+ # The pack may still have been moved in, but it may contain broken
+ # objects. We trust a later GC to clean it up.
- def default_capabilities(self):
- return ("report-status", "delete-refs")
+ for oldsha, sha, ref in refs:
+ ref_status = 'ok'
+ try:
+ if sha == ZERO_SHA:
+ if not 'delete-refs' in self.capabilities():
+ raise GitProtocolError(
+ 'Attempted to delete refs without delete-refs '
+ 'capability.')
+ try:
+ del self.repo.refs[ref]
+ except all_exceptions:
+ ref_status = 'failed to delete'
+ else:
+ try:
+ self.repo.refs[ref] = sha
+ except all_exceptions:
+ ref_status = 'failed to write'
+ except KeyError, e:
+ ref_status = 'bad ref'
+ status.append((ref, ref_status))
+
+ return status
+
+ def _report_status(self, status):
+ if self.has_capability('side-band-64k'):
+ writer = BufferedPktLineWriter(
+ lambda d: self.proto.write_sideband(1, d))
+ write = writer.write
+
+ def flush():
+ writer.flush()
+ self.proto.write_pkt_line(None)
+ else:
+ write = self.proto.write_pkt_line
+ flush = lambda: None
+
+ for name, msg in status:
+ if name == 'unpack':
+ write('unpack %s\n' % msg)
+ elif msg == 'ok':
+ write('ok %s\n' % name)
+ else:
+ write('ng %s %s\n' % (name, msg))
+ write(None)
+ flush()
def handle(self):
- refs = self.backend.get_refs().items()
-
- if refs:
- self.proto.write_pkt_line("%s %s\x00%s\n" % (refs[0][1], refs[0][0], self.capabilities()))
- for i in range(1, len(refs)):
- ref = refs[i]
- self.proto.write_pkt_line("%s %s\n" % (ref[1], ref[0]))
- else:
- self.proto.write_pkt_line("0000000000000000000000000000000000000000 capabilities^{} %s" % self.capabilities())
+ refs = self.repo.get_refs().items()
+
+ if self.advertise_refs or not self.stateless_rpc:
+ if refs:
+ self.proto.write_pkt_line(
+ "%s %s\x00%s\n" % (refs[0][1], refs[0][0],
+ self.capability_line()))
+ for i in range(1, len(refs)):
+ ref = refs[i]
+ self.proto.write_pkt_line("%s %s\n" % (ref[1], ref[0]))
+ else:
+ self.proto.write_pkt_line("%s capabilities^{} %s" % (
+ ZERO_SHA, self.capability_line()))
- self.proto.write("0000")
+ self.proto.write("0000")
+ if self.advertise_refs:
+ return
client_refs = []
ref = self.proto.read_pkt_line()
if ref is None:
return
- ref, client_capabilities = extract_capabilities(ref)
+ ref, caps = extract_capabilities(ref)
+ self.set_client_capabilities(caps)
# client will now send us a list of (oldsha, newsha, ref)
while ref:
ref = self.proto.read_pkt_line()
# backend can now deal with this refs and read a pack using self.read
- self.backend.apply_pack(client_refs, self.proto.read)
+ status = self._apply_pack(client_refs)
- # when we have read all the pack from the client, it assumes everything worked OK
- # there is NO ack from the server before it reports victory.
+ # when we have read all the pack from the client, send a status report
+ # if the client asked for it
+ if self.has_capability('report-status'):
+ self._report_status(status)
+
+
+# Default handler classes for git services.
+DEFAULT_HANDLERS = {
+ 'git-upload-pack': UploadPackHandler,
+ 'git-receive-pack': ReceivePackHandler,
+ }
class TCPGitRequestHandler(SocketServer.StreamRequestHandler):
+ def __init__(self, handlers, *args, **kwargs):
+ self.handlers = handlers
+ SocketServer.StreamRequestHandler.__init__(self, *args, **kwargs)
+
def handle(self):
- proto = Protocol(self.rfile.read, self.wfile.write)
+ proto = ReceivableProtocol(self.connection.recv, self.wfile.write)
command, args = proto.read_cmd()
+ logger.info('Handling %s request, args=%s', command, args)
- # switch case to handle the specific git command
- if command == 'git-upload-pack':
- cls = UploadPackHandler
- elif command == 'git-receive-pack':
- cls = ReceivePackHandler
- else:
- return
-
- h = cls(self.server.backend, self.rfile.read, self.wfile.write)
+ cls = self.handlers.get(command, None)
+ if not callable(cls):
+ raise GitProtocolError('Invalid service %s' % command)
+ h = cls(self.server.backend, args, proto)
h.handle()
allow_reuse_address = True
serve = SocketServer.TCPServer.serve_forever
- def __init__(self, backend, listen_addr, port=TCP_GIT_PORT):
- self.backend = backend
- SocketServer.TCPServer.__init__(self, (listen_addr, port), TCPGitRequestHandler)
-
+ def _make_handler(self, *args, **kwargs):
+ return TCPGitRequestHandler(self.handlers, *args, **kwargs)
+ def __init__(self, backend, listen_addr, port=TCP_GIT_PORT, handlers=None):
+ self.handlers = dict(DEFAULT_HANDLERS)
+ if handlers is not None:
+ self.handlers.update(handlers)
+ self.backend = backend
+ logger.info('Listening for TCP connections on %s:%d', listen_addr, port)
+ SocketServer.TCPServer.__init__(self, (listen_addr, port),
+ self._make_handler)
+
+ def verify_request(self, request, client_address):
+ logger.info('Handling request from %s', client_address)
+ return True
+
+ def handle_error(self, request, client_address):
+ logger.exception('Exception happened during processing of request '
+ 'from %s', client_address)
+
+
+def main(argv=sys.argv):
+ """Entry point for starting a TCP git server."""
+ if len(argv) > 1:
+ gitdir = argv[1]
+ else:
+ gitdir = '.'
+
+ log_utils.default_logging_config()
+ backend = DictBackend({'/': Repo(gitdir)})
+ server = TCPGitServer(backend, 'localhost')
+ server.serve_forever()
git.samba.org / jelmer / dulwich-libgit2.git / blobdiff