Merge pull request #14 from cmu-sei/separte-comm-apps

Restructuring comm apps logic and readme

Author: sei-npacheco

README.md

@@ -141,30 +141,10 @@ In this section, you can configure each application individually by setting URLs
 #### Application Settings Overview
 Each application has a dedicated settings section. Expand each section to get an overview of each configurable application and its specific settings:
 
-<details>
-<summary><strong>Keycloak:</strong> Open Source Identity and Access Management</summary>
-
-If enabled, the Keycloak block will be added to the Applications block. If the user has admin privileges or is part of a group that has admin privileges, the URL provided to the user will contain the `/admin/master/console` path. For regular users, the URL provided to the user will contain the `/realms/master/account` path.
-
-![Keycloak Settings](img/keycloak-settings.png)
-
-- **Show Keycloak:** Show Keycloak application regardless of user permissions.
-- **User Account Redirect:** When enabled, redirects all users to the same page used for user account management.
-- **Keycloak User URL:** Specifies the Keycloak URL to which regular users are redirected. Ensure the URL includes the realm component without trailing /.
-- **Keycloak Admin URL:** Specifies the Keycloak URL tto which admins are redirected. Ensure the URL includes the realm component without trailing /.
-- **Admin Keycloak Groups:** Specify groups relevant to Keycloak for role-based permissions.
-
-**Additional Configuration Requirements:**
-- **Moodle Client Configuration in Keycloak:** The Keycloak integration will only function correctly if the Moodle client in Keycloak has the `Service Account` configuration enabled. This setup allows the Applications block to authenticate as a service account and access Keycloak's APIs for roles and groups.
-- **View Roles in Keycloak:** To enable proper role-based permissions, the Keycloak client must also be configured to include `view roles` in the `Service Account Roles` section. This ensures that user roles are correctly fetched and applied for filtering and permissions management.
-
-These configurations are essential to ensure seamless communication between Moodle and Keycloak for user authentication and role-based permissions.
-</details>
-
 <details>
 <summary><strong>Alloy: </strong>Conducting a Simulation</summary>
 
-If the required URLs are added, the Alloy block will be added to the Applications block. However, this block will only show if the user has admin privileges in the Player application or if the user has any active views in the Player application. As a requirement, for this block to be enabled, the Player block should also be configured.
+If the required URLs are added, the Alloy block will be added to the Applications block. However, this block will only show if the user has admin privileges in the Player application or if the user has any active views in the Player application. As a requirement, for this block to be enabled, the Player block should also be configured or the `Show Alloy` is checked.
 
 ![Alloy Settings](img/alloy-settings.png)
 
@@ -176,7 +156,7 @@ If the required URLs are added, the Alloy block will be added to the Application
 <details>
 <summary><strong>Blueprint: </strong>Building a MSEL</summary>
 
-If the required URLs are added, the Blueprint block will be added to the Applications block. However, this block will only show if the user has admin privileges in the Blueprint application or if the user has any MSELs and the `Show All Applications` is checked.
+If the required URLs are added, the Blueprint block will be added to the Applications block. However, this block will only show if the user has admin privileges in the Blueprint application or if the user has any MSELs and the `Show All Applications` is checked or the `Show Blueprint` is checked.
 
 ![Blueprint Settings](img/blueprint-settings.png)
 
@@ -188,7 +168,7 @@ If the required URLs are added, the Blueprint block will be added to the Applica
 <details>
 <summary><strong>Caster: </strong>Coding a Topology</summary>
 
-If the required URLs are added, the Caster block will be added to the Applications block. However, this block will only show if the user has admin privileges in the Caster application.
+If the required URLs are added, the Caster block will be added to the Applications block. However, this block will only show if the user has admin privileges in the Caster application or the `Show Caster` is checked.
 
 ![Caster Settings](img/caster-settings.png)
 
@@ -200,7 +180,7 @@ If the required URLs are added, the Caster block will be added to the Applicatio
 <details>
 <summary><strong>CITE: </strong>Evaluating Threats</summary>
 
-If the required URLs are added, the CITE block will be added to the Applications block. However, this block will only show if the user has admin privileges in the CITE application or if the user has an active evaluation and the `Show All Applications` is checked.
+If the required URLs are added, the CITE block will be added to the Applications block. However, this block will only show if the user has admin privileges in the CITE application or if the user has an active evaluation and the `Show All Applications` is checked or the `Show CITE` is checked.
 
 ![CITE Settings](img/cite-settings.png)
 
