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

    27

import sys

    28

import getopt

    29

from threading import Thread

    30

    31

    32

def usage():

    33

    print """

    34

Usage of Beremiz PLC execution service :\n

    35

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

    36

           -n        - zeroconf service name (default:disabled)

    37

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

    38

           -p        - port number default:3000

    39

           -h        - print this help text and quit

    40

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

    41

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

    42

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

    43

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

    44

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

    45

           -e        - python extension (absolute path .py)

    46

    47

           working_dir - directory where are stored PLC files

    48

""" % sys.argv[0]

    49

    50

try:

    51

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

    52

except getopt.GetoptError, err:

    53

    # print help information and exit:

    54

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

    55

    usage()

    56

    sys.exit(2)

    57

    58

# default values

    59

given_ip = None

    60

port = 3000

    61

webport = 8009

    62

wampconf = "wampconf.json"

    63

servicename = None

    64

autostart = False

    65

enablewx = True

    66

havewx = False

    67

enabletwisted = True

    68

havetwisted = False

    69

    71

    72

for o, a in opts:

    73

    if o == "-h":

    74

        usage()

    75

        sys.exit()

    76

    elif o == "-i":

    77

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

    78

            given_ip = a

    79

        else:

    80

            usage()

    81

            sys.exit()

    82

    elif o == "-p":

    83

        # port: port that the service runs on

    84

        port = int(a)

    85

    elif o == "-n":

    86

        servicename = a

    87

    elif o == "-x":

    88

        enablewx = int(a)

    89

    elif o == "-t":

    90

        enabletwisted = int(a)

    91

    elif o == "-a":

    92

        autostart = int(a)

    93

    elif o == "-w":

    94

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

    95

    elif o == "-c":

    96

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

    97

    elif o == "-e":

    98

        extensions.append(a)

    99

    else:

   100

        usage()

   101

        sys.exit()

   102

   103

import util.paths as paths

   104

beremiz_dir = paths.AbsDir(__file__)

   105

   106

if len(argv) > 1:

   107

    usage()

   108

    sys.exit()

   109

elif len(argv) == 1:

   110

    WorkingDir = argv[0]

   111

    os.chdir(WorkingDir)

   112

elif len(argv) == 0:

   113

    WorkingDir = os.getcwd()

   115

   116

import __builtin__

   117

if __name__ == '__main__':

   118

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

   119

   120

   121

def Bpath(*args):

   122

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

   123

   124

   125

def SetupI18n():

   126

    # Import module for internationalization

   127

    import gettext

   128

   129

    # Get folder containing translation files

   130

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

   131

    # Get the default language

   132

    langid = wx.LANGUAGE_DEFAULT

   133

    # Define translation domain (name of translation files)

   134

    domain = "Beremiz"

   135

   136

    # Define locale for wx

   137

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

   138

    if loc is None:

   139

        loc = wx.Locale(langid)

   140

        __builtin__.__dict__['loc'] = loc

   141

        # Define location for searching translation files

   142

    loc.AddCatalogLookupPathPrefix(localedir)

   143

    # Define locale domain

   144

    loc.AddCatalog(domain)

   145

   146

    import locale

   147

    global default_locale

   148

    default_locale = locale.getdefaultlocale()[1]

   149

   150

    # sys.stdout.encoding = default_locale

   151

    # if Beremiz_service is started from Beremiz IDE

   152

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

   153

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

   154

    # automatically converted to 'ascii' string.

   155

    def unicode_translation(message):

   156

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

   157

   158

    if __name__ == '__main__':

   159

        __builtin__.__dict__['_'] = unicode_translation

   160

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

   161

   162

if enablewx:

   163

    try:

   164

        import wxversion

   165

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

   166

        import wx

   167

        havewx = True

   168

    except:

   169

        print "Wx unavailable !"

   170

        havewx = False

   171

   172

    if havewx:

   173

        import re

   174

        from threading import Thread, currentThread

   175

        from types import *

   176

   177

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

   178

            app = wx.App(redirect=False)

   179

        else:

   180

            app = wx.PySimpleApp(redirect=False)

   181

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

   182

   183

        default_locale = None

   184

        SetupI18n()

   185

   186

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

   187

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

   188

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

   189

   190

        class ParamsEntryDialog(wx.TextEntryDialog):

   191

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

   192

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

   193

                    if id is not None:

   194

                        event(self, id, function)

   195

                    else:

   196

                        event(self, function)

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

   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

   383

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

   384

    try:

   386

    except Exception:

   388

    return res

   389

   390

   391

class Server():

   392

    def __init__(self, servicename, ip_addr, port,

   393

                 workdir, argv, autostart=False,

   394

                 statuschange=None, evaluator=default_evaluator,

   395

                 pyruntimevars=None):

   396

        self.continueloop = True

   397

        self.daemon = None

   398

        self.servicename = servicename

   399

        self.ip_addr = ip_addr

   400

        self.port = port

   401

        self.workdir = workdir

   402

        self.argv = argv

   403

        self.plcobj = None

   404

        self.servicepublisher = None

   405

        self.autostart = autostart

   406

        self.statuschange = statuschange

   407

        self.evaluator = evaluator

   408

        self.pyruntimevars = pyruntimevars

   409

   410

    def Loop(self):

   411

        while self.continueloop:

   412

            self.Start()

   413

   414

    def Restart(self):

   415

        self.Stop()

   416

   417

    def Quit(self):

   418

        self.continueloop = False

   419

        if self.plcobj is not None:

   420

            self.plcobj.StopPLC()

   421

            self.plcobj.UnLoadPLC()

   422

        self.Stop()

   423

   424

    def Start(self):

   425

        pyro.initServer()

   427

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

   428

                                self.statuschange, self.evaluator,

   429

                                self.pyruntimevars)

   430

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

   431

   432

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

   433

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

   434

   435

        # Beremiz IDE detects daemon start by looking

   436

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

   437

        # Therefore don't delete the following line

   438

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

   439

   440

        # Configure and publish service

   441

        # Not publish service if localhost in address params

   442

        if (self.servicename is not None and

   443

            self.ip_addr is not None and

   444

            self.ip_addr != "localhost" and

   445

            self.ip_addr != "127.0.0.1"):

   446

            print _("Publishing service on local network")

   447

            self.servicepublisher = ServicePublisher.ServicePublisher()

   448

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

   449

   450

        self.plcobj.AutoLoad()

   451

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

   452

            if self.autostart:

   453

                self.plcobj.StartPLC()

   454

        self.plcobj.StatusChange()

   455

   456

        sys.stdout.flush()

   457

   458

        self.daemon.requestLoop()

   459

        self.daemon.sock.close()

   460

   461

    def Stop(self):

   462

        if self.plcobj is not None:

   463

            self.plcobj.StopPLC()

   464

        if self.servicepublisher is not None:

   465

            self.servicepublisher.UnRegisterService()

   466

            self.servicepublisher = None

   467

        self.daemon.shutdown(True)

   468

   469

if enabletwisted:

   470

    import warnings

   471

    with warnings.catch_warnings():

   472

        warnings.simplefilter("ignore")

   473

        try:

   474

            from threading import Thread, currentThread

   475

            if havewx:

   476

                from twisted.internet import wxreactor

   477

                wxreactor.install()

   478

            from twisted.internet import reactor

   479

   480

            havetwisted = True

   481

        except:

   482

            print _("Twisted unavailable.")

   483

            havetwisted = False