# 
"""
Author: Richard Saxton
Date: 10-06-2020

hiligt.py is a client for the HILIGT flux and upper limit server
package. It Returns upper limits or fluxes for one or more 
sky positions.

Requirements: Python 2.7

Usage: 
#    Single position:      python client.py 123.45 -77.89
#    Position with label : python client.py 123.45 -77.89 "3C273"
#    File of positions:    python client.py file=mysrc.txt
#
#    File of positions should have format:
#
#    ra  dec   <label>
#    ra2  dec2   <label2>
#    ra3  dec3   <label3>
#
#    ra and dec should be in decimal degrees
#    The label is optional and currently can not contain a space !
#
"""
import sys
import urllib2
import argparse

# Class to describe a source with the property Ra, Dec and Label

class Source(object):

    def __init__(self, ra, dec, label=""):
           self._ra=ra
           self._dec=dec
           # Need to replace any "+" sign as treated as space in REST call
           self._label=label.replace("+","%2B")

    def ra(self):
        return self._ra

    def dec(self):
        return self._dec

    def label(self):
        return self._label

# Method to read a set of sources from a file
#
# Format is RA (degs) DEC (degs) Label (optional)
#
def readSourcesFromList(srcfile):

    sources = []  # Define an empty list of sources
   
    # Open the source list and loop over each source
    with open(srcfile, "r") as ins:
       for line in ins:
           values = line.split()
           if len(values)>2:
              sources.append(Source(values[0],values[1],values[2]))
           else:
              sources.append(Source(values[0],values[1]))


    return sources

# End of readSourcesFromList
# End of class sources

# Start of main program
def main():

   # Edit this to define the missions to poll.
    missions = ['XMMpnt','XMMslew','RosatSurvey'
#               ,'SwiftXRT','RosatPointedPSPC','RosatPointedHRI'
#               ,'Integral','ExosatLE','ExosatME','Einstein',
#               'Ginga','Asca','Ariel5','Uhuru', 'Vela5B'
               ]

    # Defaults to returning results in text format
    # Defaults to using all the energy bands
    # Defaults to using a spectral model of wabs*pow, with NH=3E20
    # and power-law slope=2.0 to convert c/s to flux

    # Get an array of sources from the input parameters
    FORMAT,sources = getSources()

    # Loop over each source
    for source in sources:

       for mission in missions:

           # Get the flux and upper limits for this mission and position 
           result = ULS_mission(mission, source.ra(), source.dec(), 
                                source.label(), FORMAT)
           print mission
           print result


def getSources():

    s = []  # A list of sources

    # Get ra,dec from command line arguments
    ra,dec,label,FORMAT,coord_file = getargs()

    
    # If two or three arguments assume it is one source
    if coord_file=="":
       s.append(Source(ra,dec,label))
    else: # Source list
       s = readSourcesFromList(coord_file)

    return FORMAT,s


# Process this position - XMM pointed
def ULS_mission(mission, ra, dec, label, FORMAT):

    # Make a URL call to the upper limit server
    urlstring=("http://xmmuls.esac.esa.int/ULSservice_passthru?mission="
               + mission + "&ra=" + ra + "&dec=" + dec + "&label=" + label + 
               "&FORMAT=" + FORMAT)
    res = urllib2.urlopen(urlstring)

    return res.read()

def check_restricted_float(x, low, high):
    x = float(x)
    if x < low or x > high:
        print("%r not in range [0.0, 1.0]"%(x,))
        #raise argparse.ArgumentTypeError("%r not in range [0.0, 1.0]"%(x,))
    return x

def getargs():

    parser = argparse.ArgumentParser(prog='ULS_client')
    parser.add_argument("ra",nargs='?',help="right ascencion",default=0.0)
    parser.add_argument("dec",nargs='?',help="declination")
    parser.add_argument("--label", help="label for source",default="")
    parser.add_argument("--file", help="file of sources",default="")
    parser.add_argument("--FORMAT", help="format",
                        choices=["text","text/html","JSON","csv"],default="text")
    args = parser.parse_args()

    # Get the format
    FORMAT = args.FORMAT
    coord_file = args.file

    # If no file supplied then set coords from an individual source
    if coord_file == "":
       ra = args.ra
       dec = args.dec
       label = args.label
       check_restricted_float(ra,0.0,360.0)
       check_restricted_float(dec,-90.0,90.0)
    else:
       ra="0.0"
       dec="0.0"
       label=""

    # Otherwise assume this is a single position
    if len(sys.argv)<3:
       print("Usage: client.py ra dec <label> or "
                                        "client.py file=<filename>")
       #raise argparse.ArgumentTypeError("Usage: client.py ra dec <label> or "
        #                                "client.py file=<filename>")

    return ra,dec,label,FORMAT,coord_file


# Run the program
if __name__ == "__main__":
        main()