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

import os, sys, getopt

    27

from threading import Thread

    28

    29

def usage():

    30

    print """

    31

Usage of Beremiz PLC execution service :\n

    32

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

    33

           -n        - zeroconf service name (default:disabled)

    34

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

    35

           -p        - port number default:3000

    36

           -h        - print this help text and quit

    37

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

    38

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

    39

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

    40

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

    41

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

    42

           -e        - python extension (absolute path .py)

    43

    44

           working_dir - directory where are stored PLC files

    45

"""%sys.argv[0]

    46

    47

try:

    48

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

    49

except getopt.GetoptError, err:

    50

    # print help information and exit:

    51

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

    52

    usage()

    53

    sys.exit(2)

    54

    55

# default values

    56

given_ip = None

    57

port = 3000

    58

webport = 8009

    59

wampconf = "wampconf.json"

    60

servicename = None

    61

autostart = False

    62

enablewx = True

    63

havewx = False

    64

enabletwisted = True

    65

havetwisted = False

    66

    67

extensions=[]

    68

    69

for o, a in opts:

    70

    if o == "-h":

    71

        usage()

    72

        sys.exit()

    73

    elif o == "-i":

    74

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

    75

            given_ip = a

    76

        else:

    77

            usage()

    78

            sys.exit()

    79

    elif o == "-p":

    80

        # port: port that the service runs on

    81

        port = int(a)

    82

    elif o == "-n":

    83

        servicename = a

    84

    elif o == "-x":

    85

        enablewx = int(a)

    86

    elif o == "-t":

    87

        enabletwisted = int(a)

    88

    elif o == "-a":

    89

        autostart = int(a)

    90

    elif o == "-w":

    91

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

    92

    elif o == "-c":

    93

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

    94

    elif o == "-e":

    95

        extensions.append(a)

    96

    else:

    97

        usage()

    98

        sys.exit()

    99

   100

import util.paths as paths

   101

beremiz_dir = paths.AbsDir(__file__)

   102

   103

if len(argv) > 1:

   104

    usage()

   105

    sys.exit()

   106

elif len(argv) == 1:

   107

    WorkingDir = argv[0]

   108

    os.chdir(WorkingDir)

   109

elif len(argv) == 0:

   110

    WorkingDir = os.getcwd()

   111

    argv=[WorkingDir]

   112

   113

import __builtin__

   114

if __name__ == '__main__':

   115

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

   116

   117

def Bpath(*args):

   118

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

   119

   120

def SetupI18n():

   121

    # Import module for internationalization

   122

    import gettext

   123

   124

    # Get folder containing translation files

   125

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

   126

    # Get the default language

   127

    langid = wx.LANGUAGE_DEFAULT

   128

    # Define translation domain (name of translation files)

   129

    domain = "Beremiz"

   130

   131

    # Define locale for wx

   132

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

   133

    if loc is None:

   134

        loc = wx.Locale(langid)

   135

        __builtin__.__dict__['loc'] = loc

   136

        # Define location for searching translation files

   137

    loc.AddCatalogLookupPathPrefix(localedir)

   138

    # Define locale domain

   139

    loc.AddCatalog(domain)

   140

   141

   142

    import locale

   143

    global default_locale

   144

    default_locale = locale.getdefaultlocale()[1]

   145

   146

   147

    # sys.stdout.encoding = default_locale

   148

    # if Beremiz_service is started from Beremiz IDE

   149

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

   150

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

   151

    # automatically converted to 'ascii' string.

   152

    def unicode_translation(message):

   153

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

   154

   155

    if __name__ == '__main__':

   156

        __builtin__.__dict__['_'] = unicode_translation

   157

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

   158

   159

