Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Many builtin built-in functions accept a regex pattern as an argument. Furthermore, any subroutine can accept a string , yet treat it as a regex pattern. Because regex patterns are encoded as regular strings, it is tempting to assume that a string literal will be treated as if a regex that matched only that string literal was supplied. This can lead to unexpected function behavior if the string contains characters that have special meanings when the string is treated as a regex pattern. Therefore, do not pass strings that are not clearly regex patterns to a function that takes a regex.

...

Code Block
bgColor#ffcccc
langperl

my $data = 'Tom$Dick$Harry';
my @names = split( '$', $data);

...

This compliant solution passes a regex pattern to split() as the first argument, properly specifying $ as a raw character. SonsequentlyConsequently, @names is assigned the three names: Tom, Dick, and Harry.

Code Block
bgColor#ccccff
langperl

my $data = 'Tom$Dick$Harry';
my @names = split( m/\$/, $data);

...

STR31-EX0: A string literal may be passed to a function if it normally takes a regex pattern , but provides special behavior for that string. For example, the perlfunc manpage [Wall 2011] says, regarding PATTERN, the first argument to split():{quote}}

As a special case, specifying a PATTERN of space (' ') will split on white space just as "split" with no arguments does. Thus, "split(' ')" can be used to emulate awk's default behavior, whereas "split(/ /)" will give you as many initial null fields (empty string) as there are leading spaces.

...

 

Risk Assessment

Recommendation

Severity

Likelihood

Remediation Cost

Priority

Level

STR31-PL

low

likely

low

P9

L2

 

Automated Detection

Tool

Diagnostic

Perl::Critic

BuiltinFunctions::ProhibitStringySplit

...