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 time import sleep

    27

import copy

    28

import socket

    29

import os.path

    30

    31

import Pyro5

    32

import Pyro5.client

    33

import Pyro5.errors

    34

    35

# TODO: PSK

    36

    37

from runtime import PlcStatus

    38

import importlib

    39

    40

    41

Pyro5.config.SERIALIZER = "msgpack"

    42

    43

    44

def PYRO_connector_factory(uri, confnodesroot):

    45

    """

    46

    This returns the connector to Pyro style PLCobject

    47

    """

    48

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

    49

    50

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

    51

    52

    # TODO: use ssl

    53

    54

    schemename = "PYRO"

    55

    56

    # Try to get the proxy object

    57

    try:

    58

        RemotePLCObjectProxy = Pyro5.client.Proxy(f"{schemename}:PLCObject@{location}")

    59

    except Exception as e:

    60

        confnodesroot.logger.write_error(

    61

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

    62

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

    63

        return None

    64

    65

    RemotePLCObjectProxy._pyroTimeout = 60

    66

    67

    def PyroCatcher(func, default=None):

    68

        """

    69

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

    70

        and return default value when it happen

    71

        """

    72

        def catcher_func(*args, **kwargs):

    73

            try:

    74

                return func(*args, **kwargs)

    75

            except Pyro5.errors.ConnectionClosedError as e:

    76

                confnodesroot._SetConnector(None)

    77

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

    78

            except Pyro5.errors.ProtocolError as e:

    79

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

    80

            except Exception as e:

    81

                errmess = ''.join(Pyro5.errors.get_pyro_traceback())

    82

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

    83

                print(errmess)

    84

                confnodesroot._SetConnector(None)

    85

            return default

    86

        return catcher_func

    87

    88

    # Check connection is effective.

    89

    # lambda is for getattr of GetPLCstatus to happen inside catcher

    90

    IDPSK = PyroCatcher(RemotePLCObjectProxy.GetPLCID)()

    91

    if IDPSK is None:

    92

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

    93

    else:

    94

        ID, secret = IDPSK

    95

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

    96

    97

    _special_return_funcs = {

    98

        "StartPLC": False,

    99

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

   100

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

   101

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

   102

    }

   103

   104

    class PyroProxyProxy(object):

   105

        """

   106

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

   107

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

   108

        """

   109

        def __getattr__(self, attrName):

   110

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

   111

            if member is None:

   112

                def my_local_func(*args, **kwargs):

   113

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

   114

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

   115

                self.__dict__[attrName] = member

   116

            return member

   117

   118

    return PyroProxyProxy