################################################################################ # 名　称：ComLog.pm # 機　能：ログに関する機能を提供する。 # ： # ：○"perl bin/foo/bar.pl 1 US STOCK"から呼び出した場合のログファイルのパス # ： # ： 例1) ComLog::open; # ： → bin/foo/log/bar_YYYYMMDD.log # ： # ： 例2) ComLog::open('addNames' => $ARGV[1]); # ： → bin/foo/log/bar_1_YYYYMMDD.log # ： # ： 例3) ComLog::open( # ： 'directory' => "bar/BT/log", # ： 'baseName' => "hoge", # ： 'addNames' => [ @ARGV, "aaa" ], # ： 'reserve' => 10, # ： ); # ： → bin/foo/bar/BT/log/hoge_1_US_STOCK_aaa_YYYYMMDD.log # ： # ：○ログ出力 # ： # ： 例1) ComLog::write("aiueo"); # ： → | YYYY/MM/DD HH:MM:SS | ------ | aiueo # ： # ： 例2) ComLog::write("ERROR", "kakikukeko"); # ： → | YYYY/MM/DD HH:MM:SS | ERROR | kakikukeko # ： # ： 例3) ComLog::write("USER", { # ： 'branch_no' => "Z99", # ： 'account_no' => "0123456", # ： 'split_name' => [ "イントラ", "太郎" ], # ： 'age' => 20, # ： }); # ： → | YYYY/MM/DD HH:MM:SS | USER-- | { # ： 'branch_no' => 'Z99', # ： 'account_no' => '0123456', # ： 'split_name' => [ # ： 'イントラ', # ： '太郎' # ： ], # ： 'age' => 20, # ： } # ： # ：○定型のログ出力 # ： 例1) ComLog::start("ログ処理"); # ： → | YYYY/MM/DD HH:MM:SS | ------ | ▼開始▼ ----------------------------- ログ処理 # ： # ： 例2) ComLog::end("ログ処理"); # ： → | YYYY/MM/DD HH:MM:SS | ------ | △終了△ ----------------------------- ログ処理 # ： # ： 例3) ComLog::startMain; # ： → | YYYY/MM/DD HH:MM:SS | ------ | ■開始■ ------------------------------- 主処理 # ： # ： 例4) ComLog::endMain; # ： → | YYYY/MM/DD HH:MM:SS | ------ | □終了□ ------------------------------- 主処理 # # ------------------------------------------------------------------------------ # 履　歴：2015/05/07 新規作成（LogOperation.pm ver1.2がベース） ################################################################################ package ComLog; use strict; use warnings; use FindBin qw($Bin); use File::Basename qw(basename); use File::Path; use POSIX qw(strftime); use Data::Dumper; my $isOpened = 0; my $defaultStat = '-' x 6; ################################################################################ # 名　称：open # 機　能：ログをオープンする。 # ------------------------------------------------------------------------------ # 引　数：下記のキーを含むハッシュ（省略可） # ：directory … ログを作成するディレクトリ(default:呼び出し元スクリプトパス/log) # ：baseName … ファイル名の先頭につける文字列(default:呼び出し元スクリプト名) # ：addNames … baseNameに追加する文字列（default:なし。スカラー、またはリストへのリファレンス） # ：reserve … 残すログの数(default:5) # 戻り値：ログパス/undef … 成功/失敗 ################################################################################ sub open(%) { my %arg = @_; my $filePath; eval { ### ログディレクトリ my $directory = $arg{'directory'}; if (defined($directory)) { # 前後トリム $directory =~ s/^\s//g; $directory =~ s/\s$//g; } # 指定なし、またはトリム後に空文字であればデフォルト if (not defined($directory) or $directory eq '') { $directory = "$Bin/log"; # 相対パスが指定された場合はカレントディレクトリを$Binに設定 } elsif ($directory =~ /^[^\/]/) { $directory = "$Bin/$directory"; } ### ファイル名の先頭文字列 my $baseName = $arg{'baseName'}; if (defined($baseName)) { # 英数字、「_」、「.」のみ有効（全角、「!"#$%&'()-=^~\|@`[]{};+:*,<>/?」は無効） $baseName =~ s/[^\w\.]//g; } $baseName = basename($0, '.pl') if (not defined($baseName) or $baseName eq ''); ### ファイル名に追加する文字列 my @addNames = (); if (defined($arg{'addNames'})) { foreach my $addName (ref($arg{'addNames'}) ? @{ $arg{'addNames'} } : $arg{'addNames'}) { $addName =~ s/[^\w\.]//g; push(@addNames, $addName) if ($addName); } } ### パスを設定 my $date = &strftime('%Y%m%d', localtime(time)); my $fileName = join('_', $baseName, @addNames); $filePath = "${directory}/${fileName}_${date}.log"; my $filePattern = "${directory}/${fileName}_????????.log"; ### ローテーション時に残すログの数 my $reserve = $arg{'reserve'}; $reserve =~ s/\D//g if ($reserve); $reserve = 5 unless ($reserve); if (-d $directory) { # ディレクトリがあったらローテーション unless (-e $filePath) { # n-1個残す(1個は今回新たに作られる) $reserve = $reserve - 1; } my $count = 0; foreach my $oldLog (sort { $b cmp $a } (glob($filePattern))) { $count++; # 古いファイルを削除 unlink($oldLog) if ($count > $reserve); } } else { # ディレクトリがなかったら作成 mkpath($directory, { 'mode' => 0755 }) or die $!; } open(STDERR, '>>', $filePath) or die $!; $isOpened = 1; # 見出し my $BT_START_TIMESTAMP = &strftime('%Y/%m/%d %H:%M:%S', localtime($^T)); warn << "__END_OF_HEADER__"; | PID $$ | UID $<(EUID $>) | GID ${(}(EGID ${)}) | Perl Version $] | Logged By $0 -------------------------------------------------------------------------------- | Datetime | Status | Processing | -------------------------------------------------------------------------------- | $BT_START_TIMESTAMP | START | Job Start | __END_OF_HEADER__ ComLog::write('CMD', "$0 " . join(' ', @ARGV)); }; if ($@) { $isOpened = -1; return undef; } else { return $filePath; } } ################################################################################ # 名　称：close # 機　能：ログをクローズする。 # ------------------------------------------------------------------------------ # 引　数：(なし) # 戻り値：1/0 … 成功/失敗 ################################################################################ sub close() { eval{ my $ts = &strftime('%Y/%m/%d %H:%M:%S', localtime(time)); warn("| $ts | END | Job End |\n"); warn(('~' x 80) . "\n"); close(STDERR) if ($isOpened > 0); $isOpened = 0; }; if ($@) { return 0; } else { return 1; } } END { ComLog::close if ($isOpened); } ################################################################################ # 名　称：write # 機　能：ログを一行書き出す。 # ------------------------------------------------------------------------------ # 引　数：stat … ステータス(省略可、default:------) # ：body … 本文 # 戻り値：1/0 … 成功/失敗 ################################################################################ sub write($;$) { my ($stat, $body) = @_; eval{ # 開き忘れていたら一応警告 warn("ログファイルがopenされていません。\n") unless ($isOpened); unless (defined($body)) { $body = $stat; $stat = undef; } $stat = $defaultStat if (not defined($stat) or $stat !~ /\S/); $body = '' unless (defined($body)); if (length($stat) > 6){ $stat = $defaultStat; } $stat = $stat . (' ' x (6 - length($stat))); my $ts = &strftime('%Y/%m/%d %H:%M:%S', localtime(time)); unless (ref($body)) { warn("| $ts | $stat | $body\n"); } else { warn("| $ts | $stat | " . Data::Dumper->new([$body])->Indent(1)->Terse(1)->Sortkeys(1)->Dump); } }; if ($@) { return 0; } else { return 1; } } ################################################################################ # 名　称：start # 機　能：処理開始ログを一行書き出す。 # ------------------------------------------------------------------------------ # 引　数：proc … 処理名 # 戻り値：1/0 … 成功/失敗 ################################################################################ sub start($) { my ($proc) = @_; my $hyphenLength = (length($proc) < 37) ? (37 - length($proc)) : 37; return ComLog::write('▼開始▼ ' . '-' x $hyphenLength . ' ' . $proc); } ################################################################################ # 名　称：end # 機　能：処理終了ログを一行書き出す。 # ------------------------------------------------------------------------------ # 引　数：proc … 処理名 # 戻り値：1/0 … 成功/失敗 ################################################################################ sub end($) { my ($proc) = @_; my $hyphenLength = (length($proc) < 37) ? (37 - length($proc)) : 37; return ComLog::write('△終了△ ' . '-' x $hyphenLength . ' ' . $proc); } ################################################################################ # 名　称：startInit # 機　能：初期処理開始ログを一行書き出す。 # ------------------------------------------------------------------------------ # 引　数：なし # 戻り値：1/0 … 成功/失敗 ################################################################################ sub startInit() { return ComLog::write('■開始■ ----------------------------- 初期処理'); } ################################################################################ # 名　称：endInit # 機　能：初期処理終了ログを一行書き出す。 # ------------------------------------------------------------------------------ # 引　数：proc … 処理名 # 戻り値：1/0 … 成功/失敗 ################################################################################ sub endInit() { return ComLog::write('□終了□ ----------------------------- 初期処理'); } ################################################################################ # 名　称：startMain # 機　能：主処理開始ログを一行書き出す。 # ------------------------------------------------------------------------------ # 引　数：なし # 戻り値：1/0 … 成功/失敗 ################################################################################ sub startMain() { return ComLog::write('■開始■ ------------------------------- 主処理'); } ################################################################################ # 名　称：endMain # 機　能：主期処理終了ログを一行書き出す。 # ------------------------------------------------------------------------------ # 引　数：proc … 処理名 # 戻り値：1/0 … 成功/失敗 ################################################################################ sub endMain() { return ComLog::write('□終了□ ------------------------------- 主処理'); } ################################################################################ # 名　称：startExit # 機　能：初期処理開始ログを一行書き出す。 # ------------------------------------------------------------------------------ # 引　数：なし # 戻り値：1/0 … 成功/失敗 ################################################################################ sub startExit() { return ComLog::write('■開始■ ----------------------------- 終了処理'); } ################################################################################ # 名　称：endExit # 機　能：初期処理終了ログを一行書き出す。 # ------------------------------------------------------------------------------ # 引　数：proc … 処理名 # 戻り値：1/0 … 成功/失敗 ################################################################################ sub endExit() { return ComLog::write('□終了□ ----------------------------- 終了処理'); } 1; 这是log.pm