Branch data Line data Source code
1 : : // SPDX-License-Identifier: GPL-3.0-or-later
2 : : // SPDX-FileCopyrightText: Andy Holmes <andrew.g.r.holmes@gmail.com>
3 : :
4 : : #define G_LOG_DOMAIN "valent-battery"
5 : :
6 : : #include "config.h"
7 : :
8 : : #include <math.h>
9 : : #include <stdint.h>
10 : :
11 : : #include <gio/gio.h>
12 : :
13 : : #include "valent-battery.h"
14 : :
15 : :
16 : : struct _ValentBattery
17 : : {
18 : : GObject parent_instance;
19 : :
20 : : GDBusProxy *proxy;
21 : : GCancellable *cancellable;
22 : :
23 : : unsigned int current_charge;
24 : : unsigned int is_charging : 1;
25 : : unsigned int is_present : 1;
26 : : unsigned int threshold_event;
27 : : };
28 : :
29 [ + + + - ]: 144 : G_DEFINE_FINAL_TYPE (ValentBattery, valent_battery, G_TYPE_OBJECT)
30 : :
31 : : enum {
32 : : CHANGED,
33 : : N_SIGNALS
34 : : };
35 : :
36 : : static guint signals[N_SIGNALS] = { 0, };
37 : :
38 : : static ValentBattery *default_battery = NULL;
39 : :
40 : :
41 : : /*
42 : : * These are a convenient representation of the values returned by UPower D-Bus
43 : : * service, that would otherwise be opaque integers.
44 : : *
45 : : * See: https://upower.freedesktop.org/docs/Device.html
46 : : */
47 : : enum {
48 : : UPOWER_KIND_UNKNOWN,
49 : : UPOWER_KIND_LINE_POWER,
50 : : UPOWER_KIND_BATTERY,
51 : : UPOWER_KIND_UPS,
52 : : UPOWER_KIND_MONITOR,
53 : : UPOWER_KIND_MOUSE,
54 : : UPOWER_KIND_KEYBOARD,
55 : : UPOWER_KIND_PDA,
56 : : UPOWER_KIND_PHONE,
57 : : };
58 : :
59 : : enum {
60 : : UPOWER_LEVEL_UNKNOWN,
61 : : UPOWER_LEVEL_NONE,
62 : : UPOWER_LEVEL_DISCHARGING,
63 : : UPOWER_LEVEL_LOW,
64 : : UPOWER_LEVEL_CRITICAL,
65 : : UPOWER_LEVEL_ACTION,
66 : : UPOWER_LEVEL_NORMAL,
67 : : UPOWER_LEVEL_HIGH,
68 : : UPOWER_LEVEL_FULL
69 : : };
70 : :
71 : : enum {
72 : : UPOWER_STATE_UNKNOWN,
73 : : UPOWER_STATE_CHARGING,
74 : : UPOWER_STATE_DISCHARGING,
75 : : UPOWER_STATE_EMPTY,
76 : : UPOWER_STATE_FULLY_CHARGED,
77 : : UPOWER_STATE_PENDING_CHARGE,
78 : : UPOWER_STATE_PENDING_DISCHARGE
79 : : };
80 : :
81 : :
82 : : /*
83 : : * These are convenience functions for translating UPower states and levels into
84 : : * values expected by KDE Connect.
85 : : */
86 : : static inline gboolean
87 : 19 : translate_state (uint32_t state)
88 : : {
89 : 19 : switch (state)
90 : : {
91 : : case UPOWER_STATE_CHARGING:
92 : : case UPOWER_STATE_FULLY_CHARGED:
93 : : case UPOWER_STATE_PENDING_CHARGE:
94 : : return TRUE;
95 : :
96 : : case UPOWER_STATE_DISCHARGING:
97 : : case UPOWER_STATE_EMPTY:
98 : : case UPOWER_STATE_PENDING_DISCHARGE:
99 : : return FALSE;
100 : :
101 : : default:
102 : : return FALSE;
103 : : }
104 : : }
105 : :
106 : : static inline unsigned int
107 : 18 : translate_warning_level (uint32_t warning_level)
108 : : {
109 : 18 : switch (warning_level)
110 : : {
111 : : case UPOWER_LEVEL_NONE:
112 : : return 0;
113 : :
114 : 4 : case UPOWER_LEVEL_LOW:
115 : : case UPOWER_LEVEL_CRITICAL:
116 : : case UPOWER_LEVEL_ACTION:
117 : 4 : return 1;
118 : :
119 : : default:
120 : : return 0;
121 : : }
122 : : }
123 : :
124 : : /*
125 : : * GDBusProxy
126 : : */
127 : : static void
128 : 3 : valent_battery_load_properties (ValentBattery *self)
129 : : {
130 : 6 : g_autoptr (GVariant) value = NULL;
131 : :
132 [ + - ]: 3 : if ((value = g_dbus_proxy_get_cached_property (self->proxy, "IsPresent")) != NULL)
133 : : {
134 : 3 : gboolean is_present = g_variant_get_boolean (value);
135 : :
136 : 3 : self->is_present = is_present;
137 : 3 : g_clear_pointer (&value, g_variant_unref);
138 : : }
139 : :
140 [ - + ]: 3 : g_assert (VALENT_IS_BATTERY (self));
141 : :
142 [ + - ]: 3 : if ((value = g_dbus_proxy_get_cached_property (self->proxy, "Percentage")) != NULL)
143 : : {
144 : 3 : double percentage = g_variant_get_double (value);
145 : :
146 : 3 : self->current_charge = (unsigned int)floor (percentage);
147 : 3 : g_clear_pointer (&value, g_variant_unref);
148 : : }
149 : :
150 [ + - ]: 3 : if ((value = g_dbus_proxy_get_cached_property (self->proxy, "State")) != NULL)
151 : : {
152 : 3 : uint32_t state = g_variant_get_uint32 (value);
153 : :
154 [ + - ]: 3 : self->is_charging = translate_state (state);
155 : 3 : g_clear_pointer (&value, g_variant_unref);
156 : : }
157 : :
158 [ + - ]: 3 : if ((value = g_dbus_proxy_get_cached_property (self->proxy, "WarningLevel")) != NULL)
159 : : {
160 : 3 : uint32_t warning_level = g_variant_get_uint32 (value);
161 : :
162 [ - + ]: 3 : self->threshold_event = translate_warning_level (warning_level);
163 : 3 : g_clear_pointer (&value, g_variant_unref);
164 : : }
165 : 3 : }
166 : :
167 : : static void
168 : 62 : on_properties_changed (GDBusProxy *proxy,
169 : : GVariant *changed_properties,
170 : : GStrv invalidated_properties,
171 : : ValentBattery *self)
172 : : {
173 : 62 : gboolean changed = FALSE;
174 : 62 : gboolean is_present;
175 : 62 : double percentage;
176 : 62 : uint32_t state;
177 : 62 : uint32_t warning_level;
178 : :
179 [ - + ]: 62 : g_assert (VALENT_IS_BATTERY (self));
180 : :
181 : : /* If the battery was inserted or removed, the properties need to be either
182 : : * entirely reloaded or reset, respectively. */
183 [ + + ]: 62 : if (g_variant_lookup (changed_properties, "IsPresent", "b", &is_present))
184 : : {
185 : : /* An existing battery was physically inserted */
186 [ + + + - ]: 15 : if (!self->is_present && is_present)
187 : : {
188 : 1 : valent_battery_load_properties (self);
189 : 1 : changed = TRUE;
190 : : }
191 : :
192 : : /* An existing battery was physically removed */
193 [ + - + + ]: 14 : else if (self->is_present && !is_present)
194 : : {
195 : 1 : self->current_charge = 0;
196 : 1 : self->is_charging = FALSE;
197 : 1 : self->is_present = FALSE;
198 : 1 : self->threshold_event = 0;
199 : 1 : changed = TRUE;
200 : : }
201 : :
202 : 2 : if (changed)
203 : : {
204 : 2 : g_signal_emit (G_OBJECT (self), signals [CHANGED], 0);
205 : 2 : return;
206 : : }
207 : : }
208 : :
209 [ + + ]: 60 : if (g_variant_lookup (changed_properties, "Percentage", "d", &percentage))
210 : : {
211 : 16 : unsigned int current_charge = (unsigned int)floor (percentage);
212 : :
213 [ + + ]: 16 : if (self->current_charge != current_charge)
214 : : {
215 : 3 : self->current_charge = current_charge;
216 : 3 : changed = TRUE;
217 : : }
218 : : }
219 : :
220 [ + + ]: 60 : if (g_variant_lookup (changed_properties, "State", "u", &state))
221 : : {
222 [ + + ]: 16 : gboolean is_charging = translate_state (state);
223 : :
224 [ + + ]: 16 : if (self->is_charging != is_charging)
225 : : {
226 : 7 : self->is_charging = is_charging;
227 : 7 : changed = TRUE;
228 : : }
229 : : }
230 : :
231 [ + + ]: 60 : if (g_variant_lookup (changed_properties, "WarningLevel", "u", &warning_level))
232 : : {
233 [ + + ]: 15 : unsigned int threshold_event = translate_warning_level (warning_level);
234 : :
235 [ + + ]: 15 : if (self->threshold_event != threshold_event)
236 : : {
237 : 6 : self->threshold_event = threshold_event;
238 : 6 : changed = TRUE;
239 : : }
240 : : }
241 : :
242 [ + + ]: 60 : if (changed)
243 : 16 : g_signal_emit (G_OBJECT (self), signals [CHANGED], 0);
244 : : }
245 : :
246 : : static void
247 : 2 : g_dbus_proxy_new_for_bus_cb (GObject *object,
248 : : GAsyncResult *result,
249 : : ValentBattery *self)
250 : : {
251 : 2 : g_autoptr (GError) error = NULL;
252 [ - + - - ]: 2 : g_autoptr (GVariant) type = NULL;
253 [ - - ]: 2 : g_autoptr (GVariant) value = NULL;
254 : :
255 [ - + ]: 2 : if ((self->proxy = g_dbus_proxy_new_for_bus_finish (result, &error)) == NULL)
256 : : {
257 : 0 : g_warning ("%s: %s", G_OBJECT_TYPE_NAME (self), error->message);
258 : 0 : return;
259 : : }
260 : :
261 [ + - - + ]: 4 : if ((type = g_dbus_proxy_get_cached_property (self->proxy, "Type")) == NULL ||
262 : 2 : g_variant_get_uint32 (type) != UPOWER_KIND_BATTERY)
263 : : {
264 : 0 : g_debug ("%s: not a battery", G_OBJECT_TYPE_NAME (self));
265 [ # # ]: 0 : return;
266 : : }
267 : :
268 [ + - ]: 2 : if ((value = g_dbus_proxy_get_cached_property (self->proxy, "IsPresent")) != NULL)
269 : : {
270 : 2 : gboolean is_present = g_variant_get_boolean (value);
271 : :
272 [ + - ]: 2 : if (is_present)
273 : 2 : valent_battery_load_properties (self);
274 : : }
275 : :
276 : 2 : g_signal_connect_object (self->proxy,
277 : : "g-properties-changed",
278 : : G_CALLBACK (on_properties_changed),
279 : : self,
280 : : G_CONNECT_DEFAULT);
281 [ + - ]: 2 : g_signal_emit (G_OBJECT (self), signals [CHANGED], 0);
282 : : }
283 : :
284 : : /*
285 : : * GObject
286 : : */
287 : : static void
288 : 1 : valent_battery_dispose (GObject *object)
289 : : {
290 : 1 : ValentBattery *self = VALENT_BATTERY (object);
291 : :
292 : 1 : g_cancellable_cancel (self->cancellable);
293 : :
294 : 1 : G_OBJECT_CLASS (valent_battery_parent_class)->dispose (object);
295 : 1 : }
296 : :
297 : : static void
298 : 1 : valent_battery_finalize (GObject *object)
299 : : {
300 : 1 : ValentBattery *self = VALENT_BATTERY (object);
301 : :
302 [ + - ]: 1 : g_clear_object (&self->cancellable);
303 [ + - ]: 1 : g_clear_object (&self->proxy);
304 : :
305 : 1 : G_OBJECT_CLASS (valent_battery_parent_class)->finalize (object);
306 : 1 : }
307 : :
308 : : static void
309 : 2 : valent_battery_class_init (ValentBatteryClass *klass)
310 : : {
311 : 2 : GObjectClass *object_class = G_OBJECT_CLASS (klass);
312 : :
313 : 2 : object_class->dispose = valent_battery_dispose;
314 : 2 : object_class->finalize = valent_battery_finalize;
315 : :
316 : : /**
317 : : * ValentBattery::changed:
318 : : * @self: a `ValentBattery`
319 : : *
320 : : * `ValentBattery`::changed is emitted whenever a relevant property changes.
321 : : */
322 : 4 : signals [CHANGED] =
323 : 2 : g_signal_new ("changed",
324 : : G_TYPE_FROM_CLASS (klass),
325 : : G_SIGNAL_RUN_LAST,
326 : : 0,
327 : : NULL, NULL, NULL,
328 : : G_TYPE_NONE, 0);
329 : 2 : }
330 : :
331 : : static void
332 : 2 : valent_battery_init (ValentBattery *self)
333 : : {
334 : 2 : self->cancellable = g_cancellable_new ();
335 : 2 : self->current_charge = 0;
336 : 2 : self->is_charging = FALSE;
337 : 2 : self->is_present = FALSE;
338 : 2 : self->threshold_event = 0;
339 : :
340 : 2 : g_dbus_proxy_new_for_bus (G_BUS_TYPE_SYSTEM,
341 : : G_DBUS_PROXY_FLAGS_NONE,
342 : : NULL,
343 : : "org.freedesktop.UPower",
344 : : "/org/freedesktop/UPower/devices/DisplayDevice",
345 : : "org.freedesktop.UPower.Device",
346 : : self->cancellable,
347 : : (GAsyncReadyCallback)g_dbus_proxy_new_for_bus_cb,
348 : : self);
349 : 2 : }
350 : :
351 : : /**
352 : : * valent_battery_get_default:
353 : : *
354 : : * Get the default `ValentBattery`.
355 : : *
356 : : * Returns: (transfer none): The default `ValentBattery`
357 : : */
358 : : ValentBattery *
359 : 5 : valent_battery_get_default (void)
360 : : {
361 [ + + ]: 5 : if (default_battery == NULL)
362 : : {
363 : 2 : default_battery = g_object_new (VALENT_TYPE_BATTERY, NULL);
364 : :
365 : 2 : g_object_add_weak_pointer (G_OBJECT (default_battery),
366 : : (gpointer) &default_battery);
367 : : }
368 : :
369 : 5 : return default_battery;
370 : : }
371 : :
372 : : /**
373 : : * valent_battery_current_charge:
374 : : * @battery: a `ValentBattery`
375 : : *
376 : : * Get the charge level of @battery.
377 : : *
378 : : * The value returned by this method is a simplification of a UPower device
379 : : * battery percentage, useful for KDE Connect clients.
380 : : *
381 : : * Returns: a charge percentage, or `0` if unavailable
382 : : */
383 : : int
384 : 20 : valent_battery_current_charge (ValentBattery *battery)
385 : : {
386 [ - + ]: 20 : g_return_val_if_fail (VALENT_IS_BATTERY (battery), 0);
387 : :
388 [ + + ]: 20 : if (!battery->is_present)
389 : : return 0;
390 : :
391 : 18 : return battery->current_charge;
392 : : }
393 : :
394 : : /**
395 : : * valent_battery_is_charging:
396 : : * @battery: a `ValentBattery`
397 : : *
398 : : * Get whether the battery is charging.
399 : : *
400 : : * The value returned by this method is a simplification of a UPower device
401 : : * state to a value useful for KDE Connect clients.
402 : : *
403 : : * Returns: %TRUE if the battery is charging
404 : : */
405 : : gboolean
406 : 17 : valent_battery_is_charging (ValentBattery *battery)
407 : : {
408 [ - + ]: 17 : g_return_val_if_fail (VALENT_IS_BATTERY (battery), FALSE);
409 : :
410 : 17 : return battery->is_charging;
411 : : }
412 : :
413 : : /**
414 : : * valent_battery_is_present:
415 : : * @battery: a `ValentBattery`
416 : : *
417 : : * Get whether the battery is present.
418 : : *
419 : : * Returns: %TRUE if the battery is present, %FALSE otherwise
420 : : */
421 : : gboolean
422 : 12 : valent_battery_is_present (ValentBattery *battery)
423 : : {
424 [ - + ]: 12 : g_return_val_if_fail (VALENT_IS_BATTERY (battery), FALSE);
425 : :
426 : 12 : return battery->is_present;
427 : : }
428 : :
429 : : /**
430 : : * valent_battery_is_charging:
431 : : * @battery: a `ValentBattery`
432 : : *
433 : : * Get whether the battery is charging.
434 : : *
435 : : * The value returned by this method is a simplification of a UPower device
436 : : * level to a value useful for KDE Connect clients.
437 : : *
438 : : * Returns: `1` if the level is below the threshold, `0` otherwise
439 : : */
440 : : unsigned int
441 : 16 : valent_battery_threshold_event (ValentBattery *battery)
442 : : {
443 [ - + ]: 16 : g_return_val_if_fail (VALENT_IS_BATTERY (battery), FALSE);
444 : :
445 : 16 : return battery->threshold_event;
446 : : }
447 : :
|
