1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
|
# --
# Copyright (C) 2001-2021 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::InterfaceConsole;
use strict;
use warnings;
our @ObjectDependencies = (
'Kernel::System::Console::Command::List',
'Kernel::System::Main',
);
=head1 NAME
Kernel::System::Console::InterfaceConsole - console interface
=head1 DESCRIPTION
...
=head1 PUBLIC INTERFACE
=head2 new()
Don't use the constructor directly, use the ObjectManager instead:
my $InterfaceConsoleObject = $Kernel::OM->Get('Kernel::System::Console::InterfaceConsole');
=cut
sub new {
my ( $Type, %Param ) = @_;
my $Self = {};
bless( $Self, $Type );
return $Self;
}
=head2 Run()
execute a command. Returns the shell status code to be used by exit().
my $StatusCode = $InterfaceConsoleObject->Run( @ARGV );
=cut
sub Run {
my ( $Self, @CommandlineArguments ) = @_;
my $CommandName;
# Catch bash completion calls
if ( $ENV{COMP_LINE} ) {
$CommandName = 'Kernel::System::Console::Command::Internal::BashCompletion';
return $Kernel::OM->Get($CommandName)->Execute(@CommandlineArguments);
}
# If we don't have any arguments OR the first argument is an option and not a command name,
# show the overview screen instead.
if ( !@CommandlineArguments || substr( $CommandlineArguments[0], 0, 2 ) eq '--' ) {
$CommandName = 'Kernel::System::Console::Command::List';
return $Kernel::OM->Get($CommandName)->Execute(@CommandlineArguments);
}
# Ok, let's try to find the command.
$CommandName = 'Kernel::System::Console::Command::' . $CommandlineArguments[0];
if ( $Kernel::OM->Get('Kernel::System::Main')->Require( $CommandName, Silent => 1 ) ) {
# Regular case: everything was ok, execute command.
# Remove first parameter (command itself) to not confuse further parsing
shift @CommandlineArguments;
return $Kernel::OM->Get($CommandName)->Execute(@CommandlineArguments);
}
# If the command cannot be found/loaded, also show the overview screen.
my $CommandObject = $Kernel::OM->Get('Kernel::System::Console::Command::List');
$CommandObject->PrintError("Could not find $CommandName.\n\n");
$CommandObject->Execute();
return 127; # EXIT_CODE_COMMAND_NOT_FOUND, see http://www.tldp.org/LDP/abs/html/exitcodes.html
}
1;
=head1 TERMS AND CONDITIONS
This software is part of the OTRS project (L<https://otrs.org/>).
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 L<https://www.gnu.org/licenses/gpl-3.0.txt>.
=cut
|
