IIPResponse.h

/*
    IIP Response Handler Class
 
    Copyright (C) 2003-2023 Ruven Pillay.
 
    This program 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 3 of the License, or
    (at your option) any later version.
 
    This program 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 this program; if not, write to the Free Software Foundation,
    Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
*/
 
 
#ifndef _IIPRESPONSE_H
#define _IIPRESPONSE_H
 
#ifndef VERSION
#define VERSION "999"
#endif
 
// Fix missing snprintf in Windows
#if defined _MSC_VER && _MSC_VER<1900
#define snprintf _snprintf
#endif
 
 
#include <string>
 
 
 
class IIPResponse{
 
 
 private:
 
  std::string server;              // Server header
  std::string powered;             // Powered By header
  std::string modified;            // Last modified header
  std::string cacheControl;        // Cache control header
  std::string mimeType;            // Mime type header
  std::string eof;                 // End of response delimitter eg "\r\n"
  std::string protocol;            // IIP protocol version
  std::string responseBody;        // The main response
  std::string error;               // Error message
  std::string cors;                // CORS (Cross-Origin Resource Sharing) setting
  std::string contentDisposition;  // File name to use for Content Disposition header
  std::string status;              // HTTP status code
  bool _cachable;                  // Indicate whether response should be cached
  bool _sent;                      // Indicate whether a response has been sent
 
 
 public:
 
  IIPResponse();
 
 
 
  void setProtocol( const std::string& p ) { protocol = p; };
 
 
 
  void setMimeType( const std::string& m ) { mimeType = "Content-Type: " + m; };
 
 
 
  void setLastModified( const std::string& m ) { modified = "Last-Modified: " + m; };
 
 
 
  void setContentDisposition( const std::string& name, const std::string& type = "inline" ) {
    contentDisposition = "Content-Disposition: " + type + "; filename=\"" + name + "\"";
  }
 
 
 
  void addResponse( const std::string& r );
 
 
 
  void addResponse( const char* c );
 
 
 
  void addResponse( const char* c, int a );
 
 
 
  void addResponse( std::string c, const std::string& a );
 
 
 
  void addResponse( const char* c, int a, int b );
 
 
 
  void setError( const std::string& code, const std::string& arg );
 
 
 
  void setCORS( const std::string& c ){
    if(!c.empty()){
      cors =
        "Access-Control-Allow-Origin: " + c + eof +
        "Access-Control-Allow-Methods: GET, POST, OPTIONS" + eof +
        "Access-Control-Allow-Headers: Accept, Content-Type, X-Requested-With, If-Modified-Since" + eof +
        "Access-Control-Max-Age: 86400";
    }
  };
 
 
  std::string getCORS(){ return cors; };
 
 
 
  void setCacheControl( const std::string& c ){ cacheControl = "Cache-Control: " + c; };
 
 
 
  void setCachability( bool cachable ){ _cachable = cachable; };
 
 
 
  bool cachable(){ return _cachable; };
 
 
  std::string getCacheControl(){ return cacheControl; };
 
 
 
  void setStatus( const std::string& s ){ status = "Status: " + s; }
 
 
  std::string formatResponse();
 
 
  bool isSet(){
    if( error.length() || responseBody.length() || protocol.length() ) return true;
    else return false;
  }
 
 
  bool errorIsSet(){
    if( error.length() ) return true;
    else return false;
  }
 
 
  void setImageSent() { _sent = true; };
 
 
  bool imageSent() { return _sent; };
 
 
 
  std::string getAdvert();
 
 
 
  std::string createHTTPHeader( const std::string& mimeType, const std::string& timeStamp, unsigned int contentLength=0 );
 
};
 
 
#endif