src/datasource_gc.c

   1 /*
   2  * viking -- GPS Data and Topo Analyzer, Explorer, and Manager
   3  *
   4  * Copyright (C) 2003-2007, Evan Battaglia <gtoevan@gmx.net>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  *
  20  */
  21 #ifdef HAVE_CONFIG_H
  22 #include "config.h"
  23 #endif
  24 #ifdef VIK_CONFIG_GEOCACHES
  25 #include <string.h>
  26
  27 #include <glib/gi18n.h>
  28
  29 #include "viking.h"
  30 #include "babel.h"
  31 #include "gpx.h"
  32 #include "acquire.h"
  33 #include "preferences.h"
  34
  35 // Could have an array of programs instead...
  36 #define GC_PROGRAM1 "geo-nearest"
  37 #define GC_PROGRAM2 "geo-html2gpx"
  38
  39 /* params will be geocaching.username, geocaching.password */
  40 /* we have to make sure these don't collide. */
  41 #define VIKING_GC_PARAMS_GROUP_KEY "geocaching"
  42 #define VIKING_GC_PARAMS_NAMESPACE "geocaching."
  43
  44
  45 typedef struct {
  46   GtkWidget *num_spin;
  47   GtkWidget *center_entry; // TODO make separate widgets for lat/lon
  48   GtkWidget *miles_radius_spin;
  49
  50   GdkGC *circle_gc;
  51   VikViewport *vvp;
  52   gboolean circle_onscreen;
  53   gint circle_x, circle_y, circle_width;
  54 } datasource_gc_widgets_t;
  55
  56
  57 static gpointer datasource_gc_init ( );
  58 static void datasource_gc_add_setup_widgets ( GtkWidget *dialog, VikViewport *vvp, gpointer user_data );
  59 static void datasource_gc_get_cmd_string ( datasource_gc_widgets_t *widgets, gchar **cmd, gchar **input_file_type );
  60 static void datasource_gc_cleanup ( datasource_gc_widgets_t *widgets );
  61 static gchar *datasource_gc_check_existence ();
  62
  63 #define METERSPERMILE 1609.344
  64
  65 VikDataSourceInterface vik_datasource_gc_interface = {
  66   N_("Download Geocaches"),
  67   N_("Geocaching.com Caches"),
  68   VIK_DATASOURCE_SHELL_CMD,
  69   VIK_DATASOURCE_ADDTOLAYER,
  70   VIK_DATASOURCE_INPUTTYPE_NONE,
  71   TRUE, // Yes automatically update the display - otherwise we won't see the geocache waypoints!
  72   TRUE,
  73   (VikDataSourceInitFunc)               datasource_gc_init,
  74   (VikDataSourceCheckExistenceFunc)     datasource_gc_check_existence,
  75   (VikDataSourceAddSetupWidgetsFunc)    datasource_gc_add_setup_widgets,
  76   (VikDataSourceGetCmdStringFunc)       datasource_gc_get_cmd_string,
  77   (VikDataSourceProgressFunc)           NULL,
  78   (VikDataSourceAddProgressWidgetsFunc) NULL,
  79   (VikDataSourceCleanupFunc)            datasource_gc_cleanup,
  80   (VikDataSourceOffFunc)                NULL,
  81 };
  82
  83 static VikLayerParam prefs[] = {
  84   { VIKING_GC_PARAMS_NAMESPACE "username", VIK_LAYER_PARAM_STRING, VIK_LAYER_GROUP_NONE, N_("geocaching.com username:"), VIK_LAYER_WIDGET_ENTRY },
  85   { VIKING_GC_PARAMS_NAMESPACE "password", VIK_LAYER_PARAM_STRING, VIK_LAYER_GROUP_NONE, N_("geocaching.com password:"), VIK_LAYER_WIDGET_ENTRY },
  86 };
  87
  88 void a_datasource_gc_init()
  89 {
  90   a_preferences_register_group ( VIKING_GC_PARAMS_GROUP_KEY, "Geocaching" );
  91
  92   VikLayerParamData tmp;
  93   tmp.s = "username";
  94   a_preferences_register(prefs, tmp, VIKING_GC_PARAMS_GROUP_KEY);
  95   tmp.s = "password";
  96   a_preferences_register(prefs+1, tmp, VIKING_GC_PARAMS_GROUP_KEY);
  97 }
  98
  99
 100 static gpointer datasource_gc_init ( )
 101 {
 102   datasource_gc_widgets_t *widgets = g_malloc(sizeof(*widgets));
 103   return widgets;
 104 }
 105
 106 static gchar *datasource_gc_check_existence ()
 107 {
 108   gboolean OK1 = FALSE;
 109   gboolean OK2 = FALSE;
 110
 111   gchar *location1 = g_find_program_in_path(GC_PROGRAM1);
 112   if ( location1 ) {
 113     g_free(location1);
 114     OK1 = TRUE;
 115   }
 116
 117   gchar *location2 = g_find_program_in_path(GC_PROGRAM2);
 118   if ( location2 ) {
 119     g_free(location2);
 120     OK2 = TRUE;
 121   }
 122
 123   if ( OK1 && OK2 )
 124     return NULL;
 125
 126   return g_strdup_printf(_("Can't find %s or %s in path! Check that you have installed it correctly."), GC_PROGRAM1, GC_PROGRAM2);
 127 }
 128
 129 static void datasource_gc_draw_circle ( datasource_gc_widgets_t *widgets )
 130 {
 131   gdouble lat, lon;
 132   if ( widgets->circle_onscreen ) {
 133     vik_viewport_draw_arc ( widgets->vvp, widgets->circle_gc, FALSE,
 134                 widgets->circle_x - widgets->circle_width/2,
 135                 widgets->circle_y - widgets->circle_width/2,
 136                 widgets->circle_width, widgets->circle_width, 0, 360*64 );
 137   }
 138   /* calculate widgets circle_x and circle_y */
 139   /* split up lat,lon into lat and lon */
 140   if ( 2 == sscanf ( gtk_entry_get_text ( GTK_ENTRY(widgets->center_entry) ), "%lf,%lf", &lat, &lon ) ) {
 141     struct LatLon ll;
 142     VikCoord c;
 143     gint x, y;
 144
 145     ll.lat = lat; ll.lon = lon;
 146     vik_coord_load_from_latlon ( &c, vik_viewport_get_coord_mode ( widgets->vvp ), &ll );
 147     vik_viewport_coord_to_screen ( widgets->vvp, &c, &x, &y );
 148     /* TODO: real calculation */
 149     if ( x > -1000 && y > -1000 && x < (vik_viewport_get_width(widgets->vvp) + 1000) &&
 150         y < (vik_viewport_get_width(widgets->vvp) + 1000) ) {
 151       VikCoord c1, c2;
 152       gdouble pixels_per_meter;
 153
 154       widgets->circle_x = x;
 155       widgets->circle_y = y;
 156
 157       /* determine miles per pixel */
 158       vik_viewport_screen_to_coord ( widgets->vvp, 0, vik_viewport_get_height(widgets->vvp)/2, &c1 );
 159       vik_viewport_screen_to_coord ( widgets->vvp, vik_viewport_get_width(widgets->vvp), vik_viewport_get_height(widgets->vvp)/2, &c2 );
 160       pixels_per_meter = ((gdouble)vik_viewport_get_width(widgets->vvp)) / vik_coord_diff(&c1, &c2);
 161
 162       /* this is approximate */
 163       widgets->circle_width = gtk_spin_button_get_value_as_float ( GTK_SPIN_BUTTON(widgets->miles_radius_spin) )
 164                 * METERSPERMILE * pixels_per_meter * 2;
 165
 166       vik_viewport_draw_arc ( widgets->vvp, widgets->circle_gc, FALSE,
 167                 widgets->circle_x - widgets->circle_width/2,
 168                 widgets->circle_y - widgets->circle_width/2,
 169                 widgets->circle_width, widgets->circle_width, 0, 360*64 );
 170
 171       widgets->circle_onscreen = TRUE;
 172     } else
 173       widgets->circle_onscreen = FALSE;
 174   }
 175
 176   /* see if onscreen */
 177   /* okay */
 178   vik_viewport_sync ( widgets->vvp );
 179 }
 180
 181 static void datasource_gc_add_setup_widgets ( GtkWidget *dialog, VikViewport *vvp, gpointer user_data )
 182 {
 183   datasource_gc_widgets_t *widgets = (datasource_gc_widgets_t *)user_data;
 184   GtkWidget *num_label, *center_label, *miles_radius_label;
 185   struct LatLon ll;
 186   gchar *s_ll;
 187
 188   num_label = gtk_label_new (_("Number geocaches:"));
 189   widgets->num_spin = gtk_spin_button_new ( GTK_ADJUSTMENT(gtk_adjustment_new( 20, 1, 1000, 10, 20, 0 )), 10, 0 );
 190   center_label = gtk_label_new (_("Centered around:"));
 191   widgets->center_entry = gtk_entry_new();
 192   miles_radius_label = gtk_label_new ("Miles Radius:");
 193   widgets->miles_radius_spin = gtk_spin_button_new ( GTK_ADJUSTMENT(gtk_adjustment_new( 5, 1, 1000, 1, 20, 0 )), 25, 1 );
 194
 195   vik_coord_to_latlon ( vik_viewport_get_center(vvp), &ll );
 196   s_ll = g_strdup_printf("%f,%f", ll.lat, ll.lon );
 197   gtk_entry_set_text ( GTK_ENTRY(widgets->center_entry), s_ll );
 198   g_free ( s_ll );
 199
 200
 201   widgets->vvp = vvp;
 202   widgets->circle_gc = vik_viewport_new_gc ( vvp, "#000000", 3 );
 203   gdk_gc_set_function ( widgets->circle_gc, GDK_INVERT );
 204   widgets->circle_onscreen = TRUE;
 205   datasource_gc_draw_circle ( widgets );
 206
 207   g_signal_connect_swapped ( G_OBJECT(widgets->center_entry), "changed", G_CALLBACK(datasource_gc_draw_circle), widgets );
 208   g_signal_connect_swapped ( G_OBJECT(widgets->miles_radius_spin), "value-changed", G_CALLBACK(datasource_gc_draw_circle), widgets );
 209
 210   gtk_box_pack_start ( GTK_BOX(GTK_DIALOG(dialog)->vbox), num_label, FALSE, FALSE, 5 );
 211   gtk_box_pack_start ( GTK_BOX(GTK_DIALOG(dialog)->vbox), widgets->num_spin, FALSE, FALSE, 5 );
 212   gtk_box_pack_start ( GTK_BOX(GTK_DIALOG(dialog)->vbox), center_label, FALSE, FALSE, 5 );
 213   gtk_box_pack_start ( GTK_BOX(GTK_DIALOG(dialog)->vbox), widgets->center_entry, FALSE, FALSE, 5 );
 214   gtk_box_pack_start ( GTK_BOX(GTK_DIALOG(dialog)->vbox), miles_radius_label, FALSE, FALSE, 5 );
 215   gtk_box_pack_start ( GTK_BOX(GTK_DIALOG(dialog)->vbox), widgets->miles_radius_spin, FALSE, FALSE, 5 );
 216   gtk_widget_show_all(dialog);
 217 }
 218
 219 static void datasource_gc_get_cmd_string ( datasource_gc_widgets_t *widgets, gchar **cmd, gchar **input_file_type )
 220 {
 221   //gchar *safe_string = g_shell_quote ( gtk_entry_get_text ( GTK_ENTRY(widgets->center_entry) ) );
 222   gchar *safe_user = g_shell_quote ( a_preferences_get ( VIKING_GC_PARAMS_NAMESPACE "username")->s );
 223   gchar *safe_pass = g_shell_quote ( a_preferences_get ( VIKING_GC_PARAMS_NAMESPACE "password")->s );
 224   gdouble lat, lon;
 225   if ( 2 != sscanf ( gtk_entry_get_text ( GTK_ENTRY(widgets->center_entry) ), "%lf,%lf", &lat, &lon ) ) {
 226     g_warning (_("Broken input - using some defaults"));
 227     lat = a_vik_get_default_lat();
 228     lon = a_vik_get_default_long();
 229   }
 230
 231   // Unix specific shell commands
 232   // 1. Remove geocache webpages (maybe be from different location)
 233   // 2, Gets upto n geocaches as webpages for the specified user in radius r Miles
 234   // 3. Converts webpages into a single waypoint file, ignoring zero location waypoints '-z'
 235   //       Probably as they are premium member only geocaches and user is only a basic member
 236   //  Final output is piped into GPSbabel - hence removal of *html is done at beginning of the command sequence
 237   *cmd = g_strdup_printf( "rm -f ~/.geo/caches/*html ; %s -P -n%d -r%.1fM -u %s -p %s %.4f %.4f ; %s -z ~/.geo/caches/*html ",
 238                           GC_PROGRAM1,
 239                           gtk_spin_button_get_value_as_int ( GTK_SPIN_BUTTON(widgets->num_spin) ),
 240                           gtk_spin_button_get_value_as_float ( GTK_SPIN_BUTTON(widgets->miles_radius_spin) ),
 241                           safe_user,
 242                           safe_pass,
 243                           lat, lon,
 244                           GC_PROGRAM2 );
 245   *input_file_type = NULL;
 246   //g_free ( safe_string );
 247   g_free ( safe_user );
 248   g_free ( safe_pass );
 249 }
 250
 251 static void datasource_gc_cleanup ( datasource_gc_widgets_t *widgets )
 252 {
 253   if ( widgets->circle_onscreen ) {
 254     vik_viewport_draw_arc ( widgets->vvp, widgets->circle_gc, FALSE,
 255                 widgets->circle_x - widgets->circle_width/2,
 256                 widgets->circle_y - widgets->circle_width/2,
 257                 widgets->circle_width, widgets->circle_width, 0, 360*64 );
 258     vik_viewport_sync( widgets->vvp );
 259   }
 260   g_free ( widgets );
 261 }
 262 #endif /* VIK_CONFIG_GEOCACHES */