com.liferay.wiki.web.internal.trash.WikiNodeTrashHandler.java Source code

Java tutorial

Introduction

Here is the source code for com.liferay.wiki.web.internal.trash.WikiNodeTrashHandler.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.wiki.web.internal.trash;

import com.liferay.portal.kernel.exception.PortalException;
import com.liferay.portal.kernel.model.LayoutConstants;
import com.liferay.portal.kernel.model.TrashedModel;
import com.liferay.portal.kernel.portlet.PortletURLFactoryUtil;
import com.liferay.portal.kernel.security.permission.PermissionChecker;
import com.liferay.portal.kernel.security.permission.resource.ModelResourcePermission;
import com.liferay.portal.kernel.theme.ThemeDisplay;
import com.liferay.portal.kernel.trash.TrashHandler;
import com.liferay.portal.kernel.trash.TrashRenderer;
import com.liferay.portal.kernel.util.OrderByComparator;
import com.liferay.portal.kernel.util.Portal;
import com.liferay.portal.kernel.util.Validator;
import com.liferay.portal.kernel.util.WebKeys;
import com.liferay.portal.kernel.workflow.WorkflowConstants;
import com.liferay.trash.TrashHelper;
import com.liferay.trash.kernel.exception.RestoreEntryException;
import com.liferay.trash.kernel.model.TrashEntry;
import com.liferay.wiki.constants.WikiPortletKeys;
import com.liferay.wiki.model.WikiNode;
import com.liferay.wiki.model.WikiPage;
import com.liferay.wiki.service.WikiNodeLocalService;
import com.liferay.wiki.service.WikiPageLocalService;
import com.liferay.wiki.web.internal.asset.WikiNodeTrashRenderer;

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

import javax.portlet.PortletRequest;
import javax.portlet.PortletURL;

import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.Reference;

/**
 * Implements trash handling for the wiki node entity.
 *
 * @author Eudaldo Alonso
 * @author Roberto Daz
 */
@Component(property = { "model.class.name=com.liferay.wiki.model.WikiNode" }, service = TrashHandler.class)
public class WikiNodeTrashHandler extends BaseWikiTrashHandler {

    @Override
    public void checkRestorableEntry(TrashEntry trashEntry, long containerModelId, String newName)
            throws PortalException {

        WikiNode node = _wikiNodeLocalService.getNode(trashEntry.getClassPK());

        String originalTitle = trashEntry.getTypeSettingsProperty("title");

        if (Validator.isNotNull(newName)) {
            originalTitle = newName;
        }

        WikiNode duplicateNode = _wikiNodeLocalService.fetchNode(node.getGroupId(), originalTitle);

        if (duplicateNode != null) {
            RestoreEntryException ree = new RestoreEntryException(RestoreEntryException.DUPLICATE);

            ree.setDuplicateEntryId(duplicateNode.getNodeId());
            ree.setOldName(duplicateNode.getName());
            ree.setTrashEntryId(trashEntry.getEntryId());

            throw ree;
        }
    }

    @Override
    public void deleteTrashEntry(long classPK) throws PortalException {
        _wikiNodeLocalService.deleteNode(classPK);
    }

    @Override
    public String getClassName() {
        return WikiNode.class.getName();
    }

    @Override
    public String getRestoreContainedModelLink(PortletRequest portletRequest, long classPK) throws PortalException {

        PortletURL portletURL = getRestoreURL(portletRequest, classPK, false);

        WikiNode node = _wikiNodeLocalService.getNode(classPK);

        portletURL.setParameter("nodeId", String.valueOf(node.getNodeId()));

        return portletURL.toString();
    }

    @Override
    public String getRestoreContainerModelLink(PortletRequest portletRequest, long classPK) throws PortalException {

        PortletURL portletURL = getRestoreURL(portletRequest, classPK, true);

        return portletURL.toString();
    }

    @Override
    public String getRestoreMessage(PortletRequest portletRequest, long classPK) {

        ThemeDisplay themeDisplay = (ThemeDisplay) portletRequest.getAttribute(WebKeys.THEME_DISPLAY);

        return themeDisplay.translate("wiki");
    }

