# SPDX-License-Identifier: LGPL-2.1-or-later # *************************************************************************** # * * # * Copyright (c) 2022-2023 FreeCAD Project Association * # * * # * This file is part of FreeCAD. * # * * # * FreeCAD is free software: you can redistribute it and/or modify it * # * under the terms of the GNU Lesser General Public License as * # * published by the Free Software Foundation, either version 2.1 of the * # * License, or (at your option) any later version. * # * * # * FreeCAD is distributed in the hope that it will be useful, but * # * WITHOUT ANY WARRANTY; without even the implied warranty of * # * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * # * Lesser General Public License for more details. * # * * # * You should have received a copy of the GNU Lesser General Public * # * License along with FreeCAD. If not, see * # * . * # * * # *************************************************************************** """ Misc. worker thread classes for the FreeCAD Addon Manager. """ from typing import Optional import FreeCAD from PySide import QtCore import NetworkManager import time translate = FreeCAD.Qt.translate class ConnectionChecker(QtCore.QThread): """A worker thread for checking the connection to GitHub as a proxy for overall network connectivity. It has two signals: success() and failure(str). The failure signal contains a translated error message suitable for display to an end user.""" success = QtCore.Signal() failure = QtCore.Signal(str) def __init__(self): QtCore.QThread.__init__(self) self.done = False self.request_id = None self.data = None def run(self): """Not generally called directly: create a new ConnectionChecker object and call start() on it to spawn a child thread.""" FreeCAD.Console.PrintLog("Checking network connection...\n") url = "https://api.github.com/zen" 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=10000 ) while not self.done: if QtCore.QThread.currentThread().isInterruptionRequested(): FreeCAD.Console.PrintLog("Connection check cancelled\n") NetworkManager.AM_NETWORK_MANAGER.abort(self.request_id) self.disconnect_network_manager() return QtCore.QCoreApplication.processEvents() time.sleep(0.1) if not self.data: self.failure.emit( translate( "AddonsInstaller", "Unable to read data from GitHub: check your internet connection and proxy " "settings and try again.", ) ) self.disconnect_network_manager() return FreeCAD.Console.PrintLog(f"GitHub's zen message response: {self.data.decode('utf-8')}\n") self.disconnect_network_manager() self.success.emit() def connection_data_received(self, id: int, status: int, data: QtCore.QByteArray): if self.request_id is not None and self.request_id == id: if status == 200: self.data = data.data() else: FreeCAD.Console.PrintWarning(f"No data received: status returned was {status}\n") self.data = None self.done = True def disconnect_network_manager(self): NetworkManager.AM_NETWORK_MANAGER.completed.disconnect(self.connection_data_received)