Work around smart HTTP bugs in C Git

I have unfortunately introduced a few bugs in the native Git client
over the years. 1.7.5 is unable to send chunked requests correctly,
resulting in corrupt data at the server. Ban this client whenever
it uses chunked encoding with an error message.

Prior to some more recent versions, git push over HTTP failed to
report status information and error messages due to a race within
the client and its helper process. Check for these bad versions and
send errors as messages before the status report, enabling users
to see the failures on their terminal.

Change-Id: Ic62d6591cbd851d21dbb3e9b023d655eaecb0624

org.eclipse.jgit.http.server/resources/org/eclipse/jgit/http/server/HttpServerText.properties

@@ -1,5 +1,12 @@
 alreadyInitializedByContainer=Already initialized by container
 cannotGetLengthOf=Cannot get length of {0}
+clientHas175ChunkedEncodingBug=Git client software upgrade is required.\n\
+\n\
+Git 1.7.5 contains a bug that breaks HTTP support in the client.\n\
+Please upgrade to Git 1.7.5.1 or newer (or alternatively, downgrade\n\
+to any version between 1.6.6 and 1.7.4.5).\n\
+\n\
+  http://git-scm.com/download\n
 encodingNotSupportedByThisLibrary={0} "{1}": not supported by this library.
 expectedRepositoryAttribute=Expected Repository attribute
 filterMustNotBeNull=filter must not be null

org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/ClientVersionUtil.java

@@ -0,0 +1,203 @@
+/*
+ * Copyright (C) 2012, Google Inc.
+ * and other copyright owners as documented in the project's IP log.
+ *
+ * This program and the accompanying materials are made available
+ * under the terms of the Eclipse Distribution License v1.0 which
+ * accompanies this distribution, is reproduced below, and is
+ * available at http://www.eclipse.org/org/documents/edl-v10.php
+ *
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or
+ * without modification, are permitted provided that the following
+ * conditions are met:
+ *
+ * - Redistributions of source code must retain the above copyright
+ *   notice, this list of conditions and the following disclaimer.
+ *
+ * - Redistributions in binary form must reproduce the above
+ *   copyright notice, this list of conditions and the following
+ *   disclaimer in the documentation and/or other materials provided
+ *   with the distribution.
+ *
+ * - Neither the name of the Eclipse Foundation, Inc. nor the
+ *   names of its contributors may be used to endorse or promote
+ *   products derived from this software without specific prior
+ *   written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
+ * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
+ * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+ * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+ * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package org.eclipse.jgit.http.server;
+
+import static org.eclipse.jgit.http.server.ServletUtils.isChunked;
+
+import javax.servlet.http.HttpServletRequest;
+
+/** Parses Git client User-Agent strings. */
+public class ClientVersionUtil {
+	private static final int[] v1_7_5 = { 1, 7, 5 };
+	private static final int[] v1_7_8_6 = { 1, 7, 8, 6 };
+	private static final int[] v1_7_9 = { 1, 7, 9 };
+
+	/** @return maximum version array, indicating an invalid version of Git. */
+	public static int[] invalidVersion() {
+		return new int[] { Integer.MAX_VALUE };
+	}
+
+	/**
+	 * Parse a Git client User-Agent header value.
+	 *
+	 * @param version
+	 *            git client version string, of the form "git/1.7.9".
+	 * @return components of the version string. {@link #invalidVersion()} if
+	 *         the version string cannot be parsed.
+	 */
+	public static int[] parseVersion(String version) {
+		if (version != null && version.startsWith("git/"))
+			return splitVersion(version.substring("git/".length()));
+		return invalidVersion();
+	}
+
+	private static int[] splitVersion(String versionString) {
+		char[] str = versionString.toCharArray();
+		int[] ver = new int[4];
+		int end = 0;
+		int acc = 0;
+		for (int i = 0; i < str.length; i++) {
+			char c = str[i];
+			if ('0' <= c && c <= '9') {
+				acc *= 10;
+				acc += c - '0';
+			} else if (c == '.') {
+				if (end == ver.length)
+					ver = grow(ver);
+				ver[end++] = acc;
+				acc = 0;
+			} else if (c == 'g' && 0 < i && str[i - 1] == '.' && 0 < end) {
+				// Non-tagged builds may contain a mangled git describe output.
+				// "1.7.6.1.45.gbe0cc". The 45 isn't a valid component. Drop it.
+				ver[end - 1] = 0;
+				acc = 0;
+				break;
+			} else if (c == '-' && (i + 2) < str.length
+					&& str[i + 1] == 'r' && str[i + 2] == 'c') {
+				// Release candidates aren't the same as a final release.
+				if (acc > 0)
+					acc--;
+				break;
+			} else
+				break;
+		}
+		if (acc != 0) {
+			if (end == ver.length)
+				ver = grow(ver);
+			ver[end++] = acc;
+		} else {
+			while (0 < end && ver[end - 1] == 0)
+				end--;
+		}
+		if (end < ver.length) {
+			int[] n = new int[end];
+			System.arraycopy(ver, 0, n, 0, end);
+			ver = n;
+		}
+		return ver;
+	}
+
+	private static int[] grow(int[] tmp) {
+		int[] n = new int[tmp.length + 1];
+		System.arraycopy(tmp, 0, n, 0, tmp.length);
+		return n;
+	}
+
+	/**
+	 * Compare two version strings for natural ordering.
+	 *
+	 * @param a
+	 *            first parsed version string.
+	 * @param b
+	 *            second parsed version string.
+	 * @return <0 if a is before b; 0 if a equals b; >0 if a is after b.
+	 */
+	public static int compare(int[] a, int[] b) {
+		for (int i = 0; i < a.length && i < b.length; i++) {
+			int cmp = a[i] - b[i];
+			if (cmp != 0)
+				return cmp;
+		}
+		return a.length - b.length;
+	}
+
+	/**
+	 * Convert a parsed version back to a string.
+	 *
+	 * @param ver
+	 *            the parsed version array.
+	 * @return a string, e.g. "1.6.6.0".
+	 */
+	public static String toString(int[] ver) {
+		StringBuilder b = new StringBuilder();
+		for (int v : ver) {
+			if (b.length() > 0)
+				b.append('.');
+			b.append(v);
+		}
+		return b.toString();
+	}
+
+	/**
+	 * Check if a Git client has the known push status bug.
+	 * <p>
+	 * These buggy clients do not display the status report from a failed push
+	 * over HTTP.
+	 *
+	 * @param version
+	 *            parsed version of the Git client software.
+	 * @return true if the bug is present.
+	 */
+	public static boolean hasPushStatusBug(int[] version) {
+		int cmp = compare(version, v1_7_8_6);
+		if (cmp < 0)
+			return true; // Everything before 1.7.8.6 is known broken.
+		else if (cmp == 0)
+			return false; // 1.7.8.6 contained the bug fix.
+
+		if (compare(version, v1_7_9) <= 0)
+			return true; // 1.7.9 shipped before 1.7.8.6 and has the bug.
+		return false; // 1.7.9.1 and later are fixed.
+	}
+
+	/**
+	 * Check if a Git client has the known chunked request body encoding bug.
+	 * <p>
+	 * Git 1.7.5 contains a unique bug where chunked requests are malformed.
+	 * This applies to both fetch and push.
+	 *
+	 * @param version
+	 *            parsed version of the Git client software.
+	 * @param request
+	 *            incoming HTTP request.
+	 * @return true if the client has the chunked encoding bug.
+	 */
+	public static boolean hasChunkedEncodingRequestBug(
+			int[] version, HttpServletRequest request) {
+		return compare(version, v1_7_5) == 0 && isChunked(request);
+	}
+
+	private ClientVersionUtil() {
+	}
+}

org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/HttpServerText.java

