[inets/httpc] Add function to retreive current options

Add function to retreive current options, httpc:get_options/1,2.

OTP-9979

6 files changed, 175 insertions, 20 deletions

diff --git a/lib/inets/doc/src/httpc.xml b/lib/inets/doc/src/httpc.xml
index 48a2089605..70c845bade 100644
--- a/lib/inets/doc/src/httpc.xml
+++ b/lib/inets/doc/src/httpc.xml
@@ -4,7 +4,7 @@
 <erlref>
   <header>
     <copyright>
-      <year>2004</year><year>2011</year>
+      <year>2004</year><year>2012</year>
       <holder>Ericsson AB. All Rights Reserved.</holder>
     </copyright>
     <legalnotice>
@@ -541,6 +541,35 @@ apply(Module, Function, [ReplyInfo | Args])
             default value of the <c>max_sessions</c> option. </p>
         </note>
 
+        <marker id="get_options"></marker>
+      </desc>
+    </func>
+    
+    <func>
+      <name>get_options(OptionItems) -> {ok, Values} | {error, Reason}</name>
+      <name>get_options(OptionItems, Profile) -> {ok, Values} | {error, Reason}</name>
+      <fsummary>Gets the currently used options.</fsummary>
+      <type>
+        <v>OptionItems = all | [option_item()]</v>
+	<v>option_item() = proxy | 
+                           max_sessions | 
+			   keep_alive_timeout | 
+	                   max_keep_alive_length | 
+			   pipeline_timeout | 
+			   max_pipeline_length | 
+			   cookies | 
+			   ipfamily | 
+			   ip | 
+			   port | 
+			   socket_opts | 
+	                   verbose</v>
+	<v>Profile = profile() | pid() (when started <c>stand_alone</c>)</v>
+        <v>Values = [{option_item(), term()}]</v>
+        <v>Reason = term() </v>
+      </type>
+      <desc>
+        <p>Retrieves the options currently used by the client.</p>
+
         <marker id="stream_next"></marker>
       </desc>
     </func>
diff --git a/lib/inets/doc/src/notes.xml b/lib/inets/doc/src/notes.xml
index a14eb15de3..f2cd03b6a8 100644
--- a/lib/inets/doc/src/notes.xml
+++ b/lib/inets/doc/src/notes.xml
@@ -64,6 +64,12 @@
 	  <p>Own Id: OTP-9960</p>
         </item>
 
+        <item>
+          <p>[httpc] Add function for retrieving current options, 
+	  <seealso marker="httpc#get_options">get_options/1,2</seealso>. </p>
+	  <p>Own Id: OTP-9979</p>
+        </item>
+
       </list>
 
     </section>
