ModalPageService.php in Modal 5.0.x

Namespace

Drupal\modal_page\Service

File

src/Service/ModalPageService.php

<?php

namespace Drupal\modal_page\Service;

use Drupal\Component\Utility\Xss;
use Drupal\Component\Uuid\UuidInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Language\LanguageManagerInterface;
use Drupal\Core\Path\PathMatcherInterface;
use Drupal\Core\StringTranslation\StringTranslationTrait;
use Symfony\Component\HttpFoundation\RequestStack;
use Drupal\Core\Session\AccountProxyInterface;
use Drupal\Core\Database\Connection;
use Drupal\Core\Config\ConfigFactoryInterface;
use Drupal\Component\Utility\Html;
use Drupal\path_alias\AliasManagerInterface;

/**
 * Modal Page Service Class.
 */
class ModalPageService {
  use StringTranslationTrait;

  /**
   * The UUID service.
   *
   * @var \Drupal\Component\Uuid\UuidInterface
   */
  protected $uuidService;

  /**
   * The language manager.
   *
   * @var \Drupal\Core\Language\LanguageManagerInterface
   */
  protected $languageManager;

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Path Matcher.
   *
   * @var \Drupal\Core\Path\PathMatcherInterface
   */
  protected $pathMatcher;

  /**
   * The current request.
   *
   * @var \Symfony\Component\HttpFoundation\Request
   */
  protected $request;

  /**
   * The config factory.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;

  /**
   * The database connection.
   *
   * @var \Drupal\Core\Database\Connection
   */
  protected $database;

  /**
   * The user current.
   *
   * @var \Drupal\Core\Session\AccountProxyInterface
   */
  protected $currentUser;

  /**
   * The path alias manager.
   *
   * @var \Drupal\path_alias\AliasManagerInterface
   */
  protected $aliasManager;

  /**
   * Construct of Modal Page service.
   */
  public function __construct(LanguageManagerInterface $language_manager, EntityTypeManagerInterface $entity_manager, ConfigFactoryInterface $config_factory, Connection $database, RequestStack $request_stack, PathMatcherInterface $path_matcher, UuidInterface $uuid_service, AccountProxyInterface $current_user, AliasManagerInterface $alias_manager) {
    $this->languageManager = $language_manager;
    $this->entityTypeManager = $entity_manager;
    $this->pathMatcher = $path_matcher;
    $this->request = $request_stack
      ->getCurrentRequest();
    $this->configFactory = $config_factory;
    $this->database = $database;
    $this->uuidService = $uuid_service;
    $this->currentUser = $current_user;
    $this->aliasManager = $alias_manager;
  }

  /**
   * Function to check Modal will show.
   */
  public function checkModalToShow() {
    $modalToShow = $this
      ->getModalToShow();
    if (empty($modalToShow)) {
      return FALSE;
    }
    $button = $this
      ->t('OK');
    if (!empty($modalToShow
      ->getOkLabelButton())) {
      $button = $this
        ->clearText($modalToShow
        ->getOkLabelButton());
    }
    $body = '';

    // Check body by string.
    if (gettype($modalToShow
      ->getBody() == 'string' && !empty($modalToShow
      ->getBody()))) {
      $body = $modalToShow
        ->getBody();
    }

    // Check by array.
    if (!empty($modalToShow
      ->getBody()['value'])) {
      $body = $modalToShow
        ->getBody()['value'];
    }
    $result = [
      'id' => $modalToShow
        ->id(),
      'title' => $this
        ->clearText($modalToShow
        ->label()),
      'text' => $this
        ->getAutheticatedUserName($this
        ->clearText($body)),
      'delay_display' => $modalToShow
        ->getDelayDisplay(),
      'modal_size' => $modalToShow
        ->getModalSize(),
      'button' => $button,
      'do_not_show_again' => empty($modalToShow
        ->getDontShowAgainLabel()) ? $this
        ->t("Don't show again") : $modalToShow
        ->getDontShowAgainLabel(),
      'close_modal_esc_key' => $modalToShow
        ->getCloseModalEscKey() == 1 ? 'true' : "false",
      'close_modal_clicking_outside' => $modalToShow
        ->getCloseModalClickingOutside() == 1 ? "true" : "static",
      'open_modal_on_element_click' => $modalToShow
        ->getOpenModalOnElementClick(),
      'auto_open' => $modalToShow
        ->getAutoOpen(),
    ];
    if ($modalToShow
      ->getEnableDontShowAgainOption() == FALSE) {
      unset($result['do_not_show_again']);
    }
    return $result;
  }

