1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
|
/*
* Copyright (C) 2015, 2022 Obeo and others
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Distribution License v. 1.0 which is available at
* https://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
package org.eclipse.jgit.hooks;
import java.io.IOException;
import java.io.PrintStream;
import java.util.Collection;
import org.eclipse.jgit.api.errors.AbortedByHookException;
import org.eclipse.jgit.lib.ObjectId;
import org.eclipse.jgit.lib.Repository;
import org.eclipse.jgit.transport.RemoteRefUpdate;
/**
* The <code>pre-push</code> hook implementation. The pre-push hook runs during
* git push, after the remote refs have been updated but before any objects have
* been transferred.
*
* @since 4.2
*/
public class PrePushHook extends GitHook<String> {
/**
* Constant indicating the name of the pre-push hook.
*/
public static final String NAME = "pre-push"; //$NON-NLS-1$
private String remoteName;
private String remoteLocation;
private String refs;
private boolean dryRun;
/**
* Constructor for PrePushHook
* <p>
* This constructor will use the default error stream.
* </p>
*
* @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 PrePushHook(Repository repo, PrintStream outputStream) {
super(repo, outputStream);
}
/**
* Constructor for PrePushHook
*
* @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}.
* @param errorStream
* The error stream the hook must use. {@code null} is allowed,
* in which case the hook will use {@code System.err}.
* @since 5.6
*/
protected PrePushHook(Repository repo, PrintStream outputStream,
PrintStream errorStream) {
super(repo, outputStream, errorStream);
}
/** {@inheritDoc} */
@Override
protected String getStdinArgs() {
return refs;
}
/** {@inheritDoc} */
@Override
public String call() throws IOException, AbortedByHookException {
if (canRun()) {
doRun();
}
return ""; //$NON-NLS-1$
}
/**
* @return {@code true}
*/
private boolean canRun() {
return true;
}
/** {@inheritDoc} */
@Override
public String getHookName() {
return NAME;
}
/**
* {@inheritDoc}
* <p>
* This hook receives two parameters, which is the name and the location of
* the remote repository.
*/
@Override
protected String[] getParameters() {
if (remoteName == null) {
remoteName = remoteLocation;
}
return new String[] { remoteName, remoteLocation };
}
/**
* Set remote name
*
* @param name
* remote name
*/
public void setRemoteName(String name) {
remoteName = name;
}
/**
* Get remote name
*
* @return remote name or null
* @since 4.11
*/
protected String getRemoteName() {
return remoteName;
}
/**
* Set remote location
*
* @param location
* a remote location
*/
public void setRemoteLocation(String location) {
remoteLocation = location;
}
/**
* Sets whether the push is a dry run.
*
* @param dryRun
* {@code true} if the push is a dry run, {@code false} otherwise
* @since 6.2
*/
public void setDryRun(boolean dryRun) {
this.dryRun = dryRun;
}
/**
* Tells whether the push is a dry run.
*
* @return {@code true} if the push is a dry run, {@code false} otherwise
* @since 6.2
*/
protected boolean isDryRun() {
return dryRun;
}
/**
* Set Refs
*
* @param toRefs
* a collection of {@code RemoteRefUpdate}s
*/
public void setRefs(Collection<RemoteRefUpdate> toRefs) {
StringBuilder b = new StringBuilder();
for (RemoteRefUpdate u : toRefs) {
b.append(u.getSrcRef());
b.append(" "); //$NON-NLS-1$
b.append(u.getNewObjectId().getName());
b.append(" "); //$NON-NLS-1$
b.append(u.getRemoteName());
b.append(" "); //$NON-NLS-1$
ObjectId ooid = u.getExpectedOldObjectId();
b.append((ooid == null) ? ObjectId.zeroId().getName() : ooid
.getName());
b.append("\n"); //$NON-NLS-1$
}
refs = b.toString();
}
}
|
