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 * @param repo
76 * The repository
77 * @param outputStream
78 * The output stream the hook must use. {@code null} is allowed,
79 * in which case the hook will use {@code System.out}.
80 */
81 protected PrePushHook(Repository repo, PrintStream outputStream) {
82 super(repo, outputStream);
83 }
84
85 @Override
86 protected String getStdinArgs() {
87 return refs;
88 }
89
90 @Override
91 public String call() throws IOException, AbortedByHookException {
92 if (canRun()) {
93 doRun();
94 }
95 return ""; //$NON-NLS-1$
96 }
97
98 /**
99 * @return {@code true}
100 */
101 private boolean canRun() {
102 return true;
103 }
104
105 @Override
106 public String getHookName() {
107 return NAME;
108 }
109
110 /**
111 * This hook receives two parameters, which is the name and the location of
112 * the remote repository.
113 */
114 @Override
115 protected String[] getParameters() {
116 if (remoteName == null) {
117 remoteName = remoteLocation;
118 }
119 return new String[] { remoteName, remoteLocation };
120 }
121
122 /**
123 * @param name
124 */
125 public void setRemoteName(String name) {
126 remoteName = name;
127 }
128
129 /**
130 * @param location
131 */
132 public void setRemoteLocation(String location) {
133 remoteLocation = location;
134 }
135
136 /**
137 * @param toRefs
138 */
139 public void setRefs(Collection<RemoteRefUpdate> toRefs) {
140 StringBuilder b = new StringBuilder();
141 boolean first = true;
142 for (RemoteRefUpdate u : toRefs) {
143 if (!first)
144 b.append("\n"); //$NON-NLS-1$
145 else
146 first = false;
147 b.append(u.getSrcRef());
148 b.append(" "); //$NON-NLS-1$
149 b.append(u.getNewObjectId().getName());
150 b.append(" "); //$NON-NLS-1$
151 b.append(u.getRemoteName());
152 b.append(" "); //$NON-NLS-1$
153 ObjectId ooid = u.getExpectedOldObjectId();
154 b.append((ooid == null) ? ObjectId.zeroId().getName() : ooid
155 .getName());
156 }
157 refs = b.toString();
158 }
159 }