ForumDataExportResource.java

/*
 * Copyright (C) 2003-2017 eXo Platform SAS.
 *
 * This 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 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software 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 software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.exoplatform.management.forum.operations;

import org.apache.commons.lang.ArrayUtils;
import org.apache.commons.lang.StringUtils;
import org.exoplatform.forum.common.jcr.KSDataLocation;
import org.exoplatform.forum.service.Category;
import org.exoplatform.forum.service.Forum;
import org.exoplatform.forum.service.ForumService;
import org.exoplatform.forum.service.Topic;
import org.exoplatform.forum.service.Utils;
import org.exoplatform.management.common.exportop.AbstractJCRExportOperationHandler;
import org.exoplatform.management.common.exportop.ActivityExportOperationInterface;
import org.exoplatform.management.common.exportop.JCRNodeExportTask;
import org.exoplatform.management.common.exportop.SpaceMetadataExportTask;
import org.exoplatform.management.forum.ForumExtension;
import org.exoplatform.poll.service.Poll;
import org.exoplatform.poll.service.PollService;
import org.exoplatform.services.jcr.RepositoryService;
import org.exoplatform.social.core.activity.model.ExoSocialActivity;
import org.exoplatform.social.core.manager.ActivityManager;
import org.exoplatform.social.core.manager.IdentityManager;
import org.exoplatform.social.core.space.SpaceUtils;
import org.exoplatform.social.core.space.model.Space;
import org.exoplatform.social.core.space.spi.SpaceService;
import org.exoplatform.social.core.storage.api.IdentityStorage;
import org.gatein.common.logging.Logger;
import org.gatein.common.logging.LoggerFactory;
import org.gatein.management.api.exceptions.OperationException;
import org.gatein.management.api.exceptions.ResourceNotFoundException;
import org.gatein.management.api.operation.OperationContext;
import org.gatein.management.api.operation.OperationNames;
import org.gatein.management.api.operation.ResultHandler;
import org.gatein.management.api.operation.model.ExportResourceModel;
import org.gatein.management.api.operation.model.ExportTask;

import java.util.ArrayList;
import java.util.List;

import javax.jcr.Node;
import javax.jcr.Session;

/**
 * The Class ForumDataExportResource.
 *
 * @author <a href="mailto:bkhanfir@exoplatform.com">Boubaker Khanfir</a>
 * @version $Revision$
 */
public class ForumDataExportResource extends AbstractJCRExportOperationHandler implements ActivityExportOperationInterface {

  /** The Constant log. */
  final private static Logger log = LoggerFactory.getLogger(ForumDataExportResource.class);

  /** The forum service. */
  private ForumService forumService;
  
  /** The poll service. */
  private PollService pollService;
  
  /** The data location. */
  private KSDataLocation dataLocation;

  /** The is space forum type. */
  private boolean isSpaceForumType;
  
  /** The type. */
  private String type;
  
  /** The form id thread local. */
  private ThreadLocal<String> formIdThreadLocal = new ThreadLocal<String>();

  /**
   * Instantiates a new forum data export resource.
   *
   * @param isSpaceForumType the is space forum type
   */
  public ForumDataExportResource(boolean isSpaceForumType) {
    this.isSpaceForumType = isSpaceForumType;
    this.type = isSpaceForumType ? ForumExtension.SPACE_FORUM_TYPE : ForumExtension.PUBLIC_FORUM_TYPE;
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public void execute(OperationContext operationContext, ResultHandler resultHandler) throws ResourceNotFoundException, OperationException {
    spaceService = operationContext.getRuntimeContext().getRuntimeComponent(SpaceService.class);
    forumService = operationContext.getRuntimeContext().getRuntimeComponent(ForumService.class);
    pollService = operationContext.getRuntimeContext().getRuntimeComponent(PollService.class);
    repositoryService = operationContext.getRuntimeContext().getRuntimeComponent(RepositoryService.class);
    dataLocation = operationContext.getRuntimeContext().getRuntimeComponent(KSDataLocation.class);
    activityManager = operationContext.getRuntimeContext().getRuntimeComponent(ActivityManager.class);
    identityManager = operationContext.getRuntimeContext().getRuntimeComponent(IdentityManager.class);
    identityStorage = operationContext.getRuntimeContext().getRuntimeComponent(IdentityStorage.class);

    String name = operationContext.getAttributes().getValue("filter");
    if(StringUtils.isEmpty(name)) {
      name = operationContext.getAddress().resolvePathTemplate("name");
    }

    increaseCurrentTransactionTimeOut(operationContext);
    try {
      String excludeSpaceMetadataString = operationContext.getAttributes().getValue("exclude-space-metadata");
      boolean exportSpaceMetadata = excludeSpaceMetadataString == null || excludeSpaceMetadataString.trim().equalsIgnoreCase("false");

      List<ExportTask> exportTasks = new ArrayList<ExportTask>();

      Category spaceCategory = forumService.getCategoryIncludedSpace();
      String workspace = dataLocation.getWorkspace();
      String categoryHomePath = dataLocation.getForumCategoriesLocation();

      if (StringUtils.isEmpty(name)) {
        log.info("Exporting all Forums of type: " + (isSpaceForumType ? "Spaces" : "Non Spaces"));
        List<Category> categories = forumService.getCategories();
        for (Category category : categories) {
          if (spaceCategory != null && category.getId().equals(spaceCategory.getId())) {
            continue;
          }
          exportForum(exportTasks, workspace, categoryHomePath, category.getId(), null, exportSpaceMetadata);
        }
      } else {
        if (isSpaceForumType) {
          if (spaceCategory != null) {
            Space space = spaceService.getSpaceByDisplayName(name);
            exportForum(exportTasks, workspace, categoryHomePath, spaceCategory.getId(), space.getPrettyName(), exportSpaceMetadata);
          }
        } else {
          List<Category> categories = forumService.getCategories();
          for (Category category : categories) {
            if (!category.getCategoryName().equals(name)) {
              continue;
            }
            exportForum(exportTasks, workspace, categoryHomePath, category.getId(), null, exportSpaceMetadata);
          }
        }
      }
      resultHandler.completed(new ExportResourceModel(exportTasks));
    } finally {
      restoreDefaultTransactionTimeOut(operationContext);
    }
  }

  /**
   * {@inheritDoc}
   */
  @Override
  protected void addJCRNodeExportTask(Node childNode, List<ExportTask> subNodesExportTask, boolean recursive, String... params) {
    if (params.length != 4) {
      log.warn("Cannot add Forum Export Task, 4 parameters was expected, got: " + ArrayUtils.toString(params));
      return;
    }
    String entryPath = "forum/" + type + "/" + (params[2] == null || params[2].isEmpty() ? params[1] : params[2]);
    JCRNodeExportTask exportTask = new JCRNodeExportTask(repositoryService, params[0], params[3], entryPath, recursive, true);
    subNodesExportTask.add(exportTask);
  }

  /**
   * Export forum.
   *
   * @param exportTasks the export tasks
   * @param workspace the workspace
   * @param categoryHomePath the category home path
   * @param categoryId the category id
   * @param spacePrettyName the space pretty name
   * @param exportSpaceMetadata the export space metadata
   */
  private void exportForum(List<ExportTask> exportTasks, String workspace, String categoryHomePath, String categoryId, String spacePrettyName, boolean exportSpaceMetadata) {
    try {
      String forumId = (spacePrettyName == null ? "" : Utils.FORUM_SPACE_ID_PREFIX + spacePrettyName);
      if (isSpaceForumType) {
        Space space = spaceService.getSpaceByPrettyName(spacePrettyName);
        spacePrettyName = space.getGroupId().replace(SpaceUtils.SPACE_GROUP + "/", "");

        forumId = Utils.FORUM_SPACE_ID_PREFIX + spacePrettyName;
        if (exportSpaceMetadata) {
          String prefix = "forum/space/" + forumId + "/";
          exportTasks.add(new SpaceMetadataExportTask(space, prefix));
        }
      }

      String parentNodePath = "/" + categoryHomePath + "/" + categoryId + (forumId.isEmpty() ? "" : "/" + forumId);
      Session session = getSession(workspace);
      Node parentNode = (Node) session.getItem(parentNodePath);
      exportNode(parentNode, exportTasks, workspace, categoryId, forumId);

      // export Activities
      String prefix = "forum/" + type + "/" + ((forumId == null || forumId.isEmpty()) ? categoryId : forumId);
      if (isSpaceForumType) {
        categoryId = forumService.getCategoryIncludedSpace().getId();
        Forum forum = forumService.getForum(categoryId, forumId);
        formIdThreadLocal.set(forum.getId());
        exportActivities(exportTasks, StringUtils.isEmpty(spacePrettyName) ? ((forum.getModerators() != null && forum.getModerators().length > 0) ? forum.getModerators()[0] : forum.getOwner())
            : spacePrettyName, prefix, FORUM_ACTIVITY_TYPE, POLL_ACTIVITY_TYPE);
      } else {
        @SuppressWarnings("deprecation")
        List<Forum> forums = forumService.getForums(categoryId, null);
        for (Forum forum : forums) {
          exportActivities(exportTasks, StringUtils.isEmpty(spacePrettyName) ? ((forum.getModerators() != null && forum.getModerators().length > 0) ? forum.getModerators()[0] : forum.getOwner())
              : spacePrettyName, prefix, FORUM_ACTIVITY_TYPE, POLL_ACTIVITY_TYPE);
        }
      }

    } catch (Exception exception) {
      throw new OperationException(OperationNames.EXPORT_RESOURCE, "Error while exporting forum", exception);
    }
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public boolean isActivityValid(ExoSocialActivity activity) throws Exception {
    if (activity.isComment()) {
      return true;
    }
    String originalForumId = formIdThreadLocal.get();
    if (activity.getTemplateParams().containsKey("PollLink")) {
      String topicId = activity.getTemplateParams().get("Id");
      if (topicId == null) {
        log.warn("Poll with null id of topic. Cannot import activity '" + activity.getTitle() + "'.");
        return false;
      }
      String pollId = topicId.replace(Utils.TOPIC, Utils.POLL);
      Poll poll = pollService.getPoll(pollId);
      if (poll == null) {
        log.warn("Poll not found. Cannot import activity '" + activity.getTitle() + "'.");
        return false;
      }
      String forumId = poll.getParentPath().substring(0, poll.getParentPath().indexOf("/topic"));
      forumId = forumId.substring(forumId.lastIndexOf("/") + 1);
      return forumId.equals(originalForumId);
    }
    String catId = activity.getTemplateParams().get("CateId");
    if (catId == null) {
      return true;
    } else {
      String forumId = activity.getTemplateParams().get("ForumId");
      String topicId = activity.getTemplateParams().get("TopicId");
      if (forumId == null || topicId == null) {
        log.warn("Activity template params are inconsistent: '" + activity.getTitle() + "'.");
        return false;
      }
      if (!forumId.equals(originalForumId)) {
        return false;
      }
      Topic topic = forumService.getTopic(catId, forumId, topicId, null);
      if (topic == null) {
        log.warn("Forum Topic not found. Cannot import activity '" + activity.getTitle() + "'.");
        return false;
      }
    }
    return true;
  }
}