source: install/bootstrap.py @ 3088

#!/usr/bin/env python
# Installs GSAS-II from network using subversion and creates platform-specific shortcuts.
# works for Mac & Linux & Windows
import os, stat, sys, platform, subprocess

g2home = 'https://subversion.xray.aps.anl.gov/pyGSAS/'
################################################################################
################################################################################
# routines copied from GSASIIpath.py
proxycmds = []
'Used to hold proxy information for subversion, set if needed in whichsvn'
svnLocCache = None
'Cached location of svn to avoid multiple searches for it'

def whichsvn():
    '''Returns a path to the subversion exe file, if any is found.
    Searches the current path after adding likely places where GSAS-II
    might install svn. 

    :returns: None if svn is not found or an absolute path to the subversion
      executable file.
    '''
    # use a previosuly cached svn location
    global svnLocCache
    if svnLocCache: return svnLocCache
    # prepare to find svn
    is_exe = lambda fpath: os.path.isfile(fpath) and os.access(fpath, os.X_OK)
    svnprog = 'svn'
    if sys.platform.startswith('win'): svnprog += '.exe'
    gsaspath = os.path.split(__file__)[0]
    # check for a proxy
    proxyinfo = os.path.join(gsaspath,"proxyinfo.txt")
    if os.path.exists(proxyinfo):
        global proxycmds
        proxycmds = []
        fp = open(proxyinfo,'r')
        host = fp.readline().strip()
        port = fp.readline().strip()
        fp.close()
        proxycmds.append('--config-option')
        proxycmds.append('servers:global:http-proxy-host='+host)
        proxycmds.append('--config-option')
        proxycmds.append('servers:global:http-proxy-port='+port)
    # add likely places to find subversion when installed with GSAS-II
    pathlist = os.environ["PATH"].split(os.pathsep)
    pathlist.append(os.path.split(sys.executable)[0])
    pathlist.append(gsaspath)
    for rpt in ('..','bin'),('..','Library','bin'),('svn','bin'),('svn',),('.'):
        pt = os.path.normpath(os.path.join(gsaspath,*rpt))
        if os.path.exists(pt):
            pathlist.insert(0,pt)    
    # search path for svn or svn.exe
    for path in pathlist:
        exe_file = os.path.join(path, svnprog)
        if is_exe(exe_file):
            try:
                p = subprocess.Popen([exe_file,'help'],stdout=subprocess.PIPE)
                res = p.stdout.read()
                p.communicate()
                svnLocCache = os.path.abspath(exe_file)
                return svnLocCache
            except:
                pass        
    svnLocCache = None

def svnVersion(svn=None):
    '''Get the version number of the current subversion executable

    :returns: a string with a version number such as "1.6.6" or None if
      subversion is not found.

    '''
    if not svn: svn = whichsvn()
    if not svn: return

    cmd = [svn,'--version','--quiet']
    s = subprocess.Popen(cmd,
                         stdout=subprocess.PIPE,stderr=subprocess.PIPE)
    out,err = s.communicate()
    if err:
        print 'subversion error!\nout=',out
        print 'err=',err
        return None
    return out.strip()

def svnVersionNumber(svn=None):
    '''Get the version number of the current subversion executable

    :returns: a fractional version number such as 1.6 or None if
      subversion is not found.

    '''
    ver = svnVersion(svn)
    if not ver: return 
    M,m = ver.split('.')[:2]
    return int(M)+int(m)/10.

################################################################################
################################################################################
print 70*'*'
#testing for incorrect locale code'
try:
    import locale
    locale.getdefaultlocale()
except ValueError:
    print 'Your location is not set properly. This causes problems for matplotlib'
    print '  (see https://github.com/matplotlib/matplotlib/issues/5420.)'
    print 'Will try to bypass problem by setting LC_ALL to en_US.UTF-8 (US English)'
    os.environ['LC_ALL'] = 'en_US.UTF-8'
    locale.getdefaultlocale()
print 'Preloading matplotlib to build fonts...'
try:
    import matplotlib
except:
    pass
print 'Checking python packages...',
missing = []
for pkg in ['numpy','scipy','matplotlib','wx',]:
    try:
        exec('import '+pkg)
    except:
        missing.append(pkg)

if missing:
    print """Sorry, this version of Python cannot be used
for GSAS-II. It is missing the following package(s):
\t""",
    for pkg in missing: print " ",pkg,
    print "\nPlease install these package(s) and try running this again."
    print "Showing first error: "
    for pkg in ['numpy','scipy','matplotlib','wx',]:
        exec('import '+pkg)
    sys.exit()
try:
    import OpenGL
    install_with_easyinstall = None 