@@ -222,7 +202,7 @@ If the required URL is added, the Docs block will be added to the Applications b
 <details>
 <summary><strong>Gallery: </strong>Keeping You in the Know!</summary>
 
-If the required URLs are added, the Gallery block will be added to the Applications block. However, this block will only show if the user has admin privileges in the Gallery application or if the user has an active exhibit and the `Show All Applications` is checked.
+If the required URLs are added, the Gallery block will be added to the Applications block. However, this block will only show if the user has admin privileges in the Gallery application or if the user has an active exhibit and the `Show All Applications` is checked or the `Show Gallery` is checked.
 
 ![Gallery Settings](img/gallery-settings.png)
 
@@ -234,7 +214,7 @@ If the required URLs are added, the Gallery block will be added to the Applicati
 <details>
 <summary><strong>Gameboard: </strong>Virtual Lab Training and Competition Platform</summary>
 
-If the required URLs are added, the Gameboard block will be added to the Applications block. However, this block will only show if the user has admin privileges in the Gameboard application or if the user has an active gamespace and the `Show All Applications` is checked or the `Enable Gameboard` is checked.
+If the required URLs are added, the Gameboard block will be added to the Applications block. However, this block will only show if the user has admin privileges in the Gameboard application or if the user has an active gamespace and the `Show All Applications` is checked or the `Show Gameboard` is checked.
 
 ![Gameboard Settings](img/gameboard-settings-v1.png)
 
@@ -244,10 +224,30 @@ If the required URLs are added, the Gameboard block will be added to the Applica
 - **Gameboard API Key:** Provide the API key needed to connect with Gameboard.
 </details>
 
+<details>
+<summary><strong>Keycloak:</strong> Open Source Identity and Access Management</summary>
+
+If enabled, the Keycloak block will be added to the Applications block. If the user has admin privileges or is part of a group that has admin privileges, the URL provided to the user will contain the `/admin/master/console` path. For regular users, the URL provided to the user will contain the `/realms/master/account` path.
+
+![Keycloak Settings](img/keycloak-settings.png)
+
+- **Show Keycloak:** Show Keycloak application regardless of user permissions.
+- **User Account Redirect:** When enabled, redirects all users to the same page used for user account management.
+- **Keycloak User URL:** Specifies the Keycloak URL to which regular users are redirected. Ensure the URL includes the realm component without trailing /.
+- **Keycloak Admin URL:** Specifies the Keycloak URL tto which admins are redirected. Ensure the URL includes the realm component without trailing /.
+- **Admin Keycloak Groups:** Specify groups relevant to Keycloak for role-based permissions.
+
+**Additional Configuration Requirements:**
+- **Moodle Client Configuration in Keycloak:** The Keycloak integration will only function correctly if the Moodle client in Keycloak has the `Service Account` configuration enabled. This setup allows the Applications block to authenticate as a service account and access Keycloak's APIs for roles and groups.
+- **View Roles in Keycloak:** To enable proper role-based permissions, the Keycloak client must also be configured to include `view roles` in the `Service Account Roles` section. This ensures that user roles are correctly fetched and applied for filtering and permissions management.
+
+These configurations are essential to ensure seamless communication between Moodle and Keycloak for user authentication and role-based permissions.
+</details>
+
 <details>
 <summary><strong>MISP: </strong>Threat Intelligence and Sharing Platform</summary>
 
-If the required URLs are added, the MISP block will be added to the Applications block. However, this block will only show if the user has admin privileges in the MISP application or if the user has an account and the `Show All Applications` is checked or the `Enable MISP` is checked.
+If the required URLs are added, the MISP block will be added to the Applications block. However, this block will only show if the user has admin privileges in the MISP application or if the user has an account and the `Show All Applications` is checked or the `Show MISP` is checked.
 
 ![MISP Settings](img/misp-settings-v1.png)
 
@@ -259,7 +259,7 @@ If the required URLs are added, the MISP block will be added to the Applications
 <details>
 <summary><strong>Player: </strong>Designing User Interfaces</summary>
 
-If the required URLs are added, the Player block will be added to the Applications block. However, this block will only show if the user has admin privileges in the Player application or if the user has an active Player view.
+If the required URLs are added, the Player block will be added to the Applications block. However, this block will only show if the user has admin privileges in the Player application or if the user has an active Player view or the `Show Player` is checked.
 
 ![Player Settings](img/player-settings.png)
 
@@ -269,53 +269,51 @@ If the required URLs are added, the Player block will be added to the Applicatio
 </details>
 
 <details>
