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

zeroconf_service_type = '_PYRO._tcp.local.'

    40

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

    41

# supported by this connector confnode.

    42

#

    43

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

    44

# or set to an empty list.

    45

    46

    47

def PYRO_connector_factory(uri, confnodesroot):

    48

    """

    49

    This returns the connector to Pyro style PLCobject

    50

    """

    51

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

    52

    53

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

    54

    if servicetype == "PYROS":

    55

        import connectors.PYRO.PSK_Adapter

    56

        schemename = "PYROLOCPSK"

    57

        url, ID = location.split('#')

    58

        # load PSK from project

    59

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

    60

        if not os.path.exists(secpath):

    61

            confnodesroot.logger.write_error(

    62

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

    63

            return None

    64

        Pyro.config.PYROPSK = (open(secpath).read(), ID)

    65

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

    66

        location = url

    67

    else:

    68

        schemename = "PYROLOC"

    69

    70

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

    71

        try:

    72

            from zeroconf import Zeroconf

    73

            r = Zeroconf()

    74

            i = r.get_service_info(zeroconf_service_type, location)

    75

            if i is None:

    76

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

    77

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

    78

            port = str(i.port)

    79

            newlocation = ip + ':' + port

    80

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

    81

            location = newlocation

    82

            r.close()

    83

        except Exception:

    84

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

    85

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

    86

            return None

    87

    88

    # Try to get the proxy object

    89

    try:

    90

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

    91

    except Exception:

    92

        confnodesroot.logger.write_error(_("Connection to '%s' failed.\n") % location)

    93

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

    94

        return None

    95

    96

    def PyroCatcher(func, default=None):

    97

        """

    98

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

    99

        and return default value when it happen

   100

        """

   101

        def catcher_func(*args, **kwargs):

   102

            try:

   103

                return func(*args, **kwargs)

   104

            except Pyro.errors.ConnectionClosedError, e:

   105

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

   106

                confnodesroot._SetConnector(None)

   107

            except Pyro.errors.ProtocolError, e:

   108

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

   109

            except Exception, e:

   110

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

   111

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

   112

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

   113

                print(errmess)

   114

                confnodesroot._SetConnector(None)

   115

            return default

   116

        return catcher_func

   117

   118

    # Check connection is effective.

   119

    # lambda is for getattr of GetPLCstatus to happen inside catcher

   120

    if PyroCatcher(RemotePLCObjectProxy.GetPLCstatus)() is None:

   121

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

   122

        return None

   123

   124

    _special_return_funcs = {

   125

        "StartPLC": False,

   126

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

   127

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

   128

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

   129

    }

   130

   131

    class PyroProxyProxy(object):

   132

        """

   133

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

   134

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

   135

        """

   136

        def __getattr__(self, attrName):

   137

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

   138

            if member is None:

   139

                def my_local_func(*args, **kwargs):

   140

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

   141

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

   142

                self.__dict__[attrName] = member

   143

            return member

   144

   145

    return PyroProxyProxy()

   146