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.SERPENT_BYTES_REPR = True

    42

    43

def PYRO_connector_factory(uri, confnodesroot):

    44

    """

    45

    This returns the connector to Pyro style PLCobject

    46

    """

    47

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

    48

    49

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

    50

    51

    # TODO: use ssl

    52

    53

    schemename = "PYRO"

    54

    55

    # Try to get the proxy object

    56

    try:

    57

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

    58

    except Exception as e:

    59

        confnodesroot.logger.write_error(

    60

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

    61

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

    62

        return None

    63

    64

    RemotePLCObjectProxy._pyroTimeout = 60

    65

    66

    def PyroCatcher(func, default=None):

    67

        """

    68

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

    69

        and return default value when it happen

    70

        """

    71

        def catcher_func(*args, **kwargs):

    72

            try:

    73

                return func(*args, **kwargs)

    74

            except Pyro5.errors.ConnectionClosedError as e:

    75

                confnodesroot._SetConnector(None)

    76

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

    77

            except Pyro5.errors.ProtocolError as e:

    78

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

    79

            except Exception as e:

    81

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

    82

                print(errmess)

    83

                confnodesroot._SetConnector(None)

    84

            return default

    85

        return catcher_func

    86

    87

    # Check connection is effective.

    88

    # lambda is for getattr of GetPLCstatus to happen inside catcher

    89

    IDPSK = PyroCatcher(RemotePLCObjectProxy.GetPLCID)()

    90

    if IDPSK is None:

    91

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

    92

    else:

    93

        ID, secret = IDPSK

    94

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

    95

    96

    _special_return_funcs = {

    97

        "StartPLC": False,

    98

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

    99

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

   100

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

   101

    }

   102

   103

    class PyroProxyProxy(object):

   104

        """

   105

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

   106

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

   107

        """

   108

        def __getattr__(self, attrName):

   109

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

   110

            if member is None:

   111

                def my_local_func(*args, **kwargs):

   112

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

   113

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

   114

                self.__dict__[attrName] = member

   115

            return member

   116

   117

    return PyroProxyProxy