add system tray module

[christian-schulze]

This is an attempt to create an SNI based system tray module for nwg-panel.

Progress:

• dbus watcher
• dbus host
• item
• tray module (showing real app icons)
• wire in DbusmenuGtk3
• cleanup and action any feedback

I think the menu's can be implemented by leveraging the libdbusmenu library. There is example python code in the following two tests:

• https://github.com/AyatanaIndicators/libdbusmenu/blob/master/tests/test-glib-simple-items.py
• https://github.com/AyatanaIndicators/libdbusmenu/blob/master/tests/test-gtk-shortcut-client.py

I'm a front-end developer by day so I apologise in advance for butchering the python language 😉 All feedback welcome!

This addresses #41

[nwg-piotr]

Great! I'll give it a try as soon as I settle down behind my desk (tonight).

[nwg-piotr]

I managed to launch your add-system-tray-module branch and see a tray icon.

Dependencies check: {'light': True, 'brightnessctl': False, 'pamixer': True, 'pactl': True, 'playerctl': True, 'netifaces': True, 'btmgmt': True, 'wlr-randr': True, 'upower': True, 'swaync': True}
Running on sway
Output: eDP-1, position: top, layer: bottom, width: 1920, height: 30
Output: eDP-1, position: bottom, layer: bottom, width: 1920, height: 30
Output: DP-1, position: bottom, layer: bottom, width: 1200, height: 30
Output: HDMI-A-1, position: bottom, layer: bottom, width: 1920, height: 30
host.init(): running dasbus.EventLoop
StatusNotifierHostInterface -> watcher_available_handler
watcher.init(): published org.kde.StatusNotifierWatcher/StatusNotifierWatcher on dbus.
watcher.init(): running dasbus.EventLoop
StatusNotifierWatcher -> RegisteredStatusNotifierItems
StatusNotifierWatcher -> IsStatusNotifierHostRegistered: False
StatusNotifierWatcher -> ProtocolVersion: 
StatusNotifierWatcher -> RegisterStatusNotifierHost: /StatusNotifierHost/0
StatusNotifierWatcher -> RegisterStatusNotifierItem
  service: /org/ayatana/NotificationItem/azote_status_icon
  sender: :1.3410
StatusNotifierWatcher -> item_available_handler
  full_service_name: :1.3410/org/ayatana/NotificationItem/azote_status_icon
StatusNotifierHostInterface -> item_registered_handler
  full_service_name: :1.3410/org/ayatana/NotificationItem/azote_status_icon
Tray -> add_item: {'ItemIsMenu': True, 'Id': 'azote_status_icon', 'Category': 'ApplicationStatus', 'Title': 'azote', 'Status': 'NeedsAttention', 'IconName': '/usr/share/azote/indicator_attention.png', 'AttentionIconName': '/usr/share/azote/indicator_attention.png', 'IconThemePath': '', 'Menu': '/org/ayatana/NotificationItem/azote_status_icon/Menu'}
StatusNotifierWatcher -> RegisterStatusNotifierItem
  service: /org/ayatana/NotificationItem/azote_status_icon
  sender: :1.3410
StatusNotifierWatcher -> RegisterStatusNotifierItem: item already registered
  full_service_name: :1.3410/org/ayatana/NotificationItem/azote_status_icon
tray.update_icon -> icon not found
  icon_name: /usr/share/azote/indicator_attention.png
  search_path: ['/home/piotr/.local/share/icons', '/home/piotr/.icons', '/usr/local/share/icons', '/usr/share/icons', '/usr/local/share/pixmaps', '/usr/share/pixmaps']

[christian-schulze]

@nwg-piotr Excellent 👍

I see the azote icon was not found so it rendered the fallback icon:

tray.update_icon -> icon not found
icon_name: /usr/share/azote/indicator_attention.png

I'll look into that now.

[nwg-piotr]

Great! Will check the progress in the morning. It's 4 am here. :)

[christian-schulze]

yikes, sorry if I woke you. FYI missing icon fixed.

[christian-schulze]

@nwg-piotr I've managed to get the menu's working! This makes use of the libdbusmenu library mentioned in the description.

I struggled to get python to recognise the gi.repository.DbusmenuGtk3 class. In the end I needed to install the gobject-introspection system library and nuke my python virtual environment, after that magic 🪄

[nwg-piotr]

It looks excellent!

If it comes to virtual environments: they are great, but cause issues, too, at least in PyCharm. Lately I use my system python.

[nwg-piotr]

flameshot ends up in positional arguments missing:

host.init(): running dasbus.EventLoop
watcher.init(): published org.kde.StatusNotifierWatcher/StatusNotifierWatcher on dbus.
watcher.init(): running dasbus.EventLoop
StatusNotifierHostInterface -> watcher_available_handler
StatusNotifierWatcher -> RegisterStatusNotifierHost: /StatusNotifierHost/0
StatusNotifierWatcher -> IsStatusNotifierHostRegistered: True
StatusNotifierWatcher -> IsStatusNotifierHostRegistered: True
StatusNotifierWatcher -> RegisterStatusNotifierItem
  service: :1.1883
  sender: :1.1883
StatusNotifierWatcher -> item_available_handler
  full_service_name: :1.1883/StatusNotifierItem
StatusNotifierHostInterface -> item_registered_handler
  full_service_name: :1.1883/StatusNotifierItem
