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

#

     9

# See COPYING file for copyrights details.

    10

#

    11

# This program is free software; you can redistribute it and/or

    12

# modify it under the terms of the GNU General Public License

    13

# as published by the Free Software Foundation; either version 2

    14

# of the License, or (at your option) any later version.

    15

#

    16

# This program is distributed in the hope that it will be useful,

    17

# but WITHOUT ANY WARRANTY; without even the implied warranty of

    18

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    19

# GNU General Public License for more details.

    20

#

    21

# You should have received a copy of the GNU General Public License

    22

# along with this program; if not, write to the Free Software

    23

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

    24

    25

import os, sys, getopt

    26

from threading import Thread

    27

    28

def usage():

    29

    print """

    30

Usage of Beremiz PLC execution service :\n

    31

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

    32

           -n        - zeroconf service name (default:disabled)

    33

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

    34

           -p        - port number default:3000

    35

           -h        - print this help text and quit

    36

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

    37

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

    38

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

    39

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

    40

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

    41

           -e        - python extension (absolute path .py)

    42

    43

           working_dir - directory where are stored PLC files

    44

"""%sys.argv[0]

    45

    46

try:

    47

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

    48

except getopt.GetoptError, err:

    49

    # print help information and exit:

    50

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

    51

    usage()

    52

    sys.exit(2)

    53

    54

# default values

    55

given_ip = None

    56

port = 3000

    57

webport = 8009

    58

wampconf = "wampconf.json"

    59

servicename = None

    60

autostart = False

    61

enablewx = True

    62

havewx = False

    63

enabletwisted = True

    64

havetwisted = False

    65

    66

extensions=[]

    67

    68

for o, a in opts:

    69

    if o == "-h":

    70

        usage()

    71

        sys.exit()

    72

    elif o == "-i":

    73

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

    74

            given_ip = a

    75

        else:

    76

            usage()

    77

            sys.exit()

    78

    elif o == "-p":

    79

        # port: port that the service runs on

    80

        port = int(a)

    81

    elif o == "-n":

    82

        servicename = a

    83

    elif o == "-x":

    84

        enablewx = int(a)

    85

    elif o == "-t":

    86

        enabletwisted = int(a)

    87

    elif o == "-a":

    88

        autostart = int(a)

    89

    elif o == "-w":

    90

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

    91

    elif o == "-c":

    92

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

    93

    elif o == "-e":

    94

        extensions.append(a)

    95

    else:

    96

        usage()

    97

        sys.exit()

    98

    99

beremiz_dir = os.path.dirname(os.path.realpath(__file__))

   100

   101

if len(argv) > 1:

   102

    usage()

   103

    sys.exit()

   104

elif len(argv) == 1:

   105

    WorkingDir = argv[0]

   106

    os.chdir(WorkingDir)

   107

elif len(argv) == 0:

   108

    WorkingDir = os.getcwd()

   109

    argv=[WorkingDir]

   110

   111

import __builtin__

   112

if __name__ == '__main__':

   113

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

   114

   115

def Bpath(*args):

   116

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

   117

   118

def SetupI18n():

   119

    # Import module for internationalization

   120

    import gettext

   121

   122

    # Get folder containing translation files

   123

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

   124

    # Get the default language

   125

    langid = wx.LANGUAGE_DEFAULT

   126

    # Define translation domain (name of translation files)

   127

    domain = "Beremiz"

   128

   129

    # Define locale for wx

   130

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

   131

    if loc is None:

   132

        loc = wx.Locale(langid)

   133

        __builtin__.__dict__['loc'] = loc

   134

        # Define location for searching translation files

   135

    loc.AddCatalogLookupPathPrefix(localedir)

   136

    # Define locale domain

   137

    loc.AddCatalog(domain)

   138

   139

   140

    import locale

   141

    global default_locale

   142

    default_locale = locale.getdefaultlocale()[1]

   143

   144

   145

    # sys.stdout.encoding = default_locale

   146

    # if Beremiz_service is started from Beremiz IDE

   147

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

   148

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

   149

    # automatically converted to 'ascii' string.

   150

    def unicode_translation(message):

   151

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

   152

   153

    if __name__ == '__main__':

   154

        __builtin__.__dict__['_'] = unicode_translation

   155

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

   156

   157

