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

    34

import traceback

    35

import __builtin__

    37

import Pyro.core as pyro

    38

    39

from runtime import PLCObject, ServicePublisher, MainWorker

    40

import util.paths as paths

    41

    42

    43

def usage():

    44

    print("""

    45

Usage of Beremiz PLC execution service :\n

    46

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

    47

           -n        - zeroconf service name (default:disabled)

    48

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

    49

           -p        - port number default:3000

    50

           -h        - print this help text and quit

    51

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

    52

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

    53

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

    54

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

    55

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

    56

           -s        - WAMP client secret, given as a file

    57

           -e        - python extension (absolute path .py)

    58

    59

           working_dir - directory where are stored PLC files

    60

""" % sys.argv[0])

    61

    62

    63

try:

    64

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

    65

except getopt.GetoptError, err:

    66

    # print help information and exit:

    67

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

    68

    usage()

    69

    sys.exit(2)

    70

    71

# default values

    72

given_ip = None

    73

port = 3000

    74

webport = 8009

    75

wampsecret = None

    76

wampconf = None

    77

servicename = None

    78

autostart = False

    79

enablewx = True

    80

havewx = False

    81

enabletwisted = True

    82

havetwisted = False

    83

    84

extensions = []

    85

    86

for o, a in opts:

    87

    if o == "-h":

    88

        usage()

    89

        sys.exit()

    90

    elif o == "-i":

    91

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

    92

            given_ip = a

    93

        else:

    94

            usage()

    95

            sys.exit()

    96

    elif o == "-p":

    97

        # port: port that the service runs on

    98

        port = int(a)

    99

    elif o == "-n":

   100

        servicename = a

   101

    elif o == "-x":

   102

        enablewx = int(a)

   103

    elif o == "-t":

   104

        enabletwisted = int(a)

   105

    elif o == "-a":

   106

        autostart = int(a)

   107

    elif o == "-w":

   108

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

   109

    elif o == "-c":

   110

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

   111

    elif o == "-s":

   112

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

   113

    elif o == "-e":

   114

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

   115

        fnameanddirname.reverse()

   116

        extensions.append(fnameanddirname)

   117

    else:

   118

        usage()

   119

        sys.exit()

   120

   121

   122

beremiz_dir = paths.AbsDir(__file__)

   123

   124

if len(argv) > 1:

   125

    usage()

   126

    sys.exit()

   127

elif len(argv) == 1:

   128

    WorkingDir = argv[0]

   129

    os.chdir(WorkingDir)

   130

elif len(argv) == 0:

   131

    WorkingDir = os.getcwd()

   132

    argv = [WorkingDir]

   133

   134

if __name__ == '__main__':

   135

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

   136

   137

   138

def Bpath(*args):

   139

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

   140

   141

   142

def SetupI18n():

   143

    # Get folder containing translation files

   144

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

   145

    # Get the default language

   146

    langid = wx.LANGUAGE_DEFAULT

   147

    # Define translation domain (name of translation files)

   148

    domain = "Beremiz"

   149

   150

    # Define locale for wx

   151

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

   152

    if loc is None:

   153

        loc = wx.Locale(langid)

   154

        __builtin__.__dict__['loc'] = loc

   155

        # Define location for searching translation files

   156

    loc.AddCatalogLookupPathPrefix(localedir)

   157

    # Define locale domain

   158

    loc.AddCatalog(domain)

   159

   160

    import locale

   161

    global default_locale

   162

    default_locale = locale.getdefaultlocale()[1]

   163

   164

    # sys.stdout.encoding = default_locale

   165

    # if Beremiz_service is started from Beremiz IDE

   166

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

   167

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

   168

    # automatically converted to 'ascii' string.

   169

    def unicode_translation(message):

   170

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

   171

   172

    if __name__ == '__main__':

   173

        __builtin__.__dict__['_'] = unicode_translation

   174

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

   175

   176

   177

# Life is hard... have a candy.

   178

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

   179

