com.liferay.document.library.internal.trash.DLFileEntryTrashHandler Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of com.liferay.document.library.service
Show all versions of com.liferay.document.library.service
Liferay Document Library Service
/**
* 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.document.library.internal.trash;
import com.liferay.document.library.kernel.model.DLFileEntry;
import com.liferay.document.library.kernel.model.DLFileEntryConstants;
import com.liferay.document.library.kernel.model.DLFileVersion;
import com.liferay.document.library.kernel.model.DLFolder;
import com.liferay.document.library.kernel.service.DLAppLocalService;
import com.liferay.document.library.kernel.service.DLFileEntryLocalService;
import com.liferay.document.library.kernel.service.DLFileVersionLocalService;
import com.liferay.document.library.kernel.service.DLFolderLocalService;
import com.liferay.document.library.kernel.service.DLTrashLocalService;
import com.liferay.document.library.kernel.util.DLUtil;
import com.liferay.document.library.kernel.util.DLValidator;
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.ContainerModel;
import com.liferay.portal.kernel.model.TrashedModel;
import com.liferay.portal.kernel.repository.DocumentRepository;
import com.liferay.portal.kernel.repository.LocalRepository;
import com.liferay.portal.kernel.repository.Repository;
import com.liferay.portal.kernel.repository.RepositoryProviderUtil;
import com.liferay.portal.kernel.repository.capabilities.TrashCapability;
import com.liferay.portal.kernel.repository.capabilities.UnsupportedCapabilityException;
import com.liferay.portal.kernel.repository.model.FileEntry;
import com.liferay.portal.kernel.search.Field;
import com.liferay.portal.kernel.search.SearchContext;
import com.liferay.portal.kernel.search.filter.BooleanFilter;
import com.liferay.portal.kernel.search.filter.Filter;
import com.liferay.portal.kernel.security.permission.ActionKeys;
import com.liferay.portal.kernel.security.permission.PermissionChecker;
import com.liferay.portal.kernel.service.ServiceContext;
import com.liferay.portal.kernel.trash.TrashActionKeys;
import com.liferay.portal.kernel.trash.TrashHandler;
import com.liferay.portal.kernel.trash.TrashHandlerRegistryUtil;
import com.liferay.portal.kernel.util.Validator;
import com.liferay.portlet.documentlibrary.service.permission.DLFileEntryPermission;
import com.liferay.portlet.documentlibrary.service.permission.DLFolderPermission;
import com.liferay.trash.kernel.exception.RestoreEntryException;
import com.liferay.trash.kernel.model.TrashEntry;
import com.liferay.trash.kernel.model.TrashEntryConstants;
import javax.portlet.PortletRequest;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.Reference;
/**
* Implements trash handling for the file entry entity.
*
* @author Alexander Chow
* @author Manuel de la Peña
* @author Zsolt Berentey
*/
@Component(
property = "model.class.name=com.liferay.document.library.kernel.model.DLFileEntry",
service = TrashHandler.class
)
public class DLFileEntryTrashHandler extends DLBaseTrashHandler {
@Override
public void checkRestorableEntry(
long classPK, long containerModelId, String newName)
throws PortalException {
DLFileEntry dlFileEntry = getDLFileEntry(classPK);
checkRestorableEntry(
classPK, 0, containerModelId, dlFileEntry.getFileName(),
dlFileEntry.getTitle(), newName);
}
@Override
public void checkRestorableEntry(
TrashEntry trashEntry, long containerModelId, String newName)
throws PortalException {
checkRestorableEntry(
trashEntry.getClassPK(), trashEntry.getEntryId(), containerModelId,
trashEntry.getTypeSettingsProperty("fileName"),
trashEntry.getTypeSettingsProperty("title"), newName);
}
@Override
public void deleteTrashEntry(long classPK) throws PortalException {
DocumentRepository documentRepository = getDocumentRepository(classPK);
TrashCapability trashCapability = documentRepository.getCapability(
TrashCapability.class);
trashCapability.deleteFileEntry(
documentRepository.getFileEntry(classPK));
}
@Override
public String getClassName() {
return DLFileEntry.class.getName();
}
@Override
public Filter getExcludeFilter(SearchContext searchContext) {
BooleanFilter excludeBooleanFilter = new BooleanFilter();
excludeBooleanFilter.addRequiredTerm(
Field.ENTRY_CLASS_NAME, DLFileEntryConstants.getClassName());
excludeBooleanFilter.addRequiredTerm(Field.HIDDEN, true);
return excludeBooleanFilter;
}
@Override
public ContainerModel getParentContainerModel(long classPK)
throws PortalException {
DLFileEntry dlFileEntry = getDLFileEntry(classPK);
long parentFolderId = dlFileEntry.getFolderId();
if (parentFolderId <= 0) {
return null;
}
return getContainerModel(parentFolderId);
}
@Override
public ContainerModel getParentContainerModel(TrashedModel trashedModel)
throws PortalException {
DLFileEntry dlFileEntry = (DLFileEntry)trashedModel;
return getContainerModel(dlFileEntry.getFolderId());
}
@Override
public String getRestoreContainedModelLink(
PortletRequest portletRequest, long classPK)
throws PortalException {
DLFileEntry dlFileEntry = getDLFileEntry(classPK);
return DLUtil.getDLFileEntryControlPanelLink(
portletRequest, dlFileEntry.getFileEntryId());
}
@Override
public String getRestoreContainerModelLink(
PortletRequest portletRequest, long classPK)
throws PortalException {
DLFileEntry dlFileEntry = getDLFileEntry(classPK);
return DLUtil.getDLFolderControlPanelLink(
portletRequest, dlFileEntry.getFolderId());
}
@Override
public String getRestoreMessage(PortletRequest portletRequest, long classPK)
throws PortalException {
DLFileEntry dlFileEntry = getDLFileEntry(classPK);
DLFolder dlFolder = dlFileEntry.getFolder();
return DLUtil.getAbsolutePath(portletRequest, dlFolder.getFolderId());
}
@Override
public String getSystemEventClassName() {
return DLFileEntryConstants.getClassName();
}
@Override
public TrashEntry getTrashEntry(long classPK) throws PortalException {
DLFileEntry dlFileEntry = getDLFileEntry(classPK);
return dlFileEntry.getTrashEntry();
}
@Override
public boolean hasTrashPermission(
PermissionChecker permissionChecker, long groupId, long classPK,
String trashActionId)
throws PortalException {
if (trashActionId.equals(TrashActionKeys.MOVE)) {
return DLFolderPermission.contains(
permissionChecker, groupId, classPK, ActionKeys.ADD_DOCUMENT);
}
return super.hasTrashPermission(
permissionChecker, groupId, classPK, trashActionId);
}
@Override
public boolean isInTrash(long classPK) throws PortalException {
try {
DLFileEntry dlFileEntry = getDLFileEntry(classPK);
return dlFileEntry.isInTrash();
}
catch (UnsupportedCapabilityException uce) {
if (_log.isDebugEnabled()) {
_log.debug(uce, uce);
}
return false;
}
}
@Override
public boolean isInTrashContainer(long classPK) throws PortalException {
try {
DLFileEntry dlFileEntry = getDLFileEntry(classPK);
return dlFileEntry.isInTrashContainer();
}
catch (UnsupportedCapabilityException uce) {
if (_log.isDebugEnabled()) {
_log.debug(uce, uce);
}
return false;
}
}
@Override
public boolean isRestorable(long classPK) throws PortalException {
DLFileEntry dlFileEntry = fetchDLFileEntry(classPK);
if ((dlFileEntry == null) ||
((dlFileEntry.getFolderId() > 0) &&
(_dlFolderLocalService.fetchFolder(dlFileEntry.getFolderId()) ==
null))) {
return false;
}
return !dlFileEntry.isInTrashContainer();
}
@Override
public void moveEntry(
long userId, long classPK, long containerModelId,
ServiceContext serviceContext)
throws PortalException {
_dlAppLocalService.moveFileEntry(
userId, classPK, containerModelId, serviceContext);
}
@Override
public void moveTrashEntry(
long userId, long classPK, long containerModelId,
ServiceContext serviceContext)
throws PortalException {
DocumentRepository documentRepository = getDocumentRepository(classPK);
_dlTrashLocalService.moveFileEntryFromTrash(
userId, documentRepository.getRepositoryId(), classPK,
containerModelId, serviceContext);
}
@Override
public void restoreTrashEntry(long userId, long classPK)
throws PortalException {
DLFileEntry dlFileEntry = getDLFileEntry(classPK);
if ((dlFileEntry.getClassNameId() > 0) &&
(dlFileEntry.getClassPK() > 0)) {
TrashHandler trashHandler =
TrashHandlerRegistryUtil.getTrashHandler(
dlFileEntry.getClassName());
trashHandler.restoreRelatedTrashEntry(getClassName(), classPK);
return;
}
_dlTrashLocalService.restoreFileEntryFromTrash(
userId, dlFileEntry.getRepositoryId(), classPK);
}
@Override
public void updateTitle(long classPK, String name) throws PortalException {
DLFileEntry dlFileEntry = getDLFileEntry(classPK);
String fileName = DLUtil.getSanitizedFileName(
name, dlFileEntry.getExtension());
dlFileEntry.setFileName(fileName);
dlFileEntry.setTitle(name);
_dlFileEntryLocalService.updateDLFileEntry(dlFileEntry);
DLFileVersion dlFileVersion = dlFileEntry.getFileVersion();
dlFileVersion.setFileName(fileName);
dlFileVersion.setTitle(name);
_dlFileVersionLocalService.updateDLFileVersion(dlFileVersion);
}
protected void checkRestorableEntry(
long classPK, long entryId, long containerModelId,
String originalFileName, String originalTitle, String newName)
throws PortalException {
if (Validator.isNotNull(newName) &&
!_dlValidator.isValidName(newName)) {
RestoreEntryException ree = new RestoreEntryException(
RestoreEntryException.INVALID_NAME);
ree.setErrorMessage("please-enter-a-valid-name");
ree.setTrashEntryId(entryId);
throw ree;
}
DLFileEntry dlFileEntry = getDLFileEntry(classPK);
if (containerModelId == TrashEntryConstants.DEFAULT_CONTAINER_ID) {
containerModelId = dlFileEntry.getFolderId();
}
if (Validator.isNotNull(newName)) {
originalFileName = DLUtil.getSanitizedFileName(
newName, dlFileEntry.getExtension());
originalTitle = newName;
}
DLFolder duplicateDLFolder = _dlFolderLocalService.fetchFolder(
dlFileEntry.getGroupId(), containerModelId, originalTitle);
if (duplicateDLFolder != null) {
RestoreEntryException ree = new RestoreEntryException(
RestoreEntryException.DUPLICATE);
ree.setDuplicateEntryId(duplicateDLFolder.getFolderId());
ree.setOldName(duplicateDLFolder.getName());
ree.setOverridable(false);
ree.setTrashEntryId(entryId);
throw ree;
}
DLFileEntry duplicateDLFileEntry =
_dlFileEntryLocalService.fetchFileEntry(
dlFileEntry.getGroupId(), containerModelId, originalTitle);
if (duplicateDLFileEntry == null) {
duplicateDLFileEntry =
_dlFileEntryLocalService.fetchFileEntryByFileName(
dlFileEntry.getGroupId(), containerModelId,
originalFileName);
}
if (duplicateDLFileEntry != null) {
RestoreEntryException ree = new RestoreEntryException(
RestoreEntryException.DUPLICATE);
ree.setDuplicateEntryId(duplicateDLFileEntry.getFileEntryId());
ree.setOldName(duplicateDLFileEntry.getTitle());
ree.setTrashEntryId(entryId);
throw ree;
}
}
protected DLFileEntry fetchDLFileEntry(long classPK)
throws PortalException {
Repository repository = RepositoryProviderUtil.getFileEntryRepository(
classPK);
if (!repository.isCapabilityProvided(TrashCapability.class)) {
return null;
}
FileEntry fileEntry = repository.getFileEntry(classPK);
return (DLFileEntry)fileEntry.getModel();
}
protected DLFileEntry getDLFileEntry(long classPK) throws PortalException {
Repository repository = RepositoryProviderUtil.getFileEntryRepository(
classPK);
if (!repository.isCapabilityProvided(TrashCapability.class)) {
throw new UnsupportedCapabilityException(
TrashCapability.class,
"Repository " + repository.getRepositoryId());
}
FileEntry fileEntry = repository.getFileEntry(classPK);
return (DLFileEntry)fileEntry.getModel();
}
@Override
protected DocumentRepository getDocumentRepository(long classPK)
throws PortalException {
LocalRepository localRepository =
RepositoryProviderUtil.getFileEntryLocalRepository(classPK);
if (!localRepository.isCapabilityProvided(TrashCapability.class)) {
throw new UnsupportedCapabilityException(
TrashCapability.class,
"Repository " + localRepository.getRepositoryId());
}
return localRepository;
}
@Override
protected boolean hasPermission(
PermissionChecker permissionChecker, long classPK, String actionId)
throws PortalException {
DLFileEntry dlFileEntry = getDLFileEntry(classPK);
if (dlFileEntry.isInHiddenFolder() &&
actionId.equals(ActionKeys.VIEW)) {
return false;
}
return DLFileEntryPermission.contains(
permissionChecker, classPK, actionId);
}
@Reference(unbind = "-")
protected void setDLAppLocalService(DLAppLocalService dlAppLocalService) {
_dlAppLocalService = dlAppLocalService;
}
@Reference(unbind = "-")
protected void setDLFileEntryLocalService(
DLFileEntryLocalService dlFileEntryLocalService) {
_dlFileEntryLocalService = dlFileEntryLocalService;
}
@Reference(unbind = "-")
protected void setDLFileVersionLocalService(
DLFileVersionLocalService dlFileVersionLocalService) {
_dlFileVersionLocalService = dlFileVersionLocalService;
}
@Reference(unbind = "-")
protected void setDLFolderLocalService(
DLFolderLocalService dlFolderLocalService) {
_dlFolderLocalService = dlFolderLocalService;
}
@Reference(unbind = "-")
protected void setDLTrashLocalService(
DLTrashLocalService dlTrashLocalService) {
_dlTrashLocalService = dlTrashLocalService;
}
private static final Log _log = LogFactoryUtil.getLog(
DLFileEntryTrashHandler.class);
private DLAppLocalService _dlAppLocalService;
private DLFileEntryLocalService _dlFileEntryLocalService;
private DLFileVersionLocalService _dlFileVersionLocalService;
private DLFolderLocalService _dlFolderLocalService;
private DLTrashLocalService _dlTrashLocalService;
@Reference
private DLValidator _dlValidator;
}© 2015 - 2025 Weber Informatics LLC | Privacy Policy