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
|
# --
# 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::SysConfig::ValueType::File;
use strict;
use warnings;
use Kernel::System::VariableCheck qw(:all);
use parent qw(Kernel::System::SysConfig::BaseValueType);
our @ObjectDependencies = (
'Kernel::System::Log',
);
=head1 NAME
Kernel::System::SysConfig::ValueType::File - System configuration file value type backed.
=head1 PUBLIC INTERFACE
=head2 new()
Create an object. Do not use it directly, instead use:
use Kernel::System::ObjectManager;
local $Kernel::OM = Kernel::System::ObjectManager->new();
my $ValueTypeObject = $Kernel::OM->Get('Kernel::System::SysConfig::ValueType::File');
=cut
sub new {
my ( $Type, %Param ) = @_;
# Allocate new hash for object.
my $Self = {};
bless( $Self, $Type );
return $Self;
}
=head2 SettingEffectiveValueCheck()
Check if provided EffectiveValue matches structure defined in XMLContentParsed.
my %Result = $ValueTypeObject->SettingEffectiveValueCheck(
XMLContentParsed => {
Value => [
{
'Item' => [
{
'Content' => '/etc/hosts',
'ValueType' => 'File',
},
],
},
],
},
EffectiveValue => '/etc/hosts',
);
Result:
%Result = (
EffectiveValue => '/etc/hosts', # Note for File ValueTypes EffectiveValue is not changed.
Success => 1,
Error => undef,
);
=cut
sub SettingEffectiveValueCheck {
my ( $Self, %Param ) = @_;
for my $Needed (qw(XMLContentParsed)) {
if ( !$Param{$Needed} ) {
$Kernel::OM->Get('Kernel::System::Log')->Log(
Priority => 'error',
Message => "Need $Needed!"
);
return;
}
}
my %Result = (
Success => 0,
);
my $Value = $Param{XMLContentParsed}->{Value};
for my $Parameter ( sort keys %{ $Param{Parameters} } ) {
if ( !defined $Value->[0]->{Item}->[0]->{$Parameter} ) {
$Value->[0]->{Item}->[0]->{$Parameter} = $Param{Parameters}->{$Parameter};
}
}
# Data should be scalar.
if ( ref $Param{EffectiveValue} ) {
$Result{Error} = 'EffectiveValue for File must be a scalar!';
return %Result;
}
if ( !-e $Param{EffectiveValue} ) {
$Result{Error} = "$Param{EffectiveValue} not exists!";
return %Result;
}
my $IsDirectory = -d $Param{EffectiveValue};
if ($IsDirectory) {
$Result{Error} = "$Param{EffectiveValue} is directory, but file is expected!";
return %Result;
}
$Result{Success} = 1;
$Result{EffectiveValue} = $Param{EffectiveValue};
return %Result;
}
1;
=head1 TERMS AND CONDITIONS
This software is part of the OTRS project (L<https://otrs.org/>).
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 L<https://www.gnu.org/licenses/gpl-3.0.txt>.
=cut
|