-<summary><strong>Steamfitter: </strong>Crafting a Scenario</summary>
+<summary><strong>Rocket.Chat</strong></summary>
 
-If the required URLs are added, the Steamfitter block will be added to the Applications block. However, this block will only show if the user has admin privileges in the Steamfitter application.
+If the required URLs are added, the Rocket.chat block will be added to the Applications block. However, this block will only show if the user has admin privileges in the Rocket.Chat application, the user has an account or the `Show Rocket.Chat` is checked.
 
-![Steamfitter Settings](img/steamfitter-settings.png)
+![Rocketchat Settings](img/rocketchat-settings.png)
 
-- **Show Steamfitter:** Show Steamfitter application regardless of user permissions.
-- **Steamfitter API:** Enter the API URL for Steamfitter.
-- **Steamfitter UI:** Enter the main URL for Steamfitter.
+- **Show Rocket.Chat:** Show Rocket.Chat application regardless of user permissions.
+- **Rocket.Chat API:** Enter the API URL for Rocket.chat.
+- **Rocket.Chat UI:** Enter the main URL for Rocket.Chat.
+- **Rocket.Chat Auth Token:** Enter the authentication token required for integration.
+- **Rocket.Chat User ID:** Specify the user ID tied to the authentication token for Rocket.Chat.
 </details>
 
 <details>
-<summary><strong>TopoMojo: </strong>Virtual Lab Builder</summary>
+<summary><strong>Roundcube</strong></summary>
 
-If the required URLs are added, the TopoMojo block will be added to the Applications block. However, this block will only show if the user has admin privileges in the Topomojo application or the `Enable TopoMojo` is checked.
+For Roundcube, if the required URL is added and the `Show Roundcube` is checked, the Roundcube block will be added to the Applications block.
 
-![TopoMojo Settings](img/topomojo-settings.png)
+![Roundcube Settings](img/roundcube-settings.png)
 
-- **Show TopoMojo:** Show TopoMojo application regardless of user permissions.
-- **TopoMojo API:** Enter the API URL for Steamfitter.
-- **TopoMojo UI:** Enter the main URL for Steamfitter.
-- **TopoMojo API Key:** Enter the API key required for integration.
+- **Roundcube UI:** Enter the URL for the Roundcube application.
 </details>
 
 <details>
-<summary><strong>Communication Apps</strong></summary>
+<summary><strong>Steamfitter: </strong>Crafting a Scenario</summary>
 
-![Communication Settings](img/communication-settings.png)
+If the required URLs are added, the Steamfitter block will be added to the Applications block. However, this block will only show if the user has admin privileges in the Steamfitter application or the `Show Steamfitter` is checked.
+![Steamfitter Settings](img/steamfitter-settings.png)
 
-- **Enable Communication Apps:** Toggle visibility of all communication-related applications.
+- **Show Steamfitter:** Show Steamfitter application regardless of user permissions.
+- **Steamfitter API:** Enter the API URL for Steamfitter.
+- **Steamfitter UI:** Enter the main URL for Steamfitter.
 </details>
 
 <details>
-<summary><strong>Rocket.Chat & Roundcube</strong></summary>
-
-If the required URLs are added and the `Enable Communication Apps` is checked, the Rocket.Chat block will be added to the Applications block. However, this block will only show if the user has admin privileges in the Rocket.Chat application or the user has an account.
-
-![Roundcube Rocketchat Settings](img/roundcube-rocketchat-settings.png)
+<summary><strong>TopoMojo: </strong>Virtual Lab Builder</summary>
 
-- **Rocket.Chat API:** Enter the API URL for Rocket.chat.
-- **Rocket.Chat UI:** Enter the main URL for Rocket.Chat.
-- **Rocket.Chat Auth Token:** Enter the authentication token required for integration.
-- **Rocket.Chat User ID:** Specify the user ID tied to the authentication token for Rocket.Chat.
+If the required URLs are added, the TopoMojo block will be added to the Applications block. However, this block will only show if the user has admin privileges in the Topomojo application or the `Show TopoMojo` is checked.
 
-For Roundcube, if the required URL is added and the `Enable Communications Apps` is checked, the Roundcube block will be added to the Applications block. However, the block will only show if the user has admin privileges in the Blueprint application.
+![TopoMojo Settings](img/topomojo-settings.png)
 