except:
    try:                 
            from setuptools.command import easy_install                  
    except ImportError:
        print 'You are missing the OpenGL Python package. This can be '
        print 'installed by this script if the setuptools package is installed'
        print 'Please install either OpenGL (pyopengl) or setuptools'
        print "package and try running this again."
        sys.exit()
    print "Missing the OpenGL Python package. Will attempt to install this later."
    def install_with_easyinstall(package):               
        try:             
            print "trying system-wide ",                 
            easy_install.main(['-f',os.path.split(__file__)[0],package])                 
            return               
        except:                  
            pass                 
        try:             
            print "trying user level ",                  
            easy_install.main(['-f',os.path.split(__file__)[0],'--user',package])                
            return               
        except:                  
            print "\nInstall of "+package+" failed. Error traceback follows:"            
            import traceback             
            print traceback.format_exc()                 
            sys.exit() 
# path to where this script is located
gsaspath = os.path.split(sys.argv[0])[0]
if not gsaspath: gsaspath = os.path.curdir
gsaspath = os.path.abspath(os.path.expanduser(gsaspath))

print '\nChecking for subversion...',
svn = whichsvn()
if not svn:
    print "Sorry, subversion (svn) could not be found on your system."
    print "Please install this or place in path and rerun this."
    #raise Exception('Subversion (svn) not found')
    sys.exit()
print ' found svn image: '+svn

if install_with_easyinstall:             
    print '\nInstalling PyOpenGL. Lots of warnings will follow... ',             
    install_with_easyinstall('PyOpenGl')                 
    print 'done.'
    
print 'Ready to bootstrap GSAS-II from repository\n\t',g2home,'\nto '+gsaspath
proxycmds = []
proxyinfo = os.path.join(gsaspath,"proxyinfo.txt")
host = None
port = '8080'
if os.path.exists(proxyinfo):
    fp = open(proxyinfo,'r')
    host = fp.readline().strip()
    port = fp.readline().strip()
    fp.close()
    os.remove(proxyinfo)
print(70*"=")
if host:
    ans = raw_input("Enter the proxy address (type none to remove) ["+host+"]: ")
    if ans.strip().lower() == "none": host = ans = ""
else:
    ans = raw_input("Enter the proxy address [none needed]: ")
if ans.strip() != "" or host:
    proxycmds.append('--config-option')
    if ans.strip() == "": ans=host
    proxycmds.append('servers:global:http-proxy-host='+ans.strip())
    fp = open(proxyinfo,'w')
    fp.write(ans.strip()+'\n')
    ans = raw_input("Enter the proxy port ["+port+"]: ")
    if ans.strip() == "": ans=port
    proxycmds.append('--config-option')
    proxycmds.append('servers:global:http-proxy-port='+ans.strip())
    fp.write(ans.strip()+'\n')
    fp.close()

# patch: switch GSAS-II location if linked to XOR server (removed May/June 2017)
cmd = [svn, 'info']
p = subprocess.Popen(cmd,stdout=subprocess.PIPE,stderr=subprocess.PIPE)
res,err = p.communicate()
if '.xor.' in res:
    print('Switching previous install with .xor. download location to\n\thttps://subversion.xray.aps.anl.gov/pyGSAS')
    cmd = [svn, 'switch','--relocate','https://subversion.xor.aps.anl.gov/pyGSAS',
           'https://subversion.xray.aps.anl.gov/pyGSAS']
    if proxycmds: cmd += proxycmds
    p = subprocess.Popen(cmd,stdout=subprocess.PIPE,stderr=subprocess.PIPE)
    res,err = p.communicate()
    if err:
        print('Please report this error to toby@anl.gov:')
        print(err)
        print(res)
# patch: switch GSAS-II location if switched to 2frame version (removed August 2017)
if '2frame' in res:
    print('Switching previous 2frame install to trunk\n\thttps://subversion.xray.aps.anl.gov/pyGSAS')
    cmd = [svn, 'switch',g2home + '/trunk',gsaspath,
           '--non-interactive','--trust-server-cert',
           '--accept','theirs-conflict','--force','--ignore-ancestry']
    if proxycmds: cmd += proxycmds
    p = subprocess.Popen(cmd,stdout=subprocess.PIPE,stderr=subprocess.PIPE)
    res,err = p.communicate()
    if err:
        print('Please report this error to toby@anl.gov:')
        print(err)
        print(res)

cmd = [svn, 'co', g2home+ 'trunk/', gsaspath, '--non-interactive', '--trust-server-cert']
if proxycmds: cmd += proxycmds
msg = 'Now preparing to install GSAS-II'
print('\n'+75*'*')
print(msg + u' from ' + cmd[2])
print 'svn load command:'
for item in cmd: print item,
print ""
s = subprocess.Popen(cmd,stderr=subprocess.PIPE)
print('\nsubversion output:')
out,err = s.communicate()
if err:
    print('subversion returned an error:')
    print(err)
    print('Retrying with command for older svn version...')
    cmd = [svn, 'co', g2home+ 'trunk/', gsaspath]
    if proxycmds: cmd += proxycmds
    for item in cmd: print item,
    print ""
    s = subprocess.Popen(cmd,stderr=subprocess.PIPE)
    out,err = s.communicate()
    if err:
        print('subversion returned an error:')
        print(err)
        print('  *** GSAS-II failed to be installed: you likely have a network access')
        print('  *** problem, most commonly because you need to use a network proxy. Please')
        print('  *** check with a network administrator or use http://www.whatismyproxy.com/\n')
        sys.exit()
