enableGql config setting

Resolves #4836
craftcms · Aug 29, 2019 · 859e990 · 859e990
1 parent e7827b0
commit 859e990
Show file tree

Hide file tree

Showing 5 changed files with 39 additions and 4 deletions.
diff --git a/CHANGELOG-v3.md b/CHANGELOG-v3.md
@@ -3,6 +3,7 @@
 ## Unreleased
 
 ### Added
+- Added the `enableGql` config setting. ([#4836](https://github.com/craftcms/cms/issues/4836))
 - Added the `children` field to the `EntryInterface` and `CategoryInterface` GraphQL types. ([#4843](https://github.com/craftcms/cms/issues/4843))
 - Added the `markdown` GraphQL directive. ([#4832](https://github.com/craftcms/cms/issues/4832))
 

diff --git a/docs/config/config-settings.md b/docs/config/config-settings.md
@@ -835,6 +835,28 @@ Whether to enable CSRF protection via hidden form inputs for all forms submitted
 
 
 
+### `enableGql`
+
+Allowed types
+
+:   [boolean](http://php.net/language.types.boolean)
+
+Default value
+
+:   `true`
+
+Defined by
+
+:   [GeneralConfig::$enableGql](api:craft\config\GeneralConfig::$enableGql)
+
+
+
+Whether the GraphQL API should be enabled.
+
+Note that the GraphQL API is only available for Craft Pro.
+
+
+
 ### `enableTemplateCaching`
 
 Allowed types

diff --git a/src/config/GeneralConfig.php b/src/config/GeneralConfig.php
@@ -282,6 +282,12 @@ class GeneralConfig extends BaseObject
      * @see enableCsrfProtection
      */
     public $enableCsrfCookie = true;
+    /**
+     * @var bool Whether the GraphQL API should be enabled.
+     *
+     * Note that the GraphQL API is only available for Craft Pro.
+     */
+    public $enableGql = true;
     /**
      * @var mixed The amount of time a user’s elevated session will last, which is required for some sensitive actions (e.g. user group/permission assignment).
      *

diff --git a/src/controllers/GraphqlController.php b/src/controllers/GraphqlController.php
@@ -21,8 +21,6 @@
 use yii\web\NotFoundHttpException;
 use yii\web\Response;
 
-Craft::$app->requireEdition(Craft::Pro);
-
 /**
  * The GqlController class is a controller that handles various GraphQL related tasks.
  *
@@ -43,9 +41,16 @@ class GraphqlController extends Controller
 
     /**
      * @inheritdoc
+     * @throws NotFoundHttpException
      */
     public function beforeAction($action)
     {
+        if (!Craft::$app->getConfig()->getGeneral()->enableGql) {
+            throw new NotFoundHttpException(Craft::t('yii', 'Page not found.'));
+        }
+
+        Craft::$app->requireEdition(Craft::Pro);
+
         if ($action->id === 'api') {
             $this->enableCsrfValidation = false;
         }

diff --git a/src/web/twig/variables/Cp.php b/src/web/twig/variables/Cp.php
@@ -112,6 +112,7 @@ public function nav(): array
     {
         $craftPro = Craft::$app->getEdition() === Craft::Pro;
         $isAdmin = Craft::$app->getUser()->getIsAdmin();
+        $generalConfig = Craft::$app->getConfig()->getGeneral();
 
         $navItems = [
             [
@@ -194,7 +195,7 @@ public function nav(): array
         }
 
         if ($isAdmin) {
-            if ($craftPro) {
+            if ($craftPro && $generalConfig->enableGql) {
                 $navItems[] = [
                     'label' => Craft::t('app', 'GraphQL'),
                     'url' => 'graphql',
@@ -212,7 +213,7 @@ public function nav(): array
                 ];
             }
 
-            if (Craft::$app->getConfig()->getGeneral()->allowAdminChanges) {
+            if ($generalConfig->allowAdminChanges) {
                 $navItems[] = [
                     'url' => 'settings',
                     'label' => Craft::t('app', 'Settings'),