Part 4: Building an Installation Package for a Real Outlook Social Connector Provider

<?xml version="1.0" encoding="utf-8"?>
<Product
    xmlns="http://schemas.microsoft.com/developer/2004/01/bootstrapper"
    ProductCode="OSC.Install_V1.1">

    <RelatedProducts>
        <DependsOnProduct Code="Microsoft.Windows.Installer.3.1"/>
    </RelatedProducts>

    <InstallChecks>
        <!--Outlook Social Connector version-->
        <RegistryCheck Property="OSCVersion"
                       Key="HKLM\Software\Microsoft\Office\Outlook\SocialConnector"
                       Value="OSCVersion"/>
        <!--Office version-->
        <RegistryCheck Property="OfficeVersion"
                       Key="HKLM\Software\Microsoft\Office\Common"
                       Value="LastAccessInstall"/>
        <!--Outlook 2010 bitness-->
        <RegistryCheck Property="Outlook14Bitness"
                       Key="HKLM\Software\Microsoft\Office\14.0\Outlook"
                       Value="Bitness"/>
    </InstallChecks>
</Product>

<?xml version="1.0" encoding="utf-8" ?>
<Package
    xmlns="http://schemas.microsoft.com/developer/2004/01/bootstrapper"
    Name="Outlook Social Connector v1.1"
    Culture="en">

    <PackageFiles>
        <!--G-link to install the latest version of the 32-bit OSC 
            (English version) for Outlook 2003 and Outlook 2007.-->
        <PackageFile Name="outlooksocialconnector-x86-en-us.exe"
                     HomeSite="http://g.live.com/0cr1033/80"
                     PublicKey="3082010a0282010100bd3089fb4572a8536b9e894f0023c0bed41d3db1594038f373918226e6961200
53d91c820e3cce1dbbbdf7428d97d4fc381ae4b9f9e3ecd36103bfa0d3d6754d5c46a9ed5ef0d2e2695b1a73eab31c8d04cd2944a064592f1e
985d6ec7ab18398265c4a7bcab758819ea87971426b37f2676a4d4383984e3b326d518f92be9d2c9165a5421f2978d878629fef4492ce68bf8
043f7dcdcd9692860d7103e2d0fe0c4235ffd7b83fdd8e450a7df6d74bad5bf076721d77237d8935c41c5db250034b476d07a75588980680a6
81ad544ed881d6fabf42c031be550d99d553491230ebe5a5887c5ec47a5a148708b43769a0eb32248c08ebf9d414bae0fccdeaa4150203010001"/>
        <!--G-link to install the latest version of the 32-bit OSC 
            (English version) for Outlook 2010.-->
        <PackageFile Name="osc-kb983403-fullfile-x86-en-us.exe"
                     HomeSite ="http://g.live.com/0cr1033/82"
                     PublicKey="3082010a0282010100bd3089fb4572a8536b9e894f0023c0bed41d3db1594038f373918226e696
120053d91c820e3cce1dbbbdf7428d97d4fc381ae4b9f9e3ecd36103bfa0d3d6754d5c46a9ed5ef0d2e2695b1a73eab31c8d04cd2944a0
64592f1e985d6ec7ab18398265c4a7bcab758819ea87971426b37f2676a4d4383984e3b326d518f92be9d2c9165a5421f2978d878629fe
f4492ce68bf8043f7dcdcd9692860d7103e2d0fe0c4235ffd7b83fdd8e450a7df6d74bad5bf076721d77237d8935c41c5db250034b476d
07a75588980680a681ad544ed881d6fabf42c031be550d99d553491230ebe5a5887c5ec47a5a148708b43769a0eb32248c08ebf9d414ba
e0fccdeaa4150203010001"/>
        <!--G-link to install the latest version of the 64-bit OSC 
            (English version) for Outlook 2010.-->
        <PackageFile Name="osc-kb983403-fullfile-x64-en-us.exe"
                     HomeSite ="http://g.live.com/0cr1033/83"
                     PublicKey="3082010a0282010100bd3089fb4572a8536b9e894f0023c0bed41d3db1594038f373918226e69
