[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

4 files changed, 101 insertions, 4 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>