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

import shlex

    34

from threading import Thread, Semaphore, Lock, currentThread

    35

from builtins import str as text

    36

from past.builtins import execfile

    37

from six.moves import builtins

    38

    39

import runtime

    40

from runtime.PyroServer import PyroServer

    41

from runtime.xenomai import TryPreloadXenomai

    42

from runtime import LogMessageAndException

    43

from runtime import PlcStatus

    44

from runtime import default_evaluator

    45

from runtime.Stunnel import ensurePSK

    46

import util.paths as paths

    47

    48

try:

    49

    from runtime.spawn_subprocess import Popen

    50

except ImportError:

    51

    from subprocess import Popen

    52

    53

def version():

    54

    from version import app_version

    55

    print("Beremiz_service: ", app_version)

    56

    57

    58

def usage():

    59

    version()

    60

    print("""

    61

Usage of Beremiz PLC execution service :\n

    62

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

    63

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

    64

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

    65

  -p  port number default:3000

    66

  -h  print this help text and quit

    67

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

    68

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

    69

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

    70

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

    71

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

    72

  -s  PSK secret path (default:PSK disabled)

    73

  -e  python extension (absolute path .py)

    74

    75

           working_dir - directory where are stored PLC files

    76

""" % sys.argv[0])

    77

    78

    79

try:

    80

    opts, argv = getopt.getopt(sys.argv[1:], "i:p:n:x:t:a:w:c:e:s:h", ["help", "version", "status-change=", "on-plc-start=", "on-plc-stop="])

    81

except getopt.GetoptError as err:

    82

    # print help information and exit:

    83

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

    84

    usage()

    85

    sys.exit(2)

    86

    87

# default values

    88

interface = ''

    89

port = 3000

    90

webport = 8009

    91

PSKpath = None

    92

wampconf = None

    93

servicename = None

    94

autostart = False

    95

enablewx = True

    96

havewx = False

    97

enabletwisted = True

    98

havetwisted = False

    99

   100

extensions = []

   101

statuschange = []

   102

def status_change_call_factory(wanted, args):

   103

    def status_change_call(status):

   104

        if wanted is None or status is wanted:

   105

            cmd = shlex.split(args.format(status))

   106

            Popen(cmd)

   107

    return status_change_call

   108

   109

for o, a in opts:

   110

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

   111

        usage()

   112

        sys.exit()

   113

    if o == "--version":

   114

        version()

   115

        sys.exit()

   116

    if o == "--on-plc-start":

   117

        statuschange.append(status_change_call_factory(PlcStatus.Started, a))

   118

    elif o == "--on-plc-stop":

   119

        statuschange.append(status_change_call_factory(PlcStatus.Stopped, a))

   120

    elif o == "--status-change":

   121

        statuschange.append(status_change_call_factory(None, a))

   122

    elif o == "-i":

   123

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

   124

            interface = a

   125

        elif a == "localhost":

   126

            interface = '127.0.0.1'

   127

        else:

   128

            usage()

   129

            sys.exit()

   130

    elif o == "-p":

   131

        # port: port that the service runs on

   132

        port = int(a)

   133

    elif o == "-n":

   134

        servicename = a

   135

    elif o == "-x":

   136

        enablewx = int(a)

   137

    elif o == "-t":

   138

        enabletwisted = int(a)

   139

    elif o == "-a":

   140

        autostart = int(a)

   141

    elif o == "-w":

   142

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

   143

    elif o == "-c":

   144

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

   145

    elif o == "-s":

   146

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

   147

    elif o == "-e":

   148

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

   149

        fnameanddirname.reverse()

   150

        extensions.append(fnameanddirname)

   151

    else:

   152

        usage()

   153

        sys.exit()

   154

   155

   156

beremiz_dir = paths.AbsDir(__file__)

   157

   158

if len(argv) > 1:

   159

    usage()

   160

    sys.exit()

   161

elif len(argv) == 1:

   162

    WorkingDir = argv[0]

   163

    os.chdir(WorkingDir)

   164

elif len(argv) == 0:

   165

    WorkingDir = os.getcwd()

   166

    argv = [WorkingDir]

   167

   168

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

   169

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

   170

TryPreloadXenomai()

   171

version()

   172

   173

   174

def Bpath(*args):

   175

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

   176

   177

   178

def SetupI18n():

   179

    # Get folder containing translation files

   180

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

   181

    # Get the default language

   182

    langid = wx.LANGUAGE_DEFAULT

   183

    # Define translation domain (name of translation files)

   184

    domain = "Beremiz"

   185

   186

    # Define locale for wx

   187

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

   188

    if loc is None:

   189

        wx.LogGui.EnableLogging(False)

   190

        loc = wx.Locale(langid)

   191

        wx.LogGui.EnableLogging(True)

   192

        builtins.__dict__['loc'] = loc

   193

        # Define location for searching translation files

   194

    loc.AddCatalogLookupPathPrefix(localedir)

   195

    # Define locale domain

   196

    loc.AddCatalog(domain)

   197

   198

    import locale

   199

    global default_locale

   200

    default_locale = locale.getdefaultlocale()[1]

   201

   202

    # sys.stdout.encoding = default_locale

   203

    # if Beremiz_service is started from Beremiz IDE

   204

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

   205

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

   206

    # automatically converted to 'ascii' string.

   207

    def unicode_translation(message):

   208

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

   209

   210

    builtins.__dict__['_'] = unicode_translation

   211

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

   212

   213

   214

# Life is hard... have a candy.

   215

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

   216

if enablewx:

   217

    try:

   218

        import wx

   219

        havewx = True

   220

    except ImportError:

   221

        print("Wx unavailable !")

   222

        havewx = False

   223

   224

    if havewx:

   225

        import re

   226

   227

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

   228

            app = wx.App(redirect=False)

   229

        else:

   230

            app = wx.PySimpleApp(redirect=False)

   231

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

   232

   233

        default_locale = None

   234

        SetupI18n()

   235

   236

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

   237

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

   238

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

   239

   240

        class ParamsEntryDialog(wx.TextEntryDialog):

   241

   242

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

   243

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

   244

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

   245

   246

                self.Tests = []

   247

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

   248

   249

            def OnOK(self, event):

   250

                value = self.GetValue()

   251

                texts = {"value": value}

   252

                for function, message in self.Tests:

   253

                    if not function(value):

   254

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

   255

                        message.ShowModal()

   256

                        message.Destroy()

   257

                        return

   258

                self.EndModal(wx.ID_OK)

   259

                event.Skip()

   260

   261

            def GetValue(self):

   262

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

   263

   264

            def SetTests(self, tests):

   265

                self.Tests = tests

   266

   267

        class BeremizTaskBarIcon(wx.TaskBarIcon):

   268

            TBMENU_START = wx.NewId()

   269

            TBMENU_STOP = wx.NewId()

   270

            TBMENU_CHANGE_NAME = wx.NewId()

   271

            TBMENU_CHANGE_PORT = wx.NewId()

   272

            TBMENU_CHANGE_INTERFACE = wx.NewId()

   273

            TBMENU_LIVE_SHELL = wx.NewId()

   274

            TBMENU_WXINSPECTOR = wx.NewId()

   275

            TBMENU_CHANGE_WD = wx.NewId()

   276

            TBMENU_QUIT = wx.NewId()

   277

   278

            def __init__(self, pyroserver):

   279

                wx.TaskBarIcon.__init__(self)

   280

                self.pyroserver = pyroserver

   281

                # Set the image

   282

                self.UpdateIcon(None)

   283

   284

                # bind some events

   285

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

   286

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

   287

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

   288

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

   289

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

   290

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

   291

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

   292

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

   293

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

   294

   295

            def CreatePopupMenu(self):

   296

                """

   297

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

   298

                the menu for the default EVT_RIGHT_DOWN event.  Just create

   299

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

   300

                the base class takes care of the rest.

   301

                """

   302

                menu = wx.Menu()

   303

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

   304

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

   305

                menu.AppendSeparator()

   306

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

   307

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

   308

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

   309

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

   310

                menu.AppendSeparator()

   311

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

   312

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

   313

                menu.AppendSeparator()

   314

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

   315

                return menu

   316

   317

            def MakeIcon(self, img):

   318

                """

   319

                The various platforms have different requirements for the

   320

                icon size...

   321

                """

   322

                if "wxMSW" in wx.PlatformInfo:

   323

                    img = img.Scale(16, 16)

   324

                elif "wxGTK" in wx.PlatformInfo:

   325

                    img = img.Scale(22, 22)

   326

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

   327

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

   328

                return icon

   329

   330

            def OnTaskBarStartPLC(self, evt):

   331

                runtime.GetPLCObjectSingleton().StartPLC()

   332

   333

            def OnTaskBarStopPLC(self, evt):

   334

                runtime.GetPLCObjectSingleton().StopPLC()

   335

   336

            def OnTaskBarChangeInterface(self, evt):

   337

                ip_addr = self.pyroserver.ip_addr

   338

                ip_addr = '' if ip_addr is None else ip_addr

   339

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

   340

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

   341

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

   342

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

   343

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

   344

                    self.pyroserver.ip_addr = dlg.GetValue()

   345

                    self.pyroserver.Restart()

   346

   347

            def OnTaskBarChangePort(self, evt):

   348

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

   349

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

   350

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

   351

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

   352

                    self.pyroserver.Restart()

   353

   354

            def OnTaskBarChangeWorkingDir(self, evt):

   355

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

   356

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

   357

                    self.pyroserver.workdir = dlg.GetPath()

   358

                    self.pyroserver.Restart()

   359

   360

            def OnTaskBarChangeName(self, evt):

   361

                _servicename = self.pyroserver.servicename

   362

                _servicename = '' if _servicename is None else _servicename

   363

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

   364

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

   365

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

   366

                    self.pyroserver.servicename = dlg.GetValue()

   367

                    self.pyroserver.Restart()

   368

   369

            def _LiveShellLocals(self):

   370

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

   371

   372

            def OnTaskBarLiveShell(self, evt):

   373

                from wx import py

   374

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

   375

                frame.Show()

   376

   377

            def OnTaskBarWXInspector(self, evt):

   378

                # Activate the widget inspection tool

   379

                from wx.lib.inspection import InspectionTool

   380

                if not InspectionTool().initialized:

   381

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

   382

   383

                wnd = wx.GetApp()

   384

                InspectionTool().Show(wnd, True)

   385

   386

            def OnTaskBarQuit(self, evt):

   387

                if wx.Platform == '__WXMSW__':

   388

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

   389

                self.RemoveIcon()

   390

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

   391

   392

            def UpdateIcon(self, plcstatus):

   393

                if plcstatus is PlcStatus.Started:

   394

                    currenticon = self.MakeIcon(starticon)

   395

                elif plcstatus is PlcStatus.Stopped:

   396

                    currenticon = self.MakeIcon(stopicon)

   397

                else:

   398

                    currenticon = self.MakeIcon(defaulticon)

   399

                self.SetIcon(currenticon, "Beremiz Service")

   400

   401

   402

if not os.path.isdir(WorkingDir):

   403

    os.mkdir(WorkingDir)

   404

   405

   406

if enabletwisted:

   407

    import warnings

   408

    with warnings.catch_warnings():

   409

        warnings.simplefilter("ignore")

   410

        try:

   411

            if havewx:

   412

                from twisted.internet import wxreactor

   413

                wxreactor.install()

   414

            from twisted.internet import reactor

   415

   416

            havetwisted = True

   417

        except ImportError:

   418

            print(_("Twisted unavailable."))

   419

            havetwisted = False

   420

   421

pyruntimevars = {}

   422

   423

if havetwisted:

   424

    if havewx:

   425

        reactor.registerWxApp(app)

   426

   427

twisted_reactor_thread_id = None

   428

ui_thread = None

   429

   430

if havewx:

   431

    wx_eval_lock = Semaphore(0)

   432

   433

    def statuschangeTskBar(status):

   434

        wx.CallAfter(taskbar_instance.UpdateIcon, status)

   435

   436

    statuschange.append(statuschangeTskBar)

   437

   438

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

   439

        tocall, args, kwargs = obj.call

   440

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

   441

        wx_eval_lock.release()

   442

   443

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

   444

        # To prevent deadlocks, check if current thread is not one of the UI

   445

        # UI threads can be either the one from WX main loop or

   446

        # worker thread from twisted "threadselect" reactor

   447

        current_id = currentThread().ident

   448

   449

        if ui_thread is not None \

   450

            and ui_thread.ident != current_id \

   451

            and (not havetwisted or (

   452

                    twisted_reactor_thread_id is not None

   453

                    and twisted_reactor_thread_id != current_id)):

   454

   455

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

   456

            wx.CallAfter(wx_evaluator, o)

   457

            wx_eval_lock.acquire()

   458

            return o.res

   459

        else:

   460

            # avoid dead lock if called from the wx mainloop

   461

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

   462

else:

   463

    evaluator = default_evaluator

   464

   465

# Exception hooks

   466

   467

   468

def LogException(*exp):

   469

    LogMessageAndException("", exp)

   470

   471

   472

sys.excepthook = LogException

   473

   474

   475

def installThreadExcepthook():

   476

    init_old = threading.Thread.__init__

   477

   478

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

   479

        init_old(self, *args, **kwargs)

   480

        run_old = self.run