View Javadoc
1   /*
2    * Copyright (C) 2015, Kaloyan Raev <kaloyan.r@zend.com>
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.pgm;
44  
45  import java.io.IOException;
46  import java.io.StringWriter;
47  import java.text.MessageFormat;
48  import java.util.ArrayList;
49  import java.util.List;
50  
51  import org.eclipse.jgit.api.Git;
52  import org.eclipse.jgit.api.RemoteAddCommand;
53  import org.eclipse.jgit.api.RemoteListCommand;
54  import org.eclipse.jgit.api.RemoteRemoveCommand;
55  import org.eclipse.jgit.api.RemoteSetUrlCommand;
56  import org.eclipse.jgit.api.RemoteSetUrlCommand.UriType;
57  import org.eclipse.jgit.api.errors.JGitInternalException;
58  import org.eclipse.jgit.pgm.internal.CLIText;
59  import org.eclipse.jgit.pgm.opt.CmdLineParser;
60  import org.eclipse.jgit.transport.RemoteConfig;
61  import org.eclipse.jgit.transport.URIish;
62  import org.eclipse.jgit.util.io.ThrowingPrintWriter;
63  import org.kohsuke.args4j.Argument;
64  import org.kohsuke.args4j.Option;
65  
66  @Command(common = false, usage = "usage_Remote")
67  class Remote extends TextBuiltin {
68  
69  	@Option(name = "--verbose", aliases = { "-v" }, usage = "usage_beVerbose")
70  	private boolean verbose = false;
71  
72  	@Option(name = "--prune", aliases = {
73  			"-p" }, usage = "usage_pruneStaleTrackingRefs")
74  	private boolean prune;
75  
76  	@Option(name = "--push", usage = "usage_pushUrls")
77  	private boolean push;
78  
79  	@Argument(index = 0, metaVar = "metaVar_command")
80  	private String command;
81  
82  	@Argument(index = 1, metaVar = "metaVar_remoteName")
83  	private String name;
84  
85  	@Argument(index = 2, metaVar = "metaVar_uriish")
86  	private String uri;
87  
88  	/** {@inheritDoc} */
89  	@Override
90  	protected void run() {
91  		try (Gitit.html#Git">Git git = new Git(db)) {
92  			if (command == null) {
93  				RemoteListCommand cmd = git.remoteList();
94  				List<RemoteConfig> remotes = cmd.call();
95  				print(remotes);
96  			} else if ("add".equals(command)) { //$NON-NLS-1$
97  				RemoteAddCommand cmd = git.remoteAdd();
98  				cmd.setName(name);
99  				cmd.setUri(new URIish(uri));
100 				cmd.call();
101 			} else if ("remove".equals(command) || "rm".equals(command)) { //$NON-NLS-1$ //$NON-NLS-2$
102 				RemoteRemoveCommand cmd = git.remoteRemove();
103 				cmd.setRemoteName(name);
104 				cmd.call();
105 			} else if ("set-url".equals(command)) { //$NON-NLS-1$
106 				RemoteSetUrlCommand cmd = git.remoteSetUrl();
107 				cmd.setRemoteName(name);
108 				cmd.setRemoteUri(new URIish(uri));
109 				cmd.setUriType(push ? UriType.PUSH : UriType.FETCH);
110 				cmd.call();
111 			} else if ("update".equals(command)) { //$NON-NLS-1$
112 				// reuse fetch command for basic implementation of remote update
113 				Fetch fetch = new Fetch();
114 				fetch.init(db, gitdir);
115 
116 				// redirect the output stream
117 				StringWriter osw = new StringWriter();
118 				fetch.outw = new ThrowingPrintWriter(osw);
119 				// redirect the error stream
120 				StringWriter esw = new StringWriter();
121 				fetch.errw = new ThrowingPrintWriter(esw);
122 
123 				List<String> fetchArgs = new ArrayList<>();
124 				if (verbose) {
125 					fetchArgs.add("--verbose"); //$NON-NLS-1$
126 				}
127 				if (prune) {
128 					fetchArgs.add("--prune"); //$NON-NLS-1$
129 				}
130 				if (name != null) {
131 					fetchArgs.add(name);
132 				}
133 
134 				fetch.execute(fetchArgs.toArray(new String[0]));
135 
136 				// flush the streams
137 				fetch.outw.flush();
138 				fetch.errw.flush();
139 				outw.println(osw.toString());
140 				errw.println(esw.toString());
141 			} else {
142 				throw new JGitInternalException(MessageFormat
143 						.format(CLIText.get().unknownSubcommand, command));
144 			}
145 		} catch (Exception e) {
146 			throw die(e.getMessage(), e);
147 		}
148 	}
149 
150 	/** {@inheritDoc} */
151 	@Override
152 	public void printUsage(String message, CmdLineParser clp)
153 			throws IOException {
154 		errw.println(message);
155 		errw.println("jgit remote [--verbose (-v)] [--help (-h)]"); //$NON-NLS-1$
156 		errw.println("jgit remote add name uri-ish [--help (-h)]"); //$NON-NLS-1$
157 		errw.println("jgit remote remove name [--help (-h)]"); //$NON-NLS-1$
158 		errw.println("jgit remote rm name [--help (-h)]"); //$NON-NLS-1$
159 		errw.println(
160 				"jgit remote [--verbose (-v)] update [name] [--prune (-p)] [--help (-h)]"); //$NON-NLS-1$
161 		errw.println("jgit remote set-url name uri-ish [--push] [--help (-h)]"); //$NON-NLS-1$
162 
163 		errw.println();
164 		clp.printUsage(errw, getResourceBundle());
165 		errw.println();
166 
167 		errw.flush();
168 	}
169 
170 	private void print(List<RemoteConfig> remotes) throws IOException {
171 		for (RemoteConfig remote : remotes) {
172 			String remoteName = remote.getName();
173 			if (verbose) {
174 				List<URIish> fetchURIs = remote.getURIs();
175 				List<URIish> pushURIs = remote.getPushURIs();
176 
177 				String fetchURI = ""; //$NON-NLS-1$
178 				if (!fetchURIs.isEmpty()) {
179 					fetchURI = fetchURIs.get(0).toString();
180 				} else if (!pushURIs.isEmpty()) {
181 					fetchURI = pushURIs.get(0).toString();
182 				}
183 
184 				String pushURI = ""; //$NON-NLS-1$
185 				if (!pushURIs.isEmpty()) {
186 					pushURI = pushURIs.get(0).toString();
187 				} else if (!fetchURIs.isEmpty()) {
188 					pushURI = fetchURIs.get(0).toString();
189 				}
190 
191 				outw.println(
192 						String.format("%s\t%s (fetch)", remoteName, fetchURI)); //$NON-NLS-1$
193 				outw.println(
194 						String.format("%s\t%s (push)", remoteName, pushURI)); //$NON-NLS-1$
195 			} else {
196 				outw.println(remoteName);
197 			}
198 		}
199 	}
200 
201 }