System tray icon

wl2776 · wl2776 · commit f2b9ac1a0542 · 2025-02-11T18:45:12.000+03:00
Add code for creation of system tray icon, menu and handle menu events
System tray icon

- add code for creation of system tray icon, menu and handle menu events
- add option to preferences dialog
- add a kind of a single instance mode: only first launched instance creates system tray icon and does not quit
diff --git a/src/App.Commands.cs b/src/App.Commands.cs
@@ -36,7 +36,8 @@ public static bool IsCheckForUpdateCommandVisible
 #endif
             }
         }
-
+        
+        public static readonly Command Unminimize = new Command(_ => ShowWindow());
         public static readonly Command OpenPreferencesCommand = new Command(_ => OpenDialog(new Views.Preferences()));
         public static readonly Command OpenHotkeysCommand = new Command(_ => OpenDialog(new Views.Hotkeys()));
         public static readonly Command OpenAppDataDirCommand = new Command(_ => Native.OS.OpenInFileManager(Native.OS.DataDir));
diff --git a/src/App.axaml.cs b/src/App.axaml.cs
@@ -16,6 +16,8 @@
 using Avalonia.Markup.Xaml;
 using Avalonia.Media;
 using Avalonia.Media.Fonts;
+using Avalonia.Media.Imaging;
+using Avalonia.Platform;
 using Avalonia.Platform.Storage;
 using Avalonia.Styling;
 using Avalonia.Threading;
@@ -169,6 +171,46 @@ public static void SetTheme(string theme, string themeOverridesFile)
             }
         }
 
+        public void SetupTrayIcon(bool enable)
+        {
+            if (enable && Native.OS.EnsureSingleInstance())
+            {
+                var icons = new TrayIcons {
+                    new TrayIcon {
+                        Icon = new WindowIcon(new Bitmap(AssetLoader.Open(new Uri("avares://SourceGit/App.ico")))),
+                        Menu = [
+                            new NativeMenuItem(Text("Open")) {Command = Unminimize},
+                            new NativeMenuItem(Text("Preferences")) {Command = OpenPreferencesCommand},
+                            new NativeMenuItemSeparator(),
+                            new NativeMenuItem(Text("Quit")) {Command = QuitCommand},
+                        ]
+                    }
+                };
+                icons[0].Clicked += (_, _) => ToggleWindow();
+                TrayIcon.SetIcons(Current, icons);
+                _createdSystemTrayIcon = true;
+            }
+        }
+
+        private static void ToggleWindow() {
+            if (Current?.ApplicationLifetime is IClassicDesktopStyleApplicationLifetime desktop) {
+                if (desktop.MainWindow.IsVisible) {
+                    desktop.MainWindow.Hide();
+                } else {
+                    ShowWindow();
+                }
+            }
+        }
+
+        private static void ShowWindow()
+        {
+            if (Current?.ApplicationLifetime is IClassicDesktopStyleApplicationLifetime desktop) {
+                desktop.MainWindow.WindowState = WindowState.Normal;
+                desktop.MainWindow.Show();
+                desktop.MainWindow.BringIntoView();
+                desktop.MainWindow.Focus();
+            }
+        }
         public static void SetFonts(string defaultFont, string monospaceFont, bool onlyUseMonospaceFontInEditor)
         {
             var app = Current as App;
@@ -322,6 +364,7 @@ public override void OnFrameworkInitializationCompleted()
 
                 TryLaunchAsNormal(desktop);
             }
+            base.OnFrameworkInitializationCompleted();
         }
         #endregion
 
@@ -477,11 +520,17 @@ private void TryLaunchAsNormal(IClassicDesktopStyleApplicationLifetime desktop)
             if (desktop.Args != null && desktop.Args.Length == 1 && Directory.Exists(desktop.Args[0]))
                 startupRepo = desktop.Args[0];
 
-            _launcher = new ViewModels.Launcher(startupRepo);
+            var pref = ViewModels.Preferences.Instance;
+
+            SetupTrayIcon(pref.SystemTrayIcon);            
+            if (_createdSystemTrayIcon) {
+                desktop.ShutdownMode = ShutdownMode.OnExplicitShutdown;
+            }
+
+            _launcher = new ViewModels.Launcher(startupRepo) { InterceptQuit = _createdSystemTrayIcon };
             desktop.MainWindow = new Views.Launcher() { DataContext = _launcher };
 
 #if !DISABLE_UPDATE_DETECTION
-            var pref = ViewModels.Preferences.Instance;
             if (pref.ShouldCheck4UpdateOnStartup())
                 Check4Update();
 #endif
@@ -544,5 +593,6 @@ private void ShowSelfUpdateResult(object data)
         private ResourceDictionary _activeLocale = null;
         private ResourceDictionary _themeOverrides = null;
         private ResourceDictionary _fontsOverrides = null;
+        private bool _createdSystemTrayIcon = false;
     }
 }
diff --git a/src/Native/Linux.cs b/src/Native/Linux.cs
@@ -11,6 +11,7 @@ namespace SourceGit.Native
     [SupportedOSPlatform("linux")]
     internal class Linux : OS.IBackend
     {
+        private FileStream _fs = null;
         public void SetupApp(AppBuilder builder)
         {
             builder.With(new X11PlatformOptions() { EnableIme = true });
@@ -97,6 +98,26 @@ public void OpenWithDefaultEditor(string file)
             }
         }
 
+        public bool EnsureSingleInstance()
+        {
+            var pidfile = Path.Combine(Path.GetTempPath(), "sourcegit.pid");
+            var pid = Process.GetCurrentProcess().Id.ToString();
+            Console.WriteLine("pid " + pid);
+
+            try
+            {
+                _fs = File.OpenWrite(pidfile);
+                _fs.Lock(0, 1000);
+                new StreamWriter(_fs).Write(pid);
+                return true;
+            }
+            catch (IOException)
+            {
+                Console.WriteLine("another SourceGit is running");
+                return false;
+            }
+        }
+        
         private string FindExecutable(string filename)
         {
             var pathVariable = Environment.GetEnvironmentVariable("PATH") ?? string.Empty;
diff --git a/src/Native/MacOS.cs b/src/Native/MacOS.cs
@@ -88,5 +88,7 @@ public void OpenWithDefaultEditor(string file)
         {
             Process.Start("open", $"\"{file}\"");
         }
+
+        public bool EnsureSingleInstance() { return true; }
     }
 }
diff --git a/src/Native/OS.cs b/src/Native/OS.cs
@@ -23,6 +23,8 @@ public interface IBackend
             void OpenInFileManager(string path, bool select);
             void OpenBrowser(string url);
             void OpenWithDefaultEditor(string file);
+
+            bool EnsureSingleInstance();
         }
 
         public static string DataDir
@@ -220,6 +222,11 @@ private static void UpdateGitVersion()
         [GeneratedRegex(@"^git version[\s\w]*(\d+)\.(\d+)[\.\-](\d+).*$")]
         private static partial Regex REG_GIT_VERSION();
 
+        public static bool EnsureSingleInstance()
+        {
+            return _backend.EnsureSingleInstance();
+        }
+
         private static IBackend _backend = null;
         private static string _gitExecutable = string.Empty;
     }
diff --git a/src/Native/Windows.cs b/src/Native/Windows.cs
@@ -14,6 +14,8 @@ namespace SourceGit.Native
     [SupportedOSPlatform("windows")]
     internal class Windows : OS.IBackend
     {
+        private FileStream _fs = null;
+        
         [StructLayout(LayoutKind.Sequential)]
         internal struct RTL_OSVERSIONINFOEX
         {
@@ -393,5 +395,25 @@ private string FindVSSolutionFile(DirectoryInfo dir, int leftDepth)
 
             return null;
         }
+
+        public bool EnsureSingleInstance()
+        {
+            var pidfile = Path.Combine(Path.GetTempPath(), "sourcegit.pid");
+            var pid = Process.GetCurrentProcess().Id.ToString();
+            Console.WriteLine("pid " + pid);
+
+            try
+            {
+                _fs = File.OpenWrite(pidfile);
+                _fs.Lock(0, 1000);
+                new StreamWriter(_fs).Write(pid);
+                return true;
+            }
+            catch (IOException)
+            {
+                Console.WriteLine("another SourceGit is running");
+                return false;
+            }
+        }
     }
 }
