View Javadoc
1   /*
2    * Copyright (C) 2011, 2013 Robin Rosenberg
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  
44  package org.eclipse.jgit.util.io;
45  
46  import java.io.IOException;
47  import java.io.OutputStream;
48  
49  import org.eclipse.jgit.diff.RawText;
50  
51  /**
52   * An OutputStream that expands LF to CRLF.
53   *
54   * Existing CRLF are not expanded to CRCRLF, but retained as is.
55   *
56   * A binary check on the first 8000 bytes is performed and in case of binary
57   * files, canonicalization is turned off (for the complete file).
58   */
59  public class AutoCRLFOutputStream extends OutputStream {
60  
61  	static final int BUFFER_SIZE = 8000;
62  
63  	private final OutputStream out;
64  
65  	private int buf = -1;
66  
67  	private byte[] binbuf = new byte[BUFFER_SIZE];
68  
69  	private byte[] onebytebuf = new byte[1];
70  
71  	private int binbufcnt = 0;
72  
73  	private boolean detectBinary;
74  
75  	private boolean isBinary;
76  
77  	/**
78  	 * @param out
79  	 */
80  	public AutoCRLFOutputStream(OutputStream out) {
81  		this(out, true);
82  	}
83  
84  	/**
85  	 * @param out
86  	 * @param detectBinary
87  	 *            whether binaries should be detected
88  	 * @since 4.3
89  	 */
90  	public AutoCRLFOutputStream(OutputStream out, boolean detectBinary) {
91  		this.out = out;
92  		this.detectBinary = detectBinary;
93  	}
94  
95  	@Override
96  	public void write(int b) throws IOException {
97  		onebytebuf[0] = (byte) b;
98  		write(onebytebuf, 0, 1);
99  	}
100 
101 	@Override
102 	public void write(byte[] b) throws IOException {
103 		int overflow = buffer(b, 0, b.length);
104 		if (overflow > 0)
105 			write(b, b.length - overflow, overflow);
106 	}
107 
108 	@Override
109 	public void write(byte[] b, final int startOff, final int startLen)
110 			throws IOException {
111 		final int overflow = buffer(b, startOff, startLen);
112 		if (overflow < 0)
113 			return;
114 		final int off = startOff + startLen - overflow;
115 		final int len = overflow;
116 		if (len == 0)
117 			return;
118 		int lastw = off;
119 		if (isBinary) {
120 			out.write(b, off, len);
121 			return;
122 		}
123 		for (int i = off; i < off + len; ++i) {
124 			final byte c = b[i];
125 			if (c == '\r') {
126 				buf = '\r';
127 			} else if (c == '\n') {
128 				if (buf != '\r') {
129 					if (lastw < i) {
130 						out.write(b, lastw, i - lastw);
131 					}
132 					out.write('\r');
133 					lastw = i;
134 				}
135 				buf = -1;
136 			} else {
137 				buf = -1;
138 			}
139 		}
140 		if (lastw < off + len) {
141 			out.write(b, lastw, off + len - lastw);
142 		}
143 		if (b[off + len - 1] == '\r')
144 			buf = '\r';
145 	}
146 
147 	private int buffer(byte[] b, int off, int len) throws IOException {
148 		if (binbufcnt > binbuf.length)
149 			return len;
150 		int copy = Math.min(binbuf.length - binbufcnt, len);
151 		System.arraycopy(b, off, binbuf, binbufcnt, copy);
152 		binbufcnt += copy;
153 		int remaining = len - copy;
154 		if (remaining > 0)
155 			decideMode();
156 		return remaining;
157 	}
158 
159 	private void decideMode() throws IOException {
160 		if (detectBinary) {
161 			isBinary = RawText.isBinary(binbuf, binbufcnt);
162 			detectBinary = false;
163 		}
164 		int cachedLen = binbufcnt;
165 		binbufcnt = binbuf.length + 1; // full!
166 		write(binbuf, 0, cachedLen);
167 	}
168 
169 	@Override
170 	public void flush() throws IOException {
171 		if (binbufcnt <= binbuf.length)
172 			decideMode();
173 		buf = -1;
174 		out.flush();
175 	}
176 
177 	@Override
178 	public void close() throws IOException {
179 		flush();
180 		out.close();
181 	}
182 }