Port OG-Context module as OgContext provider

og.services.yml

@@ -7,9 +7,6 @@ services:
   og.access:
     class: Drupal\og\OgAccess
     arguments: ['@config.factory', '@current_user', '@module_handler', '@og.group_type_manager', '@og.permission_manager', '@og.membership_manager']
-  og.membership_manager:
-    class: Drupal\og\MembershipManager
-    arguments: ['@entity_type.manager']
   og.event_subscriber:
     class: Drupal\og\EventSubscriber\OgEventSubscriber
     arguments: ['@og.permission_manager', '@entity_type.manager', '@entity_type.bundle.info']
@@ -18,24 +15,29 @@ services:
   og.group_type_manager:
     class: Drupal\og\GroupTypeManager
     arguments: ['@config.factory', '@entity_type.manager', '@entity_type.bundle.info', '@event_dispatcher', '@state', '@og.permission_manager', '@og.role_manager', '@router.builder']
+  og.membership_manager:
+    class: Drupal\og\MembershipManager
+    arguments: ['@entity_type.manager']
   og.permissions:
     class: Drupal\og\OgPermissionHandler
     arguments: ['@module_handler', '@string_translation', '@controller_resolver']
   og.permission_manager:
     class: Drupal\og\PermissionManager
     arguments: ['@event_dispatcher']
+  og.role_manager:
+    class: Drupal\og\OgRoleManager
+    arguments: ['@entity_type.manager', '@event_dispatcher', '@og.permission_manager']
   og.route_subscriber:
     class: Drupal\og\Routing\RouteSubscriber
     arguments: ['@entity_type.manager', '@router.route_provider', '@event_dispatcher']
     tags:
       - { name: event_subscriber }
-  og.role_manager:
-    class: Drupal\og\OgRoleManager
-    arguments: ['@entity_type.manager', '@event_dispatcher', '@og.permission_manager']
   plugin.manager.og.delete_orphans:
     class: Drupal\og\OgDeleteOrphansPluginManager
     parent: default_plugin_manager
   plugin.manager.og.fields:
     class: Drupal\og\OgFieldsPluginManager
     parent: default_plugin_manager
-
+  plugin.manager.og.group_resolver:
+    class: Drupal\og\OgGroupResolverPluginManager
+    parent: default_plugin_manager

src/Annotation/OgGroupResolver.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace Drupal\og\Annotation;
+
+use Drupal\Component\Annotation\Plugin;
+
+/**
+ * Defines the OgGroupResolver annotation object.
+ *
+ * @see \Drupal\og\OgGroupResolverPluginManager
+ * @see plugin_api
+ *
+ * @Annotation
+ */
+class OgGroupResolver extends Plugin {
+
+  /**
+   * The plugin ID.
+   *
+   * @var string
+   */
+  public $id;
+
+  /**
+   * The label of the plugin.
+   *
+   * @var \Drupal\Core\Annotation\Translation
+   *
+   * @ingroup plugin_translatable
+   */
+  public $label;
+
+}

src/OgGroupResolverInterface.php

@@ -0,0 +1,67 @@
+<?php
+
+namespace Drupal\og;
+
+use Drupal\Component\Plugin\PluginInspectionInterface;
+
+/**
+ * Defines an interface for OgGroupResolver plugins.
+ *
+ * These plugins are used to discover which groups are relevant in the current
+ * context. Each plugin is responsible for finding groups in a particular
+ * domain. For example, we can have a plugin that checks if we are on the
+ * canonical URL of a group entity, and can take the group entity from the
+ * route object.
+ *
+ * Sometimes a plugin might return multiple relevant groups, for example if it
+ * finds a group content entity on the route that belongs to multiple groups.
+ *
+ * These plugins are invoked by OgContext::getRuntimeContexts() which then
+ * interprets the results and makes an educated guess at the group which is most
+ * relevant in the current context.
+ *
+ * @see \Drupal\og\ContextProvider\OgContext::getRuntimeContexts()
+ */
+interface OgGroupResolverInterface {
+
+  /**
+   * Returns the groups that were resolved by the plugin.
+   *
+   * @return \Drupal\Core\Entity\EntityInterface[]
+   *   An array of groups.
+   */
+  public function getGroups();
+
+  /**
+   * Returns the group that is most relevant in the plugin's context.
+   *
+   * A plugin can have enough domain specific knowledge to determine with
+   * certainty that a particular group is the most relevant in a certain domain.
+   * This method can be used to return that group.
+   *
+   * If the plugin doesn't have absolute certainty that a particular group is
+   * the most relevant, this will return NULL.
+   *
+   * @return \Drupal\Core\Entity\EntityInterface|null
+   *   The group that is the best candidate, or NULL if there is no best
+   *   candidate.
+   */
+  public function getBestCandidate();
+
+  /**
+   * Declares that no further group resolving is necessary.
+   *
+   * Use this if the plugin has determined the relevant group in the current
+   * context with 100% certainty.
+   */
+  public function stopPropagation();
+
+  /**
+   * Returns whether the group resolving process can be stopped.
+   *
+   * @return bool
+   *   TRUE if no further group resolving is necessary. FALSE otherwise.
+   */
+  public function isPropagationStopped();
+
+}

