fdo#35785: Add MsiShortcutProperty table to the installer

This sets the different IDs for shortcuts and should help the jump-lists

WIP: data for the new MsiShortcutProperty installer table

Change-Id: If421383abe95738b8247aebc5cf43b1eaa346c39
(cherry picked from commit 20696b2a5741fcda3b9cff5fb41da4d2688312c4)

OK, so this was not just a bogus stray mess :)

Change-Id: I39287c4bf882438c409157ab5e4fa586f5289c5c
(cherry picked from commit 6c098943d600db20640264d52792c09ae336fdfb)

Some more fixups towards the MsiShortcutProperty table

Change-Id: I961a2c05c175512ee1fb4b0f11d0da1d5eae1c71
(cherry picked from commit 7137605eefb6b4efe80c89c4468e33591b1e474f)

Some more typos in perl code

Change-Id: I2123a6f4cbac0c4870495a70f5f283b75d3a5191
(cherry picked from commit 748be656846d5d698a47f63735f2ef58763a1ef6)

And a bit more of fixes

Change-Id: Ib247391d83773cddc18e37d5e979552a13dd19eb
(cherry picked from commit b36d311899fde2f80e22bcc034ab8c9bdd795b76)

Another typo

Change-Id: I57a9592359a171eb3a6f230f5de2dc44a44b7181
(cherry picked from commit 045a7c675d04c258fdf97c6178ca9ad106d47deb)

Hopefully the last installement of my perl saga

Change-Id: I2d437062e3ce468591621e7323cacb13789edf06
(cherry picked from commit 6205c58e262e9b82e815855199de462775fcd35b)

And my hope was not true

Change-Id: I41877db65b66fa3732040fc21f98a5f2be2fdcb7
(cherry picked from commit d72151ff930ff1961f2ab7b1e895958cdaabe91b)
Reviewed-on: https://gerrit.libreoffice.org/5081
Reviewed-by: Jesús Corrius <jcorrius@gmail.com>
Reviewed-by: Thorsten Behrens <tbehrens@suse.com>
Tested-by: Thorsten Behrens <tbehrens@suse.com>

13 files changed, 218 insertions, 5 deletions

diff --git a/instsetoo_native/inc_openoffice/windows/msi_templates/_Validat.idt b/instsetoo_native/inc_openoffice/windows/msi_templates/_Validat.idt
index 193873a810fb..c5945ae6f05f 100644
--- a/instsetoo_native/inc_openoffice/windows/msi_templates/_Validat.idt
+++ b/instsetoo_native/inc_openoffice/windows/msi_templates/_Validat.idt
@@ -296,6 +296,10 @@ MsiFileHash	HashPart2	N							Size of file in bytes (long integer).
 MsiFileHash	HashPart3	N							Size of file in bytes (long integer).
 MsiFileHash	HashPart4	N							Size of file in bytes (long integer).
 MsiFileHash	Options	N	0	32767					Various options and attributes for this hash.
+MsiShortcutProperty	MsiShortcutProperty	N					Identifier		Unique identifier for this row of the MsiShortcutProperty table
+MsiShortcutProperty	Shortcut_	N					Identifier		A key into the Shortcut table that identifies the shortcut having a property set
+MsiShortcutProperty	PropertyKey	N					Formatted		A string value that provides information for the PROPERTYKEY structure
+MsiShortcutProperty	PropVariantValue	N					Formatted		A string value that provides information for the PROPVARIANT structure.
 ODBCAttribute	Attribute	N					Text		Name of ODBC driver attribute
 ODBCAttribute	Driver_	N			ODBCDriver	1	Identifier		Reference to ODBC driver in ODBCDriver table
 ODBCAttribute	Value	Y					Text		Value for ODBC driver attribute
diff --git a/scp2/source/base/folderitem_base.scp b/scp2/source/base/folderitem_base.scp
index 36e6d5a4dc9a..1cc5b3fc4ef5 100644
--- a/scp2/source/base/folderitem_base.scp
+++ b/scp2/source/base/folderitem_base.scp
@@ -30,4 +30,10 @@ FolderItem gid_Folderitem_Sbase
     Parameter = "";
     ALL_LANG(Tooltip, STR_FI_TOOLTIP_BASE);
 End
