Differential D22365 Diff 62797 src/notifybymacosnotificationcenter.mm

Changeset View

Standalone View

src/notifybymacosnotificationcenter.mm

This file was added.

1		#include "notifybymacosnotificationcenter.h"
2		#include "knotification.h"
3		#include "knotifyconfig.h"
4		#include "debug_p.h"
5
6		#include <QIcon>
7		#include <QDebug>
8		#include <QtMac>
	broulikUnsubmitted Done Unused? broulik: Unused?
9
10		#import <Foundation/Foundation.h>
11		#import <objc/runtime.h>
12
13		Q_FORWARD_DECLARE_OBJC_CLASS(MacOSNotificationCenterDelegate);
14
15		class MacOSNotificationCenterPrivate
16		{
17		public:
18		static MacOSNotificationCenterPrivate *instance();
19		~MacOSNotificationCenterPrivate();
20
21		QMap<int, KNotification*> m_notifications;
	broulikUnsubmitted Done I don't really see the point in those methods, since it's "private" you can just have `KNotification` manipulate `m_notifications` directly. broulik: I don't really see the point in those methods, since it's "private" you can just have…
22
23		int m_internalCounter;
24		private:
25		MacOSNotificationCenterPrivate();
26		MacOSNotificationCenterDelegate *m_delegate;
27		static MacOSNotificationCenterPrivate *m_instance;
28		};
29
	broulikUnsubmitted Done If possible use `Q_FORWARD_DECLARE_OBJC_CLASS` to forward-declare the type instead of using generic `id` broulik: If possible use `Q_FORWARD_DECLARE_OBJC_CLASS` to forward-declare the type instead of using…
30		@interface MacOSNotificationCenterDelegate : NSObject<NSUserNotificationCenterDelegate> {}
31		@end
	broulikUnsubmitted Done Initialize right here `= 0;` or in the constructor initializer list, not the constructor body broulik: Initialize right here `= 0;` or in the constructor initializer list, not the constructor body
32
33		@implementation MacOSNotificationCenterDelegate
34		- (BOOL)userNotificationCenter:(NSUserNotificationCenter )center shouldPresentNotification:(NSUserNotification )notification
35		{
	broulikUnsubmitted Done Don't do global statics in a library, e.g. use `Q_GLOBAL_STATIC` or on-demand initialization / refcounting broulik: Don't do global statics in a library, e.g. use `Q_GLOBAL_STATIC` or on-demand initialization /…
36		Q_UNUSED(center);
37		Q_UNUSED(notification);
38		return YES;
39		}
40
41		- (void)userNotificationCenter:(NSUserNotificationCenter )center didDeliverNotification:(NSUserNotification )notification
42		{
43		Q_UNUSED(center);
44		Q_UNUSED(notification);
45		qCDebug(LOG_KNOTIFICATIONS) << "Send notification " << [notification.userInfo[@"id"] intValue];
46		}
47
48		- (void) userNotificationCenter:(NSUserNotificationCenter )center didActivateNotification:(NSUserNotification )notification
49		{
50		Q_UNUSED(center);
51		qCDebug(LOG_KNOTIFICATIONS) << "User clicked on notification "
52		<< [notification.userInfo[@"id"] intValue]
53		<< ", internal Id: "
	broulikUnsubmitted Done Just declare this down in the switch below, you will have to wrap it in `{}` to avoid the jump to case label error broulik: Just declare this down in the switch below, you will have to wrap it in `{}` to avoid the jump…
54		<< [notification.userInfo[@"internalId"] intValue];
55
56		switch (notification.activationType) {
57		case NSUserNotificationActivationTypeReplied:
58		qCDebug(LOG_KNOTIFICATIONS) << "Replied clicked";
59		break;
60		case NSUserNotificationActivationTypeContentsClicked: {
61		qCDebug(LOG_KNOTIFICATIONS) << "Content clicked";
62		KNotification *originNotification = MacOSNotificationCenterPrivate::instance()->m_notifications.value([notification.userInfo[@"internalId"] intValue]);
	broulikUnsubmitted Done We have a "default action" concept now where clicking the popup itself triggers, is this for that? broulik: We have a "default action" concept now where clicking the popup itself triggers, is this for…
	InokiAuthorUnsubmitted Done It could be. But seems that not all app provides defaultAction, so I do a check first Inoki: It could be. But seems that not all app provides defaultAction, so I do a check first
63		if (!originNotification \|\| originNotification->defaultAction().isNull()) {
64		break;
65		}
66		emit originNotification->activate();
67		}
68		break;
69		case NSUserNotificationActivationTypeActionButtonClicked: {
70		qCDebug(LOG_KNOTIFICATIONS) << "Main action clicked";
71		KNotification *originNotification = MacOSNotificationCenterPrivate::instance()->m_notifications.value([notification.userInfo[@"internalId"] intValue]);
	broulikUnsubmitted Done Coding style if (!originNotification) { break; } broulik: Coding style ``` if (!originNotification) { break; } ```
72		if (!originNotification) {
73		break;
74		}
75		emit originNotification->activate(1);
76		}
77		break;
78		case NSUserNotificationActivationTypeAdditionalActionClicked: {
79		qCDebug(LOG_KNOTIFICATIONS) << "Additional action clicked";
80		KNotification *originNotification = MacOSNotificationCenterPrivate::instance()->m_notifications.value([notification.userInfo[@"internalId"] intValue]);
81		if (!originNotification) {
82		break;
83		}
84		emit originNotification->activate([notification.additionalActivationAction.identifier intValue] + 1);
85		}
86		break;
87		default:
88		qCDebug(LOG_KNOTIFICATIONS) << "Other clicked";
89		break;
90		}
91		}
92		@end
93
94		MacOSNotificationCenterPrivate *MacOSNotificationCenterPrivate::m_instance = nullptr;
95
96		MacOSNotificationCenterPrivate::MacOSNotificationCenterPrivate()
97		: m_internalCounter(0)
	broulikUnsubmitted Done Don't call `values()` just to iterate it, use iterators, `for (auto it = m_notifications.constBegin(), ...)` broulik: Don't call `values()` just to iterate it, use iterators, `for (auto it = m_notifications.
98		{
99		// Set delegate
100		m_delegate = [MacOSNotificationCenterDelegate alloc];
101		[[NSUserNotificationCenter defaultUserNotificationCenter] setDelegate:m_delegate];
102		}
103
104		MacOSNotificationCenterPrivate::~MacOSNotificationCenterPrivate()
105		{
106		[[NSUserNotificationCenter defaultUserNotificationCenter] setDelegate: nil];
107		[m_delegate release];
108
109		// Try to finish all KNotification
110		for (auto it = m_notifications.constBegin(); it != m_notifications.constEnd(); it++) {
111		it.value()->deref();
	broulikUnsubmitted Done Coding style: if (!notification) { return; } broulik: Coding style: ``` if (!notification) { return; } ```
112		}
113
114		// Try to finish all NSNotification
115		NSArray<NSUserNotification > deliveredNotifications = [NSUserNotificationCenter defaultUserNotificationCenter].deliveredNotifications;
116		for (NSUserNotification *deliveredNotification in deliveredNotifications) {
117		// Remove NSNotification in notification center
118		[[NSUserNotificationCenter defaultUserNotificationCenter] removeDeliveredNotification: deliveredNotification];
	broulikUnsubmitted Done Avoid using `operator[]` unless you're assigning something broulik: Avoid using `operator[]` unless you're assigning something
119		}
120		}
121
122		MacOSNotificationCenterPrivate *MacOSNotificationCenterPrivate::instance() {
123		if (!m_instance) {
124		m_instance = new MacOSNotificationCenterPrivate();
125		}
126		return m_instance;
127		}
128
129
130		NotifyByMacOSNotificationCenter::NotifyByMacOSNotificationCenter(QObject* parent)
131		: KNotificationPlugin(parent)
132		{
133		// Clear notifications
134		NSArray<NSUserNotification > deliveredNotifications = [NSUserNotificationCenter defaultUserNotificationCenter].deliveredNotifications;
135		for (NSUserNotification *deliveredNotification in deliveredNotifications) {
136		// Remove NSNotification in notification center
137		[[NSUserNotificationCenter defaultUserNotificationCenter] removeDeliveredNotification: deliveredNotification];
138		}
139		}
	broulikUnsubmitted Done Why in the constructor? broulik: Why in the constructor?
	InokiAuthorUnsubmitted Done To clear previously delivered notifications Inoki: To clear previously delivered notifications
140
141		NotifyByMacOSNotificationCenter::~NotifyByMacOSNotificationCenter() {}
142
143		void NotifyByMacOSNotificationCenter::notify(KNotification notification, KNotifyConfig config)
144		{
145		Q_UNUSED(config);
146
	broulikUnsubmitted Done Are all of these debug messages neccessary? broulik: Are all of these debug messages neccessary?
147		int internalId = MacOSNotificationCenterPrivate::instance()->m_internalCounter++;
148		NSUserNotification *osxNotification = [[[NSUserNotification alloc] init] autorelease];
149		NSString *notificationId = [NSString stringWithFormat: @"%d", notification->id()];
150		NSString *internalNotificationId = [NSString stringWithFormat: @"%d", internalId];
151		NSString *title = notification->title().toNSString();
152		NSString *text = notification->text().toNSString();
153
154		osxNotification.title = title;
155		osxNotification.userInfo = [NSDictionary dictionaryWithObjectsAndKeys: notificationId, @"id",
156		internalNotificationId, @"internalId", nil];
157		osxNotification.informativeText = text;
158
159		if (notification->pixmap().isNull()) {
160		QIcon notificationIcon = QIcon::fromTheme(notification->iconName());
	broulikUnsubmitted Done Coding style: One variable per line NSString ..; NSString ...; same below broulik: Coding style: One variable per line ``` NSString ..; NSString ...; ``` same below
161		if (!notificationIcon.isNull()) {
162		osxNotification.contentImage = QtMac::toNSImage(notificationIcon.pixmap(QSize(64, 64)));
163		}
	broulikUnsubmitted Done Why not just `toNSString()`, given you convert it below anyway? Or is that ObjC awful ownership model quirk? broulik: Why not just `toNSString()`, given you convert it below anyway? Or is that ObjC awful ownership…
164		} else {
165		osxNotification.contentImage = QtMac::toNSImage(notification->pixmap());
166		}
167
168		if (notification->actions().isEmpty()) {
169		// Remove all buttons
170		osxNotification.hasReplyButton = false;
	broulikUnsubmitted Done A notification doesn't neccessarily have a `pixmap()` but could just be an `iconName()` where you need `QIcon::fromTheme()` broulik: A notification doesn't neccessarily have a `pixmap()` but could just be an `iconName()` where…
	InokiAuthorUnsubmitted Done KDE Connect does set icon by pixmap, any idea how should we treat these? Inoki: KDE Connect does set icon by pixmap, any idea how should we treat these?
	broulikUnsubmitted Done Check for `pixmap().isNull()` and use `iconName()` then broulik: Check for `pixmap().isNull()` and use `iconName()` then
171		osxNotification.hasActionButton = false;
172		} else {
173		osxNotification.hasActionButton = true;
174		// Workaround: this "API" will cause refuse from Apple
175		// [osxNotification setValue:[NSNumber numberWithBool:YES] forKey: @"_alwaysShowAlternateActionMenu"];
176
177		// Assign first action to action button
178		if (notification->actions().length() > 0) {
179		osxNotification.actionButtonTitle = notification->actions().at(0).toNSString();
180		}
181
182		// Construct a list for all actions left for additional buttons
183		NSMutableArray<NSUserNotificationAction> actions = [[NSMutableArray alloc] init];
184		for (int index = 1; index < notification->actions().length(); index++) {
185		NSUserNotificationAction *action =
186		[NSUserNotificationAction actionWithIdentifier: [NSString stringWithFormat:@"%d", index]
187		title: notification->actions().at(index).toNSString()];
188		[actions addObject: action];
189		}
190		osxNotification.additionalActions = actions;
191		}
192
193		[[NSUserNotificationCenter defaultUserNotificationCenter] deliverNotification: osxNotification];
194
195		MacOSNotificationCenterPrivate::instance()->m_notifications.insert(internalId, notification);
196		}
197
198		void NotifyByMacOSNotificationCenter::close(KNotification *notification)
199		{
200		qCDebug(LOG_KNOTIFICATIONS) << "Remove notification " << notification->id();
201
202		NSArray<NSUserNotification > deliveredNotifications = [NSUserNotificationCenter defaultUserNotificationCenter].deliveredNotifications;
203		for (NSUserNotification *deliveredNotification in deliveredNotifications) {
204		if ([deliveredNotification.userInfo[@"id"] intValue] == notification->id()) {
205		// Remove KNotification in mapping
206		int internalId = [deliveredNotification.userInfo[@"id"] intValue];
207
208		MacOSNotificationCenterPrivate::instance()->m_notifications.remove(internalId);
209
210		// Remove NSNotification in notification center
211		[[NSUserNotificationCenter defaultUserNotificationCenter] removeDeliveredNotification: deliveredNotification];
212		finish(notification);
213		return;
214		}
215		}
216		qCDebug(LOG_KNOTIFICATIONS) << "Notification " << notification->id() << " not found";
217		finish(notification);
218		}
219
220		void NotifyByMacOSNotificationCenter::update(KNotification notification, KNotifyConfig config)
221		{
222		close(notification);
	broulikUnsubmitted Not Done Is there no way to transparently update a notification? broulik: Is there no way to transparently update a notification?
	InokiAuthorUnsubmitted Not Done Could have one in UserNotifications framework but not NotificationCenter framework. UserNotifications framework requires macOS 10.14+ So maybe later Inoki: Could have one in UserNotifications framework but not NotificationCenter framework.
223		notify(notification, config);
224		}