To get this branch, use:
bzr branch
http://gegoxaren.bato24.eu/bzr/gpump/trunk
« back to all changes in this revision
Viewing changes to src/settings_data.js
- browse files at revision 21
- compare with another revision
- download diff
- download tarball
- view history from revision 21
- Committer: Gustav Hatvigsson
- Date: 2014-04-14 07:33:32 UTC
- Revision ID: gustav.hartvigsson@gmail.com-20140414073332-eagun3d8y56k3dtd
* Switched to GKeyFile instead of GSettings, for the time being.
** This is untested code **
** This is untested code **
- files added:
- src/GPumpApp.c
- files removed:
- locale
- files modified:
- HACKING
added
removed
src/settings_data.js
1
/* This file is part of GPump, a Pump.io client.
2
*
3
* GPump (THE SOFTWARE) is made available under the terms and conditions of the
4
* GNU Lesser General Public Licence 3.0. A copy of the licence can be read
5
* in the file lgpl-3.0.txt in the root of this project.
6
*/
7
8
9
const Gio = imports.gi.Gio;
10
const GLib = imports.gi.GLib;
11
const GObject = imports.gi.GObject;
12
const Lang = imports.lang;
13
const System = imports.system;
14
15
let _default_settings_object = null;
16
17
/** @file
18
*/
19
20
/** @function
21
* Please use this function when getting the settings data object. It is not
22
* good to have multiple instances of the settings data object, it may
23
* cause problems down the line.
24
*
25
* @return The the default @c SettingsData object
26
*/
27
function get_settings () {
28
if (!_default_settings_object) {
29
_default_settings_object = new SettingsData ();
30
}
31
return _default_settings_object;
32
}
33
34
/** @enum
35
*/
36
const QUIT_ON_CLOSE = {
37
/**
38
* Default value, will show the close dialogue on clicking the close button
39
* in the main window.
40
*/
41
UNKNOWN: -1,
42
/** Will not exist the app on close of main window */
43
NO: 0,
44
/** Will exit on close of main window */
45
YES: 1
46
}
47
48
/** @class
49
* NO NOT CREATE INSTANCES FROM THIS OBJECT, USE THE get_settings () FUNCTION!
50
*/
51
const SettingsData = new Lang.Class ({
52
Name: 'SettingsData',
53
Extends: GObject.Object,
54
Signals: {
55
/** @signal change
56
* When hooking up to this signal check that the name of the change.
57
*
58
* The function signature is <code> function my_callback (String: setting,
59
* Value: value) </code> where @c setting is the name of the setting,
60
* and @c value is the value to be that it has changed to.
61
*
62
* @warning Always check the @c value type and the @c setting name.
63
*
64
* @return void
65
*/
66
'change': {
67
param_types: [GObject.TYPE_STRING, GObject.TYPE_INT]
68
}
69
},
70
71
72
/* Member definitions */
73
_settings_file_path: String,
74
_settings: Array,
75
_settings_file: Gio.File,
76
77
/**
78
*
79
*/
80
_init: function (params) {
81
this.parent (params);
82
83
/* First we construct the path for where to store the settings file. */
84
this._settings_file_path = "" +
85
GLib.get_user_config_dir () +
86
"/gpump/gpump.json";
87
print ("Config file is: " + this._settings_file_path);
88
89
this._settings_file = Gio.File.new_for_path (this._settings_file_path);
90
91
/* Then we check that the file exists. If the file does not exists we
92
* construct some sane default values.
93
*/
94
if (!GLib.file_test (this._settings_file_path, GLib.FileTest.EXISTS)) {
95
/* -1 is undefined, and will be set at construction of the window */
96
this._settings = {
97
ui: {
98
x: -1,
99
y: -1,
100
h: 500,
101
w: 500
102
},
103
main: {
104
privacy: {
105
show_full_name: true,
106
only_show_avatar: false
107
},
108
use_dark: false,
109
first_run: true,
110
quit_on_close: QUIT_ON_CLOSE.UNKNOWN
111
}
112
};
113
// DEBUG:
114
print (JSON.stringify (this._settings, null, 2).toString () );
115
116
// Check if the folder exists, and if it does not exist, create it.
117
let folder_path = "" + GLib.get_user_config_dir () +
118
"/gpump/"
119
let folder = Gio.File.new_for_path (folder_path);
120
if (!GLib.file_test (folder_path, GLib.FileTest.EXISTS)) {
121
folder.make_directory (null);
122
}
123
124
let file_stream = this._settings_file.create (Gio.FileCreateFlags.PRIVATE,
125
null);
126
127
file_stream.write_all (JSON.stringify (
128
this._settings, null, 2).toString (), null);
129
130
file_stream.close (null);
131
132
} else {
133
/* The file exists, we load the settings data into memory */
134
let file_stream = this._settings_file.read (null);
135
136
/* See: http://stackoverflow.com/a/21146281
137
*/
138
let file_info = this._settings_file.query_info("standard::size",
139
Gio.FileQueryInfoFlags.NONE, null);
140
let size = file_info.get_size ();
141
142
let buffer = file_stream.read_bytes (size, null).get_data ();
143
144
this._settings = JSON.parse (buffer);
145
146
//DEBUG:
147
print (JSON.stringify (this._settings, null, 2).toString () );
148
149
}
150
},
151
152
/** @method
153
* Sets a value in the setting object.
154
*
155
* @return false on fail
156
* @return true when everything is OK.
157
*/
158
set_setting: function (setting, value) {
159
let ret_val = true;
160
if (typeof setting != "string") {
161
print ("ERROR: The \"setting\" parameter must be a string.");
162
return false;
163
}
164
switch (setting) {
165
case "ui.x":
166
if (typeof value == "number") {
167
this._settings.ui.x = value;
168
} else {
169
print ("The setting \"ui.x\" must be a number.");
170
ret_val = false;
171
}
172
break;
173
case "ui.y":
174
if (typeof value == "number") {
175
this._settings.ui.y = value;
176
} else {
177
print ("The setting \"ui.y\" must be a number.");
178
ret_val = false;
179
}
180
break;
181
case "ui.h":
182
if (typeof value == "number") {
183
this._settings.ui.h = value;
184
} else {
185
print ("The setting \"ui.h\" must be a number.");
186
ret_val = false;
187
}
188
break;
189
case "ui.w":
190
if (typeof value == "number") {
191
this._settings.ui.w = value;
192
} else {
193
print ("The setting \"ui.w\" must be a number.");
194
ret_val = false;
195
}
196
break;
197
case "main.use_dark":
198
if (typeof value == "boolean") {
199
this._settings.main.use_dark = value;
200
} else {
201
print ("The setting \"main.use_dark\" must be a boolean.");
202
ret_val = false;
203
}
204
break;
205
case "main.first_run":
206
if (typeof value == "boolean") {
207
this._settings.main.first_run = value;
208
} else {
209
print ("The setting \"main.first_run\" must be a boolean.");
210
ret_val = false;
211
}
212
break;
213
case "main.quit_on_close":
214
if (typeof value == "number") {
215
this._settings.main.quit_on_close = value;
216
} else {
217
print (
218
"The setting \"main.quit_on_close\" must be a number.");
219
ret_val = false;
220
}
221
break;
222
case "main.privacy.show_full_name":
223
if (typeof value == "boolean") {
224
this._settings.main.privacy.show_full_name = value;
225
} else {
226
print (
227
"The setting \"main.privacy.show_full_name\" must be a boolean.");
228
ret_val = false;
229
}
230
break;
231
case "main.privacy.only_show_avatar":
232
if (typeof value == "boolean") {
233
this._settings.main.privacy.only_show_avatar = value;
234
} else {
235
print (
236
"The setting \"main.privacy.only_show_avatar\" must be a boolean.");
237
ret_val = false;
238
}
239
break;
240
default:
241
242
print ("ERROR: The setting \"" + setting + "\" does not exist.");
243
return false;
244
break;
245
}
246
247
248
/* Because, reasons. */
249
if (ret_val) {
250
this.emit ("change", setting, value);
251
}
252
253
return ret_val;
254
},
255
256
/** @method
257
* Gets a value from the settings object.
258
*
259
* @param setting the @c String that corrosponds to the setting to get.
260
*
261
* @return a <code> complex object </code> with two field: @c ok and @c data.
262
*
263
* If @c ok is false something went wrong and the data field will be undefined.
264
*
265
* If @c ok is true everything is ok and the data field will be set to the
266
* value.
267
*/
268
get_setting: function (setting) {
269
let ret_data = {
270
data: undefined,
271
ok: true
272
};
273
274
if (typeof setting != "string") {
275
print ("ERROR: The \"setting\" parameter must be a string.");
276
ret_data.ok = false;
277
return ret_data;
278
}
279
280
switch (setting) {
281
case "ui.x":
282
ret_data.data = this._settings.ui.x;
283
break;
284
case "ui.y":
285
ret_data.data = this._settings.ui.y;
286
break;
287
case "ui.h":
288
ret_data.data = this._settings.ui.h;
289
break;
290
case "ui.w":
291
ret_data.data = this._settings.ui.w;
292
break;
293
case "main.use_dark":
294
ret_data.data = this._settings.main.use_dark;
295
break;
296
case "main.first_run":
297
ret_data.data = this._settings.main.first_run;
298
break;
299
case "main.privacy.show_full_name":
300
ret_data.data = this._settings.main.privacy.show_full_name;
301
break;
302
case "main.privacy.only_show_avatar":
303
ret_data.data = this._settings.main.privacy.only_show_avatar;
304
break;
305
case "main.quit_on_close":
306
ret_data.data = this._settings.main.quit_on_close;
307
break;
308
default:
309
ret_data.ok = false;
310
print ("ERROR: The setting \"" + setting + "\" does not exist.");
311
break;
312
}
313
314
return ret_data;
315
},
316
317
/** @method
318
* Commits changes to the settings object to file.
319
*/
320
commit_to_file: function () {
321
print (JSON.stringify (this._settings, null, 2).toString () );
322
323
let file_stream = this._settings_file.replace (null,
324
false,
325
Gio.FileCreateFlags.PRIVATE,
326
null);
327
file_stream.write_all (JSON.stringify (
328
this._settings, null, 2).toString (), null);
329
330
file_stream.close (null);
331
}
332
333
// End of class.
334
});
335
336
337
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0