Mail/Make/Headers/Generic.pm

filter: Statementstmt 74.1% 86 / 116 Branchbran 40.0% 16 / 40 Conditioncond 44.0% 11 / 25 MC/DCmcdc 13.3% 2 / 15 Subroutinesub 74.1% 23 / 31 Podpod 75.0% 6 / 8 totaltotal 61.2% 144 / 235 CC 31 SCAR 23.6
CC
31
Cov
62%
_filename_decode
56.0
_set_get_params
20.0
_set_get_param
6.3
CRAP 10.5
« Mail/Make/Headers.pm ↑ Summary Mail/Make/Headers/MessageID.pm »
1 ##----------------------------------------------------------------------------
2 ## MIME Email Builder - ~/lib/Mail/Make/Headers/Generic.pm
3 ## Version v0.1.0
4 ## Copyright(c) 2026 DEGUEST Pte. Ltd.
5 ## Author: Jacques Deguest <jack@deguest.jp>
6 ## Created 2026/03/02
7 ## Modified 2026/03/02
8 ## All rights reserved.
9 ##
10 ## This program is free software; you can redistribute it and/or modify it
11 ## under the same terms as Perl itself.
12 ##----------------------------------------------------------------------------
13 package Mail::Make::Headers::Generic;
14 BEGIN
15 11 ▶{
Subroutine BEGIN: called CC=1 SCAR=0.0
16 11 ▶ use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
17 11 ▶ use warnings;
Subroutine BEGIN: called CC=1 SCAR=0.0
18 11 warnings::register_categories( 'Mail::Make' );
19 11 ▶ use parent qw( Module::Generic );
Subroutine BEGIN: called CC=1 SCAR=0.0
20 11 ▶ use vars qw( $VERSION $EXCEPTION_CLASS );
Subroutine BEGIN: called CC=1 SCAR=0.0
21 11 ▶ use Encode ();
Subroutine BEGIN: called CC=1 SCAR=0.0
22 11 ▶ use Mail::Make::Exception;
Subroutine BEGIN: called CC=1 SCAR=0.0
23 11 ▶ use URI::Escape::XS ();
Subroutine BEGIN: called CC=1 SCAR=0.0
24 11 ▶ use overload (
Subroutine BEGIN: called CC=1 SCAR=0.0
25 '""' => 'as_string',
26 761 ▶ 'bool' => sub{1},
Subroutine __ANON__: called CC=1 SCAR=0.0
27 11 );
28 11 our $EXCEPTION_CLASS = 'Mail::Make::Exception';
29 11 our $VERSION = 'v0.1.0';
30 };
31  
32 11 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
33 11 ▶use warnings;
Subroutine BEGIN: called CC=1 SCAR=0.0
34  
35 sub init
36 263 ▶{
Subroutine init: called CC=2 SCAR=7.0
Pod documented
37 263 my $self = shift( @_ );
38 263 $self->{_exception_class} = $EXCEPTION_CLASS;
39 263 ▶ $self->SUPER::init( @_ ) || return( $self->pass_error );
Branch: 1 branch
BranchTrueFalseTotal
$self->SUPER::init(@_) or return $self->pass_error 263 0 263
40 263 return( $self );
41 }
42  
43 0 ▶sub as_string { return( shift->_hv_as_string( @_ ) ); }
Subroutine as_string: not called CC=1 SCAR=6.9
Pod documented
44  
45 2 ▶sub field_name { return( shift->_set_get_scalar( '_field_name', @_ ) ); }
Subroutine field_name: called CC=1 SCAR=0.0
Pod documented
46  
47 173 ▶sub param { return( shift->_set_get_param( @_ ) ); }
Subroutine param: called CC=1 SCAR=0.0
Pod documented
48  
49 0 ▶sub params { return( shift->_set_get_params( @_ ) ); }
Subroutine params: not called CC=1 SCAR=6.9
Pod documented
50  
51 0 ▶sub value { return( shift->_set_get_scalar( '_value', @_ ) ); }
Subroutine value: not called CC=1 SCAR=6.9
Pod documented
52  
53 263 ▶sub _field_name { return( shift->_set_get_scalar( '_field_name', @_ ) ); }
Subroutine _field_name: called CC=1 SCAR=0.0
54  
55 # rfc2231 filename decoding
56 # Accepts UTF-8'lang'encoded or plain value
57 # Returns decoded string
58 sub _filename_decode
59 0 ▶{
Subroutine _filename_decode: not called CC=7 SCAR=40.3
60 0 my $self = shift( @_ );
61 0 my $fname = shift( @_ );
62 0 ▶ return( $fname ) if( !defined( $fname ) || !length( $fname ) );
Branch: 1 branch
BranchTrueFalseTotal
unless defined $fname and length $fname 0 0 0
Condition0%0/3
defined $fname and length $fname
!ll&&!rl&&r
000
MC/DC0%0/2
defined $fname and length $fname
defined $fname length $fname
Truth table0%0/3
A and B
A= defined $fnameB= length $fname
ABresult
0X0
100
111
63 # rfc2231 extended notation: charset'language'encoded
64 0 ▶ if( $fname =~ /^([A-Za-z0-9\-]+)'([^']*)'(.+)$/ )
Branch: 1 branch
BranchTrueFalseTotal
if ($fname =~ /^([A-Za-z0-9\-]+)'([^']*)'(.+)$/) 0 0 0
65 {
66 0 my( $charset, $lang, $encoded ) = ( $1, $2, $3 );
67 0 my $decoded = URI::Escape::XS::uri_unescape( $encoded );
68 # try-catch
69 0 local $@;
70 eval
71 0 {
72 0 $decoded = Encode::decode( $charset, $decoded );
73 };
74 0 ▶ if( $@ )
Branch: 1 branch
BranchTrueFalseTotal
if ($@) 0 0 0
75 {
76 0 return( $fname );
77 }
78 0 ▶ return( wantarray() ? ( $decoded, $charset, $lang ) : $decoded );
Branch: 1 branch
BranchTrueFalseTotal
wantarray ? : 0 0 0
79 }
80 0 ▶ return( wantarray() ? ( $fname, undef, undef ) : $fname );
Branch: 1 branch
BranchTrueFalseTotal
wantarray ? : 0 0 0
81 }
82  
83 # rfc2231 / rfc5987 filename encoding
84 # Returns encoded string such as UTF-8''Yamato%2CInc-Logo.png
85 # Returns undef if no encoding needed (pure ASCII, no special chars)
86 sub _filename_encode
87 36 ▶{
Subroutine _filename_encode: called CC=4 SCAR=13.9
88 36 my $self = shift( @_ );
89 36 my $fname = shift( @_ );
90 36 my $lang = shift( @_ );
91 # Contains non-ASCII or RFC 2045 special chars that require quoting/encoding
92 36 ▶ if( $fname =~ /[^\x20-\x7E]/ || $fname =~ /[()<>@,;:\\"\/\[\]?=]/ )
Branch: 1 branch
BranchTrueFalseTotal
if ($fname =~ /[^\x20-\x7E]/ or $fname =~ m([()<>\@,;:\\"/\[\]?=])) 7 29 36
Condition100%3/3
$fname =~ /[^\x20-\x7E]/ or $fname =~ m([()<>\@,;:\\"/\[\]?=])
l!l&&r!l&&!r
2529
MC/DC100%2/2
$fname =~ /[^\x20-\x7E]/ or $fname =~ m([()<>\@,;:\\"/\[\]?=])
$fname =~ /[^\x20-\x7E]/ $fname =~ m([()<>\@,;:\\"/\[\]?=])
Truth table100%3/3
A or B
A= $fname =~ /[^\x20-\x7E]/B= $fname =~ m([()<>\@,;:\\"/\[\]?=])
ABresult
1X1
011
000
93 {
94 7 ▶ $lang = '' if( !defined( $lang ) );
Branch: 1 branch
BranchTrueFalseTotal
unless defined $lang 6 1 7
95 7 my $encoded = URI::Escape::XS::uri_escape( Encode::encode( 'UTF-8', $fname ) );
96 7 return( sprintf( "UTF-8'%s'%s", $lang, $encoded ) );
97 }
98 # Pure safe ASCII: caller should use simple quoting if needed
99 29 return;
100 }
101  
102 804 ▶sub _hv { return( shift->_set_get_object_without_init( '_hv', 'Module::Generic::HeaderValue', @_ ) ); }
Subroutine _hv: called CC=1 SCAR=0.0
103  
104 sub _hv_as_string
105 237 ▶{
Subroutine _hv_as_string: called CC=2 SCAR=7.0
106 237 my $self = shift( @_ );
107 237 my $hv = $self->_hv;
108 237 ▶ return( '' ) if( !$hv );
Branch: 1 branch
BranchTrueFalseTotal
unless $hv 0 237 237
109 237 return( $hv->as_string( @_ ) );
110 }
111  
112 sub _new_hv
113 1 ▶{
Subroutine _new_hv: called CC=2 SCAR=7.1
114 1 my $self = shift( @_ );
115 1 ▶ $self->_load_class( 'Module::Generic::HeaderValue' ) || return( $self->pass_error );
Branch: 1 branch
BranchTrueFalseTotal
$self->_load_class("Module::Generic::HeaderValue") or return $self->pass_error 1 0 1
116 1 return( Module::Generic::HeaderValue->new( @_ ) );
117 }
118  
119 sub _parse_header_value
120 261 ▶{
Subroutine _parse_header_value: called CC=5 SCAR=17.8
121 261 my $self = shift( @_ );
122 261 my $this = shift( @_ );
123 261 ▶ return( $self->error( "No header value was provided to parse." ) )
Branch: 1 branch
BranchTrueFalseTotal
unless defined $this and length "$this" 0 261 261
Condition33%1/3
defined $this and length "$this"
!ll&&!rl&&r
00261
MC/DC0%0/2
defined $this and length "$this"
defined $this length "$this"
Truth table33%1/3
A and B
A= defined $thisB= length "$this"
ABresult
0X0
100
111
124 if( !defined( $this ) || !length( "$this" ) );
125 261 ▶ $self->_load_class( 'Module::Generic::HeaderValue' ) || return( $self->pass_error );
Branch: 1 branch
BranchTrueFalseTotal
$self->_load_class("Module::Generic::HeaderValue") or return $self->pass_error 261 0 261
126 261 ▶ my $hv = Module::Generic::HeaderValue->new_from_header( $this, @_ ) ||
Condition50%1/2
'Module::Generic::HeaderValue'->new_from_header($this, @_) || (return $self->pass_error('Module::Generic::HeaderValue'->error))
l!l
2610
MC/DC0%0/1
'Module::Generic::HeaderValue'->new_from_header($this, @_) || (return $self->pass_error('Module::Generic::HeaderValue'->error))
'Module::Generic::HeaderValue'->new_from_header($this, @_)
Truth table50%1/2
A
A= 'Module::Generic::HeaderValue'->new_from_header($this, @_)
Aresult
11
00
127 return( $self->pass_error( Module::Generic::HeaderValue->error ) );
128 261 return( $hv );
129 }
130  
131 sub _set_get_param
132 197 ▶{
Subroutine _set_get_param: called CC=6 SCAR=18.5
133 197 my $self = shift( @_ );
134 197 ▶ my $name = shift( @_ ) || return( $self->error( "No parameter name was provided." ) );
Condition50%1/2
shift @_ || (return $self->error('No parameter name was provided.'))
l!l
1970
MC/DC0%0/1
shift @_ || (return $self->error('No parameter name was provided.'))
shift @_
Truth table50%1/2
A
A= shift @_
Aresult
11
00
135 197 my $hv = $self->_hv;
136 197 ▶ return( '' ) if( !scalar( @_ ) && !$hv );
Branch: 1 branch
BranchTrueFalseTotal
unless scalar @_ or $hv 0 197 197
Condition66%2/3
scalar @_ or $hv
l!l&&r!l&&!r
18980
MC/DC0%0/2
scalar @_ or $hv
scalar @_ $hv
Truth table66%2/3
A or B
A= scalar @_B= $hv
ABresult
1X1
011
000
137 197 ▶ return( $self->error( "Header value object (Module::Generic::HeaderValue) could not be found!" ) ) if( !$hv );
Branch: 1 branch
BranchTrueFalseTotal
unless $hv 0 197 197
138 197 ▶ if( @_ )
Branch: 1 branch
BranchTrueFalseTotal
if (@_) 189 8 197
139 {
140 189 $hv->param( $name => shift( @_ ) );
141 }
142 197 return( $hv->param( $name ) );
143 }
144  
145 sub _set_get_params
146 0 ▶{
Subroutine _set_get_params: not called CC=4 SCAR=30.0
147 0 my $self = shift( @_ );
148 0 ▶ my $hv = $self->_hv || return( $self->error( "Header value object could not be found!" ) );
Condition0%0/2
$self->_hv || (return $self->error('Header value object could not be found!'))
l!l
00
MC/DC0%0/1
$self->_hv || (return $self->error('Header value object could not be found!'))
$self->_hv
Truth table0%0/2
A
A= $self->_hv
Aresult
11
00
149 0 my $params = $hv->params;
150 0 ▶ if( @_ )
Branch: 1 branch
BranchTrueFalseTotal
if (@_) { } 0 0 0
151 {
152 0 ▶ while( my( $n, $v ) = splice( @_, 0, 2 ) )
Branch: 1 branch
BranchTrueFalseTotal
if (() = splice(@_, 0, 2)) 0 0 0
153 {
154 0 $params->set( $n => $v );
155 }
156 }
157 else
158 {
159 0 return( $params );
160 }
161 }
162  
163 # Same as _set_get_param but wraps value in double quotes on store,
164 # strips them on retrieve
165 sub _set_get_qparam
166 30 ▶{
Subroutine _set_get_qparam: called CC=6 SCAR=18.4
167 30 my $self = shift( @_ );
168 30 ▶ my $name = shift( @_ ) || return( $self->error( "No parameter name was provided." ) );
Condition50%1/2
shift @_ || (return $self->error('No parameter name was provided.'))
l!l
300
MC/DC0%0/1
shift @_ || (return $self->error('No parameter name was provided.'))
shift @_
Truth table50%1/2
A
A= shift @_
Aresult
11
00
169 30 ▶ my $hv = $self->_hv || return( $self->error( "Header value object could not be found!" ) );
Condition50%1/2
$self->_hv || (return $self->error('Header value object could not be found!'))
l!l
300
MC/DC0%0/1
$self->_hv || (return $self->error('Header value object could not be found!'))
$self->_hv
Truth table50%1/2
A
A= $self->_hv
Aresult
11
00
170 30 my $v;
171 30 ▶ if( @_ )
Branch: 1 branch
BranchTrueFalseTotal
if (@_) { } 29 1 30
172 {
173 29 $v = shift( @_ );
174 29 $v =~ s/^\"//;
175 29 $v =~ s/(?<!\\)\"$//;
176 29 $hv->param( $name => qq{"${v}"} );
177 }
178 else
179 {
180 1 $v = $hv->param( $name );
181 1 ▶ return( '' ) if( !defined( $v ) || !length( "$v" ) );
Branch: 1 branch
BranchTrueFalseTotal
unless defined $v and length "$v" 0 1 1
Condition33%1/3
defined $v and length "$v"
!ll&&!rl&&r
001
MC/DC0%0/2
defined $v and length "$v"
defined $v length "$v"
Truth table33%1/3
A and B
A= defined $vB= length "$v"
ABresult
0X0
100
111
182 1 $v =~ s/^\"//;
183 1 $v =~ s/(?<!\\)\"$//;
184 }
185 30 return( $v );
186 }
187  
188 sub _set_get_value
189 0 ▶{
Subroutine _set_get_value: not called CC=2 SCAR=17.9
190 0 my $self = shift( @_ );
191 0 my $hv = $self->_hv;
192 0 ▶ if( @_ )
Branch: 1 branch
BranchTrueFalseTotal
if (@_) 0 0 0
193 {
194 0 $hv->value( shift( @_ ) );
195 }
196 0 return( $hv->value_data );
197 }
198  
199 # NOTE: STORABLE support
200 0 ▶sub STORABLE_freeze { CORE::return( CORE::shift->FREEZE( @_ ) ); }
Subroutine STORABLE_freeze: not called CC=1 SCAR=6.9
Pod undocumented
201  
202 0 ▶sub STORABLE_thaw { CORE::return( CORE::shift->THAW( @_ ) ); }
Subroutine STORABLE_thaw: not called CC=1 SCAR=6.9
Pod undocumented
203  
204 11 1;
205 # NOTE: POD
206 __END__
« Mail/Make/Headers.pm ↑ Summary Mail/Make/Headers/MessageID.pm »