perlperldocperl-core

Perl "do", with relative path beginning with "." or ".."

I'm trying to use Perl's do EXPR function as a poor man's config parser, using a second .pl file that just returns a list as configuration information. (I think this is probably the ideal use for do, not least because I can write "do or die" in my code.) Here's an example:

main.pl

# Go read the config file
my %config = do './config.pl';

# do something with it
$web_object->login($config{username}, $config{password});

config.pl

# Configuration file for main script
(
  username => "username",
  password => "none_of_your_business",
  favorite_color => "0x0000FF",
);

Reading Perldoc for do gives a lot of helpful advice about relative paths - searching @INC and modifying %INC, special warnings about 5.26 not searching "." any more, etc. But it also has these bits:

# load the exact specified file (./ and ../ special-cased)...

Using do with a relative path (except for ./ and ../), like...

And then it never actually bothers to explain the Special Case path handling for "./" or "../" - an important omission!

So my question(s) are all variations on "what really happens when you do './file.pl';"? For instance...

Any insight is appreciated.

Solution

  • OK, so - to start with, I'm not sure your config.pl is really the right approach - it's not perl for starters, because it doesn't compile. Either way though, trying to evaluate stuff to 'parse config' isn't a great plan generally - it's rather prone to unpleasant glitches and security flaws, so should be reserved for when it's needed.

    I would urge you to do it differently by either:

    Write it as a module

    Something like this:

    package MyConfig;

# Configuration file for main script
our %config = (
   username       => "username",
   password       => "none_of_your_business",
   favorite_color => "0x0000FF",
);

    You could then in your main script:

    use MyConfig; #note - the file needs to be the same name, and in @INC

    and access it as:

    print $MyConfig::config{username},"\n";

    If you can't put it in the existing @INC - which there may be reasons you can't, FindBin lets you use paths relative to your script location:

    use FindBin; 
use lib "$FindBin::Bin"; 
use MyConfig;

    Write your 'config' as a defined parsable format, rather than executable code.

    YAML

    YAML is very solid for a config file particularly:

    use YAML::XS;

open ( my $config_file, '<', 'config.yml' ) or die $!; 
my $config = Load ( do { local $/; <$config_file> });

print $config -> {username};

    And your config file looks like:

    username: "username"
password: "password_here"
favourite_color: "green"
air_speed_of_unladen_swallow: "african_or_european?"

    (YAML also supports multi-dimensional data structures, arrays etc. You don't seem to need these though.)

    JSON

    JSON based looks much the same, just the input is:

    {
  "username": "username",
  "password": "password_here",
  "favourite_color": "green",
  "air_speed_of_unladen_swallow": "african_or_european?"
}

    You read it with:

    use JSON;
open ( my $config_file, '<', 'config.json' ) or die $!; 
my $config = from_json ( do { local $/; <$config_file> });

    Using relative paths to config:

    You don't have to worry about @INC at all. You can simply use based on relative path... but a better bet would be to NOT do that, and use FindBin instead - which lets you specify "relative to my script path" and that's much more robust.

     use FindBin;
 open ( my $config_file, '<', "$FindBin::Bin/config.yml" ) or die $!;

    And then you'll know you're reading the one in the same directory as your script, no matter where it's invoked from.

    specific questions:

    From whose perspective is "./" anyway: the Perl binary, the Perl script executed, CWD from the user's shell, or something else?

    Current working directory passes down through processes. So user's shell by default, unless the perl script does a chdir

    Are there security risks to be aware of?

    Any time you 'evaluate' something as if it were executable code (and EXPR can be) there's a security risk. It's probably not huge, because the script will be running as the user, and the user is the person who can tamper with CWD. The core risks are:

    Is this better or worse than modifying @INC and just using a base filename?

    Worse IMO. Actually just don't modify @INC at all, and use a full path, or relative one using FindBin. And don't eval things when it's not necessary.