From 8d512c7ebff279db5b5d936d2be55b275ed4d307 Mon Sep 17 00:00:00 2001 From: Marek Zawirski Date: Sat, 28 Jun 2008 00:06:35 +0200 Subject: [PATCH] Add BasePackPushConnection implementing git-send-pack protocol Implementation realies extensively on RemoteRefUpdate as input. It supports report-status capability, and honors delete-refs one. Signed-off-by: Marek Zawirski Signed-off-by: Robin Rosenberg --- .../jgit/transport/BasePackPushConnection.java | 226 +++++++++++++++++++++ 1 file changed, 226 insertions(+) create mode 100644 org.spearce.jgit/src/org/spearce/jgit/transport/BasePackPushConnection.java diff --git a/org.spearce.jgit/src/org/spearce/jgit/transport/BasePackPushConnection.java b/org.spearce.jgit/src/org/spearce/jgit/transport/BasePackPushConnection.java new file mode 100644 index 00000000..b07c54fb --- /dev/null +++ b/org.spearce.jgit/src/org/spearce/jgit/transport/BasePackPushConnection.java @@ -0,0 +1,226 @@ +/* + * Copyright (C) 2008, Marek Zawirski + * Copyright (C) 2008, Shawn O. Pearce + * + * 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 Git Development Community 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.spearce.jgit.transport; + +import java.io.IOException; +import java.util.ArrayList; +import java.util.Collection; +import java.util.Map; + +import org.spearce.jgit.errors.PackProtocolException; +import org.spearce.jgit.errors.TransportException; +import org.spearce.jgit.lib.ObjectId; +import org.spearce.jgit.lib.PackWriter; +import org.spearce.jgit.lib.ProgressMonitor; +import org.spearce.jgit.lib.Ref; +import org.spearce.jgit.transport.RemoteRefUpdate.Status; + +/** + * Push implementation using the native Git pack transfer service. + *

+ * This is the canonical implementation for transferring objects to the remote + * repository from the local repository by talking to the 'git-receive-pack' + * service. Objects are packed on the local side into a pack file and then sent + * to the remote repository. + *

+ * This connection requires only a bi-directional pipe or socket, and thus is + * easily wrapped up into a local process pipe, anonymous TCP socket, or a + * command executed through an SSH tunnel. + *

+ * This implementation honors {@link Transport#isPushThin()} option. + *

+ * Concrete implementations should just call + * {@link #init(java.io.InputStream, java.io.OutputStream)} and + * {@link #readAdvertisedRefs()} methods in constructor or before any use. They + * should also handle resources releasing in {@link #close()} method if needed. + */ +class BasePackPushConnection extends BasePackConnection implements + PushConnection { + static final String CAPABILITY_REPORT_STATUS = "report-status"; + + static final String CAPABILITY_DELETE_REFS = "delete-refs"; + + private final boolean thinPack; + + private boolean capableDeleteRefs; + + private boolean capableReport; + + private boolean sentCommand; + + private boolean writePack; + + BasePackPushConnection(final PackTransport transport) { + super(transport); + thinPack = transport.isPushThin(); + } + + public void push(final ProgressMonitor monitor, + final Map refUpdates) + throws TransportException { + markStartedOperation(); + doPush(monitor, refUpdates); + } + + protected void doPush(final ProgressMonitor monitor, + final Map refUpdates) + throws TransportException { + try { + writeCommands(refUpdates.values(), monitor); + if (writePack) + writePack(refUpdates, monitor); + if (sentCommand && capableReport) + readStatusReport(refUpdates); + } catch (TransportException e) { + throw e; + } catch (Exception e) { + throw new TransportException(uri + ": " + e.getMessage(), e); + } finally { + close(); + } + } + + private void writeCommands(final Collection refUpdates, + final ProgressMonitor monitor) throws IOException { + final String capabilties = enableCapabilties(); + for (final RemoteRefUpdate rru : refUpdates) { + if (!capableDeleteRefs && rru.isDelete()) { + rru.setStatus(Status.REJECTED_NODELETE); + continue; + } + + final StringBuilder sb = new StringBuilder(); + final Ref advertisedRef = getRef(rru.getRemoteName()); + final ObjectId oldId = (advertisedRef == null ? ObjectId.zeroId() + : advertisedRef.getObjectId()); + sb.append(oldId); + sb.append(' '); + sb.append(rru.getNewObjectId()); + sb.append(' '); + sb.append(rru.getRemoteName()); + if (!sentCommand) { + sentCommand = true; + sb.append(capabilties); + } + + pckOut.writeString(sb.toString()); + rru.setStatus(sentCommand ? Status.AWAITING_REPORT : Status.OK); + if (!rru.isDelete()) + writePack = true; + } + + if (monitor.isCancelled()) + throw new TransportException(uri + ": push cancelled"); + pckOut.end(); + } + + private String enableCapabilties() { + final StringBuilder line = new StringBuilder(); + capableReport = wantCapability(line, CAPABILITY_REPORT_STATUS); + capableDeleteRefs = wantCapability(line, CAPABILITY_DELETE_REFS); + if (line.length() > 0) + line.insert(0, '\0'); + return line.toString(); + } + + private void writePack(final Map refUpdates, + final ProgressMonitor monitor) throws IOException { + final PackWriter writer = new PackWriter(local, out, monitor); + final ArrayList remoteObjects = new ArrayList( + getRefs().size()); + final ArrayList newObjects = new ArrayList( + refUpdates.size()); + + for (final Ref r : getRefs()) + remoteObjects.add(r.getObjectId()); + for (final RemoteRefUpdate r : refUpdates.values()) + newObjects.add(r.getNewObjectId()); + + writer.writePack(newObjects, remoteObjects, thinPack, true); + } + + private void readStatusReport(final Map refUpdates) + throws IOException { + final String unpackLine = pckIn.readString(); + if (!unpackLine.startsWith("unpack ")) + throw new PackProtocolException(uri + ": unexpected report line: " + + unpackLine); + final String unpackStatus = unpackLine.substring("unpack ".length()); + if (!unpackStatus.equals("ok")) + throw new TransportException(uri + + ": error occurred during unpacking on the remote end: " + + unpackStatus); + + String refLine; + while ((refLine = pckIn.readString()).length() > 0) { + boolean ok = false; + int refNameEnd = -1; + if (refLine.startsWith("ok ")) { + ok = true; + refNameEnd = refLine.length(); + } else if (refLine.startsWith("ng ")) { + ok = false; + refNameEnd = refLine.indexOf(" ", 3); + } + if (refNameEnd == -1) + throw new PackProtocolException(uri + + ": unexpected report line: " + refLine); + final String refName = refLine.substring(3, refNameEnd); + final String message = (ok ? null : refLine + .substring(refNameEnd + 1)); + + final RemoteRefUpdate rru = refUpdates.get(refName); + if (rru == null) + throw new PackProtocolException(uri + + ": unexpected ref report: " + refName); + if (ok) { + rru.setStatus(Status.OK); + } else { + rru.setStatus(Status.REJECTED_OTHER_REASON); + rru.setMessage(message); + } + } + for (final RemoteRefUpdate rru : refUpdates.values()) { + if (rru.getStatus() == Status.AWAITING_REPORT) + throw new PackProtocolException(uri + + ": expected report for ref " + rru.getRemoteName() + + " not received"); + } + } +} -- 2.11.4.GIT