Advanced-Config
view release on metacpan or search on metacpan
lib/Advanced/Config/Reader.pm view on Meta::CPAN
F<Advanced::Config::Reader> is a helper module to L<Advanced::Config>. So it
should be very rare to directly call any methods defined by this module.
This module manages reading the requested config file into memory and parsing
it for use by L<Advanced::Config>.
Each config file is highly customizable. Where you are allowed to alter the
comment char from B<#> to anything you like, such as B<;;>. The same is true
for things like the assignment operator (B<=>), and many other character
sequences with special meaning to this module.
So to avoid confusion, when I talk about a feature, I'll talk about it's default
appearance and let it be safely assumed that the same will hold true if you've
overridden it's default character sequence with something else. Such as when
discussing comments as 'B<#>', even though you could have overridden it as
'B<;*;>'. See L<Advanced::Config::Options> for a list of symbols you can
overrides.
You are also allowed to surround your values with balanced quotes or leave them
off entirely. The only time you must surround your value with quotes is when
you want to preserve leading or trailing spaces in your value. Without balanced
quotes these spaces are trimmed off. Also if you need a comment symbol in your
tag's value, the entire value must be surrounded by quotes! Finally, unbalanced
quotes can behave very strangly and are not stripped off.
So in general white space in your config file is basically ignored unless it's
surrounded by printable chars or quotes.
Sorry you can't use a comment symbol as part of your tag's name.
See L<Advanced::Config::Examples> for some sample config files. You may also
find a lot of example config files in the package you downloaded from CPAN to
install this module from under I<t/config>.
=head1 FUNCTIONS
=over 4
=cut
package Advanced::Config::Reader;
use strict;
use warnings;
use vars qw( @ISA @EXPORT @EXPORT_OK $VERSION );
use Exporter;
use Advanced::Config::Options;
use Advanced::Config;
use Fred::Fish::DBUG 2.09 qw / on_if_set ADVANCED_CONFIG_FISH /;
use File::Basename;
$VERSION = "1.14";
@ISA = qw( Exporter );
@EXPORT = qw( read_config source_file make_new_section parse_line
expand_variables apply_modifier parse_for_variables
format_section_line format_tag_value_line format_encrypt_cmt
encrypt_config_file_details decrypt_config_file_details );
@EXPORT_OK = qw( );
my $skip_warns_due_to_make_test;
my %global_sections;
my $gUserName;
# ==============================================================
# NOTE: It is extreemly dangerous to reference Advanced::Config
# internals in this code. Avoid where possible!!!
# Ask for copies from the module instead.
# ==============================================================
# Any other module initialization done here ...
# This block references initializations done in my other modules.
BEGIN
{
DBUG_ENTER_FUNC ();
# What we call our default section ...
$global_sections{DEFAULT} = Advanced::Config::Options::DEFAULT_SECTION_NAME;
$global_sections{OVERRIDE} = $global_sections{DEFAULT};
$gUserName = Advanced::Config::Options::_get_user_id ();
# Is the code being run via "make test" environment ...
if ( $ENV{PERL_DL_NONLAZY} ||
$ENV{PERL_USE_UNSAFE_INC} ||
$ENV{HARNESS_ACTIVE} ) {
$skip_warns_due_to_make_test = 1;
}
DBUG_VOID_RETURN ();
}
# ==============================================================
# No fish please ... (called way too often)
# This method is called in 2 ways:
# 1) By parse_line() to determine if ${ln} is a tag/value pair.
# 2) By everyone else to parse a known tag/value pair in ${ln}.
#
# ${ln} is in one of these 3 formats if it's a tag/value pair.
# tag = value
# export tag = value # Unix shell scripts
# set tag = value # Windows Batch files
sub _split_assign
{
my $rOpts = shift; # The read options ...
my $ln = shift; # The value to split ...
my $skip = shift; # Skip massaging the tag?
my ( $tag, $value );
if ( is_assign_spaces ( $rOpts ) ) {
( $tag, $value ) = split ( " ", $ln, 2 );
$skip = 1; # This separator doesn't support the prefixes.
} else {
my $assign_str = convert_to_regexp_string ($rOpts->{assign}, 1);
lib/Advanced/Config/Reader.pm view on Meta::CPAN
my $hide_str = convert_to_regexp_string ($opts->{hide_lbl});
my $sect_str = convert_to_regexp_string ($opts->{source_file_section_lbl});
my $export_str = convert_to_regexp_string ($opts->{export_lbl});
my ($lb, $rb) = ( convert_to_regexp_string ($opts->{section_left}),
convert_to_regexp_string ($opts->{section_right}) );
my $assign_str = convert_to_regexp_string ($opts->{assign});
my $src_str = convert_to_regexp_string ($opts->{source});
my ($lv, $rv) = ( convert_to_regexp_string ($opts->{variable_left}),
convert_to_regexp_string ($opts->{variable_right}) );
# The label separators used when searching for option labels in a comment ...
my $lbl_sep = '[\s.,$!()-]';
# Initialize to the default secion ...
my $section = make_new_section ( $cfg, "" );
my %hide_section;
while ( <$READ_CONFIG> ) {
chomp;
my $line = $_; # Save so can use in fish logging later on.
my ($tv, $ln, $cmt, $lq, $rq) = parse_line ( $line, $opts );
if ( $ln eq "" ) {
DBUG_PRINT ("READ", "READ LINE: %s", $line);
next; # Skip to the next line if only comments found.
}
# Check for lines with no tag/value pairs in them ...
if ( ! $tv ) {
DBUG_PRINT ("READ", "READ LINE: %s", $line);
# EX: . ${file} --- Sourcing in ${file} ...
if ( $ln =~ m/^${src_str}\s+(.+)$/i ) {
my $src = $1;
my $def_section = "";
if ( $cmt =~ m/(^|${lbl_sep})${sect_str}(${lbl_sep}|$)/ ) {
$def_section = $section;
}
my $res = source_file ( $cfg, $def_section, $src, $file );
return DBUG_RETURN (0) unless ( $res );
next;
}
# EX: [ ${section} ] --- Starting a new section ...
if ( $ln =~ m/^${lb}\s*(.+?)\s*${rb}$/ ) {
$section = make_new_section ( $cfg, $1 );
$hide_section{$section} = 0; # Assume not sensitive ...
if ( $cmt =~ m/(^|${lbl_sep})${hide_str}(${lbl_sep}|$)/ ||
should_we_hide_sensitive_data ( $section ) ) {
$hide_section{$section} = 1;
}
next;
}
# Don't know what the config file was thinking of ...
# Don't bother expanding any variables encountered.
DBUG_PRINT ("error", "<Previous line ignored. Unknown format!>");
next;
}
# ------------------------------------------------------------------
# If you get here, you know it's a tag/value pair to parse ...
# Don't forget that any comment can include processing instructions!
# ------------------------------------------------------------------
# Go to the requested section ...
$cfg = $pcfg->get_section ( $section, 1 );
my ($tag, $value, $prefix, $t2) = _split_assign ( $opts, $ln );
# Don't export individually if doing a batch export ...
# If the export option is used, invert the meaning ...
my $export_flag = 0; # Assume not exporting this tag to %ENV ...
if ( $prefix ) {
$export_flag = $opts->{export} ? 0 : 1;
} elsif ( $cmt =~ m/(^|${lbl_sep})${export_str}(${lbl_sep}|$)/ ) {
$export_flag = $opts->{export} ? 0 : 1;
}
# Is the line info sensitive & should it be hidden/masked in fish ???
my $hide = 0;
if ( $hide_section{$section} ||
$cmt =~ m/(^|${lbl_sep})${encrypt_str}(${lbl_sep}|$)/ ||
$cmt =~ m/(^|${lbl_sep})${hide_str}(${lbl_sep}|$)/ ||
should_we_hide_sensitive_data ( $tag, 1 ) ) {
$hide = 1 unless ( $opts->{dbug_test_use_case_hide_override} );
}
if ( $hide ) {
# Some random length so we can't assume the value from the mask used!
my $mask = "*"x8;
if ( $value eq "" ) {
if ( is_assign_spaces ( $opts ) ) {
$line =~ s/^(\s*\S+\s+)/${1}${mask} /;
} else {
$line =~ s/(\s*${assign_str})\s*/${1} ${mask} /;
}
} else {
my $hide_value = convert_to_regexp_string ( $value, 1 );
if ( is_assign_spaces ( $opts ) ) {
$line =~ s/^(\s*\S+\s+)${hide_value}/${1}${mask}/;
} else {
$line =~ s/(\s*${assign_str}\s*)${hide_value}/${1}${mask}/;
}
}
} elsif ( $cmt =~ m/(^|${lbl_sep})${decrypt_str}(${lbl_sep}|$)/ ) {
# Don't hide the line in fish, but hide it's value processing ...
$hide = 1 unless ( $opts->{dbug_test_use_case_hide_override} );
}
DBUG_PRINT ("READ", "READ LINE: %s", $line);
# Remove any balanced quotes ... (must do after hide)
$value =~ s/^${lq}(.*)${rq}$/$1/ if ( $lq );
if ( $tag =~ m/^(shft3+)$/i ) {
my $m = "You can't override special variable '${1}'."
. " Ignoring this line in the config file.\n";
if ( $skip_warns_due_to_make_test ) {
DBUG_PRINT ("WARN", $m);
} else {
warn $m;
}
next;
}
# Was the tag's value encryped?? Then we need to decrypt it ...
my $still_encrypted = 0;
if ( $cmt =~ m/(^|${lbl_sep})${decrypt_str}(${lbl_sep}|$)/ ) {
$value = _reverse_escape_sequences ( $value, $opts );
if ( $opts->{disable_decryption} ) {
$still_encrypted = 1; # Doesn't get decrypted.
} else {
$value = decrypt_value ( $value, $t2, $opts, $file );
}
}
# See if we can expand variables in $value ???
my $still_variables = 0;
if ( $opts->{disable_variables} ) {
$still_variables = ( $value =~ m/${lv}.+${rv}/ ) ? 1 : 0;
} elsif ( ! $still_encrypted ) {
($value, $hide) = expand_variables ( $cfg, $value, $file, $hide, ($lq ? 0 : 1) );
if ( $hide == -1 ) {
# $still_encrypted = $still_variables = 1;
$still_variables = 1; # Variable(s) points to encrypted data.
}
}
# Export one value to %ENV ... (once set, can't back it out again!)
$cfg->export_tag_value_to_ENV ( $tag, $value, $hide ) if ($export_flag);
# Add to the current section in the Advanced::Config object ...
$cfg->_base_set ($tag, $value, $file, $hide, $still_encrypted, $still_variables);
} # End while reading the config file ...
close ( $READ_CONFIG );
DBUG_RETURN (1);
}
# ==============================================================
=item $boolean = source_file ($config, $def_sct, $new_file, $curr_file)
This is a private method called by I<read_config> to source in the requested
config file and merge the results into the current config file.
If I<$def_sct> is given, it will be the name of the current section that the
sourced in file is to use for it's default unlabeled section. If the default
section name has been hard coded in the config file, this value overrides it.
The I<$new_file> may contain variables and after they are expanded the
source callback function is called before I<load_config()> is called.
See L<Advanced::Config::lookup_one_variable> for rules on variable expansion.
If I<$new_file> is a relative path, it's a relative path from the location
of I<$curr_file>, not the program's current directory!
If a source callback was set up, it will call it here.
This method will also handle the removal of decryption related options if new
ones weren't provided by the callback function. See Advanced::Config::Options
for more details.
Returns B<1> if the new file successfully loaded. Else B<0> if something went
wrong during the load!
=cut
sub source_file
{
DBUG_ENTER_FUNC (@_);
my $cfg = shift;
my $defaultSection = shift; # The new default section if not "".
my $new_file = shift; # May contain variables to expand ...
my $old_file = shift; # File we're currently parsing. (has abs path)
my $rOpts = $cfg->get_cfg_settings (); # The Read Options ...
local $global_sections{OVERRIDE} = $defaultSection if ( $defaultSection );
my $pcfg = $cfg->get_section (); # Back to the main/default section ...
my $file = $new_file = expand_variables ($pcfg, $new_file, undef, undef, 1);
# Get the full name of the file we're sourcing in ...
$file = $pcfg->_fix_path ( $file, dirname ( $old_file ) );
unless ( -f $file && -r _ ) {
my $msg = "No such file to source in or it's unreadable ( $file )";
return DBUG_RETURN ( croak_helper ( $rOpts, $msg, 0 ) );
}
if ( $cfg->_recursion_check ( $file ) ) {
my $msg = "Recursion detected while sourcing in file ( $new_file )";
if ( $rOpts->{trap_recursion} ) {
# The request is a fatal error!
return DBUG_RETURN ( croak_helper ( $rOpts, $msg, 0 ) );
} else {
DBUG_PRINT ("RECURSION", $msg);
return DBUG_RETURN ( 1 ); # Just ignore the request ...
}
}
# The returned callback option(s) will be applied to the current
# settings, not the default settings if not a compete set!
my ($r_opts, $d_opts);
if ( exists $rOpts->{source_cb} && ref ( $rOpts->{source_cb} ) eq "CODE" ) {
($r_opts, $d_opts) = $rOpts->{source_cb}->( $file, $rOpts->{source_cb_opts} );
}
if ( $rOpts->{inherit_pass_phase} && $rOpts->{pass_phrase} ) {
my %empty;
$r_opts = \%empty unless ( defined $r_opts );
$r_opts->{pass_phrase} = $rOpts->{pass_phrase} unless ( $r_opts->{pass_phrase} );
}
my $res = $pcfg->_load_config_with_new_date_opts ( $file, $r_opts, $d_opts );
DBUG_RETURN ( (defined $res) ? 1 : 0 );
}
# ==============================================================
=item $name = make_new_section ($config, $section)
This is a private method called by I<read_config> to create a new section
in the L<Advanced::Config> object if a section of that name doesn't already
exist.
The I<$section> name is allowed to contain variables to expand before the
string is used. But those variables must be defined in the I<main> section.
Returns the name of the section found/created in lower case.
=cut
sub make_new_section
{
DBUG_ENTER_FUNC (@_);
my $config = shift;
my $new_name = shift;
# Check if overriding the default section with a new name ...
if ( $new_name eq "" || $new_name eq $global_sections{DEFAULT} ) {
if ( $global_sections{DEFAULT} ne $global_sections{OVERRIDE} ) {
DBUG_PRINT ("OVERRIDE", "Overriding section '%s' with section '%s'",
$new_name, $global_sections{OVERRIDE});
$new_name = $global_sections{OVERRIDE};
}
}
my $pcfg = $config->get_section (); # Back to the main section ...
my $val = expand_variables ($pcfg, $new_name, undef, undef, 1);
$new_name = lc ( $val );
# Check if the section name is already in use ...
my $old = $pcfg->get_section ( $new_name );
if ( $old ) {
return DBUG_RETURN ( $old->section_name() );
}
# Create the new section now that we know it's name is unique ...
my $scfg = $pcfg->create_section ( $new_name );
if ( $scfg ) {
return DBUG_RETURN ( $scfg->section_name () );
}
# Should never, ever happen ...
DBUG_PRINT ("WARN", "Failed to create the new section: %s.", $new_name);
DBUG_RETURN (""); # This is the main/default section being returned.
}
# ==============================================================
# Allows a config file to run a random command when it's loaded into memory.
# Only allowed if explicity enabled & configured!
# Decided it's too dangerous to use, so never called outside of a POC example!
sub _execute_backquoted_cmd
{
my $rOpts = shift;
my $hide = shift;
my $tag = shift;
my $value = shift;
return ( $value ) unless ( $rOpts->{enable_backquotes} );
# Left & right backquotes ...
my ($lbq, $rbq) = ( convert_to_regexp_string ($rOpts->{backquote_left}, 1),
convert_to_regexp_string ($rOpts->{backquote_right}, 1) );
unless ( $value =~ m/^${lbq}(.*)${rbq}$/ ) {
return ( $value ); # No balanced backquotes detected ...
}
my $cmd = $1; # The command to run ...
# DBUG_MASK_NEXT_FUNC_CALL (3) if ( $hide ); # Never hide value (cmd to run)
DBUG_ENTER_FUNC ($rOpts, $hide, $tag, $value, @_);
DBUG_MASK (0) if ( $hide ); # OK to hide the results.
if ( $cmd =~ m/[`]/ ) {
DBUG_PRINT ('INFO', 'Your command may not have backquotes (`) in it!');
} elsif ( $cmd =~ m/^\s*$/ ) {
DBUG_PRINT ('INFO', 'Your command must have a value!');
} else {
die ("Someone tried to run cmd: $cmd\n");
# $value = `$cmd`;
$value = "" unless ( defined $value );
chomp ($value);
}
lib/Advanced/Config/Reader.pm view on Meta::CPAN
foreach ("A" .. "Z", "@") {
$has_no_cmt = ${_}x10;
last unless ( $has_no_cmt =~ m/${comment}/ ||
$has_no_cmt =~ m/${lvar}/ ||
$has_no_cmt =~ m/${rvar}/ ||
$line =~ m/${has_no_cmt}/ );
}
if ( $has_no_cmt eq "@"x10 ) {
warn ("May be having variable substitution issues in parse_line()!\n");
}
# Strip out all the variables from the value ...
# Assumes processing variables from left to right ...
# Need to evaluate even if variables are disabled to parse correctly ...
my @parts = parse_for_variables ($var_line, 1, $opts);
my $cmt_found = 0;
my $count_var = 0;
my @data;
while (defined $parts[0]) {
$cmt_found = $parts[3];
push (@data, $var_line);
last if ($cmt_found);
$var_line = $parts[0] . $has_no_cmt . $parts[2];
@parts = parse_for_variables ($var_line, 1, $opts);
++$count_var;
}
push (@data, $var_line);
my $unbalanced_leading_var_anchor_with_comments = 0;
if ( $cmt_found && $parts[0] =~ m/(\s*${comment}\s*)(.*$)/ ) {
# parts[1] is parts[7] trimmed ... so join back together with untrimmed.
$cmts = $2 . $opts->{variable_left} . $parts[7]
. $opts->{variable_right} . $parts[2];
my $str = convert_to_regexp_string ( $1 . $cmts );
$line =~ s/${str}$//;
DBUG_PRINT ("LINE", "Variables encountered with variables in comment ...");
return DBUG_RETURN ( $tv_pair_flag, $line, $cmts, "", "");
} elsif ( $count_var ) {
if ( $var_line =~ m/(\s*${comment}\s*)(.*)$/ ) {
$cmts = $2;
if ( $cmts =~ m/${has_no_cmt}/ ) {
$unbalanced_leading_var_anchor_with_comments = 1;
} else {
my $cmt2 = convert_to_regexp_string ($1 . $cmts);
$line =~ s/${cmt2}$//;
DBUG_PRINT ("LINE", "Variables encountered with constant comment ...");
}
} else {
$cmts = "";
DBUG_PRINT ("LINE", "Variables encountered without comments ...");
}
unless ( $unbalanced_leading_var_anchor_with_comments ) {
return DBUG_RETURN ( $tv_pair_flag, $line, $cmts, "", "");
}
}
# ---------------------------------------------------------------------------
# Corrupted variable definition with variables in the comments ...
# Boy things are getting difficult to parse. Reverse the previous variable
# substitutions until the all variables in the comments are unexpanded again!
# Does a greedy RegExp to grab the 1st comment string encountered.
# ---------------------------------------------------------------------------
if ( $unbalanced_leading_var_anchor_with_comments ) {
$cmts = "";
foreach my $l (reverse @data) {
if ( $l =~ m/\s*${comment}\s*(.*)$/ ) {
$cmts = $1;
last unless ( $cmts =~ m/${has_no_cmt}/ );
$cmts = "";
}
}
if ( $cmts ne "" ) {
my $cmt2 = convert_to_regexp_string ($cmts);
$line =~ s/\s*${comment}\s*${cmt2}$//;
DBUG_PRINT ("LINE", "Unbalanced var def encountered with var comments ...");
return DBUG_RETURN ( $tv_pair_flag, $line, $cmts, "", "");
}
# If you get here, assume it's not a tag/value pair even if it is!
# I know I can no longer hope to parse it correctly without a test case.
# But I really don't think it's possible to get here anymore ...
warn ("Corrupted variable definition encountered. Can't split out the comment with variables in it correctly!\n");
return DBUG_RETURN ( 0, $line, "", "", "");
}
# ----------------------------------------------------------------------
# No variables, no balanced quotes ...
# But I still think there's a comment to remove!
# ----------------------------------------------------------------------
if ( $tv_pair_flag && $value =~ m/(\s*${comment}\s*)(.*)$/ ) {
$cmts = $2;
my $cmt2 = convert_to_regexp_string ($1 . $cmts);
$line =~ s/${cmt2}$//; # Remove the comment from the line.
DBUG_PRINT ("LINE", "Last ditch effort to remove the comment from the value ...");
return DBUG_RETURN ( $tv_pair_flag, $line, $cmts, "", "");
}
$cmts = $line;
$line =~ s/\s*${comment}.*$//; # Strip off any comments ....
$cmts = substr ( $cmts, length ($line) ); # Grab the comments ...
$cmts =~ s/^\s*${comment}\s*//; # Remove comment symbol ...
DBUG_PRINT ("LINE", "Last ditch effort to remove the comment from the line ...");
DBUG_RETURN ( $tv_pair_flag, $line, $cmts, "", "");
}
# ==============================================================
=item ($v[, $h]) = expand_variables ( $config, $string[, $file[, $sensitive[, trim]]] )
This function takes the provided I<$string> and expands any embedded variables
in this string similar to how it's handled by a Unix shell script.
The optional I<$file> tells which file the string was read in from.
The optional I<$sensitive> when set to a non-zero value is used to disable
B<fish> logging when it's turned on because the I<$string> being passed contains
sensitive information.
The optional I<$trim> tells if you may trim the results before it's returned.
It returns the new value $v, once all the variable substitution(s) have
occurred. And optionally a second return value $h that tells if B<fish> was
paused during the expansion of that value due to something being sensitive.
This 2nd return value $h is meaningless in most situations, so don't ask for it.
All variables are defined as B<${>I<...>B<}>, where I<...> is the variable you
wish to substitute. If something isn't surrounded by a B<${> + B<}> pair, it's
not a variable.
A config file exampe:
tmp1 = /tmp/work-1
tmp2 = /tmp/work-2
opt = 1
date = 2011-02-03
logs = ${tmp${opt}}/log-${date}.txt
date = 2012-12-13
So when passed "${tmp${opt}}/log-${date}.txt", it would return:
/tmp/work-1/log-2011-02-03.txt
And assigned it to B<logs>.
As you can see multiple variable substitutions may be expanded in a single
string as well as nested substitutions. And when the variable substitution is
done while reading in the config file, all the values used were defined before
the tag was referenced.
Should you call this method after the config file was loaded you get slightly
different results. In that case the final tag value is used instead and the
2nd date in the above example would have been used in it's place.
See L<Advanced::Config::lookup_one_variable> for more details on how it
evaluates individual variables.
As a final note, if one or more of the referenced variables holds encrypted
values that haven't yet been decrypted, those variables are not resolved. But
all variables that don't contain encrypted data are resolved.
=cut
# ==============================================================
sub expand_variables
{
my $config = shift; # For the current section of config obj ...
my $value = shift; # The value to parse for variables ...
my $file = shift || ""; # The config file the value came from ...
my $mask_flag = shift || 0; # Hide/mask sensitive info written to fish?
my $trim_flag = shift || 0; # Tells if we should trim the result or not.
# Only mask ${value} if ${mask_flag} is true ...
DBUG_MASK_NEXT_FUNC_CALL (1) if ( $mask_flag );
DBUG_ENTER_FUNC ( $config, $value, $file, $mask_flag, $trim_flag, @_);
my $opts = $config->get_cfg_settings (); # The Read Options ...
my $pcfg = $config->get_section(); # Get the main/parent section to work with!
# Don't write to Fish if we're hiding any values ...
if ( $mask_flag ) {
DBUG_PAUSE ();
DBUG_MASK ( 0 );
}
# The 1st split of the value into it's component parts ...
my ($left, $tag, $right, $cmt_flag, $mod_tag, $mod_opt, $mod_val, $ot) =
parse_for_variables ( $value, 0, $opts );
# Any variables to substitute ???
unless ( defined $tag ) {
return DBUG_RETURN ( $value, $mask_flag ); # nope ...
}
my $output = $value;
my %encrypt_vars;
my $encrypt_cnt = 0;
my $encrypt_fmt = "_"x50 . "ENCRYPT_%02d" . "-"x50;
my ($lv, $rv) = ( convert_to_regexp_string ($opts->{variable_left}),
convert_to_regexp_string ($opts->{variable_right}) );
# While there are still variables to process ...
while ( defined $tag ) {
my ( $val, $mask );
my $do_mod_lookup = 0; # Very rarely set to true ...
# ${tag} and ${mod_tag} will never have the same value ...
# ${mod_tag} will amost always be undefinded.
# If both are defined, we'll almost always end up using ${mod_tag} as
# the real variable to expand! But we check to be sure 1st.
( $val, $mask ) = $config->lookup_one_variable ( $tag );
# It's extreemly rare to have this "if statement" evalate to true ...
if ( (! defined $val) && defined $mod_tag ) {
( $val, $mask ) = $config->lookup_one_variable ( $mod_tag );
# -----------------------------------------------------------------
# If we're using variable modifiers, it doesn't matter if the
# varible exists or not. The modifier gets evaluated!
# So checking if the undefined $mod_tag needs to be masked or not ...
# -----------------------------------------------------------------
unless ( defined $val ) {
$mask = should_we_hide_sensitive_data ( $mod_tag );
}
$do_mod_lookup = 1; # Yes, apply the modifiers!
}
# Use a place holder if the variable references data that is still encrypted.
if ( $mask == -1 ) {
$mask_flag = -1;
$val = sprintf ($encrypt_fmt, ++$encrypt_cnt);
# If the place holder contains variable anchors abort the substitutions.
last if ( $val =~ m/${lv}/ || $val =~ m/${rv}/ );
$encrypt_vars{$val} = $tag;
$do_mod_lookup = 0;
}
# Doing some accounting to make sure any sensitive data doesn't
# show up in the fish logs from now on.
if ( $mask && ! $mask_flag ) {
$mask_flag = 1;
DBUG_PAUSE ();
DBUG_MASK ( 0 );
}
if ( $do_mod_lookup ) {
my $m;
($val, $m) = apply_modifier ( $config, $val, $mod_tag, $mod_opt, $mod_val, $file );
if ( $m == -2 ) {
# The name of the variable changed & points to an encrypted value.
$val = $opts->{variable_left} . ${val} . $opts->{variable_right};
} elsif ( $m && ! $mask_flag ) {
$mask_flag = 1;
DBUG_PAUSE ();
DBUG_MASK ( 0 );
}
}
# Rebuild the output string so we can look for more variables ...
if ( defined $val ) {
$output = $left . $val . $right;
} else {
$output = $left . $right;
}
# Get the next variable to evaluate ...
($left, $tag, $right, $cmt_flag, $mod_tag, $mod_opt, $mod_val, $ot) =
parse_for_variables ( $output, 0, $opts );
} # End while ( defined $tag ) loop ...
# Restore all place holders back into the output string with the
# proper variable name. Have to assume still sensitive even if
# all the placeholders drop out. Since can't tell what else may
# have triggered it.
if ( $mask_flag == -1 ) {
$mask_flag = 1; # Mark sensitive ...
foreach ( keys %encrypt_vars ) {
my $val = $opts->{variable_left} . $encrypt_vars{$_} . $opts->{variable_right};
$mask_flag = -1 if ( $output =~ s/$_/$val/ );
}
}
# Did the variable substitution result in the need to trim things?
if ( $trim_flag ) {
$output =~ s/^\s+//;
$output =~ s/\s+$//;
}
DBUG_RETURN ( $output, $mask_flag );
}
# ==============================================================
=item ($v[, $s]) = apply_modifier ( $config, $value, $tag, $rule, $sub_rule, $file )
This is a helper method to F<expand_variables>. Not for public use.
This function takes the rule specified by I<$rule> and applies it against
the I<$value> with assistance from the I<$sub_rule>.
It returns the edited I<value> and whether applying the modifier made it
I<sensitive>. (-1 means it's an encrypted value. -2 means it's the variable
name that resolves to an encrypted value. 0 - Non-sensitive, 1 - Sensitive.)
See L<https://web.archive.org/web/20200309072646/https://wiki.bash-hackers.org/syntax/pe>
for information on how this can work. This module supports most of the
parameter expansions listed there except for those dealing with arrays. Other
modifier rules may be added upon request.
=cut
# NOTE1: Fish has already been paused if $tag is sensitive. Since this method
# has no idea if the current tag is sensitive or not.
# NOTE2: But still need to mask the return value if referencing sensitive data
# in case the original $tag wasn't sensitive. So in most cases it will
# return not-sensitive even if fish has already been paused!
#
# NOTE3: If sensitive/mask is -1, it's sensitive and not decrypted. In this
# case the returned value is the tag's name, not it's value!
sub apply_modifier
{
DBUG_ENTER_FUNC ( @_ );
my $cfg = shift;
my $value = shift; # The value for ${mod_tag} ...
my $mod_tag = shift; # The tag to apply the rule against!
my $mod_opt = shift; # The rule ...
my $mod_val = shift; # The sub-rule ...
my $file = shift; # The file the tag's from.
my $alt_val = (defined $value) ? $value : "";
# The values to return ...
my $output;
# Values: 0 - Normal non-sensitive return value (99.9% of the time)
# 1 - Sensitive return value.
# -1 - Return value is encrypted.
# -2 - Return value is variable name of encrypted value.
my $mask = 0;
# If looking for a default value ...
if ( ( $mod_opt eq ":+" && $alt_val ne "" ) ||
( $mod_opt =~ m/^:[-=?]$/ && $alt_val eq "" ) ||
( $mod_opt eq "+" && defined $value ) ||
( $mod_opt =~ m/^[-=?]$/ && ! defined $value ) ) {
$output = $mod_val; # Now uses this value as it's default!
if ( $mod_opt eq ":=" || $mod_opt eq "=" ) {
# The variable either doesn't exist or it resolved to "".
# This variant rule says to also set the variable to this value!
$cfg->_base_set ( $mod_tag, $output, $file );
} elsif ( $mod_opt eq ":?" || $mod_opt eq "?" ) {
# In shell scripts, ":?" would cause your script to die with the
lib/Advanced/Config/Reader.pm view on Meta::CPAN
DBUG_PRINT ("MOD", "Indirectly referencing variable %s (%s)", $alt_val, $mask);
} elsif ( $mod_opt eq "//" ) {
my ($ptrn, $val) = split ("/", $mod_val);
$output = $alt_val;
$output =~ s/${ptrn}/${val}/g;
DBUG_PRINT ("MOD", "Global replacement in %s", $alt_val);
} elsif ( $mod_opt eq "/" ) {
my ($ptrn, $val) = split ("/", $mod_val);
$output = $alt_val;
$output =~ s/${ptrn}/${val}/;
DBUG_PRINT ("MOD", "1st replacement in %s", $alt_val);
} elsif ( $mod_opt eq ":" ) {
my ($offset, $length) = split (":", $mod_val);
if ( defined $length && $length ne "" ) {
$output = substr ( $alt_val, $offset, $length);
} else {
$output = substr ( $alt_val, $offset);
}
DBUG_PRINT ("MOD", "Substring (%s)", $output);
# The 6 case manipulation modifiers ...
} elsif ( $mod_opt eq "^^" ) {
$output = uc ($alt_val);
DBUG_PRINT ("MOD", "Upshift string (%s)", $output);
} elsif ( $mod_opt eq ",," ) {
$output = lc ($alt_val);
DBUG_PRINT ("MOD", "Downshift string (%s)", $output);
} elsif ( $mod_opt eq "~~" ) {
$output = $alt_val;
$output =~ s/([A-Z])|([a-z])/defined $1 ? lc($1) : uc($2)/gex;
DBUG_PRINT ("MOD", "Reverse case of each char in string (%s)", $output);
} elsif ( $mod_opt eq "^" ) {
$output = ucfirst ($alt_val);
DBUG_PRINT ("MOD", "Upshift 1st char in string (%s)", $output);
} elsif ( $mod_opt eq "," ) {
$output = lcfirst ($alt_val);
DBUG_PRINT ("MOD", "Downshift 1st char in string (%s)", $output);
} elsif ( $mod_opt eq "~" ) {
$output = ucfirst ($alt_val);
$output = lcfirst ($alt_val) if ( $alt_val eq $output );
DBUG_PRINT ("MOD", "Reverse case of 1st char in string (%s)", $output);
} else {
DBUG_PRINT ("MOD",
"The modifier (%s) didn't affect the variable's value!",
$mod_opt);
$output = $value;
}
DBUG_RETURN ( $output, $mask );
}
# ==============================================================
=item @ret[0..7] = parse_for_variables ( $value, $ignore_disable_flag, $rOpts )
This is a helper method to F<expand_variables> and B<parse_line>.
This method parses the I<$value> to see if any variables are defined in it
and returns the information about it. If there is more than one variable
present in the I<$value>, only the 1st variable/tag to evaluate is returned.
By default, a variable is the tag in the I<$value> between B<${> and B<}>, which
can be overridden with other anchor patterns. See L<Advanced::Config::Options>
for more details on this.
If you've configured the module to ignore variables, it will never find any.
Unless you also set I<$ignore_disable_flag> to a non-zero value.
Returns B<8> values. ( $left, $tag, $right, $cmt, $sub_tag, $sub_opr, $sub_val,
$otag )
All B<8> values will be I<undef> if no variables were found in I<$value>.
Otherwise it returns at least the 1st four values. Where I<$tag> is the
variable that needs to be looked up. And the caller can join things back
together as "B<$left . $look_up_value . $right>" after the variable substitution
is done and before this method is called again to locate additional variables in
the resulting new I<$value>.
The 4th value I<$cmt>, will be true/false based on if B<$left> has a comment
symbol in it! This flag only has meaning to B<parse_line>. And is terribly
misleading to other users.
Should the I<$tag> definition have one of the supported shell script variable
modifiers embedded inside it, then the I<$tag> will be parsed and the 3 B<sub_*>
return values will be calculated as well. See
L<http://wiki.bash-hackers.org/syntax/pe> for more details. Most of the
modifiers listed there are supported except for those dealing with arrays.
See I<apply_modifier> for applying these rules against the returned I<$tag>.
Other modifier rules may be added upon request.
These 3 B<sub_*> return values will always be I<undef> should the variable
left/right anchors be overridden with the same value. Or if no modifiers
are detected in the tag's name.
If you've configured the module to be case insensitive (option B<tag_case>),
then both I<$tag> and I<$sub_tag> will be shifted to lower case for case
insensitive variable lookups.
Finally there is an 8th return value, I<$otag>, that contains the original
I<$tag> value before it was edited. Needed by F<parse_line> logic.
=cut
# WARNING: If (${lvar} == ${rvar}), nested variables are not supported.
# : And neither are variable modifiers. (The sub_* return values.)
# : So evaluate tags left to right.
# : If (${lvar} != ${rvar}), nested variables are supported.
# : So evaluate inner most tags first. And then left to right.
#
# RETURNS: 8 values. ( $left, $tag, $right, $cmt, $sub_tag, $sub_opr, $sub_val, $otag )
# : The 3 sub_* vars are usually undef.
# : But when set, all 3 sub_* vars are set! And $tag != $sub_tag.
#
# NOTE 1 : If the 3 sub_* vars are populated, you'd get something like this
# : for the tag & sub_* vars.
( run in 1.448 second using v1.01-cache-2.11-cpan-5623c5533a1 )