Merge pull request #211 from chennes/addCacheControl

Add ability to disable QNAM cache for requests

Author: chennes

NetworkManager.py

@@ -338,7 +338,7 @@ def query_download_size(self, url: str, timeout_ms: int = default_timeout):
             current_index = next(self.counting_iterator)  # A thread-safe counter
             item = QueueItem(
                 current_index,
-                self.__create_get_request(url, timeout_ms),
+                self.__create_get_request(url, timeout_ms, disable_cache=true),
                 track_progress=False,
                 operation=QtNetwork.QNetworkAccessManager.HeadOperation,
             )
@@ -347,9 +347,7 @@ def query_download_size(self, url: str, timeout_ms: int = default_timeout):
             return current_index
 
     def submit_unmonitored_get(
-        self,
-        url: str,
-        timeout_ms: int = default_timeout,
+        self, url: str, timeout_ms: int = default_timeout, disable_cache: bool = False
     ) -> int:
         """Adds this request to the queue, and returns an index that can be used by calling code
         in conjunction with the completed() signal to handle the results of the call. All data is
@@ -360,16 +358,16 @@ def submit_unmonitored_get(
         # Use a queue because we can only put things on the QNAM from the main event loop thread
         self.queue.put(
             QueueItem(
-                current_index, self.__create_get_request(url, timeout_ms), track_progress=False
+                current_index,
+                self.__create_get_request(url, timeout_ms, disable_cache),
+                track_progress=False,
             )
         )
         self.__request_queued.emit()
         return current_index
 
     def submit_monitored_get(
-        self,
-        url: str,
-        timeout_ms: int = default_timeout,
+        self, url: str, timeout_ms: int = default_timeout, disable_cache: bool = False
     ) -> int:
         """Adds this request to the queue, and returns an index that can be used by calling code
         in conjunction with the progress_made() and progress_completed() signals to handle the
@@ -382,7 +380,9 @@ def submit_monitored_get(
         # Use a queue because we can only put things on the QNAM from the main event loop thread
         self.queue.put(
             QueueItem(
-                current_index, self.__create_get_request(url, timeout_ms), track_progress=True
+                current_index,
+                self.__create_get_request(url, timeout_ms, disable_cache),
+                track_progress=True,
             )
         )
         self.__request_queued.emit()
@@ -394,6 +394,7 @@ def blocking_get_with_retries(
         timeout_ms: int = default_timeout,
         max_attempts: int = 3,
         delay_ms: int = 1000,
+        disable_cache: bool = False,
     ):
         """Submits a GET request to the QNetworkAccessManager and blocks until it is complete. Do
         not use on the main GUI thread, it will prevent any event processing while it blocks.
@@ -421,9 +422,7 @@ def blocking_get_with_retries(
             time.sleep(delay_ms / 1000)
 
     def blocking_get(
-        self,
-        url: str,
-        timeout_ms: int = default_timeout,
+        self, url: str, timeout_ms: int = default_timeout, disable_cache: bool = False
     ) -> Optional[QtCore.QByteArray]:
         """Submits a GET request to the QNetworkAccessManager and blocks until it is complete. Do
         not use on the main GUI thread, it will prevent any event processing while it blocks.
@@ -438,7 +437,9 @@ def blocking_get(
 
         self.queue.put(
             QueueItem(
-                current_index, self.__create_get_request(url, timeout_ms), track_progress=False
+                current_index,
+                self.__create_get_request(url, timeout_ms, disable_cache),
+                track_progress=False,
             )
         )
         self.__request_queued.emit()
@@ -476,18 +477,27 @@ def __synchronous_process_completion(
                 self.synchronous_complete[index] = True
 
     @staticmethod
-    def __create_get_request(url: str, timeout_ms: int) -> QtNetwork.QNetworkRequest:
+    def __create_get_request(
+        url: str, timeout_ms: int, disable_cache: bool
+    ) -> QtNetwork.QNetworkRequest:
         """Construct a network request to a given URL"""
         request = QtNetwork.QNetworkRequest(QtCore.QUrl(url))
         request.setAttribute(
             QtNetwork.QNetworkRequest.RedirectPolicyAttribute,
             QtNetwork.QNetworkRequest.ManualRedirectPolicy,
         )
-        request.setAttribute(QtNetwork.QNetworkRequest.CacheSaveControlAttribute, True)
-        request.setAttribute(
-            QtNetwork.QNetworkRequest.CacheLoadControlAttribute,
-            QtNetwork.QNetworkRequest.PreferNetwork,
-        )
+        if disable_cache:
+            request.setAttribute(QtNetwork.QNetworkRequest.CacheSaveControlAttribute, False)
+            request.setAttribute(
+                QtNetwork.QNetworkRequest.CacheLoadControlAttribute,
+                QtNetwork.QNetworkRequest.AlwaysNetwork,
+            )
+        else:
+            request.setAttribute(QtNetwork.QNetworkRequest.CacheSaveControlAttribute, True)
+            request.setAttribute(
+                QtNetwork.QNetworkRequest.CacheLoadControlAttribute,
+                QtNetwork.QNetworkRequest.PreferNetwork,
+            )
         if hasattr(request, "setTransferTimeout"):
             # Added in Qt 5.15
             # In Qt 5, the function setTransferTimeout seems to accept
@@ -630,8 +640,13 @@ def __reply_finished(self) -> None:
                 if hasattr(request, "transferTimeout"):
                     timeout_ms = request.transferTimeout()
             new_url = reply.attribute(QtNetwork.QNetworkRequest.RedirectionTargetAttribute)
+            disable_cache = not reply.request().attribute(
+                QtNetwork.QNetworkRequest.CacheSaveControlAttribute
+            )
             self.__launch_request(
-                index, self.__create_get_request(new_url, timeout_ms), reply.operation()
+                index,
+                self.__create_get_request(new_url, timeout_ms, disable_cache=disable_cache),
+                reply.operation(),
             )
             return  # The task is not done, so get out of this method now
         if reply.error() != QtNetwork.QNetworkReply.NetworkError.OperationCanceledError:

addonmanager_connection_checker.py

@@ -37,6 +37,7 @@ class ConnectionCheckerGUI(QtCore.QObject):
     starts to take too long, and an error message if the network cannot be accessed."""
 
     connection_available = QtCore.Signal()
+    no_connection = QtCore.Signal()
     check_complete = QtCore.Signal()
 
     def __init__(self):
@@ -87,12 +88,13 @@ def _network_connection_failed(self, message: str) -> None:
         # This must run on the main GUI thread
         if hasattr(self, "connection_check_message") and self.connection_check_message:
             self.connection_check_message.close()
+        self.no_connection.emit()
         MessageDialog.show_modal(
             MessageDialog.DialogType.ERROR,
             "AddonManager_ConnectionFailedDialog",
             translate("AddonsInstaller", "Connection failed"),
             message,
-            QtWidgets.QMessageBox.OK,
+            QtWidgets.QMessageBox.Ok,
         )
         self._disconnect_signals()
         self.check_complete.emit()

addonmanager_workers_utility.py

@@ -63,7 +63,7 @@ def run(self):
         self.done = False
         NetworkManager.AM_NETWORK_MANAGER.completed.connect(self.connection_data_received)
         self.request_id = NetworkManager.AM_NETWORK_MANAGER.submit_unmonitored_get(
-            url, timeout_ms=30000
+            url, timeout_ms=30000, disable_cache=True
         )
         while not self.done:
             if QtCore.QThread.currentThread().isInterruptionRequested():