Feature #13197: implementing new community component.

Modifying component descriptor in order to specify the profile mapping between space and component.

Adding an implementation of ComponentInstanceAccessControlExtension dedicated to Community component in order to implement specific rules with respect to the space manager status.

Adding CommunityWebManager in order to centralize functional code between WEB Services and Web Component controller.

Implementing the edition of the Wysiwyg content of the space community.

Author: SilverYoCha

community/community-configuration/src/main/config/properties/org/silverpeas/components/community/multilang/communityBundle.properties

@@ -21,8 +21,5 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
-
-community.menu.item.subscribe = S'abonner \u00e0 community
-community.menu.item.unsubscribe = Se d\u00e9sabonner de community
-
-community.notifLinkLabel = Voir cette contribution
+community.menu.item.editSpaceHomePage=\u00c9diter la page d'accueil de l'espace
+community.edition.spaceHomePage=\u00c9dition de la page d'accueil de l'espace

community/community-configuration/src/main/config/properties/org/silverpeas/components/community/multilang/communityBundle_de.properties

@@ -21,7 +21,5 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
-community.menu.item.subscribe = Abonnieren Sie community
-community.menu.item.unsubscribe = Abmelden von community
-
-community.notifLinkLabel = Gehe zu diesem Beitrag
+community.menu.item.editSpaceHomePage=Homepage des Raums bearbeiten
+community.edition.spaceHomePage=Ausgabe der Weltraum-Homepage

community/community-configuration/src/main/config/properties/org/silverpeas/components/community/multilang/communityBundle_en.properties

@@ -21,7 +21,5 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
-community.menu.item.subscribe = Subscribe to community
-community.menu.item.unsubscribe = Unsubscribe from community
-
-community.notifLinkLabel = Go to this contribution
+community.menu.item.editSpaceHomePage=Startseite des Bereichs bearbeiten
+community.edition.spaceHomePage=Edition of space homepage

community/community-configuration/src/main/config/properties/org/silverpeas/components/community/multilang/communityBundle_fr.properties

@@ -21,7 +21,5 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
-community.menu.item.subscribe = S'abonner \u00e0 community
-community.menu.item.unsubscribe = Se d\u00e9sabonner de community
-
-community.notifLinkLabel = Voir cette contribution
+community.menu.item.editSpaceHomePage=\u00c9diter la page d'accueil de l'espace
+community.edition.spaceHomePage=\u00c9dition de la page d'accueil de l'espace

community/community-configuration/src/main/config/xmlcomponents/community.xml

@@ -59,6 +59,12 @@
         <message lang="en">Readers.</message>
         <message lang="de">Leser.</message>
       </help>
+      <spaceMapping>
+        <profile>admin</profile>
+        <profile>publisher</profile>
+        <profile>writer</profile>
+        <profile>reader</profile>
+      </spaceMapping>
     </profile>
   </profiles>
   <parameters>

community/community-library/src/main/java/org/silverpeas/components/community/CommunityPostConstruction.java renamed to community/community-library/src/main/java/org/silverpeas/components/community/CommunityInstancePostConstruction.java

@@ -24,20 +24,22 @@
 package org.silverpeas.components.community;
 
 import org.silverpeas.components.community.model.CommunityOfUsers;
+import org.silverpeas.core.admin.component.ComponentInstancePostConstruction;
 import org.silverpeas.core.admin.component.model.ComponentInst;
 import org.silverpeas.core.admin.service.OrganizationController;
 import org.silverpeas.core.annotation.Bean;
-import org.silverpeas.core.admin.component.ComponentInstancePostConstruction;
 
 import javax.inject.Inject;
+import javax.inject.Named;
 import javax.transaction.Transactional;
 
 /**
  * Once the Community application instance created, constructs an empty community of users for the
  * resource in Silverpeas specified in the instance parameter.
  */
 @Bean
-public class CommunityPostConstruction implements ComponentInstancePostConstruction {
+@Named
+public class CommunityInstancePostConstruction implements ComponentInstancePostConstruction {
 
   @Inject
   private OrganizationController controller;

community/community-library/src/main/java/org/silverpeas/components/community/CommunityPreDestruction.java renamed to community/community-library/src/main/java/org/silverpeas/components/community/CommunityInstancePreDestruction.java

@@ -23,26 +23,38 @@
  */
 package org.silverpeas.components.community;
 
+import org.silverpeas.components.community.model.CommunityOfUsers;
 import org.silverpeas.components.community.repository.CommunityOfUsersRepository;
-import org.silverpeas.core.annotation.Bean;
 import org.silverpeas.core.admin.component.ComponentInstancePreDestruction;
+import org.silverpeas.core.annotation.Bean;
+import org.silverpeas.core.contribution.model.WysiwygContent;
 
 import javax.inject.Inject;
+import javax.inject.Named;
 import javax.transaction.Transactional;
+import java.util.Optional;
+
+import static org.silverpeas.components.community.model.CommunityOfUsers.getByComponentInstanceId;
 
 /**
  * Wipe out for the spawned community instance the resources that were allocated to him.
  */
 @Bean
-public class CommunityPreDestruction implements ComponentInstancePreDestruction {
+@Named
+public class CommunityInstancePreDestruction implements ComponentInstancePreDestruction {
 
   @Inject
   private CommunityOfUsersRepository repository;
 
   @Transactional
   @Override
   public void preDestroy(final String componentInstanceId) {
-    repository.getByComponentInstanceId(componentInstanceId)
-        .ifPresent(c -> repository.delete(c));
+    final Optional<CommunityOfUsers> community = getByComponentInstanceId(componentInstanceId);
+    // Cleaning space facade
+    community.map(CommunityOfUsers::getSpaceFacadeContent)
+        .map(WysiwygContent::getContribution)
+        .ifPresent(WysiwygContent::deleteAllContents);
+    // Cleaning database
+    repository.getByComponentInstanceId(componentInstanceId).ifPresent(c -> repository.delete(c));
   }
 }

community/community-library/src/main/java/org/silverpeas/components/community/model/CommunityOfUsers.java

@@ -24,15 +24,26 @@
 package org.silverpeas.components.community.model;
 
 import org.silverpeas.components.community.repository.CommunityOfUsersRepository;
+import org.silverpeas.core.admin.service.OrganizationController;
+import org.silverpeas.core.admin.space.SpaceProfileInst;
+import org.silverpeas.core.admin.user.model.SilverpeasRole;
+import org.silverpeas.core.admin.user.model.User;
+import org.silverpeas.core.contribution.content.wysiwyg.service.WysiwygController;
+import org.silverpeas.core.contribution.model.WysiwygContent;
 import org.silverpeas.core.persistence.Transaction;
 import org.silverpeas.core.persistence.datasource.model.identifier.UuidIdentifier;
 import org.silverpeas.core.persistence.datasource.model.jpa.SilverpeasJpaEntity;
+import org.silverpeas.core.security.authorization.AccessControlContext;
+import org.silverpeas.core.security.authorization.ComponentAccessControl;
 
 import javax.persistence.Column;
 import javax.persistence.Entity;
 import javax.persistence.NamedQuery;
 import javax.persistence.Table;
 import java.util.Optional;
+import java.util.Set;
+
+import static java.util.function.Predicate.not;
 
 /**
  * The community of users for a given Silverpeas resource, for instance a collaborative space. Users
@@ -49,6 +60,7 @@
         "order by c.componentInstanceId, c.id")
 public class CommunityOfUsers
     extends SilverpeasJpaEntity<CommunityOfUsers, UuidIdentifier> {
+  private static final long serialVersionUID = -4908726669864467915L;
 
   @Column(name = "resourceId", nullable = false)
   private String resourceId;
@@ -86,6 +98,14 @@ public static Optional<CommunityOfUsers> getByComponentInstanceId(final String i
     return repository.getByComponentInstanceId(instanceId);
   }
 
+  /**
+   * Gets the space facade content of the Community.
+   * @return a {@link WysiwygContent} instance.
+   */
+  public WysiwygContent getSpaceFacadeContent() {
+    return WysiwygController.get(getComponentInstanceId(), "SpaceFacade", null);
+  }
+
   public String getComponentInstanceId() {
     return componentInstanceId;
   }
@@ -110,4 +130,35 @@ public CommunityOfUsers save() {
       return repository.save(this);
     });
   }
+
+  /**
+   * Indicates if the given user is a member.
+   * <p>
+   *   A member MUST be directly specified into ADMIN, PUBLISHER, WRITER or READER role of direct
+   *   parent space.
+   * </p>
+   * @param user {@link User} instance.
+   * @return true if member, false otherwise.
+   */
+  public boolean isMember(final User user) {
+    final OrganizationController controller = OrganizationController.get();
+    final String currentRequesterId = User.getCurrentRequester().getId();
+    return Optional.of(getResourceId())
+        .map(controller::getSpaceInstById)
+        .stream()
+        .flatMap(s -> s.getAllSpaceProfilesInst().stream())
+        .filter(not(SpaceProfileInst::isManager).and(not(SpaceProfileInst::isInherited)))
+        .flatMap(p -> p.getAllUsers().stream())
+        .anyMatch(i -> i.equals(currentRequesterId));
+  }
+
+  /**
+   * Gets the roles the given user has on the given community.
+   * @param user {@link User} instance.
+   * @return an unmodifiable set of {@link SilverpeasRole}.
+   */
+  public Set<SilverpeasRole> getUserRoleOn(final User user) {
+    return Set.copyOf(ComponentAccessControl.get()
+        .getUserRoles(user.getId(), getComponentInstanceId(), AccessControlContext.init()));
+  }
 }

community/community-library/src/main/java/org/silverpeas/components/community/security/authorization/CommunityInstanceAccessControlExtension.java

