altoslib: Make AltosPreferencesBackend abstract. Add set/put Serializable
[fw/altos] / altoslib / AltosPreferences.java
1 /*
2  * Copyright © 2010 Keith Packard <keithp@keithp.com>
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation; version 2 of the License.
7  *
8  * This program is distributed in the hope that it will be useful, but
9  * WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11  * General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License along
14  * with this program; if not, write to the Free Software Foundation, Inc.,
15  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
16  */
17
18 package org.altusmetrum.altoslib_10;
19
20 import java.io.*;
21 import java.util.*;
22 import java.text.*;
23
24 public class AltosPreferences {
25         public static AltosPreferencesBackend backend = null;
26
27         /* logdir preference name */
28         public final static String logdirPreference = "LOGDIR";
29
30         /* channel preference name */
31         public final static String channelPreferenceFormat = "CHANNEL-%d";
32
33         /* frequency preference name */
34         public final static String frequencyPreferenceFormat = "FREQUENCY-%d";
35
36         /* telemetry format preference name */
37         public final static String telemetryPreferenceFormat = "TELEMETRY-%d";
38
39         /* telemetry rate format preference name */
40         public final static String telemetryRatePreferenceFormat = "RATE-%d";
41
42         /* log file format preference name */
43         public final static String logfilePreferenceFormat = "LOGFILE-%d";
44
45         /* state preference name */
46         public final static String statePreferenceHead = "STATE-";
47         public final static String statePreferenceFormat = "STATE-%d";
48         public final static String statePreferenceLatest = "STATE-LATEST";
49
50         /* voice preference name */
51         public final static String voicePreference = "VOICE";
52
53         /* callsign preference name */
54         public final static String callsignPreference = "CALLSIGN";
55
56         /* firmware directory preference name */
57         public final static String firmwaredirPreference = "FIRMWARE";
58
59         /* serial debug preference name */
60         public final static String serialDebugPreference = "SERIAL-DEBUG";
61
62         /* scanning telemetry preferences name */
63         public final static String scanningTelemetryPreference = "SCANNING-TELEMETRY";
64
65         /* scanning telemetry rate preferences name */
66         public final static String scanningTelemetryRatePreference = "SCANNING-RATE";
67
68         /* Launcher serial preference name */
69         public final static String launcherSerialPreference = "LAUNCHER-SERIAL";
70
71         /* Launcher channel preference name */
72         public final static String launcherChannelPreference = "LAUNCHER-CHANNEL";
73
74         /* Default logdir is ~/TeleMetrum */
75         public final static String logdirName = "TeleMetrum";
76
77         /* Log directory */
78         public static File logdir;
79
80         /* Last log directory - use this next time we open or save something */
81         public static File last_logdir;
82
83         /* Map directory -- hangs of logdir */
84         public static File mapdir;
85
86         /* Frequency (map serial to frequency) */
87         public static Hashtable<Integer, Double> frequencies;
88
89         /* Telemetry (map serial to telemetry format) */
90         public static Hashtable<Integer, Integer> telemetries;
91
92         /* Telemetry rate (map serial to telemetry format) */
93         public static Hashtable<Integer, Integer> telemetry_rates;
94
95         /* Log file (map serial to logfile name) */
96         public static Hashtable<Integer, File> logfiles;
97
98         /* Voice preference */
99         public static boolean voice;
100
101         /* Callsign preference */
102         public static String callsign;
103
104         /* Firmware directory */
105         public static File firmwaredir;
106
107         /* Scanning telemetry */
108         public static int scanning_telemetry;
109
110         public static int scanning_telemetry_rate;
111
112         /* List of frequencies */
113         public final static String common_frequencies_node_name = "COMMON-FREQUENCIES";
114         public static AltosFrequency[] common_frequencies;
115
116         public final static String      frequency_count = "COUNT";
117         public final static String      frequency_format = "FREQUENCY-%d";
118         public final static String      description_format = "DESCRIPTION-%d";
119         public final static String      frequenciesPreference = "FREQUENCIES";
120
121         /* Units preference */
122
123         public final static String      unitsPreference = "IMPERIAL-UNITS";
124
125         /* Maps cache size preference name */
126         final static String mapCachePreference = "MAP-CACHE";
127
128         static LinkedList<AltosMapCacheListener> map_cache_listeners;
129
130         public static int map_cache = 9;
131
132         final static String mapTypePreference = "MAP-TYPE";
133         static int      map_type;
134
135         public static AltosFrequency[] load_common_frequencies() {
136
137                 AltosFrequency[] frequencies = null;
138
139                 frequencies = (AltosFrequency[]) backend.getSerializable(frequenciesPreference, null);
140
141                 if (frequencies == null) {
142                         if (backend.nodeExists(common_frequencies_node_name)) {
143                                 AltosPreferencesBackend node = backend.node(common_frequencies_node_name);
144                                 int             count = node.getInt(frequency_count, 0);
145
146                                 frequencies = new AltosFrequency[count];
147                                 for (int i = 0; i < count; i++) {
148                                         double  frequency;
149                                         String  description;
150
151                                         frequency = node.getDouble(String.format(frequency_format, i), 0.0);
152                                         description = node.getString(String.format(description_format, i), null);
153                                         frequencies[i] = new AltosFrequency(frequency, description);
154                                 }
155                         }
156                 }
157
158                 if (frequencies == null) {
159                         frequencies = new AltosFrequency[10];
160                         for (int i = 0; i < 10; i++) {
161                                 frequencies[i] = new AltosFrequency(434.550 + i * .1,
162                                                                            String.format("Channel %d", i));
163                         }
164                 }
165                 return frequencies;
166         }
167
168         public static int launcher_serial;
169
170         public static int launcher_channel;
171
172         public static void init(AltosPreferencesBackend in_backend) {
173
174                 if (backend != null)
175                         return;
176
177                 backend = in_backend;
178
179                 /* Initialize logdir from preferences */
180                 String logdir_string = backend.getString(logdirPreference, null);
181                 if (logdir_string != null)
182                         logdir = new File(logdir_string);
183                 else {
184                         logdir = new File(backend.homeDirectory(), logdirName);
185                         if (!logdir.exists())
186                                 logdir.mkdirs();
187                 }
188                 mapdir = new File(logdir, "maps");
189                 if (!mapdir.exists())
190                         mapdir.mkdirs();
191
192                 frequencies = new Hashtable<Integer, Double>();
193
194                 telemetries = new Hashtable<Integer,Integer>();
195
196                 telemetry_rates = new Hashtable<Integer,Integer>();
197
198                 logfiles = new Hashtable<Integer,File>();
199
200                 voice = backend.getBoolean(voicePreference, true);
201
202                 callsign = backend.getString(callsignPreference,"N0CALL");
203
204                 scanning_telemetry = backend.getInt(scanningTelemetryPreference,(1 << AltosLib.ao_telemetry_standard));
205
206                 scanning_telemetry_rate = backend.getInt(scanningTelemetryRatePreference,(1 << AltosLib.ao_telemetry_rate_38400));
207
208                 launcher_serial = backend.getInt(launcherSerialPreference, 0);
209
210                 launcher_channel = backend.getInt(launcherChannelPreference, 0);
211
212                 String firmwaredir_string = backend.getString(firmwaredirPreference, null);
213                 if (firmwaredir_string != null)
214                         firmwaredir = new File(firmwaredir_string);
215                 else
216                         firmwaredir = null;
217
218                 common_frequencies = load_common_frequencies();
219
220                 AltosConvert.imperial_units = backend.getBoolean(unitsPreference, false);
221
222                 map_cache = backend.getInt(mapCachePreference, 9);
223                 map_cache_listeners = new LinkedList<AltosMapCacheListener>();
224                 map_type = backend.getInt(mapTypePreference, AltosMap.maptype_hybrid);
225         }
226
227         public static void flush_preferences() {
228                 backend.flush();
229         }
230
231         public static void set_logdir(File new_logdir) {
232                 synchronized (backend) {
233                         logdir = new_logdir;
234                         mapdir = new File(logdir, "maps");
235                         if (!mapdir.exists())
236                                 mapdir.mkdirs();
237                         backend.putString(logdirPreference, logdir.getPath());
238                         flush_preferences();
239                 }
240         }
241
242         public static File logdir() {
243                 synchronized (backend) {
244                         return logdir;
245                 }
246         }
247
248         public static File last_logdir() {
249                 synchronized (backend) {
250                         if (last_logdir == null)
251                                 last_logdir = logdir;
252                         return last_logdir;
253                 }
254         }
255
256         public static void set_last_logdir(File file) {
257                 synchronized(backend) {
258                         if (file != null && !file.isDirectory())
259                                 file = file.getParentFile();
260                         if (file == null)
261                                 file = new File(".");
262                         last_logdir = file;
263                 }
264         }
265
266         public static File mapdir() {
267                 synchronized (backend) {
268                         return mapdir;
269                 }
270         }
271
272         public static void set_frequency(int serial, double new_frequency) {
273                 synchronized (backend) {
274                         frequencies.put(serial, new_frequency);
275                         backend.putDouble(String.format(frequencyPreferenceFormat, serial), new_frequency);
276                         flush_preferences();
277                 }
278         }
279
280         public static double frequency(int serial) {
281                 synchronized (backend) {
282                         if (frequencies.containsKey(serial))
283                                 return frequencies.get(serial);
284                         double frequency = backend.getDouble(String.format(frequencyPreferenceFormat, serial), 0);
285                         if (frequency == 0.0) {
286                                 int channel = backend.getInt(String.format(channelPreferenceFormat, serial), 0);
287                                 frequency = AltosConvert.radio_channel_to_frequency(channel);
288                         }
289                         frequencies.put(serial, frequency);
290                         return frequency;
291                 }
292         }
293
294         public static void set_telemetry(int serial, int new_telemetry) {
295                 synchronized (backend) {
296                         telemetries.put(serial, new_telemetry);
297                         backend.putInt(String.format(telemetryPreferenceFormat, serial), new_telemetry);
298                         flush_preferences();
299                 }
300         }
301
302         public static int telemetry(int serial) {
303                 synchronized (backend) {
304                         if (telemetries.containsKey(serial))
305                                 return telemetries.get(serial);
306                         int telemetry = backend.getInt(String.format(telemetryPreferenceFormat, serial),
307                                                    AltosLib.ao_telemetry_standard);
308                         telemetries.put(serial, telemetry);
309                         return telemetry;
310                 }
311         }
312
313         public static void set_telemetry_rate(int serial, int new_telemetry_rate) {
314                 synchronized (backend) {
315                         telemetry_rates.put(serial, new_telemetry_rate);
316                         backend.putInt(String.format(telemetryRatePreferenceFormat, serial), new_telemetry_rate);
317                         flush_preferences();
318                 }
319         }
320
321         public static int telemetry_rate(int serial) {
322                 synchronized (backend) {
323                         if (telemetry_rates.containsKey(serial))
324                                 return telemetry_rates.get(serial);
325                         int telemetry_rate = backend.getInt(String.format(telemetryRatePreferenceFormat, serial),
326                                                             AltosLib.ao_telemetry_rate_38400);
327                         telemetry_rates.put(serial, telemetry_rate);
328                         return telemetry_rate;
329                 }
330         }
331
332         public static void set_logfile(int serial, File new_logfile) {
333                 synchronized(backend) {
334                         logfiles.put(serial, new_logfile);
335                         backend.putString(String.format(logfilePreferenceFormat, serial), new_logfile.getPath());
336                         flush_preferences();
337                 }
338         }
339
340         public static File logfile(int serial) {
341                 synchronized(backend) {
342                         if (logfiles.containsKey(serial))
343                                 return logfiles.get(serial);
344                         String logfile_string = backend.getString(String.format(logfilePreferenceFormat, serial), null);
345                         if (logfile_string == null)
346                                 return null;
347                         File logfile = new File(logfile_string);
348                         logfiles.put(serial, logfile);
349                         return logfile;
350                 }
351         }
352
353         public static void set_state(int serial, AltosState state, AltosListenerState listener_state) {
354
355                 synchronized(backend) {
356                         backend.putSerializable(String.format(statePreferenceFormat, serial),
357                                                 new AltosSavedState(state, listener_state));
358                         backend.putInt(statePreferenceLatest, serial);
359                 }
360         }
361
362         public static ArrayList<Integer> list_states() {
363                 String[]                keys = backend.keys();
364                 ArrayList<Integer>      states = new ArrayList<Integer>();
365
366                 for (String key : keys) {
367                         if (key.startsWith(statePreferenceHead)) {
368                                 try {
369                                         int serial = AltosParse.parse_int(key.substring(statePreferenceHead.length()));
370                                         states.add(serial);
371                                 } catch (ParseException pe) {
372                                 }
373                         }
374                 }
375                 return states;
376         }
377
378         public static void remove_state(int serial) {
379                 synchronized(backend) {
380                         backend.remove(String.format(statePreferenceFormat, serial));
381                 }
382         }
383
384         public static int latest_state() {
385                 int     latest = 0;
386                 synchronized (backend) {
387                         latest = backend.getInt(statePreferenceLatest, 0);
388                 }
389                 return latest;
390         }
391
392         public static AltosSavedState state(int serial) {
393                 synchronized(backend) {
394                         return (AltosSavedState) backend.getSerializable(String.format(statePreferenceFormat, serial), null);
395                 }
396         }
397
398         public static void set_scanning_telemetry(int new_scanning_telemetry) {
399                 synchronized (backend) {
400                         scanning_telemetry = new_scanning_telemetry;
401                         backend.putInt(scanningTelemetryPreference, scanning_telemetry);
402                         flush_preferences();
403                 }
404         }
405
406         public static int scanning_telemetry() {
407                 synchronized (backend) {
408                         return scanning_telemetry;
409                 }
410         }
411
412         public static void set_scanning_telemetry_rate(int new_scanning_telemetry_rate) {
413                 synchronized (backend) {
414                         scanning_telemetry_rate = new_scanning_telemetry_rate;
415                         backend.putInt(scanningTelemetryRatePreference, scanning_telemetry_rate);
416                         flush_preferences();
417                 }
418         }
419
420         public static int scanning_telemetry_rate() {
421                 synchronized(backend) {
422                         return scanning_telemetry_rate;
423                 }
424         }
425
426         public static void set_voice(boolean new_voice) {
427                 synchronized (backend) {
428                         voice = new_voice;
429                         backend.putBoolean(voicePreference, voice);
430                         flush_preferences();
431                 }
432         }
433
434         public static boolean voice() {
435                 synchronized (backend) {
436                         return voice;
437                 }
438         }
439
440         public static void set_callsign(String new_callsign) {
441                 synchronized(backend) {
442                         callsign = new_callsign;
443                         backend.putString(callsignPreference, callsign);
444                         flush_preferences();
445                 }
446         }
447
448         public static String callsign() {
449                 synchronized(backend) {
450                         return callsign;
451                 }
452         }
453
454         public static void set_firmwaredir(File new_firmwaredir) {
455                 synchronized (backend) {
456                         firmwaredir = new_firmwaredir;
457                         backend.putString(firmwaredirPreference, firmwaredir.getPath());
458                         flush_preferences();
459                 }
460         }
461
462         public static File firmwaredir() {
463                 synchronized (backend) {
464                         return firmwaredir;
465                 }
466         }
467
468         public static void set_launcher_serial(int new_launcher_serial) {
469                 synchronized (backend) {
470                         launcher_serial = new_launcher_serial;
471                         backend.putInt(launcherSerialPreference, launcher_serial);
472                         flush_preferences();
473                 }
474         }
475
476         public static int launcher_serial() {
477                 synchronized (backend) {
478                         return launcher_serial;
479                 }
480         }
481
482         public static void set_launcher_channel(int new_launcher_channel) {
483                 synchronized (backend) {
484                         launcher_channel = new_launcher_channel;
485                         backend.putInt(launcherChannelPreference, launcher_channel);
486                         flush_preferences();
487                 }
488         }
489
490         public static int launcher_channel() {
491                 synchronized (backend) {
492                         return launcher_channel;
493                 }
494         }
495
496         public static AltosPreferencesBackend bt_devices() {
497                 synchronized (backend) {
498                         return backend.node("bt_devices");
499                 }
500         }
501
502         public static AltosFrequency[] common_frequencies() {
503                 synchronized (backend) {
504                         return common_frequencies;
505                 }
506         }
507
508         public static void set_common_frequencies(AltosFrequency[] frequencies) {
509                 synchronized(backend) {
510                         common_frequencies = frequencies;
511                         backend.putSerializable(frequenciesPreference, frequencies);
512                         flush_preferences();
513                 }
514         }
515
516         public static void add_common_frequency(AltosFrequency frequency) {
517                 AltosFrequency[]        old_frequencies = common_frequencies();
518                 AltosFrequency[]        new_frequencies = new AltosFrequency[old_frequencies.length + 1];
519                 int                     i;
520
521                 for (i = 0; i < old_frequencies.length; i++) {
522                         if (frequency.frequency == old_frequencies[i].frequency)
523                                 return;
524                         if (frequency.frequency < old_frequencies[i].frequency)
525                                 break;
526                         new_frequencies[i] = old_frequencies[i];
527                 }
528                 new_frequencies[i] = frequency;
529                 for (; i < old_frequencies.length; i++)
530                         new_frequencies[i+1] = old_frequencies[i];
531                 set_common_frequencies(new_frequencies);
532         }
533
534         static LinkedList<AltosUnitsListener> units_listeners;
535
536         public static boolean imperial_units() {
537                 synchronized(backend) {
538                         return AltosConvert.imperial_units;
539                 }
540         }
541
542         public static void set_imperial_units(boolean imperial_units) {
543                 synchronized (backend) {
544                         AltosConvert.imperial_units = imperial_units;
545                         backend.putBoolean(unitsPreference, imperial_units);
546                         flush_preferences();
547                 }
548                 if (units_listeners != null) {
549                         for (AltosUnitsListener l : units_listeners) {
550                                 l.units_changed(imperial_units);
551                         }
552                 }
553         }
554
555         public static void register_units_listener(AltosUnitsListener l) {
556                 synchronized(backend) {
557                         if (units_listeners == null)
558                                 units_listeners = new LinkedList<AltosUnitsListener>();
559                         units_listeners.add(l);
560                 }
561         }
562
563         public static void unregister_units_listener(AltosUnitsListener l) {
564                 synchronized(backend) {
565                         units_listeners.remove(l);
566                 }
567         }
568
569
570         public static void register_map_cache_listener(AltosMapCacheListener l) {
571                 synchronized(backend) {
572                         map_cache_listeners.add(l);
573                 }
574         }
575
576         public static void unregister_map_cache_listener(AltosMapCacheListener l) {
577                 synchronized (backend) {
578                         map_cache_listeners.remove(l);
579                 }
580         }
581
582         public static void set_map_cache(int new_map_cache) {
583                 synchronized(backend) {
584                         map_cache = new_map_cache;
585                         backend.putInt(mapCachePreference, map_cache);
586                         flush_preferences();
587                         for (AltosMapCacheListener l: map_cache_listeners)
588                                 l.map_cache_changed(map_cache);
589                 }
590         }
591
592         public static int map_cache() {
593                 synchronized(backend) {
594                         return map_cache;
595                 }
596         }
597
598         static LinkedList<AltosMapTypeListener> map_type_listeners;
599
600         public static void set_map_type(int map_type) {
601                 synchronized(backend) {
602                         AltosPreferences.map_type = map_type;
603                         backend.putInt(mapTypePreference, map_type);
604                         flush_preferences();
605                 }
606                 if (map_type_listeners != null) {
607                         for (AltosMapTypeListener l : map_type_listeners) {
608                                 l.map_type_changed(map_type);
609                         }
610                 }
611         }
612
613         public static int map_type() {
614                 synchronized(backend) {
615                         return map_type;
616                 }
617         }
618
619         public static void register_map_type_listener(AltosMapTypeListener l) {
620                 synchronized(backend) {
621                         if (map_type_listeners == null)
622                                 map_type_listeners = new LinkedList<AltosMapTypeListener>();
623                         map_type_listeners.add(l);
624                 }
625         }
626
627         public static void unregister_map_type_listener(AltosMapTypeListener l) {
628                 synchronized(backend) {
629                         map_type_listeners.remove(l);
630                 }
631         }
632 }