development/autotests/useSystemFonts.pl

   1 #! /usr/bin/env perl
   2 # -*- mode: perl; -*-
   3 #
   4 # file useSystemFonts.pl
   5 # 1.) Copies lyx-files to another location
   6 # 2.) While copying,
   7 #   2a.) searches for relative references to files and
   8 #        replaces them with absolute ones
   9 #   2b.) Changes default fonts to use non-tex-fonts
  10 #
  11 # Syntax: perl useSystemFonts.pl sourceFile destFile format
  12 # Each param represents a path to a file
  13 # sourceFile: full path to a lyx file
  14 # destFile: destination path
  15 #   Each subdocument will be copied into a subdirectory of dirname(destFile)
  16 # format: any string of the form '[a-zA-Z0-9]+', e.g. pdf5
  17 #
  18 # This file is free software; you can redistribute it and/or
  19 # modify it under the terms of the GNU General Public
  20 # License as published by the Free Software Foundation; either
  21 # version 2 of the License, or (at your option) any later version.
  22 #
  23 # This software is distributed in the hope that it will be useful,
  24 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  25 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  26 # General Public License for more details.
  27 #
  28 # You should have received a copy of the GNU General Public
  29 # License along with this software; if not, write to the Free Software
  30 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  31 #
  32 # Copyright (c) 2013 Kornel Benko <kornel@lyx.org>
  33 #           (c) 2013 Scott Kostyshak <skotysh@lyx.org>
  34
  35 use strict;
  36
  37 BEGIN {
  38   use File::Spec;
  39   my $p = File::Spec->rel2abs( __FILE__ );
  40   $p =~ s/[\/\\]?[^\/\\]+$//;
  41   unshift(@INC, "$p");
  42 }
  43 use File::Basename;
  44 use File::Path;
  45 use File::Copy "cp";
  46 use File::Temp qw/ :POSIX /;
  47 use lyxStatus;
  48
  49 # Prototypes
  50 sub printCopiedDocuments($);
  51 sub interpretedCopy($$$$);
  52 sub copyFoundSubdocuments($);
  53 sub copyJob($$);
  54 sub isrelativeFix($$$);
  55 sub isrelative($$$);
  56 sub createTemporaryFileName($$$);
  57 sub copyJobPending($$);
  58 sub addNewJob($$$$$);
  59 sub addFileCopyJob($$$$$);
  60 sub getNewNameOf($$);
  61 sub getlangs($$);
  62 sub simplifylangs($);
  63 sub getLangEntry();
  64
  65 # convert lyx file to be compilable with xetex
  66
  67 my ($source, $dest, $format, $fontT, $encodingT, $languageFile, $rest) = @ARGV;
  68 my %encodings = ();      # Encoding with TeX fonts, depending on language tag
  69
  70 diestack("Too many arguments") if (defined($rest));
  71 diestack("Sourcefilename not defined") if (! defined($source));
  72 diestack("Destfilename not defined") if (! defined($dest));
  73 diestack("Format (e.g. pdf4) not defined") if (! defined($format));
  74 diestack("Font type (e.g. texF) not defined") if (! defined($fontT));
  75 diestack("Encoding (e.g. ascii) not defined") if (! defined($encodingT));
  76
  77 $source = File::Spec->rel2abs($source);
  78 $dest = File::Spec->rel2abs($dest);
  79
  80 my %font = ();
  81 my $lang = "main";
  82 if ($source =~ /\/([a-z][a-z](_[A-Z][A-Z])?)[\/_]/) {
  83   $lang = $1;
  84 }
  85
  86 my $inputEncoding = undef;
  87 if ($fontT eq "systemF") {
  88 }
  89 elsif ($encodingT ne "default") {
  90   # set input encoding to the requested value
  91   $inputEncoding = {
  92         "search" => '.*', # this will be substituted from '\inputencoding'-line
  93         "out" => $encodingT,
  94     };
  95 }
  96 elsif (0) { # set to '1' to enable setting of inputencoding
  97   # use tex font here
  98   my %encoding = ();
  99   if (defined($languageFile)) {
 100     # The 2 lines below does not seem to have any effect
 101     #&getlangs($languageFile, \%encoding);
 102     #&simplifylangs(\%encoding);
 103   }
 104   if ($format =~ /^(pdf4)$/) { # xelatex
 105     # set input encoding to 'ascii' always
 106     $inputEncoding = {
 107       "search" => '.*', # this will be substituted from '\inputencoding'-line
 108       "out" => "ascii",
 109     };
 110   }
 111   elsif ($format =~ /^(dvi3|pdf5)$/) { # (dvi)?lualatex
 112     # when to set input encoding to 'ascii'?
 113     if (defined($encoding{$lang})) {
 114       $inputEncoding = {
 115         "search" => '.*', # this will be substituted from '\inputencoding'-line
 116         "out" => $encoding{$lang},
 117       };
 118     }
 119   }
 120 }
 121
 122 my $sourcedir = dirname($source);
 123 my $destdir = dirname($dest);
 124 if (! -d $destdir) {
 125   diestack("could not make dir \"$destdir\"") if (! mkpath $destdir);
 126 }
 127
 128 my $destdirOfSubdocuments;
 129 {
 130   my ($name, $pat, $suffix) = fileparse($source, qr/\.[^.]*/);
 131   my $ext = $format . "-$lang";
 132   $name =~ s/[%_]/-/g;
 133   $destdirOfSubdocuments = "$destdir/tmp-$ext" . "-$name"; # Global var, something TODO here
 134 }
 135
 136 if(-d $destdirOfSubdocuments) {
 137   rmtree($destdirOfSubdocuments);
 138 }
 139 mkpath($destdirOfSubdocuments); #  for possibly included files
 140
 141 my %IncludedFiles = ();
 142 my %type2hash = (
 143   "copy_only" => "copyonly",
 144   "interpret" => "interpret");
 145
 146 addNewJob($source, $dest, "interpret", {}, \%IncludedFiles);
 147
 148 copyFoundSubdocuments(\%IncludedFiles);
 149
 150 #printCopiedDocuments(\%IncludedFiles);
 151
 152 exit(0);
 153 ###########################################################
 154
 155 sub printCopiedDocuments($)
 156 {
 157   my ($rFiles) = @_;
 158   for my $k (keys %{$rFiles}) {
 159     my $rJob = $rFiles->{$k};
 160     for my $j ( values %type2hash) {
 161       if (defined($rJob->{$j})) {
 162         print "$j: $k->$rJob->{$j}, " . $rJob->{$j . "copied"} . "\n";
 163       }
 164     }
 165   }
 166 }
 167
 168 sub interpretedCopy($$$$)
 169 {
 170   my ($source, $dest, $destdirOfSubdocuments, $rFiles) = @_;
 171   my $sourcedir = dirname($source);
 172   my $res = 0;
 173
 174   diestack("could not read \"$source\"") if (!open(FI, $source));
 175   diestack("could not write \"$dest\"") if (! open(FO, '>', $dest));
 176
 177   initLyxStack(\%font, $fontT, $inputEncoding);
 178
 179   my $fi_line_no = 0;
 180   my @path_errors = ();
 181   while (my $l = <FI>) {
 182     $fi_line_no += 1;
 183     $l =~ s/[\n\r]+$//;
 184     #chomp($l);
 185     my $rStatus = checkLyxLine($l);
 186     if ($rStatus->{found}) {
 187       my $rF = $rStatus->{result};
 188       if ($rStatus->{"filetype"} eq "replace_only") {
 189         # e.g. if no files involved (font chage etc)
 190         $l = join('', @{$rF});
 191       }
 192       else {
 193         my $filelist = $rStatus->{filelist};
 194         my $fidx = $rStatus->{fileidx};
 195         my $separator = $rStatus->{"separator"};
 196         my $foundrelative = 0;
 197         for my $f (@{$filelist}) {
 198           my @isrel = isrelative($f,
 199                                   $sourcedir,
 200                                   $rStatus->{ext});
 201           if ($isrel[0]) {
 202             $foundrelative = 1;
 203             my $ext = $isrel[1];
 204             if ($rStatus->{"filetype"} eq "prefix_only") {
 205               $f = getNewNameOf("$sourcedir/$f", $rFiles);
 206             }
 207             else {
 208               my ($newname, $res1);
 209               my @extlist = ();
 210               if (ref($rStatus->{ext}) eq "ARRAY") {
 211                 my @extlist = @{$rStatus->{ext}};
 212                 my $created = 0;
 213                 for my $extx (@extlist) {
 214                   if (-e "$sourcedir/$f$extx") {
 215                     ($newname, $res1) = addFileCopyJob("$sourcedir/$f$extx",
 216                                                        "$destdirOfSubdocuments",
 217                                                        $rStatus->{"filetype"},
 218                                                        $rFiles, $created);
 219                     print "Added ($res1) file \"$sourcedir/$f$extx\" to be copied to \"$newname\"\n";
 220                     if (!$created && $extx ne "") {
 221                       $newname =~ s/$extx$//;
 222                     }
 223                     $created = 1;
 224                   }
 225                 }
 226                 print "WARNING: No prefixed file.(" . join('|', @extlist) . ") seens to exist, at \"$source:$fi_line_no\"\n" if (!$created);
 227               }
 228               else {
 229               ($newname, $res1) = addFileCopyJob("$sourcedir/$f$ext",
 230                                                   "$destdirOfSubdocuments",
 231                                                   $rStatus->{"filetype"},
 232                                                    $rFiles, 0);
 233               print "Added ($res1) file \"$sourcedir/$f$ext\" to be copied to \"$newname\"\n";
 234               if ($ext ne "") {
 235                 $newname =~ s/$ext$//;
 236               }
 237               }
 238               $f = $newname;
 239               $res += $res1;
 240             }
 241           }
 242           else {
 243             if (! -e "$f") {
 244               # Non relative (e.g. with absolute path) file should exist
 245               if ($rStatus->{"filetype"} eq "interpret") {
 246                 # filetype::interpret should be interpreted by lyx or latex and therefore emit error
 247                 # We prinnt a warning instead
 248                 print "WARNING: Interpreted file \"$f\" not found, at \"$source:$fi_line_no\"\n";
 249               }
 250               elsif ($rStatus->{"filetype"} eq "prefix_only") {
 251                 # filetype::prefix_only should be interpreted by latex
 252                 print "WARNING: Prefixed file \"$f\" not found, at \"$source:$fi_line_no\"\n";
 253               }
 254               else {
 255                 # Collect the path-error-messages
 256                 push(@path_errors, "File \"$f(" . $rStatus->{"filetype"} . ")\" not found, at \"$source:$fi_line_no\"");
 257               }
 258             }
 259           }
 260         }
 261         if ($foundrelative) {
 262           # The result can be relative too
 263           my @rel_list = ();
 264           for my $fr (@{$filelist}) {
 265             push(@rel_list, File::Spec->abs2rel($fr, $destdir));
 266           }
 267           $rF->[$fidx] = join($separator, @rel_list);
 268           $l = join('', @{$rF});
 269         }
 270       }
 271     }
 272     print FO "$l\n";
 273   }
 274   close(FI);
 275   close(FO);
 276   if (@path_errors > 0) {
 277     for my $entry (@path_errors) {
 278       print "ERROR: $entry\n";
 279     }
 280     diestack("Aborted because of path errors in \"$source\"");
 281   }
 282
 283   closeLyxStack();
 284   return($res);
 285 }
 286
 287 sub copyFoundSubdocuments($)
 288 {
 289   my ($rFiles) = @_;
 290   my $res = 0;
 291   do {
 292     $res = 0;
 293     my %copylist = ();
 294
 295     for my $filename (keys  %{$rFiles}) {
 296       next if (! copyJobPending($filename, $rFiles));
 297       $copylist{$filename} = 1;
 298     }
 299     for my $f (keys %copylist) {
 300       # Second loop needed, because here $rFiles may change
 301       my ($res1, @destfiles) = copyJob($f, $rFiles);
 302       $res += $res1;
 303       for my $destfile (@destfiles) {
 304         print "res1 = $res1 for \"$f\" to be copied to $destfile\n";
 305       }
 306     }
 307   } while($res > 0);            #  loop, while $rFiles changed
 308 }
 309
 310 sub copyJob($$)
 311 {
 312   my ($source, $rFiles) = @_;
 313   my $sourcedir = dirname($source);
 314   my $res = 0;
 315   my @dest = ();
 316
 317   for my $k (values %type2hash) {
 318     if ($rFiles->{$source}->{$k}) {
 319       if (! $rFiles->{$source}->{$k . "copied"}) {
 320         $rFiles->{$source}->{$k . "copied"} = 1;
 321         my $dest = $rFiles->{$source}->{$k};
 322         push(@dest, $dest);
 323         if ($k eq "copyonly") {
 324           diestack("Could not copy \"$source\" to \"$dest\"") if (! cp($source, $dest));
 325         }
 326         else {
 327           interpretedCopy($source, $dest, $destdirOfSubdocuments, $rFiles);
 328         }
 329         $res += 1;
 330       }
 331     }
 332   }
 333   return($res, @dest);
 334 }
 335
 336 # Trivial check
 337 sub isrelativeFix($$$)
 338 {
 339   my ($f, $sourcedir, $ext) = @_;
 340
 341   return(1, $ext) if  (-e "$sourcedir/$f$ext");
 342   return(0,0);
 343 }
 344
 345 sub isrelative($$$)
 346 {
 347   my ($f, $sourcedir, $ext) = @_;
 348
 349   if (ref($ext) eq "ARRAY") {
 350     for my $ext2 (@{$ext}) {
 351       my @res = isrelativeFix($f, $sourcedir, $ext2);
 352       if ($res[0]) {
 353         return(@res);
 354       }
 355     }
 356     return(0,0);
 357   }
 358   else {
 359     return(isrelativeFix($f, $sourcedir, $ext));
 360   }
 361 }
 362
 363 my $oldfname = "";
 364
 365 sub createTemporaryFileName($$$)
 366 {
 367   my ($source, $destdir, $created) = @_;
 368
 369   # get the basename to be used for the template
 370   my ($name, $path, $suffix) = fileparse($source, qr/\.[^.]*/);
 371   #print "source = $source, name = $name, path = $path, suffix = $suffix\n";
 372   my $template = "xx-$name" . "-";
 373   my $fname;
 374   if (! $created) {
 375     $fname = File::Temp::tempnam($destdir, $template);
 376     $oldfname = $fname;
 377   }
 378   else {
 379     $fname = $oldfname;
 380   }
 381
 382   # Append extension from source
 383   if ($suffix ne "") {
 384     $fname .= "$suffix";
 385   }
 386   return($fname);
 387 }
 388
 389 # Check, if file not copied yet
 390 sub copyJobPending($$)
 391 {
 392   my ($f, $rFiles) = @_;
 393   for my $t (values %type2hash) {
 394     if (defined($rFiles->{$f}->{$t})) {
 395       return 1 if (! $rFiles->{$f}->{$t . "copied"});
 396     }
 397   }
 398   return 0;
 399 }
 400
 401 sub addNewJob($$$$$)
 402 {
 403   my ($source, $newname, $hashname, $rJob, $rFiles) = @_;
 404
 405   $rJob->{$hashname} = $newname;
 406   $rJob->{$hashname . "copied"} = 0;
 407   $rFiles->{$source} = $rJob;
 408 }
 409
 410 sub addFileCopyJob($$$$$)
 411 {
 412   my ($source, $destdirOfSubdocuments, $filetype, $rFiles, $created) = @_;
 413   my ($res, $newname) = (0, undef);
 414   my $rJob = $rFiles->{$source};
 415
 416   my $hashname = $type2hash{$filetype};
 417   if (! defined($hashname)) {
 418     diestack("unknown filetype \"$filetype\"");
 419   }
 420   if (!defined($rJob->{$hashname})) {
 421     addNewJob($source,
 422                createTemporaryFileName($source, $destdirOfSubdocuments, $created),
 423                "$hashname", $rJob, $rFiles);
 424     $res = 1;
 425   }
 426   $newname = $rJob->{$hashname};
 427   return($newname, $res);
 428 }
 429
 430 sub getNewNameOf($$)
 431 {
 432   my ($f, $rFiles) = @_;
 433   my $resultf = $f;
 434
 435   if (defined($rFiles->{$f})) {
 436     for my $t (values %type2hash) {
 437       if (defined($rFiles->{$f}->{$t})) {
 438         $resultf = $rFiles->{$f}->{$t};
 439         last;
 440       }
 441     }
 442   }
 443   return($resultf);
 444 }
 445
 446 sub getlangs($$)
 447 {
 448   my ($languagefile, $rencoding) = @_;
 449
 450   if (open(FI, $languagefile)) {
 451     while (my $l = <FI>) {
 452       if ($l =~ /^Language/) {
 453         my ($lng, $enc) = &getLangEntry();
 454         if (defined($lng)) {
 455           $rencoding->{$lng} = $enc;
 456         }
 457       }
 458     }
 459     close(FI);
 460   }
 461 }
 462
 463 sub simplifylangs($)
 464 {
 465   my ($rencoding) = @_;
 466   my $base = "";
 467   my $enc = "";
 468   my $differ = 0;
 469   my @klist = ();
 470   my @klist2 = ();
 471   for my $k (reverse sort keys %{$rencoding}) {
 472     my @tag = split('_', $k);
 473     if ($tag[0] eq $base) {
 474       push(@klist, $k);
 475       if ($rencoding->{$k} ne $enc) {
 476         $differ = 1;
 477       }
 478     }
 479     else {
 480       # new base, check that old base was OK
 481       if ($base ne "") {
 482         if ($differ == 0) {
 483           $rencoding->{$base} = $enc;
 484           push(@klist2, @klist);
 485         }
 486       }
 487       @klist = ($k);
 488       $base = $tag[0];
 489       $enc = $rencoding->{$k};
 490       $differ = 0;
 491     }
 492   }
 493   if ($base ne "") {
 494     # close handling for last entry too
 495     if ($differ == 0) {
 496       $rencoding->{$base} = $enc;
 497       push(@klist2, @klist);
 498     }
 499   }
 500   for my $k (@klist2) {
 501     delete($rencoding->{$k});
 502   }
 503 }
 504
 505 sub getLangEntry()
 506 {
 507   my ($lng, $enc) = (undef, undef);
 508   while (my $l = <FI>) {
 509     chomp($l);
 510     if ($l =~ /^\s*Encoding\s+([^ ]+)\s*$/) {
 511       $enc = $1;
 512     }
 513     elsif ($l =~ /^\s*LangCode\s+([^ ]+)\s*$/) {
 514       $lng = $1;
 515     }
 516     elsif ($l =~ /^\s*End\s*$/) {
 517       last;
 518     }
 519   }
 520   if (defined($lng) && defined($enc)) {
 521     return($lng, $enc);
 522   }
 523   else {
 524     return(undef, undef);
 525   }
 526 }