if enablewx:

   160

    try:

   161

        import wxversion

   162

        wxversion.select(['2.8', '3.0'])

   163

        import wx

   164

        havewx = True

   165

    except:

   166

        print "Wx unavailable !"

   167

        havewx = False

   168

   169

    if havewx:

   170

        import re

   171

        from threading import Thread, currentThread

   172

        from types import *

   173

   174

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

   175

            app = wx.App(redirect=False)

   176

        else:

   177

            app = wx.PySimpleApp(redirect=False)

   178

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

   179

   180

        default_locale = None

   181

        SetupI18n()

   182

   183

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

   184

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

   185

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

   186

   187

        class ParamsEntryDialog(wx.TextEntryDialog):

   188

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

   189

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

   190

                    if id is not None:

   191

                        event(self, id, function)

   192

                    else:

   193

                        event(self, function)

   194

   195

   196

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

   197

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

   198

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

   199

   200

                self.Tests = []

   201

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

   202

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

   203

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

   204

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

   205

                else:

   206

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

   207

   208

            def OnOK(self, event):

   209

                value = self.GetValue()

   210

                texts = {"value" : value}

   211

                for function, message in self.Tests:

   212

                    if not function(value):

   213

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

   214

                        message.ShowModal()

   215

                        message.Destroy()

   216

                        return

   217

                self.EndModal(wx.ID_OK)

   218

                event.Skip()

   219

   220

            def GetValue(self):

   221

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

   222

   223

            def SetTests(self, tests):

   224

                self.Tests = tests

   225

   226

        class BeremizTaskBarIcon(wx.TaskBarIcon):

   227

            TBMENU_START = wx.NewId()

   228

            TBMENU_STOP = wx.NewId()

   229

            TBMENU_CHANGE_NAME = wx.NewId()

   230

            TBMENU_CHANGE_PORT = wx.NewId()

   231

            TBMENU_CHANGE_INTERFACE = wx.NewId()

   232

            TBMENU_LIVE_SHELL = wx.NewId()

   233

            TBMENU_WXINSPECTOR = wx.NewId()

   234

            TBMENU_CHANGE_WD = wx.NewId()

   235

            TBMENU_QUIT = wx.NewId()

   236

   237

            def __init__(self, pyroserver, level):

   238

                wx.TaskBarIcon.__init__(self)

   239

                self.pyroserver = pyroserver

   240

                # Set the image

   241

                self.UpdateIcon(None)

   242

                self.level = level

   243

   244

                # bind some events

   245

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

   246

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

   247

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

   248

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

   249

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

   250

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

   251

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

   252

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

   253

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

   254

   255

            def CreatePopupMenu(self):

   256

                """

   257

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

   258

                the menu for the default EVT_RIGHT_DOWN event.  Just create

   259

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

   260

                the base class takes care of the rest.

   261

                """

   262

                menu = wx.Menu()

   263

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

   264

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

   265

                if self.level==1:

   266

                    menu.AppendSeparator()

   267

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

   268

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

   269

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

   270

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

   271

                    menu.AppendSeparator()

   272

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

   273

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

   274

                menu.AppendSeparator()

   275

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

   276

                return menu

   277

   278

            def MakeIcon(self, img):

   279

                """

   280

                The various platforms have different requirements for the

   281

                icon size...

   282

                """

   283

                if "wxMSW" in wx.PlatformInfo:

   284

                    img = img.Scale(16, 16)

   285

                elif "wxGTK" in wx.PlatformInfo:

   286

                    img = img.Scale(22, 22)

   287

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

   288

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

   289

                return icon

   290

   291

            def OnTaskBarStartPLC(self, evt):

   292

                if self.pyroserver.plcobj is not None:

   293

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

   294

                    if  plcstatus is "Stopped":

   295

                        self.pyroserver.plcobj.StartPLC()

   296

                    else:

   297

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

   298

   299

            def OnTaskBarStopPLC(self, evt):

   300

                if self.pyroserver.plcobj is not None:

   301

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

   302

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

   303

                    else:

   304

                        print _("PLC is not started.")

   305

   306

            def OnTaskBarChangeInterface(self, evt):

   307

                ip_addr = self.pyroserver.ip_addr

   308

                ip_addr = '' if ip_addr is None else ip_addr

   309

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

   310

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

   311

                               ( lambda x :len([x for x in x.split(".") if 0 <= int(x) <= 255]) == 4, _("IP is not valid!"))

   312

                               ])

   313

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

   314

                    self.pyroserver.ip_addr = dlg.GetValue()

   315

                    self.pyroserver.Stop()

   316

   317

            def OnTaskBarChangePort(self, evt):

   318

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

   319

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

   320

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

   321

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

   322

                    self.pyroserver.Stop()

   323

   324

            def OnTaskBarChangeWorkingDir(self, evt):

   325

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

   326

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

   327

                    self.pyroserver.workdir = dlg.GetPath()

   328

                    self.pyroserver.Stop()

   329

   330

            def OnTaskBarChangeName(self, evt):

   331

                servicename = self.pyroserver.servicename

   332

                servicename = '' if servicename is None else servicename

   333

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

   334

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

   335

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

   336

                    self.pyroserver.servicename = dlg.GetValue()

   337

                    self.pyroserver.Restart()

   338

   339

            def _LiveShellLocals(self):

   340

                if self.pyroserver.plcobj is not None:

   341

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

   342

                else:

   343

                    return {}

   344

   345

            def OnTaskBarLiveShell(self, evt):

   346

                from wx import py

   347

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

   348

                frame.Show()

   349

   350

            def OnTaskBarWXInspector(self, evt):

   351

                # Activate the widget inspection tool

   352

                from wx.lib.inspection import InspectionTool

   353

                if not InspectionTool().initialized:

   354

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

   355

   356

                wnd = wx.GetApp()

   357

                InspectionTool().Show(wnd, True)

   358

   359

            def OnTaskBarQuit(self, evt):

   360

                if wx.Platform == '__WXMSW__':

   361

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

   362

                self.RemoveIcon()

   363

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

   364

   365

            def UpdateIcon(self, plcstatus):

   366

                if plcstatus is "Started" :

   367

                    currenticon = self.MakeIcon(starticon)

   368

                elif plcstatus is "Stopped":

   369

                    currenticon = self.MakeIcon(stopicon)

   370

                else:

   371

                    currenticon = self.MakeIcon(defaulticon)

   372

                self.SetIcon(currenticon, "Beremiz Service")

   373

   374

