com.caucho.server.http.HttpResponseStream Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 1998-2018 Caucho Technology -- all rights reserved
 *
 * This file is part of Resin(R) Open Source
 *
 * Each copy or derived work must preserve the copyright notice and this
 * notice unmodified.
 *
 * Resin Open Source is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * Resin Open Source is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, or any warranty
 * of NON-INFRINGEMENT.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Resin Open Source; if not, write to the
 *
 *   Free Software Foundation, Inc.
 *   59 Temple Place, Suite 330
 *   Boston, MA 02111-1307  USA
 *
 * @author Scott Ferguson
 */

package com.caucho.server.http;

import java.io.IOException;
import java.util.ArrayList;
import java.util.logging.Level;
import java.util.logging.Logger;

import com.caucho.server.webapp.WebApp;
import com.caucho.util.L10N;
import com.caucho.vfs.Path;
import com.caucho.vfs.SendfileOutputStream;
import com.caucho.vfs.WriteStream;

public class HttpResponseStream
  extends ResponseStream
  implements SendfileOutputStream
{
  private static final L10N L = new L10N(HttpResponseStream.class);
  private static final Logger log
    = Logger.getLogger(HttpResponseStream.class.getName());

  private static final int _tailChunkedLength = 7;
  private static final byte []_tailChunked
    = new byte[] {'\r', '\n', '0', '\r', '\n', '\r', '\n'};

  private HttpResponse _response;
  private WriteStream _nextStream;

  private boolean _isChunkedEncoding;
  private int _bufferStartOffset;

  HttpResponseStream(HttpResponse response, WriteStream next)
  {
    super(response);

    _response = response;
    _nextStream = next;
  }

  @Override
  public boolean isClosed()
  {
    return super.isClosed() || _nextStream.isClosed();
  }

  /**
   * initializes the Response stream at the beginning of a request.
   */
  @Override
  public void start()
  {
    super.start();

    _isChunkedEncoding = false;
    _bufferStartOffset = 0;
  }
  //
  // implementations
  //

  @Override
  protected void writeHeaders(int length)
    throws IOException
  {
    super.writeHeaders(length);

    _isChunkedEncoding = _response.isChunkedEncoding();
  }

  @Override
  protected byte []getNextBuffer()
  {
    return _nextStream.getBuffer();
  }

  @Override
  protected int getNextStartOffset()
  {
    if (_isChunkedEncoding) {
      if (_bufferStartOffset == 0) {
        _bufferStartOffset = _nextStream.getBufferOffset() + 8;
        _nextStream.setBufferOffset(_bufferStartOffset);
      }
    }

    return _bufferStartOffset;
  }

  @Override
  protected int getNextBufferOffset()
    throws IOException
  {
    if (_isChunkedEncoding) {
      if (_bufferStartOffset == 0) {
        _bufferStartOffset = _nextStream.getBufferOffset() + 8;
        _nextStream.setBufferOffset(_bufferStartOffset);
      }
    }

    return _nextStream.getBufferOffset();
  }

  @Override
  protected void setNextBufferOffsetImpl(int offset)
  {
    if (log.isLoggable(Level.FINER)) {
      log.finer(dbgId() + "write-set-offset(" + offset + ")");
    }
    
    _nextStream.setBufferOffset(offset);
  }

  @Override
  protected byte []writeNextBufferImpl(int offset)
    throws IOException
  {
    WriteStream next = _nextStream;

    int bufferStart = _bufferStartOffset;

    if (log.isLoggable(Level.FINER))
      log.finer(dbgId() + "write-next-buffer(" + (offset - bufferStart) + ")");

    if (bufferStart > 0) {
      byte []buffer = next.getBuffer();

      int len = offset - bufferStart;

      if (len > 0)
        writeChunkHeader(buffer, bufferStart, offset - bufferStart);
      else
        offset = bufferStart - 8;

      _bufferStartOffset = 0;
    }

    return next.nextBuffer(offset);
  }

  @Override
  public void flushNextImpl()
    throws IOException
  {
    if (log.isLoggable(Level.FINE))
      log.fine(dbgId() + "flush()");

    if (_bufferStartOffset > 0) {
      // server/0506
      _nextStream.setBufferOffset(_bufferStartOffset - 8);
    }

    _nextStream.flush();

    _bufferStartOffset = 0;
  }

  @Override
  protected void closeNextImpl()
    throws IOException
  {
    _bufferStartOffset = 0;

    try {
      AbstractHttpRequest req = _response.getRequest();
      if (req.isCometActive() || req.isDuplex()) {
      }
      else if (! req.isKeepalive()) {
        // close();
        
        if (log.isLoggable(Level.FINE)) {
          log.fine(dbgId() + "close stream");
        }

        // server/2k10
        _nextStream.close();
      }
      else {
        // close();

        if (log.isLoggable(Level.FINE)) {
          log.fine(dbgId() + "finish/keepalive");
        }
      }
    } catch (Exception e) {
      log.log(Level.FINER, e.toString(), e);
    }
  }

  @Override
  protected void writeTailImpl(boolean isComplete)
    throws IOException
  {
    if (! _isChunkedEncoding) {
      if (isComplete) {
        AbstractHttpRequest req = _response.getRequest();
        
        if (req.isKeepalive()) {
          _nextStream.flushBuffer();
        }
        else {
          _nextStream.close();
        }
      }
      else {
        // server/0550
        _nextStream.flushBuffer();
      }

      return;
    }

    int bufferStart = _bufferStartOffset;

    int bufferOffset = _nextStream.getBufferOffset();
    if (bufferStart < bufferOffset) {
      if (log.isLoggable(Level.FINER))
        log.finer(dbgId() + "write-tail(" + (bufferOffset - bufferStart) + ")");
    }

    if (bufferStart > 0) {
      byte []buffer = _nextStream.getBuffer();
      int len = bufferOffset - bufferStart;
      
      if (len > 0) {
        writeChunkHeader(buffer, bufferStart, len);
      }
      else {
        bufferOffset = bufferStart - 8;
      }

      _bufferStartOffset = 0;
    }

    ArrayList footerKeys = _response.getFooterKeys();

    if (footerKeys.size() == 0) {
      _nextStream.write(_tailChunked, 0, _tailChunkedLength);
    }
    else {
      ArrayList footerValues = _response.getFooterValues();

      _nextStream.print("\r\n0\r\n");

      for (int i = 0; i < footerKeys.size(); i++) {
        _nextStream.print(footerKeys.get(i));
        _nextStream.print(": ");
        _nextStream.print(footerValues.get(i));
        _nextStream.print("\r\n");
      }

      _nextStream.print("\r\n");
    }

    if (log.isLoggable(Level.FINER))
      log.finer(dbgId() + "write-chunk-tail(" + _tailChunkedLength + ")");

    _nextStream.flush();
  }

  /**
   * Fills the chunk header.
   */
  private void writeChunkHeader(byte []buffer, int start, int length)
    throws IOException
  {
    if (length == 0)
      throw new IllegalStateException();

    buffer[start - 8] = (byte) '\r';
    buffer[start - 7] = (byte) '\n';
    buffer[start - 6] = hexDigit(length >> 12);
    buffer[start - 5] = hexDigit(length >> 8);
    buffer[start - 4] = hexDigit(length >> 4);
    buffer[start - 3] = hexDigit(length);
    buffer[start - 2] = (byte) '\r';
    buffer[start - 1] = (byte) '\n';
  }

  /**
   * Returns the hex digit for the value.
   */
  private static byte hexDigit(int value)
  {
    value &= 0xf;

    if (value <= 9)
      return (byte) ('0' + value);
    else
      return (byte) ('a' + value - 10);
  }

  @Override
  public boolean isMmapEnabled()
  {
    return _nextStream.isMmapEnabled();
  }

  @Override
  public boolean isSendfileEnabled()
  {
    return _nextStream.isSendfileEnabled();
  }

  /**
   * Sends a file.
   *
   * @param path the path to the file
   * @param length the length of the file (-1 if unknown)
   */
  @Override
  public void sendFile(Path path, long offset, long length)
    throws IOException
  {
    AbstractHttpRequest request = _response.getRequest();
    WebApp webApp = request.getWebApp();

    if (! isSendfileEnabled()
        || ! webApp.isSendfileEnabled()
        || (request.getResponseFacade().isCaching()
            && length < webApp.getSendfileMinLength())) {
      path.writeToStream(this);
      return;
    }
    
    webApp.addSendfileCount();
    
    path.sendfile(this, offset, length);
  }

  /*
  @Override
  public void writeMmap(long mmapAddress, long mmapOffset, int mmapLength)
    throws IOException
  {
    if (_isChunkedEncoding) {
      throw new IllegalStateException(L.l("writeMmap cannot use chunked"));
    }
    
    flush(); // XXX:
    
    _nextStream.writeMmap(mmapAddress, mmapOffset, mmapLength);
  }
  */
  
  @Override
  public void writeMmap(long mmapAddress, long []mmapBlocks, 
                        long mmapOffset, long mmapLength)
    throws IOException
  {
    if (_isChunkedEncoding) {
      throw new IllegalStateException(L.l("writeMmap cannot use chunked"));
    }
    
    flushBuffer();
    
    _nextStream.writeMmap(mmapAddress, mmapBlocks, mmapOffset, mmapLength);
  }

  @Override
  public void writeSendfile(byte []fileName, int nameLength, long fileLength)
    throws IOException
  {
    if (_isChunkedEncoding) {
      throw new IllegalStateException(L.l("writeSendfile cannot use chunked"));
    }
    
    flushBuffer();
    
    _nextStream.writeSendfile(fileName, nameLength, fileLength);
  }
}