    @Override
    public String getTrashContainedModelName() {
        return "wiki-pages";
    }

    @Override
    public int getTrashContainedModelsCount(long classPK) {
        return _wikiPageLocalService.getPagesCount(classPK, true, WorkflowConstants.STATUS_IN_TRASH);
    }

    @Override
    public TrashedModel getTrashedModel(long classPK) {
        return _wikiNodeLocalService.fetchWikiNode(classPK);
    }

    @Override
    public int getTrashModelsCount(long classPK) throws PortalException {
        return _wikiPageLocalService.getPagesCount(classPK, true, WorkflowConstants.STATUS_IN_TRASH);
    }

    @Override
    public List<TrashedModel> getTrashModelTrashedModels(long classPK, int start, int end, OrderByComparator<?> obc)
            throws PortalException {

        List<WikiPage> pages = _wikiPageLocalService.getPages(classPK, true, WorkflowConstants.STATUS_IN_TRASH,
                start, end, (OrderByComparator<WikiPage>) obc);

        List<TrashedModel> trashedModels = new ArrayList<>(pages.size());

        for (WikiPage page : pages) {
            trashedModels.add(page);
        }

        return trashedModels;
    }

    @Override
    public TrashRenderer getTrashRenderer(long classPK) throws PortalException {
        WikiNode node = _wikiNodeLocalService.getNode(classPK);

        return new WikiNodeTrashRenderer(node, _trashHelper);
    }

    @Override
    public boolean isContainerModel() {
        return true;
    }

    @Override
    public void restoreTrashEntry(long userId, long classPK) throws PortalException {

        WikiNode node = _wikiNodeLocalService.getNode(classPK);

        _wikiNodeLocalService.restoreNodeFromTrash(userId, node);
    }

    @Override
    public void updateTitle(long classPK, String name) throws PortalException {
        WikiNode node = _wikiNodeLocalService.getNode(classPK);

        node.setName(name);

        _wikiNodeLocalService.updateWikiNode(node);
    }

    protected PortletURL getRestoreURL(PortletRequest portletRequest, long classPK, boolean containerModel)
            throws PortalException {

        PortletURL portletURL = null;

        WikiNode node = _wikiNodeLocalService.getNode(classPK);

        long plid = _portal.getPlidFromPortletId(node.getGroupId(), WikiPortletKeys.WIKI);

        if (plid == LayoutConstants.DEFAULT_PLID) {
            portletURL = _portal.getControlPanelPortletURL(portletRequest, WikiPortletKeys.WIKI_ADMIN,
                    PortletRequest.RENDER_PHASE);
        } else {
            portletURL = PortletURLFactoryUtil.create(portletRequest, WikiPortletKeys.WIKI, plid,
                    PortletRequest.RENDER_PHASE);
        }

        if (!containerModel) {
            portletURL.setParameter("mvcRenderCommandName", "/wiki/view_pages");
        }

        return portletURL;
    }

    @Override
    protected boolean hasPermission(PermissionChecker permissionChecker, long classPK, String actionId)
            throws PortalException {

        return _wikiNodeModelResourcePermission.contains(permissionChecker, classPK, actionId);
    }

    @Reference(unbind = "-")
    protected void setWikiNodeLocalService(WikiNodeLocalService wikiNodeLocalService) {

        _wikiNodeLocalService = wikiNodeLocalService;
    }

    @Reference(unbind = "-")
    protected void setWikiPageLocalService(WikiPageLocalService wikiPageLocalService) {

        _wikiPageLocalService = wikiPageLocalService;
    }

    @Reference
    private Portal _portal;

    @Reference
    private TrashHelper _trashHelper;

    private WikiNodeLocalService _wikiNodeLocalService;

    @Reference(target = "(model.class.name=com.liferay.wiki.model.WikiNode)")
    private ModelResourcePermission<WikiNode> _wikiNodeModelResourcePermission;

    private WikiPageLocalService _wikiPageLocalService;

}