Files
scripts/Perl OTRS/Kernel/System/Console/Command/Internal/BashCompletion.pm
2024-10-14 00:08:40 +02:00

103 lines
3.0 KiB
Perl

# --
# Copyright (C) 2001-2019 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::Internal::BashCompletion;
use strict;
use warnings;
use Kernel::System::Console::InterfaceConsole;
use parent qw(Kernel::System::Console::BaseCommand Kernel::System::Console::Command::List);
our @ObjectDependencies = (
'Kernel::Config',
'Kernel::System::Main',
);
sub Configure {
my ( $Self, %Param ) = @_;
$Self->Description('Handles bash autocompletion.');
$Self->AddArgument(
Name => 'command',
Description => ".",
Required => 0,
ValueRegex => qr/.*/smx,
);
$Self->AddArgument(
Name => 'current-word',
Description => ".",
Required => 0,
ValueRegex => qr/.*/smx,
);
$Self->AddArgument(
Name => 'previous-word',
Description => ".",
Required => 0,
ValueRegex => qr/.*/smx,
);
return;
}
sub Run {
my ( $Self, %Param ) = @_;
my $CurrentWord = $Self->GetArgument('current-word');
my $PreviousWord = $Self->GetArgument('previous-word');
# We are looking for the command name
if ( $PreviousWord =~ m/otrs\.Console\.pl/xms ) {
# Get all matching commands
my @CommandList = $Self->ListAllCommands();
@CommandList = map { my $T = $_; $T =~ s/^Kernel::System::Console::Command:://xms; $T } @CommandList;
if ($CurrentWord) {
@CommandList = grep { $_ =~ m/\Q$CurrentWord\E/xms } @CommandList;
}
print join( "\n", @CommandList );
}
# We are looking for an option/argument
else {
# We need to extract the command name from the command line if present.
my $CompLine = $ENV{COMP_LINE};
if ( !$CompLine || !$CompLine =~ m/otrs\.Console\.pl/ ) {
$Self->ExitCodeError();
}
$CompLine =~ s/.*otrs\.Console\.pl\s*//xms;
my @Elements = split( m/\s+/, $CompLine );
# Try to create the command object to get its options
my $CommandName = $Elements[0];
my $CommandPath = 'Kernel::System::Console::Command::' . $CommandName;
if ( !$Kernel::OM->Get('Kernel::System::Main')->Require( $CommandPath, Silent => 1 ) ) {
return $Self->ExitCodeOk();
}
my $Command = $Kernel::OM->Get($CommandPath);
my @Options = @{ $Command->{_Options} // [] };
# Select matching options
@Options = map { '--' . $_->{Name} } @Options;
if ($CurrentWord) {
@Options = grep { $_ =~ m/\Q$CurrentWord\E/xms } @Options;
}
# Hide options that are already on the commandline
@Options = grep { $CompLine !~ m/(^|\s)\Q$_\E(\s|=|$)/xms } @Options;
print join( "\n", @Options );
}
return $Self->ExitCodeOk();
}
1;