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
|
# --
# 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::Admin::WebService::Dump;
use strict;
use warnings;
use parent qw(Kernel::System::Console::BaseCommand);
our @ObjectDependencies = (
'Kernel::System::GenericInterface::Webservice',
'Kernel::System::Main',
'Kernel::System::YAML',
);
sub Configure {
my ( $Self, %Param ) = @_;
$Self->Description('Print a web service configuration (in YAML format) into a file.');
$Self->AddOption(
Name => 'webservice-id',
Description => "The ID of an existing web service.",
Required => 1,
HasValue => 1,
ValueRegex => qr/\A\d+\z/smx,
);
$Self->AddOption(
Name => 'target-path',
Description => "Specify the output location of the web service YAML configuration file.",
Required => 1,
HasValue => 1,
ValueRegex => qr/.*/smx,
);
return;
}
sub PreRun {
my ( $Self, %Param ) = @_;
my $WebServiceList = $Kernel::OM->Get('Kernel::System::GenericInterface::Webservice')->WebserviceList();
my $WebServiceID = $Self->GetOption('webservice-id');
if ( !$WebServiceList->{$WebServiceID} ) {
die "A web service with the ID $WebServiceID does not exists in this system.\n";
}
return;
}
sub Run {
my ( $Self, %Param ) = @_;
$Self->Print("<yellow>Dumping web service...</yellow>\n");
# get current web service
my $WebServiceID = $Self->GetOption('webservice-id');
my $WebService =
$Kernel::OM->Get('Kernel::System::GenericInterface::Webservice')->WebserviceGet(
ID => $WebServiceID,
);
if ( !$WebService ) {
$Self->PrintError("Could not get a web service with the ID $WebServiceID from the database!");
return $Self->ExitCodeError();
}
# dump config as string
my $Config = $Kernel::OM->Get('Kernel::System::YAML')->Dump( Data => $WebService->{Config} );
my $TargetPath = $Self->GetOption('target-path');
# write configuration in a file
my $FileLocation = $Kernel::OM->Get('Kernel::System::Main')->FileWrite(
Location => $TargetPath,
Content => \$Config,
Mode => 'utf8',
);
if ( !$FileLocation ) {
$Self->PrintError("Could not write file $TargetPath!");
return $Self->ExitCodeError();
}
$Self->Print("<green>Done.</green>\n");
return $Self->ExitCodeOk();
}
1;
|
