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

    70

extensions=[]

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

   114

    argv=[WorkingDir]

   115

   116

import __builtin__

   117

if __name__ == '__main__':

   118

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

   119

   120

   121

def Bpath(*args):

   123

   124

   125

def SetupI18n():

   126

    # Import module for internationalization

   127

    import gettext

   128

   129

    # Get folder containing translation files

   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

   147

    import locale

   148

    global default_locale

   149

    default_locale = locale.getdefaultlocale()[1]

   150

   151

   152

    # sys.stdout.encoding = default_locale

   153

    # if Beremiz_service is started from Beremiz IDE

   154

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

   155

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

   156

    # automatically converted to 'ascii' string.

   157

    def unicode_translation(message):

   158

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

   159

   160

    if __name__ == '__main__':

   161

        __builtin__.__dict__['_'] = unicode_translation

   162

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

   163

   164

if enablewx:

   165

    try:

   166

        import wxversion

   167

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

   168

        import wx

   169

        havewx = True

   170

    except:

   171

        print "Wx unavailable !"

   172

        havewx = False

   173

   174

    if havewx:

   175

        import re

   176

        from threading import Thread, currentThread

   177

        from types import *

   178

   179

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

   180

            app = wx.App(redirect=False)

   181

        else:

   182

            app = wx.PySimpleApp(redirect=False)

   183

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

   184

   185

        default_locale = None

   186

        SetupI18n()

   187

   188

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

   189

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

   190

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

   191

   192

        class ParamsEntryDialog(wx.TextEntryDialog):

   193

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

   194

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

   195

                    if id is not None:

   196

                        event(self, id, function)

   197

                    else:

   198

                        event(self, function)

   199

   200

   201

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

   202

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

   203

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

   204

   205

                self.Tests = []

   206

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

   207

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

   208

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

   209

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

   210

                else:

   211

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

   212

   213

            def OnOK(self, event):

   214

                value = self.GetValue()

   215

                texts = {"value": value}

   216

                for function, message in self.Tests:

   217

                    if not function(value):

   218

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

   219

                        message.ShowModal()

   220

                        message.Destroy()

   221

                        return

   222

                self.EndModal(wx.ID_OK)

   223

                event.Skip()

   224

   225

            def GetValue(self):

   226

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

   227

   228

            def SetTests(self, tests):

   229

                self.Tests = tests

   230

   231

        class BeremizTaskBarIcon(wx.TaskBarIcon):

   232

            TBMENU_START = wx.NewId()

   233

            TBMENU_STOP = wx.NewId()

   234

            TBMENU_CHANGE_NAME = wx.NewId()

   235

            TBMENU_CHANGE_PORT = wx.NewId()

   236

            TBMENU_CHANGE_INTERFACE = wx.NewId()

   237

            TBMENU_LIVE_SHELL = wx.NewId()

   238

            TBMENU_WXINSPECTOR = wx.NewId()

   239

            TBMENU_CHANGE_WD = wx.NewId()

   240

            TBMENU_QUIT = wx.NewId()

   241

   242

            def __init__(self, pyroserver, level):

   243

                wx.TaskBarIcon.__init__(self)

   244

                self.pyroserver = pyroserver

   245

                # Set the image

   246

                self.UpdateIcon(None)

   247

                self.level = level

   248

   249

                # bind some events

   250

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

   251

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

   252

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

   253

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

   254

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

   255

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

   256

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

   257

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

   258

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

   259

   260

            def CreatePopupMenu(self):

   261

                """

   262

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

   263

                the menu for the default EVT_RIGHT_DOWN event.  Just create

   264

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

   265

                the base class takes care of the rest.

   266

                """

   267

                menu = wx.Menu()

   268

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

   269

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

   270

                if self.level==1:

   271

                    menu.AppendSeparator()

   272

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

   273

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

   274

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

   275

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

   276

                    menu.AppendSeparator()

   277

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

   278

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

   279

                menu.AppendSeparator()

   280

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

   281

                return menu

   282

   283

            def MakeIcon(self, img):

   284

                """

   285

                The various platforms have different requirements for the

   286

                icon size...

   287

                """

   288

                if "wxMSW" in wx.PlatformInfo:

   289

                    img = img.Scale(16, 16)

   290

                elif "wxGTK" in wx.PlatformInfo:

   291

                    img = img.Scale(22, 22)

   292

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

   293

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

   294

                return icon

   295

   296

            def OnTaskBarStartPLC(self, evt):

   297

                if self.pyroserver.plcobj is not None:

   298

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

   299

                    if plcstatus is "Stopped":

   300

                        self.pyroserver.plcobj.StartPLC()

   301

                    else:

   302

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

   303

   304

            def OnTaskBarStopPLC(self, evt):

   305

                if self.pyroserver.plcobj is not None:

   306

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

   307

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

   308

                    else:

   309

                        print _("PLC is not started.")

   310

   311

            def OnTaskBarChangeInterface(self, evt):

   312

                ip_addr = self.pyroserver.ip_addr

   313

                ip_addr = '' if ip_addr is None else ip_addr

   314

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

   315

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

   316

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

   317

                               ])

   318

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

   319

                    self.pyroserver.ip_addr = dlg.GetValue()

   320

                    self.pyroserver.Stop()

   321

   322

            def OnTaskBarChangePort(self, evt):

   323

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

   324

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

   325

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

   326

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

   327

                    self.pyroserver.Stop()

   328

   329

            def OnTaskBarChangeWorkingDir(self, evt):

   330

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

   331

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

   332

                    self.pyroserver.workdir = dlg.GetPath()

   333

                    self.pyroserver.Stop()

   334

   335

            def OnTaskBarChangeName(self, evt):

   336

                servicename = self.pyroserver.servicename

   337

                servicename = '' if servicename is None else servicename

   338

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

   339

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

   340

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

   341

                    self.pyroserver.servicename = dlg.GetValue()

   342

                    self.pyroserver.Restart()

   343

   344

            def _LiveShellLocals(self):

   345

                if self.pyroserver.plcobj is not None:

   347

                else:

   348

                    return {}

   349

   350

            def OnTaskBarLiveShell(self, evt):

   351

                from wx import py

   352

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

   353

                frame.Show()

   354

   355

            def OnTaskBarWXInspector(self, evt):

   356

                # Activate the widget inspection tool

   357

                from wx.lib.inspection import InspectionTool

   358

                if not InspectionTool().initialized:

   359

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

   360

   361

                wnd = wx.GetApp()

   362

                InspectionTool().Show(wnd, True)

   363

   364

            def OnTaskBarQuit(self, evt):

   365

                if wx.Platform == '__WXMSW__':

   366

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

   367

                self.RemoveIcon()

   368

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

   369

   370

            def UpdateIcon(self, plcstatus):

   371

                if plcstatus is "Started":

   372

                    currenticon = self.MakeIcon(starticon)

   373

                elif plcstatus is "Stopped":

   374

                    currenticon = self.MakeIcon(stopicon)

   375

                else:

   376

                    currenticon = self.MakeIcon(defaulticon)

   377

                self.SetIcon(currenticon, "Beremiz Service")

   378

   379

from runtime import PLCObject, PLCprint, ServicePublisher

   380

import Pyro.core as pyro

   381

   382

if not os.path.isdir(WorkingDir):

   383

    os.mkdir(WorkingDir)

   384

   385

   386

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

   387

    try:

   389

    except Exception:

   390

        res=(None, sys.exc_info())

   391

    return res

   392

   393

   394

class Server():

   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)

   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

if enabletwisted:

   473

    import warnings

   474

    with warnings.catch_warnings():

   475

        warnings.simplefilter("ignore")

   476

        try:

   477

            from threading import Thread, currentThread

   478

            if havewx:

   479

                from twisted.internet import wxreactor

   480

                wxreactor.install()

   481

            from twisted.internet import reactor

   482

   483

            havetwisted = True

   484