View source
<?php
namespace Drupal\gatsby\Form;
use Drupal\Core\Entity\ContentEntityTypeInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Extension\ModuleHandlerInterface;
use Drupal\Core\Form\ConfigFormBase;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\StringTranslation\TranslatableMarkup;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Drupal\gatsby\PathMapping;
class GatsbyAdminForm extends ConfigFormBase {
protected $entityTypeManager;
protected $moduleHandler;
protected $pathMapping;
public function __construct(EntityTypeManagerInterface $entityTypeManager, ModuleHandlerInterface $moduleHandler, PathMapping $pathMapping) {
$this->entityTypeManager = $entityTypeManager;
$this->moduleHandler = $moduleHandler;
$this->pathMapping = $pathMapping;
}
public static function create(ContainerInterface $container) {
return new static($container
->get('entity_type.manager'), $container
->get('module_handler'), $container
->get('gatsby.path_mapping'));
}
protected function getEditableConfigNames() {
return [
'gatsby.settings',
];
}
public function getFormId() {
return 'gatsby_admin_form';
}
public function buildForm(array $form, FormStateInterface $form_state) {
$config = $this
->config('gatsby.settings');
$form['site_settings'] = [
'#type' => 'fieldset',
'#title' => $this
->t('Site settings'),
'#desription' => $this
->t('In a Gatsby Cloud account these details may be found on the "Site Settings" section of the dashboard.'),
];
$form['site_settings']['server_url'] = [
'#type' => 'textfield',
'#title' => $this
->t('Gatsby Server URL'),
'#description' => $this
->t('The URL to the Gatsby server (with port number if needed). Separate multiple values with a comma.<br />For Gatsby Cloud accounts this will be a URL in the format https://example12345.gatsbyjs.io.'),
'#default_value' => $config
->get('server_url'),
'#required' => TRUE,
'#maxlength' => 250,
'#weight' => 0,
];
$form['site_settings']['preview_callback_url'] = [
'#type' => 'textfield',
'#title' => $this
->t('Preview Webhook URL(s)'),
'#description' => $this
->t('The URL to the Gatsby preview build webhook (if running locally, it\'s "localhost:8000/__refresh"). Separate multiple values with a comma.'),
'#default_value' => $config
->get('preview_callback_url'),
'#required' => TRUE,
'#maxlength' => 250,
'#weight' => 0,
];
$form['site_settings']['incrementalbuild_url'] = [
'#type' => 'textfield',
'#title' => $this
->t("Build Webhook URL(s)"),
'#description' => $this
->t('The Callback URL to trigger the Gatsby Build. Multiple build server URLS can be separated by commas. Note: Incremental builds are currently only supported with JSON:API and gatsby-source-drupal.'),
'#default_value' => $config
->get('incrementalbuild_url'),
'#maxlength' => 250,
'#weight' => 1,
];
$form['content_advanced'] = [
'#type' => 'fieldset',
'#title' => $this
->t('Content / path mapping'),
];
$form['content_advanced']['path_mapping'] = [
'#type' => 'textarea',
'#title' => $this
->t('Preview Server Path Mapping'),
'#description' => $this
->t('If you do any path manipulation in your Gatsby site you may need to map the preview iframe and preview button to this correct path. For instance, you may have a /home path in Drupal that maps to / on your Gatsby site. Enter the Drupal path on the left (starting with a "/") and the Gatsby path on the right (starting with a "/") separated by a "|" character. For example: "/home|/". Enter one path mapping per line.'),
'#default_value' => $config
->get('path_mapping'),
];
$form['data_selection'] = [
'#type' => 'fieldset',
'#title' => $this
->t('Data selection'),
];
$form['data_selection']['build_published'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Only trigger builds for published content'),
'#description' => $this
->t('Depending on your content workflow, you may only want builds to be triggered for published content. By checking this box only published content will trigger a build. This means additional entities such as Media or Files will not trigger a rebuild until the content it\'s attached to is published. The downside is that this will only allow content entities to trigger a rebuild.'),
'#default_value' => $config
->get('build_published') !== NULL ? $config
->get('build_published') : TRUE,
'#weight' => 2,
];
$form['data_selection']['preview_entity_types'] = [
'#type' => 'checkboxes',
'#options' => $this
->getContentEntityTypes(),
'#default_value' => $config
->get('preview_entity_types') ?: [],
'#title' => $this
->t('Entity types to send to Gatsby Preview and Build Server'),
'#description' => $this
->t('What entities should be sent to the Gatsby Preview and Build Server?'),
'#weight' => 10,
];
$form['advanced'] = [
'#type' => 'fieldset',
'#title' => $this
->t('Advanced settings'),
];
$form['advanced']['log_json'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Create log messages of JSON objects sent to the Gatsby preview server'),
'#description' => $this
->t('By checking this box, log messages will be created every time a POST request is sent to the Gatsby preview server. Useful for debugging the JSON object data that gets sent to Gatsby.<br /><strong>Note: this may have security implications, esure that only trusted users can access the logged messages. Should not be used on a production environment.</strong.'),
'#default_value' => $config
->get('log_json'),
'#weight' => 3,
];
return parent::buildForm($form, $form_state);
}
public function validateForm(array &$form, FormStateInterface $form_state) {
parent::validateForm($form, $form_state);
$this
->validateCsvUrl('server_url', $this
->t('Invalid Gatsby preview server URL.'), $form_state);
$this
->validateCsvUrl('preview_callback_url', $this
->t('Invalid Gatsby preview callback URL.'), $form_state);
$path_mapping = $form_state
->getValue('path_mapping');
try {
$map = PathMapping::parsePathMapping($path_mapping);
if (strlen(trim($path_mapping)) > 0 && count($map) === 0) {
$form_state
->setErrorByName('path_mapping', $this
->t('Invalid preview server path mapping.'));
}
} catch (\Error $e) {
$form_state
->setErrorByName('path_mapping', $this
->t('Invalid preview server path mapping.'));
}
$incremental_build_url = $form_state
->getValue('incrementalbuild_url');
if (strlen($incremental_build_url) > 0 and !filter_var($incremental_build_url, FILTER_VALIDATE_URL)) {
$form_state
->setErrorByName('incrementalbuild_url', $this
->t('Invalid incremental build URL.'));
}
}
protected function validateCsvUrl(string $field_name, TranslatableMarkup $error, FormStateInterface $form_state) : void {
$urls = array_map('trim', explode(',', $form_state
->getValue($field_name)));
foreach ($urls as $url) {
if (strlen($url) > 0 and !filter_var($url, FILTER_VALIDATE_URL)) {
$form_state
->setErrorByName($field_name, $error);
}
}
}
public function submitForm(array &$form, FormStateInterface $form_state) {
parent::submitForm($form, $form_state);
$this
->config('gatsby.settings')
->set('server_url', $form_state
->getValue('server_url'))
->set('preview_callback_url', $form_state
->getValue('preview_callback_url'))
->set('incrementalbuild_url', $form_state
->getValue('incrementalbuild_url'))
->set('build_published', $form_state
->getValue('build_published'))
->set('preview_entity_types', array_values(array_filter($form_state
->getValue('preview_entity_types'))))
->set('path_mapping', $form_state
->getValue('path_mapping'))
->set('log_json', $form_state
->getValue('log_json'))
->save();
}
private function getContentEntityTypes() {
$content_entity_types = [];
$allEntityTypes = $this->entityTypeManager
->getDefinitions();
foreach ($allEntityTypes as $entity_type_id => $entity_type) {
if ($entity_type instanceof ContentEntityTypeInterface && $entity_type_id !== 'gatsby_log_entity') {
$content_entity_types[$entity_type_id] = $entity_type
->getLabel();
}
}
return $content_entity_types;
}
}