com.liferay.wiki.web.internal.portlet.action.ActionUtil Maven / Gradle / Ivy
/**
* SPDX-FileCopyrightText: (c) 2000 Liferay, Inc. https://liferay.com
* SPDX-License-Identifier: LGPL-2.1-or-later OR LicenseRef-Liferay-DXP-EULA-2.0.0-2023-06
*/
package com.liferay.wiki.web.internal.portlet.action;
import com.liferay.petra.lang.SafeCloseable;
import com.liferay.portal.configuration.module.configuration.ConfigurationProviderUtil;
import com.liferay.portal.kernel.change.tracking.CTCollectionThreadLocal;
import com.liferay.portal.kernel.exception.PortalException;
import com.liferay.portal.kernel.log.Log;
import com.liferay.portal.kernel.log.LogFactoryUtil;
import com.liferay.portal.kernel.model.Group;
import com.liferay.portal.kernel.model.Layout;
import com.liferay.portal.kernel.portlet.LiferayPortletResponse;
import com.liferay.portal.kernel.portlet.url.builder.PortletURLBuilder;
import com.liferay.portal.kernel.security.auth.PrincipalException;
import com.liferay.portal.kernel.security.permission.ActionKeys;
import com.liferay.portal.kernel.security.permission.PermissionChecker;
import com.liferay.portal.kernel.service.GroupLocalServiceUtil;
import com.liferay.portal.kernel.service.ServiceContext;
import com.liferay.portal.kernel.service.ServiceContextFactory;
import com.liferay.portal.kernel.servlet.SessionErrors;
import com.liferay.portal.kernel.settings.PortletInstanceSettingsLocator;
import com.liferay.portal.kernel.theme.PortletDisplay;
import com.liferay.portal.kernel.theme.ThemeDisplay;
import com.liferay.portal.kernel.util.ParamUtil;
import com.liferay.portal.kernel.util.PortalUtil;
import com.liferay.portal.kernel.util.Validator;
import com.liferay.portal.kernel.util.WebKeys;
import com.liferay.portal.kernel.workflow.WorkflowThreadLocal;
import com.liferay.wiki.configuration.WikiGroupServiceConfiguration;
import com.liferay.wiki.constants.WikiPageConstants;
import com.liferay.wiki.constants.WikiWebKeys;
import com.liferay.wiki.engine.WikiEngineRenderer;
import com.liferay.wiki.exception.NoSuchNodeException;
import com.liferay.wiki.exception.NoSuchPageException;
import com.liferay.wiki.model.WikiNode;
import com.liferay.wiki.model.WikiPage;
import com.liferay.wiki.service.WikiNodeLocalServiceUtil;
import com.liferay.wiki.service.WikiNodeServiceUtil;
import com.liferay.wiki.service.WikiPageLocalServiceUtil;
import com.liferay.wiki.service.WikiPageServiceUtil;
import com.liferay.wiki.web.internal.configuration.WikiPortletInstanceConfiguration;
import com.liferay.wiki.web.internal.security.permission.resource.WikiNodePermission;
import com.liferay.wiki.web.internal.util.WikiUtil;
import com.liferay.wiki.web.internal.util.WikiWebComponentProvider;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import javax.portlet.PortletException;
import javax.portlet.PortletRequest;
import javax.portlet.PortletResponse;
import javax.portlet.PortletURL;
import javax.portlet.RenderRequest;
import javax.portlet.RenderResponse;
import javax.servlet.http.HttpServletRequest;
/**
* @author Brian Wing Shun Chan
* @author Jorge Ferrer
*/
public class ActionUtil {
public static void compareVersions(
RenderRequest renderRequest, RenderResponse renderResponse,
WikiEngineRenderer wikiEngineRenderer)
throws Exception {
long nodeId = ParamUtil.getLong(renderRequest, "nodeId");
String title = ParamUtil.getString(renderRequest, "title");
double sourceVersion = ParamUtil.getDouble(
renderRequest, "sourceVersion");
double targetVersion = ParamUtil.getDouble(
renderRequest, "targetVersion");
String htmlDiffResult = getHtmlDiffResult(
sourceVersion, targetVersion, renderRequest, renderResponse,
wikiEngineRenderer);
renderRequest.setAttribute(WebKeys.DIFF_HTML_RESULTS, htmlDiffResult);
renderRequest.setAttribute(WebKeys.SOURCE_VERSION, sourceVersion);
renderRequest.setAttribute(WebKeys.TARGET_VERSION, targetVersion);
renderRequest.setAttribute(WebKeys.TITLE, title);
renderRequest.setAttribute(WikiWebKeys.WIKI_NODE_ID, nodeId);
}
public static WikiNode getFirstNode(PortletRequest portletRequest)
throws PortalException {
ThemeDisplay themeDisplay = (ThemeDisplay)portletRequest.getAttribute(
WebKeys.THEME_DISPLAY);
long groupId = themeDisplay.getScopeGroupId();
PermissionChecker permissionChecker =
themeDisplay.getPermissionChecker();
List nodes = WikiNodeLocalServiceUtil.getNodes(groupId);
PortletDisplay portletDisplay = themeDisplay.getPortletDisplay();
WikiPortletInstanceConfiguration wikiPortletInstanceConfiguration =
ConfigurationProviderUtil.getConfiguration(
WikiPortletInstanceConfiguration.class,
new PortletInstanceSettingsLocator(
themeDisplay.getLayout(), portletDisplay.getId()));
String[] visibleNodeNames =
wikiPortletInstanceConfiguration.visibleNodes();
nodes = WikiUtil.orderNodes(nodes, visibleNodeNames);
String[] hiddenNodes = wikiPortletInstanceConfiguration.hiddenNodes();
Arrays.sort(hiddenNodes);
for (WikiNode node : nodes) {
if ((Arrays.binarySearch(hiddenNodes, node.getName()) < 0) &&
WikiNodePermission.contains(
permissionChecker, node, ActionKeys.VIEW)) {
return node;
}
}
return null;
}
public static WikiNode getFirstVisibleNode(PortletRequest portletRequest)
throws PortalException {
ThemeDisplay themeDisplay = (ThemeDisplay)portletRequest.getAttribute(
WebKeys.THEME_DISPLAY);
WikiNode node = null;
int nodesCount = WikiNodeLocalServiceUtil.getNodesCount(
themeDisplay.getScopeGroupId());
if (nodesCount == 0) {
Group group = GroupLocalServiceUtil.fetchGroup(
themeDisplay.getScopeGroupId());
ServiceContext serviceContext = ServiceContextFactory.getInstance(
WikiNode.class.getName(), portletRequest);
serviceContext.setAddGroupPermissions(true);
Layout layout = themeDisplay.getLayout();
if (layout.isPublicLayout() || layout.isTypeControlPanel()) {
serviceContext.setAddGuestPermissions(true);
}
else {
serviceContext.setAddGuestPermissions(false);
}
try (SafeCloseable safeCloseable =
CTCollectionThreadLocal.setCTCollectionIdWithSafeCloseable(
group.getCtCollectionId())) {
node = WikiNodeLocalServiceUtil.addDefaultNode(
themeDisplay.getGuestUserId(), serviceContext);
}
}
else {
node = getFirstNode(portletRequest);
if (node == null) {
throw new PrincipalException();
}
return node;
}
return node;
}
public static WikiPage getFirstVisiblePage(
long nodeId, PortletRequest portletRequest)
throws PortalException {
WikiWebComponentProvider wikiWebComponentProvider =
WikiWebComponentProvider.getWikiWebComponentProvider();
WikiGroupServiceConfiguration wikiGroupServiceConfiguration =
wikiWebComponentProvider.getWikiGroupServiceConfiguration();
WikiPage page = WikiPageLocalServiceUtil.fetchPage(
nodeId, wikiGroupServiceConfiguration.frontPageName(), 0);
if (page == null) {
WikiNode node = WikiNodeLocalServiceUtil.getNode(nodeId);
ThemeDisplay themeDisplay =
(ThemeDisplay)portletRequest.getAttribute(
WebKeys.THEME_DISPLAY);
ServiceContext serviceContext = ServiceContextFactory.getInstance(
WikiPage.class.getName(), portletRequest);
serviceContext.setAddGroupPermissions(true);
serviceContext.setAddGuestPermissions(true);
boolean workflowEnabled = WorkflowThreadLocal.isEnabled();
try (SafeCloseable safeCloseable =
CTCollectionThreadLocal.setCTCollectionIdWithSafeCloseable(
node.getCtCollectionId())) {
WorkflowThreadLocal.setEnabled(false);
page = WikiPageLocalServiceUtil.addPage(
themeDisplay.getGuestUserId(), nodeId,
wikiGroupServiceConfiguration.frontPageName(), null,
WikiPageConstants.NEW, true, serviceContext);
}
finally {
WorkflowThreadLocal.setEnabled(workflowEnabled);
}
}
return page;
}
public static String getHtmlDiffResult(
double sourceVersion, double targetVersion,
PortletRequest portletRequest, PortletResponse portletResponse,
WikiEngineRenderer wikiEngineRenderer)
throws Exception {
ThemeDisplay themeDisplay = (ThemeDisplay)portletRequest.getAttribute(
WebKeys.THEME_DISPLAY);
long nodeId = ParamUtil.getLong(portletRequest, "nodeId");
String title = ParamUtil.getString(portletRequest, "title");
WikiPage sourcePage = WikiPageServiceUtil.getPage(
nodeId, title, sourceVersion);
WikiPage targetPage = WikiPageServiceUtil.getPage(
nodeId, title, targetVersion);
LiferayPortletResponse liferayPortletResponse =
PortalUtil.getLiferayPortletResponse(portletResponse);
PortletURL viewPageURL = PortletURLBuilder.createRenderURL(
liferayPortletResponse
).setMVCRenderCommandName(
"wiki/view"
).setParameter(
"nodeName",
() -> {
WikiNode sourceNode = sourcePage.getNode();
return sourceNode.getName();
}
).buildPortletURL();
return wikiEngineRenderer.diffHtml(
sourcePage, targetPage, viewPageURL,
PortletURLBuilder.createRenderURL(
liferayPortletResponse
).setMVCRenderCommandName(
"wiki/edit_page"
).setParameter(
"nodeId", nodeId
).setParameter(
"title", title
).buildPortletURL(),
WikiUtil.getAttachmentURLPrefix(
themeDisplay.getPathMain(), themeDisplay.getPlid(), nodeId,
title));
}
public static WikiNode getNode(PortletRequest portletRequest)
throws Exception {
WikiNode node = null;
long nodeId = ParamUtil.getLong(portletRequest, "nodeId");
String nodeName = ParamUtil.getString(portletRequest, "nodeName");
try {
if (nodeId > 0) {
node = WikiNodeServiceUtil.getNode(nodeId);
}
else if (Validator.isNotNull(nodeName)) {
HttpServletRequest httpServletRequest =
PortalUtil.getHttpServletRequest(portletRequest);
ThemeDisplay themeDisplay =
(ThemeDisplay)httpServletRequest.getAttribute(
WebKeys.THEME_DISPLAY);
node = WikiNodeServiceUtil.getNode(
themeDisplay.getScopeGroupId(), nodeName);
}
else {
throw new NoSuchNodeException();
}
}
catch (NoSuchNodeException noSuchNodeException) {
if (_log.isDebugEnabled()) {
_log.debug(noSuchNodeException);
}
node = getFirstVisibleNode(portletRequest);
}
return node;
}
public static List getNodes(PortletRequest portletRequest)
throws PortalException {
long[] nodeIds = ParamUtil.getLongValues(
portletRequest, "rowIdsWikiNode");
if (nodeIds.length == 0) {
return Collections.emptyList();
}
List nodes = new ArrayList<>();
for (long nodeId : nodeIds) {
if (nodeId != 0) {
nodes.add(WikiNodeServiceUtil.getNode(nodeId));
}
}
return nodes;
}
public static WikiPage getPage(PortletRequest portletRequest)
throws Exception {
HttpServletRequest httpServletRequest =
PortalUtil.getHttpServletRequest(portletRequest);
long nodeId = ParamUtil.getLong(httpServletRequest, "nodeId");
String title = ParamUtil.getString(httpServletRequest, "title");
double version = ParamUtil.getDouble(httpServletRequest, "version");
WikiNode node = null;
try {
if (nodeId > 0) {
node = WikiNodeServiceUtil.getNode(nodeId);
}
}
catch (NoSuchNodeException noSuchNodeException) {
if (_log.isDebugEnabled()) {
_log.debug(noSuchNodeException);
}
}
if (node == null) {
node = (WikiNode)httpServletRequest.getAttribute(
WikiWebKeys.WIKI_NODE);
if (node != null) {
nodeId = node.getNodeId();
}
}
WikiWebComponentProvider wikiWebComponentProvider =
WikiWebComponentProvider.getWikiWebComponentProvider();
WikiGroupServiceConfiguration wikiGroupServiceConfiguration =
wikiWebComponentProvider.getWikiGroupServiceConfiguration();
if (Validator.isNull(title)) {
title = wikiGroupServiceConfiguration.frontPageName();
}
try {
return WikiPageServiceUtil.getPage(nodeId, title, version);
}
catch (NoSuchPageException noSuchPageException) {
if (title.equals(wikiGroupServiceConfiguration.frontPageName()) &&
(version == 0)) {
return getFirstVisiblePage(nodeId, portletRequest);
}
throw noSuchPageException;
}
}
public static List getPages(PortletRequest portletRequest)
throws PortalException {
String[] titles = ParamUtil.getStringValues(
portletRequest, "rowIdsWikiPage");
if (titles.length == 0) {
return Collections.emptyList();
}
List pages = new ArrayList<>();
long nodeId = ParamUtil.getLong(portletRequest, "nodeId");
for (String title : titles) {
if (Validator.isNotNull(title)) {
pages.add(WikiPageServiceUtil.getPage(nodeId, title));
}
}
return pages;
}
public static String viewNode(
RenderRequest renderRequest, String defaultForward)
throws PortletException {
try {
WikiNode node = getNode(renderRequest);
renderRequest.setAttribute(WikiWebKeys.WIKI_NODE, node);
getFirstVisiblePage(node.getNodeId(), renderRequest);
}
catch (Exception exception) {
if (exception instanceof NoSuchNodeException ||
exception instanceof PrincipalException) {
SessionErrors.add(renderRequest, exception.getClass());
return "/wiki/error.jsp";
}
throw new PortletException(exception);
}
long categoryId = ParamUtil.getLong(renderRequest, "categoryId");
String tag = ParamUtil.getString(renderRequest, "tag");
if ((categoryId > 0) || Validator.isNotNull(tag)) {
return "/wiki/view_categorized_pages.jsp";
}
return defaultForward;
}
private static final Log _log = LogFactoryUtil.getLog(ActionUtil.class);
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy