class PremiumContent in Node Option Premium 8

Adds premium information to the indexes.

Plugin annotation


@SearchApiProcessor(
  id = "nopremium",
  label = @Translation("Premium content"),
  description = @Translation("Adds premium information to the index, so that premium nodes can be excluded from the search results."),
  stages = {
    "pre_index_save" = -10,
    "preprocess_query" = -30,
  },
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\search_api\Plugin\HideablePluginBase implements HideablePluginInterface
    class \Drupal\search_api\Plugin\ConfigurablePluginBase implements ConfigurablePluginInterface uses PluginDependencyTrait
    class \Drupal\search_api\Plugin\IndexPluginBase implements IndexPluginInterface
    class \Drupal\search_api\Processor\ProcessorPluginBase implements ProcessorInterface
    class \Drupal\nopremium\Plugin\search_api\processor\PremiumContent uses LoggerTrait

Expanded class hierarchy of PremiumContent

File

src/Plugin/search_api/processor/PremiumContent.php, line 30

Namespace

Drupal\nopremium\Plugin\search_api\processor

View source

class PremiumContent extends ProcessorPluginBase {
  use LoggerTrait;

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

  /**
   * The current_user service used by this plugin.
   *
   * @var \Drupal\Core\Session\AccountProxyInterface|null
   */
  protected $currentUser;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {

    /** @var static $processor */
    $processor = parent::create($container, $configuration, $plugin_id, $plugin_definition);
    $processor
      ->setLogger($container
      ->get('logger.channel.search_api'));
    $processor
      ->setDatabase($container
      ->get('database'));
    $processor
      ->setCurrentUser($container
      ->get('current_user'));
    return $processor;
  }

  /**
   * Retrieves the database connection.
   *
   * @return \Drupal\Core\Database\Connection
   *   The database connection.
   */
  public function getDatabase() {
    return $this->database ?: \Drupal::database();
  }

  /**
   * Sets the database connection.
   *
   * @param \Drupal\Core\Database\Connection $database
   *   The new database connection.
   *
   * @return $this
   */
  public function setDatabase(Connection $database) {
    $this->database = $database;
    return $this;
  }

  /**
   * Retrieves the current user.
   *
   * @return \Drupal\Core\Session\AccountProxyInterface
   *   The current user.
   */
  public function getCurrentUser() {
    return $this->currentUser ?: \Drupal::currentUser();
  }

  /**
   * Sets the current user.
   *
   * @param \Drupal\Core\Session\AccountProxyInterface $current_user
   *   The current user.
   *
   * @return $this
   */
  public function setCurrentUser(AccountProxyInterface $current_user) {
    $this->currentUser = $current_user;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public static function supportsIndex(IndexInterface $index) {
    foreach ($index
      ->getDatasources() as $datasource) {

      // Premium filter is only applyable on nodes.
      if ($datasource
        ->getEntityTypeId() === 'node') {
        return TRUE;
      }
    }
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function preIndexSave() {
    foreach ($this->index
      ->getDatasources() as $datasource_id => $datasource) {
      if ($datasource
        ->getEntityTypeId() == 'node') {
        $this
          ->ensureField($datasource_id, 'premium', 'boolean');
        $this
          ->ensureField($datasource_id, 'type', 'string');
        $this
          ->ensureField($datasource_id, 'uid', 'integer');
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function preprocessSearchQuery(QueryInterface $query) {
    if (!$query
      ->getOption('search_api_bypass_access')) {
      $account = $query
        ->getOption('search_api_access_account', $this
        ->getCurrentUser());
      if (is_numeric($account)) {
        $account = User::load($account);
      }
      if ($account instanceof AccountInterface) {
        try {
          $this
            ->addPremiumAccess($query, $account);
        } catch (SearchApiException $e) {
          $this
            ->logException($e);
        }
      }
      else {
        $account = $query
          ->getOption('search_api_access_account', $this
          ->getCurrentUser());
        if ($account instanceof AccountInterface) {
          $account = $account
            ->id();
        }
        if (!is_scalar($account)) {
          $account = var_export($account, TRUE);
        }
        $this
          ->getLogger()
          ->warning('An illegal user UID was given for node access: @uid.', [
          '@uid' => $account,
        ]);
      }
    }
  }

  /**
   * Adds a premium access filter to a search query, if applicable.
   *
   * @param \Drupal\search_api\Query\QueryInterface $query
   *   The query to which a node access filter should be added, if applicable.
   * @param \Drupal\Core\Session\AccountInterface $account
   *   The user for whom the search is executed.
   *
   * @throws \Drupal\search_api\SearchApiException
   *   Thrown if not all necessary fields are indexed on the index.
   */
  protected function addPremiumAccess(QueryInterface $query, AccountInterface $account) {

    // Don't do anything if the user can access all premium content.
    if ($account
      ->hasPermission('view full premium content of any type')) {
      return;
    }

    // Gather the affected datasources, grouped by entity type, as well as the
    // unaffected ones.
    $affected_datasources = [];
    $unaffected_datasources = [];
    foreach ($this->index
      ->getDatasources() as $datasource_id => $datasource) {
      if ($datasource
        ->getEntityTypeId() === 'node') {
        $affected_datasources['node'][] = $datasource_id;
      }
      else {
        $unaffected_datasources[] = $datasource_id;
      }
    }

    // The filter structure we want looks like this:
    // @code
    //   [belongs to other datasource]
    //   OR
    //   (
    //     [is enabled (or was created by the user, if applicable)]
    //     AND
    //     [grants view access to one of the user's gid/realm combinations]
    //   )
    // @endcode
    // If there are no "other" datasources, we don't need the nested OR,
    // however, and can add the inner conditions directly to the query.
    if ($unaffected_datasources) {
      $outer_conditions = $query
        ->createConditionGroup('OR', [
        'content_access',
      ]);
      $query
        ->addConditionGroup($outer_conditions);
      foreach ($unaffected_datasources as $datasource_id) {
        $outer_conditions
          ->addCondition('search_api_datasource', $datasource_id);
      }
      $access_conditions = $query
        ->createConditionGroup('AND');
      $outer_conditions
        ->addConditionGroup($access_conditions);
    }
    else {
      $access_conditions = $query;
    }

    // If the user does not have the permission to see any content at all, deny
    // access to all items from affected datasources.
    if (!$affected_datasources) {

      // If there were "other" datasources, the existing filter will already
      // remove all results of node or comment datasources. Otherwise, we should
      // not return any results at all.
      if (!$unaffected_datasources) {
        $query
          ->abort($this
          ->t('You have no access to any results in this search.'));
      }
      return;
    }

    // Authors of premium nodes may always view their own nodes.
    $premium_conditions = $query
      ->createConditionGroup('OR');
    if ($account
      ->isAuthenticated()) {
      $author_conditions = $query
        ->createConditionGroup('OR');
      foreach ($affected_datasources as $entity_type => $datasources) {
        foreach ($datasources as $datasource_id) {
          if ($entity_type == 'node') {
            $author_field = $this
              ->findField($datasource_id, 'uid', 'integer');
            if ($author_field) {
              $author_conditions
                ->addCondition($author_field
                ->getFieldIdentifier(), $account
                ->id());
            }
          }
        }
      }
      $premium_conditions
        ->addConditionGroup($author_conditions);
    }
    foreach (NodeType::loadMultiple() as $type) {
      $type_id = $type
        ->id();
      if (!$account
        ->hasPermission("view full {$type_id} premium content")) {

        // User may only view non-premium nodes of this type.
        $node_type_conditions = $query
          ->createConditionGroup('AND');
        $node_type_conditions
          ->addCondition('type', $type_id);
        $node_type_conditions
          ->addCondition('premium', FALSE);
        $premium_conditions
          ->addConditionGroup($node_type_conditions);
      }
      else {
        $premium_conditions
          ->addCondition('type', $type_id);
      }
    }
    $access_conditions
      ->addConditionGroup($premium_conditions);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigurablePluginBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies	6
ConfigurablePluginBase::calculatePluginDependencies Deprecated	protected	function	Calculates and adds dependencies of a specific plugin instance.
ConfigurablePluginBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration	11
ConfigurablePluginBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ConfigurablePluginBase::getDescription	public	function	Returns the plugin's description. Overrides ConfigurablePluginInterface::getDescription
ConfigurablePluginBase::getPluginDependencies Deprecated	protected	function	Calculates and returns dependencies of a specific plugin instance.
ConfigurablePluginBase::label	public	function	Returns the label for use on the administration pages. Overrides ConfigurablePluginInterface::label
ConfigurablePluginBase::moduleHandler Deprecated	protected	function	Wraps the module handler.
ConfigurablePluginBase::onDependencyRemoval	public	function	Informs the plugin that some of its dependencies are being removed. Overrides ConfigurablePluginInterface::onDependencyRemoval	5
ConfigurablePluginBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration	3
ConfigurablePluginBase::themeHandler Deprecated	protected	function	Wraps the theme handler.
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
DependencyTrait::$dependencies	protected	property	The object's dependencies.
DependencyTrait::addDependencies	protected	function	Adds multiple dependencies.
DependencyTrait::addDependency	protected	function	Adds a dependency.
IndexPluginBase::$index	protected	property	The index this processor is configured for.
IndexPluginBase::getIndex	public	function	Retrieves the index this plugin is configured for. Overrides IndexPluginInterface::getIndex
IndexPluginBase::setIndex	public	function	Sets the index this plugin is configured for. Overrides IndexPluginInterface::setIndex
IndexPluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides ConfigurablePluginBase::__construct	2
LoggerTrait::$logger	protected	property	The logging channel to use.
LoggerTrait::getLogger	public	function	Retrieves the logger.
LoggerTrait::logException	protected	function	Logs an exception.
LoggerTrait::setLogger	public	function	Sets the logger.
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginDependencyTrait::calculatePluginDependencies	protected	function	Calculates and adds dependencies of a specific plugin instance. Aliased as: traitCalculatePluginDependencies	1
PluginDependencyTrait::getPluginDependencies	protected	function	Calculates and returns dependencies of a specific plugin instance. Aliased as: traitGetPluginDependencies
PluginDependencyTrait::moduleHandler	protected	function	Wraps the module handler. Aliased as: traitModuleHandler	1
PluginDependencyTrait::themeHandler	protected	function	Wraps the theme handler. Aliased as: traitThemeHandler	1
PremiumContent::$currentUser	protected	property	The current_user service used by this plugin.
PremiumContent::$database	protected	property	The database connection.
PremiumContent::addPremiumAccess	protected	function	Adds a premium access filter to a search query, if applicable.
PremiumContent::create	public static	function	Creates an instance of the plugin. Overrides ProcessorPluginBase::create
PremiumContent::getCurrentUser	public	function	Retrieves the current user.
PremiumContent::getDatabase	public	function	Retrieves the database connection.
PremiumContent::preIndexSave	public	function	Preprocesses the search index entity before it is saved. Overrides ProcessorPluginBase::preIndexSave
PremiumContent::preprocessSearchQuery	public	function	Preprocesses a search query. Overrides ProcessorPluginBase::preprocessSearchQuery
PremiumContent::setCurrentUser	public	function	Sets the current user.
PremiumContent::setDatabase	public	function	Sets the database connection.
PremiumContent::supportsIndex	public static	function	Checks whether this processor is applicable for a certain index. Overrides ProcessorPluginBase::supportsIndex
ProcessorInterface::STAGE_ADD_PROPERTIES		constant	Processing stage: add properties.
ProcessorInterface::STAGE_ALTER_ITEMS		constant	Processing stage: alter indexed items.
ProcessorInterface::STAGE_POSTPROCESS_QUERY		constant	Processing stage: postprocess query.
ProcessorInterface::STAGE_PREPROCESS_INDEX		constant	Processing stage: preprocess index.
ProcessorInterface::STAGE_PREPROCESS_QUERY		constant	Processing stage: preprocess query.
ProcessorInterface::STAGE_PRE_INDEX_SAVE		constant	Processing stage: preprocess index.
ProcessorPluginBase::$fieldsHelper	protected	property	The fields helper.	1
ProcessorPluginBase::addFieldValues	public	function	Adds the values of properties defined by this processor to the item. Overrides ProcessorInterface::addFieldValues	8
ProcessorPluginBase::alterIndexedItems	public	function	Alter the items to be indexed. Overrides ProcessorInterface::alterIndexedItems	3
ProcessorPluginBase::ensureField	protected	function	Ensures that a field with certain properties is indexed on the index.
ProcessorPluginBase::findField	protected	function	Finds a certain field in the index.
ProcessorPluginBase::getFieldsHelper	public	function	Retrieves the fields helper.	1
ProcessorPluginBase::getPropertyDefinitions	public	function	Retrieves the properties this processor defines for the given datasource. Overrides ProcessorInterface::getPropertyDefinitions	8
ProcessorPluginBase::getWeight	public	function	Returns the weight for a specific processing stage. Overrides ProcessorInterface::getWeight
ProcessorPluginBase::isHidden	public	function	Determines whether this plugin should be hidden in the UI. Overrides HideablePluginBase::isHidden
ProcessorPluginBase::isLocked	public	function	Determines whether this processor should always be enabled. Overrides ProcessorInterface::isLocked
ProcessorPluginBase::postprocessSearchResults	public	function	Postprocess search results before they are returned by the query. Overrides ProcessorInterface::postprocessSearchResults	2
ProcessorPluginBase::preprocessIndexItems	public	function	Preprocesses search items for indexing. Overrides ProcessorInterface::preprocessIndexItems	5
ProcessorPluginBase::requiresReindexing	public	function	Determines whether re-indexing is required after a settings change. Overrides ProcessorInterface::requiresReindexing
ProcessorPluginBase::setFieldsHelper	public	function	Sets the fields helper.	1
ProcessorPluginBase::setWeight	public	function	Sets the weight for a specific processing stage. Overrides ProcessorInterface::setWeight
ProcessorPluginBase::supportsStage	public	function	Checks whether this processor implements a particular stage. Overrides ProcessorInterface::supportsStage	2
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.

You are here

class PremiumContent in Node Option Premium 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation