Skip to content

Conversation

Jack251970
Copy link
Member

Improve Shutdown & Restart & Hibernate in Sys Plugin

Replace them with PInvoke function which can slightly improve execution speed.

Test

  • Shutdown & Restart & Restart With Advanced Boot Options & Hibernate action

Copy link

@check-spelling-bot Report

🔴 Please review

See the 📂 files view, the 📜action log, or 📝 job summary for details.

❌ Errors Count
❌ forbidden-pattern 22
⚠️ ignored-expect-variant 1
⚠️ non-alpha-in-dictionary 19

See ❌ Event descriptions for more information.

If the flagged items are 🤯 false positives

If items relate to a ...

  • binary file (or some other file you wouldn't want to check at all).

    Please add a file path to the excludes.txt file matching the containing file.

    File paths are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your files.

    ^ refers to the file's path from the root of the repository, so ^README\.md$ would exclude README.md (on whichever branch you're using).

  • well-formed pattern.

    If you can write a pattern that would match it,
    try adding it to the patterns.txt file.

    Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines.

    Note that patterns can't match multiline strings.

Copy link

gitstream-cm bot commented Feb 18, 2025

Be a legend 🏆 by adding a before and after screenshot of the changes you made, especially if they are around UI/UX.

Copy link
Contributor

coderabbitai bot commented Feb 18, 2025

📝 Walkthrough

Walkthrough

The pull request updates two files in the Flow Launcher Sys plugin. In the main class, new using directives, a constant (REASON), and the EnableShutdownPrivilege method are added to improve Windows shutdown, restart, and logoff functionalities by leveraging system privileges via PInvoke. The commands now check for privilege enablement and either use a direct system call or fall back to a process start. Additionally, the NativeMethods file now includes several new entries related to privilege and token management.

Changes

File Change Summary
Plugins/Flow.Launcher.Plugin.Sys/Main.cs Added using directives for security namespaces, a new REASON constant, and the EnableShutdownPrivilege method. Updated shutdown, restart, and logoff actions with privilege checks.
Plugins/Flow.Launcher.Plugin.Sys/NativeMethods.txt Added new entries: OpenProcessToken, WIN32_ERROR, LookupPrivilegeValue, AdjustTokenPrivileges, TOKEN_PRIVILEGES, and SE_SHUTDOWN_NAME.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant M as Main (Plugin)
    participant P as PInvoke
    participant Proc as Process.Start

    U->>M: Request Shutdown/Restart/Logoff
    M->>M: Call EnableShutdownPrivilege()
    alt Privilege Enabled
        M->>P: Invoke ExitWindowsEx with REASON
    else Privilege Failed
        M->>Proc: Execute shutdown command via Process.Start
    end
Loading

Suggested labels

bug, Small PR

Suggested reviewers

  • taooceros

Poem

Hopping through the lines of code so fine,
I unlock privileges with each small sign.
Commands now flow, with clarity in sight,
As PInvoke leads the system to do what's right.
A bunny's cheers echo in every byte,
Celebrating changes with a hop and light delight!


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
Plugins/Flow.Launcher.Plugin.Sys/Main.cs (1)

109-145: Consider closing the token handle to avoid a potential leak.
While this code successfully enables the shutdown privilege, the opened process token should be closed after use. Adding PInvoke.CloseHandle(tokenHandle); ensures proper resource management.

You could apply the following diff (example placement right before return true):

+                PInvoke.CloseHandle(tokenHandle);
                 return true;
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9917de9 and 3bd4ca4.

