mac: add display realtime status (ui)

Related: #1064.

src/config/config.cpp

@@ -77,6 +77,10 @@ bool ReadConfig() {
   }
   config_impl->Read("tls13_early_data", &FLAGS_tls13_early_data);
 
+#if BUILDFLAG(IS_MAC)
+  config_impl->Read("ui_display_realtime_status", &FLAGS_ui_display_realtime_status);
+#endif
+
   /* close fields */
   config_impl->Close();
 
@@ -145,6 +149,10 @@ bool SaveConfig() {
   }
   all_fields_written &= config_impl->Write("tls13_early_data", FLAGS_tls13_early_data);
 
+#if BUILDFLAG(IS_MAC)
+  all_fields_written &= config_impl->Write("ui_display_realtime_status", FLAGS_ui_display_realtime_status);
+#endif
+
   all_fields_written &= config_impl->Close();
 
   return all_fields_written;

src/config/config_core.cpp

@@ -148,3 +148,7 @@ ABSL_FLAG(CipherMethodFlag, method, CipherMethodFlag(CRYPTO_DEFAULT), kCipherMet
 
 ABSL_FLAG(uint32_t, parallel_max, 512, "Maximum concurrency for parallel connections");
 ABSL_FLAG(RateFlag, limit_rate, RateFlag(0), "Limit transfer speed to RATE");
+
+#if BUILDFLAG(IS_MAC)
+ABSL_FLAG(bool, ui_display_realtime_status, true, "Display Realtime Status in Status Bar (UI)");
+#endif

src/config/config_core.hpp

@@ -6,6 +6,7 @@
 
 #include <absl/flags/declare.h>
 #include <absl/strings/string_view.h>
+#include <base/compiler_specific.h>
 #include <stdint.h>
 #include <string>
 #include <string_view>
@@ -36,4 +37,8 @@ bool AbslParseFlag(absl::string_view text, RateFlag* flag, std::string* err);
 
 std::string AbslUnparseFlag(const RateFlag&);
 
+#if BUILDFLAG(IS_MAC)
+ABSL_DECLARE_FLAG(bool, ui_display_realtime_status);
+#endif
+
 #endif  // H_CONFIG_CONFIG_CORE

src/mac/YassAppDelegate.h

@@ -8,12 +8,11 @@
 
 enum YASSState { STOPPED, STARTED, STARTING, START_FAILED, STOPPING };
 
-@class YassViewController;
 @interface YassAppDelegate : NSObject <NSApplicationDelegate>
 - (enum YASSState)getState;
 - (NSString*)getStatus;
-- (void)OnStart:(YassViewController*)viewController;
-- (void)OnStop:(YassViewController*)viewController withOption:(BOOL)quiet;
+- (void)OnStart;
+- (void)OnStop:(BOOL)quiet;
 
 @end
 

src/mac/YassAppDelegate.mm

@@ -22,7 +22,7 @@
 #include "version.h"
 
 @interface YassAppDelegate ()
-- (std::string)SaveConfig:(YassViewController*)viewController;
+- (std::string)SaveConfig;
 - (void)OnStarted;
 - (void)OnStartFailed:(std::string)error_msg;
 - (void)OnStopped;
@@ -44,7 +44,7 @@ - (void)applicationDidFinishLaunching:(NSNotification*)aNotification {
 
 - (void)applicationWillTerminate:(NSNotification*)aNotification {
   LOG(WARNING) << "Application exiting";
-  [self OnStop:nil withOption:TRUE];
+  [self OnStop:TRUE];
 }
 
 - (BOOL)applicationSupportsSecureRestorableState:(NSApplication*)app {
@@ -116,9 +116,9 @@ - (NSString*)getStatus {
   return SysUTF8ToNSString(ss.str());
 }
 
-- (void)OnStart:(YassViewController*)viewController {
+- (void)OnStart {
   state_ = STARTING;
-  auto err_msg = [self SaveConfig:viewController];
+  auto err_msg = [self SaveConfig];
   if (!err_msg.empty()) {
     [self OnStartFailed:err_msg];
     return;
@@ -147,7 +147,7 @@ - (void)OnStart:(YassViewController*)viewController {
   worker_.Start(std::move(callback));
 }
 
-- (void)OnStop:(YassViewController*)viewController withOption:(BOOL)quiet {
+- (void)OnStop:(BOOL)quiet {
   state_ = STOPPING;
 
   absl::AnyInvocable<void()> callback;
@@ -165,17 +165,15 @@ - (void)OnStarted {
   state_ = STARTED;
   config::SaveConfig();
 
-  YassWindowController* windowController =
-      (YassWindowController*)NSApplication.sharedApplication.mainWindow.windowController;
+  YassWindowController* windowController = [YassWindowController instance];
   [windowController Started];
 }
 
 - (void)OnStartFailed:(std::string)error_msg {
   state_ = START_FAILED;
 
   error_msg_ = error_msg;
-  YassWindowController* windowController =
-      (YassWindowController*)NSApplication.sharedApplication.mainWindow.windowController;
+  YassWindowController* windowController = [YassWindowController instance];
   [windowController StartFailed];
   NSAlert* alert = [[NSAlert alloc] init];
   alert.messageText = @(error_msg.c_str());
@@ -186,12 +184,13 @@ - (void)OnStartFailed:(std::string)error_msg {
 
 - (void)OnStopped {
   state_ = STOPPED;
-  YassWindowController* windowController =
-      (YassWindowController*)NSApplication.sharedApplication.mainWindow.windowController;
+  YassWindowController* windowController = [YassWindowController instance];
   [windowController Stopped];
 }
 
-- (std::string)SaveConfig:(YassViewController*)viewController {
+- (std::string)SaveConfig {
+  YassViewController* viewController = [YassViewController instance];
+
   auto server_host = SysNSStringToUTF8(viewController.serverHost.stringValue);
   auto server_sni = SysNSStringToUTF8(viewController.serverSNI.stringValue);
   auto server_port = SysNSStringToUTF8(viewController.serverPort.stringValue);

src/mac/YassViewController.h

@@ -28,6 +28,9 @@
 @property(weak) IBOutlet NSTextField* timeout;
 @property(weak) IBOutlet NSButton* autoStart;
 @property(weak) IBOutlet NSButton* systemProxy;
+@property(weak) IBOutlet NSButton* displayStatus;
+
++ (YassViewController* __weak)instance;
 @end
 
 #endif  // YASS_MAC_VIEW_CONTROLLER

src/mac/YassViewController.mm

@@ -17,15 +17,22 @@
 #include "mac/YassWindowController.h"
 #include "mac/utils.h"
 
+static YassViewController* __weak _instance;
+
 @interface YassViewController ()
 @end
 
 @implementation YassViewController {
   bool should_startup_at_app_load;
 }
 
++ (YassViewController* __weak)instance {
+  return _instance;
+}
+
 - (void)viewDidLoad {
   [super viewDidLoad];
+  _instance = self;
 
   [self.cipherMethod removeAllItems];
   NSString* methodStrings[] = {
@@ -101,6 +108,12 @@ - (IBAction)OnSystemProxyChecked:(id)sender {
   });
 }
 
+- (IBAction)OnDisplayStatusClicked:(id)sender {
+  YassWindowController* windowController = [YassWindowController instance];
+  bool enable = self.displayStatus.state == NSControlStateValueOn;
+  [windowController toggleDisplayStatus:enable];
+}
+
 - (void)OnStart {
   [self.startButton setEnabled:FALSE];
   [self.stopButton setEnabled:FALSE];
@@ -118,16 +131,16 @@ - (void)OnStart {
   [self.limitRate setEnabled:FALSE];
   [self.timeout setEnabled:FALSE];
 
-  YassWindowController* windowController = (YassWindowController*)self.view.window.windowController;
-  [windowController OnStart:self];
+  YassWindowController* windowController = [YassWindowController instance];
+  [windowController OnStart];
 }
 
 - (void)OnStop {
   [self.startButton setEnabled:FALSE];
   [self.stopButton setEnabled:FALSE];
 
-  YassWindowController* windowController = (YassWindowController*)self.view.window.windowController;
-  [windowController OnStop:self];
+  YassWindowController* windowController = [YassWindowController instance];
+  [windowController OnStop];
 }
 
 - (void)Started {
@@ -184,6 +197,9 @@ - (void)LoadChanges {
   self.dotHost.stringValue = SysUTF8ToNSString(absl::GetFlag(FLAGS_dot_host));
   self.limitRate.stringValue = SysUTF8ToNSString(std::string(absl::GetFlag(FLAGS_limit_rate)));
   self.timeout.intValue = absl::GetFlag(FLAGS_connect_timeout);
+
+  BOOL enable_status_bar = absl::GetFlag(FLAGS_ui_display_realtime_status) ? TRUE : FALSE;
+  self.displayStatus.state = enable_status_bar ? NSControlStateValueOn : NSControlStateValueOff;
 }
 
 @end

src/mac/YassWindowController.h

@@ -8,11 +8,14 @@
 
 @class YassViewController;
 @interface YassWindowController : NSWindowController <NSWindowDelegate>
-- (void)OnStart:(YassViewController*)viewController;
-- (void)OnStop:(YassViewController*)viewController;
+- (void)OnStart;
+- (void)OnStop;
 - (void)Started;
 - (void)StartFailed;
 - (void)Stopped;
+- (void)toggleDisplayStatus:(BOOL)enable;
+
++ (YassWindowController* __weak)instance;
 @end
 
 #endif  // YASS_MAC_WINDOW_CONTROLLER

src/mac/YassWindowController.mm

@@ -17,7 +17,10 @@
 #import "mac/YassViewController.h"
 #include "mac/utils.h"
 
+static YassWindowController* __weak _instance;
+
 @interface YassWindowController ()
+- (void)toggleDisplayStatusInternal:(BOOL)enable;
 @end
 
 @implementation YassWindowController {
@@ -33,8 +36,14 @@ @implementation YassWindowController {
   BOOL hide_on_closed_;
 }
 
++ (YassWindowController* __weak)instance {
+  return _instance;
+}
+
 - (void)windowDidLoad {
   [super windowDidLoad];
+  _instance = self;
+
   [self refreshTimerExceeded];
 
   y_status_bar_item_ = [[NSStatusBar systemStatusBar] statusItemWithLength:NSSquareStatusItemLength];
@@ -45,7 +54,8 @@ - (void)windowDidLoad {
   [y_status_bar_item_.button
       sendActionOn:NSEventMaskLeftMouseDown | NSEventMaskRightMouseDown | NSEventMaskOtherMouseDown];
 
-  status_bar_item_ = [[NSStatusBar systemStatusBar] statusItemWithLength:NSVariableStatusItemLength];
+  BOOL enable_status_bar = absl::GetFlag(FLAGS_ui_display_realtime_status) ? TRUE : FALSE;
+  [self toggleDisplayStatusInternal:enable_status_bar];
 
   hide_on_closed_ = FALSE;
 }
@@ -77,6 +87,10 @@ - (void)statusItemClicked {
 }
 
 - (void)UpdateStatusBar {
+  if (status_bar_item_ == nil) {
+    status_bar_text_ = nil;
+    return;
+  }
   NSString* next_status_bar_text = [self getStatusMessage];
   // prevent deep copy on unchanged title
   if ([next_status_bar_text isEqualToString:status_bar_text_]) {
@@ -131,33 +145,49 @@ - (void)refreshTimerExceeded {
                                                    repeats:NO];
 }
 
-- (void)OnStart:(YassViewController*)viewController {
+- (void)OnStart {
   YassAppDelegate* appDelegate = (YassAppDelegate*)NSApplication.sharedApplication.delegate;
 
-  [appDelegate OnStart:viewController];
+  [appDelegate OnStart];
 }
 
-- (void)OnStop:(YassViewController*)viewController {
+- (void)OnStop {
   YassAppDelegate* appDelegate = (YassAppDelegate*)NSApplication.sharedApplication.delegate;
-  [appDelegate OnStop:viewController withOption:FALSE];
+  [appDelegate OnStop:FALSE];
 }
 
 - (void)Started {
   [self UpdateStatusBar];
-  YassViewController* viewController = (YassViewController*)self.contentViewController;
+  YassViewController* viewController = [YassViewController instance];
   [viewController Started];
 }
 
 - (void)StartFailed {
   [self UpdateStatusBar];
-  YassViewController* viewController = (YassViewController*)self.contentViewController;
+  YassViewController* viewController = [YassViewController instance];
   [viewController StartFailed];
 }
 
 - (void)Stopped {
   [self UpdateStatusBar];
-  YassViewController* viewController = (YassViewController*)self.contentViewController;
+  YassViewController* viewController = [YassViewController instance];
   [viewController Stopped];
 }
 
+- (void)toggleDisplayStatus:(BOOL)enable {
+  [self toggleDisplayStatusInternal:enable];
+  absl::SetFlag(&FLAGS_ui_display_realtime_status, (enable == TRUE ? true : false));
+  config::SaveConfig();
+}
+
+- (void)toggleDisplayStatusInternal:(BOOL)enable {
+  if (enable && status_bar_item_ == nil) {
+    status_bar_item_ = [[NSStatusBar systemStatusBar] statusItemWithLength:NSVariableStatusItemLength];
+    [self UpdateStatusBar];
+  } else if (enable == FALSE && status_bar_item_ != nil) {
+    status_bar_item_ = nil;
+    status_bar_text_ = nil;
+  }
+}
+
 @end

src/mac/en.lproj/Main.strings

@@ -102,3 +102,7 @@
 "zY6-tD-aUd.title" = "Timeout";
 
 "bxG-gg-LTc.title" = "Server SNI";
+
+"mw5-nB-ary.title" = "Display Realtime Status";
+
+"71A-aG-Rt6.title" = "Enable";

src/mac/zh-Hans.lproj/Main.strings

@@ -102,3 +102,7 @@
 "zY6-tD-aUd.title" = "超时时间";
 
 "bxG-gg-LTc.title" = "服务器名称指示";
+
+"mw5-nB-ary.title" = "显示实时状态";
+
+"71A-aG-Rt6.title" = "启用";