if enablewx:

   180

    try:

   181

        import wx

   182

        havewx = True

   183

    except ImportError:

   184

        print("Wx unavailable !")

   185

        havewx = False

   186

   187

    if havewx:

   188

        import re

   189

        from types import *

   190

   191

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

   192

            app = wx.App(redirect=False)

   193

        else:

   194

            app = wx.PySimpleApp(redirect=False)

   195

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

   196

   197

        default_locale = None

   198

        SetupI18n()

   199

   200

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

   201

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

   202

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

   203

   204

        class ParamsEntryDialog(wx.TextEntryDialog):

   205

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

   206

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

   207

                    if id is not None:

   208

                        event(self, id, function)

   209

                    else:

   210

                        event(self, function)

   211

   212

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

   213

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

   214

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

   215

   216

                self.Tests = []

   217

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

   218

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

   219

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

   220

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

   221

                else:

   222

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

   223

   224

            def OnOK(self, event):

   225

                value = self.GetValue()

   226

                texts = {"value": value}

   227

                for function, message in self.Tests:

   228

                    if not function(value):

   229

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

   230

                        message.ShowModal()

   231

                        message.Destroy()

   232

                        return

   233

                self.EndModal(wx.ID_OK)

   234

                event.Skip()

   235

   236

            def GetValue(self):

   237

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

   238

   239

            def SetTests(self, tests):

   240

                self.Tests = tests

   241

   242

        class BeremizTaskBarIcon(wx.TaskBarIcon):

   243

            TBMENU_START = wx.NewId()

   244

            TBMENU_STOP = wx.NewId()

   245

            TBMENU_CHANGE_NAME = wx.NewId()

   246

            TBMENU_CHANGE_PORT = wx.NewId()

   247

            TBMENU_CHANGE_INTERFACE = wx.NewId()

   248

            TBMENU_LIVE_SHELL = wx.NewId()

   249

            TBMENU_WXINSPECTOR = wx.NewId()

   250

            TBMENU_CHANGE_WD = wx.NewId()

   251

            TBMENU_QUIT = wx.NewId()

   252

   253

            def __init__(self, pyroserver, level):

   254

                wx.TaskBarIcon.__init__(self)

   255

                self.pyroserver = pyroserver

   256

                # Set the image

   257

                self.UpdateIcon(None)

   258

                self.level = level

   259

   260

                # bind some events

   261

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

   262

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

   263

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

   264

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

   265

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

   266

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

   267

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

   268

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

   269

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

   270

   271

            def CreatePopupMenu(self):

   272

                """

   273

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

   274

                the menu for the default EVT_RIGHT_DOWN event.  Just create

   275

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

   276

                the base class takes care of the rest.

   277

                """

   278

                menu = wx.Menu()

   279

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

   280

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

   281

                if self.level == 1:

   282

                    menu.AppendSeparator()

   283

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

   284

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

   285

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

   286

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

   287

                    menu.AppendSeparator()

   288

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

   289

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

   290

                menu.AppendSeparator()

   291

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

   292

                return menu

   293

   294

            def MakeIcon(self, img):

   295

                """

   296

                The various platforms have different requirements for the

   297

                icon size...

   298

                """

   299

                if "wxMSW" in wx.PlatformInfo:

   300

                    img = img.Scale(16, 16)

   301

                elif "wxGTK" in wx.PlatformInfo:

   302

                    img = img.Scale(22, 22)

   303

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

   304

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

   305

                return icon

   306

   307

            def OnTaskBarStartPLC(self, evt):

   308

                if self.pyroserver.plcobj is not None:

   309

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

   310

                    if plcstatus is "Stopped":

   311

                        self.pyroserver.plcobj.StartPLC()

   312

                    else:

   313

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

   314

   315

            def OnTaskBarStopPLC(self, evt):

   316

                if self.pyroserver.plcobj is not None:

   317

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

   318

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

   319

                    else:

   320

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

   321

   322

            def OnTaskBarChangeInterface(self, evt):

   323

                ip_addr = self.pyroserver.ip_addr

   324

                ip_addr = '' if ip_addr is None else ip_addr

   325

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

   326

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

   327

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

   328

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

   329

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

   330

                    self.pyroserver.ip_addr = dlg.GetValue()

   331

                    self.pyroserver.Restart()

   332

   333

            def OnTaskBarChangePort(self, evt):

   334

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

   335

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

   336

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

   337

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

   338

                    self.pyroserver.Restart()

   339

   340

            def OnTaskBarChangeWorkingDir(self, evt):

   341

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

   342

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

   343

                    self.pyroserver.workdir = dlg.GetPath()

   344

                    self.pyroserver.Restart()

   345

   346

            def OnTaskBarChangeName(self, evt):

   347

                servicename = self.pyroserver.servicename

   348

                servicename = '' if servicename is None else servicename

   349

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

   350

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

   351

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

   352

                    self.pyroserver.servicename = dlg.GetValue()

   353

                    self.pyroserver.Restart()

   354

   355

            def _LiveShellLocals(self):

   356

                if self.pyroserver.plcobj is not None:

   357

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

   358

                else:

   359

                    return {}

   360

   361

            def OnTaskBarLiveShell(self, evt):

   362

                from wx import py

   363

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

   364

                frame.Show()

   365

   366

            def OnTaskBarWXInspector(self, evt):

   367

                # Activate the widget inspection tool

   368

                from wx.lib.inspection import InspectionTool

   369

                if not InspectionTool().initialized:

   370

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

   371

   372

                wnd = wx.GetApp()

   373

                InspectionTool().Show(wnd, True)

   374

   375

            def OnTaskBarQuit(self, evt):

   376

                if wx.Platform == '__WXMSW__':

   377

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

   378

                self.RemoveIcon()

   379

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

   380

   381

            def UpdateIcon(self, plcstatus):

   382

                if plcstatus is "Started":

   383

                    currenticon = self.MakeIcon(starticon)

   384

                elif plcstatus is "Stopped":

   385

                    currenticon = self.MakeIcon(stopicon)

   386

                else:

   387

                    currenticon = self.MakeIcon(defaulticon)

   388

                self.SetIcon(currenticon, "Beremiz Service")

   389

   390

   391

