fcgiplus.hpp

浏览该文件的文档.

#ifndef __FCGIPLUS_HPP__
#define __FCGIPLUS_HPP__

#if _MSC_VER > 0
#pragma warning( disable: 4244 )
#endif

#include "http.hpp"

struct FCGX_Stream;
struct FcgiServerData;

namespace fcgi
{

#ifdef FCGIPLUS_DLL_USE
    #if defined(_MSC_VER) || defined(WIN32)
        #pragma warning( disable: 4251 )
        #ifdef  FCGIPLUS_DLL_EXPORTS
            #define FCGIPLUS_DLL  __declspec(dllexport)
        #else
            #define FCGIPLUS_DLL  __declspec(dllimport)
        #endif

        #define FCGIPLUS_API __stdcall
    #else
        #define FCGIPLUS_DLL
        #define FCGIPLUS_API
    #endif
#else
    #define FCGIPLUS_DLL
    #define FCGIPLUS_API
#endif

#define FCGIPLUS_FUNC_DECL(ret) FCGIPLUS_DLL ret FCGIPLUS_API
#define FCGIPLUS_FUNC_IMPL(ret) ret FCGIPLUS_API


class FcgiApp;
class Request;
class Response;
class Cookies;

typedef winux::StringMixedMap SessionData;

struct SessionStruct
{
    SessionData data;       
    winux::uint expires;    
    SessionStruct() : expires(0) { }
};

class FCGIPLUS_DLL SessionServer
{
public:
    SessionServer() : _cleanTimeInterval(1800), _sessionLifeTime(3600) { }
    virtual ~SessionServer() { }

    winux::uint getCleanTimeInterval() const { return _cleanTimeInterval; }
    winux::uint getSessionLifeTime() const { return _sessionLifeTime; }

    virtual void clean() = 0;
    virtual bool startup( winux::String const & sessid, SessionData * sessData ) = 0;
    virtual bool save( winux::String const & sessid, SessionData const * sessData, winux::uint thisLifeTime = 0 ) = 0;

protected:
    winux::uint _cleanTimeInterval; 
    winux::uint _sessionLifeTime; 
};

class FCGIPLUS_DLL MemorySessionServer : public SessionServer
{
public:
    MemorySessionServer( winux::uint cleanTimeInterval = 1800, winux::uint sessionLifeTime = 1800 );
    virtual void clean();
    virtual bool startup( winux::String const & sessid, SessionData * sessData );
    virtual bool save( winux::String const & sessid, SessionData const * sessData, winux::uint thisLifeTime = 0 );

private:
    typedef std::map<winux::String, SessionStruct> SessionStructMap;
    SessionStructMap _sessions;
    DISABLE_OBJECT_COPY(MemorySessionServer)
};

class FCGIPLUS_DLL FileSessionServer : public SessionServer
{
public:
    FileSessionServer( winux::String const & savePath, winux::uint cleanTimeInterval = 1800, winux::uint sessionLifeTime = 1800 );
    virtual void clean();
    virtual bool startup( winux::String const & sessid, SessionData * sessData );
    virtual bool save( winux::String const & sessid, SessionData const * sessData, winux::uint thisLifeTime = 0 );

private:
    winux::String _savePath; // session文件保存路径
    DISABLE_OBJECT_COPY(FileSessionServer)
};

class FCGIPLUS_DLL Session
{
public:
    Session( Request & req, winux::String const & sessid = "", winux::uint cookieSessIdLifeTime = 0, winux::uint sessionLifeTime = 0, winux::String const & cookiesPath = "" );
    ~Session();
    winux::Mixed & operator [] ( winux::String const & name );
    winux::Mixed const & operator [] ( winux::String const & name ) const;
    bool has( winux::String const & name ) const;
    winux::Mixed const & get( winux::String const & name ) const;
    void set( winux::String const & name, winux::Mixed const & v );
    bool del( winux::String const & name );

private:
    Request & _req;
    SessionData _data;
    winux::String _sessid;             // session唯一标识
    winux::uint _cookieSessIdLifeTime; // sessid cookie生命期
    winux::uint _sessionLifeTime;      // session生命期
    bool _isModified;                  // 是否修改过
    DISABLE_OBJECT_COPY(Session)
};

class FCGIPLUS_DLL Request
{
public:
    Request();
    ~Request();

    void init( FcgiApp * app, int sock, int flags );

    void free( bool close = false );

    void finish();

    bool accept();

    bool processData();

    winux::String const & operator [] ( winux::String const & name ) const;

    void dumpEnvTo( winux::String * str, char * * envp = NULL ) const;

    winux::StringStringMap environVars;
    http::Cookies cookies;
    http::Vars get;
    http::Vars post;
    FcgiApp * fcgiApp;

private:
    winux::Members<struct Request_Data> _self;

    friend class Response;
    friend class FcgiApp;

    DISABLE_OBJECT_COPY(Request)
};

class FCGIPLUS_DLL FcgiOutputMgr
{
public:
    // FCGX_Stream * fcgiOut, FCGX_Stream * fcgiErr
    FcgiOutputMgr( struct FCGX_Stream * fcgiOut, struct FCGX_Stream * fcgiErr );
    ~FcgiOutputMgr();

    void setLocalEncoding( winux::String const & local );

    void setTargetEncoding( winux::String const & target );

    winux::String getLocalEncoding() const;
    winux::String getTargetEncoding() const;

    winux::String convFrom( winux::String const & str ) const;
    winux::String convTo( winux::String const & str ) const;

    void echo( winux::String const & str );
    void write( void const * data, int size );
    void printf( char const * format, va_list va );
    winux::uint getCacheOutStreamSize() const;
    winux::uint getConvertedContentSize();

private:
    winux::Members<struct FcgiOutputMgr_Data> _self;

    void _backupStd();
    void _resumeStd();
    void _redirectToFcgi();

    // 尝试编码转换。返回值 0:不需要进行编码转换，1:需要进行编码转换并且执行了，2:需要进行编码转换，由于之前已经转换成功，所以直接返回。
    int _tryEncodingConvert();
    // 是否需要进行编码转换
    // 不需要转换的情况：a.没有设置本地编码或者目标编码，b.本地编码和目标编码相同，c.MIME不是text类型
    bool _isNeedEncodingConvert() const;

    friend class Response;

    DISABLE_OBJECT_COPY(FcgiOutputMgr)
};

class FCGIPLUS_DLL Response
{
public:
    explicit Response( Request & request );
    ~Response();

    void echo( winux::String const & str );
    void write( void const * data, int size );
    void write( winux::Buffer const & buf );
    void printf( char const * format, ... );

    winux::String getLocalEncoding() const { return _outputMgr.getLocalEncoding(); }
    winux::String getTargetEncoding() const { return _outputMgr.getTargetEncoding(); }

    winux::String convFrom( winux::String const & str ) const { return _outputMgr.convFrom(str); }
    winux::String convTo( winux::String const & str ) const { return _outputMgr.convTo(str); }
    void setMimeType( winux::String const & mime ) { _mimeType = mime; }
    winux::String getMimeType() const { return _mimeType; }

    void setAutoContentType( bool autoContentType = true ) { _autoContentType = autoContentType; }

    void setCharset( winux::String const & charset ) { _outputMgr.setTargetEncoding(charset); }
    winux::String getCharset() const { return _outputMgr.getTargetEncoding(); }

    void import( winux::String const & doFile, void * runParam = NULL, int * retCode = NULL );

    Request & req; 
    http::Header & header; 

private:
    FcgiOutputMgr _outputMgr; 
    winux::String _mimeType; 
    bool _autoContentType; 
    DISABLE_OBJECT_COPY(Response)
};

class FCGIPLUS_DLL FcgiApp
{
public:

    FcgiApp( winux::Configure & conf, struct FcgiServerData * servData = NULL );
    ~FcgiApp();

    int run( void * runParam );

    void * getParam() const { return _param; };
    template < typename _Ty >
    _Ty getParam() const { return reinterpret_cast<_Ty>(_param); };

    void setParam( void * param ) { this->_param = param; }

    void * getRunParam() const { return _runParam; };
    template < typename _Ty >
    _Ty getRunParam() const { return reinterpret_cast<_Ty>(_runParam); };

    struct FcgiServerData * getServerData() { return _servData; }
    void setServerData( struct FcgiServerData * data ) { _servData = data; }

    SessionServer * getSessServ() { return _sessServ; }
    void setSessServ( SessionServer * sessServ ) { this->_sessServ = sessServ; }

    enum ErrorCode
    {
        Err_Success,
        Err_DoFileNotFound,
        Err_WebMainNotFound,
        Err_InfiniteRecursion,
    };

    virtual ErrorCode execWebMain( Response * rsp, void * runParam, int * retCode );

    ErrorCode importDoFile( winux::String const & doFile, Response * rsp, void * runParam, int * retCode, winux::String * errDetail );

    int loadedDoFiles( winux::Mixed * arrDoFiles ) const;

    bool unloadDoFile( winux::String const & doFullPath );

    winux::DllLoader & loadModule( winux::String const & modFile );

    int loadedModules( winux::Mixed * arrModules ) const;

    bool unloadModule( winux::String const & modFile );

    Request request;

    winux::Configure & config;

    // 获取一些已经加载的配置
    struct ConfigParams
    {
        bool isProduction;
        winux::int64 maxUrlencodedPostSize;
        winux::int64 maxMultiFormPostSize;
        winux::String uploadTmpPath;
        winux::String outputTplPath;

        ConfigParams() : isProduction(false), maxUrlencodedPostSize(0), maxMultiFormPostSize(0)
        {

        }

    } configParams;


private:
    winux::Members<struct FcgiApp_Data> _self;
    SessionServer * _sessServ; // session server
    void * _param; // setParam()传递进来的参数
    void * _runParam; // run()传递进来的参数
    struct FcgiServerData * _servData; // server data
    ErrorCode _importDoFileDevelopment( winux::String const & doFullPath, Response * rsp, void * runParam, int * retCode, winux::String * errDetail );
    ErrorCode _importDoFileProduction( winux::String const & doFullPath, Response * rsp, void * runParam, int * retCode, winux::String * errDetail );

    friend class Request;
    friend class Response;
    DISABLE_OBJECT_COPY(FcgiApp)
};

} // namespace fcgi


#endif // __FCGIPLUS_HPP__