solenv/bin/modules/installer/windows/media.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::windows::media;
  20
  21 use installer::exiter;
  22 use installer::files;
  23 use installer::globals;
  24 use installer::windows::idtglobal;
  25
  26 ##############################################################
  27 # Returning the diskid for the media table.
  28 ##############################################################
  29
  30 sub get_media_diskid
  31 {
  32     my ($id) = @_;
  33
  34     return $id;
  35 }
  36
  37 ##############################################################
  38 # Returning the lastsequence for the media table.
  39 ##############################################################
  40
  41 sub get_media_lastsequence
  42 {
  43     my ($fileref) = @_;
  44
  45     return $fileref->{'sequencenumber'};
  46 }
  47
  48 ##############################################################
  49 # Returning the diskprompt for the media table.
  50 ##############################################################
  51
  52 sub get_media_diskprompt
  53 {
  54     return 1;
  55 }
  56
  57 ##############################################################
  58 # Returning the cabinet file name for the media table.
  59 ##############################################################
  60
  61 sub get_media_cabinet
  62 {
  63     my ($id) = @_;
  64
  65     my $number = 1000 + $id;
  66     my $filename = "f_" . $number . ".cab";
  67
  68     if ( $installer::globals::include_cab_in_msi ) { $filename = "\#" . $filename; }
  69
  70     return $filename;
  71 }
  72
  73 ##############################################################
  74 # Returning the volumelabel for the media table.
  75 ##############################################################
  76
  77 sub get_media_volumelabel
  78 {
  79     return "DISK1";
  80 }
  81
  82 ##############################################################
  83 # Returning the source for the media table.
  84 ##############################################################
  85
  86 sub get_media_source
  87 {
  88     return "";
  89 }
  90
  91 ##############################################################
  92 # Saving the cabinet file name in the files collector.
  93 # This is useful for making a list to connect the
  94 # source of each file with the destination cabinet file.
  95 ##############################################################
  96
  97 sub set_cabinetfilename_for_component_in_file_collector
  98 {
  99     my ($cabinetfilename, $filesref, $componentname, $max) = @_;
 100
 101     for ( my $i = 0; $i <= $max; $i++ )
 102     {
 103         my $onefile = ${$filesref}[$i];
 104         my $component = $onefile->{'componentname'};
 105
 106         if ( $component eq $componentname )
 107         {
 108             my $cabinet = "";
 109
 110             if ( $onefile->{'cabinet'} ) { $cabinet = $onefile->{'cabinet'}; }
 111
 112             if ( $cabinet eq "" )
 113             {
 114                 $onefile->{'cabinet'} = $cabinetfilename;
 115             }
 116         }
 117     }
 118 }
 119
 120 #################################################
 121 # Creating the cab file name dynamically
 122 #################################################
 123
 124 sub generate_cab_filename_for_some_cabs
 125 {
 126     my ( $allvariables, $id ) = @_;
 127
 128     my $name = $allvariables->{'PRODUCTNAME'};
 129
 130     $name = lc($name);
 131     $name =~ s/\.//g;
 132     $name =~ s/\s//g;
 133
 134     # possibility to overwrite the name with variable CABFILENAME
 135     if ( $allvariables->{'CABFILENAME'} ) { $name = $allvariables->{'CABFILENAME'}; }
 136
 137     $name = $name . $id . ".cab";
 138
 139     if ( $installer::globals::include_cab_in_msi ) { $name = "\#" . $name; }
 140
 141     return $name;
 142 }
 143
 144 #################################################
 145 # Creating the cab file name for cab files
 146 # defined in packages.
 147 #################################################
 148
 149 sub get_cabfilename
 150 {
 151     my ($name) = @_;
 152
 153     if ( $installer::globals::include_cab_in_msi ) { $name = "\#" . $name; }
 154
 155     return $name;
 156 }
 157
 158 #################################################
 159 # Creating the cab file name dynamically
 160 #################################################
 161
 162 sub generate_cab_filename
 163 {
 164     my ( $allvariables ) = @_;
 165
 166     my $name = $allvariables->{'PRODUCTNAME'};
 167
 168     $name = lc($name);
 169     $name =~ s/\.//g;
 170     $name =~ s/\s//g;
 171
 172     # possibility to overwrite the name with variable CABFILENAME
 173     if ( $allvariables->{'CABFILENAME'} ) { $name = $allvariables->{'CABFILENAME'}; }
 174
 175     $name = $name . ".cab";
 176
 177     if ( $installer::globals::include_cab_in_msi ) { $name = "\#" . $name; }
 178
 179     return $name;
 180 }
 181
 182 sub get_maximum_filenumber
 183 {
 184     my ($allfiles, $maxcabfilenumber) = @_;
 185
 186     my $maxfile = 0;
 187
 188     while ( ! ( $allfiles%$maxcabfilenumber == 0 ))
 189     {
 190         $allfiles++;
 191     }
 192
 193     $maxfile = $allfiles / $maxcabfilenumber;
 194
 195     $maxfile++;                 # for securitry
 196
 197     return $maxfile;
 198 }
 199
 200 #################################################################################
 201 # Setting the last sequence for the cabinet files
 202 #################################################################################
 203
 204 sub get_last_sequence
 205 {
 206     my ( $cabfilename, $alludpatelastsequences ) = @_;
 207
 208     my $sequence = 0;
 209
 210     if (( $installer::globals::updatedatabase ) && ( exists($alludpatelastsequences->{$cabfilename}) ))
 211     {
 212         $sequence = $alludpatelastsequences->{$cabfilename};
 213     }
 214     else
 215     {
 216         $sequence = $installer::globals::lastsequence{$cabfilename};
 217     }
 218
 219     return $sequence;
 220 }
 221
 222 #################################################################################
 223 # Creating the file Media.idt dynamically
 224 # Content:
 225 # DiskId LastSequence DiskPrompt Cabinet VolumeLabel Source
 226 # Idea: Every component is packed into each own cab file
 227 #################################################################################
 228
 229 sub create_media_table
 230 {
 231     my ($filesref, $basedir, $allvariables, $alludpatelastsequences, $allupdatediskids) = @_;
 232
 233     my @mediatable = ();
 234
 235     my $diskid = 0;
 236
 237     installer::windows::idtglobal::write_idt_header(\@mediatable, "media");
 238
 239     if ( $installer::globals::fix_number_of_cab_files )
 240     {
 241         # number of cabfiles
 242         my $maxcabfilenumber = $installer::globals::number_of_cabfiles;
 243         if ( $allvariables->{'CABFILENUMBER'} ) { $maxcabfilenumber = $allvariables->{'CABFILENUMBER'}; }
 244         my $allfiles = $#{$filesref} + 1;
 245         my $maxfilenumber = get_maximum_filenumber($allfiles, $maxcabfilenumber);
 246         my $cabfilenumber = 0;
 247         my $cabfull = 0;
 248         my $counter = 0;
 249
 250         # Sorting of files collector files required !
 251         # Attention: The order in the cab file is not guaranteed (especially in udpate process)
 252
 253         for ( my $i = 0; $i <= $#{$filesref}; $i++ )
 254         {
 255             if (( $counter >= $maxfilenumber ) || ( $i == $#{$filesref} )) { $cabfull = 1; }
 256
 257             $counter++;      # counting the files in the cab file
 258
 259             my $onefile = ${$filesref}[$i];
 260             my $nextfile = ${$filesref}[$i+1];
 261
 262             my $filecomponent = "";
 263             my $nextcomponent = "";
 264
 265             if ( $onefile->{'componentname'} ) { $filecomponent = $onefile->{'componentname'}; }
 266             if ( $nextfile->{'componentname'} ) { $nextcomponent = $nextfile->{'componentname'}; }
 267
 268             if ( $filecomponent eq $nextcomponent ) # all files of one component have to be in one cab file
 269             {
 270                 next;       # nothing to do, this is not the last file of a component
 271             }
 272
 273             if ( $cabfull )
 274             {
 275                 my %media = ();
 276                 $cabfilenumber++;
 277
 278                 $media{'DiskId'} = get_media_diskid($cabfilenumber);
 279                 $media{'LastSequence'} = $i + 1;    # This should be correct, also for unsorted files collectors
 280                 $media{'DiskPrompt'} = get_media_diskprompt();
 281                 $media{'Cabinet'} = generate_cab_filename_for_some_cabs($allvariables, $cabfilenumber);
 282                 $media{'VolumeLabel'} = get_media_volumelabel();
 283                 $media{'Source'} = get_media_source();
 284
 285                 my $oneline = $media{'DiskId'} . "\t" . $media{'LastSequence'} . "\t" . $media{'DiskPrompt'} . "\t"
 286                         . $media{'Cabinet'} . "\t" . $media{'VolumeLabel'} . "\t" . $media{'Source'} . "\n";
 287
 288                 push(@mediatable, $oneline);
 289
 290                 # Saving the cabinet file name in the file collector
 291
 292                 $media{'Cabinet'} =~ s/^\s*\#//;    # removing leading hash
 293
 294                 for ( my $j = 0; $j <= $i; $j++ )
 295                 {
 296                     my $onefile = ${$filesref}[$j];
 297                     if ( ! $onefile->{'cabinet'} ) { $onefile->{'cabinet'} = $media{'Cabinet'}; }
 298                 }
 299
 300                 $cabfull = 0;
 301                 $counter = 0;
 302             }
 303         }
 304     }
 305     else
 306     {
 307         installer::exiter::exit_program("ERROR: No cab file specification in globals.pm !", "create_media_table");
 308     }
 309
 310     # Saving the file
 311
 312     my $mediatablename = $basedir . $installer::globals::separator . "Media.idt";
 313     installer::files::save_file($mediatablename ,\@mediatable);
 314     my $infoline = "Created idt file: $mediatablename\n";
 315     push(@installer::globals::logfileinfo, $infoline);
 316 }
 317
 318 1;