[snmp] Add log_to_io function for both manager and agent

Add a log_to_io Audit Trail Log converter function for
both the manager (snmpm) and agent (snmpa).
Also fixed the converter functions in the logger module,
snmp_log, which previously sometimes did not work
properly (re-open an already open log with different
properties).

OTP-9940

8 files changed, 190 insertions, 45 deletions

diff --git a/lib/snmp/doc/src/notes.xml b/lib/snmp/doc/src/notes.xml
index 82c7deb467..e7fb4e2287 100644
--- a/lib/snmp/doc/src/notes.xml
+++ b/lib/snmp/doc/src/notes.xml
@@ -46,6 +46,15 @@
 
       <list type="bulleted">
         <item>
+          <p>Added the log_to_io audit-trail-log converter function to the 
+	  api modules of both the 
+	  <seealso marker="snmpm#log_to_io">manager</seealso> 
+	  and 
+	  <seealso marker="snmpa#log_to_io">agent</seealso>. </p>
+          <p>Own Id: OTP-9940</p>
+        </item>
+
+        <item>
           <p>[manager] Introduced a new transport module, 
 	  <c>snmpm_net_if_mt</c>, 
 	  which handles all incomming and outgoing 
diff --git a/lib/snmp/doc/src/snmp.xml b/lib/snmp/doc/src/snmp.xml
index af0833f005..3e6610891f 100644
--- a/lib/snmp/doc/src/snmp.xml
+++ b/lib/snmp/doc/src/snmp.xml
@@ -1,10 +1,10 @@
-<?xml version="1.0" encoding="latin1" ?>
+<?xml version="1.0" encoding="iso-8859-1" ?>
 <!DOCTYPE erlref SYSTEM "erlref.dtd">
 
 <erlref>
   <header>
     <copyright>
-      <year>1996</year><year>2009</year>
+      <year>1996</year><year>2012</year>
       <holder>Ericsson AB. All Rights Reserved.</holder>
     </copyright>
     <legalnotice>
@@ -391,6 +391,30 @@
           version of the protocol data unit. There is a new line
           between <c>Vsn</c> and <c>PDU</c>.</p>
 
+        <marker id="log_to_io"></marker>
+      </desc>
+    </func>
+
+    <func>
+      <name>log_to_io(LogDir, Mibs, LogName, LogFile) ->  ok | {error, Reason}</name>
+      <name>log_to_io(LogDir, Mibs, LogName, LogFile, Start) ->  ok | {error, Reason}</name>
+      <name>log_to_io(LogDir, Mibs, LogName, LogFile, Start, Stop) -> ok | {error, Reason}</name>
+      <fsummary>Convert an Audit Trail Log to text format</fsummary>
+      <type>
+        <v>LogDir = string()</v>
+        <v>Mibs = [MibName]</v>
+        <v>MibName = string()</v>
+        <v>LogName = string()</v>
+        <v>LogFile = string()</v>
+        <v>Start = Stop = null | datetime() | {local_time,datetime()} |  {universal_time,datetime()} </v>
+        <v>Reason = term()</v>
+      </type>
+      <desc>
+        <p>Converts an Audit Trail Log to a readable format and 
+	prints it on stdio. See 
+	<seealso marker="snmp#log_to_txt">log_to_txt</seealso> 
+	above for more info.</p>
+
         <marker id="change_log_size"></marker>
       </desc>
     </func>
diff --git a/lib/snmp/doc/src/snmpa.xml b/lib/snmp/doc/src/snmpa.xml
index 27d89ea4e3..9984a10fea 100644
--- a/lib/snmp/doc/src/snmpa.xml
+++ b/lib/snmp/doc/src/snmpa.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>
@@ -495,6 +495,7 @@ notification_delivery_info() = #snmpa_notification_delivery_info{}
     </func>
 
     <func>
+      <name>log_to_txt(LogDir)</name>
       <name>log_to_txt(LogDir, Mibs)</name>
       <name>log_to_txt(LogDir, Mibs, OutFile) -> ok | {error, Reason}</name>
       <name>log_to_txt(LogDir, Mibs, OutFile, LogName) ->  ok | {error, Reason}</name>
