class SpiController in Acquia Connector 3.x
Same name and namespace in other branches
- 8.2 src/Controller/SpiController.php \Drupal\acquia_connector\Controller\SpiController
- 8 src/Controller/SpiController.php \Drupal\acquia_connector\Controller\SpiController
SPI Controller class.
Hierarchy
- class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
- class \Drupal\acquia_connector\Controller\SpiController
Expanded class hierarchy of SpiController
4 files declare their use of SpiController
- AcquiaConnectorCommands.php in src/
Commands/ AcquiaConnectorCommands.php - AcquiaConnectorSpiTest.php in tests/
src/ Functional/ AcquiaConnectorSpiTest.php - InitSubscriber.php in src/
EventSubscriber/ InitSubscriber.php - SettingsForm.php in src/
Form/ SettingsForm.php
1 string reference to 'SpiController'
1 service uses SpiController
File
- src/
Controller/ SpiController.php, line 31
Namespace
Drupal\acquia_connector\ControllerView source
class SpiController extends ControllerBase {
/**
* The Acquia client.
*
* @var \Drupal\acquia_connector\Client
*/
protected $client;
/**
* Path alias manager.
*
* @var mixed
*/
protected $pathAliasManager;
/**
* Constructs a \Drupal\system\ConfigFormBase object.
*
* @param \Drupal\acquia_connector\Client $client
* Acquia Client.
* @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
* Config factory service.
* @param \Drupal\path_alias\AliasManagerInterface $path_alias
* Path alias service.
*/
public function __construct(Client $client, ConfigFactoryInterface $config_factory, AliasManagerInterface $path_alias) {
$this->client = $client;
$this->configFactory = $config_factory;
$this->pathAliasManager = $path_alias;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container
->get('acquia_connector.client'), $container
->get('config.factory'), $container
->get('path_alias.manager'));
}
/**
* Gather site profile information about this site.
*
* @param string $method
* Optional identifier for the method initiating request.
* Values could be 'cron' or 'menu callback' or 'drush'.
*
* @return array
* An associative array keyed by types of information.
*/
public function get($method = '') {
$config = $this->configFactory
->getEditable('acquia_connector.settings');
// Get the Drupal version.
$drupal_version = $this
->getVersionInfo();
$stored = $this
->dataStoreGet([
'platform',
]);
if (!empty($stored['platform'])) {
$platform = $stored['platform'];
}
else {
$platform = $this
->getPlatform();
}
$acquia_hosted = $this
->checkAcquiaHosted();
$environment = $this
->config('acquia_connector.settings')
->get('spi.site_environment');
$env_detection_enabled = $this
->config('acquia_connector.settings')
->get('spi.env_detection_enabled');
if ($acquia_hosted) {
if ($environment != $_SERVER['AH_SITE_ENVIRONMENT']) {
$config
->set('spi.site_environment', $_SERVER['AH_SITE_ENVIRONMENT']);
$environment = $_SERVER['AH_SITE_ENVIRONMENT'];
if ($env_detection_enabled) {
$this
->state()
->set('spi.site_machine_name', $this
->getAcquiaHostedMachineName());
}
}
}
else {
if ($environment) {
$config
->set('spi.site_environment', NULL);
}
$environment = NULL;
}
if ($env_detection_enabled === NULL) {
$config
->set('spi.env_detection_enabled', TRUE);
}
$config
->save();
$spi = [
// Used in HMAC validation.
'rpc_version' => ACQUIA_CONNECTOR_ACQUIA_SPI_DATA_VERSION,
// Used in Fix it now feature.
'spi_data_version' => ACQUIA_CONNECTOR_ACQUIA_SPI_DATA_VERSION,
'site_key' => sha1(\Drupal::service('private_key')
->get()),
'site_uuid' => $this
->config('acquia_connector.settings')
->get('spi.site_uuid'),
'env_changed_action' => $this
->config('acquia_connector.settings')
->get('spi.environment_changed_action'),
'acquia_hosted' => $acquia_hosted,
'name' => $this
->state()
->get('spi.site_name'),
'machine_name' => $this
->state()
->get('spi.site_machine_name'),
'environment' => $environment,
'modules' => $this
->getModules(),
'platform' => $platform,
'quantum' => $this
->getQuantum(),
'system_status' => $this
->getSystemStatus(),
'failed_logins' => $this
->config('acquia_connector.settings')
->get('spi.send_watchdog') ? $this
->getFailedLogins() : [],
'404s' => $this
->config('acquia_connector.settings')
->get('spi.send_watchdog') ? $this
->get404s() : [],
'watchdog_size' => $this
->getWatchdogSize(),
'watchdog_data' => $this
->config('acquia_connector.settings')
->get('spi.send_watchdog') ? $this
->getWatchdogData() : [],
'last_nodes' => $this
->config('acquia_connector.settings')
->get('spi.send_node_user') ? $this
->getLastNodes() : [],
'last_users' => $this
->config('acquia_connector.settings')
->get('spi.send_node_user') ? $this
->getLastUsers() : [],
'extra_files' => $this
->checkFilesPresent(),
'ssl_login' => $this
->checkLogin(),
'distribution' => isset($drupal_version['distribution']) ? $drupal_version['distribution'] : '',
'base_version' => $drupal_version['base_version'],
'build_data' => $drupal_version,
'roles' => Json::encode(user_roles()),
'uid_0_present' => $this
->getUidZeroIsPresent(),
];
$scheme = parse_url($this
->config('acquia_connector.settings')
->get('spi.server'), PHP_URL_SCHEME);
$via_ssl = in_array('ssl', stream_get_transports(), TRUE) && $scheme == 'https' ? TRUE : FALSE;
if ($this
->config('acquia_connector.settings')
->get('spi.ssl_override')) {
$via_ssl = TRUE;
}
$additional_data = [];
$security_review = new SecurityReviewController();
$security_review_results = $security_review
->runSecurityReview();
// It's worth sending along node access control information even if there
// are no modules implementing it - some alerts are simpler if we know we
// don't have to worry about node access.
// Check for node grants modules.
$additional_data['node_grants_modules'] = $this
->moduleHandler()
->getImplementations('node_grants');
// Check for node access modules.
$additional_data['node_access_modules'] = $this
->moduleHandler()
->getImplementations('node_access');
if (!empty($security_review_results)) {
$additional_data['security_review'] = $security_review_results['security_review'];
}
// Collect all user-contributed custom tests that pass validation.
$custom_tests_results = $this
->testCollect();
if (!empty($custom_tests_results)) {
$additional_data['custom_tests'] = $custom_tests_results;
}
$spi_data = $this
->moduleHandler()
->invokeAll('acquia_connector_spi_get');
if (!empty($spi_data)) {
foreach ($spi_data as $name => $data) {
if (is_string($name) && is_array($data)) {
$additional_data[$name] = $data;
}
}
}
include_once "core/includes/update.inc";
$additional_data['pending_updates'] = (bool) update_get_update_list();
if (!empty($additional_data)) {
// JSON encode this additional data.
$spi['additional_data'] = json_encode($additional_data);
}
if (!empty($method)) {
$spi['send_method'] = $method;
}
if (!$via_ssl) {
return $spi;
}
else {
$variablesController = new VariablesController();
// Values returned only over SSL.
$spi_ssl = [
'system_vars' => $variablesController
->getVariablesData(),
'settings_ra' => $this
->getSettingsPermissions(),
'admin_count' => $this
->config('acquia_connector.settings')
->get('spi.admin_priv') ? $this
->getAdminCount() : '',
'admin_name' => $this
->config('acquia_connector.settings')
->get('spi.admin_priv') ? $this
->getSuperName() : '',
];
return array_merge($spi, $spi_ssl);
}
}
/**
* Collects all user-contributed test results that pass validation.
*
* @return array
* An associative array containing properly formatted user-contributed
* tests.
*/
private function testCollect() {
$custom_data = [];
// Collect all custom data provided by hook_insight_custom_data().
$collections = $this
->moduleHandler()
->invokeAll('acquia_connector_spi_test');
foreach ($collections as $test_name => $test_params) {
$status = new TestStatusController();
$result = $status
->testValidate([
$test_name => $test_params,
]);
if ($result['result']) {
$custom_data[$test_name] = $test_params;
}
}
return $custom_data;
}
/**
* Checks to see if SSL login is required.
*
* @return int
* 1 if SSL login is required.
*/
private function checkLogin() {
$login_safe = 0;
if ($this
->moduleHandler()
->moduleExists('securelogin')) {
$secureLoginConfig = $this
->config('securelogin.settings')
->get();
if ($secureLoginConfig['all_forms']) {
$forms_safe = TRUE;
}
else {
// All the required forms should be enabled.
$required_forms = [
'form_user_login_form',
'form_user_form',
'form_user_register_form',
'form_user_pass_reset',
'form_user_pass',
];
$forms_safe = TRUE;
foreach ($required_forms as $form_variable) {
if (!$secureLoginConfig[$form_variable]) {
$forms_safe = FALSE;
break;
}
}
}
// \Drupal::request()->isSecure() ($conf['https'] in D7) should be false
// for expected behavior.
if ($forms_safe && !\Drupal::request()
->isSecure()) {
$login_safe = 1;
}
}
return $login_safe;
}
/**
* Check to see if the unneeded release files with Drupal are removed.
*
* @return int
* 1 if they are removed, 0 if they aren't.
*/
private function checkFilesPresent() {
$files_exist = FALSE;
$files_to_remove = [
'CHANGELOG.txt',
'COPYRIGHT.txt',
'INSTALL.mysql.txt',
'INSTALL.pgsql.txt',
'INSTALL.txt',
'LICENSE.txt',
'MAINTAINERS.txt',
'README.txt',
'UPGRADE.txt',
'PRESSFLOW.txt',
'install.php',
];
foreach ($files_to_remove as $file) {
$path = DRUPAL_ROOT . DIRECTORY_SEPARATOR . $file;
if (file_exists($path)) {
$files_exist = TRUE;
}
}
return $files_exist ? 1 : 0;
}
/**
* Attempt to determine if this site is hosted with Acquia.
*
* @return bool
* TRUE if site is hosted with Acquia, otherwise FALSE.
*/
public function checkAcquiaHosted() {
return isset($_SERVER['AH_SITE_ENVIRONMENT'], $_SERVER['AH_SITE_NAME']);
}
/**
* Generate the name for acquia hosted sites.
*
* @return string
* The Acquia Hosted name.
*/
public function getAcquiaHostedName() {
$subscription_name = $this
->config('acquia_connector.settings')
->get('subscription_name');
if ($this
->checkAcquiaHosted() && $subscription_name) {
return $this
->config('acquia_connector.settings')
->get('subscription_name') . ': ' . $_SERVER['AH_SITE_ENVIRONMENT'];
}
}
/**
* Generate the machine name for acquia hosted sites.
*
* @return string
* The suggested Acquia Hosted machine name.
*/
public function getAcquiaHostedMachineName() {
$sub_data = $this
->state()
->get('acquia_subscription_data');
if ($this
->checkAcquiaHosted() && is_array($sub_data)) {
$uuid = new StatusController();
$sub_uuid = str_replace('-', '_', $uuid
->getIdFromSub($sub_data));
return $sub_uuid . '__' . $_SERVER['AH_SITE_NAME'] . '__' . uniqid();
}
}
/**
* Check if a site environment change has been detected.
*
* @return bool
* TRUE if change detected that needs to be addressed, otherwise FALSE.
*/
public function checkEnvironmentChange() {
$changes = $this
->config('acquia_connector.settings')
->get('spi.environment_changes');
$change_action = $this
->config('acquia_connector.settings')
->get('spi.environment_changed_action');
return !empty($changes) && empty($change_action);
}
/**
* Get last 15 users created.
*
* Useful for determining if your site is compromised.
*
* @return array
* The details of last 15 users created.
*/
private function getLastUsers() {
$last_five_users = [];
$result = Database::getConnection()
->select('users_field_data', 'u')
->fields('u', [
'uid',
'name',
'mail',
'created',
])
->condition('u.created', \Drupal::time()
->getRequestTime() - 3600, '>')
->orderBy('created', 'DESC')
->range(0, 15)
->execute();
$count = 0;
foreach ($result as $record) {
$last_five_users[$count]['uid'] = $record->uid;
$last_five_users[$count]['name'] = $record->name;
$last_five_users[$count]['email'] = $record->mail;
$last_five_users[$count]['created'] = $record->created;
$count++;
}
return $last_five_users;
}
/**
* Get last 15 nodes created.
*
* This can be useful to determine if you have some sort of spam on your site.
*
* @return array
* Array of the details of last 15 nodes created.
*/
private function getLastNodes() {
$last_five_nodes = [];
if ($this
->moduleHandler()
->moduleExists('node')) {
$result = Database::getConnection()
->select('node_field_data', 'n')
->fields('n', [
'title',
'type',
'nid',
'created',
'langcode',
])
->condition('n.created', \Drupal::time()
->getRequestTime() - 3600, '>')
->orderBy('n.created', 'DESC')
->range(0, 15)
->execute();
$count = 0;
foreach ($result as $record) {
$last_five_nodes[$count]['url'] = $this->pathAliasManager
->getAliasByPath('/node/' . $record->nid, $record->langcode);
$last_five_nodes[$count]['title'] = $record->title;
$last_five_nodes[$count]['type'] = $record->type;
$last_five_nodes[$count]['created'] = $record->created;
$count++;
}
}
return $last_five_nodes;
}
/**
* Get the latest (last hour) critical and emergency warnings from watchdog.
*
* These errors are 'severity' 0 and 2.
*
* @return array
* EMERGENCY and CRITICAL watchdog records for last hour.
*/
private function getWatchdogData() {
$wd = [];
if ($this
->moduleHandler()
->moduleExists('dblog')) {
// phpcs:disable
$result = Database::getConnection()
->select('watchdog', 'w')
->fields('w', [
'wid',
'severity',
'type',
'message',
'timestamp',
])
->condition('w.severity', [
RfcLogLevel::EMERGENCY,
RfcLogLevel::CRITICAL,
], 'IN')
->condition('w.timestamp', \Drupal::time()
->getRequestTime() - 3600, '>')
->execute();
// phpcs:enable
while ($record = $result
->fetchAssoc()) {
$wd[$record['severity']] = $record;
}
}
return $wd;
}
/**
* Get the number of rows in watchdog.
*
* @return int
* Number of watchdog records.
*/
private function getWatchdogSize() {
if ($this
->moduleHandler()
->moduleExists('dblog')) {
return Database::getConnection()
->select('watchdog', 'w')
->fields('w', [
'wid',
])
->countQuery()
->execute()
->fetchField();
}
}
/**
* Grabs the last 404 errors in logs.
*
* Grabs the last 404 errors in logs, excluding the checks we run for drupal
* files like README.
*
* @return array
* An array of the pages not found and some associated data.
*/
private function get404s() {
$data = [];
$row = 0;
if ($this
->moduleHandler()
->moduleExists('dblog')) {
$result = Database::getConnection()
->select('watchdog', 'w')
->fields('w', [
'message',
'hostname',
'referer',
'timestamp',
])
->condition('w.type', 'page not found', '=')
->condition('w.timestamp', \Drupal::time()
->getRequestTime() - 3600, '>')
->condition('w.message', [
"UPGRADE.txt",
"MAINTAINERS.txt",
"README.txt",
"INSTALL.pgsql.txt",
"INSTALL.txt",
"LICENSE.txt",
"INSTALL.mysql.txt",
"COPYRIGHT.txt",
"CHANGELOG.txt",
], 'NOT IN')
->orderBy('w.timestamp', 'DESC')
->range(0, 10)
->execute();
foreach ($result as $record) {
$data[$row]['message'] = $record->message;
$data[$row]['hostname'] = $record->hostname;
$data[$row]['referer'] = $record->referer;
$data[$row]['timestamp'] = $record->timestamp;
$row++;
}
}
return $data;
}
/**
* Get the information on failed logins in the last cron interval.
*
* @return array
* Array of last 10 failed logins.
*/
private function getFailedLogins() {
$last_logins = [];
$cron_interval = $this
->config('acquia_connector.settings')
->get('spi.cron_interval');
if ($this
->moduleHandler()
->moduleExists('dblog')) {
$result = Database::getConnection()
->select('watchdog', 'w')
->fields('w', [
'message',
'variables',
'timestamp',
])
->condition('w.message', 'login attempt failed%', 'LIKE')
->condition('w.timestamp', \Drupal::time()
->getRequestTime() - $cron_interval, '>')
->condition('w.message', [
"UPGRADE.txt",
"MAINTAINERS.txt",
"README.txt",
"INSTALL.pgsql.txt",
"INSTALL.txt",
"LICENSE.txt",
"INSTALL.mysql.txt",
"COPYRIGHT.txt",
"CHANGELOG.txt",
], 'NOT IN')
->orderBy('w.timestamp', 'DESC')
->range(0, 10)
->execute();
foreach ($result as $record) {
$variables = unserialize($record->variables);
if (!empty($variables['%user'])) {
$last_logins['failed'][$record->timestamp] = Html::escape($variables['%user']);
}
}
}
return $last_logins;
}
/**
* This function is a trimmed version of Drupal's system_status function.
*
* @return array
* System status array.
*/
private function getSystemStatus() {
$data = [];
if (\Drupal::hasContainer()) {
$profile = \Drupal::installProfile();
}
else {
$profile = BootstrapConfigStorageFactory::getDatabaseStorage()
->read('core.extension')['profile'];
}
if ($profile != 'standard') {
$extension_list = \Drupal::service('extension.list.module');
$info = $extension_list
->getExtensionInfo($profile);
$data['install_profile'] = [
'title' => 'Install profile',
'value' => sprintf('%s (%s-%s)', $info['name'], $profile, $info['version']),
];
}
$data['php'] = [
'title' => 'PHP',
'value' => phpversion(),
];
$conf_dir = TRUE;
$settings = TRUE;
$dir = DrupalKernel::findSitePath(\Drupal::request(), TRUE);
if (is_writable($dir) || is_writable($dir . '/settings.php')) {
$value = 'Not protected';
if (is_writable($dir)) {
$conf_dir = FALSE;
}
elseif (is_writable($dir . '/settings.php')) {
$settings = FALSE;
}
}
else {
$value = 'Protected';
}
$data['settings.php'] = [
'title' => 'Configuration file',
'value' => $value,
'conf_dir' => $conf_dir,
'settings' => $settings,
];
$cron_last = \Drupal::state()
->get('system.cron_last');
if (!is_numeric($cron_last)) {
$cron_last = \Drupal::state()
->get('install_time', 0);
}
$data['cron'] = [
'title' => 'Cron maintenance tasks',
'value' => sprintf('Last run %s ago', \Drupal::service('date.formatter')
->formatInterval(\Drupal::time()
->getRequestTime() - $cron_last)),
'cron_last' => $cron_last,
];
if (!empty(Settings::get('update_free_access'))) {
$data['update access'] = [
'value' => 'Not protected',
'protected' => FALSE,
];
}
else {
$data['update access'] = [
'value' => 'Protected',
'protected' => TRUE,
];
}
$data['update access']['title'] = 'Access to update.php';
if (!$this
->moduleHandler()
->moduleExists('update')) {
$data['update status'] = [
'value' => 'Not enabled',
];
}
else {
$data['update status'] = [
'value' => 'Enabled',
];
}
$data['update status']['title'] = 'Update notifications';
return $data;
}
/**
* Check the presence of UID 0 in the users table.
*
* @return bool
* Whether UID 0 is present.
*/
private function getUidZeroIsPresent() {
$count = Database::getConnection()
->query('SELECT uid FROM {users} WHERE uid = 0')
->fetchAll();
return (bool) $count;
}
/**
* The number of users who have admin-level user roles.
*
* @return int
* Count of admin users.
*/
private function getAdminCount() {
$roles_name = [];
$get_roles = Role::loadMultiple();
unset($get_roles[AccountInterface::ANONYMOUS_ROLE]);
$permission = [
'administer permissions',
'administer users',
];
foreach ($permission as $value) {
$filtered_roles = array_filter($get_roles, function ($role) use ($value) {
return $role
->hasPermission($value);
});
foreach ($filtered_roles as $role_name => $data) {
$roles_name[] = $role_name;
}
}
if (!empty($roles_name)) {
$roles_name_unique = array_unique($roles_name);
$query = Database::getConnection()
->select('user__roles', 'ur');
$query
->fields('ur', [
'entity_id',
]);
$query
->condition('ur.bundle', 'user', '=');
$query
->condition('ur.deleted', '0', '=');
$query
->condition('ur.roles_target_id', $roles_name_unique, 'IN');
$count = $query
->countQuery()
->execute()
->fetchField();
}
return isset($count) && is_numeric($count) ? $count : NULL;
}
/**
* Determine if the super user has a weak name.
*
* @return int
* 1 if the super user has a weak name, 0 otherwise.
*/
private function getSuperName() {
$result = Database::getConnection()
->query("SELECT name FROM {users_field_data} WHERE uid = 1 AND (name LIKE '%admin%' OR name LIKE '%root%') AND LENGTH(name) < 15")
->fetchAll();
return (int) $result;
}
/**
* Determines if settings.php is read-only.
*
* @return bool
* TRUE if settings.php is read-only, FALSE otherwise.
*/
private function getSettingsPermissions() {
$settings_permissions_read_only = TRUE;
// http://en.wikipedia.org/wiki/File_system_permissions.
$writes = [
'2',
'3',
'6',
'7',
];
$settings_file = './' . DrupalKernel::findSitePath(\Drupal::request(), TRUE) . '/settings.php';
$permissions = mb_substr(sprintf('%o', fileperms($settings_file)), -4);
foreach ($writes as $bit) {
if (strpos($permissions, $bit)) {
$settings_permissions_read_only = FALSE;
break;
}
}
return $settings_permissions_read_only;
}
/**
* Determine if a path is a file type we care about for modifications.
*/
private function isManifestType($path) {
$extensions = [
'yml' => 1,
'php' => 1,
'php4' => 1,
'php5' => 1,
'module' => 1,
'inc' => 1,
'install' => 1,
'test' => 1,
'theme' => 1,
'engine' => 1,
'profile' => 1,
'css' => 1,
'js' => 1,
'info' => 1,
'sh' => 1,
// SSL certificates.
'pem' => 1,
'pl' => 1,
'pm' => 1,
];
$pathinfo = pathinfo($path);
return isset($pathinfo['extension']) && isset($extensions[$pathinfo['extension']]);
}
/**
* Calculate the sha1 hash for a path.
*
* @param string $path
* The name of the file or a directory.
*
* @return string
* base64 encoded sha1 hash. 'hash' is an empty string for directories.
*/
private function hashPath($path = '') {
$hash = '';
if (file_exists($path)) {
if (!is_dir($path)) {
$string = file_get_contents($path);
// Remove trailing whitespace.
$string = rtrim($string);
// Replace all line endings and CVS/svn Id tags.
$string = preg_replace('/\\$Id[^;<>{}\\(\\)\\$]*\\$/', 'x$' . 'Id$', $string);
$string = preg_replace('/\\r\\n|\\n|\\r/', ' ', $string);
$hash = base64_encode(pack("H*", sha1($string)));
}
}
return $hash;
}
/**
* Attempt to determine the version of Drupal being used.
*
* Note, there is better information on this in the common.inc file.
*
* @return array
* An array containing some detail about the version
*/
private function getVersionInfo() {
$server = \Drupal::request()->server
->all();
$ver = [];
$ver['base_version'] = \Drupal::VERSION;
$install_root = DRUPAL_ROOT;
$ver['distribution'] = '';
// Determine if this puppy is Acquia Drupal.
acquia_connector_load_versions();
if (IS_ACQUIA_DRUPAL) {
$ver['distribution'] = 'Acquia Drupal';
$ver['ad']['version'] = ACQUIA_DRUPAL_VERSION;
$ver['ad']['series'] = ACQUIA_DRUPAL_SERIES;
$ver['ad']['branch'] = ACQUIA_DRUPAL_BRANCH;
$ver['ad']['revision'] = ACQUIA_DRUPAL_REVISION;
}
// Determine if we are looking at Pressflow.
if (defined('CACHE_EXTERNAL')) {
$ver['distribution'] = 'Pressflow';
$press_version_file = $install_root . './PRESSFLOW.txt';
if (is_file($press_version_file)) {
$ver['pr']['version'] = trim(file_get_contents($press_version_file));
}
}
elseif (is_dir($install_root . '/profiles/openatrium')) {
$ver['distribution'] = 'Open Atrium';
$version_file = $install_root . 'profiles/openatrium/VERSION.txt';
if (is_file($version_file)) {
$ver['oa']['version'] = trim(file_get_contents($version_file));
}
}
elseif (is_dir($install_root . '/profiles/commons')) {
$ver['distribution'] = 'Commons';
}
elseif (is_dir($install_root . '/profiles/cod')) {
$ver['distribution'] = 'COD';
}
return $ver;
}
/**
* Put SPI data in local storage.
*
* @param array $data
* Keyed array of data to store.
* @param int $expire
* Expire time or null to use default of 1 day.
*/
public function dataStoreSet(array $data, $expire = NULL) {
if (is_null($expire)) {
$expire = \Drupal::time()
->getRequestTime() + 60 * 60 * 24;
}
foreach ($data as $key => $value) {
\Drupal::cache()
->set('acquia.spi.' . $key, $value, $expire);
}
}
/**
* Get SPI data out of local storage.
*
* @param array $keys
* Array of keys to extract data for.
*
* @return array
* Stored data or false if no data is retrievable from storage.
*/
public function dataStoreGet(array $keys) {
$store = [];
foreach ($keys as $key) {
if ($cache = \Drupal::cache()
->get('acquia.spi.' . $key)) {
if (!empty($cache->data)) {
$store[$key] = $cache->data;
}
}
}
return $store;
}
/**
* Gather platform specific information.
*
* @return array
* An associative array keyed by a platform information type.
*/
public static function getPlatform() {
$server = \Drupal::request()->server;
// Database detection depends on the structure starting with the database.
$db_class = '\\Drupal\\Core\\Database\\Driver\\' . Database::getConnection()
->driver() . '\\Install\\Tasks';
$db_tasks = new $db_class();
// Webserver detection is based on name being before the slash, and
// version being after the slash.
preg_match('!^([^/]+)(/.+)?$!', $server
->get('SERVER_SOFTWARE'), $webserver);
if (isset($webserver[1]) && stristr($webserver[1], 'Apache') && function_exists('apache_get_version')) {
$webserver[2] = apache_get_version();
}
// Get some basic PHP vars.
$php_quantum = [
'memory_limit' => ini_get('memory_limit'),
'register_globals' => 'Off',
'post_max_size' => ini_get('post_max_size'),
'max_execution_time' => ini_get('max_execution_time'),
'upload_max_filesize' => ini_get('upload_max_filesize'),
'error_log' => ini_get('error_log'),
'error_reporting' => ini_get('error_reporting'),
'display_errors' => ini_get('display_errors'),
'log_errors' => ini_get('log_errors'),
'session.cookie_domain' => ini_get('session.cookie_domain'),
'session.cookie_lifetime' => ini_get('session.cookie_lifetime'),
'newrelic.appname' => ini_get('newrelic.appname'),
'sapi' => php_sapi_name(),
];
$platform = [
'php' => PHP_VERSION,
'webserver_type' => isset($webserver[1]) ? $webserver[1] : '',
'webserver_version' => isset($webserver[2]) ? $webserver[2] : '',
'php_extensions' => get_loaded_extensions(),
'php_quantum' => $php_quantum,
'database_type' => (string) $db_tasks
->name(),
'database_version' => Database::getConnection()
->version(),
'system_type' => php_uname('s'),
// php_uname() only accepts one character, so we need to concatenate
// ourselves.
'system_version' => php_uname('r') . ' ' . php_uname('v') . ' ' . php_uname('m') . ' ' . php_uname('n'),
];
return $platform;
}
/**
* Gather information about modules on the site.
*
* @return array
* An associative array keyed by filename of associative arrays with
* information on the modules.
*/
private function getModules() {
$modules = \Drupal::service('extension.list.module')
->reset()
->getList();
uasort($modules, 'system_sort_modules_by_info_name');
$result = [];
$keys_to_send = [
'name',
'version',
'package',
'core',
'project',
];
foreach ($modules as $module) {
$info = [];
$info['status'] = $module->status;
foreach ($keys_to_send as $key) {
$info[$key] = isset($module->info[$key]) ? $module->info[$key] : '';
}
$info['filename'] = $module
->getPathname();
if (empty($info['project']) && $module->origin == 'core') {
$info['project'] = 'drupal';
}
$result[] = $info;
}
return $result;
}
/**
* Gather information about nodes, users and comments.
*
* @return array
* An associative array.
*/
private function getQuantum() {
$quantum = [];
if ($this
->moduleHandler()
->moduleExists('node')) {
// Get only published nodes.
$quantum['nodes'] = Database::getConnection()
->select('node_field_data', 'n')
->fields('n', [
'nid',
])
->condition('n.status', NodeInterface::PUBLISHED)
->countQuery()
->execute()
->fetchField();
}
// Get only active users.
$quantum['users'] = Database::getConnection()
->select('users_field_data', 'u')
->fields('u', [
'uid',
])
->condition('u.status', 1)
->countQuery()
->execute()
->fetchField();
if ($this
->moduleHandler()
->moduleExists('comment')) {
// Get only active comments.
$quantum['comments'] = Database::getConnection()
->select('comment_field_data', 'c')
->fields('c', [
'cid',
])
->condition('c.status', 1)
->countQuery()
->execute()
->fetchField();
}
return $quantum;
}
/**
* Gather full SPI data and send to Acquia.
*
* @param string $method
* Optional identifier for the method initiating request.
* Values could be 'cron' or 'menu callback' or 'drush'.
*
* @return mixed
* FALSE if data is not sent or environment change detected,
* otherwise return NSPI response array.
*/
public function sendFullSpi($method = '') {
$spi = self::get($method);
if ($this
->checkEnvironmentChange()) {
$this
->getLogger('acquia spi')
->error('SPI data not sent, site environment change detected.');
$this
->messenger()
->addError($this
->t('SPI data not sent, site environment change detected. Please <a href="@environment_change">indicate how you wish to proceed</a>.', [
'@environment_change' => Url::fromRoute('acquia_connector.environment_change')
->toString(),
]));
return FALSE;
}
$storage = new Storage();
$response = $this->client
->sendNspi($storage
->getIdentifier(), $storage
->getKey(), $spi);
if ($response === FALSE) {
return FALSE;
}
$this
->handleServerResponse($response);
\Drupal::state()
->set('acquia_connector.cron_last', \Drupal::time()
->getRequestTime());
return $response;
}
/**
* Callback for sending SPI data.
*
* @param \Symfony\Component\HttpFoundation\Request $request
* Request.
*
* @return \Symfony\Component\HttpFoundation\RedirectResponse|\Symfony\Component\HttpFoundation\Response
* Redirect to the destination or return HTTP_BAD_REQUEST|HTTP_OK response.
*/
public function send(Request $request) {
// Mark this page as being uncacheable.
\Drupal::service('page_cache_kill_switch')
->trigger();
$method = ACQUIA_CONNECTOR_ACQUIA_SPI_METHOD_CALLBACK;
// Insight's set variable feature will pass method insight.
if ($request->query
->has('method') && $request->query
->get('method') === ACQUIA_CONNECTOR_ACQUIA_SPI_METHOD_INSIGHT) {
$method = ACQUIA_CONNECTOR_ACQUIA_SPI_METHOD_INSIGHT;
}
$response = $this
->sendFullSpi($method);
if ($request
->get('destination')) {
$this
->spiProcessMessages($response);
$route_match = RouteMatch::createFromRequest($request);
return $this
->redirect($route_match
->getRouteName(), $route_match
->getRawParameters()
->all());
}
$headers = [
'Expires' => 'Mon, 26 Jul 1997 05:00:00 GMT',
'Content-Type' => 'text/plain',
'Cache-Control' => 'no-cache',
'Pragma' => 'no-cache',
];
if (empty($response['body'])) {
return new Response('', Response::HTTP_BAD_REQUEST, $headers);
}
return new Response('', Response::HTTP_OK, $headers);
}
/**
* Parses and displays messages from the NSPI response.
*
* @param array|mixed $response
* Response array from NSPI.
*/
public function spiProcessMessages($response) {
if (empty($response['body'])) {
$this
->messenger()
->addError($this
->t('Error sending SPI data. Consult the logs for more information.'));
return;
}
$message_type = 'status';
if (isset($response['body']['spi_data_received']) && $response['body']['spi_data_received'] === TRUE) {
$this
->messenger()
->addStatus($this
->t('SPI data sent.'));
}
if (!empty($response['body']['nspi_messages'])) {
$this
->messenger()
->addStatus($this
->t('Acquia Subscription returned the following messages. Further information may be in the logs.'));
foreach ($response['body']['nspi_messages'] as $nspi_message) {
if (!empty($response['body']['spi_error'])) {
$message_type = $response['body']['spi_error'];
}
$this
->messenger()
->addMessage(Html::escape($nspi_message), (string) $message_type);
}
}
if (!empty($response['body']['spi_environment_changes'])) {
$this->configFactory
->getEditable('acquia_connector.settings')
->set('spi.environment_changes', Json::decode($response['body']['spi_environment_changes']))
->save();
}
}
/**
* Act on specific elements of SPI update server response.
*
* @param array $spi_response
* Array response from SpiController->send().
*/
private function handleServerResponse(array $spi_response) {
$config_set = $this->configFactory
->getEditable('acquia_connector.settings');
$changed_action = $this
->config('acquia_connector.settings')
->get('spi.environment_changed_action');
$config_set
->clear('spi.environment_changed_action')
->save();
$site_uuid = $this
->config('acquia_connector.settings')
->get('spi.site_uuid');
// Set site_uuid if it changed or if it hasn't been previously captured.
if (isset($spi_response['body']['site_uuid']) && (is_null($site_uuid) || $spi_response['body']['site_uuid'] != $site_uuid)) {
$config_set
->set('spi.site_uuid', $spi_response['body']['site_uuid'])
->save();
}
// Wipe the site_uuid if it is set locally, but NSPI is trying to create a
// new site.
if (isset($spi_response['body']['site_uuid']) && empty($spi_response['body']['site_uuid']) && !is_null($site_uuid)) {
$config_set
->clear('spi.site_uuid')
->save();
}
$spi_environment_changes = isset($spi_response['body']['spi_environment_changes']) ? Json::decode($spi_response['body']['spi_environment_changes']) : [];
$site_blocked = array_key_exists('blocked', $spi_environment_changes) || !empty($spi_response['site_revoked']);
// Address any actions taken based on a site environment change.
if (!empty($changed_action) || $site_blocked) {
if ($changed_action == 'create' && isset($spi_response['body']['site_uuid'])) {
$config_set
->set('spi.site_uuid', $spi_response['body']['site_uuid'])
->save();
}
elseif ($changed_action == 'block' && array_key_exists('spi_error', $spi_response['body']) && empty($spi_response['body']['spi_error']) || $site_blocked) {
$config_set
->set('spi.blocked', TRUE)
->save();
}
elseif ($changed_action == 'unblock' && array_key_exists('spi_error', $spi_response['body']) && empty($spi_response['body']['spi_error'])) {
$config_set
->set('spi.blocked', FALSE)
->save();
}
// If there were no errors, clear any pending actions.
if (empty($spi_response['body']['spi_error'])) {
$config_set
->clear('spi.environment_changes')
->save();
}
}
// Check result for command to update SPI definition.
$update = isset($spi_response['body']['update_spi_definition']) ? $spi_response['body']['update_spi_definition'] : FALSE;
if ($update === TRUE) {
$this
->updateDefinition();
}
// Check for set_variables command.
$set_variables = isset($spi_response['body']['set_variables']) ? $spi_response['body']['set_variables'] : FALSE;
if ($set_variables !== FALSE) {
$variablesController = new VariablesController();
$variablesController
->setVariables($set_variables);
}
// Log messages.
$messages = isset($spi_response['body']['nspi_messages']) ? $spi_response['body']['nspi_messages'] : FALSE;
if ($messages !== FALSE) {
$this
->getLogger('acquia spi')
->notice('SPI update server response messages: @messages', [
'@messages' => implode(', ', $messages),
]);
}
}
/**
* Checks if NSPI server has an updated SPI data definition.
*
* If it does, then this function updates local copy of SPI definition data.
*
* @return bool
* True if SPI definition data has been updated.
*/
private function updateDefinition() {
$core_version = substr(\Drupal::VERSION, 0, 1);
$spi_def_end_point = '/spi_def/get/' . $core_version;
$response = $this->client
->getDefinition($spi_def_end_point);
if (!$response) {
$this
->getLogger('acquia spi')
->error('Failed to obtain latest SPI data definition.');
return FALSE;
}
else {
$response_data = $response;
$expected_data_types = [
'drupal_version' => 'string',
'timestamp' => 'string',
'acquia_spi_variables' => 'array',
];
// Make sure that $response_data contains everything expected.
foreach ($expected_data_types as $key => $values) {
if (!array_key_exists($key, $response_data) || gettype($response_data[$key]) != $expected_data_types[$key]) {
$this
->getLogger('acquia spi')
->error('Received SPI data definition does not match expected pattern while checking "@key". Received and expected data: @data', [
'@key' => $key,
'@data' => var_export(array_merge([
'expected_data' => $expected_data_types,
], [
'response_data' => $response_data,
]), TRUE),
]);
return FALSE;
}
}
if ($response_data['drupal_version'] != $core_version) {
$this
->getLogger('acquia spi')
->notice('Received SPI data definition does not match with current version of your Drupal installation. Data received for Drupal @version', [
'@version' => $response_data['drupal_version'],
]);
return FALSE;
}
}
// NSPI response is in expected format.
if ((int) $response_data['timestamp'] > (int) $this
->state()
->get('acquia_spi_data.def_timestamp', 0)) {
// Compare stored variable names to incoming and report on update.
$old_vars = $this
->state()
->get('acquia_spi_data.def_vars', []);
$new_vars = $response_data['acquia_spi_variables'];
$new_optional_vars = 0;
foreach ($new_vars as $new_var_name => $new_var) {
// Count if received from NSPI optional variable is not present in old
// local SPI definition or if it already was in old SPI definition, but
// was not optional.
if ($new_var['optional'] && !array_key_exists($new_var_name, $old_vars) || $new_var['optional'] && isset($old_vars[$new_var_name]) && !$old_vars[$new_var_name]['optional']) {
$new_optional_vars++;
}
}
// Clean up waived vars that are not exposed by NSPI anymore.
$waived_spi_def_vars = $this
->state()
->get('acquia_spi_data.def_waived_vars', []);
$changed_bool = FALSE;
foreach ($waived_spi_def_vars as $key => $waived_var) {
if (!in_array($waived_var, $new_vars)) {
unset($waived_spi_def_vars[$key]);
$changed_bool = TRUE;
}
}
if ($changed_bool) {
$this
->state()
->set('acquia_spi_data.def_waived_vars', $waived_spi_def_vars);
}
// Finally, save SPI definition data.
if ($new_optional_vars > 0) {
$this
->state()
->set('acquia_spi_data.new_optional_data', 1);
}
$this
->state()
->set('acquia_spi_data.def_timestamp', (int) $response_data['timestamp']);
$this
->state()
->set('acquia_spi_data.def_vars', $response_data['acquia_spi_variables']);
return TRUE;
}
return FALSE;
}
/**
* Access callback check for SPI send independent call.
*/
public function sendAccess() {
$request = \Drupal::request();
$storage = new Storage();
$acquia_key = $storage
->getKey();
if (!empty($acquia_key) && $request
->get('key')) {
$key = sha1(\Drupal::service('private_key')
->get());
if ($key === $request
->get('key')) {
return AccessResultAllowed::allowed();
}
}
return AccessResultForbidden::forbidden();
}
}Members
Name |
Modifiers | Type | Description | Overrides |
|---|---|---|---|---|
|
ControllerBase:: |
protected | property | The configuration factory. | |
|
ControllerBase:: |
protected | property | The current user service. | 1 |
|
ControllerBase:: |
protected | property | The entity form builder. | |
|
ControllerBase:: |
protected | property | The entity type manager. | |
|
ControllerBase:: |
protected | property | The form builder. | 2 |
|
ControllerBase:: |
protected | property | The key-value storage. | 1 |
|
ControllerBase:: |
protected | property | The language manager. | 1 |
|
ControllerBase:: |
protected | property | The module handler. | 2 |
|
ControllerBase:: |
protected | property | The state service. | |
|
ControllerBase:: |
protected | function | Returns the requested cache bin. | |
|
ControllerBase:: |
protected | function | Retrieves a configuration object. | |
|
ControllerBase:: |
private | function | Returns the service container. | |
|
ControllerBase:: |
protected | function | Returns the current user. | 1 |
|
ControllerBase:: |
protected | function | Retrieves the entity form builder. | |
|
ControllerBase:: |
protected | function | Retrieves the entity type manager. | |
|
ControllerBase:: |
protected | function | Returns the form builder service. | 2 |
|
ControllerBase:: |
protected | function | Returns a key/value storage collection. | 1 |
|
ControllerBase:: |
protected | function | Returns the language manager service. | 1 |
|
ControllerBase:: |
protected | function | Returns the module handler. | 2 |
|
ControllerBase:: |
protected | function | Returns a redirect response object for the specified route. | |
|
ControllerBase:: |
protected | function | Returns the state storage service. | |
|
LoggerChannelTrait:: |
protected | property | The logger channel factory service. | |
|
LoggerChannelTrait:: |
protected | function | Gets the logger for a specific channel. | |
|
LoggerChannelTrait:: |
public | function | Injects the logger channel factory. | |
|
MessengerTrait:: |
protected | property | The messenger. | 27 |
|
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
|
MessengerTrait:: |
public | function | Sets the messenger. | |
|
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | 1 |
|
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
|
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
|
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
|
SpiController:: |
protected | property | The Acquia client. | |
|
SpiController:: |
protected | property | Path alias manager. | |
|
SpiController:: |
public | function | Attempt to determine if this site is hosted with Acquia. | |
|
SpiController:: |
public | function | Check if a site environment change has been detected. | |
|
SpiController:: |
private | function | Check to see if the unneeded release files with Drupal are removed. | |
|
SpiController:: |
private | function | Checks to see if SSL login is required. | |
|
SpiController:: |
public static | function |
Instantiates a new instance of this class. Overrides ControllerBase:: |
|
|
SpiController:: |
public | function | Get SPI data out of local storage. | |
|
SpiController:: |
public | function | Put SPI data in local storage. | |
|
SpiController:: |
public | function | Gather site profile information about this site. | |
|
SpiController:: |
private | function | Grabs the last 404 errors in logs. | |
|
SpiController:: |
public | function | Generate the machine name for acquia hosted sites. | |
|
SpiController:: |
public | function | Generate the name for acquia hosted sites. | |
|
SpiController:: |
private | function | The number of users who have admin-level user roles. | |
|
SpiController:: |
private | function | Get the information on failed logins in the last cron interval. | |
|
SpiController:: |
private | function | Get last 15 nodes created. | |
|
SpiController:: |
private | function | Get last 15 users created. | |
|
SpiController:: |
private | function | Gather information about modules on the site. | |
|
SpiController:: |
public static | function | Gather platform specific information. | |
|
SpiController:: |
private | function | Gather information about nodes, users and comments. | |
|
SpiController:: |
private | function | Determines if settings.php is read-only. | |
|
SpiController:: |
private | function | Determine if the super user has a weak name. | |
|
SpiController:: |
private | function | This function is a trimmed version of Drupal's system_status function. | |
|
SpiController:: |
private | function | Check the presence of UID 0 in the users table. | |
|
SpiController:: |
private | function | Attempt to determine the version of Drupal being used. | |
|
SpiController:: |
private | function | Get the latest (last hour) critical and emergency warnings from watchdog. | |
|
SpiController:: |
private | function | Get the number of rows in watchdog. | |
|
SpiController:: |
private | function | Act on specific elements of SPI update server response. | |
|
SpiController:: |
private | function | Calculate the sha1 hash for a path. | |
|
SpiController:: |
private | function | Determine if a path is a file type we care about for modifications. | |
|
SpiController:: |
public | function | Callback for sending SPI data. | |
|
SpiController:: |
public | function | Access callback check for SPI send independent call. | |
|
SpiController:: |
public | function | Gather full SPI data and send to Acquia. | |
|
SpiController:: |
public | function | Parses and displays messages from the NSPI response. | |
|
SpiController:: |
private | function | Collects all user-contributed test results that pass validation. | |
|
SpiController:: |
private | function | Checks if NSPI server has an updated SPI data definition. | |
|
SpiController:: |
public | function | Constructs a \Drupal\system\ConfigFormBase object. | |
|
StringTranslationTrait:: |
protected | property | The string translation service. | 4 |
|
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
|
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
|
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
|
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
|
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |