SHS-5904: Add new "log out" block to existing sites

config/default/block.block.humsci_colorful_samlsunetidlogoutblock.yml

@@ -0,0 +1,21 @@
+uuid: 7e424b1f-3692-41a3-a48a-dd1a450e0203
+langcode: en
+status: true
+dependencies:
+  module:
+    - stanford_samlauth
+  theme:
+    - humsci_colorful
+id: humsci_colorful_samlsunetidlogoutblock
+theme: humsci_colorful
+region: footer
+weight: 0
+provider: null
+plugin: stanford_samlauth_logout_block
+settings:
+  id: stanford_samlauth_logout_block
+  label: 'SAML SUNetID Logout Block'
+  label_display: '0'
+  provider: stanford_samlauth
+  link_text: 'SUNetID Logout'
+visibility: {  }

config/default/block.block.humsci_traditional_samlsunetidlogoutblock.yml

@@ -0,0 +1,21 @@
+uuid: 2f7f0d52-c463-411d-a2e2-656d185acd4d
+langcode: en
+status: true
+dependencies:
+  module:
+    - stanford_samlauth
+  theme:
+    - humsci_traditional
+id: humsci_traditional_samlsunetidlogoutblock
+theme: humsci_traditional
+region: footer
+weight: 0
+provider: null
+plugin: stanford_samlauth_logout_block
+settings:
+  id: stanford_samlauth_logout_block
+  label: 'SAML SUNetID Logout Block'
+  label_display: '0'
+  provider: stanford_samlauth
+  link_text: 'SUNetID Logout'
+visibility: {  }

docroot/profiles/humsci/su_humsci_profile/su_humsci_profile.install

@@ -5,10 +5,12 @@
  * su_humsci_profile.install
  */
 
+use Drupal\Core\Config\FileStorage;
 use Drupal\Core\DrupalKernel;
 use Drupal\Core\Entity\Entity\EntityFormDisplay;
 use Drupal\Core\Entity\Entity\EntityViewDisplay;
 use Drupal\Core\Menu\MenuTreeParameters;
+use Drupal\Core\Site\Settings;
 use Drupal\field\Entity\FieldConfig;
 use Drupal\field\Entity\FieldStorageConfig;
 use Drupal\hs_entities\Entity\HsEntityType;
@@ -1096,3 +1098,55 @@ function su_humsci_profile_update_9718() {
   // Uninstalls modules after removing configs to prevent updb errors.
   \Drupal::service('module_installer')->uninstall(['hs_webform', 'webform_ui', 'webform']);
 }
+
+/**
+ * Add new logout block to existing sites.
+ */
+function su_humsci_profile_update_9719() {
+  $config_storage = new FileStorage(Settings::get('config_sync_directory'));
+  $entity_type_manager = \Drupal::service('entity_type.manager');
+
+  $config_names = [
+    'block.block.humsci_colorful_samlsunetidlogoutblock',
+    'block.block.humsci_traditional_samlsunetidlogoutblock',
+  ];
+
+  foreach ($config_names as $config_name) {
+
+    // Load the configuration data from the sync directory.
+    $config_data = $config_storage->read($config_name);
+
+    if (!$config_data) {
+      throw new \Exception(t('The configuration %config_name was not found in the sync directory.', ['%config_name' => $config_name]));
+    }
+
+    // Get the block storage and possible existing config.
+    $block_storage = $entity_type_manager->getStorage('block');
+    $existing_config = $block_storage->load($config_data['id']);
+
+    if (!$existing_config) {
+      // Change the logout link text to match what the existing login text is.
+      $login_blocks = $entity_type_manager->getStorage('block')->loadByProperties([
+        'plugin' => 'stanford_samlauth_login_block',
+      ]);
+
+      if ($login_blocks) {
+        foreach ($login_blocks as $login_block) {
+          /** @var Drupal\block\Entity\BlockDrupal\block\Entity\Block $login_block */
+          $settings = $login_block->get('settings');
+
+          $log_in = $settings['link_text'];
+          $log_out = preg_replace('/in\b/', 'out', $log_in);
+          $log_out = preg_replace('/In\b/', 'Out', $log_out);
+          $log_out = str_replace(' to ', ' from ', $log_out);
+          $log_out = str_replace(' To ', ' From ', $log_out);
+        }
+      }
+
+      $config_data['settings']['link_text'] = $log_out;
+      $block_storage->create($config_data)->save();
+
+      \Drupal::logger('su_humsci_profile')->info('Block configuration %config_name has been imported.', ['%config_name' => $config_name]);
+    }
+  }
+}

docroot/profiles/humsci/su_humsci_profile/su_humsci_profile.profile

@@ -875,11 +875,22 @@ function su_humsci_profile_form_user_register_form_alter(&$form, FormStateInterf
 /**
  * Implements hook_preprocess_HOOK().
  */
-function su_humsci_profile_preprocess_block__stanford_samlauth(&$variables) {
-  $variables['content']['login']['#attributes']['class'] = [
+function su_humsci_profile_preprocess_block(&$variables) {
+  $classes = [
     'text-align-right',
     'hs-secondary-button',
   ];
+
+  $base_plugin_id = $variables['base_plugin_id'];
+
+  switch ($base_plugin_id) {
+    case 'stanford_samlauth_login_block':
+      $variables['content']['login']['#attributes']['class'] = $classes;
+      break;
+
+    case 'stanford_samlauth_logout_block':
+      $variables['content']['logout']['#attributes']['class'] = $classes;
+  }
 }
 
 /**