diff options
| author | Daniel Eklöf <daniel@ekloef.se> | 2024-07-23 09:29:05 +0000 |
|---|---|---|
| committer | Daniel Eklöf <daniel@ekloef.se> | 2024-07-23 09:29:05 +0000 |
| commit | ccb184ae645cd92a6e3aba429ab88a94a09bbf8c (patch) | |
| tree | 881797b5589ff9fbb7588b24791014ab01813fad /notify.c | |
| parent | notify: stdout is a bad name (diff) | |
osc: kitty notifications: updated support for icons
This implements the suggested protocol discussed in
https://github.com/kovidgoyal/kitty/issues/7657.
Icons are handled by loading a cache. Both in-band PNG data, and
symbolic names are allowed.
Applications use a graphical ID to reference the icon both when
loading the cache, and when showing a notification.
* 'g' is the graphical ID
* 'n' is optional, and assigns a symbolic name to the icon
* 'p=icon' - the payload is icon PNG data. It needs to be base64
encoded, but this is *not* implied. I.e. the application *must* use
e=1 explicitly.
To load an icon (in-band PNG data):
printf '\e]99;g=123:p=icon;<base64-encoded-png-data>\e\\'
or (symbolic name)
printf '\e]99;g=123:n=firefox:p=icon;\e\\'
Of course, we can combine the two, assigning *both* a symbolic
name, *and* PNG data:
printf '\e]99;g=123:n=firefox:p=icon;<base64-encoded-png>\e\\'
Then, to use the icon in a notification:
printf '\e]99;g=123;this is a notification\e\\'
Foot also allows a *symbolic* icon to be defined and used at the same
time:
printf '\e]99;g=123:n=firefox;this is a notification\e\\'
This obviously won't work with PNG data, since it uses the payload
portion of the escape sequence.
Diffstat (limited to 'notify.c')
| -rw-r--r-- | notify.c | 126 |
1 files changed, 116 insertions, 10 deletions
@@ -10,11 +10,12 @@ #include <fcntl.h> #define LOG_MODULE "notify" -#define LOG_ENABLE_DBG 0 +#define LOG_ENABLE_DBG 1 #include "log.h" #include "config.h" #include "spawn.h" #include "terminal.h" +#include "util.h" #include "wayland.h" #include "xmalloc.h" #include "xsnprintf.h" @@ -26,7 +27,9 @@ notify_free(struct terminal *term, struct notification *notif) free(notif->id); free(notif->title); free(notif->body); - free(notif->icon); + free(notif->icon_id); + free(notif->icon_symbolic_name); + free(notif->icon_data); free(notif->xdg_token); free(notif->stdout_data); } @@ -167,11 +170,22 @@ notify_notify(const struct terminal *term, struct notification *notif) /* Icon: use symbolic name from notification, if present, otherwise fallback to the application ID */ - const char *icon = notif->icon != NULL - ? notif->icon - : term->app_id != NULL - ? term->app_id - : term->conf->app_id; + const char *icon_name_or_path = term->app_id != NULL + ? term->app_id + : term->conf->app_id; + + if (notif->icon_id != NULL) { + for (size_t i = 0; i < ALEN(term->notification_icons); i++) { + const struct notification_icon *icon = &term->notification_icons[i]; + + if (icon->id != NULL && strcmp(icon->id, notif->icon_id) == 0) { + icon_name_or_path = icon->symbolic_name != NULL + ? icon->symbolic_name + : icon->tmp_file_on_disk; + break; + } + } + } LOG_DBG("notify: title=\"%s\", body=\"%s\"", title, body); @@ -201,9 +215,11 @@ notify_notify(const struct terminal *term, struct notification *notif) if (!spawn_expand_template( &term->conf->desktop_notifications.command, 6, - (const char *[]){"app-id", "window-title", "icon", "title", "body", "urgency"}, - (const char *[]){term->app_id ? term->app_id : term->conf->app_id, - term->window_title, icon, title, body, urgency_str}, + (const char *[]){ + "app-id", "window-title", "icon", "title", "body", "urgency"}, + (const char *[]){ + term->app_id ? term->app_id : term->conf->app_id, + term->window_title, icon_name_or_path, title, body, urgency_str}, &argc, &argv)) { return false; @@ -254,3 +270,93 @@ notify_notify(const struct terminal *term, struct notification *notif) notif->stdout_fd = stdout_fds[0]; return true; } + +static void +add_icon(struct notification_icon *icon, const char *id, const char *symbolic_name, + const uint8_t *data, size_t data_sz) +{ + icon->id = xstrdup(id); + icon->symbolic_name = symbolic_name != NULL ? xstrdup(symbolic_name) : NULL; + icon->tmp_file_on_disk = NULL; + + if (data_sz > 0) { + char name[64] = "/tmp/foot-notification-icon-cache-XXXXXX"; + int fd = mkstemp(name); + + if (fd < 0) { + LOG_ERRNO("failed to create temporary file for icon cache"); + return; + } + + write(fd, data, data_sz); + close(fd); + + LOG_DBG("wrote icon data to %s", name); + icon->tmp_file_on_disk = xstrdup(name); + } + + LOG_DBG("added icon to cache: %s: sym=%s, file=%s", + icon->id, icon->symbolic_name, icon->tmp_file_on_disk); +} + +void +notify_icon_add(struct terminal *term, const char *id, + const char *symbolic_name, const uint8_t *data, size_t data_sz) +{ +#if defined(_DEBUG) + for (size_t i = 0; i < ALEN(term->notification_icons); i++) { + struct notification_icon *icon = &term->notification_icons[i]; + if (icon->id != NULL && strcmp(icon->id, id) == 0) { + BUG("notification icon cache already contains \"%s\"", id); + } + } +#endif + + for (size_t i = 0; i < ALEN(term->notification_icons); i++) { + struct notification_icon *icon = &term->notification_icons[i]; + if (icon->id == NULL) { + add_icon(icon, id, symbolic_name, data, data_sz); + return; + } + } + + /* Cache full - throw out first entry, add new entry last */ + notify_icon_free(&term->notification_icons[0]); + memmove(&term->notification_icons[0], + &term->notification_icons[1], + ((ALEN(term->notification_icons) - 1) * + sizeof(term->notification_icons[0]))); + + add_icon( + &term->notification_icons[ALEN(term->notification_icons) - 1], + id, symbolic_name, data, data_sz); +} + +void +notify_icon_del(struct terminal *term, const char *id) +{ + for (size_t i = 0; i < ALEN(term->notification_icons); i++) { + struct notification_icon *icon = &term->notification_icons[i]; + + if (icon->id == NULL || strcmp(icon->id, id) != 0) + continue; + + notify_icon_free(icon); + return; + } +} + +void +notify_icon_free(struct notification_icon *icon) +{ + if (icon->tmp_file_on_disk != NULL) + unlink(icon->tmp_file_on_disk); + + free(icon->id); + free(icon->symbolic_name); + free(icon->tmp_file_on_disk); + + icon->id = NULL; + icon->symbolic_name = NULL; + icon->tmp_file_on_disk = NULL; +} |
