Merge pull request #2085 from ec-europa/EPIC-5944

composer.json

@@ -64,6 +64,7 @@
         "drupal/search_api_solr": "2.2",
         "drupal/simple_sitemap": "~3.6",
         "drupal/simplenews": "^1.0-beta1",
+        "drupal/site_alert": "~1.1",
         "drupal/smart_trim": "~1.2",
         "drupal/social_media_links": "^2.6",
         "drupal/spdx": "^1.0.0-alpha5",

config/sync/block.block.eiradeprecatedtermmessage.yml

@@ -10,7 +10,7 @@ dependencies:
 id: eiradeprecatedtermmessage
 theme: joinup_theme
 region: content_top
-weight: 0
+weight: -19
 provider: null
 plugin: eira_derprecated_term_block
 settings:

config/sync/block.block.joinup_theme_messages.yml

@@ -11,7 +11,7 @@ _core:
 id: joinup_theme_messages
 theme: joinup_theme
 region: content_top
-weight: -18
+weight: -20
 provider: null
 plugin: system_messages_block
 settings:

config/sync/block.block.licencedeprecatedmessage.yml

@@ -3,13 +3,14 @@ langcode: en
 status: true
 dependencies:
   module:
+    - joinup_core
     - joinup_licence
   theme:
     - joinup_theme
 id: licencedeprecatedmessage
 theme: joinup_theme
 region: content_top
-weight: 0
+weight: -18
 provider: null
 plugin: licence_deprecated_message_block
 settings:

config/sync/block.block.navigation.yml

@@ -5,8 +5,7 @@ dependencies:
   config:
     - og_menu.ogmenu.navigation
   module:
-    - collection
-    - solution
+    - joinup_group
     - og
   theme:
     - joinup_theme

config/sync/block.block.rdf_entities_in_proposed_state.yml

@@ -4,6 +4,7 @@ status: true
 dependencies:
   module:
     - joinup_core
+    - joinup_group
     - user
   theme:
     - joinup_theme

config/sync/block.block.site_alerts.yml

@@ -0,0 +1,21 @@
+uuid: 3204b36b-f978-4f1b-bd6d-b2d3fe0660c4
+langcode: en
+status: true
+dependencies:
+  module:
+    - site_alert
+  theme:
+    - joinup_theme
+id: site_alerts
+theme: joinup_theme
+region: content_top
+weight: -21
+provider: null
+plugin: site_alert_block
+settings:
+  id: site_alert_block
+  label: 'Site alerts'
+  provider: site_alert
+  label_display: '0'
+  timeout: 0
+visibility: {  }

config/sync/block.block.unpublished_content_of_group.yml

@@ -5,6 +5,7 @@ dependencies:
   module:
     - ctools
     - joinup_core
+    - joinup_group
   theme:
     - joinup_theme
 _core:

config/sync/core.extension.yml

@@ -147,6 +147,7 @@ module:
   serialization: 0
   simple_sitemap: 0
   simplenews: 0
+  site_alert: 0
   smart_trim: 0
   social_media_links: 0
   social_media_links_field: 0

config/sync/field.field.message.collection_content_subscription.field_collection_content.yml

@@ -239,4 +239,7 @@ settings:
   base_field_override:
     handler: 'default:base_field_override'
     handler_settings: {  }
+  site_alert:
+    handler: 'default:site_alert'
+    handler_settings: {  }
 field_type: dynamic_entity_reference

config/sync/user.role.moderator.yml

@@ -17,6 +17,7 @@ permissions:
   - 'access release create field'
   - 'access toolbar'
   - 'access uri converter'
+  - 'add site alerts'
   - 'administer collection ownership'
   - 'administer comments'
   - 'administer entity legal'
@@ -26,6 +27,7 @@ permissions:
   - 'administer nodes'
   - 'administer search fields'
   - 'administer shared entities'
+  - 'administer site alert'
   - 'administer solution ownership'
   - 'administer support menu items'
   - 'administer tallinn settings'
@@ -41,6 +43,7 @@ permissions:
   - 'delete contact_information rdf entity'
   - 'delete licence rdf entity'
   - 'delete owner rdf entity'
+  - 'delete site alerts'
   - 'edit any custom_page content'
   - 'edit any discussion content'
   - 'edit contact_information rdf entity'
@@ -64,6 +67,7 @@ permissions:
   - 'unfeature entity'
   - 'unpin entity'
   - 'update any simple_block block content'
+  - 'update site alerts'
   - 'view any unpublished content'
   - 'view licence overview page'
   - 'view rdf entity overview'

tests/features/moderator/site_alerts.feature

