123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360 |
- /*
- * Copyright (C) 2010, Mathias Kinzler <mathias.kinzler@sap.com>
- * Copyright (C) 2010, Chris Aniszczyk <caniszczyk@gmail.com>
- * 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.api;
-
- import java.io.IOException;
- import java.text.MessageFormat;
-
- import org.eclipse.jgit.api.errors.GitAPIException;
- import org.eclipse.jgit.api.errors.InvalidRefNameException;
- import org.eclipse.jgit.api.errors.JGitInternalException;
- import org.eclipse.jgit.api.errors.RefAlreadyExistsException;
- import org.eclipse.jgit.api.errors.RefNotFoundException;
- import org.eclipse.jgit.errors.AmbiguousObjectException;
- import org.eclipse.jgit.internal.JGitText;
- import org.eclipse.jgit.lib.ConfigConstants;
- import org.eclipse.jgit.lib.Constants;
- import org.eclipse.jgit.lib.ObjectId;
- import org.eclipse.jgit.lib.Ref;
- import org.eclipse.jgit.lib.RefUpdate;
- import org.eclipse.jgit.lib.RefUpdate.Result;
- import org.eclipse.jgit.lib.Repository;
- import org.eclipse.jgit.lib.StoredConfig;
- import org.eclipse.jgit.revwalk.RevCommit;
- import org.eclipse.jgit.revwalk.RevWalk;
-
- /**
- * Used to create a local branch.
- *
- * @see <a
- * href="http://www.kernel.org/pub/software/scm/git/docs/git-branch.html"
- * >Git documentation about Branch</a>
- */
- public class CreateBranchCommand extends GitCommand<Ref> {
- private String name;
-
- private boolean force = false;
-
- private SetupUpstreamMode upstreamMode;
-
- private String startPoint = Constants.HEAD;
-
- private RevCommit startCommit;
-
- /**
- * The modes available for setting up the upstream configuration
- * (corresponding to the --set-upstream, --track, --no-track options
- *
- */
- public enum SetupUpstreamMode {
- /**
- * Corresponds to the --track option
- */
- TRACK,
- /**
- * Corresponds to the --no-track option
- */
- NOTRACK,
- /**
- * Corresponds to the --set-upstream option
- */
- SET_UPSTREAM;
- }
-
- /**
- * @param repo
- */
- protected CreateBranchCommand(Repository repo) {
- super(repo);
- }
-
- /**
- * @throws RefAlreadyExistsException
- * when trying to create (without force) a branch with a name
- * that already exists
- * @throws RefNotFoundException
- * if the start point can not be found
- * @throws InvalidRefNameException
- * if the provided name is <code>null</code> or otherwise
- * invalid
- * @return the newly created branch
- */
- public Ref call() throws GitAPIException, RefAlreadyExistsException,
- RefNotFoundException, InvalidRefNameException {
- checkCallable();
- processOptions();
- try (RevWalk revWalk = new RevWalk(repo)) {
- Ref refToCheck = repo.findRef(name);
- boolean exists = refToCheck != null
- && refToCheck.getName().startsWith(Constants.R_HEADS);
- if (!force && exists)
- throw new RefAlreadyExistsException(MessageFormat.format(
- JGitText.get().refAlreadyExists1, name));
-
- ObjectId startAt = getStartPointObjectId();
- String startPointFullName = null;
- if (startPoint != null) {
- Ref baseRef = repo.findRef(startPoint);
- if (baseRef != null)
- startPointFullName = baseRef.getName();
- }
-
- // determine whether we are based on a commit,
- // a branch, or a tag and compose the reflog message
- String refLogMessage;
- String baseBranch = ""; //$NON-NLS-1$
- if (startPointFullName == null) {
- String baseCommit;
- if (startCommit != null)
- baseCommit = startCommit.getShortMessage();
- else {
- RevCommit commit = revWalk.parseCommit(repo
- .resolve(getStartPointOrHead()));
- baseCommit = commit.getShortMessage();
- }
- if (exists)
- refLogMessage = "branch: Reset start-point to commit " //$NON-NLS-1$
- + baseCommit;
- else
- refLogMessage = "branch: Created from commit " + baseCommit; //$NON-NLS-1$
-
- } else if (startPointFullName.startsWith(Constants.R_HEADS)
- || startPointFullName.startsWith(Constants.R_REMOTES)) {
- baseBranch = startPointFullName;
- if (exists)
- refLogMessage = "branch: Reset start-point to branch " //$NON-NLS-1$
- + startPointFullName; // TODO
- else
- refLogMessage = "branch: Created from branch " + baseBranch; //$NON-NLS-1$
- } else {
- startAt = revWalk.peel(revWalk.parseAny(startAt));
- if (exists)
- refLogMessage = "branch: Reset start-point to tag " //$NON-NLS-1$
- + startPointFullName;
- else
- refLogMessage = "branch: Created from tag " //$NON-NLS-1$
- + startPointFullName;
- }
-
- RefUpdate updateRef = repo.updateRef(Constants.R_HEADS + name);
- updateRef.setNewObjectId(startAt);
- updateRef.setRefLogMessage(refLogMessage, false);
- Result updateResult;
- if (exists && force)
- updateResult = updateRef.forceUpdate();
- else
- updateResult = updateRef.update();
-
- setCallable(false);
-
- boolean ok = false;
- switch (updateResult) {
- case NEW:
- ok = !exists;
- break;
- case NO_CHANGE:
- case FAST_FORWARD:
- case FORCED:
- ok = exists;
- break;
- default:
- break;
- }
-
- if (!ok)
- throw new JGitInternalException(MessageFormat.format(JGitText
- .get().createBranchUnexpectedResult, updateResult
- .name()));
-
- Ref result = repo.findRef(name);
- if (result == null)
- throw new JGitInternalException(
- JGitText.get().createBranchFailedUnknownReason);
-
- if (baseBranch.length() == 0) {
- return result;
- }
-
- // if we are based on another branch, see
- // if we need to configure upstream configuration: first check
- // whether the setting was done explicitly
- boolean doConfigure;
- if (upstreamMode == SetupUpstreamMode.SET_UPSTREAM
- || upstreamMode == SetupUpstreamMode.TRACK)
- // explicitly set to configure
- doConfigure = true;
- else if (upstreamMode == SetupUpstreamMode.NOTRACK)
- // explicitly set to not configure
- doConfigure = false;
- else {
- // if there was no explicit setting, check the configuration
- String autosetupflag = repo.getConfig().getString(
- ConfigConstants.CONFIG_BRANCH_SECTION, null,
- ConfigConstants.CONFIG_KEY_AUTOSETUPMERGE);
- if ("false".equals(autosetupflag)) { //$NON-NLS-1$
- doConfigure = false;
- } else if ("always".equals(autosetupflag)) { //$NON-NLS-1$
- doConfigure = true;
- } else {
- // in this case, the default is to configure
- // only in case the base branch was a remote branch
- doConfigure = baseBranch.startsWith(Constants.R_REMOTES);
- }
- }
-
- if (doConfigure) {
- StoredConfig config = repo.getConfig();
-
- String remoteName = repo.getRemoteName(baseBranch);
- if (remoteName != null) {
- String branchName = repo
- .shortenRemoteBranchName(baseBranch);
- config
- .setString(ConfigConstants.CONFIG_BRANCH_SECTION,
- name, ConfigConstants.CONFIG_KEY_REMOTE,
- remoteName);
- config.setString(ConfigConstants.CONFIG_BRANCH_SECTION,
- name, ConfigConstants.CONFIG_KEY_MERGE,
- Constants.R_HEADS + branchName);
- } else {
- // set "." as remote
- config.setString(ConfigConstants.CONFIG_BRANCH_SECTION,
- name, ConfigConstants.CONFIG_KEY_REMOTE, "."); //$NON-NLS-1$
- config.setString(ConfigConstants.CONFIG_BRANCH_SECTION,
- name, ConfigConstants.CONFIG_KEY_MERGE, baseBranch);
- }
- config.save();
- }
- return result;
- } catch (IOException ioe) {
- throw new JGitInternalException(ioe.getMessage(), ioe);
- }
- }
-
- private ObjectId getStartPointObjectId() throws AmbiguousObjectException,
- RefNotFoundException, IOException {
- if (startCommit != null)
- return startCommit.getId();
- String startPointOrHead = getStartPointOrHead();
- ObjectId result = repo.resolve(startPointOrHead);
- if (result == null)
- throw new RefNotFoundException(MessageFormat.format(
- JGitText.get().refNotResolved, startPointOrHead));
- return result;
- }
-
- private String getStartPointOrHead() {
- return startPoint != null ? startPoint : Constants.HEAD;
- }
-
- private void processOptions() throws InvalidRefNameException {
- if (name == null
- || !Repository.isValidRefName(Constants.R_HEADS + name))
- throw new InvalidRefNameException(MessageFormat.format(JGitText
- .get().branchNameInvalid, name == null ? "<null>" : name)); //$NON-NLS-1$
- }
-
- /**
- * @param name
- * the name of the new branch
- * @return this instance
- */
- public CreateBranchCommand setName(String name) {
- checkCallable();
- this.name = name;
- return this;
- }
-
- /**
- * @param force
- * if <code>true</code> and the branch with the given name
- * already exists, the start-point of an existing branch will be
- * set to a new start-point; if false, the existing branch will
- * not be changed
- * @return this instance
- */
- public CreateBranchCommand setForce(boolean force) {
- checkCallable();
- this.force = force;
- return this;
- }
-
- /**
- * @param startPoint
- * corresponds to the start-point option; if <code>null</code>,
- * the current HEAD will be used
- * @return this instance
- */
- public CreateBranchCommand setStartPoint(String startPoint) {
- checkCallable();
- this.startPoint = startPoint;
- this.startCommit = null;
- return this;
- }
-
- /**
- * @param startPoint
- * corresponds to the start-point option; if <code>null</code>,
- * the current HEAD will be used
- * @return this instance
- */
- public CreateBranchCommand setStartPoint(RevCommit startPoint) {
- checkCallable();
- this.startCommit = startPoint;
- this.startPoint = null;
- return this;
- }
-
- /**
- * @param mode
- * corresponds to the --track/--no-track/--set-upstream options;
- * may be <code>null</code>
- * @return this instance
- */
- public CreateBranchCommand setUpstreamMode(SetupUpstreamMode mode) {
- checkCallable();
- this.upstreamMode = mode;
- return this;
- }
- }
|