solenv/bin/modules/installer/scpzipfiles.pm

   1 #
   2 # This file is part of the LibreOffice project.
   3 #
   4 # This Source Code Form is subject to the terms of the Mozilla Public
   5 # License, v. 2.0. If a copy of the MPL was not distributed with this
   6 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
   7 #
   8 # This file incorporates work covered by the following license notice:
   9 #
  10 #   Licensed to the Apache Software Foundation (ASF) under one or more
  11 #   contributor license agreements. See the NOTICE file distributed
  12 #   with this work for additional information regarding copyright
  13 #   ownership. The ASF licenses this file to you under the Apache
  14 #   License, Version 2.0 (the "License"); you may not use this file
  15 #   except in compliance with the License. You may obtain a copy of
  16 #   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  17 #
  18
  19 package installer::scpzipfiles;
  20
  21 use installer::files;
  22 use installer::globals;
  23 use installer::logger;
  24 use installer::pathanalyzer;
  25 use installer::systemactions;
  26
  27 # Replacing all zip list variables.
  28 # Called for setup script as well as files with flag scpzip_replace.
  29
  30 sub replace_all_ziplistvariables_in_file
  31 {
  32     my ( $fileref, $variablesref ) = @_;
  33
  34     for my $line ( @{$fileref} )
  35     {
  36         # Avoid removing variables we do not recognise.
  37         $line =~ s/\$\{(\w+)\}/defined $variablesref->{$1}
  38                                      ? $variablesref->{$1}
  39                                      : $&/eg;
  40     }
  41 }
  42
  43 # Replacing all zip list variables in rtf files.
  44
  45 sub replace_all_ziplistvariables_in_rtffile
  46 {
  47     my ( $fileref, $variablesref ) = @_;
  48
  49     for my $line ( @{$fileref} )
  50     {
  51         # In rtf files the braces are backslash-escaped.
  52         # Avoid removing variables we do not recognise.
  53         $line =~ s/\$\\\{(\w+)\\\}/defined $variablesref->{$1}
  54                                          ? $variablesref->{$1}
  55                                          : $&/eg;
  56     }
  57 }
  58
  59 #########################################################
  60 # Analyzing files with flag SCPZIP_REPLACE
  61 # $item can be "File" or "ScpAction"
  62 #########################################################
  63
  64 sub resolving_scpzip_replace_flag
  65 {
  66     my ($filesarrayref, $variableshashref, $item, $languagestringref) = @_;
  67
  68     my $diritem = lc($item);
  69
  70     my $replacedirbase = installer::systemactions::create_directories("replace_$diritem", $languagestringref);
  71
  72     installer::logger::include_header_into_logfile("$item with flag SCPZIP:");
  73
  74     for ( my $i = 0; $i <= $#{$filesarrayref}; $i++ )
  75     {
  76         my $onefile = ${$filesarrayref}[$i];
  77         my $styles = "";
  78
  79         if ( $onefile->{'Styles'} ) { $styles = $onefile->{'Styles'}; }
  80
  81         if ( $styles =~ /\bSCPZIP_REPLACE\b/ )
  82         {
  83             # Language specific subdirectory
  84
  85             my $onelanguage = $onefile->{'specificlanguage'};
  86
  87             if ($onelanguage eq "")
  88             {
  89                 $onelanguage = "00";    # files without language into directory "00"
  90             }
  91
  92             my $replacedir = $replacedirbase . $installer::globals::separator . $onelanguage . $installer::globals::separator;
  93             installer::systemactions::create_directory($replacedir);    # creating language specific directories
  94
  95             # copy files and edit them with the variables defined in the zip.lst
  96
  97             my $longfilename = 0;
  98
  99             my $onefilename = $onefile->{'Name'};
 100             my $sourcepath = $onefile->{'sourcepath'};
 101
 102             if ( $onefilename =~ /^\s*\Q$installer::globals::separator\E/ ) # filename begins with a slash, for instance /registry/schema/org/openoffice/VCL.xcs
 103             {
 104                 $onefilename =~ s/^\s*\Q$installer::globals::separator\E//;
 105                 $longfilename = 1;
 106             }
 107
 108             my $destinationpath = $replacedir . $onefilename;
 109             my $movepath = $destinationpath . ".orig";
 110
 111             if ( $longfilename )    # the destination directory has to be created before copying
 112             {
 113                 my $destdir = $movepath;
 114                 installer::pathanalyzer::get_path_from_fullqualifiedname(\$destdir);
 115                 installer::systemactions::create_directory_structure($destdir);
 116             }
 117
 118             my $copysuccess = installer::systemactions::copy_one_file($sourcepath, $movepath);
 119
 120             if ( $copysuccess )
 121             {
 122                 # Now the file can be edited
 123                 # ToDo: How about binary patching?
 124
 125                 my $onefileref = installer::files::read_file($movepath);
 126                 replace_all_ziplistvariables_in_file($onefileref, $variableshashref);
 127                 installer::files::save_file($destinationpath ,$onefileref);
 128             }
 129
 130             # Saving the original source, where the file was found
 131             $onefile->{'originalsourcepath'} = $onefile->{'sourcepath'};
 132
 133             # Writing the new sourcepath into the hashref, even if it was no copied
 134
 135             $onefile->{'sourcepath'} = $destinationpath;
 136         }
 137     }
 138
 139     my $infoline = "\n";
 140     push( @installer::globals::logfileinfo, $infoline);
 141 }
 142
 143 1;