Как изменить msi пакет

• Download HTML Article — 335 Kb

Introduction

This article is in the form of a compiled HTML help file. It describes some of the basic architecture of the MSI package created using the Visual Studio .NET Setup Project.

We’ll look at how elements defined in the NET IDE are translated into an actual MSI setup. And we’ll perform a simple exercise in customization of the MSI using the MSI editor tool Orca.

Developers occasionally ask how to create an Uninstall shortcut in their application setups. We’ll use this customization as our example.

Having said that, let me state something for the record:

I am already well aware that this is contrary to Microsoft Logo Certification which states that applications should only be removed from the Control Panel. But consider the following:

Most developers never get their setups Logo Certified. In fact, most installs for Microsoft products themselves do not come even close to Logo Certifiable. (For that matter, Microsoft changes their «Best Practices Guidelines» like women change their shoes).

And as far as creating uninstall menu entries being against recommended best practices, as preached by Microsoft, look at what Microsoft practices: I just downloaded (on 04/05/2005) the latest MS SDK Platform Update. It creates an uninstall entry on the program menu! I also downloaded the Microsoft AntiSpyware Package. It creates an uninstall entry on the program menu. The MSDE setup? It creates an uninstall entry on the program menu. That’s just for starters.

Uninstall menu entries are more user friendly than having to go to the Control Panel. They are nice to have particularly if you are creating a package, for example, that allows a 30 day trial.

If people want to add an uninstall entry, obviously Microsoft does not see anything wrong with it, and I see nothing wrong with it either.

And even if you are a die-hard adherent to MS Best Practices, you can use the same techniques to create other useful custom shortcuts. For example, an application that uses MSDE or SQL Server might want to include it’s own menu entry to launch the Service Manager. This is a lot more user friendly than having to explain to a user that, they have to navigate to a different menu entry in case they need to manually start the SQL Server for some reason.

More importantly, we’ll also take the first steps towards learning some basics about how Windows Installer packages are put together, and how to edit them etc. etc.

Since this is not a conventional programming tutorial, there is no source code. Just download the zip and open the help file. There are very detailed steps, descriptions, and images throughout. You’ll need to have any version of VS.NET installed. If you use Visual Studio 6 with the VSI add-in that creates MSI’s instead of using the Package and Deployment Wizard that will work just fine too, but you may have to add a few steps — look at the article on creating menu entries with VSI add-in on my website (the link is in the download).

You’ll find links to the Orca and other SDK tools, you’ll need in the help file.

• Download HTML Article — 335 Kb

Introduction

This article is in the form of a compiled HTML help file. It describes some of the basic architecture of the MSI package created using the Visual Studio .NET Setup Project.

We’ll look at how elements defined in the NET IDE are translated into an actual MSI setup. And we’ll perform a simple exercise in customization of the MSI using the MSI editor tool Orca.

Developers occasionally ask how to create an Uninstall shortcut in their application setups. We’ll use this customization as our example.

Having said that, let me state something for the record:

I am already well aware that this is contrary to Microsoft Logo Certification which states that applications should only be removed from the Control Panel. But consider the following:

Most developers never get their setups Logo Certified. In fact, most installs for Microsoft products themselves do not come even close to Logo Certifiable. (For that matter, Microsoft changes their «Best Practices Guidelines» like women change their shoes).

And as far as creating uninstall menu entries being against recommended best practices, as preached by Microsoft, look at what Microsoft practices: I just downloaded (on 04/05/2005) the latest MS SDK Platform Update. It creates an uninstall entry on the program menu! I also downloaded the Microsoft AntiSpyware Package. It creates an uninstall entry on the program menu. The MSDE setup? It creates an uninstall entry on the program menu. That’s just for starters.

Uninstall menu entries are more user friendly than having to go to the Control Panel. They are nice to have particularly if you are creating a package, for example, that allows a 30 day trial.

If people want to add an uninstall entry, obviously Microsoft does not see anything wrong with it, and I see nothing wrong with it either.

And even if you are a die-hard adherent to MS Best Practices, you can use the same techniques to create other useful custom shortcuts. For example, an application that uses MSDE or SQL Server might want to include it’s own menu entry to launch the Service Manager. This is a lot more user friendly than having to explain to a user that, they have to navigate to a different menu entry in case they need to manually start the SQL Server for some reason.

More importantly, we’ll also take the first steps towards learning some basics about how Windows Installer packages are put together, and how to edit them etc. etc.

