Provide application user roles persistently for use in the views, and…

… improve configuration wayfinding for platform administrators. (CFM-310) (#113) * Provide application user roles persistently for use in the views, and improve configuration wayfinding for platform administrators. (CFM-310) * Add controller to persistent view variables, and add platform config notice to config menu panel. (CFM-310) * Improvements to the messaging and code style for platform admin wayfinding improvements (CFM-296) * Update to COmanage CO identifying statement banner text (CFM-310)
COmanage · Oct 18, 2023 · 1f02168 · 1f02168
1 parent 67f9fed
commit 1f02168
Show file tree

Hide file tree

Showing 10 changed files with 174 additions and 11 deletions.
diff --git a/app/resources/locales/en_US/information.po b/app/resources/locales/en_US/information.po
@@ -36,6 +36,12 @@ msgstr "You are not an active member in any collaboration. If your request for e
 msgid "cos.select"
 msgstr "Please select the collaboration (CO) you wish to manage."
 
+msgid "cmp.config.notice"
+msgstr "<a href="{0}">Platform-wide configurations</a> are available in the <a href="{1}">COmanage CO</a>."
+
+msgid "cmp.co.notice"
+msgstr "This is the COmanage CO, which is used for platform wide <a href="{0}">configurations</a>."
+
 msgid "entity.id"
 msgstr "ID: {0}"
 

diff --git a/app/resources/locales/en_US/menu.po b/app/resources/locales/en_US/menu.po
@@ -42,6 +42,9 @@ msgstr "Attributes"
 msgid "co.configuration"
 msgstr "Configuration"
 
+msgid "co.configuration.desc"
+msgstr "Configuration for the current CO"
+
 msgid "co.configuration.short"
 msgstr "Config"
 
@@ -58,16 +61,13 @@ msgid "co.configuration.panel.personalization.desc"
 msgstr "Dashboards, custom text, and theming"
 
 msgid "co.configuration.panel.platform"
-msgstr "Platform-Wide Settings"
+msgstr "Platform-Wide Configuration"
 
 msgid "co.configuration.panel.platform.desc"
 msgstr "These configurations are found only in the COmanage CO"
 
-msgid "co.configuration.panel.setup"
-msgstr "CO Setup"
-
-msgid "co.configuration.panel.setup.desc"
-msgstr "Settings for the current CO"
+msgid "co.configuration.title"
+msgstr "CO Configuration"
 
 msgid "co.connections"
 msgstr "Connections"

diff --git a/app/src/Controller/AppController.php b/app/src/Controller/AppController.php
@@ -140,12 +140,16 @@ public function beforeRender(\Cake\Event\EventInterface $event) {
     $modelsName = $this->name;
 
     // Views can also inspect the request object to determine the current
-    // action, but it seems slightly easier to do it once here.
+    // controller and action, but it seems slightly easier to do it once here.
+    $this->set('vv_controller', $this->request->getParam('controller'));
     $this->set('vv_action', $this->request->getParam('action'));
 
     if(isset($this->RegistryAuth)) {
       // Components might not be loaded on error, so check
       $this->set('vv_menu_permissions', $this->RegistryAuth->getMenuPermissions($this->getCOID()));
+
+      // Provide the user's application roles to the views.
+      $this->set('vv_user_roles', $this->RegistryAuth->getApplicationUserRoles($this->getCOID()));
     }
 
     return parent::beforeRender($event);

diff --git a/app/src/Controller/Component/RegistryAuthComponent.php b/app/src/Controller/Component/RegistryAuthComponent.php
@@ -422,6 +422,32 @@ public function calculatePermissionsForView(string $action, ?int $id=null): arra
     return $this->calculatePermissions($id);
   }
 
+  /**
+   * Obtain the application role of the user for general use in the views
+   *
+   * @since  COmanage Registry v5.0.0
+   * @param  int   $coId  Current CO ID, if known
+   * @return array $appRoles Array of roles
+   */
+
+  public function getApplicationUserRoles(?int $coId): array {
+    $appUserRoles = [];
+
+    // True for platform administrator
+    $appUserRoles['platform'] = $this->isPlatformAdmin();
+
+    // True for administrator of the current CO
+    $appUserRoles['co'] = $this->isCoAdmin($coId);
+
+    // TODO: add other application roles such as 'cou' and 'support'
+    // See: https://spaces.at.internet2.edu/display/COmanage/Registry+PE+Permissions  
+
+    // True if user is authenticated
+    $appUserRoles['authuser'] = $this->isAuthenticatedUser();
+
+    return $appUserRoles;
+  }
+
   /**
    * Obtain the identifier of the currently authenticated user.
    *
@@ -546,6 +572,17 @@ public function isApiUser(): bool {
     return $this->authenticatedApiUser;
   }
 
+  /**
+   * Determine if the current user is authenticated.
+   *
+   * @since  COmanage Registry v5.0.0
+   * @return bool True if the current user is authenticated
+   */
+
+  public function isAuthenticatedUser(): bool {
+    return !empty($this->authenticatedUser);
+  }
+
   /**
    * Determine if the current user is a CO Administrator.
    *

diff --git a/app/templates/Dashboards/configuration.php b/app/templates/Dashboards/configuration.php
@@ -34,6 +34,8 @@
 
 <section class="inner-content">
   <?php if(!empty($vv_platform_menu_items)): ?>
+    <h2 class="config-subtitle"><?= __d('menu','co.configuration.panel.platform') ?></h2>
+    <p class="menu-panel-links-desc"><?= __d('menu','co.configuration.panel.platform.desc') ?></p>
     <ul id="platform-menu" class="config-menu">
       <?php foreach($vv_platform_menu_items as $label => $cfg): ?>
         <li>
@@ -50,7 +52,9 @@
           ?>
         </li>
       <?php endforeach; // $vv_configuration_menu_items ?>
-  </ul>
+    </ul>
+    <h2 class="config-subtitle mb-2"><?= __d('menu','co.configuration.title') ?></h2>
+    <p class="menu-panel-links-desc"><?= __d('menu','co.configuration.desc') ?></p>
   <?php endif; // $vv_platform_menu_items ?>
   <ul id="configuration-menu" class="config-menu">
     <?php foreach($vv_configuration_menu_items as $label => $cfg): ?>
@@ -72,6 +76,30 @@
   </ul>
 </section>
 
+<?php if(empty($vv_platform_menu_items) && $vv_user_roles['platform']): ?>
+  <?php
+    $noticeUrls = [    
+      $this->Url->build([
+        'plugin'       => null,
+        'controller'   => 'dashboards',
+        'action'       => 'configuration',
+        '?'            => [
+          'co_id' => 1
+      ]]),
+      $this->Url->build([
+      'plugin'       => null,
+      'controller'   => 'dashboards',
+      'action'       => 'dashboard',
+      '?'            => [
+        'co_id' => 1
+      ]])
+    ];
+  ?>
+  <div class="config-platform-notice">
+    <?= $this->Alert->alert(__d('information','cmp.config.notice', $noticeUrls), 'information', true) ?>
+  </div>
+<?php endif; ?>
+
 <div class="comanage-version">
   <?php print __('registry.version', chop(file_get_contents(CONFIG . "VERSION"))); ?>
 </div>
diff --git a/app/templates/Dashboards/dashboard.php b/app/templates/Dashboards/dashboard.php
@@ -26,8 +26,16 @@
  */
 
 // XXX This is a placeholder
+
+// $flashArgs pass banner messages to the flash element container
+$flashArgs = [];
+if(!empty($banners)) {
+  $flashArgs['vv_banners'] = $banners;
+}
+
 ?>
 
 <div id="introduction">
+  <?= $this->element('flash', $flashArgs); ?>
   <p><?= __d('menu','menu.introduction') ?></p>
 </div>
diff --git a/app/templates/element/menuPanel.php b/app/templates/element/menuPanel.php
@@ -324,8 +324,8 @@
       <?php endif; // $vv_platform_menu_items ?>
       <ul class="menu-panel-links">
         <li>
-          <h3><?= __d('menu','co.configuration.panel.setup') ?></h3>
-          <p class="menu-panel-links-desc"><?= __d('menu','co.configuration.panel.setup.desc') ?></p>
+          <h3><?= __d('menu','co.configuration.title') ?></h3>
+          <p class="menu-panel-links-desc"><?= __d('menu','co.configuration.desc') ?></p>
           <ul class="menu-panel-links-inner">
             <li>
               <?php
@@ -411,6 +411,29 @@
       </ul>
       */ ?>
     </div>
+    <?php if($vv_cur_co->id != 1 && $vv_user_roles['platform']): ?>
+      <?php
+      $noticeUrls = [
+        $this->Url->build([
+          'plugin'       => null,
+          'controller'   => 'dashboards',
+          'action'       => 'configuration',
+          '?'            => [
+            'co_id' => 1
+          ]]),
+        $this->Url->build([
+          'plugin'       => null,
+          'controller'   => 'dashboards',
+          'action'       => 'dashboard',
+          '?'            => [
+            'co_id' => 1
+          ]])
+      ];
+      ?>
+      <div class="config-platform-notice">
+        <?= $this->Alert->alert(__d('information','cmp.config.notice', $noticeUrls), 'information', true) ?>
+      </div>
+    <?php endif; ?>
     <div class="comanage-version">
       <?php print __('registry.version', chop(file_get_contents(CONFIG . "VERSION"))); ?>
     </div>

diff --git a/app/templates/layout/default.php b/app/templates/layout/default.php
@@ -89,6 +89,13 @@
     } else {
       $bodyClasses .= ' logged-out';
     }
