Generate manifest files for registration-free COM

问题:

I have some applications (some native, some .NET) which use manifest files so that they can be deployed in complete isolation, without requiring any global COM registration. For example, the dependency on the dbgrid32.ocx com server is declared as follows in the myapp.exe.manifest file which sits in the same folder as myapp.exe:

<?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\"?>
<assembly manifestVersion=\"1.0\" xmlns=\"urn:schemas-microsoft-com:asm.v1\">
  <assemblyIdentity type=\"win32\" name=\"myapp.exe\" version=\"1.2.3.4\" />
  <dependency>
    <dependentAssembly>
      <assemblyIdentity type=\"win32\" name=\"dbgrid32.ocx\" version=\"5.1.81.4\" />
    </dependentAssembly>
  </dependency>
</assembly>

The dbgrid32.ocx is deployed to the same folder, along with it\'s own dbgrid32.ocx.manifest file:

<?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\"?>
<assembly manifestVersion=\"1.0\" xmlns=\"urn:schemas-microsoft-com:asm.v1\">
  <assemblyIdentity type=\"win32\" name=\"dbgrid32.ocx\" version=\"5.1.81.4\" />
  <file name=\"dbgrid32.ocx\">
     <typelib
        tlbid=\"{00028C01-0000-0000-0000-000000000046}\"
        version=\"1.0\"
        helpdir=\"\"/>
    <comClass progid=\"MSDBGrid.DBGrid\"
       clsid=\"{00028C00-0000-0000-0000-000000000046}\"
       description=\"DBGrid  Control\" />
  </file>
</assembly>

This all works fine but maintaining these manifest files manually is a bit of a pain. Is there a way to generate these files automatically? Ideally I would just like to declare the application\'s dependency on a list of COM servers (both native and .NET) and then let the rest be generated automatically. Is it possible?

回答1:

It looks like the perfect solution does not yet exist. To summarize some research:

Make My Manifest (link)

This tool scans a VB6 project to look for COM dependencies, but it also supports manual declaration of late-bound COM dependencies (i.e. those used via CreateObject).

Interestingly enough, this tool puts all information about the dependencies inside the application manifest. The application exe and its dependencies are described as a single assembly consisting of multiple files. I hadn\'t realized before that this was possible.

Looks like a very good tool but as of version 0.6.6 it has the following limitations:

• only for VB6 applications, starts from VB6 project file. Shame, because a lot of what it does really has nothing to do with VB6.
• wizard style application, not suitable to integrate in a build process. This is not a huge problem if your dependencies don\'t change a lot.
• freeware without source, risky to rely on it because it could become abandonware at any moment.

I did not test whether it supports .NET com libraries.

regsvr42 (codeproject link)

This command line tool generates manifest files for native COM libraries. It invokes DllRegisterServer and then spies on the self-registration as it adds information into the registry. It can also generate a client manifest for applications.

This utility does not support .NET COM libraries, since these don\'t expose a DllRegisterServer routine.

The utility is written in C++. The source code is available.

mt.exe

Part of the windows SDK (can be downloaded from MSDN), which you already have if you have visual studio installed. It is documented here. You can generate manifest files for native COM libraries with it like this:

mt.exe -tlb:mycomlib.ocx -dll:mycomlib.ocx -out:mycomlib.ocx.manifest

You can generate manifest files for .NET COM libraries with it like this:

mt.exe -managedassemblyname:netlib.dll -nodependency -out:netlib.dll.manifest

However, there are some problems with this tool:

• The first snippet will not generate progid attributes, breaking clients which use CreateObject with progids.
• The second snippet will generate <runtime> and <mvid> elements which need to be stripped out before the manifests actually work.
• Generation of client manifests for applications is not supported.

Maybe future SDK releases will improve this tool, I tested the one in the Windows SDK 6.0a (vista).

回答2:

With the MSBuild task GenerateApplicationManifest I generated a manifest at the command line identical to the manifest Visual Studio generates. I suspect Visual Studio uses the GenerateApplicationManifest during the build. Below is my build script which can be run from the command line using msbuild \"msbuild build.xml\"

Thanks to Dave Templin and his post that pointed me the the GenerateApplicationManifest task, and MSDN\'s further documentation of the task.

build.xml

