Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Handle Notification Hints in the Server #210

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Handle Notification Hints in the Server #210

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ca39423
handle urgency and desktop-entry hints in the server
Marukesu Jul 10, 2023
337277d
select the right title in the server
Marukesu Jul 10, 2023
d8e6352
handle image hints in the server
Marukesu Jul 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 18 additions & 34 deletions src/Bubble.vala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,34 +81,29 @@ public class Notifications.Bubble : AbstractBubble {
}

construct {
var app_image = new Gtk.Image () {
gicon = notification.primary_icon
var image_overlay = new Gtk.Overlay () {
valign = START
};

var image_overlay = new Gtk.Overlay ();
image_overlay.valign = Gtk.Align.START;
if (notification.image is LoadableIcon) {
image_overlay.child = new MaskedImage ((LoadableIcon) notification.image);
} else {
image_overlay.child = new Gtk.Image.from_gicon (notification.image, DIALOG) {
pixel_size = 48
};
}

if (notification.image != null) {
app_image.pixel_size = 24;
app_image.halign = app_image.valign = Gtk.Align.END;
if (notification.badge != null) {
var badge_image = new Gtk.Image.from_gicon (notification.badge, LARGE_TOOLBAR) {
pixel_size = 24,
halign = END,
valign = END
};

image_overlay.add (notification.image);
image_overlay.add_overlay (app_image);
} else {
app_image.pixel_size = 48;
image_overlay.add (app_image);

if (notification.badge_icon != null) {
var badge_image = new Gtk.Image.from_gicon (notification.badge_icon, Gtk.IconSize.LARGE_TOOLBAR) {
halign = Gtk.Align.END,
valign = Gtk.Align.END,
pixel_size = 24
};
image_overlay.add_overlay (badge_image);
}
image_overlay.add_overlay (badge_image);
}

var title_label = new Gtk.Label (notification.summary) {
var title_label = new Gtk.Label (notification.title) {
ellipsize = Pango.EllipsizeMode.END,
max_width_chars = 33,
valign = Gtk.Align.END,
Expand All @@ -119,7 +114,7 @@ public class Notifications.Bubble : AbstractBubble {

var body_label = new Gtk.Label (notification.body) {
ellipsize = Pango.EllipsizeMode.END,
lines = 2,
lines = "\n" in notification.body ? 1 : 2,
max_width_chars = 33,
use_markup = true,
valign = Gtk.Align.START,
Expand All @@ -129,17 +124,6 @@ public class Notifications.Bubble : AbstractBubble {
xalign = 0
};

if ("\n" in notification.body) {
string[] lines = notification.body.split ("\n");
string stripped_body = lines[0] + "\n";
for (int i = 1; i < lines.length; i++) {
stripped_body += lines[i].strip () + "";
}

body_label.label = stripped_body.strip ();
body_label.lines = 1;
}

column_spacing = 6;
attach (image_overlay, 0, 0, 1, 2);
attach (title_label, 1, 0);
Expand Down
129 changes: 120 additions & 9 deletions src/DBus.vala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ public class Notifications.Server : Object {

private Gee.HashMap<uint32, Notifications.Bubble> bubbles;

private static VariantType variant_type_pixbuf = new VariantType ("(iiibiiay)");

construct {
settings = new GLib.Settings ("io.elementary.notifications");
bubbles = new Gee.HashMap<uint32, Notifications.Bubble> ();
Expand Down Expand Up @@ -74,26 +76,63 @@ public class Notifications.Server : Object {
int32 expire_timeout,
BusName sender
) throws DBusError, IOError {
NotificationPriority urgency = NORMAL;
string? app_id = null;

if ("desktop-entry" in hints && hints["desktop-entry"].is_of_type (VariantType.STRING)) {
app_id = hints["desktop-entry"].get_string ();
}

if ("urgency" in hints && hints["urgency"].is_of_type (VariantType.BYTE)) {
urgency = priority_from_urgency (hints["urgency"].get_byte ());
}

// Silence "Automatic suspend. Suspending soon because of inactivity." notifications
// These values and hints are taken from gnome-settings-daemon source code
// See: https://gitlab.gnome.org/GNOME/gnome-settings-daemon/-/blob/master/plugins/power/gsd-power-manager.c#L356
// We must check for app_icon == "" to not block low power notifications
if ("desktop-entry" in hints && hints["desktop-entry"].get_string () == "gnome-power-panel"
&& "urgency" in hints && hints["urgency"].get_byte () == 2
&& app_icon == ""
&& expire_timeout == 0
) {
if (app_id == "gnome-power-panel" && urgency == URGENT && app_icon == "" && expire_timeout == 0) {
debug ("Blocked GSD notification");
throw new DBusError.FAILED ("Notification Blocked");
}

var id = (replaces_id != 0 ? replaces_id : ++id_counter);
var id = replaces_id;

if (hints.contains (X_CANONICAL_PRIVATE_SYNCHRONOUS)) {
send_confirmation (app_icon, hints);
} else {
var notification = new Notifications.Notification (app_name, app_icon, summary, body, actions, hints);
if (!settings.get_boolean ("do-not-disturb") || notification.priority == GLib.NotificationPriority.URGENT) {
// Only summary is required, so try to set a title when body is empty
if (body._strip () == "") {
body = summary._strip ();
summary = app_name._strip ();
} else if (summary._strip () == "") {
summary = app_name._strip ();
}

if (body == "" || summary == "" && app_id == null) {
throw new DBusError.INVALID_ARGS ("summary must not be empty");
}

var notification = new Notification (app_id, summary, body, actions) {
image = parse_image_string (app_icon),
priority = urgency
};

if (id == 0) {
id = ++id_counter;
}

var image = search_image (hints);
if (image != null) {
if (image is LoadableIcon) {
notification.badge = notification.image;
notification.image = image;
} else {
notification.badge = image;
}
}

if (!settings.get_boolean ("do-not-disturb") || notification.priority == URGENT) {
var app_settings = new Settings.with_path (
"io.elementary.notifications.applications",
settings.path.concat ("applications", "/", notification.app_id, "/")
Expand Down Expand Up @@ -182,7 +221,79 @@ public class Notifications.Server : Object {
CanberraGtk.context_get ().play_full (0, props);
}

static unowned string category_to_sound_name (string category) {
// convert between freedesktop urgency levels and GLib.NotificationPriority levels
// See: https://specifications.freedesktop.org/notification-spec/notification-spec-latest.html#urgency-levels
private static NotificationPriority priority_from_urgency (uint8 urgency) {
switch (urgency) {
case 0: return LOW;
case 1: return NORMAL;
case 2: return URGENT;
default:
warning ("unknown urgency value: %u, ignoring", urgency);
return NORMAL;
}
}

// search for a image hint, in priority order.
// See: https://specifications.freedesktop.org/notification-spec/notification-spec-latest.html#icons-and-images
private static Icon? search_image (HashTable<string, Variant> hints) {
const string[] IMAGE_HINTS = { "image-data", "image_data", "image-path", "image_path", "icon_data" };
Icon? image = null;

foreach (unowned var hint in IMAGE_HINTS) {
if (!hints.contains (hint)) {
continue;
}

if (hints[hint].is_of_type (VariantType.STRING)) {
image = parse_image_string (hints[hint].get_string ());
} else if (hints[hint].is_of_type (variant_type_pixbuf)) {
image = parse_image_pixbuf (hints[hint]);
}

if (image != null) {
break;
}

warning ("wrong type for hint '%s': %s. ignoring", hint, hints[hint].get_type_string ());
}

return image;
}

private static Gdk.Pixbuf? parse_image_pixbuf (Variant variant)
requires (variant.is_of_type (variant_type_pixbuf)) {
int width, height, rowstride, bps;
bool has_alpha;
Bytes data;

variant.get ("(iiibiiay)", out width, out height, out rowstride, out has_alpha, out bps, null, null);
data = variant.get_child_value (6).get_data_as_bytes ();

return new Gdk.Pixbuf.from_bytes (data, RGB, has_alpha, bps, width, height, rowstride);
}

private static Icon? parse_image_string (string image) {
if (Gtk.IconTheme.get_default ().has_icon (image)) {
return new ThemedIcon (image);
}

File? file = null;

if (image.has_prefix ("file:")) {
file = File.new_for_uri (image);
} else if (image.has_prefix ("/")) {
file = File.new_for_path (image);
}

if (file != null && file.query_exists ()) {
return new FileIcon (file);
}

return null;
}

private static unowned string category_to_sound_name (string category) {
unowned string sound;

switch (category) {
Expand Down
Loading