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

    29

import os

    30

import sys

    31

import getopt

    32

import threading

    33

import shlex

    34

import traceback

    35

import threading

    36

from threading import Thread, Semaphore, Lock, currentThread

    37

from builtins import str as text

    38

from past.builtins import execfile

    39

from six.moves import builtins

    40

from functools import partial

    41

    42

import runtime

    43

from runtime.PyroServer import PyroServer

    44

from runtime.xenomai import TryPreloadXenomai

    45

from runtime import LogMessageAndException

    46

from runtime import PlcStatus

    47

from runtime import default_evaluator

    48

from runtime.Stunnel import ensurePSK

    49

import util.paths as paths

    50

    51

# In case system time is ajusted, it is better to use

    52

# monotonic timers for timers and other timeout based operations.

    53

# hot-patch threading module to force using monitonic time for all 

    54

# Thread/Timer/Event/Condition

    55

    56

from runtime.monotonic_time import monotonic

    57

threading._time = monotonic

    58

    59

try:

    60

    from runtime.spawn_subprocess import Popen

    61

except ImportError:

    62

    from subprocess import Popen

    63

    64

def version():

    65

    from version import app_version

    66

    print("Beremiz_service: ", app_version)

    67

    68

    69

def usage():

    70

    version()

    71

    print("""

    72

Usage of Beremiz PLC execution service :\n

    73

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

    74

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

    75

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

    76

  -p  port number default:3000

    77

  -h  print this help text and quit

    78

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

    79

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

    80

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

    81

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

    82

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

    83

  -s  PSK secret path (default:PSK disabled)

    84

  -e  python extension (absolute path .py)

    85

    86

           working_dir - directory where are stored PLC files

    87

""" % sys.argv[0])

    88

    89

    90

try:

    91

    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="])

    92

except getopt.GetoptError as err:

    93

    # print help information and exit:

    94

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

    95

    usage()

    96

    sys.exit(2)

    97

    98

# default values

    99

interface = ''

   100

port = 3000

   101

webport = 8009

   102

PSKpath = None

   103

wampconf = None

   104

servicename = None

   105

autostart = False

   106

enablewx = True

   107

havewx = False

   108

enabletwisted = True

   109

havetwisted = False

   110

   111

extensions = []

   112

statuschange = []

   113

def status_change_call_factory(wanted, args):

   114

    def status_change_call(status):

   115

        if wanted is None or status is wanted:

   116

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

   117

            Popen(cmd)

   118

    return status_change_call

   119

   120

for o, a in opts:

   121

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

   122

        usage()

   123

        sys.exit()

   124

    if o == "--version":

   125

        version()

   126

        sys.exit()

   127

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

   128

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

   129

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

   130

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

   131

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

   132

        statuschange.append(status_change_call_factory(None, a))

   133

    elif o == "-i":

   134

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

   135

            interface = a

   136

        elif a == "localhost":

   137

            interface = '127.0.0.1'

   138

        else:

   139

            usage()

   140

            sys.exit()

   141

    elif o == "-p":

   142

        # port: port that the service runs on

   143

        port = int(a)

   144

    elif o == "-n":

   145

        servicename = a

   146

    elif o == "-x":

   147

        enablewx = int(a)

   148

    elif o == "-t":

   149

        enabletwisted = int(a)

   150

    elif o == "-a":

   151

        autostart = int(a)

   152

    elif o == "-w":

   153

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

   154

    elif o == "-c":

   155

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

   156

    elif o == "-s":

   157

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

   158

    elif o == "-e":

   159

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

   160

        fnameanddirname.reverse()

   161

        extensions.append(fnameanddirname)

   162

    else:

   163

        usage()

   164

        sys.exit()

   165

   166

   167

beremiz_dir = paths.AbsDir(__file__)

   168

   169

if len(argv) > 1:

   170

    usage()

   171

    sys.exit()

   172

elif len(argv) == 1:

   173

    WorkingDir = argv[0]

   174

    os.chdir(WorkingDir)

   175

elif len(argv) == 0:

   176

    WorkingDir = os.getcwd()

   177

    argv = [WorkingDir]

   178

   179

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

   180

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

   181

TryPreloadXenomai()

   182

version()

   183

   184

   185

def Bpath(*args):

   186

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

   187

   188

   189

import locale

   190

# Matiec's standard library relies on libC's locale-dependent

   191

# string to/from number convertions, but IEC-61131 counts

   192

# on '.' for decimal point. Therefore locale is reset to "C" */

   193

