Beesnest/DcResponse.cpp

Go to the documentation of this file.

/*
Copyright 2007 Erez Bibi (erezbibi@users.sourceforge.net)
This file is part of Beesnest.

Beesnest 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.

Beesnest 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.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with Beesnest; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
*/


/*
 * DcResponse.cpp: Implamentation of CdcResponse class.
 * for documentation see the header file.
 */

#include "DcResponse.h"

/* Constructor. */
CdcResponse::CdcResponse (CdcSocket* psock, CdcBuffersList& bflst)
:aBody (bflst)
{
    if (psock == NULL)
        throw (CdcException ("Socket pointer is null"));

    pSocket = psock;

    Restart ();
}

void CdcResponse::Clear ()
{
    aBody.Clear ();
    mHeaderFields.clear ();
    mCookies.clear ();
}

void CdcResponse::Restart ()
{
    Clear ();

    CdcHttpTime time;
    SetHeaderField ("Accept-Ranges", "None");
    SetHeaderField ("Allow", "GET, POST, HEAD");
    SetHeaderField ("Date", time.FormatGmt (TIME_FORMAT));
    SetHeaderField ("Server", SERVER_NAME);
    SetHeaderField ("Connection", "Keep-Alive");

    SetVersion (PROTOCOL11_VRS);
    nStatusCode = 200;
    sStatusPhrase = EMPTY_STR;

    isHeaderSent = false;
}

CdcString CdcResponse::GetStatusPhrase (int code) const
{
    switch (code)
    {
    case 100: return CdcString ("Continue");
    case 101: return CdcString ("Switching Protocols");
    case 200: return CdcString ("OK");
    case 201: return CdcString ("Created");
    case 202: return CdcString ("Accepted");
    case 203: return CdcString ("Non-Authoritative Information");
    case 204: return CdcString ("No Content");
    case 205: return CdcString ("Reset Content");
    case 206: return CdcString ("Partial Content");
    case 300: return CdcString ("Multiple Choices");
    case 301: return CdcString ("Moved Permanently");
    case 302: return CdcString ("Found");
    case 303: return CdcString ("See Other");
    case 304: return CdcString ("Not Modified");
    case 305: return CdcString ("Use Proxy");
    case 307: return CdcString ("Temporary Redirect");
    case 400: return CdcString ("Bad Request");
    case 401: return CdcString ("Unauthorized");
    case 402: return CdcString ("Payment Required");
    case 403: return CdcString ("Forbidden");
    case 404: return CdcString ("Not Found");
    case 405: return CdcString ("Method Not Allowed");
    case 406: return CdcString ("Not Acceptable");
    case 407: return CdcString ("Proxy Authentication Required");
    case 408: return CdcString ("Request Time-out");
    case 409: return CdcString ("Conflict");
    case 410: return CdcString ("Gone");
    case 411: return CdcString ("Length Required");
    case 412: return CdcString ("Precondition Failed");
    case 413: return CdcString ("Request Entity Too Large");
    case 414: return CdcString ("Request-URI Too Large");
    case 415: return CdcString ("Unsupported Media Type");
    case 416: return CdcString ("Requested range not satisfiable");
    case 417: return CdcString ("Expectation Failed");
    case 500: return CdcString ("Internal Server Error");
    case 501: return CdcString ("Not Implemented");
    case 502: return CdcString ("Bad Gateway");
    case 503: return CdcString ("Service Unavailable");
    case 504: return CdcString ("Gateway Time-out");
    case 505: return CdcString ("HTTP Version not supported");
    }
    return CdcString ("Unknown code");
}

int CdcResponse::HeaderToBuffer (CdcBuffer& buff) const
{
    /* Prepare the buffer. */
    buff.RemoveAll ();

    /* Insert Status Line. */
    buff.Append (sVersion);
    buff.Append (' ');
    buff.Append (nStatusCode);
    buff.Append (' ');
    buff.Append (sStatusPhrase);
    buff.Append (CRLF);

    /* Insert Header Fields. */
    CdcString name, val;
    bool length_header = false;
    t_map::const_iterator pos;
    for (pos = mHeaderFields.begin ();
         pos != mHeaderFields.end (); ++pos)
    {
        name = (*pos).first;
        val = (*pos).second;
        if (name.CompareNoCase ("Content-Length") == 0)
            length_header = true;
        buff.Append (name);
        buff.Append (": ");
        buff.Append (val);
        buff.Append (CRLF);
    }

    /* Insert Cookies. */
    for ( pos = mCookies.begin (); pos != mCookies.end (); ++pos)
    {
        name = (*pos).first;
        val = (*pos).second;
        buff.Append ("Set-Cookie: ");
        buff.Append (name);
        buff.Append (val);
        buff.Append (CRLF);
    }

    /* Insert the Content-Length header if not there. */
    if (length_header == false && GetHeaderField ("Transfer-Encoding").IsEmpty ())
    {
        buff.Append ("Content-Length: ");
        buff.Append (aBody.GetDataSize ());
        buff.Append (CRLF);
    }

    /* Make place for the body. */
    buff.Append (CRLF);

    return buff.GetDataSize ();
}


