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 _supports_download_only_new (VikMapSource *self );
62 static gchar *_get_uri( VikMapSourceDefault *self, MapCoord *src );
63 static gchar *_get_hostname( VikMapSourceDefault *self );
64 static DownloadMapOptions *_get_download_options( VikMapSourceDefault *self );
66 typedef struct _VikSlippyMapSourcePrivate VikSlippyMapSourcePrivate;
67 struct _VikSlippyMapSourcePrivate
71 DownloadMapOptions options;
72 gboolean is_direct_file_access;
75 #define VIK_SLIPPY_MAP_SOURCE_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), VIK_TYPE_SLIPPY_MAP_SOURCE, VikSlippyMapSourcePrivate))
86 PROP_CHECK_FILE_SERVER_TIME,
88 PROP_IS_DIRECT_FILE_ACCESS,
91 G_DEFINE_TYPE (VikSlippyMapSource, vik_slippy_map_source, VIK_TYPE_MAP_SOURCE_DEFAULT);
94 vik_slippy_map_source_init (VikSlippyMapSource *self)
96 /* initialize the object here */
97 VikSlippyMapSourcePrivate *priv = VIK_SLIPPY_MAP_SOURCE_PRIVATE (self);
99 priv->hostname = NULL;
101 priv->options.referer = NULL;
102 priv->options.follow_location = 0;
103 priv->options.check_file = a_check_map_file;
104 priv->options.check_file_server_time = FALSE;
105 priv->options.use_etag = FALSE;
106 priv->is_direct_file_access = FALSE;
108 g_object_set (G_OBJECT (self),
111 "drawmode", VIK_VIEWPORT_DRAWMODE_MERCATOR,
116 vik_slippy_map_source_finalize (GObject *object)
118 VikSlippyMapSource *self = VIK_SLIPPY_MAP_SOURCE (object);
119 VikSlippyMapSourcePrivate *priv = VIK_SLIPPY_MAP_SOURCE_PRIVATE (self);
121 g_free (priv->hostname);
122 priv->hostname = NULL;
125 g_free (priv->options.referer);
126 priv->options.referer = NULL;
128 G_OBJECT_CLASS (vik_slippy_map_source_parent_class)->finalize (object);
132 vik_slippy_map_source_set_property (GObject *object,
137 VikSlippyMapSource *self = VIK_SLIPPY_MAP_SOURCE (object);
138 VikSlippyMapSourcePrivate *priv = VIK_SLIPPY_MAP_SOURCE_PRIVATE (self);
143 g_free (priv->hostname);
144 priv->hostname = g_value_dup_string (value);
149 priv->url = g_value_dup_string (value);
153 g_free (priv->options.referer);
154 priv->options.referer = g_value_dup_string (value);
157 case PROP_FOLLOW_LOCATION:
158 priv->options.follow_location = g_value_get_long (value);
161 case PROP_CHECK_FILE_SERVER_TIME:
162 priv->options.check_file_server_time = g_value_get_boolean (value);
166 priv->options.use_etag = g_value_get_boolean (value);
169 case PROP_IS_DIRECT_FILE_ACCESS:
170 priv->is_direct_file_access = g_value_get_boolean (value);
174 /* We don't have any other property... */
175 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
181 vik_slippy_map_source_get_property (GObject *object,
186 VikSlippyMapSource *self = VIK_SLIPPY_MAP_SOURCE (object);
187 VikSlippyMapSourcePrivate *priv = VIK_SLIPPY_MAP_SOURCE_PRIVATE (self);
192 g_value_set_string (value, priv->hostname);
196 g_value_set_string (value, priv->url);
200 g_value_set_string (value, priv->options.referer);
203 case PROP_FOLLOW_LOCATION:
204 g_value_set_long (value, priv->options.follow_location);
207 case PROP_CHECK_FILE_SERVER_TIME:
208 g_value_set_boolean (value, priv->options.check_file_server_time);
212 g_value_set_boolean (value, priv->options.use_etag);
215 case PROP_IS_DIRECT_FILE_ACCESS:
216 g_value_set_boolean (value, priv->is_direct_file_access);
220 /* We don't have any other property... */
221 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
227 vik_slippy_map_source_class_init (VikSlippyMapSourceClass *klass)
229 GObjectClass* object_class = G_OBJECT_CLASS (klass);
230 VikMapSourceClass* grandparent_class = VIK_MAP_SOURCE_CLASS (klass);
231 VikMapSourceDefaultClass* parent_class = VIK_MAP_SOURCE_DEFAULT_CLASS (klass);
232 GParamSpec *pspec = NULL;
234 object_class->set_property = vik_slippy_map_source_set_property;
235 object_class->get_property = vik_slippy_map_source_get_property;
237 /* Overiding methods */
238 grandparent_class->coord_to_mapcoord = _coord_to_mapcoord;
239 grandparent_class->mapcoord_to_center_coord = _mapcoord_to_center_coord;
240 grandparent_class->is_direct_file_access = _is_direct_file_access;
241 grandparent_class->supports_download_only_new = _supports_download_only_new;
243 parent_class->get_uri = _get_uri;
244 parent_class->get_hostname = _get_hostname;
245 parent_class->get_download_options = _get_download_options;
247 pspec = g_param_spec_string ("hostname",
249 "The hostname of the map server",
250 "<no-set>" /* default value */,
252 g_object_class_install_property (object_class, PROP_HOSTNAME, pspec);
254 pspec = g_param_spec_string ("url",
256 "The template of the tiles' URL",
257 "<no-set>" /* default value */,
259 g_object_class_install_property (object_class, PROP_URL, pspec);
261 pspec = g_param_spec_string ("referer",
263 "The REFERER string to use in HTTP request",
264 NULL /* default value */,
265 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
266 g_object_class_install_property (object_class, PROP_REFERER, pspec);
268 pspec = g_param_spec_long ("follow-location",
270 "Specifies the number of retries to follow a redirect while downloading a page",
271 0 /* minimum value */,
272 G_MAXLONG /* maximum value */,
273 0 /* default value */,
274 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
275 g_object_class_install_property (object_class, PROP_FOLLOW_LOCATION, pspec);
277 pspec = g_param_spec_boolean ("check-file-server-time",
278 "Check file server time",
279 "Age of current cache before redownloading tile",
280 FALSE /* default value */,
281 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
282 g_object_class_install_property (object_class, PROP_CHECK_FILE_SERVER_TIME, pspec);
284 pspec = g_param_spec_boolean ("use-etag",
285 "Use etag values with server",
286 "Store etag in a file, and send it to server to check if we have the latest file",
287 FALSE /* default value */,
288 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
289 g_object_class_install_property (object_class, PROP_USE_ETAG, pspec);
291 pspec = g_param_spec_boolean ("use-direct-file-access",
292 "Use direct file access",
293 "Use direct file access to OSM like tile images - no need for a webservice",
294 FALSE /* default value */,
295 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
296 g_object_class_install_property (object_class, PROP_IS_DIRECT_FILE_ACCESS, pspec);
298 g_type_class_add_private (klass, sizeof (VikSlippyMapSourcePrivate));
300 object_class->finalize = vik_slippy_map_source_finalize;
304 _is_direct_file_access (VikMapSource *self)
306 g_return_val_if_fail (VIK_IS_SLIPPY_MAP_SOURCE(self), FALSE);
308 VikSlippyMapSourcePrivate *priv = VIK_SLIPPY_MAP_SOURCE_PRIVATE(self);
310 return priv->is_direct_file_access;
314 _supports_download_only_new (VikMapSource *self)
316 g_return_val_if_fail (VIK_IS_SLIPPY_MAP_SOURCE(self), FALSE);
318 VikSlippyMapSourcePrivate *priv = VIK_SLIPPY_MAP_SOURCE_PRIVATE(self);
320 return priv->options.check_file_server_time || priv->options.use_etag;
324 _coord_to_mapcoord ( VikMapSource *self, const VikCoord *src, gdouble xzoom, gdouble yzoom, MapCoord *dest )
326 g_assert ( src->mode == VIK_COORD_LATLON );
328 if ( xzoom != yzoom )
331 dest->scale = map_utils_mpp_to_scale ( xzoom );
332 if ( dest->scale == 255 )
335 dest->x = (src->east_west + 180) / 360 * VIK_GZ(17) / xzoom;
336 dest->y = (180 - MERCLAT(src->north_south)) / 360 * VIK_GZ(17) / xzoom;
343 _mapcoord_to_center_coord ( VikMapSource *self, MapCoord *src, VikCoord *dest )
345 gdouble socalled_mpp;
347 socalled_mpp = VIK_GZ(src->scale);
349 socalled_mpp = 1.0/VIK_GZ(-src->scale);
350 dest->mode = VIK_COORD_LATLON;
351 dest->east_west = ((src->x+0.5) / VIK_GZ(17) * socalled_mpp * 360) - 180;
352 dest->north_south = DEMERCLAT(180 - ((src->y+0.5) / VIK_GZ(17) * socalled_mpp * 360));
356 _get_uri( VikMapSourceDefault *self, MapCoord *src )
358 g_return_val_if_fail (VIK_IS_SLIPPY_MAP_SOURCE(self), NULL);
360 VikSlippyMapSourcePrivate *priv = VIK_SLIPPY_MAP_SOURCE_PRIVATE(self);
361 gchar *uri = g_strdup_printf (priv->url, 17 - src->scale, src->x, src->y);
366 _get_hostname( VikMapSourceDefault *self )
368 g_return_val_if_fail (VIK_IS_SLIPPY_MAP_SOURCE(self), NULL);
370 VikSlippyMapSourcePrivate *priv = VIK_SLIPPY_MAP_SOURCE_PRIVATE(self);
371 return g_strdup( priv->hostname );
374 static DownloadMapOptions *
375 _get_download_options( VikMapSourceDefault *self )
377 g_return_val_if_fail (VIK_IS_SLIPPY_MAP_SOURCE(self), NULL);
379 VikSlippyMapSourcePrivate *priv = VIK_SLIPPY_MAP_SOURCE_PRIVATE(self);
380 return &(priv->options);
384 vik_slippy_map_source_new_with_id (guint8 id, const gchar *label, const gchar *hostname, const gchar *url)
386 return g_object_new(VIK_TYPE_SLIPPY_MAP_SOURCE,
387 "id", id, "label", label, "hostname", hostname, "url", url, NULL);