LorenEteval_Furious/Furious/Controllers/ConnectionController.py

# Copyright (C) 2024–present  Loren Eteval & contributors <loren.eteval@proton.me>
#
# This file is part of Furious.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <https://www.gnu.org/licenses/>.

"""Own the application connection lifecycle independently from its UI."""

from __future__ import annotations

from Furious.Frozenlib import *
from Furious.Interface import *
from Furious.Models import ServerProfile
from Furious.Plugins import getPluginRegistry
from Furious.Qt.DynamicTranslate import gettext as _
from Furious.Qt.Signals import connectWeakly
from Furious.Repository import Storage
from Furious.Service import (
    CORE_LOG_CATEGORY,
    TUN2SOCKS_LOG_CATEGORY,
    ConnectionManager,
    UpdateManager,
)

from PySide6 import QtCore

from dataclasses import dataclass
from enum import Enum

import queue
import logging
import functools

__all__ = ['ConnectionController', 'ConnectionError', 'ConnectionState']

logger = logging.getLogger(__name__)

registerAppSettings('Connect', isBinary=True)
registerAppSettings('CustomProxyBypass')


class ConnectionState(Enum):
    """Describe the application connection lifecycle."""

    Disconnected = 'Connect'
    Connecting = 'Connecting'
    Connected = 'Disconnect'
    Disconnecting = 'Disconnecting'


@dataclass(frozen=True)
class ConnectionError:
    """Describe a user-facing connection error without presenting it."""

    title: str
    message: str
    details: str = ''


def validateProxyServer(server) -> bool:
    """Return whether *server* is a valid host and TCP port pair."""
    try:
        _host, port = parseHostPort(server)

        if int(port) < 0 or int(port) > 65535:
            raise ValueError
    except Exception:
        # Any non-exit exceptions

        return False

    return True


