import os, unittest

from django.contrib.gis import gdal

from django.contrib.gis.db.backend import SpatialBackend

from django.contrib.gis.geos import *

from django.contrib.gis.measure import Distance

from django.contrib.gis.tests.utils import no_oracle, no_postgis, no_spatialite

from models import Country, City, PennsylvaniaCity, State

if not SpatialBackend.spatialite:

    from models import Feature, MinusOneSRID

# TODO: Some tests depend on the success/failure of previous tests, these should

# be decoupled.  This flag is an artifact of this problem, and makes debugging easier;

# specifically, the DISABLE flag will disables all tests, allowing problem tests to

# be examined individually.

DISABLE = False

class GeoModelTest(unittest.TestCase):

    def test01_initial_sql(self):

        "Testing geographic initial SQL."

        if DISABLE: return

        if SpatialBackend.oracle:

            # Oracle doesn't allow strings longer than 4000 characters

            # in SQL files, and I'm stumped on how to use Oracle BFILE's

            # in PLSQL, so we set up the larger geometries manually, rather

            # than relying on the initial SQL.

            # Routine for returning the path to the data files.

            data_dir = os.path.join(os.path.dirname(__file__), 'sql')

            def get_file(wkt_file):

                return os.path.join(data_dir, wkt_file)

            State(name='Puerto Rico', poly=None).save()

            State(name='Colorado', poly=fromfile(get_file('co.wkt'))).save()

            State(name='Kansas', poly=fromfile(get_file('ks.wkt'))).save()

            Country(name='Texas', mpoly=fromfile(get_file('tx.wkt'))).save()

            Country(name='New Zealand', mpoly=fromfile(get_file('nz.wkt'))).save()

        # Ensuring that data was loaded from initial SQL.

        self.assertEqual(2, Country.objects.count())

        self.assertEqual(8, City.objects.count())

        self.assertEqual(3, State.objects.count())

    def test02_proxy(self):

        "Testing Lazy-Geometry support (using the GeometryProxy)."

        if DISABLE: return

        ## Testing on a Point

        pnt = Point(0, 0)

        nullcity = City(name='NullCity', point=pnt)

        nullcity.save()

        # Making sure TypeError is thrown when trying to set with an

        #  incompatible type.

        for bad in [5, 2.0, LineString((0, 0), (1, 1))]:

            try:

                nullcity.point = bad

            except TypeError:

                pass

            else:

                self.fail('Should throw a TypeError')

        # Now setting with a compatible GEOS Geometry, saving, and ensuring

        #  the save took, notice no SRID is explicitly set.

        new = Point(5, 23)

        nullcity.point = new

        # Ensuring that the SRID is automatically set to that of the

        #  field after assignment, but before saving.

        self.assertEqual(4326, nullcity.point.srid)

        nullcity.save()

        # Ensuring the point was saved correctly after saving

        self.assertEqual(new, City.objects.get(name='NullCity').point)

        # Setting the X and Y of the Point

        nullcity.point.x = 23

        nullcity.point.y = 5

        # Checking assignments pre & post-save.

        self.assertNotEqual(Point(23, 5), City.objects.get(name='NullCity').point)

        nullcity.save()

        self.assertEqual(Point(23, 5), City.objects.get(name='NullCity').point)

        nullcity.delete()

        ## Testing on a Polygon

        shell = LinearRing((0, 0), (0, 100), (100, 100), (100, 0), (0, 0))

        inner = LinearRing((40, 40), (40, 60), (60, 60), (60, 40), (40, 40))

        # Creating a State object using a built Polygon

        ply = Polygon(shell, inner)

        nullstate = State(name='NullState', poly=ply)

        self.assertEqual(4326, nullstate.poly.srid) # SRID auto-set from None

        nullstate.save()

        ns = State.objects.get(name='NullState')

        self.assertEqual(ply, ns.poly)

        # Testing the `ogr` and `srs` lazy-geometry properties.

        if gdal.HAS_GDAL:

            self.assertEqual(True, isinstance(ns.poly.ogr, gdal.OGRGeometry))

            self.assertEqual(ns.poly.wkb, ns.poly.ogr.wkb)

            self.assertEqual(True, isinstance(ns.poly.srs, gdal.SpatialReference))

            self.assertEqual('WGS 84', ns.poly.srs.name)

        # Changing the interior ring on the poly attribute.

        new_inner = LinearRing((30, 30), (30, 70), (70, 70), (70, 30), (30, 30))

        ns.poly[1] = new_inner

        ply[1] = new_inner

        self.assertEqual(4326, ns.poly.srid)

        ns.save()

        self.assertEqual(ply, State.objects.get(name='NullState').poly)

        ns.delete()

    @no_oracle # Oracle does not support KML.

    @no_spatialite # SpatiaLite does not support KML.

    def test03a_kml(self):

        "Testing KML output from the database using GeoQuerySet.kml()."

        if DISABLE: return

        # Should throw a TypeError when trying to obtain KML from a

        #  non-geometry field.

        qs = City.objects.all()

        self.assertRaises(TypeError, qs.kml, 'name')

        # The reference KML depends on the version of PostGIS used

        # (the output stopped including altitude in 1.3.3).

        major, minor1, minor2 = SpatialBackend.version

        ref_kml1 = '<Point><coordinates>-104.609252,38.255001,0</coordinates></Point>'

        ref_kml2 = '<Point><coordinates>-104.609252,38.255001</coordinates></Point>'

        if major == 1:

            if minor1 > 3 or (minor1 == 3 and minor2 >= 3): ref_kml = ref_kml2

            else: ref_kml = ref_kml1

        else:

            ref_kml = ref_kml2

        # Ensuring the KML is as expected.

        ptown1 = City.objects.kml(field_name='point', precision=9).get(name='Pueblo')

        ptown2 = City.objects.kml(precision=9).get(name='Pueblo')

        for ptown in [ptown1, ptown2]:

            self.assertEqual(ref_kml, ptown.kml)

    @no_spatialite # SpatiaLite does not support GML.

    def test03b_gml(self):

        "Testing GML output from the database using GeoQuerySet.gml()."

        if DISABLE: return

        # Should throw a TypeError when tyring to obtain GML from a

        #  non-geometry field.

        qs = City.objects.all()

        self.assertRaises(TypeError, qs.gml, field_name='name')

        ptown1 = City.objects.gml(field_name='point', precision=9).get(name='Pueblo')

        ptown2 = City.objects.gml(precision=9).get(name='Pueblo')

        import re

        if SpatialBackend.oracle:

            # No precision parameter for Oracle :-/

            gml_regex = re.compile(r'^<gml:Point srsName="SDO:4326" xmlns:gml="http://www.opengis.net/gml"><gml:coordinates decimal="\." cs="," ts=" ">-104.60925\d+,38.25500\d+ </gml:coordinates></gml:Point>')

            for ptown in [ptown1, ptown2]:

                self.failUnless(gml_regex.match(ptown.gml))

        else:

            gml_regex = re.compile(r'^<gml:Point srsName="EPSG:4326"><gml:coordinates>-104\.60925\d+,38\.255001</gml:coordinates></gml:Point>')

            for ptown in [ptown1, ptown2]:

                self.failUnless(gml_regex.match(ptown.gml))

    @no_spatialite

    @no_oracle

    def test03c_geojson(self):

        "Testing GeoJSON output from the database using GeoQuerySet.geojson()."

        if DISABLE: return

        # PostGIS only supports GeoJSON on 1.3.4+

        if not SpatialBackend.geojson:

            return

        major, minor1, minor2 = SpatialBackend.version

        if major >=1 and minor1 >= 4:

            pueblo_json = '{"type":"Point","coordinates":[-104.609252,38.255001]}'

            houston_json = '{"type":"Point","crs":{"type":"name","properties":{"name":"EPSG:4326"}},"coordinates":[-95.363151,29.763374]}'

            victoria_json = '{"type":"Point","bbox":[-123.30519600,48.46261100,-123.30519600,48.46261100],"coordinates":[-123.305196,48.462611]}'

            chicago_json = '{"type":"Point","crs":{"type":"name","properties":{"name":"EPSG:4326"}},"bbox":[-87.65018,41.85039,-87.65018,41.85039],"coordinates":[-87.65018,41.85039]}'

        else:

            pueblo_json = '{"type":"Point","coordinates":[-104.60925200,38.25500100]}'

            houston_json = '{"type":"Point","crs":{"type":"EPSG","properties":{"EPSG":4326}},"coordinates":[-95.36315100,29.76337400]}'

            victoria_json = '{"type":"Point","bbox":[-123.30519600,48.46261100,-123.30519600,48.46261100],"coordinates":[-123.30519600,48.46261100]}'

            chicago_json = '{"type":"Point","crs":{"type":"EPSG","properties":{"EPSG":4326}},"bbox":[-87.65018,41.85039,-87.65018,41.85039],"coordinates":[-87.65018,41.85039]}'

        # Precision argument should only be an integer

        self.assertRaises(TypeError, City.objects.geojson, precision='foo')

        # Reference queries and values.

        # SELECT ST_AsGeoJson("geoapp_city"."point", 8, 0) FROM "geoapp_city" WHERE "geoapp_city"."name" = 'Pueblo';

        self.assertEqual(pueblo_json, City.objects.geojson().get(name='Pueblo').geojson)

        # 1.3.x: SELECT ST_AsGeoJson("geoapp_city"."point", 8, 1) FROM "geoapp_city" WHERE "geoapp_city"."name" = 'Houston';

        # 1.4.x: SELECT ST_AsGeoJson("geoapp_city"."point", 8, 2) FROM "geoapp_city" WHERE "geoapp_city"."name" = 'Houston';

        # This time we want to include the CRS by using the `crs` keyword.

        self.assertEqual(houston_json, City.objects.geojson(crs=True, model_att='json').get(name='Houston').json)

        # 1.3.x: SELECT ST_AsGeoJson("geoapp_city"."point", 8, 2) FROM "geoapp_city" WHERE "geoapp_city"."name" = 'Victoria';

        # 1.4.x: SELECT ST_AsGeoJson("geoapp_city"."point", 8, 1) FROM "geoapp_city" WHERE "geoapp_city"."name" = 'Houston';

        # This time we include the bounding box by using the `bbox` keyword.

        self.assertEqual(victoria_json, City.objects.geojson(bbox=True).get(name='Victoria').geojson)

        # 1.(3|4).x: SELECT ST_AsGeoJson("geoapp_city"."point", 5, 3) FROM "geoapp_city" WHERE "geoapp_city"."name" = 'Chicago';

        # Finally, we set every available keyword.

        self.assertEqual(chicago_json, City.objects.geojson(bbox=True, crs=True, precision=5).get(name='Chicago').geojson)

    @no_oracle

    def test03d_svg(self):

        "Testing SVG output using GeoQuerySet.svg()."

        if DISABLE: return

        self.assertRaises(TypeError, City.objects.svg, precision='foo')

        # SELECT AsSVG(geoapp_city.point, 0, 8) FROM geoapp_city WHERE name = 'Pueblo';

        svg1 = 'cx="-104.609252" cy="-38.255001"'

        # Even though relative, only one point so it's practically the same except for

        # the 'c' letter prefix on the x,y values.

        svg2 = svg1.replace('c', '')

        self.assertEqual(svg1, City.objects.svg().get(name='Pueblo').svg)

        self.assertEqual(svg2, City.objects.svg(relative=5).get(name='Pueblo').svg)

    def test04_transform(self):

        "Testing the transform() GeoManager method."

        if DISABLE: return

        # Pre-transformed points for Houston and Pueblo.

        htown = fromstr('POINT(1947516.83115183 6322297.06040572)', srid=3084)

        ptown = fromstr('POINT(992363.390841912 481455.395105533)', srid=2774)

        prec = 3 # Precision is low due to version variations in PROJ and GDAL.

        # Asserting the result of the transform operation with the values in

        #  the pre-transformed points.  Oracle does not have the 3084 SRID.

        if not SpatialBackend.oracle:

            h = City.objects.transform(htown.srid).get(name='Houston')

            self.assertEqual(3084, h.point.srid)

            self.assertAlmostEqual(htown.x, h.point.x, prec)

            self.assertAlmostEqual(htown.y, h.point.y, prec)

        p1 = City.objects.transform(ptown.srid, field_name='point').get(name='Pueblo')

        p2 = City.objects.transform(srid=ptown.srid).get(name='Pueblo')

        for p in [p1, p2]:

            self.assertEqual(2774, p.point.srid)

            self.assertAlmostEqual(ptown.x, p.point.x, prec)

            self.assertAlmostEqual(ptown.y, p.point.y, prec)

    @no_spatialite # SpatiaLite does not have an Extent function

    def test05_extent(self):

        "Testing the `extent` GeoQuerySet method."

        if DISABLE: return

        # Reference query:

        # `SELECT ST_extent(point) FROM geoapp_city WHERE (name='Houston' or name='Dallas');`

        #   =>  BOX(-96.8016128540039 29.7633724212646,-95.3631439208984 32.7820587158203)

        expected = (-96.8016128540039, 29.7633724212646, -95.3631439208984, 32.782058715820)

        qs = City.objects.filter(name__in=('Houston', 'Dallas'))

        extent = qs.extent()

        for val, exp in zip(extent, expected):

            self.assertAlmostEqual(exp, val, 4)

    @no_oracle

    @no_spatialite # SpatiaLite does not have a MakeLine function

    def test06_make_line(self):

        "Testing the `make_line` GeoQuerySet method."

        if DISABLE: return

        # Ensuring that a `TypeError` is raised on models without PointFields.

        self.assertRaises(TypeError, State.objects.make_line)

        self.assertRaises(TypeError, Country.objects.make_line)

        # Reference query:

        # SELECT AsText(ST_MakeLine(geoapp_city.point)) FROM geoapp_city;

        ref_line = GEOSGeometry('LINESTRING(-95.363151 29.763374,-96.801611 32.782057,-97.521157 34.464642,174.783117 -41.315268,-104.609252 38.255001,-95.23506 38.971823,-87.650175 41.850385,-123.305196 48.462611)', srid=4326)

        self.assertEqual(ref_line, City.objects.make_line())

    def test09_disjoint(self):

        "Testing the `disjoint` lookup type."

        if DISABLE: return

        ptown = City.objects.get(name='Pueblo')

        qs1 = City.objects.filter(point__disjoint=ptown.point)

        self.assertEqual(7, qs1.count())

        if not (SpatialBackend.postgis or SpatialBackend.spatialite):

            # TODO: Do NULL columns bork queries on PostGIS?  The following

            # error is encountered:

            #  psycopg2.ProgrammingError: invalid memory alloc request size 4294957297

            #

            # Similarly, on SpatiaLite Puerto Rico is also returned (could be a

            # manifestation of

            qs2 = State.objects.filter(poly__disjoint=ptown.point)

            self.assertEqual(1, qs2.count())

            self.assertEqual('Kansas', qs2[0].name)

    def test10_contains_contained(self):

        "Testing the 'contained', 'contains', and 'bbcontains' lookup types."

        if DISABLE: return

        # Getting Texas, yes we were a country -- once ;)

        texas = Country.objects.get(name='Texas')

        # Seeing what cities are in Texas, should get Houston and Dallas,

        #  and Oklahoma City because 'contained' only checks on the

        #  _bounding box_ of the Geometries.

        if not SpatialBackend.oracle:

            qs = City.objects.filter(point__contained=texas.mpoly)

            self.assertEqual(3, qs.count())

            cities = ['Houston', 'Dallas', 'Oklahoma City']

            for c in qs: self.assertEqual(True, c.name in cities)

        # Pulling out some cities.

        houston = City.objects.get(name='Houston')

        wellington = City.objects.get(name='Wellington')

        pueblo = City.objects.get(name='Pueblo')

        okcity = City.objects.get(name='Oklahoma City')

        lawrence = City.objects.get(name='Lawrence')

        # Now testing contains on the countries using the points for

        #  Houston and Wellington.

        tx = Country.objects.get(mpoly__contains=houston.point) # Query w/GEOSGeometry

        nz = Country.objects.get(mpoly__contains=wellington.point.hex) # Query w/EWKBHEX

        self.assertEqual('Texas', tx.name)

        self.assertEqual('New Zealand', nz.name)

        # Spatialite 2.3 thinks that Lawrence is in Puerto Rico (a NULL geometry).

        if not SpatialBackend.spatialite:

            ks = State.objects.get(poly__contains=lawrence.point)

            self.assertEqual('Kansas', ks.name)

        # Pueblo and Oklahoma City (even though OK City is within the bounding box of Texas)

        #  are not contained in Texas or New Zealand.

        self.assertEqual(0, len(Country.objects.filter(mpoly__contains=pueblo.point))) # Query w/GEOSGeometry object

        self.assertEqual(0, len(Country.objects.filter(mpoly__contains=okcity.point.wkt))) # Qeury w/WKT

        # OK City is contained w/in bounding box of Texas.

        if not SpatialBackend.oracle:

            qs = Country.objects.filter(mpoly__bbcontains=okcity.point)

            self.assertEqual(1, len(qs))

            self.assertEqual('Texas', qs[0].name)

    def test11_lookup_insert_transform(self):

        "Testing automatic transform for lookups and inserts."

        if DISABLE: return

        # San Antonio in 'WGS84' (SRID 4326)

        sa_4326 = 'POINT (-98.493183 29.424170)'

        wgs_pnt = fromstr(sa_4326, srid=4326) # Our reference point in WGS84

        # Oracle doesn't have SRID 3084, using 41157.

        if SpatialBackend.oracle:

            # San Antonio in 'Texas 4205, Southern Zone (1983, meters)' (SRID 41157)

            # Used the following Oracle SQL to get this value:

            #  SELECT SDO_UTIL.TO_WKTGEOMETRY(SDO_CS.TRANSFORM(SDO_GEOMETRY('POINT (-98.493183 29.424170)', 4326), 41157)) FROM DUAL;

            nad_wkt  = 'POINT (300662.034646583 5416427.45974934)'

            nad_srid = 41157

        else:

            # San Antonio in 'NAD83(HARN) / Texas Centric Lambert Conformal' (SRID 3084)

            nad_wkt = 'POINT (1645978.362408288754523 6276356.025927528738976)' # Used ogr.py in gdal 1.4.1 for this transform

            nad_srid = 3084

        # Constructing & querying with a point from a different SRID. Oracle

        # `SDO_OVERLAPBDYINTERSECT` operates differently from

        # `ST_Intersects`, so contains is used instead.

        nad_pnt = fromstr(nad_wkt, srid=nad_srid)

        if SpatialBackend.oracle:

            tx = Country.objects.get(mpoly__contains=nad_pnt)

        else:

            tx = Country.objects.get(mpoly__intersects=nad_pnt)

        self.assertEqual('Texas', tx.name)

        # Creating San Antonio.  Remember the Alamo.

        sa = City(name='San Antonio', point=nad_pnt)

        sa.save()

        # Now verifying that San Antonio was transformed correctly

        sa = City.objects.get(name='San Antonio')

        self.assertAlmostEqual(wgs_pnt.x, sa.point.x, 6)

        self.assertAlmostEqual(wgs_pnt.y, sa.point.y, 6)

        # If the GeometryField SRID is -1, then we shouldn't perform any

        # transformation if the SRID of the input geometry is different.

        # SpatiaLite does not support missing SRID values.

        if not SpatialBackend.spatialite:

            m1 = MinusOneSRID(geom=Point(17, 23, srid=4326))

            m1.save()

            self.assertEqual(-1, m1.geom.srid)

    def test12_null_geometries(self):

        "Testing NULL geometry support, and the `isnull` lookup type."