com.liferay.knowledgebase.util.KBNavigationDisplayContext.java Source code

Introduction

Here is the source code for com.liferay.knowledgebase.util.KBNavigationDisplayContext.java

Source

/**
 * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
 *
 * This library 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 library 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.
 */

package com.liferay.knowledgebase.util;

import com.liferay.knowledgebase.model.KBArticle;
import com.liferay.knowledgebase.model.KBFolder;
import com.liferay.knowledgebase.model.KBFolderConstants;
import com.liferay.knowledgebase.service.KBArticleLocalServiceUtil;
import com.liferay.knowledgebase.service.KBFolderServiceUtil;
import com.liferay.portal.kernel.exception.PortalException;
import com.liferay.portal.kernel.util.GetterUtil;
import com.liferay.portal.kernel.workflow.WorkflowConstants;
import com.liferay.portal.util.PortalUtil;
import com.liferay.portlet.PortalPreferences;

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

import javax.portlet.PortletPreferences;
import javax.portlet.PortletRequest;

/**
 * @author Adolfo Prez
 */
public class KBNavigationDisplayContext {

    public KBNavigationDisplayContext(PortletRequest portletRequest, PortalPreferences portalPreferences,
            PortletPreferences portletPreferences, KBArticle kbArticle) {

        _portletRequest = portletRequest;
        _portalPreferences = portalPreferences;
        _portletPreferences = portletPreferences;
        _kbArticle = kbArticle;
    }

    public List<Long> getAncestorResourcePrimaryKeys() throws PortalException {
        List<Long> ancestorResourcePrimaryKeys = new ArrayList<>();

        if (_kbArticle != null) {
            KBArticle latestKBArticle = KBArticleLocalServiceUtil
                    .getLatestKBArticle(_kbArticle.getResourcePrimKey(), WorkflowConstants.STATUS_APPROVED);

            ancestorResourcePrimaryKeys = latestKBArticle.getAncestorResourcePrimaryKeys();

            Collections.reverse(ancestorResourcePrimaryKeys);
        } else {
            ancestorResourcePrimaryKeys.add(KBFolderConstants.DEFAULT_PARENT_FOLDER_ID);
        }

        return ancestorResourcePrimaryKeys;
    }

    public String getCurrentKBFolderURLTitle() throws PortalException {
        String currentKBFolderURLTitle = KnowledgeBaseUtil.getPreferredKBFolderURLTitle(_portalPreferences,
                getContentRootPrefix());

        long rootResourcePrimKey = getRootResourcePrimKey();

        if (rootResourcePrimKey != KBFolderConstants.DEFAULT_PARENT_FOLDER_ID) {
            KBFolder kbFolder = KBFolderServiceUtil.getKBFolder(rootResourcePrimKey);

            currentKBFolderURLTitle = kbFolder.getUrlTitle();
        }

        return currentKBFolderURLTitle;
    }

    public String getPageTitle() throws PortalException {
        long rootResourcePrimKey = getRootResourcePrimKey();

        String pageTitle = null;

        if (rootResourcePrimKey != KBFolderConstants.DEFAULT_PARENT_FOLDER_ID) {
            KBFolder kbFolder = KBFolderServiceUtil.getKBFolder(rootResourcePrimKey);

            pageTitle = getContentRootPrefix() + " " + kbFolder.getName();

            if (_kbArticle != null) {
                pageTitle = _kbArticle.getTitle() + " - " + pageTitle;
            }
        } else {
            if (_kbArticle != null) {
                pageTitle = _kbArticle.getTitle();
            }
        }

        return pageTitle;
    }

    public long getRootResourcePrimKey() throws PortalException {
        if (_rootResourcePrimKey == null) {
            _rootResourcePrimKey = KBFolderConstants.DEFAULT_PARENT_FOLDER_ID;

            if (_kbArticle != null) {
                _rootResourcePrimKey = KnowledgeBaseUtil.getKBFolderId(_kbArticle.getParentResourceClassNameId(),
                        _kbArticle.getParentResourcePrimKey());
            }

            if (_rootResourcePrimKey == KBFolderConstants.DEFAULT_PARENT_FOLDER_ID) {

                _rootResourcePrimKey = KnowledgeBaseUtil.getRootResourcePrimKey(_portletRequest,
                        PortalUtil.getScopeGroupId(_portletRequest), getResourceClassNameId(),
                        getResourcePrimKey());
            }
        }

        return _rootResourcePrimKey;
    }