Since this is not a conventional programming tutorial, there is no source code. Just download the zip and open the help file. There are very detailed steps, descriptions, and images throughout. You’ll need to have any version of VS.NET installed. If you use Visual Studio 6 with the VSI add-in that creates MSI’s instead of using the Package and Deployment Wizard that will work just fine too, but you may have to add a few steps — look at the article on creating menu entries with VSI add-in on my website (the link is in the download).

You’ll find links to the Orca and other SDK tools, you’ll need in the help file.

This code has only been tested on 1 file, where the name is excactly the same as the file being replaced..

but it should implement Christopher Painters answer in C#, with DTF (from WIX)

/**
 * this is a bastard class, as it is not really a part of building an installer package, 
 * however, we need to be able to modify a prebuild package, and add user specific files, post build, to save memory on server, and have a fast execution time.
 * 
 * author Henrik Dalsager
 */

//I'm using everything...
using System;
using System.IO;
using System.Linq;
using System.Text;
using System.Collections;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.Globalization;
using System.Text.RegularExpressions;
using Microsoft.Deployment.Compression.Cab;
using Microsoft.Deployment.WindowsInstaller;
using Microsoft.Deployment.WindowsInstaller.Package;

namespace MSIFileManipulator
{
/**
 * brief updates an existing MSI, I.E. add new files
 * 
 */
class updateMSI
{
    //everything revolves around this package..
    InstallPackage pkg = null;

    //the destruction should close connection with the database, just in case we forgot..
    ~updateMSI()
    {
        if (pkg != null)
        {
            try
            {
                pkg.Close();
            }
            catch (Exception ex)
            {
                //rollback?

                //do nothing.. we just don't want to break anything if database was already closed, but not dereffered.
            }
        }
    }

    /**
     * brief compresses a list of files, in a workdir, to a cabinet file, in the same workdir.
     * param workdir path to the workdir
     * param filesToArchive a list of filenames, of the files to include in the cabinet file.
     * return filename of the created cab file
     */
    public string createCabinetFileForMSI(string workdir, List<string> filesToArchive)
    {
        //create temporary cabinet file at this path:
        string GUID = Guid.NewGuid().ToString();
        string cabFile = GUID + ".cab";
        string cabFilePath = Path.Combine(workdir, cabFile);

        //create a instance of Microsoft.Deployment.Compression.Cab.CabInfo
        //which provides file-based operations on the cabinet file
        CabInfo cab = new CabInfo(cabFilePath);

        //create a list with files and add them to a cab file
        //now an argument, but previously this was used as test:
        //List<string> filesToArchive = new List<string>() { @"C:file1", @"C:file2" };
        cab.PackFiles(workdir, filesToArchive, filesToArchive);

        //we will ned the path for this file, when adding it to an msi..
        return cabFile;
    }

    /**
     * brief embeds a cabinet file into an MSI into the "stream" table, and adds it as a new media in the media table
     *  This does not install the files on a clients computer, if he runs the installer,
     *  as none of the files in the cabinet, is defined in the MSI File Table (that informs msiexec where to place mentioned files.)
     *  It simply allows cabinet files to piggypack within a package, so that they may be extracted again at clients computer.
     *  
     * param pathToCabFile full absolute path to the cabinet file
     * return media number of the new cabinet file wihtin the MSI
     */
    public int insertCabFileAsNewMediaInMSI(string cabFilePath, int numberOfFilesInCabinet = -1)
    {
        if (pkg == null)
        {
            throw new Exception("Cannot insert cabinet file into non-existing MSI package. Please Supply a path to the MSI package");
        }

        int numberOfFilesToAdd = numberOfFilesInCabinet;
        if (numberOfFilesInCabinet < 0)
        {
            CabInfo cab = new CabInfo(cabFilePath);
            numberOfFilesToAdd = cab.GetFiles().Count;
        }

        //create a cab file record as a stream (embeddable into an MSI)
        Record cabRec = new Record(1);
        cabRec.SetStream(1, cabFilePath);

        /*The Media table describes the set of disks that make up the source media for the installation.
          we want to add one, after all the others
          DiskId - Determines the sort order for the table. This number must be equal to or greater than 1,
          for out new cab file, it must be > than the existing ones...
        */
        //the baby SQL service in the MSI does not support "ORDER BY `` DESC" but does support order by..
        IList<int> mediaIDs = pkg.ExecuteIntegerQuery("SELECT `DiskId` FROM `Media` ORDER BY `DiskId`");
        int lastIndex = mediaIDs.Count - 1;
        int DiskId = mediaIDs.ElementAt(lastIndex) + 1;

        //wix name conventions of embedded cab files is "#cab" + DiskId + ".cab"
        string mediaCabinet = "cab" + DiskId.ToString() + ".cab";

        //The _Streams table lists embedded OLE data streams.
        //This is a temporary table, created only when referenced by a SQL statement.
        string query = "INSERT INTO `_Streams` (`Name`, `Data`) VALUES ('" + mediaCabinet + "', ?)";
        pkg.Execute(query, cabRec);
        Console.WriteLine(query);

        /*LastSequence - File sequence number for the last file for this new media.
          The numbers in the LastSequence column specify which of the files in the File table
          are found on a particular source disk.

          Each source disk contains all files with sequence numbers (as shown in the Sequence column of the File table)
          less than or equal to the value in the LastSequence column, and greater than the LastSequence value of the previous disk
          (or greater than 0, for the first entry in the Media table).
          This number must be non-negative; the maximum limit is 32767 files.
          /MSDN
         */
        IList<int> sequences = pkg.ExecuteIntegerQuery("SELECT `LastSequence` FROM `Media` ORDER BY `LastSequence`");
        lastIndex = sequences.Count - 1;
        int LastSequence = sequences.ElementAt(lastIndex) + numberOfFilesToAdd;

        query = "INSERT INTO `Media` (`DiskId`, `LastSequence`, `Cabinet`) VALUES (" + DiskId.ToString() + "," + LastSequence.ToString() + ",'#" + mediaCabinet + "')";
        Console.WriteLine(query);
        pkg.Execute(query);

        return DiskId;

    }

