upower support added to battstat. Preparing for 1.2.2 release.mate-applets-1.2.2

6 files changed, 447 insertions, 31 deletions

diff --git a/battstat/Makefile.am b/battstat/Makefile.am
index 093db421..10f40af0 100644
--- a/battstat/Makefile.am
+++ b/battstat/Makefile.am
@@ -27,6 +27,7 @@ INCLUDES =					\
 	$(MATE_APPLETS3_CFLAGS)		\
 	$(LIBMATENOTIFY_CFLAGS)			\
 	$(HAL_CFLAGS)				\
+	$(UPOWER_CFLAGS)	\
 	$(APMINC)				\
 	$(ACPIINC)				\
 	-DG_LOG_DOMAIN=\"battstat_applet\"	\
@@ -47,15 +48,18 @@ battstat_applet_2_SOURCES = \
 	acpi-freebsd.c \
 	acpi-freebsd.h \
 	battstat-hal.c \
-	battstat-hal.h
+	battstat-hal.h \
+	battstat-upower.c \
+	battstat-upower.h
 
 
 battstat_applet_2_LDADD = \
 		     $(MATE_APPLETS3_LIBS) \
 		     $(LIBMATENOTIFY_LIBS) \
 		     $(HAL_LIBS) \
-	$(APMLIB) \
-	-lm
+			 $(APMLIB) \
+			 $(UPOWER_LIBS) \
+			 -lm
 
 schemasdir   = @MATECONF_SCHEMA_FILE_DIR@
 schemas_in_files = battstat.schemas.in
