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

import PSKManagement as PSK

    40

from runtime import PlcStatus

    41

    42

zeroconf_service_type = '_PYRO._tcp.local.'

    43

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

    44

# supported by this connector confnode.

    45

#

    46

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

    47

# or set to an empty list.

    48

    49

    50

def PYRO_connector_factory(uri, confnodesroot):

    51

    """

    52

    This returns the connector to Pyro style PLCobject

    53

    """

    54

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

    55

    56

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

    57

    if scheme == "PYROS":

    58

        import connectors.PYRO.PSK_Adapter

    59

        schemename = "PYROLOCPSK"

    60

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

    61

        # load PSK from project

    62

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

    63

        if not os.path.exists(secpath):

    64

            confnodesroot.logger.write_error(

    65

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

    66

            return None

    67

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

    68

        Pyro.config.PYROPSK = (secret, ID)

    69

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

    70

        location = url

    71

    else:

    72

        schemename = "PYROLOC"

    73

    74

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

    75

        try:

    76

            from zeroconf import Zeroconf

    77

            r = Zeroconf()

    78

            i = r.get_service_info(zeroconf_service_type, location)

    79

            if i is None:

    80

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

    81

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

    82

            port = str(i.port)

    83

            newlocation = ip + ':' + port

    84

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

    85

            location = newlocation

    86

            r.close()

    87

        except Exception:

    88

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

    89

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

    90

            return None

    91

    92

    # Try to get the proxy object

    93

    try:

    94

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

    95

    except Exception:

    96

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

    97

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

    98

        return None

    99

   102

    def PyroCatcher(func, default=None):

   103

        """

   104

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

   105

        and return default value when it happen

   106

        """

   107

        def catcher_func(*args, **kwargs):

   108

            try:

   109

                return func(*args, **kwargs)

   110

            except Pyro.errors.ConnectionClosedError as e:

   111

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

   112

                confnodesroot._SetConnector(None)

   113

            except Pyro.errors.ProtocolError as e:

   114

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

   115

            except Exception as e:

   116

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

   117

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

   118

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

   119

                print(errmess)

   120

                confnodesroot._SetConnector(None)

   121

            return default

   122

        return catcher_func

   123

   124

    # Check connection is effective.

   125

    # lambda is for getattr of GetPLCstatus to happen inside catcher

   126

    IDPSK = PyroCatcher(RemotePLCObjectProxy.GetPLCID)()

   127

    if IDPSK is None:

   128

        confnodesroot.logger.write_warning(_("PLC did not provide identity and security infomation.\n"))

   129

    else:

   130

        ID,secret = IDPSK

   131

        PSK.UpdateID(confnodesroot.ProjectPath, ID, secret, uri)

   132

   133

   134

    _special_return_funcs = {

   135

        "StartPLC": False,

   136

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

   137

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

   138

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

   139

    }

   140

   141

    class PyroProxyProxy(object):

   142

        """

   143

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

   144

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

   145

        """

   146

        def __getattr__(self, attrName):

   147

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

   148

            if member is None:

   149

                def my_local_func(*args, **kwargs):

   150

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

   151

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

   152

                self.__dict__[attrName] = member

   153

            return member

   154

   155

    return PyroProxyProxy