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

    26

from __future__ import absolute_import

    27

from __future__ import print_function

    28

import traceback

    29

from time import sleep

    30

import copy

    31

import socket

    32

import os.path

    33

    34

import Pyro

    35

import Pyro.core

    36

import Pyro.util

    37

from Pyro.errors import PyroError

    38

    39

    40

zeroconf_service_type = '_PYRO._tcp.local.'

    41

# this module attribute contains a list of DNS-SD (Zeroconf) service types

    42

# supported by this connector confnode.

    43

#

    44

# for connectors that do not support DNS-SD, this attribute can be omitted

    45

# or set to an empty list.

    46

    47

    48

def PYRO_connector_factory(uri, confnodesroot):

    49

    """

    50

    This returns the connector to Pyro style PLCobject

    51

    """

    52

    confnodesroot.logger.write(_("PYRO connecting to URI : %s\n") % uri)

    53

    54

    servicetype, location = uri.split("://")

    55

    if servicetype == "PYROS":

    56

        import connectors.PYRO.PSK_Adapter

    57

        schemename = "PYROLOCPSK"

    58

        url, ID = location.split('#') #TODO fix exception when # not found

    59

        # load PSK from project

    60

        secpath = os.path.join(str(confnodesroot.ProjectPath), 'psk', ID+'.secret')

    61

        if not os.path.exists(secpath):

    62

            confnodesroot.logger.write_error(

    63

                'Error: Pre-Shared-Key Secret in %s is missing!\n' % secpath)

    64

            return None

    65

        secret = open(secpath).read().partition(':')[2].rstrip('\n\r')

    66

        Pyro.config.PYROPSK = (secret, ID)

    67

        # strip ID from URL, so that pyro can understand it.

    68

        location = url

    69

    else:

    70

        schemename = "PYROLOC"

    71

    72

    if location.find(zeroconf_service_type) != -1:

    73

        try:

    74

            from zeroconf import Zeroconf

    75

            r = Zeroconf()

    76

            i = r.get_service_info(zeroconf_service_type, location)

    77

            if i is None:

    78

                raise Exception("'%s' not found" % location)

    79

            ip = str(socket.inet_ntoa(i.address))

    80

            port = str(i.port)

    81

            newlocation = ip + ':' + port

    82

            confnodesroot.logger.write(_("'{a1}' is located at {a2}\n").format(a1=location, a2=newlocation))

    83

            location = newlocation

    84

            r.close()

    85

        except Exception:

    86

            confnodesroot.logger.write_error(_("MDNS resolution failure for '%s'\n") % location)

    87

            confnodesroot.logger.write_error(traceback.format_exc())

    88

            return None

    89

    90

    # Try to get the proxy object

    91

    try:

    92

        RemotePLCObjectProxy = Pyro.core.getAttrProxyForURI(schemename + "://" + location + "/PLCObject")

    93

    except Exception,e:

    94

        confnodesroot.logger.write_error(_("Connection to '%s' failed with exception '%s'\n") % (location, str(e)))

    95

        #confnodesroot.logger.write_error(traceback.format_exc())

    96

        return None

    97

    98

    def PyroCatcher(func, default=None):

    99

        """

   100

        A function that catch a Pyro exceptions, write error to logger

   101

        and return default value when it happen

   102

        """

   103

        def catcher_func(*args, **kwargs):

   104

            try:

   105

                return func(*args, **kwargs)

   106

            except Pyro.errors.ConnectionClosedError, e:

   107

                confnodesroot.logger.write_error(_("Connection lost!\n"))

   108

                confnodesroot._SetConnector(None)

   109

            except Pyro.errors.ProtocolError, e:

   110

                confnodesroot.logger.write_error(_("Pyro exception: %s\n") % e)

   111

            except Exception, e:

   112

                # confnodesroot.logger.write_error(traceback.format_exc())

   113

                errmess = ''.join(Pyro.util.getPyroTraceback(e))

   114

                confnodesroot.logger.write_error(errmess + "\n")

   115

                print(errmess)

   116

                confnodesroot._SetConnector(None)

   117

            return default

   118

        return catcher_func

   119

   120

    # Check connection is effective.

   121

    # lambda is for getattr of GetPLCstatus to happen inside catcher

   122

    IDPSK = PyroCatcher(RemotePLCObjectProxy.GetPLCID)()

   123

    if IDPSK is None:

   124

        confnodesroot.logger.write_error(_("Cannot get PLC ID - connection failed.\n"))

   125

        return None

   126

   127

    if servicetype != "PYROS":

   128

        ID,PSK = IDPSK

   133

        with open(secpath, 'w') as f:

   134

            f.write(ID+":"+PSK)

   135

   136

    _special_return_funcs = {

   137

        "StartPLC": False,

   138

        "GetTraceVariables": ("Broken", None),

   139

        "GetPLCstatus": ("Broken", None),

   140

        "RemoteExec": (-1, "RemoteExec script failed!")

   141

    }

   142

   143

    class PyroProxyProxy(object):

   144

        """

   145

        A proxy proxy class to handle Beremiz Pyro interface specific behavior.

   146

        And to put Pyro exception catcher in between caller and Pyro proxy

   147

        """

   148

        def __getattr__(self, attrName):

   149

            member = self.__dict__.get(attrName, None)

   150

            if member is None:

   151

                def my_local_func(*args, **kwargs):

   152

                    return RemotePLCObjectProxy.__getattr__(attrName)(*args, **kwargs)

   153

                member = PyroCatcher(my_local_func, _special_return_funcs.get(attrName, None))

   154

                self.__dict__[attrName] = member

   155

            return member

   156

   157

    return PyroProxyProxy()

   158