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  	 * <p>Constructor for AutoCRLFOutputStream.</p>
79  	 *
80  	 * @param out a {@link java.io.OutputStream} object.
81  	 */
82  	public AutoCRLFOutputStream(OutputStream out) {
83  		this(out, true);
84  	}
85  
86  	/**
87  	 * <p>Constructor for AutoCRLFOutputStream.</p>
88  	 *
89  	 * @param out a {@link java.io.OutputStream} object.
90  	 * @param detectBinary
91  	 *            whether binaries should be detected
92  	 * @since 4.3
93  	 */
94  	public AutoCRLFOutputStream(OutputStream out, boolean detectBinary) {
95  		this.out = out;
96  		this.detectBinary = detectBinary;
97  	}
98  
99  	/** {@inheritDoc} */
100 	@Override
101 	public void write(int b) throws IOException {
102 		onebytebuf[0] = (byte) b;
103 		write(onebytebuf, 0, 1);
104 	}
105 
106 	/** {@inheritDoc} */
107 	@Override
108 	public void write(byte[] b) throws IOException {
109 		int overflow = buffer(b, 0, b.length);
110 		if (overflow > 0)
111 			write(b, b.length - overflow, overflow);
112 	}
113 
114 	/** {@inheritDoc} */
115 	@Override
116 	public void write(byte[] b, int startOff, int startLen)
117 			throws IOException {
118 		final int overflow = buffer(b, startOff, startLen);
119 		if (overflow < 0)
120 			return;
121 		final int off = startOff + startLen - overflow;
122 		final int len = overflow;
123 		if (len == 0)
124 			return;
125 		int lastw = off;
126 		if (isBinary) {
127 			out.write(b, off, len);
128 			return;
129 		}
130 		for (int i = off; i < off + len; ++i) {
131 			final byte c = b[i];
132 			if (c == '\r') {
133 				buf = '\r';
134 			} else if (c == '\n') {
135 				if (buf != '\r') {
136 					if (lastw < i) {
137 						out.write(b, lastw, i - lastw);
138 					}
139 					out.write('\r');
140 					lastw = i;
141 				}
142 				buf = -1;
143 			} else {
144 				buf = -1;
145 			}
146 		}
147 		if (lastw < off + len) {
148 			out.write(b, lastw, off + len - lastw);
149 		}
150 		if (b[off + len - 1] == '\r')
151 			buf = '\r';
152 	}
153 
154 	private int buffer(byte[] b, int off, int len) throws IOException {
155 		if (binbufcnt > binbuf.length)
156 			return len;
157 		int copy = Math.min(binbuf.length - binbufcnt, len);
158 		System.arraycopy(b, off, binbuf, binbufcnt, copy);
159 		binbufcnt += copy;
160 		int remaining = len - copy;
161 		if (remaining > 0)
162 			decideMode();
163 		return remaining;
164 	}
165 
166 	private void decideMode() throws IOException {
167 		if (detectBinary) {
168 			isBinary = RawText.isBinary(binbuf, binbufcnt);
169 			detectBinary = false;
170 		}
171 		int cachedLen = binbufcnt;
172 		binbufcnt = binbuf.length + 1; // full!
173 		write(binbuf, 0, cachedLen);
174 	}
175 
176 	/** {@inheritDoc} */
177 	@Override
178 	public void flush() throws IOException {
179 		if (binbufcnt <= binbuf.length)
180 			decideMode();
181 		buf = -1;
182 		out.flush();
183 	}
184 
185 	/** {@inheritDoc} */
186 	@Override
187 	public void close() throws IOException {
188 		flush();
189 		out.close();
190 	}
191 }