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

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

    43

# supported by this connector confnode.

    44

#

    45

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

    46

# or set to an empty list.

    47

    48

    49

def PYRO_connector_factory(uri, confnodesroot):

    50

    """

    51

    This returns the connector to Pyro style PLCobject

    52

    """

    53

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

    54

    55

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

    56

    if scheme == "PYROS":

    57

        import connectors.PYRO.PSK_Adapter  # pylint: disable=wrong-import-order,unused-import,wrong-import-position

    58

        schemename = "PYROLOCPSK"

    59

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

    60

        # load PSK from project

    61

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

    62

        if not os.path.exists(secpath):

    63

            confnodesroot.logger.write_error(

    64

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

    65

            return None

    66

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

    67

        Pyro.config.PYROPSK = (secret, ID)

    68

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

    69

        location = url

    70

    else:

    71

        schemename = "PYROLOC"

    72

    73

    # Try to get the proxy object

    74

    try:

    75

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

    76

    except Exception as e:

    77

        confnodesroot.logger.write_error(

    78

            _("Connection to {loc} failed with exception {ex}\n").format(

    79

                loc=location, ex=str(e)))

    80

        return None

    81

    82

    RemotePLCObjectProxy.adapter.setTimeout(60)

    83

    84

    def PyroCatcher(func, default=None):

    85

        """

    86

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

    87

        and return default value when it happen

    88

        """

    89

        def catcher_func(*args, **kwargs):

    90

            try:

    91

                return func(*args, **kwargs)

    92

            except Pyro.errors.ConnectionClosedError as e:

    93

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

    94

                confnodesroot._SetConnector(None)

    95

            except Pyro.errors.ProtocolError as e:

    96

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

    97

            except Exception as e:

    98

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

    99

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

   100

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

   101

                print(errmess)

   102

                confnodesroot._SetConnector(None)

   103

            return default

   104

        return catcher_func

   105

   106

    # Check connection is effective.

   107

    # lambda is for getattr of GetPLCstatus to happen inside catcher

   108

    IDPSK = PyroCatcher(RemotePLCObjectProxy.GetPLCID)()

   109

    if IDPSK is None:

   110

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

   111

    else:

   112

        ID, secret = IDPSK

   113

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

   114

   115

    _special_return_funcs = {

   116

        "StartPLC": False,

   117

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

   118

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

   119

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

   120

    }

   121

   122

    class PyroProxyProxy(object):

   123

        """

   124

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

   125

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

   126

        """

   127

        def __getattr__(self, attrName):

   128

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

   129

            if member is None:

   130

                def my_local_func(*args, **kwargs):

   131

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

   132

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

   133

                self.__dict__[attrName] = member

   134

            return member

   135

   136

    return PyroProxyProxy