@@ -522,6 +523,37 @@ notification_delivery_info() = #snmpa_notification_delivery_info{}
           See <seealso marker="snmp#log_to_txt">snmp:log_to_txt</seealso> 
           for more info.</p>
 
+        <marker id="log_to_io"></marker>
+      </desc>
+    </func>
+
+    <func>
+      <name>log_to_io(LogDir) ->  ok | {error, Reason}</name>
+      <name>log_to_io(LogDir, Mibs) ->  ok | {error, Reason}</name>
+      <name>log_to_io(LogDir, Mibs, LogName) ->  ok | {error, Reason}</name>
+      <name>log_to_io(LogDir, Mibs, LogName, LogFile) -> ok | {error, Reason}</name>
+      <name>log_to_io(LogDir, Mibs, LogName, LogFile, Start) -> ok | {error, Reason}</name>
+      <name>log_to_io(LogDir, Mibs, LogName, LogFile, Start, Stop) -> ok | {error, Reason}</name>
+      <fsummary>Convert an Audit Trail Log to text format</fsummary>
+      <type>
+        <v>LogDir = string()</v>
+        <v>Mibs = [MibName]</v>
+        <v>MibName = string()</v>
+        <v>LogName = string()</v>
+        <v>LogFile = string()</v>
+        <v>Start = Stop = null | datetime() | {local_time,datetime()} |  {universal_time,datetime()} </v>
+        <v>Reason = disk_log_open_error() | file_open_error() | term()</v>
+        <v>disk_log_open_error() = {LogName, term()}</v>
+        <v>file_open_error() = {OutFile, term()}</v>
+      </type>
+      <desc>
+        <p>Converts an Audit Trail Log to a readable format and 
+	prints it on stdio. 
+	<c>LogName</c> defaults to "snmpa_log". 
+	<c>LogFile</c> defaults to "snmpa.log". 
+	See <seealso marker="snmp#log_to_io">snmp:log_to_io</seealso> 
+	for more info.</p>
+
         <marker id="change_log_size"></marker>
       </desc>
     </func>
