/usr/share/perl5/File/MimeInfo/Magic.pm is in libfile-mimeinfo-perl 0.26-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 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 | package File::MimeInfo::Magic;
use strict;
use Carp;
use Fcntl 'SEEK_SET';
use File::BaseDir qw/data_files/;
require File::MimeInfo;
require Exporter;
BEGIN {
no strict "refs";
for (qw/extensions describe globs inodetype default/) {
*{$_} = \&{"File::MimeInfo::$_"};
}
}
our @ISA = qw(Exporter File::MimeInfo);
our @EXPORT = qw(mimetype);
our @EXPORT_OK = qw(extensions describe globs inodetype magic);
our $VERSION = '0.26';
our $DEBUG;
our $_hashed = 0;
our (@magic_80, @magic, $max_buffer);
# @magic_80 and @magic are used to store the parse tree of magic data
# @magic_80 contains magic rules with priority 80 and higher, @magic the rest
# $max_buffer contains the maximum number of chars to be buffered from a non-seekable
# filehandle in order to do magic mimetyping
sub mimetype {
my $file = pop;
croak 'subroutine "mimetype" needs a filename as argument' unless defined $file;
return magic($file) || default($file) if ref $file;
return &File::MimeInfo::mimetype($file) unless -s $file and -r _;
my ($mimet, $fh);
return $mimet if $mimet = inodetype($file);
($mimet, $fh) = _magic($file, \@magic_80); # high priority rules
return $mimet if $mimet;
return $mimet if $mimet = globs($file);
($mimet, $fh) = _magic($fh, \@magic); # lower priority rules
close $fh if ref $fh;
return $mimet if $mimet;
return default($file);
}
sub magic {
my $file = pop;
croak 'subroutine "magic" needs a filename as argument' unless defined $file;
return undef unless ref($file) || -s $file;
print STDERR "> Checking all magic rules\n" if $DEBUG;
my ($mimet, $fh) = _magic($file, \@magic_80, \@magic);
close $fh unless ref $file;
return $mimet;
}
sub _magic {
my ($file, @rules) = @_;
_rehash() unless $_hashed;
my $fh;
unless (ref $file) {
open $fh, '<', $file or return undef;
binmode $fh;
}
else { $fh = $file }
for my $type (map @$_, @rules) {
for (2..$#$type) {
next unless _check_rule($$type[$_], $fh, 0);
close $fh unless ref $file;
return ($$type[1], $fh);
}
}
return (undef, $fh);
}
sub _check_rule {
my ($ref, $fh, $lev) = @_;
my $line;
# Read
if (ref $fh eq 'GLOB') {
seek($fh, $$ref[0], SEEK_SET); # seek offset
read($fh, $line, $$ref[1]); # read max length
}
else { # allowing for IO::Something
$fh->seek($$ref[0], SEEK_SET); # seek offset
$fh->read($line, $$ref[1]); # read max length
}
# Match regex
$line = unpack 'b*', $line if $$ref[2]; # unpack to bits if using mask
return undef unless $line =~ $$ref[3]; # match regex
print STDERR '>', '>'x$lev, ' Value "', _escape_bytes($2),
'" at offset ', $$ref[1]+length($1),
" matches at $$ref[4]\n"
if $DEBUG;
return 1 unless $#$ref > 4;
# Check nested rules and recurs
for (5..$#$ref) {
return 1 if _check_rule($$ref[$_], $fh, $lev+1);
}
print STDERR "> Failed nested rules\n" if $DEBUG && ! $lev;
return 0;
}
sub rehash {
&File::MimeInfo::rehash();
&_rehash();
#use Data::Dumper;
#print Dumper \@magic_80, \@magic;
}
sub _rehash {
local $_; # limit scope of $_ ... :S
($max_buffer, @magic_80, @magic) = (32); # clear data
my @magicfiles = @File::MimeInfo::DIRS
? ( grep {-e $_ && -r $_}
map "$_/magic", @File::MimeInfo::DIRS )
: ( reverse data_files('mime/magic') ) ;
my @done;
for my $file (@magicfiles) {
next if grep {$file eq $_} @done;
_hash_magic($file);
push @done, $file;
}
@magic = sort {$$b[0] <=> $$a[0]} @magic;
while ($magic[0][0] >= 80) {
push @magic_80, shift @magic;
}
$_hashed = 1;
}
sub _hash_magic {
my $file = shift;
open MAGIC, '<', $file
|| croak "Could not open file '$file' for reading";
binmode MAGIC;
<MAGIC> eq "MIME-Magic\x00\n"
or carp "Magic file '$file' doesn't seem to be a magic file";
my $line = 1;
while (<MAGIC>) {
$line++;
if (/^\[(\d+):(.*?)\]\n$/) {
push @magic, [$1,$2];
next;
}
s/^(\d*)>(\d+)=(.{2})//s
|| warn "$file line $line skipped\n" && next;
my ($i, $o, $l) = ($1, $2, unpack 'n', $3);
# indent, offset, value length
while (length($_) <= $l) {
$_ .= <MAGIC>;
$line++;
}
my $v = substr $_, 0, $l, ''; # value
/^(?:&(.{$l}))?(?:~(\d+))?(?:\+(\d+))?\n$/s
|| warn "$file line $line skipped\n" && next;
my ($m, $w, $r) = ($1, $2 || 1, $3 || 1);
# mask, word size, range
my $mdef = defined $m;
# possible big endian to little endian conversion
# as a bonus perl also takes care of weird endian cases
if ( $w != 1 ) {
my ( $utpl, $ptpl );
if ( 2 == $w ) {
$v = pack 'S', unpack 'n', $v;
$m = pack 'S', unpack 'n', $m if $mdef;
}
elsif ( 4 == $w ) {
$v = pack 'L', unpack 'N', $v;
$m = pack 'L', unpack 'N', $m if $mdef;
}
else {
warn "Unsupported word size: $w octets ".
" at $file line $line\n"
}
}
my $end = $o + $l + $r - 1;
$max_buffer = $end if $max_buffer < $end;
my $ref = $i ? _find_branch($i) : $magic[-1];
$r--; # 1-based => 0-based range for regex
$r *= 8 if $mdef; # bytes => bits for matching a mask
my $reg = '^'
. ( $r ? "(.{0,$r}?)" : '()' )
. ( $mdef ? '('. _mask_regex($v, $m) .')'
: '('. quotemeta($v) .')' ) ;
push @$ref, [
$o, $end, # offset, offset+length+range
$mdef, # boolean for mask
qr/$reg/sm, # the regex to match
undef # debug data
];
$$ref[-1][-1] = "$file line $line" if $DEBUG;
}
close MAGIC;
}
sub _find_branch { # finds last branch of tree of rules
my $i = shift;
my $ref = $magic[-1];
for (1..$i) { $ref = $$ref[-1] }
return $ref;
}
sub _mask_regex { # build regex based on mask
my ($v, $m) = @_;
my @v = split '', unpack "b*", $v;
my @m = split '', unpack "b*", $m;
my $re = '';
for (0 .. $#m) {
$re .= $m[$_] ? $v[$_] : '.' ;
# If $mask = 1 than ($input && $mask) will be same as $input
# If $mask = 0 than ($input && $mask) is always 0
# But $mask = 0 only makes sense if $value = 0
# So if $mask = 0 we ignore that bit of $input
}
return $re;
}
sub _escape_bytes { # used for debug output
my $string = shift;
if ($string =~ /[\x00-\x1F\x7F]/) {
$string = join '', map {
my $o = ord($_);
($o < 32) ? '^' . chr($o + 64) :
($o == 127) ? '^?' : $_ ;
} split '', $string;
}
return $string;
}
1;
__END__
=head1 NAME
File::MimeInfo::Magic - Determine file type with magic
=head1 SYNOPSIS
use File::MimeInfo::Magic;
my $mime_type = mimetype($file);
=head1 DESCRIPTION
This module inherits from L<File::MimeInfo>, it is transparent
to its functions but adds support for the freedesktop magic file.
Magic data is hashed when you need it for the first time.
If you want to force hashing earlier use the C<rehash()> function.
=head1 EXPORT
The method C<mimetype> is exported by default. The methods C<magic>,
C<inodetype>, C<globs> and C<describe> can be exported on demand.
=head1 METHODS
See also L<File::MimeInfo> for methods that are inherited.
=over 4
=item C<mimetype($file)>
Returns a mime-type string for C<$file>, returns undef on failure.
This method bundles C<inodetype()>, C<globs()> and C<magic()>.
Magic rules with an priority of 80 and higher are checked before
C<globs()> is called, all other magic rules afterwards.
If this doesn't work the file is read and the mime-type defaults
to 'text/plain' or to 'application/octet-stream' when the first ten chars
of the file match ascii control chars (white spaces excluded).
If the file doesn't exist or isn't readable C<undef> is returned.
If C<$file> is an object reference only C<magic> and the default method
are used. See below for details.
=item C<magic($file)>
Returns a mime-type string for C<$file> based on the magic rules,
returns undef on failure.
C<$file> can be an object reference, in that case it is supposed to have a
C<seek()> and a C<read()> method. This allows you for example to determine
the mimetype of data in memory by using L<IO::Scalar>.
Be aware that when using a filehandle or an C<IO::> object you need to set
the C<:utf8> binmode yourself if appropriate.
=item C<rehash()>
Rehash the data files. Glob and magic
information is preparsed when this method is called.
If you want to by-pass the XDG basedir system you can specify your database
directories by setting C<@File::MimeInfo::DIRS>. But normally it is better to
change the XDG basedir environment variables.
=item C<default>
=item C<describe>
=item C<extensions>
=item C<globs>
=item C<inodetype>
These routines are imported from L<File::MimeInfo>.
=back
=head1 SEE ALSO
L<File::MimeInfo>
=head1 LIMITATIONS
Only word sizes of 1, 2 or 4 are supported. Any other word size is ignored
and will cause a warning.
=head1 AUTHOR
Jaap Karssenberg E<lt>pardus@cpan.orgE<gt>
Maintained by Michiel Beijen E<lt>michiel.beijen@gmail.comE<gt>
=head1 COPYRIGHT
Copyright (c) 2003, 2012 Jaap G Karssenberg. All rights reserved.
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
|