1 /* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 4; tab-width: 4 -*- */
4 * Copyright (C) 2010, 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 2 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:viktmsmapsource
22 * @short_description: the class for TMS oriented map sources
24 * The #VikTmsMapSource class handles TMS oriented map sources.
26 * The tiles are in 'equirectangular'.
27 * http://en.wikipedia.org/wiki/Equirectangular_projection
29 * Such service is also a type of TMS (Tile Map Service) as defined in
31 * http://wiki.osgeo.org/wiki/Tile_Map_Service_Specification
32 * Following this specification, the protocol handled by this class
33 * follows the global-geodetic profile.
45 #include "viktmsmapsource.h"
48 static gboolean _coord_to_mapcoord ( VikMapSource *self, const VikCoord *src, gdouble xzoom, gdouble yzoom, MapCoord *dest );
49 static void _mapcoord_to_center_coord ( VikMapSource *self, MapCoord *src, VikCoord *dest );
50 static gboolean _supports_download_only_new ( VikMapSource *self );
51 static gboolean _is_direct_file_access ( VikMapSource *self );
52 static gboolean _is_mbtiles ( VikMapSource *self );
53 static gboolean _is_osm_meta_tiles (VikMapSource *self );
54 static guint8 _get_zoom_min(VikMapSource *self );
55 static guint8 _get_zoom_max(VikMapSource *self );
56 static gdouble _get_lat_min(VikMapSource *self );
57 static gdouble _get_lat_max(VikMapSource *self );
58 static gdouble _get_lon_min(VikMapSource *self );
59 static gdouble _get_lon_max(VikMapSource *self );
61 static gchar *_get_uri( VikMapSourceDefault *self, MapCoord *src );
62 static gchar *_get_hostname( VikMapSourceDefault *self );
63 static DownloadFileOptions *_get_download_options( VikMapSourceDefault *self );
65 typedef struct _VikTmsMapSourcePrivate VikTmsMapSourcePrivate;
66 struct _VikTmsMapSourcePrivate
70 DownloadFileOptions options;
71 guint zoom_min; // TMS Zoom level: 0 = Whole World // http://wiki.openstreetmap.org/wiki/Slippy_map_tilenames
72 guint zoom_max; // TMS Zoom level: Often 18 for zoomed in.
73 gdouble lat_min; // Degrees
74 gdouble lat_max; // Degrees
75 gdouble lon_min; // Degrees
76 gdouble lon_max; // Degrees
79 #define VIK_TMS_MAP_SOURCE_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), VIK_TYPE_TMS_MAP_SOURCE, VikTmsMapSourcePrivate))
90 PROP_CHECK_FILE_SERVER_TIME,
99 G_DEFINE_TYPE (VikTmsMapSource, vik_tms_map_source, VIK_TYPE_MAP_SOURCE_DEFAULT);
102 vik_tms_map_source_init (VikTmsMapSource *self)
104 /* initialize the object here */
105 VikTmsMapSourcePrivate *priv = VIK_TMS_MAP_SOURCE_PRIVATE (self);
107 priv->hostname = NULL;
109 priv->options.referer = NULL;
110 priv->options.follow_location = 0;
111 priv->options.check_file = a_check_map_file;
112 priv->options.check_file_server_time = FALSE;
115 priv->lat_min = -90.0;
116 priv->lat_max = 90.0;
117 priv->lon_min = -180.0;
118 priv->lon_max = 180.0;
120 g_object_set (G_OBJECT (self),
123 "drawmode", VIK_VIEWPORT_DRAWMODE_LATLON,
128 vik_tms_map_source_finalize (GObject *object)
130 VikTmsMapSource *self = VIK_TMS_MAP_SOURCE (object);
131 VikTmsMapSourcePrivate *priv = VIK_TMS_MAP_SOURCE_PRIVATE (self);
133 g_free (priv->hostname);
134 priv->hostname = NULL;
137 g_free (priv->options.referer);
138 priv->options.referer = NULL;
140 G_OBJECT_CLASS (vik_tms_map_source_parent_class)->finalize (object);
144 vik_tms_map_source_set_property (GObject *object,
149 VikTmsMapSource *self = VIK_TMS_MAP_SOURCE (object);
150 VikTmsMapSourcePrivate *priv = VIK_TMS_MAP_SOURCE_PRIVATE (self);
155 g_free (priv->hostname);
156 priv->hostname = g_value_dup_string (value);
161 priv->url = g_value_dup_string (value);
165 g_free (priv->options.referer);
166 priv->options.referer = g_value_dup_string (value);
169 case PROP_FOLLOW_LOCATION:
170 priv->options.follow_location = g_value_get_long (value);
173 case PROP_CHECK_FILE_SERVER_TIME:
174 priv->options.check_file_server_time = g_value_get_boolean (value);
178 priv->zoom_min = g_value_get_uint (value);
182 priv->zoom_max = g_value_get_uint (value);
186 priv->lat_min = g_value_get_double (value);
190 priv->lat_max = g_value_get_double (value);
194 priv->lon_min = g_value_get_double (value);
198 priv->lon_max = g_value_get_double (value);
202 /* We don't have any other property... */
203 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
209 vik_tms_map_source_get_property (GObject *object,
214 VikTmsMapSource *self = VIK_TMS_MAP_SOURCE (object);
215 VikTmsMapSourcePrivate *priv = VIK_TMS_MAP_SOURCE_PRIVATE (self);
220 g_value_set_string (value, priv->hostname);
224 g_value_set_string (value, priv->url);
228 g_value_set_string (value, priv->options.referer);
231 case PROP_FOLLOW_LOCATION:
232 g_value_set_long (value, priv->options.follow_location);
235 case PROP_CHECK_FILE_SERVER_TIME:
236 g_value_set_boolean (value, priv->options.check_file_server_time);
240 g_value_set_uint (value, priv->zoom_min);
244 g_value_set_uint (value, priv->zoom_max);
248 g_value_set_double (value, priv->lon_min);
252 g_value_set_double (value, priv->lon_max);
256 g_value_set_double (value, priv->lat_min);
260 g_value_set_double (value, priv->lat_max);
264 /* We don't have any other property... */
265 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
271 vik_tms_map_source_class_init (VikTmsMapSourceClass *klass)
273 GObjectClass* object_class = G_OBJECT_CLASS (klass);
274 VikMapSourceClass* grandparent_class = VIK_MAP_SOURCE_CLASS (klass);
275 VikMapSourceDefaultClass* parent_class = VIK_MAP_SOURCE_DEFAULT_CLASS (klass);
276 GParamSpec *pspec = NULL;
278 object_class->set_property = vik_tms_map_source_set_property;
279 object_class->get_property = vik_tms_map_source_get_property;
281 /* Overiding methods */
282 grandparent_class->coord_to_mapcoord = _coord_to_mapcoord;
283 grandparent_class->mapcoord_to_center_coord = _mapcoord_to_center_coord;
284 grandparent_class->supports_download_only_new = _supports_download_only_new;
285 grandparent_class->is_direct_file_access = _is_direct_file_access;
286 grandparent_class->is_mbtiles = _is_mbtiles;
287 grandparent_class->is_osm_meta_tiles = _is_osm_meta_tiles;
288 grandparent_class->get_zoom_min = _get_zoom_min;
289 grandparent_class->get_zoom_max = _get_zoom_max;
290 grandparent_class->get_lat_min = _get_lat_min;
291 grandparent_class->get_lat_max = _get_lat_max;
292 grandparent_class->get_lon_min = _get_lon_min;
293 grandparent_class->get_lon_max = _get_lon_max;
295 parent_class->get_uri = _get_uri;
296 parent_class->get_hostname = _get_hostname;
297 parent_class->get_download_options = _get_download_options;
299 pspec = g_param_spec_string ("hostname",
301 "The hostname of the map server",
302 "<no-set>" /* default value */,
303 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
304 g_object_class_install_property (object_class, PROP_HOSTNAME, pspec);
306 pspec = g_param_spec_string ("url",
308 "The template of the tiles' URL",
309 "<no-set>" /* default value */,
310 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
311 g_object_class_install_property (object_class, PROP_URL, pspec);
313 pspec = g_param_spec_string ("referer",
315 "The REFERER string to use in HTTP request",
316 NULL /* default value */,
317 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
318 g_object_class_install_property (object_class, PROP_REFERER, pspec);
320 pspec = g_param_spec_long ("follow-location",
322 "Specifies the number of retries to follow a redirect while downloading a page",
323 0 /* minimum value */,
324 G_MAXLONG /* maximum value */,
325 0 /* default value */,
326 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
327 g_object_class_install_property (object_class, PROP_FOLLOW_LOCATION, pspec);
329 pspec = g_param_spec_boolean ("check-file-server-time",
330 "Check file server time",
331 "Age of current cache before redownloading tile",
332 FALSE /* default value */,
333 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
334 g_object_class_install_property (object_class, PROP_CHECK_FILE_SERVER_TIME, pspec);
336 pspec = g_param_spec_uint ("zoom-min",
338 "Minimum Zoom level supported by the map provider",
342 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
343 g_object_class_install_property (object_class, PROP_ZOOM_MIN, pspec);
345 pspec = g_param_spec_uint ("zoom-max",
347 "Maximum Zoom level supported by the map provider",
351 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
352 g_object_class_install_property (object_class, PROP_ZOOM_MAX, pspec);
354 pspec = g_param_spec_double ("lat-min",
356 "Minimum latitude in degrees supported by the map provider",
357 -90.0, // minimum value
358 90.0, // maximum value
359 -90.0, // default value
360 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
361 g_object_class_install_property (object_class, PROP_LAT_MIN, pspec);
363 pspec = g_param_spec_double ("lat-max",
365 "Maximum latitude in degrees supported by the map provider",
366 -90.0, // minimum value
367 90.0, // maximum value
368 90.0, // default value
369 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
370 g_object_class_install_property (object_class, PROP_LAT_MAX, pspec);
372 pspec = g_param_spec_double ("lon-min",
374 "Minimum longitude in degrees supported by the map provider",
375 -180.0, // minimum value
376 180.0, // maximum value
377 -180.0, // default value
378 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
379 g_object_class_install_property (object_class, PROP_LON_MIN, pspec);
381 pspec = g_param_spec_double ("lon-max",
383 "Maximum longitude in degrees supported by the map provider",
384 -180.0, // minimum value
385 180.0, // maximum value
386 180.0, // default value
387 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
388 g_object_class_install_property (object_class, PROP_LON_MAX, pspec);
390 g_type_class_add_private (klass, sizeof (VikTmsMapSourcePrivate));
392 object_class->finalize = vik_tms_map_source_finalize;
396 _is_direct_file_access ( VikMapSource *self )
402 _is_mbtiles ( VikMapSource *self )
408 _is_osm_meta_tiles ( VikMapSource *self )
414 _supports_download_only_new ( VikMapSource *self )
416 g_return_val_if_fail (VIK_IS_TMS_MAP_SOURCE(self), FALSE);
418 VikTmsMapSourcePrivate *priv = VIK_TMS_MAP_SOURCE_PRIVATE(self);
420 return priv->options.check_file_server_time;
424 _coord_to_mapcoord ( VikMapSource *self, const VikCoord *src, gdouble xzoom, gdouble yzoom, MapCoord *dest )
426 g_assert ( src->mode == VIK_COORD_LATLON );
428 if ( xzoom != yzoom )
431 dest->scale = map_utils_mpp_to_scale ( xzoom );
432 if ( dest->scale == 255 )
435 /* Note : VIK_GZ(17) / xzoom / 2 = number of tile on Y axis */
436 g_debug("%s: xzoom=%f yzoom=%f -> %f", __FUNCTION__,
437 xzoom, yzoom, VIK_GZ(17) / xzoom / 2);
438 dest->x = floor((src->east_west + 180) / 180 * VIK_GZ(17) / xzoom / 2);
439 /* We should restore logic of viking:
440 * tile index on Y axis follow a screen logic (top -> down)
442 dest->y = floor((180 - (src->north_south + 90)) / 180 * VIK_GZ(17) / xzoom / 2);
444 g_debug("%s: %f,%f -> %d,%d", __FUNCTION__,
445 src->east_west, src->north_south, dest->x, dest->y);
450 _mapcoord_to_center_coord ( VikMapSource *self, MapCoord *src, VikCoord *dest )
452 gdouble socalled_mpp;
454 socalled_mpp = VIK_GZ(src->scale);
456 socalled_mpp = 1.0/VIK_GZ(-src->scale);
457 dest->mode = VIK_COORD_LATLON;
458 dest->east_west = (src->x+0.5) * 180 / VIK_GZ(17) * socalled_mpp * 2 - 180;
459 /* We should restore logic of viking:
460 * tile index on Y axis follow a screen logic (top -> down)
462 dest->north_south = -((src->y+0.5) * 180 / VIK_GZ(17) * socalled_mpp * 2 - 90);
463 g_debug("%s: %d,%d -> %f,%f", __FUNCTION__,
464 src->x, src->y, dest->east_west, dest->north_south);
468 _get_uri( VikMapSourceDefault *self, MapCoord *src )
470 g_return_val_if_fail (VIK_IS_TMS_MAP_SOURCE(self), NULL);
472 VikTmsMapSourcePrivate *priv = VIK_TMS_MAP_SOURCE_PRIVATE(self);
473 /* We should restore logic of viking:
474 * tile index on Y axis follow a screen logic (top -> down)
477 /* Note : nb tiles on Y axis */
478 gint nb_tiles = VIK_GZ(17 - src->scale - 1);
480 gchar *uri = g_strdup_printf (priv->url, 17 - src->scale - 1, src->x, nb_tiles - src->y - 1);
486 _get_hostname( VikMapSourceDefault *self )
488 g_return_val_if_fail (VIK_IS_TMS_MAP_SOURCE(self), NULL);
490 VikTmsMapSourcePrivate *priv = VIK_TMS_MAP_SOURCE_PRIVATE(self);
491 return g_strdup( priv->hostname );
494 static DownloadFileOptions *
495 _get_download_options( VikMapSourceDefault *self )
497 g_return_val_if_fail (VIK_IS_TMS_MAP_SOURCE(self), NULL);
499 VikTmsMapSourcePrivate *priv = VIK_TMS_MAP_SOURCE_PRIVATE(self);
500 return &(priv->options);
507 _get_zoom_min (VikMapSource *self)
509 g_return_val_if_fail (VIK_IS_TMS_MAP_SOURCE(self), FALSE);
510 VikTmsMapSourcePrivate *priv = VIK_TMS_MAP_SOURCE_PRIVATE(self);
511 return priv->zoom_min;
518 _get_zoom_max (VikMapSource *self)
520 g_return_val_if_fail (VIK_IS_TMS_MAP_SOURCE(self), FALSE);
521 VikTmsMapSourcePrivate *priv = VIK_TMS_MAP_SOURCE_PRIVATE(self);
522 return priv->zoom_max;
529 _get_lat_min (VikMapSource *self)
531 g_return_val_if_fail (VIK_IS_TMS_MAP_SOURCE(self), FALSE);
532 VikTmsMapSourcePrivate *priv = VIK_TMS_MAP_SOURCE_PRIVATE(self);
533 return priv->lat_min;
540 _get_lat_max (VikMapSource *self)
542 g_return_val_if_fail (VIK_IS_TMS_MAP_SOURCE(self), FALSE);
543 VikTmsMapSourcePrivate *priv = VIK_TMS_MAP_SOURCE_PRIVATE(self);
544 return priv->lat_max;
551 _get_lon_min (VikMapSource *self)
553 g_return_val_if_fail (VIK_IS_TMS_MAP_SOURCE(self), FALSE);
554 VikTmsMapSourcePrivate *priv = VIK_TMS_MAP_SOURCE_PRIVATE(self);
555 return priv->lon_min;
562 _get_lon_max (VikMapSource *self)
564 g_return_val_if_fail (VIK_IS_TMS_MAP_SOURCE(self), FALSE);
565 VikTmsMapSourcePrivate *priv = VIK_TMS_MAP_SOURCE_PRIVATE(self);
566 return priv->lon_max;
570 vik_tms_map_source_new_with_id (guint16 id, const gchar *label, const gchar *hostname, const gchar *url)
572 return g_object_new(VIK_TYPE_TMS_MAP_SOURCE,
573 "id", id, "label", label, "hostname", hostname, "url", url, NULL);