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

# Copyright (C) 2017: Andrey Skvortsov <andrej.skvortzov@gmail.com>

     9

#

    10

# See COPYING file for copyrights details.

    11

#

    12

# This program is free software; you can redistribute it and/or

    13

# modify it under the terms of the GNU General Public License

    14

# as published by the Free Software Foundation; either version 2

    15

# of the License, or (at your option) any later version.

    16

#

    17

# This program is distributed in the hope that it will be useful,

    18

# but WITHOUT ANY WARRANTY; without even the implied warranty of

    19

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    20

# GNU General Public License for more details.

    21

#

    22

# You should have received a copy of the GNU General Public License

    23

# along with this program; if not, write to the Free Software

    24

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

    25

    26

    27

from __future__ import absolute_import

    28

import socket

    29

from six.moves import xrange

    30

import wx

    31

import wx.lib.mixins.listctrl as listmix

    32

from zeroconf import ServiceBrowser, Zeroconf, get_all_addresses

    33

    34

service_type = '_Beremiz._tcp.local.'

    35

    36

    37

class AutoWidthListCtrl(wx.ListCtrl, listmix.ListCtrlAutoWidthMixin):

    38

    def __init__(self, parent, name, pos=wx.DefaultPosition,

    39

                 size=wx.DefaultSize, style=0):

    40

        wx.ListCtrl.__init__(self, parent, wx.ID_ANY, pos, size, style, name=name)

    41

        listmix.ListCtrlAutoWidthMixin.__init__(self)

    42

    43

    44

class DiscoveryPanel(wx.Panel, listmix.ColumnSorterMixin):

    45

    46

    def _init_coll_MainSizer_Items(self, parent):

    47

        parent.Add(self.staticText1,    0, border=20, flag=wx.TOP | wx.LEFT | wx.RIGHT | wx.GROW)

    48

        parent.Add(self.ServicesList,   0, border=20, flag=wx.LEFT | wx.RIGHT | wx.GROW)

    49

        parent.Add(self.ButtonGridSizer, 0, border=20, flag=wx.LEFT | wx.RIGHT | wx.BOTTOM | wx.GROW)

    50

    51

    def _init_coll_MainSizer_Growables(self, parent):

    52

        parent.AddGrowableCol(0)

    53

        parent.AddGrowableRow(1)

    54

    55

    def _init_coll_ButtonGridSizer_Items(self, parent):

    56

        parent.Add(self.RefreshButton, 0, border=0, flag=0)

    57

        # parent.Add(self.ByIPCheck, 0, border=0, flag=0)

    58

    59

    def _init_coll_ButtonGridSizer_Growables(self, parent):

    60

        parent.AddGrowableCol(0)

    61

        parent.AddGrowableRow(0)

    62

    63

    def _init_sizers(self):

    64

        self.MainSizer = wx.FlexGridSizer(cols=1, hgap=0, rows=3, vgap=10)

    65

        self.ButtonGridSizer = wx.FlexGridSizer(cols=2, hgap=5, rows=1, vgap=0)

    66

    67

        self._init_coll_MainSizer_Items(self.MainSizer)

    68

        self._init_coll_MainSizer_Growables(self.MainSizer)

    69

        self._init_coll_ButtonGridSizer_Items(self.ButtonGridSizer)

    70

        self._init_coll_ButtonGridSizer_Growables(self.ButtonGridSizer)

    71

    72

        self.SetSizer(self.MainSizer)

    73

    74

    def _init_list_ctrl(self):

    75

        # Set up list control

    76

        self.ServicesList = AutoWidthListCtrl(

    77

            name='ServicesList', parent=self, pos=wx.Point(0, 0), size=wx.Size(0, 0),

    78

            style=wx.LC_REPORT | wx.LC_EDIT_LABELS | wx.LC_SORT_ASCENDING | wx.LC_SINGLE_SEL)

    79

        self.ServicesList.InsertColumn(0, _('NAME'))

    80

        self.ServicesList.InsertColumn(1, _('TYPE'))

    81

        self.ServicesList.InsertColumn(2, _('IP'))

    82

        self.ServicesList.InsertColumn(3, _('PORT'))

    83

        self.ServicesList.SetColumnWidth(0, 150)

    84

        self.ServicesList.SetColumnWidth(1, 150)

    85

        self.ServicesList.SetColumnWidth(2, 150)

    86

        self.ServicesList.SetColumnWidth(3, 150)

    87

        self.ServicesList.SetInitialSize(wx.Size(-1, 300))

    88

        self.Bind(wx.EVT_LIST_ITEM_SELECTED, self.OnItemSelected, self.ServicesList)

    89

        self.Bind(wx.EVT_LIST_ITEM_ACTIVATED, self.OnItemActivated, self.ServicesList)

    90

    91

    def _init_ctrls(self, prnt):

    92

        self.staticText1 = wx.StaticText(

    93

            label=_('Services available:'), name='staticText1', parent=self,

    94

            pos=wx.Point(0, 0), size=wx.DefaultSize, style=0)

    95

    96

        self.RefreshButton = wx.Button(

    97

            label=_('Refresh'), name='RefreshButton', parent=self,

    98

            pos=wx.Point(0, 0), size=wx.DefaultSize, style=0)

    99

        self.RefreshButton.Bind(wx.EVT_BUTTON, self.OnRefreshButton)

   100

   101

        # self.ByIPCheck = wx.CheckBox(self, label=_("Use IP instead of Service Name"))

   102

        # self.ByIPCheck.SetValue(True)

   103

   104

        self._init_sizers()

   105

        self.Fit()

   106

   107

    def __init__(self, parent):

   108

        wx.Panel.__init__(self, parent)

   109

   110

        self.parent = parent

   111

   112

        self._init_list_ctrl()

   113

        listmix.ColumnSorterMixin.__init__(self, 4)

   114

   115

        self._init_ctrls(parent)

   116

   117

        self.itemDataMap = {}

   118

        self.nextItemId = 0

   119

   120

        self.URI = None

   121

        self.Browser = None

   122

        self.ZeroConfInstance = None

   123

   124

        self.RefreshList()

   125

        self.LatestSelection = None

   126

   127

        self.IfacesMonitorState = None

   128

        self.IfacesMonitorTimer = wx.Timer(self)

   129

        self.IfacesMonitorTimer.Start(2000)

   130

        self.Bind(wx.EVT_TIMER, self.IfacesMonitor, self.IfacesMonitorTimer)

   131

   132

    def _cleanup(self):

   133

        if self.IfacesMonitorTimer is not None:

   134

            self.IfacesMonitorTimer.Stop()

   135

            self.IfacesMonitorTimer = None

   136

        if self.Browser is not None:

   137

            self.Browser.cancel()

   138

            self.Browser = None

   139

        if self.ZeroConfInstance is not None:

   140

            self.ZeroConfInstance.close()

   141

            self.ZeroConfInstance = None

   142

   143

    def __del__(self):

   144

        self._cleanup()

   145

   146

    def Destroy(self):

   147

        self._cleanup()

   148

        wx.Panel.Destroy(self)

   149

   150

    def IfacesMonitor(self, event):

   151

        NewState = get_all_addresses(socket.AF_INET)

   152

   153

        if self.IfacesMonitorState != NewState:

   154

            if self.IfacesMonitorState is not None:

   155

                # refresh only if a new address appeared

   156

                for addr in NewState:

   157

                    if addr not in self.IfacesMonitorState:

   158

                        self.RefreshList()

   159

                        break

   160

            self.IfacesMonitorState = NewState

   161

        event.Skip()

   162

   163

    def RefreshList(self):

   164

        self.ServicesList.DeleteAllItems()

   165

        if self.Browser is not None:

   166

            self.Browser.cancel()

   167

        if self.ZeroConfInstance is not None:

   168

            self.ZeroConfInstance.close()

   169

        self.ZeroConfInstance = Zeroconf()

   170

        self.Browser = ServiceBrowser(self.ZeroConfInstance, service_type, self)

   171

   172

    def OnRefreshButton(self, event):

   173

        self.RefreshList()

   174

   175

    # Used by the ColumnSorterMixin, see wx/lib/mixins/listctrl.py

   176

    def GetListCtrl(self):

   177

        return self.ServicesList

   178

   179

    def getColumnText(self, index, col):

   180

        item = self.ServicesList.GetItem(index, col)

   181

        return item.GetText()

   182

   183

    def OnItemSelected(self, event):

   184

        self.SetURI(event.m_itemIndex)

   185

        event.Skip()

   186

   187

    def OnItemActivated(self, event):

   188

        self.SetURI(event.m_itemIndex)

   189

        self.parent.EndModal(wx.ID_OK)

   190

        event.Skip()

   191

   192

