1 /* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 4; tab-width: 4 -*- */
4 * Copyright (C) 2009, Guilhem Bonnefille <guilhem.bonnefille@gmail.com>
6 * viking is free software: you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * viking is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
14 * See the GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program. If not, see <http://www.gnu.org/licenses/>.
21 * SECTION:vikslippymapsource
22 * @short_description: the class for SlippyMap oriented map sources
24 * The #VikSlippyMapSource class handles slippy map oriented map sources.
25 * The related service is tile oriented, à la Google.
27 * The tiles are in 'google spherical mercator', which is
28 * basically a mercator projection that assumes a spherical earth.
29 * http://docs.openlayers.org/library/spherical_mercator.html
31 * Such service is also a type of TMS (Tile Map Service) as defined in
33 * http://wiki.osgeo.org/wiki/Tile_Map_Service_Specification
34 * But take care that the Y axis is inverted, ie the origin is at top-left
36 * Following this specification, the protocol handled by this class
37 * follows the global-mercator profile.
39 * You can also find many interesting information on the OSM's wiki.
40 * http://wiki.openstreetmap.org/wiki/Slippy_map_tilenames
41 * http://wiki.openstreetmap.org/wiki/Setting_up_TMS
53 #include "vikslippymapsource.h"
56 static gboolean _coord_to_mapcoord ( VikMapSource *self, const VikCoord *src, gdouble xzoom, gdouble yzoom, MapCoord *dest );
57 static void _mapcoord_to_center_coord ( VikMapSource *self, MapCoord *src, VikCoord *dest );
59 static gboolean _is_direct_file_access (VikMapSource *self );
60 static gboolean _is_mbtiles (VikMapSource *self );
61 static gboolean _is_osm_meta_tiles (VikMapSource *self );
62 static gboolean _supports_download_only_new (VikMapSource *self );
63 static guint8 _get_zoom_min(VikMapSource *self );
64 static guint8 _get_zoom_max(VikMapSource *self );
65 static gdouble _get_lat_min(VikMapSource *self );
66 static gdouble _get_lat_max(VikMapSource *self );
67 static gdouble _get_lon_min(VikMapSource *self );
68 static gdouble _get_lon_max(VikMapSource *self );
70 static gchar *_get_uri( VikMapSourceDefault *self, MapCoord *src );
71 static gchar *_get_hostname( VikMapSourceDefault *self );
72 static DownloadMapOptions *_get_download_options( VikMapSourceDefault *self );
74 typedef struct _VikSlippyMapSourcePrivate VikSlippyMapSourcePrivate;
75 struct _VikSlippyMapSourcePrivate
79 DownloadMapOptions options;
80 // NB Probably best to keep the above fields in same order to be common across Slippy, TMS & WMS map definitions
81 guint zoom_min; // TMS Zoom level: 0 = Whole World // http://wiki.openstreetmap.org/wiki/Slippy_map_tilenames
82 guint zoom_max; // TMS Zoom level: Often 18 for zoomed in.
83 gdouble lat_min; // Degrees
84 gdouble lat_max; // Degrees
85 gdouble lon_min; // Degrees
86 gdouble lon_max; // Degrees
87 gboolean is_direct_file_access;
89 gboolean is_osm_meta_tiles; // http://wiki.openstreetmap.org/wiki/Meta_tiles as used by tirex or renderd
90 // Mainly for ARCGIS Tile Server URL Layout // http://help.arcgis.com/EN/arcgisserver/10.0/apis/rest/tile.html
94 #define VIK_SLIPPY_MAP_SOURCE_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), VIK_TYPE_SLIPPY_MAP_SOURCE, VikSlippyMapSourcePrivate))
110 PROP_FOLLOW_LOCATION,
111 PROP_CHECK_FILE_SERVER_TIME,
113 PROP_IS_DIRECT_FILE_ACCESS,
115 PROP_IS_OSM_META_TILES,
119 G_DEFINE_TYPE (VikSlippyMapSource, vik_slippy_map_source, VIK_TYPE_MAP_SOURCE_DEFAULT);
122 vik_slippy_map_source_init (VikSlippyMapSource *self)
124 /* initialize the object here */
125 VikSlippyMapSourcePrivate *priv = VIK_SLIPPY_MAP_SOURCE_PRIVATE (self);
127 priv->hostname = NULL;
131 priv->lat_min = -90.0;
132 priv->lat_max = 90.0;
133 priv->lon_min = -180.0;
134 priv->lon_max = 180.0;
135 priv->options.referer = NULL;
136 priv->options.follow_location = 0;
137 priv->options.check_file = a_check_map_file;
138 priv->options.check_file_server_time = FALSE;
139 priv->options.use_etag = FALSE;
140 priv->is_direct_file_access = FALSE;
141 priv->is_mbtiles = FALSE;
142 priv->is_osm_meta_tiles = FALSE;
143 priv->switch_xy = FALSE;
145 g_object_set (G_OBJECT (self),
148 "drawmode", VIK_VIEWPORT_DRAWMODE_MERCATOR,
153 vik_slippy_map_source_finalize (GObject *object)
155 VikSlippyMapSource *self = VIK_SLIPPY_MAP_SOURCE (object);
156 VikSlippyMapSourcePrivate *priv = VIK_SLIPPY_MAP_SOURCE_PRIVATE (self);
158 g_free (priv->hostname);
159 priv->hostname = NULL;
162 g_free (priv->options.referer);
163 priv->options.referer = NULL;
165 G_OBJECT_CLASS (vik_slippy_map_source_parent_class)->finalize (object);
169 vik_slippy_map_source_set_property (GObject *object,
174 VikSlippyMapSource *self = VIK_SLIPPY_MAP_SOURCE (object);
175 VikSlippyMapSourcePrivate *priv = VIK_SLIPPY_MAP_SOURCE_PRIVATE (self);
180 g_free (priv->hostname);
181 priv->hostname = g_value_dup_string (value);
186 priv->url = g_value_dup_string (value);
190 priv->zoom_min = g_value_get_uint (value);
194 priv->zoom_max = g_value_get_uint (value);
198 priv->lat_min = g_value_get_double (value);
202 priv->lat_max = g_value_get_double (value);
206 priv->lon_min = g_value_get_double (value);
210 priv->lon_max = g_value_get_double (value);
214 g_free (priv->options.referer);
215 priv->options.referer = g_value_dup_string (value);
218 case PROP_FOLLOW_LOCATION:
219 priv->options.follow_location = g_value_get_long (value);
222 case PROP_CHECK_FILE_SERVER_TIME:
223 priv->options.check_file_server_time = g_value_get_boolean (value);
227 priv->options.use_etag = g_value_get_boolean (value);
230 case PROP_IS_DIRECT_FILE_ACCESS:
231 priv->is_direct_file_access = g_value_get_boolean (value);
234 case PROP_IS_MBTILES:
235 priv->is_mbtiles = g_value_get_boolean (value);
238 case PROP_IS_OSM_META_TILES:
239 priv->is_osm_meta_tiles = g_value_get_boolean (value);
243 priv->switch_xy = g_value_get_boolean (value);
247 /* We don't have any other property... */
248 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
254 vik_slippy_map_source_get_property (GObject *object,
259 VikSlippyMapSource *self = VIK_SLIPPY_MAP_SOURCE (object);
260 VikSlippyMapSourcePrivate *priv = VIK_SLIPPY_MAP_SOURCE_PRIVATE (self);
265 g_value_set_string (value, priv->hostname);
269 g_value_set_string (value, priv->url);
273 g_value_set_uint (value, priv->zoom_min);
277 g_value_set_uint (value, priv->zoom_max);
281 g_value_set_double (value, priv->lon_min);
285 g_value_set_double (value, priv->lon_max);
289 g_value_set_double (value, priv->lat_min);
293 g_value_set_double (value, priv->lat_max);
297 g_value_set_string (value, priv->options.referer);
300 case PROP_FOLLOW_LOCATION:
301 g_value_set_long (value, priv->options.follow_location);
304 case PROP_CHECK_FILE_SERVER_TIME:
305 g_value_set_boolean (value, priv->options.check_file_server_time);
309 g_value_set_boolean (value, priv->options.use_etag);
312 case PROP_IS_DIRECT_FILE_ACCESS:
313 g_value_set_boolean (value, priv->is_direct_file_access);
316 case PROP_IS_MBTILES:
317 g_value_set_boolean (value, priv->is_mbtiles);
320 case PROP_IS_OSM_META_TILES:
321 g_value_set_boolean (value, priv->is_osm_meta_tiles);
325 g_value_set_boolean (value, priv->switch_xy);
329 /* We don't have any other property... */
330 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
336 vik_slippy_map_source_class_init (VikSlippyMapSourceClass *klass)
338 GObjectClass* object_class = G_OBJECT_CLASS (klass);
339 VikMapSourceClass* grandparent_class = VIK_MAP_SOURCE_CLASS (klass);
340 VikMapSourceDefaultClass* parent_class = VIK_MAP_SOURCE_DEFAULT_CLASS (klass);
341 GParamSpec *pspec = NULL;
343 object_class->set_property = vik_slippy_map_source_set_property;
344 object_class->get_property = vik_slippy_map_source_get_property;
346 /* Overiding methods */
347 grandparent_class->coord_to_mapcoord = _coord_to_mapcoord;
348 grandparent_class->mapcoord_to_center_coord = _mapcoord_to_center_coord;
349 grandparent_class->is_direct_file_access = _is_direct_file_access;
350 grandparent_class->is_mbtiles = _is_mbtiles;
351 grandparent_class->is_osm_meta_tiles = _is_osm_meta_tiles;
352 grandparent_class->supports_download_only_new = _supports_download_only_new;
353 grandparent_class->get_zoom_min = _get_zoom_min;
354 grandparent_class->get_zoom_max = _get_zoom_max;
355 grandparent_class->get_lat_min = _get_lat_min;
356 grandparent_class->get_lat_max = _get_lat_max;
357 grandparent_class->get_lon_min = _get_lon_min;
358 grandparent_class->get_lon_max = _get_lon_max;
360 parent_class->get_uri = _get_uri;
361 parent_class->get_hostname = _get_hostname;
362 parent_class->get_download_options = _get_download_options;
364 pspec = g_param_spec_string ("hostname",
366 "The hostname of the map server",
367 "<no-set>" /* default value */,
369 g_object_class_install_property (object_class, PROP_HOSTNAME, pspec);
371 pspec = g_param_spec_string ("url",
373 "The template of the tiles' URL",
374 "<no-set>" /* default value */,
376 g_object_class_install_property (object_class, PROP_URL, pspec);
378 pspec = g_param_spec_uint ("zoom-min",
380 "Minimum Zoom level supported by the map provider",
384 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
385 g_object_class_install_property (object_class, PROP_ZOOM_MIN, pspec);
387 pspec = g_param_spec_uint ("zoom-max",
389 "Maximum Zoom level supported by the map provider",
393 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
394 g_object_class_install_property (object_class, PROP_ZOOM_MAX, pspec);
396 pspec = g_param_spec_double ("lat-min",
398 "Minimum latitude in degrees supported by the map provider",
399 -90.0, // minimum value
400 90.0, // maximum value
401 -90.0, // default value
402 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
403 g_object_class_install_property (object_class, PROP_LAT_MIN, pspec);
405 pspec = g_param_spec_double ("lat-max",
407 "Maximum latitude in degrees supported by the map provider",
408 -90.0, // minimum value
409 90.0, // maximum value
410 90.0, // default value
411 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
412 g_object_class_install_property (object_class, PROP_LAT_MAX, pspec);
414 pspec = g_param_spec_double ("lon-min",
416 "Minimum longitude in degrees supported by the map provider",
417 -180.0, // minimum value
418 180.0, // maximum value
419 -180.0, // default value
420 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
421 g_object_class_install_property (object_class, PROP_LON_MIN, pspec);
423 pspec = g_param_spec_double ("lon-max",
425 "Maximum longitude in degrees supported by the map provider",
426 -180.0, // minimum value
427 180.0, // maximum value
428 180.0, // default value
429 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
430 g_object_class_install_property (object_class, PROP_LON_MAX, pspec);
432 pspec = g_param_spec_string ("referer",
434 "The REFERER string to use in HTTP request",
435 NULL /* default value */,
436 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
437 g_object_class_install_property (object_class, PROP_REFERER, pspec);
439 pspec = g_param_spec_long ("follow-location",
441 "Specifies the number of retries to follow a redirect while downloading a page",
442 0 /* minimum value */,
443 G_MAXLONG /* maximum value */,
444 0 /* default value */,
445 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
446 g_object_class_install_property (object_class, PROP_FOLLOW_LOCATION, pspec);
448 pspec = g_param_spec_boolean ("check-file-server-time",
449 "Check file server time",
450 "Age of current cache before redownloading tile",
451 FALSE /* default value */,
452 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
453 g_object_class_install_property (object_class, PROP_CHECK_FILE_SERVER_TIME, pspec);
455 pspec = g_param_spec_boolean ("use-etag",
456 "Use etag values with server",
457 "Store etag in a file, and send it to server to check if we have the latest file",
458 FALSE /* default value */,
459 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
460 g_object_class_install_property (object_class, PROP_USE_ETAG, pspec);
462 pspec = g_param_spec_boolean ("use-direct-file-access",
463 "Use direct file access",
464 "Use direct file access to OSM like tile images - no need for a webservice",
465 FALSE /* default value */,
466 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
467 g_object_class_install_property (object_class, PROP_IS_DIRECT_FILE_ACCESS, pspec);
469 pspec = g_param_spec_boolean ("is-mbtiles",
470 "Is an SQL MBTiles File",
471 "Use an SQL MBTiles File for the tileset - no need for a webservice",
472 FALSE /* default value */,
473 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
474 g_object_class_install_property (object_class, PROP_IS_MBTILES, pspec);
476 pspec = g_param_spec_boolean ("is-osm-meta-tiles",
477 "Is in OSM Meta Tile format",
478 "Read from OSM Meta Tiles - Should be 'use-direct-file-access' as well",
479 FALSE /* default value */,
480 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
481 g_object_class_install_property (object_class, PROP_IS_OSM_META_TILES, pspec);
483 pspec = g_param_spec_boolean ("switch-xy",
484 "Switch the order of x,y components in the URL",
485 "Switch the order of x,y components in the URL (such as used by ARCGIS Tile Server",
486 FALSE /* default value */,
487 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
488 g_object_class_install_property (object_class, PROP_SWITCH_XY, pspec);
490 g_type_class_add_private (klass, sizeof (VikSlippyMapSourcePrivate));
492 object_class->finalize = vik_slippy_map_source_finalize;
496 _is_direct_file_access (VikMapSource *self)
498 g_return_val_if_fail (VIK_IS_SLIPPY_MAP_SOURCE(self), FALSE);
500 VikSlippyMapSourcePrivate *priv = VIK_SLIPPY_MAP_SOURCE_PRIVATE(self);
502 return priv->is_direct_file_access;
506 _is_mbtiles (VikMapSource *self)
508 g_return_val_if_fail (VIK_IS_SLIPPY_MAP_SOURCE(self), FALSE);
510 VikSlippyMapSourcePrivate *priv = VIK_SLIPPY_MAP_SOURCE_PRIVATE(self);
512 return priv->is_mbtiles;
519 _is_osm_meta_tiles (VikMapSource *self)
521 g_return_val_if_fail (VIK_IS_SLIPPY_MAP_SOURCE(self), FALSE);
522 VikSlippyMapSourcePrivate *priv = VIK_SLIPPY_MAP_SOURCE_PRIVATE(self);
523 return priv->is_osm_meta_tiles;
527 _supports_download_only_new (VikMapSource *self)
529 g_return_val_if_fail (VIK_IS_SLIPPY_MAP_SOURCE(self), FALSE);
531 VikSlippyMapSourcePrivate *priv = VIK_SLIPPY_MAP_SOURCE_PRIVATE(self);
533 return priv->options.check_file_server_time || priv->options.use_etag;
540 _get_zoom_min (VikMapSource *self)
542 g_return_val_if_fail (VIK_IS_SLIPPY_MAP_SOURCE(self), FALSE);
543 VikSlippyMapSourcePrivate *priv = VIK_SLIPPY_MAP_SOURCE_PRIVATE(self);
544 return priv->zoom_min;
551 _get_zoom_max (VikMapSource *self)
553 g_return_val_if_fail (VIK_IS_SLIPPY_MAP_SOURCE(self), FALSE);
554 VikSlippyMapSourcePrivate *priv = VIK_SLIPPY_MAP_SOURCE_PRIVATE(self);
555 return priv->zoom_max;
562 _get_lat_min (VikMapSource *self)
564 g_return_val_if_fail (VIK_IS_SLIPPY_MAP_SOURCE(self), FALSE);
565 VikSlippyMapSourcePrivate *priv = VIK_SLIPPY_MAP_SOURCE_PRIVATE(self);
566 return priv->lat_min;
573 _get_lat_max (VikMapSource *self)
575 g_return_val_if_fail (VIK_IS_SLIPPY_MAP_SOURCE(self), FALSE);
576 VikSlippyMapSourcePrivate *priv = VIK_SLIPPY_MAP_SOURCE_PRIVATE(self);
577 return priv->lat_max;
584 _get_lon_min (VikMapSource *self)
586 g_return_val_if_fail (VIK_IS_SLIPPY_MAP_SOURCE(self), FALSE);
587 VikSlippyMapSourcePrivate *priv = VIK_SLIPPY_MAP_SOURCE_PRIVATE(self);
588 return priv->lon_min;
595 _get_lon_max (VikMapSource *self)
597 g_return_val_if_fail (VIK_IS_SLIPPY_MAP_SOURCE(self), FALSE);
598 VikSlippyMapSourcePrivate *priv = VIK_SLIPPY_MAP_SOURCE_PRIVATE(self);
599 return priv->lon_max;
603 _coord_to_mapcoord ( VikMapSource *self, const VikCoord *src, gdouble xzoom, gdouble yzoom, MapCoord *dest )
605 g_assert ( src->mode == VIK_COORD_LATLON );
607 if ( xzoom != yzoom )
610 dest->scale = map_utils_mpp_to_scale ( xzoom );
611 if ( dest->scale == 255 )
614 dest->x = (src->east_west + 180) / 360 * VIK_GZ(17) / xzoom;
615 dest->y = (180 - MERCLAT(src->north_south)) / 360 * VIK_GZ(17) / xzoom;
622 _mapcoord_to_center_coord ( VikMapSource *self, MapCoord *src, VikCoord *dest )
624 gdouble socalled_mpp;
626 socalled_mpp = VIK_GZ(src->scale);
628 socalled_mpp = 1.0/VIK_GZ(-src->scale);
629 dest->mode = VIK_COORD_LATLON;
630 dest->east_west = ((src->x+0.5) / VIK_GZ(17) * socalled_mpp * 360) - 180;
631 dest->north_south = DEMERCLAT(180 - ((src->y+0.5) / VIK_GZ(17) * socalled_mpp * 360));
635 _get_uri( VikMapSourceDefault *self, MapCoord *src )
637 g_return_val_if_fail (VIK_IS_SLIPPY_MAP_SOURCE(self), NULL);
639 VikSlippyMapSourcePrivate *priv = VIK_SLIPPY_MAP_SOURCE_PRIVATE(self);
642 if ( priv->switch_xy )
643 // 'ARC GIS' Tile Server layout ordering
644 uri = g_strdup_printf (priv->url, 17 - src->scale, src->y, src->x);
646 // (Default) Standard OSM Tile Server layout ordering
647 uri = g_strdup_printf (priv->url, 17 - src->scale, src->x, src->y);
653 _get_hostname( VikMapSourceDefault *self )
655 g_return_val_if_fail (VIK_IS_SLIPPY_MAP_SOURCE(self), NULL);
657 VikSlippyMapSourcePrivate *priv = VIK_SLIPPY_MAP_SOURCE_PRIVATE(self);
658 return g_strdup( priv->hostname );
661 static DownloadMapOptions *
662 _get_download_options( VikMapSourceDefault *self )
664 g_return_val_if_fail (VIK_IS_SLIPPY_MAP_SOURCE(self), NULL);
666 VikSlippyMapSourcePrivate *priv = VIK_SLIPPY_MAP_SOURCE_PRIVATE(self);
667 return &(priv->options);
671 vik_slippy_map_source_new_with_id (guint16 id, const gchar *label, const gchar *hostname, const gchar *url)
673 return g_object_new(VIK_TYPE_SLIPPY_MAP_SOURCE,
674 "id", id, "label", label, "hostname", hostname, "url", url, NULL);