6120053d91c820e3cce1dbbbdf7428d97d4fc381ae4b9f9e3ecd36103bfa0d3d6754d5c46a9ed5ef0d2e2695b1a73eab31c8d04cd2944
a064592f1e985d6ec7ab18398265c4a7bcab758819ea87971426b37f2676a4d4383984e3b326d518f92be9d2c9165a5421f2978d87862
9fef4492ce68bf8043f7dcdcd9692860d7103e2d0fe0c4235ffd7b83fdd8e450a7df6d74bad5bf076721d77237d8935c41c5db250034b
476d07a75588980680a681ad544ed881d6fabf42c031be550d99d553491230ebe5a5887c5ec47a5a148708b43769a0eb32248c08ebf9d
414bae0fccdeaa4150203010001"/>
    </PackageFiles>

    <Commands>
        <!--Install latest OSC for Outlook 2003.-->
        <Command PackageFile="outlooksocialconnector-x86-en-us.exe">
            <InstallConditions>
                <!--Install if the OSC version is less than 1.1 and 
                    the Office version is 2003.-->
                <BypassIf Property="OSCVersion" Compare="VersionGreaterThanOrEqualTo" Value="1.1"/>
                <BypassIf Property="OfficeVersion" Compare="ValueNotExists"/>
                <BypassIf Property ="OfficeVersion" Compare="ValueNotEqualTo" Value="11.0"/>
            </InstallConditions>
            <ExitCodes>
                <ExitCode Value="0" Result="Success"/>
                <ExitCode Value="1641" Result="SuccessReboot"/>
                <ExitCode Value="3010" Result="SuccessReboot"/>
                <DefaultExitCode Result="Fail" String="GeneralFailure"/>
            </ExitCodes>
        </Command>
        <!--Install latest OSC for Outlook 2007.-->
        <Command PackageFile="outlooksocialconnector-x86-en-us.exe">
            <InstallConditions>
                <!--Install if the OSC version is less than 1.1 and 
                    the Office version is 2007.-->
                <BypassIf Property="OSCVersion" Compare="VersionGreaterThanOrEqualTo" Value="1.1"/>
                <BypassIf Property="OfficeVersion" Compare="ValueNotExists"/>
                <BypassIf Property ="OfficeVersion" Compare="ValueNotEqualTo" Value="12.0"/>
            </InstallConditions>
            <ExitCodes>
                <ExitCode Value="0" Result="Success"/>
                <ExitCode Value="1641" Result="SuccessReboot"/>
                <ExitCode Value="3010" Result="SuccessReboot"/>
                <DefaultExitCode Result="Fail" String="GeneralFailure"/>
            </ExitCodes>
        </Command>
        <!--Install latest OSC for Outlook 2010 32-bit.-->
        <Command PackageFile="osc-kb983403-fullfile-x86-en-us.exe">
            <InstallConditions>
                <!--Install if the OSC version is less than 1.1 and 
                    the Office version is 2010 and 
                    Office is 32-bit.-->
                <BypassIf Property="OSCVersion" Compare="VersionGreaterThanOrEqualTo" Value="1.1"/>
                <BypassIf Property="OfficeVersion" Compare="ValueNotExists"/>
                <BypassIf Property ="OfficeVersion" Compare="ValueNotEqualTo" Value="14.0"/>
                <BypassIf Property ="Outlook14Bitness" Compare="ValueNotEqualTo" Value="x86"/>
            </InstallConditions>
            <ExitCodes>
                <ExitCode Value="0" Result="Success"/>
                <ExitCode Value="1641" Result="SuccessReboot"/>
                <ExitCode Value="3010" Result="SuccessReboot"/>
                <DefaultExitCode Result="Fail" String="GeneralFailure"/>
            </ExitCodes>
        </Command>
        <!--Install latest OSC for Outlook 2010 64-bit-->
        <Command PackageFile="osc-kb983403-fullfile-x64-en-us.exe">
            <InstallConditions>
                <!--Install if the OSC version is less than 1.1 and 
                    the Office version is 2010 and 
                    Office is 64-bit.-->
                <!--NOTE: 64-bit versions of Office run only on 64-bit 
                    versions of Windows. For 64-bit versions of Windows, 
                    you must create an executable that evaluates the
                    64-bit registry keys and modify the Product.xml file to 
                    use an ExternalCheck to evaluate the results. Then
                    modify these InstallConditions to use the results.-->
                <BypassIf Property="OSCVersion" Compare="VersionGreaterThanOrEqualTo" Value="1.1"/>
                <BypassIf Property="OfficeVersion" Compare="ValueNotExists"/>
                <BypassIf Property ="OfficeVersion" Compare="ValueNotEqualTo" Value="14.0"/>
                <BypassIf Property ="Outlook14Bitness" Compare="ValueNotEqualTo" Value="x64"/>
            </InstallConditions>
            <ExitCodes>
                <ExitCode Value="0" Result="Success"/>
                <ExitCode Value="1641" Result="SuccessReboot"/>
                <ExitCode Value="3010" Result="SuccessReboot"/>
                <DefaultExitCode Result="Fail" String="GeneralFailure"/>
            </ExitCodes>
        </Command>
    </Commands>
