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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
|
# --
# 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::Dev::Code::Generate::ConsoleCommand;
## nofilter(TidyAll::Plugin::OTRS::Perl::LayoutObject)
use strict;
use warnings;
use File::Path ();
use File::Basename ();
use parent qw(Kernel::System::Console::BaseCommand);
our @ObjectDependencies = (
'Kernel::Config',
'Kernel::System::Main',
'Kernel::Output::HTML::Layout',
);
sub Configure {
my ( $Self, %Param ) = @_;
$Self->Description('Generate a console command skeleton.');
$Self->AddOption(
Name => 'module-directory',
Description =>
"Specify the directory containing the module where the new command should be created (otherwise the OTRS home directory will be used).",
Required => 0,
HasValue => 1,
ValueRegex => qr/.*/smx,
);
$Self->AddArgument(
Name => 'name',
Description => "Specify the name of the new command (e.g. 'Admin::Test::Command').",
Required => 1,
ValueRegex => qr/.*/smx,
);
return;
}
sub PreRun {
my ( $Self, %Param ) = @_;
my $ModuleDirectory = $Self->GetOption('module-directory');
if ( $ModuleDirectory && !-d $ModuleDirectory ) {
die "Directory $ModuleDirectory does not exist.\n";
}
return;
}
sub Run {
my ( $Self, %Param ) = @_;
my $CommandName = $Self->GetArgument('name');
my $Home = $Kernel::OM->Get('Kernel::Config')->Get('Home');
my $TargetHome = $Home;
my $ModuleDirectory = $Self->GetOption('module-directory');
if ($ModuleDirectory) {
$TargetHome = $ModuleDirectory;
}
# Keep comment lines in files also in the generated output.
local $ENV{TEMPLATE_KEEP_COMMENTS} = 1;
# create perl module file
my $CommandPathPM = $CommandName . ".pm";
$CommandPathPM =~ s{::}{/}smxg;
my $SkeletonFilePM = __FILE__;
$SkeletonFilePM =~ s{ConsoleCommand\.pm$}{ConsoleCommand/ConsoleCommand.pm.skel}xms;
my $SkeletonTemplatePM = $Kernel::OM->Get('Kernel::System::Main')->FileRead(
Location => $SkeletonFilePM,
);
if ( !$SkeletonTemplatePM || !${$SkeletonTemplatePM} ) {
$Self->PrintError("Could not read $SkeletonFilePM.");
return $Self->ExitCodeError();
}
my $SkeletonPM = $Kernel::OM->Get('Kernel::Output::HTML::Layout')->Output(
Template => ${$SkeletonTemplatePM},
Data => {
CommandPath => $CommandPathPM,
CommandName => $CommandName,
},
);
my $TargetLocationPM = "$TargetHome/Kernel/System/Console/Command/$CommandPathPM";
my $TargetDirectoryPM = File::Basename::dirname($TargetLocationPM);
if ( !-d $TargetDirectoryPM ) {
File::Path::make_path($TargetDirectoryPM);
}
if ( -f $TargetLocationPM ) {
$Self->PrintError("$TargetLocationPM already exists.");
return $Self->ExitCodeError();
}
my $SuccessPM = $Kernel::OM->Get('Kernel::System::Main')->FileWrite(
Location => $TargetLocationPM,
Content => \$SkeletonPM,
);
if ($SuccessPM) {
$Self->Print("<green>Generated:</green> <yellow>$TargetLocationPM</yellow>\n");
}
else {
$Self->PrintError("Could not generate $TargetLocationPM.\n");
return $Self->ExitCodeError();
}
# create unit test file
my $CommandPathUT = $CommandName . ".t";
$CommandPathUT =~ s{::}{/}smxg;
my $SkeletonFileUT = __FILE__;
$SkeletonFileUT =~ s{ConsoleCommand\.pm$}{ConsoleCommand/ConsoleCommand.t.skel}xms;
my $SkeletonTemplateUT = $Kernel::OM->Get('Kernel::System::Main')->FileRead(
Location => $SkeletonFileUT,
);
if ( !$SkeletonTemplateUT || !${$SkeletonTemplateUT} ) {
$Self->PrintError("Could not read $SkeletonFileUT.");
return $Self->ExitCodeError();
}
my $SkeletonUT = $Kernel::OM->Get('Kernel::Output::HTML::Layout')->Output(
Template => ${$SkeletonTemplateUT},
Data => {
CommandPath => $CommandPathUT,
CommandName => $CommandName,
},
);
my $TargetLocationUT = "$TargetHome/scripts/test/Console/Command/$CommandPathUT";
my $TargetDirectoryUT = File::Basename::dirname($TargetLocationUT);
if ( !-d $TargetDirectoryUT ) {
File::Path::make_path($TargetDirectoryUT);
}
if ( -f $TargetLocationUT ) {
$Self->PrintError("$TargetLocationUT already exists.");
return $Self->ExitCodeError();
}
my $SuccessUT = $Kernel::OM->Get('Kernel::System::Main')->FileWrite(
Location => $TargetLocationUT,
Content => \$SkeletonUT,
);
if ($SuccessUT) {
$Self->Print("<green>Generated:</green> <yellow>$TargetLocationUT</yellow>\n");
return $Self->ExitCodeOk();
}
$Self->PrintError("Could not generate $TargetLocationUT.\n");
return $Self->ExitCodeError();
}
1;
|
