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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
|
# vim: set et ts=4 sw=4:
package ManaTools::Shared::Logging;
#============================================================= -*-perl-*-
=head1 NAME
ManaTools::Shared::Logging - Class to manage logging
=head1 SYNOPSIS
use ManaTools::Shared::Logging;
my $obj = ManaTools::Shared::Logging->new(loc => $loc);
$obj->D("debug test string %d", 1) . "\n";
$obj->I("info test string %d", 2) . "\n";
$obj->W("warning test string %d", 3) . "\n";
$obj->E("error test string %d", 4) . "\n";
=head1 DESCRIPTION
This class wraps Sys::Syslog to manage logging
=head1 SUPPORT
You can find documentation for this module with the perldoc command:
perldoc ManaTools::Shared::Logging
=head1 SEE ALSO
Sys::Syslog
=head1 AUTHOR
Maarten Vanraes <alien@rmail.be>
=head1 COPYRIGHT and LICENSE
Copyright (C) 2015, Maarten Vanraes.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License version 2, as
published by the Free Software Foundation.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
=head1 FUNCTIONS
=cut
use Moose;
use diagnostics;
use utf8;
use Sys::Syslog;
use ManaTools::Shared::Locales;
#=============================================================
=head2 new
=head3 INPUT
hash ref containing
loc: optional ManaTools::Shared::Locales to translate before logging
=head3 DESCRIPTION
new is inherited from Moose, to create a Logging object
=cut
#=============================================================
has 'loc' => (
is => 'rw',
isa => 'ManaTools::Shared::Locales',
lazy => 1,
default => sub {
return ManaTools::Shared::Locales->new();
}
);
#=============================================================
=head2 R
=head3 INPUT
$self: this object
$syslog: syslog class and priority
$s: text
=head3 DESCRIPTION
outputs a string to syslog with given class and priority
=cut
#=============================================================
sub R {
my $self = shift;
my $syslog = shift;
my $s = shift;
Sys::Syslog::syslog($syslog, $s);
}
#=============================================================
=head2 P
=head3 INPUT
$self: this object
$syslog: syslog class and priority
$s_singular: msg id singular
$s_plural: msg id plural
$nb: value for plural
=head3 DESCRIPTION
outputs the given string localized (see dngettext) to syslog
with the given class and priority
=cut
#=============================================================
sub P {
my ($self, $syslog, $s_singular, $s_plural, $nb, @para) = @_;
$self->R($syslog, $self->loc->P($s_singular, $s_plural, $nb, @para));
}
#=============================================================
=head2 S
=head3 INPUT
$self: this object
$syslog: syslog class and priority
$s: text
=head3 DESCRIPTION
outputs a localized string to syslog with given class and priority
=cut
#=============================================================
sub S {
my ($self, $syslog, $s, @para) = @_;
$self->R($syslog, $self->loc->N($s, @para));
}
#=============================================================
=head2 I
=head3 INPUT
$self: this object
$s: text
=head3 DESCRIPTION
outputs a localized string to syslog as info|local1
=cut
#=============================================================
sub I {
my ($self, $s, @para) = @_;
$self->S('info|local1', $s, @para);
}
#=============================================================
=head2 W
=head3 INPUT
$self: this object
$s: text
=head3 DESCRIPTION
outputs a localized string to syslog as warning
=cut
#=============================================================
sub W {
my ($self, $s, @para) = @_;
$self->S('warning', $s, @para);
}
#=============================================================
=head2 E
=head3 INPUT
$self: this object
$s: text
=head3 DESCRIPTION
outputs a localized string to syslog as err
=cut
#=============================================================
sub E {
my ($self, $s, @para) = @_;
$self->S('err', $s, @para);
}
#=============================================================
=head2 D
=head3 INPUT
$self: this object
$s: text
=head3 DESCRIPTION
outputs a localized string to syslog as debug
=cut
#=============================================================
sub D {
my ($self, $s, @para) = @_;
$self->S('debug', $s, @para);
}
no Moose;
__PACKAGE__->meta->make_immutable;
1;
|
