C:/work/RevealedSystems/EyeSpy-RS/eyespy/src/objects/gui/peerGridDisplay.py

Go to the documentation of this file.

#Boa:Frame:peerGridDisplay

# Copyright (C) 2008-2009  Mark Hanegraaff
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

import wx
import wx.lib.mixins.listctrl
from wx.lib.anchors import LayoutAnchors
from objects.logic.common.globalStrings import globalStrings
import sys
import time
from traceDisplayDialog import traceDisplayDialog
from objects.logic.common.logger import logger
from objects.logic.utils.timeUtil import timeUtil


## This class is simply a wrapper for a networked entity object
# which binds its attributes with actual columns on the Peer ListCtrl object
# in the peerGridDisplayer class.
# This class is just a helper used used to facilitate sorting.
class entityColumnSorter():
    def __init__(self, netEnt):
        self.netEnt = netEnt
        
        self.since     = timeUtil.formatDateTime(netEnt.since)
        self.idleTime  = timeUtil.formatTimeDiff(time.time() - self.netEnt.lastUpdateTS)
    
        self.colDefinition = dict()
        self.colDefinition[0]     = [self.netEnt.foreignIPAddress, "S"]        
        self.colDefinition[1]     = [self.netEnt.foreignPort, "D"]
        self.colDefinition[2]     = [self.netEnt.selfPort, "D"]        
        self.colDefinition[3]     = [self.netEnt.processName, "S"]        
        self.colDefinition[4]     = [self.netEnt.Pid, "S"]                
        self.colDefinition[5]     = [self.since, "S"] # Since
        self.colDefinition[6]     = [float(self.netEnt.totalBytes) / float(1000), "F"]
        self.colDefinition[7]     = [self.netEnt.foreignCity, "U"]
        self.colDefinition[8]     = [self.netEnt.foreignStateProv, "S"]
        self.colDefinition[9]     = [self.netEnt.foreignCountry, "S"]        
        self.colDefinition[10]    = [self.netEnt.foreignOrganization, "S"]        
        self.colDefinition[11]    = [self.netEnt.foreignISP, "S"]                
        self.colDefinition[12]    = [self.netEnt.foreignLongitude, "F"]
        self.colDefinition[13]    = [self.netEnt.foreignLatitude, "F"]                                
        self.colDefinition[14]    = [self.idleTime, "S"]        
 
    
    def __getitem__(self, key):
        
        attr, type = self.colDefinition[key]
        
        if type == "S":
            return str(attr)
        elif type == "F":
            return float(attr)
        elif type == "U":
            return unicode(attr)
        else:
            return int(attr)


def create(parent):
    return peerGridDisplay(parent)

[wxID_PEERGRIDDISPLAY, wxID_PEERGRIDDISPLAYBUTTONEXPORTLIST, 
 wxID_PEERGRIDDISPLAYBUTTONSHOWTRACE, wxID_PEERGRIDDISPLAYLISTCTRLPEERS, 
 wxID_PEERGRIDDISPLAYPANELCONTROLS, 
] = [wx.NewId() for _init_ctrls in range(5)]


