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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
|
# --
# 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::Command::List;
use strict;
use warnings;
use Kernel::System::Console::InterfaceConsole;
use parent qw(Kernel::System::Console::BaseCommand);
our @ObjectDependencies = (
'Kernel::Config',
'Kernel::System::Main',
);
sub Configure {
my ( $Self, %Param ) = @_;
$Self->Description('List available commands.');
return;
}
sub Run {
my ( $Self, %Param ) = @_;
my $ProductName = $Kernel::OM->Get('Kernel::Config')->Get('ProductName');
my $ProductVersion = $Kernel::OM->Get('Kernel::Config')->Get('Version');
my $UsageText = "<green>$ProductName</green> (<yellow>$ProductVersion</yellow>)\n\n";
$UsageText .= "<yellow>Usage:</yellow>\n";
$UsageText .= " otrs.Console.pl command [options] [arguments]\n";
$UsageText .= "\n<yellow>Options:</yellow>\n";
GLOBALOPTION:
for my $Option ( @{ $Self->{_GlobalOptions} // [] } ) {
next GLOBALOPTION if $Option->{Invisible};
my $OptionShort = "[--$Option->{Name}]";
$UsageText .= sprintf " <green>%-40s</green> - %s", $OptionShort, $Option->{Description} . "\n";
}
$UsageText .= "\n<yellow>Available commands:</yellow>\n";
my $PreviousCommandNameSpace = '';
COMMAND:
for my $Command ( $Self->ListAllCommands() ) {
my $CommandObject = $Kernel::OM->Get($Command);
my $CommandName = $CommandObject->Name();
# Group by toplevel namespace
my ($CommandNamespace) = $CommandName =~ m/^([^:]+)::/smx;
$CommandNamespace //= '';
if ( $CommandNamespace ne $PreviousCommandNameSpace ) {
$UsageText .= "<yellow>$CommandNamespace</yellow>\n";
$PreviousCommandNameSpace = $CommandNamespace;
}
$UsageText .= sprintf( " <green>%-40s</green> - %s\n", $CommandName, $CommandObject->Description() );
}
$Self->Print($UsageText);
return $Self->ExitCodeOk();
}
# =item ListAllCommands()
#
# returns all available commands, sorted first by directory and then by file name.
#
# my @Commands = $CommandObject->ListAllCommands();
#
# returns
#
# (
# 'Kernel::System::Console::Command::Help',
# 'Kernel::System::Console::Command::List',
# ...
# )
#
# =cut
sub ListAllCommands {
my ( $Self, %Param ) = @_;
my @CommandFiles = $Kernel::OM->Get('Kernel::System::Main')->DirectoryRead(
Directory => $Kernel::OM->Get('Kernel::Config')->Get('Home') . '/Kernel/System/Console/Command',
Filter => '*.pm',
Recursive => 1,
);
my @Commands;
COMMAND_FILE:
for my $CommandFile (@CommandFiles) {
next COMMAND_FILE if ( $CommandFile =~ m{/Internal/}xms );
$CommandFile =~ s{^.*(Kernel/System.*)[.]pm$}{$1}xmsg;
$CommandFile =~ s{/+}{::}xmsg;
push @Commands, $CommandFile;
}
# Sort first by directory, then by File
my $Sort = sub {
my ( $DirA, $FileA ) = split( /::(?=[^:]+$)/smx, $a );
my ( $DirB, $FileB ) = split( /::(?=[^:]+$)/smx, $b );
return $DirA cmp $DirB || $FileA cmp $FileB;
};
@Commands = sort $Sort @Commands;
return @Commands;
}
1;
|
