1

#!/usr/bin/env python

     2

# -*- coding: utf-8 -*-

     3

     4

# This file is part of Beremiz, a Integrated Development Environment for

     5

# programming IEC 61131-3 automates supporting plcopen standard and CanFestival.

     6

#

     7

# Copyright (C) 2007: Edouard TISSERANT and Laurent BESSARD

     8

# Copyright (C) 2017: Andrey Skvortsov

     9

#

    10

# See COPYING file for copyrights details.

    11

#

    12

# This program is free software; you can redistribute it and/or

    13

# modify it under the terms of the GNU General Public License

    14

# as published by the Free Software Foundation; either version 2

    15

# of the License, or (at your option) any later version.

    16

#

    17

# This program is distributed in the hope that it will be useful,

    18

# but WITHOUT ANY WARRANTY; without even the implied warranty of

    19

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    20

# GNU General Public License for more details.

    21

#

    22

# You should have received a copy of the GNU General Public License

    23

# along with this program; if not, write to the Free Software

    24

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

    25

    26

    27

from __future__ import absolute_import

    28

from __future__ import print_function

    29

import os

    30

import sys

    31

import getopt

    32

import threading

    33

from threading import Thread, Semaphore, Lock

    34

import __builtin__

    35

    36

import runtime

    37

from runtime.PyroServer import Server

    38

from runtime.xenomai import TryPreloadXenomai

    39

from runtime import LogMessageAndException

    40

import util.paths as paths

    41

    42

    43

def version():

    44

    from version import app_version

    45

    print("Beremiz_service: ", app_version)

    46

    47

    48

def usage():

    49

    version()

    50

    print("""

    51

Usage of Beremiz PLC execution service :\n

    52

%s {[-n servicename] [-i IP] [-p port] [-x enabletaskbar] [-a autostart]|-h|--help} working_dir

    53

  -n  service name (default:None, zeroconf discovery disabled)

    54

  -i  IP address of interface to bind to (default:localhost)

    55

  -p  port number default:3000

    56

  -h  print this help text and quit

    57

  -a  autostart PLC (0:disable 1:enable) (default:0)

    58

  -x  enable/disable wxTaskbarIcon (0:disable 1:enable) (default:1)

    59

  -t  enable/disable Twisted web interface (0:disable 1:enable) (default:1)

    60

  -w  web server port or "off" to disable web server (default:8009)

    61

  -c  WAMP client config file (can be overriden by wampconf.json in project)

    62

  -s  PSK secret path (default:PSK disabled)

    63

  -e  python extension (absolute path .py)

    64

    65

           working_dir - directory where are stored PLC files

    66

""" % sys.argv[0])

    67

    68

    69

try:

    70

    opts, argv = getopt.getopt(sys.argv[1:], "i:p:n:x:t:a:w:c:e:s:h", ["help", "version"])

    71

except getopt.GetoptError as err:

    72

    # print help information and exit:

    73

    print(str(err))  # will print something like "option -a not recognized"

    74

    usage()

    75

    sys.exit(2)

    76

    77

# default values

    78

interface = ''

    79

port = 3000

    80

webport = 8009

    81

PSKpath = None

    82

wampconf = None

    83

servicename = None

    84

autostart = False

    85

enablewx = True

    86

havewx = False

    87

enabletwisted = True

    88

havetwisted = False

    89

    90

extensions = []

    91

    92

for o, a in opts:

    93

    if o == "-h" or o == "--help":

    94

        usage()

    95

        sys.exit()

    96

    if o == "--version":

    97

        version()

    98

        sys.exit()

    99

    elif o == "-i":

   100

        if len(a.split(".")) == 4:

   101

            interface = a

   102

        elif a == "localhost":

   103

            interface = '127.0.0.1'

   104

        else:

   105

            usage()

   106

            sys.exit()

   107

    elif o == "-p":

   108

        # port: port that the service runs on

   109

        port = int(a)

   110

    elif o == "-n":

   111

        servicename = a

   112

    elif o == "-x":

   113

        enablewx = int(a)

   114

    elif o == "-t":

   115

        enabletwisted = int(a)

   116

    elif o == "-a":

   117

        autostart = int(a)

   118

    elif o == "-w":

   119

        webport = None if a == "off" else int(a)

   120

    elif o == "-c":

   121

        wampconf = None if a == "off" else a

   122

    elif o == "-s":

   123

        PSKpath = None if a == "off" else a

   124

    elif o == "-e":

   125

        fnameanddirname = list(os.path.split(os.path.realpath(a)))

   126

        fnameanddirname.reverse()

   127

        extensions.append(fnameanddirname)

   128

    else:

   129

        usage()

   130

        sys.exit()

   131

   132

   133

