@amazeelabs/silverback-campaign-urls 1.0.10

package/drupal/silverback_campaign_urls/graphql/silverback_campaign_urls.base.graphqls

@@ -0,0 +1,6 @@
+type CampaignUrl @entity(type: "campaign_url", bundle: "campaign_url") {
+  source: String! @resolveProperty(path: "campaign_url_source.value")
+  destination: String! @resolveProperty(path: "campaign_url_destination.value")
+  statusCode: Int! @resolveProperty(path: "status_code.value")
+  force: Boolean! @resolveProperty(path: "force.value")
+}

package/drupal/silverback_campaign_urls/silverback_campaign_urls.info.yml

@@ -0,0 +1,10 @@
+name: Silverback Campaign Urls
+type: module
+description:
+  'Allows creating campaign url entities that can be afterwards exposed via
+  graphql, as redirects.'
+package: Silverback
+core: 8.x
+dependencies:
+  - graphql_directives:graphql_directives
+core_version_requirement: ^8 || ^9 || ^10 || ^11

package/drupal/silverback_campaign_urls/silverback_campaign_urls.links.action.yml

@@ -0,0 +1,5 @@
+campaign_url.add:
+  route_name: campaign_url.add
+  title: 'Add campaign url'
+  appears_on:
+    - 'campaign_url.list'

package/drupal/silverback_campaign_urls/silverback_campaign_urls.links.menu.yml

@@ -0,0 +1,12 @@
+campaign_url.list:
+  title: 'Campaign URLs'
+  parent: system.admin_config_search
+  description: 'Administer campaign URLs'
+  route_name: campaign_url.list
+  menu_name: admin
+
+campaign_url.add:
+  title: 'Add campaign url'
+  parent: campaign_url.list
+  route_name: campaign_url.add
+  menu_name: admin

package/drupal/silverback_campaign_urls/silverback_campaign_urls.permissions.yml

@@ -0,0 +1,2 @@
+administer campaign urls:
+  title: 'Administer individual campaign URLs'

package/drupal/silverback_campaign_urls/silverback_campaign_urls.routing.yml

@@ -0,0 +1,46 @@
+campaign_url.list:
+  path: '/admin/config/search/campaign_url'
+  defaults:
+    _entity_list: 'campaign_url'
+    _title: 'Campaign URLs'
+  requirements:
+    _permission: 'administer campaign urls'
+
+entity.campaign_url.canonical:
+  path: '/admin/config/search/campaign_url/edit/{campaign_url}'
+  defaults:
+    _entity_form: 'campaign_url.edit'
+    _title: 'Edit campaign URL'
+  requirements:
+    _entity_access: 'campaign_url.update'
+
+campaign_url.add:
+  path: '/admin/config/search/campaign_url/add'
+  defaults:
+    _entity_form: 'campaign_url.default'
+    _title: 'Add campaign URL'
+  requirements:
+    _entity_create_access: 'campaign_url'
+
+entity.campaign_url.edit_form:
+  path: '/admin/config/search/campaign_url/edit/{campaign_url}'
+  defaults:
+    _entity_form: 'campaign_url.edit'
+    _title: 'Edit campaign URL'
+  requirements:
+    _entity_access: 'campaign_url.update'
+
+entity.campaign_url.delete_form:
+  path: '/admin/config/search/campaign_url/delete/{campaign_url}'
+  defaults:
+    _entity_form: 'campaign_url.delete'
+    _title: 'Delete campaign URL'
+  requirements:
+    _entity_access: 'campaign_url.delete'
+
+entity.campaign_url.multiple_delete_confirm:
+  path: '/admin/config/search/campaign_url/delete'
+  defaults:
+    _form: '\Drupal\silverback_campaign_urls\Form\CampaignUrlDeleteMultipleForm'
+  requirements:
+    _permission: 'administer campaign urls'

