Changeset 24107 for main/trunk/greenstone2/perllib/cpan/Image/ExifTool/HTML.pm

Timestamp:

2011-06-01T12:33:42+12:00 (13 years ago)

Author:

sjm84

Message:

Updating the ExifTool perl modules

File:

• main/trunk/greenstone2/perllib/cpan/Image/ExifTool/HTML.pm (modified) (16 diffs)

main/trunk/greenstone2/perllib/cpan/Image/ExifTool/HTML.pm

@@ -21 +21 @@
 require Exporter;
 
-$VERSION = '1.03';
+$VERSION = '1.11';
 @ISA = qw(Exporter);
 @EXPORT_OK = qw(EscapeHTML UnescapeHTML);
+
+sub SetHTMLCharset($$);
+
+# convert HTML charset (lower case) to ExifTool Charset name
+my %htmlCharset = (
+    macintosh     => 'MacRoman',
+   'iso-8859-1'   => 'Latin',
+   'utf-8'        => 'UTF8',
+   'windows-1252' => 'Latin',
+);
 
 # HTML 4 character entity references
@@ -121 +131 @@
     NOTES => q{
         Meta information extracted from the header of HTML and XHTML files.  This is
-        a mix of information found in the C<META> elements and the C<TITLE> element.
+        a mix of information found in the C<META> elements, C<XML> element, and the
+        C<TITLE> element.
     },
     dc => {
@@ -142 +153 @@
         Name => 'HTTP-equiv',
         SubDirectory => { TagTable => 'Image::ExifTool::HTML::equiv' },
+    },
+    o => {
+        Name => 'Office',
+        SubDirectory => { TagTable => 'Image::ExifTool::HTML::Office' },
     },
     abstract        => { },
@@ -157 +172 @@
     keywords        => { List => 1 },
     mssmarttagspreventparsing => { Name => 'NoMSSmartTags' },
+    originator      => { },
     owner           => { },
     progid          => { Name => 'ProgID' },
@@ -195 +211 @@
 %Image::ExifTool::HTML::ncc = (
     GROUPS => { 1 => 'HTML-ncc', 2 => 'Document' },
-    charset         => { },
+    charset         => { Name => 'CharacterSet' }, # name changed to avoid conflict with -charset option
     depth           => { },
     files           => { },
@@ -209 +225 @@
     prodnotes       => { Name => 'ProdNotes' },
     producer        => { },
-    produceddate    => { Name => 'ProducedDate', Groups => { 2 => 'Time' } }, # yyyy-mm-dd
+    produceddate    => { Name => 'ProducedDate', Groups => { 2 => 'Time' } }, # YYYY-mm-dd
     revision        => { },
     revisiondate    => { Name => 'RevisionDate', Groups => { 2 => 'Time' } },
@@ -220 +236 @@
     sourcetitle     => { Name => 'SourceTitle' },
     tocitems        => { Name => 'TOCItems' },
-    totaltime       => { Name => 'Duration' }, # hh:mm:ss
+    totaltime       => { Name => 'Duration' }, # HH:MM:SS
 );
 
@@ -245 +261 @@
    'content-script-type' => { Name => 'ContentScriptType' },
    'content-style-type'  => { Name => 'ContentStyleType' },
-   'content-type'        => { Name => 'ContentType' },
+    # note: setting the HTMLCharset like this will miss any tags which come earlier
+   'content-type'        => { Name => 'ContentType', RawConv => \&SetHTMLCharset },
    'default-style'       => { Name => 'DefaultStyle' },
     expires              => { },
@@ -264 +281 @@
 );
 
+# MS Office namespace (ref PH)
+%Image::ExifTool::HTML::Office = (
+    GROUPS => { 1 => 'HTML-office', 2 => 'Document' },
+    NOTES => 'Tags written by Microsoft Office applications.',
+    Subject     => { },
+    Author      => { Groups => { 2 => 'Author' } },
+    Keywords    => { },
+    Description => { },
+    Template    => { },
+    LastAuthor  => { Groups => { 2 => 'Author' } },
+    Revision    => { Name => 'RevisionNumber' },
+    TotalTime   => { Name => 'TotalEditTime',   PrintConv => 'ConvertTimeSpan($val, 60)' },
+    Created     => {
+        Name => 'CreateDate',
+        Groups => { 2 => 'Time' },
+        ValueConv => 'Image::ExifTool::XMP::ConvertXMPDate($val)',
+        PrintConv => '$self->ConvertDateTime($val)',
+    },
+    LastSaved   => {
+        Name => 'ModifyDate',
+        Groups => { 2 => 'Time' },
+        ValueConv => 'Image::ExifTool::XMP::ConvertXMPDate($val)',
+        PrintConv => '$self->ConvertDateTime($val)',
+    },
+    LastSaved   => {
+        Name => 'ModifyDate',
+        Groups => { 2 => 'Time' },
+        ValueConv => 'Image::ExifTool::XMP::ConvertXMPDate($val)',
+        PrintConv => '$self->ConvertDateTime($val)',
+    },
+    LastPrinted => {
+        Name => 'LastPrinted',
+        Groups => { 2 => 'Time' },
+        ValueConv => 'Image::ExifTool::XMP::ConvertXMPDate($val)',
+        PrintConv => '$self->ConvertDateTime($val)',
+    },
+    Pages       => { },
+    Words       => { },
+    Characters  => { },
+    Category    => { },
+    Manager     => { },
+    Company     => { },
+    Lines       => { },
+    Paragraphs  => { },
+    CharactersWithSpaces => { },
+    Version     => { Name => 'RevisionNumber' },
+);
+
+#------------------------------------------------------------------------------
+# Set HTMLCharset member based on content type
+# Inputs: 0) content type string, 1) ExifTool ref
+# Returns: original string
+sub SetHTMLCharset($$)
+{
+    my ($val, $exifTool) = @_;
+    $$exifTool{HTMLCharset} = $htmlCharset{lc $1} if $val =~ /charset=['"]?([-\w]+)/;
+    return $val;
+}
+
 #------------------------------------------------------------------------------
 # Convert single UTF-8 character to HTML character reference
 # Inputs: 0) UTF-8 character sequence
-# Returns: HML character reference (ie. "&quot;");
+# Returns: HTML character reference (ie. "&quot;");
 # Note: Must be called via EscapeHTML to load name lookup
 sub EscapeChar($)
 {
     my $ch = shift;
-    my ($val) = ($] >= 5.006001) ? unpack('U0U',$ch) : UnpackUTF8($ch);
+    my $val;
+    if ($] < 5.006001) {
+        ($val) = Image::ExifTool::UnpackUTF8($ch);
+    } else {
+        # the meaning of "U0" is reversed as of Perl 5.10.0!
+        ($val) = unpack($] < 5.010000 ? 'U0U' : 'C0U', $ch);
+    }
     return '?' unless defined $val;
     return "&$entityName{$val};" if $entityName{$val};
