Skip to content

[Feature] Allow disabling the backend for a content freeze. #478

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
merged 1 commit into from
Jun 2, 2025
Merged

[Feature] Allow disabling the backend for a content freeze. #478

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions config/custom.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
return [
// Custom settings
'*' => [
'maintenanceMode' => false,
'cse' => [
'nl' => 'test-nl',
'fr' => 'test-fr',
Expand Down
38 changes: 38 additions & 0 deletions modules/statik/src/Statik.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

use Craft;
use craft\console\Application as ConsoleApplication;
use craft\elements\User;
use craft\events\RegisterComponentTypesEvent;
use craft\events\RegisterCpNavItemsEvent;
use craft\events\RegisterTemplateRootsEvent;
Expand All @@ -12,6 +13,8 @@
use craft\helpers\Assets;
use craft\i18n\PhpMessageSource;
use craft\services\Fields;
use craft\web\Application;
use craft\web\Response;
use craft\web\twig\variables\Cp;
use craft\web\twig\variables\CraftVariable;
use craft\web\View;
Expand All @@ -29,6 +32,7 @@
use verbb\formie\fields\formfields;
use yii\base\Event;
use yii\base\Module;
use yii\web\HttpException;

/**
* Class Statik
Expand Down Expand Up @@ -88,6 +92,40 @@ public function init(): void
parent::init();
self::$instance = $this;

Event::on(User::class, User::EVENT_BEFORE_AUTHENTICATE, function($event) {
if (Craft::$app->request->getIsCpRequest() && Craft::$app->config->custom->maintenanceMode) {
throw new HttpException(503, 'The control panel is temporarily locked for maintenance.');
}
});

Event::on(
Application::class,
Application::EVENT_BEFORE_REQUEST,
function() {
$request = Craft::$app->getRequest();
if ($request->getIsCpRequest() && Craft::$app->config->custom->maintenanceMode) {
$path = $request->getPathInfo();

// INFO: Allow the login page and the action that actually processes login, logout. This way we can show a clear error message to the user.
$allowedPaths = [
'login', // GET login page
'logout',
'actions/users/login', // POST login action
];

$path = trim($path, '/');
$isAllowed = in_array($path, $allowedPaths, true);

if (!$isAllowed) {
/** @var Response $response */
$response = Craft::$app->getResponse();
$response->redirect('/admin/logout');
$response->send();
exit;
}
}
}
);

// Add in our console commands
if (Craft::$app instanceof ConsoleApplication) {
Expand Down