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, currentThread, Semaphore

    34

import traceback

    35

import __builtin__

    36

import Pyro.core as pyro

    37

    38

from runtime import PLCObject, ServicePublisher

    39

import util.paths as paths

    40

    41

    42

def usage():

    43

    print("""

    44

Usage of Beremiz PLC execution service :\n

    45

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

    46

           -n        - zeroconf service name (default:disabled)

    47

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

    48

           -p        - port number default:3000

    49

           -h        - print this help text and quit

    50

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

    51

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

    52

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

    53

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

    54

           -c        - WAMP client config file or "off" (default:wampconf.json)

    55

           -e        - python extension (absolute path .py)

    56

    57

           working_dir - directory where are stored PLC files

    58

""" % sys.argv[0])

    59

    60

    61

try:

    62

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

    63

except getopt.GetoptError, err:

    64

    # print help information and exit:

    65

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

    66

    usage()

    67

    sys.exit(2)

    68

    69

# default values

    70

given_ip = None

    71

port = 3000

    72

webport = 8009

    73

wampconf = "wampconf.json"

    74

servicename = None

    75

autostart = False

    76

enablewx = True

    77

havewx = False

    78

enabletwisted = True

    79

havetwisted = False

    80

    81

extensions = []

    82

    83

for o, a in opts:

    84

    if o == "-h":

    85

        usage()

    86

        sys.exit()

    87

    elif o == "-i":

    88

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

    89

            given_ip = a

    90

        else:

    91

            usage()

    92

            sys.exit()

    93

    elif o == "-p":

    94

        # port: port that the service runs on

    95

        port = int(a)

    96

    elif o == "-n":

    97

        servicename = a

    98

    elif o == "-x":

    99

        enablewx = int(a)

   100

    elif o == "-t":

   101

        enabletwisted = int(a)

   102

    elif o == "-a":

   103

        autostart = int(a)

   104

    elif o == "-w":

   105

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

   106

    elif o == "-c":

   107

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

   108

    elif o == "-e":

   109

        extensions.append(a)

   110

    else:

   111

        usage()

   112

        sys.exit()

   113

   114

   115

beremiz_dir = paths.AbsDir(__file__)

   116

   117

if len(argv) > 1:

   118

    usage()

   119

    sys.exit()

   120

elif len(argv) == 1:

   121

    WorkingDir = argv[0]

   122

    os.chdir(WorkingDir)

   123

elif len(argv) == 0:

   124

    WorkingDir = os.getcwd()

   125

    argv = [WorkingDir]

   126

   127

if __name__ == '__main__':

   128

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

   129

   130

   131

def Bpath(*args):

   132

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

   133

   134

   135

def SetupI18n():

   136

    # Get folder containing translation files

   137

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

   138

    # Get the default language

   139

    langid = wx.LANGUAGE_DEFAULT

   140

    # Define translation domain (name of translation files)

   141

    domain = "Beremiz"

   142

   143

    # Define locale for wx

   144

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

   145

    if loc is None:

   146

        loc = wx.Locale(langid)

   147

        __builtin__.__dict__['loc'] = loc

   148

        # Define location for searching translation files

   149

    loc.AddCatalogLookupPathPrefix(localedir)

   150

    # Define locale domain

   151

    loc.AddCatalog(domain)

   152

   153

    import locale

   154

    global default_locale

   155

    default_locale = locale.getdefaultlocale()[1]

   156

   157

    # sys.stdout.encoding = default_locale

   158

    # if Beremiz_service is started from Beremiz IDE

   159

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

   160

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

   161

    # automatically converted to 'ascii' string.

   162

    def unicode_translation(message):

   163

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

   164

   165

    if __name__ == '__main__':

   166

        __builtin__.__dict__['_'] = unicode_translation

   167

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

   168

   169

   170

