path: root/lib/snmp/src/misc/snmp_log.erl

%% 
%% %CopyrightBegin%
%%
%% Copyright Ericsson AB 1997-2019. 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.
%% You may obtain a copy of the License at
%%
%%     http://www.apache.org/licenses/LICENSE-2.0
%%
%% Unless required by applicable law or agreed to in writing, software
%% distributed under the License is distributed on an "AS IS" BASIS,
%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
%% See the License for the specific language governing permissions and
%% limitations under the License.
%%
%% %CopyrightEnd%
%% 

-module(snmp_log).


-export([
	 create/4, create/5, create/6, open/1, open/2, 
	 change_size/2, close/1, sync/1, info/1, 
	 log/3, log/4,
	 log_to_txt/6, log_to_txt/7, log_to_txt/8, 
	 log_to_io/5,  log_to_io/6,  log_to_io/7
	]).
-export([
	 upgrade/1, upgrade/2, 
	 downgrade/1
	]).
-export([
	 validate/1, validate/2
	]).
%% <BACKWARD-COMPAT>
-export([
	 log_to_txt/5, 
	 log_to_io/4 
	]).
%% </BACKWARD-COMPAT>

-export_type([
	      log/0, 
	      log_time/0
	     ]).

-define(SNMP_USE_V3, true).
-include("snmp_types.hrl").

-define(VMODULE,"LOG").
-include("snmp_verbosity.hrl").

-define(LOG_FORMAT,    internal).
-define(LOG_TYPE,      wrap).
-define(BLOCK_DEFAULT, true). 

-record(snmp_log, {id, seqno}).


%%-----------------------------------------------------------------
%% Types
%%-----------------------------------------------------------------

-opaque log() :: #snmp_log{}.
-type log_time() :: null | 
                    calendar:datetime() | 
                    {local_time,     calendar:datetime()} |
                    {universal_time, calendar:datetime()}.


%% --------------------------------------------------------------------
%% Exported functions
%% --------------------------------------------------------------------

upgrade(Log) when is_record(Log, snmp_log) ->
    Log;
upgrade(Log) ->
    upgrade(Log, disabled).

upgrade(Log, _SeqNoGen) when is_record(Log, snmp_log) ->
    Log;
upgrade(Log, {M, F, A} = SeqNoGen) 
  when (is_atom(M) andalso is_atom(F) andalso is_list(A)) ->
    #snmp_log{id = Log, seqno = SeqNoGen};
upgrade(Log, SeqNoGen) 
  when is_function(SeqNoGen, 0) ->
    #snmp_log{id = Log, seqno = SeqNoGen};
upgrade(Log, disabled = SeqNoGen) ->
    #snmp_log{id = Log, seqno = SeqNoGen}.