+
+FolderItemProperty git_Folderitem_Sbase_AppIDProperty
+    ShortcutID = gid_Folderitem_Sbase;
+    Key = "System.AppUserModel.ID";
+    Value = "TheDocumentFoundation.LibreOffice.Base";
+End
 #endif
diff --git a/scp2/source/calc/folderitem_calc.scp b/scp2/source/calc/folderitem_calc.scp
index 8d4cd165f739..fcf451832625 100644
--- a/scp2/source/calc/folderitem_calc.scp
+++ b/scp2/source/calc/folderitem_calc.scp
@@ -30,4 +30,10 @@ FolderItem gid_Folderitem_Scalc
     Parameter = "";
     ALL_LANG(Tooltip, STR_FI_TOOLTIP_CALC);
 End
+
+FolderItemProperty git_Folderitem_Scalc_AppIDProperty
+    ShortcutID = gid_Folderitem_Scalc;
+    Key = "System.AppUserModel.ID";
+    Value = "TheDocumentFoundation.LibreOffice.Calc";
+End
 #endif
diff --git a/scp2/source/draw/folderitem_draw.scp b/scp2/source/draw/folderitem_draw.scp
index 95ea743aea28..be6751117763 100644
--- a/scp2/source/draw/folderitem_draw.scp
+++ b/scp2/source/draw/folderitem_draw.scp
@@ -30,4 +30,10 @@ FolderItem gid_Folderitem_Sdraw
     Parameter = "";
     ALL_LANG(Tooltip, STR_FI_TOOLTIP_DRAW);
 End
+
+FolderItemProperty git_Folderitem_Sdraw_AppIDProperty
+    ShortcutID = gid_Folderitem_Sdraw;
+    Key = "System.AppUserModel.ID";
+    Value = "TheDocumentFoundation.LibreOffice.Draw";
+End
 #endif
diff --git a/scp2/source/impress/folderitem_impress.scp b/scp2/source/impress/folderitem_impress.scp
index 22deb49d5270..1f787e4b1c64 100644
--- a/scp2/source/impress/folderitem_impress.scp
+++ b/scp2/source/impress/folderitem_impress.scp
@@ -30,4 +30,10 @@ FolderItem gid_Folderitem_Simpress
     Parameter = "";
     ALL_LANG(Tooltip, STR_FI_TOOLTIP_IMPRESS);
 End
+
+FolderItemProperty git_Folderitem_Simpress_AppIDProperty
+    ShortcutID = gid_Folderitem_Simpress;
+    Key = "System.AppUserModel.ID";
+    Value = "TheDocumentFoundation.LibreOffice.Impress";
+End
 #endif
diff --git a/scp2/source/math/folderitem_math.scp b/scp2/source/math/folderitem_math.scp
index d82243457c11..565beeed4c6c 100644
--- a/scp2/source/math/folderitem_math.scp
+++ b/scp2/source/math/folderitem_math.scp
@@ -30,4 +30,10 @@ FolderItem gid_Folderitem_Smath
     Parameter = "";
     ALL_LANG(Tooltip, STR_FI_TOOLTIP_MATH);
 End
+
+FolderItemProperty git_Folderitem_Smath_AppIDProperty
+    ShortcutID = gid_Folderitem_Smath;
+    Key = "System.AppUserModel.ID";
+    Value = "TheDocumentFoundation.LibreOffice.Math";
+End
 #endif
diff --git a/scp2/source/ooo/folderitem_ooo.scp b/scp2/source/ooo/folderitem_ooo.scp
index 6bccaff3f80c..c9b24c1e58d4 100644
--- a/scp2/source/ooo/folderitem_ooo.scp
+++ b/scp2/source/ooo/folderitem_ooo.scp
@@ -35,6 +35,12 @@ FolderItem gid_Folderitem_LibreOffice
     Parameter = "";
 End
 
+FolderItemProperty git_Folderitem_LibreOffice_AppIDProperty
+    ShortcutID = gid_Folderitem_LibreOffice;
+    Key = "System.AppUserModel.ID";
+    Value = "TheDocumentFoundation.LibreOffice.Startcenter";
+End
+
 FolderItem gid_Folderitem_Soffice_Desktop
 #ifdef ENABLE_SILENT_MSI
     Name = "%PRODUCTNAME";
@@ -52,3 +58,9 @@ FolderItem gid_Folderitem_Soffice_Desktop
     Parameter = "";
     ComponentCondition = "CREATEDESKTOPLINK=1";
 End
+
+FolderItemProperty git_Folderitem_Soffice_Desktop_AppIDProperty
+    ShortcutID = gid_Folderitem_Soffice_Desktop;
+    Key = "System.AppUserModel.ID";
+    Value = "TheDocumentFoundation.LibreOffice.Startcenter";
+End
diff --git a/scp2/source/writer/folderitem_writer.scp b/scp2/source/writer/folderitem_writer.scp
index 8efb9762fb2b..47ce8ecf38e8 100644
--- a/scp2/source/writer/folderitem_writer.scp
+++ b/scp2/source/writer/folderitem_writer.scp
@@ -30,4 +30,10 @@ FolderItem gid_Folderitem_Swriter
     Parameter = "";
     ALL_LANG(Tooltip, STR_FI_TOOLTIP_WRITER);
 End
+
+FolderItemProperty git_Folderitem_Swriter_AppIDProperty
+    ShortcutID = gid_Folderitem_Swriter;
+    Key = "System.AppUserModel.ID";
+    Value = "TheDocumentFoundation.LibreOffice.Writer";
+End
 #endif
diff --git a/solenv/bin/modules/installer.pm b/solenv/bin/modules/installer.pm
index 22b55378012e..59331d67edda 100644
--- a/solenv/bin/modules/installer.pm
+++ b/solenv/bin/modules/installer.pm
@@ -64,6 +64,7 @@ use installer::windows::inifile;
 use installer::windows::media;
 use installer::windows::mergemodule;
 use installer::windows::msiglobal;
+use installer::windows::msishortcutproperty;
 use installer::windows::msp;
 use installer::windows::property;
 use installer::windows::removefile;
