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

if enablewx:

   116

    try:

   117

        import wxversion

   118

        wxversion.select('2.8')

   119

        import wx

   120

        havewx = True

   121

    except:

   122

        print "Wx unavailable !"

   123

        havewx = False

   124

   125

    if havewx:

   126

        import re

   127

        from threading import Thread, currentThread

   128

        from types import *

   129

        app=wx.App(redirect=False)

   130

   131

        # Import module for internationalization

   132

        import gettext

   133

   134

        def Bpath(*args):

   135

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

   136

   137

        # Get folder containing translation files

   138

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

   139

        # Get the default language

   140

        langid = wx.LANGUAGE_DEFAULT

   141

        # Define translation domain (name of translation files)

   142

        domain = "Beremiz"

   143

   144

        # Define locale for wx

   145

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

   146

        if loc is None:

   147

            loc = wx.Locale(langid)

   148

            __builtin__.__dict__['loc'] = loc

   149

        # Define location for searching translation files

   150

        loc.AddCatalogLookupPathPrefix(localedir)

   151

        # Define locale domain

   152

        loc.AddCatalog(domain)

   153

   154

        def unicode_translation(message):

   155

            return wx.GetTranslation(message).encode("utf-8")

   156

   157

        if __name__ == '__main__':

   158

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

   159

   160

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

   161

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

   162

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

   163

   164

        class ParamsEntryDialog(wx.TextEntryDialog):

   165

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

   166

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

   167

                    if id is not None:

   168

                        event(self, id, function)

   169

                    else:

   170

                        event(self, function)

   171

   172

   173

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

   174

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

   175

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

   176

   177

                self.Tests = []

   178

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

   179

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

   180

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

   181

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

   182

                else:

   183

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

   184

   185

            def OnOK(self, event):

   186

                value = self.GetValue()

   187

                texts = {"value" : value}

   188

                for function, message in self.Tests:

   189

                    if not function(value):

   190

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

   191

                        message.ShowModal()

   192

                        message.Destroy()

   193

                        return

   194

                self.EndModal(wx.ID_OK)

   195

                event.Skip()

   196

   197

            def GetValue(self):

   198

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

   199

   200

            def SetTests(self, tests):

   201

                self.Tests = tests

   202

   203

        class BeremizTaskBarIcon(wx.TaskBarIcon):

   204

            TBMENU_START = wx.NewId()

   205

            TBMENU_STOP = wx.NewId()

   206

            TBMENU_CHANGE_NAME = wx.NewId()

   207

            TBMENU_CHANGE_PORT = wx.NewId()

   208

            TBMENU_CHANGE_INTERFACE = wx.NewId()

   209

            TBMENU_LIVE_SHELL = wx.NewId()

   210

            TBMENU_WXINSPECTOR = wx.NewId()

   211

            TBMENU_CHANGE_WD = wx.NewId()

   212

            TBMENU_QUIT = wx.NewId()

   213

   214

            def __init__(self, pyroserver, level):

   215

                wx.TaskBarIcon.__init__(self)

   216

                self.pyroserver = pyroserver

   217

                # Set the image

   218

                self.UpdateIcon(None)

   219

                self.level = level

   220

   221

                # bind some events

   222

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

   223

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

   224

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

   225

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

   226

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

   227

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

   228

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

   229

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

   230

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

   231

   232

            def CreatePopupMenu(self):

   233

                """

   234

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

   235

                the menu for the default EVT_RIGHT_DOWN event.  Just create

   236

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

   237

                the base class takes care of the rest.

   238

                """

   239

                menu = wx.Menu()

   240

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

   241

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

   242

                if self.level==1:

   243

                    menu.AppendSeparator()

   244

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

   245

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

   246

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

   247

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

   248

                    menu.AppendSeparator()

   249

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

   250

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

   251

                menu.AppendSeparator()

   252

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

   253

                return menu

   254

   255

            def MakeIcon(self, img):

   256

                """

   257

                The various platforms have different requirements for the

   258

                icon size...

   259

                """

   260

                if "wxMSW" in wx.PlatformInfo:

   261

                    img = img.Scale(16, 16)

   262

                elif "wxGTK" in wx.PlatformInfo:

   263

                    img = img.Scale(22, 22)

   264

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

   265

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

   266

                return icon

   267

   268

            def OnTaskBarStartPLC(self, evt):

   269

                if self.pyroserver.plcobj is not None:

   270

                    self.pyroserver.plcobj.StartPLC()

   271

   272

            def OnTaskBarStopPLC(self, evt):

   273

                if self.pyroserver.plcobj is not None:

   274

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

   275

   276

            def OnTaskBarChangeInterface(self, evt):

   277

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

   278

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

   279

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

   280

                               ])

   281

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

   282

                    self.pyroserver.ip_addr = dlg.GetValue()

   283

                    self.pyroserver.Stop()

   284

   285

            def OnTaskBarChangePort(self, evt):

   286

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

   287

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

   288

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

   289

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

   290

                    self.pyroserver.Stop()

   291

   292

            def OnTaskBarChangeWorkingDir(self, evt):

   293

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

   294

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

   295

                    self.pyroserver.workdir = dlg.GetPath()

   296

                    self.pyroserver.Stop()

   297

   298

            def OnTaskBarChangeName(self, evt):

   299

                dlg = ParamsEntryDialog(None, _("Enter a name "), defaultValue=self.pyroserver.name)

   300

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

   301

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

   302

                    self.pyroserver.name = dlg.GetValue()

   303

                    self.pyroserver.Restart()

   304

   305

            def _LiveShellLocals(self):

   306

                if self.pyroserver.plcobj is not None:

   307

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

   308

                else:

   309

                    return {}

   310

   311

            def OnTaskBarLiveShell(self, evt):

   312

                from wx import py

   313

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

   314

                frame.Show()

   315

   316

            def OnTaskBarWXInspector(self, evt):

   317

                # Activate the widget inspection tool

   318

                from wx.lib.inspection import InspectionTool

   319

                if not InspectionTool().initialized:

   320

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

   321

   322

                wnd = wx.GetApp()

   323

                InspectionTool().Show(wnd, True)

   324

   325

            def OnTaskBarQuit(self, evt):

   326

                if wx.Platform == '__WXMSW__':

   327

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

   328

                self.RemoveIcon()

   329

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

   330

   331

            def UpdateIcon(self, plcstatus):

   332

                if plcstatus is "Started" :

   333

                    currenticon = self.MakeIcon(starticon)

   334

                elif plcstatus is "Stopped":

   335

                    currenticon = self.MakeIcon(stopicon)

   336

                else:

   337

                    currenticon = self.MakeIcon(defaulticon)

   338

                self.SetIcon(currenticon, "Beremiz Service")

   339

   340

