File: fix-logs

package info (click to toggle)
kamailio 5.6.3-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 68,332 kB
  • sloc: ansic: 744,091; xml: 196,848; cpp: 14,471; makefile: 8,859; sh: 8,814; sql: 7,844; yacc: 3,863; perl: 2,955; python: 2,710; java: 449; javascript: 269; php: 258; ruby: 225; cs: 40; awk: 27
file content (155 lines) | stat: -rwxr-xr-x 4,114 bytes parent folder | download | duplicates (9)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
#!/usr/bin/perl -w
#
# Usage: fix-log [MODULE-NAME] < INFILE > OUTFILE
#
# Fixes logging macros and messages in the SER source file INFILE
# to match the recent updates in the logging API.
#
# Specify MODULE_NAME if INFILE source file is a part of a SER module.
#
# See doc/logging-api.txt for details.
#
# $Id$

#
# What *exactly* does this script do?
#
#   - replaces LOG(L_*, ...) with the short macro corresponding to L_* level
#
#   - replaces DEBUG() with DBG() macro
#
#   - removes MODULE and the level string prefixes from FMT arguments of macros
#     where FMT looks like "X:...", "X:Y:..." or "X:Y:Z:...", white spaces are
#     ignored and preserved, string matching is case-insensitive
#
#     In addition, if the level string found in FMT argument doesn't match the actual
#     level of the macro, the macro level is fixed.
#
#     Examples:
#        ERR("ERROR:tm: blah\n")           becomes ERR("blah\n")
#        DBG("Debug: blah\n")              becomes DBG("blah\n")
#        LOG(L_ERR, "tm: INFO: blah\n")    becomes INFO("blah\n")
#
#   - removes 'MODULE_NAME ":' string from the beggining of FMT arguments of macros
#     in module source files (a common special case)
#
#     Example:
#        LOG(L_ERR, MODULE_NAME ": tm:Info:blah\n")   becomes INFO("blah\n")
#

# Map a text string to L_* log level macro
my %text2level = (
    "BUG"         => "L_CRIT",
    "CRIT"        => "L_CRIT",
    "CRITICAL"    => "L_CRIT",

    "ALERT"       => "L_ALERT",

    "ERR"         => "L_ERR",
    "ERROR"       => "L_ERR",

    "WARN"        => "L_WARN",
    "WARNING"     => "L_WARN",

    "NOTICE"      => "L_NOTICE",

    "INFO"        => "L_INFO",

    "DBG"         => "L_DBG",
    "DEBUG"       => "L_DBG",
);

#
short2level


# Strip the leading and trailing whitespaces and upper-case a text
sub norm {
    my $text = ($_[0] || "");
    $text =~ s/^\s*//;
    $text =~ s/\s*$//;
    uc($text);
}

my $module_name = norm($ARGV[0]);

sub fix_log_prefix {
    my ($prefix, $level) = ($_[0], $_[1]);

    # delete prefix if it contains module name
    if ($module_name) {
        if (!$text || (norm($text) eq $module_name)) {
            return ("", $level);
        }
    }

    # delete prefix if it contains text level
    my $prefix_level = $text2level{norm($prefix)};
    if ($prefix_level) {
	$prefix = "";
	
	# change level if does not match prefix level
	if ($level =~ /^L_(DBG|INFO|NOTICE|WARN|ERR|CRIT|ALERT)$/ && 
	    $level ne $prefix_level) {
    	    return ("", $prefix_level);
	}
    }

    return ($prefix . ":", $level);
}

sub fix_log {
    my $level = $_[0];
    my $prefix1 = $_[1];
    my $prefix2 = $_[2];
    my $prefix3 = $_[3];
    my $space = $_[4];

    ($prefix1, $level) = fix_log_prefix($prefix1, $level) if $prefix1;
    ($prefix2, $level) = fix_log_prefix($prefix2, $level) if $prefix2;
    ($prefix3, $level) = fix_log_prefix($prefix3, $level) if $prefix3;

    my $prefix = $prefix1 . $prefix2 . $prefix3 . $space;
    $prefix =~ s/^\s*//;
    
    "LOG($level, \"$prefix";
}

while (<STDIN>) {
AGAIN:
    # replace DEBUG() by DBG()
    s/DEBUG\(/DBG\(/g;

    # ...in case the statement spans more lines
    if (/(DBG|INFO|NOTICE|WARN|ERR|BUG|ALERT)\(\s*$/ || /LOG\(([^,]*,)?\s*$/) {
        $_ .= <STDIN>;
        goto AGAIN;
    }

    # one common special case used in several modules
    if ($module_name) {
	s/LOG\(\s*([^,]+)\s*,\s*MODULE_NAME\s*"\s*:\s*/LOG($1, "/g;
	s/(DBG|INFO|NOTICE|WARN|ERR|BUG|ALERT)\(\s*MODULE_NAME\s*"\s*:\s*/$1("/g;
    }

    # module name and level prefix removing magic, may change macro level
    # if different one found in the message
    $id='\s*[a-zA-Z0-9_]+\s*';
    
    s/LOG\(\s*(([A-Z_]+)|[^,]+)\s*,\s*"($id):(($id):(($id):)?)?(\s*)/
        fix_log($1, $3, $5, $7, $8);
    /eg;

    s/(DBG|INFO|NOTICE|WARN|ERR|BUG|ALERT)\(\s*"($id):(($id):(($id):)?)?(\s*)/
        $1 = "CRIT" if $1 eq "BUG";
        fix_log("L_$1", $2, $4, $6, $7);
    /eg;

    # prefer shorter static-level macros
    s/LOG\(\s*L_(DBG|INFO|NOTICE|WARN|ERR|CRIT|ALERT)\s*,\s*/
	$1 = "BUG" if $1 eq "CRIT";
	"$1\(";
    /eg;

    print;
}