/*
 * Copyright (C) 2015 Obeo.
 * 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.hooks;

import java.io.File;
import java.io.IOException;
import java.io.PrintStream;

import org.eclipse.jgit.api.errors.AbortedByHookException;
import org.eclipse.jgit.lib.Constants;
import org.eclipse.jgit.lib.Repository;

The commit-msg hook implementation. This hook is run before the
commit and can reject the commit. It passes one argument to the hook script,
which is the path to the COMMIT_MSG file, relative to the repository
workTree.
Since:
4.0/**
 * The <code>commit-msg</code> hook implementation. This hook is run before the
 * commit and can reject the commit. It passes one argument to the hook script,
 * which is the path to the COMMIT_MSG file, relative to the repository
 * workTree.
 *
 * @since 4.0
 */
public class CommitMsgHook extends GitHook<String> {

	
Constant indicating the name of the commit-smg hook.
/**
	 * Constant indicating the name of the commit-smg hook.
	 */
	public static final String NAME = "commit-msg"; //$NON-NLS-1$

	
The commit message.
/**
	 * The commit message.
	 */
	private String commitMessage;

	
Constructor for CommitMsgHook
Params:
repo – 
           The repository
outputStream –  The output stream the hook must use. null is allowed, in which case the hook will use System.out./**
	 * Constructor for CommitMsgHook
	 *
	 * @param repo
	 *            The repository
	 * @param outputStream
	 *            The output stream the hook must use. {@code null} is allowed,
	 *            in which case the hook will use {@code System.out}.
	 */
	protected CommitMsgHook(Repository repo, PrintStream outputStream) {
		super(repo, outputStream);
	}

	
{@inheritDoc} /** {@inheritDoc} */
	@Override
	public String call() throws IOException, AbortedByHookException {
		if (commitMessage == null) {
			throw new IllegalStateException();
		}
		if (canRun()) {
			getRepository().writeCommitEditMsg(commitMessage);
			doRun();
			commitMessage = getRepository().readCommitEditMsg();
		}
		return commitMessage;
	}

	
Returns:
true if and only if the path to the message commit file is not null (which would happen in a bare repository) and the commit message is also not null./**
	 * @return {@code true} if and only if the path to the message commit file
	 *         is not null (which would happen in a bare repository) and the
	 *         commit message is also not null.
	 */
	private boolean canRun() {
		return getCommitEditMessageFilePath() != null && commitMessage != null;
	}

	
{@inheritDoc} /** {@inheritDoc} */
	@Override
	public String getHookName() {
		return NAME;
	}

	
{@inheritDoc}
This hook receives one parameter, which is the path to the file holding
the current commit-msg, relative to the repository's work tree.
/**
	 * {@inheritDoc}
	 *
	 * This hook receives one parameter, which is the path to the file holding
	 * the current commit-msg, relative to the repository's work tree.
	 */
	@Override
	protected String[] getParameters() {
		return new String[] { getCommitEditMessageFilePath() };
	}

	
Returns:
The path to the commit edit message file relative to the
        repository's work tree, or null if the repository is bare./**
	 * @return The path to the commit edit message file relative to the
	 *         repository's work tree, or null if the repository is bare.
	 */
	private String getCommitEditMessageFilePath() {
		File gitDir = getRepository().getDirectory();
		if (gitDir == null) {
			return null;
		}
		return Repository.stripWorkDir(getRepository().getWorkTree(), new File(
				gitDir, Constants.COMMIT_EDITMSG));
	}

	
It is mandatory to call this method with a non-null value before actually
calling the hook.
Params:
commitMessage – 
           The commit message before the hook has run.
Returns:
this for convenience./**
	 * It is mandatory to call this method with a non-null value before actually
	 * calling the hook.
	 *
	 * @param commitMessage
	 *            The commit message before the hook has run.
	 * @return {@code this} for convenience.
	 */
	public CommitMsgHook setCommitMessage(String commitMessage) {
		this.commitMessage = commitMessage;
		return this;
	}

}