diff --git a/src/Resources/Locales/en_US.axaml b/src/Resources/Locales/en_US.axaml
@@ -468,6 +468,7 @@
   <x:String x:Key="Text.Preferences.Appearance.ThemeOverrides" xml:space="preserve">Theme Overrides</x:String>
   <x:String x:Key="Text.Preferences.Appearance.UseFixedTabWidth" xml:space="preserve">Use fixed tab width in titlebar</x:String>
   <x:String x:Key="Text.Preferences.Appearance.UseNativeWindowFrame" xml:space="preserve">Use native window frame</x:String>
+  <x:String x:Key="Text.Preferences.Appearance.SystemTrayIcon" xml:space="preserve">System tray icon (needs restart)</x:String>  
   <x:String x:Key="Text.Preferences.DiffMerge" xml:space="preserve">DIFF/MERGE TOOL</x:String>
   <x:String x:Key="Text.Preferences.DiffMerge.Path" xml:space="preserve">Install Path</x:String>
   <x:String x:Key="Text.Preferences.DiffMerge.Path.Placeholder" xml:space="preserve">Input path for diff/merge tool</x:String>
diff --git a/src/Resources/Locales/ru_RU.axaml b/src/Resources/Locales/ru_RU.axaml
@@ -460,6 +460,7 @@
   <x:String x:Key="Text.Preferences.Appearance.ThemeOverrides" xml:space="preserve">Переопределение темы</x:String>
   <x:String x:Key="Text.Preferences.Appearance.UseFixedTabWidth" xml:space="preserve">Использовать фиксированную ширину табуляции в строке заголовка.</x:String>
   <x:String x:Key="Text.Preferences.Appearance.UseNativeWindowFrame" xml:space="preserve">Использовать системное окно</x:String>
+  <x:String x:Key="Text.Preferences.Appearance.SystemTrayIcon" xml:space="preserve">Иконка в системном лотке (нужен перезапуск)</x:String>
   <x:String x:Key="Text.Preferences.DiffMerge" xml:space="preserve">ИНСТРУМЕНТ РАЗЛИЧИЙ/СЛИЯНИЯ</x:String>
   <x:String x:Key="Text.Preferences.DiffMerge.Path" xml:space="preserve">Путь установки</x:String>
   <x:String x:Key="Text.Preferences.DiffMerge.Path.Placeholder" xml:space="preserve">Введите путь для инструмента различия/слияния</x:String>
diff --git a/src/ViewModels/Launcher.cs b/src/ViewModels/Launcher.cs
@@ -29,6 +29,8 @@ public Workspace ActiveWorkspace
             private set => SetProperty(ref _activeWorkspace, value);
         }
 
+        public bool InterceptQuit { get; set; } = false;
+
         public LauncherPage ActivePage
         {
             get => _activePage;
@@ -47,7 +49,6 @@ public LauncherPage ActivePage
         public Launcher(string startupRepo)
         {
             _ignoreIndexChange = true;
-
             Pages = new AvaloniaList<LauncherPage>();
             AddNewTab();
 
diff --git a/src/ViewModels/Preferences.cs b/src/ViewModels/Preferences.cs
@@ -348,6 +348,12 @@ public double LastCheckUpdateTime
             set => SetProperty(ref _lastCheckUpdateTime, value);
         }
 
+        public bool SystemTrayIcon 
+        {
+            get => _systemTrayIcon;
+            set => SetProperty(ref _systemTrayIcon, value);
+        }
+
         public bool IsGitConfigured()
         {
             var path = GitInstallPath;
@@ -682,5 +688,7 @@ private string FixFontFamilyName(string name)
         private string _externalMergeToolPath = string.Empty;
 
         private uint _statisticsSampleColor = 0xFF00FF00;
+
+        private bool _systemTrayIcon = false;
     }
 }
diff --git a/src/Views/Launcher.axaml.cs b/src/Views/Launcher.axaml.cs
@@ -262,7 +262,13 @@ protected override void OnKeyUp(KeyEventArgs e)
 
         protected override void OnClosing(WindowClosingEventArgs e)
         {
-            (DataContext as ViewModels.Launcher)?.Quit(Width, Height);
+            var launcher = DataContext as ViewModels.Launcher;
+            if (launcher is { InterceptQuit: true }) {
+                e.Cancel = true;
+                Hide();
+            } else {
+                launcher?.Quit(Width, Height);
+            }
             base.OnClosing(e);
         }
 
