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

   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 *

   135

   136

        # Import module for internationalization

   137

        import gettext

   138

   139

        def Bpath(*args):

   140

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

   141

   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

        def unicode_translation(message):

   160

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

   161

   162

        if __name__ == '__main__':

   163

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

   164

   165

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

   166

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

   167

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

   168

   169

        class ParamsEntryDialog(wx.TextEntryDialog):

   170

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

   171

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

   172

                    if id is not None:

   173

                        event(self, id, function)

   174

                    else:

   175

                        event(self, function)

   176

   177

   178

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

   179

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

   180

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

   181

   182

                self.Tests = []

   183

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

   184

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

   185

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

   186

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

   187

                else:

   188

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

   189

   190

            def OnOK(self, event):

   191

                value = self.GetValue()

   192

                texts = {"value" : value}

   193

                for function, message in self.Tests:

   194

                    if not function(value):

   195

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

   196

                        message.ShowModal()

   197

                        message.Destroy()

   198

                        return

   199

                self.EndModal(wx.ID_OK)

   200

                event.Skip()

   201

   202

            def GetValue(self):

   203

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

   204

   205

            def SetTests(self, tests):

   206

                self.Tests = tests

   207

   208

        class BeremizTaskBarIcon(wx.TaskBarIcon):

   209

            TBMENU_START = wx.NewId()

   210

            TBMENU_STOP = wx.NewId()

   211

            TBMENU_CHANGE_NAME = wx.NewId()

   212

            TBMENU_CHANGE_PORT = wx.NewId()

   213

            TBMENU_CHANGE_INTERFACE = wx.NewId()

   214

            TBMENU_LIVE_SHELL = wx.NewId()

   215

            TBMENU_WXINSPECTOR = wx.NewId()

   216

            TBMENU_CHANGE_WD = wx.NewId()

   217

            TBMENU_QUIT = wx.NewId()

   218

   219

            def __init__(self, pyroserver, level):

   220

                wx.TaskBarIcon.__init__(self)

   221

                self.pyroserver = pyroserver

   222

                # Set the image

   223

                self.UpdateIcon(None)

   224

                self.level = level

   225

   226

                # bind some events

   227

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

   228

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

   229

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

   230

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

   231

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

   232

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

   233

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

   234

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

   235

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

   236

   237

            def CreatePopupMenu(self):

   238

                """

   239

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

   240

                the menu for the default EVT_RIGHT_DOWN event.  Just create

   241

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

   242

                the base class takes care of the rest.

   243

                """

   244

                menu = wx.Menu()

   245

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

   246

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

   247

                if self.level==1:

   248

                    menu.AppendSeparator()

   249

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

   250

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

   251

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

   252

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

   253

                    menu.AppendSeparator()

   254

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

   255

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

   256

                menu.AppendSeparator()

   257

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

   258

                return menu

   259

   260

            def MakeIcon(self, img):

   261

                """

   262

                The various platforms have different requirements for the

   263

                icon size...

   264

                """

   265

                if "wxMSW" in wx.PlatformInfo:

   266

                    img = img.Scale(16, 16)

   267

                elif "wxGTK" in wx.PlatformInfo:

   268

                    img = img.Scale(22, 22)

   269

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

   270

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

   271

                return icon

   272

   273

            def OnTaskBarStartPLC(self, evt):

   274

                if self.pyroserver.plcobj is not None:

   275

                    self.pyroserver.plcobj.StartPLC()

   276

   277

            def OnTaskBarStopPLC(self, evt):

   278

                if self.pyroserver.plcobj is not None:

   279

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

   280

   281

            def OnTaskBarChangeInterface(self, evt):

   282

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

   283

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

   284

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

   285

                               ])

   286

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

   287

                    self.pyroserver.ip_addr = dlg.GetValue()

   288

                    self.pyroserver.Stop()

   289

   290

            def OnTaskBarChangePort(self, evt):

   291

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

   292

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

   293

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

   294

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

   295

                    self.pyroserver.Stop()

   296

   297

            def OnTaskBarChangeWorkingDir(self, evt):

   298

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

   299

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

   300

                    self.pyroserver.workdir = dlg.GetPath()

   301

                    self.pyroserver.Stop()

   302

   303

            def OnTaskBarChangeName(self, evt):

   304

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

   305

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

   306

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

   307

                    self.pyroserver.name = dlg.GetValue()

   308

                    self.pyroserver.Restart()

   309

   310

            def _LiveShellLocals(self):

   311

                if self.pyroserver.plcobj is not None:

   312

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

   313

                else:

   314

                    return {}

   315

   316

            def OnTaskBarLiveShell(self, evt):

   317

                from wx import py

   318

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

   319

                frame.Show()

   320

   321

            def OnTaskBarWXInspector(self, evt):

   322

                # Activate the widget inspection tool

   323

                from wx.lib.inspection import InspectionTool

   324

                if not InspectionTool().initialized:

   325

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

   326

   327

                wnd = wx.GetApp()

   328

                InspectionTool().Show(wnd, True)

   329

   330

            def OnTaskBarQuit(self, evt):

   331

                if wx.Platform == '__WXMSW__':

   332

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

   333

                self.RemoveIcon()

   334

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

   335

   336

            def UpdateIcon(self, plcstatus):

   337

                if plcstatus is "Started" :

   338

                    currenticon = self.MakeIcon(starticon)

   339

                elif plcstatus is "Stopped":

   340

                    currenticon = self.MakeIcon(stopicon)

   341

                else:

   342

                    currenticon = self.MakeIcon(defaulticon)

   343

                self.SetIcon(currenticon, "Beremiz Service")

   344

   345