locale.setlocale(locale.LC_NUMERIC, "C")

   194

   195

def SetupI18n():

   196

    # Get folder containing translation files

   197

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

   198

    # Get the default language

   199

    langid = wx.LANGUAGE_DEFAULT

   200

    # Define translation domain (name of translation files)

   201

    domain = "Beremiz"

   202

   203

    # Define locale for wx

   204

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

   205

    if loc is None:

   206

        wx.LogGui.EnableLogging(False)

   207

        loc = wx.Locale(langid)

   208

        wx.LogGui.EnableLogging(True)

   209

        builtins.__dict__['loc'] = loc

   210

        # Define location for searching translation files

   211

    loc.AddCatalogLookupPathPrefix(localedir)

   212

    # Define locale domain

   213

    loc.AddCatalog(domain)

   214

   215

    global default_locale

   216

    default_locale = locale.getdefaultlocale()[1]

   217

   218

    # sys.stdout.encoding = default_locale

   219

    # if Beremiz_service is started from Beremiz IDE

   220

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

   221

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

   222

    # automatically converted to 'ascii' string.

   223

    def unicode_translation(message):

   224

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

   225

   226

    builtins.__dict__['_'] = unicode_translation

   227

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

   228

   229

   230

# Life is hard... have a candy.

   231

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

   232

if enablewx:

   233

    try:

   234

        import wx

   235

        havewx = True

   236

    except ImportError:

   237

        print("Wx unavailable !")

   238

        havewx = False

   239

   240

    if havewx:

   241

        import re

   242

        import wx.adv

   243

   244

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

   245

            app = wx.App(redirect=False)

   246

        else:

   247

            app = wx.PySimpleApp(redirect=False)

   248

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

   249

   250

        default_locale = None

   251

        SetupI18n()

   252

   253

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

   254

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

   255

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

   256

   257

        class ParamsEntryDialog(wx.TextEntryDialog):

   258

   259

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

   260

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

   261

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

   262

   263

                self.Tests = []

   264

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

   265

   266

            def OnOK(self, event):

   267

                value = self.GetValue()

   268

                texts = {"value": value}

   269

                for function, message in self.Tests:

   270

                    if not function(value):

   271

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

   272

                        message.ShowModal()

   273

                        message.Destroy()

   274

                        return

   275

                self.EndModal(wx.ID_OK)

   276

                event.Skip()

   277

   278

            def GetValue(self):

   279

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

   280

   281

            def SetTests(self, tests):

   282

                self.Tests = tests

   283

   284

        class BeremizTaskBarIcon(wx.adv.TaskBarIcon):

   285

            TBMENU_START = wx.NewId()

   286

            TBMENU_STOP = wx.NewId()

   287

            TBMENU_CHANGE_NAME = wx.NewId()

   288

            TBMENU_CHANGE_PORT = wx.NewId()

   289

            TBMENU_CHANGE_INTERFACE = wx.NewId()

   290

            TBMENU_LIVE_SHELL = wx.NewId()

   291

            TBMENU_WXINSPECTOR = wx.NewId()

   292

            TBMENU_CHANGE_WD = wx.NewId()

   293

            TBMENU_QUIT = wx.NewId()

   294

   295

            def __init__(self, pyroserver):

   296

                wx.adv.TaskBarIcon.__init__(self)

   297

                self.pyroserver = pyroserver

   298

                # Set the image

   299

                self.UpdateIcon(None)

   300

   301

                # bind some events

   302

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

   303

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

   304

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

   305

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

   306

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

   307

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

   308

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

   309

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

   310

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

   311

   312

            def CreatePopupMenu(self):

   313

                """

   314

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

   315

                the menu for the default EVT_RIGHT_DOWN event.  Just create

   316

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

   317

                the base class takes care of the rest.

   318

                """

   319

                menu = wx.Menu()

   320

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

   321

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

   322

                menu.AppendSeparator()

   323

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

   324

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

   325

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

   326

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

   327

                menu.AppendSeparator()

   328

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

   329

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

   330

                menu.AppendSeparator()

   331

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

   332

                return menu

   333

   334

            def MakeIcon(self, img):

   335

                """

   336

                The various platforms have different requirements for the

   337

                icon size...

   338

                """

   339

                if "wxMSW" in wx.PlatformInfo:

   340

                    img = img.Scale(16, 16)

   341

                elif "wxGTK" in wx.PlatformInfo:

   342

                    img = img.Scale(22, 22)

   343

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

   344

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

   345

                return icon

   346

   347

            def OnTaskBarStartPLC(self, evt):

   348

                runtime.GetPLCObjectSingleton().StartPLC()

   349

   350

            def OnTaskBarStopPLC(self, evt):

   351

                runtime.GetPLCObjectSingleton().StopPLC()

   352

   353

            def OnTaskBarChangeInterface(self, evt):

   354

                ip_addr = self.pyroserver.ip_addr

   355

                ip_addr = '' if ip_addr is None else ip_addr

   356

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

   357

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

   358

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

   359

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

   360

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

   361

                    self.pyroserver.ip_addr = dlg.GetValue()

   362

                    self.pyroserver.Restart()

   363

   364

            def OnTaskBarChangePort(self, evt):

   365

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

   366

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

   367

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

   368

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

   369

                    self.pyroserver.Restart()

   370

   371

            def OnTaskBarChangeWorkingDir(self, evt):

   372

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

   373

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

   374

                    self.pyroserver.workdir = dlg.GetPath()

   375

                    self.pyroserver.Restart()

   376

   377

            def OnTaskBarChangeName(self, evt):

   378

                _servicename = self.pyroserver.servicename

   379

                _servicename = '' if _servicename is None else _servicename

   380

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

   381

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

   382

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

   383

                    self.pyroserver.servicename = dlg.GetValue()

   384

                    self.pyroserver.Restart()

   385

   386

            def _LiveShellLocals(self):

   387

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

   388

   389

            def OnTaskBarLiveShell(self, evt):

   390

                from wx import py

   391

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

   392

                frame.Show()

   393

   394

            def OnTaskBarWXInspector(self, evt):

   395

                # Activate the widget inspection tool

   396

                from wx.lib.inspection import InspectionTool

   397

                if not InspectionTool().initialized:

   398

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

   399

   400

                wnd = wx.GetApp()

   401

                InspectionTool().Show(wnd, True)

   402

   403

            def OnTaskBarQuit(self, evt):

   404

                if wx.Platform == '__WXMSW__':

   405

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

   406

                self.RemoveIcon()

   407

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

   408

   409

            def UpdateIcon(self, plcstatus):

   410

                if plcstatus is PlcStatus.Started:

   411

                    currenticon = self.MakeIcon(starticon)

   412

                elif plcstatus is PlcStatus.Stopped:

   413

                    currenticon = self.MakeIcon(stopicon)

   414

                else:

   415

                    currenticon = self.MakeIcon(defaulticon)

   416

                self.SetIcon(currenticon, "Beremiz Service")

   417

   418

   419

