[Xamarin.Android.Tools.AndroidSdk] Probe for Microsoft OpenJDK dirs (#113)

Context: https://aka.ms/getopenjdk
Context: https://devblogs.microsoft.com/java
Remove support for the obsolete (and never updated)
`microsoft_dist_openjdk_*` builds of OpenJDK. Despite having
"microsoft" in the name, it was maintained by a different team which
has moved on to other things.

Author: jonpryor

src/Xamarin.Android.Tools.AndroidSdk/AndroidSdkInfo.cs

@@ -185,7 +185,7 @@ public static void DetectAndSetPreferredJavaSdkPathToLatest (Action<TraceLevel,
 
 logger=logger??DefaultConsoleLogger;
 
-varlatestJdk=JdkInfo.GetMacOSMicrosoftJdks(logger).FirstOrDefault();
+varlatestJdk=JdkInfo.GetMicrosoftOpenJdks(logger).FirstOrDefault();
 if(latestJdk==null)
 thrownewNotSupportedException("No Microsoft OpenJDK could be found. Please re-run the Visual Studio installer or manually specify the JDK path in settings.");
 

src/Xamarin.Android.Tools.AndroidSdk/JdkInfo.cs

@@ -287,7 +287,7 @@ public static IEnumerable<JdkInfo> GetKnownSystemJdkInfos (Action<TraceLevel, st
 returnGetEnvironmentVariableJdks("JI_JAVA_HOME",logger)
 .Concat(GetWindowsJdks(logger))
 .Concat(GetConfiguredJdks(logger))
-.Concat(GetMacOSMicrosoftJdks(logger))
+.Concat(GetMacOSMicrosoftOpenJdks(logger))
 .Concat(GetEnvironmentVariableJdks("JAVA_HOME",logger))
 .Concat(GetPathEnvironmentJdks(logger))
 .Concat(GetLibexecJdks(logger))
@@ -313,27 +313,47 @@ static IEnumerable<string> GetConfiguredJdkPaths (Action<TraceLevel, string> log
 }
 }
 
-internalstaticIEnumerable<JdkInfo>GetMacOSMicrosoftJdks(Action<TraceLevel,string>logger)
+internalstaticIEnumerable<JdkInfo>GetMicrosoftOpenJdks(Action<TraceLevel,string>logger)
 {
-returnGetMacOSMicrosoftJdkPaths()
-.Select(p =>TryGetJdkInfo(p,logger,"$HOME/Library/Developer/Xamarin/jdk"))
+foreach(vardirinGetMacOSMicrosoftOpenJdks(logger))
+yieldreturndir;
+if(Path.DirectorySeparatorChar!='\\')
+yieldbreak;
+foreach(vardirinAndroidSdkWindows.GetJdkInfos(logger)){
+yieldreturndir;
+}
+}
+
+staticIEnumerable<JdkInfo>GetMacOSMicrosoftOpenJdks(Action<TraceLevel,string>logger)
+{
+returnGetMacOSMicrosoftOpenJdkPaths()
+.Select(p =>TryGetJdkInfo(p,logger,"/Library/Java/JavaVirtualMachines/microsoft-*.jdk"))
 .Where(jdk =>jdk!=null)
 .Select(jdk =>jdk!)
 .OrderByDescending(jdk =>jdk,JdkInfoVersionComparer.Default);
 }
 
-staticIEnumerable<string>GetMacOSMicrosoftJdkPaths()
+staticIEnumerable<string>GetMacOSMicrosoftOpenJdkPaths()
 {
+varroot="/Library/Java/JavaVirtualMachines";
+varpattern="microsoft-*.jdk";
+vartoHome=Path.Combine("Contents","Home");
 varjdks=AppDomain.CurrentDomain.GetData($"GetMacOSMicrosoftJdkPaths jdks override! {typeof(JdkInfo).AssemblyQualifiedName}")
 ?.ToString();
-if(jdks==null){
-varhome=Environment.GetFolderPath(Environment.SpecialFolder.Personal);
-jdks=Path.Combine(home,"Library","Developer","Xamarin","jdk");
+if(jdks!=null){
+root=jdks;
+toHome="";
+pattern="*";
+}
+if(!Directory.Exists(root)){
+yieldbreak;
+}
+foreach(vardirinDirectory.EnumerateDirectories(root,pattern)){
+varhome=Path.Combine(dir,toHome);
+if(!Directory.Exists(home))
+continue;
+yieldreturnhome;
 }
-if(!Directory.Exists(jdks))
-returnEnumerable.Empty<string>();
-
-returnDirectory.EnumerateDirectories(jdks);
 }
 
 staticJdkInfo?TryGetJdkInfo(stringpath,Action<TraceLevel,string>logger,stringlocator)

src/Xamarin.Android.Tools.AndroidSdk/OS.cs

@@ -1,4 +1,5 @@
 usingSystem;
+usingSystem.Collections.Generic;
 usingSystem.Runtime.InteropServices;
 usingSystem.IO;
 usingSystem.Text;
@@ -139,9 +140,89 @@ static extern int RegSetValueExW (UIntPtr hKey, string lpValueName, int lpReserv
 staticexternintRegCreateKeyEx(UIntPtrhKey,stringsubKey,uintreserved,string?@class,uintoptions,
 uintsamDesired,IntPtrlpSecurityAttributes,outUIntPtrphkResult,outDispositionlpdwDisposition);
 
+// https://docs.microsoft.com/en-us/windows/win32/api/winreg/nf-winreg-regenumkeyexw
+[DllImport(ADVAPI,CharSet=CharSet.Unicode,SetLastError=true)]
+staticexternintRegEnumKeyExW(
+UIntPtrhKey,
+uintdwIndex,
+[Out]char[]lpName,
+refuintlpcchName,
+IntPtrlpReserved,
+IntPtrlpClass,
+IntPtrlpcchClass,
+IntPtrlpftLastWriteTime
+);
+
+// https://docs.microsoft.com/en-us/windows/win32/api/winreg/nf-winreg-regqueryinfokeyw
+[DllImport(ADVAPI,CharSet=CharSet.Unicode,SetLastError=true)]
+staticexternintRegQueryInfoKey(
+UIntPtrhKey,
+IntPtrlpClass,
+IntPtrlpcchClass,
+IntPtrlpReserved,
+outuintlpcSubkey,
+outuintlpcchMaxSubkeyLen,
+IntPtrlpcchMaxClassLen,
+IntPtrlpcValues,
+IntPtrlpcchMaxValueNameLen,
+IntPtrlpcbMaxValueLen,
+IntPtrlpSecurityDescriptor,
+IntPtrlpftLastWriteTime
+);
+
 [DllImport("advapi32.dll",SetLastError=true)]
 staticexternintRegCloseKey(UIntPtrhKey);
 
+publicstaticIEnumerable<string>EnumerateSubkeys(UIntPtrkey,stringsubkey,Wow64wow64)
+{
+UIntPtrregKeyHandle;
+uintsam=(uint)Rights.Read+(uint)wow64;
+intr=RegOpenKeyEx(key,subkey,0,sam,outregKeyHandle);
+if(r!=0){
+yieldbreak;
+}
+try{
+r=RegQueryInfoKey(
+hKey:regKeyHandle,
+lpClass:IntPtr.Zero,
+lpcchClass:IntPtr.Zero,
+lpReserved:IntPtr.Zero,
+lpcSubkey:outuintcSubkeys,
+lpcchMaxSubkeyLen:outuintcchMaxSubkeyLen,
+lpcchMaxClassLen:IntPtr.Zero,
+lpcValues:IntPtr.Zero,
+lpcchMaxValueNameLen:IntPtr.Zero,
+lpcbMaxValueLen:IntPtr.Zero,
+lpSecurityDescriptor:IntPtr.Zero,
+lpftLastWriteTime:IntPtr.Zero
+);
+if(r!=0){
+yieldbreak;
+}
+varname=newchar[cchMaxSubkeyLen+1];
+for(uinti=0;i<cSubkeys;++i){
+varnameLen=(uint)name.Length;
+r=RegEnumKeyExW(
+hKey:regKeyHandle,
+dwIndex:i,
+lpName:name,
+lpcchName:refnameLen,
+lpReserved:IntPtr.Zero,
+lpClass:IntPtr.Zero,
+lpcchClass:IntPtr.Zero,
+lpftLastWriteTime:IntPtr.Zero
+);
+if(r!=0){
+continue;
+}
+yieldreturnnewstring(name,0,(int)nameLen);
+}
+}
+finally{
+RegCloseKey(regKeyHandle);
+}
+}
+
 publicstaticstring?GetValueString(UIntPtrkey,stringsubkey,stringvalueName,Wow64wow64)
 {
 UIntPtrregKeyHandle;
@@ -192,6 +273,9 @@ enum Rights : uint
 SetValue=0x0002,
 CreateSubKey=0x0004,
 EnumerateSubKey=0x0008,
+Notify=0x0010,
+Read=_StandardRead|QueryValue|EnumerateSubKey|Notify,
+_StandardRead=0x20000,
 }
 
 enumOptions

src/Xamarin.Android.Tools.AndroidSdk/Properties/AssemblyInfo.cs

@@ -0,0 +1,10 @@
+usingSystem.Runtime.CompilerServices;
+
+[assembly:InternalsVisibleTo(
+"Xamarin.Android.Tools.AndroidSdk-Tests, PublicKey="+
+"0024000004800000940000000602000000240000525341310004000011000000438ac2a5acfbf1"+
+"6cbd2b2b47a62762f273df9cb2795ceccdf77d10bf508e69e7a362ea7a45455bbf3ac955e1f2e2"+
+"814f144e5d817efc4c6502cc012df310783348304e3ae38573c6d658c234025821fda87a0be8a0"+
+"d504df564e2c93b2b878925f42503e9d54dfef9f9586d9e6f38a305769587b1de01f6c0410328b"+
+"2c9733db"
+)]

src/Xamarin.Android.Tools.AndroidSdk/Sdks/AndroidSdkWindows.cs

@@ -18,6 +18,7 @@ class AndroidSdkWindows : AndroidSdkBase
 conststringANDROID_INSTALLER_KEY="Path";
 conststringXAMARIN_ANDROID_INSTALLER_PATH=@"SOFTWARE\Xamarin\MonoAndroid";
 conststringXAMARIN_ANDROID_INSTALLER_KEY="PrivateAndroidSdkPath";
+conststringMICROSOFT_OPENJDK_PATH=@"SOFTWARE\Microsoft\JDK";
 
 publicAndroidSdkWindows(Action<TraceLevel,string>logger)
 :base(logger)
@@ -131,8 +132,9 @@ IEnumerable<JdkInfo> ToJdkInfos (IEnumerable<string> paths, string locator)
 }
 
 returnToJdkInfos(GetPreferredJdkPaths(),"Preferred Registry")
-.Concat(ToJdkInfos(GetOpenJdkPaths(),"OpenJDK"))
-.Concat(ToJdkInfos(GetKnownOpenJdkPaths(),"Well-known OpenJDK paths"))
+.Concat(ToJdkInfos(GetMicrosoftOpenJdkFilesystemPaths(),"Microsoft OpenJDK Filesystem"))
+.Concat(ToJdkInfos(GetMicrosoftOpenJdkRegistryPaths(),"Microsoft OpenJDK Registry"))
+.Concat(ToJdkInfos(GetVSAndroidJdkPaths(),@"HKLM\SOFTWARE\Microsoft\VisualStudio\Android@JavaHome"))
 .Concat(ToJdkInfos(GetOracleJdkPaths(),"Oracle JDK"))
 ;
 }
@@ -150,7 +152,7 @@ private static IEnumerable<string> GetPreferredJdkPaths ()
 }
 }
 
