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 print_function

    28

import os

    29

import sys

    30

import getopt

    31

import threading

    32

from threading import Thread, currentThread, Semaphore

    33

import traceback

    34

import __builtin__

    35

import Pyro.core as pyro

    36

    38

import util.paths as paths

    39

    40

    41

def usage():

    42

    print("""

    43

Usage of Beremiz PLC execution service :\n

    44

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

    45

           -n        - zeroconf service name (default:disabled)

    46

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

    47

           -p        - port number default:3000

    48

           -h        - print this help text and quit

    49

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

    50

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

    51

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

    52

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

    53

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

    54

           -e        - python extension (absolute path .py)

    55

    56

           working_dir - directory where are stored PLC files

    57

""" % sys.argv[0])

    58

    59

    60

try:

    61

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

    62

except getopt.GetoptError, err:

    63

    # print help information and exit:

    64

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

    65

    usage()

    66

    sys.exit(2)

    67

    68

# default values

    69

given_ip = None

    70

port = 3000

    71

webport = 8009

    72

wampconf = "wampconf.json"

    73

servicename = None

    74

autostart = False

    75

enablewx = True

    76

havewx = False

    77

enabletwisted = True

    78

havetwisted = False

    79

    80

extensions = []

    81

    82

for o, a in opts:

    83

    if o == "-h":

    84

        usage()

    85

        sys.exit()

    86

    elif o == "-i":

    87

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

    88

            given_ip = a

    89

        else:

    90

            usage()

    91

            sys.exit()

    92

    elif o == "-p":

    93

        # port: port that the service runs on

    94

        port = int(a)

    95

    elif o == "-n":

    96

        servicename = a

    97

    elif o == "-x":

    98

        enablewx = int(a)

    99

    elif o == "-t":

   100

        enabletwisted = int(a)

   101

    elif o == "-a":

   102

        autostart = int(a)

   103

    elif o == "-w":

   104

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

   105

    elif o == "-c":

   106

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

   107

    elif o == "-e":

   108

        extensions.append(a)

   109

    else:

   110

        usage()

   111

        sys.exit()

   112

   113

   114

beremiz_dir = paths.AbsDir(__file__)

   115

   116

if len(argv) > 1:

   117

    usage()

   118

    sys.exit()

   119

elif len(argv) == 1:

   120

    WorkingDir = argv[0]

   121

    os.chdir(WorkingDir)

   122

elif len(argv) == 0:

   123

    WorkingDir = os.getcwd()

   124

    argv = [WorkingDir]

   125

   126

if __name__ == '__main__':

   127

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

   128

   129

   130

def Bpath(*args):

   131

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

   132

   133

   134

def SetupI18n():

   135

    # Get folder containing translation files

   136

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

   137

    # Get the default language

   138

    langid = wx.LANGUAGE_DEFAULT

   139

    # Define translation domain (name of translation files)

   140

    domain = "Beremiz"

   141

   142

    # Define locale for wx

   143

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

   144

    if loc is None:

   145

        loc = wx.Locale(langid)

   146

        __builtin__.__dict__['loc'] = loc

   147

        # Define location for searching translation files

   148

    loc.AddCatalogLookupPathPrefix(localedir)

   149

    # Define locale domain

   150

    loc.AddCatalog(domain)

   151

   152

    import locale

   153

    global default_locale

   154

    default_locale = locale.getdefaultlocale()[1]

   155

   156

    # sys.stdout.encoding = default_locale

   157

    # if Beremiz_service is started from Beremiz IDE

   158

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

   159

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

   160

    # automatically converted to 'ascii' string.

   161

    def unicode_translation(message):

   162

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

   163

   164

    if __name__ == '__main__':

   165

        __builtin__.__dict__['_'] = unicode_translation

   166

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

   167

   168

   169

