Skip to content

feat(setup): allow alternative context key instead of 'web' #16906

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
Ibochkarev wants to merge 1 commit into
base: 3.x
Choose a base branch
from
Open

feat(setup): allow alternative context key instead of 'web' #16906

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
13 changes: 13 additions & 0 deletions setup/cli-install.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<?php

/*
* This file is part of MODX Revolution.
*
Expand Down Expand Up @@ -70,6 +71,10 @@
],
'context_web_path' => dirname($path) . '/',
'context_web_url' => '/',
'context_web_key' => [
'prompt' => 'context_web_key',
'default' => 'web',
],
'core_path' => dirname($path) . '/core/',
'context_mgr_path' => [
'prompt' => 'context_manager_path',
Expand Down Expand Up @@ -180,6 +185,14 @@
}
unset($rmdir);

$contextWebKey = isset($data['context_web_key']) ? trim($data['context_web_key']) : '';
$isInvalidKey = $contextWebKey === ''
|| !preg_match('/^[a-zA-Z0-9_]+$/', $contextWebKey)
|| in_array(strtolower($contextWebKey), ['mgr', 'root'], true);
if ($isInvalidKey) {
$data['context_web_key'] = 'web';
}

// Generate config file
$xml = new SimpleXMLElement('<modx/>');
foreach ($data as $key => $value) {
Expand Down
28 changes: 28 additions & 0 deletions setup/controllers/contexts.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,32 @@
unset($_POST['proceed']);
$webUrl= substr($_SERVER['SCRIPT_NAME'], 0, strpos($_SERVER['SCRIPT_NAME'], 'setup/'));

$contextWebKey = isset($_POST['context_web_key']) ? trim($_POST['context_web_key']) : 'web';
if ($contextWebKey === '') {
$contextWebKey = 'web';
}
$setFormWithError = function ($errorMsg) use ($parser, $contextWebKey, $webUrl) {
$parser->set('context_web_key_error', $errorMsg);
$parser->set('context_web_key', $contextWebKey);
$parser->set('context_web_path', $_POST['context_web_path'] ?? MODX_INSTALL_PATH);
$parser->set('context_web_url', $_POST['context_web_url'] ?? $webUrl);
$connPath = $_POST['context_connectors_path'] ?? MODX_INSTALL_PATH . 'connectors/';
$parser->set('context_connectors_path', $connPath);
$connUrl = $_POST['context_connectors_url'] ?? $webUrl . 'connectors/';
$parser->set('context_connectors_url', $connUrl);
$mgrPath = $_POST['context_mgr_path'] ?? MODX_INSTALL_PATH . 'manager/';
$parser->set('context_mgr_path', $mgrPath);
$parser->set('context_mgr_url', $_POST['context_mgr_url'] ?? $webUrl . 'manager/');
return $parser->render('contexts.tpl');
};
if (!preg_match('/^[a-zA-Z0-9_]+$/', $contextWebKey)) {
return $setFormWithError($install->lexicon('context_web_key_err_invalid'));
}
if (in_array(strtolower($contextWebKey), ['mgr', 'root'], true)) {
return $setFormWithError($install->lexicon('context_web_key_err_reserved'));
}
$_POST['context_web_key'] = $contextWebKey;

$_POST['context_web_path'] = !empty($_POST['context_web_path']) ? rtrim($_POST['context_web_path'],'/').'/' : MODX_INSTALL_PATH;
$_POST['context_web_url'] = !empty($_POST['context_web_url']) ? rtrim($_POST['context_web_url'],'/').'/' : $webUrl;
$_POST['context_mgr_path'] = !empty($_POST['context_mgr_path']) ? rtrim($_POST['context_mgr_path'],'/').'/' : MODX_INSTALL_PATH . 'manager/';
Expand Down Expand Up @@ -59,8 +85,10 @@
$parser->set('context_connectors_url', defined('MODX_CONNECTORS_URL') ? MODX_CONNECTORS_URL : $webUrl . 'connectors/');
$parser->set('context_mgr_path', defined('MODX_MANAGER_PATH') ? MODX_MANAGER_PATH : MODX_INSTALL_PATH . 'manager/');
$parser->set('context_mgr_url', defined('MODX_MANAGER_URL') ? MODX_MANAGER_URL : $webUrl . 'manager/');
$parser->set('context_web_key', $install->settings->get('context_web_key', 'web'));
} else {
$parser->set('context_web_path', MODX_INSTALL_PATH);
$parser->set('context_web_key', $install->settings->get('context_web_key', 'web'));
$parser->set('context_web_url', $webUrl);
$parser->set('context_connectors_path', MODX_INSTALL_PATH . 'connectors/');
$parser->set('context_connectors_url', $webUrl . 'connectors/');
Expand Down
44 changes: 37 additions & 7 deletions setup/includes/new.install.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@

use MODX\Revolution\modAccessContext;
use MODX\Revolution\modAccessPolicy;
use MODX\Revolution\modContext;
use MODX\Revolution\modContextSetting;
use MODX\Revolution\modDocument;
use MODX\Revolution\modResource;
use MODX\Revolution\modSystemSetting;
Expand All @@ -22,6 +24,34 @@
use MODX\Revolution\modUserGroupMember;
use MODX\Revolution\modUserProfile;

$contextWebKey = $install->settings->get('context_web_key', 'web');
if (!preg_match('/^[a-zA-Z0-9_]+$/', $contextWebKey) || in_array(strtolower($contextWebKey), ['mgr', 'root'], true)) {
$contextWebKey = 'web';
}

$defaultContextSetting = $modx->getObject(modSystemSetting::class, ['key' => 'default_context']);
if ($defaultContextSetting) {
$defaultContextSetting->set('value', $contextWebKey);
$defaultContextSetting->save();
}

if ($contextWebKey !== 'web') {
$context = $modx->getObject(modContext::class, ['key' => 'web']);
if ($context) {
$context->set('key', $contextWebKey);
$context->save();
$quotedKey = $modx->quote($contextWebKey);
$ctxSettingTbl = $modx->getTableName(modContextSetting::class);
$modx->exec("UPDATE {$ctxSettingTbl} SET context_key = {$quotedKey} WHERE context_key = 'web'");
$ctxResourceTbl = $modx->getTableName(\MODX\Revolution\modContextResource::class);
$modx->exec("UPDATE {$ctxResourceTbl} SET context_key = {$quotedKey} WHERE context_key = 'web'");
$accessCtxTbl = $modx->getTableName(modAccessContext::class);
$modx->exec("UPDATE {$accessCtxTbl} SET target = {$quotedKey} WHERE target = 'web'");
$resourceTbl = $modx->getTableName(modResource::class);
$modx->exec("UPDATE {$resourceTbl} SET context_key = {$quotedKey} WHERE context_key = 'web'");
}
}

/* add settings_version */
$currentVersion = include MODX_CORE_PATH . 'docs/version.inc.php';

Expand Down Expand Up @@ -109,11 +139,11 @@
/** @var modAccessContext $access */
$access= $modx->newObject(modAccessContext::class);
$access->fromArray([
'target' => 'web',
'principal_class' => modUserGroup::class,
'principal' => 0,
'authority' => 9999,
'policy' => $loadOnly->get('id'),
'target' => $contextWebKey,
'principal_class' => modUserGroup::class,
'principal' => 0,
'authority' => 9999,
'policy' => $loadOnly->get('id'),
]);
$access->save();
unset($access);
Expand Down Expand Up @@ -146,7 +176,7 @@

$access= $modx->newObject(modAccessContext::class);
$access->fromArray([
'target' => 'web',
'target' => $contextWebKey,
'principal_class' => modUserGroup::class,
'principal' => $adminGroup->get('id'),
'authority' => 0,
Expand Down Expand Up @@ -199,7 +229,7 @@
'createdby' => 1,
'hidemenu' => false,
'class_key' => modDocument::class,
'context_key' => 'web',
'context_key' => $contextWebKey,
'content_type' => 1,
]);

Expand Down
1 change: 1 addition & 0 deletions setup/includes/request/modinstallclirequest.class.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,6 +225,7 @@ public function prepareSettings(array &$settings) {
$this->setDefaultSetting('mgr_url',$this->install->settings->get('context_mgr_url'));
$this->setDefaultSetting('web_path',$this->install->settings->get('context_web_path'));
$this->setDefaultSetting('web_url',$this->install->settings->get('context_web_url'));
$this->setDefaultSetting('context_web_key', $this->install->settings->get('context_web_key', 'web'));
$this->setDefaultSetting('assets_path',$this->install->settings->get('context_assets_path',$this->install->settings->get('context_web_path').'assets/'));
$this->setDefaultSetting('assets_url',$this->install->settings->get('context_assets_url',$this->install->settings->get('context_web_url').'assets/'));
}
Expand Down
1 change: 1 addition & 0 deletions setup/includes/request/modinstallrequest.class.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,7 @@ public function setDefaultPaths(array $config = []) {
$defaults = [];
$defaults['context_web_path'] = rtrim(MODX_INSTALL_PATH,'/').'/';
$defaults['context_web_url'] = $webUrl;
$defaults['context_web_key'] = 'web';
$defaults['context_mgr_path'] = rtrim(MODX_INSTALL_PATH,'/') . '/manager/';
$defaults['context_mgr_url'] = $webUrl . 'manager/';
$defaults['context_connectors_path'] = rtrim(MODX_INSTALL_PATH,'/') . '/connectors/';
Expand Down
30 changes: 29 additions & 1 deletion setup/includes/runner/modinstallrunner.class.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,10 @@ public function writeConfig() {
}
$perms = $this->install->settings->get('new_file_permissions', sprintf("%04o", 0666 & (0777 - umask())));
if (is_string($perms)) $perms = octdec($perms);
$chmodSuccess = @ chmod($configFile, $perms);
$chmodSuccess = false;
if ($written) {
$chmodSuccess = @ chmod($configFile, $perms);
}
if ($written) {
$this->addResult(modInstallRunner::RESULT_SUCCESS,'<p class="ok">'.$this->install->lexicon('config_file_written').'</p>');
} else {
Expand All @@ -218,6 +221,31 @@ public function writeConfig() {
return $written;
}

/**
* Writes config.context.php with the web context key.
*
* @return bool
*/
public function writeContextConfig()
{
$contextWebKey = $this->install->settings->get('context_web_key', 'web');
$webPath = $this->install->settings->get('context_web_path');
$contextConfigFile = rtrim($webPath, '/') . '/config.context.php';
$content = '<?php' . "\n" . 'return ' . var_export($contextWebKey, true) . ';' . "\n";
$written = false;
if ($configHandle = @ fopen($contextConfigFile, 'wb')) {
$written = @ fwrite($configHandle, $content);
@ fclose($configHandle);
}
if ($written) {
$perms = $this->install->settings->get('new_file_permissions', sprintf("%04o", 0666 & (0777 - umask())));
if (is_string($perms)) {
$perms = octdec($perms);
}
@ chmod($contextConfigFile, $perms);
}
return (bool) $written;
}

abstract public function execute($mode);
abstract public function initialize();
Expand Down
1 change: 1 addition & 0 deletions setup/includes/runner/modinstallrunnerweb.class.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ public function initialize() {
public function execute($mode) {
/* write config file */
$this->writeConfig();
$this->writeContextConfig();

/* get connection */
$this->install->getConnection($mode);
Expand Down
4 changes: 4 additions & 0 deletions setup/lang/en/default.inc.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,10 @@
$_lang['context_manager_url'] = 'URL for mgr context';
$_lang['context_override'] = 'Leave these disabled to allow the system to auto-determine this information as shown. By enabling a specific value, regardless if you manually set the value, you are indicating that you want the path to be set explicitly to that value in the configuration.';
$_lang['context_web_options'] = '<strong>Web Context Options</strong> (front-end web site)';
$_lang['context_web_key'] = 'Web context key';
$_lang['context_web_key_desc'] = 'Key for the front-end context (letters, numbers, underscores only). Cannot be "mgr" or "root". Default: web';
$_lang['context_web_key_err_invalid'] = 'Invalid context key. Use only letters, numbers, and underscores.';
$_lang['context_web_key_err_reserved'] = 'The keys "mgr" and "root" are reserved.';
$_lang['context_web_path'] = 'Filesystem path for web context';
$_lang['context_web_url'] = 'URL for web context';
$_lang['continue'] = 'Continue';
Expand Down
15 changes: 15 additions & 0 deletions setup/templates/contexts.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,21 @@ Ext.onReady(function() {literal}{{/literal}

<h3>{$_lang.context_web_options}</h3>

<div class="labelHolder">
<div class="context-property">
<div class="context-property_label">
<label for="context_web_key">{$_lang.context_web_key}:</label>
</div>
<div class="context-property_value">
<input type="text" id="context_web_key" name="context_web_key" value="{$context_web_key|default:'web'}" maxlength="100" />
<p class="field_note">{$_lang.context_web_key_desc}</p>
{if $context_web_key_error}
<p class="field_error">{$context_web_key_error}</p>
{/if}
</div>
</div>
</div>

<div class="labelHolder">
<div class="context-property">
<div class="context-property_label">
Expand Down