if enablewx:

   158

    try:

   159

        import wxversion

   160

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

   161

        import wx

   162

        havewx = True

   163

    except:

   164

        print "Wx unavailable !"

   165

        havewx = False

   166

   167

    if havewx:

   168

        import re

   169

        from threading import Thread, currentThread

   170

        from types import *

   171

   172

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

   173

            app = wx.App(redirect=False)

   174

        else:

   175

            app = wx.PySimpleApp(redirect=False)

   176

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

   177

   178

        default_locale = None

   179

        SetupI18n()

   180

   181

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

   182

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

   183

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

   184

   185

        class ParamsEntryDialog(wx.TextEntryDialog):

   186

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

   187

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

   188

                    if id is not None:

   189

                        event(self, id, function)

   190

                    else:

   191

                        event(self, function)

   192

   193

   194

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

   195

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

   196

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

   197

   198

                self.Tests = []

   199

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

   200

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

   201

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

   202

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

   203

                else:

   204

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

   205

   206

            def OnOK(self, event):

   207

                value = self.GetValue()

   208

                texts = {"value" : value}

   209

                for function, message in self.Tests:

   210

                    if not function(value):

   211

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

   212

                        message.ShowModal()

   213

                        message.Destroy()

   214

                        return

   215

                self.EndModal(wx.ID_OK)

   216

                event.Skip()

   217

   218

            def GetValue(self):

   219

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

   220

   221

            def SetTests(self, tests):

   222

                self.Tests = tests

   223

   224

        class BeremizTaskBarIcon(wx.TaskBarIcon):

   225

            TBMENU_START = wx.NewId()

   226

            TBMENU_STOP = wx.NewId()

   227

            TBMENU_CHANGE_NAME = wx.NewId()

   228

            TBMENU_CHANGE_PORT = wx.NewId()

   229

            TBMENU_CHANGE_INTERFACE = wx.NewId()

   230

            TBMENU_LIVE_SHELL = wx.NewId()

   231

            TBMENU_WXINSPECTOR = wx.NewId()

   232

            TBMENU_CHANGE_WD = wx.NewId()

   233

            TBMENU_QUIT = wx.NewId()

   234

   235

            def __init__(self, pyroserver, level):

   236

                wx.TaskBarIcon.__init__(self)

   237

                self.pyroserver = pyroserver

   238

                # Set the image

   239

                self.UpdateIcon(None)

   240

                self.level = level

   241

   242

                # bind some events

   243

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

   244

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

   245

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

   246

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

   247

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

   248

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

   249

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

   250

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

   251

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

   252

   253

            def CreatePopupMenu(self):

   254

                """

   255

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

   256

                the menu for the default EVT_RIGHT_DOWN event.  Just create

   257

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

   258

                the base class takes care of the rest.

   259

                """

   260

                menu = wx.Menu()

   261

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

   262

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

   263

                if self.level==1:

   264

                    menu.AppendSeparator()

   265

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

   266

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

   267

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

   268

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

   269

                    menu.AppendSeparator()

   270

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

   271

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

   272

                menu.AppendSeparator()

   273

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

   274

                return menu

   275

   276

            def MakeIcon(self, img):

   277

                """

   278

                The various platforms have different requirements for the

   279

                icon size...

   280

                """

   281

                if "wxMSW" in wx.PlatformInfo:

   282

                    img = img.Scale(16, 16)

   283

                elif "wxGTK" in wx.PlatformInfo:

   284

                    img = img.Scale(22, 22)

   285

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

   286

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

   287

                return icon

   288

   289

            def OnTaskBarStartPLC(self, evt):

   290

                if self.pyroserver.plcobj is not None:

   291

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

   292

                    if  plcstatus is "Stopped":

   293

                        self.pyroserver.plcobj.StartPLC()

   294

                    else:

   295

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

   296

   297

            def OnTaskBarStopPLC(self, evt):

   298

                if self.pyroserver.plcobj is not None:

   299

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

   300

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

   301

                    else:

   302

                        print _("PLC is not started.")

   303

   304

            def OnTaskBarChangeInterface(self, evt):

   305

                ip_addr = self.pyroserver.ip_addr

   306

                ip_addr = '' if ip_addr is None else ip_addr

   307

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

   308

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

   309

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

   310

                               ])

   311

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

   312

                    self.pyroserver.ip_addr = dlg.GetValue()

   313

                    self.pyroserver.Stop()

   314

   315

            def OnTaskBarChangePort(self, evt):

   316

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

   317

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

   318

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

   319

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

   320

                    self.pyroserver.Stop()

   321

   322

            def OnTaskBarChangeWorkingDir(self, evt):

   323

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

   324

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

   325

                    self.pyroserver.workdir = dlg.GetPath()

   326

                    self.pyroserver.Stop()

   327

   328

            def OnTaskBarChangeName(self, evt):

   329

                servicename = self.pyroserver.servicename

   330

                servicename = '' if servicename is None else servicename

   331

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

   332

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

   333

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

   334

                    self.pyroserver.servicename = dlg.GetValue()

   335

                    self.pyroserver.Restart()

   336

   337

            def _LiveShellLocals(self):

   338

                if self.pyroserver.plcobj is not None:

   339

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

   340

                else:

   341

                    return {}

   342

   343

            def OnTaskBarLiveShell(self, evt):

   344

                from wx import py

   345

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

   346

                frame.Show()

   347

   348

            def OnTaskBarWXInspector(self, evt):

   349

                # Activate the widget inspection tool

   350

                from wx.lib.inspection import InspectionTool

   351

                if not InspectionTool().initialized:

   352

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

   353

   354

                wnd = wx.GetApp()

   355

                InspectionTool().Show(wnd, True)

   356

   357

            def OnTaskBarQuit(self, evt):

   358

                if wx.Platform == '__WXMSW__':

   359

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

   360

                self.RemoveIcon()

   361

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

   362

   363

            def UpdateIcon(self, plcstatus):

   364

                if plcstatus is "Started" :

   365

                    currenticon = self.MakeIcon(starticon)

   366

                elif plcstatus is "Stopped":

   367

                    currenticon = self.MakeIcon(stopicon)

   368

                else:

   369

                    currenticon = self.MakeIcon(defaulticon)

   370

                self.SetIcon(currenticon, "Beremiz Service")

   371

   372

