NavigationUtils.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.mop.operations.navigation;

import org.exoplatform.portal.config.model.I18NString;
import org.exoplatform.portal.config.model.LocalizedString;
import org.exoplatform.portal.config.model.NavigationFragment;
import org.exoplatform.portal.config.model.PageNavigation;
import org.exoplatform.portal.config.model.PageNode;
import org.exoplatform.portal.mop.Described;
import org.exoplatform.portal.mop.description.DescriptionService;
import org.exoplatform.portal.mop.navigation.GenericScope;
import org.exoplatform.portal.mop.navigation.NavigationContext;
import org.exoplatform.portal.mop.navigation.NavigationService;
import org.exoplatform.portal.mop.navigation.NodeContext;
import org.exoplatform.portal.mop.navigation.NodeModel;
import org.exoplatform.portal.mop.navigation.Scope;

import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import java.util.Locale;
import java.util.Map;

/**
 * The Class NavigationUtils.
 *
 * @author <a href="mailto:nscavell@redhat.com">Nick Scavelli</a>
 * @version $Revision$
 */
public class NavigationUtils {
  
  /**
   * Instantiates a new navigation utils.
   */
  private NavigationUtils() {}

  /**
   * Load page navigation.
   *
   * @param key the key
   * @param navigationService the navigation service
   * @param descriptionService the description service
   * @return the page navigation
   */
  public static PageNavigation loadPageNavigation(NavigationKey key, NavigationService navigationService, DescriptionService descriptionService) {
    NavigationContext navigation = navigationService.loadNavigation(key.getSiteKey());
    if (navigation == null)
      return null;

    NodeContext<NodeContext<?>> node = loadNode(navigationService, navigation, key.getNavUri());
    if (node == null)
      return null;

    if (key.getNavUri() != null) {
      return createFragmentedPageNavigation(descriptionService, navigation, node);
    } else {
      return createPageNavigation(descriptionService, navigation, node);
    }
  }

  /**
   * Load node.
   *
   * @param navigationService the navigation service
   * @param navigation the navigation
   * @param navUri the nav uri
   * @return the node context
   */
  public static NodeContext<NodeContext<?>> loadNode(NavigationService navigationService, NavigationContext navigation, String navUri) {
    if (navigation == null)
      return null;

    if (navUri != null) {
      String[] path = trim(navUri.split("/"));
      NodeContext<NodeContext<?>> node = navigationService.loadNode(NodeModel.SELF_MODEL, navigation, GenericScope.branchShape(path, Scope.ALL), null);
      for (String name : path) {
        node = node.get(name);
        if (node == null)
          break;
      }

      return node;
    } else {
      return navigationService.loadNode(NodeModel.SELF_MODEL, navigation, Scope.ALL, null);
    }
  }

  /**
   * Creates the page navigation.
   *
   * @param service the service
   * @param navigation the navigation
   * @param node the node
   * @return the page navigation
   */
  public static PageNavigation createPageNavigation(DescriptionService service, NavigationContext navigation, NodeContext<NodeContext<?>> node) {
    PageNavigation pageNavigation = new PageNavigation();
    pageNavigation.setPriority(navigation.getState().getPriority());
    pageNavigation.setOwnerType(navigation.getKey().getTypeName());
    pageNavigation.setOwnerId(navigation.getKey().getName());

    ArrayList<PageNode> children = new ArrayList<PageNode>(node.getNodeCount());
    for (NodeContext<?> child : node.getNodes()) {
      @SuppressWarnings("unchecked")
      NodeContext<NodeContext<?>> childNode = (NodeContext<NodeContext<?>>) child;
      children.add(createPageNode(service, childNode));
    }

    NavigationFragment fragment = new NavigationFragment();
    fragment.setNodes(children);
    pageNavigation.addFragment(fragment);

    return pageNavigation;
  }

  /**
   * Creates the fragmented page navigation.
   *
   * @param service the service
   * @param navigation the navigation
   * @param node the node
   * @return the page navigation
   */
  private static PageNavigation createFragmentedPageNavigation(DescriptionService service, NavigationContext navigation, NodeContext<NodeContext<?>> node) {
    PageNavigation pageNavigation = new PageNavigation();
    pageNavigation.setPriority(navigation.getState().getPriority());
    pageNavigation.setOwnerType(navigation.getKey().getTypeName());
    pageNavigation.setOwnerId(navigation.getKey().getName());

    ArrayList<PageNode> children = new ArrayList<PageNode>(1);
    children.add(createPageNode(service, node));

    NavigationFragment fragment = new NavigationFragment();
    StringBuilder parentUri = new StringBuilder("");
    getPath(node.getParent(), parentUri);
    fragment.setParentURI(parentUri.toString());
    fragment.setNodes(children);

    pageNavigation.addFragment(fragment);

    return pageNavigation;
  }

  /**
   * Gets the path.
   *
   * @param node the node
   * @param parentUri the parent uri
   */
  private static void getPath(NodeContext<NodeContext<?>> node, StringBuilder parentUri) {
    if (node == null)
      return;
    if (node.getParent() == null)
      return; // since "default" is the root node, we ignore it

    parentUri.insert(0, node.getName()).insert(0, "/");
    getPath(node.getParent(), parentUri);
  }

  /**
   * Creates the page node.
   *
   * @param service the service
   * @param node the node
   * @return the page node
   */
  private static PageNode createPageNode(DescriptionService service, NodeContext<NodeContext<?>> node) {
    PageNode pageNode = new PageNode();
    pageNode.setName(node.getName());

    if (node.getState().getLabel() == null) {
      Map<Locale, Described.State> descriptions = service.getDescriptions(node.getId());
      if (descriptions != null && !descriptions.isEmpty()) {
        I18NString labels = new I18NString();
        for (Map.Entry<Locale, Described.State> entry : descriptions.entrySet()) {
          labels.add(new LocalizedString(entry.getValue().getName(), entry.getKey()));
        }

        pageNode.setLabels(labels);
      }
    } else {
      pageNode.setLabel(node.getState().getLabel());
    }

    pageNode.setIcon(node.getState().getIcon());
    long startPublicationTime = node.getState().getStartPublicationTime();
    if (startPublicationTime != -1) {
      pageNode.setStartPublicationDate(new Date(startPublicationTime));
    }

    long endPublicationTime = node.getState().getEndPublicationTime();
    if (endPublicationTime != -1) {
      pageNode.setEndPublicationDate(new Date(endPublicationTime));
    }

    pageNode.setVisibility(node.getState().getVisibility());
    pageNode.setPageReference(node.getState().getPageRef() != null ? node.getState().getPageRef().format() : null);

    if (node.getNodes() != null) {
      ArrayList<PageNode> children = new ArrayList<PageNode>(node.getNodeCount());
      for (NodeContext<?> child : node.getNodes()) {
        @SuppressWarnings("unchecked")
        NodeContext<NodeContext<?>> childNode = (NodeContext<NodeContext<?>>) child;
        children.add(createPageNode(service, childNode));
      }

      pageNode.setChildren(children);
    } else {
      pageNode.setChildren(new ArrayList<PageNode>(0));
    }

    return pageNode;
  }

  /**
   * Trim.
   *
   * @param array the array
   * @return the string[]
   */
  private static String[] trim(String[] array) {
    List<String> trimmed = new ArrayList<String>(array.length);
    for (String s : array) {
      if (s != null && !"".equals(s)) {
        trimmed.add(s);
      }
    }

    return trimmed.toArray(new String[trimmed.size()]);
  }
}