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
|
# --
# Copyright (C) 2021 Znuny GmbH, https://znuny.org/
# --
# This software comes with ABSOLUTELY NO WARRANTY. For details, see
# the enclosed file COPYING for license information (AGPL). If you
# did not receive this file, see http://www.gnu.org/licenses/agpl.txt.
# --
package Kernel::System::Autocompletion::Base;
use strict;
use warnings;
use Kernel::System::VariableCheck qw(:all);
our @ObjectDependencies = (
'Kernel::Config',
'Kernel::System::HTMLUtils',
'Kernel::System::Log',
);
sub new {
my ( $Type, %Param ) = @_;
my $Self = {%Param};
bless( $Self, $Type );
return $Self;
}
# Will be implemented in corresponding module.
sub GetData {
return;
}
=head2 _MapData()
Ensures correct format of returned data as expected by frontend.
my $Data = $AutocompletionObject->_MapData(
ID => 5,
SelectionListTitle => 'Title of object',
InsertedValue => 'Text to insert on selection',
);
Returns:
my $Data = {
id => 5,
selection_list_title => 'Title of object',
inserted_value => 'Text to insert on selection',
};
=cut
sub _MapData {
my ( $Self, %Param ) = @_;
my $LogObject = $Kernel::OM->Get('Kernel::System::Log');
my $ConfigObject = $Kernel::OM->Get('Kernel::Config');
my $HTMLUtilsObject = $Kernel::OM->Get('Kernel::System::HTMLUtils');
NEEDED:
for my $Needed (qw(ID SelectionListTitle InsertedValue)) {
next NEEDED if defined $Param{$Needed};
$LogObject->Log(
Priority => 'error',
Message => "Parameter '$Needed' is needed!",
);
return;
}
# Sanitize values for output in browser.
my $BlockLoadingRemoteContent = $ConfigObject->Get('Ticket::Frontend::BlockLoadingRemoteContent');
for my $ParamName (qw(ID SelectionListTitle InsertedValue)) {
my %SafetyCheckResult = $HTMLUtilsObject->Safety(
String => $Param{$ParamName} // '',
NoExtSrcLoad => $BlockLoadingRemoteContent,
NoApplet => 1,
NoObject => 1,
NoEmbed => 1,
NoSVG => 1,
NoJavaScript => 1,
);
$Param{$ParamName} = $SafetyCheckResult{String};
}
my $Data = {
id => $Param{ID},
selection_list_title => $Param{SelectionListTitle},
inserted_value => $Param{InsertedValue},
};
return $Data;
}
=head2 _GetModuleConfig()
Returns the config of the module from which it will be called.
my $ModuleConfig = $AutocompletionObject->_GetModuleConfig();
Returns:
my $ModuleConfig = {
Trigger => '!EX',
# ...
}:
=cut
sub _GetModuleConfig {
my ( $Self, %Param ) = @_;
my $ConfigObject = $Kernel::OM->Get('Kernel::Config');
my $ModuleConfigs = $ConfigObject->Get('Frontend::RichText::Autocompletion::Modules');
return if !IsHashRefWithData($ModuleConfigs);
my ($PackageName) = caller();
( my $ModuleName = $PackageName ) =~ s{\A.*::}{};
my $ModuleConfig = $ModuleConfigs->{$ModuleName};
return $ModuleConfig;
}
1;
|
