""" Main application window. """ import sys import os import re import json import base64 import logging from PyQt5.QtWidgets import QWidget, QVBoxLayout, QMenuBar, QAction, QLabel, QMessageBox from PyQt5.QtWebEngineWidgets import QWebEngineView, QWebEngineProfile, QWebEnginePage from PyQt5.QtWebChannel import QWebChannel from PyQt5.QtGui import QDesktopServices, QIcon from PyQt5.QtCore import Qt, QUrl, QMargins, pyqtSlot, QVariant from vasl_templates.webapp.config.constants import APP_NAME, APP_VERSION, IS_FROZEN from vasl_templates.main import app_settings from vasl_templates.web_channel import WebChannelHandler from vasl_templates.utils import catch_exceptions _CONSOLE_SOURCE_REGEX = re.compile( r"^http://.+?/static/(.*)$" ) # --------------------------------------------------------------------- class AppWebPage( QWebEnginePage ): """Application web page.""" def acceptNavigationRequest( self, url, nav_type, is_mainframe ): #pylint: disable=unused-argument """Called when a link is clicked.""" if url.host() in ("localhost","127.0.0.1"): if "/asl-rulebook2/" not in url.url(): # nb: asl-rulebook2 links are routed through our webapp return True if not is_mainframe: # NOTE: We get here if we're in a child frame (e.g. Google Maps). However, we can't just ignore # these requests, because the help is also in a frame, and we want links to open in an external browser. # Sigh... if "google.com/maps" in url.url(): return True QDesktopServices.openUrl( url ) return False def javaScriptConsoleMessage( self, level, msg, line_no, source_id ): #pylint: disable=unused-argument """Log a Javascript console message.""" mo = _CONSOLE_SOURCE_REGEX.search( source_id ) source = mo.group(1) if mo else source_id logger = logging.getLogger( "javascript" ) logger.info( "%s:%d - %s", source, line_no, msg ) # --------------------------------------------------------------------- class MainWindow( QWidget ): """Main application window.""" instance = None def __init__( self, url, disable_browser ): # initialize super().__init__() self._view = None self._is_closing = False # initialize the main window self.setWindowTitle( APP_NAME ) if IS_FROZEN: base_dir = os.path.join( sys._MEIPASS, "vasl_templates/webapp" ) #pylint: disable=no-member,protected-access else: base_dir = os.path.join( os.path.split(__file__)[0], "webapp" ) self.setWindowIcon( QIcon( os.path.join( base_dir, "static/images/app.ico" ) ) ) # create the menu menu_bar = QMenuBar( self ) file_menu = menu_bar.addMenu( "&File" ) def add_action( caption, icon, handler ): """Add a menu action.""" icon = QIcon( os.path.join( base_dir, "static/images/menu", icon ) if icon else None ) action = QAction( icon, caption, self ) action.triggered.connect( handler ) file_menu.addAction( action ) add_action( "&Settings", "settings.png", self.on_settings ) add_action( "&About", "info.png", self.on_about ) file_menu.addSeparator() add_action( "E&xit", "exit.png", self.on_exit ) # set the window geometry if disable_browser: self.setFixedSize( 300, 108 ) else: # restore it from the previous session val = app_settings.value( "MainWindow/geometry" ) if val : self.restoreGeometry( val ) else : self.resize( 1000, 650 ) # NOTE: This should be wide enough for the sortable hints to not wrap (so that # we don't see a scrollbar when their panels are reduced to their minimum height). # We also want the Trumbowyg button pane for the VC to wrap somewhere sensible. self.setMinimumSize( 1030, 630 ) # initialize the layout layout = QVBoxLayout( self ) layout.setMenuBar( menu_bar ) # FUDGE! We offer the option to disable the QWebEngineView since getting it to run # under Windows (especially older versions) is unreliable (since it uses OpenGL). # By disabling it, the program will at least start (in particular, the webapp server), # and non-technical users can then open an external browser and connect to the webapp # that way. Sigh... if not disable_browser: # initialize the web view self._view = QWebEngineView() layout.addWidget( self._view ) # initialize the web page # nb: we create an off-the-record profile to stop the view from using cached JS files :-/ profile = QWebEngineProfile( None, self._view ) version = APP_NAME.lower().replace( " ", "-" ) + "/" + APP_VERSION[1:] profile.setHttpUserAgent( re.sub( r"QtWebEngine/\S+", version, profile.httpUserAgent() ) ) page = AppWebPage( profile, self._view ) self._view.setPage( page ) # create a web channel to communicate with the front-end web_channel = QWebChannel( page ) # FUDGE! We would like to register a WebChannelHandler instance as the handler, but this crashes PyQt :-/ # Instead, we register ourself as the handler, and delegate processing to a WebChannelHandler. # The downside is that PyQt emits lots of warnings about our member variables not being properties, # but we filter them out in qtMessageHandler() :-/ self._web_channel_handler = WebChannelHandler( self ) web_channel.registerObject( "handler", self ) page.setWebChannel( web_channel ) # load the webapp url += "?pyqt=1" self._view.load( QUrl(url) ) else: # show a minimal UI label = QLabel() label.setTextFormat( Qt.RichText ) label.setText( "Running the {} application.
" \ "Click here to connect." \ "