-- **Roundcube UI:** Enter the URL for the Roundcube application.
+- **Show TopoMojo:** Show TopoMojo application regardless of user permissions.
+- **TopoMojo API:** Enter the API URL for Steamfitter.
+- **TopoMojo UI:** Enter the main URL for Steamfitter.
+- **TopoMojo API Key:** Enter the API key required for integration.
 </details>
 
 ## 3. Usage Guide

block_crucible.php

@@ -199,14 +199,6 @@ public function get_content() {
             $data->blueprint = $blueprinturl;
             $data->blueprintDescription = get_string('blueprintdescription', 'block_crucible');
             $data->blueprintLogo = $OUTPUT->image_url('crucible-icon-blueprint', 'block_crucible');
-
-            if ($permsblueprint && $showcomms) {
-                $data->roundcube = get_config('block_crucible', 'roundcubeappurl');
-                $data->roundcubeDescription = get_string('roundcubedescription', 'block_crucible');
-                $data->roundcubeLogo = $OUTPUT->image_url('icon-roundcube', 'block_crucible');
-            } else {
-                debugging("Roundcube not enabled", DEBUG_DEVELOPER);
-            }
         } else if ($permsblueprint == 0 && $permsblueprint != null) {
             debugging("No user data found on Blueprint for User: " . $userid, DEBUG_DEVELOPER);
         } else if ($msels == 0 && $msels != null) {
@@ -304,31 +296,47 @@ public function get_content() {
         }
 
         ////////////////////RocketChat/////////////////////////////
-        if ($showcomms) {
-            $rocketchaturl = get_config('block_crucible', 'rocketchatappurl');
-            $rocketchat = null;
 
-            if ($rocketchaturl) {
-                $rocketchat = $crucible->get_rocketchat_user_info();
-            }
+        $rocketchaturl = get_config('block_crucible', 'rocketchatappurl');
+        $rocketchat = null;
+        $showrocketchat = null;
 
-            if ($rocketchat) {
-                $rocketperms = $rocketchat->user->roles;
-
-                if ($showapps) {
-                    $data->rocket = $rocketchaturl;
-                    $data->rocketDescription = get_string('rocketchatdescription', 'block_crucible');
-                    $data->rocketLogo = $OUTPUT->image_url('icon-rocketchat', 'block_crucible');
-                } else if (in_array("admin", $rocketperms)) {
-                    $data->rocket = $rocketchaturl;
-                    $data->rocketDescription = get_string('rocketchatdescription', 'block_crucible');
-                    $data->rocketLogo = $OUTPUT->image_url('icon-rocketchat', 'block_crucible');
-                }
-            } else if ($rocketchat == -1) {
-                debugging("Rocket.Chat is not configured", DEBUG_DEVELOPER);
+        if ($rocketchaturl) {
+            $rocketchat = $crucible->get_rocketchat_user_info();
+            $showrocketchat = get_config('block_crucible', 'showrocketchat');
+        }
+
+        if ($rocketchat) {
+            $rocketperms = $rocketchat->user->roles;
+        
+            if ($showapps || in_array("admin", $rocketperms)) {
+                $data->rocket = $rocketchaturl;
+                $data->rocketDescription = get_string('rocketchatdescription', 'block_crucible');
+                $data->rocketLogo = $OUTPUT->image_url('icon-rocketchat', 'block_crucible');
             }
-        } else if ($showcomms == 0) {
-            debugging("Rocket.Chat not enabled", DEBUG_DEVELOPER);
+        } else if ($showrocketchat) {
+            $data->rocket = $rocketchaturl;
+            $data->rocketDescription = get_string('rocketchatdescription', 'block_crucible');
+            $data->rocketLogo = $OUTPUT->image_url('icon-rocketchat', 'block_crucible');
+        } else if ($rocketchat === -1) {
+            debugging("Rocket.Chat is not configured", DEBUG_DEVELOPER);
+        }
+        
+
+         ////////////////////Roundcube/////////////////////////////
+        $roundcubeurl = get_config('block_crucible', 'roundcubeappurl');
+        $showroundcube = null;
+
+        if ($roundcubeurl) {
+            $showroundcube = get_config('block_crucible', 'showroundcube');
+        }
+ 
+        if ($showroundcube) {
+            $data->roundcube = get_config('block_crucible', 'roundcubeappurl');
+            $data->roundcubeDescription = get_string('roundcubedescription', 'block_crucible');
+            $data->roundcubeLogo = $OUTPUT->image_url('icon-roundcube', 'block_crucible');
+        } else {
+            debugging("Roundcube not enabled", DEBUG_DEVELOPER);
         }
 
         ////////////////////TOPOMOJO////////////////////////////