print('\n'+75*'*')

try:
    import GSASIIpath
    print('import of GSASIIpath completed')
except Exception as err:
    print('\n'+75*'=')
    print('Failed with import of GSASIIpath. This is unexpected.')
    print('GSAS-II will not run without correcting this. Contact toby@anl.gov')
    print(err)
    print(75*'=')
    sys.exit()

for a in sys.argv[1:]:
    if 'allbin' in a.lower() or 'server' in a.lower():
        print('Loading all binaries with command...')
        if not GSASIIpath.svnSwitchDir('AllBinaries','',g2home+ 'Binaries/',None,True):
            print('Binary load failed')
            sys.exit()
        break
else:
    GSASIIpath.DownloadG2Binaries(g2home)
        
#===========================================================================
# test if the compiled files load correctly
#===========================================================================

script = """  # commands that test each module can at least be loaded & run something in pyspg
try:
    import GSASIIpath
    GSASIIpath.SetBinaryPath()
    import pyspg
    import histogram2d
    import polymask
    import pypowder
    import pytexture
    pyspg.sgforpy('P -1')
    print('==OK==')
except:
    pass
"""
p = subprocess.Popen([sys.executable,'-c',script],stdout=subprocess.PIPE,stderr=subprocess.PIPE,
                     cwd=gsaspath)
res,err = p.communicate()
if '==OK==' not in res or p.returncode != 0:
    print('\n'+75*'=')
    print('Failed when testing the GSAS-II compiled files. GSAS-II will not run')
    print('without correcting this.')
    #print(res)
    #print(err)
    #print('\nAttempting to open a web page on compiling GSAS-II...')
    print('Please see web page\nhttps://subversion.xray.aps.anl.gov/trac/pyGSAS/wiki/CompileGSASII')
    #import webbrowser
    #webbrowser.open_new('https://subversion.xray.aps.anl.gov/trac/pyGSAS/wiki/CompileGSASII')
    print(75*'=')
    if '86' in platform.machine() and (sys.platform.startswith('linux')
                                        or sys.platform == "darwin"
                                        or sys.platform.startswith('win')):
        print('Platform '+sys.platform+' with processor type '+platform.machine()+' is supported')
    else:
        print('Platform '+sys.platform+' with processor type '+platform.machine()+' not is supported')
    sys.exit()
else:
    print 'Successfully tested compiled routines'
#===========================================================================
# import all .py files so that .pyc files get created
print 'Byte-compiling all .py files...',
import compileall
compileall.compile_dir(gsaspath,quiet=True)
print 'done'
#===========================================================================
# platform-dependent stuff
#===========================================================================
# on Windows, make a batch file with Python and GSAS-II location hard-coded
if sys.platform.startswith('win') and os.path.exists(
    os.path.join(gsaspath,"makeBat.py")):
    execfile(os.path.join(gsaspath,"makeBat.py"))
#===========================================================================
# on a Mac, make an applescript 
elif sys.platform.startswith('darwin') and os.path.exists(
    os.path.join(gsaspath,"makeMacApp.py")):
    sys.argv = [os.path.join(gsaspath,"makeMacApp.py")]
    print(u'running '+sys.argv[0])
    execfile(sys.argv[0])
#===========================================================================
# On linux, make desktop icon
elif sys.platform.startswith('linux'):
    desktop_template = """
[Desktop Entry]
Encoding=UTF-8
Version=1.0
Type=Application
Terminal=false
Exec=xterm -hold -e %s
Name=GSAS-II
Icon=%s
"""
    loc = '~/Desktop/'
    eloc = os.path.expanduser(loc)
    dfile = os.path.join(eloc,'GSASII.desktop')
    icon = os.path.join(gsaspath, 'gsas2.png')
    script = os.path.join(gsaspath, 'GSASII.py')
    os.chmod(script, # make the .py file executable and readable
             stat.S_IXUSR | stat.S_IRUSR | stat.S_IRGRP | stat.S_IXGRP | stat.S_IXOTH)
    if os.path.exists(eloc):
        open(dfile,'w').write(desktop_template % (script,icon))
        os.chmod(
            dfile,
            stat.S_IWUSR | stat.S_IXUSR | stat.S_IRUSR | stat.S_IRGRP | stat.S_IXGRP | stat.S_IXOTH)
        print("created GNOME desktop shortcut "+dfile)