src/preferences.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 #include <gtk/gtk.h>
  22 #include <glib/gi18n.h>
  23 #include <string.h>
  24 #include <stdio.h>
  25 #include <glib/gstdio.h>
  26 #include "preferences.h"
  27 #include "dir.h"
  28 #include "file.h"
  29 #include "util.h"
  30
  31 // TODO: STRING_LIST
  32 // TODO: share code in file reading
  33 // TODO: remove hackaround in show_window
  34
  35 #define VIKING_PREFS_FILE "viking.prefs"
  36
  37 static GPtrArray *params;
  38 static GHashTable *values;
  39 gboolean loaded;
  40
  41 /************ groups *********/
  42
  43 static GPtrArray *groups_names;
  44 static GHashTable *groups_keys_to_indices; // contains gint, NULL (0) is not found, instead 1 is used for 0, 2 for 1, etc.
  45
  46 static void preferences_groups_init()
  47 {
  48   groups_names = g_ptr_array_new();
  49   groups_keys_to_indices = g_hash_table_new_full ( g_str_hash, g_str_equal, g_free, NULL );
  50 }
  51
  52 static void preferences_groups_uninit()
  53 {
  54   g_ptr_array_free ( groups_names, TRUE );
  55   g_hash_table_destroy ( groups_keys_to_indices );
  56 }
  57
  58 void a_preferences_register_group ( const gchar *key, const gchar *name )
  59 {
  60   if ( g_hash_table_lookup ( groups_keys_to_indices, key ) )
  61     g_critical("Duplicate preferences group keys");
  62   else {
  63     g_ptr_array_add ( groups_names, g_strdup(name) );
  64     g_hash_table_insert ( groups_keys_to_indices, g_strdup(key), GINT_TO_POINTER ( (gint) groups_names->len ) ); /* index + 1 */
  65   }
  66 }
  67
  68 /* returns -1 if not found. */
  69 static gint16 preferences_groups_key_to_index( const gchar *key )
  70 {
  71   gint index = GPOINTER_TO_INT ( g_hash_table_lookup ( groups_keys_to_indices, key ) );
  72   if ( ! index )
  73     return VIK_LAYER_GROUP_NONE; /* which should be -1 anyway */
  74   return (gint16) (index - 1);
  75 }
  76
  77 /*****************************/
  78
  79 static gboolean preferences_load_from_file()
  80 {
  81   gchar *fn = g_build_filename(a_get_viking_dir(), VIKING_PREFS_FILE, NULL);
  82   FILE *f = g_fopen(fn, "r");
  83   g_free ( fn );
  84
  85   if ( f ) {
  86     gchar buf[4096];
  87     gchar *key, *val;
  88     VikLayerTypedParamData *oldval, *newval;
  89     while ( ! feof (f) ) {
  90       if (fgets(buf,sizeof(buf),f) == NULL)
  91         break;
  92       if ( split_string_from_file_on_equals ( buf, &key, &val ) ) {
  93         // if it's not in there, ignore it
  94         oldval = g_hash_table_lookup ( values, key );
  95         if ( ! oldval ) {
  96           g_free(key);
  97           g_free(val);
  98           continue;
  99         }
 100
 101         // otherwise change it (you know the type!)
 102         // if it's a string list do some funky stuff ... yuck... not yet.
 103         if ( oldval->type == VIK_LAYER_PARAM_STRING_LIST )
 104           g_critical ( "Param strings not implemented in preferences"); // fake it
 105
 106         newval = vik_layer_data_typed_param_copy_from_string ( oldval->type, val );
 107         g_hash_table_insert ( values, key, newval );
 108
 109         g_free(key);
 110         g_free(val);
 111         // change value
 112       }
 113     }
 114     fclose(f);
 115     f = NULL;
 116     return TRUE;
 117   }
 118   return FALSE;
 119 }
 120
 121 static void preferences_run_setparam ( gpointer notused, guint16 i, VikLayerParamData data, VikLayerParam *params )
 122 {
 123   if ( params[i].type == VIK_LAYER_PARAM_STRING_LIST )
 124     g_critical ( "Param strings not implemented in preferences"); //fake it
 125   g_hash_table_insert ( values, (gchar *)(params[i].name), vik_layer_typed_param_data_copy_from_data(params[i].type, data) );
 126 }
 127
 128 /* Allow preferences to be manipulated externally */
 129 void a_preferences_run_setparam ( VikLayerParamData data, VikLayerParam *params )
 130 {
 131   preferences_run_setparam (NULL, 0, data, params);
 132 }
 133
 134 static VikLayerParamData preferences_run_getparam ( gpointer notused, guint16 i, gboolean notused2 )
 135 {
 136   VikLayerTypedParamData *val = (VikLayerTypedParamData *) g_hash_table_lookup ( values, ((VikLayerParam *)g_ptr_array_index(params,i))->name );
 137   g_assert ( val != NULL );
 138   if ( val->type == VIK_LAYER_PARAM_STRING_LIST )
 139     g_critical ( "Param strings not implemented in preferences"); //fake it
 140   return val->data;
 141 }
 142
 143 /* TRUE on success */
 144 gboolean a_preferences_save_to_file()
 145 {
 146   gchar *fn = g_build_filename(a_get_viking_dir(), VIKING_PREFS_FILE, NULL);
 147
 148   // TODO: error checking
 149   FILE *f = g_fopen(fn, "w");
 150   /* Since preferences files saves OSM login credentials,
 151    * it'll be better to store it in secret.
 152    */
 153   g_chmod(fn, 0600);
 154   g_free ( fn );
 155
 156   if ( f ) {
 157     VikLayerParam *param;
 158     VikLayerTypedParamData *val;
 159     int i;
 160     for ( i = 0; i < params->len; i++ ) {
 161       param = (VikLayerParam *) g_ptr_array_index(params,i);
 162       val = (VikLayerTypedParamData *) g_hash_table_lookup ( values, param->name );
 163       g_assert ( val != NULL );
 164       file_write_layer_param ( f, param->name, val->type, val->data );
 165     }
 166     fclose(f);
 167     f = NULL;
 168     return TRUE;
 169   }
 170
 171   return FALSE;
 172 }
 173
 174
 175 void a_preferences_show_window(GtkWindow *parent) {
 176     //VikLayerParamData *a_uibuilder_run_dialog ( GtkWindow *parent, VikLayerParam \*params, // guint16 params_count, gchar **groups, guint8 groups_count, // VikLayerParamData *params_defaults )
 177     // TODO: THIS IS A MAJOR HACKAROUND, but ok when we have only a couple preferences.
 178     gint params_count = params->len;
 179     VikLayerParam *contiguous_params = g_new(VikLayerParam,params_count);
 180     int i;
 181     for ( i = 0; i < params->len; i++ ) {
 182       contiguous_params[i] = *((VikLayerParam*)(g_ptr_array_index(params,i)));
 183     }
 184     loaded = TRUE;
 185     preferences_load_from_file();
 186     if ( a_uibuilder_properties_factory ( _("Preferences"), parent, contiguous_params, params_count,
 187                                 (gchar **) groups_names->pdata, groups_names->len, // groups, groups_count, // groups? what groups?!
 188                                 (gboolean (*) (gpointer,guint16,VikLayerParamData,gpointer,gboolean)) preferences_run_setparam,
 189                                 NULL /* not used */, contiguous_params,
 190                                 preferences_run_getparam, NULL /* not used */ ) ) {
 191       a_preferences_save_to_file();
 192     }
 193     g_free ( contiguous_params );
 194 }
 195
 196 void a_preferences_register(VikLayerParam *pref, VikLayerParamData defaultval, const gchar *group_key )
 197 {
 198   /* copy value */
 199   VikLayerParam *newpref = g_new(VikLayerParam,1);
 200   *newpref = *pref;
 201   VikLayerTypedParamData *newval = vik_layer_typed_param_data_copy_from_data(pref->type, defaultval);
 202   if ( group_key )
 203     newpref->group = preferences_groups_key_to_index ( group_key );
 204
 205   g_ptr_array_add ( params, newpref );
 206   g_hash_table_insert ( values, (gchar *)pref->name, newval );
 207 }
 208
 209 void a_preferences_init()
 210 {
 211   preferences_groups_init();
 212
 213   /* not copied */
 214   params = g_ptr_array_new ();
 215
 216   /* key not copied (same ptr as in pref), actual param data yes */
 217   values = g_hash_table_new_full ( g_str_hash, g_str_equal, NULL, vik_layer_typed_param_data_free);
 218
 219   loaded = FALSE;
 220 }
 221
 222 void a_preferences_uninit()
 223 {
 224   preferences_groups_uninit();
 225
 226   g_ptr_array_free ( params, TRUE );
 227   g_hash_table_destroy ( values );
 228 }
 229
 230
 231
 232 VikLayerParamData *a_preferences_get(const gchar *key)
 233 {
 234   if ( ! loaded ) {
 235     /* since we can't load the file in a_preferences_init (no params registered yet),
 236      * do it once before we get the first key. */
 237     preferences_load_from_file();
 238     loaded = TRUE;
 239   }
 240   return g_hash_table_lookup ( values, key );
 241 }