from runtime import PLCObject, PLCprint, ServicePublisher

   341

import Pyro.core as pyro

   342

   343

if not os.path.isdir(WorkingDir):

   344

    os.mkdir(WorkingDir)

   345

   346

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

   347

    try:

   348

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

   349

    except Exception:

   350

        res=(None, sys.exc_info())

   351

    return res

   352

   353

class Server():

   354

    def __init__(self, servicename, ip_addr, port,

   355

                 workdir, argv, autostart=False,

   356

                 statuschange=None, evaluator=default_evaluator,

   357

                 pyruntimevars=None):

   358

        self.continueloop = True

   359

        self.daemon = None

   360

        self.servicename = servicename

   361

        self.ip_addr = ip_addr

   362

        self.port = port

   363

        self.workdir = workdir

   364

        self.argv = argv

   365

        self.plcobj = None

   366

        self.servicepublisher = None

   367

        self.autostart = autostart

   368

        self.statuschange = statuschange

   369

        self.evaluator = evaluator

   370

        self.pyruntimevars = pyruntimevars

   371

   372

    def Loop(self):

   373

        while self.continueloop:

   374

            self.Start()

   375

   376

    def Restart(self):

   377

        self.Stop()

   378

   379

    def Quit(self):

   380

        self.continueloop = False

   381

        if self.plcobj is not None:

   382

            self.plcobj.UnLoadPLC()

   383

        self.Stop()

   384

   385

    def Start(self):

   386

        pyro.initServer()

   387

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

   388

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

   389

                                self.statuschange, self.evaluator,

   390

                                self.pyruntimevars)

   391

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

   392

   393

        print "Pyro port :",self.port

   394

        print "Pyro object's uri :",uri

   395

        print "Current working directory :",self.workdir

   396

   397

        # Configure and publish service

   398

        # Not publish service if localhost in address params

   399

        if (self.servicename is not None and

   400

            self.ip_addr is not None and

   401

            self.ip_addr != "localhost" and

   402

            self.ip_addr != "127.0.0.1"):

   403

            print "Publishing service on local network"

   404

            self.servicepublisher = ServicePublisher.ServicePublisher()

   405

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

   406

   407

        if self.autostart :

   408

            self.plcobj.AutoLoad()

   409

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

   410

                self.plcobj.StartPLC()

   411

   412

        sys.stdout.flush()

   413

   414

        self.daemon.requestLoop()

   415

   416

    def Stop(self):

   417

        if self.plcobj is not None:

   418

            self.plcobj.StopPLC()

   419

        if self.servicepublisher is not None:

   420

            self.servicepublisher.UnRegisterService()

   421

            self.servicepublisher = None

   422

        self.daemon.shutdown(True)

   423

   424

