com.liferay.journal.service.impl.JournalArticleLocalServiceImpl Maven / Gradle / Ivy
/**
* 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.journal.service.impl;
import com.liferay.asset.kernel.model.AssetEntry;
import com.liferay.asset.kernel.model.AssetLink;
import com.liferay.asset.kernel.model.AssetLinkConstants;
import com.liferay.document.library.kernel.util.DLUtil;
import com.liferay.dynamic.data.mapping.exception.NoSuchStructureException;
import com.liferay.dynamic.data.mapping.exception.NoSuchTemplateException;
import com.liferay.dynamic.data.mapping.exception.StorageFieldNameException;
import com.liferay.dynamic.data.mapping.exception.StorageFieldRequiredException;
import com.liferay.dynamic.data.mapping.exception.StructureDefinitionException;
import com.liferay.dynamic.data.mapping.model.DDMForm;
import com.liferay.dynamic.data.mapping.model.DDMFormField;
import com.liferay.dynamic.data.mapping.model.DDMStorageLink;
import com.liferay.dynamic.data.mapping.model.DDMStructure;
import com.liferay.dynamic.data.mapping.model.DDMTemplate;
import com.liferay.dynamic.data.mapping.model.LocalizedValue;
import com.liferay.dynamic.data.mapping.service.DDMStorageLinkLocalService;
import com.liferay.dynamic.data.mapping.service.DDMStructureLocalService;
import com.liferay.dynamic.data.mapping.service.DDMTemplateLinkLocalService;
import com.liferay.dynamic.data.mapping.service.DDMTemplateLocalService;
import com.liferay.dynamic.data.mapping.storage.Fields;
import com.liferay.dynamic.data.mapping.util.DDMXML;
import com.liferay.expando.kernel.util.ExpandoBridgeUtil;
import com.liferay.exportimport.content.processor.ExportImportContentProcessor;
import com.liferay.exportimport.content.processor.ExportImportContentProcessorRegistryUtil;
import com.liferay.exportimport.kernel.lar.ExportImportThreadLocal;
import com.liferay.journal.configuration.JournalGroupServiceConfiguration;
import com.liferay.journal.configuration.JournalServiceConfigurationValues;
import com.liferay.journal.constants.JournalConstants;
import com.liferay.journal.exception.ArticleContentException;
import com.liferay.journal.exception.ArticleDisplayDateException;
import com.liferay.journal.exception.ArticleExpirationDateException;
import com.liferay.journal.exception.ArticleIdException;
import com.liferay.journal.exception.ArticleReviewDateException;
import com.liferay.journal.exception.ArticleSmallImageNameException;
import com.liferay.journal.exception.ArticleSmallImageSizeException;
import com.liferay.journal.exception.ArticleTitleException;
import com.liferay.journal.exception.ArticleVersionException;
import com.liferay.journal.exception.DuplicateArticleIdException;
import com.liferay.journal.exception.InvalidDDMStructureException;
import com.liferay.journal.exception.NoSuchArticleException;
import com.liferay.journal.model.JournalArticle;
import com.liferay.journal.model.JournalArticleConstants;
import com.liferay.journal.model.JournalArticleDisplay;
import com.liferay.journal.model.JournalArticleResource;
import com.liferay.journal.model.JournalFolder;
import com.liferay.journal.model.impl.JournalArticleDisplayImpl;
import com.liferay.journal.service.base.JournalArticleLocalServiceBaseImpl;
import com.liferay.journal.service.permission.JournalPermission;
import com.liferay.journal.social.JournalActivityKeys;
import com.liferay.journal.util.comparator.ArticleIDComparator;
import com.liferay.journal.util.comparator.ArticleVersionComparator;
import com.liferay.journal.util.impl.JournalUtil;
import com.liferay.petra.xml.XMLUtil;
import com.liferay.portal.kernel.comment.CommentManagerUtil;
import com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery;
import com.liferay.portal.kernel.dao.orm.DynamicQuery;
import com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery;
import com.liferay.portal.kernel.dao.orm.Property;
import com.liferay.portal.kernel.dao.orm.PropertyFactoryUtil;
import com.liferay.portal.kernel.dao.orm.QueryDefinition;
import com.liferay.portal.kernel.dao.orm.QueryUtil;
import com.liferay.portal.kernel.dao.orm.RestrictionsFactoryUtil;
import com.liferay.portal.kernel.diff.DiffHtmlUtil;
import com.liferay.portal.kernel.exception.LocaleException;
import com.liferay.portal.kernel.exception.NoSuchImageException;
import com.liferay.portal.kernel.exception.NoSuchLayoutException;
import com.liferay.portal.kernel.exception.PortalException;
import com.liferay.portal.kernel.exception.SystemException;
import com.liferay.portal.kernel.json.JSONFactoryUtil;
import com.liferay.portal.kernel.json.JSONObject;
import com.liferay.portal.kernel.language.LanguageUtil;
import com.liferay.portal.kernel.log.Log;
import com.liferay.portal.kernel.log.LogFactoryUtil;
import com.liferay.portal.kernel.model.Company;
import com.liferay.portal.kernel.model.Group;
import com.liferay.portal.kernel.model.Image;
import com.liferay.portal.kernel.model.Layout;
import com.liferay.portal.kernel.model.ResourceConstants;
import com.liferay.portal.kernel.model.SystemEventConstants;
import com.liferay.portal.kernel.model.User;
import com.liferay.portal.kernel.module.configuration.ConfigurationException;
import com.liferay.portal.kernel.module.configuration.ConfigurationProvider;
import com.liferay.portal.kernel.notifications.UserNotificationDefinition;
import com.liferay.portal.kernel.portlet.PortletProvider;
import com.liferay.portal.kernel.portlet.PortletProviderUtil;
import com.liferay.portal.kernel.portlet.PortletRequestModel;
import com.liferay.portal.kernel.repository.model.FileEntry;
import com.liferay.portal.kernel.sanitizer.SanitizerUtil;
import com.liferay.portal.kernel.search.BaseModelSearchResult;
import com.liferay.portal.kernel.search.Field;
import com.liferay.portal.kernel.search.Hits;
import com.liferay.portal.kernel.search.Indexable;
import com.liferay.portal.kernel.search.IndexableType;
import com.liferay.portal.kernel.search.Indexer;
import com.liferay.portal.kernel.search.IndexerRegistryUtil;
import com.liferay.portal.kernel.search.QueryConfig;
import com.liferay.portal.kernel.search.SearchContext;
import com.liferay.portal.kernel.search.SearchException;
import com.liferay.portal.kernel.search.Sort;
import com.liferay.portal.kernel.service.ServiceContext;
import com.liferay.portal.kernel.service.ServiceContextUtil;
import com.liferay.portal.kernel.settings.GroupServiceSettingsLocator;
import com.liferay.portal.kernel.social.SocialActivityManagerUtil;
import com.liferay.portal.kernel.systemevent.SystemEvent;
import com.liferay.portal.kernel.systemevent.SystemEventHierarchyEntryThreadLocal;
import com.liferay.portal.kernel.template.TemplateConstants;
import com.liferay.portal.kernel.theme.ThemeDisplay;
import com.liferay.portal.kernel.transaction.TransactionCommitCallbackUtil;
import com.liferay.portal.kernel.util.ArrayUtil;
import com.liferay.portal.kernel.util.CalendarFactoryUtil;
import com.liferay.portal.kernel.util.CharPool;
import com.liferay.portal.kernel.util.Constants;
import com.liferay.portal.kernel.util.ContentTypes;
import com.liferay.portal.kernel.util.FileUtil;
import com.liferay.portal.kernel.util.GetterUtil;
import com.liferay.portal.kernel.util.GroupSubscriptionCheckSubscriptionSender;
import com.liferay.portal.kernel.util.HtmlUtil;
import com.liferay.portal.kernel.util.HttpUtil;
import com.liferay.portal.kernel.util.ListUtil;
import com.liferay.portal.kernel.util.LocaleUtil;
import com.liferay.portal.kernel.util.LocalizationUtil;
import com.liferay.portal.kernel.util.MathUtil;
import com.liferay.portal.kernel.util.ObjectValuePair;
import com.liferay.portal.kernel.util.OrderByComparator;
import com.liferay.portal.kernel.util.ParamUtil;
import com.liferay.portal.kernel.util.PortalUtil;
import com.liferay.portal.kernel.util.PortletKeys;
import com.liferay.portal.kernel.util.PropsKeys;
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.util.SubscriptionSender;
import com.liferay.portal.kernel.util.Time;
import com.liferay.portal.kernel.util.UnicodeProperties;
import com.liferay.portal.kernel.util.Validator;
import com.liferay.portal.kernel.webserver.WebServerServletTokenUtil;
import com.liferay.portal.kernel.workflow.WorkflowConstants;
import com.liferay.portal.kernel.workflow.WorkflowHandlerRegistryUtil;
import com.liferay.portal.kernel.xml.Document;
import com.liferay.portal.kernel.xml.DocumentException;
import com.liferay.portal.kernel.xml.Element;
import com.liferay.portal.kernel.xml.Node;
import com.liferay.portal.kernel.xml.SAXReaderUtil;
import com.liferay.portal.kernel.xml.XPath;
import com.liferay.portal.spring.extender.service.ServiceReference;
import com.liferay.portal.util.PrefsPropsUtil;
import com.liferay.social.kernel.model.SocialActivityConstants;
import com.liferay.trash.kernel.exception.RestoreEntryException;
import com.liferay.trash.kernel.exception.TrashEntryException;
import com.liferay.trash.kernel.model.TrashEntry;
import com.liferay.trash.kernel.model.TrashVersion;
import com.liferay.trash.kernel.util.TrashUtil;
import java.io.File;
import java.io.IOException;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.Calendar;
import java.util.Collections;
import java.util.Date;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
import java.util.concurrent.Callable;
import javax.portlet.PortletPreferences;
/**
* Provides the local service for accessing, adding, deleting, and updating web
* content articles.
*
* @author Brian Wing Shun Chan
* @author Raymond Augé
* @author Bruno Farache
* @author Juan Fernández
* @author Sergio González
*/
public class JournalArticleLocalServiceImpl
extends JournalArticleLocalServiceBaseImpl {
/**
* Adds a web content article with additional parameters.
*
*
* The web content articles hold HTML content wrapped in XML. The XML lets
* you specify the article's default locale and available locales. Here is a
* content example:
*
*
*
*
*
* <?xml version='1.0' encoding='UTF-8'?>
* <root default-locale="en_US" available-locales="en_US">
* <static-content language-id="en_US">
* <![CDATA[<p><b><i>test<i> content<b></p>]]>
* </static-content>
* </root>
*
*
*
*
* @param userId the primary key of the web content article's creator/owner
* @param groupId the primary key of the web content article's group
* @param folderId the primary key of the web content article folder
* @param classNameId the primary key of the DDMStructure class if the web
* content article is related to a DDM structure, the primary key of
* the class name associated with the article, or
* JournalArticleConstants.CLASSNAME_ID_DEFAULT in the journal-api
* module otherwise
* @param classPK the primary key of the DDM structure, if the primary key
* of the DDMStructure class is given as the
* classNameId parameter, the primary key of the class
* associated with the web content article, or 0
* otherwise
* @param articleId the primary key of the web content article
* @param autoArticleId whether to auto generate the web content article ID
* @param version the web content article's version
* @param titleMap the web content article's locales and localized titles
* @param descriptionMap the web content article's locales and localized
* descriptions
* @param content the HTML content wrapped in XML
* @param ddmStructureKey the primary key of the web content article's DDM
* structure, if the article is related to a DDM structure, or
* null otherwise
* @param ddmTemplateKey the primary key of the web content article's DDM
* template
* @param layoutUuid the unique string identifying the web content
* article's display page
* @param displayDateMonth the month the web content article is set to
* display
* @param displayDateDay the calendar day the web content article is set to
* display
* @param displayDateYear the year the web content article is set to
* display
* @param displayDateHour the hour the web content article is set to
* display
* @param displayDateMinute the minute the web content article is set to
* display
* @param expirationDateMonth the month the web content article is set to
* expire
* @param expirationDateDay the calendar day the web content article is set
* to expire
* @param expirationDateYear the year the web content article is set to
* expire
* @param expirationDateHour the hour the web content article is set to
* expire
* @param expirationDateMinute the minute the web content article is set to
* expire
* @param neverExpire whether the web content article is not set to auto
* expire
* @param reviewDateMonth the month the web content article is set for
* review
* @param reviewDateDay the calendar day the web content article is set for
* review
* @param reviewDateYear the year the web content article is set for review
* @param reviewDateHour the hour the web content article is set for review
* @param reviewDateMinute the minute the web content article is set for
* review
* @param neverReview whether the web content article is not set for review
* @param indexable whether the web content article is searchable
* @param smallImage whether the web content article has a small image
* @param smallImageURL the web content article's small image URL
* @param smallImageFile the web content article's small image file
* @param images the web content's images
* @param articleURL the web content article's accessible URL
* @param serviceContext the service context to be applied. Can set the
* UUID, creation date, modification date, expando bridge
* attributes, guest permissions, group permissions, asset category
* IDs, asset tag names, asset link entry IDs, URL title, and
* workflow actions for the web content article. Can also set
* whether to add the default guest and group permissions.
* @return the web content article
*/
@Indexable(type = IndexableType.REINDEX)
@Override
public JournalArticle addArticle(
long userId, long groupId, long folderId, long classNameId,
long classPK, String articleId, boolean autoArticleId,
double version, Map titleMap,
Map descriptionMap, String content,
String ddmStructureKey, String ddmTemplateKey, String layoutUuid,
int displayDateMonth, int displayDateDay, int displayDateYear,
int displayDateHour, int displayDateMinute, int expirationDateMonth,
int expirationDateDay, int expirationDateYear,
int expirationDateHour, int expirationDateMinute,
boolean neverExpire, int reviewDateMonth, int reviewDateDay,
int reviewDateYear, int reviewDateHour, int reviewDateMinute,
boolean neverReview, boolean indexable, boolean smallImage,
String smallImageURL, File smallImageFile,
Map images, String articleURL,
ServiceContext serviceContext)
throws PortalException {
// Article
User user = userPersistence.findByPrimaryKey(userId);
articleId = StringUtil.toUpperCase(articleId.trim());
Date displayDate = null;
Date expirationDate = null;
Date reviewDate = null;
if (classNameId == JournalArticleConstants.CLASSNAME_ID_DEFAULT) {
displayDate = PortalUtil.getDate(
displayDateMonth, displayDateDay, displayDateYear,
displayDateHour, displayDateMinute, user.getTimeZone(),
ArticleDisplayDateException.class);
if (!neverExpire) {
expirationDate = PortalUtil.getDate(
expirationDateMonth, expirationDateDay, expirationDateYear,
expirationDateHour, expirationDateMinute,
user.getTimeZone(), ArticleExpirationDateException.class);
}
if (!neverReview) {
reviewDate = PortalUtil.getDate(
reviewDateMonth, reviewDateDay, reviewDateYear,
reviewDateHour, reviewDateMinute, user.getTimeZone(),
ArticleReviewDateException.class);
}
}
byte[] smallImageBytes = null;
try {
smallImageBytes = FileUtil.getBytes(smallImageFile);
}
catch (IOException ioe) {
}
Date now = new Date();
validateDDMStructureId(groupId, folderId, ddmStructureKey);
if (autoArticleId) {
articleId = String.valueOf(counterLocalService.increment());
}
validate(
user.getCompanyId(), groupId, classNameId, articleId, autoArticleId,
version, titleMap, content, ddmStructureKey, ddmTemplateKey,
displayDate, expirationDate, smallImage, smallImageURL,
smallImageFile, smallImageBytes, serviceContext);
validateReferences(
groupId, ddmStructureKey, ddmTemplateKey, layoutUuid, smallImage,
smallImageURL, smallImageBytes, 0, content);
serviceContext.setAttribute("articleId", articleId);
long id = counterLocalService.increment();
String articleResourceUuid = GetterUtil.getString(
serviceContext.getAttribute("articleResourceUuid"));
long resourcePrimKey =
journalArticleResourceLocalService.getArticleResourcePrimKey(
articleResourceUuid, groupId, articleId);
JournalArticle article = journalArticlePersistence.create(id);
Locale locale = getArticleDefaultLocale(content);
String title = titleMap.get(locale);
content = format(
user, groupId, articleId, version, false, content, images);
article.setUuid(serviceContext.getUuid());
article.setResourcePrimKey(resourcePrimKey);
article.setGroupId(groupId);
article.setCompanyId(user.getCompanyId());
article.setUserId(user.getUserId());
article.setUserName(user.getFullName());
article.setFolderId(folderId);
article.setClassNameId(classNameId);
article.setClassPK(classPK);
article.setTreePath(article.buildTreePath());
article.setArticleId(articleId);
article.setVersion(version);
article.setTitleMap(titleMap, locale);
article.setUrlTitle(
getUniqueUrlTitle(
id, groupId, articleId, title, null, serviceContext));
article.setDescriptionMap(descriptionMap, locale);
article.setContent(content);
article.setDDMStructureKey(ddmStructureKey);
article.setDDMTemplateKey(ddmTemplateKey);
article.setLayoutUuid(layoutUuid);
article.setDisplayDate(displayDate);
article.setExpirationDate(expirationDate);
article.setReviewDate(reviewDate);
article.setIndexable(indexable);
article.setSmallImage(smallImage);
article.setSmallImageId(counterLocalService.increment());
article.setSmallImageURL(smallImageURL);
if ((expirationDate == null) || expirationDate.after(now)) {
article.setStatus(WorkflowConstants.STATUS_DRAFT);
}
else {
article.setStatus(WorkflowConstants.STATUS_EXPIRED);
}
article.setStatusByUserId(userId);
article.setStatusDate(serviceContext.getModifiedDate(now));
article.setExpandoBridgeAttributes(serviceContext);
journalArticlePersistence.update(article);
// Resources
if (serviceContext.isAddGroupPermissions() ||
serviceContext.isAddGuestPermissions()) {
addArticleResources(
article, serviceContext.isAddGroupPermissions(),
serviceContext.isAddGuestPermissions());
}
else {
addArticleResources(
article, serviceContext.getGroupPermissions(),
serviceContext.getGuestPermissions());
}
// Small image
saveImages(
smallImage, article.getSmallImageId(), smallImageFile,
smallImageBytes);
// Asset
updateAsset(
userId, article, serviceContext.getAssetCategoryIds(),
serviceContext.getAssetTagNames(),
serviceContext.getAssetLinkEntryIds(),
serviceContext.getAssetPriority());
// Dynamic data mapping
if (classNameLocalService.getClassNameId(DDMStructure.class) ==
classNameId) {
updateDDMStructurePredefinedValues(
classPK, content, serviceContext);
}
else {
updateDDMLinks(id, groupId, ddmStructureKey, ddmTemplateKey, true);
}
// Email
PortletPreferences preferences =
ServiceContextUtil.getPortletPreferences(serviceContext);
articleURL = buildArticleURL(articleURL, groupId, folderId, articleId);
serviceContext.setAttribute("articleURL", articleURL);
sendEmail(
article, articleURL, preferences, "requested", serviceContext);
// Workflow
if (classNameId == JournalArticleConstants.CLASSNAME_ID_DEFAULT) {
startWorkflowInstance(userId, article, serviceContext);
}
else {
updateStatus(
userId, article, WorkflowConstants.STATUS_APPROVED, null,
serviceContext, new HashMap());
}
return journalArticlePersistence.findByPrimaryKey(article.getId());
}
/**
* Adds a web content article.
*
* @param userId the primary key of the web content article's creator/owner
* @param groupId the primary key of the web content article's group
* @param folderId the primary key of the web content article folder
* @param titleMap the web content article's locales and localized titles
* @param descriptionMap the web content article's locales and localized
* descriptions
* @param content the HTML content wrapped in XML. For more information,
* see the content example in the {@link #addArticle(long, long,
* long, long, long, String, boolean, double, Map, Map, String,
* String, String, String, int, int, int, int, int, int, int, int,
* int, int, boolean, int, int, int, int, int, boolean, boolean,
* boolean, String, File, Map, String, ServiceContext)} description.
* @param ddmStructureKey the primary key of the web content article's DDM
* structure, if the article is related to a DDM structure, or
* null otherwise
* @param ddmTemplateKey the primary key of the web content article's DDM
* template
* @param serviceContext the service context to be applied. Can set the
* UUID, creation date, modification date, expando bridge
* attributes, guest permissions, group permissions, asset category
* IDs, asset tag names, asset link entry IDs, asset priority, URL
* title, and workflow actions for the web content article. Can also
* set whether to add the default guest and group permissions.
* @return the web content article
*/
@Override
public JournalArticle addArticle(
long userId, long groupId, long folderId,
Map titleMap, Map descriptionMap,
String content, String ddmStructureKey, String ddmTemplateKey,
ServiceContext serviceContext)
throws PortalException {
User user = userPersistence.findByPrimaryKey(userId);
Calendar calendar = CalendarFactoryUtil.getCalendar(user.getTimeZone());
int displayDateMonth = calendar.get(Calendar.MONTH);
int displayDateDay = calendar.get(Calendar.DAY_OF_MONTH);
int displayDateYear = calendar.get(Calendar.YEAR);
int displayDateHour = calendar.get(Calendar.HOUR_OF_DAY);
int displayDateMinute = calendar.get(Calendar.MINUTE);
return journalArticleLocalService.addArticle(
userId, groupId, folderId,
JournalArticleConstants.CLASSNAME_ID_DEFAULT, 0, StringPool.BLANK,
true, 1, titleMap, descriptionMap, content, ddmStructureKey,
ddmTemplateKey, null, displayDateMonth, displayDateDay,
displayDateYear, displayDateHour, displayDateMinute, 0, 0, 0, 0, 0,
true, 0, 0, 0, 0, 0, true, true, false, null, null, null, null,
serviceContext);
}
/**
* Adds the resources to the web content article.
*
* @param article the web content article
* @param addGroupPermissions whether to add group permissions
* @param addGuestPermissions whether to add guest permissions
*/
@Override
public void addArticleResources(
JournalArticle article, boolean addGroupPermissions,
boolean addGuestPermissions)
throws PortalException {
resourceLocalService.addResources(
article.getCompanyId(), article.getGroupId(), article.getUserId(),
JournalArticle.class.getName(), article.getResourcePrimKey(), false,
addGroupPermissions, addGuestPermissions);
}
/**
* Adds the model resources with the permissions to the web content article.
*
* @param article the web content article to add resources to
* @param groupPermissions the group permissions to be added
* @param guestPermissions the guest permissions to be added
*/
@Override
public void addArticleResources(
JournalArticle article, String[] groupPermissions,
String[] guestPermissions)
throws PortalException {
resourceLocalService.addModelResources(
article.getCompanyId(), article.getGroupId(), article.getUserId(),
JournalArticle.class.getName(), article.getResourcePrimKey(),
groupPermissions, guestPermissions);
}
/**
* Adds the resources to the most recently created web content article.
*
* @param groupId the primary key of the web content article's group
* @param articleId the primary key of the web content article
* @param addGroupPermissions whether to add group permissions
* @param addGuestPermissions whether to add guest permissions
*/
@Override
public void addArticleResources(
long groupId, String articleId, boolean addGroupPermissions,
boolean addGuestPermissions)
throws PortalException {
JournalArticle article = getLatestArticle(groupId, articleId);
addArticleResources(article, addGroupPermissions, addGuestPermissions);
}
/**
* Adds the resources with the permissions to the most recently created web
* content article.
*
* @param groupId the primary key of the web content article's group
* @param articleId the primary key of the web content article
* @param groupPermissions the group permissions to be added
* @param guestPermissions the guest permissions to be added
*/
@Override
public void addArticleResources(
long groupId, String articleId, String[] groupPermissions,
String[] guestPermissions)
throws PortalException {
JournalArticle article = getLatestArticle(groupId, articleId);
addArticleResources(article, groupPermissions, guestPermissions);
}
/**
* Returns the web content article with the group, article ID, and version.
* This method checks for the article's resource primary key and, if not
* found, creates a new one.
*
* @param groupId the primary key of the web content article's group
* @param articleId the primary key of the web content article
* @param version the web content article's version
* @return the matching web content article
*/
@Override
public JournalArticle checkArticleResourcePrimKey(
long groupId, String articleId, double version)
throws PortalException {
JournalArticle article = journalArticlePersistence.findByG_A_V(
groupId, articleId, version);
if (article.getResourcePrimKey() > 0) {
return article;
}
long resourcePrimKey =
journalArticleResourceLocalService.getArticleResourcePrimKey(
groupId, articleId);
article.setResourcePrimKey(resourcePrimKey);
journalArticlePersistence.update(article);
return article;
}
/**
* Checks all web content articles by handling their expirations and sending
* review notifications based on their current workflow.
*/
@Override
public void checkArticles() throws PortalException {
Date now = new Date();
checkArticlesByExpirationDate(now);
checkArticlesByReviewDate(now);
checkArticlesByDisplayDate(now);
_previousCheckDate = now;
}
/**
* Checks the web content article matching the group, article ID, and
* version, replacing escaped newline and return characters with non-escaped
* newline and return characters.
*
* @param groupId the primary key of the web content article's group
* @param articleId the primary key of the web content article
* @param version the web content article's version
*/
@Override
public void checkNewLine(long groupId, String articleId, double version)
throws PortalException {
JournalArticle article = journalArticlePersistence.findByG_A_V(
groupId, articleId, version);
String content = GetterUtil.getString(article.getContent());
if (content.contains("\\n")) {
content = StringUtil.replace(
content, new String[] {"\\n", "\\r"},
new String[] {"\n", "\r"});
article.setContent(content);
journalArticlePersistence.update(article);
}
}
/**
* Checks the web content article matching the group, article ID, and
* version for an associated structure. If no structure is associated,
* return; otherwise check that the article and structure match.
*
* @param groupId the primary key of the web content article's group
* @param articleId the primary key of the web content article
* @param version the web content article's version
*/
@Override
public void checkStructure(long groupId, String articleId, double version)
throws PortalException {
JournalArticle article = journalArticlePersistence.findByG_A_V(
groupId, articleId, version);
checkStructure(article);
}
/**
* Copies the web content article matching the group, article ID, and
* version. This method creates a new article, extracting all the values
* from the old one and updating its article ID.
*
* @param userId the primary key of the web content article's creator/owner
* @param groupId the primary key of the web content article's group
* @param oldArticleId the primary key of the old web content article
* @param newArticleId the primary key of the new web content article
* @param autoArticleId whether to auto-generate the web content article ID
* @param version the web content article's version
* @return the new web content article
*/
@Indexable(type = IndexableType.REINDEX)
@Override
public JournalArticle copyArticle(
long userId, long groupId, String oldArticleId, String newArticleId,
boolean autoArticleId, double version)
throws PortalException {
// Article
User user = userPersistence.findByPrimaryKey(userId);
oldArticleId = StringUtil.toUpperCase(oldArticleId.trim());
newArticleId = StringUtil.toUpperCase(newArticleId.trim());
JournalArticle oldArticle = journalArticlePersistence.findByG_A_V(
groupId, oldArticleId, version);
if (autoArticleId) {
newArticleId = String.valueOf(counterLocalService.increment());
}
else {
validate(newArticleId);
if (journalArticlePersistence.countByG_A(groupId, newArticleId) >
0) {
StringBundler sb = new StringBundler(5);
sb.append("{groupId=");
sb.append(groupId);
sb.append(", articleId=");
sb.append(newArticleId);
sb.append("}");
throw new DuplicateArticleIdException(sb.toString());
}
}
long id = counterLocalService.increment();
long resourcePrimKey =
journalArticleResourceLocalService.getArticleResourcePrimKey(
groupId, newArticleId);
JournalArticle newArticle = journalArticlePersistence.create(id);
newArticle.setResourcePrimKey(resourcePrimKey);
newArticle.setGroupId(groupId);
newArticle.setCompanyId(user.getCompanyId());
newArticle.setUserId(user.getUserId());
newArticle.setUserName(user.getFullName());
newArticle.setFolderId(oldArticle.getFolderId());
newArticle.setTreePath(oldArticle.getTreePath());
newArticle.setArticleId(newArticleId);
newArticle.setVersion(JournalArticleConstants.VERSION_DEFAULT);
newArticle.setTitle(oldArticle.getTitle());
newArticle.setUrlTitle(
getUniqueUrlTitle(
id, groupId, newArticleId, oldArticle.getTitleCurrentValue()));
newArticle.setDescription(oldArticle.getDescription());
try {
copyArticleImages(oldArticle, newArticle);
}
catch (Exception e) {
newArticle.setContent(oldArticle.getContent());
}
newArticle.setDDMStructureKey(oldArticle.getDDMStructureKey());
newArticle.setDDMTemplateKey(oldArticle.getDDMTemplateKey());
newArticle.setLayoutUuid(oldArticle.getLayoutUuid());
newArticle.setDisplayDate(oldArticle.getDisplayDate());
newArticle.setExpirationDate(oldArticle.getExpirationDate());
newArticle.setReviewDate(oldArticle.getReviewDate());
newArticle.setIndexable(oldArticle.isIndexable());
newArticle.setSmallImage(oldArticle.isSmallImage());
newArticle.setSmallImageId(counterLocalService.increment());
newArticle.setSmallImageURL(oldArticle.getSmallImageURL());
if (oldArticle.isPending() ||
workflowDefinitionLinkLocalService.hasWorkflowDefinitionLink(
user.getCompanyId(), groupId, JournalArticle.class.getName())) {
newArticle.setStatus(WorkflowConstants.STATUS_DRAFT);
}
else {
newArticle.setStatus(oldArticle.getStatus());
}
ExpandoBridgeUtil.copyExpandoBridgeAttributes(
oldArticle.getExpandoBridge(), newArticle.getExpandoBridge());
journalArticlePersistence.update(newArticle);
// Resources
addArticleResources(newArticle, true, true);
// Small image
if (oldArticle.isSmallImage()) {
Image image = imageLocalService.fetchImage(
oldArticle.getSmallImageId());
if (image != null) {
byte[] smallImageBytes = image.getTextObj();
imageLocalService.updateImage(
newArticle.getSmallImageId(), smallImageBytes);
}
}
// Asset
long[] assetCategoryIds = assetCategoryLocalService.getCategoryIds(
JournalArticle.class.getName(), oldArticle.getResourcePrimKey());
String[] assetTagNames = assetTagLocalService.getTagNames(
JournalArticle.class.getName(), oldArticle.getResourcePrimKey());
AssetEntry oldAssetEntry = assetEntryLocalService.getEntry(
JournalArticle.class.getName(), oldArticle.getResourcePrimKey());
List assetLinks = assetLinkLocalService.getDirectLinks(
oldAssetEntry.getEntryId(), false);
long[] assetLinkEntryIds = ListUtil.toLongArray(
assetLinks, AssetLink.ENTRY_ID2_ACCESSOR);
updateAsset(
userId, newArticle, assetCategoryIds, assetTagNames,
assetLinkEntryIds, oldAssetEntry.getPriority());
// Dynamic data mapping
updateDDMLinks(
id, groupId, oldArticle.getDDMStructureKey(),
oldArticle.getDDMTemplateKey(), true);
return newArticle;
}
/**
* Deletes the web content article and its resources.
*
* @param article the web content article
* @return the deleted web content article
*/
@Override
@SystemEvent(
action = SystemEventConstants.ACTION_SKIP, send = false,
type = SystemEventConstants.TYPE_DELETE
)
public JournalArticle deleteArticle(JournalArticle article)
throws PortalException {
return journalArticleLocalService.deleteArticle(
article, StringPool.BLANK, null);
}
/**
* Deletes the web content article and its resources, optionally sending
* email notifying denial of the article if it had not yet been approved.
*
* @param article the web content article
* @param articleURL the web content article's accessible URL to include in
* email notifications (optionally null)
* @param serviceContext the service context to be applied (optionally
* null). Can set the portlet preferences that include
* email information to notify recipients of the unapproved web
* content's denial.
* @return the deleted web content article
*/
@Indexable(type = IndexableType.DELETE)
@Override
@SystemEvent(
action = SystemEventConstants.ACTION_SKIP, send = false,
type = SystemEventConstants.TYPE_DELETE
)
public JournalArticle deleteArticle(
JournalArticle article, String articleURL,
ServiceContext serviceContext)
throws PortalException {
JournalArticleResource articleResource =
journalArticleResourceLocalService.fetchArticleResource(
article.getGroupId(), article.getArticleId());
if (article.isApproved() &&
isLatestVersion(
article.getGroupId(), article.getArticleId(),
article.getVersion(), WorkflowConstants.STATUS_APPROVED)) {
updatePreviousApprovedArticle(article);
}
// Email
if ((serviceContext != null) && Validator.isNotNull(articleURL)) {
PortletPreferences preferences =
ServiceContextUtil.getPortletPreferences(serviceContext);
if ((preferences != null) && !article.isApproved() &&
isLatestVersion(
article.getGroupId(), article.getArticleId(),
article.getVersion())) {
articleURL = buildArticleURL(
articleURL, article.getGroupId(), article.getFolderId(),
article.getArticleId());
sendEmail(
article, articleURL, preferences, "denied", serviceContext);
}
}
// Images
String articleId = article.getArticleId();
if (article.isInTrash()) {
articleId = TrashUtil.getOriginalTitle(article.getArticleId());
}
journalArticleImageLocalService.deleteImages(
article.getGroupId(), articleId, article.getVersion());
// Dynamic data mapping
if (article.getClassNameId() !=
classNameLocalService.getClassNameId(DDMStructure.class)) {
ddmStorageLinkLocalService.deleteClassStorageLink(article.getId());
ddmTemplateLinkLocalService.deleteTemplateLink(
classNameLocalService.getClassNameId(JournalArticle.class),
article.getId());
}
// Expando
expandoRowLocalService.deleteRows(article.getId());
// Trash
if (article.isInTrash()) {
TrashEntry trashEntry = article.getTrashEntry();
if (trashEntry != null) {
trashVersionLocalService.deleteTrashVersion(
JournalArticle.class.getName(), article.getId());
}
}
// Workflow
if (!article.isDraft()) {
workflowInstanceLinkLocalService.deleteWorkflowInstanceLink(
article.getCompanyId(), article.getGroupId(),
JournalArticle.class.getName(), article.getId());
}
int articlesCount = journalArticlePersistence.countByG_A(
article.getGroupId(), article.getArticleId());
if (articlesCount == 1) {
// Asset
assetEntryLocalService.deleteEntry(
JournalArticle.class.getName(), article.getResourcePrimKey());
// Comment
CommentManagerUtil.deleteDiscussion(
JournalArticle.class.getName(), article.getResourcePrimKey());
// Content searches
journalContentSearchLocalService.deleteArticleContentSearches(
article.getGroupId(), article.getArticleId());
// Ratings
ratingsStatsLocalService.deleteStats(
JournalArticle.class.getName(), article.getResourcePrimKey());
// Small image
imageLocalService.deleteImage(article.getSmallImageId());
// Trash
trashEntryLocalService.deleteEntry(
JournalArticle.class.getName(), article.getResourcePrimKey());
// Resources
resourceLocalService.deleteResource(
article.getCompanyId(), JournalArticle.class.getName(),
ResourceConstants.SCOPE_INDIVIDUAL,
article.getResourcePrimKey());
// Resource
if (articleResource != null) {
journalArticleResourceLocalService.deleteJournalArticleResource(
articleResource);
}
}
// Article
journalArticlePersistence.remove(article);
// System event
if (articleResource != null) {
JSONObject extraDataJSONObject = JSONFactoryUtil.createJSONObject();
extraDataJSONObject.put("uuid", article.getUuid());
extraDataJSONObject.put("version", article.getVersion());
systemEventLocalService.addSystemEvent(
0, article.getGroupId(), article.getModelClassName(),
article.getPrimaryKey(), articleResource.getUuid(), null,
SystemEventConstants.TYPE_DELETE,
extraDataJSONObject.toString());
}
return article;
}
/**
* Deletes the web content article and its resources matching the group,
* article ID, and version, optionally sending email notifying denial of the
* web content article if it had not yet been approved.
*
* @param groupId the primary key of the web content article's group
* @param articleId the primary key of the web content article
* @param version the web content article's version
* @param articleURL the web content article's accessible URL
* @param serviceContext the service context to be applied. Can set the
* portlet preferences that include email information to notify
* recipients of the unapproved web content article's denial.
* @return the deleted web content article
*/
@Override
public JournalArticle deleteArticle(
long groupId, String articleId, double version, String articleURL,
ServiceContext serviceContext)
throws PortalException {
JournalArticle article = journalArticlePersistence.findByG_A_V(
groupId, articleId, version);
return journalArticleLocalService.deleteArticle(
article, articleURL, serviceContext);
}
/**
* Deletes all web content articles and their resources matching the group
* and article ID, optionally sending email notifying denial of article if
* it had not yet been approved.
*
* @param groupId the primary key of the web content article's group
* @param articleId the primary key of the web content article
* @param serviceContext the service context to be applied. Can set the
* portlet preferences that include email information to notify
* recipients of the unapproved web content article's denial.
*/
@Override
public void deleteArticle(
long groupId, String articleId, ServiceContext serviceContext)
throws PortalException {
SystemEventHierarchyEntryThreadLocal.push(JournalArticle.class);
JournalArticleResource articleResource =
journalArticleResourceLocalService.fetchArticleResource(
groupId, articleId);
try {
List articles = journalArticlePersistence.findByG_A(
groupId, articleId, QueryUtil.ALL_POS, QueryUtil.ALL_POS,
new ArticleVersionComparator(true));
for (JournalArticle article : articles) {
journalArticleLocalService.deleteArticle(
article, null, serviceContext);
}
}
finally {
SystemEventHierarchyEntryThreadLocal.pop(JournalArticle.class);
}
if (articleResource != null) {
systemEventLocalService.addSystemEvent(
0, groupId, JournalArticle.class.getName(),
articleResource.getResourcePrimKey(), articleResource.getUuid(),
null, SystemEventConstants.TYPE_DELETE, StringPool.BLANK);
}
}
/**
* Deletes all the group's web content articles and resources.
*
* @param groupId the primary key of the web content article's group
*/
@Override
public void deleteArticles(long groupId) throws PortalException {
SystemEventHierarchyEntryThreadLocal.push(JournalArticle.class);
List articleResources = new ArrayList<>();
try {
JournalArticleResource articleResource = null;
for (JournalArticle article :
journalArticlePersistence.findByGroupId(groupId)) {
if ((articleResource == null) ||
(articleResource.getPrimaryKey() !=
article.getResourcePrimKey())) {
articleResource =
journalArticleResourceLocalService.getArticleResource(
article.getResourcePrimKey());
articleResources.add(articleResource);
}
journalArticleLocalService.deleteArticle(article, null, null);
}
}
finally {
SystemEventHierarchyEntryThreadLocal.pop(JournalArticle.class);
}
for (JournalArticleResource articleResource : articleResources) {
systemEventLocalService.addSystemEvent(
0, groupId, JournalArticle.class.getName(),
articleResource.getResourcePrimKey(), articleResource.getUuid(),
null, SystemEventConstants.TYPE_DELETE, StringPool.BLANK);
}
}
/**
* Deletes all the group's web content articles and resources in the folder,
* including recycled articles.
*
* @param groupId the primary key of the web content article's group
* @param folderId the primary key of the web content article folder
*/
@Override
public void deleteArticles(long groupId, long folderId)
throws PortalException {
deleteArticles(groupId, folderId, true);
}
/**
* Deletes all the group's web content articles and resources in the folder,
* optionally including recycled articles.
*
* @param groupId the primary key of the web content article's group
* @param folderId the primary key of the web content article folder
* @param includeTrashedEntries whether to include recycled web content
* articles
*/
@Override
public void deleteArticles(
long groupId, long folderId, boolean includeTrashedEntries)
throws PortalException {
SystemEventHierarchyEntryThreadLocal.push(JournalArticle.class);
List articleResources = new ArrayList<>();
try {
JournalArticleResource articleResource = null;
for (JournalArticle article :
journalArticlePersistence.findByG_F(groupId, folderId)) {
if ((articleResource == null) ||
(articleResource.getPrimaryKey() !=
article.getResourcePrimKey())) {
articleResource =
journalArticleResourceLocalService.getArticleResource(
article.getResourcePrimKey());
articleResources.add(articleResource);
}
if (includeTrashedEntries || !article.isInTrashExplicitly()) {
journalArticleLocalService.deleteArticle(
article, null, null);
}
else {
articleResources.remove(articleResource);
}
}
}
finally {
SystemEventHierarchyEntryThreadLocal.pop(JournalArticle.class);
}
for (JournalArticleResource articleResource : articleResources) {
systemEventLocalService.addSystemEvent(
0, groupId, JournalArticle.class.getName(),
articleResource.getResourcePrimKey(), articleResource.getUuid(),
null, SystemEventConstants.TYPE_DELETE, StringPool.BLANK);
}
}
/**
* Deletes all the group's web content articles and resources matching the
* class name and class primary key.
*
* @param groupId the primary key of the web content article's group
* @param className the DDMStructure class name if the web content article
* is related to a DDM structure, the primary key of the class name
* associated with the article, or
* JournalArticleConstants.CLASSNAME_ID_DEFAULT in the journal-api
* module otherwise
* @param classPK the primary key of the DDM structure, if the DDMStructure
* class name is given as the className parameter, the
* primary key of the class associated with the web content article,
* or 0 otherwise
*/
@Override
public void deleteArticles(long groupId, String className, long classPK)
throws PortalException {
long classNameId = classNameLocalService.getClassNameId(className);
List articles = journalArticlePersistence.findByG_C_C(
groupId, classNameId, classPK);
for (JournalArticle article : articles) {
journalArticleLocalService.deleteArticle(article, null, null);
}
}
/**
* Deletes the layout's association with the web content articles for the
* group.
*
* @param groupId the primary key of the web content article's group
* @param layoutUuid the unique string identifying the web content article's
* display page
*/
@Override
public void deleteLayoutArticleReferences(long groupId, String layoutUuid) {
List articles = journalArticlePersistence.findByG_L(
groupId, layoutUuid);
for (JournalArticle article : articles) {
article.setLayoutUuid(StringPool.BLANK);
journalArticlePersistence.update(article);
}
}
/**
* Expires the web content article matching the group, article ID, and
* version.
*
* @param userId the primary key of the user updating the web content
* article
* @param groupId the primary key of the web content article's group
* @param articleId the primary key of the web content article
* @param version the web content article's version
* @param articleURL the web content article's accessible URL
* @param serviceContext the service context to be applied. Can set the
* modification date, status date, portlet preferences, and can set
* whether to add the default command update for the web content
* article. With respect to social activities, by setting the
* service context's command to {@link Constants#UPDATE}, the
* invocation is considered a web content update activity; otherwise
* it is considered a web content add activity.
* @return the web content article
*/
@Indexable(type = IndexableType.REINDEX)
@Override
public JournalArticle expireArticle(
long userId, long groupId, String articleId, double version,
String articleURL, ServiceContext serviceContext)
throws PortalException {
return updateStatus(
userId, groupId, articleId, version,
WorkflowConstants.STATUS_EXPIRED, articleURL,
new HashMap(), serviceContext);
}
/**
* Expires the web content article matching the group and article ID,
* expiring all of its versions if the
* journal.article.expire.all.versions portal property is
* true, otherwise expiring only its latest approved version.
*
* @param userId the primary key of the user updating the web content
* article
* @param groupId the primary key of the web content article's group
* @param articleId the primary key of the web content article
* @param articleURL the web content article's accessible URL
* @param serviceContext the service context to be applied. Can set the
* modification date, status date, portlet preferences, and can set
* whether to add the default command update for the web content
* article. With respect to social activities, by setting the service
* context's command to {@link Constants#UPDATE}, the invocation is
* considered a web content update activity; otherwise it is
* considered a web content add activity.
*/
@Override
public void expireArticle(
long userId, long groupId, String articleId, String articleURL,
ServiceContext serviceContext)
throws PortalException {
if (JournalServiceConfigurationValues.
JOURNAL_ARTICLE_EXPIRE_ALL_VERSIONS) {
List articles = journalArticlePersistence.findByG_A(
groupId, articleId, QueryUtil.ALL_POS, QueryUtil.ALL_POS,
new ArticleVersionComparator(true));
for (JournalArticle article : articles) {
journalArticleLocalService.expireArticle(
userId, groupId, article.getArticleId(),
article.getVersion(), articleURL, serviceContext);
}
}
else {
JournalArticle article = getLatestArticle(
groupId, articleId, WorkflowConstants.STATUS_APPROVED);
journalArticleLocalService.expireArticle(
userId, groupId, article.getArticleId(), article.getVersion(),
articleURL, serviceContext);
}
}
@Override
public JournalArticle fetchArticle(long groupId, String articleId) {
// Get the latest article that is approved, if none are approved, get
// the latest unapproved article
JournalArticle article = fetchLatestArticle(
groupId, articleId, WorkflowConstants.STATUS_APPROVED);
if (article != null) {
return article;
}
return fetchLatestArticle(
groupId, articleId, WorkflowConstants.STATUS_ANY);
}
/**
* Returns the web content article matching the group, article ID, and
* version.
*
* @param groupId the primary key of the web content article's group
* @param articleId the primary key of the web content article
* @param version the web content article's version
* @return the web content article matching the group, article ID, and
* version, or null if no web content article could be
* found
*/
@Override
public JournalArticle fetchArticle(
long groupId, String articleId, double version) {
return journalArticlePersistence.fetchByG_A_V(
groupId, articleId, version);
}
@Override
public JournalArticle fetchArticleByUrlTitle(
long groupId, String urlTitle) {
JournalArticle article = fetchLatestArticleByUrlTitle(
groupId, urlTitle, WorkflowConstants.STATUS_APPROVED);
if (article != null) {
return article;
}
return fetchLatestArticleByUrlTitle(
groupId, urlTitle, WorkflowConstants.STATUS_ANY);
}
@Override
public JournalArticle fetchDisplayArticle(long groupId, String articleId) {
List articles = journalArticlePersistence.findByG_A_ST(
groupId, articleId, WorkflowConstants.STATUS_APPROVED);
if (articles.isEmpty()) {
return null;
}
Date now = new Date();
for (JournalArticle article : articles) {
Date displayDate = article.getDisplayDate();
Date expirationDate = article.getExpirationDate();
if (((displayDate == null) || displayDate.before(now)) &&
((expirationDate == null) || expirationDate.after(now))) {
return article;
}
}
return articles.get(0);
}
@Override
public JournalArticle fetchLatestArticle(long resourcePrimKey) {
return fetchLatestArticle(
resourcePrimKey, WorkflowConstants.STATUS_ANY);
}
@Override
public JournalArticle fetchLatestArticle(long resourcePrimKey, int status) {
return fetchLatestArticle(resourcePrimKey, status, true);
}
/**
* Returns the latest web content article matching the resource primary key
* and workflow status, optionally preferring articles with approved
* workflow status.
*
* @param resourcePrimKey the primary key of the resource instance
* @param status the web content article's workflow status. For more
* information see {@link WorkflowConstants} for constants starting
* with the "STATUS_" prefix.
* @param preferApproved whether to prefer returning the latest matching
* article that has workflow status {@link
* WorkflowConstants#STATUS_APPROVED} over returning one that has a
* different status
* @return the latest web content article matching the resource primary key
* and workflow status, optionally preferring articles with an
* approved workflow status, or null if no matching web
* content article could be found
*/
@Override
public JournalArticle fetchLatestArticle(
long resourcePrimKey, int status, boolean preferApproved) {
JournalArticle article = null;
OrderByComparator orderByComparator =
new ArticleVersionComparator();
if (status == WorkflowConstants.STATUS_ANY) {
if (preferApproved) {
article = journalArticlePersistence.fetchByR_ST_First(
resourcePrimKey, WorkflowConstants.STATUS_APPROVED,
orderByComparator);
}
if (article == null) {
article =
journalArticlePersistence.fetchByResourcePrimKey_First(
resourcePrimKey, orderByComparator);
}
}
else {
article = journalArticlePersistence.fetchByR_ST_First(
resourcePrimKey, status, orderByComparator);
}
return article;
}
@Override
public JournalArticle fetchLatestArticle(
long resourcePrimKey, int[] statuses) {
OrderByComparator orderByComparator =
new ArticleVersionComparator();
List articles = journalArticlePersistence.findByR_ST(
resourcePrimKey, statuses, 0, 1, orderByComparator);
if (!articles.isEmpty()) {
return articles.get(0);
}
return null;
}
/**
* Returns the latest web content article matching the group, article ID,
* and workflow status.
*
* @param groupId the primary key of the web content article's group
* @param articleId the primary key of the web content article
* @param status the web content article's workflow status. For more
* information see {@link WorkflowConstants} for constants starting
* with the "STATUS_" prefix.
* @return the latest matching web content article, or null if
* no matching web content article could be found
*/
@Override
public JournalArticle fetchLatestArticle(
long groupId, String articleId, int status) {
OrderByComparator orderByComparator =
new ArticleVersionComparator();
if (status == WorkflowConstants.STATUS_ANY) {
return journalArticlePersistence.fetchByG_A_NotST_First(
groupId, articleId, WorkflowConstants.STATUS_IN_TRASH,
orderByComparator);
}
return journalArticlePersistence.fetchByG_A_ST_First(
groupId, articleId, status, orderByComparator);
}
@Override
public JournalArticle fetchLatestArticleByUrlTitle(
long groupId, String urlTitle, int status) {
List articles = null;
OrderByComparator orderByComparator =
new ArticleVersionComparator();
if (status == WorkflowConstants.STATUS_ANY) {
articles = journalArticlePersistence.findByG_UT(
groupId, urlTitle, 0, 1, orderByComparator);
}
else {
articles = journalArticlePersistence.findByG_UT_ST(
groupId, urlTitle, status, 0, 1, orderByComparator);
}
if (articles.isEmpty()) {
return null;
}
return articles.get(0);
}
/**
* Returns the latest indexable web content article matching the resource
* primary key.
*
* @param resourcePrimKey the primary key of the resource instance
* @return the latest indexable web content article matching the resource
* primary key, or null if no matching web content
* article could be found
*/
@Override
public JournalArticle fetchLatestIndexableArticle(long resourcePrimKey) {
OrderByComparator orderByComparator =
new ArticleVersionComparator();
int[] statuses = new int[] {
WorkflowConstants.STATUS_APPROVED, WorkflowConstants.STATUS_IN_TRASH
};
List articles = journalArticlePersistence.findByR_I_S(
resourcePrimKey, true, statuses, 0, 1, orderByComparator);
if (articles.isEmpty()) {
return null;
}
return articles.get(0);
}
/**
* Returns the web content article with the ID.
*
* @param id the primary key of the web content article
* @return the web content article with the ID
*/
@Override
public JournalArticle getArticle(long id) throws PortalException {
return journalArticlePersistence.findByPrimaryKey(id);
}
/**
* Returns the latest approved web content article, or the latest unapproved
* article if none are approved. Both approved and unapproved articles must
* match the group and article ID.
*
* @param groupId the primary key of the web content article's group
* @param articleId the primary key of the web content article
* @return the matching web content article
*/
@Override
public JournalArticle getArticle(long groupId, String articleId)
throws PortalException {
// Get the latest article that is approved, if none are approved, get
// the latest unapproved article
JournalArticle article = fetchLatestArticle(
groupId, articleId, WorkflowConstants.STATUS_APPROVED);
if (article != null) {
return article;
}
return getLatestArticle(
groupId, articleId, WorkflowConstants.STATUS_ANY);
}
/**
* Returns the web content article matching the group, article ID, and
* version.
*
* @param groupId the primary key of the web content article's group
* @param articleId the primary key of the web content article
* @param version the web content article's version
* @return the matching web content article
*/
@Override
public JournalArticle getArticle(
long groupId, String articleId, double version)
throws PortalException {
return journalArticlePersistence.findByG_A_V(
groupId, articleId, version);
}
/**
* Returns the web content article matching the group, class name, and class
* PK.
*
* @param groupId the primary key of the web content article's group
* @param className the DDMStructure class name if the web content article
* is related to a DDM structure, the primary key of the class name
* associated with the article, or
* JournalArticleConstants.CLASSNAME_ID_DEFAULT in the journal-api
* module otherwise
* @param classPK the primary key of the DDM structure, if the DDMStructure
* class name is given as the className parameter, the
* primary key of the class associated with the web content article,
* or 0 otherwise
* @return the matching web content article
*/
@Override
public JournalArticle getArticle(
long groupId, String className, long classPK)
throws PortalException {
long classNameId = classNameLocalService.getClassNameId(className);
List articles = journalArticlePersistence.findByG_C_C(
groupId, classNameId, classPK);
if (articles.isEmpty()) {
throw new NoSuchArticleException(
"No approved JournalArticle exists with the key {groupId=" +
groupId + ", className=" + className + ", classPK=" +
classPK + "}");
}
return articles.get(0);
}
/**
* Returns the latest web content article that is approved, or the latest
* unapproved article if none are approved. Both approved and unapproved
* articles must match the group and URL title.
*
* @param groupId the primary key of the web content article's group
* @param urlTitle the web content article's accessible URL title
* @return the matching web content article
*/
@Override
public JournalArticle getArticleByUrlTitle(long groupId, String urlTitle)
throws PortalException {
// Get the latest article that is approved, if none are approved, get
// the latest unapproved article
JournalArticle article = fetchLatestArticleByUrlTitle(
groupId, urlTitle, WorkflowConstants.STATUS_APPROVED);
if (article != null) {
return article;
}
return getLatestArticleByUrlTitle(
groupId, urlTitle, WorkflowConstants.STATUS_ANY);
}
/**
* Returns the web content from the web content article associated with the
* portlet request model and the DDM template.
*
* @param article the web content article
* @param ddmTemplateKey the primary key of the web content article's DDM
* template
* @param viewMode the mode in which the web content is being viewed
* @param languageId the primary key of the language translation to get
* @param portletRequestModel the portlet request model
* @param themeDisplay the theme display
* @return the web content from the web content article associated with the
* portlet request model and the DDM template
*/
@Override
public String getArticleContent(
JournalArticle article, String ddmTemplateKey, String viewMode,
String languageId, PortletRequestModel portletRequestModel,
ThemeDisplay themeDisplay)
throws PortalException {
JournalArticleDisplay articleDisplay = getArticleDisplay(
article, ddmTemplateKey, viewMode, languageId, 1,
portletRequestModel, themeDisplay);
if (articleDisplay == null) {
return StringPool.BLANK;
}
else {
return articleDisplay.getContent();
}
}
/**
* Returns the web content from the web content article associated with the
* DDM template.
*
* @param article the web content article
* @param ddmTemplateKey the primary key of the web content article's
* DDM template
* @param viewMode the mode in which the web content is being viewed
* @param languageId the primary key of the language translation to get
* @param themeDisplay the theme display
* @return the web content from the matching web content article
* @deprecated As of 3.3.0, replaced by {@link
* #getArticleContent(JournalArticle, String, String, String,
* PortletRequestModel,ThemeDisplay)}
*/
@Deprecated
@Override
public String getArticleContent(
JournalArticle article, String ddmTemplateKey, String viewMode,
String languageId, ThemeDisplay themeDisplay)
throws PortalException {
return getArticleContent(
article, ddmTemplateKey, viewMode, languageId, null, themeDisplay);
}
/**
* Returns the web content from the web content article matching the group,
* article ID, and version, and associated with the portlet request model
* and the DDM template.
*
* @param groupId the primary key of the web content article's group
* @param articleId the primary key of the web content article
* @param version the web content article's version
* @param viewMode the mode in which the web content is being viewed
* @param ddmTemplateKey the primary key of the web content article's DDM
* template
* @param languageId the primary key of the language translation to get
* @param portletRequestModel the portlet request model
* @param themeDisplay the theme display
* @return the web content from the matching web content article
*/
@Override
public String getArticleContent(
long groupId, String articleId, double version, String viewMode,
String ddmTemplateKey, String languageId,
PortletRequestModel portletRequestModel, ThemeDisplay themeDisplay)
throws PortalException {
JournalArticleDisplay articleDisplay = getArticleDisplay(
groupId, articleId, version, ddmTemplateKey, viewMode, languageId,
1, portletRequestModel, themeDisplay);
if (articleDisplay == null) {
return StringPool.BLANK;
}
else {
return articleDisplay.getContent();
}
}
/**
* Returns the web content from the web content article matching the group,
* article ID, and version, and associated with the DDM template.
*
* @param groupId the primary key of the web content article's group
* @param articleId the primary key of the web content article
* @param version the web content article's version
* @param viewMode the mode in which the web content is being viewed
* @param ddmTemplateKey the primary key of the web content article's
* DDM template (optionally null). If the article
* is related to a DDM structure, the template's structure must
* match it.
* @param languageId the primary key of the language translation to get
* @param themeDisplay the theme display
* @return the web content from the matching web content article
* @deprecated As of 3.3.0, replaced by {@link #getArticleContent(long,
* String, double, String, String, String, PortletRequestModel,
* ThemeDisplay)}
*/
@Deprecated
@Override
public String getArticleContent(
long groupId, String articleId, double version, String viewMode,
String ddmTemplateKey, String languageId, ThemeDisplay themeDisplay)
throws PortalException {
return getArticleContent(
groupId, articleId, version, viewMode, ddmTemplateKey, languageId,
null, themeDisplay);
}
/**
* Returns the web content from the web content article matching the group,
* article ID, and version.
*
* @param groupId the primary key of the web content article's group
* @param articleId the primary key of the web content article
* @param version the web content article's version
* @param viewMode the mode in which the web content is being viewed
* @param languageId the primary key of the language translation to get
* @param themeDisplay the theme display
* @return the web content from the matching web content article
* @deprecated As of 3.3.0, replaced by {@link #getArticleContent(long,
* String, double, String, String, String, PortletRequestModel,
* ThemeDisplay)}
*/
@Deprecated
@Override
public String getArticleContent(
long groupId, String articleId, double version, String viewMode,
String languageId, ThemeDisplay themeDisplay)
throws PortalException {
return getArticleContent(
groupId, articleId, version, viewMode, null, languageId, null,
themeDisplay);
}
/**
* Returns the latest web content from the web content article matching the
* group and article ID, and associated with the portlet request model and
* the DDM template.
*
* @param groupId the primary key of the web content article's group
* @param articleId the primary key of the web content article
* @param viewMode the mode in which the web content is being viewed
* @param ddmTemplateKey the primary key of the web content article's DDM
* template
* @param languageId the primary key of the language translation to get
* @param portletRequestModel the portlet request model
* @param themeDisplay the theme display
* @return the latest web content from the matching web content article
*/
@Override
public String getArticleContent(
long groupId, String articleId, String viewMode,
String ddmTemplateKey, String languageId,
PortletRequestModel portletRequestModel, ThemeDisplay themeDisplay)
throws PortalException {
JournalArticleDisplay articleDisplay = getArticleDisplay(
groupId, articleId, ddmTemplateKey, viewMode, languageId, 1,
portletRequestModel, themeDisplay);
return articleDisplay.getContent();
}
/**
* Returns the latest web content from the web content article matching the
* group and article ID, and associated with the DDM template.
*
* @param groupId the primary key of the web content article's group
* @param articleId the primary key of the web content article
* @param viewMode the mode in which the web content is being viewed
* @param ddmTemplateKey the primary key of the web content article's
* DDM template
* @param languageId the primary key of the language translation to get
* @param themeDisplay the theme display
* @return the latest web content from the matching web content article
* @deprecated As of 3.3.0, replaced by {@link #getArticleContent(long,
* String, String, String, String, PortletRequestModel,
* ThemeDisplay)}
*/
@Deprecated
@Override
public String getArticleContent(
long groupId, String articleId, String viewMode,
String ddmTemplateKey, String languageId, ThemeDisplay themeDisplay)
throws PortalException {
return getArticleContent(
groupId, articleId, viewMode, ddmTemplateKey, languageId, null,
themeDisplay);
}
/**
* Returns the latest web content from the web content article matching the
* group and article ID.
*
* @param groupId the primary key of the web content article's group
* @param articleId the primary key of the web content article
* @param viewMode the mode in which the web content is being viewed
* @param languageId the primary key of the language translation to get
* @param themeDisplay the theme display
* @return the latest web content from the matching web content article
* @deprecated As of 3.3.0, replaced by {@link #getArticleContent(long,
* String, String, String, String, PortletRequestModel,
* ThemeDisplay)}
*/
@Deprecated
@Override
public String getArticleContent(
long groupId, String articleId, String viewMode, String languageId,
ThemeDisplay themeDisplay)
throws PortalException {
return getArticleContent(
groupId, articleId, viewMode, null, languageId, null, themeDisplay);
}
/**
* Returns a web content article display for the specified page of the
* latest version of the web content article, based on the DDM template. Web
* content transformation tokens are added using the portlet request model
* and theme display.
*
* @param article the primary key of the web content article
* @param ddmTemplateKey the primary key of the web content article's DDM
* template
* @param viewMode the mode in which the web content is being viewed
* @param languageId the primary key of the language translation to get
* @param page the web content article page to display
* @param portletRequestModel the portlet request model
* @param themeDisplay the theme display
* @return the web content article display, or null if the
* article has expired or if article's display date/time is after
* the current date/time
*/
@Override
public JournalArticleDisplay getArticleDisplay(
JournalArticle article, String ddmTemplateKey, String viewMode,
String languageId, int page,
PortletRequestModel portletRequestModel, ThemeDisplay themeDisplay)
throws PortalException {
return getArticleDisplay(
article, ddmTemplateKey, viewMode, languageId, page,
portletRequestModel, themeDisplay, false);
}
/**
* Returns a web content article display for the specified page of the
* specified version of the web content article matching the group, article
* ID, and DDM template. Web content transformation tokens are added using
* the portlet request model and theme display.
*
* @param groupId the primary key of the web content article's group
* @param articleId the primary key of the web content article
* @param version the web content article's version
* @param ddmTemplateKey the primary key of the web content article's DDM
* template
* @param viewMode the mode in which the web content is being viewed
* @param languageId the primary key of the language translation to get
* @param page the web content article page to display
* @param portletRequestModel the portlet request model
* @param themeDisplay the theme display
* @return the web content article display, or null if the
* article has expired or if article's display date/time is after
* the current date/time
*/
@Override
public JournalArticleDisplay getArticleDisplay(
long groupId, String articleId, double version,
String ddmTemplateKey, String viewMode, String languageId, int page,
PortletRequestModel portletRequestModel, ThemeDisplay themeDisplay)
throws PortalException {
Date now = new Date();
JournalArticle article = journalArticlePersistence.findByG_A_V(
groupId, articleId, version);
if (article.isExpired()) {
Date expirationDate = article.getExpirationDate();
if ((expirationDate != null) && expirationDate.before(now)) {
return null;
}
}
Date displayDate = article.getDisplayDate();
if (displayDate.after(now)) {
return null;
}
return getArticleDisplay(
article, ddmTemplateKey, viewMode, languageId, page,
portletRequestModel, themeDisplay);
}
/**
* Returns a web content article display for the first page of the specified
* version of the web content article matching the group, article ID, and
* DDM template. Web content transformation tokens are added from the theme
* display (if not null).
*
* @param groupId the primary key of the web content article's group
* @param articleId the primary key of the web content article
* @param version the web content article's version
* @param ddmTemplateKey the primary key of the web content article's DDM
* template
* @param viewMode the mode in which the web content is being viewed
* @param languageId the primary key of the language translation to get
* @param themeDisplay the theme display
* @return the web content article display, or null if the
* article has expired or if article's display date/time is after
* the current date/time
*/
@Override
public JournalArticleDisplay getArticleDisplay(
long groupId, String articleId, double version,
String ddmTemplateKey, String viewMode, String languageId,
ThemeDisplay themeDisplay)
throws PortalException {
return getArticleDisplay(
groupId, articleId, version, ddmTemplateKey, viewMode, languageId,
1, null, themeDisplay);
}
/**
* Returns a web content article display for the specified page of the
* latest version of the web content article matching the group and article
* ID. Web content transformation tokens are added from the theme display
* (if not null).
*
* @param groupId the primary key of the web content article's group
* @param articleId the primary key of the web content article
* @param viewMode the mode in which the web content is being viewed
* @param languageId the primary key of the language translation to get
* @param page the web content article page to display
* @param portletRequestModel the portlet request model
* @param themeDisplay the theme display
* @return the web content article display, or null if the
* article has expired or if article's display date/time is after
* the current date/time
*/
@Override
public JournalArticleDisplay getArticleDisplay(
long groupId, String articleId, String viewMode, String languageId,
int page, PortletRequestModel portletRequestModel,
ThemeDisplay themeDisplay)
throws PortalException {
return getArticleDisplay(
groupId, articleId, null, viewMode, languageId, page,
portletRequestModel, themeDisplay);
}
/**
* Returns a web content article display for the specified page of the
* latest version of the web content article matching the group, article ID,
* and DDM template. Web content transformation tokens are added using the
* portlet request model and theme display.
*
* @param groupId the primary key of the web content article's group
* @param articleId the primary key of the web content article
* @param ddmTemplateKey the primary key of the web content article's DDM
* template
* @param viewMode the mode in which the web content is being viewed
* @param languageId the primary key of the language translation to get
* @param page the web content article page to display
* @param portletRequestModel the portlet request model
* @param themeDisplay the theme display
* @return the web content article display, or null if the
* article has expired or if article's display date/time is after
* the current date/time
*/
@Override
public JournalArticleDisplay getArticleDisplay(
long groupId, String articleId, String ddmTemplateKey,
String viewMode, String languageId, int page,
PortletRequestModel portletRequestModel, ThemeDisplay themeDisplay)
throws PortalException {
JournalArticle article = getDisplayArticle(groupId, articleId);
return getArticleDisplay(
groupId, articleId, article.getVersion(), ddmTemplateKey, viewMode,
languageId, page, portletRequestModel, themeDisplay);
}
/**
* Returns a web content article display for the first page of the latest
* version of the web content article matching the group, article ID, and
* DDM template. Web content transformation tokens are added from the theme
* display (if not null).
*
* @param groupId the primary key of the web content article's group
* @param articleId the primary key of the web content article
* @param ddmTemplateKey the primary key of the web content article's DDM
* template
* @param viewMode the mode in which the web content is being viewed
* @param languageId the primary key of the language translation to get
* @param themeDisplay the theme display
* @return the web content article display, or null if the
* article has expired or if article's display date/time is after
* the current date/time
*/
@Override
public JournalArticleDisplay getArticleDisplay(
long groupId, String articleId, String ddmTemplateKey,
String viewMode, String languageId, ThemeDisplay themeDisplay)
throws PortalException {
JournalArticle article = getDisplayArticle(groupId, articleId);
return getArticleDisplay(
groupId, articleId, article.getVersion(), ddmTemplateKey, viewMode,
languageId, themeDisplay);
}
/**
* Returns a web content article display for the first page of the latest
* version of the web content article matching the group and article ID. Web
* content transformation tokens are added from the theme display (if not
* null).
*
* @param groupId the primary key of the web content article's group
* @param articleId the primary key of the web content article
* @param viewMode the mode in which the web content is being viewed
* @param languageId the primary key of the language translation to get
* @param themeDisplay the theme display
* @return the web content article display, or null if the
* article has expired or if article's display date/time is after
* the current date/time
*/
@Override
public JournalArticleDisplay getArticleDisplay(
long groupId, String articleId, String viewMode, String languageId,
ThemeDisplay themeDisplay)
throws PortalException {
return getArticleDisplay(
groupId, articleId, null, viewMode, languageId, themeDisplay);
}
/**
* Returns all the web content articles present in the system.
*
* @return the web content articles present in the system
*/
@Override
public List getArticles() {
return journalArticlePersistence.findAll();
}
/**
* Returns all the web content articles belonging to the group.
*
* @param groupId the primary key of the web content article's group
* @return the web content articles belonging to the group
*/
@Override
public List getArticles(long groupId) {
return journalArticlePersistence.findByGroupId(groupId);
}
/**
* Returns a range of all the web content articles belonging to the group.
*
*
* Useful when paginating results. Returns a maximum of end -
* start instances. start and end are not
* primary keys, they are indexes in the result set. Thus, 0
* refers to the first result in the set. Setting both start
* and end to {@link QueryUtil#ALL_POS} will return the full
* result set.
*
*
* @param groupId the primary key of the web content article's group
* @param start the lower bound of the range of web content articles to
* return
* @param end the upper bound of the range of web content articles to
* return (not inclusive)
* @return the range of matching web content articles
*/
@Override
public List getArticles(long groupId, int start, int end) {
return journalArticlePersistence.findByGroupId(groupId, start, end);
}
/**
* Returns an ordered range of all the web content articles belonging to the
* group.
*
*
* Useful when paginating results. Returns a maximum of end -
* start instances. start and end are not
* primary keys, they are indexes in the result set. Thus, 0
* refers to the first result in the set. Setting both start
* and end to {@link QueryUtil#ALL_POS} will return the full
* result set.
*
*
* @param groupId the primary key of the web content article's group
* @param start the lower bound of the range of web content articles to
* return
* @param end the upper bound of the range of web content articles to
* return (not inclusive)
* @param obc the comparator to order the web content articles
* @return the range of matching web content articles ordered by the
* comparator
*/
@Override
public List getArticles(
long groupId, int start, int end,
OrderByComparator obc) {
return journalArticlePersistence.findByGroupId(
groupId, start, end, obc);
}
/**
* Returns all the web content articles matching the group and folder.
*
* @param groupId the primary key of the web content article's group
* @param folderId the primary key of the web content article folder
* @return the matching web content articles
*/
@Override
public List getArticles(long groupId, long folderId) {
return journalArticlePersistence.findByG_F(groupId, folderId);
}
/**
* Returns a range of all the web content articles matching the group and
* folder.
*
*
* Useful when paginating results. Returns a maximum of end -
* start instances. start and end are not
* primary keys, they are indexes in the result set. Thus, 0
* refers to the first result in the set. Setting both start
* and end to {@link QueryUtil#ALL_POS} will return the full
* result set.
*
*
* @param groupId the primary key of the web content article's group
* @param folderId the primary key of the web content article's folder
* @param start the lower bound of the range of web content articles to
* return
* @param end the upper bound of the range of web content articles to
* return (not inclusive)
* @return the range of matching web content articles
*/
@Override
public List getArticles(
long groupId, long folderId, int start, int end) {
return journalArticlePersistence.findByG_F(
groupId, folderId, start, end);
}
/**
* Returns a range of all the web content articles matching the group,
* folder, and status.
*
*
* Useful when paginating results. Returns a maximum of end -
* start instances. start and end are not
* primary keys, they are indexes in the result set. Thus, 0
* refers to the first result in the set. Setting both start
* and end to {@link QueryUtil#ALL_POS} will return the full
* result set.
*
*
* @param groupId the primary key of the web content article's group
* @param folderId the primary key of the web content article's folder
* @param status the web content article's workflow status. For more
* information see {@link WorkflowConstants} for constants starting
* with the "STATUS_" prefix.
* @param start the lower bound of the range of web content articles to
* return
* @param end the upper bound of the range of web content articles to
* return (not inclusive)
* @return the range of matching web content articles
*/
@Override
public List getArticles(
long groupId, long folderId, int status, int start, int end) {
return journalArticlePersistence.findByG_F_ST(
groupId, folderId, status, start, end);
}
/**
* Returns an ordered range of all the web content articles matching the
* group and folder.
*
*
* Useful when paginating results. Returns a maximum of end -
* start instances. start and end are not
* primary keys, they are indexes in the result set. Thus, 0
* refers to the first result in the set. Setting both start
* and end to {@link QueryUtil#ALL_POS} will return the full
* result set.
*
*
* @param groupId the primary key of the web content article's group
* @param folderId the primary key of the web content article's folder
* @param start the lower bound of the range of web content articles to
* return
* @param end the upper bound of the range of web content articles to
* return (not inclusive)
* @param orderByComparator the comparator to order the web content
* articles
* @return the range of matching web content articles ordered by the
* comparator
*/
@Override
public List getArticles(
long groupId, long folderId, int start, int end,
OrderByComparator orderByComparator) {
return journalArticlePersistence.findByG_F(
groupId, folderId, start, end, orderByComparator);
}
/**
* Returns all the web content articles matching the group and article ID.
*
* @param groupId the primary key of the web content article's group
* @param articleId the primary key of the web content article
* @return the matching web content articles
*/
@Override
public List getArticles(long groupId, String articleId) {
return journalArticlePersistence.findByG_A(groupId, articleId);
}
@Override
public List getArticles(
long groupId, String articleId, int start, int end,
OrderByComparator orderByComparator) {
return journalArticlePersistence.findByG_A(
groupId, articleId, start, end, orderByComparator);
}
/**
* Returns all the web content articles matching the resource primary key.
*
* @param resourcePrimKey the primary key of the resource instance
* @return the web content articles matching the resource primary key
*/
@Override
public List getArticlesByResourcePrimKey(
long resourcePrimKey) {
return journalArticlePersistence.findByResourcePrimKey(resourcePrimKey);
}
/**
* Returns all the web content articles matching the small image ID.
*
* @param smallImageId the primary key of the web content article's small
* image
* @return the web content articles matching the small image ID
*/
@Override
public List getArticlesBySmallImageId(long smallImageId) {
return journalArticlePersistence.findBySmallImageId(smallImageId);
}
@Override
public List getArticlesByStructureId(
long groupId, long classNameId, String ddmStructureKey, int status,
int start, int end, OrderByComparator obc) {
QueryDefinition queryDefinition = new QueryDefinition<>(
status, start, end, obc);
return journalArticleFinder.findByG_C_S(
groupId, classNameId, ddmStructureKey, queryDefinition);
}
@Override
public List getArticlesByStructureId(
long groupId, String ddmStructureKey, int status, int start, int end,
OrderByComparator obc) {
QueryDefinition queryDefinition = new QueryDefinition<>(
status, start, end, obc);
return journalArticleFinder.findByG_C_S(
groupId, JournalArticleConstants.CLASSNAME_ID_DEFAULT,
ddmStructureKey, queryDefinition);
}
@Override
public List getArticlesByStructureId(
long groupId, String ddmStructureKey, int start, int end,
OrderByComparator obc) {
return getArticlesByStructureId(
groupId, ddmStructureKey, WorkflowConstants.STATUS_ANY, start, end,
obc);
}
/**
* Returns the number of web content articles belonging to the group.
*
* @param groupId the primary key of the web content article's group
* @return the number of web content articles belonging to the group
*/
@Override
public int getArticlesCount(long groupId) {
return journalArticlePersistence.countByGroupId(groupId);
}
/**
* Returns the number of web content articles matching the group and folder.
*
* @param groupId the primary key of the web content article's group
* @param folderId the primary key of the web content article's folder
* @return the number of matching web content articles
*/
@Override
public int getArticlesCount(long groupId, long folderId) {
return journalArticlePersistence.countByG_F(groupId, folderId);
}
/**
* Returns the number of web content articles matching the group, folder,
* and status.
*
* @param groupId the primary key of the web content article's group
* @param folderId the primary key of the web content article's folder
* @param status the web content article's workflow status. For more
* information see {@link WorkflowConstants} for constants starting
* with the "STATUS_" prefix.
* @return the number of matching web content articles
*/
@Override
public int getArticlesCount(long groupId, long folderId, int status) {
return journalArticlePersistence.countByG_F_ST(
groupId, folderId, status);
}
@Override
public int getArticlesCount(long groupId, String articleId) {
return journalArticlePersistence.countByG_A(groupId, articleId);
}
/**
* Returns an ordered range of all the web content articles matching the
* company, version, and workflow status.
*
*
* Useful when paginating results. Returns a maximum of end -
* start instances. start and end are not
* primary keys, they are indexes in the result set. Thus, 0
* refers to the first result in the set. Setting both start
* and end to {@link QueryUtil#ALL_POS} will return the full
* result set.
*
*
* @param companyId the primary key of the web content article's company
* @param version the web content article's version
* @param status the web content article's workflow status. For more
* information see {@link WorkflowConstants} for constants starting
* with the "STATUS_" prefix.
* @param start the lower bound of the range of web content articles to
* return
* @param end the upper bound of the range of web content articles to
* return (not inclusive)
* @return the range of matching web content articles ordered by article ID
*/
@Override
public List getCompanyArticles(
long companyId, double version, int status, int start, int end) {
if (status == WorkflowConstants.STATUS_ANY) {
return journalArticlePersistence.findByC_V(
companyId, version, start, end, new ArticleIDComparator(true));
}
else {
return journalArticlePersistence.findByC_V_ST(
companyId, version, status, start, end,
new ArticleIDComparator(true));
}
}
/**
* Returns an ordered range of all the web content articles matching the
* company and workflow status.
*
*
* Useful when paginating results. Returns a maximum of end -
* start instances. start and end are not
* primary keys, they are indexes in the result set. Thus, 0
* refers to the first result in the set. Setting both start
* and end to {@link QueryUtil#ALL_POS} will return the full
* result set.
*
*
* @param companyId the primary key of the web content article's company
* @param status the web content article's workflow status. For more
* information see {@link WorkflowConstants} for constants starting
* with the "STATUS_" prefix.
* @param start the lower bound of the range of web content articles to
* return
* @param end the upper bound of the range of web content articles to
* return (not inclusive)
* @return the range of matching web content articles ordered by article ID
*/
@Override
public List getCompanyArticles(
long companyId, int status, int start, int end) {
if (status == WorkflowConstants.STATUS_ANY) {
return journalArticlePersistence.findByCompanyId(
companyId, start, end, new ArticleIDComparator(true));
}
else {
return journalArticlePersistence.findByC_ST(
companyId, status, start, end, new ArticleIDComparator(true));
}
}
/**
* Returns the number of web content articles matching the company, version,
* and workflow status.
*
*
* Useful when paginating results. Returns a maximum of end -
* start instances. start and end are not
* primary keys, they are indexes in the result set. Thus, 0
* refers to the first result in the set. Setting both start
* and end to {@link QueryUtil#ALL_POS} will return the full
* result set.
*
*
* @param companyId the primary key of the web content article's company
* @param version the web content article's version
* @param status the web content article's workflow status. For more
* information see {@link WorkflowConstants} for constants starting
* with the "STATUS_" prefix.
* @param start the lower bound of the range of web content articles to
* return
* @param end the upper bound of the range of web content articles to
* return (not inclusive)
* @return the number of matching web content articles
*/
@Override
public int getCompanyArticlesCount(
long companyId, double version, int status, int start, int end) {
if (status == WorkflowConstants.STATUS_ANY) {
return journalArticlePersistence.countByC_V(companyId, version);
}
else {
return journalArticlePersistence.countByC_V_ST(
companyId, version, status);
}
}
/**
* Returns the number of web content articles matching the company and
* workflow status.
*
* @param companyId the primary key of the web content article's company
* @param status the web content article's workflow status. For more
* information see {@link WorkflowConstants} for constants starting
* with the "STATUS_" prefix.
* @return the number of matching web content articles
*/
@Override
public int getCompanyArticlesCount(long companyId, int status) {
if (status == WorkflowConstants.STATUS_ANY) {
return journalArticlePersistence.countByCompanyId(companyId);
}
else {
return journalArticlePersistence.countByC_ST(companyId, status);
}
}
/**
* Returns the matching web content article currently displayed or next to
* be displayed if no article is currently displayed.
*
* @param groupId the primary key of the web content article's group
* @param articleId the primary key of the web content article
* @return the matching web content article currently displayed, or the next
* one to be displayed if no version of the article is currently
* displayed
*/
@Override
public JournalArticle getDisplayArticle(long groupId, String articleId)
throws PortalException {
JournalArticle article = fetchDisplayArticle(groupId, articleId);
if (article == null) {
throw new NoSuchArticleException(
"No approved JournalArticle exists with the key {groupId=" +
groupId + ", articleId=" + articleId + "}");
}
return article;
}
/**
* Returns the web content article matching the URL title that is currently
* displayed or next to be displayed if no article is currently displayed.
*
* @param groupId the primary key of the web content article's group
* @param urlTitle the web content article's accessible URL title
* @return the web content article matching the URL title that is currently
* displayed, or next one to be displayed if no version of the
* article is currently displayed
*/
@Override
public JournalArticle getDisplayArticleByUrlTitle(
long groupId, String urlTitle)
throws PortalException {
List articles = null;
OrderByComparator orderByComparator =
new ArticleVersionComparator();
articles = journalArticlePersistence.findByG_UT_ST(
groupId, urlTitle, WorkflowConstants.STATUS_APPROVED,
QueryUtil.ALL_POS, QueryUtil.ALL_POS, orderByComparator);
if (articles.isEmpty()) {
throw new NoSuchArticleException(
"No JournalArticle exists with the key {groupId=" + groupId +
", urlTitle=" + urlTitle + "}");
}
Date now = new Date();
for (JournalArticle article : articles) {
Date displayDate = article.getDisplayDate();
Date expirationDate = article.getExpirationDate();
if ((displayDate != null) && displayDate.before(now) &&
((expirationDate == null) || expirationDate.after(now))) {
return article;
}
}
return articles.get(0);
}
@Override
public List getIndexableArticlesByDDMStructureKey(
String[] ddmStructureKeys) {
if (JournalServiceConfigurationValues.
JOURNAL_ARTICLE_INDEX_ALL_VERSIONS) {
return getStructureArticles(ddmStructureKeys);
}
QueryDefinition approvedQueryDefinition =
new QueryDefinition(
WorkflowConstants.STATUS_APPROVED, QueryUtil.ALL_POS,
QueryUtil.ALL_POS, new ArticleVersionComparator());
List articles = new ArrayList<>();
articles.addAll(
journalArticleFinder.findByG_C_S(
0, JournalArticleConstants.CLASSNAME_ID_DEFAULT,
ddmStructureKeys, approvedQueryDefinition));
QueryDefinition trashQueryDefinition =
new QueryDefinition(
WorkflowConstants.STATUS_IN_TRASH, QueryUtil.ALL_POS,
QueryUtil.ALL_POS, new ArticleVersionComparator());
articles.addAll(
journalArticleFinder.findByG_C_S(
0, JournalArticleConstants.CLASSNAME_ID_DEFAULT,
ddmStructureKeys, trashQueryDefinition));
return articles;
}
/**
* Returns the indexable web content articles matching the resource primary
* key.
*
* @param resourcePrimKey the primary key of the resource instance
* @return the indexable web content articles matching the resource primary
* key
*/
@Override
public List getIndexableArticlesByResourcePrimKey(
long resourcePrimKey) {
return journalArticlePersistence.findByR_I(resourcePrimKey, true);
}
/**
* Returns the latest web content article matching the resource primary key,
* preferring articles with approved workflow status.
*
* @param resourcePrimKey the primary key of the resource instance
* @return the latest web content article matching the resource primary key,
* preferring articles with approved workflow status
*/
@Override
public JournalArticle getLatestArticle(long resourcePrimKey)
throws PortalException {
return getLatestArticle(resourcePrimKey, WorkflowConstants.STATUS_ANY);
}
/**
* Returns the latest web content article matching the resource primary key
* and workflow status, preferring articles with approved workflow status.
*
* @param resourcePrimKey the primary key of the resource instance
* @param status the web content article's workflow status. For more
* information see {@link WorkflowConstants} for constants starting
* with the "STATUS_" prefix.
* @return the latest web content article matching the resource primary key
* and workflow status, preferring articles with approved workflow
* status
*/
@Override
public JournalArticle getLatestArticle(long resourcePrimKey, int status)
throws PortalException {
return getLatestArticle(resourcePrimKey, status, true);
}
/**
* Returns the latest web content article matching the resource primary key
* and workflow status, optionally preferring articles with approved
* workflow status.
*
* @param resourcePrimKey the primary key of the resource instance
* @param status the web content article's workflow status. For more
* information see {@link WorkflowConstants} for constants starting
* with the "STATUS_" prefix.
* @param preferApproved whether to prefer returning the latest matching
* article that has workflow status {@link
* WorkflowConstants#STATUS_APPROVED} over returning one that has a
* different status
* @return the latest web content article matching the resource primary key
* and workflow status, optionally preferring articles with approved
* workflow status
*/
@Override
public JournalArticle getLatestArticle(
long resourcePrimKey, int status, boolean preferApproved)
throws PortalException {
List articles = null;
OrderByComparator orderByComparator =
new ArticleVersionComparator();
if (status == WorkflowConstants.STATUS_ANY) {
if (preferApproved) {
articles = journalArticlePersistence.findByR_ST(
resourcePrimKey, WorkflowConstants.STATUS_APPROVED, 0, 1,
orderByComparator);
}
if (ListUtil.isEmpty(articles)) {
articles = journalArticlePersistence.findByResourcePrimKey(
resourcePrimKey, 0, 1, orderByComparator);
}
}
else {
articles = journalArticlePersistence.findByR_ST(
resourcePrimKey, status, 0, 1, orderByComparator);
}
if (articles.isEmpty()) {
throw new NoSuchArticleException(
"No JournalArticle exists with the key {resourcePrimKey=" +
resourcePrimKey + "}");
}
return articles.get(0);
}
/**
* Returns the latest web content article with the group and article ID.
*
* @param groupId the primary key of the web content article's group
* @param articleId the primary key of the web content article
* @return the latest matching web content article
*/
@Override
public JournalArticle getLatestArticle(long groupId, String articleId)
throws PortalException {
return getLatestArticle(
groupId, articleId, WorkflowConstants.STATUS_ANY);
}
/**
* Returns the latest web content article matching the group, article ID,
* and workflow status.
*
* @param groupId the primary key of the web content article's group
* @param articleId the primary key of the web content article
* @param status the web content article's workflow status. For more
* information see {@link WorkflowConstants} for constants starting
* with the "STATUS_" prefix.
* @return the latest matching web content article
*/
@Override
public JournalArticle getLatestArticle(
long groupId, String articleId, int status)
throws PortalException {
return getFirstArticle(
groupId, articleId, status, new ArticleVersionComparator());
}
/**
* Returns the latest web content article matching the group, class name ID,
* and class PK.
*
* @param groupId the primary key of the web content article's group
* @param className the DDMStructure class name if the web content article
* is related to a DDM structure, the class name associated with the
* article, or JournalArticleConstants.CLASSNAME_ID_DEFAULT in the
* journal-api module otherwise
* @param classPK the primary key of the DDM structure, if the DDMStructure
* class name is given as the className parameter, the
* primary key of the class associated with the web content article,
* or 0 otherwise
* @return the latest matching web content article
*/
@Override
public JournalArticle getLatestArticle(
long groupId, String className, long classPK)
throws PortalException {
long classNameId = classNameLocalService.getClassNameId(className);
List articles = journalArticlePersistence.findByG_C_C(
groupId, classNameId, classPK, 0, 1,
new ArticleVersionComparator());
if (articles.isEmpty()) {
throw new NoSuchArticleException(
"No JournalArticle exists with the key {groupId=" + groupId +
", className=" + className + ", classPK =" + classPK + "}");
}
return articles.get(0);
}
/**
* Returns the latest web content article matching the group, URL title, and
* workflow status.
*
* @param groupId the primary key of the web content article's group
* @param urlTitle the web content article's accessible URL title
* @param status the web content article's workflow status. For more
* information see {@link WorkflowConstants} for constants starting
* with the "STATUS_" prefix.
* @return the latest matching web content article
*/
@Override
public JournalArticle getLatestArticleByUrlTitle(
long groupId, String urlTitle, int status)
throws PortalException {
JournalArticle article = fetchLatestArticleByUrlTitle(
groupId, urlTitle, status);
if (article == null) {
throw new NoSuchArticleException(
"No JournalArticle exists with the key {groupId=" + groupId +
", urlTitle=" + urlTitle + ", status=" + status + "}");
}
return article;
}
/**
* Returns the latest version number of the web content with the group and
* article ID.
*
* @param groupId the primary key of the web content article's group
* @param articleId the primary key of the web content article
* @return the latest version number of the matching web content
*/
@Override
public double getLatestVersion(long groupId, String articleId)
throws PortalException {
JournalArticle article = getLatestArticle(groupId, articleId);
return article.getVersion();
}
/**
* Returns the latest version number of the web content with the group,
* article ID, and workflow status.
*
* @param groupId the primary key of the web content article's group
* @param articleId the primary key of the web content article
* @param status the web content article's workflow status. For more
* information see {@link WorkflowConstants} for constants starting
* with the "STATUS_" prefix.
* @return the latest version number of the matching web content
*/
@Override
public double getLatestVersion(long groupId, String articleId, int status)
throws PortalException {
JournalArticle article = getLatestArticle(groupId, articleId, status);
return article.getVersion();
}
@Override
public List getNoAssetArticles() {
return journalArticleFinder.findByNoAssets();
}
@Override
public List getNoPermissionArticles() {
return journalArticleFinder.findByNoPermissions();
}
/**
* Returns the number of web content articles that are not recycled.
*
* @param groupId the primary key of the web content article's group
* @param folderId the primary key of the web content article folder
* @return the number of web content articles that are not recycled
*/
@Override
public int getNotInTrashArticlesCount(long groupId, long folderId) {
QueryDefinition queryDefinition = new QueryDefinition<>(
WorkflowConstants.STATUS_ANY);
List folderIds = new ArrayList<>();
folderIds.add(folderId);
return journalArticleFinder.countByG_F(
groupId, folderIds, queryDefinition);
}
/**
* Returns the oldest web content article with the group and article ID.
*
* @param groupId the primary key of the web content article's group
* @param articleId the primary key of the web content article
* @return the oldest matching web content article
*/
@Override
public JournalArticle getOldestArticle(long groupId, String articleId)
throws PortalException {
return getOldestArticle(
groupId, articleId, WorkflowConstants.STATUS_ANY);
}
/**
* Returns the oldest web content article matching the group, article ID,
* and workflow status.
*
* @param groupId the primary key of the web content article's group
* @param articleId the primary key of the web content article
* @param status the web content article's workflow status. For more
* information see {@link WorkflowConstants} for constants starting
* with the "STATUS_" prefix.
* @return the oldest matching web content article
*/
@Override
public JournalArticle getOldestArticle(
long groupId, String articleId, int status)
throws PortalException {
return getFirstArticle(
groupId, articleId, status, new ArticleVersionComparator(false));
}
/**
* Returns the previously approved version of the web content article. For
* more information on the approved workflow status, see {@link
* WorkflowConstants#STATUS_APPROVED}.
*
* @param article the web content article
* @return the previously approved version of the web content article, or
* the current web content article if there are no previously
* approved web content articles
*/
@Override
public JournalArticle getPreviousApprovedArticle(JournalArticle article) {
List approvedArticles =
journalArticlePersistence.findByG_A_ST(
article.getGroupId(), article.getArticleId(),
WorkflowConstants.STATUS_APPROVED, 0, 2);
if (approvedArticles.isEmpty() ||
((approvedArticles.size() == 1) &&
(article.getStatus() == WorkflowConstants.STATUS_APPROVED))) {
return article;
}
JournalArticle previousApprovedArticle = approvedArticles.get(0);
if (article.getStatus() == WorkflowConstants.STATUS_APPROVED) {
previousApprovedArticle = approvedArticles.get(1);
}
return previousApprovedArticle;
}
/**
* Returns the web content articles matching the group and DDM structure
* key.
*
* @param groupId the primary key of the web content article's group
* @param ddmStructureKey the primary key of the web content article's DDM
* structure
* @return the matching web content articles
*/
@Override
public List getStructureArticles(
long groupId, String ddmStructureKey) {
return journalArticlePersistence.findByG_DDMSK(
groupId, ddmStructureKey);
}
/**
* Returns an ordered range of all the web content articles matching the
* group and DDM structure key.
*
*
* Useful when paginating results. Returns a maximum of end -
* start instances. start and end are not
* primary keys, they are indexes in the result set. Thus, 0
* refers to the first result in the set. Setting both start
* and end to {@link QueryUtil#ALL_POS} will return the full
* result set.
*
*
* @param groupId the primary key of the web content article's group
* @param ddmStructureKey the primary key of the web content article's DDM
* structure
* @param start the lower bound of the range of web content articles to
* return
* @param end the upper bound of the range of web content articles to
* return (not inclusive)
* @param obc the comparator to order the web content articles
* @return the range of matching web content articles ordered by the
* comparator
*/
@Override
public List getStructureArticles(
long groupId, String ddmStructureKey, int start, int end,
OrderByComparator obc) {
return journalArticlePersistence.findByG_DDMSK(
groupId, ddmStructureKey, start, end, obc);
}
/**
* Returns the web content articles matching the DDM structure keys.
*
* @param ddmStructureKeys the primary keys of the web content article's
* DDM structures
* @return the web content articles matching the DDM structure keys
*/
@Override
public List getStructureArticles(
String[] ddmStructureKeys) {
return journalArticlePersistence.findByDDMStructureKey(
ddmStructureKeys);
}
/**
* Returns the number of web content articles matching the group and DDM
* structure key.
*
* @param groupId the primary key of the web content article's group
* @param ddmStructureKey the primary key of the web content article's DDM
* structure
* @return the number of matching web content articles
*/
@Override
public int getStructureArticlesCount(long groupId, String ddmStructureKey) {
return journalArticlePersistence.countByG_DDMSK(
groupId, ddmStructureKey);
}
/**
* Returns the web content articles matching the group and DDM template key.
*
* @param groupId the primary key of the web content article's group
* @param ddmTemplateKey the primary key of the web content article's DDM
* template
* @return the matching web content articles
*/
@Override
public List getTemplateArticles(
long groupId, String ddmTemplateKey) {
return journalArticlePersistence.findByG_DDMTK(groupId, ddmTemplateKey);
}
/**
* Returns an ordered range of all the web content articles matching the
* group and DDM template key.
*
*
* Useful when paginating results. Returns a maximum of end -
* start instances. start and end are not
* primary keys, they are indexes in the result set. Thus, 0
* refers to the first result in the set. Setting both start
* and end to {@link QueryUtil#ALL_POS} will return the full
* result set.
*
*
* @param groupId the primary key of the web content article's group
* @param ddmTemplateKey the primary key of the web content article's DDM
* template
* @param start the lower bound of the range of web content articles to
* return
* @param end the upper bound of the range of web content articles to
* return (not inclusive)
* @param obc the comparator to order the web content articles
* @return the range of matching web content articles ordered by the
* comparator
*/
@Override
public List getTemplateArticles(
long groupId, String ddmTemplateKey, int start, int end,
OrderByComparator obc) {
return journalArticlePersistence.findByG_DDMTK(
groupId, ddmTemplateKey, start, end, obc);
}
/**
* Returns the number of web content articles matching the group and DDM
* template key.
*
* @param groupId the primary key of the web content article's group
* @param ddmTemplateKey the primary key of the web content article's DDM
* template
* @return the number of matching web content articles
*/
@Override
public int getTemplateArticlesCount(long groupId, String ddmTemplateKey) {
return journalArticlePersistence.countByG_DDMTK(
groupId, ddmTemplateKey);
}
/**
* Returns the web content article's unique URL title.
*
* @param groupId the primary key of the web content article's group
* @param articleId the primary key of the web content article
* @param urlTitle the web content article's accessible URL title
* @return the web content article's unique URL title
*/
@Override
public String getUniqueUrlTitle(
long groupId, String articleId, String urlTitle)
throws PortalException {
for (int i = 1;; i++) {
JournalArticle article = fetchArticleByUrlTitle(groupId, urlTitle);
if ((article == null) || articleId.equals(article.getArticleId())) {
break;
}
else {
String suffix = StringPool.DASH + i;
String prefix = urlTitle;
if (urlTitle.length() > suffix.length()) {
prefix = urlTitle.substring(
0, urlTitle.length() - suffix.length());
}
urlTitle = prefix + suffix;
}
}
return urlTitle;
}
/**
* Returns true if the specified web content article exists.
*
* @param groupId the primary key of the group
* @param articleId the primary key of the web content article
* @return true if the specified web content article exists;
* false otherwise
*/
@Override
public boolean hasArticle(long groupId, String articleId) {
JournalArticle article = fetchArticle(groupId, articleId);
if (article != null) {
return true;
}
return false;
}
/**
* Returns true if the web content article, specified by group
* and article ID, is the latest version.
*
* @param groupId the primary key of the web content article's group
* @param articleId the primary key of the web content article
* @param version the web content article's version
* @return true if the specified web content article is the
* latest version; false otherwise
*/
@Override
public boolean isLatestVersion(
long groupId, String articleId, double version)
throws PortalException {
if (getLatestVersion(groupId, articleId) == version) {
return true;
}
else {
return false;
}
}
/**
* Returns true if the web content article, specified by group,
* article ID, and workflow status, is the latest version.
*
* @param groupId the primary key of the web content article's group
* @param articleId the primary key of the web content article
* @param version the web content article's version
* @param status the web content article's workflow status. For more
* information see {@link WorkflowConstants} for constants starting
* with the "STATUS_" prefix.
* @return true if the specified web content article is the
* latest version; false otherwise
*/
@Override
public boolean isLatestVersion(
long groupId, String articleId, double version, int status)
throws PortalException {
if (getLatestVersion(groupId, articleId, status) == version) {
return true;
}
else {
return false;
}
}
@Override
public boolean isListable(JournalArticle article) {
if ((article != null) && article.isIndexable()) {
return true;
}
return false;
}
@Override
public boolean isRenderable(
JournalArticle article, PortletRequestModel portletRequestModel,
ThemeDisplay themeDisplay) {
try {
getArticleDisplay(
article, null, Constants.VIEW, article.getDefaultLanguageId(),
0, portletRequestModel, themeDisplay, true);
}
catch (Exception e) {
return false;
}
return true;
}
/**
* Moves the web content article matching the group and article ID to a new
* folder.
*
* @param groupId the primary key of the web content article's group
* @param articleId the primary key of the web content article
* @param newFolderId the primary key of the web content article's new
* folder
* @return the updated web content article, which was moved to a new
* folder
* @deprecated As of 3.3.0, replaced by {@link #moveArticle(long, String,
* long, ServiceContext)}
*/
@Deprecated
@Indexable(type = IndexableType.REINDEX)
@Override
public JournalArticle moveArticle(
long groupId, String articleId, long newFolderId)
throws PortalException {
return moveArticle(groupId, articleId, newFolderId, null);
}
/**
* Moves the web content article matching the group and article ID to a new
* folder.
*
* @param groupId the primary key of the web content article's group
* @param articleId the primary key of the web content article
* @param newFolderId the primary key of the web content article's new
* folder
* @param serviceContext the service context to be applied. Can set the
* user ID, language ID, portlet preferences, portlet request,
* portlet response, theme display, and can set whether to add the
* default command update for the web content article. With respect
* to social activities, by setting the service context's command to
* {@link Constants#UPDATE}, the invocation is considered a web
* content update activity; otherwise it is considered a web content
* add activity.
* @return the updated web content article, which was moved to a new folder
*/
@Indexable(type = IndexableType.REINDEX)
@Override
public JournalArticle moveArticle(
long groupId, String articleId, long newFolderId,
ServiceContext serviceContext)
throws PortalException {
JournalArticle latestArticle = getLatestArticle(groupId, articleId);
validateDDMStructureId(
groupId, newFolderId, latestArticle.getDDMStructureKey());
List articles = journalArticlePersistence.findByG_A(
groupId, articleId);
for (JournalArticle article : articles) {
if (serviceContext != null) {
notifySubscribers(
serviceContext.getUserId(), article, article.getUrlTitle(),
"move_from", serviceContext);
}
article.setFolderId(newFolderId);
article.setTreePath(article.buildTreePath());
journalArticlePersistence.update(article);
if (serviceContext != null) {
notifySubscribers(
serviceContext.getUserId(), article, article.getUrlTitle(),
"move_to", serviceContext);
}
}
return getArticle(groupId, articleId);
}
/**
* Moves the web content article from the Recycle Bin to a new folder.
*
* @param userId the primary key of the user updating the web content
* article
* @param groupId the primary key of the web content article's group
* @param article the web content article
* @param newFolderId the primary key of the web content article's new
* folder
* @param serviceContext the service context to be applied. Can set the
* modification date, portlet preferences, and can set whether to
* add the default command update for the web content article. With
* respect to social activities, by setting the service context's
* command to {@link Constants#UPDATE}, the invocation is considered
* a web content update activity; otherwise it is considered a web
* content add activity.
* @return the updated web content article, which was moved from the Recycle
* Bin to a new folder
*/
@Indexable(type = IndexableType.REINDEX)
@Override
public JournalArticle moveArticleFromTrash(
long userId, long groupId, JournalArticle article, long newFolderId,
ServiceContext serviceContext)
throws PortalException {
if (!article.isInTrash()) {
throw new RestoreEntryException(
RestoreEntryException.INVALID_STATUS);
}
if (article.isInTrashExplicitly()) {
restoreArticleFromTrash(userId, article);
}
else {
// Article
TrashVersion trashVersion = trashVersionLocalService.fetchVersion(
JournalArticle.class.getName(), article.getResourcePrimKey());
int status = WorkflowConstants.STATUS_APPROVED;
if (trashVersion != null) {
status = trashVersion.getStatus();
}
updateStatus(
userId, article, status, null, serviceContext,
new HashMap());
// Trash
if (trashVersion != null) {
trashVersionLocalService.deleteTrashVersion(trashVersion);
}
}
return moveArticle(
groupId, article.getArticleId(), newFolderId, serviceContext);
}
/**
* Moves the latest version of the web content article matching the group
* and article ID to the recycle bin.
*
* @param userId the primary key of the user updating the web content
* article
* @param article the web content article
* @return the updated web content article, which was moved to the Recycle
* Bin
*/
@Indexable(type = IndexableType.REINDEX)
@Override
public JournalArticle moveArticleToTrash(
long userId, JournalArticle article)
throws PortalException {
// Article
if (article.isInTrash()) {
throw new TrashEntryException();
}
int oldStatus = article.getStatus();
if (oldStatus == WorkflowConstants.STATUS_PENDING) {
article.setStatus(WorkflowConstants.STATUS_DRAFT);
}
journalArticlePersistence.update(article);
List articleVersions =
journalArticlePersistence.findByG_A(
article.getGroupId(), article.getArticleId());
articleVersions = ListUtil.sort(
articleVersions, new ArticleVersionComparator());
List> articleVersionStatusOVPs =
new ArrayList<>();
if ((articleVersions != null) && !articleVersions.isEmpty()) {
articleVersionStatusOVPs = getArticleVersionStatuses(
articleVersions);
}
article = updateStatus(
userId, article.getId(), WorkflowConstants.STATUS_IN_TRASH,
new HashMap(), new ServiceContext());
// Trash
JournalArticleResource articleResource =
journalArticleResourceLocalService.getArticleResource(
article.getResourcePrimKey());
UnicodeProperties typeSettingsProperties = new UnicodeProperties();
typeSettingsProperties.put("title", article.getArticleId());
TrashEntry trashEntry = trashEntryLocalService.addTrashEntry(
userId, article.getGroupId(), JournalArticle.class.getName(),
article.getResourcePrimKey(), articleResource.getUuid(), null,
oldStatus, articleVersionStatusOVPs, typeSettingsProperties);
String trashArticleId = TrashUtil.getTrashTitle(
trashEntry.getEntryId());
for (JournalArticle articleVersion : articleVersions) {
articleVersion.setArticleId(trashArticleId);
articleVersion.setStatus(WorkflowConstants.STATUS_IN_TRASH);
journalArticlePersistence.update(articleVersion);
}
articleResource.setArticleId(trashArticleId);
journalArticleResourcePersistence.update(articleResource);
article.setArticleId(trashArticleId);
article = journalArticlePersistence.update(article);
// Asset
assetEntryLocalService.updateVisible(
JournalArticle.class.getName(), article.getResourcePrimKey(),
false);
// Comment
if (JournalServiceConfigurationValues.
JOURNAL_ARTICLE_COMMENTS_ENABLED) {
CommentManagerUtil.moveDiscussionToTrash(
JournalArticle.class.getName(), article.getResourcePrimKey());
}
// Social
JSONObject extraDataJSONObject = JSONFactoryUtil.createJSONObject();
extraDataJSONObject.put("title", article.getTitle());
SocialActivityManagerUtil.addActivity(
userId, article, SocialActivityConstants.TYPE_MOVE_TO_TRASH,
extraDataJSONObject.toString(), 0);
if (oldStatus == WorkflowConstants.STATUS_PENDING) {
workflowInstanceLinkLocalService.deleteWorkflowInstanceLink(
article.getCompanyId(), article.getGroupId(),
JournalArticle.class.getName(), article.getId());
}
return article;
}
/**
* Moves the latest version of the web content article matching the group
* and article ID to the recycle bin.
*
* @param userId the primary key of the user updating the web content
* article
* @param groupId the primary key of the web content article's group
* @param articleId the primary key of the web content article
* @return the moved web content article or null if no matching
* article was found
*/
@Override
public JournalArticle moveArticleToTrash(
long userId, long groupId, String articleId)
throws PortalException {
List articles = journalArticlePersistence.findByG_A(
groupId, articleId, 0, 1, new ArticleVersionComparator());
if (!articles.isEmpty()) {
return journalArticleLocalService.moveArticleToTrash(
userId, articles.get(0));
}
return null;
}
/**
* Rebuilds the web content article's tree path using tree traversal.
*
*
* For example, here is a conceptualization of a web content article tree
* path:
*
*
*
*
*
* /(Folder's folderId)/(Subfolder's folderId)/(article's articleId)
*
*
*
*
* @param companyId the primary key of the web content article's company
*/
@Override
public void rebuildTree(long companyId) throws PortalException {
journalFolderLocalService.rebuildTree(companyId);
}
/**
* Removes the web content of the web content article matching the group,
* article ID, and version, and language.
*
* @param groupId the primary key of the web content article's group
* @param articleId the primary key of the web content article
* @param version the web content article's version
* @param languageId the primary key of the language locale to remove
* @return the updated web content article with the locale removed
*/
@Indexable(type = IndexableType.REINDEX)
@Override
public JournalArticle removeArticleLocale(
long groupId, String articleId, double version, String languageId)
throws PortalException {
JournalArticle article = journalArticlePersistence.findByG_A_V(
groupId, articleId, version);
String title = article.getTitle();
title = LocalizationUtil.removeLocalization(
title, "static-content", languageId, true);
article.setTitle(title);
String description = article.getDescription();
description = LocalizationUtil.removeLocalization(
description, "static-content", languageId, true);
article.setDescription(description);
String content = article.getContent();
Document document = article.getDocument();
if (document != null) {
content = JournalUtil.removeArticleLocale(
document, content, languageId);
article.setContent(content);
}
journalArticlePersistence.update(article);
return article;
}
/**
* Restores the web content article from the Recycle Bin.
*
* @param userId the primary key of the user restoring the web content
* article
* @param article the web content article
* @return the restored web content article from the Recycle Bin
*/
@Indexable(type = IndexableType.REINDEX)
@Override
public JournalArticle restoreArticleFromTrash(
long userId, JournalArticle article)
throws PortalException {
// Article
if (!article.isInTrash()) {
throw new RestoreEntryException(
RestoreEntryException.INVALID_STATUS);
}
String trashArticleId = TrashUtil.getOriginalTitle(
article.getArticleId());
List articleVersions =
journalArticlePersistence.findByG_A(
article.getGroupId(), article.getArticleId());
for (JournalArticle articleVersion : articleVersions) {
articleVersion.setArticleId(trashArticleId);
journalArticlePersistence.update(articleVersion);
}
article.setArticleId(trashArticleId);
journalArticlePersistence.update(article);
JournalArticleResource articleResource =
journalArticleResourcePersistence.fetchByPrimaryKey(
article.getResourcePrimKey());
articleResource.setArticleId(trashArticleId);
journalArticleResourcePersistence.update(articleResource);
TrashEntry trashEntry = trashEntryLocalService.getEntry(
JournalArticle.class.getName(), article.getResourcePrimKey());
ServiceContext serviceContext = new ServiceContext();
serviceContext.setScopeGroupId(article.getGroupId());
updateStatus(
userId, article, trashEntry.getStatus(), null, serviceContext,
new HashMap());
// Trash
List trashVersions = trashVersionLocalService.getVersions(
trashEntry.getEntryId());
boolean visible = false;
for (TrashVersion trashVersion : trashVersions) {
JournalArticle trashArticleVersion =
journalArticlePersistence.findByPrimaryKey(
trashVersion.getClassPK());
trashArticleVersion.setStatus(trashVersion.getStatus());
if (trashVersion.getStatus() == WorkflowConstants.STATUS_APPROVED) {
visible = true;
}
journalArticlePersistence.update(trashArticleVersion);
}
trashEntryLocalService.deleteEntry(
JournalArticle.class.getName(), article.getResourcePrimKey());
if (visible) {
assetEntryLocalService.updateVisible(
JournalArticle.class.getName(), article.getResourcePrimKey(),
true);
}
// Comment
if (JournalServiceConfigurationValues.
JOURNAL_ARTICLE_COMMENTS_ENABLED) {
CommentManagerUtil.restoreDiscussionFromTrash(
JournalArticle.class.getName(), article.getResourcePrimKey());
}
// Social
JSONObject extraDataJSONObject = JSONFactoryUtil.createJSONObject();
extraDataJSONObject.put("title", article.getTitle());
SocialActivityManagerUtil.addActivity(
userId, article, SocialActivityConstants.TYPE_RESTORE_FROM_TRASH,
extraDataJSONObject.toString(), 0);
return article;
}
/**
* Returns a range of all the web content articles matching the parameters
* without using the indexer. It is preferable to use the indexed version
* {@link #search(long, long, long, int, int, int)} instead of this method
* wherever possible for performance reasons.
*
*
* Useful when paginating results. Returns a maximum of end -
* start instances. start and end are not
* primary keys, they are indexes in the result set. Thus, 0
* refers to the first result in the set. Setting both start
* and end to {@link QueryUtil#ALL_POS} will return the full
* result set.
*
*
* @param groupId the primary key of the group (optionally 0)
* @param folderIds the primary keys of the web content article folders
* (optionally {@link Collections#EMPTY_LIST})
* @param status the web content article's workflow status. For more
* information see {@link WorkflowConstants} for constants starting
* with the "STATUS_" prefix.
* @param start the lower bound of the range of web content articles to
* return
* @param end the upper bound of the range of web content articles to
* return (not inclusive)
* @return the matching web content articles
*/
@Override
public List search(
long groupId, List folderIds, int status, int start, int end) {
QueryDefinition queryDefinition = new QueryDefinition<>(
status, start, end, null);
return journalArticleFinder.findByG_F(
groupId, folderIds, queryDefinition);
}
/**
* Returns a range of all the web content articles in a single folder
* matching the parameters without using the indexer. It is preferable to
* use the indexed version {@link #search(long, long, long, int, int, int)}
* instead of this method wherever possible for performance reasons.
*
*
* Useful when paginating results. Returns a maximum of end -
* start instances. start and end are not
* primary keys, they are indexes in the result set. Thus, 0
* refers to the first result in the set. Setting both start
* and end to {@link QueryUtil#ALL_POS} will return the full
* result set.
*
*
* @param groupId the primary key of the group (optionally 0)
* @param folderId the primary key of the web content article folder
* @param status the web content article's workflow status. For more
* information see {@link WorkflowConstants} for constants starting
* with the "STATUS_" prefix.
* @param start the lower bound of the range of web content articles to
* return
* @param end the upper bound of the range of web content articles to
* return (not inclusive)
* @return the matching web content articles
*/
@Override
public List search(
long groupId, long folderId, int status, int start, int end) {
List folderIds = new ArrayList<>();
folderIds.add(folderId);
return search(groupId, folderIds, status, start, end);
}
/**
* Returns an ordered range of all the web content articles matching the
* parameters without using the indexer, including a keywords parameter for
* matching with the article's ID, title, description, and content, a DDM
* structure key parameter, and a DDM template key parameter. It is
* preferable to use the indexed version {@link #search(long, long, List,
* long, String, String, String, LinkedHashMap, int, int, Sort)} instead of
* this method wherever possible for performance reasons.
*
*
* Useful when paginating results. Returns a maximum of end -
* start instances. start and end are not
* primary keys, they are indexes in the result set. Thus, 0
* refers to the first result in the set. Setting both start
* and end to {@link QueryUtil#ALL_POS} will return the full
* result set.
*
*
* @param companyId the primary key of the web content article's company
* @param groupId the primary key of the group (optionally 0)
* @param folderIds the primary keys of the web content article folders
* (optionally {@link Collections#EMPTY_LIST})
* @param classNameId the primary key of the DDMStructure class if the web
* content article is related to a DDM structure, the primary key of
* the class name associated with the article, or
* JournalArticleConstants.CLASSNAME_ID_DEFAULT in the journal-api
* module otherwise
* @param keywords the keywords (space separated), which may occur in the
* web content article ID, title, description, or content
* (optionally null). If the keywords value is not
* null, the search uses the OR operator in connecting
* query criteria; otherwise it uses the AND operator.
* @param version the web content article's version (optionally
* null)
* @param ddmStructureKey the primary key of the web content article's DDM
* structure, if the article is related to a DDM structure, or
* null otherwise
* @param ddmTemplateKey the primary key of the web content article's DDM
* template
* @param displayDateGT the date after which a matching web content
* article's display date must be after (optionally
* null)
* @param displayDateLT the date before which a matching web content
* article's display date must be before (optionally
* null)
* @param status the web content article's workflow status. For more
* information see {@link WorkflowConstants} for constants starting
* with the "STATUS_" prefix.
* @param reviewDate the web content article's scheduled review date
* (optionally null)
* @param start the lower bound of the range of web content articles to
* return
* @param end the upper bound of the range of web content articles to
* return (not inclusive)
* @param obc the comparator to order the web content articles
* @return the range of matching web content articles ordered by the
* comparator
*/
@Override
public List search(
long companyId, long groupId, List folderIds, long classNameId,
String keywords, Double version, String ddmStructureKey,
String ddmTemplateKey, Date displayDateGT, Date displayDateLT,
int status, Date reviewDate, int start, int end,
OrderByComparator obc) {
return journalArticleFinder.findByKeywords(
companyId, groupId, folderIds, classNameId, keywords, version,
ddmStructureKey, ddmTemplateKey, displayDateGT, displayDateLT,
status, reviewDate, start, end, obc);
}
/**
* Returns an ordered range of all the web content articles matching the
* parameters without using the indexer, including keyword parameters for
* article ID, title, description, and content, a DDM structure key
* parameter, a DDM template key parameter, and an AND operator switch. It
* is preferable to use the indexed version {@link #search(long, long, List,
* long, String, String, String, String, int, String, String, LinkedHashMap,
* boolean, int, int, Sort)} instead of this method wherever possible for
* performance reasons.
*
*
* Useful when paginating results. Returns a maximum of end -
* start instances. start and end are not
* primary keys, they are indexes in the result set. Thus, 0
* refers to the first result in the set. Setting both start
* and end to {@link QueryUtil#ALL_POS} will return the full
* result set.
*
*
* @param companyId the primary key of the web content article's company
* @param groupId the primary key of the group (optionally 0)
* @param folderIds the primary keys of the web content article folders
* (optionally {@link Collections#EMPTY_LIST})
* @param classNameId the primary key of the DDMStructure class if the web
* content article is related to a DDM structure, the primary key of
* the class name associated with the article, or
* JournalArticleConstants.CLASSNAME_ID_DEFAULT in the journal-api
* module otherwise
* @param articleId the article ID keywords (space separated, optionally
* null)
* @param version the web content article's version (optionally
* null)
* @param title the title keywords (space separated, optionally
* null)
* @param description the description keywords (space separated, optionally
* null)
* @param content the content keywords (space separated, optionally
* null)
* @param ddmStructureKey the primary key of the web content article's DDM
* structure, if the article is related to a DDM structure, or
* null otherwise
* @param ddmTemplateKey the primary key of the web content article's DDM
* template
* @param displayDateGT the date after which a matching web content
* article's display date must be after (optionally
* null)
* @param displayDateLT the date before which a matching web content
* article's display date must be before (optionally
* null)
* @param status the web content article's workflow status. For more
* information see {@link WorkflowConstants} for constants starting
* with the "STATUS_" prefix.
* @param reviewDate the web content article's scheduled review date
* (optionally null)
* @param andOperator whether every field must match its value or keywords,
* or just one field must match. Company, group, folder IDs, class
* name ID, and status must all match their values.
* @param start the lower bound of the range of web content articles to
* return
* @param end the upper bound of the range of web content articles to
* return (not inclusive)
* @param obc the comparator to order the web content articles
* @return the range of matching web content articles ordered by the
* comparator
*/
@Override
public List search(
long companyId, long groupId, List folderIds, long classNameId,
String articleId, Double version, String title, String description,
String content, String ddmStructureKey, String ddmTemplateKey,
Date displayDateGT, Date displayDateLT, int status, Date reviewDate,
boolean andOperator, int start, int end,
OrderByComparator obc) {
QueryDefinition queryDefinition = new QueryDefinition<>(
status, start, end, obc);
return journalArticleFinder.findByC_G_F_C_A_V_T_D_C_S_T_D_R(
companyId, groupId, folderIds, classNameId, articleId, version,
title, description, content, ddmStructureKey, ddmTemplateKey,
displayDateGT, displayDateLT, reviewDate, andOperator,
queryDefinition);
}
/**
* Returns an ordered range of all the web content articles matching the
* parameters without using the indexer, including keyword parameters for
* article ID, title, description, and content, a DDM structure keys
* (plural) parameter, a DDM template keys (plural) parameter, and an AND
* operator switch.
*
*
* Useful when paginating results. Returns a maximum of end -
* start instances. start and end are not
* primary keys, they are indexes in the result set. Thus, 0
* refers to the first result in the set. Setting both start
* and end to {@link QueryUtil#ALL_POS} will return the full
* result set.
*
*
* @param companyId the primary key of the web content article's company
* @param groupId the primary key of the group (optionally 0)
* @param folderIds the primary keys of the web content article folders
* (optionally {@link Collections#EMPTY_LIST})
* @param classNameId the primary key of the DDMStructure class if the web
* content article is related to a DDM structure, the primary key of
* the class name associated with the article, or
* JournalArticleConstants.CLASSNAME_ID_DEFAULT in the journal-api
* module otherwise
* @param articleId the article ID keywords (space separated, optionally
* null)
* @param version the web content article's version (optionally
* null)
* @param title the title keywords (space separated, optionally
* null)
* @param description the description keywords (space separated, optionally
* null)
* @param content the content keywords (space separated, optionally
* null)
* @param ddmStructureKeys the primary keys of the web content article's
* DDM structures, if the article is related to a DDM structure, or
* null otherwise
* @param ddmTemplateKeys the primary keys of the web content article's DDM
* templates (originally null). If the articles are
* related to a DDM structure, the template's structure must match
* it.
* @param displayDateGT the date after which a matching web content
* article's display date must be after (optionally
* null)
* @param displayDateLT the date before which a matching web content
* article's display date must be before (optionally
* null)
* @param status the web content article's workflow status. For more
* information see {@link WorkflowConstants} for constants starting
* with the "STATUS_" prefix.
* @param reviewDate the web content article's scheduled review date
* (optionally null)
* @param andOperator whether every field must match its value or keywords,
* or just one field must match. Company, group, folder IDs, class
* name ID, and status must all match their values.
* @param start the lower bound of the range of web content articles to
* return
* @param end the upper bound of the range of web content articles to
* return (not inclusive)
* @param obc the comparator to order the web content articles
* @return the range of matching web content articles ordered by the
* comparator
*/
@Override
public List search(
long companyId, long groupId, List folderIds, long classNameId,
String articleId, Double version, String title, String description,
String content, String[] ddmStructureKeys, String[] ddmTemplateKeys,
Date displayDateGT, Date displayDateLT, int status, Date reviewDate,
boolean andOperator, int start, int end,
OrderByComparator obc) {
QueryDefinition queryDefinition = new QueryDefinition<>(
status, start, end, obc);
return journalArticleFinder.findByC_G_F_C_A_V_T_D_C_S_T_D_R(
companyId, groupId, folderIds, classNameId, articleId, version,
title, description, content, ddmStructureKeys, ddmTemplateKeys,
displayDateGT, displayDateLT, reviewDate, andOperator,
queryDefinition);
}
/**
* Returns an ordered range of all the web content articles matching the
* parameters using the indexer, including a keywords parameter for matching
* an article's ID, title, description, or content, a DDM structure key
* parameter, a DDM template key parameter, and a finder hash map parameter.
* It is preferable to use this method instead of the non-indexed version
* whenever possible for performance reasons.
*
*
* Useful when paginating results. Returns a maximum of end -
* start instances. start and end are not
* primary keys, they are indexes in the result set. Thus, 0
* refers to the first result in the set. Setting both start
* and end to {@link QueryUtil#ALL_POS} will return the full
* result set.
*
*
* @param companyId the primary key of the web content article's company
* @param groupId the primary key of the group (optionally 0)
* @param folderIds the primary keys of the web content article folders
* (optionally {@link Collections#EMPTY_LIST})
* @param classNameId the primary key of the DDMStructure class if the web
* content article is related to a DDM structure, the primary key of
* the class name associated with the article, or
* JournalArticleConstants.CLASSNAME_ID_DEFAULT in the journal-api
* module otherwise
* @param ddmStructureKey the primary key of the web content article's DDM
* structure, if the article is related to a DDM structure, or
* null otherwise
* @param ddmTemplateKey the primary key of the web content article's DDM
* template
* @param keywords the keywords (space separated), which may occur in the
* web content article ID, title, description, or content
* (optionally null). If the keywords value is not
* null, the search uses the OR operator in connecting
* query criteria; otherwise it uses the AND operator.
* @param params the finder parameters (optionally null)
* @param start the lower bound of the range of web content articles to
* return
* @param end the upper bound of the range of web content articles to
* return (not inclusive)
* @param sort the field, type, and direction by which to sort (optionally
* null)
* @return the matching web content articles ordered by sort
*/
@Override
public Hits search(
long companyId, long groupId, List folderIds, long classNameId,
String ddmStructureKey, String ddmTemplateKey, String keywords,
LinkedHashMap params, int start, int end, Sort sort) {
String articleId = null;
String title = null;
String description = null;
String content = null;
boolean andOperator = false;
if (Validator.isNotNull(keywords)) {
articleId = keywords;
title = keywords;
description = keywords;
content = keywords;
}
else {
andOperator = true;
}
if (params != null) {
params.put("keywords", keywords);
}
return search(
companyId, groupId, folderIds, classNameId, articleId, title,
description, content, WorkflowConstants.STATUS_ANY, ddmStructureKey,
ddmTemplateKey, params, andOperator, start, end, sort);
}
/**
* Returns an ordered range of all the web content articles matching the
* parameters using the indexer, including a keywords parameter for matching
* an article's ID, title, description, or content, a DDM structure key
* parameter, a DDM template key parameter, an AND operator switch, and
* parameters for type, status, a finder hash map. It is preferable to use
* this method instead of the non-indexed version whenever possible for
* performance reasons.
*
*
* Useful when paginating results. Returns a maximum of end -
* start instances. start and end are not
* primary keys, they are indexes in the result set. Thus, 0
* refers to the first result in the set. Setting both start
* and end to {@link QueryUtil#ALL_POS} will return the full
* result set.
*
*
* @param companyId the primary key of the web content article's company
* @param groupId the primary key of the group (optionally 0)
* @param folderIds the primary keys of the web content article folders
* (optionally {@link Collections#EMPTY_LIST})
* @param classNameId the primary key of the DDMStructure class if the web
* content article is related to a DDM structure, the primary key of
* the class name associated with the article, or
* JournalArticleConstants.CLASSNAME_ID_DEFAULT in the journal-api
* module otherwise
* @param articleId the article ID keywords (space separated, optionally
* null)
* @param title the title keywords (space separated, optionally
* null)
* @param description the description keywords (space separated, optionally
* null)
* @param content the content keywords (space separated, optionally
* null)
* @param status the web content article's workflow status. For more
* information see {@link WorkflowConstants} for constants starting
* with the "STATUS_" prefix.
* @param ddmStructureKey the primary key of the web content article's DDM
* structure, if the article is related to a DDM structure, or
* null otherwise
* @param ddmTemplateKey the primary key of the web content article's DDM
* template
* @param params the finder parameters (optionally null). The
* includeDiscussions parameter can be set to
* true to search for the keywords in the web content
* article discussions.
* @param andSearch whether every field must match its value or keywords,
* or just one field must match
* @param start the lower bound of the range of web content articles to
* return
* @param end the upper bound of the range of web content articles to
* return (not inclusive)
* @param sort the field, type, and direction by which to sort (optionally
* null)
* @return the matching web content articles ordered by sort
*/
@Override
public Hits search(
long companyId, long groupId, List folderIds, long classNameId,
String articleId, String title, String description, String content,
int status, String ddmStructureKey, String ddmTemplateKey,
LinkedHashMap params, boolean andSearch, int start,
int end, Sort sort) {
try {
Indexer indexer =
IndexerRegistryUtil.nullSafeGetIndexer(JournalArticle.class);
SearchContext searchContext = buildSearchContext(
companyId, groupId, folderIds, classNameId, articleId, title,
description, content, status, ddmStructureKey, ddmTemplateKey,
params, andSearch, start, end, sort);
return indexer.search(searchContext);
}
catch (Exception e) {
throw new SystemException(e);
}
}
/**
* @deprecated As of 3.3.0, replaced by {@link #search(long, long, List,
* long, String, String, String, String, int, String, String,
* LinkedHashMap, boolean, int, int, Sort)}
*/
@Deprecated
@Override
public Hits search(
long companyId, long groupId, List folderIds, long classNameId,
String articleId, String title, String description, String content,
String type, String statusString, String ddmStructureKey,
String ddmTemplateKey, LinkedHashMap params,
boolean andSearch, int start, int end, Sort sort) {
int status = GetterUtil.getInteger(statusString);
return search(
companyId, groupId, folderIds, classNameId, articleId, title,
description, content, status, ddmStructureKey, ddmTemplateKey,
params, andSearch, start, end, sort);
}
/**
* Returns a range of all the web content articles matching the group,
* creator, and status using the indexer. It is preferable to use this
* method instead of the non-indexed version whenever possible for
* performance reasons.
*
*
* Useful when paginating results. Returns a maximum of end -
* start instances. start and end are not
* primary keys, they are indexes in the result set. Thus, 0
* refers to the first result in the set. Setting both start
* and end to {@link QueryUtil#ALL_POS} will return the full
* result set.
*
*
* @param groupId the primary key of the group (optionally 0)
* @param userId the primary key of the user searching for web content
* articles
* @param creatorUserId the primary key of the web content article's
* creator
* @param status the web content article's workflow status. For more
* information see {@link WorkflowConstants} for constants starting
* with the "STATUS_" prefix.
* @param start the lower bound of the range of web content articles to
* return
* @param end the upper bound of the range of web content articles to
* return (not inclusive)
* @return the matching web content articles
*/
@Override
public Hits search(
long groupId, long userId, long creatorUserId, int status,
int start, int end)
throws PortalException {
Indexer indexer = IndexerRegistryUtil.getIndexer(
JournalArticle.class.getName());
SearchContext searchContext = buildSearchContext(
groupId, userId, creatorUserId, status, start, end);
return indexer.search(searchContext);
}
/**
* Returns the number of web content articles matching the group, folders,
* and status.
*
* @param groupId the primary key of the group (optionally 0)
* @param folderIds the primary keys of the web content article folders
* (optionally {@link Collections#EMPTY_LIST})
* @param status the web content article's workflow status. For more
* information see {@link WorkflowConstants} for constants starting
* with the "STATUS_" prefix.
* @return the number of matching web content articles
*/
@Override
public int searchCount(long groupId, List folderIds, int status) {
QueryDefinition queryDefinition = new QueryDefinition<>(
status);
return journalArticleFinder.countByG_F(
groupId, folderIds, queryDefinition);
}
/**
* Returns the number of web content articles matching the group, folder,
* and status.
*
* @param groupId the primary key of the group (optionally 0)
* @param folderId the primary key of the web content article folder
* @param status the web content article's workflow status. For more
* information see {@link WorkflowConstants} for constants starting
* with the "STATUS_" prefix.
* @return the number of matching web content articles
*/
@Override
public int searchCount(long groupId, long folderId, int status) {
List folderIds = new ArrayList<>();
folderIds.add(folderId);
return searchCount(groupId, folderIds, status);
}
/**
* Returns the number of web content articles matching the parameters,
* including a keywords parameter for matching with the article's ID, title,
* description, and content, a DDM structure key parameter, and a DDM
* template key parameter.
*
* @param companyId the primary key of the web content article's company
* @param groupId the primary key of the group (optionally 0)
* @param folderIds the primary keys of the web content article folders
* (optionally {@link Collections#EMPTY_LIST})
* @param classNameId the primary key of the DDMStructure class if the web
* content article is related to a DDM structure, the primary key of
* the class name associated with the article, or
* JournalArticleConstants.CLASSNAME_ID_DEFAULT in the journal-api
* module otherwise
* @param keywords the keywords (space separated), which may occur in the
* web content article ID, title, description, or content
* (optionally null). If the keywords value is not
* null, the search uses the OR operator in connecting
* query criteria; otherwise it uses the AND operator.
* @param version the web content article's version (optionally
* null)
* @param ddmStructureKey the primary key of the web content article's DDM
* structure, if the article is related to a DDM structure, or
* null otherwise
* @param ddmTemplateKey the primary key of the web content article's DDM
* template
* @param displayDateGT the date after which a matching web content
* article's display date must be after (optionally
* null)
* @param displayDateLT the date before which a matching web content
* article's display date must be before (optionally
* null)
* @param status the web content article's workflow status. For more
* information see {@link WorkflowConstants} for constants starting
* with the "STATUS_" prefix.
* @param reviewDate the web content article's scheduled review date
* (optionally null)
* @return the number of matching web content articles
*/
@Override
public int searchCount(
long companyId, long groupId, List folderIds, long classNameId,
String keywords, Double version, String ddmStructureKey,
String ddmTemplateKey, Date displayDateGT, Date displayDateLT,
int status, Date reviewDate) {
return journalArticleFinder.countByKeywords(
companyId, groupId, folderIds, classNameId, keywords, version,
ddmStructureKey, ddmTemplateKey, displayDateGT, displayDateLT,
status, reviewDate);
}
/**
* Returns the number of web content articles matching the parameters,
* including keyword parameters for article ID, title, description, and
* content, a DDM structure key parameter, a DDM template key parameter, and
* an AND operator switch.
*
* @param companyId the primary key of the web content article's company
* @param groupId the primary key of the group (optionally 0)
* @param folderIds the primary keys of the web content article folders
* (optionally {@link Collections#EMPTY_LIST})
* @param classNameId the primary key of the DDMStructure class if the web
* content article is related to a DDM structure, the primary key of
* the class name associated with the article, or
* JournalArticleConstants.CLASSNAME_ID_DEFAULT in the journal-api
* module otherwise
* @param articleId the article ID keywords (space separated, optionally
* null)
* @param version the web content article's version (optionally
* null)
* @param title the title keywords (space separated, optionally
* null)
* @param description the description keywords (space separated, optionally
* null)
* @param content the content keywords (space separated, optionally
* null)
* @param ddmStructureKey the primary key of the web content article's DDM
* structure, if the article is related to a DDM structure, or
* null otherwise
* @param ddmTemplateKey the primary key of the web content article's DDM
* template
* @param displayDateGT the date after which a matching web content
* article's display date must be after (optionally
* null)
* @param displayDateLT the date before which a matching web content
* article's display date must be before (optionally
* null)
* @param status the web content article's workflow status. For more
* information see {@link WorkflowConstants} for constants starting
* with the "STATUS_" prefix.
* @param reviewDate the web content article's scheduled review date
* (optionally null)
* @param andOperator whether every field must match its value or keywords,
* or just one field must match. Group, folder IDs, class name ID,
* and status must all match their values.
* @return the number of matching web content articles
*/
@Override
public int searchCount(
long companyId, long groupId, List folderIds, long classNameId,
String articleId, Double version, String title, String description,
String content, String ddmStructureKey, String ddmTemplateKey,
Date displayDateGT, Date displayDateLT, int status, Date reviewDate,
boolean andOperator) {
return journalArticleFinder.countByC_G_F_C_A_V_T_D_C_S_T_D_R(
companyId, groupId, folderIds, classNameId, articleId, version,
title, description, content, ddmStructureKey, ddmTemplateKey,
displayDateGT, displayDateLT, reviewDate, andOperator,
new QueryDefinition(status));
}
/**
* Returns the number of web content articles matching the parameters,
* including keyword parameters for article ID, title, description, and
* content, a DDM structure keys (plural) parameter, a DDM template keys
* (plural) parameter, and an AND operator switch.
*
* @param companyId the primary key of the web content article's company
* @param groupId the primary key of the group (optionally 0)
* @param folderIds the primary keys of the web content article folders
* (optionally {@link Collections#EMPTY_LIST})
* @param classNameId the primary key of the DDMStructure class if the web
* content article is related to a DDM structure, the primary key of
* the class name associated with the article, or
* JournalArticleConstants.CLASSNAME_ID_DEFAULT in the journal-api
* module otherwise
* @param articleId the article ID keywords (space separated, optionally
* null)
* @param version the web content article's version (optionally
* null)
* @param title the title keywords (space separated, optionally
* null)
* @param description the description keywords (space separated, optionally
* null)
* @param content the content keywords (space separated, optionally
* null)
* @param ddmStructureKeys the primary keys of the web content article's
* DDM structures, if the article is related to a DDM structure, or
* null otherwise
* @param ddmTemplateKeys the primary keys of the web content article's DDM
* templates (originally null). If the articles are
* related to a DDM structure, the template's structure must match
* it.
* @param displayDateGT the date after which a matching web content
* article's display date must be after (optionally
* null)
* @param displayDateLT the date before which a matching web content
* article's display date must be before (optionally
* null)
* @param status the web content article's workflow status. For more
* information see {@link WorkflowConstants} for constants starting
* with the "STATUS_" prefix.
* @param reviewDate the web content article's scheduled review date
* (optionally null)
* @param andOperator whether every field must match its value or keywords,
* or just one field must match. Group, folder IDs, class name ID,
* and status must all match their values.
* @return the number of matching web content articles
*/
@Override
public int searchCount(
long companyId, long groupId, List folderIds, long classNameId,
String articleId, Double version, String title, String description,
String content, String[] ddmStructureKeys, String[] ddmTemplateKeys,
Date displayDateGT, Date displayDateLT, int status, Date reviewDate,
boolean andOperator) {
return journalArticleFinder.countByC_G_F_C_A_V_T_D_C_S_T_D_R(
companyId, groupId, folderIds, classNameId, articleId, version,
title, description, content, ddmStructureKeys, ddmTemplateKeys,
displayDateGT, displayDateLT, reviewDate, andOperator,
new QueryDefinition(status));
}
/**
* Returns a {@link BaseModelSearchResult} containing the total number of
* hits and an ordered range of all the web content articles matching the
* parameters using the indexer, including a keywords parameter for matching
* an article's ID, title, description, or content, a DDM structure key
* parameter, a DDM template key parameter, and a finder hash map parameter.
* It is preferable to use this method instead of the non-indexed version
* whenever possible for performance reasons.
*
*
* The start and end parameters only affect the
* amount of web content articles returned as results, not the total number
* of hits.
*
*
*
* Useful when paginating results. Returns a maximum of end -
* start instances. start and end are not
* primary keys, they are indexes in the result set. Thus, 0
* refers to the first result in the set. Setting both start
* and end to {@link QueryUtil#ALL_POS} will return the full
* result set.
*
*
* @param companyId the primary key of the web content article's company
* @param groupId the primary key of the group (optionally 0)
* @param folderIds the primary keys of the web content article folders
* (optionally {@link Collections#EMPTY_LIST})
* @param classNameId the primary key of the DDMStructure class, the
* primary key of the class name associated with the article, or
* JournalArticleConstants.CLASSNAME_ID_DEFAULT in the journal-api
* module otherwise
* @param ddmStructureKey the primary key of the web content article's DDM
* structure
* @param ddmTemplateKey the primary key of the web content article's DDM
* template
* @param keywords the keywords (space separated), which may occur in the
* web content article ID, title, description, or content
* (optionally null). If the keywords value is not
* null, the search uses the OR operator in connecting
* query criteria; otherwise it uses the AND operator.
* @param params the finder parameters (optionally null)
* @param start the lower bound of the range of web content articles to
* return
* @param end the upper bound of the range of web content articles to
* return (not inclusive)
* @param sort the field, type, and direction by which to sort (optionally
* null)
* @return a {@link BaseModelSearchResult} containing the total number of
* hits and an ordered range of all the matching web content
* articles ordered by sort
*/
@Override
public BaseModelSearchResult searchJournalArticles(
long companyId, long groupId, List folderIds,
long classNameId, String ddmStructureKey, String ddmTemplateKey,
String keywords, LinkedHashMap params, int start,
int end, Sort sort)
throws PortalException {
String articleId = null;
String title = null;
String description = null;
String content = null;
boolean andOperator = false;
if (Validator.isNotNull(keywords)) {
articleId = keywords;
title = keywords;
description = keywords;
content = keywords;
}
else {
andOperator = true;
}
if (params != null) {
params.put("keywords", keywords);
}
return searchJournalArticles(
companyId, groupId, folderIds, classNameId, articleId, title,
description, content, WorkflowConstants.STATUS_ANY, ddmStructureKey,
ddmTemplateKey, params, andOperator, start, end, sort);
}
/**
* Returns a {@link BaseModelSearchResult} containing the total number of
* hits and an ordered range of all the web content articles matching the
* parameters using the indexer, including keyword parameters for article
* ID, title, description, or content, a DDM structure key parameter, a DDM
* template key parameter, an AND operator switch, and parameters for type,
* status, and a finder hash map. It is preferable to use this method
* instead of the non-indexed version whenever possible for performance
* reasons.
*
*
* The start and end parameters only affect the
* amount of web content articles returned as results, not the total number
* of hits.
*
*
*
* Useful when paginating results. Returns a maximum of end -
* start instances. start and end are not
* primary keys, they are indexes in the result set. Thus, 0
* refers to the first result in the set. Setting both start
* and end to {@link QueryUtil#ALL_POS} will return the full
* result set.
*
*
* @param companyId the primary key of the web content article's company
* @param groupId the primary key of the group (optionally 0)
* @param folderIds the primary keys of the web content article folders
* (optionally {@link Collections#EMPTY_LIST})
* @param classNameId the primary key of the DDMStructure class, the
* primary key of the class name associated with the article, or
* JournalArticleConstants.CLASSNAME_ID_DEFAULT in the journal-api
* module otherwise
* @param articleId the article ID keywords (space separated, optionally
* null)
* @param title the title keywords (space separated, optionally
* null)
* @param description the description keywords (space separated, optionally
* null)
* @param content the content keywords (space separated, optionally
* null)
* @param status the web content article's workflow status. For more
* information see {@link WorkflowConstants} for constants starting
* with the "STATUS_" prefix.
* @param ddmStructureKey the primary key of the web content article's DDM
* structure
* @param ddmTemplateKey the primary key of the web content article's DDM
* template
* @param params the finder parameters (optionally null). The
* includeDiscussions parameter can be set to
* true to search for the keywords in the web content
* article discussions.
* @param andSearch whether every field must match its value or keywords,
* or just one field must match
* @param start the lower bound of the range of web content articles to
* return
* @param end the upper bound of the range of web content articles to
* return (not inclusive)
* @param sort the field, type, and direction by which to sort (optionally
* null)
* @return a {@link BaseModelSearchResult} containing the total number of
* hits and an ordered range of all the matching web content
* articles ordered by sort
*/
@Override
public BaseModelSearchResult searchJournalArticles(
long companyId, long groupId, List folderIds,
long classNameId, String articleId, String title,
String description, String content, int status,
String ddmStructureKey, String ddmTemplateKey,
LinkedHashMap params, boolean andSearch, int start,
int end, Sort sort)
throws PortalException {
SearchContext searchContext = buildSearchContext(
companyId, groupId, folderIds, classNameId, articleId, title,
description, content, status, ddmStructureKey, ddmTemplateKey,
params, andSearch, start, end, sort);
return searchJournalArticles(searchContext);
}
/**
* Returns a {@link BaseModelSearchResult} containing the total number of
* hits and an ordered range of all the web content articles matching the
* parameters using the indexer, including the web content article's creator
* ID and status. It is preferable to use this method instead of the
* non-indexed version whenever possible for performance reasons.
*
*
* The start and end parameters only affect the
* amount of web content articles returned as results, not the total number
* of hits.
*
*
*
* Useful when paginating results. Returns a maximum of end -
* start instances. start and end are not
* primary keys, they are indexes in the result set. Thus, 0
* refers to the first result in the set. Setting both start
* and end to {@link QueryUtil#ALL_POS} will return the full
* result set.
*
*
* @param groupId the primary key of the group (optionally 0)
* @param userId the primary key of the user searching for web content
* articles
* @param creatorUserId the primary key of the web content article's
* creator
* @param status the web content article's workflow status. For more
* information see {@link WorkflowConstants} for constants starting
* with the "STATUS_" prefix.
* @param start the lower bound of the range of web content articles to
* return
* @param end the upper bound of the range of web content articles to
* return (not inclusive)
* @return a {@link BaseModelSearchResult} containing the total number of
* hits and an ordered range of all the matching web content
* articles ordered by sort
*/
@Override
public BaseModelSearchResult searchJournalArticles(
long groupId, long userId, long creatorUserId, int status,
int start, int end)
throws PortalException {
SearchContext searchContext = buildSearchContext(
groupId, userId, creatorUserId, status, start, end);
return searchJournalArticles(searchContext);
}
@Override
public void setTreePaths(
final long folderId, final String treePath, final boolean reindex)
throws PortalException {
if (treePath == null) {
throw new IllegalArgumentException("Tree path is null");
}
final IndexableActionableDynamicQuery indexableActionableDynamicQuery =
getIndexableActionableDynamicQuery();
indexableActionableDynamicQuery.setAddCriteriaMethod(
new ActionableDynamicQuery.AddCriteriaMethod() {
@Override
public void addCriteria(DynamicQuery dynamicQuery) {
Property folderIdProperty = PropertyFactoryUtil.forName(
"folderId");
dynamicQuery.add(folderIdProperty.eq(folderId));
Property treePathProperty = PropertyFactoryUtil.forName(
"treePath");
dynamicQuery.add(
RestrictionsFactoryUtil.or(
treePathProperty.isNull(),
treePathProperty.ne(treePath)));
}
});
final Indexer indexer = IndexerRegistryUtil.getIndexer(
JournalArticle.class.getName());
indexableActionableDynamicQuery.setPerformActionMethod(
new ActionableDynamicQuery.PerformActionMethod() {
@Override
public void performAction(JournalArticle article)
throws PortalException {
article.setTreePath(treePath);
updateJournalArticle(article);
if (!reindex) {
return;
}
com.liferay.portal.kernel.search.Document document =
indexer.getDocument(article);
indexableActionableDynamicQuery.addDocuments(document);
}
});
indexableActionableDynamicQuery.performActions();
}
/**
* Subscribes the user to changes in elements that belong to the web content
* article's DDM structure.
*
* @param groupId the primary key of the folder's group
* @param userId the primary key of the user to be subscribed
* @param ddmStructureId the primary key of the structure to subscribe to
*/
@Override
public void subscribeStructure(
long groupId, long userId, long ddmStructureId)
throws PortalException {
subscriptionLocalService.addSubscription(
userId, groupId, DDMStructure.class.getName(), ddmStructureId);
}
/**
* Unsubscribes the user from changes in elements that belong to the web
* content article's DDM structure.
*
* @param groupId the primary key of the folder's group
* @param userId the primary key of the user to be subscribed
* @param ddmStructureId the primary key of the structure to subscribe to
*/
@Override
public void unsubscribeStructure(
long groupId, long userId, long ddmStructureId)
throws PortalException {
subscriptionLocalService.deleteSubscription(
userId, DDMStructure.class.getName(), ddmStructureId);
}
/**
* Updates the web content article matching the version, replacing its
* folder, title, description, content, and layout UUID.
*
* @param userId the primary key of the user updating the web content
* article
* @param groupId the primary key of the web content article's group
* @param folderId the primary key of the web content article folder
* @param articleId the primary key of the web content article
* @param version the web content article's version
* @param titleMap the web content article's locales and localized titles
* @param descriptionMap the web content article's locales and localized
* descriptions
* @param content the HTML content wrapped in XML. For more information,
* see the content example in the {@link #addArticle(long, long,
* long, long, long, String, boolean, double, Map, Map, String,
* String, String, String, int, int, int, int, int, int, int, int,
* int, int, boolean, int, int, int, int, int, boolean, boolean,
* boolean, String, File, Map, String, ServiceContext)} description.
* @param layoutUuid the unique string identifying the web content
* article's display page
* @param serviceContext the service context to be applied. Can set the
* modification date, expando bridge attributes, asset category IDs,
* asset tag names, asset link entry IDs, asset priority, workflow
* actions, URL title, and can set whether to add the default
* command update for the web content article. With respect to
* social activities, by setting the service context's command to
* {@link Constants#UPDATE}, the invocation is considered a web
* content update activity; otherwise it is considered a web content
* add activity.
* @return the updated web content article
*/
@Override
public JournalArticle updateArticle(
long userId, long groupId, long folderId, String articleId,
double version, Map titleMap,
Map descriptionMap, String content,
String layoutUuid, ServiceContext serviceContext)
throws PortalException {
User user = userPersistence.findByPrimaryKey(userId);
JournalArticle article = journalArticlePersistence.findByG_A_V(
groupId, articleId, version);
Date displayDate = article.getDisplayDate();
int displayDateMonth = 0;
int displayDateDay = 0;
int displayDateYear = 0;
int displayDateHour = 0;
int displayDateMinute = 0;
if (displayDate != null) {
Calendar displayCal = CalendarFactoryUtil.getCalendar(
user.getTimeZone());
displayCal.setTime(displayDate);
displayDateMonth = displayCal.get(Calendar.MONTH);
displayDateDay = displayCal.get(Calendar.DATE);
displayDateYear = displayCal.get(Calendar.YEAR);
displayDateHour = displayCal.get(Calendar.HOUR);
displayDateMinute = displayCal.get(Calendar.MINUTE);
if (displayCal.get(Calendar.AM_PM) == Calendar.PM) {
displayDateHour += 12;
}
}
Date expirationDate = article.getExpirationDate();
int expirationDateMonth = 0;
int expirationDateDay = 0;
int expirationDateYear = 0;
int expirationDateHour = 0;
int expirationDateMinute = 0;
boolean neverExpire = true;
if (expirationDate != null) {
Calendar expirationCal = CalendarFactoryUtil.getCalendar(
user.getTimeZone());
expirationCal.setTime(expirationDate);
expirationDateMonth = expirationCal.get(Calendar.MONTH);
expirationDateDay = expirationCal.get(Calendar.DATE);
expirationDateYear = expirationCal.get(Calendar.YEAR);
expirationDateHour = expirationCal.get(Calendar.HOUR);
expirationDateMinute = expirationCal.get(Calendar.MINUTE);
neverExpire = false;
if (expirationCal.get(Calendar.AM_PM) == Calendar.PM) {
expirationDateHour += 12;
}
}
Date reviewDate = article.getReviewDate();
int reviewDateMonth = 0;
int reviewDateDay = 0;
int reviewDateYear = 0;
int reviewDateHour = 0;
int reviewDateMinute = 0;
boolean neverReview = true;
if (reviewDate != null) {
Calendar reviewCal = CalendarFactoryUtil.getCalendar(
user.getTimeZone());
reviewCal.setTime(reviewDate);
reviewDateMonth = reviewCal.get(Calendar.MONTH);
reviewDateDay = reviewCal.get(Calendar.DATE);
reviewDateYear = reviewCal.get(Calendar.YEAR);
reviewDateHour = reviewCal.get(Calendar.HOUR);
reviewDateMinute = reviewCal.get(Calendar.MINUTE);
neverReview = false;
if (reviewCal.get(Calendar.AM_PM) == Calendar.PM) {
reviewDateHour += 12;
}
}
return journalArticleLocalService.updateArticle(
userId, groupId, folderId, articleId, version, titleMap,
descriptionMap, content, article.getDDMStructureKey(),
article.getDDMTemplateKey(), layoutUuid, displayDateMonth,
displayDateDay, displayDateYear, displayDateHour, displayDateMinute,
expirationDateMonth, expirationDateDay, expirationDateYear,
expirationDateHour, expirationDateMinute, neverExpire,
reviewDateMonth, reviewDateDay, reviewDateYear, reviewDateHour,
reviewDateMinute, neverReview, article.getIndexable(),
article.isSmallImage(), article.getSmallImageURL(), null, null,
null, serviceContext);
}
/**
* Updates the web content article with additional parameters.
*
* @param userId the primary key of the user updating the web content
* article
* @param groupId the primary key of the web content article's group
* @param folderId the primary key of the web content article folder
* @param articleId the primary key of the web content article
* @param version the web content article's version
* @param titleMap the web content article's locales and localized titles
* @param descriptionMap the web content article's locales and localized
* descriptions
* @param content the HTML content wrapped in XML. For more information,
* see the content example in the {@link #addArticle(long, long,
* long, long, long, String, boolean, double, Map, Map, String,
* String, String, String, int, int, int, int, int, int, int, int,
* int, int, boolean, int, int, int, int, int, boolean, boolean,
* boolean, String, File, Map, String, ServiceContext)} description.
* @param ddmStructureKey the primary key of the web content article's DDM
* structure, if the article is related to a DDM structure, or
* null otherwise
* @param ddmTemplateKey the primary key of the web content article's DDM
* template
* @param layoutUuid the unique string identifying the web content
* article's display page
* @param displayDateMonth the month the web content article is set to
* display
* @param displayDateDay the calendar day the web content article is set to
* display
* @param displayDateYear the year the web content article is set to
* display
* @param displayDateHour the hour the web content article is set to
* display
* @param displayDateMinute the minute the web content article is set to
* display
* @param expirationDateMonth the month the web content article is set to
* expire
* @param expirationDateDay the calendar day the web content article is set
* to expire
* @param expirationDateYear the year the web content article is set to
* expire
* @param expirationDateHour the hour the web content article is set to
* expire
* @param expirationDateMinute the minute the web content article is set to
* expire
* @param neverExpire whether the web content article is not set to auto
* expire
* @param reviewDateMonth the month the web content article is set for
* review
* @param reviewDateDay the calendar day the web content article is set for
* review
* @param reviewDateYear the year the web content article is set for review
* @param reviewDateHour the hour the web content article is set for review
* @param reviewDateMinute the minute the web content article is set for
* review
* @param neverReview whether the web content article is not set for review
* @param indexable whether the web content is searchable
* @param smallImage whether to update web content article's a small image.
* A file must be passed in as smallImageFile value,
* otherwise the current small image is deleted.
* @param smallImageURL the web content article's small image URL
* (optionally null)
* @param smallImageFile the web content article's new small image file
* (optionally null). Must pass in
* smallImage value of true to replace the
* article's small image file.
* @param images the web content's images (optionally null)
* @param articleURL the web content article's accessible URL (optionally
* null)
* @param serviceContext the service context to be applied. Can set the
* modification date, expando bridge attributes, asset category IDs,
* asset tag names, asset link entry IDs, asset priority, workflow
* actions, URL title , and can set whether to add the default
* command update for the web content article. With respect to
* social activities, by setting the service context's command to
* {@link Constants#UPDATE}, the invocation is considered a web
* content update activity; otherwise it is considered a web content
* add activity.
* @return the updated web content article
*/
@Indexable(type = IndexableType.REINDEX)
@Override
public JournalArticle updateArticle(
long userId, long groupId, long folderId, String articleId,
double version, Map titleMap,
Map descriptionMap, String content,
String ddmStructureKey, String ddmTemplateKey, String layoutUuid,
int displayDateMonth, int displayDateDay, int displayDateYear,
int displayDateHour, int displayDateMinute, int expirationDateMonth,
int expirationDateDay, int expirationDateYear,
int expirationDateHour, int expirationDateMinute,
boolean neverExpire, int reviewDateMonth, int reviewDateDay,
int reviewDateYear, int reviewDateHour, int reviewDateMinute,
boolean neverReview, boolean indexable, boolean smallImage,
String smallImageURL, File smallImageFile,
Map images, String articleURL,
ServiceContext serviceContext)
throws PortalException {
// Article
User user = userPersistence.findByPrimaryKey(userId);
articleId = StringUtil.toUpperCase(articleId.trim());
byte[] smallImageBytes = null;
try {
smallImageBytes = FileUtil.getBytes(smallImageFile);
}
catch (IOException ioe) {
}
JournalArticle latestArticle = getLatestArticle(
groupId, articleId, WorkflowConstants.STATUS_ANY);
JournalArticle article = latestArticle;
boolean imported = ExportImportThreadLocal.isImportInProcess();
double latestVersion = latestArticle.getVersion();
boolean addNewVersion = false;
if (imported) {
article = getArticle(groupId, articleId, version);
}
else {
if ((version > 0) && (version != latestVersion)) {
StringBundler sb = new StringBundler(4);
sb.append("Version ");
sb.append(version);
sb.append(" is not the same as ");
sb.append(latestVersion);
throw new ArticleVersionException(sb.toString());
}
serviceContext.validateModifiedDate(
latestArticle, ArticleVersionException.class);
if (latestArticle.isApproved() || latestArticle.isExpired() ||
latestArticle.isScheduled()) {
addNewVersion = true;
version = getNextVersion(article);
}
}
Date displayDate = null;
Date expirationDate = null;
Date reviewDate = null;
if (article.getClassNameId() ==
JournalArticleConstants.CLASSNAME_ID_DEFAULT) {
displayDate = PortalUtil.getDate(
displayDateMonth, displayDateDay, displayDateYear,
displayDateHour, displayDateMinute, user.getTimeZone(),
ArticleDisplayDateException.class);
if (!neverExpire) {
expirationDate = PortalUtil.getDate(
expirationDateMonth, expirationDateDay, expirationDateYear,
expirationDateHour, expirationDateMinute,
user.getTimeZone(), ArticleExpirationDateException.class);
}
if (!neverReview) {
reviewDate = PortalUtil.getDate(
reviewDateMonth, reviewDateDay, reviewDateYear,
reviewDateHour, reviewDateMinute, user.getTimeZone(),
ArticleReviewDateException.class);
}
}
Date now = new Date();
boolean expired = false;
if ((expirationDate != null) && expirationDate.before(now)) {
expired = true;
}
validate(
user.getCompanyId(), groupId, latestArticle.getClassNameId(),
titleMap, content, ddmStructureKey, ddmTemplateKey, displayDate,
expirationDate, smallImage, smallImageURL, smallImageFile,
smallImageBytes, serviceContext);
validateReferences(
groupId, ddmStructureKey, ddmTemplateKey, layoutUuid, smallImage,
smallImageURL, smallImageBytes, latestArticle.getSmallImageId(),
content);
if (addNewVersion) {
long id = counterLocalService.increment();
article = journalArticlePersistence.create(id);
article.setResourcePrimKey(latestArticle.getResourcePrimKey());
article.setGroupId(latestArticle.getGroupId());
article.setCompanyId(latestArticle.getCompanyId());
article.setUserId(user.getUserId());
article.setUserName(user.getFullName());
article.setCreateDate(latestArticle.getCreateDate());
article.setClassNameId(latestArticle.getClassNameId());
article.setClassPK(latestArticle.getClassPK());
article.setArticleId(articleId);
article.setVersion(version);
article.setSmallImageId(latestArticle.getSmallImageId());
}
Locale locale = getArticleDefaultLocale(content);
String title = titleMap.get(locale);
content = format(
user, groupId, articleId, article.getVersion(), addNewVersion,
content, images);
article.setFolderId(folderId);
article.setTreePath(article.buildTreePath());
article.setTitleMap(titleMap, locale);
article.setUrlTitle(
getUniqueUrlTitle(
article.getId(), groupId, article.getArticleId(), title,
latestArticle.getUrlTitle(), serviceContext));
article.setDescriptionMap(descriptionMap, locale);
article.setContent(content);
article.setDDMStructureKey(ddmStructureKey);
article.setDDMTemplateKey(ddmTemplateKey);
article.setLayoutUuid(layoutUuid);
article.setDisplayDate(displayDate);
article.setExpirationDate(expirationDate);
article.setReviewDate(reviewDate);
article.setIndexable(indexable);
article.setSmallImage(smallImage);
if (smallImage) {
if ((smallImageFile != null) && (smallImageBytes != null)) {
article.setSmallImageId(counterLocalService.increment());
}
}
else {
article.setSmallImageId(0);
}
article.setSmallImageURL(smallImageURL);
if (latestArticle.isPending()) {
article.setStatus(latestArticle.getStatus());
}
else if (!expired) {
article.setStatus(WorkflowConstants.STATUS_DRAFT);
}
else {
article.setStatus(WorkflowConstants.STATUS_EXPIRED);
}
ExpandoBridgeUtil.setExpandoBridgeAttributes(
latestArticle.getExpandoBridge(), article.getExpandoBridge(),
serviceContext);
journalArticlePersistence.update(article);
// Asset
updateAsset(
userId, article, serviceContext.getAssetCategoryIds(),
serviceContext.getAssetTagNames(),
serviceContext.getAssetLinkEntryIds(),
serviceContext.getAssetPriority());
// Dynamic data mapping
if (classNameLocalService.getClassNameId(DDMStructure.class) ==
article.getClassNameId()) {
updateDDMStructurePredefinedValues(
article.getClassPK(), content, serviceContext);
}
else {
updateDDMLinks(
article.getId(), groupId, ddmStructureKey, ddmTemplateKey,
addNewVersion);
}
// Small image
saveImages(
smallImage, article.getSmallImageId(), smallImageFile,
smallImageBytes);
// Email
PortletPreferences preferences =
ServiceContextUtil.getPortletPreferences(serviceContext);
// Workflow
if (expired && imported) {
updateStatus(
userId, article, article.getStatus(), articleURL,
serviceContext, new HashMap());
}
if (serviceContext.getWorkflowAction() ==
WorkflowConstants.ACTION_PUBLISH) {
articleURL = buildArticleURL(
articleURL, groupId, folderId, articleId);
serviceContext.setAttribute("articleURL", articleURL);
sendEmail(
article, articleURL, preferences, "requested", serviceContext);
startWorkflowInstance(userId, article, serviceContext);
}
return journalArticlePersistence.findByPrimaryKey(article.getId());
}
/**
* Updates the web content article matching the version, replacing its
* folder and content.
*
* @param userId the primary key of the user updating the web content
* article
* @param groupId the primary key of the web content article's group
* @param folderId the primary key of the web content article folder
* @param articleId the primary key of the web content article
* @param version the web content article's version
* @param content the HTML content wrapped in XML. For more information,
* see the content example in the {@link #addArticle(long, long,
* long, long, long, String, boolean, double, Map, Map, String,
* String, String, String, int, int, int, int, int, int, int, int,
* int, int, boolean, int, int, int, int, int, boolean, boolean,
* boolean, String, File, Map, String, ServiceContext)} description.
* @param serviceContext the service context to be applied. Can set the
* modification date, expando bridge attributes, asset category IDs,
* asset tag names, asset link entry IDs, asset priority, workflow
* actions, URL title, and can set whether to add the default
* command update for the web content article. With respect to
* social activities, by setting the service context's command to
* {@link Constants#UPDATE}, the invocation is considered a web
* content update activity; otherwise it is considered a web content
* add activity.
* @return the updated web content article
*/
@Override
public JournalArticle updateArticle(
long userId, long groupId, long folderId, String articleId,
double version, String content, ServiceContext serviceContext)
throws PortalException {
JournalArticle article = journalArticlePersistence.findByG_A_V(
groupId, articleId, version);
return journalArticleLocalService.updateArticle(
userId, groupId, folderId, articleId, version,
article.getTitleMap(), article.getDescriptionMap(), content,
article.getLayoutUuid(), serviceContext);
}
/**
* Updates the translation of the web content article.
*
* @param groupId the primary key of the web content article's group
* @param articleId the primary key of the web content article
* @param version the web content article's version
* @param locale the locale of the web content article's display template
* @param title the translated web content article title
* @param description the translated web content article description
* @param content the HTML content wrapped in XML. For more information,
* see the content example in the {@link #addArticle(long, long,
* long, long, long, String, boolean, double, Map, Map, String,
* String, String, String, int, int, int, int, int, int, int, int,
* int, int, boolean, int, int, int, int, int, boolean, boolean,
* boolean, String, File, Map, String, ServiceContext)} description.
* @param images the web content's images
* @param serviceContext the service context to be applied. Can set the
* modification date and URL title for the web content article.
* @return the updated web content article
*/
@Indexable(type = IndexableType.REINDEX)
@Override
public JournalArticle updateArticleTranslation(
long groupId, String articleId, double version, Locale locale,
String title, String description, String content,
Map images, ServiceContext serviceContext)
throws PortalException {
validateContent(content);
JournalArticle oldArticle = getLatestArticle(
groupId, articleId, WorkflowConstants.STATUS_ANY);
double oldVersion = oldArticle.getVersion();
if ((version > 0) && (version != oldVersion)) {
StringBundler sb = new StringBundler(4);
sb.append("Version ");
sb.append(version);
sb.append(" is not the same as ");
sb.append(oldVersion);
throw new ArticleVersionException(sb.toString());
}
boolean incrementVersion = false;
if (oldArticle.isApproved() || oldArticle.isExpired()) {
incrementVersion = true;
}
if (serviceContext != null) {
serviceContext.validateModifiedDate(
oldArticle, ArticleVersionException.class);
}
JournalArticle article = null;
User user = userPersistence.fetchByC_U(
oldArticle.getCompanyId(), oldArticle.getUserId());
if (user == null) {
user = userPersistence.fetchByC_DU(oldArticle.getCompanyId(), true);
}
Locale defaultLocale = getArticleDefaultLocale(content);
if (incrementVersion) {
double newVersion = getNextVersion(oldArticle);
long id = counterLocalService.increment();
article = journalArticlePersistence.create(id);
article.setResourcePrimKey(oldArticle.getResourcePrimKey());
article.setGroupId(oldArticle.getGroupId());
article.setCompanyId(oldArticle.getCompanyId());
article.setUserId(oldArticle.getUserId());
article.setUserName(user.getFullName());
article.setCreateDate(oldArticle.getCreateDate());
article.setFolderId(oldArticle.getFolderId());
article.setClassNameId(oldArticle.getClassNameId());
article.setClassPK(oldArticle.getClassPK());
article.setArticleId(articleId);
article.setVersion(newVersion);
article.setTitleMap(oldArticle.getTitleMap(), defaultLocale);
article.setUrlTitle(
getUniqueUrlTitle(
id, groupId, articleId, title, oldArticle.getUrlTitle(),
serviceContext));
article.setDescriptionMap(oldArticle.getDescriptionMap());
article.setDDMStructureKey(oldArticle.getDDMStructureKey());
article.setDDMTemplateKey(oldArticle.getDDMTemplateKey());
article.setLayoutUuid(oldArticle.getLayoutUuid());
article.setDisplayDate(oldArticle.getDisplayDate());
article.setExpirationDate(oldArticle.getExpirationDate());
article.setReviewDate(oldArticle.getReviewDate());
article.setIndexable(oldArticle.getIndexable());
article.setSmallImage(oldArticle.getSmallImage());
article.setSmallImageId(oldArticle.getSmallImageId());
if (article.getSmallImageId() == 0) {
article.setSmallImageId(counterLocalService.increment());
}
article.setSmallImageURL(oldArticle.getSmallImageURL());
article.setStatus(WorkflowConstants.STATUS_DRAFT);
article.setStatusDate(new Date());
ExpandoBridgeUtil.copyExpandoBridgeAttributes(
oldArticle.getExpandoBridge(), article.getExpandoBridge());
// Dynamic data mapping
updateDDMLinks(
id, groupId, oldArticle.getDDMStructureKey(),
oldArticle.getDDMTemplateKey(), true);
}
else {
article = oldArticle;
}
Map titleMap = article.getTitleMap();
titleMap.put(locale, title);
article.setTitleMap(titleMap, defaultLocale);
Map descriptionMap = article.getDescriptionMap();
descriptionMap.put(locale, description);
article.setDescriptionMap(descriptionMap);
content = format(
user, groupId, articleId, article.getVersion(),
!oldArticle.isDraft(), content, images);
article.setContent(content);
journalArticlePersistence.update(article);
return article;
}
/**
* Updates the web content article's asset with the new asset categories,
* tag names, and link entries, removing and adding them as necessary.
*
* @param userId the primary key of the user updating the web content
* article's asset
* @param article the web content article
* @param assetCategoryIds the primary keys of the new asset categories
* @param assetTagNames the new asset tag names
* @param assetLinkEntryIds the primary keys of the new asset link
* entries
* @deprecated As of 3.3.0, replaced by {@link #updateAsset(long,
* JournalArticle, long[], String[], long[], Double)}
*/
@Deprecated
@Override
public void updateAsset(
long userId, JournalArticle article, long[] assetCategoryIds,
String[] assetTagNames, long[] assetLinkEntryIds)
throws PortalException {
updateAsset(
userId, article, assetCategoryIds, assetTagNames, assetLinkEntryIds,
null);
}
/**
* Updates the web content article's asset with the new asset categories,
* tag names, and link entries, removing and adding them as necessary.
*
* @param userId the primary key of the user updating the web content
* article's asset
* @param article the web content article
* @param assetCategoryIds the primary keys of the new asset categories
* @param assetTagNames the new asset tag names
* @param assetLinkEntryIds the primary keys of the new asset link entries
* @param priority the priority of the asset
*/
@Override
public void updateAsset(
long userId, JournalArticle article, long[] assetCategoryIds,
String[] assetTagNames, long[] assetLinkEntryIds, Double priority)
throws PortalException {
boolean visible = article.isApproved();
if (article.getClassNameId() !=
JournalArticleConstants.CLASSNAME_ID_DEFAULT) {
visible = false;
}
boolean addDraftAssetEntry = false;
if (!article.isApproved() &&
(article.getVersion() != JournalArticleConstants.VERSION_DEFAULT)) {
int approvedArticlesCount = journalArticlePersistence.countByG_A_ST(
article.getGroupId(), article.getArticleId(),
JournalArticleConstants.ASSET_ENTRY_CREATION_STATUSES);
if (approvedArticlesCount > 0) {
addDraftAssetEntry = true;
}
}
AssetEntry assetEntry = null;
if (addDraftAssetEntry) {
assetEntry = assetEntryLocalService.updateEntry(
userId, article.getGroupId(), article.getCreateDate(),
article.getModifiedDate(), JournalArticle.class.getName(),
article.getPrimaryKey(), article.getUuid(),
getClassTypeId(article), assetCategoryIds, assetTagNames,
isListable(article), false, null, null, null, null,
ContentTypes.TEXT_HTML, article.getTitle(),
article.getDescription(), article.getDescription(), null,
article.getLayoutUuid(), 0, 0, priority);
}
else {
JournalArticleResource journalArticleResource =
journalArticleResourceLocalService.getArticleResource(
article.getResourcePrimKey());
assetEntry = assetEntryLocalService.updateEntry(
userId, article.getGroupId(), article.getCreateDate(),
article.getModifiedDate(), JournalArticle.class.getName(),
journalArticleResource.getResourcePrimKey(),
journalArticleResource.getUuid(), getClassTypeId(article),
assetCategoryIds, assetTagNames, isListable(article), visible,
null, null, null, null, ContentTypes.TEXT_HTML,
article.getTitle(), article.getDescription(),
article.getDescription(), null, article.getLayoutUuid(), 0, 0,
priority);
}
assetLinkLocalService.updateLinks(
userId, assetEntry.getEntryId(), assetLinkEntryIds,
AssetLinkConstants.TYPE_RELATED);
}
/**
* Updates the web content article matching the group, article ID, and
* version, replacing its content.
*
* @param groupId the primary key of the web content article's group
* @param articleId the primary key of the web content article
* @param version the web content article's version
* @param content the HTML content wrapped in XML. For more information,
* see the content example in the {@link #addArticle(long, long,
* long, long, long, String, boolean, double, Map, Map, String,
* String, String, String, int, int, int, int, int, int, int, int,
* int, int, boolean, int, int, int, int, int, boolean, boolean,
* boolean, String, File, Map, String, ServiceContext)} description.
* @return the updated web content article
*/
@Indexable(type = IndexableType.REINDEX)
@Override
public JournalArticle updateContent(
long groupId, String articleId, double version, String content)
throws PortalException {
JournalArticle article = journalArticlePersistence.findByG_A_V(
groupId, articleId, version);
article.setContent(content);
journalArticlePersistence.update(article);
return article;
}
/**
* Updates the web content articles matching the group, class name ID, and
* DDM template key, replacing the DDM template key with a new one.
*
* @param groupId the primary key of the web content article's group
* @param classNameId the primary key of the DDMStructure class if the web
* content article is related to a DDM structure, the primary key of
* the class name associated with the article, or
* JournalArticleConstants.CLASSNAME_ID_DEFAULT in the journal-api
* module otherwise
* @param oldDDMTemplateKey the primary key of the web content article's old
* DDM template
* @param newDDMTemplateKey the primary key of the web content article's new
* DDM template
*/
@Override
public void updateDDMTemplateKey(
long groupId, long classNameId, String oldDDMTemplateKey,
String newDDMTemplateKey) {
List articles =
journalArticlePersistence.findByG_C_DDMTK(
groupId, classNameId, oldDDMTemplateKey);
for (JournalArticle article : articles) {
article.setDDMTemplateKey(newDDMTemplateKey);
journalArticlePersistence.update(article);
}
}
/**
* Updates the workflow status of the web content article.
*
* @param userId the primary key of the user updating the web content
* article's status
* @param article the web content article
* @param status the web content article's workflow status. For more
* information see {@link WorkflowConstants} for constants starting
* with the "STATUS_" prefix.
* @param articleURL the web content article's accessible URL
* @param serviceContext the service context to be applied. Can set the
* modification date, status date, and portlet preferences. With
* respect to social activities, by setting the service context's
* command to {@link Constants#UPDATE}, the invocation is considered
* a web content update activity; otherwise it is considered a web
* content add activity.
* @param workflowContext the web content article's configured workflow
* context
* @return the updated web content article
*/
@Indexable(type = IndexableType.REINDEX)
@Override
public JournalArticle updateStatus(
long userId, JournalArticle article, int status, String articleURL,
ServiceContext serviceContext,
Map workflowContext)
throws PortalException {
// Article
User user = userPersistence.findByPrimaryKey(userId);
Date now = new Date();
if ((status == WorkflowConstants.STATUS_APPROVED) &&
(article.getClassNameId() ==
JournalArticleConstants.CLASSNAME_ID_DEFAULT) &&
(article.getDisplayDate() != null) &&
now.before(article.getDisplayDate())) {
status = WorkflowConstants.STATUS_SCHEDULED;
}
int oldStatus = article.getStatus();
Date modifiedDate = serviceContext.getModifiedDate(now);
article.setModifiedDate(modifiedDate);
if (status == WorkflowConstants.STATUS_APPROVED) {
Date expirationDate = article.getExpirationDate();
if ((expirationDate != null) && expirationDate.before(now)) {
article.setExpirationDate(null);
}
}
if (status == WorkflowConstants.STATUS_EXPIRED) {
article.setExpirationDate(now);
}
article.setStatus(status);
article.setStatusByUserId(user.getUserId());
article.setStatusByUserName(user.getFullName());
article.setStatusDate(modifiedDate);
journalArticlePersistence.update(article);
if (JournalServiceConfigurationValues.
JOURNAL_ARTICLE_EXPIRE_ALL_VERSIONS) {
setArticlesExpirationDate(article);
}
if (hasModifiedLatestApprovedVersion(
article.getGroupId(), article.getArticleId(),
article.getVersion())) {
if (status == WorkflowConstants.STATUS_APPROVED) {
updateUrlTitles(
article.getGroupId(), article.getArticleId(),
article.getUrlTitle());
// Asset
if ((oldStatus != WorkflowConstants.STATUS_APPROVED) &&
(article.getVersion() !=
JournalArticleConstants.VERSION_DEFAULT)) {
AssetEntry draftAssetEntry =
assetEntryLocalService.fetchEntry(
JournalArticle.class.getName(),
article.getPrimaryKey());
if (draftAssetEntry != null) {
long[] assetCategoryIds =
draftAssetEntry.getCategoryIds();
String[] assetTagNames = draftAssetEntry.getTagNames();
List assetLinks =
assetLinkLocalService.getDirectLinks(
draftAssetEntry.getEntryId(),
AssetLinkConstants.TYPE_RELATED, false);
long[] assetLinkEntryIds = ListUtil.toLongArray(
assetLinks, AssetLink.ENTRY_ID2_ACCESSOR);
AssetEntry assetEntry =
assetEntryLocalService.updateEntry(
userId, article.getGroupId(),
article.getCreateDate(),
article.getModifiedDate(),
JournalArticle.class.getName(),
article.getResourcePrimKey(), article.getUuid(),
getClassTypeId(article), assetCategoryIds,
assetTagNames, isListable(article), false, null,
null, null, null, ContentTypes.TEXT_HTML,
article.getTitle(), article.getDescription(),
article.getDescription(), null,
article.getLayoutUuid(), 0, 0,
draftAssetEntry.getPriority());
assetLinkLocalService.updateLinks(
userId, assetEntry.getEntryId(), assetLinkEntryIds,
AssetLinkConstants.TYPE_RELATED);
assetEntryLocalService.deleteEntry(draftAssetEntry);
}
}
if (article.getClassNameId() ==
JournalArticleConstants.CLASSNAME_ID_DEFAULT) {
assetEntryLocalService.updateEntry(
JournalArticle.class.getName(),
article.getResourcePrimKey(), article.getDisplayDate(),
article.getExpirationDate(), isListable(article), true);
}
// Social
JSONObject extraDataJSONObject =
JSONFactoryUtil.createJSONObject();
extraDataJSONObject.put("title", article.getTitle());
if (serviceContext.isCommandUpdate()) {
SocialActivityManagerUtil.addActivity(
user.getUserId(), article,
JournalActivityKeys.UPDATE_ARTICLE,
extraDataJSONObject.toString(), 0);
}
else {
SocialActivityManagerUtil.addUniqueActivity(
user.getUserId(), article,
JournalActivityKeys.ADD_ARTICLE,
extraDataJSONObject.toString(), 0);
}
}
else if (oldStatus == WorkflowConstants.STATUS_APPROVED) {
updatePreviousApprovedArticle(article);
}
}
if ((article.getClassNameId() ==
JournalArticleConstants.CLASSNAME_ID_DEFAULT) &&
(oldStatus != WorkflowConstants.STATUS_IN_TRASH) &&
(status != WorkflowConstants.STATUS_IN_TRASH)) {
// Email
if ((oldStatus == WorkflowConstants.STATUS_PENDING) &&
((status == WorkflowConstants.STATUS_APPROVED) ||
(status == WorkflowConstants.STATUS_DENIED))) {
String msg = "granted";
if (status == WorkflowConstants.STATUS_DENIED) {
msg = "denied";
}
try {
PortletPreferences preferences =
ServiceContextUtil.getPortletPreferences(
serviceContext);
articleURL = buildArticleURL(
articleURL, article.getGroupId(), article.getFolderId(),
article.getArticleId());
sendEmail(
article, articleURL, preferences, msg, serviceContext);
}
catch (Exception e) {
_log.error(
"Unable to send email to notify the change of status " +
"to " + msg + " for article " + article.getId() +
": " + e.getMessage());
}
}
// Subscriptions
String action = "update";
if (article.getVersion() == 1.0) {
action = "add";
}
notifySubscribers(
user.getUserId(), article,
(String)workflowContext.get(WorkflowConstants.CONTEXT_URL),
action, serviceContext);
}
return article;
}
/**
* Updates the workflow status of the web content article matching the class
* PK.
*
* @param userId the primary key of the user updating the web content
* article's status
* @param classPK the primary key of the DDM structure, if the web content
* article is related to a DDM structure, the primary key of the
* class associated with the article, or 0 otherwise
* @param status the web content article's workflow status. For more
* information see {@link WorkflowConstants} for constants starting
* with the "STATUS_" prefix.
* @param workflowContext the web content article's configured workflow
* @param serviceContext the service context to be applied. Can set the
* modification date, portlet preferences, and can set whether to
* add the default command update for the web content article.
* @return the updated web content article
*/
@Override
public JournalArticle updateStatus(
long userId, long classPK, int status,
Map workflowContext,
ServiceContext serviceContext)
throws PortalException {
JournalArticle article = getArticle(classPK);
return journalArticleLocalService.updateStatus(
userId, article, status, null, serviceContext, workflowContext);
}
/**
* Updates the workflow status of the web content article matching the
* group, article ID, and version.
*
* @param userId the primary key of the user updating the web content
* article's status
* @param groupId the primary key of the web content article's group
* @param articleId the primary key of the web content article
* @param version the web content article's version
* @param status the web content article's workflow status. For more
* information see {@link WorkflowConstants} for constants starting
* with the "STATUS_" prefix.
* @param articleURL the web content article's accessible URL
* @param workflowContext the web content article's configured workflow
* @param serviceContext the service context to be applied. Can set the
* modification date, portlet preferences, and can set whether to
* add the default command update for the web content article.
* @return the updated web content article
*/
@Override
public JournalArticle updateStatus(
long userId, long groupId, String articleId, double version,
int status, String articleURL,
Map workflowContext,
ServiceContext serviceContext)
throws PortalException {
JournalArticle article = journalArticlePersistence.findByG_A_V(
groupId, articleId, version);
return journalArticleLocalService.updateStatus(
userId, article, status, articleURL, serviceContext,
workflowContext);
}
/**
* Updates the web content articles matching the group, class name ID, and
* DDM template key, replacing the DDM template key with a new one.
*
* @param groupId the primary key of the web content article's group
* @param classNameId the primary key of the DDMStructure class if the
* web content article is related to a DDM structure, the
* primary key of the class name associated with the article, or
* JournalArticleConstants.CLASSNAME_ID_DEFAULT in the
* journal-api module otherwise
* @param oldDDMTemplateKey the primary key of the web content
* article's old DDM template
* @param newDDMTemplateKey the primary key of the web content
* article's new DDM template
* @deprecated As of 3.3.0, replaced by {@link #updateDDMTemplateKey}
*/
@Deprecated
@Override
public void updateTemplateId(
long groupId, long classNameId, String oldDDMTemplateKey,
String newDDMTemplateKey) {
updateDDMTemplateKey(
groupId, classNameId, oldDDMTemplateKey, newDDMTemplateKey);
}
protected String buildArticleURL(
String articleURL, long groupId, long folderId, String articleId) {
String portletId = PortletProviderUtil.getPortletId(
JournalArticle.class.getName(), PortletProvider.Action.EDIT);
String namespace = PortalUtil.getPortletNamespace(portletId);
articleURL = HttpUtil.addParameter(
articleURL, namespace + "groupId", groupId);
articleURL = HttpUtil.addParameter(
articleURL, namespace + "folderId", folderId);
articleURL = HttpUtil.addParameter(
articleURL, namespace + "articleId", articleId);
return articleURL;
}
protected SearchContext buildSearchContext(
long companyId, long groupId, List folderIds, long classNameId,
String articleId, String title, String description, String content,
int status, String ddmStructureKey, String ddmTemplateKey,
LinkedHashMap params, boolean andSearch, int start,
int end, Sort sort) {
SearchContext searchContext = new SearchContext();
searchContext.setAndSearch(andSearch);
Map attributes = new HashMap<>();
attributes.put(Field.ARTICLE_ID, articleId);
attributes.put(Field.CLASS_NAME_ID, classNameId);
attributes.put(Field.CONTENT, content);
attributes.put(Field.DESCRIPTION, description);
attributes.put(Field.STATUS, status);
attributes.put(Field.TITLE, title);
attributes.put("ddmStructureKey", ddmStructureKey);
attributes.put("ddmTemplateKey", ddmTemplateKey);
attributes.put("params", params);
searchContext.setAttributes(attributes);
searchContext.setCompanyId(companyId);
searchContext.setEnd(end);
searchContext.setFolderIds(folderIds);
searchContext.setGroupIds(new long[] {groupId});
if (params != null) {
searchContext.setIncludeDiscussions(
GetterUtil.getBoolean(params.get("includeDiscussions")));
String keywords = (String)params.remove("keywords");
if (Validator.isNotNull(keywords)) {
searchContext.setKeywords(keywords);
}
}
QueryConfig queryConfig = new QueryConfig();
queryConfig.setHighlightEnabled(false);
queryConfig.setScoreEnabled(false);
searchContext.setQueryConfig(queryConfig);
if (sort != null) {
searchContext.setSorts(sort);
}
searchContext.setStart(start);
return searchContext;
}
protected SearchContext buildSearchContext(
long groupId, long userId, long creatorUserId, int status,
int start, int end)
throws PortalException {
SearchContext searchContext = new SearchContext();
searchContext.setAttribute(Field.STATUS, status);
searchContext.setAttribute("paginationType", "none");
if (creatorUserId > 0) {
searchContext.setAttribute(
Field.USER_ID, String.valueOf(creatorUserId));
}
Group group = groupLocalService.getGroup(groupId);
searchContext.setCompanyId(group.getCompanyId());
searchContext.setEnd(end);
searchContext.setGroupIds(new long[] {groupId});
searchContext.setSorts(new Sort(Field.MODIFIED_DATE, true));
searchContext.setStart(start);
searchContext.setUserId(userId);
return searchContext;
}
protected void checkArticlesByDisplayDate(Date displayDate)
throws PortalException {
String portletId = PortletProviderUtil.getPortletId(
JournalArticle.class.getName(), PortletProvider.Action.EDIT);
List articles = journalArticlePersistence.findByLtD_S(
displayDate, WorkflowConstants.STATUS_SCHEDULED);
for (JournalArticle article : articles) {
long userId = PortalUtil.getValidUserId(
article.getCompanyId(), article.getUserId());
ServiceContext serviceContext = new ServiceContext();
serviceContext.setCommand(Constants.UPDATE);
String layoutFullURL = PortalUtil.getLayoutFullURL(
article.getGroupId(), portletId);
serviceContext.setLayoutFullURL(layoutFullURL);
serviceContext.setScopeGroupId(article.getGroupId());
journalArticleLocalService.updateStatus(
userId, article, WorkflowConstants.STATUS_APPROVED, null,
serviceContext, new HashMap());
}
}
protected void checkArticlesByExpirationDate(Date expirationDate)
throws PortalException {
List articles =
journalArticleFinder.findByExpirationDate(
JournalArticleConstants.CLASSNAME_ID_DEFAULT,
new Date(
expirationDate.getTime() + _JOURNAL_ARTICLE_CHECK_INTERVAL),
new QueryDefinition(
WorkflowConstants.STATUS_APPROVED));
if (_log.isDebugEnabled()) {
_log.debug("Expiring " + articles.size() + " articles");
}
for (JournalArticle article : articles) {
if (JournalServiceConfigurationValues.
JOURNAL_ARTICLE_EXPIRE_ALL_VERSIONS) {
List currentArticles =
journalArticlePersistence.findByG_A(
article.getGroupId(), article.getArticleId(),
QueryUtil.ALL_POS, QueryUtil.ALL_POS,
new ArticleVersionComparator(true));
for (JournalArticle currentArticle : currentArticles) {
if ((currentArticle.getExpirationDate() == null) ||
(currentArticle.getVersion() > article.getVersion())) {
continue;
}
currentArticle.setExpirationDate(
article.getExpirationDate());
currentArticle.setStatus(WorkflowConstants.STATUS_EXPIRED);
journalArticlePersistence.update(currentArticle);
}
}
else {
article.setStatus(WorkflowConstants.STATUS_EXPIRED);
journalArticlePersistence.update(article);
}
updatePreviousApprovedArticle(article);
Indexer indexer =
IndexerRegistryUtil.nullSafeGetIndexer(JournalArticle.class);
indexer.reindex(article);
}
if (_previousCheckDate == null) {
_previousCheckDate = new Date(
expirationDate.getTime() - _JOURNAL_ARTICLE_CHECK_INTERVAL);
}
}
protected void checkArticlesByReviewDate(Date reviewDate)
throws PortalException {
List latestArticles = new ArrayList<>();
List articles = journalArticleFinder.findByReviewDate(
JournalArticleConstants.CLASSNAME_ID_DEFAULT, reviewDate,
_previousCheckDate);
for (JournalArticle article : articles) {
long groupId = article.getGroupId();
String articleId = article.getArticleId();
double version = article.getVersion();
if (!journalArticleLocalService.isLatestVersion(
groupId, articleId, version)) {
article = journalArticleLocalService.getLatestArticle(
groupId, articleId);
}
if (!latestArticles.contains(article)) {
if (_log.isDebugEnabled()) {
_log.debug(
"Sending review notification for article " +
article.getId());
}
latestArticles.add(article);
long ownerId = article.getGroupId();
int ownerType = PortletKeys.PREFS_OWNER_TYPE_GROUP;
long plid = PortletKeys.PREFS_PLID_SHARED;
String portletId = PortletProviderUtil.getPortletId(
JournalArticle.class.getName(),
PortletProvider.Action.EDIT);
PortletPreferences preferences =
portletPreferencesLocalService.getPreferences(
article.getCompanyId(), ownerId, ownerType, plid,
portletId);
String articleURL = PortalUtil.getControlPanelFullURL(
article.getGroupId(), portletId, null);
articleURL = buildArticleURL(
articleURL, article.getGroupId(), article.getFolderId(),
article.getArticleId());
sendEmail(
article, articleURL, preferences, "review",
new ServiceContext());
}
}
}
protected void checkStructure(Document contentDocument, DDMForm ddmForm)
throws PortalException {
for (DDMFormField ddmFormField : ddmForm.getDDMFormFields()) {
checkStructureField(ddmFormField, contentDocument.getRootElement());
}
}
protected void checkStructure(JournalArticle article)
throws PortalException {
DDMStructure ddmStructure = article.getDDMStructure();
try {
checkStructure(article, ddmStructure);
}
catch (StructureDefinitionException sde) {
if (_log.isWarnEnabled()) {
StringBundler sb = new StringBundler(8);
sb.append("Article {groupId=");
sb.append(article.getGroupId());
sb.append(", articleId=");
sb.append(article.getArticleId());
sb.append(", version=");
sb.append(article.getVersion());
sb.append("} has content that does not match its structure: ");
sb.append(sde.getMessage());
_log.warn(sb.toString());
}
}
}
protected void checkStructure(
JournalArticle article, DDMStructure ddmStructure)
throws PortalException {
checkStructure(article.getDocument(), ddmStructure.getDDMForm());
}
protected void checkStructureField(
DDMFormField ddmFormField, Element contentElement)
throws PortalException {
String fieldName = ddmFormField.getName();
boolean hasField = false;
for (Element childElement : contentElement.elements()) {
if (fieldName.equals(
childElement.attributeValue("name", StringPool.BLANK))) {
hasField = true;
for (DDMFormField childDDMFormField :
ddmFormField.getNestedDDMFormFields()) {
checkStructureField(childDDMFormField, childElement);
}
break;
}
}
if (!hasField) {
String contentElementType = contentElement.attributeValue(
"type", StringPool.BLANK);
if (!contentElementType.equals("list") &&
!contentElementType.equals("multi-list")) {
throw new StructureDefinitionException(fieldName);
}
}
}
protected void copyArticleImages(
JournalArticle oldArticle, JournalArticle newArticle)
throws Exception {
Document contentDocument = oldArticle.getDocument();
contentDocument = contentDocument.clone();
XPath xPathSelector = SAXReaderUtil.createXPath(
"//dynamic-element[@type='image']");
List imageNodes = xPathSelector.selectNodes(contentDocument);
for (Node imageNode : imageNodes) {
Element imageEl = (Element)imageNode;
String elInstanceId = imageEl.attributeValue("instance-id");
String elName = imageEl.attributeValue("name");
List dynamicContentEls = imageEl.elements(
"dynamic-content");
for (Element dynamicContentEl : dynamicContentEls) {
long imageId = GetterUtil.getLong(
dynamicContentEl.attributeValue("id"));
String languageId =
StringPool.UNDERLINE +
dynamicContentEl.attributeValue("language-id");
Image oldImage = imageLocalService.fetchImage(imageId);
if (oldImage == null) {
continue;
}
imageId = journalArticleImageLocalService.getArticleImageId(
newArticle.getGroupId(), newArticle.getArticleId(),
newArticle.getVersion(), elInstanceId, elName, languageId);
imageLocalService.updateImage(imageId, oldImage.getTextObj());
String elContent =
"/image/journal/article?img_id=" + imageId + "&t=" +
WebServerServletTokenUtil.getToken(imageId);
dynamicContentEl.setText(elContent);
dynamicContentEl.addAttribute("id", String.valueOf(imageId));
}
}
newArticle.setContent(contentDocument.formattedString());
}
protected Map createFieldsValuesMap(
Element parentElement) {
Map fieldsValuesMap = new HashMap<>();
List dynamicElementElements = parentElement.elements(
"dynamic-element");
LocalizedValue fieldLocalizedValue = new LocalizedValue(
LocaleUtil.fromLanguageId(
parentElement.attributeValue("default-locale")));
for (Element dynamicElementElement : dynamicElementElements) {
String fieldName = dynamicElementElement.attributeValue(
"name", StringPool.BLANK);
List dynamicContentElements =
dynamicElementElement.elements("dynamic-content");
for (Element dynamicContentElement : dynamicContentElements) {
String languageId = dynamicContentElement.attributeValue(
"language-id");
String value = dynamicContentElement.getText();
fieldLocalizedValue.addString(
LocaleUtil.fromLanguageId(languageId), value);
}
fieldsValuesMap.put(fieldName, fieldLocalizedValue);
fieldsValuesMap.putAll(
createFieldsValuesMap(dynamicElementElement));
}
return fieldsValuesMap;
}
protected Map createFieldsValuesMap(
String content) {
try {
Document document = SAXReaderUtil.read(content);
Element rootElement = document.getRootElement();
return createFieldsValuesMap(rootElement);
}
catch (DocumentException de) {
throw new SystemException(de);
}
}
protected JournalArticle fetchLatestLiveArticle(JournalArticle article)
throws PortalException {
Group group = groupLocalService.getGroup(article.getGroupId());
long liveGroupId = group.getLiveGroupId();
if (liveGroupId == 0) {
return null;
}
JournalArticleResource articleResource =
journalArticleResourceLocalService.
fetchJournalArticleResourceByUuidAndGroupId(
article.getArticleResourceUuid(), liveGroupId);
if (articleResource == null) {
return null;
}
return journalArticleLocalService.fetchLatestArticle(
articleResource.getResourcePrimKey(), WorkflowConstants.STATUS_ANY,
false);
}
protected void format(
User user, long groupId, String articleId, double version,
boolean incrementVersion, Element root, Map images)
throws PortalException {
for (Element element : root.elements()) {
String elInstanceId = element.attributeValue(
"instance-id", StringPool.BLANK);
String elType = element.attributeValue("type", StringPool.BLANK);
if (elType.equals("document_library")) {
formatDocumentLibrary(element);
}
else if (elType.equals("image")) {
String elName = element.attributeValue(
"name", StringPool.BLANK);
formatImage(
groupId, articleId, version, incrementVersion, element,
elInstanceId, elName, images);
}
else if (elType.equals("text_area") || elType.equals("text") ||
elType.equals("text_box")) {
List dynamicContentElements = element.elements(
"dynamic-content");
for (Element dynamicContentElement : dynamicContentElements) {
String dynamicContent = dynamicContentElement.getText();
if (Validator.isNotNull(dynamicContent)) {
String contentType = ContentTypes.TEXT_PLAIN;
if (elType.equals("text_area")) {
contentType = ContentTypes.TEXT_HTML;
}
dynamicContent = SanitizerUtil.sanitize(
user.getCompanyId(), groupId, user.getUserId(),
JournalArticle.class.getName(), 0, contentType,
dynamicContent);
dynamicContentElement.clearContent();
dynamicContentElement.addCDATA(dynamicContent);
}
}
}
format(
user, groupId, articleId, version, incrementVersion, element,
images);
}
}
protected String format(
User user, long groupId, String articleId, double version,
boolean incrementVersion, String content,
Map images)
throws PortalException {
Document document = null;
try {
document = SAXReaderUtil.read(content);
Element rootElement = document.getRootElement();
format(
user, groupId, articleId, version, incrementVersion,
rootElement, images);
content = XMLUtil.formatXML(document);
}
catch (DocumentException de) {
_log.error(de, de);
}
return content;
}
protected void formatDocumentLibrary(Element dynamicElementElement)
throws PortalException {
if (ExportImportThreadLocal.isImportInProcess()) {
return;
}
for (Element dynamicContentElement :
dynamicElementElement.elements("dynamic-content")) {
formatDocumentLibraryDynamicContent(dynamicContentElement);
}
}
protected void formatDocumentLibraryDynamicContent(
Element dynamicContentElement)
throws PortalException {
String value = dynamicContentElement.getText();
if (Validator.isNull(value)) {
return;
}
String previewURLPrefix = PortalUtil.getPathContext() + "/documents/";
if (value.startsWith(previewURLPrefix)) {
return;
}
JSONObject jsonObject = JSONFactoryUtil.createJSONObject(value);
String data = jsonObject.getString("data");
if (Validator.isNotNull(data)) {
dynamicContentElement.clearContent();
dynamicContentElement.addCDATA(data);
return;
}
String uuid = jsonObject.getString("uuid");
long groupId = jsonObject.getLong("groupId");
boolean tempFile = jsonObject.getBoolean("tempFile");
FileEntry fileEntry = dlAppLocalService.getFileEntryByUuidAndGroupId(
uuid, groupId);
if (tempFile) {
String fileEntryName = DLUtil.getUniqueFileName(
fileEntry.getGroupId(), fileEntry.getFolderId(),
fileEntry.getFileName());
fileEntry = dlAppLocalService.addFileEntry(
fileEntry.getUserId(), fileEntry.getGroupId(), 0, fileEntryName,
fileEntry.getMimeType(), fileEntryName, StringPool.BLANK,
StringPool.BLANK, fileEntry.getContentStream(),
fileEntry.getSize(), new ServiceContext());
}
String previewURL = DLUtil.getPreviewURL(
fileEntry, fileEntry.getFileVersion(), null, StringPool.BLANK,
false, true);
dynamicContentElement.clearContent();
dynamicContentElement.addCDATA(previewURL);
}
protected void formatImage(
long groupId, String articleId, double version,
boolean incrementVersion, Element el, String elInstanceId,
String elName, Map images)
throws PortalException {
List imageContents = el.elements("dynamic-content");
for (Element dynamicContent : imageContents) {
String elType = dynamicContent.attributeValue(
"type", StringPool.BLANK);
if (elType.equals("document")) {
if (ExportImportThreadLocal.isImportInProcess()) {
continue;
}
formatDocumentLibraryDynamicContent(dynamicContent);
continue;
}
String elLanguage = dynamicContent.attributeValue(
"language-id", StringPool.BLANK);
if (!elLanguage.equals(StringPool.BLANK)) {
elLanguage = "_" + elLanguage;
}
long imageId = journalArticleImageLocalService.getArticleImageId(
groupId, articleId, version, elInstanceId, elName, elLanguage);
if (dynamicContent.getText().equals("delete") ||
Validator.isNull(dynamicContent.getText())) {
dynamicContent.setText(StringPool.BLANK);
imageLocalService.deleteImage(imageId);
String defaultElLanguage = "";
if (Validator.isNull(elLanguage)) {
defaultElLanguage =
"_" +
LocaleUtil.toLanguageId(
LocaleUtil.getSiteDefault());
}
long defaultImageId =
journalArticleImageLocalService.getArticleImageId(
groupId, articleId, version, elInstanceId, elName,
defaultElLanguage);
imageLocalService.deleteImage(defaultImageId);
continue;
}
String elContent =
"/image/journal/article?img_id=" + imageId + "&t=" +
WebServerServletTokenUtil.getToken(imageId);
byte[] bytes = null;
if (images != null) {
bytes = images.get(elInstanceId + "_" + elName + elLanguage);
}
if (ArrayUtil.isNotEmpty(bytes)) {
dynamicContent.setText(elContent);
dynamicContent.addAttribute("id", String.valueOf(imageId));
imageLocalService.updateImage(imageId, bytes);
continue;
}
if ((version > JournalArticleConstants.VERSION_DEFAULT) &&
incrementVersion) {
long oldImageId = 0;
if (incrementVersion) {
double oldVersion = getLatestVersion(groupId, articleId);
oldImageId =
journalArticleImageLocalService.getArticleImageId(
groupId, articleId, oldVersion, elInstanceId,
elName, elLanguage);
}
Image oldImage = null;
if (oldImageId > 0) {
oldImage = imageLocalService.getImage(oldImageId);
}
if (oldImage != null) {
dynamicContent.setText(elContent);
dynamicContent.addAttribute("id", String.valueOf(imageId));
bytes = oldImage.getTextObj();
imageLocalService.updateImage(imageId, bytes);
}
else if (dynamicContent.getText().equals("update")) {
dynamicContent.setText(StringPool.BLANK);
}
continue;
}
Image image = imageLocalService.getImage(imageId);
if (image != null) {
dynamicContent.setText(elContent);
dynamicContent.addAttribute("id", String.valueOf(imageId));
continue;
}
else if (dynamicContent.getText().equals("update")) {
dynamicContent.setText(StringPool.BLANK);
continue;
}
long contentImageId = GetterUtil.getLong(
HttpUtil.getParameter(dynamicContent.getText(), "img_id"));
if (contentImageId <= 0) {
contentImageId = GetterUtil.getLong(
HttpUtil.getParameter(
dynamicContent.getText(), "img_id", false));
}
if (contentImageId > 0) {
image = imageLocalService.getImage(contentImageId);
if (image != null) {
dynamicContent.addAttribute(
"id", String.valueOf(contentImageId));
continue;
}
}
String defaultElLanguage = "";
if (Validator.isNull(elLanguage)) {
defaultElLanguage =
"_" + LocaleUtil.toLanguageId(LocaleUtil.getSiteDefault());
}
long defaultImageId =
journalArticleImageLocalService.getArticleImageId(
groupId, articleId, version, elInstanceId, elName,
defaultElLanguage);
Image defaultImage = imageLocalService.getImage(defaultImageId);
if (defaultImage != null) {
dynamicContent.setText(elContent);
dynamicContent.addAttribute(
"id", String.valueOf(defaultImageId));
bytes = defaultImage.getTextObj();
imageLocalService.updateImage(defaultImageId, bytes);
continue;
}
if (Validator.isNotNull(elLanguage)) {
dynamicContent.setText(StringPool.BLANK);
}
}
}
protected Locale getArticleDefaultLocale(String content) {
String defaultLanguageId = LocalizationUtil.getDefaultLanguageId(
content);
if (Validator.isNotNull(defaultLanguageId)) {
return LocaleUtil.fromLanguageId(defaultLanguageId);
}
return LocaleUtil.getSiteDefault();
}
protected JournalArticleDisplay getArticleDisplay(
JournalArticle article, String ddmTemplateKey, String viewMode,
String languageId, int page,
PortletRequestModel portletRequestModel, ThemeDisplay themeDisplay,
boolean propagateException)
throws PortalException {
String content = null;
if (page < 1) {
page = 1;
}
int numberOfPages = 1;
boolean paginate = false;
boolean pageFlow = false;
boolean cacheable = true;
Map tokens = JournalUtil.getTokens(
article.getGroupId(), portletRequestModel, themeDisplay);
if ((themeDisplay == null) && (portletRequestModel == null)) {
tokens.put("company_id", String.valueOf(article.getCompanyId()));
Group companyGroup = groupLocalService.getCompanyGroup(
article.getCompanyId());
tokens.put(
"article_group_id", String.valueOf(article.getGroupId()));
tokens.put(
"company_group_id", String.valueOf(companyGroup.getGroupId()));
// Deprecated tokens
tokens.put("group_id", String.valueOf(article.getGroupId()));
}
tokens.put(
TemplateConstants.CLASS_NAME_ID,
String.valueOf(
classNameLocalService.getClassNameId(DDMStructure.class)));
tokens.put(
"article_resource_pk",
String.valueOf(article.getResourcePrimKey()));
DDMStructure ddmStructure = article.getDDMStructure();
tokens.put(
"ddm_structure_key",
String.valueOf(ddmStructure.getStructureKey()));
tokens.put(
"ddm_structure_id", String.valueOf(ddmStructure.getStructureId()));
// Deprecated token
tokens.put("structure_id", article.getDDMStructureKey());
String defaultDDMTemplateKey = article.getDDMTemplateKey();
if (Validator.isNull(ddmTemplateKey)) {
ddmTemplateKey = defaultDDMTemplateKey;
}
Document document = article.getDocument();
document = document.clone();
Element rootElement = document.getRootElement();
List pages = rootElement.elements("page");
if (!pages.isEmpty()) {
pageFlow = true;
String targetPage = null;
Map parameters =
portletRequestModel.getParameters();
if (parameters != null) {
String[] values = parameters.get("targetPage");
if ((values != null) && (values.length > 0)) {
targetPage = values[0];
}
}
Element pageElement = null;
if (Validator.isNotNull(targetPage)) {
targetPage = HtmlUtil.escapeXPathAttribute(targetPage);
XPath xPathSelector = SAXReaderUtil.createXPath(
"/root/page[@id = " + targetPage + "]");
pageElement = (Element)xPathSelector.selectSingleNode(document);
}
if (pageElement != null) {
document = SAXReaderUtil.createDocument(pageElement);
rootElement = document.getRootElement();
numberOfPages = pages.size();
}
else {
if (page > pages.size()) {
page = 1;
}
pageElement = pages.get(page - 1);
document = SAXReaderUtil.createDocument(pageElement);
rootElement = document.getRootElement();
numberOfPages = pages.size();
paginate = true;
}
}
JournalUtil.addAllReservedEls(
rootElement, tokens, article, languageId, themeDisplay);
try {
if (_log.isDebugEnabled()) {
_log.debug(
"Transforming " + article.getArticleId() + " " +
article.getVersion() + " " + languageId);
}
// Try with specified template first (in the current group and the
// global group). If a template is not specified, use the default
// one. If the specified template does not exist, use the default
// one. If the default one does not exist, throw an exception.
DDMTemplate ddmTemplate = null;
try {
ddmTemplate = ddmTemplateLocalService.getTemplate(
PortalUtil.getSiteGroupId(article.getGroupId()),
classNameLocalService.getClassNameId(DDMStructure.class),
ddmTemplateKey, true);
Group companyGroup = groupLocalService.getCompanyGroup(
article.getCompanyId());
if (companyGroup.getGroupId() == ddmTemplate.getGroupId()) {
tokens.put(
"company_group_id",
String.valueOf(companyGroup.getGroupId()));
}
}
catch (NoSuchTemplateException nste) {
if (!defaultDDMTemplateKey.equals(ddmTemplateKey)) {
ddmTemplate = ddmTemplateLocalService.getTemplate(
PortalUtil.getSiteGroupId(article.getGroupId()),
classNameLocalService.getClassNameId(
DDMStructure.class),
defaultDDMTemplateKey);
}
else {
throw nste;
}
}
tokens.put(
"ddm_template_key",
String.valueOf(ddmTemplate.getTemplateKey()));
tokens.put(
"ddm_template_id", String.valueOf(ddmTemplate.getTemplateId()));
// Deprecated token
tokens.put("template_id", ddmTemplateKey);
String script = ddmTemplate.getScript();
String langType = ddmTemplate.getLanguage();
cacheable = ddmTemplate.isCacheable();
content = JournalUtil.transform(
themeDisplay, tokens, viewMode, languageId, document,
portletRequestModel, script, langType, propagateException);
if (!pageFlow) {
String[] pieces = StringUtil.split(
content,
JournalServiceConfigurationValues.
JOURNAL_ARTICLE_TOKEN_PAGE_BREAK);
if (pieces.length > 1) {
if (page > pieces.length) {
page = 1;
}
content = pieces[page - 1];
numberOfPages = pieces.length;
paginate = true;
}
}
}
catch (Exception e) {
throw new SystemException(e);
}
return new JournalArticleDisplayImpl(
article.getCompanyId(), article.getId(),
article.getResourcePrimKey(), article.getGroupId(),
article.getUserId(), article.getArticleId(), article.getVersion(),
article.getTitle(languageId), article.getUrlTitle(),
article.getDescription(languageId),
article.getAvailableLanguageIds(), content,
article.getDDMStructureKey(), ddmTemplateKey,
article.isSmallImage(), article.getSmallImageId(),
article.getSmallImageURL(), numberOfPages, page, paginate,
cacheable);
}
protected List> getArticleVersionStatuses(
List articles) {
List> articleVersionStatusOVPs =
new ArrayList<>(articles.size());
for (JournalArticle article : articles) {
int status = article.getStatus();
if (status == WorkflowConstants.STATUS_PENDING) {
status = WorkflowConstants.STATUS_DRAFT;
}
ObjectValuePair articleVersionStatusOVP =
new ObjectValuePair<>(article.getId(), status);
articleVersionStatusOVPs.add(articleVersionStatusOVP);
}
return articleVersionStatusOVPs;
}
protected long getClassTypeId(JournalArticle article)
throws PortalException {
long classNameId = classNameLocalService.getClassNameId(
JournalArticle.class);
DDMStructure ddmStructure = ddmStructureLocalService.fetchStructure(
article.getGroupId(), classNameId, article.getDDMStructureKey(),
true);
return ddmStructure.getStructureId();
}
protected JournalArticle getFirstArticle(
long groupId, String articleId, int status,
OrderByComparator orderByComparator)
throws PortalException {
if (status == WorkflowConstants.STATUS_ANY) {
return journalArticlePersistence.findByG_A_NotST_First(
groupId, articleId, WorkflowConstants.STATUS_IN_TRASH,
orderByComparator);
}
else {
return journalArticlePersistence.findByG_A_ST_First(
groupId, articleId, status, orderByComparator);
}
}
protected JournalGroupServiceConfiguration
getJournalGroupServiceConfiguration(long groupId)
throws ConfigurationException {
return configurationProvider.getConfiguration(
JournalGroupServiceConfiguration.class,
new GroupServiceSettingsLocator(
groupId, JournalConstants.SERVICE_NAME));
}
protected double getNextVersion(JournalArticle article)
throws PortalException {
double nextVersion = article.getVersion();
// The next version must be greater than the version of the latest live
// article
JournalArticle latestLiveArticle = fetchLatestLiveArticle(article);
if ((latestLiveArticle != null) &&
(latestLiveArticle.getVersion() > nextVersion)) {
nextVersion = latestLiveArticle.getVersion();
}
return MathUtil.format(nextVersion + 0.1, 1, 1);
}
protected String getUniqueUrlTitle(
long id, long groupId, String articleId, String title)
throws PortalException {
String urlTitle = JournalUtil.getUrlTitle(id, title);
return getUniqueUrlTitle(groupId, articleId, urlTitle);
}
protected String getUniqueUrlTitle(
long id, long groupId, String articleId, String title,
String oldUrlTitle, ServiceContext serviceContext)
throws PortalException {
String serviceContextUrlTitle = ParamUtil.getString(
serviceContext, "urlTitle");
String urlTitle = null;
if (Validator.isNotNull(serviceContextUrlTitle)) {
urlTitle = JournalUtil.getUrlTitle(id, serviceContextUrlTitle);
}
else if (Validator.isNotNull(oldUrlTitle)) {
return oldUrlTitle;
}
else {
urlTitle = getUniqueUrlTitle(id, groupId, articleId, title);
}
JournalArticle urlTitleArticle = fetchArticleByUrlTitle(
groupId, urlTitle);
if ((urlTitleArticle != null) &&
!Objects.equals(
urlTitleArticle.getArticleId(), articleId)) {
urlTitle = getUniqueUrlTitle(id, groupId, articleId, urlTitle);
}
return urlTitle;
}
protected boolean hasModifiedLatestApprovedVersion(
long groupId, String articleId, double version) {
JournalArticle article = fetchLatestArticle(
groupId, articleId, WorkflowConstants.STATUS_APPROVED);
if ((article == null) || (article.getVersion() <= version)) {
return true;
}
return false;
}
protected void notifySubscribers(
long userId, JournalArticle article, String articleURL,
String action, ServiceContext serviceContext)
throws PortalException {
if (!article.isApproved() || Validator.isNull(articleURL)) {
return;
}
JournalGroupServiceConfiguration journalGroupServiceConfiguration =
getJournalGroupServiceConfiguration(article.getGroupId());
String articleTitle = article.getTitle(serviceContext.getLanguageId());
articleURL = buildArticleURL(
articleURL, article.getGroupId(), article.getFolderId(),
article.getArticleId());
if (action.equals("add") &&
journalGroupServiceConfiguration.emailArticleAddedEnabled()) {
}
else if (action.equals("move_to") &&
journalGroupServiceConfiguration.
emailArticleMovedToFolderEnabled()) {
}
else if (action.equals("move_from") &&
journalGroupServiceConfiguration.
emailArticleMovedFromFolderEnabled()) {
}
else if (action.equals("update") &&
journalGroupServiceConfiguration.
emailArticleUpdatedEnabled()) {
}
else {
return;
}
String fromName = journalGroupServiceConfiguration.emailFromName();
String fromAddress =
journalGroupServiceConfiguration.emailFromAddress();
Map localizedSubjectMap = null;
Map localizedBodyMap = null;
if (action.equals("add")) {
localizedSubjectMap = LocalizationUtil.getMap(
journalGroupServiceConfiguration.emailArticleAddedSubject());
localizedBodyMap = LocalizationUtil.getMap(
journalGroupServiceConfiguration.emailArticleAddedBody());
}
else if (action.equals("move_to")) {
localizedSubjectMap = LocalizationUtil.getMap(
journalGroupServiceConfiguration.
emailArticleMovedToFolderSubject());
localizedBodyMap = LocalizationUtil.getMap(
journalGroupServiceConfiguration.
emailArticleMovedToFolderBody());
}
else if (action.equals("move_from")) {
localizedSubjectMap = LocalizationUtil.getMap(
journalGroupServiceConfiguration.
emailArticleMovedFromFolderSubject());
localizedBodyMap = LocalizationUtil.getMap(
journalGroupServiceConfiguration.
emailArticleMovedFromFolderBody());
}
else if (action.equals("update")) {
localizedSubjectMap = LocalizationUtil.getMap(
journalGroupServiceConfiguration.emailArticleUpdatedSubject());
localizedBodyMap = LocalizationUtil.getMap(
journalGroupServiceConfiguration.emailArticleUpdatedBody());
}
String articleContent = StringPool.BLANK;
String articleDiffs = StringPool.BLANK;
JournalArticle previousApprovedArticle = getPreviousApprovedArticle(
article);
try {
PortletRequestModel portletRequestModel = new PortletRequestModel(
serviceContext.getLiferayPortletRequest(),
serviceContext.getLiferayPortletResponse());
JournalArticleDisplay articleDisplay = getArticleDisplay(
article, null, Constants.VIEW,
LocaleUtil.toLanguageId(LocaleUtil.getSiteDefault()), 1,
portletRequestModel, serviceContext.getThemeDisplay());
articleContent = articleDisplay.getContent();
articleDiffs = JournalUtil.diffHtml(
article.getGroupId(), article.getArticleId(),
previousApprovedArticle.getVersion(), article.getVersion(),
LocaleUtil.toLanguageId(LocaleUtil.getSiteDefault()),
portletRequestModel, serviceContext.getThemeDisplay());
}
catch (Exception e) {
}
SubscriptionSender subscriptionSender =
new GroupSubscriptionCheckSubscriptionSender(
JournalPermission.RESOURCE_NAME);
subscriptionSender.setClassName(article.getModelClassName());
subscriptionSender.setClassPK(article.getId());
subscriptionSender.setCompanyId(article.getCompanyId());
subscriptionSender.setContextAttribute(
"[$ARTICLE_CONTENT$]", articleContent, false);
subscriptionSender.setContextAttribute(
"[$ARTICLE_DIFFS$]", DiffHtmlUtil.replaceStyles(articleDiffs),
false);
JournalFolder folder = article.getFolder();
subscriptionSender.setContextAttributes(
"[$ARTICLE_ID$]", article.getArticleId(), "[$ARTICLE_TITLE$]",
articleTitle, "[$ARTICLE_URL$]", articleURL, "[$ARTICLE_VERSION$]",
article.getVersion(), "[$FOLDER_NAME$]", folder.getName());
subscriptionSender.setContextCreatorUserPrefix("ARTICLE");
subscriptionSender.setCreatorUserId(article.getUserId());
subscriptionSender.setCurrentUserId(userId);
subscriptionSender.setEntryTitle(articleTitle);
subscriptionSender.setEntryURL(articleURL);
subscriptionSender.setFrom(fromAddress, fromName);
subscriptionSender.setHtmlFormat(true);
subscriptionSender.setLocalizedBodyMap(localizedBodyMap);
subscriptionSender.setLocalizedSubjectMap(localizedSubjectMap);
subscriptionSender.setMailId("journal_article", article.getId());
int notificationType =
UserNotificationDefinition.NOTIFICATION_TYPE_ADD_ENTRY;
if (serviceContext.isCommandUpdate()) {
notificationType =
UserNotificationDefinition.NOTIFICATION_TYPE_UPDATE_ENTRY;
}
subscriptionSender.setNotificationType(notificationType);
String portletId = PortletProviderUtil.getPortletId(
JournalArticle.class.getName(), PortletProvider.Action.EDIT);
subscriptionSender.setPortletId(portletId);
subscriptionSender.setReplyToAddress(fromAddress);
subscriptionSender.setScopeGroupId(article.getGroupId());
subscriptionSender.setServiceContext(serviceContext);
subscriptionSender.addPersistedSubscribers(
JournalFolder.class.getName(), article.getGroupId());
if (folder != null) {
subscriptionSender.addPersistedSubscribers(
JournalFolder.class.getName(), folder.getFolderId());
for (Long ancestorFolderId : folder.getAncestorFolderIds()) {
subscriptionSender.addPersistedSubscribers(
JournalFolder.class.getName(), ancestorFolderId);
}
}
DDMStructure ddmStructure = ddmStructureLocalService.getStructure(
article.getGroupId(),
classNameLocalService.getClassNameId(JournalArticle.class),
article.getDDMStructureKey(), true);
subscriptionSender.addPersistedSubscribers(
DDMStructure.class.getName(), ddmStructure.getStructureId());
subscriptionSender.addPersistedSubscribers(
JournalArticle.class.getName(), article.getResourcePrimKey());
subscriptionSender.flushNotificationsAsync();
}
protected void saveImages(
boolean smallImage, long smallImageId, File smallImageFile,
byte[] smallImageBytes)
throws PortalException {
if (smallImage) {
if ((smallImageFile != null) && (smallImageBytes != null)) {
imageLocalService.updateImage(smallImageId, smallImageBytes);
}
}
else {
imageLocalService.deleteImage(smallImageId);
}
}
protected BaseModelSearchResult searchJournalArticles(
SearchContext searchContext)
throws PortalException {
Indexer indexer =
IndexerRegistryUtil.nullSafeGetIndexer(JournalArticle.class);
for (int i = 0; i < 10; i++) {
Hits hits = indexer.search(
searchContext, JournalUtil.SELECTED_FIELD_NAMES);
List articles = JournalUtil.getArticles(hits);
if (articles != null) {
return new BaseModelSearchResult<>(articles, hits.getLength());
}
}
throw new SearchException(
"Unable to fix the search index after 10 attempts");
}
protected void sendEmail(
JournalArticle article, String articleURL,
PortletPreferences preferences, String emailType,
ServiceContext serviceContext)
throws PortalException {
JournalGroupServiceConfiguration journalGroupServiceConfiguration =
getJournalGroupServiceConfiguration(article.getGroupId());
if (preferences == null) {
return;
}
else if (emailType.equals("denied") &&
journalGroupServiceConfiguration.
emailArticleApprovalDeniedEnabled()) {
}
else if (emailType.equals("granted") &&
journalGroupServiceConfiguration.
emailArticleApprovalGrantedEnabled()) {
}
else if (emailType.equals("requested") &&
journalGroupServiceConfiguration.
emailArticleApprovalRequestedEnabled()) {
}
else if (emailType.equals("review") &&
journalGroupServiceConfiguration.emailArticleReviewEnabled()) {
}
else {
return;
}
Company company = companyPersistence.findByPrimaryKey(
article.getCompanyId());
User user = userPersistence.findByPrimaryKey(article.getUserId());
String fromName = journalGroupServiceConfiguration.emailFromName();
String fromAddress =
journalGroupServiceConfiguration.emailFromAddress();
String toName = user.getFullName();
String toAddress = user.getEmailAddress();
if (emailType.equals("requested")) {
String tempToName = fromName;
String tempToAddress = fromAddress;
fromName = toName;
fromAddress = toAddress;
toName = tempToName;
toAddress = tempToAddress;
}
Map localizedSubjectMap = null;
Map localizedBodyMap = null;
if (emailType.equals("denied")) {
localizedSubjectMap = LocalizationUtil.getMap(
journalGroupServiceConfiguration.
emailArticleApprovalDeniedSubject());
localizedBodyMap = LocalizationUtil.getMap(
journalGroupServiceConfiguration.
emailArticleApprovalDeniedBody());
}
else if (emailType.equals("granted")) {
localizedSubjectMap = LocalizationUtil.getMap(
journalGroupServiceConfiguration.
emailArticleApprovalGrantedSubject());
localizedBodyMap = LocalizationUtil.getMap(
journalGroupServiceConfiguration.
emailArticleApprovalGrantedBody());
}
else if (emailType.equals("requested")) {
localizedSubjectMap = LocalizationUtil.getMap(
journalGroupServiceConfiguration.
emailArticleApprovalGrantedSubject());
localizedBodyMap = LocalizationUtil.getMap(
journalGroupServiceConfiguration.
emailArticleApprovalGrantedBody());
}
else if (emailType.equals("review")) {
localizedSubjectMap = LocalizationUtil.getMap(
journalGroupServiceConfiguration.emailArticleReviewSubject());
localizedBodyMap = LocalizationUtil.getMap(
journalGroupServiceConfiguration.emailArticleReviewBody());
}
SubscriptionSender subscriptionSender = new SubscriptionSender();
subscriptionSender.setCompanyId(company.getCompanyId());
subscriptionSender.setContextAttributes(
"[$ARTICLE_ID$]", article.getArticleId(), "[$ARTICLE_TITLE$]",
article.getTitle(serviceContext.getLanguageId()), "[$ARTICLE_URL$]",
articleURL, "[$ARTICLE_USER_NAME$]", article.getUserName(),
"[$ARTICLE_VERSION$]", article.getVersion());
subscriptionSender.setContextCreatorUserPrefix("ARTICLE");
subscriptionSender.setCreatorUserId(article.getUserId());
subscriptionSender.setFrom(fromAddress, fromName);
subscriptionSender.setHtmlFormat(true);
subscriptionSender.setLocalizedBodyMap(localizedBodyMap);
subscriptionSender.setLocalizedSubjectMap(localizedSubjectMap);
subscriptionSender.setMailId("journal_article", article.getId());
String portletId = PortletProviderUtil.getPortletId(
JournalArticle.class.getName(), PortletProvider.Action.EDIT);
subscriptionSender.setPortletId(portletId);
subscriptionSender.setScopeGroupId(article.getGroupId());
subscriptionSender.setServiceContext(serviceContext);
subscriptionSender.addRuntimeSubscribers(toAddress, toName);
subscriptionSender.flushNotificationsAsync();
}
protected void setArticlesExpirationDate(JournalArticle article) {
if (ExportImportThreadLocal.isImportInProcess()) {
return;
}
if (!article.isApproved() || (article.getExpirationDate() == null)) {
return;
}
final List articles =
journalArticlePersistence.findByG_A(
article.getGroupId(), article.getArticleId());
final Date expirationDate = article.getExpirationDate();
TransactionCommitCallbackUtil.registerCallback(
new Callable() {
@Override
public Void call() throws Exception {
for (JournalArticle curArticle : articles) {
curArticle.setExpirationDate(expirationDate);
journalArticleLocalService.updateJournalArticle(
curArticle);
}
return null;
}
});
}
protected void startWorkflowInstance(
long userId, JournalArticle article, ServiceContext serviceContext)
throws PortalException {
Map workflowContext = new HashMap<>();
String portletId = PortletProviderUtil.getPortletId(
JournalArticle.class.getName(), PortletProvider.Action.EDIT);
workflowContext.put(
WorkflowConstants.CONTEXT_URL,
PortalUtil.getControlPanelFullURL(
article.getGroupId(), portletId, null));
WorkflowHandlerRegistryUtil.startWorkflowInstance(
article.getCompanyId(), article.getGroupId(), userId,
JournalArticle.class.getName(), article.getId(), article,
serviceContext, workflowContext);
}
protected void updateDDMFormFieldPredefinedValue(
DDMFormField ddmFormField, LocalizedValue ddmFormFieldValue) {
DDMForm ddmForm = ddmFormField.getDDMForm();
Set ddmFormAvailableLocales = ddmForm.getAvailableLocales();
ddmFormField.setPredefinedValue(ddmFormFieldValue);
ddmFormAvailableLocales.addAll(ddmFormFieldValue.getAvailableLocales());
for (Locale locale : ddmFormAvailableLocales) {
LocalizedValue label = ddmFormField.getLabel();
Map labelValues = label.getValues();
if (!labelValues.containsKey(locale)) {
label.addString(
locale, label.getString(label.getDefaultLocale()));
}
LocalizedValue style = ddmFormField.getStyle();
Map styleValues = style.getValues();
if (!styleValues.containsKey(locale)) {
style.addString(
locale, style.getString(style.getDefaultLocale()));
}
LocalizedValue tip = ddmFormField.getTip();
Map tipValues = tip.getValues();
if (!tipValues.containsKey(locale)) {
tip.addString(locale, tip.getString(tip.getDefaultLocale()));
}
}
}
protected void updateDDMLinks(
long id, long groupId, String ddmStructureKey,
String ddmTemplateKey, boolean incrementVersion)
throws PortalException {
DDMStructure ddmStructure = ddmStructureLocalService.getStructure(
PortalUtil.getSiteGroupId(groupId),
classNameLocalService.getClassNameId(JournalArticle.class),
ddmStructureKey, true);
DDMTemplate ddmTemplate = ddmTemplateLocalService.getTemplate(
PortalUtil.getSiteGroupId(groupId),
classNameLocalService.getClassNameId(DDMStructure.class),
ddmTemplateKey, true);
if (incrementVersion) {
ddmStorageLinkLocalService.addStorageLink(
ddmStructure.getClassNameId(), id,
ddmStructure.getStructureId(), new ServiceContext());
ddmTemplateLinkLocalService.addTemplateLink(
classNameLocalService.getClassNameId(JournalArticle.class), id,
ddmTemplate.getTemplateId());
}
else {
DDMStorageLink ddmStorageLink =
ddmStorageLinkLocalService.getClassStorageLink(id);
ddmStorageLink.setStructureId(ddmStructure.getStructureId());
ddmStorageLinkLocalService.updateDDMStorageLink(ddmStorageLink);
ddmTemplateLinkLocalService.updateTemplateLink(
classNameLocalService.getClassNameId(JournalArticle.class), id,
ddmTemplate.getTemplateId());
}
}
protected void updateDDMStructurePredefinedValues(
long ddmStructureId, String content, ServiceContext serviceContext)
throws PortalException {
DDMStructure ddmStructure = ddmStructureLocalService.fetchDDMStructure(
ddmStructureId);
if (ddmStructure == null) {
return;
}
DDMForm ddmForm = ddmStructure.getDDMForm();
Map ddmFormFieldsMap =
ddmForm.getDDMFormFieldsMap(true);
Map fullHierarchyDDMFormFieldsMap =
ddmStructure.getFullHierarchyDDMFormFieldsMap(true);
Map fieldsValuesMap = createFieldsValuesMap(
content);
for (Map.Entry fieldValue :
fieldsValuesMap.entrySet()) {
String ddmFormFieldName = fieldValue.getKey();
LocalizedValue ddmFormFieldValue = fieldValue.getValue();
updateDDMFormFieldPredefinedValue(
fullHierarchyDDMFormFieldsMap.get(ddmFormFieldName),
ddmFormFieldValue);
if (ddmFormFieldsMap.containsKey(ddmFormFieldName)) {
updateDDMFormFieldPredefinedValue(
ddmFormFieldsMap.get(ddmFormFieldName), ddmFormFieldValue);
}
}
boolean indexingEnabled = serviceContext.isIndexingEnabled();
try {
serviceContext.setIndexingEnabled(false);
ddmStructureLocalService.updateStructure(
serviceContext.getUserId(), ddmStructureId, ddmForm,
ddmStructure.getDDMFormLayout(), serviceContext);
}
finally {
serviceContext.setIndexingEnabled(indexingEnabled);
}
}
protected void updatePreviousApprovedArticle(JournalArticle article)
throws PortalException {
JournalArticle previousApprovedArticle = getPreviousApprovedArticle(
article);
if (previousApprovedArticle.getVersion() == article.getVersion()) {
assetEntryLocalService.updateVisible(
JournalArticle.class.getName(), article.getResourcePrimKey(),
false);
}
else {
AssetEntry assetEntry = assetEntryLocalService.updateEntry(
JournalArticle.class.getName(), article.getResourcePrimKey(),
previousApprovedArticle.getDisplayDate(),
previousApprovedArticle.getExpirationDate(),
isListable(article), true);
assetEntry.setModifiedDate(
previousApprovedArticle.getModifiedDate());
assetEntry.setTitle(previousApprovedArticle.getTitle());
assetEntryPersistence.update(assetEntry);
}
}
protected void updateUrlTitles(
long groupId, String articleId, String urlTitle)
throws PortalException {
JournalArticle firstArticle = journalArticlePersistence.findByG_A_First(
groupId, articleId, new ArticleVersionComparator(false));
if (firstArticle.getUrlTitle().equals(urlTitle)) {
return;
}
List articles = journalArticlePersistence.findByG_A(
groupId, articleId);
for (JournalArticle article : articles) {
if (!article.getUrlTitle().equals(urlTitle)) {
article.setUrlTitle(urlTitle);
journalArticlePersistence.update(article);
}
}
}
protected void validate(
long companyId, long groupId, long classNameId,
Map titleMap, String content,
String ddmStructureKey, String ddmTemplateKey, Date displayDate,
Date expirationDate, boolean smallImage, String smallImageURL,
File smallImageFile, byte[] smallImageBytes,
ServiceContext serviceContext)
throws PortalException {
Locale articleDefaultLocale = LocaleUtil.fromLanguageId(
LocalizationUtil.getDefaultLanguageId(content));
if (!ExportImportThreadLocal.isImportInProcess()) {
if (!LanguageUtil.isAvailableLocale(
groupId, articleDefaultLocale)) {
LocaleException le = new LocaleException(
LocaleException.TYPE_CONTENT,
"The locale " + articleDefaultLocale +
" is not available in site with groupId" + groupId);
le.setSourceAvailableLocales(
Collections.singleton(articleDefaultLocale));
le.setTargetAvailableLocales(
LanguageUtil.getAvailableLocales(groupId));
throw le;
}
if ((expirationDate != null) &&
(expirationDate.before(new Date()) ||
((displayDate != null) &&
expirationDate.before(displayDate)))) {
throw new ArticleExpirationDateException(
"Expiration date " + expirationDate + " is in the past");
}
}
if ((classNameId == JournalArticleConstants.CLASSNAME_ID_DEFAULT) &&
(titleMap.isEmpty() ||
Validator.isNull(titleMap.get(articleDefaultLocale)))) {
throw new ArticleTitleException("Title is null");
}
validateContent(content);
DDMStructure ddmStructure = ddmStructureLocalService.getStructure(
PortalUtil.getSiteGroupId(groupId),
classNameLocalService.getClassNameId(JournalArticle.class),
ddmStructureKey, true);
validateDDMStructureFields(
ddmStructure, classNameId, content, articleDefaultLocale);
if (Validator.isNotNull(ddmTemplateKey)) {
DDMTemplate ddmTemplate = ddmTemplateLocalService.getTemplate(
PortalUtil.getSiteGroupId(groupId),
classNameLocalService.getClassNameId(DDMStructure.class),
ddmTemplateKey, true);
if (ddmTemplate.getClassPK() != ddmStructure.getStructureId()) {
throw new NoSuchTemplateException(
"{templateKey=" + ddmTemplateKey + "}");
}
}
else if (classNameId == JournalArticleConstants.CLASSNAME_ID_DEFAULT) {
throw new NoSuchTemplateException("DDM template key is null");
}
String[] imageExtensions = PrefsPropsUtil.getStringArray(
PropsKeys.JOURNAL_IMAGE_EXTENSIONS, StringPool.COMMA);
if (!smallImage || Validator.isNotNull(smallImageURL) ||
(smallImageFile == null) || (smallImageBytes == null)) {
return;
}
String smallImageName = smallImageFile.getName();
boolean validSmallImageExtension = false;
for (String imageExtension : imageExtensions) {
if (StringPool.STAR.equals(imageExtension) ||
StringUtil.endsWith(smallImageName, imageExtension)) {
validSmallImageExtension = true;
break;
}
}
if (!validSmallImageExtension) {
throw new ArticleSmallImageNameException(smallImageName);
}
long smallImageMaxSize = PrefsPropsUtil.getLong(
PropsKeys.JOURNAL_IMAGE_SMALL_MAX_SIZE);
if ((smallImageMaxSize > 0) &&
(smallImageBytes.length > smallImageMaxSize)) {
throw new ArticleSmallImageSizeException(
smallImageBytes.length + " exceeds " + smallImageMaxSize);
}
}
protected void validate(
long companyId, long groupId, long classNameId, String articleId,
boolean autoArticleId, double version, Map titleMap,
String content, String ddmStructureKey, String ddmTemplateKey,
Date displayDate, Date expirationDate, boolean smallImage,
String smallImageURL, File smallImageFile, byte[] smallImageBytes,
ServiceContext serviceContext)
throws PortalException {
if (!autoArticleId) {
validate(articleId);
}
JournalArticle article = journalArticlePersistence.fetchByG_A_V(
groupId, articleId, version);
if (article != null) {
StringBundler sb = new StringBundler(7);
sb.append("{groupId=");
sb.append(groupId);
sb.append(", articleId=");
sb.append(articleId);
sb.append(", version=");
sb.append(version);
sb.append("}");
throw new DuplicateArticleIdException(sb.toString());
}
validate(
companyId, groupId, classNameId, titleMap, content, ddmStructureKey,
ddmTemplateKey, displayDate, expirationDate, smallImage,
smallImageURL, smallImageFile, smallImageBytes, serviceContext);
}
protected void validate(String articleId) throws PortalException {
if (Validator.isNull(articleId) ||
(articleId.indexOf(CharPool.COMMA) != -1) ||
(articleId.indexOf(CharPool.SPACE) != -1)) {
throw new ArticleIdException("Invalid articleId: " + articleId);
}
}
protected void validateContent(String content) throws PortalException {
if (Validator.isNull(content)) {
throw new ArticleContentException("Content is null");
}
try {
SAXReaderUtil.read(content);
}
catch (DocumentException de) {
if (_log.isDebugEnabled()) {
_log.debug("Invalid content:\n" + content);
}
throw new ArticleContentException(
"Unable to read content with an XML parser", de);
}
}
protected void validateDDMStructureFields(
DDMStructure ddmStructure, long classNameId, Fields fields,
Locale defaultlocale)
throws PortalException {
for (com.liferay.dynamic.data.mapping.storage.Field field : fields) {
if (!ddmStructure.hasField(field.getName())) {
throw new StorageFieldNameException(
"No field exists for {name=" + field.getName() + "}");
}
if (ddmStructure.getFieldRequired(field.getName()) &&
Validator.isNull(field.getValue(defaultlocale)) &&
(classNameId == JournalArticleConstants.CLASSNAME_ID_DEFAULT)) {
throw new StorageFieldRequiredException(
"Required field value is not present for " + defaultlocale);
}
}
}
protected void validateDDMStructureFields(
DDMStructure ddmStructure, long classNameId, String content,
Locale defaultlocale)
throws PortalException {
Fields fields = ddmXML.getFields(ddmStructure, content);
validateDDMStructureFields(
ddmStructure, classNameId, fields, defaultlocale);
}
protected void validateDDMStructureId(
long groupId, long folderId, String ddmStructureKey)
throws PortalException {
int restrictionType = JournalUtil.getRestrictionType(folderId);
DDMStructure ddmStructure = ddmStructureLocalService.getStructure(
PortalUtil.getSiteGroupId(groupId),
classNameLocalService.getClassNameId(JournalArticle.class),
ddmStructureKey, true);
List folderDDMStructures =
journalFolderLocalService.getDDMStructures(
PortalUtil.getCurrentAndAncestorSiteGroupIds(groupId), folderId,
restrictionType);
for (DDMStructure folderDDMStructure : folderDDMStructures) {
if (folderDDMStructure.getStructureId() ==
ddmStructure.getStructureId()) {
return;
}
}
throw new InvalidDDMStructureException(
"Invalid structure " + ddmStructure.getStructureId() +
" for folder " + folderId);
}
protected void validateReferences(
long groupId, String ddmStructureKey, String ddmTemplateKey,
String layoutUuid, boolean smallImage, String smallImageURL,
byte[] smallImageBytes, long smallImageId, String content)
throws PortalException {
long classNameId = classNameLocalService.getClassNameId(
JournalArticle.class.getName());
if (Validator.isNotNull(ddmStructureKey)) {
DDMStructure ddmStructure = ddmStructureLocalService.fetchStructure(
groupId, classNameId, ddmStructureKey, true);
if (ddmStructure == null) {
throw new NoSuchStructureException();
}
}
classNameId = classNameLocalService.getClassNameId(
DDMStructure.class.getName());
if (Validator.isNotNull(ddmTemplateKey)) {
DDMTemplate ddmTemplate = ddmTemplateLocalService.fetchTemplate(
groupId, classNameId, ddmTemplateKey, true);
if (ddmTemplate == null) {
throw new NoSuchTemplateException();
}
}
if (Validator.isNotNull(layoutUuid)) {
Layout layout = JournalUtil.getArticleLayout(layoutUuid, groupId);
if (layout == null) {
throw new NoSuchLayoutException(
JournalArticleConstants.DISPLAY_PAGE);
}
}
if (smallImage && Validator.isNull(smallImageURL) &&
ArrayUtil.isEmpty(smallImageBytes)) {
Image image = imageLocalService.fetchImage(smallImageId);
if (image == null) {
throw new NoSuchImageException();
}
}
ExportImportContentProcessor exportImportContentProcessor =
ExportImportContentProcessorRegistryUtil.
getExportImportContentProcessor(JournalArticle.class.getName());
exportImportContentProcessor.validateContentReferences(
groupId, content);
}
/**
* @deprecated As of 3.3.0, replaced by {@link #validateReferences(long,
* String, String, String, boolean, String, byte[], long,
* String)}
*/
@Deprecated
protected void validateReferences(
long groupId, String ddmStructureKey, String ddmTemplateKey,
String layoutUuid, boolean smallImage, String smallImageURL,
byte[] smallImageBytes, String content)
throws PortalException {
validateReferences(
groupId, ddmStructureKey, ddmTemplateKey, layoutUuid, smallImage,
smallImageURL, smallImageBytes, 0, content);
}
@ServiceReference(type = ConfigurationProvider.class)
protected ConfigurationProvider configurationProvider;
@ServiceReference(type = DDMStorageLinkLocalService.class)
protected DDMStorageLinkLocalService ddmStorageLinkLocalService;
@ServiceReference(type = DDMStructureLocalService.class)
protected DDMStructureLocalService ddmStructureLocalService;
@ServiceReference(type = DDMTemplateLinkLocalService.class)
protected DDMTemplateLinkLocalService ddmTemplateLinkLocalService;
@ServiceReference(type = DDMTemplateLocalService.class)
protected DDMTemplateLocalService ddmTemplateLocalService;
@ServiceReference(type = DDMXML.class)
protected DDMXML ddmXML;
private static final long _JOURNAL_ARTICLE_CHECK_INTERVAL =
JournalServiceConfigurationValues.JOURNAL_ARTICLE_CHECK_INTERVAL
* Time.MINUTE;
private static final Log _log = LogFactoryUtil.getLog(
JournalArticleLocalServiceImpl.class);
private Date _previousCheckDate;
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy