scyther/gui/scyther-gui.py

#!/usr/bin/env python3
"""
	Scyther : An automatic verifier for security protocols.
	Copyright (C) 2007-2020 Cas Cremers

	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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
"""


#---------------------------------------------------------------------------
# Try to get wxPython
try:
    import wx
except ImportError as err:
    from Scyther import Misc

    errmsg = "Problem with importing the required [wxPython] package."

    if 'No module' in str(err):
        errmsg = """Could not find the required [wxPython] package.
Please install this package in order to use the graphical user
interface of Scyther.
The [wxPython] packages can be found at http://www.wxpython.org/

Ubuntu users: the wxPython packages are called 'python-wxgtk' followed by the
version number. This version of Scyther requires at least wxPython version 4.0."""
    elif ('32-bit mode' in str(err)) or ('no matching architecture' in str(err)):
        import os

        key = "VERSIONER_PYTHON_PREFER_32_BIT"
        data = "yes"

        keyfound = False
        try:
            import sys
            if sys.environment[key] == data:
                keyfound = True
        except:
            pass

        if keyfound:
            """
            We already tried to set the environment variable, but it is still not working.
            """
            import sys
            #print "Key found. good job. no success."

            errmsg = """Problem with importing the required [wxPython] package.

    Possibly the problem is caused by wxPython only working in 32-bit mode currently.
    You can try the following on the command line:

      $ export VERSIONER_PYTHON_PREFER_32_BIT=yes
      $ ./scyther-gui.py"""

        else:
            """
            Key not found. Try if that works.
            """
            import sys
            from subprocess import call

            #print "Key not found. Trying to set it now."
            # TODO: check for MAC's if we need something like 'pythonw'
            call(sys.argv, shell=True, env={key: data})
            sys.exit(0)

    
    Misc.panic("""
ERROR:

%s

Note that you can still use the Scyther binaries in the 'Scyther' directory.

The exact error was:
--------------------------------------------------------------------------------
%s
--------------------------------------------------------------------------------
    """ % (errmsg,err))


#---------------------------------------------------------------------------
global WXPYTHON4
global WXPYTHONINFREQ
WXPYTHON4 = False
WXPYTHONINFREQ = wx

try:
    import wx.adv

    WXPYTHON4 = True
    WXPYTHONINFREQ = wx.adv
except ImportError:
    Misc.panic("""
ERROR:

Found wxPython libraries, but they seem to be too old (pre-4.0 wxPython). This means you cannot use the graphical user interface. To fix this, please ensure that you have at least wxPython 4.0 installed such that it is loaded by the wx import of python3.

Note that you can currently still use the Scyther binaries in the 'Scyther' directory.
""")

""" import externals """
import sys
import os
from optparse import OptionParser, SUPPRESS_HELP
from subprocess import *

#---------------------------------------------------------------------------

""" Import scyther-gui components """
from Scyther import Scyther,Misc
from Gui import About,Preference,Mainwindow

#---------------------------------------------------------------------------

def parseArgs():
    usage = "usage: %s [options] [inputfile]" % sys.argv[0]
    description = "scyther-gui is a graphical user interface for the scyther protocol verification tool."
    parser = OptionParser(usage=usage,description=description)

    # command
    parser.add_option("-V","--verify",dest="command",default=None,action="store_const",const="verify",
            help="Immediately verify the claims of the protocol (requires input file)")
    parser.add_option("-s","--state-space",dest="command",default=None,action="store_const",const="statespace",
            help="Immediately generate the complete characterization of the protocol (requires input file)")
    parser.add_option("-a","--auto-claims",dest="command",default=None,action="store_const",const="autoverify",
            help="Immediately verified protocol using default claims (requires input file)")
    #parser.add_option("-c","--check",dest="command",default=None,action="store_const",const="check",
    #        help="Immediately check protocol (requires input file)")

    # License
    parser.add_option("-l","--license",dest="license",default=False,action="store_const",const=True,
            help="Show license")

    # no-splash
    parser.add_option("-N","--no-splash",dest="splashscreen",default=True,action="store_const",const=False,
            help="Do not show the splash screen")

    # misc debug etc (not shown in the --help output)
    parser.add_option("","--test",dest="test",default=False,action="store_true",
            help=SUPPRESS_HELP)

    return parser.parse_args()

#---------------------------------------------------------------------------

class ScytherApp(wx.App):
    def OnInit(self):
        import os, inspect

        wx.GetApp().SetAppName("Scyther-gui")

        # Determine base directory (taking symbolic links into account)
        cmd_file = os.path.realpath(os.path.abspath(inspect.getfile( inspect.currentframe() )))
        basedir = os.path.split(cmd_file)[0]

        # Parse arguments
        (opts,args) = parseArgs()

        # License option may abort here
        if opts.license:
            print(Scyther.GetLicense())
            sys.exit(0)

        # Load preferences file
        Preference.init()

        #"""
        #Create and show the splash screen.  It will then create and show
        #the main frame when it is time to do so.
        #
        #The splash screen is disabled for automatic commands, and also
        #by a setting in the preferences file.
        #"""
        #if isSplashNeeded(opts):
        #    splash = MySplashScreen(basedir)
        #    splash.Show()

        self.mainWindow = Mainwindow.MainWindow(opts,args)
        self.SetTopWindow(self.mainWindow)
        self.mainWindow.Show()

        return True

    #def OnExit(self):
    #    """ Tear down """
    #    # Currently unused, but ought to return the same integer as the base class if overridden.


#---------------------------------------------------------------------------

def CheckRequirements():
    """ Check for any required programs """

    """ We need 'dot', in the graphviz package """
    from Scyther import FindDot

    FindDot.findDot()   # If Graphviz is not found, this function will call panic to complain.

#---------------------------------------------------------------------------


if __name__ == '__main__':
    CheckRequirements()
    scythergui = ScytherApp()
    scythergui.MainLoop()

# vim: set ts=4 sw=4 et list lcs=tab\:>-: