feat: Make Programs and rules publically accessible when Hub access i…

…s Open - MEED-2811 - Meeds-io/MIPs#100 (#1275)

This change will introduce new business rules to allow open the access
to program details and its associated rules when the Hub access is open.
At the same time to have a better performances to request the programs,
the Space Registration startegy is duplicated in Program Table and thus
a migration procedure has been elaborated to make the change on existing
programs.

portlets/src/main/webapp/WEB-INF/conf/gamification/upgrade-configuration.xml

@@ -76,6 +76,29 @@
         </value-param>
       </init-params>
     </component-plugin>
+    <component-plugin>
+      <name>ProgramVisibilityUpgradePlugin</name>
+      <set-method>addUpgradePlugin</set-method>
+      <type>io.meeds.gamification.upgrade.ProgramVisibilityUpgradePlugin</type>
+      <description>An upgrade plugin to set a program visibility switch audience registration type</description>
+      <init-params>
+        <value-param>
+          <name>product.group.id</name>
+          <description>The groupId of the product</description>
+          <value>org.exoplatform.social</value>
+        </value-param>
+        <value-param>
+          <name>plugin.execution.order</name>
+          <description>The plugin execution order</description>
+          <value>5</value>
+        </value-param>
+        <value-param>
+          <name>plugin.upgrade.execute.once</name>
+          <description>Execute only once, not each version change</description>
+          <value>true</value>
+        </value-param>
+      </init-params>
+    </component-plugin>
   </external-component-plugins>
 
 </configuration>

portlets/src/main/webapp/WEB-INF/jsp/engagementCenterActions.jsp

@@ -21,17 +21,18 @@
 <%@ page import="io.meeds.gamification.service.ProgramService"%>
 <%@ page import="org.exoplatform.container.ExoContainerContext"%>
 <%@ page import="io.meeds.gamification.utils.Utils" %>
-<%@ page import="org.exoplatform.services.security.ConversationState" %>
 
 <%
-boolean isAdministrator = Utils.isRewardingManager(ConversationState.getCurrent().getIdentity().getUserId());
-boolean isProgramManager = isAdministrator || ExoContainerContext.getService(ProgramService.class).countOwnedPrograms(ConversationState.getCurrent().getIdentity().getUserId()) > 0;
+  if (Utils.canAccessAnonymousResources()) {
+    boolean isAdministrator = request.getRemoteUser() != null && Utils.isRewardingManager(request.getRemoteUser());
+    boolean isProgramManager = request.getRemoteUser() != null && (isAdministrator || ExoContainerContext.getService(ProgramService.class).countOwnedPrograms(request.getRemoteUser()) > 0);
 %>
-
 <div class="VuetifyApp singlePageApplication">
   <div id="EngagementCenterActions">
     <script type="text/javascript">
       require(['PORTLET/gamification-portlets/EngagementCenterActions'], app => app.init(<%=isAdministrator%>, <%=isProgramManager%>));
     </script>
   </div>
 </div>
+<% } %>
+

portlets/src/main/webapp/WEB-INF/jsp/programsOverview.jsp

@@ -0,0 +1,11 @@
+<%@page import="io.meeds.gamification.utils.Utils"%>
+<% if (Utils.canAccessAnonymousResources()) { %>
+  <div class="VuetifyApp">
+    <div id="programsOverview">
+      <script type="text/javascript">
+                require(['PORTLET/gamification-portlets/programsOverview'], app => app.init());
+        </script>
+    </div>
+  </div>
+<% } %>
+

portlets/src/main/webapp/WEB-INF/jsp/rulesOverview/index.jsp → portlets/src/main/webapp/WEB-INF/jsp/rulesOverview.jsp

@@ -18,8 +18,10 @@
  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  */
 %>
+<%@page import="io.meeds.gamification.utils.Utils"%>
 <%
   Object showLocked = request.getAttribute("showLocked");