@@ -60,6 +60,7 @@ public class HttpServerText extends TranslationBundle {
 
 	/***/ public String alreadyInitializedByContainer;
 	/***/ public String cannotGetLengthOf;
+	/***/ public String clientHas175ChunkedEncodingBug;
 	/***/ public String encodingNotSupportedByThisLibrary;
 	/***/ public String expectedRepositoryAttribute;
 	/***/ public String filterMustNotBeNull;

org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/ReceivePackServlet.java

@@ -43,10 +43,14 @@
 
 package org.eclipse.jgit.http.server;
 
+import static javax.servlet.http.HttpServletResponse.SC_BAD_REQUEST;
 import static javax.servlet.http.HttpServletResponse.SC_FORBIDDEN;
 import static javax.servlet.http.HttpServletResponse.SC_INTERNAL_SERVER_ERROR;
 import static javax.servlet.http.HttpServletResponse.SC_UNAUTHORIZED;
 import static javax.servlet.http.HttpServletResponse.SC_UNSUPPORTED_MEDIA_TYPE;
+import static org.eclipse.jgit.http.server.ClientVersionUtil.hasChunkedEncodingRequestBug;
+import static org.eclipse.jgit.http.server.ClientVersionUtil.hasPushStatusBug;
+import static org.eclipse.jgit.http.server.ClientVersionUtil.parseVersion;
 import static org.eclipse.jgit.http.server.GitSmartHttpTools.RECEIVE_PACK;
 import static org.eclipse.jgit.http.server.GitSmartHttpTools.RECEIVE_PACK_REQUEST_TYPE;
 import static org.eclipse.jgit.http.server.GitSmartHttpTools.RECEIVE_PACK_RESULT_TYPE;
@@ -55,6 +59,7 @@ import static org.eclipse.jgit.http.server.ServletUtils.ATTRIBUTE_HANDLER;
 import static org.eclipse.jgit.http.server.ServletUtils.consumeRequestBody;
 import static org.eclipse.jgit.http.server.ServletUtils.getInputStream;
 import static org.eclipse.jgit.http.server.ServletUtils.getRepository;
+import static org.eclipse.jgit.util.HttpSupport.HDR_USER_AGENT;
 
 import java.io.IOException;
 import java.util.List;
@@ -159,6 +164,13 @@ class ReceivePackServlet extends HttpServlet {
 			return;
 		}
 
+		int[] version = parseVersion(req.getHeader(HDR_USER_AGENT));
+		if (hasChunkedEncodingRequestBug(version, req)) {
+			GitSmartHttpTools.sendError(req, rsp, SC_BAD_REQUEST, "\n\n"
+					+ HttpServerText.get().clientHas175ChunkedEncodingBug);
+			return;
+		}
+
 		SmartOutputStream out = new SmartOutputStream(req, rsp) {
 			@Override
 			public void flush() throws IOException {
@@ -169,6 +181,7 @@ class ReceivePackServlet extends HttpServlet {
 		ReceivePack rp = (ReceivePack) req.getAttribute(ATTRIBUTE_HANDLER);
 		try {
 			rp.setBiDirectionalPipe(false);
+			rp.setEchoCommandFailures(hasPushStatusBug(version));
 			rsp.setContentType(RECEIVE_PACK_RESULT_TYPE);
 
 			rp.receive(getInputStream(req), out, null);

org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/ServletUtils.java

@@ -134,7 +134,7 @@ public final class ServletUtils {
 		}
 	}
 
-	private static boolean isChunked(HttpServletRequest req) {
+	static boolean isChunked(HttpServletRequest req) {
 		return "chunked".equals(req.getHeader("Transfer-Encoding"));
 	}
 

org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/UploadPackServlet.java

@@ -43,10 +43,13 @@
 
 package org.eclipse.jgit.http.server;
 
+import static javax.servlet.http.HttpServletResponse.SC_BAD_REQUEST;
 import static javax.servlet.http.HttpServletResponse.SC_FORBIDDEN;
 import static javax.servlet.http.HttpServletResponse.SC_INTERNAL_SERVER_ERROR;
 import static javax.servlet.http.HttpServletResponse.SC_UNAUTHORIZED;
 import static javax.servlet.http.HttpServletResponse.SC_UNSUPPORTED_MEDIA_TYPE;
+import static org.eclipse.jgit.http.server.ClientVersionUtil.hasChunkedEncodingRequestBug;
+import static org.eclipse.jgit.http.server.ClientVersionUtil.parseVersion;
 import static org.eclipse.jgit.http.server.GitSmartHttpTools.UPLOAD_PACK;
 import static org.eclipse.jgit.http.server.GitSmartHttpTools.UPLOAD_PACK_REQUEST_TYPE;
 import static org.eclipse.jgit.http.server.GitSmartHttpTools.UPLOAD_PACK_RESULT_TYPE;
@@ -55,6 +58,7 @@ import static org.eclipse.jgit.http.server.ServletUtils.ATTRIBUTE_HANDLER;
 import static org.eclipse.jgit.http.server.ServletUtils.consumeRequestBody;
 import static org.eclipse.jgit.http.server.ServletUtils.getInputStream;
 import static org.eclipse.jgit.http.server.ServletUtils.getRepository;
+import static org.eclipse.jgit.util.HttpSupport.HDR_USER_AGENT;
 
 import java.io.IOException;
 import java.util.List;
@@ -161,6 +165,13 @@ class UploadPackServlet extends HttpServlet {
 			return;
 		}
 
+		int[] version = parseVersion(req.getHeader(HDR_USER_AGENT));
+		if (hasChunkedEncodingRequestBug(version, req)) {
+			GitSmartHttpTools.sendError(req, rsp, SC_BAD_REQUEST, "\n\n"
+					+ HttpServerText.get().clientHas175ChunkedEncodingBug);
+			return;
+		}
+
 		SmartOutputStream out = new SmartOutputStream(req, rsp) {
 			@Override
 			public void flush() throws IOException {

org.eclipse.jgit.http.test/tst/org/eclipse/jgit/http/server/ClientVersionUtilTest.java

@@ -0,0 +1,85 @@
+/*
+ * Copyright (C) 2012, Google Inc.
+ * and other copyright owners as documented in the project's IP log.
+ *
+ * This program and the accompanying materials are made available
+ * under the terms of the Eclipse Distribution License v1.0 which
+ * accompanies this distribution, is reproduced below, and is
+ * available at http://www.eclipse.org/org/documents/edl-v10.php
+ *
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or
+ * without modification, are permitted provided that the following
+ * conditions are met:
+ *
+ * - Redistributions of source code must retain the above copyright
+ *   notice, this list of conditions and the following disclaimer.
+ *
+ * - Redistributions in binary form must reproduce the above
+ *   copyright notice, this list of conditions and the following
+ *   disclaimer in the documentation and/or other materials provided
+ *   with the distribution.
+ *
+ * - Neither the name of the Eclipse Foundation, Inc. nor the
+ *   names of its contributors may be used to endorse or promote
+ *   products derived from this software without specific prior
+ *   written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
+ * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
+ * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+ * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+ * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package org.eclipse.jgit.http.server;
+
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
+import static org.eclipse.jgit.http.server.ClientVersionUtil.hasPushStatusBug;
+import static org.eclipse.jgit.http.server.ClientVersionUtil.invalidVersion;
+import static org.eclipse.jgit.http.server.ClientVersionUtil.parseVersion;
+
+import org.junit.Assert;
+import org.junit.Test;
+
+public class ClientVersionUtilTest {
+	@Test
+	public void testParse() {
+		assertEquals("1.6.5", parseVersion("git/1.6.6-rc0"));
+		assertEquals("1.6.6", parseVersion("git/1.6.6"));
+		assertEquals("1.7.5", parseVersion("git/1.7.5.GIT"));
+		assertEquals("1.7.6.1", parseVersion("git/1.7.6.1.45.gbe0cc"));
+
+		assertEquals("1.5.4.3", parseVersion("git/1.5.4.3,gzip(proxy)"));
+		assertEquals("1.7.0.2", parseVersion("git/1.7.0.2.msysgit.0.14.g956d7,gzip"));
+		assertEquals("1.7.10.2", parseVersion("git/1.7.10.2 (Apple Git-33)"));
+
+		assertEquals(ClientVersionUtil.toString(invalidVersion()), parseVersion("foo"));
+	}
+
+	@Test
+	public void testPushStatusBug() {
+		assertTrue(hasPushStatusBug(parseVersion("git/1.6.6")));
+		assertTrue(hasPushStatusBug(parseVersion("git/1.6.6.1")));
+		assertTrue(hasPushStatusBug(parseVersion("git/1.7.9")));
+
+		assertFalse(hasPushStatusBug(parseVersion("git/1.7.8.6")));
+		assertFalse(hasPushStatusBug(parseVersion("git/1.7.9.1")));
+		assertFalse(hasPushStatusBug(parseVersion("git/1.7.9.2")));
+		assertFalse(hasPushStatusBug(parseVersion("git/1.7.10")));
+	}
+
+	private static void assertEquals(String exp, int[] act) {
+		Assert.assertEquals(exp, ClientVersionUtil.toString(act));
+	}
+}

org.eclipse.jgit/src/org/eclipse/jgit/transport/BaseReceivePack.java

@@ -1210,9 +1210,10 @@ public abstract class BaseReceivePack {
 			}
 
 			final StringBuilder r = new StringBuilder();
-			r.append("ng ");
-			r.append(cmd.getRefName());
-			r.append(" ");
+			if (forClient)
+				r.append("ng ").append(cmd.getRefName()).append(" ");
+			else
+				r.append(" ! [rejected] ").append(cmd.getRefName()).append(" (");
 
 			switch (cmd.getResult()) {
 			case NOT_ATTEMPTED:
@@ -1259,6 +1260,8 @@ public abstract class BaseReceivePack {
 				// We shouldn't have reached this case (see 'ok' case above).
 				continue;
 			}
+			if (!forClient)
+				r.append(")");
 			out.sendString(r.toString());
 		}
 	}

org.eclipse.jgit/src/org/eclipse/jgit/transport/ReceivePack.java

@@ -63,6 +63,8 @@ public class ReceivePack extends BaseReceivePack {
 	/** Hook to report on the commands after execution. */
 	private PostReceiveHook postReceive;
 
+	private boolean echoCommandFailures;
+
 	/**
 	 * Create a new pack receive for an open repository.
 	 *
@@ -117,6 +119,17 @@ public class ReceivePack extends BaseReceivePack {
 		postReceive = h != null ? h : PostReceiveHook.NULL;
 	}
 
+	/**
+	 * @param echo
+	 *            if true this class will report command failures as warning
+	 *            messages before sending the command results. This is usually
+	 *            not necessary, but may help buggy Git clients that discard the
+	 *            errors when all branches fail.
+	 */
+	public void setEchoCommandFailures(boolean echo) {
+		echoCommandFailures = echo;
+	}
+
 	/**
 	 * Execute the receive task on the socket.
 	 *
@@ -182,6 +195,19 @@ public class ReceivePack extends BaseReceivePack {
 			unlockPack();
 
 			if (reportStatus) {
+				if (echoCommandFailures && msgOut != null) {
+					sendStatusReport(false, unpackError, new Reporter() {
+						void sendString(final String s) throws IOException {
+							msgOut.write(Constants.encode(s + "\n"));
+						}
+					});
+					msgOut.flush();
+					try {
+						Thread.sleep(500);
+					} catch (InterruptedException wakeUp) {
+						// Ignore an early wake up.
+					}
+				}
 				sendStatusReport(true, unpackError, new Reporter() {
 					void sendString(final String s) throws IOException {
 						pckOut.writeString(s + "\n");