From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

#
# (c) Jan Gehring <jan.gehring@gmail.com>
#
use v5.12.5;
our $VERSION = '1.16.0'; # VERSION
sub new {
my $that = shift;
my $proto = ref($that) || $that;
my $self = {@_};
bless( $self, $proto );
return $self;
}
sub is_installed {
my ( $self, $pkg, $option ) = @_;
my $version = $option->{version};
Rex::Logger::debug(
"Checking if $pkg" . ( $version ? "-$version" : "" ) . " is installed" );
my @pkg_info = grep { $_->{name} eq $pkg } $self->get_installed();
@pkg_info = grep { $_->{version} eq $version } @pkg_info if defined $version;
unless (@pkg_info) {
Rex::Logger::debug(
"$pkg" . ( $version ? "-$version" : "" ) . " is NOT installed." );
return 0;
}
Rex::Logger::debug(
"$pkg" . ( $version ? "-$version" : "" ) . " is installed." );
return 1;
}
sub install {
my ( $self, $pkg, $option ) = @_;
if ( $self->is_installed( $pkg, $option ) ) {
Rex::Logger::info("$pkg is already installed");
return 1;
}
$self->update( $pkg, $option );
return 1;
}
sub update {
my ( $self, $pkg, $option ) = @_;
my $version = $option->{'version'} || '';
my $env = $option->{'env'} || {};
Rex::Logger::debug( "Installing $pkg" . ( $version ? "-$version" : "" ) );
my $cmd;
if ( ( $pkg =~ /\*/ )
&& defined( $self->{commands}->{install_glob} ) )
{
# quote the pkg name so it won't error when ran
my $exec = Rex::Interface::Exec->create;
my $quoter = Net::OpenSSH::ShellQuoter->quoter( $exec->shell->name );
$pkg = $quoter->quote($pkg);
$cmd = sprintf $self->{commands}->{install_glob}, $pkg;
}
else {
$cmd = sprintf $self->{commands}->{install}, $pkg;
# not compatible with globs, so skip over this
if ( exists $option->{version} ) {
$cmd = sprintf $self->{commands}->{install_version}, $pkg,
$option->{version};
}
}
my $f = i_run $cmd, fail_ok => 1, env => $env;
unless ( $? == 0 ) {
Rex::Logger::info( "Error installing $pkg.", "warn" );
Rex::Logger::debug($f);
die("Error installing $pkg");
}
Rex::Logger::debug("$pkg successfully installed.");
return 1;
}
sub update_system {
my ( $self, %option ) = @_;
# default is to update packages
$option{update_packages} = 1 if ( !exists $option{update_packages} );
if ( !exists $self->{commands}->{update_system} ) {
Rex::Logger::debug("Not supported under this OS");
return;
}
if ( $option{update_metadata} ) {
$self->update_pkg_db(%option);
}
if ( $option{update_packages} ) {
my $cmd = $self->{commands}->{update_system};
my $f = i_run $cmd, fail_ok => 1;
unless ( $? == 0 ) {
Rex::Logger::debug($f);
die("Error updating system");
}
}
if ( $option{dist_upgrade} ) {
if ( !exists $self->{commands}->{dist_update_system} ) {
Rex::Logger::debug("dist upgrades not supported under this OS");
}
else {
my $cmd = $self->{commands}->{dist_update_system};
my $f = i_run $cmd, fail_ok => 1;
unless ( $? == 0 ) {
Rex::Logger::debug($f);
die("Error dist-updating system");
}
}
}
Rex::Logger::debug("System successfully updated.");
return 1;
}
sub remove {
my ( $self, $pkg ) = @_;
Rex::Logger::debug("Removing $pkg");
my $cmd;
if ( ( $pkg =~ /\*/ )
&& defined( $self->{commands}->{remove_glob} ) )
{
# quote the pkg name so it won't error when ran
my $exec = Rex::Interface::Exec->create;
my $quoter = Net::OpenSSH::ShellQuoter->quoter( $exec->shell->name );
$pkg = $quoter->quote($pkg);
$cmd = sprintf $self->{commands}->{remove_glob}, $pkg;
}
else {
$cmd = sprintf $self->{commands}->{remove}, $pkg;
}
my $f = i_run $cmd, fail_ok => 1;
unless ( $? == 0 ) {
Rex::Logger::info( "Error removing $pkg.", "warn" );
Rex::Logger::debug($f);
die("Error removing $pkg");
}
Rex::Logger::debug("$pkg successfully removed.");
return 1;
}
sub purge {
my ( $self, $pkg ) = @_;
return 1 if ( !exists $self->{commands}->{purge} );
Rex::Logger::debug("Purging $pkg");
my $cmd = sprintf $self->{commands}->{purge}, $pkg;
my $f = i_run $cmd, fail_ok => 1;
unless ( $? == 0 ) {
Rex::Logger::info( "Error purging $pkg.", "warn" );
Rex::Logger::debug($f);
die("Error purging $pkg");
}
Rex::Logger::debug("$pkg successfully purged.");
return 1;
}
sub update_pkg_db {
my ( $self, %option ) = @_;
if ( !exists $self->{commands}->{update_package_db} ) {
Rex::Logger::debug("Not supported under this OS");
return;
}
my $cmd = $self->{commands}->{update_package_db};
i_run $cmd, fail_ok => 1;
if ( $? != 0 ) {
die("Error updating package database");
}
}
sub bulk_install {
Rex::Logger::info(
"Installing bulk packages not supported on this platform. Falling back to one by one method",
"warn"
);
my ( $self, $packages_aref, $option ) = @_;
for my $pkg_to_install ( @{$packages_aref} ) {
$self->install( $pkg_to_install, $option );
}
return 1;
}
sub add_repository {
my ( $self, %data ) = @_;
Rex::Logger::debug("Not supported under this OS");
}
sub rm_repository {
my ( $self, $name ) = @_;
Rex::Logger::debug("Not supported under this OS");
}
sub diff_package_list {
my ( $self, $list1, $list2 ) = @_;
my @old_installed = @{$list1};
my @new_installed = @{$list2};
my @modifications;
# getting modifications of old packages
OLD_PKG:
for my $old_pkg (@old_installed) {
NEW_PKG:
for my $new_pkg (@new_installed) {
if ( $old_pkg->{name} eq $new_pkg->{name} ) {
# flag the package as found in new package list,
# to find removed and new ones.
$old_pkg->{found} = 1;
$new_pkg->{found} = 1;
if ( $old_pkg->{version} ne $new_pkg->{version} ) {
push @modifications, { %{$new_pkg}, action => 'updated' };
}
next OLD_PKG;
}
}
}
# getting removed old packages
push @modifications, map { $_->{action} = 'removed'; $_ }
grep { !exists $_->{found} } @old_installed;
# getting new packages
push @modifications, map { $_->{action} = 'installed'; $_ }
grep { !exists $_->{found} } @new_installed;
for (@modifications) {
delete $_->{found};
}
return @modifications;
}
1;