Bug#24732 Executables do not include Vista manifests

- Added script to generate application specific manifest.
- Added new CMake MACRO to add customer build events which will first
generate a manifest and then embeds that manifest into an executable.


BitKeeper/etc/ignore:
  Bug#24732 Executables do not include Vista manifests
  - Revise ignore rules to disallow auto-generated cmake files but to allow
  custom macros defined in a .cmake file.
CMakeLists.txt:
  Bug#24732 Executables do not include Vista manifests
  - Added logic for EMBED_MANIFESTS configuration option.
client/CMakeLists.txt:
  Bug#24732 Executables do not include Vista manifests
  - Embed manifest with custom CMake MACRO for client executables.
extra/CMakeLists.txt:
  Bug#24732 Executables do not include Vista manifests
  - Embed manifest with custom CMake MACRO for my_print_default executable.
libmysql/CMakeLists.txt:
  Bug#24732 Executables do not include Vista manifests
  - Embed manifest with custom CMake MACRO for myTest executable.
myisam/CMakeLists.txt:
  Bug#24732 Executables do not include Vista manifests
  - Embed manifest with custom CMake MACRO for myisam executables.
server-tools/instance-manager/CMakeLists.txt:
  Bug#24732 Executables do not include Vista manifests
  - Embed manifest with custom CMake MACRO for mysqlmanager executable.
sql/CMakeLists.txt:
  Bug#24732 Executables do not include Vista manifests
  - Embed manifest with custom CMake MACRO for mysqld executable.
win/README:
  Bug#24732 Executables do not include Vista manifests
  - Added new configuration option documentation.
win/configure.js:
  Bug#24732 Executables do not include Vista manifests
  - Added new EMBED_MANIFESTS configuration option.
win/create_manifest.js:
  Bug#24732 Executables do not include Vista manifests
  - Manifest generator.  This script generates a basic manifest.
win/mysql_manifest.cmake:
  Bug#24732 Executables do not include Vista manifests
  - Define new CMake MACRO for adding Windows manifests to executables.

.bzrignore

@@ -4,7 +4,8 @@
 *.bb
 *.bbg
 *.bin
-*.cmake
+*.vcproj.cmake
+cmake_install.cmake
 *.core
 *.d
 *.da

CMakeLists.txt

