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.PrintStream;
46 import java.text.MessageFormat;
47
48 import org.eclipse.jgit.internal.JGitText;
49 import org.eclipse.jgit.lib.Repository;
50 import org.eclipse.jgit.util.LfsFactory;
51
52 /**
53 * Factory class for instantiating supported hooks.
54 *
55 * @since 4.0
56 */
57 public class Hooks {
58
59 /**
60 * Create pre-commit hook for the given repository with the default error
61 * stream
62 *
63 * @param repo
64 * a {@link org.eclipse.jgit.lib.Repository} object.
65 * @param outputStream
66 * The output stream, or {@code null} to use {@code System.out}
67 * @return The pre-commit hook for the given repository.
68 */
69 public static PreCommitHook preCommit(Repository repo,
70 PrintStream outputStream) {
71 return new PreCommitHook(repo, outputStream);
72 }
73
74 /**
75 * Create pre-commit hook for the given repository
76 *
77 * @param repo
78 * a {@link org.eclipse.jgit.lib.Repository} object.
79 * @param outputStream
80 * The output stream, or {@code null} to use {@code System.out}
81 * @param errorStream
82 * The error stream, or {@code null} to use {@code System.err}
83 * @return The pre-commit hook for the given repository.
84 * @since 5.6
85 */
86 public static PreCommitHook preCommit(Repository repo,
87 PrintStream outputStream, PrintStream errorStream) {
88 return new PreCommitHook(repo, outputStream, errorStream);
89 }
90
91 /**
92 * Create post-commit hook for the given repository with the default error
93 * stream
94 *
95 * @param repo
96 * a {@link org.eclipse.jgit.lib.Repository} object.
97 * @param outputStream
98 * The output stream, or {@code null} to use {@code System.out}
99 * @return The post-commit hook for the given repository.
100 * @since 4.5
101 */
102 public static PostCommitHook postCommit(Repository repo,
103 PrintStream outputStream) {
104 return new PostCommitHook(repo, outputStream);
105 }
106
107 /**
108 * Create post-commit hook for the given repository
109 *
110 * @param repo
111 * a {@link org.eclipse.jgit.lib.Repository} object.
112 * @param outputStream
113 * The output stream, or {@code null} to use {@code System.out}
114 * @param errorStream
115 * The error stream, or {@code null} to use {@code System.err}
116 * @return The pre-commit hook for the given repository.
117 * @since 5.6
118 */
119 public static PostCommitHook postCommit(Repository repo,
120 PrintStream outputStream, PrintStream errorStream) {
121 return new PostCommitHook(repo, outputStream, errorStream);
122 }
123
124 /**
125 * Create commit-msg hook for the given repository with the default error
126 * stream
127 *
128 * @param repo
129 * a {@link org.eclipse.jgit.lib.Repository} object.
130 * @param outputStream
131 * The output stream, or {@code null} to use {@code System.out}
132 * @return The commit-msg hook for the given repository.
133 */
134 public static CommitMsgHook commitMsg(Repository repo,
135 PrintStream outputStream) {
136 return new CommitMsgHook(repo, outputStream);
137 }
138
139 /**
140 * Create commit-msg hook for the given repository
141 *
142 * @param repo
143 * a {@link org.eclipse.jgit.lib.Repository} object.
144 * @param outputStream
145 * The output stream, or {@code null} to use {@code System.out}
146 * @param errorStream
147 * The error stream, or {@code null} to use {@code System.err}
148 * @return The pre-commit hook for the given repository.
149 * @since 5.6
150 */
151 public static CommitMsgHook commitMsg(Repository repo,
152 PrintStream outputStream, PrintStream errorStream) {
153 return new CommitMsgHook(repo, outputStream, errorStream);
154 }
155
156 /**
157 * Create pre-push hook for the given repository with the default error
158 * stream
159 *
160 * @param repo
161 * a {@link org.eclipse.jgit.lib.Repository} object.
162 * @param outputStream
163 * The output stream, or {@code null} to use {@code System.out}
164 * @return The pre-push hook for the given repository.
165 * @since 4.2
166 */
167 public static PrePushHook prePush(Repository repo, PrintStream outputStream) {
168 if (LfsFactory.getInstance().isAvailable()) {
169 PrePushHook hook = LfsFactory.getInstance().getPrePushHook(repo,
170 outputStream);
171 if (hook != null) {
172 if (hook.isNativeHookPresent()) {
173 PrintStream ps = outputStream;
174 if (ps == null) {
175 ps = System.out;
176 }
177 ps.println(MessageFormat
178 .format(JGitText.get().lfsHookConflict, repo));
179 }
180 return hook;
181 }
182 }
183 return new PrePushHook(repo, outputStream);
184 }
185
186 /**
187 * Create pre-push hook for the given repository
188 *
189 * @param repo
190 * a {@link org.eclipse.jgit.lib.Repository} object.
191 * @param outputStream
192 * The output stream, or {@code null} to use {@code System.out}
193 * @param errorStream
194 * The error stream, or {@code null} to use {@code System.err}
195 * @return The pre-push hook for the given repository.
196 * @since 5.6
197 */
198 public static PrePushHook prePush(Repository repo, PrintStream outputStream,
199 PrintStream errorStream) {
200 if (LfsFactory.getInstance().isAvailable()) {
201 PrePushHook hook = LfsFactory.getInstance().getPrePushHook(repo,
202 outputStream, errorStream);
203 if (hook != null) {
204 if (hook.isNativeHookPresent()) {
205 PrintStream ps = outputStream;
206 if (ps == null) {
207 ps = System.out;
208 }
209 ps.println(MessageFormat
210 .format(JGitText.get().lfsHookConflict, repo));
211 }
212 return hook;
213 }
214 }
215 return new PrePushHook(repo, outputStream, errorStream);
216 }
217 }