FastCGI SDK

/* * @(#)FCGIMessage.java * * * FastCGi compatibility package Interface * * * Copyright (c) 1996 Open Market, Inc. * * See the file "LICENSE.TERMS" for information on usage and redistribution * of this file, and for a DISCLAIMER OF ALL WARRANTIES. * * $Id: FCGIMessage.java,v 1.4 2000/10/02 15:09:07 robs Exp $ */ package com.fastcgi; import java.io.*; import java.util.Properties; /* This class handles reading and building the fastcgi messages. * For reading incoming mesages, we pass the input * stream as a param to the constructor rather than to each method. * Methods that build messages use and return internal buffers, so they * dont need a stream. */ public class FCGIMessage { private static final String RCSID = "$Id: FCGIMessage.java,v 1.4 2000/10/02 15:09:07 robs Exp $"; /* * Instance variables */ /* * FCGI Message Records * The logical structures of the FCGI Message Records. * Fields are originally 1 unsigned byte in message * unless otherwise noted. */ /* * FCGI Header */ private int h_version; private int h_type; private int h_requestID; // 2 bytes private int h_contentLength; // 2 bytes private int h_paddingLength; /* * FCGI BeginRequest body. */ private int br_role; // 2 bytes private int br_flags; private FCGIInputStream in; /* * constructor - Java would do this implicitly. */ public FCGIMessage(){ super(); } /* * constructor - get the stream. */ public FCGIMessage(FCGIInputStream instream){ in = instream; } /* * Message Reading Methods */ /* * Interpret the FCGI Message Header. Processes FCGI * BeginRequest and Management messages. Param hdr is the header. * The calling routine has to keep track of the stream reading * management or use FCGIInputStream.fill() which does just that. */ public int processHeader(byte[] hdr) throws IOException{ processHeaderBytes(hdr); if (h_version != FCGIGlobalDefs.def_FCGIVersion1) { return(FCGIGlobalDefs.def_FCGIUnsupportedVersion); } in.contentLen = h_contentLength; in.paddingLen = h_paddingLength; if (h_type == FCGIGlobalDefs.def_FCGIBeginRequest) { return processBeginRecord(h_requestID); } if (h_requestID == FCGIGlobalDefs.def_FCGINullRequestID) { return processManagementRecord(h_type); } if (h_requestID != in.request.requestID) { return(FCGIGlobalDefs.def_FCGISkip); } if (h_type != in.type) { return(FCGIGlobalDefs.def_FCGIProtocolError); } return(FCGIGlobalDefs.def_FCGIStreamRecord); } /* Put the unsigned bytes in the incoming FCGI header into * integer form for Java, concatinating bytes when needed. * Because Java has no unsigned byte type, we have to be careful * about signed numeric promotion to int. */ private void processHeaderBytes(byte[] hdrBuf){ h_version = hdrBuf[0] & 0xFF; h_type = hdrBuf[1] & 0xFF; h_requestID = ((hdrBuf[2] & 0xFF) << 8) | (hdrBuf[3] & 0xFF); h_contentLength = ((hdrBuf[4] & 0xFF) << 8) | (hdrBuf[5] & 0xFF); h_paddingLength = hdrBuf[6] & 0xFF; } /* * Reads FCGI Begin Request Record. */ public int processBeginRecord(int requestID) throws IOException { byte beginReqBody[]; byte endReqMsg[]; if (requestID == 0 || in.contentLen != FCGIGlobalDefs.def_FCGIEndReqBodyLen) { return FCGIGlobalDefs.def_FCGIProtocolError; } /* * If the webserver is multiplexing the connection, * this library can't deal with it, so repond with * FCGIEndReq message with protocolStatus FCGICantMpxConn */ if (in.request.isBeginProcessed) { endReqMsg = new byte[FCGIGlobalDefs.def_FCGIHeaderLen + FCGIGlobalDefs.def_FCGIEndReqBodyLen]; System.arraycopy(makeHeader( FCGIGlobalDefs.def_FCGIEndRequest, requestID, FCGIGlobalDefs.def_FCGIEndReqBodyLen, 0), 0, endReqMsg, 0, FCGIGlobalDefs.def_FCGIHeaderLen); System.arraycopy(makeEndrequestBody(0, FCGIGlobalDefs.def_FCGICantMpxConn), 0, endReqMsg, FCGIGlobalDefs.def_FCGIHeaderLen, FCGIGlobalDefs.def_FCGIEndReqBodyLen); /* * since isBeginProcessed is first set below,this * can't be out first call, so request.out is properly set */ try { in.request.outStream.write(endReqMsg, 0, FCGIGlobalDefs.def_FCGIHeaderLen + FCGIGlobalDefs.def_FCGIEndReqBodyLen); } catch (IOException e){ in.request.outStream.setException(e); return -1; } } /* * Accept this new request. Read the record body */ in.request.requestID = requestID; beginReqBody = new byte[FCGIGlobalDefs.def_FCGIBeginReqBodyLen]; if (in.read(beginReqBody, 0, FCGIGlobalDefs.def_FCGIBeginReqBodyLen) != FCGIGlobalDefs.def_FCGIBeginReqBodyLen) { return FCGIGlobalDefs.def_FCGIProtocolError; } br_flags = beginReqBody[2] & 0xFF; in.request.keepConnection = (br_flags & FCGIGlobalDefs.def_FCGIKeepConn) != 0; br_role = ((beginReqBody[0] & 0xFF) << 8) | (beginReqBody[1] & 0xFF); in.request.role = br_role; in.request.isBeginProcessed = true; return FCGIGlobalDefs.def_FCGIBeginRecord; } /* * Reads and Responds to a Management Message. The only type of * management message this library understands is FCGIGetValues. * The only variables that this library's FCGIGetValues understands * are def_FCGIMaxConns, def_FCGIMaxReqs, and def_FCGIMpxsConns. * Ignore the other management variables, and repsond to other * management messages with FCGIUnknownType. */ public int processManagementRecord(int type) throws IOException { byte[] response = new byte[64]; int wrndx = response[FCGIGlobalDefs.def_FCGIHeaderLen]; int value, len, plen; if (type == FCGIGlobalDefs.def_FCGIGetValues) { Properties tmpProps = new Properties(); readParams(tmpProps); if (in.getFCGIError() != 0 || in.contentLen != 0) { return FCGIGlobalDefs.def_FCGIProtocolError; } if (tmpProps.containsKey( FCGIGlobalDefs.def_FCGIMaxConns)) { makeNameVal( FCGIGlobalDefs.def_FCGIMaxConns, "1", response, wrndx); } else { if (tmpProps.containsKey( FCGIGlobalDefs.def_FCGIMaxReqs)) { makeNameVal( FCGIGlobalDefs.def_FCGIMaxReqs, "1", response, wrndx); } else { if (tmpProps.containsKey( FCGIGlobalDefs.def_FCGIMaxConns)) { makeNameVal( FCGIGlobalDefs.def_FCGIMpxsConns, "0", response, wrndx); } } } plen = 64 - wrndx; len = wrndx - FCGIGlobalDefs.def_FCGIHeaderLen; System.arraycopy(makeHeader( FCGIGlobalDefs.def_FCGIGetValuesResult, FCGIGlobalDefs.def_FCGINullRequestID, len, plen), 0, response, 0, FCGIGlobalDefs.def_FCGIHeaderLen); } else { ple