#!/usr/bin/env python
###############################################################################
# $Id$
#
# Project:  GDAL/OGR Test Suite
# Purpose:  Test read/write round-tripping of SRS for HFA/Imagine format.
# Author:   Even Rouault, <even dot rouault at mines dash paris dot org>
#
###############################################################################
# Copyright (c) 2011, Even Rouault, <even dot rouault at mines dash paris dot org>
#
# Permission is hereby granted, free of charge, to any person obtaining a
# copy of this software and associated documentation files (the "Software"),
# to deal in the Software without restriction, including without limitation
# the rights to use, copy, modify, merge, publish, distribute, sublicense,
# and/or sell copies of the Software, and to permit persons to whom the
# Software is furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included
# in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
# DEALINGS IN THE SOFTWARE.
###############################################################################

import os
import sys

import gdal
import osr

sys.path.append( '../pymod' )

import gdaltest


###############################################################################
# Write a HFA/Imagine and read it back to check its SRS

class TestHFASRS:
    def __init__( self, epsg_code, use_epsg_code, expected_fail ):
        self.epsg_code = epsg_code
        self.use_epsg_code = use_epsg_code
        self.expected_fail = expected_fail

    def test( self ):
        sr = osr.SpatialReference()
        sr.ImportFromEPSG(self.epsg_code)
        if self.use_epsg_code == 0:
            proj4str = sr.ExportToProj4()
            #print(proj4str)
            sr.SetFromUserInput(proj4str)

        ds = gdal.GetDriverByName('HFA').Create('/vsimem/TestHFASRS.img',1,1)
        ds.SetProjection(sr.ExportToWkt())
        ds = None

        ds = gdal.Open('/vsimem/TestHFASRS.img')
        wkt = ds.GetProjectionRef()
        sr2 = osr.SpatialReference()
        sr2.SetFromUserInput(wkt)
        ds = None

        gdal.Unlink('/vsimem/TestHFASRS.img')

        # HFA doesn't handle TOWGS84, so we undo it from the reference SRS
        # before comparing
        sr.SetTOWGS84(0,0,0,0,0,0,0)

        # For EPSG:2065. Those 2 datums are translated into D_S_JTSK in ESRI WKT... So for the purpose of
        # comparison, substitute one for another
        if sr.ExportToWkt().find('"System_Jednotne_Trigonometricke_Site_Katastralni_Ferro"') != -1 and \
           sr2.ExportToWkt().find('"System_Jednotne_Trigonometricke_Site_Katastralni"') != -1:
               wkt2 = sr2.ExportToWkt().replace('"System_Jednotne_Trigonometricke_Site_Katastralni"', '"System_Jednotne_Trigonometricke_Site_Katastralni_Ferro"')
               sr2.SetFromUserInput(wkt2)

        if sr.IsSame(sr2) != 1:
            if self.expected_fail:
                print('did not get expected SRS. known to be broken currently. FIXME!')
                #print(sr)
                #print(sr2)
                return 'expected_fail'

            gdaltest.post_reason('did not get expected SRS')
            print(sr)
            print(sr2)
            return 'fail'

        return 'success'


gdaltest_list = []

hfa_srs_list = [ 2758, #tmerc
                  [2036, True], #sterea   # failure caused by revert done in r22803
                  2046, #tmerc
                  [3031, True], #stere
                  [32661, True], #stere
                  3035, #laea
                  2062, #lcc
                  2065, #krovak
                  2066, #cass
                  2964, #aea
                  [3410, True], #cea
                  [3786, True],  #eqc
                  [2934, True], #merc
                  27200, #nzmg
                  [2057, True], #omerc
                  29100,  #poly
                  2056, #somerc
                  2027, #utm
                  4326, #longlat
]

for item in hfa_srs_list:
    try:
        epsg_code = item[0]
        epsg_broken = item[1]
        #epsg_proj4_broken = item[2]
    except:
        epsg_code = item
        epsg_broken = False
        #epsg_proj4_broken = False

    ut = TestHFASRS( epsg_code, 1, epsg_broken )
    gdaltest_list.append( (ut.test, "hfa_srs_epsg_%d" % epsg_code) )
    #ut = TestHFASRS( epsg_code, 0, epsg_proj4_broken )
    #gdaltest_list.append( (ut.test, "hfa_srs_proj4_of_epsg_%d" % epsg_code) )

if __name__ == '__main__':

    gdaltest.setup_run( 'hfa_srs' )

    gdaltest.run_tests( gdaltest_list )

    gdaltest.summarize()