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"
55 static gboolean _coord_to_mapcoord ( VikMapSource *self, const VikCoord *src, gdouble xzoom, gdouble yzoom, MapCoord *dest );
56 static void _mapcoord_to_center_coord ( VikMapSource *self, MapCoord *src, VikCoord *dest );
58 static gboolean _is_direct_file_access (VikMapSource *self );
59 static gboolean _supports_download_only_new (VikMapSource *self );
61 static gchar *_get_uri( VikMapSourceDefault *self, MapCoord *src );
62 static gchar *_get_hostname( VikMapSourceDefault *self );
63 static DownloadMapOptions *_get_download_options( VikMapSourceDefault *self );
65 typedef struct _VikSlippyMapSourcePrivate VikSlippyMapSourcePrivate;
66 struct _VikSlippyMapSourcePrivate
70 DownloadMapOptions options;
71 gboolean is_direct_file_access;
74 #define VIK_SLIPPY_MAP_SOURCE_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), VIK_TYPE_SLIPPY_MAP_SOURCE, VikSlippyMapSourcePrivate))
85 PROP_CHECK_FILE_SERVER_TIME,
87 PROP_IS_DIRECT_FILE_ACCESS,
90 G_DEFINE_TYPE (VikSlippyMapSource, vik_slippy_map_source, VIK_TYPE_MAP_SOURCE_DEFAULT);
93 vik_slippy_map_source_init (VikSlippyMapSource *self)
95 /* initialize the object here */
96 VikSlippyMapSourcePrivate *priv = VIK_SLIPPY_MAP_SOURCE_PRIVATE (self);
98 priv->hostname = NULL;
100 priv->options.referer = NULL;
101 priv->options.follow_location = 0;
102 priv->options.check_file = a_check_map_file;
103 priv->options.check_file_server_time = FALSE;
104 priv->options.use_etag = FALSE;
105 priv->is_direct_file_access = FALSE;
107 g_object_set (G_OBJECT (self),
110 "drawmode", VIK_VIEWPORT_DRAWMODE_MERCATOR,
115 vik_slippy_map_source_finalize (GObject *object)
117 VikSlippyMapSource *self = VIK_SLIPPY_MAP_SOURCE (object);
118 VikSlippyMapSourcePrivate *priv = VIK_SLIPPY_MAP_SOURCE_PRIVATE (self);
120 g_free (priv->hostname);
121 priv->hostname = NULL;
124 g_free (priv->options.referer);
125 priv->options.referer = NULL;
127 G_OBJECT_CLASS (vik_slippy_map_source_parent_class)->finalize (object);
131 vik_slippy_map_source_set_property (GObject *object,
136 VikSlippyMapSource *self = VIK_SLIPPY_MAP_SOURCE (object);
137 VikSlippyMapSourcePrivate *priv = VIK_SLIPPY_MAP_SOURCE_PRIVATE (self);
142 g_free (priv->hostname);
143 priv->hostname = g_value_dup_string (value);
148 priv->url = g_value_dup_string (value);
152 g_free (priv->options.referer);
153 priv->options.referer = g_value_dup_string (value);
156 case PROP_FOLLOW_LOCATION:
157 priv->options.follow_location = g_value_get_long (value);
160 case PROP_CHECK_FILE_SERVER_TIME:
161 priv->options.check_file_server_time = g_value_get_boolean (value);
165 priv->options.use_etag = g_value_get_boolean (value);
168 case PROP_IS_DIRECT_FILE_ACCESS:
169 priv->is_direct_file_access = g_value_get_boolean (value);
173 /* We don't have any other property... */
174 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
180 vik_slippy_map_source_get_property (GObject *object,
185 VikSlippyMapSource *self = VIK_SLIPPY_MAP_SOURCE (object);
186 VikSlippyMapSourcePrivate *priv = VIK_SLIPPY_MAP_SOURCE_PRIVATE (self);
191 g_value_set_string (value, priv->hostname);
195 g_value_set_string (value, priv->url);
199 g_value_set_string (value, priv->options.referer);
202 case PROP_FOLLOW_LOCATION:
203 g_value_set_long (value, priv->options.follow_location);
206 case PROP_CHECK_FILE_SERVER_TIME:
207 g_value_set_boolean (value, priv->options.check_file_server_time);
211 g_value_set_boolean (value, priv->options.use_etag);
214 case PROP_IS_DIRECT_FILE_ACCESS:
215 g_value_set_boolean (value, priv->is_direct_file_access);
219 /* We don't have any other property... */
220 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
226 vik_slippy_map_source_class_init (VikSlippyMapSourceClass *klass)
228 GObjectClass* object_class = G_OBJECT_CLASS (klass);
229 VikMapSourceClass* grandparent_class = VIK_MAP_SOURCE_CLASS (klass);
230 VikMapSourceDefaultClass* parent_class = VIK_MAP_SOURCE_DEFAULT_CLASS (klass);
231 GParamSpec *pspec = NULL;
233 object_class->set_property = vik_slippy_map_source_set_property;
234 object_class->get_property = vik_slippy_map_source_get_property;
236 /* Overiding methods */
237 grandparent_class->coord_to_mapcoord = _coord_to_mapcoord;
238 grandparent_class->mapcoord_to_center_coord = _mapcoord_to_center_coord;
239 grandparent_class->is_direct_file_access = _is_direct_file_access;
240 grandparent_class->supports_download_only_new = _supports_download_only_new;
242 parent_class->get_uri = _get_uri;
243 parent_class->get_hostname = _get_hostname;
244 parent_class->get_download_options = _get_download_options;
246 pspec = g_param_spec_string ("hostname",
248 "The hostname of the map server",
249 "<no-set>" /* default value */,
251 g_object_class_install_property (object_class, PROP_HOSTNAME, pspec);
253 pspec = g_param_spec_string ("url",
255 "The template of the tiles' URL",
256 "<no-set>" /* default value */,
258 g_object_class_install_property (object_class, PROP_URL, pspec);
260 pspec = g_param_spec_string ("referer",
262 "The REFERER string to use in HTTP request",
263 NULL /* default value */,
264 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
265 g_object_class_install_property (object_class, PROP_REFERER, pspec);
267 pspec = g_param_spec_long ("follow-location",
269 "Specifies the number of retries to follow a redirect while downloading a page",
270 0 /* minimum value */,
271 G_MAXLONG /* maximum value */,
272 0 /* default value */,
273 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
274 g_object_class_install_property (object_class, PROP_FOLLOW_LOCATION, pspec);
276 pspec = g_param_spec_boolean ("check-file-server-time",
277 "Check file server time",
278 "Age of current cache before redownloading tile",
279 FALSE /* default value */,
280 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
281 g_object_class_install_property (object_class, PROP_CHECK_FILE_SERVER_TIME, pspec);
283 pspec = g_param_spec_boolean ("use-etag",
284 "Use etag values with server",
285 "Store etag in a file, and send it to server to check if we have the latest file",
286 FALSE /* default value */,
287 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
288 g_object_class_install_property (object_class, PROP_USE_ETAG, pspec);
290 pspec = g_param_spec_boolean ("use-direct-file-access",
291 "Use direct file access",
292 "Use direct file access to OSM like tile images - no need for a webservice",
293 FALSE /* default value */,
294 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
295 g_object_class_install_property (object_class, PROP_IS_DIRECT_FILE_ACCESS, pspec);
297 g_type_class_add_private (klass, sizeof (VikSlippyMapSourcePrivate));
299 object_class->finalize = vik_slippy_map_source_finalize;
302 /* 1 << (x) is like a 2**(x) */
303 #define GZ(x) ((1<<(x)))
305 static const gdouble scale_mpps[] = { GZ(0), GZ(1), GZ(2), GZ(3), GZ(4), GZ(5), GZ(6), GZ(7), GZ(8), GZ(9),
306 GZ(10), GZ(11), GZ(12), GZ(13), GZ(14), GZ(15), GZ(16), GZ(17) };
308 static const gint num_scales = (sizeof(scale_mpps) / sizeof(scale_mpps[0]));
310 static const gdouble scale_neg_mpps[] = { 1.0/GZ(0), 1.0/GZ(1), 1.0/GZ(2), 1.0/GZ(3) };
311 static const gint num_scales_neg = (sizeof(scale_neg_mpps) / sizeof(scale_neg_mpps[0]));
313 #define ERROR_MARGIN 0.01
315 vik_slippy_map_source_zoom_to_scale ( gdouble mpp ) {
317 for ( i = 0; i < num_scales; i++ ) {
318 if ( ABS(scale_mpps[i] - mpp) < ERROR_MARGIN ) {
322 for ( i = 0; i < num_scales_neg; i++ ) {
323 if ( ABS(scale_neg_mpps[i] - mpp) < 0.000001 ) {
332 _is_direct_file_access (VikMapSource *self)
334 g_return_val_if_fail (VIK_IS_SLIPPY_MAP_SOURCE(self), FALSE);
336 VikSlippyMapSourcePrivate *priv = VIK_SLIPPY_MAP_SOURCE_PRIVATE(self);
338 return priv->is_direct_file_access;
342 _supports_download_only_new (VikMapSource *self)
344 g_return_val_if_fail (VIK_IS_SLIPPY_MAP_SOURCE(self), FALSE);
346 VikSlippyMapSourcePrivate *priv = VIK_SLIPPY_MAP_SOURCE_PRIVATE(self);
348 return priv->options.check_file_server_time || priv->options.use_etag;
352 _coord_to_mapcoord ( VikMapSource *self, const VikCoord *src, gdouble xzoom, gdouble yzoom, MapCoord *dest )
354 g_assert ( src->mode == VIK_COORD_LATLON );
356 if ( xzoom != yzoom )
359 dest->scale = vik_slippy_map_source_zoom_to_scale ( xzoom );
360 if ( dest->scale == 255 )
363 dest->x = (src->east_west + 180) / 360 * GZ(17) / xzoom;
364 dest->y = (180 - MERCLAT(src->north_south)) / 360 * GZ(17) / xzoom;
371 _mapcoord_to_center_coord ( VikMapSource *self, MapCoord *src, VikCoord *dest )
373 gdouble socalled_mpp;
375 socalled_mpp = GZ(src->scale);
377 socalled_mpp = 1.0/GZ(-src->scale);
378 dest->mode = VIK_COORD_LATLON;
379 dest->east_west = ((src->x+0.5) / GZ(17) * socalled_mpp * 360) - 180;
380 dest->north_south = DEMERCLAT(180 - ((src->y+0.5) / GZ(17) * socalled_mpp * 360));
384 _get_uri( VikMapSourceDefault *self, MapCoord *src )
386 g_return_val_if_fail (VIK_IS_SLIPPY_MAP_SOURCE(self), NULL);
388 VikSlippyMapSourcePrivate *priv = VIK_SLIPPY_MAP_SOURCE_PRIVATE(self);
389 gchar *uri = g_strdup_printf (priv->url, 17 - src->scale, src->x, src->y);
394 _get_hostname( VikMapSourceDefault *self )
396 g_return_val_if_fail (VIK_IS_SLIPPY_MAP_SOURCE(self), NULL);
398 VikSlippyMapSourcePrivate *priv = VIK_SLIPPY_MAP_SOURCE_PRIVATE(self);
399 return g_strdup( priv->hostname );
402 static DownloadMapOptions *
403 _get_download_options( VikMapSourceDefault *self )
405 g_return_val_if_fail (VIK_IS_SLIPPY_MAP_SOURCE(self), NULL);
407 VikSlippyMapSourcePrivate *priv = VIK_SLIPPY_MAP_SOURCE_PRIVATE(self);
408 return &(priv->options);
412 vik_slippy_map_source_new_with_id (guint8 id, const gchar *label, const gchar *hostname, const gchar *url)
414 return g_object_new(VIK_TYPE_SLIPPY_MAP_SOURCE,
415 "id", id, "label", label, "hostname", hostname, "url", url, NULL);