Newer
Older
<?php
/**
* @file
* Contains \Drupal\system\Controller\SystemController.
*/
namespace Drupal\system\Controller;
Angie Byron
committed
use Drupal\Component\Serialization\Json;
use Drupal\Core\Controller\ControllerBase;
use Drupal\Core\Entity\Query\QueryFactory;
use Drupal\Core\Extension\ThemeHandlerInterface;
use Drupal\Core\Form\FormBuilderInterface;
use Drupal\Core\Menu\MenuLinkTreeInterface;
use Drupal\Core\Menu\MenuTreeParameters;
use Drupal\Core\Theme\ThemeAccessCheck;
use Drupal\Core\Url;
use Drupal\system\SystemManager;
use Symfony\Component\DependencyInjection\ContainerInterface;
/**
* Returns responses for System routes.
*/
Angie Byron
committed
class SystemController extends ControllerBase {
/**
* The entity query factory object.
*
* @var \Drupal\Core\Entity\Query\QueryFactory
*/
protected $queryFactory;
/**
* System Manager Service.
*
* @var \Drupal\system\SystemManager
*/
protected $systemManager;
/**
* The theme access checker service.
*
* @var \Drupal\Core\Theme\ThemeAccessCheck
*/
protected $themeAccess;
/**
* The form builder service.
*
* @var \Drupal\Core\Form\FormBuilderInterface
*/
protected $formBuilder;
/**
* The theme handler service.
*
* @var \Drupal\Core\Extension\ThemeHandlerInterface
*/
protected $themeHandler;
/**
* The menu link tree service.
*
* @var \Drupal\Core\Menu\MenuLinkTreeInterface
*/
protected $menuLinkTree;
/**
Jennifer Hodgdon
committed
* Constructs a new SystemController.
*
* @param \Drupal\system\SystemManager $systemManager
* System manager service.
* @param \Drupal\Core\Entity\Query\QueryFactory $queryFactory
* The entity query object.
* @param \Drupal\Core\Theme\ThemeAccessCheck $theme_access
* The theme access checker service.
* @param \Drupal\Core\Form\FormBuilderInterface $form_builder
* The form builder.
* @param \Drupal\Core\Extension\ThemeHandlerInterface $theme_handler
* The theme handler.
* @param \Drupal\Core\Menu\MenuLinkTreeInterface
* The menu link tree service.
*/
public function __construct(SystemManager $systemManager, QueryFactory $queryFactory, ThemeAccessCheck $theme_access, FormBuilderInterface $form_builder, ThemeHandlerInterface $theme_handler, MenuLinkTreeInterface $menu_link_tree) {
$this->systemManager = $systemManager;
$this->queryFactory = $queryFactory;
$this->themeAccess = $theme_access;
$this->formBuilder = $form_builder;
$this->themeHandler = $theme_handler;
$this->menuLinkTree = $menu_link_tree;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static(
$container->get('system.manager'),
$container->get('entity.query'),
$container->get('access_check.theme'),
$container->get('form_builder'),
$container->get('theme_handler'),
$container->get('menu.link_tree')
);
}
/**
* Provide the administration overview page.
*
* @param string $link_id
* The ID of the administrative path link for which to display child links.
Alex Pott
committed
*
* @return array
* A renderable array of the administration overview page.
*/
public function overview($link_id) {
// Check for status report errors.
if ($this->systemManager->checkRequirements() && $this->currentUser()->hasPermission('administer site configuration')) {
Angie Byron
committed
drupal_set_message($this->t('One or more problems were detected with your Drupal installation. Check the <a href="@status">status report</a> for more information.', array('@status' => $this->url('system.status'))), 'error');
}
// Load all menu links below it.
$parameters = new MenuTreeParameters();
Alex Pott
committed
$parameters->setRoot($link_id)->excludeRoot()->setTopLevelOnly()->onlyEnabledLinks();
$tree = $this->menuLinkTree->load(NULL, $parameters);
$manipulators = array(
array('callable' => 'menu.default_tree_manipulators:checkAccess'),
array('callable' => 'menu.default_tree_manipulators:generateIndexAndSort'),
);
$tree = $this->menuLinkTree->transform($tree, $manipulators);
$blocks = array();
foreach ($tree as $key => $element) {
$link = $element->link;
$block['title'] = $link->getTitle();
$block['description'] = $link->getDescription();
$block['content'] = array(
'#theme' => 'admin_block_content',
'#content' => $this->systemManager->getAdminBlock($link),
);
if (!empty($block['content']['#content'])) {
$blocks[$key] = $block;
}
}
if ($blocks) {
ksort($blocks);
return array(
'#theme' => 'admin_page',
'#blocks' => $blocks,
);
}
else {
return array(
'#markup' => $this->t('You do not have any administrative items.'),
);
}
}
/**
* Sets whether the admin menu is in compact mode or not.
*
* @param string $mode
* Valid values are 'on' and 'off'.
*
* @return \Symfony\Component\HttpFoundation\RedirectResponse
*/
public function compactPage($mode) {
user_cookie_save(array('admin_compact_mode' => ($mode == 'on')));
return $this->redirect('<front>');
}
/**
* Provides a single block from the administration menu as a page.
*/
public function systemAdminMenuBlockPage() {
return $this->systemManager->getBlockContents();
}
Angie Byron
committed
/**
* Returns a theme listing.
*
* @return string
* An HTML string of the theme listing page.
*
* @todo Move into ThemeController.
Angie Byron
committed
*/
public function themesPage() {
$config = $this->config('system.theme');
// Get all available themes.
$themes = $this->themeHandler->rebuildThemeData();
uasort($themes, 'system_sort_modules_by_info_name');
$theme_default = $config->get('default');
catch
committed
$theme_groups = array('installed' => array(), 'uninstalled' => array());
$admin_theme = $config->get('admin');
$admin_theme_options = array();
foreach ($themes as &$theme) {
if (!empty($theme->info['hidden'])) {
continue;
}
$theme->is_default = ($theme->getName() == $theme_default);
$theme->is_admin = ($theme->getName() == $admin_theme || ($theme->is_default && $admin_theme == '0'));
// Identify theme screenshot.
$theme->screenshot = NULL;
// Create a list which includes the current theme and all its base themes.
if (isset($themes[$theme->getName()]->base_themes)) {
$theme_keys = array_keys($themes[$theme->getName()]->base_themes);
$theme_keys[] = $theme->getName();
}
else {
$theme_keys = array($theme->getName());
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
}
// Look for a screenshot in the current theme or in its closest ancestor.
foreach (array_reverse($theme_keys) as $theme_key) {
if (isset($themes[$theme_key]) && file_exists($themes[$theme_key]->info['screenshot'])) {
$theme->screenshot = array(
'uri' => $themes[$theme_key]->info['screenshot'],
'alt' => $this->t('Screenshot for !theme theme', array('!theme' => $theme->info['name'])),
'title' => $this->t('Screenshot for !theme theme', array('!theme' => $theme->info['name'])),
'attributes' => array('class' => array('screenshot')),
);
break;
}
}
if (empty($theme->status)) {
// Ensure this theme is compatible with this version of core.
// Require the 'content' region to make sure the main page
// content has a common place in all themes.
$theme->incompatible_core = !isset($theme->info['core']) || ($theme->info['core'] != \DRUPAL::CORE_COMPATIBILITY) || !isset($theme->info['regions']['content']);
$theme->incompatible_php = version_compare(phpversion(), $theme->info['php']) < 0;
// Confirmed that the base theme is available.
$theme->incompatible_base = isset($theme->info['base theme']) && !isset($themes[$theme->info['base theme']]);
// Confirm that the theme engine is available.
$theme->incompatible_engine = isset($theme->info['engine']) && !isset($theme->owner);
}
$theme->operations = array();
if (!empty($theme->status) || !$theme->incompatible_core && !$theme->incompatible_php && !$theme->incompatible_base && !$theme->incompatible_engine) {
// Create the operations links.
$query['theme'] = $theme->getName();
if ($this->themeAccess->checkAccess($theme->getName())) {
$theme->operations[] = array(
'title' => $this->t('Settings'),
'url' => Url::fromRoute('system.theme_settings_theme', ['theme' => $theme->getName()]),
'attributes' => array('title' => $this->t('Settings for !theme theme', array('!theme' => $theme->info['name']))),
);
}
if (!empty($theme->status)) {
if (!$theme->is_default) {
Alex Pott
committed
$theme_uninstallable = TRUE;
if ($theme->getName() == $admin_theme) {
$theme_uninstallable = FALSE;
}
// Check it isn't the base of theme of an installed theme.
foreach ($theme->required_by as $themename => $dependency) {
if (!empty($themes[$themename]->status)) {
$theme_uninstallable = FALSE;
}
}
if ($theme_uninstallable) {
$theme->operations[] = array(
catch
committed
'title' => $this->t('Uninstall'),
'url' => Url::fromRoute('system.theme_uninstall'),
'query' => $query,
catch
committed
'attributes' => array('title' => $this->t('Uninstall !theme theme', array('!theme' => $theme->info['name']))),
);
}
$theme->operations[] = array(
Angie Byron
committed
'title' => $this->t('Set as default'),
'url' => Url::fromRoute('system.theme_set_default'),
'query' => $query,
'attributes' => array('title' => $this->t('Set !theme as default theme', array('!theme' => $theme->info['name']))),
);
}
$admin_theme_options[$theme->getName()] = $theme->info['name'];
}
else {
$theme->operations[] = array(
catch
committed
'title' => $this->t('Install'),
'url' => Url::fromRoute('system.theme_install'),
'query' => $query,
catch
committed
'attributes' => array('title' => $this->t('Install !theme theme', array('!theme' => $theme->info['name']))),
);
$theme->operations[] = array(
catch
committed
'title' => $this->t('Install and set as default'),
'url' => Url::fromRoute('system.theme_set_default'),
'query' => $query,
catch
committed
'attributes' => array('title' => $this->t('Install !theme as default theme', array('!theme' => $theme->info['name']))),
);
}
}
// Add notes to default and administration theme.
$theme->notes = array();
if ($theme->is_default) {
$theme->notes[] = $this->t('default theme');
}
if ($theme->is_admin) {
$theme->notes[] = $this->t('admin theme');
}
catch
committed
// Sort installed and uninstalled themes into their own groups.
$theme_groups[$theme->status ? 'installed' : 'uninstalled'][] = $theme;
}
// There are two possible theme groups.
$theme_group_titles = array(
catch
committed
'installed' => $this->formatPlural(count($theme_groups['installed']), 'Installed theme', 'Installed themes'),
);
catch
committed
if (!empty($theme_groups['uninstalled'])) {
$theme_group_titles['uninstalled'] = $this->formatPlural(count($theme_groups['uninstalled']), 'Uninstalled theme', 'Uninstalled themes');
}
catch
committed
uasort($theme_groups['installed'], 'system_sort_themes');
$this->moduleHandler()->alter('system_themes_page', $theme_groups);
$build = array();
$build[] = array(
'#theme' => 'system_themes_page',
'#theme_groups' => $theme_groups,
'#theme_group_titles' => $theme_group_titles,
);
$build[] = $this->formBuilder->getForm('Drupal\system\Form\ThemeAdminForm', $admin_theme_options);
return $build;
Angie Byron
committed
}
* #post_render_cache callback; sets the "is-active" class on relevant links.
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
*
* This is a PHP implementation of the drupal.active-link JavaScript library.
*
* @param array $element
* A renderable array with the following keys:
* - #markup
* - #attached
* @param array $context
* An array with the following keys:
* - path: the system path of the currently active page
* - front: whether the current page is the front page (which implies the
* current path might also be <front>)
* - language: the language code of the currently active page
* - query: the query string for the currently active page
*
* @return array
* The updated renderable array.
*
* @todo Once a future version of PHP supports parsing HTML5 properly
* (i.e. doesn't fail on https://drupal.org/comment/7938201#comment-7938201)
* then we can get rid of this manual parsing and use DOMDocument instead.
*/
public static function setLinkActiveClass(array $element, array $context) {
$search_key_current_path = 'data-drupal-link-system-path="' . $context['path'] . '"';
$search_key_front = 'data-drupal-link-system-path="<front>"';
// An active link's path is equal to the current path, so search the HTML
// for an attribute with that value.
$offset = 0;
Alex Pott
committed
while (strpos($element['#markup'], $search_key_current_path, $offset) !== FALSE || ($context['front'] && strpos($element['#markup'], $search_key_front, $offset) !== FALSE)) {
$pos_current_path = strpos($element['#markup'], $search_key_current_path, $offset);
$pos_front = strpos($element['#markup'], $search_key_front, $offset);
// Determine which of the two values is the next match: the exact path, or
// the <front> special case.
$pos_match = NULL;
if ($pos_front === FALSE) {
$pos_match = $pos_current_path;
}
elseif ($pos_current_path === FALSE) {
$pos_match = $pos_front;
}
elseif ($pos_current_path < $pos_front) {
$pos_match = $pos_current_path;
}
else {
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
$pos_match = $pos_front;
}
// Find beginning and ending of opening tag.
$pos_tag_start = NULL;
for ($i = $pos_match; $pos_tag_start === NULL && $i > 0; $i--) {
if ($element['#markup'][$i] === '<') {
$pos_tag_start = $i;
}
}
$pos_tag_end = NULL;
for ($i = $pos_match; $pos_tag_end === NULL && $i < strlen($element['#markup']); $i++) {
if ($element['#markup'][$i] === '>') {
$pos_tag_end = $i;
}
}
// Get the HTML: this will be the opening part of a single tag, e.g.:
// <a href="/" data-drupal-link-system-path="<front>">
$tag = substr($element['#markup'], $pos_tag_start, $pos_tag_end - $pos_tag_start + 1);
// Parse it into a DOMDocument so we can reliably read and modify
// attributes.
$dom = new \DOMDocument();
@$dom->loadHTML('<!DOCTYPE html><html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8" /></head><body>' . $tag . '</body></html>');
$node = $dom->getElementsByTagName('body')->item(0)->firstChild;
Alex Pott
committed
// Ensure we don't set the "active" class twice on the same element.
$class = $node->getAttribute('class');
$add_active = !in_array('is-active', explode(' ', $class));
Alex Pott
committed
// The language of an active link is equal to the current language.
Alex Pott
committed
if ($add_active && $context['language']) {
if ($node->hasAttribute('hreflang') && $node->getAttribute('hreflang') !== $context['language']) {
Alex Pott
committed
$add_active = FALSE;
}
}
// The query parameters of an active link are equal to the current
// parameters.
Alex Pott
committed
if ($add_active) {
if ($context['query']) {
if (!$node->hasAttribute('data-drupal-link-query') || $node->getAttribute('data-drupal-link-query') !== Json::encode($context['query'])) {
Alex Pott
committed
$add_active = FALSE;
}
}
else {
if ($node->hasAttribute('data-drupal-link-query')) {
Alex Pott
committed
$add_active = FALSE;
}
}
}
// Only if the path, the language and the query match, we set the
// "is-active" class.
Alex Pott
committed
if ($add_active) {
if (strlen($class) > 0) {
$class .= ' ';
}
$class .= 'is-active';
$node->setAttribute('class', $class);
// Get the updated tag.
$updated_tag = $dom->saveXML($node, LIBXML_NOEMPTYTAG);
// saveXML() added a closing tag, remove it.
$updated_tag = substr($updated_tag, 0, strrpos($updated_tag, '<'));
$element['#markup'] = str_replace($tag, $updated_tag, $element['#markup']);
// Ensure we only search the remaining HTML.
$offset = $pos_tag_end - strlen($tag) + strlen($updated_tag);
}
else {
// Ensure we only search the remaining HTML.
$offset = $pos_tag_end + 1;
}
}
return $element;
}