changed the way how the request's answer is created,

now winix can return json, xml, csv from out_main_stream or from frames and json from models

removed from Request:
  bool send_bin_stream
  bool return_json
  bool return_info_only
  pt::Space info
  bool page_generated
  bool out_main_stream_use_html_filter
  bool out_streams_use_html_filter

added to Request:
  enum AnswerSource
  enum AnswerContainer
  AnswerSource answer_source
  AnswerContainer answer_container
  bool use_ezc_engine
  std::wstring frame
  bool send_all_frames
  bool use_html_filter

added to Config:
 // the name of the url parameter for returning all frames, e.g. https://domain.tld/mydir/myfunction/allframes
 // default: allframes
 std::wstring request_all_frames_parameter;

 // the name of the root element when serializing request answer to xml
 // default: winix
 std::wstring xml_root;

algorithm (the whole algorithm is described in core/request.h):
at the beginning of a request winix sets
   answer_source to models
   answer_container to text
   use_ezc_engine to true

next answer_container and use_ezc_engine can be changed in the following way:

1. winix will look for 'Accept' http header and depending on the header winix will set:
   (not implemented yet)

             Accept | answer_container | use_ezc_engine
	     ------------------------------------|-----------------
	     application/json | json             | false
	      application/xml | xml              | false
	              text/csv | csv              | false

2. next answer_container is set depending on 'container' url parameter
       container | answer_container
 ---------------------------------------------------------
     not present | don't change the value
            text | text
            json | json
             xml | xml
             csv | csv

use_ezc_engine is set depending on 'answer' url parameter:
          answer | use_ezc_engine
 ---------------------------------
     not present | don't change the value
            html | true
            data | false

if 'answer' is html then we take into account two more parameters:
 frame: frame_name (empty default) - if set then winix returns this specific frame
 allframes: (if present then winix returns all frames)
This commit is contained in:
2021-10-13 01:27:14 +02:00
parent 3e46c5674c
commit d5ebb7ca12
42 changed files with 1085 additions and 599 deletions

View File

@@ -86,8 +86,6 @@ size_t len = 0;
*/
out_streams.ClearMap();
out_streams.ResizeTab(len);
out_main_stream_use_html_filter = true;
out_streams_use_html_filter = true;
}
@@ -116,8 +114,6 @@ void Request::Clear()
out_headers.clear();
out_cookies.clear();
page_generated = false;
env_request_method.clear();
env_request_uri.clear();
env_http_cookie.clear();
@@ -137,6 +133,12 @@ void Request::Clear()
function = nullptr;
param_tab.clear();
anchor.clear();
answer_source = AnswerSource::answer_models;
answer_container = AnswerContainer::answer_text;
use_ezc_engine = true;
frame.clear();
send_all_frames = false;
status = WINIX_ERR_OK;
@@ -165,13 +167,9 @@ void Request::Clear()
timespec_ezc_engine_stop.tv_nsec = 0;
subdomain.clear();
return_info_only = false;
info.clear();
return_json = false;
models.Clear();
out_bin_stream.clear();
send_bin_stream = false;
gen_trim_white = false;
gen_skip_new_line = false;
@@ -182,6 +180,7 @@ void Request::Clear()
use_200_status_for_not_found_and_permission_denied = false;
html_template.clear();
use_html_filter = false;
}
@@ -207,6 +206,110 @@ void Request::RequestEnds()
bool Request::PrepareAnswerType()
{
answer_source = AnswerSource::answer_models;
answer_container = AnswerContainer::answer_text;
use_ezc_engine = true;
frame = ParamValue(config->request_frame_parameter);
send_all_frames = (ParamValuep(config->request_all_frames_parameter) != nullptr);
use_html_filter = config->html_filter;
bool ok = true;
// IMPLEMENT ME add checking for Accept header;
ok = ok && CheckContainerParameter();
ok = ok && CheckAnswerParameter();
return ok;
}
// IMPROVE ME give me a better name
bool Request::CheckContainerParameter()
{
std::wstring * container = ParamValuep(L"container");
if( container )
{
// IMPROVEME do a plugin call here
// if a plugin can consume this then don't check text/json/xml/csv and just return true
if( *container == L"text" )
{
answer_container = Request::AnswerContainer::answer_text;
}
else
if( *container == L"json" )
{
answer_container = Request::AnswerContainer::answer_json;
}
else
if( *container == L"xml" )
{
answer_container = Request::AnswerContainer::answer_xml;
}
else
if( *container == L"csv" )
{
answer_container = Request::AnswerContainer::answer_csv;
}
else
{
Log * log = get_logger();
if( log )
{
(*log) << log2 << "App: an unknown 'container' parameter: " << *container << logend;
// IMPROVE ME set status to 404
return false;
}
}
}
return true;
}
// IMPROVE ME give me a better name
bool Request::CheckAnswerParameter()
{
std::wstring * answer = ParamValuep(L"answer");
if( answer )
{
// IMPROVEME do a plugin call here
// if a plugin can consume this then don't check html/data and just return true
if( *answer == L"html" )
{
use_ezc_engine = true;
}
else
if( *answer == L"data" )
{
use_ezc_engine = false;
}
else
{
Log * log = get_logger();
if( log )
{
(*log) << log2 << "App: an unknown 'answer' parameter: " << *answer << logend;
// IMPROVE ME set status to 404
return false;
}
}
}
return true;
}
bool Request::IsPostVar(const wchar_t * var)
{
PostTab::iterator p;