+ if (Utils.canAccessAnonymousResources()) {
 %>
 <div class="VuetifyApp">
   <div id="rulesOverview">
@@ -28,3 +30,4 @@
     </script>
   </div>
 </div>
+<% } %>

portlets/src/main/webapp/WEB-INF/jsp/topChallengers.jsp

@@ -0,0 +1,10 @@
+<%@page import="io.meeds.gamification.utils.Utils"%>
+<% if (Utils.canAccessAnonymousResources()) { %>
+  <div class="VuetifyApp">
+    <div id="topChallengers">
+      <script type="text/javascript">
+                require(['PORTLET/gamification-portlets/topChallengers'], app => app.init());
+        </script>
+    </div>
+  </div>
+<% } %>

portlets/src/main/webapp/WEB-INF/portlet.xml

@@ -126,7 +126,7 @@ Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
     </init-param>
     <init-param>
       <name>prefetch.resource.rest</name>
-      <value><![CDATA[/portal/rest/gamification/programs?type=ALL&sortByBudget=true|/portal/rest/gamification/leaderboard/filter?period=WEEK&capacity=10]]></value>
+      <value><![CDATA[/portal/rest/gamification/programs?type=ALL|/portal/rest/gamification/leaderboard/filter?period=WEEK&capacity=10]]></value>
     </init-param>
     <supports>
       <mime-type>text/html</mime-type>
@@ -258,14 +258,12 @@ Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
     <portlet-class>org.exoplatform.commons.api.portlet.GenericDispatchedViewPortlet</portlet-class>
     <init-param>
       <name>portlet-view-dispatched-file-path</name>
-      <value>/html/topChallengers.html</value>
+      <value>/WEB-INF/jsp/topChallengers.jsp</value>
     </init-param>
     <init-param>
       <name>prefetch.resource.rest</name>
       <value><![CDATA[/portal/rest/gamification/leaderboard/rank/all?loadCapacity=false&period=WEEK]]></value>
     </init-param>
-    <expiration-cache>-1</expiration-cache>
-    <cache-scope>PUBLIC</cache-scope>
     <supports>
       <mime-type>text/html</mime-type>
     </supports>
@@ -282,7 +280,7 @@ Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
     <portlet-class>org.exoplatform.commons.api.portlet.GenericDispatchedViewPortlet</portlet-class>
     <init-param>
       <name>portlet-view-dispatched-file-path</name>
-      <value>/WEB-INF/jsp/rulesOverview/index.jsp</value>
+      <value>/WEB-INF/jsp/rulesOverview.jsp</value>
     </init-param>
     <supports>
       <mime-type>text/html</mime-type>
@@ -306,18 +304,16 @@ Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
     <portlet-class>org.exoplatform.commons.api.portlet.GenericDispatchedViewPortlet</portlet-class>
     <init-param>
       <name>portlet-view-dispatched-file-path</name>
-      <value>/html/programsOverview.html</value>
+      <value>/WEB-INF/jsp/programsOverview.jsp</value>
     </init-param>
     <init-param>
       <name>preload.resource.bundles</name>
       <value>locale.addon.Gamification</value>
     </init-param>
     <init-param>
       <name>preload.resource.rest</name>
-      <value><![CDATA[/portal/rest/gamification/programs?returnSize=true&limit=3&type=ALL&status=ENABLED&includeDeleted=false&sortByBudget=true]]></value>
+      <value><![CDATA[/portal/rest/gamification/programs?returnSize=true&limit=4&status=ENABLED&sortBy=modifiedDate&sortDescending=true&lang=en&expand=countActiveRules]]></value>
     </init-param>
-    <expiration-cache>-1</expiration-cache>
-    <cache-scope>PUBLIC</cache-scope>
     <supports>
       <mime-type>text/html</mime-type>
     </supports>

portlets/src/main/webapp/vue-app/profileStats/components/GamificationRank.vue

@@ -68,12 +68,14 @@ Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
           justify-center
           align-end>
           <div v-if="leaderBoardArray[1]" class="transparent mx-1 align-center">
-            <exo-user-avatar
+            <user-avatar
               :profile-id="leaderBoardArray[1].remoteId"
+              :name="leaderBoardArray[1].fullname"
+              :avatar-url="leaderBoardArray[1].avatarUrl"
+              :popover="leaderBoardArray[1].remoteId"
               :size="40"
               extra-class="me-2 ml-2 pa-0 mt-0 mb-1 rounded-circle elevation-1 d-inline-block"
               avatar
-              popover
               popover-left-position />
             <v-card-text
               class="top2 grey lighten-1 px-3 py-2 flex d-flex white--text justify-center font-weight-bold"
@@ -82,12 +84,14 @@ Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             </v-card-text>
           </div>
           <div v-if="leaderBoardArray[0]" class="transparent mx-1 align-center">
-            <exo-user-avatar
+            <user-avatar
               :profile-id="leaderBoardArray[0].remoteId"
+              :name="leaderBoardArray[0].fullname"
+              :avatar-url="leaderBoardArray[0].avatarUrl"
+              :popover="leaderBoardArray[0].remoteId"
               :size="40"
               extra-class="ml-2 me-2 pa-0 mt-0 mb-1 rounded-circle elevation-1 d-inline-block"
               avatar
-              popover
               popover-left-position />
             <v-card-text
               class="top1 yellow darken-1 px-3 py-2 flex d-flex white--text justify-center font-weight-bold"
@@ -96,12 +100,14 @@ Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             </v-card-text>
           </div>
           <div v-if="leaderBoardArray[2]" class="transparent mx-1 align-center">
-            <exo-user-avatar
+            <user-avatar
               :profile-id="leaderBoardArray[2].remoteId"
+              :name="leaderBoardArray[2].fullname"
+              :avatar-url="leaderBoardArray[2].avatarUrl"
+              :popover="leaderBoardArray[1].remoteId"
               :size="40"
               extra-class="me-2 ml-2 pa-0 mt-0 mb-1 rounded-circle elevation-1 d-inline-block"
               avatar
-              popover
               popover-left-position />
             <v-card-text
               class="top3 amber darken-1 px-3 pb-1 flex d-flex white--text justify-center font-weight-bold pt-2px"
@@ -126,14 +132,16 @@ Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
                 flat>
                 {{ item.rank }}
               </v-card>
-              <exo-user-avatar
+              <user-avatar
                 :profile-id="item.remoteId"
+                :name="item.fullname"
+                :avatar-url="item.avatarUrl"
+                :popover="item.remoteId"
+                :bold-title="identityId && item.socialId === identityId"
                 :size="25"
-                :bold-title="item.socialId === identityId"
                 extra-class="me-0 pa-0 my-0 text-truncate-2"
                 popover-left-position
-                offset-x
-                popover />
+                offset-x />
               <v-list-item-action class="ml-auto">
                 <span>{{ item.score }}</span>
               </v-list-item-action>

portlets/src/main/webapp/vue-app/usersLeaderboard/components/UsersLeaderboard.vue