diff --git a/src/Views/Preferences.axaml b/src/Views/Preferences.axaml
@@ -148,7 +148,7 @@
           <TabItem.Header>
             <TextBlock Classes="tab_header" Text="{DynamicResource Text.Preferences.Appearance}"/>
           </TabItem.Header>
-          <Grid Margin="8" RowDefinitions="32,32,32,32,32,32,32,Auto" ColumnDefinitions="Auto,*">
+          <Grid Margin="8" RowDefinitions="32,32,32,32,32,Auto" ColumnDefinitions="Auto,*">
             <TextBlock Grid.Row="0" Grid.Column="0"
                        Text="{DynamicResource Text.Preferences.Appearance.Theme}"
                        HorizontalAlignment="Right"
@@ -232,21 +232,26 @@
               </TextBox.InnerRightContent>
             </TextBox>
 
-            <CheckBox Grid.Row="5" Grid.Column="1"
-                      Content="{DynamicResource Text.Preferences.Appearance.OnlyUseMonoFontInEditor}"
-                      IsChecked="{Binding OnlyUseMonoFontInEditor, Mode=TwoWay}"/>
-
-            <CheckBox Grid.Row="6" Grid.Column="1"
-                      Height="32"
-                      Content="{DynamicResource Text.Preferences.Appearance.UseFixedTabWidth}"
-                      IsChecked="{Binding Source={x:Static vm:Preferences.Instance}, Path=UseFixedTabWidth, Mode=TwoWay}"/>
-
-            <CheckBox Grid.Row="7" Grid.Column="1"
-                      Height="32"
-                      Content="{DynamicResource Text.Preferences.Appearance.UseNativeWindowFrame}"
-                      IsChecked="{Binding Source={x:Static vm:Preferences.Instance}, Path=UseSystemWindowFrame, Mode=OneTime}"
-                      IsVisible="{OnPlatform False, Linux=True}"
-                      IsCheckedChanged="OnUseNativeWindowFrameChanged"/>
+            <StackPanel Grid.Row="5" Grid.Column="1">
+              <CheckBox Content="{DynamicResource Text.Preferences.Appearance.OnlyUseMonoFontInEditor}"
+                        IsChecked="{Binding OnlyUseMonoFontInEditor, Mode=TwoWay}"/>
+
+              <CheckBox Height="32"
+                        Content="{DynamicResource Text.Preferences.Appearance.UseFixedTabWidth}"
+                        IsChecked="{Binding Source={x:Static vm:Preferences.Instance}, Path=UseFixedTabWidth, Mode=TwoWay}"/>
+
+              <CheckBox Height="32"
+                        Content="{DynamicResource Text.Preferences.Appearance.UseNativeWindowFrame}"
+                        IsChecked="{Binding Source={x:Static vm:Preferences.Instance}, Path=UseSystemWindowFrame, Mode=OneTime}"
+                        IsVisible="{OnPlatform False, Linux=True}"
+                        IsCheckedChanged="OnUseNativeWindowFrameChanged"/>
+              
+              <CheckBox Height="32"
+                        Content="{DynamicResource Text.Preferences.Appearance.SystemTrayIcon}"
+                        IsChecked="{Binding Path=SystemTrayIcon, Mode=OneTime}"
+                        IsVisible="True"
+                        IsCheckedChanged="OnSystemTrayIconCheckedChanged"/>
+            </StackPanel>
           </Grid>
         </TabItem>
 
diff --git a/src/Views/Preferences.axaml.cs b/src/Views/Preferences.axaml.cs
@@ -342,6 +342,17 @@ private void OnUseNativeWindowFrameChanged(object sender, RoutedEventArgs e)
 
             e.Handled = true;
         }
