| 1 | ###########################################################################
|
|---|
| 2 | #
|
|---|
| 3 | # ReadTxtFile.pm -- base class for import plugins that have plain text files
|
|---|
| 4 | # A component of the Greenstone digital library software
|
|---|
| 5 | # from the New Zealand Digital Library Project at the
|
|---|
| 6 | # University of Waikato, New Zealand.
|
|---|
| 7 | #
|
|---|
| 8 | # Copyright (C) 1999-2005 New Zealand Digital Library Project
|
|---|
| 9 | #
|
|---|
| 10 | # This program is free software; you can redistribute it and/or modify
|
|---|
| 11 | # it under the terms of the GNU General Public License as published by
|
|---|
| 12 | # the Free Software Foundation; either version 2 of the License, or
|
|---|
| 13 | # (at your option) any later version.
|
|---|
| 14 | #
|
|---|
| 15 | # This program is distributed in the hope that it will be useful,
|
|---|
| 16 | # but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|---|
| 17 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|---|
| 18 | # GNU General Public License for more details.
|
|---|
| 19 | #
|
|---|
| 20 | # You should have received a copy of the GNU General Public License
|
|---|
| 21 | # along with this program; if not, write to the Free Software
|
|---|
| 22 | # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
|
|---|
| 23 | #
|
|---|
| 24 | ###########################################################################
|
|---|
| 25 |
|
|---|
| 26 | package ReadTextFile;
|
|---|
| 27 |
|
|---|
| 28 | use strict;
|
|---|
| 29 | no strict 'subs';
|
|---|
| 30 | no strict 'refs'; # allow filehandles to be variables and viceversa
|
|---|
| 31 |
|
|---|
| 32 | use Encode;
|
|---|
| 33 |
|
|---|
| 34 | use multiread;
|
|---|
| 35 | use encodings;
|
|---|
| 36 | use unicode;
|
|---|
| 37 | use textcat;
|
|---|
| 38 | use doc;
|
|---|
| 39 | use ghtml;
|
|---|
| 40 | use gsprintf 'gsprintf';
|
|---|
| 41 |
|
|---|
| 42 | use AutoExtractMetadata;
|
|---|
| 43 |
|
|---|
| 44 | sub BEGIN {
|
|---|
| 45 | @ReadTextFile::ISA = ( 'AutoExtractMetadata' );
|
|---|
| 46 | }
|
|---|
| 47 |
|
|---|
| 48 | my $encoding_plus_auto_list =
|
|---|
| 49 | [ { 'name' => "auto",
|
|---|
| 50 | 'desc' => "{ReadTextFile.input_encoding.auto}" } ];
|
|---|
| 51 | push(@{$encoding_plus_auto_list},@{$CommonUtil::encoding_list});
|
|---|
| 52 |
|
|---|
| 53 | my $arguments =
|
|---|
| 54 | [ { 'name' => "input_encoding",
|
|---|
| 55 | 'desc' => "{ReadTextFile.input_encoding}",
|
|---|
| 56 | 'type' => "enum",
|
|---|
| 57 | 'list' => $encoding_plus_auto_list,
|
|---|
| 58 | 'reqd' => "no" ,
|
|---|
| 59 | 'deft' => "auto" } ,
|
|---|
| 60 | { 'name' => "default_encoding",
|
|---|
| 61 | 'desc' => "{ReadTextFile.default_encoding}",
|
|---|
| 62 | 'type' => "enum",
|
|---|
| 63 | 'list' => $CommonUtil::encoding_list,
|
|---|
| 64 | 'reqd' => "no",
|
|---|
| 65 | 'deft' => "utf8" },
|
|---|
| 66 | { 'name' => "extract_language",
|
|---|
| 67 | 'desc' => "{ReadTextFile.extract_language}",
|
|---|
| 68 | 'type' => "flag",
|
|---|
| 69 | 'reqd' => "no" },
|
|---|
| 70 | { 'name' => "default_language",
|
|---|
| 71 | 'desc' => "{ReadTextFile.default_language}",
|
|---|
| 72 | 'type' => "string",
|
|---|
| 73 | 'deft' => "en",
|
|---|
| 74 | 'reqd' => "no" }
|
|---|
| 75 | ];
|
|---|
| 76 |
|
|---|
| 77 |
|
|---|
| 78 | my $options = { 'name' => "ReadTextFile",
|
|---|
| 79 | 'desc' => "{ReadTextFile.desc}",
|
|---|
| 80 | 'abstract' => "yes",
|
|---|
| 81 | 'inherits' => "no",
|
|---|
| 82 | 'args' => $arguments };
|
|---|
| 83 |
|
|---|
| 84 |
|
|---|
| 85 |
|
|---|
| 86 | sub new {
|
|---|
| 87 | my $class = shift (@_);
|
|---|
| 88 | my ($pluginlist,$inputargs,$hashArgOptLists, $auxiliary) = @_;
|
|---|
| 89 | push(@$pluginlist, $class);
|
|---|
| 90 |
|
|---|
| 91 | push(@{$hashArgOptLists->{"ArgList"}},@{$arguments});
|
|---|
| 92 | push(@{$hashArgOptLists->{"OptList"}},$options);
|
|---|
| 93 |
|
|---|
| 94 | my $self = new AutoExtractMetadata($pluginlist, $inputargs, $hashArgOptLists, $auxiliary);
|
|---|
| 95 |
|
|---|
| 96 | return bless $self, $class;
|
|---|
| 97 |
|
|---|
| 98 | }
|
|---|
| 99 |
|
|---|
| 100 |
|
|---|
| 101 |
|
|---|
| 102 | # The ReadTextFile read_into_doc_obj() function. This function does all the
|
|---|
| 103 | # right things to make general options work for a given plugin. It reads in
|
|---|
| 104 | # a file and sets up a slew of metadata all saved in doc_obj, which
|
|---|
| 105 | # it then returns as part of a tuple (process_status,doc_obj)
|
|---|
| 106 | #
|
|---|
| 107 | # Much of this functionality used to reside in read, but it was broken
|
|---|
| 108 | # down into a supporting routine to make the code more flexible.
|
|---|
| 109 | #
|
|---|
| 110 | # recursive plugins (e.g. RecPlug) and specialized plugins like those
|
|---|
| 111 | # capable of processing many documents within a single file (e.g.
|
|---|
| 112 | # GMLPlug) will normally want to implement their own version of
|
|---|
| 113 | # read_into_doc_obj()
|
|---|
| 114 | #
|
|---|
| 115 | # Note that $base_dir might be "" and that $file might
|
|---|
| 116 | # include directories
|
|---|
| 117 | sub read_into_doc_obj {
|
|---|
| 118 | my $self = shift (@_);
|
|---|
| 119 | my ($pluginfo, $base_dir, $file, $block_hash, $metadata, $processor, $maxdocs, $total_count, $gli) = @_;
|
|---|
| 120 |
|
|---|
| 121 | my $outhandle = $self->{'outhandle'};
|
|---|
| 122 | # should we move this to read? What about secondary plugins?
|
|---|
| 123 | print STDERR "<Processing n='$file' p='$self->{'plugin_type'}'>\n" if ($gli);
|
|---|
| 124 | my $pp_file = &util::prettyprint_file($base_dir,$file,$gli);
|
|---|
| 125 | print $outhandle "$self->{'plugin_type'} processing $pp_file\n"
|
|---|
| 126 | if $self->{'verbosity'} > 1;
|
|---|
| 127 |
|
|---|
| 128 | my ($filename_full_path, $filename_no_path) = &util::get_full_filenames($base_dir, $file);
|
|---|
| 129 |
|
|---|
| 130 | # Do encoding stuff
|
|---|
| 131 | my ($language, $content_encoding) = $self->textcat_get_language_encoding ($filename_full_path);
|
|---|
| 132 | if ($self->{'verbosity'} > 2) {
|
|---|
| 133 | print $outhandle "ReadTextFile: reading $file as ($content_encoding,$language)\n";
|
|---|
| 134 | }
|
|---|
| 135 |
|
|---|
| 136 | # create a new document
|
|---|
| 137 | my $doc_obj = new doc ($filename_full_path, "indexed_doc", $self->{'file_rename_method'});
|
|---|
| 138 | my $top_section = $doc_obj->get_top_section();
|
|---|
| 139 |
|
|---|
| 140 | # this should look at the plugin option too...
|
|---|
| 141 | $doc_obj->add_utf8_metadata($top_section, "Plugin", "$self->{'plugin_type'}");
|
|---|
| 142 | $doc_obj->add_utf8_metadata($top_section, "FileSize", (-s $filename_full_path));
|
|---|
| 143 |
|
|---|
| 144 | my $dirname = &File::Basename::dirname($file);
|
|---|
| 145 | $doc_obj->add_utf8_metadata($top_section, "SourceDirectory", $dirname);
|
|---|
| 146 |
|
|---|
| 147 | my $plugin_filename_encoding = $self->{'filename_encoding'};
|
|---|
| 148 | my $filename_encoding = $self->deduce_filename_encoding($file,$metadata,$plugin_filename_encoding);
|
|---|
| 149 | $self->set_Source_metadata($doc_obj, $filename_full_path, $filename_encoding);
|
|---|
| 150 |
|
|---|
| 151 | $doc_obj->add_utf8_metadata($top_section, "Language", $language);
|
|---|
| 152 | $doc_obj->add_utf8_metadata($top_section, "Encoding", $content_encoding);
|
|---|
| 153 |
|
|---|
| 154 | # read in file ($text will be in perl internal unicode aware format)
|
|---|
| 155 | my $text = "";
|
|---|
| 156 | $self->read_file ($filename_full_path, $content_encoding, $language, \$text);
|
|---|
| 157 |
|
|---|
| 158 | if (!length ($text)) {
|
|---|
| 159 | if ($gli) {
|
|---|
| 160 | print STDERR "<ProcessingError n='$file' r='File contains no text'>\n";
|
|---|
| 161 | }
|
|---|
| 162 | gsprintf($outhandle, "$self->{'plugin_type'}: {ReadTextFile.file_has_no_text}\n", $filename_full_path) if $self->{'verbosity'};
|
|---|
| 163 |
|
|---|
| 164 | my $failhandle = $self->{'failhandle'};
|
|---|
| 165 | gsprintf($failhandle, "$file: " . ref($self) . ": {ReadTextFile.empty_file}\n");
|
|---|
| 166 | # print $failhandle "$file: " . ref($self) . ": file contains no text\n";
|
|---|
| 167 | $self->{'num_not_processed'} ++;
|
|---|
| 168 |
|
|---|
| 169 | return (0,undef); # what should we return here?? error but don't want to pass it on
|
|---|
| 170 | }
|
|---|
| 171 |
|
|---|
| 172 | # do plugin specific processing of doc_obj
|
|---|
| 173 | unless (defined ($self->process (\$text, $pluginfo, $base_dir, $file, $metadata, $doc_obj, $gli))) {
|
|---|
| 174 | $text = '';
|
|---|
| 175 | undef $text;
|
|---|
| 176 | print STDERR "<ProcessingError n='$file'>\n" if ($gli);
|
|---|
| 177 | return (-1,undef);
|
|---|
| 178 | }
|
|---|
| 179 | $text='';
|
|---|
| 180 | undef $text;
|
|---|
| 181 |
|
|---|
| 182 | # include any metadata passed in from previous plugins
|
|---|
| 183 | # note that this metadata is associated with the top level section
|
|---|
| 184 | $self->add_associated_files($doc_obj, $filename_full_path);
|
|---|
| 185 | $self->extra_metadata ($doc_obj, $top_section, $metadata);
|
|---|
| 186 |
|
|---|
| 187 | # do any automatic metadata extraction
|
|---|
| 188 | $self->auto_extract_metadata ($doc_obj);
|
|---|
| 189 |
|
|---|
| 190 |
|
|---|
| 191 | # if we haven't found any Title so far, assign one
|
|---|
| 192 | $self->title_fallback($doc_obj,$top_section,$filename_no_path);
|
|---|
| 193 |
|
|---|
| 194 | if ($self->{'metadata_mapping_rules'}) {
|
|---|
| 195 | $self->apply_metadata_mapping_file($doc_obj);
|
|---|
| 196 | }
|
|---|
| 197 |
|
|---|
| 198 | $self->add_OID($doc_obj);
|
|---|
| 199 |
|
|---|
| 200 | $self->post_process_doc_obj($pluginfo, $base_dir, $file, $metadata, $doc_obj, $gli);
|
|---|
| 201 | return (1,$doc_obj);
|
|---|
| 202 | }
|
|---|
| 203 |
|
|---|
| 204 | # uses the multiread package to read in the entire file pointed to
|
|---|
| 205 | # by filename and loads the resulting text into $$textref. Input text
|
|---|
| 206 | # may be in any of the encodings handled by multiread, output text
|
|---|
| 207 | # will be in utf8
|
|---|
| 208 | sub read_file {
|
|---|
| 209 | my $self = shift (@_);
|
|---|
| 210 | my ($filename, $encoding, $language, $textref) = @_;
|
|---|
| 211 |
|
|---|
| 212 | if (!-r $filename)
|
|---|
| 213 | {
|
|---|
| 214 | my $outhandle = $self->{'outhandle'};
|
|---|
| 215 | gsprintf($outhandle, "{ReadTextFile.read_denied}\n", $filename) if $self->{'verbosity'};
|
|---|
| 216 | # print $outhandle "Read permission denied for $filename\n" if $self->{'verbosity'};
|
|---|
| 217 | return;
|
|---|
| 218 | }
|
|---|
| 219 | $$textref = "";
|
|---|
| 220 | if (!open (FILE, $filename)) {
|
|---|
| 221 | gsprintf(STDERR, "ReadTextFile::read_file {ReadTextFile.could_not_open_for_reading} ($!)\n", $filename);
|
|---|
| 222 | die "\n";
|
|---|
| 223 | }
|
|---|
| 224 |
|
|---|
| 225 | if ($encoding eq "ascii") {
|
|---|
| 226 | # The following file reading section is a candidate to use FileUtils::readUTF8File()
|
|---|
| 227 | # in place of calling sysread() directly. But only if we can reason we'd be working with UTF8.
|
|---|
| 228 | # ascii is UTF8, but it may become inefficient to treat ascii as utf8
|
|---|
| 229 |
|
|---|
| 230 | # Replace file 'slurp' with faster implementation
|
|---|
| 231 | sysread(FILE, $$textref, -s FILE);
|
|---|
| 232 |
|
|---|
| 233 | # The old slow way of reading in a file
|
|---|
| 234 | #undef $/;
|
|---|
| 235 | #$$textref = <FILE>;
|
|---|
| 236 | #$/ = "\n";
|
|---|
| 237 | } else {
|
|---|
| 238 | my $reader = new multiread();
|
|---|
| 239 | $reader->set_handle ('ReadTextFile::FILE');
|
|---|
| 240 | $reader->set_encoding ($encoding);
|
|---|
| 241 | $reader->read_file ($textref);
|
|---|
| 242 | }
|
|---|
| 243 |
|
|---|
| 244 | # At this point $$textref is a binary byte string
|
|---|
| 245 | # => turn it into a Unicode aware string, so full
|
|---|
| 246 | # Unicode aware pattern matching can be used.
|
|---|
| 247 | # For instance: 's/\x{0101}//g' or '[[:upper:]]'
|
|---|
| 248 | #
|
|---|
| 249 |
|
|---|
| 250 | $$textref = decode("utf8",$$textref);
|
|---|
| 251 |
|
|---|
| 252 | close FILE;
|
|---|
| 253 | }
|
|---|
| 254 |
|
|---|
| 255 |
|
|---|
| 256 | # Not currently used
|
|---|
| 257 | sub UNUSED_read_file_usingPerlsEncodeModule {
|
|---|
| 258 | ##sub read_file {
|
|---|
| 259 | my $self = shift (@_);
|
|---|
| 260 | my ($filename, $encoding, $language, $textref) = @_;
|
|---|
| 261 |
|
|---|
| 262 | if (!-r $filename)
|
|---|
| 263 | {
|
|---|
| 264 | my $outhandle = $self->{'outhandle'};
|
|---|
| 265 | gsprintf($outhandle, "{ReadTextFile.read_denied}\n", $filename) if $self->{'verbosity'};
|
|---|
| 266 | # print $outhandle "Read permission denied for $filename\n" if $self->{'verbosity'};
|
|---|
| 267 | return;
|
|---|
| 268 | }
|
|---|
| 269 | $$textref = "";
|
|---|
| 270 | if (!open (FILE, $filename)) {
|
|---|
| 271 | gsprintf(STDERR, "ReadTextFile::read_file {ReadTextFile.could_not_open_f
|
|---|
| 272 | or_reading} ($!)\n", $filename);
|
|---|
| 273 | die "\n";
|
|---|
| 274 | }
|
|---|
| 275 |
|
|---|
| 276 | my $store_slash = $/;
|
|---|
| 277 | undef $/;
|
|---|
| 278 | my $text = <FILE>;
|
|---|
| 279 | $/ = $store_slash;
|
|---|
| 280 |
|
|---|
| 281 | $$textref = decode($encoding,$text);
|
|---|
| 282 |
|
|---|
| 283 | close FILE;
|
|---|
| 284 | }
|
|---|
| 285 |
|
|---|
| 286 |
|
|---|
| 287 | sub read_file_no_decoding {
|
|---|
| 288 | my $self = shift (@_);
|
|---|
| 289 | my ($filename, $textref) = @_;
|
|---|
| 290 |
|
|---|
| 291 | if (!-r $filename)
|
|---|
| 292 | {
|
|---|
| 293 | my $outhandle = $self->{'outhandle'};
|
|---|
| 294 | gsprintf($outhandle, "{ReadTextFile.read_denied}\n", $filename) if $self->{'verbosity'};
|
|---|
| 295 | # print $outhandle "Read permission denied for $filename\n" if $self->{'verbosity'};
|
|---|
| 296 | return;
|
|---|
| 297 | }
|
|---|
| 298 | $$textref = "";
|
|---|
| 299 | if (!open (FILE, $filename)) {
|
|---|
| 300 | gsprintf(STDERR, "ReadTextFile::read_file {ReadTextFile.could_not_open_for_reading} ($!)\n", $filename);
|
|---|
| 301 | die "\n";
|
|---|
| 302 | }
|
|---|
| 303 |
|
|---|
| 304 | my $reader = new multiread();
|
|---|
| 305 | $reader->set_handle ('ReadTextFile::FILE');
|
|---|
| 306 | $reader->read_file_no_decoding ($textref);
|
|---|
| 307 |
|
|---|
| 308 | $self->{'reader'} = $reader;
|
|---|
| 309 |
|
|---|
| 310 | close FILE;
|
|---|
| 311 | }
|
|---|
| 312 |
|
|---|
| 313 |
|
|---|
| 314 | sub decode_text {
|
|---|
| 315 | my $self = shift (@_);
|
|---|
| 316 | my ($raw_text, $encoding, $language, $textref) = @_;
|
|---|
| 317 |
|
|---|
| 318 | my $reader = $self->{'reader'};
|
|---|
| 319 | if (!defined $reader) {
|
|---|
| 320 | gsprintf(STDERR, "ReadTextFile::decode_text needs to call ReadTextFile::read_file_no_decoding first\n");
|
|---|
| 321 | }
|
|---|
| 322 | else {
|
|---|
| 323 | $reader->set_encoding($encoding);
|
|---|
| 324 | $reader->decode_text($raw_text,$textref);
|
|---|
| 325 |
|
|---|
| 326 | # At this point $$textref is a binary byte string
|
|---|
| 327 | # => turn it into a Unicode aware string, so full
|
|---|
| 328 | # Unicode aware pattern matching can be used.
|
|---|
| 329 | # For instance: 's/\x{0101}//g' or '[[:upper:]]'
|
|---|
| 330 |
|
|---|
| 331 | $$textref = decode("utf8",$$textref);
|
|---|
| 332 | }
|
|---|
| 333 | }
|
|---|
| 334 |
|
|---|
| 335 |
|
|---|
| 336 | sub textcat_get_language_encoding {
|
|---|
| 337 | my $self = shift (@_);
|
|---|
| 338 | my ($filename) = @_;
|
|---|
| 339 |
|
|---|
| 340 | my ($language, $encoding, $extracted_encoding);
|
|---|
| 341 | if ($self->{'input_encoding'} eq "auto") {
|
|---|
| 342 | # use textcat to automatically work out the input encoding and language
|
|---|
| 343 | ($language, $encoding) = $self->get_language_encoding ($filename);
|
|---|
| 344 | } elsif ($self->{'extract_language'}) {
|
|---|
| 345 | # use textcat to get language metadata
|
|---|
| 346 | ($language, $extracted_encoding) = $self->get_language_encoding ($filename);
|
|---|
| 347 | $encoding = $self->{'input_encoding'};
|
|---|
| 348 | # don't print this message for english... english in utf8 is identical
|
|---|
| 349 | # to english in iso-8859-1 (except for some punctuation). We don't have
|
|---|
| 350 | # a language model for en_utf8, so textcat always says iso-8859-1!
|
|---|
| 351 | if ($extracted_encoding ne $encoding && $language ne "en" && $self->{'verbosity'}) {
|
|---|
| 352 | my $plugin_name = ref ($self);
|
|---|
| 353 | my $outhandle = $self->{'outhandle'};
|
|---|
| 354 | gsprintf($outhandle, "$plugin_name: {ReadTextFile.wrong_encoding}\n", $filename, $encoding, $extracted_encoding);
|
|---|
| 355 | }
|
|---|
| 356 | } else {
|
|---|
| 357 | $language = $self->{'default_language'};
|
|---|
| 358 | $encoding = $self->{'input_encoding'};
|
|---|
| 359 | }
|
|---|
| 360 |
|
|---|
| 361 | # print STDERR "**** language encoding of contents of file $filename:\n\t****$language $encoding\n";
|
|---|
| 362 |
|
|---|
| 363 | return ($language, $encoding);
|
|---|
| 364 | }
|
|---|
| 365 |
|
|---|
| 366 |
|
|---|
| 367 | # Uses textcat to work out the encoding and language of the text in
|
|---|
| 368 | # $filename. All html tags are removed before processing.
|
|---|
| 369 | # returns an array containing "language" and "encoding"
|
|---|
| 370 | sub get_language_encoding {
|
|---|
| 371 | my $self = shift (@_);
|
|---|
| 372 | my ($filename) = @_;
|
|---|
| 373 | my $outhandle = $self->{'outhandle'};
|
|---|
| 374 | my $unicode_format = "";
|
|---|
| 375 | my $best_language = "";
|
|---|
| 376 | my $best_encoding = "";
|
|---|
| 377 |
|
|---|
| 378 |
|
|---|
| 379 | # read in file
|
|---|
| 380 | if (!open (FILE, $filename)) {
|
|---|
| 381 | gsprintf(STDERR, "ReadTextFile::get_language_encoding {ReadTextFile.could_not_open_for_reading} ($!)\n", $filename);
|
|---|
| 382 | # this is a pretty bad error, but try to continue anyway
|
|---|
| 383 | return ($self->{'default_language'}, $self->{'input_encoding'});
|
|---|
| 384 | }
|
|---|
| 385 | undef $/;
|
|---|
| 386 | my $text = <FILE>;
|
|---|
| 387 | $/ = "\n";
|
|---|
| 388 | close FILE;
|
|---|
| 389 |
|
|---|
| 390 | # check if first few bytes have a Byte Order Marker
|
|---|
| 391 | my $bom=substr($text,0,2); # check 16bit unicode
|
|---|
| 392 | if ($bom eq "\xff\xfe") { # little endian 16bit unicode
|
|---|
| 393 | $unicode_format="unicode";
|
|---|
| 394 | } elsif ($bom eq "\xfe\xff") { # big endian 16bit unicode
|
|---|
| 395 | $unicode_format="unicode";
|
|---|
| 396 | } else {
|
|---|
| 397 | $bom=substr($text,0,3); # check utf-8
|
|---|
| 398 | if ($bom eq "\xef\xbb\xbf") { # utf-8 coded FEFF bom
|
|---|
| 399 | $unicode_format="utf8";
|
|---|
| 400 | # } elsif ($bom eq "\xef\xbf\xbe") { # utf-8 coded FFFE bom. Error!?
|
|---|
| 401 | # $unicode_format="utf8";
|
|---|
| 402 | }
|
|---|
| 403 | }
|
|---|
| 404 |
|
|---|
| 405 | my $found_html_encoding = 0;
|
|---|
| 406 | # handle html files specially
|
|---|
| 407 | # XXX this doesn't match plugins derived from HTMLPlug (except ConvertTo)
|
|---|
| 408 | if (ref($self) eq 'HTMLPlugin' ||
|
|---|
| 409 | (exists $self->{'converted_to'} && $self->{'converted_to'} eq 'HTML')){
|
|---|
| 410 |
|
|---|
| 411 | # remove comments in head, including multiline ones, so that we don't match on
|
|---|
| 412 | # inactive tags (those that are nested inside comments)
|
|---|
| 413 | my ($head) = ($text =~ m/<head>(.*)<\/head>/si);
|
|---|
| 414 | $head = "" unless defined $head; # some files are not proper HTML eg php files
|
|---|
| 415 | $head =~ s/<!--.*?-->//sg;
|
|---|
| 416 |
|
|---|
| 417 | # remove <title>stuff</title> -- as titles tend often to be in English
|
|---|
| 418 | # for foreign language documents
|
|---|
| 419 | $text =~ s!<title>.*?</title>!!si;
|
|---|
| 420 |
|
|---|
| 421 | # see if this html file specifies its encoding
|
|---|
| 422 | if ($text =~ /^<\?xml.*encoding="(.+?)"/) {
|
|---|
| 423 | $best_encoding = $1;
|
|---|
| 424 | }
|
|---|
| 425 | # check the meta http-equiv charset tag
|
|---|
| 426 | elsif ($head =~ m/<meta http-equiv.*content-type.*charset=(.+?)\"/si) {
|
|---|
| 427 | $best_encoding = $1;
|
|---|
| 428 | }
|
|---|
| 429 | if ($best_encoding) { # we extracted an encoding
|
|---|
| 430 | $best_encoding =~ s/-+/_/g;
|
|---|
| 431 | $best_encoding = lc($best_encoding); # lowercase
|
|---|
| 432 | if ($best_encoding eq "utf_8" || $best_encoding =~ /utf_8/) { $best_encoding = "utf8" }
|
|---|
| 433 | $found_html_encoding = 1;
|
|---|
| 434 | # We shouldn't be modifying this here!!
|
|---|
| 435 | #$self->{'input_encoding'} = $best_encoding;
|
|---|
| 436 | }
|
|---|
| 437 |
|
|---|
| 438 | # remove all HTML tags
|
|---|
| 439 | $text =~ s/<[^>]*>//sg;
|
|---|
| 440 | }
|
|---|
| 441 |
|
|---|
| 442 | # don't need to do textcat if we know the encoding now AND don't need to extract language
|
|---|
| 443 | if($found_html_encoding && !$self->{'extract_language'}) { # encoding specified in html file
|
|---|
| 444 | $best_language = $self->{'default_language'};
|
|---|
| 445 | }
|
|---|
| 446 |
|
|---|
| 447 | else { # need to use textcat to get either the language, or get both language and encoding
|
|---|
| 448 | $self->{'textcat'} = new textcat() if (!defined($self->{'textcat'}));
|
|---|
| 449 |
|
|---|
| 450 | if($found_html_encoding) { # know encoding, find language by limiting search to known encoding
|
|---|
| 451 | my $results = $self->{'textcat'}->classify_contents_for_encoding(\$text, $filename, $best_encoding);
|
|---|
| 452 |
|
|---|
| 453 | my $language;
|
|---|
| 454 | ($language) = $results->[0] =~ m/^([^-]*)(?:-(?:.*))?$/ if (scalar @$results > 0);
|
|---|
| 455 |
|
|---|
| 456 | if (!defined $language || scalar @$results > 3) {
|
|---|
| 457 | # if there were too many results even when restricting results by encoding,
|
|---|
| 458 | # or if there were no results, use default language with the known encoding
|
|---|
| 459 | $best_language = $self->use_default_language($filename);
|
|---|
| 460 | }
|
|---|
| 461 | else { # fewer than 3 results means textcat is more certain, use the first result
|
|---|
| 462 | $best_language = $language;
|
|---|
| 463 | }
|
|---|
| 464 | }
|
|---|
| 465 | else { # don't know encoding or language yet, therefore we use textcat
|
|---|
| 466 | my $results = $self->{'textcat'}->classify_contents(\$text, $filename);
|
|---|
| 467 |
|
|---|
| 468 | # if textcat returns 3 or less possibilities we'll use the first one in the list
|
|---|
| 469 | if (scalar @$results <= 3) { # results will be > 0 when we don't constrain textcat by an encoding
|
|---|
| 470 | my ($language, $encoding) = $results->[0] =~ m/^([^-]*)(?:-(.*))?$/;
|
|---|
| 471 |
|
|---|
| 472 | $language = $self->use_default_language($filename) unless defined $language;
|
|---|
| 473 | $encoding = $self->use_default_encoding($filename) unless defined $encoding;
|
|---|
| 474 |
|
|---|
| 475 | $best_language = $language;
|
|---|
| 476 | $best_encoding = $encoding;
|
|---|
| 477 | }
|
|---|
| 478 | else { # if (scalar @$results > 3) {
|
|---|
| 479 | if ($unicode_format) { # in case the first had a BOM
|
|---|
| 480 | $best_encoding=$unicode_format;
|
|---|
| 481 | }
|
|---|
| 482 | else {
|
|---|
| 483 | # Find the most frequent encoding in the textcat results returned
|
|---|
| 484 | # Returns "" if there's no encoding more frequent than another
|
|---|
| 485 | $best_encoding = $self->{'textcat'}->most_frequent_encoding($results);
|
|---|
| 486 | }
|
|---|
| 487 |
|
|---|
| 488 | if ($best_encoding eq "") { # encoding still not set, use defaults
|
|---|
| 489 | $best_language = $self->use_default_language($filename);
|
|---|
| 490 | $best_encoding = $self->use_default_encoding($filename);
|
|---|
| 491 | }
|
|---|
| 492 | elsif (!$self->{'extract_language'}) { # know encoding but don't need to discover language
|
|---|
| 493 | $best_language = $self->use_default_language($filename);
|
|---|
| 494 | }
|
|---|
| 495 | else { # textcat again using the most frequent encoding or the $unicode_format set above
|
|---|
| 496 | $results = $self->{'textcat'}->classify_contents_for_encoding(\$text, $filename, $best_encoding);
|
|---|
| 497 | my $language;
|
|---|
| 498 | ($language) = $results->[0] =~ m/^([^-]*)(?:-(.*))?$/ if (scalar @$results > 0);
|
|---|
| 499 | if (!defined $language || scalar @$results > 3) {
|
|---|
| 500 | # if no result or too many results, use default language for the encoding previously found
|
|---|
| 501 | $best_language = $self->use_default_language($filename);
|
|---|
| 502 | }
|
|---|
| 503 | else { # fewer than 3 results, use the language of the first result
|
|---|
| 504 | $best_language = $language;
|
|---|
| 505 | }
|
|---|
| 506 | }
|
|---|
| 507 | }
|
|---|
| 508 | }
|
|---|
| 509 | }
|
|---|
| 510 |
|
|---|
| 511 | if($best_encoding eq "" || $best_language eq "") {
|
|---|
| 512 | print STDERR "****Shouldn't happen: encoding and/or language still not set. Using defaults.\n";
|
|---|
| 513 | $best_encoding = $self->use_default_encoding($filename) if $best_encoding eq "";
|
|---|
| 514 | $best_language = $self->use_default_language($filename) if $best_language eq "";
|
|---|
| 515 | }
|
|---|
| 516 | # print STDERR "****Content language: $best_language; Encoding: $best_encoding.\n";
|
|---|
| 517 |
|
|---|
| 518 |
|
|---|
| 519 | if ($best_encoding =~ /^iso_8859/ && &unicode::check_is_utf8($text)) {
|
|---|
| 520 | # the text is valid utf8, so assume that's the real encoding
|
|---|
| 521 | # (since textcat is based on probabilities)
|
|---|
| 522 | $best_encoding = 'utf8';
|
|---|
| 523 | }
|
|---|
| 524 |
|
|---|
| 525 | # check for equivalents where textcat doesn't have some encodings...
|
|---|
| 526 | # eg MS versions of standard encodings
|
|---|
| 527 | if ($best_encoding =~ /^iso_8859_(\d+)/) {
|
|---|
| 528 | my $iso = $1; # which variant of the iso standard?
|
|---|
| 529 | # iso-8859 sets don't use chars 0x80-0x9f, windows codepages do
|
|---|
| 530 | if ($text =~ /[\x80-\x9f]/) {
|
|---|
| 531 | # Western Europe
|
|---|
| 532 | if ($iso == 1 or $iso == 15) { $best_encoding = 'windows_1252' }
|
|---|
| 533 | elsif ($iso == 2) {$best_encoding = 'windows_1250'} # Central Europe
|
|---|
| 534 | elsif ($iso == 5) {$best_encoding = 'windows_1251'} # Cyrillic
|
|---|
| 535 | elsif ($iso == 6) {$best_encoding = 'windows_1256'} # Arabic
|
|---|
| 536 | elsif ($iso == 7) {$best_encoding = 'windows_1253'} # Greek
|
|---|
| 537 | elsif ($iso == 8) {$best_encoding = 'windows_1255'} # Hebrew
|
|---|
| 538 | elsif ($iso == 9) {$best_encoding = 'windows_1254'} # Turkish
|
|---|
| 539 | }
|
|---|
| 540 | }
|
|---|
| 541 |
|
|---|
| 542 | if ($best_encoding !~ /^(ascii|utf8|unicode)$/ &&
|
|---|
| 543 | !defined $encodings::encodings->{$best_encoding}) {
|
|---|
| 544 | if ($self->{'verbosity'}) {
|
|---|
| 545 | gsprintf($outhandle, "ReadTextFile: {ReadTextFile.unsupported_encoding}\n",
|
|---|
| 546 | $filename, $best_encoding, $self->{'default_encoding'});
|
|---|
| 547 | }
|
|---|
| 548 | $best_encoding = $self->{'default_encoding'};
|
|---|
| 549 | }
|
|---|
| 550 |
|
|---|
| 551 | return ($best_language, $best_encoding);
|
|---|
| 552 | }
|
|---|
| 553 |
|
|---|
| 554 |
|
|---|
| 555 | sub use_default_language {
|
|---|
| 556 | my $self = shift (@_);
|
|---|
| 557 | my ($filename) = @_;
|
|---|
| 558 |
|
|---|
| 559 | if ($self->{'verbosity'}>2) {
|
|---|
| 560 | gsprintf($self->{'outhandle'},
|
|---|
| 561 | "ReadTextFile: {ReadTextFile.could_not_extract_language}\n",
|
|---|
| 562 | $filename, $self->{'default_language'});
|
|---|
| 563 | }
|
|---|
| 564 | return $self->{'default_language'};
|
|---|
| 565 | }
|
|---|
| 566 |
|
|---|
| 567 | sub use_default_encoding {
|
|---|
| 568 | my $self = shift (@_);
|
|---|
| 569 | my ($filename) = @_;
|
|---|
| 570 |
|
|---|
| 571 | if ($self->{'verbosity'}>2) {
|
|---|
| 572 | gsprintf($self->{'outhandle'},
|
|---|
| 573 | "ReadTextFile: {ReadTextFile.could_not_extract_encoding}\n",
|
|---|
| 574 | $filename, $self->{'default_encoding'});
|
|---|
| 575 | }
|
|---|
| 576 | return $self->{'default_encoding'};
|
|---|
| 577 | }
|
|---|
| 578 |
|
|---|
| 579 | # Overridden by exploding plugins (eg. ISISPlug)
|
|---|
| 580 | sub clean_up_after_exploding
|
|---|
| 581 | {
|
|---|
| 582 | my $self = shift(@_);
|
|---|
| 583 | }
|
|---|
| 584 |
|
|---|
| 585 |
|
|---|
| 586 | 1;
|
|---|
