C:/work/RevealedSystems/EyeSpy-RS/eyespy/src/objects/logic/entity/filter/customFilter.py

Go to the documentation of this file.

# 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/>.


from objects.logic.entity.filter.baseFilter import baseFilter
from objects.logic.entity.filter.filterDictionary import filterDictionary
from threading import RLock
import copy

## The Custom filter inherits from the baseFilter object.
# In addition to basic filtering capabilities, this class will contain a Dictionary
# of of very specific filtering criteria.
# For Example Filter if: IP == XYZ, ProcessName == xxx.exe, Country==USA, etc.
class customFilter(baseFilter):
    def __init__(self):
        baseFilter.__init__(self)
        
        self.customfilterList = []
        self.filterDict = filterDictionary()
        
        self.lck = RLock()
    
    ## returns True if the supplied networkEntity should be displayed or not.
    # After calling its base class method, it will check against its Filter Dictionary
    # for additional criteria.
    # @param networkEntity networkEntity Object
    def shouldDisplayEntity(self, networkEntity):
        if baseFilter.shouldDisplayEntity(self, networkEntity) == False:
            return False
        else:
            # now deal with local filters
            self.lck.acquire(1)
            try:
                if len(self.customfilterList) == 0: return True
                
                for filterCat, filterVal in self.customfilterList:
                    attr, type = self.filterDict.filter[filterCat]
                    if networkEntity[attr] == filterVal:
                        return False
            finally:
                self.lck.release()
                
            return True 
    
    
    ## Returns a copy of the filtering Dictionary
    # @return Dictionary 
    def getSafeFilterList(self):
        copyList = []
        
        self.lck.acquire(1)
        try:            
            copyList = copy.deepcopy(self.customfilterList)
        finally:
            self.lck.release()
            
        return copyList
    
    
    
    
    ## Add a new Tuple to the filter
    # @param filterTuple Tuple (networkedEntity attributeName-->Value) 
    def addToFilter(self, filterTuple):        
        self.lck.acquire(1)
        try:            
            self.customfilterList.append(filterTuple)
        finally:
            self.lck.release()
    
    
    
    ## Removed a Filter Tuple from the Dictionary
    # @param filterTuple Tuple (networkedEntity attributeName-->Value)
    def removeFromFilter(self, filterTuple):
        self.lck.acquire(1)
        try:            
            self.customfilterList.remove(filterTuple)
        finally:
            self.lck.release()

---