Close this window when you're done.".format( APP_NAME, url ) ) label.setStyleSheet( "QLabel { background-color: white ; padding: 0.5em ; }" ) label.setOpenExternalLinks( True ) layout.addWidget( label ) layout.setContentsMargins( QMargins(0,0,0,0) ) # register the instance assert MainWindow.instance is None MainWindow.instance = self def closeEvent( self, evt ) : """Handle requests to close the window (i.e. exit the application).""" # check if we need to check for a dirty scenario if self._view is None or self._is_closing: return def close_window(): """Close the main window.""" if self._view: app_settings.setValue( "MainWindow/geometry", self.saveGeometry() ) self.close() # FUDGE! We need to do this to stop PyQt 5.15.2 from complaining that the profile # is being deleted while the page is still alive. self._view.page().deleteLater() # check if the scenario is dirty def callback( is_dirty ): """Callback for PyQt to return the result of running the Javascript.""" if not is_dirty: # nope - just close the window self._is_closing = True close_window() return # yup - ask the user to confirm the close rc = MainWindow.ask( "This scenario has been changed\n\nDo you want to close the program, and lose your changes?", QMessageBox.Yes | QMessageBox.No, QMessageBox.No ) if rc == QMessageBox.Yes: # confirmed - close the window self._is_closing = True close_window() self._view.page().runJavaScript( "is_scenario_dirty()", callback ) evt.ignore() # nb: we wait until the Javascript finishes to process the event @staticmethod def showInfoMsg( msg ): """Show an informational message.""" QMessageBox.information( MainWindow.instance, APP_NAME, msg ) @staticmethod def showErrorMsg( msg ): """Show an error message.""" QMessageBox.warning( MainWindow.instance, APP_NAME, msg ) @staticmethod def ask( msg, buttons, default ) : """Ask the user a question.""" return QMessageBox.question( MainWindow.instance, APP_NAME, msg, buttons, default ) def on_exit( self ): """Menu action handler.""" self.close() def on_settings( self ): """Menu action handler.""" from vasl_templates.server_settings import ServerSettingsDialog #pylint: disable=cyclic-import dlg = ServerSettingsDialog( self ) dlg.exec_() def on_about( self ): """Menu action handler.""" from vasl_templates.about import AboutDialog #pylint: disable=cyclic-import dlg = AboutDialog( self ) dlg.exec_() @pyqtSlot() @catch_exceptions( caption="SLOT EXCEPTION" ) def on_app_loaded( self ): """Called when the application has finished loading. NOTE: This handler might be called multiple times. """ def decode_val( val ): """Decode a settings value.""" # NOTE: Comma-separated values are deserialized as lists automatically. if val == "true": return True if val == "false": return False if str(val).isdigit(): return int(val) return val # load and install the user settings user_settings = {} for key in app_settings.allKeys(): if key.startswith( "UserSettings/" ): val = app_settings.value( key ) key = key[13:] # remove the leading "UserSettings/" sections = key.split( "." ) target = user_settings while len(sections) > 1: if sections[0] not in target: target[ sections[0] ] = {} target = target[ sections.pop(0) ] target[ sections[0] ] = decode_val( val ) self._view.page().runJavaScript( "install_user_settings('{}')".format( json.dumps( user_settings ) ) ) @pyqtSlot() @catch_exceptions( caption="SLOT EXCEPTION" ) def on_new_scenario( self ): """Called when the user wants to load a scenario.""" self._web_channel_handler.on_new_scenario() @pyqtSlot( result=QVariant ) @catch_exceptions( caption="SLOT EXCEPTION" ) def load_scenario( self ): """Called when the user wants to load a scenario.""" fname, data = self._web_channel_handler.load_scenario() if data is None: return None return QVariant( { "filename": fname, "data": data } ) @pyqtSlot( str, str, result=str ) @catch_exceptions( caption="SLOT EXCEPTION", retval=False ) def save_scenario( self, fname, data ): """Called when the user wants to save a scenario.""" fname = self._web_channel_handler.save_scenario( fname, data ) return fname @pyqtSlot( result=QVariant ) @catch_exceptions( caption="SLOT EXCEPTION" ) def load_vsav( self ): """Called when the user wants to update a VASL scenario.""" fname, data = self._web_channel_handler.load_vsav() if data is None: return None return QVariant( { "filename": fname, "data": base64.b64encode( data ).decode( "utf-8" ) } ) @pyqtSlot( str, str, result=bool ) @catch_exceptions( caption="SLOT EXCEPTION", retval=False ) def save_updated_vsav( self, fname, data ): """Called when a VASL scenario has been updated and is ready to be saved.""" data = base64.b64decode( data ) return self._web_channel_handler.save_updated_vsav( fname, data ) @pyqtSlot( str ) @catch_exceptions( caption="SLOT EXCEPTION", retval=False ) def save_log_file_analysis( self, data ): """Called when the user wants to save a log file analysis.""" self._web_channel_handler.save_log_file_analysis( data ) @pyqtSlot( str ) @catch_exceptions( caption="SLOT EXCEPTION" ) def on_user_settings_change( self, user_settings ): """Called when the user changes the user settings.""" # delete all existing keys for key in app_settings.allKeys(): if key.startswith( "UserSettings/" ): app_settings.remove( key ) # save the new user settings def save_section( vals, key_prefix ): """Save a section of the User Settings.""" for key,val in vals.items(): if isinstance( val, dict ): # FUDGE! The PyQt doco claims that it supports nested sections, but key names that have # a slash in them get saved as a top-level key, with the slash converted to a back-slash, # even on Linux :-/ We use dotted key names to represent nested levels. save_section( val, key_prefix+key+"." ) continue # NOTE: PyQt handles lists automatically, converting them to a comma-separated list, # and de-serializing them as lists (string values with a comma in them get quoted). app_settings.setValue( "UserSettings/{}".format( key_prefix + key ), val ) save_section( json.loads( user_settings ), "" ) @pyqtSlot( str, bool ) @catch_exceptions( caption="SLOT EXCEPTION" ) def on_update_scenario_status( self, caption, is_dirty ): """Update the UI to show the scenario's status.""" self._web_channel_handler.on_update_scenario_status( caption, is_dirty ) @pyqtSlot( str ) @catch_exceptions( caption="SLOT EXCEPTION" ) def on_snippet_image( self, img_data ): """Called when a snippet image has been generated.""" self._web_channel_handler.on_snippet_image( img_data ) @pyqtSlot( str, str, result=bool ) @catch_exceptions( caption="SLOT EXCEPTION", retval=False ) def save_downloaded_vsav( self, fname, data ): """Called when a VASL scenario has been downloaded.""" data = base64.b64decode( data ) # NOTE: We handle this the same as saving an updated VSAV. return self._web_channel_handler.save_updated_vsav( fname, data )