-privatestaticIEnumerable<string>GetOpenJdkPaths()
+privatestaticIEnumerable<string>GetVSAndroidJdkPaths()
 {
 varroot=RegistryEx.LocalMachine;
 varwows=new[]{RegistryEx.Wow64.Key32,RegistryEx.Wow64.Key64};
@@ -163,28 +165,24 @@ private static IEnumerable<string> GetOpenJdkPaths ()
 }
 }
 
-/// <summary>
-/// Locate OpenJDK installations by well known path.
-/// </summary>
-/// <returns>List of valid OpenJDK paths in version descending order.</returns>
-privatestaticIEnumerable<string>GetKnownOpenJdkPaths()
+staticIEnumerable<string>GetMicrosoftOpenJdkFilesystemPaths()
 {
-stringJdkFolderNamePattern="microsoft_dist_openjdk_";
+conststringJdkFolderNamePrefix="jdk-";
 
 varpaths=newList<Tuple<string,Version>>();
 varrootPaths=newList<string>{
-Path.Combine(Environment.ExpandEnvironmentVariables("%ProgramW6432%"),"Android","jdk"),
+Path.Combine(Environment.ExpandEnvironmentVariables("%ProgramW6432%"),"Microsoft"),
 Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.ProgramFilesX86),"Android","jdk"),
 };
 
 foreach(varrootPathinrootPaths){
-if(Directory.Exists(rootPath)){
-foreach(vardirectoryNameinDirectory.EnumerateDirectories(rootPath,$"{JdkFolderNamePattern}*").ToList()){
-varversionString=directoryName.Replace($"{rootPath}\\{JdkFolderNamePattern}",string.Empty);
-if(Version.TryParse(versionString,outVersion?ver)){
-paths.Add(newTuple<string,Version>(directoryName,ver));
-}
-}
+if(!Directory.Exists(rootPath))
+continue;
+foreach(vardirectoryNameinDirectory.EnumerateDirectories(rootPath,$"{JdkFolderNamePrefix}*")){
+varversion=ExtractVersion(directoryName,JdkFolderNamePrefix);
+if(version==null)
+continue;
+paths.Add(Tuple.Create(directoryName,version));
 }
 }
 
@@ -193,6 +191,59 @@ private static IEnumerable<string> GetKnownOpenJdkPaths ()
 .Select(openJdk =>openJdk.Item1);
 }
 
