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 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389
|
package Log::ger::Util;
use strict;
use warnings;
our $AUTHORITY = 'cpan:PERLANCAR'; # AUTHORITY
our $DATE = '2023-12-29'; # DATE
our $DIST = 'Log-ger'; # DIST
our $VERSION = '0.042'; # VERSION
require Log::ger;
require Log::ger::Heavy;
sub _dump {
unless ($Log::ger::_dumper) {
eval {
no warnings 'once';
require Data::Dmp;
$Data::Dmp::OPT_REMOVE_PRAGMAS = 1;
1;
};
if ($@) {
no warnings 'once';
require Data::Dumper;
$Log::ger::_dumper = sub {
local $Data::Dumper::Terse = 1;
local $Data::Dumper::Indent = 0;
local $Data::Dumper::Useqq = 1;
local $Data::Dumper::Deparse = 1;
local $Data::Dumper::Quotekeys = 0;
local $Data::Dumper::Sortkeys = 1;
local $Data::Dumper::Trailingcomma = 1;
local $Data::Dumper::Useqq = 1; # to show "\034", possible bug in Data::Dumper
Data::Dumper::Dumper($_[0]);
};
} else {
$Log::ger::_dumper = sub { Data::Dmp::dmp($_[0]) };
}
}
$Log::ger::_dumper->($_[0]);
}
sub numeric_level {
my $level = shift;
return $level if $level =~ /\A\d+\z/;
return $Log::ger::Levels{$level}
if defined $Log::ger::Levels{$level};
return $Log::ger::Level_Aliases{$level}
if defined $Log::ger::Level_Aliases{$level};
die "Unknown level '$level'";
}
sub string_level {
my $level = shift;
return $level if defined $Log::ger::Levels{$level};
$level = $Log::ger::Level_Aliases{$level}
if defined $Log::ger::Level_Aliases{$level};
for (keys %Log::ger::Levels) {
my $v = $Log::ger::Levels{$_};
return $_ if $v == $level;
}
die "Unknown level '$level'";
}
sub set_level {
no warnings 'once';
$Log::ger::Current_Level = numeric_level(shift);
reinit_all_targets();
}
sub _action_on_hooks {
no warnings 'once';
my ($action, $target_type, $target_name, $phase) = splice @_, 0, 4;
my $hooks = $Log::ger::Global_Hooks{$phase} or die "Unknown phase '$phase'";
if ($target_type eq 'package') {
$hooks = ($Log::ger::Per_Package_Hooks{$target_name}{$phase} ||= []);
} elsif ($target_type eq 'object') {
my ($addr) = $target_name =~ $Log::ger::re_addr;
$hooks = ($Log::ger::Per_Object_Hooks{$addr}{$phase} ||= []);
} elsif ($target_type eq 'hash') {
my ($addr) = $target_name =~ $Log::ger::re_addr;
$hooks = ($Log::ger::Per_Hash_Hooks{$addr}{$phase} ||= []);
}
if ($action eq 'add') {
my $hook = shift;
# XXX remove duplicate key
# my $key = $hook->[0];
unshift @$hooks, $hook;
} elsif ($action eq 'remove') {
my $code = shift;
for my $i (reverse 0..$#{$hooks}) {
splice @$hooks, $i, 1 if $code->($hooks->[$i]);
}
} elsif ($action eq 'reset') {
my $saved = [@$hooks];
splice @$hooks, 0, scalar(@$hooks),
@{ $Log::ger::Default_Hooks{$phase} };
return $saved;
} elsif ($action eq 'empty') {
my $saved = [@$hooks];
splice @$hooks, 0;
return $saved;
} elsif ($action eq 'save') {
return [@$hooks];
} elsif ($action eq 'restore') {
my $saved = shift;
splice @$hooks, 0, scalar(@$hooks), @$saved;
return $saved;
}
}
sub add_hook {
my ($phase, $hook) = @_;
_action_on_hooks('add', '', undef, $phase, $hook);
}
sub add_per_target_hook {
my ($target_type, $target_name, $phase, $hook) = @_;
_action_on_hooks('add', $target_type, $target_name, $phase, $hook);
}
sub remove_hook {
my ($phase, $code) = @_;
_action_on_hooks('remove', '', undef, $phase, $code);
}
sub remove_per_target_hook {
my ($target_type, $target_name, $phase, $code) = @_;
_action_on_hooks('remove', $target_type, $target_name, $phase, $code);
}
sub reset_hooks {
my ($phase) = @_;
_action_on_hooks('reset', '', undef, $phase);
}
sub reset_per_target_hooks {
my ($target_type, $target_name, $phase) = @_;
_action_on_hooks('reset', $target_type, $target_name, $phase);
}
sub empty_hooks {
my ($phase) = @_;
_action_on_hooks('empty', '', undef, $phase);
}
sub empty_per_target_hooks {
my ($target_type, $target_name, $phase) = @_;
_action_on_hooks('empty', $target_type, $target_name, $phase);
}
sub save_hooks {
my ($phase) = @_;
_action_on_hooks('save', '', undef, $phase);
}
sub save_per_target_hooks {
my ($target_type, $target_name, $phase) = @_;
_action_on_hooks('save', $target_type, $target_name, $phase);
}
sub restore_hooks {
my ($phase, $saved) = @_;
_action_on_hooks('restore', '', undef, $phase, $saved);
}
sub restore_per_target_hooks {
my ($target_type, $target_name, $phase, $saved) = @_;
_action_on_hooks('restore', $target_type, $target_name, $phase, $saved);
}
sub reinit_target {
my ($target_type, $target_name) = @_;
# adds target if not already exists
Log::ger::add_target($target_type, $target_name, {}, 0);
if ($target_type eq 'package') {
my $per_target_conf = $Log::ger::Package_Targets{$target_name};
Log::ger::init_target(package => $target_name, $per_target_conf);
} elsif ($target_type eq 'object') {
my ($obj_addr) = $target_name =~ $Log::ger::re_addr
or die "Invalid object '$target_name': not a reference";
my $v = $Log::ger::Object_Targets{$obj_addr}
or die "Unknown object target '$target_name'";
Log::ger::init_target(object => $v->[0], $v->[1]);
} elsif ($target_type eq 'hash') {
my ($hash_addr) = $target_name =~ $Log::ger::re_addr
or die "Invalid hashref '$target_name': not a reference";
my $v = $Log::ger::Hash_Targets{$hash_addr}
or die "Unknown hash target '$target_name'";
Log::ger::init_target(hash => $v->[0], $v->[1]);
} else {
die "Unknown target type '$target_type'";
}
}
sub reinit_all_targets {
for my $pkg (keys %Log::ger::Package_Targets) {
#print "D:reinit package $pkg\n";
Log::ger::init_target(
package => $pkg, $Log::ger::Package_Targets{$pkg});
}
for my $k (keys %Log::ger::Object_Targets) {
my ($obj, $per_target_conf) = @{ $Log::ger::Object_Targets{$k} };
Log::ger::init_target(object => $obj, $per_target_conf);
}
for my $k (keys %Log::ger::Hash_Targets) {
my ($hash, $per_target_conf) = @{ $Log::ger::Hash_Targets{$k} };
Log::ger::init_target(hash => $hash, $per_target_conf);
}
}
sub set_plugin {
my %args = @_;
my $hooks;
if ($args{hooks}) {
$hooks = $args{hooks};
} else {
no strict 'refs'; ## no critic: TestingAndDebugging::ProhibitNoStrict
my $prefix = $args{prefix} || 'Log::ger::Plugin::';
my $mod = $args{name};
$mod = $prefix . $mod unless index($mod, $prefix) == 0;
(my $mod_pm = "$mod.pm") =~ s!::!/!g;
require $mod_pm;
my $meta = $mod->can("meta") ? $mod->meta : {v=>1};
my $v = $meta->{v} || 1;
# history of v bumping:
#
# - v increased from 1 to 2 in Log::ger v0.037 to force all plugins that
# were not compatible with Log::ger 0.032 (removed
# create_logml_routine phase) to be upgraded.
unless ($v == 2) {
die "Plugin '$mod' (version ".(${"$mod\::VERSION"} || "dev").")".
" follows meta version $v but Log::ger (version ".
(${__PACKAGE__."::VERSION"} || "dev").
") (>0.032) requires meta version 2, ".
"please upgrade the plugin first";
}
$hooks = &{"$mod\::get_hooks"}(%{ $args{conf} || {} });
}
{
last unless $args{replace_package_regex};
my $all_hooks;
if (!$args{target}) {
$all_hooks = \%Log::ger::Global_Hooks;
} elsif ($args{target} eq 'package') {
$all_hooks = $Log::ger::Per_Package_Hooks{ $args{target_arg} };
} elsif ($args{target} eq 'object') {
my ($addr) = $args{target_arg} =~ $Log::ger::re_addr;
$all_hooks = $Log::ger::Per_Object_Hooks{$addr};
} elsif ($args{target} eq 'hash') {
my ($addr) = $args{target_arg} =~ $Log::ger::re_addr;
$all_hooks = $Log::ger::Per_Hash_Hooks{$addr};
}
last unless $all_hooks;
for my $phase (keys %$all_hooks) {
my $hooks = $all_hooks->{$phase};
for my $i (reverse 0..$#{$hooks}) {
splice @$hooks, $i, 1
if $hooks->[$i][0] =~ $args{replace_package_regex};
}
}
}
for my $phase (keys %$hooks) {
my $hook = $hooks->{$phase};
if (defined $args{target}) {
add_per_target_hook(
$args{target}, $args{target_arg}, $phase, $hook);
} else {
add_hook($phase, $hook);
}
}
my $reinit = $args{reinit};
$reinit = 1 unless defined $reinit;
if ($reinit) {
if (defined $args{target}) {
reinit_target($args{target}, $args{target_arg});
} else {
reinit_all_targets();
}
}
}
1;
# ABSTRACT: Utility routines for Log::ger
__END__
=pod
=encoding UTF-8
=head1 NAME
Log::ger::Util - Utility routines for Log::ger
=head1 VERSION
version 0.042
=head1 DESCRIPTION
This package is created to keep Log::ger as minimalist as possible.
=head1 FUNCTIONS
None of these functions are exported.
=head2 numeric_level
Usage:
my $num = Log::ger::Util::numeric_level($level);
If given a non-negative integer, will return the number as-is. Otherwise will
convert the argument, assumed to be a string level, to the associated numeric
level. Will die on failure.
=head2 string_level
Usage:
my $str_level = Log::ger::Util::string_level($level);
If given a known string level, will return the string as-is. Otherwise will
convert the argument, assumed to be a number, to the associated string level.
Will die on failure.
=head2 set_level
Usage:
Log::ger::Util::set_level($level);
Set log level to C<$level>, which can be a string or numeric level. Will die on
failure.
=head2 add_hook
=head2 add_per_target_hook
=head2 remove_hook
=head2 remove_per_target_hook
=head2 reset_hooks
=head2 reset_per_target_hooks
=head2 empty_hooks
=head2 empty_per_target_hooks
=head2 save_hooks
=head2 save_per_target_hooks
=head2 restore_hooks
=head2 restore_per_target_hooks
=head2 reinit_target
=head2 reinit_all_targets
=head2 set_plugin
=head1 AUTHOR
perlancar <perlancar@cpan.org>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2023, 2022, 2020, 2019, 2018, 2017 by perlancar <perlancar@cpan.org>.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut
|