View Javadoc
1   /*
2    * Copyright (C) 2008, Robin Rosenberg <robin.rosenberg@dewire.com>
3    * Copyright (C) 2008, Shawn O. Pearce <spearce@spearce.org>
4    * and other copyright owners as documented in the project's IP log.
5    *
6    * This program and the accompanying materials are made available
7    * under the terms of the Eclipse Distribution License v1.0 which
8    * accompanies this distribution, is reproduced below, and is
9    * available at http://www.eclipse.org/org/documents/edl-v10.php
10   *
11   * All rights reserved.
12   *
13   * Redistribution and use in source and binary forms, with or
14   * without modification, are permitted provided that the following
15   * conditions are met:
16   *
17   * - Redistributions of source code must retain the above copyright
18   *   notice, this list of conditions and the following disclaimer.
19   *
20   * - Redistributions in binary form must reproduce the above
21   *   copyright notice, this list of conditions and the following
22   *   disclaimer in the documentation and/or other materials provided
23   *   with the distribution.
24   *
25   * - Neither the name of the Eclipse Foundation, Inc. nor the
26   *   names of its contributors may be used to endorse or promote
27   *   products derived from this software without specific prior
28   *   written permission.
29   *
30   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
31   * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
32   * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
33   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
34   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
35   * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
36   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
37   * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
38   * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
39   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
40   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
41   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
42   * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
43   */
44  
45  package org.eclipse.jgit.transport;
46  
47  import static org.eclipse.jgit.transport.SideBandOutputStream.HDR_SIZE;
48  
49  import java.io.IOException;
50  import java.io.InputStream;
51  import java.io.OutputStream;
52  import java.io.Writer;
53  import java.text.MessageFormat;
54  import java.util.regex.Matcher;
55  import java.util.regex.Pattern;
56  
57  import org.eclipse.jgit.errors.PackProtocolException;
58  import org.eclipse.jgit.errors.TransportException;
59  import org.eclipse.jgit.internal.JGitText;
60  import org.eclipse.jgit.lib.Constants;
61  import org.eclipse.jgit.lib.ProgressMonitor;
62  import org.eclipse.jgit.util.IO;
63  import org.eclipse.jgit.util.RawParseUtils;
64  
65  /**
66   * Unmultiplexes the data portion of a side-band channel.
67   * <p>
68   * Reading from this input stream obtains data from channel 1, which is
69   * typically the bulk data stream.
70   * <p>
71   * Channel 2 is transparently unpacked and "scraped" to update a progress
72   * monitor. The scraping is performed behind the scenes as part of any of the
73   * read methods offered by this stream.
74   * <p>
75   * Channel 3 results in an exception being thrown, as the remote side has issued
76   * an unrecoverable error.
77   *
78   * @see SideBandOutputStream
79   * @since 4.11
80   */
81  public class SideBandInputStream extends InputStream {
82  	static final int CH_DATA = 1;
83  	static final int CH_PROGRESS = 2;
84  	static final int CH_ERROR = 3;
85  
86  	private static Pattern P_UNBOUNDED = Pattern
87  			.compile("^([\\w ]+): +(\\d+)(?:, done\\.)? *[\r\n]$"); //$NON-NLS-1$
88  
89  	private static Pattern P_BOUNDED = Pattern
90  			.compile("^([\\w ]+): +\\d+% +\\( *(\\d+)/ *(\\d+)\\)(?:, done\\.)? *[\r\n]$"); //$NON-NLS-1$
91  
92  	private final InputStream rawIn;
93  
94  	private final PacketLineIn pckIn;
95  
96  	private final ProgressMonitor monitor;
97  
98  	private final Writer messages;
99  
100 	private final OutputStream out;
101 
102 	private String progressBuffer = ""; //$NON-NLS-1$
103 
104 	private String currentTask;
105 
106 	private int lastCnt;
107 
108 	private boolean eof;
109 
110 	private int channel;
111 
112 	private int available;
113 
114 	SideBandInputStream(final InputStream in, final ProgressMonitor progress,
115 			final Writer messageStream, OutputStream outputStream) {
116 		rawIn = in;
117 		pckIn = new PacketLineIn(rawIn);
118 		monitor = progress;
119 		messages = messageStream;
120 		currentTask = ""; //$NON-NLS-1$
121 		out = outputStream;
122 	}
123 
124 	/** {@inheritDoc} */
125 	@Override
126 	public int read() throws IOException {
127 		needDataPacket();
128 		if (eof)
129 			return -1;
130 		available--;
131 		return rawIn.read();
132 	}
133 
134 	/** {@inheritDoc} */
135 	@Override
136 	public int read(byte[] b, int off, int len) throws IOException {
137 		int r = 0;
138 		while (len > 0) {
139 			needDataPacket();
140 			if (eof)
141 				break;
142 			final int n = rawIn.read(b, off, Math.min(len, available));
143 			if (n < 0)
144 				break;
145 			r += n;
146 			off += n;
147 			len -= n;
148 			available -= n;
149 		}
150 		return eof && r == 0 ? -1 : r;
151 	}
152 
153 	private void needDataPacket() throws IOException {
154 		if (eof || (channel == CH_DATA && available > 0))
155 			return;
156 		for (;;) {
157 			available = pckIn.readLength();
158 			if (available == 0) {
159 				eof = true;
160 				return;
161 			}
162 
163 			channel = rawIn.read() & 0xff;
164 			available -= HDR_SIZE; // length header plus channel indicator
165 			if (available == 0)
166 				continue;
167 
168 			switch (channel) {
169 			case CH_DATA:
170 				return;
171 			case CH_PROGRESS:
172 				progress(readString(available));
173 				continue;
174 			case CH_ERROR:
175 				eof = true;
176 				throw new TransportException(remote(readString(available)));
177 			default:
178 				throw new PackProtocolException(
179 						MessageFormat.format(JGitText.get().invalidChannel,
180 								Integer.valueOf(channel)));
181 			}
182 		}
183 	}
184 
185 	private void progress(String pkt) throws IOException {
186 		pkt = progressBuffer + pkt;
187 		for (;;) {
188 			final int lf = pkt.indexOf('\n');
189 			final int cr = pkt.indexOf('\r');
190 			final int s;
191 			if (0 <= lf && 0 <= cr)
192 				s = Math.min(lf, cr);
193 			else if (0 <= lf)
194 				s = lf;
195 			else if (0 <= cr)
196 				s = cr;
197 			else
198 				break;
199 
200 			doProgressLine(pkt.substring(0, s + 1));
201 			pkt = pkt.substring(s + 1);
202 		}
203 		progressBuffer = pkt;
204 	}
205 
206 	private void doProgressLine(String msg) throws IOException {
207 		Matcher matcher;
208 
209 		matcher = P_BOUNDED.matcher(msg);
210 		if (matcher.matches()) {
211 			final String taskname = matcher.group(1);
212 			if (!currentTask.equals(taskname)) {
213 				currentTask = taskname;
214 				lastCnt = 0;
215 				beginTask(Integer.parseInt(matcher.group(3)));
216 			}
217 			final int cnt = Integer.parseInt(matcher.group(2));
218 			monitor.update(cnt - lastCnt);
219 			lastCnt = cnt;
220 			return;
221 		}
222 
223 		matcher = P_UNBOUNDED.matcher(msg);
224 		if (matcher.matches()) {
225 			final String taskname = matcher.group(1);
226 			if (!currentTask.equals(taskname)) {
227 				currentTask = taskname;
228 				lastCnt = 0;
229 				beginTask(ProgressMonitor.UNKNOWN);
230 			}
231 			final int cnt = Integer.parseInt(matcher.group(2));
232 			monitor.update(cnt - lastCnt);
233 			lastCnt = cnt;
234 			return;
235 		}
236 
237 		messages.write(msg);
238 		if (out != null)
239 			out.write(msg.getBytes());
240 	}
241 
242 	private void beginTask(int totalWorkUnits) {
243 		monitor.beginTask(remote(currentTask), totalWorkUnits);
244 	}
245 
246 	private static String remote(String msg) {
247 		String prefix = JGitText.get().prefixRemote;
248 		StringBuilder r = new StringBuilder(prefix.length() + msg.length() + 1);
249 		r.append(prefix);
250 		if (prefix.length() > 0 && prefix.charAt(prefix.length() - 1) != ' ') {
251 			r.append(' ');
252 		}
253 		r.append(msg);
254 		return r.toString();
255 	}
256 
257 	private String readString(int len) throws IOException {
258 		final byte[] raw = new byte[len];
259 		IO.readFully(rawIn, raw, 0, len);
260 		return RawParseUtils.decode(Constants.CHARSET, raw, 0, len);
261 	}
262 }