Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   *  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.coyote.http11.filters;
 
 import static org.jboss.web.CoyoteMessages.MESSAGES;
 
 
Chunked input filter. Parses chunked data according to http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.6.1

Author(s):
Remy Maucherat
Filip Hanik
 
 public class ChunkedInputFilter implements InputFilter {
 
 
     // -------------------------------------------------------------- Constants
 
 
     protected static final String ENCODING_NAME = "chunked";
     protected static final ByteChunk ENCODING = new ByteChunk();
 
 
     // ----------------------------------------------------- Static Initializer
 
 
     static {
     }
 
 
     // ----------------------------------------------------- Instance Variables
 

    
Next buffer in the pipeline.
 
     protected InputBuffer buffer;


    
Number of bytes remaining in the current chunk.
 
     protected int remaining = 0;


    
Position in the buffer.
 
     protected int pos = 0;


    
Last valid byte in the buffer.
 
     protected int lastValid = 0;


    
Read bytes buffer.
 
     protected byte[] buf = null;


    
Byte chunk used to read bytes.
 
     protected ByteChunk readChunk = new ByteChunk();


    
Flag set to true when the end chunk has been read.
 
     protected boolean endChunk = false;

    
Flag set to true if the next call to doRead() must parse a CRLF pair before doing anything else.
    protected boolean needCRLFParse = false;

    
Flag that indicates if an error has occurred.
    private boolean error;
    // ------------------------------------------------------------- Properties
    // ---------------------------------------------------- InputBuffer Methods


    
Read bytes.

Returns:
If the filter does request length control, this value is significant; it should be the number of bytes consumed from the buffer, up until the end of the current request body, or the buffer length, whichever is greater. If the filter does not do request body length control, the returned value should be -1.
    public int doRead(ByteChunk chunkRequest req)
        throws IOException {
        if ()
            return -1;
        checkError();
        if () {
             = false;
            // FIXME: parse CRLF could return 0 in NB
            parseCRLF();
        }
        if ( <= 0) {
            if (!parseChunkHeader()) {
                return 0;
            }
            if () {
                parseEndChunk();
                return -1;
            }
        }
        int result = 0;
        if ( >= ) {
            // FIXME: parse CRLF could return 0 in NB
            readBytes();
        }
        if ( > ( - )) {
            result =  - ;
             =  - result;
            chunk.setBytes(result);
             = ;
        } else {
            result = ;
            chunk.setBytes();
             =  + ;
             = 0;
            //we need a CRLF
            if ((+1) >= ) {   
                //if we call parseCRLF we overrun the buffer here
                //so we defer it to the next call BZ 11117
                 = true;
            } else {
                parseCRLF(); //parse the CRLF immediately
            }
        }
        return result;
    }
    // ---------------------------------------------------- InputFilter Methods


    
Read the content length from the request.
    public void setRequest(Request request) {
    }


    
End the current request.
    public long end()
        throws IOException {
        // Consume extra bytes : parse the stream until the end chunk is found
        while (doRead(null) > 0) {
        }
        // Return the number of extra bytes which were consumed
        return ( - );
    }


    
Amount of bytes still available in a buffer.
    public int available() {
        return ( - );
    }
    

    
Set the next buffer in the filter pipeline.
    public void setBuffer(InputBuffer buffer) {
        this. = buffer;
    }


    
Make the filter ready to process the next request.
    public void recycle() {
         = 0;
         = 0;
         = 0;
         = false;
         = false;
         = false;
    }


    
Return the name of the associated encoding; Here, the value is "identity".
    public ByteChunk getEncodingName() {
        return ;
    }
    // ------------------------------------------------------ Protected Methods


    
Read bytes from the previous buffer.
    protected int readBytes()
        throws IOException {
        int nRead = .doRead(null);
         = .getStart();
         =  + nRead;
         = .getBytes();
        return nRead;
    }


    
Parse the header of a chunk. A chunk header can look like A10CRLF F23;chunk-extension to be ignoredCRLF The letters before CRLF but after the trailer mark, must be valid hex digits, we should not parse F23IAMGONNAMESSTHISUP34CRLF as a valid header according to spec
    protected boolean parseChunkHeader()
        throws IOException {
        int result = 0;
        boolean eol = false;
        boolean crfound = false;
        int readDigit = 0;
        boolean trailer = false;
        while (!eol) {
            if ( >= ) {
                // In non blocking mode, no new chunk follows, even if data was present
                int n = readBytes();
                if (n < 0) {
                     = true;
                    throw .invalidChunkHeader();
                } else if (n == 0) {
                    return false;
                }
            }
            if ([] == .) {
                if (crfoundthrow .invalidCrlfTwoCr();
                crfound = true;
            } else if ([] == .) {
                if (!crfoundthrow .invalidCrlfNoCr();
                eol = true;
            } else if ([] == .) {
                trailer = true;
            } else if ([] < 0) {
                 = true;
                throw .invalidChunkHeader();
            } else if (!trailer) { 
                //don't read data after the trailer
                int charValue = .[[] & 0xff];
                if (charValue != -1 && readDigit < 8) {
                    readDigit++;
                    result = (result << 4) | charValue;
                } else {
                    //we shouldn't allow invalid, non hex characters
                    //in the chunked header
                     = true;
                    throw .invalidChunkHeader();
                }
            }
            ++;
        }
        if (readDigit == 0 || (result < 0)) {
             = true;
            throw .invalidChunkHeader();
        }
        if (result == 0)
             = true;
         = result;
        return true;
    }


    
Parse CRLF at end of chunk.
    protected boolean parseCRLF()
        throws IOException {
        boolean eol = false;
        boolean crfound = false;
        while (!eol) {
            if ( >= ) {
                if (readBytes() <= 0) {
                     = true;
                    throw .invalidCrlf();
                }
            }
            if ([] == .) {
                if (crfound) {
                     = true;
                    throw .invalidCrlfTwoCr();
                }
                crfound = true;
            } else if ([] == .) {
                if (!crfound) {
                     = true;
                    throw .invalidCrlfNoCr();
                }
                eol = true;
            } else {
                 = true;
                throw .invalidCrlf();
            }
            ++;
        }
        return true;
    }


    
Parse end chunk data. FIXME: Handle trailers
    protected boolean parseEndChunk()
        throws IOException {
        return parseCRLF(); // FIXME
    }
    private void checkError() throws IOException {
        if () {
            throw new IOException(.chunkedFilterError());
        }
    }
New to GrepCode? Check out our FAQ X