@@ -128,6 +128,33 @@ ENDIF(CMAKE_GENERATOR MATCHES "Visual Studio 7" OR
 
 ADD_DEFINITIONS("-D_WINDOWS -D__WIN__ -D _CRT_SECURE_NO_DEPRECATE")
 
+IF(EMBED_MANIFESTS)
+    # Search for the Manifest tool.  CMake will first search it's defaults
+    # (CMAKE_FRAMEWORK_PATH, CMAKE_APPBUNDLE_PATH, CMAKE_PROGRAM_PATH and
+    # the system PATH) followed by the listed paths which are the current
+    # possible defaults and should be updated when necessary.  The custom
+    # manifests are designed to be compatible with all mt versions.
+    FIND_PROGRAM(HAVE_MANIFEST_TOOL NAMES mt
+                 PATHS
+                 "$ENV{PROGRAMFILES}/Microsoft Visual Studio 8/VC/bin"
+                 "$ENV{PROGRAMFILES}/Microsoft Visual Studio 8/Common7/Tools/Bin"
+                 "$ENV{PROGRAMFILES}/Microsoft Visual Studio 8/SDK/v2.0/Bin")
+    IF(HAVE_MANIFEST_TOOL)
+        MESSAGE(STATUS "Found Mainfest Tool. Embedding custom manifests.")
+    ELSE(HAVE_MANIFEST_TOOL)
+        MESSAGE(FATAL_ERROR "Manifest tool, mt.exe, can't be found.")
+    ENDIF(HAVE_MANIFEST_TOOL)
+    # Disable automatic manifest generation.
+    STRING(REPLACE "/MANIFEST" "/MANIFEST:NO" CMAKE_EXE_LINKER_FLAGS 
+    	   ${CMAKE_EXE_LINKER_FLAGS})
+    # Set the processor architecture.
+    IF(CMAKE_GENERATOR MATCHES "Visual Studio 8 2005 Win64")
+    	SET(PROCESSOR_ARCH "X64") 
+    ELSE(CMAKE_GENERATOR MATCHES "Visual Studio 8 2005 Win64")
+    	SET(PROCESSOR_ARCH "X86")
+    ENDIF(CMAKE_GENERATOR MATCHES "Visual Studio 8 2005 Win64")
+ENDIF(EMBED_MANIFESTS)
+
 ADD_SUBDIRECTORY(vio)
 ADD_SUBDIRECTORY(dbug)
 ADD_SUBDIRECTORY(strings)

client/CMakeLists.txt

@@ -12,6 +12,7 @@
 # You should have received a copy of the GNU General Public License
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+INCLUDE("${PROJECT_SOURCE_DIR}/win/mysql_manifest.cmake")
 
 SET(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -DSAFEMALLOC -DSAFE_MUTEX")
 SET(CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG} -DSAFEMALLOC -DSAFE_MUTEX")
@@ -98,3 +99,16 @@ TARGET_LINK_LIBRARIES(mysqladmin mysqlclient mysys dbug yassl taocrypt zlib wsoc
 
 ADD_EXECUTABLE(echo echo.c)
 
+IF(EMBED_MANIFESTS)
+  MYSQL_EMBED_MANIFEST("mysql" "asInvoker")
+  MYSQL_EMBED_MANIFEST("mysqltest" "asInvoker")
+  MYSQL_EMBED_MANIFEST("mysqlcheck" "asInvoker")
+  MYSQL_EMBED_MANIFEST("mysqldump" "asInvoker")
+  MYSQL_EMBED_MANIFEST("mysqlimport" "asInvoker")
+  MYSQL_EMBED_MANIFEST("mysql_upgrade" "asInvoker")
+  MYSQL_EMBED_MANIFEST("mysqlshow" "asInvoker")
+  MYSQL_EMBED_MANIFEST("mysqlbinlog" "asInvoker")
+  MYSQL_EMBED_MANIFEST("mysqladmin" "asInvoker")
+  MYSQL_EMBED_MANIFEST("echo" "asInvoker")
+ENDIF(EMBED_MANIFESTS)
+

extra/CMakeLists.txt

@@ -12,6 +12,7 @@
 # You should have received a copy of the GNU General Public License
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+INCLUDE("${PROJECT_SOURCE_DIR}/win/mysql_manifest.cmake")
 
 SET(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -DSAFEMALLOC -DSAFE_MUTEX")
 SET(CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG} -DSAFEMALLOC -DSAFE_MUTEX")
@@ -45,3 +46,9 @@ TARGET_LINK_LIBRARIES(perror strings mysys dbug wsock32)
 
 ADD_EXECUTABLE(replace replace.c)
 TARGET_LINK_LIBRARIES(replace strings mysys dbug wsock32)
+
+IF(EMBED_MANIFESTS)
+  MYSQL_EMBED_MANIFEST("my_print_defaults" "asInvoker")
+  MYSQL_EMBED_MANIFEST("perror" "asInvoker")
+  MYSQL_EMBED_MANIFEST("replace" "asInvoker")
+ENDIF(EMBED_MANIFESTS)

libmysql/CMakeLists.txt

@@ -12,6 +12,7 @@
 # You should have received a copy of the GNU General Public License
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+INCLUDE("${PROJECT_SOURCE_DIR}/win/mysql_manifest.cmake")
 
 # Need to set USE_TLS, since __declspec(thread) approach to thread local
 # storage does not work properly in DLLs.
@@ -67,3 +68,7 @@ TARGET_LINK_LIBRARIES(libmysql mysys strings wsock32)
 
 ADD_EXECUTABLE(myTest mytest.c)
 TARGET_LINK_LIBRARIES(myTest libmysql)
+
+IF(EMBED_MANIFESTS)
+  MYSQL_EMBED_MANIFEST("myTest" "asInvoker")
+ENDIF(EMBED_MANIFESTS)

myisam/CMakeLists.txt

@@ -12,6 +12,7 @@
 # You should have received a copy of the GNU General Public License
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+INCLUDE("${PROJECT_SOURCE_DIR}/win/mysql_manifest.cmake")
 
 SET(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -DSAFEMALLOC -DSAFE_MUTEX")
 SET(CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG} -DSAFEMALLOC -DSAFE_MUTEX")
@@ -39,3 +40,10 @@ TARGET_LINK_LIBRARIES(myisamlog myisam mysys dbug strings zlib wsock32)
 
 ADD_EXECUTABLE(myisampack myisampack.c)
 TARGET_LINK_LIBRARIES(myisampack myisam mysys dbug strings zlib wsock32)
+
+IF(EMBED_MANIFESTS)
+  MYSQL_EMBED_MANIFEST("myisam_ftdump" "asInvoker")
+  MYSQL_EMBED_MANIFEST("myisamchk" "asInvoker")
+  MYSQL_EMBED_MANIFEST("myisamlog" "asInvoker")
+  MYSQL_EMBED_MANIFEST("myisampack" "asInvoker")
+ENDIF(EMBED_MANIFESTS)

server-tools/instance-manager/CMakeLists.txt

@@ -12,6 +12,7 @@
 # You should have received a copy of the GNU General Public License
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+INCLUDE("${PROJECT_SOURCE_DIR}/win/mysql_manifest.cmake")
 
 SET(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -DSAFEMALLOC -DSAFE_MUTEX")
 SET(CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG} -DSAFEMALLOC -DSAFE_MUTEX")
@@ -30,3 +31,7 @@ ADD_EXECUTABLE(mysqlmanager buffer.cc command.cc commands.cc guardian.cc instanc
 
 ADD_DEPENDENCIES(mysqlmanager GenError)
 TARGET_LINK_LIBRARIES(mysqlmanager dbug mysys strings taocrypt vio yassl zlib wsock32)
+
+IF(EMBED_MANIFESTS)
+  MYSQL_EMBED_MANIFEST("mysqlmanager" "asInvoker")
+ENDIF(EMBED_MANIFESTS)

sql/CMakeLists.txt

@@ -12,6 +12,7 @@
 # You should have received a copy of the GNU General Public License
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+INCLUDE("${PROJECT_SOURCE_DIR}/win/mysql_manifest.cmake")
 
 SET(CMAKE_CXX_FLAGS_DEBUG 
     "${CMAKE_CXX_FLAGS_DEBUG} -DSAFEMALLOC -DSAFE_MUTEX -DUSE_SYMDIR /Zi")
@@ -84,6 +85,10 @@ ADD_EXECUTABLE(mysqld ../sql-common/client.c derror.cc des_key_file.cc
 TARGET_LINK_LIBRARIES(mysqld heap myisam myisammrg mysys yassl zlib dbug yassl 
                       taocrypt strings vio regex wsock32)
 
+IF(EMBED_MANIFESTS)
+  MYSQL_EMBED_MANIFEST("mysqld" "requireAdministrator")
+ENDIF(EMBED_MANIFESTS)
+
 IF(WITH_EXAMPLE_STORAGE_ENGINE)
   TARGET_LINK_LIBRARIES(mysqld example)
 ENDIF(WITH_EXAMPLE_STORAGE_ENGINE)

win/README

@@ -50,6 +50,8 @@ The options right now are
     MYSQL_TCP_PORT=<port>                Server port, default 3306
     DISABLE_GRANT_OPTIONS                Disables the use of --init-file and --skip-grant-tables
                                          options of mysqld.exe
+    EMBED_MANIFESTS                      Embed custom manifests into final exes, otherwise VS
+                                         default will be used.
                                 
 
 So the command line could look like:

win/configure.js

@@ -47,6 +47,7 @@ try
             case "WITH_PARTITION_STORAGE_ENGINE":
             case "__NT__":
             case "DISABLE_GRANT_OPTIONS":
+            case "EMBED_MANIFESTS":
                     configfile.WriteLine("SET (" + args.Item(i) + " TRUE)");
                     break;
             case "MYSQL_SERVER_SUFFIX":

win/create_manifest.js

@@ -0,0 +1,85 @@
+/* 
+  manifest.js - Writes a custom XML manifest for each executable/library
+  6 command line options must be supplied: 
+  name      - Name of the executable/library into which the mainfest will be 
+              embedded.
+  version   - Version of the executable 
+  arch      - Architecture intended.
+  type      - Application type.
+  exe_level - Application execution level. 
+              [asInvoker|highestAvailable|requireAdministrator]
+  outfile   - Final destination where mainfest will be written.
+
+  Example:  
+  cscript manifest.js name=mysql version=5.0.32 arch=X86 type=win32 
+                      exe_level=asInvoker outfile=out.xml
+*/
+
+try 
+{
+  var args = WScript.Arguments
+  for (i=0; i < args.Count(); i++)
+  {
+    var parts = args.Item(i).split('=');
+    switch (parts[0])
+    {
+      case "name":
+           var app_name= parts[1];
+           break;
+      case "version":
+           var app_version= parts[1];
+           break;
+      case "arch":
+           var app_arch= parts[1];
+           break;
+      case "type":
+           var app_type= parts[1];
+           break;
+      case "exe_level":
+		   var app_exe_level= parts[1];
+           break;
+      case "outfile":
+		   var manifest_file= parts[1];
+           break;
+	  default:
+	       WScript.echo("Invalid argument supplied.");
+    }
+  }
+  if (i != 6)
+    throw new Error(1, "Incorrect number of arguments.");
+
+  var manifest_xml= "<?xml version=\'1.0\' encoding=\'UTF-8\' standalone=\'yes\'?>\r\n";
+  manifest_xml+= "<assembly xmlns=\'urn:schemas-microsoft-com:asm.v1\'";
+  manifest_xml+= " manifestVersion=\'1.0\'>\r\n";
+  // Application Information 
+  manifest_xml+= "\t<assemblyIdentity name=\'" + app_name + "\'";
+  manifest_xml+= " version=\'" + app_version + "\'"; 
+  manifest_xml+= " processorArchitecture=\'" + app_arch + "\'";
+  // TOADD - Add publicKeyToken attribute once we have Authenticode key.
+  manifest_xml+= " type=\'" + app_type + "\' />\r\n";
+  // Identify the application security requirements.
+  manifest_xml+= "\t<trustInfo xmlns=\'urn:schemas-microsoft-com:asm.v2\'>\r\n"; 
+  manifest_xml+= "\t\t<security>\r\n\t\t\t<requestedPrivileges>\r\n\t\t\t\t";
+  manifest_xml+= "<requestedExecutionLevel level=\'" + app_exe_level + "\'";
+  manifest_xml+= " uiAccess=\'false\'/>\r\n";
+  manifest_xml+= "\t\t\t</requestedPrivileges>\r\n\t\t</security>\r\n";
+  manifest_xml+= "\t</trustInfo>\r\n</assembly>\r\n";
+
+  // Write the valid XML to it's final destination.
+  var outfileXML = WScript.CreateObject("Msxml2.DOMDocument.3.0");
+  outfileXML.async = false;
+  if (!outfileXML.loadXML(manifest_xml))
+  {
+     WScript.Echo(manifest_xml);
+     throw new Error(2, "Invalid XML");
+  }
+  outfileXML.save(manifest_file);
+  
+  WScript.Echo("Success, created custom manifest!");
+  WScript.Quit(0);
+}
+catch (e)
+{
+    WScript.Echo("Error: " + e.description);
+	WScript.Quit(1);
+}

win/mysql_manifest.cmake

@@ -0,0 +1,20 @@
+
+# - MYSQL_EMBED_MANIFEST(target_name required_privs)
+# Create a manifest for target_name.  Set the execution level to require_privs
+#
+# NOTE. PROCESSOR_ARCH must be defined before this MACRO is called.
+
+MACRO(MYSQL_EMBED_MANIFEST _target_name _required_privs)
+  ADD_CUSTOM_COMMAND(
+    TARGET ${_target_name}
+    PRE_LINK
+    COMMAND cscript.exe 
+    ARGS "${PROJECT_SOURCE_DIR}/win/create_manifest.js" name=$(ProjectName) version=${VERSION} arch=${PROCESSOR_ARCH} type=$(PlatformName) exe_level=${_required_privs} outfile=$(IntDir)\\$(TargetFileName).intermediate.manifest
+    COMMENT "Generates the contents of the manifest contents.")
+  ADD_CUSTOM_COMMAND(
+    TARGET ${_target_name}
+    POST_BUILD
+    COMMAND mt.exe 
+    ARGS -nologo -manifest $(IntDir)\\$(TargetFileName).intermediate.manifest -outputresource:$(TargetPath) 
+    COMMENT "Embeds the manifest contents.")
+ENDMACRO(MYSQL_EMBED_MANIFEST)