@@ -297 +379 @@
             delete $entityName{39};  # 'apos' is not valid HTML
         }
-        # supress warnings
+        # suppress warnings
         local $SIG{'__WARN__'} = sub { 1 };
         # escape any non-ascii characters for HTML
@@ -322 +404 @@
     my ($exifTool, $dirInfo) = @_;
     my $raf = $$dirInfo{RAF};
-    my $verbose = $exifTool->Options('Verbose');
-    my ($buff, $err);
+    my $buff;
 
     # validate HTML or XHTML file
     $raf->Read($buff, 256) or return 0;
-    $buff =~ /^<(!DOCTYPE HTML|HTML|\?xml)/i or return 0;
-    $buff =~ /<(!DOCTYPE )?HTML/i or return 0 if $1 eq '?xml';
+    $buff =~ /^<(!DOCTYPE\s+HTML|HTML|\?xml)/i or return 0;
+    $buff =~ /<(!DOCTYPE\s+)?HTML/i or return 0 if $1 eq '?xml';
     $exifTool->SetFileType();
 
     $raf->Seek(0,0) or $exifTool->Warn('Seek error'), return 1;
 
-    my $oldsep = Image::ExifTool::PostScript::SetInputRecordSeparator($raf);
-    $oldsep or $exifTool->Warn('Invalid HTML data'), return 1;
+    local $/ = Image::ExifTool::PostScript::GetInputRecordSeparator($raf);
+    $/ or $exifTool->Warn('Invalid HTML data'), return 1;
 
     # extract header information
@@ -348 +429 @@
         last if $buff =~ m{</head>}i;
     }
+    return 1 unless defined $doc;
 
     # process all elements in header
@@ -371 +453 @@
         }
         my $table = $tagTablePtr;
-        # parse HTML META element
         if ($tag eq 'meta') {
+            # parse HTML META element
             undef $tag;
             # tag name is in NAME or HTTP-EQUIV attribute
@@ -396 +478 @@
                 }
             }
+        } elsif ($tag eq 'xml') {
+            $exifTool->VPrint(0, "Parsing XML\n");
+            # parse XML tags (quick-and-dirty)
+            my $xml = $val;
+            while ($xml =~ /<([\w-]+):([\w-]+)(\s.*?)?>([^<]*?)<\/\1:\2>/g) {
+                ($grp, $tag, $val) = ($1, $2, $4);
+                my $tagInfo = $exifTool->GetTagInfo($tagTablePtr, $grp);
+                next unless $tagInfo and $$tagInfo{SubDirectory};
+                $table = GetTagTable($tagInfo->{SubDirectory}->{TagTable});
+                unless ($$table{$tag}) {
+                    my $name = ucfirst $tag;
+                    $name =~ s/_x([0-9a-f]{4})_/chr(hex($1))/gie; # convert hex codes
+                    $name =~ s/\s(.)/\U$1/g;     # capitalize all words in tag name
+                    $name =~ tr/-_a-zA-Z0-9//dc; # remove illegal characters (also hex code wide chars)
+                    Image::ExifTool::AddTagToTable($table, $tag, { Name => $name });
+                    $exifTool->VPrint(0, "  [adding $tag '$name']\n");
+                }
+                $val = $exifTool->Decode($val, $$exifTool{HTMLCharset}) if $$exifTool{HTMLCharset};
+                $exifTool->HandleTag($table, $tag, UnescapeXML($val));
+            }
+            next;
         } else {
-            # the only non-META element we process is TITLE
+            # the only other element we process is TITLE
             next unless $tag eq 'title';
         }
@@ -408 +511 @@
             $exifTool->VPrint(0, "  [adding $tag '$tagName']\n");
         }
+        # recode if necessary
+        $val = $exifTool->Decode($val, $$exifTool{HTMLCharset}) if $$exifTool{HTMLCharset};
         $val =~ s{\s*$/\s*}{ }sg;   # replace linefeeds and indenting spaces
         $val = UnescapeHTML($val);  # unescape HTML character references
         $exifTool->HandleTag($table, $tag, $val);
     }
-    $/ = $oldsep;   # restore original separator
     return 1;
 }
@@ -435 +539 @@
 =head1 AUTHOR
 
-Copyright 2003-2007, Phil Harvey (phil at owl.phy.queensu.ca)
+Copyright 2003-2011, Phil Harvey (phil at owl.phy.queensu.ca)
 
 This library is free software; you can redistribute it and/or modify it