## Code generated by "Boa Constructor". This class should be edited using
# the Boa Constructor IDE. Minimal inline documentation will be provided for this class
# as it may interfere with the automatic code generation.
#
# The peerGridDisplay class represents the applications's 'Peer List' window
class peerGridDisplay(wx.Frame, wx.lib.mixins.listctrl.ColumnSorterMixin):
    def _init_coll_flexGridSizerControls_Growables(self, parent):
        # generated method, don't edit

        parent.AddGrowableRow(0)
        parent.AddGrowableCol(0)

    def _init_coll_flexGridSizerButtons_Items(self, parent):
        # generated method, don't edit

        parent.AddWindow(self.buttonShowTrace, 0, border=5,
              flag=wx.TOP | wx.LEFT | wx.BOTTOM | wx.RIGHT)
        parent.AddWindow(self.buttonExportList, 0, border=5,
              flag=wx.TOP | wx.LEFT | wx.BOTTOM | wx.RIGHT)

    def _init_coll_flexGridSizerControls_Items(self, parent):
        # generated method, don't edit

        parent.AddWindow(self.listCtrlPeers, 0, border=5,
              flag=wx.BOTTOM | wx.TOP | wx.RIGHT | wx.LEFT | wx.GROW | wx.ADJUST_MINSIZE | wx.EXPAND)
        parent.AddSizer(self.flexGridSizerButtons, 0, border=10,
              flag=wx.ALIGN_RIGHT)

    def _init_coll_listCtrlPeers_Columns(self, parent):
        # generated method, don't edit

        parent.InsertColumn(col=0, format=wx.LIST_FORMAT_LEFT,
              heading='Remote IP', width=140)
        parent.InsertColumn(col=1, format=wx.LIST_FORMAT_RIGHT,
              heading='Rmt. Port', width=80)
        parent.InsertColumn(col=2, format=wx.LIST_FORMAT_RIGHT,
              heading='Lc. Port', width=70)
        parent.InsertColumn(col=3, format=wx.LIST_FORMAT_LEFT,
              heading='Application', width=100)
        parent.InsertColumn(col=4, format=wx.LIST_FORMAT_RIGHT, heading='PID',
              width=70)
        parent.InsertColumn(col=5, format=wx.LIST_FORMAT_RIGHT, heading='Since',
              width=140)
        parent.InsertColumn(col=6, format=wx.LIST_FORMAT_RIGHT,
              heading='Kb Xfer', width=-1)
        parent.InsertColumn(col=7, format=wx.LIST_FORMAT_LEFT, heading='City',
              width=100)
        parent.InsertColumn(col=8, format=wx.LIST_FORMAT_LEFT,
              heading='State/Prov', width=20)
        parent.InsertColumn(col=9, format=wx.LIST_FORMAT_LEFT,
              heading='Country', width=120)
        parent.InsertColumn(col=10, format=wx.LIST_FORMAT_LEFT,
              heading='Organization', width=20)
        parent.InsertColumn(col=11, format=wx.LIST_FORMAT_LEFT, heading='ISP',
              width=20)
        parent.InsertColumn(col=12, format=wx.LIST_FORMAT_RIGHT, heading='Lon',
              width=-1)
        parent.InsertColumn(col=13, format=wx.LIST_FORMAT_RIGHT, heading='Lat',
              width=-1)
        parent.InsertColumn(col=14, format=wx.LIST_FORMAT_RIGHT,
              heading='Idle Time', width=120)

    def _init_sizers(self):
        # generated method, don't edit
        self.flexGridSizerControls = wx.FlexGridSizer(cols=1, hgap=5, rows=2,
              vgap=5)
        self.flexGridSizerControls.SetNonFlexibleGrowMode(wx.FLEX_GROWMODE_SPECIFIED)
        self.flexGridSizerControls.SetFlexibleDirection(wx.BOTH)

        self.flexGridSizerButtons = wx.FlexGridSizer(cols=3, hgap=10, rows=1,
              vgap=10)
        self.flexGridSizerButtons.SetFlexibleDirection(wx.BOTH)

        self._init_coll_flexGridSizerControls_Items(self.flexGridSizerControls)
        self._init_coll_flexGridSizerControls_Growables(self.flexGridSizerControls)
        self._init_coll_flexGridSizerButtons_Items(self.flexGridSizerButtons)

        self.panelControls.SetSizer(self.flexGridSizerControls)

    def _init_ctrls(self, prnt):
        # generated method, don't edit
        wx.Frame.__init__(self, id=wxID_PEERGRIDDISPLAY, name='peerGridDisplay',
              parent=prnt, pos=wx.Point(472, 260), size=wx.Size(663, 397),
              style=wx.DEFAULT_FRAME_STYLE, title='Peer List ...')
        self.SetClientSize(wx.Size(647, 361))
        self.SetMinSize(wx.Size(597, 218))
        self.SetMaxSize(wx.Size(-1, -1))
        self.SetHelpText('')
        self.SetIcon(wx.Icon(u'./res/images/ico/eyespy_small.ico',
              wx.BITMAP_TYPE_ICO))

        self.panelControls = wx.Panel(id=wxID_PEERGRIDDISPLAYPANELCONTROLS,
              name='panelControls', parent=self, pos=wx.Point(0, 0),
              size=wx.Size(647, 361), style=wx.TAB_TRAVERSAL)
        self.panelControls.SetAutoLayout(True)
        self.panelControls.SetConstraints(LayoutAnchors(self.panelControls,
              True, True, True, True))
        self.panelControls.SetToolTipString('')

        self.listCtrlPeers = wx.ListCtrl(id=wxID_PEERGRIDDISPLAYLISTCTRLPEERS,
              name='listCtrlPeers', parent=self.panelControls, pos=wx.Point(5,
              5), size=wx.Size(637, 313), style=wx.LC_REPORT)
        self.listCtrlPeers.SetAutoLayout(True)
        self.listCtrlPeers.SetMinSize(wx.Size(-1, -1))
        self.listCtrlPeers.SetBackgroundColour(wx.Colour(0, 0, 0))
        self.listCtrlPeers.SetForegroundColour(wx.Colour(192, 192, 192))
        self.listCtrlPeers.SetFont(wx.Font(10, wx.SWISS, wx.NORMAL, wx.NORMAL,
              False, 'Verdana'))
        self._init_coll_listCtrlPeers_Columns(self.listCtrlPeers)
        self.listCtrlPeers.Bind(wx.EVT_LIST_ITEM_DESELECTED,
              self.OnListCtrlPeersListItemDeselected,
              id=wxID_PEERGRIDDISPLAYLISTCTRLPEERS)
        self.listCtrlPeers.Bind(wx.EVT_LIST_ITEM_SELECTED,
              self.OnListCtrlPeersListItemSelected,
              id=wxID_PEERGRIDDISPLAYLISTCTRLPEERS)
        self.listCtrlPeers.Bind(wx.EVT_LIST_COL_CLICK,
              self.OnListCtrlPeersListColClick,
              id=wxID_PEERGRIDDISPLAYLISTCTRLPEERS)

        self.buttonShowTrace = wx.Button(id=wxID_PEERGRIDDISPLAYBUTTONSHOWTRACE,
              label='Show Trace', name='buttonShowTrace',
              parent=self.panelControls, pos=wx.Point(408, 333),
              size=wx.Size(96, 23), style=0)
        self.buttonShowTrace.SetToolTipString('')
        self.buttonShowTrace.Bind(wx.EVT_BUTTON, self.OnButtonShowTraceButton,
              id=wxID_PEERGRIDDISPLAYBUTTONSHOWTRACE)

        self.buttonExportList = wx.Button(id=wxID_PEERGRIDDISPLAYBUTTONEXPORTLIST,
              label='Export to File', name='buttonExportList',
              parent=self.panelControls, pos=wx.Point(524, 333),
              size=wx.Size(118, 23), style=0)
        self.buttonExportList.SetToolTipString('')
        self.buttonExportList.Bind(wx.EVT_BUTTON, self.OnButtonExportListButton,
              id=wxID_PEERGRIDDISPLAYBUTTONEXPORTLIST)

        self._init_sizers()

    def __init__(self, parent):
        self._init_ctrls(parent)
        
        il = wx.ImageList(16,16, True)
        self.up = il.AddWithColourMask(
            wx.Bitmap(globalStrings.sort_up, wx.BITMAP_TYPE_BMP), "blue")
        self.dn = il.AddWithColourMask(
            wx.Bitmap(globalStrings.sort_down, wx.BITMAP_TYPE_BMP), "blue")
        
        # assign the image list to it
        self.listCtrlPeers.AssignImageList(il, wx.IMAGE_LIST_SMALL)
        
        wx.lib.mixins.listctrl.ColumnSorterMixin.__init__(self,15)
        
        self.selectedPeer = None
        self.peerList = []
        
    def GetListCtrl(self):
        return self.listCtrlPeers

    def GetSortImages(self):
        return (self.dn, self.up)
        

    ## Builds the Peer List using a List of networkEntity Objects
    # @param entList List of networkEntity Objects.
    def fromEntList(self, entList):
        if entList == None: return
        
        self.itemDataMap = {}
        
        for ent in entList:                        
            self.addEntityToList(ent)
            self.peerList.append(ent)            
    
    
    ## Builds the Peer List using a Dictionary of Coordinate Tuples to List of networnEntity objects
    # @param entDict Dictionary ([lon, lat) : List(networkEntiry)]  
    def fromEntGeoLocDict(self, entDict):
        if entDict == None: return
        
        self.PeerDict = entDict
    
        self.itemDataMap = {}
    
        for key, entList in entDict.iteritems():
            for ent in entList:                        
                self.addEntityToList(ent)
                self.peerList.append(ent)
    
    
    ## Builds the Peer List using a Dictionary of Coordinate Tuples to List of networnEntity objects
    # @param entDict Dictionary ([lon, lat) : List(networkEntiry)] 
    def fromEntDict(self, entDict):
        if entDict == None: return
        
        self.PeerDict = entDict
        
        self.itemDataMap = {}
        
        for key, ent in entDict.iteritems():                        
            self.addEntityToList(ent)
            self.peerList.append(ent)

    ## Returns the Foreign IP Address (as in what IP its connected to) of the supplied networkEntity
    # @param ent networkedEntity object
    def getForeignIP(self, ent):
        return ent.foreignIPAddress
    
    
    
    ## Returns the Process Name communicating with the supplied networkEntity
    # @param ent networkedEntity object
    def getProcName(self, ent):
        return str(ent.processName)
    
    
    
    ## Returns the Pid communicating with the supplied networkEntity
    # @param ent networkedEntity object
    def getPid(self, ent):
        return ent.Pid
    
    
    
    ## Returns the ISP of the supplied networkEntity
    # @param ent networkedEntity object
    def getISP(self, ent):
        return ent.foreignISP
    
    
    ## Returns the Organization Name of the supplied networkEntity
    # @param ent networkedEntity object
    def getOrg(self, ent):
        return ent.foreignOrganization
    
    
    ## Helper Function used to add a networkedEntity to the Peer List control.
    # @param ent networkedEntity object
    def addEntityToList(self, ent):
        
        since     = timeUtil.formatDateTime(ent.since)
        idleTime  = timeUtil.formatTimeDiff(time.time() - int(ent.lastUpdateTS))
        
    
    
        index = self.listCtrlPeers.InsertStringItem(sys.maxint, self.getForeignIP(ent))        
        self.listCtrlPeers.SetStringItem(index, 1, str(ent.foreignPort))
        self.listCtrlPeers.SetStringItem(index, 2, str(ent.selfPort))
        self.listCtrlPeers.SetStringItem(index, 3, self.getProcName(ent))
        self.listCtrlPeers.SetStringItem(index, 4, self.getPid(ent))
        self.listCtrlPeers.SetStringItem(index, 5, since)
        
        totalKB = "%6.2f" % (float(ent.totalBytes) / float(1000))
        self.listCtrlPeers.SetStringItem(index, 6, totalKB)
        
        try:
            self.listCtrlPeers.SetStringItem(index, 7, ent.foreignCity)
        except Exception, e:
            self.listCtrlPeers.SetStringItem(index, 7, "N/A")
            
        self.listCtrlPeers.SetStringItem(index, 8, str(ent.foreignStateProv))
        self.listCtrlPeers.SetStringItem(index, 9, str(ent.foreignCountry))            
        self.listCtrlPeers.SetStringItem(index, 10, self.getOrg(ent))
        self.listCtrlPeers.SetStringItem(index, 11, self.getISP(ent))
        
        lon = "%3.2f" % (ent.foreignLongitude)
        lat = "%3.2f" % (ent.foreignLatitude)
         
        self.listCtrlPeers.SetStringItem(index, 12, lon)
        self.listCtrlPeers.SetStringItem(index, 13, lat)
        
        self.listCtrlPeers.SetStringItem(index, 14, idleTime)                    
        
        self.listCtrlPeers.SetItemData(index, index)
        wrappedEnt = entityColumnSorter(ent)
        
        self.itemDataMap[index] = wrappedEnt



    ## "Show Trace" Button Handler
    # @param event Standard wx.Button event
    def OnButtonShowTraceButton(self, event):
        
        if self.selectedPeer == None:
            return
        
        #get the PK from the currently selected item
        try:

            foreignIP = self.listCtrlPeers.GetItemText(self.selectedPeer)
            srcPort   = self.getColumnText(self.selectedPeer, 2)
            dstPort   = self.getColumnText(self.selectedPeer, 1)
                
            traceDisplay = None
            traceDisplay = traceDisplayDialog(self, foreignIP, srcPort, dstPort)
            traceDisplay.ShowModal()
            
        except Exception, e:
                errMsg = "There was an error opening Trace Display window.\nDetailed Error:\n%s " % (str(e))
                
                dlg = wx.MessageDialog(None, errMsg, 'Error', wx.ICON_ERROR)
                result = dlg.ShowModal()
                dlg.Destroy()
        finally:
            if traceDisplay is not None:
                traceDisplay.Destroy()
    
    
    
    ## Retrieves the string value of a column/index location in the Peer List.
    # @param index Index number of the list
    # @param col column number
    # @return String
    def getColumnText(self, index, col):
        item = self.listCtrlPeers.GetItem(index, col)
        return item.GetText()
    
    
    ## "Reconstruct TCP Conversation" Button Handler (Not Implemented)
    # @param event Standard wx.Button event
    def OnButtonReconstructButton(self, event):
        pass




    ## "Select Peer List Item" Handler.
    # @param event Standard event
    def OnListCtrlPeersListItemSelected(self, event):
        item = event.GetItem()
        self.selectedPeer = item.GetId()


    ## "Deselect Peer List Item" Handler.
    # @param event Standard event
    def OnListCtrlPeersListItemDeselected(self, event):
        self.selectedPeer = None
        
        
    ## "Click on Peer List Column" Handler (not implemented).
    # @param event Standard event
    def OnListCtrlPeersListColClick(self, event):
        pass


    ## Called when the sort direction has changed
    def OnSortOrderChanged(self):
        print "sorted"
        self.selectedPeer = self.listCtrlPeers.GetFirstSelected()
        
        
    ## "Export to File" Button Handler (Not Implemented)
    # @param event Standard wx.Button event
    def OnButtonExportListButton(self, event):
        dlg = wx.FileDialog(self, "Export to file", "\\", "PeerList.csv", "Comma Separated Values (*.csv)|*.csv", style=wx.SAVE|wx.OVERWRITE_PROMPT)
        
        if dlg.ShowModal() == wx.ID_OK:
            path = dlg.GetPath()
            FILE = open(path,"w")
            FILE.write("RemoteIP,RemotePort,LocalPort,Application,PID,Since,KbXfer,City,State/Prov,Country,Organization,ISP,Lon,Lat,IdleTime\n")
            
            for ent in self.peerList:
                totalKB = "%6.2f" % (float(ent.totalBytes) / float(1000))
                idleTime  = timeUtil.formatTimeDiff(time.time() - int(ent.lastUpdateTS))
                
                since     = timeUtil.formatDateTime(ent.since)
                
    
                
                try:
                    nextLine = "%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%3.2f,%3.2f,%s" %(ent.foreignIPAddress.replace(',', ' '),                                                                                      
                                                                                      str(ent.foreignPort).replace(',', ' '),
                                                                                      str(ent.selfPort).replace(',', ' '),
                                                                                      ent.processName.replace(',', ' '),
                                                                                      str(ent.Pid).replace(',', ' '),
                                                                                      since.replace(',', ' '),
                                                                                      totalKB.replace(',', ' '),
                                                                                      ent.foreignCity.replace(',', ' '),
                                                                                      ent.foreignStateProv.replace(',', ' '),
                                                                                      ent.foreignCountry.replace(',', ' '),
                                                                                      ent.foreignOrganization.replace(',', ' '),
                                                                                      ent.foreignISP.replace(',', ' '),
                                                                                      ent.foreignLongitude,
                                                                                      ent.foreignLatitude,
                                                                                      idleTime.replace(',', ' '))
                    nextLine = nextLine.encode('utf-8')
                except Exception, ex:
                    logger.log(__name__ + ": Exception Writing Entity List line to file: " + str(ex))
                else:                
                    FILE.write(nextLine + "\n")
            
            FILE.close()
            
        

---