mirror of
https://github.com/LorenEteval/Furious.git
synced 2026-09-30 10:58:09 +03:00
1234 lines
40 KiB
Python
1234 lines
40 KiB
Python
# 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/>.
|
||
|
||
"""Provide the application window for user routing window."""
|
||
|
||
from __future__ import annotations
|
||
|
||
from Furious.Frozenlib import *
|
||
from Furious.Models import *
|
||
from Furious.Repository import *
|
||
from Furious.Qt import *
|
||
from Furious.Qt import gettext as _
|
||
|
||
from PySide6 import QtCore
|
||
from PySide6.QtGui import *
|
||
from PySide6.QtWidgets import *
|
||
|
||
import copy
|
||
import uuid
|
||
import logging
|
||
import functools
|
||
|
||
from .Routing import cleanRoutingRule
|
||
|
||
__all__ = [
|
||
'XrayRoutingWindow',
|
||
# Begin export for testing
|
||
'RoutingPreviewDialog',
|
||
'RoutingRuleEditDialog',
|
||
'RoutingRulesDialog',
|
||
# End export for testing
|
||
]
|
||
|
||
logger = logging.getLogger(__name__)
|
||
|
||
registerAppSettings('UserRoutingWindowGeometry')
|
||
registerAppSettings('UserRoutingWindowState')
|
||
registerAppSettings('UserRoutingHeaderViewState')
|
||
|
||
DOMAIN_STRATEGIES, ROUTING_STATES = (
|
||
['AsIs', 'IPIfNonMatch', 'IPOnDemand'],
|
||
['Enabled', 'Disabled'],
|
||
)
|
||
|
||
|
||
def valuesToList(text: str) -> list[str]:
|
||
"""Return the values to list value used by the application."""
|
||
values = list()
|
||
|
||
for line in text.splitlines():
|
||
for value in line.split(','):
|
||
value = value.strip()
|
||
|
||
if value:
|
||
values.append(value)
|
||
|
||
return values
|
||
|
||
|
||
def listToText(value) -> str:
|
||
"""Return the list to text value used by the application."""
|
||
if isinstance(value, list):
|
||
return '\n'.join(str(item) for item in value)
|
||
|
||
return ''
|
||
|
||
|
||
def routingStateText(state: str) -> str:
|
||
"""Return the routing state text value used by the application."""
|
||
if state == 'Enabled':
|
||
return _('Enabled')
|
||
elif state == 'Disabled':
|
||
return _('Disabled')
|
||
|
||
return _(state)
|
||
|
||
|
||
def addRoutingStateItems(combo: QComboBox):
|
||
"""Add routing state items."""
|
||
combo.clear()
|
||
|
||
for state in ROUTING_STATES:
|
||
combo.addItem(routingStateText(state), state)
|
||
|
||
|
||
def comboCurrentData(combo: QComboBox, default=''):
|
||
"""Return the combo current data value used by the application."""
|
||
data = combo.currentData()
|
||
|
||
if data is None:
|
||
return default
|
||
|
||
return data
|
||
|
||
|
||
def routingObjectFromProfile(routingProfile: dict):
|
||
"""Return the routing object from profile value used by the application."""
|
||
if not isinstance(routingProfile, dict):
|
||
routingProfile = dict()
|
||
|
||
domainStrategy = routingProfile.get('domainStrategy', 'AsIs')
|
||
|
||
if domainStrategy not in DOMAIN_STRATEGIES:
|
||
domainStrategy = 'AsIs'
|
||
|
||
rules = list(
|
||
filter(
|
||
lambda rule: rule is not None,
|
||
list(cleanRoutingRule(rule) for rule in routingProfile.get('rules', [])),
|
||
)
|
||
)
|
||
|
||
return {
|
||
'domainStrategy': domainStrategy,
|
||
'domainMatcher': 'hybrid',
|
||
'rules': rules,
|
||
}
|
||
|
||
|
||
class RoutingPreviewDialog(AppQTransientDialog):
|
||
"""Present the routing preview dialog."""
|
||
|
||
def __init__(self, routingProfile: dict, parent=None):
|
||
"""Initialize the RoutingPreviewDialog."""
|
||
super().__init__(parent)
|
||
|
||
self.setWindowTitle(_('Preview Routing'))
|
||
self.setWindowModality(QtCore.Qt.WindowModality.WindowModal)
|
||
|
||
self.textEditor = DraculaJSONTextEditor(fontFamily=AppFontName())
|
||
self.textEditor.setLineWrapMode(DraculaJSONTextEditor.LineWrapMode.NoWrap)
|
||
self.textEditor.setPlainText(
|
||
UJSONEncoder.encode(routingObjectFromProfile(routingProfile), indent=4)
|
||
)
|
||
self.textEditor.setReadOnly(True)
|
||
|
||
layout = QVBoxLayout()
|
||
layout.addWidget(self.textEditor)
|
||
|
||
self.setLayout(layout)
|
||
|
||
def setWidthAndHeight(self):
|
||
"""Apply the default size for the routing preview dialog."""
|
||
self.setFixedSize(400, int(400 * GOLDEN_RATIO))
|
||
|
||
|
||
class RoutingTextEditDialog(AppQTransientDialog):
|
||
"""Present the routing text edit dialog."""
|
||
|
||
def __init__(self, text='', parent=None):
|
||
"""Initialize the RoutingTextEditDialog."""
|
||
super().__init__(parent)
|
||
|
||
self.setWindowTitle(_('Edit Text'))
|
||
self.setWindowModality(QtCore.Qt.WindowModality.WindowModal)
|
||
|
||
self.textEdit = QTextEdit(text)
|
||
|
||
self.dialogBtns = AppQDialogButtonBox(QtCore.Qt.Orientation.Horizontal)
|
||
self.dialogBtns.addButton(_('OK'), AppQDialogButtonBox.ButtonRole.AcceptRole)
|
||
self.dialogBtns.addButton(
|
||
_('Cancel'),
|
||
AppQDialogButtonBox.ButtonRole.RejectRole,
|
||
)
|
||
self.dialogBtns.accepted.connect(self.accept)
|
||
self.dialogBtns.rejected.connect(self.reject)
|
||
|
||
layout = QVBoxLayout()
|
||
layout.addWidget(self.textEdit)
|
||
layout.addWidget(self.dialogBtns)
|
||
|
||
self.setLayout(layout)
|
||
|
||
def setWidthAndHeight(self):
|
||
"""Apply the default size for the routing text edit dialog."""
|
||
self.setFixedSize(760, 470)
|
||
|
||
def text(self):
|
||
"""Return the text value."""
|
||
return self.textEdit.toPlainText()
|
||
|
||
|
||
class RoutingTextEdit(Mixins.QTranslatable, QTextEdit):
|
||
"""Represent routing text edit."""
|
||
|
||
def __init__(self, text='', parent=None):
|
||
"""Initialize the RoutingTextEdit."""
|
||
super().__init__(text, parent)
|
||
|
||
self.setToolTip(_('Double-click to enlarge'))
|
||
|
||
def mouseDoubleClickEvent(self, event):
|
||
"""Handle the mouse double click event."""
|
||
dialog = RoutingTextEditDialog(self.toPlainText(), parent=self)
|
||
|
||
def handleResultCode(code):
|
||
"""Handle result code."""
|
||
if code == PySide6Legacy.enumValueWrapper(AppQDialog.DialogCode.Accepted):
|
||
self.setPlainText(dialog.text())
|
||
|
||
dialog.finished.connect(handleResultCode)
|
||
dialog.open()
|
||
|
||
event.accept()
|
||
|
||
def retranslate(self):
|
||
"""Refresh translated text for the routing text edit."""
|
||
self.setToolTip(_(self.toolTip()))
|
||
|
||
|
||
class RoutingDocumentationURL(AppQLabel):
|
||
"""Represent routing documentation URL."""
|
||
|
||
URL = 'https://xtls.github.io/config/routing.html'
|
||
|
||
def __init__(self, *args, **kwargs):
|
||
"""Initialize the RoutingDocumentationURL."""
|
||
super().__init__(*args, **kwargs)
|
||
|
||
self.setWebsiteURL()
|
||
self.linkActivated.connect(self.handleLinkActivated)
|
||
|
||
def setWebsiteURL(self):
|
||
"""Set website URL."""
|
||
self.setText(
|
||
'<html><head/><body><p>'
|
||
f'<a href="{self.URL}">'
|
||
'<span style=" text-decoration: underline; color:#007ad6;">'
|
||
+ _('Routing Documentation')
|
||
+ '</span></a></p></body></html>'
|
||
)
|
||
|
||
@staticmethod
|
||
def handleLinkActivated(link: str):
|
||
"""Handle link activated."""
|
||
if QDesktopServices.openUrl(QtCore.QUrl(link)):
|
||
logger.info(f'open link \'{link}\' success')
|
||
else:
|
||
logger.error(f'open link \'{link}\' failed')
|
||
|
||
def retranslate(self):
|
||
"""Refresh translated text for the routing documentation URL."""
|
||
self.setWebsiteURL()
|
||
|
||
|
||
class RoutingProfilesModel(QtCore.QAbstractTableModel):
|
||
"""Expose routing profiles data through a Qt item model."""
|
||
|
||
Headers = ['Remark', 'Domain Strategy', 'State']
|
||
|
||
def rowCount(self, parent=QtCore.QModelIndex()) -> int:
|
||
"""Return the number of rows exposed by the model."""
|
||
if parent.isValid():
|
||
return 0
|
||
|
||
return len(Storage.UserRoutings())
|
||
|
||
def columnCount(self, parent=QtCore.QModelIndex()) -> int:
|
||
"""Return the number of columns exposed by the model."""
|
||
if parent.isValid():
|
||
return 0
|
||
|
||
return len(self.Headers)
|
||
|
||
def flags(self, index):
|
||
"""Return the Qt item flags for a model index."""
|
||
if not index.isValid():
|
||
return QtCore.Qt.ItemFlag.NoItemFlags
|
||
|
||
return QtCore.Qt.ItemFlag.ItemIsEnabled | QtCore.Qt.ItemFlag.ItemIsSelectable
|
||
|
||
def headerData(self, section, orientation, role=QtCore.Qt.ItemDataRole.DisplayRole):
|
||
"""Return display data for a table header section."""
|
||
if role != QtCore.Qt.ItemDataRole.DisplayRole:
|
||
return None
|
||
|
||
if orientation == QtCore.Qt.Orientation.Horizontal:
|
||
header = self.Headers[section]
|
||
|
||
if header in ['Remark', 'State']:
|
||
return _(header)
|
||
|
||
return header
|
||
|
||
return section + 1
|
||
|
||
def routingUniqueByRow(self, row: int):
|
||
"""Return the routing unique by row value used by the routing profiles model."""
|
||
return list(Storage.UserRoutings().keys())[row]
|
||
|
||
def routingByRow(self, row: int):
|
||
"""Return the routing by row value used by the routing profiles model."""
|
||
return Storage.UserRoutings()[self.routingUniqueByRow(row)]
|
||
|
||
def data(self, index, role=QtCore.Qt.ItemDataRole.DisplayRole):
|
||
"""Return the data managed by the routing profiles model."""
|
||
if not index.isValid():
|
||
return None
|
||
|
||
row, column = index.row(), index.column()
|
||
|
||
if row < 0 or row >= len(Storage.UserRoutings()):
|
||
return None
|
||
|
||
routing = self.routingByRow(row)
|
||
|
||
if role in [
|
||
QtCore.Qt.ItemDataRole.DisplayRole,
|
||
QtCore.Qt.ItemDataRole.EditRole,
|
||
]:
|
||
if column == 0:
|
||
return routing.get('remark', '')
|
||
elif column == 1:
|
||
return routing.get('domainStrategy', 'AsIs')
|
||
elif column == 2:
|
||
return routingStateText(
|
||
'Enabled' if routing.get('enabled', True) else 'Disabled'
|
||
)
|
||
|
||
return None
|
||
|
||
def setData(self, index, value, role=QtCore.Qt.ItemDataRole.EditRole):
|
||
"""Update model data for the requested role."""
|
||
return False
|
||
|
||
def emitAllChanged(self):
|
||
"""Handle emit all changed for the routing profiles model."""
|
||
if self.rowCount() == 0:
|
||
return
|
||
|
||
self.dataChanged.emit(
|
||
self.index(0, 0),
|
||
self.index(self.rowCount() - 1, self.columnCount() - 1),
|
||
)
|
||
|
||
|
||
class RoutingRuleEditDialog(AppQTransientDialog):
|
||
"""Present the routing rule edit dialog."""
|
||
|
||
MatchInputHeight = 72
|
||
ShortInputWidth = 240
|
||
|
||
@staticmethod
|
||
def textEdit(text=''):
|
||
"""Return the text edit value used by the routing rule edit dialog."""
|
||
widget = RoutingTextEdit(text)
|
||
widget.setFixedHeight(RoutingRuleEditDialog.MatchInputHeight)
|
||
|
||
return widget
|
||
|
||
@staticmethod
|
||
def lineEdit(text=''):
|
||
"""Return the line edit value used by the routing rule edit dialog."""
|
||
widget = AppQLineEdit(text)
|
||
widget.setFixedHeight(RoutingRuleEditDialog.MatchInputHeight)
|
||
|
||
return widget
|
||
|
||
def __init__(self, rule: dict, parent=None):
|
||
"""Initialize the RoutingRuleEditDialog."""
|
||
super().__init__(parent)
|
||
|
||
self.rule = dict(rule)
|
||
|
||
self.setWindowTitle(_('Edit Routing Rule'))
|
||
self.setWindowModality(QtCore.Qt.WindowModality.WindowModal)
|
||
|
||
self.ruleTagEdit = self.lineEdit(self.rule.get('ruleTag', ''))
|
||
|
||
self.outboundEdit = self.lineEdit(self.rule.get('outboundTag', 'proxy'))
|
||
self.outboundEdit.setMaximumWidth(360)
|
||
|
||
self.balancerTagEdit = self.lineEdit(str(self.rule.get('balancerTag', '')))
|
||
|
||
self.networkCombo = AppQComboBox(translatable=False)
|
||
self.networkCombo.addItems(['', 'tcp', 'udp', 'tcp,udp'])
|
||
self.networkCombo.setCurrentText(self.rule.get('network', ''))
|
||
self.networkCombo.setMaximumWidth(self.ShortInputWidth)
|
||
|
||
self.portEdit = self.textEdit(str(self.rule.get('port', '')))
|
||
self.portEdit.setMaximumWidth(360)
|
||
|
||
self.sourcePortEdit = self.textEdit(str(self.rule.get('sourcePort', '')))
|
||
self.sourcePortEdit.setMaximumWidth(360)
|
||
|
||
self.localPortEdit = self.textEdit(str(self.rule.get('localPort', '')))
|
||
self.localPortEdit.setMaximumWidth(360)
|
||
|
||
self.vlessRouteEdit = self.textEdit(str(self.rule.get('vlessRoute', '')))
|
||
self.vlessRouteEdit.setMaximumWidth(360)
|
||
|
||
self.domainEdit = self.textEdit(listToText(self.rule.get('domain', [])))
|
||
self.ipEdit = self.textEdit(listToText(self.rule.get('ip', [])))
|
||
self.sourceIPEdit = self.textEdit(listToText(self.rule.get('sourceIP', [])))
|
||
self.localIPEdit = self.textEdit(listToText(self.rule.get('localIP', [])))
|
||
self.userEdit = self.textEdit(listToText(self.rule.get('user', [])))
|
||
self.protocolEdit = self.textEdit(listToText(self.rule.get('protocol', [])))
|
||
self.inboundTagEdit = self.textEdit(listToText(self.rule.get('inboundTag', [])))
|
||
self.processEdit = self.textEdit(listToText(self.rule.get('process', [])))
|
||
|
||
self.dialogBtns = AppQDialogButtonBox(QtCore.Qt.Orientation.Horizontal)
|
||
self.dialogBtns.addButton(_('OK'), AppQDialogButtonBox.ButtonRole.AcceptRole)
|
||
self.dialogBtns.addButton(
|
||
_('Cancel'),
|
||
AppQDialogButtonBox.ButtonRole.RejectRole,
|
||
)
|
||
self.dialogBtns.accepted.connect(self.accept)
|
||
self.dialogBtns.rejected.connect(self.reject)
|
||
|
||
generalLayout = QFormLayout()
|
||
generalLayout.addRow(
|
||
AppQLabel('Rule Tag', translatable=False),
|
||
self.ruleTagEdit,
|
||
)
|
||
generalLayout.addRow(
|
||
AppQLabel(_('OutBound (e.g. proxy/direct/block)')),
|
||
self.outboundEdit,
|
||
)
|
||
generalLayout.addRow(
|
||
AppQLabel('Balancer Tag', translatable=False),
|
||
self.balancerTagEdit,
|
||
)
|
||
generalLayout.addRow(
|
||
AppQLabel('Network', translatable=False),
|
||
self.networkCombo,
|
||
)
|
||
|
||
generalGroup = AppQGroupBox(
|
||
'General',
|
||
translatable=False,
|
||
)
|
||
generalGroup.setLayout(generalLayout)
|
||
|
||
destinationLayout = QFormLayout()
|
||
destinationLayout.addRow(
|
||
AppQLabel(_('Domain (one per line or comma-separated)')),
|
||
self.domainEdit,
|
||
)
|
||
destinationLayout.addRow(
|
||
AppQLabel(_('IP (one per line or comma-separated)')),
|
||
self.ipEdit,
|
||
)
|
||
destinationLayout.addRow(
|
||
AppQLabel(_('Port (comma/range, e.g. 53,443,1000-2000)')),
|
||
self.portEdit,
|
||
)
|
||
destinationLayout.addRow(
|
||
AppQLabel(_('VLESS Route (comma/range, e.g. 53,443,1000-2000)')),
|
||
self.vlessRouteEdit,
|
||
)
|
||
|
||
destinationGroup = AppQGroupBox(
|
||
'Destination Match',
|
||
translatable=False,
|
||
)
|
||
destinationGroup.setLayout(destinationLayout)
|
||
|
||
sourceLayout = QFormLayout()
|
||
sourceLayout.addRow(
|
||
AppQLabel(_('Source IP (one per line or comma-separated)')),
|
||
self.sourceIPEdit,
|
||
)
|
||
sourceLayout.addRow(
|
||
AppQLabel(_('Source Port (comma/range, e.g. 53,443,1000-2000)')),
|
||
self.sourcePortEdit,
|
||
)
|
||
sourceLayout.addRow(
|
||
AppQLabel(_('Local IP (one per line or comma-separated)')),
|
||
self.localIPEdit,
|
||
)
|
||
sourceLayout.addRow(
|
||
AppQLabel(_('Local Port (comma/range, e.g. 53,443,1000-2000)')),
|
||
self.localPortEdit,
|
||
)
|
||
|
||
sourceGroup = AppQGroupBox(
|
||
'Source / Local Match',
|
||
translatable=False,
|
||
)
|
||
sourceGroup.setLayout(sourceLayout)
|
||
|
||
identityLayout = QFormLayout()
|
||
identityLayout.addRow(
|
||
AppQLabel(_('User (one per line or comma-separated)')),
|
||
self.userEdit,
|
||
)
|
||
identityLayout.addRow(
|
||
AppQLabel(_('Inbound Tag (one per line or comma-separated)')),
|
||
self.inboundTagEdit,
|
||
)
|
||
identityLayout.addRow(
|
||
AppQLabel(_('Process (one per line or comma-separated)')),
|
||
self.processEdit,
|
||
)
|
||
identityLayout.addRow(
|
||
AppQLabel(_('Protocol (one per line or comma-separated)')),
|
||
self.protocolEdit,
|
||
)
|
||
|
||
identityGroup = AppQGroupBox(
|
||
'Identity / Process / Protocol Match',
|
||
translatable=False,
|
||
)
|
||
identityGroup.setLayout(identityLayout)
|
||
|
||
matchGrid = QGridLayout()
|
||
matchGrid.addWidget(generalGroup, 0, 0)
|
||
matchGrid.addWidget(destinationGroup, 0, 1)
|
||
matchGrid.addWidget(sourceGroup, 1, 0)
|
||
matchGrid.addWidget(identityGroup, 1, 1)
|
||
matchGrid.setColumnStretch(0, 1)
|
||
matchGrid.setColumnStretch(1, 1)
|
||
|
||
bottomLayout = QHBoxLayout()
|
||
bottomLayout.addWidget(RoutingDocumentationURL())
|
||
bottomLayout.addStretch(1)
|
||
bottomLayout.addWidget(self.dialogBtns)
|
||
|
||
layout = QVBoxLayout()
|
||
layout.addLayout(matchGrid)
|
||
layout.addLayout(bottomLayout)
|
||
|
||
self.setLayout(layout)
|
||
|
||
def setWidthAndHeight(self):
|
||
"""Apply the default size for the routing rule edit dialog."""
|
||
self.resize(int(800 * GOLDEN_RATIO), 800)
|
||
|
||
def routingRule(self):
|
||
"""Return the routing rule value used by the routing rule edit dialog."""
|
||
rule = {
|
||
'type': 'field',
|
||
'outboundTag': self.outboundEdit.text().strip() or 'proxy',
|
||
}
|
||
|
||
for key, value in [
|
||
('ruleTag', self.ruleTagEdit.text().strip()),
|
||
('network', self.networkCombo.currentText().strip()),
|
||
('port', self.portEdit.toPlainText().strip()),
|
||
('sourcePort', self.sourcePortEdit.toPlainText().strip()),
|
||
('localPort', self.localPortEdit.toPlainText().strip()),
|
||
('vlessRoute', self.vlessRouteEdit.toPlainText().strip()),
|
||
('balancerTag', self.balancerTagEdit.text().strip()),
|
||
]:
|
||
if value:
|
||
rule[key] = value
|
||
|
||
for key, widget in [
|
||
('domain', self.domainEdit),
|
||
('ip', self.ipEdit),
|
||
('sourceIP', self.sourceIPEdit),
|
||
('localIP', self.localIPEdit),
|
||
('user', self.userEdit),
|
||
('protocol', self.protocolEdit),
|
||
('inboundTag', self.inboundTagEdit),
|
||
('process', self.processEdit),
|
||
]:
|
||
values = valuesToList(widget.toPlainText())
|
||
|
||
if values:
|
||
rule[key] = values
|
||
|
||
return rule
|
||
|
||
|
||
class RoutingRemarkEditDialog(AppQTransientDialog):
|
||
"""Present the routing remark edit dialog."""
|
||
|
||
def __init__(self, remark: str, parent=None):
|
||
"""Initialize the RoutingRemarkEditDialog."""
|
||
super().__init__(parent)
|
||
|
||
self.setWindowTitle(_('Edit Routing Remark'))
|
||
self.setWindowModality(QtCore.Qt.WindowModality.WindowModal)
|
||
|
||
self.remarkEdit = AppQLineEdit(remark)
|
||
|
||
self.dialogBtns = AppQDialogButtonBox(QtCore.Qt.Orientation.Horizontal)
|
||
self.dialogBtns.addButton(_('OK'), AppQDialogButtonBox.ButtonRole.AcceptRole)
|
||
self.dialogBtns.addButton(
|
||
_('Cancel'),
|
||
AppQDialogButtonBox.ButtonRole.RejectRole,
|
||
)
|
||
self.dialogBtns.accepted.connect(self.accept)
|
||
self.dialogBtns.rejected.connect(self.reject)
|
||
|
||
layout = QFormLayout()
|
||
layout.addRow(AppQLabel(_('Remark')), self.remarkEdit)
|
||
layout.addRow(self.dialogBtns)
|
||
|
||
self.setLayout(layout)
|
||
|
||
def setWidthAndHeight(self):
|
||
"""Apply the default size for the routing remark edit dialog."""
|
||
self.resize(420, 120)
|
||
|
||
def remark(self):
|
||
"""Return the remark value used by the routing remark edit dialog."""
|
||
return self.remarkEdit.text().strip()
|
||
|
||
|
||
class RoutingProfileEditDialog(AppQTransientDialog):
|
||
"""Present the routing profile edit dialog."""
|
||
|
||
def __init__(self, parent=None):
|
||
"""Initialize the RoutingProfileEditDialog."""
|
||
super().__init__(parent)
|
||
|
||
self.setWindowTitle(_('Add Routing'))
|
||
self.setWindowModality(QtCore.Qt.WindowModality.WindowModal)
|
||
|
||
self.remarkEdit = AppQLineEdit(_('New Routing'))
|
||
|
||
self.domainStrategyCombo = AppQComboBox(translatable=False)
|
||
self.domainStrategyCombo.addItems(DOMAIN_STRATEGIES)
|
||
self.domainStrategyCombo.setCurrentText('AsIs')
|
||
|
||
self.enabledCombo = AppQComboBox(translatable=False)
|
||
addRoutingStateItems(self.enabledCombo)
|
||
self.enabledCombo.setCurrentIndex(ROUTING_STATES.index('Enabled'))
|
||
|
||
self.dialogBtns = AppQDialogButtonBox(QtCore.Qt.Orientation.Horizontal)
|
||
self.dialogBtns.addButton(_('OK'), AppQDialogButtonBox.ButtonRole.AcceptRole)
|
||
self.dialogBtns.addButton(
|
||
_('Cancel'),
|
||
AppQDialogButtonBox.ButtonRole.RejectRole,
|
||
)
|
||
self.dialogBtns.accepted.connect(self.accept)
|
||
self.dialogBtns.rejected.connect(self.reject)
|
||
|
||
layout = QFormLayout()
|
||
layout.addRow(AppQLabel(_('Remark')), self.remarkEdit)
|
||
layout.addRow(
|
||
AppQLabel('Domain Strategy', translatable=False),
|
||
self.domainStrategyCombo,
|
||
)
|
||
layout.addRow(AppQLabel(_('State')), self.enabledCombo)
|
||
layout.addRow(self.dialogBtns)
|
||
|
||
self.setLayout(layout)
|
||
|
||
def setWidthAndHeight(self):
|
||
"""Apply the default size for the routing profile edit dialog."""
|
||
self.resize(460, 160)
|
||
|
||
def routing(self):
|
||
"""Return the routing value used by the routing profile edit dialog."""
|
||
return {
|
||
'remark': self.remarkEdit.text().strip() or _('New Routing'),
|
||
'domainStrategy': self.domainStrategyCombo.currentText(),
|
||
'enabled': comboCurrentData(self.enabledCombo, 'Enabled') == 'Enabled',
|
||
'rules': [],
|
||
}
|
||
|
||
|
||
class RoutingRulesQListWidget(AppQListWidget):
|
||
"""Provide the routing rules Qt list widget."""
|
||
|
||
editRequested = QtCore.Signal()
|
||
|
||
def __init__(self, routing: dict, parent=None):
|
||
"""Initialize the RoutingRulesQListWidget."""
|
||
super().__init__(parent)
|
||
|
||
self.routing = routing
|
||
|
||
self.setAlternatingRowColors(True)
|
||
self.setSelectionBehavior(AppQListWidget.SelectionBehavior.SelectRows)
|
||
self.setSelectionMode(AppQListWidget.SelectionMode.ExtendedSelection)
|
||
self.itemDoubleClicked.connect(self._requestEdit)
|
||
|
||
self.flushAll()
|
||
|
||
@QtCore.Slot(QListWidgetItem)
|
||
def _requestEdit(self, _item):
|
||
"""Forward a row double-click without retaining a Python closure."""
|
||
self.editRequested.emit()
|
||
|
||
def rules(self):
|
||
"""Return the rules value used by the routing rules Qt list widget."""
|
||
rules = self.routing.setdefault('rules', list())
|
||
|
||
if not isinstance(rules, list):
|
||
self.routing['rules'] = rules = list()
|
||
|
||
return rules
|
||
|
||
def ruleAt(self, index: int):
|
||
"""Return the rule at value used by the routing rules Qt list widget."""
|
||
return self.rules()[index]
|
||
|
||
def ruleText(self, rule: dict) -> str:
|
||
"""Return the rule text value used by the routing rules Qt list widget."""
|
||
name, outbound, domains, ips = (
|
||
rule.get('ruleTag', '') or 'Untitled Rule',
|
||
rule.get('outboundTag', 'proxy'),
|
||
len(rule.get('domain', [])),
|
||
len(rule.get('ip', [])),
|
||
)
|
||
|
||
return f'{name} -> {outbound} ({domains} domains, {ips} IPs)'
|
||
|
||
def selectedRuleText(self):
|
||
"""Select ed rule text."""
|
||
indexes = self.selectedIndex
|
||
|
||
if not indexes:
|
||
return ''
|
||
|
||
return self.ruleText(self.ruleAt(indexes[0]))
|
||
|
||
def appendRule(self, rule: dict):
|
||
"""Append rule."""
|
||
self.rules().append(rule)
|
||
self.flushAll()
|
||
|
||
def setRule(self, index: int, rule: dict):
|
||
"""Set rule."""
|
||
self.rules()[index] = rule
|
||
self.flushAll()
|
||
|
||
def deleteRules(self, indexes: list[int]):
|
||
"""Delete rules."""
|
||
for i in range(len(indexes)):
|
||
self.rules().pop(indexes[i] - i)
|
||
|
||
self.flushAll()
|
||
|
||
def flushAll(self):
|
||
"""Refresh all."""
|
||
self.clear()
|
||
|
||
for rule in self.rules():
|
||
self.addItem(self.ruleText(rule))
|
||
|
||
|
||
class RoutingRulesDialog(AppQTransientDialog):
|
||
"""Present the routing rules dialog."""
|
||
|
||
def __init__(self, routing: dict, parent=None):
|
||
"""Initialize the RoutingRulesDialog."""
|
||
super().__init__(parent)
|
||
|
||
self.routing = routing
|
||
self.setWindowTitle(_('Routing Rules'))
|
||
self.setWindowModality(QtCore.Qt.WindowModality.WindowModal)
|
||
|
||
self.listWidget = RoutingRulesQListWidget(self.routing, parent=self)
|
||
self.listWidget.editRequested.connect(self.editRule)
|
||
|
||
self.addButton = AppQPushButton(
|
||
_('Add'),
|
||
icon=bootstrapIcon('plus-lg.svg'),
|
||
)
|
||
self.addButton.clicked.connect(self.addRule)
|
||
|
||
self.deleteButton = AppQPushButton(
|
||
_('Delete'),
|
||
icon=bootstrapIcon('trash.svg'),
|
||
)
|
||
self.deleteButton.clicked.connect(self.deleteRule)
|
||
|
||
self.closeWindowButton = AppQPushButton(
|
||
_('Close Window'),
|
||
icon=bootstrapIcon('window-x.svg'),
|
||
)
|
||
self.closeWindowButton.clicked.connect(self.close)
|
||
|
||
for button in (
|
||
self.addButton,
|
||
self.deleteButton,
|
||
self.closeWindowButton,
|
||
):
|
||
button.setAutoDefault(False)
|
||
button.setDefault(False)
|
||
|
||
actionLayout = QHBoxLayout()
|
||
actionLayout.setContentsMargins(0, 0, 0, 0)
|
||
actionLayout.setSpacing(8)
|
||
actionLayout.addWidget(self.addButton)
|
||
actionLayout.addWidget(self.deleteButton)
|
||
actionLayout.addStretch(1)
|
||
actionLayout.addWidget(self.closeWindowButton)
|
||
|
||
layout = QVBoxLayout()
|
||
layout.setContentsMargins(20, 18, 20, 20)
|
||
layout.setSpacing(14)
|
||
layout.addLayout(actionLayout)
|
||
layout.addWidget(self.listWidget)
|
||
|
||
self.setLayout(layout)
|
||
|
||
def setWidthAndHeight(self):
|
||
"""Apply the default size for the routing rules dialog."""
|
||
self.setFixedSize(760, 470)
|
||
|
||
def addRule(self):
|
||
"""Add rule."""
|
||
rule = {'type': 'field', 'outboundTag': 'proxy', 'ruleTag': 'New Rule'}
|
||
# This editor is subordinate to the transient rules dialog. Parenting
|
||
# it prevents an asynchronous child from outliving its owner and later
|
||
# invoking a callback on a deleted list widget.
|
||
dialog = RoutingRuleEditDialog(rule, parent=self)
|
||
|
||
def handleResultCode(code):
|
||
"""Handle result code."""
|
||
if code == PySide6Legacy.enumValueWrapper(AppQDialog.DialogCode.Accepted):
|
||
self.listWidget.appendRule(dialog.routingRule())
|
||
|
||
dialog.finished.connect(handleResultCode)
|
||
dialog.open()
|
||
|
||
def editRule(self):
|
||
"""Handle edit rule for the routing rules dialog."""
|
||
indexes = self.listWidget.selectedIndex
|
||
|
||
if len(indexes) != 1:
|
||
return
|
||
|
||
index = indexes[0]
|
||
dialog = RoutingRuleEditDialog(self.listWidget.ruleAt(index), parent=self)
|
||
|
||
def handleResultCode(_index, code):
|
||
"""Handle result code."""
|
||
if code == PySide6Legacy.enumValueWrapper(AppQDialog.DialogCode.Accepted):
|
||
self.listWidget.setRule(_index, dialog.routingRule())
|
||
|
||
dialog.finished.connect(functools.partial(handleResultCode, index))
|
||
dialog.open()
|
||
|
||
def deleteRule(self):
|
||
"""Delete rule."""
|
||
indexes = self.listWidget.selectedIndex
|
||
|
||
if len(indexes) == 0:
|
||
return
|
||
|
||
def handleResultCode(_indexes, code):
|
||
"""Handle result code."""
|
||
if code == PySide6Legacy.enumValueWrapper(
|
||
AppQMessageBox.StandardButton.Yes
|
||
):
|
||
self.listWidget.deleteRules(_indexes)
|
||
else:
|
||
# Do not delete
|
||
pass
|
||
|
||
if PLATFORM == 'Windows':
|
||
# Windows
|
||
mbox = MBoxQuestionDelete(icon=AppQMessageBox.Icon.Question)
|
||
else:
|
||
# macOS & linux
|
||
mbox = MBoxQuestionDelete(
|
||
icon=AppQMessageBox.Icon.Question,
|
||
parent=self,
|
||
)
|
||
mbox.setWindowModality(QtCore.Qt.WindowModality.WindowModal)
|
||
|
||
mbox.isMulti = bool(len(indexes) > 1)
|
||
mbox.possibleRemark = self.listWidget.selectedRuleText()
|
||
mbox.setText(mbox.customText())
|
||
mbox.finished.connect(functools.partial(handleResultCode, indexes))
|
||
|
||
# Show the MessageBox asynchronously
|
||
mbox.open()
|
||
|
||
|
||
class UserRoutingQTableViewHorizontalHeader(AppQHeaderView):
|
||
"""Provide the user routing Qt table view horizontal table header."""
|
||
|
||
def __init__(self, *args, **kwargs):
|
||
"""Initialize the UserRoutingQTableViewHorizontalHeader."""
|
||
super().__init__(QtCore.Qt.Orientation.Horizontal, *args, **kwargs)
|
||
|
||
|
||
class UserRoutingTableView(Mixins.QTranslatable, AppQTableView):
|
||
"""Represent user routing table view."""
|
||
|
||
RowHeight = 42
|
||
|
||
def __init__(self, parent=None):
|
||
"""Initialize the UserRoutingTableView."""
|
||
super().__init__(parent)
|
||
|
||
self.sourceModel = RoutingProfilesModel(parent=self)
|
||
self.setModel(self.sourceModel)
|
||
self.setHorizontalHeader(
|
||
UserRoutingQTableViewHorizontalHeader(
|
||
parent=self,
|
||
sectionSizeSettingsName='UserRoutingHeaderViewState',
|
||
)
|
||
)
|
||
self.setSelectionBehavior(QAbstractItemView.SelectionBehavior.SelectRows)
|
||
self.setSelectionMode(QAbstractItemView.SelectionMode.ExtendedSelection)
|
||
self.setDragDropMode(QAbstractItemView.DragDropMode.NoDragDrop)
|
||
self.setEditTriggers(QAbstractItemView.EditTrigger.NoEditTriggers)
|
||
self.setSortingEnabled(False)
|
||
self.doubleClicked.connect(self.editSelectedRules)
|
||
|
||
self.setDefaultRowHeight(self.RowHeight)
|
||
self.configureHeader()
|
||
self.flushAll()
|
||
|
||
def configureHeader(self):
|
||
"""Configure header."""
|
||
header = self.horizontalHeader()
|
||
header.setSectionsMovable(True)
|
||
header.setFirstSectionMovable(True)
|
||
header.setCustomSectionResizeMode()
|
||
header.restoreSectionSize()
|
||
|
||
@property
|
||
def selectedIndex(self):
|
||
"""Return the selected index value."""
|
||
return sorted(
|
||
list(set(index.row() for index in self.selectionModel().selectedRows()))
|
||
)
|
||
|
||
def routingUniqueByRow(self, row):
|
||
"""Return the routing unique by row value used by the user routing table view."""
|
||
return self.sourceModel.routingUniqueByRow(row)
|
||
|
||
def flushItem(self, row: int, column: int):
|
||
"""Refresh item."""
|
||
index = self.sourceModel.index(row, column)
|
||
|
||
if column == 1:
|
||
combo = AppQComboBox(parent=self.viewport(), translatable=False)
|
||
combo.addItems(DOMAIN_STRATEGIES)
|
||
combo.setMinimumWidth(0)
|
||
combo.setCurrentText(
|
||
self.sourceModel.routingByRow(row).get('domainStrategy', 'AsIs')
|
||
)
|
||
combo.currentTextChanged.connect(
|
||
lambda text, _row=row: self.setDomainStrategy(_row, text)
|
||
)
|
||
|
||
self.setIndexWidget(index, combo)
|
||
elif column == 2:
|
||
combo = AppQComboBox(parent=self.viewport(), translatable=False)
|
||
addRoutingStateItems(combo)
|
||
combo.setMinimumWidth(0)
|
||
combo.setCurrentIndex(
|
||
ROUTING_STATES.index(
|
||
'Enabled'
|
||
if self.sourceModel.routingByRow(row).get('enabled', True)
|
||
else 'Disabled'
|
||
)
|
||
)
|
||
combo.currentIndexChanged.connect(
|
||
lambda _index, _row=row, _combo=combo: self.setEnabled(
|
||
_row,
|
||
comboCurrentData(_combo, 'Enabled'),
|
||
)
|
||
)
|
||
|
||
self.setIndexWidget(index, combo)
|
||
|
||
def flushRow(self, row: int):
|
||
"""Refresh row."""
|
||
for column in range(self.sourceModel.columnCount()):
|
||
self.flushItem(row, column)
|
||
|
||
def flushAll(self):
|
||
"""Refresh all."""
|
||
self.sourceModel.emitAllChanged()
|
||
|
||
for row in range(self.sourceModel.rowCount()):
|
||
self.flushRow(row)
|
||
|
||
def retranslate(self):
|
||
"""Refresh translated text for the user routing table view."""
|
||
self.sourceModel.headerDataChanged.emit(
|
||
QtCore.Qt.Orientation.Horizontal,
|
||
0,
|
||
self.sourceModel.columnCount() - 1,
|
||
)
|
||
self.flushAll()
|
||
|
||
def setDomainStrategy(self, row: int, text: str):
|
||
"""Set domain strategy."""
|
||
if row < 0 or row >= self.sourceModel.rowCount():
|
||
return
|
||
|
||
self.sourceModel.routingByRow(row)['domainStrategy'] = text
|
||
self.sourceModel.emitAllChanged()
|
||
|
||
def setEnabled(self, row: int, state: str):
|
||
"""Set enabled."""
|
||
if row < 0 or row >= self.sourceModel.rowCount():
|
||
return
|
||
|
||
self.sourceModel.routingByRow(row)['enabled'] = state == 'Enabled'
|
||
self.sourceModel.emitAllChanged()
|
||
|
||
def appendNewItem(self):
|
||
"""Append new item."""
|
||
dialog = RoutingProfileEditDialog(parent=self)
|
||
|
||
def handleResultCode(code):
|
||
"""Handle result code."""
|
||
if code != PySide6Legacy.enumValueWrapper(AppQDialog.DialogCode.Accepted):
|
||
return
|
||
|
||
row = self.sourceModel.rowCount()
|
||
unique = str(uuid.uuid4())
|
||
|
||
self.sourceModel.beginInsertRows(QtCore.QModelIndex(), row, row)
|
||
|
||
Storage.UserRoutings()[unique] = dialog.routing()
|
||
|
||
self.sourceModel.endInsertRows()
|
||
self.flushRow(row)
|
||
|
||
dialog.finished.connect(handleResultCode)
|
||
dialog.open()
|
||
|
||
def deleteSelectedItem(self):
|
||
"""Delete selected item."""
|
||
indexes = self.selectedIndex
|
||
|
||
if not indexes:
|
||
# Nothing selected. Do nothing
|
||
return
|
||
|
||
def handleResultCode(_indexes, code):
|
||
"""Handle result code."""
|
||
if code != PySide6Legacy.enumValueWrapper(
|
||
AppQMessageBox.StandardButton.Yes
|
||
):
|
||
return
|
||
|
||
for i in range(len(_indexes)):
|
||
deleteIndex = _indexes[i] - i
|
||
deleteUnique = self.routingUniqueByRow(deleteIndex)
|
||
|
||
self.sourceModel.beginRemoveRows(
|
||
QtCore.QModelIndex(),
|
||
deleteIndex,
|
||
deleteIndex,
|
||
)
|
||
|
||
Storage.UserRoutings().pop(deleteUnique)
|
||
|
||
self.sourceModel.endRemoveRows()
|
||
|
||
self.flushAll()
|
||
|
||
if PLATFORM == 'Windows':
|
||
# Windows
|
||
mbox = MBoxQuestionDelete(icon=AppQMessageBox.Icon.Question)
|
||
else:
|
||
# macOS & linux
|
||
mbox = MBoxQuestionDelete(
|
||
icon=AppQMessageBox.Icon.Question,
|
||
parent=self,
|
||
)
|
||
mbox.setWindowModality(QtCore.Qt.WindowModality.WindowModal)
|
||
|
||
mbox.isMulti = bool(len(indexes) > 1)
|
||
mbox.possibleRemark = self.sourceModel.data(
|
||
self.sourceModel.index(indexes[0], 0),
|
||
QtCore.Qt.ItemDataRole.DisplayRole,
|
||
)
|
||
mbox.setText(mbox.customText())
|
||
mbox.finished.connect(functools.partial(handleResultCode, indexes))
|
||
|
||
# Show the MessageBox asynchronously
|
||
mbox.open()
|
||
|
||
def renameSelectedItem(self):
|
||
"""Handle rename selected item for the user routing table view."""
|
||
indexes = self.selectedIndex
|
||
|
||
if not indexes:
|
||
# Nothing selected. Do nothing
|
||
return
|
||
|
||
if len(indexes) > 1:
|
||
# Multiple items selected. Do nothing
|
||
return
|
||
|
||
routing = self.sourceModel.routingByRow(indexes[0])
|
||
|
||
dialog = RoutingRemarkEditDialog(routing.get('remark', ''), parent=self)
|
||
|
||
def handleResultCode(code):
|
||
"""Handle result code."""
|
||
if code != PySide6Legacy.enumValueWrapper(AppQDialog.DialogCode.Accepted):
|
||
return
|
||
|
||
remark = dialog.remark()
|
||
|
||
if remark:
|
||
routing['remark'] = remark
|
||
self.sourceModel.emitAllChanged()
|
||
|
||
dialog.finished.connect(handleResultCode)
|
||
dialog.open()
|
||
|
||
def previewSelectedItem(self):
|
||
"""Handle preview selected item for the user routing table view."""
|
||
indexes = self.selectedIndex
|
||
|
||
if len(indexes) != 1:
|
||
return
|
||
|
||
routing = copy.deepcopy(self.sourceModel.routingByRow(indexes[0]))
|
||
|
||
dialog = RoutingPreviewDialog(routing, parent=self)
|
||
dialog.open()
|
||
|
||
def editSelectedRules(self):
|
||
"""Handle edit selected rules for the user routing table view."""
|
||
indexes = self.selectedIndex
|
||
|
||
if not indexes:
|
||
# Nothing selected. Do nothing
|
||
return
|
||
|
||
if len(indexes) > 1:
|
||
# Multiple items selected. Do nothing
|
||
return
|
||
|
||
routing = self.sourceModel.routingByRow(indexes[0])
|
||
|
||
dialog = RoutingRulesDialog(routing, parent=self)
|
||
dialog.finished.connect(self._rulesDialogFinished)
|
||
dialog.open()
|
||
|
||
@QtCore.Slot(int)
|
||
def _rulesDialogFinished(self, _code):
|
||
"""Refresh routing presentation after the rules dialog finishes."""
|
||
self.flushAll()
|
||
|
||
|
||
class XrayRoutingWindow(AppQMainWindow):
|
||
"""Present the user routing window."""
|
||
|
||
DEFAULT_WINDOW_SIZE = QtCore.QSize(980, 560)
|
||
|
||
def __init__(self, *args, **kwargs):
|
||
"""Initialize the Xray routing editor window."""
|
||
super().__init__(*args, **kwargs)
|
||
|
||
self.setWindowTitle(_('Edit Routing'))
|
||
|
||
self.tableView = UserRoutingTableView(parent=self)
|
||
|
||
self.addButton, self.previewButton, self.renameButton, self.deleteButton = (
|
||
AppQPushButton(
|
||
_('Add'),
|
||
icon=bootstrapIcon('plus-lg.svg'),
|
||
),
|
||
AppQPushButton(
|
||
_('Preview'),
|
||
icon=bootstrapIcon('file-earmark-text.svg'),
|
||
),
|
||
AppQPushButton(
|
||
_('Rename'),
|
||
icon=bootstrapIcon('pencil-square.svg'),
|
||
),
|
||
AppQPushButton(
|
||
_('Delete'),
|
||
icon=bootstrapIcon('trash.svg'),
|
||
),
|
||
)
|
||
|
||
self.addButton.clicked.connect(self.tableView.appendNewItem)
|
||
self.previewButton.clicked.connect(self.tableView.previewSelectedItem)
|
||
self.renameButton.clicked.connect(self.tableView.renameSelectedItem)
|
||
self.deleteButton.clicked.connect(self.tableView.deleteSelectedItem)
|
||
|
||
actionLayout = QHBoxLayout()
|
||
actionLayout.setContentsMargins(0, 0, 0, 0)
|
||
actionLayout.setSpacing(8)
|
||
actionLayout.addWidget(self.addButton)
|
||
actionLayout.addWidget(self.previewButton)
|
||
actionLayout.addWidget(self.renameButton)
|
||
actionLayout.addWidget(self.deleteButton)
|
||
actionLayout.addStretch(1)
|
||
|
||
centralWidget = QWidget()
|
||
centralWidget.setObjectName('UserRoutingWindowContent')
|
||
|
||
layout = QVBoxLayout(centralWidget)
|
||
layout.setContentsMargins(20, 18, 20, 20)
|
||
layout.setSpacing(14)
|
||
layout.addLayout(actionLayout)
|
||
layout.addWidget(self.tableView)
|
||
|
||
self.setCentralWidget(centralWidget)
|
||
|
||
def setWidthAndHeight(self):
|
||
"""Apply the default size for the user routing window."""
|
||
if AppSettings.get('UserRoutingWindowGeometry') is None:
|
||
self.resize(XrayRoutingWindow.DEFAULT_WINDOW_SIZE)
|
||
else:
|
||
if PLATFORM == 'Darwin':
|
||
self.resize(XrayRoutingWindow.DEFAULT_WINDOW_SIZE)
|
||
else:
|
||
try:
|
||
self.restoreGeometry(AppSettings.get('UserRoutingWindowGeometry'))
|
||
except Exception:
|
||
# Any non-exit exceptions
|
||
|
||
self.resize(XrayRoutingWindow.DEFAULT_WINDOW_SIZE)
|
||
|
||
try:
|
||
self.restoreState(AppSettings.get('UserRoutingWindowState'))
|
||
except Exception:
|
||
# Any non-exit exceptions
|
||
|
||
pass
|
||
|
||
def cleanup(self):
|
||
"""Release resources owned by the user routing window."""
|
||
AppSettings.set('UserRoutingWindowGeometry', self.saveGeometry())
|
||
AppSettings.set('UserRoutingWindowState', self.saveState())
|