Include URIish in bundle transport within any TransportExceptions

[egit.git] / org.spearce.jgit / src / org / spearce / jgit / transport / TransportBundle.java

/*
 * Copyright (C) 2008, Robin Rosenberg <robin.rosenberg@dewire.com>
 * Copyright (C) 2008, Shawn O. Pearce <spearce@spearce.org>
 * Copyright (C) 2008, Google Inc.
 *
 * 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.BufferedInputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Set;

import org.spearce.jgit.errors.MissingObjectException;
import org.spearce.jgit.errors.MissingBundlePrerequisiteException;
import org.spearce.jgit.errors.NotSupportedException;
import org.spearce.jgit.errors.PackProtocolException;
import org.spearce.jgit.errors.TransportException;
import org.spearce.jgit.lib.Constants;
import org.spearce.jgit.lib.ObjectId;
import org.spearce.jgit.lib.ProgressMonitor;
import org.spearce.jgit.lib.Ref;
import org.spearce.jgit.lib.Repository;
import org.spearce.jgit.revwalk.RevCommit;
import org.spearce.jgit.revwalk.RevFlag;
import org.spearce.jgit.revwalk.RevObject;
import org.spearce.jgit.revwalk.RevWalk;
import org.spearce.jgit.util.FS;
import org.spearce.jgit.util.RawParseUtils;

/**
 * Supports fetching from a git bundle (sneaker-net object transport).
 * <p>
 * Push support for a bundle is complex, as one does not have a peer to
 * communicate with to decide what the peer already knows. So push is not
 * supported by the bundle transport.
 */
class TransportBundle extends PackTransport {
        static final String V2_BUNDLE_SIGNATURE = "# v2 git bundle";

        static boolean canHandle(final URIish uri) {
                if (uri.getHost() != null || uri.getPort() > 0 || uri.getUser() != null
                                || uri.getPass() != null || uri.getPath() == null)
                        return false;

                if ("file".equals(uri.getScheme()) || uri.getScheme() == null) {
                        final File f = FS.resolve(new File("."), uri.getPath());
                        return f.isFile() || f.getName().endsWith(".bundle");
                }

                return false;
        }

        private final File bundle;

        TransportBundle(final Repository local, final URIish uri) {
                super(local, uri);
                bundle = FS.resolve(new File("."), uri.getPath()).getAbsoluteFile();
        }

        @Override
        public FetchConnection openFetch() throws NotSupportedException,
                        TransportException {
                return new BundleFetchConnection();
        }

        @Override
        public PushConnection openPush() throws NotSupportedException {
                throw new NotSupportedException(
                                "Push is not supported for bundle transport");
        }

        @Override
        public void close() {
                // Resources must be established per-connection.
        }

        class BundleFetchConnection extends BaseFetchConnection {
                FileInputStream in;

                RewindBufferedInputStream bin;

                final Set<ObjectId> prereqs = new HashSet<ObjectId>();

                BundleFetchConnection() throws TransportException {
                        try {
                                in = new FileInputStream(bundle);
                                bin = new RewindBufferedInputStream(in);
                        } catch (FileNotFoundException err) {
                                throw new TransportException(uri, "not found");
                        }

                        try {
                                switch (readSignature()) {
                                case 2:
                                        readBundleV2();
                                        break;
                                default:
                                        throw new TransportException(uri, "not a bundle");
                                }

                                in.getChannel().position(
                                                in.getChannel().position() - bin.buffered());
                                bin = null;
                        } catch (TransportException err) {
                                close();
                                throw err;
                        } catch (IOException err) {
                                close();
                                throw new TransportException(uri, err.getMessage(), err);
                        } catch (RuntimeException err) {
                                close();
                                throw new TransportException(uri, err.getMessage(), err);
                        }
                }

                private int readSignature() throws IOException {
                        final String rev = readLine(new byte[1024]);
                        if (V2_BUNDLE_SIGNATURE.equals(rev))
                                return 2;
                        throw new TransportException(uri, "not a bundle");
                }

