Merge pull request #164 from newmarcel/v1.6.1/user-notifications

Added Support for User Notifications

CHANGELOG.md

@@ -4,6 +4,9 @@
 
 ### v1.6.1 ###
 
+- added support for notifications, use `System Preferences` to manage notification settings ([#164](https://github.com/newmarcel/KeepingYouAwake/pull/164))
+  - please note, this feature is only available on macOS 11 or newer; the previous experimental notifications support has been removed
+
 ### v1.6.0 ###
 
 - raised minimum deployment target to macOS Sierra ([#142](https://github.com/newmarcel/KeepingYouAwake/pull/142))

KYAKit/Extensions/NSDate+RemainingTime.m

@@ -27,14 +27,16 @@ - (NSDateComponentsFormatter *)dateComponentsFormatter
 
 - (NSString *)kya_localizedRemainingTime
 {
-    return [[self dateComponentsFormatter] stringFromDate:[NSDate date] toDate:self];
+    Auto startDate = [NSDate dateWithTimeIntervalSinceNow:-1];
+    return [[self dateComponentsFormatter] stringFromDate:startDate toDate:self];
 }
 
 - (NSString *)kya_localizedRemainingTimeWithoutPhrase
 {
     Auto formatter = [self dateComponentsFormatter];
     formatter.includesTimeRemainingPhrase = NO;
-    Auto remainingTimeString = [formatter stringFromDate:[NSDate date] toDate:self];
+    Auto startDate = [NSDate dateWithTimeIntervalSinceNow:-1];
+    Auto remainingTimeString = [formatter stringFromDate:startDate toDate:self];
     formatter.includesTimeRemainingPhrase = YES;
 
     return remainingTimeString;

KYAKit/Extensions/NSUserDefaults+Keys.h

@@ -12,7 +12,6 @@ NS_ASSUME_NONNULL_BEGIN
 
 // User Default Keys
 FOUNDATION_EXPORT NSString * const KYAUserDefaultsKeyActivateOnLaunch;
-FOUNDATION_EXPORT NSString * const KYAUserDefaultsKeyNotificationsEnabled;
 FOUNDATION_EXPORT NSString * const KYAUserDefaultsKeyDefaultTimeInterval;
 FOUNDATION_EXPORT NSString * const KYAUserDefaultsKeyAllowDisplaySleep;
 FOUNDATION_EXPORT NSString * const KYAUserDefaultsKeyMenuBarIconHighlightDisabled;
@@ -28,11 +27,6 @@ FOUNDATION_EXPORT NSString * const KYAUserDefaultsKeyPreReleaseUpdatesEnabled;
  */
 @property (nonatomic, getter = kya_isActivatedOnLaunch) BOOL kya_activateOnLaunch;
 
-/**
- Returns YES if user notifications should be displayed.
- */
-@property (nonatomic, getter = kya_areNotificationsEnabled) BOOL kya_notificationsEnabled;
-
 /**
  Returns the default time interval for the sleep wake timer.
  */

KYAKit/Extensions/NSUserDefaults+Keys.m

@@ -11,7 +11,6 @@
 
 // User Default Keys
 NSString * const KYAUserDefaultsKeyActivateOnLaunch = @"info.marcel-dierkes.KeepingYouAwake.ActivateOnLaunch";
-NSString * const KYAUserDefaultsKeyNotificationsEnabled = @"info.marcel-dierkes.KeepingYouAwake.NotificationsEnabled";
 NSString * const KYAUserDefaultsKeyDefaultTimeInterval = @"info.marcel-dierkes.KeepingYouAwake.TimeInterval";
 NSString * const KYAUserDefaultsKeyAllowDisplaySleep = @"info.marcel-dierkes.KeepingYouAwake.AllowDisplaySleep";
 NSString * const KYAUserDefaultsKeyMenuBarIconHighlightDisabled = @"info.marcel-dierkes.KeepingYouAwake.MenuBarIconHighlightDisabled";
@@ -22,7 +21,7 @@
 NSString * const KYAUserDefaultsKeyPreReleaseUpdatesEnabled = @"info.marcel-dierkes.KeepingYouAwake.PreReleaseUpdatesEnabled";
 
 @implementation NSUserDefaults (Keys)
-@dynamic kya_activateOnLaunch, kya_defaultTimeInterval, kya_notificationsEnabled;
+@dynamic kya_activateOnLaunch, kya_defaultTimeInterval;
 @dynamic kya_allowDisplaySleep;
 @dynamic kya_menuBarIconHighlightDisabled;
 @dynamic kya_batteryCapacityThresholdEnabled, kya_batteryCapacityThreshold;
@@ -41,18 +40,6 @@ - (void)setKya_activateOnLaunch:(BOOL)activateOnLaunch
     [self setBool:activateOnLaunch forKey:KYAUserDefaultsKeyActivateOnLaunch];
 }
 
-#pragma mark - Notifications Enabled
-
-- (BOOL)kya_areNotificationsEnabled
-{
-    return [self boolForKey:KYAUserDefaultsKeyNotificationsEnabled];
-}
-
-- (void)setKya_notificationsEnabled:(BOOL)notificationsEnabled
-{
-    [self setBool:notificationsEnabled forKey:KYAUserDefaultsKeyNotificationsEnabled];
-}
-
 #pragma mark - Default Time Interval
 
 - (NSTimeInterval)kya_defaultTimeInterval

KYAKit/KYAKit.h

@@ -20,9 +20,12 @@ FOUNDATION_EXPORT const unsigned char KYAKitVersionString[];
 #import <KYAKit/KYAEvent.h>
 #import <KYAKit/KYAEventHandler.h>
 #import <KYAKit/KYASleepWakeTimer.h>
+#import <KYAKit/KYAUserNotificationCenter.h>
 
 #import <KYAKit/NSApplication+KYALauncher.h>
 #import <KYAKit/NSBundle+KYAUpdateFeed.h>
 #import <KYAKit/NSBundle+KYAVersion.h>
 #import <KYAKit/NSDate+RemainingTime.h>
 #import <KYAKit/NSUserDefaults+Keys.h>
+#import <KYAKit/NSURL+KYAUserNotificationCenter.h>
+#import <KYAKit/NSWorkspace+KYAUserNotificationCenter.h>

KYAKit/KYAUserNotificationCenter/Extensions/NSURL+KYAUserNotificationCenter.h

@@ -0,0 +1,16 @@
+//
+//  NSURL+KYAUserNotificationCenter.h
+//  KYAKit
+//
+//  Created by Marcel Dierkes on 20.02.21.
+//
+
+#import <Foundation/Foundation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface NSURL (KYAUserNotificationCenter)
+@property (class, nonatomic, readonly) NSURL *kya_notificationPreferencesURL;
+@end
+
+NS_ASSUME_NONNULL_END

KYAKit/KYAUserNotificationCenter/Extensions/NSURL+KYAUserNotificationCenter.m

@@ -0,0 +1,18 @@
+//
+//  NSURL+KYAUserNotificationCenter.m
+//  KYAKit
+//
+//  Created by Marcel Dierkes on 20.02.21.
+//
+
+#import "NSURL+KYAUserNotificationCenter.h"
+#import "KYADefines.h"
+
+@implementation NSURL (KYAUserNotificationCenter)
+
++ (NSURL *)kya_notificationPreferencesURL
+{
+    return [self URLWithString:@"x-apple.systempreferences:com.apple.preference.notifications"];
+}
+
+@end

KYAKit/KYAUserNotificationCenter/Extensions/NSWorkspace+KYAUserNotificationCenter.h

@@ -0,0 +1,23 @@
+//
+//  NSWorkspace+KYAUserNotificationCenter.h
+//  KYAKit
+//
+//  Created by Marcel Dierkes on 20.02.21.
+//
+
+#import <Cocoa/Cocoa.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+typedef void(^KYAOpenNotificationsCompletionHandler)(NSRunningApplication *_Nullable,
+                                                     NSError *_Nullable);
+
+@interface NSWorkspace (KYAUserNotificationCenter)
+
+/// Opens the notifications pane in System Preferences.
+/// @param completionHandler An optional completion handler, called on a private queue
+- (void)kya_openNotificationPreferencesWithCompletionHandler:(nullable KYAOpenNotificationsCompletionHandler)completionHandler API_AVAILABLE(macos(11.0));
+
+@end
+
+NS_ASSUME_NONNULL_END

KYAKit/KYAUserNotificationCenter/Extensions/NSWorkspace+KYAUserNotificationCenter.m

@@ -0,0 +1,30 @@
+//
+//  NSWorkspace+KYAUserNotificationCenter.m
+//  KYAKit
+//
+//  Created by Marcel Dierkes on 20.02.21.
+//
+
+#import "NSWorkspace+KYAUserNotificationCenter.h"
+#import "KYADefines.h"
+#import "NSURL+KYAUserNotificationCenter.h"
+
+@implementation NSWorkspace (KYAUserNotificationCenter)
+
+- (void)kya_openNotificationPreferencesWithCompletionHandler:(KYAOpenNotificationsCompletionHandler)completionHandler
+{
+    Auto prefURL = NSURL.kya_notificationPreferencesURL;
+    Auto config = [NSWorkspaceOpenConfiguration configuration];
+    config.addsToRecentItems = NO;
+
+    [self openApplicationAtURL:prefURL
+                 configuration:config
+             completionHandler:^(NSRunningApplication *app, NSError *error) {
+        if(completionHandler != nil)
+        {
+            completionHandler(app, error);
+        }
+    }];
+}
+
+@end

KYAKit/KYAUserNotificationCenter/KYAUserNotificationCenter.h

@@ -0,0 +1,49 @@
+//
+//  KYAUserNotificationCenter.h
+//  KYAKit
+//
+//  Created by Marcel Dierkes on 13.02.21.
+//
+
+#import <Foundation/Foundation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+@class KYAUserNotification;
+
+typedef NS_ENUM(NSUInteger, KYAUserNotificationAuthorizationStatus) {
+    KYAUserNotificationAuthorizationStatusUndetermined = 0,
+    KYAUserNotificationAuthorizationStatusGranted,
+    KYAUserNotificationAuthorizationStatusDenied,
+};
+
+typedef void(^KYAUserNotificationsAuthorizationCompletion)(KYAUserNotificationAuthorizationStatus, NSError *_Nullable);
+
+API_AVAILABLE(macos(11.0))
+@interface KYAUserNotificationCenter : NSObject
+@property (class, nonatomic, readonly) KYAUserNotificationCenter *sharedCenter;
+
+- (void)getAuthorizationStatusWithCompletion:(void(NS_NOESCAPE ^)(KYAUserNotificationAuthorizationStatus))completion;
+- (void)requestAuthorizationWithCompletion:(nullable NS_NOESCAPE KYAUserNotificationsAuthorizationCompletion)completion;
+- (void)requestAuthorizationIfUndetermined;
+
+- (void)postNotification:(__kindof KYAUserNotification *)notification;
+- (void)clearAllDeliveredNotifications;
+
+@end
+
+API_AVAILABLE(macos(11.0))
+@interface KYAUserNotification : NSObject
+@property (copy, nonatomic) NSString *identifier;
+@property (copy, nonatomic, nullable) NSString *title; // use the localized setter instead
+@property (copy, nonatomic, nullable) NSString *subtitle; // use the localized setter instead
+@property (copy, nonatomic, nullable) NSString *bodyText; // use the localized setter instead
+@property (copy, nonatomic, nullable) NSDictionary *userInfo;
+
+- (void)setLocalizedTitleWithKey:(NSString *)key arguments:(nullable NSArray *)arguments;
+- (void)setLocalizedSubtitleWithKey:(NSString *)key arguments:(nullable NSArray *)arguments;
+- (void)setLocalizedBodyTextWithKey:(NSString *)key arguments:(nullable NSArray *)arguments;
+
+@end
+
+NS_ASSUME_NONNULL_END