class ConnectionController(QtCore.QObject):
    """Coordinate one connection lifecycle and publish observable state."""

    stateChanged = QtCore.Signal(object)
    activeProfileChanged = QtCore.Signal(object)
    interactionEnabledChanged = QtCore.Signal(bool)
    runtimesChanged = QtCore.Signal(object)
    progressStarted = QtCore.Signal()
    progressFinished = QtCore.Signal(bool)
    notificationRequested = QtCore.Signal(str)
    errorOccurred = QtCore.Signal(object)

    def __init__(self, parent=None, *, coreManager=None, updatesManager=None):
        """Initialize reusable runtime services and a disconnected state."""
        super().__init__(parent)

        self._actionQueue = queue.Queue()
        self._coreManager = coreManager or ConnectionManager()
        self._updatesManager = updatesManager or UpdateManager()
        self._state = ConnectionState.Disconnected
        self._activeProfile = None
        self._lastError = None
        self._startOperation = None
        self._pendingHttpProxy = ''
        self._connectionGeneration = 0
        self._startAdmissionPending = False
        self._shuttingDown = False
        self._runtimeCleanupFailed = False

        self._actionTimer = QtCore.QTimer(self)
        self._actionTimer.timeout.connect(self._callActionFromQueue)

    @property
    def state(self) -> ConnectionState:
        """Return the current connection lifecycle state."""
        return self._state

    @property
    def activeProfile(self):
        """Return the profile owned by the current connection lifecycle."""
        return self._activeProfile

    @property
    def runtimes(self):
        """Return an immutable snapshot of managed core runtimes."""
        return tuple(self._coreManager.runtimes)

    @property
    def lastError(self):
        """Return the last user-facing connection error, if any."""
        return self._lastError

    @property
    def interactionEnabled(self) -> bool:
        """Return whether connection-dependent settings may be changed."""
        return self.state not in (
            ConnectionState.Connecting,
            ConnectionState.Disconnecting,
        )

    def isConnected(self) -> bool:
        """Return whether the connection is established."""
        return self.state is ConnectionState.Connected

    def isConnecting(self) -> bool:
        """Return whether the connection is starting."""
        return self.state is ConnectionState.Connecting

    def isDisconnecting(self) -> bool:
        """Return whether the connection is stopping."""
        return self.state is ConnectionState.Disconnecting

    def _setState(self, state: ConnectionState):
        """Publish an atomic lifecycle transition."""
        if state is self._state:
            return

        interactionWasEnabled = self.interactionEnabled

        generation = self._connectionGeneration

        self._state = state
        self.stateChanged.emit(state)

        if generation != self._connectionGeneration or self._state is not state:
            return

        if self.interactionEnabled != interactionWasEnabled:
            self.interactionEnabledChanged.emit(self.interactionEnabled)

    def _setActiveProfile(self, profile):
        """Publish the profile owned by the current lifecycle."""
        if profile is self._activeProfile:
            return

        self._activeProfile = profile
        self.activeProfileChanged.emit(profile)

    def _emitRuntimesChanged(self):
        """Publish a stable snapshot after managed runtimes change."""
        self.runtimesChanged.emit(self.runtimes)

    def _reportError(self, message: str, details: str = ''):
        """Publish a user-facing error without choosing its presentation."""
        self._lastError = ConnectionError(_('Unable to connect'), message, details)
        self.errorOccurred.emit(self._lastError)

    def _failConnection(self, message: str, details: str = '') -> bool:
        """Clean partial runtime state, then publish one structured error."""
        if self.state is not ConnectionState.Disconnected:
            self.startDisconnection()

        self._reportError(message, details)

        return False

    def _reset(self):
        """Restore disconnected state after all runtime resources stop."""
        self._startOperation = None
        self._pendingHttpProxy = ''

        self.progressFinished.emit(True)
        self._setActiveProfile(None)

        AppSettings.turnOFF('Connect')

        self._setState(ConnectionState.Disconnected)

    def _isCurrentConnection(self, generation):
        """Reject continuations from an earlier, synchronously replaced lifecycle."""
        return generation == self._connectionGeneration and not self._shuttingDown

    def _startConnecting(self):
        """Enter the connecting state and request progress presentation."""
        generation = self._connectionGeneration

        self._setState(ConnectionState.Connecting)

        if self._isCurrentConnection(generation) and self.isConnecting():
            self.progressStarted.emit()

    def _finishConnecting(self):
        """Publish connection completion only while this lifecycle stays current."""
        generation = self._connectionGeneration

        self.progressFinished.emit(True)

        if not self._isCurrentConnection(generation) or not self.isConnecting():
            return False

        AppSettings.turnON_('Connect')

        self._setState(ConnectionState.Connected)

        if not self._isCurrentConnection(generation) or not self.isConnected():
            return False

        Mixins.ConnectionAware.callConnectedCallback()

        return self._isCurrentConnection(generation) and self.isConnected()

    def startConnection(self, configuration=None) -> bool:
        """Start *configuration* or the active repository profile."""
        # QObject already exposes a legacy ``connect`` attribute in PySide.
        # Using an explicit operation name avoids shadowing Qt signal plumbing.
        if (
            self.state is not ConnectionState.Disconnected
            or self._startAdmissionPending
            or self._shuttingDown
        ):
            return False

        if configuration is None:
            servers = Storage.UserServers()

            if not servers:
                AppSettings.turnOFF('Connect')

                self._reportError(
                    _('Server configuration empty. Please configure your server first')
                )

                return False

            activeIndex = Storage.UserActivatedItemIndex()

            if activeIndex < 0 or activeIndex >= len(servers):
                AppSettings.turnOFF('Connect')

                self._reportError(
                    _('Select and press Enter to activate configuration and connect')
                )

                return False

            configuration = servers[activeIndex]

        if not isinstance(configuration, ServerProfile):
            AppSettings.turnOFF('Connect')

            self._reportError(_('Please complete your server configuration'))

            return False

        @forceToLocalhostIfPossible()
        def getHttpProxy() -> str:
            """Return the system-proxy endpoint for this connection."""
            return configuration.httpProxy()

        httpProxy = getHttpProxy()

        if not validateProxyServer(httpProxy):
            AppSettings.turnOFF('Connect')

            self._reportError(
                _(
                    f'{APPLICATION_NAME} cannot find any valid http proxy endpoint in the configuration'
                ),
                _('Please complete your server configuration'),
            )

            return False

        self._connectionGeneration += 1

        generation = self._connectionGeneration

        self._startAdmissionPending = True
        self._lastError = None
        self._pendingHttpProxy = httpProxy
        self._setActiveProfile(configuration)

        if not self._isCurrentConnection(generation):
            return False

        self._startConnecting()

        if not self._isCurrentConnection(generation) or not self.isConnecting():
            return False

        self._startAdmissionPending = False

        logManager = AppLogManager()

        # Retain application diagnostics while starting a fresh runtime log.
        logManager.clear(runtimeOnly=True)

        if not self._isCurrentConnection(generation) or not self.isConnecting():
            return False

        startAsync = getattr(self._coreManager, 'startAsync', None)

        if callable(startAsync):
            try:
                operation = startAsync(
                    configuration,
                    routing=AppSettings.get('Routing'),
                    exitCallback=self.coreExitCallback,
                    msgCallbackCore=logManager.callback(CORE_LOG_CATEGORY),
                    msgCallbackTUN_=logManager.callback(
                        TUN2SOCKS_LOG_CATEGORY,
                        source='Tun2socks',
                    ),
                )
            except Exception as ex:
                # Any non-exit exceptions

                logger.error(f'failed to schedule core manager startup: {ex}')

                return self._failConnection(
                    f'{configuration.coreName()}: ' + _('Unknown error'),
                    str(ex),
                )

            if not self._isCurrentConnection(generation) or not self.isConnecting():
                self._coreManager.cancelStart(operation)

                return False

            self._startOperation = operation

            connectWeakly(
                operation.succeeded,
                self,
                '_connectionStartSucceeded',
                sender=operation,
            )
            connectWeakly(
                operation.failed,
                self,
                '_connectionStartFailed',
                sender=operation,
            )
            connectWeakly(
                operation.cancelled,
                self,
                '_connectionStartCancelled',
                sender=operation,
            )

            return True

        startExceptionDetails = ''

        try:
            success = self._coreManager.start(
                configuration,
                routing=AppSettings.get('Routing'),
                exitCallback=self.coreExitCallback,
                msgCallbackCore=logManager.callback(CORE_LOG_CATEGORY),
                msgCallbackTUN_=logManager.callback(
                    TUN2SOCKS_LOG_CATEGORY,
                    source='Tun2socks',
                ),
            )
        except Exception as ex:
            # Any non-exit exceptions

            logger.error(f'failed to start core manager: {ex}')

            success = False
            startExceptionDetails = str(ex)

        self._emitRuntimesChanged()

        if not self._actionQueue.empty():
            while not self._actionQueue.empty():
                self._callActionFromQueue()

            return False

        if not self._isCurrentConnection(generation) or not self.isConnecting():
            return False

        if not success:
            logger.error('failed to start core manager')

            startError = getattr(self._coreManager, 'lastStartError', '')

            return self._failConnection(
                f'{configuration.coreName()}: '
                + (_(startError) if startError else _('Unknown error')),
                startExceptionDetails,
            )

        return self._finishConnection(configuration, httpProxy)

    def _finishConnection(self, configuration, httpProxy) -> bool:
        """Commit system integration after manager runtime ownership commits."""
        generation = self._connectionGeneration

        settings = AppSettings.get('CustomProxyBypass')

        proxyServerBypass = (
            settings if isinstance(settings, str) else PROXY_SERVER_BYPASS
        )

        try:
            # System proxy setup is best effort; the helper logs host failures.
            # Ignore even False so an otherwise usable core stays connected.
            SystemProxy.set(httpProxy, proxyServerBypass)
        except Exception as ex:
            # Any non-exit exceptions

            logger.error(f'error while setting http proxy: {ex}')
            logger.error(
                f'failed to connect successfully. '
                f'This may be due to improper proxy '
                f'server bypass settings: {proxyServerBypass}'
            )

            return self._failConnection(
                f'{configuration.coreName()}: ' + _('Unknown error'), str(ex)
            )

        if not self._isCurrentConnection(generation) or not self.isConnecting():
            return False

        if not self._finishConnecting():
            return False

        self.notificationRequested.emit(
            f'{configuration.coreName()}: ' + _('Connected')
        )

        if not self._isCurrentConnection(generation) or not self.isConnected():
            return False

        interval = CORE_CHECK_ALIVE_INTERVAL

        if AppSettings.isStateON_('PowerSaveMode'):
            interval *= 2

        self._actionTimer.start(interval)

        self._runPostConnectTasksOnce()

        return True

    @QtCore.Slot(object)
    def _connectionStartSucceeded(self, operation):
        """Finish the exact manager generation that committed successfully."""
        if operation is not self._startOperation or not self.isConnecting():
            return

        generation = self._connectionGeneration

        self._startOperation = None

        self._emitRuntimesChanged()

        while not self._actionQueue.empty():
            self._callActionFromQueue()

        if not self._isCurrentConnection(generation) or not self.isConnecting():
            return

        configuration = self.activeProfile

        if configuration is None:
            self._failConnection(_('Unknown error'))

            return

        self._finishConnection(configuration, self._pendingHttpProxy)

    @QtCore.Slot(object, str, str)
    def _connectionStartFailed(self, operation, message, details):
        """Return one failed manager generation to stable disconnected state."""
        if operation is not self._startOperation:
            return

        generation = self._connectionGeneration

        self._startOperation = None

        self._emitRuntimesChanged()

        if not self._isCurrentConnection(generation):
            return

        configuration = self.activeProfile
        coreName = configuration.coreName() if configuration is not None else ''
        startError = message or getattr(self._coreManager, 'lastStartError', '')
        displayMessage = (f'{coreName}: ' if coreName else '') + (
            _(startError) if startError else _('Unknown error')
        )

        self._failConnection(displayMessage, details)

    @QtCore.Slot(object)
    def _connectionStartCancelled(self, operation):
        """Ignore stale cancellation or reset an externally cancelled start."""
        if operation is not self._startOperation:
            return

        generation = self._connectionGeneration

        self._startOperation = None

        self._emitRuntimesChanged()

        if not self._isCurrentConnection(generation):
            return

        self._reset()

    def startDisconnection(self, notification: str = '') -> bool:
        """Stop the active runtime and optionally request a notification."""
        if self.isDisconnecting() or (
            self.state is ConnectionState.Disconnected
            and not self._startAdmissionPending
        ):
            return False

        self._connectionGeneration += 1

        generation = self._connectionGeneration

        self._startAdmissionPending = False

        operation = self._startOperation

        self._startOperation = None

        self._setState(ConnectionState.Disconnecting)
        self._actionTimer.stop()

        if operation is not None:
            cancelStart = getattr(self._coreManager, 'cancelStart', None)

            if callable(cancelStart):
                try:
                    cancelStart(operation)
                except Exception as ex:
                    # Any non-exit exceptions

                    logger.error(f'failed to cancel connection startup: {ex}')

        try:
            SystemProxy.off()
        except Exception as ex:
            # Any non-exit exceptions

            logger.error(f'failed to turn off system proxy: {ex}')

        self._runtimeCleanupFailed = False

        try:
            self._coreManager.stopAll()
        except Exception as ex:
            # Any non-exit exceptions

            # Always complete the state transition. A cleanup failure must not
            # strand every connection UI in the disabled Disconnecting state.
            self._runtimeCleanupFailed = True

            logger.error(f'failed to stop connection runtime: {ex}')

        self._emitRuntimesChanged()
        self._reset()

        if generation != self._connectionGeneration:
            return True

        while not self._actionQueue.empty():
            try:
                self._actionQueue.get_nowait()
            except Exception:
                # Any non-exit exceptions

                pass

        Mixins.ConnectionAware.callDisconnectedCallback()

        if notification:
            self.notificationRequested.emit(notification)

        return True

    def startReconnection(self, notification: str = '') -> bool:
        """Restart the active repository profile when lifecycle state permits."""
        if self.state is ConnectionState.Disconnecting:
            return False

        if self.isConnected() or self.isConnecting():
            self.startDisconnection(notification)

        return self.startConnection()

    def restoreStartupState(self) -> bool:
        """Restore the persisted connection preference during application startup."""
        if not AppSettings.isStateON_('Connect'):
            return False

        return self.startConnection()

    def shutdown(self):
        """Stop runtime resources without changing the next-start preference."""
        reconnectOnStartup = AppSettings.isStateON_('Connect')

        self._shuttingDown = True

        try:
            if (
                self.state is not ConnectionState.Disconnected
                or self._startAdmissionPending
            ):
                self.startDisconnection()

                if not self._runtimeCleanupFailed:
                    return

            # Disconnect keeps the UI usable on failure. Final shutdown must
            # surface retained resources before its owner is destroyed.
            self._coreManager.stopAll()
            self._runtimeCleanupFailed = False
        finally:
            if reconnectOnStartup:
                AppSettings.turnON_('Connect')

    def toggle(self) -> bool:
        """Perform the operation represented by the current stable state."""
        if self.state is ConnectionState.Disconnected:
            return self.startConnection()

        if self.state is ConnectionState.Connected:
            return self.startDisconnection(_('Disconnected'))

        return False

    @callOnceOnly
    def _runPostConnectTasksOnce(self):
        """Run application update and plugin maintenance after first connect."""

        def newVersionCallback(newVersion):
            """Request a notification when a newer version is available."""
            self.notificationRequested.emit(
                f'{APPLICATION_NAME} {newVersion} ' + _('is available to download')
            )

        connectedHttpProxy = Storage.Extras.UserHttpProxy()

        self._updatesManager.configureHttpProxy(connectedHttpProxy)
        self._updatesManager.checkForUpdates(
            showMessageBox=False,
            hasNewVersionCallback=newVersionCallback,
        )

        getPluginRegistry().afterConnected(connectedHttpProxy)

    @QtCore.Slot()
    def _callActionFromQueue(self):
        """Run one core-thread action on the controller's Qt thread."""
        try:
            action = self._actionQueue.get_nowait()
        except queue.Empty:
            return
        except Exception:
            # Any non-exit exceptions

            return

        if callable(action):
            action()

    def coreExitCallback(self, core: CoreRuntime, event: RuntimeExit):
        """Queue one already interpreted committed-runtime exit."""

        def putItem(item):
            """Queue an operation without allowing worker failures to escape."""
            try:
                self._actionQueue.put_nowait(item)
            except Exception:
                # Any non-exit exceptions

                pass

        if not event.unexpected:
            return None

        message = f'{core.name()}: ' + _(event.message)

        putItem(
            functools.partial(
                self._failConnection,
                message,
                f'raw exit code={event.code}; reason={event.reason.value}',
            )
        )

        return None