                private void readBundleV2() throws IOException {
                        final byte[] hdrbuf = new byte[1024];
                        final LinkedHashMap<String, Ref> avail = new LinkedHashMap<String, Ref>();
                        for (;;) {
                                String line = readLine(hdrbuf);
                                if (line.length() == 0)
                                        break;

                                if (line.charAt(0) == '-') {
                                        prereqs.add(ObjectId.fromString(line.substring(1, 41)));
                                        continue;
                                }

                                final String name = line.substring(41, line.length());
                                final ObjectId id = ObjectId.fromString(line.substring(0, 40));
                                final Ref prior = avail.put(name, new Ref(Ref.Storage.NETWORK,
                                                name, id));
                                if (prior != null)
                                        throw duplicateAdvertisement(name);
                        }
                        available(avail);
                }

                private PackProtocolException duplicateAdvertisement(final String name) {
                        return new PackProtocolException(uri,
                                        "duplicate advertisements of " + name);
                }

                private String readLine(final byte[] hdrbuf) throws IOException {
                        bin.mark(hdrbuf.length);
                        final int cnt = bin.read(hdrbuf);
                        int lf = 0;
                        while (lf < cnt && hdrbuf[lf] != '\n')
                                lf++;
                        bin.reset();
                        bin.skip(lf);
                        if (lf < cnt && hdrbuf[lf] == '\n')
                                bin.skip(1);
                        return RawParseUtils.decode(Constants.CHARSET, hdrbuf, 0, lf);
                }

                @Override
                protected void doFetch(final ProgressMonitor monitor,
                                final Collection<Ref> want) throws TransportException {
                        verifyPrerequisites();
                        try {
                                final IndexPack ip = IndexPack.create(local, in);
                                ip.setFixThin(true);
                                ip.index(monitor);
                                ip.renameAndOpenPack();
                        } catch (IOException err) {
                                close();
                                throw new TransportException(uri, err.getMessage(), err);
                        } catch (RuntimeException err) {
                                close();
                                throw new TransportException(uri, err.getMessage(), err);
                        }
                }

                private void verifyPrerequisites() throws TransportException {
                        if (prereqs.isEmpty())
                                return;

                        final RevWalk rw = new RevWalk(local);
                        final RevFlag PREREQ = rw.newFlag("PREREQ");
                        final RevFlag SEEN = rw.newFlag("SEEN");

                        final List<ObjectId> missing = new ArrayList<ObjectId>();
                        final List<RevObject> commits = new ArrayList<RevObject>();
                        for (final ObjectId p : prereqs) {
                                try {
                                        final RevCommit c = rw.parseCommit(p);
                                        if (!c.has(PREREQ)) {
                                                c.add(PREREQ);
                                                commits.add(c);
                                        }
                                } catch (MissingObjectException notFound) {
                                        missing.add(p);
                                } catch (IOException err) {
                                        throw new TransportException(uri, "Cannot read commit "
                                                        + p.name(), err);
                                }
                        }
                        if (!missing.isEmpty())
                                throw new MissingBundlePrerequisiteException(uri, missing);

                        for (final Ref r : local.getAllRefs().values()) {
                                try {
                                        rw.markStart(rw.parseCommit(r.getObjectId()));
                                } catch (IOException readError) {
                                        // If we cannot read the value of the ref skip it.
                                }
                        }

                        int remaining = commits.size();
                        try {
                                RevCommit c;
                                while ((c = rw.next()) != null) {
                                        if (c.has(PREREQ)) {
                                                c.add(SEEN);
                                                if (--remaining == 0)
                                                        break;
                                        }
                                }
                        } catch (IOException err) {
                                throw new TransportException(uri, "Cannot read object", err);
                        }

                        if (remaining > 0) {
                                for (final RevObject o : commits) {
                                        if (!o.has(SEEN))
                                                missing.add(o);
                                }
                                throw new MissingBundlePrerequisiteException(uri, missing);
                        }
                }

                @Override
                public void close() {
                        if (in != null) {
                                try {
                                        in.close();
                                } catch (IOException ie) {
                                        // Ignore close failures.
                                } finally {
                                        in = null;
                                        bin = null;
                                }
                        }
                }

                class RewindBufferedInputStream extends BufferedInputStream {
                        RewindBufferedInputStream(final InputStream src) {
                                super(src);
                        }

                        int buffered() {
                                return (count - pos);
                        }
                }
        }
}