📒 Files selected for processing (2)
  • Plugins/Flow.Launcher.Plugin.Sys/Main.cs (11 hunks)
  • Plugins/Flow.Launcher.Plugin.Sys/NativeMethods.txt (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: gitStream.cm
🔇 Additional comments (12)
Plugins/Flow.Launcher.Plugin.Sys/Main.cs (11)

5-5: Imports for PInvoke are proper.
No issues found; this import is needed to marshal between managed and unmanaged code.


13-13: Security namespace import looks good.
This addition is necessary to reference Windows security constants and methods.


25-27: Reason constant is well-defined and documented.
Declaring a planned, generic shutdown reason helps convey intent for system logs.


169-172: Shutdown fallback approach is correct.
This ensures graceful handling if privilege elevation fails.


191-194: Restart fallback approach is consistent.
Code is clear and mirrors the shutdown logic.


213-216: Advanced boot restore similarly consistent.
No concerns; logic follows same fallback pattern.


235-235: Log off uses direct PInvoke without fallback.
Logoff in Windows generally doesn’t require elevated shutdown privileges, so a fallback may be unnecessary.


258-262: Sleep call is clear and appropriate.
SetSuspendState(false, false, false) correctly triggers system sleep.


272-272: Hibernate call is clear and appropriate.
SetSuspendState(true, false, false) properly triggers system hibernation.


284-284: Index Option command usage.
Launching “srchadmin.dll” via “control.exe” is a known approach for Windows indexing options.


322-322: Open Recycle Bin command is straightforward.
No concerns with launching Explorer on this shell path.

Plugins/Flow.Launcher.Plugin.Sys/NativeMethods.txt (1)

6-12: New entries align with PInvoke requirements.
All newly declared methods (OpenProcessToken, LookupPrivilegeValue, AdjustTokenPrivileges, etc.) and constants (WIN32_ERROR, TOKEN_PRIVILEGES, SE_SHUTDOWN_NAME) match usage in Main.cs. No issues identified.

@Jack251970 Jack251970 added the enhancement New feature or request label Feb 18, 2025
@Jack251970 Jack251970 requested a review from taooceros February 18, 2025 03:42
@taooceros
Copy link
Member

taooceros commented Feb 19, 2025

Do you know what would happen if you use EWX_SHUTDOWN or EWX_HYBRID_SHUTDOWN instead of poweroff?

@Jack251970
Copy link
Member Author

Do you know what would happen if you use EWX_SHUTDOWN or EWX_HYBRID_SHUTDOWN instead of poweroff?

If you use the former, the system in a state where other processes (e.g., firmware) can intervene before power-off and it may leave the system waiting for a manual power-off. Considering that user click to shutdown the computer, I think FL should not wait.

If you use the later, the system will performs a hybrid shutdown (Fast Startup). Instead of fully shutting down, Windows hibernates the kernel and driver state. I think FL should not use this mode.

Copy link

gitstream-cm bot commented Feb 19, 2025

🥷 Code experts: no user but you matched threshold 10

Jack251970, cibere have most 👩‍💻 activity in the files.
Jack251970 has most 🧠 knowledge in the files.

See details

Plugins/Flow.Launcher.Plugin.Sys/Main.cs

Activity based on git-commit:

Jack251970 cibere
FEB 2 additions & 2 deletions
JAN
DEC 12 additions & 38 deletions 15 additions & 6 deletions
NOV 12 additions & 14 deletions
OCT
SEP

Knowledge based on git-blame:
Jack251970: 4%

Plugins/Flow.Launcher.Plugin.Sys/NativeMethods.txt

Activity based on git-commit:

Jack251970 cibere
FEB
JAN
DEC 6 additions & 0 deletions
NOV
OCT
SEP

Knowledge based on git-blame:
Jack251970: 100%

To learn more about /:\ gitStream - Visit our Docs

@taooceros
Copy link
Member

Do you know what would happen if you use EWX_SHUTDOWN or EWX_HYBRID_SHUTDOWN instead of poweroff?

If you use the former, the system in a state where other processes (e.g., firmware) can intervene before power-off and it may leave the system waiting for a manual power-off. Considering that user click to shutdown the computer, I think FL should not wait.

If you use the later, the system will performs a hybrid shutdown (Fast Startup). Instead of fully shutting down, Windows hibernates the kernel and driver state. I think FL should not use this mode.

I am actually pretty curious whether we should have a way to use the hybrid shutdown. It is enabled by default for many computer I think, and for many people they wouldn't need a full shutdown but a fast startup would help. If they want to refresh some hardware state, most likely they will use restart instead of shutdown. I am not sure whether the current shutdown uses fast startup or the full shutdown. Maybe it worth to check.

@Jack251970
Copy link
Member Author

Do you know what would happen if you use EWX_SHUTDOWN or EWX_HYBRID_SHUTDOWN instead of poweroff?

If you use the former, the system in a state where other processes (e.g., firmware) can intervene before power-off and it may leave the system waiting for a manual power-off. Considering that user click to shutdown the computer, I think FL should not wait.
If you use the later, the system will performs a hybrid shutdown (Fast Startup). Instead of fully shutting down, Windows hibernates the kernel and driver state. I think FL should not use this mode.

I am actually pretty curious whether we should have a way to use the hybrid shutdown. It is enabled by default for many computer I think, and for many people they wouldn't need a full shutdown but a fast startup would help. If they want to refresh some hardware state, most likely they will use restart instead of shutdown. I am not sure whether the current shutdown uses fast startup or the full shutdown. Maybe it worth to check.

The current codes Process.Start("shutdown", "/s /t 0"); use the full shutdown so I use EWX_SHUTDOWN | EWX_POWEROFF to keep their behaviour consistent.

@taooceros
Copy link
Member

Sounds good, let's keep it for now. We can have the fast startup sometimes later.

@Jack251970 Jack251970 merged commit 1a54eed into Flow-Launcher:dev Feb 19, 2025
8 checks passed
@jjw24 jjw24 added this to the 1.20.0 milestone Feb 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants