root/MGET/Trunk/PythonPackage/src/GeoEco/ReportInstallation.py

# ReportInstallation.py - reports an MGET installation to the MGET statistics server
#
# This program is only intended to be invoked by the GeoEco setup
# program. The setup program uses it to report a successful or failed
# installation to the server that tracks installation statistics.
# Please do not invoke this program yourself. Doing so will corrupt
# the statistics. We use these statistics to assess the software
# quality of the setup program, identify common installation problems
# encountered by MGET users, and justify our requests for additional
# funding.
# 
# For more information about this program, including a discussion of
# what data are reported, what we do with the data, and how to disable
# the reporting, please see the MGET web site. Alternatively, just
# look at the code below. If you have any questions, please contact
# Jason Roberts (jason.roberts@duke.edu).
#
# Copyright (C) 2009 Jason J. Roberts
#
# 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 2
# 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 (available in the file LICENSE.TXT)
# for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

import ConfigParser
import os
import re
import socket
import sys
import tempfile
import time
import traceback
import urllib
import xmlrpclib

import pywintypes
import win32api
import win32con

def main():

    # Validate that we have been invoked from the command line.

    if sys.argv[0] != __file__:
        raise RuntimeError('This function is only intended to be invoked by the GeoEco setup program. The setup program uses it to report a successful or failed installation to the server that tracks installation statistics. Please do not invoke this function yourself. Doing so will corrupt our statistics. Thank you.')

    # Open a log file in the user's temp directory.

    logFileHandle, logFilePath = tempfile.mkstemp('.txt', 'GeoEcoSetupFailure_')
    logFile = os.fdopen(logFileHandle, 'wb')
    try:
        try:
            logFile.write('Installation completed at %s GMT.\n' % time.asctime(time.gmtime(time.time())))
            
            # Parse and validate the command line arguments.

            logFile.write('Parsing command line arguments.\n')
            
            try:
                if len(sys.argv) != 4:
                    raise RuntimeError('Invalid number of arguments.')

                if sys.argv[1] not in ['False', 'True']:
                    raise RuntimeError('Invalid arguments.')
                shortcuts = sys.argv[1] == 'True'
                logFile.write('shortcuts = %s\n' % str(shortcuts))

                if sys.argv[2] not in ['False', 'True']:
                    raise RuntimeError('Invalid arguments.')
                arcToolbox = sys.argv[2] == 'True'
                logFile.write('arcToolbox = %s\n' % str(arcToolbox))

                if sys.argv[3] not in ['False', 'True']:
                    raise RuntimeError('Invalid arguments.')
                comClasses = sys.argv[3] == 'True'
                logFile.write('comClasses = %s\n' % str(comClasses))
                
            except Exception, e:
                sys.stderr.write('%s: %s\n' % (str(e.__class__.__name__), str(e)))
                print('')
                print('ReportInstallation.py - reports an MGET installation to the MGET statistics server')
                print('')
                print('This program is only intended to be invoked by the GeoEco setup program. The')
                print('setup program uses it to report a successful or failed installation to the')
                print('server that tracks installation statistics. Please do not invoke this program')
                print('yourself. Doing so will corrupt the statistics. We use these statistics to')
                print('assess the software quality of the setup program, identify common installation')
                print('problems encountered by MGET users, and justify our requests for additional')
                print('funding.')
                print('')
                print('For more information about this program, including a discussion of what data are')
                print('reported, what we do with the data, and how to disable the reporting, please see')
                print('the MGET web site. You are also welcome to examine the program source code. If')
                print('you have any questions, please contact Jason Roberts (jason.roberts@duke.edu).')
                print('')
                print('Thanks for your support,')
                print('')
                print('    - The MGET Development Team')
                sys.exit(1)

            # Look up the ID of this client MGET's registry key. If no client
            # ID is there, generate one randomly. The client ID is a random
            # 128-bit number (a GUID) that is guaranteed by the operating
            # system to be unique globally.

            logFile.write('Creating/opening registry key HLKM\\SOFTWARE\\GeoEco.\n')
            hKey = win32api.RegCreateKey(win32con.HKEY_LOCAL_MACHINE, 'SOFTWARE\\GeoEco')
            try:
                # First see if there is a value called
                # DisableInstallationReporting. If so, it means the user
                # requested that no installation report be sent to the server
                # and we must exit immediately.

                try:
                    logFile.write('Querying for the DisableInstallationReporting value.\n')
                    win32api.RegQueryValueEx(hKey, 'DisableInstallationReporting')
                except:
                    logFile.write('The DisableInstallationReporting value could not be queried. Installation reporting is not disabled.\n')
                else:
                    logFile.write('The DisableInstallationReporting was successfully queried. Installation reporting is disabled. Exiting without sending a report.\n')
                    print('Installation reporting has been disabled. Exiting without sending a report.')
                    return

                # Now try to read the ClientID value.

                clientID = None
                
                try:
                    logFile.write('Querying for the ClientID value.\n')
                    clientID = win32api.RegQueryValueEx(hKey, 'ClientID')[0]
                except:
                    logFile.write('Failed to query the ClientID value.\n')

                # If we failed to read a ClientID value or we got one that is
                # an invalid format, generate a new one.

                if not isinstance(clientID, basestring) or re.match('\{[0123456789AaBbCcDdEeFf]{8}-[0123456789AaBbCcDdEeFf]{4}-[0123456789AaBbCcDdEeFf]{4}-[0123456789AaBbCcDdEeFf]{4}-[0123456789AaBbCcDdEeFf]{12}\}', clientID) is None:
                    clientID = str(pywintypes.CreateGuid())
                    logFile.write('Writing ClientID value "%s".\n' % clientID)
                    win32api.RegSetValueEx(hKey, 'ClientID', 0, win32con.REG_SZ, clientID)
                else:
                    clientID = clientID.upper()
                    logFile.write('clientID = %s.\n' % clientID)
                
            finally:
                logFile.write('Closing the registry key.\n')
                win32api.RegCloseKey(hKey)

            # Get the MGET version number. This should always succeed, because
            # we are only invoked from the MGET post-installation script,
            # which distutils should only invoke if it was able to copy the
            # Python files onto the machine and compile them.

            mgetVer = None
            try:
                logFile.write('Importing GeoEco.\n')
                import GeoEco
                mgetVer = GeoEco.__version__
            except Exception, e:
                logFile.write('Failed to import GeoEco: %s: %s\n' % (str(e.__class__.__name__), str(e)))
            else:
                logFile.write('mgetVer = %s\n' % mgetVer)

            # Get the ArcGIS version number from the registry. This will fail
            # if ArcGIS is not installed, in which case we send None to the
            # server.

            arcVer = None
            try:
                logFile.write('Opening registry key HLKM\\SOFTWARE\\ESRI\\ArcInfo\\Desktop\\8.0.\n')
                hkey = win32api.RegOpenKey(win32con.HKEY_LOCAL_MACHINE, 'SOFTWARE\\ESRI\\ArcInfo\\Desktop\\8.0')
                try:
                    logFile.write('Querying for the RealVersion value.\n')
                    realVersion = win32api.RegQueryValueEx(hkey, 'RealVersion')[0].strip()
                    try:
                        logFile.write('Querying for the SPNumber value.\n')
                        spNumber = win32api.RegQueryValueEx(hkey, 'SPNumber')[0].strip()
                    except:
                        spNumber = None
                finally:
                    logFile.write('Closing the registry key.\n')
                    win32api.RegCloseKey(hkey)

                if spNumber is None or spNumber == '0':
                    arcVer = realVersion
                elif realVersion == '9.3' and spNumber == '2':
                    arcVer = '9.3.1'
                elif realVersion == '9.3' and spNumber > '2':
                    arcVer = '9.3.1 SP%i' % (int(spNumber) - 2)
                else:
                    arcVer = '%s SP%s' % (realVersion, spNumber)

            except Exception, e:
                logFile.write('Failed to get ArcGIS version number: %s: %s\n' % (str(e.__class__.__name__), str(e)))
            else:
                logFile.write('arcVer = %s\n' % arcVer)

            # Get the R version using logic that imitates what rpy's
            # get_R_VERSION function does. (I originally tried to use that
            # function but it would not work if the registry key did not exist
            # and it tried to run R.exe instead.)

            rVer = None
            try:
                # First try to read the "Current Version" value of the
                # HKLM\SOFTWARE\R-core\R registry key.
                
                try:
                    logFile.write('Opening registry key HLKM\\SOFTWARE\\R-core\\R.\n')
                    hkey = win32api.RegOpenKey(win32con.HKEY_LOCAL_MACHINE, 'SOFTWARE\\R-core\\R')
                    try:
                        logFile.write('Querying for the Current Version value.\n')
                        rVer = win32api.RegQueryValueEx(hkey, 'Current Version')[0]
                    finally:
                        logFile.write('Closing the registry key.\n')
                        win32api.RegCloseKey(hkey)

                # If that did not work, try to parse the R version from the
                # R_HOME environment variable.
                
                except:
                    logFile.write('Failed. Trying the R_HOME environment variable instead.\n')
                    if os.environ.has_key('R_HOME'):
                        rHome = os.environ['R_HOME']
                        if re.match('^[Rr]-\d+\.\d+\.\d+$', os.path.basename(rHome)):
                            rVer = os.path.basename(rHome)[2:]

                        # If that did not work, look for a file called
                        # README.R-X.Y.Z in the R_HOME directory, where X.Y.Z
                        # is the version number.
                        
                        else:
                            import glob
                            files = glob.glob(os.path.join(rHome, 'README.R-[0123456789].*.*'))
                            if len(files) > 0 and re.match('^\d+\.\d+\.\d+$', os.path.basename(files[0])[9:]) is not None:
                                rVer = os.path.basename(files[0])[9:]

            except Exception, e:
                logFile.write('Failed to get R version number: %s: %s\n' % (str(e.__class__.__name__), str(e)))
            else:
                logFile.write('rVer = %s\n' % rVer)

            # Download the ClientConfiguration.ini file from the well-known
            # location and look up the URL to the XML-RPC web service that
            # will accept the installation report.
            #
            # In order to prevent this script from hanging if the Duke
            # servers are not working, we set the default socket timeout
            # to 60 seconds. (With Python, there is no way to set it on a
            # per-connection basis, at least using urllib and xmlrpclib.)
            # But Python 2.4 contains a bug that causes this to break SSL
            # support (see http://bugs.python.org/issue1153016). So, on
            # 2.4, convert https URLs to http URLs.

            logFile.write('Setting the socket default timeout to 60.\n')

            socket.setdefaulttimeout(60)

            if sys.version_info[0] == 2 and sys.version_info[1] == 4:
                clientINIURL = 'http://code.env.duke.edu/projects/mget/statistics/client.ini'
            else:
                clientINIURL = 'https://code.env.duke.edu/projects/mget/statistics/client.ini'

            logFile.write('clientINIURL = %s\n' % clientINIURL)

            try:
                iniFileError = 'Step 1: '
                config = ConfigParser.ConfigParser()
                logFile.write('Opening the clientINIURL.\n')
                iniFileError = 'Step 2: '
                f = urllib.urlopen(clientINIURL)
                try:
                    logFile.write('Parsing the INI file.\n')
                    iniFileError = 'Step 3: '
                    config.readfp(f)
                finally:
                    iniFileError = 'Step 4: '
                    f.close()
                logFile.write('Getting the URL from the parsed INI file.\n')
                iniFileError = 'Step 5: '
                serverURL = config.get('V1', 'URL')
            except Exception, e:
                logFile.write('Failed to get the MGET server URL: %s: %s. The default URL will be used.\n' % (str(e.__class__.__name__), str(e)))
                serverURL = 'http://mgetstats.nicholas.duke.edu:8001'
                iniFileError = '%s%s: %s' % (iniFileError, str(e.__class__.__name__), str(e))
            else:
                iniFileError = None

            logFile.write('serverURL = %s\n' % serverURL)

            if sys.version_info[0] == 2 and sys.version_info[1] == 4 and serverURL.startswith('https:'):
                logFile.write('Changing serverURL to http from https because we\'re running on Python 2.4.\n')
                serverURL = 'http:' + serverURL[6:]

            # Send the report to the server by calling its XML-RPC web
            # service.

            logFile.write('Instantiating the xmlrpclib.Server object.\n')
            s = xmlrpclib.Server(serverURL, allow_none=True)
            
            logFile.write('Calling ReportMGETInstallationV2 on the server.\n')
            s.ReportMGETInstallationV2(clientID, shortcuts, arcToolbox, comClasses, mgetVer, '.'.join(map(str, sys.version_info[0:3])), arcVer, rVer, iniFileError)

        # If we got any kind of exception, write it to the log file.

        except:
            try:
                logFile.write('Caught an exception:\n')
                logFile.write('\n')
                logFile.write(traceback.format_exc())
            except:
                pass
            raise

    # Close the log file.

    finally:
        try:
            logFile.close()
        except:
            pass

    # If we got to here, we succesfully sent the report to the server.
    # Delete the log file.

    os.remove(logFilePath)

if __name__ == '__main__':
    main()