This commit is contained in:
2024-10-14 00:08:40 +02:00
parent dbfba56f66
commit 1462d52e13
4572 changed files with 2658864 additions and 0 deletions

View File

@@ -0,0 +1,101 @@
# --
# 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::Admin::WebService::Add;
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('Create a new web service.');
$Self->AddOption(
Name => 'name',
Description => "The name of the new web service.",
Required => 1,
HasValue => 1,
ValueRegex => qr/.*/smx,
);
$Self->AddOption(
Name => 'source-path',
Description => "Specify the location of the web service YAML configuration file.",
Required => 1,
HasValue => 1,
ValueRegex => qr/.*/smx,
);
return;
}
sub PreRun {
my ( $Self, %Param ) = @_;
my $SourcePath = $Self->GetOption('source-path');
if ( !-r $SourcePath ) {
die "Source file $SourcePath does not exist / is not readable.\n";
}
my $List = $Kernel::OM->Get('Kernel::System::GenericInterface::Webservice')->WebserviceList();
my %WebServiceLookup = reverse %{$List};
my $Name = $Self->GetOption('name');
if ( $WebServiceLookup{$Name} ) {
die "A web service with name $Name already exists in this system.\n";
}
return;
}
sub Run {
my ( $Self, %Param ) = @_;
$Self->Print("<yellow>Creating web service...</yellow>\n");
# read config
my $Content = $Kernel::OM->Get('Kernel::System::Main')->FileRead(
Location => $Self->GetOption('source-path'),
);
if ( !$Content ) {
$Self->PrintError('Could not read YAML source.');
return $Self->ExitCodeError();
}
my $Config = $Kernel::OM->Get('Kernel::System::YAML')->Load( Data => ${$Content} );
if ( !$Config ) {
$Self->PrintError('Could not parse YAML source.');
return $Self->ExitCodeError();
}
# add new web service
my $ID = $Kernel::OM->Get('Kernel::System::GenericInterface::Webservice')->WebserviceAdd(
Name => $Self->GetOption('name'),
Config => $Config,
ValidID => 1,
UserID => 1,
);
if ( !$ID ) {
$Self->PrintError('Could not create web service!');
return $Self->ExitCodeError();
}
$Self->Print("<green>Done.</green>\n");
return $Self->ExitCodeOk();
}
1;

View File

@@ -0,0 +1,80 @@
# --
# 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::Admin::WebService::Delete;
use strict;
use warnings;
use parent qw(Kernel::System::Console::BaseCommand);
our @ObjectDependencies = (
'Kernel::System::GenericInterface::Webservice',
);
sub Configure {
my ( $Self, %Param ) = @_;
$Self->Description('Delete an existing web service.');
$Self->AddOption(
Name => 'webservice-id',
Description => "The ID of an existing web service.",
Required => 1,
HasValue => 1,
ValueRegex => qr/\A\d+\z/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>Deleting 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();
}
# web service delete
my $Success = $Kernel::OM->Get('Kernel::System::GenericInterface::Webservice')->WebserviceDelete(
ID => $WebServiceID,
UserID => 1,
);
if ( !$Success ) {
$Self->PrintError('Could not delete web service!');
return $Self->ExitCodeError();
}
$Self->Print("<green>Done.</green>\n");
return $Self->ExitCodeOk();
}
1;

View File

@@ -0,0 +1,95 @@
# --
# 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::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;

View File

@@ -0,0 +1,42 @@
# --
# 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::Admin::WebService::List;
use strict;
use warnings;
use parent qw(Kernel::System::Console::BaseCommand);
our @ObjectDependencies = (
'Kernel::System::GenericInterface::Webservice',
);
sub Configure {
my ( $Self, %Param ) = @_;
$Self->Description('List all web services.');
return;
}
sub Run {
my ( $Self, %Param ) = @_;
$Self->Print("<yellow>Listing all web services...</yellow>\n");
my $List = $Kernel::OM->Get('Kernel::System::GenericInterface::Webservice')->WebserviceList();
for my $ID ( sort keys %{$List} ) {
print " $List->{$ID} ($ID)\n";
}
$Self->Print("<green>Done.</green>\n");
return $Self->ExitCodeOk();
}
1;

View File

@@ -0,0 +1,113 @@
# --
# 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::Admin::WebService::Update;
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('Update an existing web service.');
$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 => 'source-path',
Description => "Specify the location of the web service YAML configuration file.",
Required => 1,
HasValue => 1,
ValueRegex => qr/.*/smx,
);
return;
}
sub PreRun {
my ( $Self, %Param ) = @_;
my $SourcePath = $Self->GetOption('source-path');
if ( !-r $SourcePath ) {
die "Source file $SourcePath does not exist / is not readable.\n";
}
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>Updating web service...</yellow>\n");
# read config
my $Content = $Kernel::OM->Get('Kernel::System::Main')->FileRead(
Location => $Self->GetOption('source-path'),
);
if ( !$Content ) {
$Self->PrintError('Could not read YAML source.');
return $Self->ExitCodeError();
}
my $Config = $Kernel::OM->Get('Kernel::System::YAML')->Load( Data => ${$Content} );
if ( !$Config ) {
$Self->PrintError('Could not parse YAML source.');
return $Self->ExitCodeError();
}
# 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();
}
# update web service
my $Success = $Kernel::OM->Get('Kernel::System::GenericInterface::Webservice')->WebserviceUpdate(
ID => $WebService->{ID},
Name => $WebService->{Name},
Config => $Config,
ValidID => 1,
UserID => 1,
);
if ( !$Success ) {
$Self->PrintError('Could not update web service!');
return $Self->ExitCodeError();
}
$Self->Print("<green>Done.</green>\n");
return $Self->ExitCodeOk();
}
1;