if not os.path.isdir(WorkingDir):

   392

    os.mkdir(WorkingDir)

   393

   394

   395

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

   396

    try:

   397

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

   398

    except Exception:

   399

        res = (None, sys.exc_info())

   400

    return res

   401

   402

   404

class Server(object):

   405

    def __init__(self, servicename, ip_addr, port,

   406

                 workdir, argv,

   407

                 statuschange=None, evaluator=default_evaluator,

   408

                 pyruntimevars=None):

   409

        self.continueloop = True

   410

        self.daemon = None

   411

        self.servicename = servicename

   412

        self.ip_addr = ip_addr

   413

        self.port = port

   414

        self.workdir = workdir

   415

        self.argv = argv

   416

        self.servicepublisher = None

   417

        self.statuschange = statuschange

   418

        self.evaluator = evaluator

   419

        self.pyruntimevars = pyruntimevars

   420

        self.plcobj = PLCObject(self)

   421

   422

    def _to_be_published(self):

   423

        return self.servicename is not None and \

   424

               self.ip_addr is not None and \

   425

               self.ip_addr != "localhost" and \

   426

               self.ip_addr != "127.0.0.1"

   427

   428

    def PrintServerInfo(self):

   429

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

   430

   431

        # Beremiz IDE detects LOCAL:// runtime is ready by looking

   432

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

   433

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

   434

   435

        if self._to_be_published():

   436

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

   437

   438

        sys.stdout.flush()

   439

   440

   442

        while self.continueloop:

   444

            pyro.initServer()

   445

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

   446

   447

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

   448

            # taking too small timeout value may cause

   449

            # unwanted diconnection when IDE is kept busy for long periods

   450

            self.daemon.setTimeout(60)

   451

   452

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

   453

   454

            if self._to_be_published():

   455

                self.servicepublisher = ServicePublisher.ServicePublisher()

   456

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

   457

   459

            self.daemon.requestLoop()

   460

            self.daemon.sock.close()

   461

   462

    def Restart(self):

   463

        self._stop()

   464

   465

    def Quit(self):

   466

        self.continueloop = False

   467

        if self.plcobj is not None:

   468

            self.plcobj.StopPLC()

   469

            self.plcobj.UnLoadPLC()

   470

        self._stop()

   471

   472

    def _stop(self):

   473

        if self.plcobj is not None:

   474

            self.plcobj.StopPLC()

   475

        if self.servicepublisher is not None:

   476

            self.servicepublisher.UnRegisterService()

   477

            self.servicepublisher = None

   478

        self.daemon.shutdown(True)

   479

   480

    def AutoLoad(self):

   481

        self.plcobj.AutoLoad()