Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\Core\Menu;
Chris@0: 
Chris@0: use Drupal\Component\Plugin\Exception\PluginException;
Chris@0: use Drupal\Core\Access\AccessManagerInterface;
Chris@0: use Drupal\Core\Cache\CacheBackendInterface;
Chris@0: use Drupal\Core\Controller\ControllerResolverInterface;
Chris@0: use Drupal\Core\Extension\ModuleHandlerInterface;
Chris@0: use Drupal\Core\Language\LanguageManagerInterface;
Chris@0: use Drupal\Core\Plugin\DefaultPluginManager;
Chris@0: use Drupal\Core\Plugin\Discovery\ContainerDerivativeDiscoveryDecorator;
Chris@0: use Drupal\Core\Plugin\Discovery\YamlDiscovery;
Chris@0: use Drupal\Core\Plugin\Factory\ContainerFactory;
Chris@0: use Drupal\Core\Session\AccountInterface;
Chris@0: use Symfony\Component\HttpFoundation\RequestStack;
Chris@0: 
Chris@0: /**
Chris@0:  * Defines a contextual link plugin manager to deal with contextual links.
Chris@0:  *
Chris@0:  * @see \Drupal\Core\Menu\ContextualLinkInterface
Chris@0:  */
Chris@0: class ContextualLinkManager extends DefaultPluginManager implements ContextualLinkManagerInterface {
Chris@0: 
Chris@0:   /**
Chris@0:    * Provides default values for a contextual link definition.
Chris@0:    *
Chris@0:    * @var array
Chris@0:    */
Chris@0:   protected $defaults = [
Chris@0:     // (required) The name of the route to link to.
Chris@0:     'route_name' => '',
Chris@0:     // (required) The contextual links group.
Chris@0:     'group' => '',
Chris@0:     // The static title text for the link.
Chris@0:     'title' => '',
Chris@0:     // The default link options.
Chris@0:     'options' => [],
Chris@0:     // The weight of the link.
Chris@0:     'weight' => NULL,
Chris@0:     // Default class for contextual link implementations.
Chris@0:     'class' => '\Drupal\Core\Menu\ContextualLinkDefault',
Chris@0:     // The plugin id. Set by the plugin system based on the top-level YAML key.
Chris@0:     'id' => '',
Chris@0:   ];
Chris@0: 
Chris@0:   /**
Chris@0:    * A controller resolver object.
Chris@0:    *
Chris@0:    * @var \Symfony\Component\HttpKernel\Controller\ControllerResolverInterface
Chris@0:    */
Chris@0:   protected $controllerResolver;
Chris@0: 
Chris@0:   /**
Chris@0:    * The access manager.
Chris@0:    *
Chris@0:    * @var \Drupal\Core\Access\AccessManagerInterface
Chris@0:    */
Chris@0:   protected $accessManager;
Chris@0: 
Chris@0:   /**
Chris@0:    * The current user.
Chris@0:    *
Chris@0:    * @var \Drupal\Core\Session\AccountInterface
Chris@0:    */
Chris@0:   protected $account;
Chris@0: 
Chris@0:   /**
Chris@0:    * The request stack.
Chris@0:    *
Chris@0:    * @var \Symfony\Component\HttpFoundation\RequestStack
Chris@0:    */
Chris@0:   protected $requestStack;
Chris@0: 
Chris@0:   /**
Chris@0:    * A static cache of all the contextual link plugins by group name.
Chris@0:    *
Chris@0:    * @var array
Chris@0:    */
Chris@0:   protected $pluginsByGroup;
Chris@0: 
Chris@0:   /**
Chris@0:    * Constructs a new ContextualLinkManager instance.
Chris@0:    *
Chris@0:    * @param \Drupal\Core\Controller\ControllerResolverInterface $controller_resolver
Chris@0:    *   The controller resolver.
Chris@0:    * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
Chris@0:    *   The module handler.
Chris@0:    * @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
Chris@0:    *   The cache backend.
Chris@0:    * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
Chris@0:    *   The language manager.
Chris@0:    * @param \Drupal\Core\Access\AccessManagerInterface $access_manager
Chris@0:    *   The access manager.
Chris@0:    * @param \Drupal\Core\Session\AccountInterface $account
Chris@0:    *   The current user.
Chris@0:    * @param \Symfony\Component\HttpFoundation\RequestStack $request_stack
Chris@0:    *   The request stack.
Chris@0:    */
Chris@0:   public function __construct(ControllerResolverInterface $controller_resolver, ModuleHandlerInterface $module_handler, CacheBackendInterface $cache_backend, LanguageManagerInterface $language_manager, AccessManagerInterface $access_manager, AccountInterface $account, RequestStack $request_stack) {
Chris@0:     $this->factory = new ContainerFactory($this, '\Drupal\Core\Menu\ContextualLinkInterface');
Chris@0:     $this->controllerResolver = $controller_resolver;
Chris@0:     $this->accessManager = $access_manager;
Chris@0:     $this->account = $account;
Chris@0:     $this->moduleHandler = $module_handler;
Chris@0:     $this->requestStack = $request_stack;
Chris@0:     $this->alterInfo('contextual_links_plugins');
Chris@0:     $this->setCacheBackend($cache_backend, 'contextual_links_plugins:' . $language_manager->getCurrentLanguage()->getId(), ['contextual_links_plugins']);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   protected function getDiscovery() {
Chris@0:     if (!isset($this->discovery)) {
Chris@0:       $yaml_discovery = new YamlDiscovery('links.contextual', $this->moduleHandler->getModuleDirectories());
Chris@0:       $yaml_discovery->addTranslatableProperty('title', 'title_context');
Chris@0:       $this->discovery = new ContainerDerivativeDiscoveryDecorator($yaml_discovery);
Chris@0:     }
Chris@0:     return $this->discovery;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function processDefinition(&$definition, $plugin_id) {
Chris@0:     parent::processDefinition($definition, $plugin_id);
Chris@0: 
Chris@0:     // If there is no route name, this is a broken definition.
Chris@0:     if (empty($definition['route_name'])) {
Chris@0:       throw new PluginException(sprintf('Contextual link plugin (%s) definition must include "route_name".', $plugin_id));
Chris@0:     }
Chris@0:     // If there is no group name, this is a broken definition.
Chris@0:     if (empty($definition['group'])) {
Chris@0:       throw new PluginException(sprintf('Contextual link plugin (%s) definition must include "group".', $plugin_id));
Chris@0:     }
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getContextualLinkPluginsByGroup($group_name) {
Chris@0:     if (isset($this->pluginsByGroup[$group_name])) {
Chris@0:       $contextual_links = $this->pluginsByGroup[$group_name];
Chris@0:     }
Chris@0:     elseif ($cache = $this->cacheBackend->get($this->cacheKey . ':' . $group_name)) {
Chris@0:       $contextual_links = $cache->data;
Chris@0:       $this->pluginsByGroup[$group_name] = $contextual_links;
Chris@0:     }
Chris@0:     else {
Chris@0:       $contextual_links = [];
Chris@0:       foreach ($this->getDefinitions() as $plugin_id => $plugin_definition) {
Chris@0:         if ($plugin_definition['group'] == $group_name) {
Chris@0:           $contextual_links[$plugin_id] = $plugin_definition;
Chris@0:         }
Chris@0:       }
Chris@0:       $this->cacheBackend->set($this->cacheKey . ':' . $group_name, $contextual_links);
Chris@0:       $this->pluginsByGroup[$group_name] = $contextual_links;
Chris@0:     }
Chris@0:     return $contextual_links;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getContextualLinksArrayByGroup($group_name, array $route_parameters, array $metadata = []) {
Chris@0:     $links = [];
Chris@0:     $request = $this->requestStack->getCurrentRequest();
Chris@0:     foreach ($this->getContextualLinkPluginsByGroup($group_name) as $plugin_id => $plugin_definition) {
Chris@0:       /** @var $plugin \Drupal\Core\Menu\ContextualLinkInterface */
Chris@0:       $plugin = $this->createInstance($plugin_id);
Chris@0:       $route_name = $plugin->getRouteName();
Chris@0: 
Chris@0:       // Check access.
Chris@0:       if (!$this->accessManager->checkNamedRoute($route_name, $route_parameters, $this->account)) {
Chris@0:         continue;
Chris@0:       }
Chris@0: 
Chris@0:       $links[$plugin_id] = [
Chris@0:         'route_name' => $route_name,
Chris@0:         'route_parameters' => $route_parameters,
Chris@0:         'title' => $plugin->getTitle($request),
Chris@0:         'weight' => $plugin->getWeight(),
Chris@0:         'localized_options' => $plugin->getOptions(),
Chris@0:         'metadata' => $metadata,
Chris@0:       ];
Chris@0:     }
Chris@0: 
Chris@0:     $this->moduleHandler->alter('contextual_links', $links, $group_name, $route_parameters);
Chris@0: 
Chris@0:     return $links;
Chris@0:   }
Chris@0: 
Chris@0: }