Java tutorial
/** * 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.verify; import com.liferay.counter.kernel.service.CounterLocalService; import com.liferay.document.library.kernel.exception.DuplicateFileEntryException; import com.liferay.document.library.kernel.exception.DuplicateFolderNameException; import com.liferay.document.library.kernel.model.DLFileEntry; import com.liferay.document.library.kernel.model.DLFileEntryMetadata; import com.liferay.document.library.kernel.model.DLFileEntryType; import com.liferay.document.library.kernel.model.DLFileEntryTypeConstants; import com.liferay.document.library.kernel.model.DLFileVersion; import com.liferay.document.library.kernel.model.DLFolder; import com.liferay.document.library.kernel.service.DLAppHelperLocalService; import com.liferay.document.library.kernel.service.DLFileEntryLocalService; import com.liferay.document.library.kernel.service.DLFileEntryMetadataLocalService; import com.liferay.document.library.kernel.service.DLFileEntryTypeLocalService; import com.liferay.document.library.kernel.service.DLFileVersionLocalService; import com.liferay.document.library.kernel.service.DLFolderLocalService; import com.liferay.document.library.kernel.store.DLStoreUtil; import com.liferay.document.library.kernel.util.DLUtil; import com.liferay.document.library.kernel.util.DLValidatorUtil; import com.liferay.document.library.kernel.util.comparator.DLFileVersionVersionComparator; import com.liferay.portal.instances.service.PortalInstancesLocalService; import com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery; import com.liferay.portal.kernel.dao.orm.Criterion; import com.liferay.portal.kernel.dao.orm.DynamicQuery; import com.liferay.portal.kernel.dao.orm.RestrictionsFactoryUtil; 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.Release; import com.liferay.portal.kernel.repository.model.FileEntry; import com.liferay.portal.kernel.repository.model.FileVersion; import com.liferay.portal.kernel.repository.model.Folder; import com.liferay.portal.kernel.util.ContentTypes; import com.liferay.portal.kernel.util.ListUtil; import com.liferay.portal.kernel.util.LocaleUtil; import com.liferay.portal.kernel.util.LoggingTimer; import com.liferay.portal.kernel.util.MimeTypesUtil; import com.liferay.portal.kernel.util.StreamUtil; import com.liferay.portal.kernel.util.StringBundler; import com.liferay.portal.kernel.util.StringPool; import com.liferay.portal.kernel.util.StringUtil; import com.liferay.portal.kernel.workflow.WorkflowConstants; import com.liferay.portal.repository.liferayrepository.model.LiferayFileEntry; import com.liferay.portal.repository.liferayrepository.model.LiferayFileVersion; import com.liferay.portal.repository.liferayrepository.model.LiferayFolder; import com.liferay.portal.verify.VerifyProcess; import com.liferay.portlet.documentlibrary.webdav.DLWebDAVUtil; import java.io.InputStream; import java.util.Collections; import java.util.Date; import java.util.List; import java.util.Objects; import org.osgi.service.component.annotations.Component; import org.osgi.service.component.annotations.Reference; import org.springframework.context.ApplicationContext; /** * @author Raymond Aug * @author Douglas Wong * @author Alexander Chow */ @Component(immediate = true, property = { "verify.process.name=com.liferay.document.library.service" }, service = VerifyProcess.class) public class DLServiceVerifyProcess extends VerifyProcess { protected void addDLFileVersion(DLFileEntry dlFileEntry) { long fileVersionId = _counterLocalService.increment(); DLFileVersion dlFileVersion = _dlFileVersionLocalService.createDLFileVersion(fileVersionId); dlFileVersion.setGroupId(dlFileEntry.getGroupId()); dlFileVersion.setCompanyId(dlFileEntry.getCompanyId()); long userId = dlFileEntry.getUserId(); dlFileVersion.setUserId(userId); String userName = dlFileEntry.getUserName(); dlFileVersion.setUserName(userName); dlFileVersion.setCreateDate(dlFileEntry.getModifiedDate()); dlFileVersion.setModifiedDate(dlFileEntry.getModifiedDate()); dlFileVersion.setRepositoryId(dlFileEntry.getRepositoryId()); dlFileVersion.setFolderId(dlFileEntry.getFolderId()); dlFileVersion.setFileEntryId(dlFileEntry.getFileEntryId()); dlFileVersion.setExtension(dlFileEntry.getExtension()); dlFileVersion.setMimeType(dlFileEntry.getMimeType()); dlFileVersion.setTitle(dlFileEntry.getTitle()); dlFileVersion.setDescription(dlFileEntry.getDescription()); dlFileVersion.setExtraSettings(dlFileEntry.getExtraSettings()); dlFileVersion.setFileEntryTypeId(dlFileEntry.getFileEntryTypeId()); dlFileVersion.setVersion(dlFileEntry.getVersion()); dlFileVersion.setSize(dlFileEntry.getSize()); dlFileVersion.setStatus(WorkflowConstants.STATUS_APPROVED); dlFileVersion.setStatusByUserId(userId); dlFileVersion.setStatusByUserName(userName); dlFileVersion.setStatusDate(new Date()); _dlFileVersionLocalService.updateDLFileVersion(dlFileVersion); } protected void checkDLFileEntryMetadata() throws Exception { try (LoggingTimer loggingTimer = new LoggingTimer()) { List<DLFileEntryMetadata> mismatchedCompanyIdDLFileEntryMetadatas = _dlFileEntryMetadataLocalService .getMismatchedCompanyIdFileEntryMetadatas(); if (_log.isDebugEnabled()) { int size = mismatchedCompanyIdDLFileEntryMetadatas.size(); _log.debug("Deleting " + size + " file entry metadatas with " + "mismatched company IDs"); } for (DLFileEntryMetadata dlFileEntryMetadata : mismatchedCompanyIdDLFileEntryMetadatas) { deleteUnusedDLFileEntryMetadata(dlFileEntryMetadata); } List<DLFileEntryMetadata> noStructuresDLFileEntryMetadatas = _dlFileEntryMetadataLocalService .getNoStructuresFileEntryMetadatas(); if (_log.isDebugEnabled()) { _log.debug("Deleting " + noStructuresDLFileEntryMetadatas.size() + " file entry metadatas with no structures"); } for (DLFileEntryMetadata dlFileEntryMetadata : noStructuresDLFileEntryMetadatas) { deleteUnusedDLFileEntryMetadata(dlFileEntryMetadata); } } } protected void checkDLFileEntryType() throws Exception { try (LoggingTimer loggingTimer = new LoggingTimer()) { DLFileEntryType dlFileEntryType = _dlFileEntryTypeLocalService .fetchDLFileEntryType(DLFileEntryTypeConstants.FILE_ENTRY_TYPE_ID_BASIC_DOCUMENT); if (dlFileEntryType != null) { return; } dlFileEntryType = _dlFileEntryTypeLocalService .createDLFileEntryType(DLFileEntryTypeConstants.FILE_ENTRY_TYPE_ID_BASIC_DOCUMENT); dlFileEntryType.setCompanyId(DLFileEntryTypeConstants.COMPANY_ID_BASIC_DOCUMENT); dlFileEntryType .setFileEntryTypeKey(StringUtil.toUpperCase(DLFileEntryTypeConstants.NAME_BASIC_DOCUMENT)); dlFileEntryType.setName(DLFileEntryTypeConstants.NAME_BASIC_DOCUMENT, LocaleUtil.getDefault()); _dlFileEntryTypeLocalService.updateDLFileEntryType(dlFileEntryType); } } protected void checkFileVersionMimeTypes(final String[] originalMimeTypes) throws Exception { ActionableDynamicQuery actionableDynamicQuery = _dlFileVersionLocalService.getActionableDynamicQuery(); actionableDynamicQuery.setAddCriteriaMethod(new ActionableDynamicQuery.AddCriteriaMethod() { @Override public void addCriteria(DynamicQuery dynamicQuery) { Criterion criterion = RestrictionsFactoryUtil.eq("mimeType", originalMimeTypes[0]); for (int i = 1; i < originalMimeTypes.length; i++) { criterion = RestrictionsFactoryUtil.or(criterion, RestrictionsFactoryUtil.eq("mimeType", originalMimeTypes[i])); } dynamicQuery.add(criterion); } }); actionableDynamicQuery .setPerformActionMethod(new ActionableDynamicQuery.PerformActionMethod<DLFileVersion>() { @Override public void performAction(DLFileVersion dlFileVersion) { InputStream inputStream = null; try { inputStream = _dlFileEntryLocalService.getFileAsStream(dlFileVersion.getFileEntryId(), dlFileVersion.getVersion(), false); } catch (Exception e) { if (_log.isWarnEnabled()) { DLFileEntry dlFileEntry = _dlFileEntryLocalService .fetchDLFileEntry(dlFileVersion.getFileEntryId()); if (dlFileEntry == null) { _log.warn("Unable to find file entry associated " + "with file version " + dlFileVersion.getFileVersionId(), e); } else { StringBundler sb = new StringBundler(4); sb.append("Unable to find file version "); sb.append(dlFileVersion.getVersion()); sb.append(" for file entry "); sb.append(dlFileEntry.getName()); _log.warn(sb.toString(), e); } } return; } String title = DLUtil.getTitleWithExtension(dlFileVersion.getTitle(), dlFileVersion.getExtension()); String mimeType = getMimeType(inputStream, title); if (mimeType.equals(dlFileVersion.getMimeType())) { return; } dlFileVersion.setMimeType(mimeType); _dlFileVersionLocalService.updateDLFileVersion(dlFileVersion); try { DLFileEntry dlFileEntry = dlFileVersion.getFileEntry(); if (Objects.equals(dlFileEntry.getVersion(), dlFileVersion.getVersion())) { dlFileEntry.setMimeType(mimeType); _dlFileEntryLocalService.updateDLFileEntry(dlFileEntry); } } catch (PortalException pe) { if (_log.isWarnEnabled()) { _log.warn("Unable to get file entry " + dlFileVersion.getFileEntryId(), pe); } } } }); if (_log.isDebugEnabled()) { long count = actionableDynamicQuery.performCount(); _log.debug("Processing " + count + " file versions with mime types: " + StringUtil.merge(originalMimeTypes, StringPool.COMMA)); } actionableDynamicQuery.performActions(); } protected void checkMimeTypes() throws Exception { try (LoggingTimer loggingTimer = new LoggingTimer()) { String[] mimeTypes = { ContentTypes.APPLICATION_OCTET_STREAM, _MS_OFFICE_2010_TEXT_XML_UTF8 }; checkFileVersionMimeTypes(mimeTypes); if (_log.isDebugEnabled()) { _log.debug("Fixed file entries with invalid mime types"); } } } protected void checkMisversionedDLFileEntries() throws Exception { try (LoggingTimer loggingTimer = new LoggingTimer()) { List<DLFileEntry> dlFileEntries = _dlFileEntryLocalService.getMisversionedFileEntries(); if (_log.isDebugEnabled()) { _log.debug("Processing " + dlFileEntries.size() + " misversioned file entries"); } for (DLFileEntry dlFileEntry : dlFileEntries) { copyDLFileEntry(dlFileEntry); addDLFileVersion(dlFileEntry); } if (_log.isDebugEnabled()) { _log.debug("Fixed misversioned file entries"); } } } protected void checkTitles() throws Exception { try (LoggingTimer loggingTimer = new LoggingTimer()) { ActionableDynamicQuery actionableDynamicQuery = _dlFileEntryLocalService.getActionableDynamicQuery(); actionableDynamicQuery .setPerformActionMethod(new ActionableDynamicQuery.PerformActionMethod<DLFileEntry>() { @Override public void performAction(DLFileEntry dlFileEntry) { if (dlFileEntry.isInTrash()) { return; } String title = dlFileEntry.getTitle(); if (!DLValidatorUtil.isValidName(title)) { try { dlFileEntry = renameTitle(dlFileEntry, DLValidatorUtil.fixName(title)); } catch (Exception e) { if (_log.isWarnEnabled()) { _log.warn("Unable to rename invalid title for " + "file entry " + dlFileEntry.getFileEntryId(), e); } } } if (!DLWebDAVUtil.isRepresentableTitle(dlFileEntry.getTitle())) { try { dlFileEntry = renameWithRepresentableTitle(dlFileEntry); } catch (Exception e) { if (_log.isWarnEnabled()) { _log.warn("Unable to rename file entry " + dlFileEntry.getFileEntryId() + " with a WebDAV title", e); } } } try { _dlFileEntryLocalService.validateFile(dlFileEntry.getGroupId(), dlFileEntry.getFolderId(), dlFileEntry.getFileEntryId(), dlFileEntry.getFileName(), dlFileEntry.getTitle()); } catch (DuplicateFileEntryException | DuplicateFolderNameException pe) { try { renameDuplicateTitle(dlFileEntry); } catch (Exception e) { if (_log.isWarnEnabled()) { _log.warn("Unable to rename duplicate title " + "for file entry " + dlFileEntry.getFileEntryId(), e); } } } catch (PortalException pe) { // LPS-52675 if (_log.isDebugEnabled()) { _log.debug(pe, pe); } return; } } }); actionableDynamicQuery.performActions(); } } protected void copyDLFileEntry(DLFileEntry dlFileEntry) throws PortalException { long companyId = dlFileEntry.getCompanyId(); long dataRepositoryId = dlFileEntry.getDataRepositoryId(); String name = dlFileEntry.getName(); String version = dlFileEntry.getVersion(); if (DLStoreUtil.hasFile(companyId, dataRepositoryId, name, version)) { return; } List<DLFileVersion> dlFileVersions = dlFileEntry.getFileVersions(WorkflowConstants.STATUS_APPROVED); if (dlFileVersions.isEmpty()) { dlFileVersions = dlFileEntry.getFileVersions(WorkflowConstants.STATUS_ANY); } if (dlFileVersions.isEmpty()) { DLStoreUtil.addFile(companyId, dataRepositoryId, name, new byte[0]); return; } dlFileVersions = ListUtil.copy(dlFileVersions); Collections.sort(dlFileVersions, new DLFileVersionVersionComparator()); DLFileVersion dlFileVersion = dlFileVersions.get(0); DLStoreUtil.copyFileVersion(companyId, dataRepositoryId, name, dlFileVersion.getVersion(), version); } protected void deleteOrphanedDLFileEntries() throws Exception { try (LoggingTimer loggingTimer = new LoggingTimer()) { List<DLFileEntry> dlFileEntries = _dlFileEntryLocalService.getOrphanedFileEntries(); if (_log.isDebugEnabled()) { _log.debug("Processing " + dlFileEntries.size() + " file entries with no group"); } for (DLFileEntry dlFileEntry : dlFileEntries) { try { _dlFileEntryLocalService.deleteFileEntry(dlFileEntry.getFileEntryId()); } catch (Exception e) { if (_log.isWarnEnabled()) { _log.warn("Unable to remove file entry " + dlFileEntry.getFileEntryId() + ": " + e.getMessage()); } } } if (_log.isDebugEnabled()) { _log.debug("Removed orphaned file entries"); } } } protected void deleteUnusedDLFileEntryMetadata(DLFileEntryMetadata dlFileEntryMetadata) throws Exception { _dlFileEntryMetadataLocalService.deleteFileEntryMetadata(dlFileEntryMetadata); } @Override protected void doVerify() throws Exception { checkMisversionedDLFileEntries(); checkDLFileEntryType(); checkDLFileEntryMetadata(); checkMimeTypes(); checkTitles(); deleteOrphanedDLFileEntries(); updateClassNameId(); updateFileEntryAssets(); updateFolderAssets(); } protected String getMimeType(InputStream inputStream, String title) { String mimeType = null; try { mimeType = MimeTypesUtil.getContentType(inputStream, title); } finally { StreamUtil.cleanUp(inputStream); } return mimeType; } protected void renameDuplicateTitle(DLFileEntry dlFileEntry) throws PortalException { String uniqueTitle = _dlFileEntryLocalService.getUniqueTitle(dlFileEntry.getGroupId(), dlFileEntry.getFolderId(), dlFileEntry.getFileEntryId(), dlFileEntry.getTitle(), dlFileEntry.getExtension()); renameTitle(dlFileEntry, uniqueTitle); } protected DLFileEntry renameTitle(DLFileEntry dlFileEntry, String newTitle) throws PortalException { String title = dlFileEntry.getTitle(); dlFileEntry.setTitle(newTitle); String fileName = DLUtil.getSanitizedFileName(newTitle, dlFileEntry.getExtension()); dlFileEntry.setFileName(fileName); DLFileEntry renamedDLFileEntry = _dlFileEntryLocalService.updateDLFileEntry(dlFileEntry); DLFileVersion dlFileVersion = dlFileEntry.getFileVersion(); dlFileVersion.setTitle(newTitle); dlFileVersion.setFileName(fileName); _dlFileVersionLocalService.updateDLFileVersion(dlFileVersion); if (_log.isDebugEnabled()) { _log.debug("Invalid title " + title + " renamed to " + newTitle + " for file entry " + dlFileEntry.getFileEntryId()); } return renamedDLFileEntry; } protected DLFileEntry renameWithRepresentableTitle(DLFileEntry dlFileEntry) throws PortalException { String title = dlFileEntry.getTitle(); for (int i = 0;; i++) { String newTitle = DLWebDAVUtil.getRepresentableTitle(title, i); try { return renameTitle(dlFileEntry, newTitle); } catch (DuplicateFileEntryException dfee) { // LPS-52675 if (_log.isDebugEnabled()) { _log.debug(dfee, dfee); } } } } @Reference(target = "(org.springframework.context.service.name=com.liferay.dynamic.data.mapping.service)", unbind = "-") protected void setApplicationContext(ApplicationContext applicationContext) { } @Reference(unbind = "-") protected void setCounterLocalService(CounterLocalService counterLocalService) { _counterLocalService = counterLocalService; } @Reference(unbind = "-") protected void setDLAppHelperLocalService(DLAppHelperLocalService dlAppHelperLocalService) { _dlAppHelperLocalService = dlAppHelperLocalService; } @Reference(unbind = "-") protected void setDLFileEntryLocalService(DLFileEntryLocalService dlFileEntryLocalService) { _dlFileEntryLocalService = dlFileEntryLocalService; } @Reference(unbind = "-") protected void setDLFileEntryMetadataLocalService( DLFileEntryMetadataLocalService dlFileEntryMetadataLocalService) { _dlFileEntryMetadataLocalService = dlFileEntryMetadataLocalService; } @Reference(unbind = "-") protected void setDLFileEntryTypeLocalService(DLFileEntryTypeLocalService dlFileEntryTypeLocalService) { _dlFileEntryTypeLocalService = dlFileEntryTypeLocalService; } @Reference(unbind = "-") protected void setDLFileVersionLocalService(DLFileVersionLocalService dlFileVersionLocalService) { _dlFileVersionLocalService = dlFileVersionLocalService; } @Reference(unbind = "-") protected void setDLFolderLocalService(DLFolderLocalService dlFolderLocalService) { _dlFolderLocalService = dlFolderLocalService; } @Reference(target = "(&(release.bundle.symbolic.name=com.liferay.document.library.service)(release.schema.version=1.0.0))", unbind = "-") protected void setRelease(Release release) { } protected void updateClassNameId() { try (LoggingTimer loggingTimer = new LoggingTimer()) { runSQL("update DLFileEntry set classNameId = 0 where classNameId is " + "null"); } catch (Exception e) { if (_log.isWarnEnabled()) { _log.warn("Unable to fix file entries where class name ID is null", e); } } } protected void updateFileEntryAssets() throws Exception { try (LoggingTimer loggingTimer = new LoggingTimer()) { List<DLFileEntry> dlFileEntries = _dlFileEntryLocalService.getNoAssetFileEntries(); if (_log.isDebugEnabled()) { _log.debug("Processing " + dlFileEntries.size() + " file entries with no asset"); } for (DLFileEntry dlFileEntry : dlFileEntries) { FileEntry fileEntry = new LiferayFileEntry(dlFileEntry); FileVersion fileVersion = new LiferayFileVersion(dlFileEntry.getFileVersion()); try { _dlAppHelperLocalService.updateAsset(dlFileEntry.getUserId(), fileEntry, fileVersion, null, null, null); } catch (Exception e) { if (_log.isWarnEnabled()) { _log.warn("Unable to update asset for file entry " + dlFileEntry.getFileEntryId() + ": " + e.getMessage()); } } } if (_log.isDebugEnabled()) { _log.debug("Assets verified for file entries"); } } } protected void updateFolderAssets() throws Exception { try (LoggingTimer loggingTimer = new LoggingTimer()) { List<DLFolder> dlFolders = _dlFolderLocalService.getNoAssetFolders(); if (_log.isDebugEnabled()) { _log.debug("Processing " + dlFolders.size() + " folders with no asset"); } for (DLFolder dlFolder : dlFolders) { Folder folder = new LiferayFolder(dlFolder); try { _dlAppHelperLocalService.updateAsset(dlFolder.getUserId(), folder, null, null, null); } catch (Exception e) { if (_log.isWarnEnabled()) { _log.warn("Unable to update asset for folder " + dlFolder.getFolderId() + ": " + e.getMessage()); } } } if (_log.isDebugEnabled()) { _log.debug("Assets verified for folders"); } } } private static final String _MS_OFFICE_2010_TEXT_XML_UTF8 = "text/xml; charset=\"utf-8\""; private static final Log _log = LogFactoryUtil.getLog(DLServiceVerifyProcess.class); private CounterLocalService _counterLocalService; private DLAppHelperLocalService _dlAppHelperLocalService; private DLFileEntryLocalService _dlFileEntryLocalService; private DLFileEntryMetadataLocalService _dlFileEntryMetadataLocalService; private DLFileEntryTypeLocalService _dlFileEntryTypeLocalService; private DLFileVersionLocalService _dlFileVersionLocalService; private DLFolderLocalService _dlFolderLocalService; @Reference private PortalInstancesLocalService _portalInstancesLocalService; }