Add new reserved keys for Contexts

Adds "root" to already protected set of keys ("mgr" and "web")
modxcms · Sep 20, 2023 · fae37d3 · fae37d3
1 parent c948618
commit fae37d3
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 6 deletions.
diff --git a/core/lexicon/en/context.inc.php b/core/lexicon/en/context.inc.php
@@ -18,6 +18,7 @@
 $_lang['context_err_ns'] = 'Context not specified.';
 $_lang['context_err_ns_key'] = 'Please specify a valid key for the Context.';
 $_lang['context_err_remove'] = 'An error occurred while trying to delete the Context.';
+$_lang['context_err_reserved'] = 'The Context key you chose is reserved for system use only. Please specify a different key.';
 $_lang['context_err_save'] = 'An error occurred while saving the Context.';
 $_lang['context_id'] = 'Ctx ID';
 $_lang['context_key'] = 'Context Key';

diff --git a/core/src/Revolution/Processors/Context/Create.php b/core/src/Revolution/Processors/Context/Create.php
@@ -1,4 +1,5 @@
 <?php
+
 /*
  * This file is part of the MODX Revolution package.
  *
@@ -10,7 +11,6 @@
 
 namespace MODX\Revolution\Processors\Context;
 
-
 use MODX\Revolution\modAccessContext;
 use MODX\Revolution\modAccessPolicy;
 use MODX\Revolution\modContext;
@@ -35,15 +35,24 @@ class Create extends CreateProcessor
     public function beforeSave()
     {
         $key = $this->getProperty('key');
-        if (empty($key)) {
-            $this->addFieldError('key', $this->modx->lexicon('context_err_ns_key'));
+
+        switch (true) {
+            case empty($key):
+                $this->addFieldError('key', $this->modx->lexicon('context_err_ns_key'));
+                break;
+            case in_array($key, $this->classKey::RESERVED_KEYS):
+                $this->addFieldError('key', $this->modx->lexicon('context_err_reserved'));
+                break;
+            case $this->alreadyExists($key):
+                $this->addFieldError('key', $this->modx->lexicon('context_err_ae'));
+            // no default
         }
-        if ($this->alreadyExists($key)) {
-            $this->addFieldError('key', $this->modx->lexicon('context_err_ae'));
+        if ($this->hasErrors()) {
+            return false;
         }
         $this->object->set('key', $key);
 
-        return !$this->hasErrors();
+        return true;
     }
 
     /**

diff --git a/core/src/Revolution/modContext.php b/core/src/Revolution/modContext.php
@@ -23,6 +23,13 @@
  */
 class modContext extends modAccessibleObject
 {
+    /**
+     * A set of Context keys that are restricted to system use only
+     *
+     *  @var array RESERVED_KEYS
+     */
+    public const RESERVED_KEYS = ['mgr', 'web', 'root'];
+
     /**
      * An array of configuration options for this context
      *