-
Notifications
You must be signed in to change notification settings - Fork 137
/
AppDelegate.m
471 lines (394 loc) · 16 KB
/
AppDelegate.m
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
// This file is part of Scroll Reverser <https://pilotmoon.com/scrollreverser/>
// Licensed under Apache License v2.0 <http://www.apache.org/licenses/LICENSE-2.0>
#import "AppDelegate.h"
#import "StatusItemController.h"
#import "MouseTap.h"
#import "WelcomeWindowController.h"
#import "PrefsWindowController.h"
#import "DebugWindowController.h"
#import "TestWindowController.h"
#import "TapLogger.h"
NSString *const PrefsReverseScrolling=@"InvertScrollingOn";
NSString *const PrefsReverseHorizontal=@"ReverseX";
NSString *const PrefsReverseVertical=@"ReverseY";
NSString *const PrefsReverseTrackpad=@"ReverseTrackpad";
NSString *const PrefsReverseMouse=@"ReverseMouse";
NSString *const PrefsHasRunBefore=@"HasRunBefore";
NSString *const PrefsHideIcon=@"HideIcon";
NSString *const PrefsBetaUpdates=@"BetaUpdates";
NSString *const PrefsAppcastOverrideURL=@"AppcastOverrideURL";
NSString *const PrefsTerminatedWithPrefsWindowOpen=@"TerminatedWithPrefsWindowOpen";
NSString *const PrefsDiscreteScrollStepSize=@"DiscreteScrollStepSize";
NSString *const PrefsShowDiscreteScrollOptions=@"ShowDiscreteScrollOptions";
static void *_contextHideIcon=&_contextHideIcon;
static void *_contextEnabled=&_contextEnabled;
static void *_contextPermissions=&_contextPermissions;
@interface AppDelegate ()
@property MouseTap *tap;
@property StatusItemController *statusController;
@property WelcomeWindowController *welcomeWindowController;
@property PrefsWindowController *prefsWindowController;
@property DebugWindowController *debugWindowController;
@property TestWindowController *testWindowController;
@property PermissionsManager *permissionsManager;
@property LauncherController *launcherController;
@property TapLogger *logger;
@property SPUUpdater *updater;
@property SPUStandardUserDriver *updaterUserDriver;
@end
@implementation AppDelegate
// note that there is a third category of build, "Development" (see BuildScripts)
+ (NSString *)releaseChannel {
return [[NSBundle mainBundle] objectForInfoDictionaryKey:@"PilotmoonReleaseChannel"];
}
+ (BOOL)appIsProductionBuild {
return [[self releaseChannel] isEqualToString:@"Production"];
}
+ (BOOL)appIsBetaBuild {
return [[self releaseChannel] isEqualToString:@"Beta"];
}
#pragma mark Sparkle
+ (NSString *)sparkleFeedURLString
{
NSString *urlString=[[NSUserDefaults standardUserDefaults] stringForKey:PrefsAppcastOverrideURL];
if (!urlString) {
if([self appIsProductionBuild]||[self appIsBetaBuild])
{
urlString=@"https://softwareupdate.pilotmoon.com/update/scrollreverser/";
if ([[NSUserDefaults standardUserDefaults] boolForKey:PrefsBetaUpdates]) {
urlString=[urlString stringByAppendingString:@"appcast-beta.xml"];
}
else {
urlString=[urlString stringByAppendingString:@"appcast.xml"];
}
}
}
return urlString ? urlString : @"https://localhost/";
}
- (NSString *)feedURLStringForUpdater:(SPUUpdater *)updater
{
return [[self class] sparkleFeedURLString];
}
- (BOOL)updaterShouldPromptForPermissionToCheckForUpdates:(SPUUpdater *)bundle
{
return NO;
}
- (void)updater:(SPUUpdater *)updater didFinishLoadingAppcast:(SUAppcast *)appcast
{
NSLog(@"Loaded appcast.");
}
#pragma mark Launch, relaunch and termination
// There can be only one scroll reverser
+ (void)terminateOthers
{
NSRunningApplication *app=nil;
for (app in [[NSWorkspace sharedWorkspace] runningApplications]) {
if (![app isEqual:[NSRunningApplication currentApplication]]) {
if ([[app.bundleIdentifier lowercaseString] isEqualToString:[[NSRunningApplication currentApplication].bundleIdentifier lowercaseString]]) {
[app terminate];
}
}
}
}
/* Quickly and quietly quit and relaunch our own process. This is called on wake from sleep as a
workaround for a macOS bug whereby the OS stops calling our event taps after sleep.
*/
- (void)relaunch
{
[self logAppEvent:@"Scroll Reverser will relaunch"];
NSWorkspaceOpenConfiguration *config = [[NSWorkspaceOpenConfiguration alloc] init];
config.createsNewApplicationInstance = YES;
[[NSWorkspace sharedWorkspace] openApplicationAtURL:[NSBundle mainBundle].bundleURL
configuration:config
completionHandler:^(NSRunningApplication * _Nullable app, NSError * _Nullable error) {
if (app) {
NSLog(@"Launched new instance: %@", app);
}
if (error) {
NSLog(@"Error launching new instance: %@", error);
}
}];
}
- (void)handleURLEvent:(NSAppleEventDescriptor *)event withReplyEvent: (NSAppleEventDescriptor *)replyEvent
{
NSURL* url = [NSURL URLWithString:[[event paramDescriptorForKeyword:keyDirectObject] stringValue]];
NSLog(@"Handling URL: %@", url);
if ([[url scheme] isEqualToString:BUILDSCRIPTS_URL_SCHEME]) {
if ([[url host] isEqualToString:@"launch"]) {
NSLog(@"Launch via URL");
}
}
}
#pragma mark Inits
+ (void)initialize
{
if ([self class]==[AppDelegate class])
{
[[NSUserDefaults standardUserDefaults] registerDefaults:@{
PrefsReverseScrolling: @(NO),
PrefsReverseHorizontal: @(NO),
PrefsReverseVertical: @(YES),
PrefsReverseTrackpad: @(YES),
PrefsReverseMouse: @(YES),
PrefsDiscreteScrollStepSize: @(3),
LoggerMaxEntries: @(50000),
PrefsBetaUpdates: @([self appIsBetaBuild]),
}];
}
}
- (id)init
{
self=[super init];
if (self) {
[[self class] terminateOthers];
self.tap=[[MouseTap alloc] init];
self.launcherController=[[LauncherController alloc] init];
self.statusController=[[StatusItemController alloc] init];
self.statusController.statusItemDelegate=self;
self.statusController.visible=![[NSUserDefaults standardUserDefaults] boolForKey:PrefsHideIcon];
[[NSUserDefaults standardUserDefaults] addObserver:self forKeyPath:PrefsHideIcon options:0 context:_contextHideIcon];
self.permissionsManager=[[PermissionsManager alloc] init];
NSBundle *const hostBundle = [NSBundle mainBundle];
self.updaterUserDriver = [[SPUStandardUserDriver alloc] initWithHostBundle:hostBundle delegate:self];
self.updater = [[SPUUpdater alloc] initWithHostBundle:hostBundle applicationBundle:hostBundle userDriver:self.updaterUserDriver delegate:self];
NSError *error=nil;
if (![self.updater startUpdater:&error]) {
NSLog(@"Updater failed to start: %@", error);
}
else {
NSLog(@"Updater started");
}
// event handler for url events (for launching)
[[NSAppleEventManager sharedAppleEventManager] setEventHandler:self
andSelector:@selector(handleURLEvent:withReplyEvent:)
forEventClass:kInternetEventClass
andEventID:kAEGetURL];
}
return self;
}
- (void)dealloc {
[[[NSWorkspace sharedWorkspace] notificationCenter] removeObserver:self];
}
#pragma mark Application events
- (void)awakeFromNib {
[self.statusController attachMenu:self.statusMenu];
}
- (void)applicationDidFinishLaunching:(NSNotification *)aNotification
{
// Even though the app has no visible main menu, we set a minimal menu for keyboard shortcut support.
// For example, ⌘W to close the prefs window.
[NSApp setMainMenu:self.theMainMenu];
// Show the welcome window if the user hasn't run Scroll Reverser before.
const BOOL first=![[NSUserDefaults standardUserDefaults] boolForKey:PrefsHasRunBefore];
[[NSUserDefaults standardUserDefaults] setBool:YES forKey:PrefsHasRunBefore];
if(first) {
self.welcomeWindowController=[[WelcomeWindowController alloc] initWithWindowNibName:@"WelcomeWindow"];
[self.welcomeWindowController showWindow:self];
}
[[[NSWorkspace sharedWorkspace] notificationCenter] addObserver:self selector:@selector(appDidWake:) name:NSWorkspaceDidWakeNotification object:nil];
[[[NSWorkspace sharedWorkspace] notificationCenter] addObserver:self selector:@selector(appWillSleep:) name:NSWorkspaceWillSleepNotification object:nil];
// Observe permissions updates
[self.permissionsManager addObserver:self
forKeyPath:PermissionsManagerKeyHasAllRequiredPermissions
options:NSKeyValueObservingOptionInitial
context:_contextPermissions];
[self logAppEvent:@"Scroll Reverser started. Option-click the Scroll Reverser menu bar icon to show the debug console."];
// We don't bind `enabled` directly to prefs, because of the many dynamic interactions with the setting.
BOOL enabledInPrefs=[[NSUserDefaults standardUserDefaults] boolForKey:PrefsReverseScrolling];
[self addObserver:self forKeyPath:@"enabled" options:NSKeyValueObservingOptionInitial context:_contextEnabled];
self.enabled=enabledInPrefs;
if ([[NSUserDefaults standardUserDefaults] boolForKey:PrefsTerminatedWithPrefsWindowOpen]) {
[self showPrefs:self];
}
[[NSUserDefaults standardUserDefaults] setBool:NO forKey:PrefsTerminatedWithPrefsWindowOpen];
}
- (void)appDidWake:(NSNotification *)note
{
[self logAppEvent:@"OS woke from sleep - will relaunch"];
[self relaunch];
}
- (void)appWillSleep:(NSNotification *)note
{
[self logAppEvent:@"OS is going to sleep"];
}
- (void)applicationWillTerminate:(NSNotification *)notification
{
[self logAppEvent:@"Scroll Reverser will terminate"];
if (self.prefsWindowController.window.visible) {
[[NSUserDefaults standardUserDefaults] setBool:YES forKey:PrefsTerminatedWithPrefsWindowOpen];
}
}
- (BOOL)applicationShouldHandleReopen:(NSApplication *)theApplication hasVisibleWindows:(BOOL)flag
{
[self showPrefs:nil];
return NO;
}
- (BOOL)application:(NSApplication *)sender delegateHandlesKey:(NSString *)key // For Applescript handling
{
return [key isEqualToString:@"enabled"];
}
#pragma mark Logging
- (NSString *)settingsSummary
{
NSString *(^yn)(NSString *, BOOL) = ^(NSString *label, BOOL state) {
return [NSString stringWithFormat:@"[%@ %@]", label, state?@"yes":@"no"];
};
NSString *temp=yn(@"on", [[NSUserDefaults standardUserDefaults] boolForKey:PrefsReverseScrolling]);
temp=[temp stringByAppendingString:yn(@"v", [[NSUserDefaults standardUserDefaults] boolForKey:PrefsReverseVertical])];
temp=[temp stringByAppendingString:yn(@"h", [[NSUserDefaults standardUserDefaults] boolForKey:PrefsReverseHorizontal])];
temp=[temp stringByAppendingString:yn(@"trackpad", [[NSUserDefaults standardUserDefaults] boolForKey:PrefsReverseTrackpad])];
temp=[temp stringByAppendingString:yn(@"mouse", [[NSUserDefaults standardUserDefaults] boolForKey:PrefsReverseMouse])];
return temp;
}
- (Logger *)startLogging
{
if (!self.logger) {
self.logger=[[TapLogger alloc] init];
self.tap->logger=self.logger;
}
return self.logger;
}
- (void)logAppEvent:(NSString *)str
{
NSString *message=[NSString stringWithFormat:@"%@ %@", str, [self settingsSummary]];
NSLog(@"App event: %@", message);
[self.logger logMessage:message special:YES];
}
#pragma mark Showing windows
- (IBAction)showDebug:(id)sender
{
[NSApp activateIgnoringOtherApps:YES];
if(!self.debugWindowController) {
self.debugWindowController=[[DebugWindowController alloc] initWithWindowNibName:@"DebugWindow"];
self.debugWindowController.logger=[self startLogging];
}
[self.debugWindowController showWindow:self];
}
- (void)showPrefsWithDefaultPane:(BOOL)showDefault
{
[NSApp activateIgnoringOtherApps:YES];
if(!self.prefsWindowController) {
self.prefsWindowController=[[PrefsWindowController alloc] initWithWindowNibName:@"PrefsWindow"];
}
if (showDefault) {
[self.prefsWindowController showPermissionsPane];
}
[self.prefsWindowController showWindow:self];
}
- (IBAction)showPrefs:(id)sender
{
[self showPrefsWithDefaultPane:NO];
}
- (IBAction)showAbout:(id)sender
{
[self.prefsWindowController close];
[NSApp activateIgnoringOtherApps:YES];
NSDictionary *dict=@{@"ApplicationName": @"Scroll Reverser"};
[NSApp orderFrontStandardAboutPanelWithOptions:dict];
}
- (IBAction)showTestWindow:(id)sender
{
[NSApp activateIgnoringOtherApps:YES];
if(!self.testWindowController) {
self.testWindowController=[[TestWindowController alloc] initWithWindowNibName:@"TestWindow"];
}
[self.testWindowController showWindow:self];
}
#pragma mark Observer
- (void)observeValueForKeyPath:(NSString *)keyPath ofObject:(id)object change:(NSDictionary *)change context:(void *)context
{
if (context==_contextHideIcon) {
self.statusController.visible=![[NSUserDefaults standardUserDefaults] boolForKey:PrefsHideIcon];;
}
else if (context==_contextEnabled) {
self.statusController.enabled=self.enabled;
[[NSUserDefaults standardUserDefaults] setBool:self.enabled forKey:PrefsReverseScrolling];
}
else if (context==_contextPermissions) {
if(!self.permissionsManager.hasAllRequiredPermissions) {
self.enabled=NO;
}
}
}
#pragma mark Enable/disable
- (void)setEnabled:(BOOL)state
{
if (state==self.enabled) { // already in this state
return;
}
if ((!state) || self.permissionsManager.hasAllRequiredPermissions) {
[self logAppEvent:[NSString stringWithFormat:@"Setting enabled state to: %@", @(state)]];
self.tap.active=state;
}
else {
[self logAppEvent:@"Cannot enable Scroll Reverser; missing required permissions"];
}
// in case changing active state fails, force refresh of the triggering button
dispatch_after(dispatch_time(DISPATCH_TIME_NOW, (int64_t)(0.1 * NSEC_PER_SEC)), dispatch_get_main_queue(), ^{
[self willChangeValueForKey:@"enabled"];
[self didChangeValueForKey:@"enabled"];
if (state && (!self.enabled)) { // failed to enable
[self showPermissionsUI];
}
});
}
- (BOOL)isEnabled {
return self.tap.active;
}
+ (NSSet *)keyPathsForValuesAffectingEnabled {
return [NSSet setWithObject:@"tap.active"];
}
#pragma mark Status item handling
- (void)statusItemClicked {
// do nothing
}
- (void)statusItemRightClicked {
self.enabled=!self.enabled; // toggle
}
- (void)statusItemAltClicked {
[self showDebug:self];
}
#pragma mark Permissions
- (void)refreshPermissions {
[self.permissionsManager refresh];
}
- (void)showPermissionsUI {
[self showPrefsWithDefaultPane:YES];
}
#pragma mark Special
- (void)enableDiscreteScrollOptions
{
[[NSUserDefaultsController sharedUserDefaultsController] setValue:@YES forKeyPath:@"values.ShowDiscreteScrollOptions"];
}
#pragma mark App info strings
- (NSString *)appName {
return @"Scroll Reverser";
}
- (NSString *)appVersion {
return [NSString stringWithFormat:@"%@ (%@)",
[[NSBundle mainBundle] objectForInfoDictionaryKey:@"CFBundleShortVersionString"],
[[NSBundle mainBundle] objectForInfoDictionaryKey:@"CFBundleVersion"]];
}
- (NSString *)appCredit {
return @"by Nick Moore";
}
- (NSURL *)appLink {
return [NSURL URLWithString:@"https://pilotmoon.com/link/scrollreverser"];
}
- (NSString *)appDisplayLink {
return @"pilotmoon.com/scrollreverser";
}
- (NSURL *)appPermissionsHelpLink {
return [NSURL URLWithString:@"https://pilotmoon.com/link/scrollreverser/help/permissions"];
}
#pragma mark Other UI Strings
- (NSString *)menuStringReverseScrolling {
return [NSString stringWithFormat:NSLocalizedString(@"Enable %1$@", @"1=name of app e.g. `Enable Scroll Reverser`"), self.appName];
}
- (NSString *)menuStringPreferences {
return [NSLocalizedString(@"Preferences", nil) stringByAppendingString:@"..."];
}
- (NSString *)menuStringQuit {
return [NSString stringWithFormat:NSLocalizedString(@"Quit %1$@",@"1=name of app e.g. `Quit Scroll Reverser`"`), self.appName];
}
@end