beremiz_dir = paths.AbsDir(__file__)

   134

   135

if len(argv) > 1:

   136

    usage()

   137

    sys.exit()

   138

elif len(argv) == 1:

   139

    WorkingDir = argv[0]

   140

    os.chdir(WorkingDir)

   141

elif len(argv) == 0:

   142

    WorkingDir = os.getcwd()

   143

    argv = [WorkingDir]

   144

   145

__builtin__.__dict__['_'] = lambda x: x

   146

# TODO: add a cmdline parameter if Trying Preloading Xenomai makes problem

   147

TryPreloadXenomai()

   148

version()

   149

   150

   151

def Bpath(*args):

   152

    return os.path.join(beremiz_dir, *args)

   153

   154

   155

def SetupI18n():

   156

    # Get folder containing translation files

   157

    localedir = os.path.join(beremiz_dir, "locale")

   158

    # Get the default language

   159

    langid = wx.LANGUAGE_DEFAULT

   160

    # Define translation domain (name of translation files)

   161

    domain = "Beremiz"

   162

   163

    # Define locale for wx

   164

    loc = __builtin__.__dict__.get('loc', None)

   165

    if loc is None:

   166

        wx.LogGui.EnableLogging(False)

   167

        loc = wx.Locale(langid)

   168

        wx.LogGui.EnableLogging(True)

   169

        __builtin__.__dict__['loc'] = loc

   170

        # Define location for searching translation files

   171

    loc.AddCatalogLookupPathPrefix(localedir)

   172

    # Define locale domain

   173

    loc.AddCatalog(domain)

   174

   175

    import locale

   176

    global default_locale

   177

    default_locale = locale.getdefaultlocale()[1]

   178

   179

    # sys.stdout.encoding = default_locale

   180

    # if Beremiz_service is started from Beremiz IDE

   181

    # sys.stdout.encoding is None (that means 'ascii' encoding').

   182

    # And unicode string returned by wx.GetTranslation() are

   183

    # automatically converted to 'ascii' string.

   184

    def unicode_translation(message):

   185

        return wx.GetTranslation(message).encode(default_locale)

   186

   187

    __builtin__.__dict__['_'] = unicode_translation

   188

    # __builtin__.__dict__['_'] = wx.GetTranslation

   189

   190

   191

# Life is hard... have a candy.

   192

# pylint: disable=wrong-import-position,wrong-import-order

   193

