/* * Copyright (C) 2008, 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.transport; import java.io.IOException; import java.text.MessageFormat; import java.util.ArrayList; import java.util.List; import org.eclipse.jgit.internal.JGitText; import org.eclipse.jgit.lib.ObjectId; import org.eclipse.jgit.lib.Ref; import org.eclipse.jgit.lib.RefUpdate; /** * A command being processed by {@link ReceivePack}. *
* This command instance roughly translates to the server side representation of * the {@link RemoteRefUpdate} created by the client. */ public class ReceiveCommand { /** Type of operation requested. */ public static enum Type { /** Create a new ref; the ref must not already exist. */ CREATE, /** * Update an existing ref with a fast-forward update. *
* During a fast-forward update no changes will be lost; only new * commits are inserted into the ref. */ UPDATE, /** * Update an existing ref by potentially discarding objects. *
* The current value of the ref is not fully reachable from the new
* value of the ref, so a successful command may result in one or more
* objects becoming unreachable.
*/
UPDATE_NONFASTFORWARD,
/** Delete an existing ref; the ref should already exist. */
DELETE;
}
/** Result of the update command. */
public static enum Result {
/** The command has not yet been attempted by the server. */
NOT_ATTEMPTED,
/** The server is configured to deny creation of this ref. */
REJECTED_NOCREATE,
/** The server is configured to deny deletion of this ref. */
REJECTED_NODELETE,
/** The update is a non-fast-forward update and isn't permitted. */
REJECTED_NONFASTFORWARD,
/** The update affects HEAD
and cannot be permitted. */
REJECTED_CURRENT_BRANCH,
/**
* One or more objects aren't in the repository.
*
* This is severe indication of either repository corruption on the
* server side, or a bug in the client wherein the client did not supply
* all required objects during the pack transfer.
*/
REJECTED_MISSING_OBJECT,
/** Other failure; see {@link ReceiveCommand#getMessage()}. */
REJECTED_OTHER_REASON,
/** The ref could not be locked and updated atomically; try again. */
LOCK_FAILURE,
/** The change was completed successfully. */
OK;
}
/**
* Filter a list of commands according to result.
*
* @param commands
* commands to filter.
* @param want
* desired status to filter by.
* @return a copy of the command list containing only those commands with
* the desired status.
* @since 2.0
*/
public static List
* Sets the status of the command as a side effect.
*
* @param rp
* receive-pack session.
* @since 2.0
*/
public void execute(final ReceivePack rp) {
try {
final RefUpdate ru = rp.getRepository().updateRef(getRefName());
ru.setRefLogIdent(rp.getRefLogIdent());
switch (getType()) {
case DELETE:
if (!ObjectId.zeroId().equals(getOldId())) {
// We can only do a CAS style delete if the client
// didn't bork its delete request by sending the
// wrong zero id rather than the advertised one.
//
ru.setExpectedOldObjectId(getOldId());
}
ru.setForceUpdate(true);
setResult(ru.delete(rp.getRevWalk()));
break;
case CREATE:
case UPDATE:
case UPDATE_NONFASTFORWARD:
ru.setForceUpdate(rp.isAllowNonFastForwards());
ru.setExpectedOldObjectId(getOldId());
ru.setNewObjectId(getNewId());
ru.setRefLogMessage("push", true);
setResult(ru.update(rp.getRevWalk()));
break;
}
} catch (IOException err) {
setResult(Result.REJECTED_OTHER_REASON, MessageFormat.format(
JGitText.get().lockError, err.getMessage()));
}
}
void setRef(final Ref r) {
ref = r;
}
void setType(final Type t) {
type = t;
}
private void setResult(final RefUpdate.Result r) {
switch (r) {
case NOT_ATTEMPTED:
setResult(Result.NOT_ATTEMPTED);
break;
case LOCK_FAILURE:
case IO_FAILURE:
setResult(Result.LOCK_FAILURE);
break;
case NO_CHANGE:
case NEW:
case FORCED:
case FAST_FORWARD:
setResult(Result.OK);
break;
case REJECTED:
setResult(Result.REJECTED_NONFASTFORWARD);
break;
case REJECTED_CURRENT_BRANCH:
setResult(Result.REJECTED_CURRENT_BRANCH);
break;
default:
setResult(Result.REJECTED_OTHER_REASON, r.name());
break;
}
}
@Override
public String toString() {
return getType().name() + ": " + getOldId().name() + " "
+ getNewId().name() + " " + getRefName();
}
}