block_exclude_pages.module in Block Exclude Pages 2.x

Contains block_exclude_pages.module.

File

block_exclude_pages.module

<?php

/**
 * @file
 * Contains block_exclude_pages.module.
 */
use Drupal\Core\Routing\RouteMatchInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\block\Entity\Block;
use Drupal\Core\Session\AccountInterface;

/**
 * Implements hook_help().
 */
function block_exclude_pages_help($route_name, RouteMatchInterface $route_match) {
  $output = '';
  switch ($route_name) {

    // Main module help for the block_exclude_pages module.
    case 'help.page.block_exclude_pages':
      $output .= '<h3>' . t('About') . '</h3>';
      $description = block_exclude_pages_blockhelptext();
      $output .= '<p>' . t('This module adds an exclude pages filter for blocks') . '</p>';
      $output .= $description;
    default:
  }
  return $output;
}

/**
 * Doc function returns the help markup.
 */
function block_exclude_pages_blockhelptext() {
  return t("<br><br><b>To exclude specific pages</b>, prefix the path with a '!'. Example excluded path <em class='placeholder'>!/user/jc</em>");
}

/**
 * Implements hook_form_FORM_ID_alter().
 */
function block_exclude_pages_form_block_form_alter(&$form, FormStateInterface $form_state, $form_id) {
  $description = block_exclude_pages_blockhelptext();
  $currenthelper = $form['visibility']['request_path']['pages']['#description'];
  $form['visibility']['request_path']['pages']['#description'] = $currenthelper . $description;
}

/**
 * Implements hook_block_access().
 */
function block_exclude_pages_block_access(Block $block, $operation, AccountInterface $account) {

  /* ############  testing/debuggin - only: ################# */
  $debug_output = [];
  $debug = FALSE;

  /* ######################################################## */
  $nodeid = \Drupal::service('path.current')
    ->getPath();
  $path = explode('/', trim(\Drupal::request()->query
    ->get('q'), '/'));
  if ($path[0] == "" && \Drupal::service('path.matcher')
    ->isFrontPage() != TRUE) {
    $path = explode('/', trim(\Drupal::service('path_alias.manager')
      ->getAliasByPath($nodeid), '/'));
  }
  $language = \Drupal::languageManager()
    ->getCurrentLanguage()
    ->getId();

  // - unset language id if present in path.
  if ($path[0] == $language) {
    unset($path[0]);
  }

  // - join paths.
  $path = "/" . implode("/", $path);

  // - get block's visibility conditions.
  $conditions = $debug ? block_exclude_pages_debug_check() : $block
    ->getVisibilityConditions()
    ->getConfiguration();
  if (is_array($conditions) && (count($conditions) > 0 && !empty($conditions['request_path']))) {
    $pages = explode("\n", $conditions['request_path']['pages']);
    $pttr = '#^\\!#';
    foreach ($pages as $p) {

      // - check if exclude conditions is set.
      if (preg_match($pttr, $p) !== 1) {
        if ($debug) {
          array_push($debug_output, $p . " -  SKIPPED");
        }
        continue;
      }

      // - exclude item found, now test if on page path.
      $exclude = trim(preg_replace($pttr, "", $p));
      $pathmatcher = \Drupal::service('path.matcher');
      if ($debug) {

        // Used for testing and debugging only:
        $paths = block_exclude_pages_debug_dummy_path();
        array_push($debug_output, "----------------------------- [ !" . $exclude . " ]------------------------------");
        foreach ($paths as $path) {
          if ($pathmatcher
            ->matchPath($nodeid, $exclude) || $pathmatcher
            ->matchPath($path, $exclude)) {
            if ($exclude == $nodeid) {
              array_push($debug_output, "!" . $exclude . " : " . $nodeid . " - BLOCKED <<<<<<<<<<<<<<<<<<<<<<<<<");
            }
            else {
              array_push($debug_output, "!" . $exclude . " : " . $path . " - BLOCKED <<<<<<<<<<<<<<<<<<<<<<<<<");
            }
          }
          else {
            array_push($debug_output, "!" . $exclude . " : " . $path . " - PASSED");
          }
        }
      }
      else {

        // - Set the visibility of the block:
        if ($pathmatcher
          ->matchPath($nodeid, $exclude) || $pathmatcher
          ->matchPath($path, $exclude)) {
          $config['pages'] = $exclude;
          $config['context_mapping'] = [];
          if (isset($conditions['request_path']['negate']) && $conditions['request_path']['negate'] == TRUE) {
            $config['negate'] = FALSE;
          }
          else {
            $config['negate'] = TRUE;
          }
          $block
            ->setVisibilityConfig('request_path', $config);
          break;
        }
      }
    }

    // - output testing/debug info:
    if ($debug) {
      $debug_log = [
        'type' => 'debug_log',
        'block_id' => $block
          ->id(),
        'block_data' => $block,
        'debug_output' => $debug_output,
      ];
      if (function_exists('ksm')) {
        ksm($debug_log);
      }
      else {
        \Drupal::logger('block_exclude_pages')
          ->notice(print_r($debug_log, 1));
      }
    }
  }
}

/* -- DEBUGGING VARIABLES ---- */

/**
 * Doc function returns an array of dummy paths to run a test.
 */
function block_exclude_pages_debug_dummy_path() {
  $dummy = [
    "/node/28",
    "/node/2",
    "/user",
    "/other",
    "/user/mc",
    "/user/jc",
    "/user/jc/profile",
    "/user/jc/profile/1",
    "/user/jc/profile/mc",
    "/user/jc/settings/mc",
    "/offices/human-resources/current-employees",
    "/offices/human-resources/current-employees/manager-documents",
    "/offices/human-resources/current-employees/manager-resources",
  ];
  return $dummy;
}

/**
 * Doc function returns a strign witha list of paths to check for testing.
 */
function block_exclude_pages_debug_check() {
  $senario = [
    'request_path' => [
      'pages' => <<<EEE
/node/28
!/node/2
/user
/user/*
!/user/jc
!/user/jc/*
!/user/jc/*/mc",
/offices/human-resources/current-employees/*
!/offices/human-resources/current-employees/manager-resources
EEE
,
    ],
  ];
  return $senario;
}

Functions

Name	Description
block_exclude_pages_blockhelptext	Doc function returns the help markup.
block_exclude_pages_block_access	Implements hook_block_access().
block_exclude_pages_debug_check	Doc function returns a strign witha list of paths to check for testing.
block_exclude_pages_debug_dummy_path	Doc function returns an array of dummy paths to run a test.
block_exclude_pages_form_block_form_alter	Implements hook_form_FORM_ID_alter().
block_exclude_pages_help	Implements hook_help().