cloudi_core

%-*-Mode:erlang;coding:utf-8;tab-width:4;c-basic-offset:4;indent-tabs-mode:()-*-
% ex: set ft=erlang fenc=utf-8 sts=4 ts=4 sw=4 et nomod:
%%%
%%%------------------------------------------------------------------------
%%% @doc
%%% ==CloudI ResponseInfo Creation and Parsing==
%%% The ResponseInfo format is consistent with the RequestInfo format,
%%% defined in the cloudi_request_info module.
%%% @end
%%%
%%% MIT License
%%%
%%% Copyright (c) 2014-2020 Michael Truog <mjtruog at protonmail dot com>
%%%
%%% Permission is hereby granted, free of charge, to any person obtaining a
%%% copy of this software and associated documentation files (the "Software"),
%%% to deal in the Software without restriction, including without limitation
%%% the rights to use, copy, modify, merge, publish, distribute, sublicense,
%%% and/or sell copies of the Software, and to permit persons to whom the
%%% Software is furnished to do so, subject to the following conditions:
%%%
%%% The above copyright notice and this permission notice shall be included in
%%% all copies or substantial portions of the Software.
%%%
%%% THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
%%% IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
%%% FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
%%% AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
%%% LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
%%% FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
%%% DEALINGS IN THE SOFTWARE.
%%%
%%% @author Michael Truog <mjtruog at protonmail dot com>
%%% @copyright 2014-2020 Michael Truog
%%% @version 2.0.1 {@date} {@time}
%%%------------------------------------------------------------------------

-module(cloudi_response_info).
-author('mjtruog at protonmail dot com').

%% external interface
-export([key_value_new/1,
         key_value_new/2,
         key_value_parse/1,
         key_value_parse/2,
         lookup_content_type/0,
         lookup_content_type/1,
         lookup_content_type/2]).

-type format() :: cloudi_request_info:format().
-export_type([format/0]).

-include("cloudi_response_info.hrl").

%%%------------------------------------------------------------------------
%%% External interface functions
%%%------------------------------------------------------------------------

%%-------------------------------------------------------------------------
%% @doc
%% ===New ResponseInfo key/value data.===
%% ResponseInfo is meant to contain key/value pairs that is response
%% meta-data.  Create the binary ResponseInfo data with any supported
%% data structure.
%% @end
%%-------------------------------------------------------------------------

-spec key_value_new(ResponseInfo :: cloudi_key_value:key_values()) ->
    Result :: binary().

key_value_new(ResponseInfo) ->
    key_value_new(ResponseInfo, text_pairs).

%%-------------------------------------------------------------------------
%% @doc
%% ===New ResponseInfo key/value data.===
%% ResponseInfo is meant to contain key/value pairs that is response
%% meta-data.  Create the binary ResponseInfo data with any supported
%% data structure.
%% @end
%%-------------------------------------------------------------------------

-spec key_value_new(ResponseInfo :: cloudi_key_value:key_values(),
                    Format :: format()) ->
    Result :: binary().

key_value_new(ResponseInfo, Format) ->
    case cloudi_key_value:to_list(ResponseInfo) of
        [] ->
            <<0>>;
        L ->
            cloudi_request_info:key_value_new(L, Format)
    end.

%%-------------------------------------------------------------------------
%% @doc
%% ===Parse ResponseInfo key/value data.===
%% ResponseInfo is meant to contain key/value pairs that is response
%% meta-data.
%% @end
%%-------------------------------------------------------------------------

-spec key_value_parse(ResponseInfo :: binary() |
                                      cloudi_key_value:key_values()) ->
    Result :: #{cloudi_key_value:key() := cloudi_key_value:value()}.

key_value_parse(ResponseInfo) ->
    cloudi_request_info:key_value_parse(ResponseInfo).

%%-------------------------------------------------------------------------
%% @doc
%% ===Parse ResponseInfo key/value data to the return type specified.===
%% ResponseInfo is meant to contain key/value pairs that is response
%% meta-data.
%% @end
%%-------------------------------------------------------------------------

-spec key_value_parse(ResponseInfo :: binary() |
                                      cloudi_key_value:key_values(),
                      ResultType :: map | list) ->
    Result :: #{cloudi_key_value:key() := cloudi_key_value:value()} |
              list({cloudi_key_value:key(), cloudi_key_value:value()}).

key_value_parse(ResponseInfo, ResultType) ->
    cloudi_request_info:key_value_parse(ResponseInfo, ResultType).

%%-------------------------------------------------------------------------
%% @doc
%% ===Provide a lookup with common content types.===
%% @end
%%-------------------------------------------------------------------------

-spec lookup_content_type() ->
    trie:trie().

lookup_content_type() ->
    lookup_content_type(binary).

%%-------------------------------------------------------------------------
%% @doc
%% ===Provide a lookup with common content types while setting string type of the content type value.===
%% @end
%%-------------------------------------------------------------------------

-spec lookup_content_type(binary | list) ->
    trie:trie().

lookup_content_type(binary) ->
    trie:new(lookup_content_type_data());
lookup_content_type(list) ->
    trie:new([{E, {T, erlang:binary_to_list(V)}}
                       || {E, {T, V}} <- lookup_content_type_data()]).

%%-------------------------------------------------------------------------
%% @doc
%% ===Perform a lookup on a file extension with temporary data to minimize memory consumption.===
%% @end
%%-------------------------------------------------------------------------

-spec lookup_content_type(Format :: binary | list,
                          FileExtension :: string()) ->
    {ok, {request | attachment, binary() | string()}} | error.

lookup_content_type(Format, FileExtension) ->
    case lists:keyfind(FileExtension, 1, lookup_content_type_data()) of
        {_, {Type, Value} = Result} ->
            if
                Format =:= binary ->
                    {ok, Result};
                Format =:= list ->
                    {ok, {Type, erlang:binary_to_list(Value)}}
            end;
        false ->
            error
    end.

%%%------------------------------------------------------------------------
%%% Private functions
%%%------------------------------------------------------------------------

lookup_content_type_data() ->
    ?LOOKUP_CONTENT_TYPE_DATA.

-ifdef(TEST).
-include_lib("eunit/include/eunit.hrl").

-include("cloudi_core_i_test.hrl").

module_test_() ->
    {timeout, ?TEST_TIMEOUT, [
        {"format tests", ?_assertOk(t_format())}
    ]}.

t_format() ->
    <<0>> = key_value_new([]),
    <<0>> = key_value_new([], text_pairs),
    <<0>> = key_value_new([], binary_pairs),
    ok.

-endif.