Changeset 103028 in vbox for trunk/src/VBox/Installer/win

Timestamp:

Jan 24, 2024 3:53:59 PM (10 months ago)

Author:

vboxsync

Message:

Main/Python: Big revamp to modernize our vboxapi Python package to now use a so-called src-layout, which also can be used with pip directly. Also added compatibility w/ Python 3.12 where distutils are not shipped anymore. We also now do have automatic linting for our code, which hopefully should improve quality in this area. Moved some Python-related files into an own sub folder so that it's more clear to which these belong to. The "sdk/installer" directories also have an own "python" sub directory where the stuff resides now. The Windows installer also uses "sdk/installer" instead of "sdk/install", to match the other platforms. bugref:10579

Location:

trunk/src/VBox/Installer/win

Files:

• InstallHelper/VBoxInstallHelper.cpp (modified) (2 diffs)
• VBoxMergePython.wxi (modified) (2 diffs)
• VirtualBox.wxs (modified) (1 diff)

trunk/src/VBox/Installer/win/InstallHelper/VBoxInstallHelper.cpp

@@ -608 +608 @@
      */
     /* Get the VBox API setup string. */
-    WCHAR wszVBoxSDKPath[RTPATH_MAX];
-    rcWin = VBoxGetMsiProp(hModule, L"CustomActionData", wszVBoxSDKPath, RT_ELEMENTS(wszVBoxSDKPath));
+    WCHAR wszVBoxPythonInstallerPath[RTPATH_MAX];
+    rcWin = VBoxGetMsiProp(hModule, L"CustomActionData", wszVBoxPythonInstallerPath, RT_ELEMENTS(wszVBoxPythonInstallerPath));
     if (rcWin == ERROR_SUCCESS)
     {
         /* Make sure our current working directory is the VBox installation path. */
-        if (SetCurrentDirectoryW(wszVBoxSDKPath))
+        if (SetCurrentDirectoryW(wszVBoxPythonInstallerPath))
         {
             /* Set required environment variables. */
-            if (SetEnvironmentVariableW(L"VBOX_INSTALL_PATH", wszVBoxSDKPath))
-            {
-                logStringF(hModule, "InstallPythonAPI: Invoking vboxapisetup.py in \"%ls\" ...", wszVBoxSDKPath);
+            if (SetEnvironmentVariableW(L"VBOX_INSTALL_PATH", wszVBoxPythonInstallerPath)) /** @todo BUGBUG r=andy That can't be right! */
+            {
+                logStringF(hModule, "InstallPythonAPI: Invoking vboxapisetup.py in \"%ls\" ...", wszVBoxPythonInstallerPath);
 
                 rcWin = procRun(hModule, wszPythonExe, L"vboxapisetup.py install");
@@ -650 +650 @@
         else
             logStringF(hModule, "InstallPythonAPI: Could set working directory to \"%ls\": LastError=%u",
-                       wszVBoxSDKPath, GetLastError());
+                       wszVBoxPythonInstallerPath, GetLastError());
     }
     else

trunk/src/VBox/Installer/win/VBoxMergePython.wxi

@@ -33 +33 @@
     <Component Id="cp_VBoxPyInst" Guid="C9A40306-5102-11DE-A7BA-C3C555D89593" Win64="$(var.Property_Win64)">
          <File Id="file_vboxapisetup.py" Name="vboxapisetup.py"
-               Source="$(env.PATH_OUT)\bin\sdk\installer\vboxapisetup.py"
+               Source="$(env.PATH_OUT)\bin\sdk\installer\python\vboxapisetup.py"
                DiskId="$(var.Property_DiskIdCommon)" />
     </Component>
@@ -39 +39 @@
         <Component Id="cp_VBoxPyMod" Guid="DF19CB76-5102-11DE-943B-13C755D89593" Win64="$(var.Property_Win64)">
             <File Id="file___init__.py" Name="__init__.py"
-                  Source="$(env.PATH_OUT)\bin\sdk\installer\vboxapi\__init__.py"
+                  Source="$(env.PATH_OUT)\bin\sdk\installer\python\vboxapi\__init__.py"
                   DiskId="$(var.Property_DiskIdCommon)" />
             <File Id="file_VirtualBox_constants.py" Name="VirtualBox_constants.py"
-                  Source="$(env.PATH_OUT)\bin\sdk\installer\vboxapi\VirtualBox_constants.py"
+                  Source="$(env.PATH_OUT)\bin\sdk\installer\python\vboxapi\VirtualBox_constants.py"
                   DiskId="$(var.Property_DiskIdCommon)" />
         </Component>

trunk/src/VBox/Installer/win/VirtualBox.wxs

@@ -384 +384 @@
                 <Directory Id="dir_SDK" Name="sdk">
 <?if $(env.VBOX_WITH_PYTHON) = "yes" ?>
-                    <Directory Id="dir_SDKInstall" Name="install">
-    <?if $(env.VBOX_WITH_MSM_INSTALL) = "yes" ?>
-                        <Merge Id="msm_VBoxPython" Language="!(loc.LANG)" SourceFile="$(var.Property_VBoxMergePython)" DiskId="1" />
-    <?else ?>
-                        <Directory Id="msm_VBoxPythonFolder" FileSource=".">
-                            <?include VBoxMergePython.wxi ?>
+                    <Directory Id="dir_SDKInstaller" Name="installer"> <!-- Note: For < VBox 7.1 this folder was called 'install'. -->
+                        <Directory Id="dir_SDKInstallerPython" Name="python">
+        <?if $(env.VBOX_WITH_MSM_INSTALL) = "yes" ?>
+                            <Merge Id="msm_VBoxPython" Language="!(loc.LANG)" SourceFile="$(var.Property_VBoxMergePython)" DiskId="1" />
+        <?else ?>
+                            <Directory Id="msm_VBoxPythonFolder" FileSource=".">
+                                <?include VBoxMergePython.wxi ?>
+                            </Directory>
+        <?endif ?>
                         </Directory>
-    <?endif ?>
                     </Directory>
 <?endif ?>