1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2 /* This Source Code Form is subject to the terms of the Mozilla Public
3 * License, v. 2.0. If a copy of the MPL was not distributed with this
4 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
5
6 #include "mozilla/ArrayUtils.h"
7
8 #include "nsGSettingsService.h"
9 #include "nsString.h"
10 #include "nsCOMPtr.h"
11 #include "nsMemory.h"
12 #include "prlink.h"
13 #include "nsComponentManagerUtils.h"
14 #include "nsIMutableArray.h"
15 #include "nsISupportsPrimitives.h"
16
17 #include <glib.h>
18 #include <glib-object.h>
19
20 using namespace mozilla;
21
22 typedef struct _GSettings GSettings;
23 typedef struct _GVariantType GVariantType;
24 typedef struct _GVariant GVariant;
25
26 #ifndef G_VARIANT_TYPE_INT32
27 # define G_VARIANT_TYPE_INT32 ((const GVariantType*)"i")
28 # define G_VARIANT_TYPE_BOOLEAN ((const GVariantType*)"b")
29 # define G_VARIANT_TYPE_STRING ((const GVariantType*)"s")
30 # define G_VARIANT_TYPE_OBJECT_PATH ((const GVariantType*)"o")
31 # define G_VARIANT_TYPE_SIGNATURE ((const GVariantType*)"g")
32 #endif
33 #ifndef G_VARIANT_TYPE_STRING_ARRAY
34 # define G_VARIANT_TYPE_STRING_ARRAY ((const GVariantType*)"as")
35 #endif
36
37 #define GSETTINGS_FUNCTIONS \
38 FUNC(g_settings_new, GSettings*, (const char* schema)) \
39 FUNC(g_settings_list_schemas, const char* const*, (void)) \
40 FUNC(g_settings_list_keys, char**, (GSettings * settings)) \
41 FUNC(g_settings_get_value, GVariant*, \
42 (GSettings * settings, const char* key)) \
43 FUNC(g_settings_set_value, gboolean, \
44 (GSettings * settings, const char* key, GVariant* value)) \
45 FUNC(g_settings_range_check, gboolean, \
46 (GSettings * settings, const char* key, GVariant* value)) \
47 FUNC(g_variant_get_int32, gint32, (GVariant * variant)) \
48 FUNC(g_variant_get_boolean, gboolean, (GVariant * variant)) \
49 FUNC(g_variant_get_string, const char*, (GVariant * value, gsize * length)) \
50 FUNC(g_variant_get_strv, const char**, (GVariant * value, gsize * length)) \
51 FUNC(g_variant_is_of_type, gboolean, \
52 (GVariant * value, const GVariantType* type)) \
53 FUNC(g_variant_new_int32, GVariant*, (gint32 value)) \
54 FUNC(g_variant_new_boolean, GVariant*, (gboolean value)) \
55 FUNC(g_variant_new_string, GVariant*, (const char* string)) \
56 FUNC(g_variant_unref, void, (GVariant * value))
57
58 #define FUNC(name, type, params) \
59 typedef type(*_##name##_fn) params; \
60 static _##name##_fn _##name;
61
62 GSETTINGS_FUNCTIONS
63
64 #undef FUNC
65
66 #define g_settings_new _g_settings_new
67 #define g_settings_list_schemas _g_settings_list_schemas
68 #define g_settings_list_keys _g_settings_list_keys
69 #define g_settings_get_value _g_settings_get_value
70 #define g_settings_set_value _g_settings_set_value
71 #define g_settings_range_check _g_settings_range_check
72 #define g_variant_get_int32 _g_variant_get_int32
73 #define g_variant_get_boolean _g_variant_get_boolean
74 #define g_variant_get_string _g_variant_get_string
75 #define g_variant_get_strv _g_variant_get_strv
76 #define g_variant_is_of_type _g_variant_is_of_type
77 #define g_variant_new_int32 _g_variant_new_int32
78 #define g_variant_new_boolean _g_variant_new_boolean
79 #define g_variant_new_string _g_variant_new_string
80 #define g_variant_unref _g_variant_unref
81
82 static PRLibrary* gioLib = nullptr;
83
84 class nsGSettingsCollection final : public nsIGSettingsCollection {
85 public:
86 NS_DECL_ISUPPORTS
87 NS_DECL_NSIGSETTINGSCOLLECTION
88
nsGSettingsCollection(GSettings * aSettings)89 explicit nsGSettingsCollection(GSettings* aSettings)
90 : mSettings(aSettings), mKeys(nullptr) {}
91
92 private:
93 ~nsGSettingsCollection();
94
95 bool KeyExists(const nsACString& aKey);
96 bool SetValue(const nsACString& aKey, GVariant* aValue);
97
98 GSettings* mSettings;
99 char** mKeys;
100 };
101
~nsGSettingsCollection()102 nsGSettingsCollection::~nsGSettingsCollection() {
103 g_strfreev(mKeys);
104 g_object_unref(mSettings);
105 }
106
KeyExists(const nsACString & aKey)107 bool nsGSettingsCollection::KeyExists(const nsACString& aKey) {
108 if (!mKeys) mKeys = g_settings_list_keys(mSettings);
109
110 for (uint32_t i = 0; mKeys[i] != nullptr; i++) {
111 if (aKey.Equals(mKeys[i])) return true;
112 }
113
114 return false;
115 }
116
SetValue(const nsACString & aKey,GVariant * aValue)117 bool nsGSettingsCollection::SetValue(const nsACString& aKey, GVariant* aValue) {
118 if (!KeyExists(aKey) ||
119 !g_settings_range_check(mSettings, PromiseFlatCString(aKey).get(),
120 aValue)) {
121 g_variant_unref(aValue);
122 return false;
123 }
124
125 return g_settings_set_value(mSettings, PromiseFlatCString(aKey).get(),
126 aValue);
127 }
128
NS_IMPL_ISUPPORTS(nsGSettingsCollection,nsIGSettingsCollection)129 NS_IMPL_ISUPPORTS(nsGSettingsCollection, nsIGSettingsCollection)
130
131 NS_IMETHODIMP
132 nsGSettingsCollection::SetString(const nsACString& aKey,
133 const nsACString& aValue) {
134 GVariant* value = g_variant_new_string(PromiseFlatCString(aValue).get());
135 if (!value) return NS_ERROR_OUT_OF_MEMORY;
136
137 bool res = SetValue(aKey, value);
138
139 return res ? NS_OK : NS_ERROR_FAILURE;
140 }
141
142 NS_IMETHODIMP
SetBoolean(const nsACString & aKey,bool aValue)143 nsGSettingsCollection::SetBoolean(const nsACString& aKey, bool aValue) {
144 GVariant* value = g_variant_new_boolean(aValue);
145 if (!value) return NS_ERROR_OUT_OF_MEMORY;
146
147 bool res = SetValue(aKey, value);
148
149 return res ? NS_OK : NS_ERROR_FAILURE;
150 }
151
152 NS_IMETHODIMP
SetInt(const nsACString & aKey,int32_t aValue)153 nsGSettingsCollection::SetInt(const nsACString& aKey, int32_t aValue) {
154 GVariant* value = g_variant_new_int32(aValue);
155 if (!value) return NS_ERROR_OUT_OF_MEMORY;
156
157 bool res = SetValue(aKey, value);
158
159 return res ? NS_OK : NS_ERROR_FAILURE;
160 }
161
162 NS_IMETHODIMP
GetString(const nsACString & aKey,nsACString & aResult)163 nsGSettingsCollection::GetString(const nsACString& aKey, nsACString& aResult) {
164 if (!KeyExists(aKey)) return NS_ERROR_INVALID_ARG;
165
166 GVariant* value =
167 g_settings_get_value(mSettings, PromiseFlatCString(aKey).get());
168 if (!g_variant_is_of_type(value, G_VARIANT_TYPE_STRING) &&
169 !g_variant_is_of_type(value, G_VARIANT_TYPE_OBJECT_PATH) &&
170 !g_variant_is_of_type(value, G_VARIANT_TYPE_SIGNATURE)) {
171 g_variant_unref(value);
172 return NS_ERROR_FAILURE;
173 }
174
175 aResult.Assign(g_variant_get_string(value, nullptr));
176 g_variant_unref(value);
177
178 return NS_OK;
179 }
180
181 NS_IMETHODIMP
GetBoolean(const nsACString & aKey,bool * aResult)182 nsGSettingsCollection::GetBoolean(const nsACString& aKey, bool* aResult) {
183 NS_ENSURE_ARG_POINTER(aResult);
184
185 if (!KeyExists(aKey)) return NS_ERROR_INVALID_ARG;
186
187 GVariant* value =
188 g_settings_get_value(mSettings, PromiseFlatCString(aKey).get());
189 if (!g_variant_is_of_type(value, G_VARIANT_TYPE_BOOLEAN)) {
190 g_variant_unref(value);
191 return NS_ERROR_FAILURE;
192 }
193
194 gboolean res = g_variant_get_boolean(value);
195 *aResult = res ? true : false;
196 g_variant_unref(value);
197
198 return NS_OK;
199 }
200
201 NS_IMETHODIMP
GetInt(const nsACString & aKey,int32_t * aResult)202 nsGSettingsCollection::GetInt(const nsACString& aKey, int32_t* aResult) {
203 NS_ENSURE_ARG_POINTER(aResult);
204
205 if (!KeyExists(aKey)) return NS_ERROR_INVALID_ARG;
206
207 GVariant* value =
208 g_settings_get_value(mSettings, PromiseFlatCString(aKey).get());
209 if (!g_variant_is_of_type(value, G_VARIANT_TYPE_INT32)) {
210 g_variant_unref(value);
211 return NS_ERROR_FAILURE;
212 }
213
214 *aResult = g_variant_get_int32(value);
215 g_variant_unref(value);
216
217 return NS_OK;
218 }
219
220 // These types are local to nsGSettingsService::Init, but ISO C++98 doesn't
221 // allow a template (ArrayLength) to be instantiated based on a local type.
222 // Boo-urns!
223 typedef void (*nsGSettingsFunc)();
224 struct nsGSettingsDynamicFunction {
225 const char* functionName;
226 nsGSettingsFunc* function;
227 };
228
229 NS_IMETHODIMP
GetStringList(const nsACString & aKey,nsIArray ** aResult)230 nsGSettingsCollection::GetStringList(const nsACString& aKey,
231 nsIArray** aResult) {
232 if (!KeyExists(aKey)) return NS_ERROR_INVALID_ARG;
233
234 nsCOMPtr<nsIMutableArray> items(do_CreateInstance(NS_ARRAY_CONTRACTID));
235 if (!items) {
236 return NS_ERROR_OUT_OF_MEMORY;
237 }
238
239 GVariant* value =
240 g_settings_get_value(mSettings, PromiseFlatCString(aKey).get());
241
242 if (!g_variant_is_of_type(value, G_VARIANT_TYPE_STRING_ARRAY)) {
243 g_variant_unref(value);
244 return NS_ERROR_FAILURE;
245 }
246
247 const gchar** gs_strings = g_variant_get_strv(value, nullptr);
248 if (!gs_strings) {
249 // empty array
250 items.forget(aResult);
251 g_variant_unref(value);
252 return NS_OK;
253 }
254
255 const gchar** p_gs_strings = gs_strings;
256 while (*p_gs_strings != nullptr) {
257 nsCOMPtr<nsISupportsCString> obj(
258 do_CreateInstance(NS_SUPPORTS_CSTRING_CONTRACTID));
259 if (obj) {
260 obj->SetData(nsDependentCString(*p_gs_strings));
261 items->AppendElement(obj);
262 }
263 p_gs_strings++;
264 }
265 g_free(gs_strings);
266 items.forget(aResult);
267 g_variant_unref(value);
268 return NS_OK;
269 }
270
Init()271 nsresult nsGSettingsService::Init() {
272 #define FUNC(name, type, params) {#name, (nsGSettingsFunc*)&_##name},
273 static const nsGSettingsDynamicFunction kGSettingsSymbols[] = {
274 GSETTINGS_FUNCTIONS};
275 #undef FUNC
276
277 if (!gioLib) {
278 gioLib = PR_LoadLibrary("libgio-2.0.so.0");
279 if (!gioLib) return NS_ERROR_FAILURE;
280 }
281
282 for (auto GSettingsSymbol : kGSettingsSymbols) {
283 *GSettingsSymbol.function =
284 PR_FindFunctionSymbol(gioLib, GSettingsSymbol.functionName);
285 if (!*GSettingsSymbol.function) {
286 return NS_ERROR_FAILURE;
287 }
288 }
289
290 return NS_OK;
291 }
292
NS_IMPL_ISUPPORTS(nsGSettingsService,nsIGSettingsService)293 NS_IMPL_ISUPPORTS(nsGSettingsService, nsIGSettingsService)
294
295 nsGSettingsService::~nsGSettingsService() {
296 if (gioLib) {
297 PR_UnloadLibrary(gioLib);
298 gioLib = nullptr;
299 }
300 }
301
302 NS_IMETHODIMP
GetCollectionForSchema(const nsACString & schema,nsIGSettingsCollection ** collection)303 nsGSettingsService::GetCollectionForSchema(
304 const nsACString& schema, nsIGSettingsCollection** collection) {
305 NS_ENSURE_ARG_POINTER(collection);
306
307 const char* const* schemas = g_settings_list_schemas();
308
309 for (uint32_t i = 0; schemas[i] != nullptr; i++) {
310 if (schema.Equals(schemas[i])) {
311 GSettings* settings = g_settings_new(PromiseFlatCString(schema).get());
312 nsGSettingsCollection* mozGSettings = new nsGSettingsCollection(settings);
313 NS_ADDREF(*collection = mozGSettings);
314 return NS_OK;
315 }
316 }
317
318 return NS_ERROR_FAILURE;
319 }
320