inets: Add unix domain socket support to httpc

Change-Id: I44fe2670e36884e09600d17dd71b1e86b9ee75fa

8 files changed, 186 insertions, 26 deletions

diff --git a/lib/inets/doc/src/http_client.xml b/lib/inets/doc/src/http_client.xml
index 212958f17f..15e383ec77 100644
--- a/lib/inets/doc/src/http_client.xml
+++ b/lib/inets/doc/src/http_client.xml
@@ -97,27 +97,32 @@
       7 > {ok, {{NewVersion, 200, NewReasonPhrase}, NewHeaders, NewBody}} =
       httpc:request(get, {"http://www.erlang.org", [{"connection", "close"}]},
       [], []).</code>
-
+    <p>This sends an HTTP request over a unix domain socket (experimental):</p>
+    <code type="erl">
+      8 > httpc:set_options([{ipfamily, local},
+      {unix_socket,"/tmp/unix_socket/consul_http.sock"}]).
+      9 > {ok, {{NewVersion, 200, NewReasonPhrase}, NewHeaders, NewBody}} =
+      httpc:request(put, {"http:///v1/kv/foo", [], [], "hello"}, [], []).</code>
     <p>Start an HTTP client profile:</p>
    
     <code><![CDATA[
-      8 > {ok, Pid} = inets:start(httpc, [{profile, foo}]).
+      10 > {ok, Pid} = inets:start(httpc, [{profile, foo}]).
       {ok, <0.45.0>}       
       ]]></code>
     
     <p>The new profile has no proxy settings, so the connection is refused:</p>
       <code type="erl">
-      9 > httpc:request("http://www.erlang.org", foo). 
+      11 > httpc:request("http://www.erlang.org", foo).
       {error, econnrefused}</code>
 
     <p>Stop the HTTP client profile:</p>
     <code type="erl">
-      10 > inets:stop(httpc, foo).
+      12 > inets:stop(httpc, foo).
       ok</code>
     
     <p>Alternative way to stop the HTTP client profile:</p>
     <code type="erl">
-      10 > inets:stop(httpc, Pid).
+      13 > inets:stop(httpc, Pid).
       ok</code>
     
   </section>
diff --git a/lib/inets/doc/src/httpc.xml b/lib/inets/doc/src/httpc.xml
index 29e4b22632..befcd83827 100644
--- a/lib/inets/doc/src/httpc.xml
+++ b/lib/inets/doc/src/httpc.xml
@@ -210,7 +210,8 @@
 			   ip | 
 			   port | 
 			   socket_opts | 
-	                   verbose</v>
+	                   verbose |
+	                   unix_socket</v>
 	<v>Profile = profile() | pid()</v>
 	<d>When started <c>stand_alone</c> only the pid can used.</d>
         <v>Values = [{option_item(), term()}]</v>
@@ -298,8 +299,8 @@
                       {full_result,             boolean()} | 
                       {headers_as_is,           boolean() |
                       {socket_opts,             socket_opts()} | 
-                      {receiver,                receiver()},
-	              {ipv6_host_with_brackets, boolean()}}</v>
+                      {receiver,                receiver()} |
+	              {ipv6_host_with_brackets, boolean()}</v>
         <v>stream_to() = none | self | {self, once} | filename()</v>
         <v>socket_opts() = [socket_opt()]</v>
         <v>receiver() = pid() | function()/1 | {Module, Function, Args}</v>
@@ -541,7 +542,8 @@
 	<v>| {ip, IpAddress}</v>
 	<v>| {port, Port}</v>
 	<v>| {socket_opts, socket_opts()}</v>
-	<v>| {verbose, VerboseMode}</v>	    
+	<v>| {verbose, VerboseMode}</v>
+	<v>| {unix_socket, UnixSocket}</v>
         <v>Proxy = {Hostname, Port}</v>
         <v>Hostname = string()</v>
         <d>Example: "localhost" or "foo.bar.se"</d>
@@ -584,7 +586,7 @@
 	If option <c>verify</c> is used, function <c>store_cookies/2</c>
 	has to be called for the cookies to be saved. 
 	Default is <c>disabled</c>.</d>
