]> git.street.me.uk Git - andy/viking.git/blob - src/file.c
New Google version numbers.
[andy/viking.git] / src / file.c
1 /*
2  * viking -- GPS Data and Topo Analyzer, Explorer, and Manager
3  *
4  * Copyright (C) 2003-2005, 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
22 #include "viking.h"
23
24 #include "gpx.h"
25
26 #include <string.h>
27 #include <stdlib.h>
28
29 #define TEST_BOOLEAN(str) (! ((str)[0] == '\0' || (str)[0] == '0' || (str)[0] == 'n' || (str)[0] == 'N' || (str)[0] == 'f' || (str)[0] == 'F') )
30 #define VIK_MAGIC "#VIK"
31 #define GPX_MAGIC "<?xm"
32 #define VIK_MAGIC_LEN 4
33
34 #ifdef WINDOWS
35 #define FILE_SEP '\\'
36 #else
37 #define FILE_SEP '/'
38 #endif
39
40 typedef struct _Stack Stack;
41
42 struct _Stack {
43   Stack *under;
44   gpointer *data;
45 };
46
47 static void pop(Stack **stack) {
48   Stack *tmp = (*stack)->under;
49   g_free ( *stack );
50   *stack = tmp;
51 }
52
53 static void push(Stack **stack)
54 {
55   Stack *tmp = g_malloc ( sizeof ( Stack ) );
56   tmp->under = *stack;
57   *stack = tmp;
58 }
59
60 static gboolean check_magic ( FILE *f, const gchar *magic_number )
61 {
62   gchar magic[VIK_MAGIC_LEN];
63   gboolean rv = FALSE;
64   gint8 i;
65   if ( fread(magic, 1, sizeof(magic), f) == sizeof(magic) &&
66       strncmp(magic, magic_number, sizeof(magic)) == 0 )
67     rv = TRUE;
68   for ( i = sizeof(magic)-1; i >= 0; i-- ) /* the ol' pushback */
69     ungetc(magic[i],f);
70   return rv;
71 }
72
73
74 static gboolean str_starts_with ( const gchar *haystack, const gchar *needle, guint16 len_needle, gboolean must_be_longer )
75 {
76   if ( strlen(haystack) > len_needle - (!must_be_longer) && strncasecmp ( haystack, needle, len_needle ) == 0 )
77     return TRUE;
78   return FALSE;
79 }
80
81 static guint16 layer_type_from_string ( const gchar *str )
82 {
83   guint8 i;
84   for ( i = 0; i < VIK_LAYER_NUM_TYPES; i++ )
85     if ( strcasecmp ( str, vik_layer_get_interface(i)->name ) == 0 )
86       return i;
87   return -1;
88 }
89
90 static void write_layer_params_and_data ( VikLayer *l, FILE *f )
91 {
92   VikLayerParam *params = vik_layer_get_interface(l->type)->params;
93   VikLayerFuncGetParam get_param = vik_layer_get_interface(l->type)->get_param;
94
95   fprintf ( f, "name=%s\n", l->name ? l->name : "" );
96   if ( !l->visible )
97     fprintf ( f, "visible=f\n" );
98
99   if ( params && get_param )
100   {
101     VikLayerParamData data;
102     guint16 i, params_count = vik_layer_get_interface(l->type)->params_count;
103     for ( i = 0; i < params_count; i++ )
104     {
105       data = get_param(l,i);
106       fprintf ( f, "%s=", params[i].name );
107       switch ( params[i].type )
108       {
109         case VIK_LAYER_PARAM_DOUBLE: {
110 //          char buf[15]; /* locale independent */
111 //          fprintf ( f, "%s\n", (char *) g_dtostr (data.d, buf, sizeof (buf)) ); break;
112             fprintf ( f, "%f\n", data.d );
113             break;
114        }
115         case VIK_LAYER_PARAM_UINT: fprintf ( f, "%d\n", data.u ); break;
116         case VIK_LAYER_PARAM_INT: fprintf ( f, "%d\n", data.i ); break;
117         case VIK_LAYER_PARAM_BOOLEAN: fprintf ( f, "%c\n", data.b ? 't' : 'f' ); break;
118         case VIK_LAYER_PARAM_STRING: fprintf ( f, "%s\n", data.s ); break;
119         case VIK_LAYER_PARAM_COLOR: fprintf ( f, "#%.2x%.2x%.2x\n", (int)(data.c.red/256),(int)(data.c.green/256),(int)(data.c.blue/256)); break;
120       }
121     }
122   }
123   if ( vik_layer_get_interface(l->type)->write_file_data )
124   {
125     fprintf ( f, "\n\n~LayerData\n" );
126     vik_layer_get_interface(l->type)->write_file_data ( l, f );
127     fprintf ( f, "~EndLayerData\n" );
128   }
129   /* foreach param:
130      write param, and get_value, etc.
131      then run layer data, and that's it.
132   */
133 }
134
135 static void file_write ( VikAggregateLayer *top, FILE *f, gpointer vp )
136 {
137   Stack *stack = NULL;
138   VikLayer *current_layer;
139   struct LatLon ll;
140   gchar *modestring;
141
142   push(&stack);
143   stack->data = (gpointer) vik_aggregate_layer_get_children(VIK_AGGREGATE_LAYER(top));
144   stack->under = NULL;
145
146   /* crazhy CRAZHY */
147   vik_coord_to_latlon ( vik_viewport_get_center ( VIK_VIEWPORT(vp) ), &ll );
148
149   switch ( vik_viewport_get_drawmode ( VIK_VIEWPORT(vp) ) ) {
150     case VIK_VIEWPORT_DRAWMODE_UTM: modestring = "utm"; break;
151     case VIK_VIEWPORT_DRAWMODE_EXPEDIA: modestring = "expedia"; break;
152     case VIK_VIEWPORT_DRAWMODE_GOOGLE: modestring = "google"; break;
153     case VIK_VIEWPORT_DRAWMODE_KH: modestring = "kh"; break;
154     default: modestring = "mercator";
155   }
156
157   fprintf ( f, "#VIKING GPS Data file " VIKING_URL "\n\nxmpp=%f\nympp=%f\nlat=%f\nlon=%f\nmode=%s\ncolor=%s\ndrawscale=%s\ndrawcentermark=%s",
158       vik_viewport_get_xmpp ( VIK_VIEWPORT(vp) ), vik_viewport_get_ympp ( VIK_VIEWPORT(vp) ), ll.lat, ll.lon,
159       modestring, vik_viewport_get_background_color(VIK_VIEWPORT(vp)),
160       vik_viewport_get_draw_scale(VIK_VIEWPORT(vp)) ? "t" : "f",
161       vik_viewport_get_draw_centermark(VIK_VIEWPORT(vp)) ? "t" : "f" );
162
163   if ( ! VIK_LAYER(top)->visible )
164     fprintf ( f, "visible=f\n" );
165
166   while (stack && stack->data)
167   {
168     current_layer = VIK_LAYER(((GList *)stack->data)->data);
169     fprintf ( f, "\n~Layer %s\n", vik_layer_get_interface(current_layer->type)->name );
170     write_layer_params_and_data ( current_layer, f );
171     if ( current_layer->type == VIK_LAYER_AGGREGATE && !vik_aggregate_layer_is_empty(VIK_AGGREGATE_LAYER(current_layer)) )
172     {
173       push(&stack);
174       stack->data = (gpointer) vik_aggregate_layer_get_children(VIK_AGGREGATE_LAYER(current_layer));
175     }
176     else if ( current_layer->type == VIK_LAYER_GPS && !vik_gps_layer_is_empty(VIK_GPS_LAYER(current_layer)) )
177     {
178       push(&stack);
179       stack->data = (gpointer) vik_gps_layer_get_children(VIK_GPS_LAYER(current_layer));
180     }
181     else
182     {
183       stack->data = (gpointer) ((GList *)stack->data)->next;
184       fprintf ( f, "~EndLayer\n\n" );
185       while ( stack && (!stack->data) )
186       {
187         pop(&stack);
188         if ( stack )
189         {
190           stack->data = (gpointer) ((GList *)stack->data)->next;
191           fprintf ( f, "~EndLayer\n\n" );
192         }
193       }
194     }
195   }
196 /*
197   get vikaggregatelayer's children (?)
198   foreach write ALL params,
199   then layer data (IF function exists)
200   then endlayer
201
202   impl:
203   stack of layers (LIST) we are working on
204   when layer->next == NULL ...
205   we move on.
206 */
207 }
208
209 static void file_read ( VikAggregateLayer *top, FILE *f, gpointer vp )
210 {
211   Stack *stack;
212   struct LatLon ll = { 0.0, 0.0 };
213   gchar buffer[4096];
214   gchar *line;
215   guint16 len;
216   long line_num = 0;
217
218   VikLayerParam *params; /* for current layer, so we don't have to keep on looking up interface */
219   guint8 params_count;
220
221   push(&stack);
222   stack->under = NULL;
223   stack->data = (gpointer) top;
224
225   while ( fgets ( buffer, 4096, f ) )
226   {
227     line_num++;
228
229     line = buffer;
230     while ( *line == ' ' || *line =='\t' )
231       line++;
232
233     if ( line[0] == '#' )
234       continue;
235     
236
237     len = strlen(line);
238     if ( len > 0 && line[len-1] == '\n' )
239       line[--len] = '\0';
240     if ( len > 0 && line[len-1] == '\r' )
241       line[--len] = '\0';
242
243     if ( len == 0 )
244       continue;
245
246
247     if ( line[0] == '~' )
248     {
249       line++; len--;
250       if ( *line == '\0' )
251         continue;
252       else if ( str_starts_with ( line, "Layer ", 6, TRUE ) )
253       {
254         int parent_type = VIK_LAYER(stack->data)->type;
255         if ( ( ! stack->data ) || ((parent_type != VIK_LAYER_AGGREGATE) && (parent_type != VIK_LAYER_GPS)) )
256         {
257           g_warning ( "Line %ld: Layer command inside non-Aggregate Layer (type %d)", line_num, parent_type );
258           push(&stack); /* inside INVALID layer */
259           stack->data = NULL;
260           continue;
261         }
262         else
263         {
264           gint16 type = layer_type_from_string ( line+6 );
265           push(&stack);
266           if ( type == -1 )
267           {
268             g_warning ( "Line %ld: Unknown type %s\n", line_num, line+6 );
269             stack->data = NULL;
270           }
271           else if (parent_type == VIK_LAYER_GPS)
272           {
273             stack->data = (gpointer) vik_gps_layer_get_a_child(VIK_GPS_LAYER(stack->under->data));
274             params = vik_layer_get_interface(type)->params;
275             params_count = vik_layer_get_interface(type)->params_count;
276           }
277           else
278           {
279             stack->data = (gpointer) vik_layer_create ( type, vp, NULL, FALSE );
280             params = vik_layer_get_interface(type)->params;
281             params_count = vik_layer_get_interface(type)->params_count;
282           }
283         }
284       }
285       else if ( str_starts_with ( line, "EndLayer", 8, FALSE ) )
286       {
287         if ( stack->under == NULL )
288           g_warning ( "Line %ld: Mismatched ~EndLayer command", line_num );
289         else
290         {
291           if ( stack->data && stack->under->data )
292           {
293             if (VIK_LAYER(stack->under->data)->type == VIK_LAYER_AGGREGATE) {
294               vik_aggregate_layer_add_layer ( VIK_AGGREGATE_LAYER(stack->under->data), VIK_LAYER(stack->data) );
295               vik_layer_post_read ( VIK_LAYER(stack->data), vp );
296             }
297             else if (VIK_LAYER(stack->under->data)->type == VIK_LAYER_GPS) {
298               /* TODO: anything else needs to be done here ? */
299             }
300             else
301               g_warning ( "Line %ld: EndLayer command inside non-Aggregate Layer (type %d)", line_num, VIK_LAYER(stack->data)->type );
302           }
303           pop(&stack);
304         }
305       }
306       else if ( str_starts_with ( line, "LayerData", 9, FALSE ) )
307       {
308         if ( stack->data && vik_layer_get_interface(VIK_LAYER(stack->data)->type)->read_file_data )
309           vik_layer_get_interface(VIK_LAYER(stack->data)->type)->read_file_data ( VIK_LAYER(stack->data), f );
310           /* must read until hits ~EndLayerData */
311
312         else
313         { /* simply skip layer data over */
314           while ( fgets ( buffer, 4096, f ) )
315           {
316             line_num++;
317
318             line = buffer;
319
320             len = strlen(line);
321             if ( len > 0 && line[len-1] == '\n' )
322               line[--len] = '\0';
323             if ( len > 0 && line[len-1] == '\r' )
324               line[--len] = '\0';
325             if ( strcasecmp ( line, "~EndLayerData" ) == 0 )
326               break;
327           }
328           continue;
329         }
330       }
331       else
332       {
333         g_warning ( "Line %ld: Unknown tilde command", line_num );
334       }
335     }
336     else
337     {
338       gint32 eq_pos = -1;
339       guint16 i;
340       if ( ! stack->data )
341         continue;
342
343       for ( i = 0; i < len; i++ )
344         if ( line[i] == '=' )
345           eq_pos = i;
346
347       if ( stack->under == NULL && eq_pos == 4 && strncasecmp ( line, "xmpp", eq_pos ) == 0) /* "hard coded" params: global & for all layer-types */
348         vik_viewport_set_xmpp ( VIK_VIEWPORT(vp), strtod ( line+5, NULL ) );
349       else if ( stack->under == NULL && eq_pos == 4 && strncasecmp ( line, "ympp", eq_pos ) == 0)
350         vik_viewport_set_ympp ( VIK_VIEWPORT(vp), strtod ( line+5, NULL ) );
351       else if ( stack->under == NULL && eq_pos == 3 && strncasecmp ( line, "lat", eq_pos ) == 0 )
352         ll.lat = strtod ( line+4, NULL );
353       else if ( stack->under == NULL && eq_pos == 3 && strncasecmp ( line, "lon", eq_pos ) == 0 )
354         ll.lon = strtod ( line+4, NULL );
355       else if ( stack->under == NULL && eq_pos == 4 && strncasecmp ( line, "mode", eq_pos ) == 0 && strcasecmp ( line+5, "utm" ) == 0)
356         vik_viewport_set_drawmode ( VIK_VIEWPORT(vp), VIK_VIEWPORT_DRAWMODE_UTM);
357       else if ( stack->under == NULL && eq_pos == 4 && strncasecmp ( line, "mode", eq_pos ) == 0 && strcasecmp ( line+5, "expedia" ) == 0)
358         vik_viewport_set_drawmode ( VIK_VIEWPORT(vp), VIK_VIEWPORT_DRAWMODE_EXPEDIA );
359       else if ( stack->under == NULL && eq_pos == 4 && strncasecmp ( line, "mode", eq_pos ) == 0 && strcasecmp ( line+5, "google" ) == 0)
360         vik_viewport_set_drawmode ( VIK_VIEWPORT(vp), VIK_VIEWPORT_DRAWMODE_GOOGLE );
361       else if ( stack->under == NULL && eq_pos == 4 && strncasecmp ( line, "mode", eq_pos ) == 0 && strcasecmp ( line+5, "kh" ) == 0)
362         vik_viewport_set_drawmode ( VIK_VIEWPORT(vp), VIK_VIEWPORT_DRAWMODE_KH );
363       else if ( stack->under == NULL && eq_pos == 4 && strncasecmp ( line, "mode", eq_pos ) == 0 && strcasecmp ( line+5, "mercator" ) == 0)
364         vik_viewport_set_drawmode ( VIK_VIEWPORT(vp), VIK_VIEWPORT_DRAWMODE_MERCATOR );
365       else if ( stack->under == NULL && eq_pos == 5 && strncasecmp ( line, "color", eq_pos ) == 0 )
366         vik_viewport_set_background_color ( VIK_VIEWPORT(vp), line+6 );
367       else if ( stack->under == NULL && eq_pos == 9 && strncasecmp ( line, "drawscale", eq_pos ) == 0 )
368         vik_viewport_set_draw_scale ( VIK_VIEWPORT(vp), TEST_BOOLEAN(line+10) );
369       else if ( stack->under == NULL && eq_pos == 9 && strncasecmp ( line, "drawcentermark", eq_pos ) == 0 )
370         vik_viewport_set_draw_centermark ( VIK_VIEWPORT(vp), TEST_BOOLEAN(line+10) );
371       else if ( stack->under && eq_pos == 4 && strncasecmp ( line, "name", eq_pos ) == 0 )
372         vik_layer_rename ( VIK_LAYER(stack->data), line+5 );
373       else if ( eq_pos == 7 && strncasecmp ( line, "visible", eq_pos ) == 0 )
374         VIK_LAYER(stack->data)->visible = TEST_BOOLEAN(line+8);
375       else if ( eq_pos != -1 && stack->under )
376       {
377         gboolean found_match = FALSE;
378         /* go thru layer params. if len == eq_pos && starts_with jazz, set it. */
379         /* also got to check for name and visible. */
380
381         if ( ! params )
382         {
383           g_warning ( "Line %ld: No options for this kind of layer", line_num );
384           continue;
385         }
386
387         for ( i = 0; i < params_count; i++ )
388           if ( strlen(params[i].name) == eq_pos && strncasecmp ( line, params[i].name, eq_pos ) == 0 )
389           {
390             VikLayerParamData x;
391             line += eq_pos+1;
392             switch ( params[i].type )
393             {
394               case VIK_LAYER_PARAM_DOUBLE: x.d = strtod(line, NULL); break;
395               case VIK_LAYER_PARAM_UINT: x.u = strtoul(line, NULL, 10); break;
396               case VIK_LAYER_PARAM_INT: x.i = strtol(line, NULL, 10); break;
397               case VIK_LAYER_PARAM_BOOLEAN: x.b = TEST_BOOLEAN(line); break;
398               case VIK_LAYER_PARAM_COLOR: memset(&(x.c), 0, sizeof(x.c)); /* default: black */
399                                           gdk_color_parse ( line, &(x.c) ); break;
400               default: x.s = line;
401             }
402             vik_layer_set_param ( VIK_LAYER(stack->data), i, x, vp );
403             found_match = TRUE;
404             break;
405           }
406         if ( ! found_match )
407           g_warning ( "Line %ld: Unknown parameter. Line:\n%s", line_num, line );
408       }
409       else
410         g_warning ( "Line %ld: Invalid parameter or parameter outside of layer.", line_num );
411     }
412 /* could be:
413 [Layer Type=Bla]
414 [EndLayer]
415 [LayerData]
416 name=this
417 #comment
418 */
419   }
420
421   while ( stack )
422   {
423     if ( stack->under && stack->under->data && stack->data )
424     {
425       vik_aggregate_layer_add_layer ( VIK_AGGREGATE_LAYER(stack->under->data), VIK_LAYER(stack->data) );
426       vik_layer_post_read ( VIK_LAYER(stack->data), vp );
427     }
428     pop(&stack);
429   }
430
431   if ( ll.lat != 0.0 || ll.lon != 0.0 )
432     vik_viewport_set_center_latlon ( VIK_VIEWPORT(vp), &ll );
433
434   if ( ( ! VIK_LAYER(top)->visible ) && VIK_LAYER(top)->realized )
435     vik_treeview_item_set_visible ( VIK_LAYER(top)->vt, &(VIK_LAYER(top)->iter), FALSE ); 
436 }
437
438 /*
439 read thru file
440 if "[Layer Type="
441   push(&stack)
442   new default layer of type (str_to_type) (check interface->name)
443 if "[EndLayer]"
444   VikLayer *vl = stack->data;
445   pop(&stack);
446   vik_aggregate_layer_add_layer(stack->data, vl);
447 if "[LayerData]"
448   vik_layer_data ( VIK_LAYER_DATA(stack->data), f, vp );
449
450 */
451
452 /* ---------------------------------------------------- */
453
454 static FILE *xfopen ( const char *fn, const char *mode )
455 {
456   if ( strcmp(fn,"-") == 0 )
457     return stdin;
458   else
459     return fopen(fn, "r");
460 }
461
462 static void xfclose ( FILE *f )
463 {
464   if ( f != stdin && f != stdout )
465     fclose ( f );
466 }
467
468 /* 0 on failure, 1 on success (vik file) 2 on success (other file) */
469 gshort a_file_load ( VikAggregateLayer *top, gpointer vp, const gchar *filename )
470 {
471   FILE *f = xfopen ( filename, "r" );
472
473   g_assert ( vp );
474
475   if ( ! f )
476     return 0;
477
478   if ( check_magic ( f, VIK_MAGIC ) )
479   {
480     file_read ( top, f, vp );
481     if ( f != stdin )
482       xfclose(f);
483     return 1;
484   }
485   else
486   {
487     VikCoord new_center;
488     VikLayer *vtl = vik_layer_create ( VIK_LAYER_TRW, vp, NULL, FALSE );
489     vik_layer_rename ( vtl, a_file_basename ( filename ) );
490
491     if ( check_magic ( f, GPX_MAGIC ) )
492       a_gpx_read_file ( VIK_TRW_LAYER(vtl), f );
493     else
494      a_gpspoint_read_file ( VIK_TRW_LAYER(vtl), f );
495
496     vik_layer_post_read ( vtl, vp );
497
498     vik_aggregate_layer_add_layer ( top, vtl );
499
500     if ( vik_trw_layer_find_center ( VIK_TRW_LAYER(vtl), &new_center ) )
501       vik_viewport_set_center_coord ( VIK_VIEWPORT(vp), &new_center );
502     xfclose(f);
503     return 2;
504   }
505 }
506
507 gboolean a_file_save ( VikAggregateLayer *top, gpointer vp, const gchar *filename )
508 {
509   FILE *f = fopen(filename, "w");
510
511   if ( ! f )
512     return FALSE;
513
514   file_write ( top, f, vp );
515
516   fclose(f);
517
518   return TRUE;
519 }
520
521
522 const gchar *a_file_basename ( const gchar *filename )
523 {
524   const gchar *t = filename + strlen(filename) - 1;
525   while ( --t > filename )
526     if ( *(t-1) == FILE_SEP )
527       break;
528   if ( t >= filename )
529     return t;
530   return filename;
531 }
532
533 gboolean a_file_export ( VikTrwLayer *vtl, const gchar *filename, gshort file_type )
534 {
535   FILE *f = fopen ( filename, "w" );
536   if ( f )
537   {
538     if ( file_type == FILE_TYPE_GPSMAPPER )
539       a_gpsmapper_write_file ( vtl, f );
540     else if ( file_type == FILE_TYPE_GPX )
541       a_gpx_write_file ( vtl, f );
542     else
543       a_gpspoint_write_file ( vtl, f );
544     fclose ( f );
545     return TRUE;
546   }
547   return FALSE;
548 }
549
550 const gchar *a_get_viking_dir()
551 {
552   static gchar *viking_dir = NULL;
553
554   if (!viking_dir) {
555     gchar *temp[] = {"/tmp/vikXXXXXX"};
556     gchar *home = getenv("HOME");
557     if (!home || access(home, W_OK))
558       home = mktemp(temp);
559     viking_dir = g_strdup_printf("%s/%s", home, ".viking");
560     if (access(viking_dir, F_OK))
561       mkdir(viking_dir, 0755);
562   }
563
564   return viking_dir;
565 }