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

    29

from threading import Thread

    30

    31

def usage():

    32

    print """

    33

Usage of Beremiz PLC execution service :\n

    34

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

    35

           -n        - zeroconf service name (default:disabled)

    36

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

    37

           -p        - port number default:3000

    38

           -h        - print this help text and quit

    39

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

    40

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

    41

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

    42

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

    43

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

    44

           -e        - python extension (absolute path .py)

    45

    46

           working_dir - directory where are stored PLC files

    47

"""%sys.argv[0]

    48

    49

try:

    50

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

    51

except getopt.GetoptError, err:

    52

    # print help information and exit:

    53

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

    54

    usage()

    55

    sys.exit(2)

    56

    57

# default values

    58

given_ip = None

    59

port = 3000

    60

webport = 8009

    61

wampconf = "wampconf.json"

    62

servicename = None

    63

autostart = False

    64

enablewx = True

    65

havewx = False

    66

enabletwisted = True

    67

havetwisted = False

    68

    69

extensions=[]

    70

    71

for o, a in opts:

    72

    if o == "-h":

    73

        usage()

    74

        sys.exit()

    75

    elif o == "-i":

    76

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

    77

            given_ip = a

    78

        else:

    79

            usage()

    80

            sys.exit()

    81

    elif o == "-p":

    82

        # port: port that the service runs on

    83

        port = int(a)

    84

    elif o == "-n":

    85

        servicename = a

    86

    elif o == "-x":

    87

        enablewx = int(a)

    88

    elif o == "-t":

    89

        enabletwisted = int(a)

    90

    elif o == "-a":

    91

        autostart = int(a)

    92

    elif o == "-w":

    93

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

    94

    elif o == "-c":

    95

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

    96

    elif o == "-e":

    97

        extensions.append(a)

    98

    else:

    99

        usage()

   100

        sys.exit()

   101

   102

import util.paths as paths

   103

beremiz_dir = paths.AbsDir(__file__)

   104

   105

if len(argv) > 1:

   106

    usage()

   107

    sys.exit()

   108

elif len(argv) == 1:

   109

    WorkingDir = argv[0]

   110

    os.chdir(WorkingDir)

   111

elif len(argv) == 0:

   112

    WorkingDir = os.getcwd()

   113

    argv=[WorkingDir]

   114

   115

import __builtin__

   116

if __name__ == '__main__':

   117

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

   118

   119

def Bpath(*args):

   120

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

   121

   122

def SetupI18n():

   123

    # Import module for internationalization

   124

    import gettext

   125

   126

    # Get folder containing translation files

   127

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

   128

    # Get the default language

   129

    langid = wx.LANGUAGE_DEFAULT

   130

    # Define translation domain (name of translation files)

   131

    domain = "Beremiz"

   132

   133

    # Define locale for wx

   134

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

   135

    if loc is None:

   136

        loc = wx.Locale(langid)

   137

        __builtin__.__dict__['loc'] = loc

   138

        # Define location for searching translation files

   139

    loc.AddCatalogLookupPathPrefix(localedir)

   140

    # Define locale domain

   141

    loc.AddCatalog(domain)

   142

   143

   144

    import locale

   145

    global default_locale

   146

    default_locale = locale.getdefaultlocale()[1]

   147

   148

   149

    # sys.stdout.encoding = default_locale

   150

    # if Beremiz_service is started from Beremiz IDE

   151

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

   152

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

   153

    # automatically converted to 'ascii' string.

   154

    def unicode_translation(message):

   155

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

   156

   157

    if __name__ == '__main__':

   158

        __builtin__.__dict__['_'] = unicode_translation

   159

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

   160

   161

