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

           -s        - WAMP client secret, given as a file or "off"

    56

           -e        - python extension (absolute path .py)

    57

    58

           working_dir - directory where are stored PLC files

    59

""" % sys.argv[0])

    60

    61

    62

try:

    63

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

    64

except getopt.GetoptError, err:

    65

    # print help information and exit:

    66

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

    67

    usage()

    68

    sys.exit(2)

    69

    70

# default values

    71

given_ip = None

    72

port = 3000

    73

webport = 8009

    74

wampsecret = None

    75

wampconf = None

    76

servicename = None

    77

autostart = False

    78

enablewx = True

    79

havewx = False

    80

enabletwisted = True

    81

havetwisted = False

    82

    83

extensions = []

    84

    85

for o, a in opts:

    86

    if o == "-h":

    87

        usage()

    88

        sys.exit()

    89

    elif o == "-i":

    90

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

    91

            given_ip = a

    92

        else:

    93

            usage()

    94

            sys.exit()

    95

    elif o == "-p":

    96

        # port: port that the service runs on

    97

        port = int(a)

    98

    elif o == "-n":

    99

        servicename = a

   100

    elif o == "-x":

   101

        enablewx = int(a)

   102

    elif o == "-t":

   103

        enabletwisted = int(a)

   104

    elif o == "-a":

   105

        autostart = int(a)

   106

    elif o == "-w":

   107

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

   108

    elif o == "-c":

   109

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

   110

    elif o == "-s":

   111

        wampsecret = None if a == "off" else a

   112

    elif o == "-e":

   113

        extensions.append(a)

   114

    else:

   115

        usage()

   116

        sys.exit()

   117

   118

   119

beremiz_dir = paths.AbsDir(__file__)

   120

   121

if len(argv) > 1:

   122

    usage()

   123

    sys.exit()

   124

elif len(argv) == 1:

   125

    WorkingDir = argv[0]

   126

    os.chdir(WorkingDir)

   127

elif len(argv) == 0:

   128

    WorkingDir = os.getcwd()

   129

    argv = [WorkingDir]

   130

   131

if __name__ == '__main__':

   132

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

   133

   134

   135

def Bpath(*args):

   136

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

   137

   138

   139

def SetupI18n():

   140

    # Get folder containing translation files

   141

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

   142

    # Get the default language

   143

    langid = wx.LANGUAGE_DEFAULT

   144

    # Define translation domain (name of translation files)

   145

    domain = "Beremiz"

   146

   147

    # Define locale for wx

   148

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

   149

    if loc is None:

   150

        loc = wx.Locale(langid)

   151

        __builtin__.__dict__['loc'] = loc

   152

        # Define location for searching translation files

   153

    loc.AddCatalogLookupPathPrefix(localedir)

   154

    # Define locale domain

   155

    loc.AddCatalog(domain)

   156

   157

    import locale

   158

    global default_locale

   159

    default_locale = locale.getdefaultlocale()[1]

   160

   161

    # sys.stdout.encoding = default_locale

   162

    # if Beremiz_service is started from Beremiz IDE

   163

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

   164

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

   165

    # automatically converted to 'ascii' string.

   166

    def unicode_translation(message):

   167

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

   168

   169

    if __name__ == '__main__':

   170

        __builtin__.__dict__['_'] = unicode_translation

   171

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

   172

   173

   174

if enablewx:

   175

    try:

   176

        import wx

   177

        havewx = True

   178

    except ImportError:

   179

        print("Wx unavailable !")

   180

        havewx = False

   181

   182

    if havewx:

   183

        import re

   184

        from types import *

   185

   186

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

   187

            app = wx.App(redirect=False)

   188

        else:

   189

            app = wx.PySimpleApp(redirect=False)

   190

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

   191

   192

        default_locale = None

   193

        SetupI18n()

   194

   195

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

   196

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

   197

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

   198

   199

        class ParamsEntryDialog(wx.TextEntryDialog):

   200

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

   201

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

   202

                    if id is not None:

   203

                        event(self, id, function)

   204

                    else:

   205

                        event(self, function)

   206

   207

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

   208

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

   209

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

   210

   211

                self.Tests = []

   212

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

   213

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

   214

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

   215

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

   216

                else:

   217

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

   218

   219

            def OnOK(self, event):

   220

                value = self.GetValue()

   221

                texts = {"value": value}

   222

                for function, message in self.Tests:

   223

                    if not function(value):

   224

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

   225

                        message.ShowModal()

   226

                        message.Destroy()

   227

                        return

   228

                self.EndModal(wx.ID_OK)

   229

                event.Skip()

   230

   231

            def GetValue(self):

   232

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

   233

   234

            def SetTests(self, tests):

   235

                self.Tests = tests

   236

   237

        class BeremizTaskBarIcon(wx.TaskBarIcon):

   238

            TBMENU_START = wx.NewId()

   239

            TBMENU_STOP = wx.NewId()

   240

            TBMENU_CHANGE_NAME = wx.NewId()

   241

            TBMENU_CHANGE_PORT = wx.NewId()

   242

            TBMENU_CHANGE_INTERFACE = wx.NewId()

   243

            TBMENU_LIVE_SHELL = wx.NewId()

   244

            TBMENU_WXINSPECTOR = wx.NewId()

   245

            TBMENU_CHANGE_WD = wx.NewId()

   246

            TBMENU_QUIT = wx.NewId()

   247

   248

            def __init__(self, pyroserver, level):

   249

                wx.TaskBarIcon.__init__(self)

   250

                self.pyroserver = pyroserver

   251

                # Set the image

   252

                self.UpdateIcon(None)

   253

                self.level = level

   254

   255

                # bind some events

   256

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

   257

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

   258

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

   259

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

   260

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

   261

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

   262

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

   263

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

   264

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

   265

   266

            def CreatePopupMenu(self):

   267

                """

   268

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

   269

                the menu for the default EVT_RIGHT_DOWN event.  Just create

   270

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

   271

                the base class takes care of the rest.

   272

                """

   273

                menu = wx.Menu()

   274

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

   275

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

   276

                if self.level == 1:

   277

                    menu.AppendSeparator()

   278

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

   279

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

   280

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

   281

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

   282

                    menu.AppendSeparator()

   283

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

   284

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

   285

                menu.AppendSeparator()

   286

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

   287

                return menu

   288

   289

            def MakeIcon(self, img):

   290

                """

   291

                The various platforms have different requirements for the

   292

                icon size...

   293

                """

   294

                if "wxMSW" in wx.PlatformInfo:

   295

                    img = img.Scale(16, 16)

   296

                elif "wxGTK" in wx.PlatformInfo:

   297

                    img = img.Scale(22, 22)

   298

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

   299

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

   300

                return icon

   301

   302

            def OnTaskBarStartPLC(self, evt):

   303

                if self.pyroserver.plcobj is not None:

   304

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

   305

                    if plcstatus is "Stopped":

   306

                        self.pyroserver.plcobj.StartPLC()

   307

                    else:

   308

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

   309

   310

            def OnTaskBarStopPLC(self, evt):

   311

                if self.pyroserver.plcobj is not None:

   312

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

   313

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

   314

                    else:

   315

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

   316

   317

            def OnTaskBarChangeInterface(self, evt):

   318

                ip_addr = self.pyroserver.ip_addr

   319

                ip_addr = '' if ip_addr is None else ip_addr

   320

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

   321

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

   322

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

   323

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

   324

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

   325

                    self.pyroserver.ip_addr = dlg.GetValue()

   326

                    self.pyroserver.Restart()

   327

   328

            def OnTaskBarChangePort(self, evt):

   329

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

   330

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

   331

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

   332

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

   333

                    self.pyroserver.Restart()

   334

   335

            def OnTaskBarChangeWorkingDir(self, evt):

   336

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

   337

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

   338

                    self.pyroserver.workdir = dlg.GetPath()

   339

                    self.pyroserver.Restart()

   340

   341

            def OnTaskBarChangeName(self, evt):

   342

                servicename = self.pyroserver.servicename

   343

                servicename = '' if servicename is None else servicename

   344

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

   345

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

   346

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

   347

                    self.pyroserver.servicename = dlg.GetValue()

   348

                    self.pyroserver.Restart()

   349

   350

            def _LiveShellLocals(self):

   351

                if self.pyroserver.plcobj is not None:

   352

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

   353

                else:

   354

                    return {}

   355

   356

            def OnTaskBarLiveShell(self, evt):

   357

                from wx import py

   358

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

   359

                frame.Show()

   360

   361

            def OnTaskBarWXInspector(self, evt):

   362

                # Activate the widget inspection tool

   363

                from wx.lib.inspection import InspectionTool

   364

                if not InspectionTool().initialized:

   365

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

   366

   367

                wnd = wx.GetApp()

   368

                InspectionTool().Show(wnd, True)

   369

   370

            def OnTaskBarQuit(self, evt):

   371

                if wx.Platform == '__WXMSW__':

   372

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

   373

                self.RemoveIcon()

   374

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

   375

   376

            def UpdateIcon(self, plcstatus):

   377

                if plcstatus is "Started":

   378

                    currenticon = self.MakeIcon(starticon)

   379

                elif plcstatus is "Stopped":

   380

                    currenticon = self.MakeIcon(stopicon)

   381

                else:

   382

                    currenticon = self.MakeIcon(defaulticon)

   383

                self.SetIcon(currenticon, "Beremiz Service")

   384

   385

   386

if not os.path.isdir(WorkingDir):

   387

    os.mkdir(WorkingDir)

   388

   389

   390

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

   391

    try:

   392

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

   393

    except Exception:

   394

        res = (None, sys.exc_info())

   395

    return res

   396

   397

   398

class Server(object):

   399

    def __init__(self, servicename, ip_addr, port,

   400

                 workdir, argv, autostart=False,

   401

                 statuschange=None, evaluator=default_evaluator,

   402

                 pyruntimevars=None):

   403

        self.continueloop = True

   404

        self.daemon = None

   405

        self.servicename = servicename

   406

        self.ip_addr = ip_addr

   407

        self.port = port

   408

        self.workdir = workdir

   409

        self.argv = argv

   410

        self.plcobj = None

   411

        self.servicepublisher = None

   412

        self.autostart = autostart

   413

        self.statuschange = statuschange

   414

        self.evaluator = evaluator

   415

        self.pyruntimevars = pyruntimevars

   416

   417

    def Loop(self):

   418

        while self.continueloop:

   419

            pyro.initServer()

   420

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

   421

            # pyro never frees memory after connection close if no timeout set 

   422

            self.daemon.setTimeout(1);

   423

            self.Start()

   424

            self.daemon.requestLoop()

   425

            self.daemon.sock.close()

   426

   427

    def Restart(self):

   428

        self._stop()

   429

   430

    def Quit(self):

   431

        self.continueloop = False

   432

        if self.plcobj is not None:

   433

            self.plcobj.StopPLC()

   434

            self.plcobj.UnLoadPLC()

   435

        self._stop()

   436

   437

    def Start(self):

   438

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

   439

                                self.statuschange, self.evaluator,

   440

                                self.pyruntimevars)

   441

   442

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

   443

   444

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

   445

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

   446

   447

        # Beremiz IDE detects daemon start by looking

   448

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

   449

        # Therefore don't delete the following line

   450

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

   451

   452

        # Configure and publish service

   453

        # Not publish service if localhost in address params

   454

        if self.servicename is not None and \

   455

           self.ip_addr is not None and \

   456

           self.ip_addr != "localhost" and \

   457

           self.ip_addr != "127.0.0.1":

   458

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

   459

            self.servicepublisher = ServicePublisher.ServicePublisher()

   460

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

   461

   462

        self.plcobj.AutoLoad()

   463

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

   464

            if self.autostart:

   465

                self.plcobj.StartPLC()

   466

        self.plcobj.StatusChange()

   467

   468

        sys.stdout.flush()

   469

   470

   471

    def _stop(self):

   472

        if self.plcobj is not None:

   473

            self.plcobj.StopPLC()

   474

        if self.servicepublisher is not None:

   475

            self.servicepublisher.UnRegisterService()

   476

            self.servicepublisher = None

   477

        self.daemon.shutdown(True)

   478

   479

   480

if enabletwisted:

   481

    import warnings