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 connectors.PYRO.PSK_Adapter import setupPSKAdapter

    41

    42

    43

def switch_pyro_adapter(use_ssl):

    44

    """

    45

    Reloads Pyro module with new settings.

    46

    This is workaround for Pyro, because it doesn't work with SSL wrapper.

    47

    """

    48

    # Pyro.config.PYRO_BROKEN_MSGWAITALL = use_ssl

    49

    reload(Pyro.protocol)

    50

    if use_ssl:

    51

        setupPSKAdapter()

    52

    53

    54

def PYRO_connector_factory(uri, confnodesroot):

    55

    """

    56

    This returns the connector to Pyro style PLCobject

    57

    """

    58

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

    59

    60

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

    61

    use_ssl = scheme == "PYROS"

    62

    switch_pyro_adapter(use_ssl)

    63

    if use_ssl:

    64

        schemename = "PYROLOCPSK"

    65

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

    66

        # load PSK from project

    67

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

    68

        if not os.path.exists(secpath):

    69

            confnodesroot.logger.write_error(

    70

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

    71

            return None

    72

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

    73

        Pyro.config.PYROPSK = (secret, ID)

    74

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

    75

        location = url

    76

    else:

    77

        schemename = "PYROLOC"

    78

    79

    # Try to get the proxy object

    80

    try:

    81

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

    82

    except Exception as e:

    83

        confnodesroot.logger.write_error(

    84

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

    85

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

    86

        return None

    87

    88

    RemotePLCObjectProxy.adapter.setTimeout(60)

    89

    93

    def PyroCatcher(func, default=None):

    94

        """

    95

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

    96

        and return default value when it happen

    97

        """

    98

        def catcher_func(*args, **kwargs):

    99

            try:

   100

                return func(*args, **kwargs)

   101

            except Pyro.errors.ConnectionClosedError as e:

   102

                confnodesroot._SetConnector(None)

   103

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

   104

            except Pyro.errors.ProtocolError as e:

   105

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

   108

            except Exception as e:

   109

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

   110

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

   111

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

   112

                print(errmess)

   113

                confnodesroot._SetConnector(None)

   114

            return default

   115

        return catcher_func

   116

   117

    # Check connection is effective.

   118

    # lambda is for getattr of GetPLCstatus to happen inside catcher

   119

    IDPSK = PyroCatcher(RemotePLCObjectProxy.GetPLCID)()

   120

    if IDPSK is None:

   121

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

   122

    else:

   123

        ID, secret = IDPSK

   124

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

   125

   126

    class PyroProxyProxy(object):

   127

        """

   128

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

   129

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

   130

        """

   131

        def __getattr__(self, attrName):

   132

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

   133

            if member is None:

   134

                def my_local_func(*args, **kwargs):

   141

                self.__dict__[attrName] = member

   142

            return member

   143

   144

    return PyroProxyProxy