if enablewx:

   171

    try:

   172

        import wx

   173

        havewx = True

   174

    except ImportError:

   175

        print("Wx unavailable !")

   176

        havewx = False

   177

   178

    if havewx:

   179

        import re

   180

        from types import *

   181

   182

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

   183

            app = wx.App(redirect=False)

   184

        else:

   185

            app = wx.PySimpleApp(redirect=False)

   186

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

   187

   188

        default_locale = None

   189

        SetupI18n()

   190

   191

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

   192

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

   193

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

   194

   195

        class ParamsEntryDialog(wx.TextEntryDialog):

   196

            if wx.VERSION < (2, 6, 0):

   197

                def Bind(self, event, function, id=None):

   198

                    if id is not None:

   199

                        event(self, id, function)

   200

                    else:

   201

                        event(self, function)

   202

   203

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

   204

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

   205

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

   206

   207

                self.Tests = []

   208

                if wx.VERSION >= (2, 8, 0):

   209

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

   210

                elif wx.VERSION >= (2, 6, 0):

   211

                    self.Bind(wx.EVT_BUTTON, self.OnOK, id=self.GetSizer().GetItem(3).GetSizer().GetAffirmativeButton().GetId())

   212

                else:

   213

                    self.Bind(wx.EVT_BUTTON, self.OnOK, id=self.GetSizer().GetItem(3).GetSizer().GetChildren()[0].GetSizer().GetChildren()[0].GetWindow().GetId())

   214

   215

            def OnOK(self, event):

   216

                value = self.GetValue()

   217

                texts = {"value": value}

   218

                for function, message in self.Tests:

   219

                    if not function(value):

   220

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

   221

                        message.ShowModal()

   222

                        message.Destroy()

   223

                        return

   224

                self.EndModal(wx.ID_OK)

   225

                event.Skip()

   226

   227

            def GetValue(self):

   228

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

   229

   230

            def SetTests(self, tests):

   231

                self.Tests = tests

   232

   233

        class BeremizTaskBarIcon(wx.TaskBarIcon):

   234

            TBMENU_START = wx.NewId()

   235

            TBMENU_STOP = wx.NewId()

   236

            TBMENU_CHANGE_NAME = wx.NewId()

   237

            TBMENU_CHANGE_PORT = wx.NewId()

   238

            TBMENU_CHANGE_INTERFACE = wx.NewId()

   239

            TBMENU_LIVE_SHELL = wx.NewId()

   240

            TBMENU_WXINSPECTOR = wx.NewId()

   241

            TBMENU_CHANGE_WD = wx.NewId()

   242

            TBMENU_QUIT = wx.NewId()

   243

   244

            def __init__(self, pyroserver, level):

   245

                wx.TaskBarIcon.__init__(self)

   246

                self.pyroserver = pyroserver

   247

                # Set the image

   248

                self.UpdateIcon(None)

   249

                self.level = level

   250

   251

                # bind some events

   252

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

   253

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

   254

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

   255

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

   256

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

   257

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

   258

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

   259

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

   260

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

   261

   262

            def CreatePopupMenu(self):

   263

                """

   264

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

   265

                the menu for the default EVT_RIGHT_DOWN event.  Just create

   266

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

   267

                the base class takes care of the rest.

   268

                """

   269

                menu = wx.Menu()

   270

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

   271

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

   272

                if self.level == 1:

   273

                    menu.AppendSeparator()

   274

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

   275

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

   276

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

   277

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

   278

                    menu.AppendSeparator()

   279

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

   280

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

   281

                menu.AppendSeparator()

   282

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

   283

                return menu

   284

   285

            def MakeIcon(self, img):

   286

                """

   287

                The various platforms have different requirements for the

   288

                icon size...

   289

                """

   290

                if "wxMSW" in wx.PlatformInfo:

   291

                    img = img.Scale(16, 16)

   292

                elif "wxGTK" in wx.PlatformInfo:

   293

                    img = img.Scale(22, 22)

   294

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

   295

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

   296

                return icon

   297

   298

            def OnTaskBarStartPLC(self, evt):

   299

                if self.pyroserver.plcobj is not None:

   300

                    plcstatus = self.pyroserver.plcobj.GetPLCstatus()[0]

   301

                    if plcstatus is "Stopped":

   302

                        self.pyroserver.plcobj.StartPLC()

   303

                    else:

   304

                        print(_("PLC is empty or already started."))

   305

   306

            def OnTaskBarStopPLC(self, evt):

   307

                if self.pyroserver.plcobj is not None:

   308

                    if self.pyroserver.plcobj.GetPLCstatus()[0] == "Started":

   309

                        Thread(target=self.pyroserver.plcobj.StopPLC).start()

   310

                    else:

   311

                        print(_("PLC is not started."))

   312

   313

            def OnTaskBarChangeInterface(self, evt):

   314

                ip_addr = self.pyroserver.ip_addr

   315

                ip_addr = '' if ip_addr is None else ip_addr

   316

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

   317

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

   318

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

   319

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

   320

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

   321

                    self.pyroserver.ip_addr = dlg.GetValue()

   322

                    self.pyroserver.Stop()

   323

   324

            def OnTaskBarChangePort(self, evt):

   325

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

   326

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

   327

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

   328

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

   329

                    self.pyroserver.Stop()

   330

   331

            def OnTaskBarChangeWorkingDir(self, evt):

   332

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

   333

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

   334

                    self.pyroserver.workdir = dlg.GetPath()

   335

                    self.pyroserver.Stop()

   336

   337

            def OnTaskBarChangeName(self, evt):

   338

                servicename = self.pyroserver.servicename

   339

                servicename = '' if servicename is None else servicename

   340

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

   341

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

   342

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

   343

                    self.pyroserver.servicename = dlg.GetValue()

   344

                    self.pyroserver.Restart()

   345

   346

            def _LiveShellLocals(self):

   347

                if self.pyroserver.plcobj is not None:

   348

                    return {"locals": self.pyroserver.plcobj.python_runtime_vars}

   349

                else:

   350

                    return {}

   351

   352

            def OnTaskBarLiveShell(self, evt):

   353

                from wx import py

   354

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

   355

                frame.Show()

   356

   357

            def OnTaskBarWXInspector(self, evt):

   358

                # Activate the widget inspection tool

   359

                from wx.lib.inspection import InspectionTool

   360

                if not InspectionTool().initialized:

   361

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

   362

   363

                wnd = wx.GetApp()

   364

                InspectionTool().Show(wnd, True)

   365

   366

            def OnTaskBarQuit(self, evt):

   367

                if wx.Platform == '__WXMSW__':

   368

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

   369

                self.RemoveIcon()

   370

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

   371

   372

            def UpdateIcon(self, plcstatus):

   373

                if plcstatus is "Started":

   374

                    currenticon = self.MakeIcon(starticon)

   375

                elif plcstatus is "Stopped":

   376

                    currenticon = self.MakeIcon(stopicon)

   377

                else:

   378

                    currenticon = self.MakeIcon(defaulticon)

   379

                self.SetIcon(currenticon, "Beremiz Service")

   380

   381

   382