downgrade(#snmp_log{id = Log}) ->
    Log;
downgrade(Log) ->
    Log.


%% -- create ---

create(Name, File, Size, Repair) ->
    create(Name, File, disabled, Size, Repair, false).

create(Name, File, Size, Repair, Notify) 
  when (((Repair =:= true) orelse 
	 (Repair =:= false) orelse 
	 (Repair =:= truncate) orelse 
	 (Repair =:= snmp_repair)) andalso 
	((Notify =:= true) orelse
	 (Notify =:= false))) ->
    create(Name, File, disabled, Size, Repair, Notify);
create(Name, File, SeqNoGen, Size, Repair) ->
    create(Name, File, SeqNoGen, Size, Repair, false).

create(Name, File, SeqNoGen, Size, Repair, Notify) 
  when (((Repair =:= true) orelse 
	 (Repair =:= false) orelse 
	 (Repair =:= truncate) orelse 
	 (Repair =:= snmp_repair)) andalso 
	((Notify =:= true) orelse
	 (Notify =:= false))) ->
    ?vtrace("create -> entry with"
	    "~n   Name:     ~p"
	    "~n   File:     ~p"
	    "~n   SeqNoGen: ~p"
	    "~n   Size:     ~p"
	    "~n   Repair:   ~p"
	    "~n   Notify:   ~p", [Name, File, SeqNoGen, Size, Repair, Notify]),
    log_open(Name, File, SeqNoGen, Size, Repair, Notify);
create(Name, File, SeqNoGen, Size, Repair, Notify) ->
    {error, {bad_args, Name, File, SeqNoGen, Size, Repair, Notify}}.
    
    
%% -- open ---

%% Open an already existing ( = open ) log

open(Name) ->
    open(Name, #snmp_log{seqno = disabled}).
open(Name, #snmp_log{seqno = SeqNoGen} = _OldLog) ->
    %% We include mode in the opts just to be on the safe side
    case disk_log:open([{name, Name}, {mode, read_write}]) of
	{ok, Log} ->
	    %% SeqNo must be proprly initiated also
	    {ok, #snmp_log{id = Log, seqno = SeqNoGen}};
	{repaired, Log, _RecBytes, _BadBytes} ->
	    {ok, #snmp_log{id = Log, seqno = SeqNoGen}};
	ERROR ->
	    ERROR
    end.


%% -- close ---

close(#snmp_log{id = Log}) ->
    ?vtrace("close -> entry with"
	    "~n   Log: ~p", [Log]),
    do_close(Log);
close(Log) ->
    do_close(Log).

do_close(Log) ->
    disk_log:close(Log).


%% -- close ---

sync(#snmp_log{id = Log}) ->
    do_sync(Log);
sync(Log) ->
    do_sync(Log).

do_sync(Log) ->
    ?vtrace("sync -> entry with"
	    "~n   Log: ~p", [Log]),
    disk_log:sync(Log).


%% -- info ---

info(#snmp_log{id = Log}) ->
    do_info(Log);
info(Log) ->
    do_info(Log).

do_info(Log) ->
    case disk_log:info(Log) of
	Info when is_list(Info) ->
	    Items = [no_current_bytes, no_current_items, 
		     current_file, no_overflows],
	    info_filter(Items, Info, []);
	Else ->
	    Else
    end.
    
info_filter([], _Info, Acc) ->
    {ok, Acc};
info_filter([Item|Items], Info, Acc) ->
    case lists:keysearch(Item, 1, Info) of
	{value, New} ->
	    info_filter(Items, Info, [New|Acc]);
	false ->
	    info_filter(Items, Info, Acc)
    end.


%% -- validate --

%% This function is used to "validate" a log.
%% At present this means making sure all entries
%% are in the proper order, and if sequence numbering
%% is used that no entries are missing.
%% It is intended to be used for testing.

validate(Log) ->
    validate(Log, false).

validate(#snmp_log{id = Log}, SeqNoReq) ->
    validate(Log, SeqNoReq);
validate(Log, SeqNoReq) 
  when ((SeqNoReq =:= true) orelse (SeqNoReq =:= false)) ->
    Validator = 
	fun({Timestamp, SeqNo, _Packet, _Addr, _Port}, {PrevTS, PrevSN}) ->
		?vtrace("validating log entry when"
			"~n   Timestamp: ~p"
			"~n   SeqNo:     ~p"
			"~n   PrevTS:    ~p"
			"~n   PrevSN:    ~p", 
			[Timestamp, SeqNo, PrevTS, PrevSN]),
		validate_timestamp(PrevTS, Timestamp),
		validate_seqno(PrevSN, SeqNo),
		{Timestamp, SeqNo};

	   ({Timestamp, SeqNo, _Packet, _AddrStr}, {PrevTS, PrevSN})
	      when is_integer(SeqNo) ->
		?vtrace("validating log entry when"
			"~n   Timestamp: ~p"
			"~n   SeqNo:     ~p"
			"~n   PrevTS:    ~p"
			"~n   PrevSN:    ~p",
			[Timestamp, SeqNo, PrevTS, PrevSN]),
		validate_timestamp(PrevTS, Timestamp),
		validate_seqno(PrevSN, SeqNo),
		{Timestamp, SeqNo};

	   ({Timestamp, _Packet, _Addr, _Port}, {PrevTS, _PrevSN})
	      when SeqNoReq =:= true ->
		?vtrace("validating log entry when"
			"~n   Timestamp: ~p"
			"~n   PrevTS:    ~p", 
			[Timestamp, PrevTS]),
		throw({error, {missing_seqno, Timestamp}});

	   ({Timestamp, _Packet, _Addr, _Port}, {PrevTS, PrevSN}) -> 
		?vtrace("validating log entry when"
			"~n   Timestamp: ~p"
			"~n   PrevTS:    ~p", 
			[Timestamp, PrevTS]),
		validate_timestamp(PrevTS, Timestamp),
		{Timestamp, PrevSN};

	   (E, Acc) ->
		?vtrace("validating bad log entry when"
			"~n   E:   ~p"
			"~n   Acc: ~p", 
			[E, Acc]),
		throw({error, {bad_entry, E, Acc}})
	end,
    try
	begin
	    validate_loop(disk_log:chunk(Log, start), 
			  Log, Validator, first, first)
	end
    catch 
	throw:Error ->
	    Error
    end.
    
%% We shall check that TS2 >= TS1
validate_timestamp(first, _TS2) ->
    ok;
validate_timestamp({LT1, UT1} = TS1, {LT2, UT2} = TS2) ->
    LT1_Secs = calendar:datetime_to_gregorian_seconds(LT1),
    UT1_Secs = calendar:datetime_to_gregorian_seconds(UT1),
    LT2_Secs = calendar:datetime_to_gregorian_seconds(LT2),
    UT2_Secs = calendar:datetime_to_gregorian_seconds(UT2),
    case ((LT2_Secs >= LT1_Secs) andalso (UT2_Secs >= UT1_Secs)) of
	true ->
	    ok;
	false ->
	    throw({error, {invalid_timestamp, TS1, TS2}})
    end;
validate_timestamp(TS1, TS2) ->
    throw({error, {bad_timestamp, TS1, TS2}}).


%% The usual case when SN2 = SN1 + 1
validate_seqno(first, SN2) 
  when is_integer(SN2) >= 1 ->
    ok;

%% The usual case when SN2 = SN1 + 1
validate_seqno(SN1, SN2) 
  when is_integer(SN1) andalso is_integer(SN2) andalso 
       (SN2 =:= (SN1 + 1)) andalso (SN1 >= 1) ->
    ok;

%% The case when we have a wrap
validate_seqno(SN1, SN2) 
  when is_integer(SN1) andalso is_integer(SN2) andalso 
       (SN2 < SN1) andalso (SN2 >= 1) ->
    ok;

%% And everything else must be an error...
validate_seqno(SN1, SN2) -> 
    throw({error, {bad_seqno, SN1, SN2}}).

validate_loop(eof, _Log, _Validatior, _PrevTS, _PrevSN) ->
    ok;
validate_loop({error, _} = Error, _Log, _Validator, _PrevTS, _PrevSN) ->
    Error;
validate_loop({Cont, Terms}, Log, Validator, PrevTS, PrevSN) ->
    ?vtrace("validate_loop -> entry with"
	    "~n   Terms:  ~p"
	    "~n   PrevTS: ~p"
	    "~n   PrevSN: ~p", [Terms, PrevTS, PrevSN]),
    {NextTS, NextSN} = lists:foldl(Validator, {PrevTS, PrevSN}, Terms), 
    ?vtrace("validate_loop -> "
	    "~n   NextTS: ~p"
	    "~n   NextSN: ~p", [NextTS, NextSN]),
    validate_loop(disk_log:chunk(Log, Cont), Log, Validator, NextTS, NextSN);
validate_loop({Cont, Terms, BadBytes}, Log, Validator, PrevTS, PrevSN) ->
    ?vtrace("validate_loop -> entry with"
	    "~n   Terms:    ~p"
	    "~n   BadBytes: ~p"
	    "~n   PrevTS:   ~p"
	    "~n   PrevSN:   ~p", [Terms, BadBytes, PrevTS, PrevSN]),
    error_logger:error_msg("Skipping ~w bytes while validating ~p~n~n", 
			   [BadBytes, Log]),
    {NextTS, NextSN} = lists:foldl(Validator, {PrevTS, PrevSN}, Terms), 
    ?vtrace("validate_loop -> "
	    "~n   NextTS: ~p"
	    "~n   NextSN: ~p", [NextTS, NextSN]),
    validate_loop(disk_log:chunk(Log, Cont), Log, Validator, NextTS, NextSN).
%% validate_loop(Error, _Log, _Write, _PrevTS, _PrevSN) ->
%%     Error.
    

%% -- log ---

%%-----------------------------------------------------------------
%% For efficiency reasons, we want to log the packet as a binary.
%% This is only possible for messages that are not encrypted.
%% Therefore, Packet can be either a binary (encoded message), or
%% a tuple {V3Hdr, ScopedPduBytes}
%% 
%% log(Log, Packet, Addr, Port)
%%-----------------------------------------------------------------

log(#snmp_log{id = Log, seqno = SeqNo}, Packet, AddrStr) ->
    ?vtrace(
       "log -> entry with~n"
       "   Log:     ~p~n"
       "   AddrStr: ~s", [Log, AddrStr]),
    Entry = make_entry(SeqNo, Packet, AddrStr),
    disk_log:alog(Log, Entry).

log(#snmp_log{id = Log, seqno = SeqNo}, Packet, Ip, Port) ->
    ?vtrace("log -> entry with"
	    "~n   Log:  ~p"
	    "~n   Ip: ~p"
	    "~n   Port: ~p", [Log, Ip, Port]),
    Entry = make_entry(SeqNo, Packet, Ip, Port),
%%     io:format("log -> "
%% 	      "~n   Entry: ~p"
%% 	      "~n   Info:  ~p"
%% 	      "~n", [Entry, disk_log:info(Log)]),
    Res = disk_log:alog(Log, Entry),
%%     io:format("log -> "
%% 	      "~n   Res:  ~p"
%% 	      "~n   Info: ~p"
%% 	      "~n", [Res, disk_log:info(Log)]),
    %% disk_log:sync(Log), 
    Res.



make_entry(SeqNoGen, Packet, AddrStr)
  when is_integer(Packet);
       is_tuple(AddrStr) ->
    erlang:error(badarg, [SeqNoGen, Packet, AddrStr]);
make_entry(SeqNoGen, Packet, AddrStr) ->
    try next_seqno(SeqNoGen) of
	disabled ->
	    {timestamp(), Packet, AddrStr};
	{ok, NextSeqNo} when is_integer(NextSeqNo) ->
	    {timestamp(), NextSeqNo, Packet, AddrStr}
    catch
	_:_ ->
	    {timestamp(), Packet, AddrStr}
    end.

make_entry(SeqNoGen, Packet, Ip, Port) when is_integer(Packet) ->
    erlang:error(badarg, [SeqNoGen, Packet, Ip, Port]);
make_entry(SeqNoGen, Packet, Ip, Port) ->
    try next_seqno(SeqNoGen) of
	disabled ->
	    {timestamp(), Packet, Ip, Port};
	{ok, NextSeqNo} when is_integer(NextSeqNo) ->
	    {timestamp(), NextSeqNo, Packet, Ip, Port}
    catch
	_:_ ->
	    {timestamp(), Packet, Ip, Port}
    end.

next_seqno({M, F, A}) ->
    {ok, apply(M, F, A)};
next_seqno(F) when is_function(F) ->
    {ok, F()};
next_seqno(_) ->
    disabled.


%% -- change_size ---

change_size(#snmp_log{id = Log}, NewSize) ->
    do_change_size(Log, NewSize);
change_size(Log, NewSize) ->
    do_change_size(Log, NewSize).

do_change_size(Log, NewSize) ->
    ?vtrace("change_size -> entry with"
	    "~n   Log:     ~p"
	    "~n   NewSize: ~p", [Log, NewSize]),
    disk_log:change_size(Log, NewSize).


%% -- log_to_txt ---

%% <BACKWARD-COMPAT>
log_to_txt(Log, FileName, Dir, Mibs, TextFile) ->
    log_to_txt(Log, ?BLOCK_DEFAULT, FileName, Dir, Mibs, TextFile).
%% </BACKWARD-COMPAT>

log_to_txt(Log, Block, FileName, Dir, Mibs, TextFile) 
  when ((Block =:= true) orelse (Block =:= false)) ->
    log_to_txt(Log, Block, FileName, Dir, Mibs, TextFile, null, null);
%% <BACKWARD-COMPAT>
log_to_txt(Log, FileName, Dir, Mibs, TextFile, Start) ->
    log_to_txt(Log, ?BLOCK_DEFAULT, FileName, Dir, Mibs, TextFile, Start, null).
%% </BACKWARD-COMPAT>

log_to_txt(Log, Block, FileName, Dir, Mibs, TextFile, Start) 
  when ((Block =:= true) orelse (Block =:= false)) ->
    log_to_txt(Log, Block, FileName, Dir, Mibs, TextFile, Start, null);
%% <BACKWARD-COMPAT>
log_to_txt(Log, FileName, Dir, Mibs, TextFile, Start, Stop) ->
    log_to_txt(Log, ?BLOCK_DEFAULT, FileName, Dir, Mibs, TextFile, Start, Stop).
%% </BACKWARD-COMPAT>

log_to_txt(Log, Block, FileName, Dir, Mibs, TextFile, Start, Stop) 
  when (((Block =:= true) orelse (Block =:= false)) andalso 
	is_list(Mibs) andalso is_list(TextFile)) ->
    ?vtrace("log_to_txt -> entry with"
	    "~n   Log:      ~p"
	    "~n   Block:    ~p"
	    "~n   FileName: ~p"
	    "~n   Dir:      ~p"
	    "~n   Mibs:     ~p"
	    "~n   TextFile: ~p"
	    "~n   Start:    ~p"
	    "~n   Stop:     ~p", 
	    [Log, Block, FileName, Dir, Mibs, TextFile, Start, Stop]),
    File = filename:join(Dir, FileName),
    Converter = fun(L) ->
			do_log_to_file(L, TextFile, Mibs, Start, Stop)
		end,
    log_convert(Log, Block, File, Converter).


%% -- log_to_io ---

%% <BACKWARD-COMPAT>
log_to_io(Log, FileName, Dir, Mibs) ->
    log_to_io(Log, ?BLOCK_DEFAULT, FileName, Dir, Mibs, null, null).
%% </BACKWARD-COMPAT>

log_to_io(Log, Block, FileName, Dir, Mibs) 
  when ((Block =:= true) orelse (Block =:= false)) ->
    log_to_io(Log, Block, FileName, Dir, Mibs, null, null); 
%% <BACKWARD-COMPAT>
log_to_io(Log, FileName, Dir, Mibs, Start) ->
    log_to_io(Log, ?BLOCK_DEFAULT, FileName, Dir, Mibs, Start, null).
%% </BACKWARD-COMPAT>

log_to_io(Log, Block, FileName, Dir, Mibs, Start) 
  when ((Block =:= true) orelse (Block =:= false)) ->
    log_to_io(Log, Block, FileName, Dir, Mibs, Start, null); 
%% <BACKWARD-COMPAT>
log_to_io(Log, FileName, Dir, Mibs, Start, Stop) ->
    log_to_io(Log, ?BLOCK_DEFAULT, FileName, Dir, Mibs, Start, Stop).
%% </BACKWARD-COMPAT>

log_to_io(Log, Block, FileName, Dir, Mibs, Start, Stop) 
  when is_list(Mibs) ->
    ?vtrace("log_to_io -> entry with"
	    "~n   Log:      ~p"
	    "~n   Block:    ~p"
	    "~n   FileName: ~p"
	    "~n   Dir:      ~p"
	    "~n   Mibs:     ~p"
	    "~n   Start:    ~p"
	    "~n   Stop:     ~p", 
	    [Log, Block, FileName, Dir, Mibs, Start, Stop]),
    File = filename:join(Dir, FileName),
    Converter = fun(L) ->
			do_log_to_io(L, Mibs, Start, Stop)
		end,
    log_convert(Log, Block, File, Converter).


%% --------------------------------------------------------------------
%% Internal functions
%% --------------------------------------------------------------------

%% -- log_convert ---

log_convert(#snmp_log{id = Log}, Block, File, Converter) ->
    do_log_convert(Log, Block, File, Converter);
log_convert(Log, Block, File, Converter) ->
    do_log_convert(Log, Block, File, Converter).

do_log_convert(Log, Block, File, Converter) ->
    %% ?vtrace("do_log_converter -> entry with"
    %% 	    "~n   Log:   ~p"
    %% 	    "~n   Block: ~p"
    %% 	    "~n   File:  ~p"
    %% 	    [Log, Block, File]),
    Verbosity  = get(verbosity), 
    {Pid, Ref} = 
	erlang:spawn_monitor(
	  fun() ->
		  put(sname,     lc),
		  put(verbosity, Verbosity), 
		  ?vlog("begin converting", []),
		  Result = do_log_convert2(Log, Block, File, Converter),
		  ?vlog("convert result: ~p", [Result]),
		  exit(Result)
	  end),
    receive 
	{'DOWN', Ref, process, Pid, Result} ->
	    %% ?vtrace("do_log_converter -> received result"
	    %% 	    "~n   Result: ~p", [Result]),
	    Result
    end.
    
do_log_convert2(Log, Block, File, Converter) ->

    %% ?vtrace("do_log_converter2 -> entry with"
    %% 	    "~n   Log:   ~p"
    %% 	    "~n   Block: ~p"
    %% 	    "~n   File:  ~p"
    %% 	    "~n   disk_log:info(Log): ~p", 
    %% 	    [Log, Block, File, disk_log:info(Log)]),

    %% 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.

    ?vtrace("do_log_convert2 -> entry - check if owner", []),
    case is_owner(Log) of
	true ->
	    ?vtrace("do_log_converter2 -> convert an already owned log", []),
	    maybe_block(Log, Block), 
	    Res = Converter(Log),
	    maybe_unblock(Log, Block), 
	    Res;
	false ->
	    %% Not yet member of the ruling party, apply for membership...
	    ?vtrace("do_log_converter2 -> convert log", []),
	    case log_open(Log, File) of
		{ok, _} ->
		    ?vdebug("do_log_convert2 -> opened - now convert", []),
		    maybe_block(Log, Block), 
		    Res = Converter(Log),
		    maybe_unblock(Log, Block), 
		    disk_log:close(Log),
		    ?vdebug("do_log_convert2 -> converted - done: "
			    "~n   Result: ~p", [Res]),
		    Res;
		{error, {name_already_open, _}} ->
		    ?vdebug("do_log_convert2 -> "
			    "already opened - now convert", []),
		    maybe_block(Log, Block), 
                    Res = Converter(Log), 
		    maybe_unblock(Log, Block), 
		    ?vdebug("do_log_convert2 -> converted - done: "
			    "~n   Result: ~p", [Res]),
		    Res;
                {error, Reason} ->
		    ?vinfo("do_log_converter2 -> "
			   "failed converting log - open failed: "
			   "~n   Reason: ~p", [Reason]),
                    {error, {Log, Reason}}
	    end
    end.


maybe_block(_Log, false = _Block) ->
    %% ?vtrace("maybe_block(false) -> entry", []),
    ok;
maybe_block(Log, true = _Block) ->
    %% ?vtrace("maybe_block(true) -> entry when"
    %% 	    "~n   Log Status: ~p", [log_status(Log)]),
    Res = disk_log:block(Log, true),
    %% ?vtrace("maybe_block(true) -> "
    %% 	    "~n   Log Status: ~p"
    %% 	    "~n   Res:        ~p", [log_status(Log), Res]),
    Res.

maybe_unblock(_Log, false = _Block) ->
    %% ?vtrace("maybe_unblock(false) -> entry", []),
    ok;
maybe_unblock(Log, true = _Block) ->
    %% ?vtrace("maybe_unblock(true) -> entry when"
    %% 	    "~n   Log Status: ~p", [log_status(Log)]),
    Res = disk_log:unblock(Log),
    %% ?vtrace("maybe_unblock(true) -> "
    %% 	    "~n   Log Status: ~p"
    %% 	    "~n   Res:        ~p", [log_status(Log), Res]),
    Res.

%% log_status(Log) ->
%%     Info = disk_log:info(Log),
%%     case lists:keysearch(status, 1, Info) of
%% 	{value, {status, Status}} ->
%% 	    Status;
%% 	false ->
%% 	    undefined
%%     end.


%% -- do_log_to_text ---

do_log_to_file(Log, TextFile, Mibs, Start, Stop) ->
    case file:open(TextFile, [write]) of
        {ok, Fd} ->
            MiniMib = snmp_mini_mib:create(Mibs),
	    Write = fun(X) -> 
			    case format_msg(X, MiniMib, Start, Stop) of
                                {Tag, S} when (Tag =:= ok) orelse (Tag =:= error) ->
				    io:format(Fd, "~s", [S]),
                                    Tag;
				Ignore ->
				    Ignore
			    end
		    end,
            Res = (catch loop(Log, Write)),
	    snmp_mini_mib:delete(MiniMib), 
            file:close(Fd),
            Res;
        {error, Reason} ->
            {error, {TextFile, Reason}}
    end.


do_log_to_io(Log, Mibs, Start, Stop) ->
    MiniMib = snmp_mini_mib:create(Mibs),
    Write = fun(X) -> 
		    case format_msg(X, MiniMib, Start, Stop) of
			{Tag, S} when (Tag =:= ok) orelse (Tag =:= error) ->
			    io:format("~s", [S]),
                            Tag;
			X ->
			    X
		    end
	    end,
    Res = (catch loop(Log, Write)),
    snmp_mini_mib:delete(MiniMib),
    Res.


loop(Log, Write) ->
    loop(disk_log:chunk(Log, start), Log, Write, 0, 0).

loop(eof, _Log, _Write, _NumOK, 0 = _NumERR) ->
    ok;
loop(eof, _Log, _Write, NumOK, NumERR) ->
    {ok, {NumOK, NumERR}};
loop({error, _} = Error, _Log, _Write, _NumOK, _NumERR) ->
    Error;
loop({Cont, Terms}, Log, Write, NumOK, NumERR) ->
    try loop_terms(Terms, Write) of
        {ok, {AddedOK, AddedERR}} ->
            loop(disk_log:chunk(Log, Cont), Log, Write,
                 NumOK+AddedOK, NumERR+AddedERR)
    catch
        C:E:S ->
            {error, {C, E, S}}
    end;
loop({Cont, Terms, BadBytes}, Log, Write, NumOK, NumERR) ->
    error_logger:error_msg("Skipping ~w bytes while converting ~p~n~n", 
			   [BadBytes, Log]),
    try loop_terms(Terms, Write) of
        {ok, {AddedOK, AddedERR}} ->
            loop(disk_log:chunk(Log, Cont), Log, Write,
                 NumOK+AddedOK, NumERR+AddedERR)
    catch
        C:E:S ->
            {error, {C, E, S}}
    end.


loop_terms(Terms, Write) ->
    loop_terms(Terms, Write, 0, 0).

loop_terms([], _Write, NumOK, NumERR) ->
    {ok, {NumOK, NumERR}};
loop_terms([Term|Terms], Write, NumOK, NumERR) ->
    case Write(Term) of
        ok ->
            loop_terms(Terms, Write, NumOK+1, NumERR);
        error ->
            loop_terms(Terms, Write, NumOK,   NumERR+1);
        _ ->
            loop_terms(Terms, Write, NumOK,   NumERR)
    end.


format_msg(Entry, Mib, Start, Stop) ->
    TimeStamp = element(1, Entry),
    case timestamp_filter(TimeStamp, Start, Stop) of
        true ->
	    do_format_msg(Entry, Mib);
	false ->
	    ignore
    end.

%% This is an old-style entry, that never had the sequence-number
do_format_msg({Timestamp, Packet, {Ip, Port}}, Mib) ->
    do_format_msg(Timestamp, Packet, ipPort2Str(Ip, Port), Mib);
%% This is the format without sequence-number
do_format_msg({Timestamp, Packet, AddrStr}, Mib) ->
    do_format_msg(Timestamp, Packet, AddrStr, Mib);

%% This is the format with sequence-number
do_format_msg({Timestamp, SeqNo, Packet, AddrStr}, Mib)
  when is_integer(SeqNo) ->
    do_format_msg(Timestamp, Packet, AddrStr, Mib);
%% This is the format without sequence-number
do_format_msg({Timestamp, Packet, Ip, Port}, Mib) ->
    do_format_msg(Timestamp, Packet, ipPort2Str(Ip, Port), Mib);

%% This is the format with sequence-number
do_format_msg({Timestamp, SeqNo, Packet, Ip, Port}, Mib) ->
    do_format_msg(Timestamp, SeqNo, Packet, ipPort2Str(Ip, Port), Mib);

%% This is crap...
do_format_msg(_, _) ->
    {error, format_tab("** unknown entry in log file\n\n", [])}.

do_format_msg(TimeStamp, {V3Hdr, ScopedPdu}, AddrStr, Mib) ->
    try snmp_pdus:dec_scoped_pdu(ScopedPdu) of
	ScopedPDU when is_record(ScopedPDU, scopedPdu) -> 
	    Msg = #message{version = 'version-3',
			   vsn_hdr = V3Hdr,
			   data    = ScopedPDU},
	    try f(ts2str(TimeStamp), "", Msg, AddrStr, Mib) of
                {ok, _} = OK ->
                    OK
            catch
                FormatT:FormatE ->
                    format_error("format scoped pdu",
                                 TimeStamp, AddrStr, FormatT, FormatE)
            end
    catch
        DecT:DecE ->
            format_error("decode scoped pdu", 
                         TimeStamp, AddrStr, DecT, DecE)
    end;
do_format_msg(TimeStamp, Packet, AddrStr, Mib) ->
    try snmp_pdus:dec_message(binary_to_list(Packet)) of
	Msg when is_record(Msg, message) ->
	    try f(ts2str(TimeStamp), "", Msg, AddrStr, Mib) of
                {ok, _} = OK ->
                    OK
            catch
                FormatT:FormatE ->
                    %% Provide info about the message
                    Extra = 
                        case Msg#message.version of
                            'version-3' ->
                                #v3_hdr{msgID            = ID,
                                        msgFlags         = Flags,
                                        msgSecurityModel = SecModel} = 
                                    Msg#message.vsn_hdr,
                                SecLevel = snmp_misc:get_sec_level(Flags),
                                f("msg-id: ~w, sec-level: ~w, sec-model: ~w", 
                                  [ID, SecLevel, sm2atom(SecModel)]);
                            _ -> %% Community
                                f("community: ~s", [Msg#message.vsn_hdr])
                        end,
                    format_error(f("format ~p message; ~s", 
                                   [Msg#message.version, Extra]),
                                 TimeStamp, AddrStr, FormatT, FormatE)
            end
    catch
        DecT:DecE ->
            format_error("decode message", 
                         TimeStamp, AddrStr, DecT, DecE)

    end.

sm2atom(?SEC_ANY) -> any;
sm2atom(?SEC_V1)  -> v1;
sm2atom(?SEC_V2C) -> v2c;
sm2atom(?SEC_USM) -> usm;
sm2atom(_)        -> unknown.

do_format_msg(TimeStamp, SeqNo, {V3Hdr, ScopedPdu}, AddrStr, Mib) ->
    try snmp_pdus:dec_scoped_pdu(ScopedPdu) of
	ScopedPDU when is_record(ScopedPDU, scopedPdu) -> 
	    Msg = #message{version = 'version-3',
			   vsn_hdr = V3Hdr,
			   data    = ScopedPDU},
	    try f(ts2str(TimeStamp), sn2str(SeqNo), Msg, AddrStr, Mib) of
                {ok, _} = OK ->
                    OK
            catch
                FormatT:FormatE ->
                    format_error("format scoped pdu",
                                 TimeStamp, SeqNo, AddrStr, FormatT, FormatE)
            end
    catch
        DecT:DecE ->
            format_error("decode scoped pdu",
                         TimeStamp, SeqNo, AddrStr, DecT, DecE)
    end;
do_format_msg(TimeStamp, SeqNo, Packet, AddrStr, Mib) ->
    try snmp_pdus:dec_message(binary_to_list(Packet)) of
	Msg when is_record(Msg, message) ->
	    try f(ts2str(TimeStamp), sn2str(SeqNo), Msg, AddrStr, Mib) of
                {ok, _} = OK ->
                    OK
                        
            catch
                FormatT:FormatE ->
                    %% Provide info about the message
                    Extra = 
                        case Msg#message.version of
                            'version-3' ->
                                #v3_hdr{msgID            = ID,
                                        msgFlags         = Flags,
                                        msgSecurityModel = SecModel} = 
                                    Msg#message.vsn_hdr,
                                SecLevel = snmp_misc:get_sec_level(Flags),
                                f("msg-id: ~w, sec-level: ~w, sec-model: ~w", 
                                  [ID, SecLevel, sm2atom(SecModel)]);
                            _ -> %% Community
                                f("community: ~s", [Msg#message.vsn_hdr])
                        end,
                    format_error(f("format ~p message; ~s", 
                                   [Msg#message.version, Extra]),
                                 TimeStamp, SeqNo, AddrStr, FormatT, FormatE)
            end
    catch
        DecT:DecE ->
            format_error("decode message",
                         TimeStamp, SeqNo, AddrStr, DecT, DecE)
    end.


format_error(WhatStr, TimeStamp, AddrStr, throw, {error, Reason}) ->
    {ok, Str} = 
        format_tab(
          "** error (~s) in log file at ~s from ~s: "
          "~n   ~p\n\n",
          [WhatStr, ts2str(TimeStamp), AddrStr, Reason]),
    {error, Str};
format_error(WhatStr, TimeStamp, AddrStr, T, E) ->
    {ok, Str} = 
        format_tab(
          "** error (~s) in log file at ~s from ~s: "
          "~n   ~w: ~p\n\n",
          [WhatStr, ts2str(TimeStamp), AddrStr, T, E]),
    {error, Str}.

format_error(WhatStr, TimeStamp, SeqNo, AddrStr, throw, {error, Reason}) ->
    {ok, Str} = 
        format_tab(
          "** error (~s) in log file at ~s~s from ~s: "
          "~n   ~p\n\n",
          [WhatStr, ts2str(TimeStamp), sn2str(SeqNo), AddrStr, Reason]),        
    {error, Str};
format_error(WhatStr, TimeStamp, SeqNo, AddrStr, T, E) ->
    {ok, Str} = 
        format_tab(
          "** error (~s) in log file at ~s~s from ~s: "
          "~n   ~w, ~p\n\n",
          [WhatStr, ts2str(TimeStamp), sn2str(SeqNo), AddrStr, T, E]),        
    {error, Str}.


f(TimeStamp, SeqNo, 
  #message{version = Vsn, vsn_hdr = VsnHdr, data = Data}, 
  AddrStr, Mib) ->
    Str    = format_pdu(Data, Mib),
    HdrStr = format_header(Vsn, VsnHdr),
    Class =
	case get_type(Data) of
	    trappdu ->
		trap;
	    'snmpv2-trap' ->
		trap;
	    'inform-request' ->
		inform;
	    'get-response' ->
		response;
	    report ->
		report;
	    _ ->
		request
	end,
    format_tab(
      "~w ~s - ~s [~s]~s ~w\n~s",
      [Class, AddrStr, HdrStr, TimeStamp, SeqNo, Vsn, Str]).

f(F, A) ->
    lists:flatten(io_lib:format(F, A)).


ipPort2Str(Ip, Port) ->
    snmp_conf:mk_addr_string({Ip, Port}).

%% Convert a timestamp 2-tupple to a printable string
%%
ts2str({Local,Universal}) ->
    dat2str(Local) ++ " , " ++ dat2str(Universal);
ts2str(_) ->
    "".

%% Convert a sequence number integer to a printable string
%%
sn2str(SeqNo) when is_integer(SeqNo) ->
    " [" ++ integer_to_list(SeqNo) ++ "]";
sn2str(_) ->
    "".

%% Convert a datetime 2-tupple to a printable string
%%
dat2str({{Y,M,D},{H,Min,S}}) -> 
    io_lib:format("~w-~w-~w,~w:~w:~w",[Y,M,D,H,Min,S]).


timestamp_filter({Local,Universal},Start,Stop) ->
    tsf_ge(Local,Universal,Start) and tsf_le(Local,Universal,Stop);
timestamp_filter(_,_Start,_Stop) -> 
    true.

tsf_ge(_Local,_Universal,null) ->
    true;
tsf_ge(Local,_Universal,{local_time,DateTime}) ->
    tsf_ge(Local,DateTime);
tsf_ge(_Local,Universal,{universal_time,DateTime}) ->
    tsf_ge(Universal,DateTime);
tsf_ge(Local,_Universal,DateTime) ->
    tsf_ge(Local,DateTime).

tsf_ge(TimeStamp, DateTime) -> 
    T1 = calendar:datetime_to_gregorian_seconds(TimeStamp),
    T2 = calendar:datetime_to_gregorian_seconds(DateTime),
    T1 >= T2.

tsf_le(_Local, _Universal, null) ->
    true;
tsf_le(Local, _Universal, {local_time, DateTime}) ->
    tsf_le(Local, DateTime);
tsf_le(_Local, Universal, {universal_time, DateTime}) ->
    tsf_le(Universal, DateTime);
tsf_le(Local, _Universal, DateTime) ->
    tsf_le(Local,DateTime).

tsf_le(TimeStamp, DateTime) ->
    T1 = calendar:datetime_to_gregorian_seconds(TimeStamp),
    T2 = calendar:datetime_to_gregorian_seconds(DateTime),
    T1 =< T2.


%% In the output replace TAB by ESC TAB, and add a single trailing TAB.
%%
format_tab(Format, Args) ->
    Str  = lists:flatten(io_lib:format(Format, Args)),
    DStr = lists:map(fun($\t) -> "\e\t"; (C) -> C end, Str),
    {ok, io_lib:format("~s\t", [DStr])}.


format_header('version-1', CommunityStr) ->
    CommunityStr;
format_header('version-2', CommunityStr) ->
    CommunityStr;
format_header('version-3', #v3_hdr{msgFlags              = MsgFlags,
                                   msgSecurityModel      = SecModel,
                                   msgSecurityParameters = SecParams}) ->
    SecLevel = snmp_misc:get_sec_level(MsgFlags),
    case SecModel of
        ?SEC_USM ->
            case catch snmp_pdus:dec_usm_security_parameters(SecParams) of
                #usmSecurityParameters{msgAuthoritativeEngineID = AuthEngineID,
                                       msgUserName              = UserName} ->
                    io_lib:format("~w:\"~s\":\"~s\"",
                                  [SecLevel, AuthEngineID, UserName]);
                _ ->
                    "-"
            end;
        _ ->
            "\"unknown security model\""
    end.


format_pdu(#scopedPdu{contextName = Context, data = Pdu}, Mib) ->
    io_lib:format("Context: \"~s\"\n~s",
                  [Context, snmp_misc:format_pdu(Pdu, Mib)]);
format_pdu(Pdu, Mib) ->
    try snmp_misc:format_pdu(Pdu, Mib) of
        Str ->
            Str
    catch
        _:_ ->
            throw({error, 'invalid-pdu'})
    end.

get_type(#scopedPdu{data = Pdu}) ->
    get_type(Pdu);
get_type(Pdu) when is_record(Pdu, trappdu) ->
    trappdu;
get_type(#pdu{type = Type}) ->
    Type.



%% -------------------------------------------------------------------    
%% Various utility functions
%% -------------------------------------------------------------------    

log_open(Name, File, {M, F, A} = SeqNoGen, Size, Repair, Notify) 
  when (is_atom(M) andalso is_atom(F) andalso is_list(A)) ->
    log_open2(Name, File, SeqNoGen, Size, Repair, Notify);
log_open(Name, File, SeqNoGen, Size, Repair, Notify) 
  when is_function(SeqNoGen, 0) ->
    log_open2(Name, File, SeqNoGen, Size, Repair, Notify);
log_open(Name, File, disabled = SeqNoGen, Size, Repair, Notify) ->
    log_open2(Name, File, SeqNoGen, Size, Repair, Notify);
log_open(_, _File, BadSeqNoGen, _Size, _Repair, _Notify) ->
    {error, {bad_seqno, BadSeqNoGen}}.

log_open2(Name, File, SeqNoGen, Size, Repair, Notify) ->
    case do_log_open(Name, File, Size, Repair, Notify) of
	{ok, Log} ->
	    {ok, #snmp_log{id = Log, seqno = SeqNoGen}};
	{repaired, Log, Rec, Bad} ->
	    ?vlog("log_open -> repaired: "
		  "~n   Rec: ~p"
		  "~n   Bad: ~p", [Rec, Bad]),
	    {ok, #snmp_log{id = Log, seqno = SeqNoGen}};
	Error ->
	    Error
    end.


%% We need to make sure we do not end up in an infinite loop
%% Take the number of files of the wrap log and add 2 (for
%% the index and size files).
do_log_open(Name, File, {_, N} = Size, snmp_repair = _Repair, Notify) ->
    do_snmp_log_open(Name, File, Size, N+2, Notify);

do_log_open(Name, File, Size, snmp_repair = _Repair, Notify) ->
    do_snmp_log_open(Name, File, Size, 1, Notify);

do_log_open(Name, File, Size, Repair, Notify) ->
    do_std_log_open(Name, File, Size, Repair, Notify).


do_snmp_log_open(Name, File, Size, N, Notify) when N =< 0 ->
    do_std_log_open(Name, File, Size, true, Notify);
do_snmp_log_open(Name, File, Size, N, Notify) ->
    case do_std_log_open(Name, File, Size, true, Notify) of
	{error, {not_a_log_file, XFile}} ->
	    case file:rename(XFile, lists:append([XFile, ".MOVED"])) of
		ok ->
		    ?vinfo("Failed open log file (even with repair) - "
			   "not a logfile:"
			   "~n   Attempting to move file aside (.MOVED)"
			   "~n   ~s", [XFile]),
		    do_snmp_log_open(Name, File, Size, N-1, Notify);
		Error ->
		    {error, {rename_failed, Error}}
	    end;
	{error, Reason} ->
	    ?vinfo("Failed open log file (even with repair) - "
		   "~n   Attempting to move old log file aside (.MOVED)"
		   "~n~p", [Reason]),
	    move_log(File),
	    do_std_log_open(Name, File, Size, true, Notify);
	Else ->
	    Else
    end.


%% First try to open the log without the size-spec.  This will 
%% succeed if the log has already been created.  In that case, 
%% we'll use whatever size the log had at the time it was closed.
do_std_log_open(Name, File, Size, Repair, Notify) ->
    Opts = [{name,   Name},
	    {file,   File},
	    {type,   ?LOG_TYPE},
	    {format, ?LOG_FORMAT},
	    {mode,   read_write},
	    {notify, Notify}, 
	    {repair, Repair}],
    case disk_log:open(Opts) of
	{error, {badarg, size}} ->
	    %% The log didn't exist, try with the size-spec
            disk_log:open([{size, Size} | Opts]);
	Else ->
	    Else
    end.


log_open(Name, File) ->
    Opts = [{name, Name}, 
	    {file, File}],
    case disk_log:open(Opts) of
	{error, {badarg, size}} ->
	    {error, no_such_log};
	Else ->
	    Else
    end.


move_log(File) ->
    Dir      = filename:dirname(File),
    FileName = filename:basename(File),
    case file:list_dir(Dir) of
        {ok, Files0} ->
	    Files = [F || F <- Files0, lists:prefix(FileName, F)],
	    F = fun(XFile) ->
			file:rename(XFile, lists:append([XFile, ".MOVED"]))
		end,
            lists:foreach(F, Files);
        _ ->
            ok
    end.
    

is_owner(Log) ->    
    lists:member(self(), log_owners(Log)).

log_owners(Log) ->
    Info = log_info(Log),
    case lists:keysearch(owners, 1, Info) of
	{value, {_, Pids}} ->
	    [P || {P, _} <- Pids];
	_ ->
	    []
    end.

log_info(Log) ->
    case disk_log:info(Log) of
	Info when is_list(Info) ->
	    Info;
	_ ->
	    []
    end.


timestamp() ->     
    {calendar:local_time(), calendar:universal_time()}.