@@ -0,0 +1,57 @@
+@api @group-b
+Feature: Site alerts
+  In order to announce scheduled downtime
+  As a moderator
+  I want to be able to display a site wide alert
+
+  Scenario: Show a site wide alert and hide it again
+    # Create a site wide alert as a moderator.
+    Given I am logged in as a moderator
+    When I click "Site alerts" in the "Administration toolbar" region
+    Then I should see the text "There are no site alerts yet."
+
+    When I click "Add Site Alert"
+    And I fill in "Label" with "Site maintenance 18:00-20:00"
+    And I select "Medium" from "Severity"
+    And I enter "Between 18:00 and 20:00 the site will be temporarily unavailable due to scheduled maintenance" in the "Message" wysiwyg editor
+    And I press "Save"
+
+    # Anonymous users should see the alert.
+    Given I am not logged in
+    And I am on the homepage
+    Then I should see the text "Between 18:00 and 20:00 the site will be temporarily unavailable due to scheduled maintenance"
+
+    # Deactivate the alert without deleting it, so it can be used again later.
+    Given I am logged in as a moderator
+    When I click "Site alerts" in the "Administration toolbar" region
+    And I click "Edit"
+    And I uncheck "Active"
+    And I press "Save"
+    Then I should see the text "Not Active"
+
+    # The alert should no longer be shown.
+    Given I am not logged in
+    And I am on the homepage
+    Then I should not see the text "Between 18:00 and 20:00 the site will be temporarily unavailable due to scheduled maintenance"
+
+    # Re-enable the alert, it should appear again.
+    Given I am logged in as a moderator
+    When I click "Site alerts" in the "Administration toolbar" region
+    And I click "Edit"
+    And I check "Active"
+    And I press "Save"
+
+    Given I am not logged in
+    And I am on the homepage
+    Then I should see the text "Between 18:00 and 20:00 the site will be temporarily unavailable due to scheduled maintenance"
+
+    # An alert can also be removed entirely, if it does not need to be reused.
+    Given I am logged in as a moderator
+    When I click "Site alerts" in the "Administration toolbar" region
+    And I click "Delete"
+    And I press "Delete"
+    Then I should see the message " The Site Alert Site maintenance 18:00-20:00 has been deleted."
+
+    Given I am not logged in
+    And I am on the homepage
+    Then I should not see the text "Between 18:00 and 20:00 the site will be temporarily unavailable due to scheduled maintenance"

web/modules/custom/joinup_core/joinup_core.info.yml

@@ -24,6 +24,7 @@ dependencies:
   - 'redirect:redirect'
   - 'search_api:search_api'
   - 'search_api_solr:search_api_solr'
+  - 'site_alert:site_alert'
   - 'state_machine:state_machine'
 
 config_devel:

web/modules/custom/joinup_core/joinup_core.links.menu.yml

@@ -18,10 +18,17 @@ joinup_core.edit_support_menu:
   route_name: entity.menu.edit_form
   route_parameters:
     menu: support
-  description: 'Allows to manage of the user support menu.'
+  description: 'Allows to manage the user support menu.'
   parent: system.admin
   weight: 0
 
+joinup_core.site_alerts:
+  title: 'Site alerts'
+  route_name: entity.site_alert.collection
+  description: 'Manage site wide alerts.'
+  parent: system.admin
+  weight: 3
+
 joinup_core.support.tour:
   title: 'Take a tour'
   menu_name: support

web/modules/custom/joinup_core/joinup_core.module

@@ -18,6 +18,7 @@ use Drupal\Core\Link;
 use Drupal\Core\StreamWrapper\StreamWrapperManager;
 use Drupal\Core\Template\Attribute;
 use Drupal\joinup_core\Element\Datetime;
+use Drupal\joinup_core\JoinupSiteAlertListBuilder;
 use Drupal\node\NodeInterface;
 use Drupal\search_api\IndexInterface;
 use Drupal\search_api\Utility\Utility;
@@ -127,6 +128,18 @@ function joinup_core_form_rdf_entity_form_alter(&$form, FormStateInterface $form
   }
 }
 
+/**
+ * Implements hook_form_BASE_FORM_ID_alter().
+ *
+ * Alters the Site Alert entity form to hide the scheduling of the alerts. Due
+ * to a bug in the core page cache module the scheduling can only work using an
+ * additional AJAX call which is undesirable in our case. By disabling the
+ * scheduling the alerts are managed manually and the page cache works normally.
+ */
+function joinup_core_form_site_alert_form_alter(&$form, FormStateInterface $form_state, $form_id) {
+  $form['scheduling']['#access'] = FALSE;
+}
+
 /**
  * Implements hook_entity_base_field_info().
  *
@@ -174,6 +187,14 @@ function joinup_core_entity_base_field_info(EntityTypeInterface $entity_type) {
  * Implements hook_entity_type_alter().
  */
 function joinup_core_entity_type_alter(array &$entity_types) {
+  // Check that the Site Alert entity type is defined, so we can avoid depending
+  // on the Site Alert module.
+  if (isset($entity_types['site_alert'])) {
+    // Override the list builder with a version which omits the unused 'Start
+    // time' and 'End time' columns.
+    $entity_types['site_alert']->setListBuilderClass(JoinupSiteAlertListBuilder::class);
+  }
+
   if (!isset($entity_types['rdf_entity'])) {
     return;
   }