-	<v>IpFamily = inet | inet6 </v>
+	<v>IpFamily = inet | inet6 | local</v>
 	<d>Default is <c>inet</c>.</d>
 	<v>IpAddress = ip_address()</v>
 	<d>If the host has several network interfaces, this option specifies 
@@ -609,6 +611,12 @@
 	It is a debug feature.</d>
 	<v>Profile = profile() | pid()</v>
 	<d>When started <c>stand_alone</c> only the pid can be used.</d>
+	<v>UnixSocket = path()</v>
+	<d>
+	  Experimental option for sending HTTP requests over a unix domain socket. The value
+	  of <c>unix_socket</c> shall be the full path to a unix domain socket file with read/write
+	  permissions for the erlang process. Default is <c>undefined</c>.
+	</d>
       </type>
       <desc>
 	<p>Sets options to be used for subsequent requests.</p>
diff --git a/lib/inets/src/http_client/httpc.erl b/lib/inets/src/http_client/httpc.erl
index bf2da82603..dd493d7554 100644
--- a/lib/inets/src/http_client/httpc.erl
+++ b/lib/inets/src/http_client/httpc.erl
@@ -171,6 +171,7 @@ request(Method,
 	HTTPOptions, Options, Profile) 
   when (Method =:= options) orelse 
        (Method =:= get) orelse 
+       (Method =:= put) orelse
        (Method =:= head) orelse 
        (Method =:= delete) orelse 
        (Method =:= trace) andalso 