package/drupal/silverback_campaign_urls/src/CampaignUrlAccessControlHandler.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace Drupal\silverback_campaign_urls;
+
+use Drupal\Core\Access\AccessResult;
+use Drupal\Core\Entity\EntityAccessControlHandler;
+use Drupal\Core\Entity\EntityInterface;
+use Drupal\Core\Session\AccountInterface;
+
+class CampaignUrlAccessControlHandler extends EntityAccessControlHandler {
+
+  /**
+   * {@inheritDoc}
+   */
+  public function access(EntityInterface $entity, $operation, ?AccountInterface $account = NULL, $return_as_object = FALSE) {
+    $account = $this->prepareUser($account);
+    if ($operation === 'view label' && !$this->viewLabelOperation) {
+      $operation = 'view';
+    }
+    // Everyone with the "access content" permission should be able to view
+    // the campaign URLs (redirects), otherwise they won't be accessible via
+    // graphql.
+    if ($operation === 'view' && $account->hasPermission('access content')) {
+      $result = AccessResult::allowed()->cachePerPermissions();
+      return $return_as_object ? $result : $result->isAllowed();
+    }
+    return parent::access($entity, $operation, $account, TRUE);
+  }
+}

package/drupal/silverback_campaign_urls/src/Entity/CampaignUrl.php

@@ -0,0 +1,179 @@
+<?php
+
+namespace Drupal\silverback_campaign_urls\Entity;
+
+use Drupal\Core\Entity\ContentEntityBase;
+use Drupal\Core\Entity\EntityChangedTrait;
+use Drupal\Core\Entity\EntityStorageInterface;
+use Drupal\Core\Entity\EntityTypeInterface;
+use Drupal\Core\Field\BaseFieldDefinition;
+
+/**
+ * The campaign URL entity class.
+ *
+ * @ContentEntityType(
+ *   id = "campaign_url",
+ *   label = @Translation("Campaign URL"),
+ *   handlers = {
+ *     "list_builder" = "Drupal\silverback_campaign_urls\Entity\CampaignUrlListBuilder",
+ *     "access" = "Drupal\silverback_campaign_urls\CampaignUrlAccessControlHandler",
+ *     "form" = {
+ *       "default" = "Drupal\silverback_campaign_urls\Form\CampaignUrlForm",
+ *       "delete" = "Drupal\silverback_campaign_urls\Form\CampaignUrlDeleteForm",
+ *       "edit" = "Drupal\silverback_campaign_urls\Form\CampaignUrlForm"
+ *     },
+ *     "views_data" = "Drupal\views\EntityViewsData"
+ *   },
+ *   base_table = "campaign_url",
+ *   translatable = FALSE,
+ *   admin_permission = "administer campaign urls",
+ *   entity_keys = {
+ *     "id" = "cid",
+ *     "label" = "campaign_url_source",
+ *     "uuid" = "uuid",
+ *     "bundle" = "type",
+ *   },
+ *   links = {
+ *     "canonical" = "/admin/config/search/campaign_url/edit/{campaign_url}",
+ *     "delete-form" = "/admin/config/search/campaign_url/delete/{campaign_url}",
+ *     "edit-form" = "/admin/config/search/campaign_url/edit/{campaign_url}",
+ *   },
+ *   constraints = {
+ *     "UniqueCampaignUrlSource" = {}
+ *   }
+ * )
+ */
+class CampaignUrl extends ContentEntityBase implements CampaignUrlInterface {
+  use EntityChangedTrait;
+
+  public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
+    $fields = parent::baseFieldDefinitions($entity_type);
+
+    $fields['campaign_url_source'] = BaseFieldDefinition::create('string')
+      ->setLabel(t('Source'))
+      ->setDescription(t('Please provide the source path for this campaign URL. You can enter an internal path (starting with "/") or an external URL such as https://example.com. However, it can be any arbitrary source path that your hosting provider understands.'))
+      ->setRequired(TRUE)
+      ->setSetting('max_length', 1024)
+      ->setDisplayOptions('form', [
+        'type' => 'string_textfield',
+        'weight' => -5,
+      ])
+      ->setDisplayConfigurable('form', TRUE);
+
+    $fields['campaign_url_destination'] = BaseFieldDefinition::create('string')
+      ->setLabel(t('Destination'))
+      ->setDescription(t('Same as <em>Source</em>, you can enter an internal path (starting with "/") or an external URL such as https://example.com. However, it can be any destination path that your hosting provider understands. If the site is multilingual, the language parameter has to be in the path (e.g.: <em>/en/test</em>)'))
+      ->setRequired(TRUE)
+      ->setSetting('max_length', 1024)
+      ->setDisplayOptions('form', [
+        'type' => 'string_textfield',
+        'weight' => -3,
+      ])
+      ->setDisplayConfigurable('form', TRUE);
+
+    $fields['status_code'] = BaseFieldDefinition::create('integer')
+      ->setLabel(t('Status code'))
+      ->setDescription(t('The campaign url redirect status code.'))
+      ->setDefaultValue(301);
+
+    $fields['force'] = BaseFieldDefinition::create('boolean')
+      ->setLabel(t('Force redirect'))
+      ->setDescription(t('Force the redirect, even if there is already a static file matching the source URL.'))
+      ->setDefaultValue(TRUE)
+      ->setDisplayOptions('form', [
+        'type' => 'boolean_checkbox',
+        'settings' => [
+          'display_label' => TRUE,
+        ],
+      ])
+      ->setDisplayConfigurable('form', TRUE);
+
+    $fields['author'] = BaseFieldDefinition::create('entity_reference')
+      ->setLabel(t('Author'))
+      ->setDescription(t('The user ID of the campaign URl author.'))
+      ->setDefaultValueCallback('\Drupal\silverback_campaign_urls\Entity\CampaignUrl::getCurrentUserId')
+      ->setSettings(array(
+        'target_type' => 'user',
+      ));
+    $fields['edited_by'] = BaseFieldDefinition::create('entity_reference')
+      ->setLabel(t('Edited by'))
+      ->setDescription(t('The user ID of the last person who edited the campaign URL.'))
+      ->setDefaultValueCallback('\Drupal\silverback_campaign_urls\Entity\CampaignUrl::getCurrentUserId')
+      ->setSettings(array(
+        'target_type' => 'user',
+      ));
+
+    $fields['created'] = BaseFieldDefinition::create('created')
+      ->setLabel(t('Created'))
+      ->setDescription(t('The date when the campaign URL was created.'));
+    $fields['changed'] = BaseFieldDefinition::create('changed')
+      ->setLabel(t('Updated'))
+      ->setDescription(t('The date when the campaign URL was last updated.'));
+    return $fields;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function preCreate(EntityStorageInterface $storage, array &$values) {
+    $values += [
+      'type' => 'campaign_url',
+    ];
+  }
+
+  /**
+   * {@inheritDoc}
+   */
+  public function preSave(EntityStorageInterface $storage) {
+    parent::preSave($storage);
+    // On every save, update the value of the editey_by field with the current
+    // user's ID.
+    $this->set('edited_by', static::getCurrentUserId());
+  }
+
+  /**
+   * {@inheritDoc}
+   */
+  public function getStatusCode() {
+    if ($this->get('status_code')->isEmpty()) {
+      return NULL;
+    }
+    return $this->get('status_code')->getValue()[0]['value'];
+  }
+
+  /**
+   * {@inheritDoc}
+   */
+  public function isCampaignRedirectForced() {
+    if ($this->get('force')->isEmpty()) {
+      return FALSE;
+    }
+    return (int) $this->get('force')->getValue()[0]['value'] > 0;
+  }
+
+  /**
+   * {@inheritDoc}
+   */
+  public function getSource() {
+    return $this->get('campaign_url_source')->getValue()[0]['value'];
+  }
+
+  /**
+   * {@inheritDoc}
+   */
+  public function getDestination() {
+    return $this->get('campaign_url_destination')->getValue()[0]['value'];
+  }
+
+  /**
+   * Default value callback for the author and the edite_by fields.
+   *
+   * @see ::baseFieldDefinitions()
+   *
+   * @return array
+   *   An array containing the current user id.
+   */
+  public static function getCurrentUserId() {
+    return array(\Drupal::currentUser()->id());
+  }
+}

