err.no Git - mapper/blob - src/map-download.c

   1 /*
   2  * This file is part of mapper
   3  *
   4  * Copyright (C) 2007 Kaj-Michael Lang
   5  * Copyright (C) 2006-2007 John Costigan.
   6  *
   7  * POI and GPS-Info code originally written by Cezary Jackiewicz.
   8  *
   9  * Default map data provided by http://www.openstreetmap.org/
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License along
  22  * with this program; if not, write to the Free Software Foundation, Inc.,
  23  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  24  */
  25
  26 #include "config.h"
  27
  28 #include <unistd.h>
  29 #include <stdlib.h>
  30 #include <string.h>
  31 #include <strings.h>
  32 #include <stddef.h>
  33 #include <locale.h>
  34 #include <math.h>
  35 #include <errno.h>
  36 #include <sys/wait.h>
  37 #include <glib/gstdio.h>
  38 #include <fcntl.h>
  39 #include <curl/multi.h>
  40 #include <libintl.h>
  41 #include <locale.h>
  42
  43 #include "hildon-mapper.h"
  44
  45 #include "utils.h"
  46 #include "map.h"
  47 #include "osm.h"
  48 #include "db.h"
  49 #include "osm-db.h"
  50 #include "poi.h"
  51 #include "route.h"
  52 #include "gps.h"
  53 #include "mapper-types.h"
  54 #include "ui-common.h"
  55 #include "settings.h"
  56 #include "latlon.h"
  57 #include "gpx.h"
  58 #include "map-download.h"
  59 #include "iap.h"
  60 #include "map-repo.h"
  61
  62 static guint _num_downloads=0;
  63 static guint _curr_download=0;
  64
  65 static GQueue *curl_easy_queue=NULL;
  66 static GTree *pui_tree=NULL;
  67 static GTree *downloading_tree=NULL;
  68 static GHashTable *pui_by_easy=NULL;
  69
  70 static gchar *map_construct_url(guint tilex, guint tiley, guint zoom);
  71
  72 static gboolean
  73 get_next_pui(gpointer key, gpointer value, ProgressUpdateInfo ** data)
  74 {
  75 *data = key;
  76 return TRUE;
  77 }
  78
  79 static gint
  80 download_comparefunc(const ProgressUpdateInfo * a, const ProgressUpdateInfo * b, gpointer user_data)
  81 {
  82 gint diff = (a->priority - b->priority);
  83 if (diff)
  84         return diff;
  85 diff = (a->tilex - b->tilex);
  86 if (diff)
  87         return diff;
  88 diff = (a->tiley - b->tiley);
  89 if (diff)
  90         return diff;
  91 diff = (a->zoom - b->zoom);
  92 if (diff)
  93         return diff;
  94 diff = (a->repo - b->repo);
  95 if (diff)
  96         return diff;
  97 /* Otherwise, deletes are "greatest" (least priority). */
  98 if (!a->retries)
  99         return (b->retries ? -1 : 0);
 100 else if (!b->retries)
 101         return (a->retries ? 1 : 0);
 102 /* Do updates after non-updates (because they'll both be done anyway). */
 103 return (a->retries - b->retries);
 104 }
 105
 106 /**
 107  * Free a ProgressUpdateInfo data structure that was allocated during the
 108  * auto-map-download process.
 109  */
 110 static void
 111 progress_update_info_free(ProgressUpdateInfo * pui)
 112 {
 113 g_free(pui->src_str);
 114 g_free(pui->dest_str);
 115 g_slice_free(ProgressUpdateInfo, pui);
 116 }
 117
 118 gboolean
 119 map_download_timeout()
 120 {
 121 static guint destroy_counter = 50;
 122 gint num_transfers = 0, num_msgs = 0;
 123 gint deletes_left = 50; /* only do 50 deletes at a time. */
 124 CURLMsg *msg;
 125
 126 if (_curl_multi && CURLM_CALL_MULTI_PERFORM == curl_multi_perform(_curl_multi, &num_transfers))
 127         return TRUE;    /* Give UI a chance first. */
 128
 129 while (_curl_multi && (msg = curl_multi_info_read(_curl_multi, &num_msgs))) {
 130         if (msg->msg == CURLMSG_DONE) {
 131                 if (msg->easy_handle == _autoroute_data.curl_easy) {
 132                         /* This is the autoroute download. */
 133                         /* Now, parse the autoroute and update the display. */
 134                         if (_autoroute_data.enabled && parse_gpx(&_route, _autoroute_data.rdl_data.bytes, _autoroute_data.rdl_data.bytes_read, 0)) {
 135                                 /* Find the nearest route point, if we're connected. */
 136                                 route_find_nearest_point();
 137                                 map_force_redraw();
 138                         }
 139                         route_cancel_autoroute(TRUE);   /* We're done. Clean up. */
 140                 } else {
 141                         ProgressUpdateInfo *pui = g_hash_table_lookup(pui_by_easy, msg->easy_handle);
 142                         g_queue_push_head(curl_easy_queue, msg->easy_handle);
 143                         g_hash_table_remove(pui_by_easy, msg->easy_handle);
 144                         fclose(pui->file);
 145                         if (msg->data.result != CURLE_OK)
 146                                 g_unlink(pui->dest_str);        /* Delete so we try again. */
 147                         curl_multi_remove_handle(_curl_multi, msg->easy_handle);
 148                         g_idle_add_full(G_PRIORITY_HIGH_IDLE, (GSourceFunc)map_download_idle_refresh, pui, NULL);
 149                 }
 150         }
 151 }
 152
 153 /* Up to 1 transfer per tile. */
 154 while (num_transfers < (4*4) && g_tree_nnodes(pui_tree)) {
 155         ProgressUpdateInfo *pui;
 156         g_tree_foreach(pui_tree, (GTraverseFunc)get_next_pui, &pui);
 157
 158         if (pui->retries) {
 159                 /* This is a download. */
 160                 FILE *f;
 161                 g_tree_steal(pui_tree, pui);
 162                 g_tree_insert(downloading_tree, pui, pui);
 163
 164                 pui->src_str=map_construct_url(pui->tilex, pui->tiley, pui->zoom);
 165
 166                 if (!pui->src_str) {
 167                         /* Failed to generate URL. */
 168                         g_debug("Failed to generate tile download URL");
 169                         g_idle_add_full(G_PRIORITY_HIGH_IDLE,(GSourceFunc)map_download_idle_refresh, pui, NULL);
 170                         continue;
 171                 }
 172
 173                 pui->dest_str=g_strdup_printf("%s/%u/%u/%u.jpg", pui->repo->cache_dir, pui->zoom, pui->tilex, pui->tiley);
 174
 175                 /* Check to see if we need to overwrite. */
 176                 if (pui->retries > 0) {
 177                         /* We're not updating - check if file already exists. */
 178                         if (g_file_test(pui->dest_str, G_FILE_TEST_EXISTS)) {
 179                                 g_idle_add_full(G_PRIORITY_HIGH_IDLE, (GSourceFunc)map_download_idle_refresh, pui, NULL);
 180                                 continue;
 181                         }
 182                 }
 183
 184                 /* Attempt to open the file for writing. */
 185                 if (!(f=g_fopen(pui->dest_str, "w")) && errno == ENOENT) {
 186                         /* Directory doesn't exist yet - create it, then we'll retry */
 187                         gchar buffer[BUFFER_SIZE];
 188                         g_snprintf(buffer, sizeof(buffer), "%s/%u/%u", pui->repo->cache_dir, pui->zoom, pui->tilex);
 189                         g_mkdir_with_parents(buffer, 0775);
 190                         f=g_fopen(pui->dest_str, "w");
 191                 }
 192
 193                 if (f) {
 194                         CURL *curl_easy;
 195                         pui->file = f;
 196                         curl_easy = g_queue_pop_tail(curl_easy_queue);
 197                         if (!curl_easy) {
 198                                 /* Need a new curl_easy. */
 199                                 MACRO_CURL_EASY_INIT(curl_easy);
 200                         }
 201                         curl_easy_setopt(curl_easy, CURLOPT_URL, pui->src_str);
 202                         curl_easy_setopt(curl_easy, CURLOPT_WRITEDATA, f);
 203                         g_hash_table_insert(pui_by_easy, curl_easy, pui);
 204                         if (!_curl_multi) {
 205                                 /* Initialize CURL. */
 206                                 _curl_multi = curl_multi_init();
 207                                 /*curl_multi_setopt(_curl_multi, CURLMOPT_PIPELINING, 1); */
 208                         }
 209                         curl_multi_add_handle(_curl_multi, curl_easy);
 210                         num_transfers++;
 211                 } else {
 212                         /* Unable to open tile file for writing. */
 213                         gchar buffer[BUFFER_SIZE];
 214                         g_snprintf(buffer, sizeof(buffer), "%s:\n%s", _("Failed to open file for writing"), pui->dest_str);
 215                         MACRO_BANNER_SHOW_INFO(_window, buffer);
 216                         g_idle_add_full(G_PRIORITY_HIGH_IDLE, (GSourceFunc)map_download_idle_refresh, pui, NULL);
 217                         continue;
 218                 }
 219         } else if (--deletes_left) {
 220                 /* This is a delete. */
 221                 gchar buffer[BUFFER_SIZE];
 222                 g_tree_steal(pui_tree, pui);
 223                 g_tree_insert(downloading_tree, pui, pui);
 224
 225                 g_snprintf(buffer, sizeof(buffer), "%s/%u/%u/%u.jpg", pui->repo->cache_dir, pui->zoom, pui->tilex, pui->tiley);
 226                 g_unlink(buffer);
 227                 g_idle_add_full(G_PRIORITY_HIGH_IDLE,(GSourceFunc)map_download_idle_refresh, pui, NULL);
 228         } else
 229                 break;
 230 }
 231
 232 if (!(num_transfers || g_tree_nnodes(pui_tree))) {
 233         /* Destroy curl after 50 counts (5 seconds). */
 234         if (--destroy_counter) {
 235                 /* Clean up curl. */
 236                 CURL *curr;
 237                 while ((curr = g_queue_pop_tail(curl_easy_queue)))
 238                         curl_easy_cleanup(curr);
 239
 240                 curl_multi_cleanup(_curl_multi);
 241                 _curl_multi = NULL;
 242
 243                 _curl_sid = 0;
 244                 return FALSE;
 245         }
 246 } else
 247         destroy_counter = 50;
 248
 249 return TRUE;
 250 }
 251
 252 /**
 253  * Given a wms uri pattern, compute the coordinate transformation and
 254  * trimming.
 255  * 'proj' is used for the conversion
 256  */
 257 static gchar *
 258 map_convert_wms_to_wms(gint tilex, gint tiley, gint zoomlevel, gchar * uri)
 259 {
 260 gint system_retcode;
 261 gchar cmd[BUFFER_SIZE], srs[BUFFER_SIZE];
 262 gchar *ret = NULL;
 263 FILE *in;
 264 gdouble lon1, lat1, lon2, lat2;
 265
 266 gchar *widthstr = strcasestr(uri, "WIDTH=");
 267 gchar *heightstr = strcasestr(uri, "HEIGHT=");
 268 gchar *srsstr = strcasestr(uri, "SRS=EPSG");
 269 gchar *srsstre = strchr(srsstr, '&');
 270
 271 /* missing: test if found */
 272 strcpy(srs, "epsg");
 273 strncpy(srs + 4, srsstr + 8, 256);
 274 /* missing: test srsstre-srsstr < 526 */
 275 srs[srsstre - srsstr - 4] = 0;
 276 /* convert to lower, as WMC is EPSG and cs2cs is epsg */
 277
 278 gint dwidth = widthstr ? atoi(widthstr + 6) - TILE_SIZE_PIXELS : 0;
 279 gint dheight = heightstr ? atoi(heightstr + 7) - TILE_SIZE_PIXELS : 0;
 280
 281 unit2latlon(tile2zunit(tilex, zoomlevel) - pixel2zunit(dwidth / 2, zoomlevel),
 282             tile2zunit(tiley + 1, zoomlevel) + pixel2zunit((dheight + 1) / 2, zoomlevel), lat1, lon1);
 283
 284 unit2latlon(tile2zunit(tilex + 1, zoomlevel) + pixel2zunit((dwidth + 1) / 2, zoomlevel),
 285                 tile2zunit(tiley, zoomlevel) - pixel2zunit(dheight / 2, zoomlevel), lat2, lon2);
 286
 287 setlocale(LC_NUMERIC, "C");
 288
 289 g_snprintf(cmd, sizeof(cmd),
 290          "(echo \"%.6f %.6f\"; echo \"%.6f %.6f\") | "
 291          "/usr/bin/cs2cs +proj=longlat +datum=WGS84 +to +init=%s -f %%.6f "
 292          " > /tmp/tmpcs2cs ", lon1, lat1, lon2, lat2, srs);
 293 vprintf("Running command: %s\n", cmd);
 294 system_retcode = system(cmd);
 295
 296 if (system_retcode)
 297         g_printerr("cs2cs returned error code %d\n", WEXITSTATUS(system_retcode));
 298 else if (!(in = g_fopen("/tmp/tmpcs2cs", "r")))
 299         g_printerr("Cannot open results of conversion\n");
 300 else if (5 != fscanf(in, "%lf %lf %s %lf %lf", &lon1, &lat1, cmd, &lon2, &lat2)) {
 301         g_printerr("Wrong conversion\n");
 302         fclose(in);
 303 } else {
 304         fclose(in);
 305         ret = g_strdup_printf(uri, lon1, lat1, lon2, lat2);
 306 }
 307
 308 setlocale(LC_NUMERIC, "");
 309
 310 return ret;
 311 }
 312
 313
 314 /**
 315  * Given the xyz coordinates of our map coordinate system, write the qrst
 316  * quadtree coordinates to buffer.
 317  */
 318 static void
 319 map_convert_coords_to_quadtree_string(gint x, gint y, gint zoomlevel,
 320                                       gchar * buffer, const gchar initial,
 321                                       const gchar * const quadrant)
 322 {
 323 gchar *ptr = buffer;
 324 gint n;
 325
 326 if (initial)
 327         *ptr++ = initial;
 328
 329 for (n = 16 - zoomlevel; n >= 0; n--) {
 330         gint xbit = (x >> n) & 1;
 331         gint ybit = (y >> n) & 1;
 332         *ptr++ = quadrant[xbit + 2 * ybit];
 333 }
 334 *ptr++ = '\0';
 335 }
 336
 337 /**
 338  * Construct the URL that we should fetch, based on the current URI format.
 339  * This method works differently depending on if a "%s" string is present in
 340  * the URI format, since that would indicate a quadtree-based map coordinate
 341  * system.
 342  */
 343 static gchar *
 344 map_construct_url(guint tilex, guint tiley, guint zoom)
 345 {
 346 switch (_curr_repo->type) {
 347 case REPOTYPE_XYZ:
 348         return g_strdup_printf(_curr_repo->url, tilex, tiley, zoom);
 349
 350 case REPOTYPE_XYZ_INV:
 351         return g_strdup_printf(_curr_repo->url, 17 - zoom, tilex, tiley);
 352
 353 case REPOTYPE_QUAD_QRST:
 354         {
 355                 gchar location[MAX_ZOOM + 2];
 356                 map_convert_coords_to_quadtree_string(tilex, tiley, zoom, location, 't', "qrts");
 357                 return g_strdup_printf(_curr_repo->url, location);
 358         }
 359
 360 case REPOTYPE_QUAD_ZERO:
 361         {
 362                 /* This is a zero-based quadtree URI. */
 363                 gchar location[MAX_ZOOM + 2];
 364                 map_convert_coords_to_quadtree_string(tilex, tiley, zoom, location, '\0', "0123");
 365                 return g_strdup_printf(_curr_repo->url, location);
 366         }
 367
 368 case REPOTYPE_WMS:
 369         return map_convert_wms_to_wms(tilex, tiley, zoom, _curr_repo->url);
 370
 371 default:
 372         return NULL;
 373 }
 374 return "";
 375 }
 376
 377 void
 378 map_download_progress_clear(void)
 379 {
 380 g_assert(_progress_item);
 381 gtk_progress_bar_set_fraction(_progress_item, 0.0);
 382 gtk_progress_bar_set_text(_progress_item, "");
 383 }
 384
 385 void
 386 map_download_progress_set(gint currd, gint numd)
 387 {
 388 gchar buffer[64];
 389
 390 g_assert(_progress_item);
 391 g_snprintf(buffer, sizeof(buffer), _("Downloading maps (%d/%d)"), currd, numd);
 392 gtk_progress_bar_set_text(_progress_item, buffer);
 393 gtk_progress_bar_set_fraction(_progress_item, currd/(double)numd);
 394 }
 395
 396 gboolean
 397 map_download_idle_refresh(ProgressUpdateInfo * pui)
 398 {
 399 guint tmp=0;
 400 /* Test if download succeeded (only if retries != 0). */
 401 if (!pui->retries || g_file_test(pui->dest_str, G_FILE_TEST_EXISTS)) {
 402         gint zoom_diff = pui->zoom - _zoom;
 403
 404         /* Only refresh at same or "lower" (more detailed) zoom level. */
 405         if (zoom_diff >= 0) {
 406                 guint tilex, tiley, tilex_end, tiley_end;
 407
 408                 /* If zoom has changed since we first put in the request for
 409                  * this tile, then we may have to update more than one tile. */
 410                 for (tilex = pui->tilex << zoom_diff, tilex_end = tilex + (1 << zoom_diff); tilex < tilex_end; tilex++) {
 411                         for (tiley = pui->tiley << zoom_diff, tiley_end = tiley + (1 << zoom_diff); tiley < tiley_end; tiley++) {
 412                                 tmp++;
 413                                 if (map_render_tile(tilex, tiley, ((tilex - _base_tilex) << TILE_SIZE_P2), ((tiley - _base_tiley) << TILE_SIZE_P2), TRUE)==TRUE) {
 414                                         map_render_data();
 415                                         gtk_widget_queue_draw_area(_map_widget,
 416                                              ((tilex - _base_tilex) << TILE_SIZE_P2) - _offsetx,
 417                                              ((tiley - _base_tiley) << TILE_SIZE_P2) - _offsety,
 418                                              TILE_SIZE_PIXELS, TILE_SIZE_PIXELS);
 419                                 }
 420                         }
 421                 }
 422         g_debug("*** MDIR LOOP: %u", tmp);
 423         }
 424 }
 425 /* Else the download failed. Update retries and maybe try again. */
 426 else {
 427         if (pui->retries > 0)
 428                 --pui->retries;
 429         else if (pui->retries < 0)
 430                 ++pui->retries;
 431
 432         if (pui->retries) {
 433                 /* removal automatically calls progress_update_info_free(). */
 434                 g_tree_steal(downloading_tree, pui);
 435                 g_tree_insert(pui_tree, pui, pui);
 436                 if (iap_is_connected() && !_curl_sid)
 437                         _curl_sid = g_timeout_add(100,(GSourceFunc)map_download_timeout, NULL);
 438                 /* Don't do anything else. */
 439                 return FALSE;
 440         } else {
 441                 /* No more retries left - something must be wrong. */
 442                 MACRO_BANNER_SHOW_INFO(_window, _("Error in download. Check internet connection and/or Map Repository URL Format."));
 443         }
 444 }
 445
 446 /* removal automatically calls progress_update_info_free(). */
 447 g_tree_remove(downloading_tree, pui);
 448
 449 if (++_curr_download == _num_downloads) {
 450         _num_downloads = _curr_download = 0;
 451         map_download_progress_clear();
 452 } else {
 453         map_download_progress_set(_curr_download, _num_downloads);
 454 }
 455 return FALSE;
 456 }
 457
 458 /**
 459  * Initiate a download of the given xyz coordinates using the given buffer
 460  * as the URL.  If the map already exists on disk, or if we are already
 461  * downloading the map, then this method does nothing.
 462  */
 463 void
 464 map_initiate_download(guint tilex, guint tiley, guint zoom, gint retries)
 465 {
 466 ProgressUpdateInfo *pui;
 467
 468 iap_connect();
 469
 470 pui = g_slice_new(ProgressUpdateInfo);
 471 pui->tilex = tilex;
 472 pui->tiley = tiley;
 473 pui->zoom = zoom;
 474 pui->priority = (abs((gint) tilex - unit2tile(_center.unitx)) + abs((gint) tiley - unit2tile(_center.unity)));
 475 if (!retries)
 476         pui->priority = -pui->priority; /* "Negative" makes them lowest pri. */
 477 pui->retries = retries;
 478 pui->repo = _curr_repo;
 479
 480 if (g_tree_lookup(pui_tree, pui) || g_tree_lookup(downloading_tree, pui)) {
 481         /* Already downloading. */
 482         g_slice_free(ProgressUpdateInfo, pui);
 483         return;
 484 }
 485 pui->src_str = NULL;
 486 pui->dest_str = NULL;
 487 pui->file = NULL;
 488
 489 g_tree_insert(pui_tree, pui, pui);
 490 if (iap_is_connected() && !_curl_sid)
 491         _curl_sid = g_timeout_add(100, (GSourceFunc) map_download_timeout, NULL);
 492
 493 if (!_num_downloads++)
 494         gtk_progress_bar_set_text(_progress_item, _("Downloading maps..."));
 495 }
 496
 497 void
 498 map_download_init(void)
 499 {
 500 curl_easy_queue = g_queue_new();
 501 pui_tree = g_tree_new_full((GCompareDataFunc)download_comparefunc, NULL, (GDestroyNotify) progress_update_info_free, NULL);
 502 downloading_tree = g_tree_new_full((GCompareDataFunc)download_comparefunc, NULL, (GDestroyNotify) progress_update_info_free, NULL);
 503 pui_by_easy = g_hash_table_new(g_direct_hash, g_direct_equal);
 504 }
 505
 506 gboolean
 507 map_download_stop(void)
 508 {
 509 if (_curl_multi) {
 510         CURL *curr;
 511         CURLMsg *msg;
 512         gint num_msgs;
 513
 514         /* Clear the tree and create it again */
 515         if (pui_tree) {
 516                 g_tree_destroy(pui_tree);
 517                 pui_tree = g_tree_new_full((GCompareDataFunc)download_comparefunc, NULL, (GDestroyNotify) progress_update_info_free, NULL);
 518         }
 519
 520         /* Close all finished files. */
 521         while ((msg = curl_multi_info_read(_curl_multi, &num_msgs))) {
 522                 if (msg->msg == CURLMSG_DONE) {
 523                         /* This is a map download. */
 524                         ProgressUpdateInfo *pui = g_hash_table_lookup(pui_by_easy, msg->easy_handle);
 525                         g_queue_push_head(curl_easy_queue, msg->easy_handle);
 526                         g_hash_table_remove(pui_by_easy, msg->easy_handle);
 527                         fclose(pui->file);
 528                         curl_multi_remove_handle(_curl_multi, msg->easy_handle);
 529                 }
 530         }
 531
 532         g_debug("Stopping downloads");
 533         while ((curr = g_queue_pop_tail(curl_easy_queue)))
 534                 curl_easy_cleanup(curr);
 535         curl_multi_cleanup(_curl_multi);
 536         _curl_multi = NULL;
 537         return TRUE;
 538 }
 539 g_debug("No downloads to stop");
 540 return FALSE;
 541 }
 542
 543 /*
 544  * Clean up CURL and structures
 545  */
 546 void
 547 map_download_deinit(void)
 548 {
 549 if (_curl_multi) {
 550         CURL *curr;
 551         gint num_transfers;
 552
 553         /* Finish up all downloads. */
 554         while (CURLM_CALL_MULTI_PERFORM == curl_multi_perform(_curl_multi, &num_transfers) || num_transfers) {
 555                 g_debug("NT: %d", num_transfers);
 556         }
 557
 558         /* Stop all transfers and cleanup */
 559         map_download_stop();
 560
 561         if (pui_tree)
 562                 g_tree_destroy(pui_tree);
 563         if (downloading_tree)
 564                 g_tree_destroy(downloading_tree);
 565         if (pui_by_easy)
 566                 g_hash_table_destroy(pui_by_easy);
 567         if (curl_easy_queue)
 568                 g_queue_free(curl_easy_queue);
 569 }
 570
 571 if (_curl_sid) {
 572     g_source_remove(_curl_sid);
 573     _curl_sid = 0;
 574 }
 575 }