imp - brk|doc - Login handler's LoginScreen() returns boolean

--- We've made a breaking change that allows us to implement the final portions of the login handler, which is telling the handler whether to "proceed" or to "refresh" itself. --- Type: imp Breaking: True Doc Required: True Part: 1/1
Aptivi · Feb 15, 2024 · 89e7ea9 · 89e7ea9
1 parent 8e11026
commit 89e7ea9
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 5 deletions.
diff --git a/public/Nitrocid/Nitrocid.csproj b/public/Nitrocid/Nitrocid.csproj
@@ -52,7 +52,7 @@
     <NitrocidModAPIVersionMajor>3.0.25</NitrocidModAPIVersionMajor>
 
     <!-- Increment NitrocidModAPIVersionChangeset every time there is a breaking change or an API addition in the N-KS API. -->
-    <NitrocidModAPIVersionChangeset>426</NitrocidModAPIVersionChangeset>
+    <NitrocidModAPIVersionChangeset>427</NitrocidModAPIVersionChangeset>
 
     <!-- To be installed to the file version -->
     <NitrocidModAPIVersion>$(NitrocidModAPIVersionMajor).$(NitrocidModAPIVersionChangeset)</NitrocidModAPIVersion>

diff --git a/public/Nitrocid/Users/Login/Handlers/BaseLoginHandler.cs b/public/Nitrocid/Users/Login/Handlers/BaseLoginHandler.cs
@@ -64,7 +64,7 @@ public abstract class BaseLoginHandler : ILoginHandler
             Config.MainConfig.ShowAvailableUsers;
 
         /// <inheritdoc/>
-        public virtual void LoginScreen()
+        public virtual bool LoginScreen()
         {
             // Clear console if ClearOnLogin is set to True (If a user has enabled Clear Screen on Login)
             if (ClearOnLogin)
@@ -90,6 +90,7 @@ public virtual void LoginScreen()
                 TextWriterColor.Write(Translate.DoTranslation("You can log in to these accounts:"));
                 ListWriterColor.WriteList(UsersList);
             }
+            return true;
         }
 
         /// <inheritdoc/>

diff --git a/public/Nitrocid/Users/Login/Handlers/ILoginHandler.cs b/public/Nitrocid/Users/Login/Handlers/ILoginHandler.cs
@@ -27,7 +27,8 @@ public interface ILoginHandler
         /// <summary>
         /// Login screen
         /// </summary>
-        void LoginScreen();
+        /// <returns>True if we need to proceed to the user selector. Otherwise, false.</returns>
+        bool LoginScreen();
 
         /// <summary>
         /// Username selector

diff --git a/public/Nitrocid/Users/Login/Handlers/Logins/ModernLogin.cs b/public/Nitrocid/Users/Login/Handlers/Logins/ModernLogin.cs
@@ -36,7 +36,7 @@ namespace Nitrocid.Users.Login.Handlers.Logins
 {
     internal class ModernLogin : BaseLoginHandler, ILoginHandler
     {
-        public override void LoginScreen()
+        public override bool LoginScreen()
         {
             // Clear the console
             ConsoleWrapper.CursorVisible = false;
@@ -57,6 +57,7 @@ public override void LoginScreen()
             ModernLogonScreen.renderedFully = false;
 
             // Check to see if user requested power actions
+            bool proceed = true;
             if (key == ConsoleKey.Escape)
             {
                 int answer = InfoBoxButtonsColor.WriteInfoBoxButtons([
@@ -68,7 +69,9 @@ public override void LoginScreen()
                     PowerManager.PowerManage(PowerMode.Shutdown);
                 else if (answer == 1)
                     PowerManager.PowerManage(PowerMode.Reboot);
+                proceed = answer == 2;
             }
+            return proceed;
         }
 
         public override string UserSelector()

diff --git a/public/Nitrocid/Users/Login/Login.cs b/public/Nitrocid/Users/Login/Login.cs
@@ -93,12 +93,16 @@ public static void LoginPrompt()
                         UserManagement.fallbackRootAccount;
 
                     // Now, show the Login screen
-                    handler.LoginScreen();
+                    bool proceed = handler.LoginScreen();
 
                     // The login screen may provide an option to perform power options.
                     if (PowerManager.RebootRequested || PowerManager.KernelShutdown)
                         continue;
 
+                    // The login screen may provide an option to refresh itself.
+                    if (!proceed)
+                        continue;
+
                     // Prompt for username
                     user = handler.UserSelector();