package/drupal/silverback_campaign_urls/src/Entity/CampaignUrlInterface.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace Drupal\silverback_campaign_urls\Entity;
+
+use Drupal\Core\Entity\EntityChangedInterface;
+
+interface CampaignUrlInterface extends EntityChangedInterface {
+
+  /**
+   * Returns the status code of the campaign URL.
+   *
+   * @return int
+   */
+  public function getStatusCode();
+
+  /**
+   * Returns true of the campaign URL redirect is forced, false otherwise.
+   *
+   * @return boolean
+   */
+  public function isCampaignRedirectForced();
+
+  /**
+   * Returns the source of the campaign URL.
+   * @return string
+   */
+  public function getSource();
+
+  /**
+   * Returns the destination of the campaign URL.
+   * @return string
+   */
+  public function getDestination();
+}

package/drupal/silverback_campaign_urls/src/Entity/CampaignUrlListBuilder.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace Drupal\silverback_campaign_urls\Entity;
+
+use Drupal\Core\Entity\EntityInterface;
+use Drupal\Core\Entity\EntityListBuilder;
+
+class CampaignUrlListBuilder extends EntityListBuilder {
+
+  /**
+   * {@inheritdoc}
+   */
+  public function buildHeader() {
+    $header['source'] = $this->t('Source');
+    $header['destination'] = $this->t('Destination');
+    $header['status_code'] = $this->t('Status code');
+    $header['force'] = $this->t('Force redirect');
+
+    return $header + parent::buildHeader();
+  }
+
+
+  /**
+   * {@inheritdoc}
+   */
+  public function buildRow(EntityInterface $entity) {
+    if (!$entity instanceof CampaignUrl) {
+      return parent::buildRow($entity);
+    }
+    $row['source'] = $entity->getSource();
+    $row['destination'] = $entity->getDestination();
+    $row['status_code'] = $entity->getStatusCode();
+    $row['force'] = $entity->isCampaignRedirectForced() ? $this->t('Yes') : $this->t('No');
+
+    return $row + parent::buildRow($entity);
+  }
+
+}

