FCGIResponse.h

Go to the documentation of this file.

/*
 * Copyright 2006-2009 Savarese Software Research Corporation
 *
 * Licensed 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
 *
 *     https://www.savarese.com/software/ApacheLicense-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.
 */

#ifndef __SSRC_WSPR_FCGI_FCGI_RESPONSE_H
#define __SSRC_WSPR_FCGI_FCGI_RESPONSE_H

#include <ssrc/wispers/fcgi/HTTPResponse.h>
#include <ssrc/wispers/fcgi/FCGIRequest.h>
#include <ssrc/wispers/types.h>

__BEGIN_NS_SSRC_WSPR_FCGI

class FCGIResponse : public HTTPResponse {
  typedef HTTPResponse super;

  boost::shared_ptr<FCGIRequest> _request;
  bool _completed, _suspended;
  HTTPStatusCode _status;
  sid_type _session_id;
  string _content_type;
  // TODO: replace with generic add_header/set_header using parameter_map.
  // Since we don't use any other custom headers, we don't implement those yet.
  string _session_cookie;

public:

  explicit FCGIResponse(const boost::shared_ptr<FCGIRequest> & request) :
    super(), _request(request),
    _completed(false), _suspended(false),
    _status(StatusOK), _session_id(_request->session_id()),
    _content_type("text/html"), _session_cookie()
  {
    // Check size as first line of protection against garbage identifiers.
    if(_session_id.size() != SessionIdNumChars && !_session_id.empty())
      _session_id.clear();
  }

  virtual ~FCGIResponse() {
    // Should be StatusGatewayTimeout, but lighttpd won't forward message body.
    if(!completed())
      send_error(StatusInternalServerError);
  }

  void fcgi_output(const char *content = 0,
                   const unsigned int content_length = 0,
                   bool cache_disable = CacheDisable);

  void fcgx_finish(const HTTPStatusCode status) {
    _completed = true;
    set_status(status);
    FCGI::FCGX_SetExitStatus(status, _request->_fcgx_request->in);
    FCGI::FCGX_Finish_r(_request->_fcgx_request.get());
  }

  virtual void complete(const char *content = 0,
                        const unsigned int content_length = 0,
                        bool cache_disable = CacheDisable)
  {
    fcgi_output(content, content_length, cache_disable);
    fcgx_finish(status());
  }

  virtual bool completed() const {
    return _completed;
  }

  virtual void suspend() {
    _suspended = true;
  }

  virtual void resume() {
    _suspended = false;
  }

  virtual bool suspended() const {
    return _suspended;
  }

  virtual void send_error(const HTTPStatusCode status) {
    _completed = true;
    // TODO: Add a proper HTML body.
    FCGI::FCGX_FPrintF(_request->_fcgx_request->out,
                       "Status: %d\r\nContent-Type: text/html\r\n\r\n"
                       "<h1>%d - Error</h1>", status, status);
    fcgx_finish(status);
  }

  virtual void send_redirect(const string & redirect);

  virtual void set_content_type(const string & type) {
    _content_type = type;
  }

  virtual const string & content_type() const {
    return _content_type;
  }

  virtual void set_status(const HTTPStatusCode status) {
    _status = status;
  }

  virtual HTTPStatusCode status() const {
    return _status;
  }

  virtual void set_session_id(const sid_type & session_id,
                              const unsigned int max_age = 1,
                              const bool secure = false);

  virtual void clear_session_id() {
    _session_id.clear();
    _session_cookie.assign("Set-Cookie: WSPRSID=; path=/; "
                           "expires=Thursday, 01-Jan-1970 00:00:00 GMT\r\n"
                           "Set-Cookie: WSPRSID=; Path=/; "
                           "Version=1; Max-Age=0\r\n"
                           /*
                           "Set-Cookie2: WSPRSID=; Path=/; "
                           "Version=1; Max-Age=0\r\n"
                           */
                           "Wispers-Event: ClearSession");
  }

  virtual const sid_type & session_id() const {
    return _session_id;
  }
};


__END_NS_SSRC_WSPR_FCGI

#endif