diff --git a/lib/inets/src/http_client/httpc.erl b/lib/inets/src/http_client/httpc.erl
index ae87ceed93..5ed2d98ba6 100644
--- a/lib/inets/src/http_client/httpc.erl
+++ b/lib/inets/src/http_client/httpc.erl
@@ -31,8 +31,10 @@
 -export([
 	 request/1, request/2, request/4, request/5,
 	 cancel_request/1, cancel_request/2,
-	 set_option/2, set_option/3,
+	 set_option/2,  set_option/3,
 	 set_options/1, set_options/2,
+	 get_option/1,  get_option/2,
+	 get_options/1, get_options/2,
 	 store_cookies/2, store_cookies/3, 
 	 cookie_header/1, cookie_header/2, cookie_header/3, 
 	 which_cookies/0, which_cookies/1, 
@@ -230,7 +232,7 @@ cancel_request(RequestId, Profile)
 set_options(Options) ->
     set_options(Options, default_profile()).
 set_options(Options, Profile) when is_atom(Profile) orelse is_pid(Profile) ->
-    ?hcrt("set cookies", [{options, Options}, {profile, Profile}]),
+    ?hcrt("set options", [{options, Options}, {profile, Profile}]),
     case validate_options(Options) of
 	{ok, Opts} ->
 	    try 
@@ -253,6 +255,58 @@ set_option(Key, Value, Profile) ->
 
 
 %%--------------------------------------------------------------------------
+%% get_options(OptionItems) -> {ok, Values} | {error, Reason}
+%% get_options(OptionItems, Profile) -> {ok, Values} | {error, Reason}
+%%   OptionItems   - all | [option_item()]
+%%   option_item() - proxy | pipeline_timeout | max_pipeline_length | 
+%%                   keep_alive_timeout | max_keep_alive_length | 
+%%                   max_sessions | verbose | 
+%%                   cookies | ipfamily | ip | port | socket_opts
+%%   Profile       - atom()
+%%   Values - [{option_item(), term()}]
+%%   Reason - term()
+%% Description: Retrieves the current options. 
+%%-------------------------------------------------------------------------
+get_options() ->
+    record_info(fields, options).
+
+get_options(Options) ->
+    get_options(Options, default_profile()).
+
+get_options(all = _Options, Profile) ->
+    get_options(get_options(), Profile);
+get_options(Options, Profile) 
+  when (is_list(Options) andalso 
+	(is_atom(Profile) orelse is_pid(Profile))) ->
+    ?hcrt("get options", [{options, Options}, {profile, Profile}]),
+    case Options -- get_options() of
+	[] ->
+	    try 
+		begin
+		    {ok, httpc_manager:get_options(Options, 
+						   profile_name(Profile))}
+		end
+	    catch
+		exit:{noproc, _} ->
+		    {error, inets_not_started}
+	    end;
+	InvalidGetOptions ->
+	    {error, {invalid_options, InvalidGetOptions}}
+    end.
+
+get_option(Key) ->
+    get_option(Key, default_profile()).
+
+get_option(Key, Profile) ->
+    case get_options([Key], Profile) of
+	{ok, [{Key, Value}]} ->
+	    {ok, Value};
+	Error ->
+	    Error
+    end.
+
+
+%%--------------------------------------------------------------------------
 %% store_cookies(SetCookieHeaders, Url [, Profile]) -> ok | {error, reason} 
 %%   
 %%                                 
@@ -347,7 +401,7 @@ which_cookies(Profile) ->
 %% info() -> list()
 %% info(Profile) -> list()
 %%               
-%% Description: Debug function, retreive info about the profile
+%% Description: Debug function, retrieve info about the profile
 %%-------------------------------------------------------------------------
 info() ->
     info(default_profile()).
diff --git a/lib/inets/src/http_client/httpc_manager.erl b/lib/inets/src/http_client/httpc_manager.erl
index 453081da21..33b5dfe046 100644
--- a/lib/inets/src/http_client/httpc_manager.erl
+++ b/lib/inets/src/http_client/httpc_manager.erl
@@ -37,6 +37,7 @@
 	 update_session/4, 
 	 delete_session/2, 
 	 set_options/2, 
+	 get_options/2, 
 	 store_cookies/3,
 	 which_cookies/1, which_cookies/2, which_cookies/3, 
 	 reset_cookies/1, 
@@ -250,6 +251,21 @@ set_options(Options, ProfileName) ->
 
 
 %%--------------------------------------------------------------------
+%% Function: get_options(OptionItems, ProfileName) -> Values
+%%
+%%	OptionItems = [OptionItem]
+%%	OptionItem = Any or all fields of the current #options{} record 
+%%      Values = [{OptionItem, Value}]
+%%      Value = term()
+%% 
+%% Description: Gets the specified options used by the client.
+%%--------------------------------------------------------------------
+
+get_options(Options, ProfileName) ->
+    call(ProfileName, {get_options, Options}).
+
+
+%%--------------------------------------------------------------------
 %% Function: store_cookies(Cookies, Address, ProfileName) -> ok
 %%
 %%	Cookies = [Cookie]
@@ -439,6 +455,12 @@ handle_call({which_cookies, Url, Options}, _,
 	    {reply, ERROR, State}
     end;
 
+handle_call({get_options, OptionItems}, _, #state{options = Options} = State) ->
+    ?hcrv("get options", [{option_items, OptionItems}]),
+    Reply = [{OptionItem, get_option(OptionItem, Options)} || OptionItem <- 
+								  OptionItems], 
+    {reply, Reply, State};
+
 handle_call(info, _, State) ->
     ?hcrv("info", []),
     Info = get_manager_info(State), 
@@ -883,6 +905,31 @@ cast(ProfileName, Msg) ->
    gen_server:cast(ProfileName, Msg).
 
 
+get_option(proxy, #options{proxy = Proxy}) ->
+    Proxy;
+get_option(pipeline_timeout, #options{pipeline_timeout = Timeout}) ->
+    Timeout;
+get_option(max_pipeline_length, #options{max_pipeline_length = Length}) ->
+    Length;
+get_option(keep_alive_timeout, #options{keep_alive_timeout = Timeout}) ->
+    Timeout;
+get_option(max_keep_alive_length, #options{max_keep_alive_length = Length}) ->
+    Length;
+get_option(max_sessions, #options{max_sessions = MaxSessions}) ->
+    MaxSessions;
+get_option(cookies, #options{cookies = Cookies}) ->
+    Cookies;
+get_option(verbose, #options{verbose = Verbose}) ->
+    Verbose;
+get_option(ipfamily, #options{ipfamily = IpFamily}) ->
+    IpFamily;
+get_option(ip, #options{ip = IP}) ->
+    IP;
+get_option(port, #options{port = Port}) ->
+    Port;
+get_option(socket_opts, #options{socket_opts = SocketOpts}) ->
+    SocketOpts.
+
 get_proxy(Opts, #options{proxy = Default}) ->
     proplists:get_value(proxy, Opts, Default).
 
diff --git a/lib/inets/src/inets_app/inets.appup.src b/lib/inets/src/inets_app/inets.appup.src
index d36fcf87d4..9dfa16b405 100644
--- a/lib/inets/src/inets_app/inets.appup.src
+++ b/lib/inets/src/inets_app/inets.appup.src
@@ -20,6 +20,9 @@
  [
   {"5.8.1", 
    [
+    {load_module, httpc,         soft_purge, soft_purge, [httpc_manager]}, 
+    {update,      httpc_manager, soft, soft_purge, soft_purge, []},
+
     {load_module, inets_app, soft_purge, soft_purge, [inets_sup]}, 
     {update,      inets_sup,     soft, soft_purge, soft_purge, []},
 
@@ -35,6 +38,8 @@
   }, 
   {"5.8",
    [
+    {load_module, httpc, soft_purge, soft_purge, [httpc_manager]}, 
+
     {load_module, inets_app, soft_purge, soft_purge, [inets_sup]}, 
     {update,      inets_sup,     soft, soft_purge, soft_purge, []},
 
@@ -63,6 +68,9 @@
  [
   {"5.8.1",
    [
+    {load_module, httpc,         soft_purge, soft_purge, [httpc_manager]}, 
+    {update,      httpc_manager, soft, soft_purge, soft_purge, []},
+
     {load_module, inets_app, soft_purge, soft_purge, [inets_sup]}, 
     {update,      inets_sup,     soft, soft_purge, soft_purge, []},
 
@@ -78,6 +86,8 @@
   }, 
   {"5.8",
    [
+    {load_module, httpc,         soft_purge, soft_purge, [httpc_manager]}, 
+
     {load_module, inets_app, soft_purge, soft_purge, [inets_sup]}, 
     {update,      inets_sup,     soft, soft_purge, soft_purge, []},
 
diff --git a/lib/inets/test/httpc_SUITE.erl b/lib/inets/test/httpc_SUITE.erl
index a18d079426..61bb5214f3 100644
--- a/lib/inets/test/httpc_SUITE.erl
+++ b/lib/inets/test/httpc_SUITE.erl
@@ -275,20 +275,6 @@ init_per_testcase(Case, Timeout, Config) ->
     %% inets:enable_trace(max, io, httpc),
     %% inets:enable_trace(max, io, all),
 
-    %% <IPv6>
-    % Set default ipfamily to the same as the main server has by default
-    %% This makes the client try w/ ipv6 before falling back to ipv4,
-    %% as that is what the server is configured to do.
-    %% Note that this is required for the tests to run on *BSD w/ ipv6 enabled
-    %% as well as on Windows. The Linux behaviour of allowing ipv4 connects
-    %% to ipv6 sockets is not required or even encouraged.
-
-    httpc:set_options([{ipfamily, inet6fb4}]),
-
-    %% Note that the IPv6 trest case *must* use inet6, 
-    %% so this value will be overwritten (see "ipv6_" below).
-    %% </IPv6>
-
     NewConfig = 
 	case atom_to_list(Case) of
 	    [$s, $s, $l | _] ->
@@ -371,7 +357,8 @@ init_per_testcase(Case, Timeout, Config) ->
 			    inets:start(httpc, 
 					[{profile,  Profile}, 
 					 {data_dir, PrivDir}], stand_alone),
-			httpc:set_options([{ipfamily, inet6}], ProfilePid), 
+			ok = httpc:set_options([{ipfamily, inet6}], 
+					       ProfilePid), 
 			tsp("httpc profile pid: ~p", [ProfilePid]),
 			[{watchdog, Dog}, {profile, ProfilePid}| TmpConfig]
 		catch 
@@ -410,9 +397,31 @@ init_per_testcase(Case, Timeout, Config) ->
 		[{watchdog, Dog}, {local_server, Server} | TmpConfig2]
 	end,
     
+    %% <IPv6>
+    %% Set default ipfamily to the same as the main server has by default
+    %% This makes the client try w/ ipv6 before falling back to ipv4,
+    %% as that is what the server is configured to do.
+    %% Note that this is required for the tests to run on *BSD w/ ipv6 enabled
+    %% as well as on Windows. The Linux behaviour of allowing ipv4 connects
+    %% to ipv6 sockets is not required or even encouraged.
+
+    tsp("init_per_testcase -> Options before ipfamily set: ~n~p", 
+	[httpc:get_options(all)]),
+    ok = httpc:set_options([{ipfamily, inet6fb4}]),
+    tsp("init_per_testcase -> Options after ipfamily set: ~n~p", 
+	[httpc:get_options(all)]),
+
+    %% Note that the IPv6 test case(s) *must* use inet6, 
+    %% so this value will be overwritten (see "ipv6_" below).
+    %% </IPv6>
+
     %% This will fail for the ipv6_ - cases (but that is ok)
     ProxyExceptions = ["localhost", ?IPV6_LOCAL_HOST], 
-    httpc:set_options([{proxy, {{?PROXY, ?PROXY_PORT}, ProxyExceptions}}]),
+    tsp("init_per_testcase -> Options before proxy set: ~n~p", 
+	[httpc:get_options(all)]),
+    ok = httpc:set_options([{proxy, {{?PROXY, ?PROXY_PORT}, ProxyExceptions}}]),
+    tsp("init_per_testcase -> Options after proxy set: ~n~p", 
+	[httpc:get_options(all)]),
     inets:enable_trace(max, io, httpc),
     %% inets:enable_trace(max, io, all),
     %% snmp:set_trace([gen_tcp]),