SpaceActivityPublisher.java
/*
* Copyright (C) 2003-2010 eXo Platform SAS.
*
* 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.
*
* 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see<http://www.gnu.org/licenses/>.
*/
package org.exoplatform.social.core.application;
import org.apache.commons.lang.StringEscapeUtils;
import org.exoplatform.container.PortalContainer;
import org.exoplatform.container.xml.InitParams;
import org.exoplatform.services.log.ExoLogger;
import org.exoplatform.services.log.Log;
import org.exoplatform.social.core.BaseActivityProcessorPlugin;
import org.exoplatform.social.core.activity.model.ExoSocialActivity;
import org.exoplatform.social.core.activity.model.ExoSocialActivityImpl;
import org.exoplatform.social.core.identity.model.Identity;
import org.exoplatform.social.core.identity.model.Profile;
import org.exoplatform.social.core.identity.provider.OrganizationIdentityProvider;
import org.exoplatform.social.core.identity.provider.SpaceIdentityProvider;
import org.exoplatform.social.core.manager.ActivityManager;
import org.exoplatform.social.core.manager.IdentityManager;
import org.exoplatform.social.core.processor.I18NActivityUtils;
import org.exoplatform.social.core.space.SpaceListenerPlugin;
import org.exoplatform.social.core.space.model.Space;
import org.exoplatform.social.core.space.model.Space.UpdatedField;
import org.exoplatform.social.core.space.spi.SpaceLifeCycleEvent;
import org.exoplatform.social.core.space.spi.SpaceLifeCycleEvent.Type;
import org.exoplatform.social.core.storage.api.IdentityStorage;
import org.exoplatform.social.core.storage.api.SpaceStorage;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.Map;
/**
* This listener is responsible for initializing and notifying activity stream for the space. We create a special
* opensocial user (with a group provider) ready to receive new activities.
*
* @author <a href="mailto:patrice.lamarque@exoplatform.com">Patrice Lamarque</a>
* @version $Revision$
*/
public class SpaceActivityPublisher extends SpaceListenerPlugin {
/**
* The SPACE_DISPLAY_NAME_PARAM template param key
* @since 1.2.8
*/
public static final String SPACE_DISPLAY_NAME_PARAM = "SPACE_DISPLAY_NAME_PARAM";
public static final String NUMBER_OF_PUBLIC_SPACE = "NUMBER_OF_PUBLIC_SPACE";
public static final String USER_JOINED_PUBLIC_SPACE_TITLE_ID = "user_joined_public_space";
public static final String USER_JOINED_PUBLIC_SPACES_TITLE_ID = "user_joined_public_spaces";
/**
* The USER_NAME_PARAM template param key
* @since 1.2.8
*/
public static final String USER_NAME_PARAM = "USER_NAME_PARAM";
public static final String SPACE_DESCRIPTION_PARAM = "SPACE_DESCRIPTION_PARAM";
public static final String SPACE_APP_ID = "exosocial:spaces";
public static final String SPACE_PROFILE_ACTIVITY = "SPACE_ACTIVITY";
public static final String USER_ACTIVITIES_FOR_SPACE = "USER_ACTIVITIES_FOR_SPACE";
public static final String SPACE_CREATED_TITLE_ID = "space_created";
public static final String MANAGER_GRANTED_TITLE_ID = "manager_role_granted";
public static final String USER_JOINED_TITLE_ID = "has_joined";
public static final String USER_SPACE_JOINED_TITLE_ID = "user_space_joined";
public static final String MEMBER_LEFT_TITLE_ID = "has_left";
public static final String MANAGER_REVOKED_TITLE_ID = "manager_role_revoked";
public static final String SPACE_RENAMED_TITLE_ID = "space_renamed";
public static final String SPACE_DESCRIPTION_EDITED_TITLE_ID = "space_description_edited";
public static final String SPACE_AVATAR_EDITED_TITLE_ID = "space_avatar_edited";
/**
* The Logger.
*/
private static final Log LOG = ExoLogger.getExoLogger(SpaceActivityPublisher.class);
/**
* activity manager for posting activities.
*/
private ActivityManager activityManager;
/**
* identity manager for getting identities.
*/
private IdentityManager identityManager;
/**
* Constructor.
*
* @param params the initial params
* @param activityManager the activity manager
* @param identityManager the identity manager
*/
public SpaceActivityPublisher(final InitParams params,
final ActivityManager activityManager,
final IdentityManager identityManager) {
this.activityManager = activityManager;
this.identityManager = identityManager;
}
/**
* {@inheritDoc}
*/
@Override
public void spaceCreated(SpaceLifeCycleEvent event) {
Space space = event.getSpace();
final String activityMessage = "Has joined the space.";
Map<String, String> templateParams = new LinkedHashMap<>();
templateParams.put(SPACE_DISPLAY_NAME_PARAM, space.getDisplayName());
recordActivity(event, activityMessage, SPACE_CREATED_TITLE_ID, templateParams);
}
/**
* {@inheritDoc}
*/
@Override
public void spaceRemoved(SpaceLifeCycleEvent event) {
LOG.debug("space " + event.getSpace().getDisplayName() + " was removed!");
}
/**
* {@inheritDoc}
*/
@Override
public void applicationActivated(SpaceLifeCycleEvent event) {
LOG.debug("application <strong>" + event.getTarget() + "</strong> was activated in space "
+ event.getSpace().getDisplayName());
}
/**
* {@inheritDoc}
*/
@Override
public void applicationAdded(SpaceLifeCycleEvent event) {
LOG.debug("application <strong>" + event.getTarget() + "</strong> was added in space "
+ event.getSpace().getDisplayName());
}
/**
* {@inheritDoc}
*/
@Override
public void applicationDeactivated(SpaceLifeCycleEvent event) {
LOG.debug("application " + event.getTarget() + " was deactivated in space "
+ event.getSpace().getDisplayName());
}
/**
* {@inheritDoc}
*/
@Override
public void applicationRemoved(SpaceLifeCycleEvent event) {
LOG.debug("application " + event.getTarget() + " was removed in space "
+ event.getSpace().getDisplayName());
}
/**
* {@inheritDoc}
*/
@Override
public void grantedLead(SpaceLifeCycleEvent event) {
Space space = event.getSpace();
final String activityMessage = "@" + event.getTarget() + " has been promoted as space's manager.";
Map<String, String> templateParams = new LinkedHashMap<String, String>();
templateParams.put(USER_NAME_PARAM, "@" + event.getTarget());
templateParams.put(BaseActivityProcessorPlugin.TEMPLATE_PARAM_TO_PROCESS, USER_NAME_PARAM);
recordActivity(new SpaceLifeCycleEvent(space, space.getEditor(), Type.GRANTED_LEAD), activityMessage, MANAGER_GRANTED_TITLE_ID, templateParams);
LOG.debug("user " + event.getTarget() + " has been promoted as space's manager " + space.getDisplayName());
}
/**
* {@inheritDoc}
*/
@Override
public void joined(SpaceLifeCycleEvent event) {
final String activityMessage ="Has joined the space.";
Map<String, String> templateParams = new LinkedHashMap<String, String>();
//
recordActivity(event, activityMessage, USER_JOINED_TITLE_ID, templateParams);
LOG.debug("user " + event.getTarget() + " joined space " + event.getSpace().getDisplayName());
}
/**
* {@inheritDoc}
*/
@Override
public void left(SpaceLifeCycleEvent event) {
Space space = event.getSpace();
Identity spaceIdentity = identityManager.getOrCreateIdentity(SpaceIdentityProvider.NAME, space.getPrettyName(), false);
String activityId = getStorage().getProfileActivityId(spaceIdentity.getProfile(), Profile.AttachedActivityType.SPACE);
if (activityId != null) {
try {
ExoSocialActivity activity = (ExoSocialActivityImpl) activityManager.getActivity(activityId);
updateActivity(activity, space.getPrettyName());
activityManager.updateActivity(activity);
} catch (Exception e) {
LOG.debug("Cannot update space activity.");
}
}
LOG.debug("user " + event.getTarget() + " has left of space " + event.getSpace().getDisplayName());
}
/**
* {@inheritDoc}
*/
@Override
public void revokedLead(SpaceLifeCycleEvent event) {
Space space = event.getSpace();
final String activityMessage = "@" + event.getTarget() + " has been revoked as space's manager.";
Map<String, String> templateParams = new LinkedHashMap<String, String>();
templateParams.put(USER_NAME_PARAM, "@" + event.getTarget());
templateParams.put(BaseActivityProcessorPlugin.TEMPLATE_PARAM_TO_PROCESS, USER_NAME_PARAM);
recordActivity(new SpaceLifeCycleEvent(space, space.getEditor(), Type.REVOKED_LEAD), activityMessage, MANAGER_REVOKED_TITLE_ID, templateParams);
LOG.debug("user " + event.getTarget() + " has been revoked as space's manage "
+ event.getSpace().getDisplayName());
}
/**
* {@inheritDoc}
*/
@Override
public void spaceRenamed(SpaceLifeCycleEvent event) {
final String activityMessage = "Name has been updated to: "+event.getSpace().getDisplayName();
Map<String, String> templateParams = new LinkedHashMap<String, String>();
templateParams.put(SPACE_DISPLAY_NAME_PARAM, event.getSpace().getDisplayName());
templateParams.put(BaseActivityProcessorPlugin.TEMPLATE_PARAM_TO_PROCESS, SPACE_DISPLAY_NAME_PARAM);
recordActivity(event, activityMessage, SPACE_RENAMED_TITLE_ID, templateParams);
LOG.debug("Name has been updated ");
// Update description at the same time of rename space
if (UpdatedField.DESCRIPTION.equals(event.getSpace().getField())) {
spaceDescriptionEdited(event);
}
}
/**
* {@inheritDoc}
*/
@Override
public void spaceDescriptionEdited(SpaceLifeCycleEvent event) {
String spaceDescription = StringEscapeUtils.unescapeHtml(event.getSpace().getDescription());
final String activityMessage = "Description has been updated to: "+ spaceDescription;
Map<String, String> templateParams = new LinkedHashMap<String, String>();
templateParams.put(SPACE_DESCRIPTION_PARAM, spaceDescription);
templateParams.put(BaseActivityProcessorPlugin.TEMPLATE_PARAM_TO_PROCESS, SPACE_DESCRIPTION_PARAM);
recordActivity(event, activityMessage, SPACE_DESCRIPTION_EDITED_TITLE_ID, templateParams);
LOG.debug("Description has been updated ");
}
/**
* {@inheritDoc}
*/
@Override
public void spaceAvatarEdited(SpaceLifeCycleEvent event) {
final String activityMessage = "Space has a new avatar.";
Map<String, String> templateParams = new LinkedHashMap<String, String>();
recordActivity(event, activityMessage, SPACE_AVATAR_EDITED_TITLE_ID, templateParams);
LOG.debug("Space has a new avatar.");
}
/**
* {@inheritDoc}
*/
@Override
public void spaceAccessEdited(SpaceLifeCycleEvent event) {
Space space = event.getSpace();
//Update space's activity
Identity spaceIdentity = identityManager.getOrCreateIdentity(SpaceIdentityProvider.NAME, space.getPrettyName(), false);
String spaceActivityId = getStorage().getProfileActivityId(spaceIdentity.getProfile(), Profile.AttachedActivityType.SPACE);
if (spaceActivityId != null) {
ExoSocialActivity activity = (ExoSocialActivityImpl) activityManager.getActivity(spaceActivityId);
if (activity != null) {
if (Space.HIDDEN.equals(space.getVisibility())) {
activity.isHidden(true);
}
if (Space.PRIVATE.equals(space.getVisibility())) {
activity.isHidden(false);
}
activityManager.updateActivity(activity);
}
}
//Update user space activity of all member of space
String[] members = space.getMembers();
for (String member : members) {
Identity identity = identityManager.getOrCreateIdentity(OrganizationIdentityProvider.NAME, member, false);
String userSpaceActivityId = getStorage().getProfileActivityId(identity.getProfile(), Profile.AttachedActivityType.RELATION);
if (userSpaceActivityId != null) {
ExoSocialActivity activity = (ExoSocialActivityImpl) activityManager.getActivity(userSpaceActivityId);
if (activity != null) {
int numberOfSpacesOfMember = getSpaceStorage().getNumberOfMemberPublicSpaces(identity.getRemoteId());
Map<String, String> templateParams = activity.getTemplateParams();
templateParams.put(NUMBER_OF_PUBLIC_SPACE, String.valueOf(numberOfSpacesOfMember));
templateParams.put(BaseActivityProcessorPlugin.TEMPLATE_PARAM_TO_PROCESS, NUMBER_OF_PUBLIC_SPACE);
activity.setTemplateParams(templateParams);
if (numberOfSpacesOfMember > 1) {
activity.setTitle("I now member of " + numberOfSpacesOfMember + " spaces");
activity.setTitleId(USER_JOINED_PUBLIC_SPACES_TITLE_ID);
} else {
activity.setTitle("I now member of " + numberOfSpacesOfMember + " space");
activity.setTitleId(USER_JOINED_PUBLIC_SPACE_TITLE_ID);
}
activityManager.updateActivity(activity);
}
}
}
}
/**
* Records an activity based on space lifecyle event and the activity object.
*
* @param event the space lifecyle event
* @param activityMessage the message of activity object
* @param titleId the title of activity (comment)
* @param templateParams
*/
private void recordActivity(SpaceLifeCycleEvent event, String activityMessage, String titleId,
Map<String, String> templateParams) {
Space space = event.getSpace();
Identity spaceIdentity = identityManager.getOrCreateIdentity(SpaceIdentityProvider.NAME, space.getPrettyName(), false);
Identity identity = identityManager.getOrCreateIdentity(OrganizationIdentityProvider.NAME, event.getTarget(), false);
String activityId = getStorage().getProfileActivityId(spaceIdentity.getProfile(), Profile.AttachedActivityType.SPACE);
if (activityId != null) {
try {
ExoSocialActivity comment = createComment(activityMessage, titleId, null, SPACE_APP_ID, identity, templateParams);
ExoSocialActivity activity = (ExoSocialActivityImpl) activityManager.getActivity(activityId);
// When update number of members in case of join and left space ==> update the activity's title
if (USER_JOINED_TITLE_ID.equals(titleId)) {
updateActivity(activity, space.getPrettyName());
activityManager.updateActivity(activity);
}
activityManager.saveComment(activity, comment);
} catch (Exception e) {
LOG.debug("Run in case of activity deleted and reupdate");
activityId = null;
}
}
if (activityId == null) {
ExoSocialActivity activity = new ExoSocialActivityImpl();
activity.setType(SPACE_PROFILE_ACTIVITY);
updateActivity(activity, space.getPrettyName());
if (Space.HIDDEN.equals(space.getVisibility())) {
activity.isHidden(true);
}
activity.getTemplateParams().put(Space.CREATOR, event.getTarget());
activityManager.saveActivityNoReturn(spaceIdentity, activity);
getStorage().updateProfileActivityId(spaceIdentity, activity.getId(), Profile.AttachedActivityType.SPACE);
if (SPACE_CREATED_TITLE_ID.equals(titleId))
titleId = USER_JOINED_TITLE_ID;
ExoSocialActivity comment = createComment(activityMessage, titleId, null, SPACE_APP_ID, identity, templateParams);
activityManager.saveComment(activity, comment);
}
}
private void updateActivity(ExoSocialActivity activity, String spacePrettyName) {
Space sp = getSpaceStorage().getSpaceByPrettyName(spacePrettyName);
//The value of the title is not used at the end and it is replaced by the translation from the resource bundle, but is is necessary to avoid null check when saving the activity
String title = " ";
String titleId;
if ((sp.getMembers().length) > 1) {
titleId = "space_members";
} else {
titleId = "space_member";
}
Map<String, String> params = new HashMap<String, String>();
activity.setTitle(title);
activity.setTitleId(null);
activity.setTemplateParams(params);
I18NActivityUtils.addResourceKey(activity, titleId, "" + sp.getMembers().length);
}
private ExoSocialActivity createComment(String title, String titleId, String spacePrettyName, String type, Identity identity, Map<String, String> templateParams) {
ExoSocialActivityImpl comment = new ExoSocialActivityImpl();
comment.setTitle(title);
comment.setTitleId(titleId);
comment.setUserId(identity.getId());
comment.setType(type);
if (spacePrettyName != null) {
templateParams.put(SPACE_DISPLAY_NAME_PARAM, spacePrettyName);
templateParams.put(BaseActivityProcessorPlugin.TEMPLATE_PARAM_TO_PROCESS, SPACE_DISPLAY_NAME_PARAM);
}
comment.setTemplateParams(templateParams);
return comment;
}
private IdentityStorage getStorage() {
return (IdentityStorage) PortalContainer.getInstance().getComponentInstanceOfType(IdentityStorage.class);
}
private SpaceStorage getSpaceStorage() {
return (SpaceStorage) PortalContainer.getInstance().getComponentInstanceOfType(SpaceStorage.class);
}
@Override
public void addInvitedUser(SpaceLifeCycleEvent event) {
}
@Override
public void addPendingUser(SpaceLifeCycleEvent event) {
}
@Override
public void spaceBannerEdited(SpaceLifeCycleEvent event) {
LOG.debug("Banner of space {} has been updated", event.getSpace().getId());
}
}