From 7d8956083b76babafef3c8e82fb32c4f243424c3 Mon Sep 17 00:00:00 2001
From: Stefan Schantl <stefan.schantl@ipfire.org>
Date: Thu, 24 Mar 2022 20:18:58 +0100
Subject: [PATCH] ids-functions.pl: Early load required perl modules.

This will help us to determine if all required perl modules and their
dependencies are avail and load-able.

It also prevents us from doubble loading modules and makes development
and maintainance more easy.

Signed-off-by: Stefan Schantl <stefan.schantl@ipfire.org>
---
 config/cfgroot/ids-functions.pl | 66 ++++++++++++++-------------------
 1 file changed, 27 insertions(+), 39 deletions(-)

diff --git a/config/cfgroot/ids-functions.pl b/config/cfgroot/ids-functions.pl
index 90b7d2d7f0..35b8f7a833 100644
--- a/config/cfgroot/ids-functions.pl
+++ b/config/cfgroot/ids-functions.pl
@@ -29,6 +29,33 @@ require '/var/ipfire/general-functions.pl';
 require "${General::swroot}/network-functions.pl";
 require "${General::swroot}/suricata/ruleset-sources";
 
+# Load perl module to deal with Archives.
+use Archive::Tar;
+
+# Load perl module to deal with files and path.
+use File::Basename;
+
+# Load module to move files.
+use File::Copy;
+
+# Load module to recursely remove files and a folder.
+use File::Path qw(rmtree);
+
+# Load module to get file stats.
+use File::stat;
+
+# Load module to deal with temporary files.
+use File::Temp;
+
+# Load the libwwwperl User Agent module.
+use LWP::UserAgent;
+
+# Load function from posix module to format time strings.
+use POSIX qw (strftime);
+
+# Load module to talk to the kernel log daemon.
+use Sys::Syslog qw(:DEFAULT setlogsock);
+
 # Location where all config and settings files are stored.
 our $settingsdir = "${General::swroot}/suricata";
 
@@ -280,9 +307,6 @@ sub downloadruleset ($) {
 	my %proxysettings=();
 	&General::readhash("${General::swroot}/proxy/settings", \%proxysettings);
 
-	# Load required perl module to handle the download.
-	use LWP::UserAgent;
-
 	# Init the download module.
 	#
 	# Request SSL hostname verification and specify path
@@ -358,9 +382,6 @@ sub downloadruleset ($) {
 			return 1;
 		}
 
-		# Load perl module to deal with temporary files.
-		use File::Temp;
-
 		# Generate temporary file name, located in "/var/tmp" and with a suffix of ".tmp".
 		my $tmp = File::Temp->new( SUFFIX => ".tmp", DIR => "/var/tmp/", UNLINK => 0 );
 		my $tmpfile = $tmp->filename();
@@ -406,9 +427,6 @@ sub downloadruleset ($) {
 		# Get the remote size of the downloaded file.
 		my $remote_filesize = $headers->content_length;
 
-		# Load perl stat module.
-		use File::stat;
-
 		# Perform stat on the tmpfile.
 		my $stat = stat($tmpfile);
 
@@ -443,9 +461,6 @@ sub downloadruleset ($) {
 			return 1;
 		}
 
-		# Load file copy module, which contains the move() function.
-		use File::Copy;
-
 		# Overwrite the may existing rulefile or tarball with the downloaded one.
 		move("$tmpfile", "$dl_rulesfile");
 
@@ -469,18 +484,9 @@ sub downloadruleset ($) {
 sub extractruleset ($) {
 	my ($provider) = @_;
 
-	# Load perl module to deal with archives.
-	use Archive::Tar;
-
 	# Disable chown functionality when uncompressing files.
 	$Archive::Tar::CHOWN = "0";
 
-	# Load perl module to deal with files and path.
-	use File::Basename;
-
-	# Load perl module for file copying.
-	use File::Copy;
-
 	# Get full path and downloaded rulesfile for the given provider.
 	my $tarball = &_get_dl_rulesfile($provider);
 
@@ -586,9 +592,6 @@ sub extractruleset ($) {
 				# Extract the file to the temporary directory.
 				$tar->extract_file("$packed_file", "$destination");
 			} else {
-				# Load perl module to deal with temporary files.
-				use File::Temp;
-
 				# Generate temporary file name, located in the temporary rules directory and a suffix of ".tmp".
 				my $tmp = File::Temp->new( SUFFIX => ".tmp", DIR => "$tmp_rules_directory", UNLINK => 0 );
 				my $tmpfile = $tmp->filename();
@@ -637,9 +640,6 @@ sub oinkmaster () {
 		&extractruleset($provider);
 	}
 
-	# Load perl module to talk to the kernel syslog.
-	use Sys::Syslog qw(:DEFAULT setlogsock);
-
 	# Establish the connection to the syslog service.
 	openlog('oinkmaster', 'cons,pid', 'user');
 
@@ -811,9 +811,6 @@ sub merge_sid_msg (@) {
 ## the rules directory.
 #
 sub move_tmp_ruleset() {
-	# Load perl module.
-	use File::Copy;
-
 	# Do a directory listing of the temporary directory.
 	opendir  DH, $tmp_rules_directory;
 
@@ -831,8 +828,6 @@ sub move_tmp_ruleset() {
 ## Function to cleanup the temporary IDS directroy.
 #
 sub cleanup_tmp_directory () {
-	# Load rmtree() function from file path perl module.
-	use File::Path 'rmtree';
 
 	# Delete temporary directory and all containing files.
 	rmtree([ "$tmp_directory" ]);
@@ -860,9 +855,6 @@ sub log_error ($) {
 sub _log_to_syslog ($) {
 	my ($message) = @_;
 
-	# Load perl module to talk to the kernel syslog.
-	use Sys::Syslog qw(:DEFAULT setlogsock);
-
 	# The syslog function works best with an array based input,
 	# so generate one before passing the message details to syslog.
 	my @syslog = ("ERR", "<ERROR> $message");
@@ -1584,10 +1576,6 @@ sub get_ruleset_date($) {
 	my $date;
 	my $mtime;
 
-	# Load neccessary perl modules for file stat and to format the timestamp.
-	use File::stat;
-	use POSIX qw( strftime );
-
 	# Get the stored rulesfile for this provider.
 	my $stored_rulesfile = &_get_dl_rulesfile($provider);
 
-- 
2.39.5