This repository has been archived on 2025-01-19. You can view files and clone it, but cannot push or open issues or pull requests.
drupalcampbristol/web/modules/contrib/webform/includes/webform.install.requirements.inc
2018-11-23 12:29:20 +00:00

171 lines
6.4 KiB
PHP

<?php
/**
* @file
* Webform requirements.
*/
use Drupal\Component\Render\FormattableMarkup;
use Drupal\Core\Url;
use Drupal\webform\Plugin\WebformElement\ManagedFile;
/**
* Implements hook_requirements().
*/
function webform_requirements($phase) {
if ($phase != 'runtime') {
return [];
}
$requirements = [];
/****************************************************************************/
// Check HTML email handling.
/****************************************************************************/
/** @var \Drupal\webform\WebformEmailProviderInterface $email_provider */
$email_provider = \Drupal::service('webform.email_provider');
$mail_module_name = $email_provider->getModuleName();
$mail_plugin_id = $email_provider->getMailPluginId();
$mail_plugin_definition = $email_provider->getMailPluginDefinition();
if ($mail_module_name || $mail_plugin_id) {
$t_args = [
'@module' => $mail_module_name,
'@plugin_id' => $mail_plugin_id,
'@plugin_label' => $mail_plugin_definition['label'],
'@plugin_description' => $mail_plugin_definition['description'],
];
$requirements['webform_email'] = [
'title' => t('Webform: HTML email support'),
'value' => ($mail_module_name) ? t('Provided by the @module module.', $t_args) : t('Provided by @plugin_id mail plugin.', $t_args),
'description' => new FormattableMarkup('@plugin_label: @plugin_description', $t_args),
'severity' => REQUIREMENT_OK,
];
}
else {
$requirements['webform_email'] = [
'title' => t('Webform: HTML email support'),
'value' => t('Unable to determine email module and/or provider'),
'severity' => REQUIREMENT_ERROR,
];
}
/****************************************************************************/
// Check private file upload.
/****************************************************************************/
$scheme_options = ManagedFile::getVisibleStreamWrappers();
if (isset($scheme_options['private'])) {
$requirements['webform_file_private'] = [
'title' => t('Webform: Private files'),
'value' => t('Private file system is set.'),
];
}
else {
$requirements['webform_file_private'] = [
'title' => t('Webform: Private files'),
'value' => t('Private file system is not set.'),
'description' => t('This must be changed in <a href="https://www.drupal.org/documentation/modules/file">settings.php</a>. For more information see: <a href="https://www.drupal.org/psa-2016-003">DRUPAL-PSA-2016-003</a>'),
'severity' => REQUIREMENT_WARNING,
];
}
/****************************************************************************/
// Check external libraries.
/****************************************************************************/
/** @var \Drupal\webform\WebformLibrariesManagerInterface $libraries_manager */
$libraries_manager = \Drupal::service('webform.libraries_manager');
$requirements += $libraries_manager->requirements();
/****************************************************************************/
// Check Bootstrap theme.
/****************************************************************************/
if (\Drupal::config('webform.settings')->get('requirements.bootstrap')) {
$spam_protection = FALSE;
$themes = \Drupal::service('theme_handler')->listInfo();
foreach ($themes as $theme) {
if ((isset($theme->base_themes) && isset($theme->base_themes['bootstrap'])) || $theme == 'bootstrap') {
$spam_protection = TRUE;
}
}
if ($spam_protection) {
if (\Drupal::moduleHandler()->moduleExists('webform_bootstrap')) {
$requirements['webform_bootstrap'] = [
'title' => t('Webform: Bootstrap integration'),
'value' => t('Webform Bootstrap module installed.'),
];
}
else {
$requirements['webform_bootstrap'] = [
'title' => t('Webform: Bootstrap integration'),
'value' => t('Webform Bootstrap Integration module not installed.'),
'description' => t('The Webform Bootstrap module helps support Webform to Bootstrap integration. <a href=":href">Disable Webform Bootstrap Integration warning</a>', [':href' => Url::fromRoute('webform.config.advanced')->toString()]),
'severity' => REQUIREMENT_WARNING,
];
}
}
}
/****************************************************************************/
// Check SPAM protection.
/****************************************************************************/
if (\Drupal::config('webform.settings')->get('requirements.spam')) {
$spam_protection = FALSE;
$installed_projects = [
'#prefix' => '<p><hr/></p><dl>',
'#suffix' => '</dl>',
];
$available_projects = [
'#prefix' => '<p><hr/></p><dl>',
'#suffix' => '</dl>',
];
/** @var \Drupal\webform\WebformAddonsManagerInterface $addons_manager */
$addons_manager = \Drupal::service('webform.addons_manager');
$projects = $addons_manager->getProjects('spam');
foreach ($projects as $project_name => $project) {
$available_projects[$project_name] = [
'title' => [
'#type' => 'link',
'#title' => $project['title'],
'#url' => $project['url'],
'#prefix' => '<dt><strong>',
'#suffix' => '</strong></dt>',
],
'description' => [
'#markup' => $project['description'],
'#prefix' => '<dd>',
'#suffix' => '</dd>',
],
];
if (\Drupal::moduleHandler()->moduleExists($project_name)) {
$spam_protection = TRUE;
$installed_projects[$project_name] = $available_projects[$project_name];
}
}
if ($spam_protection) {
$requirements['webform_spam'] = [
'title' => t('Webform: SPAM protection'),
'value' => t('Webform SPAM protection module installed.'),
'description' => \Drupal::service('renderer')->renderPlain($installed_projects),
];
}
else {
$requirements['webform_spam'] = [
'title' => t('Webform: SPAM protection'),
'value' => t('Webform <a href=":href">SPAM protection module</a> missing. Please install one of the below modules.', [':href' => 'https://www.drupal.org/node/206787']),
'description' => \Drupal::service('renderer')->renderPlain($available_projects),
'severity' => REQUIREMENT_WARNING,
];
}
}
// Sort all requirements alphabetically.
ksort($requirements);
return $requirements;
}