if enablewx:

   162

    try:

   163

        import wxversion

   164

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

   165

        import wx

   166

        havewx = True

   167

    except:

   168

        print "Wx unavailable !"

   169

        havewx = False

   170

   171

    if havewx:

   172

        import re

   173

        from threading import Thread, currentThread

   174

        from types import *

   175

   176

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

   177

            app = wx.App(redirect=False)

   178

        else:

   179

            app = wx.PySimpleApp(redirect=False)

   180

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

   181

   182

        default_locale = None

   183

        SetupI18n()

   184

   185

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

   186

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

   187

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

   188

   189

        class ParamsEntryDialog(wx.TextEntryDialog):

   190

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

   191

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

   192

                    if id is not None:

   193

                        event(self, id, function)

   194

                    else:

   195

                        event(self, function)

   196

   197

   198

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

   199

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

   200

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

   201

   202

                self.Tests = []

   203

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

   204

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

   205

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

   206

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

   207

                else:

   208

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

   209

   210

            def OnOK(self, event):

   211

                value = self.GetValue()

   212

                texts = {"value" : value}

   213

                for function, message in self.Tests:

   214

                    if not function(value):

   215

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

   216

                        message.ShowModal()

   217

                        message.Destroy()

   218

                        return

   219

                self.EndModal(wx.ID_OK)

   220

                event.Skip()

   221

   222

            def GetValue(self):

   223

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

   224

   225

            def SetTests(self, tests):

   226

                self.Tests = tests

   227

   228

        class BeremizTaskBarIcon(wx.TaskBarIcon):

   229

            TBMENU_START = wx.NewId()

   230

            TBMENU_STOP = wx.NewId()

   231

            TBMENU_CHANGE_NAME = wx.NewId()

   232

            TBMENU_CHANGE_PORT = wx.NewId()

   233

            TBMENU_CHANGE_INTERFACE = wx.NewId()

   234

            TBMENU_LIVE_SHELL = wx.NewId()

   235

            TBMENU_WXINSPECTOR = wx.NewId()

   236

            TBMENU_CHANGE_WD = wx.NewId()

   237

            TBMENU_QUIT = wx.NewId()

   238

   239

            def __init__(self, pyroserver, level):

   240

                wx.TaskBarIcon.__init__(self)

   241

                self.pyroserver = pyroserver

   242

                # Set the image

   243

                self.UpdateIcon(None)

   244

                self.level = level

   245

   246

                # bind some events

   247

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

   248

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

   249

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

   250

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

   251

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

   252

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

   253

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

   254

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

   255

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

   256

   257

            def CreatePopupMenu(self):

   258

                """

   259

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

   260

                the menu for the default EVT_RIGHT_DOWN event.  Just create

   261

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

   262

                the base class takes care of the rest.

   263

                """

   264

                menu = wx.Menu()

   265

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

   266

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

   267

                if self.level==1:

   268

                    menu.AppendSeparator()

   269

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

   270

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

   271

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

   272

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

   273

                    menu.AppendSeparator()

   274

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

   275

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

   276

                menu.AppendSeparator()

   277

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

   278

                return menu

   279

   280

            def MakeIcon(self, img):

   281

                """

   282

                The various platforms have different requirements for the

   283

                icon size...

   284

                """

   285

                if "wxMSW" in wx.PlatformInfo:

   286

                    img = img.Scale(16, 16)

   287

                elif "wxGTK" in wx.PlatformInfo:

   288

                    img = img.Scale(22, 22)

   289

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

   290

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

   291

                return icon

   292

   293

            def OnTaskBarStartPLC(self, evt):

   294

                if self.pyroserver.plcobj is not None:

   295

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

   296

                    if  plcstatus is "Stopped":

   297

                        self.pyroserver.plcobj.StartPLC()

   298

                    else:

   299

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

   300

   301

            def OnTaskBarStopPLC(self, evt):

   302

                if self.pyroserver.plcobj is not None:

   303

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

   304

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

   305

                    else:

   306

                        print _("PLC is not started.")

   307

   308

            def OnTaskBarChangeInterface(self, evt):

   309

                ip_addr = self.pyroserver.ip_addr

   310

                ip_addr = '' if ip_addr is None else ip_addr

   311

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

   312

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

   313

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

   314

                               ])

   315

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

   316

                    self.pyroserver.ip_addr = dlg.GetValue()

   317

                    self.pyroserver.Stop()

   318

   319

            def OnTaskBarChangePort(self, evt):

   320

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

   321

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

   322

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

   323

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

   324

                    self.pyroserver.Stop()

   325

   326

            def OnTaskBarChangeWorkingDir(self, evt):

   327

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

   328

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

   329

                    self.pyroserver.workdir = dlg.GetPath()

   330

                    self.pyroserver.Stop()

   331

   332

            def OnTaskBarChangeName(self, evt):

   333

                servicename = self.pyroserver.servicename

   334

                servicename = '' if servicename is None else servicename

   335

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

   336

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

   337

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

   338

                    self.pyroserver.servicename = dlg.GetValue()

   339

                    self.pyroserver.Restart()

   340

   341

            def _LiveShellLocals(self):

   342

                if self.pyroserver.plcobj is not None:

   343

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

   344

                else:

   345

                    return {}

   346

   347

            def OnTaskBarLiveShell(self, evt):

   348

                from wx import py

   349

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

   350

                frame.Show()

   351

   352

            def OnTaskBarWXInspector(self, evt):

   353

                # Activate the widget inspection tool

   354

                from wx.lib.inspection import InspectionTool

   355

                if not InspectionTool().initialized:

   356

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

   357

   358

                wnd = wx.GetApp()

   359

                InspectionTool().Show(wnd, True)

   360

   361

            def OnTaskBarQuit(self, evt):

   362

                if wx.Platform == '__WXMSW__':

   363

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

   364

                self.RemoveIcon()

   365

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

   366

   367

            def UpdateIcon(self, plcstatus):

   368

                if plcstatus is "Started" :

   369

                    currenticon = self.MakeIcon(starticon)

   370

                elif plcstatus is "Stopped":

   371

                    currenticon = self.MakeIcon(stopicon)

   372

                else:

   373

                    currenticon = self.MakeIcon(defaulticon)

   374

                self.SetIcon(currenticon, "Beremiz Service")

   375

   376

from runtime import PLCObject, PLCprint, ServicePublisher

   377

import Pyro.core as pyro

   378

   379

if not os.path.isdir(WorkingDir):

   380

    os.mkdir(WorkingDir)

   381

   382

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

   383

    try:

   384

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

   385

    except Exception:

   386

        res=(None, sys.exc_info())

   387

    return res

   388

   389

class Server():

   390

    def __init__(self, servicename, ip_addr, port,

   391

                 workdir, argv, autostart=False,

   392

                 statuschange=None, evaluator=default_evaluator,

   393

                 pyruntimevars=None):

   394

        self.continueloop = True

   395

        self.daemon = None

   396

        self.servicename = servicename

   397

        self.ip_addr = ip_addr

   398

        self.port = port

   399

        self.workdir = workdir

   400

        self.argv = argv

   401

        self.plcobj = None

   402

        self.servicepublisher = None

   403

        self.autostart = autostart

   404

        self.statuschange = statuschange

   405

        self.evaluator = evaluator

   406

        self.pyruntimevars = pyruntimevars

   407

   408

    def Loop(self):

   409

        while self.continueloop:

   410

            self.Start()

   411

   412

    def Restart(self):

   413

        self.Stop()

   414

   415

    def Quit(self):

   416

        self.continueloop = False

   417

        if self.plcobj is not None:

   418

            self.plcobj.StopPLC()

   419

            self.plcobj.UnLoadPLC()

   420

        self.Stop()

   421

   422

    def Start(self):

   423

        pyro.initServer()

   424

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

   425

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

   426

                                self.statuschange, self.evaluator,

   427

                                self.pyruntimevars)

   428

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

   429

   430

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

   431

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

   432

   433

        # Beremiz IDE detects daemon start by looking

   434

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

   435

        # Therefore don't delete the following line

   436

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

   437

   438

        # Configure and publish service

   439

        # Not publish service if localhost in address params

   440

        if (self.servicename is not None and

   441

            self.ip_addr is not None and

   442

            self.ip_addr != "localhost" and

   443

            self.ip_addr != "127.0.0.1"):

   444

            print _("Publishing service on local network")

   445

            self.servicepublisher = ServicePublisher.ServicePublisher()

   446

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

   447

   448

        self.plcobj.AutoLoad()

   449

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

   450

            if self.autostart :

   451

                self.plcobj.StartPLC()

   452

        self.plcobj.StatusChange()

   453

   454

        sys.stdout.flush()

   455

   456

        self.daemon.requestLoop()

   457

        self.daemon.sock.close()

   458

   459

    def Stop(self):

   460

        if self.plcobj is not None:

   461

            self.plcobj.StopPLC()

   462

        if self.servicepublisher is not None:

   463

            self.servicepublisher.UnRegisterService()

   464

            self.servicepublisher = None

   465

        self.daemon.shutdown(True)

   466

   467

if enabletwisted:

   468

    import warnings

   469

    with warnings.catch_warnings():

   470

        warnings.simplefilter("ignore")

   471

        try:

   472

            from threading import Thread, currentThread

   473

            if havewx:

   474

                from twisted.internet import wxreactor

   475

                wxreactor.install()

   476

            from twisted.internet import reactor

   477

   478

            havetwisted = True

   479

        except:

   480

            print _("Twisted unavailable.")

   481

            havetwisted = False

   482

   483

pyruntimevars = {}

   484

statuschange = []

   485