+        private void OnSystemTrayIconCheckedChanged(object sender, RoutedEventArgs e)
+        {
+            if (sender is CheckBox box)
+            {
+                ViewModels.Preferences.Instance.SystemTrayIcon = box.IsChecked == true;
+                var dialog = new ConfirmRestart();
+                App.OpenDialog(dialog);
+            }
+
+            e.Handled = true;
+        }
 
         private void OnGitInstallPathChanged(object sender, TextChangedEventArgs e)
         {

Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,8 @@ public static bool IsCheckForUpdateCommandVisible`
`36`	`36`	`#endif`
`37`	`37`	`}`
`38`	`38`	`}`
`39`		`-`
	`39`	`+`
	`40`	`+ public static readonly Command Unminimize = new Command(_ => ShowWindow());`
`40`	`41`	`public static readonly Command OpenPreferencesCommand = new Command(_ => OpenDialog(new Views.Preferences()));`
`41`	`42`	`public static readonly Command OpenHotkeysCommand = new Command(_ => OpenDialog(new Views.Hotkeys()));`
`42`	`43`	`public static readonly Command OpenAppDataDirCommand = new Command(_ => Native.OS.OpenInFileManager(Native.OS.DataDir));`
Original file line number	Diff line number	Diff line change
`@@ -88,5 +88,7 @@ public void OpenWithDefaultEditor(string file)`
`88`	`88`	`{`
`89`	`89`	`Process.Start("open", $"\"{file}\"");`
`90`	`90`	`}`
	`91`	`+`
	`92`	`+ public bool EnsureSingleInstance() { return true; }`
`91`	`93`	`}`
`92`	`94`	`}`
Original file line number	Diff line number	Diff line change
`@@ -29,6 +29,8 @@ public Workspace ActiveWorkspace`
`29`	`29`	`private set => SetProperty(ref _activeWorkspace, value);`
`30`	`30`	`}`
`31`	`31`
	`32`	`+ public bool InterceptQuit { get; set; } = false;`
	`33`	`+`
`32`	`34`	`public LauncherPage ActivePage`
`33`	`35`	`{`
`34`	`36`	`get => _activePage;`
`@@ -47,7 +49,6 @@ public LauncherPage ActivePage`
`47`	`49`	`public Launcher(string startupRepo)`
`48`	`50`	`{`
`49`	`51`	`_ignoreIndexChange = true;`
`50`		`-`
`51`	`52`	`Pages = new AvaloniaList<LauncherPage>();`
`52`	`53`	`AddNewTab();`
`53`	`54`
Original file line number	Diff line number	Diff line change
`@@ -348,6 +348,12 @@ public double LastCheckUpdateTime`
`348`	`348`	`set => SetProperty(ref _lastCheckUpdateTime, value);`
`349`	`349`	`}`
`350`	`350`
	`351`	`+ public bool SystemTrayIcon`
	`352`	`+ {`
	`353`	`+ get => _systemTrayIcon;`
	`354`	`+ set => SetProperty(ref _systemTrayIcon, value);`
	`355`	`+ }`
	`356`	`+`
`351`	`357`	`public bool IsGitConfigured()`
`352`	`358`	`{`
`353`	`359`	`var path = GitInstallPath;`
`@@ -682,5 +688,7 @@ private string FixFontFamilyName(string name)`
`682`	`688`	`private string _externalMergeToolPath = string.Empty;`
`683`	`689`
`684`	`690`	`private uint _statisticsSampleColor = 0xFF00FF00;`
	`691`	`+`
	`692`	`+ private bool _systemTrayIcon = false;`
`685`	`693`	`}`
`686`	`694`	`}`
Original file line number	Diff line number	Diff line change
`@@ -262,7 +262,13 @@ protected override void OnKeyUp(KeyEventArgs e)`
`262`	`262`
`263`	`263`	`protected override void OnClosing(WindowClosingEventArgs e)`
`264`	`264`	`{`
`265`		`- (DataContext as ViewModels.Launcher)?.Quit(Width, Height);`
	`265`	`+ var launcher = DataContext as ViewModels.Launcher;`
	`266`	`+ if (launcher is { InterceptQuit: true }) {`
	`267`	`+ e.Cancel = true;`
	`268`	`+ Hide();`
	`269`	`+ } else {`
	`270`	`+ launcher?.Quit(Width, Height);`
	`271`	`+ }`
`266`	`272`	`base.OnClosing(e);`
`267`	`273`	`}`
`268`	`274`