@@ -528,6 +529,7 @@ handle_request(Method, Url,
 	    HeadersRecord = header_record(NewHeaders, Host2, HTTPOptions),
 	    Receiver      = proplists:get_value(receiver, Options),
 	    SocketOpts    = proplists:get_value(socket_opts, Options),
+	    UnixSocket    = proplists:get_value(unix_socket, Options),
 	    BracketedHost = proplists:get_value(ipv6_host_with_brackets, 
 						Options),
 	    MaybeEscPath  = maybe_encode_uri(HTTPOptions, Path),
@@ -549,6 +551,7 @@ handle_request(Method, Url,
 			       headers_as_is = headers_as_is(Headers0, Options),
 			       socket_opts   = SocketOpts, 
 			       started       = Started,
+			       unix_socket   = UnixSocket,
 			       ipv6_host_with_brackets = BracketedHost},
 
 	    case httpc_manager:request(Request, profile_name(Profile)) of
@@ -798,7 +801,7 @@ request_options_defaults() ->
 		error
 	end,
 
-    VerifyBrackets = VerifyBoolean, 
+    VerifyBrackets = VerifyBoolean,
 
     [
      {sync,                    true,      VerifySync}, 
@@ -869,11 +872,36 @@ request_options_sanity_check(Opts) ->
     end,
     ok.
 
-validate_options(Options) ->
-    (catch validate_options(Options, [])).
-
-validate_options([], ValidateOptions) ->
-    {ok, lists:reverse(ValidateOptions)};
+validate_ipfamily_unix_socket(Options0) ->
+    IpFamily = proplists:get_value(ipfamily, Options0, inet),
+    UnixSocket = proplists:get_value(unix_socket, Options0, undefined),
+    Options1 = proplists:delete(ipfamily, Options0),
+    Options2 = proplists:delete(ipfamily, Options1),
+    validate_ipfamily_unix_socket(IpFamily, UnixSocket, Options2,
+                                  [{ipfamily, IpFamily}, {unix_socket, UnixSocket}]).
+%%
+validate_ipfamily_unix_socket(local, undefined, _Options, _Acc) ->
+    bad_option(unix_socket, undefined);
+validate_ipfamily_unix_socket(IpFamily, UnixSocket, _Options, _Acc)
+  when IpFamily =/= local, UnixSocket =/= undefined ->
+    bad_option(ipfamily, IpFamily);
+validate_ipfamily_unix_socket(IpFamily, UnixSocket, Options, Acc) ->
+    validate_ipfamily(IpFamily),
+    validate_unix_socket(UnixSocket),
+    {Options, Acc}.
+
+
+validate_options(Options0) ->
+    try
+        {Options, Acc} = validate_ipfamily_unix_socket(Options0),
+        validate_options(Options, Acc)
+    catch
+        error:Reason ->
+            {error, Reason}
+    end.
+%%
+validate_options([], ValidOptions) ->
+    {ok, lists:reverse(ValidOptions)};
 
 validate_options([{proxy, Proxy} = Opt| Tail], Acc) ->
     validate_proxy(Proxy),
@@ -933,6 +961,10 @@ validate_options([{verbose, Value} = Opt| Tail], Acc) ->
     validate_verbose(Value), 
     validate_options(Tail, [Opt | Acc]);
 
+validate_options([{unix_socket, Value} = Opt| Tail], Acc) ->
+    validate_unix_socket(Value),
+    validate_options(Tail, [Opt | Acc]);
+
 validate_options([{_, _} = Opt| _], _Acc) ->
     {error, {not_an_option, Opt}}.
 
@@ -1001,7 +1033,8 @@ validate_ipv6(BadValue) ->
     bad_option(ipv6, BadValue).
 
 validate_ipfamily(Value) 
-  when (Value =:= inet) orelse (Value =:= inet6) orelse (Value =:= inet6fb4) ->
+  when (Value =:= inet) orelse (Value =:= inet6) orelse
+       (Value =:= inet6fb4) orelse (Value =:= local) ->
     Value;
 validate_ipfamily(BadValue) ->
     bad_option(ipfamily, BadValue).
@@ -1031,6 +1064,15 @@ validate_verbose(Value)
 validate_verbose(BadValue) ->
     bad_option(verbose, BadValue).
 
+validate_unix_socket(Value)
+  when (Value =:= undefined) ->
+    Value;
+validate_unix_socket(Value)
+  when is_list(Value) andalso length(Value) > 0 ->
+    Value;
+validate_unix_socket(BadValue) ->
+    bad_option(unix_socket, BadValue).
+
 bad_option(Option, BadValue) ->
     throw({error, {bad_option, Option, BadValue}}).
 
diff --git a/lib/inets/src/http_client/httpc_handler.erl b/lib/inets/src/http_client/httpc_handler.erl
index a4e406b807..26e4f4e699 100644
--- a/lib/inets/src/http_client/httpc_handler.erl
+++ b/lib/inets/src/http_client/httpc_handler.erl
@@ -754,6 +754,7 @@ connect(SocketType, ToAddress,
         #options{ipfamily    = IpFamily,
                  ip          = FromAddress,
                  port        = FromPort,
+                 unix_socket = UnixSocket,
                  socket_opts = Opts0}, Timeout) ->
     Opts1 = 
         case FromPort of
@@ -789,6 +790,16 @@ connect(SocketType, ToAddress,
                 OK ->
                     OK
             end;
+        local ->
+            Opts3 = [IpFamily | Opts2],
+            SocketAddr = {local, UnixSocket},
+            case http_transport:connect(SocketType, {SocketAddr, 0}, Opts3, Timeout) of
+                {error, Reason} ->
+                    {error, {failed_connect, [{to_address, SocketAddr},
+                                              {IpFamily, Opts3, Reason}]}};
+                Else ->
+                    Else
+            end;
         _ ->
             Opts3 = [IpFamily | Opts2], 
             case http_transport:connect(SocketType, ToAddress, Opts3, Timeout) of
@@ -800,9 +811,23 @@ connect(SocketType, ToAddress,
             end
     end.
 
-connect_and_send_first_request(Address, Request, #state{options = Options} = State) ->
+handle_unix_socket_options(#request{unix_socket = UnixSocket}, Options)
+  when UnixSocket =:= undefined ->
+    Options;
+
+handle_unix_socket_options(#request{unix_socket = UnixSocket},
+                           Options = #options{ipfamily = IpFamily}) ->
+    case IpFamily of
+        local ->
+            Options#options{unix_socket = UnixSocket};
+        Else ->
+            error({badarg, [{ipfamily, Else}, {unix_socket, UnixSocket}]})
+    end.
+
+connect_and_send_first_request(Address, Request, #state{options = Options0} = State) ->
     SocketType  = socket_type(Request),
     ConnTimeout = (Request#request.settings)#http_options.connect_timeout,
+    Options = handle_unix_socket_options(Request, Options0),
     case connect(SocketType, Address, Options, ConnTimeout) of
         {ok, Socket} ->
             ClientClose =
@@ -841,9 +866,10 @@ connect_and_send_first_request(Address, Request, #state{options = Options} = Sta
             {ok, State#state{request = Request}}
     end.
 
-connect_and_send_upgrade_request(Address, Request, #state{options = Options} = State) ->
+connect_and_send_upgrade_request(Address, Request, #state{options = Options0} = State) ->
     ConnTimeout = (Request#request.settings)#http_options.connect_timeout,
     SocketType = ip_comm,
+    Options = handle_unix_socket_options(Request, Options0),
     case connect(SocketType, Address, Options, ConnTimeout) of
         {ok, Socket} ->
 	    SessionType = httpc_manager:session_type(Options),
diff --git a/lib/inets/src/http_client/httpc_internal.hrl b/lib/inets/src/http_client/httpc_internal.hrl
index 5f8c70f28d..c5fe439722 100644
--- a/lib/inets/src/http_client/httpc_internal.hrl
+++ b/lib/inets/src/http_client/httpc_internal.hrl
@@ -83,10 +83,11 @@
 	 max_sessions          = ?HTTP_MAX_TCP_SESSIONS,
 	 cookies               = disabled, % enabled | disabled | verify
 	 verbose               = false,   % boolean(),
-	 ipfamily              = inet,    % inet | inet6 | inet6fb4
+	 ipfamily              = inet,    % inet | inet6 | inet6fb4 | local
 	 ip                    = default, % specify local interface
 	 port                  = default, % specify local port
-	 socket_opts           = []       % other socket options
+	 socket_opts           = [],      % other socket options
+	 unix_socket           = undefined % Local unix socket
 	}
        ).
 -type options() :: #options{}.
@@ -115,6 +116,7 @@
 			 % request
 	  timer         :: undefined | reference(),
 	  socket_opts,   % undefined | [socket_option()]
+	  unix_socket,   % undefined | string()
 	  ipv6_host_with_brackets % boolean()
 	}
        ).
diff --git a/lib/inets/src/http_client/httpc_manager.erl b/lib/inets/src/http_client/httpc_manager.erl
index ffdf1603b3..7b8d7875de 100644
--- a/lib/inets/src/http_client/httpc_manager.erl
+++ b/lib/inets/src/http_client/httpc_manager.erl
@@ -553,7 +553,8 @@ handle_cast({set_options, Options}, State = #state{options = OldOptions}) ->
 		 ip                    = get_ip(Options, OldOptions),
 		 port                  = get_port(Options, OldOptions),
 		 verbose               = get_verbose(Options, OldOptions),
-		 socket_opts           = get_socket_opts(Options, OldOptions)
+		 socket_opts           = get_socket_opts(Options, OldOptions),
+		 unix_socket           = get_unix_socket_opts(Options, OldOptions)
 		}, 
     case {OldOptions#options.verbose, NewOptions#options.verbose} of
 	{Same, Same} ->
@@ -963,7 +964,10 @@ get_option(ip, #options{ip = IP}) ->
 get_option(port, #options{port = Port}) ->
     Port;
 get_option(socket_opts, #options{socket_opts = SocketOpts}) ->
-    SocketOpts.
+    SocketOpts;
+get_option(unix_socket, #options{unix_socket = UnixSocket}) ->
+    UnixSocket.
+
 
 get_proxy(Opts, #options{proxy = Default}) ->
     proplists:get_value(proxy, Opts, Default).
@@ -1016,6 +1020,8 @@ get_verbose(Opts, #options{verbose = Default}) ->
 get_socket_opts(Opts, #options{socket_opts = Default}) ->
     proplists:get_value(socket_opts, Opts, Default).
 
+get_unix_socket_opts(Opts, #options{unix_socket = Default}) ->
+    proplists:get_value(unix_socket, Opts, Default).
 
 handle_verbose(debug) ->
     dbg:p(self(), [call]),
diff --git a/lib/inets/test/http_test_lib.erl b/lib/inets/test/http_test_lib.erl
index 38e9e4976e..4e119cce04 100644
--- a/lib/inets/test/http_test_lib.erl
+++ b/lib/inets/test/http_test_lib.erl
@@ -1,7 +1,7 @@
 %%
 %% %CopyrightBegin%
 %% 
-%% Copyright Ericsson AB 2015-2015. All Rights Reserved.
+%% Copyright Ericsson AB 2015-2018. All Rights Reserved.
 %% 
 %% Licensed under the Apache License, Version 2.0 (the "License");
 %% you may not use this file except in compliance with the License.
@@ -55,6 +55,25 @@ dummy_server_init(Caller, ip_comm, Inet, Extra) ->
 						     ]]},
 			     [], ContentCb, Conf, ListenSocket);
 
+dummy_server_init(Caller, unix_socket, Inet, Extra) ->
+    ContentCb = proplists:get_value(content_cb, Extra),
+    UnixSocket = proplists:get_value(unix_socket, Extra),
+    SocketAddr = {local, UnixSocket},
+    BaseOpts = [binary, {packet, 0}, {reuseaddr,true}, {active, false}, {nodelay, true},
+               {ifaddr, SocketAddr}],
+    Conf = proplists:get_value(conf, Extra),
+    {ok, ListenSocket} = gen_tcp:listen(0, [Inet | BaseOpts]),
+    {ok, Port} = inet:port(ListenSocket),
+    Caller ! {port, Port},
+    dummy_ipcomm_server_loop({httpd_request, parse, [[{max_uri,    ?HTTP_MAX_URI_SIZE},
+						      {max_header, ?HTTP_MAX_HEADER_SIZE},
+						      {max_version,?HTTP_MAX_VERSION_STRING},
+						      {max_method, ?HTTP_MAX_METHOD_STRING},
+						      {max_content_length, ?HTTP_MAX_CONTENT_LENGTH},
+						      {customize, httpd_custom}
+						     ]]},
+			     [], ContentCb, Conf, ListenSocket);
+
 dummy_server_init(Caller, ssl, Inet, Extra) ->
     ContentCb = proplists:get_value(content_cb, Extra),
     SSLOptions = proplists:get_value(ssl, Extra),
diff --git a/lib/inets/test/httpc_SUITE.erl b/lib/inets/test/httpc_SUITE.erl
index f7e5c11272..52d9e0603a 100644
--- a/lib/inets/test/httpc_SUITE.erl
+++ b/lib/inets/test/httpc_SUITE.erl
@@ -37,6 +37,10 @@
 -define(TLS_URL_START, "https://").
 -define(NOT_IN_USE_PORT, 8997).
 
+%% Using hardcoded file path to keep it below 107 charaters
+%% (maximum length supported by erlang)
+-define(UNIX_SOCKET, "/tmp/inets_httpc_SUITE.sock").
+
 -record(sslsocket, {fd = nil, pid = nil}).
 %%--------------------------------------------------------------------
 %% Common Test interface functions -----------------------------------
@@ -51,6 +55,7 @@ all() ->
      {group, http},
      {group, sim_http},
      {group, http_internal},
+     {group, http_unix_socket},
      {group, https},
      {group, sim_https},
      {group, misc}
@@ -61,6 +66,7 @@ groups() ->
      {http, [], real_requests()},
      {sim_http, [], only_simulated() ++ [process_leak_on_keepalive]},
      {http_internal, [], real_requests_esi()},
+     {http_unix_socket, [], simulated_unix_socket()},
      {https, [], real_requests()},
      {sim_https, [], only_simulated()},
      {misc, [], misc()}
@@ -98,6 +104,9 @@ real_requests()->
 real_requests_esi() ->
     [slow_connection].
 
+simulated_unix_socket() ->
+    [unix_domain_socket].
+
 only_simulated() ->
     [
      cookie,
@@ -155,12 +164,14 @@ init_per_suite(Config) ->
     ServerRoot = filename:join(PrivDir, "server_root"),
     DocRoot = filename:join(ServerRoot, "htdocs"),
     setup_server_dirs(ServerRoot, DocRoot, DataDir),
+    file:delete(?UNIX_SOCKET),
     [{server_root, ServerRoot}, {doc_root, DocRoot}  | Config].
 
 end_per_suite(Config) ->
     inets_test_lib:stop_apps([inets]),
     PrivDir = proplists:get_value(priv_dir, Config),
     inets_test_lib:del_dirs(PrivDir),
+    file:delete(?UNIX_SOCKET),
     ok.
 
 %%--------------------------------------------------------------------
@@ -1227,6 +1238,21 @@ slow_connection(Config) when is_list(Config) ->
     %% in httpc_handler.
     {ok, _} = httpc:request(post, Request, [], []).
 
+%%-------------------------------------------------------------------------
+unix_domain_socket() ->
+    [{"doc, Test HTTP requests over unix domain sockets"}].
+unix_domain_socket(Config) when is_list(Config) ->
+
+    URL = "http:///v1/kv/foo",
+
+    {ok,[{unix_socket,?UNIX_SOCKET}]} =
+        httpc:get_options([unix_socket]),
+    {ok, {{_,200,_}, [_ | _], _}}
+	= httpc:request(put, {URL, [], [], ""}, [], []),
+    {ok, {{_,200,_}, [_ | _], _}}
+        = httpc:request(get, {URL, []}, [], []).
+
+
 
 %%--------------------------------------------------------------------
 %% Internal Functions ------------------------------------------------
@@ -1342,19 +1368,28 @@ group_name(Config) ->
 
 server_start(sim_http, _) ->
     Inet = inet_version(),
-    ok = httpc:set_options([{ipfamily, Inet}]),
+    ok = httpc:set_options([{ipfamily, Inet},{unix_socket, undefined}]),
     {_Pid, Port} = http_test_lib:dummy_server(ip_comm, Inet, [{content_cb, ?MODULE}]),
     Port;
 
 server_start(sim_https, SslConfig) ->
     Inet = inet_version(),
-    ok = httpc:set_options([{ipfamily, Inet}]),
+    ok = httpc:set_options([{ipfamily, Inet},{unix_socket, undefined}]),
     {_Pid, Port} = http_test_lib:dummy_server(ssl, Inet, [{ssl, SslConfig}, {content_cb, ?MODULE}]),
     Port;
 
+server_start(http_unix_socket, Config) ->
+    Inet = local,
+    Socket = proplists:get_value(unix_socket, Config),
+    ok = httpc:set_options([{ipfamily, Inet},{unix_socket, Socket}]),
+    {_Pid, Port} = http_test_lib:dummy_server(unix_socket, Inet, [{content_cb, ?MODULE},
+                                                                  {unix_socket, Socket}]),
+    Port;
+
 server_start(_, HttpdConfig) ->
     {ok, Pid} = inets:start(httpd, HttpdConfig),
     Serv = inets:services_info(),
+    ok = httpc:set_options([{ipfamily, inet_version()},{unix_socket, undefined}]),
     {value, {_, _, Info}} = lists:keysearch(Pid, 2, Serv),
     proplists:get_value(port, Info).
 
@@ -1384,6 +1419,10 @@ server_config(https, Config) ->
     [{socket_type, {essl, ssl_config(Config)}} | server_config(http, Config)];
 server_config(sim_https, Config) ->
     ssl_config(Config);
+server_config(http_unix_socket, _Config) ->
+    Socket = ?UNIX_SOCKET,
+    [{unix_socket, Socket}];
+
 server_config(_, _) ->
     [].
 
@@ -2102,6 +2141,19 @@ handle_uri(_,"/delay_close.html",_,_,Socket,_) ->
 handle_uri("HEAD",_,_,_,_,_) ->
     "HTTP/1.1 200 ok\r\n" ++
 	"Content-Length:0\r\n\r\n";
+handle_uri("PUT","/v1/kv/foo",_,_,_,_) ->
+    "HTTP/1.1 200 OK\r\n" ++
+        "Date: Tue, 20 Feb 2018 14:39:08 GMT\r\n" ++
+        "Content-Length: 5\r\n\r\n" ++
+        "Content-Type: application/json\r\n\r\n" ++
+        "true\n";
+handle_uri("GET","/v1/kv/foo",_,_,_,_) ->
+    "HTTP/1.1 200 OK\r\n" ++
+        "Date: Tue, 20 Feb 2018 14:39:08 GMT\r\n" ++
+        "Content-Length: 24\r\n" ++
+        "Content-Type: application/json\r\n\r\n" ++
+        "[{\"Value\": \"aGVsbG8=\"}]\n";
+
 handle_uri(_,_,_,_,_,DefaultResponse) ->
     DefaultResponse.