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   */
80  class SideBandInputStream extends InputStream {
81  	private static final String PFX_REMOTE = JGitText.get().prefixRemote;
82  
83  	static final int CH_DATA = 1;
84  
85  	static final int CH_PROGRESS = 2;
86  
87  	static final int CH_ERROR = 3;
88  
89  	private static Pattern P_UNBOUNDED = Pattern
90  			.compile("^([\\w ]+): +(\\d+)(?:, done\\.)? *[\r\n]$"); //$NON-NLS-1$
91  
92  	private static Pattern P_BOUNDED = Pattern
93  			.compile("^([\\w ]+): +\\d+% +\\( *(\\d+)/ *(\\d+)\\)(?:, done\\.)? *[\r\n]$"); //$NON-NLS-1$
94  
95  	private final InputStream rawIn;
96  
97  	private final PacketLineIn pckIn;
98  
99  	private final ProgressMonitor monitor;
100 
101 	private final Writer messages;
102 
103 	private final OutputStream out;
104 
105 	private String progressBuffer = ""; //$NON-NLS-1$
106 
107 	private String currentTask;
108 
109 	private int lastCnt;
110 
111 	private boolean eof;
112 
113 	private int channel;
114 
115 	private int available;
116 
117 	SideBandInputStream(final InputStream in, final ProgressMonitor progress,
118 			final Writer messageStream, OutputStream outputStream) {
119 		rawIn = in;
120 		pckIn = new PacketLineIn(rawIn);
121 		monitor = progress;
122 		messages = messageStream;
123 		currentTask = ""; //$NON-NLS-1$
124 		out = outputStream;
125 	}
126 
127 	@Override
128 	public int read() throws IOException {
129 		needDataPacket();
130 		if (eof)
131 			return -1;
132 		available--;
133 		return rawIn.read();
134 	}
135 
136 	@Override
137 	public int read(final byte[] b, int off, int len) throws IOException {
138 		int r = 0;
139 		while (len > 0) {
140 			needDataPacket();
141 			if (eof)
142 				break;
143 			final int n = rawIn.read(b, off, Math.min(len, available));
144 			if (n < 0)
145 				break;
146 			r += n;
147 			off += n;
148 			len -= n;
149 			available -= n;
150 		}
151 		return eof && r == 0 ? -1 : r;
152 	}
153 
154 	private void needDataPacket() throws IOException {
155 		if (eof || (channel == CH_DATA && available > 0))
156 			return;
157 		for (;;) {
158 			available = pckIn.readLength();
159 			if (available == 0) {
160 				eof = true;
161 				return;
162 			}
163 
164 			channel = rawIn.read() & 0xff;
165 			available -= HDR_SIZE; // length header plus channel indicator
166 			if (available == 0)
167 				continue;
168 
169 			switch (channel) {
170 			case CH_DATA:
171 				return;
172 			case CH_PROGRESS:
173 				progress(readString(available));
174 				continue;
175 			case CH_ERROR:
176 				eof = true;
177 				throw new TransportException(PFX_REMOTE + readString(available));
178 			default:
179 				throw new PackProtocolException(
180 						MessageFormat.format(JGitText.get().invalidChannel,
181 								Integer.valueOf(channel)));
182 			}
183 		}
184 	}
185 
186 	private void progress(String pkt) throws IOException {
187 		pkt = progressBuffer + pkt;
188 		for (;;) {
189 			final int lf = pkt.indexOf('\n');
190 			final int cr = pkt.indexOf('\r');
191 			final int s;
192 			if (0 <= lf && 0 <= cr)
193 				s = Math.min(lf, cr);
194 			else if (0 <= lf)
195 				s = lf;
196 			else if (0 <= cr)
197 				s = cr;
198 			else
199 				break;
200 
201 			doProgressLine(pkt.substring(0, s + 1));
202 			pkt = pkt.substring(s + 1);
203 		}
204 		progressBuffer = pkt;
205 	}
206 
207 	private void doProgressLine(final String msg) throws IOException {
208 		Matcher matcher;
209 
210 		matcher = P_BOUNDED.matcher(msg);
211 		if (matcher.matches()) {
212 			final String taskname = matcher.group(1);
213 			if (!currentTask.equals(taskname)) {
214 				currentTask = taskname;
215 				lastCnt = 0;
216 				beginTask(Integer.parseInt(matcher.group(3)));
217 			}
218 			final int cnt = Integer.parseInt(matcher.group(2));
219 			monitor.update(cnt - lastCnt);
220 			lastCnt = cnt;
221 			return;
222 		}
223 
224 		matcher = P_UNBOUNDED.matcher(msg);
225 		if (matcher.matches()) {
226 			final String taskname = matcher.group(1);
227 			if (!currentTask.equals(taskname)) {
228 				currentTask = taskname;
229 				lastCnt = 0;
230 				beginTask(ProgressMonitor.UNKNOWN);
231 			}
232 			final int cnt = Integer.parseInt(matcher.group(2));
233 			monitor.update(cnt - lastCnt);
234 			lastCnt = cnt;
235 			return;
236 		}
237 
238 		messages.write(msg);
239 		if (out != null)
240 			out.write(msg.getBytes());
241 	}
242 
243 	private void beginTask(final int totalWorkUnits) {
244 		monitor.beginTask(PFX_REMOTE + currentTask, totalWorkUnits);
245 	}
246 
247 	private String readString(final int len) throws IOException {
248 		final byte[] raw = new byte[len];
249 		IO.readFully(rawIn, raw, 0, len);
250 		return RawParseUtils.decode(Constants.CHARSET, raw, 0, len);
251 	}
252 }