Traceback (most recent call last):
  File "/usr/lib/python3.10/site-packages/dasbus/client/observer.py", line 88, in _name_appeared_callback
    callback(name_owner, *callback_args)
  File "/usr/lib/python3.10/site-packages/dasbus/client/observer.py", line 230, in _service_name_appeared_callback
    self._enable_service()
  File "/usr/lib/python3.10/site-packages/dasbus/client/observer.py", line 220, in _enable_service
    self._service_available.emit(self)
  File "/usr/lib/python3.10/site-packages/dasbus/signal.py", line 53, in emit
    callback(*args, **kwargs)
  File "/home/piotr/PycharmProjects/nwg-panel-shulze/nwg_panel/modules/sni_system_tray/item.py", line 69, in item_available_handler
    self.item_proxy.NewIconThemePath.connect(
  File "/usr/lib/python3.10/site-packages/dasbus/client/proxy.py", line 161, in __getattr__
    member = self._get_member(self._get_interface(name), name)
  File "/usr/lib/python3.10/site-packages/dasbus/client/proxy.py", line 223, in _get_interface
    raise AttributeError(
AttributeError: DBus object has no attribute 'NewIconThemePath'.
Traceback (most recent call last):
  File "/usr/lib/python3.10/site-packages/dasbus/client/handler.py", line 133, in _signal_callback
    callback(parameters, *callback_args)
  File "/usr/lib/python3.10/site-packages/dasbus/client/handler.py", line 359, in _signal_callback
    callback(*unwrap_variant(parameters))
  File "/usr/lib/python3.10/site-packages/dasbus/signal.py", line 53, in emit
    callback(*args, **kwargs)
TypeError: StatusNotifierItem.item_available_handler.<locals>.<lambda>() missing 2 required positional arguments: '_icon_name' and '_icon_pixmap'
Traceback (most recent call last):
  File "/usr/lib/python3.10/site-packages/dasbus/client/handler.py", line 133, in _signal_callback
    callback(parameters, *callback_args)
  File "/usr/lib/python3.10/site-packages/dasbus/client/handler.py", line 359, in _signal_callback
    callback(*unwrap_variant(parameters))
  File "/usr/lib/python3.10/site-packages/dasbus/signal.py", line 53, in emit
    callback(*args, **kwargs)
TypeError: StatusNotifierItem.item_available_handler.<locals>.<lambda>() missing 1 required positional argument: '_title'

[christian-schulze]

oh cool, so flameshot is doing a bunch of things differently which I need to complete implementing:

1. Sends the icon as a pixbuf instead of an icon name/path
2. Does not implement the WindowId property (causing the error you see)
3. Implements the Tooltip property

These are basically differences in libappindicator and full SNI implementations. I'll get stuck in and fill in the missing pieces 👍

[nwg-piotr]

Yes, I heard it's a mess. That's why gnome guys gave up on the tray. But people are strangely attached to it, for some mysterious reason.

[christian-schulze]

@nwg-piotr yeah its fragmented.

Fixes pushed 🎉

[nwg-piotr]

It must be 2:30 am in your place! 🤣

No more problem with the flameshot icon. Good job!

I wonder why I see no Chromium icon. I remember seeing it previously. Same applies to nm-applet.

[christian-schulze]

It is 12:45AM so yeah just about time to log off.

I don't use Chromium so can't check yet, but if you're not seeing anything chromium related in the logs then that means its using another protocol other than SNI over dbus. It may well be using the xembed protocol, which this solution definitely does not support.

[christian-schulze]

For what its worth, this solution is now very close to feature parity with Waybars tray implementation.

[nwg-piotr]

I don't care about the Chomium icon. I never use it residently. But the nm-applet icon does appear in Waybar, if I remember well.

[christian-schulze]

Also last before i go to bed...i just tested nm-applet and I see the icon/menu, I ran it like this:

nm-applet --indicator

This instructs it to use the libappindicator lib which is a partial SNI implementation.

[nwg-piotr]

Maybe I'm doing something wrong....

[christian-schulze]

I'll need some info about your environment to help troubleshoot, I'm on arch.

[nwg-piotr]

So am I. Just added nm-applet --indicator to autostart. Haven't used it for quite a long time, possibly I'm missing something.

[nwg-piotr]

It works after restarting sway.

Many thanks for your contribution!

[nwg-piotr]

Let me know when it's ready to merge. It seems to have no config yet (?).

[christian-schulze]

No worries at all, this has been really interesting to work on.

I've got some errors showing after opening/closing the nm-applet menu, so I will fix that tomorrow evening. Will ping you when its ready 👍

[christian-schulze]

@nwg-piotr unless you have any feedback, I think this is ready to go.

[christian-schulze]

Also some interesting reading on the effort to create a new app indicator protocol:
https://gitlab.freedesktop.org/xdg/xdg-specs/-/issues/84

[nwg-piotr]

effort to create a new app indicator protocol

Yes, I saw this last night somewhere on reddit.

Your PR seems not to contain any config GUI. No problem, but please check if these are all keys:

settings["root-css-name"]
settings["inner-css-name"]
settings["icon-size"]
settings["inner-css-name"]
settings["smooth-scrolling-threshold"]

[christian-schulze]

Yes those are the ones used, though it works fine without any settings at all.

I'm more than happy to add settings into nwg_panel/config.py, either as part of this PR or I can create another one in the next few days. What do you think?

[nwg-piotr]

This would take me half an hour... :)

[nwg-piotr]

The minimum requirement is to add "taskbar" to the known_modules list. I do not want users to edit json manually. But the icon size should be adjustable, too.

[christian-schulze]

no worries, config added.

[christian-schulze]

Cheers for merging 🎉

Happy to address any bugs and improvements anyone has.

[nwg-piotr]

Thanks again for the great module!

I'll need to add the dependency check. As the python-dasbus package comes from AUR, it should be an optional dependency. I'll add some lines to prevent the program from crashing when it's absent.

For use in my flagship, the full shell implementation in ArchLabs Linux, I'll have python-dasbus packaged in the distro-specific repo.