    public boolean isLeftNavigationVisible() throws PortalException {
        if (_leftNavigationVisible == null) {
            _leftNavigationVisible = hasMultipleDescendantKBArticles();
        }

        return _leftNavigationVisible;
    }

    public boolean isTopNavigationVisible() throws PortalException {
        long kbFolderClassNameId = PortalUtil.getClassNameId(KBFolderConstants.getClassName());

        if ((getResourceClassNameId() == kbFolderClassNameId) && !isLeftNavigationVisible()) {

            return true;
        }

        return false;
    }

    protected String getContentRootPrefix() {
        return GetterUtil.getString(_portletPreferences.getValue("contentRootPrefix", null));
    }

    protected long getResourceClassNameId() {
        if (_resourceClassNameId == null) {
            _resourceClassNameId = GetterUtil.getLong(_portletPreferences.getValue("resourceClassNameId", null),
                    PortalUtil.getClassNameId(KBFolderConstants.getClassName()));
        }

        return _resourceClassNameId;
    }

    protected long getResourcePrimKey() {
        if (_resourcePrimKey == null) {
            _resourcePrimKey = GetterUtil.getLong(_portletPreferences.getValue("resourcePrimKey", null));
        }

        return _resourcePrimKey;
    }

    protected boolean hasMultipleDescendantKBArticles() throws PortalException {
        long scopeGroupId = PortalUtil.getScopeGroupId(_portletRequest);

        long kbFolderClassNameId = PortalUtil.getClassNameId(KBFolderConstants.getClassName());

        if (getResourceClassNameId() == kbFolderClassNameId) {
            List<KBFolder> kbFolders = KnowledgeBaseUtil.getAlternateRootKBFolders(scopeGroupId,
                    getResourcePrimKey());

            if (kbFolders.size() > 1) {
                int maxKBArticlesCount = 0;

                for (KBFolder kbFolder : kbFolders) {
                    int kbArticlesCount = KBArticleLocalServiceUtil.getKBFolderKBArticlesCount(scopeGroupId,
                            kbFolder.getKbFolderId(), WorkflowConstants.STATUS_APPROVED);

                    if (kbArticlesCount > maxKBArticlesCount) {
                        maxKBArticlesCount = kbArticlesCount;
                    }
                }

                if (maxKBArticlesCount > 1) {
                    return true;
                }

                return false;
            }
        }

        boolean showNavigation = true;

        long rootResourcePrimKey = getRootResourcePrimKey();

        int kbArticlesCount = KBArticleLocalServiceUtil.getKBArticlesCount(scopeGroupId, rootResourcePrimKey,
                WorkflowConstants.STATUS_APPROVED);

        if (kbArticlesCount == 0) {
            showNavigation = false;
        } else if (kbArticlesCount == 1) {
            List<KBArticle> kbArticles = KBArticleLocalServiceUtil.getKBArticles(scopeGroupId, rootResourcePrimKey,
                    WorkflowConstants.STATUS_APPROVED, 0, 1, null);

            KBArticle navigationKBArticle = kbArticles.get(0);

            int navigationKBArticleChildCount = KBArticleLocalServiceUtil.getKBArticlesCount(scopeGroupId,
                    navigationKBArticle.getResourcePrimKey(), WorkflowConstants.STATUS_APPROVED);

            if (navigationKBArticleChildCount == 0) {
                showNavigation = false;
            }
        }

        return showNavigation;
    }

    private final KBArticle _kbArticle;
    private Boolean _leftNavigationVisible;
    private final PortalPreferences _portalPreferences;
    private final PortletPreferences _portletPreferences;
    private final PortletRequest _portletRequest;
    private Long _resourceClassNameId;
    private Long _resourcePrimKey;
    private Long _rootResourcePrimKey;

}