@@ -351,6 +352,7 @@ sub run {
 
     my $folderinproductarrayref;
     my $folderitemsinproductarrayref;
+    my $folderitempropertiesinproductarrayref;
     my $registryitemsinproductarrayref;
     my $windowscustomactionsarrayref;
     my $mergemodulesarrayref;
@@ -367,6 +369,10 @@ sub run {
 
         installer::setupscript::add_predefined_folder($folderitemsinproductarrayref, $folderinproductarrayref);
 
+        installer::logger::print_message( "... analyzing folderitemproperties ... \n" );
+
+        $folderitempropertiesinproductarrayref = installer::setupscript::get_all_items_from_script($setupscriptref, "FolderItemProperty");
+
         installer::logger::print_message( "... analyzing registryitems ... \n" );
 
         $registryitemsinproductarrayref = installer::setupscript::get_all_items_from_script($setupscriptref, "RegistryItem");
@@ -1386,6 +1392,8 @@ sub run {
 
             installer::windows::upgrade::create_upgrade_table($newidtdir, $allvariableshashref);
 
+            installer::windows::msishortcutproperty::create_msishortcutproperty_table($folderitempropertiesinproductarrayref, $folderitemsinproductarrayref, $newidtdir);
+
             if (( ! $installer::globals::languagepack ) && ( ! $installer::globals::helppack )) # the following tables not for language packs or help packs
             {
                 installer::windows::removefile::create_removefile_table($folderitemsinproductlanguageresolvedarrayref, $newidtdir);
diff --git a/solenv/bin/modules/installer/windows/idtglobal.pm b/solenv/bin/modules/installer/windows/idtglobal.pm
index dd751f4c5b9b..d3495c91f448 100644
--- a/solenv/bin/modules/installer/windows/idtglobal.pm
+++ b/solenv/bin/modules/installer/windows/idtglobal.pm
@@ -475,6 +475,16 @@ sub write_idt_header
         push(@{$idtref}, $oneline);
     }
 
+    if ( $definestring eq "msishortcutproperty" )
+    {
+        $oneline = "MsiShortcutProperty\tShortcut_\tPropertyKey\tPropVariantValue\n";
+        push(@{$idtref}, $oneline);
+        $oneline = "s72\ts72\tS255\tS255\n";
+        push(@{$idtref}, $oneline);
+        $oneline = "MsiShortcutProperty\tMsiShortcutProperty\n";
+        push(@{$idtref}, $oneline);
+    }
+
     if ( $definestring eq "registry" )
     {
         $oneline = "Registry\tRoot\tKey\tName\tValue\tComponent_\n";
diff --git a/solenv/bin/modules/installer/windows/msishortcutproperty.pm b/solenv/bin/modules/installer/windows/msishortcutproperty.pm
new file mode 100644
index 000000000000..5436f2565cf2
--- /dev/null
+++ b/solenv/bin/modules/installer/windows/msishortcutproperty.pm
@@ -0,0 +1,143 @@
+#
+# This file is part of the LibreOffice project.
+#
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+#
+# This file incorporates work covered by the following license notice:
+#
+#   Licensed to the Apache Software Foundation (ASF) under one or more
+#   contributor license agreements. See the NOTICE file distributed
+#   with this work for additional information regarding copyright
+#   ownership. The ASF licenses this file to you under the Apache
+#   License, Version 2.0 (the "License"); you may not use this file
+#   except in compliance with the License. You may obtain a copy of
+#   the License at http://www.apache.org/licenses/LICENSE-2.0 .
+#
+
+package installer::windows::msishortcutproperty;
+
+use installer::exiter;
+use installer::files;
+use installer::globals;
+use installer::windows::idtglobal;
+
+##############################################################
+# Returning identifier for msishortcutproperty table.
+##############################################################
+
+sub get_msishortcutproperty_identifier
+{
+    my ($msishortcutproperty) = @_;
+
+    my $identifier = $msishortcutproperty->{'gid'};
+
+    return $identifier;
+}
+
+##############################################################
+# Returning shortcut for msishortcutproperty table.
+##############################################################
+
+sub get_msishorcutproperty_shortcut
+{
+    my ($msishortcutproperty, $filesref) = @_;
+
+    my $onefile;
+    my $shortcut = "";
+    my $found = 0;
+    my $msishortcutproperty_shortcutid = $msishortcutproperty->{'ShortcutID'};
+
+    for ( my $i = 0; $i <= $#{$filesref}; $i++ )
+    {
+        $onefile = ${$filesref}[$i];
+        my $filegid = $onefile->{'gid'};
+
+        if ( $filegid eq $msishortcutproperty_shortcutid )
+        {
+            $found = 1;
+            last;
+        }
+    }
+
+    if (!($found))
+    {
+        installer::exiter::exit_program("ERROR: Did not find ShortcutID $msishortcutproperty_shortcutid in file collection for shortcut", "get_msishorcutproperty_shortcut");
+    }
+
+    $shortcut = $onefile->{'gid'};
+
+    return $shortcut;
+}
+
+##############################################################
+# Returning the propertykey for msishortcutproperty table.
+##############################################################
+
+sub get_msishortcutproperty_propertykey
+{
+    my ($msishortcutproperty) = @_;
+
+    my $propertykey = "";
+    if ( $msishortcutproperty->{'Key'} ) { $propertykey = $msishortcutproperty->{'Key'}; }
+
+    return $propertykey;
+}
+
+################################################################
+# Returning the propvariantvalue for msishortcutproperty table.
+################################################################
+
+sub get_msishortcutproperty_propvariantvalue
+{
+    my ($msishortcutproperty) = @_;
+
+    my $propvariantvalue = "";
+    if ( $msishortcutproperty->{'Value'} ) { $propvariantvalue = $msishortcutproperty->{'Value'}; }
+
+    return $propvariantvalue;
+}
+
+###################################################################
+# Creating the file MsiShortcutProperty.idt dynamically
+# Content:
+# MsiShortcutProperty Shortcut_ PropertyKey PropVariantValue
+###################################################################
+
+sub create_msishortcutproperty_table
+{
+    my ($folderitempropertiesref, $folderitemsref, $basedir) = @_;
+
+    my @msishortcutpropertytable = ();
+
+    installer::windows::idtglobal::write_idt_header(\@msishortcutpropertytable, "msishortcutproperty");
+
+    # The entries defined in scp as FolderItemProperties
+
+    for ( my $j = 0; $j <= $#{$folderitempropertiesref}; $j++ )
+    {
+        my $onelink = ${$folderitempropertiesref}[$j];
+        my %msishortcutproperty = ();
+
+        $msishortcutproperty{'MsiShortcutProperty'} = get_msishortcutproperty_identifier($onelink);
+        $msishortcutproperty{'Shortcut_'} = get_msishorcutproperty_shortcut($onelink, $folderitemsref);
+        $msishortcutproperty{'PropertyKey'} = get_msishortcutproperty_propertykey($onelink);
+        $msishortcutproperty{'PropVariantValue'} = get_msishortcutproperty_propvariantvalue($onelink);
+
+        my $oneline = $msishortcutproperty{'MsiShortcutProperty'} . "\t" . $msishortcutproperty{'Shortcut_'} . "\t"
+                    . $msishortcutproperty{'PropertyKey'} . "\t" . $msishortcutproperty{'PropVariantValue'} . "\n";
+
+        push(@msishortcutpropertytable, $oneline);
+    }
+
+    # Saving the file
+
+    my $msishortcutpropertytablename = $basedir . $installer::globals::separator . "MsiShorP.idt";
+    installer::files::save_file($msishortcutpropertytablename ,\@msishortcutpropertytable);
+    my $infoline = "Created idt file: $msishortcutpropertytablename\n";
+    push(@installer::globals::logfileinfo, $infoline);
+}
+
+
+1;
diff --git a/solenv/bin/modules/par2script/globals.pm b/solenv/bin/modules/par2script/globals.pm
index 770b6c890973..02a399767b4e 100644
--- a/solenv/bin/modules/par2script/globals.pm
+++ b/solenv/bin/modules/par2script/globals.pm
@@ -34,13 +34,13 @@ BEGIN
 
     @allitems = ("Installation", "ScpAction", "Directory", "File",
                  "Shortcut", "Unixlink", "Module", "Profile", "ProfileItem",
-                 "Folder", "FolderItem", "RegistryItem", "WindowsCustomAction",
-                 "MergeModule");
+                 "Folder", "FolderItem", "FolderItemProperty", "RegistryItem",
+                 "WindowsCustomAction", "MergeModule");
 
     @items_assigned_at_modules = ("File", "Directory", "Unixlink");
     @items_with_directories = ("File", "Profile", "Shortcut", "Unixlink");
     @items_with_moduleid = ("Profile", "ProfileItem", "FolderItem", "RegistryItem");
-    @items_without_moduleid = ("File", "Directory", "Shortcut", "Unixlink");
+    @items_without_moduleid = ("File", "FolderItemProperty", "Directory", "Shortcut", "Unixlink");
 
     %searchkeys = ("File" => "Files", "Directory" => "Dirs", "Unixlink" => "Unixlinks");
 
diff --git a/solenv/bin/modules/pre2par/globals.pm b/solenv/bin/modules/pre2par/globals.pm
index c69e5b556703..08d79b06b937 100644
--- a/solenv/bin/modules/pre2par/globals.pm
+++ b/solenv/bin/modules/pre2par/globals.pm
@@ -33,8 +33,8 @@ BEGIN
 
     @allitems = ("Installation", "ScpAction", "HelpText", "Directory", "DataCarrier", "StarRegistry", "File",
                  "Shortcut", "Custom", "Unixlink", "Procedure", "Module", "Profile", "ProfileItem",
-                 "Folder", "FolderItem", "RegistryItem", "StarRegistryItem", "WindowsCustomAction",
-                 "MergeModule");
+                 "Folder", "FolderItem", "FolderItemProperty", "RegistryItem", "StarRegistryItem",
+                 "WindowsCustomAction", "MergeModule");
 
     $logging     = 0;
     $logfilename = "logfile.log";   # the default logfile name for global errors