</Package>

using Microsoft.Win32;
using System.Runtime.InteropServices;
using System.Diagnostics;

[System.Security.Permissions.SecurityPermission(System.Security.Permissions.SecurityAction.Demand)]
public override void Commit(IDictionary savedState)
{
    base.Commit(savedState);

    // Register the OSC Provider.
    // Get the correct Regasm.exe version to use.
    String regasmPath = GetRegasmPath();

    // Create the Regasm.exe command-line arguments.
    String regasmArgs =
        String.Format(@"/codebase ""{0}""", this.GetType().Assembly.Location);

    // Call Regasm.exe to register the provider.
    Process process = Process.Start(regasmPath, regasmArgs);
    
    // Wait a maximum of 15 seconds for Regasm.exe to complete.
    process.WaitForExit(15000);


    // Add the registry keys for this OSC provider.
    // Get the location of the OSC Social Providers key.
    // The path to the OSC Social Providers key will be in the Wow6432Node
    // branch if 32-bit Office is installed on a 64-bit OS.
    String oscProvidersLocation = GetOscProvidersKeyLocation();

    // Add registry keys to the local machine hive if installing 
    // for everyone; otherwise, install to the current user hive.
    RegistryKey hive = null;
    RegistryKey oscProvidersKey = null;
    if (this.Context.Parameters["InstallAllUsers"] == "1")
    {
        hive = Registry.LocalMachine;
    }
    else
    {
        hive = Registry.CurrentUser;
    }

    // Open the OSC Social Providers key.
    oscProvidersKey = hive.CreateSubKey(oscProvidersLocation);
    if (oscProvidersKey != null)
    {
        // Add the keys for this OSC provider.
        RegistryKey providerKey =
            oscProvidersKey.CreateSubKey(@"OfficeTalkOSCProvider.OTProvider");

        if (providerKey != null)
        {
            providerKey.SetValue("FriendlyName", 
                "OfficeTalkOSCProvider", 
                RegistryValueKind.String);
            providerKey.SetValue("Url", 
                "http://yoururl", 
                RegistryValueKind.String);
        }
    }
}

[System.Security.Permissions.SecurityPermission(System.Security.Permissions.SecurityAction.Demand)]
protected override void OnBeforeUninstall(IDictionary savedState)
{
    base.OnBeforeUninstall(savedState);

    // Unregister the OSC Provider.
    // Get the correct Regasm.exe version to use.
    String regasmPath = GetRegasmPath();

    // Create the Regasm.exe command-line arguments.
    String regasmArgs =
        String.Format(@"/unregister ""{0}""", 
            this.GetType().Assembly.Location);
    
    // Call Regasm.exe to unregister the provider.
    Process process = Process.Start(regasmPath, regasmArgs);
    
    // Wait a maximum of 15 seconds for Regasm.exe to complete.
    process.WaitForExit(15000);


    // Remove the registry keys for this OSC provider.
    // Get the location of the OSC Social Providers key.
    // The path to the OSC Social Providers key will be in the Wow6432Node 
    // branch if 32-bit Office is installed on a 64-bit OS.
    string oscProvidersLocation = GetOscProvidersKeyLocation();

    // Remove registry keys from the local machine hive if installing
    // for everyone; otherwise, remove from the current user hive.
    RegistryKey hive = null;
    RegistryKey oscProvidersKey = null;
    if (this.Context.Parameters["InstallAllUsers"] == "1")
    {
        hive = Registry.LocalMachine;
    }
    else
    {
        hive = Registry.CurrentUser;
    }

    // Open the OSC Social Providers key.
    oscProvidersKey = hive.OpenSubKey(oscProvidersLocation, true);

    if (oscProvidersKey != null)
    {
        // Remove the keys for this OSC provider.
        oscProvidersKey.DeleteSubKeyTree("OfficeTalkOSCProvider.OTProvider", 
            false);
    }
}