int CdcResponse::SendHeader () throw (CdcException)
{
    if (isHeaderSent) return 0;
    /* Make the header buffer. */
    CdcBuffer buff;
    int lng = HeaderToBuffer (buff);
    /* Send by the socket.*/
    lng = pSocket->Write (buff.GetPointer (), lng);
    isHeaderSent = true;
    return lng;
}

int CdcResponse::SendResponse () throw (CdcException)
{


    int lng = 0;
    if (nStatusCode == 0 || (lng = SendHeader ()) > 0)
    {   /* Go over buffers list and send it. */
        bool ret = aBody.SeekFirst ();
        while (ret)
        {
            lng += pSocket->Write (aBody.GetPointer (), aBody.GetLength ());
            ret = aBody.SeekNext ();
        }
    }
    else
    {   /* This was started as a chunk response. */
        lng += Flush (EMPTY_STR.c_str ());
        /* Write end of chunk response. */
        CdcString tmp = "0 ";
        tmp += CRLFCRLF;
        lng += pSocket->Write (tmp.GetBuffer (), tmp.GetLength ());
    }
    return lng;
}

// http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.6.1
// http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.4.6
int CdcResponse::Flush (BufferHolder buff) throw (int)
{
    int lng = 0;
    try
    {
        if (nStatusCode > 0 && isHeaderSent == false)
        {   /* Send headers just once. */
            SetHeaderField ("Transfer-Encoding", "chunked");
            lng = SendHeader ();
        }

        bool ret = aBody.SeekFirst ();
        CdcString cnk_hdr;
        while (ret)
        {   /* Send all buffers parts that in the buffer list. */
            if (nStatusCode > 0)
            {
                cnk_hdr = CdcString::IntToString (aBody.GetLength (), "%X ") + CRLF;
                lng += pSocket->Write (cnk_hdr.GetBuffer (), cnk_hdr.GetLength ());
            }
            lng += pSocket->Write (aBody.GetPointer (), aBody.GetLength ());
            if (nStatusCode > 0)
                lng += pSocket->Write (CRLF, CRLF_SIZE);
            ret = aBody.SeekNext ();
        }

        if (buff.empty () == false)
        {   /* Send pbuff. */
            if (nStatusCode > 0)
            {
                cnk_hdr = CdcString::IntToString (buff.size, "%X ") + CRLF;
                lng += pSocket->Write (cnk_hdr.GetBuffer (), cnk_hdr.GetLength ());
            }
            lng += pSocket->Write (buff.pointer, buff.size);
            if (nStatusCode > 0)
                lng += pSocket->Write (CRLF, CRLF_SIZE);
        }
        /* Clear all data. */
        Clear ();
    }
    catch (CdcException& e)
    {   /* So we don't throw CdcException to the script engine. */
        throw e.GetExpCode ();
    }
    return lng;
}


void CdcResponse::SetCookie (const CdcString& name,
                             const CdcString& val,
                             int days, const CdcString& path)
{
    CdcString cookie = "=" + val + "; path=" + path + "; expires=";
    CdcHttpTime time;
    time.AddDays (days);
    cookie += time.FormatGmt ("%a, %d-%b-%Y %H:%M:%S GMT");
    mCookies [name] = cookie;
}

/* Set functions. */

void CdcResponse::SetVersion (const CdcString& vrs)
{
    sVersion = vrs;
}

void CdcResponse::SetStatus (int code)
{
    nStatusCode = code;
    sStatusPhrase = GetStatusPhrase (nStatusCode);
}

void CdcResponse::SetHeaderField (const CdcString& name, const CdcString& value)
{
    if (name == BN_SET_STATUS)
        SetStatus (atoi (value.GetBuffer ()));
    else
        mHeaderFields [name] = value;
}

CdcString CdcResponse::GetHeaderField (CdcString& name)
{
    if (name == BN_SET_STATUS)
        return CdcString::IntToString (nStatusCode);
    else
        return mHeaderFields [name];
}