494 lines
18 KiB
Python
494 lines
18 KiB
Python
from decimal import Decimal
|
|
|
|
from django.contrib.gis.db.models.fields import BaseSpatialField, GeometryField
|
|
from django.contrib.gis.db.models.sql import AreaField, DistanceField
|
|
from django.contrib.gis.geometry.backend import Geometry
|
|
from django.contrib.gis.measure import (
|
|
Area as AreaMeasure, Distance as DistanceMeasure,
|
|
)
|
|
from django.core.exceptions import FieldError
|
|
from django.db.models import (
|
|
BooleanField, FloatField, IntegerField, TextField, Transform,
|
|
)
|
|
from django.db.models.expressions import Func, Value
|
|
from django.db.models.functions import Cast
|
|
from django.utils.functional import cached_property
|
|
|
|
NUMERIC_TYPES = (int, float, Decimal)
|
|
|
|
|
|
class GeoFuncMixin:
|
|
function = None
|
|
output_field_class = None
|
|
geom_param_pos = (0,)
|
|
|
|
def __init__(self, *expressions, **extra):
|
|
if 'output_field' not in extra and self.output_field_class:
|
|
extra['output_field'] = self.output_field_class()
|
|
super().__init__(*expressions, **extra)
|
|
|
|
# Ensure that value expressions are geometric.
|
|
for pos in self.geom_param_pos:
|
|
expr = self.source_expressions[pos]
|
|
if not isinstance(expr, Value):
|
|
continue
|
|
try:
|
|
output_field = expr.output_field
|
|
except FieldError:
|
|
output_field = None
|
|
geom = expr.value
|
|
if not isinstance(geom, Geometry) or output_field and not isinstance(output_field, GeometryField):
|
|
raise TypeError("%s function requires a geometric argument in position %d." % (self.name, pos + 1))
|
|
if not geom.srid and not output_field:
|
|
raise ValueError("SRID is required for all geometries.")
|
|
if not output_field:
|
|
self.source_expressions[pos] = Value(geom, output_field=GeometryField(srid=geom.srid))
|
|
|
|
@property
|
|
def name(self):
|
|
return self.__class__.__name__
|
|
|
|
@cached_property
|
|
def geo_field(self):
|
|
return self.source_expressions[self.geom_param_pos[0]].field
|
|
|
|
def as_sql(self, compiler, connection, function=None, **extra_context):
|
|
if not self.function and not function:
|
|
function = connection.ops.spatial_function_name(self.name)
|
|
return super().as_sql(compiler, connection, function=function, **extra_context)
|
|
|
|
def resolve_expression(self, *args, **kwargs):
|
|
res = super().resolve_expression(*args, **kwargs)
|
|
|
|
# Ensure that expressions are geometric.
|
|
source_fields = res.get_source_fields()
|
|
for pos in self.geom_param_pos:
|
|
field = source_fields[pos]
|
|
if not isinstance(field, GeometryField):
|
|
raise TypeError(
|
|
"%s function requires a GeometryField in position %s, got %s." % (
|
|
self.name, pos + 1, type(field).__name__,
|
|
)
|
|
)
|
|
|
|
base_srid = res.geo_field.srid
|
|
for pos in self.geom_param_pos[1:]:
|
|
expr = res.source_expressions[pos]
|
|
expr_srid = expr.output_field.srid
|
|
if expr_srid != base_srid:
|
|
# Automatic SRID conversion so objects are comparable.
|
|
res.source_expressions[pos] = Transform(expr, base_srid).resolve_expression(*args, **kwargs)
|
|
return res
|
|
|
|
def _handle_param(self, value, param_name='', check_types=None):
|
|
if not hasattr(value, 'resolve_expression'):
|
|
if check_types and not isinstance(value, check_types):
|
|
raise TypeError(
|
|
"The %s parameter has the wrong type: should be %s." % (
|
|
param_name, check_types)
|
|
)
|
|
return value
|
|
|
|
|
|
class GeoFunc(GeoFuncMixin, Func):
|
|
pass
|
|
|
|
|
|
class GeomOutputGeoFunc(GeoFunc):
|
|
@cached_property
|
|
def output_field(self):
|
|
return self.geo_field
|
|
|
|
|
|
class SQLiteDecimalToFloatMixin:
|
|
"""
|
|
By default, Decimal values are converted to str by the SQLite backend, which
|
|
is not acceptable by the GIS functions expecting numeric values.
|
|
"""
|
|
def as_sqlite(self, compiler, connection):
|
|
for expr in self.get_source_expressions():
|
|
if hasattr(expr, 'value') and isinstance(expr.value, Decimal):
|
|
expr.value = float(expr.value)
|
|
return super().as_sql(compiler, connection)
|
|
|
|
|
|
class OracleToleranceMixin:
|
|
tolerance = 0.05
|
|
|
|
def as_oracle(self, compiler, connection):
|
|
tol = self.extra.get('tolerance', self.tolerance)
|
|
return self.as_sql(compiler, connection, template="%%(function)s(%%(expressions)s, %s)" % tol)
|
|
|
|
|
|
class Area(OracleToleranceMixin, GeoFunc):
|
|
output_field_class = AreaField
|
|
arity = 1
|
|
|
|
def as_sql(self, compiler, connection, **extra_context):
|
|
if connection.ops.geography:
|
|
self.output_field.area_att = 'sq_m'
|
|
else:
|
|
# Getting the area units of the geographic field.
|
|
if self.geo_field.geodetic(connection):
|
|
if connection.features.supports_area_geodetic:
|
|
self.output_field.area_att = 'sq_m'
|
|
else:
|
|
# TODO: Do we want to support raw number areas for geodetic fields?
|
|
raise NotImplementedError('Area on geodetic coordinate systems not supported.')
|
|
else:
|
|
units_name = self.geo_field.units_name(connection)
|
|
if units_name:
|
|
self.output_field.area_att = AreaMeasure.unit_attname(units_name)
|
|
return super().as_sql(compiler, connection, **extra_context)
|
|
|
|
def as_oracle(self, compiler, connection):
|
|
self.output_field = AreaField('sq_m') # Oracle returns area in units of meters.
|
|
return super().as_oracle(compiler, connection)
|
|
|
|
def as_sqlite(self, compiler, connection, **extra_context):
|
|
if self.geo_field.geodetic(connection):
|
|
extra_context['template'] = '%(function)s(%(expressions)s, %(spheroid)d)'
|
|
extra_context['spheroid'] = True
|
|
return self.as_sql(compiler, connection, **extra_context)
|
|
|
|
|
|
class Azimuth(GeoFunc):
|
|
output_field_class = FloatField
|
|
arity = 2
|
|
geom_param_pos = (0, 1)
|
|
|
|
|
|
class AsGeoJSON(GeoFunc):
|
|
output_field_class = TextField
|
|
|
|
def __init__(self, expression, bbox=False, crs=False, precision=8, **extra):
|
|
expressions = [expression]
|
|
if precision is not None:
|
|
expressions.append(self._handle_param(precision, 'precision', int))
|
|
options = 0
|
|
if crs and bbox:
|
|
options = 3
|
|
elif bbox:
|
|
options = 1
|
|
elif crs:
|
|
options = 2
|
|
if options:
|
|
expressions.append(options)
|
|
super().__init__(*expressions, **extra)
|
|
|
|
|
|
class AsGML(GeoFunc):
|
|
geom_param_pos = (1,)
|
|
output_field_class = TextField
|
|
|
|
def __init__(self, expression, version=2, precision=8, **extra):
|
|
expressions = [version, expression]
|
|
if precision is not None:
|
|
expressions.append(self._handle_param(precision, 'precision', int))
|
|
super().__init__(*expressions, **extra)
|
|
|
|
def as_oracle(self, compiler, connection, **extra_context):
|
|
source_expressions = self.get_source_expressions()
|
|
version = source_expressions[0]
|
|
clone = self.copy()
|
|
clone.set_source_expressions([source_expressions[1]])
|
|
extra_context['function'] = 'SDO_UTIL.TO_GML311GEOMETRY' if version.value == 3 else 'SDO_UTIL.TO_GMLGEOMETRY'
|
|
return super(AsGML, clone).as_sql(compiler, connection, **extra_context)
|
|
|
|
|
|
class AsKML(AsGML):
|
|
def as_sqlite(self, compiler, connection):
|
|
# No version parameter
|
|
clone = self.copy()
|
|
clone.set_source_expressions(self.get_source_expressions()[1:])
|
|
return clone.as_sql(compiler, connection)
|
|
|
|
|
|
class AsSVG(GeoFunc):
|
|
output_field_class = TextField
|
|
|
|
def __init__(self, expression, relative=False, precision=8, **extra):
|
|
relative = relative if hasattr(relative, 'resolve_expression') else int(relative)
|
|
expressions = [
|
|
expression,
|
|
relative,
|
|
self._handle_param(precision, 'precision', int),
|
|
]
|
|
super().__init__(*expressions, **extra)
|
|
|
|
|
|
class BoundingCircle(OracleToleranceMixin, GeoFunc):
|
|
def __init__(self, expression, num_seg=48, **extra):
|
|
super().__init__(expression, num_seg, **extra)
|
|
|
|
def as_oracle(self, compiler, connection):
|
|
clone = self.copy()
|
|
clone.set_source_expressions([self.get_source_expressions()[0]])
|
|
return super(BoundingCircle, clone).as_oracle(compiler, connection)
|
|
|
|
|
|
class Centroid(OracleToleranceMixin, GeomOutputGeoFunc):
|
|
arity = 1
|
|
|
|
|
|
class Difference(OracleToleranceMixin, GeomOutputGeoFunc):
|
|
arity = 2
|
|
geom_param_pos = (0, 1)
|
|
|
|
|
|
class DistanceResultMixin:
|
|
output_field_class = DistanceField
|
|
|
|
def source_is_geography(self):
|
|
return self.geo_field.geography and self.geo_field.srid == 4326
|
|
|
|
def distance_att(self, connection):
|
|
dist_att = None
|
|
if self.geo_field.geodetic(connection):
|
|
if connection.features.supports_distance_geodetic:
|
|
dist_att = 'm'
|
|
else:
|
|
units = self.geo_field.units_name(connection)
|
|
if units:
|
|
dist_att = DistanceMeasure.unit_attname(units)
|
|
return dist_att
|
|
|
|
def as_sql(self, compiler, connection, **extra_context):
|
|
clone = self.copy()
|
|
clone.output_field.distance_att = self.distance_att(connection)
|
|
return super(DistanceResultMixin, clone).as_sql(compiler, connection, **extra_context)
|
|
|
|
|
|
class Distance(DistanceResultMixin, OracleToleranceMixin, GeoFunc):
|
|
geom_param_pos = (0, 1)
|
|
spheroid = None
|
|
|
|
def __init__(self, expr1, expr2, spheroid=None, **extra):
|
|
expressions = [expr1, expr2]
|
|
if spheroid is not None:
|
|
self.spheroid = spheroid
|
|
expressions += (self._handle_param(spheroid, 'spheroid', bool),)
|
|
super().__init__(*expressions, **extra)
|
|
|
|
def as_postgresql(self, compiler, connection):
|
|
function = None
|
|
expr2 = self.source_expressions[1]
|
|
geography = self.source_is_geography()
|
|
if expr2.output_field.geography != geography:
|
|
if isinstance(expr2, Value):
|
|
expr2.output_field.geography = geography
|
|
else:
|
|
self.source_expressions[1] = Cast(
|
|
expr2,
|
|
GeometryField(srid=expr2.output_field.srid, geography=geography),
|
|
)
|
|
|
|
if not geography and self.geo_field.geodetic(connection):
|
|
# Geometry fields with geodetic (lon/lat) coordinates need special distance functions
|
|
if self.spheroid:
|
|
# DistanceSpheroid is more accurate and resource intensive than DistanceSphere
|
|
function = connection.ops.spatial_function_name('DistanceSpheroid')
|
|
# Replace boolean param by the real spheroid of the base field
|
|
self.source_expressions[2] = Value(self.geo_field.spheroid(connection))
|
|
else:
|
|
function = connection.ops.spatial_function_name('DistanceSphere')
|
|
return super().as_sql(compiler, connection, function=function)
|
|
|
|
def as_oracle(self, compiler, connection):
|
|
if self.spheroid:
|
|
self.source_expressions.pop(2)
|
|
return super().as_oracle(compiler, connection)
|
|
|
|
def as_sqlite(self, compiler, connection, **extra_context):
|
|
if self.spheroid:
|
|
self.source_expressions.pop(2)
|
|
if self.geo_field.geodetic(connection):
|
|
# SpatiaLite returns NULL instead of zero on geodetic coordinates
|
|
extra_context['template'] = 'COALESCE(%(function)s(%(expressions)s, %(spheroid)s), 0)'
|
|
extra_context['spheroid'] = int(bool(self.spheroid))
|
|
return super().as_sql(compiler, connection, **extra_context)
|
|
|
|
|
|
class Envelope(GeomOutputGeoFunc):
|
|
arity = 1
|
|
|
|
|
|
class ForceRHR(GeomOutputGeoFunc):
|
|
arity = 1
|
|
|
|
|
|
class GeoHash(GeoFunc):
|
|
output_field_class = TextField
|
|
|
|
def __init__(self, expression, precision=None, **extra):
|
|
expressions = [expression]
|
|
if precision is not None:
|
|
expressions.append(self._handle_param(precision, 'precision', int))
|
|
super().__init__(*expressions, **extra)
|
|
|
|
def as_mysql(self, compiler, connection):
|
|
clone = self.copy()
|
|
# If no precision is provided, set it to the maximum.
|
|
if len(clone.source_expressions) < 2:
|
|
clone.source_expressions.append(Value(100))
|
|
return clone.as_sql(compiler, connection)
|
|
|
|
|
|
class Intersection(OracleToleranceMixin, GeomOutputGeoFunc):
|
|
arity = 2
|
|
geom_param_pos = (0, 1)
|
|
|
|
|
|
@BaseSpatialField.register_lookup
|
|
class IsValid(OracleToleranceMixin, GeoFuncMixin, Transform):
|
|
lookup_name = 'isvalid'
|
|
output_field = BooleanField()
|
|
|
|
def as_oracle(self, compiler, connection, **extra_context):
|
|
sql, params = super().as_oracle(compiler, connection, **extra_context)
|
|
return "CASE %s WHEN 'TRUE' THEN 1 ELSE 0 END" % sql, params
|
|
|
|
|
|
class Length(DistanceResultMixin, OracleToleranceMixin, GeoFunc):
|
|
def __init__(self, expr1, spheroid=True, **extra):
|
|
self.spheroid = spheroid
|
|
super().__init__(expr1, **extra)
|
|
|
|
def as_sql(self, compiler, connection, **extra_context):
|
|
if self.geo_field.geodetic(connection) and not connection.features.supports_length_geodetic:
|
|
raise NotImplementedError("This backend doesn't support Length on geodetic fields")
|
|
return super().as_sql(compiler, connection, **extra_context)
|
|
|
|
def as_postgresql(self, compiler, connection):
|
|
function = None
|
|
if self.source_is_geography():
|
|
self.source_expressions.append(Value(self.spheroid))
|
|
elif self.geo_field.geodetic(connection):
|
|
# Geometry fields with geodetic (lon/lat) coordinates need length_spheroid
|
|
function = connection.ops.spatial_function_name('LengthSpheroid')
|
|
self.source_expressions.append(Value(self.geo_field.spheroid(connection)))
|
|
else:
|
|
dim = min(f.dim for f in self.get_source_fields() if f)
|
|
if dim > 2:
|
|
function = connection.ops.length3d
|
|
return super().as_sql(compiler, connection, function=function)
|
|
|
|
def as_sqlite(self, compiler, connection):
|
|
function = None
|
|
if self.geo_field.geodetic(connection):
|
|
function = 'GeodesicLength' if self.spheroid else 'GreatCircleLength'
|
|
return super().as_sql(compiler, connection, function=function)
|
|
|
|
|
|
class LineLocatePoint(GeoFunc):
|
|
output_field_class = FloatField
|
|
arity = 2
|
|
geom_param_pos = (0, 1)
|
|
|
|
|
|
class MakeValid(GeoFunc):
|
|
pass
|
|
|
|
|
|
class MemSize(GeoFunc):
|
|
output_field_class = IntegerField
|
|
arity = 1
|
|
|
|
|
|
class NumGeometries(GeoFunc):
|
|
output_field_class = IntegerField
|
|
arity = 1
|
|
|
|
|
|
class NumPoints(GeoFunc):
|
|
output_field_class = IntegerField
|
|
arity = 1
|
|
|
|
|
|
class Perimeter(DistanceResultMixin, OracleToleranceMixin, GeoFunc):
|
|
arity = 1
|
|
|
|
def as_postgresql(self, compiler, connection):
|
|
function = None
|
|
if self.geo_field.geodetic(connection) and not self.source_is_geography():
|
|
raise NotImplementedError("ST_Perimeter cannot use a non-projected non-geography field.")
|
|
dim = min(f.dim for f in self.get_source_fields())
|
|
if dim > 2:
|
|
function = connection.ops.perimeter3d
|
|
return super().as_sql(compiler, connection, function=function)
|
|
|
|
def as_sqlite(self, compiler, connection):
|
|
if self.geo_field.geodetic(connection):
|
|
raise NotImplementedError("Perimeter cannot use a non-projected field.")
|
|
return super().as_sql(compiler, connection)
|
|
|
|
|
|
class PointOnSurface(OracleToleranceMixin, GeomOutputGeoFunc):
|
|
arity = 1
|
|
|
|
|
|
class Reverse(GeoFunc):
|
|
arity = 1
|
|
|
|
|
|
class Scale(SQLiteDecimalToFloatMixin, GeomOutputGeoFunc):
|
|
def __init__(self, expression, x, y, z=0.0, **extra):
|
|
expressions = [
|
|
expression,
|
|
self._handle_param(x, 'x', NUMERIC_TYPES),
|
|
self._handle_param(y, 'y', NUMERIC_TYPES),
|
|
]
|
|
if z != 0.0:
|
|
expressions.append(self._handle_param(z, 'z', NUMERIC_TYPES))
|
|
super().__init__(*expressions, **extra)
|
|
|
|
|
|
class SnapToGrid(SQLiteDecimalToFloatMixin, GeomOutputGeoFunc):
|
|
def __init__(self, expression, *args, **extra):
|
|
nargs = len(args)
|
|
expressions = [expression]
|
|
if nargs in (1, 2):
|
|
expressions.extend(
|
|
[self._handle_param(arg, '', NUMERIC_TYPES) for arg in args]
|
|
)
|
|
elif nargs == 4:
|
|
# Reverse origin and size param ordering
|
|
expressions.extend(
|
|
[self._handle_param(arg, '', NUMERIC_TYPES) for arg in args[2:]]
|
|
)
|
|
expressions.extend(
|
|
[self._handle_param(arg, '', NUMERIC_TYPES) for arg in args[0:2]]
|
|
)
|
|
else:
|
|
raise ValueError('Must provide 1, 2, or 4 arguments to `SnapToGrid`.')
|
|
super().__init__(*expressions, **extra)
|
|
|
|
|
|
class SymDifference(OracleToleranceMixin, GeomOutputGeoFunc):
|
|
arity = 2
|
|
geom_param_pos = (0, 1)
|
|
|
|
|
|
class Transform(GeomOutputGeoFunc):
|
|
def __init__(self, expression, srid, **extra):
|
|
expressions = [
|
|
expression,
|
|
self._handle_param(srid, 'srid', int),
|
|
]
|
|
if 'output_field' not in extra:
|
|
extra['output_field'] = GeometryField(srid=srid)
|
|
super().__init__(*expressions, **extra)
|
|
|
|
|
|
class Translate(Scale):
|
|
def as_sqlite(self, compiler, connection):
|
|
if len(self.source_expressions) < 4:
|
|
# Always provide the z parameter for ST_Translate
|
|
self.source_expressions.append(Value(0))
|
|
return super().as_sqlite(compiler, connection)
|
|
|
|
|
|
class Union(OracleToleranceMixin, GeomOutputGeoFunc):
|
|
arity = 2
|
|
geom_param_pos = (0, 1)
|