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

import socket

    28

import weakref

    29

import wx

    30

import wx.lib.mixins.listctrl as listmix

    31

from zeroconf import ServiceBrowser, Zeroconf, get_all_addresses

    32

    33

service_type = '_Beremiz._tcp.local.'

    34

    35

class ZeroConfListenerClass:

    36

    def __init__(self, dialog):

    37

        self.dialog = weakref.ref(dialog)

    38

        self.ZeroConfInstance = Zeroconf()

    39

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

    40

    41

    def clean(self):

    42

        if self.Browser is not None:

    43

            self.Browser.cancel()

    44

            self.Browser = None

    45

        if  self.ZeroConfInstance is not None:

    46

            self.ZeroConfInstance.close()

    47

            self.ZeroConfInstance = None

    48

    49

    def __del__(self):

    50

        self.clean()

    51

    52

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

    53

        self.remove_service(zeroconf, _type, name)

    54

        self.add_service(zeroconf, _type, name)

    55

    56

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

    57

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

    58

        if info is None:

    59

            return

    60

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

    61

        ip = str(info.parsed_addresses()[0])

    62

        port = info.port

    63

    64

        wx.CallAfter(self._add_service, typename, ip, port, name)

    65

    66

    def _add_service(self, typename, ip, port, name):

    67

        dialog = self.dialog()

    68

        if not dialog: return

    69

        dialog._addService(typename, ip, port, name)

    70

    71

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

    72

        wx.CallAfter(self._remove_service, name)

    73

    74

    def _remove_service(self, name):

    75

        dialog = self.dialog()

    76

        if not dialog: return

    77

        dialog._removeService(name)

    78

    79

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

    80

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

    81

                 size=wx.DefaultSize, style=0):

    82

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

    83

        listmix.ListCtrlAutoWidthMixin.__init__(self)

    84

    85

    86

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

    87

    88

    def _init_coll_MainSizer_Items(self, parent):

    89

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

    90

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

    91

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

    92

    93

    def _init_coll_MainSizer_Growables(self, parent):

    94

        parent.AddGrowableCol(0)

    95

        parent.AddGrowableRow(1)

    96

    97

    def _init_coll_ButtonGridSizer_Items(self, parent):

    98

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

    99

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

   100

   101

    def _init_coll_ButtonGridSizer_Growables(self, parent):

   102

        parent.AddGrowableCol(0)

   103

        parent.AddGrowableRow(0)

   104

   105

    def _init_sizers(self):

   106

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

   107

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

   108

   109

        self._init_coll_MainSizer_Items(self.MainSizer)

   110

        self._init_coll_MainSizer_Growables(self.MainSizer)

   111

        self._init_coll_ButtonGridSizer_Items(self.ButtonGridSizer)

   112

        self._init_coll_ButtonGridSizer_Growables(self.ButtonGridSizer)

   113

   114

        self.SetSizer(self.MainSizer)

   115

   116

    def _init_list_ctrl(self):

   117

        # Set up list control

   118

        self.ServicesList = AutoWidthListCtrl(

   119

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

   120

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

   121

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

   122

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

   123

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

   124

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

   125

        self.ServicesList.SetColumnWidth(0, 150)

   126

        self.ServicesList.SetColumnWidth(1, 150)

   127

        self.ServicesList.SetColumnWidth(2, 150)

   128

        self.ServicesList.SetColumnWidth(3, 150)

   129

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

   130

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

   131

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

   132

   133

    def _init_ctrls(self, prnt):

   134

        self.staticText1 = wx.StaticText(

   135

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

   136

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

   137

   138

        self.RefreshButton = wx.Button(

   139

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

   140

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

   141

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

   142

   143

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

   144

        # self.ByIPCheck.SetValue(True)

   145

   146

        self._init_sizers()

   147

        self.Fit()

   148

   149

    def __init__(self, parent):

   150

        wx.Panel.__init__(self, parent)

   151

   152

        self.parent = parent

   153

   154

        self._init_list_ctrl()

   155

        listmix.ColumnSorterMixin.__init__(self, 4)

   156

   157

        self._init_ctrls(parent)

   158

   159

        self.itemDataMap = {}

   160

        self.nextItemId = 0

   161

   162

        self.URI = None

   163

   164

        self.RefreshList()

   165

        self.LatestSelection = None

   166

   167

        self.IfacesMonitorState = None

   168

        self.IfacesMonitorTimer = wx.Timer(self)

   169

        self.IfacesMonitorTimer.Start(2000)

   170

        self.ZeroConfListener = None

   171

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

   172

   173

    def _cleanup(self):

   174

        if self.IfacesMonitorTimer is not None:

   175

            self.IfacesMonitorTimer.Stop()

   176

            self.IfacesMonitorTimer = None

   177

        if self.ZeroConfListener is not None:

   178

            self.ZeroConfListener.clean()

   179

            self.ZeroConfListener = None

   180

   181

    def __del__(self):

   182

        self._cleanup()

   183

   184

    def Destroy(self):

   185

        self._cleanup()

   186

        wx.Panel.Destroy(self)

   187

   188

    def IfacesMonitor(self, event):

   189

        NewState = get_all_addresses()

   190

   191

        if self.IfacesMonitorState != NewState:

   192

            if self.IfacesMonitorState is not None:

   193

                # refresh only if a new address appeared

   194

                for addr in NewState:

   195

                    if addr not in self.IfacesMonitorState:

   196

                        self.RefreshList()

   197

                        break

   198

            self.IfacesMonitorState = NewState

   199

        event.Skip()

   200

   201

    def RefreshList(self):

   202

        self.ServicesList.DeleteAllItems()

   203

        self.ZeroConfListener = ZeroConfListenerClass(self)

   204

   205

    def OnRefreshButton(self, event):

   206

        self.RefreshList()

   207

   208

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

   209

    def GetListCtrl(self):

   210

        return self.ServicesList

   211

   212

    def getColumnText(self, index, col):

   213

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

   214

        return item.GetText()

   215

   216

    def OnItemSelected(self, event):

   217

        self.SetURI(event.GetIndex())

   218

        event.Skip()

   219

   220

    def OnItemActivated(self, event):

   221

        self.SetURI(event.GetIndex())

   222

        self.parent.EndModal(wx.ID_OK)

   223

        event.Skip()

   224

   225

#    def SetURI(self, idx):

   226

#        connect_type = self.getColumnText(idx, 1)

   227

#        connect_address = self.getColumnText(idx, 2)

   228

#        connect_port = self.getColumnText(idx, 3)

   229

#

   230

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

   231

   232

    def SetURI(self, idx):

   233

        self.LatestSelection = idx

   234

   235

    def GetURI(self):

   236

        if self.LatestSelection is not None:

   237

            # if self.ByIPCheck.IsChecked():

   238

            svcname, scheme, host, port = \

   239

                [self.getColumnText(self.LatestSelection, col) for col in range(4)]

   240

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

   241

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

   242

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

   243

            # else:

   244

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

   245

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

   246

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

   247

        return None

   248

   249

    def _removeService(self, name):

   250

        '''

   251

        called when a service with the desired type goes offline.

   252

        '''

   253

   254

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

   255

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

   256

            # this is the unique identifier assigned to the item

   257

            item_id = self.ServicesList.GetItemData(idx)

   258

   259

            # this is the full typename that was received by addService

   260

            item_name = self.itemDataMap[item_id][4]

   261

   262

            if item_name == name:

   263

                self.ServicesList.DeleteItem(idx)

   264

                break

   265

   266

   267

    def _addService(self, typename, ip, port, name):

   268

        '''

   269

        called when a service with the desired type is discovered.

   270

        '''

   271

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

   272

   273

        num_items = self.ServicesList.GetItemCount()

   274

   275

        # display the new data in the list

   276

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

   277

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

   278

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

   279

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

   280

   281

        # record the new data for the ColumnSorterMixin

   282

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

   283

        # are added or removed)

   284

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

   285

   286

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

   287

        # so that ColumnSorterMixin knows how to sort the column.

   288

   289

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

   290

        # can access it.

   291

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

   292

   293

        self.nextItemId += 1