| 1 | package Sereal::Decoder; | ||
| 2 | use 5.014; | ||
| 3 | use strict; | ||
| 4 | use warnings; | ||
| 5 | use Carp qw/croak/; | ||
| 6 | use XSLoader; | ||
| 7 | |||
| 8 | our $VERSION = '7.003'; | ||
| 9 | our $XS_VERSION = $VERSION; $VERSION = eval $VERSION; | ||
| 10 | |||
| 11 | our $ChecksumPolicy; | ||
| 12 | our $UnknownOptionPolicy; | ||
| 13 | our $DefaultKey; | ||
| 14 | $Sereal::ChecksumPolicy = $ENV{SEREAL_CHECKSUM_POLICY} | ||
| 15 | if !defined($Sereal::ChecksumPolicy) && defined($ENV{SEREAL_CHECKSUM_POLICY}) && length($ENV{SEREAL_CHECKSUM_POLICY}); | ||
| 16 | $ChecksumPolicy = $ENV{SEREAL_DECODER_CHECKSUM_POLICY} | ||
| 17 | if !defined($ChecksumPolicy) && defined($ENV{SEREAL_DECODER_CHECKSUM_POLICY}) && length($ENV{SEREAL_DECODER_CHECKSUM_POLICY}); | ||
| 18 | $Sereal::UnknownOptionPolicy = $ENV{SEREAL_UNKNOWN_OPTION_POLICY} | ||
| 19 | if !defined($Sereal::UnknownOptionPolicy) && defined($ENV{SEREAL_UNKNOWN_OPTION_POLICY}) && length($ENV{SEREAL_UNKNOWN_OPTION_POLICY}); | ||
| 20 | $UnknownOptionPolicy = $ENV{SEREAL_DECODER_UNKNOWN_OPTION_POLICY} | ||
| 21 | if !defined($UnknownOptionPolicy) && defined($ENV{SEREAL_DECODER_UNKNOWN_OPTION_POLICY}) && length($ENV{SEREAL_DECODER_UNKNOWN_OPTION_POLICY}); | ||
| 22 | |||
| 23 | use Exporter 'import'; | ||
| 24 | our @EXPORT_OK = qw( | ||
| 25 | prepare_checksum_key | ||
| 26 | siphash24_128 | ||
| 27 | get_sereal_checksum | ||
| 28 | validate_sereal_checksum | ||
| 29 | siphash24 | ||
| 30 | siphash36_128 | ||
| 31 | decode_sereal | ||
| 32 | looks_like_sereal | ||
| 33 | decode_sereal_with_header_data | ||
| 34 | scalar_looks_like_sereal | ||
| 35 | sereal_decode_with_object | ||
| 36 | sereal_decode_with_header_with_object | ||
| 37 | sereal_decode_only_header_with_object | ||
| 38 | sereal_decode_only_header_with_offset_with_object | ||
| 39 | sereal_decode_with_header_and_offset_with_object | ||
| 40 | sereal_decode_with_offset_with_object | ||
| 41 | ); | ||
| 42 | our %EXPORT_TAGS = ( all => \@EXPORT_OK ); | ||
| 43 | |||
| 44 | # export by default if run from command line | ||
| 45 | our @EXPORT = ( ( caller() )[1] eq '-e' ? @EXPORT_OK : () ); | ||
| 46 | |||
| 47 | sub CLONE_SKIP { 1 } | ||
| 48 | XSLoader::load( 'Sereal::Decoder', $XS_VERSION ); | ||
| 49 | if ( !defined($DefaultKey) && defined( $ENV{SEREAL_DECODER_DEFAULT_KEY} ) ) { | ||
| 50 | my $key = $ENV{SEREAL_DECODER_DEFAULT_KEY}; | ||
| 51 | if ( $key =~ /\A[0-9a-fA-F]{32}\z/ ) { | ||
| 52 | $DefaultKey = pack( 'H*', $key ); | ||
| 53 | } | ||
| 54 | else { | ||
| 55 | warn "SEREAL_DECODER_DEFAULT_KEY is not exactly 32 hexadecimal characters; normalizing with Sereal::Decoder::prepare_checksum_key()\n"; | ||
| 56 | $DefaultKey = prepare_checksum_key($key); | ||
| 57 | } | ||
| 58 | } | ||
| 59 | unless ($Sereal::_DefaultKeyInitialized) { | ||
| 60 | if ( !defined($Sereal::DefaultKey) && defined( $ENV{SEREAL_DEFAULT_KEY} ) ) { | ||
| 61 | my $key = $ENV{SEREAL_DEFAULT_KEY}; | ||
| 62 | if ( $key =~ /\A[0-9a-fA-F]{32}\z/ ) { | ||
| 63 | $Sereal::DefaultKey = pack( 'H*', $key ); | ||
| 64 | } | ||
| 65 | else { | ||
| 66 | warn | ||
| 67 | "SEREAL_DEFAULT_KEY is not exactly 32 hexadecimal characters; normalizing with Sereal::Decoder::prepare_checksum_key()\n"; | ||
| 68 | $Sereal::DefaultKey = prepare_checksum_key($key); | ||
| 69 | } | ||
| 70 | } | ||
| 71 | $Sereal::_DefaultKeyInitialized = 1; | ||
| 72 | } | ||
| 73 | #start-no-tidy | ||
| 74 | use constant #begin generated | ||
| 75 | { | ||
| 76 | 'SRL_F_DECODER_ALIAS_CHECK_FLAGS' => 28672, | ||
| 77 | 'SRL_F_DECODER_ALIAS_SMALLINT' => 4096, | ||
| 78 | 'SRL_F_DECODER_ALIAS_VARINT' => 8192, | ||
| 79 | 'SRL_F_DECODER_ALLOW_UNKNOWN_LONG_DOUBLE' => 16777216, | ||
| 80 | 'SRL_F_DECODER_BIG_ENDIAN_FLOATS' => 8388608, | ||
| 81 | 'SRL_F_DECODER_DECOMPRESS_SNAPPY' => 8, | ||
| 82 | 'SRL_F_DECODER_DECOMPRESS_ZLIB' => 16, | ||
| 83 | 'SRL_F_DECODER_DECOMPRESS_ZSTD' => 131072, | ||
| 84 | 'SRL_F_DECODER_DESTRUCTIVE_INCREMENTAL' => 1024, | ||
| 85 | 'SRL_F_DECODER_DIRTY' => 2, | ||
| 86 | 'SRL_F_DECODER_FLOAT_BYTEORDER_SET' => 4194304, | ||
| 87 | 'SRL_F_DECODER_NEEDS_FINALIZE' => 4, | ||
| 88 | 'SRL_F_DECODER_NO_BLESS_OBJECTS' => 512, | ||
| 89 | 'SRL_F_DECODER_NO_THAW_OBJECTS' => 524288, | ||
| 90 | 'SRL_F_DECODER_PROTOCOL_V1' => 2048, | ||
| 91 | 'SRL_F_DECODER_READONLY_FLAGS' => 98304, | ||
| 92 | 'SRL_F_DECODER_REFUSE_OBJECTS' => 128, | ||
| 93 | 'SRL_F_DECODER_REFUSE_SNAPPY' => 32, | ||
| 94 | 'SRL_F_DECODER_REFUSE_ZLIB' => 64, | ||
| 95 | 'SRL_F_DECODER_REFUSE_ZSTD' => 262144, | ||
| 96 | 'SRL_F_DECODER_REUSE' => 1, | ||
| 97 | 'SRL_F_DECODER_SET_READONLY' => 32768, | ||
| 98 | 'SRL_F_DECODER_SET_READONLY_SCALARS' => 65536, | ||
| 99 | 'SRL_F_DECODER_THAW_DENY_RAW' => 1048576, | ||
| 100 | 'SRL_F_DECODER_USE_NATIVE_FLOATS' => 2097152, | ||
| 101 | 'SRL_F_DECODER_USE_UNDEF' => 16384, | ||
| 102 | 'SRL_F_DECODER_VALIDATE_UTF8' => 256, | ||
| 103 | 'SRL_F_DECODER_VOLATILE_FLAGS' => 133150, | ||
| 104 | '_FLAG_NAME' => [ | ||
| 105 | 'REUSE', | ||
| 106 | 'DIRTY', | ||
| 107 | 'NEEDS_FINALIZE', | ||
| 108 | 'DECOMPRESS_SNAPPY', | ||
| 109 | 'DECOMPRESS_ZLIB', | ||
| 110 | 'REFUSE_SNAPPY', | ||
| 111 | 'REFUSE_ZLIB', | ||
| 112 | 'REFUSE_OBJECTS', | ||
| 113 | 'VALIDATE_UTF8', | ||
| 114 | 'NO_BLESS_OBJECTS', | ||
| 115 | 'DESTRUCTIVE_INCREMENTAL', | ||
| 116 | 'PROTOCOL_V1', | ||
| 117 | 'ALIAS_SMALLINT', | ||
| 118 | 'ALIAS_VARINT', | ||
| 119 | 'USE_UNDEF', | ||
| 120 | 'SET_READONLY', | ||
| 121 | 'SET_READONLY_SCALARS', | ||
| 122 | 'DECOMPRESS_ZSTD', | ||
| 123 | 'REFUSE_ZSTD', | ||
| 124 | 'NO_THAW_OBJECTS', | ||
| 125 | 'THAW_DENY_RAW', | ||
| 126 | 'USE_NATIVE_FLOATS', | ||
| 127 | 'FLOAT_BYTEORDER_SET', | ||
| 128 | 'BIG_ENDIAN_FLOATS', | ||
| 129 | 'ALLOW_UNKNOWN_LONG_DOUBLE' | ||
| 130 | ], | ||
| 131 | '_FLAG_NAME_STATIC' => [ | ||
| 132 | 'REUSE', | ||
| 133 | undef, | ||
| 134 | undef, | ||
| 135 | undef, | ||
| 136 | undef, | ||
| 137 | 'REFUSE_SNAPPY', | ||
| 138 | 'REFUSE_ZLIB', | ||
| 139 | 'REFUSE_OBJECTS', | ||
| 140 | 'VALIDATE_UTF8', | ||
| 141 | 'NO_BLESS_OBJECTS', | ||
| 142 | 'DESTRUCTIVE_INCREMENTAL', | ||
| 143 | undef, | ||
| 144 | 'ALIAS_SMALLINT', | ||
| 145 | 'ALIAS_VARINT', | ||
| 146 | 'USE_UNDEF', | ||
| 147 | 'SET_READONLY', | ||
| 148 | 'SET_READONLY_SCALARS', | ||
| 149 | undef, | ||
| 150 | 'REFUSE_ZSTD', | ||
| 151 | 'NO_THAW_OBJECTS', | ||
| 152 | 'THAW_DENY_RAW', | ||
| 153 | 'USE_NATIVE_FLOATS', | ||
| 154 | 'FLOAT_BYTEORDER_SET', | ||
| 155 | 'BIG_ENDIAN_FLOATS', | ||
| 156 | 'ALLOW_UNKNOWN_LONG_DOUBLE' | ||
| 157 | ], | ||
| 158 | '_FLAG_NAME_VOLATILE' => [ | ||
| 159 | undef, | ||
| 160 | 'DIRTY', | ||
| 161 | 'NEEDS_FINALIZE', | ||
| 162 | 'DECOMPRESS_SNAPPY', | ||
| 163 | 'DECOMPRESS_ZLIB', | ||
| 164 | undef, | ||
| 165 | undef, | ||
| 166 | undef, | ||
| 167 | undef, | ||
| 168 | undef, | ||
| 169 | undef, | ||
| 170 | 'PROTOCOL_V1', | ||
| 171 | undef, | ||
| 172 | undef, | ||
| 173 | undef, | ||
| 174 | undef, | ||
| 175 | undef, | ||
| 176 | 'DECOMPRESS_ZSTD', | ||
| 177 | undef, | ||
| 178 | undef, | ||
| 179 | undef, | ||
| 180 | undef, | ||
| 181 | undef, | ||
| 182 | undef, | ||
| 183 | undef | ||
| 184 | ] | ||
| 185 | }; #end generated | ||
| 186 | #end-no-tidy | ||
| 187 | |||
| 188 | sub decode_from_file { | ||
| 189 | my ( $self, $file, ) = @_; # pos 3 is "target var" if one is provided | ||
| 190 | $self = $self->new() unless ref $self; | ||
| 191 | open my $fh, "<", $file | ||
| 192 | or die "Failed to open '$file' for read: $!"; | ||
| 193 | my $buf = do { local $/; <$fh> }; | ||
| 194 | close $fh | ||
| 195 | or die "Failed to close '$file': $!"; | ||
| 196 | if ( wantarray && ( $self->flags & SRL_F_DECODER_DESTRUCTIVE_INCREMENTAL ) ) { | ||
| 197 | my @ret; | ||
| 198 | while ( length $buf ) { | ||
| 199 | push @ret, $self->decode($buf); | ||
| 200 | } | ||
| 201 | return @ret; | ||
| 202 | } | ||
| 203 | return $self->decode( $buf, @_ > 2 ? $_[2] : () ); | ||
| 204 | } | ||
| 205 | |||
| 206 | my $flags = sub { | ||
| 207 | my ( $int, $ary ) = @_; | ||
| 208 | return map { ( $ary->[$_] and $int & ( 1 << $_ ) ) ? $ary->[$_] : () } ( 0 .. $#$ary ); | ||
| 209 | }; | ||
| 210 | |||
| 211 | sub flag_names { | ||
| 212 | my ( $self, $val ) = @_; | ||
| 213 | return $flags->( defined $val ? $val : $self->flags, _FLAG_NAME ); | ||
| 214 | } | ||
| 215 | |||
| 216 | sub flag_names_volatile { | ||
| 217 | my ( $self, $val ) = @_; | ||
| 218 | return $flags->( $val // $self->flags, _FLAG_NAME_VOLATILE ); | ||
| 219 | } | ||
| 220 | |||
| 221 | sub flag_names_static { | ||
| 222 | my ( $self, $val ) = @_; | ||
| 223 | return $flags->( $val // $self->flags, _FLAG_NAME_STATIC ); | ||
| 224 | } | ||
| 225 | |||
| 226 | 1; | ||
| 227 | |||
| 228 | __END__ |