+
+    // add hints that we're in the platform-level (COmanage) CO
+    $isPlatformCO = false;
+    if(!empty($vv_cur_co) && ($vv_cur_co->id == 1) && !($vv_controller == 'Cos' && $vv_action == 'select')) {
+      $isPlatformCO = true;
+      $bodyClasses .= ' platform-co';
+    }
   ?>
   <body class="<?= $bodyClasses ?>" onload="jsOnLoadCallHooks()">
     <div id="skip-to-content-box">
@@ -97,7 +104,6 @@
 
     <!-- Primary layout -->
     <div id="comanage-wrapper">
-
       <!-- Include custom header -->
       <?php if(!empty($vv_theme_header)): ?>
         <header id="customHeader">
@@ -158,6 +164,21 @@
           <?= $this->element('menuTop') ?>
         </div>
       </div>
+
+      <?php if($isPlatformCO): ?>
+        <?php
+        $platformConfigUrl = $this->Url->build([
+          'plugin'       => null,
+          'controller'   => 'dashboards',
+          'action'       => 'configuration',
+          '?'            => [
+            'co_id' => 1
+          ]]);
+        ?>
+        <div id="platform-notice">
+          <?= __d('information','cmp.co.notice', [$platformConfigUrl]) ?>
+        </div>
+      <?php endif; ?>
 
       <div id="main-wrapper">
         <?php if(!empty($vv_user) && !empty($vv_cur_co) && !$isCoSelectView): ?>