if not os.path.isdir(WorkingDir):

   383

    os.mkdir(WorkingDir)

   384

   385

   386

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

   387

    try:

   388

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

   389

    except Exception:

   390

        res = (None, sys.exc_info())

   391

    return res

   392

   393

   394

class Server(object):

   395

    def __init__(self, servicename, ip_addr, port,

   396

                 workdir, argv, autostart=False,

   397

                 statuschange=None, evaluator=default_evaluator,

   398

                 pyruntimevars=None):

   399

        self.continueloop = True

   400

        self.daemon = None

   401

        self.servicename = servicename

   402

        self.ip_addr = ip_addr

   403

        self.port = port

   404

        self.workdir = workdir

   405

        self.argv = argv

   406

        self.plcobj = None

   407

        self.servicepublisher = None

   408

        self.autostart = autostart

   409

        self.statuschange = statuschange

   410

        self.evaluator = evaluator

   411

        self.pyruntimevars = pyruntimevars

   412

   413

    def Loop(self):

   414

        while self.continueloop:

   415

            self.Start()

   416

   417

    def Restart(self):

   418

        self.Stop()

   419

   420

    def Quit(self):

   421

        self.continueloop = False

   422

        if self.plcobj is not None:

   423

            self.plcobj.StopPLC()

   424

            self.plcobj.UnLoadPLC()

   425

        self.Stop()

   426

   427

    def Start(self):

   428

        pyro.initServer()

   429

        self.daemon = pyro.Daemon(host=self.ip_addr, port=self.port)

   430

        self.plcobj = PLCObject(self.workdir, self.daemon, self.argv,

   431

                                self.statuschange, self.evaluator,

   432

                                self.pyruntimevars)

   433

        uri = self.daemon.connect(self.plcobj, "PLCObject")

   434

   435

        print(_("Pyro port :"), self.port)

   436

        print(_("Pyro object's uri :"), uri)

   437

   438

        # Beremiz IDE detects daemon start by looking

   439

        # for self.workdir in the daemon's stdout.

   440

        # Therefore don't delete the following line

   441

        print(_("Current working directory :"), self.workdir)

   442

   443

        # Configure and publish service

   444

        # Not publish service if localhost in address params

   445

        if self.servicename is not None and \

   446

           self.ip_addr is not None and \

   447

           self.ip_addr != "localhost" and \

   448

           self.ip_addr != "127.0.0.1":

   449

            print(_("Publishing service on local network"))

   450

            self.servicepublisher = ServicePublisher.ServicePublisher()

   451

            self.servicepublisher.RegisterService(self.servicename, self.ip_addr, self.port)

   452

   453

        self.plcobj.AutoLoad()

   454

        if self.plcobj.GetPLCstatus()[0] != "Empty":

   455

            if self.autostart:

   456

                self.plcobj.StartPLC()

   457

        self.plcobj.StatusChange()

   458

   459

        sys.stdout.flush()

   460

   461

        self.daemon.requestLoop()

   462

        self.daemon.sock.close()

   463

   464

    def Stop(self):

   465

        if self.plcobj is not None:

   466

            self.plcobj.StopPLC()

   467

        if self.servicepublisher is not None:

   468

            self.servicepublisher.UnRegisterService()

   469

            self.servicepublisher = None

   470

        self.daemon.shutdown(True)

   471

   472

   473

if enabletwisted:

   474

    import warnings

   475

    with warnings.catch_warnings():

   476

        warnings.simplefilter("ignore")

   477

        try:

   478

            if havewx:

   479

                from twisted.internet import wxreactor

   480

                wxreactor.install()

   481

            from twisted.internet import reactor

   482