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:vikwmscmapsource
22 * @short_description: the class for WMS/WMS-C oriented map sources
24 * The #VikWmscMapSource class handles WMS/WMS-C oriented map sources.
26 * http://wiki.osgeo.org/wiki/WMS_Tile_Caching
38 #include "vikwmscmapsource.h"
41 static gboolean _coord_to_mapcoord ( VikMapSource *self, const VikCoord *src, gdouble xzoom, gdouble yzoom, MapCoord *dest );
42 static void _mapcoord_to_center_coord ( VikMapSource *self, MapCoord *src, VikCoord *dest );
43 static gboolean _supports_download_only_new ( VikMapSource *self );
44 static gboolean _is_direct_file_access ( VikMapSource *self );
45 static gboolean _is_mbtiles ( VikMapSource *self );
46 static gboolean _is_osm_meta_tiles (VikMapSource *self );
47 static guint8 _get_zoom_min(VikMapSource *self );
48 static guint8 _get_zoom_max(VikMapSource *self );
49 static gdouble _get_lat_min(VikMapSource *self );
50 static gdouble _get_lat_max(VikMapSource *self );
51 static gdouble _get_lon_min(VikMapSource *self );
52 static gdouble _get_lon_max(VikMapSource *self );
54 static gchar *_get_uri( VikMapSourceDefault *self, MapCoord *src );
55 static gchar *_get_hostname( VikMapSourceDefault *self );
56 static DownloadFileOptions *_get_download_options( VikMapSourceDefault *self );
58 typedef struct _VikWmscMapSourcePrivate VikWmscMapSourcePrivate;
59 struct _VikWmscMapSourcePrivate
63 DownloadFileOptions options;
64 guint zoom_min; // TMS Zoom level: 0 = Whole World // http://wiki.openstreetmap.org/wiki/Slippy_map_tilenames
65 guint zoom_max; // TMS Zoom level: Often 18 for zoomed in.
66 gdouble lat_min; // Degrees
67 gdouble lat_max; // Degrees
68 gdouble lon_min; // Degrees
69 gdouble lon_max; // Degrees
72 #define VIK_WMSC_MAP_SOURCE_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), VIK_TYPE_WMSC_MAP_SOURCE, VikWmscMapSourcePrivate))
83 PROP_CHECK_FILE_SERVER_TIME,
92 G_DEFINE_TYPE (VikWmscMapSource, vik_wmsc_map_source, VIK_TYPE_MAP_SOURCE_DEFAULT);
95 vik_wmsc_map_source_init (VikWmscMapSource *self)
97 /* initialize the object here */
98 VikWmscMapSourcePrivate *priv = VIK_WMSC_MAP_SOURCE_PRIVATE (self);
100 priv->hostname = NULL;
102 priv->options.referer = NULL;
103 priv->options.follow_location = 0;
104 priv->options.check_file = a_check_map_file;
105 priv->options.check_file_server_time = FALSE;
108 priv->lat_min = -90.0;
109 priv->lat_max = 90.0;
110 priv->lon_min = -180.0;
111 priv->lon_max = 180.0;
113 g_object_set (G_OBJECT (self),
116 "drawmode", VIK_VIEWPORT_DRAWMODE_LATLON,
121 vik_wmsc_map_source_finalize (GObject *object)
123 VikWmscMapSource *self = VIK_WMSC_MAP_SOURCE (object);
124 VikWmscMapSourcePrivate *priv = VIK_WMSC_MAP_SOURCE_PRIVATE (self);
126 g_free (priv->hostname);
127 priv->hostname = NULL;
130 g_free (priv->options.referer);
131 priv->options.referer = NULL;
133 G_OBJECT_CLASS (vik_wmsc_map_source_parent_class)->finalize (object);
137 vik_wmsc_map_source_set_property (GObject *object,
142 VikWmscMapSource *self = VIK_WMSC_MAP_SOURCE (object);
143 VikWmscMapSourcePrivate *priv = VIK_WMSC_MAP_SOURCE_PRIVATE (self);
148 g_free (priv->hostname);
149 priv->hostname = g_value_dup_string (value);
154 priv->url = g_value_dup_string (value);
158 g_free (priv->options.referer);
159 priv->options.referer = g_value_dup_string (value);
162 case PROP_FOLLOW_LOCATION:
163 priv->options.follow_location = g_value_get_long (value);
166 case PROP_CHECK_FILE_SERVER_TIME:
167 priv->options.check_file_server_time = g_value_get_boolean (value);
171 priv->zoom_min = g_value_get_uint (value);
175 priv->zoom_max = g_value_get_uint (value);
179 priv->lat_min = g_value_get_double (value);
183 priv->lat_max = g_value_get_double (value);
187 priv->lon_min = g_value_get_double (value);
191 priv->lon_max = g_value_get_double (value);
195 /* We don't have any other property... */
196 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
202 vik_wmsc_map_source_get_property (GObject *object,
207 VikWmscMapSource *self = VIK_WMSC_MAP_SOURCE (object);
208 VikWmscMapSourcePrivate *priv = VIK_WMSC_MAP_SOURCE_PRIVATE (self);
213 g_value_set_string (value, priv->hostname);
217 g_value_set_string (value, priv->url);
221 g_value_set_string (value, priv->options.referer);
224 case PROP_FOLLOW_LOCATION:
225 g_value_set_long (value, priv->options.follow_location);
228 case PROP_CHECK_FILE_SERVER_TIME:
229 g_value_set_boolean (value, priv->options.check_file_server_time);
233 g_value_set_uint (value, priv->zoom_min);
237 g_value_set_uint (value, priv->zoom_max);
241 g_value_set_double (value, priv->lon_min);
245 g_value_set_double (value, priv->lon_max);
249 g_value_set_double (value, priv->lat_min);
253 g_value_set_double (value, priv->lat_max);
257 /* We don't have any other property... */
258 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
264 vik_wmsc_map_source_class_init (VikWmscMapSourceClass *klass)
266 GObjectClass* object_class = G_OBJECT_CLASS (klass);
267 VikMapSourceClass* grandparent_class = VIK_MAP_SOURCE_CLASS (klass);
268 VikMapSourceDefaultClass* parent_class = VIK_MAP_SOURCE_DEFAULT_CLASS (klass);
269 GParamSpec *pspec = NULL;
271 object_class->set_property = vik_wmsc_map_source_set_property;
272 object_class->get_property = vik_wmsc_map_source_get_property;
274 /* Overiding methods */
275 grandparent_class->coord_to_mapcoord = _coord_to_mapcoord;
276 grandparent_class->mapcoord_to_center_coord = _mapcoord_to_center_coord;
277 grandparent_class->supports_download_only_new = _supports_download_only_new;
278 grandparent_class->is_direct_file_access = _is_direct_file_access;
279 grandparent_class->is_mbtiles = _is_mbtiles;
280 grandparent_class->is_osm_meta_tiles = _is_osm_meta_tiles;
281 grandparent_class->get_zoom_min = _get_zoom_min;
282 grandparent_class->get_zoom_max = _get_zoom_max;
283 grandparent_class->get_lat_min = _get_lat_min;
284 grandparent_class->get_lat_max = _get_lat_max;
285 grandparent_class->get_lon_min = _get_lon_min;
286 grandparent_class->get_lon_max = _get_lon_max;
288 parent_class->get_uri = _get_uri;
289 parent_class->get_hostname = _get_hostname;
290 parent_class->get_download_options = _get_download_options;
292 pspec = g_param_spec_string ("hostname",
294 "The hostname of the map server",
295 "<no-set>" /* default value */,
296 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
297 g_object_class_install_property (object_class, PROP_HOSTNAME, pspec);
299 pspec = g_param_spec_string ("url",
301 "The template of the tiles' URL",
302 "<no-set>" /* default value */,
303 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
304 g_object_class_install_property (object_class, PROP_URL, pspec);
306 pspec = g_param_spec_string ("referer",
308 "The REFERER string to use in HTTP request",
309 NULL /* default value */,
310 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
311 g_object_class_install_property (object_class, PROP_REFERER, pspec);
313 pspec = g_param_spec_long ("follow-location",
315 "Specifies the number of retries to follow a redirect while downloading a page",
316 0 /* minimum value */,
317 G_MAXLONG /* maximum value */,
318 0 /* default value */,
319 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
320 g_object_class_install_property (object_class, PROP_FOLLOW_LOCATION, pspec);
322 pspec = g_param_spec_boolean ("check-file-server-time",
323 "Check file server time",
324 "Age of current cache before redownloading tile",
325 FALSE /* default value */,
326 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
327 g_object_class_install_property (object_class, PROP_CHECK_FILE_SERVER_TIME, pspec);
329 pspec = g_param_spec_uint ("zoom-min",
331 "Minimum Zoom level supported by the map provider",
335 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
336 g_object_class_install_property (object_class, PROP_ZOOM_MIN, pspec);
338 pspec = g_param_spec_uint ("zoom-max",
340 "Maximum Zoom level supported by the map provider",
344 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
345 g_object_class_install_property (object_class, PROP_ZOOM_MAX, pspec);
347 pspec = g_param_spec_double ("lat-min",
349 "Minimum latitude in degrees supported by the map provider",
350 -90.0, // minimum value
351 90.0, // maximum value
352 -90.0, // default value
353 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
354 g_object_class_install_property (object_class, PROP_LAT_MIN, pspec);
356 pspec = g_param_spec_double ("lat-max",
358 "Maximum latitude in degrees supported by the map provider",
359 -90.0, // minimum value
360 90.0, // maximum value
361 90.0, // default value
362 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
363 g_object_class_install_property (object_class, PROP_LAT_MAX, pspec);
365 pspec = g_param_spec_double ("lon-min",
367 "Minimum longitude in degrees supported by the map provider",
368 -180.0, // minimum value
369 180.0, // maximum value
370 -180.0, // default value
371 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
372 g_object_class_install_property (object_class, PROP_LON_MIN, pspec);
374 pspec = g_param_spec_double ("lon-max",
376 "Maximum longitude in degrees supported by the map provider",
377 -180.0, // minimum value
378 180.0, // maximum value
379 180.0, // default value
380 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
381 g_object_class_install_property (object_class, PROP_LON_MAX, pspec);
383 g_type_class_add_private (klass, sizeof (VikWmscMapSourcePrivate));
385 object_class->finalize = vik_wmsc_map_source_finalize;
389 _supports_download_only_new ( VikMapSource *self )
391 g_return_val_if_fail (VIK_IS_WMSC_MAP_SOURCE(self), FALSE);
393 VikWmscMapSourcePrivate *priv = VIK_WMSC_MAP_SOURCE_PRIVATE(self);
395 return priv->options.check_file_server_time;
399 _is_direct_file_access ( VikMapSource *self )
405 _is_mbtiles ( VikMapSource *self )
411 _is_osm_meta_tiles ( VikMapSource *self )
417 _coord_to_mapcoord ( VikMapSource *self, const VikCoord *src, gdouble xzoom, gdouble yzoom, MapCoord *dest )
419 g_assert ( src->mode == VIK_COORD_LATLON );
421 if ( xzoom != yzoom )
424 dest->scale = map_utils_mpp_to_scale ( xzoom );
425 if ( dest->scale == 255 )
428 /* Note : VIK_GZ(17) / xzoom / 2 = number of tile on Y axis */
429 g_debug("%s: xzoom=%f yzoom=%f -> %f", __FUNCTION__,
430 xzoom, yzoom, VIK_GZ(17) / xzoom / 2);
431 dest->x = floor((src->east_west + 180) / 180 * VIK_GZ(17) / xzoom / 2);
432 /* We should restore logic of viking:
433 * tile index on Y axis follow a screen logic (top -> down)
435 dest->y = floor((180 - (src->north_south + 90)) / 180 * VIK_GZ(17) / xzoom / 2);
437 g_debug("%s: %f,%f -> %d,%d", __FUNCTION__,
438 src->east_west, src->north_south, dest->x, dest->y);
443 _mapcoord_to_center_coord ( VikMapSource *self, MapCoord *src, VikCoord *dest )
445 gdouble socalled_mpp;
447 socalled_mpp = VIK_GZ(src->scale);
449 socalled_mpp = 1.0/VIK_GZ(-src->scale);
450 dest->mode = VIK_COORD_LATLON;
451 dest->east_west = (src->x+0.5) * 180 / VIK_GZ(17) * socalled_mpp * 2 - 180;
452 /* We should restore logic of viking:
453 * tile index on Y axis follow a screen logic (top -> down)
455 dest->north_south = -((src->y+0.5) * 180 / VIK_GZ(17) * socalled_mpp * 2 - 90);
456 g_debug("%s: %d,%d -> %f,%f", __FUNCTION__,
457 src->x, src->y, dest->east_west, dest->north_south);
461 _get_uri( VikMapSourceDefault *self, MapCoord *src )
463 g_return_val_if_fail (VIK_IS_WMSC_MAP_SOURCE(self), NULL);
465 VikWmscMapSourcePrivate *priv = VIK_WMSC_MAP_SOURCE_PRIVATE(self);
466 gdouble socalled_mpp;
468 socalled_mpp = VIK_GZ(src->scale);
470 socalled_mpp = 1.0/VIK_GZ(-src->scale);
471 gdouble minx = (gdouble)src->x * 180 / VIK_GZ(17) * socalled_mpp * 2 - 180;
472 gdouble maxx = (gdouble)(src->x + 1) * 180 / VIK_GZ(17) * socalled_mpp * 2 - 180;
473 /* We should restore logic of viking:
474 * tile index on Y axis follow a screen logic (top -> down)
476 gdouble miny = -((gdouble)(src->y + 1) * 180 / VIK_GZ(17) * socalled_mpp * 2 - 90);
477 gdouble maxy = -((gdouble)(src->y) * 180 / VIK_GZ(17) * socalled_mpp * 2 - 90);
479 gchar sminx[G_ASCII_DTOSTR_BUF_SIZE];
480 gchar smaxx[G_ASCII_DTOSTR_BUF_SIZE];
481 gchar sminy[G_ASCII_DTOSTR_BUF_SIZE];
482 gchar smaxy[G_ASCII_DTOSTR_BUF_SIZE];
484 g_ascii_dtostr (sminx, G_ASCII_DTOSTR_BUF_SIZE, minx);
485 g_ascii_dtostr (smaxx, G_ASCII_DTOSTR_BUF_SIZE, maxx);
486 g_ascii_dtostr (sminy, G_ASCII_DTOSTR_BUF_SIZE, miny);
487 g_ascii_dtostr (smaxy, G_ASCII_DTOSTR_BUF_SIZE, maxy);
489 gchar *uri = g_strdup_printf (priv->url, sminx, sminy, smaxx, smaxy);
495 _get_hostname( VikMapSourceDefault *self )
497 g_return_val_if_fail (VIK_IS_WMSC_MAP_SOURCE(self), NULL);
499 VikWmscMapSourcePrivate *priv = VIK_WMSC_MAP_SOURCE_PRIVATE(self);
500 return g_strdup( priv->hostname );
503 static DownloadFileOptions *
504 _get_download_options( VikMapSourceDefault *self )
506 g_return_val_if_fail (VIK_IS_WMSC_MAP_SOURCE(self), NULL);
508 VikWmscMapSourcePrivate *priv = VIK_WMSC_MAP_SOURCE_PRIVATE(self);
509 return &(priv->options);
515 _get_zoom_min (VikMapSource *self)
517 g_return_val_if_fail (VIK_IS_WMSC_MAP_SOURCE(self), FALSE);
518 VikWmscMapSourcePrivate *priv = VIK_WMSC_MAP_SOURCE_PRIVATE(self);
519 return priv->zoom_min;
526 _get_zoom_max (VikMapSource *self)
528 g_return_val_if_fail (VIK_IS_WMSC_MAP_SOURCE(self), FALSE);
529 VikWmscMapSourcePrivate *priv = VIK_WMSC_MAP_SOURCE_PRIVATE(self);
530 return priv->zoom_max;
537 _get_lat_min (VikMapSource *self)
539 g_return_val_if_fail (VIK_IS_WMSC_MAP_SOURCE(self), FALSE);
540 VikWmscMapSourcePrivate *priv = VIK_WMSC_MAP_SOURCE_PRIVATE(self);
541 return priv->lat_min;
548 _get_lat_max (VikMapSource *self)
550 g_return_val_if_fail (VIK_IS_WMSC_MAP_SOURCE(self), FALSE);
551 VikWmscMapSourcePrivate *priv = VIK_WMSC_MAP_SOURCE_PRIVATE(self);
552 return priv->lat_max;
559 _get_lon_min (VikMapSource *self)
561 g_return_val_if_fail (VIK_IS_WMSC_MAP_SOURCE(self), FALSE);
562 VikWmscMapSourcePrivate *priv = VIK_WMSC_MAP_SOURCE_PRIVATE(self);
563 return priv->lon_min;
570 _get_lon_max (VikMapSource *self)
572 g_return_val_if_fail (VIK_IS_WMSC_MAP_SOURCE(self), FALSE);
573 VikWmscMapSourcePrivate *priv = VIK_WMSC_MAP_SOURCE_PRIVATE(self);
574 return priv->lon_max;
578 vik_wmsc_map_source_new_with_id (guint16 id, const gchar *label, const gchar *hostname, const gchar *url)
580 return g_object_new(VIK_TYPE_WMSC_MAP_SOURCE,
581 "id", id, "label", label, "hostname", hostname, "url", url, NULL);