diff --git a/battstat/battstat-upower.c b/battstat/battstat-upower.c
new file mode 100644
index 00000000..4cf51fa0
--- /dev/null
+++ b/battstat/battstat-upower.c
@@ -0,0 +1,330 @@
+/*
+ *  Copyright (C) 2010 by Joachim Breitner <[email protected]>
+ *
+ * Based on battstat-hal.c:
+ * Copyright (C) 2005 by Ryan Lortie <[email protected]>
+ *
+ *  This program is free software; you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation; either version 2 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Street #330, Boston, MA 02111-1307, USA.
+ *
+ * $Id$
+ */
+
+#include <config.h>
+
+#ifdef HAVE_UPOWER
+
+#include <upower.h>
+#include <math.h>
+
+#include "battstat-upower.h"
+
+static UpClient *upc;
+static void (*status_updated_callback) (void);
+
+
+/* status_updated_callback() can not be called directly because at the time of
+ * the device-remove signal, the device is not actually removed from the list
+ * of devices known to the up_client object (see libupower-glib/up-client.c in
+ * upower). Waiting for the next idle timer works around this issue and has has
+ * the additionaly benefit of possibly running status_updated_callback only
+ * once when several events happen very soon after each other.
+ */
+static gboolean status_update_scheduled;
+
+static gboolean
+update_status_idle (gpointer junk)
+{
+  if (status_updated_callback)
+    status_updated_callback ();
+
+  return status_update_scheduled = FALSE;
+}
+
+static void
+schedule_status_callback (void)
+{
+  if (status_update_scheduled)
+    return;
+
+  status_update_scheduled = TRUE;
+  g_idle_add (update_status_idle, NULL);
+}
+
+static void
+device_cb (UpClient *client, UpDevice *device, gpointer user_data) {
+  schedule_status_callback();
+}
+
+/* ---- public functions ---- */
+
+char *
+battstat_upower_initialise (void (*callback) (void))
+{
+  char *error_str;
+  int i, num;
+
+  status_updated_callback = callback;
+
+  if( upc != NULL )
+    return g_strdup( "Already initialised!" );
+
+  if( (upc = up_client_new() ) == NULL )
+    goto error_out;
+
+  GCancellable *cancellable = g_cancellable_new();
+  GError *gerror;
+
+  if (! up_client_enumerate_devices_sync( upc, cancellable, &gerror ) ) {
+    sprintf(error_str, "Unable to enumerate upower devices: %s\n", gerror->message);
+    goto error_shutdownclient;
+  }
+
+  g_signal_connect_after( upc, "device-changed", device_cb, NULL );
+  g_signal_connect_after( upc, "device-added", device_cb, NULL );
+  g_signal_connect_after( upc, "device-removed", device_cb, NULL );
+
+  return NULL;
+
+error_shutdownclient:
+  g_object_unref( upc );
+  upc = NULL;
+
+error_out:
+  return "Can not initialize upower";
+}
+
+void
+battstat_upower_cleanup( void )
+{
+  if( upc == NULL )
+    return;
+  
+  g_object_unref( upc );
+  upc = NULL;
+}
+
+#include "battstat.h"
+
+/* This function currently exists to allow the multiple batteries supported
+ * by the upower backend to appear as a single composite battery device (since
+ * at the current time this is all that battstat supports).
+ *
+ * This entire function is filled with logic to make multiple batteries
+ * appear as one "composite" battery.  Comments included as appropriate.
+ *
+ * For more information about some of the assumptions made in the following
+ * code please see the following mailing list post and the resulting thread:
+ *
+ *   http://lists.freedesktop.org/archives/hal/2005-July/002841.html
+ */
+void
+battstat_upower_get_battery_info( BatteryStatus *status )
+{
+
+  GPtrArray *devices = up_client_get_devices( upc );
+
+  /* The calculation to get overall percentage power remaining is as follows:
+   *
+   *    Sum( Current charges ) / Sum( Full Capacities )
+   *
+   * We can't just take an average of all of the percentages since this
+   * doesn't deal with the case that one battery might have a larger
+   * capacity than the other.
+   *
+   * In order to do this calculation, we need to keep a running total of
+   * current charge and full capacities.
+   */
+  double current_charge_total = 0, full_capacity_total = 0;
+
+  /* Record the time remaining as reported by upower.  This is used in the event
+   * that the system has exactly one battery (since, then, upower is capable
+   * of providing an accurate time remaining report and we should trust it.)
+   */
+  gint64 remaining_time = 0;
+
+  /* The total (dis)charge rate of the system is the sum of the rates of
+   * the individual batteries.
+   */
+  double rate_total = 0;
+
+  /* We need to know if we should report the composite battery as present
+   * at all.  The logic is that if at least one actual battery is installed
+   * then the composite battery will be reported to exist.
+   */
+  int present = 0;
+
+  /* We need to know if we are on AC power or not.  Eventually, we can look
+   * at the AC adaptor upower devices to determine that.  For now, we assume that
+   * if any battery is discharging then we must not be on AC power.  Else, by
+   * default, we must be on AC.
+   */
+  int on_ac_power = 1;
+
+  /* Finally, we consider the composite battery to be "charging" if at least
+   * one of the actual batteries in the system is charging.
+   */
+  int charging = 0;
+
+  /* A list iterator. */
+  GSList *item;
+
+  /* For each physical battery bay... */
+  int i;
+  for( i = 0; i < devices->len; i++ )
+  {
+    UpDevice *upd = g_ptr_array_index( devices, i );
+
+    int type, state;
+    double current_charge, full_capacity, rate;
+    gint64 time_to_full, time_to_empty;
+    
+    g_object_get( upd,
+      "kind", &type,
+      "state", &state,
+      "energy", &current_charge,
+      "energy-full", &full_capacity,
+      "energy-rate", &rate,
+      "time-to-full", &time_to_full,
+      "time-to-empty", &time_to_empty,
+      NULL );
+
+    /* Only count batteries here */
+
+    if (type != UP_DEVICE_KIND_BATTERY)
+      continue;
+
+    /* At least one battery present -> composite battery is present. */
+    present++;
+
+    /* At least one battery charging -> composite battery is charging. */
+    if( state == UP_DEVICE_STATE_CHARGING )
+      charging = 1;
+
+    /* At least one battery is discharging -> we're not on AC. */
+    if( state == UP_DEVICE_STATE_DISCHARGING )
+      on_ac_power = 0;
+
+    /* Sum the totals for current charge, design capacity, (dis)charge rate. */
+    current_charge_total += current_charge;
+    full_capacity_total += full_capacity;
+    rate_total += rate;
+
+    /* Record remaining time too, incase this is the only battery. */
+    remaining_time = (state == UP_DEVICE_STATE_DISCHARGING ? time_to_empty : time_to_full);
+  }
+
+  if( !present || full_capacity_total <= 0 || (charging && !on_ac_power) )
+  {
+    /* Either no battery is present or something has gone horribly wrong.
+     * In either case we must return that the composite battery is not
+     * present.
+     */
+    status->present = FALSE;
+    status->percent = 0;
+    status->minutes = -1;
+    status->on_ac_power = TRUE;
+    status->charging = FALSE;
+
+    g_ptr_array_unref( devices );
+    return;
+  }
+
+  /* Else, our composite battery is present. */
+  status->present = TRUE;
+
+  /* As per above, overall charge is:
+   *
+   *    Sum( Current charges ) / Sum( Full Capacities )
+   */
+  status->percent = ( current_charge_total / full_capacity_total ) * 100.0 + 0.5;
+
+  if( present == 1 )
+  {
+    /* In the case of exactly one battery, report the time remaining figure
+     * from upower directly since it might have come from an authorative source
+     * (ie: the PMU or APM subsystem).
+     *
+     * upower gives remaining time in seconds with a 0 to mean that the
+     * remaining time is unknown.  Battstat uses minutes and -1 for 
+     * unknown time remaining.
+     */
+
+    if( remaining_time == 0 )
+      status->minutes = -1;
+    else
+      status->minutes = (remaining_time + 30) / 60;
+  }
+  /* Rest of cases to deal with multiple battery systems... */
+  else if( !on_ac_power && rate_total != 0 )
+  {
+    /* Then we're discharging.  Calculate time remaining until at zero. */
+
+    double remaining;
+
+    remaining = current_charge_total;
+    remaining /= rate_total;
+    status->minutes = (int) floor( remaining * 60.0 + 0.5 );
+  }
+  else if( charging && rate_total != 0 )
+  {
+    /* Calculate time remaining until charged.  For systems with more than
+     * one battery, this code is very approximate.  The assumption is that if
+     * one battery reaches full charge before the other that the other will
+     * start charging faster due to the increase in available power (similar
+     * to how a laptop will charge faster if you're not using it).
+     */
+
+    double remaining;
+
+    remaining = full_capacity_total - current_charge_total;
+    if( remaining < 0 )
+      remaining = 0;
+    remaining /= rate_total;
+
+    status->minutes = (int) floor( remaining * 60.0 + 0.5 );
+  }
+  else
+  {
+    /* On AC power and not charging -or- rate is unknown. */
+    status->minutes = -1;
+  }
+
+  /* These are simple and well-explained above. */
+  status->charging = charging;
+  status->on_ac_power = on_ac_power;
+  
+  g_ptr_array_unref( devices );
+}
+
+void
+error_dialog( const char *fmt , ...)
+{
+  va_list ap;
+  va_start(ap, fmt);
+  char str[1000];
+  vsprintf(str, fmt, ap);
+  GtkWidget *dialog;
+
+  dialog = gtk_message_dialog_new( NULL, 0, GTK_MESSAGE_ERROR,
+                                   GTK_BUTTONS_OK, "%s", str);
+
+  g_signal_connect_swapped( GTK_OBJECT (dialog), "response",
+                            G_CALLBACK (gtk_widget_destroy),
+                            GTK_OBJECT (dialog) );
+
+  gtk_widget_show_all( dialog );
+}
+
+#endif /* HAVE_UPOWER */
diff --git a/battstat/battstat-upower.h b/battstat/battstat-upower.h
new file mode 100644
index 00000000..ad7e0351
--- /dev/null
+++ b/battstat/battstat-upower.h
@@ -0,0 +1,33 @@
+/*
+ * Copyright (C) 2010 by Joachim Breitner <[email protected]>
+ *
+ * Based on battstat-hal.h:
+ * Copyright (C) 2005 by Ryan Lortie <[email protected]>
+ *
+ *  This program is free software; you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation; either version 2 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Street #330, Boston, MA 02111-1307, USA.
+ *
+ * $Id$
+ */
+
+#ifndef _battstat_upower_h_
+#define _battstat_upower_h_
+
+char *battstat_upower_initialise (void (*) (void));
+void battstat_upower_cleanup (void);
+
+#include "battstat.h"
+void battstat_upower_get_battery_info (BatteryStatus *status);
+
+#endif /* _battstat_upower_h_ */
diff --git a/battstat/battstat_applet.c b/battstat/battstat_applet.c
index f610b66c..2ba713e6 100644
--- a/battstat/battstat_applet.c
+++ b/battstat/battstat_applet.c
@@ -1230,7 +1230,7 @@ about_cb( GtkAction *action, ProgressData *battstat )
   const gchar *authors[] = {
     "J\xC3\xB6rgen Pehrson <[email protected]>",
     "Lennart Poettering <[email protected]> (Linux ACPI support)",
-    "Seth Nickell <[email protected]> (MATE2 port)",
+    "Seth Nickell <[email protected]> (GNOME2 port)",
     "Davyd Madeley <[email protected]>",
     "Ryan Lortie <[email protected]>",
     "Joe Marcus Clarke <[email protected]> (FreeBSD ACPI support)",
@@ -1246,9 +1246,11 @@ about_cb( GtkAction *action, ProgressData *battstat )
 
   char *comments = g_strdup_printf ("%s\n\n%s",
 		  _("This utility shows the status of your laptop battery."),
-		  power_management_using_hal () ?
+		  power_management_using_upower () ?
+		    /* ture */ _("upower backend enabled.") :
+		  (power_management_using_hal () ?
 		  	/* true */ _("HAL backend enabled.") :
-			/* false */ _("Legacy (non-HAL) backend enabled."));
+			/* false */ _("Legacy (non-HAL) backend enabled.")));
 
   gtk_show_about_dialog( NULL,
     "version",             VERSION,
diff --git a/battstat/docs/C/mate-battstat.xml b/battstat/docs/C/mate-battstat.xml
index 04c5d03f..2ba2273a 100644
--- a/battstat/docs/C/mate-battstat.xml
+++ b/battstat/docs/C/mate-battstat.xml
@@ -226,11 +226,14 @@
      <title>Power Management Backends</title>
 
      <para>
-      The battery monitor supports a number of power management backends. If it
-      is available, the monitor will attempt to use the freedesktop.org
-      <ulink url="http://freedesktop.org/Software/hal">HAL (Hardware Abstraction
-      Layer)</ulink>. If it is unavailable or unsupported on your platform, the
-      battery monitor will attempt direct access to the power management system.
+       The battery monitor supports a number of power management backends.
+       If it is available, the monitor will attempt to use the freedesktop.org
+       <ulink url="http://upower.freedesktop.org/">upower</ulink> interface.
+       If it is unavailable or unsupported on your platform, it will fall back
+       to the freedesktop.org
+       <ulink url="http://freedesktop.org/Software/hal">HAL (Hardware
+       Abstraction Layer)</ulink>. If that is also not availble, the
+       battery monitor will attempt direct access to the power management system
      </para>
      <para>
       Not all power management backends are available from all vendors, and some
@@ -410,10 +413,10 @@
     <sect2 id="battstat-troubleshooting-backends">
      <title>Determining the backend</title>
      <para>
-       If you are using the Hardware Abstraction Layer
-       (see <xref linkend="battstat-power-backends"/>) then that will be
-       indicated in the about dialog by placing a star next to the author of the
-       HAL backend.
+       If you are using the upower interface, or the the Hardware
+       Abstraction Layer (see <xref linkend="battstat-power-backends"/>) then
+       that will be indicated in the about dialog by placing a star next to the
+       author of the HAL backend.
     <figure id="battstat-credits-hal"> 
       <title>Check you're using the HAL backend</title> 
       <screenshot> 
diff --git a/battstat/power-management.c b/battstat/power-management.c
index 53ae081a..94d1adf6 100644
--- a/battstat/power-management.c
+++ b/battstat/power-management.c
@@ -41,6 +41,7 @@
 
 #include "battstat.h"
 #include "battstat-hal.h"
+#include "battstat-upower.h"
 
 #define ERR_ACPID _("Can't access ACPI events in /var/run/acpid.socket! "    \
                     "Make sure the ACPI subsystem is working and "           \
@@ -66,6 +67,9 @@ static int pm_initialised;
 #ifdef HAVE_HAL
 static int using_hal;
 #endif
+#ifdef HAVE_UPOWER
+static int using_upower;
+#endif
 
 /*
  * What follows is a series of platform-specific apm_readinfo functions
@@ -390,13 +394,21 @@ power_management_getinfo( BatteryStatus *status )
     return NULL;
   }
 
-#ifdef HAVE_HAL
-  if( using_hal )
-  {
-    battstat_hal_get_battery_info( status );
-    return NULL;
-  }
-#endif
+  #ifdef HAVE_UPOWER
+    if( using_upower)
+    {
+      battstat_upower_get_battery_info( status );
+      return NULL;
+    }
+  #endif
+  
+  #ifdef HAVE_HAL
+    if( using_hal )
+    {
+      battstat_hal_get_battery_info( status );
+      return NULL;
+    }
+  #endif
 
   retval = apm_readinfo( status );
 
@@ -430,22 +442,19 @@ power_management_getinfo( BatteryStatus *status )
 const char *
 power_management_initialise (int no_hal, void (*callback) (void))
 {
+  char *err;
+  err = g_strdup( ":(" );
 #ifdef __linux__
   struct stat statbuf;
 #endif
-#ifdef HAVE_HAL
-  char *err;
 
-  if( no_hal )
-    err = g_strdup( ":(" );
-  else
-    err = battstat_hal_initialise (callback);
+#ifdef HAVE_UPOWER
+  err = battstat_upower_initialise (callback);
 
-
-  if( err == NULL ) /* HAL is up */
+  if( err == NULL ) /* UPOWER is up */
   {
     pm_initialised = 1;
-    using_hal = TRUE;
+    using_upower = TRUE;
     return NULL;
   }
   else
@@ -453,6 +462,22 @@ power_management_initialise (int no_hal, void (*callback) (void))
     g_free( err );
 #endif
     
+#ifdef HAVE_HAL
+  if(! no_hal ) {
+    err = battstat_hal_initialise (callback);
+    
+    if( err == NULL) /* HAL is up */
+    {
+      pm_initialised = 1;
+      using_hal = TRUE;
+      return NULL;
+    }
+  }
+    
+    /* fallback to legacy methods */
+    g_free( err );
+#endif
+
 #ifdef __linux__
 
   if (acpi_linux_init(&acpiinfo)) {
@@ -498,6 +523,15 @@ power_management_initialise (int no_hal, void (*callback) (void))
 void
 power_management_cleanup( void )
 {
+#ifdef HAVE_UPOWER
+  if( using_upower)
+  {
+    battstat_upower_cleanup();
+    pm_initialised = 1;
+    return;
+  }
+#endif
+
 #ifdef HAVE_HAL
   if( using_hal )
   {
@@ -525,6 +559,16 @@ power_management_cleanup( void )
 }
 
 int
+power_management_using_upower( void)
+{
+#ifdef HAVE_UPOWER
+ return using_upower;
+#else
+ return 0;
+#endif
+}
+
+int
 power_management_using_hal( void )
 {
 #ifdef HAVE_HAL