    /**
     * brief embeds a cabinet file into an MSI into the "stream" table, and adds it as a new media in the media table
     *  This does not install the files on a clients computer, if he runs the installer,
     *  as none of the files in the cabinet, is defined in the MSI File Table (that informs msiexec where to place mentioned files.)
     *  It simply allows cabinet files to piggypack within a package, so that they may be extracted again at clients computer.
     *  
     * param pathToCabFile full absolute path to the cabinet file
     * param pathToMSIFile full absolute path to the msi file
     * return media number of the new cabinet file wihtin the MSI
     */
    public int insertCabFileAsNewMediaInMSI(string cabFilePath, string pathToMSIFile, int numberOfFilesInCabinet = -1)
    {
        //open the MSI package for editing
        pkg = new InstallPackage(pathToMSIFile, DatabaseOpenMode.Direct); //have also tried direct, while database was corrupted when writing.
        return insertCabFileAsNewMediaInMSI(cabFilePath, numberOfFilesInCabinet);
    }

    /**
     * brief overloaded method, that embeds a cabinet file into an MSI into the "stream" table, and adds it as a new media in the media table
     *  This does not install the files on a clients computer, if he runs the installer,
     *  as none of the files in the cabinet, is defined in the MSI File Table (that informs msiexec where to place mentioned files.)
     *  It simply allows cabinet files to piggypack within a package, so that they may be extracted again at clients computer.
     *
     * param workdir absolute path to the cabinet files location
     * param cabFile is the filename of the cabinet file
     * param pathToMSIFile full absolute path to the msi file
     * return media number of the new cabinet file wihtin the MSI
     */
    public int insertCabFileAsNewMediaInMSI(string workdir, string cabFile, string pathToMSIFile, int numberOfFilesInCabinet = -1)
    {
        string absPathToCabFile = Path.Combine(workdir, cabFile);
        string absPathToMSIFile = Path.Combine(workdir, pathToMSIFile);
        return insertCabFileAsNewMediaInMSI(absPathToCabFile, absPathToMSIFile, numberOfFilesInCabinet);
    }

    /**
     * brief reconfigures the MSI, so that a file pointer is "replaced" by a file pointer to another cabinets version of said file...
     * The original file will not be removed from the MSI, but simply orphaned (no component refers to it). It will not be installed, but will remain in the package.
     * 
     * param OriginalFileName (this is the files target name at the clients computer after installation. It is our only way to locate the file in the file table. If two or more files have the same target name, we cannot reorient the pointer to that file!)
     * param FileNameInCabinet (In case you did not have the excact same filename for the new file, as the original file, you can specify the name of the file, as it is known in the cabinet, here.)
     * param DiskIdOfCabinetFile - Very important information. This is the Id of the new cabinet file, it is the only way to know where the new source data is within the MSI cabinet stream. This function extracts the data it needs from there, like sequence numbers
     */
    public void PointAPreviouslyConfiguredComponentsFileToBeFetchedFromAnotherCabinet(string OriginalFileName, string FileNameInCabinet, string newFileSizeInBytes, int DiskIdOfCabinetFile)
    {
        //retrieve the range of sequence numbers for this cabinet file. 
        string query = "SELECT `DiskId` FROM `Media` ORDER BY `LastSequence`";
        Console.WriteLine(query);
        IList<int> medias = pkg.ExecuteIntegerQuery("SELECT `DiskId` FROM `Media` ORDER BY `LastSequence`");

        query = "SELECT `LastSequence` FROM `Media` ORDER BY `LastSequence`";
        Console.WriteLine(query); 
        IList<int> mediaLastSequences = pkg.ExecuteIntegerQuery("SELECT `LastSequence` FROM `Media` ORDER BY `LastSequence`");

        if(medias.Count != mediaLastSequences.Count)
        {
            throw new Exception("there is something wrong with the Media Table, There is a different number of DiskId and LastSequence rows");
        }

        if(medias.Count <= 0)
        {
            throw new Exception("there is something wrong with the Media Table, There are no rows with medias available..");
        }

        int FirstSequence = -1;
        int LastSequence = -1;
        int lastIndex = medias.Count - 1;

        for (int index = lastIndex; index >= 0; index--)
        {
            int rowLastSequence = mediaLastSequences.ElementAt(index);
            int rowDiskId = medias.ElementAt(index);

            if (rowDiskId == DiskIdOfCabinetFile)
            {
                LastSequence = rowLastSequence;
                if (index < lastIndex)
                {
                    //the next cabinet files last sequence number + 1,  is this ones first..
                    FirstSequence = mediaLastSequences.ElementAt(index + 1) + 1;
                    break;
                }
                else
                {
                    //all files from the first, to this last sequence number, are found in this cabinet
                    FirstSequence = mediaLastSequences.ElementAt(lastIndex);
                    break;
                }
            }
        }

        //now we will look in the file table to get a vacant sequence number in the new cabinet (if available - first run will return empty, and thus default to FirstSequence)
        int Sequence = FirstSequence;
        query = "SELECT `Sequence` FROM `File` WHERE `Sequence` >= " + FirstSequence.ToString() + " AND `Sequence` <= " + LastSequence.ToString() + " ORDER BY `Sequence`";
        Console.WriteLine(query);

        IList<int> SequencesInRange = pkg.ExecuteIntegerQuery(query);
        for (int index = 0; index < SequencesInRange.Count; index++)
        {
            if (FirstSequence + index != SequencesInRange.ElementAt(index))
            {
                Sequence = FirstSequence + index;
                break;
            }
        }

        //now we set this in the file table, to re-point this file to the new media..
        //File.FileName = FileNameInCabinet;
        //File.FileSize = newFileSizeInBytes;
        //File.Sequence = sequence;
        query = "UPDATE `File` SET `File`.`FileName`='" + FileNameInCabinet + "' WHERE `File`='" + OriginalFileName + "'";
        Console.WriteLine(query);
        pkg.Execute(query);
        query = "UPDATE `File` SET `File`.`FileSize`=" + newFileSizeInBytes + " WHERE `File`='" + OriginalFileName + "'";
        Console.WriteLine(query);
        pkg.Execute(query);
        query = "UPDATE `File` SET `File`.`Sequence`=" + Sequence.ToString() + " WHERE `File`='" + OriginalFileName + "'";
        Console.WriteLine(query);
        pkg.Execute(query);
    }        
}
}

demonstration usage:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace MSIFileManipulator
{
class Program
{
    static void Main(string[] args)
    {
        string workdir = @"C:UsersMeMyDevFoldertests";
        string msiFile = "replace_test_copy.msi";
        string fileName = "REPLACE_THIS_IMAGE.png";

        List<string> filesToInclude = new List<string>();
        System.IO.FileInfo fileInfo = new System.IO.FileInfo(System.IO.Path.Combine(workdir, fileName));
        if (fileInfo.Exists)
        {
            Console.WriteLine("now adding: " + fileName + " to cabinet");
            filesToInclude.Add(fileName);

            updateMSI myMSI = new updateMSI();
            string cabfileName = myMSI.createCabinetFileForMSI(workdir, filesToInclude);
            Console.WriteLine("cabinet file saved as: " + cabfileName);

            int diskID = myMSI.insertCabFileAsNewMediaInMSI(workdir, cabfileName, msiFile);
            Console.WriteLine("new media added with disk ID: " + diskID.ToString());
            myMSI.PointAPreviouslyConfiguredComponentsFileToBeFetchedFromAnotherCabinet(fileName, fileName, fileInfo.Length.ToString(), diskID);
            Console.WriteLine("Done");

        }
        else
        {
            Console.WriteLine("Could not locate the replacement file:" + fileName);
        }
        Console.WriteLine("press any key to exit");
        Console.ReadKey();
    }
}
}

I am aware that my test does not clean up after it self..