Add resolve_icon to support icon names

Author: vilhalmer

config.c

@@ -100,7 +100,7 @@ void init_default_style(struct mako_style *style) {
 	style->icons = false;
 #endif
 	style->max_icon_size = 64;
-
+	style->icon_path = strdup("");  // hicolor and pixmaps are implicit.
 
 	style->font = strdup("monospace 10");
 	style->markup = true;
@@ -139,6 +139,7 @@ bool apply_style(struct mako_style *target, const struct mako_style *style) {
 	// to bail without changing `target`.
 	char *new_font = NULL;
 	char *new_format = NULL;
+	char *new_icon_path = NULL;
 
 	if (style->spec.font) {
 		new_font = strdup(style->font);
@@ -157,6 +158,16 @@ bool apply_style(struct mako_style *target, const struct mako_style *style) {
 		}
 	}
 
+	if (style->spec.icon_path) {
+		new_icon_path = strdup(style->icon_path);
+		if (new_icon_path == NULL) {
+			free(new_format);
+			free(new_font);
+			fprintf(stderr, "allocation failed\n");
+			return false;
+		}
+	}
+
 	// Now on to actually setting things!
 
 	if (style->spec.width) {
@@ -194,6 +205,12 @@ bool apply_style(struct mako_style *target, const struct mako_style *style) {
 		target->spec.max_icon_size = true;
 	}
 
+	if (style->spec.icon_path) {
+		free(target->icon_path);
+		target->icon_path = new_icon_path;
+		target->spec.icon_path = true;
+	}
+
 	if (style->spec.font) {
 		free(target->font);
 		target->font = new_font;
@@ -457,6 +474,9 @@ static bool apply_style_option(struct mako_style *style, const char *name,
 	} else if (strcmp(name, "max-icon-size") == 0) {
 		return spec->max_icon_size =
 			parse_int(value, &style->max_icon_size);
+	} else if (strcmp(name, "icon-path") == 0) {
+		free(style->icon_path);
+		return spec->icon_path = !!(style->icon_path = strdup(value));
 	} else if (strcmp(name, "markup") == 0) {
 		return spec->markup = parse_boolean(value, &style->markup);
 	} else if (strcmp(name, "actions") == 0) {

dbus/xdg.c

@@ -118,9 +118,6 @@ static int handle_notify(sd_bus_message *msg, void *data,
 	notif->app_icon = strdup(app_icon);
 	notif->summary = strdup(summary);
 	notif->body = strdup(body);
-	if (state->config.superstyle.icons) {
-		notif->icon = create_icon(notif->app_icon, state->config.superstyle.max_icon_size);
-	}
 
 	// These fields may not be filled, so make sure they're valid strings.
 	notif->category = strdup("");
@@ -283,6 +280,10 @@ static int handle_notify(sd_bus_message *msg, void *data,
 			handle_notification_timer, notif);
 	}
 
+	if (notif->style.icons) {
+		notif->icon = create_icon(notif);
+	}
+
 	// Now we need to perform the grouping based on the new notification's
 	// group criteria specification (list of critera which must match). We
 	// don't necessarily want to start with the new notification, as depending

icon.c

@@ -1,9 +1,18 @@
+#define _POSIX_C_SOURCE 200809L
+#include <assert.h>
+#include <errno.h>
+#include <fnmatch.h>
+#include <glob.h>
+#include <libgen.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <assert.h>
 #include <cairo/cairo.h>
 
+#include "mako.h"
 #include "icon.h"
+#include "string-util.h"
+#include "wayland.h"
 
 #ifdef HAVE_ICONS
 #include <gdk/gdk.h>
@@ -28,7 +37,148 @@ static double fit_to_square(int width, int height, int square_size) {
 	return longest > square_size ? square_size/longest : 1.0;
 }
 
-struct mako_icon *create_icon(const char *path, double max_size) {
+// Attempt to find a full path for a notification's icon_name, which may be:
+// - An absolute path, which will simply be returned (as a new string)
+// - A file:// URI, which will be converted to an absolute path
+// - A Freedesktop icon name, which will be resolved within the configured
+//   `icon-path` using something that looks vaguely like the algorithm defined
+//   in the icon theme spec (https://standards.freedesktop.org/icon-theme-spec/icon-theme-spec-latest.html)
+//
+// Returns the resolved path, or NULL if it was unable to find an icon. The
+// return value must be freed by the caller.
+static char *resolve_icon(struct mako_notification *notif) {
+	char *icon_name = notif->app_icon;
+	if (icon_name[0] == '\0') {
+		return NULL;
+	}
+	if (icon_name[0] == '/') {
+		return strdup(icon_name);
+	}
+	if (strstr(icon_name, "file://") == icon_name) {
+		// Just chop off the scheme.
+		return strdup(icon_name + strlen("file://"));
+	}
+
+	// Determine the largest scale factor of any attached output.
+	int32_t max_scale = 1;
+	struct mako_output *output = NULL;
+	wl_list_for_each(output, &notif->state->outputs, link) {
+		if (output->scale > max_scale) {
+			max_scale = output->scale;
+		}
+	}
+
+	static const char fallback[] = "%s:/usr/share/icons/hicolor";
+	char *search = mako_asprintf(fallback, notif->style.icon_path);
+
+	char *saveptr = NULL;
+	char *theme_path = strtok_r(search, ":", &saveptr);
+
+	// Match all icon files underneath of the theme_path followed by any icon
+	// size and category subdirectories. This pattern assumes that all the
+	// files in the icon path are valid icon types.
+	static const char pattern_fmt[] = "%s/*/*/%s.*";
+
+	char *icon_path = NULL;
+	int32_t last_icon_size = 0;
+	while (theme_path) {
+		if (strlen(theme_path) == 0) {
+			continue;
+		}
+
+		glob_t icon_glob = {0};
+		char *pattern = mako_asprintf(pattern_fmt, theme_path, icon_name);
+
+		// Disable sorting because we're going to do our own anyway.
+		int found = glob(pattern, GLOB_NOSORT, NULL, &icon_glob);
+		size_t found_count = 0;
+		if (found == 0) {
+			// The value of gl_pathc isn't guaranteed to be usable if glob
+			// returns non-zero.
+			found_count = icon_glob.gl_pathc;
+		}
+
+		for (size_t i = 0; i < found_count; ++i) {
+			char *relative_path = icon_glob.gl_pathv[i];
+
+			// Find the end of the current search path and walk to the next
+			// path component. Hopefully this will be the icon resolution
+			// subdirectory.
+			relative_path += strlen(theme_path);
+			while (relative_path[0] == '/') {
+				++relative_path;
+			}
+
+			errno = 0;
+			int32_t icon_size = strtol(relative_path, NULL, 10);
+			if (errno || icon_size == 0) {
+				continue;
+			}
+
+			int32_t icon_scale = 1;
+			char *scale_str = strchr(relative_path, '@');
+			if (scale_str != NULL) {
+				icon_scale = strtol(scale_str + 1, NULL, 10);
+			}
+
+			if (icon_size == notif->style.max_icon_size &&
+					icon_scale == max_scale) {
+				// If we find an exact match, we're done.
+				free(icon_path);
+				icon_path = strdup(icon_glob.gl_pathv[i]);
+				break;
+			} else if (icon_size < notif->style.max_icon_size * max_scale &&
+					icon_size > last_icon_size) {
+				// Otherwise, if this icon is small enough to fit but bigger
+				// than the last best match, choose it on a provisional basis.
+				// We multiply by max_scale to increase the odds of finding an
+				// icon which looks sharp on the highest-scale output.
+				free(icon_path);
+				icon_path = strdup(icon_glob.gl_pathv[i]);
+				last_icon_size = icon_size;
+			}
+		}
+
+		free(pattern);
+		globfree(&icon_glob);
+
+		if (icon_path) {
+			// The spec says that if we find any match whatsoever in a theme,
+			// we should stop there to avoid mixing icons from different
+			// themes even if one is a better size.
+			break;
+		}
+		theme_path = strtok_r(NULL, ":", &saveptr);
+	}
+
+	if (icon_path == NULL) {
+		// Finally, fall back to looking in /usr/share/pixmaps. These are
+		// unsized icons, which may lead to downscaling, but some apps are
+		// still using it.
+		static const char pixmaps_fmt[] = "/usr/share/pixmaps/%s.*";
+
+		char *pattern = mako_asprintf(pixmaps_fmt, icon_name);
+
+		glob_t icon_glob = {0};
+		int found = glob(pattern, GLOB_NOSORT, NULL, &icon_glob);
+
+		if (found == 0 && icon_glob.gl_pathc > 0) {
+			icon_path = strdup(icon_glob.gl_pathv[0]);
+		}
+		free(pattern);
+		globfree(&icon_glob);
+	}
+
+	free(search);
+	return icon_path;
+}
+
+struct mako_icon *create_icon(struct mako_notification *notif) {
+	char *path = resolve_icon(notif);
+	if (path == NULL) {
+		return NULL;
+	}
+
 	GdkPixbuf *image = load_image(path);
 	if (image == NULL) {
 		return NULL;
@@ -37,7 +187,8 @@ struct mako_icon *create_icon(const char *path, double max_size) {
 	int image_height = gdk_pixbuf_get_height(image);
 
 	struct mako_icon *icon = calloc(1, sizeof(struct mako_icon));
-	icon->scale = fit_to_square(image_width, image_height, max_size);
+	icon->scale = fit_to_square(
+			image_width, image_height, notif->style.max_icon_size);
 	icon->width = image_width * icon->scale;
 	icon->height = image_height * icon->scale;
 

include/config.h

@@ -25,7 +25,7 @@ enum mako_sort_criteria {
 struct mako_style_spec {
 	bool width, height, margin, padding, border_size, border_radius, font,
 		markup, format, actions, default_timeout, ignore_timeout, icons,
-		max_icon_size, group_criteria_spec, invisible;
+		max_icon_size, icon_path, group_criteria_spec, invisible;
 
 	struct {
 		bool background, text, border, progress;
@@ -45,6 +45,7 @@ struct mako_style {
 
 	bool icons;
 	int32_t max_icon_size;
+	char *icon_path;
 
 	char *font;
 	bool markup;

include/icon.h

@@ -2,6 +2,7 @@
 #define MAKO_ICON_H
 
 #include <cairo/cairo.h>
+#include "notification.h"
 
 struct mako_icon {
 	double width;
@@ -10,7 +11,7 @@ struct mako_icon {
 	cairo_surface_t *image;
 };
 
-struct mako_icon *create_icon(const char *path, double max_size);
+struct mako_icon *create_icon(struct mako_notification *notif);
 void destroy_icon(struct mako_icon *icon);
 void draw_icon(cairo_t *cairo, struct mako_icon *icon,
 		double xpos, double ypos, double scale);

include/string-util.h

@@ -0,0 +1,6 @@
+#ifndef MAKO_STRING_H
+#define MAKO_STRING_H
+
+char *mako_asprintf(const char *fmt, ...);
+
+#endif

main.c

@@ -14,32 +14,33 @@
 static const char usage[] =
 	"Usage: mako [options...]\n"
 	"\n"
-	"  -h, --help                      Show help message and quit.\n"
-	"      --font <font>               Font family and size.\n"
-	"      --background-color <color>  Background color.\n"
-	"      --text-color <color>        Text color.\n"
-	"      --width <px>                Notification width.\n"
-	"      --height <px>               Max notification height.\n"
-	"      --margin <px>[,<px>...]     Margin values, comma separated.\n"
-	"                                  Up to four values, with the same\n"
-	"                                  meaning as in CSS.\n"
-	"      --padding <px>[,<px>...]    Padding values, comma separated.\n"
-	"                                  Up to four values, with the same\n"
-	"                                  meaning as in CSS.\n"
-	"      --border-size <px>          Border size.\n"
-	"      --border-color <color>      Border color.\n"
-	"      --border-radius <px>        Corner radius\n"
-	"      --progress-color <color>    Progress indicator color.\n"
-	"      --icons <0|1>               Show icons in notifications.\n"
-	"      --max-icon-size <px>        Set max size of icons.\n"
-	"      --markup <0|1>              Enable/disable markup.\n"
-	"      --format <format>           Format string.\n"
-	"      --hidden-format <format>    Format string.\n"
-	"      --max-visible <n>           Max number of visible notifications.\n"
-	"      --default-timeout <timeout> Default timeout in milliseconds.\n"
-	"      --output <name>             Show notifications on this output.\n"
-	"      --layer <layer>             Arrange notifications at this layer.\n"
-	"      --anchor <position>         Position on output to put notifications.\n"
+	"  -h, --help                          Show help message and quit.\n"
+	"      --font <font>                   Font family and size.\n"
+	"      --background-color <color>      Background color.\n"
+	"      --text-color <color>            Text color.\n"
+	"      --width <px>                    Notification width.\n"
+	"      --height <px>                   Max notification height.\n"
+	"      --margin <px>[,<px>...]         Margin values, comma separated.\n"
+	"                                      Up to four values, with the same\n"
+	"                                      meaning as in CSS.\n"
+	"      --padding <px>[,<px>...]        Padding values, comma separated.\n"
+	"                                      Up to four values, with the same\n"
+	"                                      meaning as in CSS.\n"
+	"      --border-size <px>              Border size.\n"
+	"      --border-color <color>          Border color.\n"
+	"      --border-radius <px>            Corner radius\n"
+	"      --progress-color <color>        Progress indicator color.\n"
+	"      --icons <0|1>                   Show icons in notifications.\n"
+	"      --icon-path <path>[:<path>...]  Icon search path, colon delimited.\n"
+	"      --max-icon-size <px>            Set max size of icons.\n"
+	"      --markup <0|1>                  Enable/disable markup.\n"
+	"      --format <format>               Format string.\n"
+	"      --hidden-format <format>        Format string.\n"
+	"      --max-visible <n>               Max number of visible notifications.\n"
+	"      --default-timeout <timeout>     Default timeout in milliseconds.\n"
+	"      --output <name>                 Show notifications on this output.\n"
+	"      --layer <layer>                 Arrange notifications at this layer.\n"
+	"      --anchor <position>             Position on output to put notifications.\n"
 	"\n"
 	"Colors can be specified with the format #RRGGBB or #RRGGBBAA.\n";
 

meson.build

@@ -54,7 +54,8 @@ src_files = [
 	'wayland.c',
 	'criteria.c',
 	'types.c',
-	'icon.c'
+	'icon.c',
+	'string-util.c',
 ]
 
 executable(