+staticIEnumerable<string>GetMicrosoftOpenJdkRegistryPaths()
+{
+varpaths=newList<(Versionversion,stringpath)>();
+varroots=new[]{RegistryEx.CurrentUser,RegistryEx.LocalMachine};
+varwows=new[]{RegistryEx.Wow64.Key32,RegistryEx.Wow64.Key64};
+foreach(varrootinroots)
+foreach(varwowinwows){
+foreach(varsubkeyNameinRegistryEx.EnumerateSubkeys(root,MICROSOFT_OPENJDK_PATH,wow)){
+if(!Version.TryParse(subkeyName,outvarversion))
+continue;
+varmsiKey=$@"{MICROSOFT_OPENJDK_PATH}\{subkeyName}\hotspot\MSI";
+varpath=RegistryEx.GetValueString(root,msiKey,"Path",wow);
+if(path==null)
+continue;
+paths.Add((version,path));
+}
+}
+
+returnpaths.OrderByDescending(e =>e.version)
+.Select(e =>e.path);
+}
+
+internalstaticVersion?ExtractVersion(stringpath,stringprefix)
+{
+varname=Path.GetFileName(path);
+if(name.Length<=prefix.Length)
+returnnull;
+if(!name.StartsWith(prefix,StringComparison.OrdinalIgnoreCase))
+returnnull;
+
+varstart=prefix.Length;
+while(start<name.Length&&!char.IsDigit(name,start)){
+++start;
+}
+if(start==name.Length)
+returnnull;
+
+name=name.Substring(start);
+intend=0;
+while(end<name.Length&&
+(char.IsDigit(name[end])||name[end]=='.')){
+end++;
+}
+
+do{
+if(Version.TryParse(name.Substring(0,end),outvarv))
+returnv;
+end=name.LastIndexOf('.',end-1);
+}while(end>0);
+
+returnnull;
+}
+
 privatestaticIEnumerable<string>GetOracleJdkPaths()
 {
 stringsubkey=@"SOFTWARE\JavaSoft\Java Development Kit";

tests/Xamarin.Android.Tools.AndroidSdk-Tests/AndroidSdkWindowsTests.cs

@@ -0,0 +1,68 @@
+usingSystem;
+usingSystem.Collections.Generic;
+usingSystem.Diagnostics;
+usingSystem.IO;
+usingSystem.Linq;
+usingSystem.Text;
+usingSystem.Xml.Linq;
+
+usingNUnit.Framework;
+
+namespaceXamarin.Android.Tools.Tests
+{
+[TestFixture]
+publicclassAndroidSdkWindowsTests
+{
+[Test]
+publicvoidExtractVersion()
+{
+varsep=Path.DirectorySeparatorChar;
+
+vartests=new[]{
+new{
+Path=$"foo{sep}",
+Prefix="",
+Expected=(Version)null,
+},
+new{
+Path=$"foo{sep}bar-1-extra",
+Prefix="bar-",
+Expected=(Version)null,
+},
+new{
+Path=$"foo{sep}abcdef",
+Prefix="a",
+Expected=(Version)null,
+},
+new{
+Path=$"foo{sep}a{sep}b.c.d",
+Prefix="none-of-the-above",
+Expected=(Version)null,
+},
+new{
+Path=$"jdks{sep}jdk-1.2.3-hotspot-extra",
+Prefix="jdk-",
+Expected=newVersion(1,2,3),
+},
+new{
+Path=$"jdks{sep}jdk-1.2.3-hotspot-extra",
+Prefix="jdk",
+Expected=newVersion(1,2,3),
+},
+new{
+Path=$"jdks{sep}jdk-1.2.3.4.5.6-extra",
+Prefix="jdk-",
+Expected=newVersion(1,2,3,4),
+},
+};
+
+foreach(vartestintests){
+Assert.AreEqual(
+test.Expected,
+AndroidSdkWindows.ExtractVersion(test.Path,test.Prefix),
+$"Version couldn't be extracted from Path=`{test.Path}` Prefix=`{test.Prefix}`!"
+);
+}
+}
+}
+}

tests/Xamarin.Android.Tools.AndroidSdk-Tests/Xamarin.Android.Tools.AndroidSdk-Tests.csproj

@@ -5,6 +5,8 @@
  If $(TargetFramework) is declared here instead, it will not be evaluated before Directory.Build.props
  is loaded and the wrong $(TestOutputFullPath) will be used. -->
  <TargetFrameworks>netcoreapp3.1</TargetFrameworks>
+ <SignAssembly>true</SignAssembly>
+ <AssemblyOriginatorKeyFile>..\..\product.snk</AssemblyOriginatorKeyFile>
  <IsPackable>false</IsPackable>
  <OutputPath>$(TestOutputFullPath)</OutputPath>
  <AppendTargetFrameworkToOutputPath>false</AppendTargetFrameworkToOutputPath>