frappy/frappy/gui/mainwindow.py
Jens Krüger 318b3ad412 Update copyright year
Change-Id: I7fe65e46639c2d8948fa93303ee9b14393e8bfca
2024-09-13 08:59:40 +02:00

301 lines
11 KiB
Python

# *****************************************************************************
# Copyright (c) 2015-2024 by the authors, see LICENSE
#
# 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 2 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, write to the Free Software Foundation, Inc.,
# 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
# Module authors:
# Alexander Lenz <alexander.lenz@frm2.tum.de>
# Alexander Zaft <a.zaft@fz-juelich.de>
#
# *****************************************************************************
from frappy.gui.qt import QAction, QInputDialog, QKeySequence, QMainWindow, \
QMessageBox, QObject, QPixmap, QSettings, QShortcut, Qt, QWidget, \
pyqtSignal, pyqtSlot
import frappy.version
from frappy.gui.connection import QSECNode
from frappy.gui.logwindow import LogWindow, LogWindowHandler
from frappy.gui.nodewidget import NodeWidget
from frappy.gui.tabwidget import TearOffTabWidget
from frappy.gui.util import Colors, is_light_theme, loadUi
class Greeter(QWidget):
recentClearBtn = pyqtSignal()
addnodes = pyqtSignal(list)
def __init__(self, parent=None):
super().__init__(parent)
loadUi(self, 'greeter.ui')
if not is_light_theme(self.palette()):
# maybe change it at runtime instead of second file?
self.logoLabel.setPixmap(QPixmap(':/icons/logo_subtitle_light'))
self.loadRecent()
self.recentNodes.itemDoubleClicked.connect(self.recentNodeDoubleClicked)
self.shortcut = QShortcut(QKeySequence("Return"), self.recentNodes,
self.on_connectRecentButton_clicked,
context=Qt.ShortcutContext.WidgetWithChildrenShortcut)
def loadRecent(self):
self.recentNodes.clear()
settings = QSettings()
recent = settings.value('recent', [])
for host in recent:
self.recentNodes.addItem(host)
@pyqtSlot()
def on_ClearButton_clicked(self):
self.recentClearBtn.emit()
@pyqtSlot()
def on_connectRecentButton_clicked(self):
selected = self.recentNodes.selectedItems()
hosts = [item.text() for item in selected]
self.addnodes.emit(hosts)
@pyqtSlot()
def on_AddSECNodeButton_clicked(self):
self.addnodes.emit([self.secnodeEdit.text()
or self.secnodeEdit.placeholderText()])
def recentNodeDoubleClicked(self, item):
self.addnodes.emit([item.text()])
class HistorySerializer(QObject):
def __init__(self, parent=None):
super().__init__(parent)
settings = QSettings()
self.history = settings.value('consoleHistory', [])
def append(self, text):
self.history.append(text)
def saveHistory(self):
settings = QSettings()
settings.setValue('consoleHistory', self.history)
class MainWindow(QMainWindow):
recentNodesChanged = pyqtSignal()
def __init__(self, hosts, logger, parent=None):
super().__init__(parent)
# centralized handling for logging and cmd-history
self.loghandler = LogWindowHandler()
self.log = logger
self.log.addHandler(self.loghandler)
self.logwin = None
self.historySerializer = HistorySerializer()
loadUi(self, 'mainwin.ui')
Colors._setPalette(self.palette())
self.toolBar.hide()
self.buildRecentNodeMenu()
self.recentNodesChanged.connect(self.buildRecentNodeMenu)
settings = QSettings()
self.actionHighlightAnimation.blockSignals(True)
self.actionHighlightAnimation.setChecked(
settings.value('highlightanimation', True, bool))
self.actionHighlightAnimation.blockSignals(False)
# what is which?
self.tab = TearOffTabWidget(self, self, self, self)
self.tab.setTabsClosable(True)
self.tab.tabCloseRequested.connect(self._handleTabClose)
self.shortcut = QShortcut(QKeySequence("Ctrl+W"), self,
self.tab.close_current)
self.setCentralWidget(self.tab)
greeter = Greeter(self)
greeter.addnodes.connect(self.addNodes)
greeter.recentClearBtn.connect(self.on_actionClear_triggered)
self.recentNodesChanged.connect(greeter.loadRecent)
self.tab.addPanel(greeter, 'Welcome')
self._nodeWidgets = {}
# add localhost (if available) and SEC nodes given as arguments
self.addNodes(hosts)
@pyqtSlot()
def on_actionAbout_triggered(self):
try:
ver = frappy.version.get_version()
except Exception:
ver = 'unknown'
QMessageBox.about(
self, 'About Frappy GUI',
f'''
<h2>About Frappy GUI</h2>
<p>A graphical client for the SECoP protocol.</p>
<p>© 2017-2024 Frappy contributors:</p>
<ul>
<li><a href="mailto:markus.zolliker@psi.ch">Markus Zolliker</a></li>
<li><a href="mailto:enrico.faulhaber@frm2.tum.de">Enrico Faulhaber</a></li>
<li><a href="mailto:a.zaft@fz-juelich.de">Alexander Zaft</a></li>
<li><a href="mailto:g.brandl@fz-juelich.de">Georg Brandl</a></li>
</ul>
<p>Frappy is available under the
<a href="http://www.gnu.org/licenses/gpl.html">GNU General
Public License</a> version 2.0 or later.</p>
<p style="font-weight: bold">Version: v{ver}</p>
''')
@pyqtSlot()
def on_actionAdd_SEC_node_triggered(self):
host, ok = QInputDialog.getText(
self, 'Add SEC node',
'Enter SEC node URI (or just hostname:port):')
if not ok:
return
self.addNode(host)
@pyqtSlot()
def on_actionReconnect_triggered(self):
self.tab.currentWidget().getSecNode().reconnect()
def on_actionDetailed_View_toggled(self, toggled):
self._rebuildAdvanced(toggled)
def on_actionShow_Logs_toggled(self, active):
if not active and self.logwin:
self.logwin.close()
self.logwin = None
return
self.logwin = LogWindow(self.loghandler, self)
self.logwin.closed.connect(self.onLogWindowClose)
self.logwin.show()
def onLogWindowClose(self):
if self.actionShow_Logs.isChecked():
self.actionShow_Logs.toggle()
self.logwin = None
def on_actionHighlightAnimation_toggled(self, toggled):
settings = QSettings()
settings.setValue('highlightanimation', toggled)
# def on_validateCheckBox_toggled(self, state):
# print('validateCheckBox_toggled', state)
# def on_visibilityComboBox_activated(self, level):
# if level in ['user', 'admin', 'expert']:
# print('visibility Level now:', level)
def addNodes(self, hosts):
for host in hosts:
self.addNode(host)
def addNode(self, host):
try:
self.log.info('Trying to connect to %s', host)
self._addNode(host)
except Exception as e:
self.log.error('error in addNode: %r', e)
QMessageBox.critical(self.parent(),
f'Connecting to {host} failed!', str(e))
def _addNode(self, host):
prevWidget = self._nodeWidgets.get(host)
if prevWidget:
self.tab.setCurrentWidget(prevWidget)
return
# create client
node = QSECNode(host, self.log, parent=self)
nodeWidget = NodeWidget(node)
nodeWidget.setParent(self)
nodeWidget.consoleTextSent.connect(self.historySerializer.append)
nodeWidget._rebuildAdvanced(self.actionDetailed_View.isChecked())
# Node and NodeWidget created without error
self.tab.addTab(nodeWidget, node.equipmentId)
self._nodeWidgets[host] = nodeWidget
self.tab.setCurrentWidget(nodeWidget)
node.descriptionChanged.connect(self._descriptiveDataChange)
# add to recent nodes
settings = QSettings()
recent = settings.value('recent', [])
if host in recent:
recent.remove(host)
recent.insert(0, host)
settings.setValue('recent', recent)
self.recentNodesChanged.emit()
def buildRecentNodeMenu(self):
settings = QSettings()
recent = settings.value('recent', [])
menu = self.menuRecent_SECNodes
for action in list(menu.actions()):
if action.isSeparator():
break
menu.removeAction(action)
# save reference so they are not deleted
self.recentNodeActions = []
for host in recent:
a = QAction(host)
a.triggered.connect(lambda _t, h=host: self.addNode(h))
self.recentNodeActions.append(a)
menu.insertActions(action, self.recentNodeActions)
def on_actionClear_triggered(self):
"""clears recent SECNode menu"""
settings = QSettings()
settings.remove('recent')
self.recentNodesChanged.emit()
def _handleTabClose(self, index):
nodeWidget = self.tab.widget(index)
try:
node = nodeWidget.getSecNode()
except AttributeError:
# Closing the greeter
self.log.debug("Greeter Tab closed")
else:
# disconnect node from all events
node.terminate_connection()
self._nodeWidgets.pop(node.contactPoint)
self.log.debug("Closing tab with node %s", node.nodename)
self.tab.removeTab(index)
def _descriptiveDataChange(self, host, node):
old_widget = self._nodeWidgets[host]
new_widget = NodeWidget(node)
curr_idx = self.tab.currentIndex()
index = self.tab.indexOf(old_widget)
self._nodeWidgets[host] = new_widget
self.tab.replace_widget(old_widget, new_widget, title=node.equipmentId)
if curr_idx == index:
self.tab.setCurrentIndex(curr_idx)
def _rebuildAdvanced(self, advanced):
if advanced:
pass
else:
pass
for widget in self._nodeWidgets.values():
widget._rebuildAdvanced(advanced)
def _onQuit(self):
for widget in self._nodeWidgets.values():
# this is only qt signals deconnecting!
widget.getSecNode().terminate_connection()
self.historySerializer.saveHistory()