SaveTeamMemberAddEvents.java

/*
 * ConcourseConnect
 * Copyright 2009 Concursive Corporation
 * http://www.concursive.com
 *
 * This file is part of ConcourseConnect, an open source social business
 * software and community platform.
 *
 * Concursive ConcourseConnect 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, version 3 of the License.
 *
 * Under the terms of the GNU Affero General Public License you must release the
 * complete source code for any application that uses any part of ConcourseConnect
 * (system header files and libraries used by the operating system are excluded).
 * These terms must be included in any work that has ConcourseConnect components.
 * If you are developing and distributing open source applications under the
 * GNU Affero General Public License, then you are free to use ConcourseConnect
 * under the GNU Affero General Public License.
 *
 * If you are deploying a web site in which users interact with any portion of
 * ConcourseConnect over a network, the complete source code changes must be made
 * available.  For example, include a link to the source archive directly from
 * your web site.
 *
 * For OEMs, ISVs, SIs and VARs who distribute ConcourseConnect with their
 * products, and do not license and distribute their source code under the GNU
 * Affero General Public License, Concursive provides a flexible commercial
 * license.
 *
 * To anyone in doubt, we recommend the commercial license. Our commercial license
 * is competitively priced and will eliminate any confusion about how
 * ConcourseConnect can be used and distributed.
 *
 * ConcourseConnect 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 ConcourseConnect.  If not, see <http://www.gnu.org/licenses/>.
 *
 * Attribution Notice: ConcourseConnect is an Original Work of software created
 * by Concursive Corporation
 */
package com.concursive.connect.web.modules.members.workflow;

import com.concursive.commons.workflow.ComponentContext;
import com.concursive.commons.workflow.ComponentInterface;
import com.concursive.commons.workflow.ObjectHookComponent;
import com.concursive.connect.web.modules.activity.dao.ProjectHistory;
import com.concursive.connect.web.modules.activity.dao.ProjectHistoryList;
import com.concursive.connect.web.modules.login.dao.User;
import com.concursive.connect.web.modules.login.utils.UserUtils;
import com.concursive.connect.web.modules.members.dao.TeamMember;
import com.concursive.connect.web.modules.profile.dao.Project;
import com.concursive.connect.web.modules.profile.utils.ProjectUtils;
import com.concursive.connect.web.modules.wiki.utils.WikiLink;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

import java.sql.Connection;

/**
 * Records team member add events
 *
 * @author Ananth
 * @created Feb 20, 2009
 */
public class SaveTeamMemberAddEvents extends ObjectHookComponent implements ComponentInterface {

  private static Log LOG = LogFactory.getLog(SaveTeamMemberAddEvents.class);

  public final static String HISTORY_INVITE_TEXT = "history.invite.text";
  public final static String HISTORY_FAN_TEXT = "history.fan.text";
  public final static String HISTORY_FRIEND_TEXT = "history.friend.text";

  public String getDescription() {
    return "Records team member add events..";
  }

  public boolean execute(ComponentContext context) {
    boolean result = false;
    Connection db = null;

    try {
      // @note the db connection isn't obtained yet
      TeamMember thisMember = (TeamMember) context.getThisObject();

      //load the user who created this member record
      User user = UserUtils.loadUser(thisMember.getEnteredBy());
      Project userProfile = ProjectUtils.loadProject(user.getProfileProjectId());

      //load the user that is being invited
      User member = UserUtils.loadUser(thisMember.getUserId());
      Project memberProfile = ProjectUtils.loadProject(member.getProfileProjectId());
      if (memberProfile == null) {
        throw new Exception("Member doesn't have a profile for recording history; skipping");
      }

      //load the project profile
      Project projectProfile = ProjectUtils.loadProject(thisMember.getProjectId());

      // Use the database connection since everything is now ready...
      db = getConnection(context);

      if (thisMember.getStatus() == TeamMember.STATUS_PENDING) {
        // Prepare the wiki links
        context.setParameter("user", WikiLink.generateLink(userProfile));
        context.setParameter("member", WikiLink.generateLink(memberProfile));
        context.setParameter("profile", WikiLink.generateLink(projectProfile));

        // Insert the history
        ProjectHistory history = new ProjectHistory();
        history.setEnteredBy(user.getId());
        history.setProjectId(thisMember.getProjectId());
        history.setLinkObject(ProjectHistoryList.INVITES_OBJECT);
        history.setEventType(ProjectHistoryList.INVITE_MEMBER_EVENT);
        history.setLinkItemId(thisMember.getId());
        history.setDescription(context.getParameter(HISTORY_INVITE_TEXT));
        history.insert(db);
      } else if (thisMember.getStatus() == TeamMember.STATUS_ADDED) {
        // user joined a particular project

        // Prepare the wiki links
        context.setParameter("member", WikiLink.generateLink(memberProfile));
        context.setParameter("profile", WikiLink.generateLink(projectProfile));

        // Insert the history
        ProjectHistory history = new ProjectHistory();
        history.setEnteredBy(member.getId());
        history.setProjectId(thisMember.getProjectId());
        history.setLinkObject(ProjectHistoryList.MEMBER_OBJECT);
        history.setEventType(ProjectHistoryList.BECOME_PROFILE_FAN_EVENT);
        history.setLinkItemId(thisMember.getId());
        if (projectProfile.getProfile()) {
          // This is a friend request
          history.setDescription(context.getParameter(HISTORY_FRIEND_TEXT));
        } else {
          // This is everything else
          history.setDescription(context.getParameter(HISTORY_FAN_TEXT));
        }
        history.insert(db);
      }
      result = true;
    } catch (Exception e) {
      LOG.warn("Save error", e);
    } finally {
      freeConnection(context, db);
    }
    return result;
  }
}