Add Logos 30+ Support

[thw26]

This PR fixes #22.

It adds an installer step that downloads a .tar.gz from GitHub and then untars it into place.

We need to come up with an appropriate installer check to be able to skip this step if possible.

---

BLOCKED

• Fix #121, #124. Prep for #118. #122

TODO

• Modify minimum required Wine version for Logos 30+ to 9.10. See Fix #121, #124. Prep for #118. #122.
• Modify required AppImage to 9.12. See Fix #121, #124. Prep for #118. #122.
• Add code that errors if the user tries to run Logos 30+ without having an up-to-date Wine, for cases of installs updated to Logos 30+ but using Wine<9. This may be a corner case? See Fix #121, #124. Prep for #118. #122, b558528.
• Installer check to ensure ICU in place
• Optarg to install/update ICU
• TUI option to install/update ICU
• GUI option to install/update ICU
• TUI python logging basicConfig is ignored in msg.initialize_curses_logging #135
• TUI Dialog Importing Never Uses Python Dialog #136; fixes TUI Dialog Importing Never Uses Python Dialog #136
• log file isn't written to if dialog isn't installed (curses, tk)
• desktop launcher file isn't created (curses)
• curses menu doesn't recognize installed app
• Config File is Not Properly Read or Updated #123
• Make sure config paths are relative so that the install is self-contained and can be moved freely; that is, make sure the config doesn't break if someone moves their install from their initial install dir. cf. Add an Option for Moving the Install #13.
• Make Selected AppImage Executable #113
• Exit doesn't work on main menu of TUI after running Logos due to how the run state is handled.
  • A waiting screen is probably necessary so that while Logos is running no actions can be issued and we can create a new menu screen when Logos is exited. We may need to track our main Logos PID to know if the program is running or not, so that we also don't trigger issues with CLI commands.
• tk "Run action" button isn't activated when choosing to update/install ICU files
• tk "Run action" button doesn't work for update/install ICU files
• GUI: install & window freeze during "verifying appimage" step.

[Freilichtbuehne]

I tested with this branch (installed for the first time) and it works without any problems.

[thw26]

Given @Freilichtbuehne's testing, I have marked this as ready for review.

[n8marti]

Testing with GUI I get this error:

Traceback (most recent call last):
  File "/opt/lib/python3.12/threading.py", line 1073, in _bootstrap_inner
    self.run()
  File "/opt/lib/python3.12/threading.py", line 1010, in run
    self._target(*self._args, **self._kwargs)
  File "/home/nate/g/LogosLinuxInstaller/installer.py", line 644, in ensure_launcher_shortcuts
    ensure_launcher_executable(app=app)
  File "/home/nate/g/LogosLinuxInstaller/installer.py", line 622, in ensure_launcher_executable
    ensure_config_file(app=app)
  File "/home/nate/g/LogosLinuxInstaller/installer.py", line 584, in ensure_config_file
    ensure_product_installed(app=app)
  File "/home/nate/g/LogosLinuxInstaller/installer.py", line 566, in ensure_product_installed
    ensure_winetricks_applied(app=app)
  File "/home/nate/g/LogosLinuxInstaller/installer.py", line 513, in ensure_winetricks_applied
    ensure_icu_data_files(app=app)
  File "/home/nate/g/LogosLinuxInstaller/installer.py", line 507, in ensure_icu_data_files
    wine.installICUDataFiles()
  File "/home/nate/g/LogosLinuxInstaller/wine.py", line 285, in installICUDataFiles
    icu_filename = os.path.basename(logoslinuxinstaller_url)  # noqa: #501
                                    ^^^^^^^^^^^^^^^^^^^^^^^
NameError: name 'logoslinuxinstaller_url' is not defined

[andyhunne]

I just tested with the latest commit. It passes the logoslinuxinstaller_url error, then stops here:

Copying: icu.tar.gz into: /home/andy/downloads Traceback (most recent call last): File "/home/andy/code/LogosLinuxInstaller/./LogosLinuxInstaller.py", line 358, in <module> main() File "/home/andy/code/LogosLinuxInstaller/./LogosLinuxInstaller.py", line 347, in main config.ACTION() File "/home/andy/code/LogosLinuxInstaller/./LogosLinuxInstaller.py", line 259, in run_control_panel tui_app.control_panel_app() File "/home/andy/code/LogosLinuxInstaller/tui_app.py", line 106, in control_panel_app installer.ensure_launcher_shortcuts() File "/home/andy/code/LogosLinuxInstaller/installer.py", line 644, in ensure_launcher_shortcuts ensure_launcher_executable(app=app) File "/home/andy/code/LogosLinuxInstaller/installer.py", line 622, in ensure_launcher_executable ensure_config_file(app=app) File "/home/andy/code/LogosLinuxInstaller/installer.py", line 584, in ensure_config_file ensure_product_installed(app=app) File "/home/andy/code/LogosLinuxInstaller/installer.py", line 566, in ensure_product_installed ensure_winetricks_applied(app=app) File "/home/andy/code/LogosLinuxInstaller/installer.py", line 513, in ensure_winetricks_applied ensure_icu_data_files(app=app) File "/home/andy/code/LogosLinuxInstaller/installer.py", line 507, in ensure_icu_data_files wine.installICUDataFiles() File "/home/andy/code/LogosLinuxInstaller/wine.py", line 287, in installICUDataFiles utils.untar_file(f"{config.MYDOWNLOADS}/icu.tar.gz", f"{config.APPDIR}/wine64_bottle/drive_c") ^^^^^^^^^^^^^ AttributeError: module 'config' has no attribute 'APPDIR'

[n8marti]

I'm currently working through another issue: in the GUI I choose v34.x, and it downloads it correctly, but then it still copies v29.x into the INSTALLDIR. This might be from my config file, but choosing a different version in the installer should override what the config file says.

[n8marti]

I also have a minor issue where downloading the ICU files doesn't change the progress bar to show download progress, nor file verification progress. I think in the longer term I should probably rethink how the GUI handles these things, because a big part of the progress bar handling is more or less hard-coded and not too flexible.

[n8marti]

I'm currently working through another issue: in the GUI I choose v34.x, and it downloads it correctly, but then it still copies v29.x into the INSTALLDIR. This might be from my config file, but choosing a different version in the installer should override what the config file says.

Removing the config file does fix this problem. But then I get an error when the MSI starts:

2024-07-02 10:00:48 ERROR: Error running '/home/nate/LogosBible10/data/bin/wine-devel_8.19-x86_64.AppImage msiexec /i /home/nate/LogosBible10/data/Logos_v34.1.0.0009-x64.msi': 67

Up till now I've been using wine-devel 8.19 appimage. I think I need to switch to 9.x to continue testing.

[n8marti]

More progress made, but now if the 9.11-devel appimage is chosen from the EXE dropdown list, it immediately reverts the choice to the 8.19-devel appimage. I'm out of time for today.

[andyhunne]

Install failed when the 'Welcome to Logos Setup' windows dialogue displayed, with the notification:
'Logos Bible study requires Windows to be fully updated. Please install system updates.'

Thanks for all the effort to get this working with the latest version btw!

[Freilichtbuehne]

With #120 the previous errors are fixed. But using Logos 34.1.0.0009 it not fails with the following error (while downloading the books after installation):

Error ID: 5313
Error detail: EntryPointNotFoundException: Unable to find an entry point named 'GetThreadDpiHostingBehavior' in DLL 'USER32.dll'.

System.EntryPointNotFoundException: Unable to find an entry point named 'GetThreadDpiHostingBehavior' in DLL 'USER32.dll'.
   at System.Windows.Forms.DpiHelper.DpiAwarenessScope..ctor(DPI_AWARENESS_CONTEXT context, DPI_HOSTING_BEHAVIOR behavior)
   at System.Windows.Forms.DpiHelper.EnterDpiAwarenessScope(DPI_AWARENESS_CONTEXT awareness, DPI_HOSTING_BEHAVIOR dpiHosting)
   at System.Windows.Forms.NativeWindow.CreateHandle(CreateParams cp)
   at System.Windows.Forms.Control.CreateHandle()
   at System.Windows.Forms.Application.ThreadContext.get_MarshalingControl()
   at System.Windows.Forms.WindowsFormsSynchronizationContext..ctor()
   at System.Windows.Forms.WindowsFormsSynchronizationContext.InstallIfNeeded()
   at System.Windows.Forms.Control..ctor(Boolean autoInstallSyncContext)
   at System.Windows.Forms.ScrollableControl..ctor()
   at System.Windows.Forms.ContainerControl..ctor()
   at System.Windows.Forms.Form..ctor()
   at Libronix.Utility.Windows.GlobalHotKeys.GlobalHotKeysForm..ctor()
   at Libronix.Utility.Windows.GlobalHotKeys.GlobalHotKeysThread(Object obj)
   at System.Threading.ExecutionContext.RunInternal(ExecutionContext executionContext, ContextCallback callback, Object state)
--- End of stack trace from previous location ---
   at System.Threading.ExecutionContext.RunInternal(ExecutionContext executionContext, ContextCallback callback, Object state)

And according to this it should be fixed by upgrading wine to 9.0-rc1 or later... Like @n8marti said earlier.

On Logos 30 it works without any problem.

[thw26]

I merged your PR. Thank you!

And we have found that using Wine 9.10+ has been good. Wine 9.0/9.1 had some known crashes on our end, but 9.10 has been pretty stable. I will see about pushing a PR with the latest Wine AppImage and we can run further testing hopefully to get this merged soon!

[n8marti]

GUI now seems to properly handle Logos 30+, including ICU files

[n8marti]

commit 8eed39d fixes #136

[n8marti]

I think we're good here.