if enablewx:

   194

    try:

   195

        import wx

   196

        havewx = True

   197

    except ImportError:

   198

        print("Wx unavailable !")

   199

        havewx = False

   200

   201

    if havewx:

   202

        import re

   203

        from types import *

   204

   205

        if wx.VERSION >= (3, 0, 0):

   206

            app = wx.App(redirect=False)

   207

        else:

   208

            app = wx.PySimpleApp(redirect=False)

   209

        app.SetTopWindow(wx.Frame(None, -1))

   210

   211

        default_locale = None

   212

        SetupI18n()

   213

   214

        defaulticon = wx.Image(Bpath("images", "brz.png"))

   215

        starticon = wx.Image(Bpath("images", "icoplay24.png"))

   216

        stopicon = wx.Image(Bpath("images", "icostop24.png"))

   217

   218

        class ParamsEntryDialog(wx.TextEntryDialog):

   219

   220

            def __init__(self, parent, message, caption=_("Please enter text"), defaultValue="",

   221

                         style=wx.OK | wx.CANCEL | wx.CENTRE, pos=wx.DefaultPosition):

   222

                wx.TextEntryDialog.__init__(self, parent, message, caption, defaultValue, style, pos)

   223

   224

                self.Tests = []

   225

                self.Bind(wx.EVT_BUTTON, self.OnOK, id=self.GetAffirmativeId())

   226

   227

            def OnOK(self, event):

   228

                value = self.GetValue()

   229

                texts = {"value": value}

   230

                for function, message in self.Tests:

   231

                    if not function(value):

   232

                        message = wx.MessageDialog(self, message % texts, _("Error"), wx.OK | wx.ICON_ERROR)

   233

                        message.ShowModal()

   234

                        message.Destroy()

   235

                        return

   236

                self.EndModal(wx.ID_OK)

   237

                event.Skip()

   238

   239

            def GetValue(self):

   240

                return self.GetSizer().GetItem(1).GetWindow().GetValue()

   241

   242

            def SetTests(self, tests):

   243

                self.Tests = tests

   244

   245

        class BeremizTaskBarIcon(wx.TaskBarIcon):

   246

            TBMENU_START = wx.NewId()

   247

            TBMENU_STOP = wx.NewId()

   248

            TBMENU_CHANGE_NAME = wx.NewId()

   249

            TBMENU_CHANGE_PORT = wx.NewId()

   250

            TBMENU_CHANGE_INTERFACE = wx.NewId()

   251

            TBMENU_LIVE_SHELL = wx.NewId()

   252

            TBMENU_WXINSPECTOR = wx.NewId()

   253

            TBMENU_CHANGE_WD = wx.NewId()

   254

            TBMENU_QUIT = wx.NewId()

   255

   256

            def __init__(self, pyroserver):

   257

                wx.TaskBarIcon.__init__(self)

   258

                self.pyroserver = pyroserver

   259

                # Set the image

   260

                self.UpdateIcon(None)

   261

   262

                # bind some events

   263

                self.Bind(wx.EVT_MENU, self.OnTaskBarStartPLC, id=self.TBMENU_START)

   264

                self.Bind(wx.EVT_MENU, self.OnTaskBarStopPLC, id=self.TBMENU_STOP)

   265

                self.Bind(wx.EVT_MENU, self.OnTaskBarChangeName, id=self.TBMENU_CHANGE_NAME)

   266

                self.Bind(wx.EVT_MENU, self.OnTaskBarChangeInterface, id=self.TBMENU_CHANGE_INTERFACE)

   267

                self.Bind(wx.EVT_MENU, self.OnTaskBarLiveShell, id=self.TBMENU_LIVE_SHELL)

   268

                self.Bind(wx.EVT_MENU, self.OnTaskBarWXInspector, id=self.TBMENU_WXINSPECTOR)

   269

                self.Bind(wx.EVT_MENU, self.OnTaskBarChangePort, id=self.TBMENU_CHANGE_PORT)

   270

                self.Bind(wx.EVT_MENU, self.OnTaskBarChangeWorkingDir, id=self.TBMENU_CHANGE_WD)

   271

                self.Bind(wx.EVT_MENU, self.OnTaskBarQuit, id=self.TBMENU_QUIT)

   272

   273

            def CreatePopupMenu(self):

   274

                """

   275

                This method is called by the base class when it needs to popup

   276

                the menu for the default EVT_RIGHT_DOWN event.  Just create

   277

                the menu how you want it and return it from this function,

   278

                the base class takes care of the rest.

   279

                """

   280

                menu = wx.Menu()

   281

                menu.Append(self.TBMENU_START, _("Start PLC"))

   282

                menu.Append(self.TBMENU_STOP, _("Stop PLC"))

   283

                menu.AppendSeparator()

   284

                menu.Append(self.TBMENU_CHANGE_NAME, _("Change Name"))

   285

                menu.Append(self.TBMENU_CHANGE_INTERFACE, _("Change IP of interface to bind"))

   286

                menu.Append(self.TBMENU_CHANGE_PORT, _("Change Port Number"))

   287

                menu.Append(self.TBMENU_CHANGE_WD, _("Change working directory"))

   288

                menu.AppendSeparator()

   289

                menu.Append(self.TBMENU_LIVE_SHELL, _("Launch a live Python shell"))

   290

                menu.Append(self.TBMENU_WXINSPECTOR, _("Launch WX GUI inspector"))

   291

                menu.AppendSeparator()

   292

                menu.Append(self.TBMENU_QUIT, _("Quit"))

   293

                return menu

   294

   295

            def MakeIcon(self, img):

   296

                """

   297

                The various platforms have different requirements for the

   298

                icon size...

   299

                """

   300

                if "wxMSW" in wx.PlatformInfo:

   301

                    img = img.Scale(16, 16)

   302

                elif "wxGTK" in wx.PlatformInfo:

   303

                    img = img.Scale(22, 22)

   304

                # wxMac can be any size upto 128x128, so leave the source img alone....

   305

                icon = wx.IconFromBitmap(img.ConvertToBitmap())

   306

                return icon

   307

   308

            def OnTaskBarStartPLC(self, evt):

   309

                runtime.GetPLCObjectSingleton().StartPLC()

   310

   311

            def OnTaskBarStopPLC(self, evt):

   312

                runtime.GetPLCObjectSingleton().StopPLC()

   313

   314

            def OnTaskBarChangeInterface(self, evt):

   315

                ip_addr = self.pyroserver.ip_addr

   316

                ip_addr = '' if ip_addr is None else ip_addr

   317

                dlg = ParamsEntryDialog(None, _("Enter the IP of the interface to bind"), defaultValue=ip_addr)

   318

                dlg.SetTests([(re.compile('\d{1,3}(?:\.\d{1,3}){3}$').match, _("IP is not valid!")),

   319

                              (lambda x:len([x for x in x.split(".") if 0 <= int(x) <= 255]) == 4,

   320

                               _("IP is not valid!"))])

   321

                if dlg.ShowModal() == wx.ID_OK:

   322

                    self.pyroserver.ip_addr = dlg.GetValue()

   323

                    self.pyroserver.Restart()

   324

   325

            def OnTaskBarChangePort(self, evt):

   326

                dlg = ParamsEntryDialog(None, _("Enter a port number "), defaultValue=str(self.pyroserver.port))

   327

                dlg.SetTests([(UnicodeType.isdigit, _("Port number must be an integer!")), (lambda port: 0 <= int(port) <= 65535, _("Port number must be 0 <= port <= 65535!"))])

   328

                if dlg.ShowModal() == wx.ID_OK:

   329

                    self.pyroserver.port = int(dlg.GetValue())

   330

                    self.pyroserver.Restart()

   331

   332

            def OnTaskBarChangeWorkingDir(self, evt):

   333

                dlg = wx.DirDialog(None, _("Choose a working directory "), self.pyroserver.workdir, wx.DD_NEW_DIR_BUTTON)

   334

                if dlg.ShowModal() == wx.ID_OK:

   335

                    self.pyroserver.workdir = dlg.GetPath()

   336

                    self.pyroserver.Restart()

   337

   338

            def OnTaskBarChangeName(self, evt):

   339

                _servicename = self.pyroserver.servicename

   340

                _servicename = '' if _servicename is None else _servicename

   341

                dlg = ParamsEntryDialog(None, _("Enter a name "), defaultValue=_servicename)

   342

                dlg.SetTests([(lambda name: len(name) is not 0, _("Name must not be null!"))])

   343

                if dlg.ShowModal() == wx.ID_OK:

   344

                    self.pyroserver.servicename = dlg.GetValue()

   345

                    self.pyroserver.Restart()

   346

   347

            def _LiveShellLocals(self):

   348

                return {"locals": runtime.GetPLCObjectSingleton().python_runtime_vars}

   349

   350

            def OnTaskBarLiveShell(self, evt):

   351

                from wx import py

   352

                frame = py.crust.CrustFrame(**self._LiveShellLocals())

   353

                frame.Show()

   354

   355

            def OnTaskBarWXInspector(self, evt):

   356

                # Activate the widget inspection tool

   357

                from wx.lib.inspection import InspectionTool

   358

                if not InspectionTool().initialized:

   359

                    InspectionTool().Init(**self._LiveShellLocals())

   360

   361

                wnd = wx.GetApp()

   362

                InspectionTool().Show(wnd, True)

   363

   364

            def OnTaskBarQuit(self, evt):

   365

                if wx.Platform == '__WXMSW__':

   366

                    Thread(target=self.pyroserver.Quit).start()

   367

                self.RemoveIcon()

   368

                wx.CallAfter(wx.GetApp().ExitMainLoop)

   369

   370

            def UpdateIcon(self, plcstatus):

   371

                if plcstatus is "Started":

   372

                    currenticon = self.MakeIcon(starticon)

   373

                elif plcstatus is "Stopped":

   374

                    currenticon = self.MakeIcon(stopicon)

   375

                else:

   376

                    currenticon = self.MakeIcon(defaulticon)

   377

                self.SetIcon(currenticon, "Beremiz Service")

   378

   379

   380