from runtime import PLCObject, PLCprint, ServicePublisher

   346

import Pyro.core as pyro

   347

   348

if not os.path.isdir(WorkingDir):

   349

    os.mkdir(WorkingDir)

   350

   351

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

   352

    try:

   353

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

   354

    except Exception:

   355

        res=(None, sys.exc_info())

   356

    return res

   357

   358

class Server():

   359

    def __init__(self, servicename, ip_addr, port,

   360

                 workdir, argv, autostart=False,

   361

                 statuschange=None, evaluator=default_evaluator,

   362

                 pyruntimevars=None):

   363

        self.continueloop = True

   364

        self.daemon = None

   365

        self.servicename = servicename

   366

        self.ip_addr = ip_addr

   367

        self.port = port

   368

        self.workdir = workdir

   369

        self.argv = argv

   370

        self.plcobj = None

   371

        self.servicepublisher = None

   372

        self.autostart = autostart

   373

        self.statuschange = statuschange

   374

        self.evaluator = evaluator

   375

        self.pyruntimevars = pyruntimevars

   376

   377

    def Loop(self):

   378

        while self.continueloop:

   379

            self.Start()

   380

   381

    def Restart(self):

   382

        self.Stop()

   383

   384

    def Quit(self):

   385

        self.continueloop = False

   386

        if self.plcobj is not None:

   387

            self.plcobj.UnLoadPLC()

   388

        self.Stop()

   389

   390

    def Start(self):

   391

        pyro.initServer()

   392

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

   393

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

   394

                                self.statuschange, self.evaluator,

   395

                                self.pyruntimevars)

   396

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

   397

   398

        print "Pyro port :",self.port

   399

        print "Pyro object's uri :",uri

   400

        print "Current working directory :",self.workdir

   401

   402

        # Configure and publish service

   403

        # Not publish service if localhost in address params

   404

        if (self.servicename is not None and

   405

            self.ip_addr is not None and

   406

            self.ip_addr != "localhost" and

   407

            self.ip_addr != "127.0.0.1"):

   408

            print "Publishing service on local network"

   409

            self.servicepublisher = ServicePublisher.ServicePublisher()

   410

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

   411

   412

        if self.autostart :

   413

            self.plcobj.AutoLoad()

   414

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

   415

                self.plcobj.StartPLC()

   416

   417

        sys.stdout.flush()

   418

   419

        self.daemon.requestLoop()

   420

   421

    def Stop(self):

   422

        if self.plcobj is not None:

   423

            self.plcobj.StopPLC()

   424

        if self.servicepublisher is not None:

   425

            self.servicepublisher.UnRegisterService()

   426

            self.servicepublisher = None

   427

        self.daemon.shutdown(True)

   428

   429

if enabletwisted:

   430

    import warnings

   431

    with warnings.catch_warnings():

   432

        warnings.simplefilter("ignore")

   433

        try:

   434

            from threading import Thread, currentThread

   435

            if havewx:

   436

                from twisted.internet import wxreactor

   437

                wxreactor.install()

   438

            from twisted.internet import reactor

   439

   440

            havetwisted = True

   441

        except:

   442

            print "Twisted unavailable."

   443

            havetwisted = False

   444

   445

pyruntimevars = {}

   446

statuschange = []

   447

   448

if havetwisted:

   449

   450

    if havewx:

   451

        reactor.registerWxApp(app)

   452

   453

if havewx:

   454

    from threading import Semaphore

   455

    wx_eval_lock = Semaphore(0)

   456

    main_thread = currentThread()

   457

   458

    def statuschangeTskBar(status):

   459

        wx.CallAfter(taskbar_instance.UpdateIcon,status)

   460

   461

    statuschange.append(statuschangeTskBar)

   462

   463

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

   464

        tocall,args,kwargs = obj.call

   465

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

   466

        wx_eval_lock.release()

   467

   468

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

   469

        global main_thread

   470

        if(main_thread == currentThread()):

   471

            # avoid dead lock if called from the wx mainloop

   472

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

   473

        else:

   474

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

   475

            wx.CallAfter(wx_evaluator,o)

   476

            wx_eval_lock.acquire()

   477

            return o.res

   478

   479

    pyroserver = Server(servicename, given_ip, port,

   480

                        WorkingDir, argv, autostart,

   481

                        statuschange, evaluator, pyruntimevars)

   482

   483

    taskbar_instance = BeremizTaskBarIcon(pyroserver, enablewx)

   484

else: