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 absolute_import

    28

from __future__ import print_function

    29

import os

    30

import sys

    31

import getopt

    32

import threading

    33

from threading import Thread, currentThread, Semaphore

    34

import traceback

    35

import __builtin__

    36

import Pyro.core as pyro

    37

    38

from runtime import PLCObject, ServicePublisher

    39

import util.paths as paths

    40

    41

    42

def usage():

    43

    print("""

    44

Usage of Beremiz PLC execution service :\n

    45

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

    46

           -n        - zeroconf service name (default:disabled)

    47

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

    48

           -p        - port number default:3000

    49

           -h        - print this help text and quit

    50

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

    51

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

    52

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

    53

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

    54

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

    55

           -s        - WAMP client secret, given as a file

    56

           -e        - python extension (absolute path .py)

    57

    58

           working_dir - directory where are stored PLC files

    59

""" % sys.argv[0])

    60

    61

    62

try:

    63

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

    64

except getopt.GetoptError, err:

    65

    # print help information and exit:

    66

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

    67

    usage()

    68

    sys.exit(2)

    69

    70

# default values

    71

given_ip = None

    72

port = 3000

    73

webport = 8009

    74

wampsecret = None

    75

wampconf = None

    76

servicename = None

    77

autostart = False

    78

enablewx = True

    79

havewx = False

    80

enabletwisted = True

    81

havetwisted = False

    82

    83

extensions = []

    84

    85

for o, a in opts:

    86

    if o == "-h":

    87

        usage()

    88

        sys.exit()

    89

    elif o == "-i":

    90

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

    91

            given_ip = a

    92

        else:

    93

            usage()

    94

            sys.exit()

    95

    elif o == "-p":

    96

        # port: port that the service runs on

    97

        port = int(a)

    98

    elif o == "-n":

    99

        servicename = a

   100

    elif o == "-x":

   101

        enablewx = int(a)

   102

    elif o == "-t":

   103

        enabletwisted = int(a)

   104

    elif o == "-a":

   105

        autostart = int(a)

   106

    elif o == "-w":

   107

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

   108

    elif o == "-c":

   109

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

   110

    elif o == "-s":

   111

        wampsecret = None if a == "off" else a

   112

    elif o == "-e":

   113

        l = list(os.path.split(os.path.realpath(a)))

   114

        l.reverse()

   115

        extensions.append(l)

   116

    else:

   117

        usage()

   118

        sys.exit()

   119

   120

   121

beremiz_dir = paths.AbsDir(__file__)

   122

   123

if len(argv) > 1:

   124

    usage()

   125

    sys.exit()

   126

elif len(argv) == 1:

   127

    WorkingDir = argv[0]

   128

    os.chdir(WorkingDir)

   129

elif len(argv) == 0:

   130

    WorkingDir = os.getcwd()

   131

    argv = [WorkingDir]

   132

   133

if __name__ == '__main__':

   134

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

   135

   136

   137

def Bpath(*args):

   138

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

   139

   140

   141

def SetupI18n():

   142

    # Get folder containing translation files

   143

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

   144

    # Get the default language

   145

    langid = wx.LANGUAGE_DEFAULT

   146

    # Define translation domain (name of translation files)

   147

    domain = "Beremiz"

   148

   149

    # Define locale for wx

   150

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

   151

    if loc is None:

   152

        loc = wx.Locale(langid)

   153

        __builtin__.__dict__['loc'] = loc

   154

        # Define location for searching translation files

   155

    loc.AddCatalogLookupPathPrefix(localedir)

   156

    # Define locale domain

   157

    loc.AddCatalog(domain)

   158

   159

    import locale

   160

    global default_locale

   161

    default_locale = locale.getdefaultlocale()[1]

   162

   163

    # sys.stdout.encoding = default_locale

   164

    # if Beremiz_service is started from Beremiz IDE

   165

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

   166

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

   167

    # automatically converted to 'ascii' string.

   168

    def unicode_translation(message):

   169

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

   170

   171

    if __name__ == '__main__':

   172

        __builtin__.__dict__['_'] = unicode_translation

   173

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

   174

   175

   176

# Life is hard... have a candy.

   177

# pylint: disable=wrong-import-position,wrong-import-order

   178