diff --git a/lib/snmp/doc/src/snmpm.xml b/lib/snmp/doc/src/snmpm.xml
index c36a1b2a24..9bbb6cdbdb 100644
--- a/lib/snmp/doc/src/snmpm.xml
+++ b/lib/snmp/doc/src/snmpm.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>
@@ -1237,6 +1237,38 @@ priv_key = [integer()]   (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1
           See <seealso marker="snmp#log_to_txt">snmp:log_to_txt</seealso> 
           for more info.</p>
 
+        <marker id="log_to_io"></marker>
+      </desc>
+    </func>
+
+    <func>
+      <name>log_to_io(LogDir) -> ok | {error, Reason}</name>
+      <name>log_to_io(LogDir, Mibs) -> ok | {error, Reason}</name>
+      <name>log_to_io(LogDir, Mibs) -> ok | {error, Reason}</name>
+      <name>log_to_io(LogDir, Mibs, LogName) ->  ok | {error, Reason}</name>
+      <name>log_to_io(LogDir, Mibs, LogName, LogFile) ->  ok | {error, Reason}</name>
+      <name>log_to_io(LogDir, Mibs, LogName, LogFile, Start) ->  ok | {error, Reason}</name>
+      <name>log_to_io(LogDir, Mibs, LogName, LogFile, Start, Stop)  -> ok | {error, Reason}</name>
+      <fsummary>Convert an Audit Trail Log to text format</fsummary>
+      <type>
+        <v>LogDir = string()</v>
+        <v>Mibs = [MibName]</v>
+        <v>MibName = string()</v>
+        <v>LogName = string()</v>
+        <v>LogFile = string()</v>
+        <v>Start = Stop = null | datetime() | {local_time,datetime()} |  {universal_time,datetime()} </v>
+        <v>Reason = disk_log_open_error() | file_open_error() | term()</v>
+        <v>disk_log_open_error() = {LogName, term()}</v>
+        <v>file_open_error() = {OutFile, term()}</v>
+      </type>
+      <desc>
+        <p>Converts an Audit Trail Log to a readable format and 
+	prints it on stdio. 
+	<c>LogName</c> defaults to "snmpm_log". 
+	<c>LogFile</c> defaults to "snmpm.log". 
+	See <seealso marker="snmp#log_to_io">snmp:log_to_io</seealso> 
+	for more info.</p>
+
         <marker id="change_log_size"></marker>
       </desc>
     </func>
diff --git a/lib/snmp/src/agent/snmpa.erl b/lib/snmp/src/agent/snmpa.erl
index 50b169e4e7..584c7a22fb 100644
--- a/lib/snmp/src/agent/snmpa.erl
+++ b/lib/snmp/src/agent/snmpa.erl
@@ -1,7 +1,7 @@
 %%
 %% %CopyrightBegin%
 %%
-%% Copyright Ericsson AB 2004-2011. All Rights Reserved.
+%% Copyright Ericsson AB 2004-2012. All Rights Reserved.
 %%
 %% The contents of this file are subject to the Erlang Public License,
 %% Version 1.1, (the "License"); you may not use this file except in
@@ -83,8 +83,11 @@
 -export([add_agent_caps/2, del_agent_caps/1, get_agent_caps/0]).
 
 %% Audit Trail Log functions
--export([log_to_txt/2, log_to_txt/3, log_to_txt/4, 
+-export([log_to_txt/1, 
+	 log_to_txt/2, log_to_txt/3, log_to_txt/4, 
 	 log_to_txt/5, log_to_txt/6, log_to_txt/7, 
+	 log_to_io/1,  log_to_io/2,  log_to_io/3, 
+	 log_to_io/4,  log_to_io/5,  log_to_io/6, 
 	 log_info/0, 
 	 change_log_size/1,
 	 get_log_type/0,    get_log_type/1, 
@@ -780,6 +783,8 @@ get_agent_caps() ->
 %%% Audit Trail Log functions 
 %%%-----------------------------------------------------------------
 
+log_to_txt(LogDir) -> 
+    log_to_txt(LogDir, []).
 log_to_txt(LogDir, Mibs) -> 
     OutFile = "snmpa_log.txt",       
     LogName = ?audit_trail_log_name, 
@@ -800,6 +805,23 @@ log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Start, Stop) ->
     snmp:log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Start, Stop).
 
 
+log_to_io(LogDir) -> 
+    log_to_io(LogDir, []).
+log_to_io(LogDir, Mibs) -> 
+    LogName = ?audit_trail_log_name, 
+    LogFile = ?audit_trail_log_file, 
+    snmp:log_to_io(LogDir, Mibs, LogName, LogFile).
+log_to_io(LogDir, Mibs, LogName) -> 
+    LogFile = ?audit_trail_log_file, 
+    snmp:log_to_io(LogDir, Mibs, LogName, LogFile).
+log_to_io(LogDir, Mibs, LogName, LogFile) -> 
+    snmp:log_to_io(LogDir, Mibs, LogName, LogFile).
+log_to_io(LogDir, Mibs, LogName, LogFile, Start) -> 
+    snmp:log_to_io(LogDir, Mibs, LogName, LogFile, Start).
+log_to_io(LogDir, Mibs, LogName, LogFile, Start, Stop) -> 
+    snmp:log_to_io(LogDir, Mibs, LogName, LogFile, Start, Stop).
+
+
 log_info() ->
     LogName = ?audit_trail_log_name, 
     snmp_log:info(LogName).
diff --git a/lib/snmp/src/app/snmp.erl b/lib/snmp/src/app/snmp.erl
index 3e0f05e604..fc03757e3f 100644
--- a/lib/snmp/src/app/snmp.erl
+++ b/lib/snmp/src/app/snmp.erl
@@ -50,6 +50,7 @@
 	 read_mib/1, 
  
 	 log_to_txt/5, log_to_txt/6, log_to_txt/7,
+	 log_to_io/4,  log_to_io/5,  log_to_io/6,
 	 change_log_size/2,
 
 	 octet_string_to_bits/1, bits_to_octet_string/1, 
@@ -843,6 +844,12 @@ log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Start) ->
 log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Start, Stop) -> 
     snmp_log:log_to_txt(LogName, LogFile, LogDir, Mibs, OutFile, Start, Stop).
 
+log_to_io(LogDir, Mibs, LogName, LogFile) -> 
+    snmp_log:log_to_io(LogName, LogFile, LogDir, Mibs).
+log_to_io(LogDir, Mibs, LogName, LogFile, Start) -> 
+    snmp_log:log_to_io(LogName, LogFile, LogDir, Mibs, Start).
+log_to_io(LogDir, Mibs, LogName, LogFile, Start, Stop) -> 
+    snmp_log:log_to_io(LogName, LogFile, LogDir, Mibs, Start, Stop).
 
 change_log_size(LogName, NewSize) -> 
     snmp_log:change_size(LogName, NewSize).
diff --git a/lib/snmp/src/manager/snmpm.erl b/lib/snmp/src/manager/snmpm.erl
index 6d2ac8d747..89eaee9f80 100644
--- a/lib/snmp/src/manager/snmpm.erl
+++ b/lib/snmp/src/manager/snmpm.erl
@@ -1,7 +1,7 @@
 %% 
 %% %CopyrightBegin%
 %% 
-%% Copyright Ericsson AB 2004-2011. All Rights Reserved.
+%% Copyright Ericsson AB 2004-2012. All Rights Reserved.
 %% 
 %% The contents of this file are subject to the Erlang Public License,
 %% Version 1.1, (the "License"); you may not use this file except in
@@ -75,8 +75,11 @@
 
 	 %% 
 	 %% Logging
+	 log_to_txt/1, 
 	 log_to_txt/2, log_to_txt/3, log_to_txt/4,
 	 log_to_txt/5, log_to_txt/6, log_to_txt/7, 
+	 log_to_io/1,  log_to_io/2,  log_to_io/3,
+	 log_to_io/4,  log_to_io/5,  log_to_io/6, 
 	 change_log_size/1,
 	 get_log_type/0,
 	 set_log_type/1,
@@ -1371,6 +1374,9 @@ cancel_async_request(UserId, ReqId) ->
 %%%-----------------------------------------------------------------
 %%% Audit Trail Log functions (for backward compatibility)
 %%%-----------------------------------------------------------------
+
+log_to_txt(LogDir) ->
+    log_to_txt(LogDir, []). 
 log_to_txt(LogDir, Mibs) ->
     OutFile = "snmpm_log.txt",       
     LogName = ?audit_trail_log_name, 
@@ -1391,6 +1397,23 @@ log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Start, Stop) ->
     snmp:log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Start, Stop).
 
 
+log_to_io(LogDir) ->
+    log_to_io(LogDir, []).
+log_to_io(LogDir, Mibs) ->
+    LogName = ?audit_trail_log_name, 
+    LogFile = ?audit_trail_log_file, 
+    snmp:log_to_io(LogDir, Mibs, LogName, LogFile).
+log_to_io(LogDir, Mibs, LogName) ->
+    LogFile = ?audit_trail_log_file, 
+    snmp:log_to_io(LogDir, Mibs, LogName, LogFile).
+log_to_io(LogDir, Mibs, LogName, LogFile) -> 
+    snmp:log_to_io(LogDir, Mibs, LogName, LogFile).
+log_to_io(LogDir, Mibs, LogName, LogFile, Start) -> 
+    snmp:log_to_io(LogDir, Mibs, LogName, LogFile, Start).
+log_to_io(LogDir, Mibs, LogName, LogFile, Start, Stop) -> 
+    snmp:log_to_io(LogDir, Mibs, LogFile, Start, Stop).
+    
+
 change_log_size(NewSize) ->
     LogName = ?audit_trail_log_name, 
     snmp:change_log_size(LogName, NewSize).
diff --git a/lib/snmp/src/misc/snmp_log.erl b/lib/snmp/src/misc/snmp_log.erl
index 7f7030c9bf..a8c5df0b64 100644
--- a/lib/snmp/src/misc/snmp_log.erl
+++ b/lib/snmp/src/misc/snmp_log.erl
@@ -412,6 +412,14 @@ log_to_io(Log, FileName, Dir, Mibs, Start) ->
 
 log_to_io(Log, FileName, Dir, Mibs, Start, Stop) 
   when is_list(Mibs) ->
