Skip to content

Evaluate $upgrading numeric value when checking if maintenance mode is active #22

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

Merged
danielbachhuber merged 12 commits into from
Nov 6, 2023
Merged

Evaluate $upgrading numeric value when checking if maintenance mode is active #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
7c7d365
fix maintenance mode inconsistency by using the $upgrading value in c…
selul Jun 2, 2022
c4df9a3
split test into two separate commands.
selul Jun 2, 2022
3064a4a
Merge branch 'main' into selul/main
swissspidy Nov 3, 2023
2f8423c
Use regex
swissspidy Nov 3, 2023
8fe2f30
Adds warning when non numeric value is detected.
selul Nov 4, 2023
7ef179f
[skip ci] Update features/maintenance-mode.feature
selul Nov 4, 2023
f612a70
[skip ci] Update features/maintenance-mode.feature
selul Nov 4, 2023
79957be
[skip ci] Update features/maintenance-mode.feature
selul Nov 4, 2023
0b76340
Restructure status check commands in two scenarios.
selul Nov 4, 2023
f2d0b64
Update features/maintenance-mode.feature
selul Nov 6, 2023
c767cb5
Adds code comment reference to wp_is_maintenance_mode
selul Nov 6, 2023
a407fb0
Fix Behat statement
danielbachhuber Nov 6, 2023
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: 31 additions & 0 deletions features/maintenance-mode.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,3 +55,34 @@ Feature: Manage maintenance mode of WordPress install.
"""
Error: Maintenance mode already deactivated.
"""

When I run `wp maintenance-mode activate`
Then STDOUT should be:
"""
Enabling Maintenance mode...
Success: Activated Maintenance mode.
"""

Scenario: Check maintenance mode status when expression is used.

When I run `wp eval "file_put_contents('.maintenance', '<?php \$upgrading=(time()-601);'); "`
And I try `wp maintenance-mode is-active`
Then the return code should be 1
And STDERR should contain:
"""
Warning: Unable to read the maintenance file timestamp, non-numeric value detected.
"""

Scenario: Check maintenance mode status when numeric timestamp is used.

When I run `wp eval "file_put_contents('.maintenance', '<?php \$upgrading=' . ( time() + 100 ) . ';'); "`
And I run `wp maintenance-mode is-active`
Then the return code should be 0

When I run `wp eval "file_put_contents('.maintenance', '<?php \$upgrading =' . ( time() + 100 ) . ';') ; "`
And I run `wp maintenance-mode is-active`
Then the return code should be 0

When I run `wp eval "file_put_contents('.maintenance', '<?php \$upgrading= ' . ( time() + 100 ) . ';'); "`
And I run `wp maintenance-mode is-active`
Then the return code should be 0
21 changes: 20 additions & 1 deletion src/MaintenanceModeCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,26 @@ private function get_maintenance_mode_status() {

$maintenance_file = trailingslashit( $wp_filesystem->abspath() ) . '.maintenance';

return $wp_filesystem->exists( $maintenance_file );
if ( ! $wp_filesystem->exists( $maintenance_file ) ) {
return false;
}

// We use the timestamp defined in the .maintenance file
// to check if the maintenance is available.
$upgrading = 0;

$contents = $wp_filesystem->get_contents( $maintenance_file );
$matches = [];
if ( preg_match( '/upgrading\s*=\s*(\d+)\s*;/i', $contents, $matches ) ) {
$upgrading = (int) $matches[1];
} else {
WP_CLI::warning( 'Unable to read the maintenance file timestamp, non-numeric value detected.' );
}
// The logic here is based on the core WordPress `wp_is_maintenance_mode()` function.
if ( ( time() - $upgrading ) >= 10 * MINUTE_IN_SECONDS ) {
return false;
}
return true;
}

/**
Expand Down