@@ -196,7 +196,7 @@ export default {
         });
     },
     retrievePrograms() {
-      return fetch(`${eXo.env.portal.context}/${eXo.env.portal.rest}/gamification/programs?type=ALL&sortByBudget=true`, {
+      return fetch(`${eXo.env.portal.context}/${eXo.env.portal.rest}/gamification/programs?type=ALL`, {
         credentials: 'include',
       }).then(resp => resp?.ok && resp.json())
         .then(data => {

services/src/main/java/io/meeds/gamification/constant/EntityVisibility.java

@@ -0,0 +1,26 @@
+/**
+ * 
+ * This file is part of the Meeds project (https://meeds.io/).
+ * 
+ * Copyright (C) 2023 Meeds Association [email protected]
+ * 
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ * 
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ * 
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * 
+ */
+package io.meeds.gamification.constant;
+
+public enum EntityVisibility {
+  RESTRICTED, OPEN;
+}

services/src/main/java/io/meeds/gamification/dao/ProgramDAO.java

@@ -34,6 +34,7 @@
 import io.meeds.gamification.constant.EntityFilterType;
 import io.meeds.gamification.constant.EntityStatusType;
 import io.meeds.gamification.constant.EntityType;
+import io.meeds.gamification.constant.EntityVisibility;
 import io.meeds.gamification.entity.ProgramEntity;
 import io.meeds.gamification.model.filter.ProgramFilter;
 
@@ -119,6 +120,9 @@ private <T> void addQueryFilterParameters(ProgramFilter filter, TypedQuery<T> qu
     if (CollectionUtils.isNotEmpty(filter.getSpacesIds())) {
       query.setParameter("spacesIds", filter.getSpacesIds());
     }
+    if (filter.getOwnerId() == 0 && (CollectionUtils.isNotEmpty(filter.getSpacesIds()) || !filter.isAllSpaces())) {
+      query.setParameter("openVisibility", EntityVisibility.OPEN);
+    }
     EntityFilterType type = filter.getType();
     if (type != null && type != EntityFilterType.ALL) {
       query.setParameter("type", EntityType.valueOf(type.name()));
@@ -173,10 +177,10 @@ private void buildPredicates(ProgramFilter filter, List<String> suffixes, List<S
       }
     } else if (CollectionUtils.isNotEmpty(filter.getSpacesIds())) {
       suffixes.add("Audience");
-      predicates.add("(d.audienceId IS NULL OR d.audienceId in (:spacesIds))");
+      predicates.add("(d.audienceId IS NULL OR d.visibility = :openVisibility OR d.audienceId in (:spacesIds))");
     } else if (!filter.isAllSpaces()) {
       suffixes.add("OpenAudience");
-      predicates.add("d.audienceId IS NULL");
+      predicates.add("(d.audienceId IS NULL OR d.visibility = :openVisibility)");
     }
     if (StringUtils.isNotBlank(filter.getSortBy())) {
       suffixes.add("SortBy");

services/src/main/java/io/meeds/gamification/dao/RuleDAO.java

@@ -39,6 +39,7 @@
 import io.meeds.gamification.constant.EntityFilterType;
 import io.meeds.gamification.constant.EntityStatusType;
 import io.meeds.gamification.constant.EntityType;
+import io.meeds.gamification.constant.EntityVisibility;
 import io.meeds.gamification.entity.RuleEntity;
 import io.meeds.gamification.model.filter.RuleFilter;
 
@@ -215,6 +216,10 @@ private <T> void addQueryFilterParameters(RuleFilter filter, TypedQuery<T> query
     if (entityFilterType != null && entityFilterType != EntityFilterType.ALL) {
       query.setParameter("filterType", EntityType.valueOf(filter.getType().name()));
     }
+    if ((CollectionUtils.isNotEmpty(filter.getSpaceIds()) && !filter.isExcludeNoSpace())
+        || (CollectionUtils.isEmpty(filter.getSpaceIds()) && !filter.isAllSpaces())) {
+      query.setParameter("openVisibility", EntityVisibility.OPEN);
+    }
   }
 
   private String getQueryFilterName(String sortField,
@@ -311,11 +316,11 @@ private void buildPredicates(RuleFilter filter, List<String> suffixes, List<Stri
         predicates.add("r.domainEntity.audienceId in (:ids)");
       } else {
         suffixes.add("Audience");
-        predicates.add("(r.domainEntity.audienceId IS NULL OR r.domainEntity.audienceId in (:ids))");
+        predicates.add("(r.domainEntity.audienceId IS NULL OR r.domainEntity.visibility = :openVisibility OR r.domainEntity.audienceId in (:ids))");
       }
     } else if (!filter.isAllSpaces()) {
       suffixes.add("OpenAudience");
-      predicates.add("r.domainEntity.audienceId IS NULL");
+      predicates.add("(r.domainEntity.audienceId IS NULL OR r.domainEntity.visibility = :openVisibility)");
     }
     if (CollectionUtils.isNotEmpty(filter.getExcludedRuleIds())) {
       suffixes.add("ExcludeIds");