+    ?vtrace("log_to_io -> entry with"
+	    "~n   Log:      ~p"
+	    "~n   FileName: ~p"
+	    "~n   Dir:      ~p"
+	    "~n   Mibs:     ~p"
+	    "~n   Start:    ~p"
+	    "~n   Stop:     ~p", 
+	    [Log, FileName, Dir, Mibs, Start, Stop]),
     File = filename:join(Dir, FileName),
     Converter = fun(L) ->
 			do_log_to_io(L, Mibs, Start, Stop)
@@ -419,28 +427,10 @@ log_to_io(Log, FileName, Dir, Mibs, Start, Stop)
     log_convert(Log, File, Converter).
 
 
-%% -- log_to_plain ---
-
-%% log_to_plain(Log, FileName, Dir) ->
-%%     log_to_plain(Log, FileName, Dir, null, null).
-
-%% log_to_plain(Log, FileName, Dir, Start) ->
-%%     log_to_plain(Log, FileName, Dir, Start, null).
-
-%% log_to_plain(Log, FileName, Dir, Start, Stop) 
-%%   when is_list(Mibs) ->
-%%     File = filename:join(Dir, FileName),
-%%     Converter = fun(L) ->
-%% 			do_log_to_plain(L, Start, Stop)
-%% 		end,
-%%     log_convert(Log, File, Converter).
-
-
 %% --------------------------------------------------------------------
 %% Internal functions
 %% --------------------------------------------------------------------
 
-
 %% -- log_convert ---
 
 log_convert(#snmp_log{id = Log}, File, Converter) ->
@@ -449,6 +439,26 @@ log_convert(Log, File, Converter) ->
     do_log_convert(Log, File, Converter).
 
 do_log_convert(Log, File, Converter) ->
+    %% ?vtrace("do_log_converter -> entry with"
+    %% 	    "~n   Log:  ~p"
+    %% 	    "~n   File: ~p"
+    %% 	    "~n   disk_log:info(Log): ~p", [Log, File, disk_log:info(Log)]),
+    {Pid, Ref} = 
+	erlang:spawn_monitor(
+	  fun() ->
+		  Result = do_log_convert2(Log, File, Converter),
+		  exit(Result)
+	  end),
+    receive 
+	{'DOWN', Ref, process, Pid, Result} ->
+	    %% ?vtrace("do_log_converter -> received result"
+	    %% 	    "~n   Result: ~p"
+	    %% 	    "~n   disk_log:info(Log): ~p", 
+	    %% 	    [Result, disk_log:info(Log)]),
+	    Result
+    end.
+    
+do_log_convert2(Log, File, Converter) ->
     %% First check if the caller process has already opened the
     %% log, because if we close an already open log we will cause
     %% a runtime error.
@@ -457,29 +467,18 @@ do_log_convert(Log, File, Converter) ->
 	    Converter(Log);
 	false ->
 	    %% Not yet member of the ruling party, apply for membership...
-	    %% If a log is opened as read_write it is not possible to 
-	    %% open it as read_only. So, to get around this we open 
-	    %% it under a different name...
-	    Log2 = convert_name(Log),
-	    case log_open(Log2, File) of
+	    case log_open(Log, File) of
 		{ok, _} ->
-		    Res = Converter(Log2),
-		    disk_log:close(Log2),
+		    Res = Converter(Log),
+		    disk_log:close(Log),
 		    Res;
 		{error, {name_already_open, _}} ->
-                    Converter(Log2);
+                    Converter(Log);
                 {error, Reason} ->
                     {error, {Log, Reason}}
 	    end
     end.
 
-convert_name(Name) when is_list(Name) ->
-    Name ++ "_tmp";
-convert_name(Name) when is_atom(Name) ->
-    list_to_atom(atom_to_list(Name) ++ "_tmp");
-convert_name(Name) ->
-    lists:flatten(io_lib:format("~w_tmp", [Name])).
-
 
 %% -- do_log_to_text ---
 
@@ -882,11 +881,8 @@ do_std_log_open(Name, File, Size, Repair, Notify) ->
 
 
 log_open(Name, File) ->
-    Opts = [{name,   Name}, 
-	    {file,   File}, 
-	    {type,   ?LOG_TYPE},
-	    {format, ?LOG_FORMAT},	    
-	    {mode,   read_only}],
+    Opts = [{name, Name}, 
+	    {file, File}],
     case disk_log:open(Opts) of
 	{error, {badarg, size}} ->
 	    {error, no_such_log};