  /**
   * Get modal to show.
   *
   * @return object
   *   Return the modal to show.
   */
  public function getModalToShow() {
    $modalToShow = FALSE;
    $currentPath = $this
      ->getCurrentPath();
    $parameters = $this->request->query
      ->all();
    $modalParameter = empty($parameters['modal']) ? FALSE : Html::escape($parameters['modal']);
    if (!empty($modalParameter)) {
      $modalParameter = $this
        ->clearText($modalParameter);
    }

    // We need to use Depency Injection on this. @codingStandardsIgnoreLine.
    $modals = \Drupal::entityTypeManager()
      ->getStorage('modal')
      ->loadMultiple();
    foreach ($modals as $modal) {
      if (empty($modal
        ->getPublished())) {
        continue;
      }
      if (empty($modal
        ->getType())) {
        continue;
      }
      $modalType = $modal
        ->getType();
      switch ($modalType) {
        case 'page':
          $modalToShow = $this
            ->getModalToShowByPage($modal, $currentPath);
          break;
        case 'parameter':
          $modalToShow = $this
            ->getModalToShowByParameter($modal, $modalParameter);
          break;
      }

      // Return Modal if there isn't restriction configured or if user has
      // permission.
      if (!empty($modalToShow) && $this
        ->checkUserHasPermissionOnModal($modalToShow)) {
        return $modalToShow;
      }
    }
    return FALSE;
  }

  /**
   * Check if the Current User has Permission to Access Modal.
   */
  public function checkUserHasPermissionOnModal($modal) {
    if (empty($modal
      ->getRoles())) {
      return TRUE;
    }

    /** @var \Drupal\user\Entity\User $user */
    $user = $this->entityTypeManager
      ->getStorage('user')
      ->load($this->currentUser
      ->id());
    if (empty($user) || empty($modal
      ->getRoles())) {
      return FALSE;
    }
    $roles = $modal
      ->getRoles();
    foreach ($roles as $roleId => $role) {
      if (!empty($roleId) && $user
        ->hasRole($roleId)) {
        return TRUE;
      }
    }
    return FALSE;
  }

  /**
   * Apply the filter on text.
   */
  public function clearText($text) {
    if (empty(is_string($text))) {
      $text = (string) $text;
    }
    $text = Xss::filter($text, $this
      ->getAllowTags());
    return trim($text);
  }

  /**
   * Get user name authenticate.
   *
   * @param string $text
   *   The body text of modal.
   *
   * @return string
   *   The text with user name or visitor text.
   */
  public function getAutheticatedUserName($text) : string {
    if ($this->currentUser
      ->isAuthenticated()) {
      return str_replace('@user_name@', $this->currentUser
        ->getAccountName(), $text);
    }
    return str_replace('@user_name@', $this
      ->t('visitor'), $text);
  }

  /**
   * Get the current path.
   *
   * @return string
   *   The current path.
   */
  public function getCurrentPath() : string {

    // $currentPath = ltrim($this->request->getRequestUri(), '/');.
    $currentPath = $this->request
      ->getRequestUri();
    if ($this->pathMatcher
      ->isFrontPage()) {
      $currentPath = '<front>';
    }
    return $currentPath;
  }

  /**
   * Get the modal by page.
   *
   * @param object $modal
   *   The object modal.
   * @param string $currentPath
   *   The current path.
   *
   * @return object
   *   Retunr the modal.
   */
  public function getModalToShowByPage($modal, $currentPath) {
    $pages = $modal
      ->getPages();
    $pages = explode(PHP_EOL, $pages);
    $currentPath = mb_strtolower($currentPath);
    foreach ($pages as $page) {
      $path = mb_strtolower($page);
      if ($path != '<front>') {
        $path = Xss::filter($path);
      }

      // $path = ltrim(trim($path), '/');.
      $path = trim($path);
      $currentPath = $this->aliasManager
        ->getPathByAlias($currentPath);
      if ($currentPath == $path || $path == NULL) {
        return $modal;
      }

      // Check wildcard.
      if (strpos($path, '*') === FALSE) {
        return FALSE;
      }
      $path = str_replace('/*', '', $path);
      $path = str_replace('*', '', $path);
      if (strpos($currentPath, $path) === 0) {
        return $modal;
      }
    }
  }

  /**
   * Get the modal by parameter.
   *
   * @param object $modal
   *   The object modal.
   * @param string $modalParamenter
   *   The string text of parameters.
   *
   * @return bool
   *   Return modal or false.
   */
  public function getModalToShowByParameter($modal, $modalParamenter) {
    $parameters = $modal
      ->getParameters();
    $parameters = explode(PHP_EOL, $parameters);
    foreach ($parameters as $parameter) {
      $parameter = trim($parameter);
      if ($modalParamenter == $parameter) {
        return $modal;
      }
    }
    return FALSE;
  }

