Include build number when renaming hotfix releases of Unity

[JensRestemeier]

Issue Checklist

• I'm using the latest u3d version
• I ran u3d --help
• I read the README
• I made sure that a similar issue doesn't exit

Issue Description

We sometimes have hotfix releases installed in parallel to official releases. They'll have the same version, but they'll have a different revision code. Renaming them to the plain version number will not be possible because of the conflict to the official release.

When I install them manually I usually use the Unity_<version>_<revision> pattern.

Suggestion:

• check the installed revision to the official revision
• if they match, use the usual Unity_<version> pattern
• if they don't match, use Unity_<version>_<revision>

The official revision seems to be used as part of the download url, i.e.:

u3d available
...
Version 5.4.1f1: https://download.unity3d.com/download_unity/**649f48bbbf0f**/
...

This revision is displayed in Unity in Help/About after pressing "Alt" on the keyboard.

At the start of the log file:

Built from '5.4/release' branch; Version is '5.4.1f1 (649f48bbbf0f) revision 6594376'; Using compiler version '160040219'

Unfortunately I haven't found a good way to find this without running Unity, yet. On OSX it is in the UnityBuildNumber plist key. On Windows there seems to be a special "Unity Version" resource in the exe:

BLOCK "StringFileInfo"
{
BLOCK "040904b0"
{
VALUE "CompanyName", "Unity Technologies ApS"
VALUE "FileDescription", "Unity Editor"
VALUE "FileVersion", "5.4.1.6594376"
VALUE "LegalCopyright", "(c) 2016 Unity Technologies ApS. All rights reserved."
VALUE "ProductName", "Unity"
VALUE "ProductVersion", "5.4.1.6594376"
VALUE "Unity Version", "5.4.1f1_649f48bbbf0f"
}
}

This can be seen in "Resource Hacker". I am not a Ruby hacker, so I have no idea if there is a package to open .exe version resources...

[JensRestemeier]

It would be useful if u3d looked for some kind of overrideVersion.txt file in a Unity installation, in case two copies of the same version are installed for other reasons. But that is less critical than the hotfix releases.

[lacostej]

Hello @JensRestemeier Thanks for the feedback. This sounds like a feature for u3d. We'll look into it.

[lacostej]

I googled a bit and here are some findings/links.

Here's the full native version of a function we could use https://www.conedogers.com/2012/08/06/retrieving-windows-vs_versioninfo-struct-from-a-binary/ to retrieve the Windows Exe information

Various ruby wrappers that implement part of this:

• https://stackoverflow.com/questions/2219486/ruby-win32api-structs-verqueryvalue
• https://stackoverflow.com/questions/76472/checking-version-of-file-in-ruby-on-windows
• https://www.thecodingforums.com/threads/win32api-and-getfileversioninfo.825267/

[lacostej]

This code works for me:

require "Win32API"

GetFileVersionInfoSize = Win32API.new('version.dll', 'GetFileVersionInfoSize','PP','L')
GetFileVersionInfo = Win32API.new('version.dll', 'GetFileVersionInfo','PIIP','I')
VerQueryValue = Win32API.new('version.dll', 'VerQueryValue','PPPP','I')
RtlMoveMemory = Win32API.new('kernel32.dll', 'RtlMoveMemory', 'PLL', 'I')

def string_file_info(info, path)
  begin
      file = path.gsub(/\//,"\\")

      buf = [0].pack('L')
      version_size = GetFileVersionInfoSize.call(file + "\0", buf)
      raise Exception.new    if version_size == 0 # TODO use GetLastError

      version_info = 0.chr * version_size
      version_ok = GetFileVersionInfo.call(file, 0, version_size, version_info)
      raise Exception.new if version_ok == 0 # TODO use GetLastError
  
      # hardcoding lang codepage
      struct_path = "\\StringFileInfo\\040904b0\\#{info}"
	  
      addr = [0].pack('L')
      size = [0].pack('L')
      query_ok = VerQueryValue.call(version_info, struct_path + "\0", addr, size)
      raise Exception.new if query_ok == 0

      raddr = addr.unpack('L')[0]
      rsize = size.unpack('L')[0]
	  
      info = Array.new(rsize,0).pack('L*')
      RtlMoveMemory.call(info, raddr, info.length)
      info.strip
  rescue Exception => e
      #puts e
      #puts e.backtrace
      "N/A"
  end
end

FILENAME = "C:/Program Files/Unity/Editor/Unity.exe"
infos = ["CompanyName","LegalCopyright","ProductVersion","FileDescription","LegalTrademarks","PrivateBuild","FileVersion","OriginalFilename","SpecialBuild", # predefined VerQueryValue string-names
  "Unity Version", "FileVersion", "ProductName"] # Unity specific?
infos.each { |info| r = string_file_info(info, FILENAME); puts "#{info}: #{r}" }

# gives
%Q(
CompanyName: Unity Technologies ApS
LegalCopyright: (c) 2018 Unity Technologies ApS. All rights reserved.
ProductVersion: 2017.4.1.9581049
FileDescription: Unity Editor
LegalTrademarks: N/A
PrivateBuild: N/A
FileVersion: 2017.4.1.9581049
OriginalFilename: N/A
SpecialBuild: N/A
Unity Version: 2017.4.1f1_9231f953d9d3
FileVersion: 2017.4.1.9581049
ProductName: Unity
)

[niezbop]

I just tested it locally, and it gave me the following:

CompanyName: Unity Technologies ApS
LegalCopyright: (c) 2017 Unity Technologies ApS. All rights reserved.
ProductVersion: 5.6.1.2646195
FileDescription: Unity Editor
LegalTrademarks: N/A
PrivateBuild: N/A
FileVersion: 5.6.1.2646195
OriginalFilename: N/A
SpecialBuild: N/A
Unity Version: 5.6.1f1_2860b30f0b54
FileVersion: 5.6.1.2646195
ProductName: Unity

[lacostej]

And I was looking at the release notes for 2017.2.2 and found reference to this:

https://issuetracker.unity3d.com/issues/windows-standalone-player-exe-has-no-product-version-slash-file-version-in-properties

So some version of Unity don't have version information... This is going to be fun.

[JensRestemeier]

That is the player executable, isn't it? That is the executable that is copied into the player folder to create a stand alone game, not the editor executable.
I kind-of hoped that inserting the build identifier into the version resources is part of their build process, not something that has to be remembered.

[JensRestemeier]

I think Linux is going to need a custom solution, as there is no standard way to embed resources into a binary. There is the option to add custom sections to an elf file through the linker, but I have not idea if Unity does that, or which section they use... If you have a Linux version of the editor around you could use objdump or readelf to look for any custom sections. Otherwise you'd have to grep for the string in the .rodata section.

[lacostej]

@JensRestemeier ah yes, it was the Player. Good.

For Linux we could go

$ strings /opt/unity-editor-2017.3.0f1/Editor/Unity | grep 2017.3.0f1
2017.3.0f1 (3c89f8d277f5)
2017.3.0f1_3c89f8d277f5
Invalid serialized file version. File: "%s". Expected version: 2017.3.0f1. Actual version: %s.
Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/37.0.2062.94 Safari/537.36 Unity/2017.3.0f1 (unity3d.com;
Unity 2017.3.0f1
UnityPlayer/2017.3.0f1 (UnityWebRequest/1.0, libcurl/7.51.0-DEV)

So this works

$ strings /opt/unity-editor-2017.3.0f1/Editor/Unity | ruby -ne 'print if /^[0-9\.fpb]+_[0-9a-f]{12}/'
2017.3.0f1_3c89f8d277f5

I could use readelf to make it more efficient.

[lacostej]

@JensRestemeier I've added (as a PR) the foundation for detecting the build number. It will part of next release, feel free to test it.

Then will remain to design the feature set for using this. I'll make a proposal later.

[lacostej]

I don't have a proposal. I have too many questions! To properly support this in all the features we need to look at the consequences / potential features:

• list
  -> display build number [DONE]
  -> idea: display extra information? (LTS, hotfix, etc)

• available
  -> idea: display extra information? (LTS, hotfix, etc). Would need to group them by channel sources, probably update unities.

• install
  -> idea: take a URL, can be used to install hotfix releases
  if given a URL, install it as version_buildnumber?
  question: what if someone gives a regular version to be installed using its URL?
  question: how could you deal with all those extra URLs. Should we support something like
  u3d available add [URL|build_number]?

• internals
  moving unities -> ouch! question: how do we know what to move to version vs version_build_number path?

• u3d run / install. ProjectSettings/ProjectVersion.txt doesn't contain the hotfix version
  question: how do you select/install the needed version?

[lacostej]

I added a section on build numbers: https://github.com/DragonBox/u3d#unity-build-numbers

We will release 1.0.20 now and think about the proper full support for hotfixes in the coming weeks. Please test 1.0.20 when it is out! Thanks

[JensRestemeier]

list:

• not sure where extra info can come from. Maybe parsing release notes from the website? Hotfixes come normally because of a specific issue, which are later (after further QA on all platforms etc.) go into an official patch release.

install:

• we got hotfix releases through a separate channel, so I don't think installation through u3d is easy or possible. The most important thing is not to get confused by multiple installed editors with the same version. Maybe when installing an official release it could be tagged as such, which means everything else is automatically a hotfix release.
  One option would be to allow installation from a local path or network share.

internals:

• I think for most people unity_version will work best, and unity_version_build is only useful if you actually need to install multiple copies of Unity.

u3d run/install: For me both a runtime argument and a separate manifest file in the project folder would work.