Skip to content

Limiting scope of signal handling based on environment #220

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bennothommo wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

Limiting scope of signal handling based on environment #220

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9130c48
Limiting scope of signal handling based on environment
bennothommo Sep 19, 2025
9cb8c68
Merge branch 'develop' into fix/sigint-missing
LukeTowers Dec 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 18 additions & 13 deletions src/Console/Traits/HandlesCleanup.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
<?php namespace Winter\Storm\Console\Traits;
<?php

namespace Winter\Storm\Console\Traits;

/**
* Console Command Trait that injects cross-platform signal handling to trigger
Expand All @@ -12,6 +14,8 @@
*/
trait HandlesCleanup
{
protected $windowsSignalHandlerRegistered = false;

/**
* Returns the process signals this command listens to
* @see https://www.php.net/manual/en/pcntl.constants.php
Expand All @@ -20,15 +24,18 @@ trait HandlesCleanup
public function getSubscribedSignals(): array
{
$signals = [];

if (method_exists($this, 'handleCleanup')) {
// Handle Windows OS
if (PHP_OS_FAMILY === 'Windows') {
// Attach to Windows Ctrl+C & Ctrl+Break events
if (function_exists('sapi_windows_set_ctrl_handler')) {
sapi_windows_set_ctrl_handler([$this, 'handleWindowsSignal'], true);
if (function_exists('sapi_windows_set_ctrl_handler') && !$this->windowsSignalHandlerRegistered) {
if (sapi_windows_set_ctrl_handler([$this, 'handleWindowsSignal'], true)) {
$this->windowsSignalHandlerRegistered = true;
}
}
// Handle Unix-like OS
} else {
} elseif (function_exists('pcntl_signal')) {
$signals = [SIGINT, SIGTERM, SIGQUIT];
}
}
Expand All @@ -51,7 +58,7 @@ public function handleSignal(int $signal, /* int|false $previousExitCode = 0 */)
}

// Exit cleanly at this point if this was a user termination
if (in_array($signal, [SIGINT, SIGQUIT])) {
if (function_exists('pcntl_signal') && in_array($signal, [SIGINT, SIGQUIT])) {
return 0;
}

Expand All @@ -64,16 +71,14 @@ public function handleSignal(int $signal, /* int|false $previousExitCode = 0 */)
public function handleWindowsSignal(int $event): void
{
// Remove the handler
sapi_windows_set_ctrl_handler([$this, 'handleWindowsSignal'], false);
if ($this->windowsSignalHandlerRegistered) {
if (sapi_windows_set_ctrl_handler([$this, 'handleWindowsSignal'], false)) {
$this->windowsSignalHandlerRegistered = false;
}
}

// Handle the signal
if (
method_exists($this, 'handleCleanup')
&& (
$event === PHP_WINDOWS_EVENT_CTRL_C
|| $event === PHP_WINDOWS_EVENT_CTRL_BREAK
)
) {
if (method_exists($this, 'handleCleanup')) {
$this->handleCleanup();

// Exit cleanly at this point if this was a user termination
Expand Down