  /**
   * Allowed tags on modal page.
   *
   * @return array
   *   Return the tags allowed.
   */
  public function getAllowTags() : array {
    $config = $this->configFactory
      ->get('modal_page.settings');
    $allowed_tags = $config
      ->get('allowed_tags') ?? "h1,h2,a,b,big,code,del,em,i,ins,pre,q,small,span,strong,sub,sup,tt,ol,ul,li,p,br,img";
    $tags = explode(",", $allowed_tags);
    return $tags;
  }

  /**
   * Get ids modal.
   *
   * @param string $currentPath
   *   Current path.
   * @param string $modalParameter
   *   Parameter for show modal.
   *
   * @return mixed
   *   Return ids list.
   */
  protected function getModalIds(string $currentPath, string $modalParameter) {
    $query = $this->entityTypeManager
      ->getStorage('modal_page_modal')
      ->getQuery();
    if ($modalParameter) {
      $query
        ->condition('parameters', '%' . $modalParameter . '%', 'like');
    }
    else {
      $currentPath = $this->aliasManager
        ->getPathByAlias($currentPath);
      $groupCondition = $query
        ->orConditionGroup();

      // Get all itens with wildcard.
      $groupCondition
        ->condition('pages', '%*%', 'like');

      // Get all with current path.
      $groupCondition
        ->condition('pages', '%' . $currentPath . '%', 'like');

      // Get all with NULL (all pages).
      $groupCondition
        ->condition('pages', NULL, 'IS');
      $query
        ->condition($groupCondition);
    }
    if (!empty($this->languageManager
      ->getCurrentLanguage()
      ->getId())) {
      $lang_code = $this->languageManager
        ->getCurrentLanguage()
        ->getId();
      $condition = $query
        ->orConditionGroup()
        ->condition('langcode', $lang_code, '=')
        ->condition('langcode', '', '=');
      $query
        ->condition($condition);
    }
    return $query
      ->execute();
  }

  /**
   * Import Modal Config to Entity.
   */
  public function importModalConfigToEntity() {
    $language = $this->languageManager
      ->getCurrentLanguage()
      ->getId();
    $config = $this->configFactory
      ->get('modal_page.settings');
    $modals = $config
      ->get('modals');
    $modals_by_parameter = $config
      ->get('modals_by_parameter');
    $allow_tags = $this
      ->getAllowTags();
    if (empty($modals) && empty($modals_by_parameter)) {
      return FALSE;
    }
    if (!empty($modals)) {
      $modals_settings = explode(PHP_EOL, $modals);
      foreach ($modals_settings as $modal_settings) {
        $modal = explode('|', $modal_settings);
        $path = $modal[0];
        if ($path != '<front>') {
          $path = Xss::filter($modal[0]);
        }
        $path = trim($path);
        $path = ltrim($path, '/');
        $title = Xss::filter($modal[1], $allow_tags);
        $title = trim($title);
        $text = Xss::filter($modal[2], $allow_tags);
        $text = trim($text);
        $button = Xss::filter($modal[3]);
        $button = trim($button);
        $uuid = $this->uuidService
          ->generate();
        $modal = [
          'uuid' => $uuid,
          'title' => $title,
          'body' => $text,
          'type' => 'page',
          'pages' => $path,
          'ok_label_button' => $button,
          'langcode' => $language,
          'created' => time(),
          'changed' => time(),
        ];
        $query = $this->database
          ->insert('modal');
        $query
          ->fields($modal);
        $query
          ->execute();
      }
    }
    if (!empty($modals_by_parameter)) {
      $modals_settings = explode(PHP_EOL, $modals_by_parameter);
      foreach ($modals_settings as $modal_settings) {
        $modal = explode('|', $modal_settings);
        $parameter_settings = Xss::filter($modal[0]);
        $parameter = trim($parameter_settings);
        $parameter_data = explode('=', $parameter);
        $parameter_value = $parameter_data[1];
        $title = Xss::filter($modal[1], $allow_tags);
        $title = trim($title);
        $text = Xss::filter($modal[2], $allow_tags);
        $text = trim($text);
        $button = Xss::filter($modal[3]);
        $button = trim($button);
        $uuid = $this->uuidService
          ->generate();
        $modal = [
          'uuid' => $uuid,
          'title' => $title,
          'body' => $text,
          'type' => 'parameter',
          'parameters' => $parameter_value,
          'ok_label_button' => $button,
          'langcode' => $language,
          'created' => time(),
          'changed' => time(),
        ];
        $query = $this->database
          ->insert('modal');
        $query
          ->fields($modal);
        $query
          ->execute();
      }
    }
  }

}

Classes

Name	Description
ModalPageService	Modal Page Service Class.