#    def SetURI(self, idx):

   193

#        connect_type = self.getColumnText(idx, 1)

   194

#        connect_address = self.getColumnText(idx, 2)

   195

#        connect_port = self.getColumnText(idx, 3)

   196

#

   197

#        self.URI = "%s://%s:%s"%(connect_type, connect_address, connect_port)

   198

   199

    def SetURI(self, idx):

   200

        self.LatestSelection = idx

   201

   202

    def GetURI(self):

   203

        if self.LatestSelection is not None:

   204

            # if self.ByIPCheck.IsChecked():

   205

            svcname, scheme, host, port = \

   206

                map(lambda col: self.getColumnText(self.LatestSelection, col),

   207

                    range(4))

   208

            return ("%s://%s:%s#%s" % (scheme, host, port, svcname)) \

   209

                if scheme[-1] == "S" \

   210

                else ("%s://%s:%s" % (scheme, host, port))

   211

            # else:

   212

            #     svcname = self.getColumnText(self.LatestSelection, 0)

   213

            #     connect_type = self.getColumnText(self.LatestSelection, 1)

   214

            #     return str("MDNS://%s" % svcname)

   215

        return None

   216

   217

    def remove_service(self, zeroconf, _type, name):

   218

        wx.CallAfter(self._removeService, name)

   219

   220

    def _removeService(self, name):

   221

        '''

   222

        called when a service with the desired type goes offline.

   223

        '''

   224

   225

        # loop through the list items looking for the service that went offline

   226

        for idx in xrange(self.ServicesList.GetItemCount()):

   227

            # this is the unique identifier assigned to the item

   228

            item_id = self.ServicesList.GetItemData(idx)

   229

   230

            # this is the full typename that was received by addService

   231

            item_name = self.itemDataMap[item_id][4]

   232

   233

            if item_name == name:

   234

                self.ServicesList.DeleteItem(idx)

   235

                break

   236

   237

    def add_service(self, zeroconf, _type, name):

   238

        wx.CallAfter(self._addService, _type, name)

   239

   240

    def _addService(self, _type, name):

   241

        '''

   242

        called when a service with the desired type is discovered.

   243

        '''

   244

        info = self.ZeroConfInstance.get_service_info(_type, name)

   245

        if info is None:

   246

            return

   247

        svcname = name.split(".")[0]

   248

        typename = info.properties.get("protocol", None)

   249

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

   250

        port = info.port

   251

   252

        num_items = self.ServicesList.GetItemCount()

   253

   254

        # display the new data in the list

   255

        new_item = self.ServicesList.InsertStringItem(num_items, svcname)

   256

        self.ServicesList.SetStringItem(new_item, 1, "%s" % typename)

   257

        self.ServicesList.SetStringItem(new_item, 2, "%s" % ip)

   258

        self.ServicesList.SetStringItem(new_item, 3, "%s" % port)

   259

   260

        # record the new data for the ColumnSorterMixin

   261

        # we assign every list item a unique id (that won't change when items

   262

        # are added or removed)

   263

        self.ServicesList.SetItemData(new_item, self.nextItemId)

   264

   265

        # the value of each column has to be stored in the itemDataMap

   266

        # so that ColumnSorterMixin knows how to sort the column.

   267

   268

        # "name" is included at the end so that self.removeService

   269

        # can access it.

   270

        self.itemDataMap[self.nextItemId] = [svcname, typename, ip, port, name]

   271

   272

        self.nextItemId += 1