diff --git a/app/webroot/css/co-base.css b/app/webroot/css/co-base.css
@@ -946,6 +946,16 @@ ul.form-list li.alert-banner .co-alert {
 .top-filters-fields-date .duet-date__toggle {
   margin-top: -3px;
 }
+/* PLATFORM NOTICE (for COmanage CO) */
+#platform-notice {
+  padding: 0.5em;
+  text-align: center;
+  border-bottom: 1px solid var(--cmg-color-bg-006);
+  background-color: var(--cmg-color-highlight-004);
+}
+#platform-notice a:hover {
+  text-decoration: underline;
+}
 /* CO CONFIGURATION DASHBOARD */
 .config-menu {
   list-style: none;
@@ -965,6 +975,26 @@ ul.form-list li.alert-banner .co-alert {
   border-bottom: 1px solid var(--cmg-color-bg-006);
   padding-bottom: 1em;
 }
+h2.config-subtitle {
+  font-size: 1.6em;
+}
+.config-platform-notice {
+  margin: 4em 0 -3em;
+}
+#main-menu .menu-panel .config-platform-notice {
+  margin: 0 0 1em;
+}
+#main-menu .menu-panel .config-platform-notice a {
+  display: inline;
+  padding: 0;
+}
+#main-menu .menu-panel .config-platform-notice a:hover {
+  background-color: unset;
+  text-decoration: underline;
+}
+#main-menu .menu-panel .config-platform-notice .material-icons-outlined {
+  font-size: 24px;
+}
 /* INDEX ACTION COMMAND MENUS */
 th.with-field-actions {
   padding-left: 2.75em;

diff --git a/app/webroot/css/co-responsive.css b/app/webroot/css/co-responsive.css
@@ -239,6 +239,9 @@
   #advanced-menu {
     margin-top: 2rem;
   }
+  body.platform-co #advanced-menu li a {
+    padding: 0.25em;
+  }
   #co-menu-collapse {
     display: flex;
     justify-content: center;
@@ -294,6 +297,9 @@
     bottom: 2rem;
     margin: 0;
   }
+  #main-menu .menu-panel .config-platform-notice {
+    margin: 10em 0 4em;
+  }
   /* GENERAL */
   .table-container {
     overflow: unset;