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
|
# --
# 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::SupportDataCollector::PluginBase;
use strict;
use warnings;
use Scalar::Util qw();
use Kernel::Language qw(Translatable);
our $StatusUnknown = 0;
our $StatusInfo = 1;
our $StatusOK = 2;
our $StatusWarning = 3;
our $StatusProblem = 4;
our %Status2Name = (
$StatusUnknown => Translatable('Unknown'),
$StatusOK => Translatable('OK'),
$StatusWarning => Translatable('Warning'),
$StatusProblem => Translatable('Problem'),
$StatusInfo => Translatable('Information'),
);
our @ObjectDependencies = ();
sub new {
my ( $Type, %Param ) = @_;
# allocate new hash ref to object
my $Self = {};
bless( $Self, $Type );
return $Self;
}
# Override this in the plugins to specify their DisplayPath
sub GetDisplayPath {
return Translatable('General');
}
sub AddResultUnknown {
my ( $Self, %Param ) = @_;
return $Self->_AddResult(
%Param,
Status => $StatusUnknown,
);
}
sub AddResultInformation {
my ( $Self, %Param ) = @_;
return $Self->_AddResult(
%Param,
Status => $StatusInfo,
);
}
sub AddResultOk {
my ( $Self, %Param ) = @_;
return $Self->_AddResult(
%Param,
Status => $StatusOK,
);
}
sub AddResultWarning {
my ( $Self, %Param ) = @_;
return $Self->_AddResult(
%Param,
Status => $StatusWarning,
);
}
sub AddResultProblem {
my ( $Self, %Param ) = @_;
return $Self->_AddResult(
%Param,
Status => $StatusProblem,
);
}
sub _AddResult {
my ( $Self, %Param ) = @_;
my %Result = %Param;
$Result{Identifier} //= '';
$Result{Identifier} =~ s{:+}{_}; # Replace all :: in the Identifier
if ( $Result{Identifier} ) {
$Result{Identifier} = Scalar::Util::blessed($Self) . "::$Result{Identifier}";
}
else {
$Result{Identifier} = Scalar::Util::blessed($Self);
}
$Result{ShortIdentifier} = $Result{Identifier};
$Result{ShortIdentifier} =~ s{Kernel::System::SupportDataCollector::Plugin(Asynchronous)?::}{}xmsg;
$Result{DisplayPath} //= $Self->GetDisplayPath();
$Self->{Results} //= [];
push @{ $Self->{Results} }, \%Result;
return;
}
sub GetResults {
my ( $Self, %Param ) = @_;
return (
Success => 1,
Result => $Self->{Results} // [],
);
}
1;
|