if not os.path.isdir(WorkingDir):

   381

    os.mkdir(WorkingDir)

   382

   383

   384

def default_evaluator(tocall, *args, **kwargs):

   385

    try:

   386

        res = (tocall(*args, **kwargs), None)

   387

    except Exception:

   388

        res = (None, sys.exc_info())

   389

    return res

   390

   391

   392

if enabletwisted:

   393

    import warnings

   394

    with warnings.catch_warnings():

   395

        warnings.simplefilter("ignore")

   396

        try:

   397

            if havewx:

   398

                from twisted.internet import wxreactor

   399

                wxreactor.install()

   400

            from twisted.internet import reactor

   401

   402

            havetwisted = True

   403

        except ImportError:

   404

            print(_("Twisted unavailable."))

   405

            havetwisted = False

   406

   407

pyruntimevars = {}

   408

statuschange = []

   409

   410

if havetwisted:

   411

    if havewx:

   412

        reactor.registerWxApp(app)

   413

   414

if havewx:

   415

    wx_eval_lock = Semaphore(0)

   416

    # FIXME : beware wx mainloop is _not_ running in main thread

   417

    # main_thread = currentThread()

   418

   419

    def statuschangeTskBar(status):

   420

        wx.CallAfter(taskbar_instance.UpdateIcon, status)

   421

   422

    statuschange.append(statuschangeTskBar)

   423

   424

    def wx_evaluator(obj, *args, **kwargs):

   425

        tocall, args, kwargs = obj.call

   426

        obj.res = default_evaluator(tocall, *args, **kwargs)

   427

        wx_eval_lock.release()

   428

   429

    def evaluator(tocall, *args, **kwargs):

   430

        # FIXME : should implement anti-deadlock

   431

        # if main_thread == currentThread():

   432

        #     # avoid dead lock if called from the wx mainloop

   433

        #     return default_evaluator(tocall, *args, **kwargs)

   434

        # else:

   435

        o = type('', (object,), dict(call=(tocall, args, kwargs), res=None))

   436

        wx.CallAfter(wx_evaluator, o)

   437

        wx_eval_lock.acquire()

   438

        return o.res

   439

else:

   440

    evaluator = default_evaluator

   441

   442

# Exception hooks

   443

   444

   445

def LogException(*exp):

   446

    LogMessageAndException("", exp)

   447

   448

   449

sys.excepthook = LogException

   450

   451

   452

def installThreadExcepthook():

   453

    init_old = threading.Thread.__init__

   454

   455

    def init(self, *args, **kwargs):

   456

        init_old(self, *args, **kwargs)

   457

        run_old = self.run

   458

   459

        def run_with_except_hook(*args, **kw):

   460

            try:

   461

                run_old(*args, **kw)

   462

            except (KeyboardInterrupt, SystemExit):

   463

                raise

   464

            except Exception:

   465

                sys.excepthook(*sys.exc_info())

   466

        self.run = run_with_except_hook

   467

    threading.Thread.__init__ = init

   468

   469

   470

installThreadExcepthook()

   471

havewamp = False

   472

   473

if havetwisted:

   474

    if webport is not None:

   475

        try:

   476

            import runtime.NevowServer as NS  # pylint: disable=ungrouped-imports

   477

        except Exception:

   478

            LogMessageAndException(_("Nevow/Athena import failed :"))

   479

            webport = None

   480

        NS.WorkingDir = WorkingDir