#!/usr/bin/env perl # docx2txt, a command-line utility to convert Docx documents to text format. # Copyright (C) 2008-2014 Sandeep Kumar # # This program is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program; if not, write to the Free Software # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA # # This script extracts text from document.xml contained inside .docx file. # Perl v5.10.1 was used for testing this script. # # Author : Sandeep Kumar (shimple0 -AT- Yahoo .DOT. COM) # # ChangeLog : # # 10/08/2008 - Initial version (v0.1) # 15/08/2008 - Script takes two arguments [second optional] now and can be # used independently to extract text from docx file. It accepts # docx file directly, instead of xml file. # 18/08/2008 - Added support for center and right justification of text that # fits in a line 80 characters wide (adjustable). # 03/09/2008 - Fixed the slip in usage message. # 12/09/2008 - Slightly changed the script invocation and argument handling # to incorporate some of the shell script functionality here. # Added support to handle embedded urls in docx document. # 23/09/2008 - Changed #! line to use /usr/bin/env - good suggestion from # Rene Maroufi (info>ATDOTATDOTATDOT '&', apos => '\'', gt => '>', lt => '<', quot => '"', acute => '\'', brvbar => '|', copy => '(C)', divide => '/', laquo => '<<', macr => '-', nbsp => ' ', raquo => '>>', reg => '(R)', shy => '-', times => 'x' ); my %splchars = ( "\xC2" => { "\xA0" => ' ', # non-breaking space "\xA2" => 'cent', # "\xA3" => 'Pound', # "\xA5" => 'Yen', # "\xA6" => '|', # broken vertical bar # "\xA7" => '', # section "\xA9" => '(C)', # copyright "\xAB" => '<<', # angle quotation mark (left) "\xAC" => '-', # negation "\xAE" => '(R)', # registered trademark "\xB1" => '+-', # plus-or-minus "\xB4" => '\'', # "\xB5" => 'u', # # "\xB6" => '', # paragraph "\xBB" => '>>', # angle quotation mark (right) "\xBC" => '(1/4)', # fraction 1/4 "\xBD" => '(1/2)', # fraction 1/2 "\xBE" => '(3/4)', # fraction 3/4 }, "\xC3" => { "\x97" => 'x', # multiplication "\xB7" => '/', # division }, "\xCF" => { "\x80" => 'PI', # }, "\xE2\x80" => { "\x82" => ' ', # en space "\x83" => ' ', # em space "\x85" => ' ', # "\x93" => ' - ', # en dash "\x94" => ' -- ', # em dash "\x95" => '--', # "\x98" => '`', # "\x99" => '\'', # "\x9C" => '"', # "\x9D" => '"', # "\xA2" => '::', # "\xA6" => '...', # horizontal ellipsis "\xB0" => '%.', # per mille }, "\xE2\x82" => { "\xAC" => 'Euro' # }, "\xE2\x84" => { "\x85" => 'c/o', # "\x97" => '(P)', # "\xA0" => '(SM)', # "\xA2" => '(TM)', # trademark "\xA6" => 'Ohm', # }, "\xE2\x85" => { "\x93" => '(1/3)', "\x94" => '(2/3)', "\x95" => '(1/5)', "\x96" => '(2/5)', "\x97" => '(3/5)', "\x98" => '(4/5)', "\x99" => '(1/6)', "\x9B" => '(1/8)', "\x9C" => '(3/8)', "\x9D" => '(5/8)', "\x9E" => '(7/8)', "\x9F" => '1/', }, "\xE2\x86" => { "\x90" => '<--', # left arrow "\x92" => '-->', # right arrow "\x94" => '<-->', # left right arrow }, "\xE2\x88" => { "\x82" => 'd', # partial differential "\x9E" => 'infinity', }, "\xE2\x89" => { "\xA0" => '!=', # "\xA4" => '<=', # "\xA5" => '>=', # }, "\xEF\x82" => { "\xB7" => '*' # small white square } ); # # Check argument(s) sanity. # my $usage = < outfile.txt In second usage, output is dumped on STDOUT. Use '-h' as the first argument to get this usage information. Use '-' as the infile name to read the docx file from STDIN. Use '-' as the outfile name to dump the text on STDOUT. Output is saved in infile.txt if second argument is omitted. Note: infile.docx can also be a directory name holding the unzipped content of concerned .docx file. USAGE die $usage if (@ARGV > 2 || $ARGV[0] eq '-h'); # # Look for configuration file in current directory/ user configuration # directory/ system configuration directory - in the given order. # my %config; if (-f "docx2txt.config") { %config = do 'docx2txt.config'; } elsif (-f "$userConfigDir/docx2txt.config") { %config = do "$userConfigDir/docx2txt.config"; } elsif (-f "$systemConfigDir/docx2txt.config") { %config = do "$systemConfigDir/docx2txt.config"; } if (%config) { foreach my $var (keys %config) { $$var = $config{$var}; } } # # Check for unzip utility, before proceeding further. # die "Failed to locate unzip command '$config_unzip'!\n" if ! -f $config_unzip; # # Handle cases where this script reads docx file from STDIN. # if (@ARGV == 0) { $ARGV[0] = '-'; $ARGV[1] = '-'; $inputFileName = "STDIN"; } elsif (@ARGV == 1 && $ARGV[0] eq '-') { $ARGV[1] = '-'; $inputFileName = "STDIN"; } else { $inputFileName = $ARGV[0]; } if ($ARGV[0] eq '-') { $tempFile = "${config_tempDir}/dx2tTemp_${$}_" . time() . ".docx"; open my $fhTemp, "> $tempFile" or die "Can't create temporary file for storing docx file read from STDIN!\n"; binmode $fhTemp; local $/ = undef; my $docxFileContent = ; print $fhTemp $docxFileContent; close $fhTemp; $ARGV[0] = $tempFile; } # # Check for existence and readability of required file in specified directory, # and whether it is a text file. # sub check_for_required_file_in_folder { stat("$_[1]/$_[0]"); die "Can't read <$_[0]> in <$_[1]>!\n" if ! (-f _ && -r _); die "<$_[1]/$_[0]> does not seem to be a text file!\n" if ! -T _; } sub readFileInto { local $/ = undef; open my $fh, "$_[0]" or die "Couldn't read file <$_[0]>!\n"; binmode $fh; $_[1] = <$fh>; close $fh; } sub readOptionalFileInto { local $/ = undef; stat("$_[0]"); if (-f _) { if (-r _ && -T _) { open my $fh, "$_[0]" or die "Couldn't read file <$_[0]>!\n"; binmode $fh; $_[1] = <$fh>; close $fh; } else { die "Invalid <$_[0]>!\n"; } } } # # Check whether first argument is specifying a directory holding extracted # content of .docx file, or .docx file itself. # sub cleandie { unlink("$tempFile") if -e "$tempFile"; die "$_[0]"; } stat($ARGV[0]); if (-d _) { check_for_required_file_in_folder("word/document.xml", $ARGV[0]); check_for_required_file_in_folder("word/_rels/document.xml.rels", $ARGV[0]); $inpIsDir = 'y'; } else { cleandie "Can't read docx file <$inputFileName>!\n" if ! (-f _ && -r _); cleandie "<$inputFileName> does not seem to be a docx file!\n" if -T _; } # # Extract xml document content from argument docx file/directory. # my $unzip_cmd = "'$config_unzip' $config_unzip_opts"; if ($inpIsDir eq 'y') { readFileInto("$ARGV[0]/word/document.xml", $content); } else { $content = `$unzip_cmd "$ARGV[0]" word/document.xml 2>$nullDevice`; } cleandie "Failed to extract required information from <$inputFileName>!\n" if ! $content; # # Be ready for outputting the extracted text contents. # if (@ARGV == 1) { $ARGV[1] = $ARGV[0]; # Remove any trailing slashes to generate proper output filename, when # input is directory. $ARGV[1] =~ s%[/\\]+$%% if ($inpIsDir eq 'y'); $ARGV[1] .= ".txt" if !($ARGV[1] =~ s/\.docx$/\.txt/); } my $txtfile; open($txtfile, "> $ARGV[1]") || cleandie "Can't create <$ARGV[1]> for output!\n"; binmode $txtfile; # Ensure no auto-conversion of '\n' to '\r\n' on Windows. # # Gather information about header, footer, hyperlinks, images, footnotes etc. # if ($inpIsDir eq 'y') { readFileInto("$ARGV[0]/word/_rels/document.xml.rels", $_); } else { $_ = `$unzip_cmd "$ARGV[0]" word/_rels/document.xml.rels 2>$nullDevice`; } my %docurels; while (//g) { $docurels{"$2:$1"} = $3; } # # Gather list numbering information. # $_ = ""; if ($inpIsDir eq 'y') { readOptionalFileInto("$ARGV[0]/word/numbering.xml", $_); } else { $_ = `$unzip_cmd "$ARGV[0]" word/numbering.xml 2>$nullDevice`; } my %abstractNum; my @N2ANId = (); my %NFList = ( "bullet" => \&bullet, "decimal" => \&decimal, "lowerLetter" => \&lowerLetter, "upperLetter" => \&upperLetter, "lowerRoman" => \&lowerRoman, "upperRoman" => \&upperRoman ); if ($_) { while (/(.*?)<\/w:abstractNum>/g) { my $abstractNumId = $1, $temp = $2; while ($temp =~ /]*>]*>]*>.*?]*>.*?]*>/g ) { # $2: Start $3: NumFmt, $4: LvlText, ($5,$6): (Indent (twips), hanging) @{$abstractNum{"$abstractNumId:$1"}} = ( $NFList{$3}, $4, $2, int ((($5-$6) / $config_twipsPerChar) + 0.5), $5 ); } } while ( /]*?>//og; $hltext .= " [HYPERLINK: $hlink]" if (lc $config_showHyperLink eq "y" && $hltext ne $hlink); return $hltext; } # # Subroutines for processing numbering information. # my @RomanNumbers = ( "", "i", "ii", "iii", "iv", "v", "vi", "vii", "viii", "ix", "x", "xi", "xii", "xiii", "xiv", "xv", "xvi", "xvii", "xviii", "xix", "xx", "xxi", "xxii", "xxiii", "xxiv", "xxv", "xxvi", "xxvii", "xxviii", "xxix", "xxx", "xxxi", "xxxii", "xxxiii", "xxxiv", "xxxv", "xxxvi", "xxxvii", "xxxviii", "xxxix", "xl", "xli", "xlii", "xliii", "xliv", "xlv", "xlvi", "xlvii", "xlviii", "xlix", "l", "li" ); sub lowerRoman { return $RomanNumbers[$_[0]] if ($_[0] < @RomanNumbers); @rcode = ("i", "iv", "v", "ix", "x", "xl", "l", "xc", "c", "cd", "d", "cm", "m"); @dval = (1, 4, 5, 9, 10, 40, 50, 90, 100, 400, 500, 900, 1000); my $roman = ""; my $num = $_[0]; my $div, $i = (@rcode - 1); while ($num > 0) { $i-- while ($num < $dval[$i]); $div = $num / $dval[$i]; $num = $num % $dval[$i]; $roman .= $rcode[$i] x $div; } return $roman; } sub upperRoman { return uc lowerRoman(@_); } sub lowerLetter { @Alphabets = split '' , "abcdefghijklmnopqrstuvwxyz"; return $Alphabets[($_[0] % 26) - 1] x (($_[0] - 1)/26 + 1); } sub upperLetter { return uc lowerLetter(@_); } sub decimal { return $_[0]; } my %bullets = ( "\x6F" => 'o', "\xEF\x81\xB6" => '::', # Diamond "\xEF\x82\xA7" => '#', # Small Black Square "\xEF\x82\xB7" => '*', # Small Black Circle "\xEF\x83\x98" => '>', # Arrowhead "\xEF\x83\xBC" => '+' # Right Sign ); sub bullet { return $bullets{$_[0]} ? $bullets{$_[0]} : 'oo'; } my @lastCnt = (0); my @twipStack = (0); my @keyStack = (undef); my $ssiz = 1; sub listNumbering { my $aref = \@{$abstractNum{"$N2ANId[$_[0]]:$_[1]"}}; my $lvlText; if ($aref->[0] != \&bullet) { my $key = "$N2ANId[$_[0]]:$_[1]"; my $ccnt; if ($aref->[4] < $twipStack[$ssiz-1]) { while ($twipStack[$ssiz-1] > $aref->[4]) { pop @twipStack; pop @keyStack; pop @lastCnt; $ssiz--; } } if ($aref->[4] == $twipStack[$ssiz-1]) { if ($key eq $keyStack[$ssiz-1]) { ++$lastCnt[$ssiz-1]; } else { $keyStack[$ssiz-1] = $key; $lastCnt[$ssiz-1] = $aref->[2]; } } elsif ($aref->[4] > $twipStack[$ssiz-1]) { push @twipStack, $aref->[4]; push @keyStack, $key; push @lastCnt, $aref->[2]; $ssiz++; } $ccnt = $lastCnt[$ssiz-1]; $lvlText = $aref->[1]; $lvlText =~ s/%\d([^%]*)$/($aref->[0]->($ccnt)).$1/oe; my $i = $ssiz - 2; $i-- while ($lvlText =~ s/%\d([^%]*)$/$lastCnt[$i]$1/o); } else { $lvlText = $aref->[0]->($aref->[1]); } return ' ' x $aref->[3] . $lvlText . ' '; } # # Subroutines for processing paragraph content. # sub processParagraph { my $para = $_[0] . "$config_newLine"; my $align = $1 if ($_[0] =~ //); $para =~ s/<.*?>//og; return justify($align,$para) if $align; return $para; } # # Text extraction starts. # my %tag2chr = (tab => "\t", noBreakHyphen => "-", softHyphen => " - "); $content =~ s/(\r)?\n//; $content =~ s{<(wp14|wp):[^>]*>.*?]*>}||og; # Remove the field instructions (instrText) and data (fldData), and deleted # text. $content =~ s{]*>.*?}||ogs; # Mark cross-reference superscripting within [...]. $content =~ s|(.*?)|[$1]|og; $content =~ s{}|$tag2chr{$1}|og; my $hr = '-' x $config_lineWidth . $config_newLine; $content =~ s|.*?|$hr|og; $content =~ s{.*?(|]+>)(.*?)}/uc $2/oge; $content =~ s{(.*?)}/hyperlink($1,$2)/oge; $content =~ s||listNumbering($2,$1)|oge; $content =~ s{]*>}|' ' x int((($2-$4)/$config_twipsPerChar)+0.5)|oge; $content =~ s{]+?/>|}|$config_newLine|og; $content =~ s/]+?>(.*?)<\/w:p>/processParagraph($1)/ogse; $content =~ s/<.*?>//og; # # Convert non-ASCII characters/character sequences to ASCII characters. # $content =~ s/(\xC2|\xC3|\xCF|\xE2.|\xEF.)(.)/($splchars{$1}{$2} ? $splchars{$1}{$2} : $1.$2)/oge; # # Convert docx specific (reserved HTML/XHTML) escape characters. # $content =~ s/(&)(amp|apos|gt|lt|quot)(;)/$escChrs{lc $2}/iog; # # Write the extracted and converted text contents to output. # print $txtfile $content; close $txtfile;