/usr/share/otrs/Kernel/System/YAML.pm is in otrs2 3.3.5-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 | # --
# Kernel/System/YAML.pm - YAML wrapper
# Copyright (C) 2001-2014 OTRS AG, http://otrs.com/
# --
# 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::YAML;
use strict;
use warnings;
use YAML::Any qw();
use YAML qw();
use Encode qw();
=head1 NAME
Kernel::System::YAML - YAML wrapper functions
=head1 SYNOPSIS
Functions for YAML serialization / deserialization.
=over 4
=cut
=item new()
create a YAML object
use Kernel::Config;
use Kernel::System::Encode;
use Kernel::System::Log;
use Kernel::System::YAML;
my $ConfigObject = Kernel::Config->new();
my $EncodeObject = Kernel::System::Encode->new(
ConfigObject => $ConfigObject,
);
my $LogObject = Kernel::System::Log->new(
ConfigObject => $ConfigObject,
EncodeObject => $EncodeObject,
);
my $YAMLObject = Kernel::System::YAML->new(
ConfigObject => $ConfigObject,
EncodeObject => $EncodeObject,
LogObject => $LogObject,
);
=cut
sub new {
my ( $Type, %Param ) = @_;
# allocate new hash for object
my $Self = {};
bless( $Self, $Type );
# check needed objects
for my $Object (qw(ConfigObject EncodeObject LogObject)) {
$Self->{$Object} = $Param{$Object} || die "Got no $Object!";
}
return $Self;
}
=item Dump()
Dump a perl data structure to a YAML string.
my $YAMLString = $YAMLObject->Dump(
Data => $Data,
);
=cut
sub Dump {
my ( $Self, %Param ) = @_;
# check for needed data
if ( !defined $Param{Data} ) {
$Self->{LogObject}->Log(
Priority => 'error',
Message => 'Need Data!',
);
return;
}
my $Result = YAML::Any::Dump( $Param{Data} ) || "--- ''\n";
# Make sure the resulting string has the UTF-8 flag.
Encode::_utf8_on($Result);
return $Result;
}
=item Load()
Load a YAML string to a perl data structure.
This string must be a encoded in UTF8.
my $PerlStructureScalar = $YAMLObject->Load(
Data => $YAMLString,
);
=cut
sub Load {
my ( $Self, %Param ) = @_;
# check for needed data
return if !defined $Param{Data};
if ( Encode::is_utf8( $Param{Data} ) ) {
Encode::_utf8_off( $Param{Data} );
}
my $Result;
if ( !eval { $Result = YAML::Any::Load( $Param{Data} ) } ) {
$Self->{LogObject}->Log(
Priority => 'error',
Message => 'Loading the YAML string failed: ' . $@,
);
$Self->{LogObject}->Log(
Priority => 'error',
Message => 'YAML data was: "' . $Param{Data} . '"',
);
# get used YAML implementation
my $YAMLImplementation = YAML::Any->implementation();
# if used implementation is pure perl YAML there is nothing to do, but exit with error
return if $YAMLImplementation eq 'YAML';
# otherwise use pure-perl YAML as fallback if YAML::XS or other can't parse the data
# structure correctly
if ( !eval { $Result = YAML::Load( $Param{Data} ) } ) {
$Self->{LogObject}->Log(
Priority => 'error',
Message => 'YAML data was not readable even by pure-perl YAML module',
);
return;
}
$Self->{LogObject}->Log(
Priority => 'error',
Message => 'Data was only readable pure-perl YAML module, please contact the'
. ' System Administrator to update this record, as the stored data is still in a'
. ' wrong format!',
);
}
# YAML does not set the UTF8 flag on strings that need it,
# do that manually now
if ( defined $Result ) {
_AddUTF8Flag( \$Result );
}
return $Result;
}
=begin Internal:
=item _AddUTF8Flag()
adds the UTF8 flag to all elements in a complex data structure.
=cut
sub _AddUTF8Flag {
my ($Data) = @_;
if ( !ref ${$Data} ) {
Encode::_utf8_on( ${$Data} );
return;
}
if ( ref ${$Data} eq 'SCALAR' ) {
return _AddUTF8Flag( ${$Data} );
}
if ( ref ${$Data} eq 'HASH' ) {
KEY:
for my $Key ( sort keys %{ ${$Data} } ) {
next KEY if !defined ${$Data}->{$Key};
_AddUTF8Flag( \${$Data}->{$Key} );
}
return;
}
if ( ref ${$Data} eq 'ARRAY' ) {
KEY:
for my $Key ( 0 .. $#{ ${$Data} } ) {
next KEY if !defined ${$Data}->[$Key];
_AddUTF8Flag( \${$Data}->[$Key] );
}
return;
}
if ( ref ${$Data} eq 'REF' ) {
return _AddUTF8Flag( ${$Data} );
}
#$Self->{LogObject}->Log(
# Priority => 'error',
# Message => "Unknown ref '" . ref( ${$Data} ) . "'!",
#);
return;
}
1;
=end Internal:
=back
=head1 TERMS AND CONDITIONS
This software is part of the OTRS project (L<http://otrs.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 L<http://www.gnu.org/licenses/agpl.txt>.
=cut
|