View source
<?php
namespace Drupal\search;
use Drupal\Core\Config\ConfigFactoryInterface;
use Drupal\Core\Config\Entity\DraggableListBuilder;
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Entity\EntityStorageInterface;
use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\Core\Form\ConfigFormBaseTrait;
use Drupal\Core\Form\FormInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Messenger\MessengerInterface;
use Drupal\Core\Url;
use Symfony\Component\DependencyInjection\ContainerInterface;
class SearchPageListBuilder extends DraggableListBuilder implements FormInterface {
use ConfigFormBaseTrait;
protected $entities = [];
protected $configFactory;
protected $searchManager;
protected $searchIndex;
protected $messenger;
public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $storage, SearchPluginManager $search_manager, ConfigFactoryInterface $config_factory, MessengerInterface $messenger, SearchIndexInterface $search_index = NULL) {
parent::__construct($entity_type, $storage);
$this->configFactory = $config_factory;
$this->searchManager = $search_manager;
$this->messenger = $messenger;
if (!$search_index) {
@trigger_error('Calling SearchPageListBuilder::__construct() without the $search_index argument is deprecated in drupal:8.8.0 and is required in drupal:9.0.0. See https://www.drupal.org/node/3075696', E_USER_DEPRECATED);
$search_index = \Drupal::service('search.index');
}
$this->searchIndex = $search_index;
}
public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
return new static($entity_type, $container
->get('entity_type.manager')
->getStorage($entity_type
->id()), $container
->get('plugin.manager.search'), $container
->get('config.factory'), $container
->get('messenger'), $container
->get('search.index'));
}
public function getFormId() {
return 'search_admin_settings';
}
protected function getEditableConfigNames() {
return [
'search.settings',
];
}
public function buildHeader() {
$header['label'] = [
'data' => $this
->t('Label'),
];
$header['url'] = [
'data' => $this
->t('URL'),
'class' => [
RESPONSIVE_PRIORITY_LOW,
],
];
$header['plugin'] = [
'data' => $this
->t('Type'),
'class' => [
RESPONSIVE_PRIORITY_LOW,
],
];
$header['status'] = [
'data' => $this
->t('Status'),
];
$header['progress'] = [
'data' => $this
->t('Indexing progress'),
'class' => [
RESPONSIVE_PRIORITY_MEDIUM,
],
];
return $header + parent::buildHeader();
}
public function buildRow(EntityInterface $entity) {
$row['label'] = $entity
->label();
$row['url']['#markup'] = 'search/' . $entity
->getPath();
if ($entity
->status()) {
$row['url'] = [
'#type' => 'link',
'#title' => $row['url'],
'#url' => Url::fromRoute('search.view_' . $entity
->id()),
];
}
$definition = $entity
->getPlugin()
->getPluginDefinition();
$row['plugin']['#markup'] = $definition['title'];
if ($entity
->isDefaultSearch()) {
$status = $this
->t('Default');
}
elseif ($entity
->status()) {
$status = $this
->t('Enabled');
}
else {
$status = $this
->t('Disabled');
}
$row['status']['#markup'] = $status;
if ($entity
->isIndexable()) {
$status = $entity
->getPlugin()
->indexStatus();
$row['progress']['#markup'] = $this
->t('%num_indexed of %num_total indexed', [
'%num_indexed' => $status['total'] - $status['remaining'],
'%num_total' => $status['total'],
]);
}
else {
$row['progress']['#markup'] = $this
->t('Does not use index');
}
return $row + parent::buildRow($entity);
}
public function buildForm(array $form, FormStateInterface $form_state) {
$form = parent::buildForm($form, $form_state);
$search_settings = $this
->config('search.settings');
$remaining = 0;
$total = 0;
foreach ($this->entities as $entity) {
if ($entity
->isIndexable() && ($status = $entity
->getPlugin()
->indexStatus())) {
$remaining += $status['remaining'];
$total += $status['total'];
}
}
$this->moduleHandler
->loadAllIncludes('admin.inc');
$count = $this
->formatPlural($remaining, 'There is 1 item left to index.', 'There are @count items left to index.');
$done = $total - $remaining;
$percentage = $total > 0 ? floor(100 * $done / $total) : 100;
$percentage .= '%';
$status = '<p><strong>' . $this
->t('%percentage of the site has been indexed.', [
'%percentage' => $percentage,
]) . ' ' . $count . '</strong></p>';
$form['status'] = [
'#type' => 'details',
'#title' => $this
->t('Indexing progress'),
'#open' => TRUE,
'#description' => $this
->t('Only items in the index will appear in search results. To build and maintain the index, a correctly configured <a href=":cron">cron maintenance task</a> is required.', [
':cron' => Url::fromRoute('system.cron_settings')
->toString(),
]),
];
$form['status']['status'] = [
'#markup' => $status,
];
$form['status']['wipe'] = [
'#type' => 'submit',
'#value' => $this
->t('Re-index site'),
'#submit' => [
'::searchAdminReindexSubmit',
],
];
$items = [
10,
20,
50,
100,
200,
500,
];
$items = array_combine($items, $items);
$form['indexing_throttle'] = [
'#type' => 'details',
'#title' => $this
->t('Indexing throttle'),
'#open' => TRUE,
];
$form['indexing_throttle']['cron_limit'] = [
'#type' => 'select',
'#title' => $this
->t('Number of items to index per cron run'),
'#default_value' => $search_settings
->get('index.cron_limit'),
'#options' => $items,
'#description' => $this
->t('The maximum number of items indexed in each run of the <a href=":cron">cron maintenance task</a>. If necessary, reduce the number of items to prevent timeouts and memory errors while indexing. Some search page types may have their own setting for this.', [
':cron' => Url::fromRoute('system.cron_settings')
->toString(),
]),
];
$form['indexing_settings'] = [
'#type' => 'details',
'#title' => $this
->t('Default indexing settings'),
'#open' => TRUE,
];
$form['indexing_settings']['info'] = [
'#markup' => $this
->t("<p>Search pages that use an index may use the default index provided by the Search module, or they may use a different indexing mechanism. These settings are for the default index. <em>Changing these settings will cause the default search index to be rebuilt to reflect the new settings. Searching will continue to work, based on the existing index, but new content won't be indexed until all existing content has been re-indexed.</em></p><p><em>The default settings should be appropriate for the majority of sites.</em></p>"),
];
$form['indexing_settings']['minimum_word_size'] = [
'#type' => 'number',
'#title' => $this
->t('Minimum word length to index'),
'#default_value' => $search_settings
->get('index.minimum_word_size'),
'#min' => 1,
'#max' => 1000,
'#description' => $this
->t('The minimum character length for a word to be added to the index. Searches must include a keyword of at least this length.'),
];
$form['indexing_settings']['overlap_cjk'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Simple CJK handling'),
'#default_value' => $search_settings
->get('index.overlap_cjk'),
'#description' => $this
->t('Whether to apply a simple Chinese/Japanese/Korean tokenizer based on overlapping sequences. Turn this off if you want to use an external preprocessor for this instead. Does not affect other languages.'),
];
$form['logging'] = [
'#type' => 'details',
'#title' => $this
->t('Logging'),
'#open' => TRUE,
];
$form['logging']['logging'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Log searches'),
'#default_value' => $search_settings
->get('logging'),
'#description' => $this
->t('If checked, all searches will be logged. Uncheck to skip logging. Logging may affect performance.'),
];
$form['search_pages'] = [
'#type' => 'details',
'#title' => $this
->t('Search pages'),
'#open' => TRUE,
];
$form['search_pages']['add_page'] = [
'#type' => 'container',
'#attributes' => [
'class' => [
'container-inline',
],
],
];
$form['search_pages']['add_page']['search_type'] = [
'#type' => 'select',
'#title' => $this
->t('Search page type'),
'#empty_option' => $this
->t('- Choose page type -'),
'#options' => array_map(function ($definition) {
return $definition['title'];
}, $this->searchManager
->getDefinitions()),
];
$form['search_pages']['add_page']['add_search_submit'] = [
'#type' => 'submit',
'#value' => $this
->t('Add search page'),
'#validate' => [
'::validateAddSearchPage',
],
'#submit' => [
'::submitAddSearchPage',
],
'#limit_validation_errors' => [
[
'search_type',
],
],
];
$form['search_pages'][$this->entitiesKey] = $form[$this->entitiesKey];
$form['search_pages'][$this->entitiesKey]['#empty'] = $this
->t('No search pages have been configured.');
unset($form[$this->entitiesKey]);
$form['actions']['#type'] = 'actions';
$form['actions']['submit'] = [
'#type' => 'submit',
'#value' => $this
->t('Save configuration'),
'#button_type' => 'primary',
];
return $form;
}
public function getDefaultOperations(EntityInterface $entity) {
$operations = parent::getDefaultOperations($entity);
if ($entity
->isDefaultSearch()) {
unset($operations['disable'], $operations['delete']);
}
else {
$operations['default'] = [
'title' => $this
->t('Set as default'),
'url' => Url::fromRoute('entity.search_page.set_default', [
'search_page' => $entity
->id(),
]),
'weight' => 50,
];
}
return $operations;
}
public function validateForm(array &$form, FormStateInterface $form_state) {
}
public function submitForm(array &$form, FormStateInterface $form_state) {
parent::submitForm($form, $form_state);
$search_settings = $this
->config('search.settings');
if ($search_settings
->get('index.minimum_word_size') != $form_state
->getValue('minimum_word_size') || $search_settings
->get('index.overlap_cjk') != $form_state
->getValue('overlap_cjk')) {
$search_settings
->set('index.minimum_word_size', $form_state
->getValue('minimum_word_size'));
$search_settings
->set('index.overlap_cjk', $form_state
->getValue('overlap_cjk'));
$this->messenger
->addStatus($this
->t('The default search index will be rebuilt.'));
$this->searchIndex
->markForReindex();
}
$search_settings
->set('index.cron_limit', $form_state
->getValue('cron_limit'))
->set('logging', $form_state
->getValue('logging'))
->save();
$this->messenger
->addStatus($this
->t('The configuration options have been saved.'));
}
public function searchAdminReindexSubmit(array &$form, FormStateInterface $form_state) {
$form_state
->setRedirect('search.reindex_confirm');
}
public function validateAddSearchPage(array &$form, FormStateInterface $form_state) {
if ($form_state
->isValueEmpty('search_type')) {
$form_state
->setErrorByName('search_type', $this
->t('You must select the new search page type.'));
}
}
public function submitAddSearchPage(array &$form, FormStateInterface $form_state) {
$form_state
->setRedirect('search.add_type', [
'search_plugin_id' => $form_state
->getValue('search_type'),
]);
}
}