from runtime import PLCObject, PLCprint, ServicePublisher

   375

import Pyro.core as pyro

   376

   377

if not os.path.isdir(WorkingDir):

   378

    os.mkdir(WorkingDir)

   379

   380

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

   381

    try:

   382

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

   383

    except Exception:

   384

        res=(None, sys.exc_info())

   385

    return res

   386

   387

class Server():

   388

    def __init__(self, servicename, ip_addr, port,

   389

                 workdir, argv, autostart=False,

   390

                 statuschange=None, evaluator=default_evaluator,

   391

                 pyruntimevars=None):

   392

        self.continueloop = True

   393

        self.daemon = None

   394

        self.servicename = servicename

   395

        self.ip_addr = ip_addr

   396

        self.port = port

   397

        self.workdir = workdir

   398

        self.argv = argv

   399

        self.plcobj = None

   400

        self.servicepublisher = None

   401

        self.autostart = autostart

   402

        self.statuschange = statuschange

   403

        self.evaluator = evaluator

   404

        self.pyruntimevars = pyruntimevars

   405

   406

    def Loop(self):

   407

        while self.continueloop:

   408

            self.Start()

   409

   410

    def Restart(self):

   411

        self.Stop()

   412

   413

    def Quit(self):

   414

        self.continueloop = False

   415

        if self.plcobj is not None:

   416

            self.plcobj.StopPLC()

   417

            self.plcobj.UnLoadPLC()

   418

        self.Stop()

   419

   420

    def Start(self):

   421

        pyro.initServer()

   422

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

   423

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

   424

                                self.statuschange, self.evaluator,

   425

                                self.pyruntimevars)

   426

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

   427

   428

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

   429

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

   430

   431

        # Beremiz IDE detects daemon start by looking

   432

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

   433

        # Therefore don't delete the following line

   434

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

   435

   436

        # Configure and publish service

   437

        # Not publish service if localhost in address params

   438

        if (self.servicename is not None and

   439

            self.ip_addr is not None and

   440

            self.ip_addr != "localhost" and

   441

            self.ip_addr != "127.0.0.1"):

   442

            print _("Publishing service on local network")

   443

            self.servicepublisher = ServicePublisher.ServicePublisher()

   444

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

   445

   446

        self.plcobj.AutoLoad()

   447

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

   448

            if self.autostart :

   449

                self.plcobj.StartPLC()

   450

        self.plcobj.StatusChange()

   451

   452

        sys.stdout.flush()

   453

   454

        self.daemon.requestLoop()

   455

        self.daemon.sock.close()

   456

   457

    def Stop(self):

   458

        if self.plcobj is not None:

   459

            self.plcobj.StopPLC()

   460

        if self.servicepublisher is not None:

   461

            self.servicepublisher.UnRegisterService()

   462

            self.servicepublisher = None

   463

        self.daemon.shutdown(True)

   464

   465

if enabletwisted:

   466

    import warnings

   467

    with warnings.catch_warnings():

   468

        warnings.simplefilter("ignore")

   469

        try:

   470

            from threading import Thread, currentThread

   471

            if havewx:

   472

                from twisted.internet import wxreactor

   473

                wxreactor.install()

   474

            from twisted.internet import reactor

   475

   476

            havetwisted = True

   477

        except:

   478

            print _("Twisted unavailable.")

   479

            havetwisted = False

   480

   481

pyruntimevars = {}

   482

statuschange = []

   483

   484

if havetwisted:

   485