Skip to content

[4.x] Improve the workflow around enabling Statamic Pro #9435

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
jasonvarga merged 4 commits into from
Jan 31, 2024
Merged

[4.x] Improve the workflow around enabling Statamic Pro #9435

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6a216a3
Add .env var for easy enabling of pro without publishing config.
jesseleite Jan 31, 2024
cd78aa4
Add `please pro:enable` command.
jesseleite Jan 31, 2024
c02d767
Register command.
jesseleite Jan 31, 2024
b570a91
If editions config is not referencing the new .env var, instruct user.
jesseleite Jan 31, 2024
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
2 changes: 1 addition & 1 deletion config/editions.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

return [

'pro' => false,
'pro' => env('STATAMIC_PRO_ENABLED', false),

'addons' => [
//
Expand Down
138 changes: 138 additions & 0 deletions src/Console/Commands/ProEnable.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
<?php

namespace Statamic\Console\Commands;

use Illuminate\Console\Command;
use Illuminate\Console\ConfirmableTrait;
use Statamic\Console\EnhancesCommands;
use Statamic\Console\RunsInPlease;

class ProEnable extends Command
{
use ConfirmableTrait, EnhancesCommands, RunsInPlease;

/**
* The name and signature of the console command.
*
* @var string
*/
protected $signature = 'statamic:pro:enable
{ --force : Force the operation to run when in production }';

/**
* The console command description.
*
* @var string
*/
protected $description = 'Enable Statamic Pro in .env';

/**
* Execute the console command.
*
* @return void
*/
public function handle()
{
if (! $this->setProInEnvironmentFile()) {
return;
}

$this->laravel['config']['statamic.editions.pro'] = true;

$this->checkInfo('Statamic Pro successfully enabled in .env file!');

if ($this->configNotReferencingEnv()) {
$this->crossLine('Statamic editions config not currently referencing .env file.');
$this->comment(PHP_EOL.'For this setting to take effect, please modify your [config/statamic/editions.php] as follows:');
$this->line("'pro' => env('STATAMIC_PRO_ENABLED', false)");
}
}

/**
* Set to pro in the environment file.
*
* @return bool
*/
protected function setProInEnvironmentFile()
{
if (! $this->confirmToProceed()) {
return false;
}

if ($this->proEnvVarExists()) {
$this->ensureProInEnv();
} else {
$this->appendProToEnv();
}

return true;
}

/**
* Check whether the pro env var already exists.
*
* @return bool
*/
protected function proEnvVarExists()
{
return preg_match('/^STATAMIC_PRO_ENABLED=/m', $this->envContents());
}

/**
* Ensure pro in .env file.
*
* @return void
*/
protected function ensureProInEnv()
{
file_put_contents($this->envPath(), preg_replace(
'/^STATAMIC_PRO_ENABLED=.*$/m',
'STATAMIC_PRO_ENABLED=true',
$this->envContents()
));
}

/**
* Append pro to end of .env file.
*
* @return void
*/
protected function appendProToEnv()
{
file_put_contents($this->envPath(), $this->envContents()."\nSTATAMIC_PRO_ENABLED=true");
}

/**
* Get app .env path.
*
* @return string
*/
protected function envPath()
{
return $this->laravel->environmentFilePath();
}

/**
* Get app .env contents.
*
* @return string
*/
protected function envContents()
{
return file_get_contents($this->envPath());
}

/**
* Check whether the editions config is referencing the .env var.
*
* @return bool
*/
protected function configNotReferencingEnv()
{
if (! file_exists($configPath = config_path('statamic/editions.php'))) {
return false;
}

return ! preg_match('/[\'"]pro[\'"]\s*=>\s*env\([\'"]STATAMIC_PRO_ENABLED[\'"]/m', file_get_contents($configPath));
}
}
1 change: 1 addition & 0 deletions src/Providers/ConsoleServiceProvider.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ class ConsoleServiceProvider extends ServiceProvider
Commands\ImportGroups::class,
Commands\ImportRoles::class,
Commands\ImportUsers::class,
Commands\ProEnable::class,
];

public function boot()
Expand Down