if enablewx:

   170

    try:

   171

        import wx

   172

        havewx = True

   173

    except ImportError:

   174

        print("Wx unavailable !")

   175

        havewx = False

   176

   177

    if havewx:

   178

        import re

   179

        from types import *

   180

   181

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

   182

            app = wx.App(redirect=False)

   183

        else:

   184

            app = wx.PySimpleApp(redirect=False)

   185

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

   186

   187

        default_locale = None

   188

        SetupI18n()

   189

   190

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

   191

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

   192

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

   193

   194

        class ParamsEntryDialog(wx.TextEntryDialog):

   195

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

   196

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

   197

                    if id is not None:

   198

                        event(self, id, function)

   199

                    else:

   200

                        event(self, function)

   201

   202

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

   203

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

   204

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

   205

   206

                self.Tests = []

   207

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

   208

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

   209

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

   210

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

   211

                else:

   212

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

   213

   214

            def OnOK(self, event):

   215

                value = self.GetValue()

   216

                texts = {"value": value}

   217

                for function, message in self.Tests:

   218

                    if not function(value):

   219

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

   220

                        message.ShowModal()

   221

                        message.Destroy()

   222

                        return

   223

                self.EndModal(wx.ID_OK)

   224

                event.Skip()

   225

   226

            def GetValue(self):

   227

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

   228

   229

            def SetTests(self, tests):

   230

                self.Tests = tests

   231

   232

        class BeremizTaskBarIcon(wx.TaskBarIcon):

   233

            TBMENU_START = wx.NewId()

   234

            TBMENU_STOP = wx.NewId()

   235

            TBMENU_CHANGE_NAME = wx.NewId()

   236

            TBMENU_CHANGE_PORT = wx.NewId()

   237

            TBMENU_CHANGE_INTERFACE = wx.NewId()

   238

            TBMENU_LIVE_SHELL = wx.NewId()

   239

            TBMENU_WXINSPECTOR = wx.NewId()

   240

            TBMENU_CHANGE_WD = wx.NewId()

   241

            TBMENU_QUIT = wx.NewId()

   242

   243

            def __init__(self, pyroserver, level):

   244

                wx.TaskBarIcon.__init__(self)

   245

                self.pyroserver = pyroserver

   246

                # Set the image

   247

                self.UpdateIcon(None)

   248

                self.level = level

   249

   250

                # bind some events

   251

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

   252

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

   253

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

   254

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

   255

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

   256

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

   257

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

   258

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

   259

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

   260

   261

            def CreatePopupMenu(self):

   262

                """

   263

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

   264

                the menu for the default EVT_RIGHT_DOWN event.  Just create

   265

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

   266

                the base class takes care of the rest.

   267

                """

   268

                menu = wx.Menu()

   269

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

   270

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

   271

                if self.level == 1:

   272

                    menu.AppendSeparator()

   273

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

   274

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

   275

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

   276

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

   277

                    menu.AppendSeparator()

   278

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

   279

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

   280

                menu.AppendSeparator()

   281

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

   282

                return menu

   283

   284

            def MakeIcon(self, img):

   285

                """

   286

                The various platforms have different requirements for the

   287

                icon size...

   288

                """

   289

                if "wxMSW" in wx.PlatformInfo:

   290

                    img = img.Scale(16, 16)

   291

                elif "wxGTK" in wx.PlatformInfo:

   292

                    img = img.Scale(22, 22)

   293

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

   294

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

   295

                return icon

   296

   297

            def OnTaskBarStartPLC(self, evt):

   298

                if self.pyroserver.plcobj is not None:

   299

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

   300

                    if plcstatus is "Stopped":

   301

                        self.pyroserver.plcobj.StartPLC()

   302

                    else:

   303

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

   304

   305

            def OnTaskBarStopPLC(self, evt):

   306

                if self.pyroserver.plcobj is not None:

   307

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

   308

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

   309

                    else:

   310

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

   311

   312

            def OnTaskBarChangeInterface(self, evt):

   313

                ip_addr = self.pyroserver.ip_addr

   314

                ip_addr = '' if ip_addr is None else ip_addr

   315

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

   316

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

   317

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

   318

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

   319

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

   320

                    self.pyroserver.ip_addr = dlg.GetValue()

   321

                    self.pyroserver.Stop()

   322

   323

            def OnTaskBarChangePort(self, evt):

   324

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

   325

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

   326

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

   327

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

   328

                    self.pyroserver.Stop()

   329

   330

            def OnTaskBarChangeWorkingDir(self, evt):

   331

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

   332

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

   333

                    self.pyroserver.workdir = dlg.GetPath()

   334

                    self.pyroserver.Stop()

   335

   336

            def OnTaskBarChangeName(self, evt):

   337

                servicename = self.pyroserver.servicename

   338

                servicename = '' if servicename is None else servicename

   339

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

   340

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

   341

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

   342

                    self.pyroserver.servicename = dlg.GetValue()

   343

                    self.pyroserver.Restart()

   344

   345

            def _LiveShellLocals(self):

   346

                if self.pyroserver.plcobj is not None:

   347

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

   348

                else:

   349

                    return {}

   350

   351

            def OnTaskBarLiveShell(self, evt):

   352

                from wx import py

   353

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

   354

                frame.Show()

   355

   356

            def OnTaskBarWXInspector(self, evt):

   357

                # Activate the widget inspection tool

   358

                from wx.lib.inspection import InspectionTool

   359

                if not InspectionTool().initialized:

   360

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

   361

   362

                wnd = wx.GetApp()

   363

                InspectionTool().Show(wnd, True)

   364

   365

            def OnTaskBarQuit(self, evt):

   366

                if wx.Platform == '__WXMSW__':

   367

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

   368

                self.RemoveIcon()

   369

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

   370

   371

            def UpdateIcon(self, plcstatus):

   372

                if plcstatus is "Started":

   373

                    currenticon = self.MakeIcon(starticon)

   374

                elif plcstatus is "Stopped":

   375

                    currenticon = self.MakeIcon(stopicon)

   376

                else:

   377

                    currenticon = self.MakeIcon(defaulticon)

   378

                self.SetIcon(currenticon, "Beremiz Service")

   379

   380

   381

if not os.path.isdir(WorkingDir):

   382

    os.mkdir(WorkingDir)

   383

   384

   385

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

   386

    try:

   387

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

   388

    except Exception:

   389

        res = (None, sys.exc_info())

   390

    return res

   391

   392

   393

class Server(object):

   394

    def __init__(self, servicename, ip_addr, port,

   395

                 workdir, argv, autostart=False,

   396

                 statuschange=None, evaluator=default_evaluator,

   397

                 pyruntimevars=None):

   398

        self.continueloop = True

   399

        self.daemon = None

   400

        self.servicename = servicename

   401

        self.ip_addr = ip_addr

   402

        self.port = port

   403

        self.workdir = workdir

   404

        self.argv = argv

   405

        self.plcobj = None

   406

        self.servicepublisher = None

   407

        self.autostart = autostart

   408

        self.statuschange = statuschange

   409

        self.evaluator = evaluator

   410

        self.pyruntimevars = pyruntimevars

   411

   412

    def Loop(self):

   413

        while self.continueloop:

   414

            self.Start()

   415

   416

    def Restart(self):

   417

        self.Stop()

   418

   419

    def Quit(self):

   420

        self.continueloop = False

   421

        if self.plcobj is not None:

   422

            self.plcobj.StopPLC()

   423

            self.plcobj.UnLoadPLC()

   424

        self.Stop()

   425

   426

    def Start(self):

   427

        pyro.initServer()

   428

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

   429

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

   430

                                self.statuschange, self.evaluator,

   431

                                self.pyruntimevars)

   432

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

   433

   434

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

   435

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

   436

   437

        # Beremiz IDE detects daemon start by looking

   438

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

   439

        # Therefore don't delete the following line

   440

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

   441

   442

        # Configure and publish service

   443

        # Not publish service if localhost in address params

   444

        if self.servicename is not None and \

   445

           self.ip_addr is not None and \

   446

           self.ip_addr != "localhost" and \

   447

           self.ip_addr != "127.0.0.1":

   448

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

   449

            self.servicepublisher = ServicePublisher.ServicePublisher()

   450

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

   451

   452

        self.plcobj.AutoLoad()

   453

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

   454

            if self.autostart:

   455

                self.plcobj.StartPLC()

   456

        self.plcobj.StatusChange()

   457

   458

        sys.stdout.flush()

   459

   460

        self.daemon.requestLoop()

   461

        self.daemon.sock.close()

   462

   463

    def Stop(self):

   464

        if self.plcobj is not None:

   465

            self.plcobj.StopPLC()

   466

        if self.servicepublisher is not None:

   467

            self.servicepublisher.UnRegisterService()

   468

            self.servicepublisher = None

   469

        self.daemon.shutdown(True)

   470

   471

   472

if enabletwisted:

   473

    import warnings

   474

    with warnings.catch_warnings():

   475

        warnings.simplefilter("ignore")

   476

        try:

   477

            if havewx:

   478

                from twisted.internet import wxreactor

   479

                wxreactor.install()

   480

            from twisted.internet import reactor

   481

   482

            havetwisted = True