if enablewx:

   179

    try:

   180

        import wx

   181

        havewx = True

   182

    except ImportError:

   183

        print("Wx unavailable !")

   184

        havewx = False

   185

   186

    if havewx:

   187

        import re

   188

        from types import *

   189

   190

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

   191

            app = wx.App(redirect=False)

   192

        else:

   193

            app = wx.PySimpleApp(redirect=False)

   194

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

   195

   196

        default_locale = None

   197

        SetupI18n()

   198

   199

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

   200

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

   201

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

   202

   203

        class ParamsEntryDialog(wx.TextEntryDialog):

   204

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

   205

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

   206

                    if id is not None:

   207

                        event(self, id, function)

   208

                    else:

   209

                        event(self, function)

   210

   211

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

   212

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

   213

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

   214

   215

                self.Tests = []

   216

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

   217

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

   218

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

   219

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

   220

                else:

   221

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

   222

   223

            def OnOK(self, event):

   224

                value = self.GetValue()

   225

                texts = {"value": value}

   226

                for function, message in self.Tests:

   227

                    if not function(value):

   228

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

   229

                        message.ShowModal()

   230

                        message.Destroy()

   231

                        return

   232

                self.EndModal(wx.ID_OK)

   233

                event.Skip()

   234

   235

            def GetValue(self):

   236

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

   237

   238

            def SetTests(self, tests):

   239

                self.Tests = tests

   240

   241

        class BeremizTaskBarIcon(wx.TaskBarIcon):

   242

            TBMENU_START = wx.NewId()

   243

            TBMENU_STOP = wx.NewId()

   244

            TBMENU_CHANGE_NAME = wx.NewId()

   245

            TBMENU_CHANGE_PORT = wx.NewId()

   246

            TBMENU_CHANGE_INTERFACE = wx.NewId()

   247

            TBMENU_LIVE_SHELL = wx.NewId()

   248

            TBMENU_WXINSPECTOR = wx.NewId()

   249

            TBMENU_CHANGE_WD = wx.NewId()

   250

            TBMENU_QUIT = wx.NewId()

   251

   252

            def __init__(self, pyroserver, level):

   253

                wx.TaskBarIcon.__init__(self)

   254

                self.pyroserver = pyroserver

   255

                # Set the image

   256

                self.UpdateIcon(None)

   257

                self.level = level

   258

   259

                # bind some events

   260

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

   261

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

   262

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

   263

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

   264

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

   265

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

   266

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

   267

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

   268

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

   269

   270

            def CreatePopupMenu(self):

   271

                """

   272

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

   273

                the menu for the default EVT_RIGHT_DOWN event.  Just create

   274

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

   275

                the base class takes care of the rest.

   276

                """

   277

                menu = wx.Menu()

   278

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

   279

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

   280

                if self.level == 1:

   281

                    menu.AppendSeparator()

   282

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

   283

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

   284

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

   285

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

   286

                    menu.AppendSeparator()

   287

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

   288

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

   289

                menu.AppendSeparator()

   290

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

   291

                return menu

   292

   293

            def MakeIcon(self, img):

   294

                """

   295

                The various platforms have different requirements for the

   296

                icon size...

   297

                """

   298

                if "wxMSW" in wx.PlatformInfo:

   299

                    img = img.Scale(16, 16)

   300

                elif "wxGTK" in wx.PlatformInfo:

   301

                    img = img.Scale(22, 22)

   302

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

   303

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

   304

                return icon

   305

   306

            def OnTaskBarStartPLC(self, evt):

   307

                if self.pyroserver.plcobj is not None:

   308

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

   309

                    if plcstatus is "Stopped":

   310

                        self.pyroserver.plcobj.StartPLC()

   311

                    else:

   312

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

   313

   314

            def OnTaskBarStopPLC(self, evt):

   315

                if self.pyroserver.plcobj is not None:

   316

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

   317

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

   318

                    else:

   319

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

   320

   321

            def OnTaskBarChangeInterface(self, evt):

   322

                ip_addr = self.pyroserver.ip_addr

   323

                ip_addr = '' if ip_addr is None else ip_addr

   324

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

   325

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

   326

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

   327

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

   328

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

   329

                    self.pyroserver.ip_addr = dlg.GetValue()

   330

                    self.pyroserver.Restart()

   331

   332

            def OnTaskBarChangePort(self, evt):

   333

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

   334

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

   335

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

   336

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

   337

                    self.pyroserver.Restart()

   338

   339

            def OnTaskBarChangeWorkingDir(self, evt):

   340

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

   341

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

   342

                    self.pyroserver.workdir = dlg.GetPath()

   343

                    self.pyroserver.Restart()

   344

   345

            def OnTaskBarChangeName(self, evt):

   346

                servicename = self.pyroserver.servicename

   347

                servicename = '' if servicename is None else servicename

   348

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

   349

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

   350

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

   351

                    self.pyroserver.servicename = dlg.GetValue()

   352

                    self.pyroserver.Restart()

   353

   354

            def _LiveShellLocals(self):

   355

                if self.pyroserver.plcobj is not None:

   356

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

   357

                else:

   358

                    return {}

   359

   360

            def OnTaskBarLiveShell(self, evt):

   361

                from wx import py

   362

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

   363

                frame.Show()

   364

   365

            def OnTaskBarWXInspector(self, evt):

   366

                # Activate the widget inspection tool

   367

                from wx.lib.inspection import InspectionTool

   368

                if not InspectionTool().initialized:

   369

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

   370

   371

                wnd = wx.GetApp()

   372

                InspectionTool().Show(wnd, True)

   373

   374

            def OnTaskBarQuit(self, evt):

   375

                if wx.Platform == '__WXMSW__':

   376

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

   377

                self.RemoveIcon()

   378

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

   379

   380

            def UpdateIcon(self, plcstatus):

   381

                if plcstatus is "Started":

   382

                    currenticon = self.MakeIcon(starticon)

   383

                elif plcstatus is "Stopped":

   384

                    currenticon = self.MakeIcon(stopicon)

   385

                else:

   386

                    currenticon = self.MakeIcon(defaulticon)

   387

                self.SetIcon(currenticon, "Beremiz Service")

   388

   389

   390

