/*
    * Copyright (C) 2008, Robin Rosenberg <robin.rosenberg@dewire.com>
    * Copyright (C) 2008, Shawn O. Pearce <spearce@spearce.org>
    * 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.transport;
  
  import static org.eclipse.jgit.transport.ReceiveCommand.Result.NOT_ATTEMPTED;
  import static org.eclipse.jgit.transport.ReceiveCommand.Result.OK;
  import static org.eclipse.jgit.transport.ReceiveCommand.Result.REJECTED_NONFASTFORWARD;
  import static org.eclipse.jgit.transport.ReceiveCommand.Type.UPDATE_NONFASTFORWARD;
  
  import java.io.File;
  import java.io.IOException;
  import java.io.OutputStreamWriter;
  import java.io.Writer;
  import java.text.MessageFormat;
  import java.util.ArrayList;
  import java.util.Collection;
  import java.util.Collections;
  import java.util.HashMap;
  import java.util.HashSet;
  import java.util.Iterator;
  import java.util.Map;
  import java.util.Set;
  import java.util.concurrent.TimeUnit;
  
  import org.eclipse.jgit.errors.MissingObjectException;
  import org.eclipse.jgit.errors.NotSupportedException;
  import org.eclipse.jgit.errors.TransportException;
  import org.eclipse.jgit.internal.JGitText;
  import org.eclipse.jgit.internal.storage.file.LockFile;
  import org.eclipse.jgit.internal.storage.file.PackLock;
  import org.eclipse.jgit.lib.BatchRefUpdate;
  import org.eclipse.jgit.lib.BatchingProgressMonitor;
  import org.eclipse.jgit.lib.Constants;
  import org.eclipse.jgit.lib.ObjectId;
  import org.eclipse.jgit.lib.ObjectIdRef;
  import org.eclipse.jgit.lib.ProgressMonitor;
  import org.eclipse.jgit.lib.Ref;
  import org.eclipse.jgit.lib.RefDatabase;
  import org.eclipse.jgit.revwalk.ObjectWalk;
  import org.eclipse.jgit.revwalk.RevWalk;
  
  class FetchProcess {
  	/** Transport we will fetch over. */
  	private final Transport transport;
  
  	/** List of things we want to fetch from the remote repository. */
  	private final Collection<RefSpec> toFetch;
  
  	/** Set of refs we will actually wind up asking to obtain. */
  	private final HashMap<ObjectId, Ref> askFor = new HashMap<>();
  
  	/** Objects we know we have locally. */
  	private final HashSet<ObjectId> have = new HashSet<>();
  
  	/** Updates to local tracking branches (if any). */
  	private final ArrayList<TrackingRefUpdate> localUpdates = new ArrayList<>();
  
 	/** Records to be recorded into FETCH_HEAD. */
 	private final ArrayList<FetchHeadRecord> fetchHeadUpdates = new ArrayList<>();
 
 	private final ArrayList<PackLock> packLocks = new ArrayList<>();
 
 	private FetchConnection conn;
 
 	private Map<String, Ref> localRefs;
 
 	FetchProcess(final Transport t, final Collection<RefSpec> f) {
 		transport = t;
 		toFetch = f;
 	}
 
 	void execute(final ProgressMonitor monitor, final FetchResult result)
 			throws NotSupportedException, TransportException {
 		askFor.clear();
 		localUpdates.clear();
 		fetchHeadUpdates.clear();
 		packLocks.clear();
 		localRefs = null;
 
 		try {
 			executeImp(monitor, result);
 		} finally {
 			try {
 			for (final PackLock lock : packLocks)
 				lock.unlock();
 			} catch (IOException e) {
 				throw new TransportException(e.getMessage(), e);
 			}
 		}
 	}
 
 	private void executeImp(final ProgressMonitor monitor,
 			final FetchResult result) throws NotSupportedException,
 			TransportException {
 		conn = transport.openFetch();
 		try {
 			result.setAdvertisedRefs(transport.getURI(), conn.getRefsMap());
 			result.peerUserAgent = conn.getPeerUserAgent();
 			final Set<Ref> matched = new HashSet<>();
 			for (final RefSpec spec : toFetch) {
 				if (spec.getSource() == null)
 					throw new TransportException(MessageFormat.format(
 							JGitText.get().sourceRefNotSpecifiedForRefspec, spec));
 
 				if (spec.isWildcard())
 					expandWildcard(spec, matched);
 				else
 					expandSingle(spec, matched);
 			}
 
 			Collection<Ref> additionalTags = Collections.<Ref> emptyList();
 			final TagOpt tagopt = transport.getTagOpt();
 			if (tagopt == TagOpt.AUTO_FOLLOW)
 				additionalTags = expandAutoFollowTags();
 			else if (tagopt == TagOpt.FETCH_TAGS)
 				expandFetchTags();
 
 			final boolean includedTags;
 			if (!askFor.isEmpty() && !askForIsComplete()) {
 				fetchObjects(monitor);
 				includedTags = conn.didFetchIncludeTags();
 
 				// Connection was used for object transfer. If we
 				// do another fetch we must open a new connection.
 				//
 				closeConnection(result);
 			} else {
 				includedTags = false;
 			}
 
 			if (tagopt == TagOpt.AUTO_FOLLOW && !additionalTags.isEmpty()) {
 				// There are more tags that we want to follow, but
 				// not all were asked for on the initial request.
 				//
 				have.addAll(askFor.keySet());
 				askFor.clear();
 				for (final Ref r : additionalTags) {
 					ObjectId id = r.getPeeledObjectId();
 					if (id == null)
 						id = r.getObjectId();
 					if (transport.local.hasObject(id))
 						wantTag(r);
 				}
 
 				if (!askFor.isEmpty() && (!includedTags || !askForIsComplete())) {
 					reopenConnection();
 					if (!askFor.isEmpty())
 						fetchObjects(monitor);
 				}
 			}
 		} finally {
 			closeConnection(result);
 		}
 
 		BatchRefUpdate batch = transport.local.getRefDatabase()
 				.newBatchUpdate()
 				.setAllowNonFastForwards(true)
 				.setRefLogMessage("fetch", true); //$NON-NLS-1$
 		try (final RevWalk walk = new RevWalk(transport.local)) {
 			if (monitor instanceof BatchingProgressMonitor) {
 				((BatchingProgressMonitor) monitor).setDelayStart(
 						250, TimeUnit.MILLISECONDS);
 			}
 			if (transport.isRemoveDeletedRefs())
 				deleteStaleTrackingRefs(result, batch);
 			for (TrackingRefUpdate u : localUpdates) {
 				result.add(u);
 				batch.addCommand(u.asReceiveCommand());
 			}
 			for (ReceiveCommand cmd : batch.getCommands()) {
 				cmd.updateType(walk);
 				if (cmd.getType() == UPDATE_NONFASTFORWARD
 						&& cmd instanceof TrackingRefUpdate.Command
 						&& !((TrackingRefUpdate.Command) cmd).canForceUpdate())
 					cmd.setResult(REJECTED_NONFASTFORWARD);
 			}
 			if (transport.isDryRun()) {
 				for (ReceiveCommand cmd : batch.getCommands()) {
 					if (cmd.getResult() == NOT_ATTEMPTED)
 						cmd.setResult(OK);
 				}
 			} else
 				batch.execute(walk, monitor);
 		} catch (IOException err) {
 			throw new TransportException(MessageFormat.format(
 					JGitText.get().failureUpdatingTrackingRef,
 					getFirstFailedRefName(batch), err.getMessage()), err);
 		}
 
 		if (!fetchHeadUpdates.isEmpty()) {
 			try {
 				updateFETCH_HEAD(result);
 			} catch (IOException err) {
 				throw new TransportException(MessageFormat.format(
 						JGitText.get().failureUpdatingFETCH_HEAD, err.getMessage()), err);
 			}
 		}
 	}
 
 	private void fetchObjects(final ProgressMonitor monitor)
 			throws TransportException {
 		try {
 			conn.setPackLockMessage("jgit fetch " + transport.uri); //$NON-NLS-1$
 			conn.fetch(monitor, askFor.values(), have);
 		} finally {
 			packLocks.addAll(conn.getPackLocks());
 		}
 		if (transport.isCheckFetchedObjects()
 				&& !conn.didFetchTestConnectivity() && !askForIsComplete())
 			throw new TransportException(transport.getURI(),
 					JGitText.get().peerDidNotSupplyACompleteObjectGraph);
 	}
 
 	private void closeConnection(final FetchResult result) {
 		if (conn != null) {
 			conn.close();
 			result.addMessages(conn.getMessages());
 			conn = null;
 		}
 	}
 
 	private void reopenConnection() throws NotSupportedException,
 			TransportException {
 		if (conn != null)
 			return;
 
 		conn = transport.openFetch();
 
 		// Since we opened a new connection we cannot be certain
 		// that the system we connected to has the same exact set
 		// of objects available (think round-robin DNS and mirrors
 		// that aren't updated at the same time).
 		//
 		// We rebuild our askFor list using only the refs that the
 		// new connection has offered to us.
 		//
 		final HashMap<ObjectId, Ref> avail = new HashMap<>();
 		for (final Ref r : conn.getRefs())
 			avail.put(r.getObjectId(), r);
 
 		final Collection<Ref> wants = new ArrayList<>(askFor.values());
 		askFor.clear();
 		for (final Ref want : wants) {
 			final Ref newRef = avail.get(want.getObjectId());
 			if (newRef != null) {
 				askFor.put(newRef.getObjectId(), newRef);
 			} else {
 				removeFetchHeadRecord(want.getObjectId());
 				removeTrackingRefUpdate(want.getObjectId());
 			}
 		}
 	}
 
 	private void removeTrackingRefUpdate(final ObjectId want) {
 		final Iterator<TrackingRefUpdate> i = localUpdates.iterator();
 		while (i.hasNext()) {
 			final TrackingRefUpdate u = i.next();
 			if (u.getNewObjectId().equals(want))
 				i.remove();
 		}
 	}
 
 	private void removeFetchHeadRecord(final ObjectId want) {
 		final Iterator<FetchHeadRecord> i = fetchHeadUpdates.iterator();
 		while (i.hasNext()) {
 			final FetchHeadRecord fh = i.next();
 			if (fh.newValue.equals(want))
 				i.remove();
 		}
 	}
 
 	private void updateFETCH_HEAD(final FetchResult result) throws IOException {
 		File meta = transport.local.getDirectory();
 		if (meta == null)
 			return;
 		final LockFile lock = new LockFile(new File(meta, "FETCH_HEAD")); //$NON-NLS-1$
 		try {
 			if (lock.lock()) {
 				final Writer w = new OutputStreamWriter(lock.getOutputStream());
 				try {
 					for (final FetchHeadRecord h : fetchHeadUpdates) {
 						h.write(w);
 						result.add(h);
 					}
 				} finally {
 					w.close();
 				}
 				lock.commit();
 			}
 		} finally {
 			lock.unlock();
 		}
 	}
 
 	private boolean askForIsComplete() throws TransportException {
 		try {
 			try (final ObjectWalk ow = new ObjectWalk(transport.local)) {
 				for (final ObjectId want : askFor.keySet())
 					ow.markStart(ow.parseAny(want));
 				for (final Ref ref : localRefs().values())
 					ow.markUninteresting(ow.parseAny(ref.getObjectId()));
 				ow.checkConnectivity();
 			}
 			return true;
 		} catch (MissingObjectException e) {
 			return false;
 		} catch (IOException e) {
 			throw new TransportException(JGitText.get().unableToCheckConnectivity, e);
 		}
 	}
 
 	private void expandWildcard(final RefSpec spec, final Set<Ref> matched)
 			throws TransportException {
 		for (final Ref src : conn.getRefs()) {
 			if (spec.matchSource(src) && matched.add(src))
 				want(src, spec.expandFromSource(src));
 		}
 	}
 
 	private void expandSingle(final RefSpec spec, final Set<Ref> matched)
 			throws TransportException {
 		String want = spec.getSource();
 		if (ObjectId.isId(want)) {
 			want(ObjectId.fromString(want));
 			return;
 		}
 
 		Ref src = conn.getRef(want);
 		if (src == null) {
 			throw new TransportException(MessageFormat.format(JGitText.get().remoteDoesNotHaveSpec, want));
 		}
 		if (matched.add(src)) {
 			want(src, spec);
 		}
 	}
 
 	private Collection<Ref> expandAutoFollowTags() throws TransportException {
 		final Collection<Ref> additionalTags = new ArrayList<>();
 		final Map<String, Ref> haveRefs = localRefs();
 		for (final Ref r : conn.getRefs()) {
 			if (!isTag(r))
 				continue;
 
 			Ref local = haveRefs.get(r.getName());
 			if (local != null)
 				// We already have a tag with this name, don't fetch it (even if
 				// the local is different).
 				continue;
 
 			ObjectId obj = r.getPeeledObjectId();
 			if (obj == null)
 				obj = r.getObjectId();
 
 			if (askFor.containsKey(obj) || transport.local.hasObject(obj))
 				wantTag(r);
 			else
 				additionalTags.add(r);
 		}
 		return additionalTags;
 	}
 
 	private void expandFetchTags() throws TransportException {
 		final Map<String, Ref> haveRefs = localRefs();
 		for (final Ref r : conn.getRefs()) {
 			if (!isTag(r)) {
 				continue;
 			}
 			ObjectId id = r.getObjectId();
 			if (id == null) {
 				continue;
 			}
 			final Ref local = haveRefs.get(r.getName());
 			if (local == null || !id.equals(local.getObjectId())) {
 				wantTag(r);
 			}
 		}
 	}
 
 	private void wantTag(final Ref r) throws TransportException {
 		want(r, new RefSpec().setSource(r.getName())
 				.setDestination(r.getName()).setForceUpdate(true));
 	}
 
 	private void want(final Ref src, final RefSpec spec)
 			throws TransportException {
 		final ObjectId newId = src.getObjectId();
 		if (newId == null) {
 			throw new NullPointerException(MessageFormat.format(
 					JGitText.get().transportProvidedRefWithNoObjectId,
 					src.getName()));
 		}
 		if (spec.getDestination() != null) {
 			final TrackingRefUpdate tru = createUpdate(spec, newId);
 			if (newId.equals(tru.getOldObjectId()))
 				return;
 			localUpdates.add(tru);
 		}
 
 		askFor.put(newId, src);
 
 		final FetchHeadRecord fhr = new FetchHeadRecord();
 		fhr.newValue = newId;
 		fhr.notForMerge = spec.getDestination() != null;
 		fhr.sourceName = src.getName();
 		fhr.sourceURI = transport.getURI();
 		fetchHeadUpdates.add(fhr);
 	}
 
 	private void want(ObjectId id) {
 		askFor.put(id,
 				new ObjectIdRef.Unpeeled(Ref.Storage.NETWORK, id.name(), id));
 	}
 
 	private TrackingRefUpdate createUpdate(RefSpec spec, ObjectId newId)
 			throws TransportException {
 		Ref ref = localRefs().get(spec.getDestination());
 		ObjectId oldId = ref != null && ref.getObjectId() != null
 				? ref.getObjectId()
 				: ObjectId.zeroId();
 		return new TrackingRefUpdate(
 				spec.isForceUpdate(),
 				spec.getSource(),
 				spec.getDestination(),
 				oldId,
 				newId);
 	}
 
 	private Map<String, Ref> localRefs() throws TransportException {
 		if (localRefs == null) {
 			try {
 				localRefs = transport.local.getRefDatabase()
 						.getRefs(RefDatabase.ALL);
 			} catch (IOException err) {
 				throw new TransportException(JGitText.get().cannotListRefs, err);
 			}
 		}
 		return localRefs;
 	}
 
 	private void deleteStaleTrackingRefs(FetchResult result,
 			BatchRefUpdate batch) throws IOException {
 		for (final Ref ref : localRefs().values()) {
 			final String refname = ref.getName();
 			for (final RefSpec spec : toFetch) {
 				if (spec.matchDestination(refname)) {
 					final RefSpec s = spec.expandFromDestination(refname);
 					if (result.getAdvertisedRef(s.getSource()) == null) {
 						deleteTrackingRef(result, batch, s, ref);
 					}
 				}
 			}
 		}
 	}
 
 	private void deleteTrackingRef(final FetchResult result,
 			final BatchRefUpdate batch, final RefSpec spec, final Ref localRef) {
 		if (localRef.getObjectId() == null)
 			return;
 		TrackingRefUpdate update = new TrackingRefUpdate(
 				true,
 				spec.getSource(),
 				localRef.getName(),
 				localRef.getObjectId(),
 				ObjectId.zeroId());
 		result.add(update);
 		batch.addCommand(update.asReceiveCommand());
 	}
 
 	private static boolean isTag(final Ref r) {
 		return isTag(r.getName());
 	}
 
 	private static boolean isTag(final String name) {
 		return name.startsWith(Constants.R_TAGS);
 	}
 
 	private static String getFirstFailedRefName(BatchRefUpdate batch) {
 		for (ReceiveCommand cmd : batch.getCommands()) {
 			if (cmd.getResult() != ReceiveCommand.Result.OK)
 				return cmd.getRefName();
 		}
 		return ""; //$NON-NLS-1$
 	}
 }