private static bool IsOffice64Bit()
{
    // Determine whether a 64-bit operating system is in use.
    bool is64bitOS = System.Environment.Is64BitOperatingSystem;

    // If the operating system is not a 64-bit, Office cannot be 64-bit.
    if (!is64bitOS)
    {
        return false;
    }

    // Outlook bitness is stored in the Outlook version branch.
    // Get the version of Outlook currently installed.
    int officeVersion = 0;
    RegistryKey hive =
        RegistryKey.OpenBaseKey(RegistryHive.LocalMachine,
        RegistryView.Registry64);

    // Find the version of Office installed.
    // Check the 64-bit registry key.
    RegistryKey officeKey =
        hive.OpenSubKey(@"Software\Microsoft\Office\Common");
    officeVersion =
        (int)officeKey.GetValue("LastAccessInstall", 0);

    // If the Office version was not found, check the 32-bit registry key.
    if (officeVersion == 0)
    {
        officeKey =
            hive.OpenSubKey(@"Software\Wow6432Node\Microsoft\Office\Common");
        officeVersion =
            (int)officeKey.GetValue("LastAccessInstall", 0);
    }

    // Find the Outlook bitness.
    String officeKeyLocation =
        String.Format(@"Software\Microsoft\Office\{0}.0\Outlook",
        officeVersion);
    RegistryKey versionedKey = hive.OpenSubKey(officeKeyLocation);
    String bitness = versionedKey.GetValue("Bitness", String.Empty).ToString();

    // Return true if Outlook is 64-bit; otherwise, return false.
    if (bitness == "x64")
    {
        return true;
    }
    else
    {
        return false;
    }
}

private static string GetRegasmPath()
{
    // Variables used to build the Regasm.exe path.
    string regasmPath = String.Empty;
    string runtimeFolder32 = String.Empty;
    string runtimeFolder64 = String.Empty;

    // Determine whether a 64-bit operating system is in use.
    bool is64bitOS = System.Environment.Is64BitOperatingSystem;

    // Determine whether Office is 64-bit.
    bool isOutlook64bit = IsOffice64Bit();

    // If the operating system is 64-bit, locate both the 32-bit 
    // and 64-bit versions of Regasm.exe.
    if (is64bitOS)
    {
        // Get the 32-bit runtime folder.
        RegistryKey hive32 =
            RegistryKey.OpenBaseKey(RegistryHive.LocalMachine, 
                RegistryView.Registry32);
        RegistryKey hklmRuntime32Key =
            hive32.OpenSubKey(@"Software\Wow6432Node\Microsoft\.NETFramework");
        runtimeFolder32 =
            hklmRuntime32Key.GetValue("InstallRoot", 
                String.Empty).ToString();

        // Get the 64-bit runtime folder.
        RegistryKey hive64 =
            RegistryKey.OpenBaseKey(RegistryHive.LocalMachine, 
                RegistryView.Registry64);
        RegistryKey hklmRuntime64Key =
            hive64.OpenSubKey(@"Software\Microsoft\.NETFramework");
        runtimeFolder64 =
            hklmRuntime64Key.GetValue("InstallRoot", 
                String.Empty).ToString();
    }
    else
    {
        // Get the 32-bit runtime folder.
        runtimeFolder32 = Registry.GetValue(
            @"HKEY_LOCAL_MACHINE\Software\Microsoft\.NETFramework",
            "InstallRoot",
            String.Empty).ToString();
    }

    // Determine the current runtime, used as part of the path to Regasm.exe.
    string runtimeVersion = 
        System.Runtime.InteropServices.RuntimeEnvironment.GetSystemVersion();

    // Build the path to the correct version of Regasm.exe.
    if (isOutlook64bit)
    {
        regasmPath
            = System.IO.Path.Combine(runtimeFolder64, 
                runtimeVersion, 
                "regasm.exe");
    }
    else
    {
        regasmPath
            = System.IO.Path.Combine(runtimeFolder32, 
                runtimeVersion, 
                "regasm.exe");
    }
    return regasmPath;
}

private static String GetOscProvidersKeyLocation()
{
    // Determine whether the operating system is 64-bit.
    bool is64bitOS = System.Environment.Is64BitOperatingSystem;

    // Determine whether Office is 64-bit.
    bool isOutlook64bit = IsOffice64Bit();

    // Define the location of the OSC Social Providers key.
    // The location of the OSC Social Providers key
    // is in the Wow6432Node branch when 32-bit Office 
    // is installed on a 64-bit OS.
    String oscProvidersLocation = String.Empty;
    if (is64bitOS && !isOutlook64bit)
    {
        oscProvidersLocation =
            @"Software\Wow6432Node\Microsoft\Office\Outlook\SocialConnector\SocialProviders";
    }
    else
    {
        oscProvidersLocation =
            @"Software\Microsoft\Office\Outlook\SocialConnector\SocialProviders";
    }
    return oscProvidersLocation;
}