solenv/bin/modules/installer/windows/shortcut.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::shortcut;
  20
  21 use installer::exiter;
  22 use installer::files;
  23 use installer::globals;
  24 use installer::windows::idtglobal;
  25
  26 ##############################################################
  27 # Returning identifier for shortcut table.
  28 ##############################################################
  29
  30 sub get_shortcut_identifier
  31 {
  32     my ($shortcut) = @_;
  33
  34     my $identifier = $shortcut->{'gid'};
  35
  36     return $identifier;
  37 }
  38
  39 ##############################################################
  40 # Returning directory for shortcut table.
  41 ##############################################################
  42
  43 sub get_shortcut_directory
  44 {
  45     my ($shortcut, $dirref) = @_;
  46
  47     # For shortcuts it is easy to convert the gid_Dir_Abc into the unique name in
  48     # the directory table, for instance help_en_simpressidx.
  49     # For files (components) this is not so easy, because files can be included
  50     # in zip files with subdirectories that are not defined in scp.
  51
  52     my $onedir;
  53     my $shortcutdirectory = $shortcut->{'Dir'};
  54     my $directory = "";
  55     my $found = 0;
  56
  57     for ( my $i = 0; $i <= $#{$dirref}; $i++ )
  58     {
  59         $onedir = ${$dirref}[$i];
  60         my $directorygid = $onedir->{'Dir'};
  61
  62         if ( $directorygid eq $shortcutdirectory )
  63         {
  64             $found = 1;
  65             last;
  66         }
  67     }
  68
  69     if (!($found))
  70     {
  71         installer::exiter::exit_program("ERROR: Did not find DirectoryID $shortcutdirectory in directory collection for shortcut", "get_shortcut_directory");
  72     }
  73
  74     $directory = $onedir->{'uniquename'};
  75
  76     if ($directory eq "") { $directory = "INSTALLLOCATION"; }       # Shortcuts in the root directory
  77
  78     return $directory;
  79 }
  80
  81 ##############################################################
  82 # Returning name for shortcut table.
  83 ##############################################################
  84
  85 sub get_shortcut_name
  86 {
  87     my ($shortcut, $shortnamesref, $onelanguage) = @_;
  88
  89     my $returnstring;
  90
  91     my $name = $shortcut->{'Name'};
  92
  93     my $shortstring = installer::windows::idtglobal::make_eight_three_conform($name, "shortcut", $shortnamesref);
  94     $shortstring =~ s/\s/\_/g;  # replacing white spaces with underline
  95
  96     if ( $shortstring eq $name ) { $returnstring = $name; } # nothing changed
  97     else {$returnstring = $shortstring . "\|" . $name; }
  98
  99     return $returnstring;
 100 }
 101
 102 ##############################################################
 103 # Returning component for shortcut table.
 104 ##############################################################
 105
 106 sub get_shortcut_component
 107 {
 108     my ($shortcut, $filesref) = @_;
 109
 110     my $onefile;
 111     my $component = "";
 112     my $found = 0;
 113     my $shortcut_fileid = $shortcut->{'FileID'};
 114
 115     my $absolute_filename = 0;
 116     if ( $shortcut->{'Styles'} ) { $styles = $shortcut->{'Styles'}; }
 117     if ( $styles =~ /\bABSOLUTE_FILENAME\b/ ) { $absolute_filename = 1; }   # FileID contains an absolute filename
 118     if ( $styles =~ /\bUSE_HELPER_FILENAME\b/ ) { $absolute_filename = 1; } # ComponentIDFile contains id of a helper file
 119
 120     # if the FileID contains an absolute filename, therefore the entry for "ComponentIDFile" has to be used.
 121     if ( $absolute_filename ) { $shortcut_fileid = $shortcut->{'ComponentIDFile'}; }
 122
 123     for ( my $i = 0; $i <= $#{$filesref}; $i++ )
 124     {
 125         $onefile = ${$filesref}[$i];
 126         my $filegid = $onefile->{'gid'};
 127
 128         if ( $filegid eq $shortcut_fileid )
 129         {
 130             $found = 1;
 131             last;
 132         }
 133     }
 134
 135     if (!($found))
 136     {
 137         installer::exiter::exit_program("ERROR: Did not find FileID $shortcut_fileid in file collection for shortcut", "get_shortcut_component");
 138     }
 139
 140     $component = $onefile->{'componentname'};
 141
 142     # finally saving the componentname in the folderitem collector
 143
 144     $shortcut->{'component'} = $component;
 145
 146     return $component;
 147 }
 148
 149 ##############################################################
 150 # Returning target for shortcut table.
 151 ##############################################################
 152
 153 sub get_shortcut_target
 154 {
 155     my ($shortcut, $filesref) = @_;
 156
 157     my $target = "";
 158     my $found = 0;
 159     my $shortcut_fileid = $shortcut->{'FileID'};
 160     my $onefile;
 161
 162     for ( my $i = 0; $i <= $#{$filesref}; $i++ )
 163     {
 164         $onefile = ${$filesref}[$i];
 165         my $filegid = $onefile->{'gid'};
 166
 167         if ( $filegid eq $shortcut_fileid )
 168         {
 169             $found = 1;
 170             last;
 171         }
 172     }
 173
 174     if (!($found))
 175     {
 176         installer::exiter::exit_program("ERROR: Did not find FileID $shortcut_fileid in file collection for shortcut", "get_shortcut_target");
 177     }
 178
 179     if ( $onefile->{'Name'} )
 180     {
 181         $target = $onefile->{'Name'};
 182     }
 183
 184     $target = "\[\#" . $target . "\]";  # format for Non-Advertised shortcuts
 185
 186     return $target;
 187 }
 188
 189 ##############################################################
 190 # Returning arguments for shortcut table.
 191 ##############################################################
 192
 193 sub get_shortcut_arguments
 194 {
 195     my ($shortcut) = @_;
 196
 197     return "";
 198 }
 199
 200 ##############################################################
 201 # Returning the localized description for shortcut table.
 202 ##############################################################
 203
 204 sub get_shortcut_description
 205 {
 206     my ($shortcut, $onelanguage) = @_;
 207
 208     my $description = "";
 209     if ( $shortcut->{'Tooltip'} ) { $description = $shortcut->{'Tooltip'}; }
 210     $description =~ s/\\\"/\"/g;  # no more masquerading of '"'
 211
 212     return $description;
 213 }
 214
 215 ##############################################################
 216 # Returning hotkey for shortcut table.
 217 ##############################################################
 218
 219 sub get_shortcut_hotkey
 220 {
 221     my ($shortcut) = @_;
 222
 223     return "";
 224 }
 225
 226 ##############################################################
 227 # Returning icon for shortcut table.
 228 ##############################################################
 229
 230 sub get_shortcut_icon
 231 {
 232     my ($shortcut) = @_;
 233
 234     return "";
 235 }
 236
 237 ##############################################################
 238 # Returning iconindex for shortcut table.
 239 ##############################################################
 240
 241 sub get_shortcut_iconindex
 242 {
 243     my ($shortcut) = @_;
 244
 245     return "";
 246 }
 247
 248 ##############################################################
 249 # Returning show command for shortcut table.
 250 ##############################################################
 251
 252 sub get_shortcut_showcmd
 253 {
 254     my ($shortcut) = @_;
 255
 256     return "";
 257 }
 258
 259 ##############################################################
 260 # Returning working directory for shortcut table.
 261 ##############################################################
 262
 263 sub get_shortcut_wkdir
 264 {
 265     my ($shortcut) = @_;
 266
 267     return "";
 268 }
 269
 270 ####################################################################
 271 # Returning working directory for shortcut table for FolderItems.
 272 ####################################################################
 273
 274 sub get_folderitem_wkdir
 275 {
 276     my ($onelink, $dirref) = @_;
 277
 278     # For shortcuts it is easy to convert the gid_Dir_Abc into the unique name in
 279     # the directory table, for instance help_en_simpressidx.
 280
 281     my $onedir;
 282     my $workingdirectory = "";
 283     if ( $onelink->{'WkDir'} ) { $workingdirectory = $onelink->{'WkDir'}; }
 284     my $directory = "";
 285
 286     if ( $workingdirectory )
 287     {
 288         my $found = 0;
 289
 290         for ( my $i = 0; $i <= $#{$dirref}; $i++ )
 291         {
 292             $onedir = ${$dirref}[$i];
 293             my $directorygid = $onedir->{'Dir'};
 294
 295             if ( $directorygid eq $workingdirectory )
 296             {
 297                 $found = 1;
 298                 last;
 299             }
 300         }
 301
 302         if (!($found))
 303         {
 304             installer::exiter::exit_program("ERROR: Did not find DirectoryID $workingdirectory in directory collection for FolderItem", "get_folderitem_wkdir");
 305         }
 306
 307         $directory = $onedir->{'uniquename'};
 308
 309         if ($directory eq "") { $directory = "INSTALLLOCATION"; }
 310     }
 311
 312     return $directory;
 313 }
 314
 315 ###################################################################
 316 # Returning the directory for a folderitem for shortcut table.
 317 ###################################################################
 318
 319 sub get_folderitem_directory
 320 {
 321     my ($shortcut) = @_;
 322
 323     my $directory = "$installer::globals::officemenufolder";     # default
 324
 325     # The default is not correct for the
 326     # PREDEFINED folders, like PREDEFINED_AUTOSTART
 327
 328     if ( $shortcut->{'FolderID'} eq "PREDEFINED_AUTOSTART" )
 329     {
 330         $directory = $installer::globals::startupfolder;
 331     }
 332
 333     if ( $shortcut->{'FolderID'} eq "PREDEFINED_DESKTOP" )
 334     {
 335         $directory = $installer::globals::desktopfolder;
 336         $installer::globals::desktoplinkexists = 1;
 337     }
 338
 339     if ( $shortcut->{'FolderID'} eq "PREDEFINED_STARTMENU" )
 340     {
 341         $directory = $installer::globals::programmenufolder;
 342     }
 343
 344     # saving the directory in the folderitems collector
 345
 346     $shortcut->{'directory'} = $directory;
 347
 348     return $directory;
 349 }
 350
 351 ########################################################################
 352 # Returning the target (feature) for a folderitem for shortcut table.
 353 # For non-advertised shortcuts this is a formatted string.
 354 ########################################################################
 355
 356 sub get_folderitem_target
 357 {
 358     my ($shortcut, $filesref) = @_;
 359
 360     my $onefile;
 361     my $target = "";
 362     my $found = 0;
 363     my $shortcut_fileid = $shortcut->{'FileID'};
 364
 365     my $styles = "";
 366     my $nonadvertised = 0;
 367     my $absolute_filename = 0;
 368     if ( $shortcut->{'Styles'} ) { $styles = $shortcut->{'Styles'}; }
 369     if ( $styles =~ /\bNON_ADVERTISED\b/ ) { $nonadvertised = 1; }  # this is a non-advertised shortcut
 370     if ( $styles =~ /\bABSOLUTE_FILENAME\b/ ) { $absolute_filename = 1; }   # FileID contains an absolute filename
 371
 372     # if the FileID contains an absolute filename this can simply be returned as target for the shortcut table.
 373     if ( $absolute_filename )
 374     {
 375         $shortcut->{'target'} = $shortcut_fileid;
 376         return $shortcut_fileid;
 377     }
 378
 379     for ( my $i = 0; $i <= $#{$filesref}; $i++ )
 380     {
 381         $onefile = ${$filesref}[$i];
 382         my $filegid = $onefile->{'gid'};
 383
 384         if ( $filegid eq $shortcut_fileid )
 385         {
 386             $found = 1;
 387             last;
 388         }
 389     }
 390
 391     if (!($found))
 392     {
 393         installer::exiter::exit_program("ERROR: Did not find FileID $shortcut_fileid in file collection for folderitem", "get_folderitem_target");
 394     }
 395
 396     # Non advertised shortcuts do not return the feature, but the path to the file
 397     if ( $nonadvertised )
 398     {
 399         $target = "\[" . $onefile->{'uniquedirname'} . "\]" . "\\" . $onefile->{'Name'};
 400         $shortcut->{'target'} = $target;
 401         return $target;
 402     }
 403
 404     # the rest only for advertised shortcuts, which contain the feature in the shortcut table.
 405
 406     if ( $onefile->{'modules'} ) { $target = $onefile->{'modules'}; }
 407
 408     # If modules contains a list of modules, only taking the first one.
 409     # But this should never be needed
 410
 411     if ( $target =~ /^\s*(.*?)\,/ ) { $target = $1; }
 412
 413     # Attention: Maximum feature length is 38!
 414     installer::windows::idtglobal::shorten_feature_gid(\$target);
 415
 416     # and finally saving the target in the folderitems collector
 417
 418     $shortcut->{'target'} = $target;
 419
 420     return $target;
 421 }
 422
 423 ########################################################################
 424 # Returning the arguments for a folderitem for shortcut table.
 425 ########################################################################
 426
 427 sub get_folderitem_arguments
 428 {
 429     my ($shortcut) = @_;
 430
 431     my $parameter = "";
 432
 433     if ( $shortcut->{'Parameter'} ) { $parameter = $shortcut->{'Parameter'}; }
 434
 435     return $parameter;
 436 }
 437
 438 ########################################################################
 439 # Returning the icon for a folderitem for shortcut table.
 440 # The returned value has to be defined in the icon table.
 441 ########################################################################
 442
 443 sub get_folderitem_icon
 444 {
 445     my ($shortcut, $filesref, $iconfilecollector) = @_;
 446
 447     my $styles = "";
 448     if ( $shortcut->{'Styles'} ) { $styles = $shortcut->{'Styles'}; }
 449     if ( $styles =~ /\bNON_ADVERTISED\b/ ) { return ""; }   # no icon for non-advertised shortcuts
 450
 451     my $iconfilegid = "";
 452
 453     if ( $shortcut->{'IconFile'} ) { $iconfilegid = $shortcut->{'IconFile'}; }
 454     else { $iconfilegid = $shortcut->{'FileID'}; }
 455
 456     my $onefile;
 457     my $found = 0;
 458
 459     for ( my $i = 0; $i <= $#{$filesref}; $i++ )
 460     {
 461         $onefile = ${$filesref}[$i];
 462         my $filegid = $onefile->{'gid'};
 463
 464         if ( $filegid eq $iconfilegid )
 465         {
 466             $found = 1;
 467             last;
 468         }
 469     }
 470
 471     if (!($found))
 472     {
 473         installer::exiter::exit_program("ERROR: Did not find FileID $iconfilegid in file collection", "get_folderitem_icon");
 474     }
 475
 476     $iconfile = $onefile->{'Name'};
 477
 478     # collecting all icon files to copy them into the icon directory
 479
 480     my $sourcepath = $onefile->{'sourcepath'};
 481
 482     if (! grep {$_ eq $sourcepath} @{$iconfilecollector})
 483     {
 484         push(@{$iconfilecollector}, $sourcepath);
 485     }
 486
 487     return $iconfile;
 488 }
 489
 490 ########################################################################
 491 # Returning the iconindex for a folderitem for shortcut table.
 492 ########################################################################
 493
 494 sub get_folderitem_iconindex
 495 {
 496     my ($shortcut) = @_;
 497
 498     my $styles = "";
 499     if ( $shortcut->{'Styles'} ) { $styles = $shortcut->{'Styles'}; }
 500     if ( $styles =~ /\bNON_ADVERTISED\b/ ) { return ""; }   # no iconindex for non-advertised shortcuts
 501
 502     my $iconid = 0;
 503
 504     if ( $shortcut->{'IconID'} ) { $iconid = $shortcut->{'IconID'}; }
 505
 506     return $iconid;
 507 }
 508
 509 ########################################################################
 510 # Returning the show command for a folderitem for shortcut table.
 511 ########################################################################
 512
 513 sub get_folderitem_showcmd
 514 {
 515     my ($shortcut) = @_;
 516
 517     return "1";
 518 }
 519
 520 ###########################################################################################################
 521 # Creating the file Shortcut.idt dynamically
 522 # Content:
 523 # Shortcut Directory_ Name Component_ Target Arguments Description Hotkey Icon_ IconIndex ShowCmd WkDir
 524 ###########################################################################################################
 525
 526 sub create_shortcut_table
 527 {
 528     my ($filesref, $linksref, $folderref, $folderitemsref, $dirref, $basedir, $languagesarrayref, $includepatharrayref, $iconfilecollector) = @_;
 529
 530     for ( my $m = 0; $m <= $#{$languagesarrayref}; $m++ )
 531     {
 532         my $onelanguage = ${$languagesarrayref}[$m];
 533
 534         my @shortcuttable = ();
 535
 536         my @shortnames = ();    # to collect all short names
 537
 538         installer::windows::idtglobal::write_idt_header(\@shortcuttable, "shortcut");
 539
 540         # First the links, defined in scp as ShortCut
 541
 542         for ( my $i = 0; $i <= $#{$linksref}; $i++ )
 543         {
 544             my $onelink = ${$linksref}[$i];
 545
 546             # Controlling the language!
 547             # Only language independent folderitems or folderitems with the correct language
 548             # will be included into the table
 549
 550             if (! (!(( $onelink->{'ismultilingual'} )) || ( $onelink->{'specificlanguage'} eq $onelanguage )) )  { next; }
 551
 552             my %shortcut = ();
 553
 554             $shortcut{'Shortcut'} = get_shortcut_identifier($onelink);
 555             $shortcut{'Directory_'} = get_shortcut_directory($onelink, $dirref);
 556             $shortcut{'Name'} = get_shortcut_name($onelink, \@shortnames, $onelanguage);    # localized name
 557             $shortcut{'Component_'} = get_shortcut_component($onelink, $filesref);
 558             $shortcut{'Target'} = get_shortcut_target($onelink, $filesref);
 559             $shortcut{'Arguments'} = get_shortcut_arguments($onelink);
 560             $shortcut{'Description'} = get_shortcut_description($onelink, $onelanguage);    # localized description
 561             $shortcut{'Hotkey'} = get_shortcut_hotkey($onelink);
 562             $shortcut{'Icon_'} = get_shortcut_icon($onelink);
 563             $shortcut{'IconIndex'} = get_shortcut_iconindex($onelink);
 564             $shortcut{'ShowCmd'} = get_shortcut_showcmd($onelink);
 565             $shortcut{'WkDir'} = get_shortcut_wkdir($onelink);
 566
 567             my $oneline = $shortcut{'Shortcut'} . "\t" . $shortcut{'Directory_'} . "\t" . $shortcut{'Name'} . "\t"
 568                         . $shortcut{'Component_'} . "\t" . $shortcut{'Target'} . "\t" . $shortcut{'Arguments'} . "\t"
 569                         . $shortcut{'Description'} . "\t" . $shortcut{'Hotkey'} . "\t" . $shortcut{'Icon_'} . "\t"
 570                         . $shortcut{'IconIndex'} . "\t" . $shortcut{'ShowCmd'} . "\t" . $shortcut{'WkDir'} . "\n";
 571
 572             push(@shortcuttable, $oneline);
 573         }
 574
 575         # Second the entries into the start menu, defined in scp as Folder and Folderitem
 576         # These shortcuts will fill the icons table.
 577
 578         for ( my $i = 0; $i <= $#{$folderref}; $i++ )
 579         {
 580             my $foldergid = ${$folderref}[$i]->{'gid'};
 581
 582             # iterating over all folderitems for this folder
 583
 584             for ( my $j = 0; $j <= $#{$folderitemsref}; $j++ )
 585             {
 586                 my $onelink = ${$folderitemsref}[$j];
 587
 588                 # Controlling the language!
 589                 # Only language independent folderitems or folderitems with the correct language
 590                 # will be included into the table
 591
 592                 if (! (!(( $onelink->{'ismultilingual'} )) || ( $onelink->{'specificlanguage'} eq $onelanguage )) )  { next; }
 593
 594                 # controlling the folder
 595
 596                 my $localused = 0;
 597
 598                 if ( $onelink->{'used'} ) { $localused = $onelink->{'used'}; }
 599
 600                 if (!($localused == 1)) { $onelink->{'used'} = "0"; }       # no resetting
 601
 602                 if (!( $onelink->{'FolderID'} eq $foldergid )) { next; }
 603
 604                 $onelink->{'used'} = "1";
 605
 606                 my %shortcut = ();
 607
 608                 $shortcut{'Shortcut'} = get_shortcut_identifier($onelink);
 609                 $shortcut{'Directory_'} = get_folderitem_directory($onelink);
 610                 $shortcut{'Name'} = get_shortcut_name($onelink, \@shortnames, $onelanguage);    # localized name
 611                 $shortcut{'Component_'} = get_shortcut_component($onelink, $filesref);
 612                 $shortcut{'Target'} = get_folderitem_target($onelink, $filesref);
 613                 $shortcut{'Arguments'} = get_folderitem_arguments($onelink);
 614                 $shortcut{'Description'} = get_shortcut_description($onelink, $onelanguage);    # localized description
 615                 $shortcut{'Hotkey'} = get_shortcut_hotkey($onelink);
 616                 $shortcut{'Icon_'} = get_folderitem_icon($onelink, $filesref, $iconfilecollector);
 617                 $shortcut{'IconIndex'} = get_folderitem_iconindex($onelink);
 618                 $shortcut{'ShowCmd'} = get_folderitem_showcmd($onelink);
 619                 $shortcut{'WkDir'} = get_folderitem_wkdir($onelink, $dirref);
 620
 621                 my $oneline = $shortcut{'Shortcut'} . "\t" . $shortcut{'Directory_'} . "\t" . $shortcut{'Name'} . "\t"
 622                             . $shortcut{'Component_'} . "\t" . $shortcut{'Target'} . "\t" . $shortcut{'Arguments'} . "\t"
 623                             . $shortcut{'Description'} . "\t" . $shortcut{'Hotkey'} . "\t" . $shortcut{'Icon_'} . "\t"
 624                             . $shortcut{'IconIndex'} . "\t" . $shortcut{'ShowCmd'} . "\t" . $shortcut{'WkDir'} . "\n";
 625
 626                 push(@shortcuttable, $oneline);
 627             }
 628         }
 629
 630         # The soffice.ico has to be included into the icon table
 631         # as icon for the ARP applet
 632
 633         my $onefile = "";
 634         my $sofficefile = "soffice.ico";
 635
 636         my $sourcepathref = $ENV{'SRCDIR'} . "/sysui/desktop/icons/" . $sofficefile;
 637
 638         if (! -f $sourcepathref) { installer::exiter::exit_program("ERROR: Could not find $sofficefile ($sourcepathref) as icon!", "create_shortcut_table"); }
 639
 640         if (! grep {$_ eq $sourcepathref} @{$iconfilecollector})
 641         {
 642             unshift(@{$iconfilecollector}, $sourcepathref);
 643             $installer::globals::sofficeiconadded = 1;
 644         }
 645
 646         my $localinfoline = "Added icon file $sourcepathref for language pack into icon file collector.\n";
 647         push(@installer::globals::logfileinfo, $localinfoline);
 648
 649         # Saving the file
 650
 651         my $shortcuttablename = $basedir . $installer::globals::separator . "Shortcut.idt" . "." . $onelanguage;
 652         installer::files::save_file($shortcuttablename ,\@shortcuttable);
 653         my $infoline = "Created idt file: $shortcuttablename\n";
 654         push(@installer::globals::logfileinfo, $infoline);
 655     }
 656 }
 657
 658
 659 1;