<?xml version=\"1.0\" encoding=\"utf-8\"?>
<Project DefaultTargets=\"Build\" xmlns=\"http://schemas.microsoft.com/developer/msbuild/2003\">
    <Target Name=\"Build\">
        <ItemGroup>
            <File Include=\'MyNativeApp.exe\'/>
            <ComComponent Include=\'Com1.ocx;Com2.ocx\'/>
        </ItemGroup>
        <GenerateApplicationManifest
            AssemblyName=\"MyNativeApp.exe\"
            AssemblyVersion=\"1.0.0.0\"
            IsolatedComReferences=\"@(ComComponent)\"
            Platform=\"x86\"
            ManifestType=\"Native\">
            <Output
                ItemName=\"ApplicationManifest\"
                TaskParameter=\"OutputManifest\"/>
        </GenerateApplicationManifest>
    </Target>   
</Project>

回答3:

Make My Manifest (MMM) is a nice tool for doing this. It\'s also possible to write a script to process all your DLL/OCX files using mt.exe to generate a manifest for each one and then merge them all together. MMM is usually better/easier, because it also handles lots of special/weird cases.

回答4:

You can use Unattended Make My Manifest spin off to generate manifests directly in automated builds. It uses a script file to add depended COM components. This is an excerpt from the sample ini with the available commands:

# Unattended MMM script
#
# Command names are case-insensitive. Reference of supported commands:
#
# Command: Identity
#
#   Appends assemblyIdentity and description tags.
#
#   Parameters       <exe_file> [name] [description]
#      exe_file      file name can be quoted if containing spaces. The containing folder 
#                    of the executable sets base path for relative file names
#      name          (optional) assembly name. Defaults to MyAssembly
#      description   (optional) description of assembly
#
# Command: Dependency
#
#   Appends dependency tag for referencing dependent assemblies like Common Controls 6.0, 
#     VC run-time or MFC
#
#   Parameters       {<lib_name>|<assembly_file>} [version] [/update]
#     lib_name       one of { comctl, vc90crt, vc90mfc }
#     assembly_file  file name of .NET DLL exporting COM classes
#     version        (optional) required assembly version. Multiple version of vc90crt can
#                    be required by a single manifest
#     /update        (optional) updates assembly_file assembly manifest. Spawns mt.exe
#
# Command: File
#
#   Appends file tag and collects information about coclasses and interfaces exposed by 
#     the referenced COM component typelib.
#
#   Parameters       <file_name> [interfaces]
#     file_name      file containing typelib. Can be relative to base path
#     interfaces     (optional) pipe (|) separated interfaces with or w/o leading 
#                    underscore
#
# Command: Interface
#
#   Appends comInterfaceExternalProxyStub tag for inter-thread marshaling of interfaces
#
#   Parameters       <file_name> <interfaces>
#     file_name      file containing typelib. Can be relative to base path
#     interfaces     pipe (|) separated interfaces with or w/o leading underscore
#
# Command: TrustInfo
#
#   Appends trustInfo tag for UAC user-rights elevation on Vista and above
#
#   Parameters       [level] [uiaccess]
#     level          (optional) one of { 1, 2, 3 } corresponding to { asInvoker, 
#                    highestAvailable, requireAdministrator }. Default is 1
#     uiaccess       (optional) true/false or 0/1. Allows application to gain access to 
#                    the protected system UI. Default is 0
#
# Command: DpiAware
#
#   Appends dpiAware tag for custom DPI aware applications
#
#   Parameters       [on_off]
#     on_off         (optional) true/false or 0/1. Default is 0
#
# Command: SupportedOS
#
#   Appends supportedOS tag
#
#   Parameters       <os_type>
#     os_type        one of { vista, win7 }. Multiple OSes can be supported by a single 
#                    manifest
#

回答5:

To fill in the ProgIDs that mt.exe doesn\'t include, you can call ProgIDFromCLSID to look them up from the registry. This requires traditional COM registration prior to completing the manifest file, but subsequently, the manifest file will be self-sufficient.

This C# code adds the ProgIDs to all COM classes in a manifest:

var manifest = XDocument.Load(fileName);
var namespaceManager = new XmlNamespaceManager(new NameTable());
namespaceManager.AddNamespace(\"s\", \"urn:schemas-microsoft-com:asm.v1\");
foreach (var classElement in manifest.XPathSelectElements(\"s:assembly/s:file/s:comClass\", namespaceManager)) {
    var clsid = Guid.Parse(classElement.Attribute(\"clsid\").Value);
    int result = ProgIDFromCLSID(ref clsid, out string progId); if (result != S_OK) throw new COMException($\"ProgID lookup failed for {clsid}.\", result);
    classElement.SetAttributeValue(\"progid\", progId);
}
manifest.Save(fileName);

The code relies on these interop definitions:

[DllImport(\"ole32.dll\")] static extern int ProgIDFromCLSID([In] ref Guid clsid, [MarshalAs(UnmanagedType.LPWStr)] out string lplpszProgID);
const int S_OK = 0;