X-Git-Url: https://git.street.me.uk/andy/viking.git/blobdiff_plain/db03733a614fc5f52ede5d5c83b8aeb5651599aa..02d0c36780d02fe5ba62bf4232c5d6c923ffdb79:/src/vikslippymapsource.c diff --git a/src/vikslippymapsource.c b/src/vikslippymapsource.c index 402eb93e..0fd926bf 100644 --- a/src/vikslippymapsource.c +++ b/src/vikslippymapsource.c @@ -1,7 +1,7 @@ /* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 4; tab-width: 4 -*- */ /* * viking - * Copyright (C) Guilhem Bonnefille 2009 + * Copyright (C) 2009, Guilhem Bonnefille * * viking is free software: you can redistribute it and/or modify it * under the terms of the GNU General Public License as published by the @@ -16,6 +16,31 @@ * You should have received a copy of the GNU General Public License along * with this program. If not, see . */ + + /** + * SECTION:vikslippymapsource + * @short_description: the class for SlippyMap oriented map sources + * + * The #VikSlippyMapSource class handles slippy map oriented map sources. + * The related service is tile oriented, à la Google. + * + * The tiles are in 'google spherical mercator', which is + * basically a mercator projection that assumes a spherical earth. + * http://docs.openlayers.org/library/spherical_mercator.html + * + * Such service is also a type of TMS (Tile Map Service) as defined in + * OSGeo's wiki. + * http://wiki.osgeo.org/wiki/Tile_Map_Service_Specification + * But take care that the Y axis is inverted, ie the origin is at top-left + * corner. + * Following this specification, the protocol handled by this class + * follows the global-mercator profile. + * + * You can also find many interesting information on the OSM's wiki. + * http://wiki.openstreetmap.org/wiki/Slippy_map_tilenames + * http://wiki.openstreetmap.org/wiki/Setting_up_TMS + */ + #ifdef HAVE_CONFIG_H #include "config.h" #endif @@ -29,20 +54,21 @@ static gboolean _coord_to_mapcoord ( VikMapSource *self, const VikCoord *src, gdouble xzoom, gdouble yzoom, MapCoord *dest ); static void _mapcoord_to_center_coord ( VikMapSource *self, MapCoord *src, VikCoord *dest ); -static int _download ( VikMapSource *self, MapCoord *src, const gchar *dest_fn ); -static gchar *_get_uri( VikSlippyMapSource *self, MapCoord *src ); -static gchar *_get_hostname( VikSlippyMapSource *self ); -static DownloadOptions *_get_download_options( VikSlippyMapSource *self ); +static gboolean _is_direct_file_access (VikMapSource *self ); +static gboolean _supports_download_only_new (VikMapSource *self ); -/* FIXME Huge gruik */ -static DownloadOptions slippy_options = { NULL, 0, a_check_map_file }; +static gchar *_get_uri( VikMapSourceDefault *self, MapCoord *src ); +static gchar *_get_hostname( VikMapSourceDefault *self ); +static DownloadMapOptions *_get_download_options( VikMapSourceDefault *self ); typedef struct _VikSlippyMapSourcePrivate VikSlippyMapSourcePrivate; struct _VikSlippyMapSourcePrivate { gchar *hostname; gchar *url; + DownloadMapOptions options; + gboolean is_direct_file_access; }; #define VIK_SLIPPY_MAP_SOURCE_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), VIK_TYPE_SLIPPY_MAP_SOURCE, VikSlippyMapSourcePrivate)) @@ -54,27 +80,51 @@ enum PROP_HOSTNAME, PROP_URL, + PROP_REFERER, + PROP_FOLLOW_LOCATION, + PROP_CHECK_FILE_SERVER_TIME, + PROP_USE_ETAG, + PROP_IS_DIRECT_FILE_ACCESS, }; -G_DEFINE_TYPE_EXTENDED (VikSlippyMapSource, vik_slippy_map_source, VIK_TYPE_MAP_SOURCE_DEFAULT, (GTypeFlags)0,); +G_DEFINE_TYPE (VikSlippyMapSource, vik_slippy_map_source, VIK_TYPE_MAP_SOURCE_DEFAULT); static void vik_slippy_map_source_init (VikSlippyMapSource *self) { - /* initialize the object here */ - g_object_set (G_OBJECT (self), - "tilesize-x", 256, - "tilesize-y", 256, - "drawmode", VIK_VIEWPORT_DRAWMODE_MERCATOR, - NULL); + /* initialize the object here */ + VikSlippyMapSourcePrivate *priv = VIK_SLIPPY_MAP_SOURCE_PRIVATE (self); + + priv->hostname = NULL; + priv->url = NULL; + priv->options.referer = NULL; + priv->options.follow_location = 0; + priv->options.check_file = a_check_map_file; + priv->options.check_file_server_time = FALSE; + priv->options.use_etag = FALSE; + priv->is_direct_file_access = FALSE; + + g_object_set (G_OBJECT (self), + "tilesize-x", 256, + "tilesize-y", 256, + "drawmode", VIK_VIEWPORT_DRAWMODE_MERCATOR, + NULL); } static void vik_slippy_map_source_finalize (GObject *object) { - /* TODO: Add deinitalization code here */ + VikSlippyMapSource *self = VIK_SLIPPY_MAP_SOURCE (object); + VikSlippyMapSourcePrivate *priv = VIK_SLIPPY_MAP_SOURCE_PRIVATE (self); - G_OBJECT_CLASS (vik_slippy_map_source_parent_class)->finalize (object); + g_free (priv->hostname); + priv->hostname = NULL; + g_free (priv->url); + priv->url = NULL; + g_free (priv->options.referer); + priv->options.referer = NULL; + + G_OBJECT_CLASS (vik_slippy_map_source_parent_class)->finalize (object); } static void @@ -98,6 +148,27 @@ vik_slippy_map_source_set_property (GObject *object, priv->url = g_value_dup_string (value); break; + case PROP_REFERER: + g_free (priv->options.referer); + priv->options.referer = g_value_dup_string (value); + break; + + case PROP_FOLLOW_LOCATION: + priv->options.follow_location = g_value_get_long (value); + break; + + case PROP_CHECK_FILE_SERVER_TIME: + priv->options.check_file_server_time = g_value_get_boolean (value); + break; + + case PROP_USE_ETAG: + priv->options.use_etag = g_value_get_boolean (value); + break; + + case PROP_IS_DIRECT_FILE_ACCESS: + priv->is_direct_file_access = g_value_get_boolean (value); + break; + default: /* We don't have any other property... */ G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec); @@ -124,6 +195,26 @@ vik_slippy_map_source_get_property (GObject *object, g_value_set_string (value, priv->url); break; + case PROP_REFERER: + g_value_set_string (value, priv->options.referer); + break; + + case PROP_FOLLOW_LOCATION: + g_value_set_long (value, priv->options.follow_location); + break; + + case PROP_CHECK_FILE_SERVER_TIME: + g_value_set_boolean (value, priv->options.check_file_server_time); + break; + + case PROP_USE_ETAG: + g_value_set_boolean (value, priv->options.use_etag); + break; + + case PROP_IS_DIRECT_FILE_ACCESS: + g_value_set_boolean (value, priv->is_direct_file_access); + break; + default: /* We don't have any other property... */ G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec); @@ -135,96 +226,126 @@ static void vik_slippy_map_source_class_init (VikSlippyMapSourceClass *klass) { GObjectClass* object_class = G_OBJECT_CLASS (klass); - VikMapSourceClass* parent_class = VIK_MAP_SOURCE_CLASS (klass); + VikMapSourceClass* grandparent_class = VIK_MAP_SOURCE_CLASS (klass); + VikMapSourceDefaultClass* parent_class = VIK_MAP_SOURCE_DEFAULT_CLASS (klass); GParamSpec *pspec = NULL; object_class->set_property = vik_slippy_map_source_set_property; object_class->get_property = vik_slippy_map_source_get_property; /* Overiding methods */ - parent_class->coord_to_mapcoord = _coord_to_mapcoord; - parent_class->mapcoord_to_center_coord = _mapcoord_to_center_coord; - parent_class->download = _download; - - /* Default implementation of methods */ - klass->get_uri = _get_uri; - klass->get_hostname = _get_hostname; - klass->get_download_options = _get_download_options; + grandparent_class->coord_to_mapcoord = _coord_to_mapcoord; + grandparent_class->mapcoord_to_center_coord = _mapcoord_to_center_coord; + grandparent_class->is_direct_file_access = _is_direct_file_access; + grandparent_class->supports_download_only_new = _supports_download_only_new; + + parent_class->get_uri = _get_uri; + parent_class->get_hostname = _get_hostname; + parent_class->get_download_options = _get_download_options; pspec = g_param_spec_string ("hostname", "Hostname", "The hostname of the map server", "" /* default value */, - G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE); + G_PARAM_READWRITE); g_object_class_install_property (object_class, PROP_HOSTNAME, pspec); pspec = g_param_spec_string ("url", "URL", "The template of the tiles' URL", "" /* default value */, - G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE); + G_PARAM_READWRITE); g_object_class_install_property (object_class, PROP_URL, pspec); + + pspec = g_param_spec_string ("referer", + "Referer", + "The REFERER string to use in HTTP request", + NULL /* default value */, + G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE); + g_object_class_install_property (object_class, PROP_REFERER, pspec); + + pspec = g_param_spec_long ("follow-location", + "Follow location", + "Specifies the number of retries to follow a redirect while downloading a page", + 0 /* minimum value */, + G_MAXLONG /* maximum value */, + 0 /* default value */, + G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE); + g_object_class_install_property (object_class, PROP_FOLLOW_LOCATION, pspec); + pspec = g_param_spec_boolean ("check-file-server-time", + "Check file server time", + "Age of current cache before redownloading tile", + FALSE /* default value */, + G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE); + g_object_class_install_property (object_class, PROP_CHECK_FILE_SERVER_TIME, pspec); + + pspec = g_param_spec_boolean ("use-etag", + "Use etag values with server", + "Store etag in a file, and send it to server to check if we have the latest file", + FALSE /* default value */, + G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE); + g_object_class_install_property (object_class, PROP_USE_ETAG, pspec); + + pspec = g_param_spec_boolean ("use-direct-file-access", + "Use direct file access", + "Use direct file access to OSM like tile images - no need for a webservice", + FALSE /* default value */, + G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE); + g_object_class_install_property (object_class, PROP_IS_DIRECT_FILE_ACCESS, pspec); + g_type_class_add_private (klass, sizeof (VikSlippyMapSourcePrivate)); object_class->finalize = vik_slippy_map_source_finalize; } /* 1 << (x) is like a 2**(x) */ -#define GZ(x) ((1<get_uri != NULL, 0); - return (*klass->get_uri)(self, src); + return 255; } -gchar * -vik_slippy_map_source_get_hostname( VikSlippyMapSource *self ) +gboolean +_is_direct_file_access (VikMapSource *self) { - VikSlippyMapSourceClass *klass; - g_return_val_if_fail (self != NULL, 0); - g_return_val_if_fail (VIK_IS_SLIPPY_MAP_SOURCE (self), 0); - klass = VIK_SLIPPY_MAP_SOURCE_GET_CLASS(self); + g_return_val_if_fail (VIK_IS_SLIPPY_MAP_SOURCE(self), FALSE); - g_return_val_if_fail (klass->get_hostname != NULL, 0); + VikSlippyMapSourcePrivate *priv = VIK_SLIPPY_MAP_SOURCE_PRIVATE(self); - return (*klass->get_hostname)(self); + return priv->is_direct_file_access; } -DownloadOptions * -vik_slippy_map_source_get_download_options( VikSlippyMapSource *self ) +gboolean +_supports_download_only_new (VikMapSource *self) { - VikSlippyMapSourceClass *klass; - g_return_val_if_fail (self != NULL, 0); - g_return_val_if_fail (VIK_IS_SLIPPY_MAP_SOURCE (self), 0); - klass = VIK_SLIPPY_MAP_SOURCE_GET_CLASS(self); - - g_return_val_if_fail (klass->get_download_options != NULL, 0); - - return (*klass->get_download_options)(self); + g_return_val_if_fail (VIK_IS_SLIPPY_MAP_SOURCE(self), FALSE); + + VikSlippyMapSourcePrivate *priv = VIK_SLIPPY_MAP_SOURCE_PRIVATE(self); + + return priv->options.check_file_server_time || priv->options.use_etag; } static gboolean @@ -235,7 +356,7 @@ _coord_to_mapcoord ( VikMapSource *self, const VikCoord *src, gdouble xzoom, gdo if ( xzoom != yzoom ) return FALSE; - dest->scale = slippy_zoom ( xzoom ); + dest->scale = vik_slippy_map_source_zoom_to_scale ( xzoom ); if ( dest->scale == 255 ) return FALSE; @@ -249,27 +370,18 @@ _coord_to_mapcoord ( VikMapSource *self, const VikCoord *src, gdouble xzoom, gdo static void _mapcoord_to_center_coord ( VikMapSource *self, MapCoord *src, VikCoord *dest ) { - gdouble socalled_mpp = GZ(src->scale); + gdouble socalled_mpp; + if (src->scale >= 0) + socalled_mpp = GZ(src->scale); + else + socalled_mpp = 1.0/GZ(-src->scale); dest->mode = VIK_COORD_LATLON; dest->east_west = ((src->x+0.5) / GZ(17) * socalled_mpp * 360) - 180; dest->north_south = DEMERCLAT(180 - ((src->y+0.5) / GZ(17) * socalled_mpp * 360)); } -static int -_download ( VikMapSource *self, MapCoord *src, const gchar *dest_fn ) -{ - int res; - gchar *uri = vik_slippy_map_source_get_uri(VIK_SLIPPY_MAP_SOURCE(self), src); - gchar *host = vik_slippy_map_source_get_hostname(VIK_SLIPPY_MAP_SOURCE(self)); - DownloadOptions *options = vik_slippy_map_source_get_download_options(VIK_SLIPPY_MAP_SOURCE(self)); - res = a_http_download_get_url ( host, uri, dest_fn, options ); - g_free ( uri ); - g_free ( host ); - return res; -} - static gchar * -_get_uri( VikSlippyMapSource *self, MapCoord *src ) +_get_uri( VikMapSourceDefault *self, MapCoord *src ) { g_return_val_if_fail (VIK_IS_SLIPPY_MAP_SOURCE(self), NULL); @@ -279,7 +391,7 @@ _get_uri( VikSlippyMapSource *self, MapCoord *src ) } static gchar * -_get_hostname( VikSlippyMapSource *self ) +_get_hostname( VikMapSourceDefault *self ) { g_return_val_if_fail (VIK_IS_SLIPPY_MAP_SOURCE(self), NULL); @@ -287,12 +399,13 @@ _get_hostname( VikSlippyMapSource *self ) return g_strdup( priv->hostname ); } -static DownloadOptions * -_get_download_options( VikSlippyMapSource *self ) +static DownloadMapOptions * +_get_download_options( VikMapSourceDefault *self ) { g_return_val_if_fail (VIK_IS_SLIPPY_MAP_SOURCE(self), NULL); - return &slippy_options; + VikSlippyMapSourcePrivate *priv = VIK_SLIPPY_MAP_SOURCE_PRIVATE(self); + return &(priv->options); } VikSlippyMapSource * @@ -300,4 +413,4 @@ vik_slippy_map_source_new_with_id (guint8 id, const gchar *label, const gchar *h { return g_object_new(VIK_TYPE_SLIPPY_MAP_SOURCE, "id", id, "label", label, "hostname", hostname, "url", url, NULL); -} \ No newline at end of file +}