1 /*
2 * Copyright (C) 2015 Obeo.
3 * and other copyright owners as documented in the project's IP log.
4 *
5 * This program and the accompanying materials are made available
6 * under the terms of the Eclipse Distribution License v1.0 which
7 * accompanies this distribution, is reproduced below, and is
8 * available at http://www.eclipse.org/org/documents/edl-v10.php
9 *
10 * All rights reserved.
11 *
12 * Redistribution and use in source and binary forms, with or
13 * without modification, are permitted provided that the following
14 * conditions are met:
15 *
16 * - Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 *
19 * - Redistributions in binary form must reproduce the above
20 * copyright notice, this list of conditions and the following
21 * disclaimer in the documentation and/or other materials provided
22 * with the distribution.
23 *
24 * - Neither the name of the Eclipse Foundation, Inc. nor the
25 * names of its contributors may be used to endorse or promote
26 * products derived from this software without specific prior
27 * written permission.
28 *
29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
30 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
31 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
32 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
34 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
35 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
36 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
37 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
38 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42 */
43 package org.eclipse.jgit.hooks;
44
45 import java.io.File;
46 import java.io.IOException;
47 import java.io.PrintStream;
48
49 import org.eclipse.jgit.api.errors.AbortedByHookException;
50 import org.eclipse.jgit.lib.Constants;
51 import org.eclipse.jgit.lib.Repository;
52
53 /**
54 * The <code>commit-msg</code> hook implementation. This hook is run before the
55 * commit and can reject the commit. It passes one argument to the hook script,
56 * which is the path to the COMMIT_MSG file, relative to the repository
57 * workTree.
58 *
59 * @since 4.0
60 */
61 public class CommitMsgHook extends GitHook<String> {
62
63 /**
64 * Constant indicating the name of the commit-smg hook.
65 */
66 public static final String NAME = "commit-msg"; //$NON-NLS-1$
67
68 /**
69 * The commit message.
70 */
71 private String commitMessage;
72
73 /**
74 * Constructor for CommitMsgHook
75 *
76 * @param repo
77 * The repository
78 * @param outputStream
79 * The output stream the hook must use. {@code null} is allowed,
80 * in which case the hook will use {@code System.out}.
81 */
82 protected CommitMsgHook(Repository repo, PrintStream outputStream) {
83 super(repo, outputStream);
84 }
85
86 /** {@inheritDoc} */
87 @Override
88 public String call() throws IOException, AbortedByHookException {
89 if (commitMessage == null) {
90 throw new IllegalStateException();
91 }
92 if (canRun()) {
93 getRepository().writeCommitEditMsg(commitMessage);
94 doRun();
95 commitMessage = getRepository().readCommitEditMsg();
96 }
97 return commitMessage;
98 }
99
100 /**
101 * @return {@code true} if and only if the path to the message commit file
102 * is not null (which would happen in a bare repository) and the
103 * commit message is also not null.
104 */
105 private boolean canRun() {
106 return getCommitEditMessageFilePath() != null && commitMessage != null;
107 }
108
109 /** {@inheritDoc} */
110 @Override
111 public String getHookName() {
112 return NAME;
113 }
114
115 /**
116 * {@inheritDoc}
117 *
118 * This hook receives one parameter, which is the path to the file holding
119 * the current commit-msg, relative to the repository's work tree.
120 */
121 @Override
122 protected String[] getParameters() {
123 return new String[] { getCommitEditMessageFilePath() };
124 }
125
126 /**
127 * @return The path to the commit edit message file relative to the
128 * repository's work tree, or null if the repository is bare.
129 */
130 private String getCommitEditMessageFilePath() {
131 File gitDir = getRepository().getDirectory();
132 if (gitDir == null) {
133 return null;
134 }
135 return Repository.stripWorkDir(getRepository().getWorkTree(), new File(
136 gitDir, Constants.COMMIT_EDITMSG));
137 }
138
139 /**
140 * It is mandatory to call this method with a non-null value before actually
141 * calling the hook.
142 *
143 * @param commitMessage
144 * The commit message before the hook has run.
145 * @return {@code this} for convenience.
146 */
147 public CommitMsgHook setCommitMessage(String commitMessage) {
148 this.commitMessage = commitMessage;
149 return this;
150 }
151
152 }