if not os.path.isdir(WorkingDir):

   420

    os.mkdir(WorkingDir)

   421

   422

   423

if enabletwisted:

   424

    import warnings

   425

    with warnings.catch_warnings():

   426

        warnings.simplefilter("ignore")

   427

        try:

   428

            if havewx:

   429

                from twisted.internet import wxreactor

   430

                wxreactor.install()

   431

                from twisted.internet import reactor

   432

                reactor.registerWxApp(app)

   433

            else:

   434

                # from twisted.internet import pollreactor

   435

                # pollreactor.install()

   436

                from twisted.internet import reactor

   437

   438

            havetwisted = True

   439

        except ImportError:

   440

            print(_("Twisted unavailable."))

   441

            havetwisted = False

   442

   443

pyruntimevars = {}

   444

   445

if havewx:

   446

    wx_eval_lock = Semaphore(0)

   447

   448

    def statuschangeTskBar(status):

   449

        wx.CallAfter(taskbar_instance.UpdateIcon, status)

   450

   451

    statuschange.append(statuschangeTskBar)

   452

   453

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

   454

        tocall, args, kwargs = obj.call

   455

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

   456

        wx_eval_lock.release()

   457

   458

    main_thread_id = currentThread().ident

   459

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

   460

        # To prevent deadlocks, check if current thread is not one already main

   461

        current_id = currentThread().ident

   462

   463

        if main_thread_id != current_id:

   464

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

   465

            wx.CallAfter(wx_evaluator, o)

   466

            wx_eval_lock.acquire()

   467

            return o.res

   468

        else:

   469

            # avoid dead lock if called from main : do job immediately

   470

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

   471

else:

   472

    evaluator = default_evaluator

   473

   474

# Exception hooks

   475

   476

   477

def LogException(*exp):

   478

    LogMessageAndException("", exp)

   479

   480