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.IOException;
46 import java.io.PrintStream;
47 import java.util.Collection;
48
49 import org.eclipse.jgit.api.errors.AbortedByHookException;
50 import org.eclipse.jgit.lib.ObjectId;
51 import org.eclipse.jgit.lib.Repository;
52 import org.eclipse.jgit.transport.RemoteRefUpdate;
53
54 /**
55 * The <code>pre-push</code> hook implementation. The pre-push hook runs during
56 * git push, after the remote refs have been updated but before any objects have
57 * been transferred.
58 *
59 * @since 4.2
60 */
61 public class PrePushHook extends GitHook<String> {
62
63 /**
64 * Constant indicating the name of the pre-push hook.
65 */
66 public static final String NAME = "pre-push"; //$NON-NLS-1$
67
68 private String remoteName;
69
70 private String remoteLocation;
71
72 private String refs;
73
74 /**
75 * Constructor for PrePushHook
76 *
77 * @param repo
78 * The repository
79 * @param outputStream
80 * The output stream the hook must use. {@code null} is allowed,
81 * in which case the hook will use {@code System.out}.
82 */
83 protected PrePushHook(Repository repo, PrintStream outputStream) {
84 super(repo, outputStream);
85 }
86
87 /** {@inheritDoc} */
88 @Override
89 protected String getStdinArgs() {
90 return refs;
91 }
92
93 /** {@inheritDoc} */
94 @Override
95 public String call() throws IOException, AbortedByHookException {
96 if (canRun()) {
97 doRun();
98 }
99 return ""; //$NON-NLS-1$
100 }
101
102 /**
103 * @return {@code true}
104 */
105 private boolean canRun() {
106 return true;
107 }
108
109 /** {@inheritDoc} */
110 @Override
111 public String getHookName() {
112 return NAME;
113 }
114
115 /**
116 * {@inheritDoc}
117 * <p>
118 * This hook receives two parameters, which is the name and the location of
119 * the remote repository.
120 */
121 @Override
122 protected String[] getParameters() {
123 if (remoteName == null) {
124 remoteName = remoteLocation;
125 }
126 return new String[] { remoteName, remoteLocation };
127 }
128
129 /**
130 * Set remote name
131 *
132 * @param name
133 * remote name
134 */
135 public void setRemoteName(String name) {
136 remoteName = name;
137 }
138
139 /**
140 * Get remote name
141 *
142 * @return remote name or null
143 * @since 4.11
144 */
145 protected String getRemoteName() {
146 return remoteName;
147 }
148
149 /**
150 * Set remote location
151 *
152 * @param location
153 * a remote location
154 */
155 public void setRemoteLocation(String location) {
156 remoteLocation = location;
157 }
158
159 /**
160 * Set Refs
161 *
162 * @param toRefs
163 * a collection of {@code RemoteRefUpdate}s
164 */
165 public void setRefs(Collection<RemoteRefUpdate> toRefs) {
166 StringBuilder b = new StringBuilder();
167 boolean first = true;
168 for (RemoteRefUpdate u : toRefs) {
169 if (!first)
170 b.append("\n"); //$NON-NLS-1$
171 else
172 first = false;
173 b.append(u.getSrcRef());
174 b.append(" "); //$NON-NLS-1$
175 b.append(u.getNewObjectId().getName());
176 b.append(" "); //$NON-NLS-1$
177 b.append(u.getRemoteName());
178 b.append(" "); //$NON-NLS-1$
179 ObjectId ooid = u.getExpectedOldObjectId();
180 b.append((ooid == null) ? ObjectId.zeroId().getName() : ooid
181 .getName());
182 }
183 refs = b.toString();
184 }
185 }