backend: General performance improvements and code cleanup

This commit is the first of many to avoid the back-end rewrite.


* document Result object

* document Diff class

* remove layered env code

* remove Notifications since deprecated

* fix method name (PEP8)

* add convenient method to force kill wineserver when stalled

* use force_f_stalled in runner

* use Result obj in Downloader.download

* handle the Result obj in ComponentManager.download

* code cleanup

* remove old RunnerName type

* remove old note

repositories can now instruct this changes

* code cleanup

* code cleanup

* code cleanup

* code cleanup

* new trailing newline

* extend __validate_template method with essential paths

* code cleanup

* improve offline check

the old method was too slow, the new one just checks the headers with curl, which is much faster

* remove deprecations and old migrations

* fixes #2345

* fix typo

Co-authored-by: Kinsteen <[email protected]>

* fix exception string

* remove cabextract binary check

since it's already done in health.py

* remove reportMissingImports

useless now since the main package moved from src to bottles

* add PycURL

* replace urllib with pycurl in crucial points

Co-authored-by: Kinsteen <[email protected]>

Author: mirkobrombin

Diff for: bottles/backend/cabextract.py

@@ -21,7 +21,7 @@
 import subprocess
 from gettext import gettext as _
 
-from bottles.backend.logger import Logger  # pyright: reportMissingImports=false
+from bottles.backend.logger import Logger
 
 logging = Logger()
 
@@ -61,15 +61,6 @@ def __checks(self):
             logging.error(f"Cab file {self.path} not found")
             return False
 
-        if not self.cabextract_bin:
-            logging.critical("cabextract utility not found, please install to use "
-                             "dependencies which need this feature")
-            logging.write_log(
-                "cabextract utility not found, please install to use "
-                "dependencies which need this feature"
-            )
-            return False
-
         return True
 
     def __extract(self) -> bool:
@@ -81,7 +72,7 @@ def __extract(self) -> bool:
                 for file in self.files:
                     '''
                     if file already exists as a symlink, remove it
-                    preventing broken symlinks when using layers
+                    preventing broken symlinks
                     '''
                     if os.path.exists(os.path.join(self.destination, file)):
                         if os.path.islink(os.path.join(self.destination, file)):
@@ -111,10 +102,7 @@ def __extract(self) -> bool:
                     f"-q {self.path}"
                 ]
                 command = " ".join(command)
-                subprocess.Popen(
-                    command,
-                    shell=True
-                ).communicate()
+                subprocess.Popen(command,  shell=True).communicate()
 
             logging.info(f"Cabinet {self.name} extracted successfully")
             return True

Diff for: bottles/backend/diff.py

@@ -3,11 +3,14 @@
 
 
 class Diff:
+    '''
+    This class is no more used by the application, it's just a
+    reference for future implementations.
+    '''
     __ignored = [
         "dosdevices",
         "users",
         "bottle.yml",
-        "layer.yml",
         "storage"
     ]
 

Diff for: bottles/backend/dlls/dll.py

@@ -20,7 +20,7 @@
 from typing import NewType
 from abc import abstractmethod
 
-from bottles.backend.logger import Logger  # pyright: reportMissingImports=false
+from bottles.backend.logger import Logger
 from bottles.backend.utils.manager import ManagerUtils
 from bottles.backend.wine.reg import Reg
 from bottles.backend.wine.wineboot import WineBoot

Diff for: bottles/backend/dlls/dxvk.py

@@ -15,7 +15,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-from bottles.backend.dlls.dll import DLLComponent  # pyright: reportMissingImports=false
+from bottles.backend.dlls.dll import DLLComponent
 from bottles.backend.utils.manager import ManagerUtils
 
 

Diff for: bottles/backend/dlls/latencyflex.py

@@ -15,7 +15,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-from bottles.backend.dlls.dll import DLLComponent  # pyright: reportMissingImports=false
+from bottles.backend.dlls.dll import DLLComponent
 from bottles.backend.utils.manager import ManagerUtils
 
 

Diff for: bottles/backend/dlls/nvapi.py

@@ -15,7 +15,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-from bottles.backend.dlls.dll import DLLComponent  # pyright: reportMissingImports=false
+from bottles.backend.dlls.dll import DLLComponent
 from bottles.backend.utils.manager import ManagerUtils
 
 

Diff for: bottles/backend/dlls/vkd3d.py

@@ -15,7 +15,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-from bottles.backend.dlls.dll import DLLComponent  # pyright: reportMissingImports=false
+from bottles.backend.dlls.dll import DLLComponent
 from bottles.backend.utils.manager import ManagerUtils
 
 

Diff for: bottles/backend/downloader.py

