# --
# Copyright (C) 2001-2020 OTRS AG, https://otrs.com/
# --
# This software comes with ABSOLUTELY NO WARRANTY. For details, see
# the enclosed file COPYING for license information (GPL). If you
# did not receive this file, see https://www.gnu.org/licenses/gpl-3.0.txt.
# --
package Kernel::System::Console::Command::Admin::Package::Uninstall;
use strict;
use warnings;
use parent qw(Kernel::System::Console::BaseCommand Kernel::System::Console::Command::Admin::Package::List);
our @ObjectDependencies = (
'Kernel::System::Cache',
'Kernel::System::Package',
);
sub Configure {
my ( $Self, %Param ) = @_;
$Self->Description('Uninstall an OTRS package.');
$Self->AddOption(
Name => 'force',
Description => 'Force package uninstallation even if validation fails.',
Required => 0,
HasValue => 0,
);
$Self->AddArgument(
Name => 'location',
Description =>
"Specify a file path, a remote repository (http://ftp.otrs.org/pub/otrs/packages/:Package-1.0.0.opm) or just any online repository (online:Package).",
Required => 1,
ValueRegex => qr/.*/smx,
);
return;
}
sub Run {
my ( $Self, %Param ) = @_;
$Self->Print("Uninstalling package...\n");
my $CacheObject = $Kernel::OM->Get('Kernel::System::Cache');
# Enable in-memory cache to improve SysConfig performance, which is normally disabled for commands.
$CacheObject->Configure(
CacheInMemory => 1,
);
my $FileString = $Self->_PackageContentGet( Location => $Self->GetArgument('location') );
return $Self->ExitCodeError() if !$FileString;
# get package file from db
# parse package
my %Structure = $Kernel::OM->Get('Kernel::System::Package')->PackageParse(
String => $FileString,
);
# just un-install it if PackageIsRemovable flag is enable
if (
defined $Structure{PackageIsRemovable}
&& !$Structure{PackageIsRemovable}->{Content}
)
{
my $Error = "Not possible to remove this package!\n";
# exchange message if package should not be visible
if (
defined $Structure{PackageIsVisible}
&& !$Structure{PackageIsVisible}->{Content}
)
{
$Error = "No such package!\n";
}
$Self->PrintError($Error);
return $Self->ExitCodeError();
}
# intro screen
if ( $Structure{IntroUninstall} ) {
my %Data = $Self->_PackageMetadataGet(
Tag => $Structure{IntroUninstall},
AttributeFilterKey => 'Type',
AttributeFilterValue => 'pre',
);
if ( $Data{Description} ) {
print "+----------------------------------------------------------------------------+\n";
print "| $Structure{Name}->{Content}-$Structure{Version}->{Content}\n";
print "$Data{Title}";
print "$Data{Description}";
print "+----------------------------------------------------------------------------+\n";
}
}
# Uninstall
my $Success = $Kernel::OM->Get('Kernel::System::Package')->PackageUninstall(
String => $FileString,
Force => $Self->GetOption('force'),
);
if ( !$Success ) {
$Self->PrintError("Package uninstallation failed.");
return $Self->ExitCodeError();
}
# intro screen
if ( $Structure{IntroUninstallPost} ) {
my %Data = $Self->_PackageMetadataGet(
Tag => $Structure{IntroUninstall},
AttributeFilterKey => 'Type',
AttributeFilterValue => 'post',
);
if ( $Data{Description} ) {
print "+----------------------------------------------------------------------------+\n";
print "| $Structure{Name}->{Content}-$Structure{Version}->{Content}\n";
print "$Data{Title}";
print "$Data{Description}";
print "+----------------------------------------------------------------------------+\n";
}
}
# Disable in memory cache.
$CacheObject->Configure(
CacheInMemory => 0,
);
$Self->Print("Done.\n");
return $Self->ExitCodeOk();
}
1;