Merge pull request #252 from alebastr/tray-items-refresh

Process tray icon updates

include/modules/sni/item.hpp

@@ -2,12 +2,14 @@
 
 #include <dbus-status-notifier-item.h>
 #include <glibmm/refptr.h>
+#include <giomm/dbusproxy.h>
 #include <gtkmm/eventbox.h>
 #include <gtkmm/image.h>
 #include <gtkmm/icontheme.h>
 #include <gtkmm/menu.h>
 #include <json/json.h>
 #include <libdbusmenu-gtk/dbusmenu-gtk.h>
+#include <sigc++/trackable.h>
 #ifdef FILESYSTEM_EXPERIMENTAL
 #include <experimental/filesystem>
 #else
@@ -16,7 +18,7 @@
 
 namespace waybar::modules::SNI {
 
-class Item {
+class Item : public sigc::trackable {
 public:
   Item(std::string, std::string, const Json::Value&);
   ~Item() = default;
@@ -46,8 +48,12 @@ public:
   bool item_is_menu;
 
 private:
-  static void proxyReady(GObject *obj, GAsyncResult *res, gpointer data);
+  void proxyReady(Glib::RefPtr<Gio::AsyncResult>& result);
-  static void getAll(GObject *obj, GAsyncResult *res, gpointer data);
+  void setProperty(const Glib::ustring& name, Glib::VariantBase& value);
+  void getUpdatedProperties();
+  void processUpdatedProperties(Glib::RefPtr<Gio::AsyncResult>& result);
+  void onSignal(const Glib::ustring& sender_name, const Glib::ustring& signal_name,
+      const Glib::VariantContainerBase& arguments);
 
   void updateImage();
   Glib::RefPtr<Gdk::Pixbuf> extractPixBuf(GVariant *variant);
@@ -56,8 +62,9 @@ private:
   bool makeMenu(GdkEventButton *const &ev);
   bool handleClick(GdkEventButton *const & /*ev*/);
 
-  GCancellable *cancellable_ = nullptr;
+  Glib::RefPtr<Gio::Cancellable> cancellable_;
-  SnItem *proxy_ = nullptr;
+  Glib::RefPtr<Gio::DBus::Proxy> proxy_;
+  bool update_pending_;
 };
 
 } // namespace waybar::modules::SNI

src/modules/sni/item.cpp

@@ -1,10 +1,16 @@
 #include "modules/sni/item.hpp"
 
 #include <iostream>
+#include <glibmm/main.h>
+
+using namespace Glib;
+
+static const ustring SNI_INTERFACE_NAME = sn_item_interface_info()->name;
+static const unsigned UPDATE_DEBOUNCE_TIME = 10;
 
 waybar::modules::SNI::Item::Item(std::string bn, std::string op, const Json::Value& config)
-    : bus_name(bn), object_path(op), icon_size(16), effective_icon_size(0)
+    : bus_name(bn), object_path(op), icon_size(16), effective_icon_size(0),
-{
+    update_pending_(false) {
   if (config["icon-size"].isUInt()) {
     icon_size = config["icon-size"].asUInt();
   }
@@ -12,107 +18,148 @@ waybar::modules::SNI::Item::Item(std::string bn, std::string op, const Json::Val
   event_box.add_events(Gdk::BUTTON_PRESS_MASK);
   event_box.signal_button_press_event().connect(
       sigc::mem_fun(*this, &Item::handleClick));
-  cancellable_ = g_cancellable_new();
+
-  sn_item_proxy_new_for_bus(
+  cancellable_ = Gio::Cancellable::create();
-      G_BUS_TYPE_SESSION, G_DBUS_PROXY_FLAGS_NONE, bus_name.c_str(),
+
-      object_path.c_str(), cancellable_, &Item::proxyReady, this);
+  auto interface = Glib::wrap(sn_item_interface_info(), true);
+  Gio::DBus::Proxy::create_for_bus(Gio::DBus::BusType::BUS_TYPE_SESSION, bus_name,
+      object_path, SNI_INTERFACE_NAME, sigc::mem_fun(*this, &Item::proxyReady),
+      cancellable_, interface);
 }
 
-void waybar::modules::SNI::Item::proxyReady(GObject *obj, GAsyncResult *res,
+void waybar::modules::SNI::Item::proxyReady(Glib::RefPtr<Gio::AsyncResult>& result) {
-                                            gpointer data) {
+  try {
-  GError *error = nullptr;
+    this->proxy_ = Gio::DBus::Proxy::create_for_bus_finish(result);
-  SnItem *proxy = sn_item_proxy_new_for_bus_finish(res, &error);
+    /* Properties are already cached during object creation */
-  if (g_error_matches(error, G_IO_ERROR, G_IO_ERROR_CANCELLED)) {
+    auto cached_properties = this->proxy_->get_cached_property_names();
-    g_error_free(error);
+    for (const auto& name: cached_properties) {
-    return;
+      Glib::VariantBase value;
+      this->proxy_->get_cached_property(value, name);
+      setProperty(name, value);
     }
-  auto item = static_cast<SNI::Item *>(data);
-  item->proxy_ = proxy;
-  if (error) {
-    std::cerr << error->message << std::endl;
-    g_error_free(error);
-    return;
-  }
-  auto conn = g_dbus_proxy_get_connection(G_DBUS_PROXY(proxy));
 
-  g_dbus_connection_call(conn, item->bus_name.c_str(),
+    this->proxy_->signal_signal().connect(sigc::mem_fun(*this, &Item::onSignal));
-    item->object_path.c_str(), "org.freedesktop.DBus.Properties", "GetAll",
+
-    g_variant_new("(s)", "org.kde.StatusNotifierItem"),
+    if (this->id.empty() || this->category.empty() || this->status.empty()) {
-    G_VARIANT_TYPE("(a{sv})"), G_DBUS_CALL_FLAGS_NONE, -1, item->cancellable_,
+      std::cerr << "Invalid Status Notifier Item: " + this->bus_name + "," +
-    &Item::getAll, data);
+        this->object_path << std::endl;
+      return;
+    }
+    if (!this->icon_theme_path.empty()) {
+      Glib::RefPtr<Gtk::IconTheme> icon_theme = Gtk::IconTheme::get_default();
+      icon_theme->append_search_path(this->icon_theme_path);
+    }
+    this->updateImage();
+    // this->event_box.set_tooltip_text(this->title);
+
+  } catch (const Glib::Error& err) {
+    g_error("Failed to create DBus Proxy for %s %s: %s", bus_name.c_str(),
+        object_path.c_str(), err.what().c_str());
+  } catch (const std::exception& err) {
+    g_error("Failed to create DBus Proxy for %s %s: %s", bus_name.c_str(),
+        object_path.c_str(), err.what());
+  }
 }
 
-void waybar::modules::SNI::Item::getAll(GObject *obj, GAsyncResult *res,
+template<typename T>
-                                        gpointer data) {
+T get_variant(VariantBase& value) {
-  GError *error = nullptr;
+    return VariantBase::cast_dynamic<Variant<T>>(value).get();
-  auto conn = G_DBUS_CONNECTION(obj);
+}
-  GVariant *properties = g_dbus_connection_call_finish(conn, res, &error);
+
-  if (g_error_matches(error, G_IO_ERROR, G_IO_ERROR_CANCELLED)) {
+void
-    g_error_free(error);
+waybar::modules::SNI::Item::setProperty(const ustring& name,
-    return;
+    VariantBase& value) {
-  }
+  if (name == "Category") {
-  auto item = static_cast<SNI::Item *>(data);
+    category = get_variant<std::string>(value);
-  if (error) {
+  } else if (name == "Id") {
-    std::cerr << error->message << std::endl;
+    id = get_variant<std::string>(value);
-    g_error_free(error);
+  } else if (name == "Title") {
-    return;
+    title = get_variant<std::string>(value);
-  }
+  } else if (name == "Status") {
-  GVariantIter *it = nullptr;
+    status = get_variant<std::string>(value);
-  g_variant_get(properties, "(a{sv})", &it);
+  } else if (name == "WindowId") {
-  gchar *key;
+    window_id = get_variant<int32_t>(value);
-  GVariant *value;
+  } else if (name == "IconName") {
-  while (g_variant_iter_next(it, "{sv}", &key, &value)) {
+    icon_name = get_variant<std::string>(value);
-    if (g_strcmp0(key, "Category") == 0) {
+  } else if (name == "IconPixmap") {
-      item->category = g_variant_dup_string(value, nullptr);
+    icon_pixmap = this->extractPixBuf(value.gobj());
-    } else if (g_strcmp0(key, "Id") == 0) {
+  } else if (name == "OverlayIconName") {
-      item->id = g_variant_dup_string(value, nullptr);
+    overlay_icon_name = get_variant<std::string>(value);
-    } else if (g_strcmp0(key, "Title") == 0) {
+  } else if (name == "OverlayIconPixmap") {
-      item->title = g_variant_dup_string(value, nullptr);
-    } else if (g_strcmp0(key, "Status") == 0) {
-      item->status = g_variant_dup_string(value, nullptr);
-    } else if (g_strcmp0(key, "WindowId") == 0) {
-      item->window_id = g_variant_get_int32(value);
-    } else if (g_strcmp0(key, "IconName") == 0) {
-      item->icon_name = g_variant_dup_string(value, nullptr);
-    } else if (g_strcmp0(key, "IconPixmap") == 0) {
-      item->icon_pixmap = item->extractPixBuf(value);
-    } else if (g_strcmp0(key, "OverlayIconName") == 0) {
-      item->overlay_icon_name = g_variant_dup_string(value, nullptr);
-    } else if (g_strcmp0(key, "OverlayIconPixmap") == 0) {
     // TODO: overlay_icon_pixmap
-    } else if (g_strcmp0(key, "AttentionIconName") == 0) {
+  } else if (name == "AttentionIconName") {
-      item->attention_icon_name = g_variant_dup_string(value, nullptr);
+    attention_icon_name = get_variant<std::string>(value);
-    } else if (g_strcmp0(key, "AttentionIconPixmap") == 0) {
+  } else if (name == "AttentionIconPixmap") {
     // TODO: attention_icon_pixmap
-    } else if (g_strcmp0(key, "AttentionMovieName") == 0) {
+  } else if (name == "AttentionMovieName") {
-      item->attention_movie_name = g_variant_dup_string(value, nullptr);
+    attention_movie_name = get_variant<std::string>(value);
-    } else if (g_strcmp0(key, "ToolTip") == 0) {
+  } else if (name == "ToolTip") {
     // TODO: tooltip
-    } else if (g_strcmp0(key, "IconThemePath") == 0) {
+  } else if (name == "IconThemePath") {
-      item->icon_theme_path = g_variant_dup_string(value, nullptr);
+    icon_theme_path = get_variant<std::string>(value);
-    } else if (g_strcmp0(key, "Menu") == 0) {
+  } else if (name == "Menu") {
-      item->menu = g_variant_dup_string(value, nullptr);
+    menu = get_variant<std::string>(value);
-    } else if (g_strcmp0(key, "ItemIsMenu") == 0) {
+  } else if (name == "ItemIsMenu") {
-      item->item_is_menu = g_variant_get_boolean(value);
+    item_is_menu = get_variant<bool>(value);
   }
-    g_variant_unref(value);
+}
-    g_free(key);
+
+void
+waybar::modules::SNI::Item::getUpdatedProperties() {
+  update_pending_ = false;
+
+  auto params = VariantContainerBase::create_tuple({
+    Variant<ustring>::create(SNI_INTERFACE_NAME)
+  });
+  proxy_->call("org.freedesktop.DBus.Properties.GetAll",
+      sigc::mem_fun(*this, &Item::processUpdatedProperties), params);
+};
+
+void
+waybar::modules::SNI::Item::processUpdatedProperties(
+    Glib::RefPtr<Gio::AsyncResult>& _result) {
+  try {
+    auto result = proxy_->call_finish(_result);
+    // extract "a{sv}" from VariantContainerBase
+    Variant<std::map<ustring, VariantBase>> properties_variant;
+    result.get_child(properties_variant);
+    auto properties = properties_variant.get();
+
+    for (const auto& [name, value]: properties) {
+      VariantBase old_value;
+      proxy_->get_cached_property(old_value, name);
+      if (!value.equal(old_value)) {
+        proxy_->set_cached_property(name, value);
+        setProperty(name, const_cast<VariantBase&>(value));
       }
-  g_variant_iter_free(it);
-  g_variant_unref(properties);
-  if (item->id.empty() || item->category.empty() || item->status.empty()) {
-    std::cerr << "Invalid Status Notifier Item: " + item->bus_name + "," +
-      item->object_path << std::endl;
-    return;
     }
-  if (!item->icon_theme_path.empty()) {
+
-    GtkIconTheme *icon_theme = gtk_icon_theme_get_default();
+    this->updateImage();
-    gtk_icon_theme_append_search_path(icon_theme,
+    // this->event_box.set_tooltip_text(this->title);
-      item->icon_theme_path.c_str());
+  } catch (const Glib::Error& err) {
+    g_warning("Failed to update properties: %s", err.what().c_str());
+  } catch (const std::exception& err) {
+    g_warning("Failed to update properties: %s", err.what());
   }
-  item->updateImage();
+}
-  // item->event_box.set_tooltip_text(item->title);
+
-  // TODO: handle change
+void
+waybar::modules::SNI::Item::onSignal(const ustring& sender_name,
+    const ustring& signal_name, const VariantContainerBase& arguments) {
+  if (!update_pending_ && signal_name.compare(0, 3, "New") == 0) {
+    /* Debounce signals and schedule update of all properties.
+     * Based on behavior of Plasma dataengine for StatusNotifierItem.
+     */
+    update_pending_ = true;
+    Glib::signal_timeout().connect_once(
+        sigc::mem_fun(*this, &Item::getUpdatedProperties), UPDATE_DEBOUNCE_TIME);
+  }
+}
+
+
+static void
+pixbuf_data_deleter(const guint8* data) {
+  g_free((void*) data);
 }
 
 Glib::RefPtr<Gdk::Pixbuf>
@@ -158,7 +205,8 @@ waybar::modules::SNI::Item::extractPixBuf(GVariant *variant) {
       array[i + 3] = alpha;
     }
     return Gdk::Pixbuf::create_from_data(array, Gdk::Colorspace::COLORSPACE_RGB,
-                                         true, 8, lwidth, lheight, 4 * lwidth);
+                                         true, 8, lwidth, lheight, 4 * lwidth,
+                                         &pixbuf_data_deleter);
   }
   return Glib::RefPtr<Gdk::Pixbuf>{};
 }
@@ -251,15 +299,21 @@ bool waybar::modules::SNI::Item::makeMenu(GdkEventButton *const &ev)
 }
 
 bool waybar::modules::SNI::Item::handleClick(GdkEventButton *const &ev) {
+  auto parameters = VariantContainerBase::create_tuple({
+    Variant<int>::create(ev->x),
+    Variant<int>::create(ev->y)
+  });
   if ((ev->button == 1 && item_is_menu) || ev->button == 3) {
     if (!makeMenu(ev)) {
-      return sn_item_call_context_menu_sync(proxy_, ev->x, ev->y, nullptr, nullptr);
+      proxy_->call("ContextMenu", parameters);
+      return true;
     }
   } else if (ev->button == 1) {
-    return sn_item_call_activate_sync(proxy_, ev->x, ev->y, nullptr, nullptr);
+    proxy_->call("Activate", parameters);
+    return true;
   } else if (ev->button == 2) {
-    return sn_item_call_secondary_activate_sync(proxy_, ev->x, ev->y,
+    proxy_->call("SecondaryActivate", parameters);
-      nullptr, nullptr);
+    return true;
   }
   return false;
 }