from runtime import PLCObject, PLCprint, ServicePublisher

   373

import Pyro.core as pyro

   374

   375

if not os.path.isdir(WorkingDir):

   376

    os.mkdir(WorkingDir)

   377

   378

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

   379

    try:

   380

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

   381

    except Exception:

   382

        res=(None, sys.exc_info())

   383

    return res

   384

   385

class Server():

   386

    def __init__(self, servicename, ip_addr, port,

   387

                 workdir, argv, autostart=False,

   388

                 statuschange=None, evaluator=default_evaluator,

   389

                 pyruntimevars=None):

   390

        self.continueloop = True

   391

        self.daemon = None

   392

        self.servicename = servicename

   393

        self.ip_addr = ip_addr

   394

        self.port = port

   395

        self.workdir = workdir

   396

        self.argv = argv

   397

        self.plcobj = None

   398

        self.servicepublisher = None

   399

        self.autostart = autostart

   400

        self.statuschange = statuschange

   401

        self.evaluator = evaluator

   402

        self.pyruntimevars = pyruntimevars

   403

   404

    def Loop(self):

   405

        while self.continueloop:

   406

            self.Start()

   407

   408

    def Restart(self):

   409

        self.Stop()

   410

   411

    def Quit(self):

   412

        self.continueloop = False

   413

        if self.plcobj is not None:

   414

            self.plcobj.StopPLC()

   415

            self.plcobj.UnLoadPLC()

   416

        self.Stop()

   417

   418

    def Start(self):

   419

        pyro.initServer()

   420

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

   421

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

   422

                                self.statuschange, self.evaluator,

   423

                                self.pyruntimevars)

   424

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

   425

   426

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

   427

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

   428

   429

        # Beremiz IDE detects daemon start by looking

   430

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

   431

        # Therefore don't delete the following line

   432

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

   433

   434

        # Configure and publish service

   435

        # Not publish service if localhost in address params

   436

        if (self.servicename is not None and

   437

            self.ip_addr is not None and

   438

            self.ip_addr != "localhost" and

   439

            self.ip_addr != "127.0.0.1"):

   440

            print _("Publishing service on local network")

   441

            self.servicepublisher = ServicePublisher.ServicePublisher()

   442

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

   443

   444

        self.plcobj.AutoLoad()

   445

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

   446

            if self.autostart :

   447

                self.plcobj.StartPLC()

   448

        self.plcobj.StatusChange()

   449

   450

        sys.stdout.flush()

   451

   452

        self.daemon.requestLoop()

   453

        self.daemon.sock.close()

   454

   455

    def Stop(self):

   456

        if self.plcobj is not None:

   457

            self.plcobj.StopPLC()

   458

        if self.servicepublisher is not None:

   459

            self.servicepublisher.UnRegisterService()

   460

            self.servicepublisher = None

   461

        self.daemon.shutdown(True)

   462

   463

if enabletwisted:

   464

    import warnings

   465

    with warnings.catch_warnings():

   466

        warnings.simplefilter("ignore")

   467

        try:

   468

            from threading import Thread, currentThread

   469

            if havewx:

   470

                from twisted.internet import wxreactor

   471

                wxreactor.install()

   472

            from twisted.internet import reactor

   473

   474

            havetwisted = True

   475

        except:

   476

            print _("Twisted unavailable.")

   477

            havetwisted = False

   478

   479

pyruntimevars = {}

   480

statuschange = []

   481

   482

if havetwisted:

   483

   484

    if havewx:

   485

        reactor.registerWxApp(app)