From b74f5ef66f019eaf5e2d4ce206064b30c41f6a75 Mon Sep 17 00:00:00 2001 From: Justin Bronn Date: Wed, 12 Sep 2007 13:04:33 +0000 Subject: [PATCH] gis: added the beginnings of a `maps` module, for generating mapping framework JavaScript; cleaned up the sitemaps module and KML templates; added shortcuts module. git-svn-id: http://code.djangoproject.com/svn/django/branches/gis@6108 bcc190cf-cafb-0310-a4f2-bffc1f526a37 --- django/contrib/gis/maps/__init__.py | 0 django/contrib/gis/maps/google/__init__.py | 60 +++++++ django/contrib/gis/maps/google/gmap.py | 100 +++++++++++ django/contrib/gis/maps/google/zoom.py | 164 ++++++++++++++++++ .../contrib/gis/maps/openlayers/__init__.py | 0 django/contrib/gis/shortcuts.py | 12 ++ django/contrib/gis/sitemaps.py | 19 +- .../gis/templates/gis/google/js/google-map.js | 16 ++ django/contrib/gis/templates/gis/kml.xml | 10 -- django/contrib/gis/templates/gis/kml/base.kml | 6 + .../gis/templates/gis/kml/placemarks.kml | 8 + 11 files changed, 372 insertions(+), 23 deletions(-) create mode 100644 django/contrib/gis/maps/__init__.py create mode 100644 django/contrib/gis/maps/google/__init__.py create mode 100644 django/contrib/gis/maps/google/gmap.py create mode 100644 django/contrib/gis/maps/google/zoom.py create mode 100644 django/contrib/gis/maps/openlayers/__init__.py create mode 100644 django/contrib/gis/shortcuts.py create mode 100644 django/contrib/gis/templates/gis/google/js/google-map.js delete mode 100644 django/contrib/gis/templates/gis/kml.xml create mode 100644 django/contrib/gis/templates/gis/kml/base.kml create mode 100644 django/contrib/gis/templates/gis/kml/placemarks.kml diff --git a/django/contrib/gis/maps/__init__.py b/django/contrib/gis/maps/__init__.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/django/contrib/gis/maps/google/__init__.py b/django/contrib/gis/maps/google/__init__.py new file mode 100644 index 0000000000..ec3d372453 --- /dev/null +++ b/django/contrib/gis/maps/google/__init__.py @@ -0,0 +1,60 @@ +""" + This module houses the GoogleMap object, used for generating + the needed javascript to embed Google Maps in a webpage. + + Google(R) is a registered trademark of Google, Inc. of Mountain View, California. + + Example: + + * In the view: + return render_to_response('template.html', {'google' : GoogleMap(key="abcdefg")}) + + * In the template: + + + {{ google.xhtml }} + + Google Maps via GeoDjango + {{ google.style }} + {{ google.scripts }} + + {{ google.body }} +
+ + + + Note: If you want to be more explicit in your templates, the following are + equivalent: + {{ google.body }} => "" + {{ google.xhtml }} => "" + {{ google.style }} => "" + + Explanation: + - The `xhtml` property provides the correct XML namespace needed for + Google Maps to operate in IE using XHTML. Google Maps on IE uses + VML to draw polylines. Returns, by default: + + + - The `style` property provides the correct style tag for the CSS + properties required by Google Maps on IE: + + + - The `scripts` property provides the necessary ' % (self._url, self._key) + + @property + def scripts(self): + "Returns all tags required for Google Maps JavaScript." + return '%s\n ' % (self.api_script, self.js) + + @property + def style(self): + "Returns additional CSS styling needed for Google Maps on IE." + return '' % self.vml_css + + @property + def xhtml(self): + "Returns XHTML information needed for IE VML overlays." + return '' % self.xmlns diff --git a/django/contrib/gis/maps/google/zoom.py b/django/contrib/gis/maps/google/zoom.py new file mode 100644 index 0000000000..16b18ac555 --- /dev/null +++ b/django/contrib/gis/maps/google/zoom.py @@ -0,0 +1,164 @@ +from django.contrib.gis.geos import GEOSGeometry, LinearRing, Polygon, Point +from django.contrib.gis.maps.google.gmap import GoogleMapException +from math import pi, sin, cos, log, exp, atan + +# Constants used for degree to radian conversion, and vice-versa. +DTOR = pi / 180. +RTOD = 180. / pi + +def get_width_height(envelope): + # Getting the lower-left, upper-left, and upper-right + # coordinates of the envelope. + ll = Point(envelope[0][0]) + ul = Point(envelope[0][1]) + ur = Point(envelope[0][2]) + + height = ll.distance(ul) + width = ul.distance(ur) + return width, height + +class GoogleZoom(object): + """ + GoogleZoom is a utility for performing operations related to the zoom + levels on Google Maps. + + This class is inspired by the OpenStreetMap Mapnik tile generation routine + `generate_tiles.py`, and the article "How Big Is the World" (Hack #16) in + "Google Maps Hacks" by Rich Gibson and Schuyler Erle. + + `generate_tiles.py` may be found at: + http://trac.openstreetmap.org/browser/applications/rendering/mapnik/generate_tiles.py + + "Google Maps Hacks" may be found at http://safari.oreilly.com/0596101619 + """ + + def __init__(self, num_zoom=19, tilesize=256): + "Initializes the Google Zoom object." + + # Google's tilesize is 256x256, square tiles are assumed. + self._tilesize = tilesize + + # The number of zoom levels + self._nzoom = num_zoom + + # Initializing arrays to hold the parameters for each + # one of the zoom levels. + self._degpp = [] # Degrees per pixel + self._radpp = [] # Radians per pixel + self._npix = [] # 1/2 the number of pixels for a tile at the given zoom level + + # Incrementing through the zoom levels and populating the + # parameter arrays. + z = tilesize # The number of pixels per zoom level. + for i in xrange(num_zoom): + # Getting the degrees and radians per pixel, and the 1/2 the number of + # for every zoom level. + self._degpp.append(z / 360.) # degrees per pixel + self._radpp.append(z / (2 * pi)) # radians per pixl + self._npix.append(z / 2) # number of pixels to center of tile + + # Multiplying `z` by 2 for the next iteration. + z *= 2 + + def __len__(self): + "Returns the number of zoom levels." + return self._nzoom + + def get_lon_lat(self, lonlat): + "Unpacks longitude, latitude from GEOS Points and 2-tuples." + if isinstance(lonlat, Point): + lon, lat = lonlat.coords + else: + lon, lat = lonlat + return lon, lat + + def lonlat_to_pixel(self, lonlat, zoom): + "Converts a longitude, latitude coordinate pair for the given zoom level." + # Setting up, unpacking the longitude, latitude values and getting the + # number of pixels for the given zoom level. + lon, lat = self.get_lon_lat(lonlat) + npix = self._npix[zoom] + + # Calculating the pixel x coordinate by multiplying the longitude + # value with with the number of degrees/pixel at the given + # zoom level. + px_x = round(npix + (lon * self._degpp[zoom])) + + # Creating the factor, and ensuring that 1 or -1 is not passed in as the + # base to the logarithm. Here's why: + # if fac = -1, we'll get log(0) which is undefined; + # if fac = 1, our logarithm base will be divided by 0, also undefined. + fac = min(max(sin(DTOR * lat), -0.9999), 0.9999) + + # Calculating the pixel y coordinate. + px_y = round(npix + (0.5 * log((1 + fac)/(1 - fac)) * (-1.0 * self._radpp[zoom]))) + + # Returning the pixel x, y to the caller of the function. + return (px_x, px_y) + + def pixel_to_lonlat(self, px, zoom): + "Converts a pixel to a longitude, latitude pair at the given zoom level." + if len(px) != 2: + raise TypeError, 'Pixel should be a sequence of two elements.' + + # Getting the number of pixels for the given zoom level. + npix = self._npix[zoom] + + # Calculating the longitude value, using the degrees per pixel. + lon = (px[0] - npix) / self._degpp[zoom] + + # Calculating the latitude value. + lat = RTOD * ( 2 * atan(exp((px[1] - npix)/ (-1.0 * self._radpp[zoom]))) - 0.5 * pi) + + # Returning the longitude, latitude coordinate pair. + return (lon, lat) + + def tile(self, lonlat, zoom): + """ + Returns a Polygon corresponding to the region represented by a fictional + Google Tile for the given longitude/latitude pair and zoom level. This + tile is used to determine the size of a tile at the given point. + """ + # The given lonlat is the center of the tile. + delta = self._tilesize / 2 + + # Getting the pixel coordinates corresponding to the + # the longitude/latitude. + px = self.lonlat_to_pixel(lonlat, zoom) + + # Getting the lower-left and upper-right lat/lon coordinates + # for the bounding box of the tile. + ll = self.pixel_to_lonlat((px[0]-delta, px[1]-delta), zoom) + ur = self.pixel_to_lonlat((px[0]+delta, px[1]+delta), zoom) + + # Constructing the Polygon, representing the tile and returning. + return Polygon(LinearRing(ll, (ll[0], ur[1]), ur, (ur[0], ll[1]), ll), srid=4326) + + def get_zoom(self, geom): + "Returns the optimal Zoom level for the given geometry." + + # Checking the input type. + if not isinstance(geom, GEOSGeometry) and geom.srid == 4326: + raise TypeError, 'get_zoom() expects a GEOS Geometry with an SRID of 4326.' + + # Getting the envelope for the geometry, and its associated width, height + # and centroid. + env = geom.envelope + env_w, env_h = get_width_height(env) + center = env.centroid + + for z in xrange(self._nzoom): + # Getting the tile at the zoom level. + tile = self.tile(center, z) + tile_w, tile_h = get_width_height(tile) + + # When we span more than one tile, this is an approximately good + # zoom level. + if (env_w > tile_w) or (env_h > tile_h): + if z == 0: + raise GoogleMapException, \ + 'Geometry width and height should not exceed that of the Earth.' + return z-1 + + # Otherwise, we've zoomed in to the max. + return self._nzoom-1 diff --git a/django/contrib/gis/maps/openlayers/__init__.py b/django/contrib/gis/maps/openlayers/__init__.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/django/contrib/gis/shortcuts.py b/django/contrib/gis/shortcuts.py new file mode 100644 index 0000000000..8eeaed1aaa --- /dev/null +++ b/django/contrib/gis/shortcuts.py @@ -0,0 +1,12 @@ +from django.http import HttpResponse +from django.template import loader + +def render_to_kml(*args, **kwargs): + "Renders the response using the MIME type for KML." + return HttpResponse(loader.render_to_string(*args, **kwargs), + mimetype='application/vnd.google-earth.kml+xml kml') + +def render_to_text(*args, **kwargs): + "Renders the response using the MIME type for plain text." + return HttpResponse(loader.render_to_string(*args, **kwargs), + mimetype='text/plain') diff --git a/django/contrib/gis/sitemaps.py b/django/contrib/gis/sitemaps.py index 1ce0493472..d5d11b9c0f 100644 --- a/django/contrib/gis/sitemaps.py +++ b/django/contrib/gis/sitemaps.py @@ -1,18 +1,13 @@ from django.core import urlresolvers from django.contrib.sitemaps import Sitemap from django.contrib.gis.db.models.fields import GeometryField +from django.contrib.gis.shortcuts import render_to_kml from django.db.models import get_model, get_models -from django.template.loader import get_template -from django.template import Context from django.http import HttpResponse -kml_files = [('gis.school', 'location'), - ('gis.district', 'boundary')] - - class KMLSitemap(Sitemap): """ - A minimal hook to + A minimal hook to produce KML sitemaps. """ def __init__(self, locations=None): if locations is None: @@ -28,7 +23,6 @@ class KMLSitemap(Sitemap): kwargs={'label':obj[0], 'field_name':obj[1]}) - def _build_kml_sources(): "Make a mapping of all available KML sources." ret = [] @@ -45,18 +39,17 @@ def _build_kml_sources(): class KMLNotFound(Exception): pass - def kml(request, label, field_name): placemarks = [] klass = get_model(*label.split('.')) if not klass: raise KMLNotFound("You must supply a valid app.model label. Got %s" % label) + #FIXME: GMaps apparently has a limit on size of displayed kml files # check if paginating w/ external refs (i.e. linked list) helps. placemarks.extend(list(klass._default_manager.kml(field_name)[:100])) + #FIXME: other KML features? - t = get_template('gis/kml.xml') - c = Context({'places':placemarks}) - - return HttpResponse(t.render(c), mimetype='application/vnd.google-earth.kml+xml') + return render_to_kml('gis/kml/placemarks.kml', {'places' : placemarks}) + diff --git a/django/contrib/gis/templates/gis/google/js/google-map.js b/django/contrib/gis/templates/gis/google/js/google-map.js new file mode 100644 index 0000000000..cb78acf5a8 --- /dev/null +++ b/django/contrib/gis/templates/gis/google/js/google-map.js @@ -0,0 +1,16 @@ +{% block vars %}var map;{% for kml_url in kml_urls %}var kml{{ forloop.counter }};{% endfor %}{% endblock %} +{% block functions %}{% endblock %} +{% block load %}function {{ load_func }}(){ + if (GBrowserIsCompatible()) { + map = new GMap2(document.getElementById("{{ dom_id }}")); + map.addControl(new GSmallMapControl()); + map.addControl(new GMapTypeControl()); + map.setCenter(new GLatLng({{ center_lat }}, {{ center_lon }}), {{ zoom }}); + {% for kml_url in kml_urls %}kml{{ forloop.counter }} = new GGeoXml("{{ kml_url }}"); + map.addOverlay(kml{{ forloop.counter }});{% endfor %} + {% block load_extra %}{% endblock %} + }else { + alert("Sorry, the Google Maps API is not compatible with this browser."); + } +} +{% endblock %} \ No newline at end of file diff --git a/django/contrib/gis/templates/gis/kml.xml b/django/contrib/gis/templates/gis/kml.xml deleted file mode 100644 index 7d121c2aa1..0000000000 --- a/django/contrib/gis/templates/gis/kml.xml +++ /dev/null @@ -1,10 +0,0 @@ - - - {% for place in places %} - - {{ place.name|escape }} - {{ place.description|escape }} - {{ place.kml }} - - {% endfor %} - diff --git a/django/contrib/gis/templates/gis/kml/base.kml b/django/contrib/gis/templates/gis/kml/base.kml new file mode 100644 index 0000000000..374404c39f --- /dev/null +++ b/django/contrib/gis/templates/gis/kml/base.kml @@ -0,0 +1,6 @@ + + +{% block name %}{% endblock %} +{% block placemarks %}{% endblock %} + + diff --git a/django/contrib/gis/templates/gis/kml/placemarks.kml b/django/contrib/gis/templates/gis/kml/placemarks.kml new file mode 100644 index 0000000000..2b9b5e2f02 --- /dev/null +++ b/django/contrib/gis/templates/gis/kml/placemarks.kml @@ -0,0 +1,8 @@ +{% extends "gis/kml/base.kml" %} +{% block placemarks %}{% for place in places %} + + {{ place.name|escape }} + {{ place.description|escape }} + {{ place.kml }} + {% endfor %}{% endblock %} +