@@ -0,0 +1,53 @@
+/*
+ * Copyright (C) 2000 - 2022 Silverpeas
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * As a special exception to the terms and conditions of version 3.0 of
+ * the GPL, you may redistribute this Program in connection with Free/Libre
+ * Open Source Software ("FLOSS") applications as described in Silverpeas's
+ * FLOSS exception.  You should have received a copy of the text describing
+ * the FLOSS exception, and it is also available here:
+ * "https://www.silverpeas.org/legal/floss_exception.html"
+ *
+ * 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 Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package org.silverpeas.components.community.security.authorization;
+
+import org.silverpeas.core.admin.component.model.SilverpeasComponentInstance;
+import org.silverpeas.core.admin.user.model.User;
+import org.silverpeas.core.annotation.Service;
+import org.silverpeas.core.security.authorization.ComponentAccessController;
+import org.silverpeas.core.security.authorization.DefaultInstanceAccessControlExtension;
+
+import javax.inject.Named;
+
+import static org.silverpeas.core.admin.space.SpaceInst.SPACE_KEY_PREFIX;
+import static org.silverpeas.core.util.StringUtil.EMPTY;
+
+/**
+ * @author silveryocha
+ */
+@Named
+@Service
+public class CommunityInstanceAccessControlExtension
+    extends DefaultInstanceAccessControlExtension {
+
+  @Override
+  protected boolean mustUserBeComponentInstanceAdminIfManagerOfParentSpace(
+      final ComponentAccessController.DataManager dataManager, final User user,
+      final SilverpeasComponentInstance componentInstance) {
+    return dataManager.getManageableSpaceIds(user.getId())
+        .contains(componentInstance.getSpaceId().replace(SPACE_KEY_PREFIX, EMPTY));
+  }
+}

community/community-war/src/main/java/org/silverpeas/components/community/CommunityWebManager.java

@@ -0,0 +1,107 @@
+/*
+ * Copyright (C) 2000 - 2022 Silverpeas
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * As a special exception to the terms and conditions of version 3.0 of
+ * the GPL, you may redistribute this Program in connection with Free/Libre
+ * Open Source Software ("FLOSS") applications as described in Silverpeas's
+ * FLOSS exception. You should have received a copy of the text describing
+ * the FLOSS exception, and it is also available here:
+ * "http://www.silverpeas.org/docs/core/legal/floss_exception.html"
+ *
+ * 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 Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package org.silverpeas.components.community;
+
+import org.silverpeas.components.community.model.CommunityOfUsers;
+import org.silverpeas.core.admin.user.model.SilverpeasRole;
+import org.silverpeas.core.admin.user.model.User;
+import org.silverpeas.core.annotation.Service;
+import org.silverpeas.core.cache.service.CacheServiceProvider;
+import org.silverpeas.core.util.ServiceProvider;
+import org.silverpeas.core.web.mvc.webcomponent.WebMessager;
+
+import java.util.Set;
+import java.util.function.Supplier;
+
+import static org.silverpeas.components.community.CommunityComponentSettings.getMessagesIn;
+
+
+/**
+ * WEB manager which allows to centralize code to be used by REST Web Services and Web Component
+ * Controller.
+ * @author silveryocha
+ */
+@Service
+public class CommunityWebManager {
+
+  private static final String CACHE_KEY_PREFIX = CommunityWebManager.class.getSimpleName() + ":";
+
+  protected CommunityWebManager() {
+  }
+
+  /**
+   * Gets the singleton instance of the provider.
+   */
+  public static CommunityWebManager get() {
+    return ServiceProvider.getSingleton(CommunityWebManager.class);
+  }
+
+  /**
+   * Indicates if the current requester is a member.
+   * <p>
+   *   A member MUST be directly specified into ADMIN, PUBLISHER, WRITER or READER role of direct
+   *   parent space.
+   * </p>
+   * @param community {@link CommunityOfUsers} instance.
+   * @return true if member, false otherwise.
+   */
+  public boolean isMemberOf(final CommunityOfUsers community) {
+    return requestCache("isMemberOf", community.getId(), Boolean.class,
+        () -> community.isMember(User.getCurrentRequester()));
+  }
+
+  /**
+   * Gets the roles the current requester has on the given community.
+   * @param community {@link CommunityOfUsers} instance.
+   * @return a set of {@link SilverpeasRole}.
+   */
+  @SuppressWarnings("unchecked")
+  public Set<SilverpeasRole> getUserRoleOn(final CommunityOfUsers community) {
+    return requestCache("userRoleOf", community.getId(), Set.class,
+        () -> community.getUserRoleOn(User.getCurrentRequester()));
+  }
+
+  private <T> T requestCache(final String type, final String id, Class<T> classType,
+      Supplier<T> supplier) {
+    return CacheServiceProvider.getRequestCacheService()
+        .getCache()
+        .computeIfAbsent(CACHE_KEY_PREFIX + type + ":" + id, classType, supplier);
+  }
+
+  /**
+   * Push a success message to the current user.
+   * @param messageKey the key of the message.
+   * @param params the message parameters.
+   */
+  private void successMessage(String messageKey, Object... params) {
+    User owner = User.getCurrentRequester();
+    String userLanguage = owner.getUserPreferences().getLanguage();
+    getMessager().addSuccess(getMessagesIn(userLanguage).getStringWithParams(messageKey, params));
+  }
+
+  private WebMessager getMessager() {
+    return WebMessager.getInstance();
+  }
+}