if enabletwisted:

   425

    import warnings

   426

    with warnings.catch_warnings():

   427

        warnings.simplefilter("ignore")

   428

        try:

   429

            from threading import Thread, currentThread

   430

            if havewx:

   431

                from twisted.internet import wxreactor

   432

                wxreactor.install()

   433

            from twisted.internet import reactor

   434

   435

            havetwisted = True

   436

        except:

   437

            print "Twisted unavailable."

   438

            havetwisted = False

   439

   440

pyruntimevars = {}

   441

statuschange = []

   442

   443

if havetwisted:

   444

   445

    if havewx:

   446

        reactor.registerWxApp(app)

   447

   448

if havewx:

   449

    from threading import Semaphore

   450

    wx_eval_lock = Semaphore(0)

   451

    main_thread = currentThread()

   452

   453

    def statuschangeTskBar(status):

   454

        wx.CallAfter(taskbar_instance.UpdateIcon,status)

   455

   456

    statuschange.append(statuschangeTskBar)

   457

   458

    def wx_evaluator(obj, *args, **kwargs):

   459

        tocall,args,kwargs = obj.call

   460

        obj.res = default_evaluator(tocall, *args, **kwargs)

   461

        wx_eval_lock.release()

   462

   463

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

   464

        global main_thread

   465

        if(main_thread == currentThread()):

   466

            # avoid dead lock if called from the wx mainloop

   467

            return default_evaluator(tocall, *args, **kwargs)

   468

        else:

   469

            o=type('',(object,),dict(call=(tocall, args, kwargs), res=None))

   470

            wx.CallAfter(wx_evaluator,o)

   471

            wx_eval_lock.acquire()

   472

            return o.res

   473

   474

    pyroserver = Server(servicename, given_ip, port,

   475

                        WorkingDir, argv, autostart,

   476

                        statuschange, evaluator, pyruntimevars)

   477

   478

    taskbar_instance = BeremizTaskBarIcon(pyroserver, enablewx)

   479

else:

   480

    pyroserver = Server(servicename, given_ip, port,

   481

                        WorkingDir, argv, autostart,

   482

                        statuschange, pyruntimevars=pyruntimevars)

   483

   484