package/drupal/silverback_campaign_urls/src/Form/CampaignUrlDeleteForm.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace Drupal\silverback_campaign_urls\Form;
+
+use Drupal\Core\Entity\ContentEntityConfirmFormBase;
+use Drupal\Core\Url;
+use Drupal\Core\Form\FormStateInterface;
+
+class CampaignUrlDeleteForm extends ContentEntityConfirmFormBase {
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getQuestion() {
+    return $this->t('Are you sure you want to delete the campaign URL %source', array('%source' => $this->entity->getSource()));
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getCancelUrl() {
+    return new Url('campaign_url.list');
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getConfirmText() {
+    return $this->t('Delete');
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function submitForm(array &$form, FormStateInterface $form_state) {
+    $this->entity->delete();
+    $this->messenger()->addMessage(t('The campaign URL %source has been deleted.', array('%source' => $this->entity->getSource())));
+    $form_state->setRedirect('campaign_url.list');
+  }
+
+}

package/drupal/silverback_campaign_urls/src/Form/CampaignUrlDeleteMultipleForm.php

@@ -0,0 +1,145 @@
+<?php
+
+namespace Drupal\silverback_campaign_urls\Form;
+
+use Drupal\Core\Entity\EntityTypeManagerInterface;
+use Drupal\Core\Form\ConfirmFormBase;
+use Drupal\Core\Form\FormStateInterface;
+use Drupal\Core\Url;
+use Drupal\Core\TempStore\PrivateTempStoreFactory;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+use Symfony\Component\HttpFoundation\RedirectResponse;
+use Drupal\Core\Session\AccountInterface;
+use Drupal\Core\StringTranslation\TranslationInterface;
+
+/**
+ * Provides a campaign URL deletion confirmation form.
+ */
+class CampaignUrlDeleteMultipleForm extends ConfirmFormBase {
+
+  /**
+   * The array of campaign URLs to delete.
+   *
+   * @var string[][]
+   */
+  protected $campaignURLs = [];
+
+  /**
+   * The private tempstore factory.
+   *
+   * @var \Drupal\Core\TempStore\PrivateTempStoreFactory
+   */
+  protected $privateTempStoreFactory;
+
+  /**
+   * The campaign URL storage.
+   *
+   * @var \Drupal\Core\Entity\EntityStorageInterface
+   */
+  protected $campaignUrlStorage;
+
+  /**
+   * The current user.
+   *
+   * @var \Drupal\Core\Session\AccountInterface
+   */
+  protected $currentUser;
+
+  /**
+   * Constructs a CampaignUrlDeleteMultipleForm object.
+   *
+   * @param \Drupal\Core\TempStore\PrivateTempStoreFactory $temp_store_factory
+   *   The tempstore factory.
+   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
+   *   The entity type manager.
+   * @param \Drupal\Core\Session\AccountInterface $account
+   *   The current user.
+   * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
+   *   The String translation.
+   */
+  public function __construct(
+    PrivateTempStoreFactory $temp_store_factory,
+    EntityTypeManagerInterface $entity_type_manager,
+    AccountInterface $account,
+    TranslationInterface $string_translation
+  ) {
+    $this->privateTempStoreFactory = $temp_store_factory;
+    $this->campaignUrlStorage = $entity_type_manager->getStorage('campaign_url');
+    $this->currentUser = $account;
+    $this->setStringTranslation($string_translation);
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function create(ContainerInterface $container) {
+    return new static(
+      $container->get('tempstore.private'),
+      $container->get('entity_type.manager'),
+      $container->get('current_user'),
+      $container->get('string_translation')
+    );
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getFormId() {
+    return 'campaign_url_multiple_delete_confirm';
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getQuestion() {
+    return $this->formatPlural(count($this->campaignURLs), 'Are you sure you want to delete this campaign URL?', 'Are you sure you want to delete these campaign URLs?');
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getCancelUrl() {
+    return new Url('campaign_url.list');
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getConfirmText() {
+    return $this->t('Delete');
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function buildForm(array $form, FormStateInterface $form_state) {
+    $this->campaignURLs = $this->privateTempStoreFactory->get('campaign_url_multiple_delete_confirm')->get($this->currentUser->id());
+    if (empty($this->campaignURLs)) {
+      return new RedirectResponse($this->getCancelUrl()->setAbsolute()->toString());
+    }
+
+    $form['campaign_urls'] = [
+      '#theme' => 'item_list',
+      '#items' => array_map(function ($campaignURL) {
+        return $campaignURL->label();
+      }, $this->campaignURLs),
+    ];
+    return parent::buildForm($form, $form_state);
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function submitForm(array &$form, FormStateInterface $form_state) {
+
+    if ($form_state->getValue('confirm') && !empty($this->campaignURLs)) {
+      $this->campaignUrlStorage->delete($this->campaignURLs);
+      $this->privateTempStoreFactory->get('campaign_url_multiple_delete_confirm')->delete($this->currentUser->id());
+      $count = count($this->campaignURLs);
+      $this->logger('campaign_url')->notice('Deleted @count campaign URLs.', ['@count' => $count]);
+      $this->messenger()->addMessage($this->stringTranslation->formatPlural($count, 'Deleted 1 campaign URL.', 'Deleted @count campaign URLs.'));
+    }
+    $form_state->setRedirect('campaign_url.list');
+  }
+
+}

package/drupal/silverback_campaign_urls/src/Form/CampaignUrlForm.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace Drupal\silverback_campaign_urls\Form;
+
+use Drupal\Core\Entity\ContentEntityForm;
+use Drupal\Core\Form\FormStateInterface;
+
+class CampaignUrlForm extends ContentEntityForm {
+
+  /**
+   * {@inheritdoc}
+   */
+  public function save(array $form, FormStateInterface $form_state) {
+    parent::save($form, $form_state);
+    $this->messenger()->addMessage(t('The campaign URL has been saved.'));
+    $form_state->setRedirect('campaign_url.list');
+  }
+
+  /**
+   * {@inheritDoc}
+   */
+  public function form(array $form, FormStateInterface $form_state) {
+    $form = parent::form($form, $form_state);
+    /** @var \Drupal\silverback_campaign_urls\Entity\CampaignUrl $campaignUrl */
+    $campaignUrl = $this->entity;
+    $defaultCode = $campaignUrl->getStatusCode() ? $campaignUrl->getStatusCode() : 301;
+    $form['status_code'] = [
+      '#type' => 'select',
+      '#title' => $this->t('Redirect status'),
+      '#description' => $this->t('You can find more information about HTTP redirect status codes at <a href="@status-codes" target="_blank">@status-codes</a>. Additionally, some hosting providers, like Netlify, support also URL rewrites, which means you can assign a 200 status code to redirect rules. Here is some <a href="@rewrite-docs" target="_blank">more documentation</a>.', ['@status-codes' => 'http://en.wikipedia.org/wiki/List_of_HTTP_status_codes#3xx_redirection', '@rewrite-docs' => 'https://docs.netlify.com/routing/redirects/rewrites-proxies']),
+      '#default_value' => $defaultCode,
+      '#options' => [
+        200 => t('200 Rewrite'),
+        300 => t('300 Multiple Choices'),
+        301 => t('301 Moved Permanently'),
+        302 => t('302 Found'),
+        303 => t('303 See Other'),
+        304 => t('304 Not Modified'),
+        305 => t('305 Use Proxy'),
+        307 => t('307 Temporary Redirect'),
+      ]
+    ];
+    return $form;
+  }
+}