diff options
Diffstat (limited to 'docs/dbus')
-rw-r--r-- | docs/dbus/ferdium_bar.py | 102 | ||||
-rw-r--r-- | docs/dbus/org.ferdium.Ferdium.xml | 80 | ||||
-rw-r--r-- | docs/dbus/requirements.txt | 1 |
3 files changed, 183 insertions, 0 deletions
diff --git a/docs/dbus/ferdium_bar.py b/docs/dbus/ferdium_bar.py new file mode 100644 index 000000000..6fd5d8c30 --- /dev/null +++ b/docs/dbus/ferdium_bar.py | |||
@@ -0,0 +1,102 @@ | |||
1 | import asyncio | ||
2 | import argparse | ||
3 | import html | ||
4 | |||
5 | from ferdium_dbus import Client | ||
6 | |||
7 | |||
8 | async def toggle_window(client, args): | ||
9 | """Toggle window visibility""" | ||
10 | |||
11 | await client.toggle_window() | ||
12 | |||
13 | |||
14 | async def toggle_mute(client, args): | ||
15 | """Toggle mute status""" | ||
16 | |||
17 | await client.toggle_mute() | ||
18 | |||
19 | |||
20 | async def unread(client, args): | ||
21 | """Get unread messages count""" | ||
22 | |||
23 | def callback(): | ||
24 | """Print unread count(s)""" | ||
25 | |||
26 | # For each service | ||
27 | counts = {} | ||
28 | for service in client.unread_services: | ||
29 | name, direct, indirect = service | ||
30 | safe_name = html.escape(name) | ||
31 | |||
32 | # If it's exactly the service we're looking for, just return the count | ||
33 | if safe_name == args.services: | ||
34 | count = direct | ||
35 | if not args.direct: | ||
36 | count += indirect | ||
37 | print(count) | ||
38 | return | ||
39 | |||
40 | # If the service in included in the services we're looking for | ||
41 | if args.services in ("total", "all") or safe_name in args.services: | ||
42 | counts[safe_name] = direct | ||
43 | if not args.direct: | ||
44 | counts[safe_name] += indirect | ||
45 | |||
46 | # Get total notifications | ||
47 | if args.services == "total": | ||
48 | print(sum(counts.values())) | ||
49 | return | ||
50 | |||
51 | # Finally, print each service notifications on a different line | ||
52 | print( | ||
53 | "\n".join( | ||
54 | f"{name}: {count}" | ||
55 | for name, count in counts.items() | ||
56 | ) | ||
57 | ) | ||
58 | |||
59 | # Do print counts and keep running if tail mode enabled | ||
60 | callback() | ||
61 | if args.tail: | ||
62 | client.on_change(callback) | ||
63 | await asyncio.get_running_loop().create_future() | ||
64 | |||
65 | |||
66 | async def main(): | ||
67 | """Main cli interface""" | ||
68 | |||
69 | # Define commands | ||
70 | commands = { | ||
71 | "unread": unread, | ||
72 | "toggle-mute": toggle_mute, | ||
73 | "toggle-window": toggle_window, | ||
74 | } | ||
75 | |||
76 | # Arguments parser | ||
77 | argparser = argparse.ArgumentParser(description="Script to interact with Ferdium on your bar") | ||
78 | subparsers = argparser.add_subparsers(dest="command", required=True) | ||
79 | # Unread command | ||
80 | argparser_unread = subparsers.add_parser("unread", help=unread.__doc__) | ||
81 | argparser_unread.add_argument("-s", "--services", default="total", help="Which services to get notifications from {total, all, <name>} (the name can be a comma-separated list)") | ||
82 | argparser_unread.add_argument("-d", "--direct", action="store_true", default=False, help="Get only direct (mentions or DM) messages") | ||
83 | argparser_unread.add_argument("-t", "--tail", action="store_true", default=False, help="Keep running and print on change") | ||
84 | # Toggle mute and toggle window commands | ||
85 | argparser_toggle_mute = subparsers.add_parser("toggle-mute", help=toggle_mute.__doc__) | ||
86 | argparser_toggle_window = subparsers.add_parser("toggle-window", help=toggle_window.__doc__) | ||
87 | # Get args | ||
88 | args = argparser.parse_args() | ||
89 | |||
90 | # Initialise ferdium client | ||
91 | client = Client() | ||
92 | await client.connect() | ||
93 | if not client.running: | ||
94 | print("not running") | ||
95 | return | ||
96 | |||
97 | # Execute command | ||
98 | await commands[args.command](client, args) | ||
99 | |||
100 | |||
101 | if __name__ == "__main__": | ||
102 | asyncio.run(main()) | ||
diff --git a/docs/dbus/org.ferdium.Ferdium.xml b/docs/dbus/org.ferdium.Ferdium.xml new file mode 100644 index 000000000..8c66a9e21 --- /dev/null +++ b/docs/dbus/org.ferdium.Ferdium.xml | |||
@@ -0,0 +1,80 @@ | |||
1 | <?xml version="1.0" encoding="UTF-8"?> | ||
2 | <!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN" | ||
3 | "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd"> | ||
4 | <node> | ||
5 | <!-- | ||
6 | org.ferdium.Ferdium: | ||
7 | @short_description: Control Ferdium from the desktop | ||
8 | |||
9 | Interface for accessing Ferdium notification state, allowing notification | ||
10 | counts to be displayed in the desktop (e.g., on a status bar) and updating | ||
11 | the muted state of notifications. | ||
12 | |||
13 | The #org.ferdium.UnreadDirectMessageCount, | ||
14 | #org.ferdium.UnreadIndirectMessageCount, and #org.ferdium.UnreadServices | ||
15 | are affected by notification muting and hiding settings of Ferdium. | ||
16 | In particular, they are not updated if #org.ferdium.Muted is #TRUE. | ||
17 | Moreover, services with muted notifications or hidden indirect message | ||
18 | counts will not appear in the respective counts. | ||
19 | This behavior is consistent with the behavior of the Ferdium tray icon. | ||
20 | --> | ||
21 | <interface name="org.ferdium.Ferdium"> | ||
22 | <!-- | ||
23 | ToggleMute: | ||
24 | |||
25 | Toggles the muted state of notifcations. | ||
26 | |||
27 | Use the #org.ferdium.Ferdium.Muted property to get or set the current | ||
28 | muted state. | ||
29 | --> | ||
30 | <method name="ToggleMute" /> | ||
31 | <!-- | ||
32 | ToggleWindow: | ||
33 | |||
34 | Brings the Ferdium window into the foreground if it is not currently | ||
35 | focused. Hides the Ferdium window if is is currently focused. | ||
36 | |||
37 | Calling this method is equivalent to clicking on the Ferdium tray icon. | ||
38 | --> | ||
39 | <method name="ToggleWindow" /> | ||
40 | <!-- | ||
41 | Muted: | ||
42 | |||
43 | Gets or sets the current muted state of notifications. | ||
44 | |||
45 | #TRUE if notifications are currently muted, #FALSE otherwise. | ||
46 | --> | ||
47 | <property name="Muted" type="b" access="readwrite" /> | ||
48 | <!-- | ||
49 | UnreadDirectMessageCount: | ||
50 | |||
51 | The number of unread direct messages. | ||
52 | --> | ||
53 | <property name="UnreadDirectMessageCount" type="u" access="read" /> | ||
54 | <!-- | ||
55 | UnreadIndirectMessageCount: | ||
56 | |||
57 | The number of unread indirect messages. | ||
58 | --> | ||
59 | <property name="UnreadIndirectMessageCount" type="u" access="read" /> | ||
60 | <!-- | ||
61 | UnreadServices: | ||
62 | |||
63 | The list of services with unread messages. | ||
64 | |||
65 | The value of this property is an array of structs corresponding to each | ||
66 | service with unread messages. | ||
67 | The elements of a struct are the following: | ||
68 | |||
69 | 1. The name of the service. | ||
70 | |||
71 | 2. The number of unread direct messages of the service. | ||
72 | |||
73 | 3. The number of unread indirect messages of the service. | ||
74 | |||
75 | Services with no unread direct or indirect messages (i.e., structs with | ||
76 | the second and third element set to 0) are omitted from the array. | ||
77 | --> | ||
78 | <property name="UnreadServices" type="a(suu)" access="read" /> | ||
79 | </interface> | ||
80 | </node> | ||
diff --git a/docs/dbus/requirements.txt b/docs/dbus/requirements.txt new file mode 100644 index 000000000..d08a849d9 --- /dev/null +++ b/docs/dbus/requirements.txt | |||
@@ -0,0 +1 @@ | |||
git+https://github.com/victorbnl/ferdium-dbus-py | |||