C:/work/RevealedSystems/EyeSpy-RS/eyespy/src/objects/geoip/geoIPUtils.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.common.logger import logger
from objects.logic.common.exception import exception
from objects.logic.utils.timeUtil import timeUtil 
import os
from array import array
from objects.logic.common.globalStrings import globalStrings
import shutil
import time


## The geoIPUtils class is collection of various methods used to import the GEO IP
# database into the application.

class geoIPUtils():
    
    ## getIPUtils constructor
    def __init__(self, path):
        self.path = path
        logger.log(__name__ + ": Setting GEO IP Database Path: " + self.path)
    
    ## Retrieves the last time the the GEO IP database was installed.
    # This method works by extracting a time stamp from a small text file (located in the same folder as the database).
    # This file is created each time a new database is imported into the application.   
    def getLastUpdateTime(self):
        infoFile = None
                
        try:
            infoFile = open(globalStrings.geoIPInfoPath(),"r")
            infoString = infoFile.read(512);
            return infoString
        
        except Exception, e:
            logger.log(__name__ + ": There was an error opening GEO IP info file: " + str(e))
            logger.log(__name__ + ": Could not determine when the last time the GEO IP Database was updated")
            return "";
        
        finally:
            if infoFile != None:
                infoFile.close()
                
                
    ## Returns True if any database is installed. The method simply checks to see
    # whether the database file exists at the expected location
    # @return Boolean.           
    def isGEOIPDatabaseInstalled(self):
        return os.path.exists( globalStrings.geoIPLocPath() )
    
    ## Copies a new database file to EyeSpy's GEO IP Database folder.
    # Typically this is set to: objects/logic/entity/res/geoIP/   
    #@param path Source path of the database (full path + file name) 
    def updateGEOIPDatabase(self, path):       
        try: 
            infoFile = None            
            
            #make sure these folders exist, don't complain if the mkdir fails
            try:
                os.mkdir(globalStrings.geoIPResPath)
                os.mkdir(globalStrings.geoIPPath)
            except Exception, ex:
                logger.log(__name__ + "GEO IP Database folder already exists. This is not necessarily an error.")
            
            
            shutil.copyfile(path, globalStrings.tempIPLocPath())
            
            # now create file containing the time stamp of the last update.            
            infoFile = open(globalStrings.tempIPInfoPath(),"w")
            
            infoFile.write(timeUtil.formatDateTime(time.time()));
        
        except Exception, ex:
                strErr = "There was an error updating database files: %s" % str(ex)                
                logger.log(__name__ + ": " + strErr)
                
                raise Exception, strErr
        finally:
            if infoFile != None:
                infoFile.close()
                
    ## Checks EyeSpy's GEO IP Database folder to see which database files need to updated.
    # Note that calling updateGEOIPDatabase does not update the database file directly, since the
    # the database file may be locked. This method should be called when the application
    # is starting up, before the database is initialized.         
    def installGeoIPIfNecessary():
        if os.path.isfile(globalStrings.tempIPInfoPath()):            
            try:                                
                shutil.copyfile(globalStrings.tempIPInfoPath(), globalStrings.geoIPInfoPath())
                shutil.copyfile(globalStrings.tempIPLocPath(), globalStrings.geoIPLocPath())                                                
                
                os.remove(globalStrings.tempIPInfoPath())            
                os.remove(globalStrings.tempIPLocPath())                                                            
            except Exception, ex:
                strErr = "There was an error updating database files: %s" % str(ex)                
                logger.log(__name__ + ": " + strErr)
                
                raise Exception, strErr
            
            # the next are optional, so do not raise an exception back to the user
            try:
                shutil.copyfile(globalStrings.tempIPIspInfoPath(), globalStrings.geoIPIspPath())
                shutil.copyfile(globalStrings.tempIPOrgInfoPath(), globalStrings.geoIPOrgPath())
                
                os.remove(globalStrings.tempIPIspInfoPath())
                os.remove(globalStrings.tempIPOrgInfoPath())
                
            except Exception, ex:                
                
                strErr = "There was an error updating optional database files: %s" % str(ex)                
                logger.log(__name__ + ": " + strErr)
            
            
    installGeoIPIfNecessary = staticmethod(installGeoIPIfNecessary)
        
        
        
        

---