@@ -19,8 +19,9 @@
 import requests
 from gi.repository import GLib
 
-from bottles.backend.logger import Logger  # pyright: reportMissingImports=false
+from bottles.backend.logger import Logger
 from bottles.backend.utils.file import FileUtils
+from bottles.backend.models.result import Result
 
 logging = Logger()
 
@@ -39,12 +40,12 @@ def __init__(self, url: str, file: str, func: callable = None, task_id: int = No
         self.func = func
         self.task_id = task_id
 
-    def download(self):
+    def download(self) -> Result:
         """Start the download."""
         try:
             with open(self.file, "wb") as file:
                 self.start_time = time.time()
-                headers = {"User-Agent": "curl/7.79.1"}
+                headers = {"User-Agent": "curl/7.79.1"}  # we fake the user-agent to avoid 403 errors on some servers
                 response = requests.get(self.url, stream=True, headers=headers)
                 total_size = int(response.headers.get("content-length", 0))
                 block_size = 1024
@@ -78,12 +79,12 @@ def download(self):
                         self.__progress(1, 1, 1)
         except requests.exceptions.SSLError:
             logging.error("Download failed due to a SSL error. Your system may have a wrong date/time or wrong certificates.")
-            return False
+            return Result(False, message="Download failed due to a SSL error.")
         except (requests.exceptions.RequestException, OSError):
             logging.error("Download failed! Check your internet connection.")
-            return False
+            return Result(False, message="Download failed! Check your internet connection.")
 
-        return True
+        return Result(True)
 
     def __progress(self, count, block_size, total_size):
         """Update the progress bar."""

Diff for: bottles/backend/globals.py

@@ -21,17 +21,13 @@
 from pathlib import Path
 from functools import lru_cache
 
-from bottles.backend.logger import Logger  # pyright: reportMissingImports=false
+from bottles.backend.logger import Logger
 from bottles.backend.utils.display import DisplayUtils
 from bottles.backend.managers.data import DataManager
 
 logging = Logger()
 
 
-class API:
-    notifications = "https://raw.githubusercontent.com/bottlesdevs/data/main/notifications.yml"
-
-
 # xdg data path
 xdg_data_home = GLib.get_user_data_dir()
 
@@ -45,7 +41,7 @@ def get_apps_dir():
         _dir = f"{Path.home()}/.local/share/applications"
     return _dir
 
-def VkBasaltPath():
+def is_vkbasalt_available():
     vkbasalt_paths = [
             "/usr/lib/extensions/vulkan/vkBasalt/etc/vkBasalt",
             "/usr/local",
@@ -76,7 +72,6 @@ class Paths:
     runners = f"{base}/runners"
     bottles = f"{base}/bottles"
     steam = f"{base}/steam"
-    layers = f"{base}/layers"
     dxvk = f"{base}/dxvk"
     vkd3d = f"{base}/vkd3d"
     nvapi = f"{base}/nvapi"
@@ -105,7 +100,7 @@ class TrdyPaths:
 # Check if some tools are available
 gamemode_available = shutil.which("gamemoderun") or False
 gamescope_available = shutil.which("gamescope") or False
-vkbasalt_available = VkBasaltPath()
+vkbasalt_available = is_vkbasalt_available()
 mangohud_available = shutil.which("mangohud") or False
 obs_vkc_available = shutil.which("obs-vkcapture") or False
 vmtouch_available = shutil.which("vmtouch") or False

Diff for: bottles/backend/health.py

@@ -22,7 +22,7 @@
 import contextlib
 import subprocess
 
-from bottles.backend.logger import Logger  # pyright: reportMissingImports=false
+from bottles.backend.logger import Logger
 from bottles.backend.utils.display import DisplayUtils
 from bottles.backend.utils.gpu import GPUUtils
 from bottles.backend.utils.generic import is_glibc_min_available
@@ -70,6 +70,7 @@ def __init__(self):
             "MemAvailable": "n/a"
         }
         self.get_ram_data()
+        
         if not "FLATPAK_ID" in os.environ:
             self.cabextract = self.check_cabextract()
             self.p7zip = self.check_p7zip()
@@ -231,7 +232,6 @@ def __get_distro():
     @staticmethod
     def get_bottles_envs():
         look = [
-            "LAYERS",
             "TESTING_REPOS",
             "LOCAL_INSTALLERS",
             "LOCAL_COMPONENTS",
@@ -269,6 +269,7 @@ def get_ram_data(self):
 
     def get_results(self, plain: bool = False):
         results = {
+            "Official Package": "FLATPAK_ID" in os.environ,
             "Version": VERSION,
             "Display": {
                 "X.org": self.x11,