/
InputBuffer.java
594 lines (461 loc) · 14.9 KB
/
InputBuffer.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.catalina.connector;
import java.io.IOException;
import java.io.Reader;
import java.security.AccessController;
import java.security.PrivilegedActionException;
import java.security.PrivilegedExceptionAction;
import java.util.concurrent.ConcurrentHashMap;
import javax.servlet.ReadListener;
import org.apache.catalina.security.SecurityUtil;
import org.apache.coyote.ActionCode;
import org.apache.coyote.ContainerThreadMarker;
import org.apache.coyote.Request;
import org.apache.tomcat.util.buf.B2CConverter;
import org.apache.tomcat.util.buf.ByteChunk;
import org.apache.tomcat.util.buf.CharChunk;
import org.apache.tomcat.util.res.StringManager;
/**
* The buffer used by Tomcat request. This is a derivative of the Tomcat 3.3
* OutputBuffer, adapted to handle input instead of output. This allows
* complete recycling of the facade objects (the ServletInputStream and the
* BufferedReader).
*
* @author Remy Maucherat
*/
public class InputBuffer extends Reader
implements ByteChunk.ByteInputChannel, CharChunk.CharInputChannel,
CharChunk.CharOutputChannel {
/**
* The string manager for this package.
*/
protected static final StringManager sm = StringManager.getManager(InputBuffer.class);
// -------------------------------------------------------------- Constants
public static final int DEFAULT_BUFFER_SIZE = 8*1024;
// The buffer can be used for byte[] and char[] reading
// ( this is needed to support ServletInputStream and BufferedReader )
public final int INITIAL_STATE = 0;
public final int CHAR_STATE = 1;
public final int BYTE_STATE = 2;
// ----------------------------------------------------- Instance Variables
/**
* The byte buffer.
*/
private final ByteChunk bb;
/**
* The chunk buffer.
*/
private CharChunk cb;
/**
* State of the output buffer.
*/
private int state = 0;
/**
* Flag which indicates if the input buffer is closed.
*/
private boolean closed = false;
/**
* Encoding to use.
*/
private String enc;
/**
* Encoder is set.
*/
private boolean gotEnc = false;
/**
* List of encoders.
*/
protected final ConcurrentHashMap<String,B2CConverter> encoders = new ConcurrentHashMap<>();
/**
* Current byte to char converter.
*/
protected B2CConverter conv;
/**
* Associated Coyote request.
*/
private Request coyoteRequest;
/**
* Buffer position.
*/
private int markPos = -1;
/**
* Buffer size.
*/
private final int size;
// ----------------------------------------------------------- Constructors
/**
* Default constructor. Allocate the buffer with the default buffer size.
*/
public InputBuffer() {
this(DEFAULT_BUFFER_SIZE);
}
/**
* Alternate constructor which allows specifying the initial buffer size.
*
* @param size Buffer size to use
*/
public InputBuffer(int size) {
this.size = size;
bb = new ByteChunk(size);
bb.setLimit(size);
bb.setByteInputChannel(this);
cb = new CharChunk(size);
cb.setLimit(size);
cb.setOptimizedWrite(false);
cb.setCharInputChannel(this);
cb.setCharOutputChannel(this);
}
// ------------------------------------------------------------- Properties
/**
* Associated Coyote request.
*
* @param coyoteRequest Associated Coyote request
*/
public void setRequest(Request coyoteRequest) {
this.coyoteRequest = coyoteRequest;
}
// --------------------------------------------------------- Public Methods
/**
* Recycle the output buffer.
*/
public void recycle() {
state = INITIAL_STATE;
// If usage of mark made the buffer too big, reallocate it
if (cb.getChars().length > size) {
cb = new CharChunk(size);
cb.setLimit(size);
cb.setOptimizedWrite(false);
cb.setCharInputChannel(this);
cb.setCharOutputChannel(this);
} else {
cb.recycle();
}
markPos = -1;
bb.recycle();
closed = false;
if (conv != null) {
conv.recycle();
}
gotEnc = false;
enc = null;
}
/**
* Clear cached encoders (to save memory for async requests).
*/
public void clearEncoders() {
encoders.clear();
}
/**
* Close the input buffer.
*
* @throws IOException An underlying IOException occurred
*/
@Override
public void close()
throws IOException {
closed = true;
}
public int available() {
int available = 0;
if (state == BYTE_STATE) {
available = bb.getLength();
} else if (state == CHAR_STATE) {
available = cb.getLength();
}
if (available == 0) {
coyoteRequest.action(ActionCode.AVAILABLE, null);
available = (coyoteRequest.getAvailable() > 0) ? 1 : 0;
}
return available;
}
public void setReadListener(ReadListener listener) {
coyoteRequest.setReadListener(listener);
// The container is responsible for the first call to
// listener.onDataAvailable(). If isReady() returns true, the container
// needs to call listener.onDataAvailable() from a new thread. If
// isReady() returns false, the socket will be registered for read and
// the container will call listener.onDataAvailable() once data arrives.
// Must call isFinished() first as a call to isReady() if the request
// has been finished will register the socket for read interest and that
// is not required.
if (!coyoteRequest.isFinished() && isReady()) {
coyoteRequest.action(ActionCode.DISPATCH_READ, null);
if (!ContainerThreadMarker.isContainerThread()) {
// Not on a container thread so need to execute the dispatch
coyoteRequest.action(ActionCode.DISPATCH_EXECUTE, null);
}
}
}
public boolean isFinished() {
int available = 0;
if (state == BYTE_STATE) {
available = bb.getLength();
} else if (state == CHAR_STATE) {
available = cb.getLength();
}
if (available > 0) {
return false;
} else {
return coyoteRequest.isFinished();
}
}
public boolean isReady() {
if (coyoteRequest.getReadListener() == null) {
throw new IllegalStateException("not in non blocking mode.");
}
if (isFinished()) {
// If this is a non-container thread, need to trigger a read
// which will eventually lead to a call to onAllDataRead() via a
// container thread.
if (!ContainerThreadMarker.isContainerThread()) {
coyoteRequest.action(ActionCode.DISPATCH_READ, null);
coyoteRequest.action(ActionCode.DISPATCH_EXECUTE, null);
}
return false;
}
boolean result = available() > 0;
if (!result) {
coyoteRequest.action(ActionCode.NB_READ_INTEREST, null);
}
return result;
}
boolean isBlocking() {
return coyoteRequest.getReadListener() == null;
}
// ------------------------------------------------- Bytes Handling Methods
/**
* Reads new bytes in the byte chunk.
*
* @throws IOException An underlying IOException occurred
*/
@Override
public int realReadBytes() throws IOException {
if (closed) {
return -1;
}
if (coyoteRequest == null) {
return -1;
}
if(state == INITIAL_STATE) {
state = BYTE_STATE;
}
int result = coyoteRequest.doRead(bb);
return result;
}
public int readByte() throws IOException {
if (closed) {
throw new IOException(sm.getString("inputBuffer.streamClosed"));
}
return bb.substract();
}
public int read(byte[] b, int off, int len) throws IOException {
if (closed) {
throw new IOException(sm.getString("inputBuffer.streamClosed"));
}
return bb.substract(b, off, len);
}
// ------------------------------------------------- Chars Handling Methods
/**
* Since the converter will use append, it is possible to get chars to
* be removed from the buffer for "writing". Since the chars have already
* been read before, they are ignored. If a mark was set, then the
* mark is lost.
*/
@Override
public void realWriteChars(char c[], int off, int len) throws IOException {
markPos = -1;
cb.setOffset(0);
cb.setEnd(0);
}
public void setEncoding(String s) {
enc = s;
}
@Override
public int realReadChars() throws IOException {
if (!gotEnc) {
setConverter();
}
boolean eof = false;
if (bb.getLength() <= 0) {
int nRead = realReadBytes();
if (nRead < 0) {
eof = true;
}
}
if (markPos == -1) {
cb.setOffset(0);
cb.setEnd(0);
} else {
// Make sure there's enough space in the worst case
cb.makeSpace(bb.getLength());
if ((cb.getBuffer().length - cb.getEnd()) == 0) {
// We went over the limit
cb.setOffset(0);
cb.setEnd(0);
markPos = -1;
}
}
state = CHAR_STATE;
conv.convert(bb, cb, eof);
if (cb.getLength() == 0 && eof) {
return -1;
} else {
return cb.getLength();
}
}
@Override
public int read()
throws IOException {
if (closed) {
throw new IOException(sm.getString("inputBuffer.streamClosed"));
}
return cb.substract();
}
@Override
public int read(char[] cbuf)
throws IOException {
if (closed) {
throw new IOException(sm.getString("inputBuffer.streamClosed"));
}
return read(cbuf, 0, cbuf.length);
}
@Override
public int read(char[] cbuf, int off, int len)
throws IOException {
if (closed) {
throw new IOException(sm.getString("inputBuffer.streamClosed"));
}
return cb.substract(cbuf, off, len);
}
@Override
public long skip(long n) throws IOException {
if (closed) {
throw new IOException(sm.getString("inputBuffer.streamClosed"));
}
if (n < 0) {
throw new IllegalArgumentException();
}
long nRead = 0;
while (nRead < n) {
if (cb.getLength() >= n) {
cb.setOffset(cb.getStart() + (int) n);
nRead = n;
} else {
nRead += cb.getLength();
cb.setOffset(cb.getEnd());
int nb = realReadChars();
if (nb < 0) {
break;
}
}
}
return nRead;
}
@Override
public boolean ready() throws IOException {
if (closed) {
throw new IOException(sm.getString("inputBuffer.streamClosed"));
}
if (state == INITIAL_STATE) {
state = CHAR_STATE;
}
return (available() > 0);
}
@Override
public boolean markSupported() {
return true;
}
@Override
public void mark(int readAheadLimit)
throws IOException {
if (closed) {
throw new IOException(sm.getString("inputBuffer.streamClosed"));
}
if (cb.getLength() <= 0) {
cb.setOffset(0);
cb.setEnd(0);
} else {
if ((cb.getBuffer().length > (2 * size))
&& (cb.getLength()) < (cb.getStart())) {
System.arraycopy(cb.getBuffer(), cb.getStart(),
cb.getBuffer(), 0, cb.getLength());
cb.setEnd(cb.getLength());
cb.setOffset(0);
}
}
cb.setLimit(cb.getStart() + readAheadLimit + size);
markPos = cb.getStart();
}
@Override
public void reset()
throws IOException {
if (closed) {
throw new IOException(sm.getString("inputBuffer.streamClosed"));
}
if (state == CHAR_STATE) {
if (markPos < 0) {
cb.recycle();
markPos = -1;
throw new IOException();
} else {
cb.setOffset(markPos);
}
} else {
bb.recycle();
}
}
public void checkConverter()
throws IOException {
if (!gotEnc) {
setConverter();
}
}
protected void setConverter()
throws IOException {
if (coyoteRequest != null) {
enc = coyoteRequest.getCharacterEncoding();
}
gotEnc = true;
if (enc == null) {
enc = org.apache.coyote.Constants.DEFAULT_CHARACTER_ENCODING;
}
conv = encoders.get(enc);
if (conv == null) {
if (SecurityUtil.isPackageProtectionEnabled()){
try{
conv = AccessController.doPrivileged(
new PrivilegedExceptionAction<B2CConverter>(){
@Override
public B2CConverter run() throws IOException {
return new B2CConverter(enc);
}
}
);
}catch(PrivilegedActionException ex){
Exception e = ex.getException();
if (e instanceof IOException) {
throw (IOException)e;
}
}
} else {
conv = new B2CConverter(enc);
}
encoders.put(enc, conv);
}
}
}