if not os.path.isdir(WorkingDir):

   391

    os.mkdir(WorkingDir)

   392

   393

   394

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

   395

    try:

   396

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

   397

    except Exception:

   398

        res = (None, sys.exc_info())

   399

    return res

   400

   401

   402

class Server(object):

   403

    def __init__(self, servicename, ip_addr, port,

   404

                 workdir, argv, autostart=False,

   405

                 statuschange=None, evaluator=default_evaluator,

   406

                 pyruntimevars=None):

   407

        self.continueloop = True

   408

        self.daemon = None

   409

        self.servicename = servicename

   410

        self.ip_addr = ip_addr

   411

        self.port = port

   412

        self.workdir = workdir

   413

        self.argv = argv

   414

        self.plcobj = None

   415

        self.servicepublisher = None

   416

        self.autostart = autostart

   417

        self.statuschange = statuschange

   418

        self.evaluator = evaluator

   419

        self.pyruntimevars = pyruntimevars

   420

   421

    def Loop(self):

   422

        while self.continueloop:

   423

            pyro.initServer()

   424

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

   425

            # pyro never frees memory after connection close if no timeout set

   426

            # taking too small timeout value may cause

   427

            # unwanted diconnection when IDE is kept busy for long periods

   428

            self.daemon.setTimeout(60);

   429

            self.Start()

   430

            self.daemon.requestLoop()

   431

            self.daemon.sock.close()

   432

   433

    def Restart(self):

   434

        self._stop()

   435

   436

    def Quit(self):

   437

        self.continueloop = False

   438

        if self.plcobj is not None:

   439

            self.plcobj.StopPLC()

   440

            self.plcobj.UnLoadPLC()

   441

        self._stop()

   442

   443

    def Start(self):

   444

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

   445

                                self.statuschange, self.evaluator,

   446

                                self.pyruntimevars)

   447

   448

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

   449

   450

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

   451

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

   452

   453

        # Beremiz IDE detects daemon start by looking

   454

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

   455

        # Therefore don't delete the following line

   456

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

   457

   458

        # Configure and publish service

   459

        # Not publish service if localhost in address params

   460

        if self.servicename is not None and \

   461

           self.ip_addr is not None and \

   462

           self.ip_addr != "localhost" and \

   463

           self.ip_addr != "127.0.0.1":

   464

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

   465

            self.servicepublisher = ServicePublisher.ServicePublisher()

   466

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

   467

   468

        self.plcobj.AutoLoad()

   469

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

   470

            if self.autostart:

   471

                self.plcobj.StartPLC()

   472

        self.plcobj.StatusChange()

   473

   474

        sys.stdout.flush()

   475

   476

    def _stop(self):

   477

        if self.plcobj is not None:

   478

            self.plcobj.StopPLC()

   479

        if self.servicepublisher is not None:

   480

            self.servicepublisher.UnRegisterService()

   481

            self.servicepublisher = None