src/OgGroupResolverPluginManager.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace Drupal\og;
+
+use Drupal\Core\Cache\CacheBackendInterface;
+use Drupal\Core\Extension\ModuleHandlerInterface;
+use Drupal\Core\Plugin\DefaultPluginManager;
+
+/**
+ * Plugin manager for OgGroupResolver plugins.
+ */
+class OgGroupResolverPluginManager extends DefaultPluginManager {
+
+  /**
+   * Constructs an OgGroupResolverPluginManager service.
+   *
+   * @param \Traversable $namespaces
+   *   An object that implements \Traversable which contains the root paths
+   *   keyed by the corresponding namespace to look for plugin implementations.
+   * @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
+   *   Cache backend instance to use.
+   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
+   *   The module handler to invoke the alter hook with.
+   */
+  public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler) {
+    parent::__construct('Plugin/OgGroupResolver', $namespaces, $module_handler, 'Drupal\og\OgGroupResolverInterface', 'Drupal\og\Annotation\OgGroupResolver');
+
+    $this->alterInfo('og_group_resolver_info');
+    $this->setCacheBackend($cache_backend, 'og_group_resolver');
+  }
+
+}

src/Plugin/OgGroupResolver/Entity.php

@@ -0,0 +1,91 @@
+<?php
+
+namespace Drupal\og\Plugin\OgGroupResolver;
+
+use Drupal\Core\Entity\ContentEntityBase;
+use Drupal\Core\Routing\RouteMatchInterface;
+use Drupal\og\GroupTypeManager;
+use Drupal\og\Og;
+use Drupal\og\OgGroupResolverBase;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+
+/**
+ * Get the group from the given viewed entity.
+ *
+ * @OgGroupResolver(
+ *  id = "entity",
+ *  label = "Entity",
+ *  description = @Translation("Get the group from the current entity, by checking if it is a group or a group content entity.")
+ * )
+ */
+class Entity extends OgGroupResolverBase {
+
+  /**
+   * The route match service.
+   *
+   * @var RouteMatchInterface
+   */
+  protected $routeMatch;
+
+  /**
+   * The group type manager service.
+   *
+   * @var \Drupal\og\GroupTypeManager
+   */
+  protected $groupTypeManager;
+
+  /**
+   * Constructs a Drupal\Component\Plugin\PluginBase object.
+   *
+   * @param array $configuration
+   *   A configuration array containing information about the plugin instance.
+   * @param string $plugin_id
+   *   The plugin_id for the plugin instance.
+   * @param mixed $plugin_definition
+   *   The plugin implementation definition.
+   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
+   *   The route match service.
+   * @param \Drupal\og\GroupTypeManager $group_type_manager
+   *   The group type manager service.
+   */
+  public function __construct(array $configuration, $plugin_id, $plugin_definition, RouteMatchInterface $route_match, GroupTypeManager $group_type_manager) {
+    parent::__construct($configuration, $plugin_id, $plugin_definition);
+    $this->routeMatch = $route_match;
+    $this->groupTypeManager = $group_type_manager;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
+    return new static(
+      $configuration,
+      $plugin_id,
+      $plugin_definition,
+      $container->get('current_route_match'),
+      $container->get('og.group_type_manager')
+    );
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getGroup() {
+    foreach ($this->routeMatch->getParameters() as $parameter) {
+      if (!($parameter instanceof ContentEntityBase)) {
+        continue;
+      }
+
+      if ($this->groupTypeManager->isGroup($parameter->getEntityTypeId(), $parameter->bundle())) {
+        return $parameter;
+      }
+
+      if (!Og::isGroupContent($parameter->getEntityTypeId(), $parameter->bundle())) {
+        continue;
+      }
+
+      return Og::getGroups($parameter);
+    }
+  }
+
+}

tests/modules/og_test/src/Plugin/GroupResolver/UserGroupReference.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace Drupal\og_test\Plugin\GroupResolver;
+
+/**
+ * @file
+ * Contains \Drupal\og_test\Plugin\OgResolver\UserGroupReference.
+ */
+
+use Drupal\og\OgContextBase;
+
+/**
+ * Get the group from a field reference attached to the current user.
+ *
+ * @GroupResolver(
+ *  id = "user_group_reference",
+ *  label = "User group reference",
+ *  description = @Translation("A dummy plugin to return the first